Allow tweaking of Differential mail by using events

Summary: Allow tweaking Differential mail before sending.

Test Plan:
Wrote a listener renaming Differential attachments and it worked without
problems.

Reviewers: epriestley

Reviewed By: epriestley

CC: aran, epriestley, mareksapota, davidreuss

Differential Revision: 1091

src/__phutil_library_map__.php

@@ -488,6 +488,7 @@ phutil_register_library_map(array(
     'PhabricatorMailImplementationTestAdapter' => 'applications/metamta/adapter/test',
     'PhabricatorMailReplyHandler' => 'applications/metamta/replyhandler/base',
     'PhabricatorMarkupEngine' => 'applications/markup/engine',
+    'PhabricatorMetaMTAAttachment' => 'applications/metamta/storage/mail',
     'PhabricatorMetaMTAController' => 'applications/metamta/controller/base',
     'PhabricatorMetaMTADAO' => 'applications/metamta/storage/base',
     'PhabricatorMetaMTADaemon' => 'applications/metamta/daemon/mta',

src/applications/differential/mail/base/DifferentialMail.php

@@ -90,13 +90,7 @@ abstract class DifferentialMail {
       ->setParentMessageID($this->parentMessageID)
       ->addHeader('Thread-Topic', $this->getRevision()->getTitle());
 
-    foreach ($attachments as $attachment) {
+    $template->setAttachments($attachments);
-      $template->addAttachment(
-        $attachment['data'],
-        $attachment['filename'],
-        $attachment['mimetype']
-      );
-    }
 
     $template->setThreadID(
       $this->getThreadID(),
@@ -120,6 +114,16 @@ abstract class DifferentialMail {
 
     $handles = id(new PhabricatorObjectHandleData($phids))->loadHandles();
 
+    $event = new PhabricatorEvent(
+      PhabricatorEventType::TYPE_DIFFERENTIAL_WILLSENDMAIL,
+      array(
+        'mail' => $template,
+      )
+    );
+    PhabricatorEventEngine::dispatchEvent($event);
+
+    $template = $event->getValue('mail');
+
     $mails = $reply_handler->multiplexMail(
       $template,
       array_select_keys($handles, $to_phids),
@@ -177,14 +181,8 @@ EOTEXT;
 
   /**
    * You can override this method in a subclass and return array of attachments
-   * to be sent with the email.  Each attachment is a dictionary with 'data',
+   * to be sent with the email.  Each attachment is an instance of
-   * 'filename' and 'mimetype' keys.  For example:
+   * PhabricatorMetaMTAAttachment.
-   *
-   *   array(
-   *     'data' => 'some text',
-   *     'filename' => 'example.txt',
-   *     'mimetype' => 'text/plain'
-   *   );
    */
   protected function buildAttachments() {
     return array();

src/applications/differential/mail/base/__init__.php

@@ -9,6 +9,9 @@
 phutil_require_module('phabricator', 'applications/metamta/storage/mail');
 phutil_require_module('phabricator', 'applications/phid/handle/data');
 phutil_require_module('phabricator', 'infrastructure/env');
+phutil_require_module('phabricator', 'infrastructure/events/constant/type');
+phutil_require_module('phabricator', 'infrastructure/events/engine');
+phutil_require_module('phabricator', 'infrastructure/events/event');
 
 phutil_require_module('phutil', 'utils');
 

src/applications/differential/mail/reviewrequest/DifferentialReviewRequestMail.php

@@ -104,10 +104,10 @@ abstract class DifferentialReviewRequestMail extends DifferentialMail {
       $bundle = ArcanistBundle::newFromChanges($changes);
       $unified_diff = $bundle->toUnifiedDiff();
 
-      $attachments[] = array(
+      $attachments[] = new PhabricatorMetaMTAAttachment(
-        'data' => $unified_diff,
+        $unified_diff,
-        'filename' => $filename,
+        $filename,
-        'mimetype' => 'text/x-patch; charset=utf-8'
+        'text/x-patch; charset=utf-8'
       );
     }
     return $attachments;

src/applications/differential/mail/reviewrequest/__init__.php

@@ -10,6 +10,7 @@ phutil_require_module('arcanist', 'parser/bundle');
 phutil_require_module('arcanist', 'parser/diff/change');
 
 phutil_require_module('phabricator', 'applications/differential/mail/base');
+phutil_require_module('phabricator', 'applications/metamta/storage/mail');
 phutil_require_module('phabricator', 'applications/phid/handle/data');
 phutil_require_module('phabricator', 'infrastructure/env');
 

src/applications/metamta/controller/send/PhabricatorMetaMTASendController.php

@@ -34,10 +34,11 @@ class PhabricatorMetaMTASendController extends PhabricatorMetaMTAController {
       if ($files) {
         foreach ($files as $phid) {
           $file = id(new PhabricatorFile())->loadOneWhere('phid = %s', $phid);
-          $mail->addAttachment(
+          $mail->addAttachment(new PhabricatorMetaMTAAttachment(
             $file->loadFileData(),
             $file->getName(),
-            $file->getMimeType());
+            $file->getMimeType()
+          ));
         }
       }
 

src/applications/metamta/storage/mail/PhabricatorMetaMTAAttachment.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * Copyright 2011 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class PhabricatorMetaMTAAttachment {
+  protected $data;
+  protected $filename;
+  protected $mimetype;
+
+  public function __construct($data, $filename, $mimetype) {
+    $this->setData($data);
+    $this->setFileName($filename);
+    $this->setMimeType($mimetype);
+  }
+
+  public function getData() {
+    return $this->data;
+  }
+
+  public function setData($data) {
+    $this->data = $data;
+    return $this;
+  }
+
+  public function getFileName() {
+    return $this->filename;
+  }
+
+  public function setFileName($filename) {
+    $this->filename = $filename;
+    return $this;
+  }
+
+  public function getMimeType() {
+    return $this->mimetype;
+  }
+
+  public function setMimeType($mimetype) {
+    $this->mimetype = $mimetype;
+    return $this;
+  }
+}

src/applications/metamta/storage/mail/PhabricatorMetaMTAMail.php

@@ -104,12 +104,17 @@ class PhabricatorMetaMTAMail extends PhabricatorMetaMTADAO {
     return $this;
   }
 
-  public function addAttachment($data, $filename, $mimetype) {
+  public function addAttachment(PhabricatorMetaMTAAttachment $attachment) {
-    $this->parameters['attachments'][] = array(
+    $this->parameters['attachments'][] = $attachment;
-      'data' => $data,
+    return $this;
-      'filename' => $filename,
+  }
-      'mimetype' => $mimetype
+
-    );
+  public function getAttachments() {
+    return $this->getParam('attachments');
+  }
+
+  public function setAttachments(array $attachments) {
+    $this->setParam('attachments', $attachments);
     return $this;
   }
 
@@ -312,9 +317,9 @@ class PhabricatorMetaMTAMail extends PhabricatorMetaMTADAO {
           case 'attachments':
             foreach ($value as $attachment) {
               $mailer->addAttachment(
-                $attachment['data'],
+                $attachment->getData(),
-                $attachment['filename'],
+                $attachment->getFileName(),
-                $attachment['mimetype']
+                $attachment->getMimeType()
               );
             }
             break;

src/applications/metamta/storage/mail/__init__.php

@@ -14,4 +14,5 @@ phutil_require_module('phutil', 'symbols');
 phutil_require_module('phutil', 'utils');
 
 
+phutil_require_source('PhabricatorMetaMTAAttachment.php');
 phutil_require_source('PhabricatorMetaMTAMail.php');

src/docs/userguide/events.diviner

@@ -24,4 +24,11 @@ or alter the edit. Data available on this event:
     @{class:ManiphestTransaction}) being applied.
   - ##new## A boolean indicating if this task is being created.
   - ##mail## If this edit originates from email, the
-    @{class:PhabricatorMetaMTAReceivedMail} object.
+    @{class:PhabricatorMetaMTAReceivedMail} object.
+
+== PhabricatorEventType::TYPE_DIFFERENTIAL_WILLSENDMAIL ==
+
+This event is dispatche before Differential sends an email, and allows you to
+edit the message that will be sent.  Data available on this event:
+
+  - ##mail## The {@class:PhabricatorMetaMTAMail} being edited.

src/infrastructure/events/constant/type/PhabricatorEventType.php

@@ -20,5 +20,6 @@ final class PhabricatorEventType extends PhabricatorEventConstants {
 
   const TYPE_ALL                    = '*';
   const TYPE_MANIPHEST_WILLEDITTASK = 'maniphest.willEditTask';
+  const TYPE_DIFFERENTIAL_WILLSENDMAIL = 'differential.willSendMail';
 
 }