cron.py 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. """Cron service — lightweight scheduled-task engine backed by asyncio."""
  2. from __future__ import annotations
  3. import asyncio
  4. import json
  5. import time
  6. import uuid
  7. from dataclasses import dataclass, field
  8. from pathlib import Path
  9. from typing import Any, Awaitable, Callable, Literal
  10. # ===================================================================
  11. # Data types
  12. # ===================================================================
  13. @dataclass
  14. class CronSchedule:
  15. kind: Literal["at", "every", "cron"]
  16. at_ms: int | None = None # one-shot timestamp (ms)
  17. every_ms: int | None = None # interval (ms)
  18. expr: str | None = None # cron expression
  19. @dataclass
  20. class CronJob:
  21. id: str
  22. name: str
  23. schedule: CronSchedule
  24. message: str = ""
  25. channel: str = "cli"
  26. chat_id: str = "direct"
  27. enabled: bool = True
  28. delete_after_run: bool = False
  29. next_run_ms: int | None = None
  30. last_run_ms: int | None = None
  31. # ===================================================================
  32. # Helpers
  33. # ===================================================================
  34. def _now_ms() -> int:
  35. return int(time.time() * 1000)
  36. def _next_run(sched: CronSchedule, now_ms: int) -> int | None:
  37. """Compute the next fire time in milliseconds."""
  38. if sched.kind == "at":
  39. return sched.at_ms if sched.at_ms and sched.at_ms > now_ms else None
  40. if sched.kind == "every" and sched.every_ms and sched.every_ms > 0:
  41. return now_ms + sched.every_ms
  42. if sched.kind == "cron" and sched.expr:
  43. try:
  44. from datetime import datetime
  45. from croniter import croniter
  46. base = datetime.fromtimestamp(now_ms / 1000).astimezone()
  47. return int(croniter(sched.expr, base).get_next(datetime).timestamp() * 1000)
  48. except Exception:
  49. return None
  50. return None
  51. # ===================================================================
  52. # Service
  53. # ===================================================================
  54. class CronService:
  55. """Persists jobs to a JSON file; fires them via an asyncio timer."""
  56. def __init__(
  57. self,
  58. store_path: Path,
  59. on_job: Callable[[CronJob], Awaitable[str | None]] | None = None,
  60. ):
  61. self._path = store_path
  62. self.on_job = on_job
  63. self._jobs: list[CronJob] = []
  64. self._running = False
  65. self._timer: asyncio.Task[None] | None = None
  66. # -- lifecycle -----------------------------------------------------
  67. async def start(self) -> None:
  68. self._load()
  69. self._recompute()
  70. self._save()
  71. self._running = True
  72. self._arm()
  73. def stop(self) -> None:
  74. self._running = False
  75. if self._timer:
  76. self._timer.cancel()
  77. self._timer = None
  78. # -- public API (called by CronTool) -------------------------------
  79. def list_jobs(self) -> list[CronJob]:
  80. self._load()
  81. return [j for j in self._jobs if j.enabled]
  82. def add_job(
  83. self,
  84. name: str,
  85. schedule: CronSchedule,
  86. message: str,
  87. channel: str = "cli",
  88. chat_id: str = "direct",
  89. delete_after_run: bool = False,
  90. ) -> CronJob:
  91. self._load()
  92. job = CronJob(
  93. id=uuid.uuid4().hex[:8],
  94. name=name,
  95. schedule=schedule,
  96. message=message,
  97. channel=channel,
  98. chat_id=chat_id,
  99. delete_after_run=delete_after_run,
  100. next_run_ms=_next_run(schedule, _now_ms()),
  101. )
  102. self._jobs.append(job)
  103. self._save()
  104. self._arm()
  105. return job
  106. def remove_job(self, job_id: str) -> bool:
  107. self._load()
  108. before = len(self._jobs)
  109. self._jobs = [j for j in self._jobs if j.id != job_id]
  110. if len(self._jobs) < before:
  111. self._save()
  112. self._arm()
  113. return True
  114. return False
  115. # -- internals -----------------------------------------------------
  116. def _load(self) -> None:
  117. if not self._path.exists():
  118. self._jobs = []
  119. return
  120. try:
  121. raw = json.loads(self._path.read_text(encoding="utf-8"))
  122. self._jobs = [
  123. CronJob(
  124. id=j["id"],
  125. name=j["name"],
  126. schedule=CronSchedule(
  127. kind=j["schedule"]["kind"],
  128. at_ms=j["schedule"].get("at_ms"),
  129. every_ms=j["schedule"].get("every_ms"),
  130. expr=j["schedule"].get("expr"),
  131. ),
  132. message=j.get("message", ""),
  133. channel=j.get("channel", "cli"),
  134. chat_id=j.get("chat_id", "direct"),
  135. enabled=j.get("enabled", True),
  136. delete_after_run=j.get("delete_after_run", False),
  137. next_run_ms=j.get("next_run_ms"),
  138. last_run_ms=j.get("last_run_ms"),
  139. )
  140. for j in raw.get("jobs", [])
  141. ]
  142. except Exception:
  143. self._jobs = []
  144. def _save(self) -> None:
  145. self._path.parent.mkdir(parents=True, exist_ok=True)
  146. data = {
  147. "jobs": [
  148. {
  149. "id": j.id,
  150. "name": j.name,
  151. "schedule": {"kind": j.schedule.kind, "at_ms": j.schedule.at_ms,
  152. "every_ms": j.schedule.every_ms, "expr": j.schedule.expr},
  153. "message": j.message,
  154. "channel": j.channel,
  155. "chat_id": j.chat_id,
  156. "enabled": j.enabled,
  157. "delete_after_run": j.delete_after_run,
  158. "next_run_ms": j.next_run_ms,
  159. "last_run_ms": j.last_run_ms,
  160. }
  161. for j in self._jobs
  162. ]
  163. }
  164. self._path.write_text(json.dumps(data, indent=2, ensure_ascii=False), encoding="utf-8")
  165. def _recompute(self) -> None:
  166. now = _now_ms()
  167. for j in self._jobs:
  168. if j.enabled:
  169. j.next_run_ms = _next_run(j.schedule, now)
  170. def _arm(self) -> None:
  171. """Schedule the next timer tick."""
  172. if self._timer:
  173. self._timer.cancel()
  174. times = [j.next_run_ms for j in self._jobs if j.enabled and j.next_run_ms]
  175. if not times or not self._running:
  176. return
  177. delay_s = max(0, (min(times) - _now_ms())) / 1000
  178. async def _tick() -> None:
  179. await asyncio.sleep(delay_s)
  180. if self._running:
  181. await self._fire_due()
  182. self._timer = asyncio.create_task(_tick())
  183. async def _fire_due(self) -> None:
  184. self._load()
  185. now = _now_ms()
  186. due = [j for j in self._jobs if j.enabled and j.next_run_ms and now >= j.next_run_ms]
  187. for job in due:
  188. await self._execute(job)
  189. self._save()
  190. self._arm()
  191. async def _execute(self, job: CronJob) -> None:
  192. job.last_run_ms = _now_ms()
  193. if self.on_job:
  194. try:
  195. await self.on_job(job)
  196. except Exception:
  197. pass # best-effort
  198. # Reschedule or disable
  199. if job.schedule.kind == "at":
  200. if job.delete_after_run:
  201. self._jobs = [j for j in self._jobs if j.id != job.id]
  202. else:
  203. job.enabled = False
  204. job.next_run_ms = None
  205. else:
  206. job.next_run_ms = _next_run(job.schedule, _now_ms())