2015-08-19 20:22:45 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class that returns structured data based
|
|
|
|
* on the provided event.
|
|
|
|
*/
|
|
|
|
abstract class EchoEventPresentationModel {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var EchoEvent
|
|
|
|
*/
|
|
|
|
protected $event;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var Language
|
|
|
|
*/
|
|
|
|
protected $language;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
protected $type;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var User for permissions checking
|
|
|
|
*/
|
|
|
|
private $user;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param EchoEvent $event
|
|
|
|
* @param Language|string $language
|
|
|
|
* @param User $user Only used for permissions checking
|
|
|
|
*/
|
|
|
|
protected function __construct( EchoEvent $event, $language, User $user ) {
|
|
|
|
$this->event = $event;
|
|
|
|
$this->type = $event->getType();
|
|
|
|
$this->language = wfGetLangObj( $language );
|
|
|
|
$this->user = $user;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Convenience function to detect whether the event type
|
|
|
|
* has been updated to use the presentation model system
|
|
|
|
*
|
|
|
|
* @param string $type event type
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public static function supportsPresentationModel( $type ) {
|
|
|
|
global $wgEchoNotifications;
|
|
|
|
return isset( $wgEchoNotifications[$type]['presentation-model'] );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param EchoEvent $event
|
|
|
|
* @param Language|string $language
|
|
|
|
* @param User $user
|
|
|
|
* @return EchoEventPresentationModel
|
|
|
|
*/
|
|
|
|
public static function factory( EchoEvent $event, $language, User $user ) {
|
|
|
|
global $wgEchoNotifications;
|
|
|
|
// @todo don't depend upon globals
|
|
|
|
|
|
|
|
$class = $wgEchoNotifications[$event->getType()]['presentation-model'];
|
|
|
|
return new $class( $event, $language, $user );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Equivalent to IContextSource::msg for the current
|
|
|
|
* language
|
|
|
|
*
|
|
|
|
* @return Message
|
|
|
|
*/
|
|
|
|
protected function msg( /* ,,, */ ) {
|
|
|
|
/**
|
|
|
|
* @var Message $msg
|
|
|
|
*/
|
|
|
|
$msg = call_user_func_array( 'wfMessage', func_get_args() );
|
|
|
|
$msg->inLanguage( $this->language );
|
|
|
|
|
|
|
|
return $msg;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string The symbolic icon name as defined in $wgEchoNotificationIcons
|
|
|
|
*/
|
|
|
|
abstract public function getIconType();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Helper for EchoEvent::userCan
|
|
|
|
*
|
|
|
|
* @param int $type Revision::DELETED_* constant
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
final protected function userCan( $type ) {
|
|
|
|
return $this->event->userCan( $type, $this->user );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return array|bool ['wikitext to display', 'username for GENDER'], false if no agent
|
|
|
|
*
|
|
|
|
* We have to display wikitext so we can add CSS classes for revision deleted user.
|
|
|
|
* The goal of this function is for callers not to worry about whether
|
|
|
|
* the user is visible or not.
|
|
|
|
* @par Example:
|
|
|
|
* @code
|
|
|
|
* list( $formattedName, $genderName ) = $this->getAgentForOutput();
|
|
|
|
* $msg->params( $formattedName, $genderName );
|
|
|
|
* @endcode
|
|
|
|
*/
|
|
|
|
final protected function getAgentForOutput() {
|
|
|
|
$agent = $this->event->getAgent();
|
|
|
|
if ( !$agent ) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $this->userCan( Revision::DELETED_USER ) ) {
|
|
|
|
// Not deleted
|
|
|
|
return array( $agent->getName(), $agent->getName() );
|
|
|
|
} else {
|
|
|
|
// Deleted/hidden
|
|
|
|
$msg = $this->msg( 'rev-deleted-user' )->plain();
|
|
|
|
// HACK: Pass an invalid username to GENDER to force the default
|
|
|
|
return array( '<span class="history-deleted">' . $msg . '</span>', '[]' );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-10-28 17:15:25 +00:00
|
|
|
/**
|
|
|
|
* To be overridden by subclasses if they are unable to render the
|
|
|
|
* notification, for example when a page is deleted.
|
|
|
|
* If this function returns false, no other methods will be called
|
|
|
|
* on the object.
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function canRender() {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2015-08-19 20:22:45 +00:00
|
|
|
/**
|
|
|
|
* @return string Message key that will be used in getHeaderMessage
|
|
|
|
*/
|
|
|
|
protected function getHeaderMessageKey() {
|
|
|
|
return "notification-header-{$this->type}";
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a message object and add the performer's name as
|
|
|
|
* a parameter. It is expected that subclasses will override
|
|
|
|
* this.
|
|
|
|
*
|
|
|
|
* @return Message
|
|
|
|
*/
|
|
|
|
public function getHeaderMessage() {
|
|
|
|
$msg = $this->msg( $this->getHeaderMessageKey() );
|
|
|
|
list( $formattedName, $genderName ) = $this->getAgentForOutput();
|
|
|
|
$msg->params( $formattedName, $genderName );
|
|
|
|
|
|
|
|
return $msg;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the body text, false if notification has no body
|
|
|
|
*
|
|
|
|
* @return bool|Message
|
|
|
|
*/
|
|
|
|
public function getBodyText() {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Possibly-relative URL to the primary link for this
|
|
|
|
*
|
|
|
|
* @return [array URL, link text (non-escaped)]
|
|
|
|
*/
|
|
|
|
abstract public function getPrimaryLink();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Possibly-relative URLs to the secondary links
|
|
|
|
*
|
|
|
|
* @return array URL => link text
|
|
|
|
*/
|
|
|
|
public function getSecondaryLinks() {
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
}
|