4 * Global functions used everywhere
9 * Some globals and requires needed
13 * Total number of articles
14 * @global integer $wgNumberOfArticles
16 $wgNumberOfArticles = -1; # Unset
18 * Total number of views
19 * @global integer $wgTotalViews
23 * Total number of edits
24 * @global integer $wgTotalEdits
29 require_once( 'DatabaseFunctions.php' );
30 require_once( 'UpdateClasses.php' );
31 require_once( 'LogPage.php' );
32 require_once( 'normal/UtfNormalUtil.php' );
35 * Compatibility functions
36 * PHP <4.3.x is not actively supported; 4.1.x and 4.2.x might or might not work.
37 * <4.1.x will not work, as we use a number of features introduced in 4.1.0
38 * such as the new autoglobals.
40 if( !function_exists('iconv') ) {
41 # iconv support is not in the default configuration and so may not be present.
42 # Assume will only ever use utf-8 and iso-8859-1.
43 # This will *not* work in all circumstances.
44 function iconv( $from, $to, $string ) {
45 if(strcasecmp( $from, $to ) == 0) return $string;
46 if(strcasecmp( $from, 'utf-8' ) == 0) return utf8_decode( $string );
47 if(strcasecmp( $to, 'utf-8' ) == 0) return utf8_encode( $string );
52 if( !function_exists('file_get_contents') ) {
53 # Exists in PHP 4.3.0+
54 function file_get_contents( $filename ) {
55 return implode( '', file( $filename ) );
59 if( !function_exists('is_a') ) {
60 # Exists in PHP 4.2.0+
61 function is_a( $object, $class_name ) {
63 (strcasecmp( get_class( $object ), $class_name ) == 0) ||
64 is_subclass_of( $object, $class_name );
68 # UTF-8 substr function based on a PHP manual comment
69 if ( !function_exists( 'mb_substr' ) ) {
70 function mb_substr( $str, $start ) {
71 preg_match_all( '/./us', $str, $ar );
73 if( func_num_args() >= 3 ) {
74 $end = func_get_arg( 2 );
75 return join( '', array_slice( $ar[0], $start, $end ) );
77 return join( '', array_slice( $ar[0], $start ) );
82 if( !function_exists( 'floatval' ) ) {
84 * First defined in PHP 4.2.0
88 function floatval( $var ) {
93 if ( !function_exists( 'array_diff_key' ) ) {
95 * Exists in PHP 5.1.0+
96 * Not quite compatible, two-argument version only
97 * Null values will cause problems due to this use of isset()
99 function array_diff_key( $left, $right ) {
101 foreach ( $left as $key => $value ) {
102 if ( isset( $right[$key] ) ) {
103 unset( $result[$key] );
110 // If it doesn't exist no ctype_* stuff will
111 if ( ! function_exists( 'ctype_alnum' ) )
112 require_once 'compatability/ctype.php';
115 * Wrapper for clone() for PHP 4, for the moment.
116 * PHP 5 won't let you declare a 'clone' function, even conditionally,
117 * so it has to be a wrapper with a different name.
119 function wfClone( $object ) {
120 // WARNING: clone() is not a function in PHP 5, so function_exists fails.
121 if( version_compare( PHP_VERSION
, '5.0' ) < 0 ) {
124 return clone( $object );
129 * Where as we got a random seed
130 * @var bool $wgTotalViews
132 $wgRandomSeeded = false;
135 * Seed Mersenne Twister
136 * Only necessary in PHP < 4.2.0
140 function wfSeedRandom() {
141 global $wgRandomSeeded;
143 if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
144 $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff;
146 $wgRandomSeeded = true;
151 * Get a random decimal value between 0 and 1, in a way
152 * not likely to give duplicate values for any realistic
153 * number of articles.
157 function wfRandom() {
158 # The maximum random value is "only" 2^31-1, so get two random
159 # values to reduce the chance of dupes
160 $max = mt_getrandmax();
161 $rand = number_format( (mt_rand() * $max +
mt_rand())
162 / $max / $max, 12, '.', '' );
167 * We want / and : to be included as literal characters in our title URLs.
168 * %2F in the page titles seems to fatally break for some reason.
173 function wfUrlencode ( $s ) {
174 $s = urlencode( $s );
175 $s = preg_replace( '/%3[Aa]/', ':', $s );
176 $s = preg_replace( '/%2[Ff]/', '/', $s );
182 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
183 * In normal operation this is a NOP.
185 * Controlling globals:
186 * $wgDebugLogFile - points to the log file
187 * $wgProfileOnly - if set, normal debug messages will not be recorded.
188 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
189 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
191 * @param string $text
192 * @param bool $logonly Set true to avoid appearing in HTML when $wgDebugComments is set
194 function wfDebug( $text, $logonly = false ) {
195 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
197 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
198 if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
202 if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) {
203 $wgOut->debug( $text );
205 if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
206 # Strip unprintables; they can switch terminal modes when binary data
207 # gets dumped, which is pretty annoying.
208 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
209 @error_log
( $text, 3, $wgDebugLogFile );
214 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
215 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
217 * @param string $logGroup
218 * @param string $text
219 * @param bool $public Whether to log the event in the public log if no private
220 * log file is specified, (default true)
222 function wfDebugLog( $logGroup, $text, $public = true ) {
223 global $wgDebugLogGroups, $wgDBname;
224 if( $text{strlen( $text ) - 1} != "\n" ) $text .= "\n";
225 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
226 @error_log
( "$wgDBname: $text", 3, $wgDebugLogGroups[$logGroup] );
227 } else if ( $public === true ) {
228 wfDebug( $text, true );
233 * Log for database errors
234 * @param string $text Database error message.
236 function wfLogDBError( $text ) {
237 global $wgDBerrorLog;
238 if ( $wgDBerrorLog ) {
239 $host = trim(`hostname`
);
240 $text = date('D M j G:i:s T Y') . "\t$host\t".$text;
241 error_log( $text, 3, $wgDBerrorLog );
248 function logProfilingData() {
249 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
250 global $wgProfiling, $wgUser;
253 list( $usec, $sec ) = explode( ' ', $wgRequestTime );
254 $start = (float)$sec +
(float)$usec;
255 $elapsed = $now - $start;
256 if ( $wgProfiling ) {
257 $prof = wfGetProfilingOutput( $start, $elapsed );
259 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
260 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
261 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
262 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
263 if( !empty( $_SERVER['HTTP_FROM'] ) )
264 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
266 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
267 if( is_object($wgUser) && $wgUser->isAnon() )
269 $log = sprintf( "%s\t%04.3f\t%s\n",
270 gmdate( 'YmdHis' ), $elapsed,
271 urldecode( $_SERVER['REQUEST_URI'] . $forward ) );
272 if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' ||
$wgDebugRawPage ) ) {
273 error_log( $log . $prof, 3, $wgDebugLogFile );
279 * Check if the wiki read-only lock file is present. This can be used to lock
280 * off editing functions, but doesn't guarantee that the database will not be
284 function wfReadOnly() {
285 global $wgReadOnlyFile, $wgReadOnly;
290 if ( '' == $wgReadOnlyFile ) {
294 // Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time
295 if ( is_file( $wgReadOnlyFile ) ) {
296 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
300 $wgReadOnlyFile = '';
306 * Get a message from anywhere, for the current user language.
308 * Use wfMsgForContent() instead if the message should NOT
309 * change depending on the user preferences.
311 * Note that the message may contain HTML, and is therefore
312 * not safe for insertion anywhere. Some functions such as
313 * addWikiText will do the escaping for you. Use wfMsgHtml()
314 * if you need an escaped message.
316 * @param string lookup key for the message, usually
317 * defined in languages/Language.php
319 function wfMsg( $key ) {
320 $args = func_get_args();
321 array_shift( $args );
322 return wfMsgReal( $key, $args, true );
326 * Same as above except doesn't transform the message
328 function wfMsgNoTrans( $key ) {
329 $args = func_get_args();
330 array_shift( $args );
331 return wfMsgReal( $key, $args, true, false );
335 * Get a message from anywhere, for the current global language
336 * set with $wgLanguageCode.
338 * Use this if the message should NOT change dependent on the
339 * language set in the user's preferences. This is the case for
340 * most text written into logs, as well as link targets (such as
341 * the name of the copyright policy page). Link titles, on the
342 * other hand, should be shown in the UI language.
344 * Note that MediaWiki allows users to change the user interface
345 * language in their preferences, but a single installation
346 * typically only contains content in one language.
348 * Be wary of this distinction: If you use wfMsg() where you should
349 * use wfMsgForContent(), a user of the software may have to
350 * customize over 70 messages in order to, e.g., fix a link in every
353 * @param string lookup key for the message, usually
354 * defined in languages/Language.php
356 function wfMsgForContent( $key ) {
357 global $wgForceUIMsgAsContentMsg;
358 $args = func_get_args();
359 array_shift( $args );
361 if( is_array( $wgForceUIMsgAsContentMsg ) &&
362 in_array( $key, $wgForceUIMsgAsContentMsg ) )
364 return wfMsgReal( $key, $args, true, $forcontent );
368 * Same as above except doesn't transform the message
370 function wfMsgForContentNoTrans( $key ) {
371 global $wgForceUIMsgAsContentMsg;
372 $args = func_get_args();
373 array_shift( $args );
375 if( is_array( $wgForceUIMsgAsContentMsg ) &&
376 in_array( $key, $wgForceUIMsgAsContentMsg ) )
378 return wfMsgReal( $key, $args, true, $forcontent, false );
382 * Get a message from the language file, for the UI elements
384 function wfMsgNoDB( $key ) {
385 $args = func_get_args();
386 array_shift( $args );
387 return wfMsgReal( $key, $args, false );
391 * Get a message from the language file, for the content
393 function wfMsgNoDBForContent( $key ) {
394 global $wgForceUIMsgAsContentMsg;
395 $args = func_get_args();
396 array_shift( $args );
398 if( is_array( $wgForceUIMsgAsContentMsg ) &&
399 in_array( $key, $wgForceUIMsgAsContentMsg ) )
401 return wfMsgReal( $key, $args, false, $forcontent );
406 * Really get a message
408 function wfMsgReal( $key, $args, $useDB, $forContent=false, $transform = true ) {
409 $fname = 'wfMsgReal';
410 wfProfileIn( $fname );
412 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
413 $message = wfMsgReplaceArgs( $message, $args );
414 wfProfileOut( $fname );
419 * This function provides the message source for messages to be edited which are *not* stored in the database
422 function wfMsgWeirdKey ( $key ) {
423 $subsource = str_replace ( ' ' , '_' , $key ) ;
424 $source = wfMsg ( $subsource ) ;
425 if ( $source == "<{$subsource}>" ) {
426 # Try again with first char lower case
427 $subsource = strtolower ( substr ( $subsource , 0 , 1 ) ) . substr ( $subsource , 1 ) ;
428 $source = wfMsg ( $subsource ) ;
430 if ( $source == "<{$subsource}>" ) {
431 # Didn't work either, return blank text
438 * Fetch a message string value, but don't replace any keys yet.
441 * @param bool $forContent
445 function wfMsgGetKey( $key, $useDB, $forContent = false, $transform = true ) {
446 global $wgParser, $wgMsgParserOptions, $wgContLang, $wgMessageCache, $wgLang;
448 if ( is_object( $wgMessageCache ) )
449 $transstat = $wgMessageCache->getTransform();
451 if( is_object( $wgMessageCache ) ) {
453 $wgMessageCache->disableTransform();
454 $message = $wgMessageCache->get( $key, $useDB, $forContent );
457 $lang = &$wgContLang;
462 wfSuppressWarnings();
464 if( is_object( $lang ) ) {
465 $message = $lang->getMessage( $key );
470 if($message === false)
471 $message = Language
::getMessage($key);
472 if ( $transform && strstr( $message, '{{' ) !== false ) {
473 $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
477 if ( is_object( $wgMessageCache ) && ! $transform )
478 $wgMessageCache->setTransform( $transstat );
484 * Replace message parameter keys on the given formatted output.
486 * @param string $message
491 function wfMsgReplaceArgs( $message, $args ) {
492 # Fix windows line-endings
493 # Some messages are split with explode("\n", $msg)
494 $message = str_replace( "\r", '', $message );
497 if ( count( $args ) )
498 if ( is_array( $args[0] ) )
499 foreach ( $args[0] as $key => $val )
500 $message = str_replace( '$' . $key, $val, $message );
502 foreach( $args as $n => $param )
503 $replacementKeys['$' . ($n +
1)] = $param;
504 $message = strtr( $message, $replacementKeys );
511 * Return an HTML-escaped version of a message.
512 * Parameter replacements, if any, are done *after* the HTML-escaping,
513 * so parameters may contain HTML (eg links or form controls). Be sure
514 * to pre-escape them if you really do want plaintext, or just wrap
515 * the whole thing in htmlspecialchars().
518 * @param string ... parameters
521 function wfMsgHtml( $key ) {
522 $args = func_get_args();
523 array_shift( $args );
524 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
528 * Return an HTML version of message
529 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
530 * so parameters may contain HTML (eg links or form controls). Be sure
531 * to pre-escape them if you really do want plaintext, or just wrap
532 * the whole thing in htmlspecialchars().
535 * @param string ... parameters
538 function wfMsgWikiHtml( $key ) {
540 $args = func_get_args();
541 array_shift( $args );
542 return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
546 * Just like exit() but makes a note of it.
547 * Commits open transactions except if the error parameter is set
549 function wfAbruptExit( $error = false ){
550 global $wgLoadBalancer;
551 static $called = false;
557 if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
558 $bt = debug_backtrace();
559 for($i = 0; $i < count($bt) ; $i++
){
560 $file = isset($bt[$i]['file']) ?
$bt[$i]['file'] : "unknown";
561 $line = isset($bt[$i]['line']) ?
$bt[$i]['line'] : "unknown";
562 wfDebug("WARNING: Abrupt exit in $file at line $line\n");
565 wfDebug('WARNING: Abrupt exit\n');
572 $wgLoadBalancer->closeAll();
580 function wfErrorExit() {
581 wfAbruptExit( true );
585 * Print a simple message and die, returning nonzero to the shell if any.
586 * Plain die() fails to return nonzero to the shell if you pass a string.
589 function wfDie( $msg='' ) {
595 * Die with a backtrace
596 * This is meant as a debugging aid to track down where bad data comes from.
597 * Shouldn't be used in production code except maybe in "shouldn't happen" areas.
599 * @param string $msg Message shown when dieing.
601 function wfDebugDieBacktrace( $msg = '' ) {
602 global $wgCommandLineMode;
604 $backtrace = wfBacktrace();
605 if ( $backtrace !== false ) {
606 if ( $wgCommandLineMode ) {
607 $msg .= "\nBacktrace:\n$backtrace";
609 $msg .= "\n<p>Backtrace:</p>\n$backtrace";
613 echo wfReportTime()."\n";
618 * Returns a HTML comment with the elapsed time since request.
619 * This method has no side effects.
622 function wfReportTime() {
623 global $wgRequestTime;
626 list( $usec, $sec ) = explode( ' ', $wgRequestTime );
627 $start = (float)$sec +
(float)$usec;
628 $elapsed = $now - $start;
630 # Use real server name if available, so we know which machine
631 # in a server farm generated the current page.
632 if ( function_exists( 'posix_uname' ) ) {
633 $uname = @posix_uname
();
637 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
638 $hostname = $uname['nodename'];
640 # This may be a virtual server.
641 $hostname = $_SERVER['SERVER_NAME'];
643 $com = sprintf( "<!-- Served by %s in %01.2f secs. -->",
644 $hostname, $elapsed );
648 function wfBacktrace() {
649 global $wgCommandLineMode;
650 if ( !function_exists( 'debug_backtrace' ) ) {
654 if ( $wgCommandLineMode ) {
659 $backtrace = debug_backtrace();
660 foreach( $backtrace as $call ) {
661 if( isset( $call['file'] ) ) {
662 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
663 $file = $f[count($f)-1];
667 if( isset( $call['line'] ) ) {
668 $line = $call['line'];
672 if ( $wgCommandLineMode ) {
673 $msg .= "$file line $line calls ";
675 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
677 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
678 $msg .= $call['function'] . '()';
680 if ( $wgCommandLineMode ) {
686 if ( $wgCommandLineMode ) {
696 /* Some generic result counters, pulled out of SearchEngine */
702 function wfShowingResults( $offset, $limit ) {
704 return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+
1 ) );
710 function wfShowingResultsNum( $offset, $limit, $num ) {
712 return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+
1 ), $wgLang->formatNum( $num ) );
718 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
719 global $wgUser, $wgLang;
720 $fmtLimit = $wgLang->formatNum( $limit );
721 $prev = wfMsg( 'prevn', $fmtLimit );
722 $next = wfMsg( 'nextn', $fmtLimit );
724 if( is_object( $link ) ) {
727 $title = Title
::newFromText( $link );
728 if( is_null( $title ) ) {
733 $sk = $wgUser->getSkin();
734 if ( 0 != $offset ) {
735 $po = $offset - $limit;
736 if ( $po < 0 ) { $po = 0; }
737 $q = "limit={$limit}&offset={$po}";
738 if ( '' != $query ) { $q .= '&'.$query; }
739 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
740 } else { $plink = $prev; }
742 $no = $offset +
$limit;
743 $q = 'limit='.$limit.'&offset='.$no;
744 if ( '' != $query ) { $q .= '&'.$query; }
749 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
751 $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
752 wfNumLink( $offset, 50, $title, $query ) . ' | ' .
753 wfNumLink( $offset, 100, $title, $query ) . ' | ' .
754 wfNumLink( $offset, 250, $title, $query ) . ' | ' .
755 wfNumLink( $offset, 500, $title, $query );
757 return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
763 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
764 global $wgUser, $wgLang;
765 if ( '' == $query ) { $q = ''; }
766 else { $q = $query.'&'; }
767 $q .= 'limit='.$limit.'&offset='.$offset;
769 $fmtLimit = $wgLang->formatNum( $limit );
770 $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
776 * @todo FIXME: we may want to blacklist some broken browsers
778 * @return bool Whereas client accept gzip compression
780 function wfClientAcceptsGzip() {
783 # FIXME: we may want to blacklist some broken browsers
785 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
786 $_SERVER['HTTP_ACCEPT_ENCODING'],
788 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
789 wfDebug( " accepts gzip\n" );
797 * Yay, more global functions!
799 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
801 return $wgRequest->getLimitOffset( $deflimit, $optionname );
805 * Escapes the given text so that it may be output using addWikiText()
806 * without any linking, formatting, etc. making its way through. This
807 * is achieved by substituting certain characters with HTML entities.
808 * As required by the callers, <nowiki> is not used. It currently does
809 * not filter out characters which have special meaning only at the
810 * start of a line, such as "*".
812 * @param string $text Text to be escaped
814 function wfEscapeWikiText( $text ) {
816 array( '[', '|', '\'', 'ISBN ' , '://' , "\n=", '{{' ),
817 array( '[', '|', ''', 'ISBN ', '://' , "\n=", '{{' ),
818 htmlspecialchars($text) );
825 function wfQuotedPrintable( $string, $charset = '' ) {
826 # Probably incomplete; see RFC 2045
827 if( empty( $charset ) ) {
828 global $wgInputEncoding;
829 $charset = $wgInputEncoding;
831 $charset = strtoupper( $charset );
832 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
834 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
835 $replace = $illegal . '\t ?_';
836 if( !preg_match( "/[$illegal]/", $string ) ) return $string;
837 $out = "=?$charset?Q?";
838 $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
844 * Returns an escaped string suitable for inclusion in a string literal
845 * for JavaScript source code.
846 * Illegal control characters are assumed not to be present.
848 * @param string $string
851 function wfEscapeJsString( $string ) {
852 // See ECMA 262 section 7.8.4 for string literal format
860 # To avoid closing the element or CDATA section
864 return strtr( $string, $pairs );
872 $st = explode( ' ', microtime() );
873 return (float)$st[0] +
(float)$st[1];
877 * Changes the first character to an HTML entity
879 function wfHtmlEscapeFirst( $text ) {
881 $newText = substr($text, 1);
882 return "&#$ord;$newText";
886 * Sets dest to source and returns the original value of dest
887 * If source is NULL, it just returns the value, it doesn't set the variable
889 function wfSetVar( &$dest, $source ) {
891 if ( !is_null( $source ) ) {
898 * As for wfSetVar except setting a bit
900 function wfSetBit( &$dest, $bit, $state = true ) {
901 $temp = (bool)($dest & $bit );
902 if ( !is_null( $state ) ) {
913 * This function takes two arrays as input, and returns a CGI-style string, e.g.
914 * "days=7&limit=100". Options in the first array override options in the second.
915 * Options set to "" will not be output.
917 function wfArrayToCGI( $array1, $array2 = NULL )
919 if ( !is_null( $array2 ) ) {
920 $array1 = $array1 +
$array2;
924 foreach ( $array1 as $key => $value ) {
925 if ( '' !== $value ) {
929 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
936 * This is obsolete, use SquidUpdate::purge()
939 function wfPurgeSquidServers ($urlArr) {
940 SquidUpdate
::purge( $urlArr );
944 * Windows-compatible version of escapeshellarg()
945 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
946 * function puts single quotes in regardless of OS
948 function wfEscapeShellArg( ) {
949 $args = func_get_args();
952 foreach ( $args as $arg ) {
959 if ( wfIsWindows() ) {
960 $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
962 $retVal .= escapeshellarg( $arg );
969 * wfMerge attempts to merge differences between three texts.
970 * Returns true for a clean merge and false for failure or a conflict.
972 function wfMerge( $old, $mine, $yours, &$result ){
975 # This check may also protect against code injection in
976 # case of broken installations.
977 if(! file_exists( $wgDiff3 ) ){
978 wfDebug( "diff3 not found\n" );
982 # Make temporary files
984 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
985 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
986 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
988 fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
989 fwrite( $mytextFile, $mine ); fclose( $mytextFile );
990 fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
992 # Check for a conflict
993 $cmd = $wgDiff3 . ' -a --overlap-only ' .
994 wfEscapeShellArg( $mytextName ) . ' ' .
995 wfEscapeShellArg( $oldtextName ) . ' ' .
996 wfEscapeShellArg( $yourtextName );
997 $handle = popen( $cmd, 'r' );
999 if( fgets( $handle, 1024 ) ){
1007 $cmd = $wgDiff3 . ' -a -e --merge ' .
1008 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1009 $handle = popen( $cmd, 'r' );
1012 $data = fread( $handle, 8192 );
1013 if ( strlen( $data ) == 0 ) {
1019 unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
1021 if ( $result === '' && $old !== '' && $conflict == false ) {
1022 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1031 function wfVarDump( $var ) {
1033 $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
1034 if ( headers_sent() ||
!@is_object
( $wgOut ) ) {
1037 $wgOut->addHTML( $s );
1042 * Provide a simple HTTP error.
1044 function wfHttpError( $code, $label, $desc ) {
1047 header( "HTTP/1.0 $code $label" );
1048 header( "Status: $code $label" );
1049 $wgOut->sendCacheControl();
1051 header( 'Content-type: text/html' );
1052 print "<html><head><title>" .
1053 htmlspecialchars( $label ) .
1054 "</title></head><body><h1>" .
1055 htmlspecialchars( $label ) .
1057 htmlspecialchars( $desc ) .
1058 "</p></body></html>\n";
1062 * Converts an Accept-* header into an array mapping string values to quality
1065 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1066 # No arg means accept anything (per HTTP spec)
1068 return array( $def => 1 );
1073 $parts = explode( ',', $accept );
1075 foreach( $parts as $part ) {
1076 # FIXME: doesn't deal with params like 'text/html; level=1'
1077 @list
( $value, $qpart ) = explode( ';', $part );
1078 if( !isset( $qpart ) ) {
1080 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
1081 $prefs[$value] = $match[1];
1089 * Checks if a given MIME type matches any of the keys in the given
1090 * array. Basic wildcards are accepted in the array keys.
1092 * Returns the matching MIME type (or wildcard) if a match, otherwise
1095 * @param string $type
1096 * @param array $avail
1100 function mimeTypeMatch( $type, $avail ) {
1101 if( array_key_exists($type, $avail) ) {
1104 $parts = explode( '/', $type );
1105 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
1106 return $parts[0] . '/*';
1107 } elseif( array_key_exists( '*/*', $avail ) ) {
1116 * Returns the 'best' match between a client's requested internet media types
1117 * and the server's list of available types. Each list should be an associative
1118 * array of type to preference (preference is a float between 0.0 and 1.0).
1119 * Wildcards in the types are acceptable.
1121 * @param array $cprefs Client's acceptable type list
1122 * @param array $sprefs Server's offered types
1125 * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
1126 * XXX: generalize to negotiate other stuff
1128 function wfNegotiateType( $cprefs, $sprefs ) {
1131 foreach( array_keys($sprefs) as $type ) {
1132 $parts = explode( '/', $type );
1133 if( $parts[1] != '*' ) {
1134 $ckey = mimeTypeMatch( $type, $cprefs );
1136 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1141 foreach( array_keys( $cprefs ) as $type ) {
1142 $parts = explode( '/', $type );
1143 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
1144 $skey = mimeTypeMatch( $type, $sprefs );
1146 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1154 foreach( array_keys( $combine ) as $type ) {
1155 if( $combine[$type] > $bestq ) {
1157 $bestq = $combine[$type];
1166 * Returns an array where the values in the first array are replaced by the
1167 * values in the second array with the corresponding keys
1171 function wfArrayLookup( $a, $b ) {
1172 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
1176 * Convenience function; returns MediaWiki timestamp for the present time.
1179 function wfTimestampNow() {
1181 return wfTimestamp( TS_MW
, time() );
1185 * Reference-counted warning suppression
1187 function wfSuppressWarnings( $end = false ) {
1188 static $suppressCount = 0;
1189 static $originalLevel = false;
1192 if ( $suppressCount ) {
1194 if ( !$suppressCount ) {
1195 error_reporting( $originalLevel );
1199 if ( !$suppressCount ) {
1200 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE
) );
1207 * Restore error level to previous value
1209 function wfRestoreWarnings() {
1210 wfSuppressWarnings( true );
1213 # Autodetect, convert and provide timestamps of various types
1216 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1218 define('TS_UNIX', 0);
1221 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1226 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1231 * RFC 2822 format, for E-mail and HTTP headers
1233 define('TS_RFC2822', 3);
1236 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
1238 * This is used by Special:Export
1240 define('TS_ISO_8601', 4);
1243 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1245 * @link http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1246 * DateTime tag and page 36 for the DateTimeOriginal and
1247 * DateTimeDigitized tags.
1249 define('TS_EXIF', 5);
1252 * Oracle format time.
1254 define('TS_ORACLE', 6);
1257 * @param mixed $outputtype A timestamp in one of the supported formats, the
1258 * function will autodetect which format is supplied
1259 and act accordingly.
1260 * @return string Time in the format specified in $outputtype
1262 function wfTimestamp($outputtype=TS_UNIX
,$ts=0) {
1266 } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1268 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1269 (int)$da[2],(int)$da[3],(int)$da[1]);
1270 } elseif (preg_match("/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1272 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1273 (int)$da[2],(int)$da[3],(int)$da[1]);
1274 } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) {
1276 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1277 (int)$da[2],(int)$da[3],(int)$da[1]);
1278 } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
1281 } elseif (preg_match('/^(\d{1,2})-(...)-(\d\d(\d\d)?) (\d\d)\.(\d\d)\.(\d\d)/', $ts, $da)) {
1283 $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1284 str_replace("+00:00", "UTC", $ts)));
1285 } elseif (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/', $ts, $da)) {
1287 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1288 (int)$da[2],(int)$da[3],(int)$da[1]);
1290 # Bogus value; fall back to the epoch...
1291 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1296 switch($outputtype) {
1300 return gmdate( 'YmdHis', $uts );
1302 return gmdate( 'Y-m-d H:i:s', $uts );
1304 return gmdate( 'Y-m-d\TH:i:s\Z', $uts );
1305 // This shouldn't ever be used, but is included for completeness
1307 return gmdate( 'Y:m:d H:i:s', $uts );
1309 return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1311 return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
1313 wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
1318 * Return a formatted timestamp, or null if input is null.
1319 * For dealing with nullable timestamp columns in the database.
1320 * @param int $outputtype
1324 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1325 if( is_null( $ts ) ) {
1328 return wfTimestamp( $outputtype, $ts );
1333 * Check if the operating system is Windows
1335 * @return bool True if it's Windows, False otherwise.
1337 function wfIsWindows() {
1338 if (substr(php_uname(), 0, 7) == 'Windows') {
1346 * Swap two variables
1348 function swap( &$x, &$y ) {
1354 function wfGetCachedNotice( $name ) {
1355 global $wgOut, $parserMemc, $wgDBname;
1356 $fname = 'wfGetCachedNotice';
1357 wfProfileIn( $fname );
1360 $notice = wfMsgForContent( $name );
1361 if( $notice == '<'. $name . ';>' ||
$notice == '-' ) {
1362 wfProfileOut( $fname );
1366 $cachedNotice = $parserMemc->get( $wgDBname . ':' . $name );
1367 if( is_array( $cachedNotice ) ) {
1368 if( md5( $notice ) == $cachedNotice['hash'] ) {
1369 $notice = $cachedNotice['html'];
1378 if( is_object( $wgOut ) ) {
1379 $parsed = $wgOut->parse( $notice );
1380 $parserMemc->set( $wgDBname . ':' . $name, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
1383 wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' );
1388 wfProfileOut( $fname );
1392 function wfGetSiteNotice() {
1393 global $wgUser, $wgSiteNotice;
1394 $fname = 'wfGetSiteNotice';
1395 wfProfileIn( $fname );
1397 if( $wgUser->isLoggedIn() ) {
1398 $siteNotice = wfGetCachedNotice( 'sitenotice' );
1399 $siteNotice = !$siteNotice ?
$wgSiteNotice : $siteNotice;
1401 $anonNotice = wfGetCachedNotice( 'anonnotice' );
1402 if( !$anonNotice ) {
1403 $siteNotice = wfGetCachedNotice( 'sitenotice' );
1404 $siteNotice = !$siteNotice ?
$wgSiteNotice : $siteNotice;
1406 $siteNotice = $anonNotice;
1410 wfProfileOut( $fname );
1411 return( $siteNotice );
1415 * Format an XML element with given attributes and, optionally, text content.
1416 * Element and attribute names are assumed to be ready for literal inclusion.
1417 * Strings are assumed to not contain XML-illegal characters; special
1418 * characters (<, >, &) are escaped but illegals are not touched.
1420 * @param string $element
1421 * @param array $attribs Name=>value pairs. Values will be escaped.
1422 * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1425 function wfElement( $element, $attribs = null, $contents = '') {
1426 $out = '<' . $element;
1427 if( !is_null( $attribs ) ) {
1428 foreach( $attribs as $name => $val ) {
1429 $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"';
1432 if( is_null( $contents ) ) {
1435 if( $contents == '' ) {
1438 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
1445 * Format an XML element as with wfElement(), but run text through the
1446 * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
1449 * @param string $element
1450 * @param array $attribs Name=>value pairs. Values will be escaped.
1451 * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1454 function wfElementClean( $element, $attribs = array(), $contents = '') {
1456 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
1459 $contents = UtfNormal
::cleanUp( $contents );
1461 return wfElement( $element, $attribs, $contents );
1465 function wfOpenElement( $element, $attribs = null ) { return wfElement( $element, $attribs, null ); }
1466 function wfCloseElement( $element ) { return "</$element>"; }
1469 * Create a namespace selector
1471 * @param mixed $selected The namespace which should be selected, default ''
1472 * @param string $allnamespaces Value of a special item denoting all namespaces. Null to not include (default)
1473 * @return Html string containing the namespace selector
1475 function &HTMLnamespaceselector($selected = '', $allnamespaces = null) {
1477 if( $selected !== '' ) {
1478 if( is_null( $selected ) ) {
1479 // No namespace selected; let exact match work without hitting Main
1482 // Let input be numeric strings without breaking the empty match.
1483 $selected = intval( $selected );
1486 $s = "<select name='namespace' class='namespaceselector'>\n\t";
1487 $arr = $wgContLang->getFormattedNamespaces();
1488 if( !is_null($allnamespaces) ) {
1489 $arr = array($allnamespaces => wfMsgHtml('namespacesall')) +
$arr;
1491 foreach ($arr as $index => $name) {
1492 if ($index < NS_MAIN
) continue;
1494 $name = $index !== 0 ?
$name : wfMsgHtml('blanknamespace');
1496 if ($index === $selected) {
1497 $s .= wfElement("option",
1498 array("value" => $index, "selected" => "selected"),
1501 $s .= wfElement("option", array("value" => $index), $name);
1504 $s .= "\n</select>\n";
1508 /** Global singleton instance of MimeMagic. This is initialized on demand,
1509 * please always use the wfGetMimeMagic() function to get the instance.
1515 /** Factory functions for the global MimeMagic object.
1516 * This function always returns the same singleton instance of MimeMagic.
1517 * That objects will be instantiated on the first call to this function.
1518 * If needed, the MimeMagic.php file is automatically included by this function.
1519 * @return MimeMagic the global MimeMagic objects.
1521 function &wfGetMimeMagic() {
1522 global $wgMimeMagic;
1524 if (!is_null($wgMimeMagic)) {
1525 return $wgMimeMagic;
1528 if (!class_exists("MimeMagic")) {
1530 require_once("MimeMagic.php");
1533 $wgMimeMagic= new MimeMagic();
1535 return $wgMimeMagic;
1540 * Tries to get the system directory for temporary files.
1541 * The TMPDIR, TMP, and TEMP environment variables are checked in sequence,
1542 * and if none are set /tmp is returned as the generic Unix default.
1544 * NOTE: When possible, use the tempfile() function to create temporary
1545 * files to avoid race conditions on file creation, etc.
1549 function wfTempDir() {
1550 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
1551 $tmp = getenv( $var );
1552 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
1556 # Hope this is Unix of some kind!
1561 * Make directory, and make all parent directories if they don't exist
1563 function wfMkdirParents( $fullDir, $mode ) {
1564 $parts = explode( '/', $fullDir );
1567 foreach ( $parts as $dir ) {
1568 $path .= $dir . '/';
1569 if ( !is_dir( $path ) ) {
1570 if ( !mkdir( $path, $mode ) ) {
1579 * Increment a statistics counter
1581 function wfIncrStats( $key ) {
1582 global $wgDBname, $wgMemc;
1583 $key = "$wgDBname:stats:$key";
1584 if ( is_null( $wgMemc->incr( $key ) ) ) {
1585 $wgMemc->add( $key, 1 );
1590 * @param mixed $nr The number to format
1591 * @param int $acc The number of digits after the decimal point, default 2
1592 * @param bool $round Whether or not to round the value, default true
1595 function wfPercent( $nr, $acc = 2, $round = true ) {
1596 $ret = sprintf( "%.${acc}f", $nr );
1597 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
1601 * Encrypt a username/password.
1603 * @param string $userid ID of the user
1604 * @param string $password Password of the user
1605 * @return string Hashed password
1607 function wfEncryptPassword( $userid, $password ) {
1608 global $wgPasswordSalt;
1609 $p = md5( $password);
1612 return md5( "{$userid}-{$p}" );
1618 * Appends to second array if $value differs from that in $default
1620 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
1621 if ( is_null( $changed ) ) {
1622 wfDebugDieBacktrace('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
1624 if ( $default[$key] !== $value ) {
1625 $changed[$key] = $value;
1630 * Since wfMsg() and co suck, they don't return false if the message key they
1631 * looked up didn't exist but a XHTML string, this function checks for the
1632 * nonexistance of messages by looking at wfMsg() output
1634 * @param $msg The message key looked up
1635 * @param $wfMsgOut The output of wfMsg*()
1638 function wfEmptyMsg( $msg, $wfMsgOut ) {
1639 return $wfMsgOut === "<$msg>";
1643 * Find out whether or not a mixed variable exists in a string
1645 * @param mixed needle
1646 * @param string haystack
1649 function in_string( $needle, $str ) {
1650 return strpos( $str, $needle ) !== false;
1654 * Returns a regular expression of url protocols
1658 function wfUrlProtocols() {
1659 global $wgUrlProtocols;
1661 $protocols = array();
1662 foreach ($wgUrlProtocols as $protocol)
1663 $protocols[] = preg_quote( $protocol, '/' );
1665 return implode( '|', $protocols );
1669 * Check if a string is well-formed XML.
1670 * Must include the surrounding tag.
1672 * @param string $text
1675 * @todo Error position reporting return
1677 function wfIsWellFormedXml( $text ) {
1678 $parser = xml_parser_create( "UTF-8" );
1680 # case folding violates XML standard, turn it off
1681 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING
, false );
1683 if( !xml_parse( $parser, $text, true ) ) {
1684 $err = xml_error_string( xml_get_error_code( $parser ) );
1685 $position = xml_get_current_byte_index( $parser );
1686 //$fragment = $this->extractFragment( $html, $position );
1687 //$this->mXmlError = "$err at byte $position:\n$fragment";
1688 xml_parser_free( $parser );
1691 xml_parser_free( $parser );
1696 * Check if a string is a well-formed XML fragment.
1697 * Wraps fragment in an <html> bit and doctype, so it can be a fragment
1698 * and can use HTML named entities.
1700 * @param string $text
1703 function wfIsWellFormedXmlFragment( $text ) {
1705 Sanitizer
::hackDocType() .
1709 return wfIsWellFormedXml( $html );
1713 * shell_exec() with time and memory limits mirrored from the PHP configuration,
1716 function wfShellExec( $cmd )
1720 if ( php_uname( 's' ) == 'Linux' ) {
1721 $time = ini_get( 'max_execution_time' );
1722 $mem = ini_get( 'memory_limit' );
1723 if( preg_match( '/^([0-9]+)[Mm]$/', trim( $mem ), $m ) ) {
1724 $mem = intval( $m[1] * (1024*1024) );
1726 if ( $time > 0 && $mem > 0 ) {
1727 $script = "$IP/bin/ulimit.sh";
1728 if ( is_executable( $script ) ) {
1729 $memKB = intval( $mem / 1024 );
1730 $cmd = escapeshellarg( $script ) . " $time $memKB $cmd";
1734 return shell_exec( $cmd );
1738 * This function works like "use VERSION" in Perl, the program will die with a
1739 * backtrace if the current version of PHP is less than the version provided
1741 * This is useful for extensions which due to their nature are not kept in sync
1742 * with releases, and might depend on other versions of PHP than the main code
1744 * Note: PHP might die due to parsing errors in some cases before it ever
1745 * manages to call this function, such is life
1747 * @see perldoc -f use
1749 * @param mixed $version The version to check, can be a string, an integer, or
1752 function wfUsePHP( $req_ver ) {
1753 $php_ver = PHP_VERSION
;
1755 if ( version_compare( $php_ver, (string)$req_ver, '<' ) )
1756 wfDebugDieBacktrace( "PHP $req_ver required--this is only $php_ver" );
1760 * This function works like "use VERSION" in Perl except it checks the version
1761 * of MediaWiki, the program will die with a backtrace if the current version
1762 * of MediaWiki is less than the version provided.
1764 * This is useful for extensions which due to their nature are not kept in sync
1767 * @see perldoc -f use
1769 * @param mixed $version The version to check, can be a string, an integer, or
1772 function wfUseMW( $req_ver ) {
1775 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) )
1776 wfDebugDieBacktrace( "MediaWiki $req_ver required--this is only $wgVersion" );
1780 * Escape a string to make it suitable for inclusion in a preg_replace()
1781 * replacement parameter.
1783 * @param string $string
1786 function wfRegexReplacement( $string ) {
1787 $string = str_replace( '\\', '\\\\', $string );
1788 $string = str_replace( '$', '\\$', $string );