mirror of
https://we.phorge.it/source/phorge.git
synced 2024-09-20 01:08:50 +02:00
Add the skeleton for a "transaction.search" Conduit API method
Summary: Ref T5873. See PHI14. This does the basics that are shared across everything (IDs, PHIDs, dates, comments). It doesn't do types (I think I don't necessarily want to expose internal types over the API?) or transaction-specific data. In the next change, I'm going to add ways to let ModularTransactions "opt-in" to providing more data to Conduit. I'll use this to flesh out the actual desired transaction types (comments, presumably inline comments) and likely leave the rest as skeletons for now until use cases arise so we don't create a backward compatibility issue (or a security issue!) by exposing tons of internal stuff as public-facing API. Test Plan: Ran queries, used paging. Retrieved an edited, deleted, and normal comment. {F5120060} Reviewers: chad Reviewed By: chad Maniphest Tasks: T5873 Differential Revision: https://secure.phabricator.com/D18466
This commit is contained in:
epriestley
parent
ba1925b155
commit
2722c167d8
2 changed files with 154 additions and 0 deletions
|
|
@ -4884,6 +4884,7 @@ phutil_register_library_map(array(
|
|||
'TokenGiveConduitAPIMethod' => 'applications/tokens/conduit/TokenGiveConduitAPIMethod.php',
|
||||
'TokenGivenConduitAPIMethod' => 'applications/tokens/conduit/TokenGivenConduitAPIMethod.php',
|
||||
'TokenQueryConduitAPIMethod' => 'applications/tokens/conduit/TokenQueryConduitAPIMethod.php',
|
||||
'TransactionSearchConduitAPIMethod' => 'applications/transactions/conduit/TransactionSearchConduitAPIMethod.php',
|
||||
'UserConduitAPIMethod' => 'applications/people/conduit/UserConduitAPIMethod.php',
|
||||
'UserDisableConduitAPIMethod' => 'applications/people/conduit/UserDisableConduitAPIMethod.php',
|
||||
'UserEnableConduitAPIMethod' => 'applications/people/conduit/UserEnableConduitAPIMethod.php',
|
||||
|
|
@ -10631,6 +10632,7 @@ phutil_register_library_map(array(
|
|||
'TokenGiveConduitAPIMethod' => 'TokenConduitAPIMethod',
|
||||
'TokenGivenConduitAPIMethod' => 'TokenConduitAPIMethod',
|
||||
'TokenQueryConduitAPIMethod' => 'TokenConduitAPIMethod',
|
||||
'TransactionSearchConduitAPIMethod' => 'ConduitAPIMethod',
|
||||
'UserConduitAPIMethod' => 'ConduitAPIMethod',
|
||||
'UserDisableConduitAPIMethod' => 'UserConduitAPIMethod',
|
||||
'UserEnableConduitAPIMethod' => 'UserConduitAPIMethod',
|
||||
|
|
|
|||
|
|
@ -0,0 +1,152 @@
|
|||
<?php
|
||||
|
||||
final class TransactionSearchConduitAPIMethod
|
||||
extends ConduitAPIMethod {
|
||||
|
||||
public function getAPIMethodName() {
|
||||
return 'transaction.search';
|
||||
}
|
||||
|
||||
public function getMethodDescription() {
|
||||
return pht('Read transactions for an object.');
|
||||
}
|
||||
|
||||
public function getMethodStatus() {
|
||||
return self::METHOD_STATUS_UNSTABLE;
|
||||
}
|
||||
|
||||
public function getMethodStatusDescription() {
|
||||
return pht('This method is new and experimental.');
|
||||
}
|
||||
|
||||
protected function defineParamTypes() {
|
||||
return array(
|
||||
'objectIdentifier' => 'phid|string',
|
||||
) + $this->getPagerParamTypes();
|
||||
}
|
||||
|
||||
protected function defineReturnType() {
|
||||
return 'list<dict>';
|
||||
}
|
||||
|
||||
protected function defineErrorTypes() {
|
||||
return array();
|
||||
}
|
||||
|
||||
protected function execute(ConduitAPIRequest $request) {
|
||||
$viewer = $request->getUser();
|
||||
$pager = $this->newPager($request);
|
||||
|
||||
$object_name = $request->getValue('objectIdentifier', null);
|
||||
if (!strlen($object_name)) {
|
||||
throw new Exception(
|
||||
pht(
|
||||
'When calling "transaction.search", you must provide an object to '.
|
||||
'retrieve transactions for.'));
|
||||
}
|
||||
|
||||
$object = id(new PhabricatorObjectQuery())
|
||||
->setViewer($viewer)
|
||||
->withNames(array($object_name))
|
||||
->executeOne();
|
||||
if (!$object) {
|
||||
throw new Exception(
|
||||
pht(
|
||||
'No object "%s" exists.',
|
||||
$object_name));
|
||||
}
|
||||
|
||||
if (!($object instanceof PhabricatorApplicationTransactionInterface)) {
|
||||
throw new Exception(
|
||||
pht(
|
||||
'Object "%s" does not implement "%s", so transactions can not '.
|
||||
'be loaded for it.'));
|
||||
}
|
||||
|
||||
$xaction_query = PhabricatorApplicationTransactionQuery::newQueryForObject(
|
||||
$object);
|
||||
|
||||
$xactions = $xaction_query
|
||||
->withObjectPHIDs(array($object->getPHID()))
|
||||
->setViewer($viewer)
|
||||
->executeWithCursorPager($pager);
|
||||
|
||||
if ($xactions) {
|
||||
$template = head($xactions)->getApplicationTransactionCommentObject();
|
||||
|
||||
$query = new PhabricatorApplicationTransactionTemplatedCommentQuery();
|
||||
|
||||
$comment_map = $query
|
||||
->setViewer($viewer)
|
||||
->setTemplate($template)
|
||||
->withTransactionPHIDs(mpull($xactions, 'getPHID'))
|
||||
->execute();
|
||||
|
||||
$comment_map = msort($comment_map, 'getCommentVersion');
|
||||
$comment_map = array_reverse($comment_map);
|
||||
$comment_map = mgroup($comment_map, 'getTransactionPHID');
|
||||
} else {
|
||||
$comment_map = array();
|
||||
}
|
||||
|
||||
$data = array();
|
||||
foreach ($xactions as $xaction) {
|
||||
$comments = idx($comment_map, $xaction->getPHID());
|
||||
|
||||
$comment_data = array();
|
||||
if ($comments) {
|
||||
$removed = head($comments)->getIsDeleted();
|
||||
|
||||
foreach ($comments as $comment) {
|
||||
if ($removed) {
|
||||
// If the most recent version of the comment has been removed,
|
||||
// don't show the history. This is for consistency with the web
|
||||
// UI, which also prevents users from retrieving the content of
|
||||
// removed comments.
|
||||
$content = array(
|
||||
'raw' => '',
|
||||
);
|
||||
} else {
|
||||
$content = array(
|
||||
'raw' => (string)$comment->getContent(),
|
||||
);
|
||||
}
|
||||
|
||||
$comment_data[] = array(
|
||||
'id' => (int)$comment->getID(),
|
||||
'phid' => (string)$comment->getPHID(),
|
||||
'version' => (int)$comment->getCommentVersion(),
|
||||
'authorPHID' => (string)$comment->getAuthorPHID(),
|
||||
'dateCreated' => (int)$comment->getDateCreated(),
|
||||
'dateModified' => (int)$comment->getDateModified(),
|
||||
'removed' => (bool)$comment->getIsDeleted(),
|
||||
'content' => $content,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$fields = array();
|
||||
|
||||
if (!$fields) {
|
||||
$fields = (object)$fields;
|
||||
}
|
||||
|
||||
$data[] = array(
|
||||
'id' => (int)$xaction->getID(),
|
||||
'phid' => (string)$xaction->getPHID(),
|
||||
'authorPHID' => (string)$xaction->getAuthorPHID(),
|
||||
'objectPHID' => (string)$xaction->getObjectPHID(),
|
||||
'dateCreated' => (int)$xaction->getDateCreated(),
|
||||
'dateModified' => (int)$xaction->getDateModified(),
|
||||
'comments' => $comment_data,
|
||||
'fields' => $fields,
|
||||
);
|
||||
}
|
||||
|
||||
$results = array(
|
||||
'data' => $data,
|
||||
);
|
||||
|
||||
return $this->addPagerResults($results, $pager);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue