/**
* Global functions used everywhere
+ * @package MediaWiki
*/
/**
* Some globals and requires needed
*/
+/**
+ * Total number of articles
+ * @global integer $wgNumberOfArticles
+ */
$wgNumberOfArticles = -1; # Unset
+/**
+ * Total number of views
+ * @global integer $wgTotalViews
+ */
$wgTotalViews = -1;
+/**
+ * Total number of edits
+ * @global integer $wgTotalEdits
+ */
$wgTotalEdits = -1;
+
require_once( 'DatabaseFunctions.php' );
require_once( 'UpdateClasses.php' );
require_once( 'LogPage.php' );
+require_once( 'normal/UtfNormalUtil.php' );
/**
* Compatibility functions
* PHP <4.3.x is not actively supported; 4.1.x and 4.2.x might or might not work.
* <4.1.x will not work, as we use a number of features introduced in 4.1.0
* such as the new autoglobals.
-*/
+ */
if( !function_exists('iconv') ) {
# iconv support is not in the default configuration and so may not be present.
# Assume will only ever use utf-8 and iso-8859-1.
# UTF-8 substr function based on a PHP manual comment
if ( !function_exists( 'mb_substr' ) ) {
- function mb_substr($str,$start)
- {
- preg_match_all("/./us", $str, $ar);
+ 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));
+ 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));
+ return join( '', array_slice( $ar[0], $start ) );
}
}
}
/**
* html_entity_decode exists in PHP 4.3.0+ but is FATALLY BROKEN even then,
* with no UTF-8 support.
+ *
+ * @param string $string String having html entities
+ * @param $quote_style
+ * @param string $charset Encoding set to use (default 'ISO-8859-1')
*/
function do_html_entity_decode( $string, $quote_style=ENT_COMPAT, $charset='ISO-8859-1' ) {
static $trans;
- if( !isset( $trans ) ) {
+ static $savedCharset;
+ if( !isset( $trans ) || $savedCharset != $charset ) {
$trans = array_flip( get_html_translation_table( HTML_ENTITIES, $quote_style ) );
+ $savedCharset = $charset;
# Assumes $charset will always be the same through a run, and only understands
# utf-8 or default. Note - mixing latin1 named entities and unicode numbered
# ones will result in a bad link.
return strtr( $string, $trans );
}
+
+/**
+ * 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()
-{
+function wfSeedRandom() {
global $wgRandomSeeded;
if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
}
/**
- * Generates a URL from a URL-encoded title and a query string
- * Title::getLocalURL() is preferred in most cases
+ * 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 wfLocalUrl( $a, $q = '' )
-{
- global $wgServer, $wgScript, $wgArticlePath;
-
- $a = str_replace( ' ', '_', $a );
-
- if ( '' == $a ) {
- if( '' == $q ) {
- $a = $wgScript;
- } else {
- $a = $wgScript.'?'.$q;
- }
- } else if ( '' == $q ) {
- $a = str_replace( '$1', $a, $wgArticlePath );
- } else if ($wgScript != '' ) {
- $a = "{$wgScript}?title={$a}&{$q}";
- } else { //XXX hackish solution for toplevel wikis
- $a = "/{$a}?{$q}";
- }
- return $a;
-}
-
-/**
- * @todo document
- */
-function wfLocalUrlE( $a, $q = '' )
-{
- return htmlspecialchars( wfLocalUrl( $a, $q ) );
- # die( "Call to obsolete function wfLocalUrlE()" );
+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() * 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 )
-{
+function wfUrlencode ( $s ) {
$s = urlencode( $s );
$s = preg_replace( '/%3[Aa]/', ':', $s );
$s = preg_replace( '/%2[Ff]/', '/', $s );
/**
* Return the UTF-8 sequence for a given Unicode code point.
* Currently doesn't work for values outside the Basic Multilingual Plane.
-*/
+ *
+ * @param string $codepoint UTF-8 code point.
+ * @return string HTML UTF-8 Entitie such as 'Ӓ'.
+ */
function wfUtf8Sequence( $codepoint ) {
if($codepoint < 0x80) return chr($codepoint);
if($codepoint < 0x800) return chr($codepoint >> 6 & 0x3f | 0xc0) .
/**
* Converts numeric character entities to UTF-8
+ *
+ * @param string $string String to convert.
+ * @return string Converted string.
*/
function wfMungeToUtf8( $string ) {
global $wgInputEncoding; # This is debatable
/**
* Converts a single UTF-8 character into the corresponding HTML character
* entity (for use with preg_replace_callback)
+ *
+ * @param array $matches
+ *
*/
function wfUtf8Entity( $matches ) {
- $char = $matches[0];
- # Find the length
- $z = ord( $char{0} );
- if ( $z & 0x80 ) {
- $length = 0;
- while ( $z & 0x80 ) {
- $length++;
- $z <<= 1;
- }
- } else {
- $length = 1;
- }
-
- if ( $length != strlen( $char ) ) {
- return '';
- }
- if ( $length == 1 ) {
- return $char;
- }
-
- # Mask off the length-determining bits and shift back to the original location
- $z &= 0xff;
- $z >>= $length;
-
- # Add in the free bits from subsequent bytes
- for ( $i=1; $i<$length; $i++ ) {
- $z <<= 6;
- $z |= ord( $char{$i} ) & 0x3f;
- }
-
- # Make entity
- return "&#$z;";
+ $codepoint = utf8ToCodepoint( $matches[0] );
+ return "&#$codepoint;";
}
/**
}
/**
- * @todo document
+ * 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 )
-{
+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
/**
* Log for database errors
+ * @param string $text Database error message.
*/
function wfLogDBError( $text ) {
global $wgDBerrorLog;
/**
* @todo document
*/
-function logProfilingData()
-{
+function logProfilingData() {
global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
$now = wfTime();
* 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;
return is_file( $wgReadOnlyFile );
}
-$wgReplacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
/**
- * Get a message from anywhere
+ * Get a message from anywhere, for the UI elements
*/
function wfMsg( $key ) {
global $wgRequest;
+
if ( $wgRequest->getVal( 'debugmsg' ) ) {
if ( $key == 'linktrail' /* a special case where we want to return something specific */ )
return "/^()(.*)$/sD";
}
/**
- * Get a message from the language file
+ * Get a message from anywhere, for the content
+ */
+function wfMsgForContent( $key ) {
+ global $wgRequest;
+ if ( $wgRequest->getVal( 'debugmsg' ) ) {
+ if ( $key == 'linktrail' /* a special case where we want to return something specific */ )
+ return "/^()(.*)$/sD";
+ else
+ return $key;
+ }
+ $args = func_get_args();
+ if ( count( $args ) ) {
+ array_shift( $args );
+ }
+ return wfMsgReal( $key, $args, true, true );
+
+
+}
+
+/**
+ * Get a message from the language file, for the UI elements
*/
function wfMsgNoDB( $key ) {
$args = func_get_args();
}
/**
- * Really get a message
+ * Get a message from the language file, for the content
*/
-function wfMsgReal( $key, $args, $useDB ) {
- global $wgReplacementKeys, $wgMessageCache, $wgLang;
+function wfMsgNoDBForContent( $key ) {
+
+ $args = func_get_args();
+ if ( count( $args ) ) {
+ array_shift( $args );
+ }
+ return wfMsgReal( $key, $args, false, true );
+}
+
+/**
+ * Really get a message
+ */
+function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
+ static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
+ global $wgParser, $wgMsgParserOptions;
+ global $wgContLang, $wgLanguageCode;
+
$fname = 'wfMsg';
wfProfileIn( $fname );
- if ( $wgMessageCache ) {
- $message = $wgMessageCache->get( $key, $useDB );
- } elseif ( $wgLang ) {
- $message = $wgLang->getMessage( $key );
+
+ if($forContent) {
+ global $wgMessageCache;
+ $cache = &$wgMessageCache;
+ $lang = &$wgContLang;
+ }
+ else {
+ if(in_array($wgLanguageCode, $wgContLang->getVariants())){
+ global $wgLang, $wgMessageCache;
+ $cache = &$wgMessageCache;
+ $lang = $wgLang;
+ }
+ else {
+ global $wgLang;
+ $cache = false;
+ $lang = &$wgLang;
+ }
+ }
+
+
+ if ( is_object($cache) ) {
+ $message = $cache->get( $key, $useDB, $forContent );
+ } elseif (is_object($lang)) {
+ wfSuppressWarnings();
+ $message = $lang->getMessage( $key );
+ wfRestoreWarnings();
+ if(!$message)
+ $message = Language::getMessage($key);
+ if(strstr($message, '{{' ) !== false) {
+ $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
+ }
} else {
wfDebug( "No language object when getting $key\n" );
$message = "<$key>";
# Replace arguments
if( count( $args ) ) {
- $message = str_replace( $wgReplacementKeys, $args, $message );
+ $message = str_replace( $replacementKeys, $args, $message );
}
wfProfileOut( $fname );
return $message;
}
+
+
/**
* Just like exit() but makes a note of it.
* Commits open transactions except if the error parameter is set
}
/**
+ * 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;
/* Some generic result counters, pulled out of SearchEngine */
-function wfShowingResults( $offset, $limit )
-{
+
+/**
+ * @todo document
+ */
+function wfShowingResults( $offset, $limit ) {
global $wgLang;
return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
}
-function wfShowingResultsNum( $offset, $limit, $num )
-{
+/**
+ * @todo document
+ */
+function wfShowingResultsNum( $offset, $limit, $num ) {
global $wgLang;
return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
}
-function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false )
-{
+/**
+ * @todo document
+ */
+function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
global $wgUser, $wgLang;
$fmtLimit = $wgLang->formatNum( $limit );
$prev = wfMsg( 'prevn', $fmtLimit );
$next = wfMsg( 'nextn', $fmtLimit );
- $link = wfUrlencode( $link );
-
+
+ if( is_object( $link ) ) {
+ $title =& $link;
+ } else {
+ $title =& Title::newFromText( $link );
+ if( is_null( $title ) ) {
+ return false;
+ }
+ }
+
$sk = $wgUser->getSkin();
if ( 0 != $offset ) {
$po = $offset - $limit;
if ( $po < 0 ) { $po = 0; }
$q = "limit={$limit}&offset={$po}";
if ( '' != $query ) { $q .= '&'.$query; }
- $plink = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$prev}</a>";
+ $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
} else { $plink = $prev; }
$no = $offset + $limit;
if ( $atend ) {
$nlink = $next;
} else {
- $nlink = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$next}</a>";
+ $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
}
- $nums = wfNumLink( $offset, 20, $link , $query ) . ' | ' .
- wfNumLink( $offset, 50, $link, $query ) . ' | ' .
- wfNumLink( $offset, 100, $link, $query ) . ' | ' .
- wfNumLink( $offset, 250, $link, $query ) . ' | ' .
- wfNumLink( $offset, 500, $link, $query );
+ $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
+ wfNumLink( $offset, 50, $title, $query ) . ' | ' .
+ wfNumLink( $offset, 100, $title, $query ) . ' | ' .
+ wfNumLink( $offset, 250, $title, $query ) . ' | ' .
+ wfNumLink( $offset, 500, $title, $query );
return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
}
-function wfNumLink( $offset, $limit, $link, $query = '' )
-{
+/**
+ * @todo document
+ */
+function wfNumLink( $offset, $limit, &$title, $query = '' ) {
global $wgUser, $wgLang;
if ( '' == $query ) { $q = ''; }
else { $q = $query.'&'; }
$q .= 'limit='.$limit.'&offset='.$offset;
$fmtLimit = $wgLang->formatNum( $limit );
- $s = '<a href="' . wfLocalUrlE( $link, $q ) . "\">{$fmtLimit}</a>";
+ $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
return $s;
}
+/**
+ * @todo document
+ * @todo FIXME: we may want to blacklist some broken browsers
+ *
+ * @return bool Whereas client accept gzip compression
+ */
function wfClientAcceptsGzip() {
global $wgUseGzip;
if( $wgUseGzip ) {
* As required by the callers, <nowiki> is not used. It currently does
* not filter out characters which have special meaning only at the
* start of a line, such as "*".
+ *
+ * @param string $text Text to be escaped
*/
-function wfEscapeWikiText( $text )
-{
+function wfEscapeWikiText( $text ) {
$text = str_replace(
array( '[', '|', "'", 'ISBN ' , '://' , "\n=", '{{' ),
array( '[', '|', ''', 'ISBN ', '://' , "\n=", '{{' ),
return $text;
}
-function wfQuotedPrintable( $string, $charset = '' )
-{
+/**
+ * @todo document
+ */
+function wfQuotedPrintable( $string, $charset = '' ) {
# Probably incomplete; see RFC 2045
if( empty( $charset ) ) {
global $wgInputEncoding;
return $out;
}
-function wfTime(){
+/**
+ * @todo document
+ * @return float
+ */
+function wfTime() {
$st = explode( ' ', microtime() );
return (float)$st[0] + (float)$st[1];
}
* 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
*/
-function wfSetVar( &$dest, $source )
-{
+function wfSetVar( &$dest, $source ) {
$temp = $dest;
if ( !is_null( $source ) ) {
$dest = $source;
if ( '' != $cgi ) {
$cgi .= '&';
}
- $cgi .= $key.'='.$value;
+ $cgi .= urlencode( $key ) . '=' . urlencode( $value );
}
}
return $cgi;
* Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
* function puts single quotes in regardless of OS
*/
-function wfEscapeShellArg( )
-{
+function wfEscapeShellArg( ) {
$args = func_get_args();
$first = true;
$retVal = '';
/**
* @todo document
*/
-function wfVarDump( $var )
-{
+function wfVarDump( $var ) {
global $wgOut;
$s = str_replace("\n","<br>\n", var_export( $var, true ) . "\n");
if ( headers_sent() || !@is_object( $wgOut ) ) {
}
/**
- * @todo document
- * @private
+ * 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) ) {
}
/**
+ * 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
*/
* 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 )
-{
+function wfArrayLookup( $a, $b ) {
return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
}
-
/**
- * Ideally we'd be using actual time fields in the db
- * @todo fixme
+ * Convenience function; returns MediaWiki timestamp for the present time.
+ * @return string
*/
-function wfTimestamp2Unix( $ts ) {
- return gmmktime( ( (int)substr( $ts, 8, 2) ),
- (int)substr( $ts, 10, 2 ), (int)substr( $ts, 12, 2 ),
- (int)substr( $ts, 4, 2 ), (int)substr( $ts, 6, 2 ),
- (int)substr( $ts, 0, 4 ) );
-}
-
-function wfUnix2Timestamp( $unixtime ) {
- return gmdate( 'YmdHis', $unixtime );
-}
-
function wfTimestampNow() {
# return NOW
- return gmdate( 'YmdHis' );
+ return wfTimestamp( TS_MW, time() );
}
/**
}
# Autodetect, convert and provide timestamps of various types
-define('TS_UNIX',0); # Standard unix timestamp (number of seconds since 1 Jan 1970)
-define('TS_MW',1); # Mediawiki concatenated string timestamp (yyyymmddhhmmss)
-define('TS_DB',2); # Standard database timestamp (yyyy-mm-dd hh:mm:ss)
+
+/** Standard unix timestamp (number of seconds since 1 Jan 1970) */
+define('TS_UNIX',0);
+/** MediaWiki concatenated string timestamp (yyyymmddhhmmss) */
+define('TS_MW',1);
+/** Standard database timestamp (yyyy-mm-dd hh:mm:ss) */
+define('TS_DB',2);
/**
* @todo document
}
/**
+ * Check where as the operating system is Windows
+ *
* @todo document
+ * @return bool True if it's windows, False otherwise.
*/
function wfIsWindows() {
if (substr(php_uname(), 0, 7) == 'Windows') {
dépôts / lhc / web / wiklou.git / blobdiff