base_task.py 24 KB

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