/* * Copyright (C) 2013 DroidDriver committers * * 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 io.appium.uiautomator2.model; import android.os.SystemClock; import android.view.accessibility.AccessibilityNodeInfo; import org.w3c.dom.DOMException; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import java.util.HashMap; import java.util.Map; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import javax.xml.xpath.XPath; import javax.xml.xpath.XPathConstants; import javax.xml.xpath.XPathExpression; import javax.xml.xpath.XPathExpressionException; import javax.xml.xpath.XPathFactory; import io.appium.uiautomator2.common.exceptions.ElementNotFoundException; import io.appium.uiautomator2.common.exceptions.InvalidSelectorException; import io.appium.uiautomator2.common.exceptions.UiAutomator2Exception; import io.appium.uiautomator2.core.UiAutomatorBridge; import io.appium.uiautomator2.utils.Attribute; import io.appium.uiautomator2.utils.Device; import io.appium.uiautomator2.utils.Logger; import io.appium.uiautomator2.utils.NodeInfoList; import io.appium.uiautomator2.utils.Preconditions; /** * Find matching UiElement by XPath. */ public class XPathFinder implements Finder { private static final XPath XPATH_COMPILER = XPathFactory.newInstance().newXPath(); // document needs to be static so that when buildDomNode is called recursively // on children they are in the same document to be appended. private static Document document; // The two maps should be kept in sync private static final Map, Element> TO_DOM_MAP = new HashMap, Element>(); private static final Map> FROM_DOM_MAP = new HashMap>(); public static void clearData() { TO_DOM_MAP.clear(); FROM_DOM_MAP.clear(); document = null; } private final String xPathString; private final XPathExpression xPathExpression; private static UiAutomationElement rootElement; @Override public String toString() { return xPathString; } public XPathFinder(String xPathString) { this.xPathString = Preconditions.checkNotNull(xPathString); try { xPathExpression = XPATH_COMPILER.compile(xPathString); } catch (XPathExpressionException e) { throw new UiAutomator2Exception("xPathString=" + xPathString, e); } } @Override public NodeInfoList find(UiElement context) { Element domNode = getDomNode((UiElement) context); try { getDocument().appendChild(domNode); NodeList nodes = (NodeList) xPathExpression.evaluate(domNode, XPathConstants.NODESET); NodeInfoList list = new NodeInfoList(); int nodesLength = nodes.getLength(); for (int i = 0; i < nodesLength; i++) { if (nodes.item(i).getNodeType() == Node.ELEMENT_NODE) { list.addToList(FROM_DOM_MAP.get(nodes.item(0)).node); } } return list; } catch (XPathExpressionException e) { throw new ElementNotFoundException( e); } finally { try { getDocument().removeChild(domNode); } catch (DOMException e) { Logger.error(e, "Failed to clear document"); document = null; // getDocument will create new } } } public static NodeInfoList getNodesList(String xpathExpression, AccessibilityNodeInfo nodeInfo) throws InvalidSelectorException, ParserConfigurationException, UiAutomator2Exception { if(nodeInfo == null) { XPathFinder.refreshUiElementTree(); } else { XPathFinder.refreshUiElementTree(nodeInfo); } XPathFinder finder = new XPathFinder(xpathExpression); return finder.find(finder.getRootElement()); } private static Document getDocument() { if (document == null) { try { document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument(); } catch (ParserConfigurationException e) { throw new UiAutomator2Exception(e); } } return document; } /** * Returns the DOM node representing this UiElement. */ private static Element getDomNode(UiElement uiElement) { Element domNode = TO_DOM_MAP.get(uiElement); if (domNode == null) { domNode = buildDomNode(uiElement); } return domNode; } private static Element buildDomNode(UiElement uiElement) { String className = uiElement.getClassName(); if (className == null) { className = "UNKNOWN"; } Element element = getDocument().createElement(tag(className)); TO_DOM_MAP.put(uiElement, element); FROM_DOM_MAP.put(element, uiElement); setAttribute(element, Attribute.CLASS, className); setAttribute(element, Attribute.RESOURCE_ID, uiElement.getResourceId()); setAttribute(element, Attribute.PACKAGE, uiElement.getPackageName()); setAttribute(element, Attribute.CONTENT_DESC, uiElement.getContentDescription()); setAttribute(element, Attribute.TEXT, uiElement.getText()); setAttribute(element, Attribute.CHECKABLE, uiElement.isCheckable()); setAttribute(element, Attribute.CHECKED, uiElement.isChecked()); setAttribute(element, Attribute.CLICKABLE, uiElement.isClickable()); setAttribute(element, Attribute.ENABLED, uiElement.isEnabled()); setAttribute(element, Attribute.FOCUSABLE, uiElement.isFocusable()); setAttribute(element, Attribute.FOCUSED, uiElement.isFocused()); setAttribute(element, Attribute.SCROLLABLE, uiElement.isScrollable()); setAttribute(element, Attribute.LONG_CLICKABLE, uiElement.isLongClickable()); setAttribute(element, Attribute.PASSWORD, uiElement.isPassword()); if (uiElement.hasSelection()) { element.setAttribute(Attribute.SELECTION_START.getName(), Integer.toString(uiElement.getSelectionStart())); element.setAttribute(Attribute.SELECTION_END.getName(), Integer.toString(uiElement.getSelectionEnd())); } setAttribute(element, Attribute.SELECTED, uiElement.isSelected()); element.setAttribute(Attribute.BOUNDS.getName(), uiElement.getBounds().toShortString()); for (UiElement child : uiElement.getChildren()) { element.appendChild(getDomNode(child)); } return element; } private static void setAttribute(Element element, Attribute attr, String value) { if (value != null) { element.setAttribute(attr.getName(), value); } } // add attribute only if it's true private static void setAttribute(Element element, Attribute attr, boolean value) { if (value) { element.setAttribute(attr.getName(), ""); } } public UiAutomationElement getRootElement() { if (rootElement == null) { refreshUiElementTree(); } return rootElement; } public static void refreshUiElementTree() { rootElement =UiAutomationElement.newRootElement(getRootAccessibilityNode()); } public static void refreshUiElementTree(AccessibilityNodeInfo nodeInfo) { rootElement =UiAutomationElement.newRootElement(nodeInfo); } public static AccessibilityNodeInfo getRootAccessibilityNode() throws UiAutomator2Exception { final long timeoutMillis = 10000; Device.getUiDevice().waitForIdle(timeoutMillis); long end = SystemClock.uptimeMillis() + timeoutMillis; while (true) { AccessibilityNodeInfo root = UiAutomatorBridge.getInstance().getQueryController().getAccessibilityRootNode(); if (root != null) { return root; } long remainingMillis = end - SystemClock.uptimeMillis(); if (remainingMillis < 0) { throw new UiAutomator2Exception( String.format("Timed out after %d milliseconds waiting for root AccessibilityNodeInfo", timeoutMillis)); } SystemClock.sleep(Math.min(250, remainingMillis)); } } /** * @return The tag name used to build UiElement DOM. It is preferable to use * this to build XPath instead of String literals. */ public static String tag(String className) { // the nth anonymous class has a class name ending in "Outer$n" // and local inner classes have names ending in "Outer.$1Inner" className = className.replaceAll("\\$[0-9]+", "\\$"); return className; } }