Files
plezy/lib/services/jellyfin_client/parts/metadata_edit.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

85 lines
3.1 KiB
Dart

part of '../../jellyfin_client.dart';
mixin _JellyfinMetadataEditMethods on _JellyfinClientInternals {
Future<Map<String, dynamic>?> fetchEditableMetadataItem(String itemId) async {
if (isOfflineMode) return null;
final response = await _http.get('/Users/${_segment(connection.userId)}/Items/${_segment(itemId)}');
if (response.statusCode == 404) return null;
throwIfHttpError(response);
final data = response.data;
return data is Map<String, dynamic> ? data : null;
}
Future<bool> updateMetadataItem(String itemId, Map<String, dynamic> item) async {
final response = await _http.post('/Items/${_segment(itemId)}', body: item);
throwIfHttpError(response);
await _deleteMetadataEditCache(itemId);
return response.statusCode >= 200 && response.statusCode < 300;
}
Future<Map<String, dynamic>> getRemoteImages(
String itemId, {
required String imageType,
int startIndex = 0,
int limit = 60,
String? providerName,
bool includeAllLanguages = false,
}) async {
final response = await _http.get(
'/Items/${_segment(itemId)}/RemoteImages',
queryParameters: {
'type': imageType,
'startIndex': startIndex,
'limit': limit,
if (providerName != null && providerName.isNotEmpty) 'providerName': providerName,
'includeAllLanguages': includeAllLanguages,
},
);
throwIfHttpError(response);
final data = response.data;
return data is Map<String, dynamic> ? data : const <String, dynamic>{};
}
Future<bool> downloadRemoteImage(String itemId, {required String imageType, required String imageUrl}) async {
final response = await _http.post(
'/Items/${_segment(itemId)}/RemoteImages/Download',
queryParameters: {'type': imageType, 'imageUrl': imageUrl},
);
throwIfHttpError(response);
await _deleteMetadataEditCache(itemId);
return response.statusCode >= 200 && response.statusCode < 300;
}
/// Upload custom artwork for [itemId].
///
/// The body must be base64 **text**, not the raw bytes: both dialects reject
/// a binary body with HTTP 500 (Emby 4.9.5 says so explicitly — `The input is
/// not a valid Base-64 string` — and Jellyfin 10.11 answers a bare
/// `Error processing request.`), and both accept the encoded form with 204.
/// The `Content-Type` still names the *image* type, which is how the server
/// decides the on-disk extension.
Future<bool> uploadItemImage(
String itemId, {
required String imageType,
required List<int> bytes,
required String contentType,
}) async {
final response = await _http.post(
'/Items/${_segment(itemId)}/Images/${_segment(imageType)}',
body: base64Encode(bytes),
headers: {'Content-Type': contentType},
);
throwIfHttpError(response);
await _deleteMetadataEditCache(itemId);
return response.statusCode >= 200 && response.statusCode < 300;
}
Future<void> _deleteMetadataEditCache(String itemId) async {
try {
await cache.deleteForItem(ServerId(cacheServerId), itemId);
} catch (e, st) {
appLogger.w('Jellyfin metadata edit cache invalidation failed', error: e, stackTrace: st);
}
}
}