Somehow managed to forget to check this in...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 377ee11..5502d9c 100644 (file)
@@ -30,6 +30,7 @@ require_once( 'DatabaseFunctions.php' );
 require_once( 'UpdateClasses.php' );
 require_once( 'LogPage.php' );
 require_once( 'normal/UtfNormalUtil.php' );
+require_once( 'XmlFunctions.php' );
 
 /**
  * Compatibility functions
@@ -107,9 +108,6 @@ if ( !function_exists( 'array_diff_key' ) ) {
        }
 }
 
-// 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.
@@ -167,7 +165,7 @@ function wfRandom() {
  * 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 ) {
@@ -188,8 +186,8 @@ 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;
@@ -214,9 +212,9 @@ function wfDebug( $text, $logonly = false ) {
  * 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 ) {
@@ -232,7 +230,7 @@ function wfDebugLog( $logGroup, $text, $public = true ) {
 
 /**
  * Log for database errors
- * @param string $text Database error message.
+ * @param $text String: database error message.
  */
 function wfLogDBError( $text ) {
        global $wgDBerrorLog;
@@ -312,7 +310,7 @@ function wfReadOnly() {
  * 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 ) {
@@ -349,7 +347,7 @@ function wfMsgNoTrans( $key ) {
  * 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 ) {
@@ -403,6 +401,10 @@ function wfMsgNoDBForContent( $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 ) {
        $fname = 'wfMsgReal';
@@ -413,9 +415,9 @@ function wfMsgReal( $key, $args, $useDB, $forContent=false, $transform = true )
 }
 
 /**
- * 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 ) ;
@@ -437,7 +439,7 @@ function wfMsgWeirdKey ( $key ) {
  * @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;
@@ -483,7 +485,7 @@ function wfMsgGetKey( $key, $useDB, $forContent = false, $transform = true ) {
  * @param string $message
  * @param array $args
  * @return string
- * @access private
+ * @private
  */
 function wfMsgReplaceArgs( $message, $args ) {
        # Fix windows line-endings
@@ -542,6 +544,52 @@ function wfMsgWikiHtml( $key ) {
        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;
+
+       $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('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
@@ -640,7 +688,7 @@ function wfDebugDieBacktrace( $msg = '' ) {
                        # This may be a virtual server.
                        $hostname = $_SERVER['SERVER_NAME'];
                }
-               $com = sprintf( "<!-- Served by %s in %01.2f secs. -->",
+               $com = sprintf( "<!-- Served by %s in %01.3f secs. -->",
                  $hostname, $elapsed );
                return $com;
        }
@@ -793,7 +841,13 @@ function wfClientAcceptsGzip() {
 }
 
 /**
- * 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;
@@ -839,29 +893,6 @@ function wfQuotedPrintable( $string, $charset = '' ) {
        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
@@ -872,15 +903,6 @@ function wfTime() {
        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";
-}
-
 /**
  * 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
@@ -970,7 +992,7 @@ function wfEscapeShellArg( ) {
                                }
                                $delim = !$delim;
                        }
-                       // Double the backslashes before the end of the string, because 
+                       // 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] );
@@ -1115,7 +1137,7 @@ function wfAcceptToPrefs( $accept, $def = '*/*' ) {
  * @param string $type
  * @param array $avail
  * @return string
- * @access private
+ * @private
  */
 function mimeTypeMatch( $type, $avail ) {
        if( array_key_exists($type, $avail) ) {
@@ -1262,7 +1284,7 @@ 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.
  */
@@ -1275,8 +1297,8 @@ define('TS_ORACLE', 6);
 
 /**
  * @param mixed $outputtype A timestamp in one of the supported formats, the
- *                         function will autodetect which format is supplied
-                           and act accordingly.
+ *                          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) {
@@ -1453,104 +1475,10 @@ function wfGetSiteNotice() {
        return( $siteNotice );
 }
 
-/**
- * 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 .= '>';
-       } else {
-               if( $contents == '' ) {
-                       $out .= ' />';
-               } else {
-                       $out .= '>' . htmlspecialchars( $contents ) . "</$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 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 );
-}
-
-// 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 id='namespace' 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.
 *
-* @access private
+* @private
 */
 $wgMimeMagic= NULL;
 
@@ -1622,19 +1550,6 @@ function wfMkdirParents( $fullDir, $mode ) {
  */
  function wfIncrStats( $key ) {
         global $wgDBname, $wgMemc;
-        /* LIVE HACK AVOID MEMCACHED ACCESSES DURING HIGH LOAD */
-        if ($wgDBname != 'enwiki' and $wgDBname != 'dewiki' and $wgDBname != 'commonswiki' and $wgDBname != 'testwiki')
-                return true;
-        static $socket;
-        if (!$socket) {
-                $socket=socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
-                $statline="{$wgDBname} - 1 1 1 1 1 -total\n";
-                socket_sendto($socket,$statline,strlen($statline),0,"webster","3811");
-        }
-        $statline="{$wgDBname} - 1 1 1 1 1 {$key}\n";
-        socket_sendto($socket,$statline,strlen($statline),0,"webster","3811");
-        return true;
-
         $key = "$wgDBname:stats:$key";
         if ( is_null( $wgMemc->incr( $key ) ) ) {
                 $wgMemc->add( $key, 1 );
@@ -1713,7 +1628,7 @@ function in_string( $needle, $str ) {
 function wfUrlProtocols() {
        global $wgUrlProtocols;
 
-       // Support old-style $wgUrlProtocols strings, for backwards compatibility 
+       // Support old-style $wgUrlProtocols strings, for backwards compatibility
        // with LocalSettings files from 1.5
        if ( is_array( $wgUrlProtocols ) ) {
                $protocols = array();
@@ -1726,50 +1641,6 @@ function wfUrlProtocols() {
        }
 }
 
-/**
- * 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.
@@ -1796,6 +1667,7 @@ function wfShellExec( $cmd )
                # http://news.php.net/php.internals/21796
                $cmd = '"' . $cmd . '"';
        }
+       wfDebug( "wfShellExec: $cmd\n" );
        return shell_exec( $cmd );
 }
 
@@ -1910,7 +1782,7 @@ function wfMakeUrlIndex( $url ) {
 function wfDoUpdates()
 {
        global $wgPostCommitUpdateList, $wgDeferredUpdateList;
-       foreach ( $wgDeferredUpdateList as $update ) { 
+       foreach ( $wgDeferredUpdateList as $update ) {
                $update->doUpdate();
        }
        foreach ( $wgPostCommitUpdateList as $update ) {
@@ -1920,4 +1792,40 @@ function wfDoUpdates()
        $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";
+       
+       // 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] );
+       }
+}
+
 ?>