/**
* Some globals and requires needed
*/
-
+
/**
* Total number of articles
* @global integer $wgNumberOfArticles
# UTF-8 substr function based on a PHP manual comment
if ( !function_exists( 'mb_substr' ) ) {
- function mb_substr( $str, $start ) {
+ function mb_substr( $str, $start ) {
preg_match_all( '/./us', $str, $ar );
if( func_num_args() >= 3 ) {
- $end = func_get_arg( 2 );
- return join( '', array_slice( $ar[0], $start, $end ) );
- } else {
- return join( '', array_slice( $ar[0], $start ) );
+ $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;
+ }
+}
+
+if ( !function_exists( 'array_diff_key' ) ) {
+ /**
+ * Exists in PHP 5.1.0+
+ * Not quite compatible, two-argument version only
+ * Null values will cause problems due to this use of isset()
+ */
+ function array_diff_key( $left, $right ) {
+ $result = $left;
+ foreach ( $left as $key => $value ) {
+ if ( isset( $right[$key] ) ) {
+ unset( $result[$key] );
+ }
}
+ return $result;
+ }
+}
+
+// If it doesn't exist no ctype_* stuff will
+if ( ! function_exists( 'ctype_alnum' ) )
+ require_once 'compatability/ctype.php';
+
+/**
+ * Wrapper for clone() for PHP 4, for the moment.
+ * PHP 5 won't let you declare a 'clone' function, even conditionally,
+ * so it has to be a wrapper with a different name.
+ */
+function wfClone( $object ) {
+ // WARNING: clone() is not a function in PHP 5, so function_exists fails.
+ if( version_compare( PHP_VERSION, '5.0' ) < 0 ) {
+ return $object;
+ } else {
+ return clone( $object );
}
}
}
}
+/**
+ * Send a line to a supplementary debug log file, if configured, or main debug log if not.
+ * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
+ *
+ * @param string $logGroup
+ * @param string $text
+ * @param bool $public Whether to log the event in the public log if no private
+ * log file is specified, (default true)
+ */
+function wfDebugLog( $logGroup, $text, $public = true ) {
+ global $wgDebugLogGroups, $wgDBname;
+ if( $text{strlen( $text ) - 1} != "\n" ) $text .= "\n";
+ if( isset( $wgDebugLogGroups[$logGroup] ) ) {
+ @error_log( "$wgDBname: $text", 3, $wgDebugLogGroups[$logGroup] );
+ } else if ( $public === true ) {
+ wfDebug( $text, true );
+ }
+}
+
/**
* 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;
+ $host = trim(`hostname`);
+ $text = date('D M j G:i:s T Y') . "\t$host\t".$text;
error_log( $text, 3, $wgDBerrorLog );
}
}
*/
function logProfilingData() {
global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
- global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
+ global $wgProfiling, $wgUser;
$now = wfTime();
list( $usec, $sec ) = explode( ' ', $wgRequestTime );
$forward .= ' from ' . $_SERVER['HTTP_FROM'];
if( $forward )
$forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
- if( $wgUser->isAnon() )
+ if( is_object($wgUser) && $wgUser->isAnon() )
$forward .= ' anon';
$log = sprintf( "%s\t%04.3f\t%s\n",
gmdate( 'YmdHis' ), $elapsed,
if ( '' == $wgReadOnlyFile ) {
return false;
}
-
+
// Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time
if ( is_file( $wgReadOnlyFile ) ) {
- $wgReadOnly = true;
+ $wgReadOnly = file_get_contents( $wgReadOnlyFile );
} else {
$wgReadOnly = false;
}
/**
- * Get a message from anywhere, for the current user language
+ * Get a message from anywhere, for the current user language.
+ *
+ * Use wfMsgForContent() instead if the message should NOT
+ * change depending on the user preferences.
*
- * @param string
+ * Note that the message may contain HTML, and is therefore
+ * not safe for insertion anywhere. Some functions such as
+ * addWikiText will do the escaping for you. Use wfMsgHtml()
+ * if you need an escaped message.
+ *
+ * @param string lookup key for the message, usually
+ * defined in languages/Language.php
*/
function wfMsg( $key ) {
$args = func_get_args();
return wfMsgReal( $key, $args, true );
}
+/**
+ * Same as above except doesn't transform the message
+ */
+function wfMsgNoTrans( $key ) {
+ $args = func_get_args();
+ array_shift( $args );
+ return wfMsgReal( $key, $args, true, false );
+}
+
/**
* Get a message from anywhere, for the current global language
+ * set with $wgLanguageCode.
+ *
+ * Use this if the message should NOT change dependent on the
+ * language set in the user's preferences. This is the case for
+ * most text written into logs, as well as link targets (such as
+ * the name of the copyright policy page). Link titles, on the
+ * other hand, should be shown in the UI language.
+ *
+ * Note that MediaWiki allows users to change the user interface
+ * language in their preferences, but a single installation
+ * typically only contains content in one language.
+ *
+ * Be wary of this distinction: If you use wfMsg() where you should
+ * use wfMsgForContent(), a user of the software may have to
+ * customize over 70 messages in order to, e.g., fix a link in every
+ * possible language.
+ *
+ * @param string lookup key for the message, usually
+ * defined in languages/Language.php
*/
function wfMsgForContent( $key ) {
global $wgForceUIMsgAsContentMsg;
return wfMsgReal( $key, $args, true, $forcontent );
}
+/**
+ * Same as above except doesn't transform the message
+ */
+function wfMsgForContentNoTrans( $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, false );
+}
+
/**
* Get a message from the language file, for the UI elements
*/
/**
* Really get a message
*/
-function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
+function wfMsgReal( $key, $args, $useDB, $forContent=false, $transform = true ) {
$fname = 'wfMsgReal';
wfProfileIn( $fname );
-
- $message = wfMsgGetKey( $key, $useDB, $forContent );
+
+ $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
$message = wfMsgReplaceArgs( $message, $args );
wfProfileOut( $fname );
return $message;
}
+/**
+ * This function provides the message source for messages to be edited which are *not* stored in the database
+*/
+
+function wfMsgWeirdKey ( $key ) {
+ $subsource = str_replace ( ' ' , '_' , $key ) ;
+ $source = wfMsg ( $subsource ) ;
+ if ( $source == "<{$subsource}>" ) {
+ # Try again with first char lower case
+ $subsource = strtolower ( substr ( $subsource , 0 , 1 ) ) . substr ( $subsource , 1 ) ;
+ $source = wfMsg ( $subsource ) ;
+ }
+ if ( $source == "<{$subsource}>" ) {
+ # Didn't work either, return blank text
+ $source = "" ;
+ }
+ return $source ;
+}
+
/**
* Fetch a message string value, but don't replace any keys yet.
* @param string $key
* @return string
* @access private
*/
-function wfMsgGetKey( $key, $useDB, $forContent = false ) {
- global $wgParser, $wgMsgParserOptions;
- global $wgContLang, $wgLanguageCode;
- global $wgMessageCache, $wgLang;
-
+function wfMsgGetKey( $key, $useDB, $forContent = false, $transform = true ) {
+ global $wgParser, $wgMsgParserOptions, $wgContLang, $wgMessageCache, $wgLang;
+
+ if ( is_object( $wgMessageCache ) )
+ $transstat = $wgMessageCache->getTransform();
+
if( is_object( $wgMessageCache ) ) {
+ if ( ! $transform )
+ $wgMessageCache->disableTransform();
$message = $wgMessageCache->get( $key, $useDB, $forContent );
} else {
if( $forContent ) {
}
wfSuppressWarnings();
-
+
if( is_object( $lang ) ) {
$message = $lang->getMessage( $key );
} else {
- $message = '';
+ $message = false;
}
wfRestoreWarnings();
- if(!$message)
+ if($message === false)
$message = Language::getMessage($key);
- if(strstr($message, '{{' ) !== false) {
+ if ( $transform && strstr( $message, '{{' ) !== false ) {
$message = $wgParser->transformMsg($message, $wgMsgParserOptions);
}
}
+
+ if ( is_object( $wgMessageCache ) && ! $transform )
+ $wgMessageCache->setTransform( $transstat );
+
return $message;
}
* @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 );
+ // Replace arguments
+ if ( count( $args ) ) {
+ if ( is_array( $args[0] ) ) {
+ foreach ( $args[0] as $key => $val ) {
+ $message = str_replace( '$' . $key, $val, $message );
+ }
+ } else {
+ foreach( $args as $n => $param ) {
+ $replacementKeys['$' . ($n + 1)] = $param;
+ }
+ $message = strtr( $message, $replacementKeys );
+ }
}
+
return $message;
}
function wfMsgHtml( $key ) {
$args = func_get_args();
array_shift( $args );
- return wfMsgReplaceArgs(
- htmlspecialchars( wfMsgGetKey( $key, $args, true ) ),
- $args );
+ return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
+}
+
+/**
+ * Return an HTML version of message
+ * Parameter replacements, if any, are done *after* parsing the wiki-text message,
+ * 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 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 );
}
/**
global $wgLoadBalancer;
static $called = false;
if ( $called ){
- exit();
+ exit( -1 );
}
$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'];
+ $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');
}
+
+ wfProfileClose();
+ logProfilingData();
+
if ( !$error ) {
$wgLoadBalancer->closeAll();
}
- exit();
+ exit( -1 );
}
/**
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 string $msg
+ */
+function wfDie( $msg='' ) {
+ echo $msg;
+ die( -1 );
+}
+
/**
* Die with a backtrace
* This is meant as a debugging aid to track down where bad data comes from.
} else {
$msg .= "\n<p>Backtrace:</p>\n$backtrace";
}
- }
- die( $msg );
+ }
+ echo $msg;
+ echo wfReportTime()."\n";
+ die( -1 );
}
+ /**
+ * Returns a HTML comment with the elapsed time since request.
+ * This method has no side effects.
+ * @return string
+ */
+ function wfReportTime() {
+ global $wgRequestTime;
+
+ $now = wfTime();
+ list( $usec, $sec ) = explode( ' ', $wgRequestTime );
+ $start = (float)$sec + (float)$usec;
+ $elapsed = $now - $start;
+
+ # Use real server name if available, so we know which machine
+ # in a server farm generated the current page.
+ if ( function_exists( 'posix_uname' ) ) {
+ $uname = @posix_uname();
+ } else {
+ $uname = false;
+ }
+ if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
+ $hostname = $uname['nodename'];
+ } else {
+ # This may be a virtual server.
+ $hostname = $_SERVER['SERVER_NAME'];
+ }
+ $com = sprintf( "<!-- Served by %s in %01.2f secs. -->",
+ $hostname, $elapsed );
+ return $com;
+ }
+
function wfBacktrace() {
global $wgCommandLineMode;
if ( !function_exists( 'debug_backtrace' ) ) {
return false;
}
-
+
if ( $wgCommandLineMode ) {
$msg = '';
} else {
$fmtLimit = $wgLang->formatNum( $limit );
$prev = wfMsg( 'prevn', $fmtLimit );
$next = wfMsg( 'nextn', $fmtLimit );
-
+
if( is_object( $link ) ) {
$title =& $link;
} else {
- $title =& Title::newFromText( $link );
+ $title = Title::newFromText( $link );
if( is_null( $title ) ) {
return false;
}
}
-
- $sk = $wgUser->getSkin();
+
if ( 0 != $offset ) {
$po = $offset - $limit;
if ( $po < 0 ) { $po = 0; }
* @param string $text Text to be escaped
*/
function wfEscapeWikiText( $text ) {
- $text = str_replace(
+ $text = str_replace(
array( '[', '|', '\'', 'ISBN ' , '://' , "\n=", '{{' ),
array( '[', '|', ''', 'ISBN ', '://' , "\n=", '{{' ),
htmlspecialchars($text) );
$pairs = array(
"\\" => "\\\\",
"\"" => "\\\"",
- "\'" => "\\\'",
+ '\'' => '\\\'',
"\n" => "\\n",
"\r" => "\\r",
-
+
# To avoid closing the element or CDATA section
"<" => "\\x3c",
">" => "\\x3e",
/**
* Windows-compatible version of escapeshellarg()
- * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
+ * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
* function puts single quotes in regardless of OS
*/
function wfEscapeShellArg( ) {
} else {
$first = false;
}
-
+
if ( wfIsWindows() ) {
$retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
} else {
# This check may also protect against code injection in
# case of broken installations.
if(! file_exists( $wgDiff3 ) ){
+ wfDebug( "diff3 not found\n" );
return false;
}
fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
# Check for a conflict
- $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
+ $cmd = $wgDiff3 . ' -a --overlap-only ' .
wfEscapeShellArg( $mytextName ) . ' ' .
wfEscapeShellArg( $oldtextName ) . ' ' .
wfEscapeShellArg( $yourtextName );
pclose( $handle );
# Merge differences
- $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
+ $cmd = $wgDiff3 . ' -a -e --merge ' .
wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
$handle = popen( $cmd, 'r' );
$result = '';
} while ( true );
pclose( $handle );
unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
+
+ if ( $result === '' && $old !== '' && $conflict == false ) {
+ wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
+ $conflict = true;
+ }
return ! $conflict;
}
header( 'Content-type: text/html' );
print "<html><head><title>" .
- htmlspecialchars( $label ) .
- "</title></head><body><h1>" .
+ htmlspecialchars( $label ) .
+ "</title></head><body><h1>" .
htmlspecialchars( $label ) .
"</h1><p>" .
htmlspecialchars( $desc ) .
* 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 ) {
if ( $end ) {
if ( $suppressCount ) {
- $suppressCount --;
+ --$suppressCount;
if ( !$suppressCount ) {
error_reporting( $originalLevel );
}
if ( !$suppressCount ) {
$originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
}
- $suppressCount++;
+ ++$suppressCount;
}
}
# 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);
*/
define('TS_RFC2822', 3);
+/**
+ * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
+ *
+ * This is used by Special:Export
+ */
+define('TS_ISO_8601', 4);
+
/**
* An Exif timestamp (YYYY:MM:DD HH:MM:SS)
*
* DateTime tag and page 36 for the DateTimeOriginal and
* DateTimeDigitized tags.
*/
-define('TS_EXIF', 4);
+define('TS_EXIF', 5);
+/**
+ * Oracle format time.
+ */
+define('TS_ORACLE', 6);
/**
* @param mixed $outputtype A timestamp in one of the supported formats, the
* @return string Time in the format specified in $outputtype
*/
function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
- if ($ts==0) {
- $uts=time();
+ $uts = 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],
} elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
# TS_UNIX
$uts=$ts;
+ } elseif (preg_match('/^(\d{1,2})-(...)-(\d\d(\d\d)?) (\d\d)\.(\d\d)\.(\d\d)/', $ts, $da)) {
+ # TS_ORACLE
+ $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
+ str_replace("+00:00", "UTC", $ts)));
+ } elseif (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/', $ts, $da)) {
+ # TS_ISO_8601
+ $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
+ (int)$da[2],(int)$da[3],(int)$da[1]);
} 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;
return gmdate( 'YmdHis', $uts );
case TS_DB:
return gmdate( 'Y-m-d H:i:s', $uts );
+ case TS_ISO_8601:
+ return gmdate( 'Y-m-d\TH:i:s\Z', $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';
+ case TS_ORACLE:
+ return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
default:
wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
}
}
/**
- * Check where as the operating system is Windows
+ * Check if the operating system is Windows
*
- * @return bool True if it's windows, False otherwise.
+ * @return bool True if it's Windows, False otherwise.
*/
-function wfIsWindows() {
- if (substr(php_uname(), 0, 7) == 'Windows') {
- return true;
- } else {
- return false;
- }
-}
+function wfIsWindows() {
+ if (substr(php_uname(), 0, 7) == 'Windows') {
+ return true;
+ } else {
+ return false;
+ }
+}
/**
* Swap two variables
$y = $z;
}
+function wfGetCachedNotice( $name ) {
+ global $wgOut, $parserMemc, $wgDBname;
+ $fname = 'wfGetCachedNotice';
+ wfProfileIn( $fname );
+
+ $needParse = false;
+ $notice = wfMsgForContent( $name );
+ if( $notice == '<'. $name . ';>' || $notice == '-' ) {
+ wfProfileOut( $fname );
+ return( false );
+ }
+
+ $cachedNotice = $parserMemc->get( $wgDBname . ':' . $name );
+ if( is_array( $cachedNotice ) ) {
+ if( md5( $notice ) == $cachedNotice['hash'] ) {
+ $notice = $cachedNotice['html'];
+ } else {
+ $needParse = true;
+ }
+ } else {
+ $needParse = true;
+ }
+
+ if( $needParse ) {
+ if( is_object( $wgOut ) ) {
+ $parsed = $wgOut->parse( $notice );
+ $parserMemc->set( $wgDBname . ':' . $name, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
+ $notice = $parsed;
+ } else {
+ wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' );
+ $notice = '';
+ }
+ }
+
+ wfProfileOut( $fname );
+ return $notice;
+}
+
function wfGetSiteNotice() {
- global $wgSiteNotice, $wgTitle, $wgOut;
+ global $wgUser, $wgSiteNotice;
$fname = 'wfGetSiteNotice';
wfProfileIn( $fname );
-
- $notice = wfMsg( 'sitenotice' );
- if($notice == '<sitenotice>') $notice = '';
- # Allow individual wikis to turn it off
- if ( $notice == '-' ) {
- $notice = '';
+
+ if( $wgUser->isLoggedIn() ) {
+ $siteNotice = wfGetCachedNotice( 'sitenotice' );
+ $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
} else {
- if ($notice == '') {
- $notice = $wgSiteNotice;
- }
- if($notice != '-' && $notice != '') {
- $specialparser = new Parser();
- $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions, false );
- $notice = $parserOutput->getText();
+ $anonNotice = wfGetCachedNotice( 'anonnotice' );
+ if( !$anonNotice ) {
+ $siteNotice = wfGetCachedNotice( 'sitenotice' );
+ $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
+ } else {
+ $siteNotice = $anonNotice;
}
}
+
wfProfileOut( $fname );
- return $notice;
+ return( $siteNotice );
}
/**
*
* @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)
+ * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
* @return string
*/
function wfElement( $element, $attribs = null, $contents = '') {
if( $contents == '' ) {
$out .= ' />';
} else {
- $out .= '>';
- $out .= htmlspecialchars( $contents );
- $out .= "</$element>";
+ $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
}
}
return $out;
*
* @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)
+ * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
* @return string
*/
function wfElementClean( $element, $attribs = array(), $contents = '') {
return wfElement( $element, $attribs, $contents );
}
+// Shortcuts
+function wfOpenElement( $element, $attribs = null ) { return wfElement( $element, $attribs, null ); }
+function wfCloseElement( $element ) { return "</$element>"; }
+
+/**
+ * Create a namespace selector
+ *
+ * @param mixed $selected The namespace which should be selected, default ''
+ * @param string $allnamespaces Value of a special item denoting all namespaces. Null to not include (default)
+ * @return Html string containing the namespace selector
+ */
+function &HTMLnamespaceselector($selected = '', $allnamespaces = null) {
+ global $wgContLang;
+ if( $selected !== '' ) {
+ if( is_null( $selected ) ) {
+ // No namespace selected; let exact match work without hitting Main
+ $selected = '';
+ } else {
+ // Let input be numeric strings without breaking the empty match.
+ $selected = intval( $selected );
+ }
+ }
+ $s = "<select name='namespace' class='namespaceselector'>\n\t";
+ $arr = $wgContLang->getFormattedNamespaces();
+ if( !is_null($allnamespaces) ) {
+ $arr = array($allnamespaces => wfMsgHtml('namespacesall')) + $arr;
+ }
+ foreach ($arr as $index => $name) {
+ if ($index < NS_MAIN) continue;
+
+ $name = $index !== 0 ? $name : wfMsgHtml('blanknamespace');
+
+ if ($index === $selected) {
+ $s .= wfElement("option",
+ array("value" => $index, "selected" => "selected"),
+ $name);
+ } else {
+ $s .= wfElement("option", array("value" => $index), $name);
+ }
+ }
+ $s .= "\n</select>\n";
+ return $s;
+}
+
/** Global singleton instance of MimeMagic. This is initialized on demand,
* please always use the wfGetMimeMagic() function to get the instance.
-*
-* @private
+*
+* @access private
*/
$wgMimeMagic= NULL;
*/
function &wfGetMimeMagic() {
global $wgMimeMagic;
-
+
if (!is_null($wgMimeMagic)) {
return $wgMimeMagic;
}
#include on demand
require_once("MimeMagic.php");
}
-
+
$wgMimeMagic= new MimeMagic();
-
+
return $wgMimeMagic;
}
function wfMkdirParents( $fullDir, $mode ) {
$parts = explode( '/', $fullDir );
$path = '';
- $success = false;
+
foreach ( $parts as $dir ) {
$path .= $dir . '/';
if ( !is_dir( $path ) ) {
return true;
}
-
+/**
+ * Increment a statistics counter
+ */
function wfIncrStats( $key ) {
global $wgDBname, $wgMemc;
$key = "$wgDBname:stats:$key";
}
}
+/**
+ * @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;
+}
+
+/**
+ * Appends to second array if $value differs from that in $default
+ */
+function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
+ if ( is_null( $changed ) ) {
+ wfDebugDieBacktrace('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
+ }
+ if ( $default[$key] !== $value ) {
+ $changed[$key] = $value;
+ }
+}
+
+/**
+ * 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
+ *
+ * @param $msg The message key looked up
+ * @param $wfMsgOut The output of wfMsg*()
+ * @return bool
+ */
+function wfEmptyMsg( $msg, $wfMsgOut ) {
+ return $wfMsgOut === "<$msg>";
+}
+
+/**
+ * Find out whether or not a mixed variable exists in a string
+ *
+ * @param mixed needle
+ * @param string haystack
+ * @return bool
+ */
+function in_string( $needle, $str ) {
+ return strpos( $str, $needle ) !== false;
+}
+
+/**
+ * Returns a regular expression of url protocols
+ *
+ * @return string
+ */
+function wfUrlProtocols() {
+ global $wgUrlProtocols;
+
+ $protocols = array();
+ foreach ($wgUrlProtocols as $protocol)
+ $protocols[] = preg_quote( $protocol, '/' );
+
+ return implode( '|', $protocols );
+}
+
+/**
+ * Check if a string is well-formed XML.
+ * Must include the surrounding tag.
+ *
+ * @param string $text
+ * @return bool
+ *
+ * @todo Error position reporting return
+ */
+function wfIsWellFormedXml( $text ) {
+ $parser = xml_parser_create( "UTF-8" );
+
+ # case folding violates XML standard, turn it off
+ xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
+
+ if( !xml_parse( $parser, $text, true ) ) {
+ $err = xml_error_string( xml_get_error_code( $parser ) );
+ $position = xml_get_current_byte_index( $parser );
+ //$fragment = $this->extractFragment( $html, $position );
+ //$this->mXmlError = "$err at byte $position:\n$fragment";
+ xml_parser_free( $parser );
+ return false;
+ }
+ xml_parser_free( $parser );
+ return true;
+}
+
+/**
+ * Check if a string is a well-formed XML fragment.
+ * Wraps fragment in an <html> bit and doctype, so it can be a fragment
+ * and can use HTML named entities.
+ *
+ * @param string $text
+ * @return bool
+ */
+function wfIsWellFormedXmlFragment( $text ) {
+ $html =
+ Sanitizer::hackDocType() .
+ '<html>' .
+ $text .
+ '</html>';
+ return wfIsWellFormedXml( $html );
+}
+
+/**
+ * shell_exec() with time and memory limits mirrored from the PHP configuration,
+ * if supported.
+ */
+function wfShellExec( $cmd )
+{
+ global $IP;
+
+ if ( php_uname( 's' ) == 'Linux' ) {
+ $time = ini_get( 'max_execution_time' );
+ $mem = ini_get( 'memory_limit' );
+ if( preg_match( '/^([0-9]+)[Mm]$/', trim( $mem ), $m ) ) {
+ $mem = intval( $m[1] * (1024*1024) );
+ }
+ if ( $time > 0 && $mem > 0 ) {
+ $script = "$IP/bin/ulimit.sh";
+ if ( is_executable( $script ) ) {
+ $memKB = intval( $mem / 1024 );
+ $cmd = escapeshellarg( $script ) . " $time $memKB $cmd";
+ }
+ }
+ }
+ return shell_exec( $cmd );
+}
+
+/**
+ * This function works like "use VERSION" in Perl, the program will die with a
+ * backtrace if the current version of PHP is less than the version provided
+ *
+ * This is useful for extensions which due to their nature are not kept in sync
+ * with releases, and might depend on other versions of PHP than the main code
+ *
+ * Note: PHP might die due to parsing errors in some cases before it ever
+ * manages to call this function, such is life
+ *
+ * @see perldoc -f use
+ *
+ * @param mixed $version The version to check, can be a string, an integer, or
+ * a float
+ */
+function wfUsePHP( $req_ver ) {
+ $php_ver = PHP_VERSION;
+
+ if ( version_compare( $php_ver, (string)$req_ver, '<' ) )
+ wfDebugDieBacktrace( "PHP $req_ver required--this is only $php_ver" );
+}
+
+/**
+ * This function works like "use VERSION" in Perl except it checks the version
+ * of MediaWiki, the program will die with a backtrace if the current version
+ * of MediaWiki is less than the version provided.
+ *
+ * This is useful for extensions which due to their nature are not kept in sync
+ * with releases
+ *
+ * @see perldoc -f use
+ *
+ * @param mixed $version The version to check, can be a string, an integer, or
+ * a float
+ */
+function wfUseMW( $req_ver ) {
+ global $wgVersion;
+
+ if ( version_compare( $wgVersion, (string)$req_ver, '<' ) )
+ wfDebugDieBacktrace( "MediaWiki $req_ver required--this is only $wgVersion" );
+}
+
+/**
+ * Escape a string to make it suitable for inclusion in a preg_replace()
+ * replacement parameter.
+ *
+ * @param string $string
+ * @return string
+ */
+function wfRegexReplacement( $string ) {
+ $string = str_replace( '\\', '\\\\', $string );
+ $string = str_replace( '$', '\\$', $string );
+ return $string;
+}
+
+/**
+ * Return the final portion of a pathname.
+ * Reimplemented because PHP5's basename() is buggy with multibyte text.
+ * http://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
+ * @return string
+ */
+function wfBaseName( $path ) {
+ if( preg_match( '#([^/\\\\]*)[/\\\\]*$#', $path, $matches ) ) {
+ return $matches[1];
+ } else {
+ return '';
+ }
+}
+
?>