phorge-phorge/src/applications/maniphest/storage/ManiphestTask.php

<?php

/**
 * @group maniphest
 */
final class ManiphestTask extends ManiphestDAO
  implements
    PhabricatorMarkupInterface,
    PhabricatorPolicyInterface,
    PhabricatorTokenReceiverInterface,
    PhrequentTrackableInterface {

  const MARKUP_FIELD_DESCRIPTION = 'markup:desc';

  protected $phid;
  protected $authorPHID;
  protected $ownerPHID;
  protected $ccPHIDs = array();

  protected $status;
  protected $priority;
  protected $subpriority;

  protected $title;
  protected $originalTitle;
  protected $description;
  protected $originalEmailSource;
  protected $mailKey;

  protected $attached = array();
  protected $projectPHIDs = array();
  private $projectsNeedUpdate;
  private $subscribersNeedUpdate;

  protected $ownerOrdering;

  private $auxiliaryAttributes = self::ATTACHABLE;
  private $auxiliaryDirty = array();
  private $groupByProjectPHID = self::ATTACHABLE;

  public function getConfiguration() {
    return array(
      self::CONFIG_AUX_PHID => true,
      self::CONFIG_SERIALIZATION => array(
        'ccPHIDs' => self::SERIALIZATION_JSON,
        'attached' => self::SERIALIZATION_JSON,
        'projectPHIDs' => self::SERIALIZATION_JSON,
      ),
    ) + parent::getConfiguration();
  }

  public function loadDependsOnTaskPHIDs() {
    return PhabricatorEdgeQuery::loadDestinationPHIDs(
      $this->getPHID(),
      PhabricatorEdgeConfig::TYPE_TASK_DEPENDS_ON_TASK);
  }

  public function loadDependedOnByTaskPHIDs() {
    return PhabricatorEdgeQuery::loadDestinationPHIDs(
      $this->getPHID(),
      PhabricatorEdgeConfig::TYPE_TASK_DEPENDED_ON_BY_TASK);
  }

  public function getAttachedPHIDs($type) {
    return array_keys(idx($this->attached, $type, array()));
  }

  public function generatePHID() {
    return PhabricatorPHID::generateNewPHID(ManiphestPHIDTypeTask::TYPECONST);
  }

  public function getCCPHIDs() {
    return array_values(nonempty($this->ccPHIDs, array()));
  }

  public function setProjectPHIDs(array $phids) {
    $this->projectPHIDs = array_values($phids);
    $this->projectsNeedUpdate = true;
    return $this;
  }

  public function getProjectPHIDs() {
    return array_values(nonempty($this->projectPHIDs, array()));
  }

  public function setCCPHIDs(array $phids) {
    $this->ccPHIDs = array_values($phids);
    $this->subscribersNeedUpdate = true;
    return $this;
  }

  public function setOwnerPHID($phid) {
    $this->ownerPHID = nonempty($phid, null);
    $this->subscribersNeedUpdate = true;
    return $this;
  }

  public function getAuxiliaryAttribute($key, $default = null) {
    $this->assertAttached($this->auxiliaryAttributes);
    return idx($this->auxiliaryAttributes, $key, $default);
  }

  public function setAuxiliaryAttribute($key, $val) {
    $this->assertAttached($this->auxiliaryAttributes);

    $this->auxiliaryAttributes[$key] = $val;
    $this->auxiliaryDirty[$key] = true;
    return $this;
  }

  public function setTitle($title) {
    $this->title = $title;
    if (!$this->getID()) {
      $this->originalTitle = $title;
    }
    return $this;
  }

  public function attachGroupByProjectPHID($phid) {
    $this->groupByProjectPHID = $phid;
    return $this;
  }

  public function getGroupByProjectPHID() {
    return $this->assertAttached($this->groupByProjectPHID);
  }

  public function attachAuxiliaryAttributes(array $attrs) {
    if ($this->auxiliaryDirty) {
      throw new Exception(
        "This object has dirty attributes, you can not attach new attributes ".
        "without writing or discarding the dirty attributes.");
    }
    $this->auxiliaryAttributes = $attrs;
    return $this;
  }

  public function loadAndAttachAuxiliaryAttributes() {
    if (!$this->getPHID()) {
      $this->auxiliaryAttributes = array();
      return $this;
    }

    $storage = id(new ManiphestTaskAuxiliaryStorage())->loadAllWhere(
      'taskPHID = %s',
      $this->getPHID());

    $this->auxiliaryAttributes = mpull($storage, 'getValue', 'getName');

    return $this;
  }

  public function save() {
    if (!$this->mailKey) {
      $this->mailKey = Filesystem::readRandomCharacters(20);
    }

    $result = parent::save();

    if ($this->projectsNeedUpdate) {
      // If we've changed the project PHIDs for this task, update the link
      // table.
      ManiphestTaskProject::updateTaskProjects($this);
      $this->projectsNeedUpdate = false;
    }

    if ($this->subscribersNeedUpdate) {
      // If we've changed the subscriber PHIDs for this task, update the link
      // table.
      ManiphestTaskSubscriber::updateTaskSubscribers($this);
      $this->subscribersNeedUpdate = false;
    }

    if ($this->auxiliaryDirty) {
      $this->writeAuxiliaryUpdates();
      $this->auxiliaryDirty = array();
    }

    return $result;
  }

  private function writeAuxiliaryUpdates() {
    $table = new ManiphestTaskAuxiliaryStorage();
    $conn_w = $table->establishConnection('w');
    $update = array();
    $remove = array();

    foreach ($this->auxiliaryDirty as $key => $dirty) {
      $value = $this->getAuxiliaryAttribute($key);
      if ($value === null) {
        $remove[$key] = true;
      } else {
        $update[$key] = $value;
      }
    }

    if ($remove) {
      queryfx(
        $conn_w,
        'DELETE FROM %T WHERE taskPHID = %s AND name IN (%Ls)',
        $table->getTableName(),
        $this->getPHID(),
        array_keys($remove));
    }

    if ($update) {
      $sql = array();
      foreach ($update as $key => $val) {
        $sql[] = qsprintf(
          $conn_w,
          '(%s, %s, %s, %d, %d)',
          $this->getPHID(),
          $key,
          $val,
          time(),
          time());
      }
      queryfx(
        $conn_w,
        'INSERT INTO %T (taskPHID, name, value, dateCreated, dateModified)
          VALUES %Q ON DUPLICATE KEY
          UPDATE value = VALUES(value), dateModified = VALUES(dateModified)',
        $table->getTableName(),
        implode(', ', $sql));
    }
  }


/* -(  Markup Interface  )--------------------------------------------------- */


  /**
   * @task markup
   */
  public function getMarkupFieldKey($field) {
    $hash = PhabricatorHash::digest($this->getMarkupText($field));
    $id = $this->getID();
    return "maniphest:T{$id}:{$field}:{$hash}";
  }


  /**
   * @task markup
   */
  public function getMarkupText($field) {
    return $this->getDescription();
  }


  /**
   * @task markup
   */
  public function newMarkupEngine($field) {
    return PhabricatorMarkupEngine::newManiphestMarkupEngine();
  }


  /**
   * @task markup
   */
  public function didMarkupText(
    $field,
    $output,
    PhutilMarkupEngine $engine) {
    return $output;
  }


  /**
   * @task markup
   */
  public function shouldUseMarkupCache($field) {
    return (bool)$this->getID();
  }


/* -(  Policy Interface  )--------------------------------------------------- */


  public function getCapabilities() {
    return array(
      PhabricatorPolicyCapability::CAN_VIEW,
      PhabricatorPolicyCapability::CAN_EDIT,
    );
  }

  public function getPolicy($capability) {
    return PhabricatorPolicies::POLICY_USER;
  }

  public function hasAutomaticCapability($capability, PhabricatorUser $user) {
    return false;
  }


/* -(  PhabricatorTokenReceiverInterface  )---------------------------------- */

  public function getUsersToNotifyOfTokenGiven() {
    // Sort of ambiguous who this was intended for; just let them both know.
    return array_filter(
      array_unique(
        array(
          $this->getAuthorPHID(),
          $this->getOwnerPHID(),
        )));
  }

}