Explain policy exception rules to users

Summary: Ref T603. Adds clarifying text which expands on policies and explains exceptions and rules. The goal is to provide an easy way for users to learn about special policy rules, like "task owners can always see a task". This presentation might be a little aggressive. That's probably OK as we introduce policies, but something a little more tempered might be better down the road. Test Plan: See screenshot. Reviewers: btrahan, chad Reviewed By: chad CC: aran Maniphest Tasks: T603 Differential Revision: https://secure.phabricator.com/D7150
2013-09-27 08:43:41 -07:00
parent e0f99484ac
commit 2e5ac128b3
63 changed files with 565 additions and 56 deletions
--- a/src/applications/policy/controller/PhabricatorPolicyExplainController.php
+++ b/src/applications/policy/controller/PhabricatorPolicyExplainController.php
@@ -0,0 +1,73 @@
+<?php
+
+final class PhabricatorPolicyExplainController
+  extends PhabricatorPolicyController {
+
+  private $phid;
+  private $capability;
+
+  public function shouldAllowPublic() {
+    return true;
+  }
+
+  public function willProcessRequest(array $data) {
+    $this->phid = $data['phid'];
+    $this->capability = $data['capability'];
+  }
+
+  public function processRequest() {
+    $request = $this->getRequest();
+    $viewer = $request->getUser();
+
+    $phid = $this->phid;
+    $capability = $this->capability;
+
+    $object = id(new PhabricatorObjectQuery())
+      ->setViewer($viewer)
+      ->withPHIDs(array($phid))
+      ->executeOne();
+    if (!$object) {
+      return new Aphront404Response();
+    }
+
+    $policies = PhabricatorPolicyQuery::loadPolicies(
+      $viewer,
+      $object);
+
+    $policy = idx($policies, $capability);
+    if (!$policy) {
+      return new Aphront404Response();
+    }
+
+    $handle = id(new PhabricatorHandleQuery())
+      ->setViewer($viewer)
+      ->withPHIDs(array($phid))
+      ->executeOne();
+    $object_uri = $handle->getURI();
+
+    $explanation = $policy->getExplanation($capability);
+    $auto_info = (array)$object->describeAutomaticCapability($capability);
+
+    foreach ($auto_info as $key => $info) {
+      $auto_info[$key] = phutil_tag('li', array(), $info);
+    }
+    if ($auto_info) {
+      $auto_info = phutil_tag('ul', array(), $auto_info);
+    }
+
+    $content = array(
+      $explanation,
+      $auto_info,
+    );
+
+    $dialog = id(new AphrontDialogView())
+      ->setUser($viewer)
+      ->setClass('aphront-access-dialog')
+      ->setTitle(pht('Policy Details'))
+      ->appendChild($content)
+      ->addCancelButton($object_uri, pht('Done'));
+
+    return id(new AphrontDialogResponse())->setDialog($dialog);
+  }
+
+}