mahara.php 100 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 151 152 153 154 155 156
        $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);
157
    }
158

159 160 161
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
162
        !check_dir_exists(get_config('dataroot') . 'sessions') ||
163
        !check_dir_exists(get_config('dataroot') . 'temp') ||
164
        !check_dir_exists(get_config('dataroot') . 'langpacks') ||
165 166 167
        !check_dir_exists(get_config('dataroot') . 'htmlpurifier') ||
        !check_dir_exists(get_config('dataroot') . 'log') ||
        !check_dir_exists(get_config('dataroot') . 'images')) {
168 169
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
170

171
    raise_memory_limit('128M');
172 173
}

174 175 176 177 178 179 180 181 182
/**
 * 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'));
    }
183 184 185
    if (is_postgres() && !postgres_create_language('plpgsql')) {
        throw new ConfigSanityException(get_string('plpgsqlnotavailable', 'error'));
    }
186 187 188
    if (is_mysql() && !mysql_has_trigger_privilege()) {
        throw new ConfigSanityException(get_string('mysqlnotriggerprivilege', 'error'));
    }
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 212 213 214 215 216 217 218
/**
 * 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;
    }
219 220 221
    else {
        $install = false;
    }
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
    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';
            }
256 257 258
            else if ($name == 'local') {
                $funname = 'upgrade_local';
            }
259 260 261 262 263 264 265 266 267
            else {
                $funname = 'upgrade_plugin';
            }
            $data->name = $name;
            $funname($data);
        }
    }
}

268 269 270 271 272
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
273
    if (get_config('installed')) {
274 275 276 277 278 279 280 281
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

282
function get_string($identifier, $section='mahara') {
283 284 285 286 287

    $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.
288 289
    }
    else {
290 291 292
        $variables = array();
    }
    
293 294 295
    return get_string_location($identifier, $section, $variables);
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
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);
}

311 312 313 314 315 316 317 318 319
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) {

320
    $subdir = 'help/';
321 322

    if ($page) {
323
        $pagebits = explode('-', $page);
324
        $file = array_pop($pagebits) . '.html';
325
        if ($plugintype != 'core') {
326
            $subdir .= 'pages/' . join('/', $pagebits) . '/';
327 328
        }
        else {
329
            $subdir .= 'pages/' . $pluginname . '/' . join('/', $pagebits) . '/';
330
        } 
331 332
    }
    else if ($section) {
333 334
        $subdir .= 'sections/';
        $file = $section . '.html';
335 336
    }
    else if (!empty($form) && !empty($element)) {
337 338
        $subdir .= 'forms/';
        $file = $form . '.' . $element . '.html';
339 340
    }
    else if (!empty($form) && empty($element)) {
341 342
        $subdir .= 'forms/';
        $file = $form . '.html';
343 344 345 346 347 348 349 350 351 352 353 354 355 356
    }
    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;
    }

357
    //try the local settings
358 359 360 361 362 363 364
    $langfile = get_config('docroot') . 'local/lang/' . $lang . '/' . $subdir;
    if ($plugintype != 'core') {
        $langfile .= $plugintype . '.' . $pluginname . '.' . $file;
    }
    else {
        $langfile .= $file;
    }
365 366 367 368
    if (is_readable($langfile)) {
        return $langfile;
    }

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
    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') {
391 392 393 394 395 396
        $location = $plugintype . '/' . $pluginname . '/lang/';
    }
    else {
        $location = 'lang/';
    }

397
    // try the current language
398
    $langfile = get_language_root() . $location . $lang . '/' . $subdir . $file;
399 400 401 402 403 404
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
405
        $langfile = get_language_root($lang) . 'lang/' . $lang . '/langconfig.php';
406 407 408 409
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
410
            $langfile = get_language_root($parentlang) . $location . $parentlang . '/' . $subdir . $file;
411 412 413 414 415 416 417 418
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

    // if it's STILL not found, and we haven't already tried english ...
    if (empty($data) && empty($trieden)) {
419
        $langfile = get_language_root('en.utf8') . $location . 'en.utf8/' . $subdir . $file;
420 421 422 423
        if (is_readable($langfile)) {
            return $langfile;
        }
    }
424 425 426 427 428 429

    // if it's a form element, try the wildcard form name
    if (!empty($form) && !empty($element) && $form !== 'ANY') {
        return get_helpfile_location('core', '', 'ANY', $element, $page, $section);
    }

430 431 432
    return false;
}

433 434 435 436 437
// 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.
438
    return get_string_location($identifier, $section, array(), 'raw_langstring');
439 440 441 442 443 444 445 446 447 448 449 450 451 452
}


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

455
    $langconfigstrs = array('parentlanguage', 'thislanguage');
456

457 458 459 460
    if ($section == 'mahara' &&
        (in_array($identifier, $langconfigstrs)
         || strpos($identifier, 'strftime') === 0
         || strpos($identifier, 'strfday')  === 0)) {
461 462 463
        $section = 'langconfig';
    }

464 465 466
    if (empty($lang)) {
        $lang = current_language();
    }
467 468

    // Define the locations of language strings for this section
469
    $langstringroot = get_language_root($lang);
470
    $langdirectory  = ''; // The directory in which the language file for this string should ideally reside, if the language has implemented it
471
    
472
    if (false === strpos($section, '.')) {
473
        $langdirectory = 'lang/';
474 475 476
    }
    else {
        $extras = plugin_types(); // more later..
477
        foreach ($extras as $tocheck) {
478
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
479
                $pluginname = substr($section ,strlen($tocheck) + 1);
480 481 482
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
483
                    $langdirectory = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
484
                    $section = 'blocktype.' . $bits[1];
485 486
                }
                else {
487
                    $langdirectory = $tocheck . '/' . $pluginname . '/lang/';
488
                }
489 490 491
            }
        }
    }
492

493
    // First check all the normal locations for the string in the current language
494 495
    $result = get_string_local($langstringroot . $langdirectory, $lang . '/' . $section . '.php', $identifier);
    if ($result !== false) {
496
        return $replacefunc($result, $variables, $lang);
497 498 499 500 501
    }

    // 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') {
502
        return '[[' . $identifier . '/' . $section . ']]';
503 504 505
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
506 507 508
    $langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
    if (is_readable($langfile)) {
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
509 510
            $result = get_string_local(get_language_root($parentlang) . 'lang/', $parentlang . '/' . $section . '.php', $identifier);
            if ($result !== false) {
511
                return $replacefunc($result, $variables, $parentlang);
512 513 514 515 516
            }
        }
    }

    /// Our only remaining option is to try English
517 518
    $result = get_string_local(get_config('docroot') . $langdirectory, 'en.utf8/' . $section . '.php', $identifier);
    if ($result !== false) {
519
        return $replacefunc($result, $variables);
520 521
    }

522
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
523
}
524 525


526 527 528 529 530 531 532 533
/**
 * 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)) {
534 535
            $result = get_string_from_file($identifier, $file);
            if ($result !== false) {
536 537 538 539 540 541 542 543
                return $result;
            }
        }
    }
    return false;
}


544 545 546 547 548
/**
 * Return a list of available languages
 *
 */
function get_languages() {
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
    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;
                            }
                        }
                    }
564
                }
565
                closedir($langdir);
566
                asort($langs);
567 568 569
            }
            else {
                log_warn('Unable to read language directory ' . $langbase);
570 571 572
            }
        }
    }
573

574 575 576
    return $langs;
}

577 578 579
/**
 * Returns whether the given language is installed/available for use
 */
580
function language_installed($lang) {
581 582 583 584 585 586
    foreach (language_get_searchpaths() as $searchpath) {
        if (is_readable($searchpath . 'lang/' . $lang . '/langconfig.php')) {
            return true;
        }
    }
    return false;
587 588
}

589 590 591 592 593 594 595 596 597
/**
 * 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) {
598 599 600 601
        // Construct the search path
        $docrootpath = array(get_config('docroot'));

        // Paths to language files in dataroot
602
        $datarootpaths = (array)glob(get_config('dataroot') . 'langpacks/*', GLOB_MARK | GLOB_ONLYDIR);
603 604 605 606 607 608 609 610 611 612

        // 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");
613
            }
614
        }
615 616

        $searchpaths = array_merge($docrootpath, $datarootpaths, $langpacksearchpaths);
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
    }

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

654
/**
655
 * Return a list of all available themes.
656
 * @return array subdir => name
657
 */
658
function get_all_themes() {
659 660
    static $themes = null;

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
    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
 */
680
function get_user_accessible_themes() {
681 682 683 684 685 686
    global $USER;

    $themes = array();
    if ($institutions = $USER->get('institutions')) {
        // Get themes for all of this users institutions
        foreach ($institutions AS $i) {
687
            $themes = array_merge($themes, get_institution_themes($i->institution));
688 689
        }
    }
690 691 692
    else {
        $themelist = get_all_theme_objects();
        foreach ($themelist AS $subdir => $theme) {
693
            if (!isset($theme->institutions) || !is_array($theme->institutions)) {
694 695 696 697 698
                $themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
            }
        }

    }
699
    $themes = array_merge(array('sitedefault' => get_string('nothemeselected', 'view')), $themes);
700 701
    unset($themes['custom']);

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
    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) {
717
            if (empty($theme->institutions) || !is_array($theme->institutions) || in_array($institution, $theme->institutions)) {
718
                $r[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
719 720
            }
        }
721
        $institutionthemes[$institution] = $r;
722 723
    }

724 725 726 727 728 729 730 731 732 733
    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;
734

735 736 737 738 739 740 741
    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))) {
742
            if (substr($subdir, 0, 1) != "." && is_dir($themebase . $subdir)) {
743 744 745 746 747 748 749 750 751 752
                // 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;
                        }
753
                    }
754
                }
755
            }
756
        }
757
        closedir($themedir);
758
        asort($themes);
759
    }
760

761 762 763 764
    return $themes;
}


765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
/**
 * 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
 *
803
 * @param string $ini_get_arg setting to look for
804 805 806 807 808 809 810 811 812 813 814
 * @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;
}

815 816 817 818 819 820 821 822
/**
 * 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() {
823
   global $CFG;
824
   global $OVERRIDDEN;    // array containing the config fields overridden by $CFG
825

826 827 828 829
   // Get a full list of overridden fields
   foreach ($CFG as $field => $value) {
        $OVERRIDDEN[] = $field;
   }
830

831
   $dbconfig = get_records_array('config', '', '', '', 'field, value');
832
   foreach ($dbconfig as $cfg) {
833
       if (!isset($CFG->{$cfg->field})) {
834 835 836
           $CFG->{$cfg->field} = $cfg->value;
       }
   }
837

838
   return true;
839 840 841
}

/**
842 843 844 845 846 847
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
848 849
function get_config($key) {
    global $CFG;
850
    if (isset($CFG->$key)) {
851 852 853 854 855
        return $CFG->$key;
    }
    return null;
}

856 857 858 859 860 861 862 863 864

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

867
    db_ignore_sql_exceptions(true);
868 869
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
870 871 872 873 874 875 876
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
877
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
878
    }
879
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
880 881

    if (!empty($status)) {
882 883 884
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
885

886 887 888 889 890 891 892 893 894 895 896 897 898 899
    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;
900

901 902
    $CFG->plugin = new StdClass;

903 904
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
905
    if (isset($CFG->plugin->{$plugintype})) {
906 907 908
        return $value;
    }

909
    $CFG->plugin = new stdClass();
910 911
    $CFG->plugin->{$plugintype} = new StdClass;

912
    $records = get_records_array($plugintype . '_config');
913
    if (!empty($records)) {
914
        foreach($records as $record) {
915
            $CFG->plugin->{$plugintype}->{$record->plugin} = new stdClass();
916 917
            $CFG->plugin->{$plugintype}->{$record->plugin}->{$record->field} = $record->value;
            if ($record->field == $key && $record->plugin == $pluginname) {
918 919 920
                $value = $record->value;
            }
        }
921 922
    }

923 924 925
    return $value;
}

Penny Leach's avatar
Penny Leach committed
926
function set_config_plugin($plugintype, $pluginname, $key, $value) {
927
    global $CFG;
928
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
929

930 931 932
    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
933 934 935 936 937 938 939 940
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
941
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
942 943
    }
    if ($status) {
944 945 946 947 948 949 950 951
        if (!isset($CFG->plugin)) {
            $CFG->plugin = new stdClass();
        }

        if (!isset($CFG->plugin->{$plugintype})) {
            $CFG->plugin->{$plugintype} = new stdClass();
        }

952
        $CFG->plugin->{$plugintype}->{$pluginname} = new stdClass();
Penny Leach's avatar
Penny Leach committed
953 954 955 956 957 958
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

959 960 961 962 963 964 965 966 967 968
/**
 * 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
 */
969
function get_config_plugin_instance($plugintype, $pluginid, $key) {
970 971 972 973 974 975
    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
976
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
977
    if (isset($value)) {
978 979 980
        return $value;
    }

981
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
982
    if (!empty($records)) {
983
        foreach($records as $record) {
984
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
985
            if ($record->field == $key) {
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
                $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;
}

1029
/**
1030 1031 1032 1033 1034
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
1035 1036 1037 1038 1039 1040
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
/**
 * Reads the locales string from a language pack and attempts to set the current locale
 * based on the contents of that string.
 *
 * @param string $lang
 */
function set_locale_for_language($lang) {
    if (empty($lang)) {
        return;
    }

1052
    if ($args = explode(',', get_string_location('locales', 'langconfig', array(), 'raw_langstring', $lang))) {
1053 1054 1055 1056 1057
        array_unshift($args, LC_ALL);
        call_user_func_array('setlocale', $args);
    }
}

1058
/**
1059 1060 1061
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
1062
 *
1063 1064
 * @return string
 */
1065
function current_language() {
1066
    global $USER, $CFG, $SESSION;
1067

1068
    static $userlang, $lastlang;
1069

1070
    $loggedin = $USER instanceof User && $USER->is_logged_in();
1071

1072
    if (!isset($userlang) && $loggedin) {
1073 1074
        $userlang = $USER->get_account_preference('lang');
        if ($userlang !== null && $userlang != 'default') {
1075
            if (!language_installed($userlang)) {
1076
                $USER->set_account_preference('lang', 'default');
Richard Mansfield's avatar