2 # News.pl: Advanced news management
4 # Version: v0.3 (20014012)
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.
25 if (!exists $::cache{newsFirst}) {
26 &::DEBUG("looks like we enabled news option just then; loading up news file just in case.");
27 $::cache{newsFirst} = 1;
33 if ($::msgType ne "private") {
37 if (defined $what and $what =~ s/^($::mask{chan})\s*//) {
38 # todo: check if the channel exists aswell.
41 if (!&::IsNickInChan($::who, $chan)) {
42 &::notice($::who, "sorry but you're not on $chan.");
48 my @chans = &::getNickInChans($::who);
50 if (scalar @chans > 1) {
51 &::notice($::who, "error: I dunno which channel you are referring to since you're on more than one. Try 'news #chan ...' instead");
55 if (scalar @chans == 0) {
56 &::notice($::who, "error: I couldn't find you on any chan. This must be a bug!");
61 &::VERB("Guessed $::who being on chan $chan",2);
62 $::chan = $chan; # hack for IsChanConf().
65 if (!defined $what or $what =~ /^\s*$/) {
70 if ($what =~ /^add(\s+(.*))?$/i) {
73 } elsif ($what =~ /^del(\s+(.*))?$/i) {
76 } elsif ($what =~ /^mod(\s+(.*))?$/i) {
79 } elsif ($what =~ /^set(\s+(.*))?$/i) {
82 } elsif ($what =~ /^(\d+)$/i) {
83 &::VERB("News: read shortcut called.",2);
86 } elsif ($what =~ /^read(\s+(.*))?$/i) {
89 } elsif ($what =~ /^(latest|new)(\s+(.*))?$/i) {
90 &latest($3 || $chan, 1);
91 # $::cmdstats{'News latest'}++;
93 } elsif ($what =~ /^stats?$/i) {
96 } elsif ($what =~ /^list$/i) {
99 } elsif ($what =~ /^(expire|text|desc)(\s+(.*))?$/i) {
102 my($arg1,$arg2) = split(/\s+/, $3, 2);
103 &set("$arg1 $1 $arg2");
105 } elsif ($what =~ /^help(\s+(.*))?$/i) {
108 } elsif ($what =~ /^newsflush$/i) {
109 &::msg($::who, "newsflush called... check out the logs!");
112 } elsif ($what =~ /^(un)?notify$/i) {
113 my $state = ($1) ? 0 : 1;
115 # todo: don't notify even if "news" is called.
116 if (!&::IsChanConf("newsNotifyAll")) {
117 &::DEBUG("chan => $chan, ::chan => $::chan.");
118 &::notice($::who, "not available for this channel or disabled altogether.");
122 my $t = $::newsuser{$chan}{$::who};
123 if ($state) { # state = 1
124 if (defined $t and ($t == 0 or $t == -1)) {
125 &::notice($::who, "enabled notify.");
126 delete $::newsuser{$chan}{$::who};
129 &::notice($::who, "already enabled.");
132 my $x = $::newsuser{$chan}{$::who};
133 if (defined $x and ($x == 0 or $x == -1)) {
134 &::notice($::who, "notify already disabled");
137 $::newsuser{$chan}{$::who} = -1;
138 &::notice($::who, "notify is now disabled.");
142 &::DEBUG("could not parse '$what'");
143 &::notice($::who, "unknown command: $what");
148 my $file = "$::bot_base_dir/blootbot-news.txt";
149 if (! -f $file or -z $file) {
154 &::DEBUG("readNews: fileno exists, should never happen.");
165 # todo: allow commands.
167 if (/^[\s\t]+(\S+):[\s\t]+(.*)$/) {
168 if (!defined $item) {
169 &::DEBUG("!defined item, never happen!");
173 $::news{$chan}{$item}{$1} = $2;
177 # U <chan> <nick> <time>
178 if (/^U\s+(\S+)\s+(\S+)\s+(\d+)$/) {
179 $::newsuser{$1}{$2} = $3;
184 if (/^(\S+)[\s\t]+(.*)$/) {
192 my $cn = scalar(keys %::news);
193 &::status("News: Read ".
194 $ci. &::fixPlural(" item", $ci). " for ".
195 $cn. &::fixPlural(" chan", $cn). ", ".
196 $cu. &::fixPlural(" user", $cu), " cache"
197 ) if ($ci or $cn or $cu);
201 if (!scalar keys %::news and !scalar keys %::newsuser) {
202 &::VERB("wN: nothing to write.",2);
206 my $file = "$::bot_base_dir/blootbot-news.txt";
209 &::ERROR("fileno NEWS exists, should never happen.");
213 # todo: add commands to output file.
215 my($cc,$ci,$cu) = (0,0,0);
217 open(NEWS, ">$file");
218 foreach $chan (sort keys %::news) {
219 $c = scalar keys %{ $::news{$chan} };
223 foreach $item (sort keys %{ $::news{$chan} }) {
224 $c = scalar keys %{ $::news{$chan}{$item} };
228 print NEWS "$chan $item\n";
229 foreach $what (sort keys %{ $::news{$chan}{$item} }) {
230 print NEWS " $what: $::news{$chan}{$item}{$what}\n";
236 # todo: show how many users we wrote down.
237 if (&::getChanConfList("newsKeepRead")) {
238 # old users are removed in newsFlush(), perhaps it should be
241 foreach $chan (sort keys %::newsuser) {
243 foreach (sort keys %{ $::newsuser{$chan} }) {
244 print NEWS "U $chan $_ $::newsuser{$chan}{$_}\n";
252 &::status("News: Wrote $ci items for $cc chans, $cu user cache.");
258 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
263 if (length $str > 64) {
264 &::notice($::who, "That's not really an item (>64chars)");
268 if (exists $::news{$chan}{$str}{Time}) {
269 &::notice($::who, "'$str' for $chan already exists!");
273 $::news{$chan}{$str}{Time} = time();
274 my $expire = &::getChanConfDefault("newsDefaultExpire",7);
275 $::news{$chan}{$str}{Expire} = time() + $expire*60*60*24;
276 $::news{$chan}{$str}{Author} = $::who;
278 my $agestr = &::Time2String($::news{$chan}{$str}{Expire} - time() );
279 my $item = &newsS2N($str);
280 &::notice($::who, "Added '\037$str\037' at [".localtime(time).
281 "] by \002$::who\002 for item #\002$item\002.");
282 &::notice($::who, "Now do 'news text $item <your_description>'");
283 &::notice($::who, "This item will expire at \002".
284 localtime($::news{$chan}{$str}{Expire})."\002 [$agestr from now] "
294 if (!defined $what) {
299 if ($what =~ /^\d+$/) {
300 my $count = scalar keys %{ $::news{$chan} };
302 &::notice($::who, "No news for $chan.");
306 if ($what > $count or $what < 0) {
307 &::notice($::who, "$what is out of range (max $count)");
311 $item = &getNewsItem($what);
312 $what = $item; # hack hack hack.
315 $_ = &getNewsItem($what); # hack hack hack.
316 $what = $_ if (defined $_);
318 if (!exists $::news{$chan}{$what}) {
320 foreach (keys %{ $::news{$chan} }) {
321 next unless (/\Q$what\E/);
325 if (!scalar @found) {
326 &::notice($::who, "could not find $what.");
330 if (scalar @found > 1) {
331 &::notice($::who, "too many matches for $what.");
336 &::DEBUG("del: str: guessed what => $what");
340 if (exists $::news{$chan}{$what}) {
342 $auth++ if ($::who eq $::news{$chan}{$what}{Author});
343 $auth++ if (&::IsFlag("o"));
346 # todo: show when it'll expire.
347 &::notice($::who, "Sorry, you cannot remove items; just let them expire on their own.");
351 &::notice($::who, "ok, deleted '$what' from \002$chan\002...");
352 delete $::news{$chan}{$what};
354 &::notice($::who, "error: not found $what in news for $chan.");
359 if (!scalar keys %{ $::news{$chan} }) {
360 &::notice($::who, "No News for \002$chan\002.");
364 if (&::IsChanConf("newsKeepRead")) {
365 my $x = $::newsuser{$chan}{$::who};
367 if (defined $x and ($x == 0 or $x == -1)) {
368 &::DEBUG("not updating time for $::who.");
370 if (!scalar keys %{ $::news{$chan} }) {
371 &DEBUG("news: should not add $chan/$::who to cache!");
374 $::newsuser{$chan}{$::who} = time();
378 my $count = scalar keys %{ $::news{$chan} };
379 &::notice($::who, "|==== News for \002$chan\002: ($count items)");
381 foreach (keys %{ $::news{$chan} }) {
382 my $t = $::news{$chan}{$_}{Time};
383 $newest = $t if ($t > $newest);
385 my $timestr = &::Time2String(time() - $newest);
386 &::notice($::who, "|= Last updated $timestr ago.");
387 &::notice($::who, " \037Num\037 \037Item ".(" "x40)." \037");
390 foreach ( &getNewsAll() ) {
392 my $setby = $::news{$chan}{$subtopic}{Author};
394 if (!defined $subtopic) {
395 &::DEBUG("warn: subtopic == undef.");
399 # todo: show request stats aswell.
400 &::notice($::who, sprintf("\002[\002%2d\002]\002 %s",
405 &::notice($::who, "|= End of News.");
406 &::notice($::who, "use 'news read <#>' or 'news read <keyword>'");
412 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
413 &::help("news read");
417 if (!scalar keys %{ $::news{$chan} }) {
418 &::notice($::who, "No News for \002$chan\002.");
422 my $item = &getNewsItem($str);
423 if (!defined $item or !scalar keys %{ $::news{$chan}{$item} }) {
424 &::notice($::who, "No news item called '$str'");
428 if (!exists $::news{$chan}{$item}{Text}) {
429 &::notice($::who, "Someone forgot to add info to this news item");
433 my $t = localtime( $::news{$chan}{$item}{Time} );
434 my $a = $::news{$chan}{$item}{Author};
435 my $text = $::news{$chan}{$item}{Text};
436 my $num = &newsS2N($item);
437 my $rwho = $::news{$chan}{$item}{Request_By} || $::who;
438 my $rcount = $::news{$chan}{$item}{Request_Count} || 0;
440 if (length $text < $::param{maxKeySize}) {
441 &::VERB("NEWS: Possible news->factoid redirection.",2);
442 my $f = &::getFactoid($text);
445 &::VERB("NEWS: ok, $text is factoid redirection.",2);
446 $f =~ s/^<REPLY>\s*//i; # anything else?
451 $_ = $::news{$chan}{$item}{'Expire'};
454 $e = sprintf("\037%s\037 [%s from now]",
455 scalar(localtime($_)),
456 &::Time2String($_ - time())
460 &::notice($::who, "+- News \002$chan\002 #$num: $item");
461 &::notice($::who, "| Added by $a at \037$t\037");
462 &::notice($::who, "| Expire: $e") if (defined $e);
463 &::notice($::who, $text);
464 &::notice($::who, "| Requested \002$rcount\002 times, last by \002$rwho\002") if ($rcount and $rwho);
466 $::news{$chan}{$item}{'Request_By'} = $::who;
467 $::news{$chan}{$item}{'Request_Time'} = time();
468 $::news{$chan}{$item}{'Request_Count'}++;
472 my($item, $str) = split /\s+/, $_[0], 2;
474 if (!defined $item or $item eq "" or $str =~ /^\s*$/) {
479 my $news = &getNewsItem($item);
481 if (!defined $news) {
482 &::DEBUG("error: mod: news == undefined.");
485 my $nnews = $::news{$chan}{$news}{Text};
486 my $mod_news = $news;
487 my $mod_nnews = $nnews;
490 if ($str =~ m|^\s*s([/,#\|])(.+?)\1(.*?)\1([a-z]*);?\s*$|) {
491 my ($delim, $op, $np, $flags) = ($1,$2,$3,$4);
493 if ($flags !~ /^(g)?$/) {
494 &::notice($::who, "error: Invalid flags to regex.");
498 ### TODO: use m### to make code safe!
499 # todo: make code safer.
501 # todo: use eval to deal with flags easily.
503 $done++ if (!$done and $mod_news =~ s/\Q$op\E/$np/);
504 $done++ if (!$done and $mod_nnews =~ s/\Q$op\E/$np/);
505 } elsif ($flags eq "g") {
506 $done++ if ($mod_news =~ s/\Q$op\E/$np/g);
507 $done++ if ($mod_nnews =~ s/\Q$op\E/$np/g);
511 &::notice($::who, "warning: regex not found in news.");
515 if ($mod_news ne $news) { # news item.
516 if (exists $::news{$chan}{$mod_news}) {
517 &::notice($::who, "item '$mod_news' already exists.");
521 &::notice($::who, "Moving item '$news' to '$mod_news' with SAR s/$op/$np/.");
522 foreach (keys %{ $::news{$chan}{$news} }) {
523 $::news{$chan}{$mod_news}{$_} = $::news{$chan}{$news}{$_};
524 delete $::news{$chan}{$news}{$_};
527 delete $::news{$chan}{$news};
530 if ($mod_nnews ne $nnews) { # news Text/Description.
531 &::notice($::who, "Changing text for '$news' SAR s/$op/$np/.");
532 if ($mod_news ne $news) {
533 $::news{$chan}{$mod_news}{Text} = $mod_nnews;
535 $::news{$chan}{$news}{Text} = $mod_nnews;
541 &::notice($::who, "error: that regex failed ;(");
545 &::notice($::who, "error: Invalid regex. Try s/1/2/, s#3#4#...");
550 $args =~ /^(\S+)\s+(\S+)\s+(.*)$/;
551 my($item, $what, $value) = ($1,$2,$3);
553 &::DEBUG("set called.");
560 &::DEBUG("item => '$item'.");
561 my $news = &getNewsItem($item);
563 if (!defined $news) {
564 &::notice($::who, "Could not find item '$item' substring or # in news list.");
568 # list all values for chan.
569 if (!defined $what) {
575 my @elements = ("Expire","Text");
576 foreach (@elements) {
577 next unless ($what =~ /^$_$/i);
584 &::notice($::who, "Invalid set. Try: @elements");
589 if (!defined $value) {
594 if (!exists $::news{$chan}{$news}) {
595 &::notice($::who, "news '$news' does not exist");
599 if ($what eq "Expire") {
600 # todo: use do_set().
603 my $plus = ($value =~ s/^\+//g);
604 while ($value =~ s/^(\d+)(\S*)\s*//) {
605 my($int,$unit) = ($1,$2);
606 $time += $int if ($unit =~ /^s(ecs?)?$/i);
607 $time += $int*60 if ($unit =~ /^m(in(utes?)?)?$/i);
608 $time += $int*60*60 if ($unit =~ /^h(ours?)?$/i);
609 $time += $int*60*60*24 if (!$unit or $unit =~ /^d(ays?)?$/i);
610 $time += $int*60*60*24*7 if ($unit =~ /^w(eeks?)?$/i);
611 $time += $int*60*60*24*30 if ($unit =~ /^mon(th)?$/i);
614 if ($value =~ s/^never$//i) {
621 # from creation of item.
622 $time += $::news{$chan}{$news}{Time};
625 if (!$time or ($value and $value !~ /^never$/i)) {
626 &::DEBUG("set: Expire... need to parse.");
631 &::notice($::who, "Set never expire for \002$item\002." );
632 } elsif ($time < -1) {
633 &::DEBUG("time should never be negative ($time).");
636 &::notice($::who, "Set expire for \002$item\002, to ".
637 localtime($time) ." [".&::Time2String($time - time())."]" );
639 if (time() > $time) {
640 &::DEBUG("hrm... time() > $time, should expire.");
645 $::news{$chan}{$news}{Expire} = $time;
651 &::DEBUG("who => '$::who'");
652 my $author = $::news{$chan}{$news}{Author};
653 $auth++ if ($::who eq $author);
654 $auth++ if (&::IsFlag("o"));
655 if (!defined $author) {
656 &::DEBUG("news{$chan}{$news}{Author} is not defined! auth'd anyway");
657 $::news{$chan}{$news}{Author} = $::who;
663 # todo: show when it'll expire.
664 &::notice($::who, "Sorry, you cannot set items. (author $author owns it)");
668 # todo: clean this up.
669 my $old = $::news{$chan}{$news}{$what};
671 &::DEBUG("old => $old.");
673 $::news{$chan}{$news}{$what} = $value;
674 &::notice($::who, "Setting [$chan]/{$news}/<$what> to '$value'.");
678 my($tchan, $flag) = @_;
680 $chan ||= $tchan; # hack hack hack.
682 # todo: if chan = undefined, guess.
683 if (!exists $::news{$chan}) {
684 &::notice($::who, "invalid chan $chan") if ($flag);
688 my $t = $::newsuser{$chan}{$::who};
689 if (defined $t and ($t == 0 or $t == -1)) {
691 &::notice($::who, "if you want to read news, try /msg $::ident news or /msg $::ident news notify");
693 &::DEBUG("not displaying any new news for $::who");
698 my $x = &::IsChanConf("newsNotifyAll");
699 if (&::IsChanConf("newsNotifyAll") and !defined $t) {
704 &::DEBUG("something went really wrong.");
705 &::DEBUG("chan => $chan, ::chan => $::chan");
706 &::notice($::who, "something went really wrong.");
711 foreach (keys %{ $::news{$chan} }) {
712 next if (!defined $t);
713 next if ($t > $::news{$chan}{$_}{Time});
715 # don't list new items if they don't have Text.
716 if (!exists $::news{$chan}{$_}{Text}) {
717 if (time() - $::news{$chan}{$_}{Time} > 60*60*24*3) {
718 &::DEBUG("deleting news{$chan}{$_} because it was too old and had no text info.");
719 delete $::news{$chan}{$_};
728 # !scalar @new, $flag
729 if (!scalar @new and $flag) {
730 &::notice($::who, "no new news for $chan.");
734 # scalar @new, !$flag
735 my $unread = scalar @new;
736 my $total = scalar keys %{ $::news{$chan} };
738 return unless ($unread);
740 my $reply = "There are unread news in $chan ($unread unread, $total total). /msg $::ident news $::chan latest";
741 $reply .= " If you don't want further news notification, /msg $::ident news unnotify" if ($unread == $total);
742 &::notice($::who, $reply);
749 &::notice($::who, "+==== New news for \002$chan\002 ($unread new; $total total):");
751 my $t = $::newsuser{$chan}{$::who};
752 if (defined $t and $t > 1) {
753 my $timestr = &::Time2String( time() - $t );
754 &::notice($::who, "|= Last time read $timestr ago");
759 my $i = &newsS2N($_);
763 for (my $i=0; $i<=scalar(@sorted); $i++) {
764 my $news = $sorted[$i];
765 next unless (defined $news);
767 my $age = time() - $::news{$chan}{$news}{Time};
768 &::notice($::who, sprintf("\002[\002%2d\002]\002 %s",
770 # $i, $_, &::Time2String($age) ) );
773 &::notice($::who, "|= to read, do 'news read <#>' or 'news read <keyword>'");
775 # lame hack to prevent dupes if we just ignore it.
776 my $x = $::newsuser{$chan}{$::who};
777 if (defined $x and ($x == 0 or $x == -1)) {
778 &::DEBUG("not updating time for $::who. (2)");
780 $::newsuser{$chan}{$::who} = time();
791 foreach (keys %{ $::news{$chan} }) {
792 $time{ $::news{$chan}{$_}{Time} } = $_;
796 foreach (sort { $a <=> $b } keys %time) {
797 push(@items, $time{$_});
810 foreach (keys %{ $::news{$chan} }) {
811 my $t = $::news{$chan}{$_}{Time};
813 if (!defined $t or $t !~ /^\d+$/) {
814 &::DEBUG("warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
815 delete $::news{$chan}{$_};
822 foreach (sort { $a <=> $b } keys %time) {
824 return $item if ($time{$_} eq $what);
827 &::DEBUG("newsS2N($what): failed...");
835 foreach (keys %{ $::news{$chan} }) {
836 my $t = $::news{$chan}{$_}{Time};
838 if (!defined $t or $t !~ /^\d+$/) {
839 &::DEBUG("warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
840 delete $::news{$chan}{$_};
847 # number to string resolution.
848 if ($what =~ /^\d+$/) {
849 foreach (sort { $a <=> $b } keys %time) {
851 return $time{$_} if ($item == $what);
855 # partial string to full string resolution
856 # in some cases, string->number resolution.
860 foreach (sort { $a <=> $b } keys %time) {
862 # $no = $item if ($time{$_} eq $what);
863 if ($time{$_} eq $what) {
868 push(@items, $time{$_}) if ($time{$_} =~ /\Q$what\E/i);
871 if (defined $no and !@items) {
872 &::DEBUG("string->number resolution: $what->$no.");
876 if (scalar @items > 1) {
877 &::DEBUG("Multiple matches, not guessing.");
878 &::notice($::who, "Multiple matches, not guessing.");
883 &::DEBUG("gNI: part_string->full_string: $what->$items[0]");
886 &::DEBUG("gNI: No match for '$what'");
891 &::ERROR("getNewsItem: Should not happen (what = $what)");
896 my($what,$value) = @_;
898 if (!defined $chan) {
899 &::DEBUG("do_set: chan not defined.");
903 if (!defined $what or $what =~ /^\s*$/) {
904 &::DEBUG("what $what is not defined.");
907 if (!defined $value or $value =~ /^\s*$/) {
908 &::DEBUG("value $value is not defined.");
912 &::DEBUG("do_set: TODO...");
916 &::DEBUG("News: stats called.");
917 &::msg($::who, "check my logs/console.");
920 # total request count.
921 foreach $chan (keys %::news) {
922 foreach (keys %{ $::news{$chan} }) {
923 $i += $::news{$chan}{$_}{Request_Count};
926 &::DEBUG("news: stats: total request count => $i");
930 foreach $chan (keys %::newsuser) {
931 $i += $::newsuser{$chan}{$_};
933 &::DEBUG("news: stats: total user cache => $i");
936 # average latest time read.
938 foreach $chan (keys %::newsuser) {
939 $i += $t - $::newsuser{$chan}{$_};
942 &::DEBUG("news: stats: average latest time read: total time: $i");
943 &::DEBUG("... count: $j");
944 &::DEBUG(" average: ".sprintf("%.02f", $i/($j||1))." sec/user");