Test that CSS subresource loading are exposed to resource timing in case of a CORS...
[WebKit-https.git] / Source / WebCore / platform / URL.h
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2011, 2012, 2013 Apple Inc. All rights reserved.
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 #pragma once
27
28 #include <wtf/Forward.h>
29 #include <wtf/RetainPtr.h>
30 #include <wtf/text/WTFString.h>
31
32 #if USE(CF)
33 typedef const struct __CFURL* CFURLRef;
34 #endif
35
36 #if USE(SOUP)
37 #include "GUniquePtrSoup.h"
38 #endif
39
40 #if USE(FOUNDATION)
41 OBJC_CLASS NSURL;
42 #endif
43
44 namespace WTF {
45 class TextStream;
46 }
47
48 namespace WebCore {
49
50 class URLTextEncoding {
51 public:
52     virtual Vector<uint8_t> encodeForURLParsing(StringView) const = 0;
53     virtual ~URLTextEncoding() { };
54 };
55
56 struct URLHash;
57
58 class URL {
59 public:
60     // Generates a URL which contains a null string.
61     URL() { invalidate(); }
62
63     explicit URL(WTF::HashTableDeletedValueType) : m_string(WTF::HashTableDeletedValue) { }
64     bool isHashTableDeletedValue() const { return string().isHashTableDeletedValue(); }
65
66     // Resolves the relative URL with the given base URL. If provided, the
67     // URLTextEncoding is used to encode non-ASCII characers. The base URL can be
68     // null or empty, in which case the relative URL will be interpreted as
69     // absolute.
70     // FIXME: If the base URL is invalid, this always creates an invalid
71     // URL. Instead I think it would be better to treat all invalid base URLs
72     // the same way we treate null and empty base URLs.
73     WEBCORE_EXPORT URL(const URL& base, const String& relative, const URLTextEncoding* = nullptr);
74
75     WEBCORE_EXPORT static URL fakeURLWithRelativePart(const String&);
76     WEBCORE_EXPORT static URL fileURLWithFileSystemPath(const String&);
77
78     String strippedForUseAsReferrer() const;
79
80     // FIXME: The above functions should be harmonized so that passing a
81     // base of null or the empty string gives the same result as the
82     // standard String constructor.
83
84     // Makes a deep copy. Helpful only if you need to use a URL on another
85     // thread. Since the underlying StringImpl objects are immutable, there's
86     // no other reason to ever prefer isolatedCopy() over plain old assignment.
87     WEBCORE_EXPORT URL isolatedCopy() const;
88
89     bool isNull() const;
90     bool isEmpty() const;
91     bool isValid() const;
92
93     // Returns true if you can set the host and port for the URL.
94     // Non-hierarchical URLs don't have a host and port.
95     bool canSetHostOrPort() const { return isHierarchical(); }
96
97     bool canSetPathname() const { return isHierarchical(); }
98     bool isHierarchical() const;
99
100     const String& string() const { return m_string; }
101
102     WEBCORE_EXPORT String stringCenterEllipsizedToLength(unsigned length = 1024) const;
103
104     WEBCORE_EXPORT StringView protocol() const;
105     WEBCORE_EXPORT StringView host() const;
106     WEBCORE_EXPORT std::optional<uint16_t> port() const;
107     WEBCORE_EXPORT String hostAndPort() const;
108     WEBCORE_EXPORT String protocolHostAndPort() const;
109     WEBCORE_EXPORT String user() const;
110     WEBCORE_EXPORT String pass() const;
111     WEBCORE_EXPORT String path() const;
112     WEBCORE_EXPORT String lastPathComponent() const;
113     WEBCORE_EXPORT String query() const;
114     WEBCORE_EXPORT String fragmentIdentifier() const;
115     WEBCORE_EXPORT bool hasFragmentIdentifier() const;
116
117     bool hasUsername() const;
118     bool hasPassword() const;
119     bool hasQuery() const;
120     bool hasFragment() const;
121     bool hasPath() const;
122
123     // Unlike user() and pass(), these functions don't decode escape sequences.
124     // This is necessary for accurate round-tripping, because encoding doesn't encode '%' characters.
125     WEBCORE_EXPORT String encodedUser() const;
126     WEBCORE_EXPORT String encodedPass() const;
127
128     WEBCORE_EXPORT String baseAsString() const;
129
130     WEBCORE_EXPORT String fileSystemPath() const;
131
132     // Returns true if the current URL's protocol is the same as the null-
133     // terminated ASCII argument. The argument must be lower-case.
134     WEBCORE_EXPORT bool protocolIs(const char*) const;
135     bool protocolIs(StringView) const;
136     bool protocolIsBlob() const { return protocolIs("blob"); }
137     bool protocolIsData() const { return protocolIs("data"); }
138     WEBCORE_EXPORT bool protocolIsAbout() const;
139     bool protocolIsInHTTPFamily() const;
140     WEBCORE_EXPORT bool isLocalFile() const;
141     bool cannotBeABaseURL() const { return m_cannotBeABaseURL; }
142
143     WEBCORE_EXPORT bool isMatchingDomain(const String&) const;
144
145     WEBCORE_EXPORT bool setProtocol(const String&);
146     void setHost(const String&);
147
148     void removePort();
149     void setPort(unsigned short);
150
151     // Input is like "foo.com" or "foo.com:8000".
152     void setHostAndPort(const String&);
153
154     void setUser(const String&);
155     void setPass(const String&);
156
157     // If you pass an empty path for HTTP or HTTPS URLs, the resulting path
158     // will be "/".
159     WEBCORE_EXPORT void setPath(const String&);
160
161     // The query may begin with a question mark, or, if not, one will be added
162     // for you. Setting the query to the empty string will leave a "?" in the
163     // URL (with nothing after it). To clear the query, pass a null string.
164     WEBCORE_EXPORT void setQuery(const String&);
165
166     WEBCORE_EXPORT void setFragmentIdentifier(StringView);
167     WEBCORE_EXPORT void removeFragmentIdentifier();
168
169     WEBCORE_EXPORT void removeQueryAndFragmentIdentifier();
170
171     WEBCORE_EXPORT static bool hostIsIPAddress(StringView);
172
173     unsigned pathStart() const;
174     unsigned pathEnd() const;
175     unsigned pathAfterLastSlash() const;
176
177     operator const String&() const { return string(); }
178
179 #if USE(CF)
180     WEBCORE_EXPORT URL(CFURLRef);
181     WEBCORE_EXPORT RetainPtr<CFURLRef> createCFURL() const;
182 #endif
183
184 #if USE(SOUP)
185     URL(SoupURI*);
186     GUniquePtr<SoupURI> createSoupURI() const;
187 #endif
188
189 #if USE(FOUNDATION)
190     WEBCORE_EXPORT URL(NSURL*);
191     WEBCORE_EXPORT operator NSURL*() const;
192 #endif
193 #ifdef __OBJC__
194     operator NSString*() const { return string(); }
195 #endif
196
197 #ifndef NDEBUG
198     void print() const;
199 #endif
200
201     template <class Encoder> void encode(Encoder&) const;
202     template <class Decoder> static bool decode(Decoder&, URL&);
203     template <class Decoder> static std::optional<URL> decode(Decoder&);
204
205 private:
206     friend class URLParser;
207     WEBCORE_EXPORT void invalidate();
208     static bool protocolIs(const String&, const char*);
209     void copyToBuffer(Vector<char, 512>& buffer) const;
210     unsigned hostStart() const;
211
212     WEBCORE_EXPORT friend bool equalIgnoringFragmentIdentifier(const URL&, const URL&);
213     WEBCORE_EXPORT friend bool protocolHostAndPortAreEqual(const URL&, const URL&);
214     WEBCORE_EXPORT friend bool hostsAreEqual(const URL&, const URL&);
215
216     String m_string;
217
218     unsigned m_isValid : 1;
219     unsigned m_protocolIsInHTTPFamily : 1;
220     unsigned m_cannotBeABaseURL : 1;
221
222     // This is out of order to align the bits better. The port is after the host.
223     unsigned m_portLength : 3;
224     static constexpr unsigned maxPortLength = (1 << 3) - 1;
225
226     static constexpr unsigned maxSchemeLength = (1 << 26) - 1;
227     unsigned m_schemeEnd : 26;
228     unsigned m_userStart;
229     unsigned m_userEnd;
230     unsigned m_passwordEnd;
231     unsigned m_hostEnd;
232     unsigned m_pathAfterLastSlash;
233     unsigned m_pathEnd;
234     unsigned m_queryEnd;
235 };
236
237 static_assert(sizeof(URL) == sizeof(String) + 8 * sizeof(unsigned), "URL should stay small");
238
239 template <class Encoder>
240 void URL::encode(Encoder& encoder) const
241 {
242     encoder << m_string;
243 }
244
245 template <class Decoder>
246 bool URL::decode(Decoder& decoder, URL& url)
247 {
248     auto optionalURL = URL::decode(decoder);
249     if (!optionalURL)
250         return false;
251     url = WTFMove(*optionalURL);
252     return true;
253 }
254
255 template <class Decoder>
256 std::optional<URL> URL::decode(Decoder& decoder)
257 {
258     String string;
259     if (!decoder.decode(string))
260         return std::nullopt;
261     return URL(URL(), string);
262 }
263
264 WEBCORE_EXPORT bool equalIgnoringFragmentIdentifier(const URL&, const URL&);
265 WEBCORE_EXPORT bool equalIgnoringQueryAndFragment(const URL&, const URL&);
266 WEBCORE_EXPORT bool protocolHostAndPortAreEqual(const URL&, const URL&);
267 WEBCORE_EXPORT bool hostsAreEqual(const URL&, const URL&);
268
269 WEBCORE_EXPORT const URL& blankURL();
270
271 // Functions to do URL operations on strings.
272 // These are operations that aren't faster on a parsed URL.
273 // These are also different from the URL functions in that they don't require the string to be a valid and parsable URL.
274 // This is especially important because valid javascript URLs are not necessarily considered valid by URL.
275
276 WEBCORE_EXPORT bool protocolIs(const String& url, const char* protocol);
277 WEBCORE_EXPORT bool protocolIsJavaScript(const String& url);
278 bool protocolIsJavaScript(StringView url);
279 WEBCORE_EXPORT bool protocolIsInHTTPFamily(const String& url);
280
281 std::optional<uint16_t> defaultPortForProtocol(StringView protocol);
282 WEBCORE_EXPORT bool isDefaultPortForProtocol(uint16_t port, StringView protocol);
283 WEBCORE_EXPORT bool portAllowed(const URL&); // Blacklist ports that should never be used for Web resources.
284
285 WEBCORE_EXPORT void registerDefaultPortForProtocolForTesting(uint16_t port, const String& protocol);
286 WEBCORE_EXPORT void clearDefaultPortForProtocolMapForTesting();
287
288 bool isValidProtocol(const String&);
289
290 String mimeTypeFromDataURL(const String& url);
291
292 // FIXME: This is a wrong concept to expose, different parts of a URL need different escaping per the URL Standard.
293 WEBCORE_EXPORT String encodeWithURLEscapeSequences(const String&);
294
295 // Inlines.
296
297 inline bool operator==(const URL& a, const URL& b)
298 {
299     return a.string() == b.string();
300 }
301
302 inline bool operator==(const URL& a, const String& b)
303 {
304     return a.string() == b;
305 }
306
307 inline bool operator==(const String& a, const URL& b)
308 {
309     return a == b.string();
310 }
311
312 inline bool operator!=(const URL& a, const URL& b)
313 {
314     return a.string() != b.string();
315 }
316
317 inline bool operator!=(const URL& a, const String& b)
318 {
319     return a.string() != b;
320 }
321
322 inline bool operator!=(const String& a, const URL& b)
323 {
324     return a != b.string();
325 }
326
327 // Inline versions of some non-GoogleURL functions so we can get inlining
328 // without having to have a lot of ugly ifdefs in the class definition.
329
330 inline bool URL::isNull() const
331 {
332     return m_string.isNull();
333 }
334
335 inline bool URL::isEmpty() const
336 {
337     return m_string.isEmpty();
338 }
339
340 inline bool URL::isValid() const
341 {
342     return m_isValid;
343 }
344
345 inline bool URL::hasPath() const
346 {
347     return m_pathEnd != m_hostEnd + m_portLength;
348 }
349
350 inline bool URL::hasUsername() const
351 {
352     return m_userEnd > m_userStart;
353 }
354
355 inline bool URL::hasPassword() const
356 {
357     return m_passwordEnd > (m_userEnd + 1);
358 }
359
360 inline bool URL::hasQuery() const
361 {
362     return m_queryEnd > m_pathEnd;
363 }
364
365 inline bool URL::hasFragment() const
366 {
367     return m_isValid && m_string.length() > m_queryEnd;
368 }
369
370 inline bool URL::protocolIsInHTTPFamily() const
371 {
372     return m_protocolIsInHTTPFamily;
373 }
374
375 inline unsigned URL::pathStart() const
376 {
377     return m_hostEnd + m_portLength;
378 }
379
380 inline unsigned URL::pathEnd() const
381 {
382     return m_pathEnd;
383 }
384
385 inline unsigned URL::pathAfterLastSlash() const
386 {
387     return m_pathAfterLastSlash;
388 }
389
390 WTF::TextStream& operator<<(WTF::TextStream&, const URL&);
391
392 } // namespace WebCore
393
394 namespace WTF {
395 template<> struct DefaultHash<WebCore::URL>;
396 template<> struct HashTraits<WebCore::URL>;
397 } // namespace WTF