diff --git a/Dockerfile b/Dockerfile index a54c68e6..6924166d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -534,7 +534,9 @@ HEALTHCHECK --interval=1m --timeout=10s --start-period=3m CMD ["/app/healthcheck ENV PYTHONPATH="/app" \ PYTHONPYCACHEPREFIX="/config/cache/pycache" \ S6_CMD_WAIT_FOR_SERVICES_MAXTIME="0" \ - XDG_CACHE_HOME="/config/cache" + XDG_CACHE_HOME="/config/cache" \ + XDG_CONFIG_HOME="/config/tubesync" \ + XDG_STATE_HOME="/config/state" EXPOSE 4848 # Volumes diff --git a/config/root/etc/s6-overlay/s6-rc.d/tubesync-init/run b/config/root/etc/s6-overlay/s6-rc.d/tubesync-init/run index df003540..4ab92e4f 100755 --- a/config/root/etc/s6-overlay/s6-rc.d/tubesync-init/run +++ b/config/root/etc/s6-overlay/s6-rc.d/tubesync-init/run @@ -5,7 +5,7 @@ groupmod -o -g "${PGID:=911}" app usermod -o -u "${PUID:=911}" app # Ensure /config directories exist -mkdir -v -p /config/{cache,media,tasks,tubesync} +mkdir -v -p /config/{cache,media,state,tasks,tubesync} # Copy local_settings.py for the user if [ -f /config/tubesync/local_settings.py ] diff --git a/tubesync/yt_dlp_plugins/extractor/cache-filesystem.py b/tubesync/yt_dlp_plugins/extractor/cache-filesystem.py new file mode 100644 index 00000000..6a938aa6 --- /dev/null +++ b/tubesync/yt_dlp_plugins/extractor/cache-filesystem.py @@ -0,0 +1,113 @@ +from collections.abc import Generator +from common.utils import getenv +from datetime import datetime, timezone +from pathlib import Path +from yt_dlp.extractor.youtube.pot.cache import ( + PoTokenCacheProvider, + register_preference, + register_provider +) + +from yt_dlp.extractor.youtube.pot.provider import PoTokenRequest + + +@register_provider +class TubeSyncFileSystemPCP(PoTokenCacheProvider): # Provider class name must end with "PCP" + PROVIDER_VERSION = '0.0.1' + # Define a unique display name for the provider + PROVIDER_NAME = 'TubeSync-fs' + BUG_REPORT_LOCATION = 'https://github.com/meeb/tubesync/issues' + + def _now(self) -> datetime: + return datetime.now(timezone.utc) + + def _make_filename(self, key: str, expires_at: int) -> str: + return f'{expires_at or "*"}-{key}' + + def _expires(self, expires_at: int) -> datetime: + return datetime.utcfromtimestamp(expires_at).astimezone(timezone.utc) + + def _files(self, key: str) -> Generator[Path]: + return Path(self._storage_directory).glob(self._make_filename(key, 0)) + + def is_available(self) -> bool: + """ + Check if the provider is available (e.g. all required dependencies are available) + This is used to determine if the provider should be used and to provide debug information. + + IMPORTANT: This method SHOULD NOT make any network requests or perform any expensive operations. + + Since this is called multiple times, we recommend caching the result. + """ + cache_home = getenv('XDG_CACHE_HOME') + if not cache_home: + return False + # TODO: check the actual setting: cookiefile + cookie_file = Path(cache_home) / '../cookies.txt' + if not cookie_file.is_file(): + return False + directory = Path(cache_home) / 'yt-dlp/youtube-pot' + if directory.exists() and directory.is_dir(): + self._storage_directory = directory + return True + return False + + def get(self, key: str): + self.logger.trace(f'fs-get: {key=}') + # ℹ️ Similar to PO Token Providers, Cache Providers and Cache Spec Providers + # are passed down extractor args matching key youtubepot-. + # some_setting = self._configuration_arg('some_setting', default=['default_value'])[0] + found = None + now = self._now() + for file in sorted(self._files(key)): + if not file.is_file(): + continue + try: + expires_at = int(file.name.partition('-')[0]) + except ValueError: + continue + else: + if self._expires(expires_at) < now: + self.logger.trace(f'fs-get: unlinking: {file.name}') + file.unlink() + else: + self.logger.trace(f'fs-get: found: {file.name}') + found = file + + self.logger.trace(f'fs-get: {found=}') + return None if found is None else found.read_bytes().decode() + + def store(self, key: str, value: str, expires_at: int): + self.logger.trace(f'fs-store: {expires_at=} {key=}') + # ⚠ expires_at MUST be respected. + # Cache entries should not be returned if they have expired. + if self._expires(expires_at) > self._now(): + dst = Path(self._storage_directory) / self._make_filename(key, expires_at) + self.logger.trace(f'fs-store: writing: {dst.name}') + dst.write_bytes(value.encode()) + + def delete(self, key: str): + self.logger.trace(f'fs-delete: {key=}') + for file in self._files(key): + if not file.is_file(): + continue + self.logger.trace(f'fs-delete: unlinking: {file.name}') + file.unlink() + + def close(self): + # Optional close hook, called when the YoutubeDL instance is closed. + pass + +# If there are multiple PO Token Cache Providers available, you can +# define a preference function to increase/decrease the priority of providers. + +# IMPORTANT: Providers should be in preference of cache lookup time. +# For example, a memory cache should have a higher preference than a disk cache. + +# VERY IMPORTANT: yt-dlp has a built-in memory cache with a priority of 10000. +# Your cache provider should be lower than this. + + +@register_preference(TubeSyncFileSystemPCP) +def filesystem_cache_preference(provider: PoTokenCacheProvider, request: PoTokenRequest) -> int: + return 10