1 use std
::{fmt
, fs
::{self, File
}, path
::Path
, io
::Read
};
3 use itertools
::Itertools
;
4 use chrono
::{prelude
::*, Duration
};
5 use rusqlite
::{named_params
, OptionalExtension
, params
, Params
};
7 use r2d2_sqlite
::SqliteConnectionManager
;
8 use rand
::distributions
::{Alphanumeric
, DistString
};
10 use crate::{consts
, user
};
11 use crate::hash
::{hash
, verify_password
};
15 const CURRENT_DB_VERSION
: u32 = 1;
19 SqliteError(rusqlite
::Error
),
20 R2d2Error(r2d2
::Error
),
21 UnsupportedVersion(u32),
25 impl fmt
::Display
for DBError
{
26 fn fmt(&self, f
: &mut fmt
::Formatter
) -> std
::result
::Result
<(), fmt
::Error
> {
27 write!(f
, "{:?}", self)
31 impl std
::error
::Error
for DBError
{ }
33 impl From
<rusqlite
::Error
> for DBError
{
34 fn from(error
: rusqlite
::Error
) -> Self {
35 DBError
::SqliteError(error
)
39 impl From
<r2d2
::Error
> for DBError
{
40 fn from(error
: r2d2
::Error
) -> Self {
41 DBError
::R2d2Error(error
)
46 fn from_dyn_error(error
: Box
<dyn std
::error
::Error
>) -> Self {
47 DBError
::Other(error
.to_string())
51 type Result
<T
> = std
::result
::Result
<T
, DBError
>;
54 pub enum SignUpResult
{
56 UserCreatedWaitingForValidation(String
), // Validation token.
60 pub enum ValidationResult
{
63 Ok(String
, i32), // Returns token and user id.
67 pub enum SignInResult
{
71 Ok(String
, i32), // Returns token and user id.
75 pub enum AuthenticationResult
{
77 Ok(i32), // Returns user id.
81 pub struct Connection
{
82 //con: rusqlite::Connection
83 pool
: Pool
<SqliteConnectionManager
>
87 pub fn new() -> Result
<Connection
> {
88 let path
= Path
::new(consts
::DB_DIRECTORY
).join(consts
::DB_FILENAME
);
89 Self::new_from_file(path
)
92 pub fn new_in_memory() -> Result
<Connection
> {
93 Self::create_connection(SqliteConnectionManager
::memory())
96 pub fn new_from_file
<P
: AsRef
<Path
>>(file
: P
) -> Result
<Connection
> {
97 if let Some(data_dir
) = file
.as_ref().parent() {
98 if !data_dir
.exists() {
99 fs
::DirBuilder
::new().create(data_dir
).unwrap();
103 Self::create_connection(SqliteConnectionManager
::file(file
))
106 fn create_connection(manager
: SqliteConnectionManager
) -> Result
<Connection
> {
107 let pool
= r2d2
::Pool
::new(manager
).unwrap();
108 let connection
= Connection
{ pool
};
109 connection
.create_or_update()?
;
113 /// Called after the connection has been established for creating or updating the database.
114 /// The 'Version' table tracks the current state of the database.
115 fn create_or_update(&self) -> Result
<()> {
116 // Check the Database version.
117 let mut con
= self.pool
.get()?
;
118 let tx
= con
.transaction()?
;
120 // Version 0 corresponds to an empty database.
123 "SELECT [name] FROM [sqlite_master] WHERE [type] = 'table' AND [name] = 'Version'",
125 |row
| row
.get
::<usize, String
>(0)
127 Ok(_
) => tx
.query_row("SELECT [version] FROM [Version] ORDER BY [id] DESC", [], |row
| row
.get(0)).unwrap_or_default(),
132 while Self::update_to_next_version(version
, &tx
)?
{
141 fn update_to_next_version(current_version
: u32, tx
: &rusqlite
::Transaction
) -> Result
<bool
> {
142 let next_version
= current_version
+ 1;
144 if next_version
<= CURRENT_DB_VERSION
{
145 println!("Update to version {}...", next_version
);
148 fn update_version(to_version
: u32, tx
: &rusqlite
::Transaction
) -> Result
<()> {
149 tx
.execute("INSERT INTO [Version] ([version], [datetime]) VALUES (?1, datetime('now'))", [to_version
]).map(|_
| ()).map_err(DBError
::from
)
152 fn ok(updated
: bool
) -> Result
<bool
> {
154 println!("Version updated");
161 let sql_file
= consts
::SQL_FILENAME
.replace("{VERSION}", &next_version
.to_string());
162 tx
.execute_batch(&load_sql_file(&sql_file
)?
)?
;
163 update_version(next_version
, tx
)?
;
168 // Version 1 doesn't exist yet.
173 Err(DBError
::UnsupportedVersion(v
)),
177 pub fn get_all_recipe_titles(&self) -> Result
<Vec
<(i32, String
)>> {
178 let con
= self.pool
.get()?
;
180 let mut stmt
= con
.prepare("SELECT [id], [title] FROM [Recipe] ORDER BY [title]")?
;
182 let titles
: std
::result
::Result
<Vec
<(i32, String
)>, rusqlite
::Error
> =
183 stmt
.query_map([], |row
| {
184 Ok((row
.get("id")?
, row
.get("title")?
))
187 titles
.map_err(DBError
::from
)
190 /* Not used for the moment.
191 pub fn get_all_recipes(&self) -> Result<Vec<model::Recipe>> {
192 let con = self.pool.get()?;
193 let mut stmt = con.prepare("SELECT [id], [title] FROM [Recipe] ORDER BY [title]")?;
195 stmt.query_map([], |row| {
196 Ok(model::Recipe::new(row.get(0)?, row.get(1)?))
197 })?.map(|r| r.unwrap()).collect_vec(); // TODO: remove unwrap.
201 pub fn get_recipe(&self, id
: i32) -> Result
<model
::Recipe
> {
202 let con
= self.pool
.get()?
;
203 con
.query_row("SELECT [id], [title], [description] FROM [Recipe] WHERE [id] = ?1", [id
], |row
| {
204 Ok(model
::Recipe
::new(row
.get("id")?
, row
.get("title")?
, row
.get("description")?
))
205 }).map_err(DBError
::from
)
208 pub fn get_user_login_info(&self, token
: &str) -> Result
<UserLoginInfo
> {
209 let con
= self.pool
.get()?
;
210 con
.query_row("SELECT [last_login_datetime], [ip], [user_agent] FROM [UserLoginToken] WHERE [token] = ?1", [token
], |r
| {
212 last_login_datetime
: r
.get("last_login_datetime")?
,
214 user_agent
: r
.get("user_agent")?
,
216 }).map_err(DBError
::from
)
219 pub fn load_user(&self, user_id
: i32) -> Result
<User
> {
220 let con
= self.pool
.get()?
;
221 con
.query_row("SELECT [email] FROM [User] WHERE [id] = ?1", [user_id
], |r
| {
223 email
: r
.get("email")?
,
225 }).map_err(DBError
::from
)
228 pub fn sign_up(&self, email
: &str, password
: &str) -> Result
<SignUpResult
> {
229 self.sign_up_with_given_time(email
, password
, Utc
::now())
232 fn sign_up_with_given_time(&self, email
: &str, password
: &str, datetime
: DateTime
<Utc
>) -> Result
<SignUpResult
> {
233 let mut con
= self.pool
.get()?
;
234 let tx
= con
.transaction()?
;
236 match tx
.query_row("SELECT [id], [validation_token] FROM [User] WHERE [email] = ?1", [email
], |r
| {
237 Ok((r
.get
::<&str, i32>("id")?
, r
.get
::<&str, Option
<String
>>("validation_token")?
))
239 Some((id
, validation_token
)) => {
240 if validation_token
.is_none() {
241 return Ok(SignUpResult
::UserAlreadyExists
)
243 let token
= generate_token();
244 let hashed_password
= hash(password
).map_err(|e
| DBError
::from_dyn_error(e
))?
;
245 tx
.execute("UPDATE [User] SET [validation_token] = ?2, [creation_datetime] = ?3, [password] = ?4 WHERE [id] = ?1", params
![id
, token
, datetime
, hashed_password
])?
;
249 let token
= generate_token();
250 let hashed_password
= hash(password
).map_err(|e
| DBError
::from_dyn_error(e
))?
;
251 tx
.execute("INSERT INTO [User] ([email], [validation_token], [creation_datetime], [password]) VALUES (?1, ?2, ?3, ?4)", params
![email
, token
, datetime
, hashed_password
])?
;
256 Ok(SignUpResult
::UserCreatedWaitingForValidation(token
))
259 pub fn validation(&self, token
: &str, validation_time
: Duration
, ip
: &str, user_agent
: &str) -> Result
<ValidationResult
> {
260 let mut con
= self.pool
.get()?
;
261 let tx
= con
.transaction()?
;
263 match tx
.query_row("SELECT [id], [creation_datetime] FROM [User] WHERE [validation_token] = ?1", [token
], |r
| {
264 Ok((r
.get
::<&str, i32>("id")?
, r
.get
::<&str, DateTime
<Utc
>>("creation_datetime")?
))
266 Some((id
, creation_datetime
)) => {
267 if Utc
::now() - creation_datetime
> validation_time
{
268 return Ok(ValidationResult
::ValidationExpired
)
270 tx
.execute("UPDATE [User] SET [validation_token] = NULL WHERE [id] = ?1", [id
])?
;
274 return Ok(ValidationResult
::UnknownUser
)
277 let token
= Connection
::create_login_token(&tx
, user_id
, ip
, user_agent
)?
;
279 Ok(ValidationResult
::Ok(token
, user_id
))
282 pub fn sign_in(&self, email
: &str, password
: &str, ip
: &str, user_agent
: &str) -> Result
<SignInResult
> {
283 let mut con
= self.pool
.get()?
;
284 let tx
= con
.transaction()?
;
285 match tx
.query_row("SELECT [id], [password], [validation_token] FROM [User] WHERE [email] = ?1", [email
], |r
| {
286 Ok((r
.get
::<&str, i32>("id")?
, r
.get
::<&str, String
>("password")?
, r
.get
::<&str, Option
<String
>>("validation_token")?
))
288 Some((id
, stored_password
, validation_token
)) => {
289 if validation_token
.is_some() {
290 Ok(SignInResult
::AccountNotValidated
)
291 } else if verify_password(password
, &stored_password
).map_err(DBError
::from_dyn_error
)?
{
292 let token
= Connection
::create_login_token(&tx
, id
, ip
, user_agent
)?
;
294 Ok(SignInResult
::Ok(token
, id
))
296 Ok(SignInResult
::WrongPassword
)
300 Ok(SignInResult
::UserNotFound
)
305 pub fn authentication(&self, token
: &str, ip
: &str, user_agent
: &str) -> Result
<AuthenticationResult
> {
306 let mut con
= self.pool
.get()?
;
307 let tx
= con
.transaction()?
;
308 match tx
.query_row("SELECT [id], [user_id] FROM [UserLoginToken] WHERE [token] = ?1", [token
], |r
| {
309 Ok((r
.get
::<&str, i32>("id")?
, r
.get
::<&str, i32>("user_id")?
))
311 Some((login_id
, user_id
)) => {
312 tx
.execute("UPDATE [UserLoginToken] SET [last_login_datetime] = ?2, [ip] = ?3, [user_agent] = ?4 WHERE [id] = ?1", params
![login_id
, Utc
::now(), ip
, user_agent
])?
;
314 Ok(AuthenticationResult
::Ok(user_id
))
317 Ok(AuthenticationResult
::NotValidToken
)
321 pub fn sign_out(&self, token
: &str) -> Result
<()> {
322 let mut con
= self.pool
.get()?
;
323 let tx
= con
.transaction()?
;
324 match tx
.query_row("SELECT [id] FROM [UserLoginToken] WHERE [token] = ?1", [token
], |r
| {
325 Ok(r
.get
::<&str, i32>("id")?
)
328 tx
.execute("DELETE FROM [UserLoginToken] WHERE [id] = ?1", params
![login_id
])?
;
336 /// Execute a given SQL file.
337 pub fn execute_file
<P
: AsRef
<Path
> + fmt
::Display
>(&self, file
: P
) -> Result
<()> {
338 let con
= self.pool
.get()?
;
339 let sql
= load_sql_file(file
)?
;
340 con
.execute_batch(&sql
).map_err(DBError
::from
)
343 /// Execute any SQL statement.
344 /// Mainly used for testing.
345 pub fn execute_sql
<P
: Params
>(&self, sql
: &str, params
: P
) -> Result
<usize> {
346 let con
= self.pool
.get()?
;
347 con
.execute(sql
, params
).map_err(DBError
::from
)
351 fn create_login_token(tx
: &rusqlite
::Transaction
, user_id
: i32, ip
: &str, user_agent
: &str) -> Result
<String
> {
352 let token
= generate_token();
353 tx
.execute("INSERT INTO [UserLoginToken] ([user_id], [last_login_datetime], [token], [ip], [user_agent]) VALUES (?1, ?2, ?3, ?4, ?5)", params
![user_id
, Utc
::now(), token
, ip
, user_agent
])?
;
358 fn load_sql_file
<P
: AsRef
<Path
> + fmt
::Display
>(sql_file
: P
) -> Result
<String
> {
359 let mut file
= File
::open(&sql_file
).map_err(|err
| DBError
::Other(format!("Cannot open SQL file ({}): {}", &sql_file
, err
.to_string())))?
;
360 let mut sql
= String
::new();
361 file
.read_to_string(&mut sql
).map_err(|err
| DBError
::Other(format!("Cannot read SQL file ({}) : {}", &sql_file
, err
.to_string())))?
;
365 fn generate_token() -> String
{
366 Alphanumeric
.sample_string(&mut rand
::thread_rng(), consts
::AUTHENTICATION_TOKEN_SIZE
)
374 fn sign_up() -> Result
<()> {
375 let connection
= Connection
::new_in_memory()?
;
376 match connection
.sign_up("paul@test.org", "12345")?
{
377 SignUpResult
::UserCreatedWaitingForValidation(_
) => (), // Nominal case.
378 other
=> panic!("{:?}", other
),
384 fn sign_up_to_an_already_existing_user() -> Result
<()> {
385 let connection
= Connection
::new_in_memory()?
;
386 connection
.execute_sql("
387 INSERT INTO [User] ([id], [email], [name], [password], [creation_datetime], [validation_token])
392 '$argon2id$v=19$m=4096,t=3,p=1$1vtXcacYjUHZxMrN6b2Xng$wW8Z59MIoMcsIljnjHmxn3EBcc5ymEySZPUVXHlRxcY',
396 match connection
.sign_up("paul@test.org", "12345")?
{
397 SignUpResult
::UserAlreadyExists
=> (), // Nominal case.
398 other
=> panic!("{:?}", other
),
404 fn sign_up_and_sign_in_without_validation() -> Result
<()> {
405 let connection
= Connection
::new_in_memory()?
;
407 let email
= "paul@test.org";
408 let password
= "12345";
410 match connection
.sign_up(email
, password
)?
{
411 SignUpResult
::UserCreatedWaitingForValidation(_
) => (), // Nominal case.
412 other
=> panic!("{:?}", other
),
415 match connection
.sign_in(email
, password
, "127.0.0.1", "Mozilla/5.0")?
{
416 SignInResult
::AccountNotValidated
=> (), // Nominal case.
417 other
=> panic!("{:?}", other
),
424 fn sign_up_to_an_unvalidated_already_existing_user() -> Result
<()> {
425 let connection
= Connection
::new_in_memory()?
;
426 let token
= generate_token();
427 connection
.execute_sql("
428 INSERT INTO [User] ([id], [email], [name], [password], [creation_datetime], [validation_token])
433 '$argon2id$v=19$m=4096,t=3,p=1$1vtXcacYjUHZxMrN6b2Xng$wW8Z59MIoMcsIljnjHmxn3EBcc5ymEySZPUVXHlRxcY',
436 );", named_params
! { ":token": token
})?
;
437 match connection
.sign_up("paul@test.org", "12345")?
{
438 SignUpResult
::UserCreatedWaitingForValidation(_
) => (), // Nominal case.
439 other
=> panic!("{:?}", other
),
445 fn sign_up_then_send_validation_at_time() -> Result
<()> {
446 let connection
= Connection
::new_in_memory()?
;
447 let validation_token
=
448 match connection
.sign_up("paul@test.org", "12345")?
{
449 SignUpResult
::UserCreatedWaitingForValidation(token
) => token
, // Nominal case.
450 other
=> panic!("{:?}", other
),
452 match connection
.validation(&validation_token
, Duration
::hours(1), "127.0.0.1", "Mozilla/5.0")?
{
453 ValidationResult
::Ok(_
, _
) => (), // Nominal case.
454 other
=> panic!("{:?}", other
),
460 fn sign_up_then_send_validation_too_late() -> Result
<()> {
461 let connection
= Connection
::new_in_memory()?
;
462 let validation_token
=
463 match connection
.sign_up_with_given_time("paul@test.org", "12345", Utc
::now() - Duration
::days(1))?
{
464 SignUpResult
::UserCreatedWaitingForValidation(token
) => token
, // Nominal case.
465 other
=> panic!("{:?}", other
),
467 match connection
.validation(&validation_token
, Duration
::hours(1), "127.0.0.1", "Mozilla/5.0")?
{
468 ValidationResult
::ValidationExpired
=> (), // Nominal case.
469 other
=> panic!("{:?}", other
),
475 fn sign_up_then_send_validation_with_bad_token() -> Result
<()> {
476 let connection
= Connection
::new_in_memory()?
;
477 let _validation_token
=
478 match connection
.sign_up("paul@test.org", "12345")?
{
479 SignUpResult
::UserCreatedWaitingForValidation(token
) => token
, // Nominal case.
480 other
=> panic!("{:?}", other
),
482 let random_token
= generate_token();
483 match connection
.validation(&random_token
, Duration
::hours(1), "127.0.0.1", "Mozilla/5.0")?
{
484 ValidationResult
::UnknownUser
=> (), // Nominal case.
485 other
=> panic!("{:?}", other
),
491 fn sign_up_then_send_validation_then_sign_in() -> Result
<()> {
492 let connection
= Connection
::new_in_memory()?
;
494 let email
= "paul@test.org";
495 let password
= "12345";
498 let validation_token
=
499 match connection
.sign_up(email
, password
)?
{
500 SignUpResult
::UserCreatedWaitingForValidation(token
) => token
, // Nominal case.
501 other
=> panic!("{:?}", other
),
505 match connection
.validation(&validation_token
, Duration
::hours(1), "127.0.0.1", "Mozilla/5.0")?
{
506 ValidationResult
::Ok(_
, _
) => (),
507 other
=> panic!("{:?}", other
),
511 match connection
.sign_in(email
, password
, "127.0.0.1", "Mozilla/5.0")?
{
512 SignInResult
::Ok(_
, _
) => (), // Nominal case.
513 other
=> panic!("{:?}", other
),
520 fn sign_up_then_send_validation_then_authentication() -> Result
<()> {
521 let connection
= Connection
::new_in_memory()?
;
523 let email
= "paul@test.org";
524 let password
= "12345";
527 let validation_token
=
528 match connection
.sign_up(email
, password
)?
{
529 SignUpResult
::UserCreatedWaitingForValidation(token
) => token
, // Nominal case.
530 other
=> panic!("{:?}", other
),
534 let (authentication_token
, user_id
) = match connection
.validation(&validation_token
, Duration
::hours(1), "127.0.0.1", "Mozilla")?
{
535 ValidationResult
::Ok(token
, user_id
) => (token
, user_id
),
536 other
=> panic!("{:?}", other
),
539 // Check user login information.
540 let user_login_info_1
= connection
.get_user_login_info(&authentication_token
)?
;
541 assert_eq!(user_login_info_1
.ip
, "127.0.0.1");
542 assert_eq!(user_login_info_1
.user_agent
, "Mozilla");
546 match connection
.authentication(&authentication_token
, "192.168.1.1", "Chrome")?
{
547 AuthenticationResult
::Ok(user_id
) => user_id
, // Nominal case.
548 other
=> panic!("{:?}", other
),
551 // Check user login information.
552 let user_login_info_2
= connection
.get_user_login_info(&authentication_token
)?
;
553 assert_eq!(user_login_info_2
.ip
, "192.168.1.1");
554 assert_eq!(user_login_info_2
.user_agent
, "Chrome");
560 fn sign_up_then_send_validation_then_sign_out_then_sign_in() -> Result
<()> {
561 let connection
= Connection
::new_in_memory()?
;
563 let email
= "paul@test.org";
564 let password
= "12345";
567 let validation_token
=
568 match connection
.sign_up(email
, password
)?
{
569 SignUpResult
::UserCreatedWaitingForValidation(token
) => token
, // Nominal case.
570 other
=> panic!("{:?}", other
),
574 let (authentication_token_1
, user_id_1
) =
575 match connection
.validation(&validation_token
, Duration
::hours(1), "127.0.0.1", "Mozilla")?
{
576 ValidationResult
::Ok(token
, user_id
) => (token
, user_id
),
577 other
=> panic!("{:?}", other
),
580 // Check user login information.
581 let user_login_info_1
= connection
.get_user_login_info(&authentication_token_1
)?
;
582 assert_eq!(user_login_info_1
.ip
, "127.0.0.1");
583 assert_eq!(user_login_info_1
.user_agent
, "Mozilla");
586 connection
.sign_out(&authentication_token_1
)?
;
589 let (authentication_token_2
, user_id_2
) =
590 match connection
.sign_in(email
, password
, "192.168.1.1", "Chrome")?
{
591 SignInResult
::Ok(token
, user_id
) => (token
, user_id
),
592 other
=> panic!("{:?}", other
),
595 assert_eq!(user_id_1
, user_id_2
);
596 assert_ne!(authentication_token_1
, authentication_token_2
);
598 // Check user login information.
599 let user_login_info_2
= connection
.get_user_login_info(&authentication_token_2
)?
;
601 assert_eq!(user_login_info_2
.ip
, "192.168.1.1");
602 assert_eq!(user_login_info_2
.user_agent
, "Chrome");