Implement ApplicationSearch in Files

Summary: Ref T2625. Ref T1163. A couple of small generalization nudges, but this is almost entirely straightforward.

Test Plan: Executed various File queries.

Reviewers: btrahan

Reviewed By: btrahan

CC: aran

Maniphest Tasks: T1163, T2625

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

resources/sql/patches/20130531.filekeys.sql

···
+ALTER TABLE {$NAMESPACE}_file.file
+  ADD KEY `key_dateCreated` (dateCreated);

src/__phutil_library_map__.php

···
     'PhabricatorFileLinkView' => 'view/layout/PhabricatorFileLinkView.php',
     'PhabricatorFileListController' => 'applications/files/controller/PhabricatorFileListController.php',
     'PhabricatorFileQuery' => 'applications/files/query/PhabricatorFileQuery.php',
+    'PhabricatorFileSearchEngine' => 'applications/files/query/PhabricatorFileSearchEngine.php',
     'PhabricatorFileShortcutController' => 'applications/files/controller/PhabricatorFileShortcutController.php',
     'PhabricatorFileStorageBlob' => 'applications/files/storage/PhabricatorFileStorageBlob.php',
     'PhabricatorFileStorageConfigurationException' => 'applications/files/exception/PhabricatorFileStorageConfigurationException.php',
···
     'PhabricatorFileInfoController' => 'PhabricatorFileController',
     'PhabricatorFileLinkListView' => 'AphrontView',
     'PhabricatorFileLinkView' => 'AphrontView',
-    'PhabricatorFileListController' => 'PhabricatorFileController',
+    'PhabricatorFileListController' =>
+    array(
+      0 => 'PhabricatorFileController',
+      1 => 'PhabricatorApplicationSearchResultsControllerInterface',
+    ),
     'PhabricatorFileQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
+    'PhabricatorFileSearchEngine' => 'PhabricatorApplicationSearchEngine',
     'PhabricatorFileShortcutController' => 'PhabricatorFileController',
     'PhabricatorFileStorageBlob' => 'PhabricatorFileDAO',
     'PhabricatorFileStorageConfigurationException' => 'Exception',

src/applications/files/application/PhabricatorApplicationFiles.php

···
     return array(
       '/F(?P<id>[1-9]\d*)' => 'PhabricatorFileShortcutController',
       '/file/' => array(
-        '' => 'PhabricatorFileListController',
-        'filter/(?P<filter>\w+)/' => 'PhabricatorFileListController',
+        '(query/(?P<key>[^/]+)/)?' => 'PhabricatorFileListController',
         'upload/' => 'PhabricatorFileUploadController',
         'dropupload/' => 'PhabricatorFileDropUploadController',
         'delete/(?P<id>[1-9]\d*)/' => 'PhabricatorFileDeleteController',

src/applications/files/controller/PhabricatorFileController.php

···
       $menu->newLink(pht('Upload File'), $this->getApplicationURI('/upload/'));
     }
 
-    $menu->newLabel(pht('Filters'));
-
-    $menu->newLink(pht('My Files'), $this->getApplicationURI('filter/my/'))
-      ->setKey('my');
-
-    $menu->newLink(pht('All Files'), $this->getApplicationURI('filter/all/'))
-      ->setKey('all');
+    id(new PhabricatorFileSearchEngine())
+      ->setViewer($this->getRequest()->getUser())
+      ->addNavigationItems($menu);
 
     return $menu;
   }

src/applications/files/controller/PhabricatorFileListController.php

···
 <?php
 
-final class PhabricatorFileListController extends PhabricatorFileController {
-
-  private $filter;
+final class PhabricatorFileListController extends PhabricatorFileController
+  implements PhabricatorApplicationSearchResultsControllerInterface {
 
-  private function setFilter($filter) {
-    $this->filter = $filter;
-    return $this;
-  }
+  private $key;
 
-  private function getFilter() {
-    return $this->filter;
+  public function shouldAllowPublic() {
+    return true;
   }
 
   public function willProcessRequest(array $data) {
-    $this->setFilter(idx($data, 'filter', 'my'));
+    $this->key = idx($data, 'key', 'authored');
   }
 
   public function processRequest() {
     $request = $this->getRequest();
-    $user = $request->getUser();
+    $controller = id(new PhabricatorApplicationSearchController($request))
+      ->setQueryKey($this->key)
+      ->setSearchEngine(new PhabricatorFileSearchEngine())
+      ->setNavigation($this->buildSideNavView());
 
-    $pager = id(new AphrontCursorPagerView())
-      ->readFromRequest($request);
+    return $this->delegateToController($controller);
+  }
 
-    $query = id(new PhabricatorFileQuery())
-      ->setViewer($user);
+  public function renderResultsList(array $files) {
+    assert_instances_of($files, 'PhabricatorFile');
 
-    switch ($this->getFilter()) {
-      case 'my':
-        $query->withAuthorPHIDs(array($user->getPHID()));
-        $query->showOnlyExplicitUploads(true);
-        $header = pht('Files You Uploaded');
-        break;
-      case 'all':
-      default:
-        $header = pht('All Files');
-        break;
-    }
+    $request = $this->getRequest();
+    $user = $request->getUser();
 
-    $files = $query->executeWithCursorPager($pager);
+    $highlighted_ids = $request->getStrList('h');
     $this->loadHandles(mpull($files, 'getAuthorPHID'));
-
-    $highlighted = $request->getStrList('h');
-    $file_list = $this->buildFileList($files, $highlighted);
-
-    $side_nav = $this->buildSideNavView();
-    $side_nav->selectFilter($this->getFilter());
-
-    $side_nav->appendChild(
-      array(
-        $file_list,
-        $pager,
-        new PhabricatorGlobalUploadTargetView(),
-      ));
-
-    $side_nav->setCrumbs(
-      $this
-        ->buildApplicationCrumbs()
-        ->addCrumb(
-          id(new PhabricatorCrumbView())
-            ->setName($header)
-            ->setHref($request->getRequestURI())));
-
-    return $this->buildApplicationPage(
-      $side_nav,
-      array(
-        'title' => 'Files',
-        'device' => true,
-        'dust' => true,
-      ));
-  }
-
-  private function buildFileList(array $files, array $highlighted_ids) {
-    assert_instances_of($files, 'PhabricatorFile');
 
     $request = $this->getRequest();
     $user = $request->getUser();
···
 
       $list_view->addItem($item);
     }
+
+    $list_view->appendChild(new PhabricatorGlobalUploadTargetView());
 
     return $list_view;
   }

src/applications/files/query/PhabricatorFileQuery.php

···
   private $authorPHIDs;
   private $explicitUploads;
   private $transforms;
+  private $dateCreatedAfter;
+  private $dateCreatedBefore;
 
   public function withIDs(array $ids) {
     $this->ids = $ids;
···
 
   public function withAuthorPHIDs(array $phids) {
     $this->authorPHIDs = $phids;
+    return $this;
+  }
+
+  public function withDateCreatedBefore($date_created_before) {
+    $this->dateCreatedBefore = $date_created_before;
+    return $this;
+  }
+
+  public function withDateCreatedAfter($date_created_after) {
+    $this->dateCreatedAfter = $date_created_after;
     return $this;
   }
 
···
         }
       }
       $where[] = qsprintf($conn_r, '(%Q)', implode(') OR (', $clauses));
+    }
+
+    if ($this->dateCreatedAfter) {
+      $where[] = qsprintf(
+        $conn_r,
+        'f.dateCreated >= %d',
+        $this->dateCreatedAfter);
+    }
+
+    if ($this->dateCreatedBefore) {
+      $where[] = qsprintf(
+        $conn_r,
+        'f.dateCreated <= %d',
+        $this->dateCreatedBefore);
     }
 
     return $this->formatWhereClause($where);

src/applications/files/query/PhabricatorFileSearchEngine.php

···
+<?php
+
+final class PhabricatorFileSearchEngine
+  extends PhabricatorApplicationSearchEngine {
+
+  public function buildSavedQueryFromRequest(AphrontRequest $request) {
+    $saved = new PhabricatorSavedQuery();
+    $saved->setParameter(
+      'authorPHIDs',
+      array_values($request->getArr('authors')));
+
+    $saved->setParameter('explicit', $request->getBool('explicit'));
+    $saved->setParameter('createdStart', $request->getStr('createdStart'));
+    $saved->setParameter('createdEnd', $request->getStr('createdEnd'));
+
+    return $saved;
+  }
+
+  public function buildQueryFromSavedQuery(PhabricatorSavedQuery $saved) {
+    $query = id(new PhabricatorFileQuery())
+      ->withAuthorPHIDs($saved->getParameter('authorPHIDs', array()));
+
+    if ($saved->getParameter('explicit')) {
+      $query->showOnlyExplicitUploads(true);
+    }
+
+    $start = $this->parseDateTime($saved->getParameter('createdStart'));
+    $end = $this->parseDateTime($saved->getParameter('createdEnd'));
+
+    if ($start) {
+      $query->withDateCreatedAfter($start);
+    }
+
+    if ($end) {
+      $query->withDateCreatedBefore($end);
+    }
+
+    return $query;
+  }
+
+  public function buildSearchForm(
+    AphrontFormView $form,
+    PhabricatorSavedQuery $saved_query) {
+
+    $phids = $saved_query->getParameter('authorPHIDs', array());
+    $handles = id(new PhabricatorObjectHandleData($phids))
+      ->setViewer($this->requireViewer())
+      ->loadHandles();
+    $author_tokens = mpull($handles, 'getFullName', 'getPHID');
+
+    $explicit = $saved_query->getParameter('explicit');
+
+    $form
+      ->appendChild(
+        id(new AphrontFormTokenizerControl())
+          ->setDatasource('/typeahead/common/users/')
+          ->setName('authors')
+          ->setLabel(pht('Authors'))
+          ->setValue($author_tokens))
+      ->appendChild(
+        id(new AphrontFormCheckboxControl())
+          ->addCheckbox(
+            'explicit',
+            1,
+            pht('Show only manually uploaded files.'),
+            $explicit));
+
+    $this->buildDateRange(
+      $form,
+      $saved_query,
+      'createdStart',
+      pht('Created After'),
+      'createdEnd',
+      pht('Created Before'));
+  }
+
+  protected function getURI($path) {
+    return '/file/'.$path;
+  }
+
+  public function getBuiltinQueryNames() {
+    $names = array();
+
+    if ($this->requireViewer()->isLoggedIn()) {
+      $names['authored'] = pht('Authored');
+    }
+
+    $names += array(
+      'all'     => pht('All'),
+    );
+
+    return $names;
+  }
+
+  public function buildSavedQueryFromBuiltin($query_key) {
+
+    $query = $this->newSavedQuery();
+    $query->setQueryKey($query_key);
+
+    switch ($query_key) {
+      case 'all':
+        return $query;
+      case 'authored':
+        $author_phid = array($this->requireViewer()->getPHID());
+        return $query
+          ->setParameter('authorPHIDs', $author_phid)
+          ->setParameter('explicit', true);
+    }
+
+    return parent::buildSavedQueryFromBuiltin($query_key);
+  }
+
+}

src/applications/macro/controller/PhabricatorMacroController.php

···
 
     id(new PhabricatorMacroSearchEngine())
       ->setViewer($this->getRequest()->getUser())
-      ->addNavigationItems($nav);
+      ->addNavigationItems($nav->getMenu());
 
     return $nav;
   }

src/applications/paste/controller/PhabricatorPasteController.php

···
 
     id(new PhabricatorPasteSearchEngine())
       ->setViewer($user)
-      ->addNavigationItems($nav);
+      ->addNavigationItems($nav->getMenu());
 
     $nav->selectFilter(null);
 

src/applications/search/engine/PhabricatorApplicationSearchEngine.php

···
   }
 
 
-  public function addNavigationItems(AphrontSideNavFilterView $nav) {
+  public function addNavigationItems(PhabricatorMenuView $menu) {
     $viewer = $this->requireViewer();
 
-    $nav->addLabel(pht('Queries'));
+    $menu->newLabel(pht('Queries'));
 
     $named_queries = id(new PhabricatorNamedQueryQuery())
       ->setViewer($viewer)
···
     foreach ($named_queries as $query) {
       $key = $query->getQueryKey();
       $uri = $this->getQueryResultsPageURI($key);
-      $nav->addFilter('query/'.$key, $query->getQueryName(), $uri);
+      $menu->newLink($query->getQueryName(), $uri, 'query/'.$key);
     }
 
     $manage_uri = $this->getQueryManagementURI();
-    $nav->addFilter('query/edit', pht('Edit Queries...'), $manage_uri);
+    $menu->newLink(pht('Edit Queries...'), $manage_uri, 'query/edit');
 
-    $nav->addLabel(pht('Search'));
+    $menu->newLabel(pht('Search'));
     $advanced_uri = $this->getQueryResultsPageURI('advanced');
-    $nav->addFilter('query/advanced', pht('Advanced Search'), $advanced_uri);
+    $menu->newLink(pht('Advanced Search'), $advanced_uri, 'query/advanced');
 
     return $this;
   }

src/infrastructure/storage/patch/PhabricatorBuiltinPatchList.php

···
         'type' => 'sql',
         'name' => $this->getPatchPath('20130530.pastekeys.sql'),
       ),
+      '20130531.filekeys.sql' => array(
+        'type' => 'sql',
+        'name' => $this->getPatchPath('20130531.filekeys.sql'),
+      ),
     );
   }
 }

src/view/layout/PhabricatorObjectItemListView.php

···
         $header,
         $items,
         $pager,
+        $this->renderChildren(),
       ));
   }