die( "This file is part of MediaWiki, it is not a valid entry point" );
}
-require_once dirname( __FILE__ ) . '/normal/UtfNormalUtil.php';
+if ( !defined( 'MW_COMPILED' ) ) {
+ require_once( dirname( __FILE__ ) . '/normal/UtfNormalUtil.php' );
+}
// Hide compatibility functions from Doxygen
/// @cond
if ( ( $wgDebugComments || $wgShowDebug ) && !$logonly ) {
$cache[] = $text;
- if ( isset( $wgOut ) && StubObject::isRealObject( $wgOut ) ) {
+ if ( isset( $wgOut ) && is_object( $wgOut ) ) {
// add the message and any cached messages to the output
array_map( array( $wgOut, 'debug' ), $cache );
$cache = array();
}
}
+/**
+ * Get microsecond timestamps for debug logs
+ *
+ * @return string
+ */
function wfDebugTimer() {
global $wgDebugTimestamps;
if ( !$wgDebugTimestamps ) {
/**
* Send a line giving PHP memory usage.
+ *
* @param $exact Bool: print exact values instead of kilobytes (default: false)
*/
function wfDebugMem( $exact = false ) {
/**
* Log for database errors
+ *
* @param $text String: database error message.
*/
function wfLogDBError( $text ) {
*
* Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
* send lines to the specified port, prefixed by the specified prefix and a space.
+ *
+ * @param $text String
+ * @param $file String filename
*/
function wfErrorLog( $text, $file ) {
if ( substr( $file, 0, 4 ) == 'udp:' ) {
$exists = file_exists( $file );
$size = $exists ? filesize( $file ) : false;
if ( !$exists || ( $size !== false && $size + strlen( $text ) < 0x7fffffff ) ) {
- error_log( $text, 3, $file );
+ file_put_contents( $file, $text, FILE_APPEND );
}
wfRestoreWarnings();
}
*/
function wfLogProfilingData() {
global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
- global $wgProfiler, $wgProfileLimit, $wgUser;
+ global $wgProfileLimit, $wgUser;
+
+ $profiler = Profiler::instance();
+
# Profiling must actually be enabled...
- if( is_null( $wgProfiler ) ) {
+ if ( $profiler->isStub() ) {
return;
}
- # Get total page request time
+
+ // Get total page request time and only show pages that longer than
+ // $wgProfileLimit time (default is 0)
$now = wfTime();
$elapsed = $now - $wgRequestTime;
- # Only show pages that longer than $wgProfileLimit time (default is 0)
- if( $elapsed <= $wgProfileLimit ) {
+ if ( $elapsed <= $wgProfileLimit ) {
return;
}
- $prof = wfGetProfilingOutput( $wgRequestTime, $elapsed );
+
+ $profiler->logData();
+
+ // Check whether this should be logged in the debug file.
+ if ( $wgDebugLogFile == '' || ( $wgRequest->getVal( 'action' ) == 'raw' && !$wgDebugRawPage ) ) {
+ return;
+ }
+
$forward = '';
- if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
+ if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
$forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
}
- if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
+ if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
$forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
}
- if( !empty( $_SERVER['HTTP_FROM'] ) ) {
+ if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
$forward .= ' from ' . $_SERVER['HTTP_FROM'];
}
- if( $forward ) {
+ if ( $forward ) {
$forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
}
- // Don't unstub $wgUser at this late stage just for statistics purposes
+ // Don't load $wgUser at this late stage just for statistics purposes
// FIXME: We can detect some anons even if it is not loaded. See User::getId()
- if( $wgUser->mDataLoaded && $wgUser->isAnon() ) {
+ if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
$forward .= ' anon';
}
$log = sprintf( "%s\t%04.3f\t%s\n",
gmdate( 'YmdHis' ), $elapsed,
urldecode( $wgRequest->getRequestURL() . $forward ) );
- if ( $wgDebugLogFile != '' && ( $wgRequest->getVal( 'action' ) != 'raw' || $wgDebugRawPage ) ) {
- wfErrorLog( $log . $prof, $wgDebugLogFile );
- }
+
+ wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
}
/**
* Check if the wiki read-only lock file is present. This can be used to lock
* off editing functions, but doesn't guarantee that the database will not be
* modified.
+ *
* @return bool
*/
function wfReadOnly() {
/**
* Return a Language object from $langcode
+ *
* @param $langcode Mixed: either:
* - a Language object
* - code of the language to get the message for, if it is
* in many ways, especially regarding to text direction. There is lots stuff
* to fix, hence this function to keep the old behaviour unless the global
* $wgBetterDirectionality is enabled (or removed when everything works).
+ *
+ * @return Language
*/
function wfUILang() {
global $wgBetterDirectionality;
* 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 first message key is returned.
- * Varargs: message keys
- * @return \type{Message}
+ * @param varargs: message keys
+ * @return Message
* @since 1.18
*/
function wfMessageFallback( /*...*/ ) {
$args = func_get_args();
- return call_user_func_array( array( 'Message', 'newFallbackSequence' ), $args );
+ return MWFunction::callArray( 'Message::newFallbackSequence', $args );
}
/**
* This function also takes extra optional parameters (not
* shown in the function definition), which can be used to
* insert variable text into the predefined message.
+ * @return String
*/
function wfMsg( $key ) {
$args = func_get_args();
/**
* Same as above except doesn't transform the message
+ *
+ * @param $key String
+ * @return String
*/
function wfMsgNoTrans( $key ) {
$args = func_get_args();
* order to, e.g., fix a link in every possible language.
*
* @param $key String: lookup key for the message, usually
- * defined in languages/Language.php
+ * defined in languages/Language.php
+ * @return String
*/
function wfMsgForContent( $key ) {
global $wgForceUIMsgAsContentMsg;
/**
* Same as above except doesn't transform the message
+ *
+ * @param $key String
+ * @return String
*/
function wfMsgForContentNoTrans( $key ) {
global $wgForceUIMsgAsContentMsg;
/**
* Get a message from the language file, for the UI elements
+ *
+ * @deprecated in 1.18; use wfMessage()
*/
function wfMsgNoDB( $key ) {
+ wfDeprecated( __FUNCTION__ );
$args = func_get_args();
array_shift( $args );
return wfMsgReal( $key, $args, false );
/**
* Get a message from the language file, for the content
+ *
+ * @deprecated in 1.18; use wfMessage()
*/
function wfMsgNoDBForContent( $key ) {
+ wfDeprecated( __FUNCTION__ );
global $wgForceUIMsgAsContentMsg;
$args = func_get_args();
array_shift( $args );
/**
* Really get a message
+ *
* @param $key String: key to get.
* @param $args
* @param $useDB Boolean
* @param $key String
*/
function wfMsgWeirdKey( $key ) {
+ wfDeprecated( __FUNCTION__ );
$source = wfMsgGetKey( $key, false, true, false );
if ( wfEmptyMsg( $key ) ) {
return '';
/**
* Fetch a message string value, but don't replace any keys yet.
+ *
* @param $key String
* @param $useDB Bool
* @param $langCode String: Code of the language to get the message for, or
* @return string
*/
function wfMsgWikiHtml( $key ) {
- global $wgOut;
$args = func_get_args();
array_shift( $args );
- return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
+ return wfMsgReplaceArgs(
+ MessageCache::singleton()->parse( wfMsgGetKey( $key, true ), null, /* can't be set to false */ true )->getText(),
+ $args );
}
/**
* <i>content</i>: fetch message for content language instead of interface
* Also can accept a single associative argument, of the form 'language' => 'xx':
* <i>language</i>: Language object or language code to fetch message for
- * (overriden by <i>content</i>), its behaviour with parse, parseinline
- * and parsemag is undefined.
+ * (overriden by <i>content</i>).
* Behavior for conflicting options (e.g., parse+parseinline) is undefined.
+ *
+ * @return String
*/
function wfMsgExt( $key, $options ) {
- global $wgOut;
-
$args = func_get_args();
array_shift( $args );
array_shift( $args );
$string = wfMsgReplaceArgs( $string, $args );
}
+ $messageCache = MessageCache::singleton();
if( in_array( 'parse', $options, true ) ) {
- $string = $wgOut->parse( $string, true, !$forContent, $langCodeObj );
+ $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
} elseif ( in_array( 'parseinline', $options, true ) ) {
- $string = $wgOut->parse( $string, true, !$forContent, $langCodeObj );
+ $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
$m = array();
if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
$string = $m[1];
}
} elseif ( in_array( 'parsemag', $options, true ) ) {
- $string = MessageCache::singleton()->transform( $string,
+ $string = $messageCache->transform( $string,
!$forContent, $langCodeObj );
}
return $string;
}
-
/**
- * Just like exit() but makes a note of it.
- * Commits open transactions except if the error parameter is set
+ * Print an error message and die, returning nonzero to the shell if any. Plain die()
+ * fails to return nonzero to the shell if you pass a string. Entry points may customise
+ * this function to return a prettier error message, but implementations must not assume
+ * access to any of the usual MediaWiki infrastructure (AutoLoader, localisation, database,
+ * etc). This should not be called directly once $wgFullyInitialised is set; instead,
+ * throw an exception and let Exception.php handle whether or not it's possible to show
+ * a prettier error.
*
- * @deprecated Please return control to the caller or throw an exception. Will
- * be removed in 1.19.
- */
-function wfAbruptExit( $error = false ) {
- static $called = false;
- if ( $called ) {
- exit( -1 );
- }
- $called = true;
-
- wfDeprecated( __FUNCTION__ );
- $bt = wfDebugBacktrace();
- if( $bt ) {
- for( $i = 0; $i < count( $bt ); $i++ ) {
- $file = isset( $bt[$i]['file'] ) ? $bt[$i]['file'] : 'unknown';
- $line = isset( $bt[$i]['line'] ) ? $bt[$i]['line'] : 'unknown';
- wfDebug( "WARNING: Abrupt exit in $file at line $line\n");
- }
- } else {
- wfDebug( "WARNING: Abrupt exit\n" );
- }
-
- wfLogProfilingData();
-
- if ( !$error ) {
- wfGetLB()->closeAll();
- }
- exit( -1 );
-}
-
-/**
- * @deprecated Please return control the caller or throw an exception. Will
- * be removed in 1.19.
- */
-function wfErrorExit() {
- wfDeprecated( __FUNCTION__ );
- wfAbruptExit( true );
-}
-
-/**
- * Print a simple message and die, returning nonzero to the shell if any.
- * Plain die() fails to return nonzero to the shell if you pass a string.
* @param $msg String
*/
-function wfDie( $msg = '' ) {
- echo $msg;
- die( 1 );
+if( !function_exists( 'wfDie' ) ){
+ function wfDie( $msg = '' ) {
+ echo $msg;
+ die( 1 );
+ }
}
/**
* Fetch server name for use in error reporting etc.
* Use real server name if available, so we know which machine
* in a server farm generated the current page.
+ *
* @return string
*/
function wfHostname() {
/**
* Returns a HTML comment with the elapsed time since request.
* This method has no side effects.
+ *
* @return string
*/
function wfReportTime() {
return array_slice( debug_backtrace(), 1 );
}
+/**
+ * Get a debug backtrace as a string
+ *
+ * @return string
+ */
function wfBacktrace() {
global $wgCommandLineMode;
/**
* @todo document
+ *
+ * @param $offset Int
+ * @param $limit Int
+ * @return String
*/
function wfShowingResults( $offset, $limit ) {
global $wgLang;
/**
* @todo document
+ *
+ * @param $offset Int
+ * @param $limit Int
+ * @param $num Int
+ * @return String
*/
function wfShowingResultsNum( $offset, $limit, $num ) {
global $wgLang;
/**
* Generate (prev x| next x) (20|50|100...) type links for paging
+ *
* @param $offset String
* @param $limit Integer
* @param $link String
* @param $query String: optional URL query parameter string
* @param $atend Bool: optional param for specified if this is the last page
+ * @return String
*/
function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
global $wgLang;
/**
* Generate links for (20|50|100...) items-per-page links
+ *
* @param $offset String
* @param $limit Integer
* @param $title Title
* @todo document
* @todo FIXME: we may want to blacklist some broken browsers
*
+ * @param $force Bool
* @return bool Whereas client accept gzip compression
*/
function wfClientAcceptsGzip( $force = false ) {
* Obtain the offset and limit values from the request string;
* used in special pages
*
- * @param $deflimit Default limit if none supplied
- * @param $optionname Name of a user preference to check against
+ * @param $deflimit Int default limit if none supplied
+ * @param $optionname String Name of a user preference to check against
* @return array
*
*/
* As required by the callers, <nowiki> is not used.
*
* @param $text String: text to be escaped
+ * @return String
*/
function wfEscapeWikiText( $text ) {
$text = strtr( "\n$text", array(
}
/**
- * @todo document
- * @return float
+ * Get the current unix timetstamp with microseconds. Useful for profiling
+ * @return Float
*/
function wfTime() {
return microtime( true );
* 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 $dest Mixed
+ * @param $source Mixed
+ * @param $force Bool
+ * @return Mixed
*/
function wfSetVar( &$dest, $source, $force = false ) {
$temp = $dest;
/**
* As for wfSetVar except setting a bit
+ *
+ * @param $dest Int
+ * @param $bit Int
+ * @param $state Bool
*/
function wfSetBit( &$dest, $bit, $state = true ) {
$temp = (bool)( $dest & $bit );
* This function takes 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 "" will not be output.
+ *
+ * @param $array1 Array( String|Array )
+ * @param $array2 Array( String|Array )
+ * @return String
*/
function wfArrayToCGI( $array1, $array2 = null ) {
if ( !is_null( $array2 ) ) {
*
* Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
* earlier distro releases of PHP)
+ *
+ * @param varargs
+ * @return String
*/
function wfEscapeShellArg( ) {
wfInitShellLocale();
/**
* wfMerge attempts to merge differences between three texts.
* Returns true for a clean merge and false for failure or a conflict.
+ *
+ * @param $old String
+ * @param $mine String
+ * @param $yours String
+ * @param $result String
+ * @return Bool
*/
function wfMerge( $old, $mine, $yours, &$result ) {
global $wgDiff3;
/**
* Returns unified plain-text diff of two texts.
* Useful for machine processing of diffs.
+ *
* @param $before String: the text before the changes.
* @param $after String: the text after the changes.
* @param $params String: command-line options for the diff command.
/**
* Provide a simple HTTP error.
+ *
+ * @param $code Int|String
+ * @param $label String
+ * @param $desc String
*/
function wfHttpError( $code, $label, $desc ) {
global $wgOut;
/**
* Converts an Accept-* header into an array mapping string values to quality
* factors
+ *
+ * @param $accept String
+ * @param $def String default
+ * @return Array
*/
function wfAcceptToPrefs( $accept, $def = '*/*' ) {
# No arg means accept anything (per HTTP spec)
* Returns an array where the values in the first array are replaced by the
* values in the second array with the corresponding keys
*
+ * @param $a Array
+ * @param $b Array
* @return array
*/
function wfArrayLookup( $a, $b ) {
return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
}
-/**
- * Convenience function; returns MediaWiki timestamp for the present time.
- * @return string
- */
-function wfTimestampNow() {
- # return NOW
- return wfTimestamp( TS_MW, time() );
-}
-
/**
* Reference-counted warning suppression
+ *
+ * @param $end Bool
*/
function wfSuppressWarnings( $end = false ) {
static $suppressCount = 0;
}
} else {
if ( !$suppressCount ) {
- $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE ) );
+ // E_DEPRECATED is undefined in PHP 5.2
+ if( !defined( 'E_DEPRECATED' ) ){
+ define( 'E_DEPRECATED', 8192 );
+ }
+ $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED ) );
}
++$suppressCount;
}
define( 'TS_DB2', 8 );
/**
- * ISO 8601 basic format with no timezone: 19860209T200000Z
- *
- * This is used by ResourceLoader
+ * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
*/
define( 'TS_ISO_8601_BASIC', 9 );
/**
+ * Get a timestamp string in one of various formats
+ *
* @param $outputtype Mixed: A timestamp in one of the supported formats, the
* function will autodetect which format is supplied and act
* accordingly.
/**
* Return a formatted timestamp, or null if input is null.
* For dealing with nullable timestamp columns in the database.
+ *
* @param $outputtype Integer
* @param $ts String
* @return String
}
}
+/**
+ * Convenience function; returns MediaWiki timestamp for the present time.
+ *
+ * @return string
+ */
+function wfTimestampNow() {
+ # return NOW
+ return wfTimestamp( TS_MW, time() );
+}
+
/**
* Check if the operating system is Windows
*
return $isWindows;
}
+/**
+ * Check if we are running under HipHop
+ *
+ * @return Bool
+ */
+function wfIsHipHop() {
+ return function_exists( 'hphp_thread_set_warmup_enabled' );
+}
+
/**
* Swap two variables
+ *
+ * @param $x Mixed
+ * @param $y Mixed
*/
function swap( &$x, &$y ) {
$z = $x;
$y = $z;
}
-/**
- * BC wrapper for MimeMagic::singleton()
- * @deprecated No longer needed as of 1.17 (r68836). Remove in 1.19.
- */
-function &wfGetMimeMagic() {
- wfDeprecated( __FUNCTION__ );
- return MimeMagic::singleton();
-}
-
/**
* Tries to get the system directory for temporary files. The TMPDIR, TMP, and
* TEMP environment variables are then checked in sequence, and if none are set
/**
* Increment a statistics counter
+ *
+ * @param $key String
+ * @param $count Int
*/
function wfIncrStats( $key, $count = 1 ) {
global $wgStatsMethod;
return $round ? round( $ret, $acc ) . '%' : "$ret%";
}
-/**
- * Encrypt a username/password.
- *
- * @param $userid Integer: ID of the user
- * @param $password String: password of the user
- * @return String: hashed password
- * @deprecated Use User::crypt() or User::oldCrypt() instead
- */
-function wfEncryptPassword( $userid, $password ) {
- wfDeprecated(__FUNCTION__);
- # Just wrap around User::oldCrypt()
- return User::oldCrypt( $password, $userid );
-}
-
/**
* Appends to second array if $value differs from that in $default
+ *
+ * @param $key String|Int
+ * @param $value Mixed
+ * @param $default Mixed
+ * @param $changed Array to alter
*/
function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
if ( is_null( $changed ) ) {
/**
* Since wfMsg() and co suck, they don't return false if the message key they
* looked up didn't exist but a XHTML string, this function checks for the
- * nonexistance of messages by looking at wfMsg() output
+ * nonexistance of messages by checking the MessageCache::get() result directly.
*
* @param $key String: the message key looked up
* @return Boolean True if the message *doesn't* exist.
*
* @param $extension String A PHP extension. The file suffix (.so or .dll)
* should be omitted
+ * @param $fileName String Name of the library, if not $extension.suffix
* @return Bool - Whether or not the extension is loaded
*/
-function wfDl( $extension ) {
+function wfDl( $extension, $fileName = null ) {
if( extension_loaded( $extension ) ) {
return true;
}
- $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
+ $canDl = false;
+ $sapi = php_sapi_name();
+ if( version_compare( PHP_VERSION, '5.3.0', '<' ) ||
+ $sapi == 'cli' || $sapi == 'cgi' || $sapi == 'embed' )
+ {
+ $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
&& wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
+ }
if( $canDl ) {
+ $fileName = $fileName ? $fileName : $extension;
+ if( wfIsWindows() ) {
+ $fileName = 'php_' . $fileName;
+ }
wfSuppressWarnings();
- dl( $extension . '.' . PHP_SHLIB_SUFFIX );
+ dl( $fileName . '.' . PHP_SHLIB_SUFFIX );
wfRestoreWarnings();
}
return extension_loaded( $extension );
* a float
*/
function wfUseMW( $req_ver ) {
- global $wgVersion;
-
- if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
- throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
+ if ( version_compare( MW_VERSION, (string)$req_ver, '<' ) ) {
+ throw new MWException( "MediaWiki $req_ver required--this is only " . MW_VERSION );
}
}
* array( 'x' ),
* array( 'y' )
* )
+ * @param varargs
+ * @return Array
*/
function wfMergeErrorArrays( /*...*/ ) {
$args = func_get_args();
/**
* Make a URL index, appropriate for the el_index field of externallinks.
+ *
+ * @param $url String
+ * @return String
*/
function wfMakeUrlIndex( $url ) {
$bits = wfParseUrl( $url );
$domainpart = '';
}
$reversedHost = $domainpart . '@' . $mailparts[0];
- } else {
+ } else if ( isset( $bits['host'] ) ) {
$reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
+ } else {
+ // In file: URIs for instance it's common to have an empty host,
+ // which turns up as not getting a 'host' member from parse_url.
+ $reversedHost = '.';
}
// Add an extra dot to the end
// Why? Is it in wrong place in mailto links?
$index .= ':' . $bits['port'];
}
if ( isset( $bits['path'] ) ) {
+ // parse_url() removes the initial '/' from the path
+ // for file: URLs with Windows-style paths, such as
+ // file:///c:/windows/stuff. We need to add it back
+ // to keep our division between host and path properly.
+ if ( strlen( $bits['path'] ) > 0 && substr( $bits['path'], 0, 1 ) !== '/' ) {
+ $index .= '/';
+ }
$index .= $bits['path'];
} else {
$index .= '/';
// Decode and validate input string
$input = strtolower( $input );
for( $i = 0; $i < strlen( $input ); $i++ ) {
- $n = strpos( $digitChars, $input{$i} );
+ $n = strpos( $digitChars, $input[$i] );
if( $n === false || $n > $sourceBase ) {
return false;
}
/**
* Create an object with a given name and an array of construct parameters
+ *
* @param $name String
* @param $p Array: parameters
- * @deprecated
+ * @deprecated since 1.18
*/
function wfCreateObject( $name, $p ) {
return MWFunction::newObj( $name, $p );
/**
* Initialise php session
+ *
+ * @param $sessionId Bool
*/
function wfSetupSession( $sessionId = false ) {
global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
$wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
if( $wgSessionsInMemcached ) {
- require_once( 'MemcachedSessions.php' );
+ if ( !defined( 'MW_COMPILED' ) ) {
+ global $IP;
+ require_once( "$IP/includes/cache/MemcachedSessions.php" );
+ }
+ session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
+ 'memsess_write', 'memsess_destroy', 'memsess_gc' );
+
+ // It's necessary to register a shutdown function to call session_write_close(),
+ // because by the time the request shutdown function for the session module is
+ // called, $wgMemc has already been destroyed. Shutdown functions registered
+ // this way are called before object destruction.
+ register_shutdown_function( 'memsess_write_close' );
} elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
# Only set this if $wgSessionHandler isn't null and session.save_handler
# hasn't already been set to the desired value (that causes errors)
/**
* Get an object from the precompiled serialized directory
*
+ * @param $name String
* @return Mixed: the variable on success, false on failure
*/
function wfGetPrecompiledData( $name ) {
return false;
}
+/**
+ * Get the name of the function which called this function
+ *
+ * @param $level Int
+ * @return Bool|string
+ */
function wfGetCaller( $level = 2 ) {
$backtrace = wfDebugBacktrace();
if ( isset( $backtrace[$level] ) ) {
*
* @param $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() );
/**
* Return a string representation of frame
+ *
+ * @param $frame Array
+ * @return Bool
*/
function wfFormatStackFrame( $frame ) {
return isset( $frame['class'] ) ?
/**
* Get a cache key
+ *
+ * @param varargs
+ * @return String
*/
function wfMemcKey( /*... */ ) {
$args = func_get_args();
/**
* Get a cache key for a foreign DB
+ *
+ * @param $db String
+ * @param $prefix String
+ * @param varargs String
+ * @return String
*/
function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
$args = array_slice( func_get_args(), 2 );
/**
* Get an ASCII string identifying this wiki
* This is used as a prefix in memcached keys
+ *
+ * @return String
*/
function wfWikiID() {
global $wgDBprefix, $wgDBname;
/**
* Split a wiki ID into DB name and table prefix
+ *
+ * @param $wiki String
+ * @param $bits String
*/
function wfSplitWikiID( $wiki ) {
$bits = explode( '-', $wiki, 2 );
/**
* Get a Database object.
+ *
* @param $db Integer: index of the connection to get. May be DB_MASTER for the
* master (for write queries), DB_SLAVE for potentially lagged read
* queries, or an integer >= 0 for a particular server.
/**
* Get the load balancer factory object
+ *
* @return LBFactory
*/
function &wfGetLBFactory() {
/**
* Find a file.
* Shortcut for RepoGroup::singleton()->findFile()
+ *
* @param $title String or Title object
* @param $options Associative array of options:
* time: requested time for an archived image, or false for the
/**
* Get an object referring to a locally registered file.
* Returns a valid placeholder object if the file does not exist.
+ *
* @param $title Title or String
* @return File, or null if passed an invalid Title
*/
/**
* Load an extension messages file
+ *
* @deprecated in 1.16, warnings in 1.18, remove in 1.20
* @codeCoverageIgnore
*/
-function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
+function wfLoadExtensionMessages() {
wfDeprecated( __FUNCTION__ );
}
/**
- * Get a platform-independent path to the null file, e.g.
- * /dev/null
+ * Get a platform-independent path to the null file, e.g. /dev/null
*
* @return string
*/
: '/dev/null';
}
-/**
- * Displays a maxlag error
- *
- * @param $host String: server that lags the most
- * @param $lag Integer: maxlag (actual)
- * @param $maxLag Integer: maxlag (requested)
- */
-function wfMaxlagError( $host, $lag, $maxLag ) {
- global $wgShowHostnames;
- header( 'HTTP/1.1 503 Service Unavailable' );
- header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
- header( 'X-Database-Lag: ' . intval( $lag ) );
- header( 'Content-Type: text/plain' );
- if( $wgShowHostnames ) {
- echo "Waiting for $host: $lag seconds lagged\n";
- } else {
- echo "Waiting for a database server: $lag seconds lagged\n";
- }
-}
-
/**
* Throws a warning that $function is deprecated
+ *
* @param $function String
* @return null
*/
}
/**
- * Sleep until the worst slave's replication lag is less than or equal to
- * $maxLag, in seconds. Use this when updating very large numbers of rows, as
+ * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
+ * and waiting for it to go down, this waits for the slaves 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 slaves.
- *
- * Every time the function has to wait for a slave, it will print a message to
- * that effect (and then sleep for a little while), so it's probably not best
- * to use this outside maintenance scripts in its present form.
- *
- * @param $maxLag Integer
+ *
+ * @param $maxLag Integer (deprecated)
* @param $wiki mixed Wiki identifier accepted by wfGetLB
* @return null
*/
-function wfWaitForSlaves( $maxLag, $wiki = false ) {
- if( $maxLag ) {
- $lb = wfGetLB( $wiki );
- list( $host, $lag ) = $lb->getMaxLag( $wiki );
- while( $lag > $maxLag ) {
- wfSuppressWarnings();
- $name = gethostbyaddr( $host );
- wfRestoreWarnings();
- if( $name !== false ) {
- $host = $name;
- }
- print "Waiting for $host (lagged $lag seconds)...\n";
- sleep( $maxLag );
- list( $host, $lag ) = $lb->getMaxLag();
- }
+function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
+ $lb = wfGetLB( $wiki );
+ // bug 27975 - Don't try to wait for slaves if there are none
+ // Prevents permission error when getting master position
+ if ( $lb->getServerCount() > 1 ) {
+ $dbw = $lb->getConnection( DB_MASTER );
+ $pos = $dbw->getMasterPos();
+ $lb->waitForAll( $pos );
}
}
* @deprecated Warnings in 1.19, removal in 1.20
*/
function wfOut( $s ) {
+ wfDeprecated( __METHOD__ );
global $wgCommandLineMode;
if ( $wgCommandLineMode && !defined( 'MEDIAWIKI_INSTALL' ) ) {
echo $s;
* Generate a random 32-character hexadecimal token.
* @param $salt Mixed: some sort of salt, if necessary, to add to random
* characters before hashing.
+ * @return Array
* @codeCoverageIgnore
*/
function wfGenerateToken( $salt = '' ) {
/**
* Replace all invalid characters with -
+ *
* @param $name Mixed: filename to process
+ * @return String
*/
function wfStripIllegalFilenameChars( $name ) {
global $wgIllegalFileChars;
/**
* Insert array into another array after the specified *KEY*
+ *
* @param $array Array: The array.
* @param $insert Array: The array to insert.
* @param $after Mixed: The key to insert after
+ * @return Array
*/
function wfArrayInsertAfter( $array, $insert, $after ) {
// Find the offset of the element to insert after.
return $output;
}
-/* Recursively converts the parameter (an object) to an array with the same data */
+/**
+ * Recursively converts the parameter (an object) to an array with the same data
+ *
+ * @param $objOrArray Object|Array
+ * @param $recursive Bool
+ * @return Array
+ */
function wfObjectToArray( $objOrArray, $recursive = true ) {
$array = array();
if( is_object( $objOrArray ) ) {
/**
* Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
+ *
* @return Integer value memory was set to.
*/
function wfMemoryLimit() {
/**
* Converts shorthand byte notation to integer form
+ *
* @param $string String
* @return Integer
*/
/**
* Get the normalised IETF language tag
* See unit test for examples.
+ *
* @param $code String: The language code.
* @return $langCode String: The language code which complying with BCP 47 standards.
*/
function wfBCP47( $code ) {
$codeSegment = explode( '-', $code );
+ $codeBCP = array();
foreach ( $codeSegment as $segNo => $seg ) {
if ( count( $codeSegment ) > 0 ) {
// when previous segment is x, it is a private segment and should be lc
return $langCode;
}
+/**
+ * Wrapper around array_map() which also taints variables
+ *
+ * @param $function Callback
+ * @param $input Array
+ * @return Array
+ */
function wfArrayMap( $function, $input ) {
$ret = array_map( $function, $input );
foreach ( $ret as $key => $value ) {
/**
* Get a cache object.
- * @param integer $inputType Cache type, one the the CACHE_* constants.
*
+ * @param integer $inputType Cache type, one the the CACHE_* constants.
* @return BagOStuff
*/
function wfGetCache( $inputType ) {
return ObjectCache::getInstance( $inputType );
}
-/** Get the main cache object */
+/**
+ * Get the main cache object
+ *
+ * @return BagOStuff
+ */
function wfGetMainCache() {
global $wgMainCacheType;
return ObjectCache::getInstance( $wgMainCacheType );
}
-/** Get the cache object used by the message cache */
+/**
+ * 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 */
+/**
+ * Get the cache object used by the parser cache
+ *
+ * @return BagOStuff
+ */
function wfGetParserCacheStorage() {
global $wgParserCacheType;
return ObjectCache::getInstance( $wgParserCacheType );
dépôts / lhc / web / wiklou.git / blobdiff