summaryrefslogtreecommitdiff
path: root/admin/admin/admin/libraries/string.lib.php
blob: 563c2db1f16ad0e7df3e73d2e71017596216a367 (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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
<?php
/* $Id: string.lib.php,v 1.10 2002/10/25 13:55:56 loic1 Exp $ */
// vim: expandtab sw=4 ts=4 sts=4:


/** Specialized String Functions for phpMyAdmin
 *
 * Copyright 2002 Robin Johnson <robbat2@users.sourceforge.net>
 * http://www.orbis-terrarum.net/?l=people.robbat2
 *
 * Defines a set of function callbacks that have a pure C version available if
 * the "ctype" extension is available, but otherwise have PHP versions to use
 * (that are slower).
 *
 * The SQL Parser code relies heavily on these functions.
 */


if (!defined('PMA_STR_LIB_INCLUDED')) {
    define('PMA_STR_LIB_INCLUDED', 1);

    // This is for handling input better
    if (defined('PMA_MULTIBYTE_ENCODING')) {
        $GLOBALS['PMA_strlen']  = 'mb_strlen';
        $GLOBALS['PMA_strpos']  = 'mb_strpos';
        $GLOBALS['PMA_strrpos'] = 'mb_strrpos';
        $GLOBALS['PMA_substr']  = 'mb_substr';
    } else {
        $GLOBALS['PMA_strlen']  = 'strlen';
        $GLOBALS['PMA_strpos']  = 'strpos';
        $GLOBALS['PMA_strrpos'] = 'strrpos';
        $GLOBALS['PMA_substr']  = 'substr';
    }


    /**
     * This checks if a string actually exists inside another string
     * We try to do it in a PHP3-portable way.
     * We don't care about the position it is in.
     *
     * @param   string   string to search for
     * @param   string   string to search in
     *
     * @return  boolean  whether the needle is in the haystack or not
     */
    function PMA_STR_strInStr($needle, $haystack)
    {
        // $GLOBALS['PMA_strpos']($haystack, $needle) !== FALSE
        // return (is_integer($GLOBALS['PMA_strpos']($haystack, $needle)));
        return $GLOBALS['PMA_strpos'](' ' . $haystack, $needle);
    } // end of the "PMA_STR_strInStr()" function


    /**
     * Checks if a given character position in the string is escaped or not
     *
     * @param   string   string to check for
     * @param   integer  the character to check for
     * @param   integer  starting position in the string
     *
     * @return  boolean  whether the character is escaped or not
     */
    function PMA_STR_charIsEscaped($string, $pos, $start = 0)
    {
        $len = $GLOBALS['PMA_strlen']($string);
        // Base case:
        // Check for string length or invalid input or special case of input
        // (pos == $start)
        if (($pos == $start) || ($len <= $pos)) {
            return FALSE;
        }

        $p           = $pos - 1;
        $escaped     = FALSE;
        while (($p >= $start) && ($string[$p] == '\\')) {
            $escaped = !$escaped;
            $p--;
        } // end while

        if ($pos < $start) {
            // throw error about strings
        }

        return $escaped;
    } // end of the "PMA_STR_charIsEscaped()" function


    /**
     * Checks if a number is in a range
     *
     * @param   integer  number to check for
     * @param   integer  lower bound
     * @param   integer  upper bound
     *
     * @return  boolean  whether the number is in the range or not
     */
    function PMA_STR_numberInRangeInclusive($num, $lower, $upper)
    {
        return (($num >= $lower) && ($num <= $upper));
    } // end of the "PMA_STR_numberInRangeInclusive()" function


    /**
     * Checks if a character is a digit
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is a digit or not
     *
     * @see     PMA_STR_numberInRangeInclusive()
     */
    function PMA_STR_isDigit($c)
    {
        $ord_zero = 48; //ord('0');
        $ord_nine = 57; //ord('9');
        $ord_c    = ord($c);

        return PMA_STR_numberInRangeInclusive($ord_c, $ord_zero, $ord_nine);
    } // end of the "PMA_STR_isDigit()" function


    /**
     * Checks if a character is an hexadecimal digit
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is an hexadecimal digit or not
     *
     * @see     PMA_STR_numberInRangeInclusive()
     */
    function PMA_STR_isHexDigit($c)
    {
        $ord_Aupper = 65;  //ord('A');
        $ord_Fupper = 70;  //ord('F');
        $ord_Alower = 97;  //ord('a');
        $ord_Flower = 102; //ord('f');
        $ord_zero   = 48;  //ord('0');
        $ord_nine   = 57;  //ord('9');
        $ord_c      = ord($c);

        return (PMA_STR_numberInRangeInclusive($ord_c, $ord_zero, $ord_nine)
                || PMA_STR_numberInRangeInclusive($ord_c, $ord_Aupper, $ord_Fupper)
                || PMA_STR_numberInRangeInclusive($ord_c, $ord_Alower, $ord_Flower));
    } // end of the "PMA_STR_isHexDigit()" function


    /**
     * Checks if a character is an upper alphabetic one
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is an upper alphabetic one or
     *                   not
     *
     * @see     PMA_STR_numberInRangeInclusive()
     */
    function PMA_STR_isUpper($c)
    {
        $ord_zero = 65; //ord('A');
        $ord_nine = 90; //ord('Z');
        $ord_c    = ord($c);

        return PMA_STR_numberInRangeInclusive($ord_c, $ord_zero, $ord_nine);
    } // end of the "PMA_STR_isUpper()" function


    /**
     * Checks if a character is a lower alphabetic one
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is a lower alphabetic one or
     *                   not
     *
     * @see     PMA_STR_numberInRangeInclusive()
     */
    function PMA_STR_isLower($c)
    {
        $ord_zero = 97;  //ord('a');
        $ord_nine = 122; //ord('z');
        $ord_c    = ord($c);

        return PMA_STR_numberInRangeInclusive($ord_c, $ord_zero, $ord_nine);
    } // end of the "PMA_STR_isLower()" function


    /**
     * Checks if a character is an alphabetic one
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is an alphabetic one or not
     *
     * @see     PMA_STR_isUpper()
     * @see     PMA_STR_isLower()
     */
    function PMA_STR_isAlpha($c)
    {
        return (PMA_STR_isUpper($c) || PMA_STR_isLower($c));
    } // end of the "PMA_STR_isAlpha()" function


    /**
     * Checks if a character is an alphanumeric one
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is an alphanumeric one or not
     *
     * @see     PMA_STR_isUpper()
     * @see     PMA_STR_isLower()
     * @see     PMA_STR_isDigit()
     */
    function PMA_STR_isAlnum($c)
    {
        return (PMA_STR_isUpper($c) || PMA_STR_isLower($c) || PMA_STR_isDigit($c));
    } // end of the "PMA_STR_isAlnum()" function


    /**
     * Checks if a character is a space one
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is a space one or not
     *
     * @see     PMA_STR_numberInRangeInclusive()
     */
    function PMA_STR_isSpace($c)
    {
        $ord_space = 32; //ord(' ')
        $ord_tab   = 9; //ord('\t')
        $ord_CR    = 13; //ord('\n')
        $ord_NOBR  = 160; //ord('U+00A0);
        $ord_c     = ord($c);

        return (($ord_c == $ord_space)
                || ($ord_c == $ord_NOBR)
                || PMA_STR_numberInRangeInclusive($ord_c, $ord_tab, $ord_CR));
    } // end of the "PMA_STR_isSpace()" function


    /**
     * Checks if a character is an accented character
     *
     * @note    Presently this only works for some character sets. More work
     *          may be needed to fix it.
     *
     * @param   string   character to check for
     *
     * @return  boolean  whether the character is an upper alphabetic one or
     *                   not
     *
     * @see     PMA_STR_numberInRangeInclusive()
     */
    function PMA_STR_isAccented($c)
    {
        $ord_min1 = 192; //ord('A');
        $ord_max1 = 214; //ord('Z');
        $ord_min2 = 216; //ord('A');
        $ord_max2 = 246; //ord('Z');
        $ord_min3 = 248; //ord('A');
        $ord_max3 = 255; //ord('Z');

        $ord_c    = ord($c);

        return PMA_STR_numberInRangeInclusive($ord_c, $ord_min1, $ord_max1)
               || PMA_STR_numberInRangeInclusive($ord_c, $ord_min2, $ord_max2)
               || PMA_STR_numberInRangeInclusive($ord_c, $ord_min2, $ord_max2);
    } // end of the "PMA_STR_isAccented()" function


    /**
     * Checks if a character is an SQL identifier
     *
     * @param   string   character to check for
     * @param   boolean  whether the dot character is valid or not
     *
     * @return  boolean  whether the character is an SQL identifier or not
     *
     * @see     PMA_STR_isAlnum()
     */
    function PMA_STR_isSqlIdentifier($c, $dot_is_valid = FALSE)
    {
        return (PMA_STR_isAlnum($c)
                || PMA_STR_isAccented($c)
                || ($c == '_') || ($c == '$')
                || (($dot_is_valid != FALSE) && ($c == '.')));
    } // end of the "PMA_STR_isSqlIdentifier()" function


    /**
     * Binary search of a value in a sorted array
     *
     * @param   string   string to search for
     * @param   array    sorted array to search into
     * @param   integer  size of sorted array to search into
     *
     * @return  boolean  whether the string has been found or not
     */
    function PMA_STR_binarySearchInArr($str, $arr, $arrsize)
    {
        // $arr NUST be sorted, due to binary search
        $top    = $arrsize - 1;
        $bottom = 0;
        $found  = FALSE;

        while (($top >= $bottom) && ($found == FALSE)) {
            $mid        = intval(($top + $bottom) / 2);
            $res        = strcmp($str, $arr[$mid]);
            if ($res == 0) {
                $found  = TRUE;
            } else if ($res < 0) {
                $top    = $mid - 1;
            } else {
                $bottom = $mid + 1;
            }
        } // end while

        return $found;
    } // end of the "PMA_STR_binarySearchInArr()" function

} // $__PMA_STR_LIB__

?>