Start of a config web interface.

Summary: This is somewhat clowny, particularly in how it handles JSON encode/decode, but I've commented why I did things the way I did. The goal is to store minified JSON but show pretty-printed JSON where possible, to the user editing it. Test Plan: * Went to /config/ and saw a list of keys from the `default` config. * Clicked on one of them, submitted the default value successfully. * Changed the value to invalid JSON and got a decent error. * Changed the value to valid JSON and checked the DB to confirm it saved. * Confirmed the DB values were minified. * Confirmed the user-facing values were pretty-printed where they could be. * Confirmed that PHIDs were getting assigned properly and that isDeleted properly defaulted to false/0. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T2246 Differential Revision: https://secure.phabricator.com/D4290
2012-12-27 15:20:09 -08:00
parent 1e2dfb5b6b
commit a774620042
11 changed files with 352 additions and 0 deletions
--- a/src/applications/config/controller/PhabricatorConfigEditController.php
+++ b/src/applications/config/controller/PhabricatorConfigEditController.php
@@ -0,0 +1,124 @@
+<?php
+
+final class PhabricatorConfigEditController
+  extends PhabricatorConfigController {
+
+  private $key;
+
+  public function willProcessRequest(array $data) {
+    $this->key = idx($data, 'key');
+  }
+
+  public function processRequest() {
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    $config = id(new PhabricatorConfigFileSource('default'))
+      ->getAllKeys();
+    if (!$this->key || !array_key_exists($this->key, $config)) {
+      return new Aphront404Response();
+    }
+
+    // Check if the config key is already stored in the database.
+    // Grab the value if it is.
+    $value = null;
+    $config_entry = id(new PhabricatorConfigEntry())
+      ->loadOneWhere(
+        'configKey = %s AND namespace=%s',
+        $this->key,
+        'default');
+    if ($config_entry) {
+      $value = $config_entry->getValue();
+    } else {
+      $config_entry = id(new PhabricatorConfigEntry())
+        ->setConfigKey($this->key);
+    }
+
+    $e_value = null;
+    $errors = array();
+    if ($request->isFormPost()) {
+      $new_value = $request->getStr('value');
+      if (strlen($new_value)) {
+        $json = json_decode($new_value, true);
+        if ($json === null && strtolower($value) != 'null') {
+          $e_value = 'Invalid';
+          $errors[] = 'The given value must be valid JSON. This means, among '.
+            'other things, that you must wrap strings in double-quotes.';
+          $value = $new_value;
+        } else {
+          $value = $json;
+        }
+      } else {
+        // TODO: When we do Transactions, make this just set isDeleted = 1
+        $config_entry->delete();
+      }
+
+      $config_entry->setValue($value);
+      $config_entry->setNamespace('default');
+
+      if (!$errors) {
+        $config_entry->save();
+        return id(new AphrontRedirectResponse())
+          ->setURI($config_entry->getURI());
+      }
+    }
+
+    $form = new AphrontFormView();
+    $form->setFlexible(true);
+
+    $error_view = null;
+    if ($errors) {
+      $error_view = id(new AphrontErrorView())
+        ->setTitle('You broke everything!')
+        ->setErrors($errors);
+    } else {
+      // Check not only that it's an array, but that it's an "unnatural" array
+      // meaning that the keys aren't 0 -> size_of_array.
+      if (is_array($value) &&
+        array_keys($value) != range(0, count($value) - 1)) {
+        $value = id(new PhutilJSON())->encodeFormatted($value);
+      } else {
+        $value = json_encode($value);
+      }
+    }
+
+    $form
+      ->setUser($user)
+      ->appendChild(
+        id(new AphrontFormTextAreaControl())
+          ->setLabel('JSON Value')
+          ->setError($e_value)
+          ->setValue($value)
+          ->setHeight(AphrontFormTextAreaControl::HEIGHT_VERY_TALL)
+          ->setCustomClass('PhabricatorMonospaced')
+          ->setName('value'))
+      ->appendChild(
+        id(new AphrontFormSubmitControl())
+          ->addCancelButton($config_entry->getURI())
+          ->setValue(pht('Save Config Entry')));
+
+      $title = pht('Edit %s', $this->key);
+      $short = pht('Edit');
+
+    $crumbs = $this->buildApplicationCrumbs($this->buildSideNavView());
+    $crumbs->addCrumb(
+      id(new PhabricatorCrumbView())
+        ->setName($this->key)
+        ->setHref('/config/edit/'.$this->key));
+    $crumbs->addCrumb(
+      id(new PhabricatorCrumbView())->setName($short));
+
+    return $this->buildApplicationPage(
+      array(
+        $crumbs,
+        id(new PhabricatorHeaderView())->setHeader($title),
+        $error_view,
+        $form,
+      ),
+      array(
+        'title' => $title,
+        'device' => true,
+      ));
+  }
+
+}