2010-03-23 19:24:02 +01:00
# File: Quotegrabs.pm
2010-03-24 07:47:40 +01:00
# Author: pragma_
2010-03-17 07:36:54 +01:00
#
2010-03-23 19:24:02 +01:00
# Purpose: Allows users to "grab" quotes from anti-flood history and store them for later retreival.
2010-03-17 07:36:54 +01:00
package PBot::Quotegrabs ;
use warnings ;
use strict ;
2010-03-23 19:24:02 +01:00
use vars qw( $VERSION ) ;
$ VERSION = $ PBot:: PBot:: VERSION ;
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
use HTML::Entities ;
2011-12-04 02:13:21 +01:00
use Time::Duration ;
use Time::HiRes qw( gettimeofday ) ;
2010-03-23 19:24:02 +01:00
sub new {
if ( ref ( $ _ [ 1 ] ) eq 'HASH' ) {
Carp:: croak ( "Options to Quotegrabs should be key/value pairs, not hash reference" ) ;
}
my ( $ class , % conf ) = @ _ ;
my $ self = bless { } , $ class ;
$ self - > initialize ( % conf ) ;
return $ self ;
}
sub initialize {
my ( $ self , % conf ) = @ _ ;
my $ pbot = delete $ conf { pbot } ;
if ( not defined $ pbot ) {
Carp:: croak ( "Missing pbot reference to Quotegrabs" ) ;
}
my $ filename = delete $ conf { filename } ;
my $ export_path = delete $ conf { export_path } ;
$ self - > { pbot } = $ pbot ;
$ self - > { filename } = $ filename ;
$ self - > { export_path } = $ export_path ;
$ self - > { quotegrabs } = [] ;
#-------------------------------------------------------------------------------------
# The following could be in QuotegrabsCommands.pm, or they could be kept in here?
#-------------------------------------------------------------------------------------
$ pbot - > commands - > register ( sub { $ self - > grab_quotegrab ( @ _ ) } , "grab" , 0 ) ;
$ pbot - > commands - > register ( sub { $ self - > show_quotegrab ( @ _ ) } , "getq" , 0 ) ;
2011-12-04 02:13:21 +01:00
$ pbot - > commands - > register ( sub { $ self - > delete_quotegrab ( @ _ ) } , "delq" , 10 ) ;
2010-03-23 19:24:02 +01:00
$ pbot - > commands - > register ( sub { $ self - > show_random_quotegrab ( @ _ ) } , "rq" , 0 ) ;
}
sub load_quotegrabs {
my $ self = shift ;
my $ filename ;
if ( @ _ ) { $ filename = shift ; } else { $ filename = $ self - > { filename } ; }
return if not defined $ filename ;
$ self - > { pbot } - > logger - > log ( "Loading quotegrabs from $filename ...\n" ) ;
open ( FILE , "< $filename" ) or die "Couldn't open $filename: $!\n" ;
my @ contents = <FILE> ;
close ( FILE ) ;
my $ i = 0 ;
foreach my $ line ( @ contents ) {
chomp $ line ;
$ i + + ;
my ( $ nick , $ channel , $ timestamp , $ grabbed_by , $ text ) = split ( /\s+/ , $ line , 5 ) ;
if ( not defined $ nick || not defined $ channel || not defined $ timestamp
|| not defined $ grabbed_by || not defined $ text ) {
die "Syntax error around line $i of $self->{quotegrabs}_file\n" ;
}
my $ quotegrab = { } ;
$ quotegrab - > { nick } = $ nick ;
$ quotegrab - > { channel } = $ channel ;
$ quotegrab - > { timestamp } = $ timestamp ;
$ quotegrab - > { grabbed_by } = $ grabbed_by ;
$ quotegrab - > { text } = $ text ;
$ quotegrab - > { id } = $ i + 1 ;
push @ { $ self - > { quotegrabs } } , $ quotegrab ;
}
$ self - > { pbot } - > logger - > log ( " $i quotegrabs loaded.\n" ) ;
$ self - > { pbot } - > logger - > log ( "Done.\n" ) ;
}
sub save_quotegrabs {
my $ self = shift ;
my $ filename ;
if ( @ _ ) { $ filename = shift ; } else { $ filename = $ self - > { filename } ; }
return if not defined $ filename ;
open ( FILE , "> $filename" ) or die "Couldn't open $filename: $!\n" ;
for ( my $ i = 0 ; $ i <= $# { $ self - > { quotegrabs } } ; $ i + + ) {
my $ quotegrab = $ self - > { quotegrabs } [ $ i ] ;
next if $ quotegrab - > { timestamp } == 0 ;
print FILE "$quotegrab->{nick} $quotegrab->{channel} $quotegrab->{timestamp} $quotegrab->{grabbed_by} $quotegrab->{text}\n" ;
}
close ( FILE ) ;
$ self - > export_quotegrabs ( ) ;
2010-03-17 07:36:54 +01:00
}
2010-03-23 19:24:02 +01:00
sub export_quotegrabs () {
my $ self = shift ;
return "Not enabled" if not defined $ self - > { export_path } ;
my $ text ;
my $ last_channel = "" ;
my $ had_table = 0 ;
open FILE , "> $self->{export_path}" or return "Could not open export path." ;
my $ time = localtime ;
print FILE "<html><body><i>Generated at $time</i><hr><h1>Candide's Quotegrabs</h1>\n" ;
my $ i = 0 ;
foreach my $ quotegrab ( sort { $$ a { channel } cmp $$ b { channel } or $$ a { nick } cmp $$ b { nick } } @ { $ self - > { quotegrabs } } ) {
if ( not $ quotegrab - > { channel } =~ /^$last_channel$/i ) {
print FILE "</table>\n" if $ had_table ;
print FILE "<hr><h2>$quotegrab->{channel}</h2><hr>\n" ;
print FILE "<table border=\"0\">\n" ;
$ had_table = 1 ;
}
$ last_channel = $ quotegrab - > { channel } ;
$ i + + ;
if ( $ i % 2 ) {
print FILE "<tr bgcolor=\"#dddddd\">\n" ;
} else {
print FILE "<tr>\n" ;
}
print FILE "<td>" . ( $ quotegrab - > { id } ) . "</td>" ;
$ text = "<td><b><$quotegrab->{nick}></b> " . encode_entities ( $ quotegrab - > { text } ) . "</td>\n" ;
print FILE $ text ;
my ( $ seconds , $ minutes , $ hours , $ day_of_month , $ month , $ year , $ wday , $ yday , $ isdst ) = localtime ( $ quotegrab - > { timestamp } ) ;
my $ t = sprintf ( "%02d:%02d:%02d-%04d/%02d/%02d\n" ,
$ hours , $ minutes , $ seconds , $ year + 1900 , $ month + 1 , $ day_of_month ) ;
print FILE "<td align=\"right\">- grabbed by<br> $quotegrab->{grabbed_by}<br><i>$t</i>\n" ;
print FILE "</td></tr>\n" ;
}
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
print FILE "</table>\n" ;
close ( FILE ) ;
return "$i quotegrabs exported to http://blackshell.com/~msmud/candide/quotegrabs.html" ;
}
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
# ----------------------------------------------------------------------------------------
# The following subroutines could be in QuotegrabCommands.pm . . .
# ----------------------------------------------------------------------------------------
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
sub grab_quotegrab {
my ( $ self , $ from , $ nick , $ user , $ host , $ arguments ) = @ _ ;
2010-03-17 07:36:54 +01:00
if ( not defined $ from ) {
2010-03-23 19:24:02 +01:00
$ self - > { pbot } - > logger - > log ( "Command missing ~from parameter!\n" ) ;
2010-03-17 07:36:54 +01:00
return "" ;
}
2013-07-24 14:34:13 +02:00
if ( not defined $ arguments or not length $ arguments ) {
2013-06-04 19:09:30 +02:00
return "Usage: grab <nick> [history [channel]] -- where [history] is an optional argument that is either an integer number of recent messages or a regex (without whitespace) of the text within the message; e.g., to grab the 3rd most recent message for nick, use `grab nick 3` or to grab a message containing 'pizza', use `grab nick pizza`; and [channel] is an optional channel, so you can use it from /msg (you will need to also specify [history] in this case)" ;
2010-03-17 07:36:54 +01:00
}
2011-01-20 01:15:58 +01:00
$ arguments = lc $ arguments ;
2010-03-17 07:36:54 +01:00
my ( $ grab_nick , $ grab_history , $ channel ) = split ( /\s+/ , $ arguments , 3 ) ;
2010-03-23 19:24:02 +01:00
if ( not defined $ grab_history ) {
$ grab_history = $ nick eq $ grab_nick ? 2 : 1 ;
}
2010-03-17 07:36:54 +01:00
$ channel = $ from if not defined $ channel ;
2012-08-01 11:57:43 +02:00
if ( $ grab_history =~ /^\d+$/ and ( $ grab_history < 1 || $ grab_history > $ self - > { pbot } - > { MAX_NICK_MESSAGES } ) ) {
2010-03-23 19:24:02 +01:00
return "/msg $nick Please choose a history between 1 and $self->{pbot}->{MAX_NICK_MESSAGES}" ;
2010-03-17 07:36:54 +01:00
}
2011-02-11 03:46:35 +01:00
my $ found_mask = undef ;
2012-08-01 11:57:43 +02:00
my $ last_spoken = 0 ;
2011-02-11 03:46:35 +01:00
foreach my $ mask ( keys % { $ self - > { pbot } - > antiflood - > message_history } ) {
if ( $ mask =~ m/^\Q$grab_nick\E!/i ) {
2012-08-01 11:57:43 +02:00
if ( defined $ self - > { pbot } - > antiflood - > message_history - > { $ mask } - > { channels } - > { $ channel } { last_spoken }
and $ self - > { pbot } - > antiflood - > message_history - > { $ mask } - > { channels } - > { $ channel } { last_spoken } > $ last_spoken ) {
$ last_spoken = $ self - > { pbot } - > antiflood - > message_history - > { $ mask } - > { channels } - > { $ channel } { last_spoken } ;
$ found_mask = $ mask ;
}
2011-02-11 03:46:35 +01:00
}
}
if ( not defined $ found_mask ) {
2010-03-17 07:36:54 +01:00
return "No message history for $grab_nick." ;
}
2011-02-11 03:46:35 +01:00
if ( not exists $ self - > { pbot } - > antiflood - > message_history - > { $ found_mask } - > { channels } - > { $ channel } ) {
2010-03-17 07:36:54 +01:00
return "No message history for $grab_nick in $channel." ;
}
2011-02-11 03:46:35 +01:00
my @ messages = @ { $ self - > { pbot } - > antiflood - > message_history - > { $ found_mask } - > { channels } - > { $ channel } { messages } } ;
2010-03-17 07:36:54 +01:00
2012-08-01 11:57:43 +02:00
if ( $ grab_history =~ /^\d+$/ ) {
# integral history
$ grab_history - - ;
if ( $ grab_history > $# messages ) {
return "$grab_nick has only " . ( $# messages + 1 ) . " messages in the history." ;
}
2010-03-17 07:36:54 +01:00
2012-08-01 11:57:43 +02:00
$ grab_history = $# messages - $ grab_history ;
} else {
# regex history
my $ ret = eval {
2012-08-01 13:06:01 +02:00
my $ i = $# messages ;
2012-08-12 18:41:38 +02:00
$ i - - if ( $ nick =~ /^\Q$grab_nick\E$/i ) ; # skip 'grab' command if grabbing own nick
2012-08-01 11:57:43 +02:00
my $ found = 0 ;
2012-08-01 13:06:01 +02:00
while ( $ i >= 0 ) {
2012-08-01 11:57:43 +02:00
if ( $ messages [ $ i ] - > { msg } =~ m/$grab_history/i ) {
$ grab_history = $ i ;
$ found = 1 ;
last ;
}
2012-08-01 13:06:01 +02:00
$ i - - ;
2012-08-01 11:57:43 +02:00
}
if ( $ found == 0 ) {
return "/msg $nick No message containing regex '$grab_history' found for $grab_nick" ;
} else {
return undef ;
}
} ;
return "/msg $nick Bad grab regex: $@" if $@ ;
if ( defined $ ret ) {
return $ ret ;
}
}
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
$ self - > { pbot } - > logger - > log ( "$nick ($from) grabbed <$grab_nick/$channel> $messages[$grab_history]->{msg}\n" ) ;
2010-03-17 07:36:54 +01:00
my $ quotegrab = { } ;
$ quotegrab - > { nick } = $ grab_nick ;
$ quotegrab - > { channel } = $ channel ;
$ quotegrab - > { timestamp } = $ messages [ $ grab_history ] - > { timestamp } ;
$ quotegrab - > { grabbed_by } = $ nick ;
$ quotegrab - > { text } = $ messages [ $ grab_history ] - > { msg } ;
2010-03-23 19:24:02 +01:00
$ quotegrab - > { id } = $# { $ self - > { quotegrabs } } + 2 ;
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
push @ { $ self - > { quotegrabs } } , $ quotegrab ;
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
$ self - > save_quotegrabs ( ) ;
2010-03-17 07:36:54 +01:00
2013-06-04 19:09:30 +02:00
my $ text = $ quotegrab - > { text } ;
if ( $ text =~ s/^\/me\s+// ) {
return "Quote grabbed: " . ( $# { $ self - > { quotegrabs } } + 1 ) . ": * $grab_nick $text" ;
} else {
return "Quote grabbed: " . ( $# { $ self - > { quotegrabs } } + 1 ) . ": <$grab_nick> $text" ;
}
2010-03-17 07:36:54 +01:00
}
2010-03-23 19:24:02 +01:00
sub add_quotegrab {
my ( $ self , $ nick , $ channel , $ timestamp , $ grabbed_by , $ text ) = @ _ ;
my $ quotegrab = { } ;
$ quotegrab - > { nick } = $ nick ;
$ quotegrab - > { channel } = $ channel ;
$ quotegrab - > { timestamp } = $ timestamp ;
$ quotegrab - > { grabbed_by } = $ grabbed_by ;
$ quotegrab - > { text } = $ text ;
$ quotegrab - > { id } = $# { $ self - > { quotegrabs } } + 2 ;
push @ { $ self - > { quotegrabs } } , $ quotegrab ;
}
2010-03-17 07:36:54 +01:00
sub delete_quotegrab {
2010-03-23 19:24:02 +01:00
my ( $ self , $ from , $ nick , $ user , $ host , $ arguments ) = @ _ ;
if ( $ arguments < 1 || $ arguments > $# { $ self - > { quotegrabs } } + 1 ) {
2013-06-04 19:09:30 +02:00
return "/msg $nick Valid range for `getq` is 1 - " . ( $# { $ self - > { quotegrabs } } + 1 ) ;
2010-03-23 19:24:02 +01:00
}
my $ quotegrab = $ self - > { quotegrabs } [ $ arguments - 1 ] ;
splice @ { $ self - > { quotegrabs } } , $ arguments - 1 , 1 ;
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
for ( my $ i = $ arguments - 1 ; $ i <= $# { $ self - > { quotegrabs } } ; $ i + + ) {
$ self - > { quotegrabs } [ $ i ] - > { id } - - ;
2010-03-17 07:36:54 +01:00
}
2010-03-23 19:24:02 +01:00
$ self - > save_quotegrabs ( ) ;
2013-06-04 19:09:30 +02:00
my $ text = $ quotegrab - > { text } ;
if ( $ text =~ s/^\/me\s+// ) {
return "Deleted $arguments: * $quotegrab->{nick} $text" ;
} else {
return "Deleted $arguments: <$quotegrab->{nick}> $text" ;
}
2010-03-17 07:36:54 +01:00
}
sub show_quotegrab {
2010-03-23 19:24:02 +01:00
my ( $ self , $ from , $ nick , $ user , $ host , $ arguments ) = @ _ ;
2010-03-17 07:36:54 +01:00
2010-03-23 19:24:02 +01:00
if ( $ arguments < 1 || $ arguments > $# { $ self - > { quotegrabs } } + 1 ) {
return "/msg $nick Valid range for !getq is 1 - " . ( $# { $ self - > { quotegrabs } } + 1 ) ;
2010-03-17 07:36:54 +01:00
}
2010-03-23 19:24:02 +01:00
my $ quotegrab = $ self - > { quotegrabs } [ $ arguments - 1 ] ;
2011-12-04 02:13:21 +01:00
my $ timestamp = $ quotegrab - > { timestamp } ;
my $ ago = ago ( gettimeofday - $ timestamp ) ;
2013-06-04 19:09:30 +02:00
my $ text = $ quotegrab - > { text } ;
if ( $ text =~ s/^\/me\s+// ) {
return "$arguments: grabbed by $quotegrab->{grabbed_by} on " . localtime ( $ timestamp ) . " [$ago] * $quotegrab->{nick} $text" ;
} else {
return "$arguments: grabbed by $quotegrab->{grabbed_by} on " . localtime ( $ timestamp ) . " [$ago] <$quotegrab->{nick}> $text" ;
}
2010-03-17 07:36:54 +01:00
}
sub show_random_quotegrab {
2010-03-23 19:24:02 +01:00
my ( $ self , $ from , $ nick , $ user , $ host , $ arguments ) = @ _ ;
2010-03-17 07:36:54 +01:00
my @ quotes = ( ) ;
my $ nick_search = ".*" ;
my $ channel_search = $ from ;
2010-03-26 06:14:03 +01:00
my $ text_search = ".*" ;
2010-03-17 07:36:54 +01:00
if ( not defined $ from ) {
2010-03-23 19:24:02 +01:00
$ self - > { pbot } - > logger - > log ( "Command missing ~from parameter!\n" ) ;
2010-03-17 07:36:54 +01:00
return "" ;
}
if ( defined $ arguments ) {
2010-03-26 06:14:03 +01:00
( $ nick_search , $ channel_search , $ text_search ) = split /\s+/ , $ arguments ;
2010-03-17 07:36:54 +01:00
if ( not defined $ channel_search ) {
$ channel_search = $ from ;
}
}
2010-03-26 06:14:03 +01:00
$ nick_search = '.*' if not defined $ nick_search ;
$ channel_search = '.*' if not defined $ channel_search ;
$ text_search = '.*' if not defined $ text_search ;
2010-03-17 07:36:54 +01:00
eval {
2010-03-23 19:24:02 +01:00
for ( my $ i = 0 ; $ i <= $# { $ self - > { quotegrabs } } ; $ i + + ) {
my $ hash = $ self - > { quotegrabs } [ $ i ] ;
2010-03-26 06:14:03 +01:00
if ( $ hash - > { channel } =~ /$channel_search/i && $ hash - > { nick } =~ /$nick_search/i && $ hash - > { text } =~ /$text_search/i ) {
2010-03-17 07:36:54 +01:00
$ hash - > { id } = $ i + 1 ;
push @ quotes , $ hash ;
}
}
} ;
if ( $@ ) {
2010-03-23 19:24:02 +01:00
$ self - > { pbot } - > logger - > log ( "Error in show_random_quotegrab parameters: $@\n" ) ;
2010-03-26 06:14:03 +01:00
return "/msg $nick Error in search parameters: $@"
2010-03-17 07:36:54 +01:00
}
if ( $# quotes < 0 ) {
if ( $ nick_search eq ".*" ) {
2013-06-04 19:09:30 +02:00
return "No quotes grabbed in $channel_search yet (use `rq [nick [channel]]` to specify the correct channel). Use `grab` to grab a quote." ;
2010-03-17 07:36:54 +01:00
} else {
2013-06-04 19:09:30 +02:00
return "No quotes grabbed for $nick_search in $channel_search yet (use `rq [nick [channel]]` to specify the correct channel).. Use `grab` to grab a quote." ;
2010-03-17 07:36:54 +01:00
}
}
my $ quotegrab = $ quotes [ int rand ( $# quotes + 1 ) ] ;
2013-06-04 19:09:30 +02:00
my $ text = $ quotegrab - > { text } ;
if ( $ text =~ s/^\/me\s+// ) {
return "$quotegrab->{id}: * $quotegrab->{nick} $text" ;
} else {
return "$quotegrab->{id}: <$quotegrab->{nick}> $text" ;
}
2010-03-17 07:36:54 +01:00
}
1 ;
