1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
/* -*- 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/. */
#ifndef mozilla_dom_Location_h
#define mozilla_dom_Location_h
#include "js/TypeDecls.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/LinkedList.h"
#include "mozilla/dom/BrowsingContext.h"
#include "mozilla/dom/DOMStringList.h"
#include "mozilla/dom/LocationBase.h"
#include "nsCycleCollectionParticipant.h"
#include "nsString.h"
#include "nsWrapperCache.h"
class nsIDocShell;
class nsIPrincipal;
class nsIURI;
class nsPIDOMWindowInner;
namespace mozilla::dom {
// Serializes principals to strings for location.ancestorOrigin purposes.
nsTArray<nsString> ProduceAncestorOriginsList(
const nsTArray<nsCOMPtr<nsIPrincipal>>& aPrincipals);
//*****************************************************************************
// Location: Script "location" object
//*****************************************************************************
class Location final : public nsISupports,
public LocationBase,
public nsWrapperCache,
public LinkedListElement<Location> {
public:
typedef BrowsingContext::LocationProxy RemoteProxy;
explicit Location(nsPIDOMWindowInner* aWindow);
NS_DECL_CYCLE_COLLECTING_ISUPPORTS_FINAL
NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(Location)
// WebIDL API:
void Assign(const nsACString& aUrl, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
MOZ_CAN_RUN_SCRIPT
void Reload(JSContext* aCx, bool aForceget, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetHref(nsACString& aHref, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError) {
if (!CallerSubsumes(&aSubjectPrincipal)) {
aError.Throw(NS_ERROR_DOM_SECURITY_ERR);
return;
}
aError = GetHref(aHref);
}
void GetOrigin(nsACString& aOrigin, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetProtocol(nsACString& aProtocol, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void SetProtocol(const nsACString& aProtocol, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetHost(nsACString& aHost, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void SetHost(const nsACString& aHost, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetHostname(nsACString& aHostname, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void SetHostname(const nsACString& aHostname, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetPort(nsACString& aPort, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void SetPort(const nsACString& aPort, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetPathname(nsACString& aPathname, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void SetPathname(const nsACString& aPathname, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetSearch(nsACString& aSeach, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void SetSearch(const nsACString& aSeach, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void GetHash(nsACString& aHash, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
void SetHash(const nsACString& aHash, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aError);
RefPtr<DOMStringList> GetAncestorOrigins(nsIPrincipal& aSubjectPrincipal,
ErrorResult& aRv);
nsPIDOMWindowInner* GetParentObject() const { return mInnerWindow; }
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
// Non WebIDL methods:
nsresult GetHref(nsACString& aHref);
void ClearCachedValues();
protected:
~Location();
BrowsingContext* GetBrowsingContext() override;
nsIDocShell* GetDocShell() override;
// In the case of jar: uris, we sometimes want the place the jar was
// fetched from as the URI instead of the jar: uri itself. Pass in
// true for aGetInnermostURI when that's the case.
// Note, this method can return NS_OK with a null value for aURL. This happens
// if the docShell is null.
nsresult GetURI(nsIURI** aURL, bool aGetInnermostURI = false);
bool CallerSubsumes(nsIPrincipal* aSubjectPrincipal);
nsCString mCachedHash;
nsCOMPtr<nsPIDOMWindowInner> mInnerWindow;
};
} // namespace mozilla::dom
#endif // mozilla_dom_Location_h
|