Prepare TransactionEditor for silent transactions via bulk edit

Summary:
Ref T13042. This adds a "silent" edit mechanism which suppresses feed stories, email, and notifications.

The other behaviors here are:

  - The transactions are marked as "silent" so we can render a hint in the UI in the future to make it clear to users that they aren't missing email.
  - If the editor uses Herald, mail rules are suppressed so they don't fire incorrectly (this mostly affects "the first time this rule matches, send me an email" rules: without this, they'd match "the first time" on the bulk edit, not send email, then never match again since they already matched).
  - If the edit queues additional edits, those are applied silently too.

This doesn't (or, at least, shouldn't) actually change any behavior since you can't apply silent edits yet.

Test Plan:
Somewhat theoretical, since this isn't reachable yet. Should get meaningful testing in an upcoming change.

Did a bit of var_dump() / debug poking to attempt to verify that nothing too crazy is happening.

Viewed and edited objects, no changes in behavior.

Reviewers: amckinley

Reviewed By: amckinley

Maniphest Tasks: T13042

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

src/__phutil_library_map__.php

@@ -1356,6 +1356,7 @@ phutil_register_library_map(array(
     'HeraldConditionTranscript' => 'applications/herald/storage/transcript/HeraldConditionTranscript.php',
     'HeraldContentSourceField' => 'applications/herald/field/HeraldContentSourceField.php',
     'HeraldController' => 'applications/herald/controller/HeraldController.php',
+    'HeraldCoreStateReasons' => 'applications/herald/state/HeraldCoreStateReasons.php',
     'HeraldDAO' => 'applications/herald/storage/HeraldDAO.php',
     'HeraldDifferentialAdapter' => 'applications/differential/herald/HeraldDifferentialAdapter.php',
     'HeraldDifferentialDiffAdapter' => 'applications/differential/herald/HeraldDifferentialDiffAdapter.php',
@@ -6529,6 +6530,7 @@ phutil_register_library_map(array(
     'HeraldConditionTranscript' => 'Phobject',
     'HeraldContentSourceField' => 'HeraldField',
     'HeraldController' => 'PhabricatorController',
+    'HeraldCoreStateReasons' => 'HeraldStateReasons',
     'HeraldDAO' => 'PhabricatorLiskDAO',
     'HeraldDifferentialAdapter' => 'HeraldAdapter',
     'HeraldDifferentialDiffAdapter' => 'HeraldDifferentialAdapter',

src/applications/herald/state/HeraldCoreStateReasons.php

@@ -0,0 +1,18 @@
+<?php
+
+final class HeraldCoreStateReasons
+  extends HeraldStateReasons {
+
+  const REASON_SILENT = 'core.silent';
+
+  public function explainReason($reason) {
+    $reasons = array(
+      self::REASON_SILENT => pht(
+        'This change applied silently, so mail and other notifications '.
+        'will not be sent.'),
+    );
+
+    return idx($reasons, $reason);
+  }
+
+}

src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php

@@ -68,7 +68,9 @@ abstract class PhabricatorApplicationTransactionEditor
   private $feedNotifyPHIDs = array();
   private $feedRelatedPHIDs = array();
   private $feedShouldPublish = false;
+  private $mailShouldSend = false;
   private $modularTypes;
+  private $silent;
 
   private $transactionQueue = array();
 
@@ -187,6 +189,15 @@ abstract class PhabricatorApplicationTransactionEditor
     return $this->isPreview;
   }
 
+  public function setIsSilent($silent) {
+    $this->silent = $silent;
+    return $this;
+  }
+
+  public function getIsSilent() {
+    return $this->silent;
+  }
+
   public function setIsInverseEdgeEditor($is_inverse_edge_editor) {
     $this->isInverseEdgeEditor = $is_inverse_edge_editor;
     return $this;
@@ -790,6 +801,10 @@ abstract class PhabricatorApplicationTransactionEditor
       $xaction->setObjectPHID($object->getPHID());
     }
 
+    if ($this->getIsSilent()) {
+      $xaction->setIsSilentTransaction(true);
+    }
+
     return $xaction;
   }
 
@@ -1136,15 +1151,22 @@ abstract class PhabricatorApplicationTransactionEditor
     // Editors need to pass into workers.
     $object = $this->willPublish($object, $xactions);
 
+    if (!$this->getIsSilent()) {
       if ($this->shouldSendMail($object, $xactions)) {
+        $this->mailShouldSend = true;
         $this->mailToPHIDs = $this->getMailTo($object);
         $this->mailCCPHIDs = $this->getMailCC($object);
       }
 
       if ($this->shouldPublishFeedStory($object, $xactions)) {
         $this->feedShouldPublish = true;
-      $this->feedRelatedPHIDs = $this->getFeedRelatedPHIDs($object, $xactions);
+        $this->feedRelatedPHIDs = $this->getFeedRelatedPHIDs(
-      $this->feedNotifyPHIDs = $this->getFeedNotifyPHIDs($object, $xactions);
+          $object,
+          $xactions);
+        $this->feedNotifyPHIDs = $this->getFeedNotifyPHIDs(
+          $object,
+          $xactions);
+      }
     }
 
     PhabricatorWorker::scheduleTask(
@@ -1186,7 +1208,7 @@ abstract class PhabricatorApplicationTransactionEditor
     $this->object = $object;
 
     $messages = array();
-    if ($this->shouldSendMail($object, $xactions)) {
+    if ($this->mailShouldSend) {
       $messages = $this->buildMail($object, $xactions);
     }
 
@@ -3138,6 +3160,16 @@ abstract class PhabricatorApplicationTransactionEditor
       $adapter->setApplicationEmail($this->getApplicationEmail());
     }
 
+    // If this editor is operating in silent mode, tell Herald that we aren't
+    // going to send any mail. This allows it to skip "the first time this
+    // rule matches, send me an email" rules which would otherwise match even
+    // though we aren't going to send any mail.
+    if ($this->getIsSilent()) {
+      $adapter->setForbiddenAction(
+        HeraldMailableState::STATECONST,
+        HeraldCoreStateReasons::REASON_SILENT);
+    }
+
     $xscript = HeraldEngine::loadAndApplyRules($adapter);
 
     $this->setHeraldAdapter($adapter);
@@ -3493,6 +3525,7 @@ abstract class PhabricatorApplicationTransactionEditor
       'feedNotifyPHIDs',
       'feedRelatedPHIDs',
       'feedShouldPublish',
+      'mailShouldSend',
     );
   }
 
@@ -3875,7 +3908,8 @@ abstract class PhabricatorApplicationTransactionEditor
       ->setActor($this->getActor())
       ->setContentSource($this->getContentSource())
       ->setContinueOnNoEffect($this->getContinueOnNoEffect())
-      ->setContinueOnMissingFields($this->getContinueOnMissingFields());
+      ->setContinueOnMissingFields($this->getContinueOnMissingFields())
+      ->setIsSilent($this->getIsSilent());
 
     if ($this->actingAsPHID !== null) {
       $editor->setActingAsPHID($this->actingAsPHID);

src/applications/transactions/storage/PhabricatorApplicationTransaction.php

@@ -158,6 +158,14 @@ abstract class PhabricatorApplicationTransaction
     return (bool)$this->getMetadataValue('core.default', false);
   }
 
+  public function setIsSilentTransaction($silent) {
+    return $this->setMetadataValue('core.silent', $silent);
+  }
+
+  public function getIsSilentTransaction() {
+    return (bool)$this->getMetadataValue('core.silent', false);
+  }
+
   public function attachComment(
     PhabricatorApplicationTransactionComment $comment) {
     $this->comment = $comment;
@@ -1515,6 +1523,12 @@ abstract class PhabricatorApplicationTransaction
       if ($apart > (60 * 2)) {
         return false;
       }
+
+      // Don't group silent and nonsilent transactions together.
+      $is_silent = $this->getIsSilentTransaction();
+      if ($is_silent != $xaction->getIsSilentTransaction()) {
+        return false;
+      }
     }
 
     return true;

src/applications/transactions/view/PhabricatorApplicationTransactionView.php

@@ -423,7 +423,8 @@ class PhabricatorApplicationTransactionView extends AphrontView {
       ->setUserHandle($xaction->getHandle($xaction->getAuthorPHID()))
       ->setIcon($xaction->getIcon())
       ->setColor($xaction->getColor())
-      ->setHideCommentOptions($this->getHideCommentOptions());
+      ->setHideCommentOptions($this->getHideCommentOptions())
+      ->setIsSilent($xaction->getIsSilentTransaction());
 
     list($token, $token_removed) = $xaction->getToken();
     if ($token) {

src/view/phui/PHUITimelineEventView.php

@@ -29,6 +29,7 @@ final class PHUITimelineEventView extends AphrontView {
   private $authorPHID;
   private $badges = array();
   private $pinboardItems = array();
+  private $isSilent;
 
   public function setAuthorPHID($author_phid) {
     $this->authorPHID = $author_phid;
@@ -177,6 +178,15 @@ final class PHUITimelineEventView extends AphrontView {
     return $this;
   }
 
+  public function setIsSilent($is_silent) {
+    $this->isSilent = $is_silent;
+    return $this;
+  }
+
+  public function getIsSilent() {
+    return $this->isSilent;
+  }
+
   public function setReallyMajorEvent($me) {
     $this->reallyMajorEvent = $me;
     return $this;