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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=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 "Platform.h"
#include "AccEvent.h"
#include "Compatibility.h"
#include "HyperTextAccessible.h"
#include "nsWinUtils.h"
#include "mozilla/a11y/DocAccessibleParent.h"
#include "mozilla/a11y/RemoteAccessible.h"
#include "mozilla/StaticPtr.h"
#include "mozilla/WindowsVersion.h"
#include "mozilla/WinHeaderOnlyUtils.h"
#include "WinUtils.h"
#include "ia2AccessibleText.h"
#include <tuple>
#if defined(MOZ_TELEMETRY_REPORTING)
# include "mozilla/Telemetry.h"
#endif // defined(MOZ_TELEMETRY_REPORTING)
using namespace mozilla;
using namespace mozilla::a11y;
using namespace mozilla::mscom;
static StaticRefPtr<nsIFile> gInstantiator;
void a11y::PlatformInit() {
nsWinUtils::MaybeStartWindowEmulation();
ia2AccessibleText::InitTextChangeData();
}
void a11y::PlatformShutdown() {
::DestroyCaret();
nsWinUtils::ShutdownWindowEmulation();
if (gInstantiator) {
gInstantiator = nullptr;
}
}
void a11y::ProxyCreated(RemoteAccessible* aProxy) {
MsaaAccessible* msaa = MsaaAccessible::Create(aProxy);
msaa->AddRef();
aProxy->SetWrapper(reinterpret_cast<uintptr_t>(msaa));
}
void a11y::ProxyDestroyed(RemoteAccessible* aProxy) {
MsaaAccessible* msaa =
reinterpret_cast<MsaaAccessible*>(aProxy->GetWrapper());
if (!msaa) {
return;
}
msaa->MsaaShutdown();
aProxy->SetWrapper(0);
msaa->Release();
if (aProxy->IsDoc() && nsWinUtils::IsWindowEmulationStarted()) {
aProxy->AsDoc()->SetEmulatedWindowHandle(nullptr);
}
}
void a11y::PlatformEvent(Accessible* aTarget, uint32_t aEventType) {
MsaaAccessible::FireWinEvent(aTarget, aEventType);
}
void a11y::PlatformStateChangeEvent(Accessible* aTarget, uint64_t, bool) {
MsaaAccessible::FireWinEvent(aTarget, nsIAccessibleEvent::EVENT_STATE_CHANGE);
}
void a11y::PlatformFocusEvent(Accessible* aTarget,
const LayoutDeviceIntRect& aCaretRect) {
if (aTarget->IsRemote() && FocusMgr() &&
FocusMgr()->FocusedLocalAccessible()) {
// This is a focus event from a remote document, but focus has moved out
// of that document into the chrome since that event was sent. For example,
// this can happen when choosing File menu -> New Tab. See bug 1471466.
// Note that this does not handle the case where a focus event is sent from
// one remote document, but focus moved into a second remote document
// since that event was sent. However, this isn't something anyone has been
// able to trigger.
return;
}
AccessibleWrap::UpdateSystemCaretFor(aTarget, aCaretRect);
MsaaAccessible::FireWinEvent(aTarget, nsIAccessibleEvent::EVENT_FOCUS);
}
void a11y::PlatformCaretMoveEvent(Accessible* aTarget, int32_t aOffset,
bool aIsSelectionCollapsed,
int32_t aGranularity,
const LayoutDeviceIntRect& aCaretRect,
bool aFromUser) {
AccessibleWrap::UpdateSystemCaretFor(aTarget, aCaretRect);
MsaaAccessible::FireWinEvent(aTarget,
nsIAccessibleEvent::EVENT_TEXT_CARET_MOVED);
}
void a11y::PlatformTextChangeEvent(Accessible* aText, const nsAString& aStr,
int32_t aStart, uint32_t aLen, bool aInsert,
bool) {
uint32_t eventType = aInsert ? nsIAccessibleEvent::EVENT_TEXT_INSERTED
: nsIAccessibleEvent::EVENT_TEXT_REMOVED;
MOZ_ASSERT(aText->IsHyperText());
ia2AccessibleText::UpdateTextChangeData(aText->AsHyperTextBase(), aInsert,
aStr, aStart, aLen);
MsaaAccessible::FireWinEvent(aText, eventType);
}
void a11y::PlatformShowHideEvent(Accessible* aTarget, Accessible*, bool aInsert,
bool) {
uint32_t event =
aInsert ? nsIAccessibleEvent::EVENT_SHOW : nsIAccessibleEvent::EVENT_HIDE;
MsaaAccessible::FireWinEvent(aTarget, event);
}
void a11y::PlatformSelectionEvent(Accessible* aTarget, Accessible*,
uint32_t aType) {
MsaaAccessible::FireWinEvent(aTarget, aType);
}
static bool GetInstantiatorExecutable(const DWORD aPid,
nsIFile** aOutClientExe) {
nsAutoHandle callingProcess(
::OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION, FALSE, aPid));
if (!callingProcess) {
return false;
}
DWORD bufLen = MAX_PATH;
UniquePtr<wchar_t[]> buf;
while (true) {
buf = MakeUnique<wchar_t[]>(bufLen);
if (::QueryFullProcessImageName(callingProcess, 0, buf.get(), &bufLen)) {
break;
}
DWORD lastError = ::GetLastError();
MOZ_ASSERT(lastError == ERROR_INSUFFICIENT_BUFFER);
if (lastError != ERROR_INSUFFICIENT_BUFFER) {
return false;
}
bufLen *= 2;
}
nsCOMPtr<nsIFile> file;
nsresult rv = NS_NewLocalFile(nsDependentString(buf.get(), bufLen), false,
getter_AddRefs(file));
if (NS_FAILED(rv)) {
return false;
}
file.forget(aOutClientExe);
return NS_SUCCEEDED(rv);
}
/**
* Appends version information in the format "|a.b.c.d".
* If there is no version information, we append nothing.
*/
static void AppendVersionInfo(nsIFile* aClientExe, nsAString& aStrToAppend) {
MOZ_ASSERT(!NS_IsMainThread());
LauncherResult<ModuleVersion> version = GetModuleVersion(aClientExe);
if (version.isErr()) {
return;
}
auto [major, minor, patch, build] = version.unwrap().AsTuple();
aStrToAppend.AppendLiteral(u"|");
constexpr auto dot = u"."_ns;
aStrToAppend.AppendInt(major);
aStrToAppend.Append(dot);
aStrToAppend.AppendInt(minor);
aStrToAppend.Append(dot);
aStrToAppend.AppendInt(patch);
aStrToAppend.Append(dot);
aStrToAppend.AppendInt(build);
}
static void AccumulateInstantiatorTelemetry(const nsAString& aValue) {
MOZ_ASSERT(NS_IsMainThread());
if (!aValue.IsEmpty()) {
#if defined(MOZ_TELEMETRY_REPORTING)
Telemetry::ScalarSet(Telemetry::ScalarID::A11Y_INSTANTIATORS, aValue);
#endif // defined(MOZ_TELEMETRY_REPORTING)
CrashReporter::AnnotateCrashReport(
CrashReporter::Annotation::AccessibilityClient,
NS_ConvertUTF16toUTF8(aValue));
}
}
static void GatherInstantiatorTelemetry(nsIFile* aClientExe) {
MOZ_ASSERT(!NS_IsMainThread());
nsString value;
nsresult rv = aClientExe->GetLeafName(value);
if (NS_SUCCEEDED(rv)) {
AppendVersionInfo(aClientExe, value);
}
nsCOMPtr<nsIRunnable> runnable(
NS_NewRunnableFunction("a11y::AccumulateInstantiatorTelemetry",
[value = std::move(value)]() -> void {
AccumulateInstantiatorTelemetry(value);
}));
// Now that we've (possibly) obtained version info, send the resulting
// string back to the main thread to accumulate in telemetry.
NS_DispatchToMainThread(runnable.forget());
}
void a11y::SetInstantiator(const uint32_t aPid) {
nsCOMPtr<nsIFile> clientExe;
if (!GetInstantiatorExecutable(aPid, getter_AddRefs(clientExe))) {
AccumulateInstantiatorTelemetry(
u"(Failed to retrieve client image name)"_ns);
return;
}
// Only record the instantiator if it is the first instantiator, or if it does
// not match the previous one. Some blocked clients are repeatedly requesting
// a11y over and over so we don't want to be spawning countless telemetry
// threads.
if (gInstantiator) {
bool equal;
nsresult rv = gInstantiator->Equals(clientExe, &equal);
if (NS_SUCCEEDED(rv) && equal) {
return;
}
}
gInstantiator = clientExe;
nsCOMPtr<nsIRunnable> runnable(
NS_NewRunnableFunction("a11y::GatherInstantiatorTelemetry",
[clientExe = std::move(clientExe)]() -> void {
GatherInstantiatorTelemetry(clientExe);
}));
DebugOnly<nsresult> rv =
NS_DispatchBackgroundTask(runnable.forget(), NS_DISPATCH_EVENT_MAY_BLOCK);
MOZ_ASSERT(NS_SUCCEEDED(rv));
}
bool a11y::GetInstantiator(nsIFile** aOutInstantiator) {
if (!gInstantiator) {
return false;
}
return NS_SUCCEEDED(gInstantiator->Clone(aOutInstantiator));
}
|