DiffusionQueryConduitAPIMethod.php
36e2d02d6ec5stable

DiffusionQueryConduitAPIMethod.php
View Options

			<?php

			abstract class DiffusionQueryConduitAPIMethod
			extends DiffusionConduitAPIMethod {

			public function shouldAllowPublic() {
			return true;
			}

			public function getMethodStatus() {
			return self::METHOD_STATUS_UNSTABLE;
			}

			public function getMethodStatusDescription() {
			return pht(
			'See T2784 - migrating Diffusion working copy calls to conduit methods. '.
			'Until that task is completed (and possibly after) these methods are '.
			'unstable.');
			}

			private $diffusionRequest;
			private $repository;

			protected function setDiffusionRequest(DiffusionRequest $request) {
			$this->diffusionRequest = $request;
			return $this;
			}

			protected function getDiffusionRequest() {
			return $this->diffusionRequest;
			}

			protected function getRepository(ConduitAPIRequest $request) {
			return $this->getDiffusionRequest()->getRepository();
			}

			final protected function defineErrorTypes() {
			return $this->defineCustomErrorTypes() +
			array(
			'ERR-UNKNOWN-REPOSITORY' =>
			pht('There is no repository with that callsign.'),
			'ERR-UNKNOWN-VCS-TYPE' =>
			pht('Unknown repository VCS type.'),
			'ERR-UNSUPPORTED-VCS' =>
			pht('VCS is not supported for this method.'),
			);
			}

			/**
			* Subclasses should override this to specify custom error types.
			*/
			protected function defineCustomErrorTypes() {
			return array();
			}

			final protected function defineParamTypes() {
			return $this->defineCustomParamTypes() +
			array(
			'callsign' => 'required string',
			'branch' => 'optional string',
			);
			}

			/**
			* Subclasses should override this to specify custom param types.
			*/
			protected function defineCustomParamTypes() {
			return array();
			}

			/**
			* Subclasses should override these methods with the proper result for the
			* pertinent version control system, e.g. getGitResult for Git.
			*
			* If the result is not supported for that VCS, do not implement it. e.g.
			* Subversion (SVN) does not support branches.
			*/
			protected function getGitResult(ConduitAPIRequest $request) {
			throw new ConduitException('ERR-UNSUPPORTED-VCS');
			}
			protected function getSVNResult(ConduitAPIRequest $request) {
			throw new ConduitException('ERR-UNSUPPORTED-VCS');
			}
			protected function getMercurialResult(ConduitAPIRequest $request) {
			throw new ConduitException('ERR-UNSUPPORTED-VCS');
			}

			/**
			* This method is final because most queries will need to construct a
			* @{class:DiffusionRequest} and use it. Consolidating this codepath and
			* enforcing @{method:getDiffusionRequest} works when we need it is good.
			*
			* @{method:getResult} should be overridden by subclasses as necessary, e.g.
			* there is a common operation across all version control systems that
			* should occur after @{method:getResult}, like formatting a timestamp.
			*/
			final protected function execute(ConduitAPIRequest $request) {
			$drequest = DiffusionRequest::newFromDictionary(
			array(
			'user' => $request->getUser(),
			'callsign' => $request->getValue('callsign'),
			'branch' => $request->getValue('branch'),
			'path' => $request->getValue('path'),
			'commit' => $request->getValue('commit'),
			));

			// Figure out whether we're going to handle this request on this device,
			// or proxy it to another node in the cluster.

			// If this is a cluster request and we need to proxy, we'll explode here
			// to prevent infinite recursion.

			$is_cluster_request = $request->getIsClusterRequest();

			$repository = $drequest->getRepository();
			$client = $repository->newConduitClient(
			$request->getUser(),
			$is_cluster_request);
			if ($client) {
			// We're proxying, so just make an intracluster call.
			return $client->callMethodSynchronous(
			$this->getAPIMethodName(),
			$request->getAllParameters());
			} else {

			// We pass this flag on to prevent proxying of any other Conduit calls
			// which we need to make in order to respond to this one. Although we
			// could safely proxy them, we take a big performance hit in the common
			// case, and doing more proxying wouldn't exercise any additional code so
			// we wouldn't gain a testability/predictability benefit.
			$drequest->setIsClusterRequest($is_cluster_request);

			$this->setDiffusionRequest($drequest);

			return $this->getResult($request);
			}
			}

			protected function getResult(ConduitAPIRequest $request) {
			$repository = $this->getRepository($request);
			$result = null;
			switch ($repository->getVersionControlSystem()) {
			case PhabricatorRepositoryType::REPOSITORY_TYPE_GIT:
			$result = $this->getGitResult($request);
			break;
			case PhabricatorRepositoryType::REPOSITORY_TYPE_MERCURIAL:
			$result = $this->getMercurialResult($request);
			break;
			case PhabricatorRepositoryType::REPOSITORY_TYPE_SVN:
			$result = $this->getSVNResult($request);
			break;
			default:
			throw new ConduitException('ERR-UNKNOWN-VCS-TYPE');
			break;
			}
			return $result;
			}

			}

phab/src/applications/diffusion/conduit/DiffusionQueryConduitAPIMethod.php36e2d02d6ec5stable

DiffusionQueryConduitAPIMethod.phpView Options

phab/src/applications/diffusion/conduit/DiffusionQueryConduitAPIMethod.php
36e2d02d6ec5stable

DiffusionQueryConduitAPIMethod.php
View Options