summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Util/GlobFilter.php
blob: ac0493afc5ea5cc1e4304eb07e836560cc25953a (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
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
174
175
176
177
178
179
180
181
182
<?php
/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */

namespace Icinga\Util;

use stdClass;

/**
 * GLOB-like filter for simple data structures
 *
 * e.g. this filters:
 *
 * foo.bar.baz
 * foo.b*r.baz
 * **.baz
 *
 * match this one:
 *
 * array(
 *   'foo' => array(
 *     'bar' => array(
 *       'baz' => 'deadbeef'  // <---
 *     )
 *   )
 * )
 */
class GlobFilter
{
    /**
     * The prepared filters
     *
     * @var array
     */
    protected $filters;

    /**
     * Create a new filter from a comma-separated list of GLOB-like filters or an array of such lists.
     *
     * @param   string|\Traversable|iterable $filters
     */
    public function __construct($filters)
    {
        $patterns = array(array(''));
        $lastIndex1 = $lastIndex2 = 0;

        foreach ((is_string($filters) ? array($filters) : $filters) as $rawPatterns) {
            $escape = false;

            foreach (str_split($rawPatterns) as $c) {
                if ($escape) {
                    $escape = false;
                    $patterns[$lastIndex1][$lastIndex2] .= preg_quote($c, '/');
                } else {
                    switch ($c) {
                        case '\\':
                            $escape = true;
                            break;
                        case ',':
                            $patterns[] = array('');
                            ++$lastIndex1;
                            $lastIndex2 = 0;
                            break;
                        case '.':
                            $patterns[$lastIndex1][] = '';
                            ++$lastIndex2;
                            break;
                        case '*':
                            $patterns[$lastIndex1][$lastIndex2] .= '.*';
                            break;
                        default:
                            $patterns[$lastIndex1][$lastIndex2] .= preg_quote($c, '/');
                    }
                }
            }

            if ($escape) {
                $patterns[$lastIndex1][$lastIndex2] .= '\\\\';
            }
        }

        $this->filters = array();

        foreach ($patterns as $pattern) {
            foreach ($pattern as $i => $subPattern) {
                if ($subPattern === '') {
                    unset($pattern[$i]);
                } elseif ($subPattern === '.*.*') {
                    $pattern[$i] = '**';
                } elseif ($subPattern === '.*') {
                    $pattern[$i] = '/^' . $subPattern . '$/';
                } else {
                    $pattern[$i] = '/^' . trim($subPattern) . '$/i';
                }
            }

            if (! empty($pattern)) {
                $found = false;
                foreach ($pattern as $i => $v) {
                    if ($found) {
                        if ($v === '**') {
                            unset($pattern[$i]);
                        } else {
                            $found = false;
                        }
                    } elseif ($v === '**') {
                        $found = true;
                    }
                }

                if (end($pattern) === '**') {
                    $pattern[] = '/^.*$/';
                }

                $this->filters[] = array_values($pattern);
            }
        }
    }

    /**
     * Remove all keys/attributes matching any of $this->filters from $dataStructure
     *
     * @param   stdClass|array  $dataStructure
     *
     * @return  stdClass|array  The modified copy of $dataStructure
     */
    public function removeMatching($dataStructure)
    {
        foreach ($this->filters as $filter) {
            $dataStructure = static::removeMatchingRecursive($dataStructure, $filter);
        }
        return $dataStructure;
    }

    /**
     * Helper method for removeMatching()
     *
     * @param   stdClass|array  $dataStructure
     * @param   array           $filter
     *
     * @return  stdClass|array
     */
    protected static function removeMatchingRecursive($dataStructure, $filter)
    {
        $multiLevelPattern = $filter[0] === '**';
        if ($multiLevelPattern) {
            $dataStructure = static::removeMatchingRecursive($dataStructure, array_slice($filter, 1));
        }

        $isObject = $dataStructure instanceof stdClass;
        if ($isObject || is_array($dataStructure)) {
            if ($isObject) {
                $dataStructure = (array) $dataStructure;
            }

            if ($multiLevelPattern) {
                foreach ($dataStructure as $k => & $v) {
                    $v = static::removeMatchingRecursive($v, $filter);
                    unset($v);
                }
            } else {
                $currentLevel = $filter[0];
                $nextLevels = count($filter) === 1 ? null : array_slice($filter, 1);
                foreach ($dataStructure as $k => & $v) {
                    if (preg_match($currentLevel, (string) $k)) {
                        if ($nextLevels === null) {
                            unset($dataStructure[$k]);
                        } else {
                            $v = static::removeMatchingRecursive($v, $nextLevels);
                        }
                    }
                    unset($v);
                }
            }

            if ($isObject) {
                $dataStructure = (object) $dataStructure;
            }
        }

        return $dataStructure;
    }
}