mahara.php 203 KB
Newer Older
1
2
<?php
/**
3
4
5
 *
 * @package    mahara
 * @subpackage core
6
 * @author     Catalyst IT Ltd
7
8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
9
 * @copyright  (C) portions from Moodle, (C) Martin Dougiamas http://dougiamas.com
10
11
 */

12
defined('INTERNAL') || die();
13

Aaron Wells's avatar
Aaron Wells committed
14
/**
15
16
17
18
19
20
 * work around silly php settings
 * and broken setup stuff about the install
 * and raise a warning/fail depending on severity
 */
function ensure_sanity() {

21
    // PHP version
22
    $phpversionrequired = '7.0.0';
23
24
    if (version_compare(phpversion(), $phpversionrequired) < 0) {
        throw new ConfigSanityException(get_string('phpversion', 'error', $phpversionrequired));
25
26
27
28
29
30
    }

    // Various required extensions
    if (!extension_loaded('json')) {
        throw new ConfigSanityException(get_string('jsonextensionnotloaded', 'error'));
    }
31
    switch (get_config('dbtype')) {
32
33
    case 'postgres':
    case 'postgres8': // for legacy purposes we also accept "postgres8"
34
35
36
37
        if (!extension_loaded('pgsql')) {
            throw new ConfigSanityException(get_string('pgsqldbextensionnotloaded', 'error'));
        }
        break;
38
39
40
    case 'mysql':
    case 'mysql5': // for legacy purposes we also accept "mysql5"
        if (!extension_loaded('mysqli') && !extension_loaded('mysql')) {
41
42
43
44
45
            throw new ConfigSanityException(get_string('mysqldbextensionnotloaded', 'error'));
        }
        break;
    default:
        throw new ConfigSanityException(get_string('unknowndbtype', 'error'));
46
    }
47
48
49
    if (!extension_loaded('xml')) {
        throw new ConfigSanityException(get_string('xmlextensionnotloaded', 'error', 'xml'));
    }
50
    if (!extension_loaded('libxml')) {
51
        throw new ConfigSanityException(get_string('xmlextensionnotloaded', 'error', 'libxml'));
52
53
54
55
56
57
58
59
    }
    if (!extension_loaded('gd')) {
        throw new ConfigSanityException(get_string('gdextensionnotloaded', 'error'));
    }
    if (!extension_loaded('session')) {
        throw new ConfigSanityException(get_string('sessionextensionnotloaded', 'error'));
    }

60
61
62
    if(!extension_loaded('curl')) {
        throw new ConfigSanityException(get_string('curllibrarynotinstalled', 'error'));
    }
63
64
65
    if (!extension_loaded('dom')) {
        throw new ConfigSanityException(get_string('domextensionnotloaded', 'error'));
    }
66
67
68
    if (!extension_loaded('mbstring')) {
        throw new ConfigSanityException(get_string('mbstringextensionnotloaded', 'error'));
    }
69
70
71
72
73
    // Check for freetype in the gd extension
    $gd_info = gd_info();
    if (!$gd_info['FreeType Support']) {
        throw new ConfigSanityException(get_string('gdfreetypenotloaded', 'error'));
    }
74

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

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

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

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

119
120
121
122
123
    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'));
    }

124
125
126
127
128
129
130
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

131
    // dataroot inside document root.
132
133
    if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
        throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
134
135
    }

136
137
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
138
139
140
141
142
143
144
        $message = get_string('datarootnotwritable', 'error', get_config('dataroot'));
        if ($openbasedir = ini_get('open_basedir')) {
            $message .= "\n(" . get_string('openbasedirenabled', 'error') . ' '
                . get_string('openbasedirpaths', 'error', htmlspecialchars($openbasedir)) // hsc() is not defined yet
                . ')';
        }
        throw new ConfigSanityException($message);
145
    }
146
    $dwoo_dir = get_dwoo_dir();
147
    if (
148
        !check_dir_exists($dwoo_dir) ||
149
        !check_dir_exists(get_config('dataroot') . 'temp') ||
150
        !check_dir_exists(get_config('dataroot') . 'langpacks') ||
151
152
153
        !check_dir_exists(get_config('dataroot') . 'htmlpurifier') ||
        !check_dir_exists(get_config('dataroot') . 'log') ||
        !check_dir_exists(get_config('dataroot') . 'images')) {
154
155
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
156
157
158
159
160
    // Since sessionpath can now exist outside of the the dataroot, check it separately.
    // NOTE: If we implement separate session handlers, we may want to remove or alter this check
    if (!check_dir_exists(get_config('sessionpath')) || !is_writable(get_config('sessionpath'))) {
        throw new ConfigSanityException(get_string('sessionpathnotwritable', 'error', get_config('sessionpath')));
    }
161

162
    raise_memory_limit('128M');
163
164
}

165
166
167
168
function get_dwoo_dir() {
    return !empty(get_config('customdwoocachedir')) ? get_config('customdwoocachedir') . '/dwoo/' : get_config('dataroot') . 'dwoo/';
}

169
/**
Aaron Wells's avatar
Aaron Wells committed
170
 * Check sanity of things that we only check at installation time - not on
171
172
173
174
175
176
177
 * 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'));
    }
178
179
180
    if (is_postgres() && !postgres_create_language('plpgsql')) {
        throw new ConfigSanityException(get_string('plpgsqlnotavailable', 'error'));
    }
181
182
183
    if (is_mysql() && !mysql_has_trigger_privilege()) {
        throw new ConfigSanityException(get_string('mysqlnotriggerprivilege', 'error'));
    }
184
185
186
187
188
    if (!file_exists(get_config('docroot') . 'theme/raw/style/style.css')) {
        $e = new ConfigSanityException(get_string('cssnotpresent', 'error'));
        $e->set_log_off();
        throw $e;
    }
189
190
}

191
192
193
194
195
196
197
198
199
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'));
            }
        }
200
201
202
        if (!mysql_has_trigger_privilege()) {
            throw new ConfigSanityException(get_string('mysqlnotriggerprivilege', 'error'));
        }
203
    }
204
205
206
    if (is_postgres() && !postgres_create_language('plpgsql')) {
        throw new ConfigSanityException(get_string('plpgsqlnotavailable', 'error'));
    }
207
208
209
210
211
    if (!file_exists(get_config('docroot') . 'theme/raw/style/style.css')) {
        $e = new ConfigSanityException(get_string('cssnotpresent', 'error'));
        $e->set_log_off();
        throw $e;
    }
212
213
214
    if (!record_exists('usr', 'id', 0)) {
        throw new ConfigSanityException(get_string('mahararootusermissing', 'error'));
    }
215
216
}

217
218
/**
 * Upgrade/Install the specified mahara components
219
 * (Only used by the CLI installer & upgrader)
220
221
222
223
224
225
226
227
 *
 * @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;
    }
228
229
230
    else {
        $install = false;
    }
231
232
    uksort($upgrades, 'sort_upgrades');
    foreach ($upgrades as $name => $data) {
233
        if ($name == 'settings') {
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
            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
252
253
            $name(array('localdata' => true));

254
            $config = new stdClass();
255
256
257
258
259
260
261
262
263
264
265
266
            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';
            }
267
268
269
            else if ($name == 'local') {
                $funname = 'upgrade_local';
            }
270
271
272
273
274
275
276
277
278
            else {
                $funname = 'upgrade_plugin';
            }
            $data->name = $name;
            $funname($data);
        }
    }
}

279
280
281
282
283
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
284
    if (get_config('installed')) {
285
286
287
288
289
290
291
292
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

293
294
/**
 * Check to see whether a language string is present in the
295
296
 * lang files. when checking the lang string we don't care about extra arguments so we use
 * the _return_string_unchanged rather than format_langstring function.
297
298
299
300
301
302
 *
 * @param string $identifier
 * @param string $section
 * @return boolean
 */
function string_exists($identifier, $section = 'mahara') {
303
304
305
306
307
308
    // Because we don't need to perform parameter replacement to test if string exists
    // we can use a simple pass-through for the $replacefunc argument.
    $string = get_string_location($identifier, $section, array(), '_return_string_unchanged');
    return $string !== '[[' . $identifier . '/' . $section . ']]';
}

309
function _return_string_unchanged($string, $args=array(), $lang='en.utf8') {
310
    return $string;
311
312
}

313
314
315
316
317
318
319
320
321
322
/**
 * Find out the number of expected arguments if $identifier for get_string() is
 * passed in by a variable. Eg in webservices error handling.
 */
function count_string_args($identifier, $section = 'mahara') {
    $string = get_string_location($identifier, $section, array(), '_return_string_unchanged');
    preg_match_all('/[^\%]\%[^\%]/', $string, $matches);
    return count($matches[0]);
}

323
function get_string($identifier, $section='mahara') {
324
325
326
327
328

    $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.
329
330
    }
    else {
331
332
        $variables = array();
    }
Aaron Wells's avatar
Aaron Wells committed
333

334
335
336
    return get_string_location($identifier, $section, $variables);
}

337
338
339
340
341
342
343
344
345
346
function get_string_php_version($identifier, $section = 'mahara') {
    if (version_compare(PHP_VERSION, '7.0.0') >= 0
        && string_exists($identifier . '7php', $section)) {
        return get_string($identifier . '7php', $section);
    }
    else {
        return get_string($identifier, $section);
    }
}

347
348
349
350
351
352
353
354
355
356
357
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();
    }
Aaron Wells's avatar
Aaron Wells committed
358

359
360
361
    return get_string_location($identifier, $section, $variables, 'format_langstring', $lang);
}

362
363
364
365
366
367
368
369
370
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) {

371
    $subdir = 'help/';
372
373

    if ($page) {
374
        $pagebits = explode('-', $page);
375
        $file = array_pop($pagebits) . '.html';
376
        if ($plugintype != 'core') {
377
            $subdir .= 'pages/' . join('/', $pagebits) . '/';
378
379
        }
        else {
380
            $subdir .= 'pages/' . $pluginname . '/' . join('/', $pagebits) . '/';
Aaron Wells's avatar
Aaron Wells committed
381
        }
382
383
    }
    else if ($section) {
384
385
        $subdir .= 'sections/';
        $file = $section . '.html';
386
387
    }
    else if (!empty($form) && !empty($element)) {
388
389
        $subdir .= 'forms/';
        $file = $form . '.' . $element . '.html';
390
391
    }
    else if (!empty($form) && empty($element)) {
392
393
        $subdir .= 'forms/';
        $file = $form . '.html';
394
395
396
397
398
399
400
401
402
403
404
405
406
407
    }
    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;
    }

408
    //try the local settings
409
410
411
412
413
414
415
    $langfile = get_config('docroot') . 'local/lang/' . $lang . '/' . $subdir;
    if ($plugintype != 'core') {
        $langfile .= $plugintype . '.' . $pluginname . '.' . $file;
    }
    else {
        $langfile .= $file;
    }
416
417
418
419
    if (is_readable($langfile)) {
        return $langfile;
    }

420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
    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') {
442
443
444
445
446
447
        $location = $plugintype . '/' . $pluginname . '/lang/';
    }
    else {
        $location = 'lang/';
    }

448
    // try the current language
449
    $langfile = get_language_root() . $location . $lang . '/' . $subdir . $file;
450
451
452
453
454
455
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
456
        $langfile = get_language_root($lang) . 'lang/' . $lang . '/langconfig.php';
457
458
459
460
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
461
            $langfile = get_language_root($parentlang) . $location . $parentlang . '/' . $subdir . $file;
462
463
464
465
466
467
468
469
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

    // if it's STILL not found, and we haven't already tried english ...
    if (empty($data) && empty($trieden)) {
470
        $langfile = get_language_root('en.utf8') . $location . 'en.utf8/' . $subdir . $file;
471
472
473
474
        if (is_readable($langfile)) {
            return $langfile;
        }
    }
475
476
477

    // if it's a form element, try the wildcard form name
    if (!empty($form) && !empty($element) && $form !== 'ANY') {
478
479
480
        // if it's a block instance config form element, try the wildcard form name
        // and element without it's prefixes
        if (preg_match('/^instconf_/', $element)) {
481
482
            $element_explode = explode('_', $element);
            $element = end($element_explode);
483
        }
484
485
486
        return get_helpfile_location('core', '', 'ANY', $element, $page, $section);
    }

487
488
489
    return false;
}

490
491
492
493
494
// 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.
495
    return get_string_location($identifier, $section, array(), 'raw_langstring');
496
497
498
499
500
501
502
503
504
505
506
507
508
509
}


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

512
    $langconfigstrs = array('parentlanguage', 'thislanguage');
513

514
515
516
517
    if ($section == 'mahara' &&
        (in_array($identifier, $langconfigstrs)
         || strpos($identifier, 'strftime') === 0
         || strpos($identifier, 'strfday')  === 0)) {
518
519
520
        $section = 'langconfig';
    }

521
522
523
    if (empty($lang)) {
        $lang = current_language();
    }
524
525

    // Define the locations of language strings for this section
526
    $langstringroot = get_language_root($lang);
527
528
    $docroot = get_config('docroot');

529
    $langdirectory  = ''; // The directory in which the language file for this string should ideally reside, if the language has implemented it
Aaron Wells's avatar
Aaron Wells committed
530

531
    if (false === strpos($section, '.')) {
532
        $langdirectory = 'lang/';
533
534
    }
    else {
535
536
537
538
539
540
541
542
543
544
545
546
547
        $extras = plugin_types();
        $extras[] = 'theme'; // Allow themes to have lang files the same as plugins
        foreach ($extras as $tocheck) {
            if (strpos($section, $tocheck . '.') === 0) {
                $pluginname = substr($section ,strlen($tocheck) + 1);
                if ($tocheck == 'blocktype' &&
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
                    $langdirectory = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
                    $section = 'blocktype.' . $bits[1];
                }
                else {
                    $langdirectory = $tocheck . '/' . $pluginname . '/lang/';
548
                }
549
550
551
            }
        }
    }
552

553
554
555
556
557
558
559
    // First check the theme/plugin locations
    $result = get_string_local($docroot . $langdirectory, $lang . '/' . $section . '.php', $identifier);
    if ($result !== false) {
        return $replacefunc($result, $variables, $lang);
    }

    // Then check the default location for the string in the current language
560
561
    $result = get_string_local($langstringroot . $langdirectory, $lang . '/' . $section . '.php', $identifier);
    if ($result !== false) {
562
        return $replacefunc($result, $variables, $lang);
563
564
565
566
567
    }

    // 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') {
568
        return '[[' . $identifier . '/' . $section . ']]';
569
570
571
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
572
573
574
    $langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
    if (is_readable($langfile)) {
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
575
576
577
578
579
580
581
582
583

            // First check the theme/plugin locations
            $result = get_string_local($docroot . $langdirectory, $parentlang . '/' . $section . '.php', $identifier);
            if ($result !== false) {
                return $replacefunc($result, $variables, $parentlang);
            }

            // Then check the default location for the string in the current language
            $result = get_string_local(get_language_root($parentlang) . $langdirectory, $parentlang . '/' . $section . '.php', $identifier);
584
            if ($result !== false) {
585
                return $replacefunc($result, $variables, $parentlang);
586
587
588
589
590
            }
        }
    }

    /// Our only remaining option is to try English
591
592
    $result = get_string_local(get_config('docroot') . $langdirectory, 'en.utf8/' . $section . '.php', $identifier);
    if ($result !== false) {
593
        return $replacefunc($result, $variables);
594
595
    }

596
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
597
}
598
599


600
601
602
603
604
605
606
607
/**
 * 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)) {
608
609
            $result = get_string_from_file($identifier, $file);
            if ($result !== false) {
610
611
612
613
614
615
616
617
                return $result;
            }
        }
    }
    return false;
}


618
619
620
621
622
/**
 * Return a list of available languages
 *
 */
function get_languages() {
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
    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;
                            }
                        }
                    }
638
                }
639
                closedir($langdir);
640
                asort($langs);
641
642
643
            }
            else {
                log_warn('Unable to read language directory ' . $langbase);
644
645
646
            }
        }
    }
647

648
649
650
    return $langs;
}

651
652
653
/**
 * Returns whether the given language is installed/available for use
 */
654
function language_installed($lang) {
655
656
657
658
659
660
    foreach (language_get_searchpaths() as $searchpath) {
        if (is_readable($searchpath . 'lang/' . $lang . '/langconfig.php')) {
            return true;
        }
    }
    return false;
661
662
}

663
664
665
666
667
668
669
670
671
/**
 * 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) {
672
673
674
675
        // Construct the search path
        $docrootpath = array(get_config('docroot'));

        // Paths to language files in dataroot
676
677
678
679
680
681
        $datarootbase = get_config('dataroot') . 'langpacks/*';
        $datarootpaths = glob($datarootbase, GLOB_MARK | GLOB_ONLYDIR);
        if ($datarootpaths === false) {
            log_warn("Problem searching for langfiles at this path: " . $datarootbase);
            $datarootpaths = array();
        }
682
683
684
685
686
687
688
689
690
691

        // 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");
692
            }
693
        }
694
695

        $searchpaths = array_merge($docrootpath, $datarootpaths, $langpacksearchpaths);
696
697
698
699
700
701
702
703
    }

    return $searchpaths;
}

/**
 * Get the directory in which the specified language pack resides.
 *
Aaron Wells's avatar
Aaron Wells committed
704
 * Defaults to getting the directory for the current_language() - i.e. the
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 * 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];
}

733
/**
734
 * Return a list of all available themes.
735
 * @return array subdir => name
736
 */
737
function get_all_themes() {
738
739
    static $themes = null;

740
741
742
    if (is_null($themes)) {
        $themes = array();
        $themelist = get_all_theme_objects();
743

744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
        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
 */
760
function get_user_accessible_themes() {
761
762
763
764
765
766
    global $USER;

    $themes = array();
    if ($institutions = $USER->get('institutions')) {
        // Get themes for all of this users institutions
        foreach ($institutions AS $i) {
767
            $themes = array_merge($themes, get_institution_themes($i->institution));
768
769
        }
    }
770
771
772
    else {
        $themelist = get_all_theme_objects();
        foreach ($themelist AS $subdir => $theme) {
773
            if (!isset($theme->institutions) || !is_array($theme->institutions)) {
774
775
776
777
778
                $themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
            }
        }

    }
779
    $themes = array_merge(array('sitedefault' => get_string('nothemeselected1', 'view')), $themes);
780
781
    unset($themes['custom']);

782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
    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) {
797
            if (empty($theme->institutions) || !is_array($theme->institutions) || in_array($institution, $theme->institutions)) {
798
                $r[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
799
800
            }
        }
801
        $institutionthemes[$institution] = $r;
802
803
    }

804
805
806
807
808
809
810
811
812
813
    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;
814

815
816
817
818
819
820
821
    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))) {
822
            if (substr($subdir, 0, 1) != "." && is_dir($themebase . $subdir)) {
823
824
825
826
827
828
829
830
                // 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) {
831
832
833
834
                            // don't include the special subthemestarter theme in the options
                            if ($subdir != 'subthemestarter') {
                                $themes[$subdir] = $theme;
                            }
835
                        }
836
                    }
837
                }
838
            }
839
        }
840
        closedir($themedir);
841
        asort($themes);
842
    }
843

844
845
846
    return $themes;
}

847
848
849
850
851
/**
 * Checks if theme still exists and if not resets it to default option
 *
 * @param $theme         string  Name of theme
 * @param $institution   string  Name of Institution
852
 * @param $new           boolean If we are validating the theme for something newly created
853
854
855
 *
 * @return  bool       True if theme exists
 */
856
function validate_theme($theme, $institution = null, $new = false) {
857
    global $SESSION;
858
859
860
861
862
863

    // Null theme means the institution is using the site default.
    if ($theme == null && ($institution || $new)) {
        return true;
    }

864
865
866
867
868
869
870
    if ($institution) {
        $themeoptions = get_institution_themes($institution);
    }
    else {
        $themeoptions = get_all_themes();
    }
    if (!array_key_exists($theme, $themeoptions)) {
871
872
        if ($new) {
            return false;
873
874
        }
        else {
875
876
877
878
879
880
881
882
            if ($institution) {
                set_config_institution($institution, 'theme', null);
            }
            else {
                set_config('theme', 'default');
            }
            $SESSION->add_info_msg(get_string('thememissing', 'admin', $theme));
            return false;
883
884
        }
    }
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904

    // validate parent theme
    if (($themeconfig = Theme::get_theme_config($theme)) && $themeconfig->parent !== false) {

          $parentthemename = $themeconfig->parent;
          $parentthemeconfig = Theme::get_theme_config($parentthemename);

          if (!$parentthemeconfig) {
            if ($institution) {
                set_config_institution($institution, 'theme', null);
            }
            else {
                set_config('theme', 'default');
            }
            $SESSION->add_info_msg(get_string('parentthememissing', 'admin', $themeconfig->displayname, $parentthemename));
            return false;

          }
      }

905
906
    return true;
}
907

908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
/**
 * 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
 *
946
 * @param string $ini_get_arg setting to look for
947
948
949
950
951
952
953
954
955
956
957
 * @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;
}

958
959
960
961
962
963
964
965
/**
 * 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() {
966
   global $CFG;
967
   global $OVERRIDDEN;    // array containing the config fields overridden by $CFG
968

969
970
971
972
   // Get a full list of overridden fields
   foreach ($CFG as $field => $value) {
        $OVERRIDDEN[] = $field;
   }
973

974
   $dbconfig = get_records_array('config', '', '', '', 'field, value');
975
   foreach ($dbconfig as $cfg) {
976
       if (!isset($CFG->{$cfg->field})) {
977
978
979
           $CFG->{$cfg->field} = $cfg->value;
       }
   }
980

981
   return true;
982
983
984
}

/**
985
 * This function returns a value from $CFG
986
 * or default value if supplied or null if it is not found
Aaron Wells's avatar
Aaron Wells committed
987
 *
988
989
 * @param string $key      Config setting to look for
 * @param string $default  Default value to return if setting not found
990
991
 * @return mixed
 */
992
function get_config($key, $default = null) {
993
    global $CFG;
994
    if (isset($CFG->$key)) {
995
996
        return $CFG->$key;
    }
997
    return $default;
998
999
}

1000
1001
1002
1003
1004
1005
1006
1007
1008

/**
 * 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) {
1009
    global $CFG;
1010
    $value = (string) $value;
1011

1012
    db_ignore_sql_exceptions(true);
1013
1014
1015
1016
1017
1018
1019
    $dbvalue = get_field('config', 'value', 'field', $key);
    if (false !== $dbvalue) {
        if (
                // No need to update the DB if the value already matches
                ($dbvalue === $value)
                || set_field('config', 'value', $value, 'field', $key)
        ) {
Penny Leach's avatar
Penny Leach committed
1020
1021
            $status = true;
        }
Aaron Wells's avatar
Aaron Wells committed
1022
    }
Penny Leach's avatar
Penny Leach committed
1023
    else {
1024
        $config = new stdClass();
Penny Leach's avatar
Penny Leach committed
1025
1026
        $config->field = $key;
        $config->value = $value;
1027
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
1028
    }
1029
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
1030
1031

    if (!empty($status)) {
1032
1033
1034
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
1035

1036
1037
1038
1039
1040
    return false;
}

/**
 * This function returns a value for $CFG for a plugin
1041
1042
1043
 * or null if it is not found.
 *
 * It will give precedence to config values set in config.php like so:
1044
 * $cfg->plugin_{$plugintype}_{$pluginname}_{$key} = 'whatever';
1045
1046
1047
 *
 * If it doesn't find one of those, it will look for the config value in
 * the database.
1048
1049
1050
1051
 *
 * @param string $plugintype eg artefact
 * @param string $pluginname eg blog
 * @param string $key the config setting to look for
1052
 * @return mixed The value of the key if found, or NULL if not found
1053
1054
1055
 */
function get_config_plugin($plugintype, $pluginname, $key) {
    global $CFG;
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
    static $pluginsfetched = array();

    $typename = "{$plugintype}_{$pluginname}";
    $configname = "plugin_{$typename}_{$key}";
    if (isset($CFG->{$configname})) {
        return $CFG->{$configname};
    }
    else if (isset($CFG->plugin->{$plugintype}->{$pluginname}->{$key})) {
        log_warn(
            "Mahara 1.9-format plugin config detected in your config.php: \$cfg->plugin->{$plugintype}->{$pluginname}->{$key}."
            . " You should change this to the Mahara 1.10 format: \$cfg->plugin_{$plugintype}_{$pluginname}_{$key}."
        );
1068
1069
1070
1071
        return $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
    }
    // If we have already fetched this plugin's data from the database, then return NULL.
    // (Note that some values may come from config.php before we hit the database.)
1072
    else if (in_array($typename, $pluginsfetched)) {
1073
        return null;
1074
    }
1075
1076
    // We haven't fetched this plugin's data yet. So do it!
    else {
1077

1078
        // To minimize database calls, get all the records for this plugin from the database at once.
1079
1080
1081
1082
1083
1084
1085
        try {
            $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field');
        }
        catch (SQLException $e) {
            // Db might not exist yet on install
            return null;
        }
1086
1087
        if (!empty($records)) {
            foreach ($records as $record) {
1088
1089
1090
                $storeconfigname = "plugin_{$typename}_{$record->field}";
                if (!isset($CFG->{$storeconfigname})) {
                    $CFG->{$storeconfigname} = $record->value;
1091
                }
1092
1093
            }
        }
1094

1095
        // Make a note that we've now hit the database over this one.
1096
        $pluginsfetched[] = $typename;
1097
1098
1099
1100

        // Now, return it if we found it, otherwise null.
        // (This could be done by a recursive call to get_config_plugin(), but it's
        // less error-prone to do it this way and it doesn't cause that much duplication)
1101
1102
        if (isset($CFG->{$configname})) {
            return $CFG->{$configname};
1103
1104
1105
1106
1107
        }
        else {
            return null;
        }
    }
1108
1109
}

1110
1111
1112
1113
1114
1115
1116
1117
1118
/**
 * Set or update a plugin config value.
 *
 * @param string $plugintype The plugin type: 'artefact', 'blocktype', etc
 * @param string $pluginname The plugin name: 'file', 'creativecommons', etc
 * @param string $key The config name
 * @param string $value The config's new value
 * @return boolean Whether or not the config was updated successfully
 */
Penny Leach's avatar
Penny Leach committed
1119
function set_config_plugin($plugintype, $pluginname, $key, $value) {
1120
    global $CFG;
1121
    $table = $plugintype . '_config';
1122
    $value = (string) $value;
Penny Leach's avatar
Penny Leach committed
1123

1124
    $success = false;
1125
1126
1127
1128
1129
1130
1131
1132
1133
    $dbvalue = get_field($table, 'value', 'plugin', $pluginname, 'field', $key);
    if (false !== $dbvalue) {
        if (
                // No need to update the DB if the value already matches
                ($dbvalue === $value)
                || set_field($table, 'value', $value, 'plugin', $pluginname, 'field', $key)
        ) {
            $success = true;
        }
Penny Leach's avatar
Penny Leach committed
1134
1135
    }
    else {
1136
        $pconfig = new stdClass();
Penny Leach's avatar
Penny Leach committed
1137
1138
1139
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
1140
        $success = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
1141
    }
1142
    // Now update the cached version
1143
1144
1145
    if ($success) {
        $configname = "plugin_{$plugintype}_{$pluginname}_{$key}";
        $CFG->{$configname} = $value;
Penny Leach's avatar
Penny Leach committed
1146
1147
1148
1149
1150
        return true;
    }
    return false;
}

1151
1152
/**
 * This function returns a value for $CFG for a plugin instance
Aaron Wells's avatar
Aaron Wells committed
1153
 * or null if it is not found. Initially this is interesting only
1154
1155
1156
 * for multiauth. Note that it may go and look in the database
 *
 * @param string $plugintype   E.g. auth
1157
 * @param string $instanceid     Instance id
1158
1159
 * @param string $key          The config setting to look for
 */
1160
function get_config_plugin_instance($plugintype, $instanceid, $key) {
1161
1162
1163
    global $CFG;

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

    // Suppress NOTICE with @ in case $key is not yet cached
1167
1168
    $configname = "plugin_{$plugintype}_{$instance}_{$key}";
    @$value = $CFG->{$configname};
1169
    if (isset($value)) {
1170
1171
1172
        return $value;
    }

1173
1174
1175
    $instancefield = $plugintype == 'interaction_forum' ? 'forum' : 'instance';
    $records = get_records_array($plugintype . '_instance_config', $instancefield, $instanceid, 'field', 'field, value');

1176
    if (!empty($records)) {
1177
        foreach($records as $record) {
1178
1179
            $storeconfigname = "plugin_{$plugintype}_{$instance}_{$record->field}";
            $CFG->{$storeconfigname} = $record->value;
1180
            if ($record->field == $key) {
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
                $value = $record->value;
            }
        }
    }

    return $value;
}

/**
 * This function returns a value for $CFG for a plugin instance
Aaron Wells's avatar
Aaron Wells committed
1191
 * or null if it is not found. Initially this is interesting only
1192
1193
1194
1195
 * for multiauth. Note that it may go and look in the database
 *
 * @param string $plugintype   E.g. auth
 * @param string $pluginname   E.g. internal
1196
 * @param string $instanceid     Instance id
1197
1198
 * @param string $key          The config setting to look for
 */
1199
function set_config_plugin_instance($plugintype, $pluginname, $instanceid, $key, $value) {
1200
    global $CFG;
1201
    $value = (string) $value;
1202