mahara.php 47.5 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
    // register globals workaround
    if (ini_get_bool('register_globals')) {
60
        log_environ(get_string('registerglobals', 'error'));
61
        $massivearray = array_keys(array_merge($_POST, $_GET, $_COOKIE, $_SERVER, $_REQUEST, $_FILES));
62
63
64
65
66
67
68
        foreach ($massivearray as $tounset) {
            unset($GLOBALS[$tounset]);
        }
    }

    // magic_quotes_gpc workaround
    if (ini_get_bool('magic_quotes_gpc')) {
69
        log_environ(get_string('magicquotesgpc', 'error'));
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
        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]);
            }
        }
    }

89
    if (ini_get_bool('magic_quotes_runtime')) {
90
91
92
93
94
95
96
97
98
        // 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'));
99
100
    }

101
102
103
    if (ini_get_bool('safe_mode')) {
        // We don't run with safe mode
        throw new ConfigSanityException(get_string('safemodeon', 'error'));
104
105
    }

106
107
108
109
110
111
112
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

113
    // dataroot inside document root.
114
115
    if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
        throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
116
117
    }

118
119
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
120
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
121
    }
122

123
124
125
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
126
127
        !check_dir_exists(get_config('dataroot') . 'templates') ||
        !check_dir_exists(get_config('dataroot') . 'sessions')) {
128
129
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
130
131
}

132
133
134
135
136
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
137
    if (get_config('installed')) {
138
139
140
141
142
143
144
145
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

146
function get_string($identifier, $section='mahara') {
147
148
149
150
151

    $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.
152
153
    }
    else {
154
155
156
        $variables = array();
    }
    
157
158
159
    return get_string_location($identifier, $section, $variables);
}

160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
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);
180
181
182
183
184
185
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
    }
    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;
}

239
240
241
242
243
// 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.
244
245
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
}


/**
 * 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
265
                            'strfdaymonthyearshort', 'thislanguage');
266
267
268
269
270

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

271
272
273
274
275
276
    $lang = current_language();

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
277
    if (false === strpos($section, '.')) {
278
279
280
281
        $locations[] = $docroot . 'lang/';
    }
    else {
        $extras = plugin_types(); // more later..
282
        foreach ($extras as $tocheck) {
283
            if (strpos($section,$tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
284
                $pluginname = substr($section ,strlen($tocheck) + 1);
285
                $locations[] = $docroot . $tocheck . '/' . $pluginname . '/lang/';
286
287
288
            }
        }
    }
289

290
291
292
    // 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
293
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
294
        if (is_readable($langfile)) {
295
            if ($result = get_string_from_file($identifier, $langfile)) {
296
                return $replacefunc($result, $variables);
297
298
299
300
301
302
303
            }
        }
    }

    // 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') {
304
        return '[[' . $identifier . '/' . $section . ']]';
305
306
307
308
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
    foreach ($locations as $location) {
309
        $langfile = $location . $lang . '/langconfig.php';
Penny Leach's avatar
Penny Leach committed
310
        if (is_readable($langfile)) {
311
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
312
                $langfile = $location . $parentlang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
313
                if (is_readable($langfile)) {
314
                    if ($result = get_string_from_file($identifier, $langfile)) {
315
                        return $replacefunc($result, $variables);
316
317
318
319
320
321
322
323
324
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
325
        $langfile = $location . 'en.utf8/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
326
        if (is_readable($langfile)) {
327
            if ($result = get_string_from_file($identifier, $langfile)) {
328
                return $replacefunc($result, $variables);
329
330
331
332
            }
        }
    }

333
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
334
}
335
336


337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
    $langbase = get_config('docroot') . 'lang/';
    if (!$langdir = opendir($langbase)) {
        throw new Exception('Unable to read language directory '.$langbase);
    }
    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)) {
        throw new Exception('Unable to read theme directory '.$themebase);
    }
    while (false !== ($subdir = readdir($themedir))) {
        if ($subdir != "." && $subdir != "..") {
372
373
374
375
376
377
378
379
380
            $themes[$subdir] = $subdir;

            $config_path = get_config('docroot') . 'theme/' . $subdir . '/config.php';
            if (is_readable($config_path)) {
                require_once($config_path);
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
381
382
383
384
385
386
387
        }
    }
    closedir($themedir);
    return $themes;
}


388
389
390
391
392
393
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
421
422
423
424
425
/**
 * 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
 *
426
 * @param string $ini_get_arg setting to look for
427
428
429
430
431
432
433
434
435
436
437
 * @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;
}

438
439
440
441
442
443
444
445
446
447
448
/**
 * 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 {
449
        $dbconfig = get_records_array('config');
450
    } 
451
    catch (SQLException $e) {
452
453
454
455
        return false;
    }
    
    foreach ($dbconfig as $cfg) {
456
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
457
            // @todo warn that we're overriding db config with $CFG
458
459
460
461
462
463
464
465
466
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
467
468
469
470
471
472
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
473
474
475
476
477
478
479
480
function get_config($key) {
    global $CFG;
    if (array_key_exists($key,$CFG)) {
        return $CFG->$key;
    }
    return null;
}

481
482
483
484
485
486
487
488
489

/**
 * 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) {
490
491
492
493
    global $CFG;

    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
494
495
496
497
498
499
500
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
501
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
502
503
504
    }

    if (!empty($status)) {
505
506
507
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
508

509
510
511
512
513
514
515
516
517
518
519
520
521
522
    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;
523

524
525
526
527
528
529
530
    if (array_key_exists('plugin',$CFG)
        && array_key_exists($plugintype,$CFG->plugin)
        && array_key_exists($pluginname,$CFG->plugin->{$plugintype})
        && array_key_exists($key,$CFG->plugin->{$plugintype}->{$pluginname})) {
        return  $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
    }
    
531
532
533
    // @todo: an optimisation might be to get all fields related to the plugin instead, as
    // it may be quite likely that if one config item is requested for a plugin another
    // might be.
534
    if (!$value = get_field($plugintype . '_config', 'value', 'plugin', $pluginname, 'field', $key)) {
535
        $value = null;
536
537
    }

538
539
540
541
    $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
    return $value;
}

Penny Leach's avatar
Penny Leach committed
542
function set_config_plugin($plugintype, $pluginname, $key, $value) {
543
    global $CFG;
544
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
545

546
547
548
    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
549
550
551
552
553
554
555
556
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
557
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
558
559
560
561
562
563
564
565
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

566
/**
567
568
569
570
571
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
572
573
574
575
576
577
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

578
/**
579
580
581
582
583
584
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
585
586
function current_language() {
    global $USER, $CFG;
587
    if ($USER instanceof User && null !== ($lang = $USER->get_account_preference('lang'))) {
588
        return $lang;
589
590
591
592
593
594
595
    }
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

596
/**
597
598
599
600
601
602
 * 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
 */
603
604
605
606
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

607
608
609
610
611
612
613
614
615
616
617
618
619
/**
 * 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);
}

620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
/**
 * 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); 
638
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
639
            // @todo has the umask been clobbered at this point, and is this a bad thing?
640
641
642
643
644
        }
    }
    return $status;
}

Penny Leach's avatar
Penny Leach committed
645
646
647
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
648
 *
Penny Leach's avatar
Penny Leach committed
649
650
 * This function is the one safe point to require plugin files.
 * so USE it :)
651
 *
Penny Leach's avatar
Penny Leach committed
652
653
654
655
656
657
 * @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
 */
658
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
659
660
661
662
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
663
664
    require_once(get_config('docroot') . $plugintype . '/lib.php');

665
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
        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); }
    
}

694
695
696
697
698
699
700
/**
 * This function returns the list of plugintypes we currently care about
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
701
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search');
702
703
704
705
    }
    return $pluginstocheck;
}

706
707
708
709
710
711
712
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
713
    return get_records_array($plugintype . '_installed');
714
715
}

716
717
718
719
720
721
722
723
724
725
726
/**
 * 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);
    return call_user_func_array(array($class, $method), $args);
}

727
728
729
730
731
function generate_class_name() {
    $args = func_get_args();
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

732
733
734
735
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

736
737
738
739
740
/**
 * 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
741
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
742
    }
743

744
745
746
747
    if ($data instanceof ArtefactType) {
        // leave it alone
    }
    else if (is_object($data)) {
748
749
        $data = (array)$data;
    }
750
    else if (is_numeric($data)) {
751
752
753
        $data = array('id' => $data);
    }

754
755
756
    // this is here because the core can't listen to events
    // @todo, this is VERY ugly, and someone should fix it
    if ($event == 'createuser') {
757
        activity_set_defaults($data['id']);
758
759
    }

Penny Leach's avatar
Penny Leach committed
760
761
    $plugintypes = plugin_types();
    foreach ($plugintypes as $name) {
762
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
763
            foreach ($subs as $sub) {
764
                safe_require($name, $sub->plugin);
Penny Leach's avatar
Penny Leach committed
765
766
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
767
                    call_static_method($classname, $sub->callfunction, $event, $data);
Penny Leach's avatar
Penny Leach committed
768
769
770
771
772
773
774
775
776
777
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

778
779
780
781
782
783
784
785
786
787
788
789
790
791
/**
 * 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
792
793
/** 
 * Adds stuff to the log
794
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
795
796
797
798
799
800
801
802
803
804
805
806
 *
 * @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) {

}

807
808
809
810
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
811
    log_debug($message);
812
813
814
815
816
817
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

818
819
820
/** 
 * Base class for all plugintypes.
 */
821
class Plugin {
822
    
823
824
    /**
     * This function returns an array of crons it wants to have run
825
     * Each item should be a StdClass object containing - 
826
827
828
829
     * - callfunction (static function on the Plugin Class)
     * - any or all of minute, hour, day, month, dayofweek 
     * (will default to * if not supplied)
     */
830
831
832
833
    public static function get_cron() {
        return array();
    }

834
835
836
837
838
839
840
    /** 
     * 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
     */
841
842
843
844
    public static function get_event_subscriptions() {
        return array();
    }

845
846
847
848
849
850
851

    /**
     * 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) {
852
853
        return true;
    }
854

855
856
857
858
859
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
860
861
862
    public static function has_config() {
        return false;
    }
863
864
}

865
866
867
868
869
/**
 * 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
870
871
 * @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
 * @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
872
873
874
875
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

876
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
877
    if (empty($date)) {
878
        return get_string($notspecifiedkey, $notspecifiedsection);
879
    }
880
881
882
    return strftime(get_string($formatkey), $date);
}

883
884
885
/**
 * Returns a random string suitable for registration/change password requests
 *
886
 * @param int $length The length of the key to return
887
888
 * @return string
 */
889
890
891
892
function get_random_key($length=16) {
    if ($length < 1) {
        throw new IllegalArgumentException('Length must be a positive number');
    }
893
894
895
896
897
898
899
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
900
    for ($i = 0; $i < $length; $i++) {
901
902
903
904
905
        $result .= $pool[$i];
    }
    return $result;
}

906

907
908
909
910
//
// Pieform related functions
//

911
912
913
/**
 * Configures a default form
 */
914
function pieform_configure() {
915
    global $USER;
916
    return array(
917
918
        'method'    => 'post',
        'action'    => '',
919
        'autofocus' => true,
920
        'renderer'  => 'maharatable',
Nigel McNie's avatar
Nigel McNie committed
921
        'elementclasses' => true,
922
923
924
925
926
927
        'jserrorcallback'       => 'formError',
        'globaljserrorcallback' => 'formGlobalError',
        'jssuccesscallback'     => 'formSuccess',
        'presubmitcallback'     => 'formStartProcessing',
        'postsubmitcallback'    => 'formStopProcessing',
        'jserrormessage' => get_string('errorprocessingform'),
928
        'configdirs' => get_config('libroot') . 'form/',
929
        'helpcallback' => 'pieform_get_help',
930
        'elements'   => array(
931
            'sesskey' => array(
932
                'type'  => 'hidden',
933
                'value' => $USER->get('sesskey')
934
935
936
937
938
            )
        )
    );
}

939
940
941
942
943
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
944
    if ($USER && $USER->get('sesskey') != $values['sesskey']) {
945
946
947
948
949
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
950
951
952
953
954
955
956
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
            FROM ' . get_config('dbprefix') . 'usr
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
957
958
959
    }
}

960
function pieform_element_calendar_configure($element) {
961
    $element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
962
    $element['themefile'] = theme_get_url('style/calendar.css');
963
    $element['imagefile'] = theme_get_url('images/calendar.gif');
964
    $element['language'] = 'en'; // @todo: language file names for the js calendar may need to be changed
965
966
967
    return $element;
}

968
function pieform_element_textarea_configure($element) {
969
970
971
    if (!array_key_exists('resizable', $element)) {
        $element['resizable'] = true;
    }
972
973
974
    return $element;
}

975
976
977
978
979
980
981
982
983
984
/**
 * 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
985
function can_view_view($view_id, $user_id=null) {
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
    global $USER;
    $now = time();
    $dbnow = db_format_timestamp($now);
    $prefix = get_config('dbprefix');

    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,
1002
            v.submittedto,
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
            ' . db_format_tsfield('a.startdate','access_startdate') . ',
            ' . db_format_tsfield('a.stopdate','access_stopdate') . '
        FROM
            ' . $prefix . 'view v
            LEFT OUTER JOIN ' . $prefix . 'view_access a ON v.id=a.view
        WHERE v.id=?
    ', array($view_id));

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

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

1017
    //log_debug('Can you look at this view? (you are user ' . $user_id . ' trying to look at view ' . $view_id . ')');
1018
1019
1020
1021
1022
1023

    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;
1024
        $view_record['submittedto'] = $row->submittedto;
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036

        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) {
1037
        //log_debug('Yes - you own this view');
1038
1039
1040
        return true;
    }

1041
    if ($view_record['submittedto'] && record_exists('community_member', 'community', $view_record['submittedto'], 'member', $user_id, 'tutor', 1)) {
1042
        //log_debug('Yes - View is submitted for assesment to a community you are a tutor in');
1043
1044
1045
        return true;
    }

1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
    // 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
1057
    ) {
1058

1059
        //log_debug('Yes - View is public');
1060
1061
1062
1063
1064
        return true;
    }

    // everything below this point requires that you be logged in
    if (!$USER->is_logged_in()) {
1065
        //log_debug('No - you are not logged in');
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
        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
1080
    ) {
1081

1082
        //log_debug('Yes - View is available to logged in users');
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
        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(
            'SELECT COUNT(*) FROM ' . $prefix . 'usr_friend f WHERE (usr1=? AND usr2=?) OR (usr1=? AND usr2=?)',
            array( $view_record['owner'], $user_id, $user_id, $view_record['owner'] )
        )
Martyn Smith's avatar
Martyn Smith committed
1101
    ) {
1102
        //log_debug('Yes - View is available to friends of the owner');
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
        return true;
    }

    // check user access
    if (get_field_sql(
        'SELECT
            a.view
        FROM 
            ' . $prefix . 'view_access_usr a
        WHERE
            a.view=? AND a.usr=?
Martyn Smith's avatar
Martyn Smith committed
1114
1115
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1116
1117
1118
1119
        LIMIT 1',
        array( $view_id, $user_id, $dbnow, $dbnow )
        )
    ) {
1120
        //log_debug('Yes - View is available to your user');
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
        return true;
    }

    // check group access
    if (get_field_sql(
        'SELECT
            a.view
        FROM 
            ' . $prefix . 'view_access_group a
            INNER JOIN ' . $prefix . 'usr_group g ON a.grp = g.id
            INNER JOIN ' . $prefix . 'usr_group_member m ON g.id = m.grp
        WHERE
            a.view=? AND m.member=?
Martyn Smith's avatar
Martyn Smith committed
1134
1135
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1136
1137
1138
1139
        LIMIT 1',
        array( $view_id, $user_id, $dbnow, $dbnow )
        )
    ) {
1140
        //log_debug('Yes - View is available to one of the owners groups');
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
        return true;
    }

    // check community access
    if (get_field_sql(
        'SELECT
            a.view
        FROM
            ' . $prefix . 'view_access_community a
            INNER JOIN ' . $prefix . 'community c ON a.community = c.id
            INNER JOIN ' . $prefix . 'community_member m ON c.id=m.community
        WHERE
1153
            a.view = ? 
Martyn Smith's avatar
Martyn Smith committed
1154
1155
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1156
            AND ( ( m.member = ? AND (a.tutoronly = 0 OR m.tutor = 1 ) ) OR c.owner = ?)
1157
        LIMIT 1',
1158
        array( $view_id, $dbnow, $dbnow, $user_id, $user_id  )
1159
1160
        )
    ) {
1161
        //log_debug('Yes - View is available to a specific community');
1162
1163
1164
        return true;
    }

1165
1166
    // check admin
    if (get_field('usr', 'admin', 'id', $user_id)) {
1167
        //log_debug('Yes - You are a site administrator');
1168
1169
1170
        return true;
    }

1171

1172
    //log_debug('No - nothing matched');
1173
1174
1175
    return false;
}

Penny Leach's avatar
Penny Leach committed
1176
1177
1178
1179
1180
1181
/**
 * 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)
1182
1183
1184
 * @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
1185
1186
1187
1188
1189
1190
 */
function get_views($users, $userlooking=null, $limit=5) {
    $userlooking = optional_userid($userlooking);
    if (is_int($users)) {
        $users = array($users);
    }
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232

    $list = array();

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

    $users = array_flip($users);

    $prefix = get_config('dbprefix');
    $dbnow  = db_format_timestamp(time());

    if ($friends = get_records_sql_array(
        'SELECT
            CASE WHEN usr1=? THEN usr2 ELSE usr1 END AS id
        FROM
            ' . $prefix . 'usr_friend f
        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 
            ' . $prefix . 'view v
            INNER JOIN ' . $prefix . 'view_access a ON
                v.id=a.view
                AND (
                    accesstype IN (\'public\',\'loggedin\')
1233
1234
1235
1236
1237
1238
1239
1240
1241
            ' . (
                    count(preg_grep('/^friend$/', $users)) > 0
                    ?  'OR (
                            accesstype = \'friends\'
                            AND v.owner IN (' . join(',',array_map('db_quote', array_keys(preg_grep('/^friend$/', $users)))) . ')
                        )'
                    : ''
                )
            . '
1242
1243
1244
1245
                )
        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
1246
            AND ( v.stopdate IS NULL OR v.stopdate > ? )
1247
1248
1249
1250
1251
1252
1253
1254
        ',
        array( $dbnow, $dbnow )
        )
    ) {
        foreach ($results as &$row) {
            $list[$row->owner][$row->id] = $row;
        }
    }
Martyn Smith's avatar
Martyn Smith committed
1255
1256

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

Martyn Smith's avatar
Martyn Smith committed
1261
    // check individual user access
1262
1263
1264
1265
1266
1267
1268
1269
    if ($results = get_records_sql_array(
        'SELECT
            v.*,
            ' . db_format_tsfield('atime') . ',
            ' . db_format_tsfield('mtime') . ',
            ' . db_format_tsfield('ctime') . '
        FROM 
            ' . $prefix . 'view v
1270
            INNER JOIN ' . $prefix . 'view_access_usr a ON v.id=a.view AND a.usr=?
1271
1272
1273
        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
1274
            AND ( v.stopdate IS NULL OR v.stopdate > ? )
1275
1276
1277
1278
1279
1280
1281
1282
1283
        ',
        array($userlooking, $dbnow, $dbnow)
        )
    ) {
        foreach ($results as &$row) {
            $list[$row->owner][$row->id] = $row;
        }
    }

Martyn Smith's avatar
Martyn Smith committed
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
    // bail if we've filled all users to the limit
    if (_get_views_trim_list($list, $users, $limit)) {
        return $list;
    }

    // check group access
    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 
            ' . $prefix . 'view v
1298
1299
            INNER JOIN ' . $prefix . 'view_access_group a ON v.id=a.view
            INNER JOIN ' . $prefix . 'usr_group_member m ON m.grp=a.grp AND m.member=?
Martyn Smith's avatar
Martyn Smith committed
1300
1301
1302
        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
1303
            AND ( v.stopdate IS NULL OR v.stopdate > ? )
Martyn Smith's avatar
Martyn Smith committed
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
        ',
        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;
    }

    // check community access
    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 
            ' . $prefix . 'view v
1327
1328
            INNER JOIN ' . $prefix . 'view_access_community a ON v.id=a.view
            INNER JOIN ' . $prefix . 'community_member m ON m.community=a.community AND m.member=?
Martyn Smith's avatar
Martyn Smith committed
1329
1330
1331
        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
1332
            AND ( v.stopdate IS NULL OR v.stopdate > ? )
Martyn Smith's avatar
Martyn Smith committed
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
        ',
        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;
    }
1346
1347
1348
1349
1350
1351
1352
1353

    return $list;
}

function _get_views_trim_list(&$list, &$users, $limit) {
    if ($limit === null) {
        return;
    }
1354
1355
1356
1357
1358
1359
1360
1361
1362
    foreach ($list as $user_id => &$views) {
        if($limit and count($views) > $limit) {
            $views = array_slice($views, 0, $limit);
        }
        if($limit and count($views) == $limit) {
            unset($users[$user_id]);
        }
    }
    if (count($users) == 0) {
1363
        return true;
1364
    }
1365
    return false;
Penny Leach's avatar
Penny Leach committed
1366
1367
}

1368
1369
1370
function artefact_in_view($artefact, $view) {
    $prefix = get_config('dbprefix');
    $sql = 'SELECT a.id 
Nigel McNie's avatar
Nigel McNie committed
1371
            FROM ' . $prefix . 'view_artefact a WHERE view = ? AND artefact = ?
1372
1373
            UNION
            SELECT c.parent 
Nigel McNie's avatar
Nigel McNie committed
1374
            FROM ' . $prefix . 'view_artefact top JOIN ' . $prefix . 'artefact_parent_cache c
1375
1376
1377
1378
1379
1380
              ON c.parent = top.artefact 
            WHERE top.view = ? AND c.artefact = ?';

    return record_exists_sql($sql, array($view, $artefact, $view, $artefact));
}

1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
function get_dir_contents($directory) {
    $contents = array();
    $dirhandle = opendir($directory);
    while (false !== ($dir = readdir($dirhandle))) {
        if (strpos($dir, '.') === 0) {
            continue;
        }
        $contents[] = $dir;
    }
    return $contents;
}

1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
/**
 * Returns the subdirectory where mahara is installed, normally / but could
 * be something different on a shared host. Useful for setting cookie paths.
 *
 * @return string
 */
function get_mahara_install_subdirectory() {
    $wwwroot = get_config('wwwroot');
    $wwwroot = preg_replace('#^https?://#', '', $wwwroot);
    return substr($wwwroot, strpos($wwwroot, '/'));
}

1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
/**
 *** get_performance_info() pairs up with init_performance_info()
 *** loaded in init.php. Returns an array with 'html' and 'txt'
 *** values ready for use, and each of the individual stats provided
 *** separately as well.
 ***
 **/
function get_performance_info() {

    if (!get_config('perftofoot') && !get_config('perftolog')) {
        return array();
    }

    global $PERF;

    $info = array();

    $info['realtime'] = microtime_diff($PERF->starttime, microtime());


    if (function_exists('memory_get_usage')) {
        $info['memory_total'] = memory_get_usage();
        $info['memory_growth'] = memory_get_usage() - $PERF->startmemory;
    }

    $inc = get_included_files();
    $info['includecount'] = count($inc);

1433
1434
1435
1436
1437
1438
1439

    if (!empty($PERF->dbreads)) {
        $info['dbreads'] = $PERF->dbreads;
    }

    if (!empty($PERF->dbwrites)) {
        $info['dbwrites'] = $PERF->dbwrites;
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
    }

    if (function_exists('posix_times')) {
        $ptimes = posix_times();
        if (is_array($ptimes)) {
            foreach ($ptimes as $key => $val) {
                $info[$key] = $ptimes[$key] -  $PERF->startposixtimes[$key];
            }
        }
    }

    // Grab the load average for the last minute
    // /proc will only work under some linux configurations
    // while uptime is there under MacOSX/Darwin and other unices
    if (is_readable('/proc/loadavg') && $loadavg = @file('/proc/loadavg')) {
        list($server_load) = explode(' ', $loadavg[0]);
        unset($loadavg);
    } else if ( function_exists('is_executable') && is_executable('/usr/bin/uptime') && $loadavg = `/usr/bin/uptime` ) {
        if (preg_match('/load averages?: (\d+[\.,:]\d+)/', $loadavg, $matches)) {
            $server_load = $matches[1];
        } else {
            log_debug('PERF: Could not parse uptime output!');
        }
    }
    if (!empty($server_load)) {
        $info['serverload'] = $server_load;
    }

    return $info;
}

1471
function perf_to_log($info=null) {
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
    if (!get_config('perftolog')) {