Repository navigation
Jellyfin Integration #234
+536
−3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| """ | ||
| Jellyfin API integration for PlexCache. | ||
| Optional second OnDeck source: Continue Watching + Next Up of every Jellyfin | ||
| user, plus active sessions. Jellyfin paths are translated into Plex paths so | ||
| the regular path_mappings handle them like any Plex item. | ||
| """ | ||
|
|
||
| import logging | ||
| from datetime import datetime, timedelta, timezone | ||
| from types import SimpleNamespace | ||
| from typing import Any, Dict, List, Optional | ||
|
|
||
| import requests | ||
|
|
||
| from core.plex_api import OnDeckItem, PlexManager | ||
|
|
||
|
|
||
| REQUEST_TIMEOUT = 30 | ||
| ITEM_FIELDS = "Path,MediaSources" | ||
| # RunTimeTicks are 100ns units | ||
| TICKS_PER_MS = 10_000 | ||
|
|
||
|
|
||
| def _parse_jellyfin_date(value: Optional[str]) -> Optional[datetime]: | ||
| """Parse a Jellyfin UTC timestamp (7 fractional digits + 'Z') to second precision.""" | ||
| if not value: | ||
| return None | ||
| try: | ||
| return datetime.fromisoformat(value[:19]).replace(tzinfo=timezone.utc) | ||
| except ValueError: | ||
| return None | ||
|
|
||
|
|
||
| class JellyfinManager: | ||
| """Fetches OnDeck-equivalent media from a Jellyfin server via an admin API key.""" | ||
|
|
||
| def __init__(self, url: str, api_key: str, path_mappings: Optional[Dict[str, str]] = None, | ||
| skip_users: Optional[List[str]] = None, session: Optional[Any] = None): | ||
| self.url = url.rstrip('/') | ||
| # Longest prefix first, so nested mappings win | ||
| self.path_mappings = sorted((path_mappings or {}).items(), key=lambda kv: len(kv[0]), reverse=True) | ||
|
Collaborator
There was a problem hiding this comment. The prefixes aren't normalized. |
||
| self.skip_users = set(skip_users or []) | ||
| self.session = session or requests.Session() | ||
| self.session.headers['Authorization'] = f'MediaBrowser Client="PlexCache-D", Token="{api_key}"' | ||
| self._ondeck_data_complete = True | ||
|
|
||
| def is_ondeck_data_complete(self) -> bool: | ||
| return self._ondeck_data_complete | ||
|
|
||
| def _get(self, path: str, **params) -> Any: | ||
| response = self.session.get(f"{self.url}{path}", params=params, timeout=REQUEST_TIMEOUT) | ||
| response.raise_for_status() | ||
| return response.json() | ||
|
|
||
| def to_plex_path(self, path: str) -> Optional[str]: | ||
| """Translate a Jellyfin path into the Plex path space. None if no mapping matches.""" | ||
| for jellyfin_prefix, plex_prefix in self.path_mappings: | ||
| if path.startswith(jellyfin_prefix): | ||
| return plex_prefix + path[len(jellyfin_prefix):] | ||
| return None | ||
|
|
||
| def _item_paths(self, item: Dict[str, Any]) -> List[str]: | ||
| """Plex-space paths of all versions of an item.""" | ||
| paths = [s['Path'] for s in item.get('MediaSources') or [] if s.get('Path')] | ||
| if not paths and item.get('Path'): | ||
| paths = [item['Path']] | ||
| result = [] | ||
| for path in dict.fromkeys(paths): | ||
| plex_path = self.to_plex_path(path) | ||
| if plex_path: | ||
| result.append(plex_path) | ||
| else: | ||
| logging.debug(f"[JELLYFIN] No jellyfin_path_mappings entry for {path}, skipping") | ||
|
Collaborator
There was a problem hiding this comment. This should be INFO, as Plex's |
||
| return result | ||
|
|
||
| def get_on_deck_media(self, days_to_monitor: int, number_episodes: int, | ||
| prefetch_minimum_minutes: int = 0) -> List[OnDeckItem]: | ||
| """Continue Watching + Next Up (with the next N episodes) for every enabled user. | ||
|
|
||
| Any failure marks the data incomplete, so move-back is skipped instead of | ||
| evicting media a Jellyfin user is still watching. | ||
| """ | ||
| self._ondeck_data_complete = True | ||
| try: | ||
| users = self._get('/Users', isDisabled='false') | ||
| except Exception as e: | ||
| logging.error(f"[JELLYFIN] Failed to list users: {type(e).__name__}: {e}") | ||
| self._ondeck_data_complete = False | ||
| return [] | ||
|
|
||
| on_deck_files: List[OnDeckItem] = [] | ||
| for user in users: | ||
| username = user.get('Name', '') | ||
| if username in self.skip_users: | ||
| logging.info(f"[JELLYFIN] [USER:{username}] Skipping for OnDeck — in skip list") | ||
| continue | ||
| try: | ||
| on_deck_files.extend(self._fetch_user_on_deck_media( | ||
| user['Id'], username, days_to_monitor, number_episodes, prefetch_minimum_minutes)) | ||
| except Exception as e: | ||
| logging.error(f"[JELLYFIN] [USER:{username}] Failed to fetch OnDeck: {type(e).__name__}: {e}") | ||
| self._ondeck_data_complete = False | ||
|
|
||
| for item in on_deck_files: | ||
| logging.debug(f"[JELLYFIN] [USER:{item.username}] OnDeck found: {item.file_path}") | ||
| return on_deck_files | ||
|
|
||
| def _fetch_user_on_deck_media(self, user_id: str, username: str, days_to_monitor: int, | ||
|
Collaborator
There was a problem hiding this comment. The list only comes back at the end, so one failed request loses everything already collected for that user. Could each item get its own try/except, so the failure only costs that item and still marks the data incomplete? We made the same kind of change on the Plex side in #204. It's also worth remembering that incomplete Jellyfin data skips array restore for Plex files as well. I think that's the right call for safety, but the warning should make it obvious that Jellyfin is what's holding things up, especially for people running it as a backup server. |
||
| number_episodes: int, prefetch_minimum_minutes: int) -> List[OnDeckItem]: | ||
| cutoff = datetime.now(timezone.utc) - timedelta(days=days_to_monitor) | ||
| resume = self._get('/UserItems/Resume', userId=user_id, fields=ITEM_FIELDS, | ||
| mediaTypes='Video').get('Items', []) | ||
| # Next Up filters by the series' last played date server-side | ||
| next_up = self._get('/Shows/NextUp', userId=user_id, fields=ITEM_FIELDS, | ||
| nextUpDateCutoff=cutoff.strftime('%Y-%m-%dT%H:%M:%SZ'), | ||
| enableResumable='true').get('Items', []) | ||
|
|
||
| on_deck_files: List[OnDeckItem] = [] | ||
| seen_ids = set() | ||
| for item in resume + next_up: | ||
| if item.get('Id') in seen_ids: | ||
| continue | ||
| seen_ids.add(item.get('Id')) | ||
| last_played = _parse_jellyfin_date((item.get('UserData') or {}).get('LastPlayedDate')) | ||
| if last_played and last_played < cutoff: | ||
| continue | ||
| if item.get('Type') == 'Episode': | ||
| self._process_episode_ondeck(item, user_id, username, number_episodes, | ||
| prefetch_minimum_minutes, on_deck_files) | ||
| elif item.get('Type') == 'Movie': | ||
| for path in self._item_paths(item): | ||
| on_deck_files.append(OnDeckItem(file_path=path, username=username, is_current_ondeck=True)) | ||
| else: | ||
| logging.debug(f"[JELLYFIN] Skipping OnDeck item '{item.get('Name')}' — type {item.get('Type')}") | ||
| return on_deck_files | ||
|
|
||
| def _process_episode_ondeck(self, item: Dict[str, Any], user_id: str, username: str, | ||
| number_episodes: int, prefetch_minimum_minutes: int, | ||
| on_deck_files: List[OnDeckItem]) -> None: | ||
| show = item.get('SeriesName') | ||
| season = item.get('ParentIndexNumber') | ||
| episode = item.get('IndexNumber') | ||
| episode_info = None | ||
| if season is not None and episode is not None: | ||
| episode_info = {'show': show, 'season': season, 'episode': episode} | ||
|
|
||
| for path in self._item_paths(item): | ||
| on_deck_files.append(OnDeckItem(file_path=path, username=username, | ||
| episode_info=episode_info, is_current_ondeck=True)) | ||
|
|
||
| if episode_info is None or not item.get('SeriesId'): | ||
| logging.warning(f"[JELLYFIN] Skipping next episode fetch for '{show}' - missing index data") | ||
| return | ||
|
|
||
| episodes = self._get(f"/Shows/{item['SeriesId']}/Episodes", userId=user_id, | ||
|
Collaborator
There was a problem hiding this comment. This pulls every episode of the show with |
||
| fields=ITEM_FIELDS, isMissing='false').get('Items', []) | ||
| # Shape Jellyfin episodes like plexapi ones to share the prefetch logic | ||
| candidates = [ | ||
| SimpleNamespace(parentIndex=e.get('ParentIndexNumber'), index=e.get('IndexNumber'), | ||
| title=e.get('Name'), grandparentTitle=show, | ||
| duration=(e.get('RunTimeTicks') or 0) // TICKS_PER_MS, item=e) | ||
| for e in episodes | ||
| ] | ||
| next_episodes = PlexManager._get_next_episodes( | ||
| candidates, season, episode, number_episodes, | ||
| prefetch_minimum_minutes=prefetch_minimum_minutes) | ||
| for next_episode in next_episodes: | ||
| next_info = {'show': show, 'season': next_episode.parentIndex, 'episode': next_episode.index} | ||
| for path in self._item_paths(next_episode.item): | ||
| on_deck_files.append(OnDeckItem(file_path=path, username=username, | ||
| episode_info=next_info, is_current_ondeck=False)) | ||
|
|
||
| def get_active_session_paths(self) -> List[str]: | ||
| """Plex-space paths of everything currently playing on Jellyfin.""" | ||
| paths = [] | ||
| try: | ||
| for session in self._get('/Sessions'): | ||
| item = session.get('NowPlayingItem') | ||
| if not item: | ||
| continue | ||
| logging.debug(f"[JELLYFIN] Active session detected, skipping: {item.get('SeriesName') or item.get('Name')}") | ||
| item_paths = self._item_paths(item) | ||
| if not item_paths and item.get('Id'): | ||
| # NowPlayingItem may come without path fields | ||
| items = self._get('/Items', ids=item['Id'], userId=session.get('UserId'), | ||
| fields=ITEM_FIELDS).get('Items', []) | ||
| item_paths = [p for i in items for p in self._item_paths(i)] | ||
| paths.extend(item_paths) | ||
| except Exception as e: | ||
| logging.warning(f"[JELLYFIN] Failed to fetch active sessions: {type(e).__name__}: {e}") | ||
| return paths | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add that this needs Jellyfin 10.9 or newer.
/UserItems/Resumeisn't in 10.8.13, so on an older server every user fetch would 404, the data would count as incomplete, and nothing would ever move back to the array.