Support configuring WebUI URL base path

src/base/preferences.cpp

@@ -1026,6 +1026,19 @@ void Preferences::setWebUITrustedReverseProxiesList(const QString &addr)
     setValue(u"Preferences/WebUI/TrustedReverseProxiesList"_s, addr);
 }
 
+QString Preferences::getWebUIBasePath() const
+{
+    return value(u"Preferences/WebUI/BasePath"_s, u"/"_s);
+}
+
+void Preferences::setWebUIBasePath(const QString &path)
+{
+    if (path == getWebUIBasePath())
+        return;
+
+    setValue(u"Preferences/WebUI/BasePath"_s, path);
+}
+
 bool Preferences::isDynDNSEnabled() const
 {
     return value(u"Preferences/DynDNS/Enabled"_s, false);

src/base/preferences.h

@@ -237,6 +237,8 @@ class Preferences final : public QObject
     void setWebUIReverseProxySupportEnabled(bool enabled);
     QString getWebUITrustedReverseProxiesList() const;
     void setWebUITrustedReverseProxiesList(const QString &addr);
+    QString getWebUIBasePath() const;
+    void setWebUIBasePath(const QString &path);
 
     // Dynamic DNS
     bool isDynDNSEnabled() const;

src/gui/optionsdialog.cpp

@@ -1313,6 +1313,7 @@ void OptionsDialog::loadWebUITabOptions()
     // Reverse proxy
     m_ui->groupEnableReverseProxySupport->setChecked(pref->isWebUIReverseProxySupportEnabled());
     m_ui->textTrustedReverseProxiesList->setText(pref->getWebUITrustedReverseProxiesList());
+    m_ui->textWebUIBasePath->setText(pref->getWebUIBasePath());
     // DynDNS
     m_ui->checkDynDNS->setChecked(pref->isDynDNSEnabled());
     m_ui->comboDNSService->setCurrentIndex(static_cast<int>(pref->getDynDNSService()));
@@ -1354,6 +1355,7 @@ void OptionsDialog::loadWebUITabOptions()
 
     connect(m_ui->groupEnableReverseProxySupport, &QGroupBox::toggled, this, &ThisType::enableApplyButton);
     connect(m_ui->textTrustedReverseProxiesList, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);
+    connect(m_ui->textWebUIBasePath, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);
 
     connect(m_ui->checkDynDNS, &QGroupBox::toggled, this, &ThisType::enableApplyButton);
     connect(m_ui->comboDNSService, qComboBoxCurrentIndexChanged, this, &ThisType::enableApplyButton);
@@ -1400,6 +1402,17 @@ void OptionsDialog::saveWebUITabOptions() const
     // Reverse proxy
     pref->setWebUIReverseProxySupportEnabled(m_ui->groupEnableReverseProxySupport->isChecked());
     pref->setWebUITrustedReverseProxiesList(m_ui->textTrustedReverseProxiesList->text());
+
+    QString path = m_ui->textWebUIBasePath->text();
+    if (!path.startsWith(u"/"_s))
+        path.prepend(u"/");
+    if (!path.endsWith(u"/"_s))
+        path.append(u"/");
+    QUrl url;
+    url.setPath(path, QUrl::StrictMode);
+    if (url.isValid())
+        pref->setWebUIBasePath(url.path());
+
     // DynDNS
     pref->setDynDNSEnabled(m_ui->checkDynDNS->isChecked());
     pref->setDynDNSService(static_cast<DNS::Service>(m_ui->comboDNSService->currentIndex()));

src/gui/optionsdialog.ui

@@ -3814,6 +3814,24 @@ Use ';' to split multiple entries. Can use wildcard '*'.</string>
                     </item>
                    </layout>
                   </item>
+                  <item>
+                   <layout class="QHBoxLayout" name="horizontalLayout_132">
+                    <item>
+                     <widget class="QLabel" name="lblWebUIBasePath">
+                      <property name="text">
+                       <string>URL base path:</string>
+                      </property>
+                     </widget>
+                    </item>
+                    <item>
+                     <widget class="QLineEdit" name="textWebUIBasePath">
+                      <property name="toolTip">
+                       <string>Specify the URL path qBittorent will be made accessible at (e.g. '/qbittorrent/').</string>
+                      </property>
+                     </widget>
+                    </item>
+                   </layout>
+                  </item>
                   <item>
                    <widget class="QLabel" name="labelReverseProxyLink">
                     <property name="text">

src/webui/api/appcontroller.cpp

@@ -342,6 +342,7 @@ void AppController::preferencesAction()
     // Reverse proxy
     data[u"web_ui_reverse_proxy_enabled"_s] = pref->isWebUIReverseProxySupportEnabled();
     data[u"web_ui_reverse_proxies_list"_s] = pref->getWebUITrustedReverseProxiesList();
+    data[u"web_ui_base_path"_s] = pref->getWebUIBasePath();
     // Update my dynamic domain name
     data[u"dyndns_enabled"_s] = pref->isDynDNSEnabled();
     data[u"dyndns_service"_s] = static_cast<int>(pref->getDynDNSService());
@@ -924,6 +925,18 @@ void AppController::setPreferencesAction()
         pref->setWebUIReverseProxySupportEnabled(it.value().toBool());
     if (hasKey(u"web_ui_reverse_proxies_list"_s))
         pref->setWebUITrustedReverseProxiesList(it.value().toString());
+    if (hasKey(u"web_ui_base_path"_s))
+    {
+        QString path = it.value().toString();
+        if (!path.startsWith(u"/"_s))
+            path.prepend(u"/");
+        if (!path.endsWith(u"/"_s))
+            path.append(u"/");
+        QUrl url;
+        url.setPath(path, QUrl::StrictMode);
+        if (url.isValid())
+            pref->setWebUIBasePath(url.path());
+    }
     // Update my dynamic domain name
     if (hasKey(u"dyndns_enabled"_s))
         pref->setDynDNSEnabled(it.value().toBool());

src/webui/webapplication.cpp

@@ -412,7 +412,7 @@ void WebApplication::configure()
     {
         m_isAltUIUsed = isAltUIUsed;
         m_rootFolder = rootFolder;
-        m_translatedFiles.clear();
+        m_cachedFiles.clear();
         if (!m_isAltUIUsed)
             LogMsg(tr("Using built-in WebUI."));
         else
@@ -423,7 +423,7 @@ void WebApplication::configure()
     if (m_currentLocale != newLocale)
     {
         m_currentLocale = newLocale;
-        m_translatedFiles.clear();
+        m_cachedFiles.clear();
 
         m_translationFileLoaded = m_translator.load((m_rootFolder / Path(u"translations/webui_"_s) + newLocale).data());
         if (m_translationFileLoaded)
@@ -495,6 +495,13 @@ void WebApplication::configure()
     }
 
     m_isReverseProxySupportEnabled = pref->isWebUIReverseProxySupportEnabled();
+    const QString newBasePath = m_isReverseProxySupportEnabled ? pref->getWebUIBasePath() : u"/"_s;
+    if (m_basePath != newBasePath)
+    {
+        m_cachedFiles.clear();
+        m_basePath = newBasePath;
+    }
+
     if (m_isReverseProxySupportEnabled)
     {
         const QStringList proxyList = pref->getWebUITrustedReverseProxiesList().split(u';', Qt::SkipEmptyParts);
@@ -539,8 +546,8 @@ void WebApplication::sendFile(const Path &path)
     // find translated file in cache
     if (!m_isAltUIUsed)
     {
-        if (const auto it = m_translatedFiles.constFind(path);
-            (it != m_translatedFiles.constEnd()) && (lastModified <= it->lastModified))
+        if (const auto it = m_cachedFiles.constFind(path);
+            (it != m_cachedFiles.constEnd()) && (lastModified <= it->lastModified))
         {
             print(it->data, it->mimeType);
             setHeader({Http::HEADER_CACHE_CONTROL, getCachingInterval(it->mimeType)});
@@ -576,20 +583,25 @@ void WebApplication::sendFile(const Path &path)
 
     QByteArray data = readResult.value();
     const QMimeType mimeType = QMimeDatabase().mimeTypeForFileNameAndData(path.data(), data);
-    const bool isTranslatable = !m_isAltUIUsed && mimeType.inherits(u"text/plain"_s);
-
-    if (isTranslatable)
+    const bool isTextFile = mimeType.inherits(u"text/plain"_s);
+    if (isTextFile)
     {
         auto dataStr = QString::fromUtf8(data);
-        // Translate the file
-        translateDocument(dataStr);
+        dataStr.replace(u"${BASE_PATH}"_s, m_basePath);
 
-        // Add the language options
-        if (path == (m_rootFolder / Path(PRIVATE_FOLDER) / Path(u"views/preferences.html"_s)))
-            dataStr.replace(u"${LANGUAGE_OPTIONS}"_s, createLanguagesOptionsHtml());
+        const bool isTranslatable = !m_isAltUIUsed;
+        if (isTranslatable)
+        {
+            // Translate the file
+            translateDocument(dataStr);
+
+            // Add the language options
+            if (path == (m_rootFolder / Path(PRIVATE_FOLDER) / Path(u"views/preferences.html"_s)))
+                dataStr.replace(u"${LANGUAGE_OPTIONS}"_s, createLanguagesOptionsHtml());
+        }
 
         data = dataStr.toUtf8();
-        m_translatedFiles[path] = {data, mimeType.name(), lastModified}; // caching translated file
+        m_cachedFiles[path] = {data, mimeType.name(), lastModified};
     }
 
     print(data, mimeType.name());

src/webui/webapplication.h

@@ -225,14 +225,15 @@ class WebApplication final : public ApplicationComponent<QObject>
     };
     bool m_isAltUIUsed = false;
     Path m_rootFolder;
+    QString m_basePath;
 
-    struct TranslatedFile
+    struct CachedFile
     {
         QByteArray data;
         QString mimeType;
         QDateTime lastModified;
     };
-    QHash<Path, TranslatedFile> m_translatedFiles;
+    QHash<Path, CachedFile> m_cachedFiles;
     QString m_currentLocale;
     QTranslator m_translator;
     bool m_translationFileLoaded = false;

src/webui/www/private/addpeers.html

@@ -4,11 +4,11 @@
 <head>
     <meta charset="UTF-8">
     <title>QBT_TR(Add Peers)QBT_TR[CONTEXT=PeersAdditionDialog]</title>
-    <link rel="stylesheet" href="css/style.css?v=${CACHEID}" type="text/css">
-    <script src="scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/localpreferences.js?v=${CACHEID}"></script>
-    <script src="scripts/color-scheme.js?v=${CACHEID}"></script>
+    <link rel="stylesheet" href="${BASE_PATH}css/style.css?v=${CACHEID}" type="text/css">
+    <script src="${BASE_PATH}scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/localpreferences.js?v=${CACHEID}"></script>
+    <script src="${BASE_PATH}scripts/color-scheme.js?v=${CACHEID}"></script>
     <script>
         "use strict";
 
@@ -42,7 +42,7 @@
                     return;
 
                 new Request({
-                    url: "api/v2/torrents/addPeers",
+                    url: "${BASE_PATH}api/v2/torrents/addPeers",
                     method: "post",
                     data: {
                         hashes: hash,

src/webui/www/private/addtrackers.html

@@ -4,11 +4,11 @@
 <head>
     <meta charset="UTF-8">
     <title>QBT_TR(Add trackers)QBT_TR[CONTEXT=TrackersAdditionDialog]</title>
-    <link rel="stylesheet" href="css/style.css?v=${CACHEID}" type="text/css">
-    <script src="scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/localpreferences.js?v=${CACHEID}"></script>
-    <script src="scripts/color-scheme.js?v=${CACHEID}"></script>
+    <link rel="stylesheet" href="${BASE_PATH}css/style.css?v=${CACHEID}" type="text/css">
+    <script src="${BASE_PATH}scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/localpreferences.js?v=${CACHEID}"></script>
+    <script src="${BASE_PATH}scripts/color-scheme.js?v=${CACHEID}"></script>
     <script>
         "use strict";
 
@@ -34,7 +34,7 @@
 
                 const hash = new URI().getData("hash");
                 new Request({
-                    url: "api/v2/torrents/addTrackers",
+                    url: "${BASE_PATH}api/v2/torrents/addTrackers",
                     method: "post",
                     data: {
                         hash: hash,

src/webui/www/private/addwebseeds.html

@@ -4,11 +4,11 @@
 <head>
     <meta charset="UTF-8">
     <title>QBT_TR(Add web seeds)QBT_TR[CONTEXT=HttpServer]</title>
-    <link rel="stylesheet" href="css/style.css?v=${CACHEID}" type="text/css">
-    <script src="scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/localpreferences.js?v=${CACHEID}"></script>
-    <script src="scripts/color-scheme.js?v=${CACHEID}"></script>
+    <link rel="stylesheet" href="${BASE_PATH}css/style.css?v=${CACHEID}" type="text/css">
+    <script src="${BASE_PATH}scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/localpreferences.js?v=${CACHEID}"></script>
+    <script src="${BASE_PATH}scripts/color-scheme.js?v=${CACHEID}"></script>
     <script>
         "use strict";
 
@@ -32,7 +32,7 @@
                 e.stopPropagation();
                 const hash = new URI().getData("hash");
                 new Request({
-                    url: "api/v2/torrents/addWebSeeds",
+                    url: "${BASE_PATH}api/v2/torrents/addWebSeeds",
                     method: "post",
                     data: {
                         hash: hash,

src/webui/www/private/confirmfeeddeletion.html

@@ -4,11 +4,11 @@
 <head>
     <meta charset="UTF-8">
     <title>QBT_TR(Deletion confirmation)QBT_TR[CONTEXT=RSSWidget]</title>
-    <link rel="stylesheet" href="css/style.css?v=${CACHEID}" type="text/css">
-    <script src="scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/localpreferences.js?v=${CACHEID}"></script>
-    <script src="scripts/color-scheme.js?v=${CACHEID}"></script>
+    <link rel="stylesheet" href="${BASE_PATH}css/style.css?v=${CACHEID}" type="text/css">
+    <script src="${BASE_PATH}scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/localpreferences.js?v=${CACHEID}"></script>
+    <script src="${BASE_PATH}scripts/color-scheme.js?v=${CACHEID}"></script>
     <script>
         "use strict";
 
@@ -27,7 +27,7 @@
                 let completionCount = 0;
                 paths.forEach((path) => {
                     new Request({
-                        url: "api/v2/rss/removeItem",
+                        url: "${BASE_PATH}api/v2/rss/removeItem",
                         method: "post",
                         data: {
                             path: decodeURIComponent(path)

src/webui/www/private/confirmruleclear.html

@@ -4,11 +4,11 @@
 <head>
     <meta charset="UTF-8">
     <title>QBT_TR(Clear downloaded episodes)QBT_TR[CONTEXT=AutomatedRssDownloader]</title>
-    <link rel="stylesheet" href="css/style.css?v=${CACHEID}" type="text/css">
-    <script src="scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/localpreferences.js?v=${CACHEID}"></script>
-    <script src="scripts/color-scheme.js?v=${CACHEID}"></script>
+    <link rel="stylesheet" href="${BASE_PATH}css/style.css?v=${CACHEID}" type="text/css">
+    <script src="${BASE_PATH}scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/localpreferences.js?v=${CACHEID}"></script>
+    <script src="${BASE_PATH}scripts/color-scheme.js?v=${CACHEID}"></script>
     <script>
         "use strict";
 

src/webui/www/private/confirmruledeletion.html

@@ -4,11 +4,11 @@
 <head>
     <meta charset="UTF-8">
     <title>QBT_TR(Rule deletion confirmation)QBT_TR[CONTEXT=AutomatedRssDownloader]</title>
-    <link rel="stylesheet" href="css/style.css?v=${CACHEID}" type="text/css">
-    <script src="scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/localpreferences.js?v=${CACHEID}"></script>
-    <script src="scripts/color-scheme.js?v=${CACHEID}"></script>
+    <link rel="stylesheet" href="${BASE_PATH}css/style.css?v=${CACHEID}" type="text/css">
+    <script src="${BASE_PATH}scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/localpreferences.js?v=${CACHEID}"></script>
+    <script src="${BASE_PATH}scripts/color-scheme.js?v=${CACHEID}"></script>
     <script>
         "use strict";
 
@@ -28,7 +28,7 @@
                 let completionCount = 0;
                 rules.forEach((rule) => {
                     new Request({
-                        url: "api/v2/rss/removeRule",
+                        url: "${BASE_PATH}api/v2/rss/removeRule",
                         method: "post",
                         data: {
                             ruleName: decodeURIComponent(rule)

src/webui/www/private/confirmtrackerdeletion.html

@@ -4,11 +4,11 @@
 <head>
     <meta charset="UTF-8">
     <title>QBT_TR(Remove tracker)QBT_TR[CONTEXT=confirmDeletionDlg]</title>
-    <link rel="stylesheet" href="css/style.css?v=${CACHEID}" type="text/css">
-    <script src="scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
-    <script src="scripts/localpreferences.js?v=${CACHEID}"></script>
-    <script src="scripts/color-scheme.js?v=${CACHEID}"></script>
+    <link rel="stylesheet" href="${BASE_PATH}css/style.css?v=${CACHEID}" type="text/css">
+    <script src="${BASE_PATH}scripts/lib/MooTools-Core-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/lib/MooTools-More-1.6.0-compat-compressed.js"></script>
+    <script src="${BASE_PATH}scripts/localpreferences.js?v=${CACHEID}"></script>
+    <script src="${BASE_PATH}scripts/color-scheme.js?v=${CACHEID}"></script>
     <script>
         "use strict";
 
@@ -24,7 +24,7 @@
             });
             $("confirmBtn").addEvent("click", (e) => {
                 e.stopPropagation();
-                const cmd = "api/v2/torrents/removeTrackers";
+                const cmd = "${BASE_PATH}api/v2/torrents/removeTrackers";
                 new Request({
                     url: cmd,
                     method: "post",