mahara.php 45 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
    // register globals workaround
    if (ini_get_bool('register_globals')) {
60
        log_environ(get_string('registerglobals', 'error'));
61
        $massivearray = array_keys(array_merge($_POST, $_GET, $_COOKIE, $_SERVER, $_REQUEST, $_FILES));
62 63 64 65 66 67 68
        foreach ($massivearray as $tounset) {
            unset($GLOBALS[$tounset]);
        }
    }

    // magic_quotes_gpc workaround
    if (ini_get_bool('magic_quotes_gpc')) {
69
        log_environ(get_string('magicquotesgpc', 'error'));
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
        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]);
            }
        }
    }

89
    if (ini_get_bool('magic_quotes_runtime')) {
90 91 92 93 94 95 96 97 98
        // 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'));
99 100
    }

101 102 103
    if (ini_get_bool('safe_mode')) {
        // We don't run with safe mode
        throw new ConfigSanityException(get_string('safemodeon', 'error'));
104 105
    }

106 107 108 109 110 111 112
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

113
    // dataroot inside document root.
114 115
    if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
        throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
116 117
    }

118 119
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
120
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
121
    }
122

123 124 125
    if (
        !check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
        !check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
126 127
        !check_dir_exists(get_config('dataroot') . 'templates') ||
        !check_dir_exists(get_config('dataroot') . 'sessions')) {
128 129
        throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
    }
130 131
}

132 133 134 135 136
/**
 * Check to see if the internal plugins are installed. Die if they are not.
 */
function ensure_internal_plugins_exist() {
    // Internal things installed
137
    if (get_config('installed')) {
138 139 140 141 142 143 144 145
        foreach (plugin_types() as $type) {
            if (!record_exists($type . '_installed', 'name', 'internal')) {
                throw new ConfigSanityException(get_string($type . 'notinstalled'));
            }
        }
    }
}

146
function get_string($identifier, $section='mahara') {
147 148 149 150 151

    $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.
152 153
    }
    else {
154 155 156
        $variables = array();
    }
    
157 158 159
    return get_string_location($identifier, $section, $variables);
}

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 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
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);
        $file .= 'pages/' . $page . '.html';
    }
    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;
    log_debug($langfile);
    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;
}

235 236 237 238 239
// 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.
240 241
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
}


/**
 * 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
261
                            'strfdaymonthyearshort', 'thislanguage');
262 263 264 265 266

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

267 268 269 270 271 272
    $lang = current_language();

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
273
    if (false === strpos($section, '.')) {
274 275 276 277
        $locations[] = $docroot . 'lang/';
    }
    else {
        $extras = plugin_types(); // more later..
278
        foreach ($extras as $tocheck) {
279
            if (strpos($section,$tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
280
                $pluginname = substr($section ,strlen($tocheck) + 1);
281
                $locations[] = $docroot . $tocheck . '/' . $pluginname . '/lang/';
282 283 284
            }
        }
    }
285

286 287 288
    // 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
289
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
290
        if (is_readable($langfile)) {
291
            if ($result = get_string_from_file($identifier, $langfile)) {
292
                return $replacefunc($result, $variables);
293 294 295 296 297 298 299
            }
        }
    }

    // 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') {
300
        return '[[' . $identifier . '/' . $section . ']]';
301 302 303 304
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
    foreach ($locations as $location) {
305
        $langfile = $location . $lang . '/langconfig.php';
Penny Leach's avatar
Penny Leach committed
306
        if (is_readable($langfile)) {
307
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
308
                $langfile = $location . $parentlang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
309
                if (is_readable($langfile)) {
310
                    if ($result = get_string_from_file($identifier, $langfile)) {
311
                        return $replacefunc($result, $variables);
312 313 314 315 316 317 318 319 320
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
321
        $langfile = $location . 'en.utf8/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
322
        if (is_readable($langfile)) {
323
            if ($result = get_string_from_file($identifier, $langfile)) {
324
                return $replacefunc($result, $variables);
325 326 327 328
            }
        }
    }

329
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
330
}
331 332


333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
    $langbase = get_config('docroot') . 'lang/';
    if (!$langdir = opendir($langbase)) {
        throw new Exception('Unable to read language directory '.$langbase);
    }
    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)) {
        throw new Exception('Unable to read theme directory '.$themebase);
    }
    while (false !== ($subdir = readdir($themedir))) {
        if ($subdir != "." && $subdir != "..") {
368 369 370 371 372 373 374 375 376
            $themes[$subdir] = $subdir;

            $config_path = get_config('docroot') . 'theme/' . $subdir . '/config.php';
            if (is_readable($config_path)) {
                require_once($config_path);
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
377 378 379 380 381 382 383
        }
    }
    closedir($themedir);
    return $themes;
}


384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
/**
 * 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
 *
422
 * @param string $ini_get_arg setting to look for
423 424 425 426 427 428 429 430 431 432 433
 * @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;
}

434 435 436 437 438 439 440 441 442 443 444
/**
 * 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 {
445
        $dbconfig = get_records_array('config');
446
    } 
447
    catch (SQLException $e) {
448 449 450 451
        return false;
    }
    
    foreach ($dbconfig as $cfg) {
452
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
453
            // @todo warn that we're overriding db config with $CFG
454 455 456 457 458 459 460 461 462
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
463 464 465 466 467 468
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
469 470 471 472 473 474 475 476
function get_config($key) {
    global $CFG;
    if (array_key_exists($key,$CFG)) {
        return $CFG->$key;
    }
    return null;
}

477 478 479 480 481 482 483 484 485

/**
 * 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) {
486 487 488 489
    global $CFG;

    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
490 491 492 493 494 495 496
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
497
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
498 499 500
    }

    if (!empty($status)) {
501 502 503
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
504

505 506 507 508 509 510 511 512 513 514 515 516 517 518
    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;
519

520 521 522 523 524 525 526
    if (array_key_exists('plugin',$CFG)
        && array_key_exists($plugintype,$CFG->plugin)
        && array_key_exists($pluginname,$CFG->plugin->{$plugintype})
        && array_key_exists($key,$CFG->plugin->{$plugintype}->{$pluginname})) {
        return  $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
    }
    
527 528 529
    // @todo: an optimisation might be to get all fields related to the plugin instead, as
    // it may be quite likely that if one config item is requested for a plugin another
    // might be.
530
    if (!$value = get_field($plugintype . '_config', 'value', 'plugin', $pluginname, 'field', $key)) {
531
        $value = null;
532 533
    }

534 535 536 537
    $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
    return $value;
}

Penny Leach's avatar
Penny Leach committed
538
function set_config_plugin($plugintype, $pluginname, $key, $value) {
539
    global $CFG;
540
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
541

542 543 544
    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
545 546 547 548 549 550 551 552
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
553
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
554 555 556 557 558 559 560 561
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

562
/**
563 564 565 566 567
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
568 569 570 571 572 573
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

574
/**
575 576 577 578 579 580
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
581 582
function current_language() {
    global $USER, $CFG;
583
    if ($USER instanceof User && null !== ($lang = $USER->get_account_preference('lang'))) {
584
        return $lang;
585 586 587 588 589 590 591
    }
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

592
/**
593 594 595 596 597 598
 * 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
 */
599 600 601 602
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

603 604 605 606 607 608 609 610 611 612 613 614 615
/**
 * 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);
}

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
/**
 * 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); 
634
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
635
            // @todo has the umask been clobbered at this point, and is this a bad thing?
636 637 638 639 640
        }
    }
    return $status;
}

Penny Leach's avatar
Penny Leach committed
641 642 643
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
644
 *
Penny Leach's avatar
Penny Leach committed
645 646
 * This function is the one safe point to require plugin files.
 * so USE it :)
647
 *
Penny Leach's avatar
Penny Leach committed
648 649 650 651 652 653
 * @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
 */
654
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
655 656 657 658
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
659 660
    require_once(get_config('docroot') . $plugintype . '/lib.php');

661
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ('invalid require type');
    }

    $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    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); }
    
}

690 691 692 693 694 695 696
/**
 * This function returns the list of plugintypes we currently care about
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
697
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search');
698 699 700 701
    }
    return $pluginstocheck;
}

702 703 704 705 706 707 708
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
709
    return get_records_array($plugintype . '_installed');
710 711
}

712 713 714 715 716 717 718 719 720 721 722
/**
 * 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);
    return call_user_func_array(array($class, $method), $args);
}

723 724 725 726 727
function generate_class_name() {
    $args = func_get_args();
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

728 729 730 731
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

732 733 734 735 736
/**
 * 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
737
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
738
    }
739

740 741 742 743
    if ($data instanceof ArtefactType) {
        // leave it alone
    }
    else if (is_object($data)) {
744 745
        $data = (array)$data;
    }
746
    else if (is_numeric($data)) {
747 748 749
        $data = array('id' => $data);
    }

750 751 752
    // this is here because the core can't listen to events
    // @todo, this is VERY ugly, and someone should fix it
    if ($event == 'createuser') {
753
        activity_set_defaults($data['id']);
754 755
    }

Penny Leach's avatar
Penny Leach committed
756 757
    $plugintypes = plugin_types();
    foreach ($plugintypes as $name) {
758
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
759
            foreach ($subs as $sub) {
760
                safe_require($name, $sub->plugin);
Penny Leach's avatar
Penny Leach committed
761 762
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
763
                    call_static_method($classname, $sub->callfunction, $event, $data);
Penny Leach's avatar
Penny Leach committed
764 765 766 767 768 769 770 771 772 773
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

774 775 776 777 778 779 780 781 782 783 784 785 786 787
/**
 * 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
788 789
/** 
 * Adds stuff to the log
790
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
791 792 793 794 795 796 797 798 799 800 801 802
 *
 * @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) {

}

803 804 805 806
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
807
    log_debug($message);
808 809 810 811 812 813
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

814 815 816
/** 
 * Base class for all plugintypes.
 */
817
class Plugin {
818
    
819 820
    /**
     * This function returns an array of crons it wants to have run
821
     * Each item should be a StdClass object containing - 
822 823 824 825
     * - callfunction (static function on the Plugin Class)
     * - any or all of minute, hour, day, month, dayofweek 
     * (will default to * if not supplied)
     */
826 827 828 829
    public static function get_cron() {
        return array();
    }

830 831 832 833 834 835 836
    /** 
     * 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
     */
837 838 839 840
    public static function get_event_subscriptions() {
        return array();
    }

841 842 843 844 845 846 847

    /**
     * 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) {
848 849
        return true;
    }
850

851 852 853 854 855
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
856 857 858
    public static function has_config() {
        return false;
    }
859 860
}

861 862 863 864 865 866 867 868 869 870
/**
 * 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
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

function format_date($date, $formatkey='strftimedatetime') {
871 872 873
    if (empty($date)) {
        return get_string('strftimenotspecified');
    }
874 875 876
    return strftime(get_string($formatkey), $date);
}

877 878 879
/**
 * Returns a random string suitable for registration/change password requests
 *
880
 * @param int $length The length of the key to return
881 882
 * @return string
 */
883 884 885 886
function get_random_key($length=16) {
    if ($length < 1) {
        throw new IllegalArgumentException('Length must be a positive number');
    }
887 888 889 890 891 892 893
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
894
    for ($i = 0; $i < $length; $i++) {
895 896 897 898 899
        $result .= $pool[$i];
    }
    return $result;
}

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
/**
 * Given a form, an array of values with 'password1' and 'password2'
 * indices and a user, validate that the user can change their password to
 * the one in $values.
 *
 * This provides one place where validation of passwords can be done. This is
 * used by:
 *  - registration
 *  - user forgot password
 *  - user changing password on their account page
 *  - user forced to change their password by the <kbd>passwordchange</kbd>
 *    flag on the <kbd>usr</kbd> table.
 *
 * The password is checked for:
 *  - Being in valid form according to the rules of the authentication method
 *    for the user
 *  - Not being an easy password (a blacklist of strings, NOT a length check or
 *     similar), including being the user's username
 *  - Both values being equal
 *
920 921 922
 * @param Pieform $form         The form to validate
 * @param array $values         The values passed through
 * @param string $authplugin    The authentication plugin that the user uses
923
 */
924 925
function password_validate(Pieform $form, $values, $username, $institution) {
    $authtype  = auth_get_authtype_for_institution($institution);
926
    $authclass = 'Auth' . ucfirst($authtype);
927
    safe_require('auth', $authtype);
928
    if (!$form->get_error('password1') && !call_static_method($authclass, 'is_password_valid', ($values['password1']))) {
929
        $form->set_error('password1', get_string('passwordinvalidform', "auth.$authtype"));
930 931 932
    }

    $suckypasswords = array(
933
        'mahara', 'password', $username
934 935 936 937 938 939 940 941
    );
    if (!$form->get_error('password1') && in_array($values['password1'], $suckypasswords)) {
        $form->set_error('password1', get_string('passwordtooeasy'));
    }

    if (!$form->get_error('password1') && $values['password1'] != $values['password2']) {
        $form->set_error('password2', get_string('passwordsdonotmatch'));
    }
Nigel McNie's avatar
Nigel McNie committed
942 943

    // No Mike, that's a _BAD_ Mike! :)
944
    if ($values['password1'] == 'mike01' || $values['password1'] == 'mike012') {
Nigel McNie's avatar
Nigel McNie committed
945 946
        if (!$form->get_property('jsform')) {
            die_info('<img src="'
947
                . theme_get_url('images/sidebox1_corner_botright.gif')
Nigel McNie's avatar
Nigel McNie committed
948 949 950
                . '" alt="(C) 2007 MSS Enterprises"></p>');
        }
    }
951 952
}

953

954 955 956 957
//
// Pieform related functions
//

958 959 960
/**
 * Configures a default form
 */
961
function pieform_configure() {
962
    global $USER;
963
    return array(
964 965
        'method'    => 'post',
        'action'    => '',
966
        'autofocus' => true,
967
        'renderer'  => 'maharatable',
Nigel McNie's avatar
Nigel McNie committed
968
        'elementclasses' => true,
969 970 971 972 973 974
        'jserrorcallback'       => 'formError',
        'globaljserrorcallback' => 'formGlobalError',
        'jssuccesscallback'     => 'formSuccess',
        'presubmitcallback'     => 'formStartProcessing',
        'postsubmitcallback'    => 'formStopProcessing',
        'jserrormessage' => get_string('errorprocessingform'),
975
        'configdirs' => get_config('libroot') . 'form/',
976
        'helpcallback' => 'pieform_get_help',
977
        'elements'   => array(
978
            'sesskey' => array(
979
                'type'  => 'hidden',
980
                'value' => $USER->get('sesskey')
981 982 983 984 985
            )
        )
    );
}

986 987 988 989 990
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
991
    if ($USER && $USER->get('sesskey') != $values['sesskey']) {
992 993 994 995 996
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
997 998 999 1000 1001 1002 1003
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
            FROM ' . get_config('dbprefix') . 'usr
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
1004 1005 1006
    }
}

1007
function pieform_element_calendar_configure($element) {
1008
    $element['jsroot'] = '/js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
1009
    $element['themefile'] = theme_get_url('style/calendar.css');
1010
    $element['imagefile'] = theme_get_url('images/calendar.gif');
1011
    $element['language'] = 'en'; // @todo: language file names for the js calendar may need to be changed
1012 1013 1014
    return $element;
}

1015 1016 1017 1018 1019
function pieform_element_textarea_configure($element) {
    $element['resizable'] = true;
    return $element;
}

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
/**
 * 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
1030
function can_view_view($view_id, $user_id=null) {
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
    global $USER;
    $now = time();
    $dbnow = db_format_timestamp($now);
    $prefix = get_config('dbprefix');

    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,
1047
            v.submittedto,
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
            ' . db_format_tsfield('a.startdate','access_startdate') . ',
            ' . db_format_tsfield('a.stopdate','access_stopdate') . '
        FROM
            ' . $prefix . 'view v
            LEFT OUTER JOIN ' . $prefix . 'view_access a ON v.id=a.view
        WHERE v.id=?
    ', array($view_id));

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

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

Martyn Smith's avatar
Martyn Smith committed
1062
    log_debug('Can you look at this view? (you are user ' . $user_id . ' trying to look at view ' . $view_id . ')');
1063 1064 1065 1066 1067 1068

    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;
1069
        $view_record['submittedto'] = $row->submittedto;
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085

        if (!isset($row->accesstype)) {
            continue;
        }
        
        $view_record['access'][$row->accesstype] = array(
            'startdate' => $row->access_startdate,
            'stopdate' => $row->access_stopdate,
        );
    }

    if ($USER->is_logged_in() && $view_record['owner'] == $user_id) {
        log_debug('Yes - you own this view');
        return true;
    }

1086 1087 1088 1089 1090
    if ($view_record['submittedto'] && record_exists('community_member', 'community', $view_record['submittedto'], 'member', $user_id, 'tutor', 1)) {
        log_debug('Yes - View is submitted for assesment to a community you are a tutor in');
        return true;
    }

1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
    // check public
    if (
        isset($view_record['access']['public'])
        && (    
            $view_record['access']['public']['startdate'] == null
            || $view_record['access']['public']['startdate'] < $now
        )
        && (
            $view_record['access']['public']['stopdate'] == null
            || $view_record['access']['public']['stopdate'] > $now
        )
Martyn Smith's avatar
Martyn Smith committed
1102
    ) {
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124

        log_debug('Yes - View is public');
        return true;
    }

    // everything below this point requires that you be logged in
    if (!$USER->is_logged_in()) {
        log_debug('No - you are not logged in');
        return false;
    }

    // check logged in
    if (
        isset($view_record['access']['loggedin'])
        && (    
            $view_record['access']['loggedin']['startdate'] == null
            || $view_record['access']['loggedin']['startdate'] < $now
        )
        && (
            $view_record['access']['loggedin']['stopdate'] == null
            || $view_record['access']['loggedin']['stopdate'] > $now
        )
Martyn Smith's avatar
Martyn Smith committed
1125
    ) {
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145

        log_debug('Yes - View is available to logged in users');
        return true;
    }

    // check friends access
    if (
        isset($view_record['access']['friends'])
        && (    
            $view_record['access']['friends']['startdate'] == null
            || $view_record['access']['friends']['startdate'] < $now
        )
        && (
            $view_record['access']['friends']['stopdate'] == null
            || $view_record['access']['friends']['stopdate'] > $now
        )
        && get_field_sql(
            'SELECT COUNT(*) FROM ' . $prefix . 'usr_friend f WHERE (usr1=? AND usr2=?) OR (usr1=? AND usr2=?)',
            array( $view_record['owner'], $user_id, $user_id, $view_record['owner'] )
        )
Martyn Smith's avatar
Martyn Smith committed
1146
    ) {
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
        log_debug('Yes - View is available to friends of the owner');
        return true;
    }

    // check user access
    if (get_field_sql(
        'SELECT
            a.view
        FROM 
            ' . $prefix . 'view_access_usr a
        WHERE
            a.view=? AND a.usr=?
Martyn Smith's avatar
Martyn Smith committed
1159 1160
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
        LIMIT 1',
        array( $view_id, $user_id, $dbnow, $dbnow )
        )
    ) {
        log_debug('Yes - View is available to your user');
        return true;
    }

    // check group access
    if (get_field_sql(
        'SELECT
            a.view
        FROM 
            ' . $prefix . 'view_access_group a
            INNER JOIN ' . $prefix . 'usr_group g ON a.grp = g.id
            INNER JOIN ' . $prefix . 'usr_group_member m ON g.id = m.grp
        WHERE
            a.view=? AND m.member=?
Martyn Smith's avatar
Martyn Smith committed
1179 1180
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
        LIMIT 1',
        array( $view_id, $user_id, $dbnow, $dbnow )
        )
    ) {
        log_debug('Yes - View is available to one of the owners groups');
        return true;
    }

    // check community access
    if (get_field_sql(
        'SELECT
            a.view
        FROM
            ' . $prefix . 'view_access_community a
            INNER JOIN ' . $prefix . 'community c ON a.community = c.id
            INNER JOIN ' . $prefix . 'community_member m ON c.id=m.community
        WHERE
            a.view=? AND m.member=?
Martyn Smith's avatar
Martyn Smith committed
1199 1200
            AND ( a.startdate < ? OR a.startdate IS NULL )
            AND ( a.stopdate > ?  OR a.stopdate  IS NULL )
1201 1202 1203 1204 1205 1206 1207 1208 1209
            AND ( a.tutoronly = 0 OR m.tutor = 1 )
        LIMIT 1',
        array( $view_id, $user_id, $dbnow, $dbnow )
        )
    ) {
        log_debug('Yes - View is available to a specific community');
        return true;
    }

1210 1211 1212 1213 1214 1215
    // check admin
    if (get_field('usr', 'admin', 'id', $user_id)) {
        log_debug('Yes - You are a site administrator');
        return true;
    }

1216 1217 1218 1219 1220

    log_debug('No - nothing matched');
    return false;
}

Penny Leach's avatar
Penny Leach committed
1221 1222 1223 1224 1225 1226
/**
 * get the views that a user can see belonging
 * to the given users
 *
 * @param array $users users to fetch views owned by
 * @param int $userlooking (optional, defaults to logged in user)