Add sort options to playback requests

CONTRIBUTORS.md

@@ -66,6 +66,7 @@
  - [Fishbigger](https://github.com/fishbigger)
  - [sleepycatcoding](https://github.com/sleepycatcoding)
  - [TheMelmacian](https://github.com/TheMelmacian)
+ - [v0idMrK](https://github.com/v0idMrK)
 
 # Emby Contributors
 

src/components/itemContextMenu.js

@@ -9,6 +9,8 @@ import itemHelper from './itemHelper';
 import { playbackManager } from './playback/playbackmanager';
 import ServerConnections from './ServerConnections';
 import toast from './toast/toast';
+import * as userSettings from '../scripts/settings/userSettings';
+import libraryMenu from '../scripts/libraryMenu';
 
 export function getCommands(options) {
     const item = options.item;
@@ -567,6 +569,29 @@ function deleteSeriesTimer(apiClient, item, resolve, command) {
     });
 }
 
+function getSettingsKey(item) {
+    if (item.IsFolder) {
+        return 'Folder';
+    }
+    const itemType = item.MediaType;
+    switch (itemType) {
+        case 'Movie':
+        case 'BoxSet':
+        case 'Video':
+            return 'movies';
+        case 'Audio':
+            return 'songs';
+        case 'MusicAlbum':
+            return 'musicalbums';
+        case 'MusicArtist':
+            return 'musicartists';
+        case 'MusicGenre':
+            return 'genres';
+        case 'MusicPlaylist':
+            return 'musicplaylists';
+    }
+}
+
 function play(item, resume, queue, queueNext) {
     let method = 'play';
     if (queue) {
@@ -589,9 +614,12 @@ function play(item, resume, queue, queueNext) {
             serverId: item.ServerId
         });
     } else {
+        const sortParentId = item.IsFolder ? ('items-' + item.Id) : libraryMenu.getTopParentId() + '-' + getSettingsKey(item);
+        const sortValues = userSettings.getSortValues(sortParentId);
         playbackManager[method]({
             items: [item],
-            startPositionTicks: startPosition
+            startPositionTicks: startPosition,
+            queryOptions: sortValues
         });
     }
 }

src/components/playback/playbackmanager.js

@@ -145,7 +145,10 @@ function createStreamInfoFromUrlItem(item) {
 }
 
 function mergePlaybackQueries(obj1, obj2) {
-    const query = Object.assign(obj1, obj2);
+    const query = obj1;
+    for (const key in obj2) {
+        if (obj2[key] !== undefined) query[key] = obj2[key];
+    }
 
     const filters = query.Filters ? query.Filters.split(',') : [];
     if (filters.indexOf('IsNotFolder') === -1) {
@@ -1798,23 +1801,23 @@ class PlaybackManager {
                     SortBy: options.shuffle ? 'Random' : null
                 });
             } else if (firstItem.Type === 'MusicArtist') {
-                promise = getItemsForPlayback(serverId, {
+                promise = getItemsForPlayback(serverId, mergePlaybackQueries({
                     ArtistIds: firstItem.Id,
                     Filters: 'IsNotFolder',
                     Recursive: true,
                     SortBy: options.shuffle ? 'Random' : 'SortName',
                     MediaTypes: 'Audio'
-                });
+                }, queryOptions));
             } else if (firstItem.MediaType === 'Photo') {
-                promise = getItemsForPlayback(serverId, {
+                promise = getItemsForPlayback(serverId, mergePlaybackQueries({
                     ParentId: firstItem.ParentId,
                     Filters: 'IsNotFolder',
                     // Setting this to true may cause some incorrect sorting
                     Recursive: false,
-                    SortBy: options.shuffle ? 'Random' : 'SortName',
                     MediaTypes: 'Photo,Video',
+                    sortBy: options.shuffle ? 'Random' : 'SortName',
                     Limit: UNLIMITED_ITEMS
-                }).then(function (result) {
+                }, queryOptions)).then(function (result) {
                     const playbackItems = result.Items;
 
                     let index = playbackItems.map(function (i) {
@@ -1830,7 +1833,7 @@ class PlaybackManager {
                     return Promise.resolve(result);
                 });
             } else if (firstItem.Type === 'PhotoAlbum') {
-                promise = getItemsForPlayback(serverId, {
+                promise = getItemsForPlayback(serverId, mergePlaybackQueries({
                     ParentId: firstItem.Id,
                     Filters: 'IsNotFolder',
                     // Setting this to true may cause some incorrect sorting
@@ -1839,15 +1842,15 @@ class PlaybackManager {
                     // Only include Photos because we do not handle mixed queues currently
                     MediaTypes: 'Photo',
                     Limit: UNLIMITED_ITEMS
-                });
+                }, queryOptions));
             } else if (firstItem.Type === 'MusicGenre') {
-                promise = getItemsForPlayback(serverId, {
+                promise = getItemsForPlayback(serverId, mergePlaybackQueries({
                     GenreIds: firstItem.Id,
                     Filters: 'IsNotFolder',
                     Recursive: true,
                     SortBy: options.shuffle ? 'Random' : 'SortName',
                     MediaTypes: 'Audio'
-                });
+                }));
             } else if (firstItem.IsFolder && firstItem.CollectionType === 'homevideos') {
                 promise = getItemsForPlayback(serverId, mergePlaybackQueries({
                     ParentId: firstItem.Id,

src/components/shortcuts.js

@@ -11,6 +11,7 @@ import dom from '../scripts/dom';
 import recordingHelper from './recordingcreator/recordinghelper';
 import ServerConnections from './ServerConnections';
 import toast from './toast/toast';
+import * as userSettings from '../scripts/settings/userSettings';
 
 function playAllFromHere(card, serverId, queue) {
     const parent = card.parentNode;
@@ -177,6 +178,10 @@ function executeAction(card, target, action) {
 
     const item = getItemInfoFromCard(card);
 
+    const itemsContainer = dom.parentWithClass(card, 'itemsContainer');
+
+    const sortParentId = 'items-' + (item.IsFolder ? item.Id : itemsContainer?.getAttribute('data-parentid')) + '-Folder';
+
     const serverId = item.ServerId;
     const type = item.Type;
 
@@ -205,7 +210,8 @@ function executeAction(card, target, action) {
             playbackManager.play({
                 ids: [playableItemId],
                 startPositionTicks: startPositionTicks,
-                serverId: serverId
+                serverId: serverId,
+                queryOptions: userSettings.getSortValuesLegacy(sortParentId, 'SortName')
             });
         } else {
             console.warn('Unable to play item', item);

src/controllers/list.js

@@ -722,11 +722,13 @@ class ItemsView {
 
         function play() {
             const currentItem = self.currentItem;
+            const values = self.getSortValues();
 
             if (currentItem && !self.hasFilters) {
                 playbackManager.play({
                     items: [currentItem],
-                    autoplay: true
+                    autoplay: true,
+                    queryOptions: values
                 });
             } else {
                 getItems(self, self.params, currentItem, null, 0, 300).then(function (result) {
@@ -960,10 +962,7 @@ class ItemsView {
 
     getSortValues() {
         const basekey = this.getSettingsKey();
-        return {
-            sortBy: userSettings.getFilter(basekey + '-sortby') || this.getDefaultSortBy(),
-            sortOrder: userSettings.getFilter(basekey + '-sortorder') === 'Descending' ? 'Descending' : 'Ascending'
-        };
+        return userSettings.getSortValuesLegacy(basekey, this.getDefaultSortBy());
     }
 
     getDefaultSortBy() {

src/scripts/settings/userSettings.js

@@ -622,6 +622,31 @@ export class UserSettings {
     getFilter(key) {
         return this.get(key, true);
     }
+
+    /**
+     * Gets the current sort values (Legacy - Non-JSON)
+     * (old views such as list.js [Photos] will
+     * use this one)
+     * @param {string} key - Filter key.
+     * @return {Object} sortOptions object
+     */
+    getSortValuesLegacy(key, defaultSortBy) {
+        return {
+            sortBy: this.getFilter(key + '-sortby') || defaultSortBy,
+            sortOrder: this.getFilter(key + '-sortorder') === 'Descending' ? 'Descending' : 'Ascending'
+        };
+    }
+
+    /**
+     * Gets the current sort values (JSON)
+     * (new views such as MoviesView will use
+     * this one)
+     * @param {string} key - Filter key.
+     * @return {Object} sortOptions object
+     */
+    getSortValues(key) {
+        return this.loadQuerySettings(key, {});
+    }
 }
 
 export const currentSettings = new UserSettings;
@@ -672,3 +697,5 @@ export const customCss = currentSettings.customCss.bind(currentSettings);
 export const disableCustomCss = currentSettings.disableCustomCss.bind(currentSettings);
 export const getSavedView = currentSettings.getSavedView.bind(currentSettings);
 export const saveViewSetting = currentSettings.saveViewSetting.bind(currentSettings);
+export const getSortValuesLegacy = currentSettings.getSortValuesLegacy.bind(currentSettings);
+export const getSortValues = currentSettings.getSortValues.bind(currentSettings);