mediawiki-extensions-Echo/Hooks.php
Andrew Garrett 5c841cafe3 Add an "overlay" to personal links showing new notifications.
Change-Id: I1a350e5d051bd0e776e5043f0ba189a576ac7ee7
TODO: Add date/time stamp to notifications as shown in overlay
2012-06-01 21:02:30 +10:00

122 lines
3.4 KiB
PHP

<?php
class EchoHooks {
public static function getSchemaUpdates($updater) {
$dir = dirname(__FILE__);
$baseSQLFile = "$dir/echo.sql";
$updater->addExtensionTable( 'echo_subscription', $baseSQLFile );
$updater->addExtensionTable( 'echo_event', $baseSQLFile );
$updater->addExtensionTable( 'echo_notification', $baseSQLFile );
$updater->modifyField( 'echo_event', 'event_agent',
"$dir/db_patches/patch-event_agent-split.sql", true );
$updater->modifyField( 'echo_event', 'event_variant',
"$dir/db_patches/patch-event_variant_nullability.sql", true );
return true;
}
public static function getDefaultNotifiedUsers($event, &$users) {
switch( $event->getType() ) {
case 'edit-user-talk':
if ( !$event->getTitle() || !$event->getTitle()->getNamespace() == NS_USER_TALK ) {
break;
}
$username = $event->getTitle()->getText();
$user = User::newFromName( $username );
if ($user->getId()) {
$user = User::newFromName($username);
$users[$user->getId()] = $user;
}
break;
}
return true;
}
public static function getPreferences( $user, &$preferences ) {
$preferences['echo-notify-watchlist'] = array(
'type' => 'toggle',
'label-message' => 'echo-pref-notify-watchlist',
'section' => 'echo',
);
return true;
}
public static function onWatch( $user, $article ) {
if ( ! $user->getOption('echo-notify-watchlist') ) {
return true;
}
$subscription = new EchoSubscription( $user, 'edit', $article->getTitle() );
$subscription->enableNotification('notify');
$subscription->save();
return true;
}
public static function onUnwatch( $user, $article ) {
$subscription = new EchoSubscription( $user, 'edit', $article->getTitle() );
$subscription->disableNotification('notify');
$subscription->save();
return true;
}
public static function onArticleSaved( &$article, &$user, $text, $summary, $minoredit, $watchthis, $sectionanchor, &$flags, $revision, &$status ) {
if ( $revision ) {
$event = EchoEvent::create( array(
'type' => 'edit',
'title' => $article->getTitle(),
'extra' => array('revid' => $revision->getID()),
'agent' => $user,
) );
$possibleUser = $article->getTitle()->getText();
if (
$article->getTitle()->getNamespace() === NS_USER_TALK &&
User::newFromName($possibleUser)->getID()
) {
$event = EchoEvent::create( array(
'type' => 'edit-user-talk',
'title' => $article->getTitle(),
'extra' => array('revid' => $revision->getID()),
'agent' => $user,
) );
}
}
return true;
}
static function beforePageDisplay( $out, $skin ) {
global $wgUser;
if ( !$wgUser->isAnon() ) {
$out->addModules( array('ext.echo.overlay') );
}
return true;
}
static function onPersonalUrls( &$personal_urls, &$title ) {
global $wgUser, $wgLang, $wgOut;
if ( $wgUser->isAnon() ) {
return true;
}
$notificationCount = EchoNotificationController::getNotificationCount( $wgUser );
$msg = wfMessage( $notificationCount == 0 ? 'echo-link-none' : 'echo-link-new' );
$url = SpecialPage::getTitleFor( 'Notifications' )->getLocalURL();
$notificationsLink = array(
'href' => $url,
'text' => $msg->params($wgLang->formatNum( $notificationCount ) )->text(),
'active' => $notificationCount > 0,
);
$insertUrls = array( 'notifications' => $notificationsLink );
$personal_urls = wfArrayInsertAfter( $personal_urls, $insertUrls, 'watchlist' );
return true;
}
}