MascotRemoteQuery.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Andreas Bertsch, Daniel Jameson, Chris Bielow, Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtNetwork/QNetworkAccessManager>
#include <QTimer>
#include <QNetworkReply>
 
 
namespace OpenMS
{
  class MascotRemoteQuery :
    public QObject,
    public DefaultParamHandler
  {
    Q_OBJECT
 
public:
 
    OPENMS_DLLAPI MascotRemoteQuery(QObject* parent = 0);
 
    OPENMS_DLLAPI MascotRemoteQuery& operator=(const MascotRemoteQuery& rhs) = delete;
 
    OPENMS_DLLAPI MascotRemoteQuery(const MascotRemoteQuery& rhs) = delete;
 
    OPENMS_DLLAPI ~MascotRemoteQuery() override;
 
    OPENMS_DLLAPI void setQuerySpectra(const String& exp);
 
    OPENMS_DLLAPI const QByteArray& getMascotXMLResponse() const;
 
    OPENMS_DLLAPI const QByteArray& getMascotXMLDecoyResponse() const;
 
    OPENMS_DLLAPI bool hasError() const;
 
    OPENMS_DLLAPI const String& getErrorMessage() const;
 
    OPENMS_DLLAPI String getSearchIdentifier() const;
 
    OPENMS_DLLAPI void setExportDecoys(const bool b);
 
protected:
 
    OPENMS_DLLAPI void updateMembers_() override;
 
public slots:
 
    OPENMS_DLLAPI void run();
 
private slots:
 
    OPENMS_DLLAPI void timedOut() const;
 
    OPENMS_DLLAPI void readResponse(QNetworkReply* reply);
 
    OPENMS_DLLAPI void downloadProgress(qint64 bytes_read, qint64 bytes_total);
 
    OPENMS_DLLAPI void uploadProgress(qint64 bytes_read, qint64 bytes_total);
 
    OPENMS_DLLAPI void followRedirect(QNetworkReply * reply);
 
signals:
 
    OPENMS_DLLAPI void gotRedirect(QNetworkReply * reply);
 
    OPENMS_DLLAPI void done();
 
private:
 
    void login();
 
    void execQuery();
 
    void getResults(const QString& results_path);
 
    OPENMS_DLLAPI void endRun_();
 
    void removeHostName_(QString& url);
 
    QUrl buildUrl_(const std::string& path);
 
    OPENMS_DLLAPI void logHeader_(const QNetworkRequest& header, const String& what);
 
    OPENMS_DLLAPI void logHeader_(const QNetworkReply* header, const String& what);
 
    OPENMS_DLLAPI String getSearchIdentifierFromFilePath(const String& path) const;
 
    OPENMS_DLLAPI void readResponseHeader(const QNetworkReply* reply);
 
    QNetworkAccessManager* manager_;
 
    // Input / Output data
    String query_spectra_;
    QByteArray mascot_xml_;
    QByteArray mascot_decoy_xml_;
 
    // Internal data structures
    QString cookie_;
    String error_message_;
    QTimer timeout_;
    String search_identifier_;
 
    String server_path_;
    String host_name_;
    bool requires_login_;
    bool use_ssl_;
    String boundary_;
    Int to_;
 
    bool export_decoys_ = false;
  };
 
}