add player filters to omit songs from queue based on criteria

This commit is contained in:
jeffvli
2025-12-03 22:11:18 -08:00
parent 5540ca4e32
commit ccdd16292a
8 changed files with 757 additions and 37 deletions
@@ -8,6 +8,7 @@ import { queryKeys } from '/@/renderer/api/query-keys';
import { albumQueries } from '/@/renderer/features/albums/api/album-api';
import { artistsQueries } from '/@/renderer/features/artists/api/artists-api';
import {
filterSongsByPlayerFilters,
getAlbumArtistSongsById,
getAlbumSongsById,
getGenreSongsById,
@@ -19,7 +20,7 @@ import { useCreateFavorite } from '/@/renderer/features/shared/mutations/create-
import { useDeleteFavorite } from '/@/renderer/features/shared/mutations/delete-favorite-mutation';
import { useSetRating } from '/@/renderer/features/shared/mutations/set-rating-mutation';
import { songsQueries } from '/@/renderer/features/songs/api/songs-api';
import { AddToQueueType, usePlayerActions } from '/@/renderer/store';
import { AddToQueueType, usePlayerActions, useSettingsStore } from '/@/renderer/store';
import { LogCategory, logFn } from '/@/renderer/utils/logger';
import { logMsg } from '/@/renderer/utils/logger-message';
import { sortSongsByFetchedOrder } from '/@/shared/api/utils';
@@ -209,22 +210,31 @@ export const PlayerProvider = ({ children }: { children: React.ReactNode }) => {
const addToQueueByData = useCallback(
(data: Song[], type: AddToQueueType, playSongId?: string) => {
const filters = useSettingsStore.getState().playback.filters;
const filteredData = filterSongsByPlayerFilters(data, filters);
if (typeof type === 'object' && 'edge' in type && type.edge !== null) {
const edge = type.edge === 'top' ? 'top' : 'bottom';
logFn.debug(logMsg[LogCategory.PLAYER].addToQueueByData, {
category: LogCategory.PLAYER,
meta: { data: data.length, edge, type, uniqueId: type.uniqueId },
meta: {
data: data.length,
edge,
filtered: filteredData.length,
type,
uniqueId: type.uniqueId,
},
});
storeActions.addToQueueByUniqueId(data, type.uniqueId, edge, playSongId);
storeActions.addToQueueByUniqueId(filteredData, type.uniqueId, edge, playSongId);
} else {
logFn.debug(logMsg[LogCategory.PLAYER].addToQueueByType, {
category: LogCategory.PLAYER,
meta: { data: data.length, type },
meta: { data: data.length, filtered: filteredData.length, type },
});
storeActions.addToQueueByType(data, type as Play, playSongId);
storeActions.addToQueueByType(filteredData, type as Play, playSongId);
}
},
[storeActions],
@@ -295,11 +305,14 @@ export const PlayerProvider = ({ children }: { children: React.ReactNode }) => {
const sortedSongs = sortSongsByFetchedOrder(songs, id, itemType);
const filters = useSettingsStore.getState().playback.filters;
const filteredSongs = filterSongsByPlayerFilters(sortedSongs, filters);
if (typeof type === 'object' && 'edge' in type && type.edge !== null) {
const edge = type.edge === 'top' ? 'top' : 'bottom';
storeActions.addToQueueByUniqueId(sortedSongs, type.uniqueId, edge);
storeActions.addToQueueByUniqueId(filteredSongs, type.uniqueId, edge);
} else {
storeActions.addToQueueByType(sortedSongs, type as Play);
storeActions.addToQueueByType(filteredSongs, type as Play);
}
} catch (err: any) {
if (instanceOfCancellationError(err)) {
+131
View File
@@ -3,6 +3,9 @@ import { QueryClient } from '@tanstack/react-query';
import { api } from '/@/renderer/api';
import { queryKeys } from '/@/renderer/api/query-keys';
import { folderQueries } from '/@/renderer/features/folders/api/folder-api';
import { PlayerFilter, useSettingsStore } from '/@/renderer/store';
import { LogCategory, logFn } from '/@/renderer/utils/logger';
import { logMsg } from '/@/renderer/utils/logger-message';
import { sortSongList } from '/@/shared/api/utils';
import {
PlaylistSongListQuery,
@@ -330,3 +333,131 @@ export const getSongById = async (args: {
totalRecordCount: 1,
};
};
const getSongFieldValue = (song: Song, field: string): boolean | null | number | string => {
switch (field) {
case 'albumArtist':
return song.albumArtists[0]?.name || '';
case 'artist':
return song.artistName || song.artists[0]?.name || '';
case 'duration':
return song.duration;
case 'favorite':
return song.userFavorite;
case 'genre':
return song.genres[0]?.name || '';
case 'name':
return song.name;
case 'note':
return song.comment || '';
case 'path':
return song.path || '';
case 'playCount':
return song.playCount;
case 'rating':
return song.userRating || 0;
case 'year':
return song.releaseYear || 0;
default:
return null;
}
};
const matchesFilter = (song: Song, filter: PlayerFilter): boolean => {
const songValue = getSongFieldValue(song, filter.field);
const filterValue = filter.value;
// Handle null/undefined values
if (songValue === null || songValue === undefined) {
return false;
}
switch (filter.operator) {
case 'contains':
return String(songValue).toLowerCase().includes(String(filterValue).toLowerCase());
case 'endsWith':
return String(songValue).toLowerCase().endsWith(String(filterValue).toLowerCase());
case 'is':
return String(songValue).toLowerCase() === String(filterValue).toLowerCase();
case 'isNot':
return String(songValue).toLowerCase() !== String(filterValue).toLowerCase();
case 'lt':
return Number(songValue) < Number(filterValue);
case 'notContains':
return !String(songValue).toLowerCase().includes(String(filterValue).toLowerCase());
case 'regex': {
try {
const regex = new RegExp(String(filterValue), 'i');
return regex.test(String(songValue));
} catch {
// Invalid regex pattern, don't match
return false;
}
}
case 'gt':
return Number(songValue) > Number(filterValue);
case 'startsWith':
return String(songValue).toLowerCase().startsWith(String(filterValue).toLowerCase());
default:
return true;
}
};
export const filterSongsByPlayerFilters = (songs: Song[], filters: PlayerFilter[]): Song[] => {
// Filter out invalid filters (missing field, operator, or value)
const validFilters = filters.filter(
(filter) =>
filter.field &&
filter.operator &&
filter.value !== undefined &&
filter.value !== null &&
filter.value !== '',
);
// If no valid filters, return all songs
if (validFilters.length === 0) {
return songs;
}
// Track filtered songs and their matching conditions
const filteredSongs: Array<{ filter: PlayerFilter; song: Song }> = [];
// Filter OUT songs that match any of the filters (exclude matching songs)
const filtered = songs.filter((song) => {
const matchingFilter = validFilters.find((filter) => matchesFilter(song, filter));
if (matchingFilter) {
filteredSongs.push({ filter: matchingFilter, song });
return false;
}
return true;
});
if (filteredSongs.length > 0) {
logFn.debug(logMsg[LogCategory.PLAYER].playerFiltersApplied, {
category: LogCategory.PLAYER,
meta: {
filteredCount: filteredSongs.length,
filteredSongs: filteredSongs.map(({ filter, song }) => ({
artist: song.artistName,
condition: {
field: filter.field,
operator: filter.operator,
value: filter.value,
},
songId: song.id,
songName: song.name,
})),
originalCount: songs.length,
remainingCount: filtered.length,
},
});
}
return filtered;
};
export const getPlayerFiltersAndFilterSongs = (songs: Song[]): Song[] => {
const state = useSettingsStore.getState();
const filters = state.playback.filters;
return filterSongsByPlayerFilters(songs, filters);
};