summaryrefslogtreecommitdiff
path: root/lib/kolab_utils.php
blob: 822c2f4ac15bc15d695a2882773976867323d419 (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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<?php
/*
 +--------------------------------------------------------------------------+
 | This file is part of the Kolab Web Admin Panel                           |
 |                                                                          |
 | Copyright (C) 2011-2012, Kolab Systems AG                                |
 |                                                                          |
 | This program is free software: you can redistribute it and/or modify     |
 | it under the terms of the GNU Affero General Public License as published |
 | by the Free Software Foundation, either version 3 of the License, or     |
 | (at your option) any later version.                                      |
 |                                                                          |
 | This program is distributed in the hope that it will be useful,          |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of           |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             |
 | GNU Affero General Public License for more details.                      |
 |                                                                          |
 | You should have received a copy of the GNU Affero General Public License |
 | along with this program. If not, see <http://www.gnu.org/licenses/>      |
 +--------------------------------------------------------------------------+
 | Author: Aleksander Machniak <machniak@kolabsys.com>                      |
 | Author: Jeroen van Meeuwen <vanmeeuwen@kolabsys.com>                     |
 +--------------------------------------------------------------------------+
*/

/**
 * Utilities class
 */
class kolab_utils
{
    const REQUEST_ANY  = 0;
    const REQUEST_GET  = 1;
    const REQUEST_POST = 2;

    /**
     * Read a specific HTTP request header
     *
     * @param string $name  Header name
     *
     * @return mixed  Header value or null if not available
     */
    public static function get_request_header($name)
    {
        if (function_exists('getallheaders')) {
            $hdrs = array_change_key_case(getallheaders(), CASE_UPPER);
            $key  = strtoupper($name);
        }
        else {
            $key  = 'HTTP_' . strtoupper(strtr($name, '-', '_'));
            $hdrs = array_change_key_case($_SERVER, CASE_UPPER);
        }

        return $hdrs[$key];
    }

    /**
     * Returns input parameter value.
     *
     * @param string $name       Parameter name
     * @param int    $type       Parameter type
     * @param bool   $allow_html Disables stripping of insecure content (HTML tags)
     *
     * @return mixed Input value
     */
    public static function get_input($name, $type = null, $allow_html = false)
    {
        if ($type == self::REQUEST_GET) {
            $value = isset($_GET[$name]) ? $_GET[$name] : null;
        }
        else if ($type == self::REQUEST_POST) {
            $value = isset($_POST[$name]) ? $_POST[$name] : null;
        }
        else {
            $value = isset($_REQUEST[$name]) ? $_REQUEST[$name] : null;
        }

        return self::parse_input($value, $allow_html);
    }

    /**
     * Input parsing.
     *
     * @param mixed  $value      Input value
     * @param bool   $allow_html Disables stripping of insecure content (HTML tags)
     *
     * @return mixed Input value
     */
    public static function parse_input($value, $allow_html = false)
    {
        if (empty($value)) {
            return $value;
        }

        if (is_array($value)) {
            foreach ($value as $idx => $val) {
                $value[$idx] = self::parse_input($val, $allow_html);
            }
        }
        // remove HTML tags if not allowed
        else if (!$allow_html) {
            $value = strip_tags($value);
        }

        return $value;
    }

    /**
     * Make sure the string ends with a slash
     *
     * @param string $str String to parse
     *
     * @return string String with one slash at the end
     */
    public static function slashify($str)
    {
        return self::unslashify($str).'/';
    }

    /**
     * Remove slash at the end of the string
     *
     * @param string $str String to parse
     *
     * @return string String without any slashes at the end
     */
    public static function unslashify($str)
    {
        return preg_replace('/\/$/', '', $str);
    }

    /**
     * Check if secure protocol is being used.
     *
     * @return bool True when using https protocol, False otherwise
     */
    public static function https_check()
    {
        if (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') {
            return true;
        }

        if (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && strtolower($_SERVER['HTTP_X_FORWARDED_PROTO']) == 'https') {
            return true;
        }

        return false;
    }

    /**
     * Finds wether an array is associative or not.
     */
    public static function is_assoc($arr)
    {
        return is_array($arr) && count(array_filter(array_keys($arr), 'is_string')) == count($arr);
    }

    /**
     * Unicode-aware ldap_dn2ufn() wrapper
     *
     * @param string $dn LDAP DN string
     *
     * @return string Human-readable string
     */
    public static function dn2ufn($dn)
    {
        return self::decode_dn(ldap_dn2ufn($dn));
    }

    /**
     * Unicode-aware ldap_explode_dn() wrapper
     *
     * @param string $dn LDAP DN string
     *
     * @return array|bool Exploded DN (uses unicode encoding), False on failure
     */
    public static function explode_dn($dn)
    {
        if ($result = ldap_explode_dn($dn, 0)) {
            // get rid of count
            unset($result['count']);

            $result = array_map(array('kolab_utils', 'decode_dn'), $result);
        }

        return $result;
    }

    /**
     * Decode \XX sequences into characters
     *
     * @param string $str String to decode
     *
     * @return string Decoded string
     */
    public static function decode_dn($str)
    {
        $pos  = 0;

        // example: "\C3\A4" => "รค"
        while (preg_match('/\\\\[0-9a-fA-F]{2}/', $str, $matches, PREG_OFFSET_CAPTURE, $pos)) {
            $char = chr(hexdec(substr($matches[0][0], 1)));
            $pos  = $matches[0][1];
            $str  = substr_replace($str, $char, $pos, 3);
            $pos += 1;
        }

        return $str;
    }

    /**
     * Escape string for use in javascript code
     *
     * @param string $str String
     *
     * @return string Escaped string
     */
    public static function js_escape($str)
    {
        return strtr($str, array(
                '"'  => '\\"',
                "'"  => "\\'",
                "\\" => "\\\\",
                "\n" => '\n',
        ));
    }
}