Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / page / Location.cpp
1 /*
2  * Copyright (C) 2008, 2010 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "Location.h"
31
32 #include "DOMWindow.h"
33 #include "Document.h"
34 #include "Frame.h"
35 #include "FrameLoader.h"
36 #include "NavigationScheduler.h"
37 #include <wtf/URL.h>
38 #include "SecurityOrigin.h"
39
40 namespace WebCore {
41
42 Location::Location(DOMWindow& window)
43     : DOMWindowProperty(&window)
44 {
45 }
46
47 inline const URL& Location::url() const
48 {
49     if (!frame())
50         return WTF::blankURL();
51
52     const URL& url = frame()->document()->url();
53     if (!url.isValid())
54         return WTF::blankURL(); // Use "about:blank" while the page is still loading (before we have a frame).
55
56     return url;
57 }
58
59 String Location::href() const
60 {
61     auto& url = this->url();
62
63     if (!url.hasUsername() && !url.hasPassword())
64         return url.string();
65
66     URL urlWithoutCredentials(url);
67     urlWithoutCredentials.setUser(WTF::emptyString());
68     urlWithoutCredentials.setPass(WTF::emptyString());
69     return urlWithoutCredentials.string();
70 }
71
72 String Location::protocol() const
73 {
74     return makeString(url().protocol(), ":");
75 }
76
77 String Location::host() const
78 {
79     // Note: this is the IE spec. The NS spec swaps the two, it says
80     // "The hostname property is the concatenation of the host and port properties, separated by a colon."
81     return url().hostAndPort();
82 }
83
84 String Location::hostname() const
85 {
86     return url().host().toString();
87 }
88
89 String Location::port() const
90 {
91     const URL& url = this->url();
92     return url.port() ? String::number(url.port().value()) : emptyString();
93 }
94
95 String Location::pathname() const
96 {
97     const URL& url = this->url();
98     return url.path().isEmpty() ? "/" : url.path();
99 }
100
101 String Location::search() const
102 {
103     const URL& url = this->url();
104     return url.query().isEmpty() ? emptyString() : "?" + url.query();
105 }
106
107 String Location::origin() const
108 {
109     return SecurityOrigin::create(url())->toString();
110 }
111
112 Ref<DOMStringList> Location::ancestorOrigins() const
113 {
114     auto origins = DOMStringList::create();
115     auto* frame = this->frame();
116     if (!frame)
117         return origins;
118     for (auto* ancestor = frame->tree().parent(); ancestor; ancestor = ancestor->tree().parent())
119         origins->append(ancestor->document()->securityOrigin().toString());
120     return origins;
121 }
122
123 String Location::hash() const
124 {
125     const String& fragmentIdentifier = url().fragmentIdentifier();
126     return fragmentIdentifier.isEmpty() ? emptyString() : "#" + fragmentIdentifier;
127 }
128
129 ExceptionOr<void> Location::setHref(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& url)
130 {
131     if (!frame())
132         return { };
133     return setLocation(activeWindow, firstWindow, url);
134 }
135
136 ExceptionOr<void> Location::setProtocol(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& protocol)
137 {
138     auto* frame = this->frame();
139     if (!frame)
140         return { };
141     URL url = frame->document()->url();
142     if (!url.setProtocol(protocol))
143         return Exception { SyntaxError };
144     return setLocation(activeWindow, firstWindow, url.string());
145 }
146
147 ExceptionOr<void> Location::setHost(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& host)
148 {
149     auto* frame = this->frame();
150     if (!frame)
151         return { };
152     URL url = frame->document()->url();
153     url.setHostAndPort(host);
154     return setLocation(activeWindow, firstWindow, url.string());
155 }
156
157 ExceptionOr<void> Location::setHostname(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& hostname)
158 {
159     auto* frame = this->frame();
160     if (!frame)
161         return { };
162     URL url = frame->document()->url();
163     url.setHost(hostname);
164     return setLocation(activeWindow, firstWindow, url.string());
165 }
166
167 ExceptionOr<void> Location::setPort(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& portString)
168 {
169     auto* frame = this->frame();
170     if (!frame)
171         return { };
172     URL url = frame->document()->url();
173     int port = portString.toInt();
174     if (port < 0 || port > 0xFFFF || portString.isEmpty())
175         url.removePort();
176     else
177         url.setPort(port);
178     return setLocation(activeWindow, firstWindow, url.string());
179 }
180
181 ExceptionOr<void> Location::setPathname(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& pathname)
182 {
183     auto* frame = this->frame();
184     if (!frame)
185         return { };
186     URL url = frame->document()->url();
187     url.setPath(pathname);
188     return setLocation(activeWindow, firstWindow, url.string());
189 }
190
191 ExceptionOr<void> Location::setSearch(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& search)
192 {
193     auto* frame = this->frame();
194     if (!frame)
195         return { };
196     URL url = frame->document()->url();
197     url.setQuery(search);
198     return setLocation(activeWindow, firstWindow, url.string());
199 }
200
201 ExceptionOr<void> Location::setHash(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& hash)
202 {
203     auto* frame = this->frame();
204     if (!frame)
205         return { };
206     ASSERT(frame->document());
207     auto url = frame->document()->url();
208     auto oldFragmentIdentifier = url.fragmentIdentifier();
209     auto newFragmentIdentifier = hash;
210     if (hash[0] == '#')
211         newFragmentIdentifier = hash.substring(1);
212     url.setFragmentIdentifier(newFragmentIdentifier);
213     // Note that by parsing the URL and *then* comparing fragments, we are 
214     // comparing fragments post-canonicalization, and so this handles the 
215     // cases where fragment identifiers are ignored or invalid. 
216     if (equalIgnoringNullity(oldFragmentIdentifier, url.fragmentIdentifier()))
217         return { };
218     return setLocation(activeWindow, firstWindow, url.string());
219 }
220
221 ExceptionOr<void> Location::assign(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& url)
222 {
223     if (!frame())
224         return { };
225     return setLocation(activeWindow, firstWindow, url);
226 }
227
228 void Location::replace(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& url)
229 {
230     auto* frame = this->frame();
231     if (!frame)
232         return;
233     ASSERT(frame->document());
234     ASSERT(frame->document()->domWindow());
235     // We call DOMWindow::setLocation directly here because replace() always operates on the current frame.
236     frame->document()->domWindow()->setLocation(activeWindow, firstWindow, url, LockHistoryAndBackForwardList);
237 }
238
239 void Location::reload(DOMWindow& activeWindow)
240 {
241     auto* frame = this->frame();
242     if (!frame)
243         return;
244
245     ASSERT(activeWindow.document());
246     ASSERT(frame->document());
247     ASSERT(frame->document()->domWindow());
248
249     auto& activeDocument = *activeWindow.document();
250     auto& targetDocument = *frame->document();
251
252     // FIXME: It's not clear this cross-origin security check is valuable.
253     // We allow one page to change the location of another. Why block attempts to reload?
254     // Other location operations simply block use of JavaScript URLs cross origin.
255     if (!activeDocument.securityOrigin().canAccess(targetDocument.securityOrigin())) {
256         auto& targetWindow = *targetDocument.domWindow();
257         targetWindow.printErrorMessage(targetWindow.crossDomainAccessErrorMessage(activeWindow, IncludeTargetOrigin::Yes));
258         return;
259     }
260
261     if (WTF::protocolIsJavaScript(targetDocument.url()))
262         return;
263
264     frame->navigationScheduler().scheduleRefresh(activeDocument);
265 }
266
267 ExceptionOr<void> Location::setLocation(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& url)
268 {
269     auto* frame = this->frame();
270     ASSERT(frame);
271     if (!activeWindow.document()->canNavigate(frame))
272         return Exception { SecurityError };
273     ASSERT(frame->document());
274     ASSERT(frame->document()->domWindow());
275     frame->document()->domWindow()->setLocation(activeWindow, firstWindow, url);
276     return { };
277 }
278
279 } // namespace WebCore