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/>.
  16
  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 https://moodledev.io/docs/guides/upgrade}
  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  */
  28
  29 defined('MOODLE_INTERNAL') || die();
  30
  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 https://moodledev.io/general/development/policies/codingstyle/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;
  58
  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     }
  64
  65
  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  = 1;
  76     $newsite->category     = 0;
  77     $newsite->format       = 'site';  // Only for this course
  78     $newsite->timecreated  = time();
  79     $newsite->timemodified = $newsite->timecreated;
  80
  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     // 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));
  93     $SITE = get_site();
  94     if ($newsite->id != $SITE->id) {
  95         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Unexpected new site course id!');
  96     }
  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);
 101
 102
 103     // Create default course category
 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('defaultcategoryname');
 109     $cat->descriptionformat = FORMAT_HTML;
 110     $cat->depth        = 1;
 111     $cat->sortorder    = get_max_courses_in_category();
 112     $cat->timemodified = time();
 113     $catid = $DB->insert_record('course_categories', $cat);
 114     $DB->set_field('course_categories', 'path', '/'.$catid, array('id'=>$catid));
 115     // Make sure category context exists
 116     context_coursecat::instance($catid);
 117
 118
 119     $defaults = array(
 120         'rolesactive'           => '0', // marks fully set up system
 121         'auth'                  => 'email',
 122         'enrol_plugins_enabled' => 'manual,guest,self,cohort',
 123         'theme'                 => theme_config::DEFAULT_THEME,
 124         'filter_multilang_converted' => 1,
 125         'siteidentifier'        => random_string(32).get_host_from_url($CFG->wwwroot),
 126         'backup_version'        => 2008111700,
 127         'backup_release'        => '2.0 dev',
 128         'mnet_dispatcher_mode'  => 'off',
 129         'sessiontimeout'        => 8 * 60 * 60, // 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.
 132         'texteditors'           => 'tiny,atto,tinymce,textarea',
 133         'antiviruses'           => '',
 134         'media_plugins_sortorder' => 'videojs,youtube',
 135         'upgrade_extracreditweightsstepignored' => 1, // New installs should not run this upgrade step.
 136         'upgrade_calculatedgradeitemsignored' => 1, // New installs should not run this upgrade step.
 137         'upgrade_letterboundarycourses' => 1, // New installs should not run this upgrade step.
 138         'format_plugins_sortorder' => 'topics,weeks,singleactivity,social', // Default order for course format plugins.
 139     );
 140     foreach($defaults as $key => $value) {
 141         set_config($key, $value);
 142     }
 143
 144
 145     // Bootstrap mnet
 146     $mnethost = new stdClass();
 147     $mnethost->wwwroot    = $CFG->wwwroot;
 148     $mnethost->name       = '';
 149     $mnethost->name       = '';
 150     $mnethost->public_key = '';
 151
 152     if (empty($_SERVER['SERVER_ADDR'])) {
 153         // SERVER_ADDR is only returned by Apache-like webservers
 154         preg_match("@^(?:http[s]?://)?([A-Z0-9\-\.]+).*@i", $CFG->wwwroot, $matches);
 155         $my_hostname = $matches[1];
 156         $my_ip       = gethostbyname($my_hostname);  // Returns unmodified hostname on failure. DOH!
 157         if ($my_ip == $my_hostname) {
 158             $mnethost->ip_address = 'UNKNOWN';
 159         } else {
 160             $mnethost->ip_address = $my_ip;
 161         }
 162     } else {
 163         $mnethost->ip_address = $_SERVER['SERVER_ADDR'];
 164     }
 165
 166     $mnetid = $DB->insert_record('mnet_host', $mnethost);
 167     set_config('mnet_localhost_id', $mnetid);
 168
 169     // Initial insert of mnet applications info
 170     $mnet_app = new stdClass();
 171     $mnet_app->name              = 'moodle';
 172     $mnet_app->display_name      = 'Moodle';
 173     $mnet_app->xmlrpc_server_url = '/mnet/xmlrpc/server.php';
 174     $mnet_app->sso_land_url      = '/auth/mnet/land.php';
 175     $mnet_app->sso_jump_url      = '/auth/mnet/jump.php';
 176     $moodleapplicationid = $DB->insert_record('mnet_application', $mnet_app);
 177
 178     $mnet_app = new stdClass();
 179     $mnet_app->name              = 'mahara';
 180     $mnet_app->display_name      = 'Mahara';
 181     $mnet_app->xmlrpc_server_url = '/api/xmlrpc/server.php';
 182     $mnet_app->sso_land_url      = '/auth/xmlrpc/land.php';
 183     $mnet_app->sso_jump_url      = '/auth/xmlrpc/jump.php';
 184     $DB->insert_record('mnet_application', $mnet_app);
 185
 186     // Set up the probably-to-be-removed-soon 'All hosts' record
 187     $mnetallhosts                     = new stdClass();
 188     $mnetallhosts->wwwroot            = '';
 189     $mnetallhosts->ip_address         = '';
 190     $mnetallhosts->public_key         = '';
 191     $mnetallhosts->public_key_expires = 0;
 192     $mnetallhosts->last_connect_time  = 0;
 193     $mnetallhosts->last_log_id        = 0;
 194     $mnetallhosts->deleted            = 0;
 195     $mnetallhosts->name               = 'All Hosts';
 196     $mnetallhosts->applicationid      = $moodleapplicationid;
 197     $mnetallhosts->id                 = $DB->insert_record('mnet_host', $mnetallhosts, true);
 198     set_config('mnet_all_hosts_id', $mnetallhosts->id);
 199
 200     // Create guest record - do not assign any role, guest user gets the default guest role automatically on the fly
 201     if ($DB->record_exists('user', array())) {
 202         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default users, users already exist.');
 203     }
 204     $guest = new stdClass();
 205     $guest->auth        = 'manual';
 206     $guest->username    = 'guest';
 207     $guest->password    = hash_internal_user_password('guest');
 208     $guest->firstname   = get_string('guestuser');
 209     $guest->lastname    = ' ';
 210     $guest->email       = 'root@localhost';
 211     $guest->description = get_string('guestuserinfo');
 212     $guest->mnethostid  = $CFG->mnet_localhost_id;
 213     $guest->confirmed   = 1;
 214     $guest->lang        = $CFG->lang;
 215     $guest->timemodified= time();
 216     $guest->id = $DB->insert_record('user', $guest);
 217     if ($guest->id != 1) {
 218         echo $OUTPUT->notification('Unexpected id generated for the Guest account. Your database configuration or clustering setup may not be fully supported', 'notifyproblem');
 219     }
 220     // Store guest id
 221     set_config('siteguest', $guest->id);
 222     // Make sure user context exists
 223     context_user::instance($guest->id);
 224
 225
 226     // Now create admin user
 227     $admin = new stdClass();
 228     $admin->auth         = 'manual';
 229     $admin->firstname    = get_string('admin');
 230     $admin->lastname     = get_string('user');
 231     $admin->username     = 'admin';
 232     $admin->password     = 'adminsetuppending';
 233     $admin->email        = '';
 234     $admin->confirmed    = 1;
 235     $admin->mnethostid   = $CFG->mnet_localhost_id;
 236     $admin->lang         = $CFG->lang;
 237     $admin->maildisplay  = 1;
 238     $admin->timemodified = time();
 239     $admin->lastip       = CLI_SCRIPT ? '0.0.0.0' : getremoteaddr(); // installation hijacking prevention
 240     $admin->id = $DB->insert_record('user', $admin);
 241
 242     if ($admin->id != 2) {
 243         echo $OUTPUT->notification('Unexpected id generated for the Admin account. Your database configuration or clustering setup may not be fully supported', 'notifyproblem');
 244     }
 245     if ($admin->id != ($guest->id + 1)) {
 246         echo $OUTPUT->notification('Nonconsecutive id generated for the Admin account. Your database configuration or clustering setup may not be fully supported.', 'notifyproblem');
 247     }
 248
 249     // Store list of admins
 250     set_config('siteadmins', $admin->id);
 251     // Make sure user context exists
 252     context_user::instance($admin->id);
 253
 254
 255     // Install the roles system.
 256     $managerrole        = create_role('', 'manager', '', 'manager');
 257     $coursecreatorrole  = create_role('', 'coursecreator', '', 'coursecreator');
 258     $editteacherrole    = create_role('', 'editingteacher', '', 'editingteacher');
 259     $noneditteacherrole = create_role('', 'teacher', '', 'teacher');
 260     $studentrole        = create_role('', 'student', '', 'student');
 261     $guestrole          = create_role('', 'guest', '', 'guest');
 262     $userrole           = create_role('', 'user', '', 'user');
 263     $frontpagerole      = create_role('', 'frontpage', '', 'frontpage');
 264
 265     // Now is the correct moment to install capabilities - after creation of legacy roles, but before assigning of roles
 266     update_capabilities('moodle');
 267
 268
 269     // Default allow role matrices.
 270     foreach ($DB->get_records('role') as $role) {
 271         foreach (array('assign', 'override', 'switch', 'view') as $type) {
 272             $function = "core_role_set_{$type}_allowed";
 273             $allows = get_default_role_archetype_allows($type, $role->archetype);
 274             foreach ($allows as $allowid) {
 275                 $function($role->id, $allowid);
 276             }
 277         }
 278     }
 279
 280     // Set up the context levels where you can assign each role.
 281     set_role_contextlevels($managerrole,        get_default_contextlevels('manager'));
 282     set_role_contextlevels($coursecreatorrole,  get_default_contextlevels('coursecreator'));
 283     set_role_contextlevels($editteacherrole,    get_default_contextlevels('editingteacher'));
 284     set_role_contextlevels($noneditteacherrole, get_default_contextlevels('teacher'));
 285     set_role_contextlevels($studentrole,        get_default_contextlevels('student'));
 286     set_role_contextlevels($guestrole,          get_default_contextlevels('guest'));
 287     set_role_contextlevels($userrole,           get_default_contextlevels('user'));
 288
 289     // Init theme, JS and template revisions.
 290     set_config('themerev', time());
 291     set_config('jsrev', time());
 292     set_config('templaterev', time());
 293
 294     // No admin setting for this any more, GD is now required, remove in Moodle 2.6.
 295     set_config('gdversion', 2);
 296
 297     // Install licenses
 298     require_once($CFG->libdir . '/licenselib.php');
 299     license_manager::install_licenses();
 300
 301     // Init profile pages defaults
 302     if ($DB->record_exists('my_pages', array())) {
 303         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Can not create default profile pages, records already exist.');
 304     }
 305     $mypage = new stdClass();
 306     $mypage->userid = NULL;
 307     $mypage->name = '__default';
 308     $mypage->private = 0;
 309     $mypage->sortorder  = 0;
 310     $DB->insert_record('my_pages', $mypage);
 311     $mypage->private = 1;
 312     $DB->insert_record('my_pages', $mypage);
 313
 314     $mycoursespage = new stdClass();
 315     $mycoursespage->userid = null;
 316     $mycoursespage->name = '__courses';
 317     $mycoursespage->private = 0;
 318     $mycoursespage->sortorder  = 0;
 319     $DB->insert_record('my_pages', $mycoursespage);
 320
 321     // Set a sensible default sort order for the most-used question types.
 322     set_config('multichoice_sortorder', 1, 'question');
 323     set_config('truefalse_sortorder', 2, 'question');
 324     set_config('match_sortorder', 3, 'question');
 325     set_config('shortanswer_sortorder', 4, 'question');
 326     set_config('numerical_sortorder', 5, 'question');
 327     set_config('essay_sortorder', 6, 'question');
 328
 329     require_once($CFG->libdir . '/db/upgradelib.php');
 330     make_default_scale();
 331     make_competence_scale();
 332
 333     require_once($CFG->dirroot . '/badges/upgradelib.php'); // Core install and upgrade related functions only for badges.
 334     badges_install_default_backpacks();
 335
 336     // Create default core site admin presets.
 337     require_once($CFG->dirroot . '/admin/presets/classes/helper.php');
 338     \core_adminpresets\helper::create_default_presets();
 339 }