spam/spam.php

   1 <?php
   2 // $Id: spam.php,v 1.120 2007/02/21 14:19:58 henoheno Exp $
   3 // Copyright (C) 2006-2007 PukiWiki Developers Team
   4 // License: GPL v2 or (at your option) any later version
   5 // Functions for Concept-work of spam-uri metrics
   6 // (PHP 4 >= 4.3.0): preg_match_all(PREG_OFFSET_CAPTURE): $method['uri_XXX'] related feature
   7
   8 if (! defined('SPAM_INI_FILE')) define('SPAM_INI_FILE', 'spam.ini.php');
   9
  10 // ---------------------
  11 // Compat etc
  12
  13 // (PHP 4 >= 4.2.0): var_export(): mail-reporting and dump related
  14 if (! function_exists('var_export')) {
  15         function var_export() {
  16                 return 'var_export() is not found on this server' . "\n";
  17         }
  18 }
  19
  20 // (PHP 4 >= 4.2.0): preg_grep() enables invert option
  21 function preg_grep_invert($pattern = '//', $input = array())
  22 {
  23         static $invert;
  24         if (! isset($invert)) $invert = defined('PREG_GREP_INVERT');
  25
  26         if ($invert) {
  27                 return preg_grep($pattern, $input, PREG_GREP_INVERT);
  28         } else {
  29                 $result = preg_grep($pattern, $input);
  30                 if ($result) {
  31                         return array_diff($input, preg_grep($pattern, $input));
  32                 } else {
  33                         return $input;
  34                 }
  35         }
  36 }
  37
  38 // ---------------------
  39 // URI pickup
  40
  41 // Return an array of URIs in the $string
  42 // [OK] http://nasty.example.org#nasty_string
  43 // [OK] http://nasty.example.org:80/foo/xxx#nasty_string/bar
  44 // [OK] ftp://nasty.example.org:80/dfsdfs
  45 // [OK] ftp://cnn.example.com&story=breaking_news@10.0.0.1/top_story.htm (from RFC3986)
  46 function uri_pickup($string = '', $normalize = TRUE,
  47         $preserve_rawuri = FALSE, $preserve_chunk = TRUE)
  48 {
  49         // Not available for: IDN(ignored)
  50         $array = array();
  51         preg_match_all(
  52                 // scheme://userinfo@host:port/path/or/pathinfo/maybefile.and?query=string#fragment
  53                 // Refer RFC3986 (Regex below is not strict)
  54                 '#(\b[a-z][a-z0-9.+-]{1,8}):/+' .       // 1: Scheme
  55                 '(?:' .
  56                         '([^\s<>"\'\[\]/\#?@]*)' .              // 2: Userinfo (Username)
  57                 '@)?' .
  58                 '(' .
  59                         // 3: Host
  60                         '\[[0-9a-f:.]+\]' . '|' .                               // IPv6([colon-hex and dot]): RFC2732
  61                         '(?:[0-9]{1-3}\.){3}[0-9]{1-3}' . '|' . // IPv4(dot-decimal): 001.22.3.44
  62                         '[a-z0-9.-]+' .                                                 // hostname(FQDN) : foo.example.org
  63                 ')' .
  64                 '(?::([0-9]*))?' .                                      // 4: Port
  65                 '((?:/+[^\s<>"\'\[\]/\#]+)*/+)?' .      // 5: Directory path or path-info
  66                 '([^\s<>"\'\[\]\#?]+)?' .                       // 6: File?
  67                 '(?:\?([^\s<>"\'\[\]\#]+))?' .          // 7: Query string
  68                 '(?:\#([a-z0-9._~%!$&\'()*+,;=:@-]*))?' .       // 8: Fragment
  69                 '#i',
  70                  $string, $array, PREG_SET_ORDER | PREG_OFFSET_CAPTURE
  71         );
  72
  73         // Shrink $array
  74         static $parts = array(
  75                 1 => 'scheme', 2 => 'userinfo', 3 => 'host', 4 => 'port',
  76                 5 => 'path', 6 => 'file', 7 => 'query', 8 => 'fragment'
  77         );
  78         $default = array('');
  79         foreach(array_keys($array) as $uri) {
  80                 $_uri = & $array[$uri];
  81                 array_rename_keys($_uri, $parts, TRUE, $default);
  82
  83                 $offset = $_uri['scheme'][1]; // Scheme's offset
  84                 foreach(array_keys($_uri) as $part) {
  85                         // Remove offsets for each part
  86                         $_uri[$part] = & $_uri[$part][0];
  87                 }
  88
  89                 if ($normalize) {
  90                         $_uri['scheme'] = scheme_normalize($_uri['scheme']);
  91                         if ($_uri['scheme'] === '') {
  92                                 unset($array[$uri]);
  93                                 continue;
  94                         }
  95                         $_uri['host']  = strtolower($_uri['host']);
  96                         $_uri['port']  = port_normalize($_uri['port'], $_uri['scheme'], FALSE);
  97                         $_uri['path']  = path_normalize($_uri['path']);
  98                         if ($preserve_rawuri) $_uri['rawuri'] = & $_uri[0];
  99
 100                         // DEBUG
 101                         //$_uri['uri'] = uri_array_implode($_uri);
 102                 } else {
 103                         $_uri['uri'] = & $_uri[0]; // Raw
 104                 }
 105                 unset($_uri[0]); // Matched string itself
 106                 if (! $preserve_chunk) {
 107                         unset(
 108                                 $_uri['scheme'],
 109                                 $_uri['userinfo'],
 110                                 $_uri['host'],
 111                                 $_uri['port'],
 112                                 $_uri['path'],
 113                                 $_uri['file'],
 114                                 $_uri['query'],
 115                                 $_uri['fragment']
 116                         );
 117                 }
 118
 119                 // Area offset for area_measure()
 120                 $_uri['area']['offset'] = $offset;
 121         }
 122
 123         return $array;
 124 }
 125
 126 // Destructive normalize of URI array
 127 // NOTE: Give me the uri_pickup() result with chunks
 128 function uri_array_normalize(& $pickups, $preserve = TRUE)
 129 {
 130         if (! is_array($pickups)) return $pickups;
 131
 132         foreach (array_keys($pickups) as $key) {
 133                 $_key = & $pickups[$key];
 134                 $_key['path']     = isset($_key['path']) ? strtolower($_key['path']) : '';
 135                 $_key['file']     = isset($_key['file']) ? file_normalize($_key['file']) : '';
 136                 $_key['query']    = isset($_key['query']) ? query_normalize(strtolower($_key['query']), TRUE) : '';
 137                 $_key['fragment'] = (isset($_key['fragment']) && $preserve) ?
 138                         strtolower($_key['fragment']) : ''; // Just ignore
 139         }
 140
 141         return $pickups;
 142 }
 143
 144 // An URI array => An URI (See uri_pickup())
 145 function uri_array_implode($uri = array())
 146 {
 147         if (empty($uri) || ! is_array($uri)) return NULL;
 148
 149         $tmp = array();
 150         if (isset($uri['scheme']) && $uri['scheme'] !== '') {
 151                 $tmp[] = & $uri['scheme'];
 152                 $tmp[] = '://';
 153         }
 154         if (isset($uri['userinfo']) && $uri['userinfo'] !== '') {
 155                 $tmp[] = & $uri['userinfo'];
 156                 $tmp[] = '@';
 157         }
 158         if (isset($uri['host']) && $uri['host'] !== '') {
 159                 $tmp[] = & $uri['host'];
 160         }
 161         if (isset($uri['port']) && $uri['port'] !== '') {
 162                 $tmp[] = ':';
 163                 $tmp[] = & $uri['port'];
 164         }
 165         if (isset($uri['path']) && $uri['path'] !== '') {
 166                 $tmp[] = & $uri['path'];
 167         }
 168         if (isset($uri['file']) && $uri['file'] !== '') {
 169                 $tmp[] = & $uri['file'];
 170         }
 171         if (isset($uri['query']) && $uri['query'] !== '') {
 172                 $tmp[] = '?';
 173                 $tmp[] = & $uri['query'];
 174         }
 175         if (isset($uri['fragment']) && $uri['fragment'] !== '') {
 176                 $tmp[] = '#';
 177                 $tmp[] = & $uri['fragment'];
 178         }
 179
 180         return implode('', $tmp);
 181 }
 182
 183 // $array['something'] => $array['wanted']
 184 function array_rename_keys(& $array, $keys = array('from' => 'to'), $force = FALSE, $default = '')
 185 {
 186         if (! is_array($array) || ! is_array($keys)) return FALSE;
 187
 188         // Nondestructive test
 189         if (! $force)
 190                 foreach(array_keys($keys) as $from)
 191                         if (! isset($array[$from]))
 192                                 return FALSE;
 193
 194         foreach($keys as $from => $to) {
 195                 if ($from === $to) continue;
 196                 if (! $force || isset($array[$from])) {
 197                         $array[$to] = & $array[$from];
 198                         unset($array[$from]);
 199                 } else  {
 200                         $array[$to] = $default;
 201                 }
 202         }
 203
 204         return TRUE;
 205 }
 206
 207 // ---------------------
 208 // Area pickup
 209
 210 // Pickup all of markup areas
 211 function area_pickup($string = '', $method = array())
 212 {
 213         $area = array();
 214         if (empty($method)) return $area;
 215
 216         // Anchor tag pair by preg_match and preg_match_all()
 217         // [OK] <a href></a>
 218         // [OK] <a href=  >Good site!</a>
 219         // [OK] <a href= "#" >test</a>
 220         // [OK] <a href="http://nasty.example.com">visit http://nasty.example.com/</a>
 221         // [OK] <a href=\'http://nasty.example.com/\' >discount foobar</a>
 222         // [NG] <a href="http://ng.example.com">visit http://ng.example.com _not_ended_
 223         $regex = '#<a\b[^>]*\bhref\b[^>]*>.*?</a\b[^>]*(>)#i';
 224         if (isset($method['area_anchor'])) {
 225                 $areas = array();
 226                 $count = isset($method['asap']) ?
 227                         preg_match($regex, $string) :
 228                         preg_match_all($regex, $string, $areas);
 229                 if (! empty($count)) $area['area_anchor'] = $count;
 230         }
 231         if (isset($method['uri_anchor'])) {
 232                 $areas = array();
 233                 preg_match_all($regex, $string, $areas, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
 234                 foreach(array_keys($areas) as $_area) {
 235                         $areas[$_area] =  array(
 236                                 $areas[$_area][0][1], // Area start (<a href>)
 237                                 $areas[$_area][1][1], // Area end   (</a>)
 238                         );
 239                 }
 240                 if (! empty($areas)) $area['uri_anchor'] = $areas;
 241         }
 242
 243         // phpBB's "BBCode" pair by preg_match and preg_match_all()
 244         // [OK] [url][/url]
 245         // [OK] [url]http://nasty.example.com/[/url]
 246         // [OK] [link]http://nasty.example.com/[/link]
 247         // [OK] [url=http://nasty.example.com]visit http://nasty.example.com/[/url]
 248         // [OK] [link http://nasty.example.com/]buy something[/link]
 249         $regex = '#\[(url|link)\b[^\]]*\].*?\[/\1\b[^\]]*(\])#i';
 250         if (isset($method['area_bbcode'])) {
 251                 $areas = array();
 252                 $count = isset($method['asap']) ?
 253                         preg_match($regex, $string) :
 254                         preg_match_all($regex, $string, $areas, PREG_SET_ORDER);
 255                 if (! empty($count)) $area['area_bbcode'] = $count;
 256         }
 257         if (isset($method['uri_bbcode'])) {
 258                 $areas = array();
 259                 preg_match_all($regex, $string, $areas, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
 260                 foreach(array_keys($areas) as $_area) {
 261                         $areas[$_area] = array(
 262                                 $areas[$_area][0][1], // Area start ([url])
 263                                 $areas[$_area][2][1], // Area end   ([/url])
 264                         );
 265                 }
 266                 if (! empty($areas)) $area['uri_bbcode'] = $areas;
 267         }
 268
 269         // Various Wiki syntax
 270         // [text_or_uri>text_or_uri]
 271         // [text_or_uri:text_or_uri]
 272         // [text_or_uri|text_or_uri]
 273         // [text_or_uri->text_or_uri]
 274         // [text_or_uri text_or_uri] // MediaWiki
 275         // MediaWiki: [http://nasty.example.com/ visit http://nasty.example.com/]
 276
 277         return $area;
 278 }
 279
 280 // If in doubt, it's a little doubtful
 281 // if (Area => inside <= Area) $brief += -1
 282 function area_measure($areas, & $array, $belief = -1, $a_key = 'area', $o_key = 'offset')
 283 {
 284         if (! is_array($areas) || ! is_array($array)) return;
 285
 286         $areas_keys = array_keys($areas);
 287         foreach(array_keys($array) as $u_index) {
 288                 $offset = isset($array[$u_index][$o_key]) ?
 289                         intval($array[$u_index][$o_key]) : 0;
 290                 foreach($areas_keys as $a_index) {
 291                         if (isset($array[$u_index][$a_key])) {
 292                                 $offset_s = intval($areas[$a_index][0]);
 293                                 $offset_e = intval($areas[$a_index][1]);
 294                                 // [Area => inside <= Area]
 295                                 if ($offset_s < $offset && $offset < $offset_e) {
 296                                         $array[$u_index][$a_key] += $belief;
 297                                 }
 298                         }
 299                 }
 300         }
 301 }
 302
 303 // ---------------------
 304 // Spam-uri pickup
 305
 306 // Domain exposure callback (See spam_uri_pickup_preprocess())
 307 // http://victim.example.org/?foo+site:nasty.example.com+bar
 308 // => http://nasty.example.com/?refer=victim.example.org
 309 // NOTE: 'refer=' is not so good for (at this time).
 310 // Consider about using IP address of the victim, try to avoid that.
 311 function _preg_replace_callback_domain_exposure($matches = array())
 312 {
 313         $result = '';
 314
 315         // Preserve the victim URI as a complicity or ...
 316         if (isset($matches[5])) {
 317                 $result =
 318                         $matches[1] . '://' .   // scheme
 319                         $matches[2] . '/' .             // victim.example.org
 320                         $matches[3];                    // The rest of all (before victim)
 321         }
 322
 323         // Flipped URI
 324         if (isset($matches[4])) {
 325                 $result =
 326                         $matches[1] . '://' .   // scheme
 327                         $matches[4] .                   // nasty.example.com
 328                         '/?refer=' . strtolower($matches[2]) .  // victim.example.org
 329                         ' ' . $result;
 330         }
 331
 332         return $result;
 333 }
 334
 335 // Preprocess: rawurldecode() and adding space(s) and something
 336 // to detect/count some URIs _if possible_
 337 // NOTE: It's maybe danger to var_dump(result). [e.g. 'javascript:']
 338 // [OK] http://victim.example.org/go?http%3A%2F%2Fnasty.example.org
 339 // [OK] http://victim.example.org/http://nasty.example.org
 340 function spam_uri_pickup_preprocess($string = '')
 341 {
 342         if (! is_string($string)) return '';
 343
 344         $string = rawurldecode($string);
 345
 346         // Domain exposure (See _preg_replace_callback_domain_exposure())
 347         $string = preg_replace_callback(
 348                 array(
 349                         '#(http)://' .
 350                         '(' .
 351                                 // Something Google: http://www.google.com/supported_domains
 352                                 '(?:[a-z0-9.]+\.)?google\.[a-z]{2,3}(?:\.[a-z]{2})?' .
 353                                 '|' .
 354                                 // AltaVista
 355                                 '(?:[a-z0-9.]+\.)?altavista.com' .
 356
 357                         ')' .
 358                         '/' .
 359                         '([a-z0-9?=&.%_/\'\\\+-]+)' .                           // path/?query=foo+bar+
 360                         '\bsite:([a-z0-9.%_-]+\.[a-z0-9.%_-]+)' .       // site:nasty.example.com
 361                         //'()' .        // Preserve or remove?
 362                         '#i',
 363                 ),
 364                 '_preg_replace_callback_domain_exposure',
 365                 $string
 366         );
 367
 368
 369
 370         // URI exposure (uriuri => uri uri)
 371         $string = preg_replace(
 372                 array(
 373                         '#(?<! )(?:https?|ftp):/#i',
 374                 //      '#[a-z][a-z0-9.+-]{1,8}://#i',
 375                 //      '#[a-z][a-z0-9.+-]{1,8}://#i'
 376                 ),
 377                 ' $0',
 378                 $string
 379         );
 380
 381         return $string;
 382 }
 383
 384 // Main function of spam-uri pickup
 385 function spam_uri_pickup($string = '', $method = array())
 386 {
 387         if (! is_array($method) || empty($method)) {
 388                 $method = check_uri_spam_method();
 389         }
 390
 391         $string = spam_uri_pickup_preprocess($string);
 392
 393         $array  = uri_pickup($string);
 394
 395         // Area elevation of URIs, for '(especially external)link' intension
 396         if (! empty($array)) {
 397                 $_method = array();
 398                 if (isset($method['uri_anchor'])) $_method['uri_anchor'] = & $method['uri_anchor'];
 399                 if (isset($method['uri_bbcode'])) $_method['uri_bbcode'] = & $method['uri_bbcode'];
 400                 $areas = area_pickup($string, $_method, TRUE);
 401                 if (! empty($areas)) {
 402                         $area_shadow = array();
 403                         foreach (array_keys($array) as $key) {
 404                                 $area_shadow[$key] = & $array[$key]['area'];
 405                                 foreach (array_keys($_method) as $_key) {
 406                                         $area_shadow[$key][$_key] = 0;
 407                                 }
 408                         }
 409                         foreach (array_keys($_method) as $_key) {
 410                                 if (isset($areas[$_key])) {
 411                                         area_measure($areas[$_key], $area_shadow, 1, $_key);
 412                                 }
 413                         }
 414                 }
 415         }
 416
 417         // Remove 'offset's for area_measure()
 418         foreach(array_keys($array) as $key)
 419                 unset($array[$key]['area']['offset']);
 420
 421         return $array;
 422 }
 423
 424
 425 // ---------------------
 426 // Normalization
 427
 428 // Scheme normalization: Renaming the schemes
 429 // snntp://example.org =>  nntps://example.org
 430 // NOTE: Keep the static lists simple. See also port_normalize().
 431 function scheme_normalize($scheme = '', $considerd_harmfull = TRUE)
 432 {
 433         // Abbreviations considerable they don't have link intension
 434         static $abbrevs = array(
 435                 'ttp'   => 'http',
 436                 'ttps'  => 'https',
 437         );
 438
 439         // Alias => normalized
 440         static $aliases = array(
 441                 'pop'   => 'pop3',
 442                 'news'  => 'nntp',
 443                 'imap4' => 'imap',
 444                 'snntp' => 'nntps',
 445                 'snews' => 'nntps',
 446                 'spop3' => 'pop3s',
 447                 'pops'  => 'pop3s',
 448         );
 449
 450         $scheme = strtolower(trim($scheme));
 451         if (isset($abbrevs[$scheme])) {
 452                 if ($considerd_harmfull) {
 453                         $scheme = $abbrevs[$scheme];
 454                 } else {
 455                         $scheme = '';
 456                 }
 457         }
 458         if (isset($aliases[$scheme])) $scheme = $aliases[$scheme];
 459
 460         return $scheme;
 461 }
 462
 463 // Port normalization: Suppress the (redundant) default port
 464 // HTTP://example.org:80/ => http://example.org/
 465 // HTTP://example.org:8080/ => http://example.org:8080/
 466 // HTTPS://example.org:443/ => https://example.org/
 467 function port_normalize($port, $scheme, $scheme_normalize = TRUE)
 468 {
 469         // Schemes that users _maybe_ want to add protocol-handlers
 470         // to their web browsers. (and attackers _maybe_ want to use ...)
 471         // Reference: http://www.iana.org/assignments/port-numbers
 472         static $array = array(
 473                 // scheme => default port
 474                 'ftp'     =>    21,
 475                 'ssh'     =>    22,
 476                 'telnet'  =>    23,
 477                 'smtp'    =>    25,
 478                 'tftp'    =>    69,
 479                 'gopher'  =>    70,
 480                 'finger'  =>    79,
 481                 'http'    =>    80,
 482                 'pop3'    =>   110,
 483                 'sftp'    =>   115,
 484                 'nntp'    =>   119,
 485                 'imap'    =>   143,
 486                 'irc'     =>   194,
 487                 'wais'    =>   210,
 488                 'https'   =>   443,
 489                 'nntps'   =>   563,
 490                 'rsync'   =>   873,
 491                 'ftps'    =>   990,
 492                 'telnets' =>   992,
 493                 'imaps'   =>   993,
 494                 'ircs'    =>   994,
 495                 'pop3s'   =>   995,
 496                 'mysql'   =>  3306,
 497         );
 498
 499         $port = trim($port);
 500         if ($port === '') return $port;
 501
 502         if ($scheme_normalize) $scheme = scheme_normalize($scheme);
 503         if (isset($array[$scheme]) && $port == $array[$scheme])
 504                 $port = ''; // Ignore the defaults
 505
 506         return $port;
 507 }
 508
 509 // Path normalization
 510 // http://example.org => http://example.org/
 511 // http://example.org#hoge => http://example.org/#hoge
 512 // http://example.org/path/a/b/./c////./d => http://example.org/path/a/b/c/d
 513 // http://example.org/path/../../a/../back => http://example.org/back
 514 function path_normalize($path = '', $divider = '/', $addroot = TRUE)
 515 {
 516         if (! is_string($path) || $path == '')
 517                 return $addroot ? $divider : '';
 518
 519         $path = trim($path);
 520         $last = ($path[strlen($path) - 1] == $divider) ? $divider : '';
 521         $array = explode($divider, $path);
 522
 523         // Remove paddings
 524         foreach(array_keys($array) as $key) {
 525                 if ($array[$key] == '' || $array[$key] == '.')
 526                          unset($array[$key]);
 527         }
 528         // Back-track
 529         $tmp = array();
 530         foreach($array as $value) {
 531                 if ($value == '..') {
 532                         array_pop($tmp);
 533                 } else {
 534                         array_push($tmp, $value);
 535                 }
 536         }
 537         $array = & $tmp;
 538
 539         $path = $addroot ? $divider : '';
 540         if (! empty($array)) $path .= implode($divider, $array) . $last;
 541
 542         return $path;
 543 }
 544
 545 // DirectoryIndex normalize (Destructive and rough)
 546 function file_normalize($string = 'index.html.en')
 547 {
 548         static $array = array(
 549                 'index'                 => TRUE,        // Some system can omit the suffix
 550                 'index.htm'             => TRUE,
 551                 'index.html'    => TRUE,
 552                 'index.shtml'   => TRUE,
 553                 'index.jsp'             => TRUE,
 554                 'index.php'             => TRUE,
 555                 'index.php3'    => TRUE,
 556                 'index.php4'    => TRUE,
 557                 //'index.pl'    => TRUE,
 558                 //'index.py'    => TRUE,
 559                 //'index.rb'    => TRUE,
 560                 'index.cgi'             => TRUE,
 561                 'default.htm'   => TRUE,
 562                 'default.html'  => TRUE,
 563                 'default.asp'   => TRUE,
 564                 'default.aspx'  => TRUE,
 565         );
 566
 567         // Content-negothiation filter:
 568         // Roughly removing ISO 639 -like
 569         // 2-letter suffixes (See RFC3066)
 570         $matches = array();
 571         if (preg_match('/(.*)\.[a-z][a-z](?:-[a-z][a-z])?$/i', $string, $matches)) {
 572                 $_string = $matches[1];
 573         } else {
 574                 $_string = & $string;
 575         }
 576
 577         if (isset($array[strtolower($_string)])) {
 578                 return '';
 579         } else {
 580                 return $string;
 581         }
 582 }
 583
 584 // Sort query-strings if possible (Destructive and rough)
 585 // [OK] &&&&f=d&b&d&c&a=0dd  =>  a=0dd&b&c&d&f=d
 586 // [OK] nothing==&eg=dummy&eg=padding&eg=foobar  =>  eg=foobar
 587 function query_normalize($string = '', $equal = FALSE, $equal_cutempty = TRUE)
 588 {
 589         $array = explode('&', $string);
 590
 591         // Remove '&' paddings
 592         foreach(array_keys($array) as $key) {
 593                 if ($array[$key] == '') {
 594                          unset($array[$key]);
 595                 }
 596         }
 597
 598         // Consider '='-sepalated input and paddings
 599         if ($equal) {
 600                 $equals = $not_equals = array();
 601                 foreach ($array as $part) {
 602                         if (strpos($part, '=') === FALSE) {
 603                                  $not_equals[] = $part;
 604                         } else {
 605                                 list($key, $value) = explode('=', $part, 2);
 606                                 $value = ltrim($value, '=');
 607                                 if (! $equal_cutempty || $value != '') {
 608                                         $equals[$key] = $value;
 609                                 }
 610                         }
 611                 }
 612
 613                 $array = & $not_equals;
 614                 foreach ($equals as $key => $value) {
 615                         $array[] = $key . '=' . $value;
 616                 }
 617                 unset($equals);
 618         }
 619
 620         natsort($array);
 621         return implode('&', $array);
 622 }
 623
 624 // ---------------------
 625 // Part One : Checker
 626
 627 function generate_glob_regex($string = '', $divider = '/')
 628 {
 629         static $from = array(
 630                          1 => '*',
 631                         11 => '?',
 632         //              22 => '[',      // Maybe cause regex compilation error (e.g. '[]')
 633         //              23 => ']',      //
 634                 );
 635         static $mid = array(
 636                          1 => '_AST_',
 637                         11 => '_QUE_',
 638         //              22 => '_RBR_',
 639         //              23 => '_LBR_',
 640                 );
 641         static $to = array(
 642                          1 => '.*',
 643                         11 => '.',
 644         //              22 => '[',
 645         //              23 => ']',
 646                 );
 647
 648         if (is_array($string)) {
 649                 // Recurse
 650                 return '(?:' .
 651                         implode('|',    // OR
 652                                 array_map('generate_glob_regex',
 653                                         $string,
 654                                         array_pad(array(), count($string), $divider)
 655                                 )
 656                         ) .
 657                 ')';
 658         } else {
 659                 $string = str_replace($from, $mid, $string); // Hide
 660                 $string = preg_quote($string, $divider);
 661                 $string = str_replace($mid, $to, $string);   // Unhide
 662                 return $string;
 663         }
 664 }
 665
 666 function get_blocklist($list = '')
 667 {
 668         static $regexs;
 669
 670         if (! isset($regexs)) {
 671                 $regexs = array();
 672                 if (file_exists(SPAM_INI_FILE)) {
 673                         $blocklist = array();
 674                         include(SPAM_INI_FILE);
 675                         //      $blocklist['badhost'] = array(
 676                         //              '*.blogspot.com',       // Blog services's subdomains (only)
 677                         //              'IANA-examples' => '#^(?:.*\.)?example\.(?:com|net|org)$#',
 678                         //      );
 679                         foreach(array('goodhost', 'badhost') as $_list) {
 680                                 if (! isset($blocklist[$list])) continue;
 681                                 foreach ($blocklist[$_list] as $key => $value) {
 682                                         if (is_string($key)) {
 683                                                 $regexs[$_list][$key] = $value;
 684                                         } else {
 685                                                 $regexs[$_list][$value] =
 686                                                         '/^(?:www\.)?' . generate_glob_regex($value, '/') . '$/i';
 687                                         }
 688                                 }
 689                         }
 690                 }
 691         }
 692
 693         if ($list == '') {
 694                 return $regexs; // ALL
 695         } else if (isset($regexs[$list])) {
 696                 return $regexs[$list];
 697         } else {
 698                 return array();
 699         }
 700 }
 701
 702 function is_badhost($hosts = array(), $asap = TRUE, & $remains)
 703 {
 704         $result = array();
 705         if (! is_array($hosts)) $hosts = array($hosts);
 706         foreach(array_keys($hosts) as $key) {
 707                 if (! is_string($hosts[$key])) unset($hosts[$key]);
 708         }
 709         if (empty($hosts)) return $result;
 710
 711         foreach (get_blocklist('goodhost') as $regex) {
 712                 $hosts = preg_grep_invert($regex, $hosts);
 713         }
 714         if (empty($hosts)) return $result;
 715
 716         $tmp = array();
 717         foreach (get_blocklist('badhost') as $label => $regex) {
 718                 $result[$label] = preg_grep($regex, $hosts);
 719                 if (empty($result[$label])) {
 720                         unset($result[$label]);
 721                 } else {
 722                         $hosts = array_diff($hosts, $result[$label]);
 723                         if ($asap) break;
 724                 }
 725         }
 726
 727         $remains = $hosts;
 728
 729         return $result;
 730 }
 731
 732 // Default (enabled) methods and thresholds (for content insertion)
 733 function check_uri_spam_method($times = 1, $t_area = 0, $rule = TRUE)
 734 {
 735         $times  = intval($times);
 736         $t_area = intval($t_area);
 737
 738         $positive = array(
 739                 // Thresholds
 740                 'quantity'     =>  8 * $times,  // Allow N URIs
 741                 'non_uniqhost' =>  3 * $times,  // Allow N duped (and normalized) Hosts
 742                 //'non_uniquri'=>  3 * $times,  // Allow N duped (and normalized) URIs
 743
 744                 // Areas
 745                 'area_anchor'  => $t_area,      // Using <a href> HTML tag
 746                 'area_bbcode'  => $t_area,      // Using [url] or [link] BBCode
 747                 //'uri_anchor' => $t_area,      // URI inside <a href> HTML tag
 748                 //'uri_bbcode' => $t_area,      // URI inside [url] or [link] BBCode
 749         );
 750         if ($rule) {
 751                 $bool = array(
 752                         // Rules
 753                         //'asap'   => TRUE,     // Quit or return As Soon As Possible
 754                         'uniqhost' => TRUE,     // Show uniq host (at block notification mail)
 755                         'badhost'  => TRUE,     // Check badhost
 756                 );
 757         } else {
 758                 $bool = array();
 759         }
 760
 761         // Remove non-$positive values
 762         foreach (array_keys($positive) as $key) {
 763                 if ($positive[$key] < 0) unset($positive[$key]);
 764         }
 765
 766         return $positive + $bool;
 767 }
 768
 769 // Simple/fast spam check
 770 function check_uri_spam($target = '', $method = array())
 771 {
 772         if (! is_array($method) || empty($method)) {
 773                 $method = check_uri_spam_method();
 774         }
 775         $progress = array(
 776                 'sum' => array(
 777                         'quantity'    => 0,
 778                         'uniqhost'    => 0,
 779                         'non_uniqhost'=> 0,
 780                         'non_uniquri' => 0,
 781                         'badhost'     => 0,
 782                         'area_anchor' => 0,
 783                         'area_bbcode' => 0,
 784                         'uri_anchor'  => 0,
 785                         'uri_bbcode'  => 0,
 786                 ),
 787                 'is_spam' => array(),
 788                 'method'  => & $method,
 789                 'remains' => array(),
 790         );
 791         $sum     = & $progress['sum'];
 792         $is_spam = & $progress['is_spam'];
 793         $remains = & $progress['remains'];
 794         $asap    = isset($method['asap']);
 795
 796         // Recurse
 797         if (is_array($target)) {
 798                 foreach($target as $str) {
 799                         // Recurse
 800                         $_progress = check_uri_spam($str, $method);
 801                         $_sum      = & $_progress['sum'];
 802                         $_is_spam  = & $_progress['is_spam'];
 803                         $_remains  = & $_progress['remains'];
 804                         foreach (array_keys($_sum) as $key) {
 805                                 $sum[$key] += $_sum[$key];
 806                         }
 807                         foreach (array_keys($_is_spam) as $key) {
 808                                 if (is_array($_is_spam[$key])) {
 809                                         // Marge keys (badhost)
 810                                         foreach(array_keys($_is_spam[$key]) as $_key) {
 811                                                 if (! isset($is_spam[$key][$_key])) {
 812                                                         $is_spam[$key][$_key] =  $_is_spam[$key][$_key];
 813                                                 } else {
 814                                                         $is_spam[$key][$_key] += $_is_spam[$key][$_key];
 815                                                 }
 816                                         }
 817                                 } else {
 818                                         $is_spam[$key] = TRUE;
 819                                 }
 820                         }
 821                         foreach ($_remains as $key=>$value) {
 822                                 foreach ($value as $_key=>$_value) {
 823                                         if (is_int($_key)) {
 824                                                 $remains[$key][]      = $_value;
 825                                         } else {
 826                                                 $remains[$key][$_key] = $_value;
 827                                         }
 828                                 }
 829                         }
 830                         if ($asap && $is_spam) break;
 831                 }
 832                 return $progress;
 833         }
 834
 835         // Area: There's HTML anchor tag
 836         if ((! $asap || ! $is_spam) && isset($method['area_anchor'])) {
 837                 $key = 'area_anchor';
 838                 $_asap = isset($method['asap']) ? array('asap' => TRUE) : array();
 839                 $result = area_pickup($target, array($key => TRUE) + $_asap);
 840                 if ($result) {
 841                         $sum[$key] = $result[$key];
 842                         if (isset($method[$key]) && $sum[$key] > $method[$key]) {
 843                                 $is_spam[$key] = TRUE;
 844                         }
 845                 }
 846         }
 847
 848         // Area: There's 'BBCode' linking tag
 849         if ((! $asap || ! $is_spam) && isset($method['area_bbcode'])) {
 850                 $key = 'area_bbcode';
 851                 $_asap = isset($method['asap']) ? array('asap' => TRUE) : array();
 852                 $result = area_pickup($target, array($key => TRUE) + $_asap);
 853                 if ($result) {
 854                         $sum[$key] = $result[$key];
 855                         if (isset($method[$key]) && $sum[$key] > $method[$key]) {
 856                                 $is_spam[$key] = TRUE;
 857                         }
 858                 }
 859         }
 860
 861         // Return if ...
 862         if ($asap && $is_spam) return $progress;
 863
 864         // URI: Pickup
 865         $pickups = spam_uri_pickup($target, $method);
 866         //$remains['uri_pickup'] = & $pickups;
 867
 868         // Return if ...
 869         if (empty($pickups)) return $progress;
 870
 871         // URI: Check quantity
 872         $sum['quantity'] += count($pickups);
 873                 // URI quantity
 874         if ((! $asap || ! $is_spam) && isset($method['quantity']) &&
 875                 $sum['quantity'] > $method['quantity']) {
 876                 $is_spam['quantity'] = TRUE;
 877         }
 878
 879         // URI: used inside HTML anchor tag pair
 880         if ((! $asap || ! $is_spam) && isset($method['uri_anchor'])) {
 881                 $key = 'uri_anchor';
 882                 foreach($pickups as $pickup) {
 883                         if (isset($pickup['area'][$key])) {
 884                                 $sum[$key] += $pickup['area'][$key];
 885                                 if(isset($method[$key]) &&
 886                                         $sum[$key] > $method[$key]) {
 887                                         $is_spam[$key] = TRUE;
 888                                         if ($asap && $is_spam) break;
 889                                 }
 890                                 if ($asap && $is_spam) break;
 891                         }
 892                 }
 893         }
 894
 895         // URI: used inside 'BBCode' pair
 896         if ((! $asap || ! $is_spam) && isset($method['uri_bbcode'])) {
 897                 $key = 'uri_bbcode';
 898                 foreach($pickups as $pickup) {
 899                         if (isset($pickup['area'][$key])) {
 900                                 $sum[$key] += $pickup['area'][$key];
 901                                 if(isset($method[$key]) &&
 902                                         $sum[$key] > $method[$key]) {
 903                                         $is_spam[$key] = TRUE;
 904                                         if ($asap && $is_spam) break;
 905                                 }
 906                                 if ($asap && $is_spam) break;
 907                         }
 908                 }
 909         }
 910
 911         // URI: Uniqueness (and removing non-uniques)
 912         if ((! $asap || ! $is_spam) && isset($method['non_uniquri'])) {
 913
 914                 // Destructive normalize of URIs
 915                 uri_array_normalize($pickups);
 916
 917                 $uris = array();
 918                 foreach (array_keys($pickups) as $key) {
 919                         $uris[$key] = uri_array_implode($pickups[$key]);
 920                 }
 921                 $count = count($uris);
 922                 $uris  = array_unique($uris);
 923                 $sum['non_uniquri'] += $count - count($uris);
 924                 if ($sum['non_uniquri'] > $method['non_uniquri']) {
 925                         $is_spam['non_uniquri'] = TRUE;
 926                 }
 927                 if (! $asap || ! $is_spam) {
 928                         foreach (array_diff(array_keys($pickups),
 929                                 array_keys($uris)) as $remove) {
 930                                 unset($pickups[$remove]);
 931                         }
 932                 }
 933                 unset($uris);
 934         }
 935
 936         // Return if ...
 937         if ($asap && $is_spam) return $progress;
 938
 939         // Host: Uniqueness (uniq / non-uniq)
 940         $hosts = array();
 941         foreach ($pickups as $pickup) $hosts[] = & $pickup['host'];
 942         $hosts = array_unique($hosts);
 943         //$remains['uniqhost'] = & $hosts;
 944         $sum['uniqhost'] += count($hosts);
 945         if ((! $asap || ! $is_spam) && isset($method['non_uniqhost'])) {
 946                 $sum['non_uniqhost'] = $sum['quantity'] - $sum['uniqhost'];
 947                 if ($sum['non_uniqhost'] > $method['non_uniqhost']) {
 948                         $is_spam['non_uniqhost'] = TRUE;
 949                 }
 950         }
 951
 952         // Return if ...
 953         if ($asap && $is_spam) return $progress;
 954
 955         // URI: Bad host
 956         if ((! $asap || ! $is_spam) && isset($method['badhost'])) {
 957                 $__remains = array();
 958                 if ($asap) {
 959                         $badhost = is_badhost($hosts, $asap, $__remains);
 960                 } else {
 961                         $badhost = is_badhost($hosts, $asap, $__remains);
 962                         if ($__remains) {
 963                                 $remains['badhost'] = array();
 964                                 foreach ($__remains as $value) {
 965                                         $remains['badhost'][$value] = TRUE;
 966                                 }
 967                         }
 968                 }
 969                 unset($__remains);
 970                 if (! empty($badhost)) {
 971                         $sum['badhost'] += array_count_leaves($badhost);
 972                         foreach(array_keys($badhost) as $keys) {
 973                                 $is_spam['badhost'][$keys] =
 974                                         array_count_leaves($badhost[$keys]);
 975                         }
 976                         unset($badhost);
 977                 }
 978         }
 979
 980         return $progress;
 981 }
 982
 983 // Count leaves
 984 function array_count_leaves($array = array(), $count_empty_array = FALSE)
 985 {
 986         if (! is_array($array) || (empty($array) && $count_empty_array))
 987                 return 1;
 988
 989         // Recurse
 990         $result = 0;
 991         foreach ($array as $part) {
 992                 $result += array_count_leaves($part, $count_empty_array);
 993         }
 994         return $result;
 995 }
 996
 997 // ---------------------
 998 // Reporting
 999
1000 // TODO: Don't show unused $method!
1001 // Summarize $progress (blocked only)
1002 function summarize_spam_progress($progress = array(), $blockedonly = FALSE)
1003 {
1004         if ($blockedonly) {
1005                 $tmp = array_keys($progress['is_spam']);
1006         } else {
1007                 $tmp = array();
1008                 $method = & $progress['method'];
1009                 if (isset($progress['sum'])) {
1010                         foreach ($progress['sum'] as $key => $value) {
1011                                 if (isset($method[$key])) {
1012                                         $tmp[] = $key . '(' . $value . ')';
1013                                 }
1014                         }
1015                 }
1016         }
1017
1018         return implode(', ', $tmp);
1019 }
1020
1021 // ---------------------
1022 // Exit
1023
1024 // Common bahavior for blocking
1025 // NOTE: Call this function from various blocking feature, to disgueise the reason 'why blocked'
1026 function spam_exit($mode = '', $data = array())
1027 {
1028         switch ($mode) {
1029                 case '':        echo("\n");     break;
1030                 case 'dump':
1031                         echo('<pre>' . "\n");
1032                         echo htmlspecialchars(var_export($data, TRUE));
1033                         echo('</pre>' . "\n");
1034                         break;
1035         };
1036
1037         // Force exit
1038         exit;
1039 }
1040
1041
1042 // ---------------------
1043 // Simple filtering
1044
1045 // TODO: Record them
1046 // Simple/fast spam filter ($target: 'a string' or an array())
1047 function pkwk_spamfilter($action, $page, $target = array('title' => ''), $method = array(), $exitmode = '')
1048 {
1049         $progress = check_uri_spam($target, $method);
1050
1051         if (! empty($progress['is_spam'])) {
1052                 // Mail to administrator(s)
1053                 pkwk_spamnotify($action, $page, $target, $progress, $method);
1054
1055                 // Exit
1056                 spam_exit($exitmode, $progress);
1057         }
1058 }
1059
1060 // ---------------------
1061 // PukiWiki original
1062
1063 // Mail to administrator(s)
1064 function pkwk_spamnotify($action, $page, $target = array('title' => ''), $progress = array(), $method = array())
1065 {
1066         global $notify, $notify_subject;
1067
1068         if (! $notify) return;
1069
1070         $asap = isset($method['asap']);
1071
1072         $summary['ACTION']  = 'Blocked by: ' . summarize_spam_progress($progress, TRUE);
1073         if (! $asap) {
1074                 $summary['METRICS'] = summarize_spam_progress($progress);
1075         }
1076         if (isset($progress['is_spam']['badhost'])) {
1077                 $badhost = array();
1078                 foreach($progress['is_spam']['badhost'] as $glob=>$number) {
1079                         $badhost[] = $glob . '(' . $number . ')';
1080                 }
1081                 $summary['DETAIL_BADHOST'] = implode(', ', $badhost);
1082         }
1083         if (! $asap && $progress['remains']['badhost']) {
1084                 $count = count($progress['remains']['badhost']);
1085                 $summary['DETAIL_NEUTRAL_HOST'] = $count .
1086                         ' (' .
1087                                 preg_replace(
1088                                         '/[^, a-z0-9.-]/i', '',
1089                                         implode(', ', array_keys($progress['remains']['badhost']))
1090                                 ) .
1091                         ')';
1092         }
1093         $summary['COMMENT'] = $action;
1094         $summary['PAGE']    = '[blocked] ' . (is_pagename($page) ? $page : '');
1095         $summary['URI']     = get_script_uri() . '?' . rawurlencode($page);
1096         $summary['USER_AGENT']  = TRUE;
1097         $summary['REMOTE_ADDR'] = TRUE;
1098         pkwk_mail_notify($notify_subject,  var_export($target, TRUE), $summary, TRUE);
1099 }
1100
1101 ?>