Merge branch 'master' into master

src/crash-reporter.js

@@ -6,9 +6,10 @@ function init () {
   const config = require('./config')
   const { crashReporter } = require('electron')
 
-  crashReporter.start({
-    companyName: config.APP_NAME,
+crashReporter.start({
     productName: config.APP_NAME,
-    submitURL: config.CRASH_REPORT_URL
+    submitURL: config.CRASH_REPORT_URL,
+    globalExtra: { _companyName: config.APP_NAME },
+    compress: true
   })
 }

src/main/dialog.js

@@ -34,13 +34,13 @@ function openSeedDirectory () {
   log('openSeedDirectory')
   const opts = process.platform === 'darwin'
     ? {
-      title: 'Select a file or folder for the torrent.',
-      properties: ['openFile', 'openDirectory']
-    }
+        title: 'Select a file or folder for the torrent.',
+        properties: ['openFile', 'openDirectory']
+      }
     : {
-      title: 'Select a folder for the torrent.',
-      properties: ['openDirectory']
-    }
+        title: 'Select a folder for the torrent.',
+        properties: ['openDirectory']
+      }
   showOpenSeed(opts)
 }
 
@@ -53,13 +53,13 @@ function openFiles () {
   log('openFiles')
   const opts = process.platform === 'darwin'
     ? {
-      title: 'Select a file or folder to add.',
-      properties: ['openFile', 'openDirectory']
-    }
+        title: 'Select a file or folder to add.',
+        properties: ['openFile', 'openDirectory']
+      }
     : {
-      title: 'Select a file to add.',
-      properties: ['openFile']
-    }
+        title: 'Select a file to add.',
+        properties: ['openFile']
+      }
   setTitle(opts.title)
   const selectedPaths = dialog.showOpenDialogSync(windows.main.win, opts)
   resetTitle()

src/main/external-player.js

@@ -17,12 +17,12 @@ let proc = null
 function checkInstall (playerPath, cb) {
   // check for VLC if external player has not been specified by the user
   // otherwise assume the player is installed
-  if (playerPath == null) return vlcCommand(cb)
+  if (!playerPath) return vlcCommand(cb)
   process.nextTick(() => cb(null))
 }
 
 function spawn (playerPath, url, title) {
-  if (playerPath != null) return spawnExternal(playerPath, [url])
+  if (playerPath) return spawnExternal(playerPath, [url])
 
   // Try to find and use VLC if external player is not specified
   vlcCommand((err, vlcPath) => {

src/main/index.js

@@ -2,10 +2,13 @@ console.time('init')
 
 const { app, ipcMain } = require('electron')
 
+// Start crash reporter early, so it takes effect for child processes
+const crashReporter = require('../crash-reporter')
+crashReporter.init()
+
 const parallel = require('run-parallel')
 
 const config = require('../config')
-const crashReporter = require('../crash-reporter')
 const ipc = require('./ipc')
 const log = require('./log')
 const menu = require('./menu')
@@ -106,10 +109,6 @@ function init () {
 
   ipc.init()
 
-  app.once('will-finish-launching', function () {
-    crashReporter.init()
-  })
-
   app.once('ipcReady', function () {
     log('Command line args:', argv)
     processArgv(argv)
@@ -196,9 +195,13 @@ function onAppOpen (newArgv) {
 // Development: 2 args, eg: electron .
 // Test: 4 args, eg: electron -r .../mocks.js .
 function sliceArgv (argv) {
-  return argv.slice(config.IS_PRODUCTION ? 1
-    : config.IS_TEST ? 4
-      : 2)
+  return argv.slice(
+    config.IS_PRODUCTION
+      ? 1
+      : config.IS_TEST
+        ? 4
+        : 2
+  )
 }
 
 function processArgv (argv) {

src/main/ipc.js

@@ -137,9 +137,10 @@ function init () {
    * Shell
    */
 
-  ipcMain.on('openItem', (e, ...args) => {
+
+  ipcMain.on('openPath', (e, ...args) => {
     const shell = require('./shell')
-    shell.openItem(...args)
+    shell.openPath(...args)
   })
   ipcMain.on('showItemInFolder', (e, ...args) => {
     const shell = require('./shell')

src/main/shell.js

@@ -1,6 +1,6 @@
 module.exports = {
   openExternal,
-  openItem,
+  openPath,
   showItemInFolder,
   moveItemToTrash
 }
@@ -19,9 +19,10 @@ function openExternal (url) {
 /**
  * Open the given file in the desktop’s default manner.
  */
-function openItem (path) {
-  log(`openItem: ${path}`)
-  shell.openItem(path)
+
+function openPath (path) {
+  log(`openPath: ${path}`)
+  shell.openPath(path)
 }
 
 /**

src/main/squirrel-win32.js

@@ -2,148 +2,39 @@ module.exports = {
   handleEvent
 }
 
-const cp = require('child_process')
 const { app } = require('electron')
-const fs = require('fs')
-const os = require('os')
+
 const path = require('path')
+const spawn = require('child_process').spawn
 
 const handlers = require('./handlers')
 
 const EXE_NAME = path.basename(process.execPath)
 const UPDATE_EXE = path.join(process.execPath, '..', '..', 'Update.exe')
 
-function handleEvent (cmd) {
-  if (cmd === '--squirrel-install') {
-    // App was installed. Install desktop/start menu shortcuts.
-    createShortcuts(function () {
-      // Ensure user sees install splash screen so they realize that Setup.exe actually
-      // installed an application and isn't the application itself.
-      setTimeout(function () {
-        app.quit()
-      }, 3000)
-    })
-    return true
-  }
+const run = function (args, done) {
+  spawn(UPDATE_EXE, args, { detached: true })
+    .on('close', done)
+}
 
-  if (cmd === '--squirrel-updated') {
-    // App was updated. (Called on new version of app)
-    updateShortcuts(function () {
-      app.quit()
-    })
+function handleEvent (cmd) {
+  if (cmd === '--squirrel-install' || cmd === '--squirrel-updated') {
+    run([`--createShortcut=${EXE_NAME}`], app.quit)
     return true
   }
 
   if (cmd === '--squirrel-uninstall') {
-    // App was just uninstalled. Undo anything we did in the --squirrel-install and
-    // --squirrel-updated handlers
-
     // Uninstall .torrent file and magnet link handlers
     handlers.uninstall()
 
-    // Remove desktop/start menu shortcuts.
-    // HACK: add a callback to handlers.uninstall() so we can remove this setTimeout
-    setTimeout(function () {
-      removeShortcuts(function () {
-        app.quit()
-      })
-    }, 1000)
-
+    run([`--removeShortcut=${EXE_NAME}`], app.quit)
     return true
   }
 
   if (cmd === '--squirrel-obsolete') {
-    // App will be updated. (Called on outgoing version of app)
     app.quit()
     return true
   }
 
-  if (cmd === '--squirrel-firstrun') {
-    // App is running for the first time. Do not quit, allow startup to continue.
-    return false
-  }
-
   return false
 }
-
-/**
- * Spawn a command and invoke the callback when it completes with an error and
- * the output from standard out.
- */
-function spawn (command, args, cb) {
-  let stdout = ''
-  let error = null
-  let child = null
-  try {
-    child = cp.spawn(command, args)
-  } catch (err) {
-    // Spawn can throw an error
-    process.nextTick(function () {
-      cb(error, stdout)
-    })
-    return
-  }
-
-  child.stdout.on('data', function (data) {
-    stdout += data
-  })
-
-  child.on('error', function (processError) {
-    error = processError
-  })
-
-  child.on('close', function (code, signal) {
-    if (code !== 0 && !error) error = new Error('Command failed: #{signal || code}')
-    if (error) error.stdout = stdout
-    cb(error, stdout)
-  })
-}
-
-/**
- * Spawn the Squirrel `Update.exe` command with the given arguments and invoke
- * the callback when the command completes.
- */
-function spawnUpdate (args, cb) {
-  spawn(UPDATE_EXE, args, cb)
-}
-
-/**
- * Create desktop and start menu shortcuts using the Squirrel `Update.exe`
- * command.
- */
-function createShortcuts (cb) {
-  spawnUpdate(['--createShortcut', EXE_NAME], cb)
-}
-
-/**
- * Update desktop and start menu shortcuts using the Squirrel `Update.exe`
- * command.
- */
-function updateShortcuts (cb) {
-  const homeDir = os.homedir()
-  if (homeDir) {
-    const desktopShortcutPath = path.join(homeDir, 'Desktop', 'WebTorrent.lnk')
-    // If the desktop shortcut was deleted by the user, then keep it deleted.
-    fs.access(desktopShortcutPath, function (err) {
-      const desktopShortcutExists = !err
-      createShortcuts(function () {
-        if (desktopShortcutExists) {
-          cb()
-        } else {
-          // Remove the unwanted desktop shortcut that was recreated
-          fs.unlink(desktopShortcutPath, cb)
-        }
-      })
-    })
-  } else {
-    createShortcuts(cb)
-  }
-}
-
-/**
- * Remove desktop and start menu shortcuts using the Squirrel `Update.exe`
- * command.
- */
-function removeShortcuts (cb) {
-  spawnUpdate(['--removeShortcut', EXE_NAME], cb)
-}

src/main/windows/about.js

@@ -26,7 +26,9 @@ function init () {
     useContentSize: true,
     webPreferences: {
       nodeIntegration: true,
-      enableBlinkFeatures: 'AudioVideoTracks'
+      enableBlinkFeatures: 'AudioVideoTracks',
+      enableRemoteModule: true,
+      backgroundThrottling: false
     },
     width: 300
   })

src/main/windows/main.js

@@ -42,7 +42,9 @@ function init (state, options) {
     width: initialBounds.width,
     webPreferences: {
       nodeIntegration: true,
-      enableBlinkFeatures: 'AudioVideoTracks'
+      enableBlinkFeatures: 'AudioVideoTracks',
+      enableRemoteModule: true,
+      backgroundThrottling: false
     },
     x: initialBounds.x,
     y: initialBounds.y

src/main/windows/webtorrent.js

@@ -26,7 +26,9 @@ function init () {
     useContentSize: true,
     webPreferences: {
       nodeIntegration: true,
-      enableBlinkFeatures: 'AudioVideoTracks'
+      enableBlinkFeatures: 'AudioVideoTracks',
+      enableRemoteModule: true,
+      backgroundThrottling: false
     },
     width: 150
   })

src/renderer/controllers/playback-controller.js

@@ -59,12 +59,12 @@ module.exports = class PlaybackController {
   }
 
   // Open a file in OS default app.
-  openItem (infoHash, index) {
+  openPath (infoHash, index) {
     const torrentSummary = TorrentSummary.getByKey(this.state, infoHash)
     const filePath = path.join(
       torrentSummary.path,
       torrentSummary.files[index].path)
-    ipcRenderer.send('openItem', filePath)
+    ipcRenderer.send('openPath', filePath)
   }
 
   // Toggle (play or pause) the currently playing media
@@ -156,6 +156,20 @@ module.exports = class PlaybackController {
     else this.state.playing.jumpToTime = time
   }
 
+  // Show video preview
+  preview (x) {
+    if (!Number.isFinite(x)) {
+      console.error('Tried to preview a non-finite position ' + x)
+      return console.trace()
+    }
+    this.state.playing.previewXCoord = x
+  }
+
+  // Hide video preview
+  clearPreview () {
+    this.state.playing.previewXCoord = null
+  }
+
   // Change playback speed. 1 = faster, -1 = slower
   // Playback speed ranges from 16 (fast forward) to 1 (normal playback)
   // to 0.25 (quarter-speed playback), then goes to -0.25, -0.5, -1, -2, etc
@@ -268,8 +282,10 @@ module.exports = class PlaybackController {
     state.playing.infoHash = infoHash
     state.playing.fileIndex = index
     state.playing.fileName = fileSummary.name
-    state.playing.type = TorrentPlayer.isVideo(fileSummary) ? 'video'
-      : TorrentPlayer.isAudio(fileSummary) ? 'audio'
+    state.playing.type = TorrentPlayer.isVideo(fileSummary)
+      ? 'video'
+      : TorrentPlayer.isAudio(fileSummary)
+        ? 'audio'
         : 'other'
 
     // pick up where we left off

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

@@ -158,7 +158,7 @@ module.exports = class TorrentListController {
       .filter((torrent) => { // We're interested in active torrents only.
         return (['downloading', 'seeding'].indexOf(torrent.status) !== -1)
       })
-      .map((torrent) => { // Pause all active torrents except the one that started playing.
+      .forEach((torrent) => { // Pause all active torrents except the one that started playing.
         if (infoHash === torrent.infoHash) return
 
         // Pause torrent without playing sounds.
@@ -173,7 +173,7 @@ module.exports = class TorrentListController {
   resumePausedTorrents () {
     console.log('Playback Priority: resuming paused torrents')
     if (!this.state.saved.torrentsToResume || !this.state.saved.torrentsToResume.length) return
-    this.state.saved.torrentsToResume.map((infoHash) => {
+    this.state.saved.torrentsToResume.forEach((infoHash) => {
       this.toggleTorrent(infoHash)
     })
 

src/renderer/lib/media-extensions.js

@@ -5,7 +5,7 @@ const mediaExtensions = {
     '.ogg', '.opus', '.spx', '.wma', '.wav', '.wv', '.wvp'],
   video: [
     '.avi', '.mp4', '.m4v', '.webm', '.mov', '.mkv', '.mpg', '.mpeg',
-    '.ogv', '.webm', '.wmv'],
+    '.ogv', '.webm', '.wmv', '.m2ts'],
   image: ['.gif', '.jpg', '.jpeg', '.png']
 }
 

src/renderer/lib/migrations.js

@@ -29,7 +29,7 @@ function run (state) {
   if (semver.lt(version, '0.17.0')) migrate_0_17_0(saved)
   if (semver.lt(version, '0.17.2')) migrate_0_17_2(saved)
   if (semver.lt(version, '0.21.0')) migrate_0_21_0(saved)
-  if (semver.lt(version, '0.21.1')) migrate_0_21_1(saved)
+  if (semver.lt(version, '0.22.0')) migrate_0_22_0(saved)
 
   // Config is now on the new version
   state.saved.version = config.APP_VERSION
@@ -216,7 +216,7 @@ function migrate_0_21_0 (saved) {
   }
 }
 
-function migrate_0_21_1 (saved) {
+function migrate_0_22_0 (saved) {
   if (saved.prefs.externalPlayerPath == null) {
     saved.prefs.externalPlayerPath = ''
   }

src/renderer/lib/torrent-poster.js

@@ -166,7 +166,8 @@ function torrentPosterFromVideo (torrent, cb) {
     function onSeeked () {
       video.removeEventListener('seeked', onSeeked)
 
-      const buf = captureFrame(video)
+      const frame = captureFrame(video)
+      const buf = frame && frame.image
 
       // unload video element
       video.pause()

src/renderer/main.js

@@ -14,9 +14,6 @@ Module.prototype.require = function (id) {
 
 console.time('init')
 
-const crashReporter = require('../crash-reporter')
-crashReporter.init()
-
 // Perf optimization: Start asynchronously read on config file before all the
 // blocking require() calls below.
 
@@ -133,7 +130,10 @@ function onState (err, _state) {
   resumeTorrents()
 
   // Initialize ReactDOM
-  app = ReactDOM.render(<App state={state} />, document.querySelector('#body'))
+  ReactDOM.render(
+    <App state={state} ref={elem => { app = elem }} />,
+    document.querySelector('#body')
+  )
 
   // Calling update() updates the UI given the current state
   // Do this at least once a second to give every file in every torrentSummary
@@ -277,10 +277,12 @@ const dispatchHandlers = {
   previousTrack: () => controllers.playback().previousTrack(),
   skip: (time) => controllers.playback().skip(time),
   skipTo: (time) => controllers.playback().skipTo(time),
+  preview: (x) => controllers.playback().preview(x),
+  clearPreview: () => controllers.playback().clearPreview(),
   changePlaybackRate: (dir) => controllers.playback().changePlaybackRate(dir),
   changeVolume: (delta) => controllers.playback().changeVolume(delta),
   setVolume: (vol) => controllers.playback().setVolume(vol),
-  openItem: (infoHash, index) => controllers.playback().openItem(infoHash, index),
+  openPath: (infoHash, index) => controllers.playback().openPath(infoHash, index),
 
   // Subtitles
   openSubtitles: () => controllers.subtitles().openSubtitles(),
@@ -524,6 +526,9 @@ function onPaste (e) {
 }
 
 function onKeydown (e) {
+  // prevent event fire on user input elements
+  if (editableHtmlTags.has(e.target.tagName.toLowerCase())) return
+
   const key = e.key
 
   if (key === 'ArrowLeft') {

src/renderer/pages/player-page.js

@@ -1,5 +1,5 @@
 const React = require('react')
-const Bitfield = require('bitfield')
+const BitField = require('bitfield').default
 const prettyBytes = require('prettier-bytes')
 
 const TorrentSummary = require('../lib/torrent-summary')
@@ -536,6 +536,8 @@ function renderPlayerControls (state) {
   const nextClass = Playlist.hasNext(state) ? '' : 'disabled'
 
   const elements = [
+    renderPreview(state),
+
     <div key='playback-bar' className='playback-bar'>
       {renderLoadingBar(state)}
       <div
@@ -547,6 +549,8 @@ function renderPlayerControls (state) {
         key='scrub-bar'
         className='scrub-bar'
         draggable
+        onMouseMove={handleScrubPreview}
+        onMouseOut={clearPreview}
         onDragStart={handleDragStart}
         onClick={handleScrub}
         onDrag={handleScrub}
@@ -655,10 +659,14 @@ function renderPlayerControls (state) {
   // Render volume slider
   const volume = state.playing.volume
   const volumeIcon = 'volume_' + (
-    volume === 0 ? 'off'
-      : volume < 0.3 ? 'mute'
-        : volume < 0.6 ? 'down'
-          : 'up')
+    volume === 0
+      ? 'off'
+      : volume < 0.3
+        ? 'mute'
+        : volume < 0.6
+          ? 'down'
+          : 'up'
+  )
   const volumeStyle = {
     background: '-webkit-gradient(linear, left top, right top, ' +
       'color-stop(' + (volume * 100) + '%, #eee), ' +
@@ -722,6 +730,19 @@ function renderPlayerControls (state) {
     }
   }
 
+  // Handles a scrub hover (preview another position in the video)
+  function handleScrubPreview (e) {
+    // Only show for videos
+    if (!e.clientX || state.playing.type !== 'video') return
+    dispatch('mediaMouseMoved')
+    dispatch('preview', e.clientX)
+  }
+
+  function clearPreview (e) {
+    if (state.playing.type !== 'video') return
+    dispatch('clearPreview')
+  }
+
   // Handles a click or drag to scrub (jump to another position in the video)
   function handleScrub (e) {
     if (!e.clientX) return
@@ -760,6 +781,56 @@ function renderPlayerControls (state) {
   }
 }
 
+function renderPreview (state) {
+  const { previewXCoord = null } = state.playing
+
+  // Calculate time from x-coord as fraction of track width
+  const windowWidth = document.querySelector('body').clientWidth
+  const fraction = previewXCoord / windowWidth
+  const time = fraction * state.playing.duration /* seconds */
+
+  const height = 70
+  let width = 0
+
+  const previewEl = document.querySelector('video#preview')
+  if (previewEl !== null && previewXCoord !== null) {
+    previewEl.currentTime = time
+
+    // Auto adjust width to maintain video aspect ratio
+    width = Math.floor((previewEl.videoWidth / previewEl.videoHeight) * height)
+  }
+
+  // Center preview window on mouse cursor,
+  // while avoiding falling off the left or right edges
+  const xPos = Math.min(Math.max(previewXCoord - (width / 2), 5), windowWidth - width - 5)
+
+  return (
+    <div
+      key='preview' style={{
+        position: 'absolute',
+        bottom: 50,
+        left: xPos,
+        display: previewXCoord == null && 'none' // Hide preview when XCoord unset
+      }}
+    >
+      <div style={{ width, height, backgroundColor: 'black' }}>
+        <video
+          src={Playlist.getCurrentLocalURL(state)}
+          id='preview'
+          style={{ border: '1px solid lightgrey', borderRadius: 2 }}
+        />
+      </div>
+      <p
+        style={{
+          textAlign: 'center', margin: 5, textShadow: '0 0 2px rgba(0,0,0,.5)', color: '#eee'
+        }}
+      >
+        {formatTime(time, state.playing.duration)}
+      </p>
+    </div>
+  )
+}
+
 // Renders the loading bar. Shows which parts of the torrent are loaded, which
 // can be 'spongey' / non-contiguous
 function renderLoadingBar (state) {
@@ -779,7 +850,7 @@ function renderLoadingBar (state) {
   const parts = []
   let lastPiecePresent = false
   for (let i = fileProg.startPiece; i <= fileProg.endPiece; i++) {
-    const partPresent = Bitfield.prototype.get.call(prog.bitfield, i)
+    const partPresent = BitField.prototype.get.call(prog.bitfield, i)
     if (partPresent && !lastPiecePresent) {
       parts.push({ start: i - fileProg.startPiece, count: 1 })
     } else if (partPresent) {

src/renderer/pages/torrent-list-page.js

@@ -346,7 +346,7 @@ module.exports = class TorrentList extends React.Component {
     } else {
       icon = 'description' /* file icon, opens in OS default app */
       handleClick = isDone
-        ? dispatcher('openItem', infoHash, index)
+        ? dispatcher('openPath', infoHash, index)
         : (e) => e.stopPropagation() // noop if file is not ready
     }
     // TODO: add a css 'disabled' class to indicate that a file cannot be opened/streamed

src/renderer/webtorrent.js

@@ -7,20 +7,15 @@ const util = require('util')
 const defaultAnnounceList = require('create-torrent').announceList
 const { ipcRenderer } = require('electron')
 const fs = require('fs')
-const mkdirp = require('mkdirp')
 const mm = require('music-metadata')
 const networkAddress = require('network-address')
 const path = require('path')
 const WebTorrent = require('webtorrent')
 
-const crashReporter = require('../crash-reporter')
 const config = require('../config')
 const { TorrentKeyNotFoundError } = require('./lib/errors')
 const torrentPoster = require('./lib/torrent-poster')
 
-// Report when the process crashes
-crashReporter.init()
-
 // Force use of webtorrent trackers on all torrents
 global.WEBTORRENT_ANNOUNCE = defaultAnnounceList
   .map((arr) => arr[0])
@@ -213,7 +208,7 @@ function saveTorrentFile (torrentKey) {
     }
 
     // Otherwise, save the .torrent file, under the app config folder
-    mkdirp(config.TORRENT_PATH, function (_) {
+    fs.mkdir(config.TORRENT_PATH, { recursive: true }, function (_) {
       fs.writeFile(torrentPath, torrent.torrentFile, function (err) {
         if (err) return console.log('error saving torrent file %s: %o', torrentPath, err)
         console.log('saved torrent file %s', torrentPath)
@@ -230,7 +225,7 @@ function generateTorrentPoster (torrentKey) {
   torrentPoster(torrent, function (err, buf, extension) {
     if (err) return console.log('error generating poster: %o', err)
     // save it for next time
-    mkdirp(config.POSTER_PATH, function (err) {
+    fs.mkdir(config.POSTER_PATH, { recursive: true }, function (err) {
       if (err) return console.log('error creating poster dir: %o', err)
       const posterFileName = torrent.infoHash + extension
       const posterFilePath = path.join(config.POSTER_PATH, posterFileName)
@@ -345,7 +340,10 @@ function getAudioMetadata (infoHash, index) {
     skipCovers: true,
     fileSize: file.length,
     observer: event => {
-      ipcRenderer.send('wt-audio-metadata', infoHash, index, event.metadata)
+      ipcRenderer.send('wt-audio-metadata', infoHash, index, {
+        common: metadata.common,
+        format: metadata.format
+      })
     }
   }
   const onMetadata = file.done