lyrics-search 0.4.0

Lyrics search functionality for various platforms
Documentation
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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
use super::api_options::ApiOptions;
use super::response::{Track, TrackResponse};
use crate::error::SearchError;
use crate::providers::web::base_api;
use reqwest::Client;
use serde::Deserialize;
use serde_json::Value;
use std::sync::LazyLock;
use std::time::{Duration, Instant};
use tokio::sync::{Mutex, RwLock};

/// 请求重试次数(对应 C# `RequestRetryCount`)。
const REQUEST_RETRY_COUNT: usize = 5;

/// 结果重试次数(对应 C# `ResultRetryCount`)。
const RESULT_RETRY_COUNT: usize = 5;

/// 两次请求之间的最小间隔(对应 C# `GetResponseAsync` 中的 250ms)。
const MIN_REQUEST_INTERVAL: Duration = Duration::from_millis(250);

static OPTIONS: LazyLock<RwLock<ApiOptions>> = LazyLock::new(|| RwLock::new(ApiOptions::new()));
static CLIENT: LazyLock<RwLock<Client>> =
    LazyLock::new(|| RwLock::new(create_client(&ApiOptions::new())));
static USER_TOKEN: LazyLock<RwLock<Option<String>>> = LazyLock::new(|| RwLock::new(None));
static TOKEN_LOCK: LazyLock<Mutex<()>> = LazyLock::new(|| Mutex::new(()));
/// 串行化所有请求,并记录上一次请求的完成时间用于最小间隔控制。
static REQUEST_LOCK: LazyLock<Mutex<Option<Instant>>> = LazyLock::new(|| Mutex::new(None));

/// 返回当前配置的副本。
pub async fn options() -> ApiOptions {
    OPTIONS.read().await.clone()
}

/// 覆盖全局配置(对应 C# `new Api(options => ...)` 中的配置动作)。
///
/// 配置会先经过校验(对应 C# `ValidateOptions`),非法配置返回
/// [`SearchError::InvalidConfig`],此时不会改动已有的全局配置。
pub async fn set_options(mut options: ApiOptions) -> Result<(), SearchError> {
    validate_options(&mut options)?;
    let client = create_client(&options);
    *OPTIONS.write().await = options;
    *CLIENT.write().await = client;

    Ok(())
}

/// 设置 UserToken(例如之前缓存的 Token),不可用的 Token 会被忽略。
pub async fn set_user_token(token: &str) {
    *USER_TOKEN.write().await = if is_usable_token(token) {
        Some(token.to_string())
    } else {
        None
    };
}

/// 获取当前的 UserToken(例如用于缓存)。
pub async fn get_user_token() -> Option<String> {
    USER_TOKEN.read().await.clone()
}

/// 获取 Musixmatch 用户令牌(用于后续 API 调用)。
///
/// `Ok(None)` 表示服务端没有给出可用的 UserToken。
pub async fn get_token() -> Result<Option<String>, SearchError> {
    let response = request_token().await?;

    Ok(response
        .as_ref()
        .and_then(|json| json["message"]["body"]["user_token"].as_str())
        .map(str::to_string))
}

/// 搜索曲目列表(对应 C# `SearchTracksAsync`)。
///
/// 网络、HTTP 状态码或响应解析失败时返回 [`SearchError`];
/// 「请求成功但没有通过相关性校验的结果」由空 `Vec` 表示,不是错误。
pub async fn search_tracks(
    keyword: Option<&str>,
    track: Option<&str>,
    artist: Option<&str>,
    duration_secs: Option<i32>,
) -> Result<Vec<Track>, SearchError> {
    let mut parameters = vec![
        "page_size=10".to_string(),
        "page=1".to_string(),
        "s_track_rating=desc".to_string(),
    ];
    add_parameter(&mut parameters, "q", keyword);
    add_parameter(&mut parameters, "q_track", track);
    add_parameter(&mut parameters, "q_artist", artist);
    if let Some(duration) = duration_secs.filter(|duration| *duration > 0) {
        parameters.push(format!("q_duration={duration}"));
    }

    let request = format!("track.search?{}", parameters.join("&"));
    for attempt in 0..RESULT_RETRY_COUNT {
        let response = send_api_request(&request).await?;
        if let Some(list) = body_of(&response)["track_list"].as_array() {
            let results: Vec<Track> = list
                .iter()
                .filter_map(|item| Track::deserialize(&item["track"]).ok())
                .collect();
            if !results.is_empty() && has_related_result(&results, keyword, track, artist) {
                return Ok(results);
            }
        }

        if attempt + 1 < RESULT_RETRY_COUNT {
            delay_before_result_retry(attempt).await;
        }
    }

    Ok(Vec::new())
}

/// 获取曲目(对应 C# `GetTrack`),返回搜索结果的第一条。
///
/// `Ok(None)` 表示搜索成功但没有结果。
pub async fn search_track(
    q_track: &str,
    q_artist: &str,
    user_token: &str,
) -> Result<Option<TrackResponse>, SearchError> {
    set_user_token(user_token).await;
    let track = search_tracks(None, Some(q_track), Some(q_artist), None)
        .await?
        .into_iter()
        .next();

    Ok(track.map(TrackResponse::from_track))
}

/// 获取完整歌词的原始响应(对应 C# `GetFullLyricsRaw(string trackId)`)。
///
/// `expected_vanity_id` 非空时会额外校验曲目的 vanity ID。
/// `Ok(None)` 表示重试后仍未匹配到曲目;`track_id` 无法解析为整数时返回
/// [`SearchError::Payload`]。
pub async fn get_full_lyrics_raw(
    track_id: &str,
    expected_vanity_id: Option<&str>,
) -> Result<Option<String>, SearchError> {
    let Some(response) = get_full_lyrics_value(track_id, expected_vanity_id).await? else {
        return Ok(None);
    };

    let raw = serde_json::to_string(&response)
        .map_err(|error| SearchError::Payload(format!("Musixmatch 歌词响应序列化失败:{error}")))?;

    Ok(Some(raw))
}

/// 获取完整歌词的宏调用响应,供内部提取字段使用(避免序列化后再解析一次)。
///
/// `Ok(None)` 表示重试后仍未匹配到曲目;`track_id` 无法解析为整数时返回
/// [`SearchError::Payload`]。
async fn get_full_lyrics_value(
    track_id: &str,
    expected_vanity_id: Option<&str>,
) -> Result<Option<Value>, SearchError> {
    let id: i64 = track_id
        .parse()
        .map_err(|_| SearchError::Payload(format!("Musixmatch 曲目 ID 不是整数:{track_id}")))?;

    for attempt in 0..RESULT_RETRY_COUNT {
        let response = get_lyrics_response(id).await?;
        if let Some(track) = get_matched_track(&response)
            && track.track_id == id
            && vanity_matches(expected_vanity_id, track.commontrack_vanity_id.as_deref())
        {
            return Ok(Some(response));
        }

        if attempt + 1 < RESULT_RETRY_COUNT {
            delay_before_result_retry(attempt).await;
        }
    }

    Ok(None)
}

/// 获取 Musixmatch 非同步歌词文本。
///
/// `Ok(None)` 表示未匹配到曲目,或响应里没有 `lyrics_body` 字段。
pub async fn get_lyrics(track_id: i64, user_token: &str) -> Result<Option<String>, SearchError> {
    set_user_token(user_token).await;
    let response = get_full_lyrics_value(&track_id.to_string(), None).await?;

    Ok(response.as_ref().and_then(unsynced_lyrics_from))
}

/// 获取 Musixmatch 同步歌词(LRC 格式)。
///
/// `Ok(None)` 表示未匹配到曲目,或响应里没有字幕。
pub async fn get_synced_lyrics(
    track_id: i64,
    user_token: &str,
) -> Result<Option<String>, SearchError> {
    set_user_token(user_token).await;
    let response = get_full_lyrics_value(&track_id.to_string(), None).await?;

    Ok(response.as_ref().and_then(synced_lyrics_from))
}

/// 请求 UserToken(对应 C# `RequestTokenAsync`)。
///
/// `Ok(None)` 表示响应体为空;业务状态码非 200 时返回
/// [`SearchError::Api`],401 + captcha 时返回 [`SearchError::Captcha`]。
async fn request_token() -> Result<Option<Value>, SearchError> {
    let options = OPTIONS.read().await.clone();
    let url = format!(
        "{}token.get?user_language=en&app_id={}&t={}",
        options.api_base_url,
        urlencoding::encode(&options.app_id),
        urlencoding::encode(&options.request_id_factory.create()),
    );

    let response = get_response(&url).await?;
    if !response.is_success() {
        return Err(SearchError::Status(response.status));
    }
    if response.content.trim().is_empty() {
        return Ok(None);
    }

    let json = parse_json(&response.content)?;
    let header = &json["message"]["header"];
    let status_code = header["status_code"].as_i64();
    let hint = header["hint"].as_str();
    if status_code == Some(401) && is_hint(hint, "captcha") {
        return Err(SearchError::Captcha);
    }
    if status_code != Some(200) {
        return Err(SearchError::Api(api_status_message(status_code, hint)));
    }

    Ok(Some(json))
}

/// 发送 API 请求并解析 JSON(对应 C# `SendApiRequestAsync`)。
///
/// 命中 captcha 时立即返回,其余错误按 [`REQUEST_RETRY_COUNT`] 重试;
/// 重试耗尽后返回最后一次的错误本身,错误类型保持不变。
async fn send_api_request(request: &str) -> Result<Value, SearchError> {
    let mut last_error = None;

    for attempt in 0..REQUEST_RETRY_COUNT {
        match send_api_request_once(request).await {
            Ok(json) => return Ok(json),
            Err(error @ SearchError::Captcha) => return Err(error),
            Err(error) => last_error = Some(error),
        }

        if attempt + 1 < REQUEST_RETRY_COUNT {
            delay_before_request_retry(attempt).await;
        }
    }

    Err(last_error.unwrap_or_else(|| {
        SearchError::Api("Musixmatch request failed after all retries.".to_string())
    }))
}

/// 发送单次 API 请求(对应 C# `SendApiRequestAsync` 循环体)。
async fn send_api_request_once(request: &str) -> Result<Value, SearchError> {
    let token = ensure_user_token().await?;
    let options = OPTIONS.read().await.clone();
    let separator = if request.contains('?') { '&' } else { '?' };
    let url = format!(
        "{}{}{}usertoken={}&format=json&app_id={}&t={}",
        options.api_base_url,
        request,
        separator,
        urlencoding::encode(&token),
        urlencoding::encode(&options.app_id),
        urlencoding::encode(&options.request_id_factory.create()),
    );

    let response = get_response(&url).await?;
    if response.content.trim().is_empty() {
        return Err(SearchError::Status(response.status));
    }

    let json = parse_json(&response.content)?;
    let header = &json["message"]["header"];
    let status_code = header["status_code"].as_i64();
    let hint = header["hint"].as_str();

    if status_code == Some(404) {
        return Ok(json);
    }
    if !response.is_success() {
        return Err(SearchError::Status(response.status));
    }
    if status_code == Some(200) {
        return Ok(json);
    }

    if status_code == Some(401) && is_hint(hint, "renew") {
        invalidate_token().await;
    } else if status_code == Some(401) && is_hint(hint, "captcha") {
        return Err(SearchError::Captcha);
    }

    Err(SearchError::Api(api_status_message(status_code, hint)))
}

/// 确保存在可用的 UserToken(对应 C# `EnsureUserTokenAsync`)。
async fn ensure_user_token() -> Result<String, SearchError> {
    if let Some(token) = usable_token().await {
        return Ok(token);
    }

    let _guard = TOKEN_LOCK.lock().await;
    if let Some(token) = usable_token().await {
        return Ok(token);
    }

    let response = request_token().await?;
    let token = response
        .as_ref()
        .and_then(|json| json["message"]["body"]["user_token"].as_str())
        .map(str::to_string)
        .filter(|token| is_usable_token(token));

    match token {
        Some(token) => {
            *USER_TOKEN.write().await = Some(token.clone());
            Ok(token)
        }
        None => Err(SearchError::Api(
            "Musixmatch token request failed.".to_string(),
        )),
    }
}

/// 读取当前可用的 UserToken。
async fn usable_token() -> Option<String> {
    let token = USER_TOKEN.read().await.clone();
    token.filter(|token| is_usable_token(token))
}

/// 清除当前 UserToken(对应 C# `InvalidateToken`)。
async fn invalidate_token() {
    *USER_TOKEN.write().await = None;
}

/// 发送请求并读取响应内容(对应 C# `GetResponseAsync`),同一时刻只允许一个请求。
async fn get_response(url: &str) -> Result<RawResponse, SearchError> {
    let mut last_request = REQUEST_LOCK.lock().await;

    if let Some(previous) = *last_request {
        let elapsed = previous.elapsed();
        if elapsed < MIN_REQUEST_INTERVAL {
            tokio::time::sleep(MIN_REQUEST_INTERVAL - elapsed).await;
        }
    }

    let options = OPTIONS.read().await.clone();
    let client = CLIENT.read().await.clone();
    let mut request = client.get(url);
    if let Some(user_agent) = options
        .user_agent
        .as_deref()
        .filter(|value| !value.trim().is_empty())
    {
        request = request.header("User-Agent", user_agent);
    }
    if let Some(cookie) = options
        .cookie
        .as_deref()
        .filter(|value| !value.trim().is_empty())
    {
        request = request.header("Cookie", cookie);
    }

    let response = request.send().await?;
    let status = response.status();
    let content = response.text().await?;
    *last_request = Some(Instant::now());

    Ok(RawResponse {
        status: status.as_u16(),
        content,
    })
}

/// 请求歌词宏调用响应(对应 C# `GetLyricsResponseAsync`)。
async fn get_lyrics_response(track_id: i64) -> Result<Value, SearchError> {
    send_api_request(&format!(
        "macro.subtitles.get?namespace=lyrics_richsynched\
         &optional_calls=track.richsync\
         &subtitle_format=lrc\
         &track_id={track_id}\
         &f_subtitle_length_max_deviation=40"
    ))
    .await
}

/// 从宏调用响应中取出匹配到的曲目(对应 C# `GetMatchedTrack`)。
fn get_matched_track(response: &Value) -> Option<Track> {
    let track = &response["message"]["body"]["macro_calls"]["matcher.track.get"]["message"]["body"]
        ["track"];
    Track::deserialize(track).ok()
}

/// 从宏调用响应中提取非同步歌词文本(`track.lyrics.get`)。
fn unsynced_lyrics_from(response: &Value) -> Option<String> {
    response["message"]["body"]["macro_calls"]["track.lyrics.get"]["message"]["body"]["lyrics"]
        ["lyrics_body"]
        .as_str()
        .map(str::to_string)
}

/// 从宏调用响应中提取同步歌词文本(`track.subtitles.get`,LRC 格式)。
fn synced_lyrics_from(response: &Value) -> Option<String> {
    response["message"]["body"]["macro_calls"]["track.subtitles.get"]["message"]["body"]
        ["subtitle_list"][0]["subtitle"]["subtitle_body"]
        .as_str()
        .map(str::to_string)
}

/// 对应 C# `GetBody`:`response.message.body`。
fn body_of(response: &Value) -> &Value {
    &response["message"]["body"]
}

/// 响应文本不是合法 JSON 时返回 [`SearchError::Json`]。
fn parse_json(content: &str) -> Result<Value, SearchError> {
    serde_json::from_str(content).map_err(SearchError::Json)
}

/// 对应 C# `AddParameter`:非空白值才会加入查询参数。
fn add_parameter(parameters: &mut Vec<String>, name: &str, value: Option<&str>) {
    if let Some(value) = value.filter(|value| !value.trim().is_empty()) {
        parameters.push(format!("{name}={}", urlencoding::encode(value)));
    }
}

/// 对应 C# `HasRelatedResult`。
fn has_related_result(
    results: &[Track],
    keyword: Option<&str>,
    title: Option<&str>,
    artist: Option<&str>,
) -> bool {
    let keyword_tokens = tokenize(keyword);
    let title_tokens = tokenize(title);
    let artist_tokens = tokenize(artist);
    if keyword_tokens.is_empty() && title_tokens.is_empty() && artist_tokens.is_empty() {
        return true;
    }

    results.iter().any(|result| {
        let actual_title = result.track_name.to_lowercase();
        let actual_artists = result.artist_name.to_lowercase();
        if !title_tokens.is_empty()
            && !title_tokens
                .iter()
                .all(|token| actual_title.contains(token))
        {
            return false;
        }
        if !artist_tokens.is_empty()
            && !artist_tokens
                .iter()
                .any(|token| actual_artists.contains(token))
        {
            return false;
        }

        if keyword_tokens.is_empty() {
            return true;
        }

        let actual = format!("{actual_title} {actual_artists}");
        let required_matches =
            std::cmp::max(1, (keyword_tokens.len() as f64 * 0.6).ceil() as usize);
        keyword_tokens
            .iter()
            .filter(|token| actual.contains(*token))
            .count()
            >= required_matches
    })
}

/// 对应 C# `Tokenize`。
fn tokenize(value: Option<&str>) -> Vec<String> {
    value
        .unwrap_or_default()
        .to_lowercase()
        .split([' ', '-', '_', '/', ',', '.', '(', ')', '[', ']', '&'])
        .filter(|token| token.chars().count() > 1)
        .map(str::to_string)
        .collect()
}

/// 对应 C# `IsUsableToken`。
fn is_usable_token(token: &str) -> bool {
    !token.trim().is_empty() && token != "null" && token.chars().any(|c| c != '0')
}

/// 对应 C# `NormalizeVanity`。
fn normalize_vanity(value: &str) -> String {
    let decoded = urlencoding::decode(value)
        .map(|decoded| decoded.into_owned())
        .unwrap_or_else(|_| value.to_string());
    decoded.trim().trim_matches('/').to_string()
}

/// 校验曲目 vanity ID 是否与预期一致,预期为空时视为匹配。
fn vanity_matches(expected: Option<&str>, actual: Option<&str>) -> bool {
    match expected.filter(|expected| !expected.trim().is_empty()) {
        Some(expected) => normalize_vanity(expected)
            .eq_ignore_ascii_case(&normalize_vanity(actual.unwrap_or_default())),
        None => true,
    }
}

fn is_hint(hint: Option<&str>, expected: &str) -> bool {
    hint.is_some_and(|hint| hint.eq_ignore_ascii_case(expected))
}

/// 拼装业务状态码错误的消息(保留原始 `status_code` 与 `hint`)。
fn api_status_message(status_code: Option<i64>, hint: Option<&str>) -> String {
    let status = status_code
        .map(|status| status.to_string())
        .unwrap_or_else(|| "未知".to_string());
    match hint.filter(|hint| !hint.trim().is_empty()) {
        Some(hint) => format!("Musixmatch 返回业务状态码 {status}(hint: {hint})"),
        None => format!("Musixmatch 返回业务状态码 {status}"),
    }
}

/// 请求重试前的等待(对应 C# `DelayBeforeRequestRetryAsync`)。
async fn delay_before_request_retry(attempt: usize) {
    let delay = std::cmp::min(500 * (1 << attempt), 2000);
    tokio::time::sleep(Duration::from_millis(delay)).await;
}

/// 结果重试前的等待(对应 C# `DelayBeforeResultRetryAsync`)。
async fn delay_before_result_retry(attempt: usize) {
    let delay = std::cmp::min(200 * (attempt as u64 + 1), 800);
    tokio::time::sleep(Duration::from_millis(delay)).await;
}

/// 对应 C# `CreateClient`。
fn create_client(options: &ApiOptions) -> Client {
    Client::builder()
        .timeout(options.timeout)
        .build()
        .expect("Failed to create HTTP client")
}

/// 对应 C# `ValidateOptions`。
///
/// 非法配置返回 [`SearchError::InvalidConfig`](原先是 panic);
/// base URL 结尾补 `/` 仍就地进行(与 C# 一样是副作用)。
fn validate_options(options: &mut ApiOptions) -> Result<(), SearchError> {
    if options.api_base_url.trim().is_empty() {
        return Err(SearchError::InvalidConfig(
            "Musixmatch API base URL is required.".to_string(),
        ));
    }
    if !options.api_base_url.ends_with('/') {
        options.api_base_url.push('/');
    }
    if options.app_id.trim().is_empty() {
        return Err(SearchError::InvalidConfig(
            "Musixmatch app ID is required.".to_string(),
        ));
    }
    if options.timeout.is_zero() {
        return Err(SearchError::InvalidConfig(
            "Musixmatch request timeout must be greater than zero.".to_string(),
        ));
    }

    Ok(())
}

/// 请求结果(对应 C# `GetResponseAsync` 返回的元组)。
struct RawResponse {
    status: u16,
    content: String,
}

impl RawResponse {
    /// HTTP 状态码是否为 2xx。
    fn is_success(&self) -> bool {
        base_api::StatusCode::from_u16(self.status).is_ok_and(|status| status.is_success())
    }
}