includes/GlobalFunctions.php

   1 <?php
   2 # Global functions used everywhere
   3
   4 $wgNumberOfArticles = -1; # Unset
   5 $wgTotalViews = -1;
   6 $wgTotalEdits = -1;
   7
   8 require_once( 'DatabaseFunctions.php' );
   9 require_once( 'UpdateClasses.php' );
  10 require_once( 'LogPage.php' );
  11
  12 /*
  13  * Compatibility functions
  14  */
  15
  16 # PHP <4.3.x is not actively supported; 4.1.x and 4.2.x might or might not work.
  17 # <4.1.x will not work, as we use a number of features introduced in 4.1.0
  18 # such as the new autoglobals.
  19
  20 if( !function_exists('iconv') ) {
  21         # iconv support is not in the default configuration and so may not be present.
  22         # Assume will only ever use utf-8 and iso-8859-1.
  23         # This will *not* work in all circumstances.
  24         function iconv( $from, $to, $string ) {
  25                 if(strcasecmp( $from, $to ) == 0) return $string;
  26                 if(strcasecmp( $from, 'utf-8' ) == 0) return utf8_decode( $string );
  27                 if(strcasecmp( $to, 'utf-8' ) == 0) return utf8_encode( $string );
  28                 return $string;
  29         }
  30 }
  31
  32 if( !function_exists('file_get_contents') ) {
  33         # Exists in PHP 4.3.0+
  34         function file_get_contents( $filename ) {
  35                 return implode( '', file( $filename ) );
  36         }
  37 }
  38
  39 if( !function_exists('is_a') ) {
  40         # Exists in PHP 4.2.0+
  41         function is_a( $object, $class_name ) {
  42                 return
  43                         (strcasecmp( get_class( $object ), $class_name ) == 0) ||
  44                          is_subclass_of( $object, $class_name );
  45         }
  46 }
  47
  48 # html_entity_decode exists in PHP 4.3.0+ but is FATALLY BROKEN even then,
  49 # with no UTF-8 support.
  50 function do_html_entity_decode( $string, $quote_style=ENT_COMPAT, $charset='ISO-8859-1' ) {
  51         static $trans;
  52         if( !isset( $trans ) ) {
  53                 $trans = array_flip( get_html_translation_table( HTML_ENTITIES, $quote_style ) );
  54                 # Assumes $charset will always be the same through a run, and only understands
  55                 # utf-8 or default. Note - mixing latin1 named entities and unicode numbered
  56                 # ones will result in a bad link.
  57                 if( strcasecmp( 'utf-8', $charset ) == 0 ) {
  58                         $trans = array_map( 'utf8_encode', $trans );
  59                 }
  60         }
  61         return strtr( $string, $trans );
  62 }
  63
  64 $wgRandomSeeded = false;
  65
  66 function wfSeedRandom()
  67 {
  68         global $wgRandomSeeded;
  69
  70         if ( ! $wgRandomSeeded ) {
  71                 $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff;
  72                 mt_srand( $seed );
  73                 $wgRandomSeeded = true;
  74         }
  75 }
  76
  77 # Generates a URL from a URL-encoded title and a query string
  78 # Title::getLocalURL() is preferred in most cases
  79 #
  80 function wfLocalUrl( $a, $q = '' )
  81 {
  82         global $wgServer, $wgScript, $wgArticlePath;
  83
  84         $a = str_replace( ' ', '_', $a );
  85
  86         if ( '' == $a ) {
  87                 if( '' == $q ) {
  88                         $a = $wgScript;
  89                 } else {
  90                         $a = "{$wgScript}?{$q}";
  91                 }
  92         } else if ( '' == $q ) {
  93                 $a = str_replace( "$1", $a, $wgArticlePath );
  94         } else if ($wgScript != '' ) {
  95                 $a = "{$wgScript}?title={$a}&{$q}";
  96         } else { //XXX hackish solution for toplevel wikis
  97                 $a = "/{$a}?{$q}";
  98         }
  99         return $a;
 100 }
 101
 102 function wfLocalUrlE( $a, $q = '' )
 103 {
 104         return wfEscapeHTML( wfLocalUrl( $a, $q ) );
 105         # die( "Call to obsolete function wfLocalUrlE()" );
 106 }
 107
 108 function wfFullUrl( $a, $q = '' ) {
 109         wfDebugDieBacktrace( 'Call to obsolete function wfFullUrl(); use Title::getFullURL' );
 110 }
 111
 112 function wfFullUrlE( $a, $q = '' ) {
 113         wfDebugDieBacktrace( 'Call to obsolete function wfFullUrlE(); use Title::getFullUrlE' );
 114
 115 }
 116
 117 // orphan function wfThumbUrl( $img )
 118 //{
 119 //      global $wgUploadPath;
 120 //
 121 //      $nt = Title::newFromText( $img );
 122 //      if( !$nt ) return "";
 123 //
 124 //      $name = $nt->getDBkey();
 125 //      $hash = md5( $name );
 126 //
 127 //      $url = "{$wgUploadPath}/thumb/" . $hash{0} . "/" .
 128 //        substr( $hash, 0, 2 ) . "/{$name}";
 129 //      return wfUrlencode( $url );
 130 //}
 131
 132
 133 function wfImageArchiveUrl( $name )
 134 {
 135         global $wgUploadPath;
 136
 137         $hash = md5( substr( $name, 15) );
 138         $url = "{$wgUploadPath}/archive/" . $hash{0} . "/" .
 139           substr( $hash, 0, 2 ) . "/{$name}";
 140         return wfUrlencode($url);
 141 }
 142
 143 function wfUrlencode ( $s )
 144 {
 145         $s = urlencode( $s );
 146         $s = preg_replace( '/%3[Aa]/', ':', $s );
 147         $s = preg_replace( '/%2[Ff]/', '/', $s );
 148
 149         return $s;
 150 }
 151
 152 function wfUtf8Sequence($codepoint) {
 153         if($codepoint <         0x80) return chr($codepoint);
 154         if($codepoint <    0x800) return chr($codepoint >>      6 & 0x3f | 0xc0) .
 155                                                                          chr($codepoint           & 0x3f | 0x80);
 156         if($codepoint <  0x10000) return chr($codepoint >> 12 & 0x0f | 0xe0) .
 157                                                                          chr($codepoint >>      6 & 0x3f | 0x80) .
 158                                                                          chr($codepoint           & 0x3f | 0x80);
 159         if($codepoint < 0x100000) return chr($codepoint >> 18 & 0x07 | 0xf0) . # Double-check this
 160                                                                          chr($codepoint >> 12 & 0x3f | 0x80) .
 161                                                                          chr($codepoint >>      6 & 0x3f | 0x80) .
 162                                                                          chr($codepoint           & 0x3f | 0x80);
 163         # Doesn't yet handle outside the BMP
 164         return "&#$codepoint;";
 165 }
 166
 167 # Converts numeric character entities to UTF-8
 168 function wfMungeToUtf8($string) {
 169         global $wgInputEncoding; # This is debatable
 170         #$string = iconv($wgInputEncoding, "UTF-8", $string);
 171         $string = preg_replace ( '/&#([0-9]+);/e', 'wfUtf8Sequence($1)', $string );
 172         $string = preg_replace ( '/&#x([0-9a-f]+);/ie', 'wfUtf8Sequence(0x$1)', $string );
 173         # Should also do named entities here
 174         return $string;
 175 }
 176
 177 # Converts a single UTF-8 character into the corresponding HTML character entity
 178 function wfUtf8Entity( $matches ) {
 179         $char = $matches[0];
 180         # Find the length
 181         $z = ord( $char{0} );
 182         if ( $z & 0x80 ) {
 183                 $length = 0;
 184                 while ( $z & 0x80 ) {
 185                         $length++;
 186                         $z <<= 1;
 187                 }
 188         } else {
 189                 $length = 1;
 190         }
 191
 192         if ( $length != strlen( $char ) ) {
 193                 return '';
 194         }
 195         if ( $length == 1 ) {
 196                 return $char;
 197         }
 198
 199         # Mask off the length-determining bits and shift back to the original location
 200         $z &= 0xff;
 201         $z >>= $length;
 202
 203         # Add in the free bits from subsequent bytes
 204         for ( $i=1; $i<$length; $i++ ) {
 205                 $z <<= 6;
 206                 $z |= ord( $char{$i} ) & 0x3f;
 207         }
 208
 209         # Make entity
 210         return "&#$z;";
 211 }
 212
 213 # Converts all multi-byte characters in a UTF-8 string into the appropriate character entity
 214 function wfUtf8ToHTML($string) {
 215         return preg_replace_callback( '/[\\xc0-\\xfd][\\x80-\\xbf]*/', 'wfUtf8Entity', $string );
 216 }
 217
 218 function wfDebug( $text, $logonly = false )
 219 {
 220         global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly;
 221
 222         if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) {
 223                 $wgOut->debug( $text );
 224         }
 225         if ( "" != $wgDebugLogFile && !$wgProfileOnly ) {
 226                 error_log( $text, 3, $wgDebugLogFile );
 227         }
 228 }
 229
 230 # Log for database errors
 231 function wfLogDBError( $text ) {
 232         global $wgDBerrorLog;
 233         if ( $wgDBerrorLog ) {
 234                 $text = date("D M j G:i:s T Y") . "\t$text";
 235                 error_log( $text, 3, $wgDBerrorLog );
 236         }
 237 }
 238
 239 function logProfilingData()
 240 {
 241         global $wgRequestTime, $wgDebugLogFile;
 242         global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
 243         $now = wfTime();
 244
 245         list( $usec, $sec ) = explode( " ", $wgRequestTime );
 246         $start = (float)$sec + (float)$usec;
 247         $elapsed = $now - $start;
 248         if ( $wgProfiling ) {
 249                 $prof = wfGetProfilingOutput( $start, $elapsed );
 250                 $forward = '';
 251                 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
 252                         $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
 253                 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
 254                         $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
 255                 if( !empty( $_SERVER['HTTP_FROM'] ) )
 256                         $forward .= ' from ' . $_SERVER['HTTP_FROM'];
 257                 if( $forward )
 258                         $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
 259                 if($wgUser->getId() == 0)
 260                         $forward .= ' anon';
 261                 $log = sprintf( "%s\t%04.3f\t%s\n",
 262                   gmdate( 'YmdHis' ), $elapsed,
 263                   urldecode( $_SERVER['REQUEST_URI'] . $forward ) );
 264                 if ( '' != $wgDebugLogFile ) {
 265                         error_log( $log . $prof, 3, $wgDebugLogFile );
 266                 }
 267         }
 268 }
 269
 270
 271 function wfReadOnly()
 272 {
 273         global $wgReadOnlyFile;
 274
 275         if ( "" == $wgReadOnlyFile ) { return false; }
 276         return is_file( $wgReadOnlyFile );
 277 }
 278
 279 $wgReplacementKeys = array( "$1", "$2", "$3", "$4", "$5", "$6", "$7", "$8", "$9" );
 280
 281 # Get a message from anywhere
 282 function wfMsg( $key ) {
 283         $args = func_get_args();
 284         if ( count( $args ) ) {
 285                 array_shift( $args );
 286         }
 287         return wfMsgReal( $key, $args, true );
 288 }
 289
 290 # Get a message from the language file
 291 function wfMsgNoDB( $key ) {
 292         $args = func_get_args();
 293         if ( count( $args ) ) {
 294                 array_shift( $args );
 295         }
 296         return wfMsgReal( $key, $args, false );
 297 }
 298
 299 # Really get a message
 300 function wfMsgReal( $key, $args, $useDB ) {
 301         global $wgReplacementKeys, $wgMessageCache, $wgLang;
 302
 303         $fname = 'wfMsg';
 304         wfProfileIn( $fname );
 305         if ( $wgMessageCache ) {
 306                 $message = $wgMessageCache->get( $key, $useDB );
 307         } elseif ( $wgLang ) {
 308                 $message = $wgLang->getMessage( $key );
 309         } else {
 310                 wfDebug( "No language object when getting $key\n" );
 311                 $message = "&lt;$key&gt;";
 312         }
 313
 314         # Replace arguments
 315         if( count( $args ) ) {
 316                 $message = str_replace( $wgReplacementKeys, $args, $message );
 317         }
 318         wfProfileOut( $fname );
 319         return $message;
 320 }
 321
 322 function wfCleanFormFields( $fields )
 323 {
 324         wfDebugDieBacktrace( 'Call to obsolete wfCleanFormFields(). Use wgRequest instead...' );
 325 }
 326
 327 function wfMungeQuotes( $in )
 328 {
 329         $out = str_replace( '%', '%25', $in );
 330         $out = str_replace( "'", '%27', $out );
 331         $out = str_replace( '"', '%22', $out );
 332         return $out;
 333 }
 334
 335 function wfDemungeQuotes( $in )
 336 {
 337         $out = str_replace( '%22', '"', $in );
 338         $out = str_replace( '%27', "'", $out );
 339         $out = str_replace( '%25', '%', $out );
 340         return $out;
 341 }
 342
 343 function wfCleanQueryVar( $var )
 344 {
 345         wfDebugDieBacktrace( 'Call to obsolete function wfCleanQueryVar(); use wgRequest instead' );
 346 }
 347
 348 function wfSearch( $s )
 349 {
 350         $se = new SearchEngine( $s );
 351         $se->showResults();
 352 }
 353
 354 function wfGo( $s )
 355 { # pick the nearest match
 356         $se = new SearchEngine( $s );
 357         $se->goResult();
 358 }
 359
 360 # Just like exit() but makes a note of it.
 361 function wfAbruptExit(){
 362         static $called = false;
 363         if ( $called ){
 364                 exit();
 365         }
 366         $called = true;
 367
 368         if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
 369                 $bt = debug_backtrace();
 370                 for($i = 0; $i < count($bt) ; $i++){
 371                         $file = $bt[$i]['file'];
 372                         $line = $bt[$i]['line'];
 373                         wfDebug("WARNING: Abrupt exit in $file at line $line\n");
 374                 }
 375         } else {
 376                 wfDebug('WARNING: Abrupt exit\n');
 377         }
 378         exit();
 379 }
 380
 381 function wfDebugDieBacktrace( $msg = '' ) {
 382         global $wgCommandLineMode;
 383
 384         if ( function_exists( 'debug_backtrace' ) ) {
 385                 if ( $wgCommandLineMode ) {
 386                         $msg .= "\nBacktrace:\n";
 387                 } else {
 388                         $msg .= "\n<p>Backtrace:</p>\n<ul>\n";
 389                 }
 390                 $backtrace = debug_backtrace();
 391                 foreach( $backtrace as $call ) {
 392                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
 393                         $file = $f[count($f)-1];
 394                         if ( $wgCommandLineMode ) {
 395                                 $msg .= "$file line {$call['line']}, in ";
 396                         } else {
 397                                 $msg .= '<li>' . $file . " line " . $call['line'] . ', in ';
 398                         }
 399                         if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 400                         $msg .= $call['function'] . "()";
 401
 402                         if ( $wgCommandLineMode ) {
 403                                 $msg .= "\n";
 404                         } else {
 405                                 $msg .= "</li>\n";
 406                         }
 407                 }
 408          }
 409          die( $msg );
 410 }
 411
 412 function wfNumberOfArticles()
 413 {
 414         global $wgNumberOfArticles;
 415
 416         wfLoadSiteStats();
 417         return $wgNumberOfArticles;
 418 }
 419
 420 /* private */ function wfLoadSiteStats()
 421 {
 422         global $wgNumberOfArticles, $wgTotalViews, $wgTotalEdits;
 423         if ( -1 != $wgNumberOfArticles ) return;
 424
 425         $sql = 'SELECT ss_total_views, ss_total_edits, ss_good_articles ' .
 426           'FROM site_stats WHERE ss_row_id=1';
 427         $res = wfQuery( $sql, DB_READ, 'wfLoadSiteStats' );
 428
 429         if ( 0 == wfNumRows( $res ) ) { return; }
 430         else {
 431                 $s = wfFetchObject( $res );
 432                 $wgTotalViews = $s->ss_total_views;
 433                 $wgTotalEdits = $s->ss_total_edits;
 434                 $wgNumberOfArticles = $s->ss_good_articles;
 435         }
 436 }
 437
 438 function wfEscapeHTML( $in )
 439 {
 440         return str_replace(
 441                 array( '&', '"', '>', '<' ),
 442                 array( '&amp;', '&quot;', '&gt;', '&lt;' ),
 443                 $in );
 444 }
 445
 446 function wfEscapeHTMLTagsOnly( $in ) {
 447         return str_replace(
 448                 array( '"', '>', '<' ),
 449                 array( '&quot;', '&gt;', '&lt;' ),
 450                 $in );
 451 }
 452
 453 function wfUnescapeHTML( $in )
 454 {
 455         $in = str_replace( '&lt;', '<', $in );
 456         $in = str_replace( '&gt;', '>', $in );
 457         $in = str_replace( '&quot;', '"', $in );
 458         $in = str_replace( '&amp;', '&', $in );
 459         return $in;
 460 }
 461
 462 function wfImageDir( $fname )
 463 {
 464         global $wgUploadDirectory;
 465
 466         $hash = md5( $fname );
 467         $oldumask = umask(0);
 468         $dest = $wgUploadDirectory . '/' . $hash{0};
 469         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
 470         $dest .= '/' . substr( $hash, 0, 2 );
 471         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
 472
 473         umask( $oldumask );
 474         return $dest;
 475 }
 476
 477 function wfImageThumbDir( $fname , $subdir='thumb')
 478 {
 479         return wfImageArchiveDir( $fname, $subdir );
 480 }
 481
 482 function wfImageArchiveDir( $fname , $subdir='archive')
 483 {
 484         global $wgUploadDirectory;
 485
 486         $hash = md5( $fname );
 487         $oldumask = umask(0);
 488
 489         # Suppress warning messages here; if the file itself can't
 490         # be written we'll worry about it then.
 491         $archive = "{$wgUploadDirectory}/{$subdir}";
 492         if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
 493         $archive .= '/' . $hash{0};
 494         if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
 495         $archive .= '/' . substr( $hash, 0, 2 );
 496         if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
 497
 498         umask( $oldumask );
 499         return $archive;
 500 }
 501
 502 function wfRecordUpload( $name, $oldver, $size, $desc, $copyStatus = "", $source = "" )
 503 {
 504         global $wgUser, $wgLang, $wgTitle, $wgOut, $wgDeferredUpdateList;
 505         global $wgUseCopyrightUpload;
 506
 507         $fname = 'wfRecordUpload';
 508
 509         $sql = 'SELECT img_name,img_size,img_timestamp,img_description,img_user,' .
 510           "img_user_text FROM image WHERE img_name='" . wfStrencode( $name ) . "'";
 511         $res = wfQuery( $sql, DB_READ, $fname );
 512
 513         $now = wfTimestampNow();
 514         $won = wfInvertTimestamp( $now );
 515         $size = IntVal( $size );
 516
 517         if ( $wgUseCopyrightUpload )
 518           {
 519                 $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
 520                   '== ' . wfMsg ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
 521                   '== ' . wfMsg ( 'filesource' ) . " ==\n" . $source ;
 522           }
 523         else $textdesc = $desc ;
 524
 525         $now = wfTimestampNow();
 526         $won = wfInvertTimestamp( $now );
 527
 528         if ( 0 == wfNumRows( $res ) ) {
 529                 $sql = 'INSERT INTO image (img_name,img_size,img_timestamp,' .
 530                   "img_description,img_user,img_user_text) VALUES ('" .
 531                   wfStrencode( $name ) . "',$size,'{$now}','" .
 532                   wfStrencode( $desc ) . "', '" . $wgUser->getID() .
 533                   "', '" . wfStrencode( $wgUser->getName() ) . "')";
 534                 wfQuery( $sql, DB_WRITE, $fname );
 535
 536                 $sql = 'SELECT cur_id,cur_text FROM cur WHERE cur_namespace=' .
 537                   Namespace::getImage() . " AND cur_title='" .
 538                   wfStrencode( $name ) . "'";
 539                 $res = wfQuery( $sql, DB_READ, $fname );
 540                 if ( 0 == wfNumRows( $res ) ) {
 541                         $common =
 542                           Namespace::getImage() . ",'" .
 543                           wfStrencode( $name ) . "','" .
 544                           wfStrencode( $desc ) . "','" . $wgUser->getID() . "','" .
 545                           wfStrencode( $wgUser->getName() ) . "','" . $now .
 546                           "',1";
 547                         $sql = 'INSERT INTO cur (cur_namespace,cur_title,' .
 548                           'cur_comment,cur_user,cur_user_text,cur_timestamp,cur_is_new,' .
 549                           'cur_text,inverse_timestamp,cur_touched) VALUES (' .
 550                           $common .
 551                           ",'" . wfStrencode( $textdesc ) . "','{$won}','{$now}')";
 552                         wfQuery( $sql, DB_WRITE, $fname );
 553                         $id = wfInsertId() or 0; # We should throw an error instead
 554
 555                         $titleObj = Title::makeTitle( NS_IMAGE, $name );
 556                         RecentChange::notifyNew( $now, $titleObj, 0, $wgUser, $desc );
 557
 558                         $u = new SearchUpdate( $id, $name, $desc );
 559                         $u->doUpdate();
 560                 }
 561         } else {
 562                 $s = wfFetchObject( $res );
 563
 564                 $sql = 'INSERT INTO oldimage (oi_name,oi_archive_name,oi_size,' .
 565                   "oi_timestamp,oi_description,oi_user,oi_user_text) VALUES ('" .
 566                   wfStrencode( $s->img_name ) . "','" .
 567                   wfStrencode( $oldver ) .
 568                   "',{$s->img_size},'{$s->img_timestamp}','" .
 569                   wfStrencode( $s->img_description ) . "','" .
 570                   wfStrencode( $s->img_user ) . "','" .
 571                   wfStrencode( $s->img_user_text) . "')";
 572                 wfQuery( $sql, DB_WRITE, $fname );
 573
 574                 $sql = "UPDATE image SET img_size={$size}," .
 575                   "img_timestamp='" . wfTimestampNow() . "',img_user='" .
 576                   $wgUser->getID() . "',img_user_text='" .
 577                   wfStrencode( $wgUser->getName() ) . "', img_description='" .
 578                   wfStrencode( $desc ) . "' WHERE img_name='" .
 579                   wfStrencode( $name ) . "'";
 580                 wfQuery( $sql, DB_WRITE, $fname );
 581
 582                 $sql = "UPDATE cur SET cur_touched='{$now}' WHERE cur_namespace=" .
 583                   Namespace::getImage() . " AND cur_title='" .
 584                   wfStrencode( $name ) . "'";
 585                 wfQuery( $sql, DB_WRITE, $fname );
 586         }
 587
 588         $log = new LogPage( wfMsg( 'uploadlogpage' ), wfMsg( 'uploadlogpagetext' ) );
 589         $da = wfMsg( 'uploadedimage', '[[:' . $wgLang->getNsText(
 590           Namespace::getImage() ) . ":{$name}|{$name}]]" );
 591         $ta = wfMsg( 'uploadedimage', $name );
 592         $log->addEntry( $da, $desc, $ta );
 593 }
 594
 595
 596 /* Some generic result counters, pulled out of SearchEngine */
 597
 598 function wfShowingResults( $offset, $limit )
 599 {
 600         global $wgLang;
 601         return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 602 }
 603
 604 function wfShowingResultsNum( $offset, $limit, $num )
 605 {
 606         global $wgLang;
 607         return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 608 }
 609
 610 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false )
 611 {
 612         global $wgUser, $wgLang;
 613         $fmtLimit = $wgLang->formatNum( $limit );
 614         $prev = wfMsg( 'prevn', $fmtLimit );
 615         $next = wfMsg( 'nextn', $fmtLimit );
 616         $link = wfUrlencode( $link );
 617
 618         $sk = $wgUser->getSkin();
 619         if ( 0 != $offset ) {
 620                 $po = $offset - $limit;
 621                 if ( $po < 0 ) { $po = 0; }
 622                 $q = "limit={$limit}&offset={$po}";
 623                 if ( '' != $query ) { $q .= "&{$query}"; }
 624                 $plink = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$prev}</a>";
 625         } else { $plink = $prev; }
 626
 627         $no = $offset + $limit;
 628         $q = "limit={$limit}&offset={$no}";
 629         if ( "" != $query ) { $q .= "&{$query}"; }
 630
 631         if ( $atend ) {
 632                 $nlink = $next;
 633         } else {
 634                 $nlink = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$next}</a>";
 635         }
 636         $nums = wfNumLink( $offset, 20, $link , $query ) . ' | ' .
 637           wfNumLink( $offset, 50, $link, $query ) . ' | ' .
 638           wfNumLink( $offset, 100, $link, $query ) . ' | ' .
 639           wfNumLink( $offset, 250, $link, $query ) . ' | ' .
 640           wfNumLink( $offset, 500, $link, $query );
 641
 642         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 643 }
 644
 645 function wfNumLink( $offset, $limit, $link, $query = '' )
 646 {
 647         global $wgUser, $wgLang;
 648         if ( '' == $query ) { $q = ''; }
 649         else { $q = "{$query}&"; }
 650         $q .= "limit={$limit}&offset={$offset}";
 651
 652         $fmtLimit = $wgLang->formatNum( $limit );
 653         $s = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$fmtLimit}</a>";
 654         return $s;
 655 }
 656
 657 function wfClientAcceptsGzip() {
 658         global $wgUseGzip;
 659         if( $wgUseGzip ) {
 660                 # FIXME: we may want to blacklist some broken browsers
 661                 if( preg_match(
 662                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
 663                         $_SERVER['HTTP_ACCEPT_ENCODING'],
 664                         $m ) ) {
 665                         if( ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
 666                         wfDebug( " accepts gzip\n" );
 667                         return true;
 668                 }
 669         }
 670         return false;
 671 }
 672
 673 # Yay, more global functions!
 674 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
 675         global $wgUser, $wgRequest;
 676
 677         $limit = $wgRequest->getInt( 'limit', 0 );
 678         if( $limit < 0 ) $limit = 0;
 679         if( ( $limit == 0 ) && ( $optionname != '' ) ) {
 680                 $limit = (int)$wgUser->getOption( $optionname );
 681         }
 682         if( $limit <= 0 ) $limit = $deflimit;
 683         if( $limit > 5000 ) $limit = 5000; # We have *some* limits...
 684
 685         $offset = $wgRequest->getInt( 'offset', 0 );
 686         if( $offset < 0 ) $offset = 0;
 687         if( $offset > 65000 ) $offset = 65000; # do we need a max? what?
 688
 689         return array( $limit, $offset );
 690 }
 691
 692 # Escapes the given text so that it may be output using addWikiText()
 693 # without any linking, formatting, etc. making its way through. This
 694 # is achieved by substituting certain characters with HTML entities.
 695 # As required by the callers, <nowiki> is not used. It currently does
 696 # not filter out characters which have special meaning only at the
 697 # start of a line, such as "*".
 698 function wfEscapeWikiText( $text )
 699 {
 700         $text = str_replace(
 701                 array( '[',             '|',      "'",     'ISBN '        , '://'         , "\n=" ),
 702                 array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;" ),
 703                 htmlspecialchars($text) );
 704         return $text;
 705 }
 706
 707 function wfQuotedPrintable( $string, $charset = '' )
 708 {
 709         # Probably incomplete; see RFC 2045
 710         if( empty( $charset ) ) {
 711                 global $wgInputEncoding;
 712                 $charset = $wgInputEncoding;
 713         }
 714         $charset = strtoupper( $charset );
 715         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 716
 717         $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 718         $replace = $illegal . '\t ?_';
 719         if( !preg_match( "/[$illegal]/", $string ) ) return $string;
 720         $out = "=?$charset?Q?";
 721         $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
 722         $out .= '?=';
 723         return $out;
 724 }
 725
 726 function wfTime(){
 727         $st = explode( ' ', microtime() );
 728         return (float)$st[0] + (float)$st[1];
 729 }
 730
 731 # Changes the first character to an HTML entity
 732 function wfHtmlEscapeFirst( $text ) {
 733         $ord = ord($text);
 734         $newText = substr($text, 1);
 735         return "&#$ord;$newText";
 736 }
 737
 738 # Sets dest to source and returns the original value of dest
 739 function wfSetVar( &$dest, $source )
 740 {
 741         $temp = $dest;
 742         $dest = $source;
 743         return $temp;
 744 }
 745
 746 # Sets dest to a reference to source and returns the original dest
 747 # Pity that doesn't work in PHP
 748 function &wfSetRef( &$dest, &$source )
 749 {
 750         die( "You can't rebind a variable in the caller's scope" );
 751 }
 752
 753 # This function takes two arrays as input, and returns a CGI-style string, e.g.
 754 # "days=7&limit=100". Options in the first array override options in the second.
 755 # Options set to "" will not be output.
 756 function wfArrayToCGI( $array1, $array2 = NULL )
 757 {
 758         if ( !is_null( $array2 ) ) {
 759                 $array1 = $array1 + $array2;
 760         }
 761
 762         $cgi = '';
 763         foreach ( $array1 as $key => $value ) {
 764                 if ( '' !== $value ) {
 765                         if ( '' != $cgi ) {
 766                                 $cgi .= '&';
 767                         }
 768                         $cgi .= "{$key}={$value}";
 769                 }
 770         }
 771         return $cgi;
 772 }
 773
 774 # This is obsolete, use SquidUpdate::purge()
 775 function wfPurgeSquidServers ($urlArr) {
 776         SquidUpdate::purge( $urlArr );
 777 }
 778
 779 # Windows-compatible version of escapeshellarg()
 780 function wfEscapeShellArg( )
 781 {
 782         $args = func_get_args();
 783         $first = true;
 784         $retVal = '';
 785         foreach ( $args as $arg ) {
 786                 if ( !$first ) {
 787                         $retVal .= ' ';
 788                 } else {
 789                         $first = false;
 790                 }
 791
 792                 if ( wfIsWindows() ) {
 793                         $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
 794                 } else {
 795                         $retVal .= escapeshellarg( $arg );
 796                 }
 797         }
 798         return $retVal;
 799 }
 800
 801 # wfMerge attempts to merge differences between three texts.
 802 # Returns true for a clean merge and false for failure or a conflict.
 803
 804 function wfMerge( $old, $mine, $yours, &$result ){
 805         global $wgDiff3;
 806
 807         # This check may also protect against code injection in
 808         # case of broken installations.
 809         if(! file_exists( $wgDiff3 ) ){
 810                 return false;
 811         }
 812
 813         # Make temporary files
 814         $td = '/tmp/';
 815         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
 816         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
 817         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
 818
 819         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
 820         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
 821         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
 822
 823         # Check for a conflict
 824         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
 825           wfEscapeShellArg( $mytextName ) . ' ' .
 826           wfEscapeShellArg( $oldtextName ) . ' ' .
 827           wfEscapeShellArg( $yourtextName );
 828         $handle = popen( $cmd, 'r' );
 829
 830         if( fgets( $handle ) ){
 831                 $conflict = true;
 832         } else {
 833                 $conflict = false;
 834         }
 835         pclose( $handle );
 836
 837         # Merge differences
 838         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
 839           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
 840         $handle = popen( $cmd, 'r' );
 841         $result = '';
 842         do {
 843                 $data = fread( $handle, 8192 );
 844                 if ( strlen( $data ) == 0 ) {
 845                         break;
 846                 }
 847                 $result .= $data;
 848         } while ( true );
 849         pclose( $handle );
 850         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
 851         return ! $conflict;
 852 }
 853
 854 function wfVarDump( $var )
 855 {
 856         global $wgOut;
 857         $s = str_replace("\n","<br>\n", var_export( $var, true ) . "\n");
 858         if ( headers_sent() || !@is_object( $wgOut ) ) {
 859                 print $s;
 860         } else {
 861                 $wgOut->addHTML( $s );
 862         }
 863 }
 864
 865 # Provide a simple HTTP error.
 866 function wfHttpError( $code, $label, $desc ) {
 867         global $wgOut;
 868         $wgOut->disable();
 869         header( "HTTP/1.0 $code $label" );
 870         header( "Status: $code $label" );
 871         $wgOut->sendCacheControl();
 872
 873         # Don't send content if it's a HEAD request.
 874         if( $_SERVER['REQUEST_METHOD'] == 'HEAD' ) {
 875                 header( 'Content-type: text/plain' );
 876                 print "$desc\n";
 877         }
 878 }
 879
 880 # Converts an Accept-* header into an array mapping string values to quality factors
 881 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
 882         # No arg means accept anything (per HTTP spec)
 883         if( !$accept ) {
 884                 return array( $def => 1 );
 885         }
 886
 887         $prefs = array();
 888
 889         $parts = explode( ',', $accept );
 890
 891         foreach( $parts as $part ) {
 892                 # FIXME: doesn't deal with params like 'text/html; level=1'
 893                 @list( $value, $qpart ) = explode( ';', $part );
 894                 if( !isset( $qpart ) ) {
 895                         $prefs[$value] = 1;
 896                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
 897                         $prefs[$value] = $match[1];
 898                 }
 899         }
 900
 901         return $prefs;
 902 }
 903
 904 /* private */ function mimeTypeMatch( $type, $avail ) {
 905         if( array_key_exists($type, $avail) ) {
 906                 return $type;
 907         } else {
 908                 $parts = explode( '/', $type );
 909                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
 910                         return $parts[0] . '/*';
 911                 } elseif( array_key_exists( '*/*', $avail ) ) {
 912                         return '*/*';
 913                 } else {
 914                         return NULL;
 915                 }
 916         }
 917 }
 918
 919 # FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
 920 # XXX: generalize to negotiate other stuff
 921 function wfNegotiateType( $cprefs, $sprefs ) {
 922         $combine = array();
 923
 924         foreach( array_keys($sprefs) as $type ) {
 925                 $parts = explode( '/', $type );
 926                 if( $parts[1] != '*' ) {
 927                         $ckey = mimeTypeMatch( $type, $cprefs );
 928                         if( $ckey ) {
 929                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
 930                         }
 931                 }
 932         }
 933
 934         foreach( array_keys( $cprefs ) as $type ) {
 935                 $parts = explode( '/', $type );
 936                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
 937                         $skey = mimeTypeMatch( $type, $sprefs );
 938                         if( $skey ) {
 939                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
 940                         }
 941                 }
 942         }
 943
 944         $bestq = 0;
 945         $besttype = NULL;
 946
 947         foreach( array_keys( $combine ) as $type ) {
 948                 if( $combine[$type] > $bestq ) {
 949                         $besttype = $type;
 950                         $bestq = $combine[$type];
 951                 }
 952         }
 953
 954         return $besttype;
 955 }
 956
 957 # Array lookup
 958 # Returns an array where the values in the first array are replaced by the
 959 # values in the second array with the corresponding keys
 960 function wfArrayLookup( $a, $b )
 961 {
 962         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
 963 }
 964
 965 # Since Windows is so different to any of the other popular OSes, it seems appropriate
 966 # to have a simple way to test for its presence
 967 function wfIsWindows() {
 968         if (substr(php_uname(), 0, 7) == 'Windows') {
 969                 return true;
 970         } else {
 971                 return false;
 972         }
 973 }
 974
 975 ?>