base_task.py 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641
  1. # This Python file uses the following encoding: utf-8
  2. # @author runhey
  3. # github https://github.com/runhey
  4. from time import sleep
  5. from datetime import datetime, timedelta
  6. from module.atom.animate import RuleAnimate
  7. from module.atom.click import RuleClick
  8. from module.atom.gif import RuleGif
  9. from module.atom.image import RuleImage
  10. from module.atom.list import RuleList
  11. from module.atom.long_click import RuleLongClick
  12. from module.atom.ocr import RuleOcr
  13. from module.atom.swipe import RuleSwipe
  14. from module.base.timer import Timer
  15. from module.config.config import Config
  16. from module.device.device import Device
  17. from module.exception import ScriptError
  18. from module.logger import logger
  19. from module.ocr.base_ocr import OcrMode
  20. from tasks.Component.Costume.costume_base import CostumeBase
  21. from tasks.Component.config_base import Time
  22. from tasks.GlobalGame.assets import GlobalGameAssets
  23. from tasks.GlobalGame.config_emergency import FriendInvitation
  24. from typing import Union
  25. class BaseTask(GlobalGameAssets, CostumeBase):
  26. config: Config = None
  27. device: Device = None
  28. folder: str
  29. name: str
  30. stage: str
  31. limit_time: timedelta = None # 限制运行的时间,是软时间,不是硬时间
  32. limit_count: int = None # 限制运行的次数
  33. current_count: int = None # 当前运行的次数
  34. def __init__(self, config: Config, device: Device) -> None:
  35. """
  36. :rtype: object
  37. """
  38. self.config = config
  39. self.device = device
  40. self.interval_timer = {} # 这个是用来记录每个匹配的运行间隔的,用于控制运行频率
  41. self.animates = {} # 保存缓存
  42. self.start_time = datetime.now() # 启动的时间
  43. self.check_costume(self.config.global_game.costume_config)
  44. # self.friend_timer = None # 这个是用来记录勾协的时间的
  45. # if self.config.global_game.emergency.invitation_detect_interval:
  46. # self.interval_time = self.config.global_game.emergency.invitation_detect_interval
  47. # self.friend_timer = Timer(self.interval_time)
  48. # self.friend_timer.start()
  49. # 战斗次数相关
  50. self.current_count = 0 # 战斗次数
  51. def _burst(self) -> bool:
  52. """
  53. 游戏界面突发异常检测
  54. :return: 没有出现返回False, 其他True
  55. """
  56. image = self.device.image
  57. appear_invitation = self.appear(self.I_G_ACCEPT)
  58. if not appear_invitation:
  59. return False
  60. logger.info('Invitation appearing')
  61. invite_type = self.config.global_game.emergency.friend_invitation
  62. detect_record = self.device.detect_record
  63. match invite_type:
  64. case FriendInvitation.ACCEPT:
  65. logger.info(f"Accept friend invitation")
  66. click_button = self.I_G_ACCEPT
  67. case FriendInvitation.REJECT:
  68. logger.info(f"Reject friend invitation")
  69. click_button = self.I_G_REJECT
  70. case FriendInvitation.ONLY_JADE:
  71. # 勾协
  72. logger.info(f"Only accept jade invitation")
  73. if self.appear(self.I_G_JADE):
  74. click_button = self.I_G_ACCEPT
  75. else:
  76. click_button = self.I_G_IGNORE
  77. case FriendInvitation.JADE_AND_FOOD:
  78. # 如果是接受勾协和粮协
  79. logger.info(f"Accept jade and food invitation")
  80. if self.appear(self.I_G_JADE) or self.appear(self.I_G_CAT_FOOD) or self.appear(self.I_G_DOG_FOOD):
  81. click_button = self.I_G_ACCEPT
  82. else:
  83. click_button = self.I_G_IGNORE
  84. case FriendInvitation.IGNORE:
  85. # 如果是忽略
  86. logger.info(f"Ignore friend invitation")
  87. click_button = self.I_G_IGNORE
  88. case _:
  89. raise ScriptError(f'Unknown friend invitation type: {invite_type}')
  90. if not click_button:
  91. raise ScriptError(f'Unknown click button type: {invite_type}')
  92. while 1:
  93. self.device.screenshot()
  94. if not self.appear(target=click_button):
  95. logger.info('Deal with invitation done')
  96. break
  97. if self.appear_then_click(click_button, interval=0.8):
  98. continue
  99. # 有的时候长战斗 点击后会取消战斗状态
  100. self.device.detect_record = detect_record
  101. # 如果接受邀请则立即执行悬赏任务
  102. if click_button == self.I_G_ACCEPT:
  103. self.set_next_run(task='WantedQuests', target=datetime.now().replace(microsecond=0))
  104. return True
  105. def screenshot(self):
  106. """
  107. 截图 引入中间函数的目的是 为了解决如协作的这类突发的事件
  108. :return:
  109. """
  110. self.device.screenshot()
  111. # 判断勾协
  112. self._burst()
  113. # # 判断网络异常
  114. # if self.appear(self.I_NETWORK_ABNORMAL):
  115. # logger.warning(f"Network abnormal")
  116. # raise GameStuckError
  117. #
  118. # # 判断网络错误
  119. # if self.appear(self.I_NETWORK_ERROR):
  120. # logger.warning(f"Network error")
  121. # raise GameStuckError
  122. return self.device.image
  123. def appear(self,
  124. target: RuleImage | RuleGif | RuleOcr,
  125. interval: float = None,
  126. threshold: float = None):
  127. """
  128. :param target: 匹配的目标可以是RuleImage, 也可以是RuleOcr
  129. :param interval:
  130. :param threshold:
  131. :return:
  132. """
  133. if interval:
  134. if target.name in self.interval_timer:
  135. if self.interval_timer[target.name].limit != interval:
  136. self.interval_timer[target.name] = Timer(interval)
  137. else:
  138. self.interval_timer[target.name] = Timer(interval)
  139. if not self.interval_timer[target.name].reached():
  140. return False
  141. if isinstance(target, RuleOcr):
  142. appear = self.ocr_appear(target, interval)
  143. else:
  144. appear = target.match(self.device.image, threshold=threshold)
  145. if appear and interval:
  146. self.interval_timer[target.name].reset()
  147. return appear
  148. def appear_then_click(self,
  149. target: RuleImage | RuleGif,
  150. action: Union[RuleClick, RuleLongClick] = None,
  151. interval: float = None,
  152. threshold: float = None,
  153. duration: float = None):
  154. """
  155. 出现了就点击,默认点击图片的位置,如果添加了click参数,就点击click的位置
  156. :param duration: 如果是长按,可以手动指定duration,不指定默认.单位是ms!!!!
  157. :param action: 可以是RuleClick, 也可以是RuleLongClick
  158. :param target: 可以是RuleImage后续支持RuleOcr
  159. :param interval:
  160. :param threshold:
  161. :return: True or False
  162. """
  163. if not isinstance(target, RuleImage) and not isinstance(target, RuleGif):
  164. return False
  165. appear = self.appear(target, interval=interval, threshold=threshold)
  166. if appear and not action:
  167. x, y = target.coord()
  168. self.device.click(x, y, control_name=target.name)
  169. elif appear and action:
  170. x, y = action.coord()
  171. if isinstance(action, RuleLongClick):
  172. if duration is None:
  173. self.device.long_click(x, y, duration=action.duration / 1000, control_name=target.name)
  174. else:
  175. self.device.long_click(x, y, duration=duration / 1000, control_name=target.name)
  176. elif isinstance(action, RuleClick):
  177. self.device.click(x, y, control_name=target.name)
  178. return appear
  179. def wait_until_appear(self,
  180. target: RuleImage | RuleOcr,
  181. skip_first_screenshot=False,
  182. wait_time: int = None) -> bool:
  183. """
  184. 等待直到出现目标
  185. :param wait_time: 等待时间,单位秒
  186. :param target:
  187. :param skip_first_screenshot:
  188. :return:
  189. """
  190. wait_timer = None
  191. if wait_time:
  192. wait_timer = Timer(wait_time)
  193. wait_timer.start()
  194. while 1:
  195. if skip_first_screenshot:
  196. skip_first_screenshot = False
  197. else:
  198. self.screenshot()
  199. if wait_timer and wait_timer.reached():
  200. logger.warning(f"Wait until appear {target.name} timeout")
  201. return False
  202. if isinstance(target, RuleImage) and self.appear(target):
  203. return True
  204. if isinstance(target, RuleOcr) and self.ocr_appear(target):
  205. return True
  206. def wait_until_appear_then_click(self,
  207. target: RuleImage,
  208. action: Union[RuleClick, RuleLongClick] = None,
  209. wait_time: int = None) -> bool:
  210. """
  211. 等待直到出现目标,然后点击
  212. :param wait_time:
  213. :param action:
  214. :param target:
  215. :return:
  216. """
  217. if not self.wait_until_appear(target, wait_time):
  218. return False
  219. click_x, click_y = target.coord()
  220. if action is None:
  221. self.device.click(click_x, click_y, control_name=target.name)
  222. elif isinstance(action, RuleLongClick):
  223. self.device.long_click(click_x, click_y, duration=action.duration / 1000, control_name=target.name)
  224. elif isinstance(action, RuleClick):
  225. self.device.click(click_x, click_y, control_name=target.name)
  226. return True
  227. def wait_until_disappear(self, target: RuleImage) -> None:
  228. while 1:
  229. self.screenshot()
  230. if not self.appear(target):
  231. break
  232. def wait_until_stable(self,
  233. target: RuleImage,
  234. timer=Timer(0.3, count=1),
  235. timeout=Timer(5, count=10),
  236. skip_first_screenshot=True):
  237. """
  238. 等待目标稳定,即连续多次匹配成功
  239. :param target:
  240. :param timer:
  241. :param timeout:
  242. :param skip_first_screenshot:
  243. :return:
  244. """
  245. target._match_init = False
  246. timeout.reset()
  247. while 1:
  248. if skip_first_screenshot:
  249. skip_first_screenshot = False
  250. else:
  251. self.screenshot()
  252. if target._match_init:
  253. if target.match(self.device.image):
  254. if timer.reached():
  255. break
  256. else:
  257. # button.load_color(self.device.image)
  258. timer.reset()
  259. else:
  260. # target.load_color(self.device.image)
  261. target._match_init = True
  262. if timeout.reached():
  263. logger.warning(f'Wait_until_stable({target}) timeout')
  264. break
  265. def wait_animate_stable(self, rule: RuleAnimate, interval: float = None, timeout: float = None):
  266. """
  267. 不同与上面的wait_until_stable,这个将会匹配连续的两帧图片的特定区域
  268. @param rule:
  269. @param interval:
  270. @param timeout:
  271. @return:
  272. """
  273. if not isinstance(rule, RuleAnimate):
  274. rule = RuleAnimate(rule)
  275. timeout_timer = Timer(timeout).start() if timeout is not None else None
  276. while 1:
  277. self.screenshot()
  278. if interval:
  279. if rule.name in self.interval_timer:
  280. if self.interval_timer[rule.name].limit != interval:
  281. self.interval_timer[rule.name] = Timer(interval)
  282. else:
  283. self.interval_timer[rule.name] = Timer(interval)
  284. if not self.interval_timer[rule.name].reached():
  285. return False
  286. stable = rule.stable(self.device.image)
  287. if stable:
  288. if interval:
  289. self.interval_timer[rule.name].reset()
  290. break
  291. if timeout_timer and timeout_timer.reached():
  292. logger.info(f'Wait_animate_stable({rule}) timeout')
  293. break
  294. def swipe(self, swipe: RuleSwipe, interval: float = None) -> None:
  295. """
  296. :param interval:
  297. :param swipe:
  298. :return:
  299. """
  300. if not isinstance(swipe, RuleSwipe):
  301. return
  302. if interval:
  303. if swipe.name in self.interval_timer:
  304. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  305. if self.interval_timer[swipe.name].limit != interval:
  306. self.interval_timer[swipe.name] = Timer(interval)
  307. else:
  308. # 如果没有限制时间,则创建限制时间
  309. self.interval_timer[swipe.name] = Timer(interval)
  310. # 如果时间还没到达,则不执行
  311. if not self.interval_timer[swipe.name].reached():
  312. return
  313. x1, y1, x2, y2 = swipe.coord()
  314. self.device.swipe(p1=(x1, y1), p2=(x2, y2), control_name=swipe.name)
  315. # 执行后,如果有限制时间,则重置限制时间
  316. if interval:
  317. # logger.info(f'Swipe {swipe.name}')
  318. self.interval_timer[swipe.name].reset()
  319. def click(self, click: Union[RuleClick, RuleLongClick] = None, interval: float = None) -> bool:
  320. """
  321. 点击或者长按
  322. :param interval:
  323. :param click:
  324. :return:
  325. """
  326. if not click:
  327. return False
  328. if interval:
  329. if click.name in self.interval_timer:
  330. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  331. if self.interval_timer[click.name].limit != interval:
  332. self.interval_timer[click.name] = Timer(interval)
  333. else:
  334. # 如果没有限制时间,则创建限制时间
  335. self.interval_timer[click.name] = Timer(interval)
  336. # 如果时间还没到达,则不执行
  337. if not self.interval_timer[click.name].reached():
  338. return False
  339. x, y = click.coord()
  340. if isinstance(click, RuleLongClick):
  341. self.device.long_click(x=x, y=y, duration=click.duration / 1000, control_name=click.name)
  342. elif isinstance(click, RuleClick) or isinstance(click, RuleImage) or isinstance(click, RuleOcr):
  343. self.device.click(x=x, y=y, control_name=click.name)
  344. # 执行后,如果有限制时间,则重置限制时间
  345. if interval:
  346. self.interval_timer[click.name].reset()
  347. return True
  348. return False
  349. def ocr_appear(self, target: RuleOcr, interval: float = None) -> bool:
  350. """
  351. ocr识别目标
  352. :param interval:
  353. :param target:
  354. :return: 如果target有keyword或者是keyword存在,返回是True,否则返回False
  355. 但是没有指定keyword,返回的是匹配到的值,具体取决于target的mode
  356. """
  357. if not isinstance(target, RuleOcr):
  358. return None
  359. if interval:
  360. if target.name in self.interval_timer:
  361. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  362. if self.interval_timer[target.name].limit != interval:
  363. self.interval_timer[target.name] = Timer(interval)
  364. else:
  365. # 如果没有限制时间,则创建限制时间
  366. self.interval_timer[target.name] = Timer(interval)
  367. # 如果时间还没到达,则不执行
  368. if not self.interval_timer[target.name].reached():
  369. return None
  370. result = target.ocr(self.device.image)
  371. appear = False
  372. if not target.keyword or target.keyword == '':
  373. appear = False
  374. match target.mode:
  375. case OcrMode.FULL: # 全匹配
  376. appear = result != (0, 0, 0, 0)
  377. case OcrMode.SINGLE:
  378. appear = result == target.keyword
  379. case OcrMode.DIGIT:
  380. appear = result == int(target.keyword)
  381. case OcrMode.DIGITCOUNTER:
  382. appear = result == target.ocr_str_digit_counter(target.keyword)
  383. case OcrMode.DURATION:
  384. appear = result == target.parse_time(target.keyword)
  385. if interval and appear:
  386. self.interval_timer[target.name].reset()
  387. return appear
  388. def ocr_appear_click(self,
  389. target: RuleOcr,
  390. action: Union[RuleClick, RuleLongClick] = None,
  391. interval: float = None,
  392. duration: float = None) -> bool:
  393. """
  394. ocr识别目标,如果目标存在,则触发动作
  395. :param target:
  396. :param action:
  397. :param interval:
  398. :param duration:
  399. :return:
  400. """
  401. appear = self.ocr_appear(target, interval)
  402. if not appear:
  403. return False
  404. if action:
  405. x, y = action.coord()
  406. self.click(action, interval)
  407. else:
  408. x, y = target.coord()
  409. self.device.click(x=x, y=y, control_name=target.name)
  410. return True
  411. def list_find(self, target: RuleList, name: str | list[str]) -> bool | tuple:
  412. """
  413. 会一致在列表寻找目标,找到了就退出。
  414. 如果是图片列表会一直往下找
  415. 如果是纯文字的,会自动识别自己的位置,根据位置选择向前还是向后翻
  416. :param target:
  417. :param name:
  418. :return:
  419. """
  420. if target.is_image:
  421. while True:
  422. self.screenshot()
  423. result = target.image_appear(self.device.image, name=name)
  424. if result is not None:
  425. return result
  426. x1, y1, x2, y2 = target.swipe_pos()
  427. self.device.swipe(p1=(x1, y1), p2=(x2, y2))
  428. elif target.is_ocr:
  429. while True:
  430. self.screenshot()
  431. result = target.ocr_appear(self.device.image, name=name)
  432. if isinstance(result, tuple):
  433. return result
  434. after = True
  435. if isinstance(result, int) and result > 0:
  436. after = True
  437. elif isinstance(result, int) and result < 0:
  438. after = False
  439. x1, y1, x2, y2 = target.swipe_pos(number=1, after=after)
  440. self.device.swipe(p1=(x1, y1), p2=(x2, y2))
  441. sleep(1) # 等待滑动完成, 还没想好如何优化
  442. def list_appear_click(self, target: RuleList) -> bool:
  443. appear = self.list_find(target, name=target.array[0])
  444. if not appear:
  445. return False
  446. if isinstance(appear, tuple):
  447. x, y = appear
  448. self.device.click(x, y)
  449. return True
  450. return False
  451. def set_next_run(self, task: str, finish: bool = False,
  452. success: bool = None, server: bool = True, target: datetime = None) -> None:
  453. """
  454. 设置下次运行时间 当然这个也是可以重写的
  455. :param target: 可以自定义的下次运行时间
  456. :param server: True
  457. :param success: 判断是成功的还是失败的时间间隔
  458. :param task: 任务名称,大驼峰的
  459. :param finish: 是完成任务后的时间为基准还是开始任务的时间为基准
  460. :return:
  461. """
  462. if finish:
  463. start_time = datetime.now().replace(microsecond=0)
  464. else:
  465. start_time = self.start_time
  466. self.config.task_delay(task, start_time=start_time, success=success, server=server, target=target)
  467. def custom_next_run(self, task: str, custom_time: Time = None, time_delta: float = 1) -> None:
  468. """
  469. 设置下次自定义运行时间
  470. :param task: 任务名称,大驼峰的
  471. :param custom_time: 可以自定义的下次运行时间
  472. :param time_delta: 下次运行日期为几天后,默认为第二天
  473. :return:
  474. """
  475. target_time = (datetime.now() + timedelta(days=time_delta)).replace(hour=custom_time.hour,
  476. minute=custom_time.minute,
  477. second=custom_time.second)
  478. self.set_next_run(task, target=target_time)
  479. # ---------------------------------------------------------------------------------------------------------------
  480. #
  481. # ---------------------------------------------------------------------------------------------------------------
  482. def ui_reward_appear_click(self, screenshot=False) -> bool:
  483. """
  484. 如果出现 ‘获得奖励’ 就点击
  485. :return:
  486. """
  487. if screenshot:
  488. self.screenshot()
  489. return self.appear_then_click(self.I_UI_REWARD, action=self.C_UI_REWARD, interval=0.4, threshold=0.6)
  490. def ui_get_reward(self, click_image: RuleImage or RuleOcr or RuleClick, click_interval: float = 1):
  491. """
  492. 传进来一个点击图片 或是 一个ocr, 会点击这个图片,然后等待‘获得奖励’,
  493. 最后当获得奖励消失后 退出
  494. :param click_interval:
  495. :param click_image:
  496. :return:
  497. """
  498. _timer = Timer(10)
  499. _timer.start()
  500. while 1:
  501. self.screenshot()
  502. if self.ui_reward_appear_click():
  503. sleep(0.5)
  504. while 1:
  505. self.screenshot()
  506. # 等待动画结束
  507. if not self.appear(self.I_UI_REWARD, threshold=0.6):
  508. logger.info('Get reward success')
  509. break
  510. # 一直点击
  511. if self.ui_reward_appear_click():
  512. continue
  513. break
  514. if _timer.reached():
  515. logger.warning('Get reward timeout')
  516. break
  517. if isinstance(click_image, RuleImage):
  518. if self.appear_then_click(click_image, interval=click_interval):
  519. continue
  520. elif isinstance(click_image, RuleOcr):
  521. if self.ocr_appear_click(click_image, interval=click_interval):
  522. continue
  523. elif isinstance(click_image, RuleClick):
  524. if self.click(click_image, interval=click_interval):
  525. continue
  526. return True
  527. def ui_click(self, click, stop, interval=1):
  528. """
  529. 循环的一个操作,直到出现stop
  530. :param click:
  531. :param stop:
  532. :parm interval
  533. :return:
  534. """
  535. while 1:
  536. self.screenshot()
  537. if self.appear(stop):
  538. break
  539. if isinstance(click, RuleImage) and self.appear_then_click(click, interval=interval):
  540. continue
  541. if isinstance(click, RuleClick) and self.click(click, interval=interval):
  542. continue
  543. elif isinstance(click, RuleOcr) and self.ocr_appear_click(click, interval=interval):
  544. continue
  545. def ui_click_until_disappear(self, click, interval: float = 1):
  546. """
  547. 点击一个按钮直到消失
  548. :param interval:
  549. :param click:
  550. :return:
  551. """
  552. while 1:
  553. self.screenshot()
  554. if not self.appear(click):
  555. break
  556. elif self.appear_then_click(click, interval=interval):
  557. continue
  558. def ui_click_until_smt_disappear(self, click, stop, interval: float = 1):
  559. """
  560. 点击一个按钮/区域/文字直到stop消失
  561. """
  562. while 1:
  563. self.screenshot()
  564. if not self.appear(stop):
  565. break
  566. if isinstance(click, RuleImage) or isinstance(click, RuleGif):
  567. self.appear_then_click(click, interval=interval)
  568. continue
  569. if isinstance(click, RuleClick):
  570. self.click(click, interval)
  571. continue
  572. if isinstance(click, RuleOcr):
  573. self.click(click)
  574. continue