collect-reminders

   1 #!/usr/bin/perl -T
   2
   3 =head1 NAME
   4
   5 collect-reminders - collect email reminders to be sent out
   6
   7 =head1 SYNOPSIS
   8
   9 Collect emails reminders set by users for special occasions and move
  10 them to the email-reminder spool directory.
  11
  12 =head1 DESCRIPTION
  13
  14 Email-reminder allows users to define events that they want to be
  15 reminded of by email.
  16
  17 This script is meant to be invoked everyday by a cron job or as the
  18 root user.  It collects the reminder files from each user.
  19
  20 =head1 OPTIONS
  21
  22 =over 6
  23
  24 =item B<--help>
  25
  26 Displays basic usage message.
  27
  28 =item B<--verbose>
  29
  30 Prints out information about what the program is doing, including the
  31 full emails being sent out.
  32
  33 =item B<--version>
  34
  35 Displays the version number.
  36
  37 =back
  38
  39 =head1 FILES
  40
  41 F<~/.email-reminders>, F</etc/email-reminder.conf>
  42
  43 =head1 AUTHOR
  44
  45 Francois Marier <francois@fmarier.org>
  46
  47 =head1 SEE ALSO
  48
  49 email-reminder-editor, send-reminders
  50
  51 =head1 COPYRIGHT
  52
  53 Copyright (C) 2004-2010 by Francois Marier
  54
  55 Email-Reminder is free software; you can redistribute it and/or
  56 modify it under the terms of the GNU General Public License as
  57 published by the Free Software Foundation; either version 3 of the
  58 License, or (at your option) any later version.
  59
  60 Email-Reminder is distributed in the hope that it will be useful,
  61 but WITHOUT ANY WARRANTY; without even the implied warranty of
  62 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  63 General Public License for more details.
  64
  65 You should have received a copy of the GNU General Public License
  66 along with Email-Reminder; if not, write to the Free Software
  67 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  68 02110-1301, USA.
  69
  70 =cut
  71
  72 use strict;
  73 use warnings;
  74
  75 use File::Copy;
  76 use Getopt::Long;
  77 use Pod::Usage;
  78
  79 use EmailReminder::Utils;
  80
  81 # Command-line parameters
  82 my $verbose  = 0;
  83 my $simulate = 0;
  84 my $version  = 0;
  85 my $help  = 0;
  86 GetOptions( "verbose"  => \$verbose,
  87             "version"  => \$version,
  88             "help"     => \$help,
  89     );
  90
  91 sub copy_reminders
  92 {
  93     my $uid = shift;
  94     my $homedir = shift;
  95
  96     my $file = "$homedir/" . $EmailReminder::Utils::USER_CONFIG_FILE;
  97     if (-e $file) {
  98         my $destination = $EmailReminder::Utils::SPOOL_DIRECTORY . '/' . $uid;
  99         print "==> Copying $file to $destination\n" if $verbose;
 100
 101         # Delete existing file for the user if necessary
 102         if (-e $destination) {
 103             if (unlink($destination)) {
 104                 print "A file for uid $uid was already present and has been removed.\n" if $verbose;
 105             } else {
 106                 die "Could not remove $destination\n";
 107             }
 108         }
 109
 110         # Copy the file to the spool directory
 111         unless (copy($file, $destination)) {
 112             die "Could not copy $file\n";
 113         }
 114
 115         return 1;
 116     }
 117     else {
 118         print "No reminders in '$homedir'.\n" if $verbose;
 119     }
 120
 121     return 0;
 122 }
 123
 124 sub main
 125 {
 126     my $running_uid = $>;
 127     if ($running_uid != 0) {
 128         die "This script must be run as root\n";
 129     }
 130
 131     # Iterate through all local users
 132     while (my (undef, undef, $uid, undef, undef, undef, undef,
 133                $homedir, $shell, undef) = getpwent) {
 134
 135         # Untaint uid
 136         if ($uid =~ /^([0-9]+)$/i) {
 137             $uid = $1;
 138         } else {
 139             die "Error: got a non-numeric uid\n";
 140         }
 141
 142         # Try to skip non-human users
 143         if (($uid < 1000) || ($uid >= 60000) || ($shell eq '/bin/false')) {
 144             print "Skipped non-human uid $uid\n" if $verbose;
 145             next;
 146         }
 147
 148         # Untaint homedir
 149         if ($homedir =~ /^([A-Za-z0-9_\-\/.]+)$/) {
 150             $homedir = $1;
 151         } else {
 152             die "Error: home directory for uid $uid contains invalid characters\n";
 153         }
 154
 155         copy_reminders($uid, $homedir);
 156     }
 157     return 1;
 158 }
 159
 160 if ($help || $version) {
 161     print "collect-reminders $EmailReminder::Utils::VERSION\n";
 162     if ($help) {
 163         print "\n";
 164         pod2usage(1);
 165     } else {
 166         exit(1);
 167     }
 168 } else {
 169     main();
 170 }