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