No OneTemporary
Actions

Size

35 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/applications/diffusion/conduit/ConduitAPI_diffusion_tagsquery_Method.php b/src/applications/diffusion/conduit/ConduitAPI_diffusion_tagsquery_Method.php
	index da40a3b4a8..1ffe98433a 100644
	--- a/src/applications/diffusion/conduit/ConduitAPI_diffusion_tagsquery_Method.php
	+++ b/src/applications/diffusion/conduit/ConduitAPI_diffusion_tagsquery_Method.php
	@@ -1,111 +1,154 @@
	<?php

	/**
	* @group conduit
	*/
	final class ConduitAPI_diffusion_tagsquery_Method
	extends ConduitAPI_diffusion_abstractquery_Method {

	public function getMethodDescription() {
	- return
	- 'Find tags for a given commit or list tags in the repository.';
	+ return pht('Retrieve information about tags in a repository.');
	}

	public function defineReturnType() {
	return 'array';
	}

	protected function defineCustomParamTypes() {
	return array(
	+ 'names' => 'optional list<string>',
	'commit' => 'optional string',
	+ 'needMessages' => 'optional bool',
	'offset' => 'optional int',
	'limit' => 'optional int',
	);
	}

	protected function getGitResult(ConduitAPIRequest $request) {
	$drequest = $this->getDiffusionRequest();
	$repository = $drequest->getRepository();
	$commit = $drequest->getRawCommit();

	- $offset = $request->getValue('offset');
	- $limit = $request->getValue('limit');
	-
	- if (!$commit) {
	- return $this->loadGitTagList($offset, $limit);
	+ $commit_filter = null;
	+ if ($commit) {
	+ $commit_filter = $this->loadTagNamesForCommit($commit);
	}

	- list($err, $stdout) = $repository->execLocalCommand(
	- 'tag -l --contains %s',
	- $commit);
	+ $name_filter = $request->getValue('names', null);

	- if ($err) {
	- // Git exits with an error code if the commit is bogus.
	- return array();
	+ $all_tags = $this->loadGitTagList();
	+ $all_tags = mpull($all_tags, null, 'getName');
	+ if ($name_filter !== null) {
	+ $all_tags = array_intersect_key($all_tags, array_fuse($name_filter));
	}
	-
	- $stdout = trim($stdout);
	- if (!strlen($stdout)) {
	- return array();
	- }
	-
	- $tag_names = explode("\n", $stdout);
	- $tag_names = array_fill_keys($tag_names, true);
	-
	- $tags = $this->loadGitTagList($offset = 0, $limit = 0, $serialize = false);
	-
	- $result = array();
	- foreach ($tags as $tag) {
	- if (isset($tag_names[$tag->getName()])) {
	- $result[] = $tag->toDictionary();
	- }
	+ if ($commit_filter !== null) {
	+ $all_tags = array_intersect_key($all_tags, array_fuse($commit_filter));
	}
	+ $tags = array_values($all_tags);

	+ $offset = $request->getValue('offset');
	+ $limit = $request->getValue('limit');
	if ($offset) {
	- $result = array_slice($result, $offset);
	+ $tags = array_slice($tags, $offset);
	}
	+
	if ($limit) {
	- $result = array_slice($result, 0, $limit);
	+ $tags = array_slice($tags, 0, $limit);
	+ }
	+
	+ if ($request->getValue('needMessages')) {
	+ $this->loadMessagesForTags($all_tags);
	}

	- return $result;
	+ return mpull($tags, 'toDictionary');
	}

	- private function loadGitTagList($offset, $limit, $serialize=true) {
	+ private function loadGitTagList() {
	$drequest = $this->getDiffusionRequest();
	$repository = $drequest->getRepository();

	$refs = id(new DiffusionLowLevelGitRefQuery())
	->setRepository($repository)
	->withIsTag(true)
	->execute();

	$tags = array();
	foreach ($refs as $ref) {
	$fields = $ref->getRawFields();
	$tag = id(new DiffusionRepositoryTag())
	->setAuthor($fields['author'])
	->setEpoch($fields['epoch'])
	->setCommitIdentifier($ref->getCommitIdentifier())
	->setName($ref->getShortName())
	->setDescription($fields['subject'])
	->setType('git/'.$fields['objecttype']);

	$tags[] = $tag;
	}

	- if ($offset) {
	- $tags = array_slice($tags, $offset);
	+ return $tags;
	+ }
	+
	+ private function loadTagNamesForCommit($commit) {
	+ $drequest = $this->getDiffusionRequest();
	+ $repository = $drequest->getRepository();
	+
	+ list($err, $stdout) = $repository->execLocalCommand(
	+ 'tag -l --contains %s',
	+ $commit);
	+
	+ if ($err) {
	+ // Git exits with an error code if the commit is bogus.
	+ return array();
	}

	- if ($limit) {
	- $tags = array_slice($tags, 0, $limit);
	+ $stdout = rtrim($stdout, "\n");
	+ if (!strlen($stdout)) {
	+ return array();
	}

	- if ($serialize) {
	- $tags = mpull($tags, 'toDictionary');
	+ $tag_names = explode("\n", $stdout);
	+ $tag_names = array_fill_keys($tag_names, true);
	+
	+ return $tag_names;
	+ }
	+
	+ private function loadMessagesForTags(array $tags) {
	+ assert_instances_of($tags, 'DiffusionRepositoryTag');
	+
	+ $drequest = $this->getDiffusionRequest();
	+ $repository = $drequest->getRepository();
	+
	+ $futures = array();
	+ foreach ($tags as $key => $tag) {
	+ $futures[$key] = $repository->getLocalCommandFuture(
	+ 'cat-file tag %s',
	+ $tag->getName());
	}
	+
	+ Futures($futures)->resolveAll();
	+
	+ foreach ($tags as $key => $tag) {
	+ $future = $futures[$key];
	+ list($err, $stdout) = $future->resolve();
	+
	+ $message = null;
	+ if ($err) {
	+ // Not all tags are actually "tag" objects: a "tag" object is only
	+ // created if you provide a message or sign the tag. Tags created with
	+ // `git tag x [commit]` are "lightweight tags" and `git cat-file tag`
	+ // will fail on them. This is fine: they don't have messages.
	+ } else {
	+ $parts = explode("\n\n", $stdout, 2);
	+ if (count($parts) == 2) {
	+ $message = last($parts);
	+ }
	+ }
	+
	+ $tag->attachMessage($message);
	+ }
	+
	return $tags;
	}

	}
	diff --git a/src/applications/diffusion/controller/DiffusionBrowseController.php b/src/applications/diffusion/controller/DiffusionBrowseController.php
	index 84b8b9f2dd..33fc2e2d15 100644
	--- a/src/applications/diffusion/controller/DiffusionBrowseController.php
	+++ b/src/applications/diffusion/controller/DiffusionBrowseController.php
	@@ -1,203 +1,215 @@
	<?php

	abstract class DiffusionBrowseController extends DiffusionController {

	public function shouldAllowPublic() {
	return true;
	}

	protected function renderSearchForm($collapsed) {
	$drequest = $this->getDiffusionRequest();
	$form = id(new AphrontFormView())
	->setUser($this->getRequest()->getUser())
	->setMethod('GET');

	switch ($drequest->getRepository()->getVersionControlSystem()) {
	case PhabricatorRepositoryType::REPOSITORY_TYPE_SVN:
	$form->appendChild(pht('Search is not available in Subversion.'));
	break;

	default:
	$form
	->appendChild(
	id(new AphrontFormTextControl())
	->setLabel(pht('Search Here'))
	->setName('grep')
	->setValue($this->getRequest()->getStr('grep'))
	->setCaption(pht('Enter a regular expression.')))
	->appendChild(
	id(new AphrontFormSubmitControl())
	->setValue(pht('Search File Content')));
	break;
	}

	$filter = new AphrontListFilterView();
	$filter->appendChild($form);

	if ($collapsed) {
	$filter->setCollapsed(
	pht('Show Search'),
	pht('Hide Search'),
	pht('Search for file content in this directory.'),
	'#');
	}

	return $filter;
	}

	protected function markupText($text) {
	$engine = PhabricatorMarkupEngine::newDiffusionMarkupEngine();
	$engine->setConfig('viewer', $this->getRequest()->getUser());
	$text = $engine->markupText($text);

	$text = phutil_tag(
	'div',
	array(
	'class' => 'phabricator-remarkup',
	),
	$text);

	return $text;
	}

	protected function buildHeaderView(DiffusionRequest $drequest) {
	$viewer = $this->getRequest()->getUser();

	$header = id(new PHUIHeaderView())
	->setUser($viewer)
	->setHeader($this->renderPathLinks($drequest, $mode = 'browse'))
	->setPolicyObject($drequest->getRepository());

	return $header;
	}

	protected function buildActionView(DiffusionRequest $drequest) {
	$viewer = $this->getRequest()->getUser();

	$view = id(new PhabricatorActionListView())
	->setUser($viewer);

	$history_uri = $drequest->generateURI(
	array(
	'action' => 'history',
	));

	$view->addAction(
	id(new PhabricatorActionView())
	->setName(pht('View History'))
	->setHref($history_uri)
	->setIcon('history'));

	$behind_head = $drequest->getRawCommit();
	$head_uri = $drequest->generateURI(
	array(
	'commit' => '',
	'action' => 'browse',
	));
	$view->addAction(
	id(new PhabricatorActionView())
	->setName(pht('Jump to HEAD'))
	->setHref($head_uri)
	->setIcon('home')
	->setDisabled(!$behind_head));

	// TODO: Ideally, this should live in Owners and be event-triggered, but
	// there's no reasonable object for it to react to right now.

	$owners_uri = id(new PhutilURI('/owners/view/search/'))
	->setQueryParams(
	array(
	'repository' => $drequest->getCallsign(),
	'path' => '/'.$drequest->getPath(),
	));

	$view->addAction(
	id(new PhabricatorActionView())
	->setName(pht('Find Owners'))
	->setHref((string)$owners_uri)
	->setIcon('preview'));

	return $view;
	}

	protected function buildPropertyView(
	DiffusionRequest $drequest,
	PhabricatorActionListView $actions) {

	$viewer = $this->getRequest()->getUser();

	$view = id(new PHUIPropertyListView())
	->setUser($viewer)
	->setActionList($actions);

	$stable_commit = $drequest->getStableCommitName();
	$callsign = $drequest->getRepository()->getCallsign();

	$view->addProperty(
	pht('Commit'),
	phutil_tag(
	'a',
	array(
	'href' => $drequest->generateURI(
	array(
	'action' => 'commit',
	'commit' => $stable_commit,
	)),
	),
	$drequest->getRepository()->formatCommitName($stable_commit)));

	- if ($drequest->getTagContent()) {
	- $view->addProperty(
	- pht('Tag'),
	- $drequest->getSymbolicCommit());
	+ if ($drequest->getCommitType() == 'tag') {
	+ $symbolic = $drequest->getSymbolicCommit();
	+ $view->addProperty(pht('Tag'), $symbolic);

	- $view->addSectionHeader(pht('Tag Content'));
	- $view->addTextContent($this->markupText($drequest->getTagContent()));
	+ $tags = $this->callConduitWithDiffusionRequest(
	+ 'diffusion.tagsquery',
	+ array(
	+ 'names' => array($symbolic),
	+ 'needMessages' => true,
	+ ));
	+ $tags = DiffusionRepositoryTag::newFromConduit($tags);
	+
	+ $tags = mpull($tags, null, 'getName');
	+ $tag = idx($tags, $symbolic);
	+
	+ if ($tag && strlen($tag->getMessage())) {
	+ $view->addSectionHeader(pht('Tag Content'));
	+ $view->addTextContent($this->markupText($tag->getMessage()));
	+ }
	}

	return $view;
	}

	protected function buildOpenRevisions() {
	$user = $this->getRequest()->getUser();

	$drequest = $this->getDiffusionRequest();
	$repository = $drequest->getRepository();
	$path = $drequest->getPath();

	$path_map = id(new DiffusionPathIDQuery(array($path)))->loadPathIDs();
	$path_id = idx($path_map, $path);
	if (!$path_id) {
	return null;
	}

	$revisions = id(new DifferentialRevisionQuery())
	->setViewer($user)
	->withPath($repository->getID(), $path_id)
	->withStatus(DifferentialRevisionQuery::STATUS_OPEN)
	->setOrder(DifferentialRevisionQuery::ORDER_PATH_MODIFIED)
	->setLimit(10)
	->needRelationships(true)
	->execute();

	if (!$revisions) {
	return null;
	}

	$view = id(new DifferentialRevisionListView())
	->setRevisions($revisions)
	->setFields(DifferentialRevisionListView::getDefaultFields($user))
	->setUser($user)
	->loadAssets();

	$phids = $view->getRequiredHandlePHIDs();
	$handles = $this->loadViewerHandles($phids);
	$view->setHandles($handles);

	return id(new PHUIObjectBoxView())
	->setHeaderText(pht('Pending Differential Revisions'))
	->appendChild($view);

	}

	}
	diff --git a/src/applications/diffusion/data/DiffusionRepositoryTag.php b/src/applications/diffusion/data/DiffusionRepositoryTag.php
	index 47e60eedd3..a8e3696b46 100644
	--- a/src/applications/diffusion/data/DiffusionRepositoryTag.php
	+++ b/src/applications/diffusion/data/DiffusionRepositoryTag.php
	@@ -1,90 +1,117 @@
	<?php

	final class DiffusionRepositoryTag {

	private $author;
	private $epoch;
	private $commitIdentifier;
	private $name;
	private $description;
	private $type;

	+ private $message = false;
	+
	public function setType($type) {
	$this->type = $type;
	return $this;
	}

	public function getType() {
	return $this->type;
	}

	public function setDescription($description) {
	$this->description = $description;
	return $this;
	}

	public function getDescription() {
	return $this->description;
	}

	public function setName($name) {
	$this->name = $name;
	return $this;
	}

	public function getName() {
	return $this->name;
	}

	public function setCommitIdentifier($commit_identifier) {
	$this->commitIdentifier = $commit_identifier;
	return $this;
	}

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

	public function setEpoch($epoch) {
	$this->epoch = $epoch;
	return $this;
	}

	public function getEpoch() {
	return $this->epoch;
	}

	public function setAuthor($author) {
	$this->author = $author;
	return $this;
	}

	public function getAuthor() {
	return $this->author;
	}

	+ public function attachMessage($message) {
	+ $this->message = $message;
	+ return $this;
	+ }
	+
	+ public function getMessage() {
	+ if ($this->message === false) {
	+ throw new Exception("Message is not attached!");
	+ }
	+ return $this->message;
	+ }
	+
	public function toDictionary() {
	- return array(
	+ $dict = array(
	'author' => $this->getAuthor(),
	'epoch' => $this->getEpoch(),
	'commitIdentifier' => $this->getCommitIdentifier(),
	'name' => $this->getName(),
	'description' => $this->getDescription(),
	- 'type' => $this->getType());
	+ 'type' => $this->getType(),
	+ );
	+
	+ if ($this->message !== false) {
	+ $dict['message'] = $this->message;
	+ }
	+
	+ return $dict;
	}

	public static function newFromConduit(array $dicts) {
	$tags = array();
	foreach ($dicts as $dict) {
	- $tags[] = id(new DiffusionRepositoryTag())
	+ $tag = id(new DiffusionRepositoryTag())
	->setAuthor($dict['author'])
	->setEpoch($dict['epoch'])
	->setCommitIdentifier($dict['commitIdentifier'])
	->setName($dict['name'])
	->setDescription($dict['description'])
	->setType($dict['type']);
	+
	+ if (array_key_exists('message', $dict)) {
	+ $tag->attachMessage($dict['message']);
	+ }
	+
	+ $tags[] = $tag;
	}
	return $tags;
	}

	}
	diff --git a/src/applications/diffusion/request/DiffusionRequest.php b/src/applications/diffusion/request/DiffusionRequest.php
	index d61c5b63bf..035ed245c0 100644
	--- a/src/applications/diffusion/request/DiffusionRequest.php
	+++ b/src/applications/diffusion/request/DiffusionRequest.php
	@@ -1,668 +1,672 @@
	<?php

	/**
	* Contains logic to parse Diffusion requests, which have a complicated URI
	* structure.
	*
	*
	* @task new Creating Requests
	* @task uri Managing Diffusion URIs
	*
	* @group diffusion
	*/
	abstract class DiffusionRequest {

	protected $callsign;
	protected $path;
	protected $line;
	protected $symbolicCommit;
	protected $commit;
	protected $commitType = 'commit';
	protected $tagContent;
	protected $branch;
	protected $lint;

	protected $repository;
	protected $repositoryCommit;
	protected $repositoryCommitData;
	protected $stableCommitName;
	protected $arcanistProjects;

	private $initFromConduit = true;
	private $user;

	abstract protected function getSupportsBranches();
	abstract protected function didInitialize();


	/* -( Creating Requests )-------------------------------------------------- */


	/**
	* Create a new synthetic request from a parameter dictionary. If you need
	* a @{class:DiffusionRequest} object in order to issue a DiffusionQuery, you
	* can use this method to build one.
	*
	* Parameters are:
	*
	* - `callsign` Repository callsign. Provide this or `repository`.
	* - `user` Viewing user. Required if `callsign` is provided.
	* - `repository` Repository object. Provide this or `callsign`.
	* - `branch` Optional, branch name.
	* - `path` Optional, file path.
	* - `commit` Optional, commit identifier.
	* - `line` Optional, line range.
	*
	* @param map See documentation.
	* @return DiffusionRequest New request object.
	* @task new
	*/
	final public static function newFromDictionary(array $data) {
	if (isset($data['repository']) && isset($data['callsign'])) {
	throw new Exception(
	"Specify 'repository' or 'callsign', but not both.");
	} else if (!isset($data['repository']) && !isset($data['callsign'])) {
	throw new Exception(
	"One of 'repository' and 'callsign' is required.");
	} else if (isset($data['callsign']) && empty($data['user'])) {
	throw new Exception(
	"Parameter 'user' is required if 'callsign' is provided.");
	}

	if (isset($data['repository'])) {
	$object = self::newFromRepository($data['repository']);
	} else {
	$object = self::newFromCallsign($data['callsign'], $data['user']);
	}

	$object->initializeFromDictionary($data);

	return $object;
	}


	/**
	* Create a new request from an Aphront request dictionary. This is an
	* internal method that you generally should not call directly; instead,
	* call @{method:newFromDictionary}.
	*
	* @param map Map of Aphront request data.
	* @return DiffusionRequest New request object.
	* @task new
	*/
	final public static function newFromAphrontRequestDictionary(
	array $data,
	AphrontRequest $request) {

	$callsign = phutil_unescape_uri_path_component(idx($data, 'callsign'));
	$object = self::newFromCallsign($callsign, $request->getUser());

	$use_branches = $object->getSupportsBranches();
	$parsed = self::parseRequestBlob(idx($data, 'dblob'), $use_branches);

	$object->setUser($request->getUser());
	$object->initializeFromDictionary($parsed);
	$object->lint = $request->getStr('lint');
	return $object;
	}


	/**
	* Internal.
	*
	* @task new
	*/
	final private function __construct() {
	// <private>
	}


	/**
	* Internal. Use @{method:newFromDictionary}, not this method.
	*
	* @param string Repository callsign.
	* @param PhabricatorUser Viewing user.
	* @return DiffusionRequest New request object.
	* @task new
	*/
	final private static function newFromCallsign(
	$callsign,
	PhabricatorUser $viewer) {

	$repository = id(new PhabricatorRepositoryQuery())
	->setViewer($viewer)
	->withCallsigns(array($callsign))
	->executeOne();
	if (!$repository) {
	throw new Exception("No such repository '{$callsign}'.");
	}

	return self::newFromRepository($repository);
	}


	/**
	* Internal. Use @{method:newFromDictionary}, not this method.
	*
	* @param PhabricatorRepository Repository object.
	* @return DiffusionRequest New request object.
	* @task new
	*/
	final private static function newFromRepository(
	PhabricatorRepository $repository) {

	$map = array(
	PhabricatorRepositoryType::REPOSITORY_TYPE_GIT => 'DiffusionGitRequest',
	PhabricatorRepositoryType::REPOSITORY_TYPE_SVN => 'DiffusionSvnRequest',
	PhabricatorRepositoryType::REPOSITORY_TYPE_MERCURIAL =>
	'DiffusionMercurialRequest',
	);

	$class = idx($map, $repository->getVersionControlSystem());

	if (!$class) {
	throw new Exception("Unknown version control system!");
	}

	$object = new $class();

	$object->repository = $repository;
	$object->callsign = $repository->getCallsign();

	return $object;
	}


	/**
	* Internal. Use @{method:newFromDictionary}, not this method.
	*
	* @param map Map of parsed data.
	* @return void
	* @task new
	*/
	final private function initializeFromDictionary(array $data) {
	$this->path = idx($data, 'path');
	$this->symbolicCommit = idx($data, 'commit');
	$this->commit = idx($data, 'commit');
	$this->line = idx($data, 'line');
	$this->initFromConduit = idx($data, 'initFromConduit', true);

	if ($this->getSupportsBranches()) {
	$this->branch = idx($data, 'branch');
	}

	if (!$this->getUser()) {
	$user = idx($data, 'user');
	if (!$user) {
	throw new Exception(
	'You must provide a PhabricatorUser in the dictionary!');
	}
	$this->setUser($user);
	}

	$this->didInitialize();
	}

	final protected function shouldInitFromConduit() {
	return $this->initFromConduit;
	}

	final public function setUser(PhabricatorUser $user) {
	$this->user = $user;
	return $this;
	}
	final public function getUser() {
	return $this->user;
	}

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

	public function getCallsign() {
	return $this->callsign;
	}

	public function setPath($path) {
	$this->path = $path;
	return $this;
	}

	public function getPath() {
	return $this->path;
	}

	public function getLine() {
	return $this->line;
	}

	public function getCommit() {
	return $this->commit;
	}

	public function getSymbolicCommit() {
	return $this->symbolicCommit;
	}

	public function getBranch() {
	return $this->branch;
	}

	public function getLint() {
	return $this->lint;
	}

	protected function getArcanistBranch() {
	return $this->getBranch();
	}

	public function loadBranch() {
	return id(new PhabricatorRepositoryBranch())->loadOneWhere(
	'repositoryID = %d AND name = %s',
	$this->getRepository()->getID(),
	$this->getArcanistBranch());
	}

	public function getTagContent() {
	return $this->tagContent;
	}

	public function loadCommit() {
	if (empty($this->repositoryCommit)) {
	$repository = $this->getRepository();

	// TODO: (T603) This should be a real query, but we need to sort out
	// the viewer.
	$commit = id(new PhabricatorRepositoryCommit())->loadOneWhere(
	'repositoryID = %d AND commitIdentifier = %s',
	$repository->getID(),
	$this->getCommit());
	if ($commit) {
	$commit->attachRepository($repository);
	}
	$this->repositoryCommit = $commit;
	}
	return $this->repositoryCommit;
	}

	public function loadArcanistProjects() {
	if (empty($this->arcanistProjects)) {
	$projects = id(new PhabricatorRepositoryArcanistProject())->loadAllWhere(
	'repositoryID = %d',
	$this->getRepository()->getID());
	$this->arcanistProjects = $projects;
	}
	return $this->arcanistProjects;
	}

	public function loadCommitData() {
	if (empty($this->repositoryCommitData)) {
	$commit = $this->loadCommit();
	$data = id(new PhabricatorRepositoryCommitData())->loadOneWhere(
	'commitID = %d',
	$commit->getID());
	if (!$data) {
	$data = new PhabricatorRepositoryCommitData();
	$data->setCommitMessage(
	'(This commit has not been fully parsed yet.)');
	}
	$this->repositoryCommitData = $data;
	}
	return $this->repositoryCommitData;
	}

	/**
	* Retrieve a stable, permanent commit name. This returns a non-symbolic
	* identifier for the current commit: e.g., a specific commit hash in git
	* (NOT a symbolic name like "origin/master") or a specific revision number
	* in SVN (NOT a symbolic name like "HEAD").
	*
	* @return string Stable commit name, like a git hash or SVN revision. Not
	* a symbolic commit reference.
	*/
	public function getStableCommitName() {
	if (!$this->stableCommitName) {
	$this->queryStableCommitName();
	}
	return $this->stableCommitName;
	}

	final public function getRawCommit() {
	return $this->commit;
	}

	public function setCommit($commit) {
	$this->commit = $commit;
	return $this;
	}

	/* -( Managing Diffusion URIs )-------------------------------------------- */


	/**
	* Generate a Diffusion URI using this request to provide defaults. See
	* @{method:generateDiffusionURI} for details. This method is the same, but
	* preserves the request parameters if they are not overridden.
	*
	* @param map See @{method:generateDiffusionURI}.
	* @return PhutilURI Generated URI.
	* @task uri
	*/
	public function generateURI(array $params) {
	if (empty($params['stable'])) {
	$default_commit = $this->getRawCommit();
	} else {
	$default_commit = $this->getStableCommitName();
	}

	$defaults = array(
	'callsign' => $this->getCallsign(),
	'path' => $this->getPath(),
	'branch' => $this->getBranch(),
	'commit' => $default_commit,
	'lint' => idx($params, 'lint', $this->getLint()),
	);
	foreach ($defaults as $key => $val) {
	if (!isset($params[$key])) { // Overwrite NULL.
	$params[$key] = $val;
	}
	}
	return self::generateDiffusionURI($params);
	}


	/**
	* Generate a Diffusion URI from a parameter map. Applies the correct encoding
	* and formatting to the URI. Parameters are:
	*
	* - `action` One of `history`, `browse`, `change`, `lastmodified`,
	* `branch`, `tags`, `branches`, or `revision-ref`. The action specified
	* by the URI.
	* - `callsign` Repository callsign.
	* - `branch` Optional if action is not `branch`, branch name.
	* - `path` Optional, path to file.
	* - `commit` Optional, commit identifier.
	* - `line` Optional, line range.
	* - `lint` Optional, lint code.
	* - `params` Optional, query parameters.
	*
	* The function generates the specified URI and returns it.
	*
	* @param map See documentation.
	* @return PhutilURI Generated URI.
	* @task uri
	*/
	public static function generateDiffusionURI(array $params) {
	$action = idx($params, 'action');

	$callsign = idx($params, 'callsign');
	$path = idx($params, 'path');
	$branch = idx($params, 'branch');
	$commit = idx($params, 'commit');
	$line = idx($params, 'line');

	if (strlen($callsign)) {
	$callsign = phutil_escape_uri_path_component($callsign).'/';
	}

	if (strlen($branch)) {
	$branch = phutil_escape_uri_path_component($branch).'/';
	}

	if (strlen($path)) {
	$path = ltrim($path, '/');
	$path = str_replace(array(';', '$'), array(';;', '$$'), $path);
	$path = phutil_escape_uri($path);
	}

	$path = "{$branch}{$path}";

	if (strlen($commit)) {
	$commit = str_replace('$', '$$', $commit);
	$commit = ';'.phutil_escape_uri($commit);
	}

	if (strlen($line)) {
	$line = '$'.phutil_escape_uri($line);
	}

	$req_callsign = false;
	$req_branch = false;
	$req_commit = false;

	switch ($action) {
	case 'history':
	case 'browse':
	case 'change':
	case 'lastmodified':
	case 'tags':
	case 'branches':
	case 'lint':
	$req_callsign = true;
	break;
	case 'branch':
	$req_callsign = true;
	$req_branch = true;
	break;
	case 'commit':
	$req_callsign = true;
	$req_commit = true;
	break;
	}

	if ($req_callsign && !strlen($callsign)) {
	throw new Exception(
	"Diffusion URI action '{$action}' requires callsign!");
	}

	if ($req_commit && !strlen($commit)) {
	throw new Exception(
	"Diffusion URI action '{$action}' requires commit!");
	}

	switch ($action) {
	case 'change':
	case 'history':
	case 'browse':
	case 'lastmodified':
	case 'tags':
	case 'branches':
	case 'lint':
	$uri = "/diffusion/{$callsign}{$action}/{$path}{$commit}{$line}";
	break;
	case 'branch':
	if (strlen($path)) {
	$uri = "/diffusion/{$callsign}repository/{$path}";
	} else {
	$uri = "/diffusion/{$callsign}";
	}
	break;
	case 'external':
	$commit = ltrim($commit, ';');
	$uri = "/diffusion/external/{$commit}/";
	break;
	case 'rendering-ref':
	// This isn't a real URI per se, it's passed as a query parameter to
	// the ajax changeset stuff but then we parse it back out as though
	// it came from a URI.
	$uri = rawurldecode("{$path}{$commit}");
	break;
	case 'commit':
	$commit = ltrim($commit, ';');
	$callsign = rtrim($callsign, '/');
	$uri = "/r{$callsign}{$commit}";
	break;
	default:
	throw new Exception("Unknown Diffusion URI action '{$action}'!");
	}

	if ($action == 'rendering-ref') {
	return $uri;
	}

	$uri = new PhutilURI($uri);

	if (isset($params['lint'])) {
	$params['params'] = idx($params, 'params', array()) + array(
	'lint' => $params['lint'],
	);
	}

	if (idx($params, 'params')) {
	$uri->setQueryParams($params['params']);
	}

	return $uri;
	}


	/**
	* Internal. Public only for unit tests.
	*
	* Parse the request URI into components.
	*
	* @param string URI blob.
	* @param bool True if this VCS supports branches.
	* @return map Parsed URI.
	*
	* @task uri
	*/
	public static function parseRequestBlob($blob, $supports_branches) {
	$result = array(
	'branch' => null,
	'path' => null,
	'commit' => null,
	'line' => null,
	);

	$matches = null;

	if ($supports_branches) {
	// Consume the front part of the URI, up to the first "/". This is the
	// path-component encoded branch name.
	if (preg_match('@^([^/]+)/@', $blob, $matches)) {
	$result['branch'] = phutil_unescape_uri_path_component($matches[1]);
	$blob = substr($blob, strlen($matches[1]) + 1);
	}
	}

	// Consume the back part of the URI, up to the first "$". Use a negative
	// lookbehind to prevent matching '$$'. We double the '$' symbol when
	// encoding so that files with names like "money/$100" will survive.
	$pattern = '@(?:(?:^\|[^$])(?:[$][$])*)[$]([\d-,]+)$@';
	if (preg_match($pattern, $blob, $matches)) {
	$result['line'] = $matches[1];
	$blob = substr($blob, 0, -(strlen($matches[1]) + 1));
	}

	// We've consumed the line number if it exists, so unescape "$" in the
	// rest of the string.
	$blob = str_replace('$$', '$', $blob);

	// Consume the commit name, stopping on ';;'. We allow any character to
	// appear in commits names, as they can sometimes be symbolic names (like
	// tag names or refs).
	if (preg_match('@(?:(?:^\|[^;])(?:;;));([^;].)$@', $blob, $matches)) {
	$result['commit'] = $matches[1];
	$blob = substr($blob, 0, -(strlen($matches[1]) + 1));
	}

	// We've consumed the commit if it exists, so unescape ";" in the rest
	// of the string.
	$blob = str_replace(';;', ';', $blob);

	if (strlen($blob)) {
	$result['path'] = $blob;
	}

	$parts = explode('/', $result['path']);
	foreach ($parts as $part) {
	// Prevent any hyjinx since we're ultimately shipping this to the
	// filesystem under a lot of workflows.
	if ($part == '..') {
	throw new Exception("Invalid path URI.");
	}
	}

	return $result;
	}

	/**
	* Check that the working copy of the repository is present and readable.
	*
	* @param string Path to the working copy.
	*/
	protected function validateWorkingCopy($path) {
	if (!is_readable(dirname($path))) {
	$this->raisePermissionException();
	}

	if (!Filesystem::pathExists($path)) {
	$this->raiseCloneException();
	}
	}

	protected function raisePermissionException() {
	$host = php_uname('n');
	$callsign = $this->getRepository()->getCallsign();
	throw new DiffusionSetupException(
	"The clone of this repository ('{$callsign}') on the local machine " .
	"('{$host}') could not be read. Ensure that the repository is in a " .
	"location where the web server has read permissions.");
	}

	protected function raiseCloneException() {
	$host = php_uname('n');
	$callsign = $this->getRepository()->getCallsign();
	throw new DiffusionSetupException(
	"The working copy for this repository ('{$callsign}') hasn't been ".
	"cloned yet on this machine ('{$host}'). Make sure you've started the ".
	"Phabricator daemons. If this problem persists for longer than a clone ".
	"should take, check the daemon logs (in the Daemon Console) to see if ".
	"there were errors cloning the repository. Consult the 'Diffusion User ".
	"Guide' in the documentation for help setting up repositories.");
	}

	final protected function expandCommitName() {
	if ($this->shouldInitFromConduit()) {
	$commit_data = DiffusionQuery::callConduitWithDiffusionRequest(
	$this->getUser(),
	$this,
	'diffusion.expandshortcommitquery',
	array(
	'commit' => $this->commit
	));
	} else {
	$repository = $this->getRepository();
	$this->validateWorkingCopy($repository->getLocalPath());
	$query = DiffusionExpandShortNameQuery::newFromRepository(
	$repository);
	$query->setCommit($this->commit);
	$commit_data = $query->expand();
	}

	$this->commit = $commit_data['commit'];
	$this->commitType = $commit_data['commitType'];
	$this->tagContent = $commit_data['tagContent'];
	}

	+ public function getCommitType() {
	+ return $this->commitType;
	+ }
	+
	private function queryStableCommitName() {
	if ($this->commit) {
	$this->stableCommitName = $this->commit;
	} else if ($this->shouldInitFromConduit()) {
	$this->stableCommitName = DiffusionQuery::callConduitWithDiffusionRequest(
	$this->getUser(),
	$this,
	'diffusion.stablecommitnamequery',
	array(
	'branch' => $this->getBranch()
	));
	} else {
	$query = DiffusionStableCommitNameQuery::newFromRepository(
	$this->getRepository());
	$query->setBranch($this->getBranch());
	$this->stableCommitName = $query->load();
	}
	return $this->stableCommitName;
	}
	}

File Metadata

Mime Type: text/x-diff
Expires: Sun, Jan 19, 20:33 (1 w, 5 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1128472
Default Alt Text: (35 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions