X-Git-Url: https://defaria.com/gitweb/?a=blobdiff_plain;f=bin%2FannounceEmail.pl;h=22d30d01e5a9f1897ec15fa05d1992686c02c8bc;hb=cbfba1c8c330651d563f03ba6e2b04ce48c79896;hp=07cb6db25c5c77472886103c7f83a8cf7bd0f99f;hpb=7a4807bce717fe5086ce6432a1d193bcefc596b8;p=clearscm.git diff --git a/bin/announceEmail.pl b/bin/announceEmail.pl index 07cb6db..22d30d0 100755 --- a/bin/announceEmail.pl +++ b/bin/announceEmail.pl @@ -31,23 +31,33 @@ $Date: 2019/04/04 13:40:10 $ =head1 SYNOPSIS - Usage: announceEmail.pl [-usa|ge] [-h|elp] [-v|erbose] [-de|bug] [-da|emon] + Usage: announceEmail.pl [-usa|ge] [-h|elp] [-v|erbose] [-de|bug] [-use|rname ] [-p|assword ] - [-i|map ] [-t|imeout ] + [-an|nouce] [-ap|pend] [-da|emon] [-n|name ] + [-uses|sl] [-useb|locking] Where: - -usa|ge: Print this usage - -h|elp: Detailed help - -v|erbose: Verbose mode (Default: -verbose) - -de|bug: Turn on debugging (Default: Off) - -da|emon: Run in daemon mode (Default: -daemon) - -user|name: User name to log in with (Default: $USER) - -p|assword: Password to use (Default: prompted) - -n|ame: Name of account (Default: imap) - -i|map: IMAP server to talk to (Default: defaria.com) - -uses|sl: Whether or not to use SSL to connect (Default: False) + -usa|ge Print this usage + -h|elp Detailed help + -v|erbose Verbose mode (Default: -verbose) + -de|bug Turn on debugging (Default: Off) + + -user|name User name to log in with (Default: $USER) + -p|assword Password to use (Default: prompted) + -i|map IMAP server to talk to (Default: defaria.com) + -t|imeout Timeout IMAP idle call (Sefault: 600 seconds or 10 minutes) + + -an|nounce Announce startup (Default: False) + -ap|pend Append to logfile (Default: Noappend) + -da|emon Run in daemon mode (Default: -daemon) + -n|ame Name of account (Default: imap) + -uses|sl Whether or not to use SSL to connect (Default: False) -useb|locking Whether to block on socket (Default: False) - -a-nnounce Announce startup (Default: False) + + Signals: + $SIG{USR1}: Toggles debug option + $SIG{USR2}: Reestablishes connection to IMAP server =head1 DESCRIPTION @@ -77,6 +87,8 @@ use Speak; use TimeUtils; use Utils; +local $0 = "$FindBin::Script " . join ' ', @ARGV; + my $defaultIMAPServer = 'defaria.com'; my $IMAP; my %unseen; @@ -93,35 +105,58 @@ my @greetings = ( 'I was looking in your inbox and found a message', 'Not sure you want to hear this message', 'Good news', + "What's this? A new message", ); +my $icon = '/home/andrew/.icons/Thunderbird.jpg'; +my $timeout = 5 * 1000; + my %opts = ( usage => sub { pod2usage }, help => sub { pod2usage(-verbose => 2)}, verbose => sub { set_verbose }, debug => sub { set_debug }, daemon => 1, + timeout => 600, # 10 minutes username => $ENV{USER}, password => $ENV{PASSWORD}, imap => $defaultIMAPServer, - usessl => 0, - useblocking => 0, - announce => 0, ); +sub notify($) { + my ($msg) = @_; + + my $cmd = "notify-send -i $icon -t $timeout '$msg'"; + + Execute $cmd; + + return; +} # notify + sub interrupted { if (get_debug) { - $log->msg("Turning off debugging"); + notify 'Turning off debugging'; set_debug 0; } else { - $log->msg("Turning on debugging"); + notify ('Turning on debugging'); set_debug 1; } # if return; } # interrupted +sub Connect2IMAP; + +#sub restart { +# $log->dbug("Re-establishing connection to $opts{imap} as $opts{username}"); +# +# Connect2IMAP; +# +# goto MONITORMAIL; +#} # restart + $SIG{USR1} = \&interrupted; +#$SIG{USR2} = \&restart; sub unseenMsgs() { $IMAP->select('inbox') or @@ -133,6 +168,9 @@ sub unseenMsgs() { sub Connect2IMAP() { $log->dbug("Connecting to $opts{imap} as $opts{username}"); + # Destroy any old connections + undef $IMAP; + $IMAP = Mail::IMAPTalk->new( Server => $opts{imap}, Username => $opts{username}, @@ -154,19 +192,22 @@ sub Connect2IMAP() { } # Connect2IMAP sub MonitorMail() { - MONITORMAIL: +# MONITORMAIL: + $log->dbug("Top of MonitorMail loop"); # 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); + $log->dbug("Closed and reselected 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 + $log->dbug("Cleaning out unseen"); for (keys %unseen) { if (defined $newUnseen{$_}) { if ($unseen{$_}) { @@ -177,6 +218,7 @@ sub MonitorMail() { } # if } # for + $log->dbug("Processing new unseen messages"); for (keys %newUnseen) { next if $unseen{$_}; @@ -197,6 +239,10 @@ sub MonitorMail() { # Google Talk doesn't like # $subject =~ s/\#//g; + # Remove long strings of numbers like order numbers. They are uninteresting + my $longNumber = 5; + $subject =~ s/\s+\S*\d{$longNumber,}\S*\s*//g; + # Now speak it! my $logmsg = "From $from $subject"; @@ -208,7 +254,9 @@ sub MonitorMail() { # 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. + $log->dbug("About to speak/log"); if ($hour >= 7) { + $log->dbug("Calling speak"); speak $msg, $log; $log->msg($logmsg); } else { @@ -218,38 +266,32 @@ sub MonitorMail() { $unseen{$_} = 1; } # for - # 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}"); + # Let's time things + my $startTime = time; - undef $IMAP; - - # Re-establish connection - Connect2IMAP; + # Re-establish callback + $log->dbug("Evaling idle"); + eval { $IMAP->idle(\&MonitorMail, $opts{timeout}) }; - $log->dbug("MonitorMail: Reconnected to IMAP server $opts{imap}"); + $log->err("Unable to set IMAP Idle - AS $@", 1) if $@; + $log->msg("IMAP Idle for $opts{name} timed out in " . howlong $startTime, time); - # 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'); + # 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 return + # back to main which will re-establish the connection and call us again. + unless ($IMAP->get_response_code('timeout')) { + my $errstr = $IMAP->get_last_error; - goto MONITORMAIL; + $log->dbug("$opts{name} went away - $errstr"); + } # unless - return; # To make perlcritic happy + return 0; } # MonitorMail END { # If $log is not yet defined then the exit is not unexpected if ($log) { - my $msg = "$FindBin::Script ending unexpectedly!"; + my $msg = "$FindBin::Script $opts{name} ended unexpectedly!"; speak $msg, $log; @@ -269,9 +311,11 @@ GetOptions( 'name=s', 'password=s', 'imap=s', + 'timeout=i', 'usessl', 'useblocking', 'announce!', + 'append', ) || pod2usage; unless ($opts{password}) { @@ -287,19 +331,18 @@ if ($opts{username} =~ /.*\@(.*)$/) { if ($opts{daemon}) { # Perl complains if we reference $DB::OUT only once - my $foo = $DB::OUT; - EnterDaemonMode unless defined $DB::OUT; + no warnings; + EnterDaemonMode unless defined $DB::OUT or get_debug; + use warnings; } # if $log = Logger->new( path => '/var/local/log', name => "$Logger::me.$opts{name}", timestamped => 'yes', - append => 'yes', + append => $opts{append}, ); -Connect2IMAP; - if ($opts{username} =~ /(.*)\@/) { $opts{user} = $1; } else { @@ -308,11 +351,20 @@ if ($opts{username} =~ /(.*)\@/) { my $msg = "Now monitoring email for $opts{user}\@$opts{name}"; -speak $msg, $log if $opts{announce}; +# Changed to loop here - better than using a goto. This kinda kills the idea of +# using siguser2 to interrupt announceEmail.pl to kick it into re-establishing +# the connection. +while () { + Connect2IMAP; + + speak $msg, $log if $opts{announce}; + + $log->msg($msg); -$log->msg($msg); + MonitorMail; -MonitorMail; + $log->dbug("$opts{name} timed out! Re-establishing connection"); +} # while # Should not get here $log->err("Falling off the edge of $0", 1);