mahara.php 46.7 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
    // @todo the results of these should be checked
124
125
126
    check_dir_exists(get_config('dataroot').'smarty/compile');
    check_dir_exists(get_config('dataroot').'smarty/cache');

127
128
}

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

143
function get_string($identifier, $section='mahara') {
144
145
146
147
148

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

// 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.
162
163
    return get_string_location($identifier, $section, array(), 
                               create_function('$string, $args','return $string;'));
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
}


/**
 * 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',
                            'thislanguage');

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

189
190
191
192
193
194
    $lang = current_language();

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
195
    if (false === strpos($section, '.')) {
196
197
198
199
        $locations[] = $docroot . 'lang/';
    }
    else {
        $extras = plugin_types(); // more later..
200
        foreach ($extras as $tocheck) {
201
            if (strpos($section,$tocheck . '.') === 0) {
Nigel McNie's avatar
Nigel McNie committed
202
                $pluginname = substr($section ,strlen($tocheck) + 1);
203
                $locations[] = $docroot . $tocheck . '/' . $pluginname . '/lang/';
204
205
206
            }
        }
    }
207

208
209
210
    // 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
211
        $langfile = $location . $lang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
212
        if (is_readable($langfile)) {
213
            if ($result = get_string_from_file($identifier, $langfile)) {
214
                return $replacefunc($result, $variables);
215
216
217
218
219
220
221
            }
        }
    }

    // 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') {
222
        return '[[' . $identifier . ']]';
223
224
225
226
    }

    // Is a parent language defined?  If so, try to find this string in a parent language file
    foreach ($locations as $location) {
227
        $langfile = $location . $lang . '/langconfig.php';
Penny Leach's avatar
Penny Leach committed
228
        if (is_readable($langfile)) {
229
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
230
                $langfile = $location . $parentlang . '/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
231
                if (is_readable($langfile)) {
232
                    if ($result = get_string_from_file($identifier, $langfile)) {
233
                        return $replacefunc($result, $variables);
234
235
236
237
238
239
240
241
242
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
243
        $langfile = $location . 'en.utf8/' . $section . '.php';
Penny Leach's avatar
Penny Leach committed
244
        if (is_readable($langfile)) {
245
            if ($result = get_string_from_file($identifier, $langfile)) {
246
                return $replacefunc($result, $variables);
247
248
249
250
            }
        }
    }

251
    return '[[' . $identifier . ']]';  // Last resort
252
}
253
254


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
/**
 * 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))) {
        // Where do we get theme names from?
        if ($subdir != "." && $subdir != "..") {
            $themes[$subdir] = get_string($subdir);
        }
    }
    closedir($themedir);
    return $themes;
}


299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/**
 * 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
 *
337
 * @param string $ini_get_arg setting to look for
338
339
340
341
342
343
344
345
346
347
348
 * @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;
}

349
350
351
352
353
354
355
356
357
358
359
/**
 * 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 {
360
        $dbconfig = get_records_array('config');
361
    } 
362
    catch (SQLException $e) {
363
364
365
366
        return false;
    }
    
    foreach ($dbconfig as $cfg) {
367
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
Penny Leach's avatar
Penny Leach committed
368
            // @todo warn that we're overriding db config with $CFG
369
370
371
372
373
374
375
376
377
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
378
379
380
381
382
383
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
384
385
386
387
388
389
390
391
function get_config($key) {
    global $CFG;
    if (array_key_exists($key,$CFG)) {
        return $CFG->$key;
    }
    return null;
}

392
393
394
395
396
397
398
399
400

/**
 * 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) {
401
402
403
404
    global $CFG;

    if (get_record('config', 'field', $key)) {
        if (set_field('config', 'value', $value, 'field', $key)) {
Penny Leach's avatar
Penny Leach committed
405
406
407
408
409
410
411
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
412
        $status = insert_record('config', $config);
Penny Leach's avatar
Penny Leach committed
413
414
415
    }

    if (!empty($status)) {
416
417
418
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
419

420
421
422
423
424
425
426
427
428
429
430
431
432
433
    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;
434

435
436
437
438
439
440
441
    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};
    }
    
442
443
444
    // @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.
445
    if (!$value = get_field($plugintype . '_config', 'value', 'plugin', $pluginname, 'field', $key)) {
446
        $value = null;
447
448
    }

449
450
451
452
    $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
    return $value;
}

Penny Leach's avatar
Penny Leach committed
453
function set_config_plugin($plugintype, $pluginname, $key, $value) {
454
    global $CFG;
455
    $table = $plugintype . '_config';
Penny Leach's avatar
Penny Leach committed
456

457
458
459
    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
460
461
462
463
464
465
466
467
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
468
        $status = insert_record($table, $pconfig);
Penny Leach's avatar
Penny Leach committed
469
470
471
472
473
474
475
476
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

477
/**
478
479
480
481
482
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
483
484
485
486
487
488
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

489
/**
490
491
492
493
494
495
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
496
497
function current_language() {
    global $USER, $CFG;
498
499
    if (null !== ($lang = $USER->get_account_preference('lang'))) {
        return $lang;
500
501
502
503
504
505
506
    }
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

507
/**
508
509
510
511
512
513
 * 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
 */
514
515
516
517
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

518
519
520
521
522
523
524
525
526
527
528
529
530
/**
 * 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);
}

531
532
533
534
535
536
537
538
539
/**
 *
 * Check whether to use the wysiwyg html editor or a plain textarea.
 * @todo check user setting from db and browser capability
 *
 */
function use_html_editor() {
    return true;
}
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558

/**
 * 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); 
559
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
560
            // @todo has the umask been clobbered at this point, and is this a bad thing?
561
562
563
564
565
        }
    }
    return $status;
}

566
567
568
569
570
/**
 * Checks that a username is in valid form
 *
 * @todo need such a function for password too.
 */
571
572
573
//function validate_username($username) {
//    return preg_match('/^[a-zA-Z0-9_\.@]+$/', $username);
//}
574

Penny Leach's avatar
Penny Leach committed
575
576
577
/**
 * Function to require a plugin file. This is to avoid doing 
 * require and include directly with variables.
578
 *
Penny Leach's avatar
Penny Leach committed
579
580
 * This function is the one safe point to require plugin files.
 * so USE it :)
581
 *
Penny Leach's avatar
Penny Leach committed
582
583
584
585
586
587
 * @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
 */
588
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
589
590
591
592
    $plugintypes = plugin_types();
    if (!in_array($plugintype, $plugintypes)) {
        throw new Exception("\"$plugintype\" is not a valid plugin type");
    }
593
594
    require_once(get_config('docroot') . $plugintype . '/lib.php');

595
    if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
Penny Leach's avatar
Penny Leach committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
        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); }
    
}

Martyn Smith's avatar
Martyn Smith committed
624

625
626
627
628
629
/**
 * Returns the list of site content pages
 * @return array of names
 */
function site_content_pages() {
630
    return array('about', 'home', 'loggedouthome', 'privacy', 'termsandconditions', 'uploadcopyright');
631
632
}

Richard Mansfield's avatar
Richard Mansfield committed
633
function get_site_page_content($pagename) {
634
    if ($pagedata = @get_record('site_content', 'name', $pagename)) {
Richard Mansfield's avatar
Richard Mansfield committed
635
636
        return $pagedata->content;
    }
637
    return get_string('sitecontentnotfound', 'mahara', get_string($pagename));
Richard Mansfield's avatar
Richard Mansfield committed
638
639
}

640
641
642
643
644
645
646
/**
 * This function returns the list of plugintypes we currently care about
 * @return array of names
 */
function plugin_types() {
    static $pluginstocheck;
    if (empty($pluginstocheck)) {
647
        $pluginstocheck = array('artefact', 'auth', 'notification', 'search');
648
649
650
651
    }
    return $pluginstocheck;
}

652
653
654
655
656
657
658
/** 
 * This return returns the names of plugins installed 
 * for the given plugin type.
 * 
 * @param string $plugintype type of plugin
 */
function plugins_installed($plugintype) {
659
    return get_records_array($plugintype . '_installed');
660
661
}

662
663
664
665
666
667
668
669
670
671
672
/**
 * 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);
}

673
674
675
676
677
function generate_class_name() {
    $args = func_get_args();
    return 'Plugin' . implode('', array_map('ucfirst', $args));
}

678
679
680
681
function generate_artefact_class_name($type) {
    return 'ArtefactType' . ucfirst($type);
}

682
683
684
685
686
687
688
689
690
function redirect($location) {
    if (headers_sent()) {
        throw new Exception('Headers already sent when redirect() was called');
    }
    header('HTTP/1.1 303 See Other');
    header('Location:' . $location);
    exit;
}

Martyn Smith's avatar
Martyn Smith committed
691
function handle_event($event) {
Penny Leach's avatar
Penny Leach committed
692
    if (!$e = get_record('event_type','name',$event)) {
Martyn Smith's avatar
Martyn Smith committed
693
        throw new Exception("Invalid event");
Penny Leach's avatar
Penny Leach committed
694
695
696
    }
    $plugintypes = plugin_types();
    foreach ($plugintypes as $name) {
697
        if ($subs = get_records_array('event_subscription_' . $name, 'event', $event)) {
Penny Leach's avatar
Penny Leach committed
698
699
700
            foreach ($subs as $sub) {
                $classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
                try {
Martyn Smith's avatar
Martyn Smith committed
701
                    call_static_method($classname, $sub->callfunction);
Penny Leach's avatar
Penny Leach committed
702
703
704
705
706
707
708
709
710
711
                }
                catch (Exception $e) {
                    log_warn("Event $event caused an exception from plugin $classname "
                             . "with function $sub->callfunction. Continuing with event handlers");
                }
            }
        }
    }
}

Nigel McNie's avatar
Nigel McNie committed
712
713
714
715
716
717
718
719
720
721
/**
 * Returns a string, HTML escaped
 *
 * @param string $text The text to escape
 * @return string      The text, HTML escaped
 */
function hsc ($text) {
    return htmlspecialchars($text, ENT_COMPAT, 'UTF-8');
}

722
723
724
725
726
727
728
729
730
731
732
733
734
735
/**
 * 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
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
/** 
 * Adds stuff to the log
 * @todo write this functino
 *
 * @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) {

}

751
752
753
754
/**
 * Used by XMLDB
 */
function debugging ($message, $level) {
755
    log_debug($message);
756
757
758
759
760
761
}
function xmldb_dbg($message) {
    log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');

762
763
764
/** 
 * Base class for all plugintypes.
 */
765
class Plugin {
766
767
768
769
770
771
772
773
774
775
776
777
    
    public static function get_cron() {
        return array();
    }

    public static function get_event_subscriptions() {
        return array();
    }

    public static function postinst() {
        return true;
    }
778
779
780
781

    public static function has_config() {
        return false;
    }
782
783
}

Martyn Smith's avatar
Martyn Smith committed
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
/**
 * Builds the admin navigation menu and returns it as a data structure
 *
 * @return $adminnav a data structure containing the admin navigation
 */
function admin_nav() {
    $wwwroot = get_config('wwwroot');

    $menu = array(
        array(
            'name'     => 'adminhome',
            'section'  => 'admin',
            'link'     => $wwwroot . 'admin/',
        ),
        array(
            'name'     => 'siteoptions',
            'section'  => 'admin',
            'link'     => $wwwroot . 'admin/options/',
        ),
803
804
805
806
807
        array(
            'name'     => 'institutions',
            'section'  => 'admin',
            'link'     => $wwwroot . 'admin/institutions.php',
        ),
Martyn Smith's avatar
Martyn Smith committed
808
        array(
809
810
811
812
813
814
            'name'     => 'pageeditor',
            'section'  => 'admin',
            'link'     => $wwwroot . 'admin/editsitepage.php',
        ),
        array(
            'name'     => 'menueditor',
Martyn Smith's avatar
Martyn Smith committed
815
            'section'  => 'admin',
816
            'link'     => $wwwroot . 'admin/editmenu.php',
Martyn Smith's avatar
Martyn Smith committed
817
        ),
818
819
820
821
822
        array(
            'name'     => 'adminplugins',
            'section'  => 'admin',
            'link'     => $wwwroot . 'admin/plugins/',
        ),
Martyn Smith's avatar
Martyn Smith committed
823
824
825
826
827
828
829
830
        array(
            'name'     => 'files',
            'section'  => 'admin',
            'link'     => $wwwroot . 'admin/todo',
        ),
        array(
            'name'     => 'usermanagement',
            'section'  => 'admin',
831
832
833
            'link'     => $wwwroot . 'admin/usermanagement/uploadcsv.php',
            'submenu'  => array(
                array(
834
                    'name' => 'uploadcsv',
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
                    'section' => 'admin',
                    'link' => $wwwroot . 'admin/usermanagement/uploadcsv.php'
                ),
                array(
                    'name' => 'adminusers',
                    'section' => 'admin',
                    'link' => $wwwroot . 'admin/usermanagement/adminusers.php',
                ),
                array(
                    'name' => 'staffusers',
                    'section' => 'admin',
                    'link' => $wwwroot . 'admin/usermanagement/staffusers.php'
                ),
                array(
                    'name' => 'adminnotifications',
                    'section' => 'admin',
                    'link' => $wwwroot . 'admin/usermanagement/adminnotifications.php'
                ),
                array(
                    'name' => 'suspendedusers',
                    'section' => 'admin',
                    'link' => $wwwroot . 'admin/usermanagement/suspendedusers.php'
                )
            )
Martyn Smith's avatar
Martyn Smith committed
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
        ),
    );

    if (defined('MENUITEM')) {
        foreach ( $menu as &$item ) {
            if ($item['name'] == MENUITEM) {
                $item['selected'] = true;
                if (defined('SUBMENUITEM') and is_array($item['submenu'])) {
                    foreach ( $item['submenu'] as &$subitem ) {
                        if ($subitem['name'] == SUBMENUITEM) {
                            $subitem['selected'] = true;
                        }
                    }
                }
            }
        }
    }

    return $menu;
}

880
881
882
883
884
885
886
887
888
/**
 * Builds the main navigation menu and returns it as a data structure
 *
 * @return $mainnav a data structure containing the main navigation
 * @todo martyn this is probably quite expenvise, perhaps it needs teh caching
 */
function main_nav() {
    $wwwroot = get_config('wwwroot');

Martyn Smith's avatar
Martyn Smith committed
889
890
891
892
    if (defined('ADMIN')) {
        return admin_nav();
    }

893
894
895
    $menu = array(
        array(
            'name'     => 'home',
Martyn Smith's avatar
Martyn Smith committed
896
            'section'  => 'mahara',
897
898
899
900
            'link'     => $wwwroot,
        ),
    );

901
    if ($plugins = get_records_array('artefact_installed')) {
902
        foreach ($plugins as &$plugin) {
903
904
            safe_require('artefact', $plugin->name, 'lib.php', 'require_once');
            $plugin_menu = call_static_method(generate_class_name('artefact',$plugin->name), 'menu_items');
905
906

            foreach ($plugin_menu as &$menu_item) {
907
908
                $menu_item['link'] = $wwwroot . 'artefact/' . $plugin->name . '/' . $menu_item['link'];
                $menu_item['section'] = 'artefact.' . $plugin->name;
909
910
911
912
913
914
915
            }

            $menu = array_merge($menu, $plugin_menu);
        }
    }

    $menu[] = array(
Martyn Smith's avatar
Martyn Smith committed
916
917
918
        'name'    => 'mycontacts',
        'link'    => $wwwroot . 'contacts/',
        'section' => 'mahara',
Martyn Smith's avatar
Martyn Smith committed
919
        'submenu' => array(
Martyn Smith's avatar
Martyn Smith committed
920
            array(
Martyn Smith's avatar
Martyn Smith committed
921
922
923
924
                'name'    => 'myfriends',
                'link'    => $wwwroot . 'contacts/',
                'section' => 'mahara',
            ),
Martyn Smith's avatar
Martyn Smith committed
925
            array(
Martyn Smith's avatar
Martyn Smith committed
926
927
928
929
                'name'    => 'myaddressbook',
                'link'    => $wwwroot . 'contacts/addressbook/',
                'section' => 'mahara',
            ),
Martyn Smith's avatar
Martyn Smith committed
930
            array(
Martyn Smith's avatar
Martyn Smith committed
931
932
933
934
                'name'    => 'mycommunities',
                'link'    => $wwwroot . 'contacts/communities/',
                'section' => 'mahara',
            ),
Martyn Smith's avatar
Martyn Smith committed
935
            array(
Martyn Smith's avatar
Martyn Smith committed
936
937
938
939
                'name'    => 'myownedcommunities',
                'link'    => $wwwroot . 'contacts/communities/owned.php',
                'section' => 'mahara',
            ),
Martyn Smith's avatar
Martyn Smith committed
940
            array(
Martyn Smith's avatar
Martyn Smith committed
941
942
943
944
945
                'name'    => 'mygroups',
                'link'    => $wwwroot . 'contacts/groups/',
                'section' => 'mahara',
            ),
        ),
946
    );
Richard Mansfield's avatar
Richard Mansfield committed
947
948
949
950
951
    $menu[] = array(
        'name'    => 'myviews',
        'link'    => $wwwroot . 'view/',
        'section' => 'mahara',
    );
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
    $menu[] = array(
        'name'    => 'account',
        'link'    => $wwwroot . 'account/',
        'section' => 'mahara',
        'submenu' => array(
            array(
                'name'    => 'accountprefs',
                'link'    => $wwwroot . 'account/',
                'section' => 'mahara',
            ),
            array(
                'name'    => 'activity',
                'link'    => $wwwroot . 'account/activity/',
                'section' => 'mahara',
            ),
            array(
                'name'    => 'activityprefs',
969
                'link'    => $wwwroot . 'account/activity/preferences/',
970
971
                'section' => 'mahara',
            ),
972
973
974
975
976
            array(
                'name'    => 'watchlist',
                'link'    => $wwwroot . 'account/watchlist/',
                'section' => 'mahara',
            ),
977
978
        ),
    );
979
980
981
982
983
984


    if (defined('MENUITEM')) {
        foreach ( $menu as &$item ) {
            if ($item['name'] == MENUITEM) {
                $item['selected'] = true;
Martyn Smith's avatar
Martyn Smith committed
985
986
987
988
989
990
991
                if (defined('SUBMENUITEM') and is_array($item['submenu'])) {
                    foreach ( $item['submenu'] as &$subitem ) {
                        if ($subitem['name'] == SUBMENUITEM) {
                            $subitem['selected'] = true;
                        }
                    }
                }
992
993
994
995
996
997
998
999
1000
1001
            }
        }
    }
    else {
        $menu[0]['selected'] = true;
    }

    return $menu;
}

1002
1003
1004
1005
1006
1007
/**
 * Site-level sidebar menu (list of links)
 * There is no admin files table yet so just get the urls.
 * @return $menu a data structure containing the site menu
 */
function site_menu() {
1008
    global $USER;
1009
    $menu = array();
1010
    if ($menuitems = get_records_array('site_menu','public',(int) !$USER->is_logged_in(),'displayorder')) {
1011
1012
1013
1014
1015
1016
1017
1018
1019
        foreach ($menuitems as $i) {
            if ($i->url) {
                $menu[] = array('name' => $i->title,
                                'link' => $i->url);
            }
        }
    }
    return $menu;
}
Richard Mansfield's avatar
Richard Mansfield committed
1020
1021


1022
1023
1024
/** 
 * Always use this function for all emails to users
 * 
1025
 * @param object $userto user object to send email to. must contain firstname,lastname,preferredname,email
1026
1027
1028
1029
 * @param object $userfrom user object to send email from. If null, email will come from mahara
 * @param string $subject email subject
 * @param string $messagetext text version of email
 * @param string $messagehtml html version of email (will send both html and text)
1030
 * @throws EmailException
1031
 */ 
1032
1033
1034
1035
1036
1037
1038
1039
function email_user($userto, $userfrom, $subject, $messagetext, $messagehtml='') {

    if (empty($userto)) {
        throw new InvalidArgumentException("empty user given to email_user");
    }
    
    require_once('phpmailer/class.phpmailer.php');

1040
    $mail = new phpmailer();
1041
1042

    $mail->Version = 'Mahara ' . get_config('release'); 
1043
    $mail->PluginDir = get_config('libroot')  . 'phpmailer/';
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
    
    $mail->CharSet = 'UTF-8';

    $smtphosts = get_config('smtphosts');
    if ($smtphosts == 'qmail') {
        // use Qmail system
        $mail->IsQmail();
    } 
    else if (empty($smtphosts)) {
        // use PHP mail() = sendmail
        $mail->IsMail();
    }
    else {
        $mail->IsSMTP();
        // use SMTP directly
        $mail->Host = get_config('smtphosts');
        if (get_config('smtpuser')) {
            // Use SMTP authentication
            $mail->SMTPAuth = true;
            $mail->Username = get_config('smtpuser');
            $mail->Password = get_config('smtppass');
        }
    }

    if (empty($userfrom)) {
        $mail->Sender = get_config('noreplyaddress');
        $mail->From = $mail->Sender;
        $mail->FromName = get_string('emailname');
    }
    else {
        $mail->Sender = $userfrom->email;
        $mail->From = $mail->Sender;
1076
        $mail->FromName = display_name($userfrom, $userto);
1077
1078
1079
1080
1081
1082
    }
           
    $mail->AddReplyTo($mail->From, $mail->FromName);

    $mail->Subject = substr(stripslashes($subject), 0, 78);

1083
    $usertoname = display_name($userto, $userto);
1084
1085
1086
1087
    $mail->AddAddress($userto->email, $usertoname );

    $mail->WordWrap = 79;   

1088
    if ($messagehtml) { 
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
        $mail->IsHTML(true);
        $mail->Encoding = 'quoted-printable';
        $mail->Body    =  $messagehtml;
        $mail->AltBody =  "\n$messagetext\n";
    } 
    else {
        $mail->IsHTML(false);
        $mail->Body =  "\n$messagetext\n";
    }

    if ($mail->Send()) {
        return true;
    } 
1102
    throw new EmailException("Couldn't send email to $usertoname with subject $subject. "
1103
1104
1105
                        . "Error from phpmailer was: " . $mail->ErrorInfo );
}

1106
1107
1108
1109
/**
 * converts a user object to a string representation of the user suitable for
 * the current user (or specified user) to see
 *
1110
1111
1112
 * Both parameters should be objects containing id, preferredname, firstname,
 * lastname, admin
 *
1113
1114
 * @param object the user that you're trying to format to a string
 * @param object the user that is looking at the string representation (if left
1115
 * blank, will default to the currently logged in user).
1116
1117
1118
 *
 * @returns string name to display
 */
1119
1120
1121
1122
function display_name($user, $userto=null) {
    global $USER;
    
    if (empty($userto)) {
1123
1124
1125
1126
1127
        $userto = new StdClass;
        $userto->id            = $USER->get('id');
        $userto->preferredname = $USER->get('preferredname');
        $userto->firstname     = $USER->get('firstname');
        $userto->lastname      = $USER->get('lastname');
1128
        $userto->admin         = $USER->get('admin');
1129
    }
1130
1131
1132
    if (is_array($user)) {
        $user = (object)$user;
    }
1133
1134
1135
1136
1137
1138
    else if (is_numeric($user)) {
        $user = get_record('usr', 'id', $user);
    }
    if (!is_object($user)) {
        throw new InvalidArgumentException("Invalid user passed to display_name");
    }
1139

1140
1141
1142
1143
1144
    // if they don't have a preferred name set, just return here
    if (empty($user->preferredname)) {
        return $user->firstname . ' ' . $user->lastname;
    }

1145
1146
1147
1148
    if ($userto->admin) {
        return $user->preferredname . ' (' . $user->firstname . ' ' . $user->lastname . ')';
    }

1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
    $prefix = get_config('dbprefix');
    $sql = 'SELECT c1.member
            FROM ' . $prefix . 'community_member c1 
            JOIN  ' .$prefix. 'community_member c2
                ON c1.community = c2.community 
            WHERE c1.member = ? AND c2.member = ? AND c2.tutor = ?';
    if (record_exists_sql($sql, array($user->id, $userto->id, 1))) {
        return $user->preferredname . ' (' . $user->firstname . ' ' . $user->lastname . ')';
    }
    return  $user->preferredname;
1159
1160
}

1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
/**
 * 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') {
    return strftime(get_string($formatkey), $date);
}

1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
/**
 * Returns a random string suitable for registration/change password requests
 *
 * @return string
 */
function get_random_key() {
    $pool = array_merge(
        range('A', 'Z'),
        range('a', 'z'),
        range(0, 9)
    );
    shuffle($pool);
    $result = '';
    for ($i = 0; $i < 16; $i++) {
        $result .= $pool[$i];
    }
    return $result;
}

1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
/**
 * 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
 *
1213
1214
1215
 * @param Pieform $form         The form to validate
 * @param array $values         The values passed through
 * @param string $authplugin    The authentication plugin that the user uses
1216
 */
1217
1218
function password_validate(Pieform $form, $values, $username, $institution) {
    $authtype  = auth_get_authtype_for_institution($institution);
1219
    $authclass = 'Auth' . ucfirst($authtype);
1220
    safe_require('auth', $authtype);
1221
    if (!$form->get_error('password1') && !call_static_method($authclass, 'is_password_valid', ($values['password1']))) {
1222
        $form->set_error('password1', get_string('passwordinvalidform', "auth.$authtype"));
1223
1224
1225
    }

    $suckypasswords = array(
1226
        'mahara', 'password', $username
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
    );
    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'));
    }
}

1237
1238
1239
function rebuild_artefact_parent_cache_dirty() {
    // this will give us a list of artefacts, as the first returned column
    // is not unqiue, but that's ok, it's what we want.
1240
    if (!$dirty = get_records_array('artefact_parent_cache', 'dirty', 1)) {
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
        return;
    }
    db_begin();
    delete_records('artefact_parent_cache', 'dirty', 1);
    foreach ($dirty as $d) {
        $parentids = array();
        $current = $d->artefact;
        while (true) {
            if (!$parent = get_record('artefact', 'id', $current)) {
                break;
            }
            if (!$parent->parent) {
                break;
            }
            $parentids[] = $parent->parent;
            $current = $parent->parent;
        }
        foreach ($parentids as $p) {
            $apc = new StdClass;
            $apc->artefact = $d->artefact;
            $apc->parent   = $p;
            $apc->dirty    = 0;
            insert_record('artefact_parent_cache', $apc);
        }
    }
    db_commit();
}

function rebuild_artefact_parent_cache_complete() {
    db_begin();
    delete_records('artefact_parent_cache');
1272
    $artefacts = get_records_array('artefact');
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
    foreach ($artefacts as $a) {
        $parentids = array();
        $current = $a->id;
        while (true) {
            if (!$parent = get_record('artefact', 'id', $current)) {
                break;
            }
            if (!$parent->parent) {
                break;
            }
            $parentids[] = $parent->parent;
            $current = $parent->parent;
        }
        foreach ($parentids as $p) {
            $apc = new StdClass;
            $apc->artefact = $a->id;
            $apc->parent   = $p;
            $apc->dirty    = 0;
            insert_record('artefact_parent_cache', $apc);
        }
    }
    db_commit();
}

1297
1298
1299
1300
1301
1302
1303
function artefact_instance_from_id($id) {
    $prefix = get_config('dbprefix');
    $sql = 'SELECT a.*, i.plugin 
            FROM ' . $prefix . 'artefact a 
            JOIN ' . $prefix . 'artefact_installed_type i ON a.artefacttype = i.name
            WHERE a.id = ?';
    if (!$data = get_record_sql($sql, array($id))) {
Penny Leach's avatar
Penny Leach committed
1304
        throw new ArtefactNotFoundException(get_string('artefactnotfound', 'mahara', $id));
1305
1306
1307
1308
1309
1310
    }
    $classname = generate_artefact_class_name($data->artefacttype);
    safe_require('artefact', $data->plugin);
    return new $classname($id, $data);
}

1311
1312
1313
/**
 * Configures a default form
 */
1314
function pieform_configure() {
1315
    global $USER;
1316
1317
1318
1319
    return array(
        'method' => 'post',
        'action' => '',
        'autofocus' => true,
1320
1321
1322
        'renderer' => 'maharatable',
        'preajaxsubmitcallback' => 'processingStart',
        'postajaxsubmitcallback' => 'processingStop',
1323
1324
1325
        'elements' => array(
            'sesskey' => array(
                'type' => 'hidden',
1326
                'value' => $USER->get('sesskey')
1327
1328
1329
1330
1331
            )
        )
    );
}

1332
function searchform() {
1333
1334
    require_once('pieforms/pieform.php');
    return pieform(array(
1335
        'name'                => 'searchform',
Richard Mansfield's avatar
Richard Mansfield committed
1336
        'action'              => get_config('wwwroot') . 'user/search.php',
1337
1338
1339
1340
1341
1342
        'elements'            => array(
            'query' => array(
                'type'           => 'text',
                'defaultvalue'   => '',
            ),
        )
1343
    ));
1344
1345
}

1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
/**
 * 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.
 */
function can_view_view($view_id, $user_id = null) {
    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,
            ' . 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() );

    log_debug('Can you look at this view? (you are user ' . $user_id . ')');

    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;

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

    // 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
        )
    )
    {

        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
        )
    )
    {

        log_debug(