diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2013-01-18 16:46:04 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2013-01-18 16:46:04 +0100 |
commit | 63601400e476c6cf43d985f3e7b9864681695ed4 (patch) | |
tree | f7846203a952e38aaf66989d0a4702779f549962 /includes/Timestamp.php | |
parent | 8ff01378c9e0207f9169b81966a51def645b6a51 (diff) |
Update to MediaWiki 1.20.2
this update includes:
* adjusted Arch Linux skin
* updated FluxBBAuthPlugin
* patch for https://bugzilla.wikimedia.org/show_bug.cgi?id=44024
Diffstat (limited to 'includes/Timestamp.php')
-rw-r--r-- | includes/Timestamp.php | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/includes/Timestamp.php b/includes/Timestamp.php new file mode 100644 index 00000000..c9ba8d91 --- /dev/null +++ b/includes/Timestamp.php @@ -0,0 +1,229 @@ +<?php +/** + * Creation and parsing of MW-style timestamps. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + * @since 1.20 + * @author Tyler Romeo, 2012 + */ + +/** + * Library for creating and parsing MW-style timestamps. Based on the JS + * library that does the same thing. + * + * @since 1.20 + */ +class MWTimestamp { + /** + * Standard gmdate() formats for the different timestamp types. + */ + private static $formats = array( + TS_UNIX => 'U', + TS_MW => 'YmdHis', + TS_DB => 'Y-m-d H:i:s', + TS_ISO_8601 => 'Y-m-d\TH:i:s\Z', + TS_ISO_8601_BASIC => 'Ymd\THis\Z', + TS_EXIF => 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness + TS_RFC2822 => 'D, d M Y H:i:s', + TS_ORACLE => 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500 + TS_POSTGRES => 'Y-m-d H:i:s', + TS_DB2 => 'Y-m-d H:i:s', + ); + + /** + * Different units for human readable timestamps. + * @see MWTimestamp::getHumanTimestamp + */ + private static $units = array( + "milliseconds" => 1, + "seconds" => 1000, // 1000 milliseconds per second + "minutes" => 60, // 60 seconds per minute + "hours" => 60, // 60 minutes per hour + "days" => 24 // 24 hours per day + ); + + /** + * The actual timestamp being wrapped. Either a DateTime + * object or a string with a Unix timestamp depending on + * PHP. + * @var string|DateTime + */ + private $timestamp; + + /** + * Make a new timestamp and set it to the specified time, + * or the current time if unspecified. + * + * @param $timestamp bool|string Timestamp to set, or false for current time + */ + public function __construct( $timestamp = false ) { + $this->setTimestamp( $timestamp ); + } + + /** + * Set the timestamp to the specified time, or the current time if unspecified. + * + * Parse the given timestamp into either a DateTime object or a Unix timestamp, + * and then store it. + * + * @param $ts string|bool Timestamp to store, or false for now + * @throws TimestampException + */ + public function setTimestamp( $ts = false ) { + $da = array(); + $strtime = ''; + + if ( !$ts || $ts === "\0\0\0\0\0\0\0\0\0\0\0\0\0\0" ) { // We want to catch 0, '', null... but not date strings starting with a letter. + $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 ) ) { + # TS_EXIF + } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) { + # TS_MW + } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) { + # TS_UNIX + $strtime = "@$ts"; // http://php.net/manual/en/datetime.formats.compound.php + } 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 + $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 ) ) { + #TS_ISO_8601_BASIC + } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) { + # TS_POSTGRES + } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) { + # 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( '/^[ \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 { + throw new TimestampException( __METHOD__ . " : Invalid timestamp - $ts" ); + } + + if( !$strtime ) { + $da = array_map( 'intval', $da ); + $da[0] = "%04d-%02d-%02dT%02d:%02d:%02d.00+00:00"; + $strtime = call_user_func_array( "sprintf", $da ); + } + + if( function_exists( "date_create" ) ) { + try { + $final = new DateTime( $strtime, new DateTimeZone( 'GMT' ) ); + } catch(Exception $e) { + throw new TimestampException( __METHOD__ . ' Invalid timestamp format.' ); + } + } else { + $final = strtotime( $strtime ); + } + + if( $final === false ) { + throw new TimestampException( __METHOD__ . ' Invalid timestamp format.' ); + } + $this->timestamp = $final; + } + + /** + * Get the timestamp represented by this object in a certain form. + * + * Convert the internal timestamp to the specified format and then + * return it. + * + * @param $style int Constant Output format for timestamp + * @throws TimestampException + * @return string The formatted timestamp + */ + public function getTimestamp( $style = TS_UNIX ) { + if( !isset( self::$formats[$style] ) ) { + throw new TimestampException( __METHOD__ . ' : Illegal timestamp output type.' ); + } + + if( is_object( $this->timestamp ) ) { + // DateTime object was used, call DateTime::format. + $output = $this->timestamp->format( self::$formats[$style] ); + } elseif( TS_UNIX == $style ) { + // Unix timestamp was used and is wanted, just return it. + $output = $this->timestamp; + } else { + // Unix timestamp was used, use gmdate(). + $output = gmdate( self::$formats[$style], $this->timestamp ); + } + + if ( ( $style == TS_RFC2822 ) || ( $style == TS_POSTGRES ) ) { + $output .= ' GMT'; + } + + return $output; + } + + /** + * Get the timestamp in a human-friendly relative format, e.g., "3 days ago". + * + * Determine the difference between the timestamp and the current time, and + * generate a readable timestamp by returning "<N> <units> ago", where the + * largest possible unit is used. + * + * @return string Formatted timestamp + */ + public function getHumanTimestamp() { + $then = $this->getTimestamp( TS_UNIX ); + $now = time(); + $timeago = ($now - $then) * 1000; + $message = false; + + foreach( self::$units as $unit => $factor ) { + $next = $timeago / $factor; + if( $next < 1 ) { + break; + } else { + $timeago = $next; + $message = array( $unit, floor( $timeago ) ); + } + } + + if( $message ) { + $initial = call_user_func_array( 'wfMessage', $message ); + return wfMessage( 'ago', $initial ); + } else { + return wfMessage( 'just-now' ); + } + } + + /** + * @return string + */ + public function __toString() { + return $this->getTimestamp(); + } +} + +class TimestampException extends MWException {} |