summaryrefslogtreecommitdiffstats
path: root/dom/base/Location.cpp
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--dom/base/Location.cpp653
1 files changed, 653 insertions, 0 deletions
diff --git a/dom/base/Location.cpp b/dom/base/Location.cpp
new file mode 100644
index 0000000000..e5ed7e22e4
--- /dev/null
+++ b/dom/base/Location.cpp
@@ -0,0 +1,653 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "Location.h"
+#include "nsIScriptObjectPrincipal.h"
+#include "nsIScriptContext.h"
+#include "nsDocShellLoadState.h"
+#include "nsIWebNavigation.h"
+#include "nsIOService.h"
+#include "nsIURL.h"
+#include "nsIJARURI.h"
+#include "nsIURIMutator.h"
+#include "nsNetUtil.h"
+#include "nsCOMPtr.h"
+#include "nsEscape.h"
+#include "nsPresContext.h"
+#include "nsError.h"
+#include "nsReadableUtils.h"
+#include "nsJSUtils.h"
+#include "nsContentUtils.h"
+#include "nsDocShell.h"
+#include "nsGlobalWindow.h"
+#include "mozilla/Likely.h"
+#include "nsCycleCollectionParticipant.h"
+#include "mozilla/BasePrincipal.h"
+#include "mozilla/Components.h"
+#include "mozilla/NullPrincipal.h"
+#include "mozilla/ServoStyleConsts.h"
+#include "mozilla/StaticPrefs_dom.h"
+#include "mozilla/Unused.h"
+#include "mozilla/dom/Document.h"
+#include "mozilla/dom/DocumentInlines.h"
+#include "mozilla/dom/LocationBinding.h"
+#include "mozilla/dom/ScriptSettings.h"
+#include "ReferrerInfo.h"
+
+namespace mozilla::dom {
+
+Location::Location(nsPIDOMWindowInner* aWindow,
+ BrowsingContext* aBrowsingContext)
+ : mInnerWindow(aWindow) {
+ // aBrowsingContext can be null if it gets called after nsDocShell::Destory().
+ if (aBrowsingContext) {
+ mBrowsingContextId = aBrowsingContext->Id();
+ }
+}
+
+Location::~Location() = default;
+
+// QueryInterface implementation for Location
+NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(Location)
+ NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
+ NS_INTERFACE_MAP_ENTRY(nsISupports)
+NS_INTERFACE_MAP_END
+
+NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(Location, mInnerWindow)
+
+NS_IMPL_CYCLE_COLLECTING_ADDREF(Location)
+NS_IMPL_CYCLE_COLLECTING_RELEASE(Location)
+
+BrowsingContext* Location::GetBrowsingContext() {
+ RefPtr<BrowsingContext> bc = BrowsingContext::Get(mBrowsingContextId);
+ return bc.get();
+}
+
+already_AddRefed<nsIDocShell> Location::GetDocShell() {
+ if (RefPtr<BrowsingContext> bc = GetBrowsingContext()) {
+ return do_AddRef(bc->GetDocShell());
+ }
+ return nullptr;
+}
+
+nsresult Location::GetURI(nsIURI** aURI, bool aGetInnermostURI) {
+ *aURI = nullptr;
+
+ nsCOMPtr<nsIDocShell> docShell(GetDocShell());
+ if (!docShell) {
+ return NS_OK;
+ }
+
+ nsresult rv;
+ nsCOMPtr<nsIWebNavigation> webNav(do_QueryInterface(docShell, &rv));
+ if (NS_FAILED(rv)) {
+ return rv;
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ rv = webNav->GetCurrentURI(getter_AddRefs(uri));
+ NS_ENSURE_SUCCESS(rv, rv);
+
+ // It is valid for docshell to return a null URI. Don't try to fixup
+ // if this happens.
+ if (!uri) {
+ return NS_OK;
+ }
+
+ if (aGetInnermostURI) {
+ nsCOMPtr<nsIJARURI> jarURI(do_QueryInterface(uri));
+ while (jarURI) {
+ jarURI->GetJARFile(getter_AddRefs(uri));
+ jarURI = do_QueryInterface(uri);
+ }
+ }
+
+ NS_ASSERTION(uri, "nsJARURI screwed up?");
+ nsCOMPtr<nsIURI> exposableURI = net::nsIOService::CreateExposableURI(uri);
+ exposableURI.forget(aURI);
+ return NS_OK;
+}
+
+void Location::GetHash(nsAString& aHash, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aHash.SetLength(0);
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ nsAutoCString ref;
+ nsAutoString unicodeRef;
+
+ aRv = uri->GetRef(ref);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ if (!ref.IsEmpty()) {
+ aHash.Assign(char16_t('#'));
+ AppendUTF8toUTF16(ref, aHash);
+ }
+
+ if (aHash == mCachedHash) {
+ // Work around ShareThis stupidly polling location.hash every
+ // 5ms all the time by handing out the same exact string buffer
+ // we handed out last time.
+ aHash = mCachedHash;
+ } else {
+ mCachedHash = aHash;
+ }
+}
+
+void Location::SetHash(const nsAString& aHash, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ NS_ConvertUTF16toUTF8 hash(aHash);
+ if (hash.IsEmpty() || hash.First() != char16_t('#')) {
+ hash.Insert(char16_t('#'), 0);
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ aRv = NS_MutateURI(uri).SetRef(hash).Finalize(uri);
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ SetURI(uri, aSubjectPrincipal, aRv);
+}
+
+void Location::GetHost(nsAString& aHost, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aHost.Truncate();
+
+ nsCOMPtr<nsIURI> uri;
+ nsresult result;
+
+ result = GetURI(getter_AddRefs(uri), true);
+
+ if (uri) {
+ nsAutoCString hostport;
+
+ result = uri->GetHostPort(hostport);
+
+ if (NS_SUCCEEDED(result)) {
+ AppendUTF8toUTF16(hostport, aHost);
+ }
+ }
+}
+
+void Location::SetHost(const nsAString& aHost, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ aRv =
+ NS_MutateURI(uri).SetHostPort(NS_ConvertUTF16toUTF8(aHost)).Finalize(uri);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ SetURI(uri, aSubjectPrincipal, aRv);
+}
+
+void Location::GetHostname(nsAString& aHostname,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aHostname.Truncate();
+
+ nsCOMPtr<nsIURI> uri;
+ GetURI(getter_AddRefs(uri), true);
+ if (uri) {
+ nsContentUtils::GetHostOrIPv6WithBrackets(uri, aHostname);
+ }
+}
+
+void Location::SetHostname(const nsAString& aHostname,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ aRv =
+ NS_MutateURI(uri).SetHost(NS_ConvertUTF16toUTF8(aHostname)).Finalize(uri);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ SetURI(uri, aSubjectPrincipal, aRv);
+}
+
+nsresult Location::GetHref(nsAString& aHref) {
+ aHref.Truncate();
+
+ nsCOMPtr<nsIURI> uri;
+ nsresult rv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(NS_FAILED(rv)) || !uri) {
+ return rv;
+ }
+
+ nsAutoCString uriString;
+ rv = uri->GetSpec(uriString);
+ if (NS_WARN_IF(NS_FAILED(rv))) {
+ return rv;
+ }
+
+ AppendUTF8toUTF16(uriString, aHref);
+ return NS_OK;
+}
+
+void Location::GetOrigin(nsAString& aOrigin, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aOrigin.Truncate();
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri), true);
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ nsAutoString origin;
+ aRv = nsContentUtils::GetUTFOrigin(uri, origin);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ aOrigin = origin;
+}
+
+void Location::GetPathname(nsAString& aPathname,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aPathname.Truncate();
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ nsAutoCString file;
+
+ aRv = uri->GetFilePath(file);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ AppendUTF8toUTF16(file, aPathname);
+}
+
+void Location::SetPathname(const nsAString& aPathname,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ nsresult rv = NS_MutateURI(uri)
+ .SetFilePath(NS_ConvertUTF16toUTF8(aPathname))
+ .Finalize(uri);
+ if (NS_FAILED(rv)) {
+ return;
+ }
+
+ SetURI(uri, aSubjectPrincipal, aRv);
+}
+
+void Location::GetPort(nsAString& aPort, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aPort.SetLength(0);
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri), true);
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ int32_t port;
+ nsresult result = uri->GetPort(&port);
+
+ // Don't propagate this exception to caller
+ if (NS_SUCCEEDED(result) && -1 != port) {
+ nsAutoString portStr;
+ portStr.AppendInt(port);
+ aPort.Append(portStr);
+ }
+}
+
+void Location::SetPort(const nsAString& aPort, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed() || !uri)) {
+ return;
+ }
+
+ // perhaps use nsReadingIterators at some point?
+ NS_ConvertUTF16toUTF8 portStr(aPort);
+ const char* buf = portStr.get();
+ int32_t port = -1;
+
+ if (!portStr.IsEmpty() && buf) {
+ if (*buf == ':') {
+ port = atol(buf + 1);
+ } else {
+ port = atol(buf);
+ }
+ }
+
+ aRv = NS_MutateURI(uri).SetPort(port).Finalize(uri);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ SetURI(uri, aSubjectPrincipal, aRv);
+}
+
+void Location::GetProtocol(nsAString& aProtocol,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aProtocol.SetLength(0);
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ nsAutoCString protocol;
+
+ aRv = uri->GetScheme(protocol);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ CopyASCIItoUTF16(protocol, aProtocol);
+ aProtocol.Append(char16_t(':'));
+}
+
+void Location::SetProtocol(const nsAString& aProtocol,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !uri) {
+ return;
+ }
+
+ nsAString::const_iterator start, end;
+ aProtocol.BeginReading(start);
+ aProtocol.EndReading(end);
+ nsAString::const_iterator iter(start);
+ Unused << FindCharInReadable(':', iter, end);
+
+ nsresult rv = NS_MutateURI(uri)
+ .SetScheme(NS_ConvertUTF16toUTF8(Substring(start, iter)))
+ .Finalize(uri);
+ if (NS_WARN_IF(NS_FAILED(rv))) {
+ // Oh, I wish nsStandardURL returned NS_ERROR_MALFORMED_URI for _all_ the
+ // malformed cases, not just some of them!
+ aRv.Throw(NS_ERROR_DOM_SYNTAX_ERR);
+ return;
+ }
+
+ nsAutoCString newSpec;
+ aRv = uri->GetSpec(newSpec);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+ // We may want a new URI class for the new URI, so recreate it:
+ rv = NS_NewURI(getter_AddRefs(uri), newSpec);
+ if (NS_FAILED(rv)) {
+ if (rv == NS_ERROR_MALFORMED_URI) {
+ rv = NS_ERROR_DOM_SYNTAX_ERR;
+ }
+
+ aRv.Throw(rv);
+ return;
+ }
+
+ if (!uri->SchemeIs("http") && !uri->SchemeIs("https")) {
+ // No-op, per spec.
+ return;
+ }
+
+ SetURI(uri, aSubjectPrincipal, aRv);
+}
+
+void Location::GetSearch(nsAString& aSearch, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aSearch.SetLength(0);
+
+ nsCOMPtr<nsIURI> uri;
+ nsresult result = NS_OK;
+
+ result = GetURI(getter_AddRefs(uri));
+
+ nsCOMPtr<nsIURL> url(do_QueryInterface(uri));
+
+ if (url) {
+ nsAutoCString search;
+
+ result = url->GetQuery(search);
+
+ if (NS_SUCCEEDED(result) && !search.IsEmpty()) {
+ aSearch.Assign(char16_t('?'));
+ AppendUTF8toUTF16(search, aSearch);
+ }
+ }
+}
+
+void Location::SetSearch(const nsAString& aSearch,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ nsCOMPtr<nsIURI> uri;
+ aRv = GetURI(getter_AddRefs(uri));
+ nsCOMPtr<nsIURL> url(do_QueryInterface(uri));
+ if (NS_WARN_IF(aRv.Failed()) || !url) {
+ return;
+ }
+
+ aRv =
+ NS_MutateURI(uri).SetQuery(NS_ConvertUTF16toUTF8(aSearch)).Finalize(uri);
+ if (NS_WARN_IF(aRv.Failed())) {
+ return;
+ }
+
+ SetURI(uri, aSubjectPrincipal, aRv);
+}
+
+void Location::Reload(bool aForceget, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ RefPtr<nsDocShell> docShell(GetDocShell().downcast<nsDocShell>());
+ if (!docShell) {
+ return aRv.Throw(NS_ERROR_FAILURE);
+ }
+
+ if (StaticPrefs::dom_block_reload_from_resize_event_handler()) {
+ nsCOMPtr<nsPIDOMWindowOuter> window = docShell->GetWindow();
+ if (window && window->IsHandlingResizeEvent()) {
+ // location.reload() was called on a window that is handling a
+ // resize event. Sites do this since Netscape 4.x needed it, but
+ // we don't, and it's a horrible experience for nothing. In stead
+ // of reloading the page, just clear style data and reflow the
+ // page since some sites may use this trick to work around gecko
+ // reflow bugs, and this should have the same effect.
+ RefPtr<Document> doc = window->GetExtantDoc();
+
+ nsPresContext* pcx;
+ if (doc && (pcx = doc->GetPresContext())) {
+ pcx->RebuildAllStyleData(NS_STYLE_HINT_REFLOW,
+ RestyleHint::RestyleSubtree());
+ }
+ return;
+ }
+ }
+
+ RefPtr<BrowsingContext> bc = GetBrowsingContext();
+ if (!bc || bc->IsDiscarded()) {
+ return;
+ }
+
+ CallerType callerType = aSubjectPrincipal.IsSystemPrincipal()
+ ? CallerType::System
+ : CallerType::NonSystem;
+
+ nsresult rv = bc->CheckLocationChangeRateLimit(callerType);
+ if (NS_FAILED(rv)) {
+ aRv.Throw(rv);
+ return;
+ }
+
+ uint32_t reloadFlags = nsIWebNavigation::LOAD_FLAGS_NONE;
+
+ if (aForceget) {
+ reloadFlags = nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE |
+ nsIWebNavigation::LOAD_FLAGS_BYPASS_PROXY;
+ }
+
+ rv = docShell->Reload(reloadFlags);
+ if (NS_FAILED(rv) && rv != NS_BINDING_ABORTED) {
+ // NS_BINDING_ABORTED is returned when we attempt to reload a POST result
+ // and the user says no at the "do you want to reload?" prompt. Don't
+ // propagate this one back to callers.
+ return aRv.Throw(rv);
+ }
+}
+
+void Location::Assign(const nsAString& aUrl, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aRv.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ DoSetHref(aUrl, aSubjectPrincipal, false, aRv);
+}
+
+bool Location::CallerSubsumes(nsIPrincipal* aSubjectPrincipal) {
+ MOZ_ASSERT(aSubjectPrincipal);
+
+ RefPtr<BrowsingContext> bc(GetBrowsingContext());
+ if (MOZ_UNLIKELY(!bc) || MOZ_UNLIKELY(bc->IsDiscarded())) {
+ // Per spec, operations on a Location object with a discarded BC are no-ops,
+ // not security errors, so we need to return true from the access check and
+ // let the caller do its own discarded docShell check.
+ return true;
+ }
+ if (MOZ_UNLIKELY(!bc->IsInProcess())) {
+ return false;
+ }
+
+ // Get the principal associated with the location object. Note that this is
+ // the principal of the page which will actually be navigated, not the
+ // principal of the Location object itself. This is why we need this check
+ // even though we only allow limited cross-origin access to Location objects
+ // in general.
+ nsCOMPtr<nsPIDOMWindowOuter> outer = bc->GetDOMWindow();
+ MOZ_DIAGNOSTIC_ASSERT(outer);
+ if (MOZ_UNLIKELY(!outer)) return false;
+
+ nsCOMPtr<nsIScriptObjectPrincipal> sop = do_QueryInterface(outer);
+ bool subsumes = false;
+ nsresult rv = aSubjectPrincipal->SubsumesConsideringDomain(
+ sop->GetPrincipal(), &subsumes);
+ NS_ENSURE_SUCCESS(rv, false);
+ return subsumes;
+}
+
+JSObject* Location::WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) {
+ return Location_Binding::Wrap(aCx, this, aGivenProto);
+}
+
+} // namespace mozilla::dom