1850dd55c70f5ec3670e4f36ae08b0c830009ba3
[WebKit-https.git] / Source / WebCore / platform / gtk / UserAgentGtk.cpp
1 /*
2  * Copyright (C) 2012, 2014 Igalia S.L.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "UserAgentGtk.h"
28
29 #include "URL.h"
30 #include <wtf/NeverDestroyed.h>
31 #include <wtf/text/StringBuilder.h>
32
33 #if OS(UNIX)
34 #include <sys/utsname.h>
35 #endif
36
37 namespace WebCore {
38
39 class UserAgentQuirks {
40 public:
41     enum UserAgentQuirk {
42         NeedsMacintoshPlatform,
43
44         NumUserAgentQuirks
45     };
46
47     UserAgentQuirks()
48         : m_quirks(0)
49     {
50         COMPILE_ASSERT(sizeof(m_quirks) * 8 >= NumUserAgentQuirks, not_enough_room_for_quirks);
51     }
52
53     void add(UserAgentQuirk quirk)
54     {
55         ASSERT(quirk >= 0);
56         ASSERT_WITH_SECURITY_IMPLICATION(quirk < NumUserAgentQuirks);
57
58         m_quirks |= (1 << quirk);
59     }
60
61     bool contains(UserAgentQuirk quirk) const
62     {
63         return m_quirks & (1 << quirk);
64     }
65
66     bool isEmpty() const { return !m_quirks; }
67
68 private:
69     uint32_t m_quirks;
70 };
71
72 static const char* cpuDescriptionForUAString()
73 {
74 #if CPU(PPC) || CPU(PPC64)
75     return "PPC";
76 #elif CPU(X86) || CPU(X86_64)
77     return "Intel";
78 #elif CPU(ARM) || CPU(ARM64)
79     return "ARM";
80 #else
81     return "Unknown";
82 #endif
83 }
84
85 static const char* platformForUAString()
86 {
87 #if PLATFORM(X11)
88     return "X11";
89 #elif OS(WINDOWS)
90     return "";
91 #elif PLATFORM(MAC)
92     return "Macintosh";
93 #elif defined(GDK_WINDOWING_DIRECTFB)
94     return "DirectFB";
95 #else
96     return "Unknown";
97 #endif
98 }
99
100 static const String platformVersionForUAString()
101 {
102 #if OS(UNIX)
103     struct utsname name;
104     uname(&name);
105     static NeverDestroyed<const String> uaOSVersion(String::format("%s %s", name.sysname, name.machine));
106     return uaOSVersion;
107 #else
108     // We will always claim to be Safari in Mac OS X, since Safari in Linux triggers the iOS path on some websites.
109     static NeverDestroyed<const String> uaOSVersion(String::format("%s Mac OS X", cpuDescriptionForUAString()));
110     return uaOSVersion;
111 #endif
112 }
113
114 static const char* versionForUAString()
115 {
116 #define MAKE_VERSION(major, minor) #major "." #minor
117     return MAKE_VERSION(USER_AGENT_GTK_MAJOR_VERSION, USER_AGENT_GTK_MINOR_VERSION);
118 #undef MAKE_VERSION
119 }
120
121 static String buildUserAgentString(const UserAgentQuirks& quirks)
122 {
123     StringBuilder uaString;
124     uaString.appendLiteral("Mozilla/5.0 ");
125     uaString.append('(');
126
127     if (quirks.contains(UserAgentQuirks::NeedsMacintoshPlatform))
128         uaString.appendLiteral("Macintosh");
129     else
130         uaString.append(platformForUAString());
131
132     uaString.appendLiteral("; ");
133
134     if (quirks.contains(UserAgentQuirks::NeedsMacintoshPlatform)) {
135         uaString.append(cpuDescriptionForUAString());
136         uaString.appendLiteral(" Mac OS X");
137     } else
138         uaString.append(platformVersionForUAString());
139
140     uaString.appendLiteral(") AppleWebKit/");
141     uaString.append(versionForUAString());
142     // Version/X is mandatory *before* Safari/X to be a valid Safari UA. See
143     // https://bugs.webkit.org/show_bug.cgi?id=133403 for details.
144     uaString.appendLiteral(" (KHTML, like Gecko) Version/8.0 Safari/");
145     uaString.append(versionForUAString());
146
147     return uaString.toString();
148 }
149
150 static const String standardUserAgentStatic()
151 {
152     static NeverDestroyed<const String> uaStatic(buildUserAgentString(UserAgentQuirks()));
153     return uaStatic;
154 }
155
156 String standardUserAgent(const String& applicationName, const String& applicationVersion)
157 {
158     // Create a default user agent string with a liberal interpretation of
159     // https://developer.mozilla.org/en-US/docs/User_Agent_Strings_Reference
160     //
161     // Forming a functional user agent is really difficult. We must mention Safari, because some
162     // sites check for that when detecting WebKit browsers. Additionally some sites assume that
163     // browsers that are "Safari" but not running on OS X are the Safari iOS browse. Getting this
164     // wrong can cause sites to load the wrong JavaScript, CSS, or custom fonts. In some cases
165     // sites won't load resources at all.
166     if (applicationName.isEmpty())
167         return standardUserAgentStatic();
168
169     String finalApplicationVersion = applicationVersion;
170     if (finalApplicationVersion.isEmpty())
171         finalApplicationVersion = versionForUAString();
172
173     return standardUserAgentStatic() + ' ' + applicationName + '/' + finalApplicationVersion;
174 }
175
176 String standardUserAgentForURL(const URL& url)
177 {
178     ASSERT(!url.isNull());
179     UserAgentQuirks quirks;
180     if (url.host().endsWith(".yahoo.com")) {
181         // www.yahoo.com redirects to the mobile version when Linux is present in the UA,
182         // use always Macintosh as platform. See https://bugs.webkit.org/show_bug.cgi?id=125444.
183         quirks.add(UserAgentQuirks::NeedsMacintoshPlatform);
184     }
185
186     // The null string means we don't need a specific UA for the given URL.
187     return quirks.isEmpty() ? String() : buildUserAgentString(quirks);
188 }
189
190 } // namespace WebCore
191