Folowup r77763, add documentation for $wgFooterIcons.
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 80b15a3..8319c36 100644 (file)
@@ -214,7 +214,7 @@ function wfArrayDiff2_cmp( $a, $b ) {
        } else {
                reset( $a );
                reset( $b );
-               while( ( list( $keyA, $valueA ) = each( $a ) ) && ( list( $keyB, $valueB ) = each( $b ) ) ) {
+               while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
                        $cmp = strcmp( $valueA, $valueB );
                        if ( $cmp !== 0 ) {
                                return $cmp;
@@ -854,7 +854,7 @@ function wfMsgWikiHtml( $key ) {
  *   <i>content</i>: fetch message for content language instead of interface
  * Also can accept a single associative argument, of the form 'language' => 'xx':
  *   <i>language</i>: Language object or language code to fetch message for
- *       (overriden by <i>content</i>), its behaviour with parser, parseinline
+ *       (overriden by <i>content</i>), its behaviour with parse, parseinline
  *       and parsemag is undefined.
  * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
  */
@@ -1287,9 +1287,9 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
  */
 function wfEscapeWikiText( $text ) {
        $text = str_replace(
-               array( '[',     '|',      ']',     '\'',    'ISBN ',     
+               array( '[',     '|',      ']',     '\'',    'ISBN ',
                        'RFC ',     '://',     "\n=",     '{{',           '}}' ),
-               array( '&#91;', '&#124;', '&#93;', '&#39;', 'ISBN&#32;', 
+               array( '&#91;', '&#124;', '&#93;', '&#39;', 'ISBN&#32;',
                        'RFC&#32;', '&#58;//', "\n&#61;", '&#123;&#123;', '&#125;&#125;' ),
                htmlspecialchars( $text )
        );
@@ -1981,13 +1981,16 @@ define( 'TS_ISO_8601_BASIC', 9 );
  *                    function will autodetect which format is supplied and act
  *                    accordingly.
  * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
- * @return String: in the format specified in $outputtype
+ * @return Mixed: String / false The same date in the format specified in $outputtype or false
  */
 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
        $uts = 0;
        $da = array();
+       $strtime = '';
+
        if ( $ts === 0 ) {
                $uts = time();
+               $strtime = "@$uts";
        } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
                # TS_DB
        } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
@@ -1997,10 +2000,11 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
        } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
                # TS_UNIX
                $uts = $ts;
+               $strtime = "@$ts"; // Undocumented?
        } 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 ) ) );
+               $strtime = 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 ) ) {
                # TS_ISO_8601
        } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
@@ -2011,21 +2015,26 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                # TS_POSTGRES
        } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
                # TS_DB2
-       } elseif ( preg_match( '/^[A-Z][a-z]{2}, \d\d [A-Z][a-z]{2} \d{4} \d\d:\d\d:\d\d/', $ts ) ) {
-               # TS_RFC2822
-               $uts = strtotime( $ts );
+       } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
+                                                       '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' .  # dd Mon yyyy
+                                                       '[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d/S', $ts ) ) { # hh:mm:ss
+               # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
+               # The regex is a superset of rfc2822 for readability 
+               $strtime = strtok( $ts, ';' );
+       } elseif ( preg_match( '/^[A-Z][a-z]{5,8}, \d\d-[A-Z][a-z]{2}-\d{2} \d\d:\d\d:\d\d/', $ts ) ) {
+               # TS_RFC850
+               $strtime = $ts;
+       } elseif ( preg_match( '/^[A-Z][a-z]{2} [A-Z][a-z]{2} +\d{1,2} \d\d:\d\d:\d\d \d{4}/', $ts ) ) {
+               # asctime
+               $strtime = $ts;
        } else {
                # Bogus value; fall back to the epoch...
                wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
-               $uts = 0;
+               
+               return false;
        }
 
-       if (count( $da ) ) {
-               // Warning! gmmktime() acts oddly if the month or day is set to 0
-               // We may want to handle that explicitly at some point
-               $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
-                       (int)$da[2], (int)$da[3], (int)$da[1] );
-       }
+
 
        static $formats = array(
                TS_UNIX => 'U',
@@ -2044,11 +2053,45 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                throw new MWException( 'wfTimestamp() called with illegal output type.' );
        }
 
-       if ( TS_UNIX == $outputtype ) {
-               return $uts;
-       }
+       if ( function_exists( "date_create" ) ) {
+               if ( count( $da ) ) {
+                       $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
+                               (int)$da[1], (int)$da[2], (int)$da[3],
+                               (int)$da[4], (int)$da[5], (int)$da[6]);
+
+                       $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
+               } elseif ( $strtime ) {
+                       $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
+               } else {
+                       return false;
+               }
+               
+               if ( !$d ) {
+                       wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
+                       return false;
+               }
+               
+               $output = $d->format( $formats[$outputtype] );
+       } else {
+               if ( count( $da ) ) {
+                       // Warning! gmmktime() acts oddly if the month or day is set to 0
+                       // We may want to handle that explicitly at some point
+                       $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
+                               (int)$da[2], (int)$da[3], (int)$da[1] );
+               } elseif ( $strtime ) {
+                       $uts = strtotime( $strtime );
+               }
+
+               if ( $uts === false ) {
+                       wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
+                       return false;
+               }
 
-       $output = gmdate( $formats[$outputtype], $uts );
+               if ( TS_UNIX == $outputtype ) {
+                       return $uts;
+               }
+               $output = gmdate( $formats[$outputtype], $uts );
+       }
 
        if ( ( $outputtype == TS_RFC2822 ) || ( $outputtype == TS_POSTGRES ) ) {
                $output .= ' GMT';
@@ -2467,7 +2510,7 @@ function wfDl( $extension ) {
  * @param $cmd String Command line, properly escaped for shell.
  * @param &$retval optional, will receive the program's exit code.
  *                 (non-zero is usually failure)
- * @param $environ Array optional environment variables which should be 
+ * @param $environ Array optional environment variables which should be
  *                 added to the executed command environment.
  * @return collected stdout as a string (trailing newlines stripped)
  */
@@ -2502,22 +2545,22 @@ function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
        $envcmd = '';
        foreach( $environ as $k => $v ) {
                if ( wfIsWindows() ) {
-                       /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves 
-                        * appear in the environment variable, so we must use carat escaping as documented in 
-                        * http://technet.microsoft.com/en-us/library/cc723564.aspx 
-                        * Note however that the quote isn't listed there, but is needed, and the parentheses 
+                       /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
+                        * appear in the environment variable, so we must use carat escaping as documented in
+                        * http://technet.microsoft.com/en-us/library/cc723564.aspx
+                        * Note however that the quote isn't listed there, but is needed, and the parentheses
                         * are listed there but doesn't appear to need it.
                         */
                        $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . ' && ';
                } else {
-                       /* Assume this is a POSIX shell, thus required to accept variable assignments before the command 
+                       /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
                         * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
                         */
                        $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
                }
        }
        $cmd = $envcmd . $cmd;
-       
+
        if ( wfIsWindows() ) {
                if ( version_compare( PHP_VERSION, '5.3.0', '<' ) && /* Fixed in 5.3.0 :) */
                        ( version_compare( PHP_VERSION, '5.2.1', '>=' ) || php_uname( 's' ) == 'Windows NT' ) )
@@ -3163,7 +3206,7 @@ function wfFindFile( $title, $options = array() ) {
 /**
  * Get an object referring to a locally registered file.
  * Returns a valid placeholder object if the file does not exist.
- * @param $title Either a string or Title object
+ * @param $title Title or String
  * @return File, or null if passed an invalid Title
  */
 function wfLocalFile( $title ) {
@@ -3542,20 +3585,20 @@ function wfArrayMap( $function, $input ) {
 
 /**
  * Returns the PackageRepository object for interaction with the package repository.
- * 
- * TODO: Make the repository type also configurable. 
- * 
+ *
+ * TODO: Make the repository type also configurable.
+ *
  * @since 1.17
- * 
+ *
  * @return PackageRepository
  */
 function wfGetRepository() {
        global $wgRepositoryApiLocation;
        static $repository = false;
-       
+
        if ( $repository === false ) {
                $repository = new DistributionRepository( $wgRepositoryApiLocation );
        }
-       
+
        return $repository;
 }