| OpenMS 2.5.0

MascotRemoteQuery.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: Andreas Bertsch, Daniel Jameson, Chris Bielow, Timo Sachsenberg $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
38 #include <QtCore/QObject>
39 #include <QtCore/QString>
40 #include <QtNetwork/QNetworkAccessManager>
41 #include <QTimer>
42 #include <QNetworkReply>
43
44
45 namespace OpenMS
46 {
56 class MascotRemoteQuery :
57 public QObject,
58 public DefaultParamHandler
59 {
60 Q_OBJECT
61
62 public:
63
67 OPENMS_DLLAPI MascotRemoteQuery(QObject* parent = 0);
69
71 OPENMS_DLLAPI virtual ~MascotRemoteQuery();
73
75 OPENMS_DLLAPI void setQuerySpectra(const String& exp);
76
78 OPENMS_DLLAPI const QByteArray& getMascotXMLResponse() const;
79
81 OPENMS_DLLAPI bool hasError() const;
82
84 OPENMS_DLLAPI const String& getErrorMessage() const;
85
87 OPENMS_DLLAPI String getSearchIdentifier() const;
88
89 protected:
90
91 OPENMS_DLLAPI virtual void updateMembers_();
92
93 public slots:
94
95 OPENMS_DLLAPI void run();
96
97 private slots:
98
100 OPENMS_DLLAPI void timedOut();
101
103 OPENMS_DLLAPI void readResponse(QNetworkReply* reply);
104
106 OPENMS_DLLAPI void downloadProgress(qint64 bytes_read, qint64 bytes_total);
107
109 OPENMS_DLLAPI void uploadProgress(qint64 bytes_read, qint64 bytes_total);
110
112 OPENMS_DLLAPI void followRedirect(QNetworkReply * reply);
113
114 signals:
115
117 OPENMS_DLLAPI void gotRedirect(QNetworkReply * reply);
118
120 OPENMS_DLLAPI void done();
121
122 private:
123
125 void login();
126
128 void execQuery();
129
131 void getResults(QString results_path);
132
134 OPENMS_DLLAPI MascotRemoteQuery& operator=(const MascotRemoteQuery& rhs);
135
137 OPENMS_DLLAPI MascotRemoteQuery(const MascotRemoteQuery& rhs);
138
140 OPENMS_DLLAPI void endRun_();
141
147 void removeHostName_(QString& url);
148
150 QUrl buildUrl_(std::string path);
151
153 OPENMS_DLLAPI void logHeader_(const QNetworkRequest header, const String& what);
154
156 OPENMS_DLLAPI void logHeader_(const QNetworkReply* header, const String& what);
157
158 OPENMS_DLLAPI String getSearchIdentifierFromFilePath(const String& path) const;
159
161 OPENMS_DLLAPI void readResponseHeader(const QNetworkReply* reply);
162
163 QNetworkAccessManager* manager_;
164
165 // Input / Output data
166 String query_spectra_;
167 QByteArray mascot_xml_;
168
169 // Internal data structures
170 QString cookie_;
171 String error_message_;
172 QTimer timeout_;
173 String search_identifier_;
174
176 String server_path_;
178 String host_name_;
180 bool requires_login_;
182 bool use_ssl_;
184 String boundary_;
186 Int to_;
187 };
188
189 }
190
OpenMS::MascotRemoteQuery::manager_
QNetworkAccessManager * manager_
Definition: MascotRemoteQuery.h:163
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MascotRemoteQuery::endRun_
void endRun_()
finish a run and emit "done"
OpenMS::MascotRemoteQuery::timedOut
void timedOut()
slot connected to QTimer (timeout_)
OpenMS::MascotRemoteQuery::logHeader_
void logHeader_(const QNetworkRequest header, const String &what)
Write HTTP header to error stream (for debugging)
OpenMS::MascotRemoteQuery::removeHostName_
void removeHostName_(QString &url)
Remove host name information from an url, e.g., "http://www.google.de/search" -> "search".
OpenMS::MascotRemoteQuery::search_identifier_
String search_identifier_
Definition: MascotRemoteQuery.h:173
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:91
OpenMS::MascotRemoteQuery::uploadProgress
void uploadProgress(qint64 bytes_read, qint64 bytes_total)
slot connected to signal uploadProgress
OpenMS::MascotRemoteQuery::getMascotXMLResponse
const QByteArray & getMascotXMLResponse() const
returns the Mascot XML response which contains the identifications
OpenMS::MascotRemoteQuery::boundary_
String boundary_
boundary string that will be embedded into the HTTP requests
Definition: MascotRemoteQuery.h:184
OpenMS::MascotRemoteQuery::to_
Int to_
Timeout after these many seconds.
Definition: MascotRemoteQuery.h:186
OpenMS::MascotRemoteQuery::buildUrl_
QUrl buildUrl_(std::string path)
helper function to build URL
OpenMS::MascotRemoteQuery::use_ssl_
bool use_ssl_
Use SSL connection.
Definition: MascotRemoteQuery.h:182
OpenMS::MascotRemoteQuery::hasError
bool hasError() const
predicate which returns true if an error occurred during the query
OpenMS::MascotRemoteQuery::getErrorMessage
const String & getErrorMessage() const
returns the error message, if hasError can be used to check whether an error has occurred ...
OpenMS::MascotRemoteQuery::mascot_xml_
QByteArray mascot_xml_
Definition: MascotRemoteQuery.h:167
OpenMS::MascotRemoteQuery::cookie_
QString cookie_
Definition: MascotRemoteQuery.h:170
OpenMS::MascotRemoteQuery::query_spectra_
String query_spectra_
Definition: MascotRemoteQuery.h:166
OpenMS::MascotRemoteQuery::~MascotRemoteQuery
virtual ~MascotRemoteQuery()
destructor
OpenMS::MascotRemoteQuery::downloadProgress
void downloadProgress(qint64 bytes_read, qint64 bytes_total)
slot connected to signal downloadProgress
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MascotRemoteQuery::host_name_
String host_name_
Hostname of the mascot server.
Definition: MascotRemoteQuery.h:178
OpenMS::MascotRemoteQuery::setQuerySpectra
void setQuerySpectra(const String &exp)
sets the query spectra, given in MGF file format
OpenMS::MascotRemoteQuery::followRedirect
void followRedirect(QNetworkReply *reply)
slot connected to signal gotRedirect
OpenMS::MascotRemoteQuery
Class which handles the communication between OpenMS and the Mascot server.
Definition: MascotRemoteQuery.h:56
OpenMS::MascotRemoteQuery::getSearchIdentifierFromFilePath
String getSearchIdentifierFromFilePath(const String &path) const
OpenMS::MascotRemoteQuery::getSearchIdentifier
String getSearchIdentifier() const
returns the search number
OpenMS::MascotRemoteQuery::readResponse
void readResponse(QNetworkReply *reply)
slot connected to the QNetworkAccessManager::finished signal
OpenMS::MascotRemoteQuery::login
void login()
login to Mascot server
DefaultParamHandler.h
OpenMS::MascotRemoteQuery::gotRedirect
void gotRedirect(QNetworkReply *reply)
signal when class got a redirect
OpenMS::MascotRemoteQuery::readResponseHeader
void readResponseHeader(const QNetworkReply *reply)
parse new response header
OpenMS::MascotRemoteQuery::run
void run()
int
OpenMS::MascotRemoteQuery::server_path_
String server_path_
Path on mascot server.
Definition: MascotRemoteQuery.h:176
OpenMS::MascotRemoteQuery::error_message_
String error_message_
Definition: MascotRemoteQuery.h:171
OpenMS::MascotRemoteQuery::operator=
MascotRemoteQuery & operator=(const MascotRemoteQuery &rhs)
assignment operator
OpenMS::MascotRemoteQuery::timeout_
QTimer timeout_
Definition: MascotRemoteQuery.h:172
OpenMS::MascotRemoteQuery::getResults
void getResults(QString results_path)
download result file
OpenMS::MascotRemoteQuery::MascotRemoteQuery
MascotRemoteQuery(QObject *parent=0)
default constructor
QObject
OpenMS::MascotRemoteQuery::updateMembers_
virtual void updateMembers_()
This method is used to update extra member variables at the end of the setParameters() method...
OpenMS::MascotRemoteQuery::requires_login_
bool requires_login_
Login required.
Definition: MascotRemoteQuery.h:180
OpenMS::MascotRemoteQuery::done
void done()
signal when class is done and results can be collected
OpenMS::MascotRemoteQuery::execQuery
void execQuery()
execute query (upload file)