phorge-arcanist/src/configuration/ArcanistSettings.php

<?php

final class ArcanistSettings {

  private function getOptions() {
    return array(
      'default' => array(
        'type' => 'string',
        'help' =>
          'The URI of a Phabricator install to connect to by default, if '.
          'arc is run in a project without a Phabricator URI or run outside '.
          'of a project.',
        'example' => '"http://phabricator.example.com/"',
      ),
      'base' => array(
        'type' => 'string',
        'help' =>
          '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' =>
          '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.',
        'example' => '["/var/arc/customlib/src"]',
        'default' => array(),
      ),
      'repository.callsign' => array(
        'type' => 'string',
        'example' => '"X"',
        'help' => pht(
          'Associate the working copy with a specific Phabricator repository. '.
          'Normally, arc 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.'),
      ),
      'phabricator.uri' => array(
        'type' => 'string',
        'legacy' => 'conduit_uri',
        'example' => '"https://phabricator.mycompany.com/"',
        'help' => pht(
          'Associates this working copy with a specific installation of '.
          'Phabricator.'),
      ),
      'project.name' => array(
        'type' => 'string',
        'legacy' => 'project_id',
        'example' => '"arcanist"',
        'help' => pht(
          'Associates this working copy with a named Arcanist Project. '.
          'This is primarily useful if you use SVN and have several different '.
          'projects in the same repository.'),
      ),
      'lint.engine' => array(
        'type' => 'string',
        'legacy' => 'lint_engine',
        'help' =>
          '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' =>
          'The name of a default unit test engine to use, if no unit test '.
          'engine is specified by the current project.',
        'example' => '"ExampleUnitTestEngine"',
      ),
      'arc.feature.start.default' => array(
        'type' => 'string',
        'help' =>
          'The name of the default branch to create the new feature branch '.
          'off of.',
        'example' => '"develop"',
      ),
      'arc.land.onto.default' => array(
        'type' => 'string',
        'help' =>
          'The name of the default branch to land changes onto when '.
          '`arc land` is run.',
        'example' => '"develop"',
      ),
      'arc.land.update.default' => array(
        'type' => 'string',
        'help' =>
          'The default strategy to use when arc land updates the feature '.
          'branch. Supports \'rebase\' and \'merge\' strategies.',
        'example' => '"rebase"',
      ),
      'arc.lint.cache' => array(
        'type' => 'bool',
        'help' =>
          "Enable the lint cache by default. When enabled, 'arc lint' ".
          "attempts to use cached results if possible. Currently, the cache ".
          "is not always invalidated correctly and may cause 'arc lint' to ".
          "report incorrect results, particularly while developing linters. ".
          "This is probably worth enabling only if your linters are very slow.",
        'example' => 'false',
        'default' => false,
      ),
      'history.immutable' => array(
        'type' => 'bool',
        'legacy' => 'immutable_history',
        'help' =>
          'If true, arc 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.',
        'example' => 'false',
      ),
      'editor' => array(
        'type' => 'string',
        'help' =>
          "Command to use to invoke an interactive editor, like 'nano' or ".
          "'vim'. This setting overrides the EDITOR environmental variable.",
        'example' => '"nano"',
      ),
      'https.cabundle' => array(
        'type' => 'string',
        'help' =>
          "Path to a custom CA bundle file to be used for arcanist's cURL ".
          "calls. This is used primarily when your conduit endpoint is ".
          "behind https signed by your organization's internal CA.",
        'example' => 'support/yourca.pem',
      ),
      'https.blindly-trust-domains' => array(
        'type' => 'list',
        'help' => 'List of domains to blindly trust SSL certificates for. '.
                  'Disables peer verification.',
        'example' => '["secure.mycompany.com"]',
        'default' => array(),
      ),
      'browser' => array(
        'type' => 'string',
        'help' =>
          'Command to use to invoke a web browser.',
        'example' => '"gnome-www-browser"',
      ),
      'events.listeners' => array(
        'type' => 'list',
        'help' => 'List of event listener classes to install at startup.',
        'example' => '["ExampleEventListener"]',
        'default' => array(),
      ),
      'http.basicauth.user' => array(
        'type' => 'string',
        'help' =>
          'Username to use for basic auth over http transports',
        'example' => '"bob"',
      ),
      'http.basicauth.pass' => array(
        'type' => 'string',
        'help' =>
          'Password to use for basic auth over http transports',
        'example' => '"bobhasasecret"',
      ),
      'arc.autostash' => array(
        'type' => 'bool',
        'help' =>
          'Whether arc 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 Arcanist operation causes an unrecoverable error.',
        'example' => 'false',
        'default' => false,
      ),
    );
  }

  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(
            "Type of setting '{$key}' must be boolean, like 'true' or ".
            "'false'.");
        }
        break;
      case 'list':
        if (is_array($value)) {
          break;
        }

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

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

      case 'string':
        if (!is_scalar($value)) {
          throw new ArcanistUsageException(
            "Type of setting '{$key}' must be string.");
        }
        $value = (string)$value;
        break;
      case 'wild':
        break;
    }

    return $value;
  }

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

}