No OneTemporary
Actions

Size

37 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/aphront/AphrontRequest.php b/src/aphront/AphrontRequest.php
	index 07c0c692ec..484219afa4 100644
	--- a/src/aphront/AphrontRequest.php
	+++ b/src/aphront/AphrontRequest.php
	@@ -1,509 +1,525 @@
	<?php

	/**
	*
	* @task data Accessing Request Data
	*
	* @group aphront
	*/
	final class AphrontRequest {

	// NOTE: These magic request-type parameters are automatically included in
	// certain requests (e.g., by phabricator_form(), JX.Request,
	// JX.Workflow, and ConduitClient) and help us figure out what sort of
	// response the client expects.

	const TYPE_AJAX = '__ajax__';
	const TYPE_FORM = '__form__';
	const TYPE_CONDUIT = '__conduit__';
	const TYPE_WORKFLOW = '__wflow__';
	const TYPE_CONTINUE = '__continue__';
	const TYPE_PREVIEW = '__preview__';

	private $host;
	private $path;
	private $requestData;
	private $user;
	private $applicationConfiguration;

	final public function __construct($host, $path) {
	$this->host = $host;
	$this->path = $path;
	}

	final public function setApplicationConfiguration(
	$application_configuration) {
	$this->applicationConfiguration = $application_configuration;
	return $this;
	}

	final public function getApplicationConfiguration() {
	return $this->applicationConfiguration;
	}

	final public function setPath($path) {
	$this->path = $path;
	return $this;
	}

	final public function getPath() {
	return $this->path;
	}

	final public function getHost() {
	// The "Host" header may include a port number, or may be a malicious
	// header in the form "realdomain.com:ignored@evil.com". Invoke the full
	// parser to extract the real domain correctly. See here for coverage of
	// a similar issue in Django:
	//
	// https://www.djangoproject.com/weblog/2012/oct/17/security/
	$uri = new PhutilURI('http://'.$this->host);
	return $uri->getDomain();
	}


	/* -( Accessing Request Data )--------------------------------------------- */


	/**
	* @task data
	*/
	final public function setRequestData(array $request_data) {
	$this->requestData = $request_data;
	return $this;
	}


	/**
	* @task data
	*/
	final public function getRequestData() {
	return $this->requestData;
	}


	/**
	* @task data
	*/
	final public function getInt($name, $default = null) {
	if (isset($this->requestData[$name])) {
	return (int)$this->requestData[$name];
	} else {
	return $default;
	}
	}


	/**
	* @task data
	*/
	final public function getBool($name, $default = null) {
	if (isset($this->requestData[$name])) {
	if ($this->requestData[$name] === 'true') {
	return true;
	} else if ($this->requestData[$name] === 'false') {
	return false;
	} else {
	return (bool)$this->requestData[$name];
	}
	} else {
	return $default;
	}
	}


	/**
	* @task data
	*/
	final public function getStr($name, $default = null) {
	if (isset($this->requestData[$name])) {
	$str = (string)$this->requestData[$name];
	// Normalize newline craziness.
	$str = str_replace(
	array("\r\n", "\r"),
	array("\n", "\n"),
	$str);
	return $str;
	} else {
	return $default;
	}
	}


	/**
	* @task data
	*/
	final public function getArr($name, $default = array()) {
	if (isset($this->requestData[$name]) &&
	is_array($this->requestData[$name])) {
	return $this->requestData[$name];
	} else {
	return $default;
	}
	}


	/**
	* @task data
	*/
	final public function getStrList($name, $default = array()) {
	if (!isset($this->requestData[$name])) {
	return $default;
	}
	$list = $this->getStr($name);
	$list = preg_split('/[\s,]+/', $list, $limit = -1, PREG_SPLIT_NO_EMPTY);
	return $list;
	}


	/**
	* @task data
	*/
	final public function getExists($name) {
	return array_key_exists($name, $this->requestData);
	}

	final public function getFileExists($name) {
	return isset($_FILES[$name]) &&
	(idx($_FILES[$name], 'error') !== UPLOAD_ERR_NO_FILE);
	}

	final public function isHTTPGet() {
	return ($_SERVER['REQUEST_METHOD'] == 'GET');
	}

	final public function isHTTPPost() {
	return ($_SERVER['REQUEST_METHOD'] == 'POST');
	}

	final public function isAjax() {
	return $this->getExists(self::TYPE_AJAX);
	}

	final public function isJavelinWorkflow() {
	return $this->getExists(self::TYPE_WORKFLOW);
	}

	final public function isConduit() {
	return $this->getExists(self::TYPE_CONDUIT);
	}

	public static function getCSRFTokenName() {
	return '__csrf__';
	}

	public static function getCSRFHeaderName() {
	return 'X-Phabricator-Csrf';
	}

	final public function validateCSRF() {
	$token_name = self::getCSRFTokenName();
	$token = $this->getStr($token_name);

	// No token in the request, check the HTTP header which is added for Ajax
	// requests.
	if (empty($token)) {
	$token = self::getHTTPHeader(self::getCSRFHeaderName());
	}

	$valid = $this->getUser()->validateCSRFToken($token);
	if (!$valid) {

	// Add some diagnostic details so we can figure out if some CSRF issues
	// are JS problems or people accessing Ajax URIs directly with their
	// browsers.
	if ($token) {
	$token_info = "with an invalid CSRF token";
	} else {
	$token_info = "without a CSRF token";
	}

	if ($this->isAjax()) {
	$more_info = "(This was an Ajax request, {$token_info}.)";
	} else {
	$more_info = "(This was a web request, {$token_info}.)";
	}

	// Give a more detailed explanation of how to avoid the exception
	// in developer mode.
	if (PhabricatorEnv::getEnvConfig('phabricator.developer-mode')) {
	$more_info = $more_info .
	"To avoid this error, use phabricator_form() to construct forms. " .
	"If you are already using phabricator_form(), make sure the form " .
	"'action' uses a relative URI (i.e., begins with a '/'). Forms " .
	"using absolute URIs do not include CSRF tokens, to prevent " .
	"leaking tokens to external sites.\n\n" .
	"If this page performs writes which do not require CSRF " .
	"protection (usually, filling caches or logging), you can use " .
	"AphrontWriteGuard::beginScopedUnguardedWrites() to temporarily " .
	"bypass CSRF protection while writing. You should use this only " .
	"for writes which can not be protected with normal CSRF " .
	"mechanisms.\n\n" .
	"Some UI elements (like PhabricatorActionListView) also have " .
	"methods which will allow you to render links as forms (like " .
	"setRenderAsForm(true)).";
	}

	// This should only be able to happen if you load a form, pull your
	// internet for 6 hours, and then reconnect and immediately submit,
	// but give the user some indication of what happened since the workflow
	// is incredibly confusing otherwise.
	throw new AphrontCSRFException(
	"The form you just submitted did not include a valid CSRF token. ".
	"This token is a technical security measure which prevents a ".
	"certain type of login hijacking attack. However, the token can ".
	"become invalid if you leave a page open for more than six hours ".
	"without a connection to the internet. To fix this problem: reload ".
	"the page, and then resubmit it. All data inserted to the form will ".
	"be lost in some browsers so copy them somewhere before reloading.\n\n".
	$more_info);
	}

	return true;
	}

	final public function isFormPost() {
	$post = $this->getExists(self::TYPE_FORM) &&
	$this->isHTTPPost();

	if (!$post) {
	return false;
	}

	return $this->validateCSRF();
	}

	+ final public function setCookiePrefix($prefix) {
	+ $this->cookiePrefix = $prefix;
	+ return $this;
	+ }
	+
	+ final private function getPrefixedCookieName($name) {
	+ if (strlen($this->cookiePrefix)) {
	+ return $this->cookiePrefix.'_'.$name;
	+ } else {
	+ return $name;
	+ }
	+ }
	+
	final public function getCookie($name, $default = null) {
	+ $name = $this->getPrefixedCookieName($name);
	return idx($_COOKIE, $name, $default);
	}

	final public function clearCookie($name) {
	+ $name = $this->getPrefixedCookieName($name);
	$this->setCookie($name, '', time() - (60 * 60 * 24 * 30));
	unset($_COOKIE[$name]);
	}

	final public function setCookie($name, $value, $expire = null) {

	$is_secure = false;

	// If a base URI has been configured, ensure cookies are only set on that
	// domain. Also, use the URI protocol to control SSL-only cookies.
	$base_uri = PhabricatorEnv::getEnvConfig('phabricator.base-uri');
	if ($base_uri) {
	$alternates = PhabricatorEnv::getEnvConfig('phabricator.allowed-uris');
	$allowed_uris = array_merge(
	array($base_uri),
	$alternates);

	$host = $this->getHost();

	$match = null;
	foreach ($allowed_uris as $allowed_uri) {
	$uri = new PhutilURI($allowed_uri);
	$domain = $uri->getDomain();
	if ($host == $domain) {
	$match = $uri;
	break;
	}
	}

	if ($match === null) {
	if (count($allowed_uris) > 1) {
	throw new Exception(
	pht(
	'This Phabricator install is configured as "%s", but you are '.
	'accessing it via "%s". Access Phabricator via the primary '.
	'configured domain, or one of the permitted alternate '.
	'domains: %s. Phabricator will not set cookies on other domains '.
	'for security reasons.',
	$base_uri,
	$host,
	implode(', ', $alternates)));
	} else {
	throw new Exception(
	pht(
	'This Phabricator install is configured as "%s", but you are '.
	'accessing it via "%s". Acccess Phabricator via the primary '.
	'configured domain. Phabricator will not set cookies on other '.
	'domains for security reasons.',
	$base_uri,
	$host));
	}
	}

	$base_domain = $match->getDomain();
	$is_secure = ($match->getProtocol() == 'https');
	} else {
	$base_uri = new PhutilURI(PhabricatorEnv::getRequestBaseURI());
	$base_domain = $base_uri->getDomain();
	}

	if ($expire === null) {
	$expire = time() + (60 * 60 * 24 * 365 * 5);
	}

	+ $name = $this->getPrefixedCookieName($name);

	if (php_sapi_name() == 'cli') {
	// Do nothing, to avoid triggering "Cannot modify header information"
	// warnings.

	// TODO: This is effectively a test for whether we're running in a unit
	// test or not. Move this actual call to HTTPSink?
	} else {
	setcookie(
	$name,
	$value,
	$expire,
	$path = '/',
	$base_domain,
	$is_secure,
	$http_only = true);
	}

	$_COOKIE[$name] = $value;

	return $this;
	}

	final public function setUser($user) {
	$this->user = $user;
	return $this;
	}

	final public function getUser() {
	return $this->user;
	}

	final public function getRequestURI() {
	$get = $_GET;
	unset($get['__path__']);
	$path = phutil_escape_uri($this->getPath());
	return id(new PhutilURI($path))->setQueryParams($get);
	}

	final public function isDialogFormPost() {
	return $this->isFormPost() && $this->getStr('__dialog__');
	}

	final public function getRemoteAddr() {
	return $_SERVER['REMOTE_ADDR'];
	}

	public function isHTTPS() {
	if (empty($_SERVER['HTTPS'])) {
	return false;
	}
	if (!strcasecmp($_SERVER["HTTPS"], "off")) {
	return false;
	}
	return true;
	}

	public function isContinueRequest() {
	return $this->isFormPost() && $this->getStr('__continue__');
	}

	public function isPreviewRequest() {
	return $this->isFormPost() && $this->getStr('__preview__');
	}

	/**
	* Get application request parameters in a flattened form suitable for
	* inclusion in an HTTP request, excluding parameters with special meanings.
	* This is primarily useful if you want to ask the user for more input and
	* then resubmit their request.
	*
	* @return dict<string, string> Original request parameters.
	*/
	public function getPassthroughRequestParameters() {
	return self::flattenData($this->getPassthroughRequestData());
	}

	/**
	* Get request data other than "magic" parameters.
	*
	* @return dict<string, wild> Request data, with magic filtered out.
	*/
	public function getPassthroughRequestData() {
	$data = $this->getRequestData();

	// Remove magic parameters like __dialog__ and __ajax__.
	foreach ($data as $key => $value) {
	if (!strncmp($key, '__', 2)) {
	unset($data[$key]);
	}
	}

	return $data;
	}


	/**
	* Flatten an array of key-value pairs (possibly including arrays as values)
	* into a list of key-value pairs suitable for submitting via HTTP request
	* (with arrays flattened).
	*
	* @param dict<string, wild> Data to flatten.
	* @return dict<string, string> Flat data suitable for inclusion in an HTTP
	* request.
	*/
	public static function flattenData(array $data) {
	$result = array();
	foreach ($data as $key => $value) {
	if (is_array($value)) {
	foreach (self::flattenData($value) as $fkey => $fvalue) {
	$fkey = '['.preg_replace('/(?=\[)\|$/', ']', $fkey, $limit = 1);
	$result[$key.$fkey] = $fvalue;
	}
	} else {
	$result[$key] = (string)$value;
	}
	}

	ksort($result);

	return $result;
	}


	/**
	* Read the value of an HTTP header from `$_SERVER`, or a similar datasource.
	*
	* This function accepts a canonical header name, like `"Accept-Encoding"`,
	* and looks up the appropriate value in `$_SERVER` (in this case,
	* `"HTTP_ACCEPT_ENCODING"`).
	*
	* @param string Canonical header name, like `"Accept-Encoding"`.
	* @param wild Default value to return if header is not present.
	* @param array? Read this instead of `$_SERVER`.
	* @return string\|wild Header value if present, or `$default` if not.
	*/
	public static function getHTTPHeader($name, $default = null, $data = null) {
	// PHP mangles HTTP headers by uppercasing them and replacing hyphens with
	// underscores, then prepending 'HTTP_'.
	$php_index = strtoupper($name);
	$php_index = str_replace('-', '_', $php_index);

	$try_names = array();

	$try_names[] = 'HTTP_'.$php_index;
	if ($php_index == 'CONTENT_TYPE' \|\| $php_index == 'CONTENT_LENGTH') {
	// These headers may be available under alternate names. See
	// http://www.php.net/manual/en/reserved.variables.server.php#110763
	$try_names[] = $php_index;
	}

	if ($data === null) {
	$data = $_SERVER;
	}

	foreach ($try_names as $try_name) {
	if (array_key_exists($try_name, $data)) {
	return $data[$try_name];
	}
	}

	return $default;
	}

	}
	diff --git a/src/aphront/configuration/AphrontDefaultApplicationConfiguration.php b/src/aphront/configuration/AphrontDefaultApplicationConfiguration.php
	index 24a9043864..7523a04821 100644
	--- a/src/aphront/configuration/AphrontDefaultApplicationConfiguration.php
	+++ b/src/aphront/configuration/AphrontDefaultApplicationConfiguration.php
	@@ -1,295 +1,298 @@
	<?php

	/**
	* @group aphront
	*/
	class AphrontDefaultApplicationConfiguration
	extends AphrontApplicationConfiguration {

	public function __construct() {

	}

	public function getApplicationName() {
	return 'aphront-default';
	}

	public function getURIMap() {
	return $this->getResourceURIMapRules() + array(
	'/(?:(?P<filter>(?:jump))/)?' =>
	'PhabricatorDirectoryMainController',

	'/typeahead/' => array(
	'common/(?P<type>\w+)/'
	=> 'PhabricatorTypeaheadCommonDatasourceController',
	),

	'/oauthserver/' => array(
	'auth/' => 'PhabricatorOAuthServerAuthController',
	'test/' => 'PhabricatorOAuthServerTestController',
	'token/' => 'PhabricatorOAuthServerTokenController',
	'clientauthorization/' => array(
	'' => 'PhabricatorOAuthClientAuthorizationListController',
	'delete/(?P<phid>[^/]+)/' =>
	'PhabricatorOAuthClientAuthorizationDeleteController',
	'edit/(?P<phid>[^/]+)/' =>
	'PhabricatorOAuthClientAuthorizationEditController',
	),
	'client/' => array(
	'' => 'PhabricatorOAuthClientListController',
	'create/' => 'PhabricatorOAuthClientEditController',
	'delete/(?P<phid>[^/]+)/' => 'PhabricatorOAuthClientDeleteController',
	'edit/(?P<phid>[^/]+)/' => 'PhabricatorOAuthClientEditController',
	'view/(?P<phid>[^/]+)/' => 'PhabricatorOAuthClientViewController',
	),
	),

	'/~/' => array(
	'' => 'DarkConsoleController',
	'data/(?P<key>[^/]+)/' => 'DarkConsoleDataController',
	),

	'/status/' => 'PhabricatorStatusController',


	'/help/' => array(
	'keyboardshortcut/' => 'PhabricatorHelpKeyboardShortcutController',
	),

	'/notification/' => array(
	'(?:(?P<filter>all\|unread)/)?'
	=> 'PhabricatorNotificationListController',
	'panel/' => 'PhabricatorNotificationPanelController',
	'individual/' => 'PhabricatorNotificationIndividualController',
	'status/' => 'PhabricatorNotificationStatusController',
	'clear/' => 'PhabricatorNotificationClearController',
	),

	'/debug/' => 'PhabricatorDebugController',
	);
	}

	protected function getResourceURIMapRules() {
	return array(
	'/res/' => array(
	'(?:(?P<mtime>[0-9]+)T/)?'.
	'(?P<library>[^/]+)/'.
	'(?P<hash>[a-f0-9]{8})/'.
	'(?P<path>.+\.(?:css\|js\|jpg\|png\|swf\|gif))'
	=> 'CelerityPhabricatorResourceController',
	),
	);
	}

	/**
	* @phutil-external-symbol class PhabricatorStartup
	*/
	public function buildRequest() {
	$parser = new PhutilQueryStringParser();
	$data = array();

	// If the request has "multipart/form-data" content, we can't use
	// PhutilQueryStringParser to parse it, and the raw data supposedly is not
	// available anyway (according to the PHP documentation, "php://input" is
	// not available for "multipart/form-data" requests). However, it is
	// available at least some of the time (see T3673), so double check that
	// we aren't trying to parse data we won't be able to parse correctly by
	// examining the Content-Type header.
	$content_type = idx($_SERVER, 'CONTENT_TYPE');
	$is_form_data = preg_match('@^multipart/form-data@i', $content_type);

	$raw_input = PhabricatorStartup::getRawInput();
	if (strlen($raw_input) && !$is_form_data) {
	$data += $parser->parseQueryString($raw_input);
	} else if ($_POST) {
	$data += $_POST;
	}

	$data += $parser->parseQueryString(idx($_SERVER, 'QUERY_STRING', ''));

	+ $cookie_prefix = PhabricatorEnv::getEnvConfig('phabricator.cookie-prefix');
	+
	$request = new AphrontRequest($this->getHost(), $this->getPath());
	$request->setRequestData($data);
	$request->setApplicationConfiguration($this);
	+ $request->setCookiePrefix($cookie_prefix);

	return $request;
	}

	public function handleException(Exception $ex) {
	$request = $this->getRequest();

	// For Conduit requests, return a Conduit response.
	if ($request->isConduit()) {
	$response = new ConduitAPIResponse();
	$response->setErrorCode(get_class($ex));
	$response->setErrorInfo($ex->getMessage());

	return id(new AphrontJSONResponse())
	->setAddJSONShield(false)
	->setContent($response->toDictionary());
	}

	// For non-workflow requests, return a Ajax response.
	if ($request->isAjax() && !$request->isJavelinWorkflow()) {
	// Log these; they don't get shown on the client and can be difficult
	// to debug.
	phlog($ex);

	$response = new AphrontAjaxResponse();
	$response->setError(
	array(
	'code' => get_class($ex),
	'info' => $ex->getMessage(),
	));
	return $response;
	}

	$is_serious = PhabricatorEnv::getEnvConfig('phabricator.serious-business');

	$user = $request->getUser();
	if (!$user) {
	// If we hit an exception very early, we won't have a user.
	$user = new PhabricatorUser();
	}

	if ($ex instanceof PhabricatorPolicyException) {

	if (!$user->isLoggedIn()) {
	// If the user isn't logged in, just give them a login form. This is
	// probably a generally more useful response than a policy dialog that
	// they have to click through to get a login form.
	//
	// Possibly we should add a header here like "you need to login to see
	// the thing you are trying to look at".
	$login_controller = new PhabricatorAuthStartController($request);

	$auth_app_class = 'PhabricatorApplicationAuth';
	$auth_app = PhabricatorApplication::getByClass($auth_app_class);
	$login_controller->setCurrentApplication($auth_app);

	return $login_controller->processRequest();
	}

	$list = $ex->getMoreInfo();
	foreach ($list as $key => $item) {
	$list[$key] = phutil_tag('li', array(), $item);
	}
	if ($list) {
	$list = phutil_tag('ul', array(), $list);
	}

	$content = array(
	phutil_tag(
	'div',
	array(
	'class' => 'aphront-policy-rejection',
	),
	$ex->getRejection()),
	phutil_tag(
	'div',
	array(
	'class' => 'aphront-capability-details',
	),
	pht('Users with the "%s" capability:', $ex->getCapabilityName())),
	$list,
	);

	$dialog = new AphrontDialogView();
	$dialog
	->setTitle($ex->getTitle())
	->setClass('aphront-access-dialog')
	->setUser($user)
	->appendChild($content);

	if ($this->getRequest()->isAjax()) {
	$dialog->addCancelButton('/', 'Close');
	} else {
	$dialog->addCancelButton('/', $is_serious ? 'OK' : 'Away With Thee');
	}

	$response = new AphrontDialogResponse();
	$response->setDialog($dialog);
	return $response;
	}

	if ($ex instanceof AphrontUsageException) {
	$error = new AphrontErrorView();
	$error->setTitle($ex->getTitle());
	$error->appendChild($ex->getMessage());

	$view = new PhabricatorStandardPageView();
	$view->setRequest($this->getRequest());
	$view->appendChild($error);

	$response = new AphrontWebpageResponse();
	$response->setContent($view->render());
	$response->setHTTPResponseCode(500);

	return $response;
	}


	// Always log the unhandled exception.
	phlog($ex);

	$class = get_class($ex);
	$message = $ex->getMessage();

	if ($ex instanceof AphrontQuerySchemaException) {
	$message .=
	"\n\n".
	"NOTE: This usually indicates that the MySQL schema has not been ".
	"properly upgraded. Run 'bin/storage upgrade' to ensure your ".
	"schema is up to date.";
	}

	if (PhabricatorEnv::getEnvConfig('phabricator.developer-mode')) {
	$trace = id(new AphrontStackTraceView())
	->setUser($user)
	->setTrace($ex->getTrace());
	} else {
	$trace = null;
	}

	$content = phutil_tag(
	'div',
	array('class' => 'aphront-unhandled-exception'),
	array(
	phutil_tag('div', array('class' => 'exception-message'), $message),
	$trace,
	));

	$dialog = new AphrontDialogView();
	$dialog
	->setTitle('Unhandled Exception ("'.$class.'")')
	->setClass('aphront-exception-dialog')
	->setUser($user)
	->appendChild($content);

	if ($this->getRequest()->isAjax()) {
	$dialog->addCancelButton('/', 'Close');
	}

	$response = new AphrontDialogResponse();
	$response->setDialog($dialog);
	$response->setHTTPResponseCode(500);

	return $response;
	}

	public function willSendResponse(AphrontResponse $response) {
	return $response;
	}

	public function build404Controller() {
	return array(new Phabricator404Controller($this->getRequest()), array());
	}

	public function buildRedirectController($uri) {
	return array(
	new PhabricatorRedirectController($this->getRequest()),
	array(
	'uri' => $uri,
	));
	}

	}
	diff --git a/src/applications/config/option/PhabricatorCoreConfigOptions.php b/src/applications/config/option/PhabricatorCoreConfigOptions.php
	index 54eb700ecf..62005f9d9d 100644
	--- a/src/applications/config/option/PhabricatorCoreConfigOptions.php
	+++ b/src/applications/config/option/PhabricatorCoreConfigOptions.php
	@@ -1,266 +1,276 @@
	<?php

	final class PhabricatorCoreConfigOptions
	extends PhabricatorApplicationConfigOptions {

	public function getName() {
	return pht("Core");
	}

	public function getDescription() {
	return pht("Configure core options, including URIs.");
	}

	public function getOptions() {
	if (phutil_is_windows()) {
	$paths = array();
	} else {
	$paths = array(
	'/bin',
	'/usr/bin',
	'/usr/local/bin',
	);
	}

	$path = getenv('PATH');

	return array(
	$this->newOption('phabricator.base-uri', 'string', null)
	->setLocked(true)
	->setSummary(pht("URI where Phabricator is installed."))
	->setDescription(
	pht(
	"Set the URI where Phabricator is installed. Setting this ".
	"improves security by preventing cookies from being set on other ".
	"domains, and allows daemons to send emails with links that have ".
	"the correct domain."))
	->addExample('http://phabricator.example.com/', pht('Valid Setting')),
	$this->newOption('phabricator.production-uri', 'string', null)
	->setSummary(
	pht("Primary install URI, for multi-environment installs."))
	->setDescription(
	pht(
	"If you have multiple Phabricator environments (like a ".
	"development/staging environment for working on testing ".
	"Phabricator, and a production environment for deploying it), ".
	"set the production environment URI here so that emails and other ".
	"durable URIs will always generate with links pointing at the ".
	"production environment. If unset, defaults to ".
	"{{phabricator.base-uri}}. Most installs do not need to set ".
	"this option."))
	->addExample('http://phabricator.example.com/', pht('Valid Setting')),
	$this->newOption('phabricator.allowed-uris', 'list<string>', array())
	->setLocked(true)
	->setSummary(pht("Alternative URIs that can access Phabricator."))
	->setDescription(
	pht(
	"These alternative URIs will be able to access 'normal' pages ".
	"on your Phabricator install. Other features such as OAuth ".
	"won't work. The major use case for this is moving installs ".
	"across domains."))
	->addExample(
	'["http://phabricator2.example.com/", '.
	'"http://phabricator3.example.com/"]',
	pht('Valid Setting')),
	$this->newOption('phabricator.timezone', 'string', null)
	->setSummary(
	pht("The timezone Phabricator should use."))
	->setDescription(
	pht(
	"PHP requires that you set a timezone in your php.ini before ".
	"using date functions, or it will emit a warning. If this isn't ".
	"possible (for instance, because you are using HPHP) you can set ".
	"some valid constant for date_default_timezone_set() here and ".
	"Phabricator will set it on your behalf, silencing the warning."))
	->addExample('America/New_York', pht('US East (EDT)'))
	->addExample('America/Chicago', pht('US Central (CDT)'))
	->addExample('America/Boise', pht('US Mountain (MDT)'))
	->addExample('America/Los_Angeles', pht('US West (PDT)')),
	+ $this->newOption('phabricator.cookie-prefix', 'string', null)
	+ ->setSummary(
	+ pht("Set a string Phabricator should use to prefix ".
	+ "cookie names"))
	+ ->setDescription(
	+ pht(
	+ "Cookies set for x.com are also sent for y.x.com. Assuming ".
	+ "Phabricator instances are running on both domains, this will ".
	+ "create a collision preventing you from logging in."))
	+ ->addExample('dev', pht('Prefix cookie with "dev"')),
	$this->newOption('phabricator.show-beta-applications', 'bool', false)
	->setBoolOptions(
	array(
	pht('Install Beta Applications'),
	pht('Uninstall Beta Applications')
	))
	->setDescription(
	pht(
	"Phabricator includes 'Beta' applications which are in an early ".
	"stage of development. They range from very rough prototypes to ".
	"relatively complete (but unpolished) applications.\n\n".
	"By default, Beta applications are not installed. You can enable ".
	"this option to install them if you're interested in previewing ".
	"upcoming features.\n\n".
	"After enabling Beta applications, you can selectively uninstall ".
	"them (like normal applications).")),
	$this->newOption('phabricator.serious-business', 'bool', false)
	->setBoolOptions(
	array(
	pht('Serious business'),
	pht('Shenanigans'), // That should be interesting to translate. :P
	))
	->setSummary(
	pht("Should Phabricator be serious?"))
	->setDescription(
	pht(
	"By default, Phabricator includes some silly nonsense in the UI, ".
	"such as a submit button called 'Clowncopterize' in Differential ".
	"and a call to 'Leap Into Action'. If you'd prefer more ".
	"traditional UI strings like 'Submit', you can set this flag to ".
	"disable most of the jokes and easter eggs.")),
	$this->newOption('environment.append-paths', 'list<string>', $paths)
	->setSummary(
	pht("These paths get appended to your \$PATH envrionment variable."))
	->setDescription(
	pht(
	"Phabricator occasionally shells out to other binaries on the ".
	"server. An example of this is the `pygmentize` command, used ".
	"to syntax-highlight code written in languages other than PHP. ".
	"By default, it is assumed that these binaries are in the \$PATH ".
	"of the user running Phabricator (normally 'apache', 'httpd', or ".
	"'nobody'). Here you can add extra directories to the \$PATH ".
	"environment variable, for when these binaries are in ".
	"non-standard locations.\n\n".
	"Note that you can also put binaries in ".
	"`phabricator/support/bin/` (for example, by symlinking them).\n\n".
	"The current value of PATH after configuration is applied is:\n\n".
	" lang=text\n".
	" %s", $path))
	->addExample('/usr/local/bin', pht('Add One Path'))
	->addExample("/usr/bin\n/usr/local/bin", pht('Add Multiple Paths')),
	$this->newOption('tokenizer.ondemand', 'bool', false)
	->setBoolOptions(
	array(
	pht("Query on demand"),
	pht("Query on page load"),
	))
	->setSummary(
	pht("Query for tokenizer fields on demand."))
	->setDescription(
	pht(
	"Tokenizers are UI controls which let the user select other ".
	"users, email addresses, project names, etc., by typing the ".
	"first few letters and having the control autocomplete from a ".
	"list. They can load their data in two ways: either in a big ".
	"chunk up front, or as the user types. By default, the data is ".
	"loaded in a big chunk. This is simpler and performs better for ".
	"small datasets. However, if you have a very large number of ".
	"users or projects, (in the ballpark of more than a thousand), ".
	"loading all that data may become slow enough that it's ".
	"worthwhile to query on demand instead. This makes the typeahead ".
	"slightly less responsive but overall performance will be much ".
	"better if you have a ton of stuff. You can figure out which ".
	"setting is best for your install by changing this setting and ".
	"then playing with a user tokenizer (like the user selectors in ".
	"Maniphest or Differential) and seeing which setting loads ".
	"faster and feels better.")),
	$this->newOption('config.lock', 'set', array())
	->setLocked(true)
	->setDescription(pht('Additional configuration options to lock.')),
	$this->newOption('config.hide', 'set', array())
	->setLocked(true)
	->setDescription(pht('Additional configuration options to hide.')),
	$this->newOption('config.mask', 'set', array())
	->setLocked(true)
	->setDescription(pht('Additional configuration options to mask.')),
	$this->newOption('config.ignore-issues', 'set', array())
	->setLocked(true)
	->setDescription(pht('Setup issues to ignore.')),
	$this->newOption('phabricator.env', 'string', null)
	->setLocked(true)
	->setDescription(pht('Internal.')),
	$this->newOption('test.value', 'wild', null)
	->setLocked(true)
	->setDescription(pht('Unit test value.')),
	$this->newOption('phabricator.uninstalled-applications', 'set', array())
	->setLocked(true)
	->setDescription(
	pht('Array containing list of Uninstalled applications.')),
	$this->newOption('phabricator.application-settings', 'wild', array())
	->setLocked(true)
	->setDescription(
	pht('Customized settings for Phabricator applications.')),
	$this->newOption('welcome.html', 'string', null)
	->setLocked(true)
	->setDescription(
	pht('Custom HTML to show on the main Phabricator dashboard.')),
	$this->newOption('phabricator.cache-namespace', 'string', null)
	->setLocked(true)
	->setDescription(pht('Cache namespace.')),
	$this->newOption('phabricator.allow-email-users', 'bool', false)
	->setBoolOptions(
	array(
	pht('Allow'),
	pht('Disallow'),
	))->setDescription(
	pht(
	'Allow non-members to interact with tasks over email.')),
	);

	}

	protected function didValidateOption(
	PhabricatorConfigOption $option,
	$value) {

	$key = $option->getKey();
	if ($key == 'phabricator.base-uri' \|\|
	$key == 'phabricator.production-uri') {

	$uri = new PhutilURI($value);
	$protocol = $uri->getProtocol();
	if ($protocol !== 'http' && $protocol !== 'https') {
	throw new PhabricatorConfigValidationException(
	pht(
	"Config option '%s' is invalid. The URI must start with ".
	"'http://' or 'https://'.",
	$key));
	}

	$domain = $uri->getDomain();
	if (strpos($domain, '.') === false) {
	throw new PhabricatorConfigValidationException(
	pht(
	"Config option '%s' is invalid. The URI must contain a dot ('.'), ".
	"like 'http://example.com/', not just a bare name like ".
	"'http://example/'. Some web browsers will not set cookies on ".
	"domains with no TLD.",
	$key));
	}

	$path = $uri->getPath();
	if ($path !== '' && $path !== '/') {
	throw new PhabricatorConfigValidationException(
	pht(
	"Config option '%s' is invalid. The URI must NOT have a path, ".
	"e.g. 'http://phabricator.example.com/' is OK, but ".
	"'http://example.com/phabricator/' is not. Phabricator must be ".
	"installed on an entire domain; it can not be installed on a ".
	"path.",
	$key));
	}
	}


	if ($key === 'phabricator.timezone') {
	$old = date_default_timezone_get();
	$ok = @date_default_timezone_set($value);
	@date_default_timezone_set($old);

	if (!$ok) {
	throw new PhabricatorConfigValidationException(
	pht(
	"Config option '%s' is invalid. The timezone identifier must ".
	"be a valid timezone identifier recognized by PHP, like ".
	"'America/Los_Angeles'. You can find a list of valid identifiers ".
	"here: %s",
	$key,
	'http://php.net/manual/timezones.php'));
	}
	}



	}


	}

File Metadata

Mime Type: text/x-diff
Expires: Thu, Jul 24, 4:14 AM (1 d, 13 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 182523
Default Alt Text: (37 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions