Skip to content

Commit

Permalink
fix(jellyfinapi): refactors jellyfin library sync to support automati…
Browse files Browse the repository at this point in the history 
…c grouping and collections

Previously, #450 added support for automatic library grouping. However, some users reported that
they were getting a 401 when using custom authentication such as LDAP. Therefore, that PR was
reverted (#524). This PR adds back the support for automatic library grouping for jellyfin
authentication users using the endpoint `/Library/MediaFolders` and fallsback to User views endpoint
if they're unable to sync the libraries (some, not all LDAP users had issues. Some reported that it
worked despite having custom authentication). Once it falls back to user views endpoint for syncing,
now it will detect if automatic grouping is enabled giving a warning that its not supported when
using some custom authentication methods. This PR also fixed collection syncing by expanding the
boxsets when syncing.

fix #256, fix #489, re #450, #524, fix #515, fix #474, fix #473
  • Loading branch information
@fallenbagel
fallenbagel committed Mar 30, 2024
1 parent 010df62 commit fa3e99a
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 33 deletions.
77 changes: 50 additions & 27 deletions server/api/jellyfin.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ export interface JellyfinUserResponse {
ServerId: string;
ServerName: string;
Id: string;
Configuration: {
GroupedFolders: string[];
};
Policy: {
IsAdministrator: boolean;
};
Expand All @@ -24,6 +27,13 @@ export interface JellyfinUserListResponse {
users: JellyfinUserResponse[];
}

interface JellyfinMediaFolder {
Name: string;
Id: string;
Type: string;
CollectionType: string;
}

export interface JellyfinLibrary {
type: 'show' | 'movie';
key: string;
Expand Down Expand Up @@ -175,46 +185,59 @@ class JellyfinAPI {

public async getLibraries(): Promise<JellyfinLibrary[]> {
try {
// TODO: Try to fix automatic grouping without fucking up LDAP users
// const libraries = await this.axios.get<any>('/Library/VirtualFolders');

const account = await this.axios.get<any>(
`/Users/${this.userId ?? 'Me'}/Views`
);
const mediaFolders = await this.axios.get<any>(`/Library/MediaFolders`);
console.log(mediaFolders.data.Items);

return this.mapLibraries(mediaFolders.data.Items);
} catch (mediaFoldersError) {
// fallback to user views to get libraries
// this only affects LDAP users
try {
const mediaFolders = await this.axios.get<any>(
`/Users/${this.userId}/Views`
);

return this.mapLibraries(mediaFolders.data.Items);
} catch (e) {
logger.error(
`Something went wrong while getting libraries from the Jellyfin server: ${e.message}`,
{ label: 'Jellyfin API' }
);
return [];
}
}
}

const response: JellyfinLibrary[] = account.data.Items.filter(
(Item: any) => {
return (
Item.Type === 'CollectionFolder' &&
Item.CollectionType !== 'music' &&
Item.CollectionType !== 'books' &&
Item.CollectionType !== 'musicvideos' &&
Item.CollectionType !== 'homevideos'
);
}
).map((Item: any) => {
private mapLibraries(mediaFolders: JellyfinMediaFolder[]): JellyfinLibrary[] {
const excludedTypes = [
'music',
'books',
'musicvideos',
'homevideos',
'boxsets',
];

return mediaFolders
.filter((Item: JellyfinMediaFolder) => {
return (
Item.Type === 'CollectionFolder' &&
!excludedTypes.includes(Item.CollectionType)
);
})
.map((Item: JellyfinMediaFolder) => {
return <JellyfinLibrary>{
key: Item.Id,
title: Item.Name,
type: Item.CollectionType === 'movies' ? 'movie' : 'show',
agent: 'jellyfin',
};
});

return response;
} catch (e) {
logger.error(
`Something went wrong while getting libraries from the Jellyfin server: ${e.message}`,
{ label: 'Jellyfin API' }
);
return [];
}
}

public async getLibraryContents(id: string): Promise<JellyfinLibraryItem[]> {
try {
const contents = await this.axios.get<any>(
`/Users/${this.userId}/Items?SortBy=SortName&SortOrder=Ascending&IncludeItemTypes=Series,Movie,Others&Recursive=true&StartIndex=0&ParentId=${id}`
`/Users/${this.userId}/Items?SortBy=SortName&SortOrder=Ascending&IncludeItemTypes=Series,Movie,Others&Recursive=true&StartIndex=0&ParentId=${id}&collapseBoxSetItems=false`
);

return contents.data.Items.filter(
Expand Down
17 changes: 16 additions & 1 deletion server/routes/settings/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ settingsRoutes.post('/jellyfin', (req, res) => {
return res.status(200).json(settings.jellyfin);
});

settingsRoutes.get('/jellyfin/library', async (req, res) => {
settingsRoutes.get('/jellyfin/library', async (req, res, next) => {
const settings = getSettings();

if (req.query.sync) {
Expand All @@ -281,6 +281,21 @@ settingsRoutes.get('/jellyfin/library', async (req, res) => {

const libraries = await jellyfinClient.getLibraries();

if (libraries.length === 0) {
// Check if no libraries are found due to the fallback to user views
// This only affects LDAP users
const account = await jellyfinClient.getUser();

console.log(account.Configuration.GroupedFolders.length);

// Automatic Library grouping is not supported when user views are used to get library
if (account.Configuration.GroupedFolders.length > 0) {
return next({ status: 501, message: 'SYNC_ERROR_GROUPED_FOLDERS' });
}

return next({ status: 404, message: 'SYNC_ERROR_NO_LIBRARIES' });
}

const newLibraries: Library[] = libraries.map((library) => {
const existing = settings.jellyfin.libraries.find(
(l) => l.id === library.key && l.name === library.title
Expand Down
42 changes: 37 additions & 5 deletions src/components/Settings/SettingsJellyfin.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ const messages = defineMessages({
librariesRemaining: 'Libraries Remaining: {count}',
startscan: 'Start Scan',
cancelscan: 'Cancel Scan',
syncFailedNoLibrariesFound: 'No libraries were found',
syncFailedAutomaticGroupedFolders:
'Custom authentication with Automatic Library Grouping not supported',
syncFailedGenericError: 'Something went wrong while syncing libraries',
});

interface Library {
Expand All @@ -70,6 +74,7 @@ const SettingsJellyfin: React.FC<SettingsJellyfinProps> = ({
showAdvancedSettings,
}) => {
const [isSyncing, setIsSyncing] = useState(false);
const toasts = useToasts();

const {
data,
Expand Down Expand Up @@ -117,11 +122,38 @@ const SettingsJellyfin: React.FC<SettingsJellyfinProps> = ({
params.enable = activeLibraries.join(',');
}

await axios.get('/api/v1/settings/jellyfin/library', {
params,
});
setIsSyncing(false);
revalidate();
try {
await axios.get('/api/v1/settings/jellyfin/library', {
params,
});
setIsSyncing(false);
revalidate();
} catch (e) {
if (e.response.data.message === 'SYNC_ERROR_GROUPED_FOLDERS') {
toasts.addToast(
intl.formatMessage(messages.syncFailedAutomaticGroupedFolders),
{
autoDismiss: true,
appearance: 'warning',
}
);
} else if (e.response.data.message === 'SYNC_ERROR_NO_LIBRARIES') {
toasts.addToast(
intl.formatMessage(messages.syncFailedNoLibrariesFound),
{
autoDismiss: true,
appearance: 'error',
}
);
} else {
toasts.addToast(intl.formatMessage(messages.syncFailedGenericError), {
autoDismiss: true,
appearance: 'error',
});
}
setIsSyncing(false);
revalidate();
}
};

const startScan = async () => {
Expand Down

0 comments on commit fa3e99a

Please sign in to comment.