Add ability to name saved queries.

Summary: Can name saved queries.

Test Plan: Try naming some saved queries using the form.

Reviewers: epriestley

CC: aran, Korvin, AnhNhan

Maniphest Tasks: T2625

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

Conflicts:

src/infrastructure/storage/patch/PhabricatorBuiltinPatchList.php

resources/sql/patches/20130508.search_namedquery.sql

···
+CREATE TABLE {$NAMESPACE}_search.search_namedquery (
+  id INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+  userPHID VARCHAR(64) NOT NULL COLLATE utf8_bin,
+  engineClassName VARCHAR(128) NOT NULL COLLATE utf8_bin,
+  queryName VARCHAR(255) NOT NULL COLLATE utf8_bin,
+  queryKey VARCHAR(12) NOT NULL COLLATE utf8_bin,
+  dateCreated INT(10) UNSIGNED NOT NULL,
+  dateModified INT(10) UNSIGNED NOT NULL,
+  UNIQUE KEY `key_userquery` (userPHID, engineClassName, queryKey),
+  PRIMARY KEY(id)
+)
+ENGINE=InnoDB, COLLATE utf8_general_ci

src/__phutil_library_map__.php

···
     'PhabricatorMustVerifyEmailController' => 'applications/auth/controller/PhabricatorMustVerifyEmailController.php',
     'PhabricatorMySQLConfigOptions' => 'applications/config/option/PhabricatorMySQLConfigOptions.php',
     'PhabricatorMySQLFileStorageEngine' => 'applications/files/engine/PhabricatorMySQLFileStorageEngine.php',
+    'PhabricatorNamedQuery' => 'applications/search/storage/PhabricatorNamedQuery.php',
     'PhabricatorNoteExample' => 'applications/uiexample/examples/PhabricatorNoteExample.php',
     'PhabricatorNotificationBuilder' => 'applications/notification/builder/PhabricatorNotificationBuilder.php',
     'PhabricatorNotificationClearController' => 'applications/notification/controller/PhabricatorNotificationClearController.php',
···
     'PhabricatorPasteDAO' => 'applications/paste/storage/PhabricatorPasteDAO.php',
     'PhabricatorPasteEditController' => 'applications/paste/controller/PhabricatorPasteEditController.php',
     'PhabricatorPasteListController' => 'applications/paste/controller/PhabricatorPasteListController.php',
+    'PhabricatorPasteQueriesController' => 'applications/paste/controller/PhabricatorPasteQueriesController.php',
     'PhabricatorPasteQuery' => 'applications/paste/query/PhabricatorPasteQuery.php',
     'PhabricatorPasteRemarkupRule' => 'applications/paste/remarkup/PhabricatorPasteRemarkupRule.php',
     'PhabricatorPasteSearchEngine' => 'applications/paste/query/PhabricatorPasteSearchEngine.php',
···
     'PhabricatorSearchIndexer' => 'applications/search/index/PhabricatorSearchIndexer.php',
     'PhabricatorSearchManagementIndexWorkflow' => 'applications/search/management/PhabricatorSearchManagementIndexWorkflow.php',
     'PhabricatorSearchManagementWorkflow' => 'applications/search/management/PhabricatorSearchManagementWorkflow.php',
+    'PhabricatorSearchNameController' => 'applications/search/controller/PhabricatorSearchNameController.php',
     'PhabricatorSearchQuery' => 'applications/search/storage/PhabricatorSearchQuery.php',
     'PhabricatorSearchRelationship' => 'applications/search/constants/PhabricatorSearchRelationship.php',
     'PhabricatorSearchResultView' => 'applications/search/view/PhabricatorSearchResultView.php',
···
     'PhabricatorMustVerifyEmailController' => 'PhabricatorAuthController',
     'PhabricatorMySQLConfigOptions' => 'PhabricatorApplicationConfigOptions',
     'PhabricatorMySQLFileStorageEngine' => 'PhabricatorFileStorageEngine',
+    'PhabricatorNamedQuery' => 'PhabricatorSearchDAO',
     'PhabricatorNoteExample' => 'PhabricatorUIExample',
     'PhabricatorNotificationClearController' => 'PhabricatorNotificationController',
     'PhabricatorNotificationConfigOptions' => 'PhabricatorApplicationConfigOptions',
···
     'PhabricatorPasteDAO' => 'PhabricatorLiskDAO',
     'PhabricatorPasteEditController' => 'PhabricatorPasteController',
     'PhabricatorPasteListController' => 'PhabricatorPasteController',
+    'PhabricatorPasteQueriesController' => 'PhabricatorPasteController',
     'PhabricatorPasteQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
     'PhabricatorPasteRemarkupRule' => 'PhabricatorRemarkupRuleObject',
     'PhabricatorPasteSearchEngine' => 'PhabricatorApplicationSearchEngine',
···
     'PhabricatorSearchHovercardController' => 'PhabricatorSearchBaseController',
     'PhabricatorSearchManagementIndexWorkflow' => 'PhabricatorSearchManagementWorkflow',
     'PhabricatorSearchManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorSearchNameController' => 'PhabricatorSearchBaseController',
     'PhabricatorSearchQuery' => 'PhabricatorSearchDAO',
     'PhabricatorSearchResultView' => 'AphrontView',
     'PhabricatorSearchSelectController' => 'PhabricatorSearchBaseController',
···
     'ReleephBranchEditor' => 'PhabricatorEditor',
     'ReleephBranchNamePreviewController' => 'PhabricatorController',
     'ReleephBranchPreviewView' => 'AphrontFormControl',
+    'ReleephBranchTemplate' => 'PhabricatorMarkupInterface',
     'ReleephBranchViewController' => 'ReleephController',
     'ReleephCommitFinderException' => 'Exception',
     'ReleephCommitMessageFieldSpecification' => 'ReleephFieldSpecification',

src/applications/paste/application/PhabricatorApplicationPaste.php

···
         'edit/(?P<id>[1-9]\d*)/'  => 'PhabricatorPasteEditController',
         'filter/(?P<filter>\w+)/' => 'PhabricatorPasteListController',
         'query/(?P<queryKey>\w+)/'=> 'PhabricatorPasteListController',
+        'savedqueries/'           => 'PhabricatorPasteQueriesController',
       ),
     );
   }

src/applications/paste/controller/PhabricatorPasteController.php

···
     if ($user->isLoggedIn()) {
       $nav->addFilter('my', pht('My Pastes'));
     }
+
+    $nav->addLabel(pht('Search'));
     $nav->addFilter('advanced', pht('Advanced Search'));
+    $nav->addFilter('', pht('Saved Queries'),
+      $this->getApplicationURI('/savedqueries/'));
 
     $nav->selectFilter($filter, 'all');
 

src/applications/paste/controller/PhabricatorPasteQueriesController.php

···
+<?php
+
+final class PhabricatorPasteQueriesController
+  extends PhabricatorPasteController {
+
+  public function processRequest() {
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    $nav = $this->buildSideNavView("");
+    $filter = $nav->getSelectedFilter();
+
+    $table = new PhabricatorNamedQuery();
+    $conn = $table->establishConnection('r');
+    $data = queryfx_all(
+      $conn,
+      'SELECT * FROM %T WHERE userPHID=%s AND engineClassName=%s',
+      $table->getTableName(),
+      $user->getPHID(),
+      'PhabricatorPasteSearchEngine');
+
+    $list = new PhabricatorObjectItemListView();
+    $list->setUser($user);
+
+    foreach ($data as $key => $saved_query) {
+      $date_created = phabricator_datetime($saved_query["dateCreated"], $user);
+      $item = id(new PhabricatorObjectItemView())
+        ->setHeader($saved_query["queryName"])
+        ->setHref('/paste/query/'.$saved_query["queryKey"].'/')
+        ->addByline(pht('Date Created: ').$date_created);
+      $list->addItem($item);
+    }
+
+    $pager = new AphrontCursorPagerView();
+    $pager->readFromRequest($request);
+
+    $list->setPager($pager);
+
+    $list->setNoDataString(pht("No results found for this query."));
+
+    $nav->appendChild(
+      array(
+        $list,
+      ));
+
+    $crumbs = $this
+      ->buildApplicationCrumbs($nav)
+      ->addCrumb(
+        id(new PhabricatorCrumbView())
+          ->setName(pht("Saved Queries"))
+          ->setHref($this->getApplicationURI('/savedqueries/')));
+
+    $nav->setCrumbs($crumbs);
+
+    return $this->buildApplicationPage(
+      $nav,
+      array(
+        'title' => pht("Saved Queries"),
+        'device' => true,
+        'dust' => true,
+      ));
+  }
+
+}

src/applications/paste/query/PhabricatorPasteSearchEngine.php

···
 
     $form->appendChild(
       id(new AphrontFormSubmitControl())
-        ->setValue(pht('Filter Pastes')));
+      ->setValue(pht('Filter Pastes'))
+      ->addCancelButton(
+        '/search/name/'.$saved_query->getQueryKey().'/',
+        pht('Save Custom Query...')));
 
     return $form;
   }

src/applications/search/application/PhabricatorApplicationSearch.php

···
         'index/(?P<phid>[^/]+)/' => 'PhabricatorSearchIndexController',
         'hovercard/(?P<mode>retrieve|test)/' =>
           'PhabricatorSearchHovercardController',
-      ),
+        'name/(?P<queryKey>\w+)/' => 'PhabricatorSearchNameController',
+        ),
     );
   }
 

src/applications/search/controller/PhabricatorSearchNameController.php

···
+<?php
+
+/**
+ * @group search
+ */
+final class PhabricatorSearchNameController
+  extends PhabricatorSearchBaseController {
+
+  private $queryKey;
+
+  public function willProcessRequest(array $data) {
+    $this->queryKey = idx($data, 'queryKey');
+  }
+
+  public function processRequest() {
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    if ($this->queryKey) {
+      $saved_query = id(new PhabricatorSavedQuery())->loadOneWhere(
+        'queryKey = %s',
+        $this->queryKey);
+      if (!$saved_query) {
+        return new Aphront404Response();
+      }
+    } else {
+      return new Aphront404Response();
+    }
+
+    if ($request->isFormPost()) {
+      $request_data = $request->getRequestData();
+
+      $named_query = id(new PhabricatorNamedQuery())
+        ->setUserPHID($user->getPHID())
+        ->setQueryKey($saved_query->getQueryKey())
+        ->setQueryName($request_data["set_name"])
+        ->setEngineClassName($saved_query->getEngineClassName());
+
+      try {
+        $named_query->save();
+      } catch (AphrontQueryDuplicateKeyException $ex) {
+        // Ignore, the user is naming an identical query.
+      }
+
+      return id(new AphrontRedirectResponse())
+        ->setURI('/search/');
+    }
+
+    $form = id(new AphrontFormView())
+      ->setUser($user);
+
+    $form->appendChild(
+      id(new AphrontFormTextControl())
+        ->setName('set_name')
+        ->setLabel(pht('Query Name')));
+
+    $form->appendChild(
+      id(new AphrontFormSubmitControl())
+        ->setValue(pht('Save')));
+
+    return $this->buildStandardPageResponse(
+      array(
+        $form,
+      ),
+      array(
+        'title' => 'Name Query',
+      ));
+  }
+
+
+}

src/applications/search/storage/PhabricatorNamedQuery.php

···
+<?php
+
+/**
+ * @group search
+ */
+final class PhabricatorNamedQuery extends PhabricatorSearchDAO {
+
+  protected $queryKey = "";
+  protected $queryName = "";
+  protected $userPHID = "";
+  protected $engineClassName = "";
+
+}

src/infrastructure/storage/patch/PhabricatorBuiltinPatchList.php

···
         'type' => 'php',
         'name' => $this->getPatchPath('20130507.releephrqmailkeypop.php'),
       ),
+      '20130508.search_namedquery.sql' => array(
+        'type' => 'sql',
+        'name' => $this->getPatchPath('20130508.search_namedquery.sql'),
+      ),
     );
   }
 }