send-reminders

   1 #!/usr/bin/perl -T
   2
   3 =head1 NAME
   4
   5 Send-reminders - send email reminders for special occasions
   6
   7 =head1 SYNOPSIS
   8
   9 Send emails reminders set by users for special occasions.
  10
  11 =head1 DESCRIPTION
  12
  13 Email-reminder allows users to define events that they want to be
  14 reminded of by email.  Possible events include birthdays,
  15 anniversaries and yearly events.  Reminders can be sent on the day of
  16 the event and a few days beforehand.
  17
  18 This script is meant to be invoked everyday by a cron job.  It mails
  19 the actual reminders out.
  20
  21 When run by the root user, it processes all of the spooled reminders.
  22 When run by a specific user, it only processes reminders set by that
  23 user.
  24
  25 =head1 OPTIONS
  26
  27 =over 6
  28
  29 =item B<--help>
  30
  31 Displays basic usage message.
  32
  33 =item B<--simulate>
  34
  35 Does not actually send any emails out.
  36
  37 =item B<--verbose>
  38
  39 Prints out information about what the program is doing, including the
  40 full emails being sent out.
  41
  42 =item B<--version>
  43
  44 Displays the version number.
  45
  46 =back
  47
  48 =head1 FILES
  49
  50 F<~/.email-reminders>, F</etc/email-reminder.conf>
  51
  52 =head1 AUTHOR
  53
  54 Francois Marier <francois@debian.org>
  55
  56 =head1 SEE ALSO
  57
  58 email-reminder-editor, collect-reminders
  59
  60 =head1 COPYRIGHT
  61
  62 Copyright (C) 2004-2008 by Francois Marier
  63
  64 Email-Reminder is free software; you can redistribute it and/or
  65 modify it under the terms of the GNU General Public License as
  66 published by the Free Software Foundation; either version 3 of the
  67 License, or (at your option) any later version.
  68
  69 Email-Reminder is distributed in the hope that it will be useful,
  70 but WITHOUT ANY WARRANTY; without even the implied warranty of
  71 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  72 General Public License for more details.
  73
  74 You should have received a copy of the GNU General Public License
  75 along with Email-Reminder; if not, write to the Free Software
  76 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  77 02110-1301, USA.
  78
  79 =cut
  80
  81 use strict;
  82 use warnings;
  83
  84 use Encode;
  85 use Getopt::Long;
  86 use MIME::Base64;
  87 use MIME::QuotedPrint;
  88 use Pod::Usage;
  89
  90 use EmailReminder::EventList;
  91 use EmailReminder::Utils;
  92 use Date::Manip qw(ParseDate UnixDate);
  93
  94 # Default preferences
  95 my $PREFERENCE_FILE = '/etc/email-reminder.conf';
  96 my %preferences;
  97 $preferences{"send_reminders"}   = 1;
  98 $preferences{"smtp_server"}      = 'localhost';
  99 $preferences{"smtp_ssl"}         = 0;
 100 $preferences{"smtp_username"}    = '';
 101 $preferences{"smtp_password"}    = '';
 102 $preferences{"mail_from"}        = 'root@localhost';
 103 read_config();
 104
 105 # Global variables
 106 my $user_fname;
 107 my $user_lname;
 108
 109 # Command-line parameters
 110 my $verbose  = 0;
 111 my $simulate = 0;
 112 my $version  = 0;
 113 my $help  = 0;
 114 GetOptions( "verbose"  => \$verbose,
 115             "simulate" => \$simulate,
 116             "version"  => \$version,
 117             "help"     => \$help,
 118     );
 119
 120 # Override preferences with system values
 121 sub read_config
 122 {
 123     if (open CONFIG, '<', $PREFERENCE_FILE)
 124     {
 125         print "Reading preferences from '$PREFERENCE_FILE'\n" if $verbose;
 126
 127         # Stolen off of the Cookbook (section 8.16)
 128         while (<CONFIG>) {
 129             chomp;                  # no newline
 130             s/#.*//;                # no comments
 131             s/^\s+//;               # no leading white
 132             s/\s+$//;               # no trailing white
 133             next unless length;     # anything left?
 134             my ($var, $value) = split(/\s*=\s*/, $_, 2);
 135             $preferences{$var} = $value;
 136         }
 137
 138         close CONFIG;
 139     }
 140     else {
 141         print "Warning: cannot read configuration file at $PREFERENCE_FILE.\nMake sure that the user running $0 has read permissions on that configuration file.\n";
 142     }
 143 }
 144
 145 sub send_email
 146 {
 147     my $message = shift;
 148     my $subject = shift;
 149     my $user_name = shift;
 150     my $user_email = shift;
 151
 152     unless ($user_email) {
 153         return 0;
 154     }
 155
 156     my $to = $user_email;
 157     $to = "$user_name <$user_email>" if ($user_name);
 158
 159     print "--> Emailing '$to':\n".encode("UTF-8", $subject."\n\n".$message) if $verbose;
 160
 161     unless ($simulate) {
 162         my $smtp_server = '';
 163         if ($preferences{"smtp_server"} =~ /^([A-Za-z_0-9\-\/.]+)$/) {
 164             $smtp_server = $1;
 165         }
 166         my $smtp = undef;
 167         if ($preferences{"smtp_ssl"}) {
 168             use Net::SMTP::SSL;
 169             $smtp = Net::SMTP::SSL->new($smtp_server, Port => 465, Debug => 0);
 170         }
 171         else {
 172             use Net::SMTP;
 173             $smtp = Net::SMTP->new($smtp_server, Debug => 0);
 174         }
 175         die "Error: couldn't connect to server '$smtp_server'" unless $smtp;
 176
 177         # SMTP SASL authentication (if necessary)
 178         if ($preferences{"smtp_username"} and $preferences{"smtp_password"}) {
 179             unless ($smtp->auth($preferences{"smtp_username"}, $preferences{"smtp_password"})) {
 180                 die "Error: authentication with the SMTP server failed with error code ".$smtp->status;
 181             }
 182         }
 183
 184         unless ($smtp->mail($preferences{"mail_from"})) {
 185             die "Error: the sending address was not accepted. Try setting the 'mail_from' variable to a valid email address in the configuration file";
 186         }
 187
 188         my $ok = 1;
 189         $ok = $ok && $smtp->to($to);
 190         $ok = $ok && $smtp->data();
 191         $ok = $ok && $smtp->datasend("From: Email-Reminder <" . $preferences{"mail_from"} . ">\n");
 192
 193         # Create an RFC822 compliant date (current time)
 194         my $rfc822_format = "%a, %d %b %Y %H:%M %z";
 195         my $today         = ParseDate("Now");
 196         my $rfc822_date = UnixDate($today,$rfc822_format);
 197         $ok = $ok && $smtp->datasend("Date: $rfc822_date\n");
 198
 199         $ok = $ok && $smtp->datasend("To: $to\n");
 200         $ok = $ok && $smtp->datasend("Subject: =?utf-8?B?".encode_base64(encode("UTF-8", $subject), '')."?=\n");
 201         $ok = $ok && $smtp->datasend("Mime-Version: 1.0\n");
 202         $ok = $ok && $smtp->datasend("Content-Type: text/plain; charset=utf-8\n");
 203         $ok = $ok && $smtp->datasend("Content-Disposition: inline\n");
 204         $ok = $ok && $smtp->datasend("Content-Transfer-Encoding: quoted-printable\n");
 205         $ok = $ok && $smtp->datasend("\n");
 206         $ok = $ok && $smtp->datasend(encode_qp(encode("UTF-8", $message)));
 207         $ok = $ok && $smtp->dataend();
 208
 209         $smtp->quit();
 210
 211         die "Error: could not mail the reminder out" unless $ok;
 212     }
 213
 214     return 1;
 215 }
 216
 217 sub process_file
 218 {
 219     my $file = shift;
 220
 221     print "==> Processing $file\n" if $verbose;
 222
 223     my $list = EmailReminder::EventList->new($file);
 224
 225     my @fullname = $list->get_user_name();
 226     my $user_fname = $fullname[0];
 227     my $user_lname = $fullname[1];
 228     my $user_name = $user_fname;
 229     $user_name .= " " . $user_lname if defined($user_lname);
 230     my $user_email = $list->get_user_email();
 231
 232     foreach my $event ($list->get_events()) {
 233         print '--> Processing event '.$event->get_name()."\n" if $verbose;
 234
 235         if ($event->is_occurring()) {
 236             print '--> Event '.$event->get_name()." is occurring\n" if $verbose;
 237
 238             my $msg = $event->get_message($user_fname);
 239             my $subject = $event->get_subject();
 240
 241             my @recipients = @{$event->get_recipients()};
 242             if ($#recipients > -1) {
 243                 foreach my $recipient (@recipients) {
 244                     my $recipient_email = shift @{$recipient};
 245                     my $recipient_name = shift @{$recipient};
 246                     my $success = send_email($msg, $subject, $recipient_name, $recipient_email) if $msg;
 247                     return 0 if !$success;
 248                 }
 249             } else {
 250                 my $success = send_email($msg, $subject, $user_name, $user_email) if $msg;
 251                 return 0 if !$success;
 252             }
 253         }
 254     }
 255
 256     return 1;
 257 }
 258
 259 sub main
 260 {
 261     my $running_uid = $>;
 262     if (0 == $running_uid) {
 263         print STDERR "Warning: for security reasons, this script should not be not as root.\n";
 264     }
 265
 266     my $spool_dir = $EmailReminder::Utils::SPOOL_DIRECTORY;
 267     if (-w $spool_dir) {
 268         # Iterate through all spooled files
 269         while (defined(my $file = <$spool_dir/*>)) {
 270             # Untaint filename
 271             if ($file =~ /^([A-Za-z_0-9\-\/]+)$/) {
 272                 $file = $1;
 273             } else {
 274                 print STDERR "Skipped unclean filename" if $verbose;
 275                 next;
 276             }
 277
 278             unless (process_file($file, 0, 1)) {
 279                 return 0;
 280             }
 281
 282             # Delete the file once we're done with it
 283             unless (unlink($file)) {
 284                 print STDERR "Could not remove $file.\n" if $verbose;
 285             }
 286         }
 287         return 1;
 288     } else {
 289         # Normal users only get to test their own reminders
 290         my @pwinfo = getpwuid($>);
 291         my $homedir = $pwinfo[7];
 292         my $file = "$homedir/" . $EmailReminder::Utils::USER_CONFIG_FILE;
 293
 294         if (-e $file) {
 295             return process_file($file, 0, 1);
 296         } else {
 297             print STDERR "Warning: could not find your .email-reminders file.\n";
 298             return 0;
 299         }
 300     }
 301 }
 302
 303 if ($help || $version) {
 304     print "send-reminders $EmailReminder::Utils::VERSION\n";
 305     if ($help) {
 306         print "\n";
 307         pod2usage(1);
 308     }
 309 } elsif ($preferences{"send_reminders"}) {
 310     unless (main()) {
 311         print STDERR "Could not send reminders.\n";
 312     }
 313 }