script.py 14 KB

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