mahara.php 48.4 KB
Newer Older
1
2
<?php
/**
Nigel McNie's avatar
Nigel McNie committed
3
 * This program is part of Mahara
4
 *
5
6
7
8
 *  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 2 of the License, or
 *  (at your option) any later version.
9
 *
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * @package    mahara
 * @subpackage core
 * @author     Penny Leach <penny@catalyst.net.nz>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
 * @copyright  (C) portions from Moodle, (C) Martin Dougiamas http://dougiamas.com
25
26
 */

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

29
30
31
32
33
34
35
/** 
 * work around silly php settings
 * and broken setup stuff about the install
 * and raise a warning/fail depending on severity
 */
function ensure_sanity() {

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
    // PHP version
    if (version_compare(phpversion(), '5.1.0') < 0) {
        throw new ConfigSanityException(get_string('phpversion', 'error'));
    }

    // Various required extensions
    if (!extension_loaded('json')) {
        throw new ConfigSanityException(get_string('jsonextensionnotloaded', 'error'));
    }
    if (!extension_loaded('pgsql') && !extension_loaded('mysqli')) {
        throw new ConfigSanityException(get_string('dbextensionnotloaded', 'error'));
    }
    if (!extension_loaded('libxml')) {
        throw new ConfigSanityException(get_string('libxmlextensionnotloaded', 'error'));
    }
    if (!extension_loaded('gd')) {
        throw new ConfigSanityException(get_string('gdextensionnotloaded', 'error'));
    }
    if (!extension_loaded('session')) {
        throw new ConfigSanityException(get_string('sessionextensionnotloaded', 'error'));
    }

58
59
60
61
62
63
64
65
66
67
68
    // Various optional extensions
    if (!extension_loaded('openssl')) {
        log_environ(get_string('opensslextensionnotloaded', 'error'));
    }
    if (!extension_loaded('curl')) {
        log_environ(get_string('curlextensionnotloaded', 'error'));
    }
    if (!extension_loaded('xmlrpc')) {
        log_environ(get_string('xmlrpcextensionnotloaded', 'error'));
    }

69
70
    // register globals workaround
    if (ini_get_bool('register_globals')) {
71
        log_environ(get_string('registerglobals', 'error'));
72
        $massivearray = array_keys(array_merge($_POST, $_GET, $_COOKIE, $_SERVER, $_REQUEST, $_FILES));
73
74
75
76
77
78
79
        foreach ($massivearray as $tounset) {
            unset($GLOBALS[$tounset]);
        }
    }

    // magic_quotes_gpc workaround
    if (ini_get_bool('magic_quotes_gpc')) {
80
        log_environ(get_string('magicquotesgpc', 'error'));
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
        function stripslashes_deep($value) {
            $value = is_array($value) ?
                array_map('stripslashes_deep', $value) :
                stripslashes($value);
            return $value;
        }
        $_POST = array_map('stripslashes_deep', $_POST);
        $_GET = array_map('stripslashes_deep', $_GET);
        $_COOKIE = array_map('stripslashes_deep', $_COOKIE);
        $_REQUEST = array_map('stripslashes_deep', $_REQUEST);

        $servervars = array('REQUEST_URI','QUERY_STRING','HTTP_REFERER','PATH_INFO','PHP_SELF','PATH_TRANSLATED');
        foreach ($servervars as $tocheck) {
            if (array_key_exists($tocheck,$_SERVER) && !empty($_SERVER[$tocheck])) {
                $_SERVER[$tocheck] = stripslashes($_SERVER[$tocheck]);
            }
        }
    }

100
    if (ini_get_bool('magic_quotes_runtime')) {
101
102
103
104
105
106
107
108
109
        // Turn of magic_quotes_runtime. Anyone with this on deserves a slap in the face
        set_magic_quotes_runtime(0);
        log_environ(get_string('magicquotesruntime', 'error'));
    }

    if (ini_get_bool('magic_quotes_sybase')) {
        // See above comment re. magic_quotes_runtime
        @ini_set('magic_quotes_sybase', 0);
        log_environ(get_string('magicquotessybase', 'error'));
110
111
    }

112
113
114
    if (ini_get_bool('safe_mode')) {
        // We don't run with safe mode
        throw new ConfigSanityException(get_string('safemodeon', 'error'));
115
116
    }

117
118
119
120
121
122
123
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

124
    // dataroot inside document root.
125
126
    if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
        throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
127
128
    }

129
130
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
131
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
132
    }
133

134
135
136
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
137
138
        !check_dir_exists(get_config('dataroot') . 'templates') ||
        !check_dir_exists(get_config('dataroot') . 'sessions')) {
139
140
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
141
142
}

143
144
145
146
147
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
148
    if (get_config('installed')) {
149
150
151
152
153
154
155
156
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

157
function get_string($identifier, $section='mahara') {
158
159
160
161
162

    $variables = func_get_args();
    if (count($variables) > 2) { // we have some stuff we need to sprintf
        array_shift($variables);
        array_shift($variables); //shift off the first two.
163
164
    }
    else {
165
166
167
        $variables = array();
    }
    
168
169
170
    return get_string_location($identifier, $section, $variables);
}

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
function get_helpfile($plugintype, $pluginname, $form, $element, $page=null, $section=null) {
    if ($langfile = get_helpfile_location($plugintype, $pluginname, $form, $element, $page, $section)) {
        return file_get_contents($langfile);
    }
    return false;
}

function get_helpfile_location($plugintype, $pluginname, $form, $element, $page=null, $section=null) {

    $location = get_config('docroot') ;
    $file = 'help/';

    if ($plugintype != 'core') {
        $location .= $plugintype . '/' . $pluginname . '/lang/';
    }
    else {
        $location .= 'lang/';
    }
    if ($page) {
        $page = str_replace('-', '/', $page);
191
192
193
194
195
196
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
    }
    else if ($section) {
        $file .= 'sections/' . $section . '.html';
    }
    else if (!empty($form) && !empty($element)) {
        $file .= 'forms/' . $form . '.' . $element . '.html';
    }
    else if (!empty($form) && empty($element)) {
        $file .= 'forms/' . $form . '.html';
    }
    else {
        return false;
    }

    // now we have to try and locate the help file
    $lang = current_language();
    if ($lang == 'en.utf8') {
        $trieden = true;
    }
    else {
        $trieden = false;
    }

    // try the current language
    $langfile = $location . $lang . '/' . $file;
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
        $langfile = $location . $lang . '/langconfig.php';
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
            $langfile = $location . $parentlang . '/' . $file;
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

    // if it's STILL not found, and we haven't already tried english ...
    if (empty($data) && empty($trieden)) {
        $langfile = $location .  'en.utf8/' . $file;
        if (is_readable($langfile)) {
            return $langfile;
        }
    }
    return false;
}

250
251
252
253
254
// get a string without sprintfing it.
function get_raw_string($identifier, $section='mahara') {
    // For a raw string we don't want to format any arguments using
    // sprintf, so the replace function passed to get_string_location
    // should just return the first argument and ignore the second.
255
256
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
}


/**
 * This function gets a language string identified by $identifier from
 * an appropriate location, and formats the string and any arguments
 * in $variables using the function $replacefunc.
 *
 * @param string   $identifier
 * @param string   $section
 * @param array    $variables
 * @param function $replacefunc
 * @return string
 */
function get_string_location($identifier, $section, $variables, $replacefunc='format_langstring') {

    $langconfigstrs = array('parentlanguage', 'strftimedate', 'strftimedateshort', 'strftimedatetime',
                            'strftimedaydate', 'strftimedaydatetime', 'strftimedayshort', 'strftimedaytime',
                            'strftimemonthyear', 'strftimerecent', 'strftimerecentfull', 'strftimetime',
Richard Mansfield's avatar
Richard Mansfield committed
276
                            'strfdaymonthyearshort', 'thislanguage');
277
278
279
280
281

    if (in_array($identifier, $langconfigstrs)) {
        $section = 'langconfig';
    }

282
283
284
285
286
287
    $lang = current_language();

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
288
    if (false === strpos($section, '.')) {
289
290
291
292
        $locations[] = $docroot . 'lang/';
    }
    else {
        $extras = plugin_types(); // more later..
293
        foreach ($extras as $tocheck) {
294
            if (strpos($section,$tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
295
                $pluginname = substr($section ,strlen($tocheck) + 1);
296
                $locations[] = $docroot . $tocheck . '/' . $pluginname . '/lang/';
297
298
299
            }
        }
    }
300

301
302
303
    // First check all the normal locations for the string in the current language
    foreach ($locations as $location) {
        //if local directory not found, or particular string does not exist in local direcotry
304
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
305
        if (is_readable($langfile)) {
306
            if ($result = get_string_from_file($identifier, $langfile)) {
307
                return $replacefunc($result, $variables);
308
309
310
311
312
313
314
            }
        }
    }

    // If the preferred language was English (utf8) we can abort now
    // saving some checks beacuse it's the only "root" lang
    if ($lang == 'en.utf8') {
315
        return '[[' . $identifier . '/' . $section . ']]';
316
317
318
319
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
    foreach ($locations as $location) {
320
        $langfile = $location . $lang . '/langconfig.php';
Penny Leach's avatar
Penny Leach committed
321
        if (is_readable($langfile)) {
322
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
323
                $langfile = $location . $parentlang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
324
                if (is_readable($langfile)) {
325
                    if ($result = get_string_from_file($identifier, $langfile)) {
326
                        return $replacefunc($result, $variables);
327
328
329
330
331
332
333
334
335
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
336
        $langfile = $location . 'en.utf8/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
337
        if (is_readable($langfile)) {
338
            if ($result = get_string_from_file($identifier, $langfile)) {
339
                return $replacefunc($result, $variables);
340
341
342
343
            }
        }
    }

344
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
345
}
346
347


348
349
350
351
352
353
354
355
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
    $langbase = get_config('docroot') . 'lang/';
    if (!$langdir = opendir($langbase)) {
356
        throw new SystemException('Unable to read language directory '.$langbase);
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
    }
    while (false !== ($subdir = readdir($langdir))) {
        $langfile = $langbase . $subdir . '/langconfig.php';
        if ($subdir != "." && $subdir != ".." && is_readable($langfile)) {
            if ($langname = get_string_from_file('thislanguage',$langfile)) {
                $langs[$subdir] = $langname;
            }
        }
    }
    closedir($langdir);
    return $langs;
}

/**
 * Return a list of available themes
 * Need to add the theme names sometime; for now use get_string().
 *
 */
function get_themes() {
    $themes = array();
    $themebase = get_config('docroot') . 'theme/';
    if (!$themedir = opendir($themebase)) {
379
        throw new SystemException('Unable to read theme directory '.$themebase);
380
381
    }
    while (false !== ($subdir = readdir($themedir))) {
382
        if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
383
384
            $themes[$subdir] = $subdir;

385
            $config_path = $themebase . $subdir . '/config.php';
386
387
388
389
390
391
            if (is_readable($config_path)) {
                require_once($config_path);
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
392
393
394
395
396
397
398
        }
    }
    closedir($themedir);
    return $themes;
}


399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/**
 * This function is only used from {@link get_string()}.
 *
 * @internal Only used from get_string, not meant to be public API
 * @param string $identifier ?
 * @param string $langfile ?
 * @param string $destination ?
 * @return string|false ?
 * @staticvar array $strings Localized strings
 * @access private
 * @todo Finish documenting this function.
 */
function get_string_from_file($identifier, $langfile) {

    static $strings;    // Keep the strings cached in memory.

    if (empty($strings[$langfile])) {
        $string = array();
        include ($langfile);
        $strings[$langfile] = $string;
    } else {
        $string = &$strings[$langfile];
    }

    if (!isset ($string[$identifier])) {
        return false;
    }

    return $string[$identifier];
}

/**
 * This function makes the return value of ini_get consistent if you are
 * setting server directives through the .htaccess file in apache.
 * Current behavior for value set from php.ini On = 1, Off = [blank]
 * Current behavior for value set from .htaccess On = On, Off = Off
 * Contributed by jdell @ unr.edu
 *
437
 * @param string $ini_get_arg setting to look for
438
439
440
441
442
443
444
445
446
447
448
 * @return bool
 */
function ini_get_bool($ini_get_arg) {
    $temp = ini_get($ini_get_arg);

    if ($temp == '1' or strtolower($temp) == 'on') {
        return true;
    }
    return false;
}

449
450
451
452
453
454
455
456
457
458
459
/**
 * This function loads up the basic $CFG
 * from the database table
 * note that it doesn't load plugin config
 * as not every page needs them
 * @return boolean false if the assignment fails (generally if the databse is not installed)
 */
function load_config() {
    global $CFG;
    
    try {
460
        $dbconfig = get_records_array('config', '', '', '', 'field, value');
461
    } 
462
    catch (SQLException $e) {
463
464
465
        // TODO: better reporting if config could not be obtained? This 
        // normally happens when the system isn't installed
        log_info($e->getMessage());
466
467
468
469
        return false;
    }
    
    foreach ($dbconfig as $cfg) {
470
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
471
            // @todo warn that we're overriding db config with $CFG
472
473
474
475
476
477
478
479
480
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
481
482
483
484
485
486
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
487
488
489
490
491
492
493
494
function get_config($key) {
    global $CFG;
    if (array_key_exists($key,$CFG)) {
        return $CFG->$key;
    }
    return null;
}

495
496
497
498
499
500
501
502
503

/**
 * This function sets a config variable
 * both in $CFG and in the database
 *
 * @param string $key config field to set
 * @param string $value config value
 */
function set_config($key, $value) {
504
505
506
507
    global $CFG;

    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
508
509
510
511
512
513
514
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
515
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
516
517
518
    }

    if (!empty($status)) {
519
520
521
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
522

523
524
525
526
527
528
529
530
531
532
533
534
535
536
    return false;
}

/**
 * This function returns a value for $CFG for a plugin
 * or null if it is not found
 * note that it may go and look in the database
 *
 * @param string $plugintype eg artefact
 * @param string $pluginname eg blog
 * @param string $key the config setting to look for
 */
function get_config_plugin($plugintype, $pluginname, $key) {
    global $CFG;
537

538
539
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
540
    if (isset($value)) {
541
542
543
544
        return $value;
    }

    $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
545
    if (!empty($records)) {
546
547
        foreach($records as $record) {
            $CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
548
            if ($record->field == $key) {
549
550
551
                $value = $record->value;
            }
        }
552
553
    }

554
555
556
    return $value;
}

Penny Leach's avatar
Penny Leach committed
557
function set_config_plugin($plugintype, $pluginname, $key, $value) {
558
    global $CFG;
559
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
560

561
562
563
    if (false !== get_field($table, 'value', 'plugin', $pluginname, 'field', $key)) {
        //if (set_field($table, 'value', $key, 'plugin', $pluginname, 'field', $value)) {
        if (set_field($table, 'value', $value, 'plugin', $pluginname, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
564
565
566
567
568
569
570
571
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
572
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
573
574
575
576
577
578
579
580
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

581
582
583
584
585
586
587
588
589
590
/**
 * This function returns a value for $CFG for a plugin instance
 * or null if it is not found. Initially this is interesting only 
 * for multiauth. Note that it may go and look in the database
 *
 * @param string $plugintype   E.g. auth
 * @param string $pluginname   E.g. internal
 * @param string $pluginid     Instance id
 * @param string $key          The config setting to look for
 */
591
function get_config_plugin_instance($plugintype, $pluginid, $key) {
592
593
594
595
596
597
    global $CFG;

    // Must be unlikely to exist as a config option for any plugin
    $instance = '_i_n_s_t'.$pluginid;

    // Suppress NOTICE with @ in case $key is not yet cached
598
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
599
    if (isset($value)) {
600
601
602
        return $value;
    }

603
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
604
    if (!empty($records)) {
605
        foreach($records as $record) {
606
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
607
            if ($record->field == $key) {
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
                $value = $record->value;
            }
        }
    }

    return $value;
}

/**
 * This function returns a value for $CFG for a plugin instance
 * or null if it is not found. Initially this is interesting only 
 * for multiauth. Note that it may go and look in the database
 *
 * @param string $plugintype   E.g. auth
 * @param string $pluginname   E.g. internal
 * @param string $pluginid     Instance id
 * @param string $key          The config setting to look for
 */
function set_config_plugin_instance($plugintype, $pluginname, $pluginid, $key, $value) {
    global $CFG;
    $table = $plugintype . '_instance_config';

    if (false !== get_field($table, 'value', 'instance', $pluginid, 'field', $key)) {
        if (set_field($table, 'value', $value, 'instance', $pluginid, 'field', $key)) {
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->instance = $pluginid;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
        $status = insert_record($table, $pconfig);
    }
    if ($status) {
        // Must be unlikely to exist as a config option for any plugin
        $instance = '_i_n_s_t'.$pluginid;
        $CFG->plugin->{$plugintype}->{$pluginname}->{$instance}->{$key} = $value;
        return true;
    }
    return false;
}

651
/**
652
653
654
655
656
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
657
658
659
660
661
662
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

663
/**
664
665
666
667
668
669
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
670
671
function current_language() {
    global $USER, $CFG;
672
673
674
675
676
    if ($USER instanceof User) {
        $lang = $USER->get_account_preference('lang');
        if ($lang !== null && $lang != 'default') {
            return $lang;
        }
677
678
679
680
681
682
683
    }
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

684
/**
685
686
687
688
689
690
 * Helper function to sprintf language strings
 * with a variable number of arguments
 * 
 * @param string $string raw string to use
 * @param array $args arguments to sprintf
 */
691
692
693
694
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

695
696
697
698
699
700
701
702
703
704
705
706
707
/**
 * Helper function to figure out whether an array is an array or a hash
 * @param array $array array to check
 * @return bool true if the array is a hash
 */
function is_hash($array) {
    if (!is_array($array)) {
        return false;
    }
    $diff = array_diff_assoc($array,array_values($array));
    return !empty($diff);
}

708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
/**
 * Function to check if a directory exists and optionally create it.
 *
 * @param string absolute directory path
 * @param boolean create directory if does not exist
 * @param boolean create directory recursively
 *
 * @return boolean true if directory exists or created
 */
function check_dir_exists($dir, $create=true, $recursive=true) {

    $status = true;

    if(!is_dir($dir)) {
        if (!$create) {
            $status = false;
        } else {
            umask(0000); 
726
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
727
            // @todo has the umask been clobbered at this point, and is this a bad thing?
728
729
730
731
732
        }
    }
    return $status;
}

Penny Leach's avatar
Penny Leach committed
733
734
735
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
736
 *
Penny Leach's avatar
Penny Leach committed
737
738
 * This function is the one safe point to require plugin files.
 * so USE it :)
739
 *
Penny Leach's avatar
Penny Leach committed
740
741
742
743
744
745
 * @param string $plugintype the type of plugin (eg artefact)
 * @param string $pluginname the name of the plugin (eg blog)
 * @param string $filename the name of the file to include within the plugin structure
 * @param string $function (optional, defaults to require) the require/include function to use
 * @param string $nonfatal (optional, defaults to false) just returns false if the file doesn't exist
 */
746
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
747
748
749
750
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
751
752
    require_once(get_config('docroot') . $plugintype . '/lib.php');

753
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
754
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
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ('invalid require type');
    }

    $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    if (!$realpath = realpath($fullpath)) {
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ("File $fullpath did not exist");
    }

    if (strpos($realpath, get_config('docroot') !== 0)) {
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ("File $fullpath was outside document root!");
    }

    if ($function == 'require') { return require($realpath); }
    if ($function == 'include') { return include($realpath); }
    if ($function == 'require_once') { return require_once($realpath); }
    if ($function == 'include_once') { return include_once($realpath); }
    
}

782
783
784
785
786
787
788
/**
 * This function returns the list of plugintypes we currently care about
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
789
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search');
790
791
792
793
    }
    return $pluginstocheck;
}

794
795
796
797
798
799
800
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
801
    return get_records_array($plugintype . '_installed');
802
803
}

804
805
806
807
808
809
810
811
/**
 * Helper to call a static method when you do not know the name of the class
 * you want to call the method on. PHP5 does not support $class::method().
 */
function call_static_method($class, $method) {
    $args = func_get_args();
    array_shift($args);
    array_shift($args);
812
    return call_user_func_array(array($class, $method), $args);
813
814
}

815
816
817
818
819
function generate_class_name() {
    $args = func_get_args();
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

820
821
822
823
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

824
825
826
827
828
/**
 * Fires an event which can be handled by different parts of the system
 */
function handle_event($event, $data) {
    if (!$e = get_record('event_type', 'name', $event)) {
Martyn Smith's avatar
Martyn Smith committed
829
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
830
    }
831

832
833
834
835
    if ($data instanceof ArtefactType) {
        // leave it alone
    }
    else if (is_object($data)) {
836
837
        $data = (array)$data;
    }
838
    else if (is_numeric($data)) {
839
840
841
        $data = array('id' => $data);
    }

842
843
844
    // this is here because the core can't listen to events
    // @todo, this is VERY ugly, and someone should fix it
    if ($event == 'createuser') {
845
        activity_set_defaults($data['id']);
846
847
    }

Penny Leach's avatar
Penny Leach committed
848
849
    $plugintypes = plugin_types();
    foreach ($plugintypes as $name) {
850
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
851
            foreach ($subs as $sub) {
852
                safe_require($name, $sub->plugin);
Penny Leach's avatar
Penny Leach committed
853
854
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
855
                    call_static_method($classname, $sub->callfunction, $event, $data);
Penny Leach's avatar
Penny Leach committed
856
857
858
859
860
861
862
863
864
865
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

866
867
868
869
870
871
872
873
874
875
876
877
878
879
/**
 * function to convert an array of objects to 
 * an array containing one field per place
 * 
 * @param array $array input array
 * @param mixed $field field to look for in each object
 */
function mixed_array_to_field_array($array, $field) {
    $repl_fun = create_function('$n, $field', '$n = (object)$n; return $n->{$field};');
    $fields = array_pad(array(), count($array), $field);
    return array_map($repl_fun, $array, $fields);
}


Penny Leach's avatar
Penny Leach committed
880
881
/** 
 * Adds stuff to the log
882
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
883
884
885
886
887
888
889
890
891
892
893
894
 *
 * @param string $plugintype plugin type or core
 * @param string $pluginname plugin name or core component (eg 'view')
 * @param string $action action string (like 'add')
 * @param int $user id of user making the action
 * @param int $id relevant id (ie, profile view would have id of profile owner)
 * 
 */
function add_to_log($plugintype, $pluginname, $action, $user, $id=0) {

}

895
896
897
898
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
899
    log_debug($message);
900
901
902
903
904
905
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

906
907
908
/** 
 * Base class for all plugintypes.
 */
909
class Plugin {
910
    
911
912
    /**
     * This function returns an array of crons it wants to have run
913
     * Each item should be a StdClass object containing - 
914
915
916
917
     * - callfunction (static function on the Plugin Class)
     * - any or all of minute, hour, day, month, dayofweek 
     * (will default to * if not supplied)
     */
918
919
920
921
    public static function get_cron() {
        return array();
    }

922
923
924
925
926
927
928
    /** 
     * This function returns an array of events to subscribe to
     * by unique name. 
     * If an event the plugin is trying to subscribe to is unknown by the
     * core, an exception will be thrown.
     * @return array
     */
929
930
931
932
    public static function get_event_subscriptions() {
        return array();
    }

933
934
935
936
937
938
939

    /**
     * This function will be run after every upgrade to the plugin.
     * 
     * @param int $fromversion version upgrading from (or 0 if installing)
     */
    public static function postinst($fromversion) {
940
941
        return true;
    }
942

943
944
945
946
947
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
948
949
950
    public static function has_config() {
        return false;
    }
951
952
}

953
954
955
956
957
/**
 * formats a unix timestamp to a nice date format.
 * 
 * @param int $date unix timestamp to format
 * @param string $formatkey language key to fetch the format from
958
959
 * @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
 * @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
960
961
962
963
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

964
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
965
    if (empty($date)) {
966
        return get_string($notspecifiedkey, $notspecifiedsection);
967
    }
968
969
970
    return strftime(get_string($formatkey), $date);
}

971
972
973
/**
 * Returns a random string suitable for registration/change password requests
 *
974
 * @param int $length The length of the key to return
975
976
 * @return string
 */
977
978
979
980
function get_random_key($length=16) {
    if ($length < 1) {
        throw new IllegalArgumentException('Length must be a positive number');
    }
981
982
983
984
985
986
987
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
988
    for ($i = 0; $i < $length; $i++) {
989
990
991
992
993
        $result .= $pool[$i];
    }
    return $result;
}

994

995
996
997
998
//
// Pieform related functions
//

999
1000
1001
/**
 * Configures a default form
 */
1002
function pieform_configure() {
1003
    global $USER;
1004
    return array(
1005
1006
        'method'    => 'post',
        'action'    => '',
1007
        'language'  => current_language(),
1008
        'autofocus' => true,
1009
        'renderer'  => 'maharatable',
1010
        'requiredmarker' => true,
Nigel McNie's avatar
Nigel McNie committed
1011
        'elementclasses' => true,
1012
1013
1014
1015
1016
1017
        'jserrorcallback'       => 'formError',
        'globaljserrorcallback' => 'formGlobalError',
        'jssuccesscallback'     => 'formSuccess',
        'presubmitcallback'     => 'formStartProcessing',
        'postsubmitcallback'    => 'formStopProcessing',
        'jserrormessage' => get_string('errorprocessingform'),
1018
        'configdirs' => get_config('libroot') . 'form/',
1019
        'helpcallback' => 'pieform_get_help',
1020
        'elements'   => array(
1021
            'sesskey' => array(
1022
                'type'  => 'hidden',
1023
                'value' => $USER->get('sesskey')
1024
1025
1026
1027
1028
            )
        )
    );
}

1029
1030
1031
1032
1033
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
1034
    if ($USER && $USER->is_logged_in() && $USER->get('sesskey') != $values['sesskey']) {
1035
1036
1037
1038
1039
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
1040
1041
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
1042
            FROM {usr}
1043
1044
1045
1046
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
1047
1048
1049
    }
}

1050
function pieform_element_calendar_configure($element) {
1051
    $element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
1052
    $element['themefile'] = theme_get_url('style/calendar.css');
1053
    $element['imagefile'] = theme_get_url('images/calendar.gif');
1054
    $language = substr(current_language(), 0, 2);
1055
    $element['language'] = $language;
1056
1057
1058
    return $element;
}

1059
function pieform_element_textarea_configure($element) {
1060
1061
1062
    if (!array_key_exists('resizable', $element)) {
        $element['resizable'] = true;
    }
1063
1064
1065
    return $element;
}

1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
/**
 * Given a view id, and a user id (defaults to currently logged in user if not
 * specified) will return wether this user is allowed to look at this view.
 *
 * @param integer $view_id      View ID to check
 * @param integer $user_id      User trying to look at the view (defaults to
 * currently logged in user, or null if user isn't logged in)
 *
 * @returns boolean Wether the specified user can look at the specified view.
 */
Martyn Smith's avatar
Martyn Smith committed
1076
function can_view_view($view_id, $user_id=null) {
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
    global $USER;
    $now = time();
    $dbnow = db_format_timestamp($now);

    if ($user_id === null) {
        $user_id = $USER->get('id');
    }

    $view_data = get_records_sql_array('
        SELECT
            v.title,
            v.owner,
            ' . db_format_tsfield('v.startdate','startdate') . ',
            ' . db_format_tsfield('v.stopdate','stopdate') . ',
            a.accesstype,
1092
            v.submittedto,
1093
1094
1095
            ' . db_format_tsfield('a.startdate','access_startdate') . ',
            ' . db_format_tsfield('a.stopdate','access_stopdate') . '
        FROM
1096
1097
            {view} v
            LEFT OUTER JOIN {view_access} a ON v.id=a.view
1098
1099
1100
1101
1102
1103
1104
1105
1106
        WHERE v.id=?
    ', array($view_id));

    if(!$view_data) {
        throw new ViewNotFoundException("View id=$view_id doesn't exist");
    }

    $view_record = array( 'access' => array() );

1107
    //log_debug('Can you look at this view? (you are user ' . $user_id . ' trying to look at view ' . $view_id . ')');
1108
1109
1110
1111
1112
1113

    foreach ( $view_data as $row ) {
        $view_record['title'] = $row->title;
        $view_record['owner'] = $row->owner;
        $view_record['startdate'] = $row->startdate;
        $view_record['stopdate'] = $row->stopdate;
1114
        $view_record['submittedto'] = $row->submittedto;
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126

        if (!isset($row->accesstype)) {
            continue;
        }
        
        $view_record['access'][$row->accesstype] = array(
            'startdate' => $row->access_startdate,
            'stopdate' => $row->access_stopdate,
        );
    }

    if ($USER->is_logged_in() && $view_record['owner'] == $user_id) {
1127
        //log_debug('Yes - you own this view');
1128
1129
1130
        return true;
    }

1131
1132
    if ($view_record['submittedto'] && record_exists('group_member', 'group', $view_record['submittedto'], 'member', $user_id, 'tutor', 1)) {
        //log_debug('Yes - View is submitted for assesment to a group you are a tutor in');
1133
1134
1135
        return true;
    }

1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
    // check public
    if (
        isset($view_record['access']['public'])
        && (    
            $view_record['access']['public']['startdate'] == null
            || $view_record['access']['public']['startdate'] < $now
        )
        && (
            $view_record['access']['public']['stopdate'] == null
            || $view_record['access']['public']['stopdate'] > $now
        )
Martyn Smith's avatar
Martyn Smith committed
1147
    ) {
1148

1149
        //log_debug('Yes - View is public');
1150
1151
1152
1153
1154
        return true;
    }

    // everything below this point requires that you be logged in
    if (!$USER->is_logged_in()) {
1155
        //log_debug('No - you are not logged in');
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
        return false;
    }

    // check logged in
    if (
        isset($view_record['access']['loggedin'])
        && (    
            $view_record['access']['loggedin']['startdate'] == null
            || $view_record['access']['loggedin']['startdate'] < $now
        )
        && (
            $view_record['access']['loggedin']['stopdate'] == null
            || $view_record['access']['loggedin']['stopdate'] > $now
        )
Martyn Smith's avatar
Martyn Smith committed
1170
    ) {
1171

1172
        //log_debug('Yes - View is available to logged in users');
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
        return true;
    }

    // check friends access
    if (
        isset($view_record['access']['friends'])
        && (    
            $view_record['access']['friends']['startdate'] == null
            || $view_record['access']['friends']['startdate'] < $now
        )
        && (
            $view_record['access']['friends']['stopdate'] == null
            || $view_record['access']['friends']['stopdate'] > $now
        )
        && get_field_sql(
1188
            'SELECT COUNT(*) FROM {usr_friend} f WHERE (usr1=? AND usr2=?) OR (usr1=? AND usr2=?)',
1189
1190
            array( $view_record['owner'], $user_id, $user_id, $view_record['owner'] )
        )
Martyn Smith's avatar
Martyn Smith committed
1191
    ) {
1192
        //log_debug('Yes - View is available to friends of the owner');
1193
1194
1195
1196
1197
1198
1199
1200
        return true;
    }

    // check user access
    if (get_field_sql(
        'SELECT
            a.view
        FROM 
1201
            {view_access_usr} a
1202
1203
        WHERE
            a.view=? AND a.usr=?
Martyn Smith's avatar
Martyn Smith committed
1204
1205
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1206
1207
1208
1209
        LIMIT 1',
        array( $view_id, $user_id, $dbnow, $dbnow )
        )
    ) {
1210
        //log_debug('Yes - View is available to your user');
1211
1212
1213
        return true;
    }

1214
    // check group access
1215
1216
1217
1218
    if (get_field_sql(
        'SELECT
            a.view
        FROM
1219
1220
1221
            {view_access_group} a
            INNER JOIN {group} g ON a.group = g.id
            INNER JOIN {group_member} m ON g.id=m.group
1222
        WHERE
1223
            a.view = ? 
Martyn Smith's avatar
Martyn Smith committed
1224
1225
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1226
            AND ( ( m.member = ? AND (a.tutoronly = 0 OR m.tutor = 1 ) ) OR g.owner = ?)
1227
        LIMIT 1',
1228
        array( $view_id, $dbnow, $dbnow, $user_id, $user_id  )
1229
1230
        )
    ) {
1231
        //log_debug('Yes - View is available to a specific group');
1232
1233
1234
        return true;
    }

1235
1236
    // check admin
    if (get_field('usr', 'admin', 'id', $user_id)) {
1237
        //log_debug('Yes - You are a site administrator');
1238
1239
1240
        return true;
    }

1241

1242
    //log_debug('No - nothing matched');
1243
1244
1245
    return false;
}

Penny Leach's avatar
Penny Leach committed
1246
1247
1248
1249
1250
1251
/**
 * get the views that a user can see belonging
 * to the given users
 *
 * @param array $users users to fetch views owned by
 * @param int $userlooking (optional, defaults to logged in user)
1252
1253
1254
 * @param int $limit grab this many views. (setting this null means get all)
 *
 * @return array Associative array keyed by userid, of arrays of view ids
Penny Leach's avatar
Penny Leach committed
1255
1256
1257
1258
1259
1260
 */
function get_views($users, $userlooking=null, $limit=5) {
    $userlooking = optional_userid($userlooking);
    if (is_int($users)) {
        $users = array($users);
    }
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275

    $list = array();

    if(count($users) == 0) {
        return $list;
    }

    $users = array_flip($users);

    $dbnow  = db_format_timestamp(time());

    if ($friends = get_records_sql_array(
        'SELECT
            CASE WHEN usr1=? THEN usr2 ELSE usr1 END AS id
        FROM
1276
            {usr_friend} f
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
        WHERE
            ( usr1=? AND usr2 IN (' . join(',',array_map('db_quote', array_keys($users))) . ') )
            OR
            ( usr2=? AND usr1 IN (' . join(',',array_map('db_quote', array_keys($users))) . ') )
        ',
        array($userlooking,$userlooking,$userlooking)
    )) {
        foreach ( $friends as $user_id ) {
            $users[$user_id->id] = 'friend';
        }
    }

    // public, logged in, or friends' views
    if ($results = get_records_sql_array(
        'SELECT
            v.*,
            ' . db_format_tsfield('atime') . ',
            ' . db_format_tsfield('mtime') . ',
            ' . db_format_tsfield('ctime') . '
        FROM 
1297
1298
            {view} v
            INNER JOIN {view_access} a ON
1299
1300
1301
                v.id=a.view
                AND (
                    accesstype IN (\'public\',\'loggedin\')
1302
1303
1304
1305
1306
1307
1308
1309
1310
            ' . (
                    count(preg_grep('/^friend$/', $users)) > 0
                    ?  'OR (
                            accesstype = \'friends\'
                            AND v.owner IN (' . join(',',array_map('db_quote', array_keys(preg_grep('/^friend$/', $users)))) . ')
                        )'
                    : ''
                )
            . '
1311
1312
1313
1314
                )
        WHERE
            v.owner IN (' . join(',',array_map('db_quote', array_keys($users))) . ')
            AND ( v.startdate IS NULL OR v.startdate < ? )
Martyn Smith's avatar
Martyn Smith committed
1315
            AND ( v.stopdate IS NULL OR v.stopdate > ? )
1316
1317
1318
1319
1320
1321
1322
1323
        ',
        array( $dbnow, $dbnow )
        )
    ) {
        foreach ($results as &$row) {
            $list[$row->owner][$row->id] = $row;
        }
    }
Martyn Smith's avatar
Martyn Smith committed
1324
1325

    // bail if we've filled all users to the limit
1326
1327
1328
1329
    if (_get_views_trim_list($list, $users, $limit)) {
        return $list;
    }

Martyn Smith's avatar
Martyn Smith committed
1330
    // check individual user access
1331
1332
1333
1334
1335
1336
1337
    if ($results = get_records_sql_array(
        'SELECT
            v.*,
            ' . db_format_tsfield('atime') . ',
            ' . db_format_tsfield('mtime') . ',
            ' . db_format_tsfield('ctime') . '
        FROM 
1338
1339
            {view} v
            INNER JOIN {view_access_usr} a ON v.id=a.view AND a.usr=?
1340
1341
1342
        WHERE
            v.owner IN (' . join(',',array_map('db_quote', array_keys($users))) . ')
            AND ( v.startdate IS NULL OR v.startdate < ? )
Martyn Smith's avatar
Martyn Smith committed
1343
            AND ( v.stopdate IS NULL OR v.stopdate > ? )
Martyn Smith's avatar
Martyn Smith committed
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
        ',
        array($userlooking, $dbnow, $dbnow)
        )
    ) {
        foreach ($results as &$row) {
            $list[$row->owner][$row->id] = $row;
        }
    }

    // bail if we've filled all users to the limit
    if (_get_views_trim_list($list, $users, $limit)) {
        return $list;
    }

1358
    // check group access
Martyn Smith's avatar
Martyn Smith committed
1359
1360
1361
1362
1363
1364
1365
    if ($results = get_records_sql_array(
        'SELECT
            v.*,
            ' . db_format_tsfield('v.atime','atime') . ',
            ' . db_format_tsfield('v.mtime','mtime') . ',
            ' . db_format_tsfield('v.ctime','ctime') . '
        FROM 
1366
1367
1368
            {view} v
            INNER JOIN {view_access_group} a ON v.id=a.view
            INNER JOIN {group_member} m ON m.group=a.group AND m.member=?
Martyn Smith's avatar
Martyn Smith committed
1369
1370
1371
        WHERE
            v.owner IN (' . join(',',array_map('db_quote', array_keys($users))) . ')
            AND ( v.startdate IS NULL OR v.startdate < ? )
Martyn Smith's avatar
Martyn Smith committed
1372
            AND ( v.stopdate IS NULL OR v.stopdate > ? )
Martyn Smith's avatar
Martyn Smith committed
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
        ',
        array($userlooking, $dbnow, $dbnow)
        )
    ) {
        foreach ($results as &$row) {
            $list[$row->owner][$row->id] = $row;
        }
    }

    // bail if we've filled all users to the limit
    if (_get_views_trim_list($list, $users, $limit)) {
        return $list;
    }
1386
1387
1388
1389
1390
1391
1392
1393

    return $list;
}

function _get_views_trim_list(&$list, &$users, $limit) {
    if ($limit === null) {
        return;
    }
1394
1395
1396
1397
1398
1399
1400
1401
1402
    foreach ($list as $user_id => &$views