File vendors/shells/migration_date_items.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

<?php
/*-----8<--------------------------------------------------------------------
 *
 * BEdita - a semantic content management framework
 *
 * Copyright 2009 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 *
 *------------------------------------------------------------------->8-----
 */

require_once 'bedita_base.php';

/**
 * Convert Date Items to another format.
 */
class MigrationDateItemsShell extends BeditaBaseShell
{
    /**
     * Models used by this shell.
     *
     * @var array
     */
    public $uses = array('DateItem');

    /**
     * Columns in the SQL table.
     *
     * @var array
     */
    protected $columns = array();

    /**
     * Conversion(s) to perform.
     *
     * @var array
     */
    protected $conversion = array();

    public function help() {
        $this->out('Conversion script to handle conversion of Date Items from DATETIME format');
        $this->out('to BIGINT and vice versa.');
        $this->out();

        $this->out('First, you must run the first part of the appropriate conversion SQL.');
        $this->out('You can find them in the bedita-app/config/sql/ directory.');
        $this->out();

        $this->out('CAREFUL! Do NOT blindly launch this SQL, or you might lose data!');
        $this->out('PLEASE READ the instructions therein!');
        $this->out();

        $this->out('Then, run this script to convert not-yet-converted items (or all items');
        $this->out('if you pass the --all flag). Finally, run the last two queries in the');
        $this->out('same SQL conversion script as before.');
        $this->out();

        $this->out('  Usage: migration_date_items [-a|--all]');
        $this->out("    --all, -a\tAlways convert ALL date items in database");
    }

    /**
     * Load informations about SQL table columns.
     */
    public function startup() {
        parent::startup();

        $keys = array('start_date', 'end_date', 'start_date_tmp', 'end_date_tmp');

        $this->columns = array_intersect_key($this->DateItem->getColumnTypes(), array_flip($keys));
        $this->columns = array_map('strtolower', $this->columns);

        $this->conversion = array();
        foreach (array('start', 'end') as $startEnd) {
            if (empty($this->columns[$startEnd . '_date'])) {
                $this->error("Missing required column `{$startEnd}_date`! How is it possible that BEdita is running???");
            }
            if (!empty($this->columns[$startEnd . '_date_tmp'])) {
                array_push($this->conversion, $startEnd);
            }
        }
    }

    /**
     * Load IDs of the Date Items to be converted.
     *
     * @return array Array of IDs.
     */
    protected function load() {
        if (array_key_exists('-all', $this->params) || array_key_exists('a', $this->params)) {
            return $this->DateItem->find('list');
        }

        $conditions = array();

        if (count($this->conversion) == 1) {
            $startEnd = reset($this->conversion);
            $conditions['AND'] = array(
                $startEnd . '_date <>' => null,
                $startEnd . '_date_tmp' => null,
            );
        } else {
            $conditions['OR'] = array(
                'AND' => array(
                    'start_date <>' => null,
                    'start_date_tmp' => null,
                ),
                'OR' => array(
                    '1 <> 1',
                    'AND' => array(
                        'end_date <>' => null,
                        'end_date_tmp' => null,
                    )
                ),
            );
        }

        return $this->DateItem->find('list', compact('conditions'));
    }

    /**
     * Convert a single value.
     *
     * @param mixed $value Value to be converted.
     * @param string $startEnd Either `start` or `end`.
     * @return mixed Converted value.
     */
    protected function convert($value, $startEnd) {
        if (!in_array($startEnd, array('start', 'end'))) {
            return false;
        }

        if ($this->columns[$startEnd . '_date'] == $this->columns[$startEnd . '_date_tmp']) {
            return $value;
        }

        if (is_null($value)) {
            return null;
        }

        if ($this->columns[$startEnd . '_date'] == 'integer') {
            if (!is_numeric($value)) {
                $value = strtotime($value) ?: null;
            }
            return date('Y-m-d H:i:s', $value);
        }

        if ($this->columns[$startEnd . '_date'] == 'datetime') {
            return strtotime($value) ?: null;
        }

        return $value;
    }

    /**
     * Convert all date items in the database.
     */
    public function main() {
        if (empty($this->conversion)) {
            $this->error('No conversion to be performed!');
        }

        $quiet = array_key_exists('-quiet', $this->params);

        $this->out(' - Loading data... ', 0);
        $dateItems = $this->load();
        $this->out('DONE');

        if (empty($dateItems)) {
            $this->out(' * No items to be converted');
            return;
        }

        $this->out(' - Converting... ', $quiet ? 0 : 1);
        $count = 0;
        $time = microtime(true);
        foreach ($dateItems as $id) {
            $ok = true;
            $this->DateItem->id = $id;
            foreach ($this->conversion as $startEnd) {
                $value = $this->DateItem->read($startEnd . '_date', $id);
                $value = $value['DateItem'][$startEnd . '_date'];
                $value = $this->convert($value, $startEnd);
                $ok = $this->DateItem->saveField($startEnd . '_date_tmp', $value) && $ok;
            }

            $count++;
            if (!$quiet) {
                $this->out($ok ? '.' : 'x', ($count % 80 == 0) ? 1 : 0);
            }
        }
        $this->out($quiet ? 'DONE' : '');
        $time = microtime(true) - $time;

        $this->out(' * Converted ' . count($dateItems) . ' items in ' . sprintf('%.3f', $time) . ' seconds');
    }
}

Classes

Interfaces

Exceptions