Files
actual-imap-poll/actual_imap_poll/watcher.py
T

145 lines
5.0 KiB
Python

import asyncio
import email.policy
import importlib.metadata
import importlib.util
import logging
import os
import ssl
from imaplib import IMAP4, IMAP4_SSL
from os import getenv
from pydantic import Field, SecretStr
from pydantic_settings import BaseSettings
from .model import Transaction
from .parsers import TransactionParsingFailed
CONFIG_PATH = getenv("CONFIG_PATH", "/data/config.py")
ACTUAL_PATH = "./cli.js"
TIMEOUT = 30
log = logging.getLogger("watch")
async def ticker(interval: float):
while True:
yield
await asyncio.sleep(interval)
def load_config_module(path: str):
spec = importlib.util.spec_from_file_location("config", path)
if spec is None or spec.loader is None:
raise ImportError(f"Could not find config module at {path}")
config = importlib.util.module_from_spec(spec)
spec.loader.exec_module(config)
return config
class AppConfig(BaseSettings):
imap_server: str
imap_user: str
imap_pass: SecretStr
imap_port: int = Field(default=143)
imap_mailbox: str = Field(default="INBOX")
imap_interval: int = Field(default=300)
imap_starttls: bool = Field(default_factory=lambda data: not data["imap_tls"])
imap_tls: bool = Field(default_factory=lambda data: data["imap_port"] == 993)
model_config = {"env_prefix": ""}
class App:
def __init__(self, app_config: AppConfig, parser_config_path: str):
config_mod = load_config_module(parser_config_path)
self._parsers = config_mod.PARSERS
self._config = app_config
async def submit_transaction(self, t: Transaction):
cmd = (
ACTUAL_PATH
+ f' -a "{t.account}"'
+ (f' -p "{t.payee}"' if t.payee else "")
+ f' -m "{t.amount}"'
+ f' -d "{t.date}"'
+ (f' -n "{t.notes}"' if t.notes else "")
)
log.debug("Actual command: %s", cmd)
proc = await asyncio.create_subprocess_shell(
cmd=cmd,
env=os.environ,
stderr=asyncio.subprocess.STDOUT,
stdout=asyncio.subprocess.PIPE,
)
stdout, _stderr = await proc.communicate()
if proc.returncode != 0:
log.error("Submitting to actual failed: %s", stdout)
async def process_message(self, msg_b: bytes):
log.debug("parsing message")
msg = email.message_from_bytes(msg_b, policy=email.policy.default)
log.info(
"Found message from %s to %s subject %s",
msg.get("From", "<unknown>"),
msg.get("To", "<unknown>"),
msg.get("Subject", "<no subject>"),
)
for parser in self._parsers:
log.debug("Running parser %s", type(parser).__name__)
try:
if parser.match(msg):
log.info("Parser %s claimed message", type(parser).__name__)
trans = parser.extract(msg)
if trans is not None:
log.info("Submitting transaction to Actual: %s", trans)
await self.submit_transaction(trans)
else:
log.warning("Parser %s returned None", type(parser).__name__)
except TransactionParsingFailed as e:
log.warning("Unable to parse message %s", e)
except Exception as e: # noqa: BLE001 - trap all errors in the parsers
log.warning("Unexpected exception %s", e)
async def poll_imap(self):
log.info("polling mailbox")
imap_class = IMAP4_SSL if self._config.imap_tls else IMAP4
with imap_class(
self._config.imap_server, self._config.imap_port, timeout=TIMEOUT
) as M:
if self._config.imap_starttls:
context = ssl.create_default_context()
M.starttls(context)
M.login(self._config.imap_user, self._config.imap_pass.get_secret_value())
M.select(self._config.imap_mailbox)
_status, m_set = M.search(None, "UNSEEN")
for msg_id in m_set[0].split():
log.debug("Retrieving msg id %s", msg_id)
_status, msg = M.fetch(msg_id, "(RFC822)")
if _status != "OK" or msg[0] is None:
log.error("Unable to fetch message %s", msg_id)
continue
msg_body = msg[0][1]
if isinstance(msg_body, int):
log.error("Unable to fetch message %s", msg_id)
continue
log.debug("Processing message %s", msg_id)
await self.process_message(msg_body)
async def run(self):
async for _ in ticker(self._config.imap_interval):
await self.poll_imap()
def main():
logging.basicConfig(level=getenv("LOG_LEVEL", "INFO"))
log.info(
"actual-imap-parser %s starting up",
importlib.metadata.version("actual-imap-poll"),
)
app_config = AppConfig()
log.debug("Config: %s", app_config)
app = App(app_config, CONFIG_PATH)
asyncio.run(app.run())