ArcanistSettings.php
No OneTemporary
Actions

Size

9 KB

Referenced Files

None

Subscribers

None

ArcanistSettings.php
View Options

	<?php

	final class ArcanistSettings extends Phobject {

	private function getOptions() {
	$legacy_builtins = array(
	'default' => array(
	'type' => 'string',
	'help' => pht(
	'The URI of a server to connect to by default, if '.
	'%s is run in a project without a configured URI or run outside '.
	'of a project.',
	'arc'),
	'example' => '"http://devtools.example.com/"',
	),
	'base' => array(
	'type' => 'string',
	'help' => pht(
	'Base commit ruleset to invoke when determining the start of a '.
	'commit range. See "Arcanist User Guide: Commit Ranges" for '.
	'details.'),
	'example' => '"arc:amended, arc:prompt"',
	),
	'load' => array(
	'type' => 'list',
	'legacy' => 'phutil_libraries',
	'help' => pht(
	'A list of paths to phutil libraries that should be loaded at '.
	'startup. This can be used to make classes available, like lint '.
	'or unit test engines.'),
	'default' => array(),
	'example' => '["/var/arc/customlib/src"]',
	),
	'repository.callsign' => array(
	'type' => 'string',
	'example' => '"X"',
	'help' => pht(
	'Associate the working copy with a specific repository. '.
	'Normally, %s can figure this association out on its own, but if '.
	'your setup is unusual you can use this option to tell it what the '.
	'desired value is.',
	'arc'),
	),
	'phabricator.uri' => array(
	'type' => 'string',
	'legacy' => 'conduit_uri',
	'example' => '"https://devtools.example.com/"',
	'help' => pht(
	'Associates this working copy with a specific server.'),
	),
	'lint.engine' => array(
	'type' => 'string',
	'legacy' => 'lint_engine',
	'help' => pht(
	'The name of a default lint engine to use, if no lint engine is '.
	'specified by the current project.'),
	'example' => '"ExampleLintEngine"',
	),
	'unit.engine' => array(
	'type' => 'string',
	'legacy' => 'unit_engine',
	'help' => pht(
	'The name of a default unit test engine to use, if no unit test '.
	'engine is specified by the current project.'),
	'example' => '"ExampleUnitTestEngine"',
	),
	'arc.land.onto.default' => array(
	'type' => 'string',
	'help' => pht(
	'The name of the default branch to land changes onto when '.
	'`%s` is run.',
	'arc land'),
	'example' => '"develop"',
	),
	'history.immutable' => array(
	'type' => 'bool',
	'legacy' => 'immutable_history',
	'help' => pht(
	'If true, %s will never change repository history (e.g., through '.
	'amending or rebasing). Defaults to true in Mercurial and false in '.
	'Git. This setting has no effect in Subversion.',
	'arc'),
	'example' => 'false',
	),
	'editor' => array(
	'type' => 'string',
	'help' => pht(
	'Command to use to invoke an interactive editor, like `%s` or `%s`. '.
	'This setting overrides the %s environmental variable.',
	'nano',
	'vim',
	'EDITOR'),
	'example' => '"nano"',
	),
	'https.cabundle' => array(
	'type' => 'string',
	'help' => pht(
	"Path to a custom CA bundle file to be used for cURL calls. ".
	"This is used primarily when your conduit endpoint is ".
	"behind HTTPS signed by your organization's internal CA."),
	'example' => 'support/yourca.pem',
	),
	'browser' => array(
	'type' => 'string',
	'help' => pht('Command to use to invoke a web browser.'),
	'example' => '"gnome-www-browser"',
	),
	'events.listeners' => array(
	'type' => 'list',
	'help' => pht('List of event listener classes to install at startup.'),
	'default' => array(),
	'example' => '["ExampleEventListener"]',
	),
	'arc.autostash' => array(
	'type' => 'bool',
	'help' => pht(
	'Whether %s should permit the automatic stashing of changes in the '.
	'working directory when requiring a clean working copy. This option '.
	'should only be used when users understand how to restore their '.
	'working directory from the local stash if an operation '.
	'causes an unrecoverable error.',
	'arc'),
	'default' => false,
	'example' => 'false',
	),
	'aliases' => array(
	'type' => 'aliases',
	'help' => pht(
	'Configured command aliases. Use "arc alias" to define aliases.'),
	),
	);

	$settings = ArcanistSetting::getAllSettings();
	foreach ($settings as $key => $setting) {
	$settings[$key] = $setting->getLegacyDictionary();
	}

	$results = $settings + $legacy_builtins;
	ksort($results);

	return $results;
	}

	private function getOption($key) {
	return idx($this->getOptions(), $key, array());
	}

	public function getAllKeys() {
	return array_keys($this->getOptions());
	}

	public function getHelp($key) {
	return idx($this->getOption($key), 'help');
	}

	public function getExample($key) {
	return idx($this->getOption($key), 'example');
	}

	public function getType($key) {
	return idx($this->getOption($key), 'type', 'wild');
	}

	public function getLegacyName($key) {
	return idx($this->getOption($key), 'legacy');
	}

	public function getDefaultSettings() {
	$defaults = array();
	foreach ($this->getOptions() as $key => $option) {
	if (array_key_exists('default', $option)) {
	$defaults[$key] = $option['default'];
	}
	}
	return $defaults;
	}

	public function willWriteValue($key, $value) {
	$type = $this->getType($key);
	switch ($type) {
	case 'bool':
	if (strtolower($value) === 'false' \|\|
	strtolower($value) === 'no' \|\|
	strtolower($value) === 'off' \|\|
	$value === '' \|\|
	$value === '0' \|\|
	$value === 0 \|\|
	$value === false) {
	$value = false;
	} else if (strtolower($value) === 'true' \|\|
	strtolower($value) === 'yes' \|\|
	strtolower($value) === 'on' \|\|
	$value === '1' \|\|
	$value === 1 \|\|
	$value === true) {
	$value = true;
	} else {
	throw new ArcanistUsageException(
	pht(
	"Type of setting '%s' must be boolean, like 'true' or 'false'.",
	$key));
	}
	break;
	case 'list':
	if (is_array($value)) {
	break;
	}

	if (is_string($value)) {
	$list = json_decode($value, true);
	if (is_array($list)) {
	$value = $list;
	break;
	}
	}

	throw new ArcanistUsageException(
	pht(
	"Type of setting '%s' must be list. You can specify a list ".
	"in JSON, like: %s",
	$key,
	'["apple", "banana", "cherry"]'));

	case 'string':
	if (!is_scalar($value)) {
	throw new ArcanistUsageException(
	pht(
	"Type of setting '%s' must be string.",
	$key));
	}
	$value = (string)$value;
	break;
	case 'wild':
	break;
	case 'aliases':
	throw new Exception(
	pht(
	'Use "arc alias" to configure aliases, not "arc set-config".'));
	break;

	}

	return $value;
	}

	public function willReadValue($key, $value) {
	$type = $this->getType($key);
	switch ($type) {
	case 'string':
	if (!is_string($value)) {
	throw new ArcanistUsageException(
	pht(
	"Type of setting '%s' must be string.",
	$key));
	}
	break;
	case 'bool':
	if ($value !== true && $value !== false) {
	throw new ArcanistUsageException(
	pht(
	"Type of setting '%s' must be boolean.",
	$key));
	}
	break;
	case 'list':
	if (!is_array($value)) {
	throw new ArcanistUsageException(
	pht(
	"Type of setting '%s' must be list.",
	$key));
	}
	break;
	case 'wild':
	case 'aliases':
	break;
	}

	return $value;
	}

	public function formatConfigValueForDisplay($key, $value) {
	if ($value === false) {
	return 'false';
	}

	if ($value === true) {
	return 'true';
	}

	if ($value === null) {
	return 'null';
	}

	if (is_string($value)) {
	return '"'.$value.'"';
	}

	if (is_array($value)) {
	// TODO: Both json_encode() and PhutilJSON do a bad job with one-liners.
	// PhutilJSON splits them across a bunch of lines, while json_encode()
	// escapes all kinds of stuff like "/". It would be nice if PhutilJSON
	// had a mode for pretty one-liners.
	$value = json_encode($value);

	// json_encode() unnecessarily escapes "/" to prevent "</script>" stuff,
	// optimistically unescape it for display to improve readability.
	$value = preg_replace('@(?<!\\\\)\\\\/@', '/', $value);
	return $value;
	}

	return $value;
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Mon, Mar 24, 01:41 (1 d, 10 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1114149
Default Alt Text: ArcanistSettings.php (9 KB)

ArcanistSettings.phpNo OneTemporaryActions

ArcanistSettings.phpView Options

File Metadata

Event Timeline

ArcanistSettings.php
No OneTemporary
Actions

ArcanistSettings.php
View Options