/*
- * Copyright © 2022 Soren Stoutner <soren@stoutner.com>.
+ * Copyright 2022 Soren Stoutner <soren@stoutner.com>.
*
* This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
*
*/
// Application headers.
+#include "Settings.h"
#include "UserAgentHelper.h"
+#include "widgets/TabWidget.h"
-// The default constructor.
-UserAgentHelper::UserAgentHelper() {};
+// KDE Framework headers.
+#include <KLocalizedString>
-QString UserAgentHelper::getUserAgent(const QString &userAgentName)
+// Define the public database constants.
+const QString UserAgentHelper::SYSTEM_DEFAULT_DATABASE = QLatin1String("System Default");
+const QString UserAgentHelper::PRIVACY_BROWSER_DATABASE = QLatin1String("Privacy Browser");
+const QString UserAgentHelper::WEB_ENGINE_DEFAULT_DATABASE = QLatin1String("WebEngine Default");
+const QString UserAgentHelper::FIREFOX_LINUX_DATABASE = QLatin1String("Firefox Linux");
+const QString UserAgentHelper::CHROMIUM_LINUX_DATABASE = QLatin1String("Chromium Linux");
+const QString UserAgentHelper::FIREFOX_WINDOWS_DATABASE = QLatin1String("Firefox Windows");
+const QString UserAgentHelper::CHROME_WINDOWS_DATABASE = QLatin1String("Chrome Windows");
+const QString UserAgentHelper::EDGE_WINDOWS_DATABASE = QLatin1String("Edge Windows");
+const QString UserAgentHelper::SAFARI_MACOS_DATABASE = QLatin1String("Safari macOS");
+
+// Define the public user agent constants.
+const QString UserAgentHelper::PRIVACY_BROWSER_USER_AGENT = QLatin1String("PrivacyBrowser/1.0");
+const QString UserAgentHelper::FIREFOX_LINUX_USER_AGENT = QLatin1String("Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Firefox/102.0");
+const QString UserAgentHelper::CHROMIUM_LINUX_USER_AGENT = QLatin1String("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36");
+const QString UserAgentHelper::FIREFOX_WINDOWS_USER_AGENT = QLatin1String("Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:108.0) Gecko/20100101 Firefox/108.0");
+const QString UserAgentHelper::CHROME_WINDOWS_USER_AGENT = QLatin1String("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36");
+const QString UserAgentHelper::EDGE_WINDOWS_USER_AGENT = QLatin1String("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36 Edg/108.0.1462.54");
+const QString UserAgentHelper::SAFARI_MACOS_USER_AGENT = QLatin1String("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.0 Safari/605.1.15");
+
+// Construct the class.
+UserAgentHelper::UserAgentHelper() {
+ // Populate the translated user agents. Translated entries cannot be public static const.
+ SYSTEM_DEFAULT_TRANSLATED = i18nc("User agents", "System default");
+ PRIVACY_BROWSER_TRANSLATED = i18nc("User agents", "Privacy Browser");
+ WEB_ENGINE_DEFAULT_TRANSLATED = i18nc("User agents", "WebEngine default");
+ FIREFOX_LINUX_TRANSLATED = i18nc("User agents", "Firefox on Linux");
+ CHROMIUM_LINUX_TRANSLATED = i18nc("User agents", "Chromium on Linux");
+ FIREFOX_WINDOWS_TRANSLATED = i18nc("User agents", "Firefox on Windows");
+ CHROME_WINDOWS_TRANSLATED = i18nc("User agents", "Chrome on Windows");
+ EDGE_WINDOWS_TRANSLATED = i18nc("User agents", "Edge on Windows");
+ SAFARI_MACOS_TRANSLATED = i18nc("User agents", "Safari on macOS");
+};
+
+QString UserAgentHelper::getDatabaseUserAgentNameFromTranslatedName(const QString &translatedUserAgentName)
+{
+ // Return the database user agent name.
+ if (translatedUserAgentName == SYSTEM_DEFAULT_TRANSLATED) return SYSTEM_DEFAULT_DATABASE; // System Default.
+ else if (translatedUserAgentName == PRIVACY_BROWSER_TRANSLATED) return PRIVACY_BROWSER_DATABASE; // Privacy Browser.
+ else if (translatedUserAgentName == WEB_ENGINE_DEFAULT_TRANSLATED) return WEB_ENGINE_DEFAULT_DATABASE; // WebEngine default.
+ else if (translatedUserAgentName == FIREFOX_LINUX_TRANSLATED) return FIREFOX_LINUX_DATABASE; // Firefox Linux.
+ else if (translatedUserAgentName == CHROMIUM_LINUX_TRANSLATED) return CHROMIUM_LINUX_DATABASE; // Chromium Linux.
+ else if (translatedUserAgentName == FIREFOX_WINDOWS_TRANSLATED) return FIREFOX_WINDOWS_DATABASE; // Firefox Windows.
+ else if (translatedUserAgentName == CHROME_WINDOWS_TRANSLATED) return CHROME_WINDOWS_DATABASE; // Chrome Windows.
+ else if (translatedUserAgentName == EDGE_WINDOWS_TRANSLATED) return EDGE_WINDOWS_DATABASE; // Edge Windows.
+ else if (translatedUserAgentName == SAFARI_MACOS_TRANSLATED) return SAFARI_MACOS_DATABASE; // Safari macOS.
+ else return translatedUserAgentName; // Return the custom user agent.
+}
+
+int UserAgentHelper::getDomainSettingsUserAgentIndex(const QString &userAgentName)
+{
+ // Return the domain settings user agent index.
+ if (userAgentName == SYSTEM_DEFAULT_DATABASE) return 0; // System Default.
+ else if (userAgentName == PRIVACY_BROWSER_DATABASE) return 1; // Privacy Browser.
+ else if (userAgentName == WEB_ENGINE_DEFAULT_DATABASE) return 2; // WebEngine default.
+ else if (userAgentName == FIREFOX_LINUX_DATABASE) return 3; // Firefox Linux.
+ else if (userAgentName == CHROMIUM_LINUX_DATABASE) return 4; // Chromium Linux.
+ else if (userAgentName == FIREFOX_WINDOWS_DATABASE) return 5; // Firefox Windows.
+ else if (userAgentName == CHROME_WINDOWS_DATABASE) return 6; // Chrome Windows.
+ else if (userAgentName == EDGE_WINDOWS_DATABASE) return 7; // Edge Windows.
+ else if (userAgentName == SAFARI_MACOS_DATABASE) return 8; // Safari macOS.
+ else return -1; // Custom user agent.
+}
+
+QString UserAgentHelper::getUserAgentFromDatabaseName(const QString &userAgentDatabaseName)
+{
+ if (userAgentDatabaseName == PRIVACY_BROWSER_DATABASE) return PRIVACY_BROWSER_USER_AGENT; // Privacy Browser.
+ else if (userAgentDatabaseName == WEB_ENGINE_DEFAULT_DATABASE) return TabWidget::webEngineDefaultUserAgent; // WebEngine default.
+ else if (userAgentDatabaseName == FIREFOX_LINUX_DATABASE) return FIREFOX_LINUX_USER_AGENT; // Firefox Linux.
+ else if (userAgentDatabaseName == CHROMIUM_LINUX_DATABASE) return CHROMIUM_LINUX_USER_AGENT; // Chromium Linux.
+ else if (userAgentDatabaseName == FIREFOX_WINDOWS_DATABASE) return FIREFOX_WINDOWS_USER_AGENT; // Firefox Windows.
+ else if (userAgentDatabaseName == CHROME_WINDOWS_DATABASE) return CHROME_WINDOWS_USER_AGENT; // Chrome Windows.
+ else if (userAgentDatabaseName == EDGE_WINDOWS_DATABASE) return EDGE_WINDOWS_USER_AGENT; // Edge Windows.
+ else if (userAgentDatabaseName == SAFARI_MACOS_DATABASE) return SAFARI_MACOS_USER_AGENT; // Safari macOS.
+ else return userAgentDatabaseName; // Return the custom user agent.
+}
+
+QString UserAgentHelper::getUserAgentFromTranslatedName(const QString &userAgentTranslatedName)
+{
+ if (userAgentTranslatedName == PRIVACY_BROWSER_TRANSLATED) return PRIVACY_BROWSER_USER_AGENT; // Privacy Browser.
+ else if (userAgentTranslatedName == WEB_ENGINE_DEFAULT_TRANSLATED) return TabWidget::webEngineDefaultUserAgent; // WebEngine default.
+ else if (userAgentTranslatedName == FIREFOX_LINUX_TRANSLATED) return FIREFOX_LINUX_USER_AGENT; // Firefox on Linux.
+ else if (userAgentTranslatedName == CHROMIUM_LINUX_TRANSLATED) return CHROMIUM_LINUX_USER_AGENT; // Chromium on Linux.
+ else if (userAgentTranslatedName == FIREFOX_WINDOWS_TRANSLATED) return FIREFOX_WINDOWS_USER_AGENT; // Firefox on Windows.
+ else if (userAgentTranslatedName == CHROME_WINDOWS_TRANSLATED) return CHROME_WINDOWS_USER_AGENT; // Chrome on Windows.
+ else if (userAgentTranslatedName == EDGE_WINDOWS_TRANSLATED) return EDGE_WINDOWS_USER_AGENT; // Edge on Windows.
+ else if (userAgentTranslatedName == SAFARI_MACOS_TRANSLATED) return SAFARI_MACOS_USER_AGENT; // Safari on macOS.
+ else return userAgentTranslatedName; // Return the custom user agent.
+}
+
+QString UserAgentHelper::getResultingDomainSettingsUserAgent(const QString &rawUserAgent)
+{
+ // Return the resulting user agent. If `System default` is selected, it looks up the default user agent from the settings.
+ if (rawUserAgent == SYSTEM_DEFAULT_DATABASE) return getUserAgentFromDatabaseName(Settings::userAgent()); // Return the default user agent.
+ else return getUserAgentFromDatabaseName(rawUserAgent); // Return the domain user agent.
+}
+
+QString UserAgentHelper::getTranslatedUserAgentNameFromDatabaseName(const QString &userAgentName)
{
- if (userAgentName == "Privacy Browser") // Privacy Browser.
- {
- return "PrivacyBrowser/1.0";
- }
- else if (userAgentName == "Firefox Linux") // Firefox Linux.
- {
- return "Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0";
- }
- else if (userAgentName == "Chromium Linux") // Chromium Linux.
- {
- return "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36";
- }
- else if (userAgentName == "Firefox Windows") // Firefox Windows.
- {
- return "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:94.0) Gecko/20100101 Firefox/94.0";
- }
- else if (userAgentName == "Chrome Windows") // Chrome Windows.
- {
- return "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.45 Safari/537.36";
- }
- else if (userAgentName == "Edge Windows") // Edge Windows.
- {
- return "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36 Edg/96.0.1054.34";
- }
- else if (userAgentName == "Safari macOS") // Safari macOS.
- {
- return "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1 Safari/605.1.15";
- }
- else
- {
- // Return the custom user agent.
- return userAgentName;
- }
+ // Return the translated user agent name.
+ if (userAgentName == PRIVACY_BROWSER_DATABASE) return PRIVACY_BROWSER_TRANSLATED; // Privacy Browser.
+ else if (userAgentName == WEB_ENGINE_DEFAULT_DATABASE) return WEB_ENGINE_DEFAULT_TRANSLATED; // WebEngine default.
+ else if (userAgentName == FIREFOX_LINUX_DATABASE) return FIREFOX_LINUX_TRANSLATED; // Firefox on Linux.
+ else if (userAgentName == CHROMIUM_LINUX_DATABASE) return CHROMIUM_LINUX_TRANSLATED; // Chromium on Linux.
+ else if (userAgentName == FIREFOX_WINDOWS_DATABASE) return FIREFOX_WINDOWS_TRANSLATED; // Firefox on Windows.
+ else if (userAgentName == CHROME_WINDOWS_DATABASE) return CHROME_WINDOWS_TRANSLATED; // Chrome on Windows.
+ else if (userAgentName == EDGE_WINDOWS_DATABASE) return EDGE_WINDOWS_TRANSLATED; // Edge on Windows.
+ else if (userAgentName == SAFARI_MACOS_DATABASE) return SAFARI_MACOS_TRANSLATED; // Safari on macOS.
+ else return userAgentName; // Return the custom user agent.
}
projects / PrivacyBrowserPC.git / blobdiff