      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

    /*
     * mCaptcha - A proof of work based DoS protection system
     * Copyright © 2021 Aravinth Manivannan <realravinth@batsense.net>
     *
     * This program is free software: you can redistribute it and/or modify
     * it under the terms of the GNU Affero General Public License as
     * published by the Free Software Foundation, either version 3 of the
     * License, or (at your option) any later version.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU Affero General Public License for more details.
     *
     * You should have received a copy of the GNU Affero General Public License
     * along with this program.  If not, see <http://www.gnu.org/licenses/>.
     */
    //! [Master] actor module that manages [MCaptcha] actors
    use std::collections::BTreeMap;
    use std::time::Duration;

    //use actix::clock::sleep;
    use actix::clock::delay_for;
    use actix::dev::*;
    use derive_builder::Builder;
    use log::info;

    use crate::mcaptcha::MCaptcha;

    /// This Actor manages the [MCaptcha] actors.
    /// A service can have several [MCaptcha] actors with
    /// varying [Defense][crate::defense::Defense] configurations
    /// so a "master" actor is needed to manage them all
    #[derive(Clone)]
    pub struct Master {
        sites: BTreeMap<String, (Option<()>, Addr<MCaptcha>)>,
        gc: u64,
    }

    impl Master {
        /// add [MCaptcha] actor to [Master]
        pub fn add_site(&mut self, details: AddSite) {
            self.sites
                .insert(details.id, (None, details.addr.to_owned()));
        }

        /// create new master
        /// accepts a `u64` to configure garbage collection period
        pub fn new(gc: u64) -> Self {
            Master {
                sites: BTreeMap::new(),
                gc,
            }
        }

        /// get [MCaptcha] actor from [Master]
        pub fn get_site<'a, 'b>(&'a mut self, id: &'b str) -> Option<Addr<MCaptcha>> {
            let mut r = None;
            if let Some((read_val, addr)) = self.sites.get_mut(id) {
                r = Some(addr.clone());
                *read_val = Some(());
            };
            r
        }

        /// remvoes [MCaptcha] actor from [Master]
        pub fn rm_site(&mut self, id: &str) {
            self.sites.remove(id);
        }
    }

    impl Actor for Master {
        type Context = Context<Self>;

        fn started(&mut self, ctx: &mut Self::Context) {
            let addr = ctx.address();
            let task = async move {
                addr.send(CleanUp).await.unwrap();
            }
            .into_actor(self);
            ctx.spawn(task);
        }
    }

    /// Message to get an [MCaptcha] actor from master
    #[derive(Message)]
    #[rtype(result = "Option<Addr<MCaptcha>>")]
    pub struct GetSite(pub String);

    impl Handler<GetSite> for Master {
        type Result = MessageResult<GetSite>;

        fn handle(&mut self, m: GetSite, _ctx: &mut Self::Context) -> Self::Result {
            let addr = self.get_site(&m.0);
            if addr.is_none() {
                return MessageResult(None);
            } else {
                return MessageResult(Some(addr.unwrap().clone()));
            }
        }
    }

    /// Message to clean up master of [MCaptcha] actors with zero visitor count
    #[derive(Message)]
    #[rtype(result = "()")]
    pub struct CleanUp;

    impl Handler<CleanUp> for Master {
        type Result = ();

        fn handle(&mut self, _: CleanUp, ctx: &mut Self::Context) -> Self::Result {
            let sites = self.sites.clone();
            let gc = self.gc;
            let master = ctx.address();
            info!("init master actor cleanup up");
            let task = async move {
                for (id, (new, addr)) in sites.iter() {
                    use crate::mcaptcha::{GetCurrentVisitorCount, Stop};
                    let visitor_count = addr.send(GetCurrentVisitorCount).await.unwrap();
                    println!("{}", visitor_count);
                    if visitor_count == 0 && new.is_some() {
                        addr.send(Stop).await.unwrap();
                        master.send(RemoveSite(id.to_owned())).await.unwrap();
                        println!("cleaned up");
                    }
                }

                let duration = Duration::new(gc, 0);
                //sleep(duration).await;
                delay_for(duration).await;
                master.send(CleanUp).await.unwrap();
            }
            .into_actor(self);
            ctx.spawn(task);
        }
    }

    /// Message to delete [MCaptcha] actor
    #[derive(Message)]
    #[rtype(result = "()")]
    pub struct RemoveSite(pub String);

    impl Handler<RemoveSite> for Master {
        type Result = ();

        fn handle(&mut self, m: RemoveSite, _ctx: &mut Self::Context) -> Self::Result {
            self.rm_site(&m.0);
        }
    }

    /// Message to add an [MCaptcha] actor to [Master]
    #[derive(Message, Builder)]
    #[rtype(result = "()")]
    pub struct AddSite {
        pub id: String,
        pub addr: Addr<MCaptcha>,
    }

    impl Handler<AddSite> for Master {
        type Result = ();

        fn handle(&mut self, m: AddSite, _ctx: &mut Self::Context) -> Self::Result {
            self.add_site(m);
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;
        use crate::mcaptcha::tests::*;

        #[actix_rt::test]
        async fn master_actor_works() {
            let addr = Master::new(1).start();

            let id = "yo";
            let mcaptcha = get_counter().start();
            let msg = AddSiteBuilder::default()
                .id(id.into())
                .addr(mcaptcha.clone())
                .build()
                .unwrap();

            addr.send(msg).await.unwrap();

            let mcaptcha_addr = addr.send(GetSite(id.into())).await.unwrap();
            assert_eq!(mcaptcha_addr, Some(mcaptcha));

            let addr_doesnt_exist = addr.send(GetSite("a".into())).await.unwrap();
            assert!(addr_doesnt_exist.is_none());

            let timer_expire = Duration::new(DURATION, 0);
            //        sleep(timer_expire).await;
            //        sleep(timer_expire).await;
            delay_for(timer_expire).await;
            delay_for(timer_expire).await;

            let mcaptcha_addr = addr.send(GetSite(id.into())).await.unwrap();
            assert_eq!(mcaptcha_addr, None);
        }
    }