Partially clean up Phriction document status constants; introduce "phriction.document.search"

Summary:
Depends on D19098. Ref T13077.

Phriction status constants currently use the "bag of statuses" approach typical of older code, and store integers in the database.

This fixes the "bag of statuses" stuff; a future change will fix the integers.

Also adds a skeleton for `phriction.document.search`, but doesn't implement the Conduit interface yet.

Test Plan: Searched for documents with various status constraints. Grepped for removed status constants. Viewed document list.

Maniphest Tasks: T13077

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

src/__phutil_library_map__.php

···
     'PhrictionDocumentPHIDType' => 'applications/phriction/phid/PhrictionDocumentPHIDType.php',
     'PhrictionDocumentPathHeraldField' => 'applications/phriction/herald/PhrictionDocumentPathHeraldField.php',
     'PhrictionDocumentQuery' => 'applications/phriction/query/PhrictionDocumentQuery.php',
+    'PhrictionDocumentSearchConduitAPIMethod' => 'applications/phriction/conduit/PhrictionDocumentSearchConduitAPIMethod.php',
+    'PhrictionDocumentSearchEngine' => 'applications/phriction/query/PhrictionDocumentSearchEngine.php',
     'PhrictionDocumentStatus' => 'applications/phriction/constants/PhrictionDocumentStatus.php',
     'PhrictionDocumentTitleHeraldField' => 'applications/phriction/herald/PhrictionDocumentTitleHeraldField.php',
     'PhrictionDocumentTitleTransaction' => 'applications/phriction/xaction/PhrictionDocumentTitleTransaction.php',
···
     'PhrictionRemarkupRule' => 'applications/phriction/markup/PhrictionRemarkupRule.php',
     'PhrictionReplyHandler' => 'applications/phriction/mail/PhrictionReplyHandler.php',
     'PhrictionSchemaSpec' => 'applications/phriction/storage/PhrictionSchemaSpec.php',
-    'PhrictionSearchEngine' => 'applications/phriction/query/PhrictionSearchEngine.php',
     'PhrictionTransaction' => 'applications/phriction/storage/PhrictionTransaction.php',
     'PhrictionTransactionComment' => 'applications/phriction/storage/PhrictionTransactionComment.php',
     'PhrictionTransactionEditor' => 'applications/phriction/editor/PhrictionTransactionEditor.php',
···
     'PhrictionDocumentPHIDType' => 'PhabricatorPHIDType',
     'PhrictionDocumentPathHeraldField' => 'PhrictionDocumentHeraldField',
     'PhrictionDocumentQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
-    'PhrictionDocumentStatus' => 'PhrictionConstants',
+    'PhrictionDocumentSearchConduitAPIMethod' => 'PhabricatorSearchEngineAPIMethod',
+    'PhrictionDocumentSearchEngine' => 'PhabricatorApplicationSearchEngine',
+    'PhrictionDocumentStatus' => 'PhabricatorObjectStatus',
     'PhrictionDocumentTitleHeraldField' => 'PhrictionDocumentHeraldField',
     'PhrictionDocumentTitleTransaction' => 'PhrictionDocumentTransactionType',
     'PhrictionDocumentTransactionType' => 'PhabricatorModularTransactionType',
···
     'PhrictionRemarkupRule' => 'PhutilRemarkupRule',
     'PhrictionReplyHandler' => 'PhabricatorApplicationTransactionReplyHandler',
     'PhrictionSchemaSpec' => 'PhabricatorConfigSchemaSpec',
-    'PhrictionSearchEngine' => 'PhabricatorApplicationSearchEngine',
     'PhrictionTransaction' => 'PhabricatorModularTransaction',
     'PhrictionTransactionComment' => 'PhabricatorApplicationTransactionComment',
     'PhrictionTransactionEditor' => 'PhabricatorApplicationTransactionEditor',

src/applications/phriction/conduit/PhrictionDocumentSearchConduitAPIMethod.php

···
+<?php
+
+final class PhrictionDocumentSearchConduitAPIMethod
+  extends PhabricatorSearchEngineAPIMethod {
+
+  public function getAPIMethodName() {
+    return 'phriction.document.search';
+  }
+
+  public function newSearchEngine() {
+    return new PhrictionDocumentSearchEngine();
+  }
+
+  public function getMethodSummary() {
+    return pht('Read information about Phriction documents.');
+  }
+
+}

src/applications/phriction/constants/PhrictionDocumentStatus.php

···
 <?php
 
-final class PhrictionDocumentStatus extends PhrictionConstants {
+final class PhrictionDocumentStatus
+  extends PhabricatorObjectStatus {
 
   const STATUS_EXISTS     = 0;
   const STATUS_DELETED    = 1;
···
     return idx($map, $const, 'unknown');
   }
 
+  public static function newStatusObject($key) {
+    return new self($key, id(new self())->getStatusSpecification($key));
+  }
+
+  public static function getStatusMap() {
+    $map = id(new self())->getStatusSpecifications();
+    return ipull($map, 'name', 'key');
+  }
+
+  public function isActive() {
+    return ($this->getKey() == self::STATUS_EXISTS);
+  }
+
+  protected function newStatusSpecifications() {
+    return array(
+      array(
+        'key' => self::STATUS_EXISTS,
+        'name' => pht('Active'),
+        'icon' => 'fa-file-text-o',
+        'color' => 'bluegrey',
+      ),
+      array(
+        'key' => self::STATUS_DELETED,
+        'name' => pht('Deleted'),
+        'icon' => 'fa-file-text-o',
+        'color' => 'grey',
+      ),
+      array(
+        'key' => self::STATUS_MOVED,
+        'name' => pht('Moved'),
+        'icon' => 'fa-arrow-right',
+        'color' => 'grey',
+      ),
+      array(
+        'key' => self::STATUS_STUB,
+        'name' => pht('Stub'),
+        'icon' => 'fa-file-text-o',
+        'color' => 'grey',
+      ),
+    );
+  }
 }

src/applications/phriction/controller/PhrictionController.php

···
       $nav->addFilter('/phriction/', pht('Index'));
     }
 
-    id(new PhrictionSearchEngine())
+    id(new PhrictionDocumentSearchEngine())
       ->setViewer($user)
       ->addNavigationItems($nav->getMenu());
 

src/applications/phriction/controller/PhrictionListController.php

···
 
     $controller = id(new PhabricatorApplicationSearchController())
       ->setQueryKey($querykey)
-      ->setSearchEngine(new PhrictionSearchEngine())
+      ->setSearchEngine(new PhrictionDocumentSearchEngine())
       ->setNavigation($this->buildSideNavView());
 
     return $this->delegateToController($controller);

src/applications/phriction/query/PhrictionDocumentQuery.php

···
 
   private $needContent;
 
-  private $status       = 'status-any';
-  const STATUS_ANY      = 'status-any';
-  const STATUS_OPEN     = 'status-open';
-  const STATUS_NONSTUB  = 'status-nonstub';
-
-  const ORDER_HIERARCHY = 'order-hierarchy';
+  const ORDER_HIERARCHY = 'hierarchy';
 
   public function withIDs(array $ids) {
     $this->ids = $ids;
···
 
   public function withStatuses(array $statuses) {
     $this->statuses = $statuses;
-    return $this;
-  }
-
-  public function withStatus($status) {
-    $this->status = $status;
     return $this;
   }
 
···
         $this->depths);
     }
 
-    switch ($this->status) {
-      case self::STATUS_OPEN:
-        $where[] = qsprintf(
-          $conn,
-          'd.status NOT IN (%Ld)',
-          array(
-            PhrictionDocumentStatus::STATUS_DELETED,
-            PhrictionDocumentStatus::STATUS_MOVED,
-            PhrictionDocumentStatus::STATUS_STUB,
-          ));
-        break;
-      case self::STATUS_NONSTUB:
-        $where[] = qsprintf(
-          $conn,
-          'd.status NOT IN (%Ld)',
-          array(
-            PhrictionDocumentStatus::STATUS_MOVED,
-            PhrictionDocumentStatus::STATUS_STUB,
-          ));
-        break;
-      case self::STATUS_ANY:
-        break;
-      default:
-        throw new Exception(pht("Unknown status '%s'!", $this->status));
-    }
-
     return $where;
   }
 
   public function getBuiltinOrders() {
-    return array(
+    return parent::getBuiltinOrders() + array(
       self::ORDER_HIERARCHY => array(
         'vector' => array('depth', 'title', 'updated'),
         'name' => pht('Hierarchy'),
       ),
-    ) + parent::getBuiltinOrders();
+    );
   }
 
   public function getOrderableColumns() {

src/applications/phriction/query/PhrictionSearchEngine.php src/applications/phriction/query/PhrictionDocumentSearchEngine.php

···
 <?php
 
-final class PhrictionSearchEngine
+final class PhrictionDocumentSearchEngine
   extends PhabricatorApplicationSearchEngine {
 
   public function getResultTypeDescription() {
···
 
   public function newQuery() {
     return id(new PhrictionDocumentQuery())
-      ->needContent(true)
-      ->withStatus(PhrictionDocumentQuery::STATUS_NONSTUB);
+      ->needContent(true);
   }
 
   protected function buildQueryFromParameters(array $map) {
     $query = $this->newQuery();
 
-    if ($map['status']) {
-      $query->withStatus($map['status']);
+    if ($map['statuses']) {
+      $query->withStatuses($map['statuses']);
     }
 
     return $query;
···
 
   protected function buildCustomSearchFields() {
     return array(
-      id(new PhabricatorSearchSelectField())
-        ->setKey('status')
+      id(new PhabricatorSearchCheckboxesField())
+        ->setKey('statuses')
         ->setLabel(pht('Status'))
-        ->setOptions($this->getStatusOptions()),
+        ->setOptions(PhrictionDocumentStatus::getStatusMap()),
     );
   }
 
···
         return $query;
       case 'active':
         return $query->setParameter(
-          'status', PhrictionDocumentQuery::STATUS_OPEN);
+          'statuses',
+          array(
+            PhrictionDocumentStatus::STATUS_EXISTS,
+          ));
     }
 
     return parent::buildSavedQueryFromBuiltin($query_key);
   }
 
-  private function getStatusOptions() {
-    return array(
-      PhrictionDocumentQuery::STATUS_OPEN => pht('Show Active Documents'),
-      PhrictionDocumentQuery::STATUS_NONSTUB => pht('Show All Documents'),
-    );
-  }
-
   protected function getRequiredHandlePHIDsForResultList(
     array $documents,
     PhabricatorSavedQuery $query) {
···
 
       $item->addAttribute($slug_uri);
 
-      switch ($document->getStatus()) {
-        case PhrictionDocumentStatus::STATUS_DELETED:
-          $item->setDisabled(true);
-          $item->addIcon('delete', pht('Deleted'));
-          break;
-        case PhrictionDocumentStatus::STATUS_MOVED:
-          $item->setDisabled(true);
-          $item->addIcon('arrow-right', pht('Moved Away'));
-          break;
+      $icon = $document->getStatusIcon();
+      $color = $document->getStatusColor();
+      $label = $document->getStatusDisplayName();
+
+      $item->setStatusIcon("{$icon} {$color}", $label);
+
+      if (!$document->isActive()) {
+        $item->setDisabled(true);
       }
 
       $list->addItem($item);

src/applications/phriction/search/PhrictionDocumentFerretEngine.php

···
   }
 
   public function newSearchEngine() {
-    return new PhrictionSearchEngine();
+    return new PhrictionDocumentSearchEngine();
   }
 
 }

src/applications/phriction/storage/PhrictionDocument.php

···
     return $this;
   }
 
+/* -(  Status  )------------------------------------------------------------- */
+
+
+  public function getStatusObject() {
+    return PhrictionDocumentStatus::newStatusObject($this->getStatus());
+  }
+
+  public function getStatusIcon() {
+    return $this->getStatusObject()->getIcon();
+  }
+
+  public function getStatusColor() {
+    return $this->getStatusObject()->getColor();
+  }
+
+  public function getStatusDisplayName() {
+    return $this->getStatusObject()->getDisplayName();
+  }
+
+  public function isActive() {
+    return $this->getStatusObject()->isActive();
+  }
+
 
 /* -(  PhabricatorPolicyInterface  )----------------------------------------- */