SemanticMediaWiki / SemanticTasks

src/SemanticTasksMailer.php

<?php

namespace ST;

use Content;
use ContentHandler;
use Exception;
use IContextSource;
use Language;
use MediaWiki\Diff\ComplexityException;
use MWException;
use ParserOutput;
use SMW\ApplicationFactory;
use SMW\DIWikiPage;
use SMWDataItem;
use SMWPrintRequest;
use Title;
use User;
use WikiPage;

if ( !defined( 'MEDIAWIKI' ) ) {
	echo 'Not a valid entry point';
	exit( 1 );
}

if ( !defined( 'SMW_VERSION' ) ) {
	echo 'This extension requires Semantic MediaWiki to be installed.';
	exit( 1 );
}

// constants for message type
if ( !defined( 'ST_NEWTASK' ) ) {
	define( 'ST_NEWTASK', 0 );
	define( 'ST_UPDATE', 1 );
	define( 'ST_ASSIGNED', 2 );
	define( 'ST_CLOSED', 3 );
	define( 'ST_UNASSIGNED', 4 );
}

/**
 * This class handles the creation and sending of notification emails.
 */
class SemanticTasksMailer {

	private static $user_mailer;

	/**
	 * Mails the assignees when the task is modified
	 *
	 * @param Assignees $assignees
	 * @param WikiPage $article
	 * @param User $current_user
	 * @param Content $text
	 * @param string $summary Unused
	 * @param bool $minoredit
	 * @param null $watchthis Unused
	 * @param null $sectionanchor Unused
	 * @param $flags
	 * @return boolean
	 * @throws ComplexityException
	 * @throws MWException
	 */
	public static function mailAssigneesUpdatedTask( Assignees $assignees, WikiPage $article, User $current_user, $text,
			$summary, $minoredit, $watchthis, $sectionanchor, $flags, $revision ) {

The parameter $summary is not used and could be removed.

The parameter $watchthis is not used and could be removed.

The parameter $sectionanchor is not used and could be removed.

		if ( $minoredit ) {
			return true;
		}
		$status = ST_UPDATE;
		if ( ( $flags & EDIT_NEW ) && !$article->getTitle()->isTalkPage() ) {
			$status = ST_NEWTASK;
		}
		$assignedToParserOutput = self::getAssignedUserFromParserOutput($article, $revision, $current_user);

		return self::mailAssignees( $article, $text, $current_user, $status, $assignees, $assignedToParserOutput );
	}

	// todo: this could replace Assignees->getAssignees(...).
	private static function getAssignedUserFromParserOutput(WikiPage $article, $revision, User $current_user) {
		$smwFactory = ApplicationFactory::getInstance();
		$mwCollaboratorFactory = $smwFactory->newMwCollaboratorFactory();
		$editInfo = $mwCollaboratorFactory->newEditInfo(
			$article,
			$revision,
			$current_user
		);
		$editInfo->fetchEditInfo();
		$parserOutput = $editInfo->getOutput();

		if ( !$parserOutput instanceof ParserOutput ) {

The class ParserOutput does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

			return [];
		}

		global $stgPropertyAssignedTo;
		$stgPropertyAssignedToString = str_replace(' ', '_', $stgPropertyAssignedTo);
		$property = new \SMW\DIProperty($stgPropertyAssignedToString, false);

		/** @var $semanticData \SMW\SemanticData */
		$semanticData = $parserOutput->getExtensionData('smwdata');
		$assigneesPropValues = $semanticData->getPropertyValues($property);
		// todo: maybe there should be a check if these pages are userpages.
		$assigneeList = array_map(function(DIWikiPage $assignePropVal) {
			return $assignePropVal->getTitle()->getText();
		}, $assigneesPropValues);


		return $assigneeList;
	}

	/**
	 *
	 * @param WikiPage $article
	 * @param Content $content
	 * @param User $user
	 * @param integer $status
	 * @param Assignees $assignees
	 * @return boolean
	 * @throws ComplexityException
	 * @throws MWException
	 * @global boolean $wgSemanticTasksNotifyIfUnassigned
	 */
	static function mailAssignees( WikiPage $article, Content $content, User $user, $status, Assignees $assignees,
								   $assignedToParserOutput ) {
		$text = ContentHandler::getContentText( $content );
		$title = $article->getTitle();

		// Notify those unassigned from this task
		global $wgSemanticTasksNotifyIfUnassigned;
		if ( $wgSemanticTasksNotifyIfUnassigned ) {
			$removedAssignees = $assignees->getRemovedAssignees( $article );
			$removedAssignees = Assignees::getAssigneeAddresses( $removedAssignees );
			self::mailNotification( $removedAssignees, $text, $title, $user, ST_UNASSIGNED );
		}

		// Send notification of an assigned task to assignees
		// Treat task as new
		$newAssignees = $assignees->getNewAssignees( $article );
		$newAssignees = Assignees::getAssigneeAddresses( $newAssignees );
		self::mailNotification( $newAssignees, $text, $title, $user, ST_ASSIGNED );

		$copies = $assignees->getCurrentCarbonCopy( $article );
		$currentStatus = $assignees->getCurrentStatus( $article );
		$oldStatus = $assignees->getSavedStatus();
		if ( $currentStatus === "Closed" && $oldStatus !== "Closed" ) {
			$close_mailto = Assignees::getAssigneeAddresses( $copies );
			self::mailNotification( $close_mailto, $text, $title, $user, ST_CLOSED );
		}

		$currentAssignees = $assignees->getCurrentAssignees( $article );

		// Only send group notifications on new tasks
		$groups = array();
		if ( $status === ST_NEWTASK ) {
			$groups = $assignees->getGroupAssignees( $article );

			// if this is a new task and there are no $currentAssignees but there are $assignedToParserOutput
			// then this is probably a new page and sending ST_ASSIGNED notifications didn't work and needs to be retried.
			if ( empty( $currentAssignees ) ) {
				$mails = Assignees::getAssigneeAddresses( $assignedToParserOutput );
				self::mailNotification( $mails, $text, $title, $user, ST_ASSIGNED );
			}
		}

		$mailto = array_merge( $currentAssignees, $copies, $groups );
		$mailto = array_unique( $mailto );
		$mailto = Assignees::getAssigneeAddresses( $mailto );

		// Send notifications to assignees, ccs, and groups
		self::mailNotification( $mailto, $text, $title, $user, $status );

		return true;
	}

	/**
	 * Sends mail notifications
	 *
	 * @param array $assignees
	 * @param string $text
	 * @param Title $title
	 * @param User $user
	 * @param integer $status
	 * @throws MWException
	 * @throws ComplexityException
	 * @global string $wgSitename
	 */
	static function mailNotification( array $assignees, $text, Title $title, User $user, $status ) {
		global $wgSitename;

		if ( empty( $assignees ) ) {
			return;
		}
		$title_text = $title->getFullText();
		$from = new \MailAddress( $user->getEmail(), $user->getName() );
		$link = htmlspecialchars( $title->getFullURL() );

		/** @todo This should probably be refactored */
		if ( $status == ST_NEWTASK ) {
			$subject = '[' . $wgSitename . '] ' . wfMessage( 'semantictasks-newtask' )->text() . ' ' .
				$title_text;
			$message = 'semantictasks-newtask-msg';
			$body = wfMessage( $message, $title_text )->text() . " " . $link;
			$body .= "\n \n" . wfMessage( 'semantictasks-text-message' )->text() . "\n" . $text;
		} elseif ( $status == ST_UPDATE ) {
			$subject = '[' . $wgSitename . '] ' . wfMessage( 'semantictasks-taskupdated' )->text() . ' ' .
				$title_text;
			$message = 'semantictasks-updatedtoyou-msg2';
			$body = wfMessage( $message, $title_text )->text() . " " . $link;
			$body .= "\n \n" . wfMessage( 'semantictasks-diff-message' )->text() . "\n" .
				self::generateDiffBodyTxt( $title );
		} elseif ( $status == ST_CLOSED ) {
			$subject = '[' . $wgSitename . '] ' . wfMessage( 'semantictasks-taskclosed' )->text() . ' ' .
				$title_text;
			$message = 'semantictasks-taskclosed-msg';
			$body = wfMessage( $message, $title_text )->text() . " " . $link;
			$body .= "\n \n" . wfMessage( 'semantictasks-text-message' )->text() . "\n" . $text;
		} elseif ( $status == ST_UNASSIGNED ) {
			$subject = '[' . $wgSitename . '] ' . wfMessage( 'semantictasks-taskunassigned' )->text() . ' ' .
				$title_text;
			$message = 'semantictasks-unassignedtoyou-msg2';
			$body = wfMessage( $message, $title_text )->text() . " " . $link;
			$body .= "\n \n" . wfMessage( 'semantictasks-text-message' )->text() . "\n" . $text;
		} else {
			// status == ASSIGNED
			$subject = '[' . $wgSitename . '] ' . wfMessage( 'semantictasks-taskassigned' )->text() . ' ' .
				$title_text;
			$message = 'semantictasks-assignedtoyou-msg2';
			$body = wfMessage( $message, $title_text )->text() . " " . $link;
			$body .= "\n \n" . wfMessage( 'semantictasks-text-message' )->text() . "\n" . $text;
		}

		if (!self::$user_mailer) {
			self::$user_mailer = new \ST\UserMailer(new \UserMailer());
		}

		self::$user_mailer->send( $assignees, $from, $subject, $body );
	}

	static function setUserMailer(\ST\UserMailer $user_mailer) {
		self::$user_mailer = $user_mailer;
	}

	/**
	 * Generates a diff txt
	 *
	 * Code is similar to DifferenceEngine::generateTextDiffBody
	 * @param Title $title
	 * @param IContextSource $context
	 * @return string
	 * @throws ComplexityException
	 * @throws MWException
	 */
	static function generateDiffBodyTxt( Title $title, IContextSource $context = null) {

It is generally recommended to explicitly declare the visibility for methods.

		$revision = \Revision::newFromTitle( $title, 0 );
		if ($revision === null) {
			return '';
		}
		/** @todo The first parameter should be a Context. */
		$diff = new \DifferenceEngine( $context, $revision->getId(), 'prev' );
		// The DifferenceEngine::getDiffBody() method generates html,
		// so let's generate the txt diff manually:
		global $wgContLang;
		$diff->loadText();
		$otext = '';
		$ntext = '';
		if ( version_compare( MW_VERSION, '1.32', '<' ) ) {
			$otext = str_replace( "\r\n", "\n", \ContentHandler::getContentText( $diff->mOldContent ) );
			$ntext = str_replace( "\r\n", "\n", \ContentHandler::getContentText( $diff->mNewContent ) );
		} else {
			if ($diff->getOldRevision()) {
				$otext = str_replace( "\r\n", "\n", ContentHandler::getContentText( $diff->getOldRevision()->getContent( 'main' ) ) );
			}
			if ($diff->getNewRevision()) {
				$ntext = str_replace( "\r\n", "\n", ContentHandler::getContentText( $diff->getNewRevision()->getContent( 'main' ) ) );
			}
		}
		$ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
		$nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
		// We use here the php diff engine included in MediaWiki
		$diffs = new \Diff( $ota, $nta );
		// And we ask for a txt formatted diff
		$formatter = new \UnifiedDiffFormatter();
		$diff_text = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
		return $diff_text;
	}

	/**
	 * Run by the maintenance script to remind the assignees
	 *
	 * @return boolean
	 * @throws Exception
	 * @global string $wgSitename
	 * @global Language $wgLang
	 */
	static function remindAssignees() {
		global $wgSitename;
		global $stgPropertyReminderAt;
		global $stgPropertyAssignedTo;
		global $stgPropertyTargetDate;
		global $stgPropertyStatus;

		# Make this equal to midnight. Rational is that if users set today as the Target date with
		# reminders set to "0" so that the reminder happens on the deadline, the reminders will go
		# out even though now it is after the beginning of today and technically past the
		# target date.
		$today = wfTimestamp( TS_ISO_8601, strtotime( 'today midnight' ) );

		# Get tasks where a reminder is called for, whose status is either new or in progress, and
		# whose target date is in the future.
		$query_string = "[[$stgPropertyReminderAt::+]][[$stgPropertyStatus::New||In Progress]][[$stgPropertyTargetDate::≥ $today]]";
		$properties_to_display = array( $stgPropertyReminderAt, $stgPropertyAssignedTo, $stgPropertyTargetDate );

		$results = Query::getQueryResults( $query_string, $properties_to_display, true );
		if ( empty( $results ) ) {
			return false;
		}

		while ( $row = $results->getNext() ) {
			$task_name = $row[0]->getNextObject()->getTitle();
			$subject = '[' . $wgSitename . '] ' . wfMessage( 'semantictasks-reminder' )->text() . $task_name;
			// The following doesn't work, maybe because we use a cron job.
			// $link = $task_name->getFullURL();
			// So let's do it manually
			//$link = $wiki_url . $task_name->getPartialURL();
			// You know what? Let's try it again.
			$link = $task_name->getFullURL();

			$target_date = $row[3]->getNextObject();
			$tg_date = new DateTime( $target_date->getShortHTMLText() );

			while ( $reminder = $row[1]->getNextObject() ) {
				$remind_me_in = $reminder->getShortHTMLText();
				$date = new DateTime( 'today midnight' );
				$date->modify( "+$remind_me_in day" );

				if ( $tg_date === $date ) {
					global $wgLang;
					while ( $task_assignee = $row[2]->getNextObject() ) {
						$assignee_username = $task_assignee->getTitle()->getText();
						$assignee = User::newFromName( $assignee_username );

						$body = wfMessage( 'semantictasks-reminder-message2', $task_name,
							$wgLang->formatNum( $remind_me_in ), $link )->text();
						$assignee->sendMail( $subject, $body );
					}
				}
			}
		}
		return true;
	}

	/**
	 * Prints debugging information. $debugText is what you want to print, $debugVal
	 * is the level at which you want to print the information.
	 *
	 * @global boolean $wgSemanticTasksDebug
	 * @param string $debugText
	 * @param string $debugArr
	 * @access private
	 */
	static function printDebug( $debugText, $debugArr = null ) {
		global $wgSemanticTasksDebug;

		if ( $wgSemanticTasksDebug ) {
			if ( isset( $debugArr ) ) {
				$text = $debugText . ' ' . implode( '::', $debugArr );
				wfDebugLog( 'semantic-tasks', $text, false );
			} else {
				wfDebugLog( 'semantic-tasks', $debugText, false );
			}
		}
	}

}