feat: add preference to customize global trackers (#1836)

* Add preference to customize global trackers. Requires restart to apply

* Use IPC to pass global trackers list, torrent pause and resume will now update trackers

* Make the default tracker list an array from array of arrays

* Use globalThis instead of just global

Co-authored-by: Diego Rodríguez Baquero <github@diegorbaquero.com>

src/renderer/controllers/torrent-list-controller.js

@@ -113,6 +113,10 @@ module.exports = class TorrentListController {
     }
   }
 
+  setGlobalTrackers (globalTrackers) {
+    ipcRenderer.send('wt-set-global-trackers', globalTrackers)
+  }
+
   // TODO: use torrentKey, not infoHash
   toggleTorrent (infoHash) {
     const torrentSummary = TorrentSummary.getByKey(this.state, infoHash)

src/renderer/lib/state.js

@@ -3,6 +3,7 @@ const path = require('path')
 const { EventEmitter } = require('events')
 
 const config = require('../../config')
+const defaultAnnounceList = require('create-torrent').announceList.map((arr) => arr[0])
 
 const SAVE_DEBOUNCE_INTERVAL = 1000
 
@@ -79,6 +80,7 @@ function getDefaultState () {
     getPlayingTorrentSummary,
     getPlayingFileSummary,
     getExternalPlayerName,
+    getGlobalTrackers,
     shouldHidePlayerControls
   }
 }
@@ -129,7 +131,8 @@ function setupStateSaved () {
       soundNotifications: true,
       autoAddTorrents: false,
       torrentsFolderPath: '',
-      highestPlaybackPriority: true
+      highestPlaybackPriority: true,
+      globalTrackers: defaultAnnounceList
     },
     torrents: config.DEFAULT_TORRENTS.map(createTorrentObject),
     torrentsToResume: [],
@@ -201,6 +204,14 @@ function shouldHidePlayerControls () {
     this.playing.location === 'local'
 }
 
+function getGlobalTrackers () {
+  const trackers = this.saved.prefs.globalTrackers
+  if (!trackers) {
+    return defaultAnnounceList
+  }
+  return trackers
+}
+
 async function load (cb) {
   let saved = await appConfig.read()
 

src/renderer/main.js

@@ -124,6 +124,9 @@ function onState (err, _state) {
     }
   })
 
+  // Give global trackers
+  setGlobalTrackers()
+
   // Restart everything we were torrenting last time the app ran
   resumeTorrents()
 
@@ -314,6 +317,7 @@ const dispatchHandlers = {
   preferences: () => controllers.prefs().show(),
   updatePreferences: (key, value) => controllers.prefs().update(key, value),
   checkDownloadPath,
+  updateGlobalTrackers: (trackers) => setGlobalTrackers(trackers),
   startFolderWatcher: () => controllers.folderWatcher().start(),
   stopFolderWatcher: () => controllers.folderWatcher().stop(),
 
@@ -416,6 +420,10 @@ function escapeBack () {
   }
 }
 
+function setGlobalTrackers () {
+  controllers.torrentList().setGlobalTrackers(state.getGlobalTrackers())
+}
+
 // Starts all torrents that aren't paused on program startup
 function resumeTorrents () {
   state.saved.torrents

src/renderer/pages/preferences-page.js

@@ -4,6 +4,7 @@ const PropTypes = require('prop-types')
 const colors = require('material-ui/styles/colors')
 const Checkbox = require('material-ui/Checkbox').default
 const RaisedButton = require('material-ui/RaisedButton').default
+const TextField = require('material-ui/TextField').default
 const Heading = require('../components/heading')
 const PathSelector = require('../components/path-selector')
 
@@ -28,6 +29,15 @@ class PreferencesPage extends React.Component {
 
     this.handleSoundNotificationsChange =
       this.handleSoundNotificationsChange.bind(this)
+
+    this.handleSetGlobalTrackers =
+      this.handleSetGlobalTrackers.bind(this)
+
+    const globalTrackers = this.props.state.getGlobalTrackers().join('\n')
+
+    this.state = {
+      globalTrackers
+    }
   }
 
   downloadPathSelector () {
@@ -229,6 +239,39 @@ class PreferencesPage extends React.Component {
     dispatch('updatePreferences', 'isFileHandler', true)
   }
 
+  setGlobalTrackers () {
+    // Align the text fields
+    const textFieldStyle = { width: '100%' }
+    const textareaStyle = { margin: 0 }
+
+    return (
+      <Preference>
+        <TextField
+          className='torrent-trackers control'
+          style={textFieldStyle}
+          textareaStyle={textareaStyle}
+          multiLine
+          rows={2}
+          rowsMax={10}
+          value={this.state.globalTrackers}
+          onChange={this.handleSetGlobalTrackers}
+        />
+      </Preference>
+    )
+  }
+
+  handleSetGlobalTrackers (e, globalTrackers) {
+    this.setState({ globalTrackers })
+
+    const announceList = globalTrackers
+      .split('\n')
+      .map((s) => s.trim())
+      .filter((s) => s !== '')
+
+    dispatch('updatePreferences', 'globalTrackers', announceList)
+    dispatch('updateGlobalTrackers', announceList)
+  }
+
   render () {
     const style = {
       color: colors.grey400,
@@ -254,6 +297,9 @@ class PreferencesPage extends React.Component {
           {this.setStartupCheckbox()}
           {this.soundNotificationsCheckbox()}
         </PreferencesSection>
+        <PreferencesSection title='Trackers'>
+          {this.setGlobalTrackers()}
+        </PreferencesSection>
       </div>
     )
   }

src/renderer/webtorrent.js

@@ -4,7 +4,6 @@ console.time('init')
 
 const crypto = require('crypto')
 const util = require('util')
-const defaultAnnounceList = require('create-torrent').announceList
 const { ipcRenderer } = require('electron')
 const fs = require('fs')
 const mm = require('music-metadata')
@@ -16,11 +15,6 @@ const config = require('../config')
 const { TorrentKeyNotFoundError } = require('./lib/errors')
 const torrentPoster = require('./lib/torrent-poster')
 
-// Force use of webtorrent trackers on all torrents
-globalThis.WEBTORRENT_ANNOUNCE = defaultAnnounceList
-  .map((arr) => arr[0])
-  .filter((url) => url.indexOf('wss://') === 0 || url.indexOf('ws://') === 0)
-
 /**
  * WebTorrent version.
  */
@@ -65,6 +59,8 @@ init()
 function init () {
   listenToClientEvents()
 
+  ipcRenderer.on('wt-set-global-trackers', (e, globalTrackers) =>
+    setGlobalTrackers(globalTrackers))
   ipcRenderer.on('wt-start-torrenting', (e, torrentKey, torrentID, path, fileModtimes, selections) =>
     startTorrenting(torrentKey, torrentID, path, fileModtimes, selections))
   ipcRenderer.on('wt-stop-torrenting', (e, infoHash) =>
@@ -99,6 +95,11 @@ function listenToClientEvents () {
   client.on('error', (err) => ipcRenderer.send('wt-error', null, err.message))
 }
 
+// Sets the default trackers
+function setGlobalTrackers (globalTrackers) {
+  globalThis.WEBTORRENT_ANNOUNCE = globalTrackers
+}
+
 // Starts a given TorrentID, which can be an infohash, magnet URI, etc.
 // Returns a WebTorrent object. See https://git.io/vik9M
 function startTorrenting (torrentKey, torrentID, path, fileModtimes, selections) {