(bug 31740) JpegMetadataExtractor and friends weren't checking for unexpected end...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 2b16d17..34c46b3 100644 (file)
@@ -164,7 +164,7 @@ function wfArrayMerge( $array1/* ... */ ) {
  *             array( array( 'x' ) ),
  *             array( array( 'x', '2' ) ),
  *             array( array( 'x' ) ),
- *             array( array( 'y') )
+ *             array( array( 'y' ) )
  *     );
  * returns:
  *             array(
@@ -296,9 +296,9 @@ function wfUrlencode( $s ) {
        static $needle;
        if ( is_null( $s ) ) {
                $needle = null;
-               return;
+               return '';
        }
-       
+
        if ( is_null( $needle ) ) {
                $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
                if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) || ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
@@ -431,13 +431,14 @@ function wfAppendQuery( $url, $query ) {
 /**
  * Expand a potentially local URL to a fully-qualified URL.  Assumes $wgServer
  * is correct.
- * 
+ *
  * The meaning of the PROTO_* constants is as follows:
  * PROTO_HTTP: Output a URL starting with http://
  * PROTO_HTTPS: Output a URL starting with https://
  * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
  * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
  * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
+ * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
  *
  * @todo this won't work with current-path-relative URLs
  * like "subdir/foo.html", etc.
@@ -447,29 +448,35 @@ function wfAppendQuery( $url, $query ) {
  * @return string Fully-qualified URL
  */
 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
-       global $wgServer, $wgCanonicalServer;
-       $serverUrl = $defaultProto === PROTO_CANONICAL ? $wgCanonicalServer : $wgServer;
-       
+       global $wgServer, $wgCanonicalServer, $wgInternalServer;
+       $serverUrl = $wgServer;
+       if ( $defaultProto === PROTO_CANONICAL ) {
+               $serverUrl = $wgCanonicalServer;
+       }
+       // Make $wgInternalServer fall back to $wgServer if not set
+       if ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
+               $serverUrl = $wgInternalServer;
+       }
        if ( $defaultProto === PROTO_CURRENT ) {
                $defaultProto = WebRequest::detectProtocol() . '://';
        }
-       
+
        // Analyze $serverUrl to obtain its protocol
        $bits = wfParseUrl( $serverUrl );
        $serverHasProto = $bits && $bits['scheme'] != '';
-       
-       if ( $defaultProto === PROTO_CANONICAL ) {
+
+       if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
                if ( $serverHasProto ) {
                        $defaultProto = $bits['scheme'] . '://';
                } else {
-                       // $wgCanonicalServer doesn't have a protocol. This really isn't supposed to happen
+                       // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
                        // Fall back to HTTP in this ridiculous case
                        $defaultProto = PROTO_HTTP;
                }
        }
-       
+
        $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
-       
+
        if( substr( $url, 0, 2 ) == '//' ) {
                return $defaultProtoWithoutSlashes . $url;
        } elseif( substr( $url, 0, 1 ) == '/' ) {
@@ -516,7 +523,7 @@ function wfUrlProtocols( $includeProtocolRelative = true ) {
                // URLs weren't supported until 1.18
                $retval = $wgUrlProtocols;
        }
-       
+
        // Cache return value
        if ( $includeProtocolRelative ) {
                $withProtRel = $retval;
@@ -530,6 +537,7 @@ function wfUrlProtocols( $includeProtocolRelative = true ) {
  * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
  * you need a regex that matches all URL protocols but does not match protocol-
  * relative URLs
+ * @return String
  */
 function wfUrlProtocolsWithoutProtRel() {
        return wfUrlProtocols( false );
@@ -749,8 +757,8 @@ function wfDebugTimer() {
        } else {
                $prefix = sprintf( "%6.4f", microtime( true ) - $start );
        }
-
-       return $prefix . '  ';
+       $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / (1024*1024) ) );
+       return "$prefix $mem  " ;
 }
 
 /**
@@ -845,21 +853,22 @@ function wfErrorLog( $text, $file ) {
                        $text = preg_replace( '/^/m', $prefix . ' ', $text );
 
                        // Limit to 64KB
-                       if ( strlen( $text ) > 65534 ) {
-                               $text = substr( $text, 0, 65534 );
+                       if ( strlen( $text ) > 65506 ) {
+                               $text = substr( $text, 0, 65506 );
                        }
 
                        if ( substr( $text, -1 ) != "\n" ) {
                                $text .= "\n";
                        }
-               } elseif ( strlen( $text ) > 65535 ) {
-                       $text = substr( $text, 0, 65535 );
+               } elseif ( strlen( $text ) > 65507 ) {
+                       $text = substr( $text, 0, 65507 );
                }
 
                $sock = socket_create( $domain, SOCK_DGRAM, SOL_UDP );
                if ( !$sock ) {
                        return;
                }
+
                socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
                socket_close( $sock );
        } else {
@@ -952,6 +961,9 @@ function wfReadOnly() {
        return (bool)$wgReadOnly;
 }
 
+/**
+ * @return bool
+ */
 function wfReadOnlyReason() {
        global $wgReadOnly;
        wfReadOnly();
@@ -967,9 +979,10 @@ function wfReadOnlyReason() {
  *                    a valid code create a language for that language, if
  *                    it is a string but not a valid code then make a basic
  *                    language object
- *                  - a boolean: if it's false then use the current users
- *                    language (as a fallback for the old parameter
- *                    functionality), or if it is true then use the wikis
+ *                  - a boolean: if it's false then use the global object for
+ *                    the current user's language (as a fallback for the old parameter
+ *                    functionality), or if it is true then use global object
+ *                    for the wiki's content language.
  * @return Language object
  */
 function wfGetLangObj( $langcode = false ) {
@@ -1344,7 +1357,7 @@ function wfEmptyMsg( $key ) {
  * Throw a debugging exception. This function previously once exited the process,
  * but now throws an exception instead, with similar results.
  *
- * @param $msg String: message shown when dieing.
+ * @param $msg String: message shown when dying.
  */
 function wfDebugDieBacktrace( $msg = '' ) {
        throw new MWException( $msg );
@@ -1407,6 +1420,8 @@ function wfReportTime() {
  * debug_backtrace is disabled, otherwise the output from
  * debug_backtrace() (trimmed).
  *
+ * @param $limit int This parameter can be used to limit the number of stack frames returned
+ *
  * @return array of backtrace information
  */
 function wfDebugBacktrace( $limit = 0 ) {
@@ -1432,7 +1447,7 @@ function wfDebugBacktrace( $limit = 0 ) {
        }
 
        if ( $limit && version_compare( PHP_VERSION, '5.4.0', '>=' ) ) {
-               return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, 1 ), 1 );
+               return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit ), 1 );
        } else {
                return array_slice( debug_backtrace(), 1 );
        }
@@ -1564,80 +1579,38 @@ function wfShowingResults( $offset, $limit ) {
  * @param $query String: optional URL query parameter string
  * @param $atend Bool: optional param for specified if this is the last page
  * @return String
+ * @deprecated in 1.19; use Language::viewPrevNext() instead
  */
 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
        global $wgLang;
-       $fmtLimit = $wgLang->formatNum( $limit );
-       // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
-       # Get prev/next link display text
-       $prev = wfMsgExt( 'prevn', array( 'parsemag', 'escape' ), $fmtLimit );
-       $next = wfMsgExt( 'nextn', array( 'parsemag', 'escape' ), $fmtLimit );
-       # Get prev/next link title text
-       $pTitle = wfMsgExt( 'prevn-title', array( 'parsemag', 'escape' ), $fmtLimit );
-       $nTitle = wfMsgExt( 'nextn-title', array( 'parsemag', 'escape' ), $fmtLimit );
-       # Fetch the title object
+
+       $query = wfCgiToArray( $query );
+
        if( is_object( $link ) ) {
-               $title =& $link;
+               $title = $link;
        } else {
                $title = Title::newFromText( $link );
                if( is_null( $title ) ) {
                        return false;
                }
        }
-       # Make 'previous' link
-       if( 0 != $offset ) {
-               $po = $offset - $limit;
-               $po = max( $po, 0 );
-               $q = "limit={$limit}&offset={$po}";
-               if( $query != '' ) {
-                       $q .= '&' . $query;
-               }
-               $plink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
-       } else {
-               $plink = $prev;
-       }
-       # Make 'next' link
-       $no = $offset + $limit;
-       $q = "limit={$limit}&offset={$no}";
-       if( $query != '' ) {
-               $q .= '&' . $query;
-       }
-       if( $atend ) {
-               $nlink = $next;
-       } else {
-               $nlink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
-       }
-       # Make links to set number of items per page
-       $nums = $wgLang->pipeList( array(
-               wfNumLink( $offset, 20, $title, $query ),
-               wfNumLink( $offset, 50, $title, $query ),
-               wfNumLink( $offset, 100, $title, $query ),
-               wfNumLink( $offset, 250, $title, $query ),
-               wfNumLink( $offset, 500, $title, $query )
-       ) );
-       return wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums );
+
+       return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
 }
 
 /**
- * Generate links for (20|50|100...) items-per-page links
+ * Make a list item, used by various special pages
  *
- * @param $offset String
- * @param $limit Integer
- * @param $title Title
- * @param $query String: optional URL query parameter string
+ * @param $page String Page link
+ * @param $details String Text between brackets
+ * @param $oppositedm Boolean  Add the direction mark opposite to your
+ *                                                             language, to display text properly
+ * @return String
+ * @deprecated since 1.19; use Language::specialList() instead
  */
-function wfNumLink( $offset, $limit, $title, $query = '' ) {
+function wfSpecialList( $page, $details, $oppositedm = true ) {
        global $wgLang;
-       if( $query == '' ) {
-               $q = '';
-       } else {
-               $q = $query.'&';
-       }
-       $q .= "limit={$limit}&offset={$offset}";
-       $fmtLimit = $wgLang->formatNum( $limit );
-       $lTitle = wfMsgExt( 'shown-title', array( 'parsemag', 'escape' ), $limit );
-       $s = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$lTitle}\" class=\"mw-numlink\">{$fmtLimit}</a>";
-       return $s;
+       return $wgLang->specialList( $page, $details, $oppositedm );
 }
 
 /**
@@ -1752,217 +1725,6 @@ function wfSetBit( &$dest, $bit, $state = true ) {
        return $temp;
 }
 
-/**
- * Windows-compatible version of escapeshellarg()
- * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
- * function puts single quotes in regardless of OS.
- *
- * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
- * earlier distro releases of PHP)
- *
- * @param varargs
- * @return String
- */
-function wfEscapeShellArg( ) {
-       wfInitShellLocale();
-
-       $args = func_get_args();
-       $first = true;
-       $retVal = '';
-       foreach ( $args as $arg ) {
-               if ( !$first ) {
-                       $retVal .= ' ';
-               } else {
-                       $first = false;
-               }
-
-               if ( wfIsWindows() ) {
-                       // Escaping for an MSVC-style command line parser and CMD.EXE
-                       // Refs:
-                       //  * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
-                       //  * http://technet.microsoft.com/en-us/library/cc723564.aspx
-                       //  * Bug #13518
-                       //  * CR r63214
-                       // Double the backslashes before any double quotes. Escape the double quotes.
-                       $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
-                       $arg = '';
-                       $iteration = 0;
-                       foreach ( $tokens as $token ) {
-                               if ( $iteration % 2 == 1 ) {
-                                       // Delimiter, a double quote preceded by zero or more slashes
-                                       $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
-                               } elseif ( $iteration % 4 == 2 ) {
-                                       // ^ in $token will be outside quotes, need to be escaped
-                                       $arg .= str_replace( '^', '^^', $token );
-                               } else { // $iteration % 4 == 0
-                                       // ^ in $token will appear inside double quotes, so leave as is
-                                       $arg .= $token;
-                               }
-                               $iteration++;
-                       }
-                       // Double the backslashes before the end of the string, because
-                       // we will soon add a quote
-                       $m = array();
-                       if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
-                               $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
-                       }
-
-                       // Add surrounding quotes
-                       $retVal .= '"' . $arg . '"';
-               } else {
-                       $retVal .= escapeshellarg( $arg );
-               }
-       }
-       return $retVal;
-}
-
-/**
- * wfMerge attempts to merge differences between three texts.
- * Returns true for a clean merge and false for failure or a conflict.
- *
- * @param $old String
- * @param $mine String
- * @param $yours String
- * @param $result String
- * @return Bool
- */
-function wfMerge( $old, $mine, $yours, &$result ) {
-       global $wgDiff3;
-
-       # This check may also protect against code injection in
-       # case of broken installations.
-       wfSuppressWarnings();
-       $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
-       wfRestoreWarnings();
-
-       if( !$haveDiff3 ) {
-               wfDebug( "diff3 not found\n" );
-               return false;
-       }
-
-       # Make temporary files
-       $td = wfTempDir();
-       $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
-       $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
-       $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
-
-       fwrite( $oldtextFile, $old );
-       fclose( $oldtextFile );
-       fwrite( $mytextFile, $mine );
-       fclose( $mytextFile );
-       fwrite( $yourtextFile, $yours );
-       fclose( $yourtextFile );
-
-       # Check for a conflict
-       $cmd = $wgDiff3 . ' -a --overlap-only ' .
-               wfEscapeShellArg( $mytextName ) . ' ' .
-               wfEscapeShellArg( $oldtextName ) . ' ' .
-               wfEscapeShellArg( $yourtextName );
-       $handle = popen( $cmd, 'r' );
-
-       if( fgets( $handle, 1024 ) ) {
-               $conflict = true;
-       } else {
-               $conflict = false;
-       }
-       pclose( $handle );
-
-       # Merge differences
-       $cmd = $wgDiff3 . ' -a -e --merge ' .
-               wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
-       $handle = popen( $cmd, 'r' );
-       $result = '';
-       do {
-               $data = fread( $handle, 8192 );
-               if ( strlen( $data ) == 0 ) {
-                       break;
-               }
-               $result .= $data;
-       } while ( true );
-       pclose( $handle );
-       unlink( $mytextName );
-       unlink( $oldtextName );
-       unlink( $yourtextName );
-
-       if ( $result === '' && $old !== '' && !$conflict ) {
-               wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
-               $conflict = true;
-       }
-       return !$conflict;
-}
-
-/**
- * Returns unified plain-text diff of two texts.
- * Useful for machine processing of diffs.
- *
- * @param $before String: the text before the changes.
- * @param $after String: the text after the changes.
- * @param $params String: command-line options for the diff command.
- * @return String: unified diff of $before and $after
- */
-function wfDiff( $before, $after, $params = '-u' ) {
-       if ( $before == $after ) {
-               return '';
-       }
-
-       global $wgDiff;
-       wfSuppressWarnings();
-       $haveDiff = $wgDiff && file_exists( $wgDiff );
-       wfRestoreWarnings();
-
-       # This check may also protect against code injection in
-       # case of broken installations.
-       if( !$haveDiff ) {
-               wfDebug( "diff executable not found\n" );
-               $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
-               $format = new UnifiedDiffFormatter();
-               return $format->format( $diffs );
-       }
-
-       # Make temporary files
-       $td = wfTempDir();
-       $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
-       $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
-
-       fwrite( $oldtextFile, $before );
-       fclose( $oldtextFile );
-       fwrite( $newtextFile, $after );
-       fclose( $newtextFile );
-
-       // Get the diff of the two files
-       $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
-
-       $h = popen( $cmd, 'r' );
-
-       $diff = '';
-
-       do {
-               $data = fread( $h, 8192 );
-               if ( strlen( $data ) == 0 ) {
-                       break;
-               }
-               $diff .= $data;
-       } while ( true );
-
-       // Clean up
-       pclose( $h );
-       unlink( $oldtextName );
-       unlink( $newtextName );
-
-       // Kill the --- and +++ lines. They're not useful.
-       $diff_lines = explode( "\n", $diff );
-       if ( strpos( $diff_lines[0], '---' ) === 0 ) {
-               unset( $diff_lines[0] );
-       }
-       if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
-               unset( $diff_lines[1] );
-       }
-
-       $diff = implode( "\n", $diff_lines );
-
-       return $diff;
-}
-
 /**
  * A wrapper around the PHP function var_export().
  * Either print it or add it to the regular output ($wgOut).
@@ -2150,7 +1912,7 @@ function mimeTypeMatch( $type, $avail ) {
 function wfNegotiateType( $cprefs, $sprefs ) {
        $combine = array();
 
-       foreach( array_keys($sprefs) as $type ) {
+       foreach( array_keys( $sprefs ) as $type ) {
                $parts = explode( '/', $type );
                if( $parts[1] != '*' ) {
                        $ckey = mimeTypeMatch( $type, $cprefs );
@@ -2202,7 +1964,7 @@ function wfSuppressWarnings( $end = false ) {
        } else {
                if ( !$suppressCount ) {
                        // E_DEPRECATED is undefined in PHP 5.2
-                       if( !defined( 'E_DEPRECATED' ) ){
+                       if( !defined( 'E_DEPRECATED' ) ) {
                                define( 'E_DEPRECATED', 8192 );
                        }
                        $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED ) );
@@ -2315,7 +2077,7 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                # TS_POSTGRES
        } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
                # TS_POSTGRES
-       } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
+       } elseif (preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/', $ts, $da ) ) {
                # TS_DB2
        } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
                                                        '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' .  # dd Mon yyyy
@@ -2600,23 +2362,6 @@ function in_string( $needle, $str, $insensitive = false ) {
        return $func( $str, $needle ) !== false;
 }
 
-/**
- * Make a list item, used by various special pages
- *
- * @param $page String Page link
- * @param $details String Text between brackets
- * @param $oppositedm Boolean  Add the direction mark opposite to your
- *                                                             language, to display text properly
- * @return String
- */
-function wfSpecialList( $page, $details, $oppositedm = true ) {
-       global $wgLang;
-       $dirmark = ( $oppositedm ? $wgLang->getDirMark( true ) : '' ) .
-               $wgLang->getDirMark();
-       $details = $details ? $dirmark . " ($details)" : '';
-       return $page . $details;
-}
-
 /**
  * Safety wrapper around ini_get() for boolean settings.
  * The values returned from ini_get() are pre-normalized for settings
@@ -2684,6 +2429,70 @@ function wfDl( $extension, $fileName = null ) {
        return extension_loaded( $extension );
 }
 
+/**
+ * Windows-compatible version of escapeshellarg()
+ * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
+ * function puts single quotes in regardless of OS.
+ *
+ * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
+ * earlier distro releases of PHP)
+ *
+ * @param varargs
+ * @return String
+ */
+function wfEscapeShellArg( ) {
+       wfInitShellLocale();
+
+       $args = func_get_args();
+       $first = true;
+       $retVal = '';
+       foreach ( $args as $arg ) {
+               if ( !$first ) {
+                       $retVal .= ' ';
+               } else {
+                       $first = false;
+               }
+
+               if ( wfIsWindows() ) {
+                       // Escaping for an MSVC-style command line parser and CMD.EXE
+                       // Refs:
+                       //  * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
+                       //  * http://technet.microsoft.com/en-us/library/cc723564.aspx
+                       //  * Bug #13518
+                       //  * CR r63214
+                       // Double the backslashes before any double quotes. Escape the double quotes.
+                       $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
+                       $arg = '';
+                       $iteration = 0;
+                       foreach ( $tokens as $token ) {
+                               if ( $iteration % 2 == 1 ) {
+                                       // Delimiter, a double quote preceded by zero or more slashes
+                                       $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
+                               } elseif ( $iteration % 4 == 2 ) {
+                                       // ^ in $token will be outside quotes, need to be escaped
+                                       $arg .= str_replace( '^', '^^', $token );
+                               } else { // $iteration % 4 == 0
+                                       // ^ in $token will appear inside double quotes, so leave as is
+                                       $arg .= $token;
+                               }
+                               $iteration++;
+                       }
+                       // Double the backslashes before the end of the string, because
+                       // we will soon add a quote
+                       $m = array();
+                       if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
+                               $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
+                       }
+
+                       // Add surrounding quotes
+                       $retVal .= '"' . $arg . '"';
+               } else {
+                       $retVal .= escapeshellarg( $arg );
+               }
+       }
+       return $retVal;
+}
+
 /**
  * Execute a shell command, with time and memory limits mirrored from the PHP
  * configuration if supported.
@@ -2793,6 +2602,178 @@ function wfInitShellLocale() {
        }
 }
 
+/**
+ * Generate a shell-escaped command line string to run a maintenance script.
+ * Note that $parameters should be a flat array and an option with an argument
+ * should consist of two consecutive items in the array (do not use "--option value").
+ * @param $script string MediaWiki maintenance script path
+ * @param $parameters Array Arguments and options to the script
+ * @param $options Array Associative array of options:
+ *             'php': The path to the php executable
+ *             'wrapper': Path to a PHP wrapper to handle the maintenance script
+ * @return Array
+ */
+function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
+       global $wgPhpCli;
+       // Give site config file a chance to run the script in a wrapper.
+       // The caller may likely want to call wfBasename() on $script.
+       wfRunHooks( 'wfShellMaintenanceCmd', array( &$script, &$parameters, &$options ) );
+       $cmd = isset( $options['php'] ) ? array( $options['php'] ) : array( $wgPhpCli );
+       if ( isset( $options['wrapper'] ) ) {
+               $cmd[] = $options['wrapper'];
+       }
+       $cmd[] = $script;
+       // Escape each parameter for shell
+       return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
+}
+
+/**
+ * wfMerge attempts to merge differences between three texts.
+ * Returns true for a clean merge and false for failure or a conflict.
+ *
+ * @param $old String
+ * @param $mine String
+ * @param $yours String
+ * @param $result String
+ * @return Bool
+ */
+function wfMerge( $old, $mine, $yours, &$result ) {
+       global $wgDiff3;
+
+       # This check may also protect against code injection in
+       # case of broken installations.
+       wfSuppressWarnings();
+       $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
+       wfRestoreWarnings();
+
+       if( !$haveDiff3 ) {
+               wfDebug( "diff3 not found\n" );
+               return false;
+       }
+
+       # Make temporary files
+       $td = wfTempDir();
+       $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
+       $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
+       $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
+
+       fwrite( $oldtextFile, $old );
+       fclose( $oldtextFile );
+       fwrite( $mytextFile, $mine );
+       fclose( $mytextFile );
+       fwrite( $yourtextFile, $yours );
+       fclose( $yourtextFile );
+
+       # Check for a conflict
+       $cmd = $wgDiff3 . ' -a --overlap-only ' .
+               wfEscapeShellArg( $mytextName ) . ' ' .
+               wfEscapeShellArg( $oldtextName ) . ' ' .
+               wfEscapeShellArg( $yourtextName );
+       $handle = popen( $cmd, 'r' );
+
+       if( fgets( $handle, 1024 ) ) {
+               $conflict = true;
+       } else {
+               $conflict = false;
+       }
+       pclose( $handle );
+
+       # Merge differences
+       $cmd = $wgDiff3 . ' -a -e --merge ' .
+               wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
+       $handle = popen( $cmd, 'r' );
+       $result = '';
+       do {
+               $data = fread( $handle, 8192 );
+               if ( strlen( $data ) == 0 ) {
+                       break;
+               }
+               $result .= $data;
+       } while ( true );
+       pclose( $handle );
+       unlink( $mytextName );
+       unlink( $oldtextName );
+       unlink( $yourtextName );
+
+       if ( $result === '' && $old !== '' && !$conflict ) {
+               wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
+               $conflict = true;
+       }
+       return !$conflict;
+}
+
+/**
+ * Returns unified plain-text diff of two texts.
+ * Useful for machine processing of diffs.
+ *
+ * @param $before String: the text before the changes.
+ * @param $after String: the text after the changes.
+ * @param $params String: command-line options for the diff command.
+ * @return String: unified diff of $before and $after
+ */
+function wfDiff( $before, $after, $params = '-u' ) {
+       if ( $before == $after ) {
+               return '';
+       }
+
+       global $wgDiff;
+       wfSuppressWarnings();
+       $haveDiff = $wgDiff && file_exists( $wgDiff );
+       wfRestoreWarnings();
+
+       # This check may also protect against code injection in
+       # case of broken installations.
+       if( !$haveDiff ) {
+               wfDebug( "diff executable not found\n" );
+               $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
+               $format = new UnifiedDiffFormatter();
+               return $format->format( $diffs );
+       }
+
+       # Make temporary files
+       $td = wfTempDir();
+       $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
+       $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
+
+       fwrite( $oldtextFile, $before );
+       fclose( $oldtextFile );
+       fwrite( $newtextFile, $after );
+       fclose( $newtextFile );
+
+       // Get the diff of the two files
+       $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
+
+       $h = popen( $cmd, 'r' );
+
+       $diff = '';
+
+       do {
+               $data = fread( $h, 8192 );
+               if ( strlen( $data ) == 0 ) {
+                       break;
+               }
+               $diff .= $data;
+       } while ( true );
+
+       // Clean up
+       pclose( $h );
+       unlink( $oldtextName );
+       unlink( $newtextName );
+
+       // Kill the --- and +++ lines. They're not useful.
+       $diff_lines = explode( "\n", $diff );
+       if ( strpos( $diff_lines[0], '---' ) === 0 ) {
+               unset( $diff_lines[0] );
+       }
+       if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
+               unset( $diff_lines[1] );
+       }
+
+       $diff = implode( "\n", $diff_lines );
+
+       return $diff;
+}
+
 /**
  * This function works like "use VERSION" in Perl, the program will die with a
  * backtrace if the current version of PHP is less than the version provided
@@ -2909,35 +2890,12 @@ function wfRelativePath( $path, $from ) {
 /**
  * Do any deferred updates and clear the list
  *
- * @param $commit String: set to 'commit' to commit after every update to
- *                prevent lock contention
+ * @deprecated since 1.19
+ * @see DeferredUpdates::doUpdate()
+ * @param $commit string
  */
 function wfDoUpdates( $commit = '' ) {
-       global $wgDeferredUpdateList;
-
-       wfProfileIn( __METHOD__ );
-
-       // No need to get master connections in case of empty updates array
-       if ( !count( $wgDeferredUpdateList ) ) {
-               wfProfileOut( __METHOD__ );
-               return;
-       }
-
-       $doCommit = $commit == 'commit';
-       if ( $doCommit ) {
-               $dbw = wfGetDB( DB_MASTER );
-       }
-
-       foreach ( $wgDeferredUpdateList as $update ) {
-               $update->doUpdate();
-
-               if ( $doCommit && $dbw->trxLevel() ) {
-                       $dbw->commit();
-               }
-       }
-
-       $wgDeferredUpdateList = array();
-       wfProfileOut( __METHOD__ );
+       DeferredUpdates::doUpdates( $commit );
 }
 
 /**
@@ -3032,6 +2990,7 @@ function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = t
  *
  * @param $name String
  * @param $p Array: parameters
+ * @return object
  * @deprecated since 1.18, warnings in 1.18, removal in 1.20
  */
 function wfCreateObject( $name, $p ) {
@@ -3039,6 +2998,9 @@ function wfCreateObject( $name, $p ) {
        return MWFunction::newObj( $name, $p );
 }
 
+/**
+ * @return bool
+ */
 function wfHttpOnlySafe() {
        global $wgHttpOnlyBlacklist;
 
@@ -3155,8 +3117,10 @@ function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
  * @return String
  */
 function wfWikiID() {
-       global $wgDBprefix, $wgDBname;
-       if ( $wgDBprefix ) {
+       global $wgDBprefix, $wgDBname, $wgWikiID;
+       if ( $wgWikiID !== false ) {
+               return $wgWikiID;
+       } elseif ( $wgDBprefix ) {
                return "$wgDBname-$wgDBprefix";
        } else {
                return $wgDBname;
@@ -3167,7 +3131,8 @@ function wfWikiID() {
  * Split a wiki ID into DB name and table prefix
  *
  * @param $wiki String
- * @param $bits String
+ *
+ * @return array
  */
 function wfSplitWikiID( $wiki ) {
        $bits = explode( '-', $wiki, 2 );
@@ -3350,13 +3315,30 @@ function wfGetNull() {
  * Throws a warning that $function is deprecated
  *
  * @param $function String
+ * @param $version String
  * @return null
  */
-function wfDeprecated( $function ) {
+function wfDeprecated( $function, $version = false ) {
        static $functionsWarned = array();
        if ( !isset( $functionsWarned[$function] ) ) {
                $functionsWarned[$function] = true;
-               wfWarn( "Use of $function is deprecated.", 2 );
+               if ( $version ) {
+                       global $wgDeprecationReleaseLimit;
+                       if ( $wgDeprecationReleaseLimit ) {
+                               # Strip -* off the end of $version so that branches can use the
+                               # format #.##-branchname to avoid issues if the branch is merged into
+                               # a version of MediaWiki later than what it was branched from
+                               $comparableVersion = preg_replace( '/-.*$/', '', $version );
+                               # If the comparableVersion is larger than our release limit then
+                               # skip the warning message for the deprecation
+                               if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
+                                       return;
+                               }
+                       }
+                       wfWarn( "Use of $function was deprecated in $version.", 2 );
+               } else {
+                       wfWarn( "Use of $function is deprecated.", 2 );
+               }
        }
 }
 
@@ -3408,7 +3390,6 @@ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
  *
  * @param $maxLag Integer (deprecated)
  * @param $wiki mixed Wiki identifier accepted by wfGetLB
- * @return null
  */
 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
        $lb = wfGetLB( $wiki );
@@ -3440,6 +3421,7 @@ function wfOut( $s ) {
  * Count down from $n to zero on the terminal, with a one-second pause
  * between showing each number. For use in command-line scripts.
  * @codeCoverageIgnore
+ * @param $n int
  */
 function wfCountDown( $n ) {
        for ( $i = $n; $i >= 0; $i-- ) {
@@ -3548,7 +3530,7 @@ function wfShorthandToInteger( $string = '' ) {
  * See unit test for examples.
  *
  * @param $code String: The language code.
- * @return $langCode String: The language code which complying with BCP 47 standards.
+ * @return String: The language code which complying with BCP 47 standards.
  */
 function wfBCP47( $code ) {
        $codeSegment = explode( '-', $code );
@@ -3556,7 +3538,7 @@ function wfBCP47( $code ) {
        foreach ( $codeSegment as $segNo => $seg ) {
                if ( count( $codeSegment ) > 0 ) {
                        // when previous segment is x, it is a private segment and should be lc
-                       if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') {
+                       if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
                                $codeBCP[$segNo] = strtolower( $seg );
                        // ISO 3166 country code
                        } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
@@ -3627,3 +3609,39 @@ function wfGetParserCacheStorage() {
 function wfRunHooks( $event, $args = array() ) {
        return Hooks::run( $event, $args );
 }
+
+/**
+ * Wrapper around php's unpack.
+ *
+ * @param $format String: The format string (See php's docs)
+ * @param $data: A binary string of binary data
+ * @param $length integer or false: The minimun length of $data. This is to
+ *     prevent reading beyond the end of $data. false to disable the check.
+ *
+ * Also be careful when using this function to read unsigned 32 bit integer
+ * because php might make it negative.
+ *
+ * @throws MWException if $data not long enough, or if unpack fails
+ * @return Associative array of the extracted data
+ */
+function wfUnpack( $format, $data, $length=false ) {
+       if ( $length !== false ) {
+               $realLen = strlen( $data );
+               if ( $realLen < $length ) {
+                       throw new MWException( "Tried to use wfUnpack on a "
+                               . "string of length $realLen, but needed one "
+                               . "of at least length $length."
+                       );
+               }
+       }
+
+       wfSuppressWarnings();
+       $result = unpack( $format, $data );
+       wfRestoreWarnings();
+
+       if ( $result === false ) {
+               // If it cannot extract the packed data.
+               throw new MWException( "unpack could not unpack binary data" );
+       }
+       return $result;
+}