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
|
"""Classes to manage ADB connections.
* :py:class:`ADBPythonAsync` utilizes a Python implementation of the ADB protocol.
* :py:class:`ADBServerAsync` utilizes an ADB server to communicate with the device.
"""
import asyncio
from contextlib import asynccontextmanager
import logging
from adb_shell.adb_device import AdbDeviceUsb
from adb_shell.adb_device_async import AdbDeviceTcpAsync
from adb_shell.auth.sign_pythonrsa import PythonRSASigner
from adb_shell.constants import DEFAULT_PUSH_MODE, DEFAULT_READ_TIMEOUT_S
import aiofiles
import async_timeout
from ppadb.client import Client
from ..constants import (
DEFAULT_ADB_TIMEOUT_S,
DEFAULT_AUTH_TIMEOUT_S,
DEFAULT_LOCK_TIMEOUT_S,
DEFAULT_TRANSPORT_TIMEOUT_S,
)
from ..exceptions import LockNotAcquiredException
_LOGGER = logging.getLogger(__name__)
class AdbDeviceUsbAsync:
"""An async wrapper for the adb-shell ``AdbDeviceUsb`` class."""
def __init__(self, serial=None, port_path=None, default_transport_timeout_s=None, banner=None):
self._adb = AdbDeviceUsb(serial, port_path, default_transport_timeout_s, banner)
@property
def available(self):
"""Whether or not an ADB connection to the device has been established."""
return self._adb.available
async def close(self):
"""Close the connection via the provided transport's ``close()`` method."""
await asyncio.get_running_loop().run_in_executor(None, self._adb.close)
async def connect(
self,
rsa_keys=None,
transport_timeout_s=None,
auth_timeout_s=DEFAULT_AUTH_TIMEOUT_S,
read_timeout_s=DEFAULT_READ_TIMEOUT_S,
auth_callback=None,
):
"""Establish an ADB connection to the device."""
return await asyncio.get_running_loop().run_in_executor(
None, self._adb.connect, rsa_keys, transport_timeout_s, auth_timeout_s, read_timeout_s, auth_callback
)
async def pull(
self,
device_path,
local_path,
progress_callback=None,
transport_timeout_s=None,
read_timeout_s=DEFAULT_READ_TIMEOUT_S,
):
"""Pull a file from the device."""
await asyncio.get_running_loop().run_in_executor(
None, self._adb.pull, device_path, local_path, progress_callback, transport_timeout_s, read_timeout_s
)
async def push(
self,
local_path,
device_path,
st_mode=DEFAULT_PUSH_MODE,
mtime=0,
progress_callback=None,
transport_timeout_s=None,
read_timeout_s=DEFAULT_READ_TIMEOUT_S,
):
"""Push a file or directory to the device."""
await asyncio.get_running_loop().run_in_executor(
None,
self._adb.push,
local_path,
device_path,
st_mode,
mtime,
progress_callback,
transport_timeout_s,
read_timeout_s,
)
async def shell(
self, command, transport_timeout_s=None, read_timeout_s=DEFAULT_READ_TIMEOUT_S, timeout_s=None, decode=True
):
"""Send an ADB shell command to the device."""
return await asyncio.get_running_loop().run_in_executor(
None, self._adb.shell, command, transport_timeout_s, read_timeout_s, timeout_s, decode
)
class DeviceAsync:
"""An async wrapper for the pure-python-adb ``Device`` class."""
def __init__(self, device):
self._device = device
async def pull(self, device_path, local_path):
"""Download a file."""
return await asyncio.get_running_loop().run_in_executor(None, self._device.pull, device_path, local_path)
async def push(self, local_path, device_path):
"""Upload a file."""
return await asyncio.get_running_loop().run_in_executor(None, self._device.push, local_path, device_path)
async def screencap(self):
"""Take a screencap."""
return await asyncio.get_running_loop().run_in_executor(None, self._device.screencap)
async def shell(self, cmd):
"""Send a shell command."""
return await asyncio.get_running_loop().run_in_executor(None, self._device.shell, cmd)
# pylint: disable=too-few-public-methods
class ClientAsync:
"""An async wrapper for the pure-python-adb ``Client`` class."""
def __init__(self, host, port):
self._client = Client(host, port)
async def device(self, serial):
"""Get a ``DeviceAsync`` instance."""
dev = await asyncio.get_running_loop().run_in_executor(None, self._client.device, serial)
if dev:
return DeviceAsync(dev)
return None
@asynccontextmanager
async def _acquire(lock, timeout=DEFAULT_LOCK_TIMEOUT_S):
"""Handle acquisition and release of an ``asyncio.Lock`` object with a timeout.
Parameters
----------
lock : asyncio.Lock
The lock that we will try to acquire
timeout : float
The timeout in seconds
Yields
------
acquired : bool
Whether or not the lock was acquired
Raises
------
LockNotAcquiredException
Raised if the lock was not acquired
"""
try:
acquired = False
try:
async with async_timeout.timeout(timeout):
acquired = await lock.acquire()
if not acquired:
raise LockNotAcquiredException
yield acquired
except asyncio.TimeoutError as exc:
raise LockNotAcquiredException from exc
finally:
if acquired:
lock.release()
class ADBPythonAsync(object):
"""A manager for ADB connections that uses a Python implementation of the ADB protocol.
Parameters
----------
host : str
The address of the device; may be an IP address or a host name
port : int
The device port to which we are connecting (default is 5555)
adbkey : str
The path to the ``adbkey`` file for ADB authentication
signer : PythonRSASigner, None
The signer for the ADB keys, as loaded by :meth:`ADBPythonAsync.load_adbkey`
"""
def __init__(self, host, port, adbkey="", signer=None):
self.host = host
self.port = int(port)
self.adbkey = adbkey
if host:
self._adb = AdbDeviceTcpAsync(
host=self.host, port=self.port, default_transport_timeout_s=DEFAULT_ADB_TIMEOUT_S
)
else:
self._adb = AdbDeviceUsbAsync(default_transport_timeout_s=DEFAULT_ADB_TIMEOUT_S)
self._signer = signer
# use a lock to make sure that ADB commands don't overlap
self._adb_lock = asyncio.Lock()
@property
def available(self):
"""Check whether the ADB connection is intact.
Returns
-------
bool
Whether or not the ADB connection is intact
"""
return self._adb.available
async def close(self):
"""Close the ADB socket connection."""
await self._adb.close()
async def connect(
self,
log_errors=True,
auth_timeout_s=DEFAULT_AUTH_TIMEOUT_S,
transport_timeout_s=DEFAULT_TRANSPORT_TIMEOUT_S,
):
"""Connect to an Android TV / Fire TV device.
Parameters
----------
log_errors : bool
Whether errors should be logged
auth_timeout_s : float
Authentication timeout (in seconds)
transport_timeout_s : float
Transport timeout (in seconds)
Returns
-------
bool
Whether or not the connection was successfully established and the device is available
"""
try:
async with _acquire(self._adb_lock):
# Catch exceptions
try:
# Connect with authentication
if self.adbkey:
if not self._signer:
self._signer = await self.load_adbkey(self.adbkey)
await self._adb.connect(
rsa_keys=[self._signer],
transport_timeout_s=transport_timeout_s,
auth_timeout_s=auth_timeout_s,
)
# Connect without authentication
else:
await self._adb.connect(transport_timeout_s=transport_timeout_s, auth_timeout_s=auth_timeout_s)
# ADB connection successfully established
_LOGGER.debug("ADB connection to %s:%d successfully established", self.host, self.port)
return True
except OSError as exc:
if log_errors:
if exc.strerror is None:
exc.strerror = "Timed out trying to connect to ADB device."
_LOGGER.warning(
"Couldn't connect to %s:%d. %s: %s",
self.host,
self.port,
exc.__class__.__name__,
exc.strerror,
)
# ADB connection attempt failed
await self.close()
return False
except Exception as exc: # pylint: disable=broad-except
if log_errors:
_LOGGER.warning(
"Couldn't connect to %s:%d. %s: %s", self.host, self.port, exc.__class__.__name__, exc
)
# ADB connection attempt failed
await self.close()
return False
except LockNotAcquiredException:
_LOGGER.warning("Couldn't connect to %s:%d because adb-shell lock not acquired.", self.host, self.port)
await self.close()
return False
@staticmethod
async def load_adbkey(adbkey):
"""Load the ADB keys.
Parameters
----------
adbkey : str
The path to the ``adbkey`` file for ADB authentication
Returns
-------
PythonRSASigner
The ``PythonRSASigner`` with the key files loaded
"""
# private key
async with aiofiles.open(adbkey) as f:
priv = await f.read()
# public key
try:
async with aiofiles.open(adbkey + ".pub") as f:
pub = await f.read()
except FileNotFoundError:
pub = ""
return PythonRSASigner(pub, priv)
async def pull(self, local_path, device_path):
"""Pull a file from the device using the Python ADB implementation.
Parameters
----------
local_path : str
The path where the file will be saved
device_path : str
The file on the device that will be pulled
"""
if not self.available:
_LOGGER.debug(
"ADB command not sent to %s:%d because adb-shell connection is not established: pull(%s, %s)",
self.host,
self.port,
local_path,
device_path,
)
return
async with _acquire(self._adb_lock):
_LOGGER.debug(
"Sending command to %s:%d via adb-shell: pull(%s, %s)", self.host, self.port, local_path, device_path
)
await self._adb.pull(device_path, local_path)
return
async def push(self, local_path, device_path):
"""Push a file to the device using the Python ADB implementation.
Parameters
----------
local_path : str
The file that will be pushed to the device
device_path : str
The path where the file will be saved on the device
"""
if not self.available:
_LOGGER.debug(
"ADB command not sent to %s:%d because adb-shell connection is not established: push(%s, %s)",
self.host,
self.port,
local_path,
device_path,
)
return
async with _acquire(self._adb_lock):
_LOGGER.debug(
"Sending command to %s:%d via adb-shell: push(%s, %s)", self.host, self.port, local_path, device_path
)
await self._adb.push(local_path, device_path)
return
async def screencap(self):
"""Take a screenshot using the Python ADB implementation.
Returns
-------
bytes
The screencap as a binary .png image
"""
if not self.available:
_LOGGER.debug(
"ADB screencap not taken from %s:%d because adb-shell connection is not established",
self.host,
self.port,
)
return None
async with _acquire(self._adb_lock):
_LOGGER.debug("Taking screencap from %s:%d via adb-shell", self.host, self.port)
result = await self._adb.shell("screencap -p", decode=False)
if result and result[5:6] == b"\r":
return result.replace(b"\r\n", b"\n")
return result
async def shell(self, cmd):
"""Send an ADB command using the Python ADB implementation.
Parameters
----------
cmd : str
The ADB command to be sent
Returns
-------
str, None
The response from the device, if there is a response
"""
if not self.available:
_LOGGER.debug(
"ADB command not sent to %s:%d because adb-shell connection is not established: %s",
self.host,
self.port,
cmd,
)
return None
async with _acquire(self._adb_lock):
_LOGGER.debug("Sending command to %s:%d via adb-shell: %s", self.host, self.port, cmd)
return await self._adb.shell(cmd)
class ADBServerAsync(object):
"""A manager for ADB connections that uses an ADB server.
Parameters
----------
host : str
The address of the device; may be an IP address or a host name
port : int
The device port to which we are connecting (default is 5555)
adb_server_ip : str
The IP address of the ADB server
adb_server_port : int
The port for the ADB server
"""
def __init__(self, host, port=5555, adb_server_ip="", adb_server_port=5037):
self.host = host
self.port = int(port)
self.adb_server_ip = adb_server_ip
self.adb_server_port = adb_server_port
self._adb_client = None
self._adb_device = None
# keep track of whether the ADB connection is intact
self._available = False
# use a lock to make sure that ADB commands don't overlap
self._adb_lock = asyncio.Lock()
@property
def available(self):
"""Check whether the ADB connection is intact.
Returns
-------
bool
Whether or not the ADB connection is intact
"""
if not self._adb_client or not self._adb_device:
return False
return self._available
async def close(self):
"""Close the ADB server socket connection.
Currently, this doesn't do anything except set ``self._available = False``.
"""
self._available = False
async def connect(self, log_errors=True):
"""Connect to an Android TV / Fire TV device.
Parameters
----------
log_errors : bool
Whether errors should be logged
Returns
-------
bool
Whether or not the connection was successfully established and the device is available
"""
try:
async with _acquire(self._adb_lock):
# Catch exceptions
try:
self._adb_client = ClientAsync(host=self.adb_server_ip, port=self.adb_server_port)
self._adb_device = await self._adb_client.device("{}:{}".format(self.host, self.port))
# ADB connection successfully established
if self._adb_device:
_LOGGER.debug(
"ADB connection to %s:%d via ADB server %s:%d successfully established",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
)
self._available = True
return True
# ADB connection attempt failed (without an exception)
if log_errors:
_LOGGER.warning(
"Couldn't connect to %s:%d via ADB server %s:%d because the server is not connected to the device",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
)
await self.close()
self._available = False
return False
# ADB connection attempt failed
except Exception as exc: # noqa pylint: disable=broad-except
if log_errors:
_LOGGER.warning(
"Couldn't connect to %s:%d via ADB server %s:%d, error: %s",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
exc,
)
await self.close()
self._available = False
return False
except LockNotAcquiredException:
_LOGGER.warning(
"Couldn't connect to %s:%d via ADB server %s:%d because pure-python-adb lock not acquired.",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
)
await self.close()
self._available = False
return False
async def pull(self, local_path, device_path):
"""Pull a file from the device using an ADB server.
Parameters
----------
local_path : str
The path where the file will be saved
device_path : str
The file on the device that will be pulled
"""
if not self.available:
_LOGGER.debug(
"ADB command not sent to %s:%d via ADB server %s:%d because pure-python-adb connection is not established: pull(%s, %s)",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
local_path,
device_path,
)
return
async with _acquire(self._adb_lock):
_LOGGER.debug(
"Sending command to %s:%d via ADB server %s:%d: pull(%s, %s)",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
local_path,
device_path,
)
await self._adb_device.pull(device_path, local_path)
return
async def push(self, local_path, device_path):
"""Push a file to the device using an ADB server.
Parameters
----------
local_path : str
The file that will be pushed to the device
device_path : str
The path where the file will be saved on the device
"""
if not self.available:
_LOGGER.debug(
"ADB command not sent to %s:%d via ADB server %s:%d because pure-python-adb connection is not established: push(%s, %s)",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
local_path,
device_path,
)
return
async with _acquire(self._adb_lock):
_LOGGER.debug(
"Sending command to %s:%d via ADB server %s:%d: push(%s, %s)",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
local_path,
device_path,
)
await self._adb_device.push(local_path, device_path)
return
async def screencap(self):
"""Take a screenshot using an ADB server.
Returns
-------
bytes, None
The screencap as a binary .png image, or ``None`` if there was an ``IndexError`` exception
"""
if not self.available:
_LOGGER.debug(
"ADB screencap not taken from %s:%d via ADB server %s:%d because pure-python-adb connection is not established",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
)
return None
async with _acquire(self._adb_lock):
_LOGGER.debug(
"Taking screencap from %s:%d via ADB server %s:%d",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
)
return await self._adb_device.screencap()
async def shell(self, cmd):
"""Send an ADB command using an ADB server.
Parameters
----------
cmd : str
The ADB command to be sent
Returns
-------
str, None
The response from the device, if there is a response
"""
if not self.available:
_LOGGER.debug(
"ADB command not sent to %s:%d via ADB server %s:%d because pure-python-adb connection is not established: %s",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
cmd,
)
return None
async with _acquire(self._adb_lock):
_LOGGER.debug(
"Sending command to %s:%d via ADB server %s:%d: %s",
self.host,
self.port,
self.adb_server_ip,
self.adb_server_port,
cmd,
)
return await self._adb_device.shell(cmd)
|