Merge "Use the MWDebug class to display debug log back in the request."
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
1 <?php
2 /**
3 * Global functions used everywhere.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
25 }
26
27 // Hide compatibility functions from Doxygen
28 /// @cond
29
30 /**
31 * Compatibility functions
32 *
33 * We support PHP 5.3.2 and up.
34 * Re-implementations of newer functions or functions in non-standard
35 * PHP extensions may be included here.
36 */
37
38 if( !function_exists( 'iconv' ) ) {
39 /**
40 * @codeCoverageIgnore
41 * @return string
42 */
43 function iconv( $from, $to, $string ) {
44 return Fallback::iconv( $from, $to, $string );
45 }
46 }
47
48 if ( !function_exists( 'mb_substr' ) ) {
49 /**
50 * @codeCoverageIgnore
51 * @return string
52 */
53 function mb_substr( $str, $start, $count='end' ) {
54 return Fallback::mb_substr( $str, $start, $count );
55 }
56
57 /**
58 * @codeCoverageIgnore
59 * @return int
60 */
61 function mb_substr_split_unicode( $str, $splitPos ) {
62 return Fallback::mb_substr_split_unicode( $str, $splitPos );
63 }
64 }
65
66 if ( !function_exists( 'mb_strlen' ) ) {
67 /**
68 * @codeCoverageIgnore
69 * @return int
70 */
71 function mb_strlen( $str, $enc = '' ) {
72 return Fallback::mb_strlen( $str, $enc );
73 }
74 }
75
76 if( !function_exists( 'mb_strpos' ) ) {
77 /**
78 * @codeCoverageIgnore
79 * @return int
80 */
81 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
82 return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding );
83 }
84
85 }
86
87 if( !function_exists( 'mb_strrpos' ) ) {
88 /**
89 * @codeCoverageIgnore
90 * @return int
91 */
92 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
93 return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding );
94 }
95 }
96
97
98 // Support for Wietse Venema's taint feature
99 if ( !function_exists( 'istainted' ) ) {
100 /**
101 * @codeCoverageIgnore
102 * @return int
103 */
104 function istainted( $var ) {
105 return 0;
106 }
107 /** @codeCoverageIgnore */
108 function taint( $var, $level = 0 ) {}
109 /** @codeCoverageIgnore */
110 function untaint( $var, $level = 0 ) {}
111 define( 'TC_HTML', 1 );
112 define( 'TC_SHELL', 1 );
113 define( 'TC_MYSQL', 1 );
114 define( 'TC_PCRE', 1 );
115 define( 'TC_SELF', 1 );
116 }
117 /// @endcond
118
119 /**
120 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
121 * @param $a array
122 * @param $b array
123 * @return array
124 */
125 function wfArrayDiff2( $a, $b ) {
126 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
127 }
128
129 /**
130 * @param $a
131 * @param $b
132 * @return int
133 */
134 function wfArrayDiff2_cmp( $a, $b ) {
135 if ( !is_array( $a ) ) {
136 return strcmp( $a, $b );
137 } elseif ( count( $a ) !== count( $b ) ) {
138 return count( $a ) < count( $b ) ? -1 : 1;
139 } else {
140 reset( $a );
141 reset( $b );
142 while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
143 $cmp = strcmp( $valueA, $valueB );
144 if ( $cmp !== 0 ) {
145 return $cmp;
146 }
147 }
148 return 0;
149 }
150 }
151
152 /**
153 * Array lookup
154 * Returns an array where the values in the first array are replaced by the
155 * values in the second array with the corresponding keys
156 *
157 * @param $a Array
158 * @param $b Array
159 * @return array
160 */
161 function wfArrayLookup( $a, $b ) {
162 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
163 }
164
165 /**
166 * Appends to second array if $value differs from that in $default
167 *
168 * @param $key String|Int
169 * @param $value Mixed
170 * @param $default Mixed
171 * @param $changed Array to alter
172 */
173 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
174 if ( is_null( $changed ) ) {
175 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
176 }
177 if ( $default[$key] !== $value ) {
178 $changed[$key] = $value;
179 }
180 }
181
182 /**
183 * Backwards array plus for people who haven't bothered to read the PHP manual
184 * XXX: will not darn your socks for you.
185 *
186 * @param $array1 Array
187 * @param [$array2, [...]] Arrays
188 * @return Array
189 */
190 function wfArrayMerge( $array1/* ... */ ) {
191 $args = func_get_args();
192 $args = array_reverse( $args, true );
193 $out = array();
194 foreach ( $args as $arg ) {
195 $out += $arg;
196 }
197 return $out;
198 }
199
200 /**
201 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
202 * e.g.
203 * wfMergeErrorArrays(
204 * array( array( 'x' ) ),
205 * array( array( 'x', '2' ) ),
206 * array( array( 'x' ) ),
207 * array( array( 'y' ) )
208 * );
209 * returns:
210 * array(
211 * array( 'x', '2' ),
212 * array( 'x' ),
213 * array( 'y' )
214 * )
215 * @param varargs
216 * @return Array
217 */
218 function wfMergeErrorArrays( /*...*/ ) {
219 $args = func_get_args();
220 $out = array();
221 foreach ( $args as $errors ) {
222 foreach ( $errors as $params ) {
223 # @todo FIXME: Sometimes get nested arrays for $params,
224 # which leads to E_NOTICEs
225 $spec = implode( "\t", $params );
226 $out[$spec] = $params;
227 }
228 }
229 return array_values( $out );
230 }
231
232 /**
233 * Insert array into another array after the specified *KEY*
234 *
235 * @param $array Array: The array.
236 * @param $insert Array: The array to insert.
237 * @param $after Mixed: The key to insert after
238 * @return Array
239 */
240 function wfArrayInsertAfter( array $array, array $insert, $after ) {
241 // Find the offset of the element to insert after.
242 $keys = array_keys( $array );
243 $offsetByKey = array_flip( $keys );
244
245 $offset = $offsetByKey[$after];
246
247 // Insert at the specified offset
248 $before = array_slice( $array, 0, $offset + 1, true );
249 $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
250
251 $output = $before + $insert + $after;
252
253 return $output;
254 }
255
256 /**
257 * Recursively converts the parameter (an object) to an array with the same data
258 *
259 * @param $objOrArray Object|Array
260 * @param $recursive Bool
261 * @return Array
262 */
263 function wfObjectToArray( $objOrArray, $recursive = true ) {
264 $array = array();
265 if( is_object( $objOrArray ) ) {
266 $objOrArray = get_object_vars( $objOrArray );
267 }
268 foreach ( $objOrArray as $key => $value ) {
269 if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
270 $value = wfObjectToArray( $value );
271 }
272
273 $array[$key] = $value;
274 }
275
276 return $array;
277 }
278
279 /**
280 * Wrapper around array_map() which also taints variables
281 *
282 * @param $function Callback
283 * @param $input Array
284 * @return Array
285 */
286 function wfArrayMap( $function, $input ) {
287 $ret = array_map( $function, $input );
288 foreach ( $ret as $key => $value ) {
289 $taint = istainted( $input[$key] );
290 if ( $taint ) {
291 taint( $ret[$key], $taint );
292 }
293 }
294 return $ret;
295 }
296
297 /**
298 * Get a random decimal value between 0 and 1, in a way
299 * not likely to give duplicate values for any realistic
300 * number of articles.
301 *
302 * @return string
303 */
304 function wfRandom() {
305 # The maximum random value is "only" 2^31-1, so get two random
306 # values to reduce the chance of dupes
307 $max = mt_getrandmax() + 1;
308 $rand = number_format( ( mt_rand() * $max + mt_rand() )
309 / $max / $max, 12, '.', '' );
310 return $rand;
311 }
312
313 /**
314 * Get a random string containing a number of pesudo-random hex
315 * characters.
316 * @note This is not secure, if you are trying to generate some sort
317 * of token please use MWCryptRand instead.
318 *
319 * @param $length int The length of the string to generate
320 * @return String
321 * @since 1.20
322 */
323 function wfRandomString( $length = 32 ) {
324 $str = '';
325 while ( strlen( $str ) < $length ) {
326 $str .= dechex( mt_rand() );
327 }
328 return substr( $str, 0, $length );
329 }
330
331 /**
332 * We want some things to be included as literal characters in our title URLs
333 * for prettiness, which urlencode encodes by default. According to RFC 1738,
334 * all of the following should be safe:
335 *
336 * ;:@&=$-_.+!*'(),
337 *
338 * But + is not safe because it's used to indicate a space; &= are only safe in
339 * paths and not in queries (and we don't distinguish here); ' seems kind of
340 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
341 * is reserved, we don't care. So the list we unescape is:
342 *
343 * ;:@$!*(),/
344 *
345 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
346 * so no fancy : for IIS7.
347 *
348 * %2F in the page titles seems to fatally break for some reason.
349 *
350 * @param $s String:
351 * @return string
352 */
353 function wfUrlencode( $s ) {
354 static $needle;
355 if ( is_null( $s ) ) {
356 $needle = null;
357 return '';
358 }
359
360 if ( is_null( $needle ) ) {
361 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
362 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) || ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
363 $needle[] = '%3A';
364 }
365 }
366
367 $s = urlencode( $s );
368 $s = str_ireplace(
369 $needle,
370 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
371 $s
372 );
373
374 return $s;
375 }
376
377 /**
378 * This function takes two arrays as input, and returns a CGI-style string, e.g.
379 * "days=7&limit=100". Options in the first array override options in the second.
380 * Options set to null or false will not be output.
381 *
382 * @param $array1 Array ( String|Array )
383 * @param $array2 Array ( String|Array )
384 * @param $prefix String
385 * @return String
386 */
387 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
388 if ( !is_null( $array2 ) ) {
389 $array1 = $array1 + $array2;
390 }
391
392 $cgi = '';
393 foreach ( $array1 as $key => $value ) {
394 if ( !is_null($value) && $value !== false ) {
395 if ( $cgi != '' ) {
396 $cgi .= '&';
397 }
398 if ( $prefix !== '' ) {
399 $key = $prefix . "[$key]";
400 }
401 if ( is_array( $value ) ) {
402 $firstTime = true;
403 foreach ( $value as $k => $v ) {
404 $cgi .= $firstTime ? '' : '&';
405 if ( is_array( $v ) ) {
406 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
407 } else {
408 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
409 }
410 $firstTime = false;
411 }
412 } else {
413 if ( is_object( $value ) ) {
414 $value = $value->__toString();
415 }
416 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
417 }
418 }
419 }
420 return $cgi;
421 }
422
423 /**
424 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
425 * its argument and returns the same string in array form. This allows compa-
426 * tibility with legacy functions that accept raw query strings instead of nice
427 * arrays. Of course, keys and values are urldecode()d.
428 *
429 * @param $query String: query string
430 * @return array Array version of input
431 */
432 function wfCgiToArray( $query ) {
433 if ( isset( $query[0] ) && $query[0] == '?' ) {
434 $query = substr( $query, 1 );
435 }
436 $bits = explode( '&', $query );
437 $ret = array();
438 foreach ( $bits as $bit ) {
439 if ( $bit === '' ) {
440 continue;
441 }
442 if ( strpos( $bit, '=' ) === false ) {
443 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
444 $key = $bit;
445 $value = '';
446 } else {
447 list( $key, $value ) = explode( '=', $bit );
448 }
449 $key = urldecode( $key );
450 $value = urldecode( $value );
451 if ( strpos( $key, '[' ) !== false ) {
452 $keys = array_reverse( explode( '[', $key ) );
453 $key = array_pop( $keys );
454 $temp = $value;
455 foreach ( $keys as $k ) {
456 $k = substr( $k, 0, -1 );
457 $temp = array( $k => $temp );
458 }
459 if ( isset( $ret[$key] ) ) {
460 $ret[$key] = array_merge( $ret[$key], $temp );
461 } else {
462 $ret[$key] = $temp;
463 }
464 } else {
465 $ret[$key] = $value;
466 }
467 }
468 return $ret;
469 }
470
471 /**
472 * Append a query string to an existing URL, which may or may not already
473 * have query string parameters already. If so, they will be combined.
474 *
475 * @param $url String
476 * @param $query Mixed: string or associative array
477 * @return string
478 */
479 function wfAppendQuery( $url, $query ) {
480 if ( is_array( $query ) ) {
481 $query = wfArrayToCgi( $query );
482 }
483 if( $query != '' ) {
484 if( false === strpos( $url, '?' ) ) {
485 $url .= '?';
486 } else {
487 $url .= '&';
488 }
489 $url .= $query;
490 }
491 return $url;
492 }
493
494 /**
495 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
496 * is correct.
497 *
498 * The meaning of the PROTO_* constants is as follows:
499 * PROTO_HTTP: Output a URL starting with http://
500 * PROTO_HTTPS: Output a URL starting with https://
501 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
502 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
503 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
504 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
505 *
506 * @todo this won't work with current-path-relative URLs
507 * like "subdir/foo.html", etc.
508 *
509 * @param $url String: either fully-qualified or a local path + query
510 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
511 * protocol to use if $url or $wgServer is
512 * protocol-relative
513 * @return string Fully-qualified URL, current-path-relative URL or false if
514 * no valid URL can be constructed
515 */
516 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
517 global $wgServer, $wgCanonicalServer, $wgInternalServer;
518 $serverUrl = $wgServer;
519 if ( $defaultProto === PROTO_CANONICAL ) {
520 $serverUrl = $wgCanonicalServer;
521 }
522 // Make $wgInternalServer fall back to $wgServer if not set
523 if ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
524 $serverUrl = $wgInternalServer;
525 }
526 if ( $defaultProto === PROTO_CURRENT ) {
527 $defaultProto = WebRequest::detectProtocol() . '://';
528 }
529
530 // Analyze $serverUrl to obtain its protocol
531 $bits = wfParseUrl( $serverUrl );
532 $serverHasProto = $bits && $bits['scheme'] != '';
533
534 if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
535 if ( $serverHasProto ) {
536 $defaultProto = $bits['scheme'] . '://';
537 } else {
538 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
539 // Fall back to HTTP in this ridiculous case
540 $defaultProto = PROTO_HTTP;
541 }
542 }
543
544 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
545
546 if ( substr( $url, 0, 2 ) == '//' ) {
547 $url = $defaultProtoWithoutSlashes . $url;
548 } elseif ( substr( $url, 0, 1 ) == '/' ) {
549 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
550 $url = ( $serverHasProto ? '' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
551 }
552
553 $bits = wfParseUrl( $url );
554 if ( $bits && isset( $bits['path'] ) ) {
555 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
556 return wfAssembleUrl( $bits );
557 } elseif ( $bits ) {
558 # No path to expand
559 return $url;
560 } elseif ( substr( $url, 0, 1 ) != '/' ) {
561 # URL is a relative path
562 return wfRemoveDotSegments( $url );
563 }
564
565 # Expanded URL is not valid.
566 return false;
567 }
568
569 /**
570 * This function will reassemble a URL parsed with wfParseURL. This is useful
571 * if you need to edit part of a URL and put it back together.
572 *
573 * This is the basic structure used (brackets contain keys for $urlParts):
574 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
575 *
576 * @todo Need to integrate this into wfExpandUrl (bug 32168)
577 *
578 * @since 1.19
579 * @param $urlParts Array URL parts, as output from wfParseUrl
580 * @return string URL assembled from its component parts
581 */
582 function wfAssembleUrl( $urlParts ) {
583 $result = '';
584
585 if ( isset( $urlParts['delimiter'] ) ) {
586 if ( isset( $urlParts['scheme'] ) ) {
587 $result .= $urlParts['scheme'];
588 }
589
590 $result .= $urlParts['delimiter'];
591 }
592
593 if ( isset( $urlParts['host'] ) ) {
594 if ( isset( $urlParts['user'] ) ) {
595 $result .= $urlParts['user'];
596 if ( isset( $urlParts['pass'] ) ) {
597 $result .= ':' . $urlParts['pass'];
598 }
599 $result .= '@';
600 }
601
602 $result .= $urlParts['host'];
603
604 if ( isset( $urlParts['port'] ) ) {
605 $result .= ':' . $urlParts['port'];
606 }
607 }
608
609 if ( isset( $urlParts['path'] ) ) {
610 $result .= $urlParts['path'];
611 }
612
613 if ( isset( $urlParts['query'] ) ) {
614 $result .= '?' . $urlParts['query'];
615 }
616
617 if ( isset( $urlParts['fragment'] ) ) {
618 $result .= '#' . $urlParts['fragment'];
619 }
620
621 return $result;
622 }
623
624 /**
625 * Remove all dot-segments in the provided URL path. For example,
626 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
627 * RFC3986 section 5.2.4.
628 *
629 * @todo Need to integrate this into wfExpandUrl (bug 32168)
630 *
631 * @param $urlPath String URL path, potentially containing dot-segments
632 * @return string URL path with all dot-segments removed
633 */
634 function wfRemoveDotSegments( $urlPath ) {
635 $output = '';
636 $inputOffset = 0;
637 $inputLength = strlen( $urlPath );
638
639 while ( $inputOffset < $inputLength ) {
640 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
641 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
642 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
643 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
644 $trimOutput = false;
645
646 if ( $prefixLengthTwo == './' ) {
647 # Step A, remove leading "./"
648 $inputOffset += 2;
649 } elseif ( $prefixLengthThree == '../' ) {
650 # Step A, remove leading "../"
651 $inputOffset += 3;
652 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
653 # Step B, replace leading "/.$" with "/"
654 $inputOffset += 1;
655 $urlPath[$inputOffset] = '/';
656 } elseif ( $prefixLengthThree == '/./' ) {
657 # Step B, replace leading "/./" with "/"
658 $inputOffset += 2;
659 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
660 # Step C, replace leading "/..$" with "/" and
661 # remove last path component in output
662 $inputOffset += 2;
663 $urlPath[$inputOffset] = '/';
664 $trimOutput = true;
665 } elseif ( $prefixLengthFour == '/../' ) {
666 # Step C, replace leading "/../" with "/" and
667 # remove last path component in output
668 $inputOffset += 3;
669 $trimOutput = true;
670 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
671 # Step D, remove "^.$"
672 $inputOffset += 1;
673 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
674 # Step D, remove "^..$"
675 $inputOffset += 2;
676 } else {
677 # Step E, move leading path segment to output
678 if ( $prefixLengthOne == '/' ) {
679 $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
680 } else {
681 $slashPos = strpos( $urlPath, '/', $inputOffset );
682 }
683 if ( $slashPos === false ) {
684 $output .= substr( $urlPath, $inputOffset );
685 $inputOffset = $inputLength;
686 } else {
687 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
688 $inputOffset += $slashPos - $inputOffset;
689 }
690 }
691
692 if ( $trimOutput ) {
693 $slashPos = strrpos( $output, '/' );
694 if ( $slashPos === false ) {
695 $output = '';
696 } else {
697 $output = substr( $output, 0, $slashPos );
698 }
699 }
700 }
701
702 return $output;
703 }
704
705 /**
706 * Returns a regular expression of url protocols
707 *
708 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
709 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
710 * @return String
711 */
712 function wfUrlProtocols( $includeProtocolRelative = true ) {
713 global $wgUrlProtocols;
714
715 // Cache return values separately based on $includeProtocolRelative
716 static $withProtRel = null, $withoutProtRel = null;
717 $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
718 if ( !is_null( $cachedValue ) ) {
719 return $cachedValue;
720 }
721
722 // Support old-style $wgUrlProtocols strings, for backwards compatibility
723 // with LocalSettings files from 1.5
724 if ( is_array( $wgUrlProtocols ) ) {
725 $protocols = array();
726 foreach ( $wgUrlProtocols as $protocol ) {
727 // Filter out '//' if !$includeProtocolRelative
728 if ( $includeProtocolRelative || $protocol !== '//' ) {
729 $protocols[] = preg_quote( $protocol, '/' );
730 }
731 }
732
733 $retval = implode( '|', $protocols );
734 } else {
735 // Ignore $includeProtocolRelative in this case
736 // This case exists for pre-1.6 compatibility, and we can safely assume
737 // that '//' won't appear in a pre-1.6 config because protocol-relative
738 // URLs weren't supported until 1.18
739 $retval = $wgUrlProtocols;
740 }
741
742 // Cache return value
743 if ( $includeProtocolRelative ) {
744 $withProtRel = $retval;
745 } else {
746 $withoutProtRel = $retval;
747 }
748 return $retval;
749 }
750
751 /**
752 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
753 * you need a regex that matches all URL protocols but does not match protocol-
754 * relative URLs
755 * @return String
756 */
757 function wfUrlProtocolsWithoutProtRel() {
758 return wfUrlProtocols( false );
759 }
760
761 /**
762 * parse_url() work-alike, but non-broken. Differences:
763 *
764 * 1) Does not raise warnings on bad URLs (just returns false)
765 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
766 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
767 *
768 * @param $url String: a URL to parse
769 * @return Array: bits of the URL in an associative array, per PHP docs
770 */
771 function wfParseUrl( $url ) {
772 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
773
774 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
775 // way to handle them is to just prepend 'http:' and strip the protocol out later
776 $wasRelative = substr( $url, 0, 2 ) == '//';
777 if ( $wasRelative ) {
778 $url = "http:$url";
779 }
780 wfSuppressWarnings();
781 $bits = parse_url( $url );
782 wfRestoreWarnings();
783 // parse_url() returns an array without scheme for some invalid URLs, e.g.
784 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
785 if ( !$bits || !isset( $bits['scheme'] ) ) {
786 return false;
787 }
788
789 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
790 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
791 $bits['delimiter'] = '://';
792 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
793 $bits['delimiter'] = ':';
794 // parse_url detects for news: and mailto: the host part of an url as path
795 // We have to correct this wrong detection
796 if ( isset( $bits['path'] ) ) {
797 $bits['host'] = $bits['path'];
798 $bits['path'] = '';
799 }
800 } else {
801 return false;
802 }
803
804 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
805 if ( !isset( $bits['host'] ) ) {
806 $bits['host'] = '';
807
808 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
809 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
810 $bits['path'] = '/' . $bits['path'];
811 }
812 }
813
814 // If the URL was protocol-relative, fix scheme and delimiter
815 if ( $wasRelative ) {
816 $bits['scheme'] = '';
817 $bits['delimiter'] = '//';
818 }
819 return $bits;
820 }
821
822 /**
823 * Take a URL, make sure it's expanded to fully qualified, and replace any
824 * encoded non-ASCII Unicode characters with their UTF-8 original forms
825 * for more compact display and legibility for local audiences.
826 *
827 * @todo handle punycode domains too
828 *
829 * @param $url string
830 * @return string
831 */
832 function wfExpandIRI( $url ) {
833 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
834 }
835
836 /**
837 * Private callback for wfExpandIRI
838 * @param array $matches
839 * @return string
840 */
841 function wfExpandIRI_callback( $matches ) {
842 return urldecode( $matches[1] );
843 }
844
845
846
847 /**
848 * Make URL indexes, appropriate for the el_index field of externallinks.
849 *
850 * @param $url String
851 * @return array
852 */
853 function wfMakeUrlIndexes( $url ) {
854 $bits = wfParseUrl( $url );
855
856 // Reverse the labels in the hostname, convert to lower case
857 // For emails reverse domainpart only
858 if ( $bits['scheme'] == 'mailto' ) {
859 $mailparts = explode( '@', $bits['host'], 2 );
860 if ( count( $mailparts ) === 2 ) {
861 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
862 } else {
863 // No domain specified, don't mangle it
864 $domainpart = '';
865 }
866 $reversedHost = $domainpart . '@' . $mailparts[0];
867 } else {
868 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
869 }
870 // Add an extra dot to the end
871 // Why? Is it in wrong place in mailto links?
872 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
873 $reversedHost .= '.';
874 }
875 // Reconstruct the pseudo-URL
876 $prot = $bits['scheme'];
877 $index = $prot . $bits['delimiter'] . $reversedHost;
878 // Leave out user and password. Add the port, path, query and fragment
879 if ( isset( $bits['port'] ) ) {
880 $index .= ':' . $bits['port'];
881 }
882 if ( isset( $bits['path'] ) ) {
883 $index .= $bits['path'];
884 } else {
885 $index .= '/';
886 }
887 if ( isset( $bits['query'] ) ) {
888 $index .= '?' . $bits['query'];
889 }
890 if ( isset( $bits['fragment'] ) ) {
891 $index .= '#' . $bits['fragment'];
892 }
893
894 if ( $prot == '' ) {
895 return array( "http:$index", "https:$index" );
896 } else {
897 return array( $index );
898 }
899 }
900
901 /**
902 * Check whether a given URL has a domain that occurs in a given set of domains
903 * @param $url string URL
904 * @param $domains array Array of domains (strings)
905 * @return bool True if the host part of $url ends in one of the strings in $domains
906 */
907 function wfMatchesDomainList( $url, $domains ) {
908 $bits = wfParseUrl( $url );
909 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
910 foreach ( (array)$domains as $domain ) {
911 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
912 // We should use something that interprets dots instead
913 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
914 return true;
915 }
916 }
917 }
918 return false;
919 }
920
921 /**
922 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
923 * In normal operation this is a NOP.
924 *
925 * Controlling globals:
926 * $wgDebugLogFile - points to the log file
927 * $wgProfileOnly - if set, normal debug messages will not be recorded.
928 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
929 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
930 *
931 * @param $text String
932 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
933 */
934 function wfDebug( $text, $logonly = false ) {
935 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
936
937 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
938 return;
939 }
940
941 $timer = wfDebugTimer();
942 if ( $timer !== '' ) {
943 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
944 }
945
946 if ( !$logonly ) {
947 MWDebug::debugMsg( $text );
948 }
949
950 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
951 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
952 # Strip unprintables; they can switch terminal modes when binary data
953 # gets dumped, which is pretty annoying.
954 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
955 $text = $wgDebugLogPrefix . $text;
956 wfErrorLog( $text, $wgDebugLogFile );
957 }
958 }
959 }
960
961 /**
962 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
963 * @return bool
964 */
965 function wfIsDebugRawPage() {
966 static $cache;
967 if ( $cache !== null ) {
968 return $cache;
969 }
970 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
971 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
972 || (
973 isset( $_SERVER['SCRIPT_NAME'] )
974 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
975 ) )
976 {
977 $cache = true;
978 } else {
979 $cache = false;
980 }
981 return $cache;
982 }
983
984 /**
985 * Get microsecond timestamps for debug logs
986 *
987 * @return string
988 */
989 function wfDebugTimer() {
990 global $wgDebugTimestamps, $wgRequestTime;
991
992 if ( !$wgDebugTimestamps ) {
993 return '';
994 }
995
996 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
997 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
998 return "$prefix $mem ";
999 }
1000
1001 /**
1002 * Send a line giving PHP memory usage.
1003 *
1004 * @param $exact Bool: print exact values instead of kilobytes (default: false)
1005 */
1006 function wfDebugMem( $exact = false ) {
1007 $mem = memory_get_usage();
1008 if( !$exact ) {
1009 $mem = floor( $mem / 1024 ) . ' kilobytes';
1010 } else {
1011 $mem .= ' bytes';
1012 }
1013 wfDebug( "Memory usage: $mem\n" );
1014 }
1015
1016 /**
1017 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1018 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1019 *
1020 * @param $logGroup String
1021 * @param $text String
1022 * @param $public Bool: whether to log the event in the public log if no private
1023 * log file is specified, (default true)
1024 */
1025 function wfDebugLog( $logGroup, $text, $public = true ) {
1026 global $wgDebugLogGroups;
1027 $text = trim( $text ) . "\n";
1028 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
1029 $time = wfTimestamp( TS_DB );
1030 $wiki = wfWikiID();
1031 $host = wfHostname();
1032 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1033 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1034 }
1035 } elseif ( $public === true ) {
1036 wfDebug( $text, true );
1037 }
1038 }
1039
1040 /**
1041 * Log for database errors
1042 *
1043 * @param $text String: database error message.
1044 */
1045 function wfLogDBError( $text ) {
1046 global $wgDBerrorLog, $wgDBerrorLogTZ;
1047 static $logDBErrorTimeZoneObject = null;
1048
1049 if ( $wgDBerrorLog ) {
1050 $host = wfHostname();
1051 $wiki = wfWikiID();
1052
1053 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1054 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1055 }
1056
1057 // Workaround for https://bugs.php.net/bug.php?id=52063
1058 // Can be removed when min PHP > 5.3.2
1059 if ( $logDBErrorTimeZoneObject === null ) {
1060 $d = date_create( "now" );
1061 } else {
1062 $d = date_create( "now", $logDBErrorTimeZoneObject );
1063 }
1064
1065 $date = $d->format( 'D M j G:i:s T Y' );
1066
1067 $text = "$date\t$host\t$wiki\t$text";
1068 wfErrorLog( $text, $wgDBerrorLog );
1069 }
1070 }
1071
1072 /**
1073 * Throws a warning that $function is deprecated
1074 *
1075 * @param $function String
1076 * @param $version String|bool: Version of MediaWiki that the function was deprecated in (Added in 1.19).
1077 * @param $component String|bool: Added in 1.19.
1078 * @param $callerOffset integer: How far up the callstack is the original
1079 * caller. 2 = function that called the function that called
1080 * wfDeprecated (Added in 1.20)
1081 *
1082 * @return null
1083 */
1084 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1085 static $functionsWarned = array();
1086
1087 MWDebug::deprecated( $function, $version, $component );
1088
1089 if ( !isset( $functionsWarned[$function] ) ) {
1090 $functionsWarned[$function] = true;
1091
1092 if ( $version ) {
1093 global $wgDeprecationReleaseLimit;
1094
1095 if ( $wgDeprecationReleaseLimit && $component === false ) {
1096 # Strip -* off the end of $version so that branches can use the
1097 # format #.##-branchname to avoid issues if the branch is merged into
1098 # a version of MediaWiki later than what it was branched from
1099 $comparableVersion = preg_replace( '/-.*$/', '', $version );
1100
1101 # If the comparableVersion is larger than our release limit then
1102 # skip the warning message for the deprecation
1103 if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
1104 return;
1105 }
1106 }
1107
1108 $component = $component === false ? 'MediaWiki' : $component;
1109 wfWarn( "Use of $function was deprecated in $component $version.", $callerOffset );
1110 } else {
1111 wfWarn( "Use of $function is deprecated.", $callerOffset );
1112 }
1113 }
1114 }
1115
1116 /**
1117 * Send a warning either to the debug log or in a PHP error depending on
1118 * $wgDevelopmentWarnings
1119 *
1120 * @param $msg String: message to send
1121 * @param $callerOffset Integer: number of items to go back in the backtrace to
1122 * find the correct caller (1 = function calling wfWarn, ...)
1123 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
1124 * is true
1125 */
1126 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1127 global $wgDevelopmentWarnings;
1128
1129 MWDebug::warning( $msg, $callerOffset + 2 );
1130
1131 $callers = wfDebugBacktrace();
1132 if ( isset( $callers[$callerOffset + 1] ) ) {
1133 $callerfunc = $callers[$callerOffset + 1];
1134 $callerfile = $callers[$callerOffset];
1135 if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
1136 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
1137 } else {
1138 $file = '(internal function)';
1139 }
1140 $func = '';
1141 if ( isset( $callerfunc['class'] ) ) {
1142 $func .= $callerfunc['class'] . '::';
1143 }
1144 if ( isset( $callerfunc['function'] ) ) {
1145 $func .= $callerfunc['function'];
1146 }
1147 $msg .= " [Called from $func in $file]";
1148 }
1149
1150 if ( $wgDevelopmentWarnings ) {
1151 trigger_error( $msg, $level );
1152 } else {
1153 wfDebug( "$msg\n" );
1154 }
1155 }
1156
1157 /**
1158 * Log to a file without getting "file size exceeded" signals.
1159 *
1160 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1161 * send lines to the specified port, prefixed by the specified prefix and a space.
1162 *
1163 * @param $text String
1164 * @param $file String filename
1165 */
1166 function wfErrorLog( $text, $file ) {
1167 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1168 # Needs the sockets extension
1169 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1170 // IPv6 bracketed host
1171 $host = $m[2];
1172 $port = intval( $m[3] );
1173 $prefix = isset( $m[4] ) ? $m[4] : false;
1174 $domain = AF_INET6;
1175 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1176 $host = $m[2];
1177 if ( !IP::isIPv4( $host ) ) {
1178 $host = gethostbyname( $host );
1179 }
1180 $port = intval( $m[3] );
1181 $prefix = isset( $m[4] ) ? $m[4] : false;
1182 $domain = AF_INET;
1183 } else {
1184 throw new MWException( __METHOD__ . ': Invalid UDP specification' );
1185 }
1186
1187 // Clean it up for the multiplexer
1188 if ( strval( $prefix ) !== '' ) {
1189 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1190
1191 // Limit to 64KB
1192 if ( strlen( $text ) > 65506 ) {
1193 $text = substr( $text, 0, 65506 );
1194 }
1195
1196 if ( substr( $text, -1 ) != "\n" ) {
1197 $text .= "\n";
1198 }
1199 } elseif ( strlen( $text ) > 65507 ) {
1200 $text = substr( $text, 0, 65507 );
1201 }
1202
1203 $sock = socket_create( $domain, SOCK_DGRAM, SOL_UDP );
1204 if ( !$sock ) {
1205 return;
1206 }
1207
1208 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1209 socket_close( $sock );
1210 } else {
1211 wfSuppressWarnings();
1212 $exists = file_exists( $file );
1213 $size = $exists ? filesize( $file ) : false;
1214 if ( !$exists || ( $size !== false && $size + strlen( $text ) < 0x7fffffff ) ) {
1215 file_put_contents( $file, $text, FILE_APPEND );
1216 }
1217 wfRestoreWarnings();
1218 }
1219 }
1220
1221 /**
1222 * @todo document
1223 */
1224 function wfLogProfilingData() {
1225 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1226 global $wgProfileLimit, $wgUser;
1227
1228 $profiler = Profiler::instance();
1229
1230 # Profiling must actually be enabled...
1231 if ( $profiler->isStub() ) {
1232 return;
1233 }
1234
1235 // Get total page request time and only show pages that longer than
1236 // $wgProfileLimit time (default is 0)
1237 $elapsed = microtime( true ) - $wgRequestTime;
1238 if ( $elapsed <= $wgProfileLimit ) {
1239 return;
1240 }
1241
1242 $profiler->logData();
1243
1244 // Check whether this should be logged in the debug file.
1245 if ( $wgDebugLogFile == '' || ( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1246 return;
1247 }
1248
1249 $forward = '';
1250 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1251 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1252 }
1253 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1254 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1255 }
1256 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1257 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1258 }
1259 if ( $forward ) {
1260 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1261 }
1262 // Don't load $wgUser at this late stage just for statistics purposes
1263 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1264 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1265 $forward .= ' anon';
1266 }
1267 $log = sprintf( "%s\t%04.3f\t%s\n",
1268 gmdate( 'YmdHis' ), $elapsed,
1269 urldecode( $wgRequest->getRequestURL() . $forward ) );
1270
1271 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1272 }
1273
1274 /**
1275 * Increment a statistics counter
1276 *
1277 * @param $key String
1278 * @param $count Int
1279 */
1280 function wfIncrStats( $key, $count = 1 ) {
1281 global $wgStatsMethod;
1282
1283 $count = intval( $count );
1284
1285 if( $wgStatsMethod == 'udp' ) {
1286 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
1287 static $socket;
1288
1289 $id = $wgAggregateStatsID !== false ? $wgAggregateStatsID : $wgDBname;
1290
1291 if ( !$socket ) {
1292 $socket = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
1293 $statline = "stats/{$id} - 1 1 1 1 1 -total\n";
1294 socket_sendto(
1295 $socket,
1296 $statline,
1297 strlen( $statline ),
1298 0,
1299 $wgUDPProfilerHost,
1300 $wgUDPProfilerPort
1301 );
1302 }
1303 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
1304 wfSuppressWarnings();
1305 socket_sendto(
1306 $socket,
1307 $statline,
1308 strlen( $statline ),
1309 0,
1310 $wgUDPProfilerHost,
1311 $wgUDPProfilerPort
1312 );
1313 wfRestoreWarnings();
1314 } elseif( $wgStatsMethod == 'cache' ) {
1315 global $wgMemc;
1316 $key = wfMemcKey( 'stats', $key );
1317 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
1318 $wgMemc->add( $key, $count );
1319 }
1320 } else {
1321 // Disabled
1322 }
1323 }
1324
1325 /**
1326 * Check if the wiki read-only lock file is present. This can be used to lock
1327 * off editing functions, but doesn't guarantee that the database will not be
1328 * modified.
1329 *
1330 * @return bool
1331 */
1332 function wfReadOnly() {
1333 global $wgReadOnlyFile, $wgReadOnly;
1334
1335 if ( !is_null( $wgReadOnly ) ) {
1336 return (bool)$wgReadOnly;
1337 }
1338 if ( $wgReadOnlyFile == '' ) {
1339 return false;
1340 }
1341 // Set $wgReadOnly for faster access next time
1342 if ( is_file( $wgReadOnlyFile ) ) {
1343 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1344 } else {
1345 $wgReadOnly = false;
1346 }
1347 return (bool)$wgReadOnly;
1348 }
1349
1350 /**
1351 * @return bool
1352 */
1353 function wfReadOnlyReason() {
1354 global $wgReadOnly;
1355 wfReadOnly();
1356 return $wgReadOnly;
1357 }
1358
1359 /**
1360 * Return a Language object from $langcode
1361 *
1362 * @param $langcode Mixed: either:
1363 * - a Language object
1364 * - code of the language to get the message for, if it is
1365 * a valid code create a language for that language, if
1366 * it is a string but not a valid code then make a basic
1367 * language object
1368 * - a boolean: if it's false then use the global object for
1369 * the current user's language (as a fallback for the old parameter
1370 * functionality), or if it is true then use global object
1371 * for the wiki's content language.
1372 * @return Language object
1373 */
1374 function wfGetLangObj( $langcode = false ) {
1375 # Identify which language to get or create a language object for.
1376 # Using is_object here due to Stub objects.
1377 if( is_object( $langcode ) ) {
1378 # Great, we already have the object (hopefully)!
1379 return $langcode;
1380 }
1381
1382 global $wgContLang, $wgLanguageCode;
1383 if( $langcode === true || $langcode === $wgLanguageCode ) {
1384 # $langcode is the language code of the wikis content language object.
1385 # or it is a boolean and value is true
1386 return $wgContLang;
1387 }
1388
1389 global $wgLang;
1390 if( $langcode === false || $langcode === $wgLang->getCode() ) {
1391 # $langcode is the language code of user language object.
1392 # or it was a boolean and value is false
1393 return $wgLang;
1394 }
1395
1396 $validCodes = array_keys( Language::fetchLanguageNames() );
1397 if( in_array( $langcode, $validCodes ) ) {
1398 # $langcode corresponds to a valid language.
1399 return Language::factory( $langcode );
1400 }
1401
1402 # $langcode is a string, but not a valid language code; use content language.
1403 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1404 return $wgContLang;
1405 }
1406
1407 /**
1408 * Old function when $wgBetterDirectionality existed
1409 * All usage removed, wfUILang can be removed in near future
1410 *
1411 * @deprecated since 1.18
1412 * @return Language
1413 */
1414 function wfUILang() {
1415 wfDeprecated( __METHOD__, '1.18' );
1416 global $wgLang;
1417 return $wgLang;
1418 }
1419
1420 /**
1421 * This is the new function for getting translated interface messages.
1422 * See the Message class for documentation how to use them.
1423 * The intention is that this function replaces all old wfMsg* functions.
1424 * @param $key \string Message key.
1425 * Varargs: normal message parameters.
1426 * @return Message
1427 * @since 1.17
1428 */
1429 function wfMessage( $key /*...*/) {
1430 $params = func_get_args();
1431 array_shift( $params );
1432 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1433 $params = $params[0];
1434 }
1435 return new Message( $key, $params );
1436 }
1437
1438 /**
1439 * This function accepts multiple message keys and returns a message instance
1440 * for the first message which is non-empty. If all messages are empty then an
1441 * instance of the first message key is returned.
1442 * @param varargs: message keys
1443 * @return Message
1444 * @since 1.18
1445 */
1446 function wfMessageFallback( /*...*/ ) {
1447 $args = func_get_args();
1448 return MWFunction::callArray( 'Message::newFallbackSequence', $args );
1449 }
1450
1451 /**
1452 * Get a message from anywhere, for the current user language.
1453 *
1454 * Use wfMsgForContent() instead if the message should NOT
1455 * change depending on the user preferences.
1456 *
1457 * @deprecated since 1.18
1458 *
1459 * @param $key String: lookup key for the message, usually
1460 * defined in languages/Language.php
1461 *
1462 * Parameters to the message, which can be used to insert variable text into
1463 * it, can be passed to this function in the following formats:
1464 * - One per argument, starting at the second parameter
1465 * - As an array in the second parameter
1466 * These are not shown in the function definition.
1467 *
1468 * @return String
1469 */
1470 function wfMsg( $key ) {
1471 $args = func_get_args();
1472 array_shift( $args );
1473 return wfMsgReal( $key, $args );
1474 }
1475
1476 /**
1477 * Same as above except doesn't transform the message
1478 *
1479 * @deprecated since 1.18
1480 *
1481 * @param $key String
1482 * @return String
1483 */
1484 function wfMsgNoTrans( $key ) {
1485 $args = func_get_args();
1486 array_shift( $args );
1487 return wfMsgReal( $key, $args, true, false, false );
1488 }
1489
1490 /**
1491 * Get a message from anywhere, for the current global language
1492 * set with $wgLanguageCode.
1493 *
1494 * Use this if the message should NOT change dependent on the
1495 * language set in the user's preferences. This is the case for
1496 * most text written into logs, as well as link targets (such as
1497 * the name of the copyright policy page). Link titles, on the
1498 * other hand, should be shown in the UI language.
1499 *
1500 * Note that MediaWiki allows users to change the user interface
1501 * language in their preferences, but a single installation
1502 * typically only contains content in one language.
1503 *
1504 * Be wary of this distinction: If you use wfMsg() where you should
1505 * use wfMsgForContent(), a user of the software may have to
1506 * customize potentially hundreds of messages in
1507 * order to, e.g., fix a link in every possible language.
1508 *
1509 * @deprecated since 1.18
1510 *
1511 * @param $key String: lookup key for the message, usually
1512 * defined in languages/Language.php
1513 * @return String
1514 */
1515 function wfMsgForContent( $key ) {
1516 global $wgForceUIMsgAsContentMsg;
1517 $args = func_get_args();
1518 array_shift( $args );
1519 $forcontent = true;
1520 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1521 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1522 {
1523 $forcontent = false;
1524 }
1525 return wfMsgReal( $key, $args, true, $forcontent );
1526 }
1527
1528 /**
1529 * Same as above except doesn't transform the message
1530 *
1531 * @deprecated since 1.18
1532 *
1533 * @param $key String
1534 * @return String
1535 */
1536 function wfMsgForContentNoTrans( $key ) {
1537 global $wgForceUIMsgAsContentMsg;
1538 $args = func_get_args();
1539 array_shift( $args );
1540 $forcontent = true;
1541 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1542 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1543 {
1544 $forcontent = false;
1545 }
1546 return wfMsgReal( $key, $args, true, $forcontent, false );
1547 }
1548
1549 /**
1550 * Really get a message
1551 *
1552 * @deprecated since 1.18
1553 *
1554 * @param $key String: key to get.
1555 * @param $args
1556 * @param $useDB Boolean
1557 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1558 * @param $transform Boolean: Whether or not to transform the message.
1559 * @return String: the requested message.
1560 */
1561 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1562 wfProfileIn( __METHOD__ );
1563 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1564 $message = wfMsgReplaceArgs( $message, $args );
1565 wfProfileOut( __METHOD__ );
1566 return $message;
1567 }
1568
1569 /**
1570 * Fetch a message string value, but don't replace any keys yet.
1571 *
1572 * @deprecated since 1.18
1573 *
1574 * @param $key String
1575 * @param $useDB Bool
1576 * @param $langCode String: Code of the language to get the message for, or
1577 * behaves as a content language switch if it is a boolean.
1578 * @param $transform Boolean: whether to parse magic words, etc.
1579 * @return string
1580 */
1581 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1582 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1583
1584 $cache = MessageCache::singleton();
1585 $message = $cache->get( $key, $useDB, $langCode );
1586 if( $message === false ) {
1587 $message = '&lt;' . htmlspecialchars( $key ) . '&gt;';
1588 } elseif ( $transform ) {
1589 $message = $cache->transform( $message );
1590 }
1591 return $message;
1592 }
1593
1594 /**
1595 * Replace message parameter keys on the given formatted output.
1596 *
1597 * @deprecated since 1.18
1598 *
1599 * @param $message String
1600 * @param $args Array
1601 * @return string
1602 * @private
1603 */
1604 function wfMsgReplaceArgs( $message, $args ) {
1605 # Fix windows line-endings
1606 # Some messages are split with explode("\n", $msg)
1607 $message = str_replace( "\r", '', $message );
1608
1609 // Replace arguments
1610 if ( count( $args ) ) {
1611 if ( is_array( $args[0] ) ) {
1612 $args = array_values( $args[0] );
1613 }
1614 $replacementKeys = array();
1615 foreach( $args as $n => $param ) {
1616 $replacementKeys['$' . ( $n + 1 )] = $param;
1617 }
1618 $message = strtr( $message, $replacementKeys );
1619 }
1620
1621 return $message;
1622 }
1623
1624 /**
1625 * Return an HTML-escaped version of a message.
1626 * Parameter replacements, if any, are done *after* the HTML-escaping,
1627 * so parameters may contain HTML (eg links or form controls). Be sure
1628 * to pre-escape them if you really do want plaintext, or just wrap
1629 * the whole thing in htmlspecialchars().
1630 *
1631 * @deprecated since 1.18
1632 *
1633 * @param $key String
1634 * @param string ... parameters
1635 * @return string
1636 */
1637 function wfMsgHtml( $key ) {
1638 $args = func_get_args();
1639 array_shift( $args );
1640 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1641 }
1642
1643 /**
1644 * Return an HTML version of message
1645 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1646 * so parameters may contain HTML (eg links or form controls). Be sure
1647 * to pre-escape them if you really do want plaintext, or just wrap
1648 * the whole thing in htmlspecialchars().
1649 *
1650 * @deprecated since 1.18
1651 *
1652 * @param $key String
1653 * @param string ... parameters
1654 * @return string
1655 */
1656 function wfMsgWikiHtml( $key ) {
1657 $args = func_get_args();
1658 array_shift( $args );
1659 return wfMsgReplaceArgs(
1660 MessageCache::singleton()->parse( wfMsgGetKey( $key ), null,
1661 /* can't be set to false */ true, /* interface */ true )->getText(),
1662 $args );
1663 }
1664
1665 /**
1666 * Returns message in the requested format
1667 *
1668 * @deprecated since 1.18
1669 *
1670 * @param $key String: key of the message
1671 * @param $options Array: processing rules. Can take the following options:
1672 * <i>parse</i>: parses wikitext to HTML
1673 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1674 * p's added by parser or tidy
1675 * <i>escape</i>: filters message through htmlspecialchars
1676 * <i>escapenoentities</i>: same, but allows entity references like &#160; through
1677 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1678 * <i>parsemag</i>: transform the message using magic phrases
1679 * <i>content</i>: fetch message for content language instead of interface
1680 * Also can accept a single associative argument, of the form 'language' => 'xx':
1681 * <i>language</i>: Language object or language code to fetch message for
1682 * (overriden by <i>content</i>).
1683 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1684 *
1685 * @return String
1686 */
1687 function wfMsgExt( $key, $options ) {
1688 $args = func_get_args();
1689 array_shift( $args );
1690 array_shift( $args );
1691 $options = (array)$options;
1692
1693 foreach( $options as $arrayKey => $option ) {
1694 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1695 # An unknown index, neither numeric nor "language"
1696 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING );
1697 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1698 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1699 'replaceafter', 'parsemag', 'content' ) ) ) {
1700 # A numeric index with unknown value
1701 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING );
1702 }
1703 }
1704
1705 if( in_array( 'content', $options, true ) ) {
1706 $forContent = true;
1707 $langCode = true;
1708 $langCodeObj = null;
1709 } elseif( array_key_exists( 'language', $options ) ) {
1710 $forContent = false;
1711 $langCode = wfGetLangObj( $options['language'] );
1712 $langCodeObj = $langCode;
1713 } else {
1714 $forContent = false;
1715 $langCode = false;
1716 $langCodeObj = null;
1717 }
1718
1719 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1720
1721 if( !in_array( 'replaceafter', $options, true ) ) {
1722 $string = wfMsgReplaceArgs( $string, $args );
1723 }
1724
1725 $messageCache = MessageCache::singleton();
1726 $parseInline = in_array( 'parseinline', $options, true );
1727 if( in_array( 'parse', $options, true ) || $parseInline ) {
1728 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1729 if ( $string instanceof ParserOutput ) {
1730 $string = $string->getText();
1731 }
1732
1733 if ( $parseInline ) {
1734 $m = array();
1735 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1736 $string = $m[1];
1737 }
1738 }
1739 } elseif ( in_array( 'parsemag', $options, true ) ) {
1740 $string = $messageCache->transform( $string,
1741 !$forContent, $langCodeObj );
1742 }
1743
1744 if ( in_array( 'escape', $options, true ) ) {
1745 $string = htmlspecialchars ( $string );
1746 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1747 $string = Sanitizer::escapeHtmlAllowEntities( $string );
1748 }
1749
1750 if( in_array( 'replaceafter', $options, true ) ) {
1751 $string = wfMsgReplaceArgs( $string, $args );
1752 }
1753
1754 return $string;
1755 }
1756
1757 /**
1758 * Since wfMsg() and co suck, they don't return false if the message key they
1759 * looked up didn't exist but a XHTML string, this function checks for the
1760 * nonexistance of messages by checking the MessageCache::get() result directly.
1761 *
1762 * @deprecated since 1.18. Use Message::isDisabled().
1763 *
1764 * @param $key String: the message key looked up
1765 * @return Boolean True if the message *doesn't* exist.
1766 */
1767 function wfEmptyMsg( $key ) {
1768 return MessageCache::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1769 }
1770
1771 /**
1772 * Throw a debugging exception. This function previously once exited the process,
1773 * but now throws an exception instead, with similar results.
1774 *
1775 * @param $msg String: message shown when dying.
1776 */
1777 function wfDebugDieBacktrace( $msg = '' ) {
1778 throw new MWException( $msg );
1779 }
1780
1781 /**
1782 * Fetch server name for use in error reporting etc.
1783 * Use real server name if available, so we know which machine
1784 * in a server farm generated the current page.
1785 *
1786 * @return string
1787 */
1788 function wfHostname() {
1789 static $host;
1790 if ( is_null( $host ) ) {
1791
1792 # Hostname overriding
1793 global $wgOverrideHostname;
1794 if( $wgOverrideHostname !== false ) {
1795 # Set static and skip any detection
1796 $host = $wgOverrideHostname;
1797 return $host;
1798 }
1799
1800 if ( function_exists( 'posix_uname' ) ) {
1801 // This function not present on Windows
1802 $uname = posix_uname();
1803 } else {
1804 $uname = false;
1805 }
1806 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1807 $host = $uname['nodename'];
1808 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1809 # Windows computer name
1810 $host = getenv( 'COMPUTERNAME' );
1811 } else {
1812 # This may be a virtual server.
1813 $host = $_SERVER['SERVER_NAME'];
1814 }
1815 }
1816 return $host;
1817 }
1818
1819 /**
1820 * Returns a HTML comment with the elapsed time since request.
1821 * This method has no side effects.
1822 *
1823 * @return string
1824 */
1825 function wfReportTime() {
1826 global $wgRequestTime, $wgShowHostnames;
1827
1828 $elapsed = microtime( true ) - $wgRequestTime;
1829
1830 return $wgShowHostnames
1831 ? sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1832 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1833 }
1834
1835 /**
1836 * Safety wrapper for debug_backtrace().
1837 *
1838 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1839 * murky circumstances, which may be triggered in part by stub objects
1840 * or other fancy talkin'.
1841 *
1842 * Will return an empty array if Zend Optimizer is detected or if
1843 * debug_backtrace is disabled, otherwise the output from
1844 * debug_backtrace() (trimmed).
1845 *
1846 * @param $limit int This parameter can be used to limit the number of stack frames returned
1847 *
1848 * @return array of backtrace information
1849 */
1850 function wfDebugBacktrace( $limit = 0 ) {
1851 static $disabled = null;
1852
1853 if( extension_loaded( 'Zend Optimizer' ) ) {
1854 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1855 return array();
1856 }
1857
1858 if ( is_null( $disabled ) ) {
1859 $disabled = false;
1860 $functions = explode( ',', ini_get( 'disable_functions' ) );
1861 $functions = array_map( 'trim', $functions );
1862 $functions = array_map( 'strtolower', $functions );
1863 if ( in_array( 'debug_backtrace', $functions ) ) {
1864 wfDebug( "debug_backtrace is in disabled_functions\n" );
1865 $disabled = true;
1866 }
1867 }
1868 if ( $disabled ) {
1869 return array();
1870 }
1871
1872 if ( $limit && version_compare( PHP_VERSION, '5.4.0', '>=' ) ) {
1873 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1874 } else {
1875 return array_slice( debug_backtrace(), 1 );
1876 }
1877 }
1878
1879 /**
1880 * Get a debug backtrace as a string
1881 *
1882 * @return string
1883 */
1884 function wfBacktrace() {
1885 global $wgCommandLineMode;
1886
1887 if ( $wgCommandLineMode ) {
1888 $msg = '';
1889 } else {
1890 $msg = "<ul>\n";
1891 }
1892 $backtrace = wfDebugBacktrace();
1893 foreach( $backtrace as $call ) {
1894 if( isset( $call['file'] ) ) {
1895 $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
1896 $file = $f[count( $f ) - 1];
1897 } else {
1898 $file = '-';
1899 }
1900 if( isset( $call['line'] ) ) {
1901 $line = $call['line'];
1902 } else {
1903 $line = '-';
1904 }
1905 if ( $wgCommandLineMode ) {
1906 $msg .= "$file line $line calls ";
1907 } else {
1908 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1909 }
1910 if( !empty( $call['class'] ) ) {
1911 $msg .= $call['class'] . $call['type'];
1912 }
1913 $msg .= $call['function'] . '()';
1914
1915 if ( $wgCommandLineMode ) {
1916 $msg .= "\n";
1917 } else {
1918 $msg .= "</li>\n";
1919 }
1920 }
1921 if ( $wgCommandLineMode ) {
1922 $msg .= "\n";
1923 } else {
1924 $msg .= "</ul>\n";
1925 }
1926
1927 return $msg;
1928 }
1929
1930 /**
1931 * Get the name of the function which called this function
1932 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1933 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1934 * wfGetCaller( 3 ) is the parent of that.
1935 *
1936 * @param $level Int
1937 * @return Bool|string
1938 */
1939 function wfGetCaller( $level = 2 ) {
1940 $backtrace = wfDebugBacktrace( $level + 1 );
1941 if ( isset( $backtrace[$level] ) ) {
1942 return wfFormatStackFrame( $backtrace[$level] );
1943 } else {
1944 $caller = 'unknown';
1945 }
1946 return $caller;
1947 }
1948
1949 /**
1950 * Return a string consisting of callers in the stack. Useful sometimes
1951 * for profiling specific points.
1952 *
1953 * @param $limit int The maximum depth of the stack frame to return, or false for
1954 * the entire stack.
1955 * @return String
1956 */
1957 function wfGetAllCallers( $limit = 3 ) {
1958 $trace = array_reverse( wfDebugBacktrace() );
1959 if ( !$limit || $limit > count( $trace ) - 1 ) {
1960 $limit = count( $trace ) - 1;
1961 }
1962 $trace = array_slice( $trace, -$limit - 1, $limit );
1963 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1964 }
1965
1966 /**
1967 * Return a string representation of frame
1968 *
1969 * @param $frame Array
1970 * @return Bool
1971 */
1972 function wfFormatStackFrame( $frame ) {
1973 return isset( $frame['class'] ) ?
1974 $frame['class'] . '::' . $frame['function'] :
1975 $frame['function'];
1976 }
1977
1978
1979 /* Some generic result counters, pulled out of SearchEngine */
1980
1981
1982 /**
1983 * @todo document
1984 *
1985 * @param $offset Int
1986 * @param $limit Int
1987 * @return String
1988 */
1989 function wfShowingResults( $offset, $limit ) {
1990 return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1991 }
1992
1993 /**
1994 * Generate (prev x| next x) (20|50|100...) type links for paging
1995 *
1996 * @param $offset String
1997 * @param $limit Integer
1998 * @param $link String
1999 * @param $query String: optional URL query parameter string
2000 * @param $atend Bool: optional param for specified if this is the last page
2001 * @return String
2002 * @deprecated in 1.19; use Language::viewPrevNext() instead
2003 */
2004 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
2005 wfDeprecated( __METHOD__, '1.19' );
2006
2007 global $wgLang;
2008
2009 $query = wfCgiToArray( $query );
2010
2011 if( is_object( $link ) ) {
2012 $title = $link;
2013 } else {
2014 $title = Title::newFromText( $link );
2015 if( is_null( $title ) ) {
2016 return false;
2017 }
2018 }
2019
2020 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
2021 }
2022
2023 /**
2024 * Make a list item, used by various special pages
2025 *
2026 * @param $page String Page link
2027 * @param $details String Text between brackets
2028 * @param $oppositedm Boolean Add the direction mark opposite to your
2029 * language, to display text properly
2030 * @return String
2031 * @deprecated since 1.19; use Language::specialList() instead
2032 */
2033 function wfSpecialList( $page, $details, $oppositedm = true ) {
2034 wfDeprecated( __METHOD__, '1.19' );
2035
2036 global $wgLang;
2037 return $wgLang->specialList( $page, $details, $oppositedm );
2038 }
2039
2040 /**
2041 * @todo document
2042 * @todo FIXME: We may want to blacklist some broken browsers
2043 *
2044 * @param $force Bool
2045 * @return bool Whereas client accept gzip compression
2046 */
2047 function wfClientAcceptsGzip( $force = false ) {
2048 static $result = null;
2049 if ( $result === null || $force ) {
2050 $result = false;
2051 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2052 # @todo FIXME: We may want to blacklist some broken browsers
2053 $m = array();
2054 if( preg_match(
2055 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2056 $_SERVER['HTTP_ACCEPT_ENCODING'],
2057 $m )
2058 )
2059 {
2060 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2061 $result = false;
2062 return $result;
2063 }
2064 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2065 $result = true;
2066 }
2067 }
2068 }
2069 return $result;
2070 }
2071
2072 /**
2073 * Obtain the offset and limit values from the request string;
2074 * used in special pages
2075 *
2076 * @param $deflimit Int default limit if none supplied
2077 * @param $optionname String Name of a user preference to check against
2078 * @return array
2079 *
2080 */
2081 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2082 global $wgRequest;
2083 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2084 }
2085
2086 /**
2087 * Escapes the given text so that it may be output using addWikiText()
2088 * without any linking, formatting, etc. making its way through. This
2089 * is achieved by substituting certain characters with HTML entities.
2090 * As required by the callers, "<nowiki>" is not used.
2091 *
2092 * @param $text String: text to be escaped
2093 * @return String
2094 */
2095 function wfEscapeWikiText( $text ) {
2096 $text = strtr( "\n$text", array(
2097 '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
2098 '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
2099 '{' => '&#123;', '|' => '&#124;', '}' => '&#125;',
2100 "\n#" => "\n&#35;", "\n*" => "\n&#42;",
2101 "\n:" => "\n&#58;", "\n;" => "\n&#59;",
2102 '://' => '&#58;//', 'ISBN ' => 'ISBN&#32;', 'RFC ' => 'RFC&#32;',
2103 ) );
2104 return substr( $text, 1 );
2105 }
2106
2107 /**
2108 * Get the current unix timetstamp with microseconds. Useful for profiling
2109 * @return Float
2110 */
2111 function wfTime() {
2112 return microtime( true );
2113 }
2114
2115 /**
2116 * Sets dest to source and returns the original value of dest
2117 * If source is NULL, it just returns the value, it doesn't set the variable
2118 * If force is true, it will set the value even if source is NULL
2119 *
2120 * @param $dest Mixed
2121 * @param $source Mixed
2122 * @param $force Bool
2123 * @return Mixed
2124 */
2125 function wfSetVar( &$dest, $source, $force = false ) {
2126 $temp = $dest;
2127 if ( !is_null( $source ) || $force ) {
2128 $dest = $source;
2129 }
2130 return $temp;
2131 }
2132
2133 /**
2134 * As for wfSetVar except setting a bit
2135 *
2136 * @param $dest Int
2137 * @param $bit Int
2138 * @param $state Bool
2139 *
2140 * @return bool
2141 */
2142 function wfSetBit( &$dest, $bit, $state = true ) {
2143 $temp = (bool)( $dest & $bit );
2144 if ( !is_null( $state ) ) {
2145 if ( $state ) {
2146 $dest |= $bit;
2147 } else {
2148 $dest &= ~$bit;
2149 }
2150 }
2151 return $temp;
2152 }
2153
2154 /**
2155 * A wrapper around the PHP function var_export().
2156 * Either print it or add it to the regular output ($wgOut).
2157 *
2158 * @param $var mixed A PHP variable to dump.
2159 */
2160 function wfVarDump( $var ) {
2161 global $wgOut;
2162 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2163 if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
2164 print $s;
2165 } else {
2166 $wgOut->addHTML( $s );
2167 }
2168 }
2169
2170 /**
2171 * Provide a simple HTTP error.
2172 *
2173 * @param $code Int|String
2174 * @param $label String
2175 * @param $desc String
2176 */
2177 function wfHttpError( $code, $label, $desc ) {
2178 global $wgOut;
2179 $wgOut->disable();
2180 header( "HTTP/1.0 $code $label" );
2181 header( "Status: $code $label" );
2182 $wgOut->sendCacheControl();
2183
2184 header( 'Content-type: text/html; charset=utf-8' );
2185 print "<!doctype html>" .
2186 '<html><head><title>' .
2187 htmlspecialchars( $label ) .
2188 '</title></head><body><h1>' .
2189 htmlspecialchars( $label ) .
2190 '</h1><p>' .
2191 nl2br( htmlspecialchars( $desc ) ) .
2192 "</p></body></html>\n";
2193 }
2194
2195 /**
2196 * Clear away any user-level output buffers, discarding contents.
2197 *
2198 * Suitable for 'starting afresh', for instance when streaming
2199 * relatively large amounts of data without buffering, or wanting to
2200 * output image files without ob_gzhandler's compression.
2201 *
2202 * The optional $resetGzipEncoding parameter controls suppression of
2203 * the Content-Encoding header sent by ob_gzhandler; by default it
2204 * is left. See comments for wfClearOutputBuffers() for why it would
2205 * be used.
2206 *
2207 * Note that some PHP configuration options may add output buffer
2208 * layers which cannot be removed; these are left in place.
2209 *
2210 * @param $resetGzipEncoding Bool
2211 */
2212 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2213 if( $resetGzipEncoding ) {
2214 // Suppress Content-Encoding and Content-Length
2215 // headers from 1.10+s wfOutputHandler
2216 global $wgDisableOutputCompression;
2217 $wgDisableOutputCompression = true;
2218 }
2219 while( $status = ob_get_status() ) {
2220 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2221 // Probably from zlib.output_compression or other
2222 // PHP-internal setting which can't be removed.
2223 //
2224 // Give up, and hope the result doesn't break
2225 // output behavior.
2226 break;
2227 }
2228 if( !ob_end_clean() ) {
2229 // Could not remove output buffer handler; abort now
2230 // to avoid getting in some kind of infinite loop.
2231 break;
2232 }
2233 if( $resetGzipEncoding ) {
2234 if( $status['name'] == 'ob_gzhandler' ) {
2235 // Reset the 'Content-Encoding' field set by this handler
2236 // so we can start fresh.
2237 header_remove( 'Content-Encoding' );
2238 break;
2239 }
2240 }
2241 }
2242 }
2243
2244 /**
2245 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2246 *
2247 * Clear away output buffers, but keep the Content-Encoding header
2248 * produced by ob_gzhandler, if any.
2249 *
2250 * This should be used for HTTP 304 responses, where you need to
2251 * preserve the Content-Encoding header of the real result, but
2252 * also need to suppress the output of ob_gzhandler to keep to spec
2253 * and avoid breaking Firefox in rare cases where the headers and
2254 * body are broken over two packets.
2255 */
2256 function wfClearOutputBuffers() {
2257 wfResetOutputBuffers( false );
2258 }
2259
2260 /**
2261 * Converts an Accept-* header into an array mapping string values to quality
2262 * factors
2263 *
2264 * @param $accept String
2265 * @param $def String default
2266 * @return Array
2267 */
2268 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2269 # No arg means accept anything (per HTTP spec)
2270 if( !$accept ) {
2271 return array( $def => 1.0 );
2272 }
2273
2274 $prefs = array();
2275
2276 $parts = explode( ',', $accept );
2277
2278 foreach( $parts as $part ) {
2279 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2280 $values = explode( ';', trim( $part ) );
2281 $match = array();
2282 if ( count( $values ) == 1 ) {
2283 $prefs[$values[0]] = 1.0;
2284 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2285 $prefs[$values[0]] = floatval( $match[1] );
2286 }
2287 }
2288
2289 return $prefs;
2290 }
2291
2292 /**
2293 * Checks if a given MIME type matches any of the keys in the given
2294 * array. Basic wildcards are accepted in the array keys.
2295 *
2296 * Returns the matching MIME type (or wildcard) if a match, otherwise
2297 * NULL if no match.
2298 *
2299 * @param $type String
2300 * @param $avail Array
2301 * @return string
2302 * @private
2303 */
2304 function mimeTypeMatch( $type, $avail ) {
2305 if( array_key_exists( $type, $avail ) ) {
2306 return $type;
2307 } else {
2308 $parts = explode( '/', $type );
2309 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2310 return $parts[0] . '/*';
2311 } elseif( array_key_exists( '*/*', $avail ) ) {
2312 return '*/*';
2313 } else {
2314 return null;
2315 }
2316 }
2317 }
2318
2319 /**
2320 * Returns the 'best' match between a client's requested internet media types
2321 * and the server's list of available types. Each list should be an associative
2322 * array of type to preference (preference is a float between 0.0 and 1.0).
2323 * Wildcards in the types are acceptable.
2324 *
2325 * @param $cprefs Array: client's acceptable type list
2326 * @param $sprefs Array: server's offered types
2327 * @return string
2328 *
2329 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2330 * XXX: generalize to negotiate other stuff
2331 */
2332 function wfNegotiateType( $cprefs, $sprefs ) {
2333 $combine = array();
2334
2335 foreach( array_keys( $sprefs ) as $type ) {
2336 $parts = explode( '/', $type );
2337 if( $parts[1] != '*' ) {
2338 $ckey = mimeTypeMatch( $type, $cprefs );
2339 if( $ckey ) {
2340 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2341 }
2342 }
2343 }
2344
2345 foreach( array_keys( $cprefs ) as $type ) {
2346 $parts = explode( '/', $type );
2347 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2348 $skey = mimeTypeMatch( $type, $sprefs );
2349 if( $skey ) {
2350 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2351 }
2352 }
2353 }
2354
2355 $bestq = 0;
2356 $besttype = null;
2357
2358 foreach( array_keys( $combine ) as $type ) {
2359 if( $combine[$type] > $bestq ) {
2360 $besttype = $type;
2361 $bestq = $combine[$type];
2362 }
2363 }
2364
2365 return $besttype;
2366 }
2367
2368 /**
2369 * Reference-counted warning suppression
2370 *
2371 * @param $end Bool
2372 */
2373 function wfSuppressWarnings( $end = false ) {
2374 static $suppressCount = 0;
2375 static $originalLevel = false;
2376
2377 if ( $end ) {
2378 if ( $suppressCount ) {
2379 --$suppressCount;
2380 if ( !$suppressCount ) {
2381 error_reporting( $originalLevel );
2382 }
2383 }
2384 } else {
2385 if ( !$suppressCount ) {
2386 // E_DEPRECATED is undefined in PHP 5.2
2387 if( !defined( 'E_DEPRECATED' ) ) {
2388 define( 'E_DEPRECATED', 8192 );
2389 }
2390 $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED ) );
2391 }
2392 ++$suppressCount;
2393 }
2394 }
2395
2396 /**
2397 * Restore error level to previous value
2398 */
2399 function wfRestoreWarnings() {
2400 wfSuppressWarnings( true );
2401 }
2402
2403 # Autodetect, convert and provide timestamps of various types
2404
2405 /**
2406 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2407 */
2408 define( 'TS_UNIX', 0 );
2409
2410 /**
2411 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2412 */
2413 define( 'TS_MW', 1 );
2414
2415 /**
2416 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2417 */
2418 define( 'TS_DB', 2 );
2419
2420 /**
2421 * RFC 2822 format, for E-mail and HTTP headers
2422 */
2423 define( 'TS_RFC2822', 3 );
2424
2425 /**
2426 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2427 *
2428 * This is used by Special:Export
2429 */
2430 define( 'TS_ISO_8601', 4 );
2431
2432 /**
2433 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2434 *
2435 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2436 * DateTime tag and page 36 for the DateTimeOriginal and
2437 * DateTimeDigitized tags.
2438 */
2439 define( 'TS_EXIF', 5 );
2440
2441 /**
2442 * Oracle format time.
2443 */
2444 define( 'TS_ORACLE', 6 );
2445
2446 /**
2447 * Postgres format time.
2448 */
2449 define( 'TS_POSTGRES', 7 );
2450
2451 /**
2452 * DB2 format time
2453 */
2454 define( 'TS_DB2', 8 );
2455
2456 /**
2457 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2458 */
2459 define( 'TS_ISO_8601_BASIC', 9 );
2460
2461 /**
2462 * Get a timestamp string in one of various formats
2463 *
2464 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2465 * function will autodetect which format is supplied and act
2466 * accordingly.
2467 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2468 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2469 */
2470 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
2471 $uts = 0;
2472 $da = array();
2473 $strtime = '';
2474
2475 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
2476 $uts = time();
2477 $strtime = "@$uts";
2478 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2479 # TS_DB
2480 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2481 # TS_EXIF
2482 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
2483 # TS_MW
2484 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
2485 # TS_UNIX
2486 $uts = $ts;
2487 $strtime = "@$ts"; // http://php.net/manual/en/datetime.formats.compound.php
2488 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
2489 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
2490 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
2491 str_replace( '+00:00', 'UTC', $ts ) );
2492 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2493 # TS_ISO_8601
2494 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2495 #TS_ISO_8601_BASIC
2496 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
2497 # TS_POSTGRES
2498 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
2499 # TS_POSTGRES
2500 } elseif (preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/', $ts, $da ) ) {
2501 # TS_DB2
2502 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
2503 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
2504 '[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d/S', $ts ) ) { # hh:mm:ss
2505 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
2506 # The regex is a superset of rfc2822 for readability
2507 $strtime = strtok( $ts, ';' );
2508 } elseif ( preg_match( '/^[A-Z][a-z]{5,8}, \d\d-[A-Z][a-z]{2}-\d{2} \d\d:\d\d:\d\d/', $ts ) ) {
2509 # TS_RFC850
2510 $strtime = $ts;
2511 } elseif ( preg_match( '/^[A-Z][a-z]{2} [A-Z][a-z]{2} +\d{1,2} \d\d:\d\d:\d\d \d{4}/', $ts ) ) {
2512 # asctime
2513 $strtime = $ts;
2514 } else {
2515 # Bogus value...
2516 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2517
2518 return false;
2519 }
2520
2521 static $formats = array(
2522 TS_UNIX => 'U',
2523 TS_MW => 'YmdHis',
2524 TS_DB => 'Y-m-d H:i:s',
2525 TS_ISO_8601 => 'Y-m-d\TH:i:s\Z',
2526 TS_ISO_8601_BASIC => 'Ymd\THis\Z',
2527 TS_EXIF => 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
2528 TS_RFC2822 => 'D, d M Y H:i:s',
2529 TS_ORACLE => 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
2530 TS_POSTGRES => 'Y-m-d H:i:s',
2531 TS_DB2 => 'Y-m-d H:i:s',
2532 );
2533
2534 if ( !isset( $formats[$outputtype] ) ) {
2535 throw new MWException( 'wfTimestamp() called with illegal output type.' );
2536 }
2537
2538 if ( function_exists( "date_create" ) ) {
2539 if ( count( $da ) ) {
2540 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
2541 (int)$da[1], (int)$da[2], (int)$da[3],
2542 (int)$da[4], (int)$da[5], (int)$da[6]);
2543
2544 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
2545 } elseif ( $strtime ) {
2546 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
2547 } else {
2548 return false;
2549 }
2550
2551 if ( !$d ) {
2552 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
2553 return false;
2554 }
2555
2556 $output = $d->format( $formats[$outputtype] );
2557 } else {
2558 if ( count( $da ) ) {
2559 // Warning! gmmktime() acts oddly if the month or day is set to 0
2560 // We may want to handle that explicitly at some point
2561 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
2562 (int)$da[2], (int)$da[3], (int)$da[1] );
2563 } elseif ( $strtime ) {
2564 $uts = strtotime( $strtime );
2565 }
2566
2567 if ( $uts === false ) {
2568 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
2569 return false;
2570 }
2571
2572 if ( TS_UNIX == $outputtype ) {
2573 return $uts;
2574 }
2575 $output = gmdate( $formats[$outputtype], $uts );
2576 }
2577
2578 if ( ( $outputtype == TS_RFC2822 ) || ( $outputtype == TS_POSTGRES ) ) {
2579 $output .= ' GMT';
2580 }
2581
2582 return $output;
2583 }
2584
2585 /**
2586 * Return a formatted timestamp, or null if input is null.
2587 * For dealing with nullable timestamp columns in the database.
2588 *
2589 * @param $outputtype Integer
2590 * @param $ts String
2591 * @return String
2592 */
2593 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
2594 if( is_null( $ts ) ) {
2595 return null;
2596 } else {
2597 return wfTimestamp( $outputtype, $ts );
2598 }
2599 }
2600
2601 /**
2602 * Convenience function; returns MediaWiki timestamp for the present time.
2603 *
2604 * @return string
2605 */
2606 function wfTimestampNow() {
2607 # return NOW
2608 return wfTimestamp( TS_MW, time() );
2609 }
2610
2611 /**
2612 * Check if the operating system is Windows
2613 *
2614 * @return Bool: true if it's Windows, False otherwise.
2615 */
2616 function wfIsWindows() {
2617 static $isWindows = null;
2618 if ( $isWindows === null ) {
2619 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2620 }
2621 return $isWindows;
2622 }
2623
2624 /**
2625 * Check if we are running under HipHop
2626 *
2627 * @return Bool
2628 */
2629 function wfIsHipHop() {
2630 return function_exists( 'hphp_thread_set_warmup_enabled' );
2631 }
2632
2633 /**
2634 * Swap two variables
2635 *
2636 * @param $x Mixed
2637 * @param $y Mixed
2638 */
2639 function swap( &$x, &$y ) {
2640 $z = $x;
2641 $x = $y;
2642 $y = $z;
2643 }
2644
2645 /**
2646 * Tries to get the system directory for temporary files. First
2647 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2648 * environment variables are then checked in sequence, and if none are
2649 * set try sys_get_temp_dir().
2650 *
2651 * NOTE: When possible, use instead the tmpfile() function to create
2652 * temporary files to avoid race conditions on file creation, etc.
2653 *
2654 * @return String
2655 */
2656 function wfTempDir() {
2657 global $wgTmpDirectory;
2658
2659 if ( $wgTmpDirectory !== false ) {
2660 return $wgTmpDirectory;
2661 }
2662
2663 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2664
2665 foreach( $tmpDir as $tmp ) {
2666 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2667 return $tmp;
2668 }
2669 }
2670 return sys_get_temp_dir();
2671 }
2672
2673 /**
2674 * Make directory, and make all parent directories if they don't exist
2675 *
2676 * @param $dir String: full path to directory to create
2677 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2678 * @param $caller String: optional caller param for debugging.
2679 * @return bool
2680 */
2681 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2682 global $wgDirectoryMode;
2683
2684 if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2685 throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2686 }
2687
2688 if ( !is_null( $caller ) ) {
2689 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2690 }
2691
2692 if( strval( $dir ) === '' || file_exists( $dir ) ) {
2693 return true;
2694 }
2695
2696 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $dir );
2697
2698 if ( is_null( $mode ) ) {
2699 $mode = $wgDirectoryMode;
2700 }
2701
2702 // Turn off the normal warning, we're doing our own below
2703 wfSuppressWarnings();
2704 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2705 wfRestoreWarnings();
2706
2707 if( !$ok ) {
2708 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2709 trigger_error( sprintf( "%s: failed to mkdir \"%s\" mode 0%o", __FUNCTION__, $dir, $mode ),
2710 E_USER_WARNING );
2711 }
2712 return $ok;
2713 }
2714
2715 /**
2716 * Remove a directory and all its content.
2717 * Does not hide error.
2718 */
2719 function wfRecursiveRemoveDir( $dir ) {
2720 wfDebug( __FUNCTION__ . "( $dir )\n" );
2721 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2722 if ( is_dir( $dir ) ) {
2723 $objects = scandir( $dir );
2724 foreach ( $objects as $object ) {
2725 if ( $object != "." && $object != ".." ) {
2726 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2727 wfRecursiveRemoveDir( $dir . '/' . $object );
2728 } else {
2729 unlink( $dir . '/' . $object );
2730 }
2731 }
2732 }
2733 reset( $objects );
2734 rmdir( $dir );
2735 }
2736 }
2737
2738 /**
2739 * @param $nr Mixed: the number to format
2740 * @param $acc Integer: the number of digits after the decimal point, default 2
2741 * @param $round Boolean: whether or not to round the value, default true
2742 * @return float
2743 */
2744 function wfPercent( $nr, $acc = 2, $round = true ) {
2745 $ret = sprintf( "%.${acc}f", $nr );
2746 return $round ? round( $ret, $acc ) . '%' : "$ret%";
2747 }
2748
2749 /**
2750 * Find out whether or not a mixed variable exists in a string
2751 *
2752 * @param $needle String
2753 * @param $str String
2754 * @param $insensitive Boolean
2755 * @return Boolean
2756 */
2757 function in_string( $needle, $str, $insensitive = false ) {
2758 $func = 'strpos';
2759 if( $insensitive ) $func = 'stripos';
2760
2761 return $func( $str, $needle ) !== false;
2762 }
2763
2764 /**
2765 * Safety wrapper around ini_get() for boolean settings.
2766 * The values returned from ini_get() are pre-normalized for settings
2767 * set via php.ini or php_flag/php_admin_flag... but *not*
2768 * for those set via php_value/php_admin_value.
2769 *
2770 * It's fairly common for people to use php_value instead of php_flag,
2771 * which can leave you with an 'off' setting giving a false positive
2772 * for code that just takes the ini_get() return value as a boolean.
2773 *
2774 * To make things extra interesting, setting via php_value accepts
2775 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2776 * Unrecognized values go false... again opposite PHP's own coercion
2777 * from string to bool.
2778 *
2779 * Luckily, 'properly' set settings will always come back as '0' or '1',
2780 * so we only have to worry about them and the 'improper' settings.
2781 *
2782 * I frickin' hate PHP... :P
2783 *
2784 * @param $setting String
2785 * @return Bool
2786 */
2787 function wfIniGetBool( $setting ) {
2788 $val = ini_get( $setting );
2789 // 'on' and 'true' can't have whitespace around them, but '1' can.
2790 return strtolower( $val ) == 'on'
2791 || strtolower( $val ) == 'true'
2792 || strtolower( $val ) == 'yes'
2793 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2794 }
2795
2796 /**
2797 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2798 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2799 *
2800 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2801 * should be omitted
2802 * @param $fileName String Name of the library, if not $extension.suffix
2803 * @return Bool - Whether or not the extension is loaded
2804 */
2805 function wfDl( $extension, $fileName = null ) {
2806 if( extension_loaded( $extension ) ) {
2807 return true;
2808 }
2809
2810 $canDl = false;
2811 $sapi = php_sapi_name();
2812 if( $sapi == 'cli' || $sapi == 'cgi' || $sapi == 'embed' ) {
2813 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2814 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2815 }
2816
2817 if( $canDl ) {
2818 $fileName = $fileName ? $fileName : $extension;
2819 if( wfIsWindows() ) {
2820 $fileName = 'php_' . $fileName;
2821 }
2822 wfSuppressWarnings();
2823 dl( $fileName . '.' . PHP_SHLIB_SUFFIX );
2824 wfRestoreWarnings();
2825 }
2826 return extension_loaded( $extension );
2827 }
2828
2829 /**
2830 * Windows-compatible version of escapeshellarg()
2831 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2832 * function puts single quotes in regardless of OS.
2833 *
2834 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2835 * earlier distro releases of PHP)
2836 *
2837 * @param varargs
2838 * @return String
2839 */
2840 function wfEscapeShellArg( ) {
2841 wfInitShellLocale();
2842
2843 $args = func_get_args();
2844 $first = true;
2845 $retVal = '';
2846 foreach ( $args as $arg ) {
2847 if ( !$first ) {
2848 $retVal .= ' ';
2849 } else {
2850 $first = false;
2851 }
2852
2853 if ( wfIsWindows() ) {
2854 // Escaping for an MSVC-style command line parser and CMD.EXE
2855 // Refs:
2856 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2857 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2858 // * Bug #13518
2859 // * CR r63214
2860 // Double the backslashes before any double quotes. Escape the double quotes.
2861 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
2862 $arg = '';
2863 $iteration = 0;
2864 foreach ( $tokens as $token ) {
2865 if ( $iteration % 2 == 1 ) {
2866 // Delimiter, a double quote preceded by zero or more slashes
2867 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2868 } elseif ( $iteration % 4 == 2 ) {
2869 // ^ in $token will be outside quotes, need to be escaped
2870 $arg .= str_replace( '^', '^^', $token );
2871 } else { // $iteration % 4 == 0
2872 // ^ in $token will appear inside double quotes, so leave as is
2873 $arg .= $token;
2874 }
2875 $iteration++;
2876 }
2877 // Double the backslashes before the end of the string, because
2878 // we will soon add a quote
2879 $m = array();
2880 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2881 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2882 }
2883
2884 // Add surrounding quotes
2885 $retVal .= '"' . $arg . '"';
2886 } else {
2887 $retVal .= escapeshellarg( $arg );
2888 }
2889 }
2890 return $retVal;
2891 }
2892
2893 /**
2894 * Execute a shell command, with time and memory limits mirrored from the PHP
2895 * configuration if supported.
2896 * @param $cmd String Command line, properly escaped for shell.
2897 * @param &$retval null|Mixed optional, will receive the program's exit code.
2898 * (non-zero is usually failure)
2899 * @param $environ Array optional environment variables which should be
2900 * added to the executed command environment.
2901 * @param $limits Array optional array with limits(filesize, memory, time)
2902 * this overwrites the global wgShellMax* limits.
2903 * @return string collected stdout as a string (trailing newlines stripped)
2904 */
2905 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2906 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2907
2908 static $disabled;
2909 if ( is_null( $disabled ) ) {
2910 $disabled = false;
2911 if( wfIniGetBool( 'safe_mode' ) ) {
2912 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2913 $disabled = 'safemode';
2914 } else {
2915 $functions = explode( ',', ini_get( 'disable_functions' ) );
2916 $functions = array_map( 'trim', $functions );
2917 $functions = array_map( 'strtolower', $functions );
2918 if ( in_array( 'passthru', $functions ) ) {
2919 wfDebug( "passthru is in disabled_functions\n" );
2920 $disabled = 'passthru';
2921 }
2922 }
2923 }
2924 if ( $disabled ) {
2925 $retval = 1;
2926 return $disabled == 'safemode' ?
2927 'Unable to run external programs in safe mode.' :
2928 'Unable to run external programs, passthru() is disabled.';
2929 }
2930
2931 wfInitShellLocale();
2932
2933 $envcmd = '';
2934 foreach( $environ as $k => $v ) {
2935 if ( wfIsWindows() ) {
2936 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2937 * appear in the environment variable, so we must use carat escaping as documented in
2938 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2939 * Note however that the quote isn't listed there, but is needed, and the parentheses
2940 * are listed there but doesn't appear to need it.
2941 */
2942 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2943 } else {
2944 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2945 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2946 */
2947 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2948 }
2949 }
2950 $cmd = $envcmd . $cmd;
2951
2952 if ( php_uname( 's' ) == 'Linux' ) {
2953 $time = intval ( isset($limits['time']) ? $limits['time'] : $wgMaxShellTime );
2954 $mem = intval ( isset($limits['memory']) ? $limits['memory'] : $wgMaxShellMemory );
2955 $filesize = intval ( isset($limits['filesize']) ? $limits['filesize'] : $wgMaxShellFileSize );
2956
2957 if ( $time > 0 && $mem > 0 ) {
2958 $script = "$IP/bin/ulimit4.sh";
2959 if ( is_executable( $script ) ) {
2960 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2961 }
2962 }
2963 }
2964 wfDebug( "wfShellExec: $cmd\n" );
2965
2966 $retval = 1; // error by default?
2967 ob_start();
2968 passthru( $cmd, $retval );
2969 $output = ob_get_contents();
2970 ob_end_clean();
2971
2972 if ( $retval == 127 ) {
2973 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2974 }
2975 return $output;
2976 }
2977
2978 /**
2979 * Workaround for http://bugs.php.net/bug.php?id=45132
2980 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2981 */
2982 function wfInitShellLocale() {
2983 static $done = false;
2984 if ( $done ) {
2985 return;
2986 }
2987 $done = true;
2988 global $wgShellLocale;
2989 if ( !wfIniGetBool( 'safe_mode' ) ) {
2990 putenv( "LC_CTYPE=$wgShellLocale" );
2991 setlocale( LC_CTYPE, $wgShellLocale );
2992 }
2993 }
2994
2995 /**
2996 * Alias to wfShellWikiCmd()
2997 * @see wfShellWikiCmd()
2998 */
2999 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
3000 return wfShellWikiCmd( $script, $parameters, $options );
3001 }
3002
3003 /**
3004 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3005 * Note that $parameters should be a flat array and an option with an argument
3006 * should consist of two consecutive items in the array (do not use "--option value").
3007 * @param $script string MediaWiki cli script path
3008 * @param $parameters Array Arguments and options to the script
3009 * @param $options Array Associative array of options:
3010 * 'php': The path to the php executable
3011 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3012 * @return Array
3013 */
3014 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3015 global $wgPhpCli;
3016 // Give site config file a chance to run the script in a wrapper.
3017 // The caller may likely want to call wfBasename() on $script.
3018 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3019 $cmd = isset( $options['php'] ) ? array( $options['php'] ) : array( $wgPhpCli );
3020 if ( isset( $options['wrapper'] ) ) {
3021 $cmd[] = $options['wrapper'];
3022 }
3023 $cmd[] = $script;
3024 // Escape each parameter for shell
3025 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
3026 }
3027
3028 /**
3029 * wfMerge attempts to merge differences between three texts.
3030 * Returns true for a clean merge and false for failure or a conflict.
3031 *
3032 * @param $old String
3033 * @param $mine String
3034 * @param $yours String
3035 * @param $result String
3036 * @return Bool
3037 */
3038 function wfMerge( $old, $mine, $yours, &$result ) {
3039 global $wgDiff3;
3040
3041 # This check may also protect against code injection in
3042 # case of broken installations.
3043 wfSuppressWarnings();
3044 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3045 wfRestoreWarnings();
3046
3047 if( !$haveDiff3 ) {
3048 wfDebug( "diff3 not found\n" );
3049 return false;
3050 }
3051
3052 # Make temporary files
3053 $td = wfTempDir();
3054 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3055 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3056 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3057
3058 fwrite( $oldtextFile, $old );
3059 fclose( $oldtextFile );
3060 fwrite( $mytextFile, $mine );
3061 fclose( $mytextFile );
3062 fwrite( $yourtextFile, $yours );
3063 fclose( $yourtextFile );
3064
3065 # Check for a conflict
3066 $cmd = $wgDiff3 . ' -a --overlap-only ' .
3067 wfEscapeShellArg( $mytextName ) . ' ' .
3068 wfEscapeShellArg( $oldtextName ) . ' ' .
3069 wfEscapeShellArg( $yourtextName );
3070 $handle = popen( $cmd, 'r' );
3071
3072 if( fgets( $handle, 1024 ) ) {
3073 $conflict = true;
3074 } else {
3075 $conflict = false;
3076 }
3077 pclose( $handle );
3078
3079 # Merge differences
3080 $cmd = $wgDiff3 . ' -a -e --merge ' .
3081 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3082 $handle = popen( $cmd, 'r' );
3083 $result = '';
3084 do {
3085 $data = fread( $handle, 8192 );
3086 if ( strlen( $data ) == 0 ) {
3087 break;
3088 }
3089 $result .= $data;
3090 } while ( true );
3091 pclose( $handle );
3092 unlink( $mytextName );
3093 unlink( $oldtextName );
3094 unlink( $yourtextName );
3095
3096 if ( $result === '' && $old !== '' && !$conflict ) {
3097 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3098 $conflict = true;
3099 }
3100 return !$conflict;
3101 }
3102
3103 /**
3104 * Returns unified plain-text diff of two texts.
3105 * Useful for machine processing of diffs.
3106 *
3107 * @param $before String: the text before the changes.
3108 * @param $after String: the text after the changes.
3109 * @param $params String: command-line options for the diff command.
3110 * @return String: unified diff of $before and $after
3111 */
3112 function wfDiff( $before, $after, $params = '-u' ) {
3113 if ( $before == $after ) {
3114 return '';
3115 }
3116
3117 global $wgDiff;
3118 wfSuppressWarnings();
3119 $haveDiff = $wgDiff && file_exists( $wgDiff );
3120 wfRestoreWarnings();
3121
3122 # This check may also protect against code injection in
3123 # case of broken installations.
3124 if( !$haveDiff ) {
3125 wfDebug( "diff executable not found\n" );
3126 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3127 $format = new UnifiedDiffFormatter();
3128 return $format->format( $diffs );
3129 }
3130
3131 # Make temporary files
3132 $td = wfTempDir();
3133 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3134 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3135
3136 fwrite( $oldtextFile, $before );
3137 fclose( $oldtextFile );
3138 fwrite( $newtextFile, $after );
3139 fclose( $newtextFile );
3140
3141 // Get the diff of the two files
3142 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3143
3144 $h = popen( $cmd, 'r' );
3145
3146 $diff = '';
3147
3148 do {
3149 $data = fread( $h, 8192 );
3150 if ( strlen( $data ) == 0 ) {
3151 break;
3152 }
3153 $diff .= $data;
3154 } while ( true );
3155
3156 // Clean up
3157 pclose( $h );
3158 unlink( $oldtextName );
3159 unlink( $newtextName );
3160
3161 // Kill the --- and +++ lines. They're not useful.
3162 $diff_lines = explode( "\n", $diff );
3163 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3164 unset( $diff_lines[0] );
3165 }
3166 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3167 unset( $diff_lines[1] );
3168 }
3169
3170 $diff = implode( "\n", $diff_lines );
3171
3172 return $diff;
3173 }
3174
3175 /**
3176 * This function works like "use VERSION" in Perl, the program will die with a
3177 * backtrace if the current version of PHP is less than the version provided
3178 *
3179 * This is useful for extensions which due to their nature are not kept in sync
3180 * with releases, and might depend on other versions of PHP than the main code
3181 *
3182 * Note: PHP might die due to parsing errors in some cases before it ever
3183 * manages to call this function, such is life
3184 *
3185 * @see perldoc -f use
3186 *
3187 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3188 * a float
3189 */
3190 function wfUsePHP( $req_ver ) {
3191 $php_ver = PHP_VERSION;
3192
3193 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3194 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3195 }
3196 }
3197
3198 /**
3199 * This function works like "use VERSION" in Perl except it checks the version
3200 * of MediaWiki, the program will die with a backtrace if the current version
3201 * of MediaWiki is less than the version provided.
3202 *
3203 * This is useful for extensions which due to their nature are not kept in sync
3204 * with releases
3205 *
3206 * @see perldoc -f use
3207 *
3208 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3209 * a float
3210 */
3211 function wfUseMW( $req_ver ) {
3212 global $wgVersion;
3213
3214 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3215 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3216 }
3217 }
3218
3219 /**
3220 * Return the final portion of a pathname.
3221 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3222 * http://bugs.php.net/bug.php?id=33898
3223 *
3224 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3225 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3226 *
3227 * @param $path String
3228 * @param $suffix String: to remove if present
3229 * @return String
3230 */
3231 function wfBaseName( $path, $suffix = '' ) {
3232 $encSuffix = ( $suffix == '' )
3233 ? ''
3234 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3235 $matches = array();
3236 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3237 return $matches[1];
3238 } else {
3239 return '';
3240 }
3241 }
3242
3243 /**
3244 * Generate a relative path name to the given file.
3245 * May explode on non-matching case-insensitive paths,
3246 * funky symlinks, etc.
3247 *
3248 * @param $path String: absolute destination path including target filename
3249 * @param $from String: Absolute source path, directory only
3250 * @return String
3251 */
3252 function wfRelativePath( $path, $from ) {
3253 // Normalize mixed input on Windows...
3254 $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
3255 $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
3256
3257 // Trim trailing slashes -- fix for drive root
3258 $path = rtrim( $path, DIRECTORY_SEPARATOR );
3259 $from = rtrim( $from, DIRECTORY_SEPARATOR );
3260
3261 $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
3262 $against = explode( DIRECTORY_SEPARATOR, $from );
3263
3264 if( $pieces[0] !== $against[0] ) {
3265 // Non-matching Windows drive letters?
3266 // Return a full path.
3267 return $path;
3268 }
3269
3270 // Trim off common prefix
3271 while( count( $pieces ) && count( $against )
3272 && $pieces[0] == $against[0] ) {
3273 array_shift( $pieces );
3274 array_shift( $against );
3275 }
3276
3277 // relative dots to bump us to the parent
3278 while( count( $against ) ) {
3279 array_unshift( $pieces, '..' );
3280 array_shift( $against );
3281 }
3282
3283 array_push( $pieces, wfBaseName( $path ) );
3284
3285 return implode( DIRECTORY_SEPARATOR, $pieces );
3286 }
3287
3288 /**
3289 * Do any deferred updates and clear the list
3290 *
3291 * @deprecated since 1.19
3292 * @see DeferredUpdates::doUpdate()
3293 * @param $commit string
3294 */
3295 function wfDoUpdates( $commit = '' ) {
3296 wfDeprecated( __METHOD__, '1.19' );
3297 DeferredUpdates::doUpdates( $commit );
3298 }
3299
3300 /**
3301 * Convert an arbitrarily-long digit string from one numeric base
3302 * to another, optionally zero-padding to a minimum column width.
3303 *
3304 * Supports base 2 through 36; digit values 10-36 are represented
3305 * as lowercase letters a-z. Input is case-insensitive.
3306 *
3307 * @param $input String: of digits
3308 * @param $sourceBase Integer: 2-36
3309 * @param $destBase Integer: 2-36
3310 * @param $pad Integer: 1 or greater
3311 * @param $lowercase Boolean
3312 * @return String or false on invalid input
3313 */
3314 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
3315 $input = strval( $input );
3316 if( $sourceBase < 2 ||
3317 $sourceBase > 36 ||
3318 $destBase < 2 ||
3319 $destBase > 36 ||
3320 $pad < 1 ||
3321 $sourceBase != intval( $sourceBase ) ||
3322 $destBase != intval( $destBase ) ||
3323 $pad != intval( $pad ) ||
3324 !is_string( $input ) ||
3325 $input == '' ) {
3326 return false;
3327 }
3328 $digitChars = ( $lowercase ) ? '0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3329 $inDigits = array();
3330 $outChars = '';
3331
3332 // Decode and validate input string
3333 $input = strtolower( $input );
3334 for( $i = 0; $i < strlen( $input ); $i++ ) {
3335 $n = strpos( $digitChars, $input[$i] );
3336 if( $n === false || $n > $sourceBase ) {
3337 return false;
3338 }
3339 $inDigits[] = $n;
3340 }
3341
3342 // Iterate over the input, modulo-ing out an output digit
3343 // at a time until input is gone.
3344 while( count( $inDigits ) ) {
3345 $work = 0;
3346 $workDigits = array();
3347
3348 // Long division...
3349 foreach( $inDigits as $digit ) {
3350 $work *= $sourceBase;
3351 $work += $digit;
3352
3353 if( $work < $destBase ) {
3354 // Gonna need to pull another digit.
3355 if( count( $workDigits ) ) {
3356 // Avoid zero-padding; this lets us find
3357 // the end of the input very easily when
3358 // length drops to zero.
3359 $workDigits[] = 0;
3360 }
3361 } else {
3362 // Finally! Actual division!
3363 $workDigits[] = intval( $work / $destBase );
3364
3365 // Isn't it annoying that most programming languages
3366 // don't have a single divide-and-remainder operator,
3367 // even though the CPU implements it that way?
3368 $work = $work % $destBase;
3369 }
3370 }
3371
3372 // All that division leaves us with a remainder,
3373 // which is conveniently our next output digit.
3374 $outChars .= $digitChars[$work];
3375
3376 // And we continue!
3377 $inDigits = $workDigits;
3378 }
3379
3380 while( strlen( $outChars ) < $pad ) {
3381 $outChars .= '0';
3382 }
3383
3384 return strrev( $outChars );
3385 }
3386
3387 /**
3388 * Create an object with a given name and an array of construct parameters
3389 *
3390 * @param $name String
3391 * @param $p Array: parameters
3392 * @return object
3393 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3394 */
3395 function wfCreateObject( $name, $p ) {
3396 wfDeprecated( __FUNCTION__, '1.18' );
3397 return MWFunction::newObj( $name, $p );
3398 }
3399
3400 /**
3401 * @return bool
3402 */
3403 function wfHttpOnlySafe() {
3404 global $wgHttpOnlyBlacklist;
3405
3406 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3407 foreach( $wgHttpOnlyBlacklist as $regex ) {
3408 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3409 return false;
3410 }
3411 }
3412 }
3413
3414 return true;
3415 }
3416
3417 /**
3418 * Override session_id before session startup if php's built-in
3419 * session generation code is not secure.
3420 */
3421 function wfFixSessionID() {
3422 // If the cookie or session id is already set we already have a session and should abort
3423 if ( isset( $_COOKIE[ session_name() ] ) || session_id() ) {
3424 return;
3425 }
3426
3427 // PHP's built-in session entropy is enabled if:
3428 // - entropy_file is set or you're on Windows with php 5.3.3+
3429 // - AND entropy_length is > 0
3430 // We treat it as disabled if it doesn't have an entropy length of at least 32
3431 $entropyEnabled = (
3432 ( wfIsWindows() && version_compare( PHP_VERSION, '5.3.3', '>=' ) )
3433 || ini_get( 'session.entropy_file' )
3434 )
3435 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3436
3437 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3438 if ( !$entropyEnabled ) {
3439 wfDebug( __METHOD__ . ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3440 session_id( MWCryptRand::generateHex( 32 ) );
3441 }
3442 }
3443
3444 /**
3445 * Initialise php session
3446 *
3447 * @param $sessionId Bool
3448 */
3449 function wfSetupSession( $sessionId = false ) {
3450 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3451 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3452 if( $wgSessionsInObjectCache || $wgSessionsInMemcached ) {
3453 ObjectCacheSessionHandler::install();
3454 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3455 # Only set this if $wgSessionHandler isn't null and session.save_handler
3456 # hasn't already been set to the desired value (that causes errors)
3457 ini_set( 'session.save_handler', $wgSessionHandler );
3458 }
3459 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3460 wfDebugLog( 'cookie',
3461 'session_set_cookie_params: "' . implode( '", "',
3462 array(
3463 0,
3464 $wgCookiePath,
3465 $wgCookieDomain,
3466 $wgCookieSecure,
3467 $httpOnlySafe ) ) . '"' );
3468 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3469 session_cache_limiter( 'private, must-revalidate' );
3470 if ( $sessionId ) {
3471 session_id( $sessionId );
3472 } else {
3473 wfFixSessionID();
3474 }
3475 wfSuppressWarnings();
3476 session_start();
3477 wfRestoreWarnings();
3478 }
3479
3480 /**
3481 * Get an object from the precompiled serialized directory
3482 *
3483 * @param $name String
3484 * @return Mixed: the variable on success, false on failure
3485 */
3486 function wfGetPrecompiledData( $name ) {
3487 global $IP;
3488
3489 $file = "$IP/serialized/$name";
3490 if ( file_exists( $file ) ) {
3491 $blob = file_get_contents( $file );
3492 if ( $blob ) {
3493 return unserialize( $blob );
3494 }
3495 }
3496 return false;
3497 }
3498
3499 /**
3500 * Get a cache key
3501 *
3502 * @param varargs
3503 * @return String
3504 */
3505 function wfMemcKey( /*... */ ) {
3506 global $wgCachePrefix;
3507 $prefix = $wgCachePrefix === false ? wfWikiID() : $wgCachePrefix;
3508 $args = func_get_args();
3509 $key = $prefix . ':' . implode( ':', $args );
3510 $key = str_replace( ' ', '_', $key );
3511 return $key;
3512 }
3513
3514 /**
3515 * Get a cache key for a foreign DB
3516 *
3517 * @param $db String
3518 * @param $prefix String
3519 * @param varargs String
3520 * @return String
3521 */
3522 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3523 $args = array_slice( func_get_args(), 2 );
3524 if ( $prefix ) {
3525 $key = "$db-$prefix:" . implode( ':', $args );
3526 } else {
3527 $key = $db . ':' . implode( ':', $args );
3528 }
3529 return $key;
3530 }
3531
3532 /**
3533 * Get an ASCII string identifying this wiki
3534 * This is used as a prefix in memcached keys
3535 *
3536 * @return String
3537 */
3538 function wfWikiID() {
3539 global $wgDBprefix, $wgDBname;
3540 if ( $wgDBprefix ) {
3541 return "$wgDBname-$wgDBprefix";
3542 } else {
3543 return $wgDBname;
3544 }
3545 }
3546
3547 /**
3548 * Split a wiki ID into DB name and table prefix
3549 *
3550 * @param $wiki String
3551 *
3552 * @return array
3553 */
3554 function wfSplitWikiID( $wiki ) {
3555 $bits = explode( '-', $wiki, 2 );
3556 if ( count( $bits ) < 2 ) {
3557 $bits[] = '';
3558 }
3559 return $bits;
3560 }
3561
3562 /**
3563 * Get a Database object.
3564 *
3565 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3566 * master (for write queries), DB_SLAVE for potentially lagged read
3567 * queries, or an integer >= 0 for a particular server.
3568 *
3569 * @param $groups Mixed: query groups. An array of group names that this query
3570 * belongs to. May contain a single string if the query is only
3571 * in one group.
3572 *
3573 * @param $wiki String: the wiki ID, or false for the current wiki
3574 *
3575 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3576 * will always return the same object, unless the underlying connection or load
3577 * balancer is manually destroyed.
3578 *
3579 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3580 * updater to ensure that a proper database is being updated.
3581 *
3582 * @return DatabaseBase
3583 */
3584 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3585 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3586 }
3587
3588 /**
3589 * Get a load balancer object.
3590 *
3591 * @param $wiki String: wiki ID, or false for the current wiki
3592 * @return LoadBalancer
3593 */
3594 function wfGetLB( $wiki = false ) {
3595 return wfGetLBFactory()->getMainLB( $wiki );
3596 }
3597
3598 /**
3599 * Get the load balancer factory object
3600 *
3601 * @return LBFactory
3602 */
3603 function &wfGetLBFactory() {
3604 return LBFactory::singleton();
3605 }
3606
3607 /**
3608 * Find a file.
3609 * Shortcut for RepoGroup::singleton()->findFile()
3610 *
3611 * @param $title String or Title object
3612 * @param $options array Associative array of options:
3613 * time: requested time for an archived image, or false for the
3614 * current version. An image object will be returned which was
3615 * created at the specified time.
3616 *
3617 * ignoreRedirect: If true, do not follow file redirects
3618 *
3619 * private: If true, return restricted (deleted) files if the current
3620 * user is allowed to view them. Otherwise, such files will not
3621 * be found.
3622 *
3623 * bypassCache: If true, do not use the process-local cache of File objects
3624 *
3625 * @return File, or false if the file does not exist
3626 */
3627 function wfFindFile( $title, $options = array() ) {
3628 return RepoGroup::singleton()->findFile( $title, $options );
3629 }
3630
3631 /**
3632 * Get an object referring to a locally registered file.
3633 * Returns a valid placeholder object if the file does not exist.
3634 *
3635 * @param $title Title|String
3636 * @return LocalFile|null A File, or null if passed an invalid Title
3637 */
3638 function wfLocalFile( $title ) {
3639 return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
3640 }
3641
3642 /**
3643 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3644 * @deprecated since 1.19
3645 */
3646 function wfStreamFile( $fname, $headers = array() ) {
3647 wfDeprecated( __FUNCTION__, '1.19' );
3648 StreamFile::stream( $fname, $headers );
3649 }
3650
3651 /**
3652 * Should low-performance queries be disabled?
3653 *
3654 * @return Boolean
3655 * @codeCoverageIgnore
3656 */
3657 function wfQueriesMustScale() {
3658 global $wgMiserMode;
3659 return $wgMiserMode
3660 || ( SiteStats::pages() > 100000
3661 && SiteStats::edits() > 1000000
3662 && SiteStats::users() > 10000 );
3663 }
3664
3665 /**
3666 * Get the path to a specified script file, respecting file
3667 * extensions; this is a wrapper around $wgScriptExtension etc.
3668 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3669 *
3670 * @param $script String: script filename, sans extension
3671 * @return String
3672 */
3673 function wfScript( $script = 'index' ) {
3674 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3675 if ( $script === 'index' ) {
3676 return $wgScript;
3677 } else if ( $script === 'load' ) {
3678 return $wgLoadScript;
3679 } else {
3680 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3681 }
3682 }
3683
3684 /**
3685 * Get the script URL.
3686 *
3687 * @return string script URL
3688 */
3689 function wfGetScriptUrl() {
3690 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3691 #
3692 # as it was called, minus the query string.
3693 #
3694 # Some sites use Apache rewrite rules to handle subdomains,
3695 # and have PHP set up in a weird way that causes PHP_SELF
3696 # to contain the rewritten URL instead of the one that the
3697 # outside world sees.
3698 #
3699 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3700 # provides containing the "before" URL.
3701 return $_SERVER['SCRIPT_NAME'];
3702 } else {
3703 return $_SERVER['URL'];
3704 }
3705 }
3706
3707 /**
3708 * Convenience function converts boolean values into "true"
3709 * or "false" (string) values
3710 *
3711 * @param $value Boolean
3712 * @return String
3713 */
3714 function wfBoolToStr( $value ) {
3715 return $value ? 'true' : 'false';
3716 }
3717
3718 /**
3719 * Load an extension messages file
3720 *
3721 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3722 * @codeCoverageIgnore
3723 */
3724 function wfLoadExtensionMessages() {
3725 wfDeprecated( __FUNCTION__, '1.16' );
3726 }
3727
3728 /**
3729 * Get a platform-independent path to the null file, e.g. /dev/null
3730 *
3731 * @return string
3732 */
3733 function wfGetNull() {
3734 return wfIsWindows()
3735 ? 'NUL'
3736 : '/dev/null';
3737 }
3738
3739 /**
3740 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3741 * and waiting for it to go down, this waits for the slaves to catch up to the
3742 * master position. Use this when updating very large numbers of rows, as
3743 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3744 * a no-op if there are no slaves.
3745 *
3746 * @param $maxLag Integer (deprecated)
3747 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3748 */
3749 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3750 $lb = wfGetLB( $wiki );
3751 // bug 27975 - Don't try to wait for slaves if there are none
3752 // Prevents permission error when getting master position
3753 if ( $lb->getServerCount() > 1 ) {
3754 $dbw = $lb->getConnection( DB_MASTER );
3755 $pos = $dbw->getMasterPos();
3756 $lb->waitForAll( $pos );
3757 }
3758 }
3759
3760 /**
3761 * Used to be used for outputting text in the installer/updater
3762 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3763 */
3764 function wfOut( $s ) {
3765 wfDeprecated( __FUNCTION__, '1.18' );
3766 global $wgCommandLineMode;
3767 if ( $wgCommandLineMode ) {
3768 echo $s;
3769 } else {
3770 echo htmlspecialchars( $s );
3771 }
3772 flush();
3773 }
3774
3775 /**
3776 * Count down from $n to zero on the terminal, with a one-second pause
3777 * between showing each number. For use in command-line scripts.
3778 * @codeCoverageIgnore
3779 * @param $n int
3780 */
3781 function wfCountDown( $n ) {
3782 for ( $i = $n; $i >= 0; $i-- ) {
3783 if ( $i != $n ) {
3784 echo str_repeat( "\x08", strlen( $i + 1 ) );
3785 }
3786 echo $i;
3787 flush();
3788 if ( $i ) {
3789 sleep( 1 );
3790 }
3791 }
3792 echo "\n";
3793 }
3794
3795 /**
3796 * Generate a random 32-character hexadecimal token.
3797 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3798 * characters before hashing.
3799 * @return string
3800 * @codeCoverageIgnore
3801 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pesudo-random strings
3802 * @warning This method is NOT secure. Additionally it has many callers that use it for pesudo-random purposes.
3803 */
3804 function wfGenerateToken( $salt = '' ) {
3805 wfDeprecated( __METHOD__, '1.20' );
3806 $salt = serialize( $salt );
3807 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3808 }
3809
3810 /**
3811 * Replace all invalid characters with -
3812 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3813 * By default, $wgIllegalFileChars = ':'
3814 *
3815 * @param $name Mixed: filename to process
3816 * @return String
3817 */
3818 function wfStripIllegalFilenameChars( $name ) {
3819 global $wgIllegalFileChars;
3820 $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
3821 $name = wfBaseName( $name );
3822 $name = preg_replace(
3823 "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
3824 '-',
3825 $name
3826 );
3827 return $name;
3828 }
3829
3830 /**
3831 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3832 *
3833 * @return Integer value memory was set to.
3834 */
3835 function wfMemoryLimit() {
3836 global $wgMemoryLimit;
3837 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3838 if( $memlimit != -1 ) {
3839 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3840 if( $conflimit == -1 ) {
3841 wfDebug( "Removing PHP's memory limit\n" );
3842 wfSuppressWarnings();
3843 ini_set( 'memory_limit', $conflimit );
3844 wfRestoreWarnings();
3845 return $conflimit;
3846 } elseif ( $conflimit > $memlimit ) {
3847 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3848 wfSuppressWarnings();
3849 ini_set( 'memory_limit', $conflimit );
3850 wfRestoreWarnings();
3851 return $conflimit;
3852 }
3853 }
3854 return $memlimit;
3855 }
3856
3857 /**
3858 * Converts shorthand byte notation to integer form
3859 *
3860 * @param $string String
3861 * @return Integer
3862 */
3863 function wfShorthandToInteger( $string = '' ) {
3864 $string = trim( $string );
3865 if( $string === '' ) {
3866 return -1;
3867 }
3868 $last = $string[strlen( $string ) - 1];
3869 $val = intval( $string );
3870 switch( $last ) {
3871 case 'g':
3872 case 'G':
3873 $val *= 1024;
3874 // break intentionally missing
3875 case 'm':
3876 case 'M':
3877 $val *= 1024;
3878 // break intentionally missing
3879 case 'k':
3880 case 'K':
3881 $val *= 1024;
3882 }
3883
3884 return $val;
3885 }
3886
3887 /**
3888 * Get the normalised IETF language tag
3889 * See unit test for examples.
3890 *
3891 * @param $code String: The language code.
3892 * @return String: The language code which complying with BCP 47 standards.
3893 */
3894 function wfBCP47( $code ) {
3895 $codeSegment = explode( '-', $code );
3896 $codeBCP = array();
3897 foreach ( $codeSegment as $segNo => $seg ) {
3898 if ( count( $codeSegment ) > 0 ) {
3899 // when previous segment is x, it is a private segment and should be lc
3900 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3901 $codeBCP[$segNo] = strtolower( $seg );
3902 // ISO 3166 country code
3903 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3904 $codeBCP[$segNo] = strtoupper( $seg );
3905 // ISO 15924 script code
3906 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3907 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3908 // Use lowercase for other cases
3909 } else {
3910 $codeBCP[$segNo] = strtolower( $seg );
3911 }
3912 } else {
3913 // Use lowercase for single segment
3914 $codeBCP[$segNo] = strtolower( $seg );
3915 }
3916 }
3917 $langCode = implode( '-', $codeBCP );
3918 return $langCode;
3919 }
3920
3921 /**
3922 * Get a cache object.
3923 *
3924 * @param $inputType integer Cache type, one the the CACHE_* constants.
3925 * @return BagOStuff
3926 */
3927 function wfGetCache( $inputType ) {
3928 return ObjectCache::getInstance( $inputType );
3929 }
3930
3931 /**
3932 * Get the main cache object
3933 *
3934 * @return BagOStuff
3935 */
3936 function wfGetMainCache() {
3937 global $wgMainCacheType;
3938 return ObjectCache::getInstance( $wgMainCacheType );
3939 }
3940
3941 /**
3942 * Get the cache object used by the message cache
3943 *
3944 * @return BagOStuff
3945 */
3946 function wfGetMessageCacheStorage() {
3947 global $wgMessageCacheType;
3948 return ObjectCache::getInstance( $wgMessageCacheType );
3949 }
3950
3951 /**
3952 * Get the cache object used by the parser cache
3953 *
3954 * @return BagOStuff
3955 */
3956 function wfGetParserCacheStorage() {
3957 global $wgParserCacheType;
3958 return ObjectCache::getInstance( $wgParserCacheType );
3959 }
3960
3961 /**
3962 * Get the cache object used by the language converter
3963 *
3964 * @return BagOStuff
3965 */
3966 function wfGetLangConverterCacheStorage() {
3967 global $wgLanguageConverterCacheType;
3968 return ObjectCache::getInstance( $wgLanguageConverterCacheType );
3969 }
3970
3971 /**
3972 * Call hook functions defined in $wgHooks
3973 *
3974 * @param $event String: event name
3975 * @param $args Array: parameters passed to hook functions
3976 * @return Boolean True if no handler aborted the hook
3977 */
3978 function wfRunHooks( $event, $args = array() ) {
3979 return Hooks::run( $event, $args );
3980 }
3981
3982 /**
3983 * Wrapper around php's unpack.
3984 *
3985 * @param $format String: The format string (See php's docs)
3986 * @param $data: A binary string of binary data
3987 * @param $length integer or false: The minimun length of $data. This is to
3988 * prevent reading beyond the end of $data. false to disable the check.
3989 *
3990 * Also be careful when using this function to read unsigned 32 bit integer
3991 * because php might make it negative.
3992 *
3993 * @throws MWException if $data not long enough, or if unpack fails
3994 * @return array Associative array of the extracted data
3995 */
3996 function wfUnpack( $format, $data, $length=false ) {
3997 if ( $length !== false ) {
3998 $realLen = strlen( $data );
3999 if ( $realLen < $length ) {
4000 throw new MWException( "Tried to use wfUnpack on a "
4001 . "string of length $realLen, but needed one "
4002 . "of at least length $length."
4003 );
4004 }
4005 }
4006
4007 wfSuppressWarnings();
4008 $result = unpack( $format, $data );
4009 wfRestoreWarnings();
4010
4011 if ( $result === false ) {
4012 // If it cannot extract the packed data.
4013 throw new MWException( "unpack could not unpack binary data" );
4014 }
4015 return $result;
4016 }
4017
4018 /**
4019 * Determine if an image exists on the 'bad image list'.
4020 *
4021 * The format of MediaWiki:Bad_image_list is as follows:
4022 * * Only list items (lines starting with "*") are considered
4023 * * The first link on a line must be a link to a bad image
4024 * * Any subsequent links on the same line are considered to be exceptions,
4025 * i.e. articles where the image may occur inline.
4026 *
4027 * @param $name string the image name to check
4028 * @param $contextTitle Title|bool the page on which the image occurs, if known
4029 * @param $blacklist string wikitext of a file blacklist
4030 * @return bool
4031 */
4032 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4033 static $badImageCache = null; // based on bad_image_list msg
4034 wfProfileIn( __METHOD__ );
4035
4036 # Handle redirects
4037 $redirectTitle = RepoGroup::singleton()->checkRedirect( Title::makeTitle( NS_FILE, $name ) );
4038 if( $redirectTitle ) {
4039 $name = $redirectTitle->getDbKey();
4040 }
4041
4042 # Run the extension hook
4043 $bad = false;
4044 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
4045 wfProfileOut( __METHOD__ );
4046 return $bad;
4047 }
4048
4049 $cacheable = ( $blacklist === null );
4050 if( $cacheable && $badImageCache !== null ) {
4051 $badImages = $badImageCache;
4052 } else { // cache miss
4053 if ( $blacklist === null ) {
4054 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4055 }
4056 # Build the list now
4057 $badImages = array();
4058 $lines = explode( "\n", $blacklist );
4059 foreach( $lines as $line ) {
4060 # List items only
4061 if ( substr( $line, 0, 1 ) !== '*' ) {
4062 continue;
4063 }
4064
4065 # Find all links
4066 $m = array();
4067 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4068 continue;
4069 }
4070
4071 $exceptions = array();
4072 $imageDBkey = false;
4073 foreach ( $m[1] as $i => $titleText ) {
4074 $title = Title::newFromText( $titleText );
4075 if ( !is_null( $title ) ) {
4076 if ( $i == 0 ) {
4077 $imageDBkey = $title->getDBkey();
4078 } else {
4079 $exceptions[$title->getPrefixedDBkey()] = true;
4080 }
4081 }
4082 }
4083
4084 if ( $imageDBkey !== false ) {
4085 $badImages[$imageDBkey] = $exceptions;
4086 }
4087 }
4088 if ( $cacheable ) {
4089 $badImageCache = $badImages;
4090 }
4091 }
4092
4093 $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
4094 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4095 wfProfileOut( __METHOD__ );
4096 return $bad;
4097 }