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