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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/* -*- 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_ClientManagerService_h
#define _mozilla_dom_ClientManagerService_h
#include "ClientHandleParent.h"
#include "ClientOpPromise.h"
#include "mozilla/AlreadyAddRefed.h"
#include "mozilla/Assertions.h"
#include "mozilla/Maybe.h"
#include "mozilla/MozPromise.h"
#include "mozilla/RefPtr.h"
#include "mozilla/Variant.h"
#include "mozilla/dom/ClientIPCTypes.h"
#include "mozilla/dom/ipc/IdType.h"
#include "nsHashKeys.h"
#include "nsISupports.h"
#include "nsTArray.h"
#include "nsTHashMap.h"
struct nsID;
namespace mozilla {
namespace ipc {
class PrincipalInfo;
} // namespace ipc
namespace dom {
class ClientManagerParent;
class ClientSourceParent;
class ClientHandleParent;
class ThreadsafeContentParentHandle;
// Define a singleton service to manage client activity throughout the
// browser. This service runs on the PBackground thread. To interact
// it with it please use the ClientManager and ClientHandle classes.
class ClientManagerService final {
// Placeholder type that represents a ClientSourceParent that may be created
// in the future (e.g. while a redirect chain is being resolved).
//
// Each FutureClientSourceParent has a promise that callbacks may be chained
// to; the promise will be resolved when the associated ClientSourceParent is
// created or rejected when it's known that it'll never be created.
class FutureClientSourceParent {
public:
explicit FutureClientSourceParent(const IPCClientInfo& aClientInfo);
const mozilla::ipc::PrincipalInfo& PrincipalInfo() const {
return mPrincipalInfo;
}
already_AddRefed<SourcePromise> Promise() {
return mPromiseHolder.Ensure(__func__);
}
void ResolvePromiseIfExists() {
mPromiseHolder.ResolveIfExists(true, __func__);
}
void RejectPromiseIfExists(const CopyableErrorResult& aRv) {
MOZ_ASSERT(aRv.Failed());
mPromiseHolder.RejectIfExists(aRv, __func__);
}
void SetAsAssociated() { mAssociated = true; }
bool IsAssociated() const { return mAssociated; }
private:
const mozilla::ipc::PrincipalInfo mPrincipalInfo;
MozPromiseHolder<SourcePromise> mPromiseHolder;
RefPtr<ClientManagerService> mService = ClientManagerService::GetInstance();
bool mAssociated;
};
using SourceTableEntry =
Variant<FutureClientSourceParent, ClientSourceParent*>;
// Store the possible ClientSourceParent objects in a hash table. We want to
// optimize for insertion, removal, and lookup by UUID.
nsTHashMap<nsIDHashKey, SourceTableEntry> mSourceTable;
nsTArray<ClientManagerParent*> mManagerList;
bool mShutdown;
ClientManagerService();
~ClientManagerService();
void Shutdown();
// Returns nullptr if aEntry isn't a ClientSourceParent (i.e. it's a
// FutureClientSourceParent).
ClientSourceParent* MaybeUnwrapAsExistingSource(
const SourceTableEntry& aEntry) const;
public:
static already_AddRefed<ClientManagerService> GetOrCreateInstance();
// Returns nullptr if the service is not already created.
static already_AddRefed<ClientManagerService> GetInstance();
bool AddSource(ClientSourceParent* aSource);
bool RemoveSource(ClientSourceParent* aSource);
// Returns true when a FutureClientSourceParent is successfully added.
bool ExpectFutureSource(const IPCClientInfo& aClientInfo);
// May still be called if it's possible that the FutureClientSourceParent
// no longer exists.
void ForgetFutureSource(const IPCClientInfo& aClientInfo);
// Returns a promise that resolves if/when the ClientSourceParent exists and
// rejects if/when it's known that the ClientSourceParent will never exist or
// if it's frozen. Note that the ClientSourceParent may not exist anymore
// by the time promise callbacks run.
RefPtr<SourcePromise> FindSource(
const nsID& aID, const mozilla::ipc::PrincipalInfo& aPrincipalInfo);
// Returns nullptr if the ClientSourceParent doesn't exist yet (i.e. it's a
// FutureClientSourceParent or has already been destroyed) or is frozen.
ClientSourceParent* FindExistingSource(
const nsID& aID, const mozilla::ipc::PrincipalInfo& aPrincipalInfo) const;
void AddManager(ClientManagerParent* aManager);
void RemoveManager(ClientManagerParent* aManager);
RefPtr<ClientOpPromise> Navigate(
ThreadsafeContentParentHandle* aOriginContent,
const ClientNavigateArgs& aArgs);
RefPtr<ClientOpPromise> MatchAll(
ThreadsafeContentParentHandle* aOriginContent,
const ClientMatchAllArgs& aArgs);
RefPtr<ClientOpPromise> Claim(ThreadsafeContentParentHandle* aOriginContent,
const ClientClaimArgs& aArgs);
RefPtr<ClientOpPromise> GetInfoAndState(
ThreadsafeContentParentHandle* aOriginContent,
const ClientGetInfoAndStateArgs& aArgs);
RefPtr<ClientOpPromise> OpenWindow(
ThreadsafeContentParentHandle* aOriginContent,
const ClientOpenWindowArgs& aArgs);
bool HasWindow(const Maybe<ContentParentId>& aContentParentId,
const mozilla::ipc::PrincipalInfo& aPrincipalInfo,
const nsID& aClientId);
NS_INLINE_DECL_REFCOUNTING(mozilla::dom::ClientManagerService)
};
} // namespace dom
} // namespace mozilla
#endif // _mozilla_dom_ClientManagerService_h
|
