about summary refs log tree commit diff stats
path: root/wiki/inc/Ui/Admin.php
blob: aa3b8b99e281c17e5c20b0a5b7159b495acc3e4c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?php
namespace dokuwiki\Ui;

/**
 * Class Admin
 *
 * Displays the Admin screen
 *
 * @package dokuwiki\Ui
 * @author Andreas Gohr <andi@splitbrain.org>
 * @author Håkan Sandell <hakan.sandell@home.se>
 */
class Admin extends Ui {

    protected $menu;

    /**
     * Display the UI element
     *
     * @return void
     */
    public function show() {
        $this->menu = $this->getPluginList();
        echo '<div class="ui-admin">';
        echo p_locale_xhtml('admin');
        $this->showSecurityCheck();
        $this->showAdminMenu();
        $this->showManagerMenu();
        $this->showVersion();
        $this->showPluginMenu();
        echo '</div>';
    }

    /**
     * Display the standard admin tasks
     */
    protected function showAdminMenu() {
        /** @var \DokuWiki_Auth_Plugin $auth */
        global $auth;
        global $INFO;

        if(!$INFO['isadmin']) return;

        // user manager only if the auth backend supports it
        if(!$auth || !$auth->canDo('getUsers') ) {
            if(isset($this->menu['usermanager'])) unset($this->menu['usermanager']);
        }

        echo '<ul class="admin_tasks">';
        foreach(array('usermanager','acl', 'extension', 'config', 'styling') as $plugin) {
            if(!isset($this->menu[$plugin])) continue;
            $this->showMenuItem($this->menu[$plugin]);
            unset($this->menu[$plugin]);
        }
        echo '</ul>';
    }

    /**
     * Display the standard manager tasks
     */
    protected function showManagerMenu() {
        echo '<ul class="admin_tasks">';
        foreach(array('revert','popularity') as $plugin) {
            if(!isset($this->menu[$plugin])) continue;
            $this->showMenuItem($this->menu[$plugin]);
            unset($this->menu[$plugin]);
        }
        echo '</ul>';
    }

    /**
     * Display all the remaining plugins
     */
    protected function showPluginMenu() {
        if(!count($this->menu)) return;
        echo p_locale_xhtml('adminplugins');
        echo '<ul class="admin_plugins">';
        foreach ($this->menu as $item) {
            $this->showMenuItem($item);
        }
        echo '</ul>';
    }

    /**
     * Display the DokuWiki version
     */
    protected function showVersion() {
        echo '<div id="admin__version">';
        echo getVersion();
        echo '</div>';
    }

    /**
     * data security check
     *
     * simple check if the 'savedir' is relative and accessible when appended to DOKU_URL
     *
     * it verifies either:
     *   'savedir' has been moved elsewhere, or
     *   has protection to prevent the webserver serving files from it
     */
    protected function showSecurityCheck() {
        global $conf;
        if(substr($conf['savedir'], 0, 2) !== './') return;
        echo '<a style="border:none; float:right;"
                href="http://www.dokuwiki.org/security#web_access_security">
                <img src="' . DOKU_URL . $conf['savedir'] . '/dont-panic-if-you-see-this-in-your-logs-it-means-your-directory-permissions-are-correct.png" alt="Your data directory seems to be protected properly."
                onerror="this.parentNode.style.display=\'none\'" /></a>';
    }

    /**
     * Display a single Admin menu item
     *
     * @param array $item
     */
    protected function showMenuItem($item) {
        global $ID;
        if(blank($item['prompt'])) return;
        echo '<li><div class="li">';
        echo '<a href="' . wl($ID, 'do=admin&amp;page=' . $item['plugin']) . '">';
        echo '<span class="icon">';
        echo inlineSVG($item['icon']);
        echo '</span>';
        echo '<span class="prompt">';
        echo $item['prompt'];
        echo '</span>';
        echo '</a>';
        echo '</div></li>';
    }

    /**
     * Build  list of admin functions from the plugins that handle them
     *
     * Checks the current permissions to decide on manager or admin plugins
     *
     * @return array list of plugins with their properties
     */
    protected function getPluginList() {
        global $INFO;
        global $conf;

        $pluginlist = plugin_list('admin');
        $menu = array();
        foreach($pluginlist as $p) {
            /** @var \DokuWiki_Admin_Plugin $obj */
            if(($obj = plugin_load('admin', $p)) === null) continue;

            // check permissions
            if($obj->forAdminOnly() && !$INFO['isadmin']) continue;

            $menu[$p] = array(
                'plugin' => $p,
                'prompt' => $obj->getMenuText($conf['lang']),
                'icon' => $obj->getMenuIcon(),
                'sort' => $obj->getMenuSort(),
            );
        }

        // sort by name, then sort
        uasort(
            $menu,
            function ($a, $b) {
                $strcmp = strcasecmp($a['prompt'], $b['prompt']);
                if($strcmp != 0) return $strcmp;
                if($a['sort'] == $b['sort']) return 0;
                return ($a['sort'] < $b['sort']) ? -1 : 1;
            }
        );

        return $menu;
    }

}