qBittorrent
apicontroller.h
Go to the documentation of this file.
1 /*
2  * Bittorrent Client using Qt and libtorrent.
3  * Copyright (C) 2018 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 <QObject>
32 #include <QVariant>
33 #include <QtContainerFwd>
34 
35 class QString;
36 
37 struct ISessionManager;
38 
39 using DataMap = QHash<QString, QByteArray>;
40 using StringMap = QHash<QString, QString>;
41 
42 class APIController : public QObject
43 {
44  Q_OBJECT
45  Q_DISABLE_COPY_MOVE(APIController)
46 
47 #ifndef Q_MOC_RUN
48 #define WEBAPI_PUBLIC
49 #define WEBAPI_PRIVATE
50 #endif
51 
52 public:
53  explicit APIController(ISessionManager *sessionManager, QObject *parent = nullptr);
54 
55  QVariant run(const QString &action, const StringMap &params, const DataMap &data = {});
56 
58 
59 protected:
60  const StringMap &params() const;
61  const DataMap &data() const;
62  void requireParams(const QVector<QString> &requiredParams) const;
63 
64  void setResult(const QString &result);
65  void setResult(const QJsonArray &result);
66  void setResult(const QJsonObject &result);
67 
68 private:
72  QVariant m_result;
73 };
QHash< QString, QString > StringMap
Definition: apicontroller.h:40
QHash< QString, QByteArray > DataMap
Definition: apicontroller.h:39
QVariant run(const QString &action, const StringMap &params, const DataMap &data={})
APIController(ISessionManager *sessionManager, QObject *parent=nullptr)
void requireParams(const QVector< QString > &requiredParams) const
const StringMap & params() const
DataMap m_data
Definition: apicontroller.h:71
QVariant m_result
Definition: apicontroller.h:72
ISessionManager * m_sessionManager
Definition: apicontroller.h:69
const DataMap & data() const
StringMap m_params
Definition: apicontroller.h:70
ISessionManager * sessionManager() const
void setResult(const QString &result)
action
Definition: tstool.py:143