require_once( 'DatabaseFunctions.php' );
-require_once( 'UpdateClasses.php' );
require_once( 'LogPage.php' );
require_once( 'normal/UtfNormalUtil.php' );
+require_once( 'XmlFunctions.php' );
/**
* Compatibility functions
}
}
+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;
+ }
+}
+
+
+/**
+ * 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 );
+ }
+}
+
/**
* Where as we got a random seed
* @var bool $wgTotalViews
* 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
+ * @param $s String:
* @return string
*/
function wfUrlencode ( $s ) {
* $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
+ * @param $text String
+ * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
*/
function wfDebug( $text, $logonly = false ) {
global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
* 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
+ * @param $logGroup String
+ * @param $text String
+ * @param $public Bool: 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] );
+ $time = wfTimestamp( TS_DB );
+ @error_log( "$time $wgDBname: $text", 3, $wgDebugLogGroups[$logGroup] );
} else if ( $public === true ) {
wfDebug( $text, true );
}
/**
* Log for database errors
- * @param string $text Database error message.
+ * @param $text String: database error message.
*/
function wfLogDBError( $text ) {
global $wgDBerrorLog;
global $wgProfiling, $wgUser;
$now = wfTime();
- list( $usec, $sec ) = explode( ' ', $wgRequestTime );
- $start = (float)$sec + (float)$usec;
- $elapsed = $now - $start;
+ $elapsed = $now - $wgRequestTime;
if ( $wgProfiling ) {
- $prof = wfGetProfilingOutput( $start, $elapsed );
+ $prof = wfGetProfilingOutput( $wgRequestTime, $elapsed );
$forward = '';
if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
$forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
$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,
function wfReadOnly() {
global $wgReadOnlyFile, $wgReadOnly;
- if ( $wgReadOnly ) {
- return true;
+ if ( !is_null( $wgReadOnly ) ) {
+ return (bool)$wgReadOnly;
}
if ( '' == $wgReadOnlyFile ) {
return false;
}
-
- // Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time
+ // Set $wgReadOnly for faster access next time
if ( is_file( $wgReadOnlyFile ) ) {
$wgReadOnly = file_get_contents( $wgReadOnlyFile );
} else {
$wgReadOnly = false;
}
- $wgReadOnlyFile = '';
- return $wgReadOnly;
+ return (bool)$wgReadOnly;
}
/**
* Get a message from anywhere, for the current user language.
*
- * Use wfMsgForContent() instead if the message should NOT
+ * Use wfMsgForContent() instead if the message should NOT
* change depending on the user preferences.
*
* Note that the message may contain HTML, and is therefore
* addWikiText will do the escaping for you. Use wfMsgHtml()
* if you need an escaped message.
*
- * @param string lookup key for the message, usually
+ * @param $key String: lookup key for the message, usually
* defined in languages/Language.php
*/
function wfMsg( $key ) {
/**
* 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
+ *
+ * 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
+ * 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
+ *
+ * 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
+ * @param $key String: lookup key for the message, usually
* defined in languages/Language.php
*/
function wfMsgForContent( $key ) {
/**
* Really get a message
+ * @return $key String: key to get.
+ * @return $args
+ * @return $useDB Boolean
+ * @return String: the requested message.
*/
-function wfMsgReal( $key, $args, $useDB, $forContent=false, $transform = true ) {
+function wfMsgReal( $key, $args, $useDB = true, $forContent=false, $transform = true ) {
$fname = 'wfMsgReal';
- wfProfileIn( $fname );
$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
-*/
-
+ * This function provides the message source for messages to be edited which are *not* stored in the database.
+ * @param $key String:
+ */
function wfMsgWeirdKey ( $key ) {
$subsource = str_replace ( ' ' , '_' , $key ) ;
$source = wfMsg ( $subsource ) ;
* @param bool $useDB
* @param bool $forContent
* @return string
- * @access private
+ * @private
*/
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();
if ( is_object( $wgMessageCache ) && ! $transform )
$wgMessageCache->setTransform( $transstat );
-
+
return $message;
}
* @param string $message
* @param array $args
* @return string
- * @access private
+ * @private
*/
function wfMsgReplaceArgs( $message, $args ) {
# Fix windows line-endings
$message = str_replace( "\r", '', $message );
// Replace arguments
- if ( count( $args ) )
- if ( is_array( $args[0] ) )
- foreach ( $args[0] as $key => $val )
+ 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 );
+ }
+ } else {
+ foreach( $args as $n => $param ) {
+ $replacementKeys['$' . ($n + 1)] = $param;
+ }
+ $message = strtr( $message, $replacementKeys );
+ }
}
-
+
return $message;
}
return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
}
+/**
+ * Returns message in the requested format
+ * @param string $key Key of the message
+ * @param array $options Processing rules:
+ * <i>parse<i>: parses wikitext to html
+ * <i>parseinline<i>: parses wikitext to html and removes the surrounding p's added by parser or tidy
+ * <i>escape<i>: filters message trough htmlspecialchars
+ * <i>replaceafter<i>: parameters are substituted after parsing or escaping
+ */
+function wfMsgExt( $key, $options ) {
+ global $wgOut, $wgMsgParserOptions, $wgParser;
+
+ $args = func_get_args();
+ array_shift( $args );
+ array_shift( $args );
+
+ if( !is_array($options) ) {
+ $options = array($options);
+ }
+
+ $string = wfMsgGetKey( $key, true, false, false );
+
+ if( !in_array('replaceafter', $options) ) {
+ $string = wfMsgReplaceArgs( $string, $args );
+ }
+
+ if( in_array('parse', $options) ) {
+ $string = $wgOut->parse( $string, true, true );
+ } elseif ( in_array('parseinline', $options) ) {
+ $string = $wgOut->parse( $string, true, true );
+ $m = array();
+ if( preg_match( "~^<p>(.*)\n?</p>$~", $string, $m ) ) {
+ $string = $m[1];
+ }
+ } elseif ( in_array('parsemag', $options) ) {
+ global $wgTitle;
+ $parser = new Parser();
+ $parserOptions = new ParserOptions();
+ $parserOptions->setInterfaceMessage( true );
+ $parser->startExternalParse( $wgTitle, $parserOptions, OT_MSG );
+ $string = $parser->transformMsg( $string, $parserOptions );
+ }
+
+ if ( in_array('escape', $options) ) {
+ $string = htmlspecialchars ( $string );
+ }
+
+ if( in_array('replaceafter', $options) ) {
+ $string = wfMsgReplaceArgs( $string, $args );
+ }
+
+ return $string;
+}
+
+
/**
* Just like exit() but makes a note of it.
* Commits open transactions except if the error parameter is set
+ *
+ * @obsolete Please return control to the caller or throw an exception
*/
function wfAbruptExit( $error = false ){
global $wgLoadBalancer;
static $called = false;
if ( $called ){
- exit();
+ exit( -1 );
}
$called = true;
} else {
wfDebug('WARNING: Abrupt exit\n');
}
+
+ wfProfileClose();
+ logProfilingData();
+
if ( !$error ) {
$wgLoadBalancer->closeAll();
}
- exit();
+ exit( -1 );
}
/**
- * @todo document
+ * @obsolete Please return control the caller or throw an exception
*/
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.
+ * 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 );
+}
+
+/**
+ * Throw a debugging exception. This function previously once exited the process,
+ * but now throws an exception instead, with similar results.
*
* @param string $msg Message shown when dieing.
*/
function wfDebugDieBacktrace( $msg = '' ) {
- global $wgCommandLineMode;
+ throw new MWException( $msg );
+}
- $backtrace = wfBacktrace();
- if ( $backtrace !== false ) {
- if ( $wgCommandLineMode ) {
- $msg .= "\nBacktrace:\n$backtrace";
- } else {
- $msg .= "\n<p>Backtrace:</p>\n$backtrace";
- }
+/**
+ * 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() {
+ if ( function_exists( 'posix_uname' ) ) {
+ // This function not present on Windows
+ $uname = @posix_uname();
+ } else {
+ $uname = false;
+ }
+ if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
+ return $uname['nodename'];
+ } else {
+ # This may be a virtual server.
+ return $_SERVER['SERVER_NAME'];
}
- echo $msg;
- echo wfReportTime()."\n";
- die( -1 );
}
/**
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 );
+ $elapsed = $now - $wgRequestTime;
+
+ $com = sprintf( "<!-- Served by %s in %01.3f secs. -->",
+ wfHostname(), $elapsed );
return $com;
}
* @todo document
*/
function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
- global $wgUser, $wgLang;
+ global $wgLang;
$fmtLimit = $wgLang->formatNum( $limit );
$prev = wfMsg( 'prevn', $fmtLimit );
$next = wfMsg( 'nextn', $fmtLimit );
}
}
- $sk = $wgUser->getSkin();
if ( 0 != $offset ) {
$po = $offset - $limit;
if ( $po < 0 ) { $po = 0; }
* @todo document
*/
function wfNumLink( $offset, $limit, &$title, $query = '' ) {
- global $wgUser, $wgLang;
+ global $wgLang;
if ( '' == $query ) { $q = ''; }
else { $q = $query.'&'; }
$q .= 'limit='.$limit.'&offset='.$offset;
}
/**
- * Yay, more global functions!
+ * 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
+ * @return array
+ *
*/
function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
global $wgRequest;
return $out;
}
-/**
- * Returns an escaped string suitable for inclusion in a string literal
- * for JavaScript source code.
- * Illegal control characters are assumed not to be present.
- *
- * @param string $string
- * @return string
- */
-function wfEscapeJsString( $string ) {
- // See ECMA 262 section 7.8.4 for string literal format
- $pairs = array(
- "\\" => "\\\\",
- "\"" => "\\\"",
- '\'' => '\\\'',
- "\n" => "\\n",
- "\r" => "\\r",
-
- # To avoid closing the element or CDATA section
- "<" => "\\x3c",
- ">" => "\\x3e",
- );
- return strtr( $string, $pairs );
-}
/**
* @todo document
* @return float
*/
function wfTime() {
- $st = explode( ' ', microtime() );
- return (float)$st[0] + (float)$st[1];
-}
-
-/**
- * Changes the first character to an HTML entity
- */
-function wfHtmlEscapeFirst( $text ) {
- $ord = ord($text);
- $newText = substr($text, 1);
- return "&#$ord;$newText";
+ return microtime(true);
}
/**
}
if ( wfIsWindows() ) {
- $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
+ // Escaping for an MSVC-style command line parser
+ // Ref: http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
+ // Double the backslashes before any double quotes. Escape the double quotes.
+ $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
+ $arg = '';
+ $delim = false;
+ foreach ( $tokens as $token ) {
+ if ( $delim ) {
+ $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
+ } else {
+ $arg .= $token;
+ }
+ $delim = !$delim;
+ }
+ // Double the backslashes before the end of the string, because
+ // we will soon add a quote
+ if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
+ $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
+ }
+
+ // Add surrounding quotes
+ $retVal .= '"' . $arg . '"';
} else {
$retVal .= escapeshellarg( $arg );
}
* @param string $type
* @param array $avail
* @return string
- * @access private
+ * @private
*/
function mimeTypeMatch( $type, $avail ) {
if( array_key_exists($type, $avail) ) {
/**
* ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
*
- * This is used by Special:Export
+ * This is used by Special:Export
*/
define('TS_ISO_8601', 4);
/**
* 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
+ * @url 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.
*/
/**
* @param mixed $outputtype A timestamp in one of the supported formats, the
* function will autodetect which format is supplied
- and act accordingly.
+ * and act accordingly.
* @return string Time in the format specified in $outputtype
*/
function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
$uts = 0;
+ $da = array();
if ($ts==0) {
$uts=time();
} elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
case TS_ORACLE:
return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
default:
- wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
+ throw new MWException( 'wfTimestamp() called with illegal output type.');
}
}
$y = $z;
}
-function wfGetSiteNotice() {
- global $wgSiteNotice, $wgTitle, $wgOut, $parserMemc, $wgDBname;
- $fname = 'wfGetSiteNotice';
+function wfGetCachedNotice( $name ) {
+ global $wgOut, $parserMemc, $wgDBname;
+ $fname = 'wfGetCachedNotice';
wfProfileIn( $fname );
-
- $shouldParse=false;
-
- $notice = wfMsgForContent( '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;
+
+ $needParse = false;
+ $notice = wfMsgForContent( $name );
+ if( $notice == '<'. $name . ';>' || $notice == '-' ) {
+ wfProfileOut( $fname );
+ return( false );
}
- if($notice != '-' && $notice != '') {
- $cachednotice=$parserMemc->get("{$wgDBname}:sitenotice");
- if (is_array($cachednotice)) {
- if (md5($notice)==$cachednotice['hash']) {
- $notice = $cachednotice['html'];
- } else {
- $shouldParse=true;
- }
+
+ $cachedNotice = $parserMemc->get( $wgDBname . ':' . $name );
+ if( is_array( $cachedNotice ) ) {
+ if( md5( $notice ) == $cachedNotice['hash'] ) {
+ $notice = $cachedNotice['html'];
} else {
- $shouldParse=true;
+ $needParse = true;
}
- if ($shouldParse) {
- if( is_object( $wgOut ) ) {
- $parsed = $wgOut->parse( $notice );
- $parserMemc->set("{$wgDBname}:sitenotice",
- array('html' => $parsed, 'hash' => md5($notice)), 600);
- $notice = $parsed;
- } else {
- wfDebug( "wfGetSiteNotice called with no \$wgOut available" );
- $notice = '';
- }
+ } 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;
}
-/**
- * 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 string $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 .= '>';
+function wfGetNamespaceNotice() {
+ global $wgTitle;
+
+ # Paranoia
+ if ( !isset( $wgTitle ) || !is_object( $wgTitle ) )
+ return "";
+
+ $fname = 'wfGetNamespaceNotice';
+ wfProfileIn( $fname );
+
+ $key = "namespacenotice-" . $wgTitle->getNsText();
+ $namespaceNotice = wfGetCachedNotice( $key );
+ if ( $namespaceNotice && substr ( $namespaceNotice , 0 ,7 ) != "<p><" ) {
+ $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . "</div>";
} else {
- if( $contents == '' ) {
- $out .= ' />';
- } else {
- $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
- }
+ $namespaceNotice = "";
}
- 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 string $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 );
+ wfProfileOut( $fname );
+ return $namespaceNotice;
}
-// 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 = '';
+function wfGetSiteNotice() {
+ global $wgUser, $wgSiteNotice;
+ $fname = 'wfGetSiteNotice';
+ wfProfileIn( $fname );
+ $siteNotice = '';
+
+ if( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice ) ) ) {
+ if( is_object( $wgUser ) && $wgUser->isLoggedIn() ) {
+ $siteNotice = wfGetCachedNotice( 'sitenotice' );
+ $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
} else {
- // Let input be numeric strings without breaking the empty match.
- $selected = intval( $selected );
+ $anonNotice = wfGetCachedNotice( 'anonnotice' );
+ if( !$anonNotice ) {
+ $siteNotice = wfGetCachedNotice( 'sitenotice' );
+ $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
+ } else {
+ $siteNotice = $anonNotice;
+ }
}
}
- $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;
+ wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice ) );
+ wfProfileOut( $fname );
+ return $siteNotice;
}
/** Global singleton instance of MimeMagic. This is initialized on demand,
function wfMkdirParents( $fullDir, $mode ) {
$parts = explode( '/', $fullDir );
$path = '';
-
+
foreach ( $parts as $dir ) {
$path .= $dir . '/';
if ( !is_dir( $path ) ) {
/**
* Increment a statistics counter
*/
-function wfIncrStats( $key ) {
- global $wgDBname, $wgMemc;
- $key = "$wgDBname:stats:$key";
- if ( is_null( $wgMemc->incr( $key ) ) ) {
- $wgMemc->add( $key, 1 );
- }
-}
+ 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
*/
function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
if ( is_null( $changed ) ) {
- wfDebugDieBacktrace('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
+ throw new MWException('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
}
if ( $default[$key] !== $value ) {
$changed[$key] = $value;
return strpos( $str, $needle ) !== false;
}
+function wfSpecialList( $page, $details ) {
+ global $wgContLang;
+ $details = $details ? ' ' . $wgContLang->getDirMark() . "($details)" : "";
+ return $page . $details;
+}
+
/**
* Returns a regular expression of url protocols
*
function wfUrlProtocols() {
global $wgUrlProtocols;
- $protocols = array();
- foreach ($wgUrlProtocols as $protocol)
- $protocols[] = preg_quote( $protocol, '/' );
+ // Support old-style $wgUrlProtocols strings, for backwards compatibility
+ // with LocalSettings files from 1.5
+ if ( is_array( $wgUrlProtocols ) ) {
+ $protocols = array();
+ foreach ($wgUrlProtocols as $protocol)
+ $protocols[] = preg_quote( $protocol, '/' );
+
+ return implode( '|', $protocols );
+ } else {
+ return $wgUrlProtocols;
+ }
+}
+
+/**
+ * Execute a shell command, with time and memory limits mirrored from the PHP
+ * configuration if supported.
+ * @param $cmd Command line, properly escaped for shell.
+ * @param &$retval optional, will receive the program's exit code.
+ * (non-zero is usually failure)
+ * @return collected stdout as a string (trailing newlines stripped)
+ */
+function wfShellExec( $cmd, &$retval=null ) {
+ global $IP, $wgMaxShellMemory;
+
+ if( ini_get( 'safe_mode' ) ) {
+ wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
+ $retval = 1;
+ return "Unable to run external programs in safe mode.";
+ }
+
+ if ( php_uname( 's' ) == 'Linux' ) {
+ $time = ini_get( 'max_execution_time' );
+ $mem = intval( $wgMaxShellMemory );
+
+ if ( $time > 0 && $mem > 0 ) {
+ $script = "$IP/bin/ulimit.sh";
+ if ( is_executable( $script ) ) {
+ $cmd = escapeshellarg( $script ) . " $time $mem $cmd";
+ }
+ }
+ } elseif ( php_uname( 's' ) == 'Windows NT' ) {
+ # This is a hack to work around PHP's flawed invocation of cmd.exe
+ # http://news.php.net/php.internals/21796
+ $cmd = '"' . $cmd . '"';
+ }
+ wfDebug( "wfShellExec: $cmd\n" );
+
+ $output = array();
+ $retval = 1; // error by default?
+ $lastline = exec( $cmd, $output, $retval );
+ return implode( "\n", $output );
- return implode( '|', $protocols );
}
/**
- * Check if a string is well-formed XML.
- * Must include the surrounding tag.
+ * 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
*
- * @param string $text
- * @return bool
+ * 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
*
- * @todo Error position reporting return
+ * @param mixed $version The version to check, can be a string, an integer, or
+ * a float
*/
-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;
+function wfUsePHP( $req_ver ) {
+ $php_ver = PHP_VERSION;
+
+ if ( version_compare( $php_ver, (string)$req_ver, '<' ) )
+ throw new MWException( "PHP $req_ver required--this is only $php_ver" );
}
/**
- * 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.
+ * 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.
*
- * @param string $text
- * @return bool
+ * 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 wfIsWellFormedXmlFragment( $text ) {
- $html =
- '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" ' .
- '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' .
- '<html>' .
- $text .
- '</html>';
- return wfIsWellFormedXml( $html );
+function wfUseMW( $req_ver ) {
+ global $wgVersion;
+
+ if ( version_compare( $wgVersion, (string)$req_ver, '<' ) )
+ throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
}
/**
- * shell_exec() with time and memory limits mirrored from the PHP configuration,
- * if supported.
+ * Escape a string to make it suitable for inclusion in a preg_replace()
+ * replacement parameter.
+ *
+ * @param string $string
+ * @return string
*/
-function wfShellExec( $cmd )
+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 '';
+ }
+}
+
+/**
+ * Make a URL index, appropriate for the el_index field of externallinks.
+ */
+function wfMakeUrlIndex( $url ) {
+ wfSuppressWarnings();
+ $bits = parse_url( $url );
+ wfRestoreWarnings();
+ if ( !$bits || $bits['scheme'] !== 'http' ) {
+ return false;
+ }
+ // Reverse the labels in the hostname, convert to lower case
+ $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
+ // Add an extra dot to the end
+ if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
+ $reversedHost .= '.';
+ }
+ // Reconstruct the pseudo-URL
+ $index = "http://$reversedHost";
+ // Leave out user and password. Add the port, path, query and fragment
+ if ( isset( $bits['port'] ) ) $index .= ':' . $bits['port'];
+ if ( isset( $bits['path'] ) ) {
+ $index .= $bits['path'];
+ } else {
+ $index .= '/';
+ }
+ if ( isset( $bits['query'] ) ) $index .= '?' . $bits['query'];
+ if ( isset( $bits['fragment'] ) ) $index .= '#' . $bits['fragment'];
+ return $index;
+}
+
+/**
+ * Do any deferred updates and clear the list
+ * TODO: This could be in Wiki.php if that class made any sense at all
+ */
+function wfDoUpdates()
{
- global $IP;
+ global $wgPostCommitUpdateList, $wgDeferredUpdateList;
+ foreach ( $wgDeferredUpdateList as $update ) {
+ $update->doUpdate();
+ }
+ foreach ( $wgPostCommitUpdateList as $update ) {
+ $update->doUpdate();
+ }
+ $wgDeferredUpdateList = array();
+ $wgPostCommitUpdateList = array();
+}
+
+/**
+ * More or less "markup-safe" explode()
+ * Ignores any instances of the separator inside <...>
+ * @param string $separator
+ * @param string $text
+ * @return array
+ */
+function wfExplodeMarkup( $separator, $text ) {
+ $placeholder = "\x00";
- 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) );
+ // Just in case...
+ $text = str_replace( $placeholder, '', $text );
+
+ // Trim stuff
+ $replacer = new ReplacerCallback( $separator, $placeholder );
+ $cleaned = preg_replace_callback( '/(<.*?>)/', array( $replacer, 'go' ), $text );
+
+ $items = explode( $separator, $cleaned );
+ foreach( $items as $i => $str ) {
+ $items[$i] = str_replace( $placeholder, $separator, $str );
+ }
+
+ return $items;
+}
+
+class ReplacerCallback {
+ function ReplacerCallback( $from, $to ) {
+ $this->from = $from;
+ $this->to = $to;
+ }
+
+ function go( $matches ) {
+ return str_replace( $this->from, $this->to, $matches[1] );
+ }
+}
+
+
+/**
+ * Convert an arbitrarily-long digit string from one numeric base
+ * to another, optionally zero-padding to a minimum column width.
+ *
+ * Supports base 2 through 36; digit values 10-36 are represented
+ * as lowercase letters a-z. Input is case-insensitive.
+ *
+ * @param $input string of digits
+ * @param $sourceBase int 2-36
+ * @param $destBase int 2-36
+ * @param $pad int 1 or greater
+ * @return string or false on invalid input
+ */
+function wfBaseConvert( $input, $sourceBase, $destBase, $pad=1 ) {
+ if( $sourceBase < 2 ||
+ $sourceBase > 36 ||
+ $destBase < 2 ||
+ $destBase > 36 ||
+ $pad < 1 ||
+ $sourceBase != intval( $sourceBase ) ||
+ $destBase != intval( $destBase ) ||
+ $pad != intval( $pad ) ||
+ !is_string( $input ) ||
+ $input == '' ) {
+ return false;
+ }
+
+ $digitChars = '0123456789abcdefghijklmnopqrstuvwxyz';
+ $inDigits = array();
+ $outChars = '';
+
+ // Decode and validate input string
+ $input = strtolower( $input );
+ for( $i = 0; $i < strlen( $input ); $i++ ) {
+ $n = strpos( $digitChars, $input{$i} );
+ if( $n === false || $n > $sourceBase ) {
+ return false;
}
- if ( $time > 0 && $mem > 0 ) {
- $script = "$IP/bin/ulimit.sh";
- if ( is_executable( $script ) ) {
- $memKB = intval( $mem / 1024 );
- $cmd = escapeshellarg( $script ) . " $time $memKB $cmd";
+ $inDigits[] = $n;
+ }
+
+ // Iterate over the input, modulo-ing out an output digit
+ // at a time until input is gone.
+ while( count( $inDigits ) ) {
+ $work = 0;
+ $workDigits = array();
+
+ // Long division...
+ foreach( $inDigits as $digit ) {
+ $work *= $sourceBase;
+ $work += $digit;
+
+ if( $work < $destBase ) {
+ // Gonna need to pull another digit.
+ if( count( $workDigits ) ) {
+ // Avoid zero-padding; this lets us find
+ // the end of the input very easily when
+ // length drops to zero.
+ $workDigits[] = 0;
+ }
+ } else {
+ // Finally! Actual division!
+ $workDigits[] = intval( $work / $destBase );
+
+ // Isn't it annoying that most programming languages
+ // don't have a single divide-and-remainder operator,
+ // even though the CPU implements it that way?
+ $work = $work % $destBase;
}
}
+
+ // All that division leaves us with a remainder,
+ // which is conveniently our next output digit.
+ $outChars .= $digitChars[$work];
+
+ // And we continue!
+ $inDigits = $workDigits;
+ }
+
+ while( strlen( $outChars ) < $pad ) {
+ $outChars .= '0';
}
- return shell_exec( $cmd );
+
+ return strrev( $outChars );
}
?>