mahara.php 66 KB
Newer Older
1 2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6 7 8 9
 * 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.
10
 *
Francois Marier's avatar
Francois Marier committed
11 12 13 14
 * 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.
15
 *
Francois Marier's avatar
Francois Marier committed
16 17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 19 20
 *
 * @package    mahara
 * @subpackage core
21
 * @author     Catalyst IT Ltd
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
24
 * @copyright  (C) portions from Moodle, (C) Martin Dougiamas http://dougiamas.com
25 26
 */

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

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

36
    // PHP version
37
    if (version_compare(phpversion(), '5.1.3') < 0) {
38 39 40 41 42 43 44
        throw new ConfigSanityException(get_string('phpversion', 'error'));
    }

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

72 73 74 75
    if(!extension_loaded('curl')) {
        throw new ConfigSanityException(get_string('curllibrarynotinstalled', 'error'));
    }

76 77 78 79 80 81
    //Check for freetype in the gd extension
    $gd_info = gd_info();
    if (!$gd_info['FreeType Support']) {
        throw new ConfigSanityException(get_string('gdfreetypenotloaded', 'error'));
    }

82 83
    // register globals workaround
    if (ini_get_bool('register_globals')) {
84
        log_environ(get_string('registerglobals', 'error'));
85
        $massivearray = array_keys(array_merge($_POST, $_GET, $_COOKIE, $_SERVER, $_REQUEST, $_FILES));
86 87 88 89 90 91
        foreach ($massivearray as $tounset) {
            unset($GLOBALS[$tounset]);
        }
    }

    // magic_quotes_gpc workaround
92
    if (!defined('CRON') && ini_get_bool('magic_quotes_gpc')) {
93
        log_environ(get_string('magicquotesgpc', 'error'));
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
        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]);
            }
        }
    }

113
    if (ini_get_bool('magic_quotes_runtime')) {
114 115 116 117 118 119 120 121 122
        // Turn of magic_quotes_runtime. Anyone with this on deserves a slap in the face
        set_magic_quotes_runtime(0);
        log_environ(get_string('magicquotesruntime', 'error'));
    }

    if (ini_get_bool('magic_quotes_sybase')) {
        // See above comment re. magic_quotes_runtime
        @ini_set('magic_quotes_sybase', 0);
        log_environ(get_string('magicquotessybase', 'error'));
123 124
    }

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

130 131 132 133 134 135 136
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

137
    // dataroot inside document root.
138 139
    if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
        throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
140 141
    }

142 143
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
144
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
145
    }
146

147 148 149
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
150
        !check_dir_exists(get_config('dataroot') . 'sessions') ||
151
        !check_dir_exists(get_config('dataroot') . 'langpacks') ||
152
        !check_dir_exists(get_config('dataroot') . 'htmlpurifier')) {
153 154
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
155 156

    raise_memory_limit('32M');
157 158
}

159 160 161 162 163
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
164
    if (get_config('installed')) {
165 166 167 168 169 170 171 172
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

173
function get_string($identifier, $section='mahara') {
174 175 176 177 178

    $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.
179 180
    }
    else {
181 182 183
        $variables = array();
    }
    
184 185 186
    return get_string_location($identifier, $section, $variables);
}

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
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);
}

202 203 204 205 206 207 208 209 210 211 212 213
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) {

    $file = 'help/';

    if ($plugintype != 'core') {
214
        $location = $plugintype . '/' . $pluginname . '/lang/';
215 216
    }
    else {
217
        $location = 'lang/';
218 219 220
    }
    if ($page) {
        $page = str_replace('-', '/', $page);
221 222 223 224 225 226
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    }
    else if ($section) {
        $file .= 'sections/' . $section . '.html';
    }
    else if (!empty($form) && !empty($element)) {
        $file .= 'forms/' . $form . '.' . $element . '.html';
    }
    else if (!empty($form) && empty($element)) {
        $file .= 'forms/' . $form . '.html';
    }
    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;
    }

    // try the current language
251
    $langfile = get_language_root() . $location . $lang . '/' . $file;
252 253 254 255 256 257
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
258
        $langfile = get_language_root($lang) . 'lang/' . $lang . '/langconfig.php';
259 260 261 262
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
263
            $langfile = get_language_root($parentlang) . $location . $parentlang . '/' . $file;
264 265 266 267 268 269 270 271
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

    // if it's STILL not found, and we haven't already tried english ...
    if (empty($data) && empty($trieden)) {
272
        $langfile = get_language_root('en.utf8') . $location . 'en.utf8/' . $file;
273 274 275 276 277 278 279
        if (is_readable($langfile)) {
            return $langfile;
        }
    }
    return false;
}

280 281 282 283 284
// 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.
285 286
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
287 288 289 290 291 292 293 294 295 296 297 298 299 300
}


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

303
    $langconfigstrs = array('parentlanguage', 'thislanguage');
304

305 306 307
    if (in_array($identifier, $langconfigstrs)
        || strpos($identifier, 'strftime') === 0
        || strpos($identifier, 'strfday')  === 0) {
308 309 310
        $section = 'langconfig';
    }

311 312 313
    if (empty($lang)) {
        $lang = current_language();
    }
314 315

    // Define the locations of language strings for this section
316
    $langstringroot = get_language_root($lang);
317
    $langdirectory  = ''; // The directory in which the language file for this string should ideally reside, if the language has implemented it
318
    
319
    if (false === strpos($section, '.')) {
320
        $langdirectory = 'lang/';
321 322 323
    }
    else {
        $extras = plugin_types(); // more later..
324
        foreach ($extras as $tocheck) {
325
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
326
                $pluginname = substr($section ,strlen($tocheck) + 1);
327 328 329
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
330
                    $langdirectory = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
331
                    $section = 'blocktype.' . $bits[1];
332 333
                }
                else {
334
                    $langdirectory = $tocheck . '/' . $pluginname . '/lang/';
335
                }
336 337 338
            }
        }
    }
339

340
    // First check all the normal locations for the string in the current language
341 342 343 344
    $langfile = $langstringroot . $langdirectory . $lang . '/' . $section . '.php';
    if (is_readable($langfile)) {
        if ($result = get_string_from_file($identifier, $langfile)) {
            return $replacefunc($result, $variables);
345 346 347 348 349 350
        }
    }

    // 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') {
351
        return '[[' . $identifier . '/' . $section . ']]';
352 353 354
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
355 356 357 358 359 360 361
    $langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
    if (is_readable($langfile)) {
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            $langfile = get_language_root($parentlang) . 'lang/' . $parentlang . '/' . $section . '.php';
            if (is_readable($langfile)) {
                if ($result = get_string_from_file($identifier, $langfile)) {
                    return $replacefunc($result, $variables);
362 363 364 365 366 367
                }
            }
        }
    }

    /// Our only remaining option is to try English
368 369 370 371
    $langfile = get_config('docroot') . $langdirectory . 'en.utf8/' . $section . '.php';
    if (is_readable($langfile)) {
        if ($result = get_string_from_file($identifier, $langfile)) {
            return $replacefunc($result, $variables);
372 373 374
        }
    }

375
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
376
}
377 378


379 380 381 382 383
/**
 * Return a list of available languages
 *
 */
function get_languages() {
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    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;
                            }
                        }
                    }
399
                }
400 401 402 403
                closedir($langdir);
            }
            else {
                log_warn('Unable to read language directory ' . $langbase);
404 405 406
            }
        }
    }
407

408 409 410
    return $langs;
}

411 412 413
/**
 * Returns whether the given language is installed/available for use
 */
414
function language_installed($lang) {
415 416 417 418 419 420
    foreach (language_get_searchpaths() as $searchpath) {
        if (is_readable($searchpath . 'lang/' . $lang . '/langconfig.php')) {
            return true;
        }
    }
    return false;
421 422
}

423 424 425 426 427 428 429 430 431
/**
 * 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) {
432 433 434 435
        // Construct the search path
        $docrootpath = array(get_config('docroot'));

        // Paths to language files in dataroot
436
        $datarootpaths = (array)glob(get_config('dataroot') . 'langpacks/*.utf8', GLOB_MARK | GLOB_ONLYDIR);
437 438 439 440 441 442 443 444 445 446

        // 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");
447
            }
448
        }
449 450

        $searchpaths = array_merge($docrootpath, $datarootpaths, $langpacksearchpaths);
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
    }

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

488
/**
489
 * Return a list of available themes.
490
 *
491
 * Themes _must_ have a config.php, and it should specify a theme name.
492 493 494 495 496
 */
function get_themes() {
    $themes = array();
    $themebase = get_config('docroot') . 'theme/';
    if (!$themedir = opendir($themebase)) {
497
        throw new SystemException('Unable to read theme directory '.$themebase);
498 499
    }
    while (false !== ($subdir = readdir($themedir))) {
500 501
        if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
            $config_path = $themebase . $subdir . '/config.php';
502
            if (is_readable($config_path)) {
503
                require($config_path);
504 505 506 507
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
508 509 510 511 512 513 514
        }
    }
    closedir($themedir);
    return $themes;
}


515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
/**
 * 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
 *
553
 * @param string $ini_get_arg setting to look for
554 555 556 557 558 559 560 561 562 563 564
 * @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;
}

565 566 567 568 569 570 571 572 573 574
/**
 * 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() {
    global $CFG;
    
575
    $dbconfig = get_records_array('config', '', '', '', 'field, value');
576 577
    
    foreach ($dbconfig as $cfg) {
578
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
579
            // @todo warn that we're overriding db config with $CFG
580 581 582 583 584 585 586 587 588
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
589 590 591 592 593 594
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
595 596
function get_config($key) {
    global $CFG;
597
    if (isset($CFG->$key)) {
598 599 600 601 602
        return $CFG->$key;
    }
    return null;
}

603 604 605 606 607 608 609 610 611

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

614
    db_ignore_sql_exceptions(true);
615 616
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
617 618 619 620 621 622 623
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
624
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
625
    }
626
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
627 628

    if (!empty($status)) {
629 630 631
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
632

633 634 635 636 637 638 639 640 641 642 643 644 645 646
    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;
647

648 649
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
650
    if (isset($value)) {
651 652 653 654
        return $value;
    }

    $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
655
    if (!empty($records)) {
656 657
        foreach($records as $record) {
            $CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
658
            if ($record->field == $key) {
659 660 661
                $value = $record->value;
            }
        }
662 663
    }

664 665 666
    return $value;
}

Penny Leach's avatar
Penny Leach committed
667
function set_config_plugin($plugintype, $pluginname, $key, $value) {
668
    global $CFG;
669
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
670

671 672 673
    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
674 675 676 677 678 679 680 681
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
682
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
683 684 685 686 687 688 689 690
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

691 692 693 694 695 696 697 698 699 700
/**
 * 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
 */
701
function get_config_plugin_instance($plugintype, $pluginid, $key) {
702 703 704 705 706 707
    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
708
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
709
    if (isset($value)) {
710 711 712
        return $value;
    }

713
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
714
    if (!empty($records)) {
715
        foreach($records as $record) {
716
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
717
            if ($record->field == $key) {
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
                $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;
}

761
/**
762 763 764 765 766
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
767 768 769 770 771 772
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

773
/**
774 775 776 777 778 779
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
780
function current_language() {
781
    global $USER, $CFG, $SESSION;
782 783 784
    if ($USER instanceof User) {
        $lang = $USER->get_account_preference('lang');
        if ($lang !== null && $lang != 'default') {
785 786 787 788
            if (language_installed($lang)) {
                return $lang;
            }
            $USER->set_account_preference('lang', 'default');
789
        }
790
    }
791 792 793 794 795 796

    if (is_a($SESSION, 'Session')) {
        $sesslang = $SESSION->get('lang');
        if (!empty($sesslang) && $sesslang != 'default') {
            return $sesslang;
        }
797
    }
798

799 800 801 802 803 804
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

805
/**
806 807 808 809 810 811
 * Helper function to sprintf language strings
 * with a variable number of arguments
 * 
 * @param string $string raw string to use
 * @param array $args arguments to sprintf
 */
812 813 814 815
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

816 817 818 819 820 821 822 823 824 825 826 827 828
/**
 * Helper function to figure out whether an array is an array or a hash
 * @param array $array array to check
 * @return bool true if the array is a hash
 */
function is_hash($array) {
    if (!is_array($array)) {
        return false;
    }
    $diff = array_diff_assoc($array,array_values($array));
    return !empty($diff);
}

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
/**
 * Function to check if a directory exists and optionally create it.
 *
 * @param string absolute directory path
 * @param boolean create directory if does not exist
 * @param boolean create directory recursively
 *
 * @return boolean true if directory exists or created
 */
function check_dir_exists($dir, $create=true, $recursive=true) {

    $status = true;

    if(!is_dir($dir)) {
        if (!$create) {
            $status = false;
        } else {
846 847 848
            $mask = umask(0000);
            $status = @mkdir($dir, get_config('directorypermissions'), true);
            umask($mask);
849 850 851 852 853
        }
    }
    return $status;
}

854

Penny Leach's avatar
Penny Leach committed
855 856 857
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
858
 *
Penny Leach's avatar
Penny Leach committed
859 860
 * This function is the one safe point to require plugin files.
 * so USE it :)
861
 *
862 863 864 865 866 867 868 869
 * blocktypes are special cases.  eg:
 *   system blocks: safe_require('blocktype', 'wall');
 *   artefact blocks: safe_require('blocktype', 'file/html');
 *
 * import/export plugins are special cases.  eg:
 *   main library: safe_require('export', 'leap');
 *   artefact plugin implementation: safe_require('export', 'leap/file');
 *
Penny Leach's avatar
Penny Leach committed
870 871 872 873 874 875
 * @param string $plugintype the type of plugin (eg artefact)
 * @param string $pluginname the name of the plugin (eg blog)
 * @param string $filename the name of the file to include within the plugin structure
 * @param string $function (optional, defaults to require) the require/include function to use
 * @param string $nonfatal (optional, defaults to false) just returns false if the file doesn't exist
 */
876
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
877 878 879 880
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
881 882
    require_once(get_config('docroot') . $plugintype . '/lib.php');

883
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
884 885 886 887 888 889
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ('invalid require type');
    }

890 891 892 893 894
    if ($plugintype == 'blocktype') { // these are a bit of a special case
        $bits = explode('/', $pluginname);
        if (count($bits) == 2) {
           $fullpath = get_config('docroot') . 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/' . $filename;
        }
895
        else {
896 897 898 899 900 901 902 903 904
            try {
                if ($artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $pluginname)) {
                    $fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
                }
            }
            catch (SQLException $e) {
                if (get_config('installed')) {
                    throw $e;
                }
905 906
            }
        }
907 908 909 910 911 912 913 914
    }
    // these can have parts living inside artefact directories as well.
    else if ($plugintype == 'export' || $plugintype == 'import') {
        $bits = explode('/', $pluginname);
        if (count($bits) == 2) {
            $fullpath = get_config('docroot') . 'artefact/' . $bits[1] . '/' . $plugintype . '/' . $bits[0] . '/' . $filename;
        }
    }
915 916 917 918
    if (empty($fullpath)) {
        $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    }

Penny Leach's avatar
Penny Leach committed
919 920 921 922
    if (!$realpath = realpath($fullpath)) {
        if (!empty($nonfatal)) {
            return false;
        }
923
        throw new SystemException ("File $fullpath did not exist");
Penny Leach's avatar
Penny Leach committed
924 925 926 927 928 929
    }

    if (strpos($realpath, get_config('docroot') !== 0)) {
        if (!empty($nonfatal)) {
            return false;
        }
930
        throw new SystemException ("File $fullpath was outside document root!");
Penny Leach's avatar
Penny Leach committed
931 932 933 934 935 936 937 938 939
    }

    if ($function == 'require') { return require($realpath); }
    if ($function == 'include') { return include($realpath); }
    if ($function == 'require_once') { return require_once($realpath); }
    if ($function == 'include_once') { return include_once($realpath); }
    
}

940
/**
941 942 943 944
 * This function returns the list of plugintypes we currently care about.
 *
 * NOTE: use plugin_types_installed if you just want the installed ones.
 *
945 946 947 948 949
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
950
        // ORDER MATTERS! artefact has to be first!
951
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype', 'interaction', 'grouptype', 'import', 'export');
952 953 954 955
    }
    return $pluginstocheck;
}

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
/**
 * Returns plugin types that are actually installed
 */
function plugin_types_installed() {
    static $plugins = array();
    if (empty($plugins)) {
        require_once('ddl.php');
        foreach (plugin_types() as $plugin) {
            if (table_exists(new XMLDBTable("{$plugin}_installed"))) {
                $plugins[] = $plugin;
            }
        }
    }
    return $plugins;
}

972 973 974 975 976 977
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
978 979 980 981 982 983 984 985 986
function plugins_installed($plugintype, $all=false) {
    $sort = 'name';
    if ($plugintype == 'blocktype') {
        $sort = 'artefactplugin,name';
    }
    if ($all) {
        return get_records_array($plugintype . '_installed', '', '', $sort);
    }
    return get_records_array($plugintype . '_installed', 'active', 1, $sort);
987 988
}

989 990 991 992 993 994 995 996
/**
 * Helper to call a static method when you do not know the name of the class
 * you want to call the method on. PHP5 does not support $class::method().
 */
function call_static_method($class, $method) {
    $args = func_get_args();
    array_shift($args);
    array_shift($args);
997
    return call_user_func_array(array($class, $method), $args);
998 999
}

1000 1001
function generate_class_name() {
    $args = func_get_args();
1002
    if (count($args) == 2 && $args[0] == 'blocktype') {
1003
        return 'PluginBlocktype' . ucfirst(blocktype_namespaced_to_single($args[1]));
1004
    }
1005 1006 1007
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

1008 1009 1010 1011
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

1012 1013 1014 1015
function generate_interaction_instance_class_name($type) {
    return 'Interaction' . ucfirst($type) . 'Instance';
}

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
function blocktype_namespaced_to_single($blocktype) {
    if (strpos($blocktype, '/') === false) { // system blocktype
        return $blocktype;
    }
    return substr($blocktype, strpos($blocktype, '/') + 1 );
}

function blocktype_single_to_namespaced($blocktype, $artefact='') {
    if (empty($artefact)) {
        return $blocktype;
    }
    return $artefact . '/' . $blocktype;
1028 1029
}

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
/**
 * Given a blocktype name, convert it to the namespaced version.
 *
 * This will be $artefacttype/$blocktype, or just plain $blocktype for system 
 * blocktypes.
 *
 * This is useful for language strings
 */
function blocktype_name_to_namespaced($blocktype) {
    static $resultcache = array();

    if (!isset($resultcache[$blocktype])) {
        $artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $blocktype);
        if ($artefactplugin) {
            $resultcache[$blocktype] = "$artefactplugin/$blocktype";
        }
        else {
            $resultcache[$blocktype] = $blocktype;
        }
    }

    return $resultcache[$blocktype];
}

1054

1055 1056 1057 1058 1059
/**
 * Fires an event which can be handled by different parts of the system
 */
function handle_event($event, $data) {
    if (!$e = get_record('event_type', 'name', $event)) {
Martyn Smith's avatar
Martyn Smith committed
1060
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
1061
    }
1062

1063
    if ($data instanceof ArtefactType || $data instanceof BlockInstance) {
1064 1065 1066
        // leave it alone
    }
    else if (is_object($data)) {
1067 1068
        $data = (array)$data;
    }
1069
    else if (is_numeric($data)) {
1070 1071 1072
        $data = array('id' => $data);
    }

1073
    if ($coreevents = get_records_array('event_subscription', 'event', $event)) {
1074
        require_once('activity.php'); // core events can generate activity.
1075 1076 1077 1078 1079 1080 1081 1082 1083
        foreach ($coreevents as $ce) {
            if (function_exists($ce->callfunction)) {
                call_user_func($ce->callfunction, $data);
            }
            else {
                log_warn("Event $event caused a problem with a core subscription "
                . " $ce->callfunction, which wasn't callable.  Continuing with event handlers");
            }
        }
1084 1085
    }

1086
    $plugintypes = plugin_types_installed();
Penny Leach's avatar
Penny Leach committed
1087
    foreach ($plugintypes as $name) {
1088
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
1089
            foreach ($subs as $sub) {
1090
                safe_require($name, $sub->plugin);
Penny Leach's avatar
Penny Leach committed
1091 1092
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
1093
                    call_static_method($classname, $sub->callfunction, $event, $data);
Penny Leach's avatar
Penny Leach committed
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
/**
 * function to convert an array of objects to 
 * an array containing one field per place
 * 
 * @param array $array input array
 * @param mixed $field field to look for in each object
 */
function mixed_array_to_field_array($array, $field) {
    $repl_fun = create_function('$n, $field', '$n = (object)$n; return $n->{$field};');
    $fields = array_pad(array(), count($array), $field);
    return array_map($repl_fun, $array, $fields);
}


Penny Leach's avatar
Penny Leach committed
1118 1119
/** 
 * Adds stuff to the log
1120
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130