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