spam/spam.php

   1 <?php
   2 // $Id: spam.php,v 1.200 2007/07/29 12:59:24 henoheno Exp $
   3 // Copyright (C) 2006-2007 PukiWiki Developers Team
   4 // License: GPL v2 or (at your option) any later version
   5 //
   6 // Functions for Concept-work of spam-uri metrics
   7 //
   8 // (PHP 4 >= 4.3.0): preg_match_all(PREG_OFFSET_CAPTURE): $method['uri_XXX'] related feature
   9
  10 if (! defined('SPAM_INI_FILE'))   define('SPAM_INI_FILE',   'spam.ini.php');
  11 if (! defined('DOMAIN_INI_FILE')) define('DOMAIN_INI_FILE', 'domain.ini.php');
  12
  13 // ---------------------
  14 // Compat etc
  15
  16 // (PHP 4 >= 4.2.0): var_export(): mail-reporting and dump related
  17 if (! function_exists('var_export')) {
  18         function var_export() {
  19                 return 'var_export() is not found on this server' . "\n";
  20         }
  21 }
  22
  23 // (PHP 4 >= 4.2.0): preg_grep() enables invert option
  24 function preg_grep_invert($pattern = '//', $input = array())
  25 {
  26         static $invert;
  27         if (! isset($invert)) $invert = defined('PREG_GREP_INVERT');
  28
  29         if ($invert) {
  30                 return preg_grep($pattern, $input, PREG_GREP_INVERT);
  31         } else {
  32                 $result = preg_grep($pattern, $input);
  33                 if ($result) {
  34                         return array_diff($input, preg_grep($pattern, $input));
  35                 } else {
  36                         return $input;
  37                 }
  38         }
  39 }
  40
  41
  42 // ---------------------
  43 // Utilities
  44
  45 // Very roughly, shrink the lines of var_export()
  46 // NOTE: If the same data exists, it must be corrupted.
  47 function var_export_shrink($expression, $return = FALSE, $ignore_numeric_keys = FALSE)
  48 {
  49         $result = var_export($expression, TRUE);
  50
  51         $result = preg_replace(
  52                 // Remove a newline and spaces
  53                 '# => \n *array \(#', ' => array (',
  54                 $result
  55         );
  56
  57         if ($ignore_numeric_keys) {
  58                 $result =preg_replace(
  59                         // Remove numeric keys
  60                         '#^( *)[0-9]+ => #m', '$1',
  61                         $result
  62                 );
  63         }
  64
  65         if ($return) {
  66                 return $result;
  67         } else {
  68                 echo   $result;
  69                 return NULL;
  70         }
  71 }
  72
  73 // Reverse $string with specified delimiter
  74 function delimiter_reverse($string = 'foo.bar.example.com', $from_delim = '.', $to_delim = '.')
  75 {
  76         if (! is_string($string) || ! is_string($from_delim) || ! is_string($to_delim))
  77                 return $string;
  78
  79         // com.example.bar.foo
  80         return implode($to_delim, array_reverse(explode($from_delim, $string)));
  81 }
  82
  83 // ksort() by domain
  84 function ksort_by_domain(& $array)
  85 {
  86         $sort = array();
  87         foreach(array_keys($array) as $key) {
  88                 $sort[delimiter_reverse($key)] = $key;
  89         }
  90         ksort($sort, SORT_STRING);
  91         $result = array();
  92         foreach($sort as $key) {
  93                 $result[$key] = & $array[$key];
  94         }
  95         $array = $result;
  96 }
  97
  98 // Roughly strings(1) using PCRE
  99 // This function is useful to:
 100 //   * Reduce the size of data, from removing unprintable binary data
 101 //   * Detect _bare_strings_ from binary data
 102 // References:
 103 //   http://www.freebsd.org/cgi/man.cgi?query=strings (Man-page of GNU strings)
 104 //   http://www.pcre.org/pcre.txt
 105 // Note: mb_ereg_replace() is one of mbstring extension's functions
 106 //   and need to init its encoding.
 107 function strings($binary = '', $min_len = 4, $ignore_space = FALSE, $multibyte = FALSE)
 108 {
 109         // String only
 110         $binary = (is_array($binary) || $binary === TRUE) ? '' : strval($binary);
 111
 112         $regex = $ignore_space ?
 113                 '[^[:graph:] \t\n]+' :          // Remove "\0" etc, and readable spaces
 114                 '[^[:graph:][:space:]]+';       // Preserve readable spaces if possible
 115
 116         $binary = $multibyte ?
 117                 mb_ereg_replace($regex,           "\n",  $binary) :
 118                 preg_replace('/' . $regex . '/s', "\n",  $binary);
 119
 120         if ($ignore_space) {
 121                 $binary = preg_replace(
 122                         array(
 123                                 '/[ \t]{2,}/',
 124                                 '/^[ \t]/m',
 125                                 '/[ \t]$/m',
 126                         ),
 127                         array(
 128                                 ' ',
 129                                 '',
 130                                 ''
 131                         ),
 132                          $binary);
 133         }
 134
 135         if ($min_len > 1) {
 136                 // The last character seems "\n" or not
 137                 $br = (! empty($binary) && $binary[strlen($binary) - 1] == "\n") ? "\n" : '';
 138
 139                 $min_len = min(1024, intval($min_len));
 140                 $regex = '/^.{' . $min_len . ',}/S';
 141                 $binary = implode("\n", preg_grep($regex, explode("\n", $binary))) . $br;
 142         }
 143
 144         return $binary;
 145 }
 146
 147
 148 // ---------------------
 149 // Utilities: Arrays
 150
 151 // Count leaves (A leaf = value that is not an array, or an empty array)
 152 function array_count_leaves($array = array(), $count_empty = FALSE)
 153 {
 154         if (! is_array($array) || (empty($array) && $count_empty)) return 1;
 155
 156         // Recurse
 157         $count = 0;
 158         foreach ($array as $part) {
 159                 $count += array_count_leaves($part, $count_empty);
 160         }
 161         return $count;
 162 }
 163
 164 // Merge two leaves
 165 // Similar to PHP array_merge_leaves(), except strictly preserving keys as string
 166 function array_merge_leaves($array1, $array2, $sort_keys = TRUE)
 167 {
 168         // Array(s) only
 169         $is_array1 = is_array($array1);
 170         $is_array2 = is_array($array2);
 171         if ($is_array1) {
 172                 if ($is_array2) {
 173                         ;       // Pass
 174                 } else {
 175                         return $array1;
 176                 }
 177         } else if ($is_array2) {
 178                 return $array2;
 179         } else {
 180                 return $array2; // Not array ($array1 is overwritten)
 181         }
 182
 183         $keys_all = array_merge(array_keys($array1), array_keys($array2));
 184         if ($sort_keys) sort($keys_all, SORT_STRING);
 185
 186         $result = array();
 187         foreach($keys_all as $key) {
 188                 $isset1 = isset($array1[$key]);
 189                 $isset2 = isset($array2[$key]);
 190                 if ($isset1 && $isset2) {
 191                         // Recurse
 192                         $result[$key] = array_merge_leaves($array1[$key], $array2[$key], $sort_keys);
 193                 } else if ($isset1) {
 194                         $result[$key] = & $array1[$key];
 195                 } else {
 196                         $result[$key] = & $array2[$key];
 197                 }
 198         }
 199         return $result;
 200 }
 201
 202 // An array-leaves to a flat array
 203 function array_flat_leaves($array, $unique = TRUE)
 204 {
 205         if (! is_array($array)) return $array;
 206
 207         $tmp = array();
 208         foreach(array_keys($array) as $key) {
 209                 if (is_array($array[$key])) {
 210                         // Recurse
 211                         foreach(array_flat_leaves($array[$key]) as $_value) {
 212                                 $tmp[] = $_value;
 213                         }
 214                 } else {
 215                         $tmp[] = & $array[$key];
 216                 }
 217         }
 218
 219         return $unique ? array_values(array_unique($tmp)) : $tmp;
 220 }
 221
 222 // $array['something'] => $array['wanted']
 223 function array_rename_keys(& $array, $keys = array('from' => 'to'), $force = FALSE, $default = '')
 224 {
 225         if (! is_array($array) || ! is_array($keys)) return FALSE;
 226
 227         // Nondestructive test
 228         if (! $force)
 229                 foreach(array_keys($keys) as $from)
 230                         if (! isset($array[$from]))
 231                                 return FALSE;
 232
 233         foreach($keys as $from => $to) {
 234                 if ($from === $to) continue;
 235                 if (! $force || isset($array[$from])) {
 236                         $array[$to] = & $array[$from];
 237                         unset($array[$from]);
 238                 } else  {
 239                         $array[$to] = $default;
 240                 }
 241         }
 242
 243         return TRUE;
 244 }
 245
 246 // Remove redundant values from array()
 247 function array_unique_recursive($array = array())
 248 {
 249         if (! is_array($array)) return $array;
 250
 251         $tmp = array();
 252         foreach($array as $key => $value){
 253                 if (is_array($value)) {
 254                         $array[$key] = array_unique_recursive($value);
 255                 } else {
 256                         if (isset($tmp[$value])) {
 257                                 unset($array[$key]);
 258                         } else {
 259                                 $tmp[$value] = TRUE;
 260                         }
 261                 }
 262         }
 263
 264         return $array;
 265 }
 266
 267
 268 // ---------------------
 269 // Part One : Checker
 270
 271 // Rough implementation of globbing
 272 //
 273 // USAGE: $regex = '/^' . generate_glob_regex('*.txt', '/') . '$/i';
 274 //
 275 function generate_glob_regex($string = '', $divider = '/')
 276 {
 277         static $from = array(
 278                          1 => '*',
 279                         11 => '?',
 280         //              22 => '[',      // Maybe cause regex compilation error (e.g. '[]')
 281         //              23 => ']',      //
 282                 );
 283         static $mid = array(
 284                          1 => '_AST_',
 285                         11 => '_QUE_',
 286         //              22 => '_RBR_',
 287         //              23 => '_LBR_',
 288                 );
 289         static $to = array(
 290                          1 => '.*',
 291                         11 => '.',
 292         //              22 => '[',
 293         //              23 => ']',
 294                 );
 295
 296         if (! is_string($string)) return '';
 297
 298         $string = str_replace($from, $mid, $string); // Hide
 299         $string = preg_quote($string, $divider);
 300         $string = str_replace($mid, $to, $string);   // Unhide
 301
 302         return $string;
 303 }
 304
 305 // Generate host (FQDN, IPv4, ...) regex
 306 // 'localhost'     : Matches with 'localhost' only
 307 // 'example.org'   : Matches with 'example.org' only (See host_normalize() about 'www')
 308 // '.example.org'  : Matches with ALL FQDN ended with '.example.org'
 309 // '*.example.org' : Almost the same of '.example.org' except 'www.example.org'
 310 // '10.20.30.40'   : Matches with IPv4 address '10.20.30.40' only
 311 // [TODO] '192.'   : Matches with all IPv4 hosts started with '192.'
 312 // TODO: IPv4, CIDR?, IPv6
 313 function generate_host_regex($string = '', $divider = '/')
 314 {
 315         if (! is_string($string)) return '';
 316
 317         if (mb_strpos($string, '.') === FALSE)
 318                 return generate_glob_regex($string, $divider);
 319
 320         $result = '';
 321         if (is_ip($string)) {
 322                 // IPv4
 323                 return generate_glob_regex($string, $divider);
 324         } else {
 325                 // FQDN or something
 326                 $part = explode('.', $string, 2);
 327                 if ($part[0] == '') {
 328                         $part[0] = '(?:.*\.)?'; // And all related FQDN
 329                 } else if ($part[0] == '*') {
 330                         $part[0] = '.*\.';      // All subdomains/hosts only
 331                 } else {
 332                         return generate_glob_regex($string, $divider);
 333                 }
 334                 $part[1] = generate_glob_regex($part[1], $divider);
 335                 return implode('', $part);
 336         }
 337 }
 338
 339 // Rough hostname checker
 340 // [OK] 192.168.
 341 // TODO: Strict digit, 0x, CIDR, IPv6
 342 function is_ip($string = '')
 343 {
 344         if (preg_match('/^' .
 345                 '(?:[0-9]{1,3}\.){3}[0-9]{1,3}' . '|' .
 346                 '(?:[0-9]{1,3}\.){1,3}' . '$/',
 347                 $string)) {
 348                 return 4;       // Seems IPv4(dot-decimal)
 349         } else {
 350                 return 0;       // Seems not IP
 351         }
 352 }
 353
 354 function get_blocklist($list = '')
 355 {
 356         static $regexes;
 357
 358         if ($list === NULL) {
 359                 $regexes = NULL;        // Unset
 360                 return array();
 361         }
 362
 363         if (! isset($regexes)) {
 364                 $regexes = array();
 365                 if (file_exists(SPAM_INI_FILE)) {
 366                         $blocklist = array();
 367                         include(SPAM_INI_FILE);
 368                         //      $blocklist['badhost'] = array(
 369                         //              '*.blogspot.com',       // Blog services's subdomains (only)
 370                         //              'IANA-examples' => '#^(?:.*\.)?example\.(?:com|net|org)$#',
 371                         //      );
 372                         if (isset($blocklist['list'])) {
 373                                 $regexes['list'] = & $blocklist['list'];
 374                         } else {
 375                                 // Default
 376                                 $blocklist['list'] = array(
 377                                         'goodhost' => FALSE,
 378                                         'badhost'  => TRUE,
 379                                 );
 380                         }
 381                         foreach(array_keys($blocklist['list']) as $_list) {
 382                                 if (! isset($blocklist[$_list])) continue;
 383                                 foreach ($blocklist[$_list] as $key => $value) {
 384                                         if (is_array($value)) {
 385                                                 $regexes[$_list][$key] = array();
 386                                                 foreach($value as $_key => $_value) {
 387                                                         get_blocklist_add($regexes[$_list][$key], $_key, $_value);
 388                                                 }
 389                                         } else {
 390                                                 get_blocklist_add($regexes[$_list], $key, $value);
 391                                         }
 392                                 }
 393                                 unset($blocklist[$_list]);
 394                         }
 395                 }
 396         }
 397
 398         if ($list === '') {
 399                 return $regexes;        // ALL
 400         } else if (isset($regexes[$list])) {
 401                 return $regexes[$list];
 402         } else {
 403                 return array();
 404         }
 405 }
 406
 407 // Subroutine of get_blocklist()
 408 function get_blocklist_add(& $array, $key = 0, $value = '*.example.org')
 409 {
 410         if (is_string($key)) {
 411                 $array[$key] = & $value; // Treat $value as a regex
 412         } else {
 413                 $array[$value] = '/^' . generate_host_regex($value, '/') . '$/i';
 414         }
 415 }
 416
 417 // Blocklist metrics: Separate $host, to $blocked and not blocked
 418 function blocklist_distiller(& $hosts, $keys = array('goodhost', 'badhost'), $asap = FALSE)
 419 {
 420         if (! is_array($hosts)) $hosts = array($hosts);
 421         if (! is_array($keys))  $keys  = array($keys);
 422
 423         $list = get_blocklist('list');
 424         $blocked = array();
 425
 426         foreach($keys as $key){
 427                 foreach (get_blocklist($key) as $label => $regex) {
 428                         if (is_array($regex)) {
 429                                 foreach($regex as $_label => $_regex) {
 430                                         $group = preg_grep($_regex, $hosts);
 431                                         if ($group) {
 432                                                 $hosts = array_diff($hosts, $group);
 433                                                 $blocked[$key][$label][$_label] = $group;
 434                                                 if ($asap && $list[$key]) break;
 435                                         }
 436                                 }
 437                         } else {
 438                                 $group = preg_grep($regex, $hosts);
 439                                 if ($group) {
 440                                         $hosts = array_diff($hosts, $group);
 441                                         $blocked[$key][$label] = $group;
 442                                         if ($asap && $list[$key]) break;
 443                                 }
 444                         }
 445                 }
 446         }
 447
 448         return $blocked;
 449 }
 450
 451
 452 // ---------------------
 453
 454
 455 // Default (enabled) methods and thresholds (for content insertion)
 456 function check_uri_spam_method($times = 1, $t_area = 0, $rule = TRUE)
 457 {
 458         $times  = intval($times);
 459         $t_area = intval($t_area);
 460
 461         $positive = array(
 462                 // Thresholds
 463                 'quantity'     =>  8 * $times,  // Allow N URIs
 464                 'non_uniqhost' =>  3 * $times,  // Allow N duped (and normalized) Hosts
 465                 //'non_uniquri'=>  3 * $times,  // Allow N duped (and normalized) URIs
 466
 467                 // Areas
 468                 'area_anchor'  => $t_area,      // Using <a href> HTML tag
 469                 'area_bbcode'  => $t_area,      // Using [url] or [link] BBCode
 470                 //'uri_anchor' => $t_area,      // URI inside <a href> HTML tag
 471                 //'uri_bbcode' => $t_area,      // URI inside [url] or [link] BBCode
 472         );
 473         if ($rule) {
 474                 $bool = array(
 475                         // Rules
 476                         //'asap'   => TRUE,     // Quit or return As Soon As Possible
 477                         'uniqhost' => TRUE,     // Show uniq host (at block notification mail)
 478                         'badhost'  => TRUE,     // Check badhost
 479                 );
 480         } else {
 481                 $bool = array();
 482         }
 483
 484         // Remove non-$positive values
 485         foreach (array_keys($positive) as $key) {
 486                 if ($positive[$key] < 0) unset($positive[$key]);
 487         }
 488
 489         return $positive + $bool;
 490 }
 491
 492 // Simple/fast spam check
 493 function check_uri_spam($target = '', $method = array())
 494 {
 495         // Return value
 496         $progress = array(
 497                 'method'  => array(
 498                         // Theme to do  => Dummy, optional value, or optional array()
 499                         //'quantity'    => 8,
 500                         //'uniqhost'    => TRUE,
 501                         //'non_uniqhost'=> 3,
 502                         //'non_uniquri' => 3,
 503                         //'badhost'     => TRUE,
 504                         //'area_anchor' => 0,
 505                         //'area_bbcode' => 0,
 506                         //'uri_anchor'  => 0,
 507                         //'uri_bbcode'  => 0,
 508                 ),
 509                 'sum' => array(
 510                         // Theme        => Volume found (int)
 511                 ),
 512                 'is_spam' => array(
 513                         // Flag. If someting defined here,
 514                         // one or more spam will be included
 515                         // in this report
 516                 ),
 517                 'blocked' => array(
 518                         // Hosts blocked
 519                         //'category' => array(
 520                         //      'host',
 521                         //)
 522                 ),
 523                 'hosts' => array(
 524                         // Hosts not blocked
 525                 ),
 526         );
 527
 528         // Aliases
 529         $sum     = & $progress['sum'];
 530         $is_spam = & $progress['is_spam'];
 531         $progress['method'] = & $method;        // Argument
 532         $blocked = & $progress['blocked'];
 533         $hosts   = & $progress['hosts'];
 534         $asap    = isset($method['asap']);
 535
 536         // Init
 537         if (! is_array($method) || empty($method)) {
 538                 $method = check_uri_spam_method();
 539         }
 540         foreach(array_keys($method) as $key) {
 541                 if (! isset($sum[$key])) $sum[$key] = 0;
 542         }
 543         if (! isset($sum['quantity'])) $sum['quantity'] = 0;
 544
 545         if (is_array($target)) {
 546                 foreach($target as $str) {
 547                         if (! is_string($str)) continue;
 548
 549                         $_progress = check_uri_spam($str, $method);     // Recurse
 550
 551                         // Merge $sum
 552                         $_sum = & $_progress['sum'];
 553                         foreach (array_keys($_sum) as $key) {
 554                                 if (! isset($sum[$key])) {
 555                                         $sum[$key] = & $_sum[$key];
 556                                 } else {
 557                                         $sum[$key] += $_sum[$key];
 558                                 }
 559                         }
 560
 561                         // Merge $is_spam
 562                         $_is_spam = & $_progress['is_spam'];
 563                         foreach (array_keys($_is_spam) as $key) {
 564                                 $is_spam[$key] = TRUE;
 565                                 if ($asap) break;
 566                         }
 567                         if ($asap && $is_spam) break;
 568
 569                         // Merge only
 570                         $blocked = array_merge_leaves($blocked, $_progress['blocked'], FALSE);
 571                         $hosts   = array_merge_leaves($hosts,   $_progress['hosts'],   FALSE);
 572                 }
 573
 574                 // Unique values
 575                 $blocked = array_unique_recursive($blocked);
 576                 $hosts   = array_unique_recursive($hosts);
 577
 578                 // Recount $sum['badhost']
 579                 $sum['badhost'] = array_count_leaves($blocked);
 580
 581                 return $progress;
 582         }
 583
 584         // Area: There's HTML anchor tag
 585         if ((! $asap || ! $is_spam) && isset($method['area_anchor'])) {
 586                 $key = 'area_anchor';
 587                 $_asap = isset($method['asap']) ? array('asap' => TRUE) : array();
 588                 $result = area_pickup($target, array($key => TRUE) + $_asap);
 589                 if ($result) {
 590                         $sum[$key] = $result[$key];
 591                         if (isset($method[$key]) && $sum[$key] > $method[$key]) {
 592                                 $is_spam[$key] = TRUE;
 593                         }
 594                 }
 595         }
 596
 597         // Area: There's 'BBCode' linking tag
 598         if ((! $asap || ! $is_spam) && isset($method['area_bbcode'])) {
 599                 $key = 'area_bbcode';
 600                 $_asap = isset($method['asap']) ? array('asap' => TRUE) : array();
 601                 $result = area_pickup($target, array($key => TRUE) + $_asap);
 602                 if ($result) {
 603                         $sum[$key] = $result[$key];
 604                         if (isset($method[$key]) && $sum[$key] > $method[$key]) {
 605                                 $is_spam[$key] = TRUE;
 606                         }
 607                 }
 608         }
 609
 610         // Return if ...
 611         if ($asap && $is_spam) return $progress;
 612
 613         // URI: Pickup
 614         $pickups = uri_pickup_normalize(spam_uri_pickup($target, $method));
 615
 616         // Return if ...
 617         if (empty($pickups)) return $progress;
 618
 619         // URI: Check quantity
 620         $sum['quantity'] += count($pickups);
 621                 // URI quantity
 622         if ((! $asap || ! $is_spam) && isset($method['quantity']) &&
 623                 $sum['quantity'] > $method['quantity']) {
 624                 $is_spam['quantity'] = TRUE;
 625         }
 626
 627         // URI: used inside HTML anchor tag pair
 628         if ((! $asap || ! $is_spam) && isset($method['uri_anchor'])) {
 629                 $key = 'uri_anchor';
 630                 foreach($pickups as $pickup) {
 631                         if (isset($pickup['area'][$key])) {
 632                                 $sum[$key] += $pickup['area'][$key];
 633                                 if(isset($method[$key]) &&
 634                                         $sum[$key] > $method[$key]) {
 635                                         $is_spam[$key] = TRUE;
 636                                         if ($asap && $is_spam) break;
 637                                 }
 638                                 if ($asap && $is_spam) break;
 639                         }
 640                 }
 641         }
 642
 643         // URI: used inside 'BBCode' pair
 644         if ((! $asap || ! $is_spam) && isset($method['uri_bbcode'])) {
 645                 $key = 'uri_bbcode';
 646                 foreach($pickups as $pickup) {
 647                         if (isset($pickup['area'][$key])) {
 648                                 $sum[$key] += $pickup['area'][$key];
 649                                 if(isset($method[$key]) &&
 650                                         $sum[$key] > $method[$key]) {
 651                                         $is_spam[$key] = TRUE;
 652                                         if ($asap && $is_spam) break;
 653                                 }
 654                                 if ($asap && $is_spam) break;
 655                         }
 656                 }
 657         }
 658
 659         // URI: Uniqueness (and removing non-uniques)
 660         if ((! $asap || ! $is_spam) && isset($method['non_uniquri'])) {
 661
 662                 $uris = array();
 663                 foreach (array_keys($pickups) as $key) {
 664                         $uris[$key] = uri_pickup_implode($pickups[$key]);
 665                 }
 666                 $count = count($uris);
 667                 $uris  = array_unique($uris);
 668                 $sum['non_uniquri'] += $count - count($uris);
 669                 if ($sum['non_uniquri'] > $method['non_uniquri']) {
 670                         $is_spam['non_uniquri'] = TRUE;
 671                 }
 672                 if (! $asap || ! $is_spam) {
 673                         foreach (array_diff(array_keys($pickups),
 674                                 array_keys($uris)) as $remove) {
 675                                 unset($pickups[$remove]);
 676                         }
 677                 }
 678                 unset($uris);
 679         }
 680
 681         // Return if ...
 682         if ($asap && $is_spam) return $progress;
 683
 684         // Host: Uniqueness (uniq / non-uniq)
 685         foreach ($pickups as $pickup) $hosts[] = & $pickup['host'];
 686         $hosts = array_unique($hosts);
 687         if (isset($sum['uniqhost'])) $sum['uniqhost'] += count($hosts);
 688         if ((! $asap || ! $is_spam) && isset($method['non_uniqhost'])) {
 689                 $sum['non_uniqhost'] = $sum['quantity'] - $sum['uniqhost'];
 690                 if ($sum['non_uniqhost'] > $method['non_uniqhost']) {
 691                         $is_spam['non_uniqhost'] = TRUE;
 692                 }
 693         }
 694
 695         // Return if ...
 696         if ($asap && $is_spam) return $progress;
 697
 698         // URI: Bad host (Separate good/bad hosts from $hosts)
 699         if ((! $asap || ! $is_spam) && isset($method['badhost'])) {
 700
 701                 // is_badhost()
 702                 $list = get_blocklist('list');
 703                 $blocked = blocklist_distiller($hosts, array_keys($list), $asap);
 704                 foreach($list as $key=>$type){
 705                         if (! $type) unset($blocked[$key]); // Ignore goodhost etc
 706                 }
 707                 unset($list);
 708
 709                 if (! empty($blocked)) $is_spam['badhost'] = TRUE;
 710         }
 711
 712         return $progress;
 713 }
 714
 715 // ---------------------
 716 // Reporting
 717
 718 // Summarize $progress (blocked only)
 719 function summarize_spam_progress($progress = array(), $blockedonly = FALSE)
 720 {
 721         if ($blockedonly) {
 722                 $tmp = array_keys($progress['is_spam']);
 723         } else {
 724                 $tmp = array();
 725                 $method = & $progress['method'];
 726                 if (isset($progress['sum'])) {
 727                         foreach ($progress['sum'] as $key => $value) {
 728                                 if (isset($method[$key]) && $value) {
 729                                         $tmp[] = $key . '(' . $value . ')';
 730                                 }
 731                         }
 732                 }
 733         }
 734
 735         return implode(', ', $tmp);
 736 }
 737
 738 function summarize_detail_badhost($progress = array())
 739 {
 740         if (! isset($progress['blocked']) || empty($progress['blocked'])) return '';
 741
 742         // Flat per group
 743         $blocked = array();
 744         foreach($progress['blocked'] as $list => $lvalue) {
 745                 foreach($lvalue as $group => $gvalue) {
 746                         $flat = implode(', ', array_flat_leaves($gvalue));
 747                         if ($flat === $group) {
 748                                 $blocked[$list][]       = $flat;
 749                         } else {
 750                                 $blocked[$list][$group] = $flat;
 751                         }
 752                 }
 753         }
 754
 755         // Shrink per list
 756         // From: 'A-1' => array('ie.to')
 757         // To:   'A-1' => 'ie.to'
 758         foreach($blocked as $list => $lvalue) {
 759                 if (is_array($lvalue) &&
 760                    count($lvalue) == 1 &&
 761                    is_numeric(key($lvalue))) {
 762                     $blocked[$list] = current($lvalue);
 763                 }
 764         }
 765
 766         return var_export_shrink($blocked, TRUE, TRUE);
 767 }
 768
 769 function summarize_detail_newtral($progress = array())
 770 {
 771         if (! isset($progress['hosts'])    ||
 772             ! is_array($progress['hosts']) ||
 773             empty($progress['hosts'])) return '';
 774
 775         // Generate a responsible $trie
 776         $trie = array();
 777         foreach($progress['hosts'] as $value) {
 778                 // 'A.foo.bar.example.com'
 779                 $resp = whois_responsibility($value);   // 'example.com'
 780                 if (empty($resp)) {
 781                         // One or more test, or do nothing here
 782                         $resp = strval($value);
 783                         $rest = '';
 784                 } else {
 785                         $rest = rtrim(substr($value, 0, - strlen($resp)), '.'); // 'A.foo.bar'
 786                 }
 787                 $trie = array_merge_leaves($trie, array($resp => array($rest => NULL)), FALSE);
 788         }
 789
 790         // Format: var_export_shrink() -like output
 791         $result = array();
 792         ksort_by_domain($trie);
 793         foreach(array_keys($trie) as $key) {
 794                 ksort_by_domain($trie[$key]);
 795                 if (count($trie[$key]) == 1 && key($trie[$key]) == '') {
 796                         // Just one 'responsibility.example.com'
 797                         $result[] = '  \'' . $key . '\',';
 798                 } else {
 799                         // One subdomain-or-host, or several ones
 800                         $subs = array();
 801                         foreach(array_keys($trie[$key]) as $sub) {
 802                                 if ($sub == '') {
 803                                         $subs[] = $key;
 804                                 } else {
 805                                         $subs[] = $sub . '.' . $key;
 806                                 }
 807                         }
 808                         $result[] = '  \'' . $key . '\' => \'' . implode(', ', $subs) . '\',';
 809                 }
 810                 unset($trie[$key]);
 811         }
 812         return
 813                 'array (' . "\n" .
 814                         implode("\n", $result) . "\n" .
 815                 ')';
 816 }
 817
 818
 819 // Check responsibility-root of the FQDN
 820 // 'foo.bar.example.com'        => 'example.com'        (.com        has the last whois for it)
 821 // 'foo.bar.example.au'         => 'example.au'         (.au         has the last whois for it)
 822 // 'foo.bar.example.edu.au'     => 'example.edu.au'     (.edu.au     has the last whois for it)
 823 // 'foo.bar.example.act.edu.au' => 'example.act.edu.au' (.act.edu.au has the last whois for it)
 824 function whois_responsibility($fqdn = 'foo.bar.example.com', $parent = FALSE, $implicit = TRUE)
 825 {
 826         static $domain;
 827
 828         if ($fqdn === NULL) {
 829                 $domain = NULL; // Unset
 830                 return '';
 831         }
 832         if (! is_string($fqdn)) return '';
 833
 834         if (is_ip($fqdn)) return $fqdn;
 835
 836         if (! isset($domain)) {
 837                 $domain = array();
 838                 if (file_exists(DOMAIN_INI_FILE)) {
 839                         include(DOMAIN_INI_FILE);       // Set
 840                 }
 841         }
 842
 843         $result  = array();
 844         $dcursor = & $domain;
 845         $array   = array_reverse(explode('.', $fqdn));
 846         $i = 0;
 847         while(TRUE) {
 848                 if (! isset($array[$i])) break;
 849                 $acursor = $array[$i];
 850                 if (is_array($dcursor) && isset($dcursor[$acursor])) {
 851                         $result[] = & $array[$i];
 852                         $dcursor  = & $dcursor[$acursor];
 853                 } else {
 854                         if (! $parent && isset($acursor)) {
 855                                 $result[] = & $array[$i];       // Whois servers must know this subdomain
 856                         }
 857                         break;
 858                 }
 859                 ++$i;
 860         }
 861
 862         // Implicit responsibility: Top-Level-Domains must not be yours
 863         // 'bar.foo.something' => 'foo.something'
 864         if ($implicit && count($result) == 1 && count($array) > 1) {
 865                 $result[] = & $array[1];
 866         }
 867
 868         return $result ? implode('.', array_reverse($result)) : '';
 869 }
 870
 871
 872 // ---------------------
 873 // Exit
 874
 875 // Freeing memories
 876 function spam_dispose()
 877 {
 878         get_blocklist(NULL);
 879         whois_responsibility(NULL);
 880 }
 881
 882 // Common bahavior for blocking
 883 // NOTE: Call this function from various blocking feature, to disgueise the reason 'why blocked'
 884 function spam_exit($mode = '', $data = array())
 885 {
 886         $exit = TRUE;
 887
 888         switch ($mode) {
 889                 case '':
 890                         echo("\n");
 891                         break;
 892                 case 'dump':
 893                         echo('<pre>' . "\n");
 894                         echo htmlspecialchars(var_export($data, TRUE));
 895                         echo('</pre>' . "\n");
 896                         break;
 897         };
 898
 899         if ($exit) exit;        // Force exit
 900 }
 901
 902
 903 // ---------------------
 904 // Simple filtering
 905
 906 // TODO: Record them
 907 // Simple/fast spam filter ($target: 'a string' or an array())
 908 function pkwk_spamfilter($action, $page, $target = array('title' => ''), $method = array(), $exitmode = '')
 909 {
 910         $progress = check_uri_spam($target, $method);
 911
 912         if (empty($progress['is_spam'])) {
 913                 spam_dispose();
 914         } else {
 915
 916 // TODO: detect encoding from $target for mbstring functions
 917 //              $tmp = array();
 918 //              foreach(array_keys($target) as $key) {
 919 //                      $tmp[strings($key, 0, FALSE, TRUE)] = strings($target[$key], 0, FALSE, TRUE);   // Removing "\0" etc
 920 //              }
 921 //              $target = & $tmp;
 922
 923                 pkwk_spamnotify($action, $page, $target, $progress, $method);
 924                 spam_exit($exitmode, $progress);
 925         }
 926 }
 927
 928 // ---------------------
 929 // PukiWiki original
 930
 931 // Mail to administrator(s)
 932 function pkwk_spamnotify($action, $page, $target = array('title' => ''), $progress = array(), $method = array())
 933 {
 934         global $notify, $notify_subject;
 935
 936         if (! $notify) return;
 937
 938         $asap = isset($method['asap']);
 939
 940         $summary['ACTION']  = 'Blocked by: ' . summarize_spam_progress($progress, TRUE);
 941         if (! $asap) {
 942                 $summary['METRICS'] = summarize_spam_progress($progress);
 943         }
 944
 945         $tmp = summarize_detail_badhost($progress);
 946         if ($tmp != '') $summary['DETAIL_BADHOST'] = $tmp;
 947
 948         $tmp = summarize_detail_newtral($progress);
 949         if (! $asap && $tmp != '') $summary['DETAIL_NEUTRAL_HOST'] = $tmp;
 950
 951         $summary['COMMENT'] = $action;
 952         $summary['PAGE']    = '[blocked] ' . (is_pagename($page) ? $page : '');
 953         $summary['URI']     = get_script_uri() . '?' . rawurlencode($page);
 954         $summary['USER_AGENT']  = TRUE;
 955         $summary['REMOTE_ADDR'] = TRUE;
 956         pkwk_mail_notify($notify_subject,  var_export($target, TRUE), $summary, TRUE);
 957 }
 958
 959 ?>