ConduitAPI_diffusion_browsequery_Method.php
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Sat, Dec 28, 15:40

ConduitAPI_diffusion_browsequery_Method.php
View Options

	<?php

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

	public function getMethodDescription() {
	return
	'File(s) information for a repository at an (optional) path and '.
	'(optional) commit.';
	}

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

	protected function defineCustomParamTypes() {
	return array(
	'path' => 'optional string',
	'commit' => 'optional string',
	'needValidityOnly' => 'optional bool',
	'renderReadme' => 'optional bool',
	);
	}

	protected function getResult(ConduitAPIRequest $request) {
	$result = parent::getResult($request);
	if ($request->getValue('renderReadme', false)) {
	$readme = $this->renderReadme($request, $result);
	}
	return $result->toDictionary();
	}

	final private function renderReadme(
	ConduitAPIRequest $request,
	DiffusionBrowseResultSet $result) {
	$drequest = $this->getDiffusionRequest();

	$readme = null;
	foreach ($result->getPaths() as $result_path) {
	$file_type = $result_path->getFileType();
	if (($file_type != ArcanistDiffChangeType::FILE_NORMAL) &&
	($file_type != ArcanistDiffChangeType::FILE_TEXT)) {
	// Skip directories, etc.
	continue;
	}

	$path = $result_path->getPath();

	if (preg_match('/^readme(\|\.txt\|\.remarkup\|\.rainbow\|\.md)$/i', $path)) {
	$readme = $result_path;
	break;
	}
	}

	if (!$readme) {
	return null;
	}

	$readme_request = DiffusionRequest::newFromDictionary(
	array(
	'user' => $request->getUser(),
	'repository' => $drequest->getRepository(),
	'commit' => $drequest->getStableCommitName(),
	'path' => $readme->getFullPath(),
	));

	$file_content = DiffusionFileContent::newFromConduit(
	DiffusionQuery::callConduitWithDiffusionRequest(
	$request->getUser(),
	$readme_request,
	'diffusion.filecontentquery',
	array(
	'commit' => $drequest->getStableCommitName(),
	'path' => $readme->getFullPath(),
	'needsBlame' => false,
	)));
	$readme_content = $file_content->getCorpus();

	if (preg_match('/\\.txt$/', $readme->getPath())) {
	$readme_content = phutil_escape_html_newlines($readme_content);

	$class = null;
	} else if (preg_match('/\\.rainbow$/', $readme->getPath())) {
	$highlighter = new PhutilRainbowSyntaxHighlighter();
	$readme_content = $highlighter
	->getHighlightFuture($readme_content)
	->resolve();
	$readme_content = phutil_escape_html_newlines($readme_content);

	require_celerity_resource('syntax-highlighting-css');
	$class = 'remarkup-code';
	} else {
	// Markup extensionless files as remarkup so we get links and such.
	$engine = PhabricatorMarkupEngine::newDiffusionMarkupEngine();
	$engine->setConfig('viewer', $request->getUser());
	$readme_content = $engine->markupText($readme_content);

	$class = 'phabricator-remarkup';
	}

	$readme_content = phutil_tag(
	'div',
	array(
	'class' => $class,
	),
	$readme_content);

	$result->setReadmeContent($readme_content);
	return $result;
	}

	protected function getGitResult(ConduitAPIRequest $request) {
	$drequest = $this->getDiffusionRequest();
	$repository = $drequest->getRepository();
	$path = $request->getValue('path');
	$commit = $request->getValue('commit');
	$result = $this->getEmptyResultSet();

	if ($path == '') {
	// Fast path to improve the performance of the repository view; we know
	// the root is always a tree at any commit and always exists.
	$stdout = 'tree';
	} else {
	try {
	list($stdout) = $repository->execxLocalCommand(
	'cat-file -t %s:%s',
	$commit,
	$path);
	} catch (CommandException $e) {
	$stderr = $e->getStdErr();
	if (preg_match('/^fatal: Not a valid object name/', $stderr)) {
	// Grab two logs, since the first one is when the object was deleted.
	list($stdout) = $repository->execxLocalCommand(
	'log -n2 --format="%%H" %s -- %s',
	$commit,
	$path);
	$stdout = trim($stdout);
	if ($stdout) {
	$commits = explode("\n", $stdout);
	$result
	->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_DELETED)
	->setDeletedAtCommit(idx($commits, 0))
	->setExistedAtCommit(idx($commits, 1));
	return $result;
	}

	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_NONEXISTENT);
	return $result;
	} else {
	throw $e;
	}
	}
	}

	if (trim($stdout) == 'blob') {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_FILE);
	return $result;
	}

	$result->setIsValidResults(true);
	if ($this->shouldOnlyTestValidity($request)) {
	return $result;
	}

	list($stdout) = $repository->execxLocalCommand(
	'ls-tree -z -l %s:%s',
	$commit,
	$path);

	$submodules = array();

	if (strlen($path)) {
	$prefix = rtrim($path, '/').'/';
	} else {
	$prefix = '';
	}

	$results = array();
	foreach (explode("\0", rtrim($stdout)) as $line) {

	// NOTE: Limit to 5 components so we parse filenames with spaces in them
	// correctly.
	list($mode, $type, $hash, $size, $name) = preg_split('/\s+/', $line, 5);

	$path_result = new DiffusionRepositoryPath();

	if ($type == 'tree') {
	$file_type = DifferentialChangeType::FILE_DIRECTORY;
	} else if ($type == 'commit') {
	$file_type = DifferentialChangeType::FILE_SUBMODULE;
	$submodules[] = $path_result;
	} else {
	$mode = intval($mode, 8);
	if (($mode & 0120000) == 0120000) {
	$file_type = DifferentialChangeType::FILE_SYMLINK;
	} else {
	$file_type = DifferentialChangeType::FILE_NORMAL;
	}
	}

	$path_result->setFullPath($prefix.$name);
	$path_result->setPath($name);
	$path_result->setHash($hash);
	$path_result->setFileType($file_type);
	$path_result->setFileSize($size);

	$results[] = $path_result;
	}

	// If we identified submodules, lookup the module info at this commit to
	// find their source URIs.

	if ($submodules) {

	// NOTE: We need to read the file out of git and write it to a temporary
	// location because "git config -f" doesn't accept a "commit:path"-style
	// argument.

	// NOTE: This file may not exist, e.g. because the commit author removed
	// it when they added the submodule. See T1448. If it's not present, just
	// show the submodule without enriching it. If ".gitmodules" was removed
	// it seems to partially break submodules, but the repository as a whole
	// continues to work fine and we've seen at least two cases of this in
	// the wild.

	list($err, $contents) = $repository->execLocalCommand(
	'cat-file blob %s:.gitmodules',
	$commit);

	if (!$err) {
	$tmp = new TempFile();
	Filesystem::writeFile($tmp, $contents);
	list($module_info) = $repository->execxLocalCommand(
	'config -l -f %s',
	$tmp);

	$dict = array();
	$lines = explode("\n", trim($module_info));
	foreach ($lines as $line) {
	list($key, $value) = explode('=', $line, 2);
	$parts = explode('.', $key);
	$dict[$key] = $value;
	}

	foreach ($submodules as $path) {
	$full_path = $path->getFullPath();
	$key = 'submodule.'.$full_path.'.url';
	if (isset($dict[$key])) {
	$path->setExternalURI($dict[$key]);
	}
	}
	}
	}

	return $result->setPaths($results);
	}

	protected function getMercurialResult(ConduitAPIRequest $request) {
	$drequest = $this->getDiffusionRequest();
	$repository = $drequest->getRepository();
	$path = $request->getValue('path');
	$commit = $request->getValue('commit');
	$result = $this->getEmptyResultSet();

	// TODO: This is a really really awful mess but Mercurial doesn't offer
	// an equivalent of "git ls-files -- directory". If it's any comfort, this
	// is what "hgweb" does too, see:
	//
	// http://selenic.com/repo/hg/file/91dc8878f888/mercurial/hgweb/webcommands.py#l320
	//
	// derp derp derp derp
	//
	// Anyway, figure out what's in this path by applying massive amounts
	// of brute force.

	list($entire_manifest) = $repository->execxLocalCommand(
	'manifest --rev %s',
	$commit);
	$entire_manifest = explode("\n", $entire_manifest);

	$results = array();

	$match_against = trim($path, '/');
	$match_len = strlen($match_against);

	// For the root, don't trim. For other paths, trim the "/" after we match.
	// We need this because Mercurial's canonical paths have no leading "/",
	// but ours do.
	$trim_len = $match_len ? $match_len + 1 : 0;

	foreach ($entire_manifest as $path) {
	if (strncmp($path, $match_against, $match_len)) {
	continue;
	}
	if (!strlen($path)) {
	continue;
	}
	$remainder = substr($path, $trim_len);
	if (!strlen($remainder)) {
	// There is a file with this exact name in the manifest, so clearly
	// it's a file.
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_FILE);
	return $result;
	}
	$parts = explode('/', $remainder);
	if (count($parts) == 1) {
	$type = DifferentialChangeType::FILE_NORMAL;
	} else {
	$type = DifferentialChangeType::FILE_DIRECTORY;
	}
	$results[reset($parts)] = $type;
	}

	foreach ($results as $key => $type) {
	$path_result = new DiffusionRepositoryPath();
	$path_result->setPath($key);
	$path_result->setFileType($type);
	$path_result->setFullPath(ltrim($match_against.'/', '/').$key);

	$results[$key] = $path_result;
	}

	$valid_results = true;
	if (empty($results)) {
	// TODO: Detect "deleted" by issuing "hg log"?
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_NONEXISTENT);
	$valid_results = false;
	}

	return $result
	->setPaths($results)
	->setIsValidResults($valid_results);
	}

	protected function getSVNResult(ConduitAPIRequest $request) {
	$drequest = $this->getDiffusionRequest();
	$repository = $drequest->getRepository();
	$path = $request->getValue('path');
	$commit = $request->getValue('commit');
	$result = $this->getEmptyResultSet();

	$subpath = $repository->getDetail('svn-subpath');
	if ($subpath && strncmp($subpath, $path, strlen($subpath))) {
	// If we have a subpath and the path isn't a child of it, it (almost
	// certainly) won't exist since we don't track commits which affect
	// it. (Even if it exists, return a consistent result.)
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_UNTRACKED_PARENT);
	return $result;
	}

	$conn_r = $repository->establishConnection('r');

	$parent_path = DiffusionPathIDQuery::getParentPath($path);
	$path_query = new DiffusionPathIDQuery(
	array(
	$path,
	$parent_path,
	));
	$path_map = $path_query->loadPathIDs();

	$path_id = $path_map[$path];
	$parent_path_id = $path_map[$parent_path];

	if (empty($path_id)) {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_NONEXISTENT);
	return $result;
	}

	if ($commit) {
	$slice_clause = 'AND svnCommit <= '.(int)$commit;
	} else {
	$slice_clause = '';
	}

	$index = queryfx_all(
	$conn_r,
	'SELECT pathID, max(svnCommit) maxCommit FROM %T WHERE
	repositoryID = %d AND parentID = %d
	%Q GROUP BY pathID',
	PhabricatorRepository::TABLE_FILESYSTEM,
	$repository->getID(),
	$path_id,
	$slice_clause);

	if (!$index) {
	if ($path == '/') {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_EMPTY);
	} else {

	// NOTE: The parent path ID is included so this query can take
	// advantage of the table's primary key; it is uniquely determined by
	// the pathID but if we don't do the lookup ourselves MySQL doesn't have
	// the information it needs to avoid a table scan.

	$reasons = queryfx_all(
	$conn_r,
	'SELECT * FROM %T WHERE repositoryID = %d
	AND parentID = %d
	AND pathID = %d
	%Q ORDER BY svnCommit DESC LIMIT 2',
	PhabricatorRepository::TABLE_FILESYSTEM,
	$repository->getID(),
	$parent_path_id,
	$path_id,
	$slice_clause);

	$reason = reset($reasons);

	if (!$reason) {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_NONEXISTENT);
	} else {
	$file_type = $reason['fileType'];
	if (empty($reason['existed'])) {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_DELETED);
	$result->setDeletedAtCommit($reason['svnCommit']);
	if (!empty($reasons[1])) {
	$result->setExistedAtCommit($reasons[1]['svnCommit']);
	}
	} else if ($file_type == DifferentialChangeType::FILE_DIRECTORY) {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_EMPTY);
	} else {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_FILE);
	}
	}
	}
	return $result;
	}

	$result->setIsValidResults(true);
	if ($this->shouldOnlyTestValidity($request)) {
	return $result;
	}

	$sql = array();
	foreach ($index as $row) {
	$sql[] =
	'(pathID = '.(int)$row['pathID'].' AND '.
	'svnCommit = '.(int)$row['maxCommit'].')';
	}

	$browse = queryfx_all(
	$conn_r,
	'SELECT *, p.path pathName
	FROM %T f JOIN %T p ON f.pathID = p.id
	WHERE repositoryID = %d
	AND parentID = %d
	AND existed = 1
	AND (%Q)
	ORDER BY pathName',
	PhabricatorRepository::TABLE_FILESYSTEM,
	PhabricatorRepository::TABLE_PATH,
	$repository->getID(),
	$path_id,
	implode(' OR ', $sql));

	$loadable_commits = array();
	foreach ($browse as $key => $file) {
	// We need to strip out directories because we don't store last-modified
	// in the filesystem table.
	if ($file['fileType'] != DifferentialChangeType::FILE_DIRECTORY) {
	$loadable_commits[] = $file['svnCommit'];
	$browse[$key]['hasCommit'] = true;
	}
	}

	$commits = array();
	$commit_data = array();
	if ($loadable_commits) {
	// NOTE: Even though these are integers, use '%Ls' because MySQL doesn't
	// use the second part of the key otherwise!
	$commits = id(new PhabricatorRepositoryCommit())->loadAllWhere(
	'repositoryID = %d AND commitIdentifier IN (%Ls)',
	$repository->getID(),
	$loadable_commits);
	$commits = mpull($commits, null, 'getCommitIdentifier');
	if ($commits) {
	$commit_data = id(new PhabricatorRepositoryCommitData())->loadAllWhere(
	'commitID in (%Ld)',
	mpull($commits, 'getID'));
	$commit_data = mpull($commit_data, null, 'getCommitID');
	} else {
	$commit_data = array();
	}
	}

	$path_normal = DiffusionPathIDQuery::normalizePath($path);

	$results = array();
	foreach ($browse as $file) {

	$full_path = $file['pathName'];
	$file_path = ltrim(substr($full_path, strlen($path_normal)), '/');
	$full_path = ltrim($full_path, '/');

	$result_path = new DiffusionRepositoryPath();
	$result_path->setPath($file_path);
	$result_path->setFullPath($full_path);
	// $result_path->setHash($hash);
	$result_path->setFileType($file['fileType']);
	// $result_path->setFileSize($size);

	if (!empty($file['hasCommit'])) {
	$commit = idx($commits, $file['svnCommit']);
	if ($commit) {
	$data = idx($commit_data, $commit->getID());
	$result_path->setLastModifiedCommit($commit);
	$result_path->setLastCommitData($data);
	}
	}

	$results[] = $result_path;
	}

	if (empty($results)) {
	$result->setReasonForEmptyResultSet(
	DiffusionBrowseResultSet::REASON_IS_EMPTY);
	}

	return $result->setPaths($results);
	}

	private function getEmptyResultSet() {
	return id(new DiffusionBrowseResultSet())
	->setPaths(array())
	->setReasonForEmptyResultSet(null)
	->setIsValidResults(false);
	}

	private function shouldOnlyTestValidity(ConduitAPIRequest $request) {
	return $request->getValue('needValidityOnly', false);
	}

	}

ConduitAPI_diffusion_browsequery_Method.phpNo OneTemporaryActions

File Metadata

ConduitAPI_diffusion_browsequery_Method.phpView Options

Event Timeline

ConduitAPI_diffusion_browsequery_Method.php
No OneTemporary
Actions

ConduitAPI_diffusion_browsequery_Method.php
View Options