File vendors/shells/tasks/cleanup_data.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

<?php
/*-----8<--------------------------------------------------------------------
 *
 * BEdita - a semantic content management framework
 *
 * Copyright 2022 Atlas 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-----
 */

/**
 * Cleanup data task
 * 
 * @property \BEobject $BEobject
 */
class CleanupDataTask extends BeditaBaseShell {
    
    /**
     * @inheritDoc
     */
    public $uses = ['BEObject'];

    protected $truncateTables = ['event_logs', 'mail_logs'];

    protected $cleanupTables = ['history', 'mail_jobs', 'versions'];

    public function help() {
        $this->hr();
        $this->out('cleanup data script shell usage:');
        $this->out('');
        $this->out('./cake.sh bedita cleanupData // truncate event_logs, mail_logs, clean old data from history and versions');
        $this->out('./cake.sh bedita cleanupData -ld <limit date yyyy-MM-dd> // use custom limit date for clean');
        $this->out('./cake.sh bedita cleanupData -ni // no interactive mode');
        $this->out('./cake.sh bedita cleanupData -tt <comma separated table names> // truncate event_logs, mail_logs + more tables');
        $this->out('./cake.sh bedita cleanupData help // show this help');
        $this->out('');
    }

    /**
     * Tables to clean (truncate or delete data):
     * - event_logs (truncate)
     * - mail_logs (truncate)
     * - history (cleanup: mantain only "CY-1 / CY" data (CY is the Current Year))
     * - mail_jobs (cleanup: mantain only "CY-1 / CY" data (CY is the Current Year))
     * - versions (cleanup: mantain only "CY-1 / CY" data (CY is the Current Year))
     *
     * @return void
     */
    public function execute()
    {
        $this->hr();
        $this->out('BEdita Data Cleanup');
        $this->out('--- count data before cleaning ---');
        $tables = $this->truncateTables;
        if (isset($this->params['tt'])) {
            $tables = array_merge($tables, explode(',', $this->params['tt']));
        }
        $countTables = array_merge($this->cleanupTables, $tables);
        sort($countTables);
        $limitDate = date('Y')-2 . '-12-31 23:59:59';
        if (isset($this->params['ld'])) {
            $limitDate = $this->params['ld'] . ' 23:59:59';
        }
        $counts = [];
        foreach ($countTables as $tableName) {
            if (in_array($tableName, $this->cleanupTables)) {
                $counts[$tableName] = $this->countRecords($tableName, $limitDate);
            } else {
                $counts[$tableName] = $this->countRecords($tableName);
            }
        }

        // check if no data to remove
        $total = 0;
        foreach ($counts as $tableName => $partial) {
            $total += $partial;
        }
        if ($total === 0) {
            $this->out('--- check if perform clean ---');
            $this->out('All tables are clean. Nothing to do. Bye');

            return;
        }

        $this->out('--- preparing clean ---');
        $this->out(sprintf('Truncate tables "%s"', implode(',', $tables)));
        $this->out(sprintf('Remove from tables "%s" records created before date limit: %s', implode(',', $this->cleanupTables), $limitDate));
        if (!isset($this->params['ni'])) { // no interactive
            $res = $this->in('Continue? [y/n]');
            if (strtolower($res) !== 'y') {
                $this->out('Bye');

                return;
            }    
        }
        $this->out('--- clean data ---');
        foreach ($this->cleanupTables as $tableName) {
            if ($counts[$tableName] === 0) {
                $this->out(sprintf('table %s clean, skip', $tableName));
                continue;
            }
            $this->cleanupTable($tableName, $limitDate);
        }
        foreach ($tables as $tableName) {
            $this->truncateTable($tableName);
        }
        $this->hr();
        $this->out('Done');        
    }

    protected function countRecords($tableName, $limitDate = '')
    {
        if (empty($limitDate)) {
            $query = trim(sprintf('SELECT COUNT(*) AS n FROM %s', $tableName));
            $result = $this->BEObject->query($query);
            $this->out(sprintf('%s => %s', $query, $result[0][0]['n']));

            return $result[0][0]['n'];
        }

        $query = trim(sprintf('SELECT COUNT(*) AS n FROM %s WHERE created < \'%s\'', $tableName, $limitDate));
        $result = $this->BEObject->query($query);
        $this->out(sprintf('%s => %s', $query, $result[0][0]['n']));

        return $result[0][0]['n'];
    }

    protected function truncateTable($tableName)
    {
        $query = sprintf('TRUNCATE table %s', $tableName);
        $this->out($query);
        $this->BEObject->query($query);
    }

    protected function cleanupTable($tableName, $limitDate)
    {
        $query = sprintf('DELETE FROM %s WHERE created < \'%s\'', $tableName, $limitDate);
        $this->out($query);
        $this->BEObject->query($query);
    }
}

Classes

Interfaces

Exceptions