mahara.php 141 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 = '5.3.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 69 70 71
    // Check for freetype in the gd extension
    $gd_info = gd_info();
    if (!$gd_info['FreeType Support']) {
        throw new ConfigSanityException(get_string('gdfreetypenotloaded', 'error'));
    }
72

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

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

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

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

117 118 119 120 121
    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'));
    }

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

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

134 135
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
136 137 138 139 140 141 142
        $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);
143
    }
144

145 146 147
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
148
        !check_dir_exists(get_config('dataroot') . 'temp') ||
149
        !check_dir_exists(get_config('dataroot') . 'langpacks') ||
150 151 152
        !check_dir_exists(get_config('dataroot') . 'htmlpurifier') ||
        !check_dir_exists(get_config('dataroot') . 'log') ||
        !check_dir_exists(get_config('dataroot') . 'images')) {
153 154
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
155 156 157 158 159
    // 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')));
    }
160

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

164
/**
Aaron Wells's avatar
Aaron Wells committed
165
 * Check sanity of things that we only check at installation time - not on
166 167 168 169 170 171 172
 * 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'));
    }
173 174 175
    if (is_postgres() && !postgres_create_language('plpgsql')) {
        throw new ConfigSanityException(get_string('plpgsqlnotavailable', 'error'));
    }
176 177 178
    if (is_mysql() && !mysql_has_trigger_privilege()) {
        throw new ConfigSanityException(get_string('mysqlnotriggerprivilege', 'error'));
    }
179 180
}

181 182 183 184 185 186 187 188 189
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'));
            }
        }
190 191 192
        if (!mysql_has_trigger_privilege()) {
            throw new ConfigSanityException(get_string('mysqlnotriggerprivilege', 'error'));
        }
193
    }
194 195 196
    if (is_postgres() && !postgres_create_language('plpgsql')) {
        throw new ConfigSanityException(get_string('plpgsqlnotavailable', 'error'));
    }
197 198
}

199 200 201 202 203 204 205 206 207 208
/**
 * 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;
    }
209 210 211
    else {
        $install = false;
    }
212 213
    uksort($upgrades, 'sort_upgrades');
    foreach ($upgrades as $name => $data) {
214
        if ($name == 'settings') {
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
            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';
            }
246 247 248
            else if ($name == 'local') {
                $funname = 'upgrade_local';
            }
249 250 251 252 253 254 255 256 257
            else {
                $funname = 'upgrade_plugin';
            }
            $data->name = $name;
            $funname($data);
        }
    }
}

258 259 260 261 262
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
263
    if (get_config('installed')) {
264 265 266 267 268 269 270 271
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

272
function get_string($identifier, $section='mahara') {
273 274 275 276 277

    $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.
278 279
    }
    else {
280 281
        $variables = array();
    }
Aaron Wells's avatar
Aaron Wells committed
282

283 284 285
    return get_string_location($identifier, $section, $variables);
}

286 287 288 289 290 291 292 293 294 295 296
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
297

298 299 300
    return get_string_location($identifier, $section, $variables, 'format_langstring', $lang);
}

301 302 303 304 305 306 307 308 309
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) {

310
    $subdir = 'help/';
311 312

    if ($page) {
313
        $pagebits = explode('-', $page);
314
        $file = array_pop($pagebits) . '.html';
315
        if ($plugintype != 'core') {
316
            $subdir .= 'pages/' . join('/', $pagebits) . '/';
317 318
        }
        else {
319
            $subdir .= 'pages/' . $pluginname . '/' . join('/', $pagebits) . '/';
Aaron Wells's avatar
Aaron Wells committed
320
        }
321 322
    }
    else if ($section) {
323 324
        $subdir .= 'sections/';
        $file = $section . '.html';
325 326
    }
    else if (!empty($form) && !empty($element)) {
327 328
        $subdir .= 'forms/';
        $file = $form . '.' . $element . '.html';
329 330
    }
    else if (!empty($form) && empty($element)) {
331 332
        $subdir .= 'forms/';
        $file = $form . '.html';
333 334 335 336 337 338 339 340 341 342 343 344 345 346
    }
    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;
    }

347
    //try the local settings
348 349 350 351 352 353 354
    $langfile = get_config('docroot') . 'local/lang/' . $lang . '/' . $subdir;
    if ($plugintype != 'core') {
        $langfile .= $plugintype . '.' . $pluginname . '.' . $file;
    }
    else {
        $langfile .= $file;
    }
355 356 357 358
    if (is_readable($langfile)) {
        return $langfile;
    }

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    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') {
381 382 383 384 385 386
        $location = $plugintype . '/' . $pluginname . '/lang/';
    }
    else {
        $location = 'lang/';
    }

387
    // try the current language
388
    $langfile = get_language_root() . $location . $lang . '/' . $subdir . $file;
389 390 391 392 393 394
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
395
        $langfile = get_language_root($lang) . 'lang/' . $lang . '/langconfig.php';
396 397 398 399
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
400
            $langfile = get_language_root($parentlang) . $location . $parentlang . '/' . $subdir . $file;
401 402 403 404 405 406 407 408
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

    // if it's STILL not found, and we haven't already tried english ...
    if (empty($data) && empty($trieden)) {
409
        $langfile = get_language_root('en.utf8') . $location . 'en.utf8/' . $subdir . $file;
410 411 412 413
        if (is_readable($langfile)) {
            return $langfile;
        }
    }
414 415 416

    // if it's a form element, try the wildcard form name
    if (!empty($form) && !empty($element) && $form !== 'ANY') {
417 418 419 420 421
        // 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)) {
            $element = end(explode('_', $element));
        }
422 423 424
        return get_helpfile_location('core', '', 'ANY', $element, $page, $section);
    }

425 426 427
    return false;
}

428 429 430 431 432
// 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.
433
    return get_string_location($identifier, $section, array(), 'raw_langstring');
434 435 436 437 438 439 440 441 442 443 444 445 446 447
}


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

450
    $langconfigstrs = array('parentlanguage', 'thislanguage');
451

452 453 454 455
    if ($section == 'mahara' &&
        (in_array($identifier, $langconfigstrs)
         || strpos($identifier, 'strftime') === 0
         || strpos($identifier, 'strfday')  === 0)) {
456 457 458
        $section = 'langconfig';
    }

459 460 461
    if (empty($lang)) {
        $lang = current_language();
    }
462 463

    // Define the locations of language strings for this section
464
    $langstringroot = get_language_root($lang);
465 466
    $docroot = get_config('docroot');

467
    $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
468

469
    if (false === strpos($section, '.')) {
470
        $langdirectory = 'lang/';
471 472
    }
    else {
473 474 475 476 477 478 479 480 481 482 483 484 485
        $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/';
486
                }
487 488 489
            }
        }
    }
490

491 492 493 494 495 496 497
    // 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
498 499
    $result = get_string_local($langstringroot . $langdirectory, $lang . '/' . $section . '.php', $identifier);
    if ($result !== false) {
500
        return $replacefunc($result, $variables, $lang);
501 502 503 504 505
    }

    // 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') {
506
        return '[[' . $identifier . '/' . $section . ']]';
507 508 509
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
510 511 512
    $langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
    if (is_readable($langfile)) {
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
513 514 515 516 517 518 519 520 521

            // 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);
522
            if ($result !== false) {
523
                return $replacefunc($result, $variables, $parentlang);
524 525 526 527 528
            }
        }
    }

    /// Our only remaining option is to try English
529 530
    $result = get_string_local(get_config('docroot') . $langdirectory, 'en.utf8/' . $section . '.php', $identifier);
    if ($result !== false) {
531
        return $replacefunc($result, $variables);
532 533
    }

534
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
535
}
536 537


538 539 540 541 542 543 544 545
/**
 * 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)) {
546 547
            $result = get_string_from_file($identifier, $file);
            if ($result !== false) {
548 549 550 551 552 553 554 555
                return $result;
            }
        }
    }
    return false;
}


556 557 558 559 560
/**
 * Return a list of available languages
 *
 */
function get_languages() {
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    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;
                            }
                        }
                    }
576
                }
577
                closedir($langdir);
578
                asort($langs);
579 580 581
            }
            else {
                log_warn('Unable to read language directory ' . $langbase);
582 583 584
            }
        }
    }
585

586 587 588
    return $langs;
}

589 590 591
/**
 * Returns whether the given language is installed/available for use
 */
592
function language_installed($lang) {
593 594 595 596 597 598
    foreach (language_get_searchpaths() as $searchpath) {
        if (is_readable($searchpath . 'lang/' . $lang . '/langconfig.php')) {
            return true;
        }
    }
    return false;
599 600
}

601 602 603 604 605 606 607 608 609
/**
 * 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) {
610 611 612 613
        // Construct the search path
        $docrootpath = array(get_config('docroot'));

        // Paths to language files in dataroot
614 615 616 617 618 619
        $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();
        }
620 621 622 623 624 625 626 627 628 629

        // 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");
630
            }
631
        }
632 633

        $searchpaths = array_merge($docrootpath, $datarootpaths, $langpacksearchpaths);
634 635 636 637 638 639 640 641
    }

    return $searchpaths;
}

/**
 * Get the directory in which the specified language pack resides.
 *
Aaron Wells's avatar
Aaron Wells committed
642
 * Defaults to getting the directory for the current_language() - i.e. the
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
 * 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];
}

671
/**
672
 * Return a list of all available themes.
673
 * @return array subdir => name
674
 */
675
function get_all_themes() {
676 677
    static $themes = null;

678 679 680
    if (is_null($themes)) {
        $themes = array();
        $themelist = get_all_theme_objects();
681

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
        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
 */
698
function get_user_accessible_themes() {
699 700 701 702 703 704
    global $USER;

    $themes = array();
    if ($institutions = $USER->get('institutions')) {
        // Get themes for all of this users institutions
        foreach ($institutions AS $i) {
705
            $themes = array_merge($themes, get_institution_themes($i->institution));
706 707
        }
    }
708 709 710
    else {
        $themelist = get_all_theme_objects();
        foreach ($themelist AS $subdir => $theme) {
711
            if (!isset($theme->institutions) || !is_array($theme->institutions)) {
712 713 714 715 716
                $themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
            }
        }

    }
717
    $themes = array_merge(array('sitedefault' => get_string('nothemeselected', 'view')), $themes);
718 719
    unset($themes['custom']);

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
    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) {
735
            if (empty($theme->institutions) || !is_array($theme->institutions) || in_array($institution, $theme->institutions)) {
736
                $r[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
737 738
            }
        }
739
        $institutionthemes[$institution] = $r;
740 741
    }

742 743 744 745 746 747 748 749 750 751
    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;
752

753 754 755 756 757 758 759
    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))) {
760
            if (substr($subdir, 0, 1) != "." && is_dir($themebase . $subdir)) {
761 762 763 764 765 766 767 768
                // 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) {
769 770 771 772
                            // don't include the special subthemestarter theme in the options
                            if ($subdir != 'subthemestarter') {
                                $themes[$subdir] = $theme;
                            }
773
                        }
774
                    }
775
                }
776
            }
777
        }
778
        closedir($themedir);
779
        asort($themes);
780
    }
781

782 783 784 785
    return $themes;
}


786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
/**
 * 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
 *
824
 * @param string $ini_get_arg setting to look for
825 826 827 828 829 830 831 832 833 834 835
 * @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;
}

836 837 838 839 840 841 842 843
/**
 * 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() {
844
   global $CFG;
845
   global $OVERRIDDEN;    // array containing the config fields overridden by $CFG
846

847 848 849 850
   // Get a full list of overridden fields
   foreach ($CFG as $field => $value) {
        $OVERRIDDEN[] = $field;
   }
851

852
   $dbconfig = get_records_array('config', '', '', '', 'field, value');
853
   foreach ($dbconfig as $cfg) {
854
       if (!isset($CFG->{$cfg->field})) {
855 856 857
           $CFG->{$cfg->field} = $cfg->value;
       }
   }
858

859
   return true;
860 861 862
}

/**
863 864
 * This function returns a value from $CFG
 * or null if it is not found
Aaron Wells's avatar
Aaron Wells committed
865 866
 *
 * @param string $key config setting to look for
867 868
 * @return mixed
 */
869 870
function get_config($key) {
    global $CFG;
871
    if (isset($CFG->$key)) {
872 873 874 875 876
        return $CFG->$key;
    }
    return null;
}

877 878 879 880 881 882 883 884 885

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

888
    db_ignore_sql_exceptions(true);
889 890
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
891 892
            $status = true;
        }
Aaron Wells's avatar
Aaron Wells committed
893
    }
Penny Leach's avatar
Penny Leach committed
894 895 896 897
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
898
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
899
    }
900
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
901 902

    if (!empty($status)) {
903 904 905
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
906

907 908 909 910 911
    return false;
}

/**
 * This function returns a value for $CFG for a plugin
912 913 914
 * or null if it is not found.
 *
 * It will give precedence to config values set in config.php like so:
915
 * $cfg->plugin_{$plugintype}_{$pluginname}_{$key} = 'whatever';
916 917 918
 *
 * If it doesn't find one of those, it will look for the config value in
 * the database.
919 920 921 922
 *
 * @param string $plugintype eg artefact
 * @param string $pluginname eg blog
 * @param string $key the config setting to look for
923
 * @return mixed The value of the key if found, or NULL if not found
924 925 926
 */
function get_config_plugin($plugintype, $pluginname, $key) {
    global $CFG;
927 928 929 930 931 932 933 934 935 936 937 938
    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}."
        );
939 940 941 942
        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.)
943
    else if (in_array($typename, $pluginsfetched)) {
944
        return null;
945
    }
946 947
    // We haven't fetched this plugin's data yet. So do it!
    else {
948

949 950 951 952
        // To minimize database calls, get all the records for this plugin from the database at once.
        $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field');
        if (!empty($records)) {
            foreach ($records as $record) {
953 954 955
                $storeconfigname = "plugin_{$typename}_{$record->field}";
                if (!isset($CFG->{$storeconfigname})) {
                    $CFG->{$storeconfigname} = $record->value;
956
                }
957 958
            }
        }
959

960
        // Make a note that we've now hit the database over this one.
961
        $pluginsfetched[] = $typename;
962 963 964 965

        // 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)
966 967
        if (isset($CFG->{$configname})) {
            return $CFG->{$configname};
968 969 970 971 972
        }
        else {
            return null;
        }
    }
973 974
}

975 976 977 978 979 980 981 982 983
/**
 * 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
984
function set_config_plugin($plugintype, $pluginname, $key, $value) {
985
    global $CFG;
986
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
987

988
    $success = false;
989
    if (false !== get_field($table, 'value', 'plugin', $pluginname, 'field', $key)) {
990
        $success = set_field($table, 'value', $value, 'plugin', $pluginname, 'field', $key);
Penny Leach's avatar
Penny Leach committed
991 992
    }
    else {
993
        $pconfig = new stdClass();
Penny Leach's avatar
Penny Leach committed
994 995 996
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
997
        $success = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
998
    }
999
    // Now update the cached version
1000 1001 1002
    if ($success) {
        $configname = "plugin_{$plugintype}_{$pluginname}_{$key}";
        $CFG->{$configname} = $value;
Penny Leach's avatar
Penny Leach committed
1003 1004 1005 1006 1007
        return true;
    }
    return false;
}

1008 1009
/**
 * This function returns a value for $CFG for a plugin instance
Aaron Wells's avatar
Aaron Wells committed
1010
 * or null if it is not found. Initially this is interesting only
1011 1012 1013 1014 1015 1016 1017
 * 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
 */
1018
function get_config_plugin_instance($plugintype, $pluginid, $key) {
1019 1020 1021
    global $CFG;

    // Must be unlikely to exist as a config option for any plugin
1022
    $instance = '_i_n_s_t' . $pluginid;
1023 1024

    // Suppress NOTICE with @ in case $key is not yet cached
1025 1026
    $configname = "plugin_{$plugintype}_{$instance}_{$key}";
    @$value = $CFG->{$configname};
1027
    if (isset($value)) {
1028 1029 1030
        return $value;
    }

1031
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
1032
    if (!empty($records)) {
1033
        foreach($records as $record) {
1034 1035
            $storeconfigname = "plugin_{$plugintype}_{$instance}_{$record->field}";
            $CFG->{$storeconfigname} = $record->value;
1036
            if ($record->field == $key) {
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
                $value = $record->value;
            }
        }
    }

    return $value;
}

/**
 * This function returns a value for $CFG for a plugin instance
Aaron Wells's avatar
Aaron Wells committed
1047
 * or null if it is not found. Initially this is interesting only
1048 1049 1050 1051 1052 1053 1054 1055 1056