wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Lib\Formatters;

use DataValues\TimeValue;
use InvalidArgumentException;
use MediaWiki\Html\Html;
use ValueFormatters\FormatterOptions;
use ValueFormatters\ValueFormatter;

/**
 * Formatter for rendering the details of a TimeValue (most useful for diffs) in HTML.
 *
 * @see \Wikibase\Lib\Formatters\HtmlTimeFormatter
 *
 * @license GPL-2.0-or-later
 * @author Daniel Kinzler
 * @author Thiemo Kreuz
 */
class TimeDetailsFormatter implements ValueFormatter {

    /**
     * @var ValueFormatter A TimeValue formatter that outputs HTML.
     */
    private $timeFormatter;

    /**
     * @var FormatterOptions
     */
    private $options;

    /**
     * @param FormatterOptions|null $options
     * @param ValueFormatter $timeFormatter A TimeValue formatter that outputs a single line of
     * HTML, suitable for headings.
     */
    public function __construct(
        ?FormatterOptions $options,
        ValueFormatter $timeFormatter
    ) {
        $this->options = $options ?: new FormatterOptions();
        $this->options->defaultOption( ValueFormatter::OPT_LANG, 'en' );

        $this->timeFormatter = $timeFormatter;
    }

    /**
     * @see ValueFormatter::format
     *
     * Generates HTML representing the details of a TimeValue,
     * as an itemized list.
     *
     * @param TimeValue $value
     *
     * @throws InvalidArgumentException
     * @return string HTML
     */
    public function format( $value ) {
        if ( !( $value instanceof TimeValue ) ) {
            throw new InvalidArgumentException( 'Data value type mismatch. Expected a TimeValue.' );
        }

        $timeHtml = $this->getTimestampHtml( $value->getTime() );

        $timeZone = $value->getTimezone();
        $timeZoneHtml = is_int( $timeZone )
            ? $this->getTimeZoneHtml( $timeZone )
            : htmlspecialchars( $timeZone );

        $calendarHtml = $this->getCalendarModelHtml( $value->getCalendarModel() );

        $precision = $value->getPrecision();
        $before = $value->getBefore();
        $after = $value->getAfter();
        if ( is_int( $precision ) && is_int( $before ) && is_int( $after ) ) {
            $precisionHtml = $this->getAmountAndPrecisionHtml( $precision );
            $beforeHtml = $this->getAmountAndPrecisionHtml( $precision, $before );
            $afterHtml = $this->getAmountAndPrecisionHtml( $precision, $after );
        } else {
            $precisionHtml = htmlspecialchars( (string)$precision );
            $beforeHtml = htmlspecialchars( (string)$value->getBefore() );
            $afterHtml = htmlspecialchars( (string)$value->getAfter() );
        }

        $html = '';
        $html .= Html::rawElement(
            'b',
            [ 'class' => 'wb-details wb-time-details wb-time-rendered' ],
            $this->timeFormatter->format( $value )
        );
        $html .= Html::openElement( 'table', [ 'class' => 'wb-details wb-time-details' ] );

        $html .= $this->getFieldHtml( 'isotime', $timeHtml );
        $html .= $this->getFieldHtml( 'timezone', $timeZoneHtml );
        $html .= $this->getFieldHtml( 'calendar', $calendarHtml );
        $html .= $this->getFieldHtml( 'precision', $precisionHtml );
        $html .= $this->getFieldHtml( 'before', $beforeHtml );
        $html .= $this->getFieldHtml( 'after', $afterHtml );

        $html .= Html::closeElement( 'table' );

        return $html;
    }

    /**
     * @param string $timestamp
     *
     * @return string HTML
     */
    private function getTimestampHtml( $timestamp ) {
        // Loose check if the ISO-like string contains at least year, month, day and the "T".
        if ( !preg_match( '/^([-+]?)(\d+)(-\d+-\d+T.*)/', $timestamp, $matches ) ) {
            return htmlspecialchars( $timestamp );
        }

        [ , $sign, $year, $rest ] = $matches;

        // Actual MINUS SIGN (U+2212) instead of HYPHEN-MINUS (U+002D)
        $sign = $sign === '-' ? "\xE2\x88\x92" : '+';
        // Warning, never cast the year to integer to not run into 32-bit integer overflows!
        $year = ltrim( $year, '0' );
        // Keep the sign. Pad the year. Keep month, day, time, and timezone.
        return htmlspecialchars( $sign . str_pad( $year, 4, '0', STR_PAD_LEFT ) . $rest );
    }

    /**
     * @param int $timezone in minutes
     *
     * @return string HTML
     */
    private function getTimeZoneHtml( $timezone ) {
        // Actual MINUS SIGN (U+2212) instead of HYPHEN-MINUS (U+002D)
        $sign = $timezone < 0 ? "\xE2\x88\x92" : '+';
        $hour = (int)( abs( $timezone ) / 60 );
        $minute = abs( $timezone ) - $hour * 60;
        return $sign . sprintf( '%02d:%02d', $hour, $minute );
    }

    /**
     * @param string $calendarModel URI
     *
     * @return string HTML
     */
    private function getCalendarModelHtml( $calendarModel ) {
        switch ( $calendarModel ) {
            case TimeValue::CALENDAR_GREGORIAN:
                $key = 'valueview-expert-timevalue-calendar-gregorian';
                break;
            case TimeValue::CALENDAR_JULIAN:
                $key = 'valueview-expert-timevalue-calendar-julian';
                break;
            default:
                return htmlspecialchars( $calendarModel );
        }

        return htmlspecialchars( $this->msg( $key ) );
    }

    /**
     * @param int $precision One of the TimeValue::PRECISION_... constants.
     * @param int $amount
     *
     * @return string HTML
     */
    private function getAmountAndPrecisionHtml( $precision, $amount = 1 ) {
        if ( $amount === 0 ) {
            // TODO: Use NumberLocalizer
            return '0';
        }

        $key = 'years';

        switch ( $precision ) {
            case TimeValue::PRECISION_MONTH:
                $key = 'months';
                break;
            case TimeValue::PRECISION_DAY:
                $key = 'days';
                break;
            case TimeValue::PRECISION_HOUR:
                $key = 'hours';
                break;
            case TimeValue::PRECISION_MINUTE:
                $key = 'minutes';
                break;
            case TimeValue::PRECISION_SECOND:
                $key = 'seconds';
                break;
        }

        if ( $precision < TimeValue::PRECISION_YEAR ) {
            // PRECISION_YEAR10 becomes 10 years, PRECISION_YEAR100 becomes 100 years, and so on.
            $precisionInYears = pow( 10, TimeValue::PRECISION_YEAR - $precision );
            $amount *= $precisionInYears;
        } elseif ( $precision > TimeValue::PRECISION_SECOND ) {
            // Sub-second precisions become 0.1 seconds, 0.01 seconds, and so on.
            $precisionInSeconds = pow( 10, $precision - TimeValue::PRECISION_SECOND );
            $amount /= $precisionInSeconds;
        }

        $lang = $this->options->getOption( ValueFormatter::OPT_LANG );
        // TODO: Use NumberLocalizer
        $msg = wfMessage( $key, $amount )->inLanguage( $lang );
        return htmlspecialchars( $msg->text() );
    }

    /**
     * @param string $fieldName
     * @param string $valueHtml
     *
     * @return string HTML
     */
    private function getFieldHtml( $fieldName, $valueHtml ) {
        // Messages:
        // wikibase-timedetails-isotime
        // wikibase-timedetails-timezone
        // wikibase-timedetails-calendar
        // wikibase-timedetails-precision
        // wikibase-timedetails-before
        // wikibase-timedetails-after
        $key = 'wikibase-timedetails-' . strtolower( $fieldName );

        $html = Html::openElement( 'tr' );

        $html .= Html::element( 'th', [ 'class' => 'wb-time-' . $fieldName ],
            $this->msg( $key ) );
        $html .= Html::rawElement( 'td', [ 'class' => 'wb-time-' . $fieldName ],
            $valueHtml );

        $html .= Html::closeElement( 'tr' );

        return $html;
    }

    /**
     * @param string $key
     *
     * @return string
     */
    private function msg( $key ) {
        $lang = $this->options->getOption( ValueFormatter::OPT_LANG );
        $msg = wfMessage( $key )->inLanguage( $lang );
        return $msg->text();
    }

}