DiffusionUpdateObjectAfterCommitWorker.php
No OneTemporary
Actions

Size

7 KB

Referenced Files

None

Subscribers

None

DiffusionUpdateObjectAfterCommitWorker.php
View Options

	<?php

	final class DiffusionUpdateObjectAfterCommitWorker
	extends PhabricatorWorker {

	private $properties;

	protected function getViewer() {
	return PhabricatorUser::getOmnipotentUser();
	}

	protected function doWork() {
	$viewer = $this->getViewer();
	$data = $this->getTaskData();

	$commit_phid = idx($data, 'commitPHID');
	if (!$commit_phid) {
	throw new PhabricatorWorkerPermanentFailureException(
	pht('No "commitPHID" in task data.'));
	}

	$commit = id(new DiffusionCommitQuery())
	->setViewer($viewer)
	->withPHIDs(array($commit_phid))
	->needIdentities(true)
	->executeOne();
	if (!$commit) {
	throw new PhabricatorWorkerPermanentFailureException(
	pht(
	'Unable to load commit "%s".',
	$commit_phid));
	}

	$object_phid = idx($data, 'objectPHID');
	if (!$object_phid) {
	throw new PhabricatorWorkerPermanentFailureException(
	pht('No "objectPHID" in task data.'));
	}

	$object = id(new PhabricatorObjectQuery())
	->setViewer($viewer)
	->withPHIDs(array($object_phid))
	->executeOne();
	if (!$object) {
	throw new PhabricatorWorkerPermanentFailureException(
	pht(
	'Unable to load object "%s".',
	$object_phid));
	}

	$properties = idx($data, 'properties', array());
	$this->properties = $properties;

	if ($object instanceof ManiphestTask) {
	$this->updateTask($commit, $object);
	} else if ($object instanceof DifferentialRevision) {
	$this->updateRevision($commit, $object);
	}
	}

	protected function getUpdateProperty($key, $default = null) {
	return idx($this->properties, $key, $default);
	}

	protected function getActingPHID(PhabricatorRepositoryCommit $commit) {
	if ($commit->hasCommitterIdentity()) {
	return $commit->getCommitterIdentity()->getIdentityDisplayPHID();
	}

	if ($commit->hasAuthorIdentity()) {
	return $commit->getAuthorIdentity()->getIdentityDisplayPHID();
	}

	return id(new PhabricatorDiffusionApplication())->getPHID();
	}

	protected function loadActingUser($acting_phid) {
	// If we we were able to identify an author or committer for the commit, we
	// try to act as that user when affecting other objects, like tasks marked
	// with "Fixes Txxx".

	// This helps to prevent mistakes where a user accidentally writes the
	// wrong task IDs and affects tasks they can't see (and thus can't undo the
	// status changes for).

	// This is just a guard rail, not a security measure. An attacker can still
	// forge another user's identity trivially by forging author or committer
	// email addresses.

	// We also let commits with unrecognized authors act on any task to make
	// behavior less confusing for new installs, and any user can craft a
	// commit with an unrecognized author and committer.

	$viewer = $this->getViewer();

	$user_type = PhabricatorPeopleUserPHIDType::TYPECONST;
	if (phid_get_type($acting_phid) === $user_type) {
	$acting_user = id(new PhabricatorPeopleQuery())
	->setViewer($viewer)
	->withPHIDs(array($acting_phid))
	->executeOne();
	if ($acting_user) {
	return $acting_user;
	}
	}

	return $viewer;
	}

	private function updateTask(
	PhabricatorRepositoryCommit $commit,
	ManiphestTask $task) {

	$acting_phid = $this->getActingPHID($commit);
	$acting_user = $this->loadActingUser($acting_phid);

	$commit_phid = $commit->getPHID();

	$xactions = array();

	$xactions[] = $this->newEdgeTransaction(
	$task,
	$commit,
	ManiphestTaskHasCommitEdgeType::EDGECONST);

	$status = $this->getUpdateProperty('status');
	if ($status) {
	$xactions[] = $task->getApplicationTransactionTemplate()
	->setTransactionType(ManiphestTaskStatusTransaction::TRANSACTIONTYPE)
	->setMetadataValue('commitPHID', $commit_phid)
	->setNewValue($status);
	}

	$content_source = $this->newContentSource();

	$editor = $task->getApplicationTransactionEditor()
	->setActor($acting_user)
	->setActingAsPHID($acting_phid)
	->setContentSource($content_source)
	->setContinueOnNoEffect(true)
	->setContinueOnMissingFields(true)
	->addUnmentionablePHIDs(array($commit_phid));

	$editor->applyTransactions($task, $xactions);
	}

	private function updateRevision(
	PhabricatorRepositoryCommit $commit,
	DifferentialRevision $revision) {

	$acting_phid = $this->getActingPHID($commit);
	$acting_user = $this->loadActingUser($acting_phid);

	// See T13625. The "Acting User" is the author of the commit based on the
	// author string, or the Diffusion application PHID if we could not
	// identify an author.

	// This user may not be able to view the commit or the revision, and may
	// also be unable to make API calls. Here, we execute queries and apply
	// transactions as the omnipotent user.

	// It would probably be better to use the acting user everywhere here, and
	// exit gracefully if they can't see the revision (this is how the flow
	// on tasks works). However, without a positive indicator in the UI
	// explaining "no revision was updated because the author of this commit
	// can't see anything", this might be fairly confusing, and break workflows
	// which have worked historically.

	// This isn't, per se, a policy violation (you can't get access to anything
	// you don't already have access to by making commits that reference
	// revisions, even if you can't see the commits or revisions), so just
	// leave it for now.

	$viewer = $this->getViewer();

	// Reload the revision to get the active diff, which is currently required
	// by "updateRevisionWithCommit()".
	$revision = id(new DifferentialRevisionQuery())
	->setViewer($viewer)
	->withIDs(array($revision->getID()))
	->needActiveDiffs(true)
	->executeOne();

	$xactions = array();

	$xactions[] = $this->newEdgeTransaction(
	$revision,
	$commit,
	DifferentialRevisionHasCommitEdgeType::EDGECONST);

	$match_data = $this->getUpdateProperty('revisionMatchData');

	$type_close = DifferentialRevisionCloseTransaction::TRANSACTIONTYPE;
	$xactions[] = $revision->getApplicationTransactionTemplate()
	->setTransactionType($type_close)
	->setNewValue(true)
	->setMetadataValue('isCommitClose', true)
	->setMetadataValue('revisionMatchData', $match_data)
	->setMetadataValue('commitPHID', $commit->getPHID());

	$extraction_engine = id(new DifferentialDiffExtractionEngine())
	->setViewer($viewer)
	->setAuthorPHID($acting_phid);

	$content_source = $this->newContentSource();

	$extraction_engine->updateRevisionWithCommit(
	$revision,
	$commit,
	$xactions,
	$content_source);
	}

	private function newEdgeTransaction(
	$object,
	PhabricatorRepositoryCommit $commit,
	$edge_type) {

	$commit_phid = $commit->getPHID();

	return $object->getApplicationTransactionTemplate()
	->setTransactionType(PhabricatorTransactions::TYPE_EDGE)
	->setMetadataValue('edge:type', $edge_type)
	->setNewValue(
	array(
	'+' => array(
	$commit_phid => $commit_phid,
	),
	));
	}


	}

File Metadata

Mime Type: text/x-php
Expires: Mon, May 12, 8:48 AM (2 d)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 107939
Default Alt Text: DiffusionUpdateObjectAfterCommitWorker.php (7 KB)

DiffusionUpdateObjectAfterCommitWorker.phpNo OneTemporaryActions

DiffusionUpdateObjectAfterCommitWorker.phpView Options

File Metadata

Event Timeline

DiffusionUpdateObjectAfterCommitWorker.php
No OneTemporary
Actions

DiffusionUpdateObjectAfterCommitWorker.php
View Options