mahara.php 51 KB
Newer Older
1 2
<?php
/**
Nigel McNie's avatar
Nigel McNie committed
3
 * This program is part of Mahara
4
 *
5 6 7 8
 *  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 2 of the License, or
 *  (at your option) any later version.
9
 *
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * @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 37 38 39 40 41 42 43 44
    // PHP version
    if (version_compare(phpversion(), '5.1.0') < 0) {
        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 150
        !check_dir_exists(get_config('dataroot') . 'templates') ||
        !check_dir_exists(get_config('dataroot') . 'sessions')) {
151 152
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
153 154
}

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

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

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

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
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);
203 204 205 206 207 208
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
209 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
    }
    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)) {
240
        $langfile = get_config('docroot') . 'lang/' . $lang . '/langconfig.php';
241 242 243 244
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
245
            $langfile = get_config('docroot') . 'lang/' . $parentlang . '/' . $file;
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
            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;
}

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


/**
 * 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
288
                            'strfdaymonthyearshort', 'thislanguage');
289 290 291 292 293

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

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

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

321 322 323
    // 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
324
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
325
        if (is_readable($langfile)) {
326
            if ($result = get_string_from_file($identifier, $langfile)) {
327
                return $replacefunc($result, $variables);
328 329 330 331 332 333 334
            }
        }
    }

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

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

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

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


368 369 370 371 372 373 374 375
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
    $langbase = get_config('docroot') . 'lang/';
    if (!$langdir = opendir($langbase)) {
376
        throw new SystemException('Unable to read language directory '.$langbase);
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    }
    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)) {
399
        throw new SystemException('Unable to read theme directory '.$themebase);
400 401
    }
    while (false !== ($subdir = readdir($themedir))) {
402
        if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
403 404
            $themes[$subdir] = $subdir;

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


419 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
/**
 * 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
 *
457
 * @param string $ini_get_arg setting to look for
458 459 460 461 462 463 464 465 466 467 468
 * @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;
}

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

    return true;
}

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

507 508 509 510 511 512 513 514 515

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

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

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

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

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

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

568 569 570
    return $value;
}

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

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

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

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

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

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

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

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

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

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

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

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

Penny Leach's avatar
Penny Leach committed
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
    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); }
    
}

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

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

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

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

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

858 859 860 861 862 863 864 865 866 867 868 869
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;
870 871
}

872

873 874 875 876 877
/**
 * 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
878
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
879
    }
880

881
    if ($data instanceof ArtefactType || $data instanceof BlockInstance) {
882 883 884
        // leave it alone
    }
    else if (is_object($data)) {
885 886
        $data = (array)$data;
    }
887
    else if (is_numeric($data)) {
888 889 890
        $data = array('id' => $data);
    }

891 892 893
    // this is here because the core can't listen to events
    // @todo, this is VERY ugly, and someone should fix it
    if ($event == 'createuser') {
894
        activity_set_defaults($data['id']);
895 896
    }

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

915 916 917 918 919 920 921 922 923 924 925 926 927 928
/**
 * 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
929 930
/** 
 * Adds stuff to the log
931
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
932 933 934 935 936 937 938 939 940 941 942 943
 *
 * @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) {

}

944 945 946 947
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
948
    log_debug($message);
949 950 951 952 953 954
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

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

971 972 973 974 975 976 977
    /** 
     * 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
     */
978 979 980 981
    public static function get_event_subscriptions() {
        return array();
    }

982 983 984 985 986 987 988

    /**
     * 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) {
989 990
        return true;
    }
991

992 993 994 995 996
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
997 998 999
    public static function has_config() {
        return false;
    }
1000 1001
}

1002 1003 1004 1005 1006
/**
 * 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
1007 1008
 * @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
 * @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
1009 1010 1011 1012
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

1013
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
1014
    if (empty($date)) {
1015
        return get_string($notspecifiedkey, $notspecifiedsection);
1016
    }
1017 1018 1019
    return strftime(get_string($formatkey), $date);
}

1020 1021 1022
/**
 * Returns a random string suitable for registration/change password requests
 *
1023
 * @param int $length The length of the key to return
1024 1025
 * @return string
 */
1026 1027 1028 1029
function get_random_key($length=16) {
    if ($length < 1) {
        throw new IllegalArgumentException('Length must be a positive number');
    }
1030 1031 1032 1033 1034 1035 1036
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
1037
    for ($i = 0; $i < $length; $i++) {
1038 1039 1040 1041 1042
        $result .= $pool[$i];
    }
    return $result;
}

1043

1044 1045 1046 1047
//
// Pieform related functions
//

1048 1049 1050
/**
 * Configures a default form
 */
1051
function pieform_configure() {
1052
    global $USER;
1053
    return array(
1054 1055
        'method'    => 'post',
        'action'    => '',
1056
        'language'  => current_language(),
1057
        'autofocus' => true,
1058
        'renderer'  => 'maharatable',
1059
        'requiredmarker' => true,
Nigel McNie's avatar
Nigel McNie committed
1060
        'elementclasses' => true,
1061 1062 1063 1064 1065 1066
        'jserrorcallback'       => 'formError',
        'globaljserrorcallback' => 'formGlobalError',
        'jssuccesscallback'     => 'formSuccess',
        'presubmitcallback'     => 'formStartProcessing',
        'postsubmitcallback'    => 'formStopProcessing',
        'jserrormessage' => get_string('errorprocessingform'),
1067
        'configdirs' => get_config('libroot') . 'form/',
1068
        'helpcallback' => 'pieform_get_help',
1069
        'elements'   => array(
1070
            'sesskey' => array(
1071
                'type'  => 'hidden',
1072
                'value' => $USER->get('sesskey')
1073 1074 1075 1076 1077
            )
        )
    );
}

1078 1079 1080 1081 1082
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
1083
    if ($USER && $USER->is_logged_in() && $USER->get('sesskey') != $values['sesskey']) {
1084 1085 1086 1087 1088
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
1089 1090
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
1091
            FROM {usr}
1092 1093 1094 1095
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
1096 1097 1098
    }
}

1099
function pieform_element_calendar_configure($element) {
1100
    $element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
1101
    $element['themefile'] = theme_get_url('style/calendar.css');
1102
    $element['imagefile'] = theme_get_url('images/calendar.gif');
1103
    $language = substr(current_language(), 0, 2);
1104
    $element['language'] = $language;
1105 1106 1107
    return $element;
}

1108
function pieform_element_textarea_configure($element) {
1109 1110 1111
    if (!array_key_exists('resizable', $element)) {
        $element['resizable'] = true;
    }
1112 1113 1114
    return $element;
}

1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
/**
 * Given a view id, and a user id (defaults to currently logged in user if not
 * specified) will return wether this user is allowed to look at this view.
 *
 * @param integer $view_id      View ID to check
 * @param integer $user_id      User trying to look at the view (defaults to
 * currently logged in user, or null if user isn't logged in)
 *
 * @returns boolean Wether the specified user can look at the specified view.
 */
Martyn Smith's avatar
Martyn Smith committed
1125
function can_view_view($view_id, $user_id=null) {
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
    global $USER;
    $now = time();
    $dbnow = db_format_timestamp($now);

    if ($user_id === null) {
        $user_id = $USER->get('id');
    }

    $view_data = g