= 3 ) { $end = func_get_arg( 2 ); return join( '', array_slice( $ar[0], $start, $end ) ); } else { return join( '', array_slice( $ar[0], $start ) ); } } } if( !function_exists( 'floatval' ) ) { /** * First defined in PHP 4.2.0 * @param mixed $var; * @return float */ function floatval( $var ) { return (float)$var; } } /** * Where as we got a random seed * @var bool $wgTotalViews */ $wgRandomSeeded = false; /** * Seed Mersenne Twister * Only necessary in PHP < 4.2.0 * * @return bool */ function wfSeedRandom() { global $wgRandomSeeded; if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) { $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff; mt_srand( $seed ); $wgRandomSeeded = true; } } /** * Get a random decimal value between 0 and 1, in a way * not likely to give duplicate values for any realistic * number of articles. * * @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(); $rand = number_format( (mt_rand() * $max + mt_rand()) / $max / $max, 12, '.', '' ); return $rand; } /** * We want / and : to be included as literal characters in our title URLs. * %2F in the page titles seems to fatally break for some reason. * * @param string $s * @return string */ function wfUrlencode ( $s ) { $s = urlencode( $s ); $s = preg_replace( '/%3[Aa]/', ':', $s ); $s = preg_replace( '/%2[Ff]/', '/', $s ); return $s; } /** * 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 * $wgProfileOnly - if set, normal debug messages will not be recorded. * $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. * * @param string $text * @param bool $logonly Set true to avoid appearing in HTML when $wgDebugComments is set */ function wfDebug( $text, $logonly = false ) { global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage; # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) { return; } if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) { $wgOut->debug( $text ); } if ( '' != $wgDebugLogFile && !$wgProfileOnly ) { # Strip unprintables; they can switch terminal modes when binary data # gets dumped, which is pretty annoying. $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text ); @error_log( $text, 3, $wgDebugLogFile ); } } /** * Log for database errors * @param string $text Database error message. */ function wfLogDBError( $text ) { global $wgDBerrorLog; if ( $wgDBerrorLog ) { $text = date('D M j G:i:s T Y') . "\t".$text; error_log( $text, 3, $wgDBerrorLog ); } } /** * @todo document */ function logProfilingData() { global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest; global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser; $now = wfTime(); list( $usec, $sec ) = explode( ' ', $wgRequestTime ); $start = (float)$sec + (float)$usec; $elapsed = $now - $start; if ( $wgProfiling ) { $prof = wfGetProfilingOutput( $start, $elapsed ); $forward = ''; if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR']; if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP']; if( !empty( $_SERVER['HTTP_FROM'] ) ) $forward .= ' from ' . $_SERVER['HTTP_FROM']; if( $forward ) $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})"; if( $wgUser->isAnon() ) $forward .= ' anon'; $log = sprintf( "%s\t%04.3f\t%s\n", gmdate( 'YmdHis' ), $elapsed, urldecode( $_SERVER['REQUEST_URI'] . $forward ) ); if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) { error_log( $log . $prof, 3, $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() { global $wgReadOnlyFile, $wgReadOnly; if ( $wgReadOnly ) { return true; } if ( '' == $wgReadOnlyFile ) { return false; } // Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time if ( is_file( $wgReadOnlyFile ) ) { $wgReadOnly = true; } else { $wgReadOnly = false; } $wgReadOnlyFile = ''; return $wgReadOnly; } /** * Get a message from anywhere, for the current user language * * @param string */ function wfMsg( $key ) { $args = func_get_args(); array_shift( $args ); return wfMsgReal( $key, $args, true ); } /** * Get a message from anywhere, for the current global language */ function wfMsgForContent( $key ) { global $wgForceUIMsgAsContentMsg; $args = func_get_args(); array_shift( $args ); $forcontent = true; if( is_array( $wgForceUIMsgAsContentMsg ) && in_array( $key, $wgForceUIMsgAsContentMsg ) ) $forcontent = false; return wfMsgReal( $key, $args, true, $forcontent ); } /** * Get a message from the language file, for the UI elements */ function wfMsgNoDB( $key ) { $args = func_get_args(); array_shift( $args ); return wfMsgReal( $key, $args, false ); } /** * Get a message from the language file, for the content */ function wfMsgNoDBForContent( $key ) { global $wgForceUIMsgAsContentMsg; $args = func_get_args(); array_shift( $args ); $forcontent = true; if( is_array( $wgForceUIMsgAsContentMsg ) && in_array( $key, $wgForceUIMsgAsContentMsg ) ) $forcontent = false; return wfMsgReal( $key, $args, false, $forcontent ); } /** * Really get a message */ function wfMsgReal( $key, $args, $useDB, $forContent=false ) { $fname = 'wfMsgReal'; wfProfileIn( $fname ); $message = wfMsgGetKey( $key, $useDB, $forContent ); $message = wfMsgReplaceArgs( $message, $args ); wfProfileOut( $fname ); return $message; } /** * Fetch a message string value, but don't replace any keys yet. * @param string $key * @param bool $useDB * @param bool $forContent * @return string * @access private */ function wfMsgGetKey( $key, $useDB, $forContent = false ) { global $wgParser, $wgMsgParserOptions; global $wgContLang, $wgLanguageCode; global $wgMessageCache, $wgLang; if( is_object( $wgMessageCache ) ) { $message = $wgMessageCache->get( $key, $useDB, $forContent ); } else { if( $forContent ) { $lang = &$wgContLang; } else { $lang = &$wgLang; } wfSuppressWarnings(); if( is_object( $lang ) ) { $message = $lang->getMessage( $key ); } else { $message = ''; } wfRestoreWarnings(); if(!$message) $message = Language::getMessage($key); if(strstr($message, '{{' ) !== false) { $message = $wgParser->transformMsg($message, $wgMsgParserOptions); } } return $message; } /** * Replace message parameter keys on the given formatted output. * * @param string $message * @param array $args * @return string * @access private */ function wfMsgReplaceArgs( $message, $args ) { static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' ); # Fix windows line-endings # Some messages are split with explode("\n", $msg) $message = str_replace( "\r", '', $message ); # Replace arguments if( count( $args ) ) { $message = str_replace( $replacementKeys, $args, $message ); } return $message; } /** * Return an HTML-escaped version of a message. * Parameter replacements, if any, are done *after* the HTML-escaping, * so parameters may contain HTML (eg links or form controls). Be sure * to pre-escape them if you really do want plaintext, or just wrap * the whole thing in htmlspecialchars(). * * @param string $key * @param string ... parameters * @return string */ function wfMsgHtml( $key ) { $args = func_get_args(); array_shift( $args ); return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args ); } /** * Just like exit() but makes a note of it. * Commits open transactions except if the error parameter is set */ function wfAbruptExit( $error = false ){ global $wgLoadBalancer; static $called = false; if ( $called ){ exit(); } $called = true; if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3 $bt = debug_backtrace(); for($i = 0; $i < count($bt) ; $i++){ $file = $bt[$i]['file']; $line = $bt[$i]['line']; wfDebug("WARNING: Abrupt exit in $file at line $line\n"); } } else { wfDebug('WARNING: Abrupt exit\n'); } if ( !$error ) { $wgLoadBalancer->closeAll(); } exit(); } /** * @todo document */ function wfErrorExit() { wfAbruptExit( true ); } /** * Die with a backtrace * This is meant as a debugging aid to track down where bad data comes from. * Shouldn't be used in production code except maybe in "shouldn't happen" areas. * * @param string $msg Message shown when dieing. */ function wfDebugDieBacktrace( $msg = '' ) { global $wgCommandLineMode; $backtrace = wfBacktrace(); if ( $backtrace !== false ) { if ( $wgCommandLineMode ) { $msg .= "\nBacktrace:\n$backtrace"; } else { $msg .= "\n
Backtrace:
\n$backtrace"; } } echo $msg; die( -1 ); } function wfBacktrace() { global $wgCommandLineMode; if ( !function_exists( 'debug_backtrace' ) ) { return false; } if ( $wgCommandLineMode ) { $msg = ''; } else { $msg = "" . htmlspecialchars( $desc ) . "
\n"; } /** * Converts an Accept-* header into an array mapping string values to quality * factors */ function wfAcceptToPrefs( $accept, $def = '*/*' ) { # No arg means accept anything (per HTTP spec) if( !$accept ) { return array( $def => 1 ); } $prefs = array(); $parts = explode( ',', $accept ); foreach( $parts as $part ) { # FIXME: doesn't deal with params like 'text/html; level=1' @list( $value, $qpart ) = explode( ';', $part ); if( !isset( $qpart ) ) { $prefs[$value] = 1; } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) { $prefs[$value] = $match[1]; } } return $prefs; } /** * Checks if a given MIME type matches any of the keys in the given * array. Basic wildcards are accepted in the array keys. * * Returns the matching MIME type (or wildcard) if a match, otherwise * NULL if no match. * * @param string $type * @param array $avail * @return string * @access private */ function mimeTypeMatch( $type, $avail ) { if( array_key_exists($type, $avail) ) { return $type; } else { $parts = explode( '/', $type ); if( array_key_exists( $parts[0] . '/*', $avail ) ) { return $parts[0] . '/*'; } elseif( array_key_exists( '*/*', $avail ) ) { return '*/*'; } else { return NULL; } } } /** * Returns the 'best' match between a client's requested internet media types * and the server's list of available types. Each list should be an associative * array of type to preference (preference is a float between 0.0 and 1.0). * Wildcards in the types are acceptable. * * @param array $cprefs Client's acceptable type list * @param array $sprefs Server's offered types * @return string * * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8' * XXX: generalize to negotiate other stuff */ function wfNegotiateType( $cprefs, $sprefs ) { $combine = array(); foreach( array_keys($sprefs) as $type ) { $parts = explode( '/', $type ); if( $parts[1] != '*' ) { $ckey = mimeTypeMatch( $type, $cprefs ); if( $ckey ) { $combine[$type] = $sprefs[$type] * $cprefs[$ckey]; } } } foreach( array_keys( $cprefs ) as $type ) { $parts = explode( '/', $type ); if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) { $skey = mimeTypeMatch( $type, $sprefs ); if( $skey ) { $combine[$type] = $sprefs[$skey] * $cprefs[$type]; } } } $bestq = 0; $besttype = NULL; foreach( array_keys( $combine ) as $type ) { if( $combine[$type] > $bestq ) { $besttype = $type; $bestq = $combine[$type]; } } return $besttype; } /** * Array lookup * Returns an array where the values in the first array are replaced by the * values in the second array with the corresponding keys * * @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 */ function wfSuppressWarnings( $end = false ) { static $suppressCount = 0; static $originalLevel = false; if ( $end ) { if ( $suppressCount ) { $suppressCount --; if ( !$suppressCount ) { error_reporting( $originalLevel ); } } } else { if ( !$suppressCount ) { $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) ); } $suppressCount++; } } /** * Restore error level to previous value */ function wfRestoreWarnings() { wfSuppressWarnings( true ); } # Autodetect, convert and provide timestamps of various types /** * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC */ define('TS_UNIX', 0); /** * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS) */ define('TS_MW', 1); /** * MySQL DATETIME (YYYY-MM-DD HH:MM:SS) */ define('TS_DB', 2); /** * RFC 2822 format, for E-mail and HTTP headers */ define('TS_RFC2822', 3); /** * An Exif timestamp (YYYY:MM:DD HH:MM:SS) * * @link http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the * DateTime tag and page 36 for the DateTimeOriginal and * DateTimeDigitized tags. */ define('TS_EXIF', 4); /** * @param mixed $outputtype A timestamp in one of the supported formats, the * function will autodetect which format is supplied and act accordingly. * @return string Time in the format specified in $outputtype */ function wfTimestamp($outputtype=TS_UNIX,$ts=0) { if ($ts==0) { $uts=time(); } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) { # TS_DB $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6], (int)$da[2],(int)$da[3],(int)$da[1]); } elseif (preg_match("/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) { # TS_EXIF $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6], (int)$da[2],(int)$da[3],(int)$da[1]); } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) { # TS_MW $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6], (int)$da[2],(int)$da[3],(int)$da[1]); } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) { # TS_UNIX $uts=$ts; } else { # Bogus value; fall back to the epoch... wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n"); $uts = 0; } switch($outputtype) { case TS_UNIX: return $uts; case TS_MW: return gmdate( 'YmdHis', $uts ); case TS_DB: return gmdate( 'Y-m-d H:i:s', $uts ); // This shouldn't ever be used, but is included for completeness case TS_EXIF: return gmdate( 'Y:m:d H:i:s', $uts ); case TS_RFC2822: return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT'; default: wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.'); } } /** * Return a formatted timestamp, or null if input is null. * For dealing with nullable timestamp columns in the database. * @param int $outputtype * @param string $ts * @return string */ function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) { if( is_null( $ts ) ) { return null; } else { return wfTimestamp( $outputtype, $ts ); } } /** * Check where as the operating system is Windows * * @return bool True if it's windows, False otherwise. */ function wfIsWindows() { if (substr(php_uname(), 0, 7) == 'Windows') { return true; } else { return false; } } /** * Swap two variables */ function swap( &$x, &$y ) { $z = $x; $x = $y; $y = $z; } function wfGetSiteNotice() { global $wgSiteNotice, $wgTitle, $wgOut; $fname = 'wfGetSiteNotice'; wfProfileIn( $fname ); $notice = wfMsg( 'sitenotice' ); if( $notice == '<sitenotice>' || $notice == '-' ) { $notice = ''; } if( $notice == '' ) { # We may also need to override a message with eg downtime info # FIXME: make this work! $notice = $wgSiteNotice; } if($notice != '-' && $notice != '') { $specialparser = new Parser(); $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions, false ); $notice = $parserOutput->getText(); } wfProfileOut( $fname ); return $notice; } /** * Format an XML element with given attributes and, optionally, text content. * Element and attribute names are assumed to be ready for literal inclusion. * Strings are assumed to not contain XML-illegal characters; special * characters (<, >, &) are escaped but illegals are not touched. * * @param string $element * @param array $attribs Name=>value pairs. Values will be escaped. * @param bool $contents NULL to make an open tag only; '' for a contentless closed tag (default) * @return string */ function wfElement( $element, $attribs = null, $contents = '') { $out = '<' . $element; if( !is_null( $attribs ) ) { foreach( $attribs as $name => $val ) { $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"'; } } if( is_null( $contents ) ) { $out .= '>'; } else { if( $contents == '' ) { $out .= ' />'; } else { $out .= '>'; $out .= htmlspecialchars( $contents ); $out .= "$element>"; } } return $out; } /** * Format an XML element as with wfElement(), but run text through the * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8 * is passed. * * @param string $element * @param array $attribs Name=>value pairs. Values will be escaped. * @param bool $contents NULL to make an open tag only; '' for a contentless closed tag (default) * @return string */ function wfElementClean( $element, $attribs = array(), $contents = '') { if( $attribs ) { $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs ); } if( $contents ) { $contents = UtfNormal::cleanUp( $contents ); } return wfElement( $element, $attribs, $contents ); } /** Global singleton instance of MimeMagic. This is initialized on demand, * please always use the wfGetMimeMagic() function to get the instance. * * @private */ $wgMimeMagic= NULL; /** Factory functions for the global MimeMagic object. * This function always returns the same singleton instance of MimeMagic. * That objects will be instantiated on the first call to this function. * If needed, the MimeMagic.php file is automatically included by this function. * @return MimeMagic the global MimeMagic objects. */ function &wfGetMimeMagic() { global $wgMimeMagic; if (!is_null($wgMimeMagic)) { return $wgMimeMagic; } if (!class_exists("MimeMagic")) { #include on demand require_once("MimeMagic.php"); } $wgMimeMagic= new MimeMagic(); return $wgMimeMagic; } /** * Tries to get the system directory for temporary files. * The TMPDIR, TMP, and TEMP environment variables are checked in sequence, * and if none are set /tmp is returned as the generic Unix default. * * NOTE: When possible, use the tempfile() function to create temporary * files to avoid race conditions on file creation, etc. * * @return string */ function wfTempDir() { foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) { $tmp = getenv( $var ); if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) { return $tmp; } } # Hope this is Unix of some kind! return '/tmp'; } /** * Make directory, and make all parent directories if they don't exist */ function wfMkdirParents( $fullDir, $mode ) { $parts = explode( '/', $fullDir ); $path = ''; $success = false; foreach ( $parts as $dir ) { $path .= $dir . '/'; if ( !is_dir( $path ) ) { if ( !mkdir( $path, $mode ) ) { return false; } } } return true; } /** * Increment a statistics counter */ function wfIncrStats( $key ) { global $wgDBname, $wgMemc; $key = "$wgDBname:stats:$key"; if ( is_null( $wgMemc->incr( $key ) ) ) { $wgMemc->add( $key, 1 ); } } /** * @param mixed $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 float */ function wfPercent( $nr, $acc = 2, $round = true ) { $ret = sprintf( "%.${acc}f", $nr ); return $round ? round( $ret, $acc ) . '%' : "$ret%"; } /** * Encrypt a username/password. * * @param string $userid ID of the user * @param string $password Password of the user * @return string Hashed password */ function wfEncryptPassword( $userid, $password ) { global $wgPasswordSalt; $p = md5( $password); if($wgPasswordSalt) return md5( "{$userid}-{$p}" ); else return $p; } ?>