lib.php 42.1 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
35
36
37
 * Mahara database.
 */
class PluginSearchInternal extends PluginSearch {

    /**
     * Implement user searching with SQL
     *
38
39
     * NOTE: user with ID zero should never be returned
     *
Martyn Smith's avatar
Martyn Smith committed
40
41
42
     * @param string  The query string
     * @param integer How many results to return
     * @param integer What result to start at (0 == first result)
43
44
45
46
     * @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)
47
     *             'exclude'=> int     // excludes a user
Martyn Smith's avatar
Martyn Smith committed
48
49
50
51
52
     * @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
53
     *               data    => array(   // the result records
Martyn Smith's avatar
Martyn Smith committed
54
     *                   array(
55
56
57
58
59
60
61
     *                       id            => integer,
     *                       username      => string,
     *                       institution   => string,
     *                       firstname     => string,
     *                       lastname      => string,
     *                       preferredname => string,
     *                       email         => string,
Martyn Smith's avatar
Martyn Smith committed
62
63
     *                   ),
     *                   array(
64
65
66
67
68
69
70
     *                       id            => integer,
     *                       username      => string,
     *                       institution   => string,
     *                       firstname     => string,
     *                       lastname      => string,
     *                       preferredname => string,
     *                       email         => string,
Martyn Smith's avatar
Martyn Smith committed
71
72
73
74
75
     *                   ),
     *                   array(...),
     *               ),
     *           );
     */
76
    public static function search_user($query_string, $limit, $offset = 0, $data=array()) {
77
78
        safe_require('artefact', 'internal');
        $publicfields = array_keys(ArtefactTypeProfile::get_public_fields());
79
80
81
        if (empty($publicfields)) {
            $publicfields = array('preferredname');
        }
82
        if (is_postgres()) {
83
            return self::search_user_pg($query_string, $limit, $offset, $data, $publicfields);
84
85
        } 
        else if (is_mysql()) {
86
            return self::search_user_my($query_string, $limit, $offset, $data, $publicfields);
87
88
        }
        else {
89
90
91
92
            throw new SQLException('search_user() is not implemented for your database engine (' . get_config('dbtype') . ')');
        }
    }

93
    public static function search_user_pg($query_string, $limit, $offset, $data, $publicfields) {
94
        $fieldlist = "('" . join("','", $publicfields) . "')";
95
        $sql = 'SELECT
96
97
                COUNT(DISTINCT u.id)
            FROM
98
99
                {usr} u
                LEFT JOIN {artefact} a ON u.id=a.owner
100
101
102
103
104
105
106
107
108
                ';
        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)
                    ';
            }
        }
109
110
        $querydata = split(' ', preg_replace('/\s\s+/', ' ', strtolower(trim($query_string))));
        $namesql = '(
111
112
113
114
                        u.preferredname ILIKE \'%\' || ? || \'%\'
                    )
                    OR (
                        (u.preferredname IS NULL OR u.preferredname = \'\')
115
116
117
118
119
120
121
122
                        AND (
                            u.firstname ILIKE \'%\' || ? || \'%\'
                            OR u.lastname ILIKE \'%\' || ? || \'%\'
                        )
                    )
                    OR (
                        a.artefacttype IN ' . $fieldlist . '
                        AND ( a.title ILIKE \'%\' || ? || \'%\')
123
124
125
126
127
128
129
130
131
132
                    )';
        $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 . '
133
                )
134
                ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
135
            ';
136
        $count = get_field_sql($sql, $values);
137
138

        if ($count > 0) {
139
            $sql = 'SELECT DISTINCT ON (u.firstname, u.lastname, u.id)
140
                    u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.staff
141
142
                FROM {artefact} a
                    INNER JOIN {usr} u ON u.id = a.owner
143
144
145
146
147
148
149
150
151
152
                ';
            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
153
                    u.id <> 0 AND u.active = 1 AND u.deleted = 0
154
                    AND (' . $namesql . '
Martyn Smith's avatar
Martyn Smith committed
155
                    )
156
                    ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
157
                ORDER BY u.firstname, u.lastname, u.id';
158
            $data = get_records_sql_array($sql, $values, $offset, $limit);
159

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

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

178
    public static function search_user_my($query_string, $limit, $offset, $data, $publicfields) {
179
180
        $fieldlist = "('" . join("','", $publicfields) . "')";

181
        $sql = 'SELECT
182
                COUNT(DISTINCT u.id)
183
            FROM
184
185
                {usr} u
                LEFT JOIN {artefact} a ON u.id=a.owner
186
187
188
189
190
191
192
193
194
                ';
        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)
                    ';
            }
        }
195
196
        $querydata = split(' ', preg_replace('/\s\s+/', ' ', strtolower(trim($query_string))));
        $namesql = '(
197
198
199
200
                        u.preferredname LIKE \'%\' || ? || \'%\'
                    )
                    OR (
                        (u.preferredname IS NULL OR u.preferredname = \'\')
201
202
203
204
205
206
207
208
                        AND (
                            u.firstname LIKE \'%\' || ? || \'%\'
                            OR u.lastname LIKE \'%\' || ? || \'%\'
                        )
                    )
                    OR (
                        a.artefacttype IN ' . $fieldlist . '
                        AND ( a.title LIKE \'%\' || ? || \'%\')
209
210
211
212
213
214
215
216
217
218
                    )';
        $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 . '
219
                )
220
                ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
221
            ';
222

223
        $count = get_field_sql($sql, $values);
224
        if ($count > 0) {
225
226
227
228
229
            // @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.
230
            $sql = 'SELECT DISTINCT
231
                    u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.staff
232
233
                FROM {artefact} a
                    INNER JOIN {usr} u ON u.id = a.owner
234
235
236
237
238
239
240
241
242
243
                    ';
            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
244
                    u.id <> 0 AND u.active = 1 AND u.deleted = 0
245
                    AND ( ' . $namesql . '
246
                    )
247
                    ' . (isset($data['exclude']) ? 'AND u.id != ' . $data['exclude'] : '') . '
248
                ORDER BY u.firstname, u.lastname, u.id';
249
            $data = get_records_sql_array($sql, $values, $offset, $limit);
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
            if ($data) {
                foreach ($data as &$item) {
                    $item = (array)$item;
                }
            }
        }
        else {
            $data = false;
        }

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
            'data'    => $data,
        );
    }
Nigel McNie's avatar
Nigel McNie committed
267
    
268

269
270
    private static function match_expression($op, $string, &$values, $ilike) {
        switch ($op) {
271
272
        case 'starts':
            $values[] = $string;
273
            return ' ' . $ilike . ' ? || \'%\'';
274
275
276
277
278
        case 'equals':
            $values[] = $string;
            return ' = ? ';
        case 'contains':
            $values[] = $string;
279
            return ' ' . $ilike . ' \'%\' || ? || \'%\'';
280
281
282
283
284
285
        case 'in':
            return ' IN (' . join(',', array_map('db_quote',$string)) . ')';
        }
    }


286
    public static function admin_search_user($queries, $constraints, $offset, $limit, 
287
                                             $sortfield, $sortdir) {
288
        $sort = $sortfield . ' ' . strtoupper($sortdir);
289
        $where = 'WHERE u.id <> 0 AND u.deleted = 0';
290
291
        $values = array();

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

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

Richard Mansfield's avatar
Richard Mansfield committed
297
        if (!empty($queries)) {
298
299
            $where .= ' AND ( ';
            $str = array();
Richard Mansfield's avatar
Richard Mansfield committed
300
            foreach ($queries as $f) {
301
                $str[] = 'u.' . $f['field'] 
302
                    . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
303
304
305
306
            }
            $where .= join(' OR ', $str) . ') ';
        } 

307
308
309
        // @todo: Institution stuff is messy and will probably need to
        // be rewritten when we get multiple institutions per user

310
        $requested = false;
311
        $institutionsearch = '';
Richard Mansfield's avatar
Richard Mansfield committed
312
313
        if (!empty($constraints)) {
            foreach ($constraints as $f) {
314
315
316
317
318
319
                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 ';
320
                    }
321
322
                    if ($f['field'] == 'institution_requested') {
                        $where .= ' AND ( i.institution ' .
323
                            PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike) .
324
                            ' OR ir.institution ' .
325
                            PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike) . ')';
326
                        $requested = true;
327
328
329
330
331
                    } else {
                        if ($f['string'] == 'mahara') {
                            $where .= ' AND i.institution IS NULL';
                        } else {
                            $where .= ' AND i.institution'
332
                                . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
333
                        }
334
                    }
335
                } else {
336
                    $where .= ' AND u.' . $f['field'] 
337
                        . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
338
                }
339
            }
340
        }
341
        if (strpos($sort, 'institution') === 0) {
342
            $sort = 'i.' . $sort;
343
344
            if ($institutionsearch == '') {
                $institutionsearch = ' LEFT OUTER JOIN {usr_institution} i ON i.usr = u.id ';
345
            }
346
347
        }

348
        $count = get_field_sql('SELECT COUNT(*) FROM {usr} u ' . $institutionsearch . $where, $values);
349
350

        if ($count > 0) {
351
            $data = get_records_sql_assoc('
352
                SELECT 
353
                    u.id, u.firstname, u.lastname, u.username, u.email, u.staff,
354
                    u.active, NOT u.suspendedcusr IS NULL as suspended
355
                FROM
356
                    {usr} u ' . $institutionsearch . $where . '
357
                ORDER BY ' . $sort,
358
                $values,
Richard Mansfield's avatar
Richard Mansfield committed
359
360
                $offset,
                $limit);
361
362

            if ($data) {
363
364
365
366
367
368
369
370
                $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;
                    }
                }
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
                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;
                            }
                        }
                    }
                }
386
387
388
                foreach ($data as &$item) {
                    $item = (array)$item;
                }
389
                $data = array_values($data);
390
391
392
393
394
395
396
397
            }
        }
        else {
            $data = false;
        }

        return array(
            'count'   => $count,
Richard Mansfield's avatar
Richard Mansfield committed
398
399
            'limit'   => $limit,
            'offset'  => $offset,
400
401
402
403
            'data'    => $data,
        );
    }

404
405
406
407
408
409
410
411
412
413
414


    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)) {
415
416
417
418
419
420
421
            $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() . ' \'%\' || ? || \'%\'';
            }
422
            $where .= '
423
                AND (' . join(' OR ', $words) . ') ';
424
425
        }

426
        $studentid = '';
427
428
429
430
431
432
        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';
433
            $studentid = ', member.studentid';
434
        }
435
        if (!is_null($institution->requested) || !is_null($institution->invitedby)) {
436
437
438
439
440
441
442
443
444
            $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)';
                }
445
                $studentid = ', req.studentid';
446
            }
447
            if (!is_null($institution->invitedby)) {
448
449
450
451
452
453
454
455
456
457
458
459
460
461
                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, 
462
                    u.admin, u.staff' . $studentid . $sql . $where . '
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
                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,
        );
    }





487
488
489
490
491
492
    /**
     * 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)
493
     * @param string  Which groups to search (all, member, notmember)
494
495
496
497
498
499
500
     * @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
501
     *                       id            => integer,
502
503
504
505
506
507
     *                       name          => string,
     *                       description   => string,
     *                       jointype      => string,
     *                       owner         => string,
     *                       ctime         => string,
     *                       mtime         => string,
Nigel McNie's avatar
Nigel McNie committed
508
509
510
     *                   ),
     *                   array(
     *                       id            => integer,
511
512
513
514
515
516
     *                       name          => string,
     *                       description   => string,
     *                       jointype      => string,
     *                       owner         => string,
     *                       ctime         => string,
     *                       mtime         => string,
Nigel McNie's avatar
Nigel McNie committed
517
518
519
520
521
     *                   ),
     *                   array(...),
     *               ),
     *           );
     */
522
    public static function search_group($query_string, $limit, $offset=0, $type='member') {
523
        if (is_postgres()) {
524
            return self::search_group_pg($query_string, $limit, $offset, $type);
525
526
        } 
        else if (is_mysql()) {
527
            return self::search_group_my($query_string, $limit, $offset, $type);
528
529
        } 
        else {
530
            throw new SQLException('search_group() is not implemented for your database engine (' . get_config('dbtype') . ')');
Martyn Smith's avatar
Martyn Smith committed
531
        }
532
533
    }

534
    public static function search_group_pg($query_string, $limit, $offset, $type) {
535
536
537
538
539
        global $USER;
        $sql = "
            SELECT
                id, name, description, jointype, owner, ctime, mtime
            FROM
540
                {group}
541
542
543
            WHERE (
                name ILIKE '%' || ? || '%' 
                OR description ILIKE '%' || ? || '%' 
544
545
            ) AND deleted = ? ";
        $values = array($query_string, $query_string, 0);
546
547
        if ($type == 'member') {
            $sql .=  'AND (
548
                owner = ? OR id IN (
549
                    SELECT "group" FROM {group_member} WHERE member = ?
550
                )
551
            )';
552
553
554
            $values[] = $USER->get('id');
            $values[] = $USER->get('id');
        }
555
556
557
558
559
560
561
562
563
564
        else if ($type == 'notmember') {
            $sql .=  'AND (
                owner != ? AND id NOT IN (
                    SELECT "group" FROM {group_member} WHERE member = ?
                )
            )';
            $values[] = $USER->get('id');
            $values[] = $USER->get('id');
        }
        $sql .= 'ORDER BY name';
565
566
567
568
569
570
        $data = get_records_sql_array($sql, $values, $offset, $limit);

        $sql = "
            SELECT
                COUNT(*)
            FROM
571
                {group} u
572
573
574
            WHERE (
                name ILIKE '%' || ? || '%' 
                OR description ILIKE '%' || ? || '%' 
575
            ) AND deleted = ? ";
576
577
        if ($type == 'member') {
            $sql .= 'AND (
578
                    owner = ? OR id IN (
579
                        SELECT "group" FROM {group_member} WHERE member = ?
580
581
                    )
                )
582
            ';
583
        }
584
585
586
587
588
589
590
591
        else if ($type == 'notmember') {
            $sql .= 'AND (
                    owner != ? AND id NOT IN (
                        SELECT "group" FROM {group_member} WHERE member = ?
                    )
                )
            ';
        }
592
        $count = get_field_sql($sql, $values);
593
594
595
596
597
598
599
600
601

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

602
    public static function search_group_my($query_string, $limit, $offset, $type) {
603
604
605
606
607
        global $USER;
        $sql = "
            SELECT
                id, name, description, jointype, owner, ctime, mtime
            FROM
608
                {group}
609
610
611
            WHERE (
                name LIKE '%' || ? || '%' 
                OR description LIKE '%' || ? || '%' 
612
613
            ) AND deleted = ? ";
        $values = array($query_string, $query_string, 0);
614
        if ($type == 'member') {
615
            $sql .=  'AND (
616
                owner = ? OR id IN (
617
                    SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
618
                )
619
            )';
620
621
622
            $values[] = $USER->get('id');
            $values[] = $USER->get('id');
        }
623
624
625
        else if ($type == 'notmember') {
            $sql .=  "AND (
                owner != ? AND id NOT IN (
626
                    SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
627
628
629
630
631
632
                )
            )";
            $values[] = $USER->get('id');
            $values[] = $USER->get('id');
        }
        $sql .= 'ORDER BY name';
633
634
635
636
637
638
        $data = get_records_sql_array($sql, $values, $offset, $limit);

        $sql = "
            SELECT
                COUNT(*)
            FROM
639
                {group} u
640
641
642
            WHERE (
                name LIKE '%' || ? || '%' 
                OR description LIKE '%' || ? || '%' 
643
            ) AND deleted = ? ";
644
        if ($type == 'member') {
645
            $sql .= 'AND (
646
                    owner = ? OR id IN (
647
                        SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
648
649
                    )
                )
650
            ';
651
        }
652
653
654
        else if ($type == 'notmember') {
            $sql .= "AND (
                    owner != ? AND id NOT IN (
655
                        SELECT gm.group FROM {group_member} gm WHERE gm.member = ?
656
657
                    )
                )
658
659
660
            ";
        }
        $count = get_field_sql($sql, $values);
Martyn Smith's avatar
Martyn Smith committed
661
662
663
664
665

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
666
            'data'    => $data,
Martyn Smith's avatar
Martyn Smith committed
667
668
        );
    }
Martyn Smith's avatar
Martyn Smith committed
669
670
671
672
673
674
675
676
677
678
679

    /**
     * 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.
     *
680
681
682
     * 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
683
684
685
686
687
688
     * @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).
     * 
     */
689
690
    public static function self_search($querystring, $limit, $offset, $type = 'all') {
        global $USER;
691
692
693
694
        if (trim($querystring) == '') {
            return false;
        }

695
696
697
698
699
        // Tokenise the search
        $querydata = self::search_parse_query($querystring);

        $sql = "
            SELECT
700
                a.id, a.artefacttype, a.title, a.description
701
            FROM
702
                {artefact} a
703
            LEFT JOIN {artefact_tag} at ON (at.artefact = a.id)
704
            WHERE
705
706
707
708
709
710
                a.owner = ?
            AND (
                ($querydata[0])
                OR
                (LOWER(at.tag) = ?)
            )";
711
712
713
714
        $count_sql = "
            SELECT
                COUNT(*)
            FROM
715
                {artefact} a
716
            LEFT JOIN {artefact_tag} at ON (at.artefact = a.id)
717
            WHERE
718
719
720
721
722
723
                a.owner = ?
            AND (
                ($querydata[0])
                OR
                (LOWER(at.tag) = ?)
            )";
724
        array_unshift($querydata[1], $USER->get('id'));
725
726
        array_push($querydata[1], $querystring);

727
728
729
730
731
732
733
        $results = array(
            'data'   => get_records_sql_array($sql, $querydata[1], $offset, $limit),
            'offset' => $offset,
            'limit'  => $limit,
            'count'  => get_field_sql($count_sql, $querydata[1])
        );

734
735
736
737
738
739
740
        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;
                    }
741
                }
742
743
744
745
746
747
748
749
750
751
                $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;
752
            }
753
754

            self::self_search_make_links($results);
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
        }

        return $results;
    }


    /**
     * 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
876
    }
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
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

    /**
     * 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
1014
1015
}

1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
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
/**
 * 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
1100
?>