Make Subscribers automatically provide working SearchFields

Summary:
Ref T8441. Ref T7715. For modern Query classes, automatically make subscriber queries and SearchField integrations work.

In particular, we can just drive this query with EdgeLogic and don't need to do anything specific on these Query classes beyond making sure they're implemented in a way that picks up all of the EdgeLogic clauses.

Test Plan:
  - Searched for subscribers in Pholio, Files, Paste, and Projects.
  - Searched for all other fields in Projects to check that Query changes are OK.

Reviewers: btrahan

Reviewed By: btrahan

Subscribers: epriestley

Maniphest Tasks: T7715, T8441

Differential Revision: https://secure.phabricator.com/D13191

src/__phutil_library_map__.php

@@ -2529,6 +2529,7 @@ phutil_register_library_map(array(
     'PhabricatorSearchSelectField' => 'applications/search/field/PhabricatorSearchSelectField.php',
     'PhabricatorSearchSpacesField' => 'applications/search/field/PhabricatorSearchSpacesField.php',
     'PhabricatorSearchStringListField' => 'applications/search/field/PhabricatorSearchStringListField.php',
+    'PhabricatorSearchSubscribersField' => 'applications/search/field/PhabricatorSearchSubscribersField.php',
     'PhabricatorSearchTextField' => 'applications/search/field/PhabricatorSearchTextField.php',
     'PhabricatorSearchThreeStateField' => 'applications/search/field/PhabricatorSearchThreeStateField.php',
     'PhabricatorSearchTokenizerField' => 'applications/search/field/PhabricatorSearchTokenizerField.php',
@@ -6031,6 +6032,7 @@ phutil_register_library_map(array(
     'PhabricatorSearchSelectField' => 'PhabricatorSearchField',
     'PhabricatorSearchSpacesField' => 'PhabricatorSearchTokenizerField',
     'PhabricatorSearchStringListField' => 'PhabricatorSearchField',
+    'PhabricatorSearchSubscribersField' => 'PhabricatorSearchTokenizerField',
     'PhabricatorSearchTextField' => 'PhabricatorSearchField',
     'PhabricatorSearchThreeStateField' => 'PhabricatorSearchField',
     'PhabricatorSearchTokenizerField' => 'PhabricatorSearchField',

src/applications/files/query/PhabricatorFileSearchEngine.php

@@ -37,6 +37,14 @@ final class PhabricatorFileSearchEngine
     );
   }
 
+  protected function getDefaultFieldOrder() {
+    return array(
+      '...',
+      'createdStart',
+      'createdEnd',
+    );
+  }
+
   public function buildQueryFromParameters(array $map) {
     $query = id(new PhabricatorFileQuery());
 

src/applications/paste/query/PhabricatorPasteSearchEngine.php

@@ -56,6 +56,14 @@ final class PhabricatorPasteSearchEngine
     );
   }
 
+  protected function getDefaultFieldOrder() {
+    return array(
+      '...',
+      'createdStart',
+      'createdEnd',
+    );
+  }
+
   protected function getURI($path) {
     return '/paste/'.$path;
   }

src/applications/project/query/PhabricatorProjectQuery.php

@@ -120,29 +120,7 @@ final class PhabricatorProjectQuery
 
   protected function loadPage() {
     $table = new PhabricatorProject();
-    $conn_r = $table->establishConnection('r');
+    $data = $this->loadStandardPageRows($table);
-
-    // NOTE: Because visibility checks for projects depend on whether or not
-    // the user is a project member, we always load their membership. If we're
-    // loading all members anyway we can piggyback on that; otherwise we
-    // do an explicit join.
-
-    $select_clause = '';
-    if (!$this->needMembers) {
-      $select_clause = ', vm.dst viewerIsMember';
-    }
-
-    $data = queryfx_all(
-      $conn_r,
-      'SELECT p.* %Q FROM %T p %Q %Q %Q %Q %Q',
-      $select_clause,
-      $table->getTableName(),
-      $this->buildJoinClause($conn_r),
-      $this->buildWhereClause($conn_r),
-      $this->buildGroupClause($conn_r),
-      $this->buildOrderClause($conn_r),
-      $this->buildLimitClause($conn_r));
-
     $projects = $table->loadAllFromArray($data);
 
     if ($projects) {
@@ -240,8 +218,22 @@ final class PhabricatorProjectQuery
     return $projects;
   }
 
-  protected function buildWhereClause(AphrontDatabaseConnection $conn_r) {
+  protected function buildSelectClauseParts(AphrontDatabaseConnection $conn) {
-    $where = array();
+    $select = parent::buildSelectClauseParts($conn);
+
+    // NOTE: Because visibility checks for projects depend on whether or not
+    // the user is a project member, we always load their membership. If we're
+    // loading all members anyway we can piggyback on that; otherwise we
+    // do an explicit join.
+    if (!$this->needMembers) {
+      $select[] = 'vm.dst viewerIsMember';
+    }
+
+    return $select;
+  }
+
+  protected function buildWhereClauseParts(AphrontDatabaseConnection $conn) {
+    $where = parent::buildWhereClauseParts($conn);
 
     if ($this->status != self::STATUS_ANY) {
       switch ($this->status) {
@@ -264,86 +256,83 @@ final class PhabricatorProjectQuery
               $this->status));
       }
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'status IN (%Ld)',
         $filter);
     }
 
     if ($this->ids !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'id IN (%Ld)',
         $this->ids);
     }
 
     if ($this->phids !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'phid IN (%Ls)',
         $this->phids);
     }
 
     if ($this->memberPHIDs !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'e.dst IN (%Ls)',
         $this->memberPHIDs);
     }
 
     if ($this->slugs !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'slug.slug IN (%Ls)',
         $this->slugs);
     }
 
     if ($this->phrictionSlugs !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'phrictionSlug IN (%Ls)',
         $this->phrictionSlugs);
     }
 
     if ($this->names !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'name IN (%Ls)',
         $this->names);
     }
 
     if ($this->icons !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'icon IN (%Ls)',
         $this->icons);
     }
 
     if ($this->colors !== null) {
       $where[] = qsprintf(
-        $conn_r,
+        $conn,
         'color IN (%Ls)',
         $this->colors);
     }
 
-    $where[] = $this->buildPagingClause($conn_r);
+    return $where;
-
-    return $this->formatWhereClause($where);
   }
 
-  protected function buildGroupClause(AphrontDatabaseConnection $conn_r) {
+  protected function shouldGroupQueryResultRows() {
     if ($this->memberPHIDs || $this->nameTokens) {
-      return 'GROUP BY p.id';
+      return true;
-    } else {
-      return $this->buildApplicationSearchGroupClause($conn_r);
     }
+    return parent::shouldGroupQueryResultRows();
   }
 
-  protected function buildJoinClause(AphrontDatabaseConnection $conn_r) {
+  protected function buildJoinClauseParts(AphrontDatabaseConnection $conn) {
-    $joins = array();
+    $joins = parent::buildJoinClauseParts($conn);
 
     if (!$this->needMembers !== null) {
       $joins[] = qsprintf(
-        $conn_r,
+        $conn,
         'LEFT JOIN %T vm ON vm.src = p.phid AND vm.type = %d AND vm.dst = %s',
         PhabricatorEdgeConfig::TABLE_NAME_EDGE,
         PhabricatorProjectProjectHasMemberEdgeType::EDGECONST,
@@ -352,7 +341,7 @@ final class PhabricatorProjectQuery
 
     if ($this->memberPHIDs !== null) {
       $joins[] = qsprintf(
-        $conn_r,
+        $conn,
         'JOIN %T e ON e.src = p.phid AND e.type = %d',
         PhabricatorEdgeConfig::TABLE_NAME_EDGE,
         PhabricatorProjectProjectHasMemberEdgeType::EDGECONST);
@@ -360,7 +349,7 @@ final class PhabricatorProjectQuery
 
     if ($this->slugs !== null) {
       $joins[] = qsprintf(
-        $conn_r,
+        $conn,
         'JOIN %T slug on slug.projectPHID = p.phid',
         id(new PhabricatorProjectSlug())->getTableName());
     }
@@ -369,7 +358,7 @@ final class PhabricatorProjectQuery
       foreach ($this->nameTokens as $key => $token) {
         $token_table = 'token_'.$key;
         $joins[] = qsprintf(
-          $conn_r,
+          $conn,
           'JOIN %T %T ON %T.projectID = p.id AND %T.token LIKE %>',
           PhabricatorProject::TABLE_DATASOURCE_TOKEN,
           $token_table,
@@ -379,9 +368,7 @@ final class PhabricatorProjectQuery
       }
     }
 
-    $joins[] = $this->buildApplicationSearchJoinClause($conn_r);
+    return $joins;
-
-    return implode(' ', $joins);
   }
 
   public function getQueryApplicationClass() {

src/applications/search/engine/PhabricatorApplicationSearchEngine.php

@@ -113,6 +113,15 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
       return $query;
     }
 
+    if ($object instanceof PhabricatorSubscribableInterface) {
+      if (!empty($parameters['subscriberPHIDs'])) {
+        $query->withEdgeLogicPHIDs(
+          PhabricatorObjectHasSubscriberEdgeType::EDGECONST,
+          PhabricatorQueryConstraint::OPERATOR_OR,
+          $parameters['subscriberPHIDs']);
+      }
+    }
+
     if ($object instanceof PhabricatorProjectInterface) {
       if (!empty($parameters['projectPHIDs'])) {
         $query->withEdgeLogicConstraints(
@@ -180,6 +189,13 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
       return $fields;
     }
 
+    if ($object instanceof PhabricatorSubscribableInterface) {
+      $fields[] = id(new PhabricatorSearchSubscribersField())
+        ->setLabel(pht('Subscribers'))
+        ->setKey('subscriberPHIDs')
+        ->setAliases(array('subscriber', 'subscribers'));
+    }
+
     if ($object instanceof PhabricatorProjectInterface) {
       $fields[] = id(new PhabricatorSearchProjectsField())
         ->setKey('projectPHIDs')

src/applications/search/field/PhabricatorSearchSubscribersField.php

@@ -0,0 +1,21 @@
+<?php
+
+final class PhabricatorSearchSubscribersField
+  extends PhabricatorSearchTokenizerField {
+
+  protected function getDefaultValue() {
+    return array();
+  }
+
+  protected function getValueFromRequest(AphrontRequest $request, $key) {
+    $allow_types = array(
+      PhabricatorProjectProjectPHIDType::TYPECONST,
+    );
+    return $this->getUsersFromRequest($request, $key, $allow_types);
+  }
+
+  protected function newDatasource() {
+    return new PhabricatorMetaMTAMailableFunctionDatasource();
+  }
+
+}

src/applications/search/field/PhabricatorSearchTokenizerField.php

@@ -26,9 +26,11 @@ abstract class PhabricatorSearchTokenizerField
   abstract protected function newDatasource();
 
 
-  protected function getUsersFromRequest(AphrontRequest $request, $key) {
+  protected function getUsersFromRequest(
+    AphrontRequest $request,
+    $key,
+    array $allow_types = array()) {
     $list = $this->getListFromRequest($request, $key);
-    $allow_types = array();
 
     $phids = array();
     $names = array();

src/infrastructure/query/policy/PhabricatorCursorPagedPolicyAwareQuery.php

@@ -76,7 +76,12 @@ abstract class PhabricatorCursorPagedPolicyAwareQuery
     return $this->beforeID;
   }
 
-  public function loadStandardPage(PhabricatorLiskDAO $table) {
+  protected function loadStandardPage(PhabricatorLiskDAO $table) {
+    $rows = $this->loadStandardPageRows($table);
+    return $table->loadAllFromArray($rows);
+  }
+
+  protected function loadStandardPageRows(PhabricatorLiskDAO $table) {
     $conn = $table->establishConnection('r');
 
     $rows = queryfx_all(
@@ -92,7 +97,7 @@ abstract class PhabricatorCursorPagedPolicyAwareQuery
       $this->buildOrderClause($conn),
       $this->buildLimitClause($conn));
 
-    return $table->loadAllFromArray($rows);
+    return $rows;
   }
 
   /**