MWTimestamp.php

Go to the documentation of this file.

<?php
class MWTimestamp {
    private static $formats = [
        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',
    ];

    public $timestamp;

    public function __construct( $timestamp = false ) {
        $this->setTimestamp( $timestamp );
    }

    public function setTimestamp( $ts = false ) {
        $m = [];
        $da = [];
        $strtime = '';

        // We want to catch 0, '', null... but not date strings starting with a letter.
        if ( !$ts || $ts === "\0\0\0\0\0\0\0\0\0\0\0\0\0\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 ) ) {
            # 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+)?$/D', $ts, $m ) ) {
            # TS_UNIX
            $strtime = "@{$m[1]}"; // 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(
            # Day of week
            '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' .
            # dd Mon yyyy
            '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' .
            # hh:mm:ss
            '[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d/S',
            $ts
        ) ) {
            # 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 );
        }

        try {
            $final = new DateTime( $strtime, new DateTimeZone( 'GMT' ) );
        } catch ( Exception $e ) {
            throw new TimestampException( __METHOD__ . ': Invalid timestamp format.', $e->getCode(), $e );
        }

        if ( $final === false ) {
            throw new TimestampException( __METHOD__ . ': Invalid timestamp format.' );
        }
        $this->timestamp = $final;
    }

    public function getTimestamp( $style = TS_UNIX ) {
        if ( !isset( self::$formats[$style] ) ) {
            throw new TimestampException( __METHOD__ . ': Illegal timestamp output type.' );
        }

        $output = $this->timestamp->format( self::$formats[$style] );

        if ( ( $style == TS_RFC2822 ) || ( $style == TS_POSTGRES ) ) {
            $output .= ' GMT';
        }

        if ( $style == TS_MW && strlen( $output ) !== 14 ) {
            throw new TimestampException( __METHOD__ . ': The timestamp cannot be represented in ' .
                'the specified format' );
        }

        return $output;
    }

    public function getHumanTimestamp(
        MWTimestamp $relativeTo = null, User $user = null, Language $lang = null
    ) {
        if ( $lang === null ) {
            $lang = RequestContext::getMain()->getLanguage();
        }

        return $lang->getHumanTimestamp( $this, $relativeTo, $user );
    }

    public function offsetForUser( User $user ) {
        global $wgLocalTZoffset;

        $option = $user->getOption( 'timecorrection' );
        $data = explode( '|', $option, 3 );

        // First handle the case of an actual timezone being specified.
        if ( $data[0] == 'ZoneInfo' ) {
            try {
                $tz = new DateTimeZone( $data[2] );
            } catch ( Exception $e ) {
                $tz = false;
            }

            if ( $tz ) {
                $this->timestamp->setTimezone( $tz );
                return new DateInterval( 'P0Y' );
            } else {
                $data[0] = 'Offset';
            }
        }

        $diff = 0;
        // If $option is in fact a pipe-separated value, check the
        // first value.
        if ( $data[0] == 'System' ) {
            // First value is System, so use the system offset.
            if ( $wgLocalTZoffset !== null ) {
                $diff = $wgLocalTZoffset;
            }
        } elseif ( $data[0] == 'Offset' ) {
            // First value is Offset, so use the specified offset
            $diff = (int)$data[1];
        } else {
            // $option actually isn't a pipe separated value, but instead
            // a comma separated value. Isn't MediaWiki fun?
            $data = explode( ':', $option );
            if ( count( $data ) >= 2 ) {
                // Combination hours and minutes.
                $diff = abs( (int)$data[0] ) * 60 + (int)$data[1];
                if ( (int)$data[0] < 0 ) {
                    $diff *= -1;
                }
            } else {
                // Just hours.
                $diff = (int)$data[0] * 60;
            }
        }

        $interval = new DateInterval( 'PT' . abs( $diff ) . 'M' );
        if ( $diff < 1 ) {
            $interval->invert = 1;
        }

        $this->timestamp->add( $interval );
        return $interval;
    }

    public function getRelativeTimestamp(
        MWTimestamp $relativeTo = null,
        User $user = null,
        Language $lang = null,
        array $chosenIntervals = []
    ) {
        if ( $relativeTo === null ) {
            $relativeTo = new self;
        }
        if ( $user === null ) {
            $user = RequestContext::getMain()->getUser();
        }
        if ( $lang === null ) {
            $lang = RequestContext::getMain()->getLanguage();
        }

        $ts = '';
        $diff = $this->diff( $relativeTo );
        if ( Hooks::run(
            'GetRelativeTimestamp',
            [ &$ts, &$diff, $this, $relativeTo, $user, $lang ]
        ) ) {
            $seconds = ( ( ( $diff->days * 24 + $diff->h ) * 60 + $diff->i ) * 60 + $diff->s );
            $ts = wfMessage( 'ago', $lang->formatDuration( $seconds, $chosenIntervals ) )
                ->inLanguage( $lang )->text();
        }

        return $ts;
    }

    public function __toString() {
        return $this->getTimestamp();
    }

    public function diff( MWTimestamp $relativeTo ) {
        return $this->timestamp->diff( $relativeTo->timestamp );
    }

    public function setTimezone( $timezone ) {
        try {
            $this->timestamp->setTimezone( new DateTimeZone( $timezone ) );
        } catch ( Exception $e ) {
            throw new TimestampException( __METHOD__ . ': Invalid timezone.', $e->getCode(), $e );
        }
    }

    public function getTimezone() {
        return $this->timestamp->getTimezone();
    }

    public function getTimezoneMessage() {
        $tzMsg = $this->format( 'T' );  // might vary on DST changeover!
        $key = 'timezone-' . strtolower( trim( $tzMsg ) );
        $msg = wfMessage( $key );
        if ( $msg->exists() ) {
            return $msg;
        } else {
            return new RawMessage( $tzMsg );
        }
    }

    public function format( $format ) {
        return $this->timestamp->format( $format );
    }

    public static function getLocalInstance( $ts = false ) {
        global $wgLocaltimezone;
        $timestamp = new self( $ts );
        $timestamp->setTimezone( $wgLocaltimezone );
        return $timestamp;
    }

    public static function getInstance( $ts = false ) {
        return new self( $ts );
    }
}