Migrate from ints to unsigneds when referring to indices into strings
[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     bool hasUsername() const;
118     bool hasPassword() const;
119     bool hasQuery() const;
120     bool hasFragment() const;
121
122     // Unlike user() and pass(), these functions don't decode escape sequences.
123     // This is necessary for accurate round-tripping, because encoding doesn't encode '%' characters.
124     String encodedUser() const;
125     String encodedPass() const;
126
127     WEBCORE_EXPORT String baseAsString() const;
128
129     WEBCORE_EXPORT String fileSystemPath() const;
130
131     // Returns true if the current URL's protocol is the same as the null-
132     // terminated ASCII argument. The argument must be lower-case.
133     WEBCORE_EXPORT bool protocolIs(const char*) const;
134     bool protocolIsBlob() const { return protocolIs("blob"); }
135     bool protocolIsData() const { return protocolIs("data"); }
136     bool protocolIsInHTTPFamily() const;
137     WEBCORE_EXPORT bool isLocalFile() const;
138     bool isBlankURL() const;
139
140     WEBCORE_EXPORT bool setProtocol(const String&);
141     void setHost(const String&);
142
143     void removePort();
144     void setPort(unsigned short);
145
146     // Input is like "foo.com" or "foo.com:8000".
147     void setHostAndPort(const String&);
148
149     void setUser(const String&);
150     void setPass(const String&);
151
152     // If you pass an empty path for HTTP or HTTPS URLs, the resulting path
153     // will be "/".
154     WEBCORE_EXPORT void setPath(const String&);
155
156     // The query may begin with a question mark, or, if not, one will be added
157     // for you. Setting the query to the empty string will leave a "?" in the
158     // URL (with nothing after it). To clear the query, pass a null string.
159     void setQuery(const String&);
160
161     void setFragmentIdentifier(const String&);
162     void removeFragmentIdentifier();
163
164     WEBCORE_EXPORT friend bool equalIgnoringFragmentIdentifier(const URL&, const URL&);
165
166     WEBCORE_EXPORT friend bool protocolHostAndPortAreEqual(const URL&, const URL&);
167
168     unsigned hostStart() const;
169     unsigned hostEnd() const;
170
171     unsigned pathStart() const;
172     unsigned pathEnd() const;
173     unsigned pathAfterLastSlash() const;
174
175     operator const String&() const { return string(); }
176
177 #if USE(CF)
178     WEBCORE_EXPORT URL(CFURLRef);
179     WEBCORE_EXPORT RetainPtr<CFURLRef> createCFURL() const;
180 #endif
181
182 #if USE(SOUP)
183     URL(SoupURI*);
184     GUniquePtr<SoupURI> createSoupURI() const;
185 #endif
186
187 #if USE(FOUNDATION)
188     WEBCORE_EXPORT URL(NSURL*);
189     WEBCORE_EXPORT operator NSURL*() const;
190 #endif
191 #ifdef __OBJC__
192     operator NSString*() const { return string(); }
193 #endif
194
195 #ifndef NDEBUG
196     void print() const;
197 #endif
198
199     template <class Encoder> void encode(Encoder&) const;
200     template <class Decoder> static bool decode(Decoder&, URL&);
201
202     String serialize(bool omitFragment = false) const;
203
204 private:
205     friend class URLParser;
206     WEBCORE_EXPORT void invalidate();
207     static bool protocolIs(const String&, const char*);
208     void init(const URL&, const String&, const TextEncoding&);
209     void copyToBuffer(Vector<char, 512>& buffer) const;
210
211     // Parses the given URL. The originalString parameter allows for an
212     // optimization: When the source is the same as the fixed-up string,
213     // it will use the passed-in string instead of allocating a new one.
214     void parse(const String&);
215     void parse(const char* url, const String* originalString = 0);
216
217     bool hasPath() const;
218
219     String m_string;
220     bool m_isValid : 1;
221     bool m_protocolIsInHTTPFamily : 1;
222
223     unsigned m_schemeEnd;
224     unsigned m_userStart;
225     unsigned m_userEnd;
226     unsigned m_passwordEnd;
227     unsigned m_hostEnd;
228     unsigned m_portEnd;
229     unsigned m_pathAfterLastSlash;
230     unsigned m_pathEnd;
231     unsigned m_queryEnd;
232     unsigned m_fragmentEnd;
233 };
234
235 template <class Encoder>
236 void URL::encode(Encoder& encoder) const
237 {
238     encoder << m_string;
239     encoder << static_cast<bool>(m_isValid);
240     if (!m_isValid)
241         return;
242     encoder << static_cast<bool>(m_protocolIsInHTTPFamily);
243     encoder << m_schemeEnd;
244     encoder << m_userStart;
245     encoder << m_userEnd;
246     encoder << m_passwordEnd;
247     encoder << m_hostEnd;
248     encoder << m_portEnd;
249     encoder << m_pathAfterLastSlash;
250     encoder << m_pathEnd;
251     encoder << m_queryEnd;
252     encoder << m_fragmentEnd;
253 }
254
255 template <class Decoder>
256 bool URL::decode(Decoder& decoder, URL& url)
257 {
258     if (!decoder.decode(url.m_string))
259         return false;
260     bool isValid;
261     if (!decoder.decode(isValid))
262         return false;
263     url.m_isValid = isValid;
264     if (!isValid)
265         return true;
266     bool protocolIsInHTTPFamily;
267     if (!decoder.decode(protocolIsInHTTPFamily))
268         return false;
269     url.m_protocolIsInHTTPFamily = protocolIsInHTTPFamily;
270     if (!decoder.decode(url.m_schemeEnd))
271         return false;
272     if (!decoder.decode(url.m_userStart))
273         return false;
274     if (!decoder.decode(url.m_userEnd))
275         return false;
276     if (!decoder.decode(url.m_passwordEnd))
277         return false;
278     if (!decoder.decode(url.m_hostEnd))
279         return false;
280     if (!decoder.decode(url.m_portEnd))
281         return false;
282     if (!decoder.decode(url.m_pathAfterLastSlash))
283         return false;
284     if (!decoder.decode(url.m_pathEnd))
285         return false;
286     if (!decoder.decode(url.m_queryEnd))
287         return false;
288     if (!decoder.decode(url.m_fragmentEnd))
289         return false;
290     return true;
291 }
292
293 bool operator==(const URL&, const URL&);
294 bool operator==(const URL&, const String&);
295 bool operator==(const String&, const URL&);
296 bool operator!=(const URL&, const URL&);
297 bool operator!=(const URL&, const String&);
298 bool operator!=(const String&, const URL&);
299
300 WEBCORE_EXPORT bool equalIgnoringFragmentIdentifier(const URL&, const URL&);
301 WEBCORE_EXPORT bool protocolHostAndPortAreEqual(const URL&, const URL&);
302 WEBCORE_EXPORT bool hostsAreEqual(const URL&, const URL&);
303
304 WEBCORE_EXPORT const URL& blankURL();
305
306 // Functions to do URL operations on strings.
307 // These are operations that aren't faster on a parsed URL.
308 // These are also different from the URL functions in that they don't require the string to be a valid and parsable URL.
309 // This is especially important because valid javascript URLs are not necessarily considered valid by URL.
310
311 WEBCORE_EXPORT bool protocolIs(const String& url, const char* protocol);
312 WEBCORE_EXPORT bool protocolIsJavaScript(const String& url);
313 WEBCORE_EXPORT bool protocolIsInHTTPFamily(const String& url);
314
315 unsigned short defaultPortForProtocol(const String& protocol);
316 bool isDefaultPortForProtocol(unsigned short port, const String& protocol);
317 WEBCORE_EXPORT bool portAllowed(const URL&); // Blacklist ports that should never be used for Web resources.
318
319 bool isValidProtocol(const String&);
320
321 String mimeTypeFromDataURL(const String& url);
322 WEBCORE_EXPORT String mimeTypeFromURL(const URL&);
323
324 // Unescapes the given string using URL escaping rules, given an optional
325 // encoding (defaulting to UTF-8 otherwise). DANGER: If the URL has "%00"
326 // in it, the resulting string will have embedded null characters!
327 WEBCORE_EXPORT String decodeURLEscapeSequences(const String&);
328 String decodeURLEscapeSequences(const String&, const TextEncoding&);
329
330 // FIXME: This is a wrong concept to expose, different parts of a URL need different escaping per the URL Standard.
331 WEBCORE_EXPORT String encodeWithURLEscapeSequences(const String&);
332
333 #if PLATFORM(IOS)
334 WEBCORE_EXPORT void enableURLSchemeCanonicalization(bool);
335 #endif
336
337 // Inlines.
338
339 inline bool operator==(const URL& a, const URL& b)
340 {
341     return a.string() == b.string();
342 }
343
344 inline bool operator==(const URL& a, const String& b)
345 {
346     return a.string() == b;
347 }
348
349 inline bool operator==(const String& a, const URL& b)
350 {
351     return a == b.string();
352 }
353
354 inline bool operator!=(const URL& a, const URL& b)
355 {
356     return a.string() != b.string();
357 }
358
359 inline bool operator!=(const URL& a, const String& b)
360 {
361     return a.string() != b;
362 }
363
364 inline bool operator!=(const String& a, const URL& b)
365 {
366     return a != b.string();
367 }
368
369 // Inline versions of some non-GoogleURL functions so we can get inlining
370 // without having to have a lot of ugly ifdefs in the class definition.
371
372 inline bool URL::isNull() const
373 {
374     return m_string.isNull();
375 }
376
377 inline bool URL::isEmpty() const
378 {
379     return m_string.isEmpty();
380 }
381
382 inline bool URL::isValid() const
383 {
384     return m_isValid;
385 }
386
387 inline bool URL::hasPath() const
388 {
389     return m_pathEnd != m_portEnd;
390 }
391
392 inline bool URL::hasPort() const
393 {
394     return m_hostEnd < m_portEnd;
395 }
396
397 inline bool URL::hasUsername() const
398 {
399     return m_userEnd > m_userStart;
400 }
401
402 inline bool URL::hasPassword() const
403 {
404     return m_passwordEnd > (m_userEnd + 1);
405 }
406
407 inline bool URL::hasQuery() const
408 {
409     return m_queryEnd > m_pathEnd;
410 }
411
412 inline bool URL::hasFragment() const
413 {
414     return m_fragmentEnd > m_queryEnd;
415 }
416
417 inline bool URL::protocolIsInHTTPFamily() const
418 {
419     return m_protocolIsInHTTPFamily;
420 }
421
422 inline unsigned URL::hostStart() const
423 {
424     return (m_passwordEnd == m_userStart) ? m_passwordEnd : m_passwordEnd + 1;
425 }
426
427 inline unsigned URL::hostEnd() const
428 {
429     return m_hostEnd;
430 }
431
432 inline unsigned URL::pathStart() const
433 {
434     return m_portEnd;
435 }
436
437 inline unsigned URL::pathEnd() const
438 {
439     return m_pathEnd;
440 }
441
442 inline unsigned URL::pathAfterLastSlash() const
443 {
444     return m_pathAfterLastSlash;
445 }
446
447 } // namespace WebCore
448
449 namespace WTF {
450
451     // URLHash is the default hash for String
452     template<typename T> struct DefaultHash;
453     template<> struct DefaultHash<WebCore::URL> {
454         typedef WebCore::URLHash Hash;
455     };
456
457 } // namespace WTF
458
459 #endif // URL_h