2 # News.pl: Advanced news management
4 # Version: v0.3 (20010412)
6 # Notes: Testing done by greycat, kudos!
9 # news{ channel }{ string } { item }
10 # newsuser{ channel }{ user } = time()
12 # Time - when it was added (used for sorting)
14 # Expire - Time to expire.
18 use vars qw($who $chan);
28 if (!exists $::cache{newsFirst}) {
29 &::DEBUG("news: looks like we enabled news option just then; loading up news file just in case.");
30 $::cache{newsFirst} = 1;
36 if ($::msgType ne "private") {
40 if (defined $what and $what =~ s/^($::mask{chan})\s*//) {
41 # todo: check if the channel exists aswell.
44 if (!&::IsNickInChan($who, $chan)) {
45 &::notice($who, "sorry but you're not on $chan.");
51 my @chans = &::getNickInChans($who);
53 if (scalar @chans > 1) {
54 &::notice($who, "error: I dunno which channel you are referring to since you're on more than one. Try 'news #chan ...' instead");
58 if (scalar @chans == 0) {
59 &::notice($who, "error: I couldn't find you on any chan. This must be a bug!");
64 &::VERB("Guessed $who being on chan $chan",2);
65 $::chan = $chan; # hack for IsChanConf().
68 if (!defined $what or $what =~ /^\s*$/) {
73 if ($what =~ /^add(\s+(.*))?$/i) {
76 } elsif ($what =~ /^del(\s+(.*))?$/i) {
79 } elsif ($what =~ /^mod(\s+(.*))?$/i) {
82 } elsif ($what =~ /^set(\s+(.*))?$/i) {
85 } elsif ($what =~ /^(\d+)$/i) {
86 &::VERB("News: read shortcut called.",2);
89 } elsif ($what =~ /^read(\s+(.*))?$/i) {
92 } elsif ($what =~ /^(latest|new)(\s+(.*))?$/i) {
93 &latest($3 || $chan, 1);
94 # $::cmdstats{'News latest'}++;
96 } elsif ($what =~ /^stats?$/i) {
99 } elsif ($what =~ /^list$/i) {
102 } elsif ($what =~ /^(expire|text|desc)(\s+(.*))?$/i) {
106 my($arg1,$arg2) = split(/\s+/, $3, 2);
107 &set("$arg1 $cmd $arg2");
109 } elsif ($what =~ /^help(\s+(.*))?$/i) {
112 } elsif ($what =~ /^newsflush$/i) {
113 &::msg($who, "newsflush called... check out the logs!");
116 } elsif ($what =~ /^(un)?notify$/i) {
117 my $state = ($1) ? 0 : 1;
119 # todo: don't notify even if "news" is called.
120 if (!&::IsChanConf("newsNotifyAll")) {
121 &::DEBUG("news: chan => $chan, ::chan => $::chan.");
122 &::notice($who, "not available for this channel or disabled altogether.");
126 my $t = $::newsuser{$chan}{$who};
127 if ($state) { # state = 1
128 if (defined $t and ($t == 0 or $t == -1)) {
129 &::notice($who, "enabled notify.");
130 delete $::newsuser{$chan}{$who};
133 &::notice($who, "already enabled.");
136 my $x = $::newsuser{$chan}{$who};
137 if (defined $x and ($x == 0 or $x == -1)) {
138 &::notice($who, "notify already disabled");
141 $::newsuser{$chan}{$who} = -1;
142 &::notice($who, "notify is now disabled.");
146 &::notice($who, "unknown command: $what");
151 my $file = "$::bot_base_dir/blootbot-news.txt";
152 if (! -f $file or -z $file) {
157 &::DEBUG("readNews: fileno exists, should never happen.");
168 # todo: allow commands.
170 if (/^[\s\t]+(\S+):[\s\t]+(.*)$/) {
171 if (!defined $item) {
172 &::DEBUG("news: !defined item, never happen!");
176 $::news{$chan}{$item}{$1} = $2;
180 # U <chan> <nick> <time>
181 if (/^U\s+(\S+)\s+(\S+)\s+(\d+)$/) {
182 $::newsuser{$1}{$2} = $3;
187 if (/^(\S+)[\s\t]+(.*)$/) {
195 my $cn = scalar(keys %::news);
196 return unless ($ci or $cn or $cu);
198 &::status("News: read ".
199 $ci. &::fixPlural(" item", $ci). " for ".
200 $cn. &::fixPlural(" chan", $cn). ", ".
201 $cu. &::fixPlural(" user", $cu), " cache"
206 if (!scalar keys %::news and !scalar keys %::newsuser) {
207 &::VERB("wN: nothing to write.",2);
211 # should define this at the top of file.
212 my $file = "$::bot_base_dir/blootbot-news.txt";
215 &::ERROR("News: write: fileno NEWS exists, should never happen.");
219 # todo: add commands to output file.
221 my($cc,$ci,$cu) = (0,0,0);
223 open(NEWS, ">$file");
224 foreach $chan (sort keys %::news) {
225 $c = scalar keys %{ $::news{$chan} };
229 foreach $item (sort keys %{ $::news{$chan} }) {
230 $c = scalar keys %{ $::news{$chan}{$item} };
234 print NEWS "$chan $item\n";
235 foreach $what (sort keys %{ $::news{$chan}{$item} }) {
236 print NEWS " $what: $::news{$chan}{$item}{$what}\n";
242 # todo: show how many users we wrote down.
243 if (&::getChanConfList("newsKeepRead")) {
244 # old users are removed in newsFlush(), perhaps it should be
247 foreach $chan (sort keys %::newsuser) {
249 foreach (sort keys %{ $::newsuser{$chan} }) {
250 print NEWS "U $chan $_ $::newsuser{$chan}{$_}\n";
258 &::status("News: Wrote $ci items for $cc chans, $cu user cache.");
264 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
269 if (length $str > 64) {
270 &::notice($who, "That's not really an item (>64chars)");
274 if (exists $::news{$chan}{$str}{Time}) {
275 &::notice($who, "'$str' for $chan already exists!");
279 $::news{$chan}{$str}{Time} = time();
280 my $expire = &::getChanConfDefault("newsDefaultExpire",7);
281 $::news{$chan}{$str}{Expire} = time() + $expire*60*60*24;
282 $::news{$chan}{$str}{Author} = $::who; # case!
284 my $agestr = &::Time2String($::news{$chan}{$str}{Expire} - time() );
285 my $item = &newsS2N($str);
286 &::notice($who, "Added '\037$str\037' at [".localtime(time).
287 "] by \002$::who\002 for item #\002$item\002.");
288 &::notice($who, "Now do 'news text $item <your_description>'");
289 &::notice($who, "This item will expire at \002".
290 localtime($::news{$chan}{$str}{Expire})."\002 [$agestr from now] "
300 if (!defined $what) {
305 if ($what =~ /^\d+$/) {
306 my $count = scalar keys %{ $::news{$chan} };
308 &::notice($who, "No news for $chan.");
312 if ($what > $count or $what < 0) {
313 &::notice($who, "$what is out of range (max $count)");
317 $item = &getNewsItem($what);
318 $what = $item; # hack hack hack.
321 $_ = &getNewsItem($what); # hack hack hack.
322 $what = $_ if (defined $_);
324 if (!exists $::news{$chan}{$what}) {
326 foreach (keys %{ $::news{$chan} }) {
327 next unless (/\Q$what\E/);
331 if (!scalar @found) {
332 &::notice($who, "could not find $what.");
336 if (scalar @found > 1) {
337 &::notice($who, "too many matches for $what.");
342 &::DEBUG("news: del: str: guessed what => $what");
346 if (exists $::news{$chan}{$what}) {
348 $auth++ if ($::who eq $::news{$chan}{$what}{Author});
349 $auth++ if (&::IsFlag("o"));
352 # todo: show when it'll expire.
353 &::notice($who, "Sorry, you cannot remove items; just let them expire on their own.");
357 &::notice($who, "ok, deleted '$what' from \002$chan\002...");
358 delete $::news{$chan}{$what};
360 &::notice($who, "error: not found $what in news for $chan.");
365 if (!scalar keys %{ $::news{$chan} }) {
366 &::notice($who, "No News for \002$chan\002.");
370 if (&::IsChanConf("newsKeepRead")) {
371 my $x = $::newsuser{$chan}{$who};
373 if (defined $x and ($x == 0 or $x == -1)) {
374 &::DEBUG("news: not updating time for $who.");
376 if (!scalar keys %{ $::news{$chan} }) {
377 &::DEBUG("news: should not add $chan/$who to cache!");
380 $::newsuser{$chan}{$who} = time();
384 # ¬ice() breaks OPN :( - using msg() instead!
385 my $count = scalar keys %{ $::news{$chan} };
386 &::msg($who, "|==== News for \002$chan\002: ($count items)");
390 foreach (keys %{ $::news{$chan} }) {
391 my $t = $::news{$chan}{$_}{Time};
392 my $e = $::news{$chan}{$_}{Expire};
393 $newest = $t if ($t > $newest);
394 if ($e > 1 and $e < $expire) {
396 $eno = &newsS2N($item);
399 my $timestr = &::Time2String(time() - $newest);
400 &::msg($who, "|= Last updated $timestr ago.");
401 &::msg($who, " \037Num\037 \037Item ".(" "x40)." \037");
403 # &::DEBUG("news: list: expire = $expire");
404 # &::DEBUG("news: list: eno = $eno");
407 foreach ( &getNewsAll() ) {
409 my $setby = $::news{$chan}{$subtopic}{Author};
410 my $chr = (exists $::News{$chan}{$subtopic}{Text}) ? "" : "*";
412 if (!defined $subtopic) {
413 &::DEBUG("news: warn: subtopic == undef.");
417 # todo: show request stats aswell.
418 &::msg($who, sprintf("\002[\002%2d\002]\002%s %s",
419 $i, $chr, $subtopic));
423 my $z = $::newsuser{$who};
425 &::DEBUG("cache $who: $z");
427 &::DEBUG("cache: $who doesn't have newscache set.");
430 &::msg($who, "|= End of News.");
431 &::msg($who, "use 'news read <#>' or 'news read <keyword>'");
437 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
438 &::help("news read");
442 if (!scalar keys %{ $::news{$chan} }) {
443 &::notice($who, "No News for \002$chan\002.");
447 my $item = &getNewsItem($str);
448 if (!defined $item or !scalar keys %{ $::news{$chan}{$item} }) {
449 # todo: numerical check.
450 if ($str =~ /^(\d+)[-, ](\d+)$/ or
451 $str =~ /^-(\d+)$/ or
452 $str =~ /^(\d+)-$/ or 0
454 &::notice($who, "We don't support multiple requests of news items yet. Sorry.");
458 &::notice($who, "No news item called '$str'");
462 if (!exists $::news{$chan}{$item}{Text}) {
463 &::notice($who, "Someone forgot to add info to this news item");
467 my $t = localtime( $::news{$chan}{$item}{Time} );
468 my $a = $::news{$chan}{$item}{Author};
469 my $text = $::news{$chan}{$item}{Text};
470 my $num = &newsS2N($item);
471 my $rwho = $::news{$chan}{$item}{Request_By} || $::who;
472 my $rcount = $::news{$chan}{$item}{Request_Count} || 0;
474 if (length $text < $::param{maxKeySize}) {
475 &::VERB("NEWS: Possible news->factoid redirection.",2);
476 my $f = &::getFactoid($text);
479 &::VERB("NEWS: ok, $text is factoid redirection.",2);
480 $f =~ s/^<REPLY>\s*//i; # anything else?
485 $_ = $::news{$chan}{$item}{'Expire'};
488 $e = sprintf("\037%s\037 [%s from now]",
489 scalar(localtime($_)),
490 &::Time2String($_ - time())
494 &::notice($who, "+- News \002$chan\002 #$num: $item");
495 &::notice($who, "| Added by $a at \037$t\037");
496 &::notice($who, "| Expire: $e") if (defined $e);
497 &::notice($who, $text);
498 &::notice($who, "| Requested \002$rcount\002 times, last by \002$rwho\002") if ($rcount and $rwho);
500 $::news{$chan}{$item}{'Request_By'} = $::who;
501 $::news{$chan}{$item}{'Request_Time'} = time();
502 $::news{$chan}{$item}{'Request_Count'}++;
506 my($item, $str) = split /\s+/, $_[0], 2;
508 if (!defined $item or $item eq "" or $str =~ /^\s*$/) {
513 my $news = &getNewsItem($item);
515 if (!defined $news) {
516 &::DEBUG("news: error: mod: news == undefined.");
519 my $nnews = $::news{$chan}{$news}{Text};
520 my $mod_news = $news;
521 my $mod_nnews = $nnews;
524 if ($str =~ m|^\s*s([/,#\|])(.+?)\1(.*?)\1([a-z]*);?\s*$|) {
525 my ($delim, $op, $np, $flags) = ($1,$2,$3,$4);
527 if ($flags !~ /^(g)?$/) {
528 &::notice($who, "error: Invalid flags to regex.");
532 ### TODO: use m### to make code safe!
533 # todo: make code safer.
535 # todo: use eval to deal with flags easily.
537 $done++ if (!$done and $mod_news =~ s/\Q$op\E/$np/);
538 $done++ if (!$done and $mod_nnews =~ s/\Q$op\E/$np/);
539 } elsif ($flags eq "g") {
540 $done++ if ($mod_news =~ s/\Q$op\E/$np/g);
541 $done++ if ($mod_nnews =~ s/\Q$op\E/$np/g);
545 &::notice($who, "warning: regex not found in news.");
549 if ($mod_news ne $news) { # news item.
550 if (exists $::news{$chan}{$mod_news}) {
551 &::notice($who, "item '$mod_news' already exists.");
555 &::notice($who, "Moving item '$news' to '$mod_news' with SAR s/$op/$np/.");
556 foreach (keys %{ $::news{$chan}{$news} }) {
557 $::news{$chan}{$mod_news}{$_} = $::news{$chan}{$news}{$_};
558 delete $::news{$chan}{$news}{$_};
561 delete $::news{$chan}{$news};
564 if ($mod_nnews ne $nnews) { # news Text/Description.
565 &::notice($who, "Changing text for '$news' SAR s/$op/$np/.");
566 if ($mod_news ne $news) {
567 $::news{$chan}{$mod_news}{Text} = $mod_nnews;
569 $::news{$chan}{$news}{Text} = $mod_nnews;
575 &::notice($who, "error: that regex failed ;(");
579 &::notice($who, "error: Invalid regex. Try s/1/2/, s#3#4#...");
584 my($item, $what, $value);
586 if (!defined $args) {
587 &::DEBUG("news: set: args == NULL.");
591 $item = $1 if ($args =~ s/^(\S+)\s*//);
592 $what = $1 if ($args =~ s/^(\S+)\s*//);
600 my $news = &getNewsItem($item);
602 if (!defined $news) {
603 &::notice($who, "Could not find item '$item' substring or # in news list.");
607 # list all values for chan.
608 if (!defined $what or $what =~ /^\s*$/) {
609 &::msg($who, "set: you didn't fill me on the arguments! (what and values)");
614 my @elements = ("Expire","Text");
615 foreach (@elements) {
616 next unless ($what =~ /^$_$/i);
623 &::notice($who, "Invalid set. Try: @elements");
628 if (!defined $value or $value =~ /^\s*$/) {
629 &::msg($who, "set: you didn't fill me on the arguments! (value)");
633 if (!exists $::news{$chan}{$news}) {
634 &::notice($who, "news '$news' does not exist");
638 if ($what eq "Expire") {
639 # todo: use do_set().
642 my $plus = ($value =~ s/^\+//g);
643 while ($value =~ s/^(\d+)(\S*)\s*//) {
644 my($int,$unit) = ($1,$2);
645 $time += $int if ($unit =~ /^s(ecs?)?$/i);
646 $time += $int*60 if ($unit =~ /^m(in(utes?)?)?$/i);
647 $time += $int*60*60 if ($unit =~ /^h(ours?)?$/i);
648 $time += $int*60*60*24 if (!$unit or $unit =~ /^d(ays?)?$/i);
649 $time += $int*60*60*24*7 if ($unit =~ /^w(eeks?)?$/i);
650 $time += $int*60*60*24*30 if ($unit =~ /^mon(th)?$/i);
653 if ($value =~ s/^never$//i) {
660 # from creation of item.
661 $time += $::news{$chan}{$news}{Time};
664 if (!$time or ($value and $value !~ /^never$/i)) {
665 &::DEBUG("news: set: Expire... need to parse.");
666 &::msg($who, "hrm... couldn't parse that.");
671 &::notice($who, "Set never expire for \002$item\002." );
672 } elsif ($time < -1) {
673 &::DEBUG("news: time should never be negative ($time).");
676 &::notice($who, "Set expire for \002$item\002, to ".
677 localtime($time) ." [".&::Time2String($time - time())."]" );
679 if (time() > $time) {
680 &::DEBUG("news: hrm... time() > $time, should expire.");
685 $::news{$chan}{$news}{Expire} = $time;
691 # &::DEBUG("news: who => '$who'");
692 my $author = $::news{$chan}{$news}{Author};
693 $auth++ if ($::who eq $author);
694 $auth++ if (&::IsFlag("o"));
695 if (!defined $author) {
696 &::DEBUG("news: news{$chan}{$news}{Author} is not defined! auth'd anyway");
697 $::news{$chan}{$news}{Author} = $::who;
703 # todo: show when it'll expire.
704 &::notice($who, "Sorry, you cannot set items. (author $author owns it)");
708 # todo: clean this up.
709 my $old = $::news{$chan}{$news}{$what};
711 &::DEBUG("news: old => $old.");
713 $::news{$chan}{$news}{$what} = $value;
714 &::notice($who, "Setting [$chan]/{$news}/<$what> to '$value'.");
718 my($tchan, $flag) = @_;
724 # todo: if chan = undefined, guess.
725 # if (!exists $::news{$chan}) {
726 if (!exists $::channels{$chan}) {
727 &::notice($who, "invalid chan $chan") if ($flag);
731 my $t = $::newsuser{$chan}{$who};
733 # &::DEBUG("newsuser: $chan/$who == $t");
735 # &::DEBUG("newsuser: $chan/$who == undefined");
738 if (defined $t and ($t == 0 or $t == -1)) {
740 &::notice($who, "if you want to read news, try \002/msg $::ident news $chan\002 or \002/msg $::ident news $chan notify\002");
742 &::DEBUG("news: not displaying any new news for $who");
748 my $x = &::IsChanConf("newsNotifyAll");
749 if (&::IsChanConf("newsNotifyAll") and !defined $t) {
754 &::DEBUG("news: something went really wrong.");
755 &::DEBUG("news: chan => $chan, ::chan => $::chan");
756 # &::notice($who, "something went really wrong.");
761 foreach (keys %{ $::news{$chan} }) {
762 next if (!defined $t);
763 next if ($t > $::news{$chan}{$_}{Time});
765 # don't list new items if they don't have Text.
766 if (!exists $::news{$chan}{$_}{Text}) {
767 if (time() - $::news{$chan}{$_}{Time} > 60*60*24*3) {
768 &::DEBUG("deleting news{$chan}{$_} because it was too old and had no text info.");
769 delete $::news{$chan}{$_};
778 # !scalar @new, $flag
779 if (!scalar @new and $flag) {
780 &::notice($who, "no new news for $chan for $who.");
782 $::newsuser{$chan}{$who} = time();
786 # scalar @new, !$flag
787 my $unread = scalar @new;
788 my $total = scalar keys %{ $::news{$chan} };
790 return unless ($unread);
792 if ($::cache{newsTime} - time() < 5) {
793 &::status("news: not displaying latest notice to $who/$chan.");
797 $::cache{newsTime} = time();
798 my $reply = "There are unread news in $chan ($unread unread, $total total). /msg $::ident news $::chan latest";
799 $reply .= " If you don't want further news notification, /msg $::ident news unnotify" if ($unread == $total);
800 &::notice($who, $reply);
807 &::notice($who, "+==== New news for \002$chan\002 ($unread new; $total total):");
809 my $t = $::newsuser{$chan}{$who};
810 if (defined $t and $t > 1) {
811 my $timestr = &::Time2String( time() - $t );
812 &::notice($who, "|= Last time read $timestr ago");
817 my $i = &newsS2N($_);
821 for (my $i=0; $i<=scalar(@sorted); $i++) {
822 my $news = $sorted[$i];
823 next unless (defined $news);
825 my $age = time() - $::news{$chan}{$news}{Time};
826 &::notice($who, sprintf("\002[\002%2d\002]\002 %s",
828 # $i, $_, &::Time2String($age) ) );
831 &::notice($who, "|= to read, do \002news $chan read <#>\002 or \002news $chan read <keyword>\002");
833 # lame hack to prevent dupes if we just ignore it.
834 my $x = $::newsuser{$chan}{$who};
835 if (defined $x and ($x == 0 or $x == -1)) {
836 &::DEBUG("news: not updating time for $who. (2)");
838 $::newsuser{$chan}{$who} = time();
849 foreach (keys %{ $::news{$chan} }) {
850 $time{ $::news{$chan}{$_}{Time} } = $_;
854 foreach (sort { $a <=> $b } keys %time) {
855 push(@items, $time{$_});
868 foreach (keys %{ $::news{$chan} }) {
869 my $t = $::news{$chan}{$_}{Time};
871 if (!defined $t or $t !~ /^\d+$/) {
872 &::DEBUG("news: warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
873 delete $::news{$chan}{$_};
880 foreach (sort { $a <=> $b } keys %time) {
882 return $item if ($time{$_} eq $what);
885 &::DEBUG("newsS2N($what): failed...");
893 foreach (keys %{ $::news{$chan} }) {
894 my $t = $::news{$chan}{$_}{Time};
896 if (!defined $t or $t !~ /^\d+$/) {
897 &::DEBUG("news: warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
898 delete $::news{$chan}{$_};
905 # number to string resolution.
906 if ($what =~ /^\d+$/) {
907 foreach (sort { $a <=> $b } keys %time) {
909 return $time{$_} if ($item == $what);
913 # partial string to full string resolution
914 # in some cases, string->number resolution.
918 foreach (sort { $a <=> $b } keys %time) {
920 # $no = $item if ($time{$_} eq $what);
921 ## if ($time{$_} eq $what) {
926 push(@items, $time{$_}) if ($time{$_} =~ /\Q$what\E/i);
929 ## if (defined $no and !@items) {
930 ## &::DEBUG("news: string->number resolution: $what->$no.");
934 if (scalar @items > 1) {
935 &::DEBUG("news: Multiple matches, not guessing.");
936 &::notice($who, "Multiple matches, not guessing.");
941 # &::DEBUG("news: gNI: part_string->full_string: $what->$items[0]");
944 &::DEBUG("news: gNI: No match for '$what'");
949 &::ERROR("news: gNI: should not happen (what = $what)");
954 my($what,$value) = @_;
956 if (!defined $chan) {
957 &::DEBUG("news: do_set: chan not defined.");
961 if (!defined $what or $what =~ /^\s*$/) {
962 &::DEBUG("news: what $what is not defined.");
966 if (!defined $value or $value =~ /^\s*$/) {
967 &::DEBUG("news: value $value is not defined.");
971 &::DEBUG("news: do_set: TODO...");
975 &::DEBUG("News: stats called.");
976 &::msg($who, "check my logs/console.");
979 # total request count.
980 foreach $chan (keys %::news) {
981 foreach (keys %{ $::news{$chan} }) {
982 $i += $::news{$chan}{$_}{Request_Count};
985 &::DEBUG("news: stats: total request count => $i");
989 foreach $chan (keys %::newsuser) {
990 $i += $::newsuser{$chan}{$_};
992 &::DEBUG("news: stats: total user cache => $i");
995 # average latest time read.
997 foreach $chan (keys %::newsuser) {
998 $i += $t - $::newsuser{$chan}{$_};
1002 &::DEBUG("news: stats: average latest time read: total time: $i");
1003 &::DEBUG("news: ... count: $j");
1004 &::DEBUG("news: average: ".sprintf("%.02f", $i/($j||1))." sec/user");
1008 sub AUTOLOAD { &::AUTOLOAD(@_); }