Files
plezy/lib/metadata_edit/jellyfin_metadata_edit_adapter.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

368 lines
15 KiB
Dart

import '../i18n/strings.g.dart';
import '../media/media_backend.dart';
import '../media/media_item.dart';
import '../media/media_kind.dart';
import '../media/media_server_client.dart';
import '../services/jellyfin_client.dart';
import '../utils/jellyfin_time.dart';
import 'metadata_edit_models.dart';
class JellyfinMetadataEditAdapter extends MetadataEditAdapter {
final JellyfinClient client;
JellyfinMetadataEditAdapter(this.client);
@override
MediaBackend get backend => client.backend;
@override
MediaServerClient get mediaClient => client;
@override
bool supportsKind(MediaKind kind) =>
kind == MediaKind.movie || kind == MediaKind.show || kind == MediaKind.season || kind == MediaKind.episode;
@override
Future<MetadataEditDraft> load(MediaItem item) async {
final raw = await client.fetchEditableMetadataItem(item.id);
if (raw == null) {
throw StateError('Editable MediaBrowser metadata item is unavailable');
}
final values = <String, Object?>{};
_writeCommonValues(values, raw, item);
_writeArtworkValues(values, item);
return MetadataEditDraft(sourceItem: item, currentItem: item, values: values, extras: {'raw': raw});
}
@override
List<MetadataEditSection> buildSchema(MetadataEditDraft draft) {
final kind = draft.sourceItem.kind;
return [
MetadataEditSection(
id: 'basic',
title: t.metadataEdit.basicInfo,
fields: metadataBasicFields(kind, studioType: MetadataEditFieldType.stringList),
),
if (_tagFields(kind).isNotEmpty)
MetadataEditSection(id: 'tags', title: t.metadataEdit.tags, fields: _tagFields(kind)),
MetadataEditSection(id: 'artwork', title: t.metadataEdit.artwork, fields: _artworkFields(kind)),
];
}
@override
Future<bool> save(MetadataEditDraft draft) async {
final raw = draft.extras['raw'];
if (raw is! Map<String, dynamic>) return false;
final dto = Map<String, dynamic>.from(raw);
dto['ProviderIds'] = _stringMap(dto['ProviderIds']);
dto['Tags'] = _namedStringList(dto, 'Tags', 'TagItems');
dto['Genres'] = _namedStringList(dto, 'Genres', 'GenreItems');
dto['People'] = _mapList(dto['People']);
dto['Studios'] = _mapList(dto['Studios']);
dto['LockedFields'] = metadataStringList(dto['LockedFields']);
dto['LockData'] = dto['LockData'] == true;
dto.remove('Trickplay');
if (draft.fieldChanged('title')) dto['Name'] = (draft.value<String>('title') ?? '').trim();
_setChangedString(dto, draft, 'titleSort', 'ForcedSortName');
_setChangedString(dto, draft, 'originalTitle', 'OriginalTitle');
_setChangedString(dto, draft, 'contentRating', 'OfficialRating');
_setChangedString(dto, draft, 'summary', 'Overview');
if (draft.fieldChanged('originallyAvailableAt')) {
final value = draft.value<String>('originallyAvailableAt') ?? '';
dto['PremiereDate'] = _jellyfinDate(value, raw['PremiereDate']);
}
if (_listFieldChanged(draft, 'studio')) {
dto['Studios'] = _replaceNamePairs(_mapList(dto['Studios']), metadataStringList(draft.values['studio']));
}
if (draft.fieldChanged('tagline')) {
final tagline = metadataEmptyToNull(draft.value<String>('tagline'));
final existing = metadataStringList(dto['Taglines']);
dto['Taglines'] = tagline == null ? <String>[] : <String>[tagline, ...existing.skip(1)];
}
if (_listFieldChanged(draft, 'genre')) dto['Genres'] = metadataStringList(draft.values['genre']);
if (_listFieldChanged(draft, 'country')) dto['ProductionLocations'] = metadataStringList(draft.values['country']);
if (_listFieldChanged(draft, 'label')) dto['Tags'] = metadataStringList(draft.values['label']);
var peopleChanged = false;
var people = _mapList(dto['People']);
if (_listFieldChanged(draft, 'director')) {
people = _replacePeopleByType(people, 'Director', metadataStringList(draft.values['director']));
peopleChanged = true;
}
if (_listFieldChanged(draft, 'writer')) {
people = _replacePeopleByType(people, 'Writer', metadataStringList(draft.values['writer']));
peopleChanged = true;
}
if (_listFieldChanged(draft, 'producer')) {
people = _replacePeopleByType(people, 'Producer', metadataStringList(draft.values['producer']));
peopleChanged = true;
}
if (peopleChanged) dto['People'] = people;
// Emby ignores the plain `Genres`/`Tags` string lists on `POST /Items/{id}`
// and reads the `GenreItems`/`TagItems` name-pair arrays instead. The
// fetched DTO carries the *old* pairs, so mirroring unconditionally (not
// only when the field changed) is what keeps a save from silently
// reinstating the previous genres. See
// [MediaBrowserDialect.metadataWritesUseNamePairLists].
if (client.dialect.metadataWritesUseNamePairLists) {
dto['GenreItems'] = _toNamePairs(dto['Genres']);
dto['TagItems'] = _toNamePairs(dto['Tags']);
}
final success = await client.updateMetadataItem(draft.sourceItem.id, dto);
if (success) {
draft.extras['raw'] = dto;
draft.acceptChanges();
}
return success;
}
@override
Future<List<MetadataArtworkOption>> fetchArtwork(MetadataEditDraft draft, MetadataEditField field) async {
final imageType = field.artwork?.key;
if (imageType == null) return const [];
final result = await client.getRemoteImages(draft.sourceItem.id, imageType: imageType);
final images = result['Images'];
if (images is! List) return const [];
return images
.whereType<Map<String, dynamic>>()
.map((image) {
final url = image['Url'] as String? ?? '';
final thumb = image['ThumbnailUrl'] as String?;
return MetadataArtworkOption(
id: url,
thumbnailPath: (thumb == null || thumb.isEmpty) ? url : thumb,
sourceUrl: url,
provider: image['ProviderName'] as String?,
width: image['Width'] as int?,
height: image['Height'] as int?,
);
})
.where((image) => image.sourceUrl.isNotEmpty)
.toList();
}
@override
Future<bool> applyArtworkFromUrl(MetadataEditDraft draft, MetadataEditField field, String url) async {
final imageType = field.artwork?.key;
if (imageType == null || url.trim().isEmpty) return false;
return client.downloadRemoteImage(draft.sourceItem.id, imageType: imageType, imageUrl: url.trim());
}
@override
Future<bool> uploadArtwork(
MetadataEditDraft draft,
MetadataEditField field,
List<int> bytes, {
String? fileName,
}) async {
final imageType = field.artwork?.key;
if (imageType == null || bytes.isEmpty) return false;
return client.uploadItemImage(
draft.sourceItem.id,
imageType: imageType,
bytes: bytes,
contentType: _imageContentType(bytes, fileName),
);
}
@override
void syncReloadedItem(MetadataEditDraft draft, MediaItem item) {
draft.currentItem = item;
_writeArtworkValues(draft.values, item);
}
void _writeCommonValues(Map<String, Object?> values, Map<String, dynamic> raw, MediaItem item) {
values['title'] = raw['Name'] as String? ?? item.title ?? '';
values['titleSort'] = raw['ForcedSortName'] as String? ?? '';
values['originalTitle'] = raw['OriginalTitle'] as String? ?? item.originalTitle ?? '';
values['originallyAvailableAt'] =
jellyfinIsoToYmd(raw['PremiereDate'] as String?) ?? item.originallyAvailableAt ?? '';
values['contentRating'] = raw['OfficialRating'] as String? ?? item.contentRating ?? '';
final studios = _nameList(raw['Studios']);
values['studio'] = studios.isNotEmpty ? studios : metadataStringList(item.studio);
values['tagline'] = metadataFirstString(raw['Taglines']).isNotEmpty
? metadataFirstString(raw['Taglines'])
: item.tagline ?? '';
values['summary'] = raw['Overview'] as String? ?? item.summary ?? '';
values['genre'] = _namedStringList(raw, 'Genres', 'GenreItems');
values['director'] = _peopleByType(raw['People'], 'Director');
values['writer'] = _peopleByType(raw['People'], 'Writer');
values['producer'] = _peopleByType(raw['People'], 'Producer');
values['country'] = metadataStringList(raw['ProductionLocations']);
values['label'] = _namedStringList(raw, 'Tags', 'TagItems');
}
void _writeArtworkValues(Map<String, Object?> values, MediaItem item) {
values['artwork:Primary'] = item.thumbPath;
values['artwork:Backdrop'] = item.artPath;
values['artwork:Logo'] = item.clearLogoPath;
}
List<MetadataEditField> _tagFields(MediaKind kind) {
MetadataEditField tag(String id, String label) =>
MetadataEditField(id: id, label: label, type: MetadataEditFieldType.stringList);
return switch (kind) {
MediaKind.movie || MediaKind.show => [
tag('genre', t.metadataEdit.genre),
tag('director', t.metadataEdit.director),
tag('writer', t.metadataEdit.writer),
tag('producer', t.metadataEdit.producer),
tag('country', t.metadataEdit.country),
tag('label', t.metadataEdit.label),
],
MediaKind.episode => [tag('director', t.metadataEdit.director), tag('writer', t.metadataEdit.writer)],
_ => const [],
};
}
List<MetadataEditField> _artworkFields(MediaKind kind) =>
metadataArtworkFields(kind, posterKey: 'Primary', backdropKey: 'Backdrop', logoKey: 'Logo');
void _setChangedString(Map<String, dynamic> dto, MetadataEditDraft draft, String fieldId, String dtoKey) {
if (!draft.fieldChanged(fieldId)) return;
dto[dtoKey] = metadataEmptyToNull(draft.value<String>(fieldId));
}
/// Every id passed here names a `stringList` field, so the comparison is
/// order-insensitive regardless of which kind's schema is in play.
bool _listFieldChanged(MetadataEditDraft draft, String fieldId) =>
!metadataEditStringListEquals(draft.values[fieldId], draft.originalValues[fieldId]);
}
Map<String, String> _stringMap(Object? value) {
if (value is! Map) return <String, String>{};
return value.map((key, value) => MapEntry(key.toString(), value?.toString() ?? ''));
}
List<Map<String, dynamic>> _mapList(Object? value) {
if (value is! List) return <Map<String, dynamic>>[];
return value.whereType<Map>().map((item) => Map<String, dynamic>.from(item)).toList();
}
List<String> _nameList(Object? value) {
return _mapList(value)
.map((item) => item['Name'] as String?)
.whereType<String>()
.where((name) => name.trim().isNotEmpty)
.map((name) => name.trim())
.toList();
}
/// Effective value of a `Genres`/`Tags` style field, preferring the plain string
/// array and falling back to its `…Items` name-pair sibling.
///
/// Emby never returns the plain `Tags` array at all — only `TagItems`, whatever
/// `Fields` the request asks for (measured on Emby 4.9.5). Reading the plain key
/// alone would show an empty tag editor for an item that has tags and, worse,
/// write that emptiness back on the next save.
List<String> _namedStringList(Map<String, dynamic> dto, String key, String pairKey) {
final plain = metadataStringList(dto[key]);
return plain.isNotEmpty ? plain : _nameList(dto[pairKey]);
}
List<String> _peopleByType(Object? value, String type) {
return _mapList(value)
.where((person) => (person['Type'] as String?)?.toLowerCase() == type.toLowerCase())
.map((person) => person['Name'] as String?)
.whereType<String>()
.where((name) => name.trim().isNotEmpty)
.map((name) => name.trim())
.toList();
}
List<Map<String, dynamic>> _replacePeopleByType(List<Map<String, dynamic>> people, String type, List<String> names) {
final lowerType = type.toLowerCase();
final existing = people.where((person) => (person['Type'] as String?)?.toLowerCase() == lowerType).toList();
final used = <int>{};
return [
...people.where((person) => (person['Type'] as String?)?.toLowerCase() != lowerType),
...names.map((name) => _preserveNamedMap(existing, used, name, type: type)),
];
}
List<Map<String, dynamic>> _replaceNamePairs(List<Map<String, dynamic>> existing, List<String> names) {
final used = <int>{};
return names.map((name) => _preserveNamedMap(existing, used, name)).toList();
}
/// Project a `Genres`/`Tags` string list into the `[{'Name': …}]` shape Emby
/// requires on write. The server assigns the `Id` for a new entry, so omitting
/// it is correct — it resolves an existing tag by name and creates one when
/// there is no match.
List<Map<String, dynamic>> _toNamePairs(Object? names) =>
metadataStringList(names).map((name) => <String, dynamic>{'Name': name}).toList();
Map<String, dynamic> _preserveNamedMap(
List<Map<String, dynamic>> existing,
Set<int> used,
String name, {
String? type,
}) {
final trimmed = name.trim();
final lowerName = trimmed.toLowerCase();
for (var i = 0; i < existing.length; i++) {
if (used.contains(i)) continue;
final existingName = (existing[i]['Name'] as String?)?.trim().toLowerCase();
if (existingName == lowerName) {
used.add(i);
final preserved = {...existing[i], 'Name': trimmed};
if (type != null) preserved['Type'] = type;
return preserved;
}
}
final created = <String, dynamic>{'Name': trimmed};
if (type != null) created['Type'] = type;
return created;
}
String? _jellyfinDate(String value, Object? originalIso) {
final trimmed = value.trim();
if (trimmed.isEmpty) return null;
final original = originalIso as String?;
if (original != null && original.startsWith(trimmed)) {
final tIndex = original.indexOf('T');
if (tIndex >= 0) return '$trimmed${original.substring(tIndex)}';
}
return trimmed;
}
String _imageContentType(List<int> bytes, String? fileName) {
if (bytes.length >= 8 &&
bytes.first == 0x89 &&
bytes[1] == 0x50 &&
bytes[2] == 0x4e &&
bytes[3] == 0x47 &&
bytes[4] == 0x0d &&
bytes[5] == 0x0a &&
bytes[6] == 0x1a &&
bytes[7] == 0x0a) {
return 'image/png';
}
if (bytes.length >= 3 && bytes.first == 0xff && bytes[1] == 0xd8 && bytes[2] == 0xff) {
return 'image/jpeg';
}
if (bytes.length >= 6) {
final header = String.fromCharCodes(bytes.take(6));
if (header == 'GIF87a' || header == 'GIF89a') return 'image/gif';
}
if (bytes.length >= 12) {
final riff = String.fromCharCodes(bytes.take(4));
final webp = String.fromCharCodes(bytes.skip(8).take(4));
if (riff == 'RIFF' && webp == 'WEBP') return 'image/webp';
}
if (bytes.length >= 2 && bytes.first == 0x42 && bytes[1] == 0x4d) return 'image/bmp';
final lowerName = fileName?.toLowerCase() ?? '';
if (lowerName.endsWith('.png')) return 'image/png';
if (lowerName.endsWith('.jpg') || lowerName.endsWith('.jpeg')) return 'image/jpeg';
if (lowerName.endsWith('.gif')) return 'image/gif';
if (lowerName.endsWith('.webp')) return 'image/webp';
if (lowerName.endsWith('.bmp')) return 'image/bmp';
return 'image/jpeg';
}