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