upgrade.php 57.4 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
30
 * @param string $name The name of the plugin to check. If no name is specified,
 *                     all plugins are checked.
 * @return array of objects
31
 */
32
function check_upgrades($name=null) {
33

34
35
36
37
    $pluginstocheck = plugin_types();

    $toupgrade = array();
    $installing = false;
38
    $disablelogin = false;
39
40

    require('version.php');
41
42
43
    if (isset($config->disablelogin) && !empty($config->disablelogin)) {
        $disablelogin = true;
    }
44
45
46
47
    // check core first...
    if (empty($name) || $name == 'core') {
        try {
            $coreversion = get_config('version');
Elliot Pahl's avatar
Elliot Pahl committed
48
        }
49
50
51
52
        catch (Exception $e) {
            $coreversion = 0;
        }
        if (empty($coreversion)) {
53
            if (is_mysql()) { // Show a more informative error message if using mysql with skip-innodb
54
                // In MySQL 5.6.x, we run the command 'SHOW ENGINES' to check if InnoDB is enabled or not
55
                global $db;
56
57
58
59
60
61
62
63
64
65
66
                $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) {
67
68
69
                    throw new ConfigSanityException("Mahara requires InnoDB tables.  Please ensure InnoDB tables are enabled in your MySQL server.");
                }
            }
70
            $core = new stdClass();
71
            $core->install = true;
72
73
74
75
            $core->to = $config->version;
            $core->torelease = $config->release;
            $core->toseries = $config->series;
            $toupgrade['core'] = $core;
76
            $installing = true;
Elliot Pahl's avatar
Elliot Pahl committed
77
        }
78
        else if ($config->version > $coreversion) {
79
            $corerelease = get_config('release');
Elliot Pahl's avatar
Elliot Pahl committed
80
            if (isset($config->minupgradefrom) && isset($config->minupgraderelease)
81
                && $coreversion < $config->minupgradefrom) {
82
                throw new ConfigSanityException("Must upgrade to $config->minupgradefrom "
83
84
                                          . "($config->minupgraderelease) first "
                                          . " (you have $coreversion ($corerelease)");
85
            }
86
            $core = new stdClass();
87
88
            $core->upgrade = true;
            $core->from = $coreversion;
89
            $core->fromrelease = $corerelease;
90
91
92
93
            $core->to = $config->version;
            $core->torelease = $config->release;
            $core->toseries = $config->series;
            $toupgrade['core'] = $core;
94
95
96
        }
    }

97
    // If we were just checking if the core needed to be upgraded, we can stop here
98
    if ($name == 'core') {
99
        $toupgrade['core']->disablelogin = $disablelogin;
100
101
102
        return $toupgrade['core'];
    }

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
    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) {
            $toupgrade['local'] = (object) array(
                'upgrade'     => true,
                'from'        => $localversion,
                'fromrelease' => $localrelease,
                'to'          => $config->version,
                'torelease'   => $config->release,
            );
        }

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

130
131
    $plugins = array();
    if (!empty($name)) {
132
133
134
135
136
137
        try {
            $bits = explode('.', $name);
            $pt = $bits[0];
            $pn = $bits[1];
            $pp = null;
            if ($pt == 'blocktype' && strpos($pn, '/') !== false) {
138
                $bits = explode('/', $pn);
139
140
141
142
143
144
                $pp = get_config('docroot') . 'artefact/' . $bits[0]  . '/blocktype/' . $bits[1];
            }
            validate_plugin($pt, $pn, $pp);
            $plugins[] = explode('.', $name);
        }
        catch (InstallationException $_e) {
145
            log_warn("Plugin $pt $pn is not installable: " . $_e->GetMessage());
146
        }
147
148
149
150
151
    }
    else {
        foreach ($pluginstocheck as $plugin) {
            $dirhandle = opendir(get_config('docroot') . $plugin);
            while (false !== ($dir = readdir($dirhandle))) {
152
                if (strpos($dir, '.') === 0 or 'CVS' == $dir) {
153
154
155
156
157
                    continue;
                }
                if (!is_dir(get_config('docroot') . $plugin . '/' . $dir)) {
                    continue;
                }
158
159
160
161
162
                try {
                    validate_plugin($plugin, $dir);
                    $plugins[] = array($plugin, $dir);
                }
                catch (InstallationException $_e) {
163
                    log_warn("Plugin $plugin $dir is not installable: " . $_e->GetMessage());
164
165
166
                }

                if ($plugin == 'artefact') { // go check it for blocks as well
167
                    $btlocation = get_config('docroot') . $plugin . '/' . $dir . '/blocktype';
168
                    if (!is_dir($btlocation)) {
169
                        continue;
Elliot Pahl's avatar
Elliot Pahl committed
170
                    }
171
172
                    $btdirhandle = opendir($btlocation);
                    while (false !== ($btdir = readdir($btdirhandle))) {
173
                        if (strpos($btdir, '.') === 0 or 'CVS' == $btdir) {
174
175
                            continue;
                        }
176
                        if (!is_dir(get_config('docroot') . $plugin . '/' . $dir . '/blocktype/' . $btdir)) {
177
178
179
                            continue;
                        }
                        $plugins[] = array('blocktype', $dir . '/' . $btdir);
180
181
                    }
                }
182
183
184
185
186
187
188
189
190
191
            }
        }
    }

    foreach ($plugins as $plugin) {
        $plugintype = $plugin[0];
        $pluginname = $plugin[1];
        $pluginpath = "$plugin[0]/$plugin[1]";
        $pluginkey  = "$plugin[0].$plugin[1]";

192
193
194
195
196
197
        if ($plugintype == 'blocktype' && strpos($pluginname, '/') !== false) {
            // sigh.. we're a bit special...
            $bits = explode('/', $pluginname);
            $pluginpath = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1];
        }

198
199
200
        // Don't try to get the plugin info if we are installing - it will
        // definitely fail
        $pluginversion = 0;
201
202
203
204
205
206
207
208
209
        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) {
210
211
212
                $pluginversion = $installed->version;
                $pluginrelease =  $installed->release;
            }
213
        }
214
215

        $config = new StdClass;
216
217
218
        require(get_config('docroot') . $pluginpath . '/version.php');
        if (isset($config->disablelogin) && !empty($config->disablelogin)) {
            $disablelogin = true;
219
220
221
        }

        if (empty($pluginversion)) {
222
223
224
            if (empty($installing) && $pluginkey != $name) {
                continue;
            }
225
226
227
228
            $plugininfo = new StdClass;
            $plugininfo->install = true;
            $plugininfo->to = $config->version;
            $plugininfo->torelease = $config->release;
229
230
231
232
233
234
            if (property_exists($config, 'requires_config')) {
                $plugininfo->requires_config = $config->requires_config;
            }
            if (property_exists($config, 'requires_parent')) {
                $plugininfo->requires_parent = $config->requires_parent;
            }
235
236
237
            $toupgrade[$pluginkey] = $plugininfo;
        }
        else if ($config->version > $pluginversion) {
238
239
240
241
242
            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))");
243
            }
244
245
246
247
248
249
            $plugininfo = new StdClass;
            $plugininfo->upgrade = true;
            $plugininfo->from = $pluginversion;
            $plugininfo->fromrelease = $pluginrelease;
            $plugininfo->to = $config->version;
            $plugininfo->torelease = $config->release;
250
251
252
253
254
255
            if (property_exists($config, 'requires_config')) {
                $plugininfo->requires_config = $config->requires_config;
            }
            if (property_exists($config, 'requires_parent')) {
                $plugininfo->requires_parent = $config->requires_parent;
            }
256
257
258
259
260
261
262
263
264
265
266
            $toupgrade[$pluginkey] = $plugininfo;
        }
    }

    // if we've just asked for one, don't return an array...
    if (!empty($name) && count($toupgrade) == 1) {
        $upgrade = new StdClass;
        $upgrade->name = $name;
        foreach ((array)$toupgrade[$name] as $key => $value) {
            $upgrade->{$key} = $value;
        }
267
        $upgrade->disablelogin = $disablelogin;
268
269
        return $upgrade;
    }
270
    $toupgrade['disablelogin'] = $disablelogin;
271
272
273
    if (count($toupgrade) == 1) {
        $toupgrade = array();
    }
274
    uksort($toupgrade, 'sort_upgrades');
275
276
277
    return $toupgrade;
}

278
279
280
281
282
/**
 * Upgrades the core system to given upgrade version.
 *
 * @param object $upgrade   The version to upgrade to
 * @return bool             Whether the upgrade succeeded or not
283
 * @throws SQLException     If the upgrade failed due to a database error
284
 */
285
286
287
function upgrade_core($upgrade) {
    global $db;

288
    $location = get_config('libroot') . 'db/';
Penny Leach's avatar
Penny Leach committed
289
290

    db_begin();
291
292

    if (!empty($upgrade->install)) {
293
        install_from_xmldb_file($location . 'install.xml');
294
295
296
    }
    else {
        require_once($location . 'upgrade.php');
Penny Leach's avatar
Penny Leach committed
297
        xmldb_core_upgrade($upgrade->from);
298
299
    }

Penny Leach's avatar
Penny Leach committed
300
301
    set_config('version', $upgrade->to);
    set_config('release', $upgrade->torelease);
302
    set_config('series', $upgrade->toseries);
303
    bump_cache_version();
Elliot Pahl's avatar
Elliot Pahl committed
304

305
    if (!empty($upgrade->install)) {
Penny Leach's avatar
Penny Leach committed
306
        core_postinst();
307
    }
308

Penny Leach's avatar
Penny Leach committed
309
310
    db_commit();
    return true;
311
312
}

313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
/**
 * 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);
328
    bump_cache_version();
329
330
331
332
333

    db_commit();
    return true;
}

334
335
336
/**
 * Upgrades the plugin to a new version
 *
337
338
339
340
 * Note: This function is sometimes executed during upgrades from
 * ancient databases.  Avoid rash assumptions about what's installed
 * or these upgrades may fail.
 *
341
342
 * @param object $upgrade   Information about the plugin to upgrade
 * @return bool             Whether the upgrade succeeded or not
343
 * @throws SQLException     If the upgrade failed due to a database error
344
 */
345
346
347
348
349
350
351
352
function upgrade_plugin($upgrade) {
    global $db;

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

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

353
354
    if ($plugintype == 'blocktype' && strpos($pluginname, '/') !== false) {
        list($artefactplugin, $blocktypename) = explode('/', $pluginname);
355
356
357
358
359
360
        $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
361
    }
362

363
    db_begin();
364
365
366

    if (!empty($upgrade->install)) {
        if (is_readable($location . 'install.xml')) {
367
            install_from_xmldb_file($location . 'install.xml');
368
369
370
371
372
        }
    }
    else {
        if (is_readable($location .  'upgrade.php')) {
            require_once($location . 'upgrade.php');
373
374
375
            if (!$function($upgrade->from)) {
                throw new InstallationException("Failed to run " . $function . " (check logs for errors)");
            }
376
377
378
379
380
381
382
        }
    }

    $installed = new StdClass;
    $installed->name = $pluginname;
    $installed->version = $upgrade->to;
    $installed->release = $upgrade->torelease;
383
384
385
386
387
388
389
390
    if ($plugintype == 'blocktype') {
        if (!empty($blocktypename)) {
            $installed->name = $blocktypename;
        }
        if (!empty($artefactplugin)) { // blocks come from artefactplugins.
            $installed->artefactplugin = $artefactplugin;
        }
    }
391
392
393
394
395
396
    if (property_exists($upgrade, 'requires_config')) {
        $installed->requires_config = $upgrade->requires_config;
    }
    if (property_exists($upgrade, 'requires_parent')) {
        $installed->requires_parent = $upgrade->requires_parent;
    }
397
    $installtable = $plugintype . '_installed';
398
399
400

    if (!empty($upgrade->install)) {
        insert_record($installtable,$installed);
Elliot Pahl's avatar
Elliot Pahl committed
401
    }
402
403
404
    else {
        update_record($installtable, $installed, 'name');
    }
405
    bump_cache_version();
406
407

    // postinst stuff...
Nigel McNie's avatar
Nigel McNie committed
408
    safe_require($plugintype, $pluginname);
409
    $pcname = generate_class_name($plugintype, $installed->name);
410
411
412
413
414
415
416
417
418
419
420

    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;
421
            $table = $plugintype . '_cron';
422
423
424
            if (!empty($upgrade->install)) {
                $new = true;
            }
425
            else if (!record_exists($table, 'plugin', $pluginname, 'callfunction', $cron->callfunction)) {
426
427
428
429
                $new = true;
            }
            $cron->plugin = $pluginname;
            if (!empty($new)) {
430
                insert_record($table, $cron);
431
432
            }
            else {
433
                update_record($table, $cron, array('plugin', 'callfunction'));
434
435
436
            }
        }
    }
Elliot Pahl's avatar
Elliot Pahl committed
437

438
439
440
441
    if ($events = call_static_method($pcname, 'get_event_subscriptions')) {
        foreach ($events as $event) {
            $event = (object)$event;

442
            if (!record_exists('event_type', 'name', $event->event)) {
443
444
445
446
447
448
449
450
451
                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;
452
            $table = $plugintype . '_event_subscription';
453
            $block = blocktype_namespaced_to_single($pluginname);
454
            if (empty($upgrade->install)) {
455
                $exists = get_record($table, 'plugin' , $block, 'event', $event->event);
456
            }
457
            $event->plugin = $block;
458
            if (empty($exists)) {
459
                insert_record($table, $event);
460
461
            }
            else {
462
                update_record($table, $event, array('id' => $exists->id));
463
464
465
466
            }
        }
    }

467
468
469
470
471
472
473
474
    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));
            }
            $activity->plugintype = $plugintype;
            $activity->pluginname = $pluginname;
475
476
477
478
479
            $where = (object) array(
                'name'       => $activity->name,
                'plugintype' => $plugintype,
                'pluginname' => $pluginname,
            );
480
            // Work around the fact that insert_record cached the columns that
481
482
483
            // _were_ in the activity_type table before it was upgraded
            global $INSERTRECORD_NOCACHE;
            $INSERTRECORD_NOCACHE = true;
484
            ensure_record_exists('activity_type', $where, $activity);
485
            unset($INSERTRECORD_NOCACHE);
486
487
488
        }
    }

489
490
     // install artefact types
    if ($plugintype == 'artefact') {
491
492
493
        if (!is_callable(array($pcname, 'get_artefact_types'))) {
            throw new InstallationException("Artefact plugin $pcname must implement get_artefact_types and doesn't");
        }
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
        $types = call_static_method($pcname, 'get_artefact_types');
        $ph = array();
        if (is_array($types)) {
            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);
                }
            }
            $select = '(plugin = ? AND name NOT IN (' . implode(',', $ph) . '))';
            delete_records_select('artefact_installed_type', $select,
                                  array_merge(array($pluginname),$types));
        }
    }
Elliot Pahl's avatar
Elliot Pahl committed
511

512
513
514
    // install blocktype categories.
    if ($plugintype == 'blocktype' && get_config('installed')) {
        install_blocktype_categories_for_plugin($pluginname);
515
        install_blocktype_viewtypes_for_plugin($pluginname);
516
517
    }

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

521
522
    db_commit();
    return true;
523
524
525
526
}

function core_postinst() {
    $status = true;
527
528

    // Attempt to create session directories
529
    $sessionpath = get_config('sessionpath');
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
    if (check_dir_exists($sessionpath)) {
        // Create three levels of directories, named 0-9, a-f
        $characters = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f');
        foreach ($characters as $c1) {
            if (check_dir_exists("$sessionpath/$c1")) {
                foreach ($characters as $c2) {
                    if (check_dir_exists("$sessionpath/$c1/$c2")) {
                        foreach ($characters as $c3) {
                            if (!check_dir_exists("$sessionpath/$c1/$c2/$c3")) {
                                $status = false;
                                break(3);
                            }
                        }
                    }
                    else {
                        $status = false;
                        break(2);
                    }
                }
            }
            else {
                $status = false;
                break;
            }
        }
    }
    else {
        $status = false;
    }
559

560
    $now = db_format_timestamp(time());
561
562
563
    // Set default search plugin
    set_config('searchplugin', 'internal');

564
    set_config('lang', 'en.utf8');
565
    set_config('installation_key', get_random_key());
566
    set_config('installation_time', $now);
567
    set_config('stats_installation_time', $now);
568

569
570
571
572
573
574
575
    // Pre-define SMTP settings
    set_config('smtphosts', '');
    set_config('smtpport', '');
    set_config('smtpuser', '');
    set_config('smtppass', '');
    set_config('smtpsecure', '');

576
577
578
579
580
581
582
583
584
    // 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);

585
586
587
588
589
    $table = new XMLDBTable('institution');
    $key = new XMLDBKey('logofk');
    $key->setAttributes(XMLDB_KEY_FOREIGN, array('logo'), 'artefact', array('id'));
    add_key($table, $key);

590
    // PostgreSQL supports indexes over functions of columns, MySQL does not.
591
    // We make use if this if we can
592
    if (is_postgres()) {
593
        // Improve the username index
594
595
        execute_sql('DROP INDEX {usr_use_uix}');
        execute_sql('CREATE UNIQUE INDEX {usr_use_uix} ON {usr}(LOWER(username))');
596

597
598
599
600
601
602
603
604
605
        // 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))');

606
607
        // Only one profile view per user
        execute_sql("CREATE UNIQUE INDEX {view_own_type_uix} ON {view}(owner) WHERE type = 'profile'");
608
609
    }

610
611
612
613
614
615
616
617
618
619
620
    // 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)
    )');
621
622
623
624
    execute_sql('ALTER TABLE {artefact} ADD CHECK (
        (author IS NOT NULL AND authorname IS NULL    ) OR
        (author IS NULL     AND authorname IS NOT NULL)
    )');
625
    execute_sql('ALTER TABLE {view_access} ADD CHECK (
626
627
628
629
630
        (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)
631
    )');
632
633
634
635
636
    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)
    )');
637

638
    set_antispam_defaults();
639
    reload_html_filters();
640
641
642
643
644
645
646
647
648
649
650

    // Default set of sites from which iframe content can be embedded
    $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',
651
        'voki.com/php/'                            => 'Voki',
652
653
654
655
656
657
658
    );
    $iframedomains = array(
        'YouTube'      => 'www.youtube.com',
        'Vimeo'        => 'vimeo.com',
        'SlideShare'   => 'www.slideshare.net',
        'Glogster'     => 'www.glogster.com',
        'WikiEducator' => 'wikieducator.org',
659
        'Voki'         => 'voki.com',
660
661
662
    );
    update_safe_iframes($iframesources, $iframedomains);

663
664
665
    require_once(get_config('docroot') . 'lib/file.php');
    update_magicdb_path();

666
    return $status;
667
668
}

669
function core_install_lastcoredata_defaults() {
670
    global $USER;
671
    db_begin();
672
    $institution = new StdClass;
673
674
675
    $institution->name = 'mahara';
    $institution->displayname = 'No Institution';
    $institution->authplugin  = 'internal';
676
    $institution->theme  = 'default';
677
    $institution->priority = 0;
678
    insert_record('institution', $institution);
679

680
681
682
683
684
685
686
    $pages = site_content_pages();
    $now = db_format_timestamp(time());
    foreach ($pages as $name) {
        $page = new stdClass();
        $page->name = $name;
        $page->ctime = $now;
        $page->mtime = $now;
687
        $page->content = get_string($page->name . 'defaultcontent', 'install', get_string('staticpageconfigdefault', 'install'));
688
689
690
691
        $page->institution = 'mahara';
        insert_record('site_content', $page);
    }

692
    $auth_instance = new StdClass;
693
    $auth_instance->instancename  = 'Internal';
694
    $auth_instance->priority='1';
695
696
    $auth_instance->institution   = 'mahara';
    $auth_instance->authname      = 'internal';
697
698
    $auth_instance->id = insert_record('auth_instance', $auth_instance, 'id', true);

699
700
701
702
703
704
705
706
707
    // Insert the root user
    $user = new StdClass;
    $user->id = 0;
    $user->username = 'root';
    $user->password = '*';
    $user->salt = '*';
    $user->firstname = 'System';
    $user->lastname = 'User';
    $user->email = 'root@example.org';
708
    $user->quota = get_config_plugin('artefact', 'file', 'defaultquota');
709
    $user->authinstance = $auth_instance->id;
710

711
712
    if (is_mysql()) { // gratuitous mysql workaround
        $newid = insert_record('usr', $user, 'id', true);
713
        set_field('usr', 'id', 0, 'id', $newid);
714
        execute_sql('ALTER TABLE {usr} AUTO_INCREMENT=1');
715
    }
716
717
718
    else {
        insert_record('usr', $user);
    }
719

720
721
722
    // install the default layout options
    install_view_layout_defaults();

723
    require_once('group.php');
724
    install_system_profile_view();
725
    install_system_dashboard_view();
726
    install_system_grouphomepage_view();
727

728
729
730
    require_once('license.php');
    install_licenses_default();

731
732
733
    require_once('skin.php');
    install_skins_default();

734
    // Insert the admin user
735
736
    $user = new StdClass;
    $user->username = 'admin';
737
    $user->salt = auth_get_random_salt();
738
    $user->password = crypt('mahara', '$2a$' . get_config('bcrypt_cost') . '$' . substr(md5(get_config('passwordsaltmain') . $user->salt), 0, 22));
739
    $user->password = substr($user->password, 0, 7) . substr($user->password, 7+22);
740
    $user->authinstance = $auth_instance->id;
741
742
743
744
745
    $user->passwordchange = 1;
    $user->admin = 1;
    $user->firstname = 'Admin';
    $user->lastname = 'User';
    $user->email = 'admin@example.org';
746
    $user->quota = get_config_plugin('artefact', 'file', 'defaultquota');
747
748
749
750
    $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);
751
    handle_event('createuser', $user);
752
    activity_add_admin_defaults(array($user->id));
753
    db_commit();
754
755

    // if we're installing, set up the block categories here and then poll the plugins.
Elliot Pahl's avatar
Elliot Pahl committed
756
    // if we're upgrading this happens somewhere else.  This is because of dependency issues around
757
758
    // the order of installation stuff.

759
    install_blocktype_extras();
760
761
762

    // also install the new watchlist notification
    install_watchlist_notification();
763
764
}

765
766
767
function core_install_firstcoredata_defaults() {
    // Install the default institution
    db_begin();
Elliot Pahl's avatar
Elliot Pahl committed
768

769
    set_config('session_timeout', 86400);
770
    set_config('sitename', 'Mahara');
771
    set_config('defaultregistrationexpirylifetime', 1209600);
772
    set_config('defaultaccountinactivewarn', 604800);
773
    set_config('creategroups', 'all');
774
    set_config('createpublicgroups', 'all');
775
    set_config('allowpublicviews', 1);
776
    set_config('allowpublicprofiles', 1);
777
    set_config('generatesitemap', 1);
778
779
780
    set_config('showselfsearchsideblock', 0);
    set_config('showtagssideblock', 1);
    set_config('tagssideblockmaxtags', 20);
781
    set_config('usersallowedmultipleinstitutions', 1);
782
783
    set_config('viewmicroheaders', 0);
    set_config('userscanchooseviewthemes', 0);
784
    set_config('anonymouscomments', 1);
785
    set_config('homepageinfo', 1);
786
    set_config('showonlineuserssideblock', 1);
787
    set_config('footerlinks', serialize(array('privacystatement', 'about', 'contactus')));
788
    set_config('searchusernames', 1);
789
    set_config('onlineuserssideblockmaxusers', 10);
790
    set_config('loggedinprofileviewaccess', 1);
791
    set_config('dropdownmenu', 0);
792
793
    // Set this to a random starting number to make minor version slightly harder to detect
    set_config('cacheversion', rand(1000, 9999));
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820

    // 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',
821
        'userjoinsgroup',
822
823
        'saveartefact',
        'deleteartefact',
824
        'deleteartefacts',
825
826
        'saveview',
        'deleteview',
827
        'blockinstancecommit',
828
829
830
831
        'addfriend',
        'removefriend',
        'addfriendrequest',
        'removefriendrequest',
Richard Mansfield's avatar
Richard Mansfield committed
832
        'creategroup',
833
        'loginas',
834
835
836
837
838
839
840
841
    );

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

842
843
844
845
846
    // install the core event subscriptions
    $subs = array(
        array(
            'event'        => 'createuser',
            'callfunction' => 'activity_set_defaults',
847
        ),
848
849
850
851
        array(
            'event'        => 'createuser',
            'callfunction' => 'add_user_to_autoadd_groups',
        ),
852
853
854
855
856
    );

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

858
859
860
861
862
863
864
865
866
867
    // install the activity types
    $activitytypes = array(
        array('maharamessage', 0, 0),
        array('usermessage', 0, 0),
        array('watchlist', 0, 1),
        array('viewaccess', 0, 1),
        array('contactus', 1, 1),
        array('objectionable', 1, 1),
        array('virusrepeat', 1, 1),
        array('virusrelease', 1, 1),
868
        array('institutionmessage', 0, 0),
869
        array('groupmessage', 0, 1),
870
871
872
873
874
875
876
877
878
879
880
881
    );

    foreach ($activitytypes as $at) {
        $a = new StdClass;
        $a->name = $at[0];
        $a->admin = $at[1];
        $a->delay = $at[2];
        insert_record('activity_type', $a);
    }

    // install the cronjobs...
    $cronjobs = array(
882
883
884
        'rebuild_artefact_parent_cache_dirty'       => array('*', '*', '*', '*', '*'),
        'rebuild_artefact_parent_cache_complete'    => array('0', '4', '*', '*', '*'),
        'auth_clean_partial_registrations'          => array('5', '0', '*', '*', '*'),
885
        'auth_clean_expired_password_requests'      => array('5', '0', '*', '*', '*'),
886
887
888
889
890
891
892
893
894
895
896
897
898
        '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', '*', '*', '*', '*'),
        '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, '*', '*', '*'),
899
        'cron_sitemap_daily'                        => array(0, 1, '*', '*', '*'),
900
        'file_cleanup_old_cached_files'             => array(0, 1, '*', '*', '*'),
901
        'user_login_tries_to_zero'                  => array('*/5', '*', '*', '*', '*'),
902
        'cron_institution_registration_data'        => array(rand(0, 59), rand(0, 23), '*', '*', rand(0, 6)),
903
904
        'cron_institution_data_weekly'              => array('55', '23', '*', '*', '6'),
        'cron_institution_data_daily'               => array('51', '23', '*', '*', '*'),
905
        'check_imap_for_bounces'                    => array('*', '*', '*', '*', '*'),
906
        'cron_event_log_expire'                     => array('7', '23', '*', '*', '*'),
907
908
909
910
911
912
913
914
915
916
917
    );
    foreach ($cronjobs as $callfunction => $times) {
        $cron = new StdClass;
        $cron->callfunction = $callfunction;
        $cron->minute       = $times[0];
        $cron->hour         = $times[1];
        $cron->day          = $times[2];
        $cron->month        = $times[3];
        $cron->dayofweek    = $times[4];
        insert_record('cron', $cron);
    }
Elliot Pahl's avatar
Elliot Pahl committed
918

919
    $viewtypes = array('dashboard', 'portfolio', 'profile', 'grouphomepage');
920
921
922
923
924
    foreach ($viewtypes as $vt) {
        insert_record('view_type', (object)array(
            'type' => $vt,
        ));
    }
925
926
927
928
    db_commit();
}


Elliot Pahl's avatar
Elliot Pahl committed
929
930
931
/**
 * xmldb will pass us the xml file and we can perform any substitution as necessary
 */
932
function local_xmldb_contents_sub(&$contents) {
933
    // the main install.xml file needs to sub in plugintype tables.
934
935
936
937
938
939
940
941
942
    $searchstring = '<!-- PLUGIN_TYPE_SUBSTITUTION -->';
    if (strstr($contents, $searchstring) === 0) {
        return;
    }
    // ok, we're in the main file and we need to install all the plugin tables
    // get the basic skeleton structure
    $plugintables = file_get_contents(get_config('docroot') . 'lib/db/plugintables.xml');
    $tosub = '';
    foreach (plugin_types() as $plugin) {
Elliot Pahl's avatar
Elliot Pahl committed
943
        // any that want their own stuff can put it in docroot/plugintype/lib/db/plugintables.xml
944
        //- like auth is a bit special
945
946
947
        $specialcase = get_config('docroot') . $plugin . '/plugintables.xml';
        if (is_readable($specialcase)) {
            $tosub .= file_get_contents($specialcase) . "\n";
Elliot Pahl's avatar
Elliot Pahl committed
948
        }
949
        else {
950
951
952
953
954
955
956
957
            $replaced = '';
            // look for tables to put at the start...
            $pretables = get_config('docroot') . $plugin . '/beforetables.xml';
            if (is_readable($pretables)) {
                $replaced = file_get_contents($pretables) . "\n";
            }

            // perform any additional once off substitutions
958
959
            require_once(get_config('docroot') . $plugin . '/lib.php');
            if (method_exists(generate_class_name($plugin), 'extra_xmldb_substitution')) {
960
                $replaced  .= call_static_method(generate_class_name($plugin), 'extra_xmldb_substitution', $plugintables);
961
            }
962
            else {
963
                $replaced .= $plugintables;
964
            }
965
            $tosub .= str_replace('__PLUGINTYPE__', $plugin, $replaced) . "\n";
966
            // look for any tables to put at the end..
967
968
969
            $extratables = get_config('docroot') . $plugin . '/extratables.xml';
            if (is_readable($extratables)) {
                $tosub .= file_get_contents($extratables) . "\n";
970
            }
971
972
        }
    }
973
    $contents = str_replace($searchstring, $tosub, $contents);
974
975
}

976
977
978
979
980
981
982
983

/**
 * validates a plugin for installation
 * @throws InstallationException
*/
function validate_plugin($plugintype, $pluginname, $pluginpath='') {

    if (empty($pluginpath)) {
984
        $pluginpath = get_config('docroot') . $plugintype . '/' . $pluginname;
985
986
987
988
    }
    if (!file_exists($pluginpath . '/version.php')) {
        throw new InstallationException(get_string('versionphpmissing', 'error', $plugintype, $pluginname));
    }
989
990
991
992
993
994
    safe_require($plugintype, $pluginname);
    $classname = generate_class_name($plugintype, $pluginname);
    if (!class_exists($classname)) {
        throw new InstallationException(get_string('classmissing', 'error', $classname, $plugintype, $pluginname));
    }
    require_once(get_config('docroot') . $plugintype . '/lib.php');
995
996
997
998
999
    $funname = $plugintype . '_check_plugin_sanity';
    if (function_exists($funname)) {
        $funname($pluginname);
    }
}
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017

/*
* the order things are installed/upgraded in matters
*/

function sort_upgrades($k1, $k2) {
    if ($k1 == 'core') {
        return -1;
    }
    else if ($k2 == 'core') {
        return 1;
    }
    else if ($k1 == 'firstcoredata') {
        return -1;
    }
    else if ($k2 == 'firstcoredata') {
        return 1;
    }
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
    else if ($k1 == 'localpreinst') {
        return -1;
    }
    else if ($k2 == 'localpreinst') {
        return 1;
    }
    else if ($k1 == 'localpostinst') {
        return 1;
    }
    else if ($k2 == 'localpostinst') {
        return -1;
    }
1030
1031
1032
1033
1034
1035
    else if ($k1 == 'lastcoredata') {
        return 1;
    }
    else if ($k2 == 'lastcoredata') {
        return -1;
    }
1036
1037
1038
1039
    // else obey the order plugin types returns (strip off plugintype. from the start)
    $weight1 = array_search(substr($k1, 0, strpos($k1, '.')), plugin_types());
    $weight2 = array_search(substr($k2, 0, strpos($k2, '.')), plugin_types());
    return ($weight1 > $weight2);
1040
}
1041

1042
/** blocktype categories the system exports (including artefact categories)
1043
*/
1044
function get_blocktype_categories() {
1045
    return array('fileimagevideo', 'blog', 'general', 'internal', 'resume', 'external');
1046
1047
1048
1049
1050
}

function install_blocktype_categories_for_plugin($blocktype) {
    safe_require('blocktype', $blocktype);
    $blocktype = blocktype_namespaced_to_single($blocktype);
1051
    $catsinstalled = get_column('blocktype_category', 'name');
1052
1053
1054
1055
    db_begin();
    delete_records('blocktype_installed_category', 'blocktype', $blocktype);
    if ($cats = call_static_method(generate_class_name('blocktype', $blocktype), 'get_categories')) {
        foreach ($cats as $cat) {
1056
1057
1058
1059
1060
1061
            if (in_array($cat, $catsinstalled)) {
                insert_record('blocktype_installed_category', (object)array(
                    'blocktype' => $blocktype,
                    'category' => $cat
                ));
            }
1062
1063
1064
1065
1066
        }
    }
    db_commit();
}

1067
1068
1069
function install_blocktype_viewtypes_for_plugin($blocktype) {
    safe_require('blocktype', $blocktype);
    $blocktype = blocktype_namespaced_to_single($blocktype);
1070
    $vtinstalled = get_column('view_type', 'type');
1071
1072
1073
1074
    db_begin();
    delete_records('blocktype_installed_viewtype', 'blocktype', $blocktype);
    if ($viewtypes = call_static_method(generate_class_name('blocktype', $blocktype), 'get_viewtypes')) {
        foreach($viewtypes as $vt) {
1075
1076
1077
1078
1079
1080
            if (in_array($vt, $vtinstalled)) {
                insert_record('blocktype_installed_viewtype', (object)array(
                    'blocktype' => $blocktype,
                    'viewtype'  => $vt,
                ));
            }
1081
1082