| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328 |
- import os
- import re
- import winreg
- import subprocess
- from adbutils.errors import AdbError
- from deploy.emulator import VirtualBoxEmulator
- from module.base.decorator import cached_property
- from module.device.connection import Connection
- from module.device.method.utils import get_serial_pair
- from module.exception import RequestHumanTakeover, EmulatorNotRunningError
- from module.logger import logger
- class EmulatorInstance(VirtualBoxEmulator):
- def __init__(self, name, root_path, emu_path,
- vbox_path=None, vbox_name=None, kill_para=None, multi_para=None):
- """
- Args:
- name (str): Emulator name in windows uninstall list.
- root_path (str): Relative path from uninstall.exe to emulator installation folder.
- emu_path (str): Relative path to executable simulator file.
- vbox_path (str): Relative path to virtual box folder.
- vbox_name (str): Regular Expression to match the name of .vbox file.
- kill_para (str): Parameters required by kill emulator.
- multi_para (str): Parameters required by start multi open emulator,
- #id will be replaced with the real ID.
- """
- super().__init__(
- name=name,
- root_path=root_path,
- adb_path=None,
- vbox_path=vbox_path,
- vbox_name=vbox_name,
- )
- self.emu_path = emu_path
- self.kill_para = kill_para
- self.multi_para = multi_para
- @cached_property
- def id_and_serial(self):
- """
- Returns:
- list[str, str]: List of multi_id and serial.
- """
- vbox = []
- for path, folders, files in os.walk(os.path.join(self.root, self.vbox_path)):
- for file in files:
- if re.match(self.vbox_name, file):
- file = os.path.join(path, file)
- vbox.append(file)
- serial = []
- for file in vbox:
- with open(file, 'r', encoding='utf-8', errors='ignore') as f:
- for line in f.readlines():
- # <Forwarding name="port2" proto="1" hostip="127.0.0.1" hostport="62026" guestport="5555"/>
- res = re.search('<*?hostport="(.*?)".*?guestport="5555"/>', line)
- if res:
- serial.append([os.path.basename(file).split(".")[0], f'127.0.0.1:{res.group(1)}'])
- return serial
- class Bluestacks5Instance(EmulatorInstance):
- @cached_property
- def root(self):
- try:
- return super().root
- except FileNotFoundError:
- self.name = 'BlueStacks_nxt_cn'
- return super().root
- @cached_property
- def id_and_serial(self):
- try:
- reg = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\BlueStacks_nxt")
- except FileNotFoundError:
- reg = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\BlueStacks_nxt_cn")
- directory = winreg.QueryValueEx(reg, 'UserDefinedDir')[0]
- with open(os.path.join(directory, 'bluestacks.conf'), encoding='utf-8') as f:
- content = f.read()
- emulators = re.findall(r'bst.instance.(\w+).status.adb_port="(\d+)"', content)
- serial = []
- for emulator in emulators:
- serial.append([emulator[0], f'127.0.0.1:{emulator[1]}'])
- return serial
- class EmulatorManager(Connection):
- pid = None
- SUPPORTED_EMULATORS = {
- 'nox_player': EmulatorInstance(
- name="Nox",
- root_path=".",
- emu_path="./Nox.exe",
- vbox_path="./BignoxVMS",
- vbox_name='.*.vbox$',
- kill_para='-quit',
- multi_para='-clone:#id',
- ),
- 'mumu_player': EmulatorInstance(
- name="Nemu",
- root_path=".",
- emu_path="./EmulatorShell/NemuPlayer.exe",
- vbox_path="./vms",
- vbox_name='.*.nemu$',
- ),
- 'bluestacks_5': Bluestacks5Instance(
- name='BlueStacks_nxt',
- root_path='.',
- emu_path='./HD-Player.exe',
- multi_para='--instance #id',
- ),
- }
- def detect_emulator(self, serial, emulator=None):
- """
- Args:
- serial (str):
- emulator (EmulatorInstance):
- Returns:
- list[EmulatorInstance, str]:Emulator and multi_id
- """
- if emulator is None:
- logger.info('Detect emulator from all emulators installed')
- emulators = []
- for emulator in self.SUPPORTED_EMULATORS.values():
- try:
- serials = emulator.id_and_serial
- for cur_serial in serials:
- if cur_serial[1] == serial:
- emulators.append([emulator, cur_serial[0]])
- except FileNotFoundError:
- pass
- logger.info('Detected emulators:')
- for emulator in emulators:
- logger.info(f'Name: {emulator[0].name}, Multi_id: {emulator[1]}')
- if len(emulators) == 1 or \
- (len(emulators) > 0 and emulators[0][0] == self.SUPPORTED_EMULATORS['mumu_player']):
- logger.info('Find the only emulator, using it')
- return emulators[0][0], emulators[0][1]
- elif len(emulators) == 0:
- logger.warning('The emulator corresponding to serial is not found, '
- 'please check the setting or use custom command')
- else:
- logger.warning('Multiple emulators with the same serial have been found, '
- 'please select one manually or use custom command')
- raise RequestHumanTakeover
- else:
- try:
- logger.info(f'Detect emulator from {emulator.name}')
- serials = emulator.id_and_serial
- for cur_serial in serials:
- if cur_serial[1] == serial:
- logger.info('Find the only emulator, using it')
- return emulator, cur_serial[0]
- except FileNotFoundError:
- pass
- logger.warning('The emulator corresponding to serial is not found, '
- 'please check the setting or use custom command')
- raise RequestHumanTakeover
- @staticmethod
- def execute(command):
- """
- Args:
- command (str):
- Returns:
- subprocess.Popen:
- """
- command = command.replace(r"\\", "/").replace("\\", "/").replace('"', '"')
- logger.info(f'Execute: {command}')
- return subprocess.Popen(command, close_fds=True) # only work on Windows
- @staticmethod
- def task_kill(pid=None, name=None):
- """
- Args:
- pid (list, int):
- name (list, str):
- Returns:
- subprocess.Popen:
- """
- command = 'taskkill '
- if pid is not None:
- if isinstance(pid, list):
- for p in pid:
- command += f'/pid {p} '
- else:
- command += f'/pid {pid} '
- elif name is not None:
- if isinstance(name, list):
- for n in name:
- command += f'/im {n} '
- else:
- command += f'/im {name} '
- else:
- raise RequestHumanTakeover
- command += '/t /f'
- return EmulatorManager.execute(command)
- def adb_connect(self, serial):
- try:
- return super(EmulatorManager, self).adb_connect(serial)
- except EmulatorNotRunningError:
- raise RequestHumanTakeover
- def detect_emulator_status(self, serial):
- devices = self.list_device()
- for device in devices:
- if device.serial == serial:
- return device.status
- return 'offline'
- def emulator_start(self, serial, emulator=None, multi_id=None, command=None):
- """
- Args:
- serial (str): Expected serial after simulator starts successfully.
- emulator (EmulatorInstance): Emulator to start.
- multi_id (str): Emulator ID used by multi open emulator.
- command (str): Customized path and parameters of the simulator to start.
- Return:
- bool: If start successful.
- """
- if command is None:
- command = '\"' + os.path.abspath(os.path.join(emulator.root, emulator.emu_path)) + '\"'
- if emulator.multi_para is not None and multi_id is not None:
- command += " " + emulator.multi_para.replace("#id", multi_id)
- logger.info('Start emulator')
- pipe = self.execute(command)
- self.pid = pipe.pid
- self.sleep(10)
- for _ in range(20):
- if pipe.poll() is not None:
- break
- try:
- if super().adb_connect(serial):
- # Wait until emulator start completely
- self.sleep(10)
- return True
- except EmulatorNotRunningError:
- pass
- self.sleep(5)
- return False
- def emulator_kill(self, serial, emulator=None, multi_id=None, command=None):
- """
- Args:
- serial (str): Expected serial after simulator starts successfully.
- emulator (EmulatorInstance): Emulator to start.
- multi_id (str): Emulator ID used by multi open emulator.
- command (str): Customized path and parameters of the simulator to start.
- Return:
- bool: If kill successful.
- """
- if command is None and emulator.kill_para is not None:
- command = '\"' + os.path.abspath(os.path.join(emulator.root, emulator.emu_path)) + '\"'
- if emulator.multi_para is not None and multi_id is not None:
- command += " " + emulator.multi_para.replace("#id", multi_id)
- command += " " + emulator.kill_para
- logger.info('Kill emulator')
- if emulator == self.SUPPORTED_EMULATORS['bluestacks_5']:
- try:
- self.adb_command(['reboot', '-p'], timeout=20)
- if self.detect_emulator_status(serial) == 'offline':
- self.pid = None
- return True
- except AdbError:
- return False
- if emulator == self.SUPPORTED_EMULATORS['mumu_player']:
- self.task_kill(pid=None, name=['NemuHeadless.exe', 'NemuPlayer.exe', 'NemuSvc.exe'])
- elif command is not None:
- self.execute(command)
- else:
- self.task_kill(pid=self.pid, name=os.path.basename(emulator.emu_path))
- self.sleep(5)
- for _ in range(10):
- if self.detect_emulator_status(serial) == 'offline':
- self.pid = None
- return True
- self.sleep(2)
- return False
- def emulator_restart(self):
- serial, _ = get_serial_pair(self.serial)
- if serial is None:
- serial = self.serial
- if os.name != 'nt':
- logger.warning('Restart simulator only works under Windows platform')
- return False
- logger.hr('Emulator restart')
- # if self.config.RestartEmulator_EmulatorType == 'auto':
- if self.config.get_arg('Restart', '') == 'auto':
- emulator, multi_id = self.detect_emulator(serial)
- else:
- emulator = self.SUPPORTED_EMULATORS[self.config.RestartEmulator_EmulatorType]
- emulator, multi_id = self.detect_emulator(serial, emulator=emulator)
- for _ in range(3):
- if not self.emulator_kill(serial, emulator, multi_id):
- continue
- if self.emulator_start(serial, emulator, multi_id):
- return True
- logger.warning('Restart emulator failed for 3 times, please check your settings')
- raise RequestHumanTakeover
|