SymphonyCms\Installer\Migrations\migration_230

Complexity

Total Complexity

30

Size/Duplication

Total Lines	210
Duplicated Lines	7.14 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getVersion()	0	4	1
A	getReleaseNotes()	0	4	1
F	upgrade()	15	189	27
A	preUpdateNotes()	0	7	1

<?php
namespace SymphonyCms\Installer\Migrations;

use SymphonyCms\Installer\Lib\Migration;
use Symphony;
use Exception;
use DatabaseException;

class migration_230 extends Migration
{
    public static function getVersion()
    {
        return '2.3';
    }

    public static function getReleaseNotes()
    {
        return 'http://getsymphony.com/download/releases/version/2.3/';
    }

    public static function upgrade()
    {
        // 2.3dev
        if (version_compare(self::$existing_version, '2.3dev', '<=')) {
            Symphony::Configuration()->set('version', '2.3dev', 'symphony');
            Symphony::Configuration()->set('useragent', 'Symphony/2.3dev', 'general');

            // Add Publish Label to `tbl_fields`
            if (!Symphony::Database()->tableContainsField('tbl_fields', 'publish_label')) {
                Symphony::Database()->query('ALTER TABLE `tbl_fields` ADD `publish_label` VARCHAR(255) DEFAULT NULL');
            }

            // Migrate any Checkbox's Long Description to Publish Label
            try {
                $checkboxes = Symphony::Database()->fetch("SELECT `field_id`, `description` FROM `tbl_fields_checkbox`");

                foreach ($checkboxes as $field) {
                    if (!isset($field['description'])) {
                        continue;
                    }

                    Symphony::Database()->query(sprintf(
                        "
                        UPDATE `tbl_fields`
                        SET `publish_label` = '%s'
                        WHERE `id` = %d
                        LIMIT 1;
                        ",
                        $field['description'],
                        $field['field_id']
                    ));
                }

                Symphony::Database()->query("ALTER TABLE `tbl_fields_checkbox` DROP `description`");
            } catch (Exception $ex) {
            }

            // Removing unused settings
            Symphony::Configuration()->remove('allow_page_subscription', 'symphony');
            Symphony::Configuration()->remove('strict_error_handling', 'symphony');
            Symphony::Configuration()->remove('character_set', 'database');
            Symphony::Configuration()->remove('character_encoding', 'database');
            Symphony::Configuration()->remove('runtime_character_set_alter', 'database');

            if (Symphony::Configuration()->get('pagination_maximum_rows', 'symphony') === '17') {
                Symphony::Configuration()->set('pagination_maximum_rows', '20', 'symphony');
            }

            Symphony::Configuration()->write();
        }

        // 2.3 Beta 1
        if (version_compare(self::$existing_version, '2.3beta1', '<=')) {
            Symphony::Configuration()->set('version', '2.3beta1', 'symphony');
            Symphony::Configuration()->set('useragent', 'Symphony/2.3 Beta 1', 'general');

            Symphony::Configuration()->write();
        }

        // 2.3 Beta 2
        if (version_compare(self::$existing_version, '2.3beta2', '<=')) {
            // Migrate Publish Labels (if created) to the Label field
            // Then drop Publish Label, we're going to use element_name and label
            // to take care of the same functionality!
            try {
                if (Symphony::Database()->tableContainsField('tbl_fields', 'publish_label')) {
                    $fields = Symphony::Database()->fetch('SELECT `publish_label`, `label`, `id` FROM `tbl_fields`');

                    foreach ($fields as $field) {
                        if (!$field['publish_label']) {
                            continue;
                        }

                        Symphony::Database()->query(sprintf(
                            "
                            UPDATE `tbl_fields`
                            SET `label` = '%s'
                            WHERE `id` = %d
                            LIMIT 1;
                            ",
                            $field['publish_label'],
                            $field['id']
                        ));
                    }

                    Symphony::Database()->query("ALTER TABLE `tbl_fields` DROP `publish_label`");
                }
            } catch (Exception $ex) {
                Symphony::Log()->notice($ex->getMessage());
            }

            // Add uniqueness constraint for the Authors table. #937
            try {
                Symphony::Database()->query("ALTER TABLE `tbl_authors` ADD UNIQUE KEY `email` (`email`)");
            } catch (DatabaseException $ex) {
                // 1061 will be 'duplicate key', which is fine (means key was added earlier)
                // 1062 means the key failed to apply, which is bad.
                // @see http://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
                if ($ex->getDatabaseErrorCode() === 1062) {
                    Symphony::Log()->error(
                        __("You have multiple Authors with the same email address, which can cause issues with password retrieval. Please ensure all Authors have unique email addresses before updating. " . $ex->getMessage())
                    );

                    return false;
                }
            }

            // Update the version information
            Symphony::Configuration()->set('version', '2.3beta2', 'symphony');
            Symphony::Configuration()->set('useragent', 'Symphony/2.3 Beta 2', 'general');

            Symphony::Configuration()->write();
        }

        // 2.3 Beta 3
        if (version_compare(self::$existing_version, '2.3beta3', '<=')) {
            // Refresh indexes on existing Author field tables
            $author_fields = Symphony::Database()->fetchCol(
                "field_id",
                "SELECT `field_id` FROM `tbl_fields_author`"
            );

            foreach ($author_fields as $id) {
                $table = 'tbl_entries_data_' . $id;

                // MySQL doesn't support DROP IF EXISTS, so we'll try and catch.
                try {
                    Symphony::Database()->query("ALTER TABLE `" . $table . "` DROP INDEX `entry_id`");
                } catch (Exception $ex) {
                }

                try {
                    Symphony::Database()->query("CREATE UNIQUE INDEX `author` ON `" . $table . "` (`entry_id`, `author_id`)");
                    Symphony::Database()->query("OPTIMIZE TABLE " . $table);
                } catch (Exception $ex) {
                }
            }

            // Move section sorting data from the database to the filesystem. #977
            if (Symphony::Database()->tableContainsField('tbl_sections', 'entry_order')) {
                $sections = Symphony::Database()->fetch("SELECT `handle`, `entry_order`, `entry_order_direction` FROM `tbl_sections`");
                foreach ($sections as $s) {
                    Symphony::Configuration()->set(
                        'section_' . $s['handle'] . '_sortby',
                        $s['entry_order'],
                        'sorting'
                    );
                    Symphony::Configuration()->set(
                        'section_' . $s['handle'] . '_order',
                        $s['entry_order_direction'],
                        'sorting'
                    );
                }
            }

            // Drop `local`/`gmt` from Date fields, add `date` column. #693
            $date_fields = Symphony::Database()->fetchCol("field_id", "SELECT `field_id` FROM `tbl_fields_date`");

            foreach ($date_fields as $id) {
                $table = 'tbl_entries_data_' . $id;

                // Don't catch an Exception, we should halt updating if something goes wrong here
                // Add the new `date` column for Date fields
                if (!Symphony::Database()->tableContainsField($table, 'date')) {
                    Symphony::Database()->query("ALTER TABLE `" . $table . "` ADD `date` DATETIME DEFAULT NULL");
                    Symphony::Database()->query("CREATE INDEX `date` ON `" . $table . "` (`date`)");
                }

                if (Symphony::Database()->tableContainsField($table, 'date')) {
                    // Populate new Date column
                    if (Symphony::Database()->query("UPDATE `" . $table . "` SET date = CONVERT_TZ(SUBSTRING(value, 1, 19), SUBSTRING(value, -6), '+00:00')")) {
                        // Drop the `local`/`gmt` columns from Date fields
                        if (Symphony::Database()->tableContainsField($table, 'local')) {
                            Symphony::Database()->query("ALTER TABLE `" . $table . "` DROP `local`;");
                        }

                        if (Symphony::Database()->tableContainsField($table, 'gmt')) {
                            Symphony::Database()->query("ALTER TABLE `" . $table . "` DROP `gmt`;");
                        }
                    }
                }

                Symphony::Database()->query("OPTIMIZE TABLE " . $table);
            }
        }

        // Update the version information
        return parent::upgrade();
    }

    public static function preUpdateNotes()
    {
        return array(
            __("Symphony 2.3 is a major release that contains breaking changes from previous versions. It is highly recommended to review the releases notes and make a complete backup of your installation before updating as these changes may affect the functionality of your site."),
            __("This release enforces that Authors must have unique email addresses. If multiple Authors have the same email address, this update will fail.")
        );
    }
}