src/applications/repository/worker/PhabricatorRepositoryCommitParserWorker.php

   1 <?php
   2
   3 abstract class PhabricatorRepositoryCommitParserWorker
   4   extends PhabricatorWorker {
   5
   6   protected $commit;
   7   protected $repository;
   8
   9   private function loadCommit() {
  10     if ($this->commit) {
  11       return $this->commit;
  12     }
  13
  14     $viewer = $this->getViewer();
  15     $task_data = $this->getTaskData();
  16
  17     $commit_query = id(new DiffusionCommitQuery())
  18       ->setViewer($viewer);
  19
  20     $commit_phid = idx($task_data, 'commitPHID');
  21
  22     // TODO: See T13591. This supports execution of legacy tasks and can
  23     // eventually be removed. Newer tasks use "commitPHID" instead of
  24     // "commitID".
  25     if (!$commit_phid) {
  26       $commit_id = idx($task_data, 'commitID');
  27       if ($commit_id) {
  28         $legacy_commit = id(clone $commit_query)
  29           ->withIDs(array($commit_id))
  30           ->executeOne();
  31         if ($legacy_commit) {
  32           $commit_phid = $legacy_commit->getPHID();
  33         }
  34       }
  35     }
  36
  37     if (!$commit_phid) {
  38       throw new PhabricatorWorkerPermanentFailureException(
  39         pht('Task data has no "commitPHID".'));
  40     }
  41
  42     $commit = id(clone $commit_query)
  43       ->withPHIDs(array($commit_phid))
  44       ->executeOne();
  45     if (!$commit) {
  46       throw new PhabricatorWorkerPermanentFailureException(
  47         pht('Commit "%s" does not exist.', $commit_phid));
  48     }
  49
  50     if ($commit->isUnreachable()) {
  51       throw new PhabricatorWorkerPermanentFailureException(
  52         pht(
  53           'Commit "%s" (with PHID "%s") is no longer reachable from any '.
  54           'branch, tag, or ref in this repository, so it will not be '.
  55           'imported. This usually means that the branch the commit was on '.
  56           'was deleted or overwritten.',
  57           $commit->getMonogram(),
  58           $commit_phid));
  59     }
  60
  61     $this->commit = $commit;
  62
  63     return $commit;
  64   }
  65
  66   final protected function doWork() {
  67     $commit = $this->loadCommit();
  68     $repository = $commit->getRepository();
  69
  70     $this->repository = $repository;
  71
  72     $this->parseCommit($repository, $this->commit);
  73   }
  74
  75   private function shouldQueueFollowupTasks() {
  76     return !idx($this->getTaskData(), 'only');
  77   }
  78
  79   final protected function queueCommitTask($task_class) {
  80     if (!$this->shouldQueueFollowupTasks()) {
  81       return;
  82     }
  83
  84     $commit = $this->loadCommit();
  85     $repository = $commit->getRepository();
  86
  87     $data = array(
  88       'commitPHID' => $commit->getPHID(),
  89     );
  90
  91     $task_data = $this->getTaskData();
  92     if (isset($task_data['via'])) {
  93       $data['via'] = $task_data['via'];
  94     }
  95
  96     $options = array(
  97       // We queue followup tasks at default priority so that the queue finishes
  98       // work it has started before starting more work. If followups are queued
  99       // at the same priority level, we do all message parses first, then all
 100       // change parses, etc. This makes progress uneven. See T11677 for
 101       // discussion.
 102       'priority' => parent::PRIORITY_DEFAULT,
 103
 104       'objectPHID' => $commit->getPHID(),
 105       'containerPHID' => $repository->getPHID(),
 106     );
 107
 108     $this->queueTask($task_class, $data, $options);
 109   }
 110
 111   protected function getImportStepFlag() {
 112     return null;
 113   }
 114
 115   final protected function shouldSkipImportStep() {
 116     // If this step has already been performed and this is a "natural" task
 117     // which was queued by the normal daemons, decline to do the work again.
 118     // This mitigates races if commits are rapidly deleted and revived.
 119     $flag = $this->getImportStepFlag();
 120     if (!$flag) {
 121       // This step doesn't have an associated flag.
 122       return false;
 123     }
 124
 125     $commit = $this->commit;
 126     if (!$commit->isPartiallyImported($flag)) {
 127       // This commit doesn't have the flag set yet.
 128       return false;
 129     }
 130
 131
 132     if (!$this->shouldQueueFollowupTasks()) {
 133       // This task was queued by administrative tools, so do the work even
 134       // if it duplicates existing work.
 135       return false;
 136     }
 137
 138     $this->log(
 139       "%s\n",
 140       pht(
 141         'Skipping import step; this step was previously completed for '.
 142         'this commit.'));
 143
 144     return true;
 145   }
 146
 147   abstract protected function parseCommit(
 148     PhabricatorRepository $repository,
 149     PhabricatorRepositoryCommit $commit);
 150
 151   protected function loadCommitHint(PhabricatorRepositoryCommit $commit) {
 152     $viewer = PhabricatorUser::getOmnipotentUser();
 153
 154     $repository = $commit->getRepository();
 155
 156     return id(new DiffusionCommitHintQuery())
 157       ->setViewer($viewer)
 158       ->withRepositoryPHIDs(array($repository->getPHID()))
 159       ->withOldCommitIdentifiers(array($commit->getCommitIdentifier()))
 160       ->executeOne();
 161   }
 162
 163   public function renderForDisplay(PhabricatorUser $viewer) {
 164     $suffix = parent::renderForDisplay($viewer);
 165
 166     $commit = id(new DiffusionCommitQuery())
 167       ->setViewer($viewer)
 168       ->withPHIDs(array(idx($this->getTaskData(), 'commitPHID')))
 169       ->executeOne();
 170     if (!$commit) {
 171       return $suffix;
 172     }
 173
 174     $link = DiffusionView::linkCommit(
 175       $commit->getRepository(),
 176       $commit->getCommitIdentifier());
 177
 178     return array($link, $suffix);
 179   }
 180
 181   final protected function loadCommitData(PhabricatorRepositoryCommit $commit) {
 182     if ($commit->hasCommitData()) {
 183       return $commit->getCommitData();
 184     }
 185
 186     $commit_id = $commit->getID();
 187
 188     $data = id(new PhabricatorRepositoryCommitData())->loadOneWhere(
 189       'commitID = %d',
 190       $commit_id);
 191     if (!$data) {
 192       $data = id(new PhabricatorRepositoryCommitData())
 193         ->setCommitID($commit_id);
 194     }
 195
 196     $commit->attachCommitData($data);
 197
 198     return $data;
 199   }
 200
 201   final public function getViewer() {
 202     return PhabricatorUser::getOmnipotentUser();
 203   }
 204
 205 }