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
#![feature(proc_macro_hygiene, decl_macro)]
#![feature(in_band_lifetimes)]
use prelude::{ChannelPermission, HubPermission};
use reqwest::StatusCode;
use std::time::{SystemTime, UNIX_EPOCH};
use thiserror::Error;
use uuid::Uuid;
pub mod api;
pub mod auth;
pub mod channel;
pub mod config;
pub mod hub;
pub mod permission;
pub mod user;
#[derive(Debug, PartialEq, Eq, Clone, Error)]
pub enum DataError {
#[error("server was unable to write new data to disk")]
WriteFile,
#[error("server was unable to parse some data")]
Deserialize,
#[error("server could not create a directory")]
Directory,
#[error("server failed to read requested data from disk")]
ReadFile,
#[error("server could not serialize some data")]
Serialize,
#[error("server was unable to delete the data")]
DeleteFailed,
}
#[derive(Debug, Error)]
pub enum ApiError {
#[error("user is muted")]
Muted,
#[error("user is banned")]
Banned,
#[error("hub does not exist")]
HubNotFound,
#[error("channel does not exist")]
ChannelNotFound,
#[error("user does not have the {0} hub permission")]
MissingHubPermission(HubPermission),
#[error("user does not have the {0} channel permission")]
MissingChannelPermission(ChannelPermission),
#[error("user not in hub")]
NotInHub,
#[error("user does not exist")]
UserNotFound,
#[error("member does not exist")]
MemberNotFound,
#[error("message does not exist")]
MessageNotFound,
#[error("not authenticated")]
NotAuthenticated,
#[error("group does not exist")]
GroupNotFound,
#[error("name is not valid, too long or invalid characters")]
InvalidName,
#[error("server did something unexpected")]
UnexpectedServerArg,
#[error("message is too big, maximum is {} bytes", MESSAGE_MAX_SIZE)]
MessageTooBig,
#[error("unable to parse message, only UTF-8 is supported")]
InvalidMessage,
#[error("{0}")]
Other(String, StatusCode),
#[error(transparent)]
Auth(#[from] auth::AuthError),
#[error(transparent)]
Data(#[from] DataError),
#[error(transparent)]
Io(#[from] std::io::Error),
}
impl From<&ApiError> for StatusCode {
fn from(error: &ApiError) -> Self {
match error {
ApiError::NotAuthenticated => Self::UNAUTHORIZED,
ApiError::InvalidName => Self::BAD_REQUEST,
ApiError::Banned => Self::FORBIDDEN,
ApiError::ChannelNotFound => Self::NOT_FOUND,
ApiError::GroupNotFound => Self::NOT_FOUND,
ApiError::HubNotFound => Self::NOT_FOUND,
ApiError::MemberNotFound => Self::NOT_FOUND,
ApiError::MessageNotFound => Self::NOT_FOUND,
ApiError::Muted => Self::FORBIDDEN,
ApiError::MissingChannelPermission(_) => Self::FORBIDDEN,
ApiError::MissingHubPermission(_) => Self::FORBIDDEN,
ApiError::NotInHub => Self::NOT_FOUND,
ApiError::UserNotFound => Self::NOT_FOUND,
ApiError::UnexpectedServerArg => Self::INTERNAL_SERVER_ERROR,
ApiError::MessageTooBig => Self::BAD_REQUEST,
ApiError::InvalidMessage => Self::BAD_REQUEST,
ApiError::Other(_, code) => code.clone(),
ApiError::Auth(error) => error.into(),
ApiError::Data(_) => Self::INTERNAL_SERVER_ERROR,
ApiError::Io(_) => Self::INTERNAL_SERVER_ERROR,
}
}
}
pub type Result<T, E = ApiError> = std::result::Result<T, E>;
pub const USER_AGENT_STRING: &str = concat!("WICRS Server ", env!("CARGO_PKG_VERSION"));
pub const NAME_ALLOWED_CHARS: &str =
" .,_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
pub const MAX_NAME_LENGTH: usize = 32;
pub const MIN_NAME_LENGTH: usize = 1;
pub const MESSAGE_MAX_SIZE: usize = 4096;
pub fn get_system_millis() -> u128 {
SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap()
.as_millis()
}
pub fn is_valid_name(name: &str) -> bool {
name.len() >= MIN_NAME_LENGTH
&& name.len() <= MAX_NAME_LENGTH
&& name.chars().all(|c| NAME_ALLOWED_CHARS.contains(c))
}
pub fn check_name_validity(name: &str) -> Result<()> {
if is_valid_name(name) {
Ok(())
} else {
Err(ApiError::InvalidName)
}
}
#[macro_export]
macro_rules! check_permission {
($member:expr, $perm:expr, $hub:expr) => {
if !$member.has_permission($perm, &$hub) {
return Err(ApiError::MissingHubPermission($perm));
}
};
($member:expr, $channel:expr, $perm:expr, $hub:expr) => {
if !$member.has_channel_permission($channel, &$perm, &$hub) {
return Err(ApiError::MissingChannelPermission($perm));
}
};
}
pub type ID = Uuid;
pub fn new_id() -> ID {
uuid::Uuid::new_v4()
}
pub mod prelude {
pub use crate::api::*;
pub use crate::auth::{IDToken, Service};
pub use crate::channel::{Channel, Message};
pub use crate::check_name_validity;
pub use crate::hub::{Hub, HubMember, PermissionGroup};
pub use crate::is_valid_name;
pub use crate::new_id;
pub use crate::permission::{
ChannelPermission, ChannelPermissions, HubPermission, HubPermissions, PermissionSetting,
};
pub use crate::user::{get_id, GenericUser, User};
pub use crate::ApiError;
pub use crate::Result;
pub use crate::ID;
pub use crate::MAX_NAME_LENGTH;
pub use crate::MESSAGE_MAX_SIZE;
pub use crate::NAME_ALLOWED_CHARS;
pub use crate::USER_AGENT_STRING;
}
#[cfg(test)]
mod tests {
use super::is_valid_name;
#[test]
fn valid_username_check() {
assert!(is_valid_name("a"));
assert!(is_valid_name("Test_test tHAt-tester."));
assert!(is_valid_name("1234567890"));
assert!(is_valid_name("l33t 5p34k"));
assert!(!is_valid_name(""));
assert!(!is_valid_name("Test! @thing"));
assert!(!is_valid_name("123456789111315171921232527293133"));
}
}