Page MenuHomeWickedGov Phorge
Files F4112310

DiscussionToolsEventTrait.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

DiscussionToolsEventTrait.php
View Options

<?php
/**
* Common code for all Echo event presentation models for DiscussionTools events.
*
* @file
* @ingroup Extensions
* @license MIT
*/
namespace MediaWiki\Extension\DiscussionTools\Notifications;
use MediaWiki\Extension\Notifications\DiscussionParser;
use MediaWiki\Extension\Notifications\Formatters\EchoPresentationModelSection;
use MediaWiki\Extension\Notifications\Model\Event;
use MediaWiki\Language\Language;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\WikiMap\WikiMap;
/**
* This trait must be only used on EchoEventPresentationModel subclasses.
*
* @property Event $event
* @property Language $language
* @property EchoPresentationModelSection $section
*/
trait DiscussionToolsEventTrait {
/**
* @param int $type RevisionRecord::DELETED_* constant
* @return bool
*/
abstract protected function userCan( $type );
/**
* @return bool
*/
abstract protected function isBundled();
/**
* @return Event[]
*/
abstract protected function getBundledEvents();
/**
* @return int[]|false
*/
abstract protected function getBundledIds();
/**
* Get a link to the individual comment, if available.
*
* @return string|null Full URL linking to the comment, null if not available
*/
protected function getCommentLink(): ?string {
if ( !$this->userCan( RevisionRecord::DELETED_TEXT ) ) {
return null;
}
if ( !$this->isBundled() ) {
// For a single-comment notification, make a pretty(ish) direct link to the comment.
// The browser scrolls and we highlight it client-side.
$commentId = $this->event->getExtraParam( 'comment-id' );
if ( !$commentId ) {
return null;
}
$title = $this->event->getTitle();
return $title->createFragmentTarget( $commentId )->getFullURL();
} else {
// For a multi-comment notification, we can't make a direct link, because we don't know
// which comment appears first on the page; the best we can do is a link to the section.
// We handle both scrolling and highlighting client-side, using the ugly parameter
// listing all comments.
// Bundling works differently for different notification types:
// * Subscribed topic notifications are bundled per-section.
// * User talk page notifications are bundled per-page (so basically, always bundled).
// * Mention notifications are *never* bundled.
// Just pass the oldest comment in the bundle. The client has access to the comment
// tree and so can work out all the other comments since this one.
// This does not include the newest comment, $this->event, but we are looking
// for the oldest comment.
$bundledEvents = $this->getBundledEvents();
$oldestEvent = end( $bundledEvents );
$params = [ 'dtnewcommentssince' => $oldestEvent->getExtraParam( 'comment-id' ) ];
if ( $this->event->getType() === 'dt-added-topic' ) {
// New topics notifications: Tell client to only highlight topics **started** since this one
$params[ 'dtsincethread' ] = 1;
} elseif ( $this->event->getExtraParam( 'subscribed-comment-name' ) ) {
// Topic notifications: Tell client to restrict highlights to this thread
$params[ 'dtinthread' ] = 1;
}
// This may or may not have a fragment identifier, depending on whether it was recorded for
// the first one of the bundled events. It's usually not needed because we handle scrolling
// client-side, but we can keep it for no-JS users, and to reduce the jump when scrolling.
$titleWithOptionalSection = $this->section->getTitleWithSection();
return $titleWithOptionalSection->getFullURL( $params );
}
}
/**
* Get a snippet of the individual comment, if available.
*
* @return string The snippet, as plain text (may be empty)
*/
protected function getContentSnippet(): string {
if ( !$this->userCan( RevisionRecord::DELETED_TEXT ) ) {
return '';
}
// Note that we store plain text in the 'content' param.
// Echo also has a 'content' param (for mention notifications), but it contains wikitext.
$content = $this->event->getExtraParam( 'content' );
if ( !$content ) {
return '';
}
return $this->language->truncateForVisual( $content, DiscussionParser::DEFAULT_SNIPPET_LENGTH );
}
/**
* Add mark-as-read params to a link array
*
* Taken from EchoEventPresentationModel::getPrimaryLinkWithMarkAsRead
* TODO: Upstream to Echo?
*
* @param array $link Link
* @return array
*/
protected function addMarkAsRead( $link ) {
global $wgEchoCrossWikiNotifications;
if ( $link ) {
$eventIds = [ $this->event->getId() ];
if ( $this->getBundledIds() ) {
$eventIds = array_merge( $eventIds, $this->getBundledIds() );
}
$queryParams = [ 'markasread' => implode( '|', $eventIds ) ];
if ( $wgEchoCrossWikiNotifications ) {
$queryParams['markasreadwiki'] = WikiMap::getCurrentWikiId();
}
$link['url'] = wfAppendQuery( $link['url'], $queryParams );
}
return $link;
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 22:47 (18 h, 16 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a8/4c/bd6a9160d5c3859785a9ce718d3c
Default Alt Text
DiscussionToolsEventTrait.php (4 KB)

Event Timeline