src/applications/releeph/editor/ReleephRequestTransactionalEditor.php

   1 <?php
   2
   3 final class ReleephRequestTransactionalEditor
   4   extends PhabricatorApplicationTransactionEditor {
   5
   6   public function getEditorApplicationClass() {
   7     return 'PhabricatorReleephApplication';
   8   }
   9
  10   public function getEditorObjectsDescription() {
  11     return pht('Releeph Requests');
  12   }
  13
  14   public function getTransactionTypes() {
  15     $types = parent::getTransactionTypes();
  16
  17     $types[] = PhabricatorTransactions::TYPE_COMMENT;
  18     $types[] = ReleephRequestTransaction::TYPE_COMMIT;
  19     $types[] = ReleephRequestTransaction::TYPE_DISCOVERY;
  20     $types[] = ReleephRequestTransaction::TYPE_EDIT_FIELD;
  21     $types[] = ReleephRequestTransaction::TYPE_MANUAL_IN_BRANCH;
  22     $types[] = ReleephRequestTransaction::TYPE_PICK_STATUS;
  23     $types[] = ReleephRequestTransaction::TYPE_REQUEST;
  24     $types[] = ReleephRequestTransaction::TYPE_USER_INTENT;
  25
  26     return $types;
  27   }
  28
  29   protected function getCustomTransactionOldValue(
  30     PhabricatorLiskDAO $object,
  31     PhabricatorApplicationTransaction $xaction) {
  32
  33     switch ($xaction->getTransactionType()) {
  34       case ReleephRequestTransaction::TYPE_REQUEST:
  35         return $object->getRequestCommitPHID();
  36
  37       case ReleephRequestTransaction::TYPE_EDIT_FIELD:
  38         $field = newv($xaction->getMetadataValue('fieldClass'), array());
  39         $value = $field->setReleephRequest($object)->getValue();
  40         return $value;
  41
  42       case ReleephRequestTransaction::TYPE_USER_INTENT:
  43         $user_phid = $xaction->getAuthorPHID();
  44         return idx($object->getUserIntents(), $user_phid);
  45
  46       case ReleephRequestTransaction::TYPE_PICK_STATUS:
  47         return (int)$object->getPickStatus();
  48         break;
  49
  50       case ReleephRequestTransaction::TYPE_COMMIT:
  51         return $object->getCommitIdentifier();
  52
  53       case ReleephRequestTransaction::TYPE_DISCOVERY:
  54         return $object->getCommitPHID();
  55
  56       case ReleephRequestTransaction::TYPE_MANUAL_IN_BRANCH:
  57         return $object->getInBranch();
  58     }
  59   }
  60
  61   protected function getCustomTransactionNewValue(
  62     PhabricatorLiskDAO $object,
  63     PhabricatorApplicationTransaction $xaction) {
  64
  65     switch ($xaction->getTransactionType()) {
  66       case ReleephRequestTransaction::TYPE_REQUEST:
  67       case ReleephRequestTransaction::TYPE_USER_INTENT:
  68       case ReleephRequestTransaction::TYPE_EDIT_FIELD:
  69       case ReleephRequestTransaction::TYPE_PICK_STATUS:
  70       case ReleephRequestTransaction::TYPE_COMMIT:
  71       case ReleephRequestTransaction::TYPE_DISCOVERY:
  72       case ReleephRequestTransaction::TYPE_MANUAL_IN_BRANCH:
  73         return $xaction->getNewValue();
  74     }
  75   }
  76
  77   protected function applyCustomInternalTransaction(
  78     PhabricatorLiskDAO $object,
  79     PhabricatorApplicationTransaction $xaction) {
  80
  81     $new = $xaction->getNewValue();
  82
  83     switch ($xaction->getTransactionType()) {
  84       case ReleephRequestTransaction::TYPE_REQUEST:
  85         $object->setRequestCommitPHID($new);
  86         break;
  87
  88       case ReleephRequestTransaction::TYPE_USER_INTENT:
  89         $user_phid = $xaction->getAuthorPHID();
  90         $intents = $object->getUserIntents();
  91         $intents[$user_phid] = $new;
  92         $object->setUserIntents($intents);
  93         break;
  94
  95       case ReleephRequestTransaction::TYPE_EDIT_FIELD:
  96         $field = newv($xaction->getMetadataValue('fieldClass'), array());
  97         $field
  98           ->setReleephRequest($object)
  99           ->setValue($new);
 100         break;
 101
 102       case ReleephRequestTransaction::TYPE_PICK_STATUS:
 103         $object->setPickStatus($new);
 104         break;
 105
 106       case ReleephRequestTransaction::TYPE_COMMIT:
 107         $this->setInBranchFromAction($object, $xaction);
 108         $object->setCommitIdentifier($new);
 109         break;
 110
 111       case ReleephRequestTransaction::TYPE_DISCOVERY:
 112         $this->setInBranchFromAction($object, $xaction);
 113         $object->setCommitPHID($new);
 114         break;
 115
 116       case ReleephRequestTransaction::TYPE_MANUAL_IN_BRANCH:
 117         $object->setInBranch((int)$new);
 118         break;
 119     }
 120   }
 121
 122   protected function applyCustomExternalTransaction(
 123     PhabricatorLiskDAO $object,
 124     PhabricatorApplicationTransaction $xaction) {
 125
 126     return;
 127   }
 128
 129   protected function filterTransactions(
 130     PhabricatorLiskDAO $object,
 131     array $xactions) {
 132
 133     // Remove TYPE_DISCOVERY xactions that are the result of a reparse.
 134     $previously_discovered_commits = array();
 135     $discovery_xactions = idx(
 136       mgroup($xactions, 'getTransactionType'),
 137       ReleephRequestTransaction::TYPE_DISCOVERY);
 138     if ($discovery_xactions) {
 139       $previous_xactions = id(new ReleephRequestTransactionQuery())
 140         ->setViewer(PhabricatorUser::getOmnipotentUser())
 141         ->withObjectPHIDs(array($object->getPHID()))
 142         ->execute();
 143
 144       foreach ($previous_xactions as $xaction) {
 145         if ($xaction->getTransactionType() ===
 146           ReleephRequestTransaction::TYPE_DISCOVERY) {
 147
 148           $commit_phid = $xaction->getNewValue();
 149           $previously_discovered_commits[$commit_phid] = true;
 150         }
 151       }
 152     }
 153
 154     foreach ($xactions as $key => $xaction) {
 155       if ($xaction->getTransactionType() ===
 156         ReleephRequestTransaction::TYPE_DISCOVERY &&
 157         idx($previously_discovered_commits, $xaction->getNewValue())) {
 158
 159         unset($xactions[$key]);
 160       }
 161     }
 162
 163     return parent::filterTransactions($object, $xactions);
 164   }
 165
 166   protected function shouldSendMail(
 167     PhabricatorLiskDAO $object,
 168     array $xactions) {
 169
 170     // Avoid sending emails that only talk about commit discovery.
 171     $types = array_unique(mpull($xactions, 'getTransactionType'));
 172     if ($types === array(ReleephRequestTransaction::TYPE_DISCOVERY)) {
 173       return false;
 174     }
 175
 176     // Don't email people when we discover that something picks or reverts OK.
 177     if ($types === array(ReleephRequestTransaction::TYPE_PICK_STATUS)) {
 178       if (!mfilter($xactions, 'isBoringPickStatus', true /* negate */)) {
 179         // If we effectively call "isInterestingPickStatus" and get nothing...
 180         return false;
 181       }
 182     }
 183
 184     return true;
 185   }
 186
 187   protected function buildReplyHandler(PhabricatorLiskDAO $object) {
 188     return id(new ReleephRequestReplyHandler())
 189       ->setActor($this->getActor())
 190       ->setMailReceiver($object);
 191   }
 192
 193   protected function getMailSubjectPrefix() {
 194     return '[Releeph]';
 195   }
 196
 197   protected function buildMailTemplate(PhabricatorLiskDAO $object) {
 198     $id = $object->getID();
 199     $title = $object->getSummaryForDisplay();
 200     return id(new PhabricatorMetaMTAMail())
 201       ->setSubject("RQ{$id}: {$title}");
 202   }
 203
 204   protected function getMailTo(PhabricatorLiskDAO $object) {
 205     $to_phids = array();
 206
 207     $product = $object->getBranch()->getProduct();
 208     foreach ($product->getPushers() as $phid) {
 209       $to_phids[] = $phid;
 210     }
 211
 212     foreach ($object->getUserIntents() as $phid => $intent) {
 213       $to_phids[] = $phid;
 214     }
 215
 216     return $to_phids;
 217   }
 218
 219   protected function getMailCC(PhabricatorLiskDAO $object) {
 220     return array();
 221   }
 222
 223   protected function buildMailBody(
 224     PhabricatorLiskDAO $object,
 225     array $xactions) {
 226
 227     $body = parent::buildMailBody($object, $xactions);
 228
 229     $rq = $object;
 230     $releeph_branch = $rq->getBranch();
 231     $releeph_project = $releeph_branch->getProduct();
 232
 233     /**
 234      * If any of the events we are emailing about were about a pick failure
 235      * (and/or a revert failure?), include pick failure instructions.
 236      */
 237     $has_pick_failure = false;
 238     foreach ($xactions as $xaction) {
 239       if ($xaction->getTransactionType() ===
 240         ReleephRequestTransaction::TYPE_PICK_STATUS &&
 241         $xaction->getNewValue() === ReleephRequest::PICK_FAILED) {
 242
 243         $has_pick_failure = true;
 244         break;
 245       }
 246     }
 247     if ($has_pick_failure) {
 248       $instructions = $releeph_project->getDetail('pick_failure_instructions');
 249       if ($instructions) {
 250         $body->addRemarkupSection(
 251           pht('PICK FAILURE INSTRUCTIONS'),
 252           $instructions);
 253       }
 254     }
 255
 256     $name = sprintf('RQ%s: %s', $rq->getID(), $rq->getSummaryForDisplay());
 257     $body->addTextSection(
 258       pht('RELEEPH REQUEST'),
 259       $name."\n".
 260       PhabricatorEnv::getProductionURI('/RQ'.$rq->getID()));
 261
 262     $project_and_branch = sprintf(
 263       '%s - %s',
 264       $releeph_project->getName(),
 265       $releeph_branch->getDisplayNameWithDetail());
 266
 267     $body->addTextSection(
 268       pht('RELEEPH BRANCH'),
 269       $project_and_branch."\n".
 270       PhabricatorEnv::getProductionURI($releeph_branch->getURI()));
 271
 272     return $body;
 273   }
 274
 275   private function setInBranchFromAction(
 276     ReleephRequest $rq,
 277     ReleephRequestTransaction $xaction) {
 278
 279     $action = $xaction->getMetadataValue('action');
 280     switch ($action) {
 281       case 'pick':
 282         $rq->setInBranch(1);
 283         break;
 284
 285       case 'revert':
 286         $rq->setInBranch(0);
 287         break;
 288
 289       default:
 290         $id = $rq->getID();
 291         $type = $xaction->getTransactionType();
 292         $new = $xaction->getNewValue();
 293         phlog(
 294           pht(
 295             "Unknown discovery action '%s' for xaction of type %s ".
 296             "with new value %s mentioning %s!",
 297             $action,
 298             $type,
 299             $new,
 300             'RQ'.$id));
 301         break;
 302     }
 303
 304     return $this;
 305   }
 306
 307 }