mahara.php 18.6 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


/**
 * This function checks core and plugins
 * for which need to be upgraded/installed
 * @returns array of objects
 */
Penny Leach's avatar
Penny Leach committed
35
function check_upgrades($name = null) {
36
    $toupgrade = array();
37
    $installing = false;
38

39
    require('version.php');
40
    // check core first...
Penny Leach's avatar
Penny Leach committed
41
    if (empty($name) || $name == 'core') {
42
43
44
45
46
47
48
        try {
            $coreversion = get_config('version');
        } 
        catch (Exception $e) {
            $coreversion = 0;
        }
        if (empty($coreversion)) {
Penny Leach's avatar
Penny Leach committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
            $core = new StdClass;
            $core->install = true;
            $core->to = $config->version;
            $core->torelease = $config->release;
            $toupgrade['core'] = $core;
            $installing = true;
        } 
        else if ($config->version > $coreversion) {
            $core = new StdClass;
            $core->upgrade = true;
            $core->from = $coreversion;
            $core->fromrelease = get_config('release');
            $core->to = $config->version;
            $core->torelease = $config->release;
            $toupgrade['core'] = $core;
        }
    }

    $plugins = array();
    if (strpos($name,'artefact.') === 0) {
        $plugins[] = substr($name,9);
70
    } 
Penny Leach's avatar
Penny Leach committed
71
72
73
74
75
76
77
78
79
80
81
    else if (empty($name)) {
        // artefact plugins next..
        $dirhandle = opendir(get_config('docroot').'artefact/');
        while (false !== ($dir = readdir($dirhandle))) {
            if (strpos($dir,'.') === 0) {
                continue;
            }
            if (!empty($installing) && $dir != 'internal') {
                continue;
            }
            $plugins[] = $dir;
82
        }
Penny Leach's avatar
Penny Leach committed
83
84
85
86
    }

    foreach ($plugins as $dir) {
        require(get_config('docroot') . 'artefact/' . $dir . '/version.php');
87
88
        $pluginversion = 0;
        try {
Penny Leach's avatar
Penny Leach committed
89
            $pluginversion = get_config_plugin('arfetact', $dir, 'version');
90
        }
Penny Leach's avatar
Penny Leach committed
91
        catch (Exception $e) { }
92
        if (empty($pluginversion)) {
93
94
            $plugin = new StdClass;
            $plugin->install = true;
95
96
97
            $plugin->to = $config->version;
            $plugin->torelease = $config->release;
            $toupgrade['artefact.' . $dir] = $plugin;
98
        }
99
100
101
102
        else if ($config->version > $pluginversion) {
            $plugin = new StdClass;
            $plugin->upgrade = true;
            $plugin->from = $pluginversion;
Penny Leach's avatar
Penny Leach committed
103
104
105
106
            try {
                $plugin->fromrelease = get_config_plugin('artefact',$dir,'release');
            }
            catch (Exception $e) { }
107
108
109
110
            $plugin->to = $config->version;
            $plugin->torelease = $config->release;
            $toupgrade['artefact.' . $dir] = $plugin;
        } 
111
112
    }

Penny Leach's avatar
Penny Leach committed
113
114
115
116
117
118
119
120
121
122
    // if we've just asked for one, don't return an array...
    if (!empty($name) && count($toupgrade) == 1) {
        $upgrade = new StdClass;
        $upgrade->name = $name;
        foreach ((array)$toupgrade[$name] as $key => $value) {
            $upgrade->{$key} = $value;
        }    
        return $upgrade;
    }

123
124
125
    return $toupgrade;
}

Penny Leach's avatar
Penny Leach committed
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
function upgrade_core($upgrade) {

    $location = get_config('libroot') . '/db/';
    
    if (!empty($upgrade->install)) {
        $status = install_from_xmldb_file($location . 'install.xml'); 
    }
    else {
        require_once($location . 'upgrade.php');
        $status = xmldb_core_upgrade($upgrade->from);
    }
    if (!$status) {
        throw new DatalibException("Failed to upgrade core");
    }

    $status = set_config('version', $upgrade->to);
    $status = $status && set_config('release', $upgrade->torelease);
    return $status;
}

function upgrade_plugin($upgrade) {
    
    $plugintype = '';
    $pluginname = '';

    if (strpos($upgrade->name,'artefact.') === 0) {
        $pluginname = substr($upgrade->name,9);
        $plugintype = 'artefact';
    }

    $location = get_config('dirroot') . $plugintype . '/' . $pluginname . '/db/';
    
    if (!empty($upgrade->install)) {
159
160
161
        // @todo check file exists first - reasonable for it not to have 
        // db tables at all. should still insert version number and cron etc
        // @todo add to installed_artefacts
Penny Leach's avatar
Penny Leach committed
162
163
164
165
        $status = install_from_xmldb_file($location . 'install.xml'); 
    }
    else {
        require_once($location . 'upgrade.php');
166
167
        // @todo check file exists first - reasonable for it not to have 
        // db tables at all. should still insert version number and cron etc
Penny Leach's avatar
Penny Leach committed
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
        $function = 'xmldb_' . $plugintype . '_' . $pluginname . '_upgrade';
        $status = $function($upgrade->from);
    }
    
    if (!$status) {
        throw new DatalibException("Failed to upgrade $upgrade->name");
    }
    
    $status = set_config_plugin($plugintype,$pluginname,'version',$upgrade->to);
    $status = $status && set_config_plugin($plugintype,$pluginname,'release',$upgrade->torelease);

    // @todo here is where plugins register events and set their crons up
    
    return $status;
}

184
185
186
187
188
189
190
191
192
/** 
 * work around silly php settings
 * and broken setup stuff about the install
 * and raise a warning/fail depending on severity
 */
function ensure_sanity() {

    // register globals workaround
    if (ini_get_bool('register_globals')) {
193
        log_environ(get_string('registerglobals', 'error'));
194
195
196
197
198
199
200
201
        $massivearray = array_keys(array_merge($_POST,$_GET,$_COOKIE,$_SERVER,$_REQUEST,$_FILES));
        foreach ($massivearray as $tounset) {
            unset($GLOBALS[$tounset]);
        }
    }

    // magic_quotes_gpc workaround
    if (ini_get_bool('magic_quotes_gpc')) {
202
        log_environ(get_string('magicquotesgpc', 'error'));
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        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]);
            }
        }
    }

222
    if (ini_get_bool('magic_quotes_runtime')) {
223
224
225
226
227
228
229
230
231
        // 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'));
232
233
    }

234
235
236
    if (ini_get_bool('safe_mode')) {
        // We don't run with safe mode
        throw new ConfigSanityException(get_string('safemodeon', 'error'));
237
238
    }

239
240
241
242
243
244
245
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

246
247
    // dataroot inside document root.
    if (strpos(get_config('dataroot'),get_config('docroot')) !== false) {
248
        throw new ConfigSanityException(get_string('datarootinsidedocroot','error'));
249
250
    }

251
252
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
253
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
254
    }
255
256
257
258
259

    // Json functions not available
    if (!function_exists('json_encode') || !function_exists('json_decode')) {
        throw new ConfigSanityException(get_string('jsonextensionnotloaded', 'error'));
    }
260
261
262
263
    
    check_dir_exists(get_config('dataroot').'smarty/compile');
    check_dir_exists(get_config('dataroot').'smarty/cache');

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
function get_string($identifier,$section) {

    $langconfigstrs = array('parentlanguage', 'strftimedate', 'strftimedateshort', 'strftimedatetime',
                            'strftimedaydate', 'strftimedaydatetime', 'strftimedayshort', 'strftimedaytime',
                            'strftimemonthyear', 'strftimerecent', 'strftimerecentfull', 'strftimetime',
                            'thislanguage');

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

    $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.
    } else {
        $variables = array();
    }
    
    $lang = current_language();

    if ($section == '') {
        $section = 'mahara';
    }

    // Define the locations of language strings for this section
    $docroot = get_config('docroot');
    $locations = array();
    
    if ($section == 'mahara' || $section != 'langconfig') {
Penny Leach's avatar
Penny Leach committed
296
        $locations[] = $docroot.'lang/';
297
298
299
300
301
302
303
304
305
    } else {
        $extras = array('artefacts','auth'); // more later..
        foreach ($extras as $tocheck) {
            if (strpos($section,$tocheck.'.') === 0) {
                $pluginname = substr($section,strlen($tocheck));
                $locations[] = $docroot.$tocheck.'/'.$pluginname.'/lang/';
            }
        }
    }
306

307
308
309
310
    // First check all the normal locations for the string in the current language
    foreach ($locations as $location) {
        //if local directory not found, or particular string does not exist in local direcotry
        $langfile = $location.$lang.'/'.$section.'.php';
Penny Leach's avatar
Penny Leach committed
311
        if (is_readable($langfile)) {
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
            if ($result = get_string_from_file($identifier, $langfile)) {
                return format_langstring($result,$variables);
            }
        }
    }

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

    // Is a parent language defined?  If so, try to find this string in a parent language file

    foreach ($locations as $location) {
        $langfile = $location.$lang.'/langconfig.php';
Penny Leach's avatar
Penny Leach committed
328
        if (is_readable($langfile)) {
329
330
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
                $langfile = $location.$parentlang.'/'.$section.'.php';
Penny Leach's avatar
Penny Leach committed
331
                if (is_readable($langfile)) {
332
333
334
335
336
337
338
339
340
341
342
343
                    if ($result = get_string_from_file($identifier, $langfile)) {
                        return format_langstring($result,$variables);
                    }
                }
            }
        }
    }

    /// Our only remaining option is to try English
    foreach ($locations as $location) {
        //if local_en not found, or string not found in local_en
        $langfile = $location.'en.utf8/'.$module.'.php';
Penny Leach's avatar
Penny Leach committed
344
        if (is_readable($langfile)) {
345
346
347
348
349
350
351
            if ($result = get_string_from_file($identifier, $langfile)) {
                return format_langstring($result,$variables);
            }
        }
    }

    return '[['.$identifier.']]';  // Last resort
352
}
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393



/**
 * 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
 *
394
 * @param string $ini_get_arg setting to look for
395
396
397
398
399
400
401
402
403
404
405
 * @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;
}

406
407
408
409
410
411
412
413
414
415
416
417
418
/**
 * 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 {
        $dbconfig = get_records('config');
    } 
419
    catch (DatalibException $e) {
420
421
422
423
424
        return false;
    }
    
    foreach ($dbconfig as $cfg) {
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $CFG->value) {
Penny Leach's avatar
Penny Leach committed
425
            // @todo warn that we're overriding db config with $CFG
426
427
428
429
430
431
432
433
434
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
435
436
437
438
439
440
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
441
442
443
444
445
446
447
448
function get_config($key) {
    global $CFG;
    if (array_key_exists($key,$CFG)) {
        return $CFG->$key;
    }
    return null;
}

449
450
451
452
453
454
455
456
457

/**
 * 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) {
Penny Leach's avatar
Penny Leach committed
458
459
460
461
462
463
464
465
466
467
468
469
470
    if (get_record('config','field',$key)) {
        if (set_field('config','value',$value,'field',$key)) {
            $status = true;
        }
    } 
    else {
        $config = new StdClass;
        $config->field = $key;
        $config->value = $value;
        $status = insert_record('config',$config);
    }

    if (!empty($status)) {
471
472
473
        $CFG->{$key} = $value;
        return true;
    }
Penny Leach's avatar
Penny Leach committed
474

475
476
477
478
479
480
481
482
483
484
485
486
487
488
    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;
489

490
491
492
493
494
495
496
    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};
    }
    
497
498
499
    // @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.
500
501
502
503
504
505
506
507
    if (!$value = get_field('config_'.$plugintype,'value','plugin',$pluginname,'field',$key)) {
        $value = null;
    } 
    
    $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
    return $value;
}

Penny Leach's avatar
Penny Leach committed
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
function set_config_plugin($plugintype, $pluginname, $key, $value) {
    $tablename = 'config_' . $plugintype;

    if (get_field($table,'value','plugin',$pluginname,'field',$key)) {
        if (set_field($table,'value',$key,'plugin',$pluginname, 'field',$value)) { 
            $status = true;
        }
    }
    else {
        $pconfig = new StdClass;
        $pconfig->plugin = $pluginname;
        $pconfig->field  = $key;
        $pconfig->value  = $value;
        $status = insert_record($table,$pconfig);
    }
    if ($status) {
        $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
        return true;
    }
    return false;
}

530
/**
531
532
533
534
535
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
536
537
538
539
540
541
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

542
/**
543
544
545
546
547
548
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
549
550
551
552
553
554
555
556
557
558
559
function current_language() {
    global $USER, $CFG;
    if (!empty($USER->lang)) {
        return $USER->lang;
    }
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

560
/**
561
562
563
564
565
566
 * 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
 */
567
568
569
570
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

571
572
573
574
575
576
577
578
579
580
581
582
583
/**
 * 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);
}

584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603


/**
 * 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); 
604
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
605
            // @todo has the umask been clobbered at this point, and is this a bad thing?
606
607
608
609
610
        }
    }
    return $status;
}

611
612
613
614
615
616
617
618
619
/**
 * Checks that a username is in valid form
 *
 * @todo need such a function for password too.
 */
function validate_username($username) {
    return preg_match('/^[a-zA-Z0-9_\.@]+$/', $username);
}

620
?>