Use application PHIDs for application transactions

Summary: Ref T2715. Ref T3578. Load application transactions through application PHID infrastructure. Test Plan: Viewed feed, saw successful loads of application transaction objects and rendered feed stories. Reviewers: btrahan Reviewed By: btrahan CC: aran Maniphest Tasks: T2715, T3578 Differential Revision: https://secure.phabricator.com/D6617
2024-11-10 00:42:41 +01:00 · 2013-07-29 06:51:19 -07:00 · 2013-07-29 06:51:19 -07:00 · 5cc3bbf721
commit 5cc3bbf721
parent 1720d651da
22 changed files with 101 additions and 102 deletions
--- a/resources/sql/patches/20130715.votecomments.php
+++ b/resources/sql/patches/20130715.votecomments.php
@ -43,7 +43,7 @@ foreach ($comments as $comment) {
  $comment_phid = PhabricatorPHID::generateNewPHID(
    PhabricatorPHIDConstants::PHID_TYPE_XCMT);
  $xaction_phid = PhabricatorPHID::generateNewPHID(
-    PhabricatorPHIDConstants::PHID_TYPE_XACT,
+    PhabricatorApplicationTransactionPHIDTypeTransaction::TYPECONST,
    PhabricatorSlowvotePHIDTypePoll::TYPECONST);

  $source = PhabricatorContentSource::newForSource(
--- a/resources/sql/patches/20130728.ponderxcomment.php
+++ b/resources/sql/patches/20130728.ponderxcomment.php
@ -27,11 +27,11 @@ foreach ($rows as $row) {
  }

  $comment_phid = PhabricatorPHID::generateNewPHID(
-    PhabricatorPHIDConstants::PHID_TYPE_XACT,
+    PhabricatorApplicationTransactionPHIDTypeTransaction::TYPECONST,
    $type);

  $xaction_phid = PhabricatorPHID::generateNewPHID(
-    PhabricatorPHIDConstants::PHID_TYPE_XACT,
+    PhabricatorApplicationTransactionPHIDTypeTransaction::TYPECONST,
    $type);

  queryfx(
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@ -833,6 +833,7 @@ phutil_register_library_map(array(
    'PhabricatorApplicationTransactionInterface' => 'applications/transactions/interface/PhabricatorApplicationTransactionInterface.php',
    'PhabricatorApplicationTransactionNoEffectException' => 'applications/transactions/exception/PhabricatorApplicationTransactionNoEffectException.php',
    'PhabricatorApplicationTransactionNoEffectResponse' => 'applications/transactions/response/PhabricatorApplicationTransactionNoEffectResponse.php',
+    'PhabricatorApplicationTransactionPHIDTypeTransaction' => 'applications/transactions/phid/PhabricatorApplicationTransactionPHIDTypeTransaction.php',
    'PhabricatorApplicationTransactionQuery' => 'applications/transactions/query/PhabricatorApplicationTransactionQuery.php',
    'PhabricatorApplicationTransactionResponse' => 'applications/transactions/response/PhabricatorApplicationTransactionResponse.php',
    'PhabricatorApplicationTransactionTextDiffDetailView' => 'applications/transactions/view/PhabricatorApplicationTransactionTextDiffDetailView.php',
@ -2844,6 +2845,7 @@ phutil_register_library_map(array(
    'PhabricatorApplicationTransactionFeedStory' => 'PhabricatorFeedStory',
    'PhabricatorApplicationTransactionNoEffectException' => 'Exception',
    'PhabricatorApplicationTransactionNoEffectResponse' => 'AphrontProxyResponse',
+    'PhabricatorApplicationTransactionPHIDTypeTransaction' => 'PhabricatorPHIDType',
    'PhabricatorApplicationTransactionQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
    'PhabricatorApplicationTransactionResponse' => 'AphrontProxyResponse',
    'PhabricatorApplicationTransactionTextDiffDetailView' => 'AphrontView',
--- a/src/applications/auth/query/PhabricatorAuthProviderConfigTransactionQuery.php
+++ b/src/applications/auth/query/PhabricatorAuthProviderConfigTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhabricatorAuthProviderConfigTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhabricatorAuthProviderConfigTransaction();
  }

--- a/src/applications/config/query/PhabricatorConfigTransactionQuery.php
+++ b/src/applications/config/query/PhabricatorConfigTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhabricatorConfigTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhabricatorConfigTransaction();
  }

--- a/src/applications/conpherence/query/ConpherenceTransactionQuery.php
+++ b/src/applications/conpherence/query/ConpherenceTransactionQuery.php
@ -6,7 +6,7 @@
 final class ConpherenceTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new ConpherenceTransaction();
  }

--- a/src/applications/legalpad/query/LegalpadTransactionQuery.php
+++ b/src/applications/legalpad/query/LegalpadTransactionQuery.php
@ -6,7 +6,7 @@
 final class LegalpadTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new LegalpadTransaction();
  }

--- a/src/applications/macro/query/PhabricatorMacroTransactionQuery.php
+++ b/src/applications/macro/query/PhabricatorMacroTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhabricatorMacroTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhabricatorMacroTransaction();
  }

--- a/src/applications/phid/PhabricatorPHIDConstants.php
+++ b/src/applications/phid/PhabricatorPHIDConstants.php
@ -20,7 +20,6 @@ final class PhabricatorPHIDConstants {
  const PHID_TYPE_CART    = 'CART';
  const PHID_TYPE_LEGB    = 'LEGB';

-  const PHID_TYPE_XACT    = 'XACT';
  const PHID_TYPE_XCMT    = 'XCMT';

  const PHID_TYPE_BOOK    = 'BOOK';
--- a/src/applications/phid/handle/PhabricatorObjectHandleData.php
+++ b/src/applications/phid/handle/PhabricatorObjectHandleData.php
@ -24,75 +24,10 @@ final class PhabricatorObjectHandleData {
  public function loadObjects() {
    $phids = array_fuse($this->phids);

-    $objects = id(new PhabricatorObjectQuery())
+    return id(new PhabricatorObjectQuery())
      ->setViewer($this->viewer)
      ->withPHIDs($phids)
      ->execute();
-
-    // For objects which don't support PhabricatorPHIDType yet, load them the
-    // old way.
-    $phids = array_diff_key($phids, array_keys($objects));
-    $types = phid_group_by_type($phids);
-    foreach ($types as $type => $phids) {
-      $objects += $this->loadObjectsOfType($type, $phids);
-    }
-
-    return $objects;
-  }
-
-  private function loadObjectsOfType($type, array $phids) {
-    if (!$this->viewer) {
-      throw new Exception(
-        "You must provide a viewer to load handles or objects.");
-    }
-
-    switch ($type) {
-
-      case PhabricatorPHIDConstants::PHID_TYPE_XACT:
-        $subtypes = array();
-        foreach ($phids as $phid) {
-          $subtypes[phid_get_subtype($phid)][] = $phid;
-        }
-        $xactions = array();
-        foreach ($subtypes as $subtype => $subtype_phids) {
-          // TODO: Do this magically.
-          // TODO: ^^^ Really do that ^^^
-          switch ($subtype) {
-            case PonderPHIDTypeQuestion::TYPECONST:
-              $results = id(new PonderQuestionTransactionQuery())
-                ->setViewer($this->viewer)
-                ->withPHIDs($subtype_phids)
-                ->execute();
-              $xactions += mpull($results, null, 'getPHID');
-              break;
-            case PonderPHIDTypeAnswer::TYPECONST:
-              $results = id(new PonderAnswerTransactionQuery())
-                ->setViewer($this->viewer)
-                ->withPHIDs($subtype_phids)
-                ->execute();
-              $xactions += mpull($results, null, 'getPHID');
-              break;
-            case PholioPHIDTypeMock::TYPECONST:
-              $results = id(new PholioTransactionQuery())
-                ->setViewer($this->viewer)
-                ->withPHIDs($subtype_phids)
-                ->execute();
-              $xactions += mpull($results, null, 'getPHID');
-              break;
-            case PhabricatorMacroPHIDTypeMacro::TYPECONST:
-              $results = id(new PhabricatorMacroTransactionQuery())
-                ->setViewer($this->viewer)
-                ->withPHIDs($subtype_phids)
-                ->execute();
-              $xactions += mpull($results, null, 'getPHID');
-              break;
-          }
-        }
-        return mpull($xactions, null, 'getPHID');
-
-    }
-
-    return array();
  }

  public function loadHandles() {
@ -111,15 +46,11 @@ final class PhabricatorObjectHandleData {
      }
    }

-    $all_objects = $this->loadObjects();
    $types = phid_group_by_type($phid_map);

    $handles = array();
-
    foreach ($types as $type => $phids) {
-      $objects = array_select_keys($all_objects, $phids);
      switch ($type) {
-
        case PhabricatorPHIDConstants::PHID_TYPE_MAGIC:
          // Black magic!
          foreach ($phids as $phid) {
@ -144,18 +75,6 @@ final class PhabricatorObjectHandleData {
            $handles[$phid] = $handle;
          }
          break;
-
-        default:
-          foreach ($phids as $phid) {
-            $handle = new PhabricatorObjectHandle();
-            $handle->setType($type);
-            $handle->setPHID($phid);
-            $handle->setName('Unknown Object');
-            $handle->setFullName('An Unknown Object');
-            $handles[$phid] = $handle;
-          }
-          break;
-
      }
    }

--- a/src/applications/phlux/query/PhluxTransactionQuery.php
+++ b/src/applications/phlux/query/PhluxTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhluxTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhluxTransaction();
  }

--- a/src/applications/pholio/query/PholioTransactionQuery.php
+++ b/src/applications/pholio/query/PholioTransactionQuery.php
@ -6,7 +6,7 @@
 final class PholioTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PholioTransaction();
  }

--- a/src/applications/phortune/query/PhortuneAccountTransactionQuery.php
+++ b/src/applications/phortune/query/PhortuneAccountTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhortuneAccountTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhortuneAccountTransaction();
  }

--- a/src/applications/phortune/query/PhortuneProductTransactionQuery.php
+++ b/src/applications/phortune/query/PhortuneProductTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhortuneProductTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhortuneProductTransaction();
  }

--- a/src/applications/ponder/query/PonderAnswerTransactionQuery.php
+++ b/src/applications/ponder/query/PonderAnswerTransactionQuery.php
@ -3,7 +3,7 @@
 final class PonderAnswerTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PonderAnswerTransaction();
  }

--- a/src/applications/ponder/query/PonderQuestionTransactionQuery.php
+++ b/src/applications/ponder/query/PonderQuestionTransactionQuery.php
@ -3,7 +3,7 @@
 final class PonderQuestionTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PonderQuestionTransaction();
  }

--- a/src/applications/releeph/query/ReleephRequestTransactionQuery.php
+++ b/src/applications/releeph/query/ReleephRequestTransactionQuery.php
@ -3,7 +3,7 @@
 final class ReleephRequestTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new ReleephRequestTransaction();
  }

--- a/src/applications/repository/query/PhabricatorRepositoryTransactionQuery.php
+++ b/src/applications/repository/query/PhabricatorRepositoryTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhabricatorRepositoryTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhabricatorRepositoryTransaction();
  }

--- a/src/applications/slowvote/query/PhabricatorSlowvoteTransactionQuery.php
+++ b/src/applications/slowvote/query/PhabricatorSlowvoteTransactionQuery.php
@ -3,7 +3,7 @@
 final class PhabricatorSlowvoteTransactionQuery
  extends PhabricatorApplicationTransactionQuery {

-  protected function getTemplateApplicationTransaction() {
+  public function getTemplateApplicationTransaction() {
    return new PhabricatorSlowvoteTransaction();
  }

--- a/src/applications/transactions/phid/PhabricatorApplicationTransactionPHIDTypeTransaction.php
+++ b/src/applications/transactions/phid/PhabricatorApplicationTransactionPHIDTypeTransaction.php
@ -0,0 +1,79 @@
+<?php
+
+final class PhabricatorApplicationTransactionPHIDTypeTransaction
+  extends PhabricatorPHIDType {
+
+  const TYPECONST = 'XACT';
+
+  public function getTypeConstant() {
+    return self::TYPECONST;
+  }
+
+  public function getTypeName() {
+    return pht('Transaction');
+  }
+
+  public function newObject() {
+    // NOTE: We could produce an object here, but we'd need to take a PHID type
+    // and subtype to do so. Currently, we never write edges to transactions,
+    // so leave this unimplemented for the moment.
+    return null;
+  }
+
+  public function loadObjects(
+    PhabricatorObjectQuery $object_query,
+    array $phids) {
+
+    static $queries;
+    if ($queries === null) {
+      $objects = id(new PhutilSymbolLoader())
+        ->setAncestorClass('PhabricatorApplicationTransactionQuery')
+        ->loadObjects();
+
+      $queries = array();
+      foreach ($objects as $object) {
+        $type = $object
+          ->getTemplateApplicationTransaction()
+          ->getApplicationTransactionType();
+
+        $queries[$type] = $object;
+      }
+    }
+
+    $phid_subtypes = array();
+    foreach ($phids as $phid) {
+      $subtype = phid_get_subtype($phid);
+      if ($subtype) {
+        $phid_subtypes[$subtype][] = $phid;
+      }
+    }
+
+    $results = array();
+    foreach ($phid_subtypes as $subtype => $subtype_phids) {
+      $query = idx($queries, $subtype);
+      if (!$query) {
+        continue;
+      }
+
+      $xactions = id(clone $query)
+        ->setViewer($object_query->getViewer())
+        ->withPHIDs($subtype_phids)
+        ->execute();
+
+      $results += mpull($xactions, null, 'getPHID');
+    }
+
+    return $results;
+  }
+
+  public function loadHandles(
+    PhabricatorHandleQuery $query,
+    array $handles,
+    array $objects) {
+
+    // NOTE: We don't produce meaningful handles here because they're
+    // impractical to produce and no application uses them.
+
+  }
+
+}
--- a/src/applications/transactions/query/PhabricatorApplicationTransactionQuery.php
+++ b/src/applications/transactions/query/PhabricatorApplicationTransactionQuery.php
@ -11,7 +11,7 @@ abstract class PhabricatorApplicationTransactionQuery
  private $needComments = true;
  private $needHandles  = true;

-  abstract protected function getTemplateApplicationTransaction();
+  abstract public function getTemplateApplicationTransaction();

  protected function buildMoreWhereClauses(AphrontDatabaseConnection $conn_r) {
    return array();
--- a/src/applications/transactions/storage/PhabricatorApplicationTransaction.php
+++ b/src/applications/transactions/storage/PhabricatorApplicationTransaction.php
@ -47,7 +47,7 @@ abstract class PhabricatorApplicationTransaction
  }

  public function generatePHID() {
-    $type = PhabricatorPHIDConstants::PHID_TYPE_XACT;
+    $type = PhabricatorApplicationTransactionPHIDTypeTransaction::TYPECONST;
    $subtype = $this->getApplicationTransactionType();

    return PhabricatorPHID::generateNewPHID($type, $subtype);