scripts/trigger.pl
# trigger.pl - execute a command or replace text, triggered by an event in irssi
# Do /TRIGGER HELP or look at http://wouter.coekaerts.be/irssi/ for help
# Copyright (C) 2002-2006 Wouter Coekaerts <wouter@coekaerts.be>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
use strict;
use Irssi 20020324 qw(command_bind command_runsub command signal_add_first signal_continue signal_stop signal_remove);
use Text::ParseWords;
use IO::File;
use vars qw($VERSION %IRSSI);
$VERSION = '1.0';
%IRSSI = (
authors => 'Wouter Coekaerts',
contact => 'wouter@coekaerts.be',
name => 'trigger',
description => 'execute a command or replace text, triggered by an event in irssi',
license => 'GPLv2 or later',
url => 'http://wouter.coekaerts.be/irssi/',
changed => '$LastChangedDate: 2006-01-23 13:10:19 +0100 (Mon, 23 Jan 2006) $',
);
sub cmd_help {
Irssi::print (<<'SCRIPTHELP_EOF', MSGLEVEL_CLIENTCRAP);
TRIGGER LIST
TRIGGER SAVE
TRIGGER RELOAD
TRIGGER MOVE <number> <number>
TRIGGER DELETE <number>
TRIGGER CHANGE <number> ...
TRIGGER ADD ...
When to match:
On which types of event to trigger:
These are simply specified by -name_of_the_type
The normal IRC event types are:
publics, %|privmsgs, pubactions, privactions, pubnotices, privnotices, joins, parts, quits, kicks, topics, invites, nick_changes, dcc_msgs, dcc_actions, dcc_ctcps
mode_channel: %|a mode on the (whole) channel (like +t, +i, +b)
mode_nick: %|a mode on someone in the channel (like +o, +v)
-all is an alias for all of those.
Additionally, there is:
rawin: %|raw text incoming from the server
send_command: %|commands you give to irssi
send_text: %|lines you type that aren't commands
beep: %|when irssi beeps
notify_join: %|someone in you notify list comes online
notify_part: %|someone in your notify list goes offline
notify_away: %|someone in your notify list goes away
notify_unaway: %|someone in your notify list goes unaway
notify_unidle: %|someone in your notify list stops idling
Filters (conditions) the event has to satisfy. They all take one parameter.
If you can give a list, seperate elements by space and use quotes around the list.
-pattern: %|The message must match the given pattern. ? and * can be used as wildcards
-regexp: %|The message must match the given regexp. (see man perlre)
%|if -nocase is given as an option, the regexp or pattern is matched case insensitive
-tags: %|The servertag must be in the given list of tags
-channels: %|The event must be in one of the given list of channels.
Examples: %|-channels '#chan1 #chan2' or -channels 'IRCNet/#channel'
%|-channels 'EFNet/' means every channel on EFNet and is the same as -tags 'EFNet'
-masks: %|The person who triggers it must match one of the given list of masks
-hasmode: %|The person who triggers it must have the give mode
Examples: %|'-o' means not opped, '+ov' means opped OR voiced, '-o&-v' means not opped AND not voiced
-hasflag: %|Only trigger if if friends.pl (friends_shasta.pl) or people.pl is loaded and the person who triggers it has the given flag in the script (same syntax as -hasmode)
-other_masks
-other_hasmode
-other_hasflag: %|Same as above but for the victim for kicks or mode_nick.
What to do when it matches:
-command: Execute the given Irssi-command
%|You are able to use $1, $2 and so on generated by your regexp pattern.
%|For multiple commands ; (or $;) can be used as seperator
%|The following variables are also expanded:
$T: %|Server tag
$C: %|Channel name
$N: %|Nickname of the person who triggered this command
$A: %|His address (foo@bar.com),
$I: %|His ident (foo)
$H: %|His hostname (bar.com)
$M: %|The complete message
${other}: %|The victim for kicks or mode_nick
${mode_type}: %|The type ('+' or '-') for a mode_channel or mode_nick
${mode_char}: %|The mode char ('o' for ops, 'b' for ban,...)
${mode_arg} : %|The argument to the mode (if there is one)
%|$\X, with X being one of the above expands (e.g. $\M), escapes all non-alphanumeric characters, so it can be used with /eval or /exec. Don't use /eval or /exec without this, it's not safe.
-replace: %|replaces the matching part with the given replacement in the event (requires a -regexp or -pattern)
-once: %|remove the trigger if it is triggered, so it only executes once and then is forgotten.
-stop: %|stops the signal. It won't get displayed by Irssi. Like /IGNORE
-debug: %|print some debugging info
Other options:
-disabled: %|Same as removing it, but keeps it in case you might need it later
-name: %|Give the trigger a name. You can refer to the trigger with this name in add/del/change commands
Examples:
Knockout people who do a !list:
/TRIGGER ADD %|-publics -channels "#channel1 #channel2" -nocase -regexp ^!list -command "KN $N This is not a warez channel!"
React to !echo commands from people who are +o in your friends-script:
/TRIGGER ADD %|-publics -regexp '^!echo (.*)' -hasflag '+o' -command 'say echo: $1'
Ignore all non-ops on #channel:
/TRIGGER ADD %|-publics -actions -channels "#channel" -hasmode '-o' -stop
Send a mail to yourself every time a topic is changed:
/TRIGGER ADD %|-topics -command 'exec echo $\N changed topic of $\C to: $\M | mail you@somewhere.com -s topic'
Examples with -replace:
%|Replace every occurence of shit with sh*t, case insensitive:
/TRIGGER ADD %|-all -nocase -regexp shit -replace sh*t
%|Strip all colorcodes from *!lamer@*:
/TRIGGER ADD %|-all -masks *!lamer@* -regexp '\x03\d?\d?(,\d\d?)?|\x02|\x1f|\x16|\x06' -replace ''
%|Never let *!bot1@foo.bar or *!bot2@foo.bar hilight you
%|(this works by cutting your nick in 2 different parts, 'myn' and 'ick' here)
%|you don't need to understand the -replace argument, just trust that it works if the 2 parts separately don't hilight:
/TRIGGER ADD %|-all masks '*!bot1@foo.bar *!bot2@foo.bar' -regexp '(myn)(ick)' -nocase -replace '$1\x02\x02$2'
%|Avoid being hilighted by !top10 in eggdrops with stats.mod (but show your nick in bold):
/TRIGGER ADD %|-publics -regexp '(Top.0\(.*\): 1.*)(my)(nick)' -replace '$1\x02$2\x02\x02$3\x02'
%|Convert a Windows-1252 Euro to an ISO-8859-15 Euro (same effect as euro.pl):
/TRIGGER ADD %|-regexp '\x80' -replace '\xA4'
%|Show tabs as spaces, not the inverted I (same effect as tab_stop.pl):
/TRIGGER ADD %|-all -regexp '\t' -replace ' '
SCRIPTHELP_EOF
} # /
my @triggers; # array of all triggers
my %triggers_by_type; # hash mapping types on triggers of that type
my $recursion_depth = 0;
my $changed_since_last_save = 0;
###############
### formats ###
###############
Irssi::theme_register([
'trigger_header' => 'Triggers:',
'trigger_line' => '%#$[-4]0 $1',
'trigger_added' => 'Trigger $0 added: $1',
'trigger_not_found' => 'Trigger {hilight $0} not found',
'trigger_saved' => 'Triggers saved to $0',
'trigger_loaded' => 'Triggers loaded from $0'
]);
#########################################
### catch the signals & do your thing ###
#########################################
# trigger types with a message and a channel
my @allchanmsg_types = qw(publics pubactions pubnotices pubctcps pubctcpreplies parts quits kicks topics);
# trigger types with a message
my @allmsg_types = (@allchanmsg_types, qw(privmsgs privactions privnotices privctcps privctcpreplies dcc_msgs dcc_actions dcc_ctcps));
# trigger types with a channel
my @allchan_types = (@allchanmsg_types, qw(mode_channel mode_nick joins invites));
# trigger types in -all
my @all_types = (@allmsg_types, qw(mode_channel mode_nick joins invites nick_changes));
# trigger types with a server
my @all_server_types = (@all_types, qw(rawin notify_join notify_part notify_away notify_unaway notify_unidle));
# all trigger types
my @trigger_types = (@all_server_types, qw(send_command send_text beep));
#trigger types that are not in -all
#my @notall_types = grep {my $a=$_; return (!grep {$_ eq $a} @all_types);} @trigger_types;
my @notall_types = qw(rawin notify_join notify_part notify_away notify_unaway notify_unidle send_command send_text beep);
my @signals = (
# "message public", SERVER_REC, char *msg, char *nick, char *address, char *target
{
'types' => ['publics'],
'signal' => 'message public',
'sub' => sub {check_signal_message(\@_,1,$_[0],$_[4],$_[2],$_[3],'publics');},
},
# "message private", SERVER_REC, char *msg, char *nick, char *address
{
'types' => ['privmsgs'],
'signal' => 'message private',
'sub' => sub {check_signal_message(\@_,1,$_[0],undef,$_[2],$_[3],'privmsgs');},
},
# "message irc action", SERVER_REC, char *msg, char *nick, char *address, char *target
{
'types' => ['privactions','pubactions'],
'signal' => 'message irc action',
'sub' => sub {
if ($_[4] eq $_[0]->{nick}) {
check_signal_message(\@_,1,$_[0],undef,$_[2],$_[3],'privactions');
} else {
check_signal_message(\@_,1,$_[0],$_[4],$_[2],$_[3],'pubactions');
}
},
},
# "message irc notice", SERVER_REC, char *msg, char *nick, char *address, char *target
{
'types' => ['privnotices','pubnotices'],
'signal' => 'message irc notice',
'sub' => sub {
if ($_[4] eq $_[0]->{nick}) {
check_signal_message(\@_,1,$_[0],undef,$_[2],$_[3],'privnotices');
} else {
check_signal_message(\@_,1,$_[0],$_[4],$_[2],$_[3],'pubnotices');
}
}
},
# "message join", SERVER_REC, char *channel, char *nick, char *address
{
'types' => ['joins'],
'signal' => 'message join',
'sub' => sub {check_signal_message(\@_,-1,$_[0],$_[1],$_[2],$_[3],'joins');}
},
# "message part", SERVER_REC, char *channel, char *nick, char *address, char *reason
{
'types' => ['parts'],
'signal' => 'message part',
'sub' => sub {check_signal_message(\@_,4,$_[0],$_[1],$_[2],$_[3],'parts');}
},
# "message quit", SERVER_REC, char *nick, char *address, char *reason
{
'types' => ['quits'],
'signal' => 'message quit',
'sub' => sub {check_signal_message(\@_,3,$_[0],undef,$_[1],$_[2],'quits');}
},
# "message kick", SERVER_REC, char *channel, char *nick, char *kicker, char *address, char *reason
{
'types' => ['kicks'],
'signal' => 'message kick',
'sub' => sub {check_signal_message(\@_,5,$_[0],$_[1],$_[3],$_[4],'kicks',{'other'=>$_[2]});}
},
# "message topic", SERVER_REC, char *channel, char *topic, char *nick, char *address
{
'types' => ['topics'],
'signal' => 'message topic',
'sub' => sub {check_signal_message(\@_,2,$_[0],$_[1],$_[3],$_[4],'topics');}
},
# "message invite", SERVER_REC, char *channel, char *nick, char *address
{
'types' => ['invites'],
'signal' => 'message invite',
'sub' => sub {check_signal_message(\@_,-1,$_[0],$_[1],$_[2],$_[3],'invites');}
},
# "message nick", SERVER_REC, char *newnick, char *oldnick, char *address
{
'types' => ['nick_changes'],
'signal' => 'message nick',
'sub' => sub {check_signal_message(\@_,-1,$_[0],undef,$_[1],$_[3],'nick_changes');}
},
# "message dcc", DCC_REC *dcc, char *msg
{
'types' => ['dcc_msgs'],
'signal' => 'message dcc',
'sub' => sub {check_signal_message(\@_,1,$_[0]->{'server'},undef,$_[0]->{'nick'},undef,'dcc_msgs');
}
},
# "message dcc action", DCC_REC *dcc, char *msg
{
'types' => ['dcc_actions'],
'signal' => 'message dcc action',
'sub' => sub {check_signal_message(\@_,1,$_[0]->{'server'},undef,$_[0]->{'nick'},undef,'dcc_actions');}
},
# "message dcc ctcp", DCC_REC *dcc, char *cmd, char *data
{
'types' => ['dcc_ctcps'],
'signal' => 'message dcc ctcp',
'sub' => sub {check_signal_message(\@_,1,$_[0]->{'server'},undef,$_[0]->{'nick'},undef,'dcc_ctcps');}
},
# "server incoming", SERVER_REC, char *data
{
'types' => ['rawin'],
'signal' => 'server incoming',
'sub' => sub {check_signal_message(\@_,1,$_[0],undef,undef,undef,'rawin');}
},
# "send command", char *args, SERVER_REC, WI_ITEM_REC
{
'types' => ['send_command'],
'signal' => 'send command',
'sub' => sub {
sig_send_text_or_command(\@_,1);
}
},
# "send text", char *line, SERVER_REC, WI_ITEM_REC
{
'types' => ['send_text'],
'signal' => 'send text',
'sub' => sub {
sig_send_text_or_command(\@_,0);
}
},
# "beep"
{
'types' => ['beep'],
'signal' => 'beep',
'sub' => sub {check_signal_message(\@_,-1,undef,undef,undef,undef,'beep');}
},
# "event "<cmd>, SERVER_REC, char *args, char *sender_nick, char *sender_address
{
'types' => ['mode_channel', 'mode_nick'],
'signal' => 'event mode',
'sub' => sub {
my ($server, $event_args, $nickname, $address) = @_;
my ($target, $modes, $modeargs) = split(/ /, $event_args, 3);
return if (!$server->ischannel($target));
my (@modeargs) = split(/ /,$modeargs);
my ($pos, $type, $event_type, $arg) = (0, '+');
foreach my $char (split(//,$modes)) {
if ($char eq "+" || $char eq "-") {
$type = $char;
} else {
if ($char =~ /[Oovh]/) { # mode_nick
$event_type = 'mode_nick';
$arg = $modeargs[$pos++];
} elsif ($char =~ /[beIqdk]/ || ( $char =~ /[lfJ]/ && $type eq '+')) { # chan_mode with arg
$event_type = 'mode_channel';
$arg = $modeargs[$pos++];
} else { # chan_mode without arg
$event_type = 'mode_channel';
$arg = undef;
}
check_signal_message(\@_,-1,$server,$target,$nickname,$address,$event_type,{
'mode_type' => $type,
'mode_char' => $char,
'mode_arg' => $arg,
'other' => ($event_type eq 'mode_nick') ? $arg : undef
});
}
}
}
},
# "notifylist joined", SERVER_REC, char *nick, char *user, char *host, char *realname, char *awaymsg
{
'types' => ['notify_join'],
'signal' => 'notifylist joined',
'sub' => sub {check_signal_message(\@_, 5, $_[0], undef, $_[1], $_[2].'@'.$_[3], 'notify_join', {'realname' => $_[4]});}
},
{
'types' => ['notify_part'],
'signal' => 'notifylist left',
'sub' => sub {check_signal_message(\@_, 5, $_[0], undef, $_[1], $_[2].'@'.$_[3], 'notify_left', {'realname' => $_[4]});}
},
{
'types' => ['notify_unidle'],
'signal' => 'notifylist unidle',
'sub' => sub {check_signal_message(\@_, 5, $_[0], undef, $_[1], $_[2].'@'.$_[3], 'notify_unidle', {'realname' => $_[4]});}
},
{
'types' => ['notify_away', 'notify_unaway'],
'signal' => 'notifylist away changed',
'sub' => sub {check_signal_message(\@_, 5, $_[0], undef, $_[1], $_[2].'@'.$_[3], ($_[5] ? 'notify_away' : 'notify_unaway'), {'realname' => $_[4]});}
},
# "ctcp msg", SERVER_REC, char *args, char *nick, char *addr, char *target
{
'types' => ['pubctcps', 'privctcps'],
'signal' => 'ctcp msg',
'sub' => sub {
my ($server, $args, $nick, $addr, $target) = @_;
if ($target eq $server->{'nick'}) {
check_signal_message(\@_, 1, $server, undef, $nick, $addr, 'privctcps');
} else {
check_signal_message(\@_, 1, $server, $target, $nick, $addr, 'pubctcps');
}
}
},
# "ctcp reply", SERVER_REC, char *args, char *nick, char *addr, char *target
{
'types' => ['pubctcpreplies', 'privctcpreplies'],
'signal' => 'ctcp reply',
'sub' => sub {
my ($server, $args, $nick, $addr, $target) = @_;
if ($target eq $server->{'nick'}) {
check_signal_message(\@_, 1, $server, undef, $nick, $addr, 'privctcps');
} else {
check_signal_message(\@_, 1, $server, $target, $nick, $addr, 'pubctcps');
}
}
}
);
sub sig_send_text_or_command {
my ($signal, $iscommand) = @_;
my ($line, $server, $item) = @$signal;
my ($channelname,$nickname,$address) = (undef,undef,undef);
if ($item && (ref($item) eq 'Irssi::Irc::Channel' || ref($item) eq 'Irssi::Silc::Channel')) {
$channelname = $item->{'name'};
} elsif ($item && ref($item) eq 'Irssi::Irc::Query') { # TODO Silc query ?
$nickname = $item->{'name'};
$address = $item->{'address'}
}
# TODO pass context also for non-channels (queries and other stuff)
check_signal_message($signal,0,$server,$channelname,$nickname,$address,$iscommand ? 'send_command' : 'send_text');
}
my %filters = (
'tags' => {
'types' => \@all_server_types,
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
if (!defined($server)) {
return 0;
}
my $matches = 0;
foreach my $tag (split(/ /,$param)) {
if (lc($server->{'tag'}) eq lc($tag)) {
$matches = 1;
last;
}
}
return $matches;
}
},
'channels' => {
'types' => \@allchan_types,
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
if (!defined($channelname) || !defined($server)) {
return 0;
}
my $matches = 0;
foreach my $trigger_channel (split(/ /,$param)) {
if (lc($channelname) eq lc($trigger_channel)
|| lc($server->{'tag'}.'/'.$channelname) eq lc($trigger_channel)
|| lc($server->{'tag'}.'/') eq lc($trigger_channel)) {
$matches = 1;
last; # this channel matches, stop checking channels
}
}
return $matches;
}
},
'masks' => {
'types' => \@all_types,
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return (defined($nickname) && defined($address) && defined($server) && $server->masks_match($param, $nickname, $address));
}
},
'other_masks' => {
'types' => ['kicks', 'mode_nick'],
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return 0 unless defined($extra->{'other'});
my $other_address = get_address($extra->{'other'}, $server, $channelname);
return defined($other_address) && $server->masks_match($param, $extra->{'other'}, $other_address);
}
},
'hasmode' => {
'types' => \@all_types,
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return hasmode($param, $nickname, $server, $channelname);
}
},
'other_hasmode' => {
'types' => ['kicks', 'mode_nick'],
'sub' => sub {
my ($param,$signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return defined($extra->{'other'}) && hasmode($param, $extra->{'other'}, $server, $channelname);
}
},
'hasflag' => {
'types' => \@all_types,
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return 0 unless defined($nickname) && defined($address) && defined($server);
my $flags = get_flags ($server->{'chatnet'},$channelname,$nickname,$address);
return defined($flags) && check_modes($flags,$param);
}
},
'other_hasflag' => {
'types' => ['kicks', 'mode_nick'],
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return 0 unless defined($extra->{'other'});
my $other_address = get_address($extra->{'other'}, $server, $channelname);
return 0 unless defined($other_address);
my $flags = get_flags ($server->{'chatnet'},$channelname,$extra->{'other'},$other_address);
return defined($flags) && check_modes($flags,$param);
}
},
'mode_type' => {
'types' => ['mode_channel', 'mode_nick'],
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return (($param) eq $extra->{'mode_type'});
}
},
'mode_char' => {
'types' => ['mode_channel', 'mode_nick'],
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return (($param) eq $extra->{'mode_char'});
}
},
'mode_arg' => {
'types' => ['mode_channel', 'mode_nick'],
'sub' => sub {
my ($param, $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra) = @_;
return (($param) eq $extra->{'mode_arg'});
}
}
);
sub get_address {
my ($nick, $server, $channel) = @_;
my $nickrec = get_nickrec($nick, $server, $channel);
return $nickrec ? $nickrec->{'host'} : undef;
}
sub get_nickrec {
my ($nick, $server, $channel) = @_;
return unless defined($server) && defined($channel) && defined($nick);
my $chanrec = $server->channel_find($channel);
return $chanrec ? $chanrec->nick_find($nick) : undef;
}
sub hasmode {
my ($param, $nickname, $server, $channelname) = @_;
my $nickrec = get_nickrec($nickname, $server, $channelname);
return 0 unless defined $nickrec;
my $modes =
($nickrec->{'op'} ? 'o' : '')
. ($nickrec->{'voice'} ? 'v' : '')
. ($nickrec->{'halfop'} ? 'h' : '')
;
return check_modes($modes, $param);
}
# list of all switches
my @trigger_switches = (@trigger_types, qw(all nocase stop once debug disabled));
# parameters (with an argument)
my @trigger_params = qw(pattern regexp command replace name);
# list of all options (including switches) for /TRIGGER ADD
my @trigger_add_options = (@trigger_switches, @trigger_params, keys(%filters));
# same for /TRIGGER CHANGE, this includes the -no<option>'s
my @trigger_options = map(($_,'no'.$_) ,@trigger_add_options);
# check the triggers on $signal's $parammessage parameter, for triggers with $condition set
# on $server in $channelname, for $nickname!$address
# set $parammessage to -1 if the signal doesn't have a message
# for signal without channel, nick or address, set to undef
sub check_signal_message {
my ($signal, $parammessage, $server, $channelname, $nickname, $address, $condition, $extra) = @_;
my ($changed, $stopped, $context, $need_rebuild);
my $message = ($parammessage == -1) ? '' : $signal->[$parammessage];
return if (!$triggers_by_type{$condition});
if ($recursion_depth > 10) {
Irssi::print("Trigger error: Maximum recursion depth reached, aborting trigger.", MSGLEVEL_CLIENTERROR);
return;
}
$recursion_depth++;
TRIGGER:
foreach my $trigger (@{$triggers_by_type{$condition}}) {
# check filters
foreach my $trigfilter (@{$trigger->{'filters'}}) {
if (! ($trigfilter->[2]($trigfilter->[1], $signal,$parammessage,$server,$channelname,$nickname,$address,$condition,$extra))) {
next TRIGGER;
}
}
# check regexp (and keep matches in @- and @+, so don't make a this a {block})
next if ($trigger->{'compregexp'} && ($parammessage == -1 || $message !~ m/$trigger->{'compregexp'}/));
# if we got this far, it fully matched, and we need to do the replace/command/stop/once
my $expands = $extra;
$expands->{'M'} = $message,;
$expands->{'T'} = (defined($server)) ? $server->{'tag'} : '';
$expands->{'C'} = $channelname;
$expands->{'N'} = $nickname;
$expands->{'A'} = $address;
$expands->{'I'} = ((!defined($address)) ? '' : substr($address,0,index($address,'@')));
$expands->{'H'} = ((!defined($address)) ? '' : substr($address,index($address,'@')+1));
$expands->{'$'} = '$';
$expands->{';'} = ';';
if (defined($trigger->{'replace'})) { # it's a -replace
$message =~ s/$trigger->{'compregexp'}/do_expands($trigger->{'compreplace'},$expands,$message)/ge;
$changed = 1;
}
if ($trigger->{'command'}) { # it's a (nonempty) -command
my $command = $trigger->{'command'};
# $1 = the stuff behind the $ we want to expand: a number, or a character from %expands
$command = do_expands($command, $expands, $message);
if (defined($server)) {
if (defined($channelname) && $server->channel_find($channelname)) {
$context = $server->channel_find($channelname);
} else {
$context = $server;
}
} else {
$context = undef;
}
if (defined($context)) {
$context->command("eval $command");
} else {
Irssi::command("eval $command");
}
}
if ($trigger->{'debug'}) {
print("DEBUG: trigger $condition pmesg=$parammessage message=$message server=$server->{tag} channel=$channelname nick=$nickname address=$address " . join(' ',map {$_ . '=' . $extra->{$_}} keys(%$extra)));
}
if ($trigger->{'stop'}) {
$stopped = 1;
}
if ($trigger->{'once'}) {
# find this trigger in the real trigger list, and remove it
for (my $realindex=0; $realindex < scalar(@triggers); $realindex++) {
if ($triggers[$realindex] == $trigger) {
splice (@triggers,$realindex,1);
last;
}
}
$need_rebuild = 1;
}
}
if ($need_rebuild) {
rebuild();
$changed_since_last_save = 1;
}
if ($stopped) { # stopped with -stop
signal_stop();
} elsif ($changed) { # changed with -replace
$signal->[$parammessage] = $message;
signal_continue(@$signal);
}
$recursion_depth--;
}
# used in check_signal_message to expand $'s
# $inthis is a string that can contain $ stuff (like 'foo$1bar$N')
sub do_expands {
my ($inthis, $expands, $from) = @_;
# @+ and @- are copied because there are two s/// nested, and the inner needs the $1 and $2,... of the outer one
my @plus = @+;
my @min = @-;
my $p = \@plus; my $m = \@min;
$inthis =~ s/\$(\\*(\d+|[^0-9x{]|x[0-9a-fA-F][0-9a-fA-F]|{.*?}))/expand_and_escape($1,$expands,$m,$p,$from)/ge;
return $inthis;
}
# \ $ and ; need extra escaping because we use eval
sub expand_and_escape {
my $retval = expand(@_);
$retval =~ s/([\\\$;])/\\\1/g;
return $retval;
}
# used in do_expands (via expand_and_escape), to_expand is the part after the $
sub expand {
my ($to_expand, $expands, $min, $plus, $from) = @_;
if ($to_expand =~ /^\d+$/) { # a number => look up in $vars
# from man perlvar:
# $3 is the same as "substr $var, $-[3], $+[3] - $-[3])"
return ($to_expand > @{$min} ? '' : substr($from,$min->[$to_expand],$plus->[$to_expand]-$min->[$to_expand]));
} elsif ($to_expand =~ s/^\\//) { # begins with \, so strip that from to_expand
my $exp = expand($to_expand,$expands,$min,$plus,$from); # first expand without \
$exp =~ s/([^a-zA-Z0-9])/\\\1/g; # escape non-word chars
return $exp;
} elsif ($to_expand =~ /^x([0-9a-fA-F]{2})/) { # $xAA
return chr(hex($1));
} elsif ($to_expand =~ /^{(.*?)}$/) { # ${foo}
return expand($1, $expands, $min, $plus, $from);
} else { # look up in $expands
return $expands->{$to_expand};
}
}
sub check_modes {
my ($has_modes, $need_modes) = @_;
my $matches;
my $switch = 1; # if a '-' if found, will be 0 (meaning the modes should not be set)
foreach my $need_mode (split /&/, $need_modes) {
$matches = 0;
foreach my $char (split //, $need_mode) {
if ($char eq '-') {
$switch = 0;
} elsif ($char eq '+') {
$switch = 1;
} elsif ((index($has_modes, $char) != -1) == $switch) {
$matches = 1;
last;
}
}
if (!$matches) {
return 0;
}
}
return 1;
}
# get someones flags from people.pl or friends(_shasta).pl
sub get_flags {
my ($chatnet, $channel, $nick, $address) = @_;
my $flags;
no strict 'refs';
if (defined %{ 'Irssi::Script::people::' }) {
if (defined ($channel)) {
$flags = (&{ 'Irssi::Script::people::find_local_flags' }($chatnet,$channel,$nick,$address));
} else {
$flags = (&{ 'Irssi::Script::people::find_global_flags' }($chatnet,$nick,$address));
}
$flags = join('',keys(%{$flags}));
} else {
my $shasta;
if (defined %{ 'Irssi::Script::friends_shasta::' }) {
$shasta = 'friends_shasta';
} elsif (defined &{ 'Irssi::Script::friends::get_idx' }) {
$shasta = 'friends';
} else {
return undef;
}
my $idx = (&{ 'Irssi::Script::'.$shasta.'::get_idx' }($nick, $address));
if ($idx == -1) {
return '';
}
$flags = (&{ 'Irssi::Script::'.$shasta.'::get_friends_flags' }($idx,undef));
if ($channel) {
$flags .= (&{ 'Irssi::Script::'.$shasta.'::get_friends_flags' }($idx,$channel));
}
}
return $flags;
}
########################################################
### internal stuff called by manage, needed by above ###
########################################################
my %mask_to_regexp = ();
foreach my $i (0..255) {
my $ch = chr $i;
$mask_to_regexp{$ch} = "\Q$ch\E";
}
$mask_to_regexp{'?'} = '(.)';
$mask_to_regexp{'*'} = '(.*)';
sub compile_trigger {
my ($trigger) = @_;
my $regexp;
if ($trigger->{'regexp'}) {
$regexp = $trigger->{'regexp'};
} elsif ($trigger->{'pattern'}) {
$regexp = $trigger->{'pattern'};
$regexp =~ s/(.)/$mask_to_regexp{$1}/g;
} else {
delete $trigger->{'compregexp'};
return;
}
if ($trigger->{'nocase'}) {
$regexp = '(?i)' . $regexp;
}
$trigger->{'compregexp'} = qr/$regexp/;
if(defined($trigger->{'replace'})) {
(my $replace = $trigger->{'replace'}) =~ s/\$/\$\$/g;
$trigger->{'compreplace'} = Irssi::parse_special($replace);
}
}
# rebuilds triggers_by_type and updates signal binds
sub rebuild {
%triggers_by_type = ();
foreach my $trigger (@triggers) {
if (!$trigger->{'disabled'}) {
if ($trigger->{'all'}) {
# -all is an alias for all types in @all_types for which the filters can apply
ALLTYPES:
foreach my $type (@all_types) {
# check if all filters can apply to $type
foreach my $filter (@{$trigger->{'filters'}}) {
if (! grep {$_ eq $type} $filters{$filter->[0]}->{'types'}) {
next ALLTYPES;
}
}
push @{$triggers_by_type{$type}}, ($trigger);
}
}
foreach my $type ($trigger->{'all'} ? @notall_types : @trigger_types) {
if ($trigger->{$type}) {
push @{$triggers_by_type{$type}}, ($trigger);
}
}
}
}
foreach my $signal (@signals) {
my $should_bind = 0;
foreach my $type (@{$signal->{'types'}}) {
if (defined($triggers_by_type{$type})) {
$should_bind = 1;
}
}
if ($should_bind && !$signal->{'bind'}) {
signal_add_first($signal->{'signal'}, $signal->{'sub'});
$signal->{'bind'} = 1;
} elsif (!$should_bind && $signal->{'bind'}) {
signal_remove($signal->{'signal'}, $signal->{'sub'});
$signal->{'bind'} = 0;
}
}
}
################################
### manage the triggers-list ###
################################
my $trigger_file; # cached setting
sub sig_setup_changed {
$trigger_file = Irssi::settings_get_str('trigger_file');
}
sub autosave {
cmd_save() if ($changed_since_last_save);
}
# TRIGGER SAVE
sub cmd_save {
my $io = new IO::File $trigger_file, "w";
if (defined $io) {
$io->print("#Triggers file version $VERSION\n");
foreach my $trigger (@triggers) {
$io->print(to_string($trigger) . "\n");
}
$io->close;
}
Irssi::printformat(MSGLEVEL_CLIENTNOTICE, 'trigger_saved', $trigger_file);
$changed_since_last_save = 0;
}
# save on unload
sub UNLOAD {
cmd_save();
}
# TRIGGER LOAD
sub cmd_load {
sig_setup_changed(); # make sure we've read the trigger_file setting
my $converted = 0;
my $io = new IO::File $trigger_file, "r";
if (not defined $io) {
if (-e $trigger_file) {
Irssi::print("Error opening triggers file", MSGLEVEL_CLIENTERROR);
}
return;
}
if (defined $io) {
@triggers = ();
my $text;
$text = $io->getline;
my $file_version = '';
if ($text =~ /^#Triggers file version (.*)\n/) {
$file_version = $1;
}
if ($file_version lt '0.6.1+2') {
no strict 'vars';
$text .= $_ foreach ($io->getlines);
my $rep = eval "$text";
if (! ref $rep) {
Irssi::print("Error in triggers file");
return;
}
my @old_triggers = @$rep;
for (my $index=0;$index < scalar(@old_triggers);$index++) {
my $trigger = $old_triggers[$index];
if ($file_version lt '0.6.1') {
# convert old names: notices => pubnotices, actions => pubactions
foreach $oldname ('notices','actions') {
if ($trigger->{$oldname}) {
delete $trigger->{$oldname};
$trigger->{'pub'.$oldname} = 1;
$converted = 1;
}
}
}
if ($file_version lt '0.6.1+1' && $trigger->{'modifiers'}) {
if ($trigger->{'modifiers'} =~ /i/) {
$trigger->{'nocase'} = 1;
Irssi::print("Trigger: trigger ".($index+1)." had 'i' in it's modifiers, it has been converted to -nocase");
}
if ($trigger->{'modifiers'} !~ /^[ig]*$/) {
Irssi::print("Trigger: trigger ".($index+1)." had unrecognised modifier '". $trigger->{'modifiers'} ."', which couldn't be converted.");
}
delete $trigger->{'modifiers'};
$converted = 1;
}
if (defined($trigger->{'replace'}) && ! $trigger->{'regexp'}) {
Irssi::print("Trigger: trigger ".($index+1)." had -replace but no -regexp, removed it");
splice (@old_triggers,$index,1);
$index--; # nr of next trigger now is the same as this one was
}
# convert to text with compat, and then to new trigger hash
$text = to_string($trigger,1);
my @args = &shellwords($text . ' a');
my $trigger = parse_options({},@args);
if ($trigger) {
push @triggers, $trigger;
}
}
} else { # new format
while ( $text = $io->getline ) {
chop($text);
my @args = &shellwords($text . ' a');
my $trigger = parse_options({},@args);
if ($trigger) {
push @triggers, $trigger;
}
}
}
}
Irssi::printformat(MSGLEVEL_CLIENTNOTICE, 'trigger_loaded', $trigger_file);
if ($converted) {
Irssi::print("Trigger: Triggers file will be in new format next time it's saved.");
}
rebuild();
}
# escape for printing with to_string
# <<abcdef>> => << 'abcdef' >>
# <<abc'def>> => << "abc'def" >>
# <<abc'def\x02>> => << 'abc'\''def\x02' >>
sub param_to_string {
my ($text) = @_;
# avoid ugly escaping if we can use "-quotes without other escaping (no " or \)
if ($text =~ /^[^"\\]*'[^"\\]$/) {
return ' "' . $text . '" ';
}
# "'" signs without a (odd number of) \ in front of them, need be to escaped as '\''
# this is ugly :(
$text =~ s/(^|[^\\](\\\\)*)'/$1'\\''/g;
return " '$text' ";
}
# converts a trigger back to "-switch -options 'foo'" form
# if $compat, $trigger is in the old format (used to convert)
sub to_string {
my ($trigger, $compat) = @_;
my $string;
foreach my $switch (@trigger_switches) {
if ($trigger->{$switch}) {
$string .= '-'.$switch.' ';
}
}
if ($compat) {
foreach my $filter (keys(%filters)) {
if ($trigger->{$filter}) {
$string .= '-' . $filter . param_to_string($trigger->{$filter});
}
}
} else {
foreach my $trigfilter (@{$trigger->{'filters'}}) {
$string .= '-' . $trigfilter->[0] . param_to_string($trigfilter->[1]);
}
}
foreach my $param (@trigger_params) {
if ($trigger->{$param} || ($param eq 'replace' && defined($trigger->{'replace'}))) {
$string .= '-' . $param . param_to_string($trigger->{$param});
}
}
return $string;
}
# find a trigger (for REPLACE and DELETE), returns index of trigger, or -1 if not found
sub find_trigger {
my ($data) = @_;
if ($data =~ /^[0-9]*$/ and defined($triggers[$data-1])) {
return $data-1;
} else {
for (my $i=0; $i < scalar(@triggers); $i++) {
if ($triggers[$i]->{'name'} eq $data) {
return $i;
}
}
}
Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'trigger_not_found', $data);
return -1; # not found
}
# TRIGGER ADD <options>
sub cmd_add {
my ($data, $server, $item) = @_;
my @args = shellwords($data . ' a');
my $trigger = parse_options({}, @args);
if ($trigger) {
push @triggers, $trigger;
Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'trigger_added', scalar(@triggers), to_string($trigger));
rebuild();
$changed_since_last_save = 1;
}
}
# TRIGGER CHANGE <nr> <options>
sub cmd_change {
my ($data, $server, $item) = @_;
my @args = shellwords($data . ' a');
my $index = find_trigger(shift @args);
if ($index != -1) {
if(parse_options($triggers[$index], @args)) {
Irssi::print("Trigger " . ($index+1) ." changed to: ". to_string($triggers[$index]));
}
rebuild();
$changed_since_last_save = 1;
}
}
# parses options for TRIGGER ADD and TRIGGER CHANGE
# if invalid args returns undef, else changes $thetrigger and returns it
sub parse_options {
my ($thetrigger,@args) = @_;
my ($trigger, $option);
if (pop(@args) ne 'a') {
Irssi::print("Syntax error, probably missing a closing quote", MSGLEVEL_CLIENTERROR);
return undef;
}
%$trigger = %$thetrigger; # make a copy to prevent changing the given trigger if args doesn't parse
ARGS: for (my $arg = shift @args; $arg; $arg = shift @args) {
# expand abbreviated options, put in $option
$arg =~ s/^-//;
$option = undef;
foreach my $ioption (@trigger_options) {
if (index($ioption, $arg) == 0) { # -$opt starts with $arg
if ($option) { # another already matched
Irssi::print("Ambiguous option: $arg", MSGLEVEL_CLIENTERROR);
return undef;
}
$option = $ioption;
last if ($arg eq $ioption); # exact match is unambiguous
}
}
if (!$option) {
Irssi::print("Unknown option: $arg", MSGLEVEL_CLIENTERROR);
return undef;
}
# -<param> <value> or -no<param>
foreach my $param (@trigger_params) {
if ($option eq $param) {
$trigger->{$param} = shift @args;
next ARGS;
}
if ($option eq 'no'.$param) {
$trigger->{$param} = undef;
next ARGS;
}
}
# -[no]<switch>
foreach my $switch (@trigger_switches) {
# -<switch>
if ($option eq $switch) {
$trigger->{$switch} = 1;
next ARGS;
}
# -no<switch>
elsif ($option eq 'no'.$switch) {
$trigger->{$switch} = undef;
next ARGS;
}
}
# -<filter> <value>
if ($filters{$option}) {
push @{$trigger->{'filters'}}, [$option, shift @args, $filters{$option}->{'sub'}];
next ARGS;
}
# -<nofilter>
if ($option =~ /^no(.*)$/ && $filters{$1}) {
my $filter = $1;
# the new filters are the old grepped for everything except ones with name $filter
@{$trigger->{'filters'}} = grep( $_->[0] ne $filter, @{$trigger->{'filters'}} );
}
}
if (defined($trigger->{'replace'}) && ! $trigger->{'regexp'} && !$trigger->{'pattern'}) {
Irssi::print("Trigger error: Can't have -replace without -regexp", MSGLEVEL_CLIENTERROR);
return undef;
}
if ($trigger->{'pattern'} && $trigger->{'regexp'}) {
Irssi::print("Trigger error: Can't have -pattern and -regexp in same trigger", MSGLEVEL_CLIENTERROR);
return undef;
}
# remove types that are implied by -all
if ($trigger->{'all'}) {
foreach my $type (@all_types) {
delete $trigger->{$type};
}
}
# remove types for which the filters don't apply
foreach my $type (@trigger_types) {
if ($trigger->{$type}) {
foreach my $filter (@{$trigger->{'filters'}}) {
if (!grep {$_ eq $type} @{$filters{$filter->[0]}->{'types'}}) {
Irssi::print("Warning: the filter -" . $filter->[0] . " can't apply to an event of type -$type, so I'm removing that type from this trigger.");
delete $trigger->{$type};
}
}
}
}
# check if it has at least one type
my $has_a_type;
foreach my $type (@trigger_types) {
if ($trigger->{$type}) {
$has_a_type = 1;
last;
}
}
if (!$has_a_type && !$trigger->{'all'}) {
Irssi::print("Warning: this trigger doesn't trigger on any type of message. you probably want to add -publics or -all");
}
compile_trigger($trigger);
%$thetrigger = %$trigger; # copy changes to real trigger
return $thetrigger;
}
# TRIGGER DELETE <num>
sub cmd_del {
my ($data, $server, $item) = @_;
my @args = shellwords($data);
my $index = find_trigger(shift @args);
if ($index != -1) {
Irssi::print("Deleted ". ($index+1) .": ". to_string($triggers[$index]));
splice (@triggers,$index,1);
rebuild();
$changed_since_last_save = 1;
}
}
# TRIGGER MOVE <num> <num>
sub cmd_move {
my ($data, $server, $item) = @_;
my @args = &shellwords($data);
my $index = find_trigger(shift @args);
if ($index != -1) {
my $newindex = shift @args;
if ($newindex < 1 || $newindex > scalar(@triggers)) {
Irssi::print("$newindex is not a valid trigger number");
return;
}
Irssi::print("Moved from ". ($index+1) ." to $newindex: ". to_string($triggers[$index]));
$newindex -= 1; # array starts counting from 0
my $trigger = splice (@triggers,$index,1); # remove from old place
splice (@triggers,$newindex,0,($trigger)); # insert at new place
rebuild();
$changed_since_last_save = 1;
}
}
# TRIGGER LIST
sub cmd_list {
Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'trigger_header');
my $i=1;
foreach my $trigger (@triggers) {
Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'trigger_line', $i++, to_string($trigger));
}
}
######################
### initialisation ###
######################
command_bind('trigger help',\&cmd_help);
command_bind('help trigger',\&cmd_help);
command_bind('trigger add',\&cmd_add);
command_bind('trigger change',\&cmd_change);
command_bind('trigger move',\&cmd_move);
command_bind('trigger list',\&cmd_list);
command_bind('trigger delete',\&cmd_del);
command_bind('trigger save',\&cmd_save);
command_bind('trigger reload',\&cmd_load);
command_bind 'trigger' => sub {
my ( $data, $server, $item ) = @_;
$data =~ s/\s+$//g;
command_runsub('trigger', $data, $server, $item);
};
Irssi::signal_add('setup saved', \&autosave);
Irssi::signal_add('setup changed', \&sig_setup_changed);
# This makes tab completion work
Irssi::command_set_options('trigger add',join(' ',@trigger_add_options));
Irssi::command_set_options('trigger change',join(' ',@trigger_options));
Irssi::settings_add_str($IRSSI{'name'}, 'trigger_file', Irssi::get_irssi_dir()."/triggers");
cmd_load();