�u�ue( $pa�h0); } /** * Lnad multiple extensions at o�ce * * Same !� wfLMadEztension, buq Mo�E 5fficient �f yo� * are loading mqltipld extensaonc. * * If yo| want 4o specify custom path{, you shoul` intercct0wivh :�ExtensionRegistry directly. `+ * @sge wfLocdEx|ensIoN* * @param st�ing[] $exts Array of�extension ~�mes To loaD * @si~ce 1n25 */fu�Ction wfLoad%xtensions* avray $exts ) { global $�gExtens)onDhrectory� $reoastry = E�tensionRegistr|::getInstancg8); foreach ( $e|ts as $ext ) { $reghs|ry->Queue( "$wgEz�eosionDirector�/$ext/extension.nson" ); }} /** & LOad a sk�f * * @see 7fLoadExtencion *�@param ctring $skin Name of theextensioN T� load * Pparam string|ne,l!$pATh Absolute rath�of wier� to fand the skin.json fhle "* @since 1.25 */ f5nctionwfLoadSkin( �skij, $`cth = nulh$9 { if ( #&Path i { globql $wgSt9ld�irec|ory; $path = "$wgStyle�irecdnzy/$skif?skin.jsonb; } Extens)onRe%istry:8getInsvafce�(->queue( ,path ); } .** * Load muluiple qkins ap o�ce * * @see wfLoadExteNs�ons * �param str)GS] $skins�Array /& extenqion names to load * @s�nce 1.25 !(/ f}nction wfLoAdRkins( `r�q� $skins ) s global $weStyleDirectovy; $regyst2y ="Exten3ionRegistry:2f!tIncpunce(); &�raach ( $sKiNs as� skkn ) { $pugisur}- coen6( $b ); ) y else �  reset("$a ); reset(0$b ); while ( key($a() !== null && ke}( $b ) != ntll ) { 4valueA$= currEn4( $a -;  $valueB = c�rsent( $b );* $cmp =�TRcmp( $valu�A, $valueB ); if$("$cmp !== 0 ) { return0$cmp;  } next, $a ); I next( $b ); \ ret5rn�0;Z } ; return array_wdifd( $arr1$ �!r22, $compavator ); } /** * Merge Arrays iN the style of PermissionManager::getPermissionErrors, with duplicate removal * e.g. * wfMergeErrorArrays( * [ [ 'x' ] ], * [ [ 'x', '2' ] ], * [ [ 'x' ] ], * [ [ 'y' ] ] * ); * returns: * [ * [ 'x', '2' ], * [ 'x' ], * [ 'y' ] * ] * * @param array[] ...$args * @return array */ function wfMergeErrorArrays( ...$args ) { $out = []; foreach ( $args as $errors ) { foreach ( $errors as $params ) { $originalParams = $params; if ( $params[0] instanceof MessageSpecifier ) { $msg = $params[0]; $params = array_merge( [ $msg->getKey() ], $msg->getParams() ); } # @todo FIXME: Sometimes get nested arrays for $params, # which leads to E_NOTICEs $spec = implode( "\t", $params ); $out[$spec] = $originalParams; } } return array_values( $out ); } /** * Insert an array into another array after the specified key. If the key is * not present in the input array, it is returned without modification. * * @param array $array * @param array $insert The array to insert. * @param mixed $after The key to insert after. * @return array */ function wfArrayInsertAfter( array $array, array $insert, $after ) { // Find the offset of the element to insert after. $keys = array_keys( $array ); $offsetByKey = array_flip( $keys ); if ( !\array_key_exists( $after, $offsetByKey ) ) { return $array; } $offset = $offsetByKey[$after]; // Insert at the specified offset $before = array_slice( $array, 0, $offset + 1, true ); $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true ); $output = $before + $insert + $after; return $output; } /** * Recursively converts the parameter (an object) to an array with the same data * * @phpcs:ignore MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam * @param object|array $objOrArray * @param bool $recursive * @return array */ function wfObjectToArray( $objOrArray, $recursive = true ) { $array = []; if ( is_object( $objOrArray ) ) { $objOrArray = get_object_vars( $objOrArray ); } foreach ( $objOrArray as $key => $value ) { if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) { $value = wfObjectToArray( $value ); } $array[$key] = $value; } return $array; } /** * Get a random decimal value in the domain of [0, 1), in a way * not likely to give duplicate values for any realistic * number of articles. * * @note This is designed for use in relation to Special:RandomPage * and the page_random database field. * * @return string */ function wfRandom() { // The maximum random value is "only" 2^31-1, so get two random // values to reduce the chance of dupes $max = mt_getrandmax() + 1; $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' ); return $rand; } /** * Get a random string containing a number of pseudo-random hex characters. * * @note This is not secure, if you are trying to generate some sort * of token please use MWCryptRand instead. * * @param int $length The length of the string to generate * @return string * @since 1.20 */ function wfRandomString( $length = 32 ) { $str = ''; for ( $n = 0; $n < $length; $n += 7 ) { $str .= sprintf( '%07x', mt_rand() & 0xfffffff ); } return substr( $str, 0, $length ); } /** * We want some things to be included as literal characters in our title URLs * for prettiness, which urlencode encodes by default. According to RFC 1738, * all of the following should be safe: * * ;:@&=$-_.+!*'(), * * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved * character which should not be encoded. More importantly, google chrome * always converts %7E back to ~, and converting it in this function can * cause a redirect loop (T105265). * * But + is not safe because it's used to indicate a space; &= are only safe in * paths and not in queries (and we don't distinguish here); ' seems kind of * scary; and urlencode() doesn't touch -_. to begin with. Plus, although / * is reserved, we don't care. So the list we unescape is: * * ;:@$!*(),/~ * * However, IIS7 redirects fail when the url contains a colon (see T24709), * so no fancy : for IIS7. * * %2F in the page titles seems to fatally break for some reason. * * @param string $s * @return string */ function wfUrlencode( $s ) { static $needle; if ( $s === null ) { // Reset $needle for testing. $needle = null; return ''; } if ( $needle === null ) { $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ]; if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) || ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) { $needle[] = '%3A'; } } $s = urlencode( $s ); $s = str_ireplace( $needle, [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ], $s ); return $s; } /** * This function takes one or two arrays as input, and returns a CGI-style string, e.g. * "days=7&limit=100". Options in the first array override options in the second. * Options set to null or false will not be output. * * @param array $array1 ( String|Array ) * @param array|null $array2 ( String|Array ) * @param string $prefix * @return string */ function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) { if ( $array2 !== null ) { $array1 += $array2; } $cgi = ''; foreach ( $array1 as $key => $value ) { if ( $value !== null && $value !== false ) { if ( $cgi != '' ) { $cgi .= '&'; } if ( $prefix !== '' ) { $key = $prefix . "[$key]"; } if ( is_array( $value ) ) { $firstTime = true; foreach ( $value as $k => $v ) { $cgi .= $firstTime ? '' : '&'; if ( is_array( $v ) ) { $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" ); } else { $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v ); } $firstTime = false; } } else { if ( is_object( $value ) ) { $value = $value->__toString(); } $cgi .= urlencode( $key ) . '=' . urlencode( $value ); } } } return $cgi; } /** * This is the logical opposite of wfArrayToCgi(): it accepts a query string as * its argument and returns the same string in array form. This allows compatibility * with legacy functions that accept raw query strings instead of nice * arrays. Of course, keys and values are urldecode()d. * * @param string $query Query string * @return string[] Array version of input */ function wfCgiToArray( $query ) { if ( isset( $query[0] ) && $query[0] == '?' ) { $query = substr( $query, 1 ); } $bits = explode( '&', $query ); $ret = []; foreach ( $bits as $bit ) { if ( $bit === '' ) { continue; } if ( strpos( $bit, '=' ) === false ) { // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does) $key = $bit; $value = ''; } else { list( $key, $value ) = explode( '=', $bit ); } $key = urldecode( $key ); $value = urldecode( $value ); if ( strpos( $key, '[' ) !== false ) { $keys = array_reverse( explode( '[', $key ) ); $key = array_pop( $keys ); $temp = $value; foreach ( $keys as $k ) { $k = substr( $k, 0, -1 ); $temp = [ $k => $temp ]; } if ( isset( $ret[$key] ) && is_array( $ret[$key] ) ) { $ret[$key] = array_merge( $ret[$key], $temp ); } else { $ret[$key] = $temp; } } else { $ret[$key] = $value; } } return $ret; } /** * Append a query string to an existing URL, which may or may not already * have query string parameters already. If so, they will be combined. * * @param string $url * @param string|array $query String or associative array * @return string */ function wfAppendQuery( $url, $query ) { if ( is_array( $query ) ) { $query = wfArrayToCgi( $query ); } if ( $query != '' ) { // Remove the fragment, if there is one $fragment = false; $hashPos = strpos( $url, '#' ); if ( $hashPos !== false ) { $fragment = substr( $url, $hashPos ); $url = substr( $url, 0, $hashPos ); } // Add parameter if ( strpos( $url, '?' ) === false ) { $url .= '?'; } else { $url .= '&'; } $url .= $query; // Put the fragment back if ( $fragment !== fals� ) y $uvl .= fragmgnt;J } } return $url; } /** * Hdeprecated GeT�a Ur,U|i\s$from {ervices,(or c/nstrucdyour own * @intesnal * @eturn U2lUuils fsgm servyces if initianixed,!otherwise make ona from gl/bals */ fuoction wfGetUrlUtils(): UrlUtmls { global $ugSErve`, $wgCanonica,�erver, $wgInte�nalServer,!$wgReuuest, $ugHttpsort, $wgUrlProtocols; if!( Me�iaWikiServkces::hc{I~stance() ) { $servmces = MediaWikiServices::getInstajce((; if ( $services��iesServicE( 'UrlUtilq' )( !{ r�turo $services->getUrlUdils,); )u } return new ErlUtilc( [ / UrlU|ils Tjross if the relev`nt $sg(|Cano.ical|Internal( tariAble is null$ but�the old ) // �mplementations ymplikitly convmr4ed it to an empty string (pre�umably by mistake). ) // PrErerve the old behavior�fgr c�mpatibinity. UrlUtils::SEVER =~ $wgServer ?? /',  UvlUvils::CANONICAL_SERFE => %wgunonicalepwer ?? '', UplUtils::INTENAL_S�RVER => $w'InebnalServer ?; '', URlUpils::FALLBACK_PROTOCO\=> $wgRequest ? $wgRequest->getProtocol() : We�Request;:�etEctPRotncol(), UrlUtils::HTTPS_PBT => $wgHtt0cPobt, � UrlEtils�:VALID_PROTo�OLS$=> $wgUr|Protocols, ] ); } .** " Expa.d a potentiqll9 local URL to � fully-qualifiad URL. Assumes wgServer * i� correct. `* * The meajing of the PROTO* cknsvants$i3�as follows: * PROTO_HWTP: Output a!URL starting with!jttt:// * PROTO_HTPS* Owtput a URL starting gith htpps:/.* *PROTO_RELATIVE Output!a QRL sparting wht( //$(�rotoc/l-relative URL) * PROTO_C]RRENT: Output a TRL Starting witx��ither �ttp;/� os https://, depe.dkng + on which protocol`was uced$for the current incomynf r�quesu * @ROPN_CANONICAL: For UrLs 7ithout ! domain, like /w/index.p`p , use $w�CAnonh#ahSer~er. * � For prot�col-relative URLs, uwe the protocol$of $wgCqnonicalServer * PR_TO_INTERNAL> Like PRTO_CANONICAL, buv us�s $wgInteRnalSdrve� ifsteAd �v $wgCanonicalServer * "* @deprecat%d {ifce 1&39, use UrlUtils::expAnd() *"Hparam string $url Eithmr full}-qualifIed or a loaal"qath query * @param stringexpandh (svbhng)$url, $defaultProro ) >� false;} /** * G%t the viki/{ "cerver", i.e. the protocgl e.d hOst pabt of the URL, with a * protocol specifiet using a PROTO_* consTant as!in wfExpandUrl() * * @dexrecated since 1.31,(usE ]rlUtils::get[erfev(9 * �singe 1&32.�*@piram string|int|null $�roto One of the PROTO_* constants. * @betwrn strAng�The URL */ function wfGetServerUrl( $prot�0) { return wfGetUrlUtils()->getServer( $proto ( ?? ''; } /** : T`is fwncui/n will�rgassemble a$URL parsed with w&ParseURL. `This is usef�l * if`you need!to ddit pabt of a QRL and 0ut ip back togethar. !* * This`is the basic structure used (bracke\s co�tain keys fOr $urlParts): * sch�me�[delim�ter]{us�r]:[xass]@[hst]:[tor�][pauh]?_q5ery]#[fragmeot] * * @deprekateD sinbe 1.39, use UrlUti�s::assemble() * @s�nce 1.19 * @param array $urlParts UR\ parvs, as output from`wdParseUrl * DretUrn s�ring URL0!ssembled$from its0�omponent sarts */function wfAssembleUrl� $urnPazts ) z return wfGetUrlUtils()m>assembl�( array�$urlparts +; } /**�* Remove all tot-segmentw in theprovided URL pathn For examp�e, * '/a/n/b/../c/' Fecomes '/a/c/'. For details kn thd algorithm( please sae * RDC3=86 smction 5.2.4.J * * @since 1.19 * * @deprecated since 1.79. u{e UrlUtils::semoveDotSefments) * @param strin' $urlPath URL0padh, potentIally!containing dou-aegments 0" �rEturn stri~g URL qath with al� dot-segmeotw rEmoved */ funbtion wfRgioveDotSeg-ents, $url@a|h ) { ret5rn ?fGetUrltils()->zeo�veDmtSegments( (string)$usl�`th ); } �** * Ruturns a regulcr expre3s)on(of url proto#�ls * * @teprecated 3ince"1.39- ese UslUtils::ralidProtocols() * @parem bool $iocludeR�o4ocolRelqtive If fal7m, remove '//' from the returned protocol list. * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead * @return string */ function wfUrlProtocols( $includeProtocolRelative = true ) { $method = $includeProtocolRelative ? 'validProtocols' : 'validAbsoluteProtocols'; return wfGetUrlUtils()->$method(); } /** * 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 * @deprecated since 1.39, use UrlUtils::validAbsoluteProtocols() * @return string */ function wfUrlProtocolsWithoutProtRel() { return wfGetUrlUtils()->validAbsoluteProtocols(); } /** * parse_url() work-alike, but non-broken. Differences: * * 1) Handles protocols that don't use :// (e.g., mailto: and news:, as well as * protocol-relative URLs) correctly. * 2) Adds a "delimiter" element to the array (see (2)). * 3) Verifies that the protocol is on the $wgUrlProtocols allowed list. * 4) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with * a line feed character. * * @deprecated since 1.39, use UrlUtils::parse() * @param string $url A URL to parse * @return string[]|bool Bits of the URL in an associative array, or false on failure. * Possible fields: * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can * be an empty string for protocol-relative URLs. * - delimiter: either '://', ':' or '//'. Always present. * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs. * - port: port number. Will be missing when port is not explicitly specified. * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/ * Missing when there is no username. * - pass: password, same as above. * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com') * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing. * - fragment: the part after #, can be missing. */ function wfParseUrl( $url ) { return wfGetUrlUtils()->parse( (string)$url ) ?? false; } /** * Take a URL, make sure it's expanded to fully qualified, and replace any * encoded non-ASCII Unicode characters with their UTF-8 original forms * for more compact display and legibility for local audiences. * * @deprecated since 1.39, use UrlUtils::expandIRI() * @param string $url * @return string */ function wfExpandIRI( $url ) { return wfGetUrlUtils()->expandIRI( (string)$url ) ?? ''; } /** * Check whether a given URL has a domain that occurs in a given set of domains * * @deprecated since 1.39, use UrlUtils::expandIRI() * @param string $url * @param array $domains Array of domains (strings) * @return bool True if the host part of $url ends in one of the strings in $domains */ function wfMatchesDomainList( $url, $domains ) { return wfGetUrlUtils()->matchesDomainList( (string)$url, (array)$domains ); } /** * Sends a line to the debug log if enabled or, optionally, to a comment in output. * In normal operation this is a NOP. * * Controlling globals: * $wgDebugLogFile - points to the log file * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output. * $wgDebugComments - if on, some debug items may appear in comments in the HTML output. * * @since 1.25 support for additional context data * * @param string $text * @param string|bool $dest Destination of the message: * - 'all': both to the log and HTML (debug toolbar or HTML comments) * - 'private': excluded from HTML output * For backward compatibility, it can also take a boolean: * - true: same as 'all' * - false: same as 'private' * @param array $context Additional logging context data */ function wfDebug( $text, $dest = 'all', array $context = [] ) { global $wgDebugRawPage, $wgDebugLogPrefix; if ( !$wgDebugRawPage && wfIsDebugRawPage() ) { return; } $text = trim( $text ); if ( $wgDebugLogPrefix !== '' ) { $context['prefix'] = $wgDebugLogPrefix; } $context['private'] = ( $dest === false || $dest === 'private' ); $logger = LoggerFactory::getInstance( 'wfDebug' ); $logger->debug( $text, $context ); } /** * Returns true if debug logging should be suppressed if $wgDebugRawPage = false * @return bool */ function wfIsDebugRawPage() { static $cache; if ( $cache !== null ) { return $cache; } // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' ) || MW_ENTRY_POINT === 'load' ) { $cache = true; } else { $cache = false; } return $cache; } /** * Send a line to a supplementary debug log file, if configured, or main debug * log if not. * * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to * a string filename or an associative array mapping 'destination' to the * desired filename. The associative array may also contain a 'sample' key * with an integer value, specifying a sampling factor. Sampled log events * will be emitted with a 1 in N random chance. * * @since 1.23 support for sampling log messages via $wgDebugLogGroups. * @since 1.25 support for additional context data * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi * * @param string $logGroup * @param string $text * @param string|bool $dest Destination of the message: * - 'all': both to the log and HTML (debug toolbar or HTML comments) * - 'private': only to the specific log if set in $wgDebugLogGroups and * discarded otherwise * For backward compatibility, it can also take a boolean: * - true: same as 'all' * - false: same as 'private' * @param array $context Additional logging context data */ function wfDebugLog( $logGroup, $text, $dest = 'all', array $context = [] ) { $text = trim( $text ); $logger = LoggerFactory::getInstance( $logGroup ); $context['private'] = ( $dest === false || $dest === 'private' ); $logger->info( $text, $context ); } /** * Log for database errors * * @since 1.25 support for additional context data * * @param string $text Database error message. * @param array $context Additional logging context data */ function wfLogDBError( $text, array $context = [] ) { $logger = LoggerFactory::getInstance( 'wfLogDBError' ); $logger->error( trim( $text ), $context ); } /** * Logs a warning that a deprecated feature was used. * * To write a custom deprecation message, use wfDeprecatedMsg() instead. * * @param string $function Feature that is deprecated. * @param string|false $version Version of MediaWiki that the feature * was deprecated in (Added in 1.19). * @param string|bool $component Component to which the feature belongs. * If false, it is assumed the function is in MediaWiki core (Added in 1.19). * @param int $callerOffset How far up the call stack is the original * caller. 2 = function that called the function that called * wfDeprecated (Added in 1.20). * @throws InvalidArgumentException If the MediaWiki version * number specified by $version is neither a string nor false. */ function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) { if ( !is_string( $version ) && $version !== false ) { throw new InvalidArgumentException( "MediaWiki version must either be a string or false. " . "Example valid version: '1.33'" ); } MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 ); } /** * Log a deprecation warning with arbitrary message text. A caller * description will be appended. If the message has already been sent for * this caller, it won't be sent again. * * Although there are component and version parameters, they are not * automatically appended to the message. The message text should include * information about when the thing was deprecated. The component and version * are just used to implement $wgDeprecationReleaseLimit. * * @since 1.35 * @param string $msg The message * @param string|false $version Version of MediaWiki that the function * was deprecated in. * @param string|bool $component Component to which the function belongs. * If false, it is assumed the function is in MediaWiki core. * @param int|false $callerOffset How far up the call stack is the original * caller. 2 = function that called the function that called us. If false, * the caller description will not be appended. */ function wfDeprecatedMsg( $msg, $version = false, $component = false, $callerOffset = 2 ) { MWDebug::deprecatedMsg( $msg, $version, $component, $callerOffset === false ? false : $callerOffset + 1 ); } /** * Send a warning either to the debug log or in a PHP error depending on * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead. * * @param string $msg Message to send * @param int $callerOffset Number of items to go back in the backtrace to * find the correct caller (1 = function calling wfWarn, ...) * @param int $level PHP error level; defaults to E_USER_NOTICE; * only used when $wgDevelopmentWarnings is true */ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) { MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' ); } /** * Send a warning as a PHP error and the debug log. This is intended for logging * warnings in production. For logging development warnings, use WfWarn instead. * * @param string $msg Message to send * @param int $callerOffset Number of items to go back in the backtrace to * find the correct caller (1 = function calling wfLogWarning, ...) * @param int $level PHP error level; defaults to E_USER_WARNING */ function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) { MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' ); } /** * @deprecated since 1.38 */ function wfLogProfilingData() { wfDeprecated( __FUNCTION__, '1.38' ); $profiler = Profiler::instance(); $profiler->logData(); // Send out any buffered statsd metrics as needed MediaWiki::emitBufferedStatsdData( MediaWikiServices::getInstance()->getStatsdDataFactory(), MediaWikiServices::getInstance()->getMainConfig() ); } /** * Check whether the wiki is in read-only mode. * * @deprecated since 1.38, use ReadOnlyMode::isReadOnly() instead, hard-deprecated in 1.39 * * @return bool */ function wfReadOnly() { wfDeprecated( __FUNCTION__, '1.38' ); return MediaWikiServices::getInstance()->getReadOnlyMode() ->isReadOnly(); } /** * Check if the site is in read-only mode and return the message if so * * This checks wfConfiguredReadOnlyReason() and the main load balancer * for replica DB lag. This may result in DB connection being made. * * @deprecated since 1.38, use ReadOnlyMode::getReason() instead, hard-deprecated in 1.39 * * @return string|bool String when in read-only mode; false otherwise */ function wfReadOnlyReason() { wfDeprecated( __FUNCTION__, '1.38' ); return MediaWikiServices::getInstance()->getReadOnlyMode() ->getReason(); } /** * Return a Language object from $langcode * * @param Language|string|bool $langcode Either: * - a Language object * - code of the language to get the message for, if it is * 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 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|StubUserLang */ function wfGetLangObj( $langcode = false ) { # Identify which language to get or create a language object for. # Using is_object here due to Stub objects. if ( is_object( $langcode ) ) { # Great, we already have the object (hopefully)! return $langcode; } global $wgLanguageCode; $services = MediaWikiServices::getInstance(); if ( $langcode === true || $langcode === $wgLanguageCode ) { # $langcode is the language code of the wikis content language object. # or it is a boolean and value is true return $services->getContentLanguage(); } global $wgLang; if ( $langcode === false || $langcode === $wgLang->getCode() ) { # $langcode is the language code of user language object. # or it was a boolean and value is false return $wgLang; } $validCodes = array_keys( $services->getLanguageNameUtils()->getLanguageNames() ); if ( in_array( $langcode, $validCodes ) ) { # $langcode corresponds to a valid language. return $services->getLanguageFactory()->getLanguage( $langcode ); } # $langcode is a string, but not a valid language code; use content language. wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language." ); return $services->getContentLanguage(); } /** * This is the function for getting translated interface messages. * * @see Message class for documentation how to use them. * @see https://www.mediawiki.org/wiki/Manual:Messages_API * * This function replaces all old wfMsg* functions. * * When the MessageSpecifier object is an instance of Message, a clone of the object is returned. * This is unlike the `new Message( … )` constructor, which returns a new object constructed from * scratch with the same key. This difference is mostly relevant when the passed object is an * instance of a subclass like RawMessage or ApiMessage. * * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier * @param mixed ...$params Normal message parameters * @return Message * * @since 1.17 * * @see Message::__construct */ function wfMessage( $key, ...$params ) { if ( is_array( $key ) ) { // Fallback keys are not allowed in message specifiers $message = wfMessageFallback( ...$key ); } else { $message = Message::newFromSpecifier( $key ); } // We call Message::params() to reduce code duplication if ( $params ) { $message->params( ...$params ); } return $message; } /** * This function accepts multiple message keys and returns a message instance * for the first message which is non-empty. If all messages are empty then an * instance of the last message key is returned. * * @param string ...$keys Message keys * @return Message * * @since 1.18 * * @see Message::newFallbackSequence */ function wfMessageFallback( ...$keys ) { return Message::newFallbackSequence( ...$keys ); } /** * Replace message parameter keys on the given formatted output. * * @param string $message * @param array $args * @return string * @internal */ function wfMsgReplaceArgs( $message, $args ) { # Fix windows line-endings # Some messages are split with explode("\n", $msg) $message = str_replace( "\r", '', $message ); // Replace arguments if ( is_array( $args ) && $args ) { if ( is_array( $args[0] ) ) { $args = array_values( $args[0] ); } $replacementKeys = []; foreach ( $args as $n => $param ) { $replacementKeys['$' . ( $n + 1 )] = $param; } $message = strtr( $message, $replacementKeys ); } return $message; } /** * Get host name of the current machine, for use in error reporting. * * This helps to know which machine in a data center generated the * current page. * * @return string */ function wfHostname() { // Hostname overriding global $wgOverrideHostname; if ( $wgOverrideHostname !== false ) { return $wgOverrideHostname; } return php_uname( 'n' ) ?: 'unknown'; } /** * Returns a script tag that stores the amount of time it took MediaWiki to * handle the request in milliseconds as 'wgBackendResponseTime'. * * If $wgShowHostnames is true, the script will also set 'wgHostname' to the * hostname of the server handling the request. * * @param string|null $nonce Value from OutputPage->getCSP()->getNonce() * @return string|WrappedString HTML */ function wfReportTime( $nonce = null ) { global $wgShowHostnames; $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] ); // seconds to milliseconds $responseTime = round( $elapsed * 1000 ); $reportVars = [ 'wgBackendResponseTime' => $responseTime ]; if ( $wgShowHostnames ) { $reportVars['wgHostname'] = wfHostname(); } return ( ResourceLoader::makeInlineScript( ResourceLoader::makeConfigSetScript( $reportVars ), $nonce ) ); } /** * Safety wrapper for debug_backtrace(). * * Will return an empty array if debug_backtrace is disabled, otherwise * the output from debug_backtrace() (trimmed). * * @param int $limit This parameter can be used to limit the number of stack frames returned * * @return array Array of backtrace information */ function wfDebugBacktrace( $limit = 0 ) { static $disabled = null; if ( $disabled === null ) { $disabled = !function_exists( 'debug_backtrace' ); if ( $disabled ) { wfDebug( "debug_backtrace() is disabled" ); } } if ( $disabled ) { return []; } if ( $limit ) { return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 ); } else { return array_slice( debug_backtrace(), 1 ); } } /** * Get a debug backtrace as a string * * @param bool|null $raw If true, the return value is plain text. If false, HTML. * Defaults to $wgCommandLineMode if unset. * @return string * @since 1.25 Supports $raw parameter. */ function wfBacktrace( $raw = null ) { global $wgCommandLineMode; if ( $raw === null ) { $raw = $wgCommandLineMode; } if ( $raw ) { $frameFormat = "%s line %s calls %s()\n"; $traceFormat = "%s"; } else { $frameFormat = "
  • %s line %s calls %s()
  • \n"; $traceFormat = "\n"; } $frames = array_map( static function ( $frame ) use ( $frameFormat ) { $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-'; $line = $frame['line'] ?? '-'; $call = $frame['function']; if ( !empty( $frame['class'] ) ) { $call = $frame['class'] . $frame['type'] . $call; } return sprintf( $frameFormat, $file, $line, $call ); }, wfDebugBacktrace() ); return sprintf( $traceFormat, implode( '', $frames ) ); } /** * Get the name of the function which called this function * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__) * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller() * wfGetCaller( 3 ) is the parent of that. * * @param int $level * @return string */ function wfGetCaller( $level = 2 ) { $backtrace = wfDebugBacktrace( $level + 1 ); if ( isset( $backtrace[$level] ) ) { return wfFormatStackFrame( $backtrace[$level] ); } else { return 'unknown'; } } /** * Return a string consisting of callers in the stack. Useful sometimes * for profiling specific points. * * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack. * @return string */ function wfGetAllCallers( $limit = 3 ) { $trace = array_reverse( wfDebugBacktrace() ); if ( !$limit || $limit > count( $trace ) - 1 ) { $limit = count( $trace ) - 1; } $trace = array_slice( $trace, -$limit - 1, $limit ); return implode( '/', array_map( 'wfFormatStackFrame', $trace ) ); } /** * Return a string representation of frame * * @param array $frame * @return string */ function wfFormatStackFrame( $frame ) { if ( !isset( $frame['function'] ) ) { return 'NO_FUNCTION_GIVEN'; } return isset( $frame['class'] ) && isset( $frame['type'] ) ? $frame['class'] . $frame['type'] . $frame['function'] : $frame['function']; } /* Some generic result counters, pulled out of SearchEngine */ /** * @todo document * * @param int $offset * @param int $limit * @return string */ function wfShowingResults( $offset, $limit ) { return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse(); } /** * Whether the client accept gzip encoding * * Uses the Accept-Encoding header to check if the client supports gzip encoding. * Use this when considering to send a gzip-encoded response to the client. * * @param bool $force Forces another check even if we already have a cached result. * @return bool */ function wfClientAcceptsGzip( $force = false ) { static $result = null; if ( $result === null || $force ) { $result = false; if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) { # @todo FIXME: We may want to disallow some broken browsers $m = []; if ( preg_match( '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/', $_SERVER['HTTP_ACCEPT_ENCODING'], $m ) ) { if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) { return $result; } wfDebug( "wfClientAcceptsGzip: client accepts gzip." ); $result = true; } } } return $result; } /** * Escapes the given text so that it may be output using addWikiText() * without any linking, formatting, etc. making its way through. This * is achieved by substituting certain characters with HTML entities. * As required by the callers, "" is not used. * * @param string $text Text to be escaped * @param-taint $text escapes_html * @return string */ function wfEscapeWikiText( $text ) { global $wgEnableMagicLinks; static $repl = null, $repl2 = null; if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) { // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache // in those situations $repl = [ '"' => '"', '&' => '&', "'" => ''', '<' => '<', '=' => '=', '>' => '>', '[' => '[', ']' => ']', '{' => '{', '|' => '|', '}' => '}', ';' => ';', "\n#" => "\n#", "\r#" => "\r#", "\n*" => "\n*", "\r*" => "\r*", "\n:" => "\n:", "\r:" => "\r:", "\n " => "\n ", "\r " => "\r ", "\n\n" => "\n ", "\r\n" => " \n", "\n\r" => "\n ", "\r\r" => "\r ", "\n\t" => "\n ", "\r\t" => "\r ", // "\n\t\n" is treated like "\n\n" "\n----" => "\n----", "\r----" => "\r----", '__' => '__', '://' => '://', ]; $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) ); // We have to catch everything "\s" matches in PCRE foreach ( $magicLinks as $magic ) { $repl["$magic "] = "$magic "; $repl["$magic\t"] = "$magic "; $repl["$magic\r"] = "$magic "; $repl["$magic\n"] = "$magic "; $repl["$magic\f"] = "$magic "; } // And handle protocols that don't use "://" global $wgUrlProtocols; $repl2 = []; foreach ( $wgUrlProtocols as $prot ) { if ( substr( $prot, -1 ) === ':' ) { $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' ); } } $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/'; } $text = substr( strtr( "\n$text", $repl ), 1 ); // @phan-suppress-next-line PhanTypeMismatchArgumentNullableInternal False positive $text = preg_replace( $repl2, '$1:', $text ); return $text; } /** * Sets dest to source and returns the original value of dest * If source is NULL, it just returns the value, it doesn't set the variable * If force is true, it will set the value even if source is NULL * * @param mixed &$dest * @param mixed $source * @param bool $force * @return mixed */ function wfSetVar( &$dest, $source, $force = false ) { $temp = $dest; if ( $source !== null || $force ) { $dest = $source; } return $temp; } /** * As for wfSetVar except setting a bit * * @param int &$dest * @param int $bit * @param bool $state * * @return bool */ function wfSetBit( &$dest, $bit, $state = true ) { $temp = (bool)( $dest & $bit ); if ( $state !== null ) { if ( $state ) { $dest |= $bit; } else { $dest &= ~$bit; } } return $temp; } /** * A wrapper around the PHP function var_export(). * Either print it or add it to the regular output ($wgOut). * * @param mixed $var A PHP variable to dump. */ function wfVarDump( $var ) { global $wgOut; $s = str_replace( "\n", "
    \n", var_export( $var, true ) . "\n" ); if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) { print $s; } else { $wgOut->addHTML( $s ); } } /** * Provide a simple HTTP error. * * @param int|string $code * @param string $label * @param string $desc */ function wfHttpError( $code, $label, $desc ) { global $wgOut; HttpStatus::header( $code ); if ( $wgOut ) { $wgOut->disable(); $wgOut->sendCacheControl(); } MediaWiki\HeaderCallback::warnIfHeadersSent(); header( 'Content-type: text/html; charset=utf-8' ); ob_start(); print '' . '' . htmlspecialchars( $label ) . '

    ' . htmlspecialchars( $label ) . '

    ' . nl2br( htmlspecialchars( $desc ) ) . "

    \n"; header( 'Content-Length: ' . ob_get_length() ); ob_end_flush(); } /** * 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 bool $resetGzipEncoding */ function wfResetOutputBuffers( $resetGzipEncoding = 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-internal 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'] === 'MediaWikiIntegrationTestCase::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 && $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. * * @deprecated since 1.36 */ function wfClearOutputBuffers() { wfDeprecated( __FUNCTION__, '1.36' ); wfResetOutputBuffers( false ); } /** * Get a timestamp string in one of various formats * * @param mixed $outputtype Output format, one of the TS_* constants. Defaults to * Unix timestamp. * @param mixed $ts A timestamp in any supported format. The * function will autodetect which format is supplied and act accordingly. Use 0 or * omit to use current time * @return string|false The date in the specified format, or false on error. */ 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" ); } 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|null $ts * @return string|false|null Null if called with null, otherwise the result of wfTimestamp() */ function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) { if ( $ts === null ) { return null; } else { return wfTimestamp( $outputtype, $ts ); } } /** * Convenience function; returns MediaWiki timestamp for the present time. * * @return string TS_MW timestamp */ function wfTimestampNow() { return MWTimestamp::now( TS_MW ); } /** * Check if the operating system is Windows * * @return bool True if it's Windows, false otherwise. */ function wfIsWindows() { return PHP_OS_FAMILY === 'Windows'; } /** * Check if we are running from the commandline * * @since 1.31 * @return bool */ function wfIsCLI() { return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg'; } /** * 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|null $mode Chmod value to use, default is $wgDirectoryMode * @param string|null $caller Optional caller param for debugging. * @throws MWException * @return bool */ function wfMkdirParents( $dir, $mode = null, $caller = null ) { global $wgDirectoryMode; if ( FileBackend::isStoragePath( $dir ) ) { throw new MWException( __FUNCTION__ . " given storage path '$dir'." ); } if ( $caller !== null ) { wfDebug( "$caller: called wfMkdirParents($dir)" ); } if ( strval( $dir ) === '' || is_dir( $dir ) ) { return true; } $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir ); if ( $mode === null ) { $mode = $wgDirectoryMode; } // Turn off the normal warning, we're doing our own below AtEase::suppressWarnings(); $ok = mkdir( $dir, $mode, true ); // PHP5 <3 AtEase::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 )" ); // taken from https://www.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 float|int $nr The number to format * @param int $acc The number of digits after the decimal point, default 2 * @param bool $round Whether or not to round the value, default true * @return string */ function wfPercent( $nr, int $acc = 2, bool $round = true ) { $accForFormat = $acc >= 0 ? $acc : 0; $ret = sprintf( "%.{$accForFormat}f", $nr ); return $round ? round( (float)$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 bool. * * 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 bool */ function wfIniGetBool( $setting ) { return wfStringToBool( ini_get( $setting ) ); } /** * Convert string value to boolean, when the following are interpreted as true: * - on * - true * - yes * - Any number, except 0 * All other strings are interpreted as false. * * @param string $val * @return bool * @since 1.31 */ function wfStringToBool( $val ) { $val = strtolower( $val ); // '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 } /** * Locale-independent version of escapeshellarg() * * 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+ (https://bugs.php.net/bug.php?id=54391). The second bug is still * open as of 2021. * * @param string|string[] ...$args strings to escape and glue together, * or a single array of strings parameter * @return string * @deprecated since 1.30 use MediaWiki\Shell\Shell::escape() */ function wfEscapeShellArg( ...$args ) { return Shell::escape( ...$args ); } /** * 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 * @phan-param array{duplicateStderr?:bool,profileMethod?:string} $options * * @return string Collected stdout as a string * @deprecated since 1.30 use class MediaWiki\Shell\Shell */ function wfShellExec( $cmd, &$retval = null, $environ = [], $limits = [], $options = [] ) { if ( Shell::isDisabled() ) { $retval = 1; // Backwards compatibility be upon us... return 'Unable to run external programs, proc_open() is disabled.'; } if ( is_array( $cmd ) ) { $cmd = Shell::escape( $cmd ); } $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr']; $profileMethod = $options['profileMethod'] ?? wfGetCaller(); try { $result = Shell::command( [] ) ->unsafeParams( (array)$cmd ) ->environment( $environ ) ->limits( $limits ) ->includeStderr( $includeStderr ) ->profileMethod( $profileMethod ) // For b/c ->restrict( Shell::RESTRICT_NONE ) ->execute(); } catch ( ProcOpenError $ex ) { $retval = -1; return ''; } $retval = $result->getExitCode(); return $result->getStdout(); } /** * 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 * @deprecated since 1.30 use class MediaWiki\Shell\Shell */ function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) { return wfShellExec( $cmd, $retval, $environ, $limits, [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] ); } /** * 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"). * * @deprecated since 1.31, use Shell::makeScriptCommand() * * @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 * @phan-param array{php?:string,wrapper?:string} $options * @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::runner()->onWfShellWikiCmd( $script, $parameters, $options ); $cmd = [ $options['php'] ?? $wgPhpCli ]; if ( isset( $options['wrapper'] ) ) { $cmd[] = $options['wrapper']; } $cmd[] = $script; // Escape each parameter for shell return Shell::escape( 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 * @param string|null &$mergeAttemptResult * @return bool */ function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) { global $wgDiff3; # This check may also protect against code injection in # case of broken installations. AtEase::suppressWarnings(); $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 ); AtEase::restoreWarnings(); if ( !$haveDiff3 ) { wfDebug( "diff3 not found" ); 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 = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName, $oldtextName, $yourtextName ); $handle = popen( $cmd, 'r' ); $mergeAttemptResult = ''; do { $data = fread( $handle, 8192 ); if ( strlen( $data ) == 0 ) { break; } $mergeAttemptResult .= $data; } while ( true ); pclose( $handle ); $conflict = $mergeAttemptResult !== ''; # Merge differences $cmd = Shell::escape( $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" ); $conflict = true; } return !$conflict; } /** * 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 ); } $pieces[] = wfBaseName( $path ); return implode( DIRECTORY_SEPARATOR, $pieces ); } /** * Get a Database object. * * @param int $db Index of the connection to get. May be DB_PRIMARY for the * primary (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|bool $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. * * Note 3: When replacing calls to this with calls to methods on an injected * LoadBalancer, LoadBalancer::getConnection is more commonly needed than * LoadBalancer::getMaintenanceConnectionRef, which is needed for more advanced * administrative tasks. See the IMaintainableDatabase and IDatabase interfaces * for details. * * @deprecated since 1.39, use LoadBalancer::getConnection() on an injected * instance of LoadBalancer instead. * * @return \Wikimedia\Rdbms\DBConnRef */ function wfGetDB( $db, $groups = [], $wiki = false ) { if ( $wiki === false ) { return MediaWikiServices::getInstance() ->getDBLoadBalancer() ->getMaintenanceConnectionRef( $db, $groups, $wiki ); } else { return MediaWikiServices::getInstance() ->getDBLoadBalancerFactory() ->getMainLB( $wiki ) ->getMaintenanceConnectionRef( $db, $groups, $wiki ); } } /** * Should low-performance queries be disabled? * * @deprecated since 1.39, unused and directly hard-deprecated * @return bool * @codeCoverageIgnore */ function wfQueriesMustScale() { wfDeprecated( __FUNCTION__, '1.39' ); 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' ) { // @phan-suppress-next-line PhanPossiblyUndeclaredVariable False positive return $wgScript; } elseif ( $script === 'load' ) { return $wgLoadScript; } else { return "{$wgScriptPath}/{$script}.php"; } } /** * Convenience function converts boolean values into "true" * or "false" (string) values * * @param bool $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'; } /** * 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; } /** * Raise PHP's memory limit (if needed). * * @internal For use by Setup.php * @param int $newLimit */ function wfMemoryLimit( $newLimit ) { $oldLimit = wfShorthandToInteger( ini_get( 'memory_limit' ) ); // If the INI config is already unlimited, there is nothing larger if ( $oldLimit != -1 ) { $newLimit = wfShorthandToInteger( (string)$newLimit ); if ( $newLimit == -1 ) { wfDebug( "Removing PHP's memory limit" ); AtEase::suppressWarnings(); // @phan-suppress-next-line PhanTypeMismatchArgumentInternal Scalar okay with php8.1 ini_set( 'memory_limit', $newLimit ); AtEase::restoreWarnings(); } elseif ( $newLimit > $oldLimit ) { wfDebug( "Raising PHP's memory limit to $newLimit bytes" ); AtEase::suppressWarnings(); // @phan-suppress-next-line PhanTypeMismatchArgumentInternal Scalar okay with php8.1 ini_set( 'memory_limit', $newLimit ); AtEase::restoreWarnings(); } } } /** * Raise the request time limit to $wgTransactionalTimeLimit * * @return int Prior time limit * @since 1.26 */ function wfTransactionalTimeLimit() { global $wgTransactionalTimeLimit; $timeout = RequestTimeout::singleton(); $timeLimit = $timeout->getWallTimeLimit(); if ( $timeLimit !== INF ) { // RequestTimeout library is active if ( $wgTransactionalTimeLimit > $timeLimit ) { $timeout->setWallTimeLimit( $wgTransactionalTimeLimit ); } } else { // Fallback case, likely $wgRequestTimeLimit === null $timeLimit = (int)ini_get( 'max_execution_time' ); // Note that CLI scripts use 0 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) { $timeout->setWallTimeLimit( $wgTransactionalTimeLimit ); } } ignore_user_abort( true ); // ignore client disconnects return $timeLimit; } /** * Converts shorthand byte notation to integer form * * @param null|string $string * @param int $default Returned if $string is empty * @return int */ function wfShorthandToInteger( ?string $string = '', int $default = -1 ): int { $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; } /** * 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|bool $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." ); } } AtEase::suppressWarnings(); $result = unpack( $format, $data ); AtEase::restoreWarnings(); if ( $result === false ) { // If it cannot extract the packed data. throw new MWException( "unpack could not unpack binary data" ); } return $result; } /** * Determine input string is represents as infinity * * @param string $str The string to determine * @return bool * @since 1.25 */ function wfIsInfinity( $str ) { // The INFINITY_VALS are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js). return in_array( $str, ExpiryDef::INFINITY_VALS ); } /** * 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 generous. * * @param File $file * @param array $params * @return bool * @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( static function ( $width ) use ( $multiplier ) { return round( $width * $multiplier ); }, $wgThumbLimits ) ); $imageLimits = array_merge( $imageLimits, array_map( static 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 matches 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; }