import os import traceback from datetime import datetime, timedelta, timezone from logging import Logger from pathlib import Path from threading import Thread from typing import Optional, Dict from bauh.api.abstract.handler import TaskManager from bauh.api.abstract.model import SuggestionPriority from bauh.api.http import HttpClient from bauh.commons.suggestions import parse from bauh.gems.debian import DEBIAN_ICON_PATH, DEBIAN_CACHE_DIR from bauh.view.util.translation import I18n class DebianSuggestionsDownloader(Thread): _file_suggestions: Optional[str] = None _file_suggestions_ts: Optional[str] = None _url_suggestions: Optional[str] = None @classmethod def file_suggestions(cls) -> str: if cls._file_suggestions is None: cls._file_suggestions = f'{DEBIAN_CACHE_DIR}/suggestions.txt' return cls._file_suggestions @classmethod def file_suggestions_timestamp(cls) -> str: if cls._file_suggestions_ts is None: cls._file_suggestions_ts = f'{cls.file_suggestions()}.ts' return cls._file_suggestions_ts def __init__(self, logger: Logger, http_client: HttpClient, i18n: I18n, file_url: Optional[str]): super(DebianSuggestionsDownloader, self).__init__() self._log = logger self.i18n = i18n self.http_client = http_client self._taskman: Optional[TaskManager] = None if file_url: self._file_url = file_url else: self._file_url = 'https://raw.githubusercontent.com/vinifmor/bauh-files/master/debian/suggestions_v1.txt' self.task_id = 'debian.suggs' def register_task(self, taskman: Optional[TaskManager]): self._taskman = taskman if taskman: self._taskman.register_task(id_=self.task_id, label=self.i18n['task.download_suggestions'], icon_path=DEBIAN_ICON_PATH) def is_local_suggestions_file(self) -> bool: return self._file_url and self._file_url.startswith('/') @property def taskman(self) -> TaskManager: if self._taskman is None: self._taskman = TaskManager() return self._taskman def should_download(self, debian_config: dict, only_positive_exp: bool = False) -> bool: if not self._file_url: self._log.error("No Debian suggestions file URL defined") return False if self.is_local_suggestions_file(): return False try: exp_hours = int(debian_config['suggestions.exp']) except ValueError: self._log.error(f"The Debian configuration property 'suggestions.expiration' has a non int value set: " f"{debian_config['suggestions']['expiration']}") return not only_positive_exp if exp_hours <= 0: self._log.info("Suggestions cache is disabled") return not only_positive_exp if not os.path.exists(self.file_suggestions()): self._log.info(f"'{self.file_suggestions()}' not found. It must be downloaded") return True if not os.path.exists(self.file_suggestions()): self._log.info(f"'{self.file_suggestions()}' not found. The suggestions file must be downloaded.") return True with open(self.file_suggestions_timestamp()) as f: timestamp_str = f.read() try: suggestions_timestamp = datetime.fromtimestamp(float(timestamp_str), tz=timezone.utc) except Exception: self._log.error(f'Could not parse the Debian cached suggestions timestamp: {timestamp_str}') traceback.print_exc() return True update = suggestions_timestamp + timedelta(hours=exp_hours) <= datetime.now(timezone.utc) return update def _save(self, text: str, timestamp: float): if not self._file_url: self._log.error("No Debian suggestions file URL defined") return if self.is_local_suggestions_file(): return False self._log.info(f"Caching suggestions to '{self.file_suggestions()}'") cache_dir = os.path.dirname(self.file_suggestions()) try: Path(cache_dir).mkdir(parents=True, exist_ok=True) cache_dir_ok = True except OSError: self._log.error(f"Could not create cache directory '{cache_dir}'") traceback.print_exc() cache_dir_ok = False if cache_dir_ok: try: with open(self.file_suggestions(), 'w+') as f: f.write(text) except Exception: self._log.error(f"An exception happened while writing the file '{self.file_suggestions()}'") traceback.print_exc() try: with open(self.file_suggestions_timestamp(), 'w+') as f: f.write(str(timestamp)) except Exception: self._log.error(f"An exception happened while writing the file '{self.file_suggestions_timestamp()}'") traceback.print_exc() def read_cached(self) -> Optional[Dict[str, SuggestionPriority]]: if not self._file_url: self._log.error("No Debian suggestions file URL defined") return if self.is_local_suggestions_file(): file_path, log_ref = self._file_url, 'local' else: file_path, log_ref = self.file_suggestions(), 'cached' self._log.info(f"Reading {log_ref} suggestions file {file_path}") try: with open(file_path) as f: sugs_str = f.read() except FileNotFoundError: self._log.warning(f"The {log_ref} suggestions file does not exist ({file_path})") return except OSError: self._log.warning(f"Could not read from the {log_ref} suggestions file ({file_path})") traceback.print_exc() return if not sugs_str: self._log.warning(f"The {log_ref} suggestions file '{file_path}' is empty") return return parse(sugs_str, self._log, 'Debian') def download(self) -> Optional[Dict[str, SuggestionPriority]]: if not self._file_url: self._log.error("No Debian suggestions file URL defined") return self.taskman.update_progress(self.task_id, progress=1, substatus=None) self._log.info(f"Downloading Debian suggestions from {self._file_url}") res = self.http_client.get(self._file_url) suggestions = None if res.status_code == 200 and res.text: self.taskman.update_progress(self.task_id, progress=50, substatus=None) suggestions = parse(res.text, self._log, 'Debian') if suggestions: self._save(text=res.text, timestamp=datetime.now(timezone.utc).timestamp()) else: self._log.warning("No Debian suggestions to cache") else: self._log.warning(f"Could not retrieve Debian suggestions. " f"Response (status={res.status_code}, text={res.text})") self.taskman.update_progress(self.task_id, progress=100, substatus=None) self.taskman.finish_task(self.task_id) return suggestions def read(self, debian_config: dict) -> Optional[Dict[str, int]]: if not self._file_url: self._log.error("No Debian suggestions file URL defined") return if self.is_local_suggestions_file() or not self.should_download(debian_config=debian_config): return self.read_cached() return self.download() def run(self): self.download()