upgrade.php 64.3 KB
Newer Older
1
2
3
4
<?php
/**
 *
 * @package    mahara
5
 * @subpackage core
6
 * @author     Catalyst IT Ltd
7
8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
9
10
11
12
13
14
15
16
 *
 */

defined('INTERNAL') || die();

/**
 * Class to use for installation exceptions
 */
17
class InstallationException extends SystemException {}
18

19
require_once('ddl.php');
20
21

/**
22
23
 * This function checks core and plugins for which need to be upgraded/installed
 *
24
25
26
27
 * Note: This function is sometimes executed during upgrades from
 * ancient databases.  Avoid rash assumptions about what's installed
 * or these upgrades may fail.
 *
28
29
 * @param string $name The name of the plugin to check. If no name is specified,
 *                     all plugins are checked.
30
31
32
 * @return mixed If a name is specified, an object will be returned with upgrade data
 *                     about the requested component (which can be "core", "local", or a plugin).
 *                     If the component desn't need to be updated, an empty array will be returned.
33
34
35
 *               If no name is specified, an array of such objects will be returned.
 *                     It will also include an array key "settings", which will be an array
 *                     that may contain metadata about the upgrade/install process.
36
 */
37
function check_upgrades($name=null) {
38

39
40
41
    $pluginstocheck = plugin_types();

    $toupgrade = array();
42
    $settings = array();
43
44
    $toupgradecount = 0;
    $newinstallcount = 0;
45
    $installing = false;
46
    $newinstalls = array();
47
48
49
50
51
52

    require('version.php');
    // check core first...
    if (empty($name) || $name == 'core') {
        try {
            $coreversion = get_config('version');
Elliot Pahl's avatar
Elliot Pahl committed
53
        }
54
55
56
        catch (Exception $e) {
            $coreversion = 0;
        }
57
        $corerelease = get_config('release');
58
59
60
61
        $core = new stdClass();
        $core->to = $config->version;
        $core->torelease = $config->release;
        $core->toseries = $config->series;
62
        $toupgrade['core'] = $core;
63
        if (empty($coreversion)) {
64
            if (is_mysql()) { // Show a more informative error message if using mysql with skip-innodb
65
                // In MySQL 5.6.x, we run the command 'SHOW ENGINES' to check if InnoDB is enabled or not
66
                global $db;
67
68
69
70
71
72
73
74
75
76
77
                $result = $db->Execute("SHOW ENGINES");
                $hasinnodb = false;
                while (!$result->EOF) {
                    if ($result->fields['Engine'] == 'InnoDB' && ($result->fields['Support'] == 'YES' || $result->fields['Support'] == 'DEFAULT')) {
                        $hasinnodb = true;
                        break;
                    }
                    $result->MoveNext();
                }

                if (!$hasinnodb) {
78
79
80
                    throw new ConfigSanityException("Mahara requires InnoDB tables.  Please ensure InnoDB tables are enabled in your MySQL server.");
                }
            }
81
82
            $core->install = true;
            $installing = true;
Elliot Pahl's avatar
Elliot Pahl committed
83
        }
84
        else if ($config->version > $coreversion) {
Elliot Pahl's avatar
Elliot Pahl committed
85
            if (isset($config->minupgradefrom) && isset($config->minupgraderelease)
86
                && $coreversion < $config->minupgradefrom) {
87
                throw new ConfigSanityException("Must upgrade to $config->minupgradefrom "
88
89
                                          . "($config->minupgraderelease) first "
                                          . " (you have $coreversion ($corerelease)");
90
            }
91
            $toupgradecount ++;
92
93
            $core->upgrade = true;
            $core->from = $coreversion;
94
            $core->fromrelease = $corerelease;
95
        }
96
97
98
99
100
101
102
103
104
105
        else if ($config->version < $coreversion) {
            if (get_config('productionmode')) {
                throw new ConfigSanityException("Database version of Mahara $corerelease ($coreversion) is newer "
                                            . "than files version $config->release ($config->version). "
                                            . "Please make sure you have the correct Mahara files in place.");
            }
            else {
                define('SITEOUTOFSYNC', 'core');
            }
        }
106
107
108
109
        else {
            // Core doesn't need to be upgraded. Remove it from the list!
            unset($toupgrade['core']);
        }
110
111
    }

112
    // If we were just checking if the core needed to be upgraded, we can stop here
113
114
115
116
    if ($name == 'core') {
        return $toupgrade['core'];
    }

117
118
119
120
121
122
123
124
125
126
127
128
    if (!$installing && (empty($name) || $name == 'local')) {
        $localversion = get_config('localversion');
        $localrelease = get_config('localrelease');
        if (is_null($localversion)) {
            $localversion = 0;
            $localrelease = 0;
        }

        $config = new StdClass;
        require(get_config('docroot') . 'local/version.php');

        if ($config->version > $localversion) {
129
            $toupgradecount ++;
130
131
132
133
134
135
136
137
138
139
140
141
142
143
            $toupgrade['local'] = (object) array(
                'upgrade'     => true,
                'from'        => $localversion,
                'fromrelease' => $localrelease,
                'to'          => $config->version,
                'torelease'   => $config->release,
            );
        }

        if ($name == 'local') {
            return $toupgrade['local'];
        }
    }

144
145
    $plugins = array();
    if (!empty($name)) {
146
147
148
149
150
151
        try {
            $bits = explode('.', $name);
            $pt = $bits[0];
            $pn = $bits[1];
            $pp = null;
            if ($pt == 'blocktype' && strpos($pn, '/') !== false) {
152
                $bits = explode('/', $pn);
153
154
155
156
157
158
                $pp = get_config('docroot') . 'artefact/' . $bits[0]  . '/blocktype/' . $bits[1];
            }
            validate_plugin($pt, $pn, $pp);
            $plugins[] = explode('.', $name);
        }
        catch (InstallationException $_e) {
159
            log_warn(get_string('pluginnotinstallable', 'mahara', $pt, $pn) . $_e->GetMessage());
160
        }
161
162
163
164
165
    }
    else {
        foreach ($pluginstocheck as $plugin) {
            $dirhandle = opendir(get_config('docroot') . $plugin);
            while (false !== ($dir = readdir($dirhandle))) {
166
                if (strpos($dir, '.') === 0 or 'CVS' == $dir) {
167
168
                    continue;
                }
169
170
                $plugin_dir = get_config('docroot') . $plugin . '/' . $dir;
                if (!is_dir($plugin_dir)) {
171
172
                    continue;
                }
173
174
175
176
177
                try {
                    validate_plugin($plugin, $dir);
                    $plugins[] = array($plugin, $dir);
                }
                catch (InstallationException $_e) {
178
                    log_warn(get_string('pluginnotinstallable', 'mahara', $plugin, $dir) . $_e->GetMessage(), true , false);
179
180
181
                }

                if ($plugin == 'artefact') { // go check it for blocks as well
182
                    $btlocation = $plugin_dir . '/blocktype';
183
                    if (!is_dir($btlocation)) {
184
                        continue;
Elliot Pahl's avatar
Elliot Pahl committed
185
                    }
186
187
                    $btdirhandle = opendir($btlocation);
                    while (false !== ($btdir = readdir($btdirhandle))) {
188
                        if (strpos($btdir, '.') === 0 or 'CVS' == $btdir) {
189
190
                            continue;
                        }
191
                        if (!is_dir(get_config('docroot') . $plugin . '/' . $dir . '/blocktype/' . $btdir)) {
192
193
194
                            continue;
                        }
                        $plugins[] = array('blocktype', $dir . '/' . $btdir);
195
196
                    }
                }
197
198
199
            }
        }
    }
200
    $outofsyncplugins = array();
201
202
203
204
205
206
    foreach ($plugins as $plugin) {
        $plugintype = $plugin[0];
        $pluginname = $plugin[1];
        $pluginpath = "$plugin[0]/$plugin[1]";
        $pluginkey  = "$plugin[0].$plugin[1]";

207
208
209
210
211
212
        if ($plugintype == 'blocktype' && strpos($pluginname, '/') !== false) {
            // sigh.. we're a bit special...
            $bits = explode('/', $pluginname);
            $pluginpath = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1];
        }

213
214
215
        // Don't try to get the plugin info if we are installing - it will
        // definitely fail
        $pluginversion = 0;
216
217
218
219
220
221
222
223
224
        if (!$installing && table_exists(new XMLDBTable($plugintype . '_installed'))) {
            if ($plugintype == 'blocktype' && strpos($pluginname, '/')) {
                $bits = explode('/', $pluginname);
                $installed = get_record('blocktype_installed', 'name', $bits[1], 'artefactplugin', $bits[0]);
            }
            else {
                $installed = get_record($plugintype . '_installed', 'name', $pluginname);
            }
            if ($installed) {
225
226
227
                $pluginversion = $installed->version;
                $pluginrelease =  $installed->release;
            }
228
        }
229
230

        $config = new StdClass;
231
        require(get_config('docroot') . $pluginpath . '/version.php');
232

233
234
235
236
237
        $classname = generate_class_name($plugintype, $pluginname);
        safe_require($plugintype, $pluginname);
        // Check if there is a displayname
        $plugindisplayname = call_static_method($classname, 'get_plugin_display_name');

238
        if (empty($pluginversion)) {
239
            $newinstall = false;
240
            if (empty($installing) && $pluginkey != $name) {
241
                $newinstall = true;
242
            }
243
244
245
246
            $plugininfo = new StdClass;
            $plugininfo->install = true;
            $plugininfo->to = $config->version;
            $plugininfo->torelease = $config->release;
247
248
249
250
251
252
            if (property_exists($config, 'requires_config')) {
                $plugininfo->requires_config = $config->requires_config;
            }
            if (property_exists($config, 'requires_parent')) {
                $plugininfo->requires_parent = $config->requires_parent;
            }
253
            $plugininfo->displayname = $plugindisplayname;
254

255
256
257
258
259
260
261
262
263
            try {
                $classname::sanity_check();
            }
            catch (InstallationException $exc) {
                $plugininfo->to = get_string('notinstalled', 'admin');
                $plugininfo->torelease = get_string('notinstalled', 'admin');
                $plugininfo->errormsg = $exc->getMessage();
            }

264
265
266
267
268
269
270
271
272
273
            if ($newinstall) {
                $plugininfo->from = get_string('notinstalled', 'admin');
                $plugininfo->fromrelease = get_string('notinstalled', 'admin');
                $plugininfo->newinstall = true;
                $newinstallcount ++;
                $newinstalls[$pluginkey] = $plugininfo;
            }
            else {
                $toupgrade[$pluginkey] = $plugininfo;
            }
274
275
        }
        else if ($config->version > $pluginversion) {
276
277
278
279
280
            if (isset($config->minupgradefrom) && isset($config->minupgraderelease)
                && $pluginversion < $config->minupgradefrom) {
                throw new ConfigSanityException("Must upgrade to $config->minupgradefrom "
                                          . " ($config->minupgraderelease) first "
                                          . " (you have $pluginversion ($pluginrelease))");
281
            }
282
            $toupgradecount++;
283
284
285
286
287
288
            $plugininfo = new StdClass;
            $plugininfo->upgrade = true;
            $plugininfo->from = $pluginversion;
            $plugininfo->fromrelease = $pluginrelease;
            $plugininfo->to = $config->version;
            $plugininfo->torelease = $config->release;
289
290
291
292
293
294
            if (property_exists($config, 'requires_config')) {
                $plugininfo->requires_config = $config->requires_config;
            }
            if (property_exists($config, 'requires_parent')) {
                $plugininfo->requires_parent = $config->requires_parent;
            }
295
            $plugininfo->displayname = $plugindisplayname;
296
297
298
299
300
301
302
303
304
305
306
307
308

            try {
                $classname::sanity_check();
            }
            catch (InstallationException $exc) {
                $plugininfo->to = $config->version;
                $plugininfo->torelease = $pluginrelease;
                $plugininfo->errormsg = $exc->getMessage();
                $toupgrade[$pluginkey] = $plugininfo;

                continue;
            }

309
310
            $toupgrade[$pluginkey] = $plugininfo;
        }
311
        else if ($config->version < $pluginversion) {
312
            $plugindisplayname = !empty($plugindisplayname) ? $plugindisplayname : (!empty($config->name) ? $config->name : $pluginpath);
313
314
315
316
317
318
319
            if (get_config('productionmode')) {
                throw new ConfigSanityException("Database version of Mahara plugin " . $plugindisplayname . " "
                                            . $pluginrelease . " (" . $pluginversion . ") is newer "
                                            . "than files version " . $config->release . " (" . $config->version . "). "
                                            . "Please make sure you have the correct Mahara plugin files in place.");
            }
            else {
320
                $outofsyncplugins[] = $plugindisplayname;
321
322
            }
        }
323
    }
324
325
326
    if (!empty($outofsyncplugins)) {
        define('SITEOUTOFSYNC', implode(', ', $outofsyncplugins));
    }
327
    // if we've just asked for one, don't return an array...
328
    if (!empty($name)) {
329
330
331
332
333
334
335
336
337
338
        if (count($toupgrade) == 1) {
            $upgrade = new StdClass;
            $upgrade->name = $name;
            foreach ((array)$toupgrade[$name] as $key => $value) {
                $upgrade->{$key} = $value;
            }
            return $upgrade;
        }
        else {
            return array();
339
340
        }
    }
341
342

    // If we get here, it's because we have an array of objects to return
343
    uksort($toupgrade, 'sort_upgrades');
344
    $settings['newinstallcount'] = $newinstallcount;
345
    $settings['newinstalls'] = $newinstalls;
346
347
    $settings['toupgradecount'] = $toupgradecount;
    $toupgrade['settings'] = $settings;
348
349
350
    return $toupgrade;
}

351
352
353
354
355
/**
 * Upgrades the core system to given upgrade version.
 *
 * @param object $upgrade   The version to upgrade to
 * @return bool             Whether the upgrade succeeded or not
356
 * @throws SQLException     If the upgrade failed due to a database error
357
 */
358
359
360
function upgrade_core($upgrade) {
    global $db;

361
    $location = get_config('libroot') . 'db/';
Penny Leach's avatar
Penny Leach committed
362
363

    db_begin();
364
365

    if (!empty($upgrade->install)) {
366
        install_from_xmldb_file($location . 'install.xml');
367
368
369
    }
    else {
        require_once($location . 'upgrade.php');
Penny Leach's avatar
Penny Leach committed
370
        xmldb_core_upgrade($upgrade->from);
371
372
    }

Penny Leach's avatar
Penny Leach committed
373
374
    set_config('version', $upgrade->to);
    set_config('release', $upgrade->torelease);
375
    set_config('series', $upgrade->toseries);
376
    bump_cache_version();
Elliot Pahl's avatar
Elliot Pahl committed
377

378
    if (!empty($upgrade->install)) {
Penny Leach's avatar
Penny Leach committed
379
        core_postinst();
380
    }
381

Penny Leach's avatar
Penny Leach committed
382
383
    db_commit();
    return true;
384
385
}

386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
/**
 * Upgrades local customisations.
 *
 * @param object $upgrade   The version to upgrade to
 * @return bool             Whether the upgrade succeeded or not
 * @throws SQLException     If the upgrade failed due to a database error
 */
function upgrade_local($upgrade) {
    db_begin();

    require_once(get_config('docroot') . 'local/upgrade.php');
    xmldb_local_upgrade($upgrade->from);

    set_config('localversion', $upgrade->to);
    set_config('localrelease', $upgrade->torelease);
401
    bump_cache_version();
402
403
404
405
406

    db_commit();
    return true;
}

407
408
409
/**
 * Upgrades the plugin to a new version
 *
410
411
412
413
 * Note: This function is sometimes executed during upgrades from
 * ancient databases.  Avoid rash assumptions about what's installed
 * or these upgrades may fail.
 *
414
415
 * @param object $upgrade   Information about the plugin to upgrade
 * @return bool             Whether the upgrade succeeded or not
416
 * @throws SQLException     If the upgrade failed due to a database error
417
 */
418
419
420
421
422
423
424
425
function upgrade_plugin($upgrade) {
    global $db;

    $plugintype = '';
    $pluginname = '';

    list($plugintype, $pluginname) = explode('.', $upgrade->name);

426
427
    if ($plugintype == 'blocktype' && strpos($pluginname, '/') !== false) {
        list($artefactplugin, $blocktypename) = explode('/', $pluginname);
428
429
430
431
432
433
        $location = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $blocktypename . '/db/';
        $function = 'xmldb_' . $plugintype . '_' . $blocktypename . '_upgrade';
    }
    else {
        $location = get_config('docroot') . $plugintype . '/' . $pluginname . '/db/';
        $function = 'xmldb_' . $plugintype . '_' . $pluginname . '_upgrade';
Elliot Pahl's avatar
Elliot Pahl committed
434
    }
435

436
    db_begin();
437
438
439

    if (!empty($upgrade->install)) {
        if (is_readable($location . 'install.xml')) {
440
            install_from_xmldb_file($location . 'install.xml');
441
442
443
444
445
        }
    }
    else {
        if (is_readable($location .  'upgrade.php')) {
            require_once($location . 'upgrade.php');
446
447
448
            if (!$function($upgrade->from)) {
                throw new InstallationException("Failed to run " . $function . " (check logs for errors)");
            }
449
450
451
452
453
454
455
        }
    }

    $installed = new StdClass;
    $installed->name = $pluginname;
    $installed->version = $upgrade->to;
    $installed->release = $upgrade->torelease;
456
457
458
459
460
461
462
463
    if ($plugintype == 'blocktype') {
        if (!empty($blocktypename)) {
            $installed->name = $blocktypename;
        }
        if (!empty($artefactplugin)) { // blocks come from artefactplugins.
            $installed->artefactplugin = $artefactplugin;
        }
    }
464
465
466
467
468
469
    if (property_exists($upgrade, 'requires_config')) {
        $installed->requires_config = $upgrade->requires_config;
    }
    if (property_exists($upgrade, 'requires_parent')) {
        $installed->requires_parent = $upgrade->requires_parent;
    }
470
    $installtable = $plugintype . '_installed';
471
472
473

    if (!empty($upgrade->install)) {
        insert_record($installtable,$installed);
Elliot Pahl's avatar
Elliot Pahl committed
474
    }
475
476
477
    else {
        update_record($installtable, $installed, 'name');
    }
478
    bump_cache_version();
479
480

    // postinst stuff...
Nigel McNie's avatar
Nigel McNie committed
481
    safe_require($plugintype, $pluginname);
482
    $pcname = generate_class_name($plugintype, $installed->name);
483
484
485
486
487
488
489
490
491
492
493

    if ($crons = call_static_method($pcname, 'get_cron')) {
        foreach ($crons as $cron) {
            $cron = (object)$cron;
            if (empty($cron->callfunction)) {
                throw new InstallationException("cron for $pcname didn't supply function name");
            }
            if (!is_callable(array($pcname, $cron->callfunction))) {
                throw new InstallationException("cron $cron->callfunction for $pcname supplied but wasn't callable");
            }
            $new = false;
494
            $table = $plugintype . '_cron';
495
496
497
            if (!empty($upgrade->install)) {
                $new = true;
            }
498
            else if (!record_exists($table, 'plugin', $pluginname, 'callfunction', $cron->callfunction)) {
499
500
501
502
                $new = true;
            }
            $cron->plugin = $pluginname;
            if (!empty($new)) {
503
                insert_record($table, $cron);
504
505
            }
            else {
506
                update_record($table, $cron, array('plugin', 'callfunction'));
507
508
509
            }
        }
    }
Elliot Pahl's avatar
Elliot Pahl committed
510

511
512
513
514
    if ($events = call_static_method($pcname, 'get_event_subscriptions')) {
        foreach ($events as $event) {
            $event = (object)$event;

515
            if (!record_exists('event_type', 'name', $event->event)) {
516
517
518
519
520
521
522
523
524
                throw new InstallationException("event $event->event for $pcname doesn't exist!");
            }
            if (empty($event->callfunction)) {
                throw new InstallationException("event $event->event for $pcname didn't supply function name");
            }
            if (!is_callable(array($pcname, $event->callfunction))) {
                throw new InstallationException("event $event->event with function $event->callfunction for $pcname supplied but wasn't callable");
            }
            $exists = false;
525
            $table = $plugintype . '_event_subscription';
526
            $block = blocktype_namespaced_to_single($pluginname);
527
            if (empty($upgrade->install)) {
528
                $exists = get_record($table, 'plugin' , $block, 'event', $event->event);
529
            }
530
            $event->plugin = $block;
531
            if (empty($exists)) {
532
                insert_record($table, $event);
533
534
            }
            else {
535
                update_record($table, $event, array('id' => $exists->id));
536
537
538
539
            }
        }
    }

540
541
542
543
544
545
    if ($activities = call_static_method($pcname, 'get_activity_types')) {
        foreach ($activities as $activity) {
            $classname = 'ActivityType' . ucfirst($plugintype) . ucfirst($pluginname) . ucfirst($activity->name);
            if (!class_exists($classname)) {
                throw new InstallationException(get_string('classmissing', 'error',  $classname, $pluginname, $plugintype));
            }
546
547
548
549
550
551
552
553
554
555
556
557
            // Add activity_type if it doesn't exist
            if (!get_record('activity_type', 'name', $activity->name, 'plugintype', $plugintype, 'pluginname', $pluginname)) {
                $activity->plugintype = $plugintype;
                $activity->pluginname = $pluginname;
                $activity->defaultmethod = get_config('defaultnotificationmethod') ? get_config('defaultnotificationmethod') : $activity->defaultmethod;
                $where = (object) array(
                    'name'       => $activity->name,
                    'plugintype' => $plugintype,
                    'pluginname' => $pluginname,
                );
                ensure_record_exists('activity_type', $where, $activity);
            }
558
559
560
        }
    }

561
    // install artefact types
562
    if ($plugintype == 'artefact') {
563
564
565
        if (!is_callable(array($pcname, 'get_artefact_types'))) {
            throw new InstallationException("Artefact plugin $pcname must implement get_artefact_types and doesn't");
        }
566
567
568
        $types = call_static_method($pcname, 'get_artefact_types');
        $ph = array();
        if (is_array($types)) {
569
570
571
572
573
574
575
576
577
578
            // Check for missing plugins - don't try to remove their data.
            // Bugs 505732 and 1287344.
            $used_types = get_records_sql_assoc("SELECT t.name, count(a.id) ct, t.plugin FROM {artefact_installed_type} t
                    LEFT JOIN {artefact} a ON t.name = a.artefacttype
                    GROUP BY t.name
                    HAVING count(a.id) > 0 AND plugin = '$pluginname'");
            if ($used_types === FALSE) {
                $used_types = array();
            }

579
580
581
582
583
584
585
586
            foreach ($types as $type) {
                $ph[] = '?';
                if (!record_exists('artefact_installed_type', 'plugin', $pluginname, 'name', $type)) {
                    $t = new StdClass;
                    $t->name = $type;
                    $t->plugin = $pluginname;
                    insert_record('artefact_installed_type',$t);
                }
587
588
589
                if (isset($used_types[$type])) {
                    unset($used_types[$type]);
                }
590
            }
591
592
593
594
595
596
597

            foreach ($used_types as $type) {
                $ph[] = '?';
            }

            $used_types = array_keys($used_types);

598
599
            $select = '(plugin = ? AND name NOT IN (' . implode(',', $ph) . '))';
            delete_records_select('artefact_installed_type', $select,
600
601
602
603
                    array_merge(array($pluginname),$types,$used_types));
            if (!empty($used_types)) {
                log_warn('Plugin for artefact type(s) "' . implode('", "', $used_types) . '" has gone away', true, false);
            }
604
605
        }
    }
Elliot Pahl's avatar
Elliot Pahl committed
606

607
608
609
    // install blocktype categories.
    if ($plugintype == 'blocktype' && get_config('installed')) {
        install_blocktype_categories_for_plugin($pluginname);
610
        install_blocktype_viewtypes_for_plugin($pluginname);
611
612
    }

613
614
    $prevversion = (empty($upgrade->install)) ? $upgrade->from : 0;
    call_static_method($pcname, 'postinst', $prevversion);
Elliot Pahl's avatar
Elliot Pahl committed
615

616
617
    db_commit();
    return true;
618
619
620
}

function core_postinst() {
621
    // Attempt to create session directories
622
    $sessionpath = get_config('sessionpath');
623
    $status = Session::create_directory_levels($sessionpath);
624

625
    $now = db_format_timestamp(time());
626
627
628
    // Set default search plugin
    set_config('searchplugin', 'internal');

629
    set_config('lang', 'en.utf8');
630
    set_config('installation_key', get_random_key());
631
    set_config('installation_time', $now);
632
    set_config('stats_installation_time', $now);
633
    set_config('passwordpolicy', '8_ulns');
634

635
636
637
638
639
640
641
    // Pre-define SMTP settings
    set_config('smtphosts', '');
    set_config('smtpport', '');
    set_config('smtpuser', '');
    set_config('smtppass', '');
    set_config('smtpsecure', '');

642
643
644
645
646
647
648
649
650
    // XMLDB adds a table's keys immediately after creating the table.  Some
    // foreign keys therefore cannot be created during the XMLDB installation,
    // because they refer to tables created later in the installation.  These
    // missing keys can be created now that all the core tables exist.
    $table = new XMLDBTable('usr');
    $key = new XMLDBKey('profileiconfk');
    $key->setAttributes(XMLDB_KEY_FOREIGN, array('profileicon'), 'artefact', array('id'));
    add_key($table, $key);

651
652
653
654
655
    $table = new XMLDBTable('institution');
    $key = new XMLDBKey('logofk');
    $key->setAttributes(XMLDB_KEY_FOREIGN, array('logo'), 'artefact', array('id'));
    add_key($table, $key);

656
    // PostgreSQL supports indexes over functions of columns, MySQL does not.
657
    // We make use if this if we can
658
    if (is_postgres()) {
659
        // Improve the username index
660
661
        execute_sql('DROP INDEX {usr_use_uix}');
        execute_sql('CREATE UNIQUE INDEX {usr_use_uix} ON {usr}(LOWER(username))');
662

663
664
665
666
667
668
669
670
671
        // Add user search indexes
        // Postgres only.  We could create non-lowercased indexes in MySQL, but
        // they would not be useful, and would require a change to varchar columns.
        execute_sql('CREATE INDEX {usr_fir_ix} ON {usr}(LOWER(firstname))');
        execute_sql('CREATE INDEX {usr_las_ix} ON {usr}(LOWER(lastname))');
        execute_sql('CREATE INDEX {usr_pre_ix} ON {usr}(LOWER(preferredname))');
        execute_sql('CREATE INDEX {usr_ema_ix} ON {usr}(LOWER(email))');
        execute_sql('CREATE INDEX {usr_stu_ix} ON {usr}(LOWER(studentid))');

672
673
        // Only one profile view per user
        execute_sql("CREATE UNIQUE INDEX {view_own_type_uix} ON {view}(owner) WHERE type = 'profile'");
674
675
    }

676
677
678
679
680
681
682
683
684
685
686
    // Some more advanced constraints. XMLDB can't handle this in its xml file format
    execute_sql('ALTER TABLE {artefact} ADD CHECK (
        (owner IS NOT NULL AND "group" IS NULL     AND institution IS NULL) OR
        (owner IS NULL     AND "group" IS NOT NULL AND institution IS NULL) OR
        (owner IS NULL     AND "group" IS NULL     AND institution IS NOT NULL)
    )');
    execute_sql('ALTER TABLE {view} ADD CHECK (
        (owner IS NOT NULL AND "group" IS NULL     AND institution IS NULL) OR
        (owner IS NULL     AND "group" IS NOT NULL AND institution IS NULL) OR
        (owner IS NULL     AND "group" IS NULL     AND institution IS NOT NULL)
    )');
687
688
689
690
    execute_sql('ALTER TABLE {artefact} ADD CHECK (
        (author IS NOT NULL AND authorname IS NULL    ) OR
        (author IS NULL     AND authorname IS NOT NULL)
    )');
691
    execute_sql('ALTER TABLE {view_access} ADD CHECK (
692
693
694
695
696
        (accesstype IS NOT NULL AND "group" IS NULL     AND usr IS NULL     AND token IS NULL   AND institution IS NULL) OR
        (accesstype IS NULL     AND "group" IS NOT NULL AND usr IS NULL     AND token IS NULL AND institution IS NULL) OR
        (accesstype IS NULL     AND "group" IS NULL     AND usr IS NOT NULL AND token IS NULL AND institution IS NULL) OR
        (accesstype IS NULL     AND "group" IS NULL     AND usr IS NULL     AND token IS NOT NULL AND institution IS NULL) OR
        (accesstype IS NULL     AND "group" IS NULL     AND usr IS NULL     AND token IS NULL AND institution IS NOT NULL)
697
    )');
698
699
700
701
702
    execute_sql('ALTER TABLE {collection} ADD CHECK (
        (owner IS NOT NULL AND "group" IS NULL     AND institution IS NULL) OR
        (owner IS NULL     AND "group" IS NOT NULL AND institution IS NULL) OR
        (owner IS NULL     AND "group" IS NULL     AND institution IS NOT NULL)
    )');
703

704
    set_antispam_defaults();
705
    reload_html_filters();
706
707

    // Default set of sites from which iframe content can be embedded
708
709
    // See also the postinst() function in plugins for other valid iframes
    // by searching for 'iframe_source_icon'
710
711
712
713
714
715
716
717
718
    $iframesources = array(
        'www.youtube.com/embed/'                   => 'YouTube',
        'player.vimeo.com/video/'                  => 'Vimeo',
        'www.slideshare.net/slideshow/embed_code/' => 'SlideShare',
        'www.glogster.com/glog/'                   => 'Glogster',
        'www.glogster.com/glog.php'                => 'Glogster',
        'edu.glogster.com/glog/'                   => 'Glogster',
        'edu.glogster.com/glog.php'                => 'Glogster',
        'wikieducator.org/index.php'               => 'WikiEducator',
719
        'voki.com/php/'                            => 'Voki',
720
721
722
723
724
725
726
    );
    $iframedomains = array(
        'YouTube'      => 'www.youtube.com',
        'Vimeo'        => 'vimeo.com',
        'SlideShare'   => 'www.slideshare.net',
        'Glogster'     => 'www.glogster.com',
        'WikiEducator' => 'wikieducator.org',
727
        'Voki'         => 'voki.com',
728
729
730
    );
    update_safe_iframes($iframesources, $iframedomains);

731
732
733
    require_once(get_config('docroot') . 'lib/file.php');
    update_magicdb_path();

734
    return $status;
735
736
}

737
function core_install_lastcoredata_defaults() {
738
    global $USER;
739
    db_begin();
740
    $institution = new StdClass;
741
742
743
    $institution->name = 'mahara';
    $institution->displayname = 'No Institution';
    $institution->authplugin  = 'internal';
744
    $institution->theme  = 'default';
745
    $institution->priority = 0;
746
    insert_record('institution', $institution);
747

748
    $auth_instance = new StdClass;
749
    $auth_instance->instancename  = 'Internal';
750
    $auth_instance->priority='1';
751
752
    $auth_instance->institution   = 'mahara';
    $auth_instance->authname      = 'internal';
753
    $auth_instance->active        = 1;
754
755
    $auth_instance->id = insert_record('auth_instance', $auth_instance, 'id', true);

756
    // Insert the root user
757
    $userid = 0;
758
    $user = new StdClass;
759
    $user->id = $userid;
760
761
762
763
764
765
    $user->username = 'root';
    $user->password = '*';
    $user->salt = '*';
    $user->firstname = 'System';
    $user->lastname = 'User';
    $user->email = 'root@example.org';
766
    $user->quota = get_config_plugin('artefact', 'file', 'defaultquota');
767
    $user->authinstance = $auth_instance->id;
768
    $user->admin = 1;
769

770
771
    if (is_mysql()) { // gratuitous mysql workaround
        $newid = insert_record('usr', $user, 'id', true);
772
        set_field('usr', 'id', 0, 'id', $newid);
773
        execute_sql('ALTER TABLE {usr} AUTO_INCREMENT=1');
774
    }
775
776
777
    else {
        insert_record('usr', $user);
    }
778

779
780
781
782
783
    $pages = site_content_pages();
    $now = db_format_timestamp(time());
    foreach ($pages as $name) {
        $page = new stdClass();
        $page->ctime = $now;
784
        $page->institution = 'mahara';
785
        $page->content = get_string($name . 'defaultcontent', 'install', get_string('staticpageconfigdefaults', 'install',  get_config('wwwroot') . 'admin/site/pages.php'));
786
        $page->name = $name;
787
788
789
790
791
        $page->mtime = $now;
        $page->mauthor = $userid;
        insert_record('site_content', $page);
    }

792
793
794
795
796
    $versionedpages = site_content_version_pages();
    foreach ($versionedpages as $name) {
        $page = new stdClass();
        $page->ctime = $now;
        $page->institution = 'mahara';
797
        $page->content = get_string($name . 'defaultcontent', 'install', get_string('versionedpageconfigdefault', 'install', get_config('wwwroot') . 'admin/site/privacy.php?fs=' . $name));
798
799
800
801
802
803
        $page->type = $name;
        $page->author = $userid;
        $page->version = '1.0';
        insert_record('site_content_version', $page);
    }

804
805
806
    // install the default layout options
    install_view_layout_defaults();

807
    require_once('group.php');
808
    install_system_profile_view();
809
    install_system_dashboard_view();
810
    install_system_grouphomepage_view();
811
812
    require_once('view.php');
    install_system_portfolio_view();
813

814
815
816
    require_once('license.php');
    install_licenses_default();

817
818
819
    require_once('skin.php');
    install_skins_default();

820
821
    install_auth_default();

822
823
824
825
    // Remove admin privs from root user as it doesn't need it now
    $user->admin = 0;
    update_record('usr', $user, array('id' => 0));

826
    // Insert the admin user
827
828
    $user = new StdClass;
    $user->username = 'admin';
829
    $user->salt = auth_get_random_salt();
830
    $user->password = crypt('mahara', '$2a$' . get_config('bcrypt_cost') . '$' . substr(md5(get_config('passwordsaltmain') . $user->salt), 0, 22));
831
    $user->password = substr($user->password, 0, 7) . substr($user->password, 7+22);
832
    $user->authinstance = $auth_instance->id;
833
834
835
836
837
    $user->passwordchange = 1;
    $user->admin = 1;
    $user->firstname = 'Admin';
    $user->lastname = 'User';
    $user->email = 'admin@example.org';
838
    $user->quota = get_config_plugin('artefact', 'file', 'defaultquota');
839
    $user->ctime = db_format_timestamp(time());
840
841
842
843
    $user->id = insert_record('usr', $user, 'id', true);
    set_profile_field($user->id, 'email', $user->email);
    set_profile_field($user->id, 'firstname', $user->firstname);
    set_profile_field($user->id, 'lastname', $user->lastname);
844
845
    // Accept the user privacy agreement on install
    $sitecontentid = get_field('site_content_version', 'id', 'type', 'privacy', 'institution', 'mahara');
846
847
848
    save_user_reply_to_agreement($user->id, $sitecontentid, 1);
    // Accept the user T&C on install
    $sitecontentid = get_field('site_content_version', 'id', 'type', 'termsandconditions', 'institution', 'mahara');
849
    save_user_reply_to_agreement($user->id, $sitecontentid, 1);
850
    handle_event('createuser', $user, array('password'));
851
    activity_add_admin_defaults(array($user->id));
852
    db_commit();
853
854

    // if we're installing, set up the block categories here and then poll the plugins.
Elliot Pahl's avatar
Elliot Pahl committed
855
    // if we're upgrading this happens somewhere else.  This is because of dependency issues around
856
    // the order of installation stuff.
857
    install_blocktype_extras();
858
859
}

860
861
862
function core_install_firstcoredata_defaults() {
    // Install the default institution
    db_begin();
Elliot Pahl's avatar
Elliot Pahl committed
863

864
    set_config('session_timeout', 86400);
865
    set_config('sitename', 'Mahara');
866
    set_config('defaultregistrationexpirylifetime', 1209600);
867
    set_config('defaultaccountinactivewarn', 604800);
868
    set_config('creategroups', 'all');
869
    set_config('createpublicgroups', 'all');
870
    set_config('allowpublicviews', 1);
871
    set_config('allowpublicprofiles', 1);
872
    set_config('allowanonymouspages', 0);
873
    set_config('generatesitemap', 1);
874
875
876
    set_config('showselfsearchsideblock', 0);
    set_config('showtagssideblock', 1);
    set_config('tagssideblockmaxtags', 20);
877
    set_config('usersallowedmultipleinstitutions', 1);
878
    set_config('userscanchooseviewthemes', 0);
879
    set_config('anonymouscomments', 1);
880
    set_config('homepageinfo', 1);
881
    set_config('showonlineuserssideblock', 1);
882
    set_config('footerlinks', serialize(array('legal', 'about', 'contactus', 'manualhelp')));
883
    set_config('nousernames', 0);
884
    set_config('onlineuserssideblockmaxusers', 10);
885
    set_config('loggedinprofileviewaccess', 1);
886
    set_config('dropdownmenu', 0);
887
888
    // Set this to a random starting number to make minor version slightly harder to detect
    set_config('cacheversion', rand(1000, 9999));
889
    set_config('watchlistnotification_delay', 20);
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916

    // install the applications
    $app = new StdClass;
    $app->name = 'mahara';
    $app->displayname = 'Mahara';
    $app->xmlrpcserverurl = '/api/xmlrpc/server.php';
    $app->ssolandurl = '/auth/xmlrpc/land.php';
    insert_record('application', $app);

    $app->name = 'moodle';
    $app->displayname = 'Moodle';
    $app->xmlrpcserverurl = '/mnet/xmlrpc/server.php';
    $app->ssolandurl = '/auth/mnet/land.php';
    insert_record('application', $app);

    // insert the event types
    $eventtypes = array(
        'createuser',
        'updateuser',
        'suspenduser',
        'unsuspenduser',
        'deleteuser',
        'undeleteuser',
        'expireuser',
        'unexpireuser',
        'deactivateuser',
        'activateuser',
917
        'userjoinsgroup',
918
        'userleavesgroup',
919
920
        'saveartefact',
        'deleteartefact',
921
        'deleteartefacts',
922
923
        'saveview',
        'deleteview',
924
        'blockinstancecommit',
925
        'deleteblockinstance',
926
927
928
929
        'addfriend',
        'removefriend',
        'addfriendrequest',
        'removefriendrequest',
Richard Mansfield's avatar
Richard Mansfield committed
930
        'creategroup',
931
        'loginas',
932
        'clearcaches',
933
934
935
936
937
938
        'createview',
        'createcollection',
        'updatecollection',
        'deletecollection',
        'addsubmission',
        'releasesubmission',
939
940
        'updateviewaccess',
        'sharedcommenttogroup'
941
942
943
944
945
946
947
948
    );

    foreach ($eventtypes as $et) {
        $e = new StdClass;
        $e->name = $et;
        insert_record('event_type', $e);
    }

949
950
951
952
953
    // install the core event subscriptions
    $subs = array(
        array(
            'event'        => 'createuser',
            'callfunction' => 'activity_set_defaults',
954
        ),
955
956
957
958
        array(
            'event'        => 'createuser',
            'callfunction' => 'add_user_to_autoadd_groups',
        ),
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
        array(
            'event'         => 'blockinstancecommit',
            'callfunction'  => 'watchlist_record_changes',
        ),
        array(
            'event'         => 'deleteblockinstance',
            'callfunction'  => 'watchlist_block_deleted',
        ),
        array(
            'event'         => 'saveartefact',
            'callfunction'  => 'watchlist_record_changes',
        ),
        array(
            'event'         => 'saveview',
            'callfunction'  => 'watchlist_record_changes',
        ),
975
976
977
978
979
    );

    foreach ($subs as $sub) {
        insert_record('event_subscription', (object)$sub);
    }
Elliot Pahl's avatar
Elliot Pahl committed
980

981
    // Install the activity types. Name, admin, delay, allownonemethod, defaultmethod.
982
    $activitytypes = array(
983
984
985
986
987
988
989
990
991
992
        array('maharamessage',      0, 0, 0, 'email'),
        array('usermessage',        0, 0, 0, 'email'),
        array('watchlist',          0, 1, 1, 'email'),
        array('viewaccess',         0, 1, 1, 'email'),
        array('contactus',          1, 1, 1, 'email'),
        array('objectionable',      1, 1, 1, 'email'),
        array('virusrepeat',        1, 1, 1, 'email'),
        array('virusrelease',       1, 1, 1, 'email'),
        array('institutionmessage', 0, 0, 1, 'email'),
        array('groupmessage',       0, 1, 1, 'email'),
993
994
995
996
997
998
999
    );

    foreach ($activitytypes as $at) {
        $a = new StdClass;
        $a->name = $at[0];
        $a->admin = $at[1];
        $a->delay = $at[2];
1000
        $a->allownonemethod = $at[3];
1001
        $a->defaultmethod = $at[4];
1002
1003
1004
1005
1006
        insert_record('activity_type', $a);
    }

    // install the cronjobs...
    $cronjobs = array(
1007
        'auth_clean_partial_registrations'          => array('5', '0', '*', '*', '*'),
1008
        'auth_clean_expired_password_requests'      => array('5', '0', '*', '*', '*'),
1009
1010
1011
1012
1013
1014
        'auth_handle_account_expiries'              => array('5', '10', '*', '*', '*'),
        'auth_handle_institution_expiries'          => array('5', '9', '*', '*', '*'),
        'activity_process_queue'                    => array('*/5', '*', '*', '*', '*'),
        'auth_remove_old_session_files'             => array('30', '20', '*', '*', '*'),
        'recalculate_quota'                         => array('15', '2', '*', '*', '*'),
        'import_process_queue'                      => array('*/5', '*', '*', '*', '*'),
1015
1016
        'export_process_queue'                      => array('*/6', '*', '*', '*', '*'),
        'submissions_delete_removed_archive'        => array('15', '1', '1', '*', '*'),
1017
1018
1019
1020
1021
1022
1023
        'cron_send_registration_data'               => array(rand(0, 59), rand(0, 23), '*', '*', rand(0, 6)),
        'export_cleanup_old_exports'                => array('0', '3,15', '*', '*', '*'),
        'import_cleanup_old_imports'                => array('0', '4,16', '*', '*', '*'),
        'cron_site_data_weekly'                     => array('55', '23', '*', '*', '6'),
        'cron_site_data_daily'                      => array('51', '23', '*', '*', '*'),
        'cron_check_for_updates'                    => array(rand(0, 59), rand(0, 23), '*', '*', '*'),
        'cron_clean_internal_activity_notifications'=> array(45, 22, '*', '*', '*'),
1024
        'cron_sitemap_daily'                        => array(0, 1, '*', '*', '*'),
1025
        'file_cleanup_old_cached_files'             => array(0, 1, '*', '*', '*'),
1026
        'user_login_tries_to_zero'                  => array('2-59/5', '*', '*', '*', '*'),