mediawiki-extensions-Echo/includes/DataOutputFormatter.php
Stephane Bisson f8a8d392d6 Expandable bundle
Support bundles being expandable
to show their sub-notifications.

Bug: T114356
Change-Id: I1507cae360f45cc87f2d60e966b4d047abfa202d
2016-06-28 15:37:54 -04:00

214 lines
6.8 KiB
PHP

<?php
/**
* Utility class that formats a notification in the format specified
*/
class EchoDataOutputFormatter {
/**
* @var array type => class
*/
protected static $formatters = array(
'flyout' => 'EchoFlyoutFormatter',
'model' => 'EchoModelFormatter',
'special' => 'SpecialNotificationsFormatter',
'html' => 'SpecialNotificationsFormatter',
);
/**
* Format a notification for a user in the format specified
*
* @param EchoNotification $notification
* @param string|bool $format output format, false to not format any notifications
* @param User $user the target user viewing the notification
* @param Language $lang Language to format the notification in
* @return array|bool false if it could not be formatted
*/
public static function formatOutput( EchoNotification $notification, $format = false, User $user, Language $lang ) {
$event = $notification->getEvent();
$timestamp = $notification->getTimestamp();
$utcTimestampUnix = wfTimestamp( TS_UNIX, $timestamp );
$utcTimestampMW = wfTimestamp( TS_MW, $timestamp );
$bundledIds = null;
$bundledNotifs = $notification->getBundledNotifications();
if ( $bundledNotifs ) {
$bundledEvents = array_map( function ( EchoNotification $notif ) {
return $notif->getEvent();
}, $bundledNotifs );
$event->setBundledEvents( $bundledEvents );
$bundledIds = array_map( function ( $event ) {
return (int)$event->getId();
}, $bundledEvents );
}
$timestampMw = self::getUserLocalTime( $user, $timestamp );
// Start creating date section header
$now = wfTimestamp();
$dateFormat = substr( $timestampMw, 0, 8 );
$timeDiff = $now - $utcTimestampUnix;
// Most notifications would be more than two days ago, check this
// first instead of checking 'today' then 'yesterday'
if ( $timeDiff > 172800 ) {
$date = self::getDateHeader( $user, $timestampMw );
// 'Today'
} elseif ( substr( self::getUserLocalTime( $user, $now ), 0, 8 ) === $dateFormat ) {
$date = wfMessage( 'echo-date-today' )->escaped();
// 'Yesterday'
} elseif ( substr( self::getUserLocalTime( $user, $now - 86400 ), 0, 8 ) === $dateFormat ) {
$date = wfMessage( 'echo-date-yesterday' )->escaped();
} else {
$date = self::getDateHeader( $user, $timestampMw );
}
// End creating date section header
$output = array(
'wiki' => wfWikiID(),
'id' => $event->getId(),
'type' => $event->getType(),
'category' => $event->getCategory(),
'timestamp' => array(
// UTC timestamp in UNIX format used for loading more notification
'utcunix' => $utcTimestampUnix,
'unix' => self::getUserLocalTime( $user, $timestamp, TS_UNIX ),
'utcmw' => $utcTimestampMW,
'mw' => $timestampMw,
'date' => $date
),
);
if ( $bundledIds ) {
$output['bundledIds'] = $bundledIds;
}
if ( $event->getVariant() ) {
$output['variant'] = $event->getVariant();
}
$title = $event->getTitle();
if ( $title ) {
$output['title'] = array(
'full' => $title->getPrefixedText(),
'namespace' => $title->getNSText(),
'namespace-key' => $title->getNamespace(),
'text' => $title->getText(),
);
}
$agent = $event->getAgent();
if ( $agent ) {
if ( $event->userCan( Revision::DELETED_USER, $user ) ) {
$output['agent'] = array(
'id' => $agent->getId(),
'name' => $agent->getName(),
);
} else {
$output['agent'] = array( 'userhidden' => '' );
}
}
if ( $event->getRevision() ) {
$output['revid'] = $event->getRevision()->getId();
}
if ( $notification->getReadTimestamp() ) {
$output['read'] = $notification->getReadTimestamp();
}
// This is only meant for unread notifications, if a notification has a target
// page, then it shouldn't be auto marked as read unless the user visits
// the target page or a user marks it as read manually ( coming soon )
$output['targetpages'] = array();
if ( $notification->getTargetPages() ) {
foreach ( $notification->getTargetPages() as $targetPage ) {
$output['targetpages'][] = $targetPage->getPageId();
}
}
if ( $format ) {
$formatted = self::formatNotification( $event, $user, $format, $lang );
if ( $formatted === false ) {
// Can't display it, so mark it as read
EchoDeferredMarkAsReadUpdate::add( $event, $user );
return false;
}
$output['*'] = $formatted;
if ( $notification->getBundledNotifications() && self::isBundleExpandable( $event->getType() ) ) {
$output['bundledNotifications'] = array_filter( array_map( function ( EchoNotification $notification ) use ( $format, $user, $lang ) {
// remove nested notifications to
// - ensure they are formatted as single notifications (not bundled)
// - prevent further re-entrance on the current notification
$notification->setBundledNotifications( array() );
$notification->getEvent()->setBundledEvents( array() );
return self::formatOutput( $notification, $format, $user, $lang );
}, array_merge( array( $notification ), $notification->getBundledNotifications() ) ) );
}
}
return $output;
}
/**
* @param EchoEvent $event
* @param User $user
* @param string $format
* @param Language $lang
* @return string|bool false if it could not be formatted
*/
protected static function formatNotification( EchoEvent $event, User $user, $format, $lang ) {
if ( isset( self::$formatters[$format] )
&& EchoEventPresentationModel::supportsPresentationModel( $event->getType() )
) {
/** @var EchoEventFormatter $formatter */
$formatter = new self::$formatters[$format]( $user, $lang );
return $formatter->format( $event );
} else {
// Legacy b/c
return EchoNotificationController::formatNotification( $event, $user, $format );
}
}
/**
* Get the date header in user's format, 'May 10' or '10 May', depending
* on user's date format preference
* @param User $user
* @param string $timestampMw
* @return string
*/
protected static function getDateHeader( User $user, $timestampMw ) {
$lang = RequestContext::getMain()->getLanguage();
$dateFormat = $lang->getDateFormatString( 'pretty', $user->getDatePreference() ?: 'default' );
return $lang->sprintfDate( $dateFormat, $timestampMw );
}
/**
* Helper function for converting UTC timezone to a user's timezone
*
* @param User
* @param string
* @param int $format output format
*
* @return string
*/
public static function getUserLocalTime( User $user, $ts, $format = TS_MW ) {
$timestamp = new MWTimestamp( $ts );
$timestamp->offsetForUser( $user );
return $timestamp->getTimestamp( $format );
}
/**
* @param string $type
* @return bool Whether a notification type can be an expandable bundle
*/
public static function isBundleExpandable( $type ) {
global $wgEchoNotifications;
return isset( $wgEchoNotifications[$type]['bundle']['expandable'] ) && $wgEchoNotifications[$type]['bundle']['expandable'];
}
}