documentation
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 6e01113..d310e27 100644 (file)
@@ -79,56 +79,6 @@ if ( !function_exists( 'mb_substr' ) ) {
        }
 }
 
-/**
- * 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 the quote style to pass as the second argument to
- *        get_html_translation_table()
- * @param string $charset Encoding set to use (default 'UTF-8')
- */
-function do_html_entity_decode( $string, $quote_style=ENT_COMPAT, $charset='UTF-8' ) {
-       $fname = 'do_html_entity_decode';
-       wfProfileIn( $fname );
-       
-       static $trans;
-       static $savedCharset;
-       static $regexp;
-       if( !isset( $trans ) || $savedCharset != $charset ) {
-               $trans = array_flip( get_html_translation_table( HTML_ENTITIES, $quote_style ) );
-               $savedCharset = $charset;
-               
-               # Note - mixing latin1 named entities and unicode numbered
-               # ones will result in a bad link.
-               if( strcasecmp( 'utf-8', $charset ) == 0 ) {
-                       $trans = array_map( 'utf8_encode', $trans );
-               }
-               
-               /**
-                * Most links will _not_ contain these fun guys,
-                * and on long pages with many links we can get
-                * called a lot.
-                *
-                * A regular expression search is faster than
-                * a strtr or str_replace with a hundred-ish
-                * entries, though it may be slower to actually
-                * replace things.
-                *
-                * They all look like '&xxxx;'...
-                */
-               foreach( $trans as $key => $val ) {
-                       $snip[] = substr( $key, 1, -1 );
-               }
-               $regexp = '/(&(?:' . implode( '|', $snip ) . ');)/e';
-       }
-
-       $out = preg_replace( $regexp, '$trans["$1"]', $string );
-       wfProfileOut( $fname );
-       return $out;
-}
-
-
 /**
  * Where as we got a random seed
  * @var bool $wgTotalViews
@@ -182,68 +132,6 @@ function wfUrlencode ( $s ) {
        return $s;
 }
 
-/**
- * Return the UTF-8 sequence for a given Unicode code point.
- * Doesn't work for values outside the Basic Multilingual Plane.
- *
- * @param string $codepoint UTF-8 code point.
- * @return string An UTF-8 character if the codepoint is in the BMP and
- *         &#$codepoint if it isn't;
- */
-function wfUtf8Sequence( $codepoint ) {
-       if($codepoint < 0x80)
-               return chr($codepoint);
-       if($codepoint < 0x800)
-               return chr($codepoint >> 6 & 0x3f | 0xc0) . chr($codepoint & 0x3f | 0x80);
-       if($codepoint < 0x10000)
-               return  chr($codepoint >> 12 & 0x0f | 0xe0) .
-                       chr($codepoint >> 6 & 0x3f | 0x80) .
-                       chr($codepoint & 0x3f | 0x80);
-       if($codepoint < 0x110000)
-               return  chr($codepoint >> 18 & 0x07 | 0xf0) .
-                       chr($codepoint >> 12 & 0x3f | 0x80) .
-                       chr($codepoint >> 6 & 0x3f | 0x80) .
-                       chr($codepoint & 0x3f | 0x80);
-       # There should be no assigned code points outside this range, but...
-       return "&#$codepoint;";
-}
-
-/**
- * Converts numeric character entities to UTF-8
- *
- * @todo Do named entities
- *
- * @param string $string String to convert.
- * @return string Converted string.
- */
-function wfMungeToUtf8( $string ) {
-       global $wgInputEncoding; # This is debatable
-       #$string = iconv($wgInputEncoding, "UTF-8", $string);
-       $string = preg_replace ( '/&#0*([0-9]+);/e', 'wfUtf8Sequence($1)', $string );
-       $string = preg_replace ( '/&#x([0-9a-f]+);/ie', 'wfUtf8Sequence(0x$1)', $string );
-       return $string;
-}
-
-/**
- * Converts a single UTF-8 character into the corresponding HTML character
- * entity (for use with preg_replace_callback)
- *
- * @param array $matches
- *
- */
-function wfUtf8Entity( $matches ) {
-       $codepoint = utf8ToCodepoint( $matches[0] );
-       return "&#$codepoint;";
-}
-
-/**
- * Converts all multi-byte characters in a UTF-8 string into the appropriate
- * character entity
- */
-function wfUtf8ToHTML($string) {
-       return preg_replace_callback( '/[\\xc0-\\xfd][\\x80-\\xbf]*/', 'wfUtf8Entity', $string );
-}
-
 /**
  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
  * In normal operation this is a NOP.
@@ -328,12 +216,23 @@ function logProfilingData() {
  * @return bool
  */
 function wfReadOnly() {
-       global $wgReadOnlyFile;
+       global $wgReadOnlyFile, $wgReadOnly;
 
+       if ( $wgReadOnly ) {
+               return true;
+       }
        if ( '' == $wgReadOnlyFile ) {
                return false;
        }
-       return is_file( $wgReadOnlyFile );
+       
+       // Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time
+       if ( is_file( $wgReadOnlyFile ) ) {
+               $wgReadOnly = true;
+       } else {
+               $wgReadOnly = false;
+       }
+       $wgReadOnlyFile = '';
+       return $wgReadOnly;
 }
 
 
@@ -390,14 +289,28 @@ function wfMsgNoDBForContent( $key ) {
  * Really get a message
  */
 function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
-       static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
+       $fname = 'wfMsgReal';
+       wfProfileIn( $fname );
+       
+       $message = wfMsgGetKey( $key, $useDB, $forContent );
+       $message = wfMsgReplaceArgs( $message, $args );
+       wfProfileOut( $fname );
+       return $message;
+}
+
+/**
+ * Fetch a message string value, but don't replace any keys yet.
+ * @param string $key
+ * @param bool $useDB
+ * @param bool $forContent
+ * @return string
+ * @access private
+ */
+function wfMsgGetKey( $key, $useDB, $forContent = false ) {
        global $wgParser, $wgMsgParserOptions;
        global $wgContLang, $wgLanguageCode;
        global $wgMessageCache, $wgLang;
        
-       $fname = 'wfMsgReal';
-       wfProfileIn( $fname );
-
        if( is_object( $wgMessageCache ) ) {
                $message = $wgMessageCache->get( $key, $useDB, $forContent );
        } else {
@@ -421,16 +334,49 @@ function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
                        $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
                }
        }
+       return $message;
+}
+
+/**
+ * Replace message parameter keys on the given formatted output.
+ *
+ * @param string $message
+ * @param array $args
+ * @return string
+ * @access private
+ */
+function wfMsgReplaceArgs( $message, $args ) {
+       static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
+       
+       # Fix windows line-endings
+       # Some messages are split with explode("\n", $msg)
+       $message = str_replace( "\r", '', $message );
 
        # Replace arguments
        if( count( $args ) ) {
                $message = str_replace( $replacementKeys, $args, $message );
        }
-       wfProfileOut( $fname );
        return $message;
 }
 
-
+/**
+ * Return an HTML-escaped version of a message.
+ * Parameter replacements, if any, are done *after* the HTML-escaping,
+ * so parameters may contain HTML (eg links or form controls). Be sure
+ * to pre-escape them if you really do want plaintext, or just wrap
+ * the whole thing in htmlspecialchars().
+ *
+ * @param string $key
+ * @param string ... parameters
+ * @return string
+ */
+function wfMsgHtml( $key ) {
+       $args = func_get_args();
+       array_shift( $args );
+       return wfMsgReplaceArgs(
+               htmlspecialchars( wfMsgGetKey( $key, $args, true ) ),
+               $args );
+}
 
 /**
  * Just like exit() but makes a note of it.
@@ -885,8 +831,14 @@ function wfHttpError( $code, $label, $desc ) {
        header( "Status: $code $label" );
        $wgOut->sendCacheControl();
 
-       header( 'Content-type: text/plain' );
-       print $desc."\n";
+       header( 'Content-type: text/html' );
+       print "<html><head><title>" .
+               htmlspecialchars( $label ) . 
+               "</title></head><body><h1>" . 
+               htmlspecialchars( $label ) .
+               "</h1><p>" .
+               htmlspecialchars( $desc ) .
+               "</p></body></html>\n";
 }
 
 /**
@@ -1193,10 +1145,12 @@ function wfGetSiteNotice() {
  * @param bool $contents NULL to make an open tag only; '' for a contentless closed tag (default)
  * @return string
  */
-function wfElement( $element, $attribs = array(), $contents = '') {
+function wfElement( $element, $attribs = null, $contents = '') {
        $out = '<' . $element;
-       foreach( $attribs as $name => $val ) {
-               $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"';
+       if( !is_null( $attribs ) ) {
+               foreach( $attribs as $name => $val ) {
+                       $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"';
+               }
        }
        if( is_null( $contents ) ) {
                $out .= '>';
@@ -1226,7 +1180,10 @@ function wfElementClean( $element, $attribs = array(), $contents = '') {
        if( $attribs ) {
                $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
        }
-       return wfElement( $element, $attribs, UtfNormal::cleanUp( $contents ) );
+       if( $contents ) {
+               $contents = UtfNormal::cleanUp( $contents );
+       }
+       return wfElement( $element, $attribs, $contents );
 }
 
 /** Global singleton instance of MimeMagic. This is initialized on demand,
@@ -1272,7 +1229,7 @@ function &wfGetMimeMagic() {
  */
 function wfTempDir() {
        foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
-               $tmp = getenv( 'TMPDIR' );
+               $tmp = getenv( $var );
                if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
                        return $tmp;
                }
@@ -1281,4 +1238,33 @@ function wfTempDir() {
        return '/tmp';
 }
 
+/**
+ * Make directory, and make all parent directories if they don't exist
+ */
+function wfMkdirParents( $fullDir, $mode ) {
+       $parts = explode( '/', $fullDir );
+       $path = '';
+       $success = false;
+       foreach ( $parts as $dir ) {
+               $path .= $dir . '/';
+               if ( !is_dir( $path ) ) {
+                       if ( !mkdir( $path, $mode ) ) {
+                               return false;
+                       }
+               }
+       }
+       return true;
+}
+
+/**
+ * Increment a statistics counter
+ */
+function wfIncrStats( $key ) {
+       global $wgDBname, $wgMemc;
+       $key = "$wgDBname:stats:$key";
+       if ( is_null( $wgMemc->incr( $key ) ) ) {
+               $wgMemc->add( $key, 1 );
+       }
+}
+
 ?>