From 00e002faebd4f08303570053b0829ab3298941f6 Mon Sep 17 00:00:00 2001
From: Cody Robibero <cody@robibe.ro>
Date: Mon, 5 Aug 2024 16:00:54 -0600
Subject: [PATCH] Add lyric fetcher settings to library options

---
 .../libraryoptionseditor.js                   | 49 +++++++++++++++++++
 .../libraryoptionseditor.template.html        |  3 ++
 src/strings/en-us.json                        |  2 +
 3 files changed, 54 insertions(+)

diff --git a/src/components/libraryoptionseditor/libraryoptionseditor.js b/src/components/libraryoptionseditor/libraryoptionseditor.js
index fd726d4150..8b9eddd467 100644
--- a/src/components/libraryoptionseditor/libraryoptionseditor.js
+++ b/src/components/libraryoptionseditor/libraryoptionseditor.js
@@ -215,6 +215,40 @@ function renderSubtitleFetchers(page, availableOptions, libraryOptions) {
     elem.innerHTML = html;
 }
 
+function renderLyricFetchers(page, availableOptions, libraryOptions) {
+    let html = '';
+    const elem = page.querySelector('.lyricFetchers');
+
+    let plugins = availableOptions.LyricFetchers;
+    plugins = getOrderedPlugins(plugins, libraryOptions.LyricFetcherOrder || []);
+    if (!plugins.length) return html;
+
+    html += `<h3 class="checkboxListLabel">${globalize.translate('LabelLyricDownloaders')}</h3>`;
+    html += '<div class="checkboxList paperList checkboxList-paperList">';
+    console.log(libraryOptions);
+    for (let i = 0; i < plugins.length; i++) {
+        const plugin = plugins[i];
+        html += `<div class="listItem lyricFetcherItem sortableOption" data-pluginname="${escapeHtml(plugin.Name)}">`;
+        const isChecked = libraryOptions.DisabledLyricFetchers ? !libraryOptions.DisabledLyricFetchers.includes(plugin.Name) : plugin.DefaultEnabled;
+        const checkedHtml = isChecked ? ' checked="checked"' : '';
+        html += `<label class="listItemCheckboxContainer"><input type="checkbox" is="emby-checkbox" class="chkLyricFetcher" data-pluginname="${escapeHtml(plugin.Name)}" ${checkedHtml}><span></span></label>`;
+        html += '<div class="listItemBody">';
+        html += '<h3 class="listItemBodyText">';
+        html += escapeHtml(plugin.Name);
+        html += '</h3>';
+        html += '</div>';
+        if (i > 0) {
+            html += `<button type="button" is="paper-icon-button-light" title="${globalize.translate('Up')}" class="btnSortableMoveUp btnSortable" data-pluginindex="${i}"><span class="material-icons keyboard_arrow_up" aria-hidden="true"></span></button>`;
+        } else if (plugins.length > 1) {
+            html += `<button type="button" is="paper-icon-button-light" title="${globalize.translate('Down')}" class="btnSortableMoveDown btnSortable" data-pluginindex="${i}"><span class="material-icons keyboard_arrow_down" aria-hidden="true"></span></button>`;
+        }
+        html += '</div>';
+    }
+    html += '</div>';
+    html += `<div class="fieldDescription">${globalize.translate('LyricDownloadersHelp')}</div>`;
+    elem.innerHTML = html;
+}
+
 function getImageFetchersForTypeHtml(availableTypeOptions, libraryOptionsForType) {
     let html = '';
     let plugins = availableTypeOptions.ImageFetchers;
@@ -284,6 +318,7 @@ function populateMetadataSettings(parent, contentType) {
         renderMetadataReaders(parent, availableOptions.MetadataReaders);
         renderMetadataFetchers(parent, availableOptions, {});
         renderSubtitleFetchers(parent, availableOptions, {});
+        renderLyricFetchers(parent, availableOptions, {});
         renderImageFetchers(parent, availableOptions, {});
         availableOptions.SubtitleFetchers.length ? parent.querySelector('.subtitleDownloadSettings').classList.remove('hide') : parent.querySelector('.subtitleDownloadSettings').classList.add('hide');
     }).catch(() => {
@@ -460,6 +495,18 @@ function setSubtitleFetchersIntoOptions(parent, options) {
     });
 }
 
+function setLyricFetchersIntoOptions(parent, options) {
+    options.DisabledLyricFetchers = Array.prototype.map.call(Array.prototype.filter.call(parent.querySelectorAll('.chkLyricFetcher'), elem => {
+        return !elem.checked;
+    }), elem => {
+        return elem.getAttribute('data-pluginname');
+    });
+
+    options.LyricFetcherOrder = Array.prototype.map.call(parent.querySelectorAll('.lyricFetcherItem'), elem => {
+        return elem.getAttribute('data-pluginname');
+    });
+}
+
 function setMetadataFetchersIntoOptions(parent, options) {
     const sections = parent.querySelectorAll('.metadataFetcher');
     for (const section of sections) {
@@ -567,6 +614,7 @@ export function getLibraryOptions(parent) {
         return elem.getAttribute('data-lang');
     });
     setSubtitleFetchersIntoOptions(parent, options);
+    setLyricFetchersIntoOptions(parent, options);
     setMetadataFetchersIntoOptions(parent, options);
     setImageFetchersIntoOptions(parent, options);
     setImageOptionsIntoOptions(options);
@@ -622,6 +670,7 @@ export function setLibraryOptions(parent, options) {
     renderMetadataFetchers(parent, parent.availableOptions, options);
     renderImageFetchers(parent, parent.availableOptions, options);
     renderSubtitleFetchers(parent, parent.availableOptions, options);
+    renderLyricFetchers(parent, parent.availableOptions, options);
 }
 
 let currentLibraryOptions;
diff --git a/src/components/libraryoptionseditor/libraryoptionseditor.template.html b/src/components/libraryoptionseditor/libraryoptionseditor.template.html
index b1d358cc02..42adf755d7 100644
--- a/src/components/libraryoptionseditor/libraryoptionseditor.template.html
+++ b/src/components/libraryoptionseditor/libraryoptionseditor.template.html
@@ -197,6 +197,9 @@
 <div class="lyricSettingsSection hide">
     <h2>${Lyrics}</h2>
 
+    <div class="lyricFetchers advanced" style="margin-bottom: 2em;">
+    </div>
+
     <div class="checkboxContainer checkboxContainer-withDescription advanced">
         <label>
             <input type="checkbox" is="emby-checkbox" id="chkSaveLyricsLocally" />
diff --git a/src/strings/en-us.json b/src/strings/en-us.json
index 786cdc814f..a50a094005 100644
--- a/src/strings/en-us.json
+++ b/src/strings/en-us.json
@@ -736,6 +736,7 @@
     "LabelLoginDisclaimer": "Login disclaimer",
     "LabelLoginDisclaimerHelp": "A message that will be displayed at the bottom of the login page.",
     "LabelLogs": "Logs",
+    "LabelLyricDownloaders": "Lyric downloaders",
     "LabelMaxAudiobookResume": "Audiobook remaining minutes to resume",
     "LabelMaxAudiobookResumeHelp": "Titles are assumed fully played if stopped when the remaining duration is less than this value.",
     "LabelMaxBackdropsPerItem": "Maximum number of backdrops per item",
@@ -999,6 +1000,7 @@
     "Lyric": "Lyric",
     "Lyricist": "Lyricist",
     "Lyrics": "Lyrics",
+    "LyricDownloadersHelp": "Enable and rank your preferred subtitle downloaders in order of priority.",
     "ManageLibrary": "Manage library",
     "ManageRecording": "Manage recording",
     "MapChannels": "Map Channels",