2011-02-23 Patrick Gansterer <paroga@webkit.org>
[WebKit-https.git] / Source / WebCore / platform / KURL.h
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 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 COMPUTER, 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 COMPUTER, 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 KURL_h
27 #define KURL_h
28
29 #include "PlatformString.h"
30 #include "URLString.h"
31 #include <wtf/HashMap.h>
32
33 #if USE(CF)
34 typedef const struct __CFURL* CFURLRef;
35 #endif
36
37 #if PLATFORM(MAC)
38 #ifdef __OBJC__
39 @class NSURL;
40 #else
41 class NSURL;
42 #endif
43 #endif
44
45 #if PLATFORM(QT)
46 QT_BEGIN_NAMESPACE
47 class QUrl;
48 QT_END_NAMESPACE
49 #endif
50
51 #if USE(GOOGLEURL)
52 #include "KURLGooglePrivate.h"
53 #endif
54
55 #if USE(JSC)
56 #include <runtime/UString.h>
57 #endif
58
59 namespace WebCore {
60
61 class TextEncoding;
62 struct KURLHash;
63
64 typedef HashMap<String, String> ParsedURLParameters;
65
66 enum ParsedURLStringTag { ParsedURLString };
67
68 class KURL {
69 public:
70     // Generates a URL which contains a null string.
71     KURL() { invalidate(); }
72
73     // The argument is an absolute URL string. The string is assumed to be output of KURL::string() called on a valid
74     // KURL object, or indiscernible from such.
75     // It is usually best to avoid repeatedly parsing a string, unless memory saving outweigh the possible slow-downs.
76     KURL(ParsedURLStringTag, const char*);
77     KURL(ParsedURLStringTag, const String&);
78     KURL(ParsedURLStringTag, const URLString&);
79
80     // Resolves the relative URL with the given base URL. If provided, the
81     // TextEncoding is used to encode non-ASCII characers. The base URL can be
82     // null or empty, in which case the relative URL will be interpreted as
83     // absolute.
84     // FIXME: If the base URL is invalid, this always creates an invalid
85     // URL. Instead I think it would be better to treat all invalid base URLs
86     // the same way we treate null and empty base URLs.
87     KURL(const KURL& base, const String& relative);
88     KURL(const KURL& base, const String& relative, const TextEncoding&);
89
90
91 #if USE(GOOGLEURL)
92     // For conversions for other structures that have already parsed and
93     // canonicalized the URL. The input must be exactly what KURL would have
94     // done with the same input.
95     KURL(const CString& canonicalSpec,
96          const url_parse::Parsed& parsed, bool isValid);
97 #endif
98
99     // FIXME: The above functions should be harmonized so that passing a
100     // base of null or the empty string gives the same result as the
101     // standard String constructor.
102
103     // Makes a deep copy. Helpful only if you need to use a KURL on another
104     // thread.  Since the underlying StringImpl objects are immutable, there's
105     // no other reason to ever prefer copy() over plain old assignment.
106     KURL copy() const;
107
108     bool isNull() const;
109     bool isEmpty() const;
110     bool isValid() const;
111
112     // Returns true if this URL has a path. Note that "http://foo.com/" has a
113     // path of "/", so this function will return true. Only invalid or
114     // non-hierarchical (like "javascript:") URLs will have no path.
115     bool hasPath() const;
116
117     // Returns true if you can set the host and port for the URL.
118     // Non-hierarchical URLs don't have a host and port.
119     bool canSetHostOrPort() const { return isHierarchical(); }
120
121     bool canSetPathname() const { return isHierarchical(); }
122
123 #if USE(GOOGLEURL)
124     const String& string() const { return m_url.string(); }
125     URLString urlString() const { return URLString(m_url.string()); }
126 #else
127     const String& string() const { return m_string; }
128     URLString urlString() const { return URLString(m_string); }
129 #endif
130
131     String protocol() const;
132     String host() const;
133     unsigned short port() const;
134     bool hasPort() const;
135     String user() const;
136     String pass() const;
137     String path() const;
138     String lastPathComponent() const;
139     String query() const;
140     String fragmentIdentifier() const;
141     bool hasFragmentIdentifier() const;
142
143     void copyParsedQueryTo(ParsedURLParameters&) const;
144
145     String baseAsString() const;
146
147     String prettyURL() const;
148     String fileSystemPath() const;
149
150     // Returns true if the current URL's protocol is the same as the null-
151     // terminated ASCII argument. The argument must be lower-case.
152     bool protocolIs(const char*) const;
153     bool protocolIsData() const { return protocolIs("data"); }
154     bool protocolInHTTPFamily() const;
155     bool isLocalFile() const;
156
157     bool setProtocol(const String&);
158     void setHost(const String&);
159
160     void removePort();
161     void setPort(unsigned short);
162
163     // Input is like "foo.com" or "foo.com:8000".
164     void setHostAndPort(const String&);
165
166     void setUser(const String&);
167     void setPass(const String&);
168
169     // If you pass an empty path for HTTP or HTTPS URLs, the resulting path
170     // will be "/".
171     void setPath(const String&);
172
173     // The query may begin with a question mark, or, if not, one will be added
174     // for you. Setting the query to the empty string will leave a "?" in the
175     // URL (with nothing after it). To clear the query, pass a null string.
176     void setQuery(const String&);
177
178     void setFragmentIdentifier(const String&);
179     void removeFragmentIdentifier();
180
181     friend bool equalIgnoringFragmentIdentifier(const KURL&, const KURL&);
182
183     friend bool protocolHostAndPortAreEqual(const KURL&, const KURL&);
184
185     unsigned hostStart() const;
186     unsigned hostEnd() const;
187
188     unsigned pathStart() const;
189     unsigned pathEnd() const;
190     unsigned pathAfterLastSlash() const;
191     operator const String&() const { return string(); }
192
193 #if USE(CF)
194     KURL(CFURLRef);
195     CFURLRef createCFURL() const;
196 #endif
197
198 #if PLATFORM(MAC)
199     KURL(NSURL*);
200     operator NSURL*() const;
201 #endif
202 #ifdef __OBJC__
203     operator NSString*() const { return string(); }
204 #endif
205
206 #if PLATFORM(QT)
207     KURL(const QUrl&);
208     operator QUrl() const;
209 #endif
210
211 #if USE(GOOGLEURL)
212     // Getters for the parsed structure and its corresponding 8-bit string.
213     const url_parse::Parsed& parsed() const { return m_url.m_parsed; }
214     const CString& utf8String() const { return m_url.utf8String(); }
215 #endif
216
217 #ifndef NDEBUG
218     void print() const;
219 #endif
220
221 private:
222     void invalidate();
223     bool isHierarchical() const;
224     static bool protocolIs(const String&, const char*);
225 #if USE(GOOGLEURL)
226     friend class KURLGooglePrivate;
227     void parse(const char* url, const String* originalString);  // KURLMac calls this.
228     void copyToBuffer(Vector<char, 512>& buffer) const;  // KURLCFNet uses this.
229     KURLGooglePrivate m_url;
230 #else  // !USE(GOOGLEURL)
231     void init(const KURL&, const String&, const TextEncoding&);
232     void copyToBuffer(Vector<char, 512>& buffer) const;
233
234     // Parses the given URL. The originalString parameter allows for an
235     // optimization: When the source is the same as the fixed-up string,
236     // it will use the passed-in string instead of allocating a new one.
237     void parse(const String&);
238     void parse(const char* url, const String* originalString);
239
240     String m_string;
241     bool m_isValid : 1;
242     bool m_protocolInHTTPFamily : 1;
243
244     int m_schemeEnd;
245     int m_userStart;
246     int m_userEnd;
247     int m_passwordEnd;
248     int m_hostEnd;
249     int m_portEnd;
250     int m_pathAfterLastSlash;
251     int m_pathEnd;
252     int m_queryEnd;
253     int m_fragmentEnd;
254 #endif
255 };
256
257 bool operator==(const KURL&, const KURL&);
258 bool operator==(const KURL&, const String&);
259 bool operator==(const String&, const KURL&);
260 bool operator!=(const KURL&, const KURL&);
261 bool operator!=(const KURL&, const String&);
262 bool operator!=(const String&, const KURL&);
263
264 bool equalIgnoringFragmentIdentifier(const KURL&, const KURL&);
265 bool protocolHostAndPortAreEqual(const KURL&, const KURL&);
266     
267 const KURL& blankURL();
268
269 // Functions to do URL operations on strings.
270 // These are operations that aren't faster on a parsed URL.
271 // These are also different from the KURL functions in that they don't require the string to be a valid and parsable URL.
272 // This is especially important because valid javascript URLs are not necessarily considered valid by KURL.
273
274 bool protocolIs(const String& url, const char* protocol);
275 bool protocolIsJavaScript(const String& url);
276
277 bool isDefaultPortForProtocol(unsigned short port, const String& protocol);
278 bool portAllowed(const KURL&); // Blacklist ports that should never be used for Web resources.
279
280 String mimeTypeFromDataURL(const String& url);
281
282 // Unescapes the given string using URL escaping rules, given an optional
283 // encoding (defaulting to UTF-8 otherwise). DANGER: If the URL has "%00"
284 // in it, the resulting string will have embedded null characters!
285 String decodeURLEscapeSequences(const String&);
286 String decodeURLEscapeSequences(const String&, const TextEncoding&);
287
288 String encodeWithURLEscapeSequences(const String&);
289
290 // Inlines.
291
292 inline bool operator==(const KURL& a, const KURL& b)
293 {
294     return a.string() == b.string();
295 }
296
297 inline bool operator==(const KURL& a, const String& b)
298 {
299     return a.string() == b;
300 }
301
302 inline bool operator==(const String& a, const KURL& b)
303 {
304     return a == b.string();
305 }
306
307 inline bool operator!=(const KURL& a, const KURL& b)
308 {
309     return a.string() != b.string();
310 }
311
312 inline bool operator!=(const KURL& a, const String& b)
313 {
314     return a.string() != b;
315 }
316
317 inline bool operator!=(const String& a, const KURL& b)
318 {
319     return a != b.string();
320 }
321
322 #if !USE(GOOGLEURL)
323
324 // Inline versions of some non-GoogleURL functions so we can get inlining
325 // without having to have a lot of ugly ifdefs in the class definition.
326
327 inline bool KURL::isNull() const
328 {
329     return m_string.isNull();
330 }
331
332 inline bool KURL::isEmpty() const
333 {
334     return m_string.isEmpty();
335 }
336
337 inline bool KURL::isValid() const
338 {
339     return m_isValid;
340 }
341
342 inline bool KURL::hasPort() const
343 {
344     return m_hostEnd < m_portEnd;
345 }
346
347 inline bool KURL::protocolInHTTPFamily() const
348 {
349     return m_protocolInHTTPFamily;
350 }
351
352 inline unsigned KURL::hostStart() const
353 {
354     return (m_passwordEnd == m_userStart) ? m_passwordEnd : m_passwordEnd + 1;
355 }
356
357 inline unsigned KURL::hostEnd() const
358 {
359     return m_hostEnd;
360 }
361
362 inline unsigned KURL::pathStart() const
363 {
364     return m_portEnd;
365 }
366
367 inline unsigned KURL::pathEnd() const
368 {
369     return m_pathEnd;
370 }
371
372 inline unsigned KURL::pathAfterLastSlash() const
373 {
374     return m_pathAfterLastSlash;
375 }
376
377 #endif  // !USE(GOOGLEURL)
378
379 } // namespace WebCore
380
381 namespace WTF {
382
383     // KURLHash is the default hash for String
384     template<typename T> struct DefaultHash;
385     template<> struct DefaultHash<WebCore::KURL> {
386         typedef WebCore::KURLHash Hash;
387     };
388
389 } // namespace WTF
390
391 #endif // KURL_h