@@ -113,7 +128,7 @@ filename_template = "[{{ feed_title }}]\t{{ title }} ({{ published }}).html" # - id: category id (str | int) # - title: category name (str) # - parents: list of parent categories (list[Category]) -# - order: category display order, starting from 1 (0 if unknown) (int) +# - order: category display order, starting from 1 (0 if unknown, only available for ttrss) (int) # If empty, no directory will be created. # Can be set through the environment variable HTML_CATEGORY_TEMPLATE. category_template = "{% if order %}{{ '%02d' % order }} {% endif %}{{ title }}" @@ -124,6 +139,7 @@ hide_empty_categories = true # Can be set through the environment variable HTML_MAX_FILENAME_LENGTH. max_filename_length = 250 # Table mapping characters to what they will be replaced with in filenames. Useful to remove/replace characters that are not allowed in filename by your filesystem. The default should be fine for most Unix filesystems. +# Can not be set through environment variables, sorry! filename_replacement = { "/" = "⧸", "\u0000" = "" } [datetime] diff --git a/src/feather/config.py b/src/feather/config.py index b61508b..98d10f2 100644 --- a/src/feather/config.py +++ b/src/feather/config.py @@ -61,10 +61,14 @@ class Config: self.only_sync_unread_articles: bool = bool( get_config("server", "only_sync_unread_articles") ) + self.keep_read_articles_for: float = float( + get_config("server", "keep_read_articles_for") + ) self.timezone: ZoneInfo = ZoneInfo(str(get_config("datetime", "timezone"))) self.time_format: str = str(get_config("datetime", "format")) + self.write_read_articles: bool = bool(get_config("html", "write_read_articles")) self.article_template: Template = Template( str(get_config("html", "article_template")), autoescape=True ) diff --git a/src/feather/data.py b/src/feather/data.py index b9a84ca..4117545 100644 --- a/src/feather/data.py +++ b/src/feather/data.py @@ -5,7 +5,7 @@ from __future__ import annotations import os import json from abc import ABC -from datetime import datetime +from datetime import datetime, timedelta from pathlib import Path from hashlib import sha256 from tempfile import NamedTemporaryFile @@ -16,7 +16,7 @@ from feather.config import Config def sanitize_filename( config: Config, filename: str, insert_before_suffix: str = "" ) -> str: - """Escape invalid caracters and truncate the filename as per the configuration. + """Escape invalid characters and truncate the filename as per the configuration. This operates on a single filename, not a path. (insert_before_suffix will be inserted between the stem and suffix, and is assumed to not need escaping).""" filename = filename.translate(config.filename_translation) @@ -38,11 +38,15 @@ def sanitize_filename( return filename[:cutoff] + "…" + insert_before_suffix + suffix -def format_datetime(config: Config, timestamp: int) -> str: - """Format a timestamp according to the configuraiton.""" - return datetime.fromtimestamp(timestamp, config.timezone).strftime( - config.time_format - ) +def format_datetime(config: Config, timestamp: float) -> str: + """Format a timestamp according to the configuration.""" + if timestamp < 0: + date = datetime(1970, 1, 1, tzinfo=config.timezone) + timedelta( + seconds=timestamp + ) + else: + date = datetime.fromtimestamp(timestamp, config.timezone) + return date.strftime(config.time_format) def atomic_write(path: Path, content: str): @@ -99,8 +103,8 @@ class Article(ABC): # with default value unread: bool = True # if the article is unread title: str = "" # article title - published: int = 0 # article publication time (timestamp) - updated: int = 0 # article update time (timestamp) + published: float = 0.0 # article publication time (timestamp) + updated: float = 0.0 # article update time (timestamp) author: str = "" # article author summary: str = "" # article summary (HTML) content: str = "" # article content (HTML) @@ -112,6 +116,7 @@ class Article(ABC): comments_url: str = "" # article comments URL language: str = "" # article language image_url: str = "" # article main image + last_write: float = 0.0 # last time this article file was written (timestamp) def _hash_id(self): return sha256(str(self.id).encode("utf-8")).hexdigest() @@ -168,13 +173,13 @@ class Article(ABC): d["category"] = self.category.asdict() return d - def _compute_json_path(self): - self.json_path = self.config.json_root / f"{self._hash_id()}.json" + def _get_json_path(self) -> Path: + return self.config.json_root / f"{self._hash_id()}.json" def _write_json(self, recompute_path=False): """Write the JSON file associated with this article. Error if it already exists.""" if recompute_path: - self._compute_json_path() + self.json_path = self._get_json_path() stored_fields = ( "id", "unread", @@ -193,6 +198,7 @@ class Article(ABC): "language", "image_url", "html_path", + "last_write", ) article_json = {field: getattr(self, field) for field in stored_fields} article_json["category"] = self.category.asdict() @@ -225,13 +231,16 @@ class Article(ABC): html_path, config.article_template.render(self._get_template_dict()) ) # set accessed date to update time, modified to publication time - os.utime(html_path, (max(self.published, self.updated), self.published)) + os.utime(html_path, (max(int(self.published), int(self.updated)), int(self.published))) def _delete_html(self, missing_ok=False): """Delete the HTML file associated with this article.""" # Delete a HTML file for a JSON object - html_path = self.config.html_root / self.html_path - html_path.unlink(missing_ok=missing_ok) + if self.html_path is None: + return + else: + html_path = self.config.html_root / self.html_path + html_path.unlink(missing_ok=missing_ok) def has_html(self) -> bool: """Check if the HTML file associated with the article exists on disk.""" @@ -247,13 +256,15 @@ class Article(ABC): def write(self, recompute_paths=False): """Write all the files associated with this article to disk.""" - try: - self._write_html(recompute_path=recompute_paths) - except FileExistsError: - raise - except: - self._delete_html(missing_ok=True) - raise + self.last_write = datetime.now().timestamp() + if self.unread or self.config.write_read_articles: + try: + self._write_html(recompute_path=recompute_paths) + except FileExistsError: + raise + except: + self._delete_html(missing_ok=True) + raise try: self._write_json(recompute_path=recompute_paths) except FileExistsError: diff --git a/uv.lock b/uv.lock index 3b4f1f3..3e036bc 100644 --- a/uv.lock +++ b/uv.lock @@ -69,7 +69,7 @@ wheels = [ [[package]] name = "feather" -version = "1.0.0" +version = "1.1.1" source = { editable = "." } dependencies = [ { name = "google-reader" },