Send 204 when WebAPI response contains no data

src/webui/CMakeLists.txt

@@ -2,6 +2,7 @@ add_library(qbt_webui STATIC
     # headers
     api/apicontroller.h
     api/apierror.h
+    api/apistatus.h
     api/appcontroller.h
     api/authcontroller.h
     api/isessionmanager.h

src/webui/api/apicontroller.cpp

@@ -42,6 +42,7 @@ void APIResult::clear()
     data.clear();
     mimeType.clear();
     filename.clear();
+    status = APIStatus::Ok;
 }
 
 APIController::APIController(IApplication *app, QObject *parent)
@@ -105,3 +106,8 @@ void APIController::setResult(const QByteArray &result, const QString &mimeType,
     m_result.mimeType = mimeType;
     m_result.filename = filename;
 }
+
+void APIController::setStatus(const APIStatus status)
+{
+    m_result.status = status;
+}

src/webui/api/apicontroller.h

@@ -34,6 +34,7 @@
 #include <QVariant>
 
 #include "base/applicationcomponent.h"
+#include "apistatus.h"
 
 using DataMap = QHash<QString, QByteArray>;
 using StringMap = QHash<QString, QString>;
@@ -43,6 +44,7 @@ struct APIResult
     QVariant data;
     QString mimeType;
     QString filename;
+    APIStatus status = APIStatus::Ok;
 
     void clear();
 };
@@ -67,6 +69,8 @@ class APIController : public ApplicationComponent<QObject>
     void setResult(const QJsonObject &result);
     void setResult(const QByteArray &result, const QString &mimeType = {}, const QString &filename = {});
 
+    void setStatus(APIStatus status);
+
 private:
     StringMap m_params;
     DataMap m_data;

src/webui/api/apistatus.h

@@ -0,0 +1,35 @@
+/*
+ * Bittorrent Client using Qt and libtorrent.
+ * Copyright (C) 2024 Thomas Piccirello <thomas@piccirello.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.
+ *
+ * In addition, as a special exception, the copyright holders give permission to
+ * link this program with the OpenSSL project's "OpenSSL" library (or with
+ * modified versions of it that use the same license as the "OpenSSL" library),
+ * and distribute the linked executables. You must obey the GNU General Public
+ * License in all respects for all of the code used other than "OpenSSL".  If you
+ * modify file(s), you may extend this exception to your version of the file(s),
+ * but you are not obligated to do so. If you do not wish to do so, delete this
+ * exception statement from your version.
+ */
+
+#pragma once
+
+enum class APIStatus
+{
+    Ok,
+    Async
+};

src/webui/api/appcontroller.cpp

@@ -123,6 +123,7 @@ void AppController::shutdownAction()
     {
         QCoreApplication::exit();
     });
+    setResult(QString());
 }
 
 void AppController::preferencesAction()
@@ -1157,6 +1158,8 @@ void AppController::setPreferencesAction()
 
     // Save preferences
     pref->apply();
+
+    setResult(QString());
 }
 
 void AppController::defaultSavePathAction()
@@ -1167,9 +1170,9 @@ void AppController::defaultSavePathAction()
 void AppController::sendTestEmailAction()
 {
     app()->sendTestEmail();
+    setResult(QString());
 }
 
-
 void AppController::getDirectoryContentAction()
 {
     requireParams({u"dirPath"_s});
@@ -1259,6 +1262,8 @@ void AppController::setCookiesAction()
     }
 
     Net::DownloadManager::instance()->setAllCookies(cookies);
+
+    setResult(QString());
 }
 
 void AppController::networkInterfaceListAction()

src/webui/api/authcontroller.cpp

@@ -46,11 +46,13 @@ AuthController::AuthController(ISessionManager *sessionManager, IApplication *ap
 void AuthController::setUsername(const QString &username)
 {
     m_username = username;
+    setResult(QString());
 }
 
 void AuthController::setPasswordHash(const QByteArray &passwordHash)
 {
     m_passwordHash = passwordHash;
+    setResult(QString());
 }
 
 void AuthController::loginAction()
@@ -99,6 +101,7 @@ void AuthController::loginAction()
 void AuthController::logoutAction() const
 {
     m_sessionManager->sessionEnd();
+    setResult(QString());
 }
 
 bool AuthController::isBanned() const

src/webui/api/rsscontroller.cpp

@@ -53,6 +53,8 @@ void RSSController::addFolderAction()
     const nonstd::expected<void, QString> result = RSS::Session::instance()->addFolder(path);
     if (!result)
         throw APIError(APIErrorType::Conflict, result.error());
+
+    setResult(QString());
 }
 
 void RSSController::addFeedAction()
@@ -64,6 +66,8 @@ void RSSController::addFeedAction()
     const nonstd::expected<void, QString> result = RSS::Session::instance()->addFeed(url, (path.isEmpty() ? url : path));
     if (!result)
         throw APIError(APIErrorType::Conflict, result.error());
+
+    setResult(QString());
 }
 
 void RSSController::setFeedURLAction()
@@ -75,6 +79,8 @@ void RSSController::setFeedURLAction()
     const nonstd::expected<void, QString> result = RSS::Session::instance()->setFeedURL(path, url);
     if (!result)
         throw APIError(APIErrorType::Conflict, result.error());
+
+    setResult(QString());
 }
 
 void RSSController::removeItemAction()
@@ -85,6 +91,8 @@ void RSSController::removeItemAction()
     const nonstd::expected<void, QString> result = RSS::Session::instance()->removeItem(path);
     if (!result)
         throw APIError(APIErrorType::Conflict, result.error());
+
+    setResult(QString());
 }
 
 void RSSController::moveItemAction()
@@ -96,6 +104,8 @@ void RSSController::moveItemAction()
     const nonstd::expected<void, QString> result = RSS::Session::instance()->moveItem(itemPath, destPath);
     if (!result)
         throw APIError(APIErrorType::Conflict, result.error());
+
+    setResult(QString());
 }
 
 void RSSController::itemsAction()
@@ -130,6 +140,8 @@ void RSSController::markAsReadAction()
     {
         item->markAsRead();
     }
+
+    setResult(QString());
 }
 
 void RSSController::refreshItemAction()
@@ -140,6 +152,8 @@ void RSSController::refreshItemAction()
     RSS::Item *item = RSS::Session::instance()->itemByPath(itemPath);
     if (item)
         item->refresh();
+
+    setResult(QString());
 }
 
 void RSSController::setRuleAction()
@@ -151,6 +165,8 @@ void RSSController::setRuleAction()
 
     const auto jsonObj = QJsonDocument::fromJson(ruleDef).object();
     RSS::AutoDownloader::instance()->setRule(RSS::AutoDownloadRule::fromJsonObject(jsonObj, ruleName));
+
+    setResult(QString());
 }
 
 void RSSController::renameRuleAction()
@@ -161,6 +177,8 @@ void RSSController::renameRuleAction()
     const QString newRuleName {params()[u"newRuleName"_s].trimmed()};
 
     RSS::AutoDownloader::instance()->renameRule(ruleName, newRuleName);
+
+    setResult(QString());
 }
 
 void RSSController::removeRuleAction()
@@ -169,6 +187,8 @@ void RSSController::removeRuleAction()
 
     const QString ruleName {params()[u"ruleName"_s].trimmed()};
     RSS::AutoDownloader::instance()->removeRule(ruleName);
+
+    setResult(QString());
 }
 
 void RSSController::rulesAction()

src/webui/api/searchcontroller.cpp

@@ -142,6 +142,8 @@ void SearchController::stopAction()
         searchHandler->cancelSearch();
         m_activeSearches.remove(id);
     }
+
+    setResult(QString());
 }
 
 void SearchController::statusAction()
@@ -215,6 +217,8 @@ void SearchController::deleteAction()
     searchHandler->cancelSearch();
     m_activeSearches.remove(id);
     m_searchHandlers.erase(iter);
+
+    setResult(QString());
 }
 
 void SearchController::downloadTorrentAction()
@@ -238,6 +242,8 @@ void SearchController::downloadTorrentAction()
             downloadHandler->deleteLater();
         });
     }
+
+    setResult(QString());
 }
 
 void SearchController::pluginsAction()
@@ -253,6 +259,8 @@ void SearchController::installPluginAction()
     const QStringList sources = params()[u"sources"_s].split(u'|');
     for (const QString &source : sources)
         SearchPluginManager::instance()->installPlugin(source);
+
+    setResult(QString());
 }
 
 void SearchController::uninstallPluginAction()
@@ -262,6 +270,8 @@ void SearchController::uninstallPluginAction()
     const QStringList names = params()[u"names"_s].split(u'|');
     for (const QString &name : names)
         SearchPluginManager::instance()->uninstallPlugin(name.trimmed());
+
+    setResult(QString());
 }
 
 void SearchController::enablePluginAction()
@@ -273,6 +283,8 @@ void SearchController::enablePluginAction()
 
     for (const QString &name : names)
         SearchPluginManager::instance()->enablePlugin(name.trimmed(), enable);
+
+    setResult(QString());
 }
 
 void SearchController::updatePluginsAction()
@@ -282,6 +294,8 @@ void SearchController::updatePluginsAction()
     connect(pluginManager, &SearchPluginManager::checkForUpdatesFinished, this, &SearchController::checkForUpdatesFinished);
     connect(pluginManager, &SearchPluginManager::checkForUpdatesFailed, this, &SearchController::checkForUpdatesFailed);
     pluginManager->checkForUpdates();
+
+    setResult(QString());
 }
 
 void SearchController::checkForUpdatesFinished(const QHash<QString, PluginVersion> &updateInfo)
@@ -300,6 +314,8 @@ void SearchController::checkForUpdatesFinished(const QHash<QString, PluginVersio
         LogMsg(tr("Updating plugin %1").arg(pluginName), Log::INFO);
         pluginManager->updatePlugin(pluginName);
     }
+
+    setResult(QString());
 }
 
 void SearchController::checkForUpdatesFailed(const QString &reason)

src/webui/api/torrentcreatorcontroller.cpp

@@ -244,4 +244,6 @@ void TorrentCreatorController::deleteTaskAction()
 
     if (!m_torrentCreationManager->deleteTask(id))
         throw APIError(APIErrorType::NotFound);
+
+    setResult(QString());
 }