remove extra whitespace; testing commit notifications
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 878a6d6..b39a8ab 100644 (file)
@@ -22,7 +22,6 @@ $wgTotalViews = -1;
 $wgTotalEdits = -1;
 
 
-global $IP;
 require_once dirname(__FILE__) . '/LogPage.php';
 require_once dirname(__FILE__) . '/normal/UtfNormalUtil.php';
 require_once dirname(__FILE__) . '/XmlFunctions.php';
@@ -68,7 +67,7 @@ if ( !function_exists( 'mb_strlen' ) ) {
         * @param string $enc optional encoding; ignored
         * @return int
         */
-       function new_mb_strlen( $str, $enc="" ) {
+       function mb_strlen( $str, $enc="" ) {
                $counts = count_chars( $str );
                $total = 0;
 
@@ -240,7 +239,7 @@ function wfLogDBError( $text ) {
 function wfErrorLog( $text, $file ) {
        wfSuppressWarnings();
        $exists = file_exists( $file );
-       $size = filesize( $file );
+       $size = $exists ? filesize( $file ) : false;
        if ( !$exists || ( $size !== false && $size + strlen( $text ) < 0x7fffffff ) ) {
                error_log( $text, 3, $file );
        }
@@ -327,6 +326,20 @@ function wfMsg( $key ) {
        return wfMsgReal( $key, $args, true );
 }
 
+/**
+ * Get a message in the user interface language and replace wiki
+ * links with clickable ones, escaping other HTML
+ *
+ * @param string $key Message key
+ * @return string
+ */
+function wfMsgWithLinks( $key ) {
+       global $wgUser;
+       $args = func_get_args();
+       return $wgUser->getSkin()->formatLinksInComment( htmlspecialchars(
+               call_user_func_array( 'wfMsg', $args ) ) );
+}
+
 /**
  * Same as above except doesn't transform the message
  */
@@ -369,6 +382,19 @@ function wfMsgForContent( $key ) {
        return wfMsgReal( $key, $args, true, $forcontent );
 }
 
+/**
+ * Get a message in the content language and replace wiki
+ * links with clickable ones, escaping other HTML
+ *
+ * @param string $key Message key
+ * @return string
+ */
+function wfMsgForContentWithLinks( $key ) {
+       global $wgUser;
+       return $wgUser->getSkin()->formatLinksInComment( htmlspecialchars(
+               call_user_func_array( 'wfMsgForContent', func_get_args() ) ) );
+}
+
 /**
  * Same as above except doesn't transform the message
  */
@@ -430,18 +456,11 @@ function wfMsgReal( $key, $args, $useDB = true, $forContent=false, $transform =
  * @param $key String:
  */
 function wfMsgWeirdKey ( $key ) {
-       $subsource = str_replace ( ' ' , '_' , $key ) ;
-       $source = wfMsgForContentNoTrans( $subsource ) ;
-       if ( wfEmptyMsg( $subsource, $source) ) {
-               # Try again with first char lower case
-               $subsource = strtolower ( substr ( $subsource , 0 , 1 ) ) . substr ( $subsource , 1 ) ;
-               $source = wfMsgForContentNoTrans( $subsource ) ;
-       }
-       if ( wfEmptyMsg( $subsource, $source ) ) {
-               # Didn't work either, return blank text
-               $source = "" ;
-       }
-       return $source ;
+       $source = wfMsgGetKey( $key, false, true, false );
+       if ( wfEmptyMsg( $key, $source ) )
+               return "";
+       else
+               return $source;
 }
 
 /**
@@ -455,6 +474,17 @@ function wfMsgWeirdKey ( $key ) {
 function wfMsgGetKey( $key, $useDB, $forContent = false, $transform = true ) {
        global $wgParser, $wgContLang, $wgMessageCache, $wgLang;
 
+       /* <Vyznev> btw, is all that code in wfMsgGetKey() that check
+        * if the message cache exists of not really necessary, or is
+        * it just paranoia?
+        * <TimStarling> Vyznev: it's probably not necessary
+        * <TimStarling> I think I wrote it in an attempt to report DB
+        * connection errors properly
+        * <TimStarling> but eventually we gave up on using the
+        * message cache for that and just hard-coded the strings
+        * <TimStarling> it may have other uses, it's not mere paranoia
+        */
+
        if ( is_object( $wgMessageCache ) )
                $transstat = $wgMessageCache->getTransform();
 
@@ -469,16 +499,18 @@ function wfMsgGetKey( $key, $useDB, $forContent = false, $transform = true ) {
                        $lang = &$wgLang;
                }
 
-               wfSuppressWarnings();
+               # MessageCache::get() does this already, Language::getMessage() doesn't
+               # ISSUE: Should we try to handle "message/lang" here too?
+               $key = str_replace( ' ' , '_' , $wgContLang->lcfirst( $key ) );
 
+               wfSuppressWarnings();
                if( is_object( $lang ) ) {
                        $message = $lang->getMessage( $key );
                } else {
                        $message = false;
                }
                wfRestoreWarnings();
-               if($message === false)
-                       $message = Language::getMessage($key);
+
                if ( $transform && strstr( $message, '{{' ) !== false ) {
                        $message = $wgParser->transformMsg($message, $wgMessageCache->getParserOptions() );
                }
@@ -559,11 +591,11 @@ function wfMsgWikiHtml( $key ) {
  * 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
- *  <i>parsemag<i>: transform the message using magic phrases
+ *  <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
+ *  <i>parsemag</i>: transform the message using magic phrases
  */
 function wfMsgExt( $key, $options ) {
        global $wgOut, $wgParser;
@@ -587,7 +619,7 @@ function wfMsgExt( $key, $options ) {
        } elseif ( in_array('parseinline', $options) ) {
                $string = $wgOut->parse( $string, true, true );
                $m = array();
-               if( preg_match( "~^<p>(.*)\n?</p>$~", $string, $m ) ) {
+               if( preg_match( '/^<p>(.*)\n?<\/p>$/sU', $string, $m ) ) {
                        $string = $m[1];
                }
        } elseif ( in_array('parsemag', $options) ) {
@@ -613,7 +645,7 @@ function wfMsgExt( $key, $options ) {
  * 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
+ * @deprecated Please return control to the caller or throw an exception
  */
 function wfAbruptExit( $error = false ){
        global $wgLoadBalancer;
@@ -643,7 +675,7 @@ function wfAbruptExit( $error = false ){
 }
 
 /**
- * @obsolete Please return control the caller or throw an exception
+ * @deprecated Please return control the caller or throw an exception
  */
 function wfErrorExit() {
        wfAbruptExit( true );
@@ -814,7 +846,7 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
                if ( $po < 0 ) { $po = 0; }
                $q = "limit={$limit}&offset={$po}";
                if ( '' != $query ) { $q .= '&'.$query; }
-               $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
+               $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-prevlink\">{$prev}</a>";
        } else { $plink = $prev; }
 
        $no = $offset + $limit;
@@ -824,7 +856,7 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
        if ( $atend ) {
                $nlink = $next;
        } else {
-               $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
+               $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-nextlink\">{$next}</a>";
        }
        $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
          wfNumLink( $offset, 50, $title, $query ) . ' | ' .
@@ -845,7 +877,7 @@ function wfNumLink( $offset, $limit, &$title, $query = '' ) {
        $q .= 'limit='.$limit.'&offset='.$offset;
 
        $fmtLimit = $wgLang->formatNum( $limit );
-       $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
+       $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-numlink\">{$fmtLimit}</a>";
        return $s;
 }
 
@@ -984,6 +1016,26 @@ function wfArrayToCGI( $array1, $array2 = NULL )
        return $cgi;
 }
 
+/**
+ * Append a query string to an existing URL, which may or may not already
+ * have query string parameters already. If so, they will be combined.
+ *
+ * @param string $url
+ * @param string $query
+ * @return string
+ */
+function wfAppendQuery( $url, $query ) {
+       if( $query != '' ) {
+               if( false === strpos( $url, '?' ) ) {
+                       $url .= '?';
+               } else {
+                       $url .= '&';
+               }
+               $url .= $query;
+       }
+       return $url;
+}
+
 /**
  * This is obsolete, use SquidUpdate::purge()
  * @deprecated
@@ -1148,7 +1200,7 @@ function wfHttpError( $code, $label, $desc ) {
  * Note that some PHP configuration options may add output buffer
  * layers which cannot be removed; these are left in place.
  *
- * @parameter bool $resetGzipEncoding
+ * @param bool $resetGzipEncoding
  */
 function wfResetOutputBuffers( $resetGzipEncoding=true ) {
        if( $resetGzipEncoding ) {
@@ -1382,7 +1434,7 @@ define('TS_ISO_8601', 4);
 /**
  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
  *
- * @url http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
+ * @see 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.
  */
@@ -1801,14 +1853,14 @@ function wfShellExec( $cmd, &$retval=null ) {
        }
 
        if ( php_uname( 's' ) == 'Linux' ) {
-               $time = ini_get( 'max_execution_time' );
+               $time = intval( ini_get( 'max_execution_time' ) );
                $mem = intval( $wgMaxShellMemory );
                $filesize = intval( $wgMaxShellFileSize );
 
                if ( $time > 0 && $mem > 0 ) {
-                       $script = "$IP/bin/ulimit-tvf.sh";
+                       $script = "$IP/bin/ulimit4.sh";
                        if ( is_executable( $script ) ) {
-                               $cmd = escapeshellarg( $script ) . " $time $mem $filesize $cmd";
+                               $cmd = escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
                        }
                }
        } elseif ( php_uname( 's' ) == 'Windows NT' ) {
@@ -1933,22 +1985,45 @@ function wfRelativePath( $path, $from ) {
  * Make a URL index, appropriate for the el_index field of externallinks.
  */
 function wfMakeUrlIndex( $url ) {
-       wfSuppressWarnings();
+       global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
        $bits = parse_url( $url );
-       $prots = array( 'http', 'https', 'ftp', 'irc', 'news' );
+       wfSuppressWarnings();
        wfRestoreWarnings();
-       if ( !$bits || !in_array( $bits['scheme'], $prots ) ) {
+       if ( !$bits ) {
+               return false;
+       }
+       // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
+       $delimiter = '';
+       if ( in_array( $bits['scheme'] . '://' , $wgUrlProtocols ) ) {
+               $delimiter = '://';
+       } elseif ( in_array( $bits['scheme'] .':' , $wgUrlProtocols ) ) {
+               $delimiter = ':';
+               // parse_url detects for news: and mailto: the host part of an url as path
+               // We have to correct this wrong detection
+               if ( isset ( $bits['path'] ) ) { 
+                       $bits['host'] = $bits['path'];
+                       $bits['path'] = '';
+               }
+       } else {
                return false;
        }
+
        // Reverse the labels in the hostname, convert to lower case
-       $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
+       // For emails reverse domainpart only
+       if ( $bits['scheme'] == 'mailto' ) {
+               $mailparts = explode( '@', $bits['host'] );
+               $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
+               $reversedHost = $domainpart . '@' . $mailparts[0];
+       } else {
+               $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
        $prot = $bits['scheme'];
-       $index = "$prot://$reversedHost";
+       $index = "$prot$delimiter$reversedHost";
        // Leave out user and password. Add the port, path, query and fragment
        if ( isset( $bits['port'] ) )      $index .= ':' . $bits['port'];
        if ( isset( $bits['path'] ) ) {
@@ -1996,6 +2071,7 @@ function wfExplodeMarkup( $separator, $text ) {
  * @param $sourceBase int 2-36
  * @param $destBase int 2-36
  * @param $pad int 1 or greater
+ * @param $lowercase bool
  * @return string or false on invalid input
  */
 function wfBaseConvert( $input, $sourceBase, $destBase, $pad=1, $lowercase=true ) {
@@ -2223,4 +2299,26 @@ function &wfGetDB( $db = DB_LAST, $groups = array() ) {
        $ret = $wgLoadBalancer->getConnection( $db, true, $groups );
        return $ret;
 }
+
+/**
+ * Find a file. 
+ * Shortcut for RepoGroup::singleton()->findFile()
+ * @param mixed $title Title object or string. May be interwiki.
+ * @param mixed $time Requested time for an archived image, or false for the 
+ *                    current version. An image object will be returned which 
+ *                    existed at or before the specified time.
+ * @return File, or false if the file does not exist
+ */
+function wfFindFile( $title, $time = false ) {
+       return RepoGroup::singleton()->findFile( $title, $time );
+}
+
+/**
+ * Get an object referring to a locally registered file.
+ * Returns a valid placeholder object if the file does not exist.
+ */
+function wfLocalFile( $title ) {
+       return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
+}
+
 ?>