app/js/renderer.js

  1. /**
  2. * @file Contains all renderer code
  3. * @author yafp
  4. * @namespace renderer
  5. */
  7. 'use strict'
  9. // ----------------------------------------------------------------------------
  10. // IMPORT MODULES
  11. // ----------------------------------------------------------------------------
  12. require('v8-compile-cache')
  14. // ----------------------------------------------------------------------------
  15. // IMPORT MEDIA-DUPES MODULES
  16. // ----------------------------------------------------------------------------
  17. const utils = require('./js/modules/utils.js')
  18. const ffmpeg = require('./js/modules/ffmpeg.js')
  19. const ui = require('./js/modules/ui.js')
  20. const settings = require('./js/modules/settings.js')
  21. const youtubeDl = require('./js/modules/youtubeDl.js')
  22. const sentry = require('./js/modules/sentry.js')
  23. const crash = require('./js/modules/crashReporter.js') // crashReporter
  24. const unhandled = require('./js/modules/unhandled.js') // electron-unhandled
  26. // ----------------------------------------------------------------------------
  27. // ERROR HANDLING
  28. // ----------------------------------------------------------------------------
  29. // crash.initCrashReporter() // since electron9: crashReporter.start is deprecated in the renderer process. Call it from the main process instead.
  30. unhandled.initUnhandled()
  32. // ----------------------------------------------------------------------------
  33. // VARIABLES
  34. // ----------------------------------------------------------------------------
  36. // Settings variables
  37. //
  38. var ytdlBinaryVersion = '0.0.0'
  39. var youtubeDlBinaryDetailsVersion
  40. var youtubeDlBinaryDetailsPath
  41. var youtubeDLBinaryDetailsExec
  43. // ----------------------------------------------------------------------------
  44. // FUNCTIONS - MAIN WINDOW CLICKS
  45. // ----------------------------------------------------------------------------
  47. /**
  48. * @function windowMainClickDistract
  49. * @summary Handles the click on the app icon
  50. * @description Triggered from the mainWindow. Starts the easteregg / distract function
  51. * @memberof renderer
  52. */
  53. function windowMainClickDistract () {
  54.     ui.windowMainDistract()
  55. }
  57. /**
  58. * @function windowMainClickButtonAddUrl
  59. * @summary Handles the click on the AddUrl button
  60. * @description Triggered from the mainWindow. Starts the add url function from the module ui
  61. * @memberof renderer
  62. */
  63. function windowMainClickButtonAddUrl () {
  64.     ui.windowMainAddUrl()
  65. }
  67. /**
  68. * @function windowMainClickButtonVideo
  69. * @summary Handles the click on the video button
  70. * @description Triggered from the mainWindow. Starts the video download function from the module ui
  71. * @memberof renderer
  72. */
  73. function windowMainClickButtonVideo () {
  74.     ui.windowMainDownloadContent('video')
  75.     sentry.countEvent('usageButtonVideoExec')
  76. }
  78. /**
  79. * @function windowMainClickButtonVideoV2
  80. * @summary Handles the click on the video button
  81. * @description Triggered from the mainWindow. Starts the video download function from the module ui
  82. * @memberof renderer
  83. */
  84. function windowMainClickButtonVideoV2 () {
  85.     ui.windowMainDownloadVideo()
  86. }
  88. /**
  89. * @function windowMainClickButtonAudio
  90. * @summary Handles the click on the audio button
  91. * @description Triggered from the mainWindow. Starts the audio download function from the module ui
  92. * @memberof renderer
  93. */
  94. function windowMainClickButtonAudio () {
  95.     ui.windowMainDownloadContent('audio')
  96.     sentry.countEvent('usageButtonAudioExec')
  97. }
  99. /**
  100. * @function windowMainClickButtonSettings
  101. * @summary Handles the click on the settings button
  102. * @description Triggered from the mainWindow. Starts the settings UI from the module ui
  103. * @memberof renderer
  104. */
  105. function windowMainClickButtonSettings () {
  106.     ui.windowMainSettingsUiLoad()
  107. }
  109. /**
  110. * @function windowMainClickButtonIntro
  111. * @summary Handles the click on the intro button
  112. * @description Triggered from the mainWindow. Starts the application intro from the module ui
  113. * @memberof renderer
  114. */
  115. function windowMainClickButtonIntro () {
  116.     ui.windowMainIntroShow()
  117. }
  119. /**
  120. * @function windowMainClickButtonDownloads
  121. * @summary Handles the click on the Downloads button
  122. * @description Triggered from the mainWindow. Starts the open-download-folder function from the module ui
  123. * @memberof renderer
  124. */
  125. function windowMainClickButtonDownloads () {
  126.     ui.windowMainOpenDownloadFolder()
  127. }
  129. /**
  130. * @function windowMainClickButtonLogReset
  131. * @summary Handles the click on the log-reset button
  132. * @description Triggered from the mainWindow. Starts the reset-log function from the module ui
  133. * @memberof renderer
  134. */
  135. function windowMainClickButtonLogReset () {
  136.     ui.windowMainLogReset()
  137. }
  139. /**
  140. * @function windowMainClickButtonUIReset
  141. * @summary Handles the click on the reset-UI button
  142. * @description Triggered from the mainWindow. Starts the reset-UI function from the module ui
  143. * @memberof renderer
  144. */
  145. function windowMainClickButtonUIReset () {
  146.     ui.windowMainResetAskUser()
  147. }
  149. // ----------------------------------------------------------------------------
  150. // FUNCTIONS - SETTINGS WINDOW CLICKS
  151. // ----------------------------------------------------------------------------
  152. /**
  153. * @function windowSettingsClickIconUserSettingsDir
  154. * @summary Handles the click on the settings icon
  155. * @description Triggered from the settingsWindow. Starts the open-settings-folder function from the module settings
  156. * @memberof renderer
  157. */
  158. function windowSettingsClickIconUserSettingsDir () {
  159.     settings.settingsFolderOpen()
  160. }
  162. /**
  163. * @function windowSettingsClickButtonChooseDownloadDir
  164. * @summary Handles the click on the choose download dir button. Starts the select-download-dir function from the module settings
  165. * @description Triggered from the settingsWindow.
  166. * @memberof renderer
  167. */
  168. function windowSettingsClickButtonChooseDownloadDir () {
  169.     settings.settingsSelectDownloadDir()
  170. }
  172. /**
  173. * @function windowSettingsClickCheckboxVerboseMode
  174. * @summary Handles the click on the checkbox verbose mode
  175. * @description Triggered from the settingsWindow.
  176. * @memberof renderer
  177. */
  178. function windowSettingsClickCheckboxVerboseMode () {
  179.     settings.settingsToggleVerboseMode()
  180. }
  182. /**
  183. * @function windowSettingsClickCheckboxAdditionalParameter
  184. * @summary Handles the click on the checkbox vadditional parameter
  185. * @description Triggered from the settingsWindow.
  186. * @memberof renderer
  187. */
  188. function windowSettingsClickCheckboxAdditionalParameter () {
  189.     settings.settingsToggleAdditionalParameter()
  190. }
  192. /**
  193. * @function windowSettingsClickButtonAdditionalParameterSave
  194. * @summary Handles the click on the button additional parameter save
  195. * @description Triggered from the settingsWindow.
  196. * @memberof renderer
  197. */
  198. function windowSettingsClickButtonAdditionalParameterSave () {
  199.     settings.settingsSaveAdditionalParameter()
  200. }
  202. /**
  203. * @function windowSettingsClickCheckboxUpdatePolicy
  204. * @summary Handles the click on the checkbox verbose mode
  205. * @description Triggered from the settingsWindow.
  206. * @memberof renderer
  207. */
  208. function windowSettingsClickCheckboxUpdatePolicy () {
  209.     settings.settingsTogglePrereleases()
  210. }
  212. /**
  213. * @function windowSettingsClickIconBug
  214. * @summary Handles the click on the bug icon
  215. * @description Triggered from the settingsWindow.
  216. * @memberof renderer
  217. */
  218. function windowSettingsClickIconBug () {
  219.     settings.settingsOpenDevTools()
  220. }
  222. /**
  223. * @function windowSettingsClickCheckboxErrorReporting
  224. * @summary Handles the click on the checkbox error reporting
  225. * @description Triggered from the settingsWindow.
  226. * @memberof renderer
  227. */
  228. function windowSettingsClickCheckboxErrorReporting () {
  229.     settings.settingsToggleErrorReporting()
  230. }
  232. /**
  233. * @function windowSettingsClickCheckboxErrorReportingMoreInfo
  234. * @summary Handles the click on the question icon in the error reporting section
  235. * @description Triggered from the settingsWindow.
  236. * @memberof renderer
  237. */
  238. function windowSettingsClickCheckboxErrorReportingMoreInfo () {
  239.     const { urlGithubSentryUsage } = require('./js/modules/urls.js') // get url
  240.     utils.openURL(urlGithubSentryUsage)
  241. }
  243. /**
  244. * @function windowSettingsClickDropdownAudioFormats
  245. * @summary Handles the click on the dropdown audio formats
  246. * @description Triggered from the settingsWindow.
  247. * @memberof renderer
  248. */
  249. function windowSettingsClickDropdownAudioFormats () {
  250.     settings.settingsAudioFormatSave()
  251. }
  253. /**
  254. * @function windowSettingsClickOpenUrl
  255. * @summary Handles the click on the dropdown audio formats
  256. * @description Triggered from the settingsWindow.
  257. * @param {string} url - the url
  258. * @memberof renderer
  259. */
  260. function windowSettingsClickOpenUrl (url) {
  261.     settings.settingsOpenExternal(url)
  262. }
  264. /**
  265. * @function windowSettingsClickYoutubeDlUpdate
  266. * @summary Starts the check for youtube-dl updates routine with feedback to the user
  267. * @description Starts the check for youtube-dl updates routine with feedback to the user
  268. * @memberof renderer
  269. */
  270. function windowSettingsClickYoutubeDlUpdate () {
  271.     youtubeDl.binaryUpdateCheck(false, false) // If silent = false -> Forces result feedback, even if no update is available
  272. }
  274. // ----------------------------------------------------------------------------
  275. // FUNCTIONS - OTHERS
  276. // ----------------------------------------------------------------------------
  278. /**
  279. * @function titlebarInit
  280. * @summary Init the titlebar for the frameless mainWindow
  281. * @description Creates a custom titlebar for the mainWindow using custom-electron-titlebar (https://github.com/AlexTorresSk/custom-electron-titlebar).
  282. * @memberof renderer
  283. */
  284. function titlebarInit () {
  285.     const customTitlebar = require('custom-electron-titlebar')
  287.     const myTitlebar = new customTitlebar.Titlebar({
  288.     // new customTitlebar.Titlebar({
  289.         titleHorizontalAlignment: 'center', // position of window title
  290.         icon: 'img/icon/icon.png',
  291.         drag: true, // whether or not you can drag the window by holding the click on the title bar.
  292.         backgroundColor: customTitlebar.Color.fromHex('#343a40'),
  293.         minimizable: true,
  294.         maximizable: true,
  295.         closeable: true,
  296.         unfocusEffect: false, // added in 0.9.0
  297.         itemBackgroundColor: customTitlebar.Color.fromHex('#ffe5e5') // menu item -> hover color
  298.     })
  300.     // Be aware: the font-size of .window-title (aka application name) is set by app/css/core.css
  301.     utils.writeConsoleMsg('info', 'titlebarInit ::: Initialized custom titlebar')
  302. }
  304. /**
  305. * @function checkApplicationDependencies
  306. * @function checkApplicationDependencies
  307. * @summary Checks for missing dependencies
  308. * @description Checks on startup for missing dependencies (youtube-dl and ffmpeg). Both are bundles and should be find
  309. * @memberof renderer
  310. */
  311. function checkApplicationDependencies () {
  312.     var countErrors = 0
  314.     // youtube-dl
  315.     //
  316.     var youtubeDlBinaryPath = youtubeDl.binaryPathGet()
  317.     if (utils.pathExists(youtubeDlBinaryPath) === true) {
  318.         utils.writeConsoleMsg('info', 'checkApplicationDependencies ::: Found youtube-dl in: _' + youtubeDlBinaryPath + '_.')
  319.     } else {
  320.         countErrors = countErrors + 1
  321.         utils.writeConsoleMsg('error', 'checkApplicationDependencies ::: Unable to find youtube-dl in: _' + youtubeDlBinaryPath + '_.')
  322.         utils.showNoty('error', 'Unable to find dependency <b>youtube-dl</b>. Please report this.', 0)
  323.     }
  325.     // ffmpeg
  326.     //
  327.     var ffmpegBinaryPath = ffmpeg.ffmpegGetBinaryPath()
  328.     if (utils.pathExists(ffmpegBinaryPath) === true) {
  329.         utils.writeConsoleMsg('info', 'checkApplicationDependencies ::: Found ffmpeg in: _' + ffmpegBinaryPath + '_.')
  330.     } else {
  331.         countErrors = countErrors + 1
  332.         utils.writeConsoleMsg('error', 'checkApplicationDependencies ::: Unable to find ffmpeg in: _' + ffmpegBinaryPath + '_.')
  333.         utils.showNoty('error', 'Unable to find dependency <b>ffmpeg</b>. Please report this', 0)
  334.     }
  336.     // if errors occured - disable / hide the action buttons
  337.     //
  338.     if (countErrors !== 0) {
  339.         $('#buttonStartVideoExec').hide() // hide video button
  340.         $('#buttonStartVideo').hide() // hide video button
  341.         $('#buttonStartAudioExec').hide() // hide audio button
  342.         utils.showNoty('error', 'Download buttons are now hidden. Please contact the developers via github.', 0)
  343.     }
  345.     utils.writeConsoleMsg('info', 'checkApplicationDependencies ::: Finished checking dependencies. Found overall _' + countErrors + '_ problems.')
  346. }
  348. /**
  349. * @function settingsLoadAllOnAppStart
  350. * @summary Reads all user-setting-files and fills some global variables
  351. * @description Reads all user-setting-files and fills some global variables
  352. * @memberof renderer
  353. */
  354. function settingsLoadAllOnAppStart () {
  355.     utils.writeConsoleMsg('info', 'settingsLoadAllOnAppStart ::: Gonna read several user config files now ...')
  356.     utils.userSettingRead('enableVerboseMode') // verbose mode
  357.     utils.userSettingRead('enableUrlInformations') // url informations
  358.     utils.userSettingRead('enableAdditionalParameter') // additional parameter
  359.     utils.userSettingRead('additionalYoutubeDlParameter') // additional parameter
  360.     utils.userSettingRead('enablePrereleases') // pre-releases
  361.     utils.userSettingRead('enableErrorReporting') // get setting for error-reporting
  362.     utils.userSettingRead('downloadDir') // download dir
  363.     utils.userSettingRead('audioFormat') // get setting for configured audio format
  364. }
  366. /**
  367. * @function settingsLoadAllOnSettingsUiLoad
  368. * @summary Reads all user-setting-files and fills some global variables and adjusts the settings UI
  369. * @description Reads all user-setting-files and fills some global variables and adjusts the settings UI
  370. * @memberof renderer
  371. */
  372. function settingsLoadAllOnSettingsUiLoad () {
  373.     utils.writeConsoleMsg('info', 'settingsLoadAllOnAppStart ::: Gonna read several user config files now and adjust the settings UI')
  374.     utils.userSettingRead('enableVerboseMode', true) // verbose mode
  375.     utils.userSettingRead('enableUrlInformations', true) // url informations
  376.     utils.userSettingRead('enableAdditionalParameter', true) // enable or not: additional parameter
  377.     utils.userSettingRead('additionalYoutubeDlParameter', true) // the actual additional youtube-dl parameter
  378.     utils.userSettingRead('enablePrereleases', true) // pre-releases
  379.     utils.userSettingRead('enableErrorReporting', true) // get setting for error-reporting
  380.     utils.userSettingRead('downloadDir', true) // download dir
  381.     utils.userSettingRead('audioFormat', true) // load configured audio format and update the settings UI
  383.     settings.settingsEnableOrDisableYoutubeDLUpdateButton()
  384. }
  386. /**
  387. * @function urlInputFieldOnKeyUp
  388. * @summary On Key up event, checks if the field is empty or not
  389. * @description On Key up event, checks if the field is empty or not
  390. * @memberof renderer
  391. */
  392. function urlInputFieldOnKeyUp () {
  393.     var currentContentOfUrlInputField = $('#inputNewUrl').val() // get current content of field
  394.     if (currentContentOfUrlInputField === '') {
  395.         utils.writeConsoleMsg('info', 'urlInputFieldOnKeyUp ::: Is now empty, gonna reset the background color')
  396.         ui.inputUrlFieldSetState() // empty = white
  397.     } else {
  398.         ui.inputUrlFieldSetState('unchecked') // unchecked = light red
  400.         var isUrlValid = utils.validURL(currentContentOfUrlInputField)
  401.         if (isUrlValid) {
  402.             utils.writeConsoleMsg('info', 'urlInputFieldOnKeyUp ::: User input is a valid URL (' + currentContentOfUrlInputField + ').')
  403.             ui.inputUrlFieldSetState('valid') // valid = green
  404.         } else {
  405.             // utils.writeConsoleMsg('info', 'urlInputFieldOnKeyUp ::: User input is not a valid URL (' + currentContentOfUrlInputField + ').')
  406.         }
  407.     }
  408. }
  410. /**
  411. * @function urlInputFieldOnKeyPress
  412. * @summary Executed on keypress inside url-input-field
  413. * @description Checks if the key-press was the ENTER-key - if so simulates a press of the button ADD URL
  414. * @memberof renderer
  415. * @event keyCode - The key press event
  416. */
  417. function urlInputFieldOnKeyPress (event) {
  418.     var code = 0
  419.     code = event.keyCode
  420.     if (code === 13) {
  421.         windowMainClickButtonAddUrl() // simulare click on ADD URL buttom
  422.     }
  423. }
  425. /**
  426. * @function urlInputFieldOnFocus
  427. * @summary Handles auto-pasting urls to url input field
  428. * @description Executed on focus - checks if the clipboard contains a valid URL - if so - its auto-pasted into the field
  429. * @memberof renderer
  430. */
  431. function urlInputFieldOnFocus () {
  432.     utils.writeConsoleMsg('info', 'urlInputFieldOnFocus ::: url input field got focus')
  434.     var currentContentOfUrlInputField = $('#inputNewUrl').val() // get current content of field
  436.     // if the field is empty - continue
  437.     if (currentContentOfUrlInputField === '') {
  438.         const { clipboard } = require('electron')
  439.         var currentClipboardContent = clipboard.readText() // get content of clipboard
  440.         currentClipboardContent = currentClipboardContent.trim() // remove leading and trailing blanks
  442.         var isUrlValid = utils.validURL(currentClipboardContent)
  443.         if (isUrlValid) {
  444.             utils.writeConsoleMsg('info', 'urlInputFieldOnFocus ::: Clipboard contains a valid URL: _' + currentClipboardContent + '_.')
  445.             $('#inputNewUrl').val(currentClipboardContent) // paste it
  446.             $('#inputNewUrl').select() // select it entirely
  447.             ui.inputUrlFieldSetState('valid') // valid = green
  448.         } else {
  449.             utils.writeConsoleMsg('warn', 'urlInputFieldOnFocus ::: Clipboard contains a non valid URL: _' + currentClipboardContent + '_.')
  450.         }
  451.     } else {
  452.         // input field is not empty
  453.         // doing nothing at this point
  454.     }
  455. }
  457. /**
  458. * @function searchUpdate
  459. * @summary Checks if there is a new media-dupes release available
  460. * @description Compares the local app version number with the tag of the latest github release. Displays a notification in the settings window if an update is available. Is executed on app launch NOT on reload.
  461. * @memberof renderer
  462. * @param {booean} [silent] - Boolean with default value. Shows a feedback in case of no available updates If 'silent' = false. Special handling for manually triggered update search
  463. */
  464. function searchUpdate (silent = true) {
  465.     var semver = require('semver')
  467.     ui.windowMainApplicationStateSet('Searching media-dupes updates')
  469.     // check if pre-releases should be included or not
  470.     var curEnablePrereleasesSetting = utils.globalObjectGet('enablePrereleases')
  472.     // get url for github releases / api
  473.     const { urlGithubApiReleases } = require('./js/modules/urls.js') // get API url
  475.     var remoteAppVersionLatest = '0.0.0'
  476.     var remoteAppVersionLatestPrerelease = false
  477.     var localAppVersion = '0.0.0'
  478.     var versions
  480.     // get local version
  481.     //
  482.     localAppVersion = require('electron').remote.app.getVersion()
  484.     // var updateStatus = $.get(urlGithubApiReleases, function (data, status) {
  485.     $.get(urlGithubApiReleases, function (data, status) {
  486.         // 3000 // in milliseconds
  488.         utils.writeConsoleMsg('info', 'searchUpdate ::: Accessing _' + urlGithubApiReleases + '_ ended with: _' + status + '_')
  490.         // success
  491.         versions = data.sort(function (v1, v2) {
  492.             // return semver.compare(v2.tag_name, v1.tag_name);
  493.             // console.error(v1.tag_name)
  494.             // console.error(v2.tag_name)
  495.         })
  497.         if (curEnablePrereleasesSetting === true) {
  498.             // user wants the latest release - ignoring if it is a prerelease or an official one
  499.             utils.writeConsoleMsg('info', 'searchUpdate ::: Including pre-releases in update search')
  500.             remoteAppVersionLatest = versions[0].tag_name // Example: 0.4.2
  501.             remoteAppVersionLatestPrerelease = versions[0].prerelease // boolean
  502.         } else {
  503.             // user wants official releases only
  504.             utils.writeConsoleMsg('info', 'searchUpdate ::: Ignoring pre-releases in update search')
  505.             // find the latest non pre-release build
  506.             // loop over the versions array to find the latest non-pre-release
  507.             // var latestOfficialRelease
  508.             for (var i = 0; i < versions.length; i++) {
  509.                 if (versions[i].prerelease === false) {
  510.                     // latestOfficialRelease = i
  511.                     break
  512.                 }
  513.             }
  515.             remoteAppVersionLatest = versions[i].tag_name // Example: 0.4.2
  516.             remoteAppVersionLatestPrerelease = versions[i].prerelease // boolean
  517.         }
  519.         // simulate different  update scenarios:
  520.         //
  521.         // localAppVersion = '0.0.1'; //  overwrite variable to simulate
  522.         // remoteAppVersionLatest = 'v0.6.0' //  overwrite variable to simulate
  524.         // strip the v away
  525.         // - up to 0.5.0 the tag used on github did not start with v.
  526.         // - comapring versions without leading chars is much easier.
  527.         localAppVersion = localAppVersion.replace('v', '')
  528.         remoteAppVersionLatest = remoteAppVersionLatest.replace('v', '')
  530.         utils.writeConsoleMsg('info', 'searchUpdate ::: Local media-dupes version: ' + localAppVersion)
  531.         utils.writeConsoleMsg('info', 'searchUpdate ::: Latest media-dupes version: ' + remoteAppVersionLatest)
  533.         // If a stable (not a prelease) update is available - see #73
  535.         // if (localAppVersion < remoteAppVersionLatest) {
  536.         if (semver.lt(localAppVersion, remoteAppVersionLatest)) {
  537.             utils.writeConsoleMsg('info', 'searchUpdate ::: Found update, notify user')
  539.             // prepare the message for the user - depending on the fact if it is a pre-release or not
  540.             var updateText
  541.             if (remoteAppVersionLatestPrerelease === false) {
  542.                 updateText = 'A media-dupes update from <b>' + localAppVersion + '</b> to version <b>' + remoteAppVersionLatest + '</b> is available. Do you want to visit the release page?'
  543.             } else {
  544.                 updateText = 'A media-dupes <b>pre-release</b> update from <b>' + localAppVersion + '</b> to version <b>' + remoteAppVersionLatest + '</b> is available. Do you want to visit the release page?'
  545.             }
  547.             // ask user using a noty confirm dialog
  548.             const Noty = require('noty')
  549.             var n = new Noty(
  550.                 {
  551.                     theme: 'bootstrap-v4',
  552.                     layout: 'bottom',
  553.                     type: 'info',
  554.                     closeWith: [''], // to prevent closing the confirm-dialog by clicking something other then a confirm-dialog-button
  555.                     text: updateText,
  556.                     buttons: [
  557.                         Noty.button('Yes', 'btn btn-success mediaDupes_btnDefaultWidth', function () {
  558.                             n.close()
  559.                             openReleasesOverview()
  560.                         },
  561.                         {
  562.                             id: 'button1', 'data-status': 'ok'
  563.                         }),
  565.                         Noty.button('No', 'btn btn-secondary mediaDupes_btnDefaultWidth float-right', function () {
  566.                             n.close()
  568.                             if (remoteAppVersionLatestPrerelease === false) {
  569.                                 utils.showNoty('warning', 'Please be aware that not updating <b>media-dupes</b> will result in an <b>outdated youtube-dl version</b> which again will result in download errors.', 0)
  570.                             }
  571.                         })
  572.                     ]
  573.                 })
  575.             // show the noty dialog
  576.             n.show()
  577.         } else {
  578.             utils.writeConsoleMsg('info', 'searchUpdate ::: No newer version of media-dupes found.')
  580.             // when executed manually via menu -> user should see result of this search
  581.             if (silent === false) {
  582.                 utils.showNoty('info', 'No updates for <b>media-dupes (' + localAppVersion + ')</b> available.')
  583.             }
  584.         }
  586.         utils.writeConsoleMsg('info', 'searchUpdate ::: Successfully checked ' + urlGithubApiReleases + ' for available releases')
  587.     })
  588.         .done(function () {
  589.         // utils.writeConsoleMsg('info', 'searchUpdate ::: Successfully checked ' + urlGithubApiReleases + ' for available releases');
  590.         })
  592.         .fail(function () {
  593.             utils.writeConsoleMsg('info', 'searchUpdate ::: Checking ' + urlGithubApiReleases + ' for available releases failed.')
  594.             utils.showNoty('error', 'Checking <b>' + urlGithubApiReleases + '</b> for available media-dupes releases failed. Please troubleshoot your network connection.', 0)
  595.         })
  597.         .always(function () {
  598.             utils.writeConsoleMsg('info', 'searchUpdate ::: Finished checking ' + urlGithubApiReleases + ' for available releases')
  599.             ui.windowMainButtonsOthersEnable()
  600.             ui.windowMainApplicationStateSet()
  601.         })
  602. }
  604. /**
  605. * @function openReleasesOverview
  606. * @summary Opens the media-dupes release page
  607. * @description Opens the url https://github.com/yafp/media-dupes/releases in the default browser. Used in searchUpdate().
  608. * @memberof renderer
  609. */
  610. function openReleasesOverview () {
  611.     const { urlGitHubReleases } = require('./js/modules/urls.js')
  612.     utils.writeConsoleMsg('info', 'openReleasesOverview ::: Opening _' + urlGitHubReleases + '_ to show available releases.')
  613.     utils.openURL(urlGitHubReleases)
  614. }
  616. /**
  617. * @function settingsShowYoutubeDLInfo
  618. * @summary Searches the youtube-binary and shows it in the settings UI
  619. * @description Searches the youtube-binary and shows it in the settings UI
  620. * @memberof renderer
  621. */
  622. function settingsShowYoutubeDLInfo () {
  623.     const youtubedl = require('youtube-dl')
  625.     settingsGetYoutubeDLBinaryVersion(function () {
  626.         utils.writeConsoleMsg('info', 'settingsShowYoutubeDLInfo ::: Searching youtube-dl ...')
  627.         var youtubeDl = youtubedl.getYtdlBinary()
  628.         if (youtubeDl === '') {
  629.             utils.writeConsoleMsg('error', 'settingsShowYoutubeDLInfo ::: Unable to find youtube-dl')
  630.             utils.showNoty('error', 'Unable to find dependency <b>youtube-dl</b>.', 0)
  631.         } else {
  632.             utils.writeConsoleMsg('info', 'settingsShowYoutubeDLInfo ::: Found youtube-dl in: _' + youtubeDl + '_.')
  633.             $('#userSettingsYouTubeDLPathInfo').val(youtubeDl) // show in UI
  634.             $('#headerYoutubeDL').html('Installation <small>Version: ' + ytdlBinaryVersion + '</small>')
  635.         }
  636.     })
  637. }
  639. /**
  640. * @function settingsShowFfmpegInfo
  641. * @summary Searches the ffmpeg-binary and shows it in the settings UI
  642. * @description Searches the ffmpeg-binary and shows it in the settings UI
  643. * @memberof renderer
  644. */
  645. function settingsShowFfmpegInfo () {
  646.     var ffmpeg = require('ffmpeg-static-electron')
  647.     // utils.writeConsoleMsg('info', 'settingsShowFfmpegInfo ::: Searching ffmpeg ...')
  648.     if (ffmpeg === '') {
  649.         utils.writeConsoleMsg('error', 'settingsShowFfmpegInfo ::: Unable to find ffmpeg')
  650.         utils.showNoty('error', 'Unable to find dependency <b>ffmpeg</b>.', 0)
  651.     } else {
  652.         utils.writeConsoleMsg('info', 'settingsShowFfmpegInfo ::: Found ffmpeg in: _' + ffmpeg.path + '_.')
  653.         $('#userSettingsFfmpegPathInfo').val(ffmpeg.path) // show in UI
  654.     }
  655. }
  657. /**
  658. * @function settingsGetYoutubeDLBinaryVersion
  659. * @summary Gets the youtube-dl binary version and displays it in settings ui
  660. * @description Reads the youtube-dl binary version from 'node_modules/youtube-dl/bin/details'
  661. * @memberof renderer
  662. * @return ytdlBinaryVersion - The youtube-dl binary version string
  663. */
  664. function settingsGetYoutubeDLBinaryVersion (_callback) {
  665.     const fs = require('fs')
  667.     var youtubeDlBinaryDetailsPath = youtubeDl.binaryDetailsPathGet() // get path to youtube-dl binary details
  668.     fs.readFile(youtubeDlBinaryDetailsPath, 'utf8', function (error, contents) {
  669.         if (error) {
  670.             utils.writeConsoleMsg('error', 'settingsGetYoutubeDLBinaryVersion ::: Unable to detect youtube-dl binary version. Error: ' + error + '.')
  671.             utils.showNoty('error', 'Unable to detect local youtube-dl binary version number. Error: ' + error, 0) // see sentry issue: MEDIA-DUPES-5A
  672.             throw error
  673.         } else {
  674.             const data = JSON.parse(contents)
  675.             ytdlBinaryVersion = data.version // extract and store the version number
  676.             utils.writeConsoleMsg('info', 'settingsGetYoutubeDLBinaryVersion ::: youtube-dl binary is version: _' + ytdlBinaryVersion + '_.')
  677.             _callback()
  678.         }
  679.     })
  680. }
  682. /**
  683. * @function validateUrlBeforeAdd
  684. * @summary Gets the content of the url field, checks if it is a valid url, if so checks if it is reachable or not
  685. * @description Gets the content of the url field, checks if it is a valid url, if so checks if it is reachable or not
  686. * @memberof renderer
  687. */
  688. function validateUrlBeforeAdd () {
  689.     var currentContentOfUrlInputField = $('#inputNewUrl').val() // get current content of field
  691.     // if the field is empty - continue
  692.     if (currentContentOfUrlInputField === '') {
  693.         utils.writeConsoleMsg('info', 'validateUrlBeforeAdd ::: Empty field')
  694.     } else {
  695.         var isUrlValid = utils.validURL(currentContentOfUrlInputField)
  696.         if (isUrlValid) {
  697.             utils.writeConsoleMsg('info', 'validateUrlBeforeAdd ::: URL seems valid URL (' + currentContentOfUrlInputField + ').')
  698.         } else {
  699.             utils.writeConsoleMsg('info', 'urlInputFieldOnFocus ::: Clipboard contains a non valid URL (' + currentContentOfUrlInputField + ').')
  700.         }
  701.     }
  702. }
  704. // ----------------------------------------------------------------------------
  705. // IPC
  706. // ----------------------------------------------------------------------------
  708. // ----------------------------------------------------------------------------
  709. // IPC - on ready-to-show
  710. // ----------------------------------------------------------------------------
  712. /**
  713. * @name startSearchUpdatesSilent
  714. * @summary Triggers the check for media-dupes updates in silent mode
  715. * @description Called via ipc from main.js on-ready to start the search for media-dupes updates
  716. * @memberof renderer
  717. */
  718. /*
  719. require('electron').ipcRenderer.on('startSearchUpdatesSilent', function () {
  720.     searchUpdate(true) // If silent = false -> Forces result feedback, even if no update is available
  721. })
  722. */
  724. /**
  725. * @name youtubeDlSearchUpdatesSilent
  726. * @summary Triggers the check for youtube-dl updates in silent mode
  727. * @description Called via ipc from main.js on-ready to check the search for youtube-dl updates
  728. * @memberof renderer
  729. */
  730. /*
  731. require('electron').ipcRenderer.on('youtubeDlSearchUpdatesSilent', function () {
  732.     youtubeDl.binaryUpdateCheck(true, false) // If silent = false -> Forces result feedback, even if no update is available
  733. })
  734. */
  736. /**
  737. * @name initSettings
  738. * @summary Triggers the check for the application dependencies
  739. * @description Called via ipc from main.js on-ready to check the application dependencies
  740. * @memberof renderer
  741. */
  742. /*
  743. require('electron').ipcRenderer.on('initSettings', function () {
  744.     settingsLoadAllOnAppStart()
  745. })
  746. */
  748. /**
  749. * @name startCheckingDependencies
  750. * @summary Triggers the check for the application dependencies
  751. * @description Called via ipc from main.js on-ready to check the application dependencies
  752. * @memberof renderer
  753. */
  754. require('electron').ipcRenderer.on('startCheckingDependencies', function () {
  755.     checkApplicationDependencies()
  756. })
  758. /**
  759. * @name scheduleUpdateCheckMediaDupes
  760. * @summary Starts the silent search for media-dupes updates
  761. * @description Starts the silent search for media-dupes updates after several seconds (to speed up the application startup)
  762. * @memberof renderer
  763. */
  764. require('electron').ipcRenderer.on('scheduleUpdateCheckMediaDupes', function () {
  765.     setTimeout(
  766.         function () {
  767.             utils.writeConsoleMsg('info', 'scheduleUpdateCheckMediaDupes ::: Starting scheduled search for new media-dupes updates.')
  768.             searchUpdate(true) // silent
  769.         }, 3000) // after 3 seconds
  770. })
  772. /**
  773. * @name scheduleUpdateCheckYoutubeDl
  774. * @summary Starts the silent search for youtube-dl updates
  775. * @description Starts the silent search for youtube-dl updates after several seconds (to speed up the application startup)
  776. * @memberof renderer
  777. */
  778. require('electron').ipcRenderer.on('scheduleUpdateCheckYoutubeDl', function () {
  779.     setTimeout(
  780.         function () {
  781.             utils.writeConsoleMsg('info', 'scheduleUpdateCheckYoutubeDl ::: Starting scheduled search for new youtube-dl updates.')
  782.             youtubeDl.binaryUpdateCheck(true, false) // If silent = false -> Forces result feedback, even if no update is available
  783.         }, 3000) // after 3 seconds
  784. })
  786. /**
  787. * @name startDisclaimerCheck
  788. * @summary Triggers the check for disclaimer need
  789. * @description Called via ipc from main.js on-ready to check for the disclaimer need
  790. * @memberof renderer
  791. */
  792. require('electron').ipcRenderer.on('startDisclaimerCheck', function () {
  793.     utils.disclaimerCheck()
  794. })
  796. /**
  797. * @name todoListCheck
  798. * @summary Triggers the check restoring previosly stored urls
  799. * @description Called via ipc from main.js on-ready-to-show and starts the restore function
  800. * @memberof renderer
  801. */
  802. require('electron').ipcRenderer.on('todoListCheck', function () {
  803.     // utils.writeConsoleMsg('info', 'todoListCheck ::: main.js forces renderer to check for urls to restore')
  804.     ui.windowMainToDoListRestore()
  805. })
  807. // ----------------------------------------------------------------------------
  808. // IPC - by menu
  809. // ----------------------------------------------------------------------------
  811. /**
  812. * @name startSearchUpdatesVerbose
  813. * @summary Start searching for updates in non-silent mode
  814. * @description Called via ipc from main.js / menu to search for applicatipn updates
  815. * @memberof renderer
  816. */
  817. require('electron').ipcRenderer.on('startSearchUpdatesVerbose', function () {
  818.     searchUpdate(false) // silent = false. Forces result feedback, even if no update is available
  819. })
  821. /**
  822. * @name openSettings
  823. * @summary Triggers loading the settings UI
  824. * @description Called via ipc from main.js / menu to open the Settings UI
  825. * @memberof renderer
  826. */
  827. require('electron').ipcRenderer.on('openSettings', function () {
  828.     ui.windowMainSettingsUiLoad()
  829. })
  831. /**
  832. * @name openYoutubeSuggestDialog
  833. * @summary Triggers a input dialog to search for youtube suggest based on an input string
  834. * @description Called via ipc from main.js / menu to ....
  835. * @memberof renderer
  836. */
  837. require('electron').ipcRenderer.on('openYoutubeSuggestDialog', function () {
  838.     ui.youtubeSuggest()
  839. })
  841. /**
  842. * @name youtubeDlBinaryUpdate
  843. * @summary Triggers updating the youtube-dl binary
  844. * @description Called via ipc from main.js / menu to update the youtube-dl binary
  845. * @memberof renderer
  846. */
  847. require('electron').ipcRenderer.on('youtubeDlBinaryUpdate', function () {
  848.     youtubeDl.binaryUpdateCheck(false, true) // silent = false && force = true
  849. })
  851. /**
  852. * @name youtubeDlBinaryPathReset
  853. * @summary Triggers resetting the path to the youtube-dl binary back to default
  854. * @description Called via ipc from main.js / menu to reset the path to the youtube-dl binary
  855. * @memberof renderer
  856. */
  857. require('electron').ipcRenderer.on('youtubeDlBinaryPathReset', function () {
  858.     var youtubeDlBinaryDetailsPath = youtubeDl.binaryDetailsPathGet() // get path to youtube-dl binary details file
  860.     utils.canWriteFileOrFolder(youtubeDlBinaryDetailsPath, function (error, isWritable) {
  861.         if (error) {
  862.             utils.writeConsoleMsg('error', 'youtubeDlBinaryPathReset ::: Error while trying to check if the youtube-dl details file is writeable or not. Error: ' + error)
  863.             throw error
  864.         }
  866.         if (isWritable === true) {
  867.             utils.writeConsoleMsg('info', 'youtubeDlBinaryPathReset ::: :  Found the youtube-dl details file and it is writeable. Gonna ask the user now if he wants to reset the path now')
  869.             // ask the user if he wants to update using a confirm dialog
  870.             const Noty = require('noty')
  871.             var n = new Noty(
  872.                 {
  873.                     theme: 'bootstrap-v4',
  874.                     layout: 'bottom',
  875.                     type: 'info',
  876.                     closeWith: [''], // to prevent closing the confirm-dialog by clicking something other then a confirm-dialog-button
  877.                     text: 'Do you really want to reset the youtube-dl binary path back to its default value?',
  878.                     buttons: [
  879.                         Noty.button('Yes', 'btn btn-success mediaDupes_btnDownloadActionWidth', function () {
  880.                             n.close()
  881.                             youtubeDl.binaryPathReset(youtubeDlBinaryDetailsPath)
  882.                         },
  883.                         {
  884.                             id: 'button1', 'data-status': 'ok'
  885.                         }),
  887.                         Noty.button('No', 'btn btn-secondary mediaDupes_btnDownloadActionWidth float-right', function () {
  888.                             n.close()
  889.                         })
  890.                     ]
  891.                 })
  893.             n.show() // show the noty dialog
  894.         } else {
  895.             // details file cant be resetted due to permission issues
  896.             utils.writeConsoleMsg('warn', 'youtubeDlBinaryPathReset ::: Found youtube-dl binary update, but unable to execute update due to permissions')
  897.             utils.showNoty('error', 'Unable to reset the <b>youtube-dl</b> setup due to permissions issues. The file: ' + youtubeDlBinaryDetailsPath + ' is not writeable.')
  898.         }
  899.     })
  901.     utils.writeConsoleMsg('info', 'youtubeDlBinaryPathReset ::: Finished re-setting the binary path for youtube-dl')
  902. })
  904. // ----------------------------------------------------------------------------
  905. // IPC - by power-state
  906. // ----------------------------------------------------------------------------
  908. /**
  909. * @name powerMonitorNotification
  910. * @summary Triggers power specific notifications to the UI
  911. * @description Called via ipc from main.js to trigger a notification about the powerState
  912. * @memberof renderer
  913. */
  914. require('electron').ipcRenderer.on('powerMonitorNotification', function (event, messageType, messageText, messageDuration) {
  915.     utils.writeConsoleMsg('warn', 'powerMonitorNotification ::: Main wants to show a notification of the type: _' + messageType + '_ and the message: _' + messageText + '_ with the duration: _' + messageDuration + '_.')
  916.     utils.showNoty(messageType, messageText, messageDuration)
  917. })
  919. // ----------------------------------------------------------------------------
  920. // IPC - by settings window closed
  921. // ----------------------------------------------------------------------------
  923. /**
  924. * @name unblurMainUI
  925. * @summary Triggers unbluring the UI
  926. * @description Called via ipc from main.js when the settings UI got closed to trigger unblur'ing the main UI
  927. * @memberof renderer
  929. */
  930. require('electron').ipcRenderer.on('unblurMainUI', function () {
  931.     ui.windowMainBlurSet(false)
  932. })
  934. /**
  935. * @name blurMainUI
  936. * @summary Triggers bluring the UI
  937. * @description Called via ipc from main.js when the main window is ready-to-show
  938. * @memberof renderer
  939. */
  940. require('electron').ipcRenderer.on('blurMainUI', function () {
  941.     ui.windowMainBlurSet(true)
  942. })
  944. /**
  945. * @name countAppStarts
  946. * @summary ..
  947. * @description Called via ipc from main.js when the main window is ready-to-show
  948. * @memberof renderer
  949. */
  950. require('electron').ipcRenderer.on('countAppStarts', function () {
  951.     sentry.countEvent('usageApplicationStarted')
  952. })
  954. // ----------------------------------------------------------------------------
  955. // IPC - by mainwindow close event
  956. // ----------------------------------------------------------------------------
  958. /**
  959. * @name todoListTryToSave
  960. * @summary Triggers saving of the current todoList
  961. * @description Called via ipc from main.js  when the application gets closed Should save existing todoList entries
  962. * @memberof renderer
  963. */
  964. require('electron').ipcRenderer.on('todoListTryToSave', function () {
  965.     ui.windowMainToDoListSave()
  966. })