admin_plugin_config::getTOC() - Code Metrics - Inspection of "fix language and TOC handling" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — psr2-config ( 303ffd...d6fc72 )

by Andreas

created 2018-05-25 08:45 UTC

admin_plugin_config::getTOC() C

↳ Parent: admin_plugin_config

Complexity

Conditions	8
Paths	18

Size

Total Lines	45
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	23
nc	18
nop	0
dl	0
loc	45
rs	5.3846
c	0
b	0
f	0

<?php
/**
 * Configuration Manager admin plugin
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Christopher Smith <[email protected]>
 * @author     Ben Coburn <[email protected]>
 */

use dokuwiki\plugin\config\core\Configuration;
use dokuwiki\plugin\config\core\Setting\Setting;
use dokuwiki\plugin\config\core\Setting\SettingFieldset;
use dokuwiki\plugin\config\core\Setting\SettingHidden;

/**
 * All DokuWiki plugins to extend the admin function
 * need to inherit from this class
 */
class admin_plugin_config extends DokuWiki_Admin_Plugin {

    const IMGDIR = DOKU_BASE . 'lib/plugins/config/images/';

    /** @var Configuration */
    protected $configuration;

    /** @var bool were there any errors in the submitted data? */
    protected $hasErrors = false;

    /** @var bool have the settings translations been loaded? */
    protected $promptsLocalized = false;

    /**
     * admin_plugin_config constructor.
     */
    public function __construct() {
        $this->configuration = new Configuration();
    }

    /**
     * handle user request
     */
    public function handle() {
        global $ID, $INPUT;

        if(!$INPUT->bool('save') || !checkSecurityToken()) {
            return;
        }

        // don't go any further if the configuration is locked
        if($this->configuration->isLocked()) return;

        // update settings and redirect of successful
        $ok = $this->configuration->updateSettings($INPUT->arr('config'));
        if($ok) { // no errors
            try {
                if($this->configuration->hasChanged()) {
                    $this->configuration->save();
                } else {
                    $this->configuration->touch();
                }
                msg($this->getLang('updated'), 1);
            } catch(Exception $e) {
                msg($this->getLang('error'), -1);
            }
            send_redirect(wl($ID, array('do' => 'admin', 'page' => 'config'), true, '&'));
        } else {
            $this->hasErrors = true;
        }
    }

    /**
     * output appropriate html
     */
    public function html() {
        $allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
        global $lang;
        global $ID;

        $this->setupLocale(true);

        echo $this->locale_xhtml('intro');

        echo '<div id="config__manager">';

        if($this->configuration->isLocked()) {
            echo '<div class="info">' . $this->getLang('locked') . '</div>';
        }

        // POST to script() instead of wl($ID) so config manager still works if
        // rewrite config is broken. Add $ID as hidden field to remember
        // current ID in most cases.
        echo '<form action="' . script() . '" method="post">';
        echo '<div class="no"><input type="hidden" name="id" value="' . $ID . '" /></div>';
        formSecurityToken();
        $this->printH1('dokuwiki_settings', $this->getLang('_header_dokuwiki'));

        $in_fieldset = false;
        $first_plugin_fieldset = true;
        $first_template_fieldset = true;
        foreach($this->configuration->getSettings() as $setting) {
            if(is_a($setting, SettingHidden::class)) {
                continue;
            } else if(is_a($setting, settingFieldset::class)) {
                // config setting group
                if($in_fieldset) {
                    echo '</table>';
                    echo '</div>';
                    echo '</fieldset>';
                } else {
                    $in_fieldset = true;
                }
                // fixme this should probably be a function in setting:
                if($first_plugin_fieldset && $setting->getType() == 'plugin') {
                    $this->printH1('plugin_settings', $this->getLang('_header_plugin'));
                    $first_plugin_fieldset = false;
                } else if($first_template_fieldset && $setting->getType() == 'template') {
                    $this->printH1('template_settings', $this->getLang('_header_template'));
                    $first_template_fieldset = false;
                }
                echo '<fieldset id="' . $setting->getKey() . '">';
                echo '<legend>' . $setting->prompt($this) . '</legend>';
                echo '<div class="table">';
                echo '<table class="inline">';
            } else {
                // config settings
                list($label, $input) = $setting->html($this, $this->hasErrors);

                $class = $setting->isDefault()
                    ? ' class="default"'
                    : ($setting->isProtected() ? ' class="protected"' : '');
                $error = $setting->hasError()
                    ? ' class="value error"'
                    : ' class="value"';
                $icon = $setting->caution()
                    ? '<img src="' . self::IMGDIR . $setting->caution() . '.png" ' .
                    'alt="' . $setting->caution() . '" title="' . $this->getLang($setting->caution()) . '" />'
                    : '';

                echo '<tr' . $class . '>';
                echo '<td class="label">';
                echo '<span class="outkey">' . $setting->getPrettyKey() . '</span>';
                echo $icon . $label;
                echo '</td>';
                echo '<td' . $error . '>' . $input . '</td>';
                echo '</tr>';
            }
        }

        echo '</table>';
        echo '</div>';
        if($in_fieldset) {
            echo '</fieldset>';
        }

        // show undefined settings list
        $undefined_settings = $this->configuration->getUndefined();
        if($allow_debug && !empty($undefined_settings)) {
            /**
             * Callback for sorting settings
             *
             * @param Setting $a
             * @param Setting $b
             * @return int if $a is lower/equal/higher than $b
             */
            function settingNaturalComparison($a, $b) {
                return strnatcmp($a->getKey(), $b->getKey());
            }

            usort($undefined_settings, 'settingNaturalComparison');
            $this->printH1('undefined_settings', $this->getLang('_header_undefined'));
            echo '<fieldset>';
            echo '<div class="table">';
            echo '<table class="inline">';
            $undefined_setting_match = array();
            foreach($undefined_settings as $setting) {
                if(
                preg_match(
                    '/^(?:plugin|tpl)' . Configuration::KEYMARKER . '.*?' . Configuration::KEYMARKER . '(.*)$/',
                    $setting->getKey(),
                    $undefined_setting_match
                )
                ) {
                    $undefined_setting_key = $undefined_setting_match[1];
                } else {
                    $undefined_setting_key = $setting->getKey();
                }
                echo '<tr>';
                echo
                    '<td class="label"><span title="$meta[\'' . $undefined_setting_key . '\']">$' .
                    'conf' . '[\'' . $setting->getArrayKey() . '\']</span></td>';
                echo '<td>' . $this->getLang('_msg_' . get_class($setting)) . '</td>';
                echo '</tr>';
            }
            echo '</table>';
            echo '</div>';
            echo '</fieldset>';
        }

        // finish up form
        echo '<p>';
        echo '<input type="hidden" name="do"     value="admin" />';
        echo '<input type="hidden" name="page"   value="config" />';

        if(!$this->configuration->isLocked()) {
            echo '<input type="hidden" name="save"   value="1" />';
            echo '<button type="submit" name="submit" accesskey="s">' . $lang['btn_save'] . '</button>';
            echo '<button type="reset">' . $lang['btn_reset'] . '</button>';
        }

        echo '</p>';

        echo '</form>';
        echo '</div>';
    }

    /**
     * @param bool $prompts
     */
    public function setupLocale($prompts = false) {
        parent::setupLocale();
        if(!$prompts || $this->promptsLocalized) return;
        $this->lang = array_merge($this->lang, $this->configuration->getLangs());
        $this->promptsLocalized = true;
    }

    /**
     * Generates a two-level table of contents for the config plugin.
     *
     * @author Ben Coburn <[email protected]>
     *
     * @return array
     */
    public function getTOC() {
        $this->setupLocale(true);

        $allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
        $toc = array();
        $check = false;

        // gather settings data into three sub arrays
        $labels = ['dokuwiki' => [], 'plugin' => [], 'template' => []];
        foreach($this->configuration->getSettings() as $setting) {
            if(is_a($setting, SettingFieldset::class)) {
                $labels[$setting->getType()][] = $setting;
            }
        }

        // top header
        $title = $this->getLang('_configuration_manager');
        $toc[] = html_mktocitem(sectionID($title, $check), $title, 1);

        // main entries
        foreach(['dokuwiki', 'plugin', 'template'] as $section) {
            if(empty($labels[$section])) continue; // no entries, skip

            // create main header
            $toc[] = html_mktocitem(
                $section . '_settings',
                $this->getLang('_header_'.$section),
                1
            );

            // create sub headers
            foreach($labels[$section] as $setting) {
                /** @var SettingFieldset $setting */
                $name = $setting->prompt($this);
                $toc[] = html_mktocitem($setting->getKey(), $name, 2);
            }
        }

        // undefined settings if allowed
        if(count($this->configuration->getUndefined()) && $allow_debug) {
            $toc[] = html_mktocitem('undefined_settings', $this->getLang('_header_undefined'), 1);
        }

        return $toc;
    }

    /**
     * @param string $id
     * @param string $text
     */
    protected function printH1($id, $text) {
        echo '<h1 id="' . $id . '">' . $text . '</h1>';
    }

    /**
     * Adds a translation to this plugin's language array
     *
     * Used by some settings to set up dynamic translations
     *
     * @param string $key
     * @param string $value
     */
    public function addLang($key, $value) {
        if(!$this->localised) $this->setupLocale();
        $this->lang[$key] = $value;
    }
}


1			<?php
2			/**
3			* Configuration Manager admin plugin
4			*
5			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6			* @author Christopher Smith <[email protected]>
7			* @author Ben Coburn <[email protected]>
8			*/
9
10			use dokuwiki\plugin\config\core\Configuration;
11			use dokuwiki\plugin\config\core\Setting\Setting;
12			use dokuwiki\plugin\config\core\Setting\SettingFieldset;
13			use dokuwiki\plugin\config\core\Setting\SettingHidden;
14
15			/**
16			* All DokuWiki plugins to extend the admin function
17			* need to inherit from this class
18			*/
19			class admin_plugin_config extends DokuWiki_Admin_Plugin {
20
21			const IMGDIR = DOKU_BASE . 'lib/plugins/config/images/';
22
23			/** @var Configuration */
24			protected $configuration;
25
26			/** @var bool were there any errors in the submitted data? */
27			protected $hasErrors = false;
28
29			/** @var bool have the settings translations been loaded? */
30			protected $promptsLocalized = false;
31
32			/**
33			* admin_plugin_config constructor.
34			*/
35			public function __construct() {
36			$this->configuration = new Configuration();
37			}
38
39			/**
40			* handle user request
41			*/
42			public function handle() {
43			global $ID, $INPUT;
44
45			if(!$INPUT->bool('save') \|\| !checkSecurityToken()) {
46			return;
47			}
48
49			// don't go any further if the configuration is locked
50			if($this->configuration->isLocked()) return;
51
52			// update settings and redirect of successful
53			$ok = $this->configuration->updateSettings($INPUT->arr('config'));
54			if($ok) { // no errors
55			try {
56			if($this->configuration->hasChanged()) {
57			$this->configuration->save();
58			} else {
59			$this->configuration->touch();
60			}
61			msg($this->getLang('updated'), 1);
62			} catch(Exception $e) {
63			msg($this->getLang('error'), -1);
64			}
65			send_redirect(wl($ID, array('do' => 'admin', 'page' => 'config'), true, '&'));
66			} else {
67			$this->hasErrors = true;
68			}
69			}
70
71			/**
72			* output appropriate html
73			*/
74			public function html() {
75			$allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
76			global $lang;
77			global $ID;
78
79			$this->setupLocale(true);
80
81			echo $this->locale_xhtml('intro');
82
83			echo '<div id="config__manager">';
84
85			if($this->configuration->isLocked()) {
86			echo '<div class="info">' . $this->getLang('locked') . '</div>';
87			}
88
89			// POST to script() instead of wl($ID) so config manager still works if
90			// rewrite config is broken. Add $ID as hidden field to remember
91			// current ID in most cases.
92			echo '<form action="' . script() . '" method="post">';
93			echo '<div class="no"><input type="hidden" name="id" value="' . $ID . '" /></div>';
94			formSecurityToken();
95			$this->printH1('dokuwiki_settings', $this->getLang('_header_dokuwiki'));
96
97			$in_fieldset = false;
98			$first_plugin_fieldset = true;
99			$first_template_fieldset = true;
100			foreach($this->configuration->getSettings() as $setting) {
101			if(is_a($setting, SettingHidden::class)) {
102			continue;
103			} else if(is_a($setting, settingFieldset::class)) {
104			// config setting group
105			if($in_fieldset) {
106			echo '</table>';
107			echo '</div>';
108			echo '</fieldset>';
109			} else {
110			$in_fieldset = true;
111			}
112			// fixme this should probably be a function in setting:
113			if($first_plugin_fieldset && $setting->getType() == 'plugin') {
114			$this->printH1('plugin_settings', $this->getLang('_header_plugin'));
115			$first_plugin_fieldset = false;
116			} else if($first_template_fieldset && $setting->getType() == 'template') {
117			$this->printH1('template_settings', $this->getLang('_header_template'));
118			$first_template_fieldset = false;
119			}
120			echo '<fieldset id="' . $setting->getKey() . '">';
121			echo '<legend>' . $setting->prompt($this) . '</legend>';
122			echo '<div class="table">';
123			echo '<table class="inline">';
124			} else {
125			// config settings
126			list($label, $input) = $setting->html($this, $this->hasErrors);
127
128			$class = $setting->isDefault()
129			? ' class="default"'
130			: ($setting->isProtected() ? ' class="protected"' : '');
131			$error = $setting->hasError()
132			? ' class="value error"'
133			: ' class="value"';
134			$icon = $setting->caution()
135			? '<img src="' . self::IMGDIR . $setting->caution() . '.png" ' .
136			'alt="' . $setting->caution() . '" title="' . $this->getLang($setting->caution()) . '" />'
137			: '';
138
139			echo '<tr' . $class . '>';
140			echo '<td class="label">';
141			echo '<span class="outkey">' . $setting->getPrettyKey() . '</span>';
142			echo $icon . $label;
143			echo '</td>';
144			echo '<td' . $error . '>' . $input . '</td>';
145			echo '</tr>';
146			}
147			}
148
149			echo '</table>';
150			echo '</div>';
151			if($in_fieldset) {
152			echo '</fieldset>';
153			}
154
155			// show undefined settings list
156			$undefined_settings = $this->configuration->getUndefined();
157			if($allow_debug && !empty($undefined_settings)) {
158			/**
159			* Callback for sorting settings
160			*
161			* @param Setting $a
162			* @param Setting $b
163			* @return int if $a is lower/equal/higher than $b
164			*/
165			function settingNaturalComparison($a, $b) {
166			return strnatcmp($a->getKey(), $b->getKey());
167			}
168
169			usort($undefined_settings, 'settingNaturalComparison');
170			$this->printH1('undefined_settings', $this->getLang('_header_undefined'));
171			echo '<fieldset>';
172			echo '<div class="table">';
173			echo '<table class="inline">';
174			$undefined_setting_match = array();
175			foreach($undefined_settings as $setting) {
176			if(
177			preg_match(
178			'/^(?:plugin\|tpl)' . Configuration::KEYMARKER . '.?' . Configuration::KEYMARKER . '(.)$/',
179			$setting->getKey(),
180			$undefined_setting_match
181			)
182			) {
183			$undefined_setting_key = $undefined_setting_match[1];
184			} else {
185			$undefined_setting_key = $setting->getKey();
186			}
187			echo '<tr>';
188			echo
189			'<td class="label"><span title="$meta[\'' . $undefined_setting_key . '\']">$' .
190			'conf' . '[\'' . $setting->getArrayKey() . '\']</span></td>';
191			echo '<td>' . $this->getLang('_msg_' . get_class($setting)) . '</td>';
192			echo '</tr>';
193			}
194			echo '</table>';
195			echo '</div>';
196			echo '</fieldset>';
197			}
198
199			// finish up form
200			echo '<p>';
201			echo '<input type="hidden" name="do" value="admin" />';
202			echo '<input type="hidden" name="page" value="config" />';
203
204			if(!$this->configuration->isLocked()) {
205			echo '<input type="hidden" name="save" value="1" />';
206			echo '<button type="submit" name="submit" accesskey="s">' . $lang['btn_save'] . '</button>';
207			echo '<button type="reset">' . $lang['btn_reset'] . '</button>';
208			}
209
210			echo '</p>';
211
212			echo '</form>';
213			echo '</div>';
214			}
215
216			/**
217			* @param bool $prompts
218			*/
219			public function setupLocale($prompts = false) {
220			parent::setupLocale();
221			if(!$prompts \|\| $this->promptsLocalized) return;
222			$this->lang = array_merge($this->lang, $this->configuration->getLangs());
223			$this->promptsLocalized = true;
224			}
225
226			/**
227			* Generates a two-level table of contents for the config plugin.
228			*
229			* @author Ben Coburn <[email protected]>
230			*
231			* @return array
232			*/
233			public function getTOC() {
234			$this->setupLocale(true);
235
236			$allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
237			$toc = array();
238			$check = false;
239
240			// gather settings data into three sub arrays
241			$labels = ['dokuwiki' => [], 'plugin' => [], 'template' => []];
242			foreach($this->configuration->getSettings() as $setting) {
243			if(is_a($setting, SettingFieldset::class)) {
244			$labels[$setting->getType()][] = $setting;
245			}
246			}
247
248			// top header
249			$title = $this->getLang('_configuration_manager');
250			$toc[] = html_mktocitem(sectionID($title, $check), $title, 1);
251
252			// main entries
253			foreach(['dokuwiki', 'plugin', 'template'] as $section) {
254			if(empty($labels[$section])) continue; // no entries, skip
255
256			// create main header
257			$toc[] = html_mktocitem(
258			$section . '_settings',
259			$this->getLang('_header_'.$section),
260			1
261			);
262
263			// create sub headers
264			foreach($labels[$section] as $setting) {
265			/** @var SettingFieldset $setting */
266			$name = $setting->prompt($this);
267			$toc[] = html_mktocitem($setting->getKey(), $name, 2);
268			}
269			}
270
271			// undefined settings if allowed
272			if(count($this->configuration->getUndefined()) && $allow_debug) {
273			$toc[] = html_mktocitem('undefined_settings', $this->getLang('_header_undefined'), 1);
274			}
275
276			return $toc;
277			}
278
279			/**
280			* @param string $id
281			* @param string $text
282			*/
283			protected function printH1($id, $text) {
284			echo '<h1 id="' . $id . '">' . $text . '</h1>';
285			}
286
287			/**
288			* Adds a translation to this plugin's language array
289			*
290			* Used by some settings to set up dynamic translations
291			*
292			* @param string $key
293			* @param string $value
294			*/
295			public function addLang($key, $value) {
296			if(!$this->localised) $this->setupLocale();
297			$this->lang[$key] = $value;
298			}
299			}
300

splitbrain / dokuwiki

Push — psr2-config ( 303ffd...d6fc72 )

admin_plugin_config::getTOC() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like