Legalpad V0.2 - add mail integration

Summary:
Supports !unsubscribe and commenting on replies. Subscribers get mailed something reasonable. Fixes T3480.

Sneaks in /LX/ support. In the near future I want to have that /LX/ be a clean "signature" page sans all the edit actions and other fluff... Will resolve this as part of T3481.

Test Plan: used the metamta console to add comments and unsubscribe. added a phlog() inside mail code to verify mail bodies looked okay.

Reviewers: epriestley

Reviewed By: epriestley

CC: aran, Korvin

Maniphest Tasks: T3480

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

resources/sql/patches/legalpad-mailkey-populate.php

···
+<?php
+
+echo "Populating Legalpad Documents with mail keys...\n";
+$table = new LegalpadDocument();
+$table->openTransaction();
+
+foreach (new LiskMigrationIterator($table) as $document) {
+  $id = $document->getID();
+
+  echo "Document {$id}: ";
+  if (!$document->getMailKey()) {
+    queryfx(
+      $document->establishConnection('w'),
+      'UPDATE %T SET mailKey = %s WHERE id = %d',
+      $document->getTableName(),
+      Filesystem::readRandomCharacters(20),
+      $id);
+    echo "Generated Key\n";
+  } else {
+    echo "-\n";
+  }
+}
+
+$table->saveTransaction();
+echo "Done.\n";

resources/sql/patches/legalpad-mailkey.sql

···
+ALTER TABLE `{$NAMESPACE}_legalpad`.legalpad_document
+  ADD mailKey VARCHAR(20) NOT NULL COLLATE utf8_bin;

src/__phutil_library_map__.php

···
     'LegalpadDocumentSearchEngine' => 'applications/legalpad/query/LegalpadDocumentSearchEngine.php',
     'LegalpadDocumentSignature' => 'applications/legalpad/storage/LegalpadDocumentSignature.php',
     'LegalpadDocumentViewController' => 'applications/legalpad/controller/LegalpadDocumentViewController.php',
+    'LegalpadMockMailReceiver' => 'applications/legalpad/mail/LegalpadMockMailReceiver.php',
+    'LegalpadReplyHandler' => 'applications/legalpad/mail/LegalpadReplyHandler.php',
     'LegalpadTransaction' => 'applications/legalpad/storage/LegalpadTransaction.php',
     'LegalpadTransactionComment' => 'applications/legalpad/storage/LegalpadTransactionComment.php',
     'LegalpadTransactionQuery' => 'applications/legalpad/query/LegalpadTransactionQuery.php',
···
     'PhabricatorJavelinLinter' => 'infrastructure/lint/linter/PhabricatorJavelinLinter.php',
     'PhabricatorJumpNavHandler' => 'applications/search/engine/PhabricatorJumpNavHandler.php',
     'PhabricatorKeyValueDatabaseCache' => 'applications/cache/PhabricatorKeyValueDatabaseCache.php',
+    'PhabricatorLegalpadConfigOptions' => 'applications/legalpad/config/PhabricatorLegalpadConfigOptions.php',
     'PhabricatorLintEngine' => 'infrastructure/lint/PhabricatorLintEngine.php',
     'PhabricatorLipsumArtist' => 'applications/lipsum/image/PhabricatorLipsumArtist.php',
     'PhabricatorLipsumGenerateWorkflow' => 'applications/lipsum/management/PhabricatorLipsumGenerateWorkflow.php',
···
     'LegalpadDocumentSearchEngine' => 'PhabricatorApplicationSearchEngine',
     'LegalpadDocumentSignature' => 'LegalpadDAO',
     'LegalpadDocumentViewController' => 'LegalpadController',
+    'LegalpadMockMailReceiver' => 'PhabricatorObjectMailReceiver',
+    'LegalpadReplyHandler' => 'PhabricatorMailReplyHandler',
     'LegalpadTransaction' => 'PhabricatorApplicationTransaction',
     'LegalpadTransactionComment' => 'PhabricatorApplicationTransactionComment',
     'LegalpadTransactionQuery' => 'PhabricatorApplicationTransactionQuery',
···
     'PhabricatorInlineSummaryView' => 'AphrontView',
     'PhabricatorJavelinLinter' => 'ArcanistLinter',
     'PhabricatorKeyValueDatabaseCache' => 'PhutilKeyValueCache',
+    'PhabricatorLegalpadConfigOptions' => 'PhabricatorApplicationConfigOptions',
     'PhabricatorLintEngine' => 'PhutilLintEngine',
     'PhabricatorLipsumGenerateWorkflow' => 'PhabricatorLipsumManagementWorkflow',
     'PhabricatorLipsumManagementWorkflow' => 'PhutilArgumentWorkflow',

src/applications/legalpad/application/PhabricatorApplicationLegalpad.php

···
 
   public function getRoutes() {
     return array(
+      '/L(?P<id>\d+)/' => 'LegalpadDocumentViewController',
       '/legalpad/' => array(
         '' => 'LegalpadDocumentListController',
         '(query/(?P<queryKey>[^/]+)/)?' => 'LegalpadDocumentListController',

src/applications/legalpad/config/PhabricatorLegalpadConfigOptions.php

···
+<?php
+
+/**
+ * @group legalpad
+ */
+final class PhabricatorLegalpadConfigOptions
+  extends PhabricatorApplicationConfigOptions {
+
+  public function getName() {
+    return pht('Legalpad');
+  }
+
+  public function getDescription() {
+    return pht('Configure Legalpad.');
+  }
+
+  public function getOptions() {
+    return array(
+      $this->newOption(
+        'metamta.legalpad.subject-prefix',
+        'string',
+        '[Legalpad]')
+        ->setDescription(pht('Subject prefix for Legalpad email.'))
+    );
+  }
+
+}

src/applications/legalpad/controller/LegalpadDocumentCommentController.php

···
     $document = id(new LegalpadDocumentQuery())
       ->setViewer($user)
       ->withIDs(array($this->id))
+      ->needDocumentBodies(true)
       ->executeOne();
 
     if (!$document) {

src/applications/legalpad/editor/LegalpadDocumentEditor.php

···
     return parent::mergeTransactions($u, $v);
   }
 
+/* -(  Sending Mail  )------------------------------------------------------- */
+
   protected function supportsMail() {
-    return false;
+    return true;
+  }
+
+  protected function buildReplyHandler(PhabricatorLiskDAO $object) {
+    return id(new LegalpadReplyHandler())
+      ->setMailReceiver($object);
+  }
+
+  protected function buildMailTemplate(PhabricatorLiskDAO $object) {
+    $id = $object->getID();
+    $phid = $object->getPHID();
+    $title = $object->getDocumentBody()->getTitle();
+
+    return id(new PhabricatorMetaMTAMail())
+      ->setSubject("L{$id}: {$title}")
+      ->addHeader('Thread-Topic', "L{$id}: {$phid}");
+  }
+
+  protected function getMailTo(PhabricatorLiskDAO $object) {
+    return array(
+      $object->getCreatorPHID(),
+      $this->requireActor()->getPHID(),
+    );
+  }
+
+  protected function shouldImplyCC(
+    PhabricatorLiskDAO $object,
+    PhabricatorApplicationTransaction $xaction) {
+
+    switch ($xaction->getTransactionType()) {
+      case LegalpadTransactionType::TYPE_TEXT:
+      case LegalpadTransactionType::TYPE_TITLE:
+        return true;
+    }
+
+    return parent::shouldImplyCC($object, $xaction);
   }
+
+  protected function buildMailBody(
+    PhabricatorLiskDAO $object,
+    array $xactions) {
+
+    $body = parent::buildMailBody($object, $xactions);
+
+    $body->addTextSection(
+      pht('DOCUMENT DETAIL'),
+      PhabricatorEnv::getProductionURI('/L'.$object->getID()));
+
+    return $body;
+  }
+
+  protected function getMailSubjectPrefix() {
+    return PhabricatorEnv::getEnvConfig('metamta.legalpad.subject-prefix');
+  }
+
 
   protected function supportsFeed() {
     return false;

src/applications/legalpad/mail/LegalpadMockMailReceiver.php

···
+<?php
+
+final class LegalpadMockMailReceiver extends PhabricatorObjectMailReceiver {
+
+  public function isEnabled() {
+    $app_class = 'PhabricatorApplicationLegalpad';
+    return PhabricatorApplication::isClassInstalled($app_class);
+  }
+
+  protected function getObjectPattern() {
+    return 'L[1-9]\d*';
+  }
+
+  protected function loadObject($pattern, PhabricatorUser $viewer) {
+    $id = (int)trim($pattern, 'L');
+
+    return id(new LegalpadDocumentQuery())
+      ->setViewer($viewer)
+      ->withIDs(array($id))
+      ->needDocumentBodies(true)
+      ->executeOne();
+  }
+
+  protected function processReceivedObjectMail(
+    PhabricatorMetaMTAReceivedMail $mail,
+    PhabricatorLiskDAO $object,
+    PhabricatorUser $sender) {
+
+    $handler = id(new LegalpadReplyHandler())
+      ->setMailReceiver($object)
+      ->setActor($sender)
+      ->setExcludeMailRecipientPHIDs(
+        $mail->loadExcludeMailRecipientPHIDs());
+
+    return $handler->processEmail($mail);
+  }
+
+}

src/applications/legalpad/mail/LegalpadReplyHandler.php

···
+<?php
+
+/**
+ * @group legalpad
+ */
+final class LegalpadReplyHandler extends PhabricatorMailReplyHandler {
+
+  public function validateMailReceiver($mail_receiver) {
+    if (!($mail_receiver instanceof LegalpadDocument)) {
+      throw new Exception("Mail receiver is not a LegalpadDocument!");
+    }
+  }
+
+  public function getPrivateReplyHandlerEmailAddress(
+    PhabricatorObjectHandle $handle) {
+    return $this->getDefaultPrivateReplyHandlerEmailAddress($handle, 'L');
+  }
+
+  public function getPublicReplyHandlerEmailAddress() {
+    return $this->getDefaultPublicReplyHandlerEmailAddress('L');
+  }
+
+  public function getReplyHandlerDomain() {
+    return PhabricatorEnv::getEnvConfig(
+      'metamta.reply-handler-domain');
+  }
+
+  public function getReplyHandlerInstructions() {
+    if ($this->supportsReplies()) {
+      return 'Reply to comment or !unsubscribe.';
+    } else {
+      return null;
+    }
+  }
+
+  protected function receiveEmail(PhabricatorMetaMTAReceivedMail $mail) {
+    $actor = $this->getActor();
+    $document = $this->getMailReceiver();
+
+    $body = $mail->getCleanTextBody();
+    $body = trim($body);
+    $body = $this->enhanceBodyWithAttachments($body, $mail->getAttachments());
+
+    $content_source = PhabricatorContentSource::newForSource(
+      PhabricatorContentSource::SOURCE_EMAIL,
+      array(
+        'id' => $mail->getID(),
+      ));
+
+    $lines = explode("\n", trim($body));
+    $first_line = head($lines);
+
+    $xactions = array();
+    $command = null;
+    $matches = null;
+    if (preg_match('/^!(\w+)/', $first_line, $matches)) {
+      $lines = array_slice($lines, 1);
+      $body = implode("\n", $lines);
+      $body = trim($body);
+
+      $command = $matches[1];
+    }
+
+    switch ($command) {
+      case 'unsubscribe':
+        $xaction = id(new LegalpadTransaction())
+          ->setTransactionType(PhabricatorTransactions::TYPE_SUBSCRIBERS)
+          ->setNewValue(array('-' => array($actor->getPHID())));
+        $xactions[] = $xaction;
+        break;
+    }
+
+    $xactions[] = id(new LegalpadTransaction())
+      ->setTransactionType(PhabricatorTransactions::TYPE_COMMENT)
+      ->attachComment(
+        id(new LegalpadTransactionComment())
+        ->setDocumentID($document->getID())
+        ->setLineNumber(0)
+        ->setLineLength(0)
+        ->setContent($body));
+
+    $editor = id(new LegalpadDocumentEditor())
+      ->setActor($actor)
+      ->setContentSource($content_source)
+      ->setContinueOnNoEffect(true)
+      ->setIsPreview(false);
+
+    try {
+      $xactions = $editor->applyTransactions($document, $xactions);
+    } catch (PhabricatorApplicationTransactionNoEffectException $ex) {
+      // just do nothing, though unclear why you're sending a blank email
+      return true;
+    }
+
+    $head_xaction = head($xactions);
+    return $head_xaction->getID();
+  }
+
+}

src/applications/legalpad/storage/LegalpadDocument.php

···
   protected $documentBodyPHID;
   protected $viewPolicy;
   protected $editPolicy;
+  protected $mailKey;
 
   private $documentBody;
   private $contributors;
···
   public function attachContributors(array $contributors) {
     $this->contributors = $contributors;
     return $this;
+  }
+
+  public function save() {
+    if (!$this->getMailKey()) {
+      $this->setMailKey(Filesystem::readRandomCharacters(20));
+    }
+    return parent::save();
   }
 
 /* -(  PhabricatorSubscribableInterface Implementation  )-------------------- */

src/applications/phid/handle/PhabricatorObjectHandleData.php

···
 
       case PhabricatorPHIDConstants::PHID_TYPE_LEGD:
         $legds = id(new LegalpadDocumentQuery())
-          ->needDocumentBody(true)
+          ->needDocumentBodies(true)
           ->withPHIDs($phids)
           ->setViewer($this->viewer)
           ->execute();

src/infrastructure/storage/patch/PhabricatorBuiltinPatchList.php

···
         'type' => 'sql',
         'name' => $this->getPatchPath('20130701.conduitlog.sql'),
       ),
+      'legalpad-mailkey.sql' => array(
+        'type'    => 'sql',
+        'name'    => $this->getPatchPath('legalpad-mailkey.sql'),
+      ),
+      'legalpad-mailkey-populate.php' => array(
+        'type'    => 'php',
+        'name'    => $this->getPatchPath('legalpad-mailkey-populate.php'),
+      ),
     );
   }
 }