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);
92 } elsif ($what =~ /^list$/i) {
95 } elsif ($what =~ /^(expire|text|desc)(\s+(.*))?$/i) {
98 my($arg1,$arg2) = split(/\s+/, $3, 2);
99 &set("$arg1 $1 $arg2");
101 } elsif ($what =~ /^help(\s+(.*))?$/i) {
104 } elsif ($what =~ /^newsflush$/i) {
105 &::msg($::who, "newsflush called... check out the logs!");
108 } elsif ($what =~ /^(un)?notify$/i) {
109 my $state = ($1) ? 0 : 1;
111 # todo: don't notify even if "news" is called.
112 if (!&::IsChanConf("newsNotifyAll")) {
113 &::DEBUG("chan => $chan, ::chan => $::chan.");
114 &::notice($::who, "not available for this channel or disabled altogether.");
118 my $t = $::newsuser{$chan}{$::who};
119 if ($state) { # state = 1
120 if (defined $t and ($t == 0 or $t == -1)) {
121 &::notice($::who, "enabled notify.");
122 delete $::newsuser{$chan}{$::who};
125 &::notice($::who, "already enabled.");
128 my $x = $::newsuser{$chan}{$::who};
129 if (defined $x and ($x == 0 or $x == -1)) {
130 &::notice($::who, "notify already disabled");
133 $::newsuser{$chan}{$::who} = -1;
134 &::notice($::who, "notify is now disabled.");
138 &::DEBUG("could not parse '$what'");
139 &::notice($::who, "unknown command: $what");
144 my $file = "$::bot_base_dir/blootbot-news.txt";
145 if (! -f $file or -z $file) {
150 &::DEBUG("readNews: fileno exists, should never happen.");
161 # todo: allow commands.
163 if (/^[\s\t]+(\S+):[\s\t]+(.*)$/) {
164 if (!defined $item) {
165 &::DEBUG("!defined item, never happen!");
169 $::news{$chan}{$item}{$1} = $2;
173 # U <chan> <nick> <time>
174 if (/^U\s+(\S+)\s+(\S+)\s+(\d+)$/) {
175 $::newsuser{$1}{$2} = $3;
180 if (/^(\S+)[\s\t]+(.*)$/) {
188 my $cn = scalar(keys %::news);
189 &::status("News: Read ".
190 $ci. &::fixPlural(" item", $ci). " for ".
191 $cn. &::fixPlural(" chan", $cn). ", ".
192 $cu. &::fixPlural(" user", $cu), " cache"
193 ) if ($ci or $cn or $cu);
197 if (!scalar keys %::news and !scalar keys %::newsuser) {
198 &::VERB("wN: nothing to write.",2);
202 my $file = "$::bot_base_dir/blootbot-news.txt";
205 &::ERROR("fileno NEWS exists, should never happen.");
209 # todo: add commands to output file.
211 my($cc,$ci,$cu) = (0,0,0);
213 open(NEWS, ">$file");
214 foreach $chan (sort keys %::news) {
215 $c = scalar keys %{ $::news{$chan} };
219 foreach $item (sort keys %{ $::news{$chan} }) {
220 $c = scalar keys %{ $::news{$chan}{$item} };
224 print NEWS "$chan $item\n";
225 foreach $what (sort keys %{ $::news{$chan}{$item} }) {
226 print NEWS " $what: $::news{$chan}{$item}{$what}\n";
232 # todo: show how many users we wrote down.
233 if (&::getChanConfList("newsKeepRead")) {
234 # old users are removed in newsFlush(), perhaps it should be
237 foreach $chan (sort keys %::newsuser) {
239 foreach (sort keys %{ $::newsuser{$chan} }) {
240 print NEWS "U $chan $_ $::newsuser{$chan}{$_}\n";
248 &::status("News: Wrote $ci items for $cc chans, $cu user cache.");
254 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
259 if (length $str > 64) {
260 &::notice($::who, "That's not really an item (>64chars)");
264 if (exists $::news{$chan}{$str}{Time}) {
265 &::notice($::who, "'$str' for $chan already exists!");
269 $::news{$chan}{$str}{Time} = time();
270 my $expire = &::getChanConfDefault("newsDefaultExpire",7);
271 $::news{$chan}{$str}{Expire} = time() + $expire*60*60*24;
272 $::news{$chan}{$str}{Author} = $::who;
274 my $agestr = &::Time2String($::news{$chan}{$str}{Expire} - time() );
275 my $item = &newsS2N($str);
276 &::notice($::who, "Added '\037$str\037' at [".localtime(time).
277 "] by \002$::who\002 for item #\002$item\002.");
278 &::notice($::who, "Now do 'news text $item <your_description>'");
279 &::notice($::who, "This item will expire at \002".
280 localtime($::news{$chan}{$str}{Expire})."\002 [$agestr from now] "
290 if (!defined $what) {
295 if ($what =~ /^\d+$/) {
296 my $count = scalar keys %{ $::news{$chan} };
298 &::notice($::who, "No news for $chan.");
302 if ($what > $count or $what < 0) {
303 &::notice($::who, "$what is out of range (max $count)");
307 $item = &getNewsItem($what);
308 $what = $item; # hack hack hack.
311 $_ = &getNewsItem($what); # hack hack hack.
312 $what = $_ if (defined $_);
314 if (!exists $::news{$chan}{$what}) {
316 foreach (keys %{ $::news{$chan} }) {
317 next unless (/\Q$what\E/);
321 if (!scalar @found) {
322 &::notice($::who, "could not find $what.");
326 if (scalar @found > 1) {
327 &::notice($::who, "too many matches for $what.");
332 &::DEBUG("del: str: guessed what => $what");
336 if (exists $::news{$chan}{$what}) {
338 $auth++ if ($::who eq $::news{$chan}{$what}{Author});
339 $auth++ if (&::IsFlag("o"));
342 # todo: show when it'll expire.
343 &::notice($::who, "Sorry, you cannot remove items; just let them expire on their own.");
347 &::notice($::who, "ok, deleted '$what' from \002$chan\002...");
348 delete $::news{$chan}{$what};
350 &::notice($::who, "error: not found $what in news for $chan.");
355 if (!scalar keys %{ $::news{$chan} }) {
356 &::notice($::who, "No News for \002$chan\002.");
360 if (&::IsChanConf("newsKeepRead")) {
361 my $x = $::newsuser{$chan}{$::who};
363 if (defined $x and ($x == 0 or $x == -1)) {
364 &::DEBUG("not updating time for $::who.");
366 $::newsuser{$chan}{$::who} = time();
370 my $count = scalar keys %{ $::news{$chan} };
371 &::notice($::who, "|==== News for \002$chan\002: ($count items)");
373 foreach (keys %{ $::news{$chan} }) {
374 my $t = $::news{$chan}{$_}{Time};
375 $newest = $t if ($t > $newest);
377 my $timestr = &::Time2String(time() - $newest);
378 &::notice($::who, "|= Last updated $timestr ago.");
379 &::notice($::who, " \037Num\037 \037Item ".(" "x40)." \037");
382 foreach ( &getNewsAll() ) {
384 my $setby = $::news{$chan}{$subtopic}{Author};
386 if (!defined $subtopic) {
387 &::DEBUG("warn: subtopic == undef.");
391 # todo: show request stats aswell.
392 &::notice($::who, sprintf("\002[\002%2d\002]\002 %s",
397 &::notice($::who, "|= End of News.");
398 &::notice($::who, "use 'news read <#>' or 'news read <keyword>'");
404 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
405 &::help("news read");
409 if (!scalar keys %{ $::news{$chan} }) {
410 &::notice($::who, "No News for \002$chan\002.");
414 my $item = &getNewsItem($str);
415 if (!defined $item or !scalar keys %{ $::news{$chan}{$item} }) {
416 &::notice($::who, "No news item called '$str'");
420 if (!exists $::news{$chan}{$item}{Text}) {
421 &::notice($::who, "Someone forgot to add info to this news item");
425 my $t = localtime( $::news{$chan}{$item}{Time} );
426 my $a = $::news{$chan}{$item}{Author};
427 my $text = $::news{$chan}{$item}{Text};
428 my $num = &newsS2N($item);
429 my $rwho = $::news{$chan}{$item}{Request_By} || $::who;
430 my $rcount = $::news{$chan}{$item}{Request_Count} || 0;
432 if (length $text < $::param{maxKeySize}) {
433 &::VERB("NEWS: Possible news->factoid redirection.",2);
434 my $f = &::getFactoid($text);
437 &::VERB("NEWS: ok, $text is factoid redirection.",2);
438 $f =~ s/^<REPLY>\s*//i; # anything else?
443 $_ = $::news{$chan}{$item}{'Expire'};
446 $e = sprintf("\037%s\037 [%s from now]",
447 scalar(localtime($_)),
448 &::Time2String($_ - time())
452 &::notice($::who, "+- News \002$chan\002 #$num: $item");
453 &::notice($::who, "| Added by $a at \037$t\037");
454 &::notice($::who, "| Expire: $e") if (defined $e);
455 &::notice($::who, $text);
456 &::notice($::who, "| Requested \002$rcount\002 times, last by \002$rwho\002") if ($rcount and $rwho);
458 $::news{$chan}{$item}{'Request_By'} = $::who;
459 $::news{$chan}{$item}{'Request_Time'} = time();
460 $::news{$chan}{$item}{'Request_Count'}++;
464 my($item, $str) = split /\s+/, $_[0], 2;
466 if (!defined $item or $item eq "" or $str =~ /^\s*$/) {
471 my $news = &getNewsItem($item);
473 if (!defined $news) {
474 &::DEBUG("error: mod: news == undefined.");
477 my $nnews = $::news{$chan}{$news}{Text};
478 my $mod_news = $news;
479 my $mod_nnews = $nnews;
482 if ($str =~ m|^\s*s([/,#\|])(.+?)\1(.*?)\1([a-z]*);?\s*$|) {
483 my ($delim, $op, $np, $flags) = ($1,$2,$3,$4);
485 if ($flags !~ /^(g)?$/) {
486 &::notice($::who, "error: Invalid flags to regex.");
490 ### TODO: use m### to make code safe!
491 # todo: make code safer.
493 # todo: use eval to deal with flags easily.
495 $done++ if (!$done and $mod_news =~ s/\Q$op\E/$np/);
496 $done++ if (!$done and $mod_nnews =~ s/\Q$op\E/$np/);
497 } elsif ($flags eq "g") {
498 $done++ if ($mod_news =~ s/\Q$op\E/$np/g);
499 $done++ if ($mod_nnews =~ s/\Q$op\E/$np/g);
503 &::notice($::who, "warning: regex not found in news.");
507 if ($mod_news ne $news) { # news item.
508 if (exists $::news{$chan}{$mod_news}) {
509 &::notice($::who, "item '$mod_news' already exists.");
513 &::notice($::who, "Moving item '$news' to '$mod_news' with SAR s/$op/$np/.");
514 foreach (keys %{ $::news{$chan}{$news} }) {
515 $::news{$chan}{$mod_news}{$_} = $::news{$chan}{$news}{$_};
516 delete $::news{$chan}{$news}{$_};
519 delete $::news{$chan}{$news};
522 if ($mod_nnews ne $nnews) { # news Text/Description.
523 &::notice($::who, "Changing text for '$news' SAR s/$op/$np/.");
524 if ($mod_news ne $news) {
525 $::news{$chan}{$mod_news}{Text} = $mod_nnews;
527 $::news{$chan}{$news}{Text} = $mod_nnews;
533 &::notice($::who, "error: that regex failed ;(");
537 &::notice($::who, "error: Invalid regex. Try s/1/2/, s#3#4#...");
542 $args =~ /^(\S+)\s+(\S+)\s+(.*)$/;
543 my($item, $what, $value) = ($1,$2,$3);
545 &::DEBUG("set called.");
552 &::DEBUG("item => '$item'.");
553 my $news = &getNewsItem($item);
555 if (!defined $news) {
556 &::notice($::who, "Could not find item '$item' substring or # in news list.");
560 # list all values for chan.
561 if (!defined $what) {
567 my @elements = ("Expire","Text");
568 foreach (@elements) {
569 next unless ($what =~ /^$_$/i);
576 &::notice($::who, "Invalid set. Try: @elements");
581 if (!defined $value) {
586 if (!exists $::news{$chan}{$news}) {
587 &::notice($::who, "news '$news' does not exist");
591 if ($what eq "Expire") {
592 # todo: use do_set().
595 my $plus = ($value =~ s/^\+//g);
596 while ($value =~ s/^(\d+)(\S*)\s*//) {
597 my($int,$unit) = ($1,$2);
598 $time += $int if ($unit =~ /^s(ecs?)?$/i);
599 $time += $int*60 if ($unit =~ /^m(in(utes?)?)?$/i);
600 $time += $int*60*60 if ($unit =~ /^h(ours?)?$/i);
601 $time += $int*60*60*24 if (!$unit or $unit =~ /^d(ays?)?$/i);
602 $time += $int*60*60*24*7 if ($unit =~ /^w(eeks?)?$/i);
603 $time += $int*60*60*24*30 if ($unit =~ /^mon(th)?$/i);
606 if ($value =~ s/^never$//i) {
613 # from creation of item.
614 $time += $::news{$chan}{$news}{Time};
617 if (!$time or ($value and $value !~ /^never$/i)) {
618 &::DEBUG("set: Expire... need to parse.");
623 &::notice($::who, "Set never expire for \002$item\002." );
624 } elsif ($time < -1) {
625 &::DEBUG("time should never be negative ($time).");
628 &::notice($::who, "Set expire for \002$item\002, to ".
629 localtime($time) ." [".&::Time2String($time - time())."]" );
631 if (time() > $time) {
632 &::DEBUG("hrm... time() > $time, should expire.");
637 $::news{$chan}{$news}{Expire} = $time;
643 &::DEBUG("who => '$::who'");
644 my $author = $::news{$chan}{$news}{Author};
645 $auth++ if ($::who eq $author);
646 $auth++ if (&::IsFlag("o"));
647 if (!defined $author) {
648 &::DEBUG("news{$chan}{$news}{Author} is not defined! auth'd anyway");
649 $::news{$chan}{$news}{Author} = $::who;
655 # todo: show when it'll expire.
656 &::notice($::who, "Sorry, you cannot set items. (author $author owns it)");
660 # todo: clean this up.
661 my $old = $::news{$chan}{$news}{$what};
663 &::DEBUG("old => $old.");
665 $::news{$chan}{$news}{$what} = $value;
666 &::notice($::who, "Setting [$chan]/{$news}/<$what> to '$value'.");
670 my($tchan, $flag) = @_;
672 $chan ||= $tchan; # hack hack hack.
674 # todo: if chan = undefined, guess.
675 if (!exists $::news{$chan}) {
676 &::notice($::who, "invalid chan $chan") if ($flag);
680 my $t = $::newsuser{$chan}{$::who};
681 if (defined $t and ($t == 0 or $t == -1)) {
683 &::notice($::who, "if you want to read news, try /msg $::ident news or /msg $::ident news notify");
685 &::DEBUG("not displaying any new news for $::who");
690 my $x = &::IsChanConf("newsNotifyAll");
691 if (&::IsChanConf("newsNotifyAll") and !defined $t) {
696 &::DEBUG("something went really wrong.");
697 &::DEBUG("chan => $chan, ::chan => $::chan");
698 &::notice($::who, "something went really wrong.");
703 foreach (keys %{ $::news{$chan} }) {
704 next if (!defined $t);
705 next if ($t > $::news{$chan}{$_}{Time});
707 # don't list new items if they don't have Text.
708 if (!exists $::news{$chan}{$_}{Text}) {
709 if (time() - $::news{$chan}{$_}{Time} > 60*60*24*3) {
710 &::DEBUG("deleting news{$chan}{$_} because it was too old and had no text info.");
711 delete $::news{$chan}{$_};
720 # !scalar @new, $flag
721 if (!scalar @new and $flag) {
722 &::notice($::who, "no new news for $chan.");
726 # scalar @new, !$flag
727 my $unread = scalar @new;
728 my $total = scalar keys %{ $::news{$chan} };
730 return unless ($unread);
732 my $reply = "There are unread news in $chan ($unread unread, $total total). /msg $::ident news latest";
733 $reply .= " If you don't want further news notification, /msg $::ident news unnotify" if ($unread == $total);
734 &::notice($::who, $reply);
741 &::notice($::who, "+==== New news for \002$chan\002 ($unread new; $total total):");
743 my $t = $::newsuser{$chan}{$::who};
744 if (defined $t and $t > 1) {
745 my $timestr = &::Time2String( time() - $t );
746 &::notice($::who, "|= Last time read $timestr ago");
751 my $i = &newsS2N($_);
755 for (my $i=0; $i<=scalar(@sorted); $i++) {
756 my $news = $sorted[$i];
757 next unless (defined $news);
759 my $age = time() - $::news{$chan}{$news}{Time};
760 &::notice($::who, sprintf("\002[\002%2d\002]\002 %s",
762 # $i, $_, &::Time2String($age) ) );
765 &::notice($::who, "|= to read, do 'news read <#>' or 'news read <keyword>'");
767 # lame hack to prevent dupes if we just ignore it.
768 my $x = $::newsuser{$chan}{$::who};
769 if (defined $x and ($x == 0 or $x == -1)) {
770 &::DEBUG("not updating time for $::who. (2)");
772 $::newsuser{$chan}{$::who} = time();
783 foreach (keys %{ $::news{$chan} }) {
784 $time{ $::news{$chan}{$_}{Time} } = $_;
788 foreach (sort { $a <=> $b } keys %time) {
789 push(@items, $time{$_});
802 foreach (keys %{ $::news{$chan} }) {
803 my $t = $::news{$chan}{$_}{Time};
805 if (!defined $t or $t !~ /^\d+$/) {
806 &::DEBUG("warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
807 delete $::news{$chan}{$_};
814 foreach (sort { $a <=> $b } keys %time) {
816 return $item if ($time{$_} eq $what);
819 &::DEBUG("newsS2N($what): failed...");
827 foreach (keys %{ $::news{$chan} }) {
828 my $t = $::news{$chan}{$_}{Time};
830 if (!defined $t or $t !~ /^\d+$/) {
831 &::DEBUG("warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
832 delete $::news{$chan}{$_};
839 # number to string resolution.
840 if ($what =~ /^\d+$/) {
841 foreach (sort { $a <=> $b } keys %time) {
843 return $time{$_} if ($item == $what);
847 # partial string to full string resolution
848 # in some cases, string->number resolution.
852 foreach (sort { $a <=> $b } keys %time) {
854 # $no = $item if ($time{$_} eq $what);
855 if ($time{$_} eq $what) {
860 push(@items, $time{$_}) if ($time{$_} =~ /\Q$what\E/i);
863 if (defined $no and !@items) {
864 &::DEBUG("string->number resolution: $what->$no.");
868 if (scalar @items > 1) {
869 &::DEBUG("Multiple matches, not guessing.");
870 &::notice($::who, "Multiple matches, not guessing.");
875 &::DEBUG("gNI: part_string->full_string: $what->$items[0]");
878 &::DEBUG("gNI: No match for '$what'");
883 &::ERROR("getNewsItem: Should not happen (what = $what)");
888 my($what,$value) = @_;
890 if (!defined $chan) {
891 &::DEBUG("do_set: chan not defined.");
895 if (!defined $what or $what =~ /^\s*$/) {
896 &::DEBUG("what $what is not defined.");
899 if (!defined $value or $value =~ /^\s*$/) {
900 &::DEBUG("value $value is not defined.");
904 &::DEBUG("do_set: TODO...");