From 857387036fe2cd3ff43319eca3db180e1479ba0e Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Sun, 9 Oct 2011 02:24:09 +0100 Subject: awayproxy: general tidy-up, rejig config initialisation and change some weird $foo == "1" tests. Need to check behaviour is still correct. --- fixery/awayproxy.pl | 200 +++++++++++++++++++++++++++++----------------------- 1 file changed, 112 insertions(+), 88 deletions(-) (limited to 'fixery') diff --git a/fixery/awayproxy.pl b/fixery/awayproxy.pl index 422a6ad..37fb20e 100644 --- a/fixery/awayproxy.pl +++ b/fixery/awayproxy.pl @@ -1,10 +1,4 @@ -# vim:syntax=perl -# vim:tabstop=4 -# vim:shiftwidth=4 -# vim:foldmethod=marker -# vim:foldenable -# vim:enc=utf-8 -######################################################################################################## +################################################################################ ## WARNING!! BAD ENGLISH BELOW :P ## ## This script is designed for those who have been using muh irc bouncer. @@ -15,7 +9,7 @@ ## Other hand if you dont use irssi-proxy you still have a good reason to ## use this if you want to forward messages that come to you while ## you are away to email box. -## This is usefull for forwarding messages to an SMS-gateway ;) +## This is usefull for forwarding messages to an SMS-gateway ;) ## ## btw.. if you find any bugs or have any ideas for development of this ## script dont hesitate to send msg to BCOW@IrcNET @@ -26,12 +20,12 @@ # * basic functionality # 0.2b # * a patch from Wulf that gives a user ability to change the autoaway reason. -# * Added away_level parameter that gives you ability to control how many -# clients there can be connected to the irssi_proxy module before you are +# * Added away_level parameter that gives you ability to control how many +# clients there can be connected to the irssi_proxy module before you are # set away. # * You arent set away when disconnecting from the irssi_proxy if you already # are away. This means that your current away reason isn't changed. -# * Sends cumulated away messages back to the client when it connects to the +# * Sends cumulated away messages back to the client when it connects to the # irssi_proxy module. # 0.2c # * Fixes bug where cummulated messages weren't sent. @@ -46,7 +40,7 @@ #### To come / planned / wanted: # * Make expansion system log several channels at once. # * Make this script server based. -######################################################################################################## +################################################################################ use strict; use warnings; @@ -54,67 +48,84 @@ use warnings; # irssi imports use Irssi; use Irssi::Irc; -use vars qw($VERSION %IRSSI %config); - -$VERSION = "0.2d"; -%IRSSI = ( - authors => "BCOW", - contact => "anttip\@n0-life.com", - name => "awayproxy", - description => "Sets nick away when client discconects from the " - . "irssi-proxy. If away gathers messages targeted to nick and forwards " - . "them to an email address.", - license => "GPLv2", - url => "http://www.n0-life.com", +#use vars qw($VERSION %IRSSI %config); + +our $VERSION = "0.3"; +our %IRSSI = ( + authors => "shabble,BCOW", + contact => "anttip\@n0-life.com", + name => "awayproxy", + description => "Sets nick away when client discconects from the " + . "irssi-proxy. If away gathers messages targeted to nick and forwards " + . "them to an email address.", + license => "GPLv2", + url => "http://www.n0-life.com", ); -# After how much seconds we can check if there are any messages to send? -$config{check_interval} = 45; -# this setting controls that when this amout of clients are connected to the -# proxy module script sets you away. If you set this to 0 you are set away when -# no clients are connected to the proxy module. If you set this to lets say 5 -# then you will be set away allways when the amount of clients connected to the -# proxy module is 5 or under. -$config{away_level} = 0; -# Controls expansion mode. This mode records pub msgs that come after one with -# your nick in it. you can use line counting or time counting. -# 0 - off -# line - line counting -# time - time counting -$config{expansion_mode} = 'time'; -# How many lines include after start line? -$config{expansion_lines} = 12; -# After how many seconds stop gathering msgs? -$config{expansion_timeout} = 90; -# script operation mode: -# 0 - to send messages both to email and when you get back to proxy -# 1 - only email -# 2 - only irc -# 3 - off -$config{script_mode} = 1; -# email address where to send the email -$config{emailto} = 'email@email.org'; -# sendmail location -$config{sendmail} = '/usr/sbin/sendmail'; -# who is the sender of the email -$config{emailfrom} = 'email@email.org'; -# Subject of email -$config{emailsubject} = '[irssi-proxy]'; -# and the awayreason setting (Thanx Wulf) -$config{awayreason} = 'Auto-away because client has disconnected from proxy.'; -# Debugging mode -$config{debug} = 0; +my %config = + ( + + # After how much seconds we can check if there are any messages to send? + check_interval => 45, + + # this setting controls that when this amout of clients are connected to the + # proxy module script sets you away. If you set this to 0 you are set away when + # no clients are connected to the proxy module. If you set this to lets say 5 + # then you will be set away allways when the amount of clients connected to the + # proxy module is 5 or under. + away_level => 0, + + # Controls expansion mode. This mode records pub msgs that come after one with + # your nick in it. you can use line counting or time counting. + # 0 - off + # line - line counting + # time - time counting + expansion_mode => 'time', + + # How many lines include after start line? + expansion_lines => 12, + + # After how many seconds stop gathering msgs? + expansion_timeout => 90, + + # script operation mode: + # 0 - to send messages both to email and when you get back to proxy + # 1 - only email + # 2 - only irc + # 3 - off + script_mode => 1, + + # email address where to send the email + emailto => 'email@email.org', + + # sendmail location + sendmail => '/usr/sbin/sendmail', + + # who is the sender of the email + emailfrom => 'email@email.org', + + # Subject of email + emailsubject => '[irssi-proxy]', + + # and the awayreason setting (Thanx Wulf) + awayreason => 'Auto-away because client has disconnected from proxy.', + + # Debugging mode + debug => 0, # -- Don't change anything below this line if you don't know Perl. -- # number of clients connected -$config{clientcount} = 0; +clientcount => 0, # number of lines recorded -$config{expansion_lines_count} = 0; +expansion_lines_count => 0, -$config{expansion_started} = 0; +expansion_started => 0, # the small list and archive list -$config{awaymsglist} = []; -$config{awaymsglist2} = []; +awaymsglist => [], +awaymsglist2 => [], + + +); if ( $config{script_mode} == 0 || $config{script_mode} == 1 ) { # {{{ # timeouts for check loop @@ -129,6 +140,7 @@ sub debug { # {{{ Irssi::print('From ' . $caller . ":\n" . $text); } } # }}} + sub msgsend_check { # {{{ # If there are any messages to send my $count = @{$config{awaymsglist}}; @@ -144,20 +156,28 @@ sub msgsend_check { # {{{ send_mail($text); } } # }}} + sub send_mail { # {{{ my $text = shift; debug("Sending mail"); - open MAIL, "|" . $config{sendmail} . " -t"; - print MAIL "To: $config{emailto}\n"; - print MAIL "From: $config{emailfrom}\n"; - print MAIL "Subject: $config{emailsubject}\n"; - print MAIL "$text"; - close MAIL; + + open my $mail_fh, '|', $config{sendmail} . " -t" + or warn "Failed to open pipe to sendmail"; + + return unless $mail_fh; + + print $mail_fh "To: $config{emailto}\n"; + print $mail_fh "From: $config{emailfrom}\n"; + print $mail_fh "Subject: $config{emailsubject}\n"; + print $mail_fh "\n$text\n"; + close $mail_fh; } # }}} + sub client_connect { # {{{ my (@servers) = Irssi::servers; - + $config{clientcount}++; + debug("Client connected, current script mode: $config{script_mode}"); # setback @@ -165,24 +185,25 @@ sub client_connect { # {{{ # if you're away on that server send yourself back if ($server->{usermode_away} == 1) { $server->send_raw('AWAY :'); - # and then send the current contents of archive list as notify's to + # and then send the current contents of archive list as notify's to # your self ;) # .. weird huh? :) - # This sends all the away messages to ALL the servers where you are + # This sends all the away messages to ALL the servers where you are # connected... this is somewhat weird i know - # but if someone wants to make a patch to this i would really + # but if someone wants to make a patch to this i would really # appreciate it. if ($config{script_mode} == 0 || $config{script_mode} == 2) { debug('Sending notices'); - $server->send_raw('NOTICE ' . $server->{nick} . " :$_") + $server->send_raw('NOTICE ' . $server->{nick} . " :$_") for @{$config{awaymsglist2}}; } } } # and "clear" the awaymessage list - $config{awaymsglist2} = [] + $config{awaymsglist2} = [] if $config{script_mode} == 0 || $config{script_mode} == 2; } # }}} + sub client_disconnect { # {{{ my (@servers) = Irssi::servers; debug('Client Disconnectted'); @@ -203,23 +224,24 @@ sub client_disconnect { # {{{ } } } # }}} + sub msg_pub { # {{{ my ($server, $data, $nick, $mask, $target) = @_; - + sub push_into_archive { # {{{ my ($nick, $mask, $target, $data) = @_; # simple list that is emptied on the email run - push @{$config{awaymsglist}}, "<$nick!$mask\@$target> $data" + push @{$config{awaymsglist}}, "<$nick!$mask\@$target> $data" if $config{script_mode} == 0 || $config{script_mode} == 1; # archive list that is emptied only on the client connect run - push @{$config{awaymsglist2}}, "<$nick!$mask\@$target> $data" + push @{$config{awaymsglist2}}, "<$nick!$mask\@$target> $data" if $config{script_mode} == 0 || $config{script_mode} == 2; } # }}} - + if ($config{expansion_started}) { if ($config{expansion_mode} eq 'line') { if ($config{expansion_lines_count} <= $config{expansion_lines} -1) { - if ($config{expansion_chan} eq $target) { + if ($config{expansion_chan} eq $target) { debug("In effect from line expansion, pushing on. Cnt: " . $config{expansion_lines_count}); push_into_archive($nick, $mask, $target, $data); @@ -240,7 +262,7 @@ sub msg_pub { # {{{ } } } - elsif ($server->{usermode_away} == "1" && $data =~ /$server->{nick}/i) { + elsif ($server->{usermode_away} == 1 && $data =~ /$server->{nick}/i) { debug("Got pub msg with my name"); push_into_archive($nick, $mask, $target, $data); if ($config{expansion_mode}) { @@ -253,14 +275,16 @@ sub msg_pub { # {{{ } } } # }}} + sub expansion_stop { # {{{ debug("Stopping expansion from timer"); $config{expansion_started} = 0; $config{expansion_chan} = ''; } # }}} + sub msg_pri { # {{{ my ($server, $data, $nick, $address) = @_; - if ($server->{usermode_away} == "1") { + if ($server->{usermode_away} == 1) { debug("Got priv msg"); # simple list that is emptied on the email run push @{$config{awaymsglist}}, "<$nick!$address> $data" @@ -271,7 +295,7 @@ sub msg_pri { # {{{ } } # }}} -Irssi::signal_add_last('proxy client connected', 'client_connect'); -Irssi::signal_add_last('proxy client disconnected', 'client_disconnect'); -Irssi::signal_add_last('message public', 'msg_pub'); -Irssi::signal_add_last('message private', 'msg_pri'); +Irssi::signal_add_last('proxy client connected', \&client_connect); +Irssi::signal_add_last('proxy client disconnected', \&client_disconnect); +Irssi::signal_add_last('message public', \&msg_pub); +Irssi::signal_add_last('message private', \&msg_pri); -- cgit v1.2.3