Connector::getFirstRevision() - Code Metrics - Inspection of "The credentials are now removed from working copy..." - console-helpers/svn-buddy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ccece4...e46910 )

by Alexander

created 2016-04-24 11:18 UTC

Connector::getFirstRevision() A

↳ Parent: Connector

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	0
cts	5
cp	0
rs	9.4285
cc	2
eloc	5
nc	2
nop	1
crap	6

<?php
/**
 * This file is part of the SVN-Buddy library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <[email protected]>
 * @link      https://github.com/console-helpers/svn-buddy
 */

namespace ConsoleHelpers\SVNBuddy\Repository\Connector;


use ConsoleHelpers\ConsoleKit\ConsoleIO;
use ConsoleHelpers\SVNBuddy\Cache\CacheManager;
use ConsoleHelpers\ConsoleKit\Config\ConfigEditor;
use ConsoleHelpers\SVNBuddy\Exception\RepositoryCommandException;
use ConsoleHelpers\SVNBuddy\Process\IProcessFactory;

/**
 * Executes command on the repository.
 */
class Connector
{

	const STATUS_UNVERSIONED = 'unversioned';

	const URL_REGEXP = '#([\w]*)://([^@\s\']+@)?([^/:\s\']+)(:\d+)?([^\s\']*)?#';

	/**
	 * Reference to configuration.
	 *
	 * @var ConfigEditor
	 */
	private $_configEditor;

	/**
	 * Process factory.
	 *
	 * @var IProcessFactory
	 */
	private $_processFactory;

	/**
	 * Console IO.
	 *
	 * @var ConsoleIO
	 */
	private $_io;

	/**
	 * Cache manager.
	 *
	 * @var CacheManager
	 */
	private $_cacheManager;

	/**
	 * Path to an svn command.
	 *
	 * @var string
	 */
	private $_svnCommand = 'svn';

	/**
	 * Cache duration for next invoked command.
	 *
	 * @var mixed
	 */
	private $_nextCommandCacheDuration = null;

	/**
	 * Whatever to cache last repository revision or not.
	 *
	 * @var mixed
	 */
	private $_lastRevisionCacheDuration = null;

	/**
	 * Creates repository connector.
	 *
	 * @param ConfigEditor    $config_editor   ConfigEditor.
	 * @param IProcessFactory $process_factory Process factory.
	 * @param ConsoleIO       $io              Console IO.
	 * @param CacheManager    $cache_manager   Cache manager.
	 */
	public function __construct(
		ConfigEditor $config_editor,
		IProcessFactory $process_factory,
		ConsoleIO $io,
		CacheManager $cache_manager
	) {
		$this->_configEditor = $config_editor;
		$this->_processFactory = $process_factory;
		$this->_io = $io;
		$this->_cacheManager = $cache_manager;

		$cache_duration = $this->_configEditor->get('repository-connector.last-revision-cache-duration');

		if ( (string)$cache_duration === '' || substr($cache_duration, 0, 1) === '0' ) {
			$cache_duration = 0;
		}

		$this->_lastRevisionCacheDuration = $cache_duration;

		$this->prepareSvnCommand();
	}

	/**
	 * Prepares static part of svn command to be used across the script.
	 *
	 * @return void
	 */
	protected function prepareSvnCommand()
	{
		$username = $this->_configEditor->get('repository-connector.username');
		$password = $this->_configEditor->get('repository-connector.password');

		$this->_svnCommand .= ' --non-interactive';

		if ( $username ) {
			$this->_svnCommand .= ' --username ' . $username;
		}

		if ( $password ) {
			$this->_svnCommand .= ' --password ' . $password;
		}
	}

	/**
	 * Builds a command.
	 *
	 * @param string      $sub_command  Sub command.
	 * @param string|null $param_string Parameter string.
	 *
	 * @return Command
	 */
	public function getCommand($sub_command, $param_string = null)
	{
		$command_line = $this->buildCommand($sub_command, $param_string);

		$command = new Command(
			$this->_processFactory->createProcess($command_line, 1200),
			$this->_io,
			$this->_cacheManager
		);

		if ( isset($this->_nextCommandCacheDuration) ) {
			$command->setCacheDuration($this->_nextCommandCacheDuration);
			$this->_nextCommandCacheDuration = null;
		}

		return $command;
	}

	/**
	 * Builds command from given arguments.
	 *
	 * @param string $sub_command  Command.
	 * @param string $param_string Parameter string.
	 *
	 * @return string
	 * @throws \InvalidArgumentException When command contains spaces.
	 */
	protected function buildCommand($sub_command, $param_string = null)
	{
		if ( strpos($sub_command, ' ') !== false ) {
			throw new \InvalidArgumentException('The "' . $sub_command . '" sub-command contains spaces.');
		}

		$command_line = $this->_svnCommand;

		if ( !empty($sub_command) ) {
			$command_line .= ' ' . $sub_command;
		}

		if ( !empty($param_string) ) {
			$command_line .= ' ' . $param_string;
		}

		$command_line = preg_replace_callback(
			'/\{([^\}]*)\}/',
			function (array $matches) {
				return escapeshellarg($matches[1]);
			},
			$command_line
		);

		return $command_line;
	}

	/**
	 * Sets cache configuration for next created command.
	 *
	 * @param mixed $cache_duration Cache duration.
	 *
	 * @return self
	 */
	public function withCache($cache_duration)
	{
		$this->_nextCommandCacheDuration = $cache_duration;

		return $this;
	}

	/**
	 * Returns property value.
	 *
	 * @param string $name        Property name.
	 * @param string $path_or_url Path to get property from.
	 * @param mixed  $revision    Revision.
	 *
	 * @return string
	 */
	public function getProperty($name, $path_or_url, $revision = null)
	{
		$param_string = $name . ' {' . $path_or_url . '}';

		if ( isset($revision) ) {
			$param_string .= ' --revision ' . $revision;
		}

		return $this->getCommand('propget', $param_string)->run();
	}

	/**
	 * Returns relative path of given path/url to the root of the repository.
	 *
	 * @param string $path_or_url Path or url.
	 *
	 * @return string
	 */
	public function getRelativePath($path_or_url)
	{
		$repository_root_url = $this->getRootUrl($path_or_url);
		$wc_url = (string)$this->_getSvnInfoEntry($path_or_url)->url;

		return preg_replace('/^' . preg_quote($repository_root_url, '/') . '/', '', $wc_url, 1);
	}

	/**
	 * Returns repository root url from given path/url.
	 *
	 * @param string $path_or_url Path or url.
	 *
	 * @return string
	 */
	public function getRootUrl($path_or_url)
	{
		return (string)$this->_getSvnInfoEntry($path_or_url)->repository->root;
	}

	/**
	 * Detects ref from given path.
	 *
	 * @param string $path Path to a file.
	 *
	 * @return string|boolean
	 */
	public function getRefByPath($path)
	{
		if ( preg_match('#^.*?/(trunk|branches/[^/]+|tags/[^/]+|releases/[^/]+).*$#', $path, $regs) ) {
			return $regs[1];
		}

		return false;
	}

	/**
	 * Returns URL of the working copy.
	 *
	 * @param string $wc_path Working copy path.
	 *
	 * @return string
	 * @throws RepositoryCommandException When repository command failed to execute.
	 */
	public function getWorkingCopyUrl($wc_path)
	{
		if ( $this->isUrl($wc_path) ) {
			return $this->removeCredentials($wc_path);
		}

		try {
			$wc_url = (string)$this->_getSvnInfoEntry($wc_path)->url;
		}
		catch ( RepositoryCommandException $e ) {
			if ( $e->getCode() == RepositoryCommandException::SVN_ERR_WC_UPGRADE_REQUIRED ) {
				$message = explode(PHP_EOL, $e->getMessage());

				$this->_io->writeln(array('', '<error>' . end($message) . '</error>', ''));

				if ( $this->_io->askConfirmation('Run "svn upgrade"', false) ) {
					$this->getCommand('upgrade', '{' . $wc_path . '}')->runLive();

					return $this->getWorkingCopyUrl($wc_path);
				}
			}

			throw $e;
		}

		return $wc_url;
	}

	/**
	 * Returns last changed revision on path/url.
	 *
	 * @param string $path_or_url Path or url.
	 *
	 * @return integer
	 */
	public function getLastRevision($path_or_url)
	{
		// Cache "svn info" commands to remote urls, not the working copy.
		$cache_duration = $this->isUrl($path_or_url) ? $this->_lastRevisionCacheDuration : null;

		return (int)$this->_getSvnInfoEntry($path_or_url, $cache_duration)->commit['revision'];
	}

	/**
	 * Determines if given path is in fact an url.
	 *
	 * @param string $path Path.
	 *
	 * @return boolean
	 */
	public function isUrl($path)
	{
		return strpos($path, '://') !== false;
	}

	/**
	 * Removes credentials from url.
	 *
	 * @param string $url URL.
	 *
	 * @return string
	 * @throws \InvalidArgumentException When non-url given.
	 */
	public function removeCredentials($url)
	{
		if ( !$this->isUrl($url) ) {
			throw new \InvalidArgumentException('Unable to remove credentials from "' . $url . '" path.');
		}

		return preg_replace('#^(.*)://(.*)@(.*)$#', '$1://$3', $url);
	}

	/**
	 * Returns project url (container for "trunk/branches/tags/releases" folders).
	 *
	 * @param string $repository_url Repository url.
	 *
	 * @return string
	 */
	public function getProjectUrl($repository_url)
	{
		if ( preg_match('#^(.*?)/(trunk|branches|tags|releases).*$#', $repository_url, $regs) ) {
			return $regs[1];
		}

		return $repository_url;
	}

	/**
	 * Returns "svn info" entry for path or url.
	 *
	 * @param string $path_or_url    Path or url.
	 * @param mixed  $cache_duration Cache duration.
	 *
	 * @return \SimpleXMLElement
	 * @throws \LogicException When unexpected 'svn info' results retrieved.
	 */
	private function _getSvnInfoEntry($path_or_url, $cache_duration = null)
	{
		// Cache "svn info" commands to remote urls, not the working copy.
		if ( !isset($cache_duration) && $this->isUrl($path_or_url) ) {
			$cache_duration = '1 year';
		}

		// Remove credentials from url, because "svn info" fails, when used on repository root.
		if ( $this->isUrl($path_or_url) ) {
			$path_or_url = $this->removeCredentials($path_or_url);
		}

		// TODO: When wc path (not url) is given, then credentials can be present in "svn info" result anyway.
		$svn_info = $this->withCache($cache_duration)->getCommand('info', '--xml {' . $path_or_url . '}')->run();

		// When getting remote "svn info", then path is last folder only.
		if ( basename($this->_getSvnInfoEntryPath($svn_info->entry)) != basename($path_or_url) ) {
			throw new \LogicException('The directory "' . $path_or_url . '" not found in "svn info" command results.');
		}

		return $svn_info->entry;
	}

	/**
	 * Returns path of "svn info" entry.
	 *
	 * @param \SimpleXMLElement $svn_info_entry The "entry" node of "svn info" command.
	 *
	 * @return string
	 */
	private function _getSvnInfoEntryPath(\SimpleXMLElement $svn_info_entry)
	{
		// SVN 1.7+.
		$path = (string)$svn_info_entry->{'wc-info'}->{'wcroot-abspath'};

		if ( $path ) {
			return $path;
		}

		// SVN 1.6-.
		return (string)$svn_info_entry['path'];
	}

	/**
	 * Returns revision, when path was added to repository.
	 *
	 * @param string $url Url.
	 *
	 * @return integer
	 * @throws \InvalidArgumentException When not an url was given.
	 */
	public function getFirstRevision($url)
	{
		if ( !$this->isUrl($url) ) {
			throw new \InvalidArgumentException('The repository URL "' . $url . '" is invalid.');
		}

		$log = $this->withCache('1 year')->getCommand('log', ' -r 1:HEAD --limit 1 --xml {' . $url . '}')->run();

		return (int)$log->logentry['revision'];
	}

	/**
	 * Returns conflicts in working copy.
	 *
	 * @param string $wc_path Working copy path.
	 *
	 * @return array
	 */
	public function getWorkingCopyConflicts($wc_path)
	{
		$ret = array();

		foreach ( $this->getWorkingCopyStatus($wc_path) as $path => $status ) {
			if ( $status['item'] == 'conflicted' || $status['props'] == 'conflicted' || $status['tree-conflicted'] ) {
				$ret[] = $path;
			}
		}

		return $ret;
	}

	/**
	 * Returns compact working copy status.
	 *
	 * @param string  $wc_path          Working copy path.
	 * @param boolean $with_unversioned With unversioned.
	 *
	 * @return string
	 */
	public function getCompactWorkingCopyStatus($wc_path, $with_unversioned = true)
	{
		$ret = array();

		foreach ( $this->getWorkingCopyStatus($wc_path) as $path => $status ) {
			if ( !$with_unversioned && $status['item'] == self::STATUS_UNVERSIONED ) {
				continue;
			}

			$line = $this->getShortItemStatus($status['item']) . $this->getShortPropertiesStatus($status['props']);
			$line .= '   ' . $path;

			$ret[] = $line;
		}

		return implode(PHP_EOL, $ret);
	}

	/**
	 * Returns short item status.
	 *
	 * @param string $status Status.
	 *
	 * @return string
	 * @throws \InvalidArgumentException When unknown status given.
	 */
	protected function getShortItemStatus($status)
	{
		$status_map = array(
			'added' => 'A',
			'conflicted' => 'C',
			'deleted' => 'D',
			'external' => 'X',
			'ignored' => 'I',
			// 'incomplete' => '',
			// 'merged' => '',
			'missing' => '!',
			'modified' => 'M',
			'none' => ' ',
			'normal' => '_',
			// 'obstructed' => '',
			'replaced' => 'R',
			'unversioned' => '?',
		);

		if ( !isset($status_map[$status]) ) {
			throw new \InvalidArgumentException('The "' . $status . '" item status is unknown.');
		}

		return $status_map[$status];
	}

	/**
	 * Returns short item status.
	 *
	 * @param string $status Status.
	 *
	 * @return string
	 * @throws \InvalidArgumentException When unknown status given.
	 */
	protected function getShortPropertiesStatus($status)
	{
		$status_map = array(
			'conflicted' => 'C',
			'modified' => 'M',
			'normal' => '_',
			'none' => ' ',
		);

		if ( !isset($status_map[$status]) ) {
			throw new \InvalidArgumentException('The "' . $status . '" properties status is unknown.');
		}

		return $status_map[$status];
	}

	/**
	 * Returns working copy status.
	 *
	 * @param string $wc_path Working copy path.
	 *
	 * @return array
	 */
	public function getWorkingCopyStatus($wc_path)
	{
		$ret = array();
		$status = $this->getCommand('status', '--xml {' . $wc_path . '}')->run();

		foreach ( $status->target as $target ) {
			if ( (string)$target['path'] !== $wc_path ) {
				continue;
			}

			foreach ( $target as $entry ) {
				$path = (string)$entry['path'];

				if ( $path === $wc_path ) {
					$path = '.';
				}
				else {
					$path = str_replace($wc_path . '/', '', $path);
				}

				$ret[$path] = array(
					'item' => (string)$entry->{'wc-status'}['item'],
					'props' => (string)$entry->{'wc-status'}['props'],
					'tree-conflicted' => (string)$entry->{'wc-status'}['tree-conflicted'] === 'true',
				);
			}
		}

		return $ret;
	}

	/**
	 * Determines if working copy contains mixed revisions.
	 *
	 * @param string $wc_path Working copy path.
	 *
	 * @return array
	 */
	public function isMixedRevisionWorkingCopy($wc_path)
	{
		$revisions = array();
		$status = $this->getCommand('status', '--xml --verbose {' . $wc_path . '}')->run();

		foreach ( $status->target as $target ) {
			if ( (string)$target['path'] !== $wc_path ) {
				continue;
			}

			foreach ( $target as $entry ) {
				$item_status = (string)$entry->{'wc-status'}['item'];

				if ( $item_status !== self::STATUS_UNVERSIONED ) {
					$revision = (int)$entry->{'wc-status'}['revision'];
					$revisions[$revision] = true;
				}
			}
		}

		return count($revisions) > 1;
	}

	/**
	 * Determines if there is a working copy on a given path.
	 *
	 * @param string $path Path.
	 *
	 * @return boolean
	 * @throws \InvalidArgumentException When path isn't found.
	 * @throws RepositoryCommandException When repository command failed to execute.
	 */

	public function isWorkingCopy($path)
	{
		if ( $this->isUrl($path) || !file_exists($path) || !is_dir($path) ) {
			throw new \InvalidArgumentException('Path "' . $path . '" not found or isn\'t a directory.');
		}

		try {
			$wc_url = $this->getWorkingCopyUrl($path);
		}
		catch ( RepositoryCommandException $e ) {
			if ( $e->getCode() == RepositoryCommandException::SVN_ERR_WC_NOT_WORKING_COPY ) {
				return false;
			}

			throw $e;
		}

		return $wc_url != '';
	}

}


1		<?php
2		/**
3		* This file is part of the SVN-Buddy library.
4		* For the full copyright and license information, please view
5		* the LICENSE file that was distributed with this source code.
6		*
7		* @copyright Alexander Obuhovich <[email protected]>
8		* @link https://github.com/console-helpers/svn-buddy
9		*/
10
11		namespace ConsoleHelpers\SVNBuddy\Repository\Connector;
12
13
14		use ConsoleHelpers\ConsoleKit\ConsoleIO;
15		use ConsoleHelpers\SVNBuddy\Cache\CacheManager;
16		use ConsoleHelpers\ConsoleKit\Config\ConfigEditor;
17		use ConsoleHelpers\SVNBuddy\Exception\RepositoryCommandException;
18		use ConsoleHelpers\SVNBuddy\Process\IProcessFactory;
19
20		/**
21		* Executes command on the repository.
22		*/
23		class Connector
24		{
25
26		const STATUS_UNVERSIONED = 'unversioned';
27
28		const URL_REGEXP = '#([\w])://([^@\s\']+@)?([^/:\s\']+)(:\d+)?([^\s\'])?#';
29
30		/**
31		* Reference to configuration.
32		*
33		* @var ConfigEditor
34		*/
35		private $_configEditor;
36
37		/**
38		* Process factory.
39		*
40		* @var IProcessFactory
41		*/
42		private $_processFactory;
43
44		/**
45		* Console IO.
46		*
47		* @var ConsoleIO
48		*/
49		private $_io;
50
51		/**
52		* Cache manager.
53		*
54		* @var CacheManager
55		*/
56		private $_cacheManager;
57
58		/**
59		* Path to an svn command.
60		*
61		* @var string
62		*/
63		private $_svnCommand = 'svn';
64
65		/**
66		* Cache duration for next invoked command.
67		*
68		* @var mixed
69		*/
70		private $_nextCommandCacheDuration = null;
71
72		/**
73		* Whatever to cache last repository revision or not.
74		*
75		* @var mixed
76		*/
77		private $_lastRevisionCacheDuration = null;
78
79		/**
80		* Creates repository connector.
81		*
82		* @param ConfigEditor $config_editor ConfigEditor.
83		* @param IProcessFactory $process_factory Process factory.
84		* @param ConsoleIO $io Console IO.
85		* @param CacheManager $cache_manager Cache manager.
86		*/
87	57	public function __construct(
88		ConfigEditor $config_editor,
89		IProcessFactory $process_factory,
90		ConsoleIO $io,
91		CacheManager $cache_manager
92		) {
93	57	$this->_configEditor = $config_editor;
94	57	$this->_processFactory = $process_factory;
95	57	$this->_io = $io;
96	57	$this->_cacheManager = $cache_manager;
97
98	57	$cache_duration = $this->_configEditor->get('repository-connector.last-revision-cache-duration');
99
100	57	if ( (string)$cache_duration === '' \|\| substr($cache_duration, 0, 1) === '0' ) {
101	4	$cache_duration = 0;
102	4	}
103
104	57	$this->_lastRevisionCacheDuration = $cache_duration;
105
106	57	$this->prepareSvnCommand();
107	57	}
108
109		/**
110		* Prepares static part of svn command to be used across the script.
111		*
112		* @return void
113		*/
114	57	protected function prepareSvnCommand()
115		{
116	57	$username = $this->_configEditor->get('repository-connector.username');
117	57	$password = $this->_configEditor->get('repository-connector.password');
118
119	57	$this->_svnCommand .= ' --non-interactive';
120
121	57	if ( $username ) {
122	15	$this->_svnCommand .= ' --username ' . $username;
123	15	}
124
125	57	if ( $password ) {
126	15	$this->_svnCommand .= ' --password ' . $password;
127	15	}
128	57	}
129
130		/**
131		* Builds a command.
132		*
133		* @param string $sub_command Sub command.
134		* @param string\|null $param_string Parameter string.
135		*
136		* @return Command
137		*/
138	32	public function getCommand($sub_command, $param_string = null)
139		{
140	32	$command_line = $this->buildCommand($sub_command, $param_string);
141
142	31	$command = new Command(
143	31	$this->_processFactory->createProcess($command_line, 1200),
144	31	$this->_io,
145	31	$this->_cacheManager
146	31	);
147
148	31	if ( isset($this->_nextCommandCacheDuration) ) {
149	11	$command->setCacheDuration($this->_nextCommandCacheDuration);
150	11	$this->_nextCommandCacheDuration = null;
151	11	}
152
153	31	return $command;
154		}
155
156		/**
157		* Builds command from given arguments.
158		*
159		* @param string $sub_command Command.
160		* @param string $param_string Parameter string.
161		*
162		* @return string
163		* @throws \InvalidArgumentException When command contains spaces.
164		*/
165	32	protected function buildCommand($sub_command, $param_string = null)
166		{
167	32	if ( strpos($sub_command, ' ') !== false ) {
168	1	throw new \InvalidArgumentException('The "' . $sub_command . '" sub-command contains spaces.');
169		}
170
171	31	$command_line = $this->_svnCommand;
172
173	31	if ( !empty($sub_command) ) {
174	26	$command_line .= ' ' . $sub_command;
175	26	}
176
177	31	if ( !empty($param_string) ) {
178	29	$command_line .= ' ' . $param_string;
179	29	}
180
181	31	$command_line = preg_replace_callback(
182	31	'/\{([^\}]*)\}/',
183	31	function (array $matches) {
184	23	return escapeshellarg($matches[1]);
185	31	},
186		$command_line
187	31	);
188
189	31	return $command_line;
190		}
191
192		/**
193		* Sets cache configuration for next created command.
194		*
195		* @param mixed $cache_duration Cache duration.
196		*
197		* @return self
198		*/
199	20	public function withCache($cache_duration)
200		{
201	20	$this->_nextCommandCacheDuration = $cache_duration;
202
203	20	return $this;
204		}
205
206		/**
207		* Returns property value.
208		*
209		* @param string $name Property name.
210		* @param string $path_or_url Path to get property from.
211		* @param mixed $revision Revision.
212		*
213		* @return string
214		*/
215	2	public function getProperty($name, $path_or_url, $revision = null)
216		{
217	2	$param_string = $name . ' {' . $path_or_url . '}';
218
219	2	if ( isset($revision) ) {
220	1	$param_string .= ' --revision ' . $revision;
221	1	}
222
223	2	return $this->getCommand('propget', $param_string)->run();
224		}
225
226		/**
227		* Returns relative path of given path/url to the root of the repository.
228		*
229		* @param string $path_or_url Path or url.
230		*
231		* @return string
232		*/
233	3	public function getRelativePath($path_or_url)
234		{
235	3	$repository_root_url = $this->getRootUrl($path_or_url);
236	3	$wc_url = (string)$this->_getSvnInfoEntry($path_or_url)->url;
237
238	3	return preg_replace('/^' . preg_quote($repository_root_url, '/') . '/', '', $wc_url, 1);
239		}
240
241		/**
242		* Returns repository root url from given path/url.
243		*
244		* @param string $path_or_url Path or url.
245		*
246		* @return string
247		*/
248	6	public function getRootUrl($path_or_url)
249		{
250	6	return (string)$this->_getSvnInfoEntry($path_or_url)->repository->root;
251		}
252
253		/**
254		* Detects ref from given path.
255		*
256		* @param string $path Path to a file.
257		*
258		* @return string\|boolean
259		*/
260	9	public function getRefByPath($path)
261		{
262	9	if ( preg_match('#^.?/(trunk\|branches/[^/]+\|tags/[^/]+\|releases/[^/]+).$#', $path, $regs) ) {
263	5	return $regs[1];
264		}
265
266	4	return false;
267		}
268
269		/**
270		* Returns URL of the working copy.
271		*
272		* @param string $wc_path Working copy path.
273		*
274		* @return string
275		* @throws RepositoryCommandException When repository command failed to execute.
276		*/
277	8	public function getWorkingCopyUrl($wc_path)
278		{
279	8	if ( $this->isUrl($wc_path) ) {
280	2	return $this->removeCredentials($wc_path);
281		}
282
283		try {
284	6	$wc_url = (string)$this->_getSvnInfoEntry($wc_path)->url;
285		}
286	6	catch ( RepositoryCommandException $e ) {
287	3	if ( $e->getCode() == RepositoryCommandException::SVN_ERR_WC_UPGRADE_REQUIRED ) {
288	2	$message = explode(PHP_EOL, $e->getMessage());
289
290	2	$this->_io->writeln(array('', '<error>' . end($message) . '</error>', ''));
291
292	2	if ( $this->_io->askConfirmation('Run "svn upgrade"', false) ) {
293	1	$this->getCommand('upgrade', '{' . $wc_path . '}')->runLive();
294
295	1	return $this->getWorkingCopyUrl($wc_path);
296		}
297	1	}
298
299	2	throw $e;
300		}
301
302	3	return $wc_url;
303		}
304
305		/**
306		* Returns last changed revision on path/url.
307		*
308		* @param string $path_or_url Path or url.
309		*
310		* @return integer
311		*/
312	7	public function getLastRevision($path_or_url)
313		{
314		// Cache "svn info" commands to remote urls, not the working copy.
315	7	$cache_duration = $this->isUrl($path_or_url) ? $this->_lastRevisionCacheDuration : null;
316
317	7	return (int)$this->_getSvnInfoEntry($path_or_url, $cache_duration)->commit['revision'];
318		}
319
320		/**
321		* Determines if given path is in fact an url.
322		*
323		* @param string $path Path.
324		*
325		* @return boolean
326		*/
327	24	public function isUrl($path)
328		{
329	24	return strpos($path, '://') !== false;
330		}
331
332		/**
333		* Removes credentials from url.
334		*
335		* @param string $url URL.
336		*
337		* @return string
338		* @throws \InvalidArgumentException When non-url given.
339		*/
340	15	public function removeCredentials($url)
341		{
342	15	if ( !$this->isUrl($url) ) {
343	1	throw new \InvalidArgumentException('Unable to remove credentials from "' . $url . '" path.');
344		}
345
346	14	return preg_replace('#^(.)://(.)@(.*)$#', '$1://$3', $url);
347		}
348
349		/**
350		* Returns project url (container for "trunk/branches/tags/releases" folders).
351		*
352		* @param string $repository_url Repository url.
353		*
354		* @return string
355		*/
356	9	public function getProjectUrl($repository_url)
357		{
358	9	if ( preg_match('#^(.?)/(trunk\|branches\|tags\|releases).$#', $repository_url, $regs) ) {
359	8	return $regs[1];
360		}
361
362	1	return $repository_url;
363		}
364
365		/**
366		* Returns "svn info" entry for path or url.
367		*
368		* @param string $path_or_url Path or url.
369		* @param mixed $cache_duration Cache duration.
370		*
371		* @return \SimpleXMLElement
372		* @throws \LogicException When unexpected 'svn info' results retrieved.
373		*/
374	19	private function _getSvnInfoEntry($path_or_url, $cache_duration = null)
375		{
376		// Cache "svn info" commands to remote urls, not the working copy.
377	19	if ( !isset($cache_duration) && $this->isUrl($path_or_url) ) {
378	4	$cache_duration = '1 year';
379	4	}
380
381		// Remove credentials from url, because "svn info" fails, when used on repository root.
382	19	if ( $this->isUrl($path_or_url) ) {
383	10	$path_or_url = $this->removeCredentials($path_or_url);
384	10	}
385
386		// TODO: When wc path (not url) is given, then credentials can be present in "svn info" result anyway.
387	19	$svn_info = $this->withCache($cache_duration)->getCommand('info', '--xml {' . $path_or_url . '}')->run();
388
389		// When getting remote "svn info", then path is last folder only.
390	17	if ( basename($this->_getSvnInfoEntryPath($svn_info->entry)) != basename($path_or_url) ) {
391	1	throw new \LogicException('The directory "' . $path_or_url . '" not found in "svn info" command results.');
392		}
393
394	16	return $svn_info->entry;
395		}
396
397		/**
398		* Returns path of "svn info" entry.
399		*
400		* @param \SimpleXMLElement $svn_info_entry The "entry" node of "svn info" command.
401		*
402		* @return string
403		*/
404	17	private function _getSvnInfoEntryPath(\SimpleXMLElement $svn_info_entry)
405		{
406		// SVN 1.7+.
407	17	$path = (string)$svn_info_entry->{'wc-info'}->{'wcroot-abspath'};
408
409	17	if ( $path ) {
410	1	return $path;
411		}
412
413		// SVN 1.6-.
414	16	return (string)$svn_info_entry['path'];
415		}
416
417		/**
418		* Returns revision, when path was added to repository.
419		*
420		* @param string $url Url.
421		*
422		* @return integer
423		* @throws \InvalidArgumentException When not an url was given.
424		*/
425		public function getFirstRevision($url)
426		{
427		if ( !$this->isUrl($url) ) {
428		throw new \InvalidArgumentException('The repository URL "' . $url . '" is invalid.');
429		}
430
431		$log = $this->withCache('1 year')->getCommand('log', ' -r 1:HEAD --limit 1 --xml {' . $url . '}')->run();
432
433		return (int)$log->logentry['revision'];
434		}
435
436		/**
437		* Returns conflicts in working copy.
438		*
439		* @param string $wc_path Working copy path.
440		*
441		* @return array
442		*/
443		public function getWorkingCopyConflicts($wc_path)
444		{
445		$ret = array();
446
447		foreach ( $this->getWorkingCopyStatus($wc_path) as $path => $status ) {
448		if ( $status['item'] == 'conflicted' \|\| $status['props'] == 'conflicted' \|\| $status['tree-conflicted'] ) {
449		$ret[] = $path;
450		}
451		}
452
453		return $ret;
454		}
455
456		/**
457		* Returns compact working copy status.
458		*
459		* @param string $wc_path Working copy path.
460		* @param boolean $with_unversioned With unversioned.
461		*
462		* @return string
463		*/
464		public function getCompactWorkingCopyStatus($wc_path, $with_unversioned = true)
465		{
466		$ret = array();
467
468		foreach ( $this->getWorkingCopyStatus($wc_path) as $path => $status ) {
469		if ( !$with_unversioned && $status['item'] == self::STATUS_UNVERSIONED ) {
470		continue;
471		}
472
473		$line = $this->getShortItemStatus($status['item']) . $this->getShortPropertiesStatus($status['props']);
474		$line .= ' ' . $path;
475
476		$ret[] = $line;
477		}
478
479		return implode(PHP_EOL, $ret);
480		}
481
482		/**
483		* Returns short item status.
484		*
485		* @param string $status Status.
486		*
487		* @return string
488		* @throws \InvalidArgumentException When unknown status given.
489		*/
490		protected function getShortItemStatus($status)
491		{
492		$status_map = array(
493		'added' => 'A',
494		'conflicted' => 'C',
495		'deleted' => 'D',
496		'external' => 'X',
497		'ignored' => 'I',
498		// 'incomplete' => '',
499		// 'merged' => '',
500		'missing' => '!',
501		'modified' => 'M',
502		'none' => ' ',
503		'normal' => '_',
504		// 'obstructed' => '',
505		'replaced' => 'R',
506		'unversioned' => '?',
507		);
508
509		if ( !isset($status_map[$status]) ) {
510		throw new \InvalidArgumentException('The "' . $status . '" item status is unknown.');
511		}
512
513		return $status_map[$status];
514		}
515
516		/**
517		* Returns short item status.
518		*
519		* @param string $status Status.
520		*
521		* @return string
522		* @throws \InvalidArgumentException When unknown status given.
523		*/
524		protected function getShortPropertiesStatus($status)
525		{
526		$status_map = array(
527		'conflicted' => 'C',
528		'modified' => 'M',
529		'normal' => '_',
530		'none' => ' ',
531		);
532
533		if ( !isset($status_map[$status]) ) {
534		throw new \InvalidArgumentException('The "' . $status . '" properties status is unknown.');
535		}
536
537		return $status_map[$status];
538		}
539
540		/**
541		* Returns working copy status.
542		*
543		* @param string $wc_path Working copy path.
544		*
545		* @return array
546		*/
547		public function getWorkingCopyStatus($wc_path)
548		{
549		$ret = array();
550		$status = $this->getCommand('status', '--xml {' . $wc_path . '}')->run();
551
552		foreach ( $status->target as $target ) {
553		if ( (string)$target['path'] !== $wc_path ) {
554		continue;
555		}
556
557		foreach ( $target as $entry ) {
558		$path = (string)$entry['path'];
559
560		if ( $path === $wc_path ) {
561		$path = '.';
562		}
563		else {
564		$path = str_replace($wc_path . '/', '', $path);
565		}
566
567		$ret[$path] = array(
568		'item' => (string)$entry->{'wc-status'}['item'],
569		'props' => (string)$entry->{'wc-status'}['props'],
570		'tree-conflicted' => (string)$entry->{'wc-status'}['tree-conflicted'] === 'true',
571		);
572		}
573		}
574
575		return $ret;
576		}
577
578		/**
579		* Determines if working copy contains mixed revisions.
580		*
581		* @param string $wc_path Working copy path.
582		*
583		* @return array
584		*/
585		public function isMixedRevisionWorkingCopy($wc_path)
586		{
587		$revisions = array();
588		$status = $this->getCommand('status', '--xml --verbose {' . $wc_path . '}')->run();
589
590		foreach ( $status->target as $target ) {
591		if ( (string)$target['path'] !== $wc_path ) {
592		continue;
593		}
594
595		foreach ( $target as $entry ) {
596		$item_status = (string)$entry->{'wc-status'}['item'];
597
598		if ( $item_status !== self::STATUS_UNVERSIONED ) {
599		$revision = (int)$entry->{'wc-status'}['revision'];
600		$revisions[$revision] = true;
601		}
602		}
603		}
604
605		return count($revisions) > 1;
606		}
607
608		/**
609		* Determines if there is a working copy on a given path.
610		*
611		* @param string $path Path.
612		*
613		* @return boolean
614		* @throws \InvalidArgumentException When path isn't found.
615		* @throws RepositoryCommandException When repository command failed to execute.
616		*/
		1 ignored issue – show Coding Style introduced 2016-02-15 22:15 UTC by Report Bug Copy Issue Report Expected 1 @throws tag(s) in function comment; 2 found Loading history...
617		public function isWorkingCopy($path)
618		{
619		if ( $this->isUrl($path) \|\| !file_exists($path) \|\| !is_dir($path) ) {
620		throw new \InvalidArgumentException('Path "' . $path . '" not found or isn\'t a directory.');
621		}
622
623		try {
624		$wc_url = $this->getWorkingCopyUrl($path);
625		}
626		catch ( RepositoryCommandException $e ) {
627		if ( $e->getCode() == RepositoryCommandException::SVN_ERR_WC_NOT_WORKING_COPY ) {
628		return false;
629		}
630
631		throw $e;
632		}
633
634		return $wc_url != '';
635		}
636
637		}
638

console-helpers / svn-buddy

Push — master ( ccece4...e46910 )

Connector::getFirstRevision() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like