ManiphestConduitAPIMethod.php
0426ce73f0e6stable

ManiphestConduitAPIMethod.php
View Options

			<?php

			abstract class ManiphestConduitAPIMethod extends ConduitAPIMethod {

			final public function getApplication() {
			return PhabricatorApplication::getByClass(
			'PhabricatorManiphestApplication');
			}

			protected function defineErrorTypes() {
			return array(
			'ERR-INVALID-PARAMETER' => pht('Missing or malformed parameter.'),
			);
			}

			protected function buildTaskInfoDictionary(ManiphestTask $task) {
			$results = $this->buildTaskInfoDictionaries(array($task));
			return idx($results, $task->getPHID());
			}

			protected function getTaskFields($is_new) {
			$fields = array();

			if (!$is_new) {
			$fields += array(
			'id' => 'optional int',
			'phid' => 'optional int',
			);
			}

			$fields += array(
			'title' => $is_new ? 'required string' : 'optional string',
			'description' => 'optional string',
			'ownerPHID' => 'optional phid',
			'viewPolicy' => 'optional phid or policy string',
			'editPolicy' => 'optional phid or policy string',
			'ccPHIDs' => 'optional list<phid>',
			'priority' => 'optional int',
			'projectPHIDs' => 'optional list<phid>',
			'auxiliary' => 'optional dict',
			);

			if (!$is_new) {
			$fields += array(
			'status' => 'optional string',
			'comments' => 'optional string',
			);
			}

			return $fields;
			}

			protected function applyRequest(
			ManiphestTask $task,
			ConduitAPIRequest $request,
			$is_new) {

			$changes = array();

			if ($is_new) {
			$task->setTitle((string)$request->getValue('title'));
			$task->setDescription((string)$request->getValue('description'));
			$changes[ManiphestTransaction::TYPE_STATUS] =
			ManiphestTaskStatus::getDefaultStatus();
			$changes[PhabricatorTransactions::TYPE_SUBSCRIBERS] =
			array('+' => array($request->getUser()->getPHID()));
			} else {

			$comments = $request->getValue('comments');
			if (!$is_new && $comments !== null) {
			$changes[PhabricatorTransactions::TYPE_COMMENT] = null;
			}

			$title = $request->getValue('title');
			if ($title !== null) {
			$changes[ManiphestTransaction::TYPE_TITLE] = $title;
			}

			$desc = $request->getValue('description');
			if ($desc !== null) {
			$changes[ManiphestTransaction::TYPE_DESCRIPTION] = $desc;
			}

			$status = $request->getValue('status');
			if ($status !== null) {
			$valid_statuses = ManiphestTaskStatus::getTaskStatusMap();
			if (!isset($valid_statuses[$status])) {
			throw id(new ConduitException('ERR-INVALID-PARAMETER'))
			->setErrorDescription(pht('Status set to invalid value.'));
			}
			$changes[ManiphestTransaction::TYPE_STATUS] = $status;
			}
			}

			$priority = $request->getValue('priority');
			if ($priority !== null) {
			$valid_priorities = ManiphestTaskPriority::getTaskPriorityMap();
			if (!isset($valid_priorities[$priority])) {
			throw id(new ConduitException('ERR-INVALID-PARAMETER'))
			->setErrorDescription(pht('Priority set to invalid value.'));
			}
			$changes[ManiphestTransaction::TYPE_PRIORITY] = $priority;
			}

			$owner_phid = $request->getValue('ownerPHID');
			if ($owner_phid !== null) {
			$this->validatePHIDList(
			array($owner_phid),
			PhabricatorPeopleUserPHIDType::TYPECONST,
			'ownerPHID');
			$changes[ManiphestTransaction::TYPE_OWNER] = $owner_phid;
			}

			$ccs = $request->getValue('ccPHIDs');
			if ($ccs !== null) {
			$changes[PhabricatorTransactions::TYPE_SUBSCRIBERS] =
			array('=' => array_fuse($ccs));
			}

			$transactions = array();

			$view_policy = $request->getValue('viewPolicy');
			if ($view_policy !== null) {
			$transactions[] = id(new ManiphestTransaction())
			->setTransactionType(PhabricatorTransactions::TYPE_VIEW_POLICY)
			->setNewValue($view_policy);
			}

			$edit_policy = $request->getValue('editPolicy');
			if ($edit_policy !== null) {
			$transactions[] = id(new ManiphestTransaction())
			->setTransactionType(PhabricatorTransactions::TYPE_EDIT_POLICY)
			->setNewValue($edit_policy);
			}

			$project_phids = $request->getValue('projectPHIDs');
			if ($project_phids !== null) {
			$this->validatePHIDList(
			$project_phids,
			PhabricatorProjectProjectPHIDType::TYPECONST,
			'projectPHIDS');

			$project_type = PhabricatorProjectObjectHasProjectEdgeType::EDGECONST;
			$transactions[] = id(new ManiphestTransaction())
			->setTransactionType(PhabricatorTransactions::TYPE_EDGE)
			->setMetadataValue('edge:type', $project_type)
			->setNewValue(
			array(
			'=' => array_fuse($project_phids),
			));
			}

			$template = new ManiphestTransaction();

			foreach ($changes as $type => $value) {
			$transaction = clone $template;
			$transaction->setTransactionType($type);
			if ($type == PhabricatorTransactions::TYPE_COMMENT) {
			$transaction->attachComment(
			id(new ManiphestTransactionComment())
			->setContent($comments));
			} else {
			$transaction->setNewValue($value);
			}

			$transactions[] = $transaction;
			}

			$field_list = PhabricatorCustomField::getObjectFields(
			$task,
			PhabricatorCustomField::ROLE_EDIT);
			$field_list->readFieldsFromStorage($task);

			$auxiliary = $request->getValue('auxiliary');
			if ($auxiliary) {
			foreach ($field_list->getFields() as $key => $field) {
			if (!array_key_exists($key, $auxiliary)) {
			continue;
			}
			$transaction = clone $template;
			$transaction->setTransactionType(
			PhabricatorTransactions::TYPE_CUSTOMFIELD);
			$transaction->setMetadataValue('customfield:key', $key);
			$transaction->setOldValue(
			$field->getOldValueForApplicationTransactions());
			$transaction->setNewValue($auxiliary[$key]);
			$transactions[] = $transaction;
			}
			}

			if (!$transactions) {
			return;
			}

			$content_source = $request->newContentSource();

			$editor = id(new ManiphestTransactionEditor())
			->setActor($request->getUser())
			->setContentSource($content_source)
			->setContinueOnNoEffect(true);

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

			$editor->applyTransactions($task, $transactions);

			// reload the task now that we've done all the fun stuff
			return id(new ManiphestTaskQuery())
			->setViewer($request->getUser())
			->withPHIDs(array($task->getPHID()))
			->needSubscriberPHIDs(true)
			->needProjectPHIDs(true)
			->executeOne();
			}

			protected function buildTaskInfoDictionaries(array $tasks) {
			assert_instances_of($tasks, 'ManiphestTask');
			if (!$tasks) {
			return array();
			}

			$task_phids = mpull($tasks, 'getPHID');

			$all_deps = id(new PhabricatorEdgeQuery())
			->withSourcePHIDs($task_phids)
			->withEdgeTypes(array(ManiphestTaskDependsOnTaskEdgeType::EDGECONST));
			$all_deps->execute();

			$result = array();
			foreach ($tasks as $task) {
			// TODO: Batch this get as CustomField gets cleaned up.
			$field_list = PhabricatorCustomField::getObjectFields(
			$task,
			PhabricatorCustomField::ROLE_EDIT);
			$field_list->readFieldsFromStorage($task);

			$auxiliary = mpull(
			$field_list->getFields(),
			'getValueForStorage',
			'getFieldKey');

			$task_deps = $all_deps->getDestinationPHIDs(
			array($task->getPHID()),
			array(ManiphestTaskDependsOnTaskEdgeType::EDGECONST));

			$result[$task->getPHID()] = array(
			'id' => $task->getID(),
			'phid' => $task->getPHID(),
			'authorPHID' => $task->getAuthorPHID(),
			'ownerPHID' => $task->getOwnerPHID(),
			'ccPHIDs' => $task->getSubscriberPHIDs(),
			'status' => $task->getStatus(),
			'statusName' => ManiphestTaskStatus::getTaskStatusName(
			$task->getStatus()),
			'isClosed' => $task->isClosed(),
			'priority' => ManiphestTaskPriority::getTaskPriorityName(
			$task->getPriority()),
			'priorityColor' => ManiphestTaskPriority::getTaskPriorityColor(
			$task->getPriority()),
			'title' => $task->getTitle(),
			'description' => $task->getDescription(),
			'projectPHIDs' => $task->getProjectPHIDs(),
			'uri' => PhabricatorEnv::getProductionURI('/T'.$task->getID()),
			'auxiliary' => $auxiliary,

			'objectName' => 'T'.$task->getID(),
			'dateCreated' => $task->getDateCreated(),
			'dateModified' => $task->getDateModified(),
			'dependsOnTaskPHIDs' => $task_deps,
			);
			}

			return $result;
			}

			/**
			* NOTE: This is a temporary stop gap since its easy to make malformed tasks.
			* Long-term, the values set in @{method:defineParamTypes} will be used to
			* validate data implicitly within the larger Conduit application.
			*
			* TODO: Remove this in favor of generalized Conduit hotness.
			*/
			private function validatePHIDList(array $phid_list, $phid_type, $field) {
			$phid_groups = phid_group_by_type($phid_list);
			unset($phid_groups[$phid_type]);
			if (!empty($phid_groups)) {
			throw id(new ConduitException('ERR-INVALID-PARAMETER'))
			->setErrorDescription(
			pht(
			'One or more PHIDs were invalid for %s.',
			$field));
			}

			return true;
			}

			}

phab/src/applications/maniphest/conduit/ManiphestConduitAPIMethod.php0426ce73f0e6stable

ManiphestConduitAPIMethod.phpView Options

phab/src/applications/maniphest/conduit/ManiphestConduitAPIMethod.php
0426ce73f0e6stable

ManiphestConduitAPIMethod.php
View Options