Merge branch 'wip-mdl-31969' of git://github.com/rajeshtaneja/moodle
[moodle.git] / lib / db / install.php
CommitLineData
117bd748 1<?php
5b4a78e2 2// This file is part of Moodle - http://moodle.org/
1caea91e 3//
5b4a78e2
PS
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * This file is executed right after the install.xml
19 *
39b90b51
EL
20 * For more information, take a look to the documentation available:
21 * - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
22 *
23 * @package core_install
24 * @category upgrade
25 * @copyright 2009 Petr Skoda (http://skodak.org)
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5b4a78e2
PS
27 */
28
29defined('MOODLE_INTERNAL') || die();
1caea91e 30
39b90b51
EL
31/**
32 * Main post-install tasks to be executed after the BD schema is available
33 *
34 * This function is automatically executed after Moodle core DB has been
35 * created at initial install. It's in charge of perform the initial tasks
36 * not covered by the {@link install.xml} file, like create initial users,
37 * roles, templates, moving stuff from other plugins...
38 *
39 * Note that the function is only invoked once, at install time, so if new tasks
40 * are needed in the future, they will need to be added both here (for new sites)
41 * and in the corresponding {@link upgrade.php} file (for existing sites).
42 *
43 * All plugins within Moodle (modules, blocks, reports...) support the existence of
44 * their own install.php file, using the "Frankenstyle" component name as
45 * defined at {@link http://docs.moodle.org/dev/Frankenstyle}, for example:
46 * - {@link xmldb_page_install()}. (modules don't require the plugintype ("mod_") to be used.
47 * - {@link xmldb_enrol_meta_install()}.
48 * - {@link xmldb_workshopform_accumulative_install()}.
49 * - ....
50 *
51 * Finally, note that it's also supported to have one uninstall.php file that is
52 * executed also once, each time one plugin is uninstalled (before the DB schema is
53 * deleted). Those uninstall files will contain one function, using the "Frankenstyle"
54 * naming conventions, like {@link xmldb_enrol_meta_uninstall()} or {@link xmldb_workshop_uninstall()}.
55 */
c20ce874 56function xmldb_main_install() {
3912cdd1 57 global $CFG, $DB, $SITE, $OUTPUT;
1caea91e 58
39b90b51 59 // Make sure system context exists
e922fe23
PS
60 $syscontext = context_system::instance(0, MUST_EXIST, false);
61 if ($syscontext->id != SYSCONTEXTID) {
19e7a192 62 throw new moodle_exception('generalexceptionmessage', 'error', '', 'Unexpected new system context id!');
1caea91e 63 }
64
65
39b90b51 66 // Create site course
e922fe23
PS
67 if ($DB->record_exists('course', array())) {
68 throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create frontpage course, courses already exist.');
69 }
365a5941 70 $newsite = new stdClass();
19e7a192
PS
71 $newsite->fullname = '';
72 $newsite->shortname = '';
73 $newsite->summary = NULL;
74 $newsite->newsitems = 3;
ba0dde97 75 $newsite->numsections = 1;
19e7a192
PS
76 $newsite->category = 0;
77 $newsite->format = 'site'; // Only for this course
c4dd3bb8
PS
78 $newsite->timecreated = time();
79 $newsite->timemodified = $newsite->timecreated;
1caea91e 80
e922fe23
PS
81 if (defined('SITEID')) {
82 $newsite->id = SITEID;
83 $DB->import_record('course', $newsite);
84 $DB->get_manager()->reset_sequence('course');
85 } else {
86 $newsite->id = $DB->insert_record('course', $newsite);
87 define('SITEID', $newsite->id);
88 }
b5cf83f0
MG
89 // set the field 'numsections'. We can not use format_site::update_format_options() because
90 // the file is not loaded
91 $DB->insert_record('course_format_options', array('courseid' => SITEID, 'format' => 'site',
92 'sectionid' => 0, 'name' => 'numsections', 'value' => $newsite->numsections));
1caea91e 93 $SITE = get_site();
e922fe23 94 if ($newsite->id != $SITE->id) {
19e7a192 95 throw new moodle_exception('generalexceptionmessage', 'error', '', 'Unexpected new site course id!');
1caea91e 96 }
e922fe23
PS
97 // Make sure site course context exists
98 context_course::instance($SITE->id);
99 // Update the global frontpage cache
100 $SITE = $DB->get_record('course', array('id'=>$newsite->id), '*', MUST_EXIST);
1caea91e 101
102
39b90b51 103 // Create default course category
e922fe23
PS
104 if ($DB->record_exists('course_categories', array())) {
105 throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default course category, categories already exist.');
106 }
107 $cat = new stdClass();
108 $cat->name = get_string('miscellaneous');
109 $cat->depth = 1;
110 $cat->sortorder = MAX_COURSES_IN_CATEGORY;
111 $cat->timemodified = time();
112 $catid = $DB->insert_record('course_categories', $cat);
113 $DB->set_field('course_categories', 'path', '/'.$catid, array('id'=>$catid));
114 // Make sure category context exists
115 context_coursecat::instance($catid);
1caea91e 116
1caea91e 117
5b8fa09b 118 $defaults = array(
119 'rolesactive' => '0', // marks fully set up system
120 'auth' => 'email',
121 'auth_pop3mailbox' => 'INBOX',
df997f84 122 'enrol_plugins_enabled' => 'manual,guest,self,cohort',
5f0baa43 123 'theme' => theme_config::DEFAULT_THEME,
5b8fa09b 124 'filter_multilang_converted' => 1,
aa282b10 125 'siteidentifier' => random_string(32).get_host_from_url($CFG->wwwroot),
5b8fa09b 126 'backup_version' => 2008111700,
127 'backup_release' => '2.0 dev',
5b8fa09b 128 'mnet_dispatcher_mode' => 'off',
129 'sessiontimeout' => 7200, // must be present during roles installation
130 'stringfilters' => '', // These two are managed in a strange way by the filters
131 'filterall' => 0, // setting page, so have to be initialised here.
a5747cf8 132 'texteditors' => 'tinymce,textarea',
5b8fa09b 133 );
1caea91e 134 foreach($defaults as $key => $value) {
135 set_config($key, $value);
136 }
137
138
39b90b51 139 // Bootstrap mnet
365a5941 140 $mnethost = new stdClass();
1caea91e 141 $mnethost->wwwroot = $CFG->wwwroot;
142 $mnethost->name = '';
143 $mnethost->name = '';
144 $mnethost->public_key = '';
145
146 if (empty($_SERVER['SERVER_ADDR'])) {
147 // SERVER_ADDR is only returned by Apache-like webservers
148 preg_match("@^(?:http[s]?://)?([A-Z0-9\-\.]+).*@i", $CFG->wwwroot, $matches);
149 $my_hostname = $matches[1];
150 $my_ip = gethostbyname($my_hostname); // Returns unmodified hostname on failure. DOH!
151 if ($my_ip == $my_hostname) {
152 $mnethost->ip_address = 'UNKNOWN';
153 } else {
154 $mnethost->ip_address = $my_ip;
155 }
156 } else {
157 $mnethost->ip_address = $_SERVER['SERVER_ADDR'];
158 }
159
160 $mnetid = $DB->insert_record('mnet_host', $mnethost);
161 set_config('mnet_localhost_id', $mnetid);
162
c20ce874 163 // Initial insert of mnet applications info
365a5941 164 $mnet_app = new stdClass();
c20ce874 165 $mnet_app->name = 'moodle';
166 $mnet_app->display_name = 'Moodle';
167 $mnet_app->xmlrpc_server_url = '/mnet/xmlrpc/server.php';
168 $mnet_app->sso_land_url = '/auth/mnet/land.php';
0eadebb1 169 $mnet_app->sso_jump_url = '/auth/mnet/jump.php';
6f4f82f2 170 $moodleapplicationid = $DB->insert_record('mnet_application', $mnet_app);
c20ce874 171
365a5941 172 $mnet_app = new stdClass();
c20ce874 173 $mnet_app->name = 'mahara';
174 $mnet_app->display_name = 'Mahara';
175 $mnet_app->xmlrpc_server_url = '/api/xmlrpc/server.php';
176 $mnet_app->sso_land_url = '/auth/xmlrpc/land.php';
177 $mnet_app->sso_jump_url = '/auth/xmlrpc/jump.php';
178 $DB->insert_record('mnet_application', $mnet_app);
179
6f4f82f2 180 // Set up the probably-to-be-removed-soon 'All hosts' record
365a5941 181 $mnetallhosts = new stdClass();
6f4f82f2
PS
182 $mnetallhosts->wwwroot = '';
183 $mnetallhosts->ip_address = '';
184 $mnetallhosts->public_key = '';
185 $mnetallhosts->public_key_expires = 0;
186 $mnetallhosts->last_connect_time = 0;
187 $mnetallhosts->last_log_id = 0;
188 $mnetallhosts->deleted = 0;
189 $mnetallhosts->name = 'All Hosts';
190 $mnetallhosts->applicationid = $moodleapplicationid;
191 $mnetallhosts->id = $DB->insert_record('mnet_host', $mnetallhosts, true);
192 set_config('mnet_all_hosts_id', $mnetallhosts->id);
88582df4 193
39b90b51 194 // Create guest record - do not assign any role, guest user gets the default guest role automatically on the fly
e922fe23
PS
195 if ($DB->record_exists('user', array())) {
196 throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default users, users already exist.');
197 }
365a5941 198 $guest = new stdClass();
88582df4 199 $guest->auth = 'manual';
200 $guest->username = 'guest';
201 $guest->password = hash_internal_user_password('guest');
202 $guest->firstname = get_string('guestuser');
203 $guest->lastname = ' ';
204 $guest->email = 'root@localhost';
205 $guest->description = get_string('guestuserinfo');
206 $guest->mnethostid = $CFG->mnet_localhost_id;
207 $guest->confirmed = 1;
208 $guest->lang = $CFG->lang;
209 $guest->timemodified= time();
210 $guest->id = $DB->insert_record('user', $guest);
19e7a192 211 if ($guest->id != 1) {
3912cdd1 212 echo $OUTPUT->notification('Unexpected id generated for the Guest account. Your database configuration or clustering setup may not be fully supported', 'notifyproblem');
19e7a192
PS
213 }
214 // Store guest id
215 set_config('siteguest', $guest->id);
e922fe23
PS
216 // Make sure user context exists
217 context_user::instance($guest->id);
88582df4 218
219
39b90b51 220 // Now create admin user
365a5941 221 $admin = new stdClass();
88582df4 222 $admin->auth = 'manual';
223 $admin->firstname = get_string('admin');
224 $admin->lastname = get_string('user');
225 $admin->username = 'admin';
226 $admin->password = 'adminsetuppending';
1deff123 227 $admin->email = '';
88582df4 228 $admin->confirmed = 1;
229 $admin->mnethostid = $CFG->mnet_localhost_id;
230 $admin->lang = $CFG->lang;
231 $admin->maildisplay = 1;
232 $admin->timemodified = time();
aa282b10 233 $admin->lastip = CLI_SCRIPT ? '0.0.0.0' : getremoteaddr(); // installation hijacking prevention
88582df4 234 $admin->id = $DB->insert_record('user', $admin);
3912cdd1 235
19e7a192 236 if ($admin->id != 2) {
3912cdd1
SH
237 echo $OUTPUT->notification('Unexpected id generated for the Admin account. Your database configuration or clustering setup may not be fully supported', 'notifyproblem');
238 }
239 if ($admin->id != ($guest->id + 1)) {
240 echo $OUTPUT->notification('Nonconsecutive id generated for the Admin account. Your database configuration or clustering setup may not be fully supported.', 'notifyproblem');
19e7a192 241 }
3912cdd1 242
39b90b51 243 // Store list of admins
4f0c2d00 244 set_config('siteadmins', $admin->id);
e922fe23
PS
245 // Make sure user context exists
246 context_user::instance($admin->id);
88582df4 247
1caea91e 248
39b90b51 249 // Install the roles system.
ff22f229
PS
250 $managerrole = create_role('', 'manager', '', 'manager');
251 $coursecreatorrole = create_role('', 'coursecreator', '', 'coursecreator');
252 $editteacherrole = create_role('', 'editingteacher', '', 'editingteacher');
253 $noneditteacherrole = create_role('', 'teacher', '', 'teacher');
254 $studentrole = create_role('', 'student', '', 'student');
255 $guestrole = create_role('', 'guest', '', 'guest');
256 $userrole = create_role('', 'user', '', 'user');
257 $frontpagerole = create_role('', 'frontpage', '', 'frontpage');
88582df4 258
39b90b51 259 // Now is the correct moment to install capabilities - after creation of legacy roles, but before assigning of roles
88582df4 260 update_capabilities('moodle');
261
39b90b51 262 // Default allow assign
4f0c2d00
PS
263 $defaultallowassigns = array(
264 array($managerrole, $managerrole),
265 array($managerrole, $coursecreatorrole),
266 array($managerrole, $editteacherrole),
267 array($managerrole, $noneditteacherrole),
268 array($managerrole, $studentrole),
88582df4 269
4f0c2d00
PS
270 array($editteacherrole, $noneditteacherrole),
271 array($editteacherrole, $studentrole),
c468795c 272 );
4f0c2d00
PS
273 foreach ($defaultallowassigns as $allow) {
274 list($fromroleid, $toroleid) = $allow;
c468795c 275 allow_assign($fromroleid, $toroleid);
4f0c2d00
PS
276 }
277
39b90b51 278 // Default allow override
4f0c2d00
PS
279 $defaultallowoverrides = array(
280 array($managerrole, $managerrole),
281 array($managerrole, $coursecreatorrole),
282 array($managerrole, $editteacherrole),
283 array($managerrole, $noneditteacherrole),
284 array($managerrole, $studentrole),
285 array($managerrole, $guestrole),
286 array($managerrole, $userrole),
287 array($managerrole, $frontpagerole),
288
289 array($editteacherrole, $noneditteacherrole),
290 array($editteacherrole, $studentrole),
291 array($editteacherrole, $guestrole),
292 );
293 foreach ($defaultallowoverrides as $allow) {
294 list($fromroleid, $toroleid) = $allow;
c468795c 295 allow_override($fromroleid, $toroleid); // There is a rant about this in MDL-15841.
4f0c2d00
PS
296 }
297
39b90b51 298 // Default allow switch.
4f0c2d00
PS
299 $defaultallowswitch = array(
300 array($managerrole, $editteacherrole),
301 array($managerrole, $noneditteacherrole),
302 array($managerrole, $studentrole),
303 array($managerrole, $guestrole),
304
305 array($editteacherrole, $noneditteacherrole),
306 array($editteacherrole, $studentrole),
307 array($editteacherrole, $guestrole),
308
309 array($noneditteacherrole, $studentrole),
310 array($noneditteacherrole, $guestrole),
311 );
312 foreach ($defaultallowswitch as $allow) {
313 list($fromroleid, $toroleid) = $allow;
c468795c 314 allow_switch($fromroleid, $toroleid);
315 }
88582df4 316
39b90b51 317 // Set up the context levels where you can assign each role.
4f0c2d00 318 set_role_contextlevels($managerrole, get_default_contextlevels('manager'));
88582df4 319 set_role_contextlevels($coursecreatorrole, get_default_contextlevels('coursecreator'));
320 set_role_contextlevels($editteacherrole, get_default_contextlevels('editingteacher'));
321 set_role_contextlevels($noneditteacherrole, get_default_contextlevels('teacher'));
322 set_role_contextlevels($studentrole, get_default_contextlevels('student'));
323 set_role_contextlevels($guestrole, get_default_contextlevels('guest'));
324 set_role_contextlevels($userrole, get_default_contextlevels('user'));
ac173d3e 325
1635da56
PS
326 // Init theme and JS revisions
327 set_config('themerev', time());
328 set_config('jsrev', time());
b64b465c 329
c7289da7 330 // No admin setting for this any more, GD is now required, remove in Moodle 2.6.
8aae16fb 331 set_config('gdversion', 2);
c7289da7 332
b64b465c
PS
333 // Install licenses
334 require_once($CFG->libdir . '/licenselib.php');
335 license_manager::install_licenses();
03d9401e 336
e922fe23
PS
337 // Init profile pages defaults
338 if ($DB->record_exists('my_pages', array())) {
339 throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default profile pages, records already exist.');
340 }
365a5941 341 $mypage = new stdClass();
03d9401e
MD
342 $mypage->userid = NULL;
343 $mypage->name = '__default';
344 $mypage->private = 0;
345 $mypage->sortorder = 0;
e922fe23 346 $DB->insert_record('my_pages', $mypage);
03d9401e 347 $mypage->private = 1;
e922fe23 348 $DB->insert_record('my_pages', $mypage);
117bd748 349}