From c8cd280d522a2522c541467b1b84c4a8666b5b38 Mon Sep 17 00:00:00 2001 From: Simon Rettberg Date: Tue, 14 Jun 2016 11:22:53 +0200 Subject: [baseconfig] Reimplement toggle/enabled switch from UFPR, sort properly, make download button honor current module/location --- modules-available/baseconfig/api.inc.php | 22 ++++-- modules-available/baseconfig/page.inc.php | 85 +++++++++++++++------- modules-available/baseconfig/templates/_page.html | 87 ++++++++++++----------- 3 files changed, 118 insertions(+), 76 deletions(-) (limited to 'modules-available/baseconfig') diff --git a/modules-available/baseconfig/api.inc.php b/modules-available/baseconfig/api.inc.php index 3aac322f..000015f5 100644 --- a/modules-available/baseconfig/api.inc.php +++ b/modules-available/baseconfig/api.inc.php @@ -45,18 +45,28 @@ foreach (glob('modules/*/baseconfig/getconfig.inc.php') as $file) { $defaults = BaseConfigUtil::getVariables(); // Dump global config from DB -$res = Database::simpleQuery('SELECT setting, value FROM setting_global'); +$res = Database::simpleQuery('SELECT setting, value, enabled FROM setting_global'); while ($row = $res->fetch(PDO::FETCH_ASSOC)) { - if (isset($configVars[$row['setting']]) || !isset($defaults[$row['setting']])) + if (isset($configVars[$row['setting']]) // Already set by a hook above, ignore + || !isset($defaults[$row['setting']])) // Setting is not defined in any /baseconfig/settings.json continue; - $configVars[$row['setting']] = $row['value']; + if ($row['enabled'] != 1) { + // Setting is disabled + $configVars[$row['setting']] = false; + } else { + $configVars[$row['setting']] = $row['value']; + } } // Fallback to default values from json files foreach ($defaults as $setting => $value) { - if (isset($configVars[$setting])) - continue; - $configVars[$setting] = $value; + if (isset($configVars[$setting])) { + if ($configVars[$setting] === false) { + unset($configVars[$setting]); + } + } else { + $configVars[$setting] = $value['defaultvalue']; + } } // All done, now output diff --git a/modules-available/baseconfig/page.inc.php b/modules-available/baseconfig/page.inc.php index d14c64ac..6f3ed806 100644 --- a/modules-available/baseconfig/page.inc.php +++ b/modules-available/baseconfig/page.inc.php @@ -3,6 +3,7 @@ class Page_BaseConfig extends Page { private $qry_extra = array(); + private $categories; /** * @var bool|string in case we're in module mode, set to the id of the module @@ -23,36 +24,47 @@ class Page_BaseConfig extends Page Util::redirect('?do=baseconfig'); } // Build variables for specific sub-settings - if (empty($this->qry_extra['field'])) { + if ($this->targetModule === false) { + // We're editing global settings - use the 'enabled' field + $qry_insert = ', enabled'; + $qry_values = ', :enabled'; + $qry_update = ', enabled = :enabled'; + $params = array(); + } elseif (empty($this->qry_extra['field'])) { + // Module specific, but module doesn't have an extra field $qry_insert = ''; $qry_values = ''; - $params = array(); + $qry_update = ''; } else { + // Module with extra field $qry_insert = ', ' . $this->qry_extra['field']; $qry_values = ', :field_value'; + $qry_update = ''; $params = array('field_value' => $this->qry_extra['field_value']); $delExtra = " AND {$this->qry_extra['field']} = :field_value "; $delParams = array('field_value' => $this->qry_extra['field_value']); - } - if ($this->targetModule === false) { - $override = false; - } else { // Not editing global settings if ($this->getCurrentModuleName() === false) { Message::addError('main.value-invalid', $this->qry_extra['field'], $this->qry_extra['field_value']); Util::redirect('?do=BaseConfig'); } - // Honor override checkbox - $override = Request::post('override', array()); } + // Honor override/enabled checkbox + $override = Request::post('override', array()); // Load all existing config options to validate input $vars = BaseConfigUtil::getVariables(); foreach ($vars as $key => $var) { - if (is_array($override) && (!isset($override[$key]) || $override[$key] !== 'on')) { - // module mode - override not set - delete - $delParams['key'] = $key; - Database::exec("DELETE FROM {$this->qry_extra['table']} WHERE setting = :key $delExtra", $delParams); - continue; + if ($this->targetModule === false) { + // Global mode + $params['enabled'] = (is_array($override) && isset($override[$key]) && $override[$key] === 'on') ? 1 : 0; + } else { + // Module mode + if (is_array($override) && (!isset($override[$key]) || $override[$key] !== 'on')) { + // override not set - delete + $delParams['key'] = $key; + Database::exec("DELETE FROM {$this->qry_extra['table']} WHERE setting = :key $delExtra", $delParams); + continue; + } } $validator = $var['validator']; $displayValue = (isset($newValues[$key]) ? $newValues[$key] : ''); @@ -65,7 +77,7 @@ class Page_BaseConfig extends Page // Now put into DB Database::exec("INSERT INTO {$this->qry_extra['table']} (setting, value, displayvalue $qry_insert)" . " VALUES (:key, :value, :displayvalue $qry_values)" - . " ON DUPLICATE KEY UPDATE value = :value, displayvalue = :displayvalue", + . " ON DUPLICATE KEY UPDATE value = :value, displayvalue = :displayvalue $qry_update", array( 'key' => $key, 'value' => $mangledValue, @@ -82,6 +94,15 @@ class Page_BaseConfig extends Page Util::redirect('?do=BaseConfig&module=' . $this->targetModule . '&' . $this->qry_extra['field'] . '=' . $this->qry_extra['field_value']); } } + // Load categories so we can define them as sub menu items + $this->categories = BaseConfigUtil::getCategories(); + asort($this->categories, SORT_DESC); + foreach ($this->categories as $catid => $val) { + Dashboard::addSubmenu( + '#category_' . $catid, + Dictionary::translateFileModule($this->categories[$catid]['module'], 'config-variable-categories', $catid) + ); + } } protected function doRender() @@ -101,17 +122,22 @@ class Page_BaseConfig extends Page // List config options $settings = array(); $vars = BaseConfigUtil::getVariables(); - $cats = BaseConfigUtil::getCategories(); // Get stuff that's set in DB already - if (isset($this->qry_extra['field'])) { + if ($this->targetModule === false) { + $fields = ', enabled'; + $where = ''; + $params = array(); + } elseif (isset($this->qry_extra['field'])) { + $fields = ''; $where = " WHERE {$this->qry_extra['field']} = :field_value"; $params = array('field_value' => $this->qry_extra['field_value']); } else { + $fields = ''; $where = ''; $params = array(); } // Populate structure with existing config from db - $res = Database::simpleQuery("SELECT setting, value, displayvalue FROM {$this->qry_extra['table']} " + $res = Database::simpleQuery("SELECT setting, value, displayvalue $fields FROM {$this->qry_extra['table']} " . " {$where} ORDER BY setting ASC", $params); while ($row = $res->fetch(PDO::FETCH_ASSOC)) { if (!isset($vars[$row['setting']]) || !is_array($vars[$row['setting']])) { @@ -119,9 +145,6 @@ class Page_BaseConfig extends Page continue; } $row += $vars[$row['setting']]; - if (is_null($row['displayvalue'])) { - $row['displayvalue'] = $row['defaultvalue']; - } if (!isset($row['catid'])) { $row['catid'] = 'unknown'; } @@ -129,35 +152,43 @@ class Page_BaseConfig extends Page } // Add entries that weren't in the db (global), setup override checkbox (module specific) foreach ($vars as $key => $var) { - if (isset($settings[$var['catid']]['settings'][$key])) { - // Value is set in DB + if (isset($settings[$var['catid']]['settings'][$key]['enabled'])) { + // Global settings - honor enabled field in db + if ($settings[$var['catid']]['settings'][$key]['enabled'] == 1) { + $settings[$var['catid']]['settings'][$key]['checked'] = 'checked'; + } + } elseif (isset($settings[$var['catid']]['settings'][$key])) { + // Module specific - value is set in DB $settings[$var['catid']]['settings'][$key]['checked'] = 'checked'; } else { - // Value is not set in DB + // Module specific - value is not set in DB $settings[$var['catid']]['settings'][$key] = $var + array( 'setting' => $key ); } + if (!isset($settings[$var['catid']]['settings'][$key]['displayvalue'])) { + $settings[$var['catid']]['settings'][$key]['displayvalue'] = $var['defaultvalue']; + } $settings[$var['catid']]['settings'][$key] += array( - 'item' => $this->makeInput($var['validator'], $key, $var['defaultvalue']), + 'item' => $this->makeInput($var['validator'], $key, $settings[$var['catid']]['settings'][$key]['displayvalue']), 'description' => Util::markup(Dictionary::translateFileModule($var['module'], 'config-variables', $key)) ); } // Sort categories $sortvals = array(); foreach ($settings as $catid => &$setting) { - $sortvals[] = isset($cats[$catid]) ? (int)$cats[$catid]['sortpos'] : 99999; + $sortvals[] = isset($this->categories[$catid]) ? (int)$this->categories[$catid]['sortpos'] : 99999; $setting['category_id'] = $catid; - $setting['category_name'] = Dictionary::translateFileModule($cats[$catid]['module'], 'config-variable-categories', $catid); + $setting['category_name'] = Dictionary::translateFileModule($this->categories[$catid]['module'], 'config-variable-categories', $catid); if ($setting['category_name'] === false) { $setting['category_name'] = $catid; } + ksort($setting['settings']); $setting['settings'] = array_values($setting['settings']); } unset($setting); array_multisort($sortvals, SORT_ASC, SORT_NUMERIC, $settings); Render::addTemplate('_page', array( - 'userid' => User::getId(), 'override' => $this->targetModule !== false, 'categories' => array_values($settings), 'target_module' => $this->targetModule, diff --git a/modules-available/baseconfig/templates/_page.html b/modules-available/baseconfig/templates/_page.html index d5548ae9..5c89213f 100644 --- a/modules-available/baseconfig/templates/_page.html +++ b/modules-available/baseconfig/templates/_page.html @@ -10,58 +10,59 @@ {{/override}} -
- - - {{#categories}} -
- -
-
-
- {{#settings}} -
-
-
-
{{setting}}
- {{^override}} -
- {{defaultvalue}} -
- {{/override}} - {{#override}} - - {{/override}} -
-
- {{{item}}} -
-
- -
+ + + {{#categories}} +
+ +
+
+ {{#settings}} +
+
+
+
{{setting}}
+ {{^override}} +
+ {{defaultvalue}}
+ + {{/override}} + {{#override}} + + {{/override}}
- +
+ + {{/settings}}
- {{/categories}}
+ {{/categories}} + {{^override}} Download + {{/override}} + {{#override}} + Download + {{/override}} -- cgit v1.2.3-55-g7522