libopenms-dev 1.11.1-3 / usr / include / OpenMS / FORMAT / MascotRemoteQuery.h

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// 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$
// --------------------------------------------------------------------------

#ifndef OPENMS_FORMAT_MASCOTREMOTEQUERY_H
#define OPENMS_FORMAT_MASCOTREMOTEQUERY_H

#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtNetwork/QHttpRequestHeader>
#include <QTimer>


namespace OpenMS
{
  /**
      @brief Class which handles the communication between OpenMS and the Mascot server

      This class provides a communication interface which is able to query the Mascot
      server and reports the identifications provided be the Mascot server

      @htmlinclude OpenMS_MascotRemoteQuery.parameters

  */
  class MascotRemoteQuery :
    public QObject,
    public DefaultParamHandler
  {
    Q_OBJECT

public:

    /** @name Constructors and destructors
    */
    //@{
    /// default constructor
    OPENMS_DLLAPI MascotRemoteQuery(QObject* parent = 0);

    /// destructor
    OPENMS_DLLAPI virtual ~MascotRemoteQuery();
    //@}


    /// sets the query spectra, given in MGF file format
    OPENMS_DLLAPI void setQuerySpectra(const String& exp);

    /// returns the Mascot XML response which contains the identifications
    OPENMS_DLLAPI const QByteArray& getMascotXMLResponse() const;

    /// predicate which returns true if an error occurred during the query
    OPENMS_DLLAPI bool hasError() const;

    /// returns the error message, if hasError can be used to check whether an error has occurred
    OPENMS_DLLAPI const String& getErrorMessage() const;

protected:

    OPENMS_DLLAPI virtual void updateMembers_();

public slots:

    OPENMS_DLLAPI void run();

private slots:

    OPENMS_DLLAPI void timedOut();

    OPENMS_DLLAPI void readyReadSlot(const QHttpResponseHeader& resp);

    /** slot connected to signal requestFinished of QHttp: "This signal is emitted
          when processing the request identified by id has finished. error is true
            if an error occurred during the processing; otherwise error is false"
    */
    OPENMS_DLLAPI void httpRequestFinished(int request_id, bool error);

    /// slot connected to signal dataReadProgress of QHttp
    OPENMS_DLLAPI void httpDataReadProgress(int bytes_read, int bytes_total);

    /// slot connected to signal dataSendProgress of QHttp
    OPENMS_DLLAPI void httpDataSendProgress(int bytes_sent, int bytes_total);

    /// slot connected to signal requestStarted of QHttp, which indicates that the processing of request request_id has been started
    OPENMS_DLLAPI void httpRequestStarted(int request_id);

    /** slot connected to signal stateChanged of QHttp, which is emitted if
            the http state changed. See 'enum QHttp::State' of Qt docu for more
            info.
    */
    OPENMS_DLLAPI void httpStateChanged(int state);

    /// slot connected to signal done of QHttp
    OPENMS_DLLAPI void httpDone(bool error);

    /// slot connect to responseHeaderRecieved, which indicates that a new response header is available
    OPENMS_DLLAPI void readResponseHeader(const QHttpResponseHeader& response_header);

    OPENMS_DLLAPI void login();

    OPENMS_DLLAPI void execQuery();

    OPENMS_DLLAPI void getResults(QString results_path);

    OPENMS_DLLAPI void followRedirect(const QHttpResponseHeader& resp);

signals:

    OPENMS_DLLAPI void done();

    OPENMS_DLLAPI void gotRedirect(const QHttpResponseHeader& resp);

private:
    /// assignment operator
    OPENMS_DLLAPI MascotRemoteQuery& operator=(const MascotRemoteQuery& rhs);
    /// copy constructor
    OPENMS_DLLAPI MascotRemoteQuery(const MascotRemoteQuery& rhs);

    OPENMS_DLLAPI void endRun_();

    /// Write HTTP header to error stream (for debugging)
    OPENMS_DLLAPI void logHeader_(const QHttpHeader& header, 
                                  const String& what);
    /**
      @brief Remove host name information from an url, e.g., "http://www.google.de/search" -> "search"

      @param The url that will be manipulated.
    */
    void removeHostName_(QString& url);

    String query_spectra_;
    QByteArray mascot_xml_;
    QHttp* http_;
    QString cookie_;
    String error_message_;
    QTimer timeout_;
    Int to_;

    /// Path on mascot server
    String server_path_;
    /// Hostname of the mascot server
    String host_name_;
    /// Login required
    bool requires_login_;
    /// Max reported hits
    Int max_hits_;
    /// Use SSL connection
    bool use_ssl_;
    /// boundary string that will be embedded into the HTTP requests
    String boundary_;
  };

}
#endif /*OPENMS_FORMAT_MASCOTREMOTEQUERY_H*/