Flesh out ApplicationTransactions/CustomField integration

Summary:
None of this code is reachable yet. See discussion in D6147. Ref T1703.

Provide tighter integration between ApplicationTransactions and CustomField. Basically, I'm just trying to get all the shared stuff into the base implementation.

Test Plan: Code not reachable.

Reviewers: chad, seporaitis

Reviewed By: chad

CC: aran

Maniphest Tasks: T1703

Differential Revision: https://secure.phabricator.com/D6149

Author: epriestley

src/__phutil_library_map__.php

@@ -921,6 +921,8 @@
     'PhabricatorCustomFieldDataNotAvailableException' => 'infrastructure/customfield/exception/PhabricatorCustomFieldDataNotAvailableException.php',
     'PhabricatorCustomFieldImplementationIncompleteException' => 'infrastructure/customfield/exception/PhabricatorCustomFieldImplementationIncompleteException.php',
     'PhabricatorCustomFieldIndexStorage' => 'infrastructure/customfield/storage/PhabricatorCustomFieldIndexStorage.php',
+    'PhabricatorCustomFieldInterface' => 'infrastructure/customfield/interface/PhabricatorCustomFieldInterface.php',
+    'PhabricatorCustomFieldNotAttachedException' => 'infrastructure/customfield/exception/PhabricatorCustomFieldNotAttachedException.php',
     'PhabricatorCustomFieldNumericIndexStorage' => 'infrastructure/customfield/storage/PhabricatorCustomFieldNumericIndexStorage.php',
     'PhabricatorCustomFieldStorage' => 'infrastructure/customfield/storage/PhabricatorCustomFieldStorage.php',
     'PhabricatorCustomFieldStringIndexStorage' => 'infrastructure/customfield/storage/PhabricatorCustomFieldStringIndexStorage.php',
@@ -1541,7 +1543,7 @@
     'PhabricatorUnitsTestCase' => 'view/__tests__/PhabricatorUnitsTestCase.php',
     'PhabricatorUser' => 'applications/people/storage/PhabricatorUser.php',
     'PhabricatorUserDAO' => 'applications/people/storage/PhabricatorUserDAO.php',
-    'PhabricatorUserEditor' => 'applications/people/PhabricatorUserEditor.php',
+    'PhabricatorUserEditor' => 'applications/people/editor/PhabricatorUserEditor.php',
     'PhabricatorUserEmail' => 'applications/people/storage/PhabricatorUserEmail.php',
     'PhabricatorUserLDAPInfo' => 'applications/people/storage/PhabricatorUserLDAPInfo.php',
     'PhabricatorUserLog' => 'applications/people/storage/PhabricatorUserLog.php',
@@ -1554,6 +1556,7 @@
     'PhabricatorUserStatusInvalidEpochException' => 'applications/people/exception/PhabricatorUserStatusInvalidEpochException.php',
     'PhabricatorUserStatusOverlapException' => 'applications/people/exception/PhabricatorUserStatusOverlapException.php',
     'PhabricatorUserTestCase' => 'applications/people/storage/__tests__/PhabricatorUserTestCase.php',
+    'PhabricatorUserTransaction' => 'applications/people/storage/PhabricatorUserTransaction.php',
     'PhabricatorWorkboardExample' => 'applications/uiexample/examples/PhabricatorWorkboardExample.php',
     'PhabricatorWorkboardView' => 'view/layout/PhabricatorWorkboardView.php',
     'PhabricatorWorker' => 'infrastructure/daemon/workers/PhabricatorWorker.php',
@@ -2764,6 +2767,7 @@
     'PhabricatorCustomFieldDataNotAvailableException' => 'Exception',
     'PhabricatorCustomFieldImplementationIncompleteException' => 'Exception',
     'PhabricatorCustomFieldIndexStorage' => 'PhabricatorLiskDAO',
+    'PhabricatorCustomFieldNotAttachedException' => 'Exception',
     'PhabricatorCustomFieldNumericIndexStorage' => 'PhabricatorCustomFieldIndexStorage',
     'PhabricatorCustomFieldStorage' => 'PhabricatorLiskDAO',
     'PhabricatorCustomFieldStringIndexStorage' => 'PhabricatorCustomFieldIndexStorage',
@@ -3385,6 +3389,7 @@
     'PhabricatorUserStatusInvalidEpochException' => 'Exception',
     'PhabricatorUserStatusOverlapException' => 'Exception',
     'PhabricatorUserTestCase' => 'PhabricatorTestCase',
+    'PhabricatorUserTransaction' => 'PhabricatorApplicationTransaction',
     'PhabricatorWorkboardExample' => 'PhabricatorUIExample',
     'PhabricatorWorkboardView' => 'AphrontView',
     'PhabricatorWorkerActiveTask' => 'PhabricatorWorkerTask',

src/applications/people/PhabricatorUserEditor.php src/applications/people/editor/PhabricatorUserEditor.php

@@ -0,0 +1,23 @@
+<?php
+
+final class PhabricatorUserTransaction
+  extends PhabricatorApplicationTransaction {
+
+  public function getApplicationName() {
+    return 'user';
+  }
+
+  public function getApplicationTransactionType() {
+    return PhabricatorPHIDConstants::PHID_TYPE_USER;
+  }
+
+  public function getApplicationTransactionCommentObject() {
+    return null;
+  }
+
+  public function getApplicationObjectTypeName() {
+    return pht('user');
+  }
+
+}
+

src/applications/people/storage/PhabricatorUserTransaction.php

@@ -7,6 +7,7 @@ final class PhabricatorTransactions {
   const TYPE_VIEW_POLICY  = 'core:view-policy';
   const TYPE_EDIT_POLICY  = 'core:edit-policy';
   const TYPE_EDGE         = 'core:edge';
+  const TYPE_CUSTOMFIELD  = 'core:customfield';
 
   const COLOR_RED         = 'red';
   const COLOR_ORANGE      = 'orange';

src/applications/transactions/constants/PhabricatorTransactions.php

@@ -78,6 +78,10 @@ public function getTransactionTypes() {
       $types[] = PhabricatorTransactions::TYPE_SUBSCRIBERS;
     }
 
+    if ($this->object instanceof PhabricatorCustomFieldInterface) {
+      $types[] = PhabricatorTransactions::TYPE_CUSTOMFIELD;
+    }
+
     return $types;
   }
 
@@ -121,6 +125,9 @@ private function getTransactionOldValue(
           $old_edges = $old_edges[$edge_src][$edge_type];
         }
         return $old_edges;
+      case PhabricatorTransactions::TYPE_CUSTOMFIELD:
+        $field = $this->getCustomFieldForTransaction($object, $xaction);
+        return $field->getOldValueForApplicationTransactions();
       default:
         return $this->getCustomTransactionOldValue($object, $xaction);
     }
@@ -137,6 +144,9 @@ private function getTransactionNewValue(
         return $xaction->getNewValue();
       case PhabricatorTransactions::TYPE_EDGE:
         return $this->getEdgeTransactionNewValue($xaction);
+      case PhabricatorTransactions::TYPE_CUSTOMFIELD:
+        $field = $this->getCustomFieldForTransaction($object, $xaction);
+        return $field->getNewValueForApplicationTransactions();
       default:
         return $this->getCustomTransactionNewValue($object, $xaction);
     }
@@ -161,6 +171,9 @@ protected function transactionHasEffect(
     switch ($xaction->getTransactionType()) {
       case PhabricatorTransactions::TYPE_COMMENT:
         return $xaction->hasComment();
+      case PhabricatorTransactions::TYPE_CUSTOMFIELD:
+        $field = $this->getCustomFieldForTransaction($object, $xaction);
+        return $field->getApplicationTransactionHasEffect($xaction);
     }
 
     return ($xaction->getOldValue() !== $xaction->getNewValue());
@@ -176,6 +189,9 @@ private function applyInternalEffects(
       case PhabricatorTransactions::TYPE_EDIT_POLICY:
         $object->setEditPolicy($xaction->getNewValue());
         break;
+      case PhabricatorTransactions::TYPE_CUSTOMFIELD:
+        $field = $this->getCustomFieldForTransaction($object, $xaction);
+        return $field->applyApplicationTransactionInternalEffects($xaction);
     }
     return $this->applyCustomInternalTransaction($object, $xaction);
   }
@@ -240,6 +256,9 @@ private function applyExternalEffects(
 
         $editor->save();
         break;
+      case PhabricatorTransactions::TYPE_CUSTOMFIELD:
+        $field = $this->getCustomFieldForTransaction($object, $xaction);
+        return $field->applyApplicationTransactionExternalEffects($xaction);
     }
 
     return $this->applyCustomExternalTransaction($object, $xaction);
@@ -1244,4 +1263,41 @@ protected function supportsSearch() {
     return false;
   }
 
+
+/* -( Custom Fields  )------------------------------------------------------- */
+
+
+  /**
+   * @task customfield
+   */
+  private function getCustomFieldForTransaction(
+    PhabricatorLiskDAO $object,
+    PhabricatorApplicationTransaction $xaction) {
+
+    $field_key = $xaction->getMetadataValue('customfield:key');
+    if (!$field_key) {
+      throw new Exception(
+        "Custom field transaction has no 'customfield:key'!");
+    }
+
+    $field = PhabricatorCustomField::getObjectField(
+      $object,
+      PhabricatorCustomField::ROLE_APPLICATIONTRANSACTIONS,
+      $field_key);
+
+    if (!$field) {
+      throw new Exception(
+        "Custom field transaction has invalid 'customfield:key'; field ".
+        "'{$field_key}' is disabled or does not exist.");
+    }
+
+    if (!$field->shouldAppearInApplicationTransactions()) {
+      throw new Exception(
+        "Custom field transaction '{$field_key}' does not implement ".
+        "integration for ApplicationTransactions.");
+    }
+
+    return $field;
+  }
+
 }

src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php

@@ -0,0 +1,6 @@
+<?php
+
+final class PhabricatorCustomFieldNotAttachedException
+  extends Exception {
+
+}