mahara.php 15.2 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
36
37


/**
 * This function checks core and plugins
 * for which need to be upgraded/installed
 * @returns array of objects
 */
function check_upgrades() {

    $toupgrade = array();
38
    $installing = false;
39

40
    require('version.php');
41
42
43
44
    // check core first...
    if (!$coreversion = get_config('version')) {
        $core = new StdClass;
        $core->install = true;
45
46
        $core->to = $config->version;
        $core->torelease = $config->release;
47
        $toupgrade['core'] = $core;
48
        $installing = true;
49
    } 
50
51
52
53
54
55
56
57
    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;
58
59
60
    }

    // artefact plugins next..
61
62
63
64
    // Note: on initial installation each plugin configuration
    // version check will cause an exception, which is caught
    // just fine although it does show in the logs (with the
    // default logging configuration)
65
    $dirhandle = opendir(get_config('docroot').'artefact/');
66
    while (false !== ($dir = readdir($dirhandle))) {
67
68
69
        if (!empty($installing) && $dir != 'internal') {
            continue;
        }
70
        require(get_config('docroot').'artefact/'.$dir.'/version.php');
71
72
73
74
        $pluginversion = 0;
        try {
            $pluginversion = get_config_plugin('arfetact',$dir,'version');
        }
75
        catch (DatalibException $e) { 
76
            if (empty($installing)) {
Penny Leach's avatar
Penny Leach committed
77
78
                // it's ok to have an exception here
                // the table won't exist...
79
80
81
82
                throw $e;
            }
        }
        if (empty($pluginversion)) {
83
84
            $plugin = new StdClass;
            $plugin->install = true;
85
86
87
            $plugin->to = $config->version;
            $plugin->torelease = $config->release;
            $toupgrade['artefact.' . $dir] = $plugin;
88
        }
89
90
91
92
93
94
95
96
97
        else if ($config->version > $pluginversion) {
            $plugin = new StdClass;
            $plugin->upgrade = true;
            $plugin->from = $pluginversion;
            $plugin->fromrelease = get_config_plugin('artefact',$dir,'release');
            $plugin->to = $config->version;
            $plugin->torelease = $config->release;
            $toupgrade['artefact.' . $dir] = $plugin;
        } 
98
99
100
101
102
    }

    return $toupgrade;
}

103
104
105
106
107
108
109
110
111
/** 
 * 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')) {
112
        log_environ(get_string('registerglobals', 'error'));
113
114
115
116
117
118
119
120
        $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')) {
121
        log_environ(get_string('magicquotesgpc', 'error'));
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
        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]);
            }
        }
    }

141
    if (ini_get_bool('magic_quotes_runtime')) {
142
143
144
145
146
147
148
149
150
        // 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'));
151
152
    }

153
154
155
    if (ini_get_bool('safe_mode')) {
        // We don't run with safe mode
        throw new ConfigSanityException(get_string('safemodeon', 'error'));
156
157
    }

158
159
160
161
162
163
164
    // Other things that might be worth checking:
    //    memory limit
    //    file_uploads (off|on)
    //    upload_max_filesize
    //    allow_url_fopen (only if we use this)
    //

165
166
    // dataroot inside document root.
    if (strpos(get_config('dataroot'),get_config('docroot')) !== false) {
167
        throw new ConfigSanityException(get_string('datarootinsidedocroot','error'));
168
169
    }

170
171
    // dataroot not writable..
    if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
172
        throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
173
    }
174
175
176
177
178

    // Json functions not available
    if (!function_exists('json_encode') || !function_exists('json_decode')) {
        throw new ConfigSanityException(get_string('jsonextensionnotloaded', 'error'));
    }
179
180
181
182
    
    check_dir_exists(get_config('dataroot').'smarty/compile');
    check_dir_exists(get_config('dataroot').'smarty/cache');

183
184
}

185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
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
215
        $locations[] = $docroot.'lang/';
216
217
218
219
220
221
222
223
224
    } 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/';
            }
        }
    }
225

226
227
228
229
    // 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
230
        if (is_readable($langfile)) {
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
            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
247
        if (is_readable($langfile)) {
248
249
            if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
                $langfile = $location.$parentlang.'/'.$section.'.php';
Penny Leach's avatar
Penny Leach committed
250
                if (is_readable($langfile)) {
251
252
253
254
255
256
257
258
259
260
261
262
                    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
263
        if (is_readable($langfile)) {
264
265
266
267
268
269
270
            if ($result = get_string_from_file($identifier, $langfile)) {
                return format_langstring($result,$variables);
            }
        }
    }

    return '[['.$identifier.']]';  // Last resort
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312



/**
 * 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
 *
313
 * @param string $ini_get_arg setting to look for
314
315
316
317
318
319
320
321
322
323
324
 * @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;
}

325
326
327
328
329
330
331
332
333
334
335
336
337
/**
 * 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');
    } 
338
    catch (DatalibException $e) {
339
340
341
342
343
        return false;
    }
    
    foreach ($dbconfig as $cfg) {
        if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $CFG->value) {
344
            log_info('Overriding database configuration for ' . $cfg->field . ' with config file value ' . $cfg->field);
345
346
347
348
349
350
351
352
353
            continue;
        }
        $CFG->{$cfg->field} = $cfg->value;
    }

    return true;
}

/**
354
355
356
357
358
359
 * This function returns a value from $CFG
 * or null if it is not found
 * 
 * @param string $key config setting to look for 
 * @return mixed
 */
360
361
362
363
364
365
366
367
function get_config($key) {
    global $CFG;
    if (array_key_exists($key,$CFG)) {
        return $CFG->$key;
    }
    return null;
}

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
394

/**
 * 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) {
    if (set_field('config',$key,$value,'field',$key)) {
        $CFG->{$key} = $value;
        return true;
    }
    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;
395

396
397
398
399
400
401
402
    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};
    }
    
403
404
405
    // @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.
406
407
408
409
410
411
412
413
    if (!$value = get_field('config_'.$plugintype,'value','plugin',$pluginname,'field',$key)) {
        $value = null;
    } 
    
    $CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
    return $value;
}

414
/**
415
416
417
418
419
 * This function prints an array or object
 * wrapped inside <pre></pre>
 * 
 * @param $mixed value to print
 */
420
421
422
423
424
425
function print_object($mixed) {
    echo '<pre>';
    print_r($mixed);
    echo '</pre>';
}

426
/**
427
428
429
430
431
432
 * This function returns the current 
 * language to use, either for a given user
 * or sitewide, or the default
 * 
 * @return string
 */
433
434
435
436
437
438
439
440
441
442
443
function current_language() {
    global $USER, $CFG;
    if (!empty($USER->lang)) {
        return $USER->lang;
    }
    if (!empty($CFG->lang)) {
        return $CFG->lang;
    }
    return 'en.utf8';
}

444
/**
445
446
447
448
449
450
 * 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
 */
451
452
453
454
function format_langstring($string,$args) {
    return call_user_func_array('sprintf',array_merge(array($string),$args));
}

455
456
457
458
459
460
461
462
463
464
465
466
467
/**
 * 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);
}

468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487


/**
 * 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); 
488
            $status = @mkdir($dir, 0777, true);
Nigel McNie's avatar
Nigel McNie committed
489
            // @todo has the umask been clobbered at this point, and is this a bad thing?
490
491
492
493
494
        }
    }
    return $status;
}

495
?>