No OneTemporary
Actions

Size

42 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/applications/audit/query/PhabricatorCommitSearchEngine.php b/src/applications/audit/query/PhabricatorCommitSearchEngine.php
	index 44413946db..ee5105f193 100644
	--- a/src/applications/audit/query/PhabricatorCommitSearchEngine.php
	+++ b/src/applications/audit/query/PhabricatorCommitSearchEngine.php
	@@ -1,254 +1,255 @@
	<?php

	final class PhabricatorCommitSearchEngine
	extends PhabricatorApplicationSearchEngine {

	public function getResultTypeDescription() {
	return pht('Diffusion Commits');
	}

	public function getApplicationClassName() {
	return 'PhabricatorDiffusionApplication';
	}

	public function newQuery() {
	return id(new DiffusionCommitQuery())
	->needAuditRequests(true)
	->needCommitData(true)
	+ ->needIdentities(true)
	->needDrafts(true);
	}

	protected function newResultBuckets() {
	return DiffusionCommitResultBucket::getAllResultBuckets();
	}

	protected function buildQueryFromParameters(array $map) {
	$query = $this->newQuery();

	if ($map['responsiblePHIDs']) {
	$query->withResponsiblePHIDs($map['responsiblePHIDs']);
	}

	if ($map['auditorPHIDs']) {
	$query->withAuditorPHIDs($map['auditorPHIDs']);
	}

	if ($map['authorPHIDs']) {
	$query->withAuthorPHIDs($map['authorPHIDs']);
	}

	if ($map['statuses']) {
	$query->withStatuses($map['statuses']);
	}

	if ($map['repositoryPHIDs']) {
	$query->withRepositoryPHIDs($map['repositoryPHIDs']);
	}

	if ($map['packagePHIDs']) {
	$query->withPackagePHIDs($map['packagePHIDs']);
	}

	if ($map['unreachable'] !== null) {
	$query->withUnreachable($map['unreachable']);
	}

	if ($map['ancestorsOf']) {
	$query->withAncestorsOf($map['ancestorsOf']);
	}

	return $query;
	}

	protected function buildCustomSearchFields() {
	return array(
	id(new PhabricatorSearchDatasourceField())
	->setLabel(pht('Responsible Users'))
	->setKey('responsiblePHIDs')
	->setConduitKey('responsible')
	->setAliases(array('responsible', 'responsibles', 'responsiblePHID'))
	->setDatasource(new DifferentialResponsibleDatasource())
	->setDescription(
	pht(
	'Find commits where given users, projects, or packages are '.
	'responsible for the next steps in the audit workflow.')),
	id(new PhabricatorUsersSearchField())
	->setLabel(pht('Authors'))
	->setKey('authorPHIDs')
	->setConduitKey('authors')
	->setAliases(array('author', 'authors', 'authorPHID'))
	->setDescription(pht('Find commits authored by particular users.')),
	id(new PhabricatorSearchDatasourceField())
	->setLabel(pht('Auditors'))
	->setKey('auditorPHIDs')
	->setConduitKey('auditors')
	->setAliases(array('auditor', 'auditors', 'auditorPHID'))
	->setDatasource(new DiffusionAuditorFunctionDatasource())
	->setDescription(
	pht(
	'Find commits where given users, projects, or packages are '.
	'auditors.')),
	id(new PhabricatorSearchCheckboxesField())
	->setLabel(pht('Audit Status'))
	->setKey('statuses')
	->setAliases(array('status'))
	->setOptions(DiffusionCommitAuditStatus::newOptions())
	->setDeprecatedOptions(
	DiffusionCommitAuditStatus::newDeprecatedOptions())
	->setDescription(pht('Find commits with given audit statuses.')),
	id(new PhabricatorSearchDatasourceField())
	->setLabel(pht('Repositories'))
	->setKey('repositoryPHIDs')
	->setConduitKey('repositories')
	->setAliases(array('repository', 'repositories', 'repositoryPHID'))
	->setDatasource(new DiffusionRepositoryFunctionDatasource())
	->setDescription(pht('Find commits in particular repositories.')),
	id(new PhabricatorSearchDatasourceField())
	->setLabel(pht('Packages'))
	->setKey('packagePHIDs')
	->setConduitKey('packages')
	->setAliases(array('package', 'packages', 'packagePHID'))
	->setDatasource(new PhabricatorOwnersPackageDatasource())
	->setDescription(
	pht('Find commits which affect given packages.')),
	id(new PhabricatorSearchThreeStateField())
	->setLabel(pht('Unreachable'))
	->setKey('unreachable')
	->setOptions(
	pht('(Show All)'),
	pht('Show Only Unreachable Commits'),
	pht('Hide Unreachable Commits'))
	->setDescription(
	pht(
	'Find or exclude unreachable commits which are not ancestors of '.
	'any branch, tag, or ref.')),
	id(new PhabricatorSearchStringListField())
	->setLabel(pht('Ancestors Of'))
	->setKey('ancestorsOf')
	->setDescription(
	pht(
	'Find commits which are ancestors of a particular ref, '.
	'like "master".')),
	);
	}

	protected function getURI($path) {
	return '/diffusion/commit/'.$path;
	}

	protected function getBuiltinQueryNames() {
	$names = array();

	if ($this->requireViewer()->isLoggedIn()) {
	$names['active'] = pht('Active Audits');
	$names['authored'] = pht('Authored');
	$names['audited'] = pht('Audited');
	}

	$names['all'] = pht('All Commits');

	return $names;
	}

	public function buildSavedQueryFromBuiltin($query_key) {
	$query = $this->newSavedQuery();
	$query->setQueryKey($query_key);
	$viewer = $this->requireViewer();

	$viewer_phid = $viewer->getPHID();
	switch ($query_key) {
	case 'all':
	return $query;
	case 'active':
	$bucket_key = DiffusionCommitRequiredActionResultBucket::BUCKETKEY;

	$open = DiffusionCommitAuditStatus::getOpenStatusConstants();

	$query
	->setParameter('responsiblePHIDs', array($viewer_phid))
	->setParameter('statuses', $open)
	->setParameter('bucket', $bucket_key)
	->setParameter('unreachable', false);
	return $query;
	case 'authored':
	$query
	->setParameter('authorPHIDs', array($viewer_phid));
	return $query;
	case 'audited':
	$query
	->setParameter('auditorPHIDs', array($viewer_phid));
	return $query;
	}

	return parent::buildSavedQueryFromBuiltin($query_key);
	}

	protected function renderResultList(
	array $commits,
	PhabricatorSavedQuery $query,
	array $handles) {
	assert_instances_of($commits, 'PhabricatorRepositoryCommit');
	$viewer = $this->requireViewer();

	$bucket = $this->getResultBucket($query);

	$template = id(new PhabricatorAuditListView())
	->setViewer($viewer)
	->setShowDrafts(true);

	$views = array();
	if ($bucket) {
	$bucket->setViewer($viewer);

	try {
	$groups = $bucket->newResultGroups($query, $commits);

	foreach ($groups as $group) {
	// Don't show groups in Dashboard Panels
	if ($group->getObjects() \|\| !$this->isPanelContext()) {
	$views[] = id(clone $template)
	->setHeader($group->getName())
	->setNoDataString($group->getNoDataString())
	->setCommits($group->getObjects());
	}
	}
	} catch (Exception $ex) {
	$this->addError($ex->getMessage());
	}
	} else {
	$views[] = id(clone $template)
	->setCommits($commits)
	->setNoDataString(pht('No commits found.'));
	}

	if (!$views) {
	$views[] = id(new PhabricatorAuditListView())
	->setViewer($viewer)
	->setNoDataString(pht('No commits found.'));
	}

	if (count($views) == 1) {
	$list = head($views)->buildList();
	} else {
	$list = $views;
	}

	$result = new PhabricatorApplicationSearchResultView();
	$result->setContent($list);

	return $result;
	}

	protected function getNewUserBody() {

	$view = id(new PHUIBigInfoView())
	->setIcon('fa-check-circle-o')
	->setTitle(pht('Welcome to Audit'))
	->setDescription(
	pht('Post-commit code review and auditing. Audits you are assigned '.
	'to will appear here.'));

	return $view;
	}

	}
	diff --git a/src/applications/diffusion/DiffusionCommitAuditStatus.php b/src/applications/diffusion/DiffusionCommitAuditStatus.php
	index ce8ec09d27..95d0e52213 100644
	--- a/src/applications/diffusion/DiffusionCommitAuditStatus.php
	+++ b/src/applications/diffusion/DiffusionCommitAuditStatus.php
	@@ -1,163 +1,173 @@
	<?php

	final class DiffusionCommitAuditStatus extends Phobject {

	private $key;
	private $spec = array();

	const NONE = 'none';
	const NEEDS_AUDIT = 'needs-audit';
	const CONCERN_RAISED = 'concern-raised';
	const PARTIALLY_AUDITED = 'partially-audited';
	const AUDITED = 'audited';
	const NEEDS_VERIFICATION = 'needs-verification';

	public static function newModernKeys(array $values) {
	$map = self::getMap();

	$modern = array();
	foreach ($map as $key => $spec) {
	if (isset($spec['legacy'])) {
	$modern[$spec['legacy']] = $key;
	}
	}

	foreach ($values as $key => $value) {
	$values[$key] = idx($modern, $value, $value);
	}

	return $values;
	}

	public static function newForStatus($status) {
	$result = new self();

	$result->key = $status;

	$map = self::getMap();
	if (isset($map[$status])) {
	$result->spec = $map[$status];
	}

	return $result;
	}

	public function getKey() {
	return $this->key;
	}

	public function getIcon() {
	return idx($this->spec, 'icon');
	}

	public function getColor() {
	return idx($this->spec, 'color');
	}

	+ public function getAnsiColor() {
	+ return idx($this->spec, 'color.ansi');
	+ }
	+
	public function getName() {
	return idx($this->spec, 'name', pht('Unknown ("%s")', $this->key));
	}

	public function isNoAudit() {
	return ($this->key == self::NONE);
	}

	public function isNeedsAudit() {
	return ($this->key == self::NEEDS_AUDIT);
	}

	public function isConcernRaised() {
	return ($this->key == self::CONCERN_RAISED);
	}

	public function isNeedsVerification() {
	return ($this->key == self::NEEDS_VERIFICATION);
	}

	public function isPartiallyAudited() {
	return ($this->key == self::PARTIALLY_AUDITED);
	}

	public function isAudited() {
	return ($this->key == self::AUDITED);
	}

	public function getIsClosed() {
	return idx($this->spec, 'closed');
	}

	public static function getOpenStatusConstants() {
	$constants = array();
	foreach (self::getMap() as $key => $map) {
	if (!$map['closed']) {
	$constants[] = $key;
	}
	}
	return $constants;
	}

	public static function newOptions() {
	$map = self::getMap();
	return ipull($map, 'name');
	}

	public static function newDeprecatedOptions() {
	$map = self::getMap();

	$results = array();
	foreach ($map as $key => $spec) {
	if (isset($spec['legacy'])) {
	$results[$spec['legacy']] = $key;
	}
	}

	return $results;
	}

	private static function getMap() {
	return array(
	self::NONE => array(
	'name' => pht('No Audits'),
	'legacy' => 0,
	'icon' => 'fa-check',
	'color' => 'bluegrey',
	'closed' => true,
	+ 'color.ansi' => null,
	),
	self::NEEDS_AUDIT => array(
	'name' => pht('Audit Required'),
	'legacy' => 1,
	'icon' => 'fa-exclamation-circle',
	'color' => 'orange',
	'closed' => false,
	+ 'color.ansi' => 'magenta',
	),
	self::CONCERN_RAISED => array(
	'name' => pht('Concern Raised'),
	'legacy' => 2,
	'icon' => 'fa-times-circle',
	'color' => 'red',
	'closed' => false,
	+ 'color.ansi' => 'red',
	),
	self::PARTIALLY_AUDITED => array(
	'name' => pht('Partially Audited'),
	'legacy' => 3,
	'icon' => 'fa-check-circle-o',
	'color' => 'yellow',
	'closed' => false,
	+ 'color.ansi' => 'yellow',
	),
	self::AUDITED => array(
	'name' => pht('Audited'),
	'legacy' => 4,
	'icon' => 'fa-check-circle',
	'color' => 'green',
	'closed' => true,
	+ 'color.ansi' => 'green',
	),
	self::NEEDS_VERIFICATION => array(
	'name' => pht('Needs Verification'),
	'legacy' => 5,
	'icon' => 'fa-refresh',
	'color' => 'indigo',
	'closed' => false,
	+ 'color.ansi' => 'magenta',
	),
	);
	}
	}
	diff --git a/src/applications/repository/storage/PhabricatorRepositoryCommit.php b/src/applications/repository/storage/PhabricatorRepositoryCommit.php
	index 38a6631200..0362aa778c 100644
	--- a/src/applications/repository/storage/PhabricatorRepositoryCommit.php
	+++ b/src/applications/repository/storage/PhabricatorRepositoryCommit.php
	@@ -1,887 +1,981 @@
	<?php

	final class PhabricatorRepositoryCommit
	extends PhabricatorRepositoryDAO
	implements
	PhabricatorPolicyInterface,
	PhabricatorFlaggableInterface,
	PhabricatorProjectInterface,
	PhabricatorTokenReceiverInterface,
	PhabricatorSubscribableInterface,
	PhabricatorMentionableInterface,
	HarbormasterBuildableInterface,
	HarbormasterCircleCIBuildableInterface,
	HarbormasterBuildkiteBuildableInterface,
	PhabricatorCustomFieldInterface,
	PhabricatorApplicationTransactionInterface,
	PhabricatorFulltextInterface,
	PhabricatorFerretInterface,
	PhabricatorConduitResultInterface,
	PhabricatorDraftInterface {

	protected $repositoryID;
	protected $phid;
	protected $authorIdentityPHID;
	protected $committerIdentityPHID;
	protected $commitIdentifier;
	protected $epoch;
	protected $mailKey;
	protected $authorPHID;
	protected $auditStatus = DiffusionCommitAuditStatus::NONE;
	protected $summary = '';
	protected $importStatus = 0;

	const IMPORTED_MESSAGE = 1;
	const IMPORTED_CHANGE = 2;
	const IMPORTED_OWNERS = 4;
	const IMPORTED_HERALD = 8;
	const IMPORTED_ALL = 15;

	const IMPORTED_CLOSEABLE = 1024;
	const IMPORTED_UNREACHABLE = 2048;

	private $commitData = self::ATTACHABLE;
	private $audits = self::ATTACHABLE;
	private $repository = self::ATTACHABLE;
	private $customFields = self::ATTACHABLE;
	private $authorIdentity = self::ATTACHABLE;
	private $committerIdentity = self::ATTACHABLE;

	private $drafts = array();
	private $auditAuthorityPHIDs = array();

	public function attachRepository(PhabricatorRepository $repository) {
	$this->repository = $repository;
	return $this;
	}

	public function getRepository($assert_attached = true) {
	if ($assert_attached) {
	return $this->assertAttached($this->repository);
	}
	return $this->repository;
	}

	public function isPartiallyImported($mask) {
	return (($mask & $this->getImportStatus()) == $mask);
	}

	public function isImported() {
	return $this->isPartiallyImported(self::IMPORTED_ALL);
	}

	public function isUnreachable() {
	return $this->isPartiallyImported(self::IMPORTED_UNREACHABLE);
	}

	public function writeImportStatusFlag($flag) {
	return $this->adjustImportStatusFlag($flag, true);
	}

	public function clearImportStatusFlag($flag) {
	return $this->adjustImportStatusFlag($flag, false);
	}

	private function adjustImportStatusFlag($flag, $set) {
	$conn_w = $this->establishConnection('w');
	$table_name = $this->getTableName();
	$id = $this->getID();

	if ($set) {
	queryfx(
	$conn_w,
	'UPDATE %T SET importStatus = (importStatus \| %d) WHERE id = %d',
	$table_name,
	$flag,
	$id);

	$this->setImportStatus($this->getImportStatus() \| $flag);
	} else {
	queryfx(
	$conn_w,
	'UPDATE %T SET importStatus = (importStatus & ~%d) WHERE id = %d',
	$table_name,
	$flag,
	$id);

	$this->setImportStatus($this->getImportStatus() & ~$flag);
	}

	return $this;
	}

	protected function getConfiguration() {
	return array(
	self::CONFIG_AUX_PHID => true,
	self::CONFIG_TIMESTAMPS => false,
	self::CONFIG_COLUMN_SCHEMA => array(
	'commitIdentifier' => 'text40',
	'mailKey' => 'bytes20',
	'authorPHID' => 'phid?',
	'authorIdentityPHID' => 'phid?',
	'committerIdentityPHID' => 'phid?',
	'auditStatus' => 'text32',
	'summary' => 'text255',
	'importStatus' => 'uint32',
	),
	self::CONFIG_KEY_SCHEMA => array(
	'key_phid' => null,
	'phid' => array(
	'columns' => array('phid'),
	'unique' => true,
	),
	'repositoryID' => array(
	'columns' => array('repositoryID', 'importStatus'),
	),
	'authorPHID' => array(
	'columns' => array('authorPHID', 'auditStatus', 'epoch'),
	),
	'repositoryID_2' => array(
	'columns' => array('repositoryID', 'epoch'),
	),
	'key_commit_identity' => array(
	'columns' => array('commitIdentifier', 'repositoryID'),
	'unique' => true,
	),
	'key_epoch' => array(
	'columns' => array('epoch'),
	),
	'key_author' => array(
	'columns' => array('authorPHID', 'epoch'),
	),
	),
	self::CONFIG_NO_MUTATE => array(
	'importStatus',
	),
	) + parent::getConfiguration();
	}

	public function generatePHID() {
	return PhabricatorPHID::generateNewPHID(
	PhabricatorRepositoryCommitPHIDType::TYPECONST);
	}

	public function loadCommitData() {
	if (!$this->getID()) {
	return null;
	}
	return id(new PhabricatorRepositoryCommitData())->loadOneWhere(
	'commitID = %d',
	$this->getID());
	}

	public function attachCommitData(
	PhabricatorRepositoryCommitData $data = null) {
	$this->commitData = $data;
	return $this;
	}

	public function getCommitData() {
	return $this->assertAttached($this->commitData);
	}

	public function attachAudits(array $audits) {
	assert_instances_of($audits, 'PhabricatorRepositoryAuditRequest');
	$this->audits = $audits;
	return $this;
	}

	public function getAudits() {
	return $this->assertAttached($this->audits);
	}

	public function hasAttachedAudits() {
	return ($this->audits !== self::ATTACHABLE);
	}

	public function attachIdentities(
	PhabricatorRepositoryIdentity $author = null,
	PhabricatorRepositoryIdentity $committer = null) {

	$this->authorIdentity = $author;
	$this->committerIdentity = $committer;

	return $this;
	}

	public function getAuthorIdentity() {
	return $this->assertAttached($this->authorIdentity);
	}

	public function getCommitterIdentity() {
	return $this->assertAttached($this->committerIdentity);
	}

	public function loadAndAttachAuditAuthority(
	PhabricatorUser $viewer,
	$actor_phid = null) {

	if ($actor_phid === null) {
	$actor_phid = $viewer->getPHID();
	}

	// TODO: This method is a little weird and sketchy, but worlds better than
	// what came before it. Eventually, this should probably live in a Query
	// class.

	// Figure out which requests the actor has authority over: these are user
	// requests where they are the auditor, and packages and projects they are
	// a member of.

	if (!$actor_phid) {
	$attach_key = $viewer->getCacheFragment();
	$phids = array();
	} else {
	$attach_key = $actor_phid;
	// At least currently, when modifying your own commits, you act only on
	// behalf of yourself, not your packages/projects -- the idea being that
	// you can't accept your own commits. This may change or depend on
	// config.
	$actor_is_author = ($actor_phid == $this->getAuthorPHID());
	if ($actor_is_author) {
	$phids = array($actor_phid);
	} else {
	$phids = array();
	$phids[$actor_phid] = true;

	$owned_packages = id(new PhabricatorOwnersPackageQuery())
	->setViewer($viewer)
	->withAuthorityPHIDs(array($actor_phid))
	->execute();
	foreach ($owned_packages as $package) {
	$phids[$package->getPHID()] = true;
	}

	$projects = id(new PhabricatorProjectQuery())
	->setViewer($viewer)
	->withMemberPHIDs(array($actor_phid))
	->execute();
	foreach ($projects as $project) {
	$phids[$project->getPHID()] = true;
	}

	$phids = array_keys($phids);
	}
	}

	$this->auditAuthorityPHIDs[$attach_key] = array_fuse($phids);

	return $this;
	}

	public function hasAuditAuthority(
	PhabricatorUser $viewer,
	PhabricatorRepositoryAuditRequest $audit,
	$actor_phid = null) {

	if ($actor_phid === null) {
	$actor_phid = $viewer->getPHID();
	}

	if (!$actor_phid) {
	$attach_key = $viewer->getCacheFragment();
	} else {
	$attach_key = $actor_phid;
	}

	$map = $this->assertAttachedKey($this->auditAuthorityPHIDs, $attach_key);

	if (!$actor_phid) {
	return false;
	}

	return isset($map[$audit->getAuditorPHID()]);
	}

	public function writeOwnersEdges(array $package_phids) {
	$src_phid = $this->getPHID();
	$edge_type = DiffusionCommitHasPackageEdgeType::EDGECONST;

	$editor = new PhabricatorEdgeEditor();

	$dst_phids = PhabricatorEdgeQuery::loadDestinationPHIDs(
	$src_phid,
	$edge_type);

	foreach ($dst_phids as $dst_phid) {
	$editor->removeEdge($src_phid, $edge_type, $dst_phid);
	}

	foreach ($package_phids as $package_phid) {
	$editor->addEdge($src_phid, $edge_type, $package_phid);
	}

	$editor->save();

	return $this;
	}

	public function getAuditorPHIDsForEdit() {
	$audits = $this->getAudits();
	return mpull($audits, 'getAuditorPHID');
	}

	public function save() {
	if (!$this->mailKey) {
	$this->mailKey = Filesystem::readRandomCharacters(20);
	}
	return parent::save();
	}

	public function delete() {
	$data = $this->loadCommitData();
	$audits = id(new PhabricatorRepositoryAuditRequest())
	->loadAllWhere('commitPHID = %s', $this->getPHID());
	$this->openTransaction();

	if ($data) {
	$data->delete();
	}
	foreach ($audits as $audit) {
	$audit->delete();
	}
	$result = parent::delete();

	$this->saveTransaction();
	return $result;
	}

	public function getDateCreated() {
	// This is primarily to make analysis of commits with the Fact engine work.
	return $this->getEpoch();
	}

	public function getURI() {
	return '/'.$this->getMonogram();
	}

	/**
	* Synchronize a commit's overall audit status with the individual audit
	* triggers.
	*/
	public function updateAuditStatus(array $requests) {
	assert_instances_of($requests, 'PhabricatorRepositoryAuditRequest');

	$any_concern = false;
	$any_accept = false;
	$any_need = false;

	foreach ($requests as $request) {
	switch ($request->getAuditStatus()) {
	case PhabricatorAuditStatusConstants::AUDIT_REQUIRED:
	case PhabricatorAuditStatusConstants::AUDIT_REQUESTED:
	$any_need = true;
	break;
	case PhabricatorAuditStatusConstants::ACCEPTED:
	$any_accept = true;
	break;
	case PhabricatorAuditStatusConstants::CONCERNED:
	$any_concern = true;
	break;
	}
	}

	if ($any_concern) {
	if ($this->isAuditStatusNeedsVerification()) {
	// If the change is in "Needs Verification", we keep it there as
	// long as any auditors still have concerns.
	$status = DiffusionCommitAuditStatus::NEEDS_VERIFICATION;
	} else {
	$status = DiffusionCommitAuditStatus::CONCERN_RAISED;
	}
	} else if ($any_accept) {
	if ($any_need) {
	$status = DiffusionCommitAuditStatus::PARTIALLY_AUDITED;
	} else {
	$status = DiffusionCommitAuditStatus::AUDITED;
	}
	} else if ($any_need) {
	$status = DiffusionCommitAuditStatus::NEEDS_AUDIT;
	} else {
	$status = DiffusionCommitAuditStatus::NONE;
	}

	return $this->setAuditStatus($status);
	}

	public function getMonogram() {
	$repository = $this->getRepository();
	$callsign = $repository->getCallsign();
	$identifier = $this->getCommitIdentifier();
	if ($callsign !== null) {
	return "r{$callsign}{$identifier}";
	} else {
	$id = $repository->getID();
	return "R{$id}:{$identifier}";
	}
	}

	public function getDisplayName() {
	$repository = $this->getRepository();
	$identifier = $this->getCommitIdentifier();
	return $repository->formatCommitName($identifier);
	}

	/**
	* Return a local display name for use in the context of the containing
	* repository.
	*
	* In Git and Mercurial, this returns only a short hash, like "abcdef012345".
	* See @{method:getDisplayName} for a short name that always includes
	* repository context.
	*
	* @return string Short human-readable name for use inside a repository.
	*/
	public function getLocalName() {
	$repository = $this->getRepository();
	$identifier = $this->getCommitIdentifier();
	return $repository->formatCommitName($identifier, $local = true);
	}

	/**
	* Make a strong effort to find a way to render this commit's committer.
	* This currently attempts to use @{PhabricatorRepositoryIdentity}, and
	* falls back to examining the commit detail information. After we force
	* the migration to using identities, update this method to remove the
	* fallback. See T12164 for details.
	*/
	public function renderAnyCommitter(PhabricatorUser $viewer, $handles) {
	$committer = $this->renderCommitter($viewer, $handles);
	if ($committer) {
	return $committer;
	}

	return $this->renderAuthor($viewer, $handles);
	}

	public function renderCommitter(PhabricatorUser $viewer, $handles) {
	$committer_phid = $this->getCommitterDisplayPHID();
	if ($committer_phid) {
	return $handles[$committer_phid]->renderLink();
	}

	$data = $this->getCommitData();
	$committer_name = $data->getCommitDetail('committer');
	if (strlen($committer_name)) {
	return DiffusionView::renderName($committer_name);
	}

	return null;
	}

	public function renderAuthor(PhabricatorUser $viewer, $handles) {
	$author_phid = $this->getAuthorDisplayPHID();
	if ($author_phid) {
	return $handles[$author_phid]->renderLink();
	}

	$data = $this->getCommitData();
	$author_name = $data->getAuthorName();
	if (strlen($author_name)) {
	return DiffusionView::renderName($author_name);
	}

	return null;
	}

	public function loadIdentities(PhabricatorUser $viewer) {
	if ($this->authorIdentity !== self::ATTACHABLE) {
	return $this;
	}

	$commit = id(new DiffusionCommitQuery())
	->setViewer($viewer)
	->withIDs(array($this->getID()))
	->needIdentities(true)
	->executeOne();

	$author_identity = $commit->getAuthorIdentity();
	$committer_identity = $commit->getCommitterIdentity();

	return $this->attachIdentities($author_identity, $committer_identity);
	}

	public function hasCommitterIdentity() {
	return ($this->getCommitterIdentity() !== null);
	}

	public function hasAuthorIdentity() {
	return ($this->getAuthorIdentity() !== null);
	}

	public function getCommitterDisplayPHID() {
	if ($this->hasCommitterIdentity()) {
	return $this->getCommitterIdentity()->getIdentityDisplayPHID();
	}

	$data = $this->getCommitData();
	return $data->getCommitDetail('committerPHID');
	}

	public function getAuthorDisplayPHID() {
	if ($this->hasAuthorIdentity()) {
	return $this->getAuthorIdentity()->getIdentityDisplayPHID();
	}

	$data = $this->getCommitData();
	return $data->getCommitDetail('authorPHID');
	}

	public function getAuditStatusObject() {
	$status = $this->getAuditStatus();
	return DiffusionCommitAuditStatus::newForStatus($status);
	}

	public function isAuditStatusNoAudit() {
	return $this->getAuditStatusObject()->isNoAudit();
	}

	public function isAuditStatusNeedsAudit() {
	return $this->getAuditStatusObject()->isNeedsAudit();
	}

	public function isAuditStatusConcernRaised() {
	return $this->getAuditStatusObject()->isConcernRaised();
	}

	public function isAuditStatusNeedsVerification() {
	return $this->getAuditStatusObject()->isNeedsVerification();
	}

	public function isAuditStatusPartiallyAudited() {
	return $this->getAuditStatusObject()->isPartiallyAudited();
	}

	public function isAuditStatusAudited() {
	return $this->getAuditStatusObject()->isAudited();
	}

	/* -( PhabricatorPolicyInterface )----------------------------------------- */

	public function getCapabilities() {
	return array(
	PhabricatorPolicyCapability::CAN_VIEW,
	PhabricatorPolicyCapability::CAN_EDIT,
	);
	}

	public function getPolicy($capability) {
	switch ($capability) {
	case PhabricatorPolicyCapability::CAN_VIEW:
	return $this->getRepository()->getPolicy($capability);
	case PhabricatorPolicyCapability::CAN_EDIT:
	return PhabricatorPolicies::POLICY_USER;
	}
	}

	public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
	return $this->getRepository()->hasAutomaticCapability($capability, $viewer);
	}

	public function describeAutomaticCapability($capability) {
	return pht(
	'Commits inherit the policies of the repository they belong to.');
	}


	/* -( PhabricatorTokenReceiverInterface )---------------------------------- */

	public function getUsersToNotifyOfTokenGiven() {
	return array(
	$this->getAuthorPHID(),
	);
	}

	/* -( Stuff for serialization )---------------------------------------------- */

	/**
	* NOTE: this is not a complete serialization; only the 'protected' fields are
	* involved. This is due to ease of (ab)using the Lisk abstraction to get this
	* done, as well as complexity of the other fields.
	*/
	public function toDictionary() {
	return array(
	'repositoryID' => $this->getRepositoryID(),
	'phid' => $this->getPHID(),
	'commitIdentifier' => $this->getCommitIdentifier(),
	'epoch' => $this->getEpoch(),
	'mailKey' => $this->getMailKey(),
	'authorPHID' => $this->getAuthorPHID(),
	'auditStatus' => $this->getAuditStatus(),
	'summary' => $this->getSummary(),
	'importStatus' => $this->getImportStatus(),
	);
	}

	public static function newFromDictionary(array $dict) {
	return id(new PhabricatorRepositoryCommit())
	->loadFromArray($dict);
	}


	/* -( HarbormasterBuildableInterface )------------------------------------- */


	public function getHarbormasterBuildableDisplayPHID() {
	return $this->getHarbormasterBuildablePHID();
	}

	public function getHarbormasterBuildablePHID() {
	return $this->getPHID();
	}

	public function getHarbormasterContainerPHID() {
	return $this->getRepository()->getPHID();
	}

	public function getBuildVariables() {
	$results = array();

	$results['buildable.commit'] = $this->getCommitIdentifier();
	$repo = $this->getRepository();

	$results['repository.callsign'] = $repo->getCallsign();
	$results['repository.phid'] = $repo->getPHID();
	$results['repository.vcs'] = $repo->getVersionControlSystem();
	$results['repository.uri'] = $repo->getPublicCloneURI();

	return $results;
	}

	public function getAvailableBuildVariables() {
	return array(
	'buildable.commit' => pht('The commit identifier, if applicable.'),
	'repository.callsign' =>
	pht('The callsign of the repository in Phabricator.'),
	'repository.phid' =>
	pht('The PHID of the repository in Phabricator.'),
	'repository.vcs' =>
	pht('The version control system, either "svn", "hg" or "git".'),
	'repository.uri' =>
	pht('The URI to clone or checkout the repository from.'),
	);
	}

	public function newBuildableEngine() {
	return new DiffusionBuildableEngine();
	}


	/* -( HarbormasterCircleCIBuildableInterface )----------------------------- */


	public function getCircleCIGitHubRepositoryURI() {
	$repository = $this->getRepository();

	$commit_phid = $this->getPHID();
	$repository_phid = $repository->getPHID();

	if ($repository->isHosted()) {
	throw new Exception(
	pht(
	'This commit ("%s") is associated with a hosted repository '.
	'("%s"). Repositories must be imported from GitHub to be built '.
	'with CircleCI.',
	$commit_phid,
	$repository_phid));
	}

	$remote_uri = $repository->getRemoteURI();
	$path = HarbormasterCircleCIBuildStepImplementation::getGitHubPath(
	$remote_uri);
	if (!$path) {
	throw new Exception(
	pht(
	'This commit ("%s") is associated with a repository ("%s") that '.
	'with a remote URI ("%s") that does not appear to be hosted on '.
	'GitHub. Repositories must be hosted on GitHub to be built with '.
	'CircleCI.',
	$commit_phid,
	$repository_phid,
	$remote_uri));
	}

	return $remote_uri;
	}

	public function getCircleCIBuildIdentifierType() {
	return 'revision';
	}

	public function getCircleCIBuildIdentifier() {
	return $this->getCommitIdentifier();
	}


	/* -( HarbormasterBuildkiteBuildableInterface )---------------------------- */


	public function getBuildkiteBranch() {
	$viewer = PhabricatorUser::getOmnipotentUser();
	$repository = $this->getRepository();

	$branches = DiffusionQuery::callConduitWithDiffusionRequest(
	$viewer,
	DiffusionRequest::newFromDictionary(
	array(
	'repository' => $repository,
	'user' => $viewer,
	)),
	'diffusion.branchquery',
	array(
	'contains' => $this->getCommitIdentifier(),
	'repository' => $repository->getPHID(),
	));

	if (!$branches) {
	throw new Exception(
	pht(
	'Commit "%s" is not an ancestor of any branch head, so it can not '.
	'be built with Buildkite.',
	$this->getCommitIdentifier()));
	}

	$branch = head($branches);

	return 'refs/heads/'.$branch['shortName'];
	}

	public function getBuildkiteCommit() {
	return $this->getCommitIdentifier();
	}


	/* -( PhabricatorCustomFieldInterface )------------------------------------ */


	public function getCustomFieldSpecificationForRole($role) {
	return PhabricatorEnv::getEnvConfig('diffusion.fields');
	}

	public function getCustomFieldBaseClass() {
	return 'PhabricatorCommitCustomField';
	}

	public function getCustomFields() {
	return $this->assertAttached($this->customFields);
	}

	public function attachCustomFields(PhabricatorCustomFieldAttachment $fields) {
	$this->customFields = $fields;
	return $this;
	}


	/* -( PhabricatorSubscribableInterface )----------------------------------- */


	public function isAutomaticallySubscribed($phid) {

	// TODO: This should also list auditors, but handling that is a bit messy
	// right now because we are not guaranteed to have the data. (It should not
	// include resigned auditors.)

	return ($phid == $this->getAuthorPHID());
	}


	/* -( PhabricatorApplicationTransactionInterface )------------------------- */


	public function getApplicationTransactionEditor() {
	return new PhabricatorAuditEditor();
	}

	public function getApplicationTransactionObject() {
	return $this;
	}

	public function getApplicationTransactionTemplate() {
	return new PhabricatorAuditTransaction();
	}

	public function willRenderTimeline(
	PhabricatorApplicationTransactionView $timeline,
	AphrontRequest $request) {

	$xactions = $timeline->getTransactions();

	$path_ids = array();
	foreach ($xactions as $xaction) {
	if ($xaction->hasComment()) {
	$path_id = $xaction->getComment()->getPathID();
	if ($path_id) {
	$path_ids[] = $path_id;
	}
	}
	}

	$path_map = array();
	if ($path_ids) {
	$path_map = id(new DiffusionPathQuery())
	->withPathIDs($path_ids)
	->execute();
	$path_map = ipull($path_map, 'path', 'id');
	}

	return $timeline->setPathMap($path_map);
	}

	/* -( PhabricatorFulltextInterface )--------------------------------------- */


	public function newFulltextEngine() {
	return new DiffusionCommitFulltextEngine();
	}


	/* -( PhabricatorFerretInterface )----------------------------------------- */


	public function newFerretEngine() {
	return new DiffusionCommitFerretEngine();
	}


	/* -( PhabricatorConduitResultInterface )---------------------------------- */

	public function getFieldSpecificationsForConduit() {
	return array(
	id(new PhabricatorConduitSearchFieldSpecification())
	->setKey('identifier')
	->setType('string')
	->setDescription(pht('The commit identifier.')),
	+ id(new PhabricatorConduitSearchFieldSpecification())
	+ ->setKey('repositoryPHID')
	+ ->setType('phid')
	+ ->setDescription(pht('The repository this commit belongs to.')),
	+ id(new PhabricatorConduitSearchFieldSpecification())
	+ ->setKey('author')
	+ ->setType('map<string, wild>')
	+ ->setDescription(pht('Information about the commit author.')),
	+ id(new PhabricatorConduitSearchFieldSpecification())
	+ ->setKey('committer')
	+ ->setType('map<string, wild>')
	+ ->setDescription(pht('Information about the committer.')),
	+ id(new PhabricatorConduitSearchFieldSpecification())
	+ ->setKey('isImported')
	+ ->setType('bool')
	+ ->setDescription(pht('True if the commit is fully imported.')),
	+ id(new PhabricatorConduitSearchFieldSpecification())
	+ ->setKey('isUnreachable')
	+ ->setType('bool')
	+ ->setDescription(
	+ pht(
	+ 'True if the commit is not the ancestor of any tag, branch, or '.
	+ 'ref.')),
	+ id(new PhabricatorConduitSearchFieldSpecification())
	+ ->setKey('auditStatus')
	+ ->setType('map<string, wild>')
	+ ->setDescription(pht('Information about the current audit status.')),
	+ id(new PhabricatorConduitSearchFieldSpecification())
	+ ->setKey('message')
	+ ->setType('string')
	+ ->setDescription(pht('The commit message.')),
	);
	}

	public function getFieldValuesForConduit() {
	+ $data = $this->getCommitData();

	- // NOTE: This data should be similar to the information returned about
	- // commmits by "differential.diff.search" with the "commits" attachment.
	+ $author_identity = $this->getAuthorIdentity();
	+ if ($author_identity) {
	+ $author_name = $author_identity->getIdentityDisplayName();
	+ $author_email = $author_identity->getIdentityEmailAddress();
	+ $author_raw = $author_identity->getIdentityName();
	+ $author_identity_phid = $author_identity->getPHID();
	+ $author_user_phid = $author_identity->getCurrentEffectiveUserPHID();
	+ } else {
	+ $author_name = null;
	+ $author_email = null;
	+ $author_raw = null;
	+ $author_identity_phid = null;
	+ $author_user_phid = null;
	+ }
	+
	+ $committer_identity = $this->getCommitterIdentity();
	+ if ($committer_identity) {
	+ $committer_name = $committer_identity->getIdentityDisplayName();
	+ $committer_email = $committer_identity->getIdentityEmailAddress();
	+ $committer_raw = $committer_identity->getIdentityName();
	+ $committer_identity_phid = $committer_identity->getPHID();
	+ $committer_user_phid = $committer_identity->getCurrentEffectiveUserPHID();
	+ } else {
	+ $committer_name = null;
	+ $committer_email = null;
	+ $committer_raw = null;
	+ $committer_identity_phid = null;
	+ $committer_user_phid = null;
	+ }
	+
	+ $author_epoch = $data->getCommitDetail('authorEpoch');
	+ if ($author_epoch) {
	+ $author_epoch = (int)$author_epoch;
	+ } else {
	+ $author_epoch = null;
	+ }
	+
	+ $audit_status = $this->getAuditStatusObject();

	return array(
	'identifier' => $this->getCommitIdentifier(),
	+ 'repositoryPHID' => $this->getRepository()->getPHID(),
	+ 'author' => array(
	+ 'name' => $author_name,
	+ 'email' => $author_email,
	+ 'raw' => $author_raw,
	+ 'epoch' => $author_epoch,
	+ 'identityPHID' => $author_identity_phid,
	+ 'userPHID' => $author_user_phid,
	+ ),
	+ 'committer' => array(
	+ 'name' => $committer_name,
	+ 'email' => $committer_email,
	+ 'raw' => $committer_raw,
	+ 'epoch' => (int)$this->getEpoch(),
	+ 'identityPHID' => $committer_identity_phid,
	+ 'userPHID' => $committer_user_phid,
	+ ),
	+ 'isUnreachable' => (bool)$this->isUnreachable(),
	+ 'isImported' => (bool)$this->isImported(),
	+ 'auditStatus' => array(
	+ 'value' => $audit_status->getKey(),
	+ 'name' => $audit_status->getName(),
	+ 'closed' => (bool)$audit_status->getIsClosed(),
	+ 'color.ansi' => $audit_status->getAnsiColor(),
	+ ),
	+ 'message' => $data->getCommitMessage(),
	);
	}

	public function getConduitSearchAttachments() {
	return array();
	}


	/* -( PhabricatorDraftInterface )------------------------------------------ */

	public function newDraftEngine() {
	return new DiffusionCommitDraftEngine();
	}

	public function getHasDraft(PhabricatorUser $viewer) {
	return $this->assertAttachedKey($this->drafts, $viewer->getCacheFragment());
	}

	public function attachHasDraft(PhabricatorUser $viewer, $has_draft) {
	$this->drafts[$viewer->getCacheFragment()] = $has_draft;
	return $this;
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Mon, Jul 28, 2:34 PM (1 w, 2 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 186970
Default Alt Text: (42 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions