1
0
mirror of https://git.ngram.ca/OpenJam/rc-servers synced 2026-08-23 23:08:52 +00:00
Files
ojrc/rc_core/src/persist/user/traits.rs

543 lines
19 KiB
Rust
Raw Normal View History

2025-03-15 11:03:35 -04:00
#[allow(dead_code)]
#[derive(Debug)]
pub struct UserToken {
pub uuid: String,
pub token: String,
pub refresh_token: String,
}
/*pub struct UserInfo {
//pub payload: libfj::robocraft::TokenPayload,
2025-04-01 19:38:03 -04:00
pub extra: ExtraUserInfo,
}*/
2025-04-01 19:38:03 -04:00
pub enum UserAuthInfo {
2025-04-01 19:38:03 -04:00
Steam {
id: u64,
},
Username {
username: String,
password: String,
},
Email {
email: String,
2025-04-01 19:38:03 -04:00
password: String,
}
}
impl UserAuthInfo {
pub(super) fn display_id(&self) -> String {
match self {
Self::Steam { id } => format!("steamID:{}", id),
Self::Username { username, .. } => format!("username:{}", username),
Self::Email { email, .. } => format!("email:{}", email),
}
}
}
2025-05-12 20:56:24 -04:00
pub enum UserId {
SteamId(u64),
Email(String),
Username(String),
}
2025-04-01 19:38:03 -04:00
pub struct UserLoginInfo {
pub response: libfj::robocraft::AuthenticationResponseInfo,
pub is_new: bool,
}
2025-05-12 20:56:24 -04:00
pub struct RegistrationInfo {
pub display_name: String,
pub password: String,
pub email: Option<String>,
pub steam_id: Option<u64>,
}
pub struct AuthError {
pub message: String,
pub code: crate::data::error_codes::AuthErrorCode,
}
2025-05-07 20:23:22 -04:00
#[async_trait::async_trait]
2025-03-15 11:03:35 -04:00
pub trait UserProvider<C> {
async fn authenticate(&self, user: UserToken) -> Result<Box<dyn User<C> + Send + Sync>, AuthError>;
async fn multiplayer_authenticate(&self, user: String) -> Result<Box<dyn User<C> + Send + Sync>, AuthError>;
2025-03-15 11:03:35 -04:00
}
2025-05-07 20:23:22 -04:00
#[async_trait::async_trait]
2025-04-01 19:38:03 -04:00
pub trait UserAuthenticator {
async fn login(&self, info: UserAuthInfo) -> Result<UserLoginInfo, AuthError>;
2025-05-12 20:56:24 -04:00
async fn user_exists(&self, user: UserId) -> Result<bool, String>;
async fn register(&self, info: RegistrationInfo) -> Result<i32, String>;
2025-04-01 19:38:03 -04:00
}
2025-05-07 20:23:22 -04:00
#[async_trait::async_trait]
pub trait User<C>: ChatUser + SocialUser + SocialUserC<C> + LobbyUser + MultiplayerUser + SingleplayerUser + IntercomUser + CommonUser + FactoryUser {
2025-05-07 20:23:22 -04:00
async fn unlocked_parts(&self) -> Vec<u32>;
2026-01-01 20:34:12 -05:00
async fn unlock_parts(&self, parts: &[u32]) -> Result<(), polariton_server::operations::SimpleOpError>;
2025-05-07 20:23:22 -04:00
async fn selected_garage(&self) -> (String, u32);
async fn select_garage(&self, slot: i32) -> Result<(), i16>;
async fn all_slots(&self) -> UserSlots<C>;
2025-05-07 20:23:22 -04:00
async fn slot_by_id(&self, id: i32) -> Result<UserSlotData<C>, i16>;
async fn save_slot(&self, vehicle: VehicleData, cpu_counter: &crate::cubes::CpuListParser) -> Result<(), i16>;
async fn save_slot_order(&self, slots: Vec<i32>) -> Result<(), i16>;
async fn new_slot(&self, reset_slot: Option<i32>) -> Result<NewSlotData<C>, i16>;
async fn copy_slot(&self, slot: i32, into_slot: Option<i32>, append: &str) -> Result<(), i16>;
async fn upgrade_slot(&self, increments: i32) -> Result<polariton::operation::Typed<C>, i16>;
async fn save_slot_controls(&self, controls: ControlData) -> Result<(), i16>;
async fn save_slot_customisations(&self, customs: CustomisationData) -> Result<(), i16>;
async fn get_slot_customisations(&self, uuid: &str) -> Result<GetCustomisationData<C>, i16>;
async fn set_slot_name(&self, slot: i32, name: String) -> Result<(), i16>;
2025-03-15 17:21:18 -04:00
fn signup_date(&self) -> i64;
async fn singleplayer_robots(&self, factory: &dyn oj_rc_factory::VehicleFactoryAdapter, weapon_order: &crate::cubes::WeaponListParser, singleplayer_config: &crate::persist::config::SingleplayerConfig, cpu_counter: &crate::cubes::CpuListParser) -> Result<polariton::operation::Typed<C>, i16>;
async fn last_seen(&self) -> Result<u64, i16>;
async fn get_avatar_info(&self) -> Result<GetAvatarInfo<C>, i16>;
async fn set_avatar_info(&self, info: AvatarInfo) -> Result<(), i16>;
fn current_game_event_setter(&self) -> Box<dyn GameEventSetter>;
async fn apply_purchase(&self, action: &crate::persist::config::ShopAction) -> Result<PurchaseResult, polariton_server::operations::SimpleOpError>;
async fn currency_debit(&self, ty: CurrencyType, to_sub: u64) -> Result<(), polariton_server::operations::SimpleOpError>;
async fn mark_code_redeemed(&self, code: String) -> Result<bool, polariton_server::operations::SimpleOpError>;
}
#[async_trait::async_trait]
pub trait GameEventSetter: Send + Sync + 'static {
async fn set_multiplayer(&self, event: CurrentGameEvent);
async fn get_multiplayer(&self) -> Option<CurrentGameEvent>;
async fn set_singleplayer(&self, event: CurrentGameEvent);
async fn get_singleplayer(&self) -> Option<CurrentGameEvent>;
2025-03-15 11:03:35 -04:00
}
pub struct UserSlots<C> {
pub slot_info: polariton::operation::Typed<C>,
pub slot_order: polariton::operation::Typed<C>,
}
pub struct UserSlotData<C> {
pub data: polariton::operation::Typed<C>,
pub colour_data: polariton::operation::Typed<C>,
pub cube_count: polariton::operation::Typed<C>,
pub weapon_order: polariton::operation::Typed<C>,
pub movement_categories: polariton::operation::Typed<C>,
pub control_type: polariton::operation::Typed<C>,
pub control_options: polariton::operation::Typed<C>,
pub mastery_level: polariton::operation::Typed<C>,
pub robot_rank: polariton::operation::Typed<C>,
pub cpu: polariton::operation::Typed<C>,
pub cosmetic_cpu: polariton::operation::Typed<C>,
2025-03-30 16:22:25 -04:00
pub uuid: polariton::operation::Typed<C>,
2025-03-15 11:03:35 -04:00
}
pub struct NewSlotData<C> {
pub name: polariton::operation::Typed<C>,
pub uuid_0: polariton::operation::Typed<C>,
pub uuid_1: polariton::operation::Typed<C>,
pub slot: polariton::operation::Typed<C>,
pub bay_cpu: polariton::operation::Typed<C>,
pub mastery_level: polariton::operation::Typed<C>,
pub slot_i: i32,
}
2025-03-15 11:03:35 -04:00
pub struct VehicleData {
pub name: Option<String>,
2025-05-07 20:23:22 -04:00
pub slot: i32,
2025-03-15 11:03:35 -04:00
pub robot_data: Vec<u8>,
pub colour_data: Vec<u8>,
pub weapon_order: Vec<i32>,
pub crf_id: Option<i32>,
pub was_rated: Option<bool>,
2025-03-15 11:03:35 -04:00
}
pub struct VehicleUploadData {
pub version: String,
pub slot: i32,
pub name: String,
pub description: String,
pub thumbnail: Vec<u8>,
}
pub struct ControlData {
pub slot: i32,
pub control_ty: ControlType,
pub vertical_strafing: bool,
pub sideways_driving: bool,
pub tracks_turn_on_spot: bool,
}
pub enum ControlType {
Camera = 0,
Keyboard = 1,
Count = 2,
}
impl ControlType {
pub fn from_i32(i: i32) -> Result<Self, i16> {
match i {
0 => Ok(Self::Camera),
1 => Ok(Self::Keyboard),
2 => Ok(Self::Count),
_ => Err(crate::data::error_codes::WebServicesError::UnexpectedError as i16),
}
}
#[inline]
pub(super) fn into_db(self) -> oj_rc_database::schema::garage::ControlType {
match self {
Self::Camera => oj_rc_database::schema::garage::ControlType::Camera,
Self::Keyboard => oj_rc_database::schema::garage::ControlType::Keyboard,
Self::Count => oj_rc_database::schema::garage::ControlType::Count,
}
}
}
pub struct CustomisationData {
pub uuid: String,
pub bay: String,
pub spawn: String,
pub death: String,
}
pub struct GetCustomisationData<C> {
pub bay: polariton::operation::Typed<C>,
pub spawn: polariton::operation::Typed<C>,
pub death: polariton::operation::Typed<C>,
}
pub struct GetAvatarInfo<C> {
pub avatar_id: polariton::operation::Typed<C>,
pub use_custom: polariton::operation::Typed<C>,
}
pub struct AvatarInfo {
pub avatar_id: i32,
pub use_custom: bool,
}
pub struct PurchaseResult {
pub success: bool,
//pub result_code:
//pub is_serial_key: bool,
//pub value: f32,
//pub promo_id: String,
pub cube_awards: std::collections::HashMap<String, u32>, // hex id -> count
pub robopass_award: bool,
pub paid_currency_award: i64,
}
#[async_trait::async_trait]
pub trait ChatUser: CommonUser + IntercomUser {
async fn subscribed_channels(&self) -> Result<polariton::operation::Typed<()>, i16>;
async fn subscribed_channels_strings(&self) -> Result<Vec<String>, i16>;
async fn add_subscribed_channel(&self, channel: String, channel_ty: crate::data::channel::ChatChannelType) -> Result<polariton::operation::Typed<()>, i16>;
async fn remove_subscribed_channel(&self, channel: String, channel_ty: crate::data::channel::ChatChannelType) -> Result<(), i16>;
//async fn has_pending_sanctions(&self) -> Result<bool, i16>;
async fn get_sanctions(&self, username: String) -> Result<polariton::operation::Typed<()>, i16>;
async fn set_sanction(&self, sanction: SetSanction) -> Result<(), i16>;
async fn get_total_registered_users(&self) -> Result<u64, polariton_server::operations::SimpleOpError>;
async fn set_permission(&self, username: String, permission: UserRole, value: bool) -> Result<(), polariton_server::operations::SimpleOpError>;
}
pub struct SetSanction {
pub is_adding: bool, // if false, it's modifying
pub type_: SanctionType,
pub duration: i32,
pub reason: String,
pub username: String,
}
pub enum SanctionType {
Warn = 0,
Mute = 1,
Ban = 2,
Note = 3,
Kick = 4,
}
impl SanctionType {
pub fn from_i32(i: i32) -> Result<Self, i16> {
match i {
0 => Ok(Self::Warn),
1 => Ok(Self::Mute),
2 => Ok(Self::Ban),
3 => Ok(Self::Note),
4 => Ok(Self::Kick),
_ => Err(crate::data::error_codes::ChatErrorCodes::UnexpectedError as i16),
}
}
}
pub enum UserRole {
Moderator,
Administrator,
Developer,
Royalty,
}
#[async_trait::async_trait]
pub trait LobbyUser {
fn user_id(&self) -> i32;
async fn player_data(&self, cpu_counter: &crate::cubes::CpuListParser) -> Result<crate::data::player_data::PlayerData, polariton_server::operations::SimpleOpError>;
async fn team_chooser(&self, game: &GameDescriptor) -> super::TeamChooser;
#[allow(clippy::too_many_arguments)]
async fn start_game(&self, game: GameDescriptor, players: Vec<PlayerLobbyDescriptor>, factory: &dyn oj_rc_factory::VehicleFactoryAdapter, cpu_counter: &crate::cubes::CpuListParser, weapon_lister: &crate::cubes::WeaponListParser, team_chooser: &super::TeamChooser, missing_players: usize) -> Result<FakePlayers, polariton_server::operations::SimpleOpError>;
2025-08-16 15:52:06 -04:00
}
pub struct FakePlayers {
2025-09-27 12:36:49 -04:00
pub players: Vec<(crate::data::player_data::PlayerData, crate::persist::config::ClientEmulator)>
}
pub struct CurrentGameEvent {
pub map: String,
pub visibility: crate::data::game_mode::MapVisibility,
pub mode: crate::data::game_mode::GameMode,
pub auto_heal: bool,
pub start: i64, // seconds since Unix epoch
pub end: i64, // seconds since Unix epoch
}
pub struct GameDescriptor {
pub guid: String,
pub map: String,
pub mode: crate::data::game_mode::GameMode,
pub visibility: crate::data::game_mode::MapVisibility,
pub auto_heal: bool,
pub is_ranked: bool,
pub is_custom: bool,
pub is_complete: bool,
}
pub struct PlayerLobbyDescriptor {
pub user_id: i32,
pub team: i32,
2025-08-16 15:52:06 -04:00
pub public_id: String,
pub display_name: String,
pub group: Option<i32>,
}
2025-07-21 22:33:12 -04:00
#[derive(Clone)]
pub struct PlayerDescriptor {
2025-08-16 15:52:06 -04:00
pub user_id: Option<i32>,
pub player_id: u8,
pub team: i32,
pub group: Option<i32>,
pub public_id: String,
pub display_name: String,
pub is_rewards_claimed: bool,
2025-09-27 12:36:49 -04:00
pub mode: Option<crate::persist::config::ClientEmulator>,
}
#[derive(Debug)]
pub struct MultiplayerError {
pub code: MultiplayerErrorCode,
pub message: String,
}
impl core::fmt::Display for MultiplayerError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{:?}: {}", self.code, self.message)
}
}
impl core::error::Error for MultiplayerError {}
#[repr(u8)]
#[derive(Debug)]
pub enum MultiplayerErrorCode {
HaxSpeed = 0,
HaxException = 1,
HaxTeleport = 2,
HaxEacViolation = 6,
HaxAfk = 7,
HaxFirerange = 8,
HaxFiredamage = 9,
HaxFirerate = 10,
HaxFireposition = 11,
IncorrectGameGuid = 12,
CustomString = 13,
TimedOut = 14,
GameEnded = 15,
}
#[async_trait::async_trait]
2025-11-03 19:24:20 -05:00
pub trait MultiplayerUser: IntercomUser + CommonUser {
fn user_id(&self) -> i32;
fn user_name(&self) -> &'_ str;
fn display_name(&self) -> &'_ str;
async fn current_game(&self) -> Result<Option<GameDescriptor>, MultiplayerError>;
async fn game_players(&self, guid: &str) -> Result<Vec<PlayerDescriptor>, MultiplayerError>;
async fn complete_game(&self, guid: &str) -> Result<(), MultiplayerError>;
async fn game_info(&self, guid: &str) -> Result<Option<GameDescriptor>, MultiplayerError>;
async fn update_game_score(&self, guid: &str, score: PlayerScore) -> Result<i32, MultiplayerError>;
async fn save_player_connected_status(&self, guid: &str, is_connected: bool) -> Result<(), MultiplayerError>;
}
pub struct PlayerScore {
pub id: Option<i32>,
pub kills: u32,
pub deaths: u32,
pub assists: u32,
pub heal_assists: u32,
pub healed: u32,
pub received_healed: u32,
pub damaged: u32,
pub received_damaged: u32,
pub crystals: u32, // crystals destroyed
pub total: u32,
}
#[async_trait::async_trait]
2025-11-03 19:24:20 -05:00
pub trait IntercomUser: CommonUser {
async fn save_custom_avatar(&self, image: Vec<u8>) -> Result<(), polariton_server::operations::SimpleOpError>;
async fn save_factory_thumbnail(&self, factory_id: i32, image: Vec<u8>) -> Result<(), polariton_server::operations::SimpleOpError>;
async fn webservice_listener(&self) -> Result<IntercomListener<super::intercom::IntercomWebServiceUserMessage>, polariton_server::operations::SimpleOpError>;
async fn show_dev_message(&self, msg: super::intercom::IntercomDevMessage, to: Vec<String>);
async fn enter_maintenance(&self, msg: super::intercom::IntercomMaintenanceMessage, to: Vec<String>);
2025-11-03 19:24:20 -05:00
async fn update_status(&self, server_name: &str, msg: oj_serdes::ServerStatus);
}
pub struct IntercomListener<D: serde::de::DeserializeOwned> {
pub(super) websocket: reqwest_websocket::WebSocket,
pub(super) _d: std::marker::PhantomData<D>,
}
impl <D: serde::de::DeserializeOwned> IntercomListener<D> {
pub async fn listen(self) -> impl futures::Stream<Item=Result<D, reqwest_websocket::Error>> + Unpin {
use futures::StreamExt;
self.websocket.map(|msg| msg.and_then(|msg| msg.json()))
}
}
pub struct ResolvedVehicle {
pub mastery: i32,
pub tier: i32,
pub robot_name: String,
pub robot_map: Vec<u8>,
pub robot_uuid: String,
pub cpu: i32,
pub weapon_order: Vec<i32>,
pub colour_map: Vec<u8>,
pub spawn_effect: String,
pub death_effect: String,
pub weapon_rank: std::collections::HashMap<i32, i32>,
}
#[async_trait::async_trait]
pub trait CommonUser: Send + Sync {
fn account_id(&self) -> i32;
async fn resolve_config_vehicle(&self, vehicle: &crate::persist::config::VehicleInfo, factory: &dyn oj_rc_factory::VehicleFactoryAdapter, weapon_order: &crate::cubes::WeaponListParser, cpu_counter: &crate::cubes::CpuListParser) -> Result<ResolvedVehicle, polariton_server::operations::SimpleOpError>;
fn public_id(&self) -> &'_ str;
fn is_mod(&self) -> bool;
fn is_admin(&self) -> bool;
fn is_dev(&self) -> bool;
fn is_royal(&self) -> bool;
fn is_banned(&self) -> bool;
2025-10-31 22:41:33 -04:00
async fn db_metrics(&self) -> oj_rc_database::DatabaseMetrics;
2026-01-05 20:34:53 -05:00
async fn db_counters(&self) -> Vec<(&'static str, i64)>;
async fn currency(&self, ty: CurrencyType, op: CurrencyOp) -> Result<u64, polariton_server::operations::SimpleOpError>;
}
#[derive(Debug, Copy, Clone)]
pub enum CurrencyType {
Free,
Paid,
TechPoints,
Experience,
}
pub enum CurrencyOp {
Get,
Add(u64),
Sub(u64),
2026-01-01 20:34:12 -05:00
AddSub(i64),
}
#[async_trait::async_trait]
pub trait SocialUser: Send + Sync {
async fn accept_friend(&self, username: String) -> Result<bool, polariton_server::operations::SimpleOpError>;
async fn decline_friend(&self, username: String) -> Result<bool, polariton_server::operations::SimpleOpError>;
async fn cancel_friend(&self, username: String) -> Result<bool, polariton_server::operations::SimpleOpError>;
async fn remove_friend(&self, username: String) -> Result<bool, polariton_server::operations::SimpleOpError>;
async fn list_friends(&self) -> Result<Vec<FriendData>, polariton_server::operations::SimpleOpError>;
async fn list_social_info(&self, public_ids: &[String]) -> Result<Vec<SocialInfo>, polariton_server::operations::SimpleOpError>;
async fn has_unclaimed_match_rewards(&self) -> Result<bool, polariton_server::operations::SimpleOpError>;
async fn get_unclaimed_match_rewards(&self) -> Result<MatchRewards, polariton_server::operations::SimpleOpError>;
async fn claim_match_rewards(&self) -> Result<bool, polariton_server::operations::SimpleOpError>;
}
#[async_trait::async_trait]
pub trait SocialUserC<C>: Send + Sync {
async fn invite_friend(&self, username: String) -> Result<FriendInviteReturn<C>, polariton_server::operations::SimpleOpError>;
}
pub struct MatchRewards {
pub season_experience: i32,
pub experience_award_base: i32,
pub experience_award_premium: i32,
pub experience_award_party: i32,
pub experience_award_tier: i32,
pub robits_total: i32,
pub average_experience: i32,
pub clan_experience: i32,
pub robits_earned: i32,
pub premium_robits_earned: i32,
}
pub struct FriendInviteReturn<C> {
pub target_public_id: String,
pub target_display_name: String,
pub my_clan_name: Option<String>,
pub target_clan_name: Option<String>,
pub my_avatar_id: u32,
pub target_player: polariton::operation::Typed<C>,
}
pub struct FriendData {
pub public_id: String,
pub display_name: String,
pub clan_name: Option<String>,
pub state: FriendInviteStatus, // FIXME don't directly pass database type
pub avatar_id: u32,
}
#[derive(Clone)]
pub struct SocialInfo {
pub public_id: String,
pub display_name: String,
pub avatar_id: Option<i32>,
}
pub enum FriendInviteStatus {
InviteSent,
InvitePending,
Accepted,
Declined,
Cancelled,
Removed,
}
impl FriendInviteStatus {
#[inline]
pub(super) fn from_db(state: oj_rc_database::schema::friend::FriendStatus) -> Self {
match state {
oj_rc_database::schema::friend::FriendStatus::InviteSent => Self::InviteSent,
oj_rc_database::schema::friend::FriendStatus::InvitePending => Self::InvitePending,
oj_rc_database::schema::friend::FriendStatus::Accepted => Self::Accepted,
oj_rc_database::schema::friend::FriendStatus::Declined => Self::Declined,
oj_rc_database::schema::friend::FriendStatus::Cancelled => Self::Cancelled,
oj_rc_database::schema::friend::FriendStatus::Removed => Self::Removed,
}
}
}
#[async_trait::async_trait]
pub trait SingleplayerUser: Send + Sync {
// regular singleplayer and campaign mode
async fn save_game_result(&self, guid: &str, result: crate::data::game_result::GameResult) -> Result<(), polariton_server::operations::SimpleOpError>;
}
#[async_trait::async_trait]
pub trait FactoryUser {
async fn prepare_factory_upload(&self, vehicle: VehicleUploadData) -> Result<oj_rc_factory::VehicleUploadInfo, polariton_server::operations::SimpleOpError>;
async fn rate_vehicle(&self, slot: i32, combat: i32, cosmetic: i32) -> Result<Option<i32>, polariton_server::operations::SimpleOpError>;
}