ReviewHandler.php

<?php

class ReviewHandler {

	// used to track change of state through page load.
	public static $pageLoadHandler = null;
	public static $isReviewable = true;

	/**
	 * @var User $user: reference to the current user
	 */
	public $user;

	/**
	 * @var Title $title: reference to current title
	 */
	public $title;

	/**
	 * @var int $initial: state of the user watching the page initially (at the
	 * beginning of the page load). Possible values: -1 for not watching the
	 * page, 0 for watching and has seen the latest version, and a large int
	 * like 20150102030405 (timestamp) for the user not having seen the latest.
	 */
	public $initial = null;

	/**
	 * @var int $final: same purpose as $initial, but determined late in the
	 * page load to see if the watch/review-state has changed.
	 */
	public $final = null;

	public function __construct( User $user, Title $title, $isDiff ) {
		$this->user = $user;
		$this->title = $title;
		$this->isDiff = $isDiff;
	}

	public static function setup( User $user, Title $title, $isDiff ) {
		if ( ! $title->isWatchable() ) {
			self::$isReviewable = false;
			return false;
		}
		self::$pageLoadHandler = new self ( $user, $title, $isDiff );
		self::$pageLoadHandler->initial = self::$pageLoadHandler->getReviewStatus();
		return self::$pageLoadHandler;
	}

	/**
	 * Get the "watch status" of a user for a page, e.g. whether they're watching
	 * and, if they're watching, whether they have reviewed the latest revision.
	 *
	 * @return int
	 */
	public function getReviewStatus() {
		$dbr = wfGetDB( DB_REPLICA );

		// FIXME: probably should use User->getNotificationTimestmap() or something
		// but I'm on a plane and I don't know what is available to me without docs
		$row = $dbr->selectRow(
			'watchlist',
			[ 'wl_notificationtimestamp' ],
			[
				'wl_user' => $this->user->getId(),
				'wl_namespace' => $this->title->getNamespace(),
				'wl_title' => $this->title->getDBkey(),
			],
			__METHOD__,
			[]
		);

		// user is not watching the page
		if ( $row === false ) {
			return -1;
		} elseif ( $row->wl_notificationtimestamp === null ) {
			return 0;
		} else {
			return $row->wl_notificationtimestamp;
		}
	}

	public static function pageIsBeingReviewed() {
		// never setup
		if ( ! self::$isReviewable || self::$pageLoadHandler === null ) {
			return false;
		}

		// no initial notification timestamp ($initial = 0) or not watching ($initial = -1)
		if ( self::$pageLoadHandler->initial < 1 ) {
			return false;
		}

		// After MW 1.25 (either 1.26 or 1.27), clearing wl_notificationtimestamp
		// was done via the job queue. This broke the ability to do a second
		// check of the review status and then compare the two statuses.
		// Instead just assume if the page is being viewed and it has a
		// positive wl_notificationtimestamp, then it is being reviewed.
		// $newStatus = self::$pageLoadHandler->getReviewStatus();

		// OLD VERSIONS OF WatchAnalytics DID THIS, BUT THE JOB QUEUE CHANGE
		// MADE THIS DIFFICULT. THIS MAY BE ADDED BACK LATER, BUT TO GET THE
		// EXTENSION WORKING AGAIN, INSTEAD WE'LL BE LESS EXACT FOR NOW.
		// either $newStatus is 0 or -1 meaning they don't have a pending review
		// or $newStatus is a timestamp greater than the original timestamp, meaning
		// they have reviewed a more recent version of the page than they had originally
		// if ( $newStatus < 1 || $newStatus > self::$pageLoadHandler->initial ) {
		// self::$pageLoadHandler->final = $newStatus;
		// return self::$pageLoadHandler;
		// }
		// else {
		// return false;
		// }

		return true;
	}

	public function getTemplate() {
		$reviewLink = Xml::element(
			'a',
			[
				'href' => null,
				'id' => 'watch-analytics-unreview',
				'class' => 'pendingreviews-green-button pendingreviews-accept-change',
			],
			wfMessage( 'watchanalytics-accept-change-close-banner' )->text()
		);

		// used if user right-clicks link and opens in new tab
		$unReviewURL = SpecialPage::getTitleFor( 'PageStatistics' )->getInternalURL( [
			'page' => $this->title->getPrefixedText(),
			'unreview' => $this->initial
		] );

		$unReviewLink = Xml::element(
			'a',
			[
				'href' => $unReviewURL,
				'id' => 'watch-analytics-unreview',
				'class' => 'watch-analytics-unreview',
				'timestamp' => $this->initial,
				'pending-title' => $this->title->getPrefixedText(),
				'title' => wfMessage( 'watchanalytics-unreview-button' )->text(),
			],
			wfMessage( 'watchanalytics-unreview-button' )->text()
		);

		$bannerText = wfMessage( 'watchanalytics-unreview-banner-text' )->parse();

		$this->pendingReview = PendingReview::getPendingReview( $this->user, $this->title );

		foreach ( $this->pendingReview as $item ) {
			if ( count( $item->newRevisions ) > 0 ) {

				// returns essentially the negative-oneth revision...the one before
				// the wl_notificationtimestamp revision...or null/false if none exists?
				$mostRecentReviewed = Revision::newFromRow( $item->newRevisions[0] )->getPrevious();
			} else {
				$mostRecentReviewed = false; // no previous revision, the user has not reviewed the first!
			}

			if ( $mostRecentReviewed ) {

				$lastSeenId = $mostRecentReviewed->getId();

			} else {

				$latest = Revision::newFromTitle( $item->title );
				$lastSeenId = $latest->getId();

			}

		}

		$diff = new DifferenceEngine( null, $lastSeenId, 0 );

		$template = "<div id='watch-analytics-review-handler' style='display:none'> $unReviewLink";

		// Don't show "close banner" button when viewing full diff page
		if ( !( $this->isDiff ) ) {
			$template .= $reviewLink;
		}

		$template .= "<p>$bannerText</p>";

		global $egWatchAnalyticsShowUnreviewDiff;
		if ( $egWatchAnalyticsShowUnreviewDiff ) {
			// Don't show diff on in header while viewing diff page
			if ( !( $this->isDiff ) ) {
				$template .= "<div id='diff-box'>";
				$template .= $diff->showDiffStyle();
				$template .= $diff->getDiff( '<b>Last seen</b>', '<b>Current</b>' );
				$template .= "</div>";
			}
		}

		$template .= "</div>";

		// Add button to navigate to top of page when user passes review banner.
		if ( !( $this->isDiff ) ) {
			$template .= "<button id='watch-analytics-go-to-top-button' title='See changes'>";
			$template .= "<b>Reviewing page!</b> Click here to see changes.";
			$template .= "</button>";
		}

		return "<script type='text/template' id='ext-watchanalytics-review-handler-template'>$template</script>";
	}

	public function resetNotificationTimestamp( $ts ) {
		$dbw = wfGetDB( DB_MASTER );

		return $dbw->update(
			'watchlist',
			[
				'wl_notificationtimestamp' => $ts,
			],
			[
				'wl_user' => $this->user->getId(),
				'wl_namespace' => $this->title->getNamespace(),
				'wl_title' => $this->title->getDBkey(),
			],
			__METHOD__,
			null
		);
	}

}