mediawiki-extensions-Echo/includes/DbEmailBatch.php

<?php

/**
 * Handle user email batch ( daily/weekly ) for database storage
 */
class MWDbEchoEmailBatch extends MWEchoEmailBatch {

	/**
	 * Set the last event of this batch, this is a cutoff point for clearing
	 * processed/invalid events
	 *
	 * @return bool true if event exists false otherwise
	 */
	protected function setLastEvent() {
		$dbr = wfGetDB( DB_SLAVE );
		$res = $dbr->selectField(
			array( 'echo_email_batch' ),
			array( 'MAX( eeb_event_id )' ),
			array( 'eeb_user_id' => $this->mUser->getId() ),
			__METHOD__
		);

		if ( $res ) {
			$this->lastEvent = $res;
			return true;
		} else {
			return false;
		}
	}

	/**
	 * Get the events queued for the current user
	 * @return array
	 */
	protected function getEvents() {
		$events = array();

		$validEvents = EchoEvent::gatherValidEchoEvents();

		if ( $validEvents ) {
			$dbr = wfGetDB( DB_SLAVE );

			$conds = array(
				'eeb_user_id' => $this->mUser->getId(),
				'event_id = eeb_event_id',
				'event_type' => $validEvents
			);

			if ( $this->lastEvent ) {
				$conds[] = 'eeb_event_id <= ' . intval( $this->lastEvent );
			}

			$res = $dbr->select(
				array( 'echo_email_batch', 'echo_event' ),
				array( '*' ),
				$conds,
				__METHOD__,
				array( 'ORDER BY' => 'eeb_event_priority, eeb_event_id', 'LIMIT' => self::$displaySize + 1 )
			);

			foreach( $res as $row ) {
				$events[$row->eeb_id] = $row;
			}
		}

		return $events;
	}

	/**
	 * Clear "processed" events in the queue, processed could be: email sent, invalid, users do not want to receive emails
	 */
	public function clearProcessedEvent() {
		$conds = array( 'eeb_user_id' => $this->mUser->getId() );

		// there is a processed cutoff point
		if ( $this->lastEvent ) {
			$conds[] = 'eeb_event_id <= ' . intval( $this->lastEvent );
		}

		$dbw = wfGetDB( DB_MASTER );
		$dbw->delete(
			'echo_email_batch',
			$conds,
			__METHOD__,
			array()
		);
	}

	/**
	 * Send the batch email
	 */
	public function sendEmail() {
		global $wgPasswordSender, $wgPasswordSenderName, $wgEchoEmailFooterAddress;

		// global email footer
		$footer = wfMessage( 'echo-email-footer-default' )
				->inLanguage( $this->mUser->getOption( 'language' ) )
				->params( $wgEchoEmailFooterAddress, '' )
				->text();

		// @Todo - replace them with the CONSTANT in 33810 once it is merged
		if ( $this->mUser->getOption( 'echo-email-frequency' ) == 7 ) {
			$frequency = 'weekly';
		} else {
			$frequency = 'daily';
		}

		// email subject
		if ( $this->count > self::$displaySize ) {
			$count = wfMessage( 'echo-notification-count' )->params( self::$displaySize )->text();
		} else {
			$count = $this->count;
		}
		$subject = wfMessage( 'echo-email-batch-subject-' . $frequency )->params( $count, $this->count )->text();
		$body = wfMessage( 'echo-email-batch-body-' . $frequency )->params(
				$this->mUser->getName(),
				$count,
				$this->count,
				$this->listToText(),
				$footer
			)->text();

		$adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
		$address = new MailAddress( $this->mUser );

		$params = array(
			'to' => $address,
			'from' => $adminAddress,
			'subj' => $subject,
			'body' => $body,
			// no replyto
			'replyto' => ''
		);
		$job = new EmaillingJob( null, $params );
		JobQueueGroup::singleton()->push( $job );
	}

	/**
	 * Insert notification event into email queue
	 * @param $userId int
	 * @param $eventId int
	 * @param $priority int
	 */
	public static function actuallyAddToQueue( $userId, $eventId, $priority ) {
		if ( !$userId || !$eventId ) {
			return;
		}

		$dbw = wfGetDB( DB_MASTER );
		$dbw->insert(
			'echo_email_batch',
			array(
				'eeb_user_id' => $userId,
				'eeb_event_id' => $eventId,
				'eeb_event_priority' => $priority
			),
			__METHOD__,
			array( 'IGNORE' )
		);
	}

	/**
	 * Get a list of users to be notified for the batch
	 * @param $startUserId int
	 * @param $batchSize int
	 */
	public static function actuallyGetUsersToNotify( $startUserId, $batchSize ) {
		$dbr = wfGetDB( DB_SLAVE );
		$res = $dbr->select(
			array( 'echo_email_batch' ),
			array( 'eeb_user_id' ),
			array( 'eeb_user_id > ' . $startUserId  ),
			__METHOD__,
			array( 'ORDER BY' => 'eeb_user_id', 'LIMIT' => $batchSize )
		);

		return $res;
	}

}