lib.php 55.8 KB
Newer Older
Martyn Smith's avatar
Martyn Smith committed
1
2
3
4
5
<?php
/**
 *
 * @package    mahara
 * @subpackage search-internal
6
 * @author     Catalyst IT Ltd
7
8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
Martyn Smith's avatar
Martyn Smith committed
9
10
11
12
 *
 */

defined('INTERNAL') || die();
13
require_once(get_config('docroot') . 'search/lib.php');
Martyn Smith's avatar
Martyn Smith committed
14
15

/**
16
 * The internal search plugin which searches against the
Martyn Smith's avatar
Martyn Smith committed
17
18
19
20
 * Mahara database.
 */
class PluginSearchInternal extends PluginSearch {

21
22
23
24
25
26
27
28
29
30
31
    /**
     * This function indicates whether the plugin should take the raw $query string
     * when its group_search_user function is called, or whether it should get the
     * parsed query string.
     *
     * @return boolean
     */
    public static function can_process_raw_group_search_user_queries() {
        return true;
    }

32
33
34
35
    public static function can_be_disabled() {
        return false;
    }

36
37
38
39
40
41
    public static function has_config() {
        return true;
    }

    public static function get_config_options() {
        return array(
42
            'class' => 'panel panel-body',
43
44
45
            'elements'   => array(
                'exactusersearch' =>  array(
                    'title'        => get_string('exactusersearch', 'search.internal'),
46
                    'description'  => get_string('exactusersearchdescription1', 'search.internal'),
47
                    'help'         => true,
48
                    'type'         => 'switchbox',
49
50
51
52
53
54
                    'defaultvalue' => get_config_plugin('search', 'internal', 'exactusersearch'),
                ),
            ),
        );
    }

Son Nguyen's avatar
Son Nguyen committed
55
    public static function save_config_options(Pieform $form, $values) {
56
57
58
59
60
61
62
63
64
        set_config_plugin('search', 'internal', 'exactusersearch', (int) $values['exactusersearch']);
    }

    public static function postinst($prevversion) {
        if ($prevversion == 0) {
            set_config_plugin('search', 'internal', 'exactusersearch', 1);
        }
    }

Martyn Smith's avatar
Martyn Smith committed
65
66
67
    /**
     * Implement user searching with SQL
     *
68
69
     * NOTE: user with ID zero should never be returned
     *
Martyn Smith's avatar
Martyn Smith committed
70
71
72
     * @param string  The query string
     * @param integer How many results to return
     * @param integer What result to start at (0 == first result)
73
74
     * @param data    Filters the users searched by
     *                can contain:
75
     *             'friends' => boolean     // only return $USER's friends
76
77
     *             'group' => integer, // only users in this group
     *             'owner' => boolean  // include the group ownwer (only if group is set)
78
     *             'exclude'=> int     // excludes a user
Martyn Smith's avatar
Martyn Smith committed
79
80
81
82
83
     * @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
84
     *               data    => array(   // the result records
Martyn Smith's avatar
Martyn Smith committed
85
     *                   array(
86
87
88
89
90
91
92
     *                       id            => integer,
     *                       username      => string,
     *                       institution   => string,
     *                       firstname     => string,
     *                       lastname      => string,
     *                       preferredname => string,
     *                       email         => string,
Martyn Smith's avatar
Martyn Smith committed
93
94
     *                   ),
     *                   array(
95
96
97
98
99
100
101
     *                       id            => integer,
     *                       username      => string,
     *                       institution   => string,
     *                       firstname     => string,
     *                       lastname      => string,
     *                       preferredname => string,
     *                       email         => string,
Martyn Smith's avatar
Martyn Smith committed
102
103
104
105
106
     *                   ),
     *                   array(...),
     *               ),
     *           );
     */
107
    public static function search_user($query_string, $limit, $offset = 0, $data=array()) {
108
        global $USER;
Richard Mansfield's avatar
Richard Mansfield committed
109

110
        $data = self::prepare_search_user_options($data);
111
112
        $sql = '
            SELECT
Richard Mansfield's avatar
Richard Mansfield committed
113
114
                COUNT(u.id)
            FROM {usr} u';
115
        if (isset($data['group'])) {
116
117
118
            $groupadminsql = '';
            if (isset($data['includeadmins']) and !$data['includeadmins']) {
                $groupadminsql = " AND gm.role != 'admin'";
119
            }
120
121
122
123
            $groupjoin = '
                INNER JOIN {group_member} gm ON
                    (gm.member = u.id AND gm.group = ' . (int)$data['group'] . $groupadminsql . ")\n";
            $sql .= $groupjoin;
124
        }
125
126
127
128
129

        $where = '
            WHERE
                u.id != 0 AND u.active = 1 AND u.deleted = 0';

130
131
132
133
134
135
136
        if (!empty($data['friends'])) {
            // Only include friends in search
            $where .= ' AND u.id IN (
                SELECT usr1 FROM {usr_friend} f1 WHERE f1.usr2 = ' . $USER->get('id')
                . ' UNION SELECT usr2 FROM {usr_friend} f2 WHERE f2.usr1 = ' . $USER->get('id') . ')';
        }

137
138
139
140
141
142
143
144
        if (isset($data['institutions']) && !empty($data['institutions'])) {
            $where .= '
                AND u.id IN (
                    SELECT usr FROM {usr_institution} WHERE institution IN ('
                . join(',', array_map('db_quote', $data['institutions'])) . ')
                )';
        }

145
146
        $sql .= "
                LEFT OUTER JOIN {usr_account_preference} h ON (u.id = h.usr AND h.field = 'hiderealname')";
Richard Mansfield's avatar
Richard Mansfield committed
147

148
        list($namesql, $values) = self::name_search_sql($query_string);
Richard Mansfield's avatar
Richard Mansfield committed
149

150
        $where .= $namesql;
Richard Mansfield's avatar
Richard Mansfield committed
151
152
153
154
155
156

        if (isset($data['exclude'])) {
            $where .= '
                AND u.id != ?';
            $values[] = $data['exclude'];
        }
157

158
159
        $sql .= $where;
        $count = count_records_sql($sql, $values);
160

161
        $result = array(
Nigel McNie's avatar
Nigel McNie committed
162
163
164
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
165
            'data'    => false,
Nigel McNie's avatar
Nigel McNie committed
166
        );
167

168
169
        if ($count < 1) {
            return $result;
170
171
        }

Richard Mansfield's avatar
Richard Mansfield committed
172
173
        $sql = '
            SELECT
174
                u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.studentid, u.staff,
175
                u.admin, u.profileicon, u.urlid
Richard Mansfield's avatar
Richard Mansfield committed
176
            FROM {usr} u';
177

178
179
180
        if (isset($data['group'])) {
            $sql .= $groupjoin;
        }
181
182
        $sql .= "
                LEFT OUTER JOIN {usr_account_preference} h ON (u.id = h.usr AND h.field = 'hiderealname')";
183
184
185
186
187
188
189
190
191
192
193
194
195

        $sql .= $where . '
            ORDER BY ' . $data['orderby'];

        $result['data'] = get_records_sql_array($sql, $values, $offset, $limit);

        if ($result['data']) {
            foreach ($result['data'] as &$item) {
                $item = (array)$item;
            }
        }

        return $result;
196
    }
197

198
199
200
201
202
203
204


    /**
     * Returns a snippet of an sql WHERE clause to filter users whose (visible)
     * names match the terms in a given query string.
     */
    function name_search_sql($query_string, $usralias='u', $usrprefalias='h') {
205
        global $USER;
206
207
208
209
210
211
212
213
214
215

        safe_require('artefact', 'internal');

        // Get the list of searchable profile fields from the internal artefact
        $required   = array_keys(ArtefactTypeProfile::get_always_searchable_fields());
        $optional   = array_diff(array_keys(ArtefactTypeProfile::get_searchable_fields()), $required);
        $required[] = 'username'; // Not a profile field, but used in the search query.

        // Get a list of match expressions to use in the WHERE clause
        $matches = new StdClass;
216
        $valuecount = 0;
217
        foreach (array_merge($required, $optional) as $f) {
218
219
220
            list ($matchsql, $matchcount) = self::match_user_field_expression($f, $usralias);
            $matches->{$f} = $matchsql;
            $valuecount += $matchcount;
221
222
223
224
        }

        $querydata = self::split_query_string(strtolower(trim($query_string)));
        $hidenameallowed = get_config('userscanhiderealnames') ? 'TRUE' : 'FALSE';
225
        $searchusernamesallowed = $USER->get('admin') || $USER->get('staff') || !get_config('nousernames') ? 'TRUE' : 'FALSE';
226
227
228

        $termsql = "$matches->preferredname
                    OR (
229
                        ($usralias.preferredname IS NULL OR $usralias.preferredname = '' OR NOT $hidenameallowed OR $usrprefalias.value != '1' OR $usrprefalias.value IS NULL)
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
                        AND ($matches->firstname OR $matches->lastname)
                    )
                    OR ($searchusernamesallowed AND $matches->username)";

        if ($optional) {
            foreach ($optional as $f) {
                $termsql .= "
                    OR {$matches->$f}";
            }
        }

        $where = '';
        $values = array();
        foreach ($querydata as $term) {
            $where .= '
                AND (
                    ' . $termsql . '
                )';
248
            $values = array_pad($values, count($values) + $valuecount, $term);
249
250
251
252
253
254
255
        }

        return array($where, $values);
    }



Richard Mansfield's avatar
Richard Mansfield committed
256
    private static function match_user_field_expression($field, $alias) {
257
258
        $sql = '';
        $values = 0;
Richard Mansfield's avatar
Richard Mansfield committed
259
        if (get_config_plugin('search', 'internal', 'exactusersearch')) {
260
            if ($field == 'email') {
261
262
                $sql = '(LOWER(' . $alias . '.email) = ? OR (SELECT email FROM {artefact_internal_profile_email} ai WHERE ai.email = ? AND ai.owner = u.id AND ai.verified = 1) = ?)';
                $values = 3;
263
264
            }
            else {
265
266
                $sql = 'LOWER(' . $alias . '.' . $field . ') = ?';
                $values = 1;
267
268
            }
        }
269
270
271
272
273
274
275
276
277
        else {
            if ($field == 'email') {
                $sql = '(' . $alias . '.email ' . db_ilike() . " '%' || ? || '%' OR (SELECT email FROM {artefact_internal_profile_email} ai WHERE ai.email " . db_ilike() . " '%' || ? || '%' AND ai.owner = u.id AND ai.verified = 1 LIMIT 1) " . db_ilike() . " '%' ||  ? || '%')";
                $values = 3;
            }
            else {
                $sql = $alias . '.' . $field . ' ' . db_ilike() . " '%' || ? || '%'";
                $values = 1;
            }
Richard Mansfield's avatar
Richard Mansfield committed
278
        }
279
        return array($sql, $values);
Richard Mansfield's avatar
Richard Mansfield committed
280
281
    }

282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320

    /**
     * Split a query string into search terms.
     *
     * Contents of double-quoted strings are counted as a single term,
     * '"' can be entered as '\"', '\' as '\\'.
     */
    private static function split_query_string($query) {
        $terms = array();

        // Split string on unescaped double quotes
        $quotesplit = preg_split('/(?<!\\\)(\")/', $query, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);

        $inphrase = false;

        foreach ($quotesplit as $q) {
            if ($q == '"') {
                $inphrase = !$inphrase;
                continue;
            }

            // Remove escaping
            $q = preg_replace(array('/\x5C(?!\x5C)/u', '/\x5C\x5C/u'), array('','\\'), $q);
            if ($inphrase) {
                if ($trimmed = trim($q)) {
                    $terms[] = $trimmed;
                }
            }
            else {
                // Split unquoted sequences on spaces
                foreach (preg_split('/\s+/', $q, -1, PREG_SPLIT_NO_EMPTY) as $word) {
                    $terms[] = $word;
                }
            }
        }
        return $terms;
    }


321
    private static function prepare_search_user_options($options) {
322
        global $USER;
323
        if (isset($options['group'])) {
324
325
326
327
328
329
330
331
332
333
            // This option should only be used by group admins, so just ensure that the caller is
            // using it correctly.
            $roles = $USER->get('grouproles');
            if ($USER->get('admin') || $USER->get('staff')
                || (isset($roles[$options['group']]) && $roles[$options['group']] == 'admin')) {
                $options['group'] = intval($options['group']);
            }
            else {
                unset($options['group']);
            }
334
335
336
337
338
339
340
341
342
343
        }
        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';
        }
344
345
346
        if (isset($options['exclude'])) {
            $options['exclude'] = intval($options['exclude']);
        }
347
348
349
350
351
        if (isset($options['myinstitutions'])) {
            if ($institutions = array_keys($USER->get('institutions'))) {
                $options['institutions'] = $institutions;
            }
        }
352
353
        return $options;
    }
354

355

356
357
    private static function match_expression($op, $string, &$values, $ilike) {
        switch ($op) {
358
359
        case 'starts':
            $values[] = $string;
360
            return ' ' . $ilike . ' ? || \'%\'';
361
        case 'equals':
362
363
364
            if ($string === null) {
                return ' IS NULL ';
            }
365
366
            $values[] = $string;
            return ' = ? ';
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
        case 'notequals':
            if (is_null($string)) {
                return ' IS NOT NULL ';
            }
            $values[] = $string;
            return ' <> ? ';
        case 'greaterthan':
            $values[] = $string;
            return ' > ? ';
        case 'greaterthanequal':
            $values[] = $string;
            return ' >= ? ';
        case 'lessthan':
            $values[] = $string;
            return ' < ? ';
        case 'lessthanequal':
            $values[] = $string;
            return ' <= ? ';
385
386
        case 'contains':
            $values[] = $string;
387
            return ' ' . $ilike . ' \'%\' || ? || \'%\'';
388
389
390
391
392
393
        case 'in':
            return ' IN (' . join(',', array_map('db_quote',$string)) . ')';
        }
    }


394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
    /**
     * Returns a list of search results for the admin user search interface.
     *
     * The constraints parameter takes an array of arrays, like so:
     * $params = array(
     *     array(
     *         'field' => 'institution'
     *         'string' => 'mahara'
     *         'type' => 'equals'
     *     ),
     *     ...
     * )
     *
     * Each constraint should has these three keys:
     * field: Should be a column in the usr table, or the special field "duplicateemails" (which indicates only users with a non-unique email).
     *   also, for the field "institution", a string value of "mahara" indicates users with no institution
     * string: The value to compare the contents of that field against
     * type: The operation by which to compare "field" to "string". This can be any of the operations in PluginSearchInternal::match_expression
     *   (starts, equals, notequals, greaterthan, greaterthanequal, lessthan, lessthanequal, contains, or in)
     *
     * @param string $query_string The string to search for
     * @param array $constraints A list of constraints on the search results (see above for format)
     * @param int $offset
     * @param int $limit
     * @param string $sortfield Which of the output columns to sort by
     * @param string $sortdir DESC or ASC
     */
421
    public static function admin_search_user($query_string, $constraints, $offset, $limit,
422
                                             $sortfield, $sortdir) {
423
424
425
426
427
428
429
430
431
432
        $sort = 'TRUE';
        if (preg_match('/^[a-zA-Z_0-9"]+$/', $sortfield)) {
            $sort = $sortfield;
            if (strtoupper($sortdir) != 'DESC') {
                $sort .= ' ASC';
            }
            else {
                $sort .= ' DESC';
            }
        }
433
        $join = '';
434
        $where = 'WHERE u.id <> 0 AND u.deleted = 0';
435
436
        $values = array();

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

440
441
        // Generate the part that matches the search term
        $querydata = self::split_query_string(strtolower(trim($query_string)));
442

443
        $matches = array();
444
        $valuecount = 0;
445
        foreach (array('firstname', 'lastname', 'preferredname', 'username', 'email') as $f) {
446
447
448
            list ($matchsql, $matchcount) = self::match_user_field_expression($f, 'u');
            $matches[] = $matchsql;
            $valuecount += $matchcount;
449
450
451
452
453
454
455
456
457
458
        }

        $termsql = join(" OR ", $matches);

        $values = array();
        foreach ($querydata as $term) {
            $where .= '
                AND (
                    ' . $termsql . '
                )';
459
            $values = array_pad($values, count($values) + $valuecount, $term);
460
        }
461

462
        $firstcols = 'u.id';
Richard Mansfield's avatar
Richard Mansfield committed
463
464
        if (!empty($constraints)) {
            foreach ($constraints as $f) {
465
466
467
                if ($f['field'] == 'institution') {
                    if ($f['string'] == 'mahara') {
                        $where .= ' AND u.id NOT IN (SELECT usr FROM {usr_institution})';
468
                    }
469
470
471
472
473
474
                    else {
                        $where .= '
                            AND u.id IN (
                                SELECT usr FROM {usr_institution} WHERE institution '
                            . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike) . '
                            )';
475
                    }
476
477
478
479
480
481
482
483
484
485
486
487
                }
                else if ($f['field'] == 'duplicateemail') {
                    if (!empty($f['string'])) {
                        $where .= '
                            AND u.id IN (
                                SELECT owner
                                FROM {artefact}
                                WHERE id IN (' . join(',', array_map('db_quote', $f['string'])) . ')
                            )';
                    }
                    else {
                        // No duplicate email is found, return empty list
488
                        $where .= ' AND FALSE';
489
490
                    }
                }
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
                else if ($f['field'] == 'exportqueue') {
                    $firstcols = 'e.id AS eid,
                      (SELECT case WHEN e.starttime IS NOT NULL THEN ' . db_format_tsfield('e.starttime', false) . ' ELSE ' . db_format_tsfield('e.ctime', false) . ' END) AS status,
                      ' . $firstcols;
                    $join .= 'JOIN {export_queue} e ON e.usr = u.id ';
                    $where .= ' AND u.id'
                        . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
                }
                else if ($f['field'] == 'archivesubmissions') {
                    $firstcols = 'e.id AS eid, a.group,
                      (SELECT name FROM {group} WHERE id = a.group) AS submittedto,
                      (SELECT case WHEN a.externalid IS NOT NULL THEN a.externalid ELSE CAST(e.id AS char) END) AS specialid,
                      e.filetitle, e.filename, e.filepath, ' . db_format_tsfield('e.ctime', 'archivectime') . ', ' . $firstcols;
                    $join .= 'JOIN {export_archive} e ON e.usr = u.id ';
                    $join .= 'JOIN {archived_submissions} a ON a.archiveid = e.id ';
                    $where .= ' AND u.id'
                        . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
                }
509
                else {
510
                    $where .= ' AND u.' . $f['field']
511
                        . PluginSearchInternal::match_expression($f['type'], $f['string'], $values, $ilike);
512
                }
513
            }
514
515
        }

516
        $count = get_field_sql('SELECT COUNT(*) FROM {usr} u ' . $join . $where, $values);
517
518

        if ($count > 0) {
519

520
            $data = get_records_sql_assoc('
521
522
                SELECT ' . $firstcols . ',
                    u.firstname, u.lastname, u.preferredname, u.username, u.email, u.staff, u.profileicon,
523
                    u.lastlogin, u.active, NOT u.suspendedcusr IS NULL as suspended, au.instancename AS authname
524
                FROM {usr} u INNER JOIN {auth_instance} au ON u.authinstance = au.id ' . $join . $where . '
525
                ORDER BY ' . $sort . ', u.id',
526
                $values,
Richard Mansfield's avatar
Richard Mansfield committed
527
528
                $offset,
                $limit);
529
530

            if ($data) {
531
                $inst = get_records_select_array('usr_institution',
532
533
534
535
536
537
538
                                                 'usr IN (' . join(',', array_keys($data)) . ')',
                                                 null, '', 'usr,institution');
                if ($inst) {
                    foreach ($inst as $i) {
                        $data[$i->usr]->institutions[] = $i->institution;
                    }
                }
539
                foreach ($data as &$item) {
540
                    $item->username = display_username($item);
541
542
                    $item = (array)$item;
                }
543
                $data = array_values($data);
544
545
546
547
548
549
550
551
            }
        }
        else {
            $data = false;
        }

        return array(
            'count'   => $count,
Richard Mansfield's avatar
Richard Mansfield committed
552
553
            'limit'   => $limit,
            'offset'  => $offset,
554
555
556
557
            'data'    => $data,
        );
    }

558

559
    public static function group_search_user($group, $query_string, $constraints, $offset, $limit, $membershiptype, $order, $friendof, $orderbyoptionidx=null) {
560
561

        list($searchsql, $values) = self::name_search_sql($query_string);
562

563
        $orderbyoptions = array(
564
565
            'adminfirst' => 'gm.role = \'admin\' DESC, gm.role = \'tutor\' DESC,
                           CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.firstname END ASC,
566
567
568
569
570
571
572
573
574
575
576
577
578
579
                           CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.lastname END ASC, gm.ctime, u.id',
            'nameatoz' => 'CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.firstname END ASC,
                           CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.lastname END ASC, gm.ctime, u.id',
            'nameztoa' => 'CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.firstname END DESC,
                           CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.lastname END DESC, gm.ctime, u.id',
            'firstjoined' => 'gm.ctime ASC, CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.firstname END ASC,
                           CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.lastname END ASC, u.id',
            'lastjoined' => 'gm.ctime DESC, CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.firstname END ASC,
                           CASE WHEN NOT u.preferredname IS NULL AND u.preferredname <> \'\' THEN u.preferredname ELSE u.lastname END ASC, u.id'
        );
        if (! key_exists($orderbyoptionidx, $orderbyoptions)) {
            $orderbyoptionidx = 'adminfirst';
        }

580
581
        if ($membershiptype == 'nonmember') {
            $select = '
582
                    u.id, u.firstname, u.lastname, u.username, u.email, u.profileicon, u.staff, u.urlid, u.preferredname';
583
584
            $from = '
                FROM {usr} u
585
                    LEFT OUTER JOIN {usr_account_preference} h ON (u.id = h.usr AND h.field = \'hiderealname\')
586
587
588
589
                WHERE u.id > 0 AND u.deleted = 0 ' . $searchsql . '
                    AND NOT u.id IN (SELECT member FROM {group_member} gm WHERE gm.group = ?)';
            $values[] = $group;
            $orderby = 'u.firstname, u.lastname, u.id';
590
        }
591
592
        else if ($membershiptype == 'notinvited') {
            $select = '
593
                    u.id, u.firstname, u.lastname, u.username, u.email, u.profileicon, u.staff, u.urlid, u.preferredname';
594
595
            $from = '
                FROM {usr} u
596
                    LEFT OUTER JOIN {usr_account_preference} h ON (u.id = h.usr AND h.field = \'hiderealname\')
597
598
599
600
601
602
603
604
605
606
                WHERE u.id > 0 AND u.deleted = 0 ' . $searchsql . '
                    AND NOT u.id IN (SELECT member FROM {group_member} gm WHERE gm.group = ?)
                    AND NOT u.id IN (SELECT member FROM {group_member_invite} gmi WHERE gmi.group = ?)';
            $values[] = $group;
            $values[] = $group;
            $orderby = 'u.firstname, u.lastname, u.id';
        }
        else if ($membershiptype == 'request') {
            $select = '
                    u.id, u.firstname, u.lastname, u.username, u.email, u.profileicon,
607
                    u.staff, u.urlid, u.preferredname, ' . db_format_tsfield('gm.ctime', 'jointime');
608
609
            $from = '
                FROM {usr} u
610
                    INNER JOIN {group_member_request} gm ON (gm.member = u.id)
611
                    LEFT OUTER JOIN {usr_account_preference} h ON (u.id = h.usr AND h.field = \'hiderealname\')
612
                WHERE u.id > 0 AND u.deleted = 0 ' . $searchsql . '
613
                    AND gm.group = ?';
614
            $values[] = $group;
615
616
617
618
            if ($orderbyoptionidx == 'adminfirst') {
                $orderbyoptionidx = 'nameatoz';
            }
            $orderby = $orderbyoptions[$orderbyoptionidx];
619
620
621
622
        }
        else if ($membershiptype == 'invite') {
            $select = '
                    u.id, u.firstname, u.lastname, u.username, u.email, u.profileicon,
623
                    u.staff, u.urlid, u.preferredname, ' . db_format_tsfield('gm.ctime', 'jointime');
624
625
            $from = '
                FROM {usr} u
626
                    INNER JOIN {group_member_invite} gm ON (gm.member = u.id)
627
                    LEFT OUTER JOIN {usr_account_preference} h ON (u.id = h.usr AND h.field = \'hiderealname\')
628
                WHERE u.id > 0 AND u.deleted = 0 ' . $searchsql . '
629
                    AND gm.group = ?';
630
            $values[] = $group;
631
            $orderby = $orderbyoptions[$orderbyoptionidx];
632
633
634
        }
        else { // All group members
            $select = '
635
                    u.id, u.firstname, u.lastname, u.username, u.preferredname, u.email, u.profileicon,
636
                    u.staff, u.urlid, u.preferredname, ' . db_format_tsfield('gm.ctime', 'jointime') . ', gm.role';
637
638
639
            $from = '
                FROM {usr} u
                    INNER JOIN {group_member} gm ON (gm.member = u.id)
640
                    LEFT OUTER JOIN {usr_account_preference} h ON (u.id = h.usr AND h.field = \'hiderealname\')
641
642
643
                WHERE u.id > 0 AND u.deleted = 0 ' . $searchsql . '
                    AND gm.group = ?';
            $values[] = $group;
644
            $orderby = $orderbyoptions[$orderbyoptionidx];
645
646
647
            if ($order == 'latest') {
                $orderby = 'gm.ctime DESC, u.firstname, u.lastname, u.id';
            }
648
649
        }

650
        if ($order == 'random') {
651
652
653
            $orderby = db_random();
        }

654
655
656
657
658
659
660
661
        if ($friendof) {
            $from .= '
                    AND u.id IN (
                        SELECT usr1 FROM {usr_friend} WHERE usr2 = ? UNION SELECT usr2 FROM {usr_friend} WHERE usr1 = ?
                    )';
            array_push($values, $friendof, $friendof);
        }

662
        $count = get_field_sql('SELECT COUNT(*)' . $from, $values);
663
664
665

        if ($count > 0) {
            $data = get_records_sql_assoc('
666
                SELECT ' . $select . $from . ' ORDER BY ' . $orderby,
667
668
669
670
671
672
673
674
675
676
677
678
                $values,
                $offset,
                $limit);

            if ($data) {
                foreach ($data as &$item) {
                    $item = (array)$item;
                }
                $data = array_values($data);
            }
        }
        else {
679
            $data = array();
680
681
682
683
684
685
686
687
688
689
        }

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

690
691
692

    public static function institutional_admin_search_user($query, $institution, $limit) {
        $sql = '
693
            FROM {usr} u LEFT OUTER JOIN {usr_tag} t ON (t.usr = u.id) ';
694
695
696
697
698

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

        $values = array();
699
        if ($query != '') {
700
701
            $where .= 'AND (t.tag = LOWER(?) OR ';
            $values[] = $query;
702
703
704
705
706
707
708
            $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() . ' \'%\' || ? || \'%\'';
            }
709
            $where .= join(' OR ', $words) . ') ';
710
711
        }

712
        $studentid = '';
713
714
715
716
717
718
        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';
719
            $studentid = ', member.studentid';
720
        }
721
        if (!is_null($institution->requested) || !is_null($institution->invitedby)) {
722
723
724
725
726
727
728
729
730
            $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)';
                }
731
                $studentid = ', req.studentid';
732
            }
733
            if (!is_null($institution->invitedby)) {
734
                if ($institution->invitedby == 1) {
735
736
737
738
739
740
                    $where .= ' AND req.confirmedinstitution = 1';
                } else {
                    $where .= ' AND (req.confirmedinstitution = 0 OR req.confirmedinstitution IS NULL)';
                }
            }
        }
741
742
743
744
        if (!is_null($institution->lastinstitution)) {
            $where .= " AND t.tag = ?";
            $values[] = 'lastinstitution:' . $institution->lastinstitution;
        }
745
746
747
748
749

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

        if ($count > 0) {
            $data = get_records_sql_array('
750
751
                SELECT
                    u.id, u.firstname, u.lastname, u.username, u.preferredname,
752
                    u.admin, u.staff' . $studentid . $sql . $where . '
753
                GROUP BY u.id, u.firstname, u.lastname, u.username, u.preferredname, u.admin, u.staff' . $studentid . '
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
                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,
        );
    }





778
779
780
781
782
783
    /**
     * 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)
784
     * @param string  Which groups to search (all, member, notmember)
785
786
787
788
789
790
791
     * @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
792
     *                       id            => integer,
793
794
795
796
797
798
     *                       name          => string,
     *                       description   => string,
     *                       jointype      => string,
     *                       owner         => string,
     *                       ctime         => string,
     *                       mtime         => string,
Nigel McNie's avatar
Nigel McNie committed
799
800
801
     *                   ),
     *                   array(
     *                       id            => integer,
802
803
804
805
806
807
     *                       name          => string,
     *                       description   => string,
     *                       jointype      => string,
     *                       owner         => string,
     *                       ctime         => string,
     *                       mtime         => string,
Nigel McNie's avatar
Nigel McNie committed
808
809
810
811
812
     *                   ),
     *                   array(...),
     *               ),
     *           );
     */
813
    public static function search_group($query_string, $limit, $offset=0, $type='member', $category='') {
814
        global $USER;
815
816
        $data = array();

817
818
        $sql = "
            FROM
819
                {group}
820
            WHERE (
821
822
                name " . db_ilike() . " '%' || ? || '%'
                OR description " . db_ilike() . " '%' || ? || '%'
823
824
825
            ) AND deleted = 0 ";
        $values = array($query_string, $query_string);

826
827
828
829
        if (!$grouproles = join(',', array_keys($USER->get('grouproles')))) {
            $grouproles = '-1';
        }

830
831
        $canseehidden = $USER->get('admin') || $USER->get('staff');

832
        if ($type == 'member') {
833
            $sql .=  'AND id IN (' . $grouproles . ')';
834
        }
835
        else if ($type == 'notmember') {
836
            $sql .= 'AND id NOT IN (' . $grouproles . ')';
837
        }
838
        else if ($type == 'canjoin') {
839
840
            $sql .= 'AND (jointype != ? AND NOT (jointype = ? AND request = 0)) AND id NOT IN (' . $grouproles . ')';
            $values = array_merge($values, array('controlled', 'approve'));
841
842
843
        }

        if (!$canseehidden) {
844
845
846
            $sql .= ' AND (hidden = 0 OR id IN (' . $grouproles . '))';
        }

847
        if (!empty($category)) {
Dan Marsden's avatar
Dan Marsden committed
848
            if ($category == -1) { //find unassigned groups
849
                $sql .= " AND category IS NULL";
Dan Marsden's avatar
Dan Marsden committed
850
            } else {
851
852
                $sql .= ' AND category = ?';
                $values[] = $category;
Dan Marsden's avatar
Dan Marsden committed
853
            }
854
        }
855

856
857
858
        $count = get_field_sql('SELECT COUNT(*) '.$sql, $values);

        if ($count > 0) {
859
            $sql = 'SELECT id, name, description, grouptype, jointype, request, public, ctime, mtime, category, urlid ' . $sql . ' ORDER BY name';
860
            $data = get_records_sql_array($sql, $values, $offset, $limit);
861
        }
Martyn Smith's avatar
Martyn Smith committed
862
863
864
865
866

        return array(
            'count'   => $count,
            'limit'   => $limit,
            'offset'  => $offset,
867
            'data'    => $data,
Martyn Smith's avatar
Martyn Smith committed
868
869
        );
    }
Martyn Smith's avatar
Martyn Smith committed
870
871
872
873
874
875
876
877
878
879
880

    /**
     * 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.
     *
881
882
883
     * 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
884
885
886
887
     * @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).
888
     *
Martyn Smith's avatar
Martyn Smith committed
889
     */
890
891
    public static function self_search($querystring, $limit, $offset, $type = 'all') {
        global $USER;
892
893
894
895
        if (trim($querystring) == '') {
            return false;
        }

896
897
898
899
900
        // Tokenise the search
        $querydata = self::search_parse_query($querystring);

        $sql = "
            SELECT
901
                a.id, a.artefacttype, a.title, a.description
902
            FROM
903
                {artefact} a
904
            LEFT JOIN {artefact_tag} at ON (at.artefact = a.id)
905
            WHERE
906
907
908
909
910
911
                a.owner = ?
            AND (
                ($querydata[0])
                OR
                (LOWER(at.tag) = ?)
            )";
912
913
914
915
        $count_sql = "
            SELECT
                COUNT(*)
            FROM
916
                {artefact} a
917
            LEFT JOIN {artefact_tag} at ON (at.artefact = a.id)
918
            WHERE
919
920
921
922
923
924
                a.owner = ?
            AND (
                ($querydata[0])
                OR
                (LOWER(at.tag) = ?)
            )";
925
        array_unshift($querydata[1], $USER->get('id'));
926
        array_push($querydata[1], strtolower($querystring));
927

928
929
930
931
932
933
934
        $results = array(
            'data'   => get_records_sql_array($sql, $querydata[1], $offset, $limit),
            'offset' => $offset,
            'limit'  => $limit,
            'count'  => get_field_sql($count_sql, $querydata[1])
        );

935
        if ($results['data']) {
936
            require_once(get_config('docroot') . 'artefact/lib.php');
937
938
939
940
941
942
            foreach ($results['data'] as &$result) {
                $newresult = array();
                foreach ($result as $key => &$value) {
                    if ($key == 'id' || $key == 'artefacttype' || $key == 'title' || $key == 'description') {
                        $newresult[$key] = $value;
                    }
943
                }
944
                $newresult['type'] = 'artefact';
945
946
947
948
949

                $artefact = artefact_instance_from_id($newresult['id']);
                $artefactplugin = $artefact->get_plugin_name();
                if ($artefactplugin == 'internal' && in_array($artefact->get('artefacttype'), PluginArtefactInternal::get_profile_artefact_types())) {
                    // Profile artefact
950
                    $newresult['summary'] = $newresult['title'];
951
                    $newresult['title'] = get_string($artefact->get('artefacttype'), 'artefact.' . $artefactplugin);
952
953
954
955
                }
                else {
                    $newresult['summary'] = $newresult['description'];
                }
956
                $newresult['summary'] = clean_html($newresult['summary']);
957
                $result = $newresult;
958
            }
959
960

            self::self_search_make_links($results);
961
962
963
964
965
966
        }

        return $results;
    }


967
968
969
970
971
972
973
974
    /**
     * 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
975
     * @param string   $sort
976
     * @param array    $types view/artefacttype filters
977
     * @param boolean  $returntags Return all the tags that have been attached to each result
978
     */
979
    public static function portfolio_search_by_tag($tag, $owner, $limit, $offset, $sort, $types, $returntags) {
980
        $viewfilter = is_null($types) || $types['view'] == true ? 'AND TRUE' : 'AND FALSE';
981
        $collectionfilter = is_null($types) || $types['collection'] == true ? 'AND TRUE' : 'AND FALSE';
982

983
984
985
986
987
988
989
990
991
992
        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';
        }

993
994
995
        if (!is_null($tag)) {
            $artefacttypefilter .= ' AND at.tag = ?';
            $viewfilter .= ' AND vt.tag = ?';
996
997
            $collectionfilter .= ' AND ct.tag = ?';
            $values = array($owner->id, $tag, $owner->id, $tag, $owner->id, $tag);
998
999
        }
        else {
1000
            $values = array($owner->id, $owner->id, $owner->id);
1001
1002
        }

1003
1004
        $from = "
        FROM (
1005
1006
           (SELECT a.id, a.title, a.description, 'artefact' AS type, a.artefacttype, " . db_format_tsfield('a.ctime', 'ctime') . ",
                a.owner, a.group, a.institution, NULL AS urlid
1007
            FROM {artefact} a JOIN {artefact_tag} at ON (a.id = at.artefact)
1008
            WHERE a.owner = ?" . $artefacttypefilter . ")
1009
           UNION
1010
1011
           (SELECT v.id, v.title, v.description, 'view' AS type, NULL AS artefacttype, " . db_format_tsfield('v.ctime', 'ctime') . ",
                v.owner, v.group, v.institution, v.urlid
1012
1013
            FROM {view} v JOIN {view_tag} vt ON (v.id = vt.view)
            WHERE v.owner = ? " . $viewfilter . ")
1014
1015
1016
1017
1018
           UNION
           (SELECT c.id, c.name, c.description, 'collection' AS type, NULL AS artefacttype, " . db_format_tsfield('c.ctime', 'ctime') . ",
                c.owner, c.group, c.institution, NULL AS urlid
            FROM {collection} c JOIN {collection_tag} ct ON (c.id = ct.collection)
            WHERE c.owner = ? " . $collectionfilter . ")
1019
1020
1021
1022
1023
1024
1025
        ) p";

        $result = (object) array(
            'tag'    => $tag,
            'owner'  => $owner,
            'offset' => $offset,
            'limit'  => $limit,
1026
            'sort'   => $sort,
1027
1028
1029
1030
1031
1032
            'count'  => 0,
            'data'   => array(),
        );

        if ($count = count_records_sql('SELECT COUNT(*) ' . $from, $values, $offset, $limit)) {
            $result->count = $count;
1033
            $sort = $sort == 'date' ? 'ctime DESC' : 'title ASC';
1034
            if ($data = get_records_sql_assoc("SELECT type || ':' || id AS tid, p.* " . $from . ' ORDER BY ' . $sort, $values, $offset, $limit)) {
1035
                if ($returntags) {
1036
                    $ids = array('view' => array(), 'collection' => array(), 'artefact' => array());
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
                    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;
                            }
                        }
                    }
1047
1048
1049
1050
1051
1052
1053
                    if (!empty($ids['collection'])) {
                        if ($collectiontags = get_records_select_array('collection_tag', 'collection IN (' . join(',', array_keys($ids['collection'])) . ')')) {
                            foreach ($collectiontags as &$ct) {
                                $data['collection:' . $ct->collection]->tags[] = $ct->tag;
                            }
                        }
                    }
1054
                    if (!empty($ids['artefact'])) {
1055
                        if ($artefacttags = get_records_select_array('artefact_tag', 'artefact IN (' . join(',', array_keys($ids['artefact'])) . ')', NULL, 'tag')) {
1056
1057
1058
1059
1060
1061
                            foreach ($artefacttags as &$at) {
                                $data['artefact:' . $at->artefact]->tags[] = $at->tag;
                            }
                        }
                    }
                }
1062
1063
1064
1065
1066
1067
1068
                $result->data = $data;
            }
        }
        return $result;
    }


1069
    /**
1070
     * Parses a query string into SQL fragments for searching. Supports
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
     * 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();
1134
        //$matches = 0;
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
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
        // 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
1184
    }
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205

    /**
     * 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
1206
      return array("a.title ". ($not ? 'NOT ' : '') . db_ilike() . " '%' || ? || '%'" . ($not ? ' AND ' : ' OR ') . 'a.description ' . ($not ? 'NOT ' : '') . db_ilike() . " '%' || ? || '%'", $count);
1207
1208
1209
1210
1211
1212
1213
1214
    }

    /**
     * Simplifies a string according to indexing rules.
     */
    private static function search_simplify($text) {
      // Decode entities to UTF-8
      $text = self::decode_entities($text);
1215

1216
1217
      // Lowercase
      $text = strtolower($text);
1218

1219
1220
      // Call an external processor for word handling.
      //search_preprocess($text);