ManiphestTransactionEditor.php 27.4 KB
Newer Older
epriestley's avatar
epriestley committed
1
2
<?php

3
4
final class ManiphestTransactionEditor
  extends PhabricatorApplicationTransactionEditor {
epriestley's avatar
epriestley committed
5

6
  private $oldProjectPHIDs;
7
8
  private $moreValidationErrors = array();

epriestley's avatar
epriestley committed
9
10
11
12
13
14
15
16
  public function getEditorApplicationClass() {
    return 'PhabricatorManiphestApplication';
  }

  public function getEditorObjectsDescription() {
    return pht('Maniphest Tasks');
  }

17
18
  public function getTransactionTypes() {
    $types = parent::getTransactionTypes();
19

20
    $types[] = PhabricatorTransactions::TYPE_COMMENT;
21
    $types[] = PhabricatorTransactions::TYPE_EDGE;
22
    $types[] = PhabricatorTransactions::TYPE_COLUMNS;
23
24
25
26
27
28
    $types[] = PhabricatorTransactions::TYPE_VIEW_POLICY;
    $types[] = PhabricatorTransactions::TYPE_EDIT_POLICY;

    return $types;
  }

29
30
31
32
33
34
35
36
  public function getCreateObjectTitle($author, $object) {
    return pht('%s created this task.', $author);
  }

  public function getCreateObjectTitleForFeed($author, $object) {
    return pht('%s created %s.', $author, $object);
  }

37
38
39
40
41
  protected function getCustomTransactionOldValue(
    PhabricatorLiskDAO $object,
    PhabricatorApplicationTransaction $xaction) {

    switch ($xaction->getTransactionType()) {
42
      case PhabricatorTransactions::TYPE_COLUMNS:
43
        return null;
44
45
46
47
48
49
50
51
    }
  }

  protected function getCustomTransactionNewValue(
    PhabricatorLiskDAO $object,
    PhabricatorApplicationTransaction $xaction) {

    switch ($xaction->getTransactionType()) {
52
      case PhabricatorTransactions::TYPE_COLUMNS:
53
        return $xaction->getNewValue();
54
55
56
57
58
59
60
61
62
63
64
    }
  }

  protected function transactionHasEffect(
    PhabricatorLiskDAO $object,
    PhabricatorApplicationTransaction $xaction) {

    $old = $xaction->getOldValue();
    $new = $xaction->getNewValue();

    switch ($xaction->getTransactionType()) {
65
66
      case PhabricatorTransactions::TYPE_COLUMNS:
        return (bool)$new;
67
68
69
70
71
72
73
74
75
76
    }

    return parent::transactionHasEffect($object, $xaction);
  }

  protected function applyCustomInternalTransaction(
    PhabricatorLiskDAO $object,
    PhabricatorApplicationTransaction $xaction) {

    switch ($xaction->getTransactionType()) {
77
      case PhabricatorTransactions::TYPE_COLUMNS:
78
        return;
79
80
81
82
83
84
    }
  }

  protected function applyCustomExternalTransaction(
    PhabricatorLiskDAO $object,
    PhabricatorApplicationTransaction $xaction) {
85
86

    switch ($xaction->getTransactionType()) {
87
88
89
      case PhabricatorTransactions::TYPE_COLUMNS:
        foreach ($xaction->getNewValue() as $move) {
          $this->applyBoardMove($object, $move);
90
91
92
        }
        break;
    }
93
94
  }

95
96
97
98
99
100
101
102
103
  protected function applyFinalEffects(
    PhabricatorLiskDAO $object,
    array $xactions) {

    // When we change the status of a task, update tasks this tasks blocks
    // with a message to the effect of "alincoln resolved blocking task Txxx."
    $unblock_xaction = null;
    foreach ($xactions as $xaction) {
      switch ($xaction->getTransactionType()) {
104
        case ManiphestTaskStatusTransaction::TRANSACTIONTYPE:
105
106
107
108
109
110
111
112
          $unblock_xaction = $xaction;
          break;
      }
    }

    if ($unblock_xaction !== null) {
      $blocked_phids = PhabricatorEdgeQuery::loadDestinationPHIDs(
        $object->getPHID(),
113
        ManiphestTaskDependedOnByTaskEdgeType::EDGECONST);
114
115
116
117
118
119
      if ($blocked_phids) {
        // In theory we could apply these through policies, but that seems a
        // little bit surprising. For now, use the actor's vision.
        $blocked_tasks = id(new ManiphestTaskQuery())
          ->setViewer($this->getActor())
          ->withPHIDs($blocked_phids)
120
          ->needSubscriberPHIDs(true)
121
          ->needProjectPHIDs(true)
122
123
124
125
126
127
          ->execute();

        $old = $unblock_xaction->getOldValue();
        $new = $unblock_xaction->getNewValue();

        foreach ($blocked_tasks as $blocked_task) {
128
          $parent_xaction = id(new ManiphestTransaction())
129
130
            ->setTransactionType(
              ManiphestTaskUnblockTransaction::TRANSACTIONTYPE)
131
132
133
            ->setOldValue(array($object->getPHID() => $old))
            ->setNewValue(array($object->getPHID() => $new));

134
135
136
137
          if ($this->getIsNewObject()) {
            $parent_xaction->setMetadataValue('blocker.new', true);
          }

138
          $this->newSubEditor()
139
140
            ->setContinueOnNoEffect(true)
            ->setContinueOnMissingFields(true)
141
            ->applyTransactions($blocked_task, array($parent_xaction));
142
143
144
145
146
147
148
        }
      }
    }

    return $xactions;
  }

epriestley's avatar
epriestley committed
149
150
151
152
153
154
  protected function shouldSendMail(
    PhabricatorLiskDAO $object,
    array $xactions) {
    return true;
  }

155
  protected function getMailSubjectPrefix() {
156
    return pht('[Maniphest]');
157
158
159
160
161
162
163
  }

  protected function getMailThreadID(PhabricatorLiskDAO $object) {
    return 'maniphest-task-'.$object->getPHID();
  }

  protected function getMailTo(PhabricatorLiskDAO $object) {
164
165
166
167
168
169
170
171
    $phids = array();

    if ($object->getOwnerPHID()) {
      $phids[] = $object->getOwnerPHID();
    }
    $phids[] = $this->getActingAsPHID();

    return $phids;
172
173
  }

epriestley's avatar
epriestley committed
174
175
  public function getMailTagsMap() {
    return array(
176
      ManiphestTransaction::MAILTAG_STATUS =>
epriestley's avatar
epriestley committed
177
        pht("A task's status changes."),
178
      ManiphestTransaction::MAILTAG_OWNER =>
epriestley's avatar
epriestley committed
179
        pht("A task's owner changes."),
180
      ManiphestTransaction::MAILTAG_PRIORITY =>
epriestley's avatar
epriestley committed
181
        pht("A task's priority changes."),
182
183
184
      ManiphestTransaction::MAILTAG_CC =>
        pht("A task's subscribers change."),
      ManiphestTransaction::MAILTAG_PROJECTS =>
epriestley's avatar
epriestley committed
185
        pht("A task's associated projects change."),
186
      ManiphestTransaction::MAILTAG_UNBLOCK =>
187
        pht("One of a task's subtasks changes status."),
188
189
190
      ManiphestTransaction::MAILTAG_COLUMN =>
        pht('A task is moved between columns on a workboard.'),
      ManiphestTransaction::MAILTAG_COMMENT =>
epriestley's avatar
epriestley committed
191
        pht('Someone comments on a task.'),
192
      ManiphestTransaction::MAILTAG_OTHER =>
epriestley's avatar
epriestley committed
193
194
195
196
        pht('Other task activity not listed above occurs.'),
    );
  }

197
198
199
200
201
202
203
204
205
206
  protected function buildReplyHandler(PhabricatorLiskDAO $object) {
    return id(new ManiphestReplyHandler())
      ->setMailReceiver($object);
  }

  protected function buildMailTemplate(PhabricatorLiskDAO $object) {
    $id = $object->getID();
    $title = $object->getTitle();

    return id(new PhabricatorMetaMTAMail())
207
      ->setSubject("T{$id}: {$title}");
208
209
  }

210
211
  protected function getObjectLinkButtonLabelForMail(
    PhabricatorLiskDAO $object) {
212
213
214
    return pht('View Task');
  }

215
216
217
218
219
220
221
  protected function buildMailBody(
    PhabricatorLiskDAO $object,
    array $xactions) {

    $body = parent::buildMailBody($object, $xactions);

    if ($this->getIsNewObject()) {
Joshua Spence's avatar
Joshua Spence committed
222
      $body->addRemarkupSection(
223
224
225
226
        pht('TASK DESCRIPTION'),
        $object->getDescription());
    }

227
    $body->addLinkSection(
228
229
230
      pht('TASK DETAIL'),
      PhabricatorEnv::getProductionURI('/T'.$object->getID()));

231
232

    $board_phids = array();
233
    $type_columns = PhabricatorTransactions::TYPE_COLUMNS;
234
    foreach ($xactions as $xaction) {
235
236
237
238
      if ($xaction->getTransactionType() == $type_columns) {
        $moves = $xaction->getNewValue();
        foreach ($moves as $move) {
          $board_phids[] = $move['boardPHID'];
239
240
241
242
243
244
245
246
247
248
249
250
251
        }
      }
    }

    if ($board_phids) {
      $projects = id(new PhabricatorProjectQuery())
        ->setViewer($this->requireActor())
        ->withPHIDs($board_phids)
        ->execute();

      foreach ($projects as $project) {
        $body->addLinkSection(
          pht('WORKBOARD'),
252
          PhabricatorEnv::getProductionURI($project->getWorkboardURI()));
253
254
255
256
      }
    }


257
258
259
    return $body;
  }

260
261
262
  protected function shouldPublishFeedStory(
    PhabricatorLiskDAO $object,
    array $xactions) {
263
    return true;
264
265
266
267
268
269
  }

  protected function supportsSearch() {
    return true;
  }

270
271
272
  protected function shouldApplyHeraldRules(
    PhabricatorLiskDAO $object,
    array $xactions) {
273
274
275
276
277
278
279
280
281
282
283
    return true;
  }

  protected function buildHeraldAdapter(
    PhabricatorLiskDAO $object,
    array $xactions) {

    return id(new HeraldManiphestTaskAdapter())
      ->setTask($object);
  }

284
285
286
287
288
289
290
  protected function adjustObjectForPolicyChecks(
    PhabricatorLiskDAO $object,
    array $xactions) {

    $copy = parent::adjustObjectForPolicyChecks($object, $xactions);
    foreach ($xactions as $xaction) {
      switch ($xaction->getTransactionType()) {
291
        case ManiphestTaskOwnerTransaction::TRANSACTIONTYPE:
292
293
294
          $copy->setOwnerPHID($xaction->getNewValue());
          break;
        default:
295
          break;
296
297
298
299
300
      }
    }

    return $copy;
  }
301

302
303
304
305
306
307
308
309
310
311
  protected function validateAllTransactions(
    PhabricatorLiskDAO $object,
    array $xactions) {

    $errors = parent::validateAllTransactions($object, $xactions);

    if ($this->moreValidationErrors) {
      $errors = array_merge($errors, $this->moreValidationErrors);
    }

312
313
314
315
    foreach ($this->getLockValidationErrors($object, $xactions) as $error) {
      $errors[] = $error;
    }

316
317
318
    return $errors;
  }

319
320
321
  protected function expandTransactions(
    PhabricatorLiskDAO $object,
    array $xactions) {
322
323
324
325

    $actor = $this->getActor();
    $actor_phid = $actor->getPHID();

326
327
328
329
330
331
    $results = parent::expandTransactions($object, $xactions);

    $is_unassigned = ($object->getOwnerPHID() === null);

    $any_assign = false;
    foreach ($xactions as $xaction) {
332
333
      if ($xaction->getTransactionType() ==
        ManiphestTaskOwnerTransaction::TRANSACTIONTYPE) {
334
335
336
337
338
339
340
341
342
343
        $any_assign = true;
        break;
      }
    }

    $is_open = !$object->isClosed();

    $new_status = null;
    foreach ($xactions as $xaction) {
      switch ($xaction->getTransactionType()) {
344
        case ManiphestTaskStatusTransaction::TRANSACTIONTYPE:
345
346
347
348
349
350
351
352
353
354
355
356
357
358
          $new_status = $xaction->getNewValue();
          break;
      }
    }

    if ($new_status === null) {
      $is_closing = false;
    } else {
      $is_closing = ManiphestTaskStatus::isClosedStatus($new_status);
    }

    // If the task is not assigned, not being assigned, currently open, and
    // being closed, try to assign the actor as the owner.
    if ($is_unassigned && !$any_assign && $is_open && $is_closing) {
359
360
      $is_claim = ManiphestTaskStatus::isClaimStatus($new_status);

361
      // Don't assign the actor if they aren't a real user.
362
363
      // Don't claim the task if the status is configured to not claim.
      if ($actor_phid && $is_claim) {
364
        $results[] = id(new ManiphestTransaction())
365
          ->setTransactionType(ManiphestTaskOwnerTransaction::TRANSACTIONTYPE)
366
367
368
369
          ->setNewValue($actor_phid);
      }
    }

370
371
372
373
374
375
376
377
378
379
380
381
    // Automatically subscribe the author when they create a task.
    if ($this->getIsNewObject()) {
      if ($actor_phid) {
        $results[] = id(new ManiphestTransaction())
          ->setTransactionType(PhabricatorTransactions::TYPE_SUBSCRIBERS)
          ->setNewValue(
            array(
              '+' => array($actor_phid => $actor_phid),
            ));
      }
    }

382
383
384
385
386
    $send_notifications = PhabricatorNotificationClient::isEnabled();
    if ($send_notifications) {
      $this->oldProjectPHIDs = $this->loadProjectPHIDs($object);
    }

387
388
389
390
391
392
393
394
395
    return $results;
  }

  protected function expandTransaction(
    PhabricatorLiskDAO $object,
    PhabricatorApplicationTransaction $xaction) {

    $results = parent::expandTransaction($object, $xaction);

396
397
398
399
    $type = $xaction->getTransactionType();
    switch ($type) {
      case PhabricatorTransactions::TYPE_COLUMNS:
        try {
400
401
402
          $more_xactions = $this->buildMoveTransaction($object, $xaction);
          foreach ($more_xactions as $more_xaction) {
            $results[] = $more_xaction;
403
404
405
406
407
408
409
410
          }
        } catch (Exception $ex) {
          $error = new PhabricatorApplicationTransactionValidationError(
            $type,
            pht('Invalid'),
            $ex->getMessage(),
            $xaction);
          $this->moreValidationErrors[] = $error;
411
412
        }
        break;
413
      case ManiphestTaskOwnerTransaction::TRANSACTIONTYPE:
414
415
416
417
        // If this is a no-op update, don't expand it.
        $old_value = $object->getOwnerPHID();
        $new_value = $xaction->getNewValue();
        if ($old_value === $new_value) {
418
          break;
419
420
        }

421
422
        // When a task is reassigned, move the old owner to the subscriber
        // list so they're still in the loop.
423
        if ($old_value) {
424
425
426
427
428
          $results[] = id(new ManiphestTransaction())
            ->setTransactionType(PhabricatorTransactions::TYPE_SUBSCRIBERS)
            ->setIgnoreOnNoEffect(true)
            ->setNewValue(
              array(
429
                '+' => array($old_value => $old_value),
430
431
432
433
434
435
436
437
              ));
        }
        break;
    }

    return $results;
  }

438
439
440
  private function buildMoveTransaction(
    PhabricatorLiskDAO $object,
    PhabricatorApplicationTransaction $xaction) {
441
    $actor = $this->getActor();
442
443
444
445
446
447
448

    $new = $xaction->getNewValue();
    if (!is_array($new)) {
      $this->validateColumnPHID($new);
      $new = array($new);
    }

449
    $relative_phids = array();
450
451
452
453
454
455
456
457
458
459
460
461
    foreach ($new as $key => $value) {
      if (!is_array($value)) {
        $this->validateColumnPHID($value);
        $value = array(
          'columnPHID' => $value,
        );
      }

      PhutilTypeSpec::checkMap(
        $value,
        array(
          'columnPHID' => 'string',
462
463
464
465
          'beforePHIDs' => 'optional list<string>',
          'afterPHIDs' => 'optional list<string>',

          // Deprecated older variations of "beforePHIDs" and "afterPHIDs".
466
467
468
469
          'beforePHID' => 'optional string',
          'afterPHID' => 'optional string',
        ));

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
      $value = $value + array(
        'beforePHIDs' => array(),
        'afterPHIDs' => array(),
      );

      // Normalize the legacy keys "beforePHID" and "afterPHID" keys to the
      // modern format.
      if (!empty($value['afterPHID'])) {
        if ($value['afterPHIDs']) {
          throw new Exception(
            pht(
              'Transaction specifies both "afterPHID" and "afterPHIDs". '.
              'Specify only "afterPHIDs".'));
        }
        $value['afterPHIDs'] = array($value['afterPHID']);
        unset($value['afterPHID']);
      }

      if (isset($value['beforePHID'])) {
        if ($value['beforePHIDs']) {
          throw new Exception(
            pht(
              'Transaction specifies both "beforePHID" and "beforePHIDs". '.
              'Specify only "beforePHIDs".'));
        }
        $value['beforePHIDs'] = array($value['beforePHID']);
        unset($value['beforePHID']);
      }
498

499
500
      foreach ($value['beforePHIDs'] as $phid) {
        $relative_phids[] = $phid;
501
502
      }

503
504
      foreach ($value['afterPHIDs'] as $phid) {
        $relative_phids[] = $phid;
505
      }
506
507

      $new[$key] = $value;
508
509
    }

510
511
512
513
514
515
516
517
    // We require that objects you specify in "beforePHIDs" or "afterPHIDs"
    // are real objects which exist and which you have permission to view.
    // If you provide other objects, we remove them from the specification.

    if ($relative_phids) {
      $objects = id(new PhabricatorObjectQuery())
        ->setViewer($actor)
        ->withPHIDs($relative_phids)
518
        ->execute();
519
      $objects = mpull($objects, null, 'getPHID');
520
    } else {
521
522
523
524
525
526
527
528
529
530
531
532
      $objects = array();
    }

    foreach ($new as $key => $value) {
      $value['afterPHIDs'] = $this->filterValidPHIDs(
        $value['afterPHIDs'],
        $objects);
      $value['beforePHIDs'] = $this->filterValidPHIDs(
        $value['beforePHIDs'],
        $objects);

      $new[$key] = $value;
533
534
535
536
537
    }

    $column_phids = ipull($new, 'columnPHID');
    if ($column_phids) {
      $columns = id(new PhabricatorProjectColumnQuery())
538
        ->setViewer($actor)
539
540
541
542
543
544
545
546
547
548
549
550
        ->withPHIDs($column_phids)
        ->execute();
      $columns = mpull($columns, null, 'getPHID');
    } else {
      $columns = array();
    }

    $board_phids = mpull($columns, 'getProjectPHID');
    $object_phid = $object->getPHID();

    // Note that we may not have an object PHID if we're creating a new
    // object.
551
    $object_phids = array();
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
    if ($object_phid) {
      $object_phids[] = $object_phid;
    }

    if ($object_phids) {
      $layout_engine = id(new PhabricatorBoardLayoutEngine())
        ->setViewer($this->getActor())
        ->setBoardPHIDs($board_phids)
        ->setObjectPHIDs($object_phids)
        ->setFetchAllBoards(true)
        ->executeLayout();
    }

    foreach ($new as $key => $spec) {
      $column_phid = $spec['columnPHID'];
      $column = idx($columns, $column_phid);
      if (!$column) {
        throw new Exception(
          pht(
            'Column move transaction specifies column PHID "%s", but there '.
            'is no corresponding column with this PHID.',
            $column_phid));
      }

      $board_phid = $column->getProjectPHID();

      if ($object_phid) {
        $old_columns = $layout_engine->getObjectColumns(
          $board_phid,
          $object_phid);
        $old_column_phids = mpull($old_columns, 'getPHID');
      } else {
        $old_column_phids = array();
      }

      $spec += array(
        'boardPHID' => $board_phid,
        'fromColumnPHIDs' => $old_column_phids,
      );

      // Check if the object is already in this column, and isn't being moved.
      // We can just drop this column change if it has no effect.
      $from_map = array_fuse($spec['fromColumnPHIDs']);
      $already_here = isset($from_map[$column_phid]);

597
      $is_reordering = ($spec['afterPHIDs'] || $spec['beforePHIDs']);
598
599
600
601
602
603
604
605
606
      if ($already_here && !$is_reordering) {
        unset($new[$key]);
      } else {
        $new[$key] = $spec;
      }
    }

    $new = array_values($new);
    $xaction->setNewValue($new);
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689


    $more = array();

    // If we're moving the object into a column and it does not already belong
    // in the column, add the appropriate board. For normal columns, this
    // is the board PHID. For proxy columns, it is the proxy PHID, unless the
    // object is already a member of some descendant of the proxy PHID.

    // The major case where this can happen is moves via the API, but it also
    // happens when a user drags a task from the "Backlog" to a milestone
    // column.

    if ($object_phid) {
      $current_phids = PhabricatorEdgeQuery::loadDestinationPHIDs(
        $object_phid,
        PhabricatorProjectObjectHasProjectEdgeType::EDGECONST);
      $current_phids = array_fuse($current_phids);
    } else {
      $current_phids = array();
    }

    $add_boards = array();
    foreach ($new as $move) {
      $column_phid = $move['columnPHID'];
      $board_phid = $move['boardPHID'];
      $column = $columns[$column_phid];
      $proxy_phid = $column->getProxyPHID();

      // If this is a normal column, add the board if the object isn't already
      // associated.
      if (!$proxy_phid) {
        if (!isset($current_phids[$board_phid])) {
          $add_boards[] = $board_phid;
        }
        continue;
      }

      // If this is a proxy column but the object is already associated with
      // the proxy board, we don't need to do anything.
      if (isset($current_phids[$proxy_phid])) {
        continue;
      }

      // If this a proxy column and the object is already associated with some
      // descendant of the proxy board, we also don't need to do anything.
      $descendants = id(new PhabricatorProjectQuery())
        ->setViewer(PhabricatorUser::getOmnipotentUser())
        ->withAncestorProjectPHIDs(array($proxy_phid))
        ->execute();

      $found_descendant = false;
      foreach ($descendants as $descendant) {
        if (isset($current_phids[$descendant->getPHID()])) {
          $found_descendant = true;
          break;
        }
      }

      if ($found_descendant) {
        continue;
      }

      // Otherwise, we're moving the object to a proxy column which it is not
      // a member of yet, so add an association to the column's proxy board.

      $add_boards[] = $proxy_phid;
    }

    if ($add_boards) {
      $more[] = id(new ManiphestTransaction())
        ->setTransactionType(PhabricatorTransactions::TYPE_EDGE)
        ->setMetadataValue(
          'edge:type',
          PhabricatorProjectObjectHasProjectEdgeType::EDGECONST)
        ->setIgnoreOnNoEffect(true)
        ->setNewValue(
          array(
            '+' => array_fuse($add_boards),
          ));
    }

    return $more;
690
691
692
693
694
  }

  private function applyBoardMove($object, array $move) {
    $board_phid = $move['boardPHID'];
    $column_phid = $move['columnPHID'];
695
696
697

    $before_phids = $move['beforePHIDs'];
    $after_phids = $move['afterPHIDs'];
698
699
700

    $object_phid = $object->getPHID();

Dmitri Iouchtchenko's avatar
Dmitri Iouchtchenko committed
701
    // We're doing layout with the omnipotent viewer to make sure we don't
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
    // remove positions in columns that exist, but which the actual actor
    // can't see.
    $omnipotent_viewer = PhabricatorUser::getOmnipotentUser();

    $select_phids = array($board_phid);

    $descendants = id(new PhabricatorProjectQuery())
      ->setViewer($omnipotent_viewer)
      ->withAncestorProjectPHIDs($select_phids)
      ->execute();
    foreach ($descendants as $descendant) {
      $select_phids[] = $descendant->getPHID();
    }

    $board_tasks = id(new ManiphestTaskQuery())
      ->setViewer($omnipotent_viewer)
      ->withEdgeLogicPHIDs(
        PhabricatorProjectObjectHasProjectEdgeType::EDGECONST,
        PhabricatorQueryConstraint::OPERATOR_ANCESTOR,
        array($select_phids))
      ->execute();

    $board_tasks = mpull($board_tasks, null, 'getPHID');
    $board_tasks[$object_phid] = $object;

    // Make sure tasks are sorted by ID, so we lay out new positions in
    // a consistent way.
    $board_tasks = msort($board_tasks, 'getID');

    $object_phids = array_keys($board_tasks);

    $engine = id(new PhabricatorBoardLayoutEngine())
      ->setViewer($omnipotent_viewer)
      ->setBoardPHIDs(array($board_phid))
      ->setObjectPHIDs($object_phids)
      ->executeLayout();

    // TODO: This logic needs to be revised when we legitimately support
    // multiple column positions.
    $columns = $engine->getObjectColumns($board_phid, $object_phid);
    foreach ($columns as $column) {
      $engine->queueRemovePosition(
        $board_phid,
        $column->getPHID(),
        $object_phid);
    }

749
750
751
752
753
754
    $engine->queueAddPosition(
      $board_phid,
      $column_phid,
      $object_phid,
      $after_phids,
      $before_phids);
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773

    $engine->applyPositionUpdates();
  }


  private function validateColumnPHID($value) {
    if (phid_get_type($value) == PhabricatorProjectColumnPHIDType::TYPECONST) {
      return;
    }

    throw new Exception(
      pht(
        'When moving objects between columns on a board, columns must '.
        'be identified by PHIDs. This transaction uses "%s" to identify '.
        'a column, but that is not a valid column PHID.',
        $value));
  }


774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
  private function getLockValidationErrors($object, array $xactions) {
    $errors = array();

    $old_owner = $object->getOwnerPHID();
    $old_status = $object->getStatus();

    $new_owner = $old_owner;
    $new_status = $old_status;

    $owner_xaction = null;
    $status_xaction = null;

    foreach ($xactions as $xaction) {
      switch ($xaction->getTransactionType()) {
        case ManiphestTaskOwnerTransaction::TRANSACTIONTYPE:
          $new_owner = $xaction->getNewValue();
          $owner_xaction = $xaction;
          break;
        case ManiphestTaskStatusTransaction::TRANSACTIONTYPE:
          $new_status = $xaction->getNewValue();
          $status_xaction = $xaction;
          break;
      }
    }

    $actor_phid = $this->getActingAsPHID();

    $was_locked = ManiphestTaskStatus::areEditsLockedInStatus(
      $old_status);
    $now_locked = ManiphestTaskStatus::areEditsLockedInStatus(
      $new_status);

    if (!$now_locked) {
      // If we're not ending in an edit-locked status, everything is good.
    } else if ($new_owner !== null) {
      // If we ending the edit with some valid owner, this is allowed for
      // now. We might need to revisit this.
    } else {
      // The edits end with the task locked and unowned. No one will be able
      // to edit it, so we forbid this. We try to be specific about what the
      // user did wrong.

      $owner_changed = ($old_owner && !$new_owner);
      $status_changed = ($was_locked !== $now_locked);
      $message = null;

      if ($status_changed && $owner_changed) {
        $message = pht(
          'You can not lock this task and unassign it at the same time '.
          'because no one will be able to edit it anymore. Lock the task '.
          'or remove the owner, but not both.');
        $problem_xaction = $status_xaction;
      } else if ($status_changed) {
        $message = pht(
          'You can not lock this task because it does not have an owner. '.
          'No one would be able to edit the task. Assign the task to an '.
          'owner before locking it.');
        $problem_xaction = $status_xaction;
      } else if ($owner_changed) {
        $message = pht(
          'You can not remove the owner of this task because it is locked '.
          'and no one would be able to edit the task. Reassign the task or '.
          'unlock it before removing the owner.');
        $problem_xaction = $owner_xaction;
      } else {
        // If the task was already broken, we don't have a transaction to
        // complain about so just let it through. In theory, this is
        // impossible since policy rules should kick in before we get here.
      }

      if ($message) {
        $errors[] = new PhabricatorApplicationTransactionValidationError(
          $problem_xaction->getTransactionType(),
          pht('Lock Error'),
          $message,
          $problem_xaction);
      }
    }

    return $errors;
  }
855

856
857
858
859
860
861
862
863
864
865
866
867
  private function filterValidPHIDs($phid_list, array $object_map) {
    foreach ($phid_list as $key => $phid) {
      if (isset($object_map[$phid])) {
        continue;
      }

      unset($phid_list[$key]);
    }

    return array_values($phid_list);
  }

868
  protected function didApplyTransactions($object, array $xactions) {
869
870
871
872
873
874
875
876
877
878
879
880
881
    $send_notifications = PhabricatorNotificationClient::isEnabled();
    if ($send_notifications) {
      $old_phids = $this->oldProjectPHIDs;
      $new_phids = $this->loadProjectPHIDs($object);

      // We want to emit update notifications for all old and new tagged
      // projects, and all parents of those projects. For example, if an
      // edit removes project "A > B" from a task, the "A" workboard should
      // receive an update event.

      $project_phids = array_fuse($old_phids) + array_fuse($new_phids);
      $project_phids = array_keys($project_phids);

882
883
884
885
886
      if ($project_phids) {
        $projects = id(new PhabricatorProjectQuery())
          ->setViewer(PhabricatorUser::getOmnipotentUser())
          ->withPHIDs($project_phids)
          ->execute();
887

888
889
890
891
892
893
        $notify_projects = array();
        foreach ($projects as $project) {
          $notify_projects[$project->getPHID()] = $project;
          foreach ($project->getAncestorProjects() as $ancestor) {
            $notify_projects[$ancestor->getPHID()] = $ancestor;
          }
894
895
        }

896
897
898
899
        foreach ($notify_projects as $key => $project) {
          if (!$project->getHasWorkboard()) {
            unset($notify_projects[$key]);
          }
900
901
        }

902
        $notify_phids = array_keys($notify_projects);
903

904
905
906
907
908
        if ($notify_phids) {
          $data = array(
            'type' => 'workboards',
            'subscribers' => $notify_phids,
          );
909

910
911
          PhabricatorNotificationClient::tryToPostMessage($data);
        }
912
913
914
915
916
917
918
919
920
921
      }
    }

    return $xactions;
  }

  private function loadProjectPHIDs(ManiphestTask $task) {
    if (!$task->getPHID()) {
      return array();
    }
922
923

    $edge_query = id(new PhabricatorEdgeQuery())
924
      ->withSourcePHIDs(array($task->getPHID()))
925
926
927
928
929
930
931
      ->withEdgeTypes(
        array(
          PhabricatorProjectObjectHasProjectEdgeType::EDGECONST,
        ));

    $edge_query->execute();

932
    return $edge_query->getDestinationPHIDs();
933
934
  }

epriestley's avatar
epriestley committed
935
}