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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
|
/*
** Copyright 2011, The Android Open Source Project
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
** http://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
package android.view.accessibility;
import static android.accessibilityservice.AccessibilityTrace.FLAGS_ACCESSIBILITY_INTERACTION_CLIENT;
import static android.accessibilityservice.AccessibilityTrace.FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK;
import static android.os.Build.VERSION_CODES.S;
import static android.view.accessibility.AccessibilityNodeInfo.FLAG_PREFETCH_DESCENDANTS_MASK;
import static android.view.accessibility.AccessibilityNodeInfo.FLAG_PREFETCH_MASK;
import android.accessibilityservice.IAccessibilityServiceConnection;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SuppressLint;
import android.compat.annotation.UnsupportedAppUsage;
import android.content.Context;
import android.os.Binder;
import android.os.Build;
import android.os.Bundle;
import android.os.IBinder;
import android.os.Message;
import android.os.Process;
import android.os.RemoteException;
import android.os.SystemClock;
import android.util.Log;
import android.util.LongSparseArray;
import android.util.SparseArray;
import android.util.SparseLongArray;
import android.view.Display;
import android.view.ViewConfiguration;
import com.android.internal.annotations.VisibleForTesting;
import com.android.internal.util.ArrayUtils;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.atomic.AtomicInteger;
/**
* This class is a singleton that performs accessibility interaction
* which is it queries remote view hierarchies about snapshots of their
* views as well requests from these hierarchies to perform certain
* actions on their views.
*
* Rationale: The content retrieval APIs are synchronous from a client's
* perspective but internally they are asynchronous. The client thread
* calls into the system requesting an action and providing a callback
* to receive the result after which it waits up to a timeout for that
* result. The system enforces security and the delegates the request
* to a given view hierarchy where a message is posted (from a binder
* thread) describing what to be performed by the main UI thread the
* result of which it delivered via the mentioned callback. However,
* the blocked client thread and the main UI thread of the target view
* hierarchy can be the same thread, for example an accessibility service
* and an activity run in the same process, thus they are executed on the
* same main thread. In such a case the retrieval will fail since the UI
* thread that has to process the message describing the work to be done
* is blocked waiting for a result is has to compute! To avoid this scenario
* when making a call the client also passes its process and thread ids so
* the accessed view hierarchy can detect if the client making the request
* is running in its main UI thread. In such a case the view hierarchy,
* specifically the binder thread performing the IPC to it, does not post a
* message to be run on the UI thread but passes it to the singleton
* interaction client through which all interactions occur and the latter is
* responsible to execute the message before starting to wait for the
* asynchronous result delivered via the callback. In this case the expected
* result is already received so no waiting is performed.
*
* @hide
*/
public final class AccessibilityInteractionClient
extends IAccessibilityInteractionConnectionCallback.Stub {
public static final int NO_ID = -1;
public static final String CALL_STACK = "call_stack";
public static final String IGNORE_CALL_STACK = "ignore_call_stack";
private static final String LOG_TAG = "AccessibilityInteractionClient";
private static final boolean DEBUG = false;
private static final boolean CHECK_INTEGRITY = true;
private static final long TIMEOUT_INTERACTION_MILLIS = 5000;
private static final long DISABLE_PREFETCHING_FOR_SCROLLING_MILLIS =
(long) (ViewConfiguration.getSendRecurringAccessibilityEventsInterval() * 1.5);
private static final Object sStaticLock = new Object();
private static final LongSparseArray<AccessibilityInteractionClient> sClients =
new LongSparseArray<>();
private static final SparseArray<IAccessibilityServiceConnection> sConnectionCache =
new SparseArray<>();
/** List of timestamps which indicate the latest time an a11y service receives a scroll event
from a window, mapping from windowId -> timestamp. */
private static final SparseLongArray sScrollingWindows = new SparseLongArray();
private static SparseArray<AccessibilityCache> sCaches = new SparseArray<>();
private final AtomicInteger mInteractionIdCounter = new AtomicInteger();
private final Object mInstanceLock = new Object();
private final AccessibilityManager mAccessibilityManager;
private volatile int mInteractionId = -1;
private volatile int mCallingUid = Process.INVALID_UID;
// call stack for IAccessibilityInteractionConnectionCallback APIs. These callback APIs are
// shared by multiple requests APIs in IAccessibilityServiceConnection. To correctly log the
// request API which triggers the callback, we log trace entries for callback after the
// request API thread waiting for the callback returns. To log the correct callback stack in
// the request API thread, we save the callback stack in this member variables.
private List<StackTraceElement> mCallStackOfCallback;
private AccessibilityNodeInfo mFindAccessibilityNodeInfoResult;
private List<AccessibilityNodeInfo> mFindAccessibilityNodeInfosResult;
private boolean mPerformAccessibilityActionResult;
private Message mSameThreadMessage;
private int mInteractionIdWaitingForPrefetchResult = -1;
private int mConnectionIdWaitingForPrefetchResult;
private String[] mPackageNamesForNextPrefetchResult;
/**
* @return The client for the current thread.
*/
@UnsupportedAppUsage()
public static AccessibilityInteractionClient getInstance() {
final long threadId = Thread.currentThread().getId();
return getInstanceForThread(threadId);
}
/**
* <strong>Note:</strong> We keep one instance per interrogating thread since
* the instance contains state which can lead to undesired thread interleavings.
* We do not have a thread local variable since other threads should be able to
* look up the correct client knowing a thread id. See ViewRootImpl for details.
*
* @return The client for a given <code>threadId</code>.
*/
public static AccessibilityInteractionClient getInstanceForThread(long threadId) {
synchronized (sStaticLock) {
AccessibilityInteractionClient client = sClients.get(threadId);
if (client == null) {
client = new AccessibilityInteractionClient();
sClients.put(threadId, client);
}
return client;
}
}
/**
* @return The client for the current thread.
*/
public static AccessibilityInteractionClient getInstance(Context context) {
final long threadId = Thread.currentThread().getId();
if (context != null) {
return getInstanceForThread(threadId, context);
}
return getInstanceForThread(threadId);
}
/**
* <strong>Note:</strong> We keep one instance per interrogating thread since
* the instance contains state which can lead to undesired thread interleavings.
* We do not have a thread local variable since other threads should be able to
* look up the correct client knowing a thread id. See ViewRootImpl for details.
*
* @return The client for a given <code>threadId</code>.
*/
public static AccessibilityInteractionClient getInstanceForThread(long threadId,
Context context) {
synchronized (sStaticLock) {
AccessibilityInteractionClient client = sClients.get(threadId);
if (client == null) {
client = new AccessibilityInteractionClient(context);
sClients.put(threadId, client);
}
return client;
}
}
/**
* Gets a cached accessibility service connection.
*
* @param connectionId The connection id.
* @return The cached connection if such.
*/
public static IAccessibilityServiceConnection getConnection(int connectionId) {
synchronized (sConnectionCache) {
return sConnectionCache.get(connectionId);
}
}
/**
* Adds a cached accessibility service connection.
*
* Adds a cache if {@code initializeCache} is true
* @param connectionId The connection id.
* @param connection The connection.
* @param initializeCache whether to initialize a cache
*/
public static void addConnection(int connectionId, IAccessibilityServiceConnection connection,
boolean initializeCache) {
if (connectionId == NO_ID) {
return;
}
synchronized (sConnectionCache) {
sConnectionCache.put(connectionId, connection);
if (!initializeCache) {
return;
}
sCaches.put(connectionId, new AccessibilityCache(
new AccessibilityCache.AccessibilityNodeRefresher()));
}
}
/**
* Gets a cached associated with the connection id if available.
*
*/
public static AccessibilityCache getCache(int connectionId) {
synchronized (sConnectionCache) {
return sCaches.get(connectionId);
}
}
/**
* Removes a cached accessibility service connection.
*
* @param connectionId The connection id.
*/
public static void removeConnection(int connectionId) {
synchronized (sConnectionCache) {
sConnectionCache.remove(connectionId);
sCaches.remove(connectionId);
}
}
/**
* This method is only for testing. Replacing the cache is a generally terrible idea, but
* tests need to be able to verify this class's interactions with the cache
*/
@VisibleForTesting
public static void setCache(int connectionId, AccessibilityCache cache) {
synchronized (sConnectionCache) {
sCaches.put(connectionId, cache);
}
}
private AccessibilityInteractionClient() {
/* reducing constructor visibility */
mAccessibilityManager = null;
}
private AccessibilityInteractionClient(Context context) {
mAccessibilityManager = context.getSystemService(AccessibilityManager.class);
}
/**
* Sets the message to be processed if the interacted view hierarchy
* and the interacting client are running in the same thread.
*
* @param message The message.
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public void setSameThreadMessage(Message message) {
synchronized (mInstanceLock) {
mSameThreadMessage = message;
mInstanceLock.notifyAll();
}
}
/**
* Gets the root {@link AccessibilityNodeInfo} in the currently active window.
*
* @param connectionId The id of a connection for interacting with the system.
* @return The root {@link AccessibilityNodeInfo} if found, null otherwise.
*/
public AccessibilityNodeInfo getRootInActiveWindow(int connectionId,
@AccessibilityNodeInfo.PrefetchingStrategy int strategy) {
return findAccessibilityNodeInfoByAccessibilityId(connectionId,
AccessibilityWindowInfo.ACTIVE_WINDOW_ID, AccessibilityNodeInfo.ROOT_NODE_ID,
false, strategy, null);
}
/**
* Gets the info for a window.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link android.view.accessibility.AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window.
* @return The {@link AccessibilityWindowInfo}.
*/
public AccessibilityWindowInfo getWindow(int connectionId, int accessibilityWindowId) {
return getWindow(connectionId, accessibilityWindowId, /* bypassCache */ false);
}
/**
* Gets the info for a window.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window.
* @param bypassCache Whether to bypass the cache.
* @return The {@link AccessibilityWindowInfo}.
*/
public AccessibilityWindowInfo getWindow(int connectionId, int accessibilityWindowId,
boolean bypassCache) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
AccessibilityWindowInfo window;
AccessibilityCache cache = getCache(connectionId);
if (cache != null) {
if (!bypassCache) {
window = cache.getWindow(accessibilityWindowId);
if (window != null) {
if (DEBUG) {
Log.i(LOG_TAG, "Window cache hit");
}
if (shouldTraceClient()) {
logTraceClient(connection, "getWindow cache",
"connectionId=" + connectionId + ";accessibilityWindowId="
+ accessibilityWindowId + ";bypassCache=false");
}
return window;
}
if (DEBUG) {
Log.i(LOG_TAG, "Window cache miss");
}
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "Cache is null for connection id: " + connectionId);
}
}
final long identityToken = Binder.clearCallingIdentity();
try {
window = connection.getWindow(accessibilityWindowId);
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (shouldTraceClient()) {
logTraceClient(connection, "getWindow", "connectionId=" + connectionId
+ ";accessibilityWindowId=" + accessibilityWindowId + ";bypassCache="
+ bypassCache);
}
if (window != null) {
if (!bypassCache && cache != null) {
cache.addWindow(window);
}
return window;
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while calling remote getWindow", re);
}
return null;
}
/**
* Gets the info for all windows of the default display.
*
* @param connectionId The id of a connection for interacting with the system.
* @return The {@link AccessibilityWindowInfo} list.
*/
public List<AccessibilityWindowInfo> getWindows(int connectionId) {
final SparseArray<List<AccessibilityWindowInfo>> windows =
getWindowsOnAllDisplays(connectionId);
if (windows.size() > 0) {
return windows.valueAt(Display.DEFAULT_DISPLAY);
}
return Collections.emptyList();
}
/**
* Gets the info for all windows of all displays.
*
* @param connectionId The id of a connection for interacting with the system.
* @return The SparseArray of {@link AccessibilityWindowInfo} list.
* The key of SparseArray is display ID.
*/
public SparseArray<List<AccessibilityWindowInfo>> getWindowsOnAllDisplays(int connectionId) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
SparseArray<List<AccessibilityWindowInfo>> windows;
AccessibilityCache cache = getCache(connectionId);
if (cache != null) {
windows = cache.getWindowsOnAllDisplays();
if (windows != null) {
if (DEBUG) {
Log.i(LOG_TAG, "Windows cache hit");
}
if (shouldTraceClient()) {
logTraceClient(
connection, "getWindows cache", "connectionId=" + connectionId);
}
return windows;
}
if (DEBUG) {
Log.i(LOG_TAG, "Windows cache miss");
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "Cache is null for connection id: " + connectionId);
}
}
long populationTimeStamp;
final long identityToken = Binder.clearCallingIdentity();
try {
populationTimeStamp = SystemClock.uptimeMillis();
windows = connection.getWindows();
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (shouldTraceClient()) {
logTraceClient(connection, "getWindows", "connectionId=" + connectionId);
}
if (windows != null) {
if (cache != null) {
cache.setWindowsOnAllDisplays(windows, populationTimeStamp);
}
return windows;
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while calling remote getWindowsOnAllDisplays", re);
}
final SparseArray<List<AccessibilityWindowInfo>> emptyWindows = new SparseArray<>();
return emptyWindows;
}
/**
* Finds an {@link AccessibilityNodeInfo} by accessibility id and given leash token instead of
* window id. This method is used to find the leashed node on the embedded view hierarchy.
*
* @param connectionId The id of a connection for interacting with the system.
* @param leashToken The token of the embedded hierarchy.
* @param accessibilityNodeId A unique view id or virtual descendant id from
* where to start the search. Use
* {@link android.view.accessibility.AccessibilityNodeInfo#ROOT_NODE_ID}
* to start from the root.
* @param bypassCache Whether to bypass the cache while looking for the node.
* @param prefetchFlags flags to guide prefetching.
* @param arguments Optional action arguments.
* @return An {@link AccessibilityNodeInfo} if found, null otherwise.
*/
public @Nullable AccessibilityNodeInfo findAccessibilityNodeInfoByAccessibilityId(
int connectionId, @NonNull IBinder leashToken, long accessibilityNodeId,
boolean bypassCache, int prefetchFlags, Bundle arguments) {
if (leashToken == null) {
return null;
}
int windowId = -1;
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
windowId = connection.getWindowIdForLeashToken(leashToken);
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while calling remote getWindowIdForLeashToken", re);
}
if (windowId == -1) {
return null;
}
return findAccessibilityNodeInfoByAccessibilityId(connectionId, windowId,
accessibilityNodeId, bypassCache, prefetchFlags, arguments);
}
/**
* Finds an {@link AccessibilityNodeInfo} by accessibility id.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link android.view.accessibility.AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window.
* @param accessibilityNodeId A unique view id or virtual descendant id from
* where to start the search. Use
* {@link android.view.accessibility.AccessibilityNodeInfo#ROOT_NODE_ID}
* to start from the root.
* @param bypassCache Whether to bypass the cache while looking for the node.
* @param prefetchFlags flags to guide prefetching.
* @return An {@link AccessibilityNodeInfo} if found, null otherwise.
*/
public @Nullable AccessibilityNodeInfo findAccessibilityNodeInfoByAccessibilityId(
int connectionId, int accessibilityWindowId, long accessibilityNodeId,
boolean bypassCache, int prefetchFlags, Bundle arguments) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
if (!bypassCache) {
AccessibilityCache cache = getCache(connectionId);
if (cache != null) {
AccessibilityNodeInfo cachedInfo = cache.getNode(
accessibilityWindowId, accessibilityNodeId);
if (cachedInfo != null) {
if (DEBUG) {
Log.i(LOG_TAG, "Node cache hit for "
+ idToString(accessibilityWindowId, accessibilityNodeId));
}
if (shouldTraceClient()) {
logTraceClient(connection,
"findAccessibilityNodeInfoByAccessibilityId cache",
"connectionId=" + connectionId + ";accessibilityWindowId="
+ accessibilityWindowId + ";accessibilityNodeId="
+ accessibilityNodeId + ";bypassCache="
+ bypassCache + ";prefetchFlags=" + prefetchFlags
+ ";arguments=" + arguments);
}
return cachedInfo;
}
if (!cache.isEnabled()) {
// Skip prefetching if cache is disabled.
prefetchFlags &= ~FLAG_PREFETCH_MASK;
}
if (DEBUG) {
Log.i(LOG_TAG, "Node cache miss for "
+ idToString(accessibilityWindowId, accessibilityNodeId));
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "Cache is null for connection id: " + connectionId);
}
}
} else {
// No need to prefech nodes in bypass cache case.
prefetchFlags &= ~FLAG_PREFETCH_MASK;
}
// Skip prefetching if window is scrolling.
if ((prefetchFlags & FLAG_PREFETCH_MASK) != 0
&& isWindowScrolling(accessibilityWindowId)) {
prefetchFlags &= ~FLAG_PREFETCH_MASK;
}
final int descendantPrefetchFlags = prefetchFlags & FLAG_PREFETCH_DESCENDANTS_MASK;
if ((descendantPrefetchFlags & (descendantPrefetchFlags - 1)) != 0) {
throw new IllegalArgumentException("There can be no more than one descendant"
+ " prefetching strategy");
}
final int interactionId = mInteractionIdCounter.getAndIncrement();
if (shouldTraceClient()) {
logTraceClient(connection, "findAccessibilityNodeInfoByAccessibilityId",
"InteractionId:" + interactionId + "connectionId=" + connectionId
+ ";accessibilityWindowId=" + accessibilityWindowId
+ ";accessibilityNodeId=" + accessibilityNodeId + ";bypassCache="
+ bypassCache + ";prefetchFlags=" + prefetchFlags + ";arguments="
+ arguments);
}
final String[] packageNames;
final long identityToken = Binder.clearCallingIdentity();
try {
packageNames = connection.findAccessibilityNodeInfoByAccessibilityId(
accessibilityWindowId, accessibilityNodeId, interactionId, this,
prefetchFlags, Thread.currentThread().getId(), arguments);
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (packageNames != null) {
if ((prefetchFlags
& AccessibilityNodeInfo.FLAG_PREFETCH_UNINTERRUPTIBLE) != 0) {
List<AccessibilityNodeInfo> infos =
getFindAccessibilityNodeInfosResultAndClear(
interactionId);
if (shouldTraceCallback()) {
logTraceCallback(connection,
"findAccessibilityNodeInfoByAccessibilityId",
"InteractionId:" + interactionId + ";connectionId="
+ connectionId + ";Result: " + infos);
}
finalizeAndCacheAccessibilityNodeInfos(infos, connectionId,
bypassCache, packageNames);
if (infos != null && !infos.isEmpty()) {
return infos.get(0);
}
} else {
AccessibilityNodeInfo info =
getFindAccessibilityNodeInfoResultAndClear(interactionId);
if (shouldTraceCallback()) {
logTraceCallback(connection,
"findAccessibilityNodeInfoByAccessibilityId",
"InteractionId:" + interactionId + ";connectionId="
+ connectionId + ";Result: " + info);
}
if ((prefetchFlags & FLAG_PREFETCH_MASK) != 0
&& info != null) {
setInteractionWaitingForPrefetchResult(interactionId, connectionId,
packageNames);
}
finalizeAndCacheAccessibilityNodeInfo(info, connectionId,
bypassCache, packageNames);
return info;
}
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while calling remote"
+ " findAccessibilityNodeInfoByAccessibilityId", re);
}
return null;
}
private void setInteractionWaitingForPrefetchResult(int interactionId, int connectionId,
String[] packageNames) {
synchronized (mInstanceLock) {
mInteractionIdWaitingForPrefetchResult = interactionId;
mConnectionIdWaitingForPrefetchResult = connectionId;
mPackageNamesForNextPrefetchResult = packageNames;
}
}
private static String idToString(int accessibilityWindowId, long accessibilityNodeId) {
return accessibilityWindowId + "/"
+ AccessibilityNodeInfo.idToString(accessibilityNodeId);
}
/**
* Finds an {@link AccessibilityNodeInfo} by View id. The search is performed in
* the window whose id is specified and starts from the node whose accessibility
* id is specified.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link android.view.accessibility.AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window.
* @param accessibilityNodeId A unique view id or virtual descendant id from
* where to start the search. Use
* {@link android.view.accessibility.AccessibilityNodeInfo#ROOT_NODE_ID}
* to start from the root.
* @param viewId The fully qualified resource name of the view id to find.
* @return An list of {@link AccessibilityNodeInfo} if found, empty list otherwise.
*/
public List<AccessibilityNodeInfo> findAccessibilityNodeInfosByViewId(int connectionId,
int accessibilityWindowId, long accessibilityNodeId, String viewId) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
final int interactionId = mInteractionIdCounter.getAndIncrement();
final String[] packageNames;
final long identityToken = Binder.clearCallingIdentity();
try {
if (shouldTraceClient()) {
logTraceClient(connection, "findAccessibilityNodeInfosByViewId",
"InteractionId=" + interactionId + ";connectionId=" + connectionId
+ ";accessibilityWindowId=" + accessibilityWindowId
+ ";accessibilityNodeId=" + accessibilityNodeId + ";viewId="
+ viewId);
}
packageNames = connection.findAccessibilityNodeInfosByViewId(
accessibilityWindowId, accessibilityNodeId, viewId, interactionId, this,
Thread.currentThread().getId());
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (packageNames != null) {
List<AccessibilityNodeInfo> infos = getFindAccessibilityNodeInfosResultAndClear(
interactionId);
if (shouldTraceCallback()) {
logTraceCallback(connection, "findAccessibilityNodeInfosByViewId",
"InteractionId=" + interactionId + ";connectionId=" + connectionId
+ ":Result: " + infos);
}
if (infos != null) {
finalizeAndCacheAccessibilityNodeInfos(infos, connectionId,
false, packageNames);
return infos;
}
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.w(LOG_TAG, "Error while calling remote"
+ " findAccessibilityNodeInfoByViewIdInActiveWindow", re);
}
return Collections.emptyList();
}
/**
* Finds {@link AccessibilityNodeInfo}s by View text. The match is case
* insensitive containment. The search is performed in the window whose
* id is specified and starts from the node whose accessibility id is
* specified.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link android.view.accessibility.AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window.
* @param accessibilityNodeId A unique view id or virtual descendant id from
* where to start the search. Use
* {@link android.view.accessibility.AccessibilityNodeInfo#ROOT_NODE_ID}
* to start from the root.
* @param text The searched text.
* @return A list of found {@link AccessibilityNodeInfo}s.
*/
public List<AccessibilityNodeInfo> findAccessibilityNodeInfosByText(int connectionId,
int accessibilityWindowId, long accessibilityNodeId, String text) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
final int interactionId = mInteractionIdCounter.getAndIncrement();
if (shouldTraceClient()) {
logTraceClient(connection, "findAccessibilityNodeInfosByText",
"InteractionId:" + interactionId + "connectionId=" + connectionId
+ ";accessibilityWindowId=" + accessibilityWindowId
+ ";accessibilityNodeId=" + accessibilityNodeId + ";text=" + text);
}
final String[] packageNames;
final long identityToken = Binder.clearCallingIdentity();
try {
packageNames = connection.findAccessibilityNodeInfosByText(
accessibilityWindowId, accessibilityNodeId, text, interactionId, this,
Thread.currentThread().getId());
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (packageNames != null) {
List<AccessibilityNodeInfo> infos = getFindAccessibilityNodeInfosResultAndClear(
interactionId);
if (shouldTraceCallback()) {
logTraceCallback(connection, "findAccessibilityNodeInfosByText",
"InteractionId=" + interactionId + ";connectionId=" + connectionId
+ ";Result: " + infos);
}
if (infos != null) {
finalizeAndCacheAccessibilityNodeInfos(infos, connectionId,
false, packageNames);
return infos;
}
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.w(LOG_TAG, "Error while calling remote"
+ " findAccessibilityNodeInfosByViewText", re);
}
return Collections.emptyList();
}
/**
* Finds the {@link AccessibilityNodeInfo} that has the
* specified focus type. The search is performed in the window whose id is specified
* and starts from the node whose accessibility id is specified.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window. Use
* {@link AccessibilityWindowInfo#ANY_WINDOW_ID} to query all
* windows
* @param accessibilityNodeId A unique view id or virtual descendant id from
* where to start the search. Use
* {@link AccessibilityNodeInfo#ROOT_NODE_ID}
* to start from the root.
* @param focusType The focus type.
* @return The accessibility focused {@link AccessibilityNodeInfo}.
*/
@SuppressLint("LongLogTag")
public AccessibilityNodeInfo findFocus(int connectionId, int accessibilityWindowId,
long accessibilityNodeId, int focusType) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
AccessibilityCache cache = getCache(connectionId);
if (cache != null) {
AccessibilityNodeInfo cachedInfo = cache.getFocus(focusType,
accessibilityNodeId, accessibilityWindowId);
if (cachedInfo != null) {
if (DEBUG) {
Log.i(LOG_TAG, "Focused node cache hit retrieved"
+ idToString(cachedInfo.getWindowId(),
cachedInfo.getSourceNodeId()));
}
return cachedInfo;
}
if (DEBUG) {
Log.i(LOG_TAG, "Focused node cache miss with "
+ idToString(accessibilityWindowId, accessibilityNodeId));
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "Cache is null for connection id: " + connectionId);
}
}
final int interactionId = mInteractionIdCounter.getAndIncrement();
if (shouldTraceClient()) {
logTraceClient(connection, "findFocus",
"InteractionId:" + interactionId + "connectionId=" + connectionId
+ ";accessibilityWindowId=" + accessibilityWindowId
+ ";accessibilityNodeId=" + accessibilityNodeId + ";focusType="
+ focusType);
}
final String[] packageNames;
final long identityToken = Binder.clearCallingIdentity();
try {
packageNames = connection.findFocus(accessibilityWindowId,
accessibilityNodeId, focusType, interactionId, this,
Thread.currentThread().getId());
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (packageNames != null) {
AccessibilityNodeInfo info = getFindAccessibilityNodeInfoResultAndClear(
interactionId);
if (shouldTraceCallback()) {
logTraceCallback(connection, "findFocus", "InteractionId=" + interactionId
+ ";connectionId=" + connectionId + ";Result:" + info);
}
finalizeAndCacheAccessibilityNodeInfo(info, connectionId, false, packageNames);
return info;
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.w(LOG_TAG, "Error while calling remote findFocus", re);
}
return null;
}
/**
* Finds the accessibility focused {@link android.view.accessibility.AccessibilityNodeInfo}.
* The search is performed in the window whose id is specified and starts from the
* node whose accessibility id is specified.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link android.view.accessibility.AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window.
* @param accessibilityNodeId A unique view id or virtual descendant id from
* where to start the search. Use
* {@link android.view.accessibility.AccessibilityNodeInfo#ROOT_NODE_ID}
* to start from the root.
* @param direction The direction in which to search for focusable.
* @return The accessibility focused {@link AccessibilityNodeInfo}.
*/
public AccessibilityNodeInfo focusSearch(int connectionId, int accessibilityWindowId,
long accessibilityNodeId, int direction) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
final int interactionId = mInteractionIdCounter.getAndIncrement();
if (shouldTraceClient()) {
logTraceClient(connection, "focusSearch",
"InteractionId:" + interactionId + "connectionId=" + connectionId
+ ";accessibilityWindowId=" + accessibilityWindowId
+ ";accessibilityNodeId=" + accessibilityNodeId + ";direction="
+ direction);
}
final String[] packageNames;
final long identityToken = Binder.clearCallingIdentity();
try {
packageNames = connection.focusSearch(accessibilityWindowId,
accessibilityNodeId, direction, interactionId, this,
Thread.currentThread().getId());
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (packageNames != null) {
AccessibilityNodeInfo info = getFindAccessibilityNodeInfoResultAndClear(
interactionId);
finalizeAndCacheAccessibilityNodeInfo(info, connectionId, false, packageNames);
if (shouldTraceCallback()) {
logTraceCallback(connection, "focusSearch", "InteractionId=" + interactionId
+ ";connectionId=" + connectionId + ";Result:" + info);
}
return info;
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.w(LOG_TAG, "Error while calling remote accessibilityFocusSearch", re);
}
return null;
}
/**
* Performs an accessibility action on an {@link AccessibilityNodeInfo}.
*
* @param connectionId The id of a connection for interacting with the system.
* @param accessibilityWindowId A unique window id. Use
* {@link android.view.accessibility.AccessibilityWindowInfo#ACTIVE_WINDOW_ID}
* to query the currently active window.
* @param accessibilityNodeId A unique view id or virtual descendant id from
* where to start the search. Use
* {@link android.view.accessibility.AccessibilityNodeInfo#ROOT_NODE_ID}
* to start from the root.
* @param action The action to perform.
* @param arguments Optional action arguments.
* @return Whether the action was performed.
*/
public boolean performAccessibilityAction(int connectionId, int accessibilityWindowId,
long accessibilityNodeId, int action, Bundle arguments) {
try {
IAccessibilityServiceConnection connection = getConnection(connectionId);
if (connection != null) {
final int interactionId = mInteractionIdCounter.getAndIncrement();
if (shouldTraceClient()) {
logTraceClient(connection, "performAccessibilityAction",
"InteractionId:" + interactionId + "connectionId=" + connectionId
+ ";accessibilityWindowId=" + accessibilityWindowId
+ ";accessibilityNodeId=" + accessibilityNodeId + ";action=" + action
+ ";arguments=" + arguments);
}
final boolean success;
final long identityToken = Binder.clearCallingIdentity();
try {
success = connection.performAccessibilityAction(
accessibilityWindowId, accessibilityNodeId, action, arguments,
interactionId, this, Thread.currentThread().getId());
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (success) {
final boolean result =
getPerformAccessibilityActionResultAndClear(interactionId);
if (shouldTraceCallback()) {
logTraceCallback(connection, "performAccessibilityAction",
"InteractionId=" + interactionId + ";connectionId=" + connectionId
+ ";Result: " + result);
}
return result;
}
} else {
if (DEBUG) {
Log.w(LOG_TAG, "No connection for connection id: " + connectionId);
}
}
} catch (RemoteException re) {
Log.w(LOG_TAG, "Error while calling remote performAccessibilityAction", re);
}
return false;
}
/**
* Clears the cache associated with {@code connectionId}
* @param connectionId the connection id
*/
@UnsupportedAppUsage(maxTargetSdk = S, publicAlternatives =
"{@link android.accessibilityservice.AccessibilityService#clearCache()}")
public void clearCache(int connectionId) {
AccessibilityCache cache = getCache(connectionId);
if (cache == null) {
return;
}
cache.clear();
}
/**
* Informs the cache associated with {@code connectionId} of {@code event}
* @param event the event
* @param connectionId the connection id
*/
public void onAccessibilityEvent(AccessibilityEvent event, int connectionId) {
switch (event.getEventType()) {
case AccessibilityEvent.TYPE_VIEW_SCROLLED:
updateScrollingWindow(event.getWindowId(), SystemClock.uptimeMillis());
break;
case AccessibilityEvent.TYPE_WINDOWS_CHANGED:
if (event.getWindowChanges() == AccessibilityEvent.WINDOWS_CHANGE_REMOVED) {
deleteScrollingWindow(event.getWindowId());
}
break;
default:
break;
}
AccessibilityCache cache = getCache(connectionId);
if (cache == null) {
if (DEBUG) {
Log.w(LOG_TAG, "Cache is null for connection id: " + connectionId);
}
return;
}
cache.onAccessibilityEvent(event);
}
/**
* Gets the the result of an async request that returns an {@link AccessibilityNodeInfo}.
*
* @param interactionId The interaction id to match the result with the request.
* @return The result {@link AccessibilityNodeInfo}.
*/
private AccessibilityNodeInfo getFindAccessibilityNodeInfoResultAndClear(int interactionId) {
synchronized (mInstanceLock) {
final boolean success = waitForResultTimedLocked(interactionId);
AccessibilityNodeInfo result = success ? mFindAccessibilityNodeInfoResult : null;
clearResultLocked();
return result;
}
}
/**
* {@inheritDoc}
*/
public void setFindAccessibilityNodeInfoResult(AccessibilityNodeInfo info,
int interactionId) {
synchronized (mInstanceLock) {
if (interactionId > mInteractionId) {
mFindAccessibilityNodeInfoResult = info;
mInteractionId = interactionId;
mCallingUid = Binder.getCallingUid();
mCallStackOfCallback = new ArrayList<StackTraceElement>(
Arrays.asList(Thread.currentThread().getStackTrace()));
}
mInstanceLock.notifyAll();
}
}
/**
* Gets the the result of an async request that returns {@link AccessibilityNodeInfo}s.
*
* @param interactionId The interaction id to match the result with the request.
* @return The result {@link AccessibilityNodeInfo}s.
*/
private List<AccessibilityNodeInfo> getFindAccessibilityNodeInfosResultAndClear(
int interactionId) {
synchronized (mInstanceLock) {
final boolean success = waitForResultTimedLocked(interactionId);
final List<AccessibilityNodeInfo> result;
if (success) {
result = mFindAccessibilityNodeInfosResult;
} else {
result = Collections.emptyList();
}
clearResultLocked();
if (Build.IS_DEBUGGABLE && CHECK_INTEGRITY) {
checkFindAccessibilityNodeInfoResultIntegrity(result);
}
return result;
}
}
/**
* {@inheritDoc}
*/
public void setFindAccessibilityNodeInfosResult(List<AccessibilityNodeInfo> infos,
int interactionId) {
synchronized (mInstanceLock) {
if (interactionId > mInteractionId) {
if (infos != null) {
// If the call is not an IPC, i.e. it is made from the same process, we need to
// instantiate new result list to avoid passing internal instances to clients.
final boolean isIpcCall = (Binder.getCallingPid() != Process.myPid());
if (!isIpcCall) {
mFindAccessibilityNodeInfosResult = new ArrayList<>(infos);
} else {
mFindAccessibilityNodeInfosResult = infos;
}
} else {
mFindAccessibilityNodeInfosResult = Collections.emptyList();
}
mInteractionId = interactionId;
mCallingUid = Binder.getCallingUid();
mCallStackOfCallback = new ArrayList<StackTraceElement>(
Arrays.asList(Thread.currentThread().getStackTrace()));
}
mInstanceLock.notifyAll();
}
}
/**
* {@inheritDoc}
*/
@Override
public void setPrefetchAccessibilityNodeInfoResult(@NonNull List<AccessibilityNodeInfo> infos,
int interactionId) {
int interactionIdWaitingForPrefetchResultCopy = -1;
int connectionIdWaitingForPrefetchResultCopy = -1;
String[] packageNamesForNextPrefetchResultCopy = null;
if (infos.isEmpty()) {
return;
}
synchronized (mInstanceLock) {
if (mInteractionIdWaitingForPrefetchResult == interactionId) {
interactionIdWaitingForPrefetchResultCopy = mInteractionIdWaitingForPrefetchResult;
connectionIdWaitingForPrefetchResultCopy =
mConnectionIdWaitingForPrefetchResult;
if (mPackageNamesForNextPrefetchResult != null) {
packageNamesForNextPrefetchResultCopy =
new String[mPackageNamesForNextPrefetchResult.length];
for (int i = 0; i < mPackageNamesForNextPrefetchResult.length; i++) {
packageNamesForNextPrefetchResultCopy[i] =
mPackageNamesForNextPrefetchResult[i];
}
}
}
}
if (interactionIdWaitingForPrefetchResultCopy == interactionId) {
finalizeAndCacheAccessibilityNodeInfos(
infos, connectionIdWaitingForPrefetchResultCopy, false,
packageNamesForNextPrefetchResultCopy);
if (shouldTraceCallback()) {
logTrace(getConnection(connectionIdWaitingForPrefetchResultCopy),
"setPrefetchAccessibilityNodeInfoResult",
"InteractionId:" + interactionId + ";connectionId="
+ connectionIdWaitingForPrefetchResultCopy + ";Result: " + infos,
Binder.getCallingUid(),
Arrays.asList(Thread.currentThread().getStackTrace()),
new HashSet<>(Collections.singletonList("getStackTrace")),
FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK);
}
} else if (DEBUG) {
Log.w(LOG_TAG, "Prefetching for interaction with id " + interactionId + " dropped "
+ infos.size() + " nodes");
}
}
/**
* Gets the result of a request to perform an accessibility action.
*
* @param interactionId The interaction id to match the result with the request.
* @return Whether the action was performed.
*/
private boolean getPerformAccessibilityActionResultAndClear(int interactionId) {
synchronized (mInstanceLock) {
final boolean success = waitForResultTimedLocked(interactionId);
final boolean result = success ? mPerformAccessibilityActionResult : false;
clearResultLocked();
return result;
}
}
/**
* {@inheritDoc}
*/
public void setPerformAccessibilityActionResult(boolean succeeded, int interactionId) {
synchronized (mInstanceLock) {
if (interactionId > mInteractionId) {
mPerformAccessibilityActionResult = succeeded;
mInteractionId = interactionId;
mCallingUid = Binder.getCallingUid();
mCallStackOfCallback = new ArrayList<StackTraceElement>(
Arrays.asList(Thread.currentThread().getStackTrace()));
}
mInstanceLock.notifyAll();
}
}
/**
* Clears the result state.
*/
private void clearResultLocked() {
mInteractionId = -1;
mFindAccessibilityNodeInfoResult = null;
mFindAccessibilityNodeInfosResult = null;
mPerformAccessibilityActionResult = false;
}
/**
* Waits up to a given bound for a result of a request and returns it.
*
* @param interactionId The interaction id to match the result with the request.
* @return Whether the result was received.
*/
private boolean waitForResultTimedLocked(int interactionId) {
long waitTimeMillis = TIMEOUT_INTERACTION_MILLIS;
final long startTimeMillis = SystemClock.uptimeMillis();
while (true) {
try {
Message sameProcessMessage = getSameProcessMessageAndClear();
if (sameProcessMessage != null) {
sameProcessMessage.getTarget().handleMessage(sameProcessMessage);
}
if (mInteractionId == interactionId) {
return true;
}
if (mInteractionId > interactionId) {
return false;
}
final long elapsedTimeMillis = SystemClock.uptimeMillis() - startTimeMillis;
waitTimeMillis = TIMEOUT_INTERACTION_MILLIS - elapsedTimeMillis;
if (waitTimeMillis <= 0) {
return false;
}
mInstanceLock.wait(waitTimeMillis);
} catch (InterruptedException ie) {
/* ignore */
}
}
}
/**
* Finalize an {@link AccessibilityNodeInfo} before passing it to the client.
*
* @param info The info.
* @param connectionId The id of the connection to the system.
* @param bypassCache Whether or not to bypass the cache. The node is added to the cache if
* this value is {@code false}
* @param packageNames The valid package names a node can come from.
*/
private void finalizeAndCacheAccessibilityNodeInfo(AccessibilityNodeInfo info,
int connectionId, boolean bypassCache, String[] packageNames) {
if (info != null) {
info.setConnectionId(connectionId);
// Empty array means any package name is Okay
if (!ArrayUtils.isEmpty(packageNames)) {
CharSequence packageName = info.getPackageName();
if (packageName == null
|| !ArrayUtils.contains(packageNames, packageName.toString())) {
// If the node package not one of the valid ones, pick the top one - this
// is one of the packages running in the introspected UID.
info.setPackageName(packageNames[0]);
}
}
info.setSealed(true);
if (!bypassCache) {
AccessibilityCache cache = getCache(connectionId);
if (cache == null) {
if (DEBUG) {
Log.w(LOG_TAG, "Cache is null for connection id: " + connectionId);
}
return;
}
cache.add(info);
}
}
}
/**
* Finalize {@link AccessibilityNodeInfo}s before passing them to the client.
*
* @param infos The {@link AccessibilityNodeInfo}s.
* @param connectionId The id of the connection to the system.
* @param bypassCache Whether or not to bypass the cache. The nodes are added to the cache if
* this value is {@code false}
* @param packageNames The valid package names a node can come from.
*/
private void finalizeAndCacheAccessibilityNodeInfos(List<AccessibilityNodeInfo> infos,
int connectionId, boolean bypassCache, String[] packageNames) {
if (infos != null) {
final int infosCount = infos.size();
for (int i = 0; i < infosCount; i++) {
AccessibilityNodeInfo info = infos.get(i);
finalizeAndCacheAccessibilityNodeInfo(info, connectionId,
bypassCache, packageNames);
}
}
}
/**
* Gets the message stored if the interacted and interacting
* threads are the same.
*
* @return The message.
*/
private Message getSameProcessMessageAndClear() {
synchronized (mInstanceLock) {
Message result = mSameThreadMessage;
mSameThreadMessage = null;
return result;
}
}
/**
* Checks whether the infos are a fully connected tree with no duplicates.
*
* @param infos The result list to check.
*/
private void checkFindAccessibilityNodeInfoResultIntegrity(List<AccessibilityNodeInfo> infos) {
if (infos.size() == 0) {
return;
}
// Find the root node.
AccessibilityNodeInfo root = infos.get(0);
final int infoCount = infos.size();
for (int i = 1; i < infoCount; i++) {
for (int j = i; j < infoCount; j++) {
AccessibilityNodeInfo candidate = infos.get(j);
if (root.getParentNodeId() == candidate.getSourceNodeId()) {
root = candidate;
break;
}
}
}
if (root == null) {
Log.e(LOG_TAG, "No root.");
}
// Check for duplicates.
HashSet<AccessibilityNodeInfo> seen = new HashSet<>();
Queue<AccessibilityNodeInfo> fringe = new ArrayDeque<>();
fringe.add(root);
while (!fringe.isEmpty()) {
AccessibilityNodeInfo current = fringe.poll();
if (!seen.add(current)) {
Log.e(LOG_TAG, "Duplicate node.");
return;
}
final int childCount = current.getChildCount();
for (int i = 0; i < childCount; i++) {
final long childId = current.getChildId(i);
for (int j = 0; j < infoCount; j++) {
AccessibilityNodeInfo child = infos.get(j);
if (child.getSourceNodeId() == childId) {
fringe.add(child);
}
}
}
}
final int disconnectedCount = infos.size() - seen.size();
if (disconnectedCount > 0) {
Log.e(LOG_TAG, disconnectedCount + " Disconnected nodes.");
}
}
/**
* Update scroll event timestamp of a given window.
*
* @param windowId The window id.
* @param uptimeMillis Device uptime millis.
*/
private void updateScrollingWindow(int windowId, long uptimeMillis) {
synchronized (sScrollingWindows) {
sScrollingWindows.put(windowId, uptimeMillis);
}
}
/**
* Remove a window from the scrolling windows list.
*
* @param windowId The window id.
*/
private void deleteScrollingWindow(int windowId) {
synchronized (sScrollingWindows) {
sScrollingWindows.delete(windowId);
}
}
/**
* Whether or not the window is scrolling.
*
* @param windowId
* @return true if it's scrolling.
*/
private boolean isWindowScrolling(int windowId) {
synchronized (sScrollingWindows) {
final long latestScrollingTime = sScrollingWindows.get(windowId);
if (latestScrollingTime == 0) {
return false;
}
final long currentUptime = SystemClock.uptimeMillis();
if (currentUptime > (latestScrollingTime + DISABLE_PREFETCHING_FOR_SCROLLING_MILLIS)) {
sScrollingWindows.delete(windowId);
return false;
}
}
return true;
}
private boolean shouldTraceClient() {
return (mAccessibilityManager != null)
&& mAccessibilityManager.isA11yInteractionClientTraceEnabled();
}
private boolean shouldTraceCallback() {
return (mAccessibilityManager != null)
&& mAccessibilityManager.isA11yInteractionConnectionCBTraceEnabled();
}
private void logTrace(
IAccessibilityServiceConnection connection, String method, String params,
int callingUid, List<StackTraceElement> callStack, HashSet<String> ignoreSet,
long logTypes) {
try {
Bundle b = new Bundle();
b.putSerializable(CALL_STACK, new ArrayList<StackTraceElement>(callStack));
if (ignoreSet != null) {
b.putSerializable(IGNORE_CALL_STACK, ignoreSet);
}
connection.logTrace(SystemClock.elapsedRealtimeNanos(),
LOG_TAG + "." + method,
logTypes, params, Process.myPid(), Thread.currentThread().getId(),
callingUid, b);
} catch (RemoteException e) {
Log.e(LOG_TAG, "Failed to log trace. " + e);
}
}
private void logTraceCallback(
IAccessibilityServiceConnection connection, String method, String params) {
logTrace(connection, method + " callback", params, mCallingUid, mCallStackOfCallback,
new HashSet<String>(Arrays.asList("getStackTrace")),
FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK);
}
private void logTraceClient(
IAccessibilityServiceConnection connection, String method, String params) {
logTrace(connection, method, params, Binder.getCallingUid(),
Arrays.asList(Thread.currentThread().getStackTrace()),
new HashSet<String>(Arrays.asList("getStackTrace", "logTraceClient")),
FLAGS_ACCESSIBILITY_INTERACTION_CLIENT);
}
}
|