phorge / src / applications / feed / query / PhabricatorFeedTransactionQuery.php

<?php

final class PhabricatorFeedTransactionQuery
  extends PhabricatorCursorPagedPolicyAwareQuery {

  private $phids;
  private $authorPHIDs;
  private $objectTypes;
  private $objectPHIDs;
  private $createdMin;
  private $createdMax;

  public function withPHIDs(array $phids) {
    $this->phids = $phids;
    return $this;
  }

  public function withAuthorPHIDs(array $phids) {
    $this->authorPHIDs = $phids;
    return $this;
  }

  public function withObjectTypes(array $types) {
    $this->objectTypes = $types;
    return $this;
  }

  public function withObjectPHIDs(array $object_phids) {
    $this->objectPHIDs = $object_phids;
    return $this;
  }

  public function withDateCreatedBetween($min, $max) {
    $this->createdMin = $min;
    $this->createdMax = $max;
    return $this;
  }

  public function newResultObject() {
    // Return an arbitrary valid transaction object. The actual query may
    // return objects of any subclass of "ApplicationTransaction" when it is
    // executed, but we need to pick something concrete here to make some
    // integrations work (like automatic handling of PHIDs in data export).
    return new PhabricatorUserTransaction();
  }

  protected function loadPage() {
    $this->normalizeObjectPHIDs();
    $queries = $this->newTransactionQueries();

    $xactions = array();

    if ($this->shouldLimitResults()) {
      $limit = $this->getRawResultLimit();
      if (!$limit) {
        $limit = null;
      }
    } else {
      $limit = null;
    }

    // We're doing a bit of manual work to get paging working, because this
    // query aggregates the results of a large number of subqueries.

    // Overall, we're ordering transactions by "<dateCreated, phid>". Ordering
    // by PHID is not very meaningful, but we don't need the ordering to be
    // especially meaningful, just consistent. Using PHIDs is easy and does
    // everything we need it to technically.

    // To actually configure paging, if we have an external cursor, we load
    // the internal cursor first. Then we pass it to each subquery and the
    // subqueries pretend they just loaded a page where it was the last object.
    // This configures their queries properly and we can aggregate a cohesive
    // set of results by combining all the queries.

    $cursor = $this->getExternalCursorString();
    if ($cursor !== null) {
      $cursor_object = $this->newInternalCursorFromExternalCursor($cursor);
    } else {
      $cursor_object = null;
    }

    $is_reversed = $this->getIsQueryOrderReversed();

    $created_min = $this->createdMin;
    $created_max = $this->createdMax;

    $xaction_phids = $this->phids;
    $author_phids = $this->authorPHIDs;
    $object_phids = $this->objectPHIDs;

    foreach ($queries as $query) {
      $query->withDateCreatedBetween($created_min, $created_max);

      if ($xaction_phids !== null) {
        $query->withPHIDs($xaction_phids);
      }

      if ($author_phids !== null) {
        $query->withAuthorPHIDs($author_phids);
      }

      if ($object_phids !== null) {
        $query->withObjectPHIDs($object_phids);
      }

      if ($limit !== null) {
        $query->setLimit($limit);
      }

      if ($cursor_object !== null) {
        $query
          ->setAggregatePagingCursor($cursor_object)
          ->setIsQueryOrderReversed($is_reversed);
      }

      $query->setOrder('global');

      $query_xactions = $query->execute();
      foreach ($query_xactions as $query_xaction) {
        $xactions[] = $query_xaction;
      }

      $xactions = msortv($xactions, 'newGlobalSortVector');
      if ($is_reversed) {
        $xactions = array_reverse($xactions);
      }

      if ($limit !== null) {
        $xactions = array_slice($xactions, 0, $limit);

        // If we've found enough transactions to fill up the entire requested
        // page size, we can narrow the search window: transactions after the
        // last transaction we've found so far can't possibly be part of the
        // result set.

        if (count($xactions) === $limit) {
          $last_date = last($xactions)->getDateCreated();
          if ($is_reversed) {
            if ($created_max === null) {
              $created_max = $last_date;
            } else {
              $created_max = min($created_max, $last_date);
            }
          } else {
            if ($created_min === null) {
              $created_min = $last_date;
            } else {
              $created_min = max($created_min, $last_date);
            }
          }
        }
      }
    }

    return $xactions;
  }

  public function getQueryApplicationClass() {
    return PhabricatorFeedApplication::class;
  }

  private function newTransactionQueries() {
    $viewer = $this->getViewer();

    $queries = id(new PhutilClassMapQuery())
      ->setAncestorClass(PhabricatorApplicationTransactionQuery::class)
      ->execute();

    // Remove TransactionQuery classes of disabled apps. Increases query
    // performance and decreases likeliness of a "Query Overheated" error if
    // an app got disabled so data in it cannot be accessed anymore anyway.
    // See https://secure.phabricator.com/T13133, https://we.phorge.it/T15642
    foreach ($queries as $key => $query) {
      $app = $query->getQueryApplicationClass();
      if ($app !== null &&
          !PhabricatorApplication::isClassInstalledForViewer($app, $viewer)) {
        unset($queries[$key]);
      }
    }

    $type_map = array();

    // If we're querying for specific transaction PHIDs, we only need to
    // consider queries which may load transactions with subtypes present
    // in the list.

    // For example, if we're loading Maniphest Task transaction PHIDs, we know
    // we only have to look at Maniphest Task transactions, since other types
    // of objects will never have the right transaction PHIDs.

    $xaction_phids = $this->phids;
    if ($xaction_phids) {
      foreach ($xaction_phids as $xaction_phid) {
        $type_map[phid_get_subtype($xaction_phid)] = true;
      }
    }

    $object_types = $this->objectTypes;
    if ($object_types) {
      $object_types = array_fuse($object_types);
    }

    $results = array();
    foreach ($queries as $query) {
      $query_type = $query->getTemplateApplicationTransaction()
        ->getApplicationTransactionType();

      if ($type_map) {
        if (!isset($type_map[$query_type])) {
          continue;
        }
      }

      if ($object_types) {
        if (!isset($object_types[$query_type])) {
          continue;
        }
      }

      $results[] = id(clone $query)
        ->setViewer($viewer)
        ->setParentQuery($this);
    }

    return $results;
  }

  protected function newExternalCursorStringForResult($object) {
    return (string)$object->getPHID();
  }

  protected function applyExternalCursorConstraintsToQuery(
    PhabricatorCursorPagedPolicyAwareQuery $subquery,
    $cursor) {

    $subquery->withPHIDs(array($cursor));
  }

  private function normalizeObjectPHIDs() {
    if (!$this->objectPHIDs) {
      return;
    }

    $have_non_phids = false;
    foreach ($this->objectPHIDs as $name) {
      if (strncmp($name, 'PHID-', 5)) {
        $have_non_phids = true;
        break;
      }
    }

    if ($have_non_phids) {

      // "Names" field in ObjectQuery also handles PHIDs.
      $objects = id(new PhabricatorObjectQuery())
        ->setViewer($this->getViewer())
        ->withNames($this->objectPHIDs)
        ->execute();

      if (!$objects) {
        // nothing resolved to anything.
        throw new PhabricatorSearchConstraintException(
          pht("objectPHID inputs didn't match any known objects."));
      }

      $phids = mpull($objects, 'getPHID');

    } else {
      $phids = $this->objectPHIDs;
    }

    $phid_types = array();
    foreach ($phids as $phid) {
      $phid_type = phid_get_type($phid);
      $phid_types[$phid_type] = $phid_type;
    }

    $this->objectPHIDs = $phids;
    $this->objectTypes = $phid_types;
  }

}