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 &::DEBUG("read shortcut called.");
86 } elsif ($what =~ /^read(\s+(.*))?$/i) {
89 } elsif ($what =~ /^(latest|new)(\s+(.*))?$/i) {
90 &latest($3 || $chan, 1);
92 } elsif ($what =~ /^list$/i) {
93 &::DEBUG("list longcut called.");
96 } elsif ($what =~ /^(expire|text|desc)(\s+(.*))?$/i) {
99 my($arg1,$arg2) = split(/\s+/, $3, 2);
100 &set("$arg1 $1 $arg2");
102 } elsif ($what =~ /^help(\s+(.*))?$/i) {
105 } elsif ($what =~ /^(un)?notify$/i) {
106 my $state = ($1) ? 0 : 1;
108 # todo: don't notify even if "news" is called.
109 if (!&::IsChanConf("newsNotifyAll")) {
110 &::DEBUG("chan => $chan, ::chan => $::chan.");
111 &::notice($::who, "not available for this channel or disabled altogether.");
115 my $t = $::newsuser{$chan}{$::who};
116 if ($state) { # state = 1
117 if (defined $t and ($t == 0 or $t == -1)) {
118 &::notice($::who, "enabled notify.");
119 delete $::newsuser{$chan}{$::who};
122 &::notice($::who, "already enabled.");
125 my $x = $::newsuser{$chan}{$::who};
126 if (defined $x and ($x == 0 or $x == -1)) {
127 &::notice($::who, "notify already disabled");
130 $::newsuser{$chan}{$::who} = -1;
131 &::notice($::who, "notify is now disabled.");
135 &::DEBUG("could not parse '$what'.");
136 &::notice($::who, "unknown command: $what");
141 my $file = "$::bot_base_dir/blootbot-news.txt";
142 if (! -f $file or -z $file) {
147 &::DEBUG("readNews: fileno exists, should never happen.");
158 # todo: allow commands.
160 if (/^[\s\t]+(\S+):[\s\t]+(.*)$/) {
161 if (!defined $item) {
162 &::DEBUG("!defined item, never happen!");
166 $::news{$chan}{$item}{$1} = $2;
170 # U <chan> <nick> <time>
171 if (/^U\s+(\S+)\s+(\S+)\s+(\d+)$/) {
172 $::newsuser{$1}{$2} = $3;
177 if (/^(\S+)[\s\t]+(.*)$/) {
185 my $cn = scalar(keys %::news);
186 &::status("News: Read $ci items for $cn chans, $cu users cache")
187 if ($ci or $cn or $cu);
191 if (!scalar keys %::news and !scalar keys %::newsuser) {
192 &::VERB("wN: nothing to write.",2);
196 my $file = "$::bot_base_dir/blootbot-news.txt";
199 &::ERROR("fileno NEWS exists, should never happen.");
203 # todo: add commands to output file.
205 my($cc,$ci,$cu) = (0,0,0);
207 open(NEWS, ">$file");
208 foreach $chan (sort keys %::news) {
209 $c = scalar keys %{ $::news{$chan} };
213 foreach $item (sort keys %{ $::news{$chan} }) {
214 $c = scalar keys %{ $::news{$chan}{$item} };
218 print NEWS "$chan $item\n";
219 foreach $what (sort keys %{ $::news{$chan}{$item} }) {
220 print NEWS " $what: $::news{$chan}{$item}{$what}\n";
226 # todo: show how many users we wrote down.
227 if (&::getChanConfList("newsKeepRead")) {
228 # old users are removed in newsFlush(), perhaps it should be
231 foreach $chan (sort keys %::newsuser) {
233 foreach (sort keys %{ $::newsuser{$chan} }) {
234 print NEWS "U $chan $_ $::newsuser{$chan}{$_}\n";
242 &::status("News: Wrote $ci items for $cc chans, $cu user cache.");
248 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
253 if (length $str > 64) {
254 &::notice($::who, "That's not really an item (>64chars)");
258 if (exists $::news{$chan}{$str}{Time}) {
259 &::notice($::who, "'$str' for $chan already exists!");
263 $::news{$chan}{$str}{Time} = time();
264 my $expire = &::getChanConfDefault("newsDefaultExpire",7);
265 $::news{$chan}{$str}{Expire} = time() + $expire*60*60*24;
266 $::news{$chan}{$str}{Author} = $::who;
268 my $agestr = &::Time2String($::news{$chan}{$str}{Expire} - time() );
269 my $item = &newsS2N($str);
270 &::notice($::who, "Added '\037$str\037' at [".localtime(time).
271 "] by \002$::who\002 for item #\002$item\002.");
272 &::notice($::who, "Now do 'news text $item <your_description>'");
273 &::notice($::who, "This item will expire at \002".
274 localtime($::news{$chan}{$str}{Expire})."\002 [$agestr from now] "
284 if (!defined $what) {
289 if ($what =~ /^\d+$/) {
290 my $count = scalar keys %{ $::news{$chan} };
292 &::notice($::who, "No news for $chan.");
296 if ($what > $count or $what < 0) {
297 &::notice($::who, "$what is out of range (max $count)");
301 $item = &getNewsItem($what);
302 $what = $item; # hack hack hack.
305 $_ = &getNewsItem($what); # hack hack hack.
306 $what = $_ if (defined $_);
308 if (!exists $::news{$chan}{$what}) {
310 foreach (keys %{ $::news{$chan} }) {
311 next unless (/\Q$what\E/);
315 if (!scalar @found) {
316 &::notice($::who, "could not find $what.");
320 if (scalar @found > 1) {
321 &::notice($::who, "too many matches for $what.");
326 &::DEBUG("del: str: guessed what => $what");
330 if (exists $::news{$chan}{$what}) {
332 $auth++ if ($::who eq $::news{$chan}{$what}{Author});
333 $auth++ if (&::IsFlag("o"));
336 # todo: show when it'll expire.
337 &::notice($::who, "Sorry, you cannot remove items; just let them expire on their own.");
341 &::notice($::who, "ok, deleted '$what' from \002$chan\002...");
342 delete $::news{$chan}{$what};
344 &::notice($::who, "error: not found $what in news for $chan.");
349 if (!scalar keys %{ $::news{$chan} }) {
350 &::notice($::who, "No News for \002$chan\002.");
354 if (&::IsChanConf("newsKeepRead")) {
355 my $x = $::newsuser{$chan}{$::who};
357 if (defined $x and ($x == 0 or $x == -1)) {
358 &::DEBUG("not updating time for $::who.");
360 $::newsuser{$chan}{$::who} = time();
364 my $count = scalar keys %{ $::news{$chan} };
365 &::notice($::who, "|==== News for \002$chan\002: ($count items)");
367 foreach (keys %{ $::news{$chan} }) {
368 my $t = $::news{$chan}{$_}{Time};
369 $newest = $t if ($t > $newest);
371 my $timestr = &::Time2String(time() - $newest);
372 &::notice($::who, "|= Last updated $timestr ago.");
373 &::notice($::who, " \037Num\037 \037Item ".(" "x40)." \037");
376 foreach ( &getNewsAll() ) {
378 my $setby = $::news{$chan}{$subtopic}{Author};
380 if (!defined $subtopic) {
381 &::DEBUG("warn: subtopic == undef.");
385 # todo: show request stats aswell.
386 &::notice($::who, sprintf("\002[\002%2d\002]\002 %s",
391 &::notice($::who, "|= End of News.");
392 &::notice($::who, "use 'news read <#>' or 'news read <keyword>'");
398 if (!defined $chan or !defined $str or $str =~ /^\s*$/) {
399 &::help("news read");
403 if (!scalar keys %{ $::news{$chan} }) {
404 &::notice($::who, "No News for \002$chan\002.");
408 my $item = &getNewsItem($str);
409 if (!defined $item or !scalar keys %{ $::news{$chan}{$item} }) {
410 &::notice($::who, "No news item called '$str'");
414 if (!exists $::news{$chan}{$item}{Text}) {
415 &::notice($::who, "Someone forgot to add info to this news item");
419 my $t = localtime( $::news{$chan}{$item}{Time} );
420 my $a = $::news{$chan}{$item}{Author};
421 my $text = $::news{$chan}{$item}{Text};
422 my $num = &newsS2N($item);
423 my $rwho = $::news{$chan}{$item}{Request_By} || $::who;
424 my $rcount = $::news{$chan}{$item}{Request_Count} || 0;
426 if (length $text < $::param{maxKeySize}) {
427 &::VERB("NEWS: Possible news->factoid redirection.",2);
428 my $f = &::getFactoid($text);
431 &::VERB("NEWS: ok, $text is factoid redirection.",2);
432 $f =~ s/^<REPLY>\s*//i; # anything else?
437 $_ = $::news{$chan}{$item}{'Expire'};
440 $e = sprintf("\037%s\037 [%s from now]",
441 scalar(localtime($_)),
442 &::Time2String($_ - time())
446 &::notice($::who, "+- News \002$chan\002 #$num: \037$item\037");
447 &::notice($::who, "| Added by $a at \037$t\037");
448 &::notice($::who, "| Expire: $e") if (defined $e);
449 &::notice($::who, $text);
450 &::notice($::who, "| Requested \002$rcount\002 times, last by \002$rwho\002") if ($rcount and $rwho);
452 $::news{$chan}{$item}{'Request_By'} = $::who;
453 $::news{$chan}{$item}{'Request_Time'} = time();
454 $::news{$chan}{$item}{'Request_Count'}++;
458 my($item, $str) = split /\s+/, $_[0], 2;
460 if (!defined $item or $item eq "" or $str =~ /^\s*$/) {
465 my $news = &getNewsItem($item);
467 if (!defined $news) {
468 &::DEBUG("error: mod: news == undefined.");
471 my $nnews = $::news{$chan}{$news}{Text};
472 my $mod_news = $news;
473 my $mod_nnews = $nnews;
476 if ($str =~ m|^\s*s([/,#\|])(.+?)\1(.*?)\1([a-z]*);?\s*$|) {
477 my ($delim, $op, $np, $flags) = ($1,$2,$3,$4);
479 if ($flags !~ /^(g)?$/) {
480 &::notice($::who, "error: Invalid flags to regex.");
484 ### TODO: use m### to make code safe!
485 # todo: make code safer.
487 # todo: use eval to deal with flags easily.
489 $done++ if (!$done and $mod_news =~ s/\Q$op\E/$np/);
490 $done++ if (!$done and $mod_nnews =~ s/\Q$op\E/$np/);
491 } elsif ($flags eq "g") {
492 $done++ if ($mod_news =~ s/\Q$op\E/$np/g);
493 $done++ if ($mod_nnews =~ s/\Q$op\E/$np/g);
497 &::notice($::who, "warning: regex not found in news.");
501 if ($mod_news ne $news) { # news item.
502 if (exists $::news{$chan}{$mod_news}) {
503 &::notice($::who, "item '$mod_news' already exists.");
507 &::notice($::who, "Moving item '$news' to '$mod_news' with SAR s/$op/$np/.");
508 foreach (keys %{ $::news{$chan}{$news} }) {
509 $::news{$chan}{$mod_news}{$_} = $::news{$chan}{$news}{$_};
510 delete $::news{$chan}{$news}{$_};
513 delete $::news{$chan}{$news};
516 if ($mod_nnews ne $nnews) { # news Text/Description.
517 &::notice($::who, "Changing text for '$news' SAR s/$op/$np/.");
518 if ($mod_news ne $news) {
519 $::news{$chan}{$mod_news}{Text} = $mod_nnews;
521 $::news{$chan}{$news}{Text} = $mod_nnews;
527 &::notice($::who, "error: that regex failed ;(");
531 &::notice($::who, "error: Invalid regex. Try s/1/2/, s#3#4#...");
536 $args =~ /^(\S+)\s+(\S+)\s+(.*)$/;
537 my($item, $what, $value) = ($1,$2,$3);
539 &::DEBUG("set called.");
546 &::DEBUG("item => '$item'.");
547 my $news = &getNewsItem($item);
549 if (!defined $news) {
550 &::notice($::who, "Could not find item '$item' substring or # in news list.");
554 # list all values for chan.
555 if (!defined $what) {
561 my @elements = ("Expire","Text");
562 foreach (@elements) {
563 next unless ($what =~ /^$_$/i);
570 &::notice($::who, "Invalid set. Try: @elements");
575 if (!defined $value) {
580 if (!exists $::news{$chan}{$news}) {
581 &::notice($::who, "news '$news' does not exist");
585 if ($what eq "Expire") {
586 # todo: use do_set().
589 my $plus = ($value =~ s/^\+//g);
590 while ($value =~ s/^(\d+)(\S*)\s*//) {
591 my($int,$unit) = ($1,$2);
592 $time += $int if ($unit =~ /^s(ecs?)?$/i);
593 $time += $int*60 if ($unit =~ /^m(in(utes?)?)?$/i);
594 $time += $int*60*60 if ($unit =~ /^h(ours?)?$/i);
595 $time += $int*60*60*24 if (!$unit or $unit =~ /^d(ays?)?$/i);
596 $time += $int*60*60*24*7 if ($unit =~ /^w(eeks?)?$/i);
597 $time += $int*60*60*24*30 if ($unit =~ /^mon(th)?$/i);
600 if ($value =~ s/^never$//i) {
607 # from creation of item.
608 $time += $::news{$chan}{$news}{Time};
611 if (!$time or ($value and $value !~ /^never$/i)) {
612 &::DEBUG("set: Expire... need to parse.");
617 &::notice($::who, "Set never expire for \002$item\002." );
618 } elsif ($time < -1) {
619 &::DEBUG("time should never be negative ($time).");
622 &::notice($::who, "Set expire for \002$item\002, to ".
623 localtime($time) ." [".&::Time2String($time - time())."]" );
625 if (time() > $time) {
626 &::DEBUG("hrm... time() > $time, should expire.");
631 $::news{$chan}{$news}{Expire} = $time;
637 &::DEBUG("who => '$::who'");
638 my $author = $::news{$chan}{$news}{Author};
639 $auth++ if ($::who eq $author);
640 $auth++ if (&::IsFlag("o"));
641 if (!defined $author) {
642 &::DEBUG("news{$chan}{$news}{Author} is not defined! auth'd anyway");
643 $::news{$chan}{$news}{Author} = $::who;
649 # todo: show when it'll expire.
650 &::notice($::who, "Sorry, you cannot set items. (author $author owns it)");
654 # todo: clean this up.
655 my $old = $::news{$chan}{$news}{$what};
657 &::DEBUG("old => $old.");
659 $::news{$chan}{$news}{$what} = $value;
660 &::notice($::who, "Setting [$chan]/{$news}/<$what> to '$value'.");
664 my($tchan, $flag) = @_;
666 $chan ||= $tchan; # hack hack hack.
668 # todo: if chan = undefined, guess.
669 if (!exists $::news{$chan}) {
670 &::notice($::who, "invalid chan $chan") if ($flag);
674 my $t = $::newsuser{$chan}{$::who};
675 if (defined $t and ($t == 0 or $t == -1)) {
677 &::notice($::who, "if you want to read news, try /msg $::ident news or /msg $::ident news notify");
679 &::DEBUG("not displaying any new news for $::who");
684 my $x = &::IsChanConf("newsNotifyAll");
685 if (&::IsChanConf("newsNotifyAll") and !defined $t) {
690 &::DEBUG("something went really wrong.");
691 &::DEBUG("chan => $chan, ::chan => $::chan");
692 &::notice($::who, "something went really wrong.");
697 foreach (keys %{ $::news{$chan} }) {
698 next if (!defined $t);
699 next if ($t > $::news{$chan}{$_}{Time});
701 # don't list new items if they don't have Text.
702 if (!exists $::news{$chan}{$_}{Text}) {
703 if (time() - $::news{$chan}{$_}{Time} > 60*60*24*3) {
704 &::DEBUG("deleting news{$chan}{$_} because it was too old and had no text info.");
705 delete $::news{$chan}{$_};
707 &::WARN("news: news{$chan}{$_}{Text} undef.");
716 # !scalar @new, $flag
717 if (!scalar @new and $flag) {
718 &::notice($::who, "no new news for $chan.");
722 # scalar @new, !$flag
723 my $unread = scalar @new;
724 my $total = scalar keys %{ $::news{$chan} };
726 return unless ($unread);
728 my $reply = "There are unread news in $chan ($unread unread, $total total). /msg $::ident news latest.";
729 $reply .= " If you don't want further news notification, /msg $::ident news unnotify" if ($unread == $total);
730 &::notice($::who, $reply);
737 &::notice($::who, "+==== New news for \002$chan\002 ($unread new; $total total):");
739 my $t = $::newsuser{$chan}{$::who};
740 if (defined $t and $t > 1) {
741 my $timestr = &::Time2String( time() - $t );
742 &::notice($::who, "|= Last time read $timestr ago");
747 my $i = &newsS2N($_);
751 for (my $i=0; $i<=scalar(@sorted); $i++) {
752 my $news = $sorted[$i];
753 next unless (defined $news);
755 my $age = time() - $::news{$chan}{$news}{Time};
756 &::notice($::who, sprintf("\002[\002%2d\002]\002 %s",
758 # $i, $_, &::Time2String($age) ) );
761 &::notice($::who, "|= to read, do 'news read <#>' or 'news read <keyword>'");
763 # lame hack to prevent dupes if we just ignore it.
764 my $x = $::newsuser{$chan}{$::who};
765 if (defined $x and ($x == 0 or $x == -1)) {
766 &::DEBUG("not updating time for $::who. (2)");
768 $::newsuser{$chan}{$::who} = time();
779 foreach (keys %{ $::news{$chan} }) {
780 $time{ $::news{$chan}{$_}{Time} } = $_;
784 foreach (sort { $a <=> $b } keys %time) {
785 push(@items, $time{$_});
798 foreach (keys %{ $::news{$chan} }) {
799 my $t = $::news{$chan}{$_}{Time};
801 if (!defined $t or $t !~ /^\d+$/) {
802 &::DEBUG("warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
803 delete $::news{$chan}{$_};
810 foreach (sort { $a <=> $b } keys %time) {
812 return $item if ($time{$_} eq $what);
815 &::DEBUG("newsS2N($what): failed...");
823 foreach (keys %{ $::news{$chan} }) {
824 my $t = $::news{$chan}{$_}{Time};
826 if (!defined $t or $t !~ /^\d+$/) {
827 &::DEBUG("warn: t is undefined for news{$chan}{$_}{Time}; removing item.");
828 delete $::news{$chan}{$_};
835 # number to string resolution.
836 if ($what =~ /^\d+$/) {
837 foreach (sort { $a <=> $b } keys %time) {
839 return $time{$_} if ($item == $what);
843 # partial string to full string resolution
844 # in some cases, string->number resolution.
848 foreach (sort { $a <=> $b } keys %time) {
850 # $no = $item if ($time{$_} eq $what);
851 if ($time{$_} eq $what) {
856 push(@items, $time{$_}) if ($time{$_} =~ /\Q$what\E/i);
859 if (defined $no and !@items) {
860 &::DEBUG("string->number resolution: $what->$no.");
864 if (scalar @items > 1) {
865 &::DEBUG("Multiple matches, not guessing.");
866 &::notice($::who, "Multiple matches, not guessing.");
871 &::DEBUG("gNI: part_string->full_string: $what->$items[0]");
874 &::DEBUG("gNI: No match.");
879 &::ERROR("getNewsItem: Should not happen (what = $what)");
884 my($what,$value) = @_;
886 if (!defined $chan) {
887 &::DEBUG("do_set: chan not defined.");
891 if (!defined $what or $what =~ /^\s*$/) {
892 &::DEBUG("what $what is not defined.");
895 if (!defined $value or $value =~ /^\s*$/) {
896 &::DEBUG("value $value is not defined.");
900 &::DEBUG("do_set: TODO...");