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@email-reminder.org.nz>
  55
  56 =head1 SEE ALSO
  57
  58 email-reminder-editor, collect-reminders
  59
  60 =head1 COPYRIGHT
  61
  62 Copyright (C) 2004-2009 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     print "Reading preferences from '$PREFERENCE_FILE'\n" if $verbose;
 124
 125     if (open my $config_fh, '<', $PREFERENCE_FILE) {
 126         # Stolen off of the Cookbook (section 8.16)
 127         while (<$config_fh>) {
 128             chomp;                  # no newline
 129             s/#.*//;                # no comments
 130             s/^\s+//;               # no leading white
 131             s/\s+$//;               # no trailing white
 132             next unless length;     # anything left?
 133             my ($var, $value) = split(/\s*=\s*/, $_, 2);
 134             $preferences{$var} = $value;
 135         }
 136         close $config_fh;
 137     }
 138     else {
 139         print "Warning: cannot read configuration file at $PREFERENCE_FILE.\nMake sure that the user running $0 has read permissions on that configuration file.\n";
 140         return;
 141     }
 142     return 1;
 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             eval 'use Net::SMTP::SSL';
 169             die "Couldn't load module : $!" if ($@);
 170             $smtp = Net::SMTP::SSL->new($smtp_server, Port => 465, Debug => 0);
 171         }
 172         else {
 173             use Net::SMTP;
 174             $smtp = Net::SMTP->new($smtp_server, Debug => 0);
 175         }
 176         die "Error: couldn't connect to server '$smtp_server'\n" unless $smtp;
 177
 178         # SMTP SASL authentication (if necessary)
 179         if ($preferences{"smtp_username"} and $preferences{"smtp_password"}) {
 180             unless ($smtp->auth($preferences{"smtp_username"}, $preferences{"smtp_password"})) {
 181                 die "Error: authentication with the SMTP server failed with error code ".$smtp->status."\n";
 182             }
 183         }
 184
 185         unless ($smtp->mail($preferences{"mail_from"})) {
 186             die "Error: the sending address was not accepted. Try setting the 'mail_from' variable to a valid email address in the configuration file\n";
 187         }
 188
 189         my $ok = 1;
 190         $ok = $ok && $smtp->to($to);
 191         $ok = $ok && $smtp->data();
 192         $ok = $ok && $smtp->datasend("From: Email-Reminder <" . $preferences{"mail_from"} . ">\n");
 193
 194         # Create an RFC822 compliant date (current time)
 195         my $rfc822_format = "%a, %d %b %Y %H:%M %z";
 196         my $today         = ParseDate("Now");
 197         my $rfc822_date = UnixDate($today,$rfc822_format);
 198         $ok = $ok && $smtp->datasend("Date: $rfc822_date\n");
 199
 200         $ok = $ok && $smtp->datasend("To: $to\n");
 201         $ok = $ok && $smtp->datasend("Subject: =?utf-8?B?".encode_base64(encode("UTF-8", $subject), '')."?=\n");
 202         $ok = $ok && $smtp->datasend("Mime-Version: 1.0\n");
 203         $ok = $ok && $smtp->datasend("Content-Type: text/plain; charset=utf-8\n");
 204         $ok = $ok && $smtp->datasend("Content-Disposition: inline\n");
 205         $ok = $ok && $smtp->datasend("Content-Transfer-Encoding: quoted-printable\n");
 206         $ok = $ok && $smtp->datasend("\n");
 207         $ok = $ok && $smtp->datasend(encode_qp(encode("UTF-8", $message)));
 208         $ok = $ok && $smtp->dataend();
 209
 210         $smtp->quit();
 211
 212         die "Error: could not mail the reminder out\n" unless $ok;
 213     }
 214
 215     return 1;
 216 }
 217
 218 sub send_author_wishes
 219 {
 220     my $user_name = shift;
 221     my $user_email = shift;
 222
 223     print "--> Processing event Email-Reminder Author's Birthday\n" if $verbose;
 224
 225     my $today = ParseDate('now');
 226     my $current_month = UnixDate($today, '%m');
 227     my $current_day = UnixDate($today, '%d');
 228
 229     if (1 == $current_month and 30 == $current_day) {
 230         print "--> Event Email-Reminder Author's Birthday is occurring\n" if $verbose;
 231
 232         my $recipient_name = 'Francois Marier';
 233         my $recipient_email = 'francois@email-reminder.org.nz';
 234         my $subject = 'Happy birthday from an email-reminder user';
 235         my $message = <<"MESSAGEEND";
 236 Hi Francois,
 237
 238 Happy birthday and thank you for email-reminder!
 239
 240 $user_name
 241 $user_email
 242
 243 --
 244 Sent by Email-Reminder $EmailReminder::Utils::VERSION
 245 http://www.email-reminder.org.nz/
 246 MESSAGEEND
 247
 248         if (!send_email($message, $subject, $recipient_name, $recipient_email)) {
 249             return;
 250         }
 251     }
 252
 253     return 1;
 254 }
 255
 256 sub process_file
 257 {
 258     my $file = shift;
 259
 260     print "==> Processing $file\n" if $verbose;
 261
 262     my $list = EmailReminder::EventList->new($file);
 263
 264     my @fullname = $list->get_user_name();
 265     my $user_fname = $fullname[0];
 266     my $user_lname = $fullname[1];
 267     my $user_name = $user_fname;
 268     $user_name .= " " . $user_lname if defined($user_lname);
 269     my $user_email = $list->get_user_email();
 270
 271     foreach my $event ($list->get_events()) {
 272         print '--> Processing event '.$event->get_name()."\n" if $verbose;
 273
 274         if ($event->is_occurring()) {
 275             print '--> Event '.$event->get_name()." is occurring\n" if $verbose;
 276
 277             eval {
 278                 if (!process_event($event, $user_name, $user_email)) {
 279                     return;
 280                 }
 281             };
 282             if($@) {
 283                 print '!!! Error while sending reminder for '.$event->get_name()."\n" if $verbose;
 284
 285                 my $msg = 'WARNING: Due to an error, the email reminder for Event "' . $event->get_name() .
 286                     '" cannot be processed and all I could do was to let you know that there was a problem.';
 287                 $msg .= "\n\n".'Since this event is OCCURRING TODAY, you should really check your reminders manually.';
 288                 $msg .= "\n\n".'Please report this problem to the email-reminder author so that it can be fixed in future versions:';
 289                 $msg .= "\n\n".'  Francois Marier <francois@email-reminder.org.nz>';
 290                 $msg .= "\n\n".'Thanks!';
 291                 my $subject = 'Email-reminder ERROR: ' . $event->get_name();
 292
 293                 if (!send_email($msg, $subject, $user_name, $user_email)) {
 294                     return;
 295                 }
 296             }
 297         }
 298     }
 299
 300     if ($list->get_author_wishes()) {
 301         send_author_wishes($user_name, $user_email);
 302     }
 303
 304     return 1;
 305 }
 306
 307 # Send reminders for an event which is occurring
 308 sub process_event
 309 {
 310     my $event = shift;
 311     my $user_name = shift;
 312     my $user_email = shift;
 313
 314     my $subject = $event->get_subject();
 315
 316     my @recipients = @{$event->get_recipients()};
 317     if ($#recipients > -1) {
 318         foreach my $recipient (@recipients) {
 319             my $recipient_email = shift @{$recipient};
 320             my $recipient_fname = shift @{$recipient};
 321             my $recipient_lname = shift @{$recipient};
 322
 323             my $recipient_name = $recipient_fname;
 324             $recipient_name .= " $recipient_lname" if defined($recipient_lname);
 325
 326             my $msg = $event->get_message($recipient_fname);
 327             if ($msg && !send_email($msg, $subject, $recipient_name, $recipient_email)) {
 328                 return;
 329             }
 330         }
 331     } else {
 332         my $msg = $event->get_message($user_fname);
 333         if ($msg && !send_email($msg, $subject, $user_name, $user_email)) {
 334             return;
 335         }
 336     }
 337 }
 338
 339 sub main
 340 {
 341     my $running_uid = $>;
 342     if (0 == $running_uid) {
 343         print STDERR "Warning: for security reasons, this script should not be not as root.\n";
 344     }
 345
 346     my $spool_dir = $EmailReminder::Utils::SPOOL_DIRECTORY;
 347     if (-w $spool_dir) {
 348         # Iterate through all spooled files
 349         while (defined(my $file = glob("$spool_dir/*"))) {
 350             # Untaint filename
 351             if ($file =~ /^([A-Za-z_0-9\-\/]+)$/) {
 352                 $file = $1;
 353             } else {
 354                 print STDERR "Skipped unclean filename" if $verbose;
 355                 next;
 356             }
 357
 358             unless (process_file($file, 0, 1)) {
 359                 return;
 360             }
 361
 362             # Delete the file once we're done with it
 363             unless (unlink($file)) {
 364                 print STDERR "Could not remove $file.\n" if $verbose;
 365             }
 366         }
 367         return 1;
 368     } else {
 369         # Normal users only get to test their own reminders
 370         my @pwinfo = getpwuid($>);
 371         my $homedir = $pwinfo[7];
 372         my $file = "$homedir/" . $EmailReminder::Utils::USER_CONFIG_FILE;
 373
 374         if (-e $file) {
 375             return process_file($file, 0, 1);
 376         } else {
 377             print STDERR "Warning: could not find your .email-reminders file.\n";
 378             return;
 379         }
 380     }
 381 }
 382
 383 if ($help || $version) {
 384     print "send-reminders $EmailReminder::Utils::VERSION\n";
 385     if ($help) {
 386         print "\n";
 387         pod2usage(1);
 388     }
 389 } elsif ($preferences{"send_reminders"}) {
 390     unless (main()) {
 391         print STDERR "Could not send reminders.\n";
 392     }
 393 }