feat: initial support for GetUserRating

Cargo.lock

@@ -1478,6 +1478,7 @@ dependencies = [
  "palc",
  "redb",
  "sdgb-api",
+ "serde",
  "serde_json",
  "snafu",
  "spdlog-rs",

Cargo.toml

@@ -12,6 +12,7 @@ spdlog-rs = { version = "0.4.3", default-features = false, features = [
 ] }
 
 snafu = { version = "0.8.6", features = ["backtrace", "rust_1_81"] }
+serde = { version = "1.0.219", features = ["derive"] }
 serde_json = "1.0.141"
 strum = { version = "0.27.2", features = ["derive"] }
 tokio = { version = "1", features = ["rt-multi-thread"] }

README.md

@@ -0,0 +1,5 @@
+# sdgb-utils-rs
+
+- SBGA 舞萌DX API 文档参考
+- “裸” cli 工具，没多少人性化功能
+- 暂时不完整开放，留在私仓

sdgb-api/Cargo.toml

@@ -19,6 +19,9 @@ tokio = { workspace = true, optional = true }
 compio = { workspace = true, optional = true }
 spdlog-rs = { workspace = true }
 
+# (de)serialization
+serde = { workspace = true }
+
 # hashing
 digest = "0.10.7"
 hmac-sha256 = { version = "1.1.12", features = ["digest010", "traits010"] }
@@ -30,8 +33,6 @@ chrono = "0.4.41"
 # network request
 nyquest = { version = "0.2.0", features = ["async", "json"] }
 
-# (de)serialization
-serde = { version = "1.0.219", features = ["derive"] }
 
 # compression / encryption
 flate2 = "1.1.2"

sdgb-api/src/helper/mod.rs

@@ -0,0 +1,15 @@
+pub fn level_name(level: u32) -> &'static str {
+    match level {
+        0 => "BASIC",
+        1 => "ADVANCED",
+        2 => "EXPERT",
+        3 => "MASTER",
+        4 => "RE: MASTER",
+        5 => "UTAGE",
+        _ => "Unknown",
+    }
+}
+
+// TODO: MusicDB lazy load
+// struct MusicDB;
+// static MUSIC_DB: LazyLock<MusicDB> = LazyLock::new(|| unimplemented!());

sdgb-api/src/lib.rs

@@ -2,6 +2,8 @@ pub mod all_net;
 pub mod auth_lite;
 pub mod title;
 
+pub mod helper;
+
 mod error;
 pub use error::ApiError;
 

sdgb-api/src/title/model/get_user_rating_api/mod.rs

@@ -1,6 +1,10 @@
+use std::fmt::Display;
+
 use serde::Deserialize;
 use serde::Serialize;
 
+use crate::helper::level_name;
+
 #[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct GetUserRatingApi {
@@ -17,21 +21,22 @@ pub struct GetUserRatingApiResp {
 #[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct UserRating {
+    /// total rating, now it's 0
     pub rating: i64,
     /// b35
-    pub rating_list: Vec<RatingList>,
+    pub rating_list: Vec<MusicRating>,
     /// b15
-    pub new_rating_list: Vec<RatingList>,
+    pub new_rating_list: Vec<MusicRating>,
     /// 候补 b35
-    pub next_rating_list: Vec<RatingList>,
+    pub next_rating_list: Vec<MusicRating>,
     /// 候补 b15
-    pub next_new_rating_list: Vec<RatingList>,
+    pub next_new_rating_list: Vec<MusicRating>,
     pub udemae: Udemae,
 }
 
 #[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
-pub struct RatingList {
+pub struct MusicRating {
     /// Maimai music id
     pub music_id: u32,
     /// difficulty
@@ -83,3 +88,43 @@ pub struct Udemae {
     #[serde(rename = "NpcLoseNum")]
     pub npc_lose_num2: i64,
 }
+
+impl Display for GetUserRatingApiResp {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.write_fmt(format_args!("用户ID: {}\n", self.user_id))?;
+
+        f.write_str("\n---------- B35 ----------\n")?;
+        for b35 in &self.user_rating.rating_list {
+            f.write_fmt(format_args!("{b35}\n---\n"))?;
+        }
+
+        f.write_str("\n---------- B15 ----------\n")?;
+        for b15 in &self.user_rating.new_rating_list {
+            f.write_fmt(format_args!("{b15}\n---\n"))?;
+        }
+        Ok(())
+    }
+}
+
+impl Display for MusicRating {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.write_fmt(format_args!("歌曲ID: \t{}\n", self.music_id))?;
+        f.write_fmt(format_args!(
+            "谱面版本: \t{}\n",
+            match (self.music_id / 10000) % 10 {
+                0 => "SD",
+                1 => "DX",
+                _ => "宴",
+            }
+        ))?;
+
+        f.write_fmt(format_args!("游玩难度: \t{}\n", level_name(self.level)))?;
+        f.write_fmt(format_args!(
+            "达成率: \t{}.{}%",
+            self.achievement / 10000,
+            self.achievement % 10000
+        ))?;
+
+        Ok(())
+    }
+}

sdgb-api/src/title/model/user_login_api/mod.rs

@@ -11,7 +11,9 @@ pub struct UserLoginApi {
     pub acsess_code: String,
     pub place_id: String,
     pub client_id: String,
-    /// set to `false` is fine
+    /// false 的情况，二维码扫描后半小时可登录。
+    ///
+    /// true  的情况，可延长至二维码扫描后的两小时可登录。
     pub is_continue: bool,
     /// fixed to 0
     pub generic_flag: u8,

sdgb-cli/Cargo.toml

@@ -16,11 +16,20 @@ fetchall = ["dep:redb", "dep:futures-util"]
 [dependencies]
 sdgb-api = { workspace = true, features = ["bincode"] }
 
-spdlog-rs = { workspace = true }
-snafu = { workspace = true }
+# (de)serialization
+serde = { workspace = true }
 serde_json = { workspace = true }
 strum = { workspace = true }
+
+# logging / errors
+spdlog-rs = { workspace = true }
+snafu = { workspace = true }
+
+
+# kv database
 redb = { workspace = true, optional = true }
+
+# async runtime
 tokio = { workspace = true, features = ["macros"], optional = true }
 compio = { workspace = true, features = ["macros"], optional = true }
 

sdgb-cli/src/commands.rs

@@ -5,6 +5,9 @@ use strum::EnumString;
 #[derive(Parser)]
 #[command(about = "SDGB api tool", long_about = env!("CARGO_PKG_DESCRIPTION"))]
 pub struct Cli {
+    /// try to generate human readable output.
+    #[arg(short = 'M', long)]
+    pub machine_readable: bool,
     #[command(subcommand)]
     pub command: Commands,
 }
@@ -37,6 +40,10 @@ pub enum Commands {
         #[arg(short, long)]
         user_id: u32,
     },
+    Rating {
+        #[arg(short, long)]
+        user_id: u32,
+    },
 
     // below requires login
     Userdata {

sdgb-cli/src/main.rs

@@ -11,14 +11,18 @@ use sdgb_api::{
         MaiVersionExt, Sdgb1_40, Sdgb1_50,
         methods::APIMethod,
         model::{
-            GetUserDataApi, GetUserDataApiResp, GetUserPreviewApi, GetUserPreviewApiResp, Ping,
-            PingResp, UserLogoutApi, UserLogoutApiResp,
+            GetUserDataApi, GetUserDataApiResp, GetUserPreviewApi, GetUserPreviewApiResp,
+            GetUserRatingApi, GetUserRatingApiResp, Ping, PingResp, UserLogoutApi,
+            UserLogoutApiResp,
         },
     },
 };
 use spdlog::{error, info, warn};
 
-use crate::{commands::Cli, utils::login_action};
+use crate::{
+    commands::Cli,
+    utils::{human_readable_display, login_action},
+};
 
 #[cfg(feature = "fetchall")]
 mod cache;
@@ -48,12 +52,27 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
         }
     })?;
 
-    let Cli { command } = <Cli as Parser>::parse();
+    let Cli {
+        command,
+        machine_readable,
+    } = <Cli as Parser>::parse();
+    let human_readable = !machine_readable;
 
     let client = ClientBuilder::default().build_async().await?;
 
     // TODO: refactor via enum_dispatch
     match command {
+        commands::Commands::Rating { user_id } => {
+            let rating: GetUserRatingApiResp = Sdgb1_50::request(
+                &client,
+                APIMethod::GetUserRatingApi,
+                user_id,
+                GetUserRatingApi { user_id },
+            )
+            .await?;
+
+            human_readable_display(rating, human_readable)?;
+        }
         commands::Commands::Logout { user_id, timestamp } => {
             let logout: UserLogoutApiResp = Sdgb1_50::request(
                 &client,
@@ -77,7 +96,7 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
             )
             .await?;
 
-            println!("{preview}");
+            human_readable_display(preview, human_readable)?;
         }
         commands::Commands::Ping => {
             let decoded: PingResp = Sdgb1_40::request(

sdgb-cli/src/utils/mod.rs

@@ -1,3 +1,5 @@
+use std::{fmt::Display, io::stdout};
+
 use nyquest_preset::nyquest::AsyncClient;
 use sdgb_api::{
     ApiError,
@@ -7,6 +9,7 @@ use sdgb_api::{
         model::{UserLoginApi, UserLoginApiResp, UserLogoutApi, UserLogoutApiResp},
     },
 };
+use serde::Serialize;
 use spdlog::info;
 
 pub async fn login_action<R>(
@@ -44,3 +47,17 @@ pub async fn login_action<R>(
     info!("logout: {logout_resp:?}");
     Ok(return_data)
 }
+
+pub fn human_readable_display(
+    value: impl Display + Serialize,
+    human_readable: bool,
+) -> Result<(), Box<dyn snafu::Error>> {
+    if human_readable {
+        println!("{value}");
+    } else {
+        let lock = stdout().lock();
+        serde_json::to_writer_pretty(lock, &value)?;
+    }
+
+    Ok(())
+}