script.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. # This Python file uses the following encoding: utf-8
  2. # @author runhey
  3. # github https://github.com/runhey
  4. import zerorpc
  5. import zmq
  6. import msgpack
  7. import random
  8. import re
  9. import cv2
  10. import time
  11. import os
  12. import inflection
  13. from datetime import datetime, timedelta
  14. from pathlib import Path
  15. from cached_property import cached_property
  16. from pydantic import BaseModel, ValidationError
  17. from PySide6.QtGui import QImage
  18. from module.config.utils import convert_to_underscore
  19. from module.config.config import Config, TaskEnd
  20. from module.device.device import Device
  21. from module.base.utils import load_module
  22. from module.base.decorator import del_cached_property
  23. from module.logger import logger
  24. from module.exception import *
  25. class Script:
  26. def __init__(self, config_name: str ='oas') -> None:
  27. logger.hr('Start', level=0)
  28. self.server = None
  29. self.config_name = config_name
  30. # Skip first restart
  31. self.is_first_task = True
  32. # Failure count of tasks
  33. # Key: str, task name, value: int, failure count
  34. self.failure_record = {}
  35. @cached_property
  36. def config(self) -> "Config":
  37. try:
  38. from module.config.config import Config
  39. config = Config(config_name=self.config_name)
  40. return config
  41. except RequestHumanTakeover:
  42. logger.critical('Request human takeover')
  43. exit(1)
  44. except Exception as e:
  45. logger.exception(e)
  46. exit(1)
  47. @cached_property
  48. def device(self) -> "Device":
  49. try:
  50. from module.device.device import Device
  51. device = Device(config=self.config)
  52. return device
  53. except RequestHumanTakeover:
  54. logger.critical('Request human takeover')
  55. exit(1)
  56. except Exception as e:
  57. logger.exception(e)
  58. exit(1)
  59. @cached_property
  60. def checker(self):
  61. """
  62. 占位函数,在alas中是检查服务器是否正常的
  63. :return:
  64. """
  65. return None
  66. def save_error_log(self):
  67. """
  68. Save last 60 screenshots in ./log/error/<timestamp>
  69. Save logs to ./log/error/<timestamp>/log.txt
  70. """
  71. from module.base.utils import save_image
  72. from module.handler.sensitive_info import (handle_sensitive_image,
  73. handle_sensitive_logs)
  74. if self.config.Error_SaveError:
  75. if not os.path.exists('./log/error'):
  76. os.mkdir('./log/error')
  77. folder = f'./log/error/{int(time.time() * 1000)}'
  78. logger.warning(f'Saving error: {folder}')
  79. os.mkdir(folder)
  80. for data in self.device.screenshot_deque:
  81. image_time = datetime.strftime(data['time'], '%Y-%m-%d_%H-%M-%S-%f')
  82. image = handle_sensitive_image(data['image'])
  83. save_image(image, f'{folder}/{image_time}.png')
  84. with open(logger.log_file, 'r', encoding='utf-8') as f:
  85. lines = f.readlines()
  86. start = 0
  87. for index, line in enumerate(lines):
  88. line = line.strip(' \r\t\n')
  89. if re.match('^═{15,}$', line):
  90. start = index
  91. lines = lines[start - 2:]
  92. lines = handle_sensitive_logs(lines)
  93. with open(f'{folder}/log.txt', 'w', encoding='utf-8') as f:
  94. f.writelines(lines)
  95. def init_server(self, port: int) -> int:
  96. """
  97. 初始化zerorpc服务,返回端口号
  98. :return:
  99. """
  100. self.server = zerorpc.Server(self)
  101. try:
  102. self.server.bind(f'tcp://127.0.0.1:{port}')
  103. return port
  104. except zmq.error.ZMQError:
  105. logger.error(f"Ocr server cannot bind on port {port}")
  106. return None
  107. def run_server(self) -> None:
  108. """
  109. 启动zerorpc服务
  110. :return:
  111. """
  112. self.server.run()
  113. def gui_args(self, task: str) -> str:
  114. """
  115. 获取给gui显示的参数
  116. :return:
  117. """
  118. return self.config.gui_args(task=task)
  119. def gui_menu(self) -> str:
  120. """
  121. 获取给gui显示的菜单
  122. :return:
  123. """
  124. return self.config.gui_menu
  125. def gui_task(self, task: str) -> str:
  126. """
  127. 获取给gui显示的任务 的参数的具体值
  128. :return:
  129. """
  130. return self.config.model.gui_task(task=task)
  131. def gui_set_task(self, task: str, group: str, argument: str, value) -> bool:
  132. """
  133. 设置给gui显示的任务 的参数的具体值
  134. :return:
  135. """
  136. task = convert_to_underscore(task)
  137. group = convert_to_underscore(group)
  138. argument = convert_to_underscore(argument)
  139. path = f'{task}.{group}.{argument}'
  140. task_object = getattr(self.config.model, task, None)
  141. group_object = getattr(task_object, group, None)
  142. argument_object = getattr(group_object, argument, None)
  143. if argument_object is None:
  144. logger.error(f'gui_set_task {task}.{group}.{argument}.{value} failed')
  145. return False
  146. try:
  147. setattr(group_object, argument, value)
  148. argument_object = getattr(group_object, argument, None)
  149. logger.info(f'gui_set_task {task}.{group}.{argument}.{argument_object}')
  150. self.config.save() # 我是没有想到什么方法可以使得属性改变自动保存的
  151. return True
  152. except ValidationError as e:
  153. logger.error(e)
  154. return False
  155. @zerorpc.stream
  156. def gui_mirror_image(self):
  157. """
  158. 获取给gui显示的镜像
  159. :return: cv2的对象将 numpy 数组转换为字节串。接下来MsgPack 进行序列化发送方将图像数据转换为字节串
  160. """
  161. # return msgpack.packb(cv2.imencode('.jpg', self.device.screenshot())[1].tobytes())
  162. ret, buffer = cv2.imencode('.jpg', self.device.screenshot())
  163. yield buffer.tobytes()
  164. def wait_until(self, future):
  165. """
  166. Wait until a specific time.
  167. Args:
  168. future (datetime):
  169. Returns:
  170. bool: True if wait finished, False if config changed.
  171. """
  172. future = future + timedelta(seconds=1)
  173. self.config.start_watching()
  174. while 1:
  175. if datetime.now() > future:
  176. return True
  177. # if self.stop_event is not None:
  178. # if self.stop_event.is_set():
  179. # logger.info("Update event detected")
  180. # logger.info(f"[{self.config_name}] exited. Reason: Update")
  181. # exit(0)
  182. time.sleep(5)
  183. if self.config.should_reload():
  184. return False
  185. def get_next_task(self) -> str:
  186. """
  187. 获取下一个任务的名字, 大驼峰。
  188. :return:
  189. """
  190. while 1:
  191. task = self.config.get_next()
  192. self.config.task = task
  193. # from module.base.resource import release_resources
  194. # if self.config.task.command != 'Alas':
  195. # release_resources(next_task=task.command)
  196. if task.next_run > datetime.now():
  197. logger.info(f'Wait until {task.next_run} for task `{task.command}`')
  198. # self.is_first_task = False
  199. method = self.config.optimization.when_task_queue_empty
  200. if method == 'close_game':
  201. logger.info('Close game during wait')
  202. self.device.app_stop()
  203. self.device.release_during_wait()
  204. if not self.wait_until(task.next_run):
  205. del_cached_property(self, 'config')
  206. continue
  207. self.run('start')
  208. elif method == 'goto_main':
  209. logger.info('Goto main page during wait')
  210. self.run('goto_main')
  211. self.device.release_during_wait()
  212. if not self.wait_until(task.next_run):
  213. del_cached_property(self, 'config')
  214. continue
  215. else:
  216. logger.warning(f'Invalid Optimization_WhenTaskQueueEmpty: {method}, fallback to stay_there')
  217. self.device.release_during_wait()
  218. if not self.wait_until(task.next_run):
  219. del_cached_property(self, 'config')
  220. continue
  221. break
  222. return task.command
  223. def run(self, command: str) -> bool:
  224. """
  225. :param command:
  226. :return:
  227. """
  228. if command == 'start' and command == 'goto_main':
  229. logger.error(f'Invalid command `{command}`')
  230. try:
  231. self.device.screenshot()
  232. module_name = 'script_task'
  233. module_path = str(Path.cwd() / 'tasks' / command / (module_name+'.py'))
  234. logger.info(f'module_path: {module_path}, module_name: {module_name}')
  235. task_module = load_module(module_name, module_path)
  236. task_module.ScriptTask(config=self.config, device=self.device).run()
  237. except TaskEnd:
  238. return True
  239. except GameNotRunningError as e:
  240. logger.warning(e)
  241. self.config.task_call('Restart')
  242. return True
  243. except (GameStuckError, GameTooManyClickError) as e:
  244. logger.error(e)
  245. self.save_error_log()
  246. logger.warning(f'Game stuck, {self.device.package} will be restarted in 10 seconds')
  247. logger.warning('If you are playing by hand, please stop Alas')
  248. self.config.task_call('Restart')
  249. self.device.sleep(10)
  250. return False
  251. except GameBugError as e:
  252. logger.warning(e)
  253. self.save_error_log()
  254. logger.warning('An error has occurred in Azur Lane game client, Alas is unable to handle')
  255. logger.warning(f'Restarting {self.device.package} to fix it')
  256. self.config.task_call('Restart')
  257. self.device.sleep(10)
  258. return False
  259. except GamePageUnknownError:
  260. logger.info('Game server may be under maintenance or network may be broken, check server status now')
  261. self.checker.check_now()
  262. if self.checker.is_available():
  263. logger.critical('Game page unknown')
  264. self.save_error_log()
  265. exit(1)
  266. else:
  267. self.checker.wait_until_available()
  268. return False
  269. except ScriptError as e:
  270. logger.critical(e)
  271. logger.critical('This is likely to be a mistake of developers, but sometimes just random issues')
  272. exit(1)
  273. except RequestHumanTakeover:
  274. logger.critical('Request human takeover')
  275. exit(1)
  276. except Exception as e:
  277. logger.exception(e)
  278. self.save_error_log()
  279. exit(1)
  280. def loop(self):
  281. """
  282. Main loop of scheduler.
  283. :return:
  284. """
  285. logger.set_file_logger(self.config_name)
  286. logger.info(f'Start scheduler loop: {self.config_name}')
  287. while 1:
  288. # Check update event from GUI
  289. # if self.stop_event is not None:
  290. # if self.stop_event.is_set():
  291. # logger.info("Update event detected")
  292. # logger.info(f"Alas [{self.config_name}] exited.")
  293. # break
  294. # Check game server maintenance
  295. # self.checker.wait_until_available()
  296. # if self.checker.is_recovered():
  297. # # There is an accidental bug hard to reproduce
  298. # # Sometimes, config won't be updated due to blocking
  299. # # even though it has been changed
  300. # # So update it once recovered
  301. # del_cached_property(self, 'config')
  302. # logger.info('Server or network is recovered. Restart game client')
  303. # self.config.task_call('Restart')
  304. # Get task
  305. task = self.get_next_task()
  306. # Init device and change server
  307. _ = self.device
  308. # Skip first restart
  309. if self.is_first_task and task == 'Restart':
  310. logger.info('Skip task `Restart` at scheduler start')
  311. self.config.task_delay(server_update=True)
  312. del_cached_property(self, 'config')
  313. continue
  314. # Run
  315. logger.info(f'Scheduler: Start task `{task}`')
  316. self.device.stuck_record_clear()
  317. self.device.click_record_clear()
  318. logger.hr(task, level=0)
  319. success = self.run(inflection.underscore(task))
  320. logger.info(f'Scheduler: End task `{task}`')
  321. self.is_first_task = False
  322. # Check failures
  323. # failed = deep_get(self.failure_record, keys=task, default=0)
  324. failed = self.failure_record[task] if task in self.failure_record else 0
  325. failed = 0 if success else failed + 1
  326. # deep_set(self.failure_record, keys=task, value=failed)
  327. self.failure_record[task] = failed
  328. if failed >= 3:
  329. logger.critical(f"Task `{task}` failed 3 or more times.")
  330. logger.critical("Possible reason #1: You haven't used it correctly. "
  331. "Please read the help text of the options.")
  332. logger.critical("Possible reason #2: There is a problem with this task. "
  333. "Please contact developers or try to fix it yourself.")
  334. logger.critical('Request human takeover')
  335. exit(1)
  336. if success:
  337. del_cached_property(self, 'config')
  338. continue
  339. elif self.config.error.handle.error:
  340. # self.config.task_delay(success=False)
  341. del_cached_property(self, 'config')
  342. self.checker.check_now()
  343. continue
  344. else:
  345. break
  346. if __name__ == "__main__":
  347. script = Script("oas1")
  348. print(script.get_next_task())
  349. script.run("AreaBoss")