MascotRemoteQuery.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Andreas Bertsch, Daniel Jameson, Chris Bielow, Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
 
#include <string>
#include <vector>
 
typedef void CURL;
 
namespace OpenMS
{
  class MascotRemoteQuery :
    public DefaultParamHandler
  {
public:
 
    OPENMS_DLLAPI MascotRemoteQuery();
 
    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 std::string& getMascotXMLResponse() const;
 
    OPENMS_DLLAPI const std::string& 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);
 
    OPENMS_DLLAPI void run();
 
protected:
 
    OPENMS_DLLAPI void updateMembers_() override;
 
private:
 
    void login(CURL* curl);
 
    void execQuery(CURL* curl);
 
    std::string getResults(CURL* curl, const std::string& results_path);
 
    std::string httpGet(CURL* curl, const std::string& path);
 
    std::string httpPost(CURL* curl, const std::string& path, const std::string& body, const std::string& content_type);
 
    std::string buildUrl(const std::string& path) const;
 
    OPENMS_DLLAPI String getSearchIdentifierFromFilePath(const String& path) const;
 
    std::string removeHostName(const std::string& url) const;
 
    // Input / Output data
    String query_spectra_;
    std::string mascot_xml_;
    std::string mascot_decoy_xml_;
 
    // Internal data structures
    String error_message_;
    String search_identifier_;
 
    String server_path_;
    String host_name_;
    bool requires_login_ = false;
    bool use_ssl_ = false;
    String boundary_;
    Int to_ = 1500;
 
    bool export_decoys_ = false;
  };
 
}