src/Factoids/Question.pl

   1 ###
   2 ### Question.pl: Kevin Lenzo  (c) 1997
   3 ###
   4
   5 ##  doQuestion --
   6 ##      if ($query == query) {
   7 ##              return $value;
   8 ##      } else {
   9 ##              return NULL;
  10 ##      }
  11 ##
  12 ##
  13
  14 # use strict;   # TODO
  15
  16 use vars qw($query $reply $finalQMark $nuh $result $talkok $who $nuh);
  17 use vars qw(%bots %forked);
  18
  19 sub doQuestion {
  20     # my doesn't allow variables to be inherinted, local does.
  21     # following is used in math()...
  22     local($query)       = @_;
  23     local($reply)       = "";
  24     local $finalQMark   = $query =~ s/\?+\s*$//;
  25     $finalQMark         += $query =~ s/\?\s*$//;
  26     $query              =~ s/^\s+|\s+$//g;
  27
  28     if (!defined $query or $query =~ /^\s*$/) {
  29         return '';
  30     }
  31
  32     my $questionWord    = "";
  33
  34     if (!$addressed) {
  35         return '' unless ($finalQMark);
  36         return '' if (&IsParam("minVolunteerLength") == 0);
  37         return '' if (length $query < $param{'minVolunteerLength'});
  38     } else {
  39         ### TODO: this should be caught in Process.pl?
  40         return '' unless ($talkok);
  41
  42         # there is no flag to disable/enable asking factoids...
  43         # so it was added... thanks zyxep! :)
  44         if (&IsFlag("a") ne "a" && &IsFlag("o") ne "o") {
  45             &status("$who tried to ask us when not allowed.");
  46             return;
  47         }
  48     }
  49
  50     # dangerous; common preambles should be stripped before here
  51     if ($query =~ /^forget /i or $query =~ /^no, /) {
  52         return if (exists $bots{$nuh});
  53     }
  54
  55     if ($query =~ s/^literal\s+//i) {
  56         &status("literal ask of '$query'.");
  57         $literal = 1;
  58     }
  59
  60     # convert to canonical reference form
  61     my $x;
  62     my @query;
  63
  64     push(@query, $query);       # 1: push original.
  65
  66     # valid factoid.
  67     if ($query =~ s/[!.]$//) {
  68         push(@query, $query);
  69     }
  70
  71     $x = &normquery($query);
  72     push(@query, $x) if ($x ne $query);
  73     $query = $x;
  74
  75     $x = &switchPerson($query);
  76     push(@query, $x) if ($x ne $query);
  77     $query = $x;
  78
  79     $query =~ s/\s+at\s*(\?*)$/$1/;     # where is x at?
  80     $query =~ s/^explain\s*(\?*)/$1/i;  # explain x
  81     $query = " $query ";                # side whitespaces.
  82
  83     my $qregex = join '|', keys %{ $lang{'qWord'} };
  84
  85     # purge prefix question string.
  86     if ($query =~ s/^ ($qregex)//i) {
  87         $questionWord = lc($1);
  88     }
  89
  90     if ($questionWord eq "" and $finalQMark and $addressed) {
  91         $questionWord = "where";
  92     }
  93     $query =~ s/^\s+|\s+$//g; # bleh. hacked.
  94     push(@query, $query) if ($query ne $x);
  95
  96     if (&IsChanConf("factoidArguments")) {
  97         $result = &factoidArgs($query[0]);
  98
  99         return $result if (defined $result);
 100     }
 101
 102     my @link;
 103     for (my$i=0; $i<scalar @query; $i++) {
 104         $query  = $query[$i];
 105         $result = &getReply($query);
 106         next if (!defined $result or $result eq "");
 107
 108         # 'see also' factoid redirection support.
 109
 110         while ($result =~ /^see( also)? (.*?)\.?$/) {
 111             my $link    = $2;
 112
 113             # #debian@OPN was having problems with libstdc++ factoid
 114             # redirection :) 20021116. -xk.
 115             # hrm... allow recursive loops... next if statement handles
 116             # that.
 117             if (grep /^\Q$link\E$/i, @link) {
 118                 &status("recursive link found; bailing out.");
 119                 last;
 120             }
 121
 122             if (scalar @link >= 5) {
 123                 &status("recursive link limit (5) reached.");
 124                 last;
 125             }
 126
 127             push(@link, $link);
 128             my $newr = &getReply($link);
 129
 130             # no such factoid. try commands
 131             if (!defined $newr || $newr =~ /^0?$/) {
 132                 # support command redirection.
 133                 # recursive cmdHooks aswell :)
 134                 my $done = 0;
 135                 $done++ if &parseCmdHook("main", $link);
 136                 $done++ if &parseCmdHook("extra", $link);
 137                 $message        = $link;
 138                 $done++ unless (&Modules());
 139
 140                 return;
 141             }
 142             last if (!defined $newr or $newr eq "");
 143             $result  = $newr;
 144         }
 145
 146         if (@link) {
 147             &status("'$query' linked to: ".join(" => ", @link) );
 148         }
 149
 150         if ($i != 0) {
 151             &VERB("Question.pl: '$query[0]' did not exist; '$query[$i]' ($i) did",2);
 152         }
 153
 154         return $result;
 155     }
 156
 157     ### TODO: Use &Forker(); move function to Debian.pl
 158     if (&IsChanConf("debianForFactoid")) {
 159         &loadMyModule($myModules{'Debian'});
 160         $result = &Debian::DebianFind($query);  # ???
 161         ### TODO: debian module should tell, through shm, that it went
 162         ###       ok or not.
 163 ###     return $result if (defined $result);
 164     }
 165
 166     if ($questionWord ne "" or $finalQMark) {
 167         # if it has not been explicitly marked as a question
 168         if ($addressed and $reply eq "") {
 169             &status("notfound: <$who> ".join(' :: ', @query))
 170                                                 if ($finalQMark);
 171
 172             return '' unless (&IsParam("friendlyBots"));
 173
 174             foreach (split /\s+/, $param{'friendlyBots'}) {
 175                 &msg($_, ":INFOBOT:QUERY <$who> $query");
 176             }
 177         }
 178     }
 179
 180     return $reply;
 181 }
 182
 183 sub factoidArgs {
 184     my($str)    = @_;
 185     my $result;
 186
 187     # to make it eleeter, split each arg and use "blah OR blah or BLAH"
 188     # which will make it less than linear => quicker!
 189     # TODO: cache this, update cache when altered. !!! !!! !!!
 190 #    my $t = &timeget();
 191     my ($first) = split(/\s+/, $str);
 192     my @list = &searchTable("factoids", "factoid_key", "factoid_key", "^CMD: $first ");
 193 #    my $delta_time = &timedelta($t);
 194 #    &DEBUG("factArgs: delta_time = $delta_time s");
 195 #    &DEBUG("factArgs: list => ".scalar(@list) );
 196
 197     # from a design perspective, it's better to have the regex in
 198     # the factoid key to reduce repetitive processing.
 199
 200     # it does not matter if it's not alphabetically sorted.
 201     foreach (sort { length($b) <=> length($a) } @list) {
 202         next if (/#DEL#/);      # deleted.
 203
 204         s/^CMD: //i;
 205 #       &DEBUG("factarg: '$str' =~ /^$_\$/");
 206         my $arg = $_;
 207
 208         # TODO: <greycat> ~punish apt for (Eating) (Parentheses)
 209         # how the hell do I fix the above? -dms.
 210
 211         # eval (evil!) code. cleaned up courtesy of lear.
 212         my @vals;
 213         eval {
 214             @vals = ($str =~ /^$arg$/i);
 215         };
 216
 217         if ($@) {
 218             &WARN("factargs: regex failed! '$str' =~ /^$_\$/");
 219             next;
 220         }
 221
 222         next unless (@vals);
 223
 224         if (defined $result) {
 225             &WARN("factargs: '$_' matches aswell.");
 226             next;
 227         }
 228
 229 #       &DEBUG("vals => @vals");
 230
 231         &status("Question: factoid Arguments for '$str'");
 232         # TODO: use getReply() - need to modify it :(
 233         my $i   = 0;
 234         my $q   = "CMD: $_";
 235         my $r   = &getFactoid($q);
 236         if (!defined $r) {
 237             &DEBUG("question: !result... should this happen?");
 238             return;
 239         }
 240
 241         # update stats.
 242         &sqlUpdate("factoids", { factoid_key => $q }, {
 243             requested_by        => $nuh,
 244             requested_time      => time(),
 245             -requested_count    => "requested_count+1",
 246         } );
 247
 248         # end of update stats.
 249
 250         $result = $r;
 251         $result =~ s/^\((.*?)\): //;
 252
 253         foreach ( split(',', $1) ) {
 254             my $val = $vals[$i];
 255 #           &DEBUG("val => $val");
 256
 257             if (!defined $val) {
 258                 &status("factArgs: vals[$i] == undef; not SARing '$_' for '$str'");
 259                 next;
 260             }
 261
 262             my $done = 0;
 263             my $old = $result;
 264             while (1) {
 265 #               &DEBUG("Q: result => $result (1before)");
 266                 $result = &substVars($result);
 267 #               &DEBUG("Q: result => $result (1after)");
 268
 269                 last if ($old eq $result);
 270                 $old = $result;
 271                 $done++;
 272             }
 273
 274             # hack.
 275             $vals[$i] =~ s/^me$/$who/gi;
 276
 277             if (!$done) {
 278                 &status("factArgs: SARing '$_' to '$vals[$i]'.");
 279                 $result =~ s/\Q$_\E/$vals[$i]/g;
 280             }
 281             $i++;
 282         }
 283
 284         # nasty hack to get partial &getReply() functionality.
 285         $result =~ s/^\s*<action>\s*(.*)/\cAACTION $1\cA/i;
 286         $result =~ s/^\s*<reply>\s*//i;
 287         $result = &SARit($result);
 288
 289 # well... lets go through all of them. not advisable if we have like
 290 # 1000 commands, heh.
 291 #       return $result;
 292         $cmdstats{'Factoid Commands'}++;
 293     }
 294
 295     return $result;
 296 }
 297
 298 1;