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