X-Git-Url: https://defaria.com/gitweb/?a=blobdiff_plain;f=bin%2FannounceEmail.pl;h=94789e84d27a695ecead72c234fb7043e99c1ef8;hb=179f42431b4ab54214ba78d94cd8d3df05d603bb;hp=71c96dd5fd378a24da199f4ecc424b7dae9366d6;hpb=447c849fd507a59596617bec83358d82e4cf7736;p=clearscm.git diff --git a/bin/announceEmail.pl b/bin/announceEmail.pl index 71c96dd..94789e8 100755 --- a/bin/announceEmail.pl +++ b/bin/announceEmail.pl @@ -17,7 +17,7 @@ Andrew DeFaria =item Revision -$Revision: 1.0 $ +$Revision: 1.2 $ =item Created: @@ -29,22 +29,25 @@ $Date: 2019/04/04 13:40:10 $ =back -=hade1 SYNOPSIS +=head1 SYNOPSIS Usage: announceEmail.pl [-usa|ge] [-h|elp] [-v|erbose] [-de|bug] [-da|emon] [-use|rname ] [-p|assword ] [-i|map sub { pod2usage }, - help => sub { pod2usage(-verbose => 2)}, - verbose => sub { set_verbose }, - debug => sub { set_debug }, - daemon => 1, - username => $ENV{USER}, - password => $ENV{PASSWORD}, - imap => $defaultIMAPServer, - sleep => $defaultSleeptime, + usage => sub { pod2usage }, + help => sub { pod2usage(-verbose => 2)}, + verbose => sub { set_verbose }, + debug => sub { set_debug }, + daemon => 1, + username => $ENV{USER}, + password => $ENV{PASSWORD}, + imap => $defaultIMAPServer, + usessl => 0, + useblocking => 0, + announce => 0, ); -sub unseenMsgs() { - my %unseenMsgs; +sub interrupted { + if (get_debug) { + $log->msg("Turning off debugging"); + set_debug 0; + } else { + $log->msg("Turning on debugging"); + set_debug 1; + } # if - for (my $i = 1; $i <= $IMAP->status; $i++) { - $unseenMsgs{$i} = 0 unless $IMAP->seen($i); - } # for + return; +} # interrupted - return %unseenMsgs; -} # unseenMsgs +$SIG{USR1} = \&interrupted; -sub Connect2IMAP() { - $log->msg("Connecting to $opts{imap} as $opts{username}"); - - $IMAP = Net::IMAP::Simple->new($opts{imap}) || - error("Unable to connect to IMAP server $opts{imap}: " . $Net::IMAP::Simple::errstr, 1); +sub unseenMsgs() { + $IMAP->select('inbox') or + $log->err("Unable to select inbox: " . get_last_error(), 1); - $log->msg("Connected"); + return map { $_=> 0 } @{$IMAP->search('not', 'seen')}; +} # unseenMsgs - $log->msg("Logging onto $opts{imap} as $opts{username}"); +sub Connect2IMAP() { + $log->dbug("Connecting to $opts{imap} as $opts{username}"); - unless ($IMAP->login($opts{username}, $opts{password})) { - $log->err("Login to $opts{imap} as $opts{username} failed: " . $IMAP->errstr, 1); - } # unless + $IMAP = Mail::IMAPTalk->new( + Server => $opts{imap}, + Username => $opts{username}, + Password => $opts{password}, + UseSSL => $opts{usessl}, + UseBlocking => $opts{useblocking}, + ) or $log->err("Unable to connect to IMAP server $opts{imap}: $@", 1); - $log->msg("Logged on"); + $log->dbug("Connected to $opts{imap} as $opts{username}"); # Focus on INBOX only - $IMAP->select('INBOX'); + $IMAP->select('inbox'); # Setup %unseen to have each unseen message index set to 0 meaning not read # aloud yet %unseen = unseenMsgs; + + return; } # Connect2IMAP +sub Say($) { + my ($msg) = @_; + + my ($status, @output) = Execute "/usr/local/bin/gt \"$msg\""; + + $log->err("Unable to speak (Status: $status) - " + . join ("\n", @output), $status) if $status; + + return; +} # Say + sub MonitorMail() { - $log->msg("Monitoring email"); - - while () { - # First close and reselect the INBOX to get its current status - $IMAP->close; - $IMAP->select('INBOX'); - - # Go through all of the unseen messages and add them to %unseen if they were - # not there already from a prior run and read - my %newUnseen = unseenMsgs; - - # Now clean out any messages in %unseen that were not in the %newUnseen and - # marked as previously read - for (keys %unseen) { - if (defined $newUnseen{$_}) { - if ($unseen{$_}) { - delete $newUnseen{$_}; - } # if - } else { - delete $unseen{$_} + MONITORMAIL: + + # First close and reselect the INBOX to get its current status + $IMAP->close; + $IMAP->select('INBOX') + or $log->err("Unable to select INBOX - ". $IMAP->errstr(), 1); + + # Go through all of the unseen messages and add them to %unseen if they were + # not there already from a prior run and read + my %newUnseen = unseenMsgs; + + # Now clean out any messages in %unseen that were not in the %newUnseen and + # marked as previously read + for (keys %unseen) { + if (defined $newUnseen{$_}) { + if ($unseen{$_}) { + delete $newUnseen{$_}; } # if - } # for + } else { + delete $unseen{$_} + } # if + } # for - for (keys %newUnseen) { - next if $unseen{$_}; + for (keys %newUnseen) { + next if $unseen{$_}; - my $email = Email::Simple->new(join '', @{$IMAP->top($_)}); + my $envelope = $IMAP->fetch($_, '(envelope)'); + my $from = $envelope->{$_}{envelope}{From}; + my $subject = $envelope->{$_}{envelope}{Subject}; + $subject //= 'Unknown subject'; - my $from = $email->header('From'); + # Extract the name only when the email is of the format "name " + if ($from =~ /^"?(.*?)"?\s*\<(\S*)>/) { + $from = $1 if $1 ne ''; + } # if - # Extract the name only when the email is of the format "name " - if ($from =~ /^(.*)\<(\S*)>/) { - $from = $1 if $1 ne ''; - } # if + if ($subject =~ /=?\S+?(Q|B)\?(.+)\?=/) { + $subject = decode_base64($2); + } # if - my $subject = $email->header('Subject'); + # Google Talk doesn't like # + $subject =~ s/\#//g; - if ($subject =~ /=?\S+?(Q|B)\?(.+)\?=/) { - $subject = decode_base64($2); - } # if + # Now speak it! + my $logmsg = "From $from $subject"; - # Now speak it! - my $logmsg = "From $from $subject"; - my $msg = "Message from $from... " . quotemeta $subject; - $msg =~ s/\"/\\"/g; + my $greeting = $greetings[int rand $#greetings]; + my $msg = "$greeting from $from... $subject"; + $msg =~ s/\"/\\"/g; - if (get_verbose) { - $log->msg($logmsg); - } else { - $log->log($logmsg); - } # if + my $hour = (localtime)[2]; - my $cmd = "/usr/local/bin/gt \"$msg\""; + # Only announce if after 6 Am. Note this will announce up until + # midnight but that's ok. I want midnight to 6 Am as silent time. + if ($hour >= 6) { + Say $msg; + $log->msg($logmsg); + } else { + $log->msg("$logmsg [silent]"); + } # if - my ($status, @output) = Execute $cmd; + $unseen{$_} = 1; + } # for - if ($status) { - $log->err("Unable to execute $cmd" . join("\n", @output)); - } # if + # Re-establish callback + eval { $IMAP->idle(\&MonitorMail) }; + + # If we return from idle then the server went away for some reason. With Gmail + # the server seems to time out around 30-40 minutes. Here we simply reconnect + # to the imap server and continue to MonitorMail. + $log->dbug("MonitorMail: Connection to $opts{imap} ended. Reconnecting"); + + # Destroy current IMAP connection + $log->dbug("MonitorMail: Destorying IMAP connection to $opts{imap}"); + + undef $IMAP; + + # Re-establish connection + Connect2IMAP; + + $log->dbug("MonitorMail: Reconnected to IMAP server $opts{imap}"); + + # MonitorMail again - the dreaded goto! Seems the cleanest way to restart + # in this instance. I could call MonitorMail() recursively but that would + # leave junk on the stack. + $log->dbug('MonitorMail: Going back to the top of the loop'); - $unseen{$_} = 1; - } # for + goto MONITORMAIL; - verbose "Sleeping for $opts{sleep} minutes"; - sleep 60 * $opts{sleep}; - verbose "Ah that was refreshing!"; - } # while + return; # To make perlcritic happy } # MonitorMail END { - $IMAP->quit if $IMAP; + # If $log is not yet defined then the exit is not unexpected + if ($log) { + my $msg = "$FindBin::Script ending unexpectedly!"; + + Say $msg; + + $log->err($msg); + } # if } # END ## Main @@ -208,27 +276,53 @@ GetOptions( 'debug', 'daemon!', 'username=s', + 'name=s', 'password=s', 'imap=s', - 'sleep', -); + 'usessl', + 'useblocking', + 'announce!', +) || pod2usage; unless ($opts{password}) { verbose "I need $opts{username}'s password"; $opts{password} = GetPassword; } # unless -EnterDaemonMode if $opts{daemon}; +$opts{name} //= $opts{imap}; + +if ($opts{username} =~ /.*\@(.*)$/) { + $opts{name} = $1; +} # if + +if ($opts{daemon}) { + # Perl complains if we reference $DB::OUT only once + my $foo = $DB::OUT; + EnterDaemonMode unless defined $DB::OUT; +} # if $log = Logger->new( path => '/var/log', + name => "$Logger::me.$opts{name}", timestamped => 'yes', append => 'yes', ); Connect2IMAP; -my $cmd = "/usr/local/bin/gt \"Now monitoring email for $opts{username}\@$opts{imap}\""; -my ($status, @output) = Execute $cmd; +if ($opts{username} =~ /(.*)\@/) { + $opts{user} = $1; +} else { + $opts{user} = $opts{username}; +} # if + +my $msg = "Now monitoring email for $opts{user}\@$opts{name}"; + +Say $msg if $opts{announce}; + +$log->msg($msg); MonitorMail; + +# Should not get here +$log->err("Falling off the edge of $0", 1);