app/js/modules/ui.js

  1. /**
  2.  * @file Contains all ui functions
  3.  * @author yafp
  4.  * @module ui
  5.  */
  6. 'use strict'
  8. // ----------------------------------------------------------------------------
  9. // REQUIRE MODULES
  10. // ----------------------------------------------------------------------------
  11. //
  12. const utils = require('./utils.js')
  13. const ffmpeg = require('./ffmpeg.js')
  14. const youtubeDl = require('./youtubeDl.js')
  15. const sentry = require('./sentry.js')
  17. // ----------------------------------------------------------------------------
  18. // VARIABLES
  19. // ----------------------------------------------------------------------------
  20. //
  21. var distractEnabler = 0
  22. var arrayUserUrls = [] // contains the urls which should be downloaded
  23. var arrayUserUrlsN = []
  25. /**
  26. * @function windowMainApplicationStateSet
  27. * @summary Updates the application state information
  28. * @description Updates the applicationState in globalObject. Updates the application state displayed in the UI. Starts or stops the spinner depending on the state
  29. * @param {string} [newState] - String which defines the new state of the application
  30. */
  31. function windowMainApplicationStateSet (newState = 'idle') {
  32.     if (newState === 'Download in progress') { // #97
  33.         // enable powerSaveBlocker
  34.         const { ipcRenderer } = require('electron')
  35.         utils.writeConsoleMsg('info', 'windowMainApplicationStateSet ::: Trying to enable the PowerSaveBlocker now, as media-dupes is currently downloading.')
  36.         ipcRenderer.send('enablePowerSaveBlocker')
  37.     }
  39.     utils.globalObjectSet('applicationState', newState) // update the global object
  40.     utils.writeConsoleMsg('info', 'windowMainApplicationStateSet ::: Setting application state to: _' + newState + '_.')
  42.     if (newState === 'idle') {
  43.         newState = ' '
  44.         windowMainLoadingAnimationHide()
  45.     } else {
  46.         windowMainLoadingAnimationShow()
  47.     }
  48.     $('#applicationState').html(newState) // update the main ui
  49. }
  51. /**
  52. * @function windowMainLoadingAnimationShow
  53. * @summary Shows the loading animation / download spinner
  54. * @description Shows the loading animation / download spinner. applicationStateSet() is using this function
  55. */
  56. function windowMainLoadingAnimationShow () {
  57.     // if ( $('#md_spinner').attr( "hidden" )) { // only if it isnt already displayed
  58.     if ($('#div').data('hidden', true)) { // only if it isnt already displayed
  59.         utils.writeConsoleMsg('info', 'windowMainLoadingAnimationShow ::: Show spinner')
  60.         $('#md_spinner').attr('hidden', false)
  61.     }
  62. }
  64. /**
  65. * @function windowMainLoadingAnimationHide
  66. * @summary Hides the loading animation / download spinner
  67. * @description Hides the loading animation / download spinner. applicationStateSet() is using this function
  68. */
  69. function windowMainLoadingAnimationHide () {
  70.     if ($('#div').data('hidden', false)) { // only if it isnt already hidden
  71.         utils.writeConsoleMsg('info', 'windowMainLoadingAnimationHide ::: Hide spinner')
  72.         $('#md_spinner').attr('hidden', true)
  73.     }
  74. }
  76. /**
  77. * @function windowMainButtonsOthersEnable
  78. * @summary Enables some of the footer buttons when a download is finished
  79. * @description Is executed when a download task has ended by the user
  80. */
  81. function windowMainButtonsOthersEnable () {
  82.     // enable some buttons
  83.     $('#inputNewUrl').prop('disabled', false) // url input field
  84.     $('#buttonShowHelp').prop('disabled', false) // help / intro
  85.     utils.writeConsoleMsg('info', 'windowMainButtonsOthersEnable ::: Did enable some other UI elements')
  86. }
  88. /**
  89. * @function windowMainButtonsOthersDisable
  90. * @summary Disables some of the footer buttons while a download is running
  91. * @description Is executed when a download task is started by the user
  92. */
  93. function windowMainButtonsOthersDisable () {
  94.     // disable some buttons
  95.     $('#inputNewUrl').prop('disabled', true) // url input field
  96.     $('#buttonShowHelp').prop('disabled', true) // help / intro
  97.     utils.writeConsoleMsg('info', 'windowMainButtonsOthersDisable ::: Did disable some other UI elements')
  98. }
  100. /**
  101. * @function windowMainButtonsStartEnable
  102. * @summary Enabled the 2 start buttons
  103. * @description Is executed when the todo-list contains at least 1 item
  104. */
  105. function windowMainButtonsStartEnable () {
  106.     // enable start buttons if needed - if needed
  107.     if ($('#buttonStartVideoExec').is(':disabled')) {
  108.         // Button: VideoExec
  109.         $('#buttonStartVideoExec').prop('disabled', false)
  110.         $('#buttonStartVideoExec').removeClass('btn-secondary') // remove class: secondary
  111.         $('#buttonStartVideoExec').addClass('btn-danger') // add class: danger
  112.         // Button: Video
  113.         $('#buttonStartVideo').prop('disabled', false)
  114.         $('#buttonStartVideo').removeClass('btn-secondary') // remove danger class
  115.         $('#buttonStartVideo').addClass('btn-danger') // add class: danger
  116.         // Button: AudioExec
  117.         $('#buttonStartAudioExec').prop('disabled', false)
  118.         $('#buttonStartAudioExec').removeClass('btn-secondary') // remove class: secondary
  119.         $('#buttonStartAudioExec').addClass('btn-danger') // add class: danger
  121.         utils.writeConsoleMsg('info', 'windowMainButtonsStartEnable ::: Did enable both start buttons')
  122.     }
  123. }
  125. /**
  126. * @function windowMainButtonsStartDisable
  127. * @summary Disables the 2 start buttons
  128. * @description Is executed when a download task is started by the user
  129. */
  130. function windowMainButtonsStartDisable () {
  131.     // disable start buttons - if needed
  132.     if ($('#buttonStartVideoExec').is(':enabled')) {
  133.         // Button: VideoExec
  134.         $('#buttonStartVideoExec').prop('disabled', true)
  135.         $('#buttonStartVideoExec').removeClass('btn-danger') // remove class: danger
  136.         $('#buttonStartVideoExec').addClass('btn-secondary') // add class: secondary
  137.         // Button: Video
  138.         $('#buttonStartVideo').prop('disabled', true)
  139.         $('#buttonStartVideo').removeClass('btn-danger') // remove danger class
  140.         $('#buttonStartVideo').addClass('btn-secondary') // add class: secondary
  141.         // Button: AudioExec
  142.         $('#buttonStartAudioExec').prop('disabled', true)
  143.         $('#buttonStartAudioExec').removeClass('btn-danger') // remove danger class
  144.         $('#buttonStartAudioExec').addClass('btn-secondary') // add class: secondary
  146.         utils.writeConsoleMsg('info', 'windowMainButtonsStartDisable ::: Did disable both start buttons')
  147.     }
  148. }
  150. /**
  151. * @function windowMainBlurSet
  152. * @summary Can set a blur level for entire main ui
  153. * @description Can set a blur level for entire main ui. Is used on the mainUI when the settingsUI is open
  154. * @param {boolean} enable- To enable or disable blur
  155. */
  156. function windowMainBlurSet (enable) {
  157.     if (enable === true) {
  158.         // mainContainer
  159.         $('#mainContainer').css('filter', 'blur(2px)') // blur
  160.         $('#mainContainer').css('pointer-events', 'none') // disable click events
  161.         // titlebar
  162.         $('.titlebar').css('filter', 'blur(2px)') // blur
  163.         $('.titlebar').css('pointer-events', 'none') // disable click events
  164.         utils.writeConsoleMsg('info', 'windowMainBlurSet ::: Enabled blur effect')
  165.     } else {
  166.         // mainContainer
  167.         $('#mainContainer').css('filter', 'blur(0px)') // unblur
  168.         $('#mainContainer').css('pointer-events', 'auto') // enable click-events
  169.         // titlebar
  170.         $('.titlebar').css('filter', 'blur(0px)') // unblur
  171.         $('.titlebar').css('pointer-events', 'auto') // enable click-events
  172.         utils.writeConsoleMsg('info', 'windowMainBlurSet ::: Disabled blur effect')
  173.     }
  174. }
  176. /**
  177. * @function windowMainIntroShow
  178. * @summary start an intro / user tutorial
  179. * @description Starts a short intro / tutorial which explains the user-interface. Using introJs
  180. */
  181. function windowMainIntroShow () {
  182.     utils.writeConsoleMsg('info', 'windowMainIntroShow ::: Starting the media-dupes intro')
  183.     const introJs = require('intro.js')
  184.     introJs().start()
  185. }
  187. /**
  188. * @function windowMainLogAppend
  189. * @summary Appends text to the log textarea
  190. * @description Appends text to the log textarea
  191. * @param {String} newLine - The content for the line which should be appended to the UI Log
  192. */
  193. function windowMainLogAppend (newLine, addTimestamp = false) {
  194.     if (addTimestamp === true) {
  195.         var currentTimestamp = utils.generateTimestamp() // get a current timestamp
  196.         newLine = currentTimestamp + ' > ' + newLine
  197.     }
  199.     $('#textareaLogOutput').val(function (i, text) {
  200.         return text + newLine + '\n'
  201.     })
  202.     windowMainLogScrollToEnd() // scroll log textarea to the end
  203. }
  205. /**
  206. * @function windowMainLogReset
  207. * @summary Resets the ui log
  208. * @description Resets the content of the ui log
  209. */
  210. function windowMainLogReset () {
  211.     document.getElementById('textareaLogOutput').value = ''
  212.     utils.writeConsoleMsg('info', 'windowMainLogReset ::: Did reset the log-textarea')
  213. }
  215. /**
  216. * @function windowMainLogScrollToEnd
  217. * @summary Scrolls the UI log to the end
  218. * @description Scrolls the UI log to the end / latest entry
  219. */
  220. function windowMainLogScrollToEnd () {
  221.     $('#textareaLogOutput').scrollTop($('#textareaLogOutput')[0].scrollHeight) // scroll log textarea to the end
  222. }
  224. /**
  225. * @function windowMainResetAskUser
  226. * @summary Ask the user if he wants to execute the UI reset function if there are currently downloads in progress
  227. * @description Ask the user if he wants to execute the UI reset function if there are currently downloads in progress
  228. */
  229. function windowMainResetAskUser () {
  230.     var curState = utils.globalObjectGet('applicationState') // get application state
  231.     if (curState === 'Download in progress') {
  232.         const Noty = require('noty')
  233.         var n = new Noty(
  234.             {
  235.                 theme: 'bootstrap-v4',
  236.                 layout: 'bottom',
  237.                 type: 'info',
  238.                 closeWith: [''], // to prevent closing the confirm-dialog by clicking something other then a confirm-dialog-button
  239.                 text: 'Seems like <b>media-dupes</b> is currently downloading. Do you really want to reset the UI?',
  240.                 buttons: [
  241.                     Noty.button('Yes', 'btn btn-success mediaDupes_btnDefaultWidth', function () {
  242.                         n.close()
  243.                         windowMainUiReset()
  244.                     },
  245.                     {
  246.                         id: 'button1', 'data-status': 'ok'
  247.                     }),
  248.                     Noty.button('No', 'btn btn-secondary mediaDupes_btnDefaultWidth float-right', function () {
  249.                         n.close()
  250.                     })
  251.                 ]
  252.             })
  254.         n.show() // show the noty dialog
  255.     } else {
  256.         windowMainUiReset()
  257.     }
  258. }
  260. /**
  261. * @function windowMainOpenDownloadFolder
  262. * @summary Triggers code in main.js to open the download folder of the user
  263. * @description Triggers code in main.js to open the download folder of the user
  264. */
  265. function windowMainOpenDownloadFolder () {
  266.     const { ipcRenderer } = require('electron')
  267.     var configuredDownloadFolder = utils.globalObjectGet('downloadDir')
  268.     utils.writeConsoleMsg('info', 'windowMainOpenDownloadFolder ::: Seems like we should use the following dir: _' + configuredDownloadFolder + '_.')
  269.     ipcRenderer.send('openUserDownloadFolder', configuredDownloadFolder)
  270. }
  272. /**
  273. * @function windowMainSettingsUiLoad
  274. * @summary Navigate to setting.html
  275. * @description Is triggered via button on index.html. Calls method on main.js which loads setting.html to the application window
  276. */
  277. function windowMainSettingsUiLoad () {
  278.     const { ipcRenderer } = require('electron')
  279.     windowMainBlurSet(true) // blur the main UI
  280.     ipcRenderer.send('settingsUiLoad') // tell main.js to load settings UI
  281. }
  283. /**
  284. * @function windowMainDownloadContent
  285. * @summary Handles the download of audio and video
  286. * @description Checks some requirements, then sets the youtube-dl parameter depending on the mode. Finally launched youtube-dl via exec
  287. * @param {String} mode - The download mode. Can be 'video' or 'audio'
  288. * @throws Exit code from youtube-dl exec task
  289. */
  290. function windowMainDownloadContent (mode) {
  291.     utils.writeConsoleMsg('info', 'downloadContent ::: Start with mode set to: _' + mode + '_.')
  293.     // some example urls for tests
  294.     //
  295.     // VIDEO:
  296.     // YOUTUBE:         http://www.youtube.com/watch?v=90AiXO1pAiA                      // 11 sec       less then 1 MB
  297.     //                  https://www.youtube.com/watch?v=cmiXteWLNw4                     // 1 hour
  298.     //                  https://www.youtube.com/watch?v=bZ_C-AVo5xA                     // for simulating download errors
  299.     // VIMEO:           https://vimeo.com/315670384                                     // 48 sec       around 1GB
  300.     //                  https://vimeo.com/274478457                                     // 6 sec        around 4MB
  301.     //
  302.     // AUDIO:
  303.     // SOUNDCLOUD:      https://soundcloud.com/jperiod/rise-up-feat-black-thought-2
  304.     // BANDCAMP:        https://nosferal.bandcamp.com/album/nosferal-ep-mini-album
  306.     // What is the target dir
  307.     var configuredDownloadFolder = utils.globalObjectGet('downloadDir')
  308.     utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: Download target directory is set to: _' + configuredDownloadFolder + '_.')
  310.     if (utils.isDirectoryAvailable(configuredDownloadFolder)) {
  311.         // the download folder exists
  313.         // check if it is writeable
  314.         if (utils.isDirectoryWriteable(configuredDownloadFolder)) {
  315.             // Prepare UI
  316.             windowMainButtonsStartDisable() // disable the start buttons
  317.             windowMainButtonsOthersDisable() // disables some other buttons
  318.             windowMainApplicationStateSet('Download in progress') // set the application state
  320.             // require some stuff
  321.             const youtubedl = require('youtube-dl')
  322.             const path = require('path')
  324.             var arrayUrlsProcessedSuccessfully = [] // prepare array for urls which got successfully downloaded
  325.             var arrayUrlsThrowingErrors = [] // prepare array for urls which are throwing errors
  327.             // youtube-dl
  328.             utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: Using youtube.dl from: _' + youtubeDl.binaryPathGet() + '_.')
  330.             // ffmpeg
  331.             var ffmpegPath = ffmpeg.ffmpegGetBinaryPath()
  332.             utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: Detected bundled ffmpeg at: _' + ffmpegPath + '_.')
  334.             // Check if todoArray exists otherwise abort and throw error. See: MEDIA-DUPES-J
  335.             if (typeof arrayUserUrlsN === 'undefined' || !(arrayUserUrlsN instanceof Array)) {
  336.                 windowMainApplicationStateSet()
  337.                 utils.showNoty('error', 'Unexpected state of array _arrayUserUrlsN_ in function downloadContent(). Please report this', 0)
  338.                 return
  339.             } else {
  340.                 utils.globalObjectSet('todoListStateEmpty', false)
  341.             }
  343.             // Define the youtube-dl parameters depending on the mode (audio vs video)
  344.             // youtube-dl docs: https://github.com/ytdl-org/youtube-dl/blob/master/README.md
  345.             var youtubeDlParameter = []
  346.             switch (mode) {
  347.             case 'audio':
  348.                 var settingAudioFormat = utils.globalObjectGet('audioFormat') // get configured audio format
  350.                 // generic parameter / flags
  351.                 youtubeDlParameter = [
  352.                     // OPTIONS
  353.                     '--ignore-errors', // Continue on download errors, for example to skip unavailable videos in a playlist
  354.                     '--format', 'bestaudio',
  355.                     '--output', path.join(configuredDownloadFolder, 'Audio', '%(track_number)s-%(artist)s-%(album)s-%(title)s-%(id)s.%(ext)s'), // output path
  356.                     // FILESYSTEM OPTIONS
  357.                     '--restrict-filenames', // Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames
  358.                     '--continue', // Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.
  359.                     // POST PROCESSING
  360.                     '--prefer-ffmpeg', '--ffmpeg-location', ffmpegPath, // ffmpeg location
  361.                     '--add-metadata', // Write metadata to the video file
  362.                     '--audio-format', settingAudioFormat, //  Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "best" by default; No effect without -x
  363.                     '--extract-audio', // Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)
  364.                     '--audio-quality', '0', // value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5),
  365.                     '--fixup', 'detect_or_warn' // Automatically correct known faults of the file.
  366.                 ]
  368.                 // prepend/add some case-specific parameter / flag
  369.                 if ((settingAudioFormat === 'mp3') || (settingAudioFormat === 'm4a')) {
  370.                     youtubeDlParameter.unshift('--embed-thumbnail') // prepend Post-processing Option
  371.                 }
  372.                 break
  374.             case 'video':
  375.                 youtubeDlParameter = [
  376.                     // OPTIONS
  377.                     '--ignore-errors', // Continue on download errors, for example to skip unavailable videos in a playlist
  378.                     '--format', 'best',
  379.                     '--output', path.join(configuredDownloadFolder, 'Video', '%(title)s-%(id)s.%(ext)s'), // output path
  380.                     // FILESYSTEM OPTIONS
  381.                     '--restrict-filenames', // Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames
  382.                     '--continue', // Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.
  383.                     // POST PROCESSING
  384.                     '--prefer-ffmpeg', '--ffmpeg-location', ffmpegPath, // ffmpeg location
  385.                     '--add-metadata', // Write metadata to the video file
  386.                     '--audio-quality', '0', // value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)
  387.                     '--fixup', 'detect_or_warn' // Automatically correct known faults of the file.
  388.                 ]
  389.                 break
  391.             default:
  392.                 windowMainApplicationStateSet()
  393.                 utils.writeConsoleMsg('error', 'windowMainDownloadContent ::: Unspecified mode. This should never happen.')
  394.                 utils.showNoty('error', 'Unexpected download mode. Please report this issue', 0)
  395.                 return
  396.             }
  398.             windowMainLogAppend('\n') // Show mode in log
  399.             windowMainLogAppend('### QUEUE STARTED ###', true) // Show mode in log
  400.             windowMainLogAppend('Download mode:\t' + mode, true) // Show mode in log
  402.             // show the selected audio-format
  403.             if (mode === 'audio') {
  404.                 utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: AudioFormat is set to: _' + settingAudioFormat + '_')
  405.                 windowMainLogAppend('Audio-Format:\t' + settingAudioFormat, true) // Show mode in log
  406.             }
  408.             // if verboseMode is enabled - append the related youtube-dl flags to the parameter array
  409.             var settingVerboseMode = utils.globalObjectGet('enableVerboseMode')
  410.             if (settingVerboseMode === true) {
  411.                 utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: Verbose Mode is enabled')
  412.                 youtubeDlParameter.unshift('--verbose') // prepend: verbose
  413.                 youtubeDlParameter.unshift('--print-traffic') // prepend: traffic (header)
  414.             } else {
  415.                 utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: Verbose Mode is disabled')
  416.             }
  417.             windowMainLogAppend('Verbose mode:\t' + settingVerboseMode, true) // Show verbose mode in log
  419.             // if configured - add custom additional parameter to parameter array - see #88
  420.             var isAdditionalParameterEnabled = utils.globalObjectGet('enableAdditionalParameter')
  421.             if (isAdditionalParameterEnabled === true) {
  422.                 var configuredAdditionalParameter = utils.globalObjectGet('additionalYoutubeDlParameter')
  423.                 var splittedParameters = configuredAdditionalParameter.split(' ')
  424.                 windowMainLogAppend('Added parameters:\t' + splittedParameters, true) // Show mode in log
  426.                 if (splittedParameters.length > 0) { // append custom parameter to parameter array
  427.                     for (var j = 0; j < splittedParameters.length; j++) {
  428.                         youtubeDlParameter.push(splittedParameters[j])
  429.                         utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: Appending custom parameter: _' + splittedParameters[j] + '_ to the youtube-dl parameter set.')
  430.                     }
  431.                 }
  432.             }
  434.             // update UI
  435.             windowMainSetReadOnly()
  437.             // assuming we got an array with urls to process
  438.             // for each item of the array ... try to start a download-process
  439.             var url
  440.             for (var i = 0; i < arrayUserUrlsN.length; i++) {
  441.                 sentry.countEvent('usageURLsOverall')
  442.                 url = utils.fullyDecodeURI(arrayUserUrlsN[i]) // decode url - see #25
  443.                 utils.writeConsoleMsg('info', 'windowMainDownloadContent ::: Added URL: _' + url + '_ (' + mode + ') with the following parameters: _' + youtubeDlParameter + '_ to the queue.')
  444.                 // windowMainLogAppend('Added: \t\t' + url + ' to queue', true) // append url to log
  446.                 // Check if url is a playlist (example: https://www.youtube.com/playlist?list=PL53E6B270F5FF0D49 )
  447.                 if ((url.includes('playlist')) && (url.includes('list='))) {
  448.                     windowMainLogAppend('Added: \t\t' + url + ' to queue (might be a playlist)', true) // append url to log
  449.                 } else {
  450.                     windowMainLogAppend('Added: \t\t' + url + ' to queue', true) // append url to log
  451.                 }
  453.                 // Download
  454.                 //
  455.                 // const newDownload = youtubedl.exec(url, youtubeDlParameter, {}, function (error, output) {
  456.                 youtubedl.exec(url, youtubeDlParameter, {}, function (error, output) {
  457.                     if (error) {
  458.                         sentry.countEvent('usageURLsFailed')
  459.                         utils.showNoty('error', '<b>Download failed</b><br><br>' + error + '<br><br><small><b><u>Common causes</u></b><br>* youtube-dl does not support this url. Please check the list of extractors<br>* Using old version of media-dupes<br>* Using old version of youtube-dl<br>* Country-/ and/or similar restrictions</small>', 0)
  460.                         utils.writeConsoleMsg('error', 'windowMainDownloadContent ::: Problems downloading an url with the following parameters: _' + youtubeDlParameter + '_. Error: ' + error)
  461.                         windowMainLogAppend('Failed to download a single url', true)
  462.                         arrayUrlsThrowingErrors.push(url) // remember troublesome url (Attention: this is not the actual url . we got a problem here)
  463.                         utils.downloadStatusCheck(arrayUserUrlsN.length, arrayUrlsProcessedSuccessfully.length, arrayUrlsThrowingErrors.length) // check if we are done here
  464.                         throw error
  465.                     }
  467.                     // no error occured for this url - assuming the download finished
  468.                     //
  469.                     arrayUrlsProcessedSuccessfully.push(url)
  470.                     utils.writeConsoleMsg('info', output.join('\n')) // Show processing output for this download task
  471.                     windowMainLogAppend(output.join('\n')) // Show processing output for this download task
  473.                     if (arrayUserUrlsN.length > 1) {
  474.                         utils.showNoty('success', 'Finished 1 download') // inform user
  475.                     }
  477.                     utils.downloadStatusCheck(arrayUserUrlsN.length, arrayUrlsProcessedSuccessfully.length, arrayUrlsThrowingErrors.length) // check if we are done here
  479.                     // FIXME:
  480.                     //
  481.                     // the variable URL contains in both cases the last processed url
  482.                     // thats why we can't show the actual url in the log
  483.                 })
  484.             }
  485.         }
  486.     }
  487. }
  489. /**
  490. * @function windowMainSetReadOnly
  491. * @summary ensures that the user can not add or remove items to the todo-list while the app is processing an existing todo list
  492. * @description ensures that the user can not add or remove items to the todo-list while the app is processing an existing todo list
  493. */
  494. function windowMainSetReadOnly () {
  495.     $('#buttonAddUrl').prop('disabled', true) // disable the add url button
  496.     $('#inputNewUrl').prop('disabled', true) // url input field
  498.     // make sure the user can no longer remove items from the todolist
  499.     $('#delete').prop('disabled', true) // disable all delete buttons for each url
  500. }
  502. /**
  503. * @function windowMainDownloadVideo
  504. * @summary Does the actual video download
  505. * @description Does the actual video download (without using youtube-dl.exec)
  506. */
  507. function windowMainDownloadVideo () {
  509.     // some example urls for tests
  510.     //
  511.     // VIDEO:
  512.     // YOUTUBE:         http://www.youtube.com/watch?v=90AiXO1pAiA                      // 11 sec       less then 1 MB
  513.     //                  https://www.youtube.com/watch?v=cmiXteWLNw4                     // 1 hour
  514.     //                  https://www.youtube.com/watch?v=bZ_C-AVo5xA                     // for simulating download errors
  515.     // VIMEO:           https://vimeo.com/315670384                                     // 48 sec       around 1GB
  516.     //                  https://vimeo.com/274478457                                     // 6 sec        around 4MB
  517.     //
  518.     // AUDIO:
  519.     // SOUNDCLOUD:      https://soundcloud.com/jperiod/rise-up-feat-black-thought-2
  520.     // BANDCAMP:        https://nosferal.bandcamp.com/album/nosferal-ep-mini-album
  522.     // FIXME:
  523.     // This method now seems to work good for youtube urls
  524.     // BUT not for non-youtube urls
  525.     // media-dupes is currently not using this function
  527.     /*
  528.     var configuredDownloadFolder = utils.globalObjectGet('downloadDir') // What is the target dir
  529.     utils.writeConsoleMsg('info', 'windowMainDownloadVideo ::: Download target directory is set to: _' + configuredDownloadFolder + '_.')
  531.     if (utils.isDirectoryAvailable(configuredDownloadFolder)) {
  532.         // the default download folder exists
  534.         if (utils.isDirectoryWriteable(configuredDownloadFolder)) {
  535.             // check if it is writeable
  537.             // Prepare UI
  538.             windowMainButtonsStartDisable() // disable the start buttons
  539.             windowMainButtonsOthersDisable() // disables some other buttons
  540.             windowMainLoadingAnimationShow() // start download animation / spinner
  542.             // require some stuff
  543.             const youtubedl = require('youtube-dl')
  544.             const path = require('path')
  545.             const fs = require('fs')
  547.             // ffmpeg
  548.             var ffmpegPath = ffmpeg.ffmpegGetBinaryPath()
  549.             utils.writeConsoleMsg('info', 'windowMainDownloadVideo ::: Detected bundled ffmpeg at: _' + ffmpegPath + '_.')
  551.             var youtubeDlParameter = ''
  553.             youtubeDlParameter = [
  554.                 // OPTIONS
  555.                 '--ignore-errors', // Continue on download errors, for example to skip unavailable videos in a playlist
  556.                 //'--format=best',
  557.                 '--output', path.join(configuredDownloadFolder, 'Video', '%(title)s-%(id)s.%(ext)s'), // output path
  558.                 // FILESYSTEM OPTIONS
  559.                 '--restrict-filenames', // Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames
  560.                 '--continue', // Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.
  561.                 // VERBOSE
  562.                 '--print-json',
  563.                 // POST PROCESSING
  564.                 '--prefer-ffmpeg', '--ffmpeg-location=' + ffmpegPath, // ffmpeg location
  565.                 '--add-metadata', // Write metadata to the video file
  566.                 ///'--audio-quality', '0', // value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)
  567.                 //'--fixup', 'detect_or_warn' // Automatically correct known faults of the file.
  568.             ]
  570.             // Check if todoArray exists otherwise abort and throw error. See: MEDIA-DUPES-J
  571.             if (typeof arrayUserUrlsN === 'undefined' || !(arrayUserUrlsN instanceof Array)) {
  572.                 utils.showNoty('error', 'Unexpected state of array _arrayUserUrlsN_ in function downloadVideo(). Please report this', 0)
  573.                 return
  574.             }
  576.             utils.writeConsoleMsg('info', 'windowMainDownloadVideo ::: Using youtube.dl: _' + youtubeDl.binaryPathGet() + '_.')
  578.             var arrayUrlsThrowingErrors = [] // prepare array for urls which are throwing errors
  579.             var arrayUrlsProcessedSuccessfully = []
  580.             var downloadUrlTargetName = []
  582.             // assuming we got an array with urls to process
  583.             // for each item of the array ... try to start a download-process
  584.             var arrayLength = arrayUserUrlsN.length
  585.             windowMainLogAppend('Queue contains ' + arrayLength + ' urls.')
  586.             windowMainLogAppend('Starting to download items from queue ... ')
  587.             for (var i = 0; i < arrayLength; i++) {
  588.                 var url = arrayUserUrlsN[i] // get url
  590.                 // decode url - see #25
  591.                 //
  592.                 // url = decodeURI(url);
  593.                 url = utils.fullyDecodeURI(url)
  595.                 windowMainLogAppend('Starting to process the url: ' + url + ' ...')
  596.                 utils.writeConsoleMsg('info', 'windowMainDownloadVideo ::: Processing URL: _' + url + '_.') // show url
  597.                 utils.writeConsoleMsg('info', 'windowMainDownloadVideo ::: Using the following parameters: _' + youtubeDlParameter + '_.') // show parameters
  599.                 const video = youtubedl(url, youtubeDlParameter)
  601.                 // Variables for progress of each download
  602.                 let size = 0
  603.                 let pos = 0
  604.                 let progress = 0
  606.                 video.on('error', function error(error) {
  607.                     //console.log(error)
  608.                     utils.showNoty('error', '<b>Download failed</b><br><br>' + error + '<br><br><small><b><u>Common causes</u></b><br>* youtube-dl does not support this url. Please check the list of extractors<br>* Country-/ and/or similar restrictions</small>', 0)
  609.                     utils.writeConsoleMsg('error', 'windowMainDownloadContent ::: Problems downloading an url with the following parameters: _' + youtubeDlParameter + '_. Error: ' + error)
  610.                     windowMainLogAppend('Failed to download a single url', true)
  611.                     throw error
  612.                 })
  614.                 // When the download fetches info - start writing to file
  615.                 //
  616.                 video.on('info', function (info) {
  617.                     // downloadUrlTargetName[i] = path.join(configuredDownloadFolder, 'Video', info._filename) // define the final name & path
  618.                     downloadUrlTargetName[i] = info._filename // define the final name & path
  620.                     size = info.size // needed to handle the progress later on('data'
  622.                     console.log('filename: ' + info._filename)
  623.                     windowMainLogAppend('Filename: ' + info._filename)
  625.                     console.log('size: ' + info.size)
  626.                     windowMainLogAppend('Size: ' + utils.formatBytes(info.size))
  628.                     // start the actual download & write to file
  629.                     var writeStream = fs.createWriteStream(downloadUrlTargetName[i])
  630.                     video.pipe(writeStream)
  631.                 })
  633.                 // updating progress
  634.                 //
  635.                 video.on('data', (chunk) => {
  636.                     // console.log('Getting another chunk: _' + chunk.length + '_.')
  637.                     pos += chunk.length
  638.                     if (size) {
  639.                         progress = (pos / size * 100).toFixed(2) // calculate progress
  640.                         console.log('Download-progress is: _' + progress + '_.')
  641.                         windowMainLogAppend('Download progress: ' + progress + '%')
  642.                     }
  643.                 })
  645.                 // If download was already completed and there is nothing more to download.
  646.                 //
  647.                 video.on('complete', function complete (info) {
  648.                     console.warn('filename: ' + info._filename + ' already downloaded.')
  649.                     windowMainLogAppend('Filename: ' + info._filename + ' already downloaded.')
  650.                 })
  652.                 // Download finished
  653.                 //
  654.                 video.on('end', function () {
  655.                     console.log('Finished downloading 1 url')
  657.                     windowMainLogAppend('Finished downloading url')
  658.                     arrayUrlsProcessedSuccessfully.push(url)
  660.                     // if all downloads finished
  661.                     if (arrayUrlsProcessedSuccessfully.length === arrayLength) {
  662.                         utils.showNotification('Finished downloading ' + arrayUrlsProcessedSuccessfully.length + ' url(s). Queue is now empty.')
  663.                         windowMainLogAppend('Finished downloading ' + arrayUrlsProcessedSuccessfully.length + ' url(s). Queue is now empty.', true)
  664.                         windowMainUiMakeUrgent() // mark mainWindow as urgent to inform the user about the state change
  665.                         windowMainLoadingAnimationHide() // stop download animation / spinner
  666.                         windowMainButtonsOthersEnable() // enable some of the buttons again
  667.                     }
  668.                 })
  669.             }
  670.         }
  671.     }
  672.     */
  673. }
  675. /**
  676. * @function windowMainAddUrl
  677. * @summary Handles the add-url-click of the user
  678. * @description Fetches the user provided url, trims it and adds it to an array. Is then calling todoListUpdate()
  679. */
  680. function windowMainAddUrl () {
  681.     var newUrl = $('#inputNewUrl').val() // get content of input
  682.     newUrl = newUrl.trim() // trim the url to remove blanks
  684.     if (newUrl !== '') {
  685.         var isUrlValid = utils.validURL(newUrl)
  686.         if (isUrlValid) {
  687.             // check if url is already in arrayUserUrlsN - If not add it to table
  688.             var isThisUrlAlreadyPartOfList = arrayUserUrlsN.includes(newUrl)
  689.             if (isThisUrlAlreadyPartOfList === false) {
  690.                 utils.writeConsoleMsg('info', 'windowMainAddUrl ::: Adding new url: _' + newUrl + '_.')
  691.                 $('#inputNewUrl').val('') // reset input
  692.                 inputUrlFieldSetState() // empty = white
  693.                 arrayUserUrlsN.push(newUrl) // append to array
  694.                 toDoListSingleUrlAdd(newUrl) // #102
  695.             } else {
  696.                 utils.showNoty('warning', 'This url is already part of the current todo list')
  697.             }
  699.             // if array size > 0 -> enable start button
  700.             var arrayLength = arrayUserUrlsN.length
  701.             if (arrayLength === 0) {
  702.                 utils.globalObjectSet('todoListStateEmpty', true)
  703.             } else {
  704.                 windowMainButtonsStartEnable()
  705.                 utils.globalObjectSet('todoListStateEmpty', false)
  706.             }
  707.         } else {
  708.             // invalid url
  709.             utils.writeConsoleMsg('warn', 'windowMainAddUrl ::: Detected invalid url: _' + newUrl + '_.')
  710.             utils.showNoty('warning', 'Please insert a valid url (reason: unable to dectect a valid url)')
  711.             $('#inputNewUrl').focus() // focus to input field
  712.             $('#inputNewUrl').select() // select it entirely
  713.         }
  714.     } else {
  715.         // empty
  716.         utils.writeConsoleMsg('warn', 'windowMainAddUrl ::: Detected empty url.')
  717.         utils.showNoty('warning', 'Please insert a valid url (reason: was empty)')
  718.         $('#inputNewUrl').focus() // focus to input field
  719.     }
  720. }
  722. /**
  723. * @function windowMainDistract
  724. * @summary Starts the distraction mode
  725. * @description Sends a request to main.js to start the "hidden" distraction mode (easteregg)
  726. */
  727. function windowMainDistract () {
  728.     const { ipcRenderer } = require('electron')
  729.     distractEnabler = distractEnabler + 1
  730.     utils.writeConsoleMsg('info', 'distract ::: Enabler is now: ' + distractEnabler)
  731.     if (distractEnabler === 3) {
  732.         sentry.countEvent('usageTetris')
  733.         distractEnabler = 0 // reset the counter
  734.         utils.writeConsoleMsg('info', 'distract ::: Init some distraction')
  735.         ipcRenderer.send('startDistraction') // tell main.js to load distraction UI
  736.     }
  737. }
  739. /**
  740. * @function windowMainDownloadQueueFinished
  741. * @summary Re-setups the main UI post downloads
  742. * @description Gets triggered after the download function finished
  743. */
  744. function windowMainDownloadQueueFinished () {
  745.     windowMainUiMakeUrgent() // mark mainWindow as urgent to inform the user about the state change
  746.     windowMainLoadingAnimationHide() // stop download animation / spinner
  747.     windowMainButtonsOthersEnable() // enable some of the buttons again
  748.     windowMainApplicationStateSet() // reset application state
  749.     windowMainDisablePowerSaveBlocker() // disabled the power save blocker
  751.     utils.globalObjectSet('todoListStateEmpty', true)
  752. }
  754. /**
  755. * @function windowMainUiReset
  756. * @summary Resets the UI back to default
  757. * @description Resets the UI back to default
  758. */
  759. function windowMainUiReset () {
  760.     utils.writeConsoleMsg('info', 'windowMainUiReset ::: Starting to reset the UI')
  762.     // call reload of the mainWindow
  763.     const { ipcRenderer } = require('electron')
  764.     ipcRenderer.send('reloadMainWindow')
  765. }
  767. /**
  768. * @function windowMainToDoListRestore
  769. * @summary Restores urls from json files back to the todoList
  770. * @description Reads all existing json files and restores those contains preiosly stored urls.
  771. */
  772. function windowMainToDoListRestore () {
  773.     const storage = require('electron-json-storage')
  774.     // utils.writeConsoleMsg('info', 'windowMaintoDoListRestore ::: Check if there are urls to restore ...')
  776.     var curUrl
  777.     var restoreCounter = 0
  779.     storage.getAll(function (error, data) {
  780.         if (error) {
  781.             utils.writeConsoleMsg('error', 'windowMaintoDoListRestore ::: Failed to fetch all json files. Error: ' + error)
  782.             throw error
  783.         }
  784.         // console.error(data); // object with all setting files
  786.         // loop over them and find each which starts with todoListEntry_
  787.         for (var key in data) {
  788.             // utils.writeConsoleMsg('info', 'windowMaintoDoListRestore ::: Current config file: _' + key + '_.') // key = name of json file
  790.             // FIXME:
  791.             // Check for better approach:
  792.             // https://eslint.org/docs/rules/no-prototype-builtins
  794.             if (key.startsWith('todoListEntry_')) {
  795.                 curUrl = data[key].url
  796.                 utils.writeConsoleMsg('info', 'windowMaintoDoListRestore ::: Restoring the url: _' + curUrl + '_ from settings file: _' + key + '_.') // key = name of json file
  798.                 arrayUserUrlsN.push(curUrl) // append to array
  799.                 toDoListSingleUrlAdd(curUrl)
  800.                 restoreCounter = restoreCounter + 1 // update url-restore counter
  802.                 // Delete the related file
  803.                 storage.remove(key, function (error) {
  804.                     if (error) {
  805.                         utils.writeConsoleMsg('info', 'windowMaintoDoListRestore ::: Failed to delete a url restore file: _' + key + '_.') // key = name of json file
  806.                         throw error
  807.                     }
  808.                 })
  809.             }
  810.         }
  812.         // inform the user if something got restored
  813.         if (restoreCounter > 0) {
  814.             utils.writeConsoleMsg('info', 'windowMaintoDoListRestore ::: Finished restored ' + restoreCounter + ' URLs from previous session.')
  815.             utils.showNoty('success', 'Restored <b>' + restoreCounter + '</b> URLs from your last session.')
  817.             // get focus
  818.             const { ipcRenderer } = require('electron')
  819.             ipcRenderer.send('makeWindowUrgent')
  821.             utils.globalObjectSet('todoListStateEmpty', false) // remember that todo list is now not longer empty - see #105
  822.             windowMainButtonsStartEnable() // enable the start buttons
  823.         } else {
  824.             utils.writeConsoleMsg('info', 'windowMaintoDoListRestore ::: Found no urls to restore from previous session.')
  825.         }
  826.     })
  827. }
  829. /**
  830. * @function windowMainToDoListSave
  831. * @summary Saves the current content of the todoList to files
  832. * @description Creates a json file for each url of the todoList. Those files can be restored on next application launch
  833. */
  834. function windowMainToDoListSave () {
  835.     const storage = require('electron-json-storage')
  836.     utils.writeConsoleMsg('info', 'windowMainToDoListSave ::: Should backup todolist')
  838.     var isToDoListEmpty = utils.globalObjectGet('todoListStateEmpty') // #79
  839.     if (isToDoListEmpty === false) {
  840.         var baseName = 'todoListEntry_'
  841.         var tempName
  842.         var arrayLength = arrayUserUrlsN.length
  843.         for (var i = 0; i < arrayLength; i++) {
  844.             var url = arrayUserUrlsN[i]
  845.             tempName = baseName + i
  846.             utils.writeConsoleMsg('info', 'windowMainToDoListSave ::: Trying to save the URL: ' + url + '_ to the file: _' + tempName + '_.')
  848.             storage.set(tempName, { url: url }, function (error) {
  849.                 if (error) {
  850.                     utils.writeConsoleMsg('error', 'Error writing json file')
  851.                     throw error
  852.                 }
  853.                 utils.writeConsoleMsg('info', 'windowMainToDoListSave ::: Written the url _' + url + '_ to the file: _' + tempName + '_.')
  854.             })
  855.         }
  856.         utils.writeConsoleMsg('info', 'windowMainToDoListSave ::: Finished saving todoList content to files.')
  857.     } else {
  858.         utils.writeConsoleMsg('info', 'windowMainToDoListSave ::: todoList was empty - nothing to store.') // #79
  859.     }
  860. }
  862. /**
  863. * @function windowMainUiMakeUrgent
  864. * @summary Tells the main process to mark the application as urgent (blinking in task manager)
  865. * @description Is used to inform the user about an important state-change (all downloads finished). Triggers code in main.js which does the actual work
  866. */
  867. function windowMainUiMakeUrgent () {
  868.     const { ipcRenderer } = require('electron')
  869.     ipcRenderer.send('makeWindowUrgent') // make window urgent after having finished downloading. See #7
  870. }
  872. /**
  873. * @function windowMainEnableAddUrlButton
  874. * @summary Enables the AddUrlButton
  875. * @description Enables the AddUrlButton if it isnt already
  876. */
  877. function windowMainEnableAddUrlButton () {
  878.     if ($('#buttonAddUrl').is(':disabled')) {
  879.         $('#buttonAddUrl').prop('disabled', false) // enable the add url button
  880.         utils.writeConsoleMsg('info', 'windowMainEnableAddUrlButton ::: Enabled the add URL button.')
  881.     }
  882. }
  884. /**
  885. * @function windowMainDisableAddUrlButton
  886. * @summary Disables the AddUrlButton
  887. * @description Disabled the AddUrlButton if it isnt already
  888. */
  889. function windowMainDisableAddUrlButton () {
  890.     if ($('#buttonAddUrl').is(':enabled')) {
  891.         $('#buttonAddUrl').prop('disabled', true) // disable the add url button
  892.         utils.writeConsoleMsg('info', 'windowMainDisableAddUrlButton ::: Disabled the add URL button.')
  893.     }
  894. }
  896. /**
  897. * @function inputUrlFieldSetState
  898. * @summary Sets the background color of the url input field based on the given state
  899. * @description Sets the background color of the url input field based on the given state
  900. * @param {String} state - Known states or 'reachable', 'unchecked', 'unreachable' and default/any else
  901. */
  902. function inputUrlFieldSetState (state) {
  903.     switch (state) {
  904.     case 'valid':
  905.         $('#inputNewUrl').css('background-color', '#90EE90') // green
  906.         windowMainEnableAddUrlButton()
  907.         break
  908.     case 'unchecked':
  909.         $('#inputNewUrl').css('background-color', '#ffe5e5') //  light red
  910.         windowMainDisableAddUrlButton()
  911.         break
  912.     default:
  913.         $('#inputNewUrl').css('background-color', '#FFFFFF') // white
  914.         windowMainDisableAddUrlButton()
  915.         break
  916.     }
  917. }
  919. /**
  920. * @function youtubeSuggest
  921. * @summary Opens a dialog to ask for a user string. Is then using the string to get youtube suggestions for the string
  922. * @description Opens a dialog to ask for a user string. Is then using the string to get youtube suggestions for the string. Results are appended to the log
  923. */
  924. function youtubeSuggest () {
  925.     const prompt = require('electron-prompt')
  927.     const youtubeSearchUrlBase = 'https://www.youtube.com/results?search_query='
  928.     var url
  929.     var curResult
  931.     prompt({
  932.         title: 'YouTube Search Suggestions',
  933.         label: 'Searchphrase:',
  934.         value: '',
  935.         inputAttrs: {
  936.             type: 'text'
  937.         },
  938.         type: 'input'
  939.     })
  940.         .then((r) => {
  941.             if (r === null) {
  942.                 utils.writeConsoleMsg('warn', 'youtubeSuggest ::: User aborted input dialog')
  943.             } else {
  944.                 if ((r !== null) && (r !== '')) {
  945.                     windowMainLoadingAnimationShow()
  946.                     utils.writeConsoleMsg('info', 'youtubeSuggest ::: User search string is: _' + r + '_.')
  947.                     windowMainLogAppend('Searching for Youtube suggestions for the searchphase: ' + r, true)
  949.                     var youtubeSuggest = require('youtube-suggest')
  950.                     var assert = require('assert')
  952.                     youtubeSuggest(r).then(function (results) {
  953.                         assert(Array.isArray(results))
  955.                         if (results.length > 0) { // if we got suggestions
  956.                             assert(typeof results[0] === 'string')
  958.                             // Loop over array and append to log
  959.                             for (var i = 0; i < results.length; i++) {
  960.                                 curResult = results[i].replace(/ /g, '+') // replace space with +
  961.                                 url = youtubeSearchUrlBase + curResult
  962.                                 windowMainLogAppend('> ' + results[i] + ' : ' + url)
  963.                             }
  964.                             windowMainLogAppend('Finished searching for Youtube suggestions for the search phrase: ' + r + '\n', true)
  965.                             windowMainLoadingAnimationHide()
  967.                             // ask user if he wants to open all those urls
  968.                             const Noty = require('noty')
  969.                             var n = new Noty(
  970.                                 {
  971.                                     theme: 'bootstrap-v4',
  972.                                     layout: 'bottom',
  973.                                     type: 'info',
  974.                                     closeWith: [''], // to prevent closing the confirm-dialog by clicking something other then a confirm-dialog-button
  975.                                     text: 'Do you want to open all suggestions in your browser?',
  976.                                     buttons: [
  977.                                         Noty.button('Yes', 'btn btn-success mediaDupes_btnDefaultWidth', function () {
  978.                                             n.close()
  980.                                             // loop over array and call openURL
  981.                                             for (var i = 0; i < results.length; i++) {
  982.                                                 curResult = results[i].replace(/ /g, '+') // replace space with +
  983.                                                 url = youtubeSearchUrlBase + curResult
  984.                                                 utils.openURL(url)
  985.                                             }
  986.                                         },
  987.                                         {
  988.                                             id: 'button1', 'data-status': 'ok'
  989.                                         }),
  990.                                         Noty.button('No', 'btn btn-secondary mediaDupes_btnDefaultWidth float-right', function () {
  991.                                             n.close()
  992.                                         })
  993.                                     ]
  994.                                 })
  996.                             n.show() // show the noty dialog
  997.                         } else {
  998.                             utils.showNoty('warning', '<b>Warning:</b> Unable to get suggestions for this search phrase')
  999.                             windowMainLogAppend('Finished searching for Youtube suggestions for the searchphase: ' + r + ' without results', true)
  1000.                             windowMainLoadingAnimationHide()
  1001.                         }
  1002.                     })
  1003.                     // end suggest
  1004.                 } else {
  1005.                     utils.showNoty('warning', '<b>Warning:</b> Unable to search suggestions without search string')
  1006.                 }
  1007.             }
  1008.         })
  1009.         .catch(console.error)
  1010. }
  1012. /**
  1013. * @function windowMainDisablePowerSaveBlocker
  1014. * @summary Disable the power save blocker
  1015. * @description RDisable the power save blocker
  1016. */
  1017. function windowMainDisablePowerSaveBlocker () {
  1018.     utils.writeConsoleMsg('info', 'windowMainDisablePowerSaveBlocker ::: Check if there is a PowerSaveBlocker enabled, if so try to disable it.')
  1019.     var currentPowerSaveBlockerStatus = utils.globalObjectGet('powerSaveBlockerEnabled')
  1021.     if (currentPowerSaveBlockerStatus === true) {
  1022.         var currentPowerSaveBlockerId = utils.globalObjectGet('powerSaveBlockerId') // get the id
  1023.         if (currentPowerSaveBlockerId !== -1) {
  1024.             utils.writeConsoleMsg('info', 'windowMainDisablePowerSaveBlocker ::: Trying to disable the PowerSaveBlocker with the ID _' + currentPowerSaveBlockerId + '_ now, as media-dupes is not longer downloading.')
  1025.             const { ipcRenderer } = require('electron')
  1026.             ipcRenderer.send('disablePowerSaveBlocker', currentPowerSaveBlockerId)
  1027.         }
  1028.     } else {
  1029.         utils.writeConsoleMsg('info', 'windowMainDisablePowerSaveBlocker ::: PowerSaveBlocker was not enabled, so nothing to do here.')
  1030.     }
  1031. }
  1033. /**
  1034. * @function toDoListSingleUrlRemove
  1035. * @summary Remove a single url from todo list array
  1036. * @description Remove a single url from todo list array
  1037. * @param {String} url - The url which should be removed from the todo array
  1038. */
  1039. function toDoListSingleUrlRemove (url) {
  1040.     const index = arrayUserUrlsN.indexOf(url)
  1041.     // console.error(arrayUserUrlsN)
  1042.     // console.error(url)
  1043.     if (index > -1) {
  1044.         arrayUserUrlsN.splice(index, 1)
  1045.         utils.writeConsoleMsg('info', 'toDoListSingleUrlRemove ::: Removed the url from the todo list array.')
  1046.     } else {
  1047.         utils.writeConsoleMsg('error', 'toDoListSingleUrlRemove ::: Unable to remove the url from the todo list array.')
  1048.     }
  1050.     // check array size (to ensure saving & restoring urls works as expected)
  1051.     if (arrayUserUrlsN.length === 0) {
  1052.         utils.globalObjectSet('todoListStateEmpty', true)
  1053.         windowMainButtonsStartDisable() // disable start buttons
  1054.     } else {
  1055.         utils.globalObjectSet('todoListStateEmpty', false)
  1056.         windowMainButtonsStartEnable() // Enable Start buttons
  1057.     }
  1058. }
  1060. /**
  1061. * @function truncateString
  1062. * @summary Truncate a string
  1063. * @description Truncate a string
  1064. * @param {String} str - The string which should be truncated
  1065. * @param {number} num - The length after which the string should get truncated
  1066. */
  1067. function truncateString (str, num) {
  1068.     utils.writeConsoleMsg('info', 'truncateString ::: Truncating _' + str + '_ after ' + num + ' chars.')
  1070.     // remove http/https
  1071.     str = str.replace('https://', '')
  1072.     str = str.replace('http://', '')
  1074.     // If the length of str is less than or equal to num just return str--don't truncate it.
  1075.     if (str.length <= num) {
  1076.         return str
  1077.     }
  1078.     return str.slice(0, num) + '...' // Return str truncated with '...' concatenated to the end of str.
  1079. }
  1081. // #102
  1082. /**
  1083. * @function toDoListSingleUrlAdd
  1084. * @summary Add a single row to the dataTable
  1085. * @description Add a single row to the dataTable
  1086. * @param {String} url - The url which should be added to the datatable todo list
  1087. */
  1088. function toDoListSingleUrlAdd (url) {
  1089.     windowMainLoadingAnimationShow() // show that something is currently happening
  1091.     var urlId = utils.generateUrlId(url) // generate an id for this url
  1092.     var shortUrl = truncateString(url, 40)
  1094.     // add new row to datatable (with the most important informations)
  1095.     //
  1096.     var table = $('#example').DataTable()
  1097.     table.row.add([
  1098.         urlId, // ID
  1099.         '<div class="spinner-border spinner-border-sm text-secondary" role="status"><span class="sr-only">Loading...</span></div>', // logo
  1100.         '<div class="spinner-border spinner-border-sm text-secondary" role="status"><span class="sr-only">Loading...</span></div>', // preview
  1101.         '<button type="button" id="play" name="play" class="btn btn-sm btn-outline-secondary" disabled><i class="fas fa-play"></i></button>', // Play
  1102.         shortUrl, // url
  1103.         url,
  1104.         '', // state
  1105.         '<button type="button" id="delete" name="delete" class="btn btn-sm btn-outline-danger disabled"><i class="fas fa-trash-alt"></i></button>' // remove
  1106.     ]).draw(false)
  1108.     utils.writeConsoleMsg('info', 'toDoListSingleUrlAdd ::: Added the url _' + url + '_ to the todo-list (dataTable).')
  1110.     //  The following code is now moved to seperate function: startMetaScraper()
  1111.     // Now try to fetch meta informations about the url using: metascraper
  1112.     //
  1113.     const metascraper = require('metascraper')([
  1114.         require('metascraper-video')(),
  1115.         require('metascraper-description')(),
  1116.         require('metascraper-image')(),
  1117.         require('metascraper-audio')(),
  1118.         require('metascraper-logo')(),
  1119.         require('metascraper-logo-favicon')(),
  1120.         require('metascraper-media-provider')(),
  1121.         require('metascraper-soundcloud')(),
  1122.         require('metascraper-title')(),
  1123.         require('metascraper-youtube')()
  1124.     ])
  1126.     var urlLogo
  1127.     var urlImage
  1128.     var urlDescription
  1129.     var urlTitle
  1130.     var urlAudio
  1132.     const got = require('got')
  1134.     const targetUrl = url
  1136.     ;(async () => {
  1137.         const { body: html, url } = await got(targetUrl)
  1138.         const metadata = await metascraper({ html, url })
  1140.         // console.log(metadata) // show all detected metadata
  1141.         utils.writeConsoleMsg('info', 'toDoListSingleUrlAdd ::: Scraped the following metadata: ', metadata)
  1143.         urlLogo = metadata.logo
  1144.         urlImage = metadata.image
  1145.         urlDescription = metadata.description
  1146.         urlTitle = metadata.title
  1147.         urlAudio = metadata.audio
  1149.         // find the new datatable record
  1150.         //
  1151.         var indexes = table.rows().eq(0).filter(function (rowIdx) {
  1152.             return table.cell(rowIdx, 0).data() === urlId
  1153.         })
  1154.         // console.error(indexes)
  1155.         // console.error(indexes[0])
  1157.         // update the previously generated new row
  1158.         //
  1159.         // logo
  1160.         if (urlLogo == null) {
  1161.             urlLogo = 'img/dummy/dummy.png'
  1162.         }
  1163.         if (urlTitle == null) {
  1164.             urlTitle = 'No url title'
  1165.         }
  1166.         table.cell({ row: indexes[0], column: 1 }).data('<img class="zoomSmall" src="' + urlLogo + '" width="30" title="' + urlTitle + '" onclick=utils.openURL("' + url + '");>')
  1168.         // preview
  1169.         //
  1170.         if (urlImage == null) {
  1171.             urlImage = 'img/dummy/dummy.png'
  1172.         }
  1173.         if (urlDescription == null) {
  1174.             urlDescription = 'No url description available'
  1175.         }
  1176.         table.cell({ row: indexes[0], column: 2 }).data('<img class="zoomSmall" src="' + urlImage + '" width="30" title="' + urlDescription + '"  onclick=ui.imagePreviewModalShow("' + urlImage + '"); >')
  1178.         // play button
  1179.         //
  1180.         if (urlAudio == null) {
  1181.             // dont enable the button at all
  1182.         } else {
  1183.             table.cell({ row: indexes[0], column: 3 }).data('<button type="button" id="play" onclick=ui.playAudio("' + urlAudio + '"); name="play" class="btn btn-sm btn-outline-secondary"><i class="fas fa-play"></i></button>')
  1184.         }
  1186.         // button delete: enable the delete button (to prevent that the row gets removed while mediascrapper is fetching data
  1187.         //
  1188.         table.cell({ row: indexes[0], column: 7 }).data('<button type="button" id="delete" name="delete" class="btn btn-sm btn-outline-danger"><i class="fas fa-trash-alt"></i></button>')
  1190.         windowMainLoadingAnimationHide()
  1191.     })()
  1192. }
  1194. /**
  1195. * @function imagePreviewModalShow
  1196. * @summary Shows the preview modal dialog
  1197. * @description Shows the preview modal dialog which shows a big version of the image provided by the selected url
  1198. * @param {String} url - The url which to the image
  1199. */
  1200. function imagePreviewModalShow (url) {
  1201.     utils.writeConsoleMsg('info', 'imagePreviewModalShow ::: Trying to show the preview image from _' + url + '_.')
  1202.     $('#imagePreview').attr('src', url) // set the image src
  1203.     $('#myModalImagePreview').modal('show') // show the modal
  1204. }
  1206. /**
  1207. * @function playAudio
  1208. * @summary Pre-listening to the audio stream
  1209. * @description  Plays 5 sec of audio as pre-listening
  1210. */
  1211. function playAudio (url) {
  1212.     utils.writeConsoleMsg('info', 'playAudio ::: Trying to play 5 sec audio from source: _' + url + '_.')
  1214.     /*
  1215.     var a = new Audio(url)
  1216.     try {
  1217.         a.play() // start to play
  1218.         setTimeout(function () { // stop it again after 5 seconds
  1219.             a.pause()
  1220.         }, 5000)
  1221.     }
  1222.     catch(error) {
  1223.         utils.writeConsoleMsg('error', 'playAudio ::: Trying to play the audio failed. Error: ' + error)
  1224.     }
  1225.     */
  1227.     var a = new Audio(url)
  1228.     var playPromise = a.play()
  1230.     // In browsers that don’t yet support this functionality,
  1231.     // playPromise won’t be defined.
  1232.     if (playPromise !== undefined) {
  1233.         playPromise.then(function () {
  1234.             // Automatic playback started!
  1235.             setTimeout(function () { // stop it again after 5 seconds
  1236.                 a.pause()
  1237.             }, 5000)
  1238.         }).catch(function (error) {
  1239.             // Automatic playback failed.
  1240.             // Show a UI element to let the user manually start playback.
  1241.             utils.showNoty('warning', 'Prelisting failed (no supported source was found)')
  1242.         })
  1243.     }
  1244. }
  1246. /**
  1247. * @function dataTablesReset
  1248. * @summary Reset the datatable
  1249. * @description  Reset the datatable
  1250. */
  1251. function dataTablesReset () {
  1252.     var table = $('#example').DataTable()
  1254.     table
  1255.         .clear()
  1256.         .draw()
  1258.     arrayUserUrlsN = [] // reset the array
  1259. }
  1261. // ----------------------------------------------------------------------------
  1262. // EXPORT THE MODULE FUNCTIONS
  1263. // ----------------------------------------------------------------------------
  1264. //
  1265. module.exports.windowMainApplicationStateSet = windowMainApplicationStateSet
  1266. module.exports.windowMainLoadingAnimationShow = windowMainLoadingAnimationShow
  1267. module.exports.windowMainLoadingAnimationHide = windowMainLoadingAnimationHide
  1268. module.exports.windowMainButtonsOthersEnable = windowMainButtonsOthersEnable
  1269. module.exports.windowMainButtonsOthersDisable = windowMainButtonsOthersDisable
  1270. module.exports.windowMainButtonsStartEnable = windowMainButtonsStartEnable
  1271. module.exports.windowMainButtonsStartDisable = windowMainButtonsStartDisable
  1272. module.exports.windowMainBlurSet = windowMainBlurSet
  1273. module.exports.windowMainIntroShow = windowMainIntroShow
  1274. module.exports.windowMainLogAppend = windowMainLogAppend
  1275. module.exports.windowMainLogReset = windowMainLogReset
  1276. module.exports.windowMainLogScrollToEnd = windowMainLogScrollToEnd
  1277. module.exports.windowMainResetAskUser = windowMainResetAskUser
  1278. module.exports.windowMainOpenDownloadFolder = windowMainOpenDownloadFolder
  1279. module.exports.windowMainSettingsUiLoad = windowMainSettingsUiLoad
  1280. module.exports.windowMainDownloadContent = windowMainDownloadContent
  1281. module.exports.windowMainAddUrl = windowMainAddUrl
  1282. module.exports.windowMainDistract = windowMainDistract
  1283. module.exports.windowMainDownloadQueueFinished = windowMainDownloadQueueFinished
  1284. module.exports.windowMainUiReset = windowMainUiReset
  1285. module.exports.windowMainToDoListRestore = windowMainToDoListRestore
  1286. module.exports.windowMainToDoListSave = windowMainToDoListSave
  1287. module.exports.windowMainUiMakeUrgent = windowMainUiMakeUrgent
  1288. module.exports.windowMainSetReadOnly = windowMainSetReadOnly
  1289. module.exports.windowMainDownloadVideo = windowMainDownloadVideo
  1290. module.exports.windowMainEnableAddUrlButton = windowMainEnableAddUrlButton
  1291. module.exports.windowMainDisableAddUrlButton = windowMainDisableAddUrlButton
  1292. module.exports.inputUrlFieldSetState = inputUrlFieldSetState
  1293. module.exports.youtubeSuggest = youtubeSuggest
  1294. module.exports.windowMainDisablePowerSaveBlocker = windowMainDisablePowerSaveBlocker
  1295. module.exports.toDoListSingleUrlRemove = toDoListSingleUrlRemove // #102
  1296. module.exports.toDoListSingleUrlAdd = toDoListSingleUrlAdd // #102
  1297. module.exports.imagePreviewModalShow = imagePreviewModalShow
  1298. module.exports.playAudio = playAudio
  1299. module.exports.dataTablesReset = dataTablesReset
  1300. module.exports.truncateString = truncateString