Files
plezy/lib/providers/user_profile_provider.dart
T
edde746 05fd622968 feat(emby): add Emby as a MediaBrowser backend alongside Jellyfin
Emby is Jellyfin's upstream ancestor and speaks a near-identical MediaBrowser
API, so the existing Jellyfin stack is parameterised by a `MediaBrowserDialect`
rather than forked. `JellyfinClient`, its auth service, endpoint discovery, LAN
discovery, and the add/edit connection screens all take the dialect and keep one
implementation; `MediaBackend.emby` and `ConnectionKind.emby` carry it through
the neutral models, the Drift `kind` discriminator, downloads, and caches.

Every divergence below was measured against a live Emby 4.9.5 server, not
inferred from documentation, and each is documented at its capability getter.
Jellyfin's request strings stay byte-identical so nothing about its behaviour
changes.

Routes and auth
- Emby only accepts the pre-10.9 user-scoped item routes (`/Users/{id}/Items/…`,
  `/Users/{id}/PlayedItems/…`, `/Users/{id}/FavoriteItems/…`); the unprefixed
  forms Jellyfin 10.11 added return 404.
- The API is also served under a legacy `/emby` prefix, and both dialects accept
  the token as `X-Emby-Token` or `api_key=`.
- Emby answers only its own LAN discovery datagram ("who is EmbyServer?") and
  ignores Jellyfin's; its default HTTPS port is 8920.
- No `/QuickConnect` route exists, so Quick Connect stays Jellyfin-only.

Row fields Emby withholds
- `ProductionYear`, `OfficialRating`, `PremiereDate` and `DateCreated` are absent
  from list rows unless named in `Fields`, which would otherwise strip the year
  and age-rating badge from every card in the app.
- `UserData.LastPlayedDate` never appears on a list row under `Fields=UserData`,
  `EnableUserData=true` or the user-scoped `Ids=` form — only on the single-item
  detail route, or when the Emby-specific `UserDataLastPlayedDate` token is
  requested. Without it every recency-ordered surface silently degrades to
  library-add time, and `JellyfinApiCache.applyWatchState` stamps
  `DateTime.now()` on watched rows, so an offline watch-state pull would rewrite
  the cached play time of everything it walked.

Continue Watching and Next Up
- Emby computes Next Up per series only: the library-wide `/Shows/NextUp` query
  returns nothing under every parameter combination tried. The shelf is
  therefore reconstructed from a played-episode recency scan plus one
  `/Shows/NextUp?SeriesId=` per distinct series, bounded by a shared wall clock
  that covers the scan as well — per-request timeouts cannot bound the pass
  because `MediaServerHttpClient` times the connect and receive phases
  independently. Rows are stamped with their series' newest play from the same
  response that ordered them, so no per-series enrichment request is needed.
- `/Shows/NextUp` ignores `NextUpDateCutoff`, and no server-side played-date
  filter exists to delegate to (`MinDatePlayed` and `MinDateLastPlayed` are
  ignored; `MinDateLastSaved`, `MinDateCreated` and `MinPremiereDate` filter
  unrelated dates), so the 365-day window is applied to the scanned dates.
- The resume route returns items with no saved position, including plain next
  episodes, so the Emby resume leg reads from `/Items?Filters=IsResumable`.
- Emby is ahead of Jellyfin in one place: `/Users/{id}/Items/{id}/HideFromResume`
  makes Continue Watching removal a real capability.

Everything else
- `/Sessions/Playing` and `/Sessions/Playing/Progress` reject a body with no
  `PlaySessionId` (HTTP 400), so playback reporting always sends one.
- Passing any `MediaTypes` value to the playlist query returns an empty list.
- There is no aggregate `/Items/Filters` route; the four filter facets are
  reassembled from `/Genres`, `/OfficialRatings`, `/Studios` and `/Tags`.
- Metadata writes take name-pair lists (`Genres: [{'Name': 'Action'}]`); the
  plain string array is accepted and then silently discarded.
- Custom artwork uploads must be base64 text, not raw bytes — which was broken
  for Jellyfin too and is fixed for both.
- Trickplay, media segments and lyrics 404 on Emby, so scrub previews are absent
  and intro/credit markers fall back to chapter names.

Verified against a local Emby 4.9.5 and a Jellyfin 10.11.11 control server:
onboarding, browse, detail, playable stream URLs serving real bytes, subtitle
sidecars, watch-state write and restore, hubs, cross-server aggregation and
search across both backends simultaneously.
2026-08-05 06:09:26 +02:00

322 lines
13 KiB
Dart

import 'dart:async';
import '../media/ids.dart';
import 'package:flutter/foundation.dart';
import '../connection/connection.dart';
import '../connection/connection_registry.dart';
import '../media/media_server_user_profile.dart';
import '../mixins/disposable_change_notifier_mixin.dart';
import '../profiles/active_profile_provider.dart';
import '../profiles/profile.dart';
import '../profiles/profile_connection.dart';
import '../profiles/profile_connection_registry.dart';
import '../services/jellyfin_client.dart';
import '../services/multi_server_manager.dart';
import '../services/plex_auth_service.dart';
import '../services/storage_service.dart';
import '../utils/app_logger.dart';
/// Holds the *current user's playback preferences* (audio/subtitle language
/// defaults) for the active profile. Plex profiles fetch from
/// `https://clients.plex.tv/api/v2/user`; MediaBrowser profiles use their
/// dialect's current-user route on the bound server.
///
/// Profile *identity* and *switching* are owned by [ActiveProfileProvider]
/// and [ActiveProfileBinder]. This provider is just the settings cache so
/// the video player can apply the active user's defaults.
///
/// Plex settings are fetched with the *active Home user's token* (minted via
/// `/home/users/{uuid}/switch` and cached in
/// the parent [ProfileConnection.userToken], or stored on the
/// [ProfileConnection] row for local profiles). Falling back to the
/// account-owner's token would silently return the *owner's* settings —
/// wrong defaults for kid profiles, parental restrictions, etc.
class UserProfileProvider extends ChangeNotifier with DisposableChangeNotifierMixin {
UserProfileProvider({this._storageService, this._authService});
MediaServerUserProfile? _profileSettings;
bool _isInitialized = false;
MediaServerUserProfile? get profileSettings => _profileSettings;
PlexAuthService? _authService;
StorageService? _storageService;
ConnectionRegistry? _connectionRegistry;
ProfileConnectionRegistry? _profileConnectionRegistry;
ActiveProfileProvider? _activeProfile;
MultiServerManager? _serverManager;
String? _lastSeenActiveId;
StreamSubscription<List<ProfileConnection>>? _profileConnectionSubscription;
String? _watchedProfileConnectionProfileId;
ProfileConnectionRegistry? _watchedProfileConnectionRegistry;
String? _watchedProfileConnectionFingerprint;
/// Wire the dependencies needed to resolve the active user's token / client.
/// May be called multiple times (proxy provider re-builds) — only the
/// most recent values are kept; we re-attach the listener on the new
/// [activeProfile] each time so settings refresh whenever the active
/// profile changes (or the binder finishes wiring up its token).
void attach({
required ConnectionRegistry connections,
required ActiveProfileProvider activeProfile,
required ProfileConnectionRegistry profileConnections,
MultiServerManager? serverManager,
}) {
_connectionRegistry = connections;
final profileConnectionsChanged = !identical(_profileConnectionRegistry, profileConnections);
_profileConnectionRegistry = profileConnections;
_serverManager = serverManager;
if (!identical(_activeProfile, activeProfile)) {
_activeProfile?.removeListener(_onActiveProfileChanged);
_activeProfile = activeProfile;
_lastSeenActiveId = activeProfile.activeId;
activeProfile.addListener(_onActiveProfileChanged);
}
if (profileConnectionsChanged) {
_profileConnectionSubscription?.cancel();
_profileConnectionSubscription = null;
_watchedProfileConnectionProfileId = null;
_watchedProfileConnectionRegistry = null;
}
_watchActiveProfileConnections(activeProfile.active);
}
void _onActiveProfileChanged() {
final ap = _activeProfile;
if (ap == null) return;
// Only refresh on actual profile change, not on every binding-state
// tick — refreshProfileSettings awaits awaitBindingSettle internally
// so it'll always read the fresh post-bind token.
final id = ap.activeId;
if (id == _lastSeenActiveId) return;
_lastSeenActiveId = id;
// The previous profile's settings must not bleed into the new profile
// (playback defaults, parental restrictions) while the fetch runs — or
// permanently, when the fetch fails/is unavailable.
_profileSettings = null;
safeNotifyListeners();
_watchActiveProfileConnections(ap.active);
if (_isInitialized) unawaited(refreshProfileSettings());
}
void _watchActiveProfileConnections(Profile? profile) {
final registry = _profileConnectionRegistry;
final profileId = profile?.id;
if (identical(_watchedProfileConnectionRegistry, registry) && _watchedProfileConnectionProfileId == profileId) {
return;
}
_profileConnectionSubscription?.cancel();
_profileConnectionSubscription = null;
_watchedProfileConnectionRegistry = registry;
_watchedProfileConnectionProfileId = profileId;
_watchedProfileConnectionFingerprint = null;
if (registry == null || profileId == null) return;
_profileConnectionSubscription = registry.watchForProfile(profileId).listen((rows) {
// Refresh only when something settings-relevant changed. The binder
// bumps lastUsedAt on every bind (markUsed), and drift re-emits on
// each of those writes — refetching plex.tv settings for them is
// wasted round-trips that also wake every awaitBindingSettle path.
final fingerprint = [
for (final row in rows) '${row.connectionId}|${row.userToken ?? ''}|${row.isDefault}',
].join(';');
if (fingerprint == _watchedProfileConnectionFingerprint) return;
final first = _watchedProfileConnectionFingerprint == null;
_watchedProfileConnectionFingerprint = fingerprint;
// The initial emission mirrors the subscribe-time state; the profile
// change that created this subscription already refreshes.
if (first) return;
if (_isInitialized) unawaited(refreshProfileSettings());
});
}
Future<void> initialize() async {
if (_isInitialized && _profileSettings != null) {
return;
}
appLogger.d('UserProfileProvider: initializing');
try {
_storageService = await StorageService.getInstance();
try {
await refreshProfileSettings();
} catch (e) {
appLogger.w('UserProfileProvider: failed to fetch profile settings during initialization', error: e);
}
_isInitialized = true;
} catch (e) {
appLogger.e('UserProfileProvider: critical initialization failure', error: e);
_authService = null;
_storageService = null;
_isInitialized = false;
}
}
/// Fetch the user's profile settings from the API. Best-effort: failures
/// leave [profileSettings] unchanged (cached or null).
Future<void> refreshProfileSettings() async {
_storageService ??= await StorageService.getInstance();
// Wait for the binder to finish wiring up the active profile so we
// read the freshly-minted user-token rather than racing the cache.
await _activeProfile?.awaitBindingSettle();
// A late-landing fetch must not clobber another profile's settings —
// discard the result when the active profile changed mid-flight.
final requestedId = _activeProfile?.activeId;
bool stale() => _activeProfile?.activeId != requestedId;
final settingsConnection = await _resolveActiveSettingsConnection();
final connection = settingsConnection?.connection;
if (connection is JellyfinConnection) {
final mediaBrowserClient = _resolveMediaBrowserClient(connection);
if (mediaBrowserClient == null) {
appLogger.d('UserProfileProvider: default MediaBrowser client unavailable, skipping settings refresh');
return;
}
final profile = await mediaBrowserClient.fetchUserProfile();
if (profile != null && !stale()) {
_profileSettings = profile;
safeNotifyListeners();
}
return;
}
final userToken = await _resolveActivePlexUserToken(preferred: settingsConnection);
if (userToken == null || userToken.isEmpty) {
appLogger.d('UserProfileProvider: no token for active profile, skipping settings refresh');
return;
}
try {
_authService ??= await PlexAuthService.create();
final profile = await _authService!.getUserProfile(userToken);
if (stale()) return;
_profileSettings = profile;
safeNotifyListeners();
} catch (e) {
appLogger.w('UserProfileProvider: failed to fetch user profile settings', error: e);
}
}
JellyfinClient? _resolveMediaBrowserClient(JellyfinConnection conn) {
final manager = _serverManager;
if (manager == null) return null;
final client = manager.getClient(ServerId(conn.serverMachineId));
return client is JellyfinClient ? client : null;
}
/// Resolve the Plex credential for the active profile without crossing
/// identity boundaries.
///
/// A Plex Home profile may use only the switched token stored on its exact
/// parent [ProfileConnection]. A missing or empty switched token returns
/// `null`; the parent account token represents a different user.
///
/// Local Plezy profiles keep their explicitly selected Plex account fallback
/// because that account is the identity selected by the local profile.
Future<String?> _resolveActivePlexUserToken({
({ProfileConnection profileConnection, Connection connection})? preferred,
}) async {
final connections = _connectionRegistry;
final activeProfile = _activeProfile;
if (connections == null || activeProfile == null) return null;
final profile = activeProfile.active;
if (profile == null) return null;
final connectionList = await connections.list();
final pcRegistry = _profileConnectionRegistry;
if (profile.kind == ProfileKind.plexHome) {
final parentId = profile.parentConnectionId;
final uuid = profile.plexHomeUserUuid;
if (parentId == null || uuid == null) return null;
if (!connectionList.whereType<PlexAccountConnection>().any((account) => account.id == parentId)) {
return null;
}
final pc = await pcRegistry?.get(profile.id, parentId);
return pc?.hasToken == true ? pc!.userToken : null;
}
final plexAccounts = connectionList.whereType<PlexAccountConnection>().toList();
if (plexAccounts.isEmpty) return null;
// Local profile — read the user-token off the default ProfileConnection
// (listForProfile orders default first). Each connection persists its
// own minted token, so this is already user-scoped.
final resolved = preferred ?? await _resolveActiveSettingsConnection();
if (resolved?.connection is PlexAccountConnection && resolved!.profileConnection.hasToken) {
return resolved.profileConnection.userToken;
}
final resolvedConnection = resolved?.connection;
if (resolvedConnection is PlexAccountConnection) {
return resolvedConnection.accountToken;
}
return plexAccounts.first.accountToken;
}
Future<({ProfileConnection profileConnection, Connection connection})?> _resolveActiveSettingsConnection() async {
final pcRegistry = _profileConnectionRegistry;
final activeProfile = _activeProfile;
final connections = _connectionRegistry;
if (pcRegistry == null || activeProfile == null || connections == null) return null;
final profile = activeProfile.active;
if (profile == null || profile.kind == ProfileKind.plexHome) return null;
final pcs = await pcRegistry.listForProfile(profile.id);
if (pcs.isEmpty) return null;
final connectionsList = await connections.list();
final byId = {for (final c in connectionsList) c.id: c};
for (final pc in pcs) {
final conn = byId[pc.connectionId];
if (conn != null) return (profileConnection: pc, connection: conn);
}
return null;
}
@visibleForTesting
Future<Connection?> debugResolveActiveSettingsConnectionForTesting() async {
return (await _resolveActiveSettingsConnection())?.connection;
}
@visibleForTesting
Future<String?> debugResolveActivePlexUserTokenForTesting() {
return _resolveActivePlexUserToken();
}
@visibleForTesting
String? get debugWatchedProfileConnectionProfileId => _watchedProfileConnectionProfileId;
/// Logout — clear settings and credentials. Called from the discover
/// screen "sign out" action; the rest of the teardown (clearing
/// connections, profiles, etc.) happens in the screen's logout flow.
Future<void> logout() async {
try {
_storageService ??= await StorageService.getInstance();
await _storageService!.clearUserData();
_profileSettings = null;
_authService = null;
_storageService = null;
_isInitialized = false;
appLogger.i('UserProfileProvider: logged out');
} catch (e) {
appLogger.e('UserProfileProvider: logout error', error: e);
} finally {
safeNotifyListeners();
}
}
@override
void dispose() {
_activeProfile?.removeListener(_onActiveProfileChanged);
_profileConnectionSubscription?.cancel();
super.dispose();
}
}