src/webui/api/apicontroller.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2018-2024  Vladimir Golovnev <glassez@yandex.ru>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #pragma once
  30
  31 #include <QtContainerFwd>
  32 #include <QObject>
  33 #include <QString>
  34 #include <QVariant>
  35
  36 #include "base/applicationcomponent.h"
  37
  38 using DataMap = QHash<QString, QByteArray>;
  39 using StringMap = QHash<QString, QString>;
  40
  41 struct APIResult
  42 {
  43     QVariant data;
  44     QString mimeType;
  45     QString filename;
  46
  47     void clear();
  48 };
  49
  50 class APIController : public ApplicationComponent<QObject>
  51 {
  52     Q_OBJECT
  53     Q_DISABLE_COPY_MOVE(APIController)
  54
  55 public:
  56     explicit APIController(IApplication *app, QObject *parent = nullptr);
  57
  58     APIResult run(const QString &action, const StringMap &params, const DataMap &data = {});
  59
  60 protected:
  61     const StringMap &params() const;
  62     const DataMap &data() const;
  63     void requireParams(const QList<QString> &requiredParams) const;
  64
  65     void setResult(const QString &result);
  66     void setResult(const QJsonArray &result);
  67     void setResult(const QJsonObject &result);
  68     void setResult(const QByteArray &result, const QString &mimeType = {}, const QString &filename = {});
  69
  70 private:
  71     StringMap m_params;
  72     DataMap m_data;
  73     APIResult m_result;
  74 };