base_task.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  1. # This Python file uses the following encoding: utf-8
  2. # @author runhey
  3. # github https://github.com/runhey
  4. import numpy as np
  5. from datetime import datetime, timedelta
  6. from typing import Union
  7. from module.config.utils import convert_to_underscore
  8. from module.atom.image import RuleImage
  9. from module.atom.click import RuleClick
  10. from module.atom.long_click import RuleLongClick
  11. from module.atom.swipe import RuleSwipe
  12. from module.atom.ocr import RuleOcr
  13. from module.atom.list import RuleList
  14. from module.ocr.base_ocr import OcrMode, OcrMethod
  15. from module.logger import logger
  16. from module.base.timer import Timer
  17. from module.config.config import Config
  18. from module.config.utils import get_server_next_update, nearest_future, dict_to_kv
  19. from module.device.device import Device
  20. from tasks.GlobalGame.assets import GlobalGameAssets
  21. from tasks.GlobalGame.config_emergency import FriendInvitation, WhenNetworkAbnormal, WhenNetworkError
  22. from module.exception import GameStuckError, ScriptError
  23. class BaseTask(GlobalGameAssets):
  24. config: Config = None
  25. device: Device = None
  26. folder: str
  27. name: str
  28. stage: str
  29. limit_time: datetime # 限制运行的时间,是软时间,不是硬时间
  30. def __init__(self, config: Config, device: Device) -> None:
  31. self.config = config
  32. self.device = device
  33. self.interval_timer = {} # 这个是用来记录每个匹配的运行间隔的,用于控制运行频率
  34. self.start_time = datetime.now() # 启动的时间
  35. self.friend_timer = None
  36. if self.config.global_game.emergency.invitation_detect_interval:
  37. self.interval_time = self.config.global_game.emergency.invitation_detect_interval
  38. self.friend_timer = Timer(self.interval_time)
  39. def screenshot(self):
  40. """
  41. 截图 引入中间函数的目的是 为了解决如协作的这类突发的事件
  42. :return:
  43. """
  44. self.device.screenshot()
  45. # 判断勾协
  46. if self.friend_timer and self.friend_timer.reached():
  47. self.friend_timer.reset()
  48. invite = self.appear(self.I_ACCEPT)
  49. # 如果是全部接受
  50. if invite and self.config.global_game.emergency.friend_invitation == FriendInvitation.ACCEPT:
  51. # 如果是接受邀请
  52. logger.info(f"Accept friend invitation")
  53. while 1:
  54. if self.appear_then_click(self.I_ACCEPT):
  55. continue
  56. if not self.appear(self.I_ACCEPT):
  57. break
  58. # 如果是全部拒绝
  59. elif invite and self.config.global_game.emergency.friend_invitation == FriendInvitation.REJECT:
  60. logger.info(f"Reject friend invitation")
  61. while 1:
  62. if self.appear_then_click(self.I_REJECT):
  63. continue
  64. if not self.appear(self.I_REJECT):
  65. break
  66. # 最后一个是仅仅接受勾协
  67. elif invite and self.config.global_game.emergency.friend_invitation == FriendInvitation.ONLY_JADE:
  68. logger.info(f"Accept jade invitation")
  69. while 1:
  70. if self.appear_then_click(self.I_ACCEPT):
  71. continue
  72. if not self.appear(self.I_ACCEPT):
  73. break
  74. # 判断网络异常
  75. if self.appear(self.I_NETWORK_ABNORMAL):
  76. logger.warning(f"Network abnormal")
  77. raise GameStuckError
  78. # 判断网络错误
  79. if self.appear(self.I_NETWORK_ERROR):
  80. logger.warning(f"Network error")
  81. raise GameStuckError
  82. return self.device.image
  83. # 返回截图
  84. def appear(self, target: RuleImage, interval: float = None, threshold: float = None):
  85. """
  86. :param target: 匹配的目标可以是RuleImage, 也可以是RuleOcr
  87. :param interval:
  88. :param threshold:
  89. :return:
  90. """
  91. if not isinstance(target, RuleImage):
  92. return False
  93. if interval:
  94. if target.name in self.interval_timer:
  95. if self.interval_timer[target.name].limit != interval:
  96. self.interval_timer[target.name] = Timer(interval)
  97. else:
  98. self.interval_timer[target.name] = Timer(interval)
  99. if not self.interval_timer[target.name].reached():
  100. return False
  101. appear = target.match(self.device.image, threshold=threshold)
  102. if appear and interval:
  103. self.interval_timer[target.name].reset()
  104. return appear
  105. def appear_then_click(self,
  106. target: RuleImage,
  107. action: Union[RuleClick, RuleLongClick] = None,
  108. interval: float = None,
  109. threshold: float = None,
  110. duration: float = None):
  111. """
  112. 出现了就点击,默认点击图片的位置,如果添加了click参数,就点击click的位置
  113. :param duration: 如果是长按,可以手动指定duration,不指定默认.单位是ms!!!!
  114. :param action: 可以是RuleClick, 也可以是RuleLongClick
  115. :param target: 可以是RuleImage后续支持RuleOcr
  116. :param interval:
  117. :param threshold:
  118. :return: True or False
  119. """
  120. if not isinstance(target, RuleImage):
  121. return False
  122. appear = self.appear(target, interval=interval, threshold=threshold)
  123. if appear and not action:
  124. x, y = target.coord()
  125. self.device.click(x, y, control_name=target.name)
  126. elif appear and action:
  127. x, y = action.coord()
  128. if isinstance(action, RuleLongClick):
  129. if duration is None:
  130. self.device.long_click(x, y, duration=action.duration / 1000, control_name=target.name)
  131. else:
  132. self.device.long_click(x, y, duration=duration / 1000, control_name=target.name)
  133. elif isinstance(action, RuleClick):
  134. self.device.click(x, y, control_name=target.name)
  135. return appear
  136. def wait_until_appear(self,
  137. target: RuleImage,
  138. skip_first_screenshot=False) -> None:
  139. """
  140. 等待直到出现目标
  141. :param target:
  142. :param skip_first_screenshot:
  143. :return:
  144. """
  145. while 1:
  146. if skip_first_screenshot:
  147. skip_first_screenshot = False
  148. else:
  149. self.screenshot()
  150. if self.appear(target):
  151. break
  152. def wait_until_appear_then_click(self,
  153. target: RuleImage,
  154. action: Union[RuleClick, RuleLongClick] = None) -> None:
  155. """
  156. 等待直到出现目标,然后点击
  157. :param action:
  158. :param target:
  159. :return:
  160. """
  161. self.wait_until_appear(target)
  162. if action is None:
  163. self.device.click(target.coord(), control_name=target.name)
  164. elif isinstance(action, RuleLongClick):
  165. self.device.long_click(target.coord(), duration=action.duration / 1000, control_name=target.name)
  166. elif isinstance(action, RuleClick):
  167. self.device.click(target.coord(), control_name=target.name)
  168. def wait_until_disappear(self, target: RuleImage) -> None:
  169. while 1:
  170. self.screenshot()
  171. if not self.appear(target):
  172. break
  173. def wait_until_stable(self,
  174. target: RuleImage,
  175. timer=Timer(0.3, count=1),
  176. timeout=Timer(5, count=10),
  177. skip_first_screenshot=True):
  178. """
  179. 等待目标稳定,即连续多次匹配成功
  180. :param target:
  181. :param timer:
  182. :param timeout:
  183. :param skip_first_screenshot:
  184. :return:
  185. """
  186. target._match_init = False
  187. timeout.reset()
  188. while 1:
  189. if skip_first_screenshot:
  190. skip_first_screenshot = False
  191. else:
  192. self.screenshot()
  193. if target._match_init:
  194. if target.match(self.device.image):
  195. if timer.reached():
  196. break
  197. else:
  198. # button.load_color(self.device.image)
  199. timer.reset()
  200. else:
  201. # target.load_color(self.device.image)
  202. target._match_init = True
  203. if timeout.reached():
  204. logger.warning(f'wait_until_stable({target}) timeout')
  205. break
  206. def swipe(self, swipe: RuleSwipe, interval: float = None) -> None:
  207. """
  208. :param interval:
  209. :param swipe:
  210. :return:
  211. """
  212. if not isinstance(swipe, RuleSwipe):
  213. return
  214. if interval:
  215. if swipe.name in self.interval_timer:
  216. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  217. if self.interval_timer[swipe.name].limit != interval:
  218. self.interval_timer[swipe.name] = Timer(interval)
  219. else:
  220. # 如果没有限制时间,则创建限制时间
  221. self.interval_timer[swipe.name] = Timer(interval)
  222. # 如果时间还没到达,则不执行
  223. if not self.interval_timer[swipe.name].reached():
  224. return
  225. x1, y1, x2, y2 = swipe.coord()
  226. self.device.swipe(p1=(x1, y1), p2=(x2, y2), control_name=swipe.name)
  227. # 执行后,如果有限制时间,则重置限制时间
  228. if interval:
  229. # logger.info(f'Swipe {swipe.name}')
  230. self.interval_timer[swipe.name].reset()
  231. def click(self, click: Union[RuleClick, RuleLongClick] = None, interval: float = None) -> None:
  232. """
  233. 点击或者长按
  234. :param interval:
  235. :param click:
  236. :return:
  237. """
  238. if not click:
  239. return
  240. if interval:
  241. if click.name in self.interval_timer:
  242. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  243. if self.interval_timer[click.name].limit != interval:
  244. self.interval_timer[click.name] = Timer(interval)
  245. else:
  246. # 如果没有限制时间,则创建限制时间
  247. self.interval_timer[click.name] = Timer(interval)
  248. # 如果时间还没到达,则不执行
  249. if not self.interval_timer[click.name].reached():
  250. return
  251. x, y = click.coord()
  252. if isinstance(click, RuleLongClick):
  253. self.device.long_click(x=x, y=y, duration=click.duration / 1000, control_name=click.name)
  254. elif isinstance(click, RuleClick):
  255. self.device.click(x=x, y=y, control_name=click.name)
  256. # 执行后,如果有限制时间,则重置限制时间
  257. if interval:
  258. self.interval_timer[click.name].reset()
  259. def ocr_appear(self, target: RuleOcr, interval: float = None) -> bool:
  260. """
  261. ocr识别目标
  262. :param interval:
  263. :param target:
  264. :return: 如果target有keyword或者是keyword存在,返回是True,否则返回False
  265. 但是没有指定keyword,返回的是匹配到的值,具体取决于target的mode
  266. """
  267. if not isinstance(target, RuleOcr):
  268. return None
  269. if interval:
  270. if target.name in self.interval_timer:
  271. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  272. if self.interval_timer[target.name].limit != interval:
  273. self.interval_timer[target.name] = Timer(interval)
  274. else:
  275. # 如果没有限制时间,则创建限制时间
  276. self.interval_timer[target.name] = Timer(interval)
  277. # 如果时间还没到达,则不执行
  278. if not self.interval_timer[target.name].reached():
  279. return None
  280. result = target.ocr(self.device.image)
  281. appear = False
  282. if not target.keyword or target.keyword == '':
  283. appear = False
  284. match target.mode:
  285. case OcrMode.FULL: # 全匹配
  286. appear = result != (0, 0, 0, 0)
  287. case OcrMode.SINGLE:
  288. appear = result == target.keyword
  289. case OcrMode.DIGIT:
  290. appear = result == int(target.keyword)
  291. case OcrMode.DIGITCOUNTER:
  292. appear = result == target.ocr_str_digit_counter(target.keyword)
  293. case OcrMode.DURATION:
  294. appear = result == target.parse_time(target.keyword)
  295. if interval and appear:
  296. self.interval_timer[target.name].reset()
  297. return appear
  298. def ocr_appear_click(self,
  299. target: RuleOcr,
  300. action: Union[RuleClick, RuleLongClick] = None,
  301. interval: float = None,
  302. duration: float = None) -> bool:
  303. """
  304. ocr识别目标,如果目标存在,则触发动作
  305. :param target:
  306. :param action:
  307. :param interval:
  308. :param duration:
  309. :return:
  310. """
  311. appear = self.ocr_appear(target, interval)
  312. if not appear:
  313. return False
  314. if action:
  315. x, y = action.coord()
  316. self.click(action, interval)
  317. else:
  318. x, y = target.coord()
  319. self.device.click(x=x, y=y, control_name=target.name)
  320. def list_find(self, target: RuleList, name: str | list[str]) -> bool:
  321. """
  322. 会一致在列表寻找目标,找到了就退出。
  323. 如果是图片列表会一直往下找
  324. 如果是纯文字的,会自动识别自己的位置,根据位置选择向前还是向后翻
  325. :param target:
  326. :param name:
  327. :return:
  328. """
  329. if target.is_image:
  330. while True:
  331. self.screenshot()
  332. result = target.image_appear(self.device.image, name=name)
  333. if result is not None:
  334. return result
  335. x1, y1, x2, y2 = target.swipe_pos()
  336. self.device.swipe(p1=(x1, y1), p2=(x2, y2))
  337. elif target.is_ocr:
  338. while True:
  339. self.screenshot()
  340. result = target.ocr_appear(self.device.image, name=name)
  341. if isinstance(result, tuple):
  342. return result
  343. after = True
  344. if isinstance(result, int) and result > 0:
  345. after = True
  346. elif isinstance(result, int) and result < 0:
  347. after = False
  348. x1, y1, x2, y2 = target.swipe_pos(after=after)
  349. self.device.swipe(p1=(x1, y1), p2=(x2, y2))
  350. def set_next_run(self, task: str, finish: bool = False,
  351. success: bool=None, server: bool=None, target: timedelta=None) -> None:
  352. """
  353. 设置下次运行时间 当然这个也是可以重写的
  354. :param target: 可以自定义的下次运行时间
  355. :param server: delay to nearest Scheduler.ServerUpdate
  356. :param success: 判断是成功的还是失败的时间间隔
  357. :param task: 任务名称,大驼峰的
  358. :param finish: 是完成任务后的时间为基准还是开始任务的时间为基准
  359. :return:
  360. """
  361. # 任务预处理
  362. if not task:
  363. task = self.config.task.command
  364. task = convert_to_underscore(task)
  365. task_object = getattr(self.config.model, task, None)
  366. if not task_object:
  367. logger.warning(f'No task named {task}')
  368. return
  369. scheduler = getattr(task_object, 'scheduler', None)
  370. if not scheduler:
  371. logger.warning(f'No scheduler in {task}')
  372. return
  373. # 任务开始时间
  374. if finish:
  375. start_time = datetime.now()
  376. else:
  377. start_time = self.start_time
  378. # 依次判断是否有自定义的下次运行时间
  379. run = []
  380. if success is not None:
  381. interval = (
  382. scheduler.success_interval
  383. if success
  384. else scheduler.failure_interval
  385. )
  386. run.append(start_time + interval)
  387. if server is not None:
  388. if server:
  389. server = scheduler.server_update
  390. run.append(get_server_next_update(server))
  391. if target is not None:
  392. target = [target] if not isinstance(target, list) else target
  393. target = nearest_future(target)
  394. run.append(target)
  395. # 排序
  396. if len(run):
  397. run = min(run).replace(microsecond=0)
  398. kv = dict_to_kv(
  399. {
  400. "success": success,
  401. "server_update": server,
  402. "target": target,
  403. },
  404. allow_none=False,
  405. )
  406. logger.info(f"Delay task `{task}` to {run} ({kv})")
  407. scheduler.next_run = run
  408. self.config.save()
  409. else:
  410. raise ScriptError(
  411. "Missing argument in delay_next_run, should set at least one"
  412. )