/*
XOWA: the XOWA Offline Wiki Application
Copyright (C) 2012 gnosygnu@gmail.com
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see
' . // nl2br( htmlspecialchars( $desc ) ) . // "
\n"; // } // // /** // * Clear away any user-level output buffers, discarding contents. // * // * Suitable for 'starting afresh', for instance when streaming // * relatively large amounts of data without buffering, or wanting to // * output image files without ob_gzhandler's compression. // * // * The optional $resetGzipEncoding parameter controls suppression of // * the Content-Encoding header sent by ob_gzhandler; by default it // * is left. See comments for wfClearOutputBuffers() for why it would // * be used. // * // * Note that some PHP configuration options may add output buffer // * layers which cannot be removed; these are left in place. // * // * @param boolean $resetGzipEncoding // */ // function wfResetOutputBuffers( $resetGzipEncoding = true ) { // if ( $resetGzipEncoding ) { // // Suppress Content-Encoding and Content-length // // headers from 1.10+s wfOutputHandler // global $wgDisableOutputCompression; // $wgDisableOutputCompression = true; // } // while ( $status = ob_get_status() ) { // if ( isset( $status['flags'] ) ) { // $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE; // $deleteable = ( $status['flags'] & $flags ) === $flags; // } elseif ( isset( $status['del'] ) ) { // $deleteable = $status['del']; // } else { // // Guess that any PHP-@gplx.Internal protected setting can't be removed. // $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */ // } // if ( !$deleteable ) { // // Give up, and hope the result doesn't break // // output behavior. // break; // } // if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) { // // Unit testing barrier to prevent this function from breaking PHPUnit. // break; // } // if ( !ob_end_clean() ) { // // Could not remove output buffer handler; abort now // // to avoid getting in some kind of infinite loop. // break; // } // if ( $resetGzipEncoding ) { // if ( $status['name'] == 'ob_gzhandler' ) { // // Reset the 'Content-Encoding' field set by this handler // // so we can start fresh. // header_remove( 'Content-Encoding' ); // break; // } // } // } // } // // /** // * More legible than passing a 'false' parameter to wfResetOutputBuffers(): // * // * Clear away output buffers, but keep the Content-Encoding header // * produced by ob_gzhandler, if any. // * // * This should be used for HTTP 304 responses, where you need to // * preserve the Content-Encoding header of the real result, but // * also need to suppress the output of ob_gzhandler to keep to spec // * and avoid breaking Firefox in rare cases where the headers and // * body are broken over two packets. // */ // function wfClearOutputBuffers() { // wfResetOutputBuffers( false ); // } // // /** // * Converts an Accept-* header into an array mapping String values to quality // * factors // * // * @param String $accept // * @param String $def Default // * @return float[] Associative array of String => float pairs // */ // function wfAcceptToPrefs( $accept, $def = '*/*' ) { // # No arg means accept anything (per HTTP spec) // if ( !$accept ) { // return [ $def => 1.0 ]; // } // // $prefs = []; // // $parts = explode( ',', $accept ); // // foreach ( $parts as $part ) { // # @todo FIXME: Doesn't deal with params like 'text/html; level=1' // $values = explode( ';', trim( $part ) ); // $match = []; // if ( count( $values ) == 1 ) { // $prefs[$values[0]] = 1.0; // } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) { // $prefs[$values[0]] = floatval( $match[1] ); // } // } // // return $prefs; // } // // /** // * Checks if a given MIME type matches any of the keys in the given // * array. Basic wildcards are accepted in the array keys. // * // * Returns the matching MIME type (or wildcard) if a match, otherwise // * NULL if no match. // * // * @param String $type // * @param array $avail // * @return String // * @private // */ // function mimeTypeMatch( $type, $avail ) { // if ( array_key_exists( $type, $avail ) ) { // return $type; // } else { // $mainType = explode( '/', $type )[0]; // if ( array_key_exists( "$mainType/*", $avail ) ) { // return "$mainType/*"; // } elseif ( array_key_exists( '*/*', $avail ) ) { // return '*/*'; // } else { // return null; // } // } // } // // /** // * Returns the 'best' match between a client's requested internet media types // * and the server's list of available types. Each list should be an associative // * array of type to preference (preference is a float between 0.0 and 1.0). // * Wildcards in the types are acceptable. // * // * @param array $cprefs Client's acceptable type list // * @param array $sprefs Server's offered types // * @return String // * // * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8' // * XXX: generalize to negotiate other stuff // */ // function wfNegotiateType( $cprefs, $sprefs ) { // $combine = []; // // foreach ( array_keys( $sprefs ) as $type ) { // $subType = explode( '/', $type )[1]; // if ( $subType != '*' ) { // $ckey = mimeTypeMatch( $type, $cprefs ); // if ( $ckey ) { // $combine[$type] = $sprefs[$type] * $cprefs[$ckey]; // } // } // } // // foreach ( array_keys( $cprefs ) as $type ) { // $subType = explode( '/', $type )[1]; // if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) { // $skey = mimeTypeMatch( $type, $sprefs ); // if ( $skey ) { // $combine[$type] = $sprefs[$skey] * $cprefs[$type]; // } // } // } // // $bestq = 0; // $besttype = null; // // foreach ( array_keys( $combine ) as $type ) { // if ( $combine[$type] > $bestq ) { // $besttype = $type; // $bestq = $combine[$type]; // } // } // // return $besttype; // } // // /** // * Reference-counted warning suppression // * // * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly // * @param boolean $end // */ // function wfSuppressWarnings( $end = false ) { // MediaWiki\suppressWarnings( $end ); // } // // /** // * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly // * Restore error level to previous value // */ // function wfRestoreWarnings() { // MediaWiki\suppressWarnings( true ); // } // // /** // * Get a timestamp String in one of various formats // * // * @param mixed $outputtype A timestamp in one of the supported formats, the // * function will autodetect which format is supplied and act accordingly. // * @param mixed $ts Optional timestamp to convert, default 0 for the current time // * @return String|boolean String / false The same date in the format specified in $outputtype or false // */ // function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) { // $ret = MWTimestamp::convert( $outputtype, $ts ); // if ( $ret === false ) { // wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" ); // } // return $ret; // } // // /** // * Return a formatted timestamp, or null if input is null. // * For dealing with nullable timestamp columns in the database. // * // * @param int $outputtype // * @param String $ts // * @return String // */ // function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) { // if ( is_null( $ts ) ) { // return null; // } else { // return wfTimestamp( $outputtype, $ts ); // } // } // // /** // * Convenience function; returns MediaWiki timestamp for the present time. // * // * @return String // */ // function wfTimestampNow() { // # return NOW // return MWTimestamp::now( TS_MW ); // } // // /** // * Check if the operating system is Windows // * // * @return boolean True if it's Windows, false otherwise. // */ // function wfIsWindows() { // static $isWindows = null; // if ( $isWindows === null ) { // $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN'; // } // return $isWindows; // } // // /** // * Check if we are running under HHVM // * // * @return boolean // */ // function wfIsHHVM() { // return defined( 'HHVM_VERSION' ); // } // // /** // * Tries to get the system directory for temporary files. First // * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP // * environment variables are then checked in sequence, then // * sys_get_temp_dir(), then upload_tmp_dir from php.ini. // * // * NOTE: When possible, use instead the tmpfile() function to create // * temporary files to avoid race conditions on file creation, etc. // * // * @return String // */ // function wfTempDir() { // global $wgTmpDirectory; // // if ( $wgTmpDirectory !== false ) { // return $wgTmpDirectory; // } // // return TempFSFile::getUsableTempDirectory(); // } // // /** // * Make directory, and make all parent directories if they don't exist // * // * @param String $dir Full path to directory to create // * @param int $mode Chmod value to use, default is $wgDirectoryMode // * @param String $caller Optional caller param for debugging. // * @throws MWException // * @return boolean // */ // function wfMkdirParents( $dir, $mode = null, $caller = null ) { // global $wgDirectoryMode; // // if ( FileBackend::isStoragePath( $dir ) ) { // sanity // throw new MWException( __FUNCTION__ . " given storage path '$dir'." ); // } // // if ( !is_null( $caller ) ) { // wfDebug( "$caller: called wfMkdirParents($dir)\n" ); // } // // if ( strval( $dir ) === '' || is_dir( $dir ) ) { // return true; // } // // $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir ); // // if ( is_null( $mode ) ) { // $mode = $wgDirectoryMode; // } // // // Turn off the normal warning, we're doing our own below // MediaWiki\suppressWarnings(); // $ok = mkdir( $dir, $mode, true ); // PHP5 <3 // MediaWiki\restoreWarnings(); // // if ( !$ok ) { // // directory may have been created on another request since we last checked // if ( is_dir( $dir ) ) { // return true; // } // // // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis. // wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) ); // } // return $ok; // } // // /** // * Remove a directory and all its content. // * Does not hide error. // * @param String $dir // */ // function wfRecursiveRemoveDir( $dir ) { // wfDebug( __FUNCTION__ . "( $dir )\n" ); // // taken from https://secure.php.net/manual/en/function.rmdir.php#98622 // if ( is_dir( $dir ) ) { // $objects = scandir( $dir ); // foreach ( $objects as $Object ) { // if ( $Object != "." && $Object != ".." ) { // if ( filetype( $dir . '/' . $Object ) == "dir" ) { // wfRecursiveRemoveDir( $dir . '/' . $Object ); // } else { // unlink( $dir . '/' . $Object ); // } // } // } // reset( $objects ); // rmdir( $dir ); // } // } // // /** // * @param int $nr The number to format // * @param int $acc The number of digits after the decimal point, default 2 // * @param boolean $round Whether or not to round the value, default true // * @return String // */ // function wfPercent( $nr, $acc = 2, $round = true ) { // $ret = sprintf( "%.${acc}f", $nr ); // return $round ? round( $ret, $acc ) . '%' : "$ret%"; // } // // /** // * Safety wrapper around ini_get() for boolean settings. // * The values returned from ini_get() are pre-normalized for settings // * set via php.ini or php_flag/php_admin_flag... but *not* // * for those set via php_value/php_admin_value. // * // * It's fairly common for people to use php_value instead of php_flag, // * which can leave you with an 'off' setting giving a false positive // * for code that just takes the ini_get() return value as a boolean. // * // * To make things extra interesting, setting via php_value accepts // * "true" and "yes" as true, but php.ini and php_flag consider them false. :) // * Unrecognized values go false... again opposite PHP's own coercion // * from String to boolean. // * // * Luckily, 'properly' set settings will always come back as '0' or '1', // * so we only have to worry about them and the 'improper' settings. // * // * I frickin' hate PHP... :P // * // * @param String $setting // * @return boolean // */ // function wfIniGetBool( $setting ) { // $val = strtolower( ini_get( $setting ) ); // // 'on' and 'true' can't have whitespace around them, but '1' can. // return $val == 'on' // || $val == 'true' // || $val == 'yes' // || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function // } // // /** // * Version of escapeshellarg() that works better on Windows. // * // * Originally, this fixed the incorrect use of single quotes on Windows // * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in // * PHP 5.2.6+ (bug backported to earlier distro releases of PHP). // * // * @param String ... strings to escape and glue together, or a single array of strings parameter // * @return String // */ // function wfEscapeShellArg( /*...*/ ) { // wfInitShellLocale(); // // $args = func_get_args(); // if ( count( $args ) === 1 && is_array( reset( $args ) ) ) { // // If only one argument has been passed, and that argument is an array, // // treat it as a list of arguments // $args = reset( $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 // // @codingStandardsIgnoreStart For long URLs // // Refs: // // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html // // * https://technet.microsoft.com/en-us/library/cc723564.aspx // // * T15518 // // * CR r63214 // // Double the backslashes before any double quotes. Escape the double quotes. // // @codingStandardsIgnoreEnd // $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 = []; // if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) { // $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] ); // } // // // Add surrounding quotes // $retVal .= '"' . $arg . '"'; // } else { // $retVal .= escapeshellarg( $arg ); // } // } // return $retVal; // } // // /** // * Check if wfShellExec() is effectively disabled via php.ini config // * // * @return boolean|String False or 'disabled' // * @since 1.22 // */ // function wfShellExecDisabled() { // static $disabled = null; // if ( is_null( $disabled ) ) { // if ( !function_exists( 'proc_open' ) ) { // wfDebug( "proc_open() is disabled\n" ); // $disabled = 'disabled'; // } else { // $disabled = false; // } // } // return $disabled; // } // // /** // * Execute a shell command, with time and memory limits mirrored from the PHP // * configuration if supported. // * // * @param String|String[] $cmd If String, a properly shell-escaped command line, // * or an array of unescaped arguments, in which case each value will be escaped // * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'" // * @param null|mixed &$retval Optional, will receive the program's exit code. // * (non-zero is usually failure). If there is an error from // * read, select, or proc_open(), this will be set to -1. // * @param array $environ Optional environment variables which should be // * added to the executed command environment. // * @param array $limits Optional array with limits(filesize, memory, time, walltime) // * this overwrites the global wgMaxShell* limits. // * @param array $options Array of options: // * - duplicateStderr: Set this to true to duplicate stderr to stdout, // * including errors from limit.sh // * - profileMethod: By default this function will profile based on the calling // * method. Set this to a String for an alternative method to profile from // * // * @return String Collected stdout as a String // */ // function wfShellExec( $cmd, &$retval = null, $environ = [], // $limits = [], $options = [] // ) { // global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime, // $wgMaxShellWallClockTime, $wgShellCgroup; // // $disabled = wfShellExecDisabled(); // if ( $disabled ) { // $retval = 1; // return 'Unable to run external programs, proc_open() is disabled.'; // } // // $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr']; // $profileMethod = isset( $options['profileMethod'] ) ? $options['profileMethod'] : wfGetCaller(); // // wfInitShellLocale(); // // $envcmd = ''; // foreach ( $environ as $k => $v ) { // if ( wfIsWindows() ) { // /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves // * appear in the environment variable, so we must use carat escaping as documented in // * https://technet.microsoft.com/en-us/library/cc723564.aspx // * Note however that the quote isn't listed there, but is needed, and the parentheses // * are listed there but doesn't appear to need it. // */ // $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& '; // } else { // /* Assume this is a POSIX shell, thus required to accept variable assignments before the command // * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01 // */ // $envcmd .= "$k=" . escapeshellarg( $v ) . ' '; // } // } // if ( is_array( $cmd ) ) { // $cmd = wfEscapeShellArg( $cmd ); // } // // $cmd = $envcmd . $cmd; // // $useLogPipe = false; // if ( is_executable( '/bin/bash' ) ) { // $time = intval( isset( $limits['time'] ) ? $limits['time'] : $wgMaxShellTime ); // if ( isset( $limits['walltime'] ) ) { // $wallTime = intval( $limits['walltime'] ); // } elseif ( isset( $limits['time'] ) ) { // $wallTime = $time; // } else { // $wallTime = intval( $wgMaxShellWallClockTime ); // } // $mem = intval( isset( $limits['memory'] ) ? $limits['memory'] : $wgMaxShellMemory ); // $filesize = intval( isset( $limits['filesize'] ) ? $limits['filesize'] : $wgMaxShellFileSize ); // // if ( $time > 0 || $mem > 0 || $filesize > 0 || $wallTime > 0 ) { // $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' . // escapeshellarg( $cmd ) . ' ' . // escapeshellarg( // "MW_INCLUDE_STDERR=" . ( $includeStderr ? '1' : '' ) . ';' . // "MW_CPU_LIMIT=$time; " . // 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' . // "MW_MEM_LIMIT=$mem; " . // "MW_FILE_SIZE_LIMIT=$filesize; " . // "MW_WALL_CLOCK_LIMIT=$wallTime; " . // "MW_USE_LOG_PIPE=yes" // ); // $useLogPipe = true; // } elseif ( $includeStderr ) { // $cmd .= ' 2>&1'; // } // } elseif ( $includeStderr ) { // $cmd .= ' 2>&1'; // } // wfDebug( "wfShellExec: $cmd\n" ); // // // Don't try to execute commands that exceed Linux's MAX_ARG_STRLEN. // // Other platforms may be more accomodating, but we don't want to be // // accomodating, because very long commands probably include user // // input. See T129506. // if ( strlen( $cmd ) > SHELL_MAX_ARG_STRLEN ) { // throw new Exception( __METHOD__ . // '(): total length of $cmd must not exceed SHELL_MAX_ARG_STRLEN' ); // } // // $desc = [ // 0 => [ 'file', 'php://stdin', 'r' ], // 1 => [ 'pipe', 'w' ], // 2 => [ 'file', 'php://stderr', 'w' ] ]; // if ( $useLogPipe ) { // $desc[3] = [ 'pipe', 'w' ]; // } // $pipes = null; // $scoped = Profiler::instance()->scopedProfileIn( __FUNCTION__ . '-' . $profileMethod ); // $proc = proc_open( $cmd, $desc, $pipes ); // if ( !$proc ) { // wfDebugLog( 'exec', "proc_open() failed: $cmd" ); // $retval = -1; // return ''; // } // $outBuffer = $logBuffer = ''; // $emptyArray = []; // $status = false; // $logMsg = false; // // /* According to the documentation, it is possible for stream_select() // * to fail due to EINTR. I haven't managed to induce this in testing // * despite sending various signals. If it did happen, the error // * message would take the form: // * // * stream_select(): unable to select [4]: Interrupted system call (max_fd=5) // * // * where [4] is the value of the macro EINTR and "Interrupted system // * call" is String which according to the Linux manual is "possibly" // * localised according to LC_MESSAGES. // */ // $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR : 4; // $eintrMessage = "stream_select(): unable to select [$eintr]"; // // $running = true; // $timeout = null; // $numReadyPipes = 0; // // while ( $running === true || $numReadyPipes !== 0 ) { // if ( $running ) { // $status = proc_get_status( $proc ); // // If the process has terminated, switch to nonblocking selects // // for getting any data still waiting to be read. // if ( !$status['running'] ) { // $running = false; // $timeout = 0; // } // } // // $readyPipes = $pipes; // // // Clear last error // // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged // @trigger_error( '' ); // $numReadyPipes = @stream_select( $readyPipes, $emptyArray, $emptyArray, $timeout ); // if ( $numReadyPipes === false ) { // // @codingStandardsIgnoreEnd // $error = error_get_last(); // if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) { // continue; // } else { // trigger_error( $error['message'], E_USER_WARNING ); // $logMsg = $error['message']; // break; // } // } // foreach ( $readyPipes as $fd => $pipe ) { // $block = fread( $pipe, 65536 ); // if ( $block === '' ) { // // End of file // fclose( $pipes[$fd] ); // unset( $pipes[$fd] ); // if ( !$pipes ) { // break 2; // } // } elseif ( $block === false ) { // // Read error // $logMsg = "Error reading from pipe"; // break 2; // } elseif ( $fd == 1 ) { // // From stdout // $outBuffer .= $block; // } elseif ( $fd == 3 ) { // // From log FD // $logBuffer .= $block; // if ( strpos( $block, "\n" ) !== false ) { // $lines = explode( "\n", $logBuffer ); // $logBuffer = array_pop( $lines ); // foreach ( $lines as $line ) { // wfDebugLog( 'exec', $line ); // } // } // } // } // } // // foreach ( $pipes as $pipe ) { // fclose( $pipe ); // } // // // Use the status previously collected if possible, since proc_get_status() // // just calls waitpid() which will not return anything useful the second time. // if ( $running ) { // $status = proc_get_status( $proc ); // } // // if ( $logMsg !== false ) { // // Read/select error // $retval = -1; // proc_close( $proc ); // } elseif ( $status['signaled'] ) { // $logMsg = "Exited with signal {$status['termsig']}"; // $retval = 128 + $status['termsig']; // proc_close( $proc ); // } else { // if ( $status['running'] ) { // $retval = proc_close( $proc ); // } else { // $retval = $status['exitcode']; // proc_close( $proc ); // } // if ( $retval == 127 ) { // $logMsg = "Possibly missing executable file"; // } elseif ( $retval >= 129 && $retval <= 192 ) { // $logMsg = "Probably exited with signal " . ( $retval - 128 ); // } // } // // if ( $logMsg !== false ) { // wfDebugLog( 'exec', "$logMsg: $cmd" ); // } // // return $outBuffer; // } // // /** // * Execute a shell command, returning both stdout and stderr. Convenience // * function, as all the arguments to wfShellExec can become unwieldy. // * // * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded. // * @param String|String[] $cmd If String, a properly shell-escaped command line, // * or an array of unescaped arguments, in which case each value will be escaped // * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'" // * @param null|mixed &$retval Optional, will receive the program's exit code. // * (non-zero is usually failure) // * @param array $environ Optional environment variables which should be // * added to the executed command environment. // * @param array $limits Optional array with limits(filesize, memory, time, walltime) // * this overwrites the global wgMaxShell* limits. // * @return String Collected stdout and stderr as a String // */ // function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) { // return wfShellExec( $cmd, $retval, $environ, $limits, // [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] ); // } // // /** // * Workaround for https://bugs.php.net/bug.php?id=45132 // * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale // */ // function wfInitShellLocale() { // static $done = false; // if ( $done ) { // return; // } // $done = true; // global $wgShellLocale; // putenv( "LC_CTYPE=$wgShellLocale" ); // setlocale( LC_CTYPE, $wgShellLocale ); // } // // /** // * Generate a shell-escaped command line String to run a MediaWiki cli 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 String $script MediaWiki cli script path // * @param array $parameters Arguments and options to the script // * @param array $options Associative array of options: // * 'php': The path to the php executable // * 'wrapper': Path to a PHP wrapper to handle the maintenance script // * @return String // */ // function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) { // 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. // Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] ); // $cmd = isset( $options['php'] ) ? [ $options['php'] ] : [ $wgPhpCli ]; // if ( isset( $options['wrapper'] ) ) { // $cmd[] = $options['wrapper']; // } // $cmd[] = $script; // // Escape each parameter for shell // return 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 String $old // * @param String $mine // * @param String $yours // * @param String $result // * @return boolean // */ // function wfMerge( $old, $mine, $yours, &$result ) { // global $wgDiff3; // // # This check may also protect against code injection in // # case of broken installations. // MediaWiki\suppressWarnings(); // $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 ); // MediaWiki\restoreWarnings(); // // 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' ); // // # NOTE: diff3 issues a warning to stderr if any of the files does not end with // # a newline character. To avoid this, we normalize the trailing whitespace before // # creating the diff. // // fwrite( $oldtextFile, rtrim( $old ) . "\n" ); // fclose( $oldtextFile ); // fwrite( $mytextFile, rtrim( $mine ) . "\n" ); // fclose( $mytextFile ); // fwrite( $yourtextFile, rtrim( $yours ) . "\n" ); // fclose( $yourtextFile ); // // # Check for a conflict // $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName, // $oldtextName, $yourtextName ); // $handle = popen( $cmd, 'r' ); // // if ( fgets( $handle, 1024 ) ) { // $conflict = true; // } else { // $conflict = false; // } // pclose( $handle ); // // # Merge differences // $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $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. // * // * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly // * // * @param String $before The text before the changes. // * @param String $after The text after the changes. // * @param String $params 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; // MediaWiki\suppressWarnings(); // $haveDiff = $wgDiff && file_exists( $wgDiff ); // MediaWiki\restoreWarnings(); // // # 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' ); // if ( !$h ) { // unlink( $oldtextName ); // unlink( $newtextName ); // throw new Exception( __METHOD__ . '(): popen() failed' ); // } // // $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 ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) { // unset( $diff_lines[0] ); // } // if ( isset( $diff_lines[1] ) && 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 // * // * This is useful for extensions which due to their nature are not kept in sync // * with releases, and might depend on other versions of PHP than the main code // * // * Note: PHP might die due to parsing errors in some cases before it ever // * manages to call this function, such is life // * // * @see perldoc -f use // * // * @param String|int|float $req_ver The version to check, can be a String, an integer, or a float // * @throws MWException // */ // function wfUsePHP( $req_ver ) { // $php_ver = PHP_VERSION; // // if ( version_compare( $php_ver, (String)$req_ver, '<' ) ) { // throw new MWException( "PHP $req_ver required--this is only $php_ver" ); // } // } // // /** // * This function works like "use VERSION" in Perl except it checks the version // * of MediaWiki, the program will die with a backtrace if the current version // * of MediaWiki is less than the version provided. // * // * This is useful for extensions which due to their nature are not kept in sync // * with releases // * // * Note: Due to the behavior of PHP's version_compare() which is used in this // * function, if you want to allow the 'wmf' development versions add a 'c' (or // * any single letter other than 'a', 'b' or 'p') as a post-fix to your // * targeted version number. For example if you wanted to allow any variation // * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will // * not result in the same comparison due to the @gplx.Internal protected logic of // * version_compare(). // * // * @see perldoc -f use // * // * @deprecated since 1.26, use the "requires' property of extension.json // * @param String|int|float $req_ver The version to check, can be a String, an integer, or a float // * @throws MWException // */ // function wfUseMW( $req_ver ) { // global $wgVersion; // // if ( version_compare( $wgVersion, (String)$req_ver, '<' ) ) { // throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" ); // } // } // // /** // * Return the final portion of a pathname. // * Reimplemented because PHP5's "basename()" is buggy with multibyte text. // * https://bugs.php.net/bug.php?id=33898 // * // * PHP's basename() only considers '\' a pathchar on Windows and Netware. // * We'll consider it so always, as we don't want '\s' in our Unix paths either. // * // * @param String $path // * @param String $suffix String to remove if present // * @return String // */ // function wfBaseName( $path, $suffix = '' ) { // if ( $suffix == '' ) { // $encSuffix = ''; // } else { // $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?'; // } // // $matches = []; // if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) { // return $matches[1]; // } else { // return ''; // } // } // // /** // * Generate a relative path name to the given file. // * May explode on non-matching case-insensitive paths, // * funky symlinks, etc. // * // * @param String $path Absolute destination path including target filename // * @param String $from Absolute source path, directory only // * @return String // */ // function wfRelativePath( $path, $from ) { // // Normalize mixed input on Windows... // $path = str_replace( '/', DIRECTORY_SEPARATOR, $path ); // $from = str_replace( '/', DIRECTORY_SEPARATOR, $from ); // // // Trim trailing slashes -- fix for drive root // $path = rtrim( $path, DIRECTORY_SEPARATOR ); // $from = rtrim( $from, DIRECTORY_SEPARATOR ); // // $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) ); // $against = explode( DIRECTORY_SEPARATOR, $from ); // // if ( $pieces[0] !== $against[0] ) { // // Non-matching Windows drive letters? // // Return a full path. // return $path; // } // // // Trim off common prefix // while ( count( $pieces ) && count( $against ) // && $pieces[0] == $against[0] ) { // array_shift( $pieces ); // array_shift( $against ); // } // // // relative dots to bump us to the parent // while ( count( $against ) ) { // array_unshift( $pieces, '..' ); // array_shift( $against ); // } // // array_push( $pieces, wfBaseName( $path ) ); // // return implode( DIRECTORY_SEPARATOR, $pieces ); // } // // /** // * Convert an arbitrarily-long digit String from one numeric super // * to another, optionally zero-padding to a minimum column width. // * // * Supports super 2 through 36; digit values 10-36 are represented // * as lowercase letters a-z. Input is case-insensitive. // * // * @deprecated since 1.27 Use Wikimedia\base_convert() directly // * // * @param String $input Input number // * @param int $sourceBase Base of the input number // * @param int $destBase Desired super of the output // * @param int $pad Minimum number of digits in the output (pad with zeroes) // * @param boolean $lowercase Whether to output in lowercase or uppercase // * @param String $engine Either "gmp", "bcmath", or "php" // * @return String|boolean The output number as a String, or false on error // */ // function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, // $lowercase = true, $engine = 'auto' // ) { // return Wikimedia\base_convert( $input, $sourceBase, $destBase, $pad, $lowercase, $engine ); // } // // /** // * @deprecated since 1.27, PHP's session generation isn't used with // * MediaWiki\Session\SessionManager // */ // function wfFixSessionID() { // wfDeprecated( __FUNCTION__, '1.27' ); // } // // /** // * Reset the session id // * // * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead // * @since 1.22 // */ // function wfResetSessionID() { // wfDeprecated( __FUNCTION__, '1.27' ); // $session = SessionManager::getGlobalSession(); // $delay = $session->delaySave(); // // $session->resetId(); // // // Make sure a session is started, since that's what the old // // wfResetSessionID() did. // if ( session_id() !== $session->getId() ) { // wfSetupSession( $session->getId() ); // } // // ScopedCallback::consume( $delay ); // } // // /** // * Initialise php session // * // * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead. // * Generally, "using" SessionManager will be calling ->getSessionById() or // * ::getGlobalSession() (depending on whether you were passing $sessionId // * here), then calling $session->persist(). // * @param boolean|String $sessionId // */ // function wfSetupSession( $sessionId = false ) { // wfDeprecated( __FUNCTION__, '1.27' ); // // if ( $sessionId ) { // session_id( $sessionId ); // } // // $session = SessionManager::getGlobalSession(); // $session->persist(); // // if ( session_id() !== $session->getId() ) { // session_id( $session->getId() ); // } // MediaWiki\quietCall( 'session_start' ); // } // // /** // * Get an Object from the precompiled serialized directory // * // * @param String $name // * @return mixed The variable on success, false on failure // */ // function wfGetPrecompiledData( $name ) { // global $IP; // // $file = "$IP/serialized/$name"; // if ( file_exists( $file ) ) { // $blob = file_get_contents( $file ); // if ( $blob ) { // return unserialize( $blob ); // } // } // return false; // } // // /** // * Make a cache key for the local wiki. // * // * @param String $args,... // * @return String // */ // function wfMemcKey( /*...*/ ) { // return call_user_func_array( // [ ObjectCache::getLocalClusterInstance(), 'makeKey' ], // func_get_args() // ); // } // // /** // * Make a cache key for a foreign DB. // * // * Must match what wfMemcKey() would produce in context of the foreign wiki. // * // * @param String $db // * @param String $prefix // * @param String $args,... // * @return String // */ // function wfForeignMemcKey( $db, $prefix /*...*/ ) { // $args = array_slice( func_get_args(), 2 ); // $keyspace = $prefix ? "$db-$prefix" : $db; // return call_user_func_array( // [ ObjectCache::getLocalClusterInstance(), 'makeKeyInternal' ], // [ $keyspace, $args ] // ); // } // // /** // * Make a cache key with database-agnostic prefix. // * // * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix // * instead. Must have a prefix as otherwise keys that use a database name // * in the first segment will clash with wfMemcKey/wfForeignMemcKey. // * // * @since 1.26 // * @param String $args,... // * @return String // */ // function wfGlobalCacheKey( /*...*/ ) { // return call_user_func_array( // [ ObjectCache::getLocalClusterInstance(), 'makeGlobalKey' ], // func_get_args() // ); // } // // /** // * Get an ASCII String identifying this wiki // * This is used as a prefix in memcached keys // * // * @return String // */ // function wfWikiID() { // global $wgDBprefix, $wgDBname; // if ( $wgDBprefix ) { // return "$wgDBname-$wgDBprefix"; // } else { // return $wgDBname; // } // } // // /** // * Split a wiki ID into DB name and table prefix // * // * @param String $wiki // * // * @return array // */ // function wfSplitWikiID( $wiki ) { // $bits = explode( '-', $wiki, 2 ); // if ( count( $bits ) < 2 ) { // $bits[] = ''; // } // return $bits; // } // // /** // * Get a Database Object. // * // * @param int $db Index of the connection to get. May be DB_MASTER for the // * master (for write queries), DB_REPLICA for potentially lagged read // * queries, or an integer >= 0 for a particular server. // * // * @param String|String[] $groups Query groups. An array of group names that this query // * belongs to. May contain a single String if the query is only // * in one group. // * // * @param String|boolean $wiki The wiki ID, or false for the current wiki // * // * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request // * will always return the same Object, unless the underlying connection or load // * balancer is manually destroyed. // * // * Note 2: use $this->getDB() in maintenance scripts that may be invoked by // * updater to ensure that a proper database is being updated. // * // * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection() // * on an injected instance of LoadBalancer. // * // * @return Database // */ // function wfGetDB( $db, $groups = [], $wiki = false ) { // return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki ); // } // // /** // * Get a load balancer Object. // * // * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer() // * or MediaWikiServices::getDBLoadBalancerFactory() instead. // * // * @param String|boolean $wiki Wiki ID, or false for the current wiki // * @return LoadBalancer // */ // function wfGetLB( $wiki = false ) { // if ( $wiki === false ) { // return \MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancer(); // } else { // $factory = \MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancerFactory(); // return $factory->getMainLB( $wiki ); // } // } // // /** // * Get the load balancer factory Object // * // * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead. // * // * @return LBFactory // */ // function wfGetLBFactory() { // return \MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancerFactory(); // } // // /** // * Find a file. // * Shortcut for RepoGroup::singleton()->findFile() // * // * @param String $title String or Title Object // * @param array $options Associative array of options (see RepoGroup::findFile) // * @return File|boolean File, or false if the file does not exist // */ // function wfFindFile( $title, $options = [] ) { // return RepoGroup::singleton()->findFile( $title, $options ); // } // // /** // * Get an Object referring to a locally registered file. // * Returns a valid placeholder Object if the file does not exist. // * // * @param Title|String $title // * @return LocalFile|null A File, or null if passed an invalid Title // */ // function wfLocalFile( $title ) { // return RepoGroup::singleton()->getLocalRepo()->newFile( $title ); // } // // /** // * Should low-performance queries be disabled? // * // * @return boolean // * @codeCoverageIgnore // */ // function wfQueriesMustScale() { // global $wgMiserMode; // return $wgMiserMode // || ( SiteStats::pages() > 100000 // && SiteStats::edits() > 1000000 // && SiteStats::users() > 10000 ); // } // // /** // * Get the path to a specified script file, respecting file // * extensions; this is a wrapper around $wgScriptPath etc. // * except for 'index' and 'load' which use $wgScript/$wgLoadScript // * // * @param String $script Script filename, sans extension // * @return String // */ // function wfScript( $script = 'index' ) { // global $wgScriptPath, $wgScript, $wgLoadScript; // if ( $script === 'index' ) { // return $wgScript; // } elseif ( $script === 'load' ) { // return $wgLoadScript; // } else { // return "{$wgScriptPath}/{$script}.php"; // } // } // // /** // * Get the script URL. // * // * @return String Script URL // */ // function wfGetScriptUrl() { // if ( isset( $_SERVER['SCRIPT_NAME'] ) ) { // /* as it was called, minus the query String. // * // * Some sites use Apache rewrite rules to handle subdomains, // * and have PHP set up in a weird way that causes PHP_SELF // * to contain the rewritten URL instead of the one that the // * outside world sees. // * // * If in this mode, use SCRIPT_URL instead, which mod_rewrite // * provides containing the "before" URL. // */ // return $_SERVER['SCRIPT_NAME']; // } else { // return $_SERVER['URL']; // } // } // // /** // * Convenience function converts boolean values into "true" // * or "false" (String) values // * // * @param boolean $value // * @return String // */ // function wfBoolToStr( $value ) { // return $value ? 'true' : 'false'; // } // // /** // * Get a platform-independent path to the null file, e.g. /dev/null // * // * @return String // */ // function wfGetNull() { // return wfIsWindows() ? 'NUL' : '/dev/null'; // } // // /** // * Waits for the replica DBs to catch up to the master position // * // * Use this when updating very large numbers of rows, as in maintenance scripts, // * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs. // * // * By default this waits on the main DB cluster of the current wiki. // * If $cluster is set to "*" it will wait on all DB clusters, including // * external ones. If the lag being waiting on is caused by the code that // * does this check, it makes since to use $ifWritesSince, particularly if // * cluster is "*", to avoid excess overhead. // * // * Never call this function after a big DB write that is still in a transaction. // * This only makes sense after the possible lag inducing changes were committed. // * // * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp // * @param String|boolean $wiki Wiki identifier accepted by wfGetLB // * @param String|boolean $cluster Cluster name accepted by LBFactory. Default: false. // * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web) // * @return boolean Success (able to connect and no timeouts reached) // * @deprecated since 1.27 Use LBFactory::waitForReplication // */ // function wfWaitForSlaves( // $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null // ) { // if ( $timeout === null ) { // $timeout = ( PHP_SAPI === 'cli' ) ? 86400 : 10; // } // // if ( $cluster === '*' ) { // $cluster = false; // $wiki = false; // } elseif ( $wiki === false ) { // $wiki = wfWikiID(); // } // // try { // wfGetLBFactory()->waitForReplication( [ // 'wiki' => $wiki, // 'cluster' => $cluster, // 'timeout' => $timeout, // // B/C: first argument used to be "max seconds of lag"; ignore such values // 'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null // ] ); // } catch ( DBReplicationWaitError $e ) { // return false; // } // // return true; // } // // /** // * Count down from $seconds to zero on the terminal, with a one-second pause // * between showing each number. For use in command-line scripts. // * // * @codeCoverageIgnore // * @param int $seconds // */ // function wfCountDown( $seconds ) { // for ( $i = $seconds; $i >= 0; $i-- ) { // if ( $i != $seconds ) { // echo str_repeat( "\x08", strlen( $i + 1 ) ); // } // echo $i; // flush(); // if ( $i ) { // sleep( 1 ); // } // } // echo "\n"; // } // // /** // * Replace all invalid characters with '-'. // * Additional characters can be defined in $wgIllegalFileChars (see T22489). // * By default, $wgIllegalFileChars includes ':', '/', '\'. // * // * @param String $name Filename to process // * @return String // */ // function wfStripIllegalFilenameChars( $name ) { // global $wgIllegalFileChars; // $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : ''; // $name = preg_replace( // "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/", // '-', // $name // ); // // $wgIllegalFileChars may not include '/' and '\', so we still need to do this // $name = wfBaseName( $name ); // return $name; // } // // /** // * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit // * // * @return int Resulting value of the memory limit. // */ // function wfMemoryLimit() { // global $wgMemoryLimit; // $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) ); // if ( $memlimit != -1 ) { // $conflimit = wfShorthandToInteger( $wgMemoryLimit ); // if ( $conflimit == -1 ) { // wfDebug( "Removing PHP's memory limit\n" ); // MediaWiki\suppressWarnings(); // ini_set( 'memory_limit', $conflimit ); // MediaWiki\restoreWarnings(); // return $conflimit; // } elseif ( $conflimit > $memlimit ) { // wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" ); // MediaWiki\suppressWarnings(); // ini_set( 'memory_limit', $conflimit ); // MediaWiki\restoreWarnings(); // return $conflimit; // } // } // return $memlimit; // } // // /** // * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit // * // * @return int Prior time limit // * @since 1.26 // */ // function wfTransactionalTimeLimit() { // global $wgTransactionalTimeLimit; // // $timeLimit = ini_get( 'max_execution_time' ); // // Note that CLI scripts use 0 // if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) { // set_time_limit( $wgTransactionalTimeLimit ); // } // // ignore_user_abort( true ); // ignore client disconnects // // return $timeLimit; // } // // /** // * Converts shorthand byte notation to integer form // * // * @param String $String // * @param int $default Returned if $String is empty // * @return int // */ // function wfShorthandToInteger( $String = '', $default = -1 ) { // $String = trim( $String ); // if ( $String === '' ) { // return $default; // } // $last = $String[strlen( $String ) - 1]; // $val = intval( $String ); // switch ( $last ) { // case 'g': // case 'G': // $val *= 1024; // // break intentionally missing // case 'm': // case 'M': // $val *= 1024; // // break intentionally missing // case 'k': // case 'K': // $val *= 1024; // } // // return $val; // } // // /** // * Get the normalised IETF language tag // * See unit test for examples. // * // * @param String $code The language code. // * @return String The language code which complying with BCP 47 standards. // */ // function wfBCP47( $code ) { // $codeSegment = explode( '-', $code ); // $codeBCP = []; // foreach ( $codeSegment as $segNo => $seg ) { // // when previous segment is x, it is a private segment and should be lc // if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) { // $codeBCP[$segNo] = strtolower( $seg ); // // ISO 3166 country code // } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) { // $codeBCP[$segNo] = strtoupper( $seg ); // // ISO 15924 script code // } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) { // $codeBCP[$segNo] = ucfirst( strtolower( $seg ) ); // // Use lowercase for other cases // } else { // $codeBCP[$segNo] = strtolower( $seg ); // } // } // $langCode = implode( '-', $codeBCP ); // return $langCode; // } // // /** // * Get a specific cache Object. // * // * @param int|String $cacheType A CACHE_* constants, or other key in $wgObjectCaches // * @return BagOStuff // */ // function wfGetCache( $cacheType ) { // return ObjectCache::getInstance( $cacheType ); // } // // /** // * Get the main cache Object // * // * @return BagOStuff // */ // function wfGetMainCache() { // global $wgMainCacheType; // return ObjectCache::getInstance( $wgMainCacheType ); // } // // /** // * Get the cache Object used by the message cache // * // * @return BagOStuff // */ // function wfGetMessageCacheStorage() { // global $wgMessageCacheType; // return ObjectCache::getInstance( $wgMessageCacheType ); // } // // /** // * Get the cache Object used by the parser cache // * // * @return BagOStuff // */ // function wfGetParserCacheStorage() { // global $wgParserCacheType; // return ObjectCache::getInstance( $wgParserCacheType ); // } // // /** // * Call hook functions defined in $wgHooks // * // * @param String $event Event name // * @param array $args Parameters passed to hook functions // * @param String|null $deprecatedVersion Optionally mark hook as deprecated with version number // * // * @return boolean True if no handler aborted the hook // * @deprecated since 1.25 - use Hooks::run // */ // function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) { // return Hooks::run( $event, $args, $deprecatedVersion ); // } // // /** // * Wrapper around php's unpack. // * // * @param String $format The format String (See php's docs) // * @param String $data A binary String of binary data // * @param int|boolean $length The minimum length of $data or false. 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 array 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." // ); // } // } // // MediaWiki\suppressWarnings(); // $result = unpack( $format, $data ); // MediaWiki\restoreWarnings(); // // if ( $result === false ) { // // If it cannot extract the packed data. // throw new MWException( "unpack could not unpack binary data" ); // } // return $result; // } // // /** // * Determine if an image exists on the 'bad image list'. // * // * The format of MediaWiki:Bad_image_list is as follows: // * * Only list items (lines starting with "*") are considered // * * The first link on a line must be a link to a bad image // * * Any subsequent links on the same line are considered to be exceptions, // * i.e. articles where the image may occur inline. // * // * @param String $name The image name to check // * @param Title|boolean $contextTitle The page on which the image occurs, if known // * @param String $blacklist Wikitext of a file blacklist // * @return boolean // */ // function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) { // # Handle redirects; callers almost always hit wfFindFile() anyway, // # so just use that method because it has a fast process cache. // $file = wfFindFile( $name ); // get the final name // $name = $file ? $file->getTitle()->getDBkey() : $name; // // # Run the extension hook // $bad = false; // if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) { // return (boolean)$bad; // } // // $cache = ObjectCache::getLocalServerInstance( 'hash' ); // $key = wfMemcKey( 'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist ) ); // $badImages = $cache->get( $key ); // // if ( $badImages === false ) { // cache miss // if ( $blacklist === null ) { // $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list // } // # Build the list now // $badImages = []; // $lines = explode( "\n", $blacklist ); // foreach ( $lines as $line ) { // # List items only // if ( substr( $line, 0, 1 ) !== '*' ) { // continue; // } // // # Find all links // $m = []; // if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) { // continue; // } // // $exceptions = []; // $imageDBkey = false; // foreach ( $m[1] as $i => $titleText ) { // $title = Title::newFromText( $titleText ); // if ( !is_null( $title ) ) { // if ( $i == 0 ) { // $imageDBkey = $title->getDBkey(); // } else { // $exceptions[$title->getPrefixedDBkey()] = true; // } // } // } // // if ( $imageDBkey !== false ) { // $badImages[$imageDBkey] = $exceptions; // } // } // $cache->set( $key, $badImages, 60 ); // } // // $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false; // $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] ); // // return $bad; // } // // /** // * Determine whether the client at a given source IP is likely to be able to // * access the wiki via HTTPS. // * // * @param String $ip The IPv4/6 address in the normal human-readable form // * @return boolean // */ // function wfCanIPUseHTTPS( $ip ) { // $canDo = true; // Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] ); // return !!$canDo; // } // // /** // * Determine input String is represents as infinity // * // * @param String $str The String to determine // * @return boolean // * @since 1.25 // */ // function wfIsInfinity( $str ) { // $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ]; // return in_array( $str, $infinityValues ); // } // // /** // * Returns true if these thumbnail parameters match one that MediaWiki // * requests from file description pages and/or parser output. // * // * $params is considered non-standard if they involve a non-standard // * width or any non-default parameters aside from width and page number. // * The number of possible files with standard parameters is far less than // * that of all combinations; rate-limiting for them can thus be more generious. // * // * @param File $file // * @param array $params // * @return boolean // * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25 // */ // function wfThumbIsStandard( File $file, array $params ) { // global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages; // // $multipliers = [ 1 ]; // if ( $wgResponsiveImages ) { // // These available sizes are hardcoded currently elsewhere in MediaWiki. // // @see Linker::processResponsiveImages // $multipliers[] = 1.5; // $multipliers[] = 2; // } // // $handler = $file->getHandler(); // if ( !$handler || !isset( $params['width'] ) ) { // return false; // } // // $basicParams = []; // if ( isset( $params['page'] ) ) { // $basicParams['page'] = $params['page']; // } // // $thumbLimits = []; // $imageLimits = []; // // Expand limits to account for multipliers // foreach ( $multipliers as $multiplier ) { // $thumbLimits = array_merge( $thumbLimits, array_map( // function ( $width ) use ( $multiplier ) { // return round( $width * $multiplier ); // }, $wgThumbLimits ) // ); // $imageLimits = array_merge( $imageLimits, array_map( // function ( $pair ) use ( $multiplier ) { // return [ // round( $pair[0] * $multiplier ), // round( $pair[1] * $multiplier ), // ]; // }, $wgImageLimits ) // ); // } // // // Check if the width matches one of $wgThumbLimits // if ( in_array( $params['width'], $thumbLimits ) ) { // $normalParams = $basicParams + [ 'width' => $params['width'] ]; // // Append any default values to the map (e.g. "lossy", "lossless", ...) // $handler->normaliseParams( $file, $normalParams ); // } else { // // If not, then check if the width matchs one of $wgImageLimits // $match = false; // foreach ( $imageLimits as $pair ) { // $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ]; // // Decide whether the thumbnail should be scaled on width or height. // // Also append any default values to the map (e.g. "lossy", "lossless", ...) // $handler->normaliseParams( $file, $normalParams ); // // Check if this standard thumbnail size maps to the given width // if ( $normalParams['width'] == $params['width'] ) { // $match = true; // break; // } // } // if ( !$match ) { // return false; // not standard for description pages // } // } // // // Check that the given values for non-page, non-width, params are just defaults // foreach ( $params as $key => $value ) { // if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) { // return false; // } // } // // return true; // } // // /** // * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray). // * // * Values that exist in both values will be combined with += (all values of the array // * of $newValues will be added to the values of the array of $baseArray, while values, // * that exists in both, the value of $baseArray will be used). // * // * @param array $baseArray The array where you want to add the values of $newValues to // * @param array $newValues An array with new values // * @return array The combined array // * @since 1.26 // */ // function wfArrayPlus2d( array $baseArray, array $newValues ) { // // First merge items that are in both arrays // foreach ( $baseArray as $name => &$groupVal ) { // if ( isset( $newValues[$name] ) ) { // $groupVal += $newValues[$name]; // } // } // // Now add items that didn't exist yet // $baseArray += $newValues; // // return $baseArray; // } }