No OneTemporary
Actions

Size

43 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/applications/diffusion/controller/DiffusionBrowseFileController.php b/src/applications/diffusion/controller/DiffusionBrowseFileController.php
	index 6207cb9e09..e6822d8667 100644
	--- a/src/applications/diffusion/controller/DiffusionBrowseFileController.php
	+++ b/src/applications/diffusion/controller/DiffusionBrowseFileController.php
	@@ -1,773 +1,783 @@
	<?php

	/*
	* Copyright 2012 Facebook, Inc.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	final class DiffusionBrowseFileController extends DiffusionController {

	private $corpusType = 'text';

	public function processRequest() {

	$request = $this->getRequest();
	$drequest = $this->getDiffusionRequest();

	$before = $request->getStr('before');
	if ($before) {
	return $this->buildBeforeResponse($before);
	}

	$path = $drequest->getPath();
	$selected = $request->getStr('view');
	// If requested without a view, assume that blame is required (see T1278).
	if (!$selected) {
	$selected = 'blame';
	}
	$needs_blame = ($selected == 'blame' \|\| $selected == 'plainblame');

	$file_query = DiffusionFileContentQuery::newFromDiffusionRequest(
	$this->diffusionRequest);
	$file_query->setNeedsBlame($needs_blame);
	$file_query->loadFileContent();
	$data = $file_query->getRawData();

	if ($selected === 'raw') {
	return $this->buildRawResponse($path, $data);
	}

	// Build the content of the file.
	$corpus = $this->buildCorpus(
	$selected,
	$file_query,
	$needs_blame,
	$drequest,
	$path,
	$data);

	require_celerity_resource('diffusion-source-css');

	if ($this->corpusType == 'text') {
	$view_select_panel = $this->renderViewSelectPanel();
	} else {
	$view_select_panel = null;
	}

	// Render the page.
	$content = array();
	$content[] = $this->buildCrumbs(
	array(
	'branch' => true,
	'path' => true,
	'view' => 'browse',
	));

	$follow = $request->getStr('follow');
	if ($follow) {
	$notice = new AphrontErrorView();
	$notice->setSeverity(AphrontErrorView::SEVERITY_WARNING);
	$notice->setTitle('Unable to Continue');
	switch ($follow) {
	case 'first':
	$notice->appendChild(
	"Unable to continue tracing the history of this file because ".
	"this commit is the first commit in the repository.");
	break;
	case 'created':
	$notice->appendChild(
	"Unable to continue tracing the history of this file because ".
	"this commit created the file.");
	break;
	}
	$content[] = $notice;
	}

	$renamed = $request->getStr('renamed');
	if ($renamed) {
	$notice = new AphrontErrorView();
	$notice->setSeverity(AphrontErrorView::SEVERITY_NOTICE);
	$notice->setTitle('File Renamed');
	$notice->appendChild(
	"File history passes through a rename from '".
	phutil_escape_html($drequest->getPath())."' to '".
	phutil_escape_html($renamed)."'.");
	$content[] = $notice;
	}

	$content[] = $view_select_panel;
	$content[] = $corpus;
	$content[] = $this->buildOpenRevisions();

	$nav = $this->buildSideNav('browse', true);
	$nav->appendChild($content);

	$basename = basename($this->getDiffusionRequest()->getPath());

	return $this->buildStandardPageResponse(
	$nav,
	array(
	'title' => $basename,
	));
	}

	private function buildCorpus($selected,
	DiffusionFileContentQuery $file_query,
	$needs_blame,
	DiffusionRequest $drequest,
	$path,
	$data) {

	if (ArcanistDiffUtils::isHeuristicBinaryFile($data)) {
	$file = $this->loadFileForData($path, $data);
	$file_uri = $file->getBestURI();

	if ($file->isViewableImage()) {
	$this->corpusType = 'image';
	return $this->buildImageCorpus($file_uri);
	} else {
	$this->corpusType = 'binary';
	return $this->buildBinaryCorpus($file_uri, $data);
	}
	}

	switch ($selected) {
	case 'plain':
	$style =
	"margin: 1em 2em; width: 90%; height: 80em; font-family: monospace";
	$corpus = phutil_render_tag(
	'textarea',
	array(
	'style' => $style,
	),
	phutil_escape_html($file_query->getRawData()));

	break;

	case 'plainblame':
	$style =
	"margin: 1em 2em; width: 90%; height: 80em; font-family: monospace";
	list($text_list, $rev_list, $blame_dict) =
	$file_query->getBlameData();

	$rows = array();
	foreach ($text_list as $k => $line) {
	$rev = $rev_list[$k];
	if (isset($blame_dict[$rev]['handle'])) {
	$author = $blame_dict[$rev]['handle']->getName();
	} else {
	$author = $blame_dict[$rev]['author'];
	}
	$rows[] =
	sprintf("%-10s %-20s %s", substr($rev, 0, 7), $author, $line);
	}

	$corpus = phutil_render_tag(
	'textarea',
	array(
	'style' => $style,
	),
	phutil_escape_html(implode("\n", $rows)));

	break;

	case 'highlighted':
	case 'blame':
	default:
	require_celerity_resource('syntax-highlighting-css');

	list($text_list, $rev_list, $blame_dict) = $file_query->getBlameData();

	$text_list = implode("\n", $text_list);
	$text_list = PhabricatorSyntaxHighlighter::highlightWithFilename(
	$path,
	$text_list);
	$text_list = explode("\n", $text_list);

	$rows = $this->buildDisplayRows($text_list, $rev_list, $blame_dict,
	$needs_blame, $drequest, $file_query, $selected);

	$corpus_table = phutil_render_tag(
	'table',
	array(
	'class' => "diffusion-source remarkup-code PhabricatorMonospaced",
	),
	implode("\n", $rows));
	$corpus = phutil_render_tag(
	'div',
	array(
	'style' => 'padding: 0 2em;',
	),
	$corpus_table);

	break;
	}

	return $corpus;
	}

	private function renderViewSelectPanel() {

	$request = $this->getRequest();

	$select = AphrontFormSelectControl::renderSelectTag(
	$request->getStr('view'),
	array(
	'blame' => 'View as Highlighted Text with Blame',
	'highlighted' => 'View as Highlighted Text',
	'plainblame' => 'View as Plain Text with Blame',
	'plain' => 'View as Plain Text',
	'raw' => 'View as raw document',
	),
	array(
	'name' => 'view',
	));

	$view_select_panel = new AphrontPanelView();
	$view_select_form = phutil_render_tag(
	'form',
	array(
	'action' => $request->getRequestURI(),
	'method' => 'get',
	'class' => 'diffusion-browse-type-form',
	),
	$select.
	' <button>View</button> '.
	$this->renderEditButton());

	$view_select_panel->appendChild($view_select_form);
	$view_select_panel->appendChild('<div style="clear: both;"></div>');

	return $view_select_panel;
	}

	private function renderEditButton() {
	$request = $this->getRequest();
	$user = $request->getUser();

	$drequest = $this->getDiffusionRequest();

	$repository = $drequest->getRepository();
	$path = $drequest->getPath();
	$line = 1;

	$callsign = $repository->getCallsign();
	$editor_link = $user->loadEditorLink($path, $line, $callsign);
	if (!$editor_link) {
	return null;
	}

	return phutil_render_tag(
	'a',
	array(
	'href' => $editor_link,
	'class' => 'button',
	),
	'Edit');
	}

	private function buildDisplayRows(
	array $text_list,
	array $rev_list,
	array $blame_dict,
	$needs_blame,
	DiffusionRequest $drequest,
	DiffusionFileContentQuery $file_query,
	$selected) {

	if ($blame_dict) {
	$epoch_list = ipull(ifilter($blame_dict, 'epoch'), 'epoch');
	$epoch_min = min($epoch_list);
	$epoch_max = max($epoch_list);
	$epoch_range = ($epoch_max - $epoch_min) + 1;
	}

	- $min_line = 0;
	- $line = $drequest->getLine();
	- if (strpos($line, '-') !== false) {
	- list($min, $max) = explode('-', $line, 2);
	- $min_line = min($min, $max);
	- $max_line = max($min, $max);
	- } else if (strlen($line)) {
	- $min_line = $line;
	- $max_line = $line;
	+ $line_arr = array();
	+ $line_str = $drequest->getLine();
	+ $ranges = explode(',', $line_str);
	+ foreach ($ranges as $range) {
	+ if (strpos($range, '-') !== false) {
	+ list($min, $max) = explode('-', $range, 2);
	+ $line_arr[] = array(
	+ 'min' => min($min, $max),
	+ 'max' => max($min, $max),
	+ );
	+ } else if (strlen($range)) {
	+ $line_arr[] = array(
	+ 'min' => $range,
	+ 'max' => $range,
	+ );
	+ }
	}

	$display = array();

	$line_number = 1;
	$last_rev = null;
	$color = null;
	foreach ($text_list as $k => $line) {
	$display_line = array(
	'color' => null,
	'epoch' => null,
	'commit' => null,
	'author' => null,
	'target' => null,
	'highlighted' => null,
	'line' => $line_number,
	'data' => $line,
	);

	if ($needs_blame) {
	// If the line's rev is same as the line above, show empty content
	// with same color; otherwise generate blame info. The newer a change
	// is, the more saturated the color.

	// TODO: SVN doesn't always give us blame for the last line, if empty?
	// Bug with our stuff or with SVN?
	$rev = idx($rev_list, $k, $last_rev);

	if ($last_rev == $rev) {
	$display_line['color'] = $color;
	} else {
	$blame = $blame_dict[$rev];

	if (!isset($blame['epoch'])) {
	$color = '#ffd'; // Render as warning.
	} else {
	$color_ratio = ($blame['epoch'] - $epoch_min) / $epoch_range;
	$color_value = 0xF6 * (1.0 - $color_ratio);
	$color = sprintf(
	'#%02x%02x%02x',
	$color_value,
	0xF6,
	$color_value);
	}

	$display_line['epoch'] = idx($blame, 'epoch');
	$display_line['color'] = $color;
	$display_line['commit'] = $rev;

	if (isset($blame['handle'])) {
	$author_link = $blame['handle']->renderLink();
	} else {
	$author_link = phutil_render_tag(
	'span',
	array(
	),
	phutil_escape_html($blame['author']));
	}
	$display_line['author'] = $author_link;

	$last_rev = $rev;
	}
	}

	- if ($min_line) {
	- if ($line_number == $min_line) {
	+ if ($line_arr) {
	+ if ($line_number == $line_arr[0]['min']) {
	$display_line['target'] = true;
	}
	- if ($line_number >= $min_line && $line_number <= $max_line) {
	- $display_line['highlighted'] = true;
	+ foreach ($line_arr as $range) {
	+ if ($line_number >= $range['min'] &&
	+ $line_number <= $range['max']) {
	+ $display_line['highlighted'] = true;
	+ }
	}
	}

	$display[] = $display_line;
	++$line_number;
	}

	$commits = array_filter(ipull($display, 'commit'));
	if ($commits) {
	$commits = id(new PhabricatorAuditCommitQuery())
	->withIdentifiers($drequest->getRepository()->getID(), $commits)
	->needCommitData(true)
	->execute();
	$commits = mpull($commits, null, 'getCommitIdentifier');
	}

	$revision_ids = id(new DifferentialRevision())
	->loadIDsByCommitPHIDs(mpull($commits, 'getPHID'));
	$revisions = array();
	if ($revision_ids) {
	$revisions = id(new DifferentialRevision())->loadAllWhere(
	'id IN (%Ld)',
	$revision_ids);
	}

	$request = $this->getRequest();
	$user = $request->getUser();

	Javelin::initBehavior('phabricator-oncopy', array());

	$rows = array();
	foreach ($display as $line) {

	$line_href = $drequest->generateURI(
	array(
	'action' => 'browse',
	'line' => $line['line'],
	'stable' => true,
	));

	$line_href->setQueryParams($request->getRequestURI()->getQueryParams());

	$blame = array();
	if ($line['color']) {
	$color = $line['color'];

	$before_link = null;
	$commit_link = null;
	$revision_link = null;
	if (idx($line, 'commit')) {
	$commit = $line['commit'];

	$summary = 'Unknown';
	if (idx($commits, $commit)) {
	$summary = $commits[$commit]->getCommitData()->getSummary();
	}

	$tooltip = phabricator_date(
	$line['epoch'],
	$user)." \xC2\xB7 ".$summary;

	Javelin::initBehavior('phabricator-tooltips', array());
	require_celerity_resource('aphront-tooltip-css');

	$commit_link = javelin_render_tag(
	'a',
	array(
	'href' => $drequest->generateURI(
	array(
	'action' => 'commit',
	'commit' => $line['commit'],
	)),
	'sigil' => 'has-tooltip',
	'meta' => array(
	'tip' => $tooltip,
	'align' => 'E',
	'size' => 600,
	),
	),
	phutil_escape_html(phutil_utf8_shorten($line['commit'], 9, '')));

	$revision_id = idx($revision_ids, $commits[$commit]->getPHID());
	if ($revision_id) {
	$revision = idx($revisions, $revision_id);
	if (!$revision) {
	$tooltip = '(Invalid revision)';
	} else {
	$tooltip =
	phabricator_date($revision->getDateModified(), $user).
	" \xC2\xB7 ".
	$revision->getTitle();
	}
	$revision_link = javelin_render_tag(
	'a',
	array(
	'href' => '/D'.$revision_id,
	'sigil' => 'has-tooltip',
	'meta' => array(
	'tip' => $tooltip,
	'align' => 'E',
	'size' => 600,
	),
	),
	'D'.$revision_id);
	}

	$before_link = javelin_render_tag(
	'a',
	array(
	'href' => $line_href->alter('before', $commit),
	'sigil' => 'has-tooltip',
	'meta' => array(
	'tip' => 'Skip Past This Commit',
	'align' => 'E',
	'size' => 300,
	),
	),
	"\xC2\xAB");
	}

	$blame[] = phutil_render_tag(
	'th',
	array(
	'class' => 'diffusion-blame-link',
	'style' => 'background: '.$color,
	),
	$before_link);

	$blame[] = phutil_render_tag(
	'th',
	array(
	'class' => 'diffusion-rev-link',
	'style' => 'background: '.$color,
	),
	$commit_link);

	$blame[] = phutil_render_tag(
	'th',
	array(
	'class' => 'diffusion-rev-link',
	'style' => 'background: '.$color,
	),
	$revision_link);

	$blame[] = phutil_render_tag(
	'th',
	array(
	'class' => 'diffusion-author-link',
	'style' => 'background: '.$color,
	),
	idx($line, 'author'));
	}

	$line_link = phutil_render_tag(
	'a',
	array(
	'href' => $line_href,
	),
	phutil_escape_html($line['line']));

	$blame[] = phutil_render_tag(
	'th',
	array(
	'class' => 'diffusion-line-link',
	'style' => isset($color) ? 'background: '.$color : null,
	),
	$line_link);

	$blame = implode('', $blame);

	if ($line['target']) {
	Javelin::initBehavior(
	'diffusion-jump-to',
	array(
	'target' => 'scroll_target',
	));
	$anchor_text = '<a id="scroll_target"></a>';
	} else {
	$anchor_text = null;
	}

	$line_text = phutil_render_tag(
	'td',
	array(
	),
	$anchor_text.
	"\xE2\x80\x8B". // NOTE: See phabricator-oncopy behavior.
	$line['data']);

	$rows[] = phutil_render_tag(
	'tr',
	array(
	'style' => ($line['highlighted'] ? 'background: #ffff00;' : null),
	),
	$blame.
	$line_text);
	}

	return $rows;
	}


	private static function renderRevision(DiffusionRequest $drequest,
	$revision) {

	$callsign = $drequest->getCallsign();

	$name = 'r'.$callsign.$revision;
	return phutil_render_tag(
	'a',
	array(
	'href' => '/'.$name,
	),
	$name
	);
	}


	private static function renderBrowse(
	DiffusionRequest $drequest,
	$path,
	$name = null,
	$rev = null,
	$line = null,
	$view = null,
	$title = null) {

	$callsign = $drequest->getCallsign();

	if ($name === null) {
	$name = $path;
	}

	$at = null;
	if ($rev) {
	$at = ';'.$rev;
	}

	if ($view) {
	$view = '?view='.$view;
	}

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

	return phutil_render_tag(
	'a',
	array(
	'href' => "/diffusion/{$callsign}/browse/{$path}{$at}{$line}{$view}",
	'title' => $title,
	),
	$name
	);
	}

	private function loadFileForData($path, $data) {
	$hash = PhabricatorHash::digest($data);

	$file = id(new PhabricatorFile())->loadOneWhere(
	'contentHash = %s LIMIT 1',
	$hash);
	if (!$file) {
	// We're just caching the data; this is always safe.
	$unguarded = AphrontWriteGuard::beginScopedUnguardedWrites();

	$file = PhabricatorFile::newFromFileData(
	$data,
	array(
	'name' => basename($path),
	));

	unset($unguarded);
	}

	return $file;
	}

	private function buildRawResponse($path, $data) {
	$file = $this->loadFileForData($path, $data);
	return id(new AphrontRedirectResponse())->setURI($file->getBestURI());
	}

	private function buildImageCorpus($file_uri) {
	$panel = new AphrontPanelView();
	$panel->setHeader('Image');
	$panel->addButton($this->renderEditButton());
	$panel->appendChild(
	phutil_render_tag(
	'img',
	array(
	'src' => $file_uri,
	)));
	return $panel;
	}

	private function buildBinaryCorpus($file_uri, $data) {
	$panel = new AphrontPanelView();
	$panel->setHeader('Binary File');
	$panel->addButton($this->renderEditButton());
	$panel->appendChild(
	'<p>'.
	'This is a binary file. '.
	'It is '.number_format(strlen($data)).' bytes in length.'.
	'</p>');
	$panel->addButton(
	phutil_render_tag(
	'a',
	array(
	'href' => $file_uri,
	'class' => 'button green',
	),
	'Download Binary File...'));
	return $panel;
	}

	private function buildBeforeResponse($before) {
	$request = $this->getRequest();
	$drequest = $this->getDiffusionRequest();

	// NOTE: We need to get the grandparent so we can capture filename changes
	// in the parent.

	$parent = $this->loadParentRevisionOf($before);
	$old_filename = null;
	$was_created = false;
	if ($parent) {
	$grandparent = $this->loadParentRevisionOf(
	$parent->getCommitIdentifier());

	if ($grandparent) {
	$rename_query = DiffusionRenameHistoryQuery::newFromDiffusionRequest(
	$drequest);
	$rename_query->setOldCommit($grandparent->getCommitIdentifier());
	$old_filename = $rename_query->loadOldFilename();
	$was_created = $rename_query->getWasCreated();
	}
	}

	$follow = null;
	if ($was_created) {
	// If the file was created in history, that means older commits won't
	// have it. Since we know it existed at 'before', it must have been
	// created then; jump there.
	$target_commit = $before;
	$follow = 'created';
	} else if ($parent) {
	// If we found a parent, jump to it. This is the normal case.
	$target_commit = $parent->getCommitIdentifier();
	} else {
	// If there's no parent, this was probably created in the initial commit?
	// And the "was_created" check will fail because we can't identify the
	// grandparent. Keep the user at 'before'.
	$target_commit = $before;
	$follow = 'first';
	}

	$path = $drequest->getPath();
	$renamed = null;
	if ($old_filename !== null &&
	$old_filename !== $path) {
	$renamed = $path;
	$path = $old_filename;
	}

	$before_uri = $drequest->generateURI(
	array(
	'action' => 'browse',
	'commit' => $target_commit,
	// If there's a follow error, drop the line so the user sees the
	// message.
	'line' => $follow ? null : $drequest->getLine(),
	'path' => $path,
	));

	$before_uri->setQueryParams($request->getRequestURI()->getQueryParams());
	$before_uri = $before_uri->alter('before', null);
	$before_uri = $before_uri->alter('renamed', $renamed);
	$before_uri = $before_uri->alter('follow', $follow);

	return id(new AphrontRedirectResponse())->setURI($before_uri);
	}

	private function loadParentRevisionOf($commit) {
	$drequest = $this->getDiffusionRequest();

	$before_req = DiffusionRequest::newFromDictionary(
	array(
	'repository' => $drequest->getRepository(),
	'commit' => $commit,
	));

	$query = DiffusionCommitParentsQuery::newFromDiffusionRequest($before_req);
	$parents = $query->loadParents();

	return head($parents);
	}

	}
	diff --git a/src/applications/diffusion/request/DiffusionRequest.php b/src/applications/diffusion/request/DiffusionRequest.php
	index e179c38d12..5a02a88fb8 100644
	--- a/src/applications/diffusion/request/DiffusionRequest.php
	+++ b/src/applications/diffusion/request/DiffusionRequest.php
	@@ -1,528 +1,528 @@
	<?php

	/*
	* Copyright 2012 Facebook, Inc.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	/**
	* 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 $branch;
	protected $commitType = 'commit';
	protected $tagContent;

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

	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`.
	* - `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.");
	}

	if (isset($data['repository'])) {
	$object = self::newFromRepository($data['repository']);
	} else {
	$object = self::newFromCallsign($data['callsign']);
	}
	$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) {
	$callsign = phutil_unescape_uri_path_component(idx($data, 'callsign'));
	$object = self::newFromCallsign($callsign);

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

	$object->initializeFromDictionary($parsed);
	return $object;
	}


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


	/**
	* Internal. Use @{method:newFromDictionary}, not this method.
	*
	* @param string Repository callsign.
	* @return DiffusionRequest New request object.
	* @task new
	*/
	final private static function newFromCallsign($callsign) {
	$repository = id(new PhabricatorRepository())->loadOneWhere(
	'callsign = %s',
	$callsign);

	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');

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

	$this->didInitialize();
	}


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

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

	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 getTagContent() {
	return $this->tagContent;
	}

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

	$commit = id(new PhabricatorRepositoryCommit())->loadOneWhere(
	'repositoryID = %d AND commitIdentifier = %s',
	$repository->getID(),
	$this->getCommit());
	$this->repositoryCommit = $commit;
	}
	return $this->repositoryCommit;
	}

	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() {
	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,
	);
	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` 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.
	* - `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':
	$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_branch && !strlen($branch)) {
	throw new Exception(
	"Diffusion URI action '{$action}' requires branch!");
	}

	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':
	$uri = "/diffusion/{$callsign}{$action}/{$path}{$commit}{$line}";
	break;
	case 'branch':
	$uri = "/diffusion/{$callsign}repository/{$path}";
	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 (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-]+)$@';
	+ $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;
	}

	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.");
	}

	}
	diff --git a/src/applications/diffusion/request/__tests__/DiffusionURITestCase.php b/src/applications/diffusion/request/__tests__/DiffusionURITestCase.php
	index 84e18a3d33..3a4e3cce32 100644
	--- a/src/applications/diffusion/request/__tests__/DiffusionURITestCase.php
	+++ b/src/applications/diffusion/request/__tests__/DiffusionURITestCase.php
	@@ -1,153 +1,166 @@
	<?php

	/*
	* Copyright 2012 Facebook, Inc.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	final class DiffusionURITestCase extends ArcanistPhutilTestCase {

	public function testBlobDecode() {
	$map = array(
	// This is a basic blob.
	'branch/path.ext;abc$3' => array(
	'branch' => 'branch',
	'path' => 'path.ext',
	'commit' => 'abc',
	'line' => '3',
	),
	'branch/path.ext$3' => array(
	'branch' => 'branch',
	'path' => 'path.ext',
	'line' => '3',
	),
	'branch/money;;/$$100' => array(
	'branch' => 'branch',
	'path' => 'money;/$100',
	),
	'a%252Fb/' => array(
	'branch' => 'a/b',
	),
	'branch/path/;Version-1_0_0' => array(
	'branch' => 'branch',
	'path' => 'path/',
	'commit' => 'Version-1_0_0',
	),
	'branch/path/;$$moneytag$$' => array(
	'branch' => 'branch',
	'path' => 'path/',
	'commit' => '$moneytag$',
	),
	'branch/path/semicolon;;;;;$$;;semicolon;;$$$$$100' => array(
	'branch' => 'branch',
	'path' => 'path/semicolon;;',
	'commit' => '$;;semicolon;;$$',
	'line' => '100',
	),
	+ 'branch/path.ext;abc$3-5,7-12,14' => array(
	+ 'branch' => 'branch',
	+ 'path' => 'path.ext',
	+ 'commit' => 'abc',
	+ 'line' => '3-5,7-12,14',
	+ ),
	);

	foreach ($map as $input => $expect) {

	// Simulate decode effect of the webserver.
	$input = rawurldecode($input);

	$expect = $expect + array(
	'branch' => null,
	'path' => null,
	'commit' => null,
	'line' => null,
	);
	$expect = array_select_keys(
	$expect,
	array('branch', 'path', 'commit', 'line'));

	$actual = $this->parseBlob($input);

	$this->assertEqual(
	$expect,
	$actual,
	"Parsing '{$input}'");
	}
	}

	public function testBlobDecodeFail() {
	$this->tryTestCaseMap(
	array(
	'branch/path/../../../secrets/secrets.key' => false,
	),
	array($this, 'parseBlob'));
	}

	public function parseBlob($blob) {
	return DiffusionRequest::parseRequestBlob(
	$blob,
	$supports_branches = true);
	}

	public function testURIGeneration() {
	$map = array(
	'/diffusion/A/browse/branch/path.ext;abc$1' => array(
	'action' => 'browse',
	'callsign' => 'A',
	'branch' => 'branch',
	'path' => 'path.ext',
	'commit' => 'abc',
	'line' => '1',
	),
	'/diffusion/A/browse/a%252Fb/path.ext' => array(
	'action' => 'browse',
	'callsign' => 'A',
	'branch' => 'a/b',
	'path' => 'path.ext',
	),
	'/diffusion/A/browse/%2B/%20%21' => array(
	'action' => 'browse',
	'callsign' => 'A',
	'path' => '+/ !',
	),
	'/diffusion/A/browse/money/%24%24100$2' => array(
	'action' => 'browse',
	'callsign' => 'A',
	'path' => 'money/$100',
	'line' => '2',
	),
	'/diffusion/A/browse/path/to/file.ext?view=things' => array(
	'action' => 'browse',
	'callsign' => 'A',
	'path' => 'path/to/file.ext',
	'params' => array(
	'view' => 'things',
	),
	),
	'/diffusion/A/repository/master/' => array(
	'action' => 'branch',
	'callsign' => 'A',
	'branch' => 'master',
	),
	'path/to/file.ext;abc' => array(
	'action' => 'rendering-ref',
	'path' => 'path/to/file.ext',
	'commit' => 'abc',
	),
	+ '/diffusion/A/browse/branch/path.ext$3-5%2C7-12%2C14' => array(
	+ 'action' => 'browse',
	+ 'callsign' => 'A',
	+ 'branch' => 'branch',
	+ 'path' => 'path.ext',
	+ 'line' => '3-5,7-12,14',
	+ ),
	);

	foreach ($map as $expect => $input) {
	$actual = DiffusionRequest::generateDiffusionURI($input);
	$this->assertEqual(
	$expect,
	(string)$actual);
	}
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Sat, Nov 15, 4:26 AM (16 h, 53 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 337627
Default Alt Text: (43 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions