changed wfMsgExt()'s warnings to use the new wfWarn() so that the caller function...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index c9a7693..3da1399 100644 (file)
@@ -72,6 +72,54 @@ if ( !function_exists( 'mb_strlen' ) ) {
        }
 }
 
+
+if( !function_exists( 'mb_strpos' ) ) {
+       /**
+        * Fallback implementation of mb_strpos, hardcoded to UTF-8.
+        * @param string $haystack
+        * @param string $needle
+        * @param string $offset optional start position
+        * @param string $encoding optional encoding; ignored
+        * @return int
+        */
+       function mb_strpos( $haystack, $needle, $offset = 0, $encoding="" ) {
+               $needle = preg_quote( $needle, '/' );
+
+               $ar = array();
+               preg_match( '/'.$needle.'/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
+
+               if( isset( $ar[0][1] ) ) {
+                       return $ar[0][1];
+               } else {
+                       return false;
+               }
+       }
+}
+
+if( !function_exists( 'mb_strrpos' ) ) {
+       /**
+        * Fallback implementation of mb_strrpos, hardcoded to UTF-8.
+        * @param string $haystack
+        * @param string $needle
+        * @param string $offset optional start position
+        * @param string $encoding optional encoding; ignored
+        * @return int
+        */
+       function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = "" ) {
+               $needle = preg_quote( $needle, '/' );
+
+               $ar = array();
+               preg_match_all( '/'.$needle.'/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
+
+               if( isset( $ar[0] ) && count( $ar[0] ) > 0 && 
+                   isset( $ar[0][count($ar[0])-1][1] ) ) {
+                       return $ar[0][count($ar[0])-1][1];
+               } else {
+                       return false;
+               } 
+       }
+}
+
 if ( !function_exists( 'array_diff_key' ) ) {
        /**
         * Exists in PHP 5.1.0+
@@ -350,12 +398,14 @@ function wfErrorLog( $text, $file ) {
  */
 function wfLogProfilingData() {
        global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
-       global $wgProfiler, $wgUser;
-       if ( !isset( $wgProfiler ) )
-               return;
-
+       global $wgProfiler, $wgProfileLimit, $wgUser;
+       # Profiling must actually be enabled...
+       if( !isset( $wgProfiler ) ) return;
+       # Get total page request time
        $now = wfTime();
        $elapsed = $now - $wgRequestTime;
+       # Only show pages that longer than $wgProfileLimit time (default is 0)
+       if( $elapsed <= $wgProfileLimit ) return;
        $prof = wfGetProfilingOutput( $wgRequestTime, $elapsed );
        $forward = '';
        if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
@@ -556,7 +606,7 @@ function wfMsgNoDBForContent( $key ) {
  * @param $forContent Boolean
  * @return String: the requested message.
  */
-function wfMsgReal( $key, $args, $useDB = true, $forContent=false, $transform = true ) {
+function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
        wfProfileIn( __METHOD__ );
        $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
        $message = wfMsgReplaceArgs( $message, $args );
@@ -568,7 +618,7 @@ function wfMsgReal( $key, $args, $useDB = true, $forContent=false, $transform =
  * This function provides the message source for messages to be edited which are *not* stored in the database.
  * @param $key String:
  */
-function wfMsgWeirdKey ( $key ) {
+function wfMsgWeirdKey( $key ) {
        $source = wfMsgGetKey( $key, false, true, false );
        if ( wfEmptyMsg( $key, $source ) )
                return "";
@@ -706,12 +756,12 @@ function wfMsgExt( $key, $options ) {
        foreach( $options as $arrayKey => $option ) {
                if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
                        # An unknown index, neither numeric nor "language"
-                       trigger_error( "wfMsgExt called with incorrect parameter key $arrayKey", E_USER_WARNING );
+                       wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING );
                } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
                array( 'parse', 'parseinline', 'escape', 'escapenoentities',
                'replaceafter', 'parsemag', 'content' ) ) ) {
                        # A numeric index with unknown value
-                       trigger_error( "wfMsgExt called with incorrect parameter $option", E_USER_WARNING );
+                       wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING );
                }
        }
 
@@ -873,18 +923,35 @@ function wfHostname() {
  * murky circumstances, which may be triggered in part by stub objects
  * or other fancy talkin'.
  *
- * Will return an empty array if Zend Optimizer is detected, otherwise
- * the output from debug_backtrace() (trimmed).
+ * Will return an empty array if Zend Optimizer is detected or if
+ * debug_backtrace is disabled, otherwise the output from
+ * debug_backtrace() (trimmed).
  *
  * @return array of backtrace information
  */
 function wfDebugBacktrace() {
+       static $disabled = null;
+
        if( extension_loaded( 'Zend Optimizer' ) ) {
                wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
                return array();
-       } else {
-               return array_slice( debug_backtrace(), 1 );
        }
+
+       if ( is_null( $disabled ) ) {
+               $disabled = false;
+               $functions = explode( ',', ini_get( 'disable_functions' ) );
+               $functions = array_map( 'trim', $functions );
+               $functions = array_map( 'strtolower', $functions );
+               if ( in_array( 'debug_backtrace', $functions ) ) {
+                       wfDebug( "debug_backtrace is in disabled_functions\n" );
+                       $disabled = true;
+               }
+       }
+       if ( $disabled ) {
+               return array();
+       }
+
+       return array_slice( debug_backtrace(), 1 );
 }
 
 function wfBacktrace() {
@@ -940,7 +1007,8 @@ function wfBacktrace() {
  */
 function wfShowingResults( $offset, $limit ) {
        global $wgLang;
-       return wfMsgExt( 'showingresults', array( 'parseinline' ), $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
+       return wfMsgExt( 'showingresults', array( 'parseinline' ), $wgLang->formatNum( $limit ),
+               $wgLang->formatNum( $offset+1 ) );
 }
 
 /**
@@ -948,18 +1016,29 @@ function wfShowingResults( $offset, $limit ) {
  */
 function wfShowingResultsNum( $offset, $limit, $num ) {
        global $wgLang;
-       return wfMsgExt( 'showingresultsnum', array( 'parseinline' ), $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
+       return wfMsgExt( 'showingresultsnum', array( 'parseinline' ), $wgLang->formatNum( $limit ), 
+               $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 }
 
 /**
- * @todo document
+ * Generate (prev x| next x) (20|50|100...) type links for paging
+ * @param $offset string
+ * @param $limit int
+ * @param $link string
+ * @param $query string, optional URL query parameter string
+ * @param $atend bool, optional param for specified if this is the last page
  */
 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
        global $wgLang;
        $fmtLimit = $wgLang->formatNum( $limit );
-       $prev = wfMsg( 'prevn', $fmtLimit );
-       $next = wfMsg( 'nextn', $fmtLimit );
-
+       // FIXME: Why on earth this needs one message for the text and another one for tooltip??
+       # Get prev/next link display text
+       $prev =  wfMsgExt( 'prevn', array('parsemag','escape'), $fmtLimit );
+       $next =  wfMsgExt( 'nextn', array('parsemag','escape'), $fmtLimit );
+       # Get prev/next link title text
+       $pTitle = wfMsgExt( 'prevn-title', array('parsemag','escape'), $fmtLimit );
+       $nTitle = wfMsgExt( 'nextn-title', array('parsemag','escape'), $fmtLimit );
+       # Fetch the title object
        if( is_object( $link ) ) {
                $title =& $link;
        } else {
@@ -968,44 +1047,58 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
                        return false;
                }
        }
-
-       if ( 0 != $offset ) {
+       # Make 'previous' link
+       if( 0 != $offset ) {
                $po = $offset - $limit;
-               if ( $po < 0 ) { $po = 0; }
+               $po = max($po,0);
                $q = "limit={$limit}&offset={$po}";
-               if ( '' != $query ) { $q .= '&'.$query; }
-               $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-prevlink\">{$prev}</a>";
-       } else { $plink = $prev; }
-
+               if( $query != '' ) {
+                       $q .= '&'.$query;
+               }
+               $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
+       } else { 
+               $plink = $prev;
+       }
+       # Make 'next' link
        $no = $offset + $limit;
-       $q = 'limit='.$limit.'&offset='.$no;
-       if ( '' != $query ) { $q .= '&'.$query; }
-
-       if ( $atend ) {
+       $q = "limit={$limit}&offset={$no}";
+       if( $query != '' ) {
+               $q .= '&'.$query;
+       }
+       if( $atend ) {
                $nlink = $next;
        } else {
-               $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-nextlink\">{$next}</a>";
+               $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
        }
-       $nums = $wgLang->pipeList( array( 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 );
+       # Make links to set number of items per page
+       $nums = $wgLang->pipeList( array( 
+               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 wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums );
 }
 
 /**
- * @todo document
+ * Generate links for (20|50|100...) items-per-page links
+ * @param $offset string
+ * @param $limit int
+ * @param $title Title
+ * @param $query string, optional URL query parameter string
  */
-function wfNumLink( $offset, $limit, &$title, $query = '' ) {
+function wfNumLink( $offset, $limit, $title, $query = '' ) {
        global $wgLang;
-       if ( '' == $query ) { $q = ''; }
-       else { $q = $query.'&'; }
-       $q .= 'limit='.$limit.'&offset='.$offset;
-
+       if( $query == '' ) { 
+               $q = '';
+       } else { 
+               $q = $query.'&';
+       }
+       $q .= "limit={$limit}&offset={$offset}";
        $fmtLimit = $wgLang->formatNum( $limit );
-       $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-numlink\">{$fmtLimit}</a>";
+       $lTitle = wfMsgExt('shown-title',array('parsemag','escape'),$limit);
+       $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\" title=\"{$lTitle}\" class=\"mw-numlink\">{$fmtLimit}</a>";
        return $s;
 }
 
@@ -1138,20 +1231,21 @@ function wfArrayToCGI( $array1, $array2 = NULL )
                        if ( '' != $cgi ) {
                                $cgi .= '&';
                        }
-                       if(is_array($value))
-                       {
+                       if ( is_array( $value ) ) {
                                $firstTime = true;
-                               foreach($value as $v)
-                               {
-                                       $cgi .= ($firstTime ? '' : '&') .
+                               foreach ( $value as $v ) {
+                                       $cgi .= ( $firstTime ? '' : '&') .
                                                urlencode( $key . '[]' ) . '=' .
                                                urlencode( $v );
                                        $firstTime = false;
                                }
-                       }
-                       else
+                       } else {
+                               if ( is_object( $value ) ) {
+                                       $value = $value->__toString();
+                               }
                                $cgi .= urlencode( $key ) . '=' .
                                        urlencode( $value );
+                       }
                }
        }
        return $cgi;
@@ -1190,10 +1284,13 @@ function wfCgiToArray( $query ) {
  * have query string parameters already. If so, they will be combined.
  *
  * @param string $url
- * @param string $query
+ * @param mixed $query String or associative array
  * @return string
  */
 function wfAppendQuery( $url, $query ) {
+       if ( is_array( $query ) ) {
+               $query = wfArrayToCGI( $query );
+       }
        if( $query != '' ) {
                if( false === strpos( $url, '?' ) ) {
                        $url .= '?';
@@ -1349,6 +1446,10 @@ function wfMerge( $old, $mine, $yours, &$result ){
  * @return string Unified diff of $before and $after
  */
 function wfDiff( $before, $after, $params = '-u' ) {
+       if ($before == $after) {
+               return '';
+       }
+       
        global $wgDiff;
 
        # This check may also protect against code injection in
@@ -1730,8 +1831,8 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
        } elseif (preg_match('/^\d{1,13}$/D',$ts)) {
                # TS_UNIX
                $uts = $ts;
-       } elseif (preg_match('/^\d{1,2}-...-\d\d(?:\d\d)? \d\d\.\d\d\.\d\d/', $ts)) {
-               # TS_ORACLE
+       } elseif (preg_match('/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts)) {
+               # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
                $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
                                str_replace("+00:00", "UTC", $ts)));
        } elseif (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da)) {
@@ -1768,7 +1869,8 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
                case TS_RFC2822:
                        return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
                case TS_ORACLE:
-                       return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
+                       return gmdate( 'd-m-Y H:i:s.000000', $uts);
+                       //return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
                case TS_POSTGRES:
                        return gmdate( 'Y-m-d H:i:s', $uts) . ' GMT';
                case TS_DB2:
@@ -1949,14 +2051,21 @@ function wfTempDir() {
  * 
  * @param string $dir Full path to directory to create
  * @param int $mode Chmod value to use, default is $wgDirectoryMode
+ * @param string $caller Optional caller param for debugging.
  * @return bool
  */
-function wfMkdirParents( $dir, $mode = null ) {
+function wfMkdirParents( $dir, $mode = null, $caller = null ) {
        global $wgDirectoryMode;
 
+       if ( !is_null( $caller ) ) {
+               wfDebug( "$caller: called wfMkdirParents($dir)" );
+       }
+
        if( strval( $dir ) === '' || file_exists( $dir ) )
                return true;
 
+       $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $dir );
+
        if ( is_null( $mode ) )
                $mode = $wgDirectoryMode;
 
@@ -2604,13 +2713,14 @@ function wfHttpOnlySafe() {
  * Initialise php session
  */
 function wfSetupSession() {
-       global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly;
+       global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain, 
+                       $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
        if( $wgSessionsInMemcached ) {
                require_once( 'MemcachedSessions.php' );
-       } elseif( 'files' != ini_get( 'session.save_handler' ) ) {
-               # If it's left on 'user' or another setting from another
-               # application, it will end up failing. Try to recover.
-               ini_set ( 'session.save_handler', 'files' );
+       } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
+               # Only set this if $wgSessionHandler isn't null and session.save_handler
+               # hasn't already been set to the desired value (that causes errors)
+               ini_set ( 'session.save_handler', $wgSessionHandler );
        }
        $httpOnlySafe = wfHttpOnlySafe();
        wfDebugLog( 'cookie',
@@ -2897,19 +3007,19 @@ function wfMaxlagError( $host, $lag, $maxLag ) {
 }
 
 /**
- * Throws an E_USER_NOTICE saying that $function is deprecated
+ * Throws a warning that $function is deprecated
  * @param string $function
  * @return null
  */
 function wfDeprecated( $function ) {
-       global $wgDebugLogFile;
-       if ( !$wgDebugLogFile ) {
-               return;
-       }
+       wfWarn( "Use of $function is deprecated.", 2 );
+}
+
+function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
        $callers = wfDebugBacktrace();
-       if( isset( $callers[2] ) ){
-               $callerfunc = $callers[2];
-               $callerfile = $callers[1];
+       if( isset( $callers[$callerOffset+1] ) ){
+               $callerfunc = $callers[$callerOffset+1];
+               $callerfile = $callers[$callerOffset];
                if( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ){
                        $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
                } else {
@@ -2919,11 +3029,15 @@ function wfDeprecated( $function ) {
                if( isset( $callerfunc['class'] ) )
                        $func .= $callerfunc['class'] . '::';
                $func .= @$callerfunc['function'];
-               $msg = "Use of $function is deprecated. Called from $func in $file";
+               $msg .= " [Called from $func in $file]";
+       }
+
+       global $wgDevelopmentWarnings;
+       if ( $wgDevelopmentWarnings ) {
+               trigger_error( $msg, $level );
        } else {
-               $msg = "Use of $function is deprecated.";
+               wfDebug( "$msg\n" );
        }
-       wfDebug( "$msg\n" );
 }
 
 /**
@@ -2988,3 +3102,39 @@ function wfStripIllegalFilenameChars( $name ) {
        $name = preg_replace ( "/[^".Title::legalChars()."]|:/", '-', $name );
        return $name;
 }
+
+/**
+  * Insert array into another array after the specified *KEY*
+  * @param array $array        The array.
+  * @param array $insert       The array to insert.
+  * @param mixed $after        The key to insert after
+  */
+function wfArrayInsertAfter( $array, $insert, $after ) {
+       // Find the offset of the element to insert after.
+       $keys = array_keys($array);
+       $offsetByKey = array_flip( $keys );
+       
+       $offset = $offsetByKey[$after];
+       
+       // Insert at the specified offset
+       $before = array_slice( $array, 0, $offset + 1, true );
+       $after = array_slice( $array, $offset + 1, count($array)-$offset, true );
+       
+       $output = $before + $insert + $after;
+       
+       return $output;
+}
+
+/* Recursively converts the parameter (an object) to an array with the same data */
+function wfObjectToArray( $object, $recursive = true ) {
+       $array = array();
+       foreach ( get_object_vars($object) as $key => $value ) {
+               if ( is_object($value) && $recursive ) {
+                       $value = wfObjectToArray( $value );
+               }
+               
+               $array[$key] = $value;
+       }
+       
+       return $array;
+}