mahara.php 50 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 45 46 47 48 49 50 51 52 53 54 55 56 57
    // 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'));
    }
    if (!extension_loaded('pgsql') && !extension_loaded('mysqli')) {
        throw new ConfigSanityException(get_string('dbextensionnotloaded', 'error'));
    }
    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'));
    }

58 59 60 61 62 63 64 65 66 67 68
    // 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'));
    }

69 70
    // register globals workaround
    if (ini_get_bool('register_globals')) {
71
        log_environ(get_string('registerglobals', 'error'));
72
        $massivearray = array_keys(array_merge($_POST, $_GET, $_COOKIE, $_SERVER, $_REQUEST, $_FILES));
73 74 75 76 77 78 79
        foreach ($massivearray as $tounset) {
            unset($GLOBALS[$tounset]);
        }
    }

    // magic_quotes_gpc workaround
    if (ini_get_bool('magic_quotes_gpc')) {
80
        log_environ(get_string('magicquotesgpc', 'error'));
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
        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]);
            }
        }
    }

100
    if (ini_get_bool('magic_quotes_runtime')) {
101 102 103 104 105 106 107 108 109
        // Turn of magic_quotes_runtime. Anyone with this on deserves a slap in the face
        set_magic_quotes_runtime(0);
        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'));
110 111
    }

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

117 118 119 120 121 122 123
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

124
    // dataroot inside document root.
125 126
    if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
        throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
127 128
    }

129 130
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
131
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
132
    }
133

134 135 136
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
137 138
        !check_dir_exists(get_config('dataroot') . 'templates') ||
        !check_dir_exists(get_config('dataroot') . 'sessions')) {
139 140
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
141 142
}

143 144 145 146 147
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
148
    if (get_config('installed')) {
149 150 151 152 153 154 155 156
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

157
function get_string($identifier, $section='mahara') {
158 159 160 161 162

    $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.
163 164
    }
    else {
165 166 167
        $variables = array();
    }
    
168 169 170
    return get_string_location($identifier, $section, $variables);
}

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
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);
191 192 193 194 195 196
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
197 198 199 200 201 202 203 204 205 206 207 208 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 240 241 242 243 244 245 246 247 248 249
    }
    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)) {
        $langfile = $location . $lang . '/langconfig.php';
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
            $langfile = $location . $parentlang . '/' . $file;
            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;
}

250 251 252 253 254
// 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.
255 256
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
}


/**
 * 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
276
                            'strfdaymonthyearshort', 'thislanguage');
277 278 279 280 281

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

282 283 284 285 286 287
    $lang = current_language();

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
288
    if (false === strpos($section, '.')) {
289 290 291 292
        $locations[] = $docroot . 'lang/';
    }
    else {
        $extras = plugin_types(); // more later..
293
        foreach ($extras as $tocheck) {
294
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
295
                $pluginname = substr($section ,strlen($tocheck) + 1);
296 297 298 299 300 301 302 303
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
                    $locations[] = $docroot . 'artefact/ ' . $bits[0] . '/blocktype/' . $bits[1] . '/' . 'lang/';
                }
                else {
                    $locations[] = $docroot . $tocheck . '/' . $pluginname . '/lang/';
                }
304 305 306
            }
        }
    }
307

308 309 310
    // 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
311
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
312
        if (is_readable($langfile)) {
313
            if ($result = get_string_from_file($identifier, $langfile)) {
314
                return $replacefunc($result, $variables);
315 316 317 318 319 320 321
            }
        }
    }

    // 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') {
322
        return '[[' . $identifier . '/' . $section . ']]';
323 324 325 326
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
    foreach ($locations as $location) {
327
        $langfile = $location . $lang . '/langconfig.php';
Penny Leach's avatar
Penny Leach committed
328
        if (is_readable($langfile)) {
329
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
330
                $langfile = $location . $parentlang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
331
                if (is_readable($langfile)) {
332
                    if ($result = get_string_from_file($identifier, $langfile)) {
333
                        return $replacefunc($result, $variables);
334 335 336 337 338 339 340 341 342
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
343
        $langfile = $location . 'en.utf8/' . $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
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
352
}
353 354


355 356 357 358 359 360 361 362
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
    $langbase = get_config('docroot') . 'lang/';
    if (!$langdir = opendir($langbase)) {
363
        throw new SystemException('Unable to read language directory '.$langbase);
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
    }
    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)) {
386
        throw new SystemException('Unable to read theme directory '.$themebase);
387 388
    }
    while (false !== ($subdir = readdir($themedir))) {
389
        if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
390 391
            $themes[$subdir] = $subdir;

392
            $config_path = $themebase . $subdir . '/config.php';
393 394 395 396 397 398
            if (is_readable($config_path)) {
                require_once($config_path);
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
399 400 401 402 403 404 405
        }
    }
    closedir($themedir);
    return $themes;
}


406 407 408 409 410 411 412 413 414 415 416 417 418 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
/**
 * 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
 *
444
 * @param string $ini_get_arg setting to look for
445 446 447 448 449 450 451 452 453 454 455
 * @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;
}

456 457 458 459 460 461 462 463 464 465 466
/**
 * 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;
    
    try {
467
        $dbconfig = get_records_array('config', '', '', '', 'field, value');
468
    } 
469
    catch (SQLException $e) {
470 471 472
        // TODO: better reporting if config could not be obtained? This 
        // normally happens when the system isn't installed
        log_info($e->getMessage());
473 474 475 476
        return false;
    }
    
    foreach ($dbconfig as $cfg) {
477
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
478
            // @todo warn that we're overriding db config with $CFG
479 480 481 482 483 484 485 486 487
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

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

502 503 504 505 506 507 508 509 510

/**
 * 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) {
511 512 513 514
    global $CFG;

    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
515 516 517 518 519 520 521
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
522
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
523 524 525
    }

    if (!empty($status)) {
526 527 528
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
529

530 531 532 533 534 535 536 537 538 539 540 541 542 543
    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;
544

545 546
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
547
    if (isset($value)) {
548 549 550 551
        return $value;
    }

    $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
552
    if (!empty($records)) {
553 554
        foreach($records as $record) {
            $CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
555
            if ($record->field == $key) {
556 557 558
                $value = $record->value;
            }
        }
559 560
    }

561 562 563
    return $value;
}

Penny Leach's avatar
Penny Leach committed
564
function set_config_plugin($plugintype, $pluginname, $key, $value) {
565
    global $CFG;
566
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
567

568 569 570
    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
571 572 573 574 575 576 577 578
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
579
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
580 581 582 583 584 585 586 587
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

588 589 590 591 592 593 594 595 596 597
/**
 * 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
 */
598
function get_config_plugin_instance($plugintype, $pluginid, $key) {
599 600 601 602 603 604
    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
605
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
606
    if (isset($value)) {
607 608 609
        return $value;
    }

610
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
611
    if (!empty($records)) {
612
        foreach($records as $record) {
613
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
614
            if ($record->field == $key) {
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
                $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;
}

658
/**
659 660 661 662 663
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
664 665 666 667 668 669
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

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

691
/**
692 693 694 695 696 697
 * 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
 */
698 699 700 701
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

702 703 704 705 706 707 708 709 710 711 712 713 714
/**
 * 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);
}

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

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

760
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
761 762 763 764 765 766
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ('invalid require type');
    }

767 768 769 770 771
    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;
        }
772 773 774 775 776 777 778
        else {
            if (get_config('installed')) {
                if ($artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $pluginname)) {
                    $fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
                }
            }
        }
779 780 781 782 783
    } 
    if (empty($fullpath)) {
        $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    }

Penny Leach's avatar
Penny Leach committed
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
    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); }
    
}

805 806 807 808 809 810 811
/**
 * This function returns the list of plugintypes we currently care about
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
812
        // ORDER MATTERS! artefact has to be first!
813
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype');
814 815 816 817
    }
    return $pluginstocheck;
}

818 819 820 821 822 823 824
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
825
    return get_records_array($plugintype . '_installed');
826 827
}

828 829 830 831 832 833 834 835
/**
 * 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);
836
    return call_user_func_array(array($class, $method), $args);
837 838
}

839 840
function generate_class_name() {
    $args = func_get_args();
841 842 843
    if (count($args) == 2 && $args[0] == 'blocktype') {
        return 'PluginBlockType' . ucfirst(blocktype_namespaced_to_single($args[1]));
    }
844 845 846
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

847 848 849 850
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

851 852 853 854 855 856 857 858 859 860 861 862
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;
863 864
}

865

866 867 868 869 870
/**
 * 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
871
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
872
    }
873

874 875 876 877
    if ($data instanceof ArtefactType) {
        // leave it alone
    }
    else if (is_object($data)) {
878 879
        $data = (array)$data;
    }
880
    else if (is_numeric($data)) {
881 882 883
        $data = array('id' => $data);
    }

884 885 886
    // this is here because the core can't listen to events
    // @todo, this is VERY ugly, and someone should fix it
    if ($event == 'createuser') {
887
        activity_set_defaults($data['id']);
888 889
    }

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

908 909 910 911 912 913 914 915 916 917 918 919 920 921
/**
 * 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
922 923
/** 
 * Adds stuff to the log
924
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
925 926 927 928 929 930 931 932 933 934 935 936
 *
 * @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) {

}

937 938 939 940
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
941
    log_debug($message);
942 943 944 945 946 947
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

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

964 965 966 967 968 969 970
    /** 
     * 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
     */
971 972 973 974
    public static function get_event_subscriptions() {
        return array();
    }

975 976 977 978 979 980 981

    /**
     * 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) {
982 983
        return true;
    }
984

985 986 987 988 989
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
990 991 992
    public static function has_config() {
        return false;
    }
993 994
}

995 996 997 998 999
/**
 * 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
1000 1001
 * @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
 * @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
1002 1003 1004 1005
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

1006
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
1007
    if (empty($date)) {
1008
        return get_string($notspecifiedkey, $notspecifiedsection);
1009
    }
1010 1011 1012
    return strftime(get_string($formatkey), $date);
}

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

1036

1037 1038 1039 1040
//
// Pieform related functions
//

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

1071 1072 1073 1074 1075
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
1076
    if ($USER && $USER->is_logged_in() && $USER->get('sesskey') != $values['sesskey']) {
1077 1078 1079 1080 1081
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
1082 1083
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
1084
            FROM {usr}
1085 1086 1087 1088
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
1089 1090 1091
    }
}

1092
function pieform_element_calendar_configure($element) {
1093
    $element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
1094
    $element['themefile'] = theme_get_url('style/calendar.css');
1095
    $element['imagefile'] = theme_get_url('images/calendar.gif');
1096
    $language = substr(current_language(), 0, 2);
1097
    $element['language'] = $language;
1098 1099 1100
    return $element;
}

1101
function pieform_element_textarea_configure($element) {
1102 1103 1104
    if (!array_key_exists('resizable', $element)) {
        $element['resizable'] = true;
    }
1105 1106 1107
    return $element;
}

1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
/**
 * 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
1118
function can_view_view($view_id, $user_id=null) {
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
    global $USER;
    $now = time();
    $dbnow = db_format_timestamp($now);

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

    $view_data = get_records_sql_array('
        SELECT
            v.title,
            v.owner,
            ' . db_format_tsfield('v.startdate','startdate') . ',
            ' . db_format_tsfield('v.stopdate','stopdate') . ',
            a.accesstype,
1134
            v.submittedto,
1135 1136 1137
            ' . db_format_tsfield('a.startdate','access_startdate') . ',
            ' . db_format_tsfield('a.stopdate','access_stopdate') . '
        FROM
1138 1139
            {view} v
            LEFT OUTER JOIN {view_access} a ON v.id=a.view
1140 1141 1142 1143 1144 1145 1146 1147 1148
        WHERE v.id=?
    ', array($view_id));

    if(!$view_data) {
        throw new ViewNotFoundException("View id=$view_id doesn't exist");
    }

    $view_record = array( 'access' => array() );

1149
    //log_debug('Can you look at this view? (you are user ' . $user_id . ' trying to look at view ' . $view_id . ')');
1150 1151 1152 1153 1154 1155

    foreach ( $view_data as $row ) {
        $view_record['title'] = $row->title;
        $view_record['owner'] = $row->owner;
        $view_record['startdate'] = $row->startdate;
        $view_record['stopdate'] = $row->stopdate;
1156
        $view_record['submittedto'] = $row->submittedto;
1157 1158 1159 1160 1161 1162 1163 1164