summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Legacy/DashboardConfig.php
blob: 3fb5c2fc2d90b4f7ce5aa4f4bf35c6edf41240d7 (plain)
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
<?php
/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */

namespace Icinga\Legacy;

use Icinga\Application\Config;
use Icinga\User;
use Icinga\Web\Navigation\DashboardPane;
use Icinga\Web\Navigation\Navigation;
use Icinga\Web\Navigation\NavigationItem;

/**
 * Legacy dashboard config class for case insensitive interpretation of dashboard config files
 *
 * Before 2.2, the username part in dashboard config files was not lowered.
 *
 * @deprecated(el): Remove. TBD.
 */
class DashboardConfig extends Config
{
    /**
     * User
     *
     * @var User
     */
    protected $user;

    /**
     * Get the user
     *
     * @return User
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * Set the user
     *
     * @param   User    $user
     *
     * @return  $this
     */
    public function setUser($user)
    {
        $this->user = $user;
        return $this;
    }


    /**
     * List all dashboard configuration files that match the given user
     *
     * @param   User    $user
     *
     * @return  string[]
     */
    public static function listConfigFilesForUser(User $user)
    {
        $files = array();
        $dashboards = static::resolvePath('dashboards');
        if ($handle = @opendir($dashboards)) {
            while (false !== ($entry = readdir($handle))) {
                if ($entry[0] === '.' || ! is_dir($dashboards . '/' . $entry)) {
                    continue;
                }
                if (strtolower($entry) === strtolower($user->getUsername())) {
                    $files[] = $dashboards . '/' . $entry . '/dashboard.ini';
                }
            }
            closedir($handle);
        }
        return $files;
    }

    /**
     * {@inheritdoc}
     */
    public function saveIni($filePath = null, $fileMode = 0660)
    {
        // Preprocessing start, ensures that the non-translated names are used to save module dashboard changes
        // TODO: This MUST NOT survive the new dashboard implementation (yes, it's still a thing..)
        $dashboardNavigation = new Navigation();
        $dashboardNavigation->load('dashboard-pane');
        $getDashboardPane = function ($label) use ($dashboardNavigation) {
            foreach ($dashboardNavigation as $dashboardPane) {
                /** @var DashboardPane $dashboardPane */
                if ($dashboardPane->getLabel() === $label) {
                    return $dashboardPane;
                }

                foreach ($dashboardPane->getChildren() as $dashlet) {
                    /** @var NavigationItem $dashlet */
                    if ($dashlet->getLabel() === $label) {
                        return $dashlet;
                    }
                }
            }
        };

        foreach (clone $this->config as $name => $options) {
            if (strpos($name, '.') !== false) {
                list($dashboardLabel, $dashletLabel) = explode('.', $name, 2);
            } else {
                $dashboardLabel = $name;
                $dashletLabel = null;
            }

            $dashboardPane = $getDashboardPane($dashboardLabel);
            if ($dashboardPane !== null) {
                $dashboardLabel = $dashboardPane->getName();
            }

            if ($dashletLabel !== null) {
                $dashletItem = $getDashboardPane($dashletLabel);
                if ($dashletItem !== null) {
                    $dashletLabel = $dashletItem->getName();
                }
            }

            unset($this->config[$name]);
            $this->config[$dashboardLabel . ($dashletLabel ? '.' . $dashletLabel : '')] = $options;
        }
        // Preprocessing end

        parent::saveIni($filePath, $fileMode);
        if ($filePath === null) {
            $filePath = $this->configFile;
        }
        foreach (static::listConfigFilesForUser($this->user) as $file) {
            if ($file !== $filePath) {
                @unlink($file);
            }
        }
    }
}