PhabricatorApplicationEditEngine.php
No OneTemporary
Actions

Size

20 KB

Referenced Files

None

Subscribers

None

PhabricatorApplicationEditEngine.php
View Options

	<?php


	/**
	* @task fields Managing Fields
	* @task text Display Text
	* @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 PhabricatorApplicationEditEngine extends Phobject {

	private $viewer;
	private $controller;
	private $isCreate;

	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;
	}


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


	abstract protected function buildCustomEditFields($object);

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

	$types = $editor->getTransactionTypesForObject($object);
	$types = array_fuse($types);

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

	if ($object instanceof PhabricatorPolicyInterface) {
	$policies = id(new PhabricatorPolicyQuery())
	->setViewer($viewer)
	->setObject($object)
	->execute();

	$map = array(
	PhabricatorTransactions::TYPE_VIEW_POLICY => array(
	'key' => 'policy.view',
	'aliases' => array('view'),
	'capability' => PhabricatorPolicyCapability::CAN_VIEW,
	'label' => pht('View Policy'),
	'description' => pht('Controls who can view the object.'),
	'edit' => 'view',
	),
	PhabricatorTransactions::TYPE_EDIT_POLICY => array(
	'key' => 'policy.edit',
	'aliases' => array('edit'),
	'capability' => PhabricatorPolicyCapability::CAN_EDIT,
	'label' => pht('Edit Policy'),
	'description' => pht('Controls who can edit the object.'),
	'edit' => 'edit',
	),
	PhabricatorTransactions::TYPE_JOIN_POLICY => array(
	'key' => 'policy.join',
	'aliases' => array('join'),
	'capability' => PhabricatorPolicyCapability::CAN_JOIN,
	'label' => pht('Join Policy'),
	'description' => pht('Controls who can join the object.'),
	'edit' => 'join',
	),
	);

	foreach ($map as $type => $spec) {
	if (empty($types[$type])) {
	continue;
	}

	$capability = $spec['capability'];
	$key = $spec['key'];
	$aliases = $spec['aliases'];
	$label = $spec['label'];
	$description = $spec['description'];
	$edit = $spec['edit'];

	$policy_field = id(new PhabricatorPolicyEditField())
	->setKey($key)
	->setLabel($label)
	->setDescription($description)
	->setAliases($aliases)
	->setCapability($capability)
	->setPolicies($policies)
	->setTransactionType($type)
	->setEditTypeKey($edit)
	->setValue($object->getPolicy($capability));
	$fields[] = $policy_field;

	if ($object instanceof PhabricatorSpacesInterface) {
	if ($capability == PhabricatorPolicyCapability::CAN_VIEW) {
	$type_space = PhabricatorTransactions::TYPE_SPACE;
	if (isset($types[$type_space])) {
	$space_field = id(new PhabricatorSpaceEditField())
	->setKey('spacePHID')
	->setLabel(pht('Space'))
	->setEditTypeKey('space')
	->setDescription(
	pht('Shifts the object in the Spaces application.'))
	->setAliases(array('space', 'policy.space'))
	->setTransactionType($type_space)
	->setValue($object->getSpacePHID());
	$fields[] = $space_field;

	$policy_field->setSpaceField($space_field);
	}
	}
	}
	}
	}

	$edge_type = PhabricatorTransactions::TYPE_EDGE;
	$object_phid = $object->getPHID();

	$project_edge_type = PhabricatorProjectObjectHasProjectEdgeType::EDGECONST;

	if ($object instanceof PhabricatorProjectInterface) {
	if (isset($types[$edge_type])) {
	if ($object_phid) {
	$project_phids = PhabricatorEdgeQuery::loadDestinationPHIDs(
	$object_phid,
	$project_edge_type);
	$project_phids = array_reverse($project_phids);
	} else {
	$project_phids = array();
	}

	$edge_field = id(new PhabricatorProjectsEditField())
	->setKey('projectPHIDs')
	->setLabel(pht('Projects'))
	->setEditTypeKey('projects')
	->setDescription(pht('Add or remove associated projects.'))
	->setAliases(array('project', 'projects'))
	->setTransactionType($edge_type)
	->setMetadataValue('edge:type', $project_edge_type)
	->setValue($project_phids);
	$fields[] = $edge_field;
	}
	}

	$subscribers_type = PhabricatorTransactions::TYPE_SUBSCRIBERS;

	if ($object instanceof PhabricatorSubscribableInterface) {
	if (isset($types[$subscribers_type])) {
	if ($object_phid) {
	$sub_phids = PhabricatorSubscribersQuery::loadSubscribersForPHID(
	$object_phid);
	} else {
	// TODO: Allow applications to provide default subscribers; Maniphest
	// does this at a minimum.
	$sub_phids = array();
	}

	$subscribers_field = id(new PhabricatorSubscribersEditField())
	->setKey('subscriberPHIDs')
	->setLabel(pht('Subscribers'))
	->setEditTypeKey('subscribers')
	->setDescription(pht('Manage subscribers.'))
	->setAliases(array('subscriber', 'subscribers'))
	->setTransactionType($subscribers_type)
	->setValue($sub_phids);
	$fields[] = $subscribers_field;
	}
	}

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

	return $fields;
	}


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


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


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


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


	/**
	* @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');
	}


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


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


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


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


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


	/**
	* @task uri
	*/
	protected function getEditURI($object, $path = null) {
	$parts = array(
	$this->getObjectEditURI($object),
	);

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

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

	return implode('', $parts);
	}


	/* -( 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 protected 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;
	}


	/**
	* Load an object by ID.
	*
	* @param int Object ID.
	* @return object\|null Object, or null if no such object exists.
	* @task load
	*/
	private function newObjectFromID($id) {
	$query = $this->newObjectQuery()
	->withIDs(array($id));

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


	/**
	* Load an object by PHID.
	*
	* @param phid Object PHID.
	* @return object\|null Object, or null if no such object exists.
	* @task load
	*/
	private function newObjectFromPHID($phid) {
	$query = $this->newObjectQuery()
	->withPHIDs(array($phid));

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


	/**
	* Load an object given a configured query.
	*
	* @param PhabricatorPolicyAwareQuery Configured query.
	* @return object\|null Object, or null if no such object exists.
	* @task load
	*/
	private function newObjectFromQuery(PhabricatorPolicyAwareQuery $query) {
	$viewer = $this->getViewer();

	$object = $query
	->setViewer($viewer)
	->requireCapabilities(
	array(
	PhabricatorPolicyCapability::CAN_VIEW,
	PhabricatorPolicyCapability::CAN_EDIT,
	))
	->executeOne();
	if (!$object) {
	return null;
	}

	return $object;
	}


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


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

	$id = $request->getURIData('id');
	if ($id) {
	$this->setIsCreate(false);
	$object = $this->newObjectFromID($id);
	if (!$object) {
	return new Aphront404Response();
	}
	} else {
	$this->setIsCreate(true);
	$object = $this->newEditableObject();
	}

	$action = $request->getURIData('editAction');
	switch ($action) {
	case 'parameters':
	return $this->buildParametersResponse($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($object);
	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->getObjectViewURI($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();

	$validation_exception = null;
	if ($request->isFormPost()) {
	foreach ($fields as $field) {
	$field->readValueFromSubmit($request);
	}

	$xactions = array();
	foreach ($fields as $field) {
	$xactions[] = $field->generateTransaction(clone $template);
	}

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

	try {

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

	return id(new AphrontRedirectResponse())
	->setURI($this->getObjectViewURI($object));
	} catch (PhabricatorApplicationTransactionValidationException $ex) {
	$validation_exception = $ex;
	}
	} else {
	if ($this->getIsCreate()) {
	foreach ($fields as $field) {
	$field->readValueFromRequest($request);
	}
	} else {
	foreach ($fields as $field) {
	$field->readValueFromObject($object);
	}
	}
	}

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

	if ($this->getIsCreate()) {
	$header_text = $this->getObjectCreateTitleText($object);
	} else {
	$header_text = $this->getObjectEditTitleText($object);
	}

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

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

	$box = id(new PHUIObjectBoxView())
	->setUser($viewer)
	->setHeader($header)
	->setValidationException($validation_exception)
	->appendChild($form);

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

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

	$form = id(new AphrontFormView())
	->setUser($viewer);

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

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

	$form->appendControl(
	id(new AphrontFormSubmitControl())
	->addCancelButton($cancel_uri)
	->setValue($submit_button));

	return $form;
	}

	private function buildEditFormActionButton($object) {
	$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('Actions'))
	->setHref('#')
	->setIconFont('fa-bars')
	->setDropdownMenu($action_view);

	return $action_button;
	}

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

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

	return $actions;
	}


	/* -( 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($object));

	$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)
	->addClass('pro-white-background')
	->appendChild($document);
	}


	/* -( 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();

	$phid = $request->getValue('objectPHID');
	if ($phid) {
	$this->setIsCreate(false);
	$object = $this->newObjectFromPHID($phid);
	if (!$object) {
	throw new Exception(pht('No such object with PHID "%s".', $phid));
	}
	} else {
	$this->setIsCreate(true);
	$object = $this->newEditableObject();
	}

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

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

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

	$editor = $object->getApplicationTransactionEditor()
	->setActor($viewer)
	->setContentSourceFromConduitRequest($request)
	->setContinueOnNoEffect(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) {

	$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();
	foreach ($xactions as $xaction) {
	$type = $types[$xaction['type']];

	$results[] = $type->generateTransaction(
	clone $template,
	$xaction);
	}

	return $results;
	}


	/**
	* @return map<string, PhabricatorEditType>
	* @task conduit
	*/
	private function getAllEditTypesFromFields(array $fields) {
	$types = array();
	foreach ($fields as $field) {
	$field_types = $field->getEditTransactionTypes();
	foreach ($field_types as $field_type) {
	$field_type->setField($field);
	$types[$field_type->getEditType()] = $field_type;
	}
	}
	return $types;
	}

	public function getAllEditTypes() {
	$object = $this->newEditableObject();
	$fields = $this->buildEditFields($object);
	return $this->getAllEditTypesFromFields($fields);
	}


	}

File Metadata

Mime Type: text/x-php
Expires: Mon, May 5, 4:30 PM (2 d)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 52734
Default Alt Text: PhabricatorApplicationEditEngine.php (20 KB)

PhabricatorApplicationEditEngine.phpNo OneTemporaryActions

PhabricatorApplicationEditEngine.phpView Options

File Metadata

Event Timeline

PhabricatorApplicationEditEngine.php
No OneTemporary
Actions

PhabricatorApplicationEditEngine.php
View Options