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 function logProfilingData()
 231 {
 232         global $wgRequestTime, $wgDebugLogFile;
 233         global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
 234         $now = wfTime();
 235
 236         list( $usec, $sec ) = explode( " ", $wgRequestTime );
 237         $start = (float)$sec + (float)$usec;
 238         $elapsed = $now - $start;
 239         if ( $wgProfiling ) {
 240                 $prof = wfGetProfilingOutput( $start, $elapsed );
 241                 $forward = '';
 242                 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
 243                         $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
 244                 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
 245                         $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
 246                 if( !empty( $_SERVER['HTTP_FROM'] ) )
 247                         $forward .= ' from ' . $_SERVER['HTTP_FROM'];
 248                 if( $forward )
 249                         $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
 250                 if($wgUser->getId() == 0)
 251                         $forward .= ' anon';
 252                 $log = sprintf( "%s\t%04.3f\t%s\n",
 253                   gmdate( 'YmdHis' ), $elapsed,
 254                   urldecode( $_SERVER['REQUEST_URI'] . $forward ) );
 255                 if ( '' != $wgDebugLogFile ) {
 256                         error_log( $log . $prof, 3, $wgDebugLogFile );
 257                 }
 258         }
 259 }
 260
 261
 262 function wfReadOnly()
 263 {
 264         global $wgReadOnlyFile;
 265
 266         if ( "" == $wgReadOnlyFile ) { return false; }
 267         return is_file( $wgReadOnlyFile );
 268 }
 269
 270 $wgReplacementKeys = array( "$1", "$2", "$3", "$4", "$5", "$6", "$7", "$8", "$9" );
 271
 272 # Get a message from anywhere
 273 function wfMsg( $key ) {
 274         $args = func_get_args();
 275         if ( count( $args ) ) {
 276                 array_shift( $args );
 277         }
 278         return wfMsgReal( $key, $args, true );
 279 }
 280
 281 # Get a message from the language file
 282 function wfMsgNoDB( $key ) {
 283         $args = func_get_args();
 284         if ( count( $args ) ) {
 285                 array_shift( $args );
 286         }
 287         return wfMsgReal( $key, $args, false );
 288 }
 289
 290 # Really get a message
 291 function wfMsgReal( $key, $args, $useDB ) {
 292         global $wgReplacementKeys, $wgMessageCache, $wgLang;
 293
 294         $fname = 'wfMsg';
 295         wfProfileIn( $fname );
 296         if ( $wgMessageCache ) {
 297                 $message = $wgMessageCache->get( $key, $useDB );
 298         } elseif ( $wgLang ) {
 299                 $message = $wgLang->getMessage( $key );
 300         } else {
 301                 wfDebug( "No language object when getting $key\n" );
 302                 $message = "&lt;$key&gt;";
 303         }
 304
 305         # Replace arguments
 306         if( count( $args ) ) {
 307                 $message = str_replace( $wgReplacementKeys, $args, $message );
 308         }
 309         wfProfileOut( $fname );
 310         return $message;
 311 }
 312
 313 function wfCleanFormFields( $fields )
 314 {
 315         wfDebugDieBacktrace( 'Call to obsolete wfCleanFormFields(). Use wgRequest instead...' );
 316 }
 317
 318 function wfMungeQuotes( $in )
 319 {
 320         $out = str_replace( '%', '%25', $in );
 321         $out = str_replace( "'", '%27', $out );
 322         $out = str_replace( '"', '%22', $out );
 323         return $out;
 324 }
 325
 326 function wfDemungeQuotes( $in )
 327 {
 328         $out = str_replace( '%22', '"', $in );
 329         $out = str_replace( '%27', "'", $out );
 330         $out = str_replace( '%25', '%', $out );
 331         return $out;
 332 }
 333
 334 function wfCleanQueryVar( $var )
 335 {
 336         wfDebugDieBacktrace( 'Call to obsolete function wfCleanQueryVar(); use wgRequest instead' );
 337 }
 338
 339 function wfSearch( $s )
 340 {
 341         $se = new SearchEngine( $s );
 342         $se->showResults();
 343 }
 344
 345 function wfGo( $s )
 346 { # pick the nearest match
 347         $se = new SearchEngine( $s );
 348         $se->goResult();
 349 }
 350
 351 # Just like exit() but makes a note of it.
 352 function wfAbruptExit(){
 353         static $called = false;
 354         if ( $called ){
 355                 exit();
 356         }
 357         $called = true;
 358
 359         if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
 360                 $bt = debug_backtrace();
 361                 for($i = 0; $i < count($bt) ; $i++){
 362                         $file = $bt[$i]['file'];
 363                         $line = $bt[$i]['line'];
 364                         wfDebug("WARNING: Abrupt exit in $file at line $line\n");
 365                 }
 366         } else {
 367                 wfDebug('WARNING: Abrupt exit\n');
 368         }
 369         exit();
 370 }
 371
 372 function wfDebugDieBacktrace( $msg = '' ) {
 373         global $wgCommandLineMode;
 374
 375         if ( function_exists( 'debug_backtrace' ) ) {
 376                 if ( $wgCommandLineMode ) {
 377                         $msg .= "\nBacktrace:\n";
 378                 } else {
 379                         $msg .= "\n<p>Backtrace:</p>\n<ul>\n";
 380                 }
 381                 $backtrace = debug_backtrace();
 382                 foreach( $backtrace as $call ) {
 383                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
 384                         $file = $f[count($f)-1];
 385                         if ( $wgCommandLineMode ) {
 386                                 $msg .= "$file line {$call['line']}, in ";
 387                         } else {
 388                                 $msg .= '<li>' . $file . " line " . $call['line'] . ', in ';
 389                         }
 390                         if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 391                         $msg .= $call['function'] . "()";
 392
 393                         if ( $wgCommandLineMode ) {
 394                                 $msg .= "\n";
 395                         } else {
 396                                 $msg .= "</li>\n";
 397                         }
 398                 }
 399          }
 400          die( $msg );
 401 }
 402
 403 function wfNumberOfArticles()
 404 {
 405         global $wgNumberOfArticles;
 406
 407         wfLoadSiteStats();
 408         return $wgNumberOfArticles;
 409 }
 410
 411 /* private */ function wfLoadSiteStats()
 412 {
 413         global $wgNumberOfArticles, $wgTotalViews, $wgTotalEdits;
 414         if ( -1 != $wgNumberOfArticles ) return;
 415
 416         $sql = 'SELECT ss_total_views, ss_total_edits, ss_good_articles ' .
 417           'FROM site_stats WHERE ss_row_id=1';
 418         $res = wfQuery( $sql, DB_READ, 'wfLoadSiteStats' );
 419
 420         if ( 0 == wfNumRows( $res ) ) { return; }
 421         else {
 422                 $s = wfFetchObject( $res );
 423                 $wgTotalViews = $s->ss_total_views;
 424                 $wgTotalEdits = $s->ss_total_edits;
 425                 $wgNumberOfArticles = $s->ss_good_articles;
 426         }
 427 }
 428
 429 function wfEscapeHTML( $in )
 430 {
 431         return str_replace(
 432                 array( '&', '"', '>', '<' ),
 433                 array( '&amp;', '&quot;', '&gt;', '&lt;' ),
 434                 $in );
 435 }
 436
 437 function wfEscapeHTMLTagsOnly( $in ) {
 438         return str_replace(
 439                 array( '"', '>', '<' ),
 440                 array( '&quot;', '&gt;', '&lt;' ),
 441                 $in );
 442 }
 443
 444 function wfUnescapeHTML( $in )
 445 {
 446         $in = str_replace( '&lt;', '<', $in );
 447         $in = str_replace( '&gt;', '>', $in );
 448         $in = str_replace( '&quot;', '"', $in );
 449         $in = str_replace( '&amp;', '&', $in );
 450         return $in;
 451 }
 452
 453 function wfImageDir( $fname )
 454 {
 455         global $wgUploadDirectory;
 456
 457         $hash = md5( $fname );
 458         $oldumask = umask(0);
 459         $dest = $wgUploadDirectory . '/' . $hash{0};
 460         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
 461         $dest .= '/' . substr( $hash, 0, 2 );
 462         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
 463
 464         umask( $oldumask );
 465         return $dest;
 466 }
 467
 468 function wfImageThumbDir( $fname , $subdir='thumb')
 469 {
 470         return wfImageArchiveDir( $fname, $subdir );
 471 }
 472
 473 function wfImageArchiveDir( $fname , $subdir='archive')
 474 {
 475         global $wgUploadDirectory;
 476
 477         $hash = md5( $fname );
 478         $oldumask = umask(0);
 479
 480         # Suppress warning messages here; if the file itself can't
 481         # be written we'll worry about it then.
 482         $archive = "{$wgUploadDirectory}/{$subdir}";
 483         if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
 484         $archive .= '/' . $hash{0};
 485         if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
 486         $archive .= '/' . substr( $hash, 0, 2 );
 487         if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
 488
 489         umask( $oldumask );
 490         return $archive;
 491 }
 492
 493 function wfRecordUpload( $name, $oldver, $size, $desc, $copyStatus = "", $source = "" )
 494 {
 495         global $wgUser, $wgLang, $wgTitle, $wgOut, $wgDeferredUpdateList;
 496         global $wgUseCopyrightUpload;
 497
 498         $fname = 'wfRecordUpload';
 499
 500         $sql = 'SELECT img_name,img_size,img_timestamp,img_description,img_user,' .
 501           "img_user_text FROM image WHERE img_name='" . wfStrencode( $name ) . "'";
 502         $res = wfQuery( $sql, DB_READ, $fname );
 503
 504         $now = wfTimestampNow();
 505         $won = wfInvertTimestamp( $now );
 506         $size = IntVal( $size );
 507
 508         if ( $wgUseCopyrightUpload )
 509           {
 510                 $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
 511                   '== ' . wfMsg ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
 512                   '== ' . wfMsg ( 'filesource' ) . " ==\n" . $source ;
 513           }
 514         else $textdesc = $desc ;
 515
 516         $now = wfTimestampNow();
 517         $won = wfInvertTimestamp( $now );
 518
 519         if ( 0 == wfNumRows( $res ) ) {
 520                 $sql = 'INSERT INTO image (img_name,img_size,img_timestamp,' .
 521                   "img_description,img_user,img_user_text) VALUES ('" .
 522                   wfStrencode( $name ) . "',$size,'{$now}','" .
 523                   wfStrencode( $desc ) . "', '" . $wgUser->getID() .
 524                   "', '" . wfStrencode( $wgUser->getName() ) . "')";
 525                 wfQuery( $sql, DB_WRITE, $fname );
 526
 527                 $sql = 'SELECT cur_id,cur_text FROM cur WHERE cur_namespace=' .
 528                   Namespace::getImage() . " AND cur_title='" .
 529                   wfStrencode( $name ) . "'";
 530                 $res = wfQuery( $sql, DB_READ, $fname );
 531                 if ( 0 == wfNumRows( $res ) ) {
 532                         $common =
 533                           Namespace::getImage() . ",'" .
 534                           wfStrencode( $name ) . "','" .
 535                           wfStrencode( $desc ) . "','" . $wgUser->getID() . "','" .
 536                           wfStrencode( $wgUser->getName() ) . "','" . $now .
 537                           "',1";
 538                         $sql = 'INSERT INTO cur (cur_namespace,cur_title,' .
 539                           'cur_comment,cur_user,cur_user_text,cur_timestamp,cur_is_new,' .
 540                           'cur_text,inverse_timestamp,cur_touched) VALUES (' .
 541                           $common .
 542                           ",'" . wfStrencode( $textdesc ) . "','{$won}','{$now}')";
 543                         wfQuery( $sql, DB_WRITE, $fname );
 544                         $id = wfInsertId() or 0; # We should throw an error instead
 545
 546                         $titleObj = Title::makeTitle( NS_IMAGE, $name );
 547                         RecentChange::notifyNew( $now, $titleObj, 0, $wgUser, $desc );
 548
 549                         $u = new SearchUpdate( $id, $name, $desc );
 550                         $u->doUpdate();
 551                 }
 552         } else {
 553                 $s = wfFetchObject( $res );
 554
 555                 $sql = 'INSERT INTO oldimage (oi_name,oi_archive_name,oi_size,' .
 556                   "oi_timestamp,oi_description,oi_user,oi_user_text) VALUES ('" .
 557                   wfStrencode( $s->img_name ) . "','" .
 558                   wfStrencode( $oldver ) .
 559                   "',{$s->img_size},'{$s->img_timestamp}','" .
 560                   wfStrencode( $s->img_description ) . "','" .
 561                   wfStrencode( $s->img_user ) . "','" .
 562                   wfStrencode( $s->img_user_text) . "')";
 563                 wfQuery( $sql, DB_WRITE, $fname );
 564
 565                 $sql = "UPDATE image SET img_size={$size}," .
 566                   "img_timestamp='" . wfTimestampNow() . "',img_user='" .
 567                   $wgUser->getID() . "',img_user_text='" .
 568                   wfStrencode( $wgUser->getName() ) . "', img_description='" .
 569                   wfStrencode( $desc ) . "' WHERE img_name='" .
 570                   wfStrencode( $name ) . "'";
 571                 wfQuery( $sql, DB_WRITE, $fname );
 572
 573                 $sql = "UPDATE cur SET cur_touched='{$now}' WHERE cur_namespace=" .
 574                   Namespace::getImage() . " AND cur_title='" .
 575                   wfStrencode( $name ) . "'";
 576                 wfQuery( $sql, DB_WRITE, $fname );
 577         }
 578
 579         $log = new LogPage( wfMsg( 'uploadlogpage' ), wfMsg( 'uploadlogpagetext' ) );
 580         $da = wfMsg( 'uploadedimage', '[[:' . $wgLang->getNsText(
 581           Namespace::getImage() ) . ":{$name}|{$name}]]" );
 582         $ta = wfMsg( 'uploadedimage', $name );
 583         $log->addEntry( $da, $desc, $ta );
 584 }
 585
 586
 587 /* Some generic result counters, pulled out of SearchEngine */
 588
 589 function wfShowingResults( $offset, $limit )
 590 {
 591         global $wgLang;
 592         return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 593 }
 594
 595 function wfShowingResultsNum( $offset, $limit, $num )
 596 {
 597         global $wgLang;
 598         return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 599 }
 600
 601 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false )
 602 {
 603         global $wgUser, $wgLang;
 604         $fmtLimit = $wgLang->formatNum( $limit );
 605         $prev = wfMsg( 'prevn', $fmtLimit );
 606         $next = wfMsg( 'nextn', $fmtLimit );
 607         $link = wfUrlencode( $link );
 608
 609         $sk = $wgUser->getSkin();
 610         if ( 0 != $offset ) {
 611                 $po = $offset - $limit;
 612                 if ( $po < 0 ) { $po = 0; }
 613                 $q = "limit={$limit}&offset={$po}";
 614                 if ( '' != $query ) { $q .= "&{$query}"; }
 615                 $plink = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$prev}</a>";
 616         } else { $plink = $prev; }
 617
 618         $no = $offset + $limit;
 619         $q = "limit={$limit}&offset={$no}";
 620         if ( "" != $query ) { $q .= "&{$query}"; }
 621
 622         if ( $atend ) {
 623                 $nlink = $next;
 624         } else {
 625                 $nlink = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$next}</a>";
 626         }
 627         $nums = wfNumLink( $offset, 20, $link , $query ) . ' | ' .
 628           wfNumLink( $offset, 50, $link, $query ) . ' | ' .
 629           wfNumLink( $offset, 100, $link, $query ) . ' | ' .
 630           wfNumLink( $offset, 250, $link, $query ) . ' | ' .
 631           wfNumLink( $offset, 500, $link, $query );
 632
 633         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 634 }
 635
 636 function wfNumLink( $offset, $limit, $link, $query = '' )
 637 {
 638         global $wgUser, $wgLang;
 639         if ( '' == $query ) { $q = ''; }
 640         else { $q = "{$query}&"; }
 641         $q .= "limit={$limit}&offset={$offset}";
 642
 643         $fmtLimit = $wgLang->formatNum( $limit );
 644         $s = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$fmtLimit}</a>";
 645         return $s;
 646 }
 647
 648 function wfClientAcceptsGzip() {
 649         global $wgUseGzip;
 650         if( $wgUseGzip ) {
 651                 # FIXME: we may want to blacklist some broken browsers
 652                 if( preg_match(
 653                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
 654                         $_SERVER['HTTP_ACCEPT_ENCODING'],
 655                         $m ) ) {
 656                         if( ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
 657                         wfDebug( " accepts gzip\n" );
 658                         return true;
 659                 }
 660         }
 661         return false;
 662 }
 663
 664 # Yay, more global functions!
 665 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
 666         global $wgUser, $wgRequest;
 667
 668         $limit = $wgRequest->getInt( 'limit', 0 );
 669         if( $limit < 0 ) $limit = 0;
 670         if( ( $limit == 0 ) && ( $optionname != '' ) ) {
 671                 $limit = (int)$wgUser->getOption( $optionname );
 672         }
 673         if( $limit <= 0 ) $limit = $deflimit;
 674         if( $limit > 5000 ) $limit = 5000; # We have *some* limits...
 675
 676         $offset = $wgRequest->getInt( 'offset', 0 );
 677         if( $offset < 0 ) $offset = 0;
 678         if( $offset > 65000 ) $offset = 65000; # do we need a max? what?
 679
 680         return array( $limit, $offset );
 681 }
 682
 683 # Escapes the given text so that it may be output using addWikiText()
 684 # without any linking, formatting, etc. making its way through. This
 685 # is achieved by substituting certain characters with HTML entities.
 686 # As required by the callers, <nowiki> is not used. It currently does
 687 # not filter out characters which have special meaning only at the
 688 # start of a line, such as "*".
 689 function wfEscapeWikiText( $text )
 690 {
 691         $text = str_replace(
 692                 array( '[',             '|',      "'",     'ISBN '        , '://'         , "\n=" ),
 693                 array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;" ),
 694                 htmlspecialchars($text) );
 695         return $text;
 696 }
 697
 698 function wfQuotedPrintable( $string, $charset = '' )
 699 {
 700         # Probably incomplete; see RFC 2045
 701         if( empty( $charset ) ) {
 702                 global $wgInputEncoding;
 703                 $charset = $wgInputEncoding;
 704         }
 705         $charset = strtoupper( $charset );
 706         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 707
 708         $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 709         $replace = $illegal . '\t ?_';
 710         if( !preg_match( "/[$illegal]/", $string ) ) return $string;
 711         $out = "=?$charset?Q?";
 712         $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
 713         $out .= '?=';
 714         return $out;
 715 }
 716
 717 function wfTime(){
 718         $st = explode( ' ', microtime() );
 719         return (float)$st[0] + (float)$st[1];
 720 }
 721
 722 # Changes the first character to an HTML entity
 723 function wfHtmlEscapeFirst( $text ) {
 724         $ord = ord($text);
 725         $newText = substr($text, 1);
 726         return "&#$ord;$newText";
 727 }
 728
 729 # Sets dest to source and returns the original value of dest
 730 function wfSetVar( &$dest, $source )
 731 {
 732         $temp = $dest;
 733         $dest = $source;
 734         return $temp;
 735 }
 736
 737 # Sets dest to a reference to source and returns the original dest
 738 # Pity that doesn't work in PHP
 739 function &wfSetRef( &$dest, &$source )
 740 {
 741         die( "You can't rebind a variable in the caller's scope" );
 742 }
 743
 744 # This function takes two arrays as input, and returns a CGI-style string, e.g.
 745 # "days=7&limit=100". Options in the first array override options in the second.
 746 # Options set to "" will not be output.
 747 function wfArrayToCGI( $array1, $array2 = NULL )
 748 {
 749         if ( !is_null( $array2 ) ) {
 750                 $array1 = $array1 + $array2;
 751         }
 752
 753         $cgi = '';
 754         foreach ( $array1 as $key => $value ) {
 755                 if ( '' !== $value ) {
 756                         if ( '' != $cgi ) {
 757                                 $cgi .= '&';
 758                         }
 759                         $cgi .= "{$key}={$value}";
 760                 }
 761         }
 762         return $cgi;
 763 }
 764
 765 # This is obsolete, use SquidUpdate::purge()
 766 function wfPurgeSquidServers ($urlArr) {
 767         SquidUpdate::purge( $urlArr );
 768 }
 769
 770 # Windows-compatible version of escapeshellarg()
 771 function wfEscapeShellArg( )
 772 {
 773         $args = func_get_args();
 774         $first = true;
 775         $retVal = '';
 776         foreach ( $args as $arg ) {
 777                 if ( !$first ) {
 778                         $retVal .= ' ';
 779                 } else {
 780                         $first = false;
 781                 }
 782
 783                 if ( wfIsWindows() ) {
 784                         $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
 785                 } else {
 786                         $retVal .= escapeshellarg( $arg );
 787                 }
 788         }
 789         return $retVal;
 790 }
 791
 792 # wfMerge attempts to merge differences between three texts.
 793 # Returns true for a clean merge and false for failure or a conflict.
 794
 795 function wfMerge( $old, $mine, $yours, &$result ){
 796         global $wgDiff3;
 797
 798         # This check may also protect against code injection in
 799         # case of broken installations.
 800         if(! file_exists( $wgDiff3 ) ){
 801                 return false;
 802         }
 803
 804         # Make temporary files
 805         $td = '/tmp/';
 806         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
 807         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
 808         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
 809
 810         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
 811         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
 812         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
 813
 814         # Check for a conflict
 815         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
 816           wfEscapeShellArg( $mytextName ) . ' ' .
 817           wfEscapeShellArg( $oldtextName ) . ' ' .
 818           wfEscapeShellArg( $yourtextName );
 819         $handle = popen( $cmd, 'r' );
 820
 821         if( fgets( $handle ) ){
 822                 $conflict = true;
 823         } else {
 824                 $conflict = false;
 825         }
 826         pclose( $handle );
 827
 828         # Merge differences
 829         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
 830           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
 831         $handle = popen( $cmd, 'r' );
 832         $result = '';
 833         do {
 834                 $data = fread( $handle, 8192 );
 835                 if ( strlen( $data ) == 0 ) {
 836                         break;
 837                 }
 838                 $result .= $data;
 839         } while ( true );
 840         pclose( $handle );
 841         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
 842         return ! $conflict;
 843 }
 844
 845 function wfVarDump( $var )
 846 {
 847         global $wgOut;
 848         $s = str_replace("\n","<br>\n", var_export( $var, true ) . "\n");
 849         if ( headers_sent() || !@is_object( $wgOut ) ) {
 850                 print $s;
 851         } else {
 852                 $wgOut->addHTML( $s );
 853         }
 854 }
 855
 856 # Provide a simple HTTP error.
 857 function wfHttpError( $code, $label, $desc ) {
 858         global $wgOut;
 859         $wgOut->disable();
 860         header( "HTTP/1.0 $code $label" );
 861         header( "Status: $code $label" );
 862         $wgOut->sendCacheControl();
 863
 864         # Don't send content if it's a HEAD request.
 865         if( $_SERVER['REQUEST_METHOD'] == 'HEAD' ) {
 866                 header( 'Content-type: text/plain' );
 867                 print "$desc\n";
 868         }
 869 }
 870
 871 # Converts an Accept-* header into an array mapping string values to quality factors
 872 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
 873         # No arg means accept anything (per HTTP spec)
 874         if( !$accept ) {
 875                 return array( $def => 1 );
 876         }
 877
 878         $prefs = array();
 879
 880         $parts = explode( ',', $accept );
 881
 882         foreach( $parts as $part ) {
 883                 # FIXME: doesn't deal with params like 'text/html; level=1'
 884                 @list( $value, $qpart ) = explode( ';', $part );
 885                 if( !isset( $qpart ) ) {
 886                         $prefs[$value] = 1;
 887                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
 888                         $prefs[$value] = $match[1];
 889                 }
 890         }
 891
 892         return $prefs;
 893 }
 894
 895 /* private */ function mimeTypeMatch( $type, $avail ) {
 896         if( array_key_exists($type, $avail) ) {
 897                 return $type;
 898         } else {
 899                 $parts = explode( '/', $type );
 900                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
 901                         return $parts[0] . '/*';
 902                 } elseif( array_key_exists( '*/*', $avail ) ) {
 903                         return '*/*';
 904                 } else {
 905                         return NULL;
 906                 }
 907         }
 908 }
 909
 910 # FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
 911 # XXX: generalize to negotiate other stuff
 912 function wfNegotiateType( $cprefs, $sprefs ) {
 913         $combine = array();
 914
 915         foreach( array_keys($sprefs) as $type ) {
 916                 $parts = explode( '/', $type );
 917                 if( $parts[1] != '*' ) {
 918                         $ckey = mimeTypeMatch( $type, $cprefs );
 919                         if( $ckey ) {
 920                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
 921                         }
 922                 }
 923         }
 924
 925         foreach( array_keys( $cprefs ) as $type ) {
 926                 $parts = explode( '/', $type );
 927                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
 928                         $skey = mimeTypeMatch( $type, $sprefs );
 929                         if( $skey ) {
 930                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
 931                         }
 932                 }
 933         }
 934
 935         $bestq = 0;
 936         $besttype = NULL;
 937
 938         foreach( array_keys( $combine ) as $type ) {
 939                 if( $combine[$type] > $bestq ) {
 940                         $besttype = $type;
 941                         $bestq = $combine[$type];
 942                 }
 943         }
 944
 945         return $besttype;
 946 }
 947
 948 # Array lookup
 949 # Returns an array where the values in the first array are replaced by the
 950 # values in the second array with the corresponding keys
 951 function wfArrayLookup( $a, $b )
 952 {
 953         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
 954 }
 955
 956 # Since Windows is so different to any of the other popular OSes, it seems appropriate
 957 # to have a simple way to test for its presence
 958 function wfIsWindows() {
 959         if (substr(php_uname(), 0, 7) == 'Windows') {
 960                 return true;
 961         } else {
 962                 return false;
 963         }
 964 }
 965
 966 ?>