mahara.php 53.1 KB
Newer Older
1 2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3 4
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
 * Copyright (C) 2006-2007 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 21 22 23 24
 *
 * @package    mahara
 * @subpackage core
 * @author     Penny Leach <penny@catalyst.net.nz>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
 * @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 51 52 53 54 55 56 57 58
    switch (get_config('dbtype')) {
    case 'postgres8':
        if (!extension_loaded('pgsql')) {
            throw new ConfigSanityException(get_string('pgsqldbextensionnotloaded', 'error'));
        }
        break;
    case 'mysql5':
    case 'mysql': // NOTE: mysql to be phased out. This should be log_environ() in 1.0 and removed in 1.1
        if (!extension_loaded('mysql')) {
            throw new ConfigSanityException(get_string('mysqldbextensionnotloaded', 'error'));
        }
        break;
    default:
        throw new ConfigSanityException(get_string('unknowndbtype', 'error'));
59 60 61 62 63 64 65 66 67 68 69
    }
    if (!extension_loaded('libxml')) {
        throw new ConfigSanityException(get_string('libxmlextensionnotloaded', 'error'));
    }
    if (!extension_loaded('gd')) {
        throw new ConfigSanityException(get_string('gdextensionnotloaded', 'error'));
    }
    if (!extension_loaded('session')) {
        throw new ConfigSanityException(get_string('sessionextensionnotloaded', 'error'));
    }

70 71 72 73 74 75 76 77 78 79 80
    // Various optional extensions
    if (!extension_loaded('openssl')) {
        log_environ(get_string('opensslextensionnotloaded', 'error'));
    }
    if (!extension_loaded('curl')) {
        log_environ(get_string('curlextensionnotloaded', 'error'));
    }
    if (!extension_loaded('xmlrpc')) {
        log_environ(get_string('xmlrpcextensionnotloaded', 'error'));
    }

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

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

112
    if (ini_get_bool('magic_quotes_runtime')) {
113 114 115 116 117 118 119 120 121
        // 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'));
122 123
    }

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

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

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

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

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

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

170
function get_string($identifier, $section='mahara') {
171 172 173 174 175

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

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
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) {

    $location = get_config('docroot') ;
    $file = 'help/';

    if ($plugintype != 'core') {
        $location .= $plugintype . '/' . $pluginname . '/lang/';
    }
    else {
        $location .= 'lang/';
    }
    if ($page) {
        $page = str_replace('-', '/', $page);
204 205 206 207 208 209
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    }
    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
    $langfile = $location . $lang . '/' . $file;
    if (is_readable($langfile)) {
        return $langfile;
    }

    // if it's not found, try the parent language if there is one...
    if (empty($data) && empty($trieden)) {
241
        $langfile = get_config('docroot') . 'lang/' . $lang . '/langconfig.php';
242 243 244 245
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
246
            $langfile = get_config('docroot') . 'lang/' . $parentlang . '/' . $file;
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
            if (is_readable($langfile)) {
                return $langfile;
            }
        }
    }

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

263 264 265 266 267
// 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.
268 269
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
}


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

    $langconfigstrs = array('parentlanguage', 'strftimedate', 'strftimedateshort', 'strftimedatetime',
                            'strftimedaydate', 'strftimedaydatetime', 'strftimedayshort', 'strftimedaytime',
                            'strftimemonthyear', 'strftimerecent', 'strftimerecentfull', 'strftimetime',
Richard Mansfield's avatar
Richard Mansfield committed
289
                            'strfdaymonthyearshort', 'thislanguage');
290 291 292 293 294

    if (in_array($identifier, $langconfigstrs)) {
        $section = 'langconfig';
    }

295 296 297 298 299 300
    $lang = current_language();

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
301
    if (false === strpos($section, '.')) {
302 303 304 305
        $locations[] = $docroot . 'lang/';
    }
    else {
        $extras = plugin_types(); // more later..
306
        foreach ($extras as $tocheck) {
307
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
308
                $pluginname = substr($section ,strlen($tocheck) + 1);
309 310 311
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
312 313
                    $locations[] = $docroot . 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
                    $section = 'blocktype.' . $bits[1];
314 315 316 317
                }
                else {
                    $locations[] = $docroot . $tocheck . '/' . $pluginname . '/lang/';
                }
318 319 320
            }
        }
    }
321

322 323 324
    // First check all the normal locations for the string in the current language
    foreach ($locations as $location) {
        //if local directory not found, or particular string does not exist in local direcotry
325
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
326
        if (is_readable($langfile)) {
327
            if ($result = get_string_from_file($identifier, $langfile)) {
328
                return $replacefunc($result, $variables);
329 330 331 332 333 334 335
            }
        }
    }

    // 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') {
336
        return '[[' . $identifier . '/' . $section . ']]';
337 338 339 340
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
    foreach ($locations as $location) {
341
        $langfile = $location . $lang . '/langconfig.php';
Penny Leach's avatar
Penny Leach committed
342
        if (is_readable($langfile)) {
343
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
344
                $langfile = $location . $parentlang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
345
                if (is_readable($langfile)) {
346
                    if ($result = get_string_from_file($identifier, $langfile)) {
347
                        return $replacefunc($result, $variables);
348 349 350 351 352 353 354 355 356
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
357
        $langfile = $location . 'en.utf8/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
358
        if (is_readable($langfile)) {
359
            if ($result = get_string_from_file($identifier, $langfile)) {
360
                return $replacefunc($result, $variables);
361 362 363 364
            }
        }
    }

365
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
366
}
367 368


369 370 371 372 373 374 375 376
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
    $langbase = get_config('docroot') . 'lang/';
    if (!$langdir = opendir($langbase)) {
377
        throw new SystemException('Unable to read language directory '.$langbase);
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
    }
    while (false !== ($subdir = readdir($langdir))) {
        $langfile = $langbase . $subdir . '/langconfig.php';
        if ($subdir != "." && $subdir != ".." && is_readable($langfile)) {
            if ($langname = get_string_from_file('thislanguage',$langfile)) {
                $langs[$subdir] = $langname;
            }
        }
    }
    closedir($langdir);
    return $langs;
}

/**
 * Return a list of available themes
 * Need to add the theme names sometime; for now use get_string().
 *
 */
function get_themes() {
    $themes = array();
    $themebase = get_config('docroot') . 'theme/';
    if (!$themedir = opendir($themebase)) {
400
        throw new SystemException('Unable to read theme directory '.$themebase);
401 402
    }
    while (false !== ($subdir = readdir($themedir))) {
403
        if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
404 405
            $themes[$subdir] = $subdir;

406
            $config_path = $themebase . $subdir . '/config.php';
407 408 409 410 411 412
            if (is_readable($config_path)) {
                require_once($config_path);
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
413 414 415 416 417 418 419
        }
    }
    closedir($themedir);
    return $themes;
}


420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
/**
 * 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
 *
458
 * @param string $ini_get_arg setting to look for
459 460 461 462 463 464 465 466 467 468 469
 * @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;
}

470 471 472 473 474 475 476 477 478 479
/**
 * 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;
    
480
    $dbconfig = get_records_array('config', '', '', '', 'field, value');
481 482
    
    foreach ($dbconfig as $cfg) {
483
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
484
            // @todo warn that we're overriding db config with $CFG
485 486 487 488 489 490 491 492 493
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
494 495 496 497 498 499
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
500 501
function get_config($key) {
    global $CFG;
502
    if (isset($CFG->$key)) {
503 504 505 506 507
        return $CFG->$key;
    }
    return null;
}

508 509 510 511 512 513 514 515 516

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

519
    db_ignore_sql_exceptions(true);
520 521
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
522 523 524 525 526 527 528
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
529
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
530
    }
531
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
532 533

    if (!empty($status)) {
534 535 536
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
537

538 539 540 541 542 543 544 545 546 547 548 549 550 551
    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;
552

553 554
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
555
    if (isset($value)) {
556 557 558 559
        return $value;
    }

    $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
560
    if (!empty($records)) {
561 562
        foreach($records as $record) {
            $CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
563
            if ($record->field == $key) {
564 565 566
                $value = $record->value;
            }
        }
567 568
    }

569 570 571
    return $value;
}

Penny Leach's avatar
Penny Leach committed
572
function set_config_plugin($plugintype, $pluginname, $key, $value) {
573
    global $CFG;
574
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
575

576 577 578
    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
579 580 581 582 583 584 585 586
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
587
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
588 589 590 591 592 593 594 595
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

596 597 598 599 600 601 602 603 604 605
/**
 * 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
 */
606
function get_config_plugin_instance($plugintype, $pluginid, $key) {
607 608 609 610 611 612
    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
613
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
614
    if (isset($value)) {
615 616 617
        return $value;
    }

618
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
619
    if (!empty($records)) {
620
        foreach($records as $record) {
621
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
622
            if ($record->field == $key) {
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 654 655 656 657 658 659 660 661 662 663 664 665
                $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;
}

666
/**
667 668 669 670 671
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
672 673 674 675 676 677
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

678
/**
679 680 681 682 683 684
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
685 686
function current_language() {
    global $USER, $CFG;
687 688 689 690 691
    if ($USER instanceof User) {
        $lang = $USER->get_account_preference('lang');
        if ($lang !== null && $lang != 'default') {
            return $lang;
        }
692 693 694 695 696 697 698
    }
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

699
/**
700 701 702 703 704 705
 * 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
 */
706 707 708 709
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

710 711 712 713 714 715 716 717 718 719 720 721 722
/**
 * 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);
}

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
/**
 * 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 {
            umask(0000); 
741
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
742
            // @todo has the umask been clobbered at this point, and is this a bad thing?
743 744 745 746 747
        }
    }
    return $status;
}

Penny Leach's avatar
Penny Leach committed
748 749 750
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
751
 *
Penny Leach's avatar
Penny Leach committed
752 753
 * This function is the one safe point to require plugin files.
 * so USE it :)
754
 *
Penny Leach's avatar
Penny Leach committed
755 756 757 758 759 760
 * @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
 */
761
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
762 763 764 765
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
766 767
    require_once(get_config('docroot') . $plugintype . '/lib.php');

768
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
769 770 771 772 773 774
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ('invalid require type');
    }

775 776 777 778 779
    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;
        }
780
        else {
781
            if (table_exists(new XMLDBTable('blocktype_installed'))) {
782 783 784 785 786
                if ($artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $pluginname)) {
                    $fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
                }
            }
        }
787 788 789 790 791
    } 
    if (empty($fullpath)) {
        $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    }

Penny Leach's avatar
Penny Leach committed
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
    if (!$realpath = realpath($fullpath)) {
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ("File $fullpath did not exist");
    }

    if (strpos($realpath, get_config('docroot') !== 0)) {
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ("File $fullpath was outside document root!");
    }

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

813 814 815 816 817 818 819
/**
 * This function returns the list of plugintypes we currently care about
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
820
        // ORDER MATTERS! artefact has to be first!
821
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype', 'interaction');
822 823 824 825
    }
    return $pluginstocheck;
}

826 827 828 829 830 831 832
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
833
    return get_records_array($plugintype . '_installed');
834 835
}

836 837 838 839 840 841 842 843
/**
 * 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);
844
    return call_user_func_array(array($class, $method), $args);
845 846
}

847 848
function generate_class_name() {
    $args = func_get_args();
849
    if (count($args) == 2 && $args[0] == 'blocktype') {
850
        return 'PluginBlocktype' . ucfirst(blocktype_namespaced_to_single($args[1]));
851
    }
852 853 854
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

855 856 857 858
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

859 860 861 862
function generate_interaction_instance_class_name($type) {
    return 'Interaction' . ucfirst($type) . 'Instance';
}

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

877

878 879 880 881 882
/**
 * 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
883
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
884
    }
885

886
    if ($data instanceof ArtefactType || $data instanceof BlockInstance) {
887 888 889
        // leave it alone
    }
    else if (is_object($data)) {
890 891
        $data = (array)$data;
    }
892
    else if (is_numeric($data)) {
893 894 895
        $data = array('id' => $data);
    }

896 897 898
    // this is here because the core can't listen to events
    // @todo, this is VERY ugly, and someone should fix it
    if ($event == 'createuser') {
899
        activity_set_defaults($data['id']);
900 901
    }

Penny Leach's avatar
Penny Leach committed
902 903
    $plugintypes = plugin_types();
    foreach ($plugintypes as $name) {
904
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
905
            foreach ($subs as $sub) {
906
                safe_require($name, $sub->plugin);
Penny Leach's avatar
Penny Leach committed
907 908
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
909
                    call_static_method($classname, $sub->callfunction, $event, $data);
Penny Leach's avatar
Penny Leach committed
910 911 912 913 914 915 916 917 918 919
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

920 921 922 923 924 925 926 927 928 929 930 931 932 933
/**
 * 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
934 935
/** 
 * Adds stuff to the log
936
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
937 938 939 940 941 942 943 944 945 946 947 948
 *
 * @param string $plugintype plugin type or core
 * @param string $pluginname plugin name or core component (eg 'view')
 * @param string $action action string (like 'add')
 * @param int $user id of user making the action
 * @param int $id relevant id (ie, profile view would have id of profile owner)
 * 
 */
function add_to_log($plugintype, $pluginname, $action, $user, $id=0) {

}

949 950 951 952
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
953
    log_debug($message);
954 955 956 957 958 959
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

960 961 962
/** 
 * Base class for all plugintypes.
 */
963
class Plugin {
964
    
965 966
    /**
     * This function returns an array of crons it wants to have run
967
     * Each item should be a StdClass object containing - 
968 969 970 971
     * - callfunction (static function on the Plugin Class)
     * - any or all of minute, hour, day, month, dayofweek 
     * (will default to * if not supplied)
     */
972 973 974 975
    public static function get_cron() {
        return array();
    }

976 977 978 979 980 981 982
    /** 
     * This function returns an array of events to subscribe to
     * by unique name. 
     * If an event the plugin is trying to subscribe to is unknown by the
     * core, an exception will be thrown.
     * @return array
     */
983 984 985 986
    public static function get_event_subscriptions() {
        return array();
    }

987 988 989 990 991 992 993

    /**
     * This function will be run after every upgrade to the plugin.
     * 
     * @param int $fromversion version upgrading from (or 0 if installing)
     */
    public static function postinst($fromversion) {
994 995
        return true;
    }
996

997 998 999 1000 1001
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
1002 1003 1004
    public static function has_config() {
        return false;
    }
1005 1006 1007 1008 1009 1010 1011 1012 1013

    /**
    * Does this plugin offer any activity types
    * If it does, you must subclass ActivityTypePlugin like 
    * ActivityType{$PluginType}{$Pluginname}
    */
    public static function get_activity_types() {
        return array();
    }
1014 1015
}

1016 1017 1018 1019 1020
/**
 * formats a unix timestamp to a nice date format.
 * 
 * @param int $date unix timestamp to format
 * @param string $formatkey language key to fetch the format from
1021 1022
 * @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
 * @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
1023 1024 1025 1026
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

1027
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
1028
    if (empty($date)) {
1029
        return get_string($notspecifiedkey, $notspecifiedsection);
1030
    }
1031 1032 1033
    return strftime(get_string($formatkey), $date);
}

1034 1035 1036
/**
 * Returns a random string suitable for registration/change password requests
 *
1037
 * @param int $length The length of the key to return
1038 1039
 * @return string
 */
1040 1041 1042 1043
function get_random_key($length=16) {
    if ($length < 1) {
        throw new IllegalArgumentException('Length must be a positive number');
    }
1044 1045 1046 1047 1048 1049 1050
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
1051
    for ($i = 0; $i < $length; $i++) {
1052 1053 1054 1055 1056
        $result .= $pool[$i];
    }
    return $result;
}

1057

1058 1059 1060 1061
//
// Pieform related functions
//

1062 1063 1064
/**
 * Configures a default form
 */
1065
function pieform_configure() {
1066
    global $USER;
1067
    return array(
1068 1069
        'method'    => 'post',
        'action'    => '',
1070
        'language'  => current_language(),
1071
        'autofocus' => true,
1072
        'renderer'  => 'maharatable',
1073
        'requiredmarker' => true,
Nigel McNie's avatar
Nigel McNie committed
1074
        'elementclasses' => true,
1075 1076 1077 1078 1079 1080
        'jserrorcallback'       => 'formError',
        'globaljserrorcallback' => 'formGlobalError',
        'jssuccesscallback'     => 'formSuccess',
        'presubmitcallback'     => 'formStartProcessing',
        'postsubmitcallback'    => 'formStopProcessing',
        'jserrormessage' => get_string('errorprocessingform'),
1081
        'configdirs' => get_config('libroot') . 'form/',
1082
        'helpcallback' => 'pieform_get_help',
1083
        'elements'   => array(
1084
            'sesskey' => array(
1085
                'type'  => 'hidden',
1086
                'value' => $USER->get('sesskey')
1087 1088 1089 1090 1091
            )
        )
    );
}

1092 1093 1094 1095 1096
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
1097
    if ($USER && $USER->is_logged_in() && $USER->get('sesskey') != $values['sesskey']) {
1098 1099 1100 1101 1102
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
1103 1104
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
1105
            FROM {usr}
1106 1107 1108 1109
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
1110 1111 1112
    }
}

1113
function pieform_element_calendar_configure($element) {
1114
    $element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
1115
    $element['themefile'] = theme_get_url('style/calendar.css');
1116
    $element['imagefile'] = theme_get_url('images/calendar.gif');
1117
    $language = substr(current_language(), 0, 2);
1118
    $element['language'] = $language;
1119 1120 1121
    return $element;
}