Improve Audit tool filters

Summary: Add more filters/options to the /audit/ interface (By User, By Package, By Project...) Test Plan: Looked at audits via /audit/. Reviewers: btrahan, jungejason Reviewed By: jungejason CC: aran, epriestley Maniphest Tasks: T904 Differential Revision: https://secure.phabricator.com/D1705
2024-09-20 01:08:50 +02:00 · 2012-02-27 19:21:41 -08:00 · 2012-02-27 19:21:41 -08:00 · 67abac5201
commit 67abac5201
parent 37a1db6fe1
5 changed files with 275 additions and 36 deletions
--- a/src/__celerity_resource_map__.php
+++ b/src/__celerity_resource_map__.php
@ -63,7 +63,7 @@ celerity_register_resource_map(array(
  ),
  'aphront-error-view-css' =>
  array(
-    'uri' => '/res/e4c5e4ed/rsrc/css/aphront/error-view.css',
+    'uri' => '/res/038f6022/rsrc/css/aphront/error-view.css',
    'type' => 'css',
    'requires' =>
    array(
--- a/src/applications/audit/controller/list/PhabricatorAuditListController.php
+++ b/src/applications/audit/controller/list/PhabricatorAuditListController.php
@ -20,6 +20,8 @@ final class PhabricatorAuditListController extends PhabricatorAuditController {

  private $filter;

+  private $filterStatus;
+
  public function willProcessRequest(array $data) {
    $this->filter = idx($data, 'filter');
  }
@ -28,45 +30,111 @@ final class PhabricatorAuditListController extends PhabricatorAuditController {
    $request = $this->getRequest();
    $user = $request->getUser();

-    $nav = new AphrontSideNavFilterView();
-    $nav->setBaseURI(new PhutilURI('/audit/view/'));
-    $nav->addLabel('Active');
-    $nav->addFilter('active',  'Need Attention');
-    $nav->addLabel('Audits');
-    $nav->addFilter('all',  'All');
-
-    $this->filter = $nav->selectFilter($this->filter, 'active');
-
-    $pager = new AphrontPagerView();
-    $pager->setURI($request->getRequestURI(), 'offset');
-
-    $query = new PhabricatorAuditQuery();
-    $query->setOffset($pager->getOffset());
-    $query->setLimit($pager->getPageSize() + 1);
-
-    switch ($this->filter) {
-      case 'all':
-        break;
-      case 'active':
-        $phids = PhabricatorAuditCommentEditor::loadAuditPHIDsForUser($user);
-        $query->withAuditorPHIDs($phids);
-        $query->withStatus(PhabricatorAuditQuery::STATUS_OPEN);
-        break;
+    if ($request->isFormPost()) {
+      // If the list filter is POST'd, redirect to GET so the page can be
+      // bookmarked.
+      $uri = $request->getRequestURI();
+      $phid = head($request->getArr('phid'));
+      if ($phid) {
+        $uri = $uri->alter('phid', $phid);
+        return id(new AphrontRedirectResponse())->setURI($uri);
+      }
    }

-    $audits = $query->execute();
-    $audits = $pager->sliceResults($audits);
+    $nav = $this->buildNavAndSelectFilter();
+    $this->filterStatus = $request->getStr('status', 'all');
+    $handle = $this->loadHandle();

-    $view = new PhabricatorAuditListView();
-    $view->setAudits($audits);
+    $nav->appendChild($this->buildListFilters($handle));

-    $phids = $view->getRequiredHandlePHIDs();
-    $handles = id(new PhabricatorObjectHandleData($phids))->loadHandles();
-    $view->setHandles($handles);

-    $panel = new AphrontPanelView();
-    $panel->appendChild($view);
-    $panel->setHeader('Audits');
+    $title = null;
+    $message = null;
+
+    if (!$handle) {
+      switch ($this->filter) {
+        case 'project':
+          $title = 'Choose A Project';
+          $message = 'Choose a project to view audits for.';
+          break;
+        case 'package':
+          $title = 'Choose a Package';
+          $message = 'Choose a package to view audits for.';
+          break;
+      }
+    }
+
+    if (!$message) {
+      $pager = new AphrontPagerView();
+      $pager->setURI($request->getRequestURI(), 'offset');
+
+      $query = new PhabricatorAuditQuery();
+      $query->setOffset($pager->getOffset());
+      $query->setLimit($pager->getPageSize() + 1);
+
+      $phids = null;
+      switch ($this->filter) {
+        case 'user':
+        case 'active':
+          $obj = id(new PhabricatorUser())->loadOneWhere(
+            'phid = %s',
+            $handle->getPHID());
+          if (!$obj) {
+            throw new Exception("Invalid user!");
+          }
+          $phids = PhabricatorAuditCommentEditor::loadAuditPHIDsForUser($obj);
+          break;
+        case 'project':
+        case 'package':
+          $phids = array($handle->getPHID());
+          break;
+        case 'all';
+          break;
+        default:
+          throw new Exception("Unknown filter!");
+      }
+
+      if ($phids) {
+        $query->withAuditorPHIDs($phids);
+      }
+
+      switch ($this->filter) {
+        case 'all':
+        case 'user':
+        case 'project':
+        case 'package':
+          switch ($this->filterStatus) {
+            case 'open':
+              $query->withStatus(PhabricatorAuditQuery::STATUS_OPEN);
+              break;
+          }
+          break;
+        case 'active':
+          $query->withStatus(PhabricatorAuditQuery::STATUS_OPEN);
+          break;
+      }
+
+      $audits = $query->execute();
+      $audits = $pager->sliceResults($audits);
+
+      $view = new PhabricatorAuditListView();
+      $view->setAudits($audits);
+
+      $phids = $view->getRequiredHandlePHIDs();
+      $handles = id(new PhabricatorObjectHandleData($phids))->loadHandles();
+      $view->setHandles($handles);
+
+      $panel = new AphrontPanelView();
+      $panel->appendChild($view);
+      $panel->setHeader('Audits');
+
+    } else {
+      $panel = id(new AphrontErrorView())
+        ->setSeverity(AphrontErrorView::SEVERITY_NODATA)
+        ->setTitle($title)
+        ->appendChild($message);
+      $pager = null;
+    }

    $nav->appendChild($panel);
    $nav->appendChild($pager);
@ -78,4 +146,153 @@ final class PhabricatorAuditListController extends PhabricatorAuditController {
      ));
  }

+  private function buildNavAndSelectFilter() {
+    $nav = new AphrontSideNavFilterView();
+    $nav->setBaseURI(new PhutilURI('/audit/view/'));
+    $nav->addLabel('Active');
+    $nav->addFilter('active',  'Need Attention');
+    $nav->addLabel('Audits');
+    $nav->addFilter('all',  'All');
+    $nav->addFilter('user',  'By User');
+    $nav->addFilter('project',  'By Project');
+    $nav->addFilter('package',  'By Package');
+
+    $this->filter = $nav->selectFilter($this->filter, 'active');
+
+    return $nav;
+  }
+
+  private function buildListFilters(PhabricatorObjectHandle $handle = null) {
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    $form = new AphrontFormView();
+    $form->setUser($user);
+
+    $show_status  = false;
+    $show_user    = false;
+    $show_project = false;
+    $show_package = false;
+
+    switch ($this->filter) {
+      case 'all':
+        $show_status = true;
+        break;
+      case 'active':
+        $show_user = true;
+        break;
+      case 'user':
+        $show_user = true;
+        $show_status = true;
+        break;
+      case 'project':
+        $show_project = true;
+        $show_status = true;
+        break;
+      case 'package':
+        $show_package = true;
+        $show_status = true;
+        break;
+    }
+
+    if ($show_user || $show_project || $show_package) {
+      if ($show_user) {
+        $uri = '/typeahead/common/user/';
+        $label = 'User';
+      } else if ($show_project) {
+        $uri = '/typeahead/common/projects/';
+        $label = 'Project';
+      } else if ($show_package) {
+        $uri = '/typeahead/common/packages/';
+        $label = 'Package';
+      }
+
+      $tok_value = null;
+      if ($handle) {
+        $tok_value = array(
+          $handle->getPHID() => $handle->getFullName(),
+        );
+      }
+
+      $form->appendChild(
+        id(new AphrontFormTokenizerControl())
+          ->setName('phid')
+          ->setLabel($label)
+          ->setLimit(1)
+          ->setDatasource($uri)
+          ->setValue($tok_value));
+    }
+
+    if ($show_status) {
+      $form->appendChild(
+        id(new AphrontFormToggleButtonsControl())
+          ->setName('status')
+          ->setLabel('Status')
+          ->setBaseURI($request->getRequestURI(), 'status')
+          ->setValue($this->filterStatus)
+          ->setButtons(
+            array(
+              'all'   => 'All',
+              'open'  => 'Open',
+            )));
+    }
+
+    $form->appendChild(
+      id(new AphrontFormSubmitControl())
+        ->setValue('Filter Audits'));
+
+    $view = new AphrontListFilterView();
+    $view->appendChild($form);
+    return $view;
+  }
+
+  private function loadHandle() {
+    $request = $this->getRequest();
+
+    $default = null;
+    switch ($this->filter) {
+      case 'user':
+      case 'active':
+        $default = $request->getUser()->getPHID();
+        break;
+    }
+
+    $phid = $request->getStr('phid', $default);
+    if (!$phid) {
+      return null;
+    }
+
+    $phids = array($phid);
+    $handles = id(new PhabricatorObjectHandleData($phids))->loadHandles();
+    $handle = $handles[$phid];
+
+    $this->validateHandle($handle);
+    return $handle;
+  }
+
+  private function validateHandle(PhabricatorObjectHandle $handle) {
+    switch ($this->filter) {
+      case 'active':
+      case 'user':
+        if ($handle->getType() !== PhabricatorPHIDConstants::PHID_TYPE_USER) {
+          throw new Exception("PHID must be a user PHID!");
+        }
+        break;
+      case 'package':
+        if ($handle->getType() !== PhabricatorPHIDConstants::PHID_TYPE_OPKG) {
+          throw new Exception("PHID must be a package PHID!");
+        }
+        break;
+      case 'project':
+        if ($handle->getType() !== PhabricatorPHIDConstants::PHID_TYPE_PROJ) {
+          throw new Exception("PHID must be a project PHID!");
+        }
+        break;
+      case 'all':
+        break;
+      default:
+        throw new Exception("Unknown filter '{$filter}'!");
+    }
+  }
+
 }
--- a/src/applications/audit/controller/list/init.php
+++ b/src/applications/audit/controller/list/init.php
@ -6,12 +6,21 @@



+phutil_require_module('phabricator', 'aphront/response/redirect');
 phutil_require_module('phabricator', 'applications/audit/controller/base');
 phutil_require_module('phabricator', 'applications/audit/editor/comment');
 phutil_require_module('phabricator', 'applications/audit/query/audit');
 phutil_require_module('phabricator', 'applications/audit/view/list');
+phutil_require_module('phabricator', 'applications/people/storage/user');
+phutil_require_module('phabricator', 'applications/phid/constants');
 phutil_require_module('phabricator', 'applications/phid/handle/data');
 phutil_require_module('phabricator', 'view/control/pager');
+phutil_require_module('phabricator', 'view/form/base');
+phutil_require_module('phabricator', 'view/form/control/submit');
+phutil_require_module('phabricator', 'view/form/control/togglebuttons');
+phutil_require_module('phabricator', 'view/form/control/tokenizer');
+phutil_require_module('phabricator', 'view/form/error');
+phutil_require_module('phabricator', 'view/layout/listfilter');
 phutil_require_module('phabricator', 'view/layout/panel');
 phutil_require_module('phabricator', 'view/layout/sidenavfilter');

--- a/src/view/form/error/AphrontErrorView.php
+++ b/src/view/form/error/AphrontErrorView.php
@ -1,7 +1,7 @@
 <?php

 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@ -21,6 +21,7 @@ final class AphrontErrorView extends AphrontView {
  const SEVERITY_ERROR = 'error';
  const SEVERITY_WARNING = 'warning';
  const SEVERITY_NOTICE = 'notice';
+  const SEVERITY_NODATA = 'nodata';

  const WIDTH_DEFAULT = 'default';
  const WIDTH_WIDE = 'wide';
--- a/webroot/rsrc/css/aphront/error-view.css
+++ b/webroot/rsrc/css/aphront/error-view.css
@ -38,3 +38,15 @@
  background: #e3e3ff;
 }

+.aphront-error-severity-nodata {
+  border: 1px solid #dfdfdf;
+  background: #f3f3f3;
+
+  color: #666666;
+
+  -webkit-box-shadow: 0px 0px 0px #000;
+  -mox-box-shadow:    0px 0px 0px #000;
+  box-shadow:         0px 0px 0px #000;
+
+}
+