File indexing completed on 2024-05-12 04:58:11

 /*
  * Copyright 2009 Jakub Wieczorek <faw217@gmail.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA  02110-1301  USA
  */
 /* ============================================================
 * Falkon - Qt web browser
 * Copyright (C) 2010-2014  David Rosca <nowrep@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * ============================================================ */
 
 #ifndef OPENSEARCHENGINE_H
 #define OPENSEARCHENGINE_H
 
 #include "qzcommon.h"
 
 #include <qpair.h>
 #include <qimage.h>
 #include <qmap.h>
 #include <qnetworkaccessmanager.h>
 #include <qstring.h>
 #include <qurl.h>
 
 class QNetworkReply;
 
 class OpenSearchEngineDelegate;
 class FALKON_EXPORT OpenSearchEngine : public QObject
 {
     Q_OBJECT
 
 Q_SIGNALS:
     void imageChanged();
     void suggestions(const QStringList &suggestions);
 
 public:
     using Parameter = QPair<QString, QString>;
     using Parameters = QList<Parameter>;
 
     Q_PROPERTY(QString name READ name WRITE setName)
     Q_PROPERTY(QString description READ description WRITE setDescription)
     Q_PROPERTY(QString searchUrlTemplate READ searchUrlTemplate WRITE setSearchUrlTemplate)
     Q_PROPERTY(Parameters searchParameters READ searchParameters WRITE setSearchParameters)
     Q_PROPERTY(QString searchMethod READ searchMethod WRITE setSearchMethod)
     Q_PROPERTY(QString suggestionsUrlTemplate READ suggestionsUrlTemplate WRITE setSuggestionsUrlTemplate)
     Q_PROPERTY(Parameters suggestionsParameters READ suggestionsParameters WRITE setSuggestionsParameters)
     Q_PROPERTY(QString suggestionsMethod READ suggestionsMethod WRITE setSuggestionsMethod)
     Q_PROPERTY(bool providesSuggestions READ providesSuggestions)
     Q_PROPERTY(QString imageUrl READ imageUrl WRITE setImageUrl)
     Q_PROPERTY(bool valid READ isValid)
     Q_PROPERTY(QNetworkAccessManager* networkAccessManager READ networkAccessManager WRITE setNetworkAccessManager)
 
     OpenSearchEngine(QObject* parent = nullptr);
     ~OpenSearchEngine();
 
     QString name() const;
     void setName(const QString &name);
 
     QString description() const;
     void setDescription(const QString &description);
 
     QString searchUrlTemplate() const;
     void setSearchUrlTemplate(const QString &searchUrl);
     QUrl searchUrl(const QString &searchTerm) const;
 
     QByteArray getPostData(const QString &searchTerm) const;
 
     bool providesSuggestions() const;
 
     QString suggestionsUrlTemplate() const;
     void setSuggestionsUrlTemplate(const QString &suggestionsUrl);
     QUrl suggestionsUrl(const QString &searchTerm) const;
 
     Parameters searchParameters() const;
     void setSearchParameters(const Parameters &searchParameters);
 
     Parameters suggestionsParameters() const;
     void setSuggestionsParameters(const Parameters &suggestionsParameters);
 
     QString searchMethod() const;
     void setSearchMethod(const QString &method);
 
     QString suggestionsMethod() const;
     void setSuggestionsMethod(const QString &method);
 
     QString imageUrl() const;
     void setImageUrl(const QString &url);
 
     QImage image() const;
     void setImage(const QImage &image);
 
     bool isValid() const;
 
     void setSuggestionsUrl(const QString &string);
     void setSuggestionsParameters(const QByteArray &parameters);
     QString getSuggestionsUrl();
     QByteArray getSuggestionsParameters();
 
     QNetworkAccessManager* networkAccessManager() const;
     void setNetworkAccessManager(QNetworkAccessManager* networkAccessManager);
 
     OpenSearchEngineDelegate* delegate() const;
     void setDelegate(OpenSearchEngineDelegate* delegate);
 
     bool operator==(const OpenSearchEngine &other) const;
     bool operator<(const OpenSearchEngine &other) const;
 
 public Q_SLOTS:
     void requestSuggestions(const QString &searchTerm);
     void requestSearchResults(const QString &searchTerm);
 
 protected:
     static QString parseTemplate(const QString &searchTerm, const QString &searchTemplate);
     void loadImage() const;
 
 private Q_SLOTS:
     void imageObtained();
     void suggestionsObtained();
 
 private:
     QString m_name;
     QString m_description;
 
     QString m_imageUrl;
     QImage m_image;
 
     QString m_searchUrlTemplate;
     QString m_suggestionsUrlTemplate;
     Parameters m_searchParameters;
     Parameters m_suggestionsParameters;
     QString m_searchMethod;
     QString m_suggestionsMethod;
 
     QByteArray m_preparedSuggestionsParameters;
     QString m_preparedSuggestionsUrl;
 
     QMap<QString, QNetworkAccessManager::Operation> m_requestMethods;
 
     QNetworkAccessManager* m_networkAccessManager;
     QNetworkReply* m_suggestionsReply;
 
     OpenSearchEngineDelegate* m_delegate;
 };
 
 #endif // OPENSEARCHENGINE_H