Differential D20998 Diff 50032 src/toolset/workflow/ArcanistGetConfigWorkflow.php

Changeset View

Standalone View

src/toolset/workflow/ArcanistGetConfigWorkflow.php

This file was added.

				<?php

				/**
				* Read configuration settings.
				*/
				final class ArcanistGetConfigWorkflow
				extends ArcanistWorkflow {

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

				public function getWorkflowName() {
				return 'get-config';
				}

				public function getWorkflowInformation() {
				$help = pht(<<<EOTEXT
				Read a configuration setting. With no argument, lists all settings.

				With __--verbose__, show detailed information.
				EOTEXT
				);

				return $this->newWorkflowInformation()
				->addExample('get-config [__options__] --')
				->addExample('get-config [__options__] -- __name__')
				->setHelp($help);
				}

				public function getWorkflowArguments() {
				return array(
				$this->newWorkflowArgument('verbose')
				->setHelp(
				pht('Show detailed information about settings.')),
				$this->newWorkflowArgument('argv')
				->setWildcard(true),
				);
				}

				public function runWorkflow() {
				$argv = $this->getArgument('argv');
				$is_verbose = $this->getArgument('verbose');

				if (count($argv) > 1) {
				throw new ArcanistUsageException(
				pht(
				'Specify at most one setting name to read.'));
				}

				$source_list = $this->getConfigurationSourceList();
				$config_engine = $this->getConfigurationEngine();

				$options_map = $config_engine->newConfigOptionsMap();

				$all_keys = array();
				$alias_map = array();
				foreach ($options_map as $key => $config_option) {
				$all_keys[$key] = $key;
				foreach ($config_option->getAliases() as $alias) {
				$alias_map[$alias] = $key;
				}
				}

				foreach ($source_list->getSources() as $source) {
				foreach ($source->getAllKeys() as $key) {
				$all_keys[$key] = $key;
				}
				}

				ksort($all_keys);

				$defaults_map = $config_engine->newDefaults();

				foreach ($all_keys as $key) {
				$option = idx($options_map, $key);

				if ($option) {
				$option_summary = $option->getSummary();
				$option_help = $option->getHelp();
				} else {
				$option_summary = pht('(This option is unrecognized.)');
				$option_help = $option_summary;
				}

				if ($option) {
				$formatter = $option;
				} else {
				$formatter = new ArcanistWildConfigOption();
				}

				if (!$is_verbose) {
				echo tsprintf(
				"%s\n%R\n\n",
				$key,
				$option_summary);
				} else {
				echo tsprintf(
				"%s\n\n%R\n\n",
				$key,
				$option_help);
				}

				// TODO: Allow options to specify that we can't render values, replacing
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				// everything. Currently, "aliases" prints out "run aliases" over and
				// over again when listing every source. It would be cleaner to print
				// one block of help and then more useful summaries (like just the
				// aliases each source defines).

				// NOTE: We can only get configuration from a SourceList if the option is
				// a recognized option, so skip this part if the option isn't known.
				if ($option) {
				$value = $source_list->getConfig($key);
				$display_value = $formatter->getDisplayValueFromValue($value);

				echo tsprintf("%s: %s\n", pht('Value'), $display_value);

				$default_value = idx($defaults_map, $key);
				$display_default = $formatter->getDisplayValueFromValue($default_value);

				echo tsprintf("%s: %s\n", pht('Default'), $display_default);
				}

				foreach ($source_list->getSources() as $source) {
				if ($source->hasValueForKey($key)) {
				$source_value = $source->getValueForKey($key);
				$source_value = $formatter->getValueFromStorageValue($source_value);
				$source_display = $formatter->getDisplayValueFromValue($source_value);
				} else {
				$source_display = pht('-');
				}

				echo tsprintf(
				"%s: %s\n",
				$source->getSourceDisplayName(),
				$source_display);
				}
				}

				// if (!$verbose) {
				// $console->writeOut(
				// "(%s)\n",
				// pht('Run with %s for more details.', '--verbose'));
				// }

				return 0;
				}

				}