integrate.js

/*
 * Copyright 2011-2018 Jiří Janoušek <janousek.jiri@gmail.com>
 * Copyright 2014 Martin Pöhlmann <martin.deimos@gmx.de>
 * Copyright 2016 Brian Finley <brian@thefinleys.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

(function (Nuvola) {
  const _ = Nuvola.Translate.gettext
  const C_ = Nuvola.Translate.pgettext

  const State = Nuvola.PlaybackState
  const PlayerAction = Nuvola.PlayerAction
  const player = Nuvola.$object(Nuvola.MediaPlayer)

  const THUMB_NEVER_TOGGLES = 'app.thumb_never_toggles'
  const ACTION_THUMBS_UP = 'thumbs-up'
  const ACTION_THUMBS_DOWN = 'thumbs-down'
  const THUMBS_ACTIONS = [ACTION_THUMBS_UP, ACTION_THUMBS_DOWN]

  const WebApp = Nuvola.$WebApp()

  WebApp._onInitAppRunner = function (emitter) {
    Nuvola.WebApp._onInitAppRunner.call(this, emitter)
    Nuvola.config.setDefaultAsync(THUMB_NEVER_TOGGLES, false).catch(Nuvola.logException)
    Nuvola.core.connect('PreferencesForm', this)
    Nuvola.actions.addAction('playback', 'win', ACTION_THUMBS_UP, C_('Action', 'Thumbs up'), null, null, null, true)
    Nuvola.actions.addAction('playback', 'win', ACTION_THUMBS_DOWN, C_('Action', 'Thumbs down'), null, null, null, true)
  }

  WebApp._onInitWebWorker = function (emitter) {
    Nuvola.WebApp._onInitWebWorker.call(this, emitter)

    Nuvola.actions.connect('ActionActivated', this)
    this.thumbsUp = undefined
    this.thumbsDown = undefined
    this.state = State.UNKNOWN
    player.addExtraActions(THUMBS_ACTIONS)
    const state = document.readyState
    if (state === 'interactive' || state === 'complete') {
      this._onPageReady()
    } else {
      document.addEventListener('DOMContentLoaded', this._onPageReady.bind(this))
    }
  }

  WebApp._onPreferencesForm = function (emitter, values, entries) {
    this.appendPreferences(values, entries)
  }

  WebApp.appendPreferences = function (values, entries) {
    values[THUMB_NEVER_TOGGLES] = Nuvola.config.get(THUMB_NEVER_TOGGLES)
    entries.push(['header', '\nGoogle Play Music'])
    entries.push(['bool', THUMB_NEVER_TOGGLES, _('Treat thumbs up or down selection as a one-way switch,\nnot a toggle.')])
  }

  /**
 * Signal handler for @link{Core::UriChanged}
 */
  WebApp._onUriChanged = function (emitter, uri) {
    /*
     * Users that use the queue page a lot might end up with it as a start-up page. However, this page is always empty
     * and not useful at all, so load Listen now page instead. https://bugs.launchpad.net/nuvola-player/+bug/1306678
     */
    if (uri === 'https://play.google.com/music/listen#/ap/queue') {
      uri = this.meta.home_url
    }

    Nuvola.WebApp._onUriChanged.call(this, emitter, uri)
  }

  WebApp._onLastPageRequest = function (emitter, result) {
    Nuvola.WebApp._onLastPageRequest.call(this, emitter, result)
    if (result.url && result.url.indexOf('file://') === 0) {
      result.url = null
    }
  }

  WebApp._onPageReady = function () {
    if (window.location.protocol === 'file:') {
      return
    }
    player.connect('RatingSet', this)
    Nuvola.config.connect('ConfigChanged', this)
    Nuvola.config.getAsync(THUMB_NEVER_TOGGLES).then((thumbNeverToggles) => {
      this.thumbNeverToggles = thumbNeverToggles
      this.update()
    }).catch(Nuvola.logException)
  }

  WebApp.update = function () {
    let elm
    /* Fix for Google Play Music shows an incomplete queue. https://github.com/tiliado/nuvolaplayer/issues/106 */
    if (!this._queueOverlayFixed && (elm = document.getElementById('queue-overlay')) && elm.hasAttribute('layout')) {
      elm.removeAttribute('layout')
      this._queueOverlayFixed = true
    }

    this.state = State.UNKNOWN
    let prevSong, nextSong
    try {
      const pp = this._getPlayPauseButton()
      if (pp.disabled === true) { this.state = State.UNKNOWN } else if (pp.className.indexOf('playing') !== -1) {
        this.state = State.PLAYING
      } else {
        this.state = State.PAUSED
      }

      if (this.state !== State.UNKNOWN) {
        prevSong = this._getGoPrevButton().disabled === false
        nextSong = this._getGoNextButton().disabled === false
      } else {
        prevSong = nextSong = false
      }
    } catch (e) {
      this.state = State.UNKNOWN
      this.scheduleUpdate()
      return
    }

    player.setPlaybackState(this.state)
    player.setCanPause(this.state === State.PLAYING)
    player.setCanPlay(this.state === State.PAUSED || (this.state === State.UNKNOWN && this._luckyMix()))
    player.setCanGoPrev(prevSong)
    player.setCanGoNext(nextSong)
    player.setCanRate(this.state !== State.UNKNOWN)

    const track = {}
    try {
      track.artLocation = document.querySelector('#playerSongInfo #playerBarArt').src.replace('=s90-', '=s500-')
    } catch (e) {
      track.artLocation = null
    }

    try {
      elm = document.querySelector('#playerSongInfo #currently-playing-title')
      track.title = elm.innerText || elm.textContent
    } catch (e) {
      track.title = null
    }

    try {
      elm = document.getElementById('player-artist').firstChild
      track.artist = elm.innerText || elm.textContent
    } catch (e) {
      track.artist = null
    }

    try {
      elm = document.querySelector('#playerSongInfo .player-album')
      track.album = elm.innerText || elm.textContent
    } catch (e) {
      track.album = null
    }

    elm = document.getElementById('time_container_duration')
    track.length = elm ? elm.innerText || null : null

    const thumbsUp = this._getThumbsUpButton()
    const thumbsDown = this._getThumbsDownButton()
    if (this._isThumbSelected(thumbsUp)) { track.rating = 1.0 } else if (this._isThumbSelected(thumbsDown)) {
      track.rating = 0.20
    } else {
      track.rating = 0.0
    }
    player.setTrack(track)

    const shuffle = this._getShuffleButton()
    const repeat = this._getRepeatStatus(this._getRepeatButton())

    // Extract enabled flag and state from a web page
    const actionsEnabled = {}
    const actionsStates = {}
    actionsStates[ACTION_THUMBS_UP] = this._isThumbSelected(thumbsUp)
    actionsStates[ACTION_THUMBS_DOWN] = this._isThumbSelected(thumbsDown)
    actionsStates[PlayerAction.SHUFFLE] = shuffle && shuffle.classList.contains('active')
    actionsStates[PlayerAction.REPEAT] = repeat || 0
    actionsEnabled[PlayerAction.SHUFFLE] = !!shuffle
    actionsEnabled[PlayerAction.REPEAT] = repeat !== null
    actionsEnabled[ACTION_THUMBS_UP] = !!thumbsUp && !(this.thumbNeverToggles && this._isThumbSelected(thumbsUp))
    actionsEnabled[ACTION_THUMBS_DOWN] = !!thumbsDown && !(this.thumbNeverToggles && this._isThumbSelected(thumbsDown))

    // Compare with previous values and update if necessary
    Nuvola.actions.updateEnabledFlags(actionsEnabled)
    Nuvola.actions.updateStates(actionsStates)

    elm = document.getElementById('time_container_current')
    player.setTrackPosition(elm ? elm.innerText || null : null)
    player.setCanSeek(this.state !== State.UNKNOWN)
    elm = document.querySelector('#volume #sliderBar')
    player.updateVolume(elm ? elm.getAttribute('value') / 100 : null)
    player.setCanChangeVolume(!!elm)
    this.scheduleUpdate()
  }

  WebApp.scheduleUpdate = function () {
    setTimeout(this.update.bind(this), 500)
  }

  WebApp._getButton = function (id) {
    return document.querySelector('[data-id=' + id + ']')
  }

  WebApp._getPlayPauseButton = function () {
    return this._getButton('play-pause')
  }

  WebApp._getGoPrevButton = function () {
    return this._getButton('rewind')
  }

  WebApp._getGoNextButton = function () {
    return this._getButton('forward')
  }

  WebApp._getShuffleButton = function () {
    return this._getButton('shuffle')
  }

  WebApp._getRepeatButton = function () {
    return this._getButton('repeat')
  }

  WebApp._getThumbsUpButton = function () {
    return document.querySelector(".player-rating-container [data-rating='5']")
  }

  WebApp._getThumbsDownButton = function () {
    return document.querySelector(".player-rating-container [data-rating='1']")
  }

  WebApp._isThumbSelected = function (elm) {
    return (elm && elm.icon) ? elm.icon.indexOf('-outline') === -1 : false
  }

  WebApp._getRepeatStatus = function (button) {
    if (!button) {
      return null
    }
    const classes = button.classList
    if (!classes.contains('active')) {
      return Nuvola.PlayerRepeat.NONE
    }
    const icon = button.firstElementChild.firstElementChild.firstElementChild.firstElementChild.getAttribute('d')
    return (icon === 'M7 7h10v3l4-4-4-4v3H5v6h2V7zm10 10H7v-3l-4 4 4 4v-3h12v-6h-2v4zm-4-2V9h-1l-2 1v1h1.5v4H13z'
      ? Nuvola.PlayerRepeat.TRACK
      : Nuvola.PlayerRepeat.PLAYLIST)
  }

  WebApp._setRepeatStatus = function (button, repeat) {
    if (!button) {
      console.log('Do not have repeat button!')
      return
    }
    while (this._getRepeatStatus(button) !== repeat) {
      Nuvola.clickOnElement(button)
    }
  }

  WebApp._onActionActivated = function (emitter, name, param) {
    const prevSong = this._getGoPrevButton()
    const nextSong = this._getGoNextButton()
    const playPause = this._getPlayPauseButton()
    const luckyMix = this._luckyMix()

    switch (name) {
    /* Base media player actions */
      case PlayerAction.TOGGLE_PLAY:
        if (this.state === State.UNKNOWN && luckyMix) {
          luckyMix.click()
        } else {
          playPause.click()
        }
        break
      case PlayerAction.PLAY:
        if (this.state === State.UNKNOWN && luckyMix) {
          luckyMix.click()
        } else if (this.state !== State.PLAYING) {
          playPause.click()
        }
        break
      case PlayerAction.PAUSE:
      case PlayerAction.STOP:
        if (this.state === State.PLAYING) {
          playPause.click()
        }
        break
      case PlayerAction.PREV_SONG:
        if (prevSong) {
          prevSong.click()
        }
        break
      case PlayerAction.NEXT_SONG:
        if (nextSong) {
          nextSong.click()
        }
        break
      case PlayerAction.SEEK: {
        const elm = document.getElementById('time_container_duration')
        const total = Nuvola.parseTimeUsec(elm ? elm.innerText : null)
        if (param > 0 && param <= total) {
          Nuvola.clickOnElement(document.getElementById('progressContainer'), param / total, 0.5)
        }
        break
      }
      case PlayerAction.CHANGE_VOLUME: {
        const elm = document.querySelector('#volume #sliderBar')
        if (elm) {
          Nuvola.clickOnElement(elm, param)
        }
        break
      }
      case PlayerAction.SHUFFLE:
        Nuvola.clickOnElement(this._getShuffleButton())
        break
      case PlayerAction.REPEAT:
        this._setRepeatStatus(this._getRepeatButton(), param)
        break
      /* Custom actions */
      case ACTION_THUMBS_UP:
        this._getThumbsUpButton().click()
        break
      case ACTION_THUMBS_DOWN:
        this._getThumbsDownButton().click()
        break
    }
  }

  // Handler for rating
  WebApp._onRatingSet = function (emitter, rating) {
    Nuvola.log('Rating set: {1}', rating)
    const thumbsUp = this._getThumbsUpButton()
    const thumbsDown = this._getThumbsDownButton()
    if (rating < 0.01) { // Unset rating
      if (this._isThumbSelected(thumbsUp)) {
        thumbsUp.click()
      } else if (this._isThumbSelected(thumbsDown)) {
        thumbsDown.click()
      }
    } else if (rating <= 0.41) { // 0-2 stars
      if (!this._isThumbSelected(thumbsDown)) {
        thumbsDown.click()
      }
    } else if (rating >= 0.79) { // 4-5 stars
      if (!this._isThumbSelected(thumbsUp)) {
        thumbsUp.click()
      }
    } else { // three stars
      window.alert('Invalid rating: ' + rating + '.' +
        "Have you clicked the three-star button? It isn't supported.")
    }
  }

  WebApp._onConfigChanged = function (emitter, key) {
    if (key === THUMB_NEVER_TOGGLES) {
      Nuvola.config.getAsync(THUMB_NEVER_TOGGLES).then((thumbNeverToggles) => {
        this.thumbNeverToggles = thumbNeverToggles
      }).catch(Nuvola.logException)
    }
  }

  WebApp._luckyMix = function () {
    return window.location.hash === '#/now' ? document.querySelector('div[data-type=imfl]') || false : false
  }

  WebApp.start()
})(this) // function(Nuvola)