MDL-30981 Upgrade API: Added related phpdocs
[moodle.git] / lib / db / install.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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/>.
17 /**
18  * This file is executed right after the install.xml
19  *
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
27  */
29 defined('MOODLE_INTERNAL') || die();
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  */
56 function xmldb_main_install() {
57     global $CFG, $DB, $SITE, $OUTPUT;
59     // Make sure system context exists
60     $syscontext = context_system::instance(0, MUST_EXIST, false);
61     if ($syscontext->id != SYSCONTEXTID) {
62         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Unexpected new system context id!');
63     }
66     // Create site course
67     if ($DB->record_exists('course', array())) {
68         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create frontpage course, courses already exist.');
69     }
70     $newsite = new stdClass();
71     $newsite->fullname     = '';
72     $newsite->shortname    = '';
73     $newsite->summary      = NULL;
74     $newsite->newsitems    = 3;
75     $newsite->numsections  = 0;
76     $newsite->category     = 0;
77     $newsite->format       = 'site';  // Only for this course
78     $newsite->timecreated  = time();
79     $newsite->timemodified = $newsite->timecreated;
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     }
89     $SITE = get_site();
90     if ($newsite->id != $SITE->id) {
91         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Unexpected new site course id!');
92     }
93     // Make sure site course context exists
94     context_course::instance($SITE->id);
95     // Update the global frontpage cache
96     $SITE = $DB->get_record('course', array('id'=>$newsite->id), '*', MUST_EXIST);
99     // Create default course category
100     if ($DB->record_exists('course_categories', array())) {
101         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default course category, categories already exist.');
102     }
103     $cat = new stdClass();
104     $cat->name         = get_string('miscellaneous');
105     $cat->depth        = 1;
106     $cat->sortorder    = MAX_COURSES_IN_CATEGORY;
107     $cat->timemodified = time();
108     $catid = $DB->insert_record('course_categories', $cat);
109     $DB->set_field('course_categories', 'path', '/'.$catid, array('id'=>$catid));
110     // Make sure category context exists
111     context_coursecat::instance($catid);
114     $defaults = array(
115         'rolesactive'           => '0', // marks fully set up system
116         'auth'                  => 'email',
117         'auth_pop3mailbox'      => 'INBOX',
118         'enrol_plugins_enabled' => 'manual,guest,self,cohort',
119         'theme'                 => theme_config::DEFAULT_THEME,
120         'filter_multilang_converted' => 1,
121         'siteidentifier'        => random_string(32).get_host_from_url($CFG->wwwroot),
122         'backup_version'        => 2008111700,
123         'backup_release'        => '2.0 dev',
124         'mnet_dispatcher_mode'  => 'off',
125         'sessiontimeout'        => 7200, // must be present during roles installation
126         'stringfilters'         => '', // These two are managed in a strange way by the filters
127         'filterall'             => 0, // setting page, so have to be initialised here.
128         'texteditors'           => 'tinymce,textarea',
129     );
130     foreach($defaults as $key => $value) {
131         set_config($key, $value);
132     }
135     // Bootstrap mnet
136     $mnethost = new stdClass();
137     $mnethost->wwwroot    = $CFG->wwwroot;
138     $mnethost->name       = '';
139     $mnethost->name       = '';
140     $mnethost->public_key = '';
142     if (empty($_SERVER['SERVER_ADDR'])) {
143         // SERVER_ADDR is only returned by Apache-like webservers
144         preg_match("@^(?:http[s]?://)?([A-Z0-9\-\.]+).*@i", $CFG->wwwroot, $matches);
145         $my_hostname = $matches[1];
146         $my_ip       = gethostbyname($my_hostname);  // Returns unmodified hostname on failure. DOH!
147         if ($my_ip == $my_hostname) {
148             $mnethost->ip_address = 'UNKNOWN';
149         } else {
150             $mnethost->ip_address = $my_ip;
151         }
152     } else {
153         $mnethost->ip_address = $_SERVER['SERVER_ADDR'];
154     }
156     $mnetid = $DB->insert_record('mnet_host', $mnethost);
157     set_config('mnet_localhost_id', $mnetid);
159     // Initial insert of mnet applications info
160     $mnet_app = new stdClass();
161     $mnet_app->name              = 'moodle';
162     $mnet_app->display_name      = 'Moodle';
163     $mnet_app->xmlrpc_server_url = '/mnet/xmlrpc/server.php';
164     $mnet_app->sso_land_url      = '/auth/mnet/land.php';
165     $mnet_app->sso_jump_url      = '/auth/mnet/jump.php';
166     $moodleapplicationid = $DB->insert_record('mnet_application', $mnet_app);
168     $mnet_app = new stdClass();
169     $mnet_app->name              = 'mahara';
170     $mnet_app->display_name      = 'Mahara';
171     $mnet_app->xmlrpc_server_url = '/api/xmlrpc/server.php';
172     $mnet_app->sso_land_url      = '/auth/xmlrpc/land.php';
173     $mnet_app->sso_jump_url      = '/auth/xmlrpc/jump.php';
174     $DB->insert_record('mnet_application', $mnet_app);
176     // Set up the probably-to-be-removed-soon 'All hosts' record
177     $mnetallhosts                     = new stdClass();
178     $mnetallhosts->wwwroot            = '';
179     $mnetallhosts->ip_address         = '';
180     $mnetallhosts->public_key         = '';
181     $mnetallhosts->public_key_expires = 0;
182     $mnetallhosts->last_connect_time  = 0;
183     $mnetallhosts->last_log_id        = 0;
184     $mnetallhosts->deleted            = 0;
185     $mnetallhosts->name               = 'All Hosts';
186     $mnetallhosts->applicationid      = $moodleapplicationid;
187     $mnetallhosts->id                 = $DB->insert_record('mnet_host', $mnetallhosts, true);
188     set_config('mnet_all_hosts_id', $mnetallhosts->id);
190     // Create guest record - do not assign any role, guest user gets the default guest role automatically on the fly
191     if ($DB->record_exists('user', array())) {
192         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default users, users already exist.');
193     }
194     $guest = new stdClass();
195     $guest->auth        = 'manual';
196     $guest->username    = 'guest';
197     $guest->password    = hash_internal_user_password('guest');
198     $guest->firstname   = get_string('guestuser');
199     $guest->lastname    = ' ';
200     $guest->email       = 'root@localhost';
201     $guest->description = get_string('guestuserinfo');
202     $guest->mnethostid  = $CFG->mnet_localhost_id;
203     $guest->confirmed   = 1;
204     $guest->lang        = $CFG->lang;
205     $guest->timemodified= time();
206     $guest->id = $DB->insert_record('user', $guest);
207     if ($guest->id != 1) {
208         echo $OUTPUT->notification('Unexpected id generated for the Guest account. Your database configuration or clustering setup may not be fully supported', 'notifyproblem');
209     }
210     // Store guest id
211     set_config('siteguest', $guest->id);
212     // Make sure user context exists
213     context_user::instance($guest->id);
216     // Now create admin user
217     $admin = new stdClass();
218     $admin->auth         = 'manual';
219     $admin->firstname    = get_string('admin');
220     $admin->lastname     = get_string('user');
221     $admin->username     = 'admin';
222     $admin->password     = 'adminsetuppending';
223     $admin->email        = '';
224     $admin->confirmed    = 1;
225     $admin->mnethostid   = $CFG->mnet_localhost_id;
226     $admin->lang         = $CFG->lang;
227     $admin->maildisplay  = 1;
228     $admin->timemodified = time();
229     $admin->lastip       = CLI_SCRIPT ? '0.0.0.0' : getremoteaddr(); // installation hijacking prevention
230     $admin->id = $DB->insert_record('user', $admin);
232     if ($admin->id != 2) {
233         echo $OUTPUT->notification('Unexpected id generated for the Admin account. Your database configuration or clustering setup may not be fully supported', 'notifyproblem');
234     }
235     if ($admin->id != ($guest->id + 1)) {
236         echo $OUTPUT->notification('Nonconsecutive id generated for the Admin account. Your database configuration or clustering setup may not be fully supported.', 'notifyproblem');
237     }
239     // Store list of admins
240     set_config('siteadmins', $admin->id);
241     // Make sure user context exists
242     context_user::instance($admin->id);
245     // Install the roles system.
246     $managerrole        = create_role(get_string('manager', 'role'), 'manager', get_string('managerdescription', 'role'), 'manager');
247     $coursecreatorrole  = create_role(get_string('coursecreators'), 'coursecreator', get_string('coursecreatorsdescription'), 'coursecreator');
248     $editteacherrole    = create_role(get_string('defaultcourseteacher'), 'editingteacher', get_string('defaultcourseteacherdescription'), 'editingteacher');
249     $noneditteacherrole = create_role(get_string('noneditingteacher'), 'teacher', get_string('noneditingteacherdescription'), 'teacher');
250     $studentrole        = create_role(get_string('defaultcoursestudent'), 'student', get_string('defaultcoursestudentdescription'), 'student');
251     $guestrole          = create_role(get_string('guest'), 'guest', get_string('guestdescription'), 'guest');
252     $userrole           = create_role(get_string('authenticateduser'), 'user', get_string('authenticateduserdescription'), 'user');
253     $frontpagerole      = create_role(get_string('frontpageuser', 'role'), 'frontpage', get_string('frontpageuserdescription', 'role'), 'frontpage');
255     // Now is the correct moment to install capabilities - after creation of legacy roles, but before assigning of roles
256     update_capabilities('moodle');
258     // Default allow assign
259     $defaultallowassigns = array(
260         array($managerrole, $managerrole),
261         array($managerrole, $coursecreatorrole),
262         array($managerrole, $editteacherrole),
263         array($managerrole, $noneditteacherrole),
264         array($managerrole, $studentrole),
266         array($editteacherrole, $noneditteacherrole),
267         array($editteacherrole, $studentrole),
268     );
269     foreach ($defaultallowassigns as $allow) {
270         list($fromroleid, $toroleid) = $allow;
271         allow_assign($fromroleid, $toroleid);
272     }
274     // Default allow override
275     $defaultallowoverrides = array(
276         array($managerrole, $managerrole),
277         array($managerrole, $coursecreatorrole),
278         array($managerrole, $editteacherrole),
279         array($managerrole, $noneditteacherrole),
280         array($managerrole, $studentrole),
281         array($managerrole, $guestrole),
282         array($managerrole, $userrole),
283         array($managerrole, $frontpagerole),
285         array($editteacherrole, $noneditteacherrole),
286         array($editteacherrole, $studentrole),
287         array($editteacherrole, $guestrole),
288     );
289     foreach ($defaultallowoverrides as $allow) {
290         list($fromroleid, $toroleid) = $allow;
291         allow_override($fromroleid, $toroleid); // There is a rant about this in MDL-15841.
292     }
294     // Default allow switch.
295     $defaultallowswitch = array(
296         array($managerrole, $editteacherrole),
297         array($managerrole, $noneditteacherrole),
298         array($managerrole, $studentrole),
299         array($managerrole, $guestrole),
301         array($editteacherrole, $noneditteacherrole),
302         array($editteacherrole, $studentrole),
303         array($editteacherrole, $guestrole),
305         array($noneditteacherrole, $studentrole),
306         array($noneditteacherrole, $guestrole),
307     );
308     foreach ($defaultallowswitch as $allow) {
309         list($fromroleid, $toroleid) = $allow;
310         allow_switch($fromroleid, $toroleid);
311     }
313     // Set up the context levels where you can assign each role.
314     set_role_contextlevels($managerrole,        get_default_contextlevels('manager'));
315     set_role_contextlevels($coursecreatorrole,  get_default_contextlevels('coursecreator'));
316     set_role_contextlevels($editteacherrole,    get_default_contextlevels('editingteacher'));
317     set_role_contextlevels($noneditteacherrole, get_default_contextlevels('teacher'));
318     set_role_contextlevels($studentrole,        get_default_contextlevels('student'));
319     set_role_contextlevels($guestrole,          get_default_contextlevels('guest'));
320     set_role_contextlevels($userrole,           get_default_contextlevels('user'));
322     // Init themes
323     set_config('themerev', 1);
325     // Install licenses
326     require_once($CFG->libdir . '/licenselib.php');
327     license_manager::install_licenses();
329     // Init profile pages defaults
330     if ($DB->record_exists('my_pages', array())) {
331         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default profile pages, records already exist.');
332     }
333     $mypage = new stdClass();
334     $mypage->userid = NULL;
335     $mypage->name = '__default';
336     $mypage->private = 0;
337     $mypage->sortorder  = 0;
338     $DB->insert_record('my_pages', $mypage);
339     $mypage->private = 1;
340     $DB->insert_record('my_pages', $mypage);