From c3b072eace1ce19a48e36c2ead5932ae2d2e06d9 Mon Sep 17 00:00:00 2001 From: Harish Narayanan Date: Thu, 14 Dec 2017 16:01:32 +0000 Subject: [PATCH] Replace spotify command in the osx plugin with a more recent copy of the upstream project (#6419) * Remove older shpotify code from the macOS plugin * Add Shpotify 2.0.1 from the upstream repository at https://github.com/hnarayanan/shpotify/releases/tag/2.0.1 * Wrap the Shpotify script in a function and import into the macOS plugin * Fix import path of the shpotify script * Add shpotify permission notice in the macos plugin rREADME * Merge with the upstream shpotify project - Fix playlist playback - Add a 'stop' command --- plugins/osx/README.md | 27 +++ plugins/osx/osx.plugin.zsh | 267 +--------------------- plugins/osx/spotify | 438 +++++++++++++++++++++++++++++++++++++ 3 files changed, 466 insertions(+), 266 deletions(-) create mode 100644 plugins/osx/spotify diff --git a/plugins/osx/README.md b/plugins/osx/README.md index b77daecc5..d3a8f94df 100644 --- a/plugins/osx/README.md +++ b/plugins/osx/README.md @@ -12,6 +12,33 @@ plugins=(... osx) Original author: [Sorin Ionescu](https://github.com/sorin-ionescu) +## Acknowledgements + +This application makes use of the following third party scripts: + +[shpotify](https://github.com/hnarayanan/shpotify) + +Copyright (c) 2012–2017 [Harish Narayanan](https://harishnarayanan.org/). + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + ## Commands diff --git a/plugins/osx/osx.plugin.zsh b/plugins/osx/osx.plugin.zsh index e8488ebc9..b7d6aca72 100644 --- a/plugins/osx/osx.plugin.zsh +++ b/plugins/osx/osx.plugin.zsh @@ -277,272 +277,7 @@ EOF } # Spotify control function -function spotify() { - - showHelp () { - echo "Usage:"; - echo; - echo " $(basename "$0") "; - echo; - echo "Commands:"; - echo; - echo " play # Resumes playback where Spotify last left off."; - echo " play [song name] # Finds a song by name and plays it."; - echo " play album [album name] # Finds an album by name and plays it."; - echo " play artist [artist name] # Finds an artist by name and plays it."; - echo " play list [playlist name] # Finds a playlist by name and plays it."; - echo " pause # Pauses Spotify playback."; - echo " next # Skips to the next song in a playlist."; - echo " prev # Returns to the previous song in a playlist."; - echo " pos [time] # Jumps to a time (in secs) in the current song."; - echo " quit # Stops playback and quits Spotify."; - echo; - echo " vol up # Increases the volume by 10%."; - echo " vol down # Decreases the volume by 10%."; - echo " vol [amount] # Sets the volume to an amount between 0 and 100."; - echo " vol show # Shows the current Spotify volume."; - echo; - echo " status # Shows the current player status."; - echo " share # Copies the current song URL to the clipboard." - echo " info # Shows Full Information about song that is playing."; - echo; - echo " toggle shuffle # Toggles shuffle playback mode."; - echo " toggle repeat # Toggles repeat playback mode."; - } - - cecho(){ - bold=$(tput bold); - green=$(tput setaf 2); - reset=$(tput sgr0); - echo "$bold$green$1$reset"; - } - - showStatus () { - state=$(osascript -e 'tell application "Spotify" to player state as string'); - cecho "Spotify is currently $state."; - if [ "$state" = "playing" ]; then - artist=$(osascript -e 'tell application "Spotify" to artist of current track as string'); - album=$(osascript -e 'tell application "Spotify" to album of current track as string'); - track=$(osascript -e 'tell application "Spotify" to name of current track as string'); - duration=$(osascript -e 'tell application "Spotify" to duration of current track as string'); - duration=$(echo "scale=2; $duration / 60 / 1000" | bc); - position=$(osascript -e 'tell application "Spotify" to player position as string' | tr ',' '.'); - position=$(echo "scale=2; $position / 60" | bc | awk '{printf "%0.2f", $0}'); - - printf "$reset""Artist: %s\nAlbum: %s\nTrack: %s \nPosition: %s / %s\n" "$artist" "$album" "$track" "$position" "$duration"; - fi - } - - - - if [ $# = 0 ]; then - showHelp; - else - if [ "$1" != "quit" ] && [ "$(osascript -e 'application "Spotify" is running')" = "false" ]; then - osascript -e 'tell application "Spotify" to activate' - sleep 2 - fi - fi - - while [ $# -gt 0 ]; do - arg=$1; - - case $arg in - "play" ) - if [ $# != 1 ]; then - # There are additional arguments, so find out how many - array=( $@ ); - len=${#array[@]}; - SPOTIFY_SEARCH_API="https://api.spotify.com/v1/search" - SPOTIFY_PLAY_URI=""; - - searchAndPlay() { - type="$1" - Q="$2" - - cecho "Searching ${type}s for: $Q"; - - SPOTIFY_PLAY_URI=$( \ - curl -s -G $SPOTIFY_SEARCH_API --data-urlencode "q=$Q" -d "type=$type&limit=1&offset=0" -H "Accept: application/json" \ - | grep -E -o "spotify:$type:[a-zA-Z0-9]+" -m 1 - ) - } - - case $2 in - "list" ) - _args=${array[*]:2:$len}; - Q=$_args; - - cecho "Searching playlists for: $Q"; - - results=$( \ - curl -s -G $SPOTIFY_SEARCH_API --data-urlencode "q=$Q" -d "type=playlist&limit=10&offset=0" -H "Accept: application/json" \ - | grep -E -o "spotify:user:[a-zA-Z0-9_]+:playlist:[a-zA-Z0-9]+" -m 10 \ - ) - - count=$( \ - echo "$results" | grep -c "spotify:user" \ - ) - - if [ "$count" -gt 0 ]; then - random=$(( RANDOM % count)); - - SPOTIFY_PLAY_URI=$( \ - echo "$results" | awk -v random="$random" '/spotify:user:[a-zA-Z0-9]+:playlist:[a-zA-Z0-9]+/{i++}i==random{print; exit}' \ - ) - fi;; - - "album" | "artist" | "track" ) - _args=${array[*]:2:$len}; - searchAndPlay "$2" "$_args";; - - * ) - _args=${array[*]:1:$len}; - searchAndPlay track "$_args";; - esac - - if [ "$SPOTIFY_PLAY_URI" != "" ]; then - cecho "Playing ($Q Search) -> Spotify URL: $SPOTIFY_PLAY_URI"; - - osascript -e "tell application \"Spotify\" to play track \"$SPOTIFY_PLAY_URI\""; - - else - cecho "No results when searching for $Q"; - fi - else - # play is the only param - cecho "Playing Spotify."; - osascript -e 'tell application "Spotify" to play'; - fi - break ;; - - "pause" ) - state=$(osascript -e 'tell application "Spotify" to player state as string'); - if [ "$state" = "playing" ]; then - cecho "Pausing Spotify."; - else - cecho "Playing Spotify."; - fi - - osascript -e 'tell application "Spotify" to playpause'; - break ;; - - "quit" ) - if [ "$(osascript -e 'application "Spotify" is running')" = "false" ]; then - cecho "Spotify was not running." - else - cecho "Closing Spotify."; - osascript -e 'tell application "Spotify" to quit'; - fi - break ;; - - "next" ) - cecho "Going to next track." ; - osascript -e 'tell application "Spotify" to next track'; - break ;; - - "prev" ) - cecho "Going to previous track."; - osascript -e 'tell application "Spotify" to previous track'; - break ;; - - "vol" ) - vol=$(osascript -e 'tell application "Spotify" to sound volume as integer'); - if [[ "$2" = "show" || "$2" = "" ]]; then - cecho "Current Spotify volume level is $vol."; - break ; - elif [ "$2" = "up" ]; then - if [ "$vol" -le 90 ]; then - newvol=$(( vol+10 )); - cecho "Increasing Spotify volume to $newvol."; - else - newvol=100; - cecho "Spotify volume level is at max."; - fi - elif [ "$2" = "down" ]; then - if [ "$vol" -ge 10 ]; then - newvol=$(( vol-10 )); - cecho "Reducing Spotify volume to $newvol."; - else - newvol=0; - cecho "Spotify volume level is at min."; - fi - elif [ "$2" -ge 0 ]; then - newvol=$2; - fi - - osascript -e "tell application \"Spotify\" to set sound volume to $newvol"; - break ;; - - "toggle" ) - if [ "$2" = "shuffle" ]; then - osascript -e 'tell application "Spotify" to set shuffling to not shuffling'; - curr=$(osascript -e 'tell application "Spotify" to shuffling'); - cecho "Spotify shuffling set to $curr"; - elif [ "$2" = "repeat" ]; then - osascript -e 'tell application "Spotify" to set repeating to not repeating'; - curr=$(osascript -e 'tell application "Spotify" to repeating'); - cecho "Spotify repeating set to $curr"; - fi - break ;; - - "pos" ) - cecho "Adjusting Spotify play position." - osascript -e "tell application \"Spotify\" to set player position to $2"; - break ;; - - "status" ) - showStatus; - break ;; - - "info" ) - info=$(osascript -e 'tell application "Spotify" - set tM to round (duration of current track / 60) rounding down - set tS to duration of current track mod 60 - set pos to player position as text - set myTime to tM as text & "min " & tS as text & "s" - set nM to round (player position / 60) rounding down - set nS to round (player position mod 60) rounding down - set nowAt to nM as text & "min " & nS as text & "s" - set info to "" & "\nArtist: " & artist of current track - set info to info & "\nTrack: " & name of current track - set info to info & "\nAlbum Artist: " & album artist of current track - set info to info & "\nAlbum: " & album of current track - set info to info & "\nSeconds: " & duration of current track - set info to info & "\nSeconds played: " & pos - set info to info & "\nDuration: " & mytime - set info to info & "\nNow at: " & nowAt - set info to info & "\nPlayed Count: " & played count of current track - set info to info & "\nTrack Number: " & track number of current track - set info to info & "\nPopularity: " & popularity of current track - set info to info & "\nId: " & id of current track - set info to info & "\nSpotify URL: " & spotify url of current track - set info to info & "\nArtwork: " & artwork of current track - set info to info & "\nPlayer: " & player state - set info to info & "\nVolume: " & sound volume - set info to info & "\nShuffle: " & shuffling - set info to info & "\nRepeating: " & repeating - end tell - return info') - echo "$info"; - break ;; - - "share" ) - url=$(osascript -e 'tell application "Spotify" to spotify url of current track'); - remove='spotify:track:' - url=${url#$remove} - url="http://open.spotify.com/track/$url" - cecho "Share URL: $url"; - cecho -n "$url" | pbcopy - break;; - - -h|--help| *) - showHelp; - break ;; - esac - done -} - +source ${ZSH}/plugins/osx/spotify # Show/hide hidden files in the Finder alias showfiles="defaults write com.apple.finder AppleShowAllFiles -bool true && killall Finder" diff --git a/plugins/osx/spotify b/plugins/osx/spotify new file mode 100644 index 000000000..69f6c5419 --- /dev/null +++ b/plugins/osx/spotify @@ -0,0 +1,438 @@ +#!/usr/bin/env bash + +function spotify() { +# Copyright (c) 2012--2017 Harish Narayanan +# +# Contains numerous helpful contributions from Jorge Colindres, Thomas +# Pritchard, iLan Epstein, Gabriele Bonetti, Sean Heller, Eric Martin +# and Peter Fonseca. + +# Permission is hereby granted, free of charge, to any person +# obtaining a copy of this software and associated documentation files +# (the "Software"), to deal in the Software without restriction, +# including without limitation the rights to use, copy, modify, merge, +# publish, distribute, sublicense, and/or sell copies of the Software, +# and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: + +# The above copyright notice and this permission notice shall be +# included in all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS +# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +USER_CONFIG_DEFAULTS="CLIENT_ID=\"\"\nCLIENT_SECRET=\"\""; +USER_CONFIG_FILE="${HOME}/.shpotify.cfg"; +if ! [[ -f "${USER_CONFIG_FILE}" ]]; then + touch "${USER_CONFIG_FILE}"; + echo -e "${USER_CONFIG_DEFAULTS}" > "${USER_CONFIG_FILE}"; +fi +source "${USER_CONFIG_FILE}"; + +showAPIHelp() { + echo; + echo "Connecting to Spotify's API:"; + echo; + echo " This command line application needs to connect to Spotify's API in order to"; + echo " find music by name. It is very likely you want this feature!"; + echo; + echo " To get this to work, you need to sign up (or in) and create an 'Application' at:"; + echo " https://developer.spotify.com/my-applications/#!/applications/create"; + echo; + echo " Once you've created an application, find the 'Client ID' and 'Client Secret'"; + echo " values, and enter them into your shpotify config file at '${USER_CONFIG_FILE}'"; + echo; + echo " Be sure to quote your values and don't add any extra spaces!"; + echo " When done, it should look like this (but with your own values):"; + echo ' CLIENT_ID="abc01de2fghijk345lmnop"'; + echo ' CLIENT_SECRET="qr6stu789vwxyz"'; +} + +showHelp () { + echo "Usage:"; + echo; + echo " `basename $0` "; + echo; + echo "Commands:"; + echo; + echo " play # Resumes playback where Spotify last left off."; + echo " play # Finds a song by name and plays it."; + echo " play album # Finds an album by name and plays it."; + echo " play artist # Finds an artist by name and plays it."; + echo " play list # Finds a playlist by name and plays it."; + echo " play uri # Play songs from specific uri."; + echo; + echo " next # Skips to the next song in a playlist."; + echo " prev # Returns to the previous song in a playlist."; + echo " replay # Replays the current track from the begining."; + echo " pos