Source: home.js

  1. "use strict";
  2. // SPDX-License-Identifier: GPL-3.0-or-later
  3. // myMPD (c) 2018-2025 Juergen Mang <mail@jcgames.de>
  4. // https://github.com/jcorporation/mympd
  6. /** @module home_js */
  8. /**
  9.  * Adds a link to a view to the homescreen
  10.  * @returns {void}
  11.  */
  12. //eslint-disable-next-line no-unused-vars
  13. function addViewToHome() {
  14.     _addHomeIcon('appGoto', '', 'preview', '', [app.current.card, app.current.tab, app.current.view,
  15.         app.current.offset, app.current.limit, app.current.filter, app.current.sort, app.current.tag, app.current.search]);
  16. }
  18. /**
  19.  * Adds a modal shortcut to the homescreen
  20.  * @returns {void}
  21.  */
  22. //eslint-disable-next-line no-unused-vars
  23. function addOpenModalToHome() {
  24.     _addHomeIcon('openModal', '', 'web_asset', '', []);
  25. }
  27. /**
  28.  * Adds a external link to the homescreen
  29.  * @returns {void}
  30.  */
  31. //eslint-disable-next-line no-unused-vars
  32. function addExternalLinkToHome() {
  33.     _addHomeIcon('openExternalLink', '', 'link', '', []);
  34. }
  36. /**
  37.  * Adds a script to the homescreen
  38.  * @param {string} name name for the home icon
  39.  * @param {object} script script object
  40.  * @returns {void}
  41.  */
  42. //eslint-disable-next-line no-unused-vars
  43. function addScriptToHome(name, script) {
  44.     const options = [script.script, script.arguments.join(',')];
  45.     _addHomeIcon('execScriptFromOptions', name, 'code', '', options);
  46. }
  48. /**
  49.  * Adds a playlist to the homescreen
  50.  * @param {string} uri uri of the playlist
  51.  * @param {string} type one of plist, smartpls
  52.  * @param {string} name name for the home icon
  53.  * @returns {void}
  54.  */
  55. //eslint-disable-next-line no-unused-vars
  56. function addPlistToHome(uri, type, name) {
  57.     _addHomeIcon('replaceQueue', name, 'list', '', [type, uri]);
  58. }
  60. /**
  61.  * Adds a webradio favorite to the homescreen
  62.  * @param {string} uri uri of the webradio favorite
  63.  * @param {string} type must be webradio
  64.  * @param {string} name name for the home icon
  65.  * @param {string} image image for the home icon
  66.  * @returns {void}
  67.  */
  68. //eslint-disable-next-line no-unused-vars
  69. function addRadioFavoriteToHome(uri, type, name, image) {
  70.     _addHomeIcon('replaceQueue', name, '', image, [type, uri]);
  71. }
  73. /**
  74.  * Adds a webradioDB entry to the homescreen
  75.  * @param {string} uri uri of the stream
  76.  * @param {string} type must be stream
  77.  * @param {string} name name for the home icon
  78.  * @param {string} image image for the home icon
  79.  * @returns {void}
  80.  */
  81. //eslint-disable-next-line no-unused-vars
  82. function addWebRadiodbToHome(uri, type, name, image) {
  83.     _addHomeIcon('replaceQueue', name, '', image, [type, uri]);
  84. }
  86. /**
  87.  * Adds a directory to the homescreen
  88.  * @param {string} uri directory uri
  89.  * @param {string} name name for the home icon
  90.  * @returns {void}
  91.  */
  92. //eslint-disable-next-line no-unused-vars
  93. function addDirToHome(uri, name) {
  94.     if(uri === undefined) {
  95.         uri = app.current.filter;
  96.         name = basename(app.current.filter, false);
  97.     }
  98.     _addHomeIcon('replaceQueue', name, 'folder_open', '', ['dir', uri]);
  99. }
  101. /**
  102.  * Adds the current directory search to the homescreen
  103.  * @returns {void}
  104.  */
  105. //eslint-disable-next-line no-unused-vars
  106. function addSearchDirToHome() {
  107.     if (app.current.search === '') {
  108.         // Search is empty, add a dir to home screen
  109.         return addDirToHome(undefined, undefined);
  110.     }
  111.     // Add a saved search to home screen
  112.     const expression = createBaseSearchExpression(app.current.filter, app.current.search);
  113.     const name = basename(app.current.filter, false) + ' (' + app.current.search + ')';
  114.     _addHomeIcon('replaceQueue', name, 'saved_search', '', ['search', expression]);
  115. }
  117. /**
  118.  * Adds a song or stream to the homescreen
  119.  * @param {string} uri song or stream uri
  120.  * @param {string} type one of song, stream
  121.  * @param {string} name name for the home icon
  122.  * @returns {void}
  123.  */
  124. //eslint-disable-next-line no-unused-vars
  125. function addSongToHome(uri, type, name) {
  126.     const ligature = type === 'song'
  127.         ? 'music_note'
  128.         : 'stream';
  129.     _addHomeIcon('replaceQueue', name, ligature, '', [type, uri]);
  130. }
  132. /**
  133.  * Adds the current search to the homescreen
  134.  * @returns {void}
  135.  */
  136. //eslint-disable-next-line no-unused-vars
  137. function addSearchToHome() {
  138.     _addHomeIcon('replaceQueue', tn('Current search'), 'saved_search', '', ['search', app.current.search, app.current.sort.tag, app.current.sort.desc]);
  139. }
  141. /**
  142.  * Adds an album to the homescreen
  143.  * @param {string} albumId the albumid
  144.  * @param {string} name name for the home icon
  145.  * @param {string} image image for the home icon
  146.  * @returns {void}
  147.  */
  148. //eslint-disable-next-line no-unused-vars
  149. function addAlbumToHome(albumId, name, image) {
  150.     if (image === '') {
  151.         _addHomeIcon('replaceQueue', name, 'album', '', ['album', albumId]);
  152.     }
  153.     else {
  154.         _addHomeIcon('replaceQueue', name, '', image, ['album', albumId]);
  155.     }
  156. }
  158. /**
  159.  * Adds a new stream to the homescreen
  160.  * @returns {void}
  161.  */
  162. //eslint-disable-next-line no-unused-vars
  163. function addStreamToHome() {
  164.     const action = getRadioBoxValueId('modalPlaylistAddToPos') + 'Queue';
  165.     const uri = elGetById('modalPlaylistAddToUrisInput').value;
  166.     _addHomeIcon(action, '', 'stream', '', ['stream', uri]);
  167. }
  169. /**
  170.  * Duplicates a home icon
  171.  * @param {number} pos home icon position
  172.  * @returns {void}
  173.  */
  174. //eslint-disable-next-line no-unused-vars
  175. function duplicateHomeIcon(pos) {
  176.     _editHomeIcon(pos, false, "Duplicate home icon");
  177. }
  179. /**
  180.  * Opens the edit home icon dialog
  181.  * @param {number} pos home icon position
  182.  * @returns {void}
  183.  */
  184. //eslint-disable-next-line no-unused-vars
  185. function editHomeIcon(pos) {
  186.     _editHomeIcon(pos, true, "Edit home icon");
  187. }
  189. /**
  190.  * Deletes a home icon
  191.  * @param {number} pos home icon position
  192.  * @returns {void}
  193.  */
  194. //eslint-disable-next-line no-unused-vars
  195. function deleteHomeIcon(pos) {
  196.     sendAPI("MYMPD_API_HOME_ICON_RM", {"pos": pos}, null, false);
  197. }
  199. /**
  200.  * Executes the home icon action
  201.  * @param {number} pos home icon position
  202.  * @returns {void}
  203.  */
  204. //eslint-disable-next-line no-unused-vars
  205. function executeHomeIcon(pos) {
  206.     const el = elGetById('HomeList').children[pos].firstChild;
  207.     parseCmd(null, getData(el, 'href'));
  208. }
  210. /**
  211.  * Executes the home icon action
  212.  * @param {number} pos home icon position
  213.  * @returns {void}
  214.  */
  215. //eslint-disable-next-line no-unused-vars
  216. function refreshHomeWidget(pos) {
  217.     const el = elGetById('HomeList').children[pos].firstChild;
  218.     updateHomeWidget(el);
  219. }
  221. /**
  222.  * Opens the link in a new window
  223.  * @param {string} link uri to open
  224.  * @returns {void}
  225.  */
  226. //eslint-disable-next-line no-unused-vars
  227. function openExternalLink(link) {
  228.     window.open(link);
  229. }
  231. /**
  232.  * Goto handler for home icons
  233.  * @param {string} type one of dir, search, album, plist, smartpls
  234.  * @param {Array} options type = search: search expression, sort, sortdec
  235.  *                        type = album: albumId,
  236.  *                        else uri of directory or playlist
  237.  * @returns {void}
  238.  */
  239. //eslint-disable-next-line no-unused-vars
  240. function homeIconGoto(type, options) {
  241.     switch(type) {
  242.         case 'dir':
  243.             gotoFilesystem(options[0], type);
  244.             break;
  245.         case 'search':
  246.             elGetById('SearchSearchStr').value = '';
  247.             appGoto('Search', undefined, undefined, 0, undefined, 'any', {'tag': options[1], 'desc': options[2]}, '', options[0]);
  248.             break;
  249.         case 'album':
  250.             //uri = AlbumId
  251.             gotoAlbum(options[0]);
  252.             break;
  253.         case 'plist':
  254.         case 'smartpls':
  255.             gotoPlaylist(options[0]);
  256.             break;
  257.         default:
  258.             logError('Invalid type: ' + type);
  259.     }
  260. }