Move most Herald actions and values into dynamic adapters

epriestley · epriestley · commit 9c637604a25b · 2013-08-07T18:03:54.000-07:00
Summary: Ref T2769. Shift the bulk of value and action config into Adapters. Test Plan: Viewed and edited Herald list and rules. Reviewers: btrahan Reviewed By: btrahan CC: aran, vrana Maniphest Tasks: T2769 Differential Revision: https://secure.phabricator.com/D6660
diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
@@ -635,7 +635,6 @@
     'HeraldTranscript' => 'applications/herald/storage/transcript/HeraldTranscript.php',
     'HeraldTranscriptController' => 'applications/herald/controller/HeraldTranscriptController.php',
     'HeraldTranscriptListController' => 'applications/herald/controller/HeraldTranscriptListController.php',
-    'HeraldValueTypeConfig' => 'applications/herald/config/HeraldValueTypeConfig.php',
     'Javelin' => 'infrastructure/javelin/Javelin.php',
     'JavelinReactorExample' => 'applications/uiexample/examples/JavelinReactorExample.php',
     'JavelinUIExample' => 'applications/uiexample/examples/JavelinUIExample.php',
diff --git a/src/applications/herald/adapter/HeraldAdapter.php b/src/applications/herald/adapter/HeraldAdapter.php
@@ -16,23 +16,41 @@ abstract class HeraldAdapter {
   const FIELD_AFFECTED_PACKAGE       = 'affected-package';
   const FIELD_AFFECTED_PACKAGE_OWNER = 'affected-package-owner';
 
-  const CONDITION_CONTAINS        = 'contains';
-  const CONDITION_NOT_CONTAINS    = '!contains';
-  const CONDITION_IS              = 'is';
-  const CONDITION_IS_NOT          = '!is';
-  const CONDITION_IS_ANY          = 'isany';
-  const CONDITION_IS_NOT_ANY      = '!isany';
-  const CONDITION_INCLUDE_ALL     = 'all';
-  const CONDITION_INCLUDE_ANY     = 'any';
-  const CONDITION_INCLUDE_NONE    = 'none';
-  const CONDITION_IS_ME           = 'me';
-  const CONDITION_IS_NOT_ME       = '!me';
-  const CONDITION_REGEXP          = 'regexp';
-  const CONDITION_RULE            = 'conditions';
-  const CONDITION_NOT_RULE        = '!conditions';
-  const CONDITION_EXISTS          = 'exists';
-  const CONDITION_NOT_EXISTS      = '!exists';
-  const CONDITION_REGEXP_PAIR     = 'regexp-pair';
+  const CONDITION_CONTAINS      = 'contains';
+  const CONDITION_NOT_CONTAINS  = '!contains';
+  const CONDITION_IS            = 'is';
+  const CONDITION_IS_NOT        = '!is';
+  const CONDITION_IS_ANY        = 'isany';
+  const CONDITION_IS_NOT_ANY    = '!isany';
+  const CONDITION_INCLUDE_ALL   = 'all';
+  const CONDITION_INCLUDE_ANY   = 'any';
+  const CONDITION_INCLUDE_NONE  = 'none';
+  const CONDITION_IS_ME         = 'me';
+  const CONDITION_IS_NOT_ME     = '!me';
+  const CONDITION_REGEXP        = 'regexp';
+  const CONDITION_RULE          = 'conditions';
+  const CONDITION_NOT_RULE      = '!conditions';
+  const CONDITION_EXISTS        = 'exists';
+  const CONDITION_NOT_EXISTS    = '!exists';
+  const CONDITION_REGEXP_PAIR   = 'regexp-pair';
+
+  const ACTION_ADD_CC     = 'addcc';
+  const ACTION_REMOVE_CC  = 'remcc';
+  const ACTION_EMAIL      = 'email';
+  const ACTION_NOTHING    = 'nothing';
+  const ACTION_AUDIT      = 'audit';
+  const ACTION_FLAG       = 'flag';
+
+  const VALUE_TEXT            = 'text';
+  const VALUE_NONE            = 'none';
+  const VALUE_EMAIL           = 'email';
+  const VALUE_USER            = 'user';
+  const VALUE_TAG             = 'tag';
+  const VALUE_RULE            = 'rule';
+  const VALUE_REPOSITORY      = 'repository';
+  const VALUE_OWNERS_PACKAGE  = 'package';
+  const VALUE_PROJECT         = 'project';
+  const VALUE_FLAG_COLOR      = 'flagcolor';
 
   abstract public function getPHID();
   abstract public function getHeraldName();
@@ -53,6 +71,11 @@ public function getAdapterContentType() {
   }
 
   abstract public function getAdapterContentName();
+
+
+/* -(  Fields  )------------------------------------------------------------- */
+
+
   abstract public function getFields();
 
   public function getFieldNameMap() {
@@ -74,6 +97,10 @@ public function getFieldNameMap() {
     );
   }
 
+
+/* -(  Conditions  )--------------------------------------------------------- */
+
+
   public function getConditionNameMap() {
     return array(
       self::CONDITION_CONTAINS        => pht('contains'),
@@ -151,6 +178,120 @@ public function getConditionsForField($field) {
   }
 
 
+/* -(  Actions  )------------------------------------------------------------ */
+
+  abstract public function getActions($rule_type);
+
+  public function getActionNameMap($rule_type) {
+    switch ($rule_type) {
+      case HeraldRuleTypeConfig::RULE_TYPE_GLOBAL:
+        return array(
+          self::ACTION_NOTHING    => pht('Do nothing'),
+          self::ACTION_ADD_CC     => pht('Add emails to CC'),
+          self::ACTION_REMOVE_CC  => pht('Remove emails from CC'),
+          self::ACTION_EMAIL      => pht('Send an email to'),
+          self::ACTION_AUDIT      => pht('Trigger an Audit by'),
+        );
+      case HeraldRuleTypeConfig::RULE_TYPE_PERSONAL:
+        return array(
+          self::ACTION_NOTHING    => pht('Do nothing'),
+          self::ACTION_ADD_CC     => pht('Add me to CC'),
+          self::ACTION_REMOVE_CC  => pht('Remove me from CC'),
+          self::ACTION_EMAIL      => pht('Send me an email'),
+          self::ACTION_AUDIT      => pht('Trigger an Audit by me'),
+          self::ACTION_FLAG       => pht('Mark with flag'),
+        );
+      default:
+        throw new Exception("Unknown rule type '{$rule_type}'!");
+    }
+  }
+
+
+/* -(  Values  )------------------------------------------------------------- */
+
+
+  public function getValueTypeForFieldAndCondition($field, $condition) {
+    switch ($condition) {
+      case self::CONDITION_CONTAINS:
+      case self::CONDITION_NOT_CONTAINS:
+      case self::CONDITION_IS:
+      case self::CONDITION_IS_NOT:
+      case self::CONDITION_REGEXP:
+      case self::CONDITION_REGEXP_PAIR:
+        return self::VALUE_TEXT;
+      case self::CONDITION_IS_ANY:
+      case self::CONDITION_IS_NOT_ANY:
+        switch ($field) {
+          case self::FIELD_REPOSITORY:
+            return self::VALUE_REPOSITORY;
+          default:
+            return self::VALUE_USER;
+        }
+        break;
+      case self::CONDITION_INCLUDE_ALL:
+      case self::CONDITION_INCLUDE_ANY:
+      case self::CONDITION_INCLUDE_NONE:
+        switch ($field) {
+          case self::FIELD_REPOSITORY:
+            return self::VALUE_REPOSITORY;
+          case self::FIELD_CC:
+            return self::VALUE_EMAIL;
+          case self::FIELD_TAGS:
+            return self::VALUE_TAG;
+          case self::FIELD_AFFECTED_PACKAGE:
+            return self::VALUE_OWNERS_PACKAGE;
+          default:
+            return self::VALUE_USER;
+        }
+        break;
+      case self::CONDITION_IS_ME:
+      case self::CONDITION_IS_NOT_ME:
+      case self::CONDITION_EXISTS:
+      case self::CONDITION_NOT_EXISTS:
+        return self::VALUE_NONE;
+      case self::CONDITION_RULE:
+      case self::CONDITION_NOT_RULE:
+        return self::VALUE_RULE;
+      default:
+        throw new Exception("Unknown condition '{$condition}'.");
+    }
+  }
+
+  public static function getValueTypeForAction($action, $rule_type) {
+    $is_personal = ($rule_type == HeraldRuleTypeConfig::RULE_TYPE_PERSONAL);
+
+    if ($is_personal) {
+      switch ($action) {
+        case self::ACTION_ADD_CC:
+        case self::ACTION_REMOVE_CC:
+        case self::ACTION_EMAIL:
+        case self::ACTION_NOTHING:
+        case self::ACTION_AUDIT:
+          return self::VALUE_NONE;
+        case self::ACTION_FLAG:
+          return self::VALUE_FLAG_COLOR;
+        default:
+          throw new Exception("Unknown or invalid action '{$action}'.");
+      }
+    } else {
+      switch ($action) {
+        case self::ACTION_ADD_CC:
+        case self::ACTION_REMOVE_CC:
+        case self::ACTION_EMAIL:
+          return self::VALUE_EMAIL;
+        case self::ACTION_NOTHING:
+          return self::VALUE_NONE;
+        case self::ACTION_AUDIT:
+          return self::VALUE_PROJECT;
+        case self::ACTION_FLAG:
+          return self::VALUE_FLAG_COLOR;
+        default:
+          throw new Exception("Unknown or invalid action '{$action}'.");
+      }
+    }
+  }
+
+
   public static function applyFlagEffect(HeraldEffect $effect, $phid) {
     $color = $effect->getTarget();
 
diff --git a/src/applications/herald/adapter/HeraldCommitAdapter.php b/src/applications/herald/adapter/HeraldCommitAdapter.php
@@ -86,6 +86,36 @@ public function getConditionsForField($field) {
     return parent::getConditionsForField($field);
   }
 
+  public function getActions($rule_type) {
+    switch ($rule_type) {
+      case HeraldRuleTypeConfig::RULE_TYPE_GLOBAL:
+        return array(
+          self::ACTION_ADD_CC,
+          self::ACTION_REMOVE_CC,
+          self::ACTION_EMAIL,
+          self::ACTION_NOTHING,
+        );
+      case HeraldRuleTypeConfig::RULE_TYPE_PERSONAL:
+        return array(
+          self::ACTION_ADD_CC,
+          self::ACTION_REMOVE_CC,
+          self::ACTION_EMAIL,
+          self::ACTION_NOTHING,
+        );
+    }
+  }
+
+  public function getValueTypeForFieldAndCondition($field, $condition) {
+    switch ($field) {
+      case self::FIELD_DIFFERENTIAL_CCS:
+        return self::VALUE_EMAIL;
+      case self::FIELD_NEED_AUDIT_FOR_PACKAGE:
+        return self::VALUE_OWNERS_PACKAGE;
+    }
+
+    return parent::getValueTypeForFieldAndCondition($field, $condition);
+  }
+
   public static function newLegacyAdapter(
     PhabricatorRepository $repository,
     PhabricatorRepositoryCommit $commit,
diff --git a/src/applications/herald/adapter/HeraldDifferentialRevisionAdapter.php b/src/applications/herald/adapter/HeraldDifferentialRevisionAdapter.php
@@ -242,6 +242,25 @@ public function getHeraldField($field) {
     }
   }
 
+  public function getActions($rule_type) {
+    switch ($rule_type) {
+      case HeraldRuleTypeConfig::RULE_TYPE_GLOBAL:
+        return array(
+          self::ACTION_ADD_CC,
+          self::ACTION_REMOVE_CC,
+          self::ACTION_EMAIL,
+          self::ACTION_NOTHING,
+        );
+      case HeraldRuleTypeConfig::RULE_TYPE_PERSONAL:
+        return array(
+          self::ACTION_ADD_CC,
+          self::ACTION_REMOVE_CC,
+          self::ACTION_EMAIL,
+          self::ACTION_NOTHING,
+        );
+    }
+  }
+
   public function applyHeraldEffects(array $effects) {
     assert_instances_of($effects, 'HeraldEffect');
 
diff --git a/src/applications/herald/adapter/HeraldDryRunAdapter.php b/src/applications/herald/adapter/HeraldDryRunAdapter.php
@@ -30,6 +30,10 @@ public function getFields() {
     return array();
   }
 
+  public function getActions($rule_type) {
+    return array();
+  }
+
   public function applyHeraldEffects(array $effects) {
     assert_instances_of($effects, 'HeraldEffect');
     $results = array();
diff --git a/src/applications/herald/config/HeraldActionConfig.php b/src/applications/herald/config/HeraldActionConfig.php
@@ -9,6 +9,7 @@ final class HeraldActionConfig {
   const ACTION_AUDIT        = 'audit';
   const ACTION_FLAG         = 'flag';
 
+  // TODO: Remove; still used by transcripts.
   public static function getActionMessageMapForRuleType($rule_type) {
     $generic_mappings = array(
       self::ACTION_NOTHING      => pht('Do nothing'),
@@ -43,6 +44,7 @@ public static function getActionMessageMapForRuleType($rule_type) {
     return $specific_mappings + $generic_mappings;
   }
 
+  // TODO: Remove; still used by transcripts.
   public static function getActionMessageMap($content_type,
                                              $rule_type) {
     $map = self::getActionMessageMapForRuleType($rule_type);
diff --git a/src/applications/herald/config/HeraldValueTypeConfig.php b/src/applications/herald/config/HeraldValueTypeConfig.php
diff --git a/src/applications/herald/controller/HeraldRuleController.php b/src/applications/herald/controller/HeraldRuleController.php
