From 2f3869576871cb96bb0d8f90d3eaee0d9e4e22a1 Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Tue, 21 May 2019 06:04:37 -0700
Subject: [PATCH] Support export of feed transactions to CSV/Excel/etc

Summary: Depends on D20534. Ref T13294. Add export support so you can dump these out, print them on paper, notarize them, and store them in a box under a tree or whatever.

Test Plan: Exported transactions to a flat file, read the file.

Reviewers: amckinley

Reviewed By: amckinley

Maniphest Tasks: T13294

Differential Revision: https://secure.phabricator.com/D20535
---
 .../query/PhabricatorFeedTransactionQuery.php |  8 ++
 ...PhabricatorFeedTransactionSearchEngine.php | 76 +++++++++++++++++++
 2 files changed, 84 insertions(+)

diff --git a/src/applications/feed/query/PhabricatorFeedTransactionQuery.php b/src/applications/feed/query/PhabricatorFeedTransactionQuery.php
index ba25f0842d..d0a9f53e35 100644
--- a/src/applications/feed/query/PhabricatorFeedTransactionQuery.php
+++ b/src/applications/feed/query/PhabricatorFeedTransactionQuery.php
@@ -30,6 +30,14 @@ final class PhabricatorFeedTransactionQuery
     return $this;
   }
 
+  public function newResultObject() {
+    // Return an arbitrary valid transaction object. The actual query may
+    // return objects of any subclass of "ApplicationTransaction" when it is
+    // executed, but we need to pick something concrete here to make some
+    // integrations work (like automatic handling of PHIDs in data export).
+    return new PhabricatorUserTransaction();
+  }
+
   protected function loadPage() {
     $queries = $this->newTransactionQueries();
 
diff --git a/src/applications/feed/query/PhabricatorFeedTransactionSearchEngine.php b/src/applications/feed/query/PhabricatorFeedTransactionSearchEngine.php
index af40b6ff6b..0cbbcd23b1 100644
--- a/src/applications/feed/query/PhabricatorFeedTransactionSearchEngine.php
+++ b/src/applications/feed/query/PhabricatorFeedTransactionSearchEngine.php
@@ -151,4 +151,80 @@ final class PhabricatorFeedTransactionSearchEngine
       ->setTable($table);
   }
 
+  protected function newExportFields() {
+    $fields = array(
+      id(new PhabricatorPHIDExportField())
+        ->setKey('authorPHID')
+        ->setLabel(pht('Author PHID')),
+      id(new PhabricatorStringExportField())
+        ->setKey('author')
+        ->setLabel(pht('Author')),
+      id(new PhabricatorStringExportField())
+        ->setKey('objectType')
+        ->setLabel(pht('Object Type')),
+      id(new PhabricatorPHIDExportField())
+        ->setKey('objectPHID')
+        ->setLabel(pht('Object PHID')),
+      id(new PhabricatorStringExportField())
+        ->setKey('objectName')
+        ->setLabel(pht('Object Name')),
+      id(new PhabricatorStringExportField())
+        ->setKey('description')
+        ->setLabel(pht('Description')),
+    );
+
+    return $fields;
+  }
+
+  protected function newExportData(array $xactions) {
+    $viewer = $this->requireViewer();
+
+    $phids = array();
+    foreach ($xactions as $xaction) {
+      $phids[] = $xaction->getAuthorPHID();
+      $phids[] = $xaction->getObjectPHID();
+    }
+    $handles = $viewer->loadHandles($phids);
+
+    $export = array();
+    foreach ($xactions as $xaction) {
+      $xaction_phid = $xaction->getPHID();
+
+      $author_phid = $xaction->getAuthorPHID();
+      if ($author_phid) {
+        $author_name = $handles[$author_phid]->getName();
+      } else {
+        $author_name = null;
+      }
+
+      $object_phid = $xaction->getObjectPHID();
+      if ($object_phid) {
+        $object_name = $handles[$object_phid]->getName();
+      } else {
+        $object_name = null;
+      }
+
+      $old_target = $xaction->getRenderingTarget();
+      try {
+        $description = $xaction
+          ->setRenderingTarget(PhabricatorApplicationTransaction::TARGET_TEXT)
+          ->getTitle();
+      } catch (Exception $ex) {
+        $description = null;
+      }
+      $xaction->setRenderingTarget($old_target);
+
+      $export[] = array(
+        'authorPHID' => $author_phid,
+        'author' => $author_name,
+        'objectType' => phid_get_subtype($xaction_phid),
+        'objectPHID' => $object_phid,
+        'objectName' => $object_name,
+        'description' => $description,
+      );
+    }
+
+    return $export;
+  }
+
 }