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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
use super::trigger::TriggerPriority;
use super::BotCmdAttr;
use super::BotCmdAuthLvl;
use super::BotCmdHandler;
use super::BotCommand;
use super::Error;
use super::ErrorKind;
use super::GetDebugInfo;
use super::Result;
use super::State;
use super::Trigger;
use super::TriggerAttr;
use super::TriggerHandler;
use itertools;
use regex::Regex;
use std;
use std::borrow::Cow;
use std::sync::Arc;
use std::sync::RwLock;
use util;
use uuid::Uuid;
use yaml_rust::Yaml;

pub struct Module {
    pub name: Cow<'static, str>,
    uuid: Uuid,
    features: Vec<ModuleFeature>,
}

impl PartialEq for Module {
    fn eq(&self, other: &Self) -> bool {
        if self.uuid == other.uuid {
            debug_assert_eq!(self.name, other.name);
            true
        } else {
            false
        }
    }
}

impl Eq for Module {}

impl GetDebugInfo for Module {
    type Output = ModuleInfo;

    fn dbg_info(&self) -> ModuleInfo {
        ModuleInfo {
            name: self.name.to_string(),
        }
    }
}

pub struct ModuleBuilder {
    name: Cow<'static, str>,
    features: Vec<ModuleFeature>,
}

pub fn mk_module<'modl, S>(name: S) -> ModuleBuilder
where
    S: Into<Cow<'static, str>>,
{
    ModuleBuilder {
        name: name.into(),
        features: Default::default(),
    }
}

impl ModuleBuilder {
    pub fn command<'attr, Attrs, S1, S2, S3>(
        mut self,
        name: S1,
        syntax: S2,
        help_msg: S3,
        auth_lvl: BotCmdAuthLvl,
        handler: Box<BotCmdHandler>,
        attrs: Attrs,
    ) -> Self
    where
        S1: Into<Cow<'static, str>>,
        S2: Into<Cow<'static, str>>,
        S3: Into<Cow<'static, str>>,
        Attrs: IntoIterator<Item = &'attr BotCmdAttr>,
    {
        let name = name.into();

        assert!(
            !name.as_ref().contains(char::is_whitespace),
            "The name of the bot command {:?} contains whitespace, which is not allowed.",
            name.as_ref()
        );

        let syntax = syntax.into();
        let usage_yaml = util::yaml::parse_node(&syntax)
            .unwrap()
            .unwrap_or(Yaml::Hash(Default::default()));

        let cmd = ModuleFeature::Command {
            name: name,
            usage_str: syntax,
            usage_yaml,
            help_msg: help_msg.into(),
            auth_lvl: auth_lvl,
            handler: handler.into(),
        };

        for attr in attrs {
            match *attr {
                // ...
            }
        }

        self.features.push(cmd);

        self
    }

    pub fn trigger<'attr, Attrs, Rx1, S1, S2>(
        mut self,
        name: S1,
        regex_str: Rx1,
        help_msg: S2,
        priority: TriggerPriority,
        handler: Box<TriggerHandler>,
        attrs: Attrs,
    ) -> Self
    where
        Rx1: util::regex::IntoRegexCI,
        S1: Into<Cow<'static, str>>,
        S2: Into<Cow<'static, str>>,
        Attrs: IntoIterator<Item = &'attr TriggerAttr>,
    {
        for attr in attrs {
            match attr {
                &TriggerAttr::AlwaysWatching => unimplemented!(),
            }
        }

        let trigger = ModuleFeature::Trigger {
            name: name.into(),
            regex: Arc::new(RwLock::new(regex_str.into_regex_ci().expect(
                "Your regex was erroneous, it \
                 seems.",
            ))),
            help_msg: help_msg.into(),
            handler: handler.into(),
            priority,
            uuid: Uuid::new_v4(),
        };

        self.features.push(trigger);

        self
    }

    pub fn end(self) -> Module {
        let ModuleBuilder { name, mut features } = self;

        features.shrink_to_fit();

        Module {
            name: name,
            uuid: Uuid::new_v4(),
            features: features,
        }
    }
}

/// Information about a `Module` that can be gathered without needing any lifetime annotation.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ModuleInfo {
    name: String,
}

enum ModuleFeature {
    Command {
        name: Cow<'static, str>,
        usage_str: Cow<'static, str>,
        usage_yaml: Yaml,
        help_msg: Cow<'static, str>,
        auth_lvl: BotCmdAuthLvl,
        handler: Arc<BotCmdHandler>,
    },
    Trigger {
        name: Cow<'static, str>,
        help_msg: Cow<'static, str>,
        regex: Arc<RwLock<Regex>>,
        handler: Arc<TriggerHandler>,
        priority: TriggerPriority,
        uuid: Uuid,
    },
}

impl GetDebugInfo for ModuleFeature {
    type Output = ModuleFeatureInfo;

    fn dbg_info(&self) -> ModuleFeatureInfo {
        ModuleFeatureInfo {
            name: self.name().to_string(),
            kind: match self {
                &ModuleFeature::Command { .. } => ModuleFeatureKind::Command,
                &ModuleFeature::Trigger { .. } => ModuleFeatureKind::Trigger,
            },
        }
    }
}

/// Information about a `ModuleFeature` that can be gathered without needing any lifetime
/// annotation.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ModuleFeatureInfo {
    name: String,
    kind: ModuleFeatureKind,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ModuleFeatureKind {
    Command,
    Trigger,
}

impl ModuleFeature {
    pub fn name(&self) -> &str {
        match self {
            &ModuleFeature::Command { ref name, .. } => name.as_ref(),
            &ModuleFeature::Trigger { ref name, .. } => name.as_ref(),
        }
    }

    // fn provider(&self) -> &Module {
    //     match self {
    //         &ModuleFeature::Command { provider, .. } => provider,
    //         &ModuleFeature::Trigger => unimplemented!(),
    //     }
    // }
}

impl GetDebugInfo for BotCommand {
    type Output = ModuleFeatureInfo;

    fn dbg_info(&self) -> ModuleFeatureInfo {
        ModuleFeatureInfo {
            name: self.name.to_string(),
            kind: ModuleFeatureKind::Command,
        }
    }
}

impl GetDebugInfo for Trigger {
    type Output = ModuleFeatureInfo;

    fn dbg_info(&self) -> ModuleFeatureInfo {
        ModuleFeatureInfo {
            name: self.name.to_string(),
            kind: ModuleFeatureKind::Trigger,
        }
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ModuleLoadMode {
    /// Emit an error if any of the new module's features conflict with already present modules'
    /// features.
    Add,
    /// Overwrite any already loaded features that conflict with the new module's features, if the
    /// old features were provided by a module with the same name as the new module.
    Replace,
    /// Overwrite old modules' features unconditionally.
    Force,
}

impl State {
    pub fn load_modules<Modls>(
        &mut self,
        modules: Modls,
        mode: ModuleLoadMode,
    ) -> std::result::Result<(), Vec<Error>>
    where
        Modls: IntoIterator<Item = Module>,
    {
        let errs = itertools::flatten(modules.into_iter().filter_map(|module| {
            match self.load_module(module, mode) {
                Ok(()) => None,
                Err(e) => Some(e),
            }
        })).collect::<Vec<Error>>();

        if errs.is_empty() {
            Ok(())
        } else {
            Err(errs)
        }
    }

    pub fn load_module(
        &mut self,
        module: Module,
        mode: ModuleLoadMode,
    ) -> std::result::Result<(), Vec<Error>> {
        debug!(
            "Loading module {:?}, mode {:?}, providing {:?}",
            module.name,
            mode,
            module
                .features
                .iter()
                .map(GetDebugInfo::dbg_info)
                .collect::<Vec<_>>()
        );

        if let Some(existing_module) = match (mode, self.modules.get(module.name.as_ref())) {
            (_, None) | (ModuleLoadMode::Replace, _) | (ModuleLoadMode::Force, _) => None,
            (ModuleLoadMode::Add, Some(old)) => Some(old),
        } {
            return Err(vec![
                ErrorKind::ModuleRegistryClash(existing_module.dbg_info(), module.dbg_info())
                    .into(),
            ]);
        }

        let module = Arc::new(module);

        self.modules.insert(module.name.clone(), module.clone());

        let errs = module
            .features
            .iter()
            .filter_map(
                |feature| match self.load_module_feature(module.clone(), feature, mode) {
                    Ok(()) => None,
                    Err(e) => Some(e),
                },
            )
            .collect::<Vec<Error>>();

        if errs.is_empty() {
            Ok(())
        } else {
            Err(errs)
        }
    }

    fn load_module_feature<'modl>(
        &mut self,
        provider: Arc<Module>,
        feature: &'modl ModuleFeature,
        mode: ModuleLoadMode,
    ) -> Result<()> {
        debug!("Loading module feature (f1): {:?}", feature.dbg_info());

        if let Some(existing_feature) = match feature {
            &ModuleFeature::Command { .. } => match (mode, self.commands.get(feature.name())) {
                (_, None) | (ModuleLoadMode::Force, _) => None,
                (ModuleLoadMode::Replace, Some(old)) if old.provider.name == provider.name => None,
                (ModuleLoadMode::Replace, Some(old)) => Some(old.dbg_info()),
                (ModuleLoadMode::Add, Some(old)) => Some(old.dbg_info()),
            },
            &ModuleFeature::Trigger { .. } => None,
        } {
            bail!(ErrorKind::ModuleFeatureRegistryClash(
                existing_feature,
                feature.dbg_info(),
            ))
        }

        self.force_load_module_feature(provider, feature);

        Ok(())
    }

    fn force_load_module_feature<'modl>(
        &mut self,
        provider: Arc<Module>,
        feature: &'modl ModuleFeature,
    ) {
        debug!("Loading module feature (f2): {:?}", feature.dbg_info());

        match feature {
            &ModuleFeature::Command {
                ref name,
                ref handler,
                ref auth_lvl,
                ref usage_str,
                ref usage_yaml,
                ref help_msg,
            } => {
                self.commands.insert(
                    name.clone(),
                    BotCommand {
                        provider: provider,
                        name: name.clone(),
                        auth_lvl: auth_lvl.clone(),
                        handler: handler.clone(),
                        usage_str: usage_str.clone(),
                        usage_yaml: usage_yaml.clone(),
                        help_msg: help_msg.clone(),
                    },
                );
            }
            &ModuleFeature::Trigger {
                ref name,
                ref regex,
                ref handler,
                ref help_msg,
                priority,
                uuid,
            } => {
                self.triggers
                    .entry(priority)
                    .or_insert_with(Default::default)
                    .push(Trigger {
                        provider,
                        name: name.clone(),
                        regex: regex.clone(),
                        handler: handler.clone(),
                        priority,
                        help_msg: help_msg.clone(),
                        uuid,
                    });
            }
        };
    }
}