ArcanistRepositoryAPI.php
No OneTemporary
Actions

Size

20 KB

Referenced Files

None

Subscribers

None

ArcanistRepositoryAPI.php
View Options

	<?php

	/**
	* Interfaces with the VCS in the working copy.
	*
	* @task status Path Status
	*/
	abstract class ArcanistRepositoryAPI extends Phobject {

	const FLAG_MODIFIED = 1;
	const FLAG_ADDED = 2;
	const FLAG_DELETED = 4;
	const FLAG_UNTRACKED = 8;
	const FLAG_CONFLICT = 16;
	const FLAG_MISSING = 32;
	const FLAG_UNSTAGED = 64;
	const FLAG_UNCOMMITTED = 128;

	// Occurs in SVN when you have uncommitted changes to a modified external,
	// or in Git when you have uncommitted or untracked changes in a submodule.
	const FLAG_EXTERNALS = 256;

	// Occurs in SVN when you replace a file with a directory without telling
	// SVN about it.
	const FLAG_OBSTRUCTED = 512;

	// Occurs in SVN when an update was interrupted or failed, e.g. you ^C'd it.
	const FLAG_INCOMPLETE = 1024;

	protected $path;
	protected $diffLinesOfContext = 0x7FFF;
	private $baseCommitExplanation = '???';
	private $configurationManager;
	private $baseCommitArgumentRules;

	private $uncommittedStatusCache;
	private $commitRangeStatusCache;

	private $symbolicBaseCommit;
	private $resolvedBaseCommit;

	private $runtime;
	private $currentWorkingCopyStateRef = false;
	private $currentCommitRef = false;
	private $graph;

	abstract public function getSourceControlSystemName();

	public function getDiffLinesOfContext() {
	return $this->diffLinesOfContext;
	}

	public function setDiffLinesOfContext($lines) {
	$this->diffLinesOfContext = $lines;
	return $this;
	}

	public function getWorkingCopyIdentity() {
	return $this->configurationManager->getWorkingCopyIdentity();
	}

	public function getConfigurationManager() {
	return $this->configurationManager;
	}

	public static function newAPIFromConfigurationManager(
	ArcanistConfigurationManager $configuration_manager) {

	$working_copy = $configuration_manager->getWorkingCopyIdentity();

	if (!$working_copy) {
	throw new Exception(
	pht(
	'Trying to create a %s without a working copy!',
	__CLASS__));
	}

	$root = $working_copy->getProjectRoot();
	switch ($working_copy->getVCSType()) {
	case 'svn':
	$api = new ArcanistSubversionAPI($root);
	break;
	case 'hg':
	$api = new ArcanistMercurialAPI($root);
	break;
	case 'git':
	$api = new ArcanistGitAPI($root);
	break;
	default:
	throw new Exception(
	pht(
	'The current working directory is not part of a working copy for '.
	'a supported version control system (Git, Subversion or '.
	'Mercurial).'));
	}

	$api->configurationManager = $configuration_manager;
	return $api;
	}

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

	public function getPath($to_file = null) {
	if ($to_file !== null) {
	return $this->path.DIRECTORY_SEPARATOR.
	ltrim($to_file, DIRECTORY_SEPARATOR);
	} else {
	return $this->path.DIRECTORY_SEPARATOR;
	}
	}


	/* -( Path Status )-------------------------------------------------------- */


	abstract protected function buildUncommittedStatus();
	abstract protected function buildCommitRangeStatus();


	/**
	* Get a list of uncommitted paths in the working copy that have been changed
	* or are affected by other status effects, like conflicts or untracked
	* files.
	*
	* Convenience methods @{method:getUntrackedChanges},
	* @{method:getUnstagedChanges}, @{method:getUncommittedChanges},
	* @{method:getMergeConflicts}, and @{method:getIncompleteChanges} allow
	* simpler selection of paths in a specific state.
	*
	* This method returns a map of paths to bitmasks with status, using
	* `FLAG_` constants. For example:
	*
	* array(
	* 'some/uncommitted/file.txt' => ArcanistRepositoryAPI::FLAG_UNSTAGED,
	* );
	*
	* A file may be in several states. Not all states are possible with all
	* version control systems.
	*
	* @return map<string, bitmask> Map of paths, see above.
	* @task status
	*/
	final public function getUncommittedStatus() {
	if ($this->uncommittedStatusCache === null) {
	$status = $this->buildUncommittedStatus();
	ksort($status);
	$this->uncommittedStatusCache = $status;
	}
	return $this->uncommittedStatusCache;
	}


	/**
	* @task status
	*/
	final public function getUntrackedChanges() {
	return $this->getUncommittedPathsWithMask(self::FLAG_UNTRACKED);
	}


	/**
	* @task status
	*/
	final public function getUnstagedChanges() {
	return $this->getUncommittedPathsWithMask(self::FLAG_UNSTAGED);
	}


	/**
	* @task status
	*/
	final public function getUncommittedChanges() {
	return $this->getUncommittedPathsWithMask(self::FLAG_UNCOMMITTED);
	}


	/**
	* @task status
	*/
	final public function getMergeConflicts() {
	return $this->getUncommittedPathsWithMask(self::FLAG_CONFLICT);
	}


	/**
	* @task status
	*/
	final public function getIncompleteChanges() {
	return $this->getUncommittedPathsWithMask(self::FLAG_INCOMPLETE);
	}


	/**
	* @task status
	*/
	final public function getMissingChanges() {
	return $this->getUncommittedPathsWithMask(self::FLAG_MISSING);
	}


	/**
	* @task status
	*/
	final public function getDirtyExternalChanges() {
	return $this->getUncommittedPathsWithMask(self::FLAG_EXTERNALS);
	}


	/**
	* @task status
	*/
	private function getUncommittedPathsWithMask($mask) {
	$match = array();
	foreach ($this->getUncommittedStatus() as $path => $flags) {
	if ($flags & $mask) {
	$match[] = $path;
	}
	}
	return $match;
	}


	/**
	* Get a list of paths affected by the commits in the current commit range.
	*
	* See @{method:getUncommittedStatus} for a description of the return value.
	*
	* @return map<string, bitmask> Map from paths to status.
	* @task status
	*/
	final public function getCommitRangeStatus() {
	if ($this->commitRangeStatusCache === null) {
	$status = $this->buildCommitRangeStatus();
	ksort($status);
	$this->commitRangeStatusCache = $status;
	}
	return $this->commitRangeStatusCache;
	}


	/**
	* Get a list of paths affected by commits in the current commit range, or
	* uncommitted changes in the working copy. See @{method:getUncommittedStatus}
	* or @{method:getCommitRangeStatus} to retrieve smaller parts of the status.
	*
	* See @{method:getUncommittedStatus} for a description of the return value.
	*
	* @return map<string, bitmask> Map from paths to status.
	* @task status
	*/
	final public function getWorkingCopyStatus() {
	$range_status = $this->getCommitRangeStatus();
	$uncommitted_status = $this->getUncommittedStatus();

	$result = new PhutilArrayWithDefaultValue($range_status);
	foreach ($uncommitted_status as $path => $mask) {
	$result[$path] \|= $mask;
	}

	$result = $result->toArray();
	ksort($result);
	return $result;
	}


	/**
	* Drops caches after changes to the working copy. By default, some queries
	* against the working copy are cached. They
	*
	* @return $this
	* @task status
	*/
	final public function reloadWorkingCopy() {
	$this->uncommittedStatusCache = null;
	$this->commitRangeStatusCache = null;

	$this->didReloadWorkingCopy();
	$this->reloadCommitRange();

	return $this;
	}


	/**
	* Hook for implementations to dirty working copy caches after the working
	* copy has been updated.
	*
	* @return void
	* @task status
	*/
	protected function didReloadWorkingCopy() {
	return;
	}


	/**
	* Fetches the original file data for each path provided.
	*
	* @return map<string, string> Map from path to file data.
	*/
	public function getBulkOriginalFileData($paths) {
	$filedata = array();
	foreach ($paths as $path) {
	$filedata[$path] = $this->getOriginalFileData($path);
	}

	return $filedata;
	}

	/**
	* Fetches the current file data for each path provided.
	*
	* @return map<string, string> Map from path to file data.
	*/
	public function getBulkCurrentFileData($paths) {
	$filedata = array();
	foreach ($paths as $path) {
	$filedata[$path] = $this->getCurrentFileData($path);
	}

	return $filedata;
	}

	/**
	* @return Traversable
	*/
	abstract public function getAllFiles();

	abstract public function getBlame($path);

	abstract public function getRawDiffText($path);
	abstract public function getOriginalFileData($path);
	abstract public function getCurrentFileData($path);
	abstract public function getLocalCommitInformation();
	abstract public function getSourceControlBaseRevision();
	abstract public function getCanonicalRevisionName($string);
	abstract public function getBranchName();
	abstract public function getSourceControlPath();
	abstract public function isHistoryDefaultImmutable();
	abstract public function supportsAmend();
	abstract public function getWorkingCopyRevision();
	abstract public function updateWorkingCopy();
	abstract public function getMetadataPath();
	abstract public function loadWorkingCopyDifferentialRevisions(
	ConduitClient $conduit,
	array $query);
	abstract public function getRemoteURI();

	public function getChangedFiles($since_commit) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function getAuthor() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function addToCommit(array $paths) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	abstract public function supportsLocalCommits();

	public function doCommit($message) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function amendCommit($message = null) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function getBaseCommitRef() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function hasLocalCommit($commit) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function getCommitMessage($commit) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function getCommitSummary($commit) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function getAllLocalChanges() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function getFinalizedRevisionMessage() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function execxLocal($pattern /* , ... */) {
	$args = func_get_args();
	return $this->buildLocalFuture($args)->resolvex();
	}

	public function execManualLocal($pattern /* , ... */) {
	$args = func_get_args();
	return $this->buildLocalFuture($args)->resolve();
	}

	public function execFutureLocal($pattern /* , ... */) {
	$args = func_get_args();
	return $this->buildLocalFuture($args);
	}

	abstract protected function buildLocalFuture(array $argv);

	public function canStashChanges() {
	return false;
	}

	public function stashChanges() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function unstashChanges() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	/* -( Scratch Files )------------------------------------------------------ */


	/**
	* Try to read a scratch file, if it exists and is readable.
	*
	* @param string $path Scratch file name.
	* @return mixed String for file contents, or false for failure.
	* @task scratch
	*/
	public function readScratchFile($path) {
	$full_path = $this->getScratchFilePath($path);
	if (!$full_path) {
	return false;
	}

	if (!Filesystem::pathExists($full_path)) {
	return false;
	}

	try {
	$result = Filesystem::readFile($full_path);
	} catch (FilesystemException $ex) {
	return false;
	}

	return $result;
	}


	/**
	* Try to write a scratch file, if there's somewhere to put it and we can
	* write there.
	*
	* @param string $path Scratch file name to write.
	* @param string $data Data to write.
	* @return bool True on success, false on failure.
	* @task scratch
	*/
	public function writeScratchFile($path, $data) {
	$dir = $this->getScratchFilePath('');
	if (!$dir) {
	return false;
	}

	if (!Filesystem::pathExists($dir)) {
	try {
	Filesystem::createDirectory($dir);
	} catch (Exception $ex) {
	return false;
	}
	}

	try {
	Filesystem::writeFile($this->getScratchFilePath($path), $data);
	} catch (FilesystemException $ex) {
	return false;
	}

	return true;
	}


	/**
	* Try to remove a scratch file.
	*
	* @param string $path Scratch file name to remove.
	* @return bool True if the file was removed successfully.
	* @task scratch
	*/
	public function removeScratchFile($path) {
	$full_path = $this->getScratchFilePath($path);
	if (!$full_path) {
	return false;
	}

	try {
	Filesystem::remove($full_path);
	} catch (FilesystemException $ex) {
	return false;
	}

	return true;
	}


	/**
	* Get a human-readable description of the scratch file location.
	*
	* @param string $path Scratch file name.
	* @return mixed String, or false on failure.
	* @task scratch
	*/
	public function getReadableScratchFilePath($path) {
	$full_path = $this->getScratchFilePath($path);
	if ($full_path) {
	return Filesystem::readablePath(
	$full_path,
	$this->getPath());
	} else {
	return false;
	}
	}


	/**
	* Get the path to a scratch file, if possible.
	*
	* @param string $path Scratch file name.
	* @return mixed File path, or false on failure.
	* @task scratch
	*/
	public function getScratchFilePath($path) {
	$new_scratch_path = Filesystem::resolvePath(
	'arc',
	$this->getMetadataPath());

	static $checked = false;
	if (!$checked) {
	$checked = true;
	$old_scratch_path = $this->getPath('.arc');
	// we only want to do the migration once
	// unfortunately, people have checked in .arc directories which
	// means that the old one may get recreated after we delete it
	if (Filesystem::pathExists($old_scratch_path) &&
	!Filesystem::pathExists($new_scratch_path)) {
	Filesystem::createDirectory($new_scratch_path);
	$existing_files = Filesystem::listDirectory($old_scratch_path, true);
	foreach ($existing_files as $file) {
	$new_path = Filesystem::resolvePath($file, $new_scratch_path);
	$old_path = Filesystem::resolvePath($file, $old_scratch_path);
	Filesystem::writeFile(
	$new_path,
	Filesystem::readFile($old_path));
	}
	Filesystem::remove($old_scratch_path);
	}
	}
	return Filesystem::resolvePath($path, $new_scratch_path);
	}


	/* -( Base Commits )------------------------------------------------------- */

	abstract public function supportsCommitRanges();

	final public function setBaseCommit($symbolic_commit) {
	if (!$this->supportsCommitRanges()) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	$this->symbolicBaseCommit = $symbolic_commit;
	$this->reloadCommitRange();
	return $this;
	}

	public function setHeadCommit($symbolic_commit) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	final public function getBaseCommit() {
	if (!$this->supportsCommitRanges()) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	if ($this->resolvedBaseCommit === null) {
	$commit = $this->buildBaseCommit($this->symbolicBaseCommit);
	$this->resolvedBaseCommit = $commit;
	}

	return $this->resolvedBaseCommit;
	}

	public function getHeadCommit() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	final public function reloadCommitRange() {
	$this->resolvedBaseCommit = null;
	$this->baseCommitExplanation = null;

	$this->didReloadCommitRange();

	return $this;
	}

	protected function didReloadCommitRange() {
	return;
	}

	protected function buildBaseCommit($symbolic_commit) {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	public function getBaseCommitExplanation() {
	return $this->baseCommitExplanation;
	}

	public function setBaseCommitExplanation($explanation) {
	$this->baseCommitExplanation = $explanation;
	return $this;
	}

	public function resolveBaseCommitRule($rule, $source) {
	return null;
	}

	public function setBaseCommitArgumentRules($base_commit_argument_rules) {
	$this->baseCommitArgumentRules = $base_commit_argument_rules;
	return $this;
	}

	public function getBaseCommitArgumentRules() {
	return $this->baseCommitArgumentRules;
	}

	public function resolveBaseCommit() {
	$base_commit_rules = array(
	'runtime' => $this->getBaseCommitArgumentRules(),
	'local' => '',
	'project' => '',
	'user' => '',
	'system' => '',
	);
	$all_sources = $this->configurationManager->getConfigFromAllSources('base');

	$base_commit_rules = $all_sources + $base_commit_rules;

	$parser = new ArcanistBaseCommitParser($this);
	$commit = $parser->resolveBaseCommit($base_commit_rules);

	return $commit;
	}

	public function getRepositoryUUID() {
	return null;
	}

	final public function newFuture($pattern /* , ... */) {
	$args = func_get_args();
	return $this->buildLocalFuture($args)
	->setResolveOnError(false);
	}

	public function newPassthru($pattern /* , ... */) {
	throw new PhutilMethodNotImplementedException();
	}

	final public function execPassthru($pattern /* , ... */) {
	$args = func_get_args();

	$future = call_user_func_array(
	array($this, 'newPassthru'),
	$args);

	return $future->resolve();
	}

	final public function setRuntime(ArcanistRuntime $runtime) {
	$this->runtime = $runtime;
	return $this;
	}

	final public function getRuntime() {
	return $this->runtime;
	}

	final protected function getSymbolEngine() {
	return $this->getRuntime()->getSymbolEngine();
	}

	final public function getCurrentWorkingCopyStateRef() {
	if ($this->currentWorkingCopyStateRef === false) {
	$ref = $this->newCurrentWorkingCopyStateRef();
	$this->currentWorkingCopyStateRef = $ref;
	}

	return $this->currentWorkingCopyStateRef;
	}

	protected function newCurrentWorkingCopyStateRef() {
	$commit_ref = $this->getCurrentCommitRef();

	if (!$commit_ref) {
	return null;
	}

	return id(new ArcanistWorkingCopyStateRef())
	->setCommitRef($commit_ref);
	}

	final public function getCurrentCommitRef() {
	if ($this->currentCommitRef === false) {
	$this->currentCommitRef = $this->newCurrentCommitRef();
	}
	return $this->currentCommitRef;
	}

	protected function newCurrentCommitRef() {
	$symbols = $this->getSymbolEngine();

	$commit_symbol = $this->newCurrentCommitSymbol();

	return $symbols->loadCommitForSymbol($commit_symbol);
	}

	protected function newCurrentCommitSymbol() {
	throw new ArcanistCapabilityNotSupportedException($this);
	}

	final public function newCommitRef() {
	return new ArcanistCommitRef();
	}

	final public function newMarkerRef() {
	return new ArcanistMarkerRef();
	}

	final public function getLandEngine() {
	$engine = $this->newLandEngine();

	if ($engine) {
	$engine->setRepositoryAPI($this);
	}

	return $engine;
	}

	protected function newLandEngine() {
	return null;
	}

	final public function getWorkEngine() {
	$engine = $this->newWorkEngine();

	if ($engine) {
	$engine->setRepositoryAPI($this);
	}

	return $engine;
	}

	protected function newWorkEngine() {
	return null;
	}

	final public function getSupportedMarkerTypes() {
	return $this->newSupportedMarkerTypes();
	}

	protected function newSupportedMarkerTypes() {
	return array();
	}

	final public function newMarkerRefQuery() {
	return id($this->newMarkerRefQueryTemplate())
	->setRepositoryAPI($this);
	}

	protected function newMarkerRefQueryTemplate() {
	throw new PhutilMethodNotImplementedException();
	}

	final public function newRemoteRefQuery() {
	return id($this->newRemoteRefQueryTemplate())
	->setRepositoryAPI($this);
	}

	protected function newRemoteRefQueryTemplate() {
	throw new PhutilMethodNotImplementedException();
	}

	final public function newCommitGraphQuery() {
	return id($this->newCommitGraphQueryTemplate());
	}

	protected function newCommitGraphQueryTemplate() {
	throw new PhutilMethodNotImplementedException();
	}

	final public function getDisplayHash($hash) {
	return substr($hash, 0, 12);
	}


	final public function getNormalizedURI($uri) {
	$normalized_uri = $this->newNormalizedURI($uri);
	return $normalized_uri->getNormalizedURI();
	}

	protected function newNormalizedURI($uri) {
	return $uri;
	}

	final public function getPublishedCommitHashes() {
	return $this->newPublishedCommitHashes();
	}

	protected function newPublishedCommitHashes() {
	return array();
	}

	final public function getGraph() {
	if (!$this->graph) {
	$this->graph = id(new ArcanistCommitGraph())
	->setRepositoryAPI($this);
	}

	return $this->graph;
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Thu, Dec 19, 17:00 (22 h, 18 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1014848
Default Alt Text: ArcanistRepositoryAPI.php (20 KB)

ArcanistRepositoryAPI.phpNo OneTemporaryActions

ArcanistRepositoryAPI.phpView Options

File Metadata

Event Timeline

ArcanistRepositoryAPI.php
No OneTemporary
Actions

ArcanistRepositoryAPI.php
View Options