mahara.php 54.2 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
4
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
 * Copyright (C) 2006-2007 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
21
22
23
24
 *
 * @package    mahara
 * @subpackage core
 * @author     Penny Leach <penny@catalyst.net.nz>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
 * @copyright  (C) portions from Moodle, (C) Martin Dougiamas http://dougiamas.com
25
26
 */

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

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

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

    // Various required extensions
    if (!extension_loaded('json')) {
        throw new ConfigSanityException(get_string('jsonextensionnotloaded', 'error'));
    }
45
46
47
48
49
50
51
    switch (get_config('dbtype')) {
    case 'postgres8':
        if (!extension_loaded('pgsql')) {
            throw new ConfigSanityException(get_string('pgsqldbextensionnotloaded', 'error'));
        }
        break;
    case 'mysql': // NOTE: mysql to be phased out. This should be log_environ() in 1.0 and removed in 1.1
52
53
54
        log_environ(get_string('mysqldbtypedeprecated', 'error'));
        // intentionally no break here
    case 'mysql5':
55
56
57
58
59
60
        if (!extension_loaded('mysql')) {
            throw new ConfigSanityException(get_string('mysqldbextensionnotloaded', 'error'));
        }
        break;
    default:
        throw new ConfigSanityException(get_string('unknowndbtype', 'error'));
61
62
63
64
65
66
67
68
69
70
71
    }
    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'));
    }

72
73
74
75
76
77
78
79
80
81
82
    // 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'));
    }

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

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

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

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

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

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

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

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

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

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

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

186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
function get_string_from_language($lang, $identifier, $section='mahara') {

    $variables = func_get_args();
    if (count($variables) > 3) { // we have some stuff we need to sprintf
        array_shift($variables);
        array_shift($variables);
        array_shift($variables); //shift off the first three.
    }
    else {
        $variables = array();
    }
    
    return get_string_location($identifier, $section, $variables, 'format_langstring', $lang);
}

201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
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);
221
222
223
224
225
226
        if ($plugintype != 'core') {
            $file .=  'pages/' . $page . '.html';
        }
        else {
            $file .= 'pages/' . $pluginname . '/' . $page . '.html';
        } 
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
    }
    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)) {
258
        $langfile = get_config('docroot') . 'lang/' . $lang . '/langconfig.php';
259
260
261
262
        if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
            if ($parentlang == 'en.utf8') {
                $trieden = true;
            }
263
            $langfile = get_config('docroot') . 'lang/' . $parentlang . '/' . $file;
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
            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;
}

280
281
282
283
284
// get a string without sprintfing it.
function get_raw_string($identifier, $section='mahara') {
    // For a raw string we don't want to format any arguments using
    // sprintf, so the replace function passed to get_string_location
    // should just return the first argument and ignore the second.
285
286
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
287
288
289
290
291
292
293
294
295
296
297
298
299
300
}


/**
 * This function gets a language string identified by $identifier from
 * an appropriate location, and formats the string and any arguments
 * in $variables using the function $replacefunc.
 *
 * @param string   $identifier
 * @param string   $section
 * @param array    $variables
 * @param function $replacefunc
 * @return string
 */
301
function get_string_location($identifier, $section, $variables, $replacefunc='format_langstring', $lang='') {
302
303
304
305

    $langconfigstrs = array('parentlanguage', 'strftimedate', 'strftimedateshort', 'strftimedatetime',
                            'strftimedaydate', 'strftimedaydatetime', 'strftimedayshort', 'strftimedaytime',
                            'strftimemonthyear', 'strftimerecent', 'strftimerecentfull', 'strftimetime',
Richard Mansfield's avatar
Richard Mansfield committed
306
                            'strfdaymonthyearshort', 'thislanguage');
307
308
309
310
311

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

312
313
314
    if (empty($lang)) {
        $lang = current_language();
    }
315
316
317
318
319

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
320
    if (false === strpos($section, '.')) {
321
322
323
324
        $locations[] = $docroot . 'lang/';
    }
    else {
        $extras = plugin_types(); // more later..
325
        foreach ($extras as $tocheck) {
326
            if (strpos($section, $tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
327
                $pluginname = substr($section ,strlen($tocheck) + 1);
328
329
330
                if ($tocheck == 'blocktype' && 
                    strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
                    $bits = explode('/', $pluginname);
331
332
                    $locations[] = $docroot . 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
                    $section = 'blocktype.' . $bits[1];
333
334
335
336
                }
                else {
                    $locations[] = $docroot . $tocheck . '/' . $pluginname . '/lang/';
                }
337
338
339
            }
        }
    }
340

341
342
343
    // 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
344
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
345
        if (is_readable($langfile)) {
346
            if ($result = get_string_from_file($identifier, $langfile)) {
347
                return $replacefunc($result, $variables);
348
349
350
351
352
353
354
            }
        }
    }

    // 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') {
355
        return '[[' . $identifier . '/' . $section . ']]';
356
357
358
359
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
    foreach ($locations as $location) {
360
        $langfile = $location . $lang . '/langconfig.php';
Penny Leach's avatar
Penny Leach committed
361
        if (is_readable($langfile)) {
362
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
363
                $langfile = $location . $parentlang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
364
                if (is_readable($langfile)) {
365
                    if ($result = get_string_from_file($identifier, $langfile)) {
366
                        return $replacefunc($result, $variables);
367
368
369
370
371
372
373
374
375
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
376
        $langfile = $location . 'en.utf8/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
377
        if (is_readable($langfile)) {
378
            if ($result = get_string_from_file($identifier, $langfile)) {
379
                return $replacefunc($result, $variables);
380
381
382
383
            }
        }
    }

384
    return '[[' . $identifier . '/' . $section . ']]';  // Last resort
385
}
386
387


388
389
390
391
392
393
394
395
/**
 * Return a list of available languages
 *
 */
function get_languages() {
    $langs = array();
    $langbase = get_config('docroot') . 'lang/';
    if (!$langdir = opendir($langbase)) {
396
        throw new SystemException('Unable to read language directory '.$langbase);
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
    }
    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)) {
419
        throw new SystemException('Unable to read theme directory '.$themebase);
420
421
    }
    while (false !== ($subdir = readdir($themedir))) {
422
        if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
423
424
            $themes[$subdir] = $subdir;

425
            $config_path = $themebase . $subdir . '/config.php';
426
427
428
429
430
431
            if (is_readable($config_path)) {
                require_once($config_path);
                if (isset($theme->name)) {
                    $themes[$subdir] = $theme->name;
                }
            }
432
433
434
435
436
437
438
        }
    }
    closedir($themedir);
    return $themes;
}


439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
/**
 * 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
 *
477
 * @param string $ini_get_arg setting to look for
478
479
480
481
482
483
484
485
486
487
488
 * @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;
}

489
490
491
492
493
494
495
496
497
498
/**
 * 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;
    
499
    $dbconfig = get_records_array('config', '', '', '', 'field, value');
500
501
    
    foreach ($dbconfig as $cfg) {
502
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
503
            // @todo warn that we're overriding db config with $CFG
504
505
506
507
508
509
510
511
512
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
513
514
515
516
517
518
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
519
520
function get_config($key) {
    global $CFG;
521
    if (isset($CFG->$key)) {
522
523
524
525
526
        return $CFG->$key;
    }
    return null;
}

527
528
529
530
531
532
533
534
535

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

538
    db_ignore_sql_exceptions(true);
539
540
    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
541
542
543
544
545
546
547
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
548
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
549
    }
550
    db_ignore_sql_exceptions(false);
Penny Leach's avatar
Penny Leach committed
551
552

    if (!empty($status)) {
553
554
555
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
556

557
558
559
560
561
562
563
564
565
566
567
568
569
570
    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;
571

572
573
    // Suppress NOTICE with @ in case $key is not yet cached
    @$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
574
    if (isset($value)) {
575
576
577
578
        return $value;
    }

    $records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
579
    if (!empty($records)) {
580
581
        foreach($records as $record) {
            $CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
582
            if ($record->field == $key) {
583
584
585
                $value = $record->value;
            }
        }
586
587
    }

588
589
590
    return $value;
}

Penny Leach's avatar
Penny Leach committed
591
function set_config_plugin($plugintype, $pluginname, $key, $value) {
592
    global $CFG;
593
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
594

595
596
597
    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
598
599
600
601
602
603
604
605
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
606
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
607
608
609
610
611
612
613
614
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

615
616
617
618
619
620
621
622
623
624
/**
 * 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
 */
625
function get_config_plugin_instance($plugintype, $pluginid, $key) {
626
627
628
629
630
631
    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
632
    @$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
633
    if (isset($value)) {
634
635
636
        return $value;
    }

637
    $records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
638
    if (!empty($records)) {
639
        foreach($records as $record) {
640
            $CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
641
            if ($record->field == $key) {
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
                $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;
}

685
/**
686
687
688
689
690
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
691
692
693
694
695
696
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

697
/**
698
699
700
701
702
703
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
704
function current_language() {
705
    global $USER, $CFG, $SESSION;
706
707
708
709
710
    if ($USER instanceof User) {
        $lang = $USER->get_account_preference('lang');
        if ($lang !== null && $lang != 'default') {
            return $lang;
        }
711
    }
712
713
714
715
716
717

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

720
721
722
723
724
725
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

726
/**
727
728
729
730
731
732
 * 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
 */
733
734
735
736
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

737
738
739
740
741
742
743
744
745
746
747
748
749
/**
 * 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);
}

750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
/**
 * 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); 
768
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
769
            // @todo has the umask been clobbered at this point, and is this a bad thing?
770
771
772
773
774
        }
    }
    return $status;
}

Penny Leach's avatar
Penny Leach committed
775
776
777
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
778
 *
Penny Leach's avatar
Penny Leach committed
779
780
 * This function is the one safe point to require plugin files.
 * so USE it :)
781
 *
Penny Leach's avatar
Penny Leach committed
782
783
784
785
786
787
 * @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
 */
788
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
789
790
791
792
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
793
794
    require_once(get_config('docroot') . $plugintype . '/lib.php');

795
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
796
797
798
799
800
801
        if (!empty($nonfatal)) {
            return false;
        }
        throw new Exception ('invalid require type');
    }

802
803
804
805
806
    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;
        }
807
        else {
808
            if (table_exists(new XMLDBTable('blocktype_installed'))) {
809
810
811
812
813
                if ($artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $pluginname)) {
                    $fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
                }
            }
        }
814
815
816
817
818
    } 
    if (empty($fullpath)) {
        $fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
    }

Penny Leach's avatar
Penny Leach committed
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
    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); }
    
}

840
841
842
843
844
845
846
/**
 * This function returns the list of plugintypes we currently care about
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
847
        // ORDER MATTERS! artefact has to be first!
848
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype', 'interaction');
849
850
851
852
    }
    return $pluginstocheck;
}

853
854
855
856
857
858
859
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
860
    return get_records_array($plugintype . '_installed');
861
862
}

863
864
865
866
867
868
869
870
/**
 * 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);
871
    return call_user_func_array(array($class, $method), $args);
872
873
}

874
875
function generate_class_name() {
    $args = func_get_args();
876
    if (count($args) == 2 && $args[0] == 'blocktype') {
877
        return 'PluginBlocktype' . ucfirst(blocktype_namespaced_to_single($args[1]));
878
    }
879
880
881
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

882
883
884
885
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

886
887
888
889
function generate_interaction_instance_class_name($type) {
    return 'Interaction' . ucfirst($type) . 'Instance';
}

890
891
892
893
894
895
896
897
898
899
900
901
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;
902
903
}

904

905
906
907
908
909
/**
 * 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
910
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
911
    }
912

913
    if ($data instanceof ArtefactType || $data instanceof BlockInstance) {
914
915
916
        // leave it alone
    }
    else if (is_object($data)) {
917
918
        $data = (array)$data;
    }
919
    else if (is_numeric($data)) {
920
921
922
        $data = array('id' => $data);
    }

923
924
925
    // this is here because the core can't listen to events
    // @todo, this is VERY ugly, and someone should fix it
    if ($event == 'createuser') {
926
        activity_set_defaults($data['id']);
927
928
    }

Penny Leach's avatar
Penny Leach committed
929
930
    $plugintypes = plugin_types();
    foreach ($plugintypes as $name) {
931
        if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
932
            foreach ($subs as $sub) {
933
                safe_require($name, $sub->plugin);
Penny Leach's avatar
Penny Leach committed
934
935
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
936
                    call_static_method($classname, $sub->callfunction, $event, $data);
Penny Leach's avatar
Penny Leach committed
937
938
939
940
941
942
943
944
945
946
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

947
948
949
950
951
952
953
954
955
956
957
958
959
960
/**
 * 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
961
962
/** 
 * Adds stuff to the log
963
 * @todo write this function
Penny Leach's avatar
Penny Leach committed
964
965
966
967
968
969
970
971
972
973
974
975
 *
 * @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) {

}

976
977
978
979
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
980
    log_debug($message);
981
982
983
984
985
986
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

987
988
989
/** 
 * Base class for all plugintypes.
 */
990
class Plugin {
991
    
992
993
    /**
     * This function returns an array of crons it wants to have run
994
     * Each item should be a StdClass object containing - 
995
996
997
998
     * - callfunction (static function on the Plugin Class)
     * - any or all of minute, hour, day, month, dayofweek 
     * (will default to * if not supplied)
     */
999
1000
1001
1002
    public static function get_cron() {
        return array();
    }

1003
1004
1005
1006
1007
1008
1009
    /** 
     * 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
     */
1010
1011
1012
1013
    public static function get_event_subscriptions() {
        return array();
    }

1014
1015
1016
1017
1018
1019
1020

    /**
     * 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) {
1021
1022
        return true;
    }
1023

1024
1025
1026
1027
1028
    /**
     * Whether this plugin has admin plugin config options.
     * If you return true here, you must supply a valid pieform
     * in {@link get_config}
     */
1029
1030
1031
    public static function has_config() {
        return false;
    }
1032
1033
1034
1035
1036
1037
1038
1039
1040

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

1043
1044
1045
1046
1047
/**
 * 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
1048
1049
 * @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
 * @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
1050
1051
1052
1053
 * (see langconfig.php or the top of {@link get_string_location}
 * for supported keys
 */

1054
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
1055
    if (empty($date)) {
1056
        return get_string($notspecifiedkey, $notspecifiedsection);
1057
    }
1058
1059
1060
    return strftime(get_string($formatkey), $date);
}

1061
1062
1063
/**
 * Returns a random string suitable for registration/change password requests
 *
1064
 * @param int $length The length of the key to return
1065
1066
 * @return string
 */
1067
1068
1069
1070
function get_random_key($length=16) {
    if ($length < 1) {
        throw new IllegalArgumentException('Length must be a positive number');
    }
1071
1072
1073
1074
1075
1076
1077
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
1078
    for ($i = 0; $i < $length; $i++) {
1079
1080
1081
1082
1083
        $result .= $pool[$i];
    }
    return $result;
}

1084

1085
1086
1087
1088
//
// Pieform related functions
//

1089
1090
1091
/**
 * Configures a default form
 */
1092
function pieform_configure() {
1093
    global $USER;
1094
    return array(
1095
1096
        'method'    => 'post',
        'action'    => '',
1097
        'language'  => current_language(),
1098
        'autofocus' => true,
1099
        'renderer'  => 'maharatable',
1100
        'requiredmarker' => true,
Nigel McNie's avatar
Nigel McNie committed
1101
        'elementclasses' => true,
1102
        'jsdirectory'    => get_config('wwwroot') . 'lib/pieforms/static/core/',
1103
        'replycallback'  => 'pieform_reply',
1104
1105
1106
1107
1108
1109
        'jserrorcallback'       => 'formError',
        'globaljserrorcallback' => 'formGlobalError',
        'jssuccesscallback'     => 'formSuccess',
        'presubmitcallback'     => 'formStartProcessing',
        'postsubmitcallback'    => 'formStopProcessing',
        'jserrormessage' => get_string('errorprocessingform'),
1110
        'configdirs' => get_config('libroot') . 'form/',
1111
        'helpcallback' => 'pieform_get_help',
1112
        'elements'   => array(
1113
            'sesskey' => array(
1114
                'type'  => 'hidden',
1115
                'value' => $USER->get('sesskey')
1116
1117
1118
1119
1120
            )
        )
    );
}

1121
1122
1123
1124
1125
function pieform_validate(Pieform $form, $values) {
    global $USER;
    if (!isset($values['sesskey'])) {
        throw new UserException('No session key');
    }
1126
    if ($USER && $USER->is_logged_in() && $USER->get('sesskey') != $values['sesskey']) {
1127
1128
1129
1130
1131
        throw new UserException('Invalid session key');
    }

    // Check to make sure the user has not been suspended, so that they cannot
    // perform any action
1132
1133
    if ($USER) {
        $record = get_record_sql('SELECT suspendedctime, suspendedreason
1134
            FROM {usr}
1135
1136
1137
1138
            WHERE id = ?', array($USER->get('id')));
        if ($record && $record->suspendedctime) {
            throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
        }
1139
1140
1141
    }
}

1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
function pieform_reply($code, $data) {
    global $SESSION;
    if (isset($data['message'])) {
        if ($code == PIEFORM_ERR) {
            $SESSION->add_error_msg($data['message']);
        }
        else {
            $SESSION->add_ok_msg($data['message']);
        }
    }
    if (isset($data['goto'])) {
        redirect($data['goto']);
    }
    // NOT explicitly exiting here. Pieforms will throw an exception which will 
    // force the user to fix their form
}

1159
function pieform_element_calendar_configure($element) {
1160
    $element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
Martyn Smith's avatar
Martyn Smith committed
1161
    $element['themefile'] = theme_get_url('style/calendar.css');
1162
    $element['imagefile'] = theme_get_url('images/calendar.gif');
1163
    $language = substr(current_language(), 0, 2);
1164
    $element['language'] = $language;
1165
1166
1167
    return $element;
}

1168
function pieform_element_textarea_configure($element) {
1169
1170
1171
    if (!array_key_exists('resizable', $element)) {
        $element['resizable'] = true;
    }
1172
1173
1174
    return $element;
}

1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
/**
 * 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
1185
function can_view_view($view_id, $user_id=null) {
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
    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,
1201
            v.submittedto,
1202
1203
1204
            ' . db_format_tsfield('a.startdate','access_startdate') . ',
            ' . db_format_tsfield('a.stopdate','access_stopdate') . '
        FROM
1205
1206
            {view} v
            LEFT OUTER JOIN {view_access} a ON v.id=a.view
1207
1208
1209
1210
1211
1212
1213
1214
1215
        WHERE v.id=?
    ', array($view_id));

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

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

1216
    //log_debug('Can you look at this view? (you are user ' . $user_id . ' trying to look at view ' . $view_id . ')');
1217
1218
1219
1220
1221
1222

    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;
1223
        $view_record['submittedto'] = $row->submittedto;
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235

        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) {
1236
        //log_debug('Yes - you own this view');
1237
1238
1239
        return true;
    }

1240
1241
    if ($view_record['submittedto'] && record_exists('group_member', 'group', $view_record['submittedto'], 'member', $user_id, 'tutor', 1)) {
        //log_debug('Yes - View is submitted for assesment to a group you are a tutor in');
1242
1243
1244
        return true;
    }

1245
1246
    // check public
    if (
Clare Lenihan's avatar
Clare Lenihan committed
1247
1248
        get_config('allowpublicviews') == '1'
        &&
1249
1250
1251
1252
1253
1254
1255
1256
1257
        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
1258
    ) {
1259

1260
        //log_debug('Yes - View is public');
1261
1262
1263
1264
1265
        return true;
    }

    // everything below this point requires that you be logged in
    if (!$USER->is_logged_in()) {
1266
        //log_debug('No - you are not logged in');
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
        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
1281
    ) {
1282

1283
        //log_debug('Yes - View is available to logged in users');
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
        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(
1299
            'SELECT COUNT(*) FROM {usr_friend} f WHERE (usr1=? AND usr2=?) OR (usr1=? AND usr2=?)',
1300
1301
            array( $view_record['owner'], $user_id, $user_id, $view_record['owner'] )
        )
Martyn Smith's avatar
Martyn Smith committed
1302
    ) {
1303
        //log_debug('Yes - View is available to friends of the owner');
1304
1305
1306
1307
1308
1309
1310
1311
        return true;
    }

    // check user access
    if (get_field_sql(