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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
mod mx;
mod smtp;
mod task;

use std::collections::BTreeSet;
use std::sync::mpsc::{self, RecvTimeoutError};
use std::sync::{Arc, RwLock};
use std::time::{Duration, Instant};

use trust_dns_resolver::Resolver;
use trust_dns_resolver::config::{ResolverConfig, NameServerConfig};

use self::task::{Task, TaskType};
use crate::config::{Config, DeliveryConfig, ResolverSetup};
use crate::delivery_result::DeliveryResult;
use crate::message_status::InternalMessageStatus;
use crate::prepared_email::PreparedEmail;
use crate::storage::MailstromStorage;

const LOOP_DELAY: u64 = 10;
const CHECK_STORAGE_PERIOD: u64 = 90;

pub enum Message {
    /// Start sending emails
    Start,
    /// Ask the worker to deliver an email (message_id is provided, Mailstrom will have
    /// already stored it)
    SendEmail(String),
    /// Ask the worker to terminate
    Terminate,
}

#[derive(Debug, Clone, Copy, PartialEq)]
#[repr(u8)]
pub enum WorkerStatus {
    Ok = 0,
    Terminated = 1,
    ChannelDisconnected = 2,
    LockPoisoned = 3,
    StorageWriteFailed = 4,
    StorageReadFailed = 5,
    ResolverCreationFailed = 6,
    Unknown = 255,
}
impl WorkerStatus {
    pub fn from_u8(value: u8) -> WorkerStatus {
        match value {
            0 => WorkerStatus::Ok,
            1 => WorkerStatus::Terminated,
            2 => WorkerStatus::ChannelDisconnected,
            3 => WorkerStatus::LockPoisoned,
            4 => WorkerStatus::StorageWriteFailed,
            5 => WorkerStatus::StorageReadFailed,
            6 => WorkerStatus::ResolverCreationFailed,
            _ => WorkerStatus::Unknown,
        }
    }
}

pub struct Worker<S: MailstromStorage + 'static> {
    pub receiver: mpsc::Receiver<Message>,

    worker_status: Arc<RwLock<u8>>,

    config: Config,

    // Persistent shared storage
    storage: Arc<RwLock<S>>,

    // A list of tasks we need to do later, sorted in time order
    tasks: BTreeSet<Task>,

    paused: bool,

    last_refresh: Instant,
}

impl<S: MailstromStorage + 'static> Worker<S> {
    pub fn new(
        receiver: mpsc::Receiver<Message>,
        storage: Arc<RwLock<S>>,
        worker_status: Arc<RwLock<u8>>,
        config: Config,
    ) -> Worker<S> {
        let mut worker = Worker {
            receiver,
            worker_status,
            config,
            storage,
            tasks: BTreeSet::new(),
            paused: true,
            last_refresh: Instant::now(),
        };

        // Load the incomplete (queued and/or deferred) email statuses, for tasking
        worker.refresh_resend_tasks();

        worker
    }

    // Sometimes other processes queue mail into Storage w/o the ability to message
    // us. So we periodically reread storage and refresh our resend tasks
    pub fn refresh_resend_tasks(&mut self) {

        // Remove all resend tasks (we will create them anew)
        {
            let mut t: Vec<Task> = vec![]; // temp holding for tasks to delete
            for task in &self.tasks {
                if task.tasktype==TaskType::Resend {
                    t.push(task.clone());
                }
            }
            for task in &t {
                let _ = self.tasks.remove(task);
            }
        }

        // Load the incomplete (queued and/or deferred) email statuses, for tasking
        if let Ok(guard) = (*self.storage).write() {
            if let Ok(mut isvec) = (*guard).retrieve_all_incomplete() {
                // Create one task for each queued/deferred email
                for is in isvec.drain(..) {
                    self.tasks.insert(Task {
                        tasktype: TaskType::Resend,
                        time: Instant::now(),
                        message_id: is.message_id.clone(),
                    });
                }
            } else {
                *self.worker_status.write().unwrap() = WorkerStatus::StorageReadFailed as u8;
            }
        } else {
            *self.worker_status.write().unwrap() = WorkerStatus::LockPoisoned as u8;
        }

        self.last_refresh = Instant::now();
    }

    pub fn run(&mut self) {
        let resolver: Option<Resolver> = {
            if let DeliveryConfig::Remote(ref rdc) = self.config.delivery {
                let result = match rdc.resolver_setup {
                    ResolverSetup::SystemConf => Resolver::from_system_conf(),
                    ResolverSetup::Google => Resolver::new(
                        ResolverConfig::google(), Default::default()),
                    ResolverSetup::Cloudflare => Resolver::new(
                        ResolverConfig::cloudflare(), Default::default()),
                    ResolverSetup::Quad9 => Resolver::new(
                        ResolverConfig::quad9(), Default::default()),
                    ResolverSetup::Specific {
                        socket, protocol, ref tls_dns_name
                    } => Resolver::new(
                        ResolverConfig::from_parts(
                            None, vec![], vec![NameServerConfig {
                                socket_addr: socket,
                                protocol: protocol,
                                tls_dns_name: tls_dns_name.clone()
                            }]),
                        Default::default()),
                };
                match result {
                    Ok(r) => Some(r),
                    Err(e) => {
                        *self.worker_status.write().unwrap() =
                            WorkerStatus::ResolverCreationFailed as u8;
                        info!("(worker) failed and terminated: {:?}", e);
                        return;
                    }
                }
            } else {
                None
            }
        };

        loop {
            // Compute the timeout
            // This timeout represents how long we wait for a message.  If there are any
            // tasks in the tasklist (and we are not paused), this will be the time until
            // the first task is due.  Otherwise it is set to LOOP_DELAY seconds.
            let timeout: Duration = if self.paused {
                trace!("(worker) loop start (paused)");
                Duration::from_secs(LOOP_DELAY)
            } else if let Some(task) = self.tasks.iter().next() {
                trace!("(worker) loop start (tasks in queue)");
                let now = Instant::now();
                if task.time > now {
                    task.time - now
                } else {
                    Duration::new(0, 0) // overdue!
                }
            } else {
                trace!("(worker) loop start (no tasks)");
                Duration::from_secs(LOOP_DELAY)
            };

            trace!(
                "(worker) waiting for a message ({} seconds)",
                timeout.as_secs()
            );

            // Receive a message.  Waiting at most until the time when the next task
            // is due, or LOOP_DELAY seconds if there are no tasks
            match self.receiver.recv_timeout(timeout) {
                Ok(message) => match message {
                    Message::Start => {
                        debug!("(worker) starting");
                        self.paused = false;
                    }
                    Message::SendEmail(message_id) => {
                        debug!("(worker) received SendEmail command");
                        // Create a task (don't do it right away) so we can more easily
                        // code pause-continue logic and eventually multiple worker threads
                        self.tasks.insert(Task {
                            tasktype: TaskType::Resend,
                            time: Instant::now(),
                            message_id
                        });
                    }
                    Message::Terminate => {
                        debug!("(worker) received Terminate command");
                        *self.worker_status.write().unwrap() = WorkerStatus::Terminated as u8;
                        info!("(worker) terminated");
                        return;
                    }
                },
                Err(RecvTimeoutError::Timeout) => {}
                Err(RecvTimeoutError::Disconnected) => {
                    *self.worker_status.write().unwrap() = WorkerStatus::ChannelDisconnected as u8;
                    info!("(worker) failed and terminated");
                    return;
                }
            };

            if !self.paused {
                // Possibly refresh tasks from storage
                if self.last_refresh + Duration::from_secs(CHECK_STORAGE_PERIOD) < Instant::now() {
                    self.refresh_resend_tasks();
                }


                // Copy out all the tasks that are due
                let now = Instant::now();
                let due_tasks: Vec<Task> = self.tasks
                    .iter()
                    .filter(|t| now > t.time)
                    .cloned()
                    .collect();

                // Handle all these due tasks
                for task in &due_tasks {
                    let worker_status = self.handle_task(task, resolver.as_ref());
                    if worker_status != WorkerStatus::Ok {
                        *self.worker_status.write().unwrap() = worker_status as u8;
                        debug!("(worker) failed and terminated");
                        return;
                    }
                    self.tasks.remove(task);
                }
            }
        }
    }

    fn handle_task(&mut self, task: &Task, resolver: Option<&Resolver>) -> WorkerStatus {
        match task.tasktype {
            TaskType::Resend => {
                debug!("(worker) resending a (queued/deferred) email");
                let (email, internal_message_status) = {
                    let guard = match (*self.storage).read() {
                        Ok(guard) => guard,
                        Err(_) => return WorkerStatus::LockPoisoned,
                    };
                    match (*guard).retrieve(&*task.message_id) {
                        Err(e) => {
                            warn!("Unable to retrieve task: {:?}", e);
                            return WorkerStatus::Ok;
                        }
                        Ok(x) => x,
                    }
                };
                self.send_email(email, internal_message_status, resolver)
            }
        }
    }

    fn send_email(
        &mut self,
        email: PreparedEmail,
        mut internal_message_status: InternalMessageStatus,
        resolver: Option<&Resolver>,
    ) -> WorkerStatus {

        debug!("(worker) Attempting to send message id={} ({} attempts remaining)",
               internal_message_status.message_id,
               internal_message_status.attempts_remaining);

        // Determine MX records only if doing remote delivery
        if let DeliveryConfig::Remote(_) = self.config.delivery {

            let mut need_mx: bool = false;
            for recipient in &internal_message_status.recipients {
                if recipient.mx_servers.is_none() {
                    need_mx = true;
                    break;
                }
            }

            if need_mx {
                crate::worker::mx::get_mx_records_for_email(
                    &mut internal_message_status,
                    resolver.unwrap() // Should always succeed
                );

                // Update storage with this MX information
                let status = self.update_status(&internal_message_status);
                if status != WorkerStatus::Ok {
                    return status;
                }
            }
        }

        // Fail all recipients after too many worker attempts
        if internal_message_status.attempts_remaining == 0 {
            for recipient in &mut internal_message_status.recipients {
                let mut data: Option<(u8, String)> = None;
                if let DeliveryResult::Deferred(attempts, ref msg) = recipient.result {
                    data = Some((attempts, msg.clone()));
                }
                if data.is_some() {
                    let (attempts, msg) = data.unwrap();
                    recipient.result = DeliveryResult::Failed(format!(
                        "Too many attempts ({}): {}",
                        attempts, msg
                    ));
                }
            }
        }

        // Attempt delivery of the email
        if deliver_to_all_servers(&email, &mut internal_message_status, &self.config) {
            internal_message_status.attempts_remaining = 0;

            debug!("(worker) message id={} delivered to all recipients.",
                   internal_message_status.message_id);
        } else {
            internal_message_status.attempts_remaining -= 1;
            debug!("(worker) message id={} not delivered to all recipients ({} attempts remaining)",
                   internal_message_status.message_id,
                   internal_message_status.attempts_remaining);
        }

        // Update storage with the new delivery results
        let status = self.update_status(&internal_message_status);
        if status != WorkerStatus::Ok {
            return status;
        }

        if internal_message_status.attempts_remaining > 0 {
            let attempt = 3 - internal_message_status.attempts_remaining;
            // exponential backoff
            let delay = Duration::from_secs(
                self.config.base_resend_delay_secs * 3u64.pow(u32::from(attempt)),
            );
            debug!("(worker) Queueing task to retry id={} in {} seconds",
                &internal_message_status.message_id,
                delay.as_secs()
            );

            // Create a new worker task to retry later
            self.tasks.insert(Task {
                tasktype: TaskType::Resend,
                time: Instant::now() + delay,
                message_id: internal_message_status.message_id.clone(),
            });
        }

        WorkerStatus::Ok
    }

    fn update_status(&mut self, internal_message_status: &InternalMessageStatus) -> WorkerStatus {
        // Lock the storage
        let mut guard = match (*self.storage).write() {
            Ok(guard) => guard,
            Err(e) => {
                error!("{:?}", e);
                return WorkerStatus::LockPoisoned;
            }
        };

        if let Err(e) = (*guard).update_status(internal_message_status.clone()) {
            error!("{:?}", e);
            return WorkerStatus::StorageWriteFailed;
        }

        WorkerStatus::Ok
    }
}

struct MxDelivery {
    mx_server: String,      // domain name
    mx_port: u16,           // port (defaults to 25)
    recipients: Vec<usize>, // index into InternalMessageStatus.recipients
}

// Deliver email to all servers.  Returns true if the job is done, false if more work
// is required later on.
fn deliver_to_all_servers(
    email: &PreparedEmail,
    internal_message_status: &mut InternalMessageStatus,
    config: &Config
) -> bool {
    // Plan delivery to each MX server
    let mx_deliveries = plan_mxdelivery_sessions(internal_message_status, config);

    let mut complete = true;
    for mx_delivery in &mx_deliveries {
        complete &= deliver_to_one_server(email, internal_message_status, config, mx_delivery);
    }
    complete
}

fn plan_mxdelivery_sessions(
    internal_message_status: &mut InternalMessageStatus,
    config: &Config
) -> Vec<MxDelivery> {
    // If we are using DeliveryConfig::Relay(_), the answer is straightforward
    if let DeliveryConfig::Relay(ref relay_config) = config.delivery {
        return vec![MxDelivery {
            mx_server: relay_config.domain_name.clone(),
            mx_port: relay_config.port.unwrap_or(25_u16),
            recipients: (0..internal_message_status.recipients.len()).collect()
        }];
    }

    let mut mx_deliveries: Vec<MxDelivery> = Vec::new();

    for r_index in 0..internal_message_status.recipients.len() {
        let recip = &mut internal_message_status.recipients[r_index];

        // Skip this recipient if already completed
        match recip.result {
            DeliveryResult::Delivered(_) | DeliveryResult::Failed(_) => continue,
            _ => {}
        }

        // If recipient was deferred too many times, fail them and skip them
        let mut data: Option<(u8, String)> = None;
        if let DeliveryResult::Deferred(a, ref msg) = recip.result {
            data = Some((a, msg.clone()));
        };
        if data.is_some() {
            let (attempts, msg) = data.unwrap();
            // We allow 5 attempts (even though worker does 3 passes, we might try
            // across multiple MX servers)
            if attempts >= 5 {
                debug!("(worker) delivery failed after 5 attempts.");
                recip.result = DeliveryResult::Failed(
                    format!("Failed after 5 attempts: {}", msg));
                continue;
            }
        }

        // Skip (and complete) if no MX servers
        if recip.mx_servers.is_none() {
            debug!("(worker) delivery failed (no valid MX records).");
            recip.result = DeliveryResult::Failed(
                "MX records found but none are valid".to_owned());
            continue;
        }

        // Sequence through this recipients MX servers
        let mx_servers: &Vec<String> = recip.mx_servers.as_ref().unwrap();

        // Add to our MxDelivery vector
        for item in mx_servers.iter().skip(recip.current_mx) {
            // Find the index of the MX server in our mx_deliveries array
            let maybe_position = mx_deliveries.iter().position(|mxd| mxd.mx_server == *item);
            match maybe_position {
                None => {
                    // Add this new MX server with the current recipient
                    mx_deliveries.push(MxDelivery {
                        mx_server: item.clone(),
                        mx_port: 25,
                        recipients: vec![r_index],
                    });
                }
                Some(index) => {
                    // Add this recipient to the mx_deliveries
                    mx_deliveries[index].recipients.push(r_index);
                }
            }
        }
    }

    mx_deliveries
}

// Organize delivery for one-SMTP-delivery per MX server, and then use smtp_deliver()
// Returns true only if all recipient deliveries have been completed (rather than deferred)
fn deliver_to_one_server(
    email: &PreparedEmail,
    internal_message_status: &mut InternalMessageStatus,
    config: &Config,
    mx_delivery: &MxDelivery
) -> bool {

    let mut deferred_some: bool = false;

    // Per-MX version of the prepared email
    let mut mx_prepared_email = email.clone();

    // Rebuild the 'To:' list; only add recipients for *this* MX server,
    // and for which delivery has not already completed
    mx_prepared_email.to = mx_delivery.recipients
        .iter()
        .filter_map(|r| {
            if internal_message_status.recipients[*r].result.completed() {
                None
            } else {
                Some(
                    internal_message_status.recipients[*r]
                        .smtp_email_addr
                        .clone(),
                )
            }
        })
        .collect();

    // Skip this MX server if no addresses to deliver to
    // (this can happen if a previous server already handled its recipients and
    // the filter_map above removed them all)
    if mx_prepared_email.to.is_empty() {
        return true;
    }

    // Actually deliver to this SMTP server
    // 'attempt' field in results will be set to 1
    let result = crate::worker::smtp::smtp_delivery(
        &mx_prepared_email,
        &*mx_delivery.mx_server,
        mx_delivery.mx_port,
        config);

    // Fix 'attempt' field in results on a per-recipient basis (not a per-mx basis)
    for r in &mx_delivery.recipients {
        // If the result is deferred, and the previous result was deferred, then
        // bump the attempt number and update the reason message
        if let DeliveryResult::Deferred(_, ref newmsg) = result {
            deferred_some = true;
            let mut data: Option<u8> = None;
            if let DeliveryResult::Deferred(attempts, _) =
                internal_message_status.recipients[*r].result
            {
                data = Some(attempts);
            }
            if data.is_some() {
                let attempts = data.unwrap();
                internal_message_status.recipients[*r].result =
                    DeliveryResult::Deferred(attempts + 1, newmsg.clone());
                continue;
            }
        }

        // For everyone else, just take the result
        internal_message_status.recipients[*r].result = result.clone();
    }

    !deferred_some
}

pub fn is_ip(s: &str) -> bool {
    if let Some(last) = s.chars().rev().next() {
        last.is_digit(10)
    } else {
        false
    }
}