Changeset 258877 in webkit

Timestamp:

Mar 23, 2020 2:50:48 PM (4 years ago)

Author:

commit-queue@webkit.org

Message:

[GTK] Allow distributors to brand user agent
​https://bugs.webkit.org/show_bug.cgi?id=162611

Patch by Michael Catanzaro <Michael Catanzaro> on 2020-03-23
Reviewed by Adrian Perez de Castro.

.:

Add build option for inserting distributor branding into the user agent string.

• Source/cmake/OptionsGTK.cmake:
• Source/cmake/OptionsWPE.cmake:

Source/WebCore:

• platform/glib/UserAgentGLib.cpp:

(WebCore::buildUserAgentString):

Location:

trunk

Files:

• ChangeLog (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/platform/glib/UserAgentGLib.cpp (modified) (2 diffs)
• Source/cmake/OptionsGTK.cmake (modified) (1 diff)
• Source/cmake/OptionsWPE.cmake (modified) (1 diff)

trunk/ChangeLog

@@ +1 @@
+2020-03-23  Michael Catanzaro  <mcatanzaro@gnome.org>
+
+        [GTK] Allow distributors to brand user agent
+        https://bugs.webkit.org/show_bug.cgi?id=162611
+
+        Reviewed by Adrian Perez de Castro.
+
+        Add build option for inserting distributor branding into the user agent string.
+
+        * Source/cmake/OptionsGTK.cmake:
+        * Source/cmake/OptionsWPE.cmake:
+
 2020-03-23  Philippe Normand  <pnormand@igalia.com>
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2020-03-23  Michael Catanzaro  <mcatanzaro@gnome.org>
+
+        [GTK] Allow distributors to brand user agent
+        https://bugs.webkit.org/show_bug.cgi?id=162611
+
+        Reviewed by Adrian Perez de Castro.
+
+        * platform/glib/UserAgentGLib.cpp:
+        (WebCore::buildUserAgentString):
+
 2020-03-23  Dean Jackson  <dino@apple.com>
 

trunk/Source/WebCore/platform/glib/UserAgentGLib.cpp

@@ -90 +90 @@
         uaString.append(platformForUAString());
         uaString.appendLiteral("; ");
+#if defined(USER_AGENT_BRANDING)
+        uaString.appendLiteral(USER_AGENT_BRANDING "; ");
+#endif
         uaString.append(platformVersionForUAString());
     }
@@ -142 +145 @@
         userAgent = standardUserAgentStatic() + ' ' + applicationName + '/' + finalApplicationVersion;
     }
-    ASSERT(isValidUserAgentHeaderValue(userAgent));
+
+    static bool checked = false;
+    if (!checked) {
+        // For release builds, we'll only check the first resource load, mainly to ensure that any
+        // configured application details or user agent branding is OK.
+        RELEASE_ASSERT_WITH_MESSAGE(isValidUserAgentHeaderValue(userAgent), "%s is not a valid user agent header", userAgent.utf8().data());
+        checked = true;
+    }
+    ASSERT(isValidUserAgentHeaderValue(userAgent);
     return userAgent;
 }

trunk/Source/cmake/OptionsGTK.cmake

@@ -17 +17 @@
 set(INTROSPECTION_INSTALL_GIRDIR "${CMAKE_INSTALL_FULL_DATADIR}/gir-1.0")
 set(INTROSPECTION_INSTALL_TYPELIBDIR "${LIB_INSTALL_DIR}/girepository-1.0")
+
+set(USER_AGENT_BRANDING "" CACHE STRING "Branding to add to user agent string")
+if (USER_AGENT_BRANDING)
+    add_definitions(-DUSER_AGENT_BRANDING="${USER_AGENT_BRANDING}")
+endif ()
 
 find_package(Cairo 1.14.0 REQUIRED)

trunk/Source/cmake/OptionsWPE.cmake

@@ -12 +12 @@
 set(EXEC_INSTALL_DIR "${CMAKE_INSTALL_FULL_BINDIR}" CACHE PATH "Absolute path to executable installation directory")
 set(LIBEXEC_INSTALL_DIR "${CMAKE_INSTALL_FULL_LIBEXECDIR}/wpe-webkit-${WPE_API_VERSION}" CACHE PATH "Absolute path to install executables executed by the library")
+
+set(USER_AGENT_BRANDING "" CACHE STRING "Branding to add to user agent string")
+if (USER_AGENT_BRANDING)
+    add_definitions(-DUSER_AGENT_BRANDING=${USER_AGENT_BRANDING})
+endif ()
 
 find_package(Cairo 1.14.0 REQUIRED)