Differential D25033 Diff 86 src/workflow/ArcanistPackagesWorkflow.php

Changeset View

Standalone View

src/workflow/ArcanistPackagesWorkflow.php

This file was added.

				<?php

				final class ArcanistPackagesWorkflow extends ArcanistWorkflow {

				public function supportsToolset(ArcanistToolset $toolset) {
				return true;
				}

				public function getWorkflowName() {
				return 'packages';
				}

				public function getWorkflowInformation() {
				$help = pht(<<<EOTEXT
				Supports: cli
				When used with no arguments, lists available and configured packages.

				WARNING: this workflow is highly unstable. Just ignore it for now.
				EOTEXT
				);
				return $this->newWorkflowInformation()
				->setSynopsis(pht('Manage Extension Packages'))
				->addExample(pht('packages'))
				->addExample(pht('packages --install-from-tgz __file__'))
				->setHelp($help);
				}

				public function getWorkflowArguments() {
				return array(
				$this->newWorkflowArgument('install-from-tgz')
				->setParameter('package_archive')
				->setHelp(pht('UNSTABLE: Install package from an archive')),
				);
				}

				public function runWorkflow() {
				$fromtar = $this->getArgument('install-from-tgz');
				if ($fromtar !== null) {
				$this->runInstallFromTar($fromtar);
				return;
				}

				$this->runListPackagesWorkflow();
				}

				private function runInstallFromTar($tar_file) {
				Filesystem::assertReadable($tar_file);
				Filesystem::assertIsFile($tar_file);

				list($stdout, $stderr) = execx(
				'tar -x -z -O -f %s ./.arcpackage',
				$tar_file);
				$manifest = phutil_json_decode($stdout);
				$descriptor = ArcanistPackageDescriptor::fromManifest($manifest);

				$dir = $this->resolvePath($descriptor);
				if (Filesystem::pathExists($dir)) {
				throw new ArcanistUsageException(
				pht('this package already installed at %s', $dir));
				}

				Filesystem::createDirectory($dir, 0755, true);
				execx('tar -x -z -f %s -C %s', $tar_file, $dir);
				}

				private function runListPackagesWorkflow() {
				$console = PhutilConsole::getConsole();

				$loader = id(new ArcanistPackagesLoader())
				->setConfigurationSourceList($this->getConfigurationSourceList());

				$configured = $loader->listRequestedPackages();
				$configured = mpull($configured, null, 'getDirectoryName');

				$installed = $loader->listInstalledPackages();
				$installed = mpull($installed, null, 'getDirectoryName');

				$report = array();

				foreach ($configured as $key => $descriptor) {
				$report[$key] = array(
				'descriptor' => $descriptor,
				'status' => 'requested',
				);
				}

				foreach ($installed as $key => $descriptor) {
				if (array_key_exists($key, $report)) {
				$report[$key]['status'] = 'loaded';
				$report[$key]['descriptor']->setDescription(
				$descriptor->getDescription());
				} else {
				$report[$key] = array(
				'descriptor' => $descriptor,
				'status' => 'installed',
				);
				}
				}

				$color_map = array(
				'loaded' => 'green',
				'installed' => 'yellow',
				'requested' => 'red',
				);
				$text_map = $this->getPackageStatusMap();

				ksort($report);

				foreach ($report as $ident => $package) {
				$status = $package['status'];
				$color = $color_map[$status];
				$text = $text_map[$status];

				$descriptor = $package['descriptor'];

				$description = $descriptor->getDescription();
				if (!strlen($description)) {
				$description = pht('Mystery package');
				}
				$config_text = null;
				$config_source = $descriptor->getConfigSource();
				if ($config_source) {
				$config_text = pht(
				'(Requested at %s)',
				$config_source->getSourceDisplayName());
				}
				$console->writeOut(
				"<bg:".$color."> %s </bg> %s %s (%s) %s\n",
				$text,
				$descriptor->getIdentifier(),
				$descriptor->getVersion(),
				$description,
				$config_text);
				}
				}

				private function loadConfiguredPackages() {
				$items = $this->getConfigurationSourceList()
				->getStorageValueList('packages');

				$packages = array();
				foreach ($items as $item) {
				foreach ($item->getValue() as $package_item) {
				$packages[] = $package_item + array(
				'config-source' => $item->getConfigurationSource(),
				);
				}
				}
				return $packages;
				}

				/**
				* Get human-readable statuses, padded to fixed width.
				*
				* @return map<string, string> Human-readable status names.
				*/
				// TODO this function is copied from Linters workflow
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				private function getPackageStatusMap() {
				$text_map = array(
				'loaded' => pht('LOADED'),
				'installed' => pht('AVAILABLE'),
				'requested' => pht('MISSING'),
				);

				$sizes = array();
				foreach ($text_map as $key => $string) {
				$sizes[$key] = phutil_utf8_console_strlen($string);
				}

				$longest = max($sizes);
				foreach ($text_map as $key => $string) {
				if ($sizes[$key] < $longest) {
				$text_map[$key] .= str_repeat(' ', $longest - $sizes[$key]);
				}
				}

				$text_map['padding'] = str_repeat(' ', $longest);

				return $text_map;
				}

				// TODO these 2 are copy-pasted from ArcanistPackagesLoader
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				private function resolvePath(ArcanistPackageDescriptor $package) {
				return $this->getPackagesDirectory().'/'.$package->getDirectoryName();
				}

				private function getPackagesDirectory() {
				if (phutil_is_windows()) {
				return getenv('APPDATA').'/.cache/arcanist-packages';
				}
				return getenv('HOME').'/.cache/arcanist-packages';
				}
				}