Support open spotify link (#307)

Resolves #218 

This PR adds support for opening track/playlist/album/artist Spotify link from `spotify_player` by calling `OpenSpotifyLinkFromClipboard` command. The application will
- open a corresponding context page for playlist/album/artist link
- play the song for track link

## Changes
- add `clipboard` crate as a dependency
- add `OpenSpotifyLinkFromClipboard` command (default keymap: `O`)

Author: aome510

.github/workflows/cd.yml

@@ -22,19 +22,19 @@ jobs:
           - os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
             container: rust
-            dependencies: "libssl-dev libasound2-dev libdbus-1-dev"
+            dependencies: "libssl-dev libasound2-dev libdbus-1-dev libxcb-shape0-dev libxcb-xfixes0-dev"
           - os: ubuntu-latest
             target: aarch64-unknown-linux-gnu
             container: rustembedded/cross:aarch64-unknown-linux-gnu
             cross_arch: "arm64"
             pkg_config_path: "/usr/lib/aarch64-linux-gnu/pkgconfig/"
-            dependencies: "libssl-dev:arm64 libasound2-dev:arm64 libdbus-1-dev:arm64"
+            dependencies: "libssl-dev:arm64 libasound2-dev:arm64 libdbus-1-dev:arm64 libxcb-shape0-dev:arm64 libxcb-xfixes0-dev:arm64"
           - os: ubuntu-latest
             target: armv7-unknown-linux-gnueabihf
             cross_arch: "armhf"
             pkg_config_path: "/usr/lib/arm-linux-gnueabihf/pkgconfig/"
             container: rustembedded/cross:armv7-unknown-linux-gnueabihf
-            dependencies: "libssl-dev:armhf libasound2-dev:armhf libdbus-1-dev:armhf"
+            dependencies: "libssl-dev:armhf libasound2-dev:armhf libdbus-1-dev:armhf libxcb-shape0-dev:armhf libxcb-xfixes0-dev:armhf"
           - os: windows-latest
             target: x86_64-pc-windows-msvc
 

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
 
     steps:
       - name: Install dependencies
-        run: sudo apt-get update && sudo apt-get install libssl-dev libasound2-dev libdbus-1-dev
+        run: sudo apt-get update && sudo apt-get install libssl-dev libasound2-dev libdbus-1-dev libxcb-shape0-dev libxcb-xfixes0-dev
         if: ${{ runner.os == 'Linux' }}
 
       - name: Checkout source

Cargo.lock

@@ -93,14 +93,10 @@ A Spotify Premium account is **required**.
 ##### Linux
 
 - [Rust and cargo](https://www.rust-lang.org/tools/install) as the build dependencies
-- `openssl`, `alsa-lib` (`streaming` feature), `libdbus` (`media-control` feature) system libraries.
-  - On Debian based systems, run the below command to install application's dependencies:
+- install `openssl`, `alsa-lib` (`streaming` feature), `libdbus` (`media-control` feature), `libxcb` system libraries.
+  - For example, on Debian based systems, run the below command to install application's dependencies:
     ```shell
-    sudo apt install libssl-dev libasound2-dev libdbus-1-dev
-    ```
-  - On Fedora based systems, run the below command to install application's dependencies:
-    ```shell
-    sudo yum install openssl-devel alsa-lib-devel dbus-devel
+    sudo apt install libssl-dev libasound2-dev libdbus-1-dev libxcb-shape0-dev libxcb-xfixes0-dev
     ```
 
 ### Binaries
@@ -382,11 +378,12 @@ List of supported commands:
 | `SearchPage`                   | go to the search page                                                   | `g s`              |
 | `BrowsePage`                   | go to the browse page                                                   | `g b`              |
 | `PreviousPage`                 | go to the previous page                                                 | `backspace`, `C-q` |
+| `OpenSpotifyLinkFromClipboard` | open a Spotify link from clipboard                                      | `O`                |
 | `SortTrackByTitle`             | sort the track table (if any) by track's title                          | `s t`              |
 | `SortTrackByArtists`           | sort the track table (if any) by track's artists                        | `s a`              |
 | `SortTrackByAlbum`             | sort the track table (if any) by track's album                          | `s A`              |
-| `SortTrackByDuration`          | sort the track table (if any) by track's duration                       | `s d`              |
 | `SortTrackByAddedDate`         | sort the track table (if any) by track's added date                     | `s D`              |
+| `SortTrackByDuration`          | sort the track table (if any) by track's duration                       | `s d`              |
 | `ReverseOrder`                 | reverse the order of the track table (if any)                           | `s r`              |
 | `MovePlaylistItemUp`           | move playlist item up one position                                      | `C-k`              |
 | `MovePlaylistItemDown`         | move playlist item down one position                                    | `C-j`              |

README.md

@@ -46,6 +46,7 @@ once_cell = "1.18.0"
 regex = "1.9.6"
 daemonize = { version = "0.5.0", optional = true }
 ttl_cache = "0.5.1"
+clipboard = "0.5.0"
 
 [target.'cfg(target_os = "windows")'.dependencies.windows]
 version = "0.44"

spotify_player/Cargo.toml

@@ -62,6 +62,7 @@ pub enum Command {
     SearchPage,
     BrowsePage,
     PreviousPage,
+    OpenSpotifyLinkFromClipboard,
 
     SortTrackByTitle,
     SortTrackByArtists,
@@ -198,6 +199,7 @@ impl Command {
             Self::SearchPage => "go to the search page",
             Self::BrowsePage => "go to the browse page",
             Self::PreviousPage => "go to the previous page",
+            Self::OpenSpotifyLinkFromClipboard => "open a Spotify link from clipboard",
             Self::SortTrackByTitle => "sort the track table (if any) by track's title",
             Self::SortTrackByArtists => "sort the track table (if any) by track's artists",
             Self::SortTrackByAlbum => "sort the track table (if any) by track's album",

spotify_player/src/command.rs

@@ -182,6 +182,10 @@ impl Default for KeymapConfig {
                     key_sequence: "C-q".into(),
                     command: Command::PreviousPage,
                 },
+                Keymap {
+                    key_sequence: "O".into(),
+                    command: Command::OpenSpotifyLinkFromClipboard,
+                },
                 Keymap {
                     key_sequence: "?".into(),
                     command: Command::OpenCommandHelp,

spotify_player/src/config/keymap.rs

@@ -7,7 +7,8 @@ use crate::{
 
 #[cfg(feature = "lyric-finder")]
 use crate::utils::map_join;
-use anyhow::Result;
+use anyhow::{Context as _, Result};
+use clipboard::{ClipboardContext, ClipboardProvider};
 
 mod page;
 mod popup;
@@ -359,6 +360,54 @@ fn handle_global_command(
                 ui.popup = None;
             }
         }
+        Command::OpenSpotifyLinkFromClipboard => {
+            let content = get_clipboard_content().context("get clipboard's content")?;
+            let re = regex::Regex::new(
+                r"https://open.spotify.com/(?P<type>.*?)/(?P<id>[[:alnum:]]*).*",
+            )?;
+            if let Some(cap) = re.captures(&content) {
+                let typ = cap.name("type").expect("valid capture").as_str();
+                let id = cap.name("id").expect("valid capture").as_str();
+                match typ {
+                    // for track link, play the song
+                    "track" => {
+                        let id = TrackId::from_id(id)?.into_static();
+                        client_pub.send(ClientRequest::Player(PlayerRequest::StartPlayback(
+                            Playback::URIs(vec![id], None),
+                            None,
+                        )))?;
+                    }
+                    // for playlist/artist/album link, go to the corresponding context page
+                    "playlist" => {
+                        let id = PlaylistId::from_id(id)?.into_static();
+                        ui.create_new_page(PageState::Context {
+                            id: None,
+                            context_page_type: ContextPageType::Browsing(ContextId::Playlist(id)),
+                            state: None,
+                        });
+                    }
+                    "artist" => {
+                        let id = ArtistId::from_id(id)?.into_static();
+                        ui.create_new_page(PageState::Context {
+                            id: None,
+                            context_page_type: ContextPageType::Browsing(ContextId::Artist(id)),
+                            state: None,
+                        });
+                    }
+                    "album" => {
+                        let id = AlbumId::from_id(id)?.into_static();
+                        ui.create_new_page(PageState::Context {
+                            id: None,
+                            context_page_type: ContextPageType::Browsing(ContextId::Album(id)),
+                            state: None,
+                        });
+                    }
+                    e => anyhow::bail!("unsupported Spotify type {e}!"),
+                }
+            } else {
+                tracing::warn!("clipboard's content ({content}) is not a valid Spotify link!");
+            }
+        }
         #[cfg(feature = "lyric-finder")]
         Command::LyricPage => {
             if let Some(track) = state.player.read().current_playing_track() {
@@ -412,3 +461,15 @@ fn handle_global_command(
     }
     Ok(true)
 }
+
+fn get_clipboard_content() -> Result<String> {
+    let mut clipboard_ctx: ClipboardContext = match ClipboardProvider::new() {
+        Ok(ctx) => ctx,
+        Err(err) => anyhow::bail!("{err:#}"),
+    };
+    let content = match clipboard_ctx.get_contents() {
+        Ok(content) => content,
+        Err(err) => anyhow::bail!("{err:#}"),
+    };
+    Ok(content)
+}