ferrosonic 0.8.2

A terminal-based Subsonic music client with bit-perfect audio playback
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
//! Subsonic API client

use reqwest::Client;
use tracing::{debug, info};
use url::Url;

use super::auth::generate_auth_params;
use super::models::*;
use crate::error::SubsonicError;

/// Client name sent to Subsonic server
const CLIENT_NAME: &str = "ferrosonic-rs";
/// API version we support
const API_VERSION: &str = "1.16.1";

/// Subsonic API client
#[derive(Clone)]
pub struct SubsonicClient {
    /// Base URL of the Subsonic server
    base_url: Url,
    /// Username for authentication
    username: String,
    /// Password for authentication (stored for stream URLs)
    password: String,
    /// HTTP client
    http: Client,
}

impl SubsonicClient {
    /// Create a new Subsonic client
    pub fn new(base_url: &str, username: &str, password: &str) -> Result<Self, SubsonicError> {
        let base_url = Url::parse(base_url)?;

        let http = Client::builder()
            .user_agent(CLIENT_NAME)
            .build()
            .map_err(SubsonicError::Http)?;

        Ok(Self {
            base_url,
            username: username.to_string(),
            password: password.to_string(),
            http,
        })
    }

    /// Build URL with authentication parameters
    fn build_url(&self, endpoint: &str) -> Result<Url, SubsonicError> {
        let mut url = self.base_url.join(&format!("rest/{}", endpoint))?;

        let (salt, token) = generate_auth_params(&self.password);

        url.query_pairs_mut()
            .append_pair("u", &self.username)
            .append_pair("t", &token)
            .append_pair("s", &salt)
            .append_pair("v", API_VERSION)
            .append_pair("c", CLIENT_NAME)
            .append_pair("f", "json");

        Ok(url)
    }

    /// Make an API request and parse the response
    async fn request<T>(&self, endpoint: &str) -> Result<T, SubsonicError>
    where
        T: serde::de::DeserializeOwned,
    {
        let url = self.build_url(endpoint)?;
        self.request_url(url).await
    }

    /// Execute a request against a pre-built URL and parse the response.
    async fn request_url<T>(&self, url: Url) -> Result<T, SubsonicError>
    where
        T: serde::de::DeserializeOwned,
    {
        debug!(
            "Requesting: {}",
            url.as_str().split('?').next().unwrap_or("")
        );

        let response = self.http.get(url).send().await?;
        let text = response.text().await?;

        let parsed: SubsonicResponse<T> = serde_json::from_str(&text)
            .map_err(|e| SubsonicError::Parse(format!("Failed to parse response: {}", e)))?;

        let inner = parsed.subsonic_response;

        if inner.status != "ok" {
            if let Some(error) = inner.error {
                return Err(SubsonicError::Api {
                    code: error.code,
                    message: error.message,
                });
            }
            return Err(SubsonicError::Api {
                code: 0,
                message: "Unknown error".to_string(),
            });
        }

        inner
            .data
            .ok_or_else(|| SubsonicError::Parse("Empty response data".to_string()))
    }

    /// Test connection to the server
    pub async fn ping(&self) -> Result<(), SubsonicError> {
        let url = self.build_url("ping")?;
        debug!("Pinging server");

        let response = self.http.get(url).send().await?;
        let text = response.text().await?;

        let parsed: SubsonicResponse<PingData> = serde_json::from_str(&text)
            .map_err(|e| SubsonicError::Parse(format!("Failed to parse ping response: {}", e)))?;

        if parsed.subsonic_response.status != "ok" {
            if let Some(error) = parsed.subsonic_response.error {
                return Err(SubsonicError::Api {
                    code: error.code,
                    message: error.message,
                });
            }
        }

        info!("Server ping successful");
        Ok(())
    }

    pub async fn get_starred_songs(&self) -> Result<Vec<Child>, SubsonicError> {
        let data: StarredSongsData = self.request("getStarred2").await?;
        let songs = data.starred_songs.song;
        debug!("Fetched {} starred songs", songs.len());
        Ok(songs)
    }

    pub async fn get_starred_albums(&self) -> Result<Vec<Album>, SubsonicError> {
        let data: StarredSongsData = self.request("getStarred2").await?;
        let albums = data.starred_songs.album;
        debug!("Fetched {} starred albums", albums.len());
        Ok(albums)
    }

    pub async fn get_random_albums(&self, count: usize) -> Result<Vec<Album>, SubsonicError> {
        self.get_album_list("random", count, 0).await
    }

    /// Search for songs via `search3`.
    ///
    /// Pass an empty string for `query` to retrieve all songs (ordered by the
    /// server's default sort).  `offset` and `count` control pagination.
    pub async fn search_songs(
        &self,
        query: &str,
        offset: usize,
        count: usize,
    ) -> Result<Vec<Child>, SubsonicError> {
        let mut url = self.build_url("search3")?;
        url.query_pairs_mut()
            .append_pair("query", query)
            .append_pair("songCount", &count.to_string())
            .append_pair("songOffset", &offset.to_string())
            .append_pair("artistCount", "0")
            .append_pair("albumCount", "0");

        debug!(
            "Searching songs: query={:?}, offset={}, count={}",
            query, offset, count
        );

        let data: Search3Data = self.request_url(url).await?;
        let songs = data.search_result.song;

        debug!("Fetched {} songs (offset={})", songs.len(), offset);
        Ok(songs)
    }

    pub async fn get_random_songs(
        &self,
        random_songs_count: usize,
    ) -> Result<Vec<Child>, SubsonicError> {
        let mut url = self.build_url("getRandomSongs")?;
        url.query_pairs_mut().append_pair("size", &random_songs_count.to_string());
        let data: RandomSongsData = self.request_url(url).await?;

        let songs = data.random_songs.song;

        debug!("Fetched {} songs", songs.len());
        Ok(songs)
    }

    /// Get all artists
    pub async fn get_artists(&self) -> Result<Vec<Artist>, SubsonicError> {
        let data: ArtistsData = self.request("getArtists").await?;

        let artists: Vec<Artist> = data
            .artists
            .index
            .into_iter()
            .flat_map(|idx| idx.artist)
            .collect();

        debug!("Fetched {} artists", artists.len());
        Ok(artists)
    }

    /// Get artist details with albums
    pub async fn get_artist(&self, id: &str) -> Result<(Artist, Vec<Album>), SubsonicError> {
        let mut url = self.build_url("getArtist")?;
        url.query_pairs_mut().append_pair("id", id);
        debug!("Fetching artist: {}", id);

        let response = self.http.get(url).send().await?;
        let text = response.text().await?;

        let parsed: SubsonicResponse<ArtistData> = serde_json::from_str(&text)
            .map_err(|e| SubsonicError::Parse(format!("Failed to parse artist response: {}", e)))?;

        if parsed.subsonic_response.status != "ok" {
            if let Some(error) = parsed.subsonic_response.error {
                return Err(SubsonicError::Api {
                    code: error.code,
                    message: error.message,
                });
            }
        }

        let detail = parsed
            .subsonic_response
            .data
            .ok_or_else(|| SubsonicError::Parse("Empty artist data".to_string()))?
            .artist;

        let artist = Artist {
            id: detail.id,
            name: detail.name.clone(),
            album_count: Some(detail.album.len() as i32),
            cover_art: None,
            starred: None,
        };

        debug!(
            "Fetched artist {} with {} albums",
            detail.name,
            detail.album.len()
        );
        Ok((artist, detail.album))
    }

    /// Get album details with songs
    pub async fn get_album(&self, id: &str) -> Result<(Album, Vec<Child>), SubsonicError> {
        let mut url = self.build_url("getAlbum")?;
        url.query_pairs_mut().append_pair("id", id);
        debug!("Fetching album: {}", id);

        let response = self.http.get(url).send().await?;
        let text = response.text().await?;

        let parsed: SubsonicResponse<AlbumData> = serde_json::from_str(&text)
            .map_err(|e| SubsonicError::Parse(format!("Failed to parse album response: {}", e)))?;

        if parsed.subsonic_response.status != "ok" {
            if let Some(error) = parsed.subsonic_response.error {
                return Err(SubsonicError::Api {
                    code: error.code,
                    message: error.message,
                });
            }
        }

        let detail = parsed
            .subsonic_response
            .data
            .ok_or_else(|| SubsonicError::Parse("Empty album data".to_string()))?
            .album;

        let album = Album {
            id: detail.id,
            name: detail.name.clone(),
            artist: detail.artist,
            artist_id: detail.artist_id,
            cover_art: None,
            song_count: Some(detail.song.len() as i32),
            duration: None,
            year: detail.year,
            genre: None,
            starred: None,
        };

        debug!(
            "Fetched album {} with {} songs",
            detail.name,
            detail.song.len()
        );
        Ok((album, detail.song))
    }

    /// Fetch albums via getAlbumList2.
    ///
    /// `list_type` is one of: `alphabeticalByName`, `alphabeticalByArtist`, `newest`,
    /// `random`, `starred`, `frequent`, `recent`, `byYear`, `byGenre`.
    pub async fn get_album_list(
        &self,
        list_type: &str,
        size: usize,
        offset: usize,
    ) -> Result<Vec<Album>, SubsonicError> {
        let mut url = self.build_url("getAlbumList2")?;
        url.query_pairs_mut()
            .append_pair("type", list_type)
            .append_pair("size", &size.to_string())
            .append_pair("offset", &offset.to_string());
        debug!(
            "Fetching album list: type={}, size={}, offset={}",
            list_type, size, offset
        );
        let data: AlbumListData = self.request_url(url).await?;
        debug!(
            "Fetched {} albums (offset={})",
            data.album_list.album.len(),
            offset
        );
        Ok(data.album_list.album)
    }

    /// Get all playlists
    pub async fn get_playlists(&self) -> Result<Vec<Playlist>, SubsonicError> {
        let data: PlaylistsData = self.request("getPlaylists").await?;
        let playlists = data.playlists.playlist;
        debug!("Fetched {} playlists", playlists.len());
        Ok(playlists)
    }

    /// Get internet radio stations
    pub async fn get_internet_radio_stations(
        &self,
    ) -> Result<Vec<InternetRadioStation>, SubsonicError> {
        let data: InternetRadioStationsData = self.request("getInternetRadioStations").await?;
        let stations = data.internet_radio_stations.internet_radio_station;
        debug!("Fetched {} internet radio stations", stations.len());
        Ok(stations)
    }

    /// Get playlist details with songs
    pub async fn get_playlist(&self, id: &str) -> Result<(Playlist, Vec<Child>), SubsonicError> {
        let mut url = self.build_url("getPlaylist")?;
        url.query_pairs_mut().append_pair("id", id);
        debug!("Fetching playlist: {}", id);

        let response = self.http.get(url).send().await?;
        let text = response.text().await?;

        let parsed: SubsonicResponse<PlaylistData> = serde_json::from_str(&text).map_err(|e| {
            SubsonicError::Parse(format!("Failed to parse playlist response: {}", e))
        })?;

        if parsed.subsonic_response.status != "ok" {
            if let Some(error) = parsed.subsonic_response.error {
                return Err(SubsonicError::Api {
                    code: error.code,
                    message: error.message,
                });
            }
        }

        let detail = parsed
            .subsonic_response
            .data
            .ok_or_else(|| SubsonicError::Parse("Empty playlist data".to_string()))?
            .playlist;

        let playlist = Playlist {
            id: detail.id,
            name: detail.name.clone(),
            owner: detail.owner,
            song_count: detail.song_count,
            duration: detail.duration,
            cover_art: None,
            public: None,
            comment: None,
        };

        debug!(
            "Fetched playlist {} with {} songs",
            detail.name,
            detail.entry.len()
        );
        Ok((playlist, detail.entry))
    }

    /// Get stream URL for a song
    ///
    /// Returns the full URL with authentication that can be passed to MPV
    pub fn get_stream_url(&self, song_id: &str) -> Result<String, SubsonicError> {
        let mut url = self.base_url.join("rest/stream")?;

        let (salt, token) = generate_auth_params(&self.password);

        url.query_pairs_mut()
            .append_pair("id", song_id)
            .append_pair("u", &self.username)
            .append_pair("t", &token)
            .append_pair("s", &salt)
            .append_pair("v", API_VERSION)
            .append_pair("c", CLIENT_NAME);

        Ok(url.to_string())
    }

    pub async fn unstar_song(&self, song_id: &str) -> Result<(), SubsonicError> {
        let mut url = self.build_url("unstar")?;
        url.query_pairs_mut().append_pair("id", song_id);
        self.request_url::<()>(url).await
    }

    pub async fn star_song(&self, song_id: &str) -> Result<(), SubsonicError> {
        let mut url = self.build_url("star")?;
        url.query_pairs_mut().append_pair("id", song_id);
        self.request_url::<()>(url).await
    }

    pub async fn unstar_artist(&self, artist_id: &str) -> Result<(), SubsonicError> {
        let mut url = self.build_url("unstar")?;
        url.query_pairs_mut().append_pair("artistId", artist_id);
        self.request_url::<()>(url).await
    }

    pub async fn star_artist(&self, artist_id: &str) -> Result<(), SubsonicError> {
        let mut url = self.build_url("star")?;
        url.query_pairs_mut().append_pair("artistId", artist_id);
        self.request_url::<()>(url).await
    }

    pub async fn unstar_album(&self, album_id: &str) -> Result<(), SubsonicError> {
        let mut url = self.build_url("unstar")?;
        url.query_pairs_mut().append_pair("albumId", album_id);
        self.request_url::<()>(url).await
    }

    pub async fn star_album(&self, album_id: &str) -> Result<(), SubsonicError> {
        let mut url = self.build_url("star")?;
        url.query_pairs_mut().append_pair("albumId", album_id);
        self.request_url::<()>(url).await
    }

    /// Scrobble a track to the server.
    ///
    /// Set `submission` to `true` when the track has been sufficiently played
    /// (the standard Last.fm/Subsonic convention), or `false` to signal that
    /// the track is now playing (a "now-playing" notification).
    pub async fn scrobble(&self, song_id: &str, submission: bool) -> Result<(), SubsonicError> {
        let mut url = self.build_url("scrobble")?;
        url.query_pairs_mut()
            .append_pair("id", song_id)
            .append_pair("submission", &submission.to_string());
        self.request_url::<()>(url).await
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    impl SubsonicClient {
        /// Parse song ID from a stream URL
        fn parse_song_id_from_url(url: &str) -> Option<String> {
            let parsed = Url::parse(url).ok()?;
            parsed
                .query_pairs()
                .find(|(k, _)| k == "id")
                .map(|(_, v)| v.to_string())
        }
    }

    #[test]
    fn test_parse_song_id() {
        let url = "https://example.com/rest/stream?id=12345&u=user&t=token&s=salt&v=1.16.1&c=test";
        let id = SubsonicClient::parse_song_id_from_url(url);
        assert_eq!(id, Some("12345".to_string()));
    }

    #[test]
    fn test_parse_song_id_missing() {
        let url = "https://example.com/rest/stream?u=user";
        let id = SubsonicClient::parse_song_id_from_url(url);
        assert_eq!(id, None);
    }

    fn parse_search3_response(json: &str) -> Result<Vec<Child>, SubsonicError> {
        let parsed: SubsonicResponse<Search3Data> = serde_json::from_str(json)
            .map_err(|e| SubsonicError::Parse(format!("Failed to parse response: {}", e)))?;
        let inner = parsed.subsonic_response;
        if inner.status != "ok" {
            if let Some(error) = inner.error {
                return Err(SubsonicError::Api {
                    code: error.code,
                    message: error.message,
                });
            }
            return Err(SubsonicError::Api {
                code: 0,
                message: "Unknown error".to_string(),
            });
        }
        Ok(inner
            .data
            .ok_or_else(|| SubsonicError::Parse("Empty response data".to_string()))?
            .search_result
            .song)
    }

    #[test]
    fn test_search3_parses_songs() {
        let json = r#"{
            "subsonic-response": {
                "status": "ok",
                "version": "1.16.1",
                "searchResult3": {
                    "song": [
                        {"id": "1", "title": "Song One", "isDir": false},
                        {"id": "2", "title": "Song Two", "isDir": false}
                    ]
                }
            }
        }"#;
        let songs = parse_search3_response(json).unwrap();
        assert_eq!(songs.len(), 2);
        assert_eq!(songs[0].id, "1");
        assert_eq!(songs[1].title, "Song Two");
    }

    #[test]
    fn test_search3_empty_results() {
        let json = r#"{
            "subsonic-response": {
                "status": "ok",
                "version": "1.16.1",
                "searchResult3": { "song": [] }
            }
        }"#;
        let songs = parse_search3_response(json).unwrap();
        assert!(songs.is_empty());
    }

    #[test]
    fn test_search3_api_error_propagates() {
        let json = r#"{
            "subsonic-response": {
                "status": "failed",
                "version": "1.16.1",
                "error": { "code": 70, "message": "Search not supported" }
            }
        }"#;
        let err = parse_search3_response(json).unwrap_err();
        match err {
            SubsonicError::Api { code, message } => {
                assert_eq!(code, 70);
                assert_eq!(message, "Search not supported");
            }
            other => panic!("Expected Api error, got {:?}", other),
        }
    }
}