Differential D21691 Diff 51704 src/applications/harbormaster/xaction/build/HarbormasterBuildMessageTransaction.php

Changeset View

Standalone View

src/applications/harbormaster/xaction/build/HarbormasterBuildMessageTransaction.php

	<?php			<?php

	abstract class HarbormasterBuildMessageTransaction			abstract class HarbormasterBuildMessageTransaction
	extends HarbormasterBuildTransactionType {			extends HarbormasterBuildTransactionType {

				final public function getHarbormasterBuildMessageType() {
				return $this->getPhobjectClassConstant('MESSAGETYPE');
				}

				abstract public function getHarbormasterBuildMessageName();
				abstract public function getHarbormasterBuildableMessageName();
				abstract public function getHarbormasterBuildableMessageEffect();

				abstract public function newConfirmPromptTitle();
				abstract public function newConfirmPromptBody();

				abstract public function newBuildableConfirmPromptTitle(
				array $builds,
				array $sendable);

				abstract public function newBuildableConfirmPromptBody(
				array $builds,
				array $sendable);

				public function newBuildableConfirmPromptWarnings(
				array $builds,
				array $sendable) {
				return array();
				}

	final public function generateOldValue($object) {			final public function generateOldValue($object) {
	return null;			return null;
	}			}

	final public function getTransactionTypeForConduit($xaction) {			final public function getTransactionTypeForConduit($xaction) {
	return 'message';			return 'message';
	}			}

	final public function getFieldValuesForConduit($xaction, $data) {			final public function getFieldValuesForConduit($xaction, $data) {
	return array(			return array(
	'type' => $xaction->getNewValue(),			'type' => $xaction->getNewValue(),
	);			);
	}			}

	final public static function getTransactionTypeForMessageType($message_type) {			final public static function getTransactionObjectForMessageType(
				$message_type) {
	$message_xactions = id(new PhutilClassMapQuery())			$message_xactions = id(new PhutilClassMapQuery())
	->setAncestorClass(__CLASS__)			->setAncestorClass(__CLASS__)
	->execute();			->execute();

	foreach ($message_xactions as $message_xaction) {			foreach ($message_xactions as $message_xaction) {
	if ($message_xaction->getMessageType() === $message_type) {			$xaction_type = $message_xaction->getHarbormasterBuildMessageType();
	return $message_xaction->getTransactionTypeConstant();			if ($xaction_type === $message_type) {
				return $message_xaction;
	}			}
	}			}

	return null;			return null;
	}			}

	abstract public function getMessageType();			final public static function getTransactionTypeForMessageType($message_type) {
				$message_xaction = self::getTransactionObjectForMessageType($message_type);

				if ($message_xaction) {
				return $message_xaction->getTransactionTypeConstant();
				}

	public function validateTransactions($object, array $xactions) {			return null;
	$errors = array();			}

				final public function getTransactionHasEffect($object, $old, $new) {
				return $this->canApplyMessage($this->getActor(), $object);
				}

	// TODO: Restore logic that tests if the command can issue without causing			final public function canApplyMessage(
	// anything to lapse into an invalid state. This should not be the same			PhabricatorUser $viewer,
	// as the logic which powers the web UI: for example, if an "abort" is			HarbormasterBuild $build) {
	// queued we want to disable "Abort" in the web UI, but should obviously
	// process it here.

	return $errors;			try {
				$this->assertCanApplyMessage($viewer, $build);
				return true;
				} catch (HarbormasterRestartException $ex) {
				return false;
	}			}
				}

				final public function canSendMessage(
				PhabricatorUser $viewer,
				HarbormasterBuild $build) {

				try {
				$this->assertCanSendMessage($viewer, $build);
				return true;
				} catch (HarbormasterRestartException $ex) {
				return false;
				}
				}

				final public function assertCanApplyMessage(
				PhabricatorUser $viewer,
				HarbormasterBuild $build) {
				$this->newCanApplyMessageAssertion($viewer, $build);
				}

				final public function assertCanSendMessage(
				PhabricatorUser $viewer,
				HarbormasterBuild $build) {
				$plan = $build->getBuildPlan();

				// See T13526. Users without permission to access the build plan can
				// currently end up here with no "BuildPlan" object.
				if (!$plan) {
				throw new HarbormasterRestartException(
				pht('No Build Plan Permission'),
				pht(
				'You can not issue this command because you do not have '.
				'permission to access the build plan for this build.'));
				}

				// Issuing these commands requires that you be able to edit the build, to
				// prevent enemy engineers from sabotaging your builds. See T9614.
				if (!$plan->canRunWithoutEditCapability()) {
				try {
				PhabricatorPolicyFilter::requireCapability(
				$viewer,
				$plan,
				PhabricatorPolicyCapability::CAN_EDIT);
				} catch (PhabricatorPolicyException $ex) {
				throw new HarbormasterRestartException(
				pht('Insufficent Build Plan Permission'),
				pht(
				'The build plan for this build is configured to prevent '.
				'users who can not edit it from issuing commands to the '.
				'build, and you do not have permission to edit the build '.
				'plan.'));
				}
				}

				$this->newCanSendMessageAssertion($viewer, $build);
				$this->assertCanApplyMessage($viewer, $build);
				}

				abstract protected function newCanSendMessageAssertion(
				PhabricatorUser $viewer,
				HarbormasterBuild $build);

				abstract protected function newCanApplyMessageAssertion(
				PhabricatorUser $viewer,
				HarbormasterBuild $build);

	}			}