Update ANGLE
[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 "PlatformExportMacros.h"
29 #include <wtf/Forward.h>
30 #include <wtf/RetainPtr.h>
31 #include <wtf/text/WTFString.h>
32
33 #if USE(CF)
34 typedef const struct __CFURL* CFURLRef;
35 #endif
36
37 #if USE(SOUP)
38 #include "GUniquePtrSoup.h"
39 #endif
40
41 #if USE(FOUNDATION)
42 OBJC_CLASS NSURL;
43 #endif
44
45 namespace WebCore {
46
47 class TextEncoding;
48 struct URLHash;
49
50 enum ParsedURLStringTag { ParsedURLString };
51
52 class URL {
53 public:
54     // Generates a URL which contains a null string.
55     URL() { invalidate(); }
56
57     // The argument is an absolute URL string. The string is assumed to be output of URL::string() called on a valid
58     // URL object, or indiscernible from such.
59     // It is usually best to avoid repeatedly parsing a string, unless memory saving outweigh the possible slow-downs.
60     WEBCORE_EXPORT URL(ParsedURLStringTag, const String&);
61     explicit URL(WTF::HashTableDeletedValueType) : m_string(WTF::HashTableDeletedValue) { }
62     bool isHashTableDeletedValue() const { return string().isHashTableDeletedValue(); }
63
64     // Resolves the relative URL with the given base URL. If provided, the
65     // TextEncoding is used to encode non-ASCII characers. The base URL can be
66     // null or empty, in which case the relative URL will be interpreted as
67     // absolute.
68     // FIXME: If the base URL is invalid, this always creates an invalid
69     // URL. Instead I think it would be better to treat all invalid base URLs
70     // the same way we treate null and empty base URLs.
71     WEBCORE_EXPORT URL(const URL& base, const String& relative);
72     URL(const URL& base, const String& relative, const TextEncoding&);
73
74     static URL fakeURLWithRelativePart(const String&);
75     static URL fileURLWithFileSystemPath(const String&);
76
77     String strippedForUseAsReferrer() const;
78
79     // FIXME: The above functions should be harmonized so that passing a
80     // base of null or the empty string gives the same result as the
81     // standard String constructor.
82
83     // Makes a deep copy. Helpful only if you need to use a URL on another
84     // thread. Since the underlying StringImpl objects are immutable, there's
85     // no other reason to ever prefer isolatedCopy() over plain old assignment.
86     WEBCORE_EXPORT URL isolatedCopy() const;
87
88     bool isNull() const;
89     bool isEmpty() const;
90     bool isValid() const;
91
92     // Returns true if you can set the host and port for the URL.
93     // Non-hierarchical URLs don't have a host and port.
94     bool canSetHostOrPort() const { return isHierarchical(); }
95
96     bool canSetPathname() const { return isHierarchical(); }
97     bool isHierarchical() const;
98
99     const String& string() const { return m_string; }
100
101     String stringCenterEllipsizedToLength(unsigned length = 1024) const;
102
103     WEBCORE_EXPORT StringView protocol() const;
104     WEBCORE_EXPORT String host() const;
105     WEBCORE_EXPORT Optional<uint16_t> port() const;
106     WEBCORE_EXPORT String user() const;
107     WEBCORE_EXPORT String pass() const;
108     WEBCORE_EXPORT String path() const;
109     WEBCORE_EXPORT String lastPathComponent() const;
110     WEBCORE_EXPORT String query() const;
111     WEBCORE_EXPORT String fragmentIdentifier() const;
112     WEBCORE_EXPORT bool hasFragmentIdentifier() const;
113
114     bool hasUsername() const;
115     bool hasPassword() const;
116     bool hasQuery() const;
117     bool hasFragment() const;
118
119     // Unlike user() and pass(), these functions don't decode escape sequences.
120     // This is necessary for accurate round-tripping, because encoding doesn't encode '%' characters.
121     String encodedUser() const;
122     String encodedPass() const;
123
124     WEBCORE_EXPORT String baseAsString() const;
125
126     WEBCORE_EXPORT String fileSystemPath() const;
127
128     // Returns true if the current URL's protocol is the same as the null-
129     // terminated ASCII argument. The argument must be lower-case.
130     WEBCORE_EXPORT bool protocolIs(const char*) const;
131     bool protocolIs(StringView) const;
132     bool protocolIsBlob() const { return protocolIs("blob"); }
133     bool protocolIsData() const { return protocolIs("data"); }
134     bool protocolIsInHTTPFamily() const;
135     WEBCORE_EXPORT bool isLocalFile() const;
136     bool isBlankURL() const;
137
138     WEBCORE_EXPORT bool setProtocol(const String&);
139     void setHost(const String&);
140
141     void removePort();
142     void setPort(unsigned short);
143
144     // Input is like "foo.com" or "foo.com:8000".
145     void setHostAndPort(const String&);
146
147     void setUser(const String&);
148     void setPass(const String&);
149
150     // If you pass an empty path for HTTP or HTTPS URLs, the resulting path
151     // will be "/".
152     WEBCORE_EXPORT void setPath(const String&);
153
154     // The query may begin with a question mark, or, if not, one will be added
155     // for you. Setting the query to the empty string will leave a "?" in the
156     // URL (with nothing after it). To clear the query, pass a null string.
157     void setQuery(const String&);
158
159     void setFragmentIdentifier(const String&);
160     void removeFragmentIdentifier();
161
162     WEBCORE_EXPORT friend bool equalIgnoringFragmentIdentifier(const URL&, const URL&);
163
164     WEBCORE_EXPORT friend bool protocolHostAndPortAreEqual(const URL&, const URL&);
165
166     unsigned hostStart() const;
167     unsigned hostEnd() const;
168
169     unsigned pathStart() const;
170     unsigned pathEnd() const;
171     unsigned pathAfterLastSlash() const;
172
173     operator const String&() const { return string(); }
174
175 #if USE(CF)
176     WEBCORE_EXPORT URL(CFURLRef);
177     WEBCORE_EXPORT RetainPtr<CFURLRef> createCFURL() const;
178 #endif
179
180 #if USE(SOUP)
181     URL(SoupURI*);
182     GUniquePtr<SoupURI> createSoupURI() const;
183 #endif
184
185 #if USE(FOUNDATION)
186     WEBCORE_EXPORT URL(NSURL*);
187     WEBCORE_EXPORT operator NSURL*() const;
188 #endif
189 #ifdef __OBJC__
190     operator NSString*() const { return string(); }
191 #endif
192
193 #ifndef NDEBUG
194     void print() const;
195 #endif
196
197     template <class Encoder> void encode(Encoder&) const;
198     template <class Decoder> static bool decode(Decoder&, URL&);
199
200     String serialize(bool omitFragment = false) const;
201
202 private:
203     friend class URLParser;
204     WEBCORE_EXPORT void invalidate();
205     static bool protocolIs(const String&, const char*);
206     void init(const URL&, const String&, const TextEncoding&);
207     void copyToBuffer(Vector<char, 512>& buffer) const;
208
209     // Parses the given URL. The originalString parameter allows for an
210     // optimization: When the source is the same as the fixed-up string,
211     // it will use the passed-in string instead of allocating a new one.
212     void parse(const String&);
213     void parse(const char* url, const String* originalString = 0);
214
215     bool hasPath() const;
216
217     String m_string;
218     bool m_isValid : 1;
219     bool m_protocolIsInHTTPFamily : 1;
220     bool m_cannotBeABaseURL : 1;
221
222     unsigned m_schemeEnd;
223     unsigned m_userStart;
224     unsigned m_userEnd;
225     unsigned m_passwordEnd;
226     unsigned m_hostEnd;
227     unsigned m_portEnd;
228     unsigned m_pathAfterLastSlash;
229     unsigned m_pathEnd;
230     unsigned m_queryEnd;
231     unsigned m_fragmentEnd;
232 };
233
234 template <class Encoder>
235 void URL::encode(Encoder& encoder) const
236 {
237     encoder << m_string;
238     encoder << static_cast<bool>(m_isValid);
239     if (!m_isValid)
240         return;
241     encoder << static_cast<bool>(m_protocolIsInHTTPFamily);
242     encoder << m_schemeEnd;
243     encoder << m_userStart;
244     encoder << m_userEnd;
245     encoder << m_passwordEnd;
246     encoder << m_hostEnd;
247     encoder << m_portEnd;
248     encoder << m_pathAfterLastSlash;
249     encoder << m_pathEnd;
250     encoder << m_queryEnd;
251     encoder << m_fragmentEnd;
252 }
253
254 template <class Decoder>
255 bool URL::decode(Decoder& decoder, URL& url)
256 {
257     if (!decoder.decode(url.m_string))
258         return false;
259     bool isValid;
260     if (!decoder.decode(isValid))
261         return false;
262     url.m_isValid = isValid;
263     if (!isValid)
264         return true;
265     bool protocolIsInHTTPFamily;
266     if (!decoder.decode(protocolIsInHTTPFamily))
267         return false;
268     url.m_protocolIsInHTTPFamily = protocolIsInHTTPFamily;
269     if (!decoder.decode(url.m_schemeEnd))
270         return false;
271     if (!decoder.decode(url.m_userStart))
272         return false;
273     if (!decoder.decode(url.m_userEnd))
274         return false;
275     if (!decoder.decode(url.m_passwordEnd))
276         return false;
277     if (!decoder.decode(url.m_hostEnd))
278         return false;
279     if (!decoder.decode(url.m_portEnd))
280         return false;
281     if (!decoder.decode(url.m_pathAfterLastSlash))
282         return false;
283     if (!decoder.decode(url.m_pathEnd))
284         return false;
285     if (!decoder.decode(url.m_queryEnd))
286         return false;
287     if (!decoder.decode(url.m_fragmentEnd))
288         return false;
289     return true;
290 }
291
292 bool operator==(const URL&, const URL&);
293 bool operator==(const URL&, const String&);
294 bool operator==(const String&, const URL&);
295 bool operator!=(const URL&, const URL&);
296 bool operator!=(const URL&, const String&);
297 bool operator!=(const String&, const URL&);
298
299 WEBCORE_EXPORT bool equalIgnoringFragmentIdentifier(const URL&, const URL&);
300 WEBCORE_EXPORT bool protocolHostAndPortAreEqual(const URL&, const URL&);
301 WEBCORE_EXPORT bool hostsAreEqual(const URL&, const URL&);
302
303 WEBCORE_EXPORT const URL& blankURL();
304
305 // Functions to do URL operations on strings.
306 // These are operations that aren't faster on a parsed URL.
307 // These are also different from the URL functions in that they don't require the string to be a valid and parsable URL.
308 // This is especially important because valid javascript URLs are not necessarily considered valid by URL.
309
310 WEBCORE_EXPORT bool protocolIs(const String& url, const char* protocol);
311 WEBCORE_EXPORT bool protocolIsJavaScript(const String& url);
312 WEBCORE_EXPORT bool protocolIsInHTTPFamily(const String& url);
313
314 Optional<uint16_t> defaultPortForProtocol(StringView protocol);
315 WEBCORE_EXPORT bool isDefaultPortForProtocol(uint16_t port, StringView protocol);
316 WEBCORE_EXPORT bool portAllowed(const URL&); // Blacklist ports that should never be used for Web resources.
317
318 bool isValidProtocol(const String&);
319
320 String mimeTypeFromDataURL(const String& url);
321 WEBCORE_EXPORT String mimeTypeFromURL(const URL&);
322
323 // Unescapes the given string using URL escaping rules, given an optional
324 // encoding (defaulting to UTF-8 otherwise). DANGER: If the URL has "%00"
325 // in it, the resulting string will have embedded null characters!
326 WEBCORE_EXPORT String decodeURLEscapeSequences(const String&);
327 String decodeURLEscapeSequences(const String&, const TextEncoding&);
328
329 // FIXME: This is a wrong concept to expose, different parts of a URL need different escaping per the URL Standard.
330 WEBCORE_EXPORT String encodeWithURLEscapeSequences(const String&);
331
332 #if PLATFORM(IOS)
333 WEBCORE_EXPORT void enableURLSchemeCanonicalization(bool);
334 #endif
335
336 // Inlines.
337
338 inline bool operator==(const URL& a, const URL& b)
339 {
340     return a.string() == b.string();
341 }
342
343 inline bool operator==(const URL& a, const String& b)
344 {
345     return a.string() == b;
346 }
347
348 inline bool operator==(const String& a, const URL& b)
349 {
350     return a == b.string();
351 }
352
353 inline bool operator!=(const URL& a, const URL& b)
354 {
355     return a.string() != b.string();
356 }
357
358 inline bool operator!=(const URL& a, const String& b)
359 {
360     return a.string() != b;
361 }
362
363 inline bool operator!=(const String& a, const URL& b)
364 {
365     return a != b.string();
366 }
367
368 // Inline versions of some non-GoogleURL functions so we can get inlining
369 // without having to have a lot of ugly ifdefs in the class definition.
370
371 inline bool URL::isNull() const
372 {
373     return m_string.isNull();
374 }
375
376 inline bool URL::isEmpty() const
377 {
378     return m_string.isEmpty();
379 }
380
381 inline bool URL::isValid() const
382 {
383     return m_isValid;
384 }
385
386 inline bool URL::hasPath() const
387 {
388     return m_pathEnd != m_portEnd;
389 }
390
391 inline bool URL::hasUsername() const
392 {
393     return m_userEnd > m_userStart;
394 }
395
396 inline bool URL::hasPassword() const
397 {
398     return m_passwordEnd > (m_userEnd + 1);
399 }
400
401 inline bool URL::hasQuery() const
402 {
403     return m_queryEnd > m_pathEnd;
404 }
405
406 inline bool URL::hasFragment() const
407 {
408     return m_fragmentEnd > m_queryEnd;
409 }
410
411 inline bool URL::protocolIsInHTTPFamily() const
412 {
413     return m_protocolIsInHTTPFamily;
414 }
415
416 inline unsigned URL::hostStart() const
417 {
418     return (m_passwordEnd == m_userStart) ? m_passwordEnd : m_passwordEnd + 1;
419 }
420
421 inline unsigned URL::hostEnd() const
422 {
423     return m_hostEnd;
424 }
425
426 inline unsigned URL::pathStart() const
427 {
428     return m_portEnd;
429 }
430
431 inline unsigned URL::pathEnd() const
432 {
433     return m_pathEnd;
434 }
435
436 inline unsigned URL::pathAfterLastSlash() const
437 {
438     return m_pathAfterLastSlash;
439 }
440
441 } // namespace WebCore
442
443 namespace WTF {
444
445     // URLHash is the default hash for String
446     template<typename T> struct DefaultHash;
447     template<> struct DefaultHash<WebCore::URL> {
448         typedef WebCore::URLHash Hash;
449     };
450
451 } // namespace WTF