No OneTemporary
Actions

Size

93 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/applications/differential/xaction/DifferentialRevisionActionTransaction.php b/src/applications/differential/xaction/DifferentialRevisionActionTransaction.php
	index 5507d1309d..82198083f8 100644
	--- a/src/applications/differential/xaction/DifferentialRevisionActionTransaction.php
	+++ b/src/applications/differential/xaction/DifferentialRevisionActionTransaction.php
	@@ -1,132 +1,138 @@
	<?php

	abstract class DifferentialRevisionActionTransaction
	extends DifferentialRevisionTransactionType {

	final public function getRevisionActionKey() {
	return $this->getPhobjectClassConstant('ACTIONKEY', 32);
	}

	public function isActionAvailable($object, PhabricatorUser $viewer) {
	try {
	$this->validateAction($object, $viewer);
	return true;
	} catch (Exception $ex) {
	return false;
	}
	}

	abstract protected function validateAction($object, PhabricatorUser $viewer);
	abstract protected function getRevisionActionLabel();

	public function getCommandKeyword() {
	return null;
	}

	public function getCommandAliases() {
	return array();
	}

	public function getCommandSummary() {
	return null;
	}

	protected function getRevisionActionOrder() {
	return 1000;
	}

	public function getActionStrength() {
	return 3;
	}

	public function getRevisionActionOrderVector() {
	return id(new PhutilSortVector())
	->addInt($this->getRevisionActionOrder());
	}

	protected function getRevisionActionGroupKey() {
	return DifferentialRevisionEditEngine::ACTIONGROUP_REVISION;
	}

	protected function getRevisionActionDescription() {
	return null;
	}

	public static function loadAllActions() {
	return id(new PhutilClassMapQuery())
	->setAncestorClass(__CLASS__)
	->setUniqueMethod('getRevisionActionKey')
	->execute();
	}

	protected function isViewerRevisionAuthor(
	DifferentialRevision $revision,
	PhabricatorUser $viewer) {

	if (!$viewer->getPHID()) {
	return false;
	}

	return ($viewer->getPHID() === $revision->getAuthorPHID());
	}

	public function newEditField(
	DifferentialRevision $revision,
	PhabricatorUser $viewer) {

	+ // Actions in the "review" group, like "Accept Revision", do not require
	+ // that the actor be able to edit the revision.
	+ $group_review = DifferentialRevisionEditEngine::ACTIONGROUP_REVIEW;
	+ $is_review = ($this->getRevisionActionGroupKey() == $group_review);
	+
	$field = id(new PhabricatorApplyEditField())
	->setKey($this->getRevisionActionKey())
	->setTransactionType($this->getTransactionTypeConstant())
	+ ->setCanApplyWithoutEditCapability($is_review)
	->setValue(true);

	if ($this->isActionAvailable($revision, $viewer)) {
	$label = $this->getRevisionActionLabel();
	if ($label !== null) {
	$field->setCommentActionLabel($label);

	$description = $this->getRevisionActionDescription();
	$field->setActionDescription($description);

	$group_key = $this->getRevisionActionGroupKey();
	$field->setCommentActionGroupKey($group_key);

	// Currently, every revision action conflicts with every other
	// revision action: for example, you can not simultaneously Accept and
	// Reject a revision.

	// Under some configurations, some combinations of actions are sort of
	// technically permissible. For example, you could reasonably Reject
	// and Abandon a revision if "anyone can abandon anything" is enabled.

	// It's not clear that these combinations are actually useful, so just
	// keep things simple for now.
	$field->setActionConflictKey('revision.action');
	}
	}

	return $field;
	}

	public function validateTransactions($object, array $xactions) {
	$errors = array();
	$actor = $this->getActor();

	$action_exception = null;
	try {
	$this->validateAction($object, $actor);
	} catch (Exception $ex) {
	$action_exception = $ex;
	}

	foreach ($xactions as $xaction) {
	if ($action_exception) {
	$errors[] = $this->newInvalidError(
	$action_exception->getMessage(),
	$xaction);
	}
	}

	return $errors;
	}

	}
	diff --git a/src/applications/diffusion/xaction/DiffusionCommitActionTransaction.php b/src/applications/diffusion/xaction/DiffusionCommitActionTransaction.php
	index 4756f914e3..d2e5f17ccb 100644
	--- a/src/applications/diffusion/xaction/DiffusionCommitActionTransaction.php
	+++ b/src/applications/diffusion/xaction/DiffusionCommitActionTransaction.php
	@@ -1,118 +1,124 @@
	<?php

	abstract class DiffusionCommitActionTransaction
	extends DiffusionCommitTransactionType {

	final public function getCommitActionKey() {
	return $this->getPhobjectClassConstant('ACTIONKEY', 32);
	}

	public function isActionAvailable($object, PhabricatorUser $viewer) {
	try {
	$this->validateAction($object, $viewer);
	return true;
	} catch (Exception $ex) {
	return false;
	}
	}

	abstract protected function validateAction($object, PhabricatorUser $viewer);
	abstract protected function getCommitActionLabel();

	public function getCommandKeyword() {
	return null;
	}

	public function getCommandAliases() {
	return array();
	}

	public function getCommandSummary() {
	return null;
	}

	protected function getCommitActionOrder() {
	return 1000;
	}

	public function getCommitActionOrderVector() {
	return id(new PhutilSortVector())
	->addInt($this->getCommitActionOrder());
	}

	protected function getCommitActionGroupKey() {
	return DiffusionCommitEditEngine::ACTIONGROUP_COMMIT;
	}

	protected function getCommitActionDescription() {
	return null;
	}

	public static function loadAllActions() {
	return id(new PhutilClassMapQuery())
	->setAncestorClass(__CLASS__)
	->setUniqueMethod('getCommitActionKey')
	->execute();
	}

	protected function isViewerCommitAuthor(
	PhabricatorRepositoryCommit $commit,
	PhabricatorUser $viewer) {

	if (!$viewer->getPHID()) {
	return false;
	}

	return ($viewer->getPHID() === $commit->getAuthorPHID());
	}

	public function newEditField(
	PhabricatorRepositoryCommit $commit,
	PhabricatorUser $viewer) {

	+ // Actions in the "audit" group, like "Accept Commit", do not require
	+ // that the actor be able to edit the commit.
	+ $group_audit = DiffusionCommitEditEngine::ACTIONGROUP_AUDIT;
	+ $is_audit = ($this->getCommitActionGroupKey() == $group_audit);
	+
	$field = id(new PhabricatorApplyEditField())
	->setKey($this->getCommitActionKey())
	->setTransactionType($this->getTransactionTypeConstant())
	+ ->setCanApplyWithoutEditCapability($is_audit)
	->setValue(true);

	if ($this->isActionAvailable($commit, $viewer)) {
	$label = $this->getCommitActionLabel();
	if ($label !== null) {
	$field->setCommentActionLabel($label);

	$description = $this->getCommitActionDescription();
	$field->setActionDescription($description);

	$group_key = $this->getCommitActionGroupKey();
	$field->setCommentActionGroupKey($group_key);

	$field->setActionConflictKey('commit.action');
	}
	}

	return $field;
	}

	public function validateTransactions($object, array $xactions) {
	$errors = array();
	$actor = $this->getActor();

	$action_exception = null;
	try {
	$this->validateAction($object, $actor);
	} catch (Exception $ex) {
	$action_exception = $ex;
	}

	foreach ($xactions as $xaction) {
	if ($action_exception) {
	$errors[] = $this->newInvalidError(
	$action_exception->getMessage(),
	$xaction);
	}
	}

	return $errors;
	}

	}
	diff --git a/src/applications/transactions/editengine/PhabricatorEditEngine.php b/src/applications/transactions/editengine/PhabricatorEditEngine.php
	index 4d1bdac921..9d769c0e66 100644
	--- a/src/applications/transactions/editengine/PhabricatorEditEngine.php
	+++ b/src/applications/transactions/editengine/PhabricatorEditEngine.php
	@@ -1,2343 +1,2374 @@
	<?php


	/**
	* @task fields Managing Fields
	* @task text Display Text
	* @task config Edit Engine Configuration
	* @task uri Managing URIs
	* @task load Creating and Loading Objects
	* @task web Responding to Web Requests
	* @task edit Responding to Edit Requests
	* @task http Responding to HTTP Parameter Requests
	* @task conduit Responding to Conduit Requests
	*/
	abstract class PhabricatorEditEngine
	extends Phobject
	implements PhabricatorPolicyInterface {

	const EDITENGINECONFIG_DEFAULT = 'default';

	const SUBTYPE_DEFAULT = 'default';

	private $viewer;
	private $controller;
	private $isCreate;
	private $editEngineConfiguration;
	private $contextParameters = array();
	private $targetObject;
	private $page;
	private $pages;
	private $navigation;
	private $hideHeader;

	final public function setViewer(PhabricatorUser $viewer) {
	$this->viewer = $viewer;
	return $this;
	}

	final public function getViewer() {
	return $this->viewer;
	}

	final public function setController(PhabricatorController $controller) {
	$this->controller = $controller;
	$this->setViewer($controller->getViewer());
	return $this;
	}

	final public function getController() {
	return $this->controller;
	}

	final public function getEngineKey() {
	$key = $this->getPhobjectClassConstant('ENGINECONST', 64);
	if (strpos($key, '/') !== false) {
	throw new Exception(
	pht(
	'EditEngine ("%s") contains an invalid key character "/".',
	get_class($this)));
	}
	return $key;
	}

	final public function getApplication() {
	$app_class = $this->getEngineApplicationClass();
	return PhabricatorApplication::getByClass($app_class);
	}

	final public function addContextParameter($key) {
	$this->contextParameters[] = $key;
	return $this;
	}

	public function isEngineConfigurable() {
	return true;
	}

	public function isEngineExtensible() {
	return true;
	}

	public function isDefaultQuickCreateEngine() {
	return false;
	}

	public function getDefaultQuickCreateFormKeys() {
	$keys = array();

	if ($this->isDefaultQuickCreateEngine()) {
	$keys[] = self::EDITENGINECONFIG_DEFAULT;
	}

	foreach ($keys as $idx => $key) {
	$keys[$idx] = $this->getEngineKey().'/'.$key;
	}

	return $keys;
	}

	public static function splitFullKey($full_key) {
	return explode('/', $full_key, 2);
	}

	public function getQuickCreateOrderVector() {
	return id(new PhutilSortVector())
	->addString($this->getObjectCreateShortText());
	}

	/**
	* Force the engine to edit a particular object.
	*/
	public function setTargetObject($target_object) {
	$this->targetObject = $target_object;
	return $this;
	}

	public function getTargetObject() {
	return $this->targetObject;
	}

	public function setNavigation(AphrontSideNavFilterView $navigation) {
	$this->navigation = $navigation;
	return $this;
	}

	public function getNavigation() {
	return $this->navigation;
	}

	public function setHideHeader($hide_header) {
	$this->hideHeader = $hide_header;
	return $this;
	}

	public function getHideHeader() {
	return $this->hideHeader;
	}


	/* -( Managing Fields )---------------------------------------------------- */


	abstract public function getEngineApplicationClass();
	abstract protected function buildCustomEditFields($object);

	public function getFieldsForConfig(
	PhabricatorEditEngineConfiguration $config) {

	$object = $this->newEditableObject();

	$this->editEngineConfiguration = $config;

	// This is mostly making sure that we fill in default values.
	$this->setIsCreate(true);

	return $this->buildEditFields($object);
	}

	final protected function buildEditFields($object) {
	$viewer = $this->getViewer();

	$fields = $this->buildCustomEditFields($object);

	foreach ($fields as $field) {
	$field
	->setViewer($viewer)
	->setObject($object);
	}

	$fields = mpull($fields, null, 'getKey');

	if ($this->isEngineExtensible()) {
	$extensions = PhabricatorEditEngineExtension::getAllEnabledExtensions();
	} else {
	$extensions = array();
	}

	foreach ($extensions as $extension) {
	$extension->setViewer($viewer);

	if (!$extension->supportsObject($this, $object)) {
	continue;
	}

	$extension_fields = $extension->buildCustomEditFields($this, $object);

	// TODO: Validate this in more detail with a more tailored error.
	assert_instances_of($extension_fields, 'PhabricatorEditField');

	foreach ($extension_fields as $field) {
	$field
	->setViewer($viewer)
	->setObject($object);
	}

	$extension_fields = mpull($extension_fields, null, 'getKey');

	foreach ($extension_fields as $key => $field) {
	$fields[$key] = $field;
	}
	}

	$config = $this->getEditEngineConfiguration();
	$fields = $this->willConfigureFields($object, $fields);
	$fields = $config->applyConfigurationToFields($this, $object, $fields);

	$fields = $this->applyPageToFields($object, $fields);

	return $fields;
	}

	protected function willConfigureFields($object, array $fields) {
	return $fields;
	}

	final public function supportsSubtypes() {
	try {
	$object = $this->newEditableObject();
	} catch (Exception $ex) {
	return false;
	}

	return ($object instanceof PhabricatorEditEngineSubtypeInterface);
	}

	final public function newSubtypeMap() {
	return $this->newEditableObject()->newEditEngineSubtypeMap();
	}


	/* -( Display Text )------------------------------------------------------- */


	/**
	* @task text
	*/
	abstract public function getEngineName();


	/**
	* @task text
	*/
	abstract protected function getObjectCreateTitleText($object);

	/**
	* @task text
	*/
	protected function getFormHeaderText($object) {
	$config = $this->getEditEngineConfiguration();
	return $config->getName();
	}

	/**
	* @task text
	*/
	abstract protected function getObjectEditTitleText($object);


	/**
	* @task text
	*/
	abstract protected function getObjectCreateShortText();


	/**
	* @task text
	*/
	abstract protected function getObjectName();


	/**
	* @task text
	*/
	abstract protected function getObjectEditShortText($object);


	/**
	* @task text
	*/
	protected function getObjectCreateButtonText($object) {
	return $this->getObjectCreateTitleText($object);
	}


	/**
	* @task text
	*/
	protected function getObjectEditButtonText($object) {
	return pht('Save Changes');
	}


	/**
	* @task text
	*/
	protected function getCommentViewSeriousHeaderText($object) {
	return pht('Take Action');
	}


	/**
	* @task text
	*/
	protected function getCommentViewSeriousButtonText($object) {
	return pht('Submit');
	}


	/**
	* @task text
	*/
	protected function getCommentViewHeaderText($object) {
	return $this->getCommentViewSeriousHeaderText($object);
	}


	/**
	* @task text
	*/
	protected function getCommentViewButtonText($object) {
	return $this->getCommentViewSeriousButtonText($object);
	}


	/**
	* Return a human-readable header describing what this engine is used to do,
	* like "Configure Maniphest Task Forms".
	*
	* @return string Human-readable description of the engine.
	* @task text
	*/
	abstract public function getSummaryHeader();


	/**
	* Return a human-readable summary of what this engine is used to do.
	*
	* @return string Human-readable description of the engine.
	* @task text
	*/
	abstract public function getSummaryText();




	/* -( Edit Engine Configuration )------------------------------------------ */


	protected function supportsEditEngineConfiguration() {
	return true;
	}

	final protected function getEditEngineConfiguration() {
	return $this->editEngineConfiguration;
	}

	private function newConfigurationQuery() {
	return id(new PhabricatorEditEngineConfigurationQuery())
	->setViewer($this->getViewer())
	->withEngineKeys(array($this->getEngineKey()));
	}

	private function loadEditEngineConfigurationWithQuery(
	PhabricatorEditEngineConfigurationQuery $query,
	$sort_method) {

	if ($sort_method) {
	$results = $query->execute();
	$results = msort($results, $sort_method);
	$result = head($results);
	} else {
	$result = $query->executeOne();
	}

	if (!$result) {
	return null;
	}

	$this->editEngineConfiguration = $result;
	return $result;
	}

	private function loadEditEngineConfigurationWithIdentifier($identifier) {
	$query = $this->newConfigurationQuery()
	->withIdentifiers(array($identifier));

	return $this->loadEditEngineConfigurationWithQuery($query, null);
	}

	private function loadDefaultConfiguration() {
	$query = $this->newConfigurationQuery()
	->withIdentifiers(
	array(
	self::EDITENGINECONFIG_DEFAULT,
	))
	->withIgnoreDatabaseConfigurations(true);

	return $this->loadEditEngineConfigurationWithQuery($query, null);
	}

	private function loadDefaultCreateConfiguration() {
	$query = $this->newConfigurationQuery()
	->withIsDefault(true)
	->withIsDisabled(false);

	return $this->loadEditEngineConfigurationWithQuery(
	$query,
	'getCreateSortKey');
	}

	public function loadDefaultEditConfiguration($object) {
	$query = $this->newConfigurationQuery()
	->withIsEdit(true)
	->withIsDisabled(false);

	// If this object supports subtyping, we edit it with a form of the same
	// subtype: so "bug" tasks get edited with "bug" forms.
	if ($object instanceof PhabricatorEditEngineSubtypeInterface) {
	$query->withSubtypes(
	array(
	$object->getEditEngineSubtype(),
	));
	}

	return $this->loadEditEngineConfigurationWithQuery(
	$query,
	'getEditSortKey');
	}

	final public function getBuiltinEngineConfigurations() {
	$configurations = $this->newBuiltinEngineConfigurations();

	if (!$configurations) {
	throw new Exception(
	pht(
	'EditEngine ("%s") returned no builtin engine configurations, but '.
	'an edit engine must have at least one configuration.',
	get_class($this)));
	}

	assert_instances_of($configurations, 'PhabricatorEditEngineConfiguration');

	$has_default = false;
	foreach ($configurations as $config) {
	if ($config->getBuiltinKey() == self::EDITENGINECONFIG_DEFAULT) {
	$has_default = true;
	}
	}

	if (!$has_default) {
	$first = head($configurations);
	if (!$first->getBuiltinKey()) {
	$first
	->setBuiltinKey(self::EDITENGINECONFIG_DEFAULT)
	->setIsDefault(true)
	->setIsEdit(true);

	if (!strlen($first->getName())) {
	$first->setName($this->getObjectCreateShortText());
	}
	} else {
	throw new Exception(
	pht(
	'EditEngine ("%s") returned builtin engine configurations, '.
	'but none are marked as default and the first configuration has '.
	'a different builtin key already. Mark a builtin as default or '.
	'omit the key from the first configuration',
	get_class($this)));
	}
	}

	$builtins = array();
	foreach ($configurations as $key => $config) {
	$builtin_key = $config->getBuiltinKey();

	if ($builtin_key === null) {
	throw new Exception(
	pht(
	'EditEngine ("%s") returned builtin engine configurations, '.
	'but one (with key "%s") is missing a builtin key. Provide a '.
	'builtin key for each configuration (you can omit it from the '.
	'first configuration in the list to automatically assign the '.
	'default key).',
	get_class($this),
	$key));
	}

	if (isset($builtins[$builtin_key])) {
	throw new Exception(
	pht(
	'EditEngine ("%s") returned builtin engine configurations, '.
	'but at least two specify the same builtin key ("%s"). Engines '.
	'must have unique builtin keys.',
	get_class($this),
	$builtin_key));
	}

	$builtins[$builtin_key] = $config;
	}


	return $builtins;
	}

	protected function newBuiltinEngineConfigurations() {
	return array(
	$this->newConfiguration(),
	);
	}

	final protected function newConfiguration() {
	return PhabricatorEditEngineConfiguration::initializeNewConfiguration(
	$this->getViewer(),
	$this);
	}


	/* -( Managing URIs )------------------------------------------------------ */


	/**
	* @task uri
	*/
	abstract protected function getObjectViewURI($object);


	/**
	* @task uri
	*/
	protected function getObjectCreateCancelURI($object) {
	return $this->getApplication()->getApplicationURI();
	}


	/**
	* @task uri
	*/
	protected function getEditorURI() {
	return $this->getApplication()->getApplicationURI('edit/');
	}


	/**
	* @task uri
	*/
	protected function getObjectEditCancelURI($object) {
	return $this->getObjectViewURI($object);
	}


	/**
	* @task uri
	*/
	public function getEditURI($object = null, $path = null) {
	$parts = array();

	$parts[] = $this->getEditorURI();

	if ($object && $object->getID()) {
	$parts[] = $object->getID().'/';
	}

	if ($path !== null) {
	$parts[] = $path;
	}

	return implode('', $parts);
	}

	public function getEffectiveObjectViewURI($object) {
	if ($this->getIsCreate()) {
	return $this->getObjectViewURI($object);
	}

	$page = $this->getSelectedPage();
	if ($page) {
	$view_uri = $page->getViewURI();
	if ($view_uri !== null) {
	return $view_uri;
	}
	}

	return $this->getObjectViewURI($object);
	}

	public function getEffectiveObjectEditDoneURI($object) {
	return $this->getEffectiveObjectViewURI($object);
	}

	public function getEffectiveObjectEditCancelURI($object) {
	$page = $this->getSelectedPage();
	if ($page) {
	$view_uri = $page->getViewURI();
	if ($view_uri !== null) {
	return $view_uri;
	}
	}

	return $this->getObjectEditCancelURI($object);
	}


	/* -( Creating and Loading Objects )--------------------------------------- */


	/**
	* Initialize a new object for creation.
	*
	* @return object Newly initialized object.
	* @task load
	*/
	abstract protected function newEditableObject();


	/**
	* Build an empty query for objects.
	*
	* @return PhabricatorPolicyAwareQuery Query.
	* @task load
	*/
	abstract protected function newObjectQuery();


	/**
	* Test if this workflow is creating a new object or editing an existing one.
	*
	* @return bool True if a new object is being created.
	* @task load
	*/
	final public function getIsCreate() {
	return $this->isCreate;
	}


	/**
	* Flag this workflow as a create or edit.
	*
	* @param bool True if this is a create workflow.
	* @return this
	* @task load
	*/
	private function setIsCreate($is_create) {
	$this->isCreate = $is_create;
	return $this;
	}


	/**
	* Try to load an object by ID, PHID, or monogram. This is done primarily
	* to make Conduit a little easier to use.
	*
	* @param wild ID, PHID, or monogram.
	* @param list<const> List of required capability constants, or omit for
	* defaults.
	* @return object Corresponding editable object.
	* @task load
	*/
	private function newObjectFromIdentifier(
	$identifier,
	array $capabilities = array()) {
	if (is_int($identifier) \|\| ctype_digit($identifier)) {
	$object = $this->newObjectFromID($identifier, $capabilities);

	if (!$object) {
	throw new Exception(
	pht(
	'No object exists with ID "%s".',
	$identifier));
	}

	return $object;
	}

	$type_unknown = PhabricatorPHIDConstants::PHID_TYPE_UNKNOWN;
	if (phid_get_type($identifier) != $type_unknown) {
	$object = $this->newObjectFromPHID($identifier, $capabilities);

	if (!$object) {
	throw new Exception(
	pht(
	'No object exists with PHID "%s".',
	$identifier));
	}

	return $object;
	}

	$target = id(new PhabricatorObjectQuery())
	->setViewer($this->getViewer())
	->withNames(array($identifier))
	->executeOne();
	if (!$target) {
	throw new Exception(
	pht(
	'Monogram "%s" does not identify a valid object.',
	$identifier));
	}

	$expect = $this->newEditableObject();
	$expect_class = get_class($expect);
	$target_class = get_class($target);
	if ($expect_class !== $target_class) {
	throw new Exception(
	pht(
	'Monogram "%s" identifies an object of the wrong type. Loaded '.
	'object has class "%s", but this editor operates on objects of '.
	'type "%s".',
	$identifier,
	$target_class,
	$expect_class));
	}

	// Load the object by PHID using this engine's standard query. This makes
	// sure it's really valid, goes through standard policy check logic, and
	// picks up any `need...()` clauses we want it to load with.

	$object = $this->newObjectFromPHID($target->getPHID(), $capabilities);
	if (!$object) {
	throw new Exception(
	pht(
	'Failed to reload object identified by monogram "%s" when '.
	'querying by PHID.',
	$identifier));
	}

	return $object;
	}

	/**
	* Load an object by ID.
	*
	* @param int Object ID.
	* @param list<const> List of required capability constants, or omit for
	* defaults.
	* @return object\|null Object, or null if no such object exists.
	* @task load
	*/
	private function newObjectFromID($id, array $capabilities = array()) {
	$query = $this->newObjectQuery()
	->withIDs(array($id));

	return $this->newObjectFromQuery($query, $capabilities);
	}


	/**
	* Load an object by PHID.
	*
	* @param phid Object PHID.
	* @param list<const> List of required capability constants, or omit for
	* defaults.
	* @return object\|null Object, or null if no such object exists.
	* @task load
	*/
	private function newObjectFromPHID($phid, array $capabilities = array()) {
	$query = $this->newObjectQuery()
	->withPHIDs(array($phid));

	return $this->newObjectFromQuery($query, $capabilities);
	}


	/**
	* Load an object given a configured query.
	*
	* @param PhabricatorPolicyAwareQuery Configured query.
	* @param list<const> List of required capabilitiy constants, or omit for
	* defaults.
	* @return object\|null Object, or null if no such object exists.
	* @task load
	*/
	private function newObjectFromQuery(
	PhabricatorPolicyAwareQuery $query,
	array $capabilities = array()) {

	$viewer = $this->getViewer();

	if (!$capabilities) {
	$capabilities = array(
	PhabricatorPolicyCapability::CAN_VIEW,
	PhabricatorPolicyCapability::CAN_EDIT,
	);
	}

	$object = $query
	->setViewer($viewer)
	->requireCapabilities($capabilities)
	->executeOne();
	if (!$object) {
	return null;
	}

	return $object;
	}


	/**
	* Verify that an object is appropriate for editing.
	*
	* @param wild Loaded value.
	* @return void
	* @task load
	*/
	private function validateObject($object) {
	if (!$object \|\| !is_object($object)) {
	throw new Exception(
	pht(
	'EditEngine "%s" created or loaded an invalid object: object must '.
	'actually be an object, but is of some other type ("%s").',
	get_class($this),
	gettype($object)));
	}

	if (!($object instanceof PhabricatorApplicationTransactionInterface)) {
	throw new Exception(
	pht(
	'EditEngine "%s" created or loaded an invalid object: object (of '.
	'class "%s") must implement "%s", but does not.',
	get_class($this),
	get_class($object),
	'PhabricatorApplicationTransactionInterface'));
	}
	}


	/* -( Responding to Web Requests )----------------------------------------- */


	final public function buildResponse() {
	$viewer = $this->getViewer();
	$controller = $this->getController();
	$request = $controller->getRequest();

	$action = $this->getEditAction();

	$capabilities = array();
	$use_default = false;
	$require_create = true;
	switch ($action) {
	case 'comment':
	$capabilities = array(
	PhabricatorPolicyCapability::CAN_VIEW,
	);
	$use_default = true;
	break;
	case 'parameters':
	$use_default = true;
	break;
	case 'nodefault':
	case 'nocreate':
	case 'nomanage':
	$require_create = false;
	break;
	default:
	break;
	}

	$object = $this->getTargetObject();
	if (!$object) {
	$id = $request->getURIData('id');

	if ($id) {
	$this->setIsCreate(false);
	$object = $this->newObjectFromID($id, $capabilities);
	if (!$object) {
	return new Aphront404Response();
	}
	} else {
	// Make sure the viewer has permission to create new objects of
	// this type if we're going to create a new object.
	if ($require_create) {
	$this->requireCreateCapability();
	}

	$this->setIsCreate(true);
	$object = $this->newEditableObject();
	}
	} else {
	$id = $object->getID();
	}

	$this->validateObject($object);

	if ($use_default) {
	$config = $this->loadDefaultConfiguration();
	if (!$config) {
	return new Aphront404Response();
	}
	} else {
	$form_key = $request->getURIData('formKey');
	if (strlen($form_key)) {
	$config = $this->loadEditEngineConfigurationWithIdentifier($form_key);

	if (!$config) {
	return new Aphront404Response();
	}

	if ($id && !$config->getIsEdit()) {
	return $this->buildNotEditFormRespose($object, $config);
	}
	} else {
	if ($id) {
	$config = $this->loadDefaultEditConfiguration($object);
	if (!$config) {
	return $this->buildNoEditResponse($object);
	}
	} else {
	$config = $this->loadDefaultCreateConfiguration();
	if (!$config) {
	return $this->buildNoCreateResponse($object);
	}
	}
	}
	}

	if ($config->getIsDisabled()) {
	return $this->buildDisabledFormResponse($object, $config);
	}

	$page_key = $request->getURIData('pageKey');
	if (!strlen($page_key)) {
	$pages = $this->getPages($object);
	if ($pages) {
	$page_key = head_key($pages);
	}
	}

	if (strlen($page_key)) {
	$page = $this->selectPage($object, $page_key);
	if (!$page) {
	return new Aphront404Response();
	}
	}

	switch ($action) {
	case 'parameters':
	return $this->buildParametersResponse($object);
	case 'nodefault':
	return $this->buildNoDefaultResponse($object);
	case 'nocreate':
	return $this->buildNoCreateResponse($object);
	case 'nomanage':
	return $this->buildNoManageResponse($object);
	case 'comment':
	return $this->buildCommentResponse($object);
	default:
	return $this->buildEditResponse($object);
	}
	}

	private function buildCrumbs($object, $final = false) {
	$controller = $this->getController();

	$crumbs = $controller->buildApplicationCrumbsForEditEngine();
	if ($this->getIsCreate()) {
	$create_text = $this->getObjectCreateShortText();
	if ($final) {
	$crumbs->addTextCrumb($create_text);
	} else {
	$edit_uri = $this->getEditURI($object);
	$crumbs->addTextCrumb($create_text, $edit_uri);
	}
	} else {
	$crumbs->addTextCrumb(
	$this->getObjectEditShortText($object),
	$this->getEffectiveObjectViewURI($object));

	$edit_text = pht('Edit');
	if ($final) {
	$crumbs->addTextCrumb($edit_text);
	} else {
	$edit_uri = $this->getEditURI($object);
	$crumbs->addTextCrumb($edit_text, $edit_uri);
	}
	}

	return $crumbs;
	}

	private function buildEditResponse($object) {
	$viewer = $this->getViewer();
	$controller = $this->getController();
	$request = $controller->getRequest();

	$fields = $this->buildEditFields($object);
	$template = $object->getApplicationTransactionTemplate();

	$config = $this->getEditEngineConfiguration()
	->attachEngine($this);

	$validation_exception = null;
	if ($request->isFormPost() && $request->getBool('editEngine')) {
	$submit_fields = $fields;

	foreach ($submit_fields as $key => $field) {
	if (!$field->shouldGenerateTransactionsFromSubmit()) {
	unset($submit_fields[$key]);
	continue;
	}
	}

	// Before we read the submitted values, store a copy of what we would
	// use if the form was empty so we can figure out which transactions are
	// just setting things to their default values for the current form.
	$defaults = array();
	foreach ($submit_fields as $key => $field) {
	$defaults[$key] = $field->getValueForTransaction();
	}

	foreach ($submit_fields as $key => $field) {
	$field->setIsSubmittedForm(true);

	if (!$field->shouldReadValueFromSubmit()) {
	continue;
	}

	$field->readValueFromSubmit($request);
	}

	$xactions = array();

	if ($this->getIsCreate()) {
	$xactions[] = id(clone $template)
	->setTransactionType(PhabricatorTransactions::TYPE_CREATE);

	if ($this->supportsSubtypes()) {
	$xactions[] = id(clone $template)
	->setTransactionType(PhabricatorTransactions::TYPE_SUBTYPE)
	->setNewValue($config->getSubtype());
	}
	}

	foreach ($submit_fields as $key => $field) {
	$field_value = $field->getValueForTransaction();

	$type_xactions = $field->generateTransactions(
	clone $template,
	array(
	'value' => $field_value,
	));

	foreach ($type_xactions as $type_xaction) {
	$default = $defaults[$key];

	if ($default === $field->getValueForTransaction()) {
	$type_xaction->setIsDefaultTransaction(true);
	}

	$xactions[] = $type_xaction;
	}
	}

	$editor = $object->getApplicationTransactionEditor()
	->setActor($viewer)
	->setContentSourceFromRequest($request)
	->setContinueOnNoEffect(true);

	try {
	$xactions = $this->willApplyTransactions($object, $xactions);

	$editor->applyTransactions($object, $xactions);

	$this->didApplyTransactions($object, $xactions);

	return $this->newEditResponse($request, $object, $xactions);
	} catch (PhabricatorApplicationTransactionValidationException $ex) {
	$validation_exception = $ex;

	foreach ($fields as $field) {
	$message = $this->getValidationExceptionShortMessage($ex, $field);
	if ($message === null) {
	continue;
	}

	$field->setControlError($message);
	}
	}
	} else {
	if ($this->getIsCreate()) {
	$template = $request->getStr('template');

	if (strlen($template)) {
	$template_object = $this->newObjectFromIdentifier(
	$template,
	array(
	PhabricatorPolicyCapability::CAN_VIEW,
	));
	if (!$template_object) {
	return new Aphront404Response();
	}
	} else {
	$template_object = null;
	}

	if ($template_object) {
	$copy_fields = $this->buildEditFields($template_object);
	$copy_fields = mpull($copy_fields, null, 'getKey');
	foreach ($copy_fields as $copy_key => $copy_field) {
	if (!$copy_field->getIsCopyable()) {
	unset($copy_fields[$copy_key]);
	}
	}
	} else {
	$copy_fields = array();
	}

	foreach ($fields as $field) {
	if (!$field->shouldReadValueFromRequest()) {
	continue;
	}

	$field_key = $field->getKey();
	if (isset($copy_fields[$field_key])) {
	$field->readValueFromField($copy_fields[$field_key]);
	}

	$field->readValueFromRequest($request);
	}
	}
	}

	$action_button = $this->buildEditFormActionButton($object);

	if ($this->getIsCreate()) {
	$header_text = $this->getFormHeaderText($object);
	$header_icon = 'fa-plus-square';
	} else {
	$header_text = $this->getObjectEditTitleText($object);
	$header_icon = 'fa-pencil';
	}

	$show_preview = !$request->isAjax();

	if ($show_preview) {
	$previews = array();
	foreach ($fields as $field) {
	$preview = $field->getPreviewPanel();
	if (!$preview) {
	continue;
	}

	$control_id = $field->getControlID();

	$preview
	->setControlID($control_id)
	->setPreviewURI('/transactions/remarkuppreview/');

	$previews[] = $preview;
	}
	} else {
	$previews = array();
	}

	$form = $this->buildEditForm($object, $fields);

	if ($request->isAjax()) {
	if ($this->getIsCreate()) {
	$cancel_uri = $this->getObjectCreateCancelURI($object);
	$submit_button = $this->getObjectCreateButtonText($object);
	} else {
	$cancel_uri = $this->getEffectiveObjectEditCancelURI($object);
	$submit_button = $this->getObjectEditButtonText($object);
	}

	return $this->getController()
	->newDialog()
	->setWidth(AphrontDialogView::WIDTH_FULL)
	->setTitle($header_text)
	->setValidationException($validation_exception)
	->appendForm($form)
	->addCancelButton($cancel_uri)
	->addSubmitButton($submit_button);
	}

	$crumbs = $this->buildCrumbs($object, $final = true);

	if ($this->getHideHeader()) {
	$header = null;
	$crumbs->setBorder(false);
	} else {
	$header = id(new PHUIHeaderView())
	->setHeader($header_text)
	->setHeaderIcon($header_icon);
	$crumbs->setBorder(true);
	}

	if ($action_button) {
	$header->addActionLink($action_button);
	}

	$box = id(new PHUIObjectBoxView())
	->setUser($viewer)
	->setHeaderText($this->getObjectName())
	->setValidationException($validation_exception)
	->setBackground(PHUIObjectBoxView::BLUE_PROPERTY)
	->appendChild($form);

	// This is fairly questionable, but in use by Settings.
	if ($request->getURIData('formSaved')) {
	$box->setFormSaved(true);
	}

	$content = array(
	$box,
	$previews,
	);

	$view = new PHUITwoColumnView();

	if ($header) {
	$view->setHeader($header);
	}

	$navigation = $this->getNavigation();
	if ($navigation) {
	$view
	->setNavigation($navigation)
	->setMainColumn($content);
	} else {
	$view->setFooter($content);
	}

	return $controller->newPage()
	->setTitle($header_text)
	->setCrumbs($crumbs)
	->appendChild($view);
	}

	protected function newEditResponse(
	AphrontRequest $request,
	$object,
	array $xactions) {
	return id(new AphrontRedirectResponse())
	->setURI($this->getEffectiveObjectEditDoneURI($object));
	}

	private function buildEditForm($object, array $fields) {
	$viewer = $this->getViewer();
	$controller = $this->getController();
	$request = $controller->getRequest();

	$fields = $this->willBuildEditForm($object, $fields);

	$form = id(new AphrontFormView())
	->setUser($viewer)
	->addHiddenInput('editEngine', 'true');

	foreach ($this->contextParameters as $param) {
	$form->addHiddenInput($param, $request->getStr($param));
	}

	foreach ($fields as $field) {
	$field->appendToForm($form);
	}

	if ($this->getIsCreate()) {
	$cancel_uri = $this->getObjectCreateCancelURI($object);
	$submit_button = $this->getObjectCreateButtonText($object);
	} else {
	$cancel_uri = $this->getEffectiveObjectEditCancelURI($object);
	$submit_button = $this->getObjectEditButtonText($object);
	}

	if (!$request->isAjax()) {
	$buttons = id(new AphrontFormSubmitControl())
	->setValue($submit_button);

	if ($cancel_uri) {
	$buttons->addCancelButton($cancel_uri);
	}

	$form->appendControl($buttons);
	}

	return $form;
	}

	protected function willBuildEditForm($object, array $fields) {
	return $fields;
	}

	private function buildEditFormActionButton($object) {
	if (!$this->isEngineConfigurable()) {
	return null;
	}

	$viewer = $this->getViewer();

	$action_view = id(new PhabricatorActionListView())
	->setUser($viewer);

	foreach ($this->buildEditFormActions($object) as $action) {
	$action_view->addAction($action);
	}

	$action_button = id(new PHUIButtonView())
	->setTag('a')
	->setText(pht('Configure Form'))
	->setHref('#')
	->setIcon('fa-gear')
	->setDropdownMenu($action_view);

	return $action_button;
	}

	private function buildEditFormActions($object) {
	$actions = array();

	if ($this->supportsEditEngineConfiguration()) {
	$engine_key = $this->getEngineKey();
	$config = $this->getEditEngineConfiguration();

	$can_manage = PhabricatorPolicyFilter::hasCapability(
	$this->getViewer(),
	$config,
	PhabricatorPolicyCapability::CAN_EDIT);

	if ($can_manage) {
	$manage_uri = $config->getURI();
	} else {
	$manage_uri = $this->getEditURI(null, 'nomanage/');
	}

	$view_uri = "/transactions/editengine/{$engine_key}/";

	$actions[] = id(new PhabricatorActionView())
	->setLabel(true)
	->setName(pht('Configuration'));

	$actions[] = id(new PhabricatorActionView())
	->setName(pht('View Form Configurations'))
	->setIcon('fa-list-ul')
	->setHref($view_uri);

	$actions[] = id(new PhabricatorActionView())
	->setName(pht('Edit Form Configuration'))
	->setIcon('fa-pencil')
	->setHref($manage_uri)
	->setDisabled(!$can_manage)
	->setWorkflow(!$can_manage);
	}

	$actions[] = id(new PhabricatorActionView())
	->setLabel(true)
	->setName(pht('Documentation'));

	$actions[] = id(new PhabricatorActionView())
	->setName(pht('Using HTTP Parameters'))
	->setIcon('fa-book')
	->setHref($this->getEditURI($object, 'parameters/'));

	$doc_href = PhabricatorEnv::getDoclink('User Guide: Customizing Forms');
	$actions[] = id(new PhabricatorActionView())
	->setName(pht('User Guide: Customizing Forms'))
	->setIcon('fa-book')
	->setHref($doc_href);

	return $actions;
	}


	/**
	* Test if the viewer could apply a certain type of change by using the
	* normal "Edit" form.
	*
	* This method returns `true` if the user has access to an edit form and
	* that edit form has a field which applied the specified transaction type,
	* and that field is visible and editable for the user.
	*
	* For example, you can use it to test if a user is able to reassign tasks
	* or not, prior to rendering dedicated UI for task reassingment.
	*
	* Note that this method does NOT test if the user can actually edit the
	* current object, just if they have access to the related field.
	*
	* @param const Transaction type to test for.
	* @return bool True if the user could "Edit" to apply the transaction type.
	*/
	final public function hasEditAccessToTransaction($xaction_type) {
	$viewer = $this->getViewer();

	$object = $this->getTargetObject();
	if (!$object) {
	$object = $this->newEditableObject();
	}

	$config = $this->loadDefaultEditConfiguration($object);
	if (!$config) {
	return false;
	}

	$fields = $this->buildEditFields($object);

	$field = null;
	foreach ($fields as $form_field) {
	$field_xaction_type = $form_field->getTransactionType();
	if ($field_xaction_type === $xaction_type) {
	$field = $form_field;
	break;
	}
	}

	if (!$field) {
	return false;
	}

	if (!$field->shouldReadValueFromSubmit()) {
	return false;
	}

	return true;
	}


	public function newNUXButton($text) {
	$specs = $this->newCreateActionSpecifications(array());
	$head = head($specs);

	return id(new PHUIButtonView())
	->setTag('a')
	->setText($text)
	->setHref($head['uri'])
	->setDisabled($head['disabled'])
	->setWorkflow($head['workflow'])
	->setColor(PHUIButtonView::GREEN);
	}


	final public function addActionToCrumbs(
	PHUICrumbsView $crumbs,
	array $parameters = array()) {
	$viewer = $this->getViewer();

	$specs = $this->newCreateActionSpecifications($parameters);

	$head = head($specs);
	$menu_uri = $head['uri'];

	$dropdown = null;
	if (count($specs) > 1) {
	$menu_icon = 'fa-caret-square-o-down';
	$menu_name = $this->getObjectCreateShortText();
	$workflow = false;
	$disabled = false;

	$dropdown = id(new PhabricatorActionListView())
	->setUser($viewer);

	foreach ($specs as $spec) {
	$dropdown->addAction(
	id(new PhabricatorActionView())
	->setName($spec['name'])
	->setIcon($spec['icon'])
	->setHref($spec['uri'])
	->setDisabled($head['disabled'])
	->setWorkflow($head['workflow']));
	}

	} else {
	$menu_icon = $head['icon'];
	$menu_name = $head['name'];

	$workflow = $head['workflow'];
	$disabled = $head['disabled'];
	}

	$action = id(new PHUIListItemView())
	->setName($menu_name)
	->setHref($menu_uri)
	->setIcon($menu_icon)
	->setWorkflow($workflow)
	->setDisabled($disabled);

	if ($dropdown) {
	$action->setDropdownMenu($dropdown);
	}

	$crumbs->addAction($action);
	}


	/**
	* Build a raw description of available "Create New Object" UI options so
	* other methods can build menus or buttons.
	*/
	public function newCreateActionSpecifications(array $parameters) {
	$viewer = $this->getViewer();

	$can_create = $this->hasCreateCapability();
	if ($can_create) {
	$configs = $this->loadUsableConfigurationsForCreate();
	} else {
	$configs = array();
	}

	$disabled = false;
	$workflow = false;

	$menu_icon = 'fa-plus-square';
	$specs = array();
	if (!$configs) {
	if ($viewer->isLoggedIn()) {
	$disabled = true;
	} else {
	// If the viewer isn't logged in, assume they'll get hit with a login
	// dialog and are likely able to create objects after they log in.
	$disabled = false;
	}
	$workflow = true;

	if ($can_create) {
	$create_uri = $this->getEditURI(null, 'nodefault/');
	} else {
	$create_uri = $this->getEditURI(null, 'nocreate/');
	}

	$specs[] = array(
	'name' => $this->getObjectCreateShortText(),
	'uri' => $create_uri,
	'icon' => $menu_icon,
	'disabled' => $disabled,
	'workflow' => $workflow,
	);
	} else {
	foreach ($configs as $config) {
	$config_uri = $config->getCreateURI();

	if ($parameters) {
	$config_uri = (string)id(new PhutilURI($config_uri))
	->setQueryParams($parameters);
	}

	$specs[] = array(
	'name' => $config->getDisplayName(),
	'uri' => $config_uri,
	'icon' => 'fa-plus',
	'disabled' => false,
	'workflow' => false,
	);
	}
	}

	return $specs;
	}

	final public function buildEditEngineCommentView($object) {
	$config = $this->loadDefaultEditConfiguration($object);

	if (!$config) {
	// TODO: This just nukes the entire comment form if you don't have access
	// to any edit forms. We might want to tailor this UX a bit.
	return id(new PhabricatorApplicationTransactionCommentView())
	->setNoPermission(true);
	}

	$viewer = $this->getViewer();
	$object_phid = $object->getPHID();

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

	if ($is_serious) {
	$header_text = $this->getCommentViewSeriousHeaderText($object);
	$button_text = $this->getCommentViewSeriousButtonText($object);
	} else {
	$header_text = $this->getCommentViewHeaderText($object);
	$button_text = $this->getCommentViewButtonText($object);
	}

	$comment_uri = $this->getEditURI($object, 'comment/');

	$view = id(new PhabricatorApplicationTransactionCommentView())
	->setUser($viewer)
	->setObjectPHID($object_phid)
	->setHeaderText($header_text)
	->setAction($comment_uri)
	->setSubmitButtonName($button_text);

	$draft = PhabricatorVersionedDraft::loadDraft(
	$object_phid,
	$viewer->getPHID());
	if ($draft) {
	$view->setVersionedDraft($draft);
	}

	$view->setCurrentVersion($this->loadDraftVersion($object));

	$fields = $this->buildEditFields($object);

	+ $can_edit = PhabricatorPolicyFilter::hasCapability(
	+ $viewer,
	+ $object,
	+ PhabricatorPolicyCapability::CAN_EDIT);
	+
	$comment_actions = array();
	foreach ($fields as $field) {
	if (!$field->shouldGenerateTransactionsFromComment()) {
	continue;
	}

	+ if (!$can_edit) {
	+ if (!$field->getCanApplyWithoutEditCapability()) {
	+ continue;
	+ }
	+ }
	+
	$comment_action = $field->getCommentAction();
	if (!$comment_action) {
	continue;
	}

	$key = $comment_action->getKey();

	// TODO: Validate these better.

	$comment_actions[$key] = $comment_action;
	}

	$comment_actions = msortv($comment_actions, 'getSortVector');

	$view->setCommentActions($comment_actions);

	$comment_groups = $this->newCommentActionGroups();
	$view->setCommentActionGroups($comment_groups);

	return $view;
	}

	protected function loadDraftVersion($object) {
	$viewer = $this->getViewer();

	if (!$viewer->isLoggedIn()) {
	return null;
	}

	$template = $object->getApplicationTransactionTemplate();
	$conn_r = $template->establishConnection('r');

	// Find the most recent transaction the user has written. We'll use this
	// as a version number to make sure that out-of-date drafts get discarded.
	$result = queryfx_one(
	$conn_r,
	'SELECT id AS version FROM %T
	WHERE objectPHID = %s AND authorPHID = %s
	ORDER BY id DESC LIMIT 1',
	$template->getTableName(),
	$object->getPHID(),
	$viewer->getPHID());

	if ($result) {
	return (int)$result['version'];
	} else {
	return null;
	}
	}


	/* -( Responding to HTTP Parameter Requests )------------------------------ */


	/**
	* Respond to a request for documentation on HTTP parameters.
	*
	* @param object Editable object.
	* @return AphrontResponse Response object.
	* @task http
	*/
	private function buildParametersResponse($object) {
	$controller = $this->getController();
	$viewer = $this->getViewer();
	$request = $controller->getRequest();
	$fields = $this->buildEditFields($object);

	$crumbs = $this->buildCrumbs($object);
	$crumbs->addTextCrumb(pht('HTTP Parameters'));
	$crumbs->setBorder(true);

	$header_text = pht(
	'HTTP Parameters: %s',
	$this->getObjectCreateShortText());

	$header = id(new PHUIHeaderView())
	->setHeader($header_text);

	$help_view = id(new PhabricatorApplicationEditHTTPParameterHelpView())
	->setUser($viewer)
	->setFields($fields);

	$document = id(new PHUIDocumentViewPro())
	->setUser($viewer)
	->setHeader($header)
	->appendChild($help_view);

	return $controller->newPage()
	->setTitle(pht('HTTP Parameters'))
	->setCrumbs($crumbs)
	->appendChild($document);
	}


	private function buildError($object, $title, $body) {
	$cancel_uri = $this->getObjectCreateCancelURI($object);

	return $this->getController()
	->newDialog()
	->setTitle($title)
	->appendParagraph($body)
	->addCancelButton($cancel_uri);
	}


	private function buildNoDefaultResponse($object) {
	return $this->buildError(
	$object,
	pht('No Default Create Forms'),
	pht(
	'This application is not configured with any forms for creating '.
	'objects that are visible to you and enabled.'));
	}

	private function buildNoCreateResponse($object) {
	return $this->buildError(
	$object,
	pht('No Create Permission'),
	pht('You do not have permission to create these objects.'));
	}

	private function buildNoManageResponse($object) {
	return $this->buildError(
	$object,
	pht('No Manage Permission'),
	pht(
	'You do not have permission to configure forms for this '.
	'application.'));
	}

	private function buildNoEditResponse($object) {
	return $this->buildError(
	$object,
	pht('No Edit Forms'),
	pht(
	'You do not have access to any forms which are enabled and marked '.
	'as edit forms.'));
	}

	private function buildNotEditFormRespose($object, $config) {
	return $this->buildError(
	$object,
	pht('Not an Edit Form'),
	pht(
	'This form ("%s") is not marked as an edit form, so '.
	'it can not be used to edit objects.',
	$config->getName()));
	}

	private function buildDisabledFormResponse($object, $config) {
	return $this->buildError(
	$object,
	pht('Form Disabled'),
	pht(
	'This form ("%s") has been disabled, so it can not be used.',
	$config->getName()));
	}

	private function buildCommentResponse($object) {
	$viewer = $this->getViewer();

	if ($this->getIsCreate()) {
	return new Aphront404Response();
	}

	$controller = $this->getController();
	$request = $controller->getRequest();

	if (!$request->isFormPost()) {
	return new Aphront400Response();
	}

	$config = $this->loadDefaultEditConfiguration($object);
	if (!$config) {
	return new Aphront404Response();
	}

	$fields = $this->buildEditFields($object);

	$is_preview = $request->isPreviewRequest();
	$view_uri = $this->getEffectiveObjectViewURI($object);

	$template = $object->getApplicationTransactionTemplate();
	$comment_template = $template->getApplicationTransactionCommentObject();

	$comment_text = $request->getStr('comment');

	$actions = $request->getStr('editengine.actions');
	if ($actions) {
	$actions = phutil_json_decode($actions);
	}

	if ($is_preview) {
	$version_key = PhabricatorVersionedDraft::KEY_VERSION;
	$request_version = $request->getInt($version_key);
	$current_version = $this->loadDraftVersion($object);
	if ($request_version >= $current_version) {
	$draft = PhabricatorVersionedDraft::loadOrCreateDraft(
	$object->getPHID(),
	$viewer->getPHID(),
	$current_version);

	$is_empty = (!strlen($comment_text) && !$actions);

	$draft
	->setProperty('comment', $comment_text)
	->setProperty('actions', $actions)
	->save();

	$draft_engine = $this->newDraftEngine($object);
	if ($draft_engine) {
	$draft_engine
	->setVersionedDraft($draft)
	->synchronize();
	}
	}
	}

	$xactions = array();

	+ $can_edit = PhabricatorPolicyFilter::hasCapability(
	+ $viewer,
	+ $object,
	+ PhabricatorPolicyCapability::CAN_EDIT);
	+
	if ($actions) {
	$action_map = array();
	foreach ($actions as $action) {
	$type = idx($action, 'type');
	if (!$type) {
	continue;
	}

	if (empty($fields[$type])) {
	continue;
	}

	$action_map[$type] = $action;
	}

	foreach ($action_map as $type => $action) {
	$field = $fields[$type];

	if (!$field->shouldGenerateTransactionsFromComment()) {
	continue;
	}

	+ // If you don't have edit permission on the object, you're limited in
	+ // which actions you can take via the comment form. Most actions
	+ // need edit permission, but some actions (like "Accept Revision")
	+ // can be applied by anyone with view permission.
	+ if (!$can_edit) {
	+ if (!$field->getCanApplyWithoutEditCapability()) {
	+ // We know the user doesn't have the capability, so this will
	+ // raise a policy exception.
	+ PhabricatorPolicyFilter::requireCapability(
	+ $viewer,
	+ $object,
	+ PhabricatorPolicyCapability::CAN_EDIT);
	+ }
	+ }
	+
	if (array_key_exists('initialValue', $action)) {
	$field->setInitialValue($action['initialValue']);
	}

	$field->readValueFromComment(idx($action, 'value'));

	$type_xactions = $field->generateTransactions(
	clone $template,
	array(
	'value' => $field->getValueForTransaction(),
	));
	foreach ($type_xactions as $type_xaction) {
	$xactions[] = $type_xaction;
	}
	}
	}

	$auto_xactions = $this->newAutomaticCommentTransactions($object);
	foreach ($auto_xactions as $xaction) {
	$xactions[] = $xaction;
	}

	if (strlen($comment_text) \|\| !$xactions) {
	$xactions[] = id(clone $template)
	->setTransactionType(PhabricatorTransactions::TYPE_COMMENT)
	->attachComment(
	id(clone $comment_template)
	->setContent($comment_text));
	}

	$editor = $object->getApplicationTransactionEditor()
	->setActor($viewer)
	->setContinueOnNoEffect($request->isContinueRequest())
	->setContinueOnMissingFields(true)
	->setContentSourceFromRequest($request)
	->setIsPreview($is_preview);

	try {
	$xactions = $editor->applyTransactions($object, $xactions);
	} catch (PhabricatorApplicationTransactionValidationException $ex) {
	return id(new PhabricatorApplicationTransactionValidationResponse())
	->setCancelURI($view_uri)
	->setException($ex);
	} catch (PhabricatorApplicationTransactionNoEffectException $ex) {
	return id(new PhabricatorApplicationTransactionNoEffectResponse())
	->setCancelURI($view_uri)
	->setException($ex);
	}

	if (!$is_preview) {
	PhabricatorVersionedDraft::purgeDrafts(
	$object->getPHID(),
	$viewer->getPHID(),
	$this->loadDraftVersion($object));

	$draft_engine = $this->newDraftEngine($object);
	if ($draft_engine) {
	$draft_engine
	->setVersionedDraft(null)
	->synchronize();
	}
	}

	if ($request->isAjax() && $is_preview) {
	$preview_content = $this->newCommentPreviewContent($object, $xactions);

	return id(new PhabricatorApplicationTransactionResponse())
	->setViewer($viewer)
	->setTransactions($xactions)
	->setIsPreview($is_preview)
	->setPreviewContent($preview_content);
	} else {
	return id(new AphrontRedirectResponse())
	->setURI($view_uri);
	}
	}

	protected function newDraftEngine($object) {
	$viewer = $this->getViewer();

	if ($object instanceof PhabricatorDraftInterface) {
	$engine = $object->newDraftEngine();
	} else {
	$engine = new PhabricatorBuiltinDraftEngine();
	}

	return $engine
	->setObject($object)
	->setViewer($viewer);
	}


	/* -( Conduit )------------------------------------------------------------ */


	/**
	* Respond to a Conduit edit request.
	*
	* This method accepts a list of transactions to apply to an object, and
	* either edits an existing object or creates a new one.
	*
	* @task conduit
	*/
	final public function buildConduitResponse(ConduitAPIRequest $request) {
	$viewer = $this->getViewer();

	$config = $this->loadDefaultConfiguration();
	if (!$config) {
	throw new Exception(
	pht(
	'Unable to load configuration for this EditEngine ("%s").',
	get_class($this)));
	}

	$identifier = $request->getValue('objectIdentifier');
	if ($identifier) {
	$this->setIsCreate(false);
	$object = $this->newObjectFromIdentifier($identifier);
	} else {
	$this->requireCreateCapability();

	$this->setIsCreate(true);
	$object = $this->newEditableObject();
	}

	$this->validateObject($object);

	$fields = $this->buildEditFields($object);

	$types = $this->getConduitEditTypesFromFields($fields);
	$template = $object->getApplicationTransactionTemplate();

	$xactions = $this->getConduitTransactions($request, $types, $template);

	$editor = $object->getApplicationTransactionEditor()
	->setActor($viewer)
	->setContentSource($request->newContentSource())
	->setContinueOnNoEffect(true);

	if (!$this->getIsCreate()) {
	$editor->setContinueOnMissingFields(true);
	}

	$xactions = $editor->applyTransactions($object, $xactions);

	$xactions_struct = array();
	foreach ($xactions as $xaction) {
	$xactions_struct[] = array(
	'phid' => $xaction->getPHID(),
	);
	}

	return array(
	'object' => array(
	'id' => $object->getID(),
	'phid' => $object->getPHID(),
	),
	'transactions' => $xactions_struct,
	);
	}


	/**
	* Generate transactions which can be applied from edit actions in a Conduit
	* request.
	*
	* @param ConduitAPIRequest The request.
	* @param list<PhabricatorEditType> Supported edit types.
	* @param PhabricatorApplicationTransaction Template transaction.
	* @return list<PhabricatorApplicationTransaction> Generated transactions.
	* @task conduit
	*/
	private function getConduitTransactions(
	ConduitAPIRequest $request,
	array $types,
	PhabricatorApplicationTransaction $template) {

	$viewer = $request->getUser();
	$transactions_key = 'transactions';

	$xactions = $request->getValue($transactions_key);
	if (!is_array($xactions)) {
	throw new Exception(
	pht(
	'Parameter "%s" is not a list of transactions.',
	$transactions_key));
	}

	foreach ($xactions as $key => $xaction) {
	if (!is_array($xaction)) {
	throw new Exception(
	pht(
	'Parameter "%s" must contain a list of transaction descriptions, '.
	'but item with key "%s" is not a dictionary.',
	$transactions_key,
	$key));
	}

	if (!array_key_exists('type', $xaction)) {
	throw new Exception(
	pht(
	'Parameter "%s" must contain a list of transaction descriptions, '.
	'but item with key "%s" is missing a "type" field. Each '.
	'transaction must have a type field.',
	$transactions_key,
	$key));
	}

	$type = $xaction['type'];
	if (empty($types[$type])) {
	throw new Exception(
	pht(
	'Transaction with key "%s" has invalid type "%s". This type is '.
	'not recognized. Valid types are: %s.',
	$key,
	$type,
	implode(', ', array_keys($types))));
	}
	}

	$results = array();

	if ($this->getIsCreate()) {
	$results[] = id(clone $template)
	->setTransactionType(PhabricatorTransactions::TYPE_CREATE);
	}

	foreach ($xactions as $xaction) {
	$type = $types[$xaction['type']];

	// Let the parameter type interpret the value. This allows you to
	// use usernames in list<user> fields, for example.
	$parameter_type = $type->getConduitParameterType();

	$parameter_type->setViewer($viewer);

	try {
	$xaction['value'] = $parameter_type->getValue(
	$xaction,
	'value',
	$request->getIsStrictlyTyped());
	} catch (Exception $ex) {
	throw new PhutilProxyException(
	pht(
	'Exception when processing transaction of type "%s": %s',
	$xaction['type'],
	$ex->getMessage()),
	$ex);
	}

	$type_xactions = $type->generateTransactions(
	clone $template,
	$xaction);

	foreach ($type_xactions as $type_xaction) {
	$results[] = $type_xaction;
	}
	}

	return $results;
	}


	/**
	* @return map<string, PhabricatorEditType>
	* @task conduit
	*/
	private function getConduitEditTypesFromFields(array $fields) {
	$types = array();
	foreach ($fields as $field) {
	$field_types = $field->getConduitEditTypes();

	if ($field_types === null) {
	continue;
	}

	foreach ($field_types as $field_type) {
	$field_type->setField($field);
	$types[$field_type->getEditType()] = $field_type;
	}
	}
	return $types;
	}

	public function getConduitEditTypes() {
	$config = $this->loadDefaultConfiguration();
	if (!$config) {
	return array();
	}

	$object = $this->newEditableObject();
	$fields = $this->buildEditFields($object);
	return $this->getConduitEditTypesFromFields($fields);
	}

	final public static function getAllEditEngines() {
	return id(new PhutilClassMapQuery())
	->setAncestorClass(__CLASS__)
	->setUniqueMethod('getEngineKey')
	->execute();
	}

	final public static function getByKey(PhabricatorUser $viewer, $key) {
	return id(new PhabricatorEditEngineQuery())
	->setViewer($viewer)
	->withEngineKeys(array($key))
	->executeOne();
	}

	public function getIcon() {
	$application = $this->getApplication();
	return $application->getIcon();
	}

	private function loadUsableConfigurationsForCreate() {
	$viewer = $this->getViewer();

	$configs = id(new PhabricatorEditEngineConfigurationQuery())
	->setViewer($viewer)
	->withEngineKeys(array($this->getEngineKey()))
	->withIsDefault(true)
	->withIsDisabled(false)
	->execute();

	$configs = msort($configs, 'getCreateSortKey');

	// Attach this specific engine to configurations we load so they can access
	// any runtime configuration. For example, this allows us to generate the
	// correct "Create Form" buttons when editing forms, see T12301.
	foreach ($configs as $config) {
	$config->attachEngine($this);
	}

	return $configs;
	}

	protected function getValidationExceptionShortMessage(
	PhabricatorApplicationTransactionValidationException $ex,
	PhabricatorEditField $field) {

	$xaction_type = $field->getTransactionType();
	if ($xaction_type === null) {
	return null;
	}

	return $ex->getShortMessage($xaction_type);
	}

	protected function getCreateNewObjectPolicy() {
	return PhabricatorPolicies::POLICY_USER;
	}

	private function requireCreateCapability() {
	PhabricatorPolicyFilter::requireCapability(
	$this->getViewer(),
	$this,
	PhabricatorPolicyCapability::CAN_EDIT);
	}

	private function hasCreateCapability() {
	return PhabricatorPolicyFilter::hasCapability(
	$this->getViewer(),
	$this,
	PhabricatorPolicyCapability::CAN_EDIT);
	}

	public function isCommentAction() {
	return ($this->getEditAction() == 'comment');
	}

	public function getEditAction() {
	$controller = $this->getController();
	$request = $controller->getRequest();
	return $request->getURIData('editAction');
	}

	protected function newCommentActionGroups() {
	return array();
	}

	protected function newAutomaticCommentTransactions($object) {
	return array();
	}

	protected function newCommentPreviewContent($object, array $xactions) {
	return null;
	}


	/* -( Form Pages )--------------------------------------------------------- */


	public function getSelectedPage() {
	return $this->page;
	}


	private function selectPage($object, $page_key) {
	$pages = $this->getPages($object);

	if (empty($pages[$page_key])) {
	return null;
	}

	$this->page = $pages[$page_key];
	return $this->page;
	}


	protected function newPages($object) {
	return array();
	}


	protected function getPages($object) {
	if ($this->pages === null) {
	$pages = $this->newPages($object);

	assert_instances_of($pages, 'PhabricatorEditPage');
	$pages = mpull($pages, null, 'getKey');

	$this->pages = $pages;
	}

	return $this->pages;
	}

	private function applyPageToFields($object, array $fields) {
	$pages = $this->getPages($object);
	if (!$pages) {
	return $fields;
	}

	if (!$this->getSelectedPage()) {
	return $fields;
	}

	$page_picks = array();
	$default_key = head($pages)->getKey();
	foreach ($pages as $page_key => $page) {
	foreach ($page->getFieldKeys() as $field_key) {
	$page_picks[$field_key] = $page_key;
	}
	if ($page->getIsDefault()) {
	$default_key = $page_key;
	}
	}

	$page_map = array_fill_keys(array_keys($pages), array());
	foreach ($fields as $field_key => $field) {
	if (isset($page_picks[$field_key])) {
	$page_map[$page_picks[$field_key]][$field_key] = $field;
	continue;
	}

	// TODO: Maybe let the field pick a page to associate itself with so
	// extensions can force themselves onto a particular page?

	$page_map[$default_key][$field_key] = $field;
	}

	$page = $this->getSelectedPage();
	if (!$page) {
	$page = head($pages);
	}

	$selected_key = $page->getKey();
	return $page_map[$selected_key];
	}

	protected function willApplyTransactions($object, array $xactions) {
	return $xactions;
	}

	protected function didApplyTransactions($object, array $xactions) {
	return;
	}


	/* -( PhabricatorPolicyInterface )----------------------------------------- */


	public function getPHID() {
	return get_class($this);
	}

	public function getCapabilities() {
	return array(
	PhabricatorPolicyCapability::CAN_VIEW,
	PhabricatorPolicyCapability::CAN_EDIT,
	);
	}

	public function getPolicy($capability) {
	switch ($capability) {
	case PhabricatorPolicyCapability::CAN_VIEW:
	return PhabricatorPolicies::getMostOpenPolicy();
	case PhabricatorPolicyCapability::CAN_EDIT:
	return $this->getCreateNewObjectPolicy();
	}
	}

	public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
	return false;
	}

	}
	diff --git a/src/applications/transactions/editfield/PhabricatorEditField.php b/src/applications/transactions/editfield/PhabricatorEditField.php
	index 2b0c93568b..3cc6fe2fff 100644
	--- a/src/applications/transactions/editfield/PhabricatorEditField.php
	+++ b/src/applications/transactions/editfield/PhabricatorEditField.php
	@@ -1,824 +1,834 @@
	<?php

	abstract class PhabricatorEditField extends Phobject {

	private $key;
	private $viewer;
	private $label;
	private $aliases = array();
	private $value;
	private $initialValue;
	private $hasValue = false;
	private $object;
	private $transactionType;
	private $metadata = array();
	private $editTypeKey;
	private $isRequired;
	private $previewPanel;
	private $controlID;
	private $controlInstructions;

	private $description;
	private $conduitDescription;
	private $conduitDocumentation;
	private $conduitTypeDescription;

	private $commentActionLabel;
	private $commentActionValue;
	private $commentActionGroupKey;
	private $commentActionOrder = 1000;
	private $hasCommentActionValue;

	private $isLocked;
	private $isHidden;

	private $isPreview;
	private $isEditDefaults;
	private $isSubmittedForm;
	private $controlError;
	+ private $canApplyWithoutEditCapability = false;

	private $isReorderable = true;
	private $isDefaultable = true;
	private $isLockable = true;
	private $isCopyable = false;
	private $isConduitOnly = false;

	private $conduitEditTypes;

	public function setKey($key) {
	$this->key = $key;
	return $this;
	}

	public function getKey() {
	return $this->key;
	}

	public function setLabel($label) {
	$this->label = $label;
	return $this;
	}

	public function getLabel() {
	return $this->label;
	}

	public function setViewer(PhabricatorUser $viewer) {
	$this->viewer = $viewer;
	return $this;
	}

	public function getViewer() {
	return $this->viewer;
	}

	public function setAliases(array $aliases) {
	$this->aliases = $aliases;
	return $this;
	}

	public function getAliases() {
	return $this->aliases;
	}

	public function setObject($object) {
	$this->object = $object;
	return $this;
	}

	public function getObject() {
	return $this->object;
	}

	public function setIsLocked($is_locked) {
	$this->isLocked = $is_locked;
	return $this;
	}

	public function getIsLocked() {
	return $this->isLocked;
	}

	public function setIsPreview($preview) {
	$this->isPreview = $preview;
	return $this;
	}

	public function getIsPreview() {
	return $this->isPreview;
	}

	public function setIsReorderable($is_reorderable) {
	$this->isReorderable = $is_reorderable;
	return $this;
	}

	public function getIsReorderable() {
	return $this->isReorderable;
	}

	public function setIsConduitOnly($is_conduit_only) {
	$this->isConduitOnly = $is_conduit_only;
	return $this;
	}

	public function getIsConduitOnly() {
	return $this->isConduitOnly;
	}

	public function setDescription($description) {
	$this->description = $description;
	return $this;
	}

	public function getDescription() {
	return $this->description;
	}

	public function setConduitDescription($conduit_description) {
	$this->conduitDescription = $conduit_description;
	return $this;
	}

	public function getConduitDescription() {
	if ($this->conduitDescription === null) {
	return $this->getDescription();
	}
	return $this->conduitDescription;
	}

	public function setConduitDocumentation($conduit_documentation) {
	$this->conduitDocumentation = $conduit_documentation;
	return $this;
	}

	public function getConduitDocumentation() {
	return $this->conduitDocumentation;
	}

	public function setConduitTypeDescription($conduit_type_description) {
	$this->conduitTypeDescription = $conduit_type_description;
	return $this;
	}

	public function getConduitTypeDescription() {
	return $this->conduitTypeDescription;
	}

	public function setIsEditDefaults($is_edit_defaults) {
	$this->isEditDefaults = $is_edit_defaults;
	return $this;
	}

	public function getIsEditDefaults() {
	return $this->isEditDefaults;
	}

	public function setIsDefaultable($is_defaultable) {
	$this->isDefaultable = $is_defaultable;
	return $this;
	}

	public function getIsDefaultable() {
	return $this->isDefaultable;
	}

	public function setIsLockable($is_lockable) {
	$this->isLockable = $is_lockable;
	return $this;
	}

	public function getIsLockable() {
	return $this->isLockable;
	}

	public function setIsHidden($is_hidden) {
	$this->isHidden = $is_hidden;
	return $this;
	}

	public function getIsHidden() {
	return $this->isHidden;
	}

	public function setIsCopyable($is_copyable) {
	$this->isCopyable = $is_copyable;
	return $this;
	}

	public function getIsCopyable() {
	return $this->isCopyable;
	}

	public function setIsSubmittedForm($is_submitted) {
	$this->isSubmittedForm = $is_submitted;
	return $this;
	}

	public function getIsSubmittedForm() {
	return $this->isSubmittedForm;
	}

	public function setIsRequired($is_required) {
	$this->isRequired = $is_required;
	return $this;
	}

	public function getIsRequired() {
	return $this->isRequired;
	}

	public function setControlError($control_error) {
	$this->controlError = $control_error;
	return $this;
	}

	public function getControlError() {
	return $this->controlError;
	}

	public function setCommentActionLabel($label) {
	$this->commentActionLabel = $label;
	return $this;
	}

	public function getCommentActionLabel() {
	return $this->commentActionLabel;
	}

	public function setCommentActionGroupKey($key) {
	$this->commentActionGroupKey = $key;
	return $this;
	}

	public function getCommentActionGroupKey() {
	return $this->commentActionGroupKey;
	}

	public function setCommentActionOrder($order) {
	$this->commentActionOrder = $order;
	return $this;
	}

	public function getCommentActionOrder() {
	return $this->commentActionOrder;
	}

	public function setCommentActionValue($comment_action_value) {
	$this->hasCommentActionValue = true;
	$this->commentActionValue = $comment_action_value;
	return $this;
	}

	public function getCommentActionValue() {
	return $this->commentActionValue;
	}

	public function setPreviewPanel(PHUIRemarkupPreviewPanel $preview_panel) {
	$this->previewPanel = $preview_panel;
	return $this;
	}

	public function getPreviewPanel() {
	return $this->previewPanel;
	}

	public function setControlInstructions($control_instructions) {
	$this->controlInstructions = $control_instructions;
	return $this;
	}

	public function getControlInstructions() {
	return $this->controlInstructions;
	}

	+ public function setCanApplyWithoutEditCapability($can_apply) {
	+ $this->canApplyWithoutEditCapability = $can_apply;
	+ return $this;
	+ }
	+
	+ public function getCanApplyWithoutEditCapability() {
	+ return $this->canApplyWithoutEditCapability;
	+ }
	+
	protected function newControl() {
	throw new PhutilMethodNotImplementedException();
	}

	protected function buildControl() {
	if ($this->getIsConduitOnly()) {
	return null;
	}

	$control = $this->newControl();
	if ($control === null) {
	return null;
	}

	$control
	->setValue($this->getValueForControl())
	->setName($this->getKey());

	if (!$control->getLabel()) {
	$control->setLabel($this->getLabel());
	}

	if ($this->getIsSubmittedForm()) {
	$error = $this->getControlError();
	if ($error !== null) {
	$control->setError($error);
	}
	} else if ($this->getIsRequired()) {
	$control->setError(true);
	}

	return $control;
	}

	public function getControlID() {
	if (!$this->controlID) {
	$this->controlID = celerity_generate_unique_node_id();
	}
	return $this->controlID;
	}

	protected function renderControl() {
	$control = $this->buildControl();
	if ($control === null) {
	return null;
	}

	if ($this->getIsPreview()) {
	$disabled = true;
	$hidden = false;
	} else if ($this->getIsEditDefaults()) {
	$disabled = false;
	$hidden = false;
	} else {
	$disabled = $this->getIsLocked();
	$hidden = $this->getIsHidden();
	}

	if ($hidden) {
	return null;
	}

	$control->setDisabled($disabled);

	if ($this->controlID) {
	$control->setID($this->controlID);
	}

	return $control;
	}

	public function appendToForm(AphrontFormView $form) {
	$control = $this->renderControl();
	if ($control !== null) {

	if ($this->getIsPreview()) {
	if ($this->getIsHidden()) {
	$control
	->addClass('aphront-form-preview-hidden')
	->setError(pht('Hidden'));
	} else if ($this->getIsLocked()) {
	$control
	->setError(pht('Locked'));
	}
	}

	$instructions = $this->getControlInstructions();
	if (strlen($instructions)) {
	$form->appendRemarkupInstructions($instructions);
	}

	$form->appendControl($control);
	}
	return $this;
	}

	protected function getValueForControl() {
	return $this->getValue();
	}

	public function getValueForDefaults() {
	$value = $this->getValue();

	// By default, just treat the empty string like `null` since they're
	// equivalent for almost all fields and this reduces the number of
	// meaningless transactions we generate when adjusting defaults.
	if ($value === '') {
	return null;
	}

	return $value;
	}

	protected function getValue() {
	return $this->value;
	}

	public function setValue($value) {
	$this->hasValue = true;
	$this->value = $value;

	// If we don't have an initial value set yet, use the value as the
	// initial value.
	$initial_value = $this->getInitialValue();
	if ($initial_value === null) {
	$this->initialValue = $value;
	}

	return $this;
	}

	public function setMetadataValue($key, $value) {
	$this->metadata[$key] = $value;
	return $this;
	}

	public function getMetadata() {
	return $this->metadata;
	}

	public function getValueForTransaction() {
	return $this->getValue();
	}

	public function getTransactionType() {
	return $this->transactionType;
	}

	public function setTransactionType($type) {
	$this->transactionType = $type;
	return $this;
	}

	public function readValueFromRequest(AphrontRequest $request) {
	$check = $this->getAllReadValueFromRequestKeys();
	foreach ($check as $key) {
	if (!$this->getValueExistsInRequest($request, $key)) {
	continue;
	}

	$this->value = $this->getValueFromRequest($request, $key);
	break;
	}
	return $this;
	}

	public function readValueFromComment($value) {
	$this->value = $this->getValueFromComment($value);
	return $this;
	}

	protected function getValueFromComment($value) {
	return $value;
	}

	public function getAllReadValueFromRequestKeys() {
	$keys = array();

	$keys[] = $this->getKey();
	foreach ($this->getAliases() as $alias) {
	$keys[] = $alias;
	}

	return $keys;
	}

	public function readDefaultValueFromConfiguration($value) {
	$this->value = $this->getDefaultValueFromConfiguration($value);
	return $this;
	}

	protected function getDefaultValueFromConfiguration($value) {
	return $value;
	}

	protected function getValueFromObject($object) {
	if ($this->hasValue) {
	return $this->value;
	} else {
	return $this->getDefaultValue();
	}
	}

	protected function getValueExistsInRequest(AphrontRequest $request, $key) {
	return $this->getHTTPParameterValueExists($request, $key);
	}

	protected function getValueFromRequest(AphrontRequest $request, $key) {
	return $this->getHTTPParameterValue($request, $key);
	}

	public function readValueFromField(PhabricatorEditField $other) {
	$this->value = $this->getValueFromField($other);
	return $this;
	}

	protected function getValueFromField(PhabricatorEditField $other) {
	return $other->getValue();
	}


	/**
	* Read and return the value the object had when the user first loaded the
	* form.
	*
	* This is the initial value from the user's point of view when they started
	* the edit process, and used primarily to prevent race conditions for fields
	* like "Projects" and "Subscribers" that use tokenizers and support edge
	* transactions.
	*
	* Most fields do not need to store these values or deal with initial value
	* handling.
	*
	* @param AphrontRequest Request to read from.
	* @param string Key to read.
	* @return wild Value read from request.
	*/
	protected function getInitialValueFromSubmit(AphrontRequest $request, $key) {
	return null;
	}

	public function getInitialValue() {
	return $this->initialValue;
	}

	public function setInitialValue($initial_value) {
	$this->initialValue = $initial_value;
	return $this;
	}

	public function readValueFromSubmit(AphrontRequest $request) {
	$key = $this->getKey();
	if ($this->getValueExistsInSubmit($request, $key)) {
	$value = $this->getValueFromSubmit($request, $key);
	} else {
	$value = $this->getDefaultValue();
	}
	$this->value = $value;

	$initial_value = $this->getInitialValueFromSubmit($request, $key);
	$this->initialValue = $initial_value;

	return $this;
	}

	protected function getValueExistsInSubmit(AphrontRequest $request, $key) {
	return $this->getHTTPParameterValueExists($request, $key);
	}

	protected function getValueFromSubmit(AphrontRequest $request, $key) {
	return $this->getHTTPParameterValue($request, $key);
	}

	protected function getHTTPParameterValueExists(
	AphrontRequest $request,
	$key) {
	$type = $this->getHTTPParameterType();

	if ($type) {
	return $type->getExists($request, $key);
	}

	return false;
	}

	protected function getHTTPParameterValue($request, $key) {
	$type = $this->getHTTPParameterType();

	if ($type) {
	return $type->getValue($request, $key);
	}

	return null;
	}

	protected function getDefaultValue() {
	$type = $this->getHTTPParameterType();

	if ($type) {
	return $type->getDefaultValue();
	}

	return null;
	}

	final public function getHTTPParameterType() {
	if ($this->getIsConduitOnly()) {
	return null;
	}

	$type = $this->newHTTPParameterType();

	if ($type) {
	$type->setViewer($this->getViewer());
	}

	return $type;
	}

	protected function newHTTPParameterType() {
	return new AphrontStringHTTPParameterType();
	}

	public function getConduitParameterType() {
	$type = $this->newConduitParameterType();

	if (!$type) {
	return null;
	}

	$type->setViewer($this->getViewer());

	return $type;
	}

	abstract protected function newConduitParameterType();

	public function setEditTypeKey($edit_type_key) {
	$this->editTypeKey = $edit_type_key;
	return $this;
	}

	public function getEditTypeKey() {
	if ($this->editTypeKey === null) {
	return $this->getKey();
	}
	return $this->editTypeKey;
	}

	protected function newEditType() {
	$parameter_type = $this->getConduitParameterType();
	if (!$parameter_type) {
	return null;
	}

	return id(new PhabricatorSimpleEditType())
	->setConduitParameterType($parameter_type);
	}

	protected function getEditType() {
	$transaction_type = $this->getTransactionType();

	if ($transaction_type === null) {
	return null;
	}

	$type_key = $this->getEditTypeKey();
	$edit_type = $this->newEditType();
	if (!$edit_type) {
	return null;
	}

	return $edit_type
	->setEditType($type_key)
	->setTransactionType($transaction_type)
	->setMetadata($this->getMetadata());
	}

	final public function getConduitEditTypes() {
	if ($this->conduitEditTypes === null) {
	$edit_types = $this->newConduitEditTypes();
	$edit_types = mpull($edit_types, null, 'getEditType');

	foreach ($edit_types as $edit_type) {
	$edit_type->setEditField($this);
	}

	$this->conduitEditTypes = $edit_types;
	}

	return $this->conduitEditTypes;
	}

	final public function getConduitEditType($key) {
	$edit_types = $this->getConduitEditTypes();

	if (empty($edit_types[$key])) {
	throw new Exception(
	pht(
	'This EditField does not provide a Conduit EditType with key "%s".',
	$key));
	}

	return $edit_types[$key];
	}

	protected function newConduitEditTypes() {
	$edit_type = $this->getEditType();

	if (!$edit_type) {
	return array();
	}

	return array($edit_type);
	}

	public function getCommentAction() {
	$label = $this->getCommentActionLabel();
	if ($label === null) {
	return null;
	}

	$action = $this->newCommentAction();
	if ($action === null) {
	return null;
	}

	if ($this->hasCommentActionValue) {
	$value = $this->getCommentActionValue();
	} else {
	$value = $this->getValue();
	}

	$action
	->setKey($this->getKey())
	->setLabel($label)
	->setValue($this->getValueForCommentAction($value))
	->setOrder($this->getCommentActionOrder())
	->setGroupKey($this->getCommentActionGroupKey());

	return $action;
	}

	protected function newCommentAction() {
	return null;
	}

	protected function getValueForCommentAction($value) {
	return $value;
	}

	public function shouldGenerateTransactionsFromSubmit() {
	if ($this->getIsConduitOnly()) {
	return false;
	}

	$edit_type = $this->getEditType();
	if (!$edit_type) {
	return false;
	}

	return true;
	}

	public function shouldReadValueFromRequest() {
	if ($this->getIsConduitOnly()) {
	return false;
	}

	if ($this->getIsLocked()) {
	return false;
	}

	if ($this->getIsHidden()) {
	return false;
	}

	return true;
	}

	public function shouldReadValueFromSubmit() {
	if ($this->getIsConduitOnly()) {
	return false;
	}

	if ($this->getIsLocked()) {
	return false;
	}

	if ($this->getIsHidden()) {
	return false;
	}

	return true;
	}

	public function shouldGenerateTransactionsFromComment() {
	if ($this->getIsConduitOnly()) {
	return false;
	}

	if ($this->getIsLocked()) {
	return false;
	}

	if ($this->getIsHidden()) {
	return false;
	}

	return true;
	}

	public function generateTransactions(
	PhabricatorApplicationTransaction $template,
	array $spec) {

	$edit_type = $this->getEditType();
	if (!$edit_type) {
	throw new Exception(
	pht(
	'EditField (with key "%s", of class "%s") is generating '.
	'transactions, but has no EditType.',
	$this->getKey(),
	get_class($this)));
	}

	return $edit_type->generateTransactions($template, $spec);
	}

	}
	diff --git a/src/applications/transactions/engineextension/PhabricatorCommentEditEngineExtension.php b/src/applications/transactions/engineextension/PhabricatorCommentEditEngineExtension.php
	index 7eb2aee037..3a01756ea7 100644
	--- a/src/applications/transactions/engineextension/PhabricatorCommentEditEngineExtension.php
	+++ b/src/applications/transactions/engineextension/PhabricatorCommentEditEngineExtension.php
	@@ -1,61 +1,66 @@
	<?php

	final class PhabricatorCommentEditEngineExtension
	extends PhabricatorEditEngineExtension {

	const EXTENSIONKEY = 'transactions.comment';
	const EDITKEY = 'comment';

	public function getExtensionPriority() {
	return 9000;
	}

	public function isExtensionEnabled() {
	return true;
	}

	public function getExtensionName() {
	return pht('Comments');
	}

	public function supportsObject(
	PhabricatorEditEngine $engine,
	PhabricatorApplicationTransactionInterface $object) {

	$xaction = $object->getApplicationTransactionTemplate();

	try {
	$comment = $xaction->getApplicationTransactionCommentObject();
	} catch (PhutilMethodNotImplementedException $ex) {
	$comment = null;
	}

	return (bool)$comment;
	}

	public function buildCustomEditFields(
	PhabricatorEditEngine $engine,
	PhabricatorApplicationTransactionInterface $object) {

	$comment_type = PhabricatorTransactions::TYPE_COMMENT;

	+ // Comments have a lot of special behavior which doesn't always check
	+ // this flag, but we set it for consistency.
	+ $is_interact = true;
	+
	$comment_field = id(new PhabricatorCommentEditField())
	->setKey(self::EDITKEY)
	->setLabel(pht('Comments'))
	->setAliases(array('comments'))
	->setIsHidden(true)
	->setIsReorderable(false)
	->setIsDefaultable(false)
	->setIsLockable(false)
	+ ->setCanApplyWithoutEditCapability($is_interact)
	->setTransactionType($comment_type)
	->setConduitDescription(pht('Make comments.'))
	->setConduitTypeDescription(
	pht('Comment to add, formatted as remarkup.'))
	->setValue(null);

	return array(
	$comment_field,
	);
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Sun, Jan 19, 17:08 (1 w, 5 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1126798
Default Alt Text: (93 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions