Add support for complex network requests

Author: hluk

docs/scripting-api.rst

@@ -2094,6 +2094,45 @@ Types
 
        Exit code
 
+.. js:class:: NetworkRequest
+
+   Make HTTP requests.
+
+   Example:
+
+   .. code-block:: js
+
+       let req = NetworkRequest();
+
+       # allow redirects
+       req.maxRedirects = 5;
+
+       # set request headers
+       req.headers = {
+          'User-Agent': req.headers['User-Agent'],
+          'Accept': 'application/json',
+       };
+
+       # create JSON data
+       const data = JSON.stringify({text: 'Hello, **world**!'});
+
+       # send POST request
+       const reply = req.request(
+           'POST', 'https://api.github.com/markdown', data)
+
+       # the request is synchronous and may not be finished
+       # until a property is called (like reply.data or reply.status)
+       if (!reply.finished) { serverLog('Processing...'); }
+       print(reply.data);
+
+   .. js:attribute:: headers
+
+       Object with HTTP headers
+
+   .. js:attribute:: maxRedirects
+
+       Maximum number of redirects to follow (default is 0)
+
 .. js:class:: NetworkReply
 
    Received network reply object.
@@ -2123,6 +2162,11 @@ Types
        True only if request has been completed, false only for unfinished
        asynchronous requests
 
+   .. js:attribute:: url
+
+       URL of the final request (may be different from the original if
+       redirects are enabled)
+
 .. js:class:: Command
 
    Wrapper for a command (from Command dialog).

src/gui/commandcompleterdocumentation.h

@@ -190,6 +190,7 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
     addDocumentation("Item", "Item", "Object with MIME types of an item.");
     addDocumentation("ItemSelection", "ItemSelection", "List of items from given tab.");
     addDocumentation("FinishedCommand", "FinishedCommand", "Properties of finished command.");
+    addDocumentation("NetworkRequest", "NetworkRequest", "Make HTTP requests.");
     addDocumentation("NetworkReply", "NetworkReply", "Received network reply object.");
     addDocumentation("Command", "Command", "Wrapper for a command (from Command dialog).");
     addDocumentation("arguments", "arguments", "Array for accessing arguments passed to current function or the script (`arguments[0]` is the script itself).");

src/scriptable/scriptable.cpp

@@ -30,6 +30,8 @@
 #include "scriptable/scriptabletemporaryfile.h"
 #include "scriptable/scriptoverrides.h"
 #include "scriptable/scriptvaluefactory.h"
+#include "scriptable/scriptablenetworkrequest.h"
+#include "scriptable/scriptablenetworkreply.h"
 
 #include <QApplication>
 #include <QCryptographicHash>
@@ -428,6 +430,10 @@ Scriptable::Scriptable(
         &ScriptableItemSelection::staticMetaObject, QStringLiteral("ItemSelection"), m_engine);
     m_settingsPrototype = addScriptableClass(
         &ScriptableSettings::staticMetaObject, QStringLiteral("Settings"), m_engine);
+    m_networkRequestPrototype = addScriptableClass(
+        &ScriptableNetworkRequest::staticMetaObject, QStringLiteral("NetworkRequest"), m_engine);
+    m_networkReplyPrototype = addScriptableClass(
+        &ScriptableNetworkReply::staticMetaObject, QStringLiteral("NetworkReply"), m_engine);
 }
 
 QJSValue Scriptable::argumentsArray() const
@@ -713,6 +719,16 @@ QJSValue Scriptable::Settings() const
     return newQObject(new ScriptableSettings(toString(arg)), m_settingsPrototype);
 }
 
+QJSValue Scriptable::NetworkReply() const
+{
+    return newQObject(new ScriptableNetworkReply(), m_networkReplyPrototype);
+}
+
+QJSValue Scriptable::NetworkRequest() const
+{
+    return newQObject(new ScriptableNetworkRequest(), m_networkRequestPrototype);
+}
+
 QJSValue Scriptable::version()
 {
     m_skipArguments = 0;
@@ -2158,28 +2174,32 @@ QJSValue Scriptable::exportCommands()
 
 QJSValue Scriptable::networkGet()
 {
-    NetworkReply *reply = networkGetHelper();
-    reply->data();
-    return reply->toScriptValue();
+    QJSValue reply = networkGetAsync();
+    reply.property("data");
+    return reply;
 }
 
 QJSValue Scriptable::networkPost()
 {
-    NetworkReply *reply = networkPostHelper();
-    reply->data();
-    return reply->toScriptValue();
+    QJSValue reply = networkPostAsync();
+    reply.property("data");
+    return reply;
 }
 
 QJSValue Scriptable::networkGetAsync()
 {
-    NetworkReply *reply = networkGetHelper();
-    return reply->toScriptValue();
+    m_skipArguments = 1;
+    auto requestJs = this->NetworkRequest();
+    auto request = qobject_cast<ScriptableNetworkRequest *>(requestJs.toQObject());
+    return request->request(newByteArray("GET"), argument(0), {});
 }
 
 QJSValue Scriptable::networkPostAsync()
 {
-    NetworkReply *reply = networkPostHelper();
-    return reply->toScriptValue();
+    m_skipArguments = 2;
+    auto requestJs = this->NetworkRequest();
+    auto request = qobject_cast<ScriptableNetworkRequest *>(requestJs.toQObject());
+    return request->request(newByteArray("POST"), argument(0), argument(1));
 }
 
 QJSValue Scriptable::env()
@@ -3651,21 +3671,6 @@ void Scriptable::interruptibleSleep(int msec)
     loop.exec();
 }
 
-NetworkReply *Scriptable::networkGetHelper()
-{
-    m_skipArguments = 1;
-    const QString url = arg(0);
-    return NetworkReply::get(url, this);
-}
-
-NetworkReply *Scriptable::networkPostHelper()
-{
-    m_skipArguments = 2;
-    const QString url = arg(0);
-    const QByteArray postData = makeByteArray(argument(1));
-    return NetworkReply::post(url, postData, this);
-}
-
 QJSValue Scriptable::newQObject(QObject *obj, const QJSValue &prototype) const
 {
     auto value = m_engine->newQObject(obj);
@@ -3715,120 +3720,6 @@ void Scriptable::installObject(QObject *fromObj, const QMetaObject *metaObject,
     }
 }
 
-NetworkReply *NetworkReply::get(const QString &url, Scriptable *scriptable)
-{
-    return new NetworkReply(url, QByteArray(), scriptable);
-}
-
-NetworkReply *NetworkReply::post(const QString &url, const QByteArray &postData, Scriptable *scriptable)
-{
-    return new NetworkReply(url, postData, scriptable);
-}
-
-NetworkReply::~NetworkReply()
-{
-    if (m_reply)
-        m_reply->deleteLater();
-}
-
-QJSValue NetworkReply::data()
-{
-    if ( !m_data.isUndefined() )
-        return m_data;
-
-    if ( !m_reply->isFinished() && m_scriptable->canContinue() ) {
-        QEventLoop loop;
-        connect(m_scriptable, &Scriptable::finished, &loop, &QEventLoop::quit);
-        connect(m_reply, &QNetworkReply::finished, &loop, &QEventLoop::quit);
-        loop.exec();
-    }
-
-    if ( !m_reply->isFinished() )
-        return QJSValue();
-
-    m_data = m_scriptable->newByteArray(m_rawData);
-
-    return m_data;
-}
-
-QJSValue NetworkReply::error()
-{
-    data();
-
-    if (m_reply->error() != QNetworkReply::NoError)
-        return m_reply->errorString();
-
-    return QJSValue();
-}
-
-QJSValue NetworkReply::status()
-{
-    data();
-
-    const QVariant v = m_reply->attribute(QNetworkRequest::HttpStatusCodeAttribute);
-    if (v.isValid())
-        return v.toInt();
-    return QJSValue();
-}
-
-QJSValue NetworkReply::redirect()
-{
-    data();
-
-    const QVariant v = m_reply->attribute(QNetworkRequest::RedirectionTargetAttribute);
-    if (v.isValid())
-        return v.toUrl().resolved(m_reply->url()).toString();
-    return QJSValue();
-}
-
-QJSValue NetworkReply::headers()
-{
-    data();
-
-    QJSValue headers = m_scriptable->engine()->newArray();
-    int i = 0;
-    for ( const auto &header : m_reply->rawHeaderList() ) {
-        QJSValue pair = m_scriptable->engine()->newArray();
-        pair.setProperty( 0, m_scriptable->newByteArray(header) );
-        pair.setProperty( 1, m_scriptable->newByteArray(m_reply->rawHeader(header)) );
-        headers.setProperty( static_cast<quint32>(i), pair );
-        ++i;
-    }
-
-    return headers;
-}
-
-QJSValue NetworkReply::finished()
-{
-    return m_reply->isFinished();
-}
-
-NetworkReply::NetworkReply(const QString &url, const QByteArray &postData, Scriptable *scriptable)
-    : QObject(scriptable)
-    , m_scriptable(scriptable)
-    , m_manager(new QNetworkAccessManager(this))
-    , m_reply(nullptr)
-{
-    if (postData.isEmpty())
-        m_reply = m_manager->get(QNetworkRequest(url));
-    else
-        m_reply = m_manager->post(QNetworkRequest(url), postData);
-
-    connect(m_reply, &QNetworkReply::readyRead, this, [this](){
-        const qint64 available = m_reply->bytesAvailable();
-        m_rawData.append( m_reply->read(available) );
-    });
-    const qint64 available = m_reply->bytesAvailable();
-    m_rawData.append( m_reply->read(available) );
-}
-
-QJSValue NetworkReply::toScriptValue()
-{
-    if ( m_self.isUndefined() )
-        m_self = m_scriptable->engine()->newQObject(this);
-    return m_self;
-}
-
 ScriptablePlugins::ScriptablePlugins(Scriptable *scriptable, ItemFactory *factory)
     : QObject(scriptable)
     , m_scriptable(scriptable)

src/scriptable/scriptable.h

@@ -19,13 +19,10 @@ class Action;
 class ScriptableByteArray;
 class ClipboardBrowser;
 class ItemFactory;
-class NetworkReply;
 class ScriptableProxy;
 
 class QFile;
 class QMimeData;
-class QNetworkReply;
-class QNetworkAccessManager;
 class QJSEngine;
 
 enum class ClipboardOwnership;
@@ -162,6 +159,8 @@ public slots:
     QJSValue Dir() const;
     QJSValue ItemSelection() const;
     QJSValue Settings() const;
+    QJSValue NetworkRequest() const;
+    QJSValue NetworkReply() const;
 
     QJSValue version();
     QJSValue help();
@@ -470,9 +469,6 @@ public slots:
 
     void interruptibleSleep(int msec);
 
-    NetworkReply *networkGetHelper();
-    NetworkReply *networkPostHelper();
-
     QJSValue newQObject(QObject *obj, const QJSValue &prototype) const;
 
     ScriptableProxy *m_proxy;
@@ -517,44 +513,8 @@ public slots:
     QJSValue m_dirPrototype;
     QJSValue m_itemSelectionPrototype;
     QJSValue m_settingsPrototype;
-};
-
-class NetworkReply final : public QObject {
-    Q_OBJECT
-    Q_PROPERTY(QJSValue data READ data CONSTANT)
-    Q_PROPERTY(QJSValue error READ error CONSTANT)
-    Q_PROPERTY(QJSValue status READ status CONSTANT)
-    Q_PROPERTY(QJSValue redirect READ redirect CONSTANT)
-    Q_PROPERTY(QJSValue headers READ headers CONSTANT)
-    Q_PROPERTY(QJSValue finished READ finished CONSTANT)
-
-public:
-    static NetworkReply *get(const QString &url, Scriptable *scriptable);
-    static NetworkReply *post(const QString &url, const QByteArray &postData, Scriptable *scriptable);
-
-    ~NetworkReply();
-
-    QJSValue data();
-
-    QJSValue error();
-
-    QJSValue status();
-    QJSValue redirect();
-    QJSValue headers();
-
-    QJSValue finished();
-
-    QJSValue toScriptValue();
-
-private:
-    explicit NetworkReply(const QString &url, const QByteArray &postData, Scriptable *scriptable);
-
-    Scriptable *m_scriptable;
-    QNetworkAccessManager *m_manager;
-    QNetworkReply *m_reply;
-    QJSValue m_data;
-    QJSValue m_self;
-    QByteArray m_rawData;
+    QJSValue m_networkRequestPrototype;
+    QJSValue m_networkReplyPrototype;
 };
 
 class ScriptablePlugins final : public QObject {