mahara.php 84.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
5
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
6
 *
Francois Marier's avatar
Francois Marier committed
7
8
9
10
 * 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.
11
 *
Francois Marier's avatar
Francois Marier committed
12
13
14
15
 * 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.
16
 *
Francois Marier's avatar
Francois Marier committed
17
18
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20
21
 *
 * @package    mahara
 * @subpackage core
22
 * @author     Catalyst IT Ltd
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
25
 * @copyright  (C) portions from Moodle, (C) Martin Dougiamas http://dougiamas.com
26
27
 */

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

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

37
    // PHP version
38
39
40
    $phpversionrequired = '5.2.0';
    if (version_compare(phpversion(), $phpversionrequired) < 0) {
        throw new ConfigSanityException(get_string('phpversion', 'error', $phpversionrequired));
41
42
43
44
45
46
    }

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

74
75
76
    if(!extension_loaded('curl')) {
        throw new ConfigSanityException(get_string('curllibrarynotinstalled', 'error'));
    }
77
78
79
    if (!extension_loaded('dom')) {
        throw new ConfigSanityException(get_string('domextensionnotloaded', 'error'));
    }
80

81
82
83
84
85
86
    //Check for freetype in the gd extension
    $gd_info = gd_info();
    if (!$gd_info['FreeType Support']) {
        throw new ConfigSanityException(get_string('gdfreetypenotloaded', 'error'));
    }

87
88
    // register globals workaround
    if (ini_get_bool('register_globals')) {
89
        $massivearray = array_keys(array_merge($_POST, $_GET, $_COOKIE, $_SERVER, $_REQUEST, $_FILES));
90
91
92
93
94
95
        foreach ($massivearray as $tounset) {
            unset($GLOBALS[$tounset]);
        }
    }

    // magic_quotes_gpc workaround
96
    if (!defined('CRON') && ini_get_bool('magic_quotes_gpc')) {
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
        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]);
            }
        }
    }

116
    if (ini_get_bool('magic_quotes_runtime')) {
117
118
119
120
121
122
123
        // Turn of magic_quotes_runtime. Anyone with this on deserves a slap in the face
        set_magic_quotes_runtime(0);
    }

    if (ini_get_bool('magic_quotes_sybase')) {
        // See above comment re. magic_quotes_runtime
        @ini_set('magic_quotes_sybase', 0);
124
125
    }

126
127
128
    if (ini_get_bool('safe_mode')) {
        // We don't run with safe mode
        throw new ConfigSanityException(get_string('safemodeon', 'error'));
129
130
    }

131
132
133
134
135
    if ('0' === ini_get('apc.stat') or 'off' === ini_get('apc.stat')) {
        // We don't run with apc.stat=0 (see https://bugs.launchpad.net/mahara/+bug/548333)
        throw new ConfigSanityException(get_string('apcstatoff', 'error'));
    }

136
137
138
139
140
141
142
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

143
    // dataroot inside document root.
144
145
    if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
        throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
146
147
    }

148
149
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
150
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
151
    }
152

153
154
155
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
156
        !check_dir_exists(get_config('dataroot') . 'sessions') ||
157
        !check_dir_exists(get_config('dataroot') . 'temp') ||
158
        !check_dir_exists(get_config('dataroot') . 'langpacks') ||
159
160
161
        !check_dir_exists(get_config('dataroot') . 'htmlpurifier') ||
        !check_dir_exists(get_config('dataroot') . 'log') ||
        !check_dir_exists(get_config('dataroot') . 'images')) {
162
163
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
164

165
    raise_memory_limit('128M');
166
167
}

168
169
170
171
172
173
174
175
176
177
178
/**
 * Check sanity of things that we only check at installation time - not on 
 * every request, like ensure_sanity() does
 */
function ensure_install_sanity() {
    // Must must must be a UTF8 database!
    if (!db_is_utf8()) {
        throw new ConfigSanityException(get_string('dbnotutf8', 'error'));
    }
}

179
180
181
182
183
184
185
186
187
188
189
190
function ensure_upgrade_sanity() {
    // Check column collation is equal to the default
    if (is_mysql()) {
        require_once('ddl.php');
        if (table_exists(new XMLDBTable('event_type'))) {
            if (!column_collation_is_default('event_type', 'name')) {
                throw new ConfigSanityException(get_string('dbcollationmismatch', 'admin'));
            }
        }
    }
}

191
192
193
194
195
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
196
    if (get_config('installed')) {
197
198
199
200
201
202
203
204
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

205
function get_string($identifier, $section='mahara') {
206
207
208
209
210

    $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.
211
212
    }
    else {
213
214
215
        $variables = array();
    }
    
216
217
218
    return get_string_location($identifier, $section, $variables);
}

219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
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);
}

234
235
236
237
238
239
240
241
242
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) {

243
    $subdir = 'help/';
244
245

    if ($page) {
246
247
        $pagebits = split('-', $page);
        $file = array_pop($pagebits) . '.html';
248
        if ($plugintype != 'core') {
249
            $subdir .= 'pages/' . join('/', $pagebits) . '/';
250
251
        }
        else {
252
            $subdir .= 'pages/' . $pluginname . '/' . join('/', $pagebits) . '/';
253
        } 
254
255
    }
    else if ($section) {
256
257
        $subdir .= 'sections/';
        $file = $section . '.html';
258
259
    }
    else if (!empty($form) && !empty($element)) {
260
261
        $subdir .= 'forms/';
        $file = $form . '.' . $element . '.html';
262
263
    }
    else if (!empty($form) && empty($element)) {
264
265
        $subdir .= 'forms/';
        $file = $form . '.html';
266
267
268
269
270
271
272
273
274
275
276
277
278
279
    }
    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;
    }

280
    //try the local settings
281
282
283
284
285
286
287
    $langfile = get_config('docroot') . 'local/lang/' . $lang . '/' . $subdir;
    if ($plugintype != 'core') {
        $langfile .= $plugintype . '.' . $pluginname . '.' . $file;
    }
    else {
        $langfile .= $file;
    }
288
289
290
291
    if (is_readable($langfile)) {
        return $langfile;
    }

292
293
294
295
296
297
298
    if ($plugintype != 'core') {
        $location = $plugintype . '/' . $pluginname . '/lang/';
    }
    else {
        $location = 'lang/';
    }

299
    // try the current language
300
    $langfile = get_language_root() . $location . $lang . '/' . $subdir . $file;
301
302
303
304
305
306
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
307
        $langfile = get_language_root($lang) . 'lang/' . $lang . '/langconfig.php';
308
309
310
311
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
312
            $langfile = get_language_root($parentlang) . $location . $parentlang . '/' . $subdir . $file;
313
314
315
316
317
318
319
320
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

    // if it's STILL not found, and we haven't already tried english ...
    if (empty($data) && empty($trieden)) {
321
        $langfile = get_language_root('en.utf8') . $location . 'en.utf8/' . $subdir . $file;
322
323
324
325
326
327
328
        if (is_readable($langfile)) {
            return $langfile;
        }
    }
    return false;
}

329
330
331
332
333
// 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.
334
    return get_string_location($identifier, $section, array(), 'raw_langstring');
335
336
337
338
339
340
341
342
343
344
345
346
347
348
}


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

351
    $langconfigstrs = array('parentlanguage', 'thislanguage');
352

353
354
355
356
    if ($section == 'mahara' &&
        (in_array($identifier, $langconfigstrs)
         || strpos($identifier, 'strftime') === 0
         || strpos($identifier, 'strfday')  === 0)) {
357
358
359
        $section = 'langconfig';
    }

360
361
362
    if (empty($lang)) {
        $lang = current_language();
    }
363
364

    // Define the locations of language strings for this section
365
    $langstringroot = get_language_root($lang);
366
    $langdirectory  = ''; // The directory in which the language file for this string should ideally reside, if the language has implemented it
367
    
368
    if (false === strpos($section, '.')) {
369
        $langdirectory = 'lang/';
370
371
372
    }
    else {
        $extras = plugin_types(); // more later..
373
        foreach ($extras as $tocheck) {
374
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
375
                $pluginname = substr($section ,strlen($tocheck) + 1);
376
377
378
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
379
                    $langdirectory = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
380
                    $section = 'blocktype.' . $bits[1];
381
382
                }
                else {
383
                    $langdirectory = $tocheck . '/' . $pluginname . '/lang/';
384
                }
385
386
387
            }
        }
    }
388

389
    // First check all the normal locations for the string in the current language
390
391
    $result = get_string_local($langstringroot . $langdirectory, $lang . '/' . $section . '.php', $identifier);
    if ($result !== false) {
392
        return $replacefunc($result, $variables);
393
394
395
396
397
    }

    // 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') {
398
        return '[[' . $identifier . '/' . $section . ']]';
399
400
401
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
402
403
404
    $langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
    if (is_readable($langfile)) {
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
405
406
            $result = get_string_local(get_language_root($parentlang) . 'lang/', $parentlang . '/' . $section . '.php', $identifier);
            if ($result !== false) {
407
                return $replacefunc($result, $variables);
408
409
410
411
412
            }
        }
    }

    /// Our only remaining option is to try English
413
414
    $result = get_string_local(get_config('docroot') . $langdirectory, 'en.utf8/' . $section . '.php', $identifier);
    if ($result !== false) {
415
        return $replacefunc($result, $variables);
416
417
    }

418
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
419
}
420
421


422
423
424
425
426
427
428
429
/**
 * Get string from a file, checking the appropriate local customisation directory first
 *
 */
function get_string_local($langpath, $langfile, $identifier) {
    foreach (array(get_config('docroot') . 'local/lang/', $langpath) as $dir) {
        $file = $dir . $langfile;
        if (is_readable($file)) {
430
431
            $result = get_string_from_file($identifier, $file);
            if ($result !== false) {
432
433
434
435
436
437
438
439
                return $result;
            }
        }
    }
    return false;
}


440
441
442
443
444
/**
 * Return a list of available languages
 *
 */
function get_languages() {
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
    static $langs = array();

    if (!$langs) {
        foreach (language_get_searchpaths() as $searchpath) {
            $langbase = $searchpath . 'lang/';
            if ($langdir = @opendir($langbase)) {
                while (false !== ($subdir = readdir($langdir))) {
                    if (preg_match('/\.utf8$/', $subdir) && is_dir($langbase . $subdir)) {
                        $langfile = $langbase . $subdir . '/langconfig.php';
                        if (is_readable($langfile)) {
                            if ($langname = get_string_from_file('thislanguage', $langfile)) {
                                $langs[$subdir] = $langname;
                            }
                        }
                    }
460
                }
461
462
463
464
                closedir($langdir);
            }
            else {
                log_warn('Unable to read language directory ' . $langbase);
465
466
467
            }
        }
    }
468

469
470
471
    return $langs;
}

472
473
474
/**
 * Returns whether the given language is installed/available for use
 */
475
function language_installed($lang) {
476
477
478
479
480
481
    foreach (language_get_searchpaths() as $searchpath) {
        if (is_readable($searchpath . 'lang/' . $lang . '/langconfig.php')) {
            return true;
        }
    }
    return false;
482
483
}

484
485
486
487
488
489
490
491
492
/**
 * 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) {
493
494
495
496
        // Construct the search path
        $docrootpath = array(get_config('docroot'));

        // Paths to language files in dataroot
497
        $datarootpaths = (array)glob(get_config('dataroot') . 'langpacks/*', GLOB_MARK | GLOB_ONLYDIR);
498
499
500
501
502
503
504
505
506
507

        // langpacksearchpaths configuration variable - for experts :)
        $lpsearchpaths = (array)get_config('langpacksearchpaths');
        $langpacksearchpaths = array();
        foreach ($lpsearchpaths as $path) {
            if (is_dir($path)) {
                $langpacksearchpaths[] = (substr($path, -1) == '/') ? $path : "$path/";
            }
            else {
                log_warn("Path in langpacksearchpaths is not a directory: $path");
508
            }
509
        }
510
511

        $searchpaths = array_merge($docrootpath, $datarootpaths, $langpacksearchpaths);
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
    }

    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];
}

549
/**
550
 * Return a list of all available themes.
551
 * @return array subdir => name
552
 */
553
function get_all_themes() {
554
555
    static $themes = null;

556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
    if (is_null($themes)) {
        $themes = array();
        $themelist = get_all_theme_objects();
        foreach ($themelist AS $subdir => $theme) {
            $themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
        }
    }

    return $themes;
}

/**
 * Return a list of themes available to this user
 * If the user is a member of any institutions, only themes available to
 * those institutions are returned; or
 * If a user is not a member of any institution, all themes not marked as
 * institution specific are returned.
 * @return array subdir => name
 */
575
function get_user_accessible_themes() {
576
577
578
579
580
581
    global $USER;

    $themes = array();
    if ($institutions = $USER->get('institutions')) {
        // Get themes for all of this users institutions
        foreach ($institutions AS $i) {
582
            $themes = array_merge($themes, get_institution_themes($i->institution));
583
584
        }
    }
585
586
587
    else {
        $themelist = get_all_theme_objects();
        foreach ($themelist AS $subdir => $theme) {
588
            if (!isset($theme->institutions) || !is_array($theme->institutions)) {
589
590
591
592
593
                $themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
            }
        }

    }
594
    $themes = array_merge(array('sitedefault' => '- ' . get_string('sitedefault', 'admin') . ' (' . $themes[get_config('theme')] . ') -'), $themes);
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
    return $themes;
}

/**
 * Return a list of themes available to the specified institution
 * @param string institution the name of the institution to load themes for
 * @return array subdir => name
 * @throws SystemException if unable to read the theme directory
 */
function get_institution_themes($institution) {
    static $institutionthemes = array();
    if (!isset($institutionthemes[$institution])) {
        $themes = get_all_theme_objects();
        $r = array();
        foreach ($themes AS $subdir => $theme) {
610
            if (empty($theme->institutions) || !is_array($theme->institutions) || in_array($institution, $theme->institutions)) {
611
                $r[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
612
613
            }
        }
614
        $institutionthemes[$institution] = $r;
615
616
    }

617
618
619
620
621
622
623
624
625
626
    return $institutionthemes[$institution];
}

/**
 * Return a list of all themes available on the system
 * @return array An array of theme objects
 * @throws SystemException if unable to read the theme directory
 */
function get_all_theme_objects() {
    static $themes = null;
627

628
629
630
631
632
633
634
635
    if (is_null($themes)) {
        $themes = array();
        $themebase = get_config('docroot') . 'theme/';
        if (!$themedir = opendir($themebase)) {
            throw new SystemException('Unable to read theme directory '.$themebase);
        }
        while (false !== ($subdir = readdir($themedir))) {
            if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
636
637
638
639
640
641
642
643
644
645
                // is the theme directory name valid?
                if (!Theme::name_is_valid($subdir)) {
                    log_warn(get_string('themenameinvalid', 'error', $subdir));
                } else {
                    $config_path = $themebase . $subdir . '/themeconfig.php';
                    if (is_readable($config_path)) {
                        require($config_path);
                        if (empty($theme->disabled) || !$theme->disabled) {
                            $themes[$subdir] = $theme;
                        }
646
                    }
647
                }
648
            }
649
        }
650
        closedir($themedir);
651
        asort($themes);
652
    }
653

654
655
656
657
    return $themes;
}


658
659
660
661
662
663
664
665
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
694
695
/**
 * 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
 *
696
 * @param string $ini_get_arg setting to look for
697
698
699
700
701
702
703
704
705
706
707
 * @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;
}

708
709
710
711
712
713
714
715
/**
 * 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() {
716
717
718
719
720
721
722
723
724
725
726
727
   global $CFG;
   global $OVERRIDDEN;    // array containing the database config fields overridden by $CFG

   $dbconfig = get_records_array('config', '', '', '', 'field, value');

   foreach ($dbconfig as $cfg) {
       if (isset($CFG->{$cfg->field})) {
           $OVERRIDDEN[] = $cfg->field;
       } else {
           $CFG->{$cfg->field} = $cfg->value;
       }
   }
728

729
   return true;
730
731
732
}

/**
733
734
735
736
737
738
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
739
740
function get_config($key) {
    global $CFG;
741
    if (isset($CFG->$key)) {
742
743
744
745
746
        return $CFG->$key;
    }
    return null;
}

747
748
749
750
751
752
753
754
755

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

758
    db_ignore_sql_exceptions(true);
759
760
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
761
762
763
764
765
766
767
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
768
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
769
    }
770
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
771
772

    if (!empty($status)) {
773
774
775
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
776

777
778
779
780
781
782
783
784
785
786
787
788
789
790
    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;
791

792
793
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
794
    if (isset($value)) {
795
796
797
798
        return $value;
    }

    $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
799
    if (!empty($records)) {
800
801
        foreach($records as $record) {
            $CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
802
            if ($record->field == $key) {
803
804
805
                $value = $record->value;
            }
        }
806
807
    }

808
809
810
    return $value;
}

Penny Leach's avatar
Penny Leach committed
811
function set_config_plugin($plugintype, $pluginname, $key, $value) {
812
    global $CFG;
813
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
814

815
816
817
    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
818
819
820
821
822
823
824
825
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
826
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
827
828
829
830
831
832
833
834
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

835
836
837
838
839
840
841
842
843
844
/**
 * 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
 */
845
function get_config_plugin_instance($plugintype, $pluginid, $key) {
846
847
848
849
850
851
    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
852
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
853
    if (isset($value)) {
854
855
856
        return $value;
    }

857
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
858
    if (!empty($records)) {
859
        foreach($records as $record) {
860
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
861
            if ($record->field == $key) {
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
                $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;
}

905
/**
906
907
908
909
910
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
911
912
913
914
915
916
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

917
/**
918
919
920
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
921
922
 *
 * param @string $reset If passed, reset the current language to this
923
924
925
 * 
 * @return string
 */
926
function current_language($reset=null) {
927
    global $USER, $CFG, $SESSION;
928
929
930

    static $lang;

931
932
933
934
    if (!empty($reset)) {
        $lang = $reset;  // Set the language for this request
    }

935
936
937
938
    if (!empty($lang)) {
        return $lang;
    }

939
    if ($USER instanceof User) {
940
941
942
943
944
945
946
        $userlang = $USER->get_account_preference('lang');
        if ($userlang !== null && $userlang != 'default') {
            if (language_installed($userlang)) {
                $lang = $userlang;
            }
            else {
                $USER->set_account_preference('lang', 'default');
947
            }
948
        }
949
    }
950

951
952
953
954
    if (empty($lang) && is_a($SESSION, 'Session')) {
        $sesslang = $SESSION->get('lang');
        if (!empty($sesslang) && $sesslang != 'default') {
            $lang = $sesslang;
955
        }
956
    }
957

958
959
960
961
962
963
964
965
966
    if (empty($lang)) {
        $lang = !empty($CFG->lang) ? $CFG->lang : 'en.utf8';
    }

    // Set locale.  We are probably being called from get_string_location.
    // $lang had better be non-empty, or it will call us again.
    if ($args = split(',', get_string_location('locales', 'langconfig', array(), 'raw_langstring', $lang))) {
        array_unshift($args, LC_ALL);
        call_user_func_array('setlocale', $args);
967
    }
968
969

    return $lang;
970
971
}

972
/**
973
974
975
976
977
978
 * 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
 */
979
980
981
982
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

983
984
985
986
function raw_langstring($string) {
    return $string;
}

987
988
989
990
991
992
993
994
995
996
997
998
999
/**
 * 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);
}

1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
/**
 * 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 {
1017
1018
1019
            $mask = umask(0000);
            $status = @mkdir($dir, get_config('directorypermissions'), true);
            umask($mask);
1020
1021
1022
1023
1024
        }
    }
    return $status;
}

1025

Penny Leach's avatar
Penny Leach committed
1026
1027
1028
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
1029
 *
Penny Leach's avatar
Penny Leach committed
1030
1031
 * This function is the one safe point to require plugin files.
 * so USE it :)
1032
 *
1033
1034
1035
1036
1037
1038
1039
1040
 * blocktypes are special cases.  eg:
 *   system blocks: safe_require('blocktype', 'wall');
 *   artefact blocks: safe_require('blocktype', 'file/html');
 *
 * import/export plugins are special cases.  eg:
 *   main library: safe_require('export', 'leap');
 *   artefact plugin implementation: safe_require('export', 'leap/file');
 *
Penny Leach's avatar
Penny Leach committed
1041
1042
1043
1044
1045
1046
 * @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
 */
1047
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
1048
1049
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
1050
        throw new SystemException("\"$plugintype\" is not a valid plugin type");
1051
    }
1052
1053
    require_once(get_config('docroot') . $plugintype . '/lib.php');

1054
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
1055
1056
1057
        if (!empty($nonfatal)) {
            return false;
        }
1058
        throw new SystemException ('Invalid require type');
Penny Leach's avatar
Penny Leach committed
1059
1060
    }

1061
1062
1063
1064
1065
    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;
        }
1066
        else {
1067
            try {
1068
                if ($artefactplugin = blocktype_artefactplugin($pluginname)) {
1069
1070
1071
1072
1073
1074
1075
                    $fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
                }
            }
            catch (SQLException $e) {
                if (get_config('installed')) {
                    throw $e;
                }
1076
1077
            }
        }
1078
1079
1080
1081
1082
1083
1084
1085
    }
    // these can have parts living inside artefact directories as well.
    else if ($plugintype == 'export' || $plugintype == 'import') {
        $bits = explode('/', $pluginname);
        if (count($bits) == 2) {
            $fullpath = get_config('docroot') . 'artefact/' . $bits[1] . '/' . $plugintype . '/' . $bits[0] . '/' . $filename;
        }
    }
1086
1087
1088
1089
    if (empty($fullpath)) {
        $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    }

1090
    if (!file_exists($fullpath)) {
Penny Leach's avatar
Penny Leach committed
1091
1092
1093
        if (!empty($nonfatal)) {
            return false;
        }
1094
        throw new SystemException ("File $fullpath did not exist");
Penny Leach's avatar
Penny Leach committed
1095
1096
    }

1097
1098
    $realpath = realpath($fullpath);

Penny Leach's avatar
Penny Leach committed
1099
1100
1101
1102
    if (strpos($realpath, get_config('docroot') !== 0)) {
        if (!empty($nonfatal)) {
            return false;
        }
1103
        throw new SystemException ("File $fullpath was outside document root!");
Penny Leach's avatar
Penny Leach committed
1104
1105
1106
1107
1108
1109
1110
1111
1112
    }

    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); }
    
}

1113
/**
1114
1115
1116
1117
 * This function returns the list of plugintypes we currently care about.
 *
 * NOTE: use plugin_types_installed if you just want the installed ones.
 *
1118
1119
1120
1121
1122
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
1123
        // ORDER MATTERS! artefact has to be first!
1124
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype', 'interaction', 'grouptype', 'import', 'export');
1125
1126
1127
1128
    }
    return $pluginstocheck;
}

1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
/**
 * 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;
}

1145
1146
1147
1148
1149
1150
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
1151
function plugins_installed($plugintype, $all=false) {
1152
1153
1154
1155
1156
    static $records = array();

    if (defined('INSTALLER') || !isset($records[$plugintype][true])) {

        $sort = $plugintype == 'blocktype' ? 'artefactplugin,name' : 'name';
1157
1158
1159
1160
1161
1162
1163
1164

        if ($rs = get_records_assoc($plugintype . '_installed', '', '', $sort)) {
            $records[$plugintype][true] = $rs;
        }
        else {
            $records[$plugintype][true] = array();
        }
        $records[$plugintype][false] = array();
1165
1166
1167
1168
1169
1170

        foreach ($records[$plugintype][true] as $r) {
            if ($r->active) {
                $records[$plugintype][false][$r->name] = $r;
            }
        }
1171
    }
1172
1173

    return $records[$plugintype][$all];
1174
1175
}

1176
1177
1178
1179
1180
1181
1182
1183
/**
 * 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);
1184
    return call_user_func_array(array($class, $method), $args);
1185
1186
}

1187
1188
function generate_class_name() {
    $args = func_get_args();
1189
    if (count($args) == 2 && $args[0] == 'blocktype') {
1190
        return 'PluginBlocktype' . ucfirst(blocktype_namespaced_to_single($args[1]));
1191
    }
1192
1193
1194
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

1195
1196
1197
1198
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

1199
1200
1201
1202
function generate_interaction_instance_class_name($type) {
    return 'Interaction' . ucfirst($type) . 'Instance';
}

1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
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;
1215
1216
}

1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
/**
 * 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];
}

1241
1242
/* Get the name of the artefact plugin that provides a given blocktype */
function blocktype_artefactplugin($blocktype) {
1243
    $installed = plugins_installed('blocktype', true);
1244
1245
1246
1247
1248
1249
    if (isset($installed[$blocktype])) {
        return $installed[$blocktype]->artefactplugin;
    }
    return false;
}

1250

1251
1252
1253
1254
1255
/**
 * 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)) {
1256
        throw new SystemException("Invalid event");
Penny Leach's avatar
Penny Leach committed
1257
    }
1258

1259
    if ($data instanceof ArtefactType || $data instanceof BlockInstance) {
1260
1261
1262
        // leave it alone
    }
    else if (is_object($data)) {
1263
1264
        $data = (array)$data;
    }
1265
    else if (is_numeric($data)) {
1266
1267
1268
        $data = array('id' => $data);
    }

1269
    if ($coreevents = get_records_array('event_subscription', 'event', $event)) {
1270
        require_once('activity.php'); // core events can generate activity.
1271
1272
1273
1274
1275
1276
1277
1278
1279
        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");
            }
        }
1280
1281
    }

1282
    $plugintypes = plugin_types_installed();
Penny Leach's avatar
Penny Leach committed
1283
    foreach ($plugintypes as $name) {
1284
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
1285
            $pluginsinstalled = plugins_installed($name);
Penny Leach's avatar
Penny Leach committed
1286
            foreach ($subs as $sub) {
1287
1288
1289
                if (!isset($pluginsinstalled[$sub->plugin])) {
                    continue;
                }
Nigel McNie's avatar