#
# News.pl: Advanced news management
# Author: dms
-# Version: v0.3 (20014012)
+# Version: v0.3 (20010412)
# Created: 20010326
# Notes: Testing done by greycat, kudos!
#
# Text - Actual text.
###
-use vars qw($who);
-
package News;
+use strict;
+
+use vars qw($who $chan);
+
sub Parse {
my($what) = @_;
$chan = undef;
}
if ($::msgType ne "private") {
- $chan = $::chan;
+ if ($who =~ /^#/){
+ &::msg($who, "I'm not noticing the entire channel. /msg me instead");
+ return;
+ }
+ &::notice($who, "I'm not noticing the entire channel. /msg me instead");
+ return;
}
if (defined $what and $what =~ s/^($::mask{chan})\s*//) {
- # todo: check if the channel exists aswell.
+ # TODO: check if the channel exists aswell.
$chan = lc $1;
if (!&::IsNickInChan($who, $chan)) {
- &::notice($::who, "sorry but you're not on $chan.");
+ &::notice($who, "sorry but you're not on $chan.");
return;
}
}
if (!defined $chan) {
- my @chans = &::getNickInChans($::who);
+ my @chans = &::getNickInChans($who);
if (scalar @chans > 1) {
- &::notice($::who, "error: I dunno which channel you are referring to since you're on more than one. Try 'news #chan ...' instead");
+ &::notice($who, "error: I dunno which channel you are referring to since you're on more than one. Try 'news #chan ...' instead");
return;
}
if (scalar @chans == 0) {
- &::notice($::who, "error: I couldn't find you on any chan. This must be a bug!");
+ &::notice($who, "error: I couldn't find you on any chan. This must be a bug!");
return;
}
$chan = $chans[0];
- &::VERB("Guessed $::who being on chan $chan",2);
+ &::VERB("Guessed $who being on chan $chan",2);
$::chan = $chan; # hack for IsChanConf().
}
} elsif ($what =~ /^(expire|text|desc)(\s+(.*))?$/i) {
# shortcut/link.
# nice hack.
+ my $cmd = $1;
my($arg1,$arg2) = split(/\s+/, $3, 2);
- &set("$arg1 $1 $arg2");
+ &set("$arg1 $cmd $arg2");
} elsif ($what =~ /^help(\s+(.*))?$/i) {
- &::help("news$1");
+ &::help("news $2");
} elsif ($what =~ /^newsflush$/i) {
- &::msg($::who, "newsflush called... check out the logs!");
+ &::msg($who, "newsflush called... check out the logs!");
&::newsFlush();
} elsif ($what =~ /^(un)?notify$/i) {
my $state = ($1) ? 0 : 1;
- # todo: don't notify even if "news" is called.
- if (!&::IsChanConf("newsNotifyAll")) {
+ # TODO: don't notify even if "News" is called.
+ if (&::IsChanConf("newsNotifyAll") <= 0) {
&::DEBUG("news: chan => $chan, ::chan => $::chan.");
- &::notice($::who, "not available for this channel or disabled altogether.");
+ &::notice($who, "not available for this channel or disabled altogether.");
return;
}
my $t = $::newsuser{$chan}{$who};
if ($state) { # state = 1
if (defined $t and ($t == 0 or $t == -1)) {
- &::notice($::who, "enabled notify.");
+ &::notice($who, "enabled notify.");
delete $::newsuser{$chan}{$who};
return;
}
- &::notice($::who, "already enabled.");
+ &::notice($who, "already enabled.");
} else { # state = 0
my $x = $::newsuser{$chan}{$who};
if (defined $x and ($x == 0 or $x == -1)) {
- &::notice($::who, "notify already disabled");
+ &::notice($who, "notify already disabled");
return;
}
$::newsuser{$chan}{$who} = -1;
- &::notice($::who, "notify is now disabled.");
+ &::notice($who, "notify is now disabled.");
}
} else {
- &::notice($::who, "unknown command: $what");
+ &::notice($who, "unknown command: $what");
}
}
while (<NEWS>) {
chop;
- # todo: allow commands.
+ # TODO: allow commands.
if (/^[\s\t]+(\S+):[\s\t]+(.*)$/) {
if (!defined $item) {
close NEWS;
my $cn = scalar(keys %::news);
- &::status("News: Read ".
+ return unless ($ci or $cn or $cu);
+
+ &::status("News: read ".
$ci. &::fixPlural(" item", $ci). " for ".
$cn. &::fixPlural(" chan", $cn). ", ".
$cu. &::fixPlural(" user", $cu), " cache"
- ) if ($ci or $cn or $cu);
+ );
}
sub writeNews {
return;
}
+ # should define this at the top of file.
my $file = "$::bot_base_dir/blootbot-news.txt";
if (fileno NEWS) {
- &::ERROR("fileno NEWS exists, should never happen.");
+ &::ERROR("News: write: fileno NEWS exists, should never happen.");
return;
}
- # todo: add commands to output file.
+ # TODO: add commands to output file.
my $c = 0;
my($cc,$ci,$cu) = (0,0,0);
$c = scalar keys %{ $::news{$chan} };
next unless ($c);
$cc++;
+ my $item;
foreach $item (sort keys %{ $::news{$chan} }) {
$c = scalar keys %{ $::news{$chan}{$item} };
$ci++;
print NEWS "$chan $item\n";
+ my $what;
foreach $what (sort keys %{ $::news{$chan}{$item} }) {
print NEWS " $what: $::news{$chan}{$item}{$what}\n";
}
}
}
- # todo: show how many users we wrote down.
+ # TODO: show how many users we wrote down.
if (&::getChanConfList("newsKeepRead")) {
# old users are removed in newsFlush(), perhaps it should be
# done here.
}
if (length $str > 64) {
- &::notice($::who, "That's not really an item (>64chars)");
+ &::notice($who, "That's not really an item (>64chars)");
return;
}
if (exists $::news{$chan}{$str}{Time}) {
- &::notice($::who, "'$str' for $chan already exists!");
+ &::notice($who, "'$str' for $chan already exists!");
return;
}
$::news{$chan}{$str}{Time} = time();
- my $expire = &::getChanConfDefault("newsDefaultExpire",7);
+ my $expire = &::getChanConfDefault("newsDefaultExpire",7, $chan);
$::news{$chan}{$str}{Expire} = time() + $expire*60*60*24;
- $::news{$chan}{$str}{Author} = $::who;
+ $::news{$chan}{$str}{Author} = $::who; # case!
my $agestr = &::Time2String($::news{$chan}{$str}{Expire} - time() );
my $item = &newsS2N($str);
- &::notice($::who, "Added '\037$str\037' at [".localtime(time).
+ &::notice($who, "Added '\037$str\037' at [".gmtime(time).
"] by \002$::who\002 for item #\002$item\002.");
- &::notice($::who, "Now do 'news text $item <your_description>'");
- &::notice($::who, "This item will expire at \002".
- localtime($::news{$chan}{$str}{Expire})."\002 [$agestr from now] "
+ &::notice($who, "Now do 'news text $item <your_description>'");
+ &::notice($who, "This item will expire at \002".
+ gmtime($::news{$chan}{$str}{Expire})."\002 [$agestr from now] "
);
&writeNews();
if ($what =~ /^\d+$/) {
my $count = scalar keys %{ $::news{$chan} };
if (!$count) {
- &::notice($::who, "No news for $chan.");
+ &::notice($who, "No news for $chan.");
return;
}
if ($what > $count or $what < 0) {
- &::notice($::who, "$what is out of range (max $count)");
+ &::notice($who, "$what is out of range (max $count)");
return;
}
}
if (!scalar @found) {
- &::notice($::who, "could not find $what.");
+ &::notice($who, "could not find $what.");
return;
}
if (scalar @found > 1) {
- &::notice($::who, "too many matches for $what.");
+ &::notice($who, "too many matches for $what.");
return;
}
$auth++ if (&::IsFlag("o"));
if (!$auth) {
- # todo: show when it'll expire.
- &::notice($::who, "Sorry, you cannot remove items; just let them expire on their own.");
+ # TODO: show when it'll expire.
+ &::notice($who, "Sorry, you cannot remove items; just let them expire on their own.");
return;
}
- &::notice($::who, "ok, deleted '$what' from \002$chan\002...");
+ &::notice($who, "ok, deleted '$what' from \002$chan\002...");
delete $::news{$chan}{$what};
} else {
- &::notice($::who, "error: not found $what in news for $chan.");
+ &::notice($who, "error: not found $what in news for $chan.");
}
}
sub list {
if (!scalar keys %{ $::news{$chan} }) {
- &::notice($::who, "No News for \002$chan\002.");
+ &::notice($who, "No news for \002$chan\002.");
return;
}
- if (&::IsChanConf("newsKeepRead")) {
+ if (&::IsChanConf("newsKeepRead") > 0) {
my $x = $::newsuser{$chan}{$who};
if (defined $x and ($x == 0 or $x == -1)) {
- &::DEBUG("news: not updating time for $::who.");
+ &::DEBUG("news: not updating time for $who.");
} else {
if (!scalar keys %{ $::news{$chan} }) {
- &::DEBUG("news: should not add $chan/$::who to cache!");
+ &::DEBUG("news: should not add $chan/$who to cache!");
}
$::newsuser{$chan}{$who} = time();
# ¬ice() breaks OPN :( - using msg() instead!
my $count = scalar keys %{ $::news{$chan} };
- &::msg($::who, "|==== News for \002$chan\002: ($count items)");
+ &::msg($who, "|==== News for \002$chan\002: ($count items)");
my $newest = 0;
+ my $expire = 0;
+ my $eno = 0;
foreach (keys %{ $::news{$chan} }) {
my $t = $::news{$chan}{$_}{Time};
+ my $e = $::news{$chan}{$_}{Expire};
$newest = $t if ($t > $newest);
+ if ($e > 1 and $e < $expire) {
+ $expire = $e;
+ &::DEBUG("before newsS2N($_)");
+ $eno = &newsS2N($_);
+ &::DEBUG("after newsS2N($_) == $eno");
+ }
}
my $timestr = &::Time2String(time() - $newest);
- &::msg($::who, "|= Last updated $timestr ago.");
- &::msg($::who, " \037Num\037 \037Item ".(" "x40)." \037");
+ &::msg($who, "|= Last updated $timestr ago.");
+ &::msg($who, " \037Num\037 \037Item ".(" "x40)." \037");
+
+# &::DEBUG("news: list: expire = $expire");
+# &::DEBUG("news: list: eno = $eno");
my $i = 1;
foreach ( &getNewsAll() ) {
next;
}
- # todo: show request stats aswell.
- &::msg($::who, sprintf("\002[\002%2d\002]\002%s %s",
+ # TODO: show request stats aswell.
+ &::msg($who, sprintf("\002[\002%2d\002]\002%s %s",
$i, $chr, $subtopic));
$i++;
}
- my $z = $::newsuser{$::who};
+ my $z = $::newsuser{$who};
if (defined $z) {
- &::DEBUG("cache $::who: $z");
+ &::DEBUG("cache $who: $z");
} else {
- &::DEBUG("cache: $::who doesn't have newscache set.");
+ &::DEBUG("cache: $who doesn't have newscache set.");
}
- &::msg($::who, "|= End of News.");
- &::msg($::who, "use 'news read <#>' or 'news read <keyword>'");
+ &::msg($who, "|= End of News.");
+ &::msg($who, "use 'news read <#>' or 'news read <keyword>'");
}
sub read {
}
if (!scalar keys %{ $::news{$chan} }) {
- &::notice($::who, "No News for \002$chan\002.");
+ &::notice($who, "No news for \002$chan\002.");
return;
}
my $item = &getNewsItem($str);
if (!defined $item or !scalar keys %{ $::news{$chan}{$item} }) {
- &::notice($::who, "No news item called '$str'");
+ # TODO: numerical check.
+ if ($str =~ /^(\d+)[-, ](\d+)$/ or
+ $str =~ /^-(\d+)$/ or
+ $str =~ /^(\d+)-$/ or 0
+ ) {
+ &::notice($who, "We don't support multiple requests of news items yet. Sorry.");
+ return;
+ }
+
+ &::notice($who, "No news item called '$str'");
return;
}
if (!exists $::news{$chan}{$item}{Text}) {
- &::notice($::who, "Someone forgot to add info to this news item");
+ &::notice($who, "Someone forgot to add info to this news item");
return;
}
- my $t = localtime( $::news{$chan}{$item}{Time} );
+ my $t = gmtime( $::news{$chan}{$item}{Time} );
my $a = $::news{$chan}{$item}{Author};
my $text = $::news{$chan}{$item}{Text};
my $num = &newsS2N($item);
my $e;
if ($_) {
$e = sprintf("\037%s\037 [%s from now]",
- scalar(localtime($_)),
+ scalar(gmtime($_)),
&::Time2String($_ - time())
);
}
- &::notice($::who, "+- News \002$chan\002 #$num: $item");
- &::notice($::who, "| Added by $a at \037$t\037");
- &::notice($::who, "| Expire: $e") if (defined $e);
- &::notice($::who, $text);
- &::notice($::who, "| Requested \002$rcount\002 times, last by \002$rwho\002") if ($rcount and $rwho);
+ &::notice($who, "+- News \002$chan\002 #$num: $item");
+ &::notice($who, "| Added by $a at \037$t\037");
+ &::notice($who, "| Expire: $e") if (defined $e);
+ &::notice($who, $text);
+ &::notice($who, "| Requested \002$rcount\002 times, last by \002$rwho\002") if ($rcount and $rwho);
$::news{$chan}{$item}{'Request_By'} = $::who;
$::news{$chan}{$item}{'Request_Time'} = time();
my ($delim, $op, $np, $flags) = ($1,$2,$3,$4);
if ($flags !~ /^(g)?$/) {
- &::notice($::who, "error: Invalid flags to regex.");
+ &::notice($who, "error: Invalid flags to regex.");
return;
}
### TODO: use m### to make code safe!
- # todo: make code safer.
+ # TODO: make code safer.
my $done = 0;
- # todo: use eval to deal with flags easily.
+ # TODO: use eval to deal with flags easily.
if ($flags eq "") {
$done++ if (!$done and $mod_news =~ s/\Q$op\E/$np/);
$done++ if (!$done and $mod_nnews =~ s/\Q$op\E/$np/);
- } elsif ($flags eq "g") {
+ } elsif ($flags eq "g") {
$done++ if ($mod_news =~ s/\Q$op\E/$np/g);
$done++ if ($mod_nnews =~ s/\Q$op\E/$np/g);
}
if (!$done) {
- &::notice($::who, "warning: regex not found in news.");
+ &::notice($who, "warning: regex not found in news.");
return;
}
if ($mod_news ne $news) { # news item.
if (exists $::news{$chan}{$mod_news}) {
- &::notice($::who, "item '$mod_news' already exists.");
+ &::notice($who, "item '$mod_news' already exists.");
return;
}
- &::notice($::who, "Moving item '$news' to '$mod_news' with SAR s/$op/$np/.");
+ &::notice($who, "Moving item '$news' to '$mod_news' with SAR s/$op/$np/.");
foreach (keys %{ $::news{$chan}{$news} }) {
$::news{$chan}{$mod_news}{$_} = $::news{$chan}{$news}{$_};
delete $::news{$chan}{$news}{$_};
}
if ($mod_nnews ne $nnews) { # news Text/Description.
- &::notice($::who, "Changing text for '$news' SAR s/$op/$np/.");
+ &::notice($who, "Changing text for '$news' SAR s/$op/$np/.");
if ($mod_news ne $news) {
$::news{$chan}{$mod_news}{Text} = $mod_nnews;
} else {
return;
} else {
- &::notice($::who, "error: that regex failed ;(");
+ &::notice($who, "error: that regex failed ;(");
return;
}
- &::notice($::who, "error: Invalid regex. Try s/1/2/, s#3#4#...");
+ &::notice($who, "error: Invalid regex. Try s/1/2/, s#3#4#...");
}
sub set {
my($args) = @_;
my($item, $what, $value);
+ if (!defined $args) {
+ &::DEBUG("news: set: args == NULL.");
+ return;
+ }
+
$item = $1 if ($args =~ s/^(\S+)\s*//);
$what = $1 if ($args =~ s/^(\S+)\s*//);
$value = $args;
- &::DEBUG("news: set called.");
-
if ($item eq "") {
&::help("news set");
return;
my $news = &getNewsItem($item);
if (!defined $news) {
- &::notice($::who, "Could not find item '$item' substring or # in news list.");
+ &::notice($who, "Could not find item '$item' substring or # in news list.");
return;
}
# list all values for chan.
if (!defined $what or $what =~ /^\s*$/) {
- &::msg($::who, "set: you didn't fill me on the arguments! (what and values)");
+ &::msg($who, "set: you didn't fill me on the arguments! (what and values)");
return;
}
}
if (!$ok) {
- &::notice($::who, "Invalid set. Try: @elements");
+ &::notice($who, "Invalid set. Try: @elements");
return;
}
# show (read) what.
if (!defined $value or $value =~ /^\s*$/) {
- &::msg($::who, "set: you didn't fill me on the arguments! (value)");
+ &::msg($who, "set: you didn't fill me on the arguments! (value)");
return;
}
if (!exists $::news{$chan}{$news}) {
- &::notice($::who, "news '$news' does not exist");
+ &::notice($who, "news '$news' does not exist");
return;
}
if ($what eq "Expire") {
- # todo: use do_set().
+ # TODO: use do_set().
my $time = 0;
my $plus = ($value =~ s/^\+//g);
if (!$time or ($value and $value !~ /^never$/i)) {
&::DEBUG("news: set: Expire... need to parse.");
- &::msg($::who, "hrm... couldn't parse that.");
+ &::msg($who, "hrm... couldn't parse that.");
return;
}
if ($time == -1) {
- &::notice($::who, "Set never expire for \002$item\002." );
+ &::notice($who, "Set never expire for \002$item\002." );
} elsif ($time < -1) {
&::DEBUG("news: time should never be negative ($time).");
return;
} else {
- &::notice($::who, "Set expire for \002$item\002, to ".
- localtime($time) ." [".&::Time2String($time - time())."]" );
+ &::notice($who, "Set expire for \002$item\002, to ".
+ gmtime($time) ." [".&::Time2String($time - time())."]" );
if (time() > $time) {
&::DEBUG("news: hrm... time() > $time, should expire.");
}
my $auth = 0;
- &::DEBUG("news: who => '$::who'");
+# &::DEBUG("news: who => '$who'");
my $author = $::news{$chan}{$news}{Author};
$auth++ if ($::who eq $author);
$auth++ if (&::IsFlag("o"));
}
if (!$auth) {
- # todo: show when it'll expire.
- &::notice($::who, "Sorry, you cannot set items. (author $author owns it)");
+ # TODO: show when it'll expire.
+ &::notice($who, "Sorry, you cannot set items. (author $author owns it)");
return;
}
- # todo: clean this up.
+ # TODO: clean this up.
my $old = $::news{$chan}{$news}{$what};
if (defined $old) {
&::DEBUG("news: old => $old.");
}
$::news{$chan}{$news}{$what} = $value;
- &::notice($::who, "Setting [$chan]/{$news}/<$what> to '$value'.");
+ &::notice($who, "Setting [$chan]/{$news}/<$what> to '$value'.");
}
sub latest {
- my($tchan, $flag) = @_;
+ my ($tchan, $flag) = @_;
- # hack hack hack.
- $chan ||= $tchan;
- $who = $::who;
+ # hack hack hack. fix later.
+ $chan = $tchan;
+ $who = $::who;
- # todo: if chan = undefined, guess.
+ # TODO: if chan = undefined, guess.
# if (!exists $::news{$chan}) {
if (!exists $::channels{$chan}) {
&::notice($who, "invalid chan $chan") if ($flag);
}
my $t = $::newsuser{$chan}{$who};
- if (defined $t) {
- &::DEBUG("newsuser: $chan/$who == $t");
- } else {
- &::DEBUG("newsuser: $chan/$who == undefined");
- }
+# if (defined $t) {
+# &::DEBUG("newsuser: $chan/$who == $t");
+# } else {
+# &::DEBUG("newsuser: $chan/$who == undefined");
+# }
if (defined $t and ($t == 0 or $t == -1)) {
if ($flag) {
- &::notice($who, "if you want to read news, try /msg $::ident news or /msg $::ident news notify");
+ &::notice($who, "if you want to read news, try \002/msg $::ident news $chan\002 or \002/msg $::ident news $chan notify\002");
} else {
&::DEBUG("news: not displaying any new news for $who");
return;
}
$::chan = $chan;
- my $x = &::IsChanConf("newsNotifyAll");
- if (&::IsChanConf("newsNotifyAll") and !defined $t) {
- $t = 1;
- }
+ return if (&::IsChanConf("newsNotifyAll") <= 0);
+
+ # I don't understand this code ;)
+ $t = 1 if (!defined $t);
if (!defined $t) {
- &::DEBUG("news: something went really wrong.");
- &::DEBUG("news: chan => $chan, ::chan => $::chan");
-# &::notice($who, "something went really wrong.");
+# &::msg($who, "News is disabled for $chan");
+ &::DEBUG("news: $chan: something went really wrong.");
return;
}
# scalar @new, !$flag
my $unread = scalar @new;
my $total = scalar keys %{ $::news{$chan} };
+ if (!$flag && &::IsChanConf("newsTellUnread") <= 0) {
+ return;
+ }
+
if (!$flag) {
return unless ($unread);
+ # just a temporary measure not to flood ourself off the
+ # network with news until we get global notice() and msg()
+ # throttling.
+ if (time() - ($::cache{newsTime} || 0) < 5) {
+ &::status("news: not displaying latest notice to $who/$chan.");
+ return;
+ }
+
+ $::cache{newsTime} = time();
my $reply = "There are unread news in $chan ($unread unread, $total total). /msg $::ident news $::chan latest";
$reply .= " If you don't want further news notification, /msg $::ident news unnotify" if ($unread == $total);
&::notice($who, $reply);
&::notice($who, "|= Last time read $timestr ago");
}
+ my $i;
my @sorted;
foreach (@new) {
- my $i = &newsS2N($_);
+ $i = &newsS2N($_);
$sorted[$i] = $_;
}
- for (my $i=0; $i<=scalar(@sorted); $i++) {
+ for ($i=0; $i<=scalar(@sorted); $i++) {
my $news = $sorted[$i];
next unless (defined $news);
- my $age = time() - $::news{$chan}{$news}{Time};
- &::notice($who, sprintf("\002[\002%2d\002]\002 %s",
- $i, $news) );
-# $i, $_, &::Time2String($age) ) );
+# my $age = time() - $::news{$chan}{$news}{Time};
+ my $msg = sprintf("\002[\002%2d\002]\002 %s", $i, $news);
+### $i, $_, &::Time2String($age)
+ $::conn->schedule(int((2+$i)/2), sub {
+ &::notice($who, $msg);
+ } );
}
- &::notice($who, "|= to read, do 'news read <#>' or 'news read <keyword>'");
+ # TODO: implement throttling via schedule into ¬ice() / &msg().
+ $::conn->schedule(int((2+$i)/2), sub {
+ &::notice($who, "|= to read, do \002news $chan read <#>\002 or \002news $chan read <keyword>\002");
+ } );
# lame hack to prevent dupes if we just ignore it.
my $x = $::newsuser{$chan}{$who};
my($what) = @_;
my $item = 0;
+ $what =~ s/^\#//; # '#1' for example.
+
my %time;
foreach (keys %{ $::news{$chan} }) {
my $t = $::news{$chan}{$_}{Time};
if (scalar @items > 1) {
&::DEBUG("news: Multiple matches, not guessing.");
- &::notice($::who, "Multiple matches, not guessing.");
+ &::notice($who, "Multiple matches, not guessing.");
return;
}
if (@items) {
- &::DEBUG("news: gNI: part_string->full_string: $what->$items[0]");
+# &::DEBUG("news: gNI: part_string->full_string: $what->$items[0]");
return $items[0];
} else {
&::DEBUG("news: gNI: No match for '$what'");
}
}
- &::ERROR("getNewsItem: Should not happen (what = $what)");
+ &::ERROR("news: gNI: should not happen (what = $what)");
return;
}
return;
}
- &::DEBUG("news: do_set: TODO...");
+ &::TODO("news: do_set:");
}
sub stats {
&::DEBUG("News: stats called.");
- &::msg($::who, "check my logs/console.");
+ &::msg($who, "check my logs/console.");
my($i,$j) = (0,0);
# total request count.
$i = $j = 0;
}
+sub AUTOLOAD { &::AUTOLOAD(@_); }
+
1;