mahara.php 93.1 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
    $phpversionrequired = '5.3.0';
39
40
    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
196
197
198
199
200
/**
 * Upgrade/Install the specified mahara components
 *
 * @param array $upgrades The list of components to install or upgrade
 * @return void
 */
function upgrade_mahara($upgrades) {
    if (isset($upgrades['firstcoredata']) && $upgrades['firstcoredata']) {
        $install = true;
    }
201
202
203
    else {
        $install = false;
    }
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    uksort($upgrades, 'sort_upgrades');
    foreach ($upgrades as $name => $data) {
        if ($name == 'disablelogin') {
            continue;
        }
        if ($install) {
            log_info(get_string('installingplugin', 'admin', $name));
        }
        else {
            log_info(get_string('upgradingplugin', 'admin', $name));
        }
        if ($name == 'firstcoredata' || $name == 'lastcoredata') {
            $funname = 'core_install_' . $name . '_defaults';
            $funname();
            continue;
        }
        else if ($install && $name == 'localpreinst') {
            $name(array('localdata' => true));
        }
        else if ($install && $name == 'localpostinst') {
            // Update local version
            $config = new StdClass;
            require(get_config('docroot') . 'local/version.php');
            set_config('localversion', $config->version);
            set_config('localrelease', $config->release);

            // Installation is finished
            set_config('installed', true);
            log_info('Installation complete.');
        }
        else {
            if ($name == 'core') {
                $funname = 'upgrade_core';
            }
238
239
240
            else if ($name == 'local') {
                $funname = 'upgrade_local';
            }
241
242
243
244
245
246
247
248
249
            else {
                $funname = 'upgrade_plugin';
            }
            $data->name = $name;
            $funname($data);
        }
    }
}

250
251
252
253
254
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
255
    if (get_config('installed')) {
256
257
258
259
260
261
262
263
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

264
function get_string($identifier, $section='mahara') {
265
266
267
268
269

    $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.
270
271
    }
    else {
272
273
274
        $variables = array();
    }
    
275
276
277
    return get_string_location($identifier, $section, $variables);
}

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
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);
}

293
294
295
296
297
298
299
300
301
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) {

302
    $subdir = 'help/';
303
304

    if ($page) {
305
306
        $pagebits = split('-', $page);
        $file = array_pop($pagebits) . '.html';
307
        if ($plugintype != 'core') {
308
            $subdir .= 'pages/' . join('/', $pagebits) . '/';
309
310
        }
        else {
311
            $subdir .= 'pages/' . $pluginname . '/' . join('/', $pagebits) . '/';
312
        } 
313
314
    }
    else if ($section) {
315
316
        $subdir .= 'sections/';
        $file = $section . '.html';
317
318
    }
    else if (!empty($form) && !empty($element)) {
319
320
        $subdir .= 'forms/';
        $file = $form . '.' . $element . '.html';
321
322
    }
    else if (!empty($form) && empty($element)) {
323
324
        $subdir .= 'forms/';
        $file = $form . '.html';
325
326
327
328
329
330
331
332
333
334
335
336
337
338
    }
    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;
    }

339
    //try the local settings
340
341
342
343
344
345
346
    $langfile = get_config('docroot') . 'local/lang/' . $lang . '/' . $subdir;
    if ($plugintype != 'core') {
        $langfile .= $plugintype . '.' . $pluginname . '.' . $file;
    }
    else {
        $langfile .= $file;
    }
347
348
349
350
    if (is_readable($langfile)) {
        return $langfile;
    }

351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
    if ($plugintype == 'blocktype') { // these are a bit of a special case
        $bits = explode('/', $pluginname);
        if (count($bits) == 2) {
           $location = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
        }
        else {
            try {
                if ($artefactplugin = blocktype_artefactplugin($pluginname)) {
                    $location = 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/lang/';
                }
                else {
                    $location = 'blocktype/' . $pluginname . '/lang/';
                }
            }
            catch (SQLException $e) {
                if (get_config('installed')) {
                    throw $e;
                }
            }
        }
    }
    else if ($plugintype != 'core') {
373
374
375
376
377
378
        $location = $plugintype . '/' . $pluginname . '/lang/';
    }
    else {
        $location = 'lang/';
    }

379
    // try the current language
380
    $langfile = get_language_root() . $location . $lang . '/' . $subdir . $file;
381
382
383
384
385
386
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
387
        $langfile = get_language_root($lang) . 'lang/' . $lang . '/langconfig.php';
388
389
390
391
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
392
            $langfile = get_language_root($parentlang) . $location . $parentlang . '/' . $subdir . $file;
393
394
395
396
397
398
399
400
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

    // if it's STILL not found, and we haven't already tried english ...
    if (empty($data) && empty($trieden)) {
401
        $langfile = get_language_root('en.utf8') . $location . 'en.utf8/' . $subdir . $file;
402
403
404
405
406
407
408
        if (is_readable($langfile)) {
            return $langfile;
        }
    }
    return false;
}

409
410
411
412
413
// 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.
414
    return get_string_location($identifier, $section, array(), 'raw_langstring');
415
416
417
418
419
420
421
422
423
424
425
426
427
428
}


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

431
    $langconfigstrs = array('parentlanguage', 'thislanguage');
432

433
434
435
436
    if ($section == 'mahara' &&
        (in_array($identifier, $langconfigstrs)
         || strpos($identifier, 'strftime') === 0
         || strpos($identifier, 'strfday')  === 0)) {
437
438
439
        $section = 'langconfig';
    }

440
441
442
    if (empty($lang)) {
        $lang = current_language();
    }
443
444

    // Define the locations of language strings for this section
445
    $langstringroot = get_language_root($lang);
446
    $langdirectory  = ''; // The directory in which the language file for this string should ideally reside, if the language has implemented it
447
    
448
    if (false === strpos($section, '.')) {
449
        $langdirectory = 'lang/';
450
451
452
    }
    else {
        $extras = plugin_types(); // more later..
453
        foreach ($extras as $tocheck) {
454
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
455
                $pluginname = substr($section ,strlen($tocheck) + 1);
456
457
458
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
459
                    $langdirectory = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
460
                    $section = 'blocktype.' . $bits[1];
461
462
                }
                else {
463
                    $langdirectory = $tocheck . '/' . $pluginname . '/lang/';
464
                }
465
466
467
            }
        }
    }
468

469
    // First check all the normal locations for the string in the current language
470
471
    $result = get_string_local($langstringroot . $langdirectory, $lang . '/' . $section . '.php', $identifier);
    if ($result !== false) {
472
        return $replacefunc($result, $variables, $lang);
473
474
475
476
477
    }

    // 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') {
478
        return '[[' . $identifier . '/' . $section . ']]';
479
480
481
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
482
483
484
    $langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
    if (is_readable($langfile)) {
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
485
486
            $result = get_string_local(get_language_root($parentlang) . 'lang/', $parentlang . '/' . $section . '.php', $identifier);
            if ($result !== false) {
487
                return $replacefunc($result, $variables, $parentlang);
488
489
490
491
492
            }
        }
    }

    /// Our only remaining option is to try English
493
494
    $result = get_string_local(get_config('docroot') . $langdirectory, 'en.utf8/' . $section . '.php', $identifier);
    if ($result !== false) {
495
        return $replacefunc($result, $variables);
496
497
    }

498
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
499
}
500
501


502
503
504
505
506
507
508
509
/**
 * 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)) {
510
511
            $result = get_string_from_file($identifier, $file);
            if ($result !== false) {
512
513
514
515
516
517
518
519
                return $result;
            }
        }
    }
    return false;
}


520
521
522
523
524
/**
 * Return a list of available languages
 *
 */
function get_languages() {
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
    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;
                            }
                        }
                    }
540
                }
541
                closedir($langdir);
542
                asort($langs);
543
544
545
            }
            else {
                log_warn('Unable to read language directory ' . $langbase);
546
547
548
            }
        }
    }
549

550
551
552
    return $langs;
}

553
554
555
/**
 * Returns whether the given language is installed/available for use
 */
556
function language_installed($lang) {
557
558
559
560
561
562
    foreach (language_get_searchpaths() as $searchpath) {
        if (is_readable($searchpath . 'lang/' . $lang . '/langconfig.php')) {
            return true;
        }
    }
    return false;
563
564
}

565
566
567
568
569
570
571
572
573
/**
 * 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) {
574
575
576
577
        // Construct the search path
        $docrootpath = array(get_config('docroot'));

        // Paths to language files in dataroot
578
        $datarootpaths = (array)glob(get_config('dataroot') . 'langpacks/*', GLOB_MARK | GLOB_ONLYDIR);
579
580
581
582
583
584
585
586
587
588

        // 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");
589
            }
590
        }
591
592

        $searchpaths = array_merge($docrootpath, $datarootpaths, $langpacksearchpaths);
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
    }

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

630
/**
631
 * Return a list of all available themes.
632
 * @return array subdir => name
633
 */
634
function get_all_themes() {
635
636
    static $themes = null;

637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
    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
 */
656
function get_user_accessible_themes() {
657
658
659
660
661
662
    global $USER;

    $themes = array();
    if ($institutions = $USER->get('institutions')) {
        // Get themes for all of this users institutions
        foreach ($institutions AS $i) {
663
            $themes = array_merge($themes, get_institution_themes($i->institution));
664
665
        }
    }
666
667
668
    else {
        $themelist = get_all_theme_objects();
        foreach ($themelist AS $subdir => $theme) {
669
            if (!isset($theme->institutions) || !is_array($theme->institutions)) {
670
671
672
673
674
                $themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
            }
        }

    }
675
    $themes = array_merge(array('sitedefault' => get_string('nothemeselected', 'view')), $themes);
676
677
    unset($themes['custom']);

678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
    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) {
693
            if (empty($theme->institutions) || !is_array($theme->institutions) || in_array($institution, $theme->institutions)) {
694
                $r[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
695
696
            }
        }
697
        $institutionthemes[$institution] = $r;
698
699
    }

700
701
702
703
704
705
706
707
708
709
    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;
710

711
712
713
714
715
716
717
    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))) {
718
            if (substr($subdir, 0, 1) != "." && is_dir($themebase . $subdir)) {
719
720
721
722
723
724
725
726
727
728
                // 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;
                        }
729
                    }
730
                }
731
            }
732
        }
733
        closedir($themedir);
734
        asort($themes);
735
    }
736

737
738
739
740
    return $themes;
}


741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
/**
 * 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
 *
779
 * @param string $ini_get_arg setting to look for
780
781
782
783
784
785
786
787
788
789
790
 * @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;
}

791
792
793
794
795
796
797
798
/**
 * 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() {
799
   global $CFG;
800
   global $OVERRIDDEN;    // array containing the config fields overridden by $CFG
801

802
803
804
805
   // Get a full list of overridden fields
   foreach ($CFG as $field => $value) {
        $OVERRIDDEN[] = $field;
   }
806

807
   $dbconfig = get_records_array('config', '', '', '', 'field, value');
808
   foreach ($dbconfig as $cfg) {
809
       if (!isset($CFG->{$cfg->field})) {
810
811
812
           $CFG->{$cfg->field} = $cfg->value;
       }
   }
813

814
   return true;
815
816
817
}

/**
818
819
820
821
822
823
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
824
825
function get_config($key) {
    global $CFG;
826
    if (isset($CFG->$key)) {
827
828
829
830
831
        return $CFG->$key;
    }
    return null;
}

832
833
834
835
836
837
838
839
840

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

843
    db_ignore_sql_exceptions(true);
844
845
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
846
847
848
849
850
851
852
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
853
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
854
    }
855
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
856
857

    if (!empty($status)) {
858
859
860
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
861

862
863
864
865
866
867
868
869
870
871
872
873
874
875
    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;
876

877
878
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
879
    if (isset($CFG->plugin->{$plugintype})) {
880
881
882
        return $value;
    }

883
884
    $CFG->plugin->{$plugintype} = new StdClass;

885
    $records = get_records_array($plugintype . '_config');
886
    if (!empty($records)) {
887
        foreach($records as $record) {
888
889
            $CFG->plugin->{$plugintype}->{$record->plugin}->{$record->field} = $record->value;
            if ($record->field == $key && $record->plugin == $pluginname) {
890
891
892
                $value = $record->value;
            }
        }
893
894
    }

895
896
897
    return $value;
}

Penny Leach's avatar
Penny Leach committed
898
function set_config_plugin($plugintype, $pluginname, $key, $value) {
899
    global $CFG;
900
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
901

902
903
904
    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
905
906
907
908
909
910
911
912
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
913
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
914
915
916
917
918
919
920
921
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

922
923
924
925
926
927
928
929
930
931
/**
 * 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
 */
932
function get_config_plugin_instance($plugintype, $pluginid, $key) {
933
934
935
936
937
938
    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
939
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
940
    if (isset($value)) {
941
942
943
        return $value;
    }

944
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
945
    if (!empty($records)) {
946
        foreach($records as $record) {
947
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
948
            if ($record->field == $key) {
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
                $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;
}

992
/**
993
994
995
996
997
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
998
999
1000
1001
1002
1003
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

1004
/**
1005
1006
1007
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
1008
 *
1009
1010
 * @return string
 */
1011
function current_language() {
1012
    global $USER, $CFG, $SESSION;
1013

1014
    static $userlang, $lastlang;
1015

1016
    $loggedin = $USER instanceof User && $USER->is_logged_in();
1017

1018
    if (!isset($userlang) && $loggedin) {
1019
1020
        $userlang = $USER->get_account_preference('lang');
        if ($userlang !== null && $userlang != 'default') {
1021
            if (!language_installed($userlang)) {
1022
                $USER->set_account_preference('lang', 'default');
1023
                $userlang = 'default';
1024
            }
1025
        }
1026
    }
1027

1028
1029
1030
1031
    if (!empty($userlang) && $userlang != 'default') {
        $lang = $userlang;
    }
    else if (!$loggedin && is_a($SESSION, 'Session')) {
1032
1033
1034
        $sesslang = $SESSION->get('lang');
        if (!empty($sesslang) && $sesslang != 'default') {
            $lang = $sesslang;
1035
        }
1036
    }
1037

1038
1039
1040
1041
    if (empty($lang)) {
        $lang = !empty($CFG->lang) ? $CFG->lang : 'en.utf8';
    }

1042
1043
1044
1045
    if ($lang == $lastlang) {
        return $lang;
    }

1046
1047
1048
1049
1050
    // 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);
1051
    }
1052

1053
    return $lastlang = $lang;
1054
1055
}

1056
/**
1057
1058
1059
 * Helper function to sprintf language strings
 * with a variable number of arguments
 * 
1060
 * @param mixed $string raw string to use, or an array of strings, one for each plural form
1061
 * @param array $args arguments to sprintf
1062
 * @param string $lang The language
1063
 */
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
function format_langstring($string, $args, $lang='en.utf8') {
    if (is_array($string) && isset($args[0]) && is_numeric($args[0])) {
        // If there are multiple strings here, there must be one for each plural
        // form in the language.  The first argument is passed into the plural
        // function, which returns an index into the array of strings.
        $pluralfunction = get_string_location('pluralfunction', 'langconfig', array(), 'raw_langstring', $lang);
        $index = function_exists($pluralfunction) ? $pluralfunction($args[0]) : 0;
        $string = isset($string[$index]) ? $string[$index] : current($string);
    }

1074
1075
1076
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

1077
1078
1079
1080
function raw_langstring($string) {
    return $string;
}

1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
/**
 * 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);
}

1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
/**
 * 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;
1106
    $dir = trim($dir);
1107
1108
1109
1110
1111

    if(!is_dir($dir)) {
        if (!$create) {
            $status = false;
        } else {
1112
1113
1114
            $mask = umask(0000);
            $status = @mkdir($dir, get_config('directorypermissions'), true);
            umask($mask);
1115
1116
1117
1118
1119
        }
    }
    return $status;
}

1120

Penny Leach's avatar
Penny Leach committed
1121
1122
1123
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
1124
 *
Penny Leach's avatar
Penny Leach committed
1125
1126
 * This function is the one safe point to require plugin files.
 * so USE it :)
1127
 *
1128
1129
1130
1131
1132
1133
1134
1135
 * 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
1136
1137
1138
1139
1140
1141
 * @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
 */
1142
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
1143
1144
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
1145
        throw new SystemException("\"$plugintype\" is not a valid plugin type");
1146
    }
1147
1148
    require_once(get_config('docroot') . $plugintype . '/lib.php');

1149
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
1150
1151
1152
        if (!empty($nonfatal)) {
            return false;
        }
1153
        throw new SystemException ('Invalid require type');
Penny Leach's avatar
Penny Leach committed
1154
1155
    }

1156
1157
1158
1159
1160
    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;
        }
1161
        else {
1162
            try {
1163
                if ($artefactplugin = blocktype_artefactplugin($pluginname)) {
1164
1165
1166
1167
1168
1169
1170
                    $fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
                }
            }
            catch (SQLException $e) {
                if (get_config('installed')) {
                    throw $e;
                }
1171
1172
            }
        }
1173
1174
1175
1176
1177
1178
1179
1180
    }
    // 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;
        }
    }
1181
1182
1183
1184
    if (empty($fullpath)) {
        $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    }

1185
    if (!file_exists($fullpath)) {
Penny Leach's avatar
Penny Leach committed
1186
1187
1188
        if (!empty($nonfatal)) {
            return false;
        }
1189
        throw new SystemException ("File $fullpath did not exist");
Penny Leach's avatar
Penny Leach committed
1190
1191
    }

1192
1193
    $realpath = realpath($fullpath);

Penny Leach's avatar
Penny Leach committed
1194
1195
1196
1197
    if (strpos($realpath, get_config('docroot') !== 0)) {
        if (!empty($nonfatal)) {
            return false;
        }
1198
        throw new SystemException ("File $fullpath was outside document root!");
Penny Leach's avatar
Penny Leach committed
1199
1200
1201
1202
1203
1204
1205
1206
1207
    }

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

1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
/**
 * This function is a wrapper around safe_require which will attempt to
 * handle missing plugins more gracefully.
 *
 * If a missing plugin is detected, then that plugin will be disabled, and
 * an e-mail will be sent to site administrators to inform them of the
 * issue.
 *
 * See @safe_require for further information on that function.
 *
 * @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
 */
function safe_require_plugin($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
    try {
        safe_require($plugintype, $pluginname, $filename, $function, $nonfatal);
        return true;
    }
    catch (SystemException $e) {
        if (get_field($plugintype . '_installed', 'active', 'name', $pluginname) == 1) {
            set_field($plugintype . '_installed', 'active', 0, 'name', $pluginname);
            // Alert site admins that the plugin is broken so was disabled
            $message = new stdClass();
            $message->users = get_column('usr', 'id', 'admin', 1);
            $message->subject = get_string('pluginbrokenanddisabledtitle', 'mahara', $pluginname);
            $message->message = get_string('pluginbrokenanddisabled', 'mahara', $pluginname, $e->getMessage());

            require_once('activity.php');
            activity_occurred('maharamessage', $message);
        }
        return false;
    }
}

1245
/**
1246
1247
1248
1249
 * This function returns the list of plugintypes we currently care about.
 *
 * NOTE: use plugin_types_installed if you just want the installed ones.
 *
1250
1251
1252
1253
1254
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
1255
        // ORDER MATTERS! artefact has to be first!
1256
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype', 'interaction', 'grouptype', 'import', 'export');
1257
1258
1259
1260
    }
    return $pluginstocheck;
}

1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
/**
 * 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;
}

1277
1278
1279
1280
1281
1282
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
1283
function plugins_installed($plugintype, $all=false) {
1284
1285
1286
1287
1288
    static $records = array();

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

        $sort = $plugintype == 'blocktype' ? 'artefactplugin,name' : 'name';
1289
1290
1291
1292
<