dce-session 1.0.0

A session lib with user binding and renewable.
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
use std::collections::{BTreeSet, HashMap, HashSet};
use log::warn;
use serde::{Deserialize, Serialize};
use dce_util::mixed::{DceErr, DceResult};
use crate::session::{Session, Meta};
use crate::user::{MAPPING_TTL_SECONDS, UidGetter, SessionUser, User, UserMeta};
#[cfg(feature = "async")]
use async_trait::async_trait;
#[cfg(feature = "async")]
use redis::aio::ConnectionLike;
#[cfg(feature = "async")]
use redis::AsyncCommands;
#[cfg(not(feature = "async"))]
use redis::ConnectionLike;
#[cfg(not(feature = "async"))]
use redis::Commands;
#[cfg(feature = "connection")]
use crate::connection::{Connection, ConnectionMeta};
#[cfg(feature = "auto-renew")]
use crate::auto::AutoRenew;


pub type RedisBasic<R> = RedisSession<R, SessionUser>;

#[cfg(feature = "connection")]
pub struct RedisSession<R: ConnectionLike + Sync, U: UidGetter + Serialize> where Self: Connection {
    meta: Meta,
    user_meta: UserMeta<U>,
    conn_meta: ConnectionMeta<Self>,
    redis: Option<R>,
    cloned: Option<Box<Self>>,
}

#[cfg(feature = "connection")]
impl<R: ConnectionLike + Sync, U: UidGetter + Serialize + Clone> Clone for RedisSession<R, U> where Self: Connection {
    fn clone(&self) -> Self {
        Self{meta: self.meta.clone(), user_meta: self.user_meta.clone(), conn_meta: self.conn_meta.clone(), redis: None, cloned: None }
    }
}

#[cfg(not(feature = "connection"))]
pub struct RedisSession<R: ConnectionLike + Sync, U: UidGetter + Serialize> {
    meta: Meta,
    user_meta: UserMeta<U>,
    redis: Option<R>,
    cloned: Option<Box<Self>>,
}

#[cfg(not(feature = "connection"))]
impl<R: ConnectionLike + Sync, U: UidGetter + Serialize + Clone> Clone for RedisSession<R, U> {
    fn clone(&self) -> Self {
        Self{meta: self.meta.clone(), user_meta: self.user_meta.clone(), redis: None, cloned: None}
    }
}

impl<R, U> RedisSession<R, U> where
    R: ConnectionLike + Send + Sync, 
    U: UidGetter + Serialize + Send + Sync + for <'a> Deserialize<'a> + 'static,
{
    pub fn with(mut self, redis: R) -> Self {
        self.redis = Some(redis);
        self
    }

    pub fn redis_then(&mut self, redis: R) -> &mut Self {
        self.redis = Some(redis);
        self
    }

    #[cfg(feature = "auto-renew")]
    pub fn auto(self) -> AutoRenew<Self> where Self: Clone {
        AutoRenew::new(self)
    }
    
    fn redis(&mut self) -> DceResult<&mut R> {
        self.redis.as_mut().ok_or_else(|| DceErr::closed0("Not set the redis yet"))
    }
}


macro_rules! auto_async {
    { $($(#[$($meta:meta),+])+, $($async: ident)?);+ } => {

        #[cfg_attr(feature = "async", async_trait)]
        impl<R, U> Session for RedisSession<R, U> where
            R: ConnectionLike + Send + Sync,
            U: Serialize + UidGetter + Send + Sync + for<'a> Deserialize<'a> + 'static,
        {
            fn new(ttl_minutes: u16) -> DceResult<Self> {
                Meta::new(ttl_minutes).map(|meta| Self{meta, user_meta: UserMeta::new(), #[cfg(feature = "connection")] conn_meta: ConnectionMeta::new(), redis: None, cloned: None})
            }
            
            fn new_with_id(sid_pool: Vec<String>) -> DceResult<Self> {
                Meta::new_with_sid(sid_pool).map(|meta| Self{meta, user_meta: UserMeta::new(), #[cfg(feature = "connection")] conn_meta: ConnectionMeta::new(), redis: None, cloned: None})
            }
        
            fn meta(&self) -> &Meta {
                &self.meta
            }
        
            fn meta_mut(&mut self) -> &mut Meta {
                &mut self.meta
            }
            
            fn gen_key(sid_name: &str, id: &str) -> String {
                format!("{}:{}", sid_name, id)
            }
        
            $($(#[$($meta),+])+
            $($async)? fn silent_set(&mut self, field: &str, value: &str) -> DceResult<bool> {
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.hset(key, field, value).await.map(|_: bool| true).map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.hset(key, field, value).map(|_: bool| true).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn silent_get(&mut self, field: &str) -> DceResult<String> {
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.hget(key, field).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.hget(key, field).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn silent_del(&mut self, field: &str) -> DceResult<bool> {
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.hdel(key, field).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.hdel(key, field).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn destroy(&mut self) -> DceResult<bool> {
                #[cfg(feature = "async")]
                self.unmapping().await?;
                #[cfg(not(feature = "async"))]
                self.unmapping()?;
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.del(key).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.del(key).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn touch(&mut self) -> DceResult<bool> {
                let ttl_seconds = self.meta.ttl_seconds() as i64;
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.expire(key, ttl_seconds).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.expire(key, ttl_seconds).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn load(&mut self, data: HashMap<String, String>) -> DceResult<bool> {
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.hset_multiple(key, &data.into_iter().collect::<Vec<_>>()).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.hset_multiple(key, &data.into_iter().collect::<Vec<_>>()).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn raw(&mut self) -> DceResult<HashMap<String, String>> {
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.hgetall(key).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.hgetall(key).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn ttl_passed(&mut self) -> DceResult<u32> {
                let key = self.key();
                #[cfg(feature = "async")]
                return self.redis()?.ttl::<_, isize>(key).await.into_iter()
                    .find_map(|ttl| if ttl > 0 { Some(self.meta.ttl_seconds() - ttl as u32) } else { None })
                    .ok_or_else(|| DceErr::closed0("ttl was not initialized yet."));
                #[cfg(not(feature = "async"))]
                return self.redis()?.ttl::<_, isize>(key).into_iter()
                    .find_map(|ttl| if ttl > 0 { Some(self.meta.ttl_seconds() - ttl as u32) } else { None })
                    .ok_or_else(|| DceErr::closed0("ttl was not initialized yet."));
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn renew(&mut self, filters: HashMap<String, Option<String>>) -> DceResult<bool> {
                #[cfg(feature = "async")]
                let result = super::user::renew(self, filters).await;
                #[cfg(not(feature = "async"))]
                let result = super::user::renew(self, filters);
                #[cfg(feature = "connection")]
                if result.is_ok() && self.conn_meta.server_unbound().is_none() {
                    #[cfg(feature = "async")]
                    self.update_shadow(self.id().to_string()).await?;
                    #[cfg(not(feature = "async"))]
                    self.update_shadow(self.id().to_string())?;
                }
                result
            } )+
        
            fn clone_with_id(&mut self, id: String) -> DceResult<Self> where Self: Clone {
                super::user::clone_with_id(self, id)
            }
        
            fn cloned_mut(&mut self) -> &mut Option<Box<Self>> {
                &mut self.cloned
            }
        
            $($(#[$($meta),+])+
            $($async)? fn cloned_silent_set(&mut self, field: &str, value: &str) -> DceResult<bool> {                
                let key = Self::gen_key(self.meta.sid_name(), self.cloned.as_ref().map(|c| c.id()).ok_or_else(|| DceErr::closed0("None cloned cannot get id"))?);
                #[cfg(feature = "async")]
                return self.redis()?.hset(key, field, value).await.map(|_: bool| true).map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.hset(key, field, value).map(|_: bool| true).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn cloned_destroy(&mut self) -> DceResult<bool> {                
                #[cfg(feature = "async")]
                self.cloned_unmapping().await?;
                #[cfg(not(feature = "async"))]
                self.cloned_unmapping()?;
                let key = Self::gen_key(self.meta.sid_name(), self.cloned.as_ref().map(|c| c.id()).ok_or_else(|| DceErr::closed0("None cloned cannot get id"))?);
                #[cfg(feature = "async")]
                self.redis()?.del(key).await.map_err(DceErr::closed0)?;
                #[cfg(not(feature = "async"))]
                self.redis()?.del(key).map_err(DceErr::closed0)?;
                // just return true, because old may not stored
                Ok(true)
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn cloned_touch(&mut self) -> DceResult<bool> {                
                let ttl_seconds = self.meta.ttl_seconds() as i64;
                let key = Self::gen_key(self.meta.sid_name(), self.cloned.as_ref().map(|c| c.id()).ok_or_else(|| DceErr::closed0("None cloned cannot get id"))?);
                #[cfg(feature = "async")]
                return self.redis()?.expire(key, ttl_seconds).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.expire(key, ttl_seconds).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn cloned_ttl_passed(&mut self) -> DceResult<u32> {
                let key = Self::gen_key(self.meta.sid_name(), self.cloned.as_ref().map(|c| c.id()).ok_or_else(|| DceErr::closed0("None cloned cannot get id"))?);
                #[cfg(feature = "async")]
                return self.redis()?.ttl::<_, isize>(key).await.into_iter()
                    .find_map(|ttl| if ttl > 0 { Some(self.meta.ttl_seconds() - ttl as u32) } else { None })
                    .ok_or_else(|| DceErr::closed0("ttl was not initialized yet."));
                #[cfg(not(feature = "async"))]
                return self.redis()?.ttl::<_, isize>(key).into_iter()
                    .find_map(|ttl| if ttl > 0 { Some(self.meta.ttl_seconds() - ttl as u32) } else { None })
                    .ok_or_else(|| DceErr::closed0("ttl was not initialized yet."));
            } )+
        }
        
        
        #[cfg_attr(feature = "async", async_trait)]
        impl<R, U> User<U> for RedisSession<R, U> where
            R: ConnectionLike + Send + Sync,
            U: Serialize + UidGetter + Send + Sync + for<'a> Deserialize<'a> + 'static,
        {
            fn user_meta(&self) -> &UserMeta<U> {
                &self.user_meta
            }
        
            fn user_meta_mut(&mut self) -> &mut UserMeta<U> {
                &mut self.user_meta
            }
            
            fn gen_user_key(user_prefix: &str, id: u64) -> String {
                format!("{}:{}", user_prefix, id)
            }
        
            #[cfg(feature = "async")]
            async fn mapping(&mut self) -> DceResult<bool> {
                // add the new sid into uid->sids mapping
                let user_key = self.user_key().await?;
                let id = self.id().to_string();
                self.redis()?.sadd(user_key.as_str(), id).await.map_err(DceErr::closed0)?;
                self.redis()?.expire(user_key.as_str(), MAPPING_TTL_SECONDS).await.map_err(DceErr::closed0)
            }
        
            #[cfg(not(feature = "async"))]
            fn mapping(&mut self) -> DceResult<bool> {
                // add the new sid into uid->sids mapping
                let user_key = self.user_key()?;
                let id = self.id().to_string();
                self.redis()?.sadd(user_key.as_str(), id).map_err(DceErr::closed0)?;
                self.redis()?.expire(user_key.as_str(), MAPPING_TTL_SECONDS).map_err(DceErr::closed0)
            }
        
            $($(#[$($meta),+])+
            $($async)? fn unmapping(&mut self) -> DceResult<bool> {
                // just need to try unmapping, because no user info if not logged there
                let sid = self.id().to_string();
                #[cfg(feature = "async")]
                if let Ok(user_key) = self.user_key().await {
                    return self.redis()?.srem(user_key, sid).await.map_err(DceErr::closed0);
                }
                #[cfg(not(feature = "async"))]
                if let Ok(user_key) = self.user_key() {
                    return self.redis()?.srem(user_key, sid).map_err(DceErr::closed0);
                }
                Ok(false)
            } )+
            
            $($(#[$($meta),+])+
            $($async)? fn sync(&mut self, user: &U) -> DceResult<bool> {
                let user_json = serde_json::to_string::<U>(user).map_err(DceErr::closed0)?;
                let user_field = self.user_meta().user_field().to_string();
                #[cfg(feature = "async")]
                for sid in self.sids(user.id()).await? {
                    let key = Self::gen_key(self.meta.sid_name(), sid.as_str());
                    self.redis()?.hset(key, user_field.as_str(), user_json.as_str()).await.map_err(DceErr::closed0)?;
                }
                #[cfg(not(feature = "async"))]
                for sid in self.sids(user.id())? {
                    let key = Self::gen_key(self.meta.sid_name(), sid.as_str());
                    self.redis()?.hset(key, user_field.as_str(), user_json.as_str()).map_err(DceErr::closed0)?;
                }
                Ok(true)
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn all_sid(&mut self, uid: u64) -> DceResult<HashSet<String>> {
                let user_key = Self::gen_user_key(self.user_meta.key_prefix(), uid);
                #[cfg(feature = "async")]
                return self.redis()?.smembers(user_key).await.map_err(DceErr::closed0);
                #[cfg(not(feature = "async"))]
                return self.redis()?.smembers(user_key).map_err(DceErr::closed0);
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn filter_sids(&mut self, uid: u64, sids: BTreeSet<String>) -> DceResult<BTreeSet<String>> {
                let user_key = Self::gen_user_key(self.user_meta.key_prefix(), uid);
                let mut filtered = BTreeSet::new();
                #[cfg(feature = "async")]
                for sid in sids {
                    let key = Self::gen_key(self.meta.sid_name(), sid.as_str());
                    if self.redis()?.exists(key).await.map_err(DceErr::closed0)? {
                        filtered.insert(sid);
                    } else {
                        let _ = self.redis()?.srem::<_, _, bool>(&user_key, sid).await.map_err(|e| warn!("{e}"));
                    }
                }
                #[cfg(not(feature = "async"))]
                for sid in sids {
                    let key = Self::gen_key(self.meta.sid_name(), sid.as_str());
                    if self.redis()?.exists(key).map_err(DceErr::closed0)? {
                        filtered.insert(sid);
                    } else {
                        let _ = self.redis()?.srem::<_, _, bool>(&user_key, sid).map_err(|e| warn!("{e}"));
                    }
                }
                Ok(filtered)
            } )+
        
            $($(#[$($meta),+])+
            $($async)? fn cloned_unmapping(&mut self) -> DceResult<bool> {                
                let keys = self.cloned.iter().find_map(|c| c.user_meta.user().map(|u| (Self::gen_user_key(c.user_meta.key_prefix(), u.id()), c.id().to_string())));
                if let Some((user_key, sid)) = keys {
                    #[cfg(feature = "async")]
                    return self.redis()?.srem(user_key, sid).await.map_err(DceErr::closed0);
                    #[cfg(not(feature = "async"))]
                    return self.redis()?.srem(user_key, sid).map_err(DceErr::closed0);
                }
                Ok(false)
            } )+
        }
    };
}
auto_async! {#[cfg(feature = "async")], async; #[cfg(not(feature = "async"))],}

#[cfg(feature = "connection")]
#[cfg_attr(feature = "async", async_trait)]
impl<R, U> Connection for RedisSession<R, U> where
    R: ConnectionLike + Send + Sync,
    U: Serialize + UidGetter + Send + Sync + for<'b> Deserialize<'b> + 'static,
{
    fn conn_meta(&self) -> &ConnectionMeta<Self> {
        &self.conn_meta
    }

    fn conn_meta_mut(&mut self) -> &mut ConnectionMeta<Self> {
        &mut self.conn_meta
    }

    #[cfg(feature = "async")]
    async fn unbinding(&mut self) -> DceResult<bool> {
        let (key, value) = (self.key(), self.conn_meta().server_field().to_string());
        return self.redis()?.hdel(key, value).await.map_err(DceErr::closed0);
    }

    #[cfg(not(feature = "async"))]
    fn unbinding(&mut self) -> DceResult<bool> {
        let (key, value) = (self.key(), self.conn_meta().server_field().to_string());
        return self.redis()?.hdel(key, value).map_err(DceErr::closed0);
    }
}