lib.php 48 KB
Newer Older
Martyn Smith's avatar
Martyn Smith committed
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
Martyn Smith's avatar
Martyn Smith committed
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
Martyn Smith's avatar
Martyn Smith committed
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * 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 General Public License for more details.
Martyn Smith's avatar
Martyn Smith committed
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
Martyn Smith's avatar
Martyn Smith committed
18
19
20
 *
 * @package    mahara
 * @subpackage search-internal
21
 * @author     Catalyst IT Ltd
Martyn Smith's avatar
Martyn Smith committed
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
Martyn Smith's avatar
Martyn Smith committed
24
25
26
27
28
29
 *
 */

defined('INTERNAL') || die();

/**
30
 * The internal search plugin which searches against the
Martyn Smith's avatar
Martyn Smith committed
31
32
33
34
 * Mahara database.
 */
class PluginSearchInternal extends PluginSearch {

35
36
37
38
    public static function can_be_disabled() {
        return false;
    }

Martyn Smith's avatar
Martyn Smith committed
39
40
41
    /**
     * Implement user searching with SQL
     *
42
43
     * NOTE: user with ID zero should never be returned
     *
Martyn Smith's avatar
Martyn Smith committed
44
45
46
     * @param string  The query string
     * @param integer How many results to return
     * @param integer What result to start at (0 == first result)
47
48
49
50
     * @param data    Filters the users searched by
     *                can contain:
     *             'group' => integer, // only users in this group
     *             'owner' => boolean  // include the group ownwer (only if group is set)
51
     *             'exclude'=> int     // excludes a user
Martyn Smith's avatar
Martyn Smith committed
52
53
54
55
56
     * @return array  A data structure containing results looking like ...
     *         $results = array(
     *               count   => integer, // total number of results
     *               limit   => integer, // how many results are returned
     *               offset  => integer, // starting from which result
57
     *               data    => array(   // the result records
Martyn Smith's avatar
Martyn Smith committed
58
     *                   array(
59
60
61
62
63
64
65
     *                       id            => integer,
     *                       username      => string,
     *                       institution   => string,
     *                       firstname     => string,
     *                       lastname      => string,
     *                       preferredname => string,
     *                       email         => string,
Martyn Smith's avatar
Martyn Smith committed
66
67
     *                   ),
     *                   array(
68
69
70
71
72
73
74
     *                       id            => integer,
     *                       username      => string,
     *                       institution   => string,
     *                       firstname     => string,
     *                       lastname      => string,
     *                       preferredname => string,
     *                       email         => string,
Martyn Smith's avatar
Martyn Smith committed
75
76
77
78
79
     *                   ),
     *                   array(...),
     *               ),
     *           );
     */
80
    public static function search_user($query_string, $limit, $offset = 0, $data=array()) {
81
82
        safe_require('artefact', 'internal');
        $publicfields = array_keys(ArtefactTypeProfile::get_public_fields());
83
84
85
        if (empty($publicfields)) {
            $publicfields = array('preferredname');
        }
86
        if (is_postgres()) {
87
            return self::search_user_pg($query_string, $limit, $offset, $data, $publicfields);
88
89
        } 
        else if (is_mysql()) {
90
            return self::search_user_my($query_string, $limit, $offset, $data, $publicfields);
91
92
        }
        else {
93
94
95
96
            throw new SQLException('search_user() is not implemented for your database engine (' . get_config('dbtype') . ')');
        }
    }

97
    public static function search_user_pg($query_string, $limit, $offset, $data, $publicfields) {
98
        $fieldlist = "('" . join("','", $publicfields) . "')";
99
        $data = self::prepare_search_user_options($data);
100
        $sql = 'SELECT
101
102
                COUNT(DISTINCT u.id)
            FROM
103
104
                {usr} u
                LEFT JOIN {artefact} a ON u.id=a.owner
105
106
                ';
        if (isset($data['group'])) {
107
108
109
            $groupadminsql = '';
            if (isset($data['includeadmins']) and !$data['includeadmins']) {
                $groupadminsql = " AND gm.role != 'admin'";
110
            }
111
            $sql .= 'INNER JOIN {group_member} gm ON (gm.member = u.id AND gm.group = ' . (int)$data['group'] . $groupadminsql . ")\n";
112
        }
113
114
        $querydata = split(' ', preg_replace('/\s\s+/', ' ', strtolower(trim($query_string))));
        $namesql = '(
115
116
117
118
                        u.preferredname ILIKE \'%\' || ? || \'%\'
                    )
                    OR (
                        (u.preferredname IS NULL OR u.preferredname = \'\')
119
120
121
122
123
124
125
126
                        AND (
                            u.firstname ILIKE \'%\' || ? || \'%\'
                            OR u.lastname ILIKE \'%\' || ? || \'%\'
                        )
                    )
                    OR (
                        a.artefacttype IN ' . $fieldlist . '
                        AND ( a.title ILIKE \'%\' || ? || \'%\')
127
128
129
130
131
132
133
134
135
136
                    )';
        $namesql = join(' OR ', array_fill(0, count($querydata), $namesql));
        $values = array();
        foreach ($querydata as $w) {
            $values = array_pad($values, count($values) + 4, $w);
        }

        $sql .= 'WHERE
                u.id <> 0 AND u.active = 1 AND u.deleted = 0
                AND ( ' . $namesql . '
137
                )
138
                ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
139
            ';
140
        $count = get_field_sql($sql, $values);
141
142

        if ($count > 0) {
143
            $sql = 'SELECT DISTINCT ON (' . $data['orderby'] . ')
144
                    u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.staff
145
146
                FROM {artefact} a
                    INNER JOIN {usr} u ON u.id = a.owner
147
148
                ';
            if (isset($data['group'])) {
149
150
151
152
153
                $groupadminsql = '';
                if (isset($data['includeadmins']) and !$data['includeadmins']) {
                    $groupadminsql = " AND gm.role != 'admin'";
                }
                $sql .= 'INNER JOIN {group_member} gm ON (gm.member = u.id AND gm.group = ' . (int)$data['group'] . $groupadminsql . ")\n";
154
155
            }
            $sql .= 'WHERE
156
                    u.id <> 0 AND u.active = 1 AND u.deleted = 0
157
                    AND (' . $namesql . '
Martyn Smith's avatar
Martyn Smith committed
158
                    )
159
                    ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
160
                ORDER BY ' . $data['orderby'];
161
            $data = get_records_sql_array($sql, $values, $offset, $limit);
162

163
164
165
            if ($data) {
                foreach ($data as &$item) {
                    $item = (array)$item;
166
                }
167
            }
Martyn Smith's avatar
Martyn Smith committed
168
169
        }
        else {
170
            $data = false;
Nigel McNie's avatar
Nigel McNie committed
171
172
173
174
175
176
177
178
179
        }

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
            'data'    => $data,
        );
    }
180

181
    public static function search_user_my($query_string, $limit, $offset, $data, $publicfields) {
182
183
        $fieldlist = "('" . join("','", $publicfields) . "')";

184
        $sql = 'SELECT
185
                COUNT(DISTINCT u.id)
186
            FROM
187
188
                {usr} u
                LEFT JOIN {artefact} a ON u.id=a.owner
189
190
191
192
193
194
195
196
197
                ';
        if (isset($data['group'])) {
            $sql .= 'INNER JOIN {group_member} gm ON (gm.member = u.id AND gm.group = ' . (int)$data['group'] . ')
                ';
            if (isset($data['owner']) && !$data['owner']) {
                $sql .= 'INNER JOIN {group} g ON (g.id = gm.group AND g.owner != u.id)
                    ';
            }
        }
198
199
        $querydata = split(' ', preg_replace('/\s\s+/', ' ', strtolower(trim($query_string))));
        $namesql = '(
200
201
202
203
                        u.preferredname LIKE \'%\' || ? || \'%\'
                    )
                    OR (
                        (u.preferredname IS NULL OR u.preferredname = \'\')
204
205
206
207
208
209
210
211
                        AND (
                            u.firstname LIKE \'%\' || ? || \'%\'
                            OR u.lastname LIKE \'%\' || ? || \'%\'
                        )
                    )
                    OR (
                        a.artefacttype IN ' . $fieldlist . '
                        AND ( a.title LIKE \'%\' || ? || \'%\')
212
213
214
215
216
217
218
219
220
221
                    )';
        $namesql = join(' OR ', array_fill(0, count($querydata), $namesql));
        $values = array();
        foreach ($querydata as $w) {
            $values = array_pad($values, count($values) + 4, $w);
        }

        $sql .= 'WHERE
                u.id <> 0 AND u.active = 1 AND u.deleted = 0
                AND (' . $namesql . '
222
                )
223
                ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
224
            ';
225

226
        $count = get_field_sql($sql, $values);
227
        if ($count > 0) {
228
229
230
231
232
            // @todo This is quite possibly not correct. See the postgres 
            // query. It should be DISTINCT ON the fields as specified by the 
            // postgres query. There is a workaround by using SELECT * followed 
            // by GROUP BY 1, 2, 3, but it's not really valid SQL. The other 
            // way is to rewrite the query using a self join on the usr table.
233
            $sql = 'SELECT DISTINCT
234
                    u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.staff
235
236
                FROM {artefact} a
                    INNER JOIN {usr} u ON u.id = a.owner
237
238
239
240
241
242
243
244
245
246
                    ';
            if (isset($data['group'])) {
                $sql .= 'INNER JOIN {group_member} gm ON (gm.member = u.id AND gm.group = ' . (int)$data['group'] . ')
                    ';
                if (isset($data['owner']) && !$data['owner']) {
                    $sql .= 'INNER JOIN {group} g ON (g.id = gm.group AND g.owner != u.id)
                        ';
                    }
            }
            $sql .= 'WHERE
247
                    u.id <> 0 AND u.active = 1 AND u.deleted = 0
248
                    AND ( ' . $namesql . '
249
                    )
250
                    ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
251
                ORDER BY u.firstname, u.lastname, u.id';
252
            $data = get_records_sql_array($sql, $values, $offset, $limit);
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
            if ($data) {
                foreach ($data as &$item) {
                    $item = (array)$item;
                }
            }
        }
        else {
            $data = false;
        }

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
            'data'    => $data,
        );
    }
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285

    private static function prepare_search_user_options($options) {
        if (isset($options['group'])) {
            $options['group'] = intval($options['group']);
        }
        if (isset($options['includeadmins'])) {
            $options['includeadmins'] = (bool)$options['includeadmins'];
        }
        if (isset($options['orderby']) && $options['orderby'] == 'lastname') {
            $options['orderby'] = 'u.lastname, u.firstname, u.id';
        }
        else {
            $options['orderby'] = 'u.firstname, u.lastname, u.id';
        }
        return $options;
    }
Nigel McNie's avatar
Nigel McNie committed
286
    
287

288
289
    private static function match_expression($op, $string, &$values, $ilike) {
        switch ($op) {
290
291
        case 'starts':
            $values[] = $string;
292
            return ' ' . $ilike . ' ? || \'%\'';
293
294
295
296
297
        case 'equals':
            $values[] = $string;
            return ' = ? ';
        case 'contains':
            $values[] = $string;
298
            return ' ' . $ilike . ' \'%\' || ? || \'%\'';
299
300
301
302
303
304
        case 'in':
            return ' IN (' . join(',', array_map('db_quote',$string)) . ')';
        }
    }


305
    public static function admin_search_user($queries, $constraints, $offset, $limit, 
306
                                             $sortfield, $sortdir) {
307
        $sort = $sortfield . ' ' . strtoupper($sortdir);
308
        $where = 'WHERE u.id <> 0 AND u.deleted = 0';
309
310
        $values = array();

311
312
313
        // Get the correct keyword for case insensitive LIKE
        $ilike = db_ilike();

314
        // Only handle OR/AND expressions at the top level.  Eventually we may need subexpressions.
315

Richard Mansfield's avatar
Richard Mansfield committed
316
        if (!empty($queries)) {
317
318
            $where .= ' AND ( ';
            $str = array();
Richard Mansfield's avatar
Richard Mansfield committed
319
            foreach ($queries as $f) {
320
                $str[] = 'u.' . $f['field'] 
321
                    . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
322
323
324
325
            }
            $where .= join(' OR ', $str) . ') ';
        } 

326
327
328
        // @todo: Institution stuff is messy and will probably need to
        // be rewritten when we get multiple institutions per user

329
        $requested = false;
330
        $institutionsearch = '';
Richard Mansfield's avatar
Richard Mansfield committed
331
332
        if (!empty($constraints)) {
            foreach ($constraints as $f) {
333
334
335
336
337
338
                if (strpos($f['field'], 'institution') === 0) {
                    $institutionsearch .= ' 
                        LEFT OUTER JOIN {usr_institution} i ON i.usr = u.id ';
                    if (strpos($f['field'], 'requested') > 0) {
                        $institutionsearch .= ' 
                            LEFT OUTER JOIN {usr_institution_request} ir ON ir.usr = u.id ';
339
                    }
340
341
                    if ($f['field'] == 'institution_requested') {
                        $where .= ' AND ( i.institution ' .
342
                            PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike) .
343
                            ' OR ir.institution ' .
344
                            PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike) . ')';
345
                        $requested = true;
346
347
348
349
350
                    } else {
                        if ($f['string'] == 'mahara') {
                            $where .= ' AND i.institution IS NULL';
                        } else {
                            $where .= ' AND i.institution'
351
                                . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
352
                        }
353
                    }
354
                } else {
355
                    $where .= ' AND u.' . $f['field'] 
356
                        . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
357
                }
358
            }
359
        }
360
        if (strpos($sort, 'institution') === 0) {
361
            $sort = 'i.' . $sort;
362
363
            if ($institutionsearch == '') {
                $institutionsearch = ' LEFT OUTER JOIN {usr_institution} i ON i.usr = u.id ';
364
            }
365
366
        }

367
        $count = get_field_sql('SELECT COUNT(*) FROM {usr} u ' . $institutionsearch . $where, $values);
368
369

        if ($count > 0) {
370
            $data = get_records_sql_assoc('
371
                SELECT 
372
                    u.id, u.firstname, u.lastname, u.username, u.email, u.staff,
373
                    u.active, NOT u.suspendedcusr IS NULL as suspended
374
                FROM
375
                    {usr} u ' . $institutionsearch . $where . '
376
                ORDER BY ' . $sort,
377
                $values,
Richard Mansfield's avatar
Richard Mansfield committed
378
379
                $offset,
                $limit);
380
381

            if ($data) {
382
383
384
385
386
387
388
389
                $inst = get_records_select_array('usr_institution', 
                                                 'usr IN (' . join(',', array_keys($data)) . ')',
                                                 null, '', 'usr,institution');
                if ($inst) {
                    foreach ($inst as $i) {
                        $data[$i->usr]->institutions[] = $i->institution;
                    }
                }
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
                if ($requested) {
                    $inst = get_records_select_array('usr_institution_request', 
                                                     'usr IN (' . join(',', array_keys($data)) . ')',
                                                     null, '', 'usr,institution,confirmedusr,confirmedinstitution');
                    if ($inst) {
                        foreach ($inst as $i) {
                            if ($i->confirmedusr) {
                                $data[$i->usr]->requested[] = $i->institution;
                            }
                            if ($i->confirmedinstitution) {
                                $data[$i->usr]->invitedby[] = $i->institution;
                            }
                        }
                    }
                }
405
406
407
                foreach ($data as &$item) {
                    $item = (array)$item;
                }
408
                $data = array_values($data);
409
410
411
412
413
414
415
416
            }
        }
        else {
            $data = false;
        }

        return array(
            'count'   => $count,
Richard Mansfield's avatar
Richard Mansfield committed
417
418
            'limit'   => $limit,
            'offset'  => $offset,
419
420
421
422
            'data'    => $data,
        );
    }

423

424
    public static function group_search_user($group, $queries, $constraints, $offset, $limit, $membershiptype) {
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
        $where = 'WHERE gm.group = ?';
        $values = array($group);

        // Get the correct keyword for case insensitive LIKE
        $ilike = db_ilike();

        // Only handle OR/AND expressions at the top level.  Eventually we may need subexpressions.

        if (!empty($queries)) {
            $where .= ' AND ( ';
            $str = array();
            foreach ($queries as $f) {
                $str[] = 'u.' . $f['field'] 
                    . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
            }
            $where .= join(' OR ', $str) . ') ';
        }

443
444
445
446
447
448
449
450
451
452
453
454
        $group_member = 'group_member';
        if (!empty($membershiptype) && in_array($membershiptype, array('request', 'invite'))) {
            $group_member .= '_' . $membershiptype;
            $gm_role = '';
            $gm_role_order = '';
        }
        else {
            $gm_role = ', gm.role';
            $gm_role_order = "gm.role = 'admin' DESC, ";
        }

        $count = get_field_sql('SELECT COUNT(*) FROM {usr} u INNER JOIN {' . $group_member . '} gm ON (gm.member = u.id) ' . $where, $values);
455
456
457
458

        if ($count > 0) {
            $data = get_records_sql_assoc('
                SELECT
459
                    u.id, u.firstname, u.lastname, u.username, u.email, u.staff, ' . db_format_tsfield('gm.ctime', 'jointime') . $gm_role . '
460
461
                FROM
                    {usr} u
462
463
                INNER JOIN {' . $group_member . '} gm ON (gm.member = u.id) ' . $where . '
                ORDER BY ' . $gm_role_order . 'gm.ctime, u.firstname, u.lastname, u.id',
464
465
466
467
468
469
470
471
472
473
474
475
                $values,
                $offset,
                $limit);

            if ($data) {
                foreach ($data as &$item) {
                    $item = (array)$item;
                }
                $data = array_values($data);
            }
        }
        else {
476
            $data = array();
477
478
479
480
481
482
483
484
485
486
        }

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
            'data'    => $data,
        );
    }

487
488
489
490
491
492
493
494
495
496

    public static function institutional_admin_search_user($query, $institution, $limit) {
        $sql = '
            FROM {usr} u ';

        $where = '
            WHERE u.id <> 0 AND u.deleted = 0 ';

        $values = array();
        if (!empty($query)) {
497
498
499
500
501
502
503
            $query = preg_replace('/\s\s+/', ' ', $query);
            $words = explode(' ', $query);
            foreach ($words as &$word) {
                $values[] = $word;
                $values[] = $word;
                $word = 'u.firstname ' . db_ilike() . ' \'%\' || ? || \'%\' OR u.lastname ' . db_ilike() . ' \'%\' || ? || \'%\'';
            }
504
            $where .= '
505
                AND (' . join(' OR ', $words) . ') ';
506
507
        }

508
        $studentid = '';
509
510
511
512
513
514
        if (!is_null($institution->member)) {
            $sql .= '
                LEFT OUTER JOIN {usr_institution} member ON (member.usr = u.id
                    AND member.institution = ' . db_quote($institution->name) . ')';
            $where .= '
                AND ' . ($institution->member ? ' NOT ' : '') . ' member.usr IS NULL';
515
            $studentid = ', member.studentid';
516
        }
517
        if (!is_null($institution->requested) || !is_null($institution->invitedby)) {
518
519
520
521
522
523
524
525
526
            $sql .= '
                LEFT OUTER JOIN {usr_institution_request} req ON (req.usr = u.id
                    AND req.institution = ' . db_quote($institution->name) . ')';
            if (!is_null($institution->requested)) {
                if ($institution->requested == 1) {
                    $where .= ' AND req.confirmedusr = 1';
                } else {
                    $where .= ' AND (req.confirmedusr = 0 OR req.confirmedusr IS NULL)';
                }
527
                $studentid = ', req.studentid';
528
            }
529
            if (!is_null($institution->invitedby)) {
530
531
532
533
534
535
536
537
538
539
540
541
542
543
                if ($institution->requested == 1) {
                    $where .= ' AND req.confirmedinstitution = 1';
                } else {
                    $where .= ' AND (req.confirmedinstitution = 0 OR req.confirmedinstitution IS NULL)';
                }
            }
        }

        $count = get_field_sql('SELECT COUNT(*) ' . $sql . $where, $values);

        if ($count > 0) {
            $data = get_records_sql_array('
                SELECT 
                    u.id, u.firstname, u.lastname, u.username, u.preferredname, 
544
                    u.admin, u.staff' . $studentid . $sql . $where . '
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
                ORDER BY u.firstname ASC',
                $values,
                0,
                $limit);
            foreach ($data as &$item) {
                $item = (array)$item;
            }
        }
        else {
            $data = false;
        }

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => 0,
            'data'    => $data,
        );
    }





569
570
571
572
573
574
    /**
     * Implement group searching with SQL
     *
     * @param string  The query string
     * @param integer How many results to return
     * @param integer What result to start at (0 == first result)
575
     * @param string  Which groups to search (all, member, notmember)
576
577
578
579
580
581
582
     * @return array  A data structure containing results looking like ...
     *         $results = array(
     *               count   => integer, // total number of results
     *               limit   => integer, // how many results are returned
     *               offset  => integer, // starting from which result
     *               data    => array(   // the result records
     *                   array(
Nigel McNie's avatar
Nigel McNie committed
583
     *                       id            => integer,
584
585
586
587
588
589
     *                       name          => string,
     *                       description   => string,
     *                       jointype      => string,
     *                       owner         => string,
     *                       ctime         => string,
     *                       mtime         => string,
Nigel McNie's avatar
Nigel McNie committed
590
591
592
     *                   ),
     *                   array(
     *                       id            => integer,
593
594
595
596
597
598
     *                       name          => string,
     *                       description   => string,
     *                       jointype      => string,
     *                       owner         => string,
     *                       ctime         => string,
     *                       mtime         => string,
Nigel McNie's avatar
Nigel McNie committed
599
600
601
602
603
     *                   ),
     *                   array(...),
     *               ),
     *           );
     */
604
    public static function search_group($query_string, $limit, $offset=0, $type='member') {
605
        if (is_postgres()) {
606
            return self::search_group_pg($query_string, $limit, $offset, $type);
607
608
        } 
        else if (is_mysql()) {
609
            return self::search_group_my($query_string, $limit, $offset, $type);
610
611
        } 
        else {
612
            throw new SQLException('search_group() is not implemented for your database engine (' . get_config('dbtype') . ')');
Martyn Smith's avatar
Martyn Smith committed
613
        }
614
615
    }

616
    public static function search_group_pg($query_string, $limit, $offset, $type) {
617
618
619
        global $USER;
        $sql = "
            SELECT
620
                id, name, description, grouptype, jointype, ctime, mtime
621
            FROM
622
                {group}
623
624
625
            WHERE (
                name ILIKE '%' || ? || '%' 
                OR description ILIKE '%' || ? || '%' 
626
627
            ) AND deleted = ? ";
        $values = array($query_string, $query_string, 0);
628
629
        if ($type == 'member') {
            $sql .=  'AND (
630
                id IN (
631
                    SELECT "group" FROM {group_member} WHERE member = ?
632
                )
633
            )';
634
635
            $values[] = $USER->get('id');
        }
636
637
        else if ($type == 'notmember') {
            $sql .=  'AND (
638
                id NOT IN (
639
640
641
642
643
644
                    SELECT "group" FROM {group_member} WHERE member = ?
                )
            )';
            $values[] = $USER->get('id');
        }
        $sql .= 'ORDER BY name';
645
646
647
648
649
650
        $data = get_records_sql_array($sql, $values, $offset, $limit);

        $sql = "
            SELECT
                COUNT(*)
            FROM
651
                {group} u
652
653
654
            WHERE (
                name ILIKE '%' || ? || '%' 
                OR description ILIKE '%' || ? || '%' 
655
            ) AND deleted = ? ";
656
657
        if ($type == 'member') {
            $sql .= 'AND (
658
                    id IN (
659
                        SELECT "group" FROM {group_member} WHERE member = ?
660
661
                    )
                )
662
            ';
663
        }
664
665
        else if ($type == 'notmember') {
            $sql .= 'AND (
666
                    id NOT IN (
667
668
669
670
671
                        SELECT "group" FROM {group_member} WHERE member = ?
                    )
                )
            ';
        }
672
        $count = get_field_sql($sql, $values);
673
674
675
676
677
678
679
680
681

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
            'data'    => $data,
        );
    }

682
    public static function search_group_my($query_string, $limit, $offset, $type) {
683
684
685
        global $USER;
        $sql = "
            SELECT
686
                id, name, description, grouptype, jointype, ctime, mtime
687
            FROM
688
                {group}
689
690
691
            WHERE (
                name LIKE '%' || ? || '%' 
                OR description LIKE '%' || ? || '%' 
692
693
            ) AND deleted = ? ";
        $values = array($query_string, $query_string, 0);
694
        if ($type == 'member') {
695
            $sql .=  'AND (
696
                id IN (
697
                    SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
698
                )
699
            )';
700
701
            $values[] = $USER->get('id');
        }
702
703
        else if ($type == 'notmember') {
            $sql .=  "AND (
704
                id NOT IN (
705
                    SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
706
707
708
709
710
                )
            )";
            $values[] = $USER->get('id');
        }
        $sql .= 'ORDER BY name';
711
712
713
714
715
716
        $data = get_records_sql_array($sql, $values, $offset, $limit);

        $sql = "
            SELECT
                COUNT(*)
            FROM
717
                {group} u
718
719
720
            WHERE (
                name LIKE '%' || ? || '%' 
                OR description LIKE '%' || ? || '%' 
721
            ) AND deleted = ? ";
722
        if ($type == 'member') {
723
            $sql .= 'AND (
724
                    id IN (
725
                        SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
726
727
                    )
                )
728
            ';
729
        }
730
731
        else if ($type == 'notmember') {
            $sql .= "AND (
732
                    id NOT IN (
733
                        SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
734
735
                    )
                )
736
737
738
            ";
        }
        $count = get_field_sql($sql, $values);
Martyn Smith's avatar
Martyn Smith committed
739
740
741
742
743

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
744
            'data'    => $data,
Martyn Smith's avatar
Martyn Smith committed
745
746
        );
    }
Martyn Smith's avatar
Martyn Smith committed
747
748
749
750
751
752
753
754
755
756
757

    /**
     * Given a query string and limits, return an array of matching objects
     * owned by the current user.  Possible return types are ...
     *   - artefact
     *   - view
     *
     * Implementations of this search should search across tags for artefacts
     * and views at a minimum. Ideally the search would also index
     * title/description and other metadata for these objects.
     *
758
759
760
     * NOTE: This implementation of internal search only does artefacts, and
     * badly at that. See the bug tracker for more information.
     *
Martyn Smith's avatar
Martyn Smith committed
761
762
763
764
765
766
     * @param string  The query string
     * @param integer How many results to return
     * @param integer What result to start at (0 == first result)
     * @param string  Type to search for (either 'all' or one of the types above).
     * 
     */
767
768
    public static function self_search($querystring, $limit, $offset, $type = 'all') {
        global $USER;
769
770
771
772
        if (trim($querystring) == '') {
            return false;
        }

773
774
775
776
777
        // Tokenise the search
        $querydata = self::search_parse_query($querystring);

        $sql = "
            SELECT
778
                a.id, a.artefacttype, a.title, a.description
779
            FROM
780
                {artefact} a
781
            LEFT JOIN {artefact_tag} at ON (at.artefact = a.id)
782
            WHERE
783
784
785
786
787
788
                a.owner = ?
            AND (
                ($querydata[0])
                OR
                (LOWER(at.tag) = ?)
            )";
789
790
791
792
        $count_sql = "
            SELECT
                COUNT(*)
            FROM
793
                {artefact} a
794
            LEFT JOIN {artefact_tag} at ON (at.artefact = a.id)
795
            WHERE
796
797
798
799
800
801
                a.owner = ?
            AND (
                ($querydata[0])
                OR
                (LOWER(at.tag) = ?)
            )";
802
        array_unshift($querydata[1], $USER->get('id'));
803
804
        array_push($querydata[1], $querystring);

805
806
807
808
809
810
811
        $results = array(
            'data'   => get_records_sql_array($sql, $querydata[1], $offset, $limit),
            'offset' => $offset,
            'limit'  => $limit,
            'count'  => get_field_sql($count_sql, $querydata[1])
        );

812
813
814
815
816
817
818
        if ($results['data']) {
            foreach ($results['data'] as &$result) {
                $newresult = array();
                foreach ($result as $key => &$value) {
                    if ($key == 'id' || $key == 'artefacttype' || $key == 'title' || $key == 'description') {
                        $newresult[$key] = $value;
                    }
819
                }
820
821
822
823
824
825
826
827
828
829
                $newresult['type'] = 'artefact';
                $artefactplugin = get_field('artefact_installed_type', 'plugin', 'name', $newresult['artefacttype']);
                if ($artefactplugin == 'internal') {
                    $newresult['summary'] = $newresult['title'];
                    $newresult['title'] = get_string($newresult['artefacttype'], 'artefact.' . $artefactplugin);
                }
                else {
                    $newresult['summary'] = $newresult['description'];
                }
                $result = $newresult;
830
            }
831
832

            self::self_search_make_links($results);
833
834
835
836
837
838
        }

        return $results;
    }


839
840
841
842
843
844
845
846
    /**
     * Returns portfolio items (artefacts, views) owned by $owner and tagged
     * with $tag.
     *
     * @param string   $tag Tag
     * @param object   $owner: owner type (user,group,institution), and id
     * @param integer  $limit
     * @param integer  $offset
847
     * @param string   $sort
848
     * @param array    $types view/artefacttype filters
849
     * @param boolean  $returntags Return all the tags that have been attached to each result
850
     */
851
852
853
854
855
856
857
858
859
860
861
862
    public static function portfolio_search_by_tag($tag, $owner, $limit, $offset, $sort, $types, $returntags) {
        $viewfilter = is_null($types) || $types['view'] == true ? 'TRUE' : 'FALSE';
        if (is_null($types)) {
            $artefacttypefilter = '';
        }
        else if (!empty($types['artefact'])) {
            $artefacttypefilter = ' AND a.artefacttype IN (' . join(',', array_map('db_quote', $types['artefact'])) . ')';
        }
        else {
            $artefacttypefilter = ' AND FALSE';
        }

863
864
865
        $from = "FROM (
           (SELECT a.id, a.title, a.description, 'artefact' AS type, a.artefacttype, " . db_format_tsfield('a.ctime', 'ctime') . "
            FROM {artefact} a JOIN {artefact_tag} at ON (a.id = at.artefact AND at.tag = ?)
866
            WHERE a.owner = ?" . $artefacttypefilter . ")
867
868
869
           UNION
           (SELECT v.id, v.title, v.description, 'view' AS type, NULL AS artefacttype, " . db_format_tsfield('v.ctime', 'ctime') . "
            FROM {view} v JOIN {view_tag} vt ON (v.id = vt.view AND vt.tag = ?)
870
            WHERE v.owner = ? AND " . $viewfilter . ")
871
872
873
874
875
876
877
878
879
        ) p";

        $values = array($tag, $owner->id, $tag, $owner->id);

        $result = (object) array(
            'tag'    => $tag,
            'owner'  => $owner,
            'offset' => $offset,
            'limit'  => $limit,
880
            'sort'   => $sort,
881
882
883
884
885
886
            'count'  => 0,
            'data'   => array(),
        );

        if ($count = count_records_sql('SELECT COUNT(*) ' . $from, $values, $offset, $limit)) {
            $result->count = $count;
887
            $sort = $sort == 'date' ? 'ctime DESC' : 'title ASC';
888
            if ($data = get_records_sql_assoc("SELECT type || ':' || id AS tid, p.* " . $from . ' ORDER BY ' . $sort, $values, $offset, $limit)) {
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
                if ($returntags) {
                    $ids = array('view' => array(), 'artefact' => array());
                    foreach ($data as &$d) {
                        $ids[$d->type][$d->id] = 1;
                    }
                    if (!empty($ids['view'])) {
                        if ($viewtags = get_records_select_array('view_tag', 'view IN (' . join(',', array_keys($ids['view'])) . ')')) {
                            foreach ($viewtags as &$vt) {
                                $data['view:' . $vt->view]->tags[] = $vt->tag;
                            }
                        }
                    }
                    if (!empty($ids['artefact'])) {
                        if ($artefacttags = get_records_select_array('artefact_tag', 'artefact IN (' . join(',', array_keys($ids['artefact'])) . ')')) {
                            foreach ($artefacttags as &$at) {
                                $data['artefact:' . $at->artefact]->tags[] = $at->tag;
                            }
                        }
                    }
                }
909
910
911
912
913
914
915
                $result->data = $data;
            }
        }
        return $result;
    }


916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
    /**
     * Parses a query string into SQL fragments for searching. Supports 
     * phrases, AND/OR etc.
     *
     * Lifted from drupal 5.1, (C) 2007 Drupal
     *
     * This function comes from Drupal's search module, with some small changes.
     */
    private static function search_parse_query($text) {
        $keys = array('positive' => array(), 'negative' => array());

        // Tokenize query string
        preg_match_all('/ (-?)("[^"]+"|[^" ]+)/i', ' '. $text, $matches, PREG_SET_ORDER);

        if (count($matches) < 1) {
          return NULL;
        }

        // Classify tokens
        $or = FALSE;
        foreach ($matches as $match) {
          $phrase = FALSE;
          // Strip off phrase quotes
          if ($match[2]{0} == '"') {
            $match[2] = substr($match[2], 1, -1);
            $phrase = TRUE;
          }
          // Simplify keyword according to indexing rules and external preprocessors
          $words = self::search_simplify($match[2]);
          // Re-explode in case simplification added more words, except when matching a phrase
          $words = $phrase ? array($words) : preg_split('/ /', $words, -1, PREG_SPLIT_NO_EMPTY);
          // Negative matches
          if ($match[1] == '-') {
            $keys['negative'] = array_merge($keys['negative'], $words);
          }
          // OR operator: instead of a single keyword, we store an array of all
          // OR'd keywords.
          elseif ($match[2] == 'OR' && count($keys['positive'])) {
            $last = array_pop($keys['positive']);
            // Starting a new OR?
            if (!is_array($last)) {
              $last = array($last);
            }
            $keys['positive'][] = $last;
            $or = TRUE;
            continue;
          }
          // Plain keyword
          else {
            if ($or) {
              // Add to last element (which is an array)
              $keys['positive'][count($keys['positive']) - 1] = array_merge($keys['positive'][count($keys['positive']) - 1], $words);
            }
            else {
              $keys['positive'] = array_merge($keys['positive'], $words);
            }
          }
          $or = FALSE;
        }

        // Convert keywords into SQL statements.
        $query = array();
        //$query2 = array();
        $arguments = array();
        $arguments2 = array();
        //$matches = 0; 
        // Positive matches
        foreach ($keys['positive'] as $key) {
          // Group of ORed terms
          if (is_array($key) && count($key)) {
            $queryor = array();
            $any = FALSE;
            foreach ($key as $or) {
              list($q, $count) = self::_search_parse_query($or, $arguments2);
              $any |= $count;
              if ($q) {
                $queryor[] = $q;
                $arguments[] = $or;
                $arguments[] = $or;
              }
            }

            if (count($queryor)) {
              $query[] = '('. implode(' OR ', $queryor) .')';
              // A group of OR keywords only needs to match once
              //$matches += ($any > 0);
            }
          }
          // Single ANDed term
          else {
            list($q, $count) = self::_search_parse_query($key, $arguments2);
            if ($q) {
              $query[] = $q;
              $arguments[] = $key;
              $arguments[] = $key;
              // Each AND keyword needs to match at least once
              //$matches += $count;
            }
          }
        }
        // Negative matches
        foreach ($keys['negative'] as $key) {
          list($q) = self::_search_parse_query($key, $arguments2, TRUE);
          if ($q) {
            $query[] = $q;
            $arguments[] = $key;
            $arguments[] = $key;
          }
        }
        $query = implode(' AND ', $query);

        // Build word-index conditions for the first pass
        //$query2 = substr(str_repeat("i.word = '%s' OR ", count($arguments2)), 0, -4);

        return array($query, $arguments, /*$query2, $arguments2, $matches*/);
Martyn Smith's avatar
Martyn Smith committed
1031
    }
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168

    /**
     * Helper function for search_parse_query();
     */
    private static function _search_parse_query(&$word, &$scores, $not = FALSE) {
      $count = 0;
      // Determine the scorewords of this word/phrase
      if (!$not) {
        $split = explode(' ', $word);
        foreach ($split as $s) {
          $num = is_numeric($s);
          if ($num || strlen($s) >= /*variable_get('minimum_word_size', 3)*/3) {
            $s = $num ? ((int)ltrim($s, '-0')) : $s;
            if (!isset($scores[$s])) {
              $scores[$s] = $s;
              $count++;
            }
          }
        }
      }
      // Return matching snippet and number of added words
      return array("a.title ". ($not ? 'NOT ' : '') ."LIKE '%' || ? || '%'" . ($not ? ' AND ' : ' OR ') . 'a.description ' . ($not ? 'NOT ' : '') . "LIKE '%' || ? || '%'", $count);
    }

    /**
     * Simplifies a string according to indexing rules.
     */
    private static function search_simplify($text) {
      // Decode entities to UTF-8
      $text = self::decode_entities($text);
    
      // Lowercase
      $text = strtolower($text);
    
      // Call an external processor for word handling.
      //search_preprocess($text);
    
      // Simple CJK handling
      //if (variable_get('overlap_cjk', TRUE)) {
      //  $text = preg_replace_callback('/['. PREG_CLASS_CJK .']+/u', 'search_expand_cjk', $text);
      //}
    
      // To improve searching for numerical data such as dates, IP addresses
      // or version numbers, we consider a group of numerical characters
      // separated only by punctuation characters to be one piece.
      // This also means that searching for e.g. '20/03/1984' also returns
      // results with '20-03-1984' in them.
      // Readable regexp: ([number]+)[punctuation]+(?=[number])
      $text = preg_replace('/(['. PREG_CLASS_NUMBERS .']+)['. PREG_CLASS_PUNCTUATION .']+(?=['. PREG_CLASS_NUMBERS .'])/u', '\1', $text);
    
      // The dot, underscore and dash are simply removed. This allows meaningful
      // search behaviour with acronyms and URLs.
      $text = preg_replace('/[._-]+/', '', $text);
    
      // With the exception of the rules above, we consider all punctuation,
      // marks, spacers, etc, to be a word boundary.
      $text = preg_replace('/['. PREG_CLASS_SEARCH_EXCLUDE . ']+/u', ' ', $text);
    
      return $text;
    }

    /**
     * Decode all HTML entities (including numerical ones) to regular UTF-8 bytes.
     * Double-escaped entities will only be decoded once ("&amp;lt;" becomes "&lt;", not "<").
     *
     * @param $text
     *   The text to decode entities in.
     * @param $exclude 
     *   An array of characters which should not be decoded. For example,
     *   array('<', '&', '"'). This affects both named and numerical entities.
     */
    function decode_entities($text, $exclude = array()) {
      static $table;
      // We store named entities in a table for quick processing.
      if (!isset($table)) { 
        // Get all named HTML entities. 
        $table = array_flip(get_html_translation_table(HTML_ENTITIES));
        // PHP gives us ISO-8859-1 data, we need UTF-8.
        $table = array_map('utf8_encode', $table);
        // Add apostrophe (XML)
        $table['&apos;'] = "'";
      }
      $newtable = array_diff($table, $exclude);

      // Use a regexp to select all entities in one pass, to avoid decoding double-escaped entities twice.
      return preg_replace('/&(#x?)?([A-Za-z0-9]+);/e', '_decode_entities("$1", "$2", "$0", $newtable, $exclude)', $text);
    }

    /**
     * Helper function for decode_entities
     */
    function _decode_entities($prefix, $codepoint, $original, &$table, &$exclude) {
      // Named entity
      if (!$prefix) {
        if (isset($table[$original])) {
          return $table[$original];
        }
        else {
          return $original;
        } 
      }   
      // Hexadecimal numerical entity
      if ($prefix == '#x') {
        $codepoint = base_convert($codepoint, 16, 10);
      } 
      // Decimal numerical entity (strip leading zeros to avoid PHP octal notation)
      else {
        $codepoint = preg_replace('/^0+/', '', $codepoint);
      }
      // Encode codepoint as UTF-8 bytes
      if ($codepoint < 0x80) {
        $str = chr($codepoint);
      }
      else if ($codepoint < 0x800) {
        $str = chr(0xC0 | ($codepoint >> 6))
             . chr(0x80 | ($codepoint & 0x3F));
      }
      else if ($codepoint < 0x10000) {
        $str = chr(0xE0 | ( $codepoint >> 12))
             . chr(0x80 | (($codepoint >> 6) & 0x3F))
             . chr(0x80 | ( $codepoint       & 0x3F));
      }
      else if ($codepoint < 0x200000) {
        $str = chr(0xF0 | ( $codepoint >> 18))
             . chr(0x80 | (($codepoint >> 12) & 0x3F))
             . chr(0x80 | (($codepoint >> 6)  & 0x3F))
             . chr(0x80 | ( $codepoint        & 0x3F));
      }
      // Check for excluded characters
      if (in_array($str, $exclude)) {
        return $original;
      }
      else { 
        return $str;
      }
    }

Martyn Smith's avatar
Martyn Smith committed
1169
1170
}

1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
/**
 * Matches Unicode character classes to exclude from the search index.
 *
 * See: http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values
 *
 * The index only contains the following character classes:
 * Lu     Letter, Uppercase
 * Ll     Letter, Lowercase
 * Lt     Letter, Titlecase
 * Lo     Letter, Other
 * Nd     Number, Decimal Digit
 * No     Number, Other
 */
define('PREG_CLASS_SEARCH_EXCLUDE',
'\x{0}-\x{2f}\x{3a}-\x{40}\x{5b}-\x{60}\x{7b}-\x{bf}\x{d7}\x{f7}\x{2b0}-'.
'\x{385}\x{387}\x{3f6}\x{482}-\x{489}\x{559}-\x{55f}\x{589}-\x{5c7}\x{5f3}-'.
'\x{61f}\x{640}\x{64b}-\x{65e}\x{66a}-\x{66d}\x{670}\x{6d4}\x{6d6}-\x{6ed}'.
'\x{6fd}\x{6fe}\x{700}-\x{70f}\x{711}\x{730}-\x{74a}\x{7a6}-\x{7b0}\x{901}-'.
'\x{903}\x{93c}\x{93e}-\x{94d}\x{951}-\x{954}\x{962}-\x{965}\x{970}\x{981}-'.
'\x{983}\x{9bc}\x{9be}-\x{9cd}\x{9d7}\x{9e2}\x{9e3}\x{9f2}-\x{a03}\x{a3c}-'.
'\x{a4d}\x{a70}\x{a71}\x{a81}-\x{a83}\x{abc}\x{abe}-\x{acd}\x{ae2}\x{ae3}'.
'\x{af1}-\x{b03}\x{b3c}\x{b3e}-\x{b57}\x{b70}\x{b82}\x{bbe}-\x{bd7}\x{bf0}-'.
'\x{c03}\x{c3e}-\x{c56}\x{c82}\x{c83}\x{cbc}\x{cbe}-\x{cd6}\x{d02}\x{d03}'.
'\x{d3e}-\x{d57}\x{d82}\x{d83}\x{dca}-\x{df4}\x{e31}\x{e34}-\x{e3f}\x{e46}-'.
'\x{e4f}\x{e5a}\x{e5b}\x{eb1}\x{eb4}-\x{ebc}\x{ec6}-\x{ecd}\x{f01}-\x{f1f}'.
'\x{f2a}-\x{f3f}\x{f71}-\x{f87}\x{f90}-\x{fd1}\x{102c}-\x{1039}\x{104a}-'.
'\x{104f}\x{1056}-\x{1059}\x{10fb}\x{10fc}\x{135f}-\x{137c}\x{1390}-\x{1399}'.
'\x{166d}\x{166e}\x{1680}\x{169b}\x{169c}\x{16eb}-\x{16f0}\x{1712}-\x{1714}'.
'\x{1732}-\x{1736}\x{1752}\x{1753}\x{1772}\x{1773}\x{17b4}-\x{17db}\x{17dd}'.
'\x{17f0}-\x{180e}\x{1843}\x{18a9}\x{1920}-\x{1945}\x{19b0}-\x{19c0}\x{19c8}'.
'\x{19c9}\x{19de}-\x{19ff}\x{1a17}-\x{1a1f}\x{1d2c}-\x{1d61}\x{1d78}\x{1d9b}-'.
'\x{1dc3}\x{1fbd}\x{1fbf}-\x{1fc1}\x{1fcd}-\x{1fcf}\x{1fdd}-\x{1fdf}\x{1fed}-'.
'\x{1fef}\x{1ffd}-\x{2070}\x{2074}-\x{207e}\x{2080}-\x{2101}\x{2103}-\x{2106}'.
'\x{2108}\x{2109}\x{2114}\x{2116}-\x{2118}\x{211e}-\x{2123}\x{2125}\x{2127}'.
'\x{2129}\x{212e}\x{2132}\x{213a}\x{213b}\x{2140}-\x{2144}\x{214a}-\x{2b13}'.
'\x{2ce5}-\x{2cff}\x{2d6f}\x{2e00}-\x{3005}\x{3007}-\x{303b}\x{303d}-\x{303f}'.
'\x{3099}-\x{309e}\x{30a0}\x{30fb}-\x{30fe}\x{3190}-\x{319f}\x{31c0}-\x{31cf}'.
'\x{3200}-\x{33ff}\x{4dc0}-\x{4dff}\x{a015}\x{a490}-\x{a716}\x{a802}\x{a806}'.
'\x{a80b}\x{a823}-\x{a82b}\x{d800}-\x{f8ff}\x{fb1e}\x{fb29}\x{fd3e}\x{fd3f}'.
'\x{fdfc}-\x{fe6b}\x{feff}-\x{ff0f}\x{ff1a}-\x{ff20}\x{ff3b}-\x{ff40}\x{ff5b}-'.
'\x{ff65}\x{ff70}\x{ff9e}\x{ff9f}\x{ffe0}-\x{fffd}');

/**
 * Matches all 'N' Unicode character classes (numbers)
 */
define('PREG_CLASS_NUMBERS',
'\x{30}-\x{39}\x{b2}\x{b3}\x{b9}\x{bc}-\x{be}\x{660}-\x{669}\x{6f0}-\x{6f9}'.
'\x{966}-\x{96f}\x{9e6}-\x{9ef}\x{9f4}-\x{9f9}\x{a66}-\x{a6f}\x{ae6}-\x{aef}'.
'\x{b66}-\x{b6f}\x{be7}-\x{bf2}\x{c66}-\x{c6f}\x{ce6}-\x{cef}\x{d66}-\x{d6f}'.
'\x{e50}-\x{e59}\x{ed0}-\x{ed9}\x{f20}-\x{f33}\x{1040}-\x{1049}\x{1369}-'.
'\x{137c}\x{16ee}-\x{16f0}\x{17e0}-\x{17e9}\x{17f0}-\x{17f9}\x{1810}-\x{1819}'.
'\x{1946}-\x{194f}\x{2070}\x{2074}-\x{2079}\x{2080}-\x{2089}\x{2153}-\x{2183}'.
'\x{2460}-\x{249b}\x{24ea}-\x{24ff}\x{2776}-\x{2793}\x{3007}\x{3021}-\x{3029}'.
'\x{3038}-\x{303a}\x{3192}-\x{3195}\x{3220}-\x{3229}\x{3251}-\x{325f}\x{3280}-'.
'\x{3289}\x{32b1}-\x{32bf}\x{ff10}-\x{ff19}');

/**
 * Matches all 'P' Unicode character classes (punctuation)
 */
define('PREG_CLASS_PUNCTUATION',
'\x{21}-\x{23}\x{25}-\x{2a}\x{2c}-\x{2f}\x{3a}\x{3b}\x{3f}\x{40}\x{5b}-\x{5d}'.
'\x{5f}\x{7b}\x{7d}\x{a1}\x{ab}\x{b7}\x{bb}\x{bf}\x{37e}\x{387}\x{55a}-\x{55f}'.
'\x{589}\x{58a}\x{5be}\x{5c0}\x{5c3}\x{5f3}\x{5f4}\x{60c}\x{60d}\x{61b}\x{61f}'.
'\x{66a}-\x{66d}\x{6d4}\x{700}-\x{70d}\x{964}\x{965}\x{970}\x{df4}\x{e4f}'.
'\x{e5a}\x{e5b}\x{f04}-\x{f12}\x{f3a}-\x{f3d}\x{f85}\x{104a}-\x{104f}\x{10fb}'.
'\x{1361}-\x{1368}\x{166d}\x{166e}\x{169b}\x{169c}\x{16eb}-\x{16ed}\x{1735}'.
'\x{1736}\x{17d4}-\x{17d6}\x{17d8}-\x{17da}\x{1800}-\x{180a}\x{1944}\x{1945}'.
'\x{2010}-\x{2027}\x{2030}-\x{2043}\x{2045}-\x{2051}\x{2053}\x{2054}\x{2057}'.
'\x{207d}\x{207e}\x{208d}\x{208e}\x{2329}\x{232a}\x{23b4}-\x{23b6}\x{2768}-'.
'\x{2775}\x{27e6}-\x{27eb}\x{2983}-\x{2998}\x{29d8}-\x{29db}\x{29fc}\x{29fd}'.
'\x{3001}-\x{3003}\x{3008}-\x{3011}\x{3014}-\x{301f}\x{3030}\x{303d}\x{30a0}'.
'\x{30fb}\x{fd3e}\x{fd3f}\x{fe30}-\x{fe52}\x{fe54}-\x{fe61}\x{fe63}\x{fe68}'.
'\x{fe6a}\x{fe6b}\x{ff01}-\x{ff03}\x{ff05}-\x{ff0a}\x{ff0c}-\x{ff0f}\x{ff1a}'.
'\x{ff1b}\x{ff1f}\x{ff20}\x{ff3b}-\x{ff3d}\x{ff3f}\x{ff5b}\x{ff5d}\x{ff5f}-'.
'\x{ff65}');

/**
 * Matches all CJK characters that are candidates for auto-splitting
 * (Chinese, Japanese, Korean).
 * Contains kana and BMP ideographs.
 */
define('PREG_CLASS_CJK', '\x{3041}-\x{30ff}\x{31f0}-\x{31ff}\x{3400}-\x{4db5}'.
'\x{4e00}-\x{9fbb}\x{f900}-\x{fad9}');

Martyn Smith's avatar
Martyn Smith committed
1255
?>