Add MAILTAGs to Badges

Summary: Still doesn't mail yet, but the settings now show up.

Test Plan: View email settings, see Badges options.

Reviewers: eadler, epriestley

Reviewed By: eadler, epriestley

Subscribers: epriestley, Korvin

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

resources/sql/autopatches/20150725.badges.mailkey.1.sql

···
+ALTER TABLE {$NAMESPACE}_badges.badges_badge
+  ADD mailKey binary(20) NOT NULL;

resources/sql/autopatches/20150725.badges.mailkey.2.php

···
+<?php
+
+$table = new PhabricatorBadgesBadge();
+$conn_w = $table->establishConnection('w');
+$iterator = new LiskMigrationIterator($table);
+foreach ($iterator as $badge) {
+  $id = $badge->getID();
+
+  echo pht('Adding mail key for badge %d...', $id);
+  echo "\n";
+
+  queryfx(
+    $conn_w,
+    'UPDATE %T SET mailKey = %s WHERE id = %d',
+    $table->getTableName(),
+    Filesystem::readRandomCharacters(20),
+    $id);
+}

src/__phutil_library_map__.php

···
     'PhabricatorBadgesEditor' => 'applications/badges/editor/PhabricatorBadgesEditor.php',
     'PhabricatorBadgesIcon' => 'applications/badges/icon/PhabricatorBadgesIcon.php',
     'PhabricatorBadgesListController' => 'applications/badges/controller/PhabricatorBadgesListController.php',
+    'PhabricatorBadgesMailReceiver' => 'applications/badges/mail/PhabricatorBadgesMailReceiver.php',
     'PhabricatorBadgesPHIDType' => 'applications/badges/phid/PhabricatorBadgesPHIDType.php',
     'PhabricatorBadgesQuery' => 'applications/badges/query/PhabricatorBadgesQuery.php',
     'PhabricatorBadgesRecipientsListView' => 'applications/badges/view/PhabricatorBadgesRecipientsListView.php',
     'PhabricatorBadgesRemoveRecipientsController' => 'applications/badges/controller/PhabricatorBadgesRemoveRecipientsController.php',
+    'PhabricatorBadgesReplyHandler' => 'applications/badges/mail/PhabricatorBadgesReplyHandler.php',
     'PhabricatorBadgesSchemaSpec' => 'applications/badges/storage/PhabricatorBadgesSchemaSpec.php',
     'PhabricatorBadgesSearchEngine' => 'applications/badges/query/PhabricatorBadgesSearchEngine.php',
     'PhabricatorBadgesTransaction' => 'applications/badges/storage/PhabricatorBadgesTransaction.php',
···
     'PhabricatorBadgesEditor' => 'PhabricatorApplicationTransactionEditor',
     'PhabricatorBadgesIcon' => 'Phobject',
     'PhabricatorBadgesListController' => 'PhabricatorBadgesController',
+    'PhabricatorBadgesMailReceiver' => 'PhabricatorObjectMailReceiver',
     'PhabricatorBadgesPHIDType' => 'PhabricatorPHIDType',
     'PhabricatorBadgesQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
     'PhabricatorBadgesRecipientsListView' => 'AphrontTagView',
     'PhabricatorBadgesRemoveRecipientsController' => 'PhabricatorBadgesController',
+    'PhabricatorBadgesReplyHandler' => 'PhabricatorApplicationTransactionReplyHandler',
     'PhabricatorBadgesSchemaSpec' => 'PhabricatorConfigSchemaSpec',
     'PhabricatorBadgesSearchEngine' => 'PhabricatorApplicationSearchEngine',
     'PhabricatorBadgesTransaction' => 'PhabricatorApplicationTransaction',

src/applications/badges/editor/PhabricatorBadgesEditor.php

···
     return $errors;
   }
 
+  protected function shouldSendMail(
+    PhabricatorLiskDAO $object,
+    array $xactions) {
+    return true;
+  }
+
+  public function getMailTagsMap() {
+    return array(
+      PhabricatorBadgesTransaction::MAILTAG_DETAILS =>
+        pht('Someone changes the badge\'s details.'),
+      PhabricatorBadgesTransaction::MAILTAG_COMMENT =>
+        pht('Someone comments on a badge.'),
+      PhabricatorBadgesTransaction::MAILTAG_OTHER =>
+        pht('Other badge activity not listed above occurs.'),
+    );
+  }
+
   protected function shouldPublishFeedStory(
     PhabricatorLiskDAO $object,
     array $xactions) {
···
   }
 
   protected function buildReplyHandler(PhabricatorLiskDAO $object) {
-    return id(new PhabricatorMacroReplyHandler())
+    return id(new PhabricatorBadgesReplyHandler())
       ->setMailReceiver($object);
   }
 

src/applications/badges/mail/PhabricatorBadgesMailReceiver.php

···
+<?php
+
+final class PhabricatorBadgesMailReceiver
+  extends PhabricatorObjectMailReceiver {
+
+  public function isEnabled() {
+    return PhabricatorApplication::isClassInstalled(
+      'PhabricatorBadgesApplication');
+  }
+
+  protected function getObjectPattern() {
+    return 'BDGE[1-9]\d*';
+  }
+
+  protected function loadObject($pattern, PhabricatorUser $viewer) {
+    $id = (int)substr($pattern, 4);
+
+    return id(new PhabricatorBadgesQuery())
+      ->setViewer($viewer)
+      ->withIDs(array($id))
+      ->executeOne();
+  }
+
+  protected function getTransactionReplyHandler() {
+    return new PhabricatorBadgesReplyHandler();
+  }
+
+}

src/applications/badges/mail/PhabricatorBadgesReplyHandler.php

···
+<?php
+
+final class PhabricatorBadgesReplyHandler
+  extends PhabricatorApplicationTransactionReplyHandler {
+
+  public function validateMailReceiver($mail_receiver) {
+    if (!($mail_receiver instanceof PhabricatorBadgesBadge)) {
+      throw new Exception(pht('Mail receiver is not a %s!', 'Badges'));
+    }
+  }
+
+  public function getObjectPrefix() {
+    return 'BDGE';
+  }
+
+}

src/applications/badges/storage/PhabricatorBadgesBadge.php

···
   protected $description;
   protected $icon;
   protected $quality;
+  protected $mailKey;
   protected $viewPolicy;
   protected $editPolicy;
   protected $status;
···
         'icon' => 'text255',
         'quality' => 'text255',
         'status' => 'text32',
+        'mailKey' => 'bytes20',
       ),
       self::CONFIG_KEY_SCHEMA => array(
         'key_creator' => array(
···
 
   public function getRecipientPHIDs() {
     return $this->assertAttached($this->recipientPHIDs);
+  }
+
+  public function save() {
+    if (!$this->getMailKey()) {
+      $this->setMailKey(Filesystem::readRandomCharacters(20));
+    }
+    return parent::save();
   }
 
 

src/applications/badges/storage/PhabricatorBadgesTransaction.php

···
   const TYPE_STATUS = 'badges:status';
   const TYPE_FLAVOR = 'badges:flavor';
 
+  const MAILTAG_NAME = 'badges:name';
+  const MAILTAG_DETAILS = 'badges:details';
+  const MAILTAG_COMMENT = 'badges:comment';
+  const MAILTAG_OTHER  = 'badges:other';
+
   public function getApplicationName() {
     return 'badges';
   }
···
     }
 
     return parent::getTitleForFeed();
+  }
+
+  public function getMailTags() {
+    $tags = parent::getMailTags();
+
+    switch ($this->getTransactionType()) {
+      case PhabricatorTransactions::TYPE_COMMENT:
+        $tags[] = self::MAILTAG_COMMENT;
+        break;
+      case self::TYPE_NAME:
+      case self::TYPE_DESCRIPTION:
+      case self::TYPE_FLAVOR:
+      case self::TYPE_ICON:
+      case self::TYPE_STATUS:
+      case self::TYPE_QUALITY:
+        $tags[] = self::MAILTAG_DETAILS;
+        break;
+      default:
+        $tags[] = self::MAILTAG_OTHER;
+        break;
+    }
+    return $tags;
   }