SemanticMediaWiki / SemanticWatchlist

specials/SpecialSemanticWatchlist.php

<?php

/**
 * Semantic watchlist page listing changes to watched properties.
 *
 * @since 0.1
 *
 * @file SemanticWatchlist.php
 * @ingroup SemanticWatchlist
 *
 * @licence GNU GPL v3 or later
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class SpecialSemanticWatchlist extends SpecialPage {

	/**
	 * MediaWiki timestamp of when the watchlist was last viewed by the current user.
	 *
	 * @since 0.1
	 *
	 * @var integer
	 */
	protected $lastViewed;

	/**
	 * Constructor.
	 *
	 * @since 0.1
	 */
	public function __construct() {
		parent::__construct( 'SemanticWatchlist', 'semanticwatch' );
	}

	/**
	 * @see SpecialPage::getDescription
	 *
	 * @since 0.1
	 */
	public function getDescription() {
		return $this->msg( 'special-' . strtolower( $this->getName() ) )->text();

Consider using $this->name. There is an issue with getName() and APC-enabled PHP versions.

	}

	/**
	 * Sets headers - this should be called from the execute() method of all derived classes!
	 *
	 * @since 0.1
	 */
	public function setHeaders() {
		global $wgOut;
		$wgOut->setArticleRelated( false );
		$wgOut->setRobotPolicy( 'noindex,nofollow' );
		$wgOut->setPageTitle( $this->getDescription() );
	}

	/**
	 * Main method.
	 *
	 * @since 0.1
	 *
	 * @param string $subPage
	 */
	public function execute( $subPage ) {
		global $wgOut;

		$this->setHeaders();
		$this->outputHeader();

		$user = $this->getUser();
		// If the user is authorized, display the page, if not, show an error.
		if ( !$this->userCanExecute( $user ) ) {
			$this->displayRestrictionError();
			return;
		}

		$this->registerUserView( $user );

		$wgOut->addHTML( '<p>' );

		if ( $user->isAllowed( 'semanticwatchgroups' ) ) {
			$wgOut->addWikiMsg( 'swl-watchlist-can-mod-groups', 'Special:WatchlistConditions' );
			$wgOut->addHTML( '&#160' );
		}

		if ( $this->userHasWatchlistGroups( $user ) ) {
			$wgOut->addWikiMsg( 'swl-watchlist-can-mod-prefs', 'Special:Preferences#mw-prefsection-swl' );
			$wgOut->addHTML( '</p>' );

			$this->getAndDisplaySets( $subPage );
		}
		else {
			$wgOut->addWikiMsg( 'swl-watchlist-no-groups', 'Special:Preferences#mw-prefsection-swl' );
			$wgOut->addHTML( '</p>' );
		}
	}

	/**
	 * Obtains the change sets and displays them by calling displayWatchlist.
	 * Also takes care of pagination and displaying appropriate message when there are no results.
	 *
	 * @since 0.1
	 *
	 * @param string $subPage
	 */
	protected function getAndDisplaySets( $subPage ) {
		global $wgRequest, $wgOut, $wgLang;

		$limit = $wgRequest->getInt( 'limit', 20 );
		$offset = $wgRequest->getInt( 'offset', 0 );
		$continue = $wgRequest->getVal( 'continue' );

		$changeSetData = $this->getChangeSetsData( $limit, $continue );

		$sets = array();

		foreach ( $changeSetData['sets'] as $set ) {
			$sets[] = SWLChangeSet::newFromArray( $set );
		}

		$newContinue = false;

		if ( array_key_exists( 'query-continue', $changeSetData ) ) {
			$newContinue = $changeSetData['query-continue']['semanticwatchlist']['swcontinue'];
		}

		if ( $offset != 0 || count( $sets ) > 0 ) {
			$wgOut->wrapWikiMsg( '<p>$1</p>', array( 'swl-watchlist-position',
				$wgLang->formatNum( count( $sets ) ),
				$wgLang->formatNum( $offset + 1 )
			) );

			$wgOut->addHTML( $this->getPagingControlHTML( $limit, $continue, $subPage, $newContinue, $offset ) );
		}

		if ( count( $sets ) > 0 ) {
			$this->displayWatchlist( $sets );
		}
		else {
			$wgOut->addWikiMsg( 'swl-watchlist-no-items' );
		}
	}

	/**
	 * Register the user viewed the watchlist,
	 * so we know that following chnages should
	 * result into notification emails is desired.
	 *
	 * @since 0.1
	 *
	 * @param User $user
	 */
	protected function registerUserView( User $user ) {
		$this->lastViewed = $user->getOption( 'swl_last_view' );

		if ( is_null( $this->lastViewed ) ) {
			$this->lastViewed = wfTimestampNow();
		}

		$user->setOption( 'swl_last_view', wfTimestampNow() );
		$user->setOption( 'swl_mail_count',0 );
		$user->saveSettings();
	}

	/**
	 * @since 0.1
	 *
	 * @return string
	 */
	protected function getPagingControlHTML( $limit, $currentContinue, $subPage, $newContinue, $offset ) {
		global $wgLang;

		$nextMsg = $this->msg( 'nextn', $limit )->escaped();
		$firstMsg = $this->msg( 'swl-watchlist-firstn', $limit )->escaped();

		if ( $newContinue === false ) {
			$nextLink = $nextMsg;
		}
		else {
			$nextLink = Html::element(
				'a',
				array(
					'href' => $this->getTitle( $subPage )->getLocalURL( wfArrayToCGI( array(
						'limit' => $limit,
						'continue' => $newContinue,
						'offset' => $offset + $limit
					) ) ),
					'title' => $this->msg( 'nextn-title', $limit )->escaped(),
					'class' => 'mw-nextlink'
				),
				$nextMsg
			);
		}

		$limitLinks = array();
		$limitLinkArgs = array();

		if ( $currentContinue == '' ) {
			$firstLink = $firstMsg;
		}
		else {
			$limitLinkArgs['continue'] = $currentContinue;

			$firstLink = Html::element(
				'a',
				array(
					'href' => $this->getTitle( $subPage )->getLocalURL( wfArrayToCGI( array( 'limit' => $limit ) ) ),
					'title' => $this->msg( 'swl-watchlist-firstn-title', $limit )->escaped()
				),
				$firstMsg
			);
		}

		foreach ( array( 20, 50, 100, 250, 500 ) as $limitValue ) {
			$limitLinkArgs['limit'] = $limitValue;
			if ( $offset != 0 ) {
				$limitLinkArgs['offset'] = $offset;
			}

			$limitLinks[] = Html::element(
				'a',
				array(
					'href' => $this->getTitle( $subPage )->getLocalURL( wfArrayToCGI( $limitLinkArgs ) ),
					'title' => $this->msg( 'shown-title', $limitValue )->escaped()
				),
				$wgLang->formatNum( $limitValue )
			);
		}

		return Html::rawElement(
			'p',
			array(),
			$this->msg( 'swl-watchlist-pagincontrol' )->rawParams( $wgLang->pipeList( array( $firstLink, $nextLink ) ), $wgLang->pipeList( $limitLinks ) )->escaped()
		);
	}

	/**
	 * Displays the watchlist.
	 *
	 * @since 0.1
	 *
	 * @param array $sets Array of SWLChangeSet
	 */
	protected function displayWatchlist( array $sets ) {
		global $wgOut, $wgLang;

		$changeSetsHTML = array();

		foreach ( $sets as /* SWLChangeSet */ $set ) {
			$dayKey = substr( $set->getEdit()->getTime(), 0, 8 ); // Get the YYYYMMDD part.

			if ( !array_key_exists( $dayKey, $changeSetsHTML ) ) {
				$changeSetsHTML[$dayKey] = array();
			}

			$changeSetsHTML[$dayKey][] = $this->getChangeSetHTML( $set );
		}

		krsort( $changeSetsHTML );

		foreach ( $changeSetsHTML as $dayKey => $daySets ) {
			$wgOut->addHTML( Html::element(
				'h4',
				array(),
				$wgLang->date( str_pad( $dayKey, 14, '0' ) )
			) );

			$wgOut->addHTML( '<ul>' );

			foreach ( $daySets as $setHTML ) {
				$wgOut->addHTML( $setHTML );
			}

			$wgOut->addHTML( '</ul>' );
		}

		SMWOutputs::commitToOutputPage( $wgOut );

		$wgOut->addModules( 'ext.swl.watchlist' );
	}

	/**
	 * Returns the response of an internal request to the API semanticwatchlist query module.
	 *
	 * @since 0.1
	 *
	 * @param integer $limit
	 * @param string $continue
	 *
	 * @return array
	 */
	protected function getChangeSetsData( $limit, $continue ) {
		$requestData = array(
			'action' => 'query',
			'list' => 'semanticwatchlist',
			'format' => 'json',
			'swuserid' => $GLOBALS['wgUser']->getId(),
			'swlimit' => $limit,
			'swcontinue' => $continue,
			'swmerge' => '1'
		);

		$api = new ApiMain( new FauxRequest( $requestData, true ), true );
		$api->execute();
		return $api->getResult()->getResultData( null, [
												 'BC' => [],
												 'Types' => [],
												 'Strip' => 'all',
		] );
	}

	/**
	 * Gets the HTML for a single change set (edit).
	 *
	 * @since 0.1
	 *
	 * @param SWLChangeSet $changeSet
	 *
	 * @return string
	 */
	protected function getChangeSetHTML( SWLChangeSet $changeSet ) {
		global $wgLang;

		$edit = $changeSet->getEdit();

		$html = '';

		$html .= '<li>';

		$html .=
			'<p>' .
				$wgLang->time( $edit->getTime(), true ) . ' ' .
				Html::element(
					'a',
					array( 'href' => $edit->getTitle()->getLocalURL() ),
					$edit->getTitle()->getText()
				) . ' (' .
				Html::element(
					'a',
					array( 'href' => $edit->getTitle()->getLocalURL( 'action=history' ) ),
					$this->msg( 'hist' )->text()
				) . ') . . ' .
				Html::element(
					'a',
					array( 'href' => $edit->getUser()->getUserPage()->getLocalURL() ),
					$edit->getUser()->getName()
				) . ' (' .
				Html::element(
					'a',
					array( 'href' => $edit->getUser()->getTalkPage()->getLocalURL() ),
					$this->msg( 'talkpagelinktext' )->text()
				) . ' | ' .
				( $edit->getUser()->isAnon() ? '' :
					Html::element(
						'a',
						array( 'href' => SpecialPage::getTitleFor( 'Contributions', $edit->getUser()->getName() )->getLocalURL() ),
						$this->msg( 'contribslink' )->text()
					) . ' | '
				) .
				Html::element(
					'a',
					array( 'href' => SpecialPage::getTitleFor( 'Block', $edit->getUser()->getName() )->getLocalURL() ),
					$this->msg( 'blocklink' )->text()
				) . ')' .
				( $edit->getTime() > $this->lastViewed ? ' <b>' . $this->msg( 'swl-new-item' )->text() . '</b>' : '' )	.
			'</p>'
		;

		$propertyHTML= array();

		foreach ( $changeSet->getAllProperties() as /* SMWDIProperty */ $property ) {
			$propertyHTML[] = $this->getPropertyHTML( $property, $changeSet->getAllPropertyChanges( $property ) );
		}

		$html .= implode( '', $propertyHTML );

		$html .=  '</li>';

		return $html;
	}

	/**
	 * Returns the HTML for the changes to a single propety.
	 *
	 * @param SMWDIProperty $property
	 * @param array $changes Array of SWLPropertyChange
	 *
	 * @return string
	 */
	protected function getPropertyHTML( SMWDIProperty $property, array $changes ) {
		$insertions = array();
		$deletions = array();

		// Convert the changes into a list of insertions and a list of deletions.
		foreach ( $changes as /* SWLPropertyChange */ $change ) {
			if ( !is_null( $change->getOldValue() ) ) {
				$deletions[] = SMWDataValueFactory::newDataItemValue( $change->getOldValue(), $property )->getLongHTMLText();
			}
			if ( !is_null( $change->getNewValue() ) ) {
				$insertions[] = SMWDataValueFactory::newDataItemValue( $change->getNewValue(), $property )->getLongHTMLText();
			}
		}

		$lines = array();

		if ( count( $deletions ) > 0 ) {
			$lines[] = Html::element( 'div', array( 'class' => 'swl-watchlist-deletions' ), $this->msg( 'swl-watchlist-deletions' )->text() ) . ' ' . implode( ', ', $deletions );
		}

		if ( count( $insertions ) > 0 ) {
			$lines[] = Html::element( 'div', array( 'class' => 'swl-watchlist-insertions' ), $this->msg( 'swl-watchlist-insertions' )->text() ) . ' ' . implode( ', ', $insertions );
		}

		$html = Html::element( 'span', array( 'class' => 'swl-watchlist-prop' ), $property->getLabel() );

		$html .= Html::rawElement(
			'div',
			array( 'class' => 'swl-prop-div' ),
			implode( '<br />', $lines )
		);

		return $html;
	}

	/**
	 * Rteurns if the specified user has any watchlist groups in his notification list.
	 *
	 * @since 0.1
	 *
	 * @param User $user
	 *
	 * @return boolean
	 */
	protected function userHasWatchlistGroups( User $user ) {
		if ( !$user->isLoggedIn() ) {
			return false;
		}

		$dbr = wfGetDB( DB_REPLICA );

		$group = $dbr->selectRow(
			'swl_users_per_group',
			array( 'upg_group_id' ),
			array( 'upg_user_id' => $user->getId() )
		);

		return $group !== false;
	}

}