mahara.php 62.2 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
 *
 * @package    mahara
 * @subpackage core
21
 * @author     Catalyst IT Ltd
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
24
 * @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
    // PHP version
37
    if (version_compare(phpversion(), '5.1.3') < 0) {
38
39
40
41
42
43
44
        throw new ConfigSanityException(get_string('phpversion', 'error'));
    }

    // Various required extensions
    if (!extension_loaded('json')) {
        throw new ConfigSanityException(get_string('jsonextensionnotloaded', 'error'));
    }
45
46
47
48
49
50
    switch (get_config('dbtype')) {
    case 'postgres8':
        if (!extension_loaded('pgsql')) {
            throw new ConfigSanityException(get_string('pgsqldbextensionnotloaded', 'error'));
        }
        break;
51
    case 'mysql5':
52
53
54
55
56
57
        if (!extension_loaded('mysql')) {
            throw new ConfigSanityException(get_string('mysqldbextensionnotloaded', 'error'));
        }
        break;
    default:
        throw new ConfigSanityException(get_string('unknowndbtype', 'error'));
58
    }
59
60
61
    if (!extension_loaded('xml')) {
        throw new ConfigSanityException(get_string('xmlextensionnotloaded', 'error', 'xml'));
    }
62
    if (!extension_loaded('libxml')) {
63
        throw new ConfigSanityException(get_string('xmlextensionnotloaded', 'error', 'libxml'));
64
65
66
67
68
69
70
71
    }
    if (!extension_loaded('gd')) {
        throw new ConfigSanityException(get_string('gdextensionnotloaded', 'error'));
    }
    if (!extension_loaded('session')) {
        throw new ConfigSanityException(get_string('sessionextensionnotloaded', 'error'));
    }

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

    // magic_quotes_gpc workaround
82
    if (!defined('CRON') && ini_get_bool('magic_quotes_gpc')) {
83
        log_environ(get_string('magicquotesgpc', 'error'));
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
        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]);
            }
        }
    }

103
    if (ini_get_bool('magic_quotes_runtime')) {
104
105
106
107
108
109
110
111
112
        // 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'));
113
114
    }

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

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

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

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

137
138
139
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
140
141
        !check_dir_exists(get_config('dataroot') . 'sessions') ||
        !check_dir_exists(get_config('dataroot') . 'htmlpurifier')) {
142
143
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
144
145

    raise_memory_limit('32M');
146
147
}

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

162
function get_string($identifier, $section='mahara') {
163
164
165
166
167

    $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.
168
169
    }
    else {
170
171
172
        $variables = array();
    }
    
173
174
175
    return get_string_location($identifier, $section, $variables);
}

176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
function get_string_from_language($lang, $identifier, $section='mahara') {

    $variables = func_get_args();
    if (count($variables) > 3) { // we have some stuff we need to sprintf
        array_shift($variables);
        array_shift($variables);
        array_shift($variables); //shift off the first three.
    }
    else {
        $variables = array();
    }
    
    return get_string_location($identifier, $section, $variables, 'format_langstring', $lang);
}

191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
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);
211
212
213
214
215
216
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
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
    }
    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)) {
248
        $langfile = get_config('docroot') . 'lang/' . $lang . '/langconfig.php';
249
250
251
252
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
253
            $langfile = get_config('docroot') . 'lang/' . $parentlang . '/' . $file;
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
            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;
}

270
271
272
273
274
// 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.
275
276
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
277
278
279
280
281
282
283
284
285
286
287
288
289
290
}


/**
 * 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
 */
291
function get_string_location($identifier, $section, $variables, $replacefunc='format_langstring', $lang='') {
292

293
    $langconfigstrs = array('parentlanguage', 'strftimedate', 'strftimedateshort', 'strftimedatetime', 'strftimedatetimeshort',
294
295
                            'strftimedaydate', 'strftimedaydatetime', 'strftimedayshort', 'strftimedaytime',
                            'strftimemonthyear', 'strftimerecent', 'strftimerecentfull', 'strftimetime',
Richard Mansfield's avatar
Richard Mansfield committed
296
                            'strfdaymonthyearshort', 'thislanguage');
297
298
299
300
301

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

302
303
304
    if (empty($lang)) {
        $lang = current_language();
    }
305
306

    // Define the locations of language strings for this section
307
308
    $langstringroot = get_language_root();
    $langdirectory  = ''; // The directory in which the language file for this string should ideally reside, if the language has implemented it
309
    
310
    if (false === strpos($section, '.')) {
311
        $langdirectory = 'lang/';
312
313
314
    }
    else {
        $extras = plugin_types(); // more later..
315
        foreach ($extras as $tocheck) {
316
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
317
                $pluginname = substr($section ,strlen($tocheck) + 1);
318
319
320
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
321
                    $langdirectory = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
322
                    $section = 'blocktype.' . $bits[1];
323
324
                }
                else {
325
                    $langdirectory = $tocheck . '/' . $pluginname . '/lang/';
326
                }
327
328
329
            }
        }
    }
330

331
    // First check all the normal locations for the string in the current language
332
333
334
335
    $langfile = $langstringroot . $langdirectory . $lang . '/' . $section . '.php';
    if (is_readable($langfile)) {
        if ($result = get_string_from_file($identifier, $langfile)) {
            return $replacefunc($result, $variables);
336
337
338
339
340
341
        }
    }

    // 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') {
342
        return '[[' . $identifier . '/' . $section . ']]';
343
344
345
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
346
347
348
349
350
351
352
    $langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
    if (is_readable($langfile)) {
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            $langfile = get_language_root($parentlang) . 'lang/' . $parentlang . '/' . $section . '.php';
            if (is_readable($langfile)) {
                if ($result = get_string_from_file($identifier, $langfile)) {
                    return $replacefunc($result, $variables);
353
354
355
356
357
358
                }
            }
        }
    }

    /// Our only remaining option is to try English
359
360
361
362
    $langfile = get_config('docroot') . $langdirectory . 'en.utf8/' . $section . '.php';
    if (is_readable($langfile)) {
        if ($result = get_string_from_file($identifier, $langfile)) {
            return $replacefunc($result, $variables);
363
364
365
        }
    }

366
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
367
}
368
369


370
371
372
373
374
375
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
376
377
378
379
380
381
382
383
384
385
386
387

    foreach (language_get_searchpaths() as $searchpath) {
        $langbase = $searchpath . '/lang/';
        if (!$langdir = opendir($langbase)) {
            throw new SystemException('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;
                }
388
389
            }
        }
390
        closedir($langdir);
391
    }
392

393
394
395
    return $langs;
}

396
397
398
399
function language_installed($lang) {
    return is_readable(get_config('docroot') . 'lang/' . $lang . '/langconfig.php');
}

400
401
402
403
404
405
406
407
408
409
/**
 * Returns a list of directories in which to search for language packs.
 *
 * This is influenced by the configuration variable 'langpacksearchpaths'
 */
function language_get_searchpaths() {
    static $searchpaths = array();

    if (!$searchpaths) {
        $searchpaths = array(get_config('docroot'));
410
411
412
413
        if ($langpacksearchpaths = get_config('langpacksearchpaths')) {
            foreach ($langpacksearchpaths as $path) {
                $searchpaths[] = (substr($path, -1) == '/') ? $path : "$path/";
            }
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
        }
    }

    return $searchpaths;
}

/**
 * Get the directory in which the specified language pack resides.
 *
 * Defaults to getting the directory for the current_language() - i.e. the 
 * language the user is using
 *
 * Returns null if the language can't be found
 *
 * @param string $language The language to look for
 */
function get_language_root($language=null) {
    static $language_root_cache = array();

    if (!isset($language_root_cache[$language])) {
        if ($language == null) {
            $language = current_language();
        }

        foreach (language_get_searchpaths() as $path) {
            if (is_dir("$path/lang/$language")) {
                return $language_root_cache[$language] = $path;
            }
        }

        // Oh noes, can't be found
        $language_root_cache[$language] = null;

    }

    return $language_root_cache[$language];
}

452
/**
453
 * Return a list of available themes.
454
 *
455
 * Themes _must_ have a config.php, and it should specify a theme name.
456
457
458
459
460
 */
function get_themes() {
    $themes = array();
    $themebase = get_config('docroot') . 'theme/';
    if (!$themedir = opendir($themebase)) {
461
        throw new SystemException('Unable to read theme directory '.$themebase);
462
463
    }
    while (false !== ($subdir = readdir($themedir))) {
464
465
        if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
            $config_path = $themebase . $subdir . '/config.php';
466
            if (is_readable($config_path)) {
467
                require($config_path);
468
469
470
471
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
472
473
474
475
476
477
478
        }
    }
    closedir($themedir);
    return $themes;
}


479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
/**
 * 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
 *
517
 * @param string $ini_get_arg setting to look for
518
519
520
521
522
523
524
525
526
527
528
 * @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;
}

529
530
531
532
533
534
535
536
537
538
/**
 * 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;
    
539
    $dbconfig = get_records_array('config', '', '', '', 'field, value');
540
541
    
    foreach ($dbconfig as $cfg) {
542
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
543
            // @todo warn that we're overriding db config with $CFG
544
545
546
547
548
549
550
551
552
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
553
554
555
556
557
558
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
559
560
function get_config($key) {
    global $CFG;
561
    if (isset($CFG->$key)) {
562
563
564
565
566
        return $CFG->$key;
    }
    return null;
}

567
568
569
570
571
572
573
574
575

/**
 * 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) {
576
577
    global $CFG;

578
    db_ignore_sql_exceptions(true);
579
580
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
581
582
583
584
585
586
587
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
588
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
589
    }
590
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
591
592

    if (!empty($status)) {
593
594
595
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
596

597
598
599
600
601
602
603
604
605
606
607
608
609
610
    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;
611

612
613
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
614
    if (isset($value)) {
615
616
617
618
        return $value;
    }

    $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
619
    if (!empty($records)) {
620
621
        foreach($records as $record) {
            $CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
622
            if ($record->field == $key) {
623
624
625
                $value = $record->value;
            }
        }
626
627
    }

628
629
630
    return $value;
}

Penny Leach's avatar
Penny Leach committed
631
function set_config_plugin($plugintype, $pluginname, $key, $value) {
632
    global $CFG;
633
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
634

635
636
637
    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
638
639
640
641
642
643
644
645
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
646
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
647
648
649
650
651
652
653
654
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

655
656
657
658
659
660
661
662
663
664
/**
 * 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
 */
665
function get_config_plugin_instance($plugintype, $pluginid, $key) {
666
667
668
669
670
671
    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
672
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
673
    if (isset($value)) {
674
675
676
        return $value;
    }

677
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
678
    if (!empty($records)) {
679
        foreach($records as $record) {
680
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
681
            if ($record->field == $key) {
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
                $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;
}

725
/**
726
727
728
729
730
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
731
732
733
734
735
736
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

737
/**
738
739
740
741
742
743
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
744
function current_language() {
745
    global $USER, $CFG, $SESSION;
746
747
748
    if ($USER instanceof User) {
        $lang = $USER->get_account_preference('lang');
        if ($lang !== null && $lang != 'default') {
749
750
751
752
            if (language_installed($lang)) {
                return $lang;
            }
            $USER->set_account_preference('lang', 'default');
753
        }
754
    }
755
756
757
758
759
760

    if (is_a($SESSION, 'Session')) {
        $sesslang = $SESSION->get('lang');
        if (!empty($sesslang) && $sesslang != 'default') {
            return $sesslang;
        }
761
    }
762

763
764
765
766
767
768
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

769
/**
770
771
772
773
774
775
 * 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
 */
776
777
778
779
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

780
781
782
783
784
785
786
787
788
789
790
791
792
/**
 * 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);
}

793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
/**
 * 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 {
810
811
812
            $mask = umask(0000);
            $status = @mkdir($dir, get_config('directorypermissions'), true);
            umask($mask);
813
814
815
816
817
        }
    }
    return $status;
}

Penny Leach's avatar
Penny Leach committed
818
819
820
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
821
 *
Penny Leach's avatar
Penny Leach committed
822
823
 * This function is the one safe point to require plugin files.
 * so USE it :)
824
 *
Penny Leach's avatar
Penny Leach committed
825
826
827
828
829
830
 * @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
 */
831
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
832
833
834
835
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
836
837
    require_once(get_config('docroot') . $plugintype . '/lib.php');

838
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
839
840
841
842
843
844
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ('invalid require type');
    }

845
846
847
848
849
    if ($plugintype == 'blocktype') { // these are a bit of a special case
        $bits = explode('/', $pluginname);
        if (count($bits) == 2) {
           $fullpath = get_config('docroot') . 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/' . $filename;
        }
850
        else {
851
852
853
854
855
856
857
858
859
            try {
                if ($artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $pluginname)) {
                    $fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
                }
            }
            catch (SQLException $e) {
                if (get_config('installed')) {
                    throw $e;
                }
860
861
            }
        }
862
863
864
865
866
    } 
    if (empty($fullpath)) {
        $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    }

Penny Leach's avatar
Penny Leach committed
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
    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); }
    
}

888
/**
889
890
891
892
 * This function returns the list of plugintypes we currently care about.
 *
 * NOTE: use plugin_types_installed if you just want the installed ones.
 *
893
894
895
896
897
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
898
        // ORDER MATTERS! artefact has to be first!
899
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype', 'interaction', 'grouptype');
900
901
902
903
    }
    return $pluginstocheck;
}

904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
/**
 * Returns plugin types that are actually installed
 */
function plugin_types_installed() {
    static $plugins = array();
    if (empty($plugins)) {
        require_once('ddl.php');
        foreach (plugin_types() as $plugin) {
            if (table_exists(new XMLDBTable("{$plugin}_installed"))) {
                $plugins[] = $plugin;
            }
        }
    }
    return $plugins;
}

920
921
922
923
924
925
926
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
927
    return get_records_array($plugintype . '_installed');
928
929
}

930
931
932
933
934
935
936
937
/**
 * 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);
938
    return call_user_func_array(array($class, $method), $args);
939
940
}

941
942
function generate_class_name() {
    $args = func_get_args();
943
    if (count($args) == 2 && $args[0] == 'blocktype') {
944
        return 'PluginBlocktype' . ucfirst(blocktype_namespaced_to_single($args[1]));
945
    }
946
947
948
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

949
950
951
952
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

953
954
955
956
function generate_interaction_instance_class_name($type) {
    return 'Interaction' . ucfirst($type) . 'Instance';
}

957
958
959
960
961
962
963
964
965
966
967
968
function blocktype_namespaced_to_single($blocktype) {
    if (strpos($blocktype, '/') === false) { // system blocktype
        return $blocktype;
    }
    return substr($blocktype, strpos($blocktype, '/') + 1 );
}

function blocktype_single_to_namespaced($blocktype, $artefact='') {
    if (empty($artefact)) {
        return $blocktype;
    }
    return $artefact . '/' . $blocktype;
969
970
}

971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
/**
 * Given a blocktype name, convert it to the namespaced version.
 *
 * This will be $artefacttype/$blocktype, or just plain $blocktype for system 
 * blocktypes.
 *
 * This is useful for language strings
 */
function blocktype_name_to_namespaced($blocktype) {
    static $resultcache = array();

    if (!isset($resultcache[$blocktype])) {
        $artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $blocktype);
        if ($artefactplugin) {
            $resultcache[$blocktype] = "$artefactplugin/$blocktype";
        }
        else {
            $resultcache[$blocktype] = $blocktype;
        }
    }

    return $resultcache[$blocktype];
}

995

996
997
998
999
1000
/**
 * 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
1001
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
1002
    }
1003

1004
    if ($data instanceof ArtefactType || $data instanceof BlockInstance) {
1005
1006
1007
        // leave it alone
    }
    else if (is_object($data)) {
1008
1009
        $data = (array)$data;
    }
1010
    else if (is_numeric($data)) {
1011
1012
1013
        $data = array('id' => $data);
    }

1014
    if ($coreevents = get_records_array('event_subscription', 'event', $event)) {
1015
        require_once('activity.php'); // core events can generate activity.
1016
1017
1018
1019
1020
1021
1022
1023
1024
        foreach ($coreevents as $ce) {
            if (function_exists($ce->callfunction)) {
                call_user_func($ce->callfunction, $data);
            }
            else {
                log_warn("Event $event caused a problem with a core subscription "
                . " $ce->callfunction, which wasn't callable.  Continuing with event handlers");
            }
        }
1025
1026
    }

1027
    $plugintypes = plugin_types_installed();
Penny Leach's avatar
Penny Leach committed
1028
    foreach ($plugintypes as $name) {
1029
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
1030
            foreach ($subs as $sub) {
1031
                safe_require($name, $sub->plugin);
Penny Leach's avatar
Penny Leach committed
1032
1033
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
1034
                    call_static_method($classname, $sub->callfunction, $event, $data);
Penny Leach's avatar
Penny Leach committed
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
/**
 * 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
1059
1060
/** 
 * Adds stuff to the log
1061
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 *
 * @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) {

}

1074
1075
1076
1077
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
1078
    log_debug($message);
1079
1080
1081
1082
1083
1084
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

1085
1086
1087
/** 
 * Base class for all plugintypes.
 */
1088
class Plugin {
1089
    
1090
1091
    /**
     * This function returns an array of crons it wants to have run
1092
     * Each item should be a StdClass object containing - 
1093
1094
1095
1096
     * - callfunction (static function on the Plugin Class)
     * - any or all of minute, hour, day, month, dayofweek 
     * (will default to * if not supplied)
     */
1097
1098
1099
1100
    public static function get_cron() {
        return array();
    }

1101
1102
1103
1104
1105
1106
1107
    /** 
     * 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
     */
1108
1109
1110
1111
    public static function get_event_subscriptions() {
        return array();
    }

1112
1113
1114
1115
1116
1117
1118

    /**
     * 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) {
1119
1120
        return true;
    }
1121

1122
1123
1124
1125
1126
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
1127
1128
1129
    public static function has_config() {
        return false;
    }
1130
1131
1132
1133
1134
1135
1136
1137
1138

    /**
    * Does this plugin offer any activity types
    * If it does, you must subclass ActivityTypePlugin like 
    * ActivityType{$PluginType}{$Pluginname}
    */
    public static function get_activity_types() {
        return array();
    }
1139
1140
}

1141
1142
1143
1144
1145
/**
 * 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
1146
1147
 * @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
 * @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
1148
1149
1150
1151
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

1152
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
1153
    if (empty($date)) {
1154
        return get_string($notspecifiedkey, $notspecifiedsection);
1155
    }
1156
1157
1158
    return strftime(get_string($formatkey), $date);
}

1159
1160
1161
/**
 * Returns a random string suitable for registration/change password requests
 *
1162
 * @param int $length The length of the key to return
1163
1164
 * @return string
 */
1165
1166
1167
1168
function get_random_key($length=16) {
    if ($length < 1) {
        throw new IllegalArgumentException('Length must be a positive number');
    }
1169
1170
1171
1172
1173
1174
1175
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
1176
    for ($i = 0; $i < $length; $i++) {
1177
1178
1179
1180
1181
        $result .= $pool[$i];
    }
    return $result;
}

1182

1183
1184
1185
1186
//
// Pieform related functions
//

1187
1188
1189
/**
 * Configures a default form
 */
1190
function pieform_configure() {
1191
    global $USER;
1192
1193
    $theme = ($USER->get('theme')) ? $USER->get('theme') : 'default';
    require(get_config('docroot') . 'theme/' . $theme . '/config.php');
1194
    return array(
1195
1196
        'method'    => 'post',
        'action'    => '',
1197
        'language'  => current_language(),
1198
        'autofocus' => true,
1199
        'renderer'  => (isset($theme->formrenderer)) ? $theme->formrenderer : 'table',
1200
        'requiredmarker' => true,
Nigel McNie's avatar
Nigel McNie committed
1201
        'elementclasses' => true,
1202
        'descriptionintwocells' => true,
1203
        'jsdirectory'    => get_config('wwwroot') . 'lib/pieforms/static/core/',
1204
        'replycallback'  => 'pieform_reply',
1205
1206
1207
1208
1209
1210
        'jserrorcallback'       => 'formError',
        'globaljserrorcallback' => 'formGlobalError',
        'jssuccesscallback'     => 'formSuccess',
        'presubmitcallback'     => 'formStartProcessing',
        'postsubmitcallback'    => 'formStopProcessing',
        'jserrormessage' => get_string('errorprocessingform'),
1211
        'configdirs' => get_config('libroot') . 'form/',
1212
        'helpcallback' => 'pieform_get_help',
1213
        'elements'   => array(
1214
            'sesskey' => array(
1215
                'type'  => 'hidden',
1216
                'value' => $USER->get('sesskey')
1217
1218
1219
1220
1221
            )
        )
    );
}

1222
1223
1224
1225
1226
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
1227
    if ($USER && $USER->is_logged_in() && $USER->get('sesskey') != $values['sesskey']) {
1228
1229
1230
1231
1232
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
1233
1234
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
1235
            FROM {usr}
1236
1237
1238
1239
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
1240
1241
1242
    }
}

1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
function pieform_reply($code, $data) {
    global $SESSION;
    if (isset($data['message'])) {
        if ($code == PIEFORM_ERR) {
            $SESSION->add_error_msg($data['message']);
        }
        else {
            $SESSION->add_ok_msg($data['message']);
        }
    }
    if (isset($data['goto'])) {
        redirect($data['goto']);
    }
    // NOT explicitly exiting here. Pieforms will throw an exception which will 
    // force the user to fix their form
}

1260
function pieform_element_calendar_configure($element) {
1261
    $element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
1262
    $element['themefile'] = theme_get_url('style/calendar.css');
1263
    $element['imagefile'] = theme_get_url('images/calendar.gif');
1264
    $language = substr(current_language(), 0, 2);
1265
    $element['language'] = $language;
1266
1267
1268
    return $element;
}

1269
function pieform_element_textarea_configure($element) {
1270
1271
1272
    if (!array_key_exists('resizable', $element)) {
        $element['resizable'] = true;
    }
1273
1274
1275
    return $element;
}

1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
/**
 * Should be used to provide the 'templatedir' directive to pieforms using a 
 * template for layout.
 *
 * This depends on theme_setup(), so potentially should be in lib/web.php, but 
 * for now it lives with the other pieform functions.
 *
 * @param string $file The file to be used as a pieform template, e.g. 
 *                     "admin/site/files.php". This is the value you used as 
 *                     the 'template' option for your pieform
 * @param string $pluginlocation Which plugin to search for the template, e.g. 
 *                               artefact/file
 */
function pieform_template_dir($file, $pluginlocation='') {
    $theme = theme_setup();

    foreach ($theme->inheritance as $themedir) {
1293
        $filepath = get_config('docroot') . $pluginlocation . '/theme/' . $themedir . '/pieforms/' . $file;
1294
1295
1296
1297
1298
1299
1300
        if (is_readable($filepath)) {
            return dirname($filepath);
        }
    }
    throw new SystemException('No pieform template available: ' . $file);
}

1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
/**
 * 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.
 */
Richard Mansfield's avatar
Richard Mansfield committed
1311
function can_view_view($view_id, $user_id=null, $token=null) {
1312
1313
1314
1315
1316
1317
1318
1319
    global $USER;
    $now = time();
    $dbnow = db_format_timestamp($now);

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

Richard Mansfield's avatar
Richard Mansfield committed
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
    $publicviews = get_config('allowpublicviews');
    if ($publicviews) {
        if (!$token) {
            $token = get_cookie('viewaccess:'.$view_id);
        }
        if ($token && (!$user_id || $user_id == $USER->get('id')) && $view_id == get_view_from_token($token)) {
            return true;
        }
    }

1330
    if (!$USER->is_logged_in()) {
1331
        // check public
Richard Mansfield's avatar
Richard Mansfield committed
1332
1333
1334
1335
        $publicprofiles = get_config('allowpublicprofiles');
        if ($publicviews || $publicprofiles) {
            $public = get_record_sql("
                SELECT
1336
                    v.id, v.type, a.*
Richard Mansfield's avatar
Richard Mansfield committed
1337
1338
1339
1340
                FROM
                    {view} v
                    LEFT OUTER JOIN {view_access} a ON v.id = a.view
                WHERE
1341
                    v.id = ? AND a.accesstype = 'public'
Richard Mansfield's avatar
Richard Mansfield committed
1342
1343
            ", array($view_id));
            return $public && 
1344