msaa.py

#!/usr/bin/env python
# coding:utf-8

import sys, os
sys.path.append(os.path.join(os.path.dirname(__file__), 'python.zip'))

if sys.version_info.major > 2:
    from past.builtins import unicode, basestring, long, xrange

import sys, os, re, time
import logging
import xml.dom.minidom, cgi
import ctypes, ctypes.wintypes
import comtypes, comtypes.automation, comtypes.client

comtypes.client.GetModule('oleacc.dll')

AccRoleNameMap = {
    1: u'TitleBar',
    2: u'MenuBar',
    3: u'ScrollBar',
    4: u'Grip',
    5: u'Sound',
    6: u'Cursor',
    7: u'Caret',
    8: u'Alert',
    9: u'Window',
    10: u'Client',
    11: u'PopupMenu',
    12: u'MenuItem',
    13: u'Tooltip',
    14: u'Application',
    15: u'Document',
    16: u'Pane',
    17: u'Chart',
    18: u'Dialog',
    19: u'Border',
    20: u'Grouping',
    21: u'Separator',
    22: u'ToolBar',
    23: u'StatusBar',
    24: u'Table',
    25: u'ColumnHeader',
    26: u'RowHeader',
    27: u'Column',
    28: u'Row',
    29: u'Cell',
    30: u'Link',
    31: u'HelpBalloon',
    32: u'Character',
    33: u'List',
    34: u'ListItem',
    35: u'Outline',
    36: u'OutlineItem',
    37: u'PageTab',
    38: u'PropertyPage',
    39: u'Indicator',
    40: u'Graphic',
    41: u'Text',
    42: u'EditableText',
    43: u'PushButton',
    44: u'CheckBox',
    45: u'RadioButton',
    46: u'ComboBox',
    47: u'DropDown',
    48: u'ProgressBar',
    49: u'Dial',
    50: u'HotKeyField',
    51: u'Slider',
    52: u'SpinBox',
    53: u'Diagram',
    54: u'Animation',
    55: u'Equation',
    56: u'DropDownButton',
    57: u'MenuButton',
    58: u'GridDropDownButton',
    59: u'WhiteSpace',
    60: u'PageTabList',
    61: u'Clock',
    62: u'SplitButton',
    63: u'IPAddress',
}

class Element(object):
    '''
    IAccessible Element
    http://msdn.microsoft.com/en-us/library/dd318466(v=VS.85).aspx
    '''
    def __init__(self, IAccessible, iObjectId):
        if not isinstance(IAccessible, comtypes.gen.Accessibility.IAccessible):
            raise TypeError(u'Element(IAccessible,iObjectId) first argument type must be IAccessible')
        if not isinstance(iObjectId, int):
            raise TypeError(u'Element(IAccessible,iObjectId) second argument type must be int')
        self.IAccessible = IAccessible
        self.iObjectId = iObjectId
        self.dictCache = {}

    def accChildCount(self):
        '''Get Child Element Count'''
        if self.iObjectId == 0:
            return self.IAccessible.accChildCount
        else:
            return 0

    def accRole(self):
        '''Get Element Role Name'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objRole = comtypes.automation.VARIANT()
        objRole.vt = comtypes.automation.VT_BSTR
        self.IAccessible._IAccessible__com__get_accRole(objChildId, objRole)
        return objRole.value

    def accName(self, objValue=None):
        '''Get Element Name'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        if objValue is None:
            objName = comtypes.automation.BSTR()
            self.IAccessible._IAccessible__com__get_accName(objChildId, ctypes.byref(objName))
            return objName.value
        else:
            self.IAccessible._IAccessible__com__set_accName(objChildId, objValue)

    def accLocation(self):
        '''Get Element Location, return (left, top, width, height)'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objL, objT, objW, objH = ctypes.c_long(), ctypes.c_long(), ctypes.c_long(), ctypes.c_long()
        self.IAccessible._IAccessible__com_accLocation(ctypes.byref(objL), ctypes.byref(objT), ctypes.byref(objW), ctypes.byref(objH), objChildId)
        return (objL.value, objT.value, objW.value, objH.value)

    def accValue(self, objValue=None):
        '''Get Element Value'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objBSTRValue = comtypes.automation.BSTR()
        if objValue is None:
            self.IAccessible._IAccessible__com__get_accValue(objChildId, ctypes.byref(objBSTRValue))
            return objBSTRValue.value
        else:
            objBSTRValue.value = objValue
            self.IAccessible._IAccessible__com__set_accValue(objChildId, objValue)
            return objBSTRValue.value

    def accDefaultAction(self):
        '''Get Element DefaultAction Name'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objDefaultAction = comtypes.automation.BSTR()
        self.IAccessible._IAccessible__com__get_accDefaultAction(objChildId, ctypes.byref(objDefaultAction))
        return objDefaultAction.value

    def accDescription(self):
        '''Get Element Description'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objDescription = comtypes.automation.BSTR()
        self.IAccessible._IAccessible__com__get_accDescription(objChildId, ctypes.byref(objDescription))
        return objDescription.value

    def accHelp(self):
        '''Get Element Help String'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objHelp = comtypes.automation.BSTR()
        self.IAccessible._IAccessible__com__get_accHelp(objChildId, ctypes.byref(objHelp))
        return objHelp.value

    def accHelpTopic(self):
        '''Get Element Help Topic Text'''
        return self.IAccessible.accHelpTopic()

    def accKeyboardShortcut(self):
        '''Get Element Keyboard Shortcut'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objKeyboardShortcut = comtypes.automation.BSTR()
        self.IAccessible._IAccessible__com__get_acccKeyboardShortcut(objhildId, ctypes.byref(objKeyboardShortcut))
        return objKeyboardShortcut.value

    def accParent(self):
        '''Get Element Parent'''
        objParent = self.IAccessible.accParent
        if objParent is not None:
            return Element(objParent, 0)

    def accSelection(self):
        '''Get Element Selection Status'''
        objChildren = comtypes.automation.VARIANT()
        self.IAccessible._IAccessible__com__get_accSelection(ctypes.byref(objChildren))
        return objChildren.value

    def accState(self):
        '''Get Element State'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        objState = comtypes.automation.VARIANT()
        self.IAccessible._IAccessible__com__get_accState(objChildId, ctypes.byref(objState))
        return objState.value

    def accNavigate(self):
        '''Need Implemented'''
        return self.IAccessible.accNavigate()

    def accDoDefaultAction(self):
        '''Trigger Element DefaultAction, such as click, double click'''
        objChildId = comtypes.automation.VARIANT()
        objChildId.vt = comtypes.automation.VT_I4
        objChildId.value = self.iObjectId
        self.IAccessible._IAccessible__com_accDoDefaultAction(objChildId)

    def accFocus(self):
        '''Foucs The Element'''
        if self.iObjectId:
            return self.IAccessible.accFocus(self.iObjectId)
        else:
            return self.IAccessible.accFocus()

    def accSelect(self, iSelection):
        '''Select The Element'''
        '''
SELFLAG_TAKEFOCUS       1
SELFLAG_TAKESELECTION   2
SELFLAG_TAKESELECTION   2
SELFLAG_EXTENDSELECTION 4
SELFLAG_ADDSELECTION    8
SELFLAG_REMOVESELECTION 16
'''
        if self.iObjectId:
            return self.IAccessible.accSelect(iSelection, self.iObjectId)
        else:
            return self.IAccessible.accSelect(iSelection)

    def accRoleName(self):
        '''Get The Role Name'''
        try:
            iRole = self.accRole()
            return AccRoleNameMap.get(iRole)
        except:
            return None

    def __iter__(self):
        '''Iterate all child Element'''
        if self.iObjectId > 0:
            return
        objAccChildArray = (comtypes.automation.VARIANT * self.IAccessible.accChildCount)()
        objAccChildCount = ctypes.c_long()
        ctypes.oledll.oleacc.AccessibleChildren(self.IAccessible, 0, self.IAccessible.accChildCount, objAccChildArray, ctypes.byref(objAccChildCount))
        for i in xrange(objAccChildCount.value):
            objAccChild = objAccChildArray[i]
            if objAccChild.vt == comtypes.automation.VT_DISPATCH:
                yield Element(objAccChild.value.QueryInterface(comtypes.gen.Accessibility.IAccessible), 0)
            else: #if objAccChild.vt == comtypes.automation.VT_I4:
                # yield Element(self.IAccessible, i+1)
                yield Element(self.IAccessible, objAccChild.value)

    def __str__(self):
        '''Format Element'''
        iRole = self.accRole()
        return '[%s(0x%X)|%r|ChildCount:%d]' % (AccRoleNameMap.get(iRole, 'Unkown'), iRole, self.accName(), self.IAccessible.accChildCount)

    def match(self, strRoleName, **kwargs):
        '''search match'''
        bMatched = True
        try:
            if strRoleName:
                iRole = self.accRole()
                if AccRoleNameMap.get(iRole) != strRoleName:
                    bMatched = False
            for strProperty in kwargs:
                try:
                    attr = getattr(self, 'acc'+strProperty)
                except AttributeError:
                    continue
                try:
                    value = attr()
                except:
                    value = None
                if type(kwargs[strProperty]) == type(lambda x:True):
                    bMatched = kwargs[strProperty](value)
                    if not bMatched:
                        break
                else:
                    if value != kwargs[strProperty]:
                        bMatched = False
                        break
        except Exception as ex:
            logging.exception('Error: Element.match %s', ex)
            bMatched = False
        return bMatched

    def __findcacheiter(self, strRoleName, **kwargs):
        '''Find Child Element in the cache'''
        for objElement in self.dictCache:
            if objElement.match(strRoleName, **kwargs):
                yield objElement

    def finditer(self, strRoleName, **kwargs):
        '''Find Child Element'''
        lstQueue = list(self)
        while lstQueue:
            objElement = lstQueue.pop(0)
            self.dictCache[objElement] = 1
            if objElement.match(strRoleName, **kwargs):
                yield objElement
            if objElement.IAccessible.accChildCount > 0:
                lstQueue[:0] = list(objElement)

    def find(self, strRoleName, **kwargs):
        '''Find First Child Element'''
        try:
            return next(self.__findcacheiter(strRoleName, **kwargs))
        except StopIteration:
            try:
                return next(self.finditer(strRoleName, **kwargs))
            except StopIteration:
                return None

    def findall(self, strRoleName, **kwargs):
        '''Find All Child Element'''
        return list(self.finditer(strRoleName, **kwargs))

    def toxml(self):
        '''Convert Element Tree to XML'''
        objDocument = xml.dom.minidom.Document()
        lstQueue = [(self, objDocument)]
        while lstQueue:
            objElement, objTree = lstQueue.pop(0)
            objRoleName = objElement.accRoleName()
            objName = objElement.accName()
            strRoleName = objRoleName or 'Unkown'
            strName = cgi.escape(unicode(objName)) if objName else ''
            strLocation = ','.join(str(x) for x in objElement.accLocation())
            objSubTree = xml.dom.minidom.Element(strRoleName)
            objSubTree.ownerDocument = objDocument
            try:
                objSubTree.attributes['Name'] = strName
            except:
                objSubTree.attributes['Name'] = strName.encode('unicode-escape')
            objSubTree.attributes['Location'] = strLocation
            objTree.appendChild(objSubTree)
            if objElement.IAccessible.accChildCount > 0:
                for objElementChild in objElement:
                    lstQueue.append((objElementChild, objSubTree))
        return objDocument.toprettyxml()


def point(x, y):
    objPoint = ctypes.wintypes.POINT()
    objPoint.x = x
    objPoint.y = y
    IAccessible = ctypes.POINTER(comtypes.gen.Accessibility.IAccessible)()
    objChildId = comtypes.automation.VARIANT()
    ctypes.oledll.oleacc.AccessibleObjectFromPoint(objPoint, ctypes.byref(IAccessible), ctypes.byref(objChildId))
    return Element(IAccessible, objChildId.value or 0)

def window(objHandle):
    if objHandle in (0, None):
        objElement = window(ctypes.windll.user32.GetDesktopWindow())
    elif isinstance(objHandle, basestring):
        objHandle = unicode(objHandle)
        iHwnd = ctypes.windll.user32.FindWindowW(objHandle, None) or ctypes.windll.user32.FindWindowW(None, objHandle)
        assert iHwnd > 0, u'Cannot FindWindow %r' % objHandle
        objElement = window(iHwnd)
    elif isinstance(objHandle, (int, long)):
        iHwnd = objHandle
        IAccessible = ctypes.POINTER(comtypes.gen.Accessibility.IAccessible)()
        ctypes.oledll.oleacc.AccessibleObjectFromWindow(iHwnd, 0, ctypes.byref(comtypes.gen.Accessibility.IAccessible._iid_), ctypes.byref(IAccessible))
        objElement = Element(IAccessible, 0)
    else:
        raise TypeError(u'window argument objHandle must be a int/str/unicode/AccObject, not %r' % objHandle)
    return objElement