moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 00:46:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-20696 fixed coding style: lib/setup.php is the first file people start reading when hacking moodle, it has to use the best coding style possible ;-)

Browse source
This commit is contained in:
Petr Skoda 2009-10-31 22:35:06 +00:00
parent 47c2811b95
commit 4dffc77519
1 changed files with 481 additions and 485 deletions
Download patch file Download diff file Expand all files Collapse all files

140
lib/setup.php
View file

@ -176,7 +176,7 @@ if (!isset($CFG->wwwroot)) {
exit(1); exit(1);
} }
/// Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output
if (!defined('CLI_SCRIPT')) { // CLI_SCRIPT might be defined in 'fake' CLI scripts like admin/cron.php if (!defined('CLI_SCRIPT')) { // CLI_SCRIPT might be defined in 'fake' CLI scripts like admin/cron.php
if (isset($_SERVER['REMOTE_ADDR'])) { if (isset($_SERVER['REMOTE_ADDR'])) {
define('CLI_SCRIPT', false); define('CLI_SCRIPT', false);
@ -186,22 +186,20 @@ if (!isset($CFG->wwwroot)) {
} }
} }
/// sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that?? // sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that??
@ini_set('precision', 14); // needed for upgrades and gradebook @ini_set('precision', 14); // needed for upgrades and gradebook
// The current directory in PHP version 4.3.0 and above isn't necessarily the
/// The current directory in PHP version 4.3.0 and above isn't necessarily the // directory of the script when run from the command line. The require_once()
/// directory of the script when run from the command line. The require_once() // would fail, so we'll have to chdir()
/// would fail, so we'll have to chdir()
if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) { if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
chdir(dirname($_SERVER['argv'][0])); chdir(dirname($_SERVER['argv'][0]));
} }
// Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides
/// Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides
$CFG->config_php_settings = (array)$CFG; $CFG->config_php_settings = (array)$CFG;
/// Set up some paths. // Set up some paths.
$CFG->libdir = $CFG->dirroot .'/lib'; $CFG->libdir = $CFG->dirroot .'/lib';
if (!isset($CFG->themedir)) { if (!isset($CFG->themedir)) {
@ -209,34 +207,34 @@ if (!isset($CFG->wwwroot)) {
$CFG->themewww = $CFG->wwwroot.'/theme'; $CFG->themewww = $CFG->wwwroot.'/theme';
} }
/// Set httpswwwroot default value (this variable will replace $CFG->wwwroot // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
/// inside some URLs used in HTTPSPAGEREQUIRED pages. // inside some URLs used in HTTPSPAGEREQUIRED pages.
$CFG->httpswwwroot = $CFG->wwwroot; $CFG->httpswwwroot = $CFG->wwwroot;
$CFG->httpsthemewww = $CFG->themewww; $CFG->httpsthemewww = $CFG->themewww;
require_once($CFG->libdir .'/setuplib.php'); // Functions that MUST be loaded first require_once($CFG->libdir .'/setuplib.php'); // Functions that MUST be loaded first
/// Time to start counting // Time to start counting
init_performance_info(); init_performance_info();
/// Put $OUTPUT in place, so errors can be displayed. // Put $OUTPUT in place, so errors can be displayed.
$OUTPUT = new bootstrap_renderer(); $OUTPUT = new bootstrap_renderer();
/// set handler for uncought exceptions - equivalent to print_error() call // set handler for uncought exceptions - equivalent to print_error() call
set_exception_handler('default_exception_handler'); set_exception_handler('default_exception_handler');
/// If there are any errors in the standard libraries we want to know! // If there are any errors in the standard libraries we want to know!
error_reporting(E_ALL); error_reporting(E_ALL);
/// Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others) // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
/// http://www.google.com/webmasters/faq.html#prefetchblock // http://www.google.com/webmasters/faq.html#prefetchblock
if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){ if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden'); header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
echo('Prefetch request forbidden.'); echo('Prefetch request forbidden.');
exit(1); exit(1);
} }
/// Define admin directory // Define admin directory
if (!isset($CFG->admin)) { // Just in case it isn't defined in config.php if (!isset($CFG->admin)) { // Just in case it isn't defined in config.php
$CFG->admin = 'admin'; // This is relative to the wwwroot and dirroot $CFG->admin = 'admin'; // This is relative to the wwwroot and dirroot
} }
@ -245,7 +243,7 @@ if (!isset($CFG->wwwroot)) {
$CFG->prefix = ''; $CFG->prefix = '';
} }
/// Load up standard libraries // Load up standard libraries
require_once($CFG->libdir .'/textlib.class.php'); // Functions to handle multibyte strings require_once($CFG->libdir .'/textlib.class.php'); // Functions to handle multibyte strings
require_once($CFG->libdir .'/filterlib.php'); // Functions for filtering test as it is output require_once($CFG->libdir .'/filterlib.php'); // Functions for filtering test as it is output
require_once($CFG->libdir .'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI require_once($CFG->libdir .'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI
@ -270,16 +268,16 @@ if (!isset($CFG->wwwroot)) {
//point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path')); ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
/// make sure PHP is not severly misconfigured // make sure PHP is not severly misconfigured
setup_validate_php_configuration(); setup_validate_php_configuration();
/// Increase memory limits if possible // Increase memory limits if possible
raise_memory_limit('96M'); // We should never NEED this much but just in case... raise_memory_limit('96M'); // We should never NEED this much but just in case...
/// Connect to the database // Connect to the database
setup_DB(); setup_DB();
/// Disable errors for now - needed for installation when debug enabled in config.php // Disable errors for now - needed for installation when debug enabled in config.php
if (isset($CFG->debug)) { if (isset($CFG->debug)) {
$originalconfigdebug = $CFG->debug; $originalconfigdebug = $CFG->debug;
unset($CFG->debug); unset($CFG->debug);
@ -287,14 +285,14 @@ if (!isset($CFG->wwwroot)) {
$originalconfigdebug = -1; $originalconfigdebug = -1;
} }
/// Load up any configuration from the config table // Load up any configuration from the config table
try { try {
$CFG = get_config(); $CFG = get_config();
} catch (dml_read_exception $e) { } catch (dml_read_exception $e) {
// most probably empty db, going to install soon // most probably empty db, going to install soon
} }
/// Verify upgrade is not running unless we are in a script that needs to execute in any case // Verify upgrade is not running unless we are in a script that needs to execute in any case
if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) { if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
if ($CFG->upgraderunning < time()) { if ($CFG->upgraderunning < time()) {
unset_config('upgraderunning'); unset_config('upgraderunning');
@ -303,12 +301,12 @@ if (!isset($CFG->wwwroot)) {
} }
} }
/// Turn on SQL logging if required // Turn on SQL logging if required
if (!empty($CFG->logsql)) { if (!empty($CFG->logsql)) {
$DB->set_logging(true); $DB->set_logging(true);
} }
/// Prevent warnings from roles when upgrading with debug on // Prevent warnings from roles when upgrading with debug on
if (isset($CFG->debug)) { if (isset($CFG->debug)) {
$originaldatabasedebug = $CFG->debug; $originaldatabasedebug = $CFG->debug;
unset($CFG->debug); unset($CFG->debug);
@ -317,12 +315,12 @@ if (!isset($CFG->wwwroot)) {
} }
/// For now, only needed under apache (and probably unstable in other contexts) // For now, only needed under apache (and probably unstable in other contexts)
if (function_exists('register_shutdown_function')) { if (function_exists('register_shutdown_function')) {
register_shutdown_function('moodle_request_shutdown'); register_shutdown_function('moodle_request_shutdown');
} }
/// Defining the site // Defining the site
try { try {
$SITE = get_site(); $SITE = get_site();
} catch (dml_read_exception $e) { } catch (dml_read_exception $e) {
@ -334,14 +332,14 @@ if (!isset($CFG->wwwroot)) {
* If $SITE global from {@link get_site()} is set then SITEID to $SITE->id, otherwise set to 1. * If $SITE global from {@link get_site()} is set then SITEID to $SITE->id, otherwise set to 1.
*/ */
define('SITEID', $SITE->id); define('SITEID', $SITE->id);
/// And the 'default' course // And the 'default' course
$COURSE = clone($SITE); // For now. This will usually get reset later in require_login() etc. $COURSE = clone($SITE); // For now. This will usually get reset later in require_login() etc.
} else { } else {
/** /**
* @ignore * @ignore
*/ */
define('SITEID', 1); define('SITEID', 1);
/// And the 'default' course // And the 'default' course
$COURSE = new object; // no site created yet $COURSE = new object; // no site created yet
$COURSE->id = 1; $COURSE->id = 1;
} }
@ -351,7 +349,7 @@ if (!isset($CFG->wwwroot)) {
get_system_context(); get_system_context();
} }
/// Set error reporting back to normal // Set error reporting back to normal
if ($originaldatabasedebug == -1) { if ($originaldatabasedebug == -1) {
$CFG->debug = DEBUG_MINIMAL; $CFG->debug = DEBUG_MINIMAL;
} else { } else {
@ -385,17 +383,17 @@ if (!isset($CFG->wwwroot)) {
@ini_set('display_errors', '1'); @ini_set('display_errors', '1');
} }
/// detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
if (!empty($CFG->version) and $CFG->version < 2007101509) { if (!empty($CFG->version) and $CFG->version < 2007101509) {
print_error('upgraderequires19', 'error'); print_error('upgraderequires19', 'error');
die; die;
} }
/// Shared-Memory cache init -- will set $MCACHE // Shared-Memory cache init -- will set $MCACHE
/// $MCACHE is a global object that offers at least add(), set() and delete() // $MCACHE is a global object that offers at least add(), set() and delete()
/// with similar semantics to the memcached PHP API http://php.net/memcache // with similar semantics to the memcached PHP API http://php.net/memcache
/// Ensure we define rcache - so we can later check for it // Ensure we define rcache - so we can later check for it
/// with a really fast and unambiguous $CFG->rcache === false // with a really fast and unambiguous $CFG->rcache === false
if (!empty($CFG->cachetype)) { if (!empty($CFG->cachetype)) {
if (empty($CFG->rcache)) { if (empty($CFG->rcache)) {
$CFG->rcache = false; $CFG->rcache = false;
@ -427,31 +425,30 @@ if (!isset($CFG->wwwroot)) {
$CFG->rcache = false; $CFG->rcache = false;
} }
/// Set a default enrolment configuration (see bug 1598) // Set a default enrolment configuration (see bug 1598)
if (!isset($CFG->enrol)) { if (!isset($CFG->enrol)) {
$CFG->enrol = 'manual'; $CFG->enrol = 'manual';
} }
/// Set default enabled enrolment plugins // Set default enabled enrolment plugins
if (!isset($CFG->enrol_plugins_enabled)) { if (!isset($CFG->enrol_plugins_enabled)) {
$CFG->enrol_plugins_enabled = 'manual'; $CFG->enrol_plugins_enabled = 'manual';
} }
/// File permissions on created directories in the $CFG->dataroot // File permissions on created directories in the $CFG->dataroot
if (empty($CFG->directorypermissions)) { if (empty($CFG->directorypermissions)) {
$CFG->directorypermissions = 0777; // Must be octal (that's why it's here) $CFG->directorypermissions = 0777; // Must be octal (that's why it's here)
} }
if (empty($CFG->filepermissions)) { if (empty($CFG->filepermissions)) {
$CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags $CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags
} }
/// better also set default umask because recursive mkdir() does not apply permissions recursively otherwise // better also set default umask because recursive mkdir() does not apply permissions recursively otherwise
umask(0000); umask(0000);
/// Calculate and set $CFG->ostype to be used everywhere. Possible values are: // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
/// - WINDOWS: for any Windows flavour. // - WINDOWS: for any Windows flavour.
/// - UNIX: for the rest // - UNIX: for the rest
/// Also, $CFG->os can continue being used if more specialization is required // Also, $CFG->os can continue being used if more specialization is required
if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) { if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
$CFG->ostype = 'WINDOWS'; $CFG->ostype = 'WINDOWS';
} else { } else {
@ -459,25 +456,25 @@ if (!isset($CFG->wwwroot)) {
} }
$CFG->os = PHP_OS; $CFG->os = PHP_OS;
/// Set up default frame target string, based on $CFG->framename // Set up default frame target string, based on $CFG->framename
$CFG->frametarget = frametarget(); $CFG->frametarget = frametarget();
/// Setup cache dir for Smarty and others // Setup cache dir for Smarty and others
if (!file_exists($CFG->dataroot .'/cache')) { if (!file_exists($CFG->dataroot .'/cache')) {
make_upload_directory('cache'); make_upload_directory('cache');
} }
/// Configure ampersands in URLs // Configure ampersands in URLs
@ini_set('arg_separator.output', '&amp;'); @ini_set('arg_separator.output', '&amp;');
/// Work around for a PHP bug see MDL-11237 // Work around for a PHP bug see MDL-11237
@ini_set('pcre.backtrack_limit', 20971520); // 20 MB @ini_set('pcre.backtrack_limit', 20971520); // 20 MB
/// Location of standard files // Location of standard files
$CFG->wordlist = $CFG->libdir .'/wordlist.txt'; $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
$CFG->moddata = 'moddata'; $CFG->moddata = 'moddata';
/// Create the $PAGE global. // Create the $PAGE global.
if (!empty($CFG->moodlepageclass)) { if (!empty($CFG->moodlepageclass)) {
$classname = $CFG->moodlepageclass; $classname = $CFG->moodlepageclass;
} else { } else {
@ -486,8 +483,8 @@ if (!isset($CFG->wwwroot)) {
$PAGE = new $classname(); $PAGE = new $classname();
unset($classname); unset($classname);
/// A hack to get around magic_quotes_gpc being turned on // A hack to get around magic_quotes_gpc being turned on
/// It is strongly recommended to disable "magic_quotes_gpc"! // It is strongly recommended to disable "magic_quotes_gpc"!
if (ini_get_bool('magic_quotes_gpc')) { if (ini_get_bool('magic_quotes_gpc')) {
function stripslashes_deep($value) { function stripslashes_deep($value) {
$value = is_array($value) ? $value = is_array($value) ?
@ -519,7 +516,7 @@ if (!isset($CFG->wwwroot)) {
} }
} }
/// neutralise nasty chars in PHP_SELF // neutralise nasty chars in PHP_SELF
if (isset($_SERVER['PHP_SELF'])) { if (isset($_SERVER['PHP_SELF'])) {
$phppos = strpos($_SERVER['PHP_SELF'], '.php'); $phppos = strpos($_SERVER['PHP_SELF'], '.php');
if ($phppos !== false) { if ($phppos !== false) {
@ -528,15 +525,15 @@ if (!isset($CFG->wwwroot)) {
unset($phppos); unset($phppos);
} }
/// initialise ME's // initialise ME's
initialise_fullme(); initialise_fullme();
/// start session and prepare global $SESSION, $USER // start session and prepare global $SESSION, $USER
session_get_instance(); session_get_instance();
$SESSION = &$_SESSION['SESSION']; $SESSION = &$_SESSION['SESSION'];
$USER = &$_SESSION['USER']; $USER = &$_SESSION['USER'];
/// Process theme change in the URL. // Process theme change in the URL.
if (!empty($CFG->allowthemechangeonurl) && ($urlthemename = optional_param('theme', '', PARAM_SAFEDIR)) && confirm_sesskey()) { if (!empty($CFG->allowthemechangeonurl) && ($urlthemename = optional_param('theme', '', PARAM_SAFEDIR)) && confirm_sesskey()) {
try { try {
theme_config::load($urlthemename); // Makes sure the theme can be loaded without errors. theme_config::load($urlthemename); // Makes sure the theme can be loaded without errors.
@ -547,16 +544,16 @@ if (!isset($CFG->wwwroot)) {
} }
unset($urlthemename); unset($urlthemename);
/// Ensure a valid theme is set. // Ensure a valid theme is set.
if (!isset($CFG->theme)) { if (!isset($CFG->theme)) {
$CFG->theme = 'standardwhite'; $CFG->theme = 'standardwhite';
} }
/// Set language/locale of printed times. If user has chosen a language that // Set language/locale of printed times. If user has chosen a language that
/// that is different from the site language, then use the locale specified // that is different from the site language, then use the locale specified
/// in the language file. Otherwise, if the admin hasn't specified a locale // in the language file. Otherwise, if the admin hasn't specified a locale
/// then use the one from the default language. Otherwise (and this is the // then use the one from the default language. Otherwise (and this is the
/// majority of cases), use the stored locale specified by admin. // majority of cases), use the stored locale specified by admin.
if (($lang = optional_param('lang', '', PARAM_SAFEDIR))) { if (($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
if (file_exists($CFG->dataroot .'/lang/'. $lang) or if (file_exists($CFG->dataroot .'/lang/'. $lang) or
file_exists($CFG->dirroot .'/lang/'. $lang)) { file_exists($CFG->dirroot .'/lang/'. $lang)) {
@ -600,8 +597,8 @@ if (!isset($CFG->wwwroot)) {
} }
} }
/// Apache log intergration. In apache conf file one can use ${MOODULEUSER}n in // Apache log intergration. In apache conf file one can use ${MOODULEUSER}n in
/// LogFormat to get the current logged in username in moodle. // LogFormat to get the current logged in username in moodle.
if ($USER && function_exists('apache_note') if ($USER && function_exists('apache_note')
&& !empty($CFG->apacheloguser) && isset($USER->username)) { && !empty($CFG->apacheloguser) && isset($USER->username)) {
$apachelog_userid = $USER->id; $apachelog_userid = $USER->id;
@ -634,10 +631,10 @@ if (!isset($CFG->wwwroot)) {
apache_note('MOODLEUSER', $logname); apache_note('MOODLEUSER', $logname);
} }
/// Adjust ALLOWED_TAGS // Adjust ALLOWED_TAGS
adjust_allowed_tags(); adjust_allowed_tags();
/// Use a custom script replacement if one exists // Use a custom script replacement if one exists
if (!empty($CFG->customscripts)) { if (!empty($CFG->customscripts)) {
if (($customscript = custom_script_path()) !== false) { if (($customscript = custom_script_path()) !== false) {
require ($customscript); require ($customscript);
@ -694,6 +691,5 @@ if (!isset($CFG->wwwroot)) {
} }
/// note: we can not block non utf-8 installations here, because empty mysql database // note: we can not block non utf-8 installations here, because empty mysql database
/// might be converted to utf-8 in admin/index.php during installation // might be converted to utf-8 in admin/index.php during installation