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