ArcanistWorkingCopyIdentity.php
No OneTemporary
Actions

Size

5 KB

Referenced Files

None

Subscribers

None

ArcanistWorkingCopyIdentity.php
View Options

	<?php

	/*
	* Copyright 2012 Facebook, Inc.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	/**
	* Interfaces with basic information about the working copy.
	*
	*
	* @task config
	*
	* @group workingcopy
	*/
	final class ArcanistWorkingCopyIdentity {

	protected $localConfig;
	protected $projectConfig;
	protected $projectRoot;

	public static function newFromPath($path) {
	$project_id = null;
	$project_root = null;
	$config = array();
	foreach (Filesystem::walkToRoot($path) as $dir) {
	$config_file = $dir.'/.arcconfig';
	if (!Filesystem::pathExists($config_file)) {
	continue;
	}
	$proj_raw = Filesystem::readFile($config_file);
	$config = self::parseRawConfigFile($proj_raw, $config_file);
	$project_root = $dir;
	break;
	}

	if (!$project_root) {
	foreach (Filesystem::walkToRoot($path) as $dir) {
	$try = array(
	$dir.'/.svn',
	$dir.'/.hg',
	$dir.'/.git',
	);
	foreach ($try as $trydir) {
	if (Filesystem::pathExists($trydir)) {
	$project_root = $dir;
	break 2;
	}
	}
	}
	}

	return new ArcanistWorkingCopyIdentity($project_root, $config);
	}

	public static function newFromRootAndConfigFile(
	$root,
	$config_raw,
	$from_where) {

	$config = self::parseRawConfigFile($config_raw, $from_where);
	return new ArcanistWorkingCopyIdentity($root, $config);
	}

	private static function parseRawConfigFile($raw_config, $from_where) {
	$proj = json_decode($raw_config, true);
	if (!is_array($proj)) {
	throw new Exception(
	"Unable to parse '.arcconfig' file '{$from_where}'. The file contents ".
	"should be valid JSON.\n\n".
	"FILE CONTENTS\n".
	substr($raw_config, 0, 2048));
	}
	$required_keys = array(
	'project_id',
	);
	foreach ($required_keys as $key) {
	if (!array_key_exists($key, $proj)) {
	throw new Exception(
	"Required key '{$key}' is missing from '.arcconfig' file ".
	"'{$from_where}'.");
	}
	}
	return $proj;
	}

	protected function __construct($root, array $config) {
	$this->projectRoot = $root;
	$this->projectConfig = $config;
	$this->localConfig = array();

	$vc_dirs = array(
	'.git',
	'.hg',
	'.svn',
	);
	foreach ($vc_dirs as $dir) {
	$local_path = Filesystem::resolvePath(
	$dir.'/arc/config',
	$this->projectRoot);
	if (Filesystem::pathExists($local_path)) {
	$file = Filesystem::readFile($local_path);
	if ($file) {
	$this->localConfig = json_decode($file, true);
	break;
	}
	}
	}

	}

	public function getProjectID() {
	return $this->getConfig('project_id');
	}

	public function getProjectRoot() {
	return $this->projectRoot;
	}

	public function getConduitURI() {
	return $this->getConfig('conduit_uri');
	}


	/* -( Config )------------------------------------------------------------- */


	/**
	* Read a configuration directive from project configuration. This reads ONLY
	* permanent project configuration (i.e., ".arcconfig"), not other
	* configuration sources. See @{method:getConfigFromAnySource} to read from
	* user configuration.
	*
	* @param key Key to read.
	* @param wild Default value if key is not found.
	* @return wild Value, or default value if not found.
	*
	* @task config
	*/
	public function getConfig($key, $default = null) {
	return idx($this->projectConfig, $key, $default);
	}


	/**
	* Read a configuration directive from local configuration. This
	* reads ONLY the per-working copy configuration,
	* i.e. .(git\|hg\|svn)/arc/config, and not other configuration
	* sources. See @{method:getConfigFromAnySource} to read from any
	* config source or @{method:getConfig} to read permanent
	* project-level config.
	*
	* @task config
	*/
	public function getLocalConfig($key, $default=null) {
	return idx($this->localConfig, $key, $default);
	}

	/**
	* Read a configuration directive from any available configuration source.
	* In contrast to @{method:getConfig}, this will look for the directive in
	* local and user configuration in addition to project configuration.
	* The precedence is local > project > user
	*
	* @param key Key to read.
	* @param wild Default value if key is not found.
	* @return wild Value, or default value if not found.
	*
	* @task config
	*/
	public function getConfigFromAnySource($key, $default = null) {

	// try local config first
	$pval = $this->getLocalConfig($key);

	// then per-project config
	if ($pval === null) {
	$pval = $this->getConfig($key);
	}

	// Test for older names in the per-project config only, since
	// they've only been used there
	static $deprecated_names = array(
	'lint.engine' => 'lint_engine',
	'unit.engine' => 'unit_engine',
	);
	if ($pval === null && isset($deprecated_names[$key])) {
	$pval = $this->getConfig($deprecated_names[$key]);
	}

	// lastly, try global (i.e. user-level) config
	if ($pval === null) {
	$global_config = ArcanistBaseWorkflow::readGlobalArcConfig();
	$pval = idx($global_config, $key);
	}

	if ($pval === null) {
	$system_config = ArcanistBaseWorkflow::readSystemArcConfig();
	$pval = idx($system_config, $key);
	}

	if ($pval === null) {
	$pval = $default;
	}

	return $pval;

	}

	}

File Metadata

Mime Type: text/x-php
Expires: Thu, Mar 27, 00:00 (1 d, 19 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1231670
Default Alt Text: ArcanistWorkingCopyIdentity.php (5 KB)

ArcanistWorkingCopyIdentity.phpNo OneTemporaryActions

ArcanistWorkingCopyIdentity.phpView Options

File Metadata

Event Timeline

ArcanistWorkingCopyIdentity.php
No OneTemporary
Actions

ArcanistWorkingCopyIdentity.php
View Options