aspirantzhang / octopus-revision

src/Revision.php

<?php

declare(strict_types=1);

namespace aspirantzhang\octopusRevision;

use think\facade\Db;
use think\Exception;

class Revision
{
    private $tableName;
    private $i18nTableName;
    private $originalId;
    private $revisionId;
    private $mainTableData;
    private $i18nTableData;
    private $recordUpdateTime;
    private $extra;
    private $extraTableData;

    public function __construct(string $tableName, int $originalId, array $extra = [])
    {
        $this->tableName = $tableName;
        $this->i18nTableName = $tableName . '_i18n';
        $this->originalId = (int)$originalId;
        $this->mainTableData = '[]';
        $this->i18nTableData = '[]';
        $this->extraTableData = '[]';
        $this->extra = $extra;
    }

    private function setMainTableData(array $data)
    {
        unset($data['id']);
        $this->mainTableData = json_encode($data);
    }

    private function getMainTableData()
    {
        return json_decode($this->mainTableData, true);
    }

    private function setI18nTableData(array $data)
    {
        foreach ($data as &$singleI18nRecord) {
            unset($singleI18nRecord['_id']);
        }
        $this->i18nTableData = json_encode($data);
    }

    private function setRecordUpdateTime(string $time)
    {
        $this->recordUpdateTime = $time;
    }

    private function getI18nTableData()
    {
        return json_decode($this->i18nTableData, true);
    }

    private function getExtraTableData()
    {
        return json_decode($this->extraTableData, true);
    }

    private function i18nTableExists(): bool
    {
        return $this->tableExists($this->i18nTableName);
    }

    private function setExtraTableData()
    {
        if (empty($this->extra)) {
            return;
        }
        $result = [];
        if (isAssocArray($this->extra)) {
            foreach ($this->extra as $tableName => $idFieldName) {
                if ($this->tableExists($tableName)) {
                    $record = Db::table($tableName)->where($idFieldName, $this->originalId)->select()->toArray();
                    foreach ($record as &$arr) {
                        unset($arr['id']);
                    }
                    $result[$tableName] = $record;
                }
            }
        } else {
            $idFieldName = $this->tableName . '_id';
            foreach ($this->extra as $tableName) {
                $record = Db::table($tableName)->where($idFieldName, $this->originalId)->select()->toArray();
                foreach ($record as &$arr) {
                    unset($arr['id']);
                }
                $result[$tableName] = $record;
            }
        }
        $this->extraTableData = json_encode($result);
    }

    private function setTableData(): void
    {
        // main table
        $record = Db::table($this->tableName)->where('id', $this->originalId)->find();
        $this->setMainTableData($record);
        $this->setRecordUpdateTime($record['update_time']);
        // i18n table
        if ($this->i18nTableExists()) {
            $i18nRecord = Db::table($this->i18nTableName)->where('original_id', $this->originalId)->select()->toArray();
            $this->setI18nTableData($i18nRecord);
        }
        // extra table
        $this->setExtraTableData();
    }

    private function saveRevision(string $title)
    {
        $currentTime = date('Y-m-d H:i:s');
        $data = [
            'table_name' => $this->tableName,
            'original_id' => $this->originalId,
            'title' => $title,
            'main_data' => $this->mainTableData,
            'i18n_data' => $this->i18nTableData,
            'extra_data' => $this->extraTableData,
            'create_time' => $this->recordUpdateTime,
            'update_time' => $currentTime
        ];
        try {
            return Db::name('revision')->insertGetId($data);
        } catch (Exception $e) {
            throw new Exception(__('write revision data failed'));
        }
    }

    public function save(string $title)
    {
        try {
            $this->setTableData();
            $revisionId = $this->saveRevision($title);
            return $revisionId;
        } catch (Exception $e) {
            throw new Exception($e->getMessage());
        }
    }

    private function initRevisionData()
    {
        $revision = Db::table('revision')->where('id', $this->revisionId)->find();
        if ($revision) {
            $this->mainTableData = $revision['main_data'];
            $this->i18nTableData = $revision['i18n_data'];
            $this->extraTableData = $revision['extra_data'];
            return [
                'tableName' => $revision['table_name'],
                'originalId' => $revision['original_id'],
                'title' => $revision['title'],
            ];
        }
        return [];
    }

    private function ifRevisionMatchOriginal(array $revisionData): bool
    {
        return ($revisionData['tableName'] === $this->tableName) && ($revisionData['originalId'] === $this->originalId);
    }

    private function updateMainTableData()
    {
        Db::name($this->tableName)->where('id', $this->originalId)->update($this->getMainTableData());
    }

    private function deleteOriginalI18nData()
    {
        Db::table($this->i18nTableName)->where('original_id', $this->originalId)->delete();
    }

    private function deleteOriginalExtraTableData()
    {
        if (!empty($this->extra)) {
            if (isAssocArray($this->extra)) {
                foreach ($this->extra as $tableName => $idFieldName) {
                    Db::table($tableName)->where($idFieldName, $this->originalId)->delete();
                }
            } else {
                $idFieldName = $this->tableName . '_id';
                foreach ($this->extra as $tableName) {
                    Db::table($tableName)->where($idFieldName, $this->originalId)->delete();
                }
            }
        }
    }

    private function insertI18nTableData()
    {
        Db::name($this->i18nTableName)->insertAll($this->getI18nTableData());
    }

    private function insertExtraTableData()
    {
        if (!empty($this->extra) && !empty($this->getExtraTableData())) {
            foreach ($this->getExtraTableData() as $tableName => $records) {
                Db::name($tableName)->insertAll($records);
            }
        }
    }

    public function restore(int $revisionId)
    {
        try {
            $this->revisionId = $revisionId;
            $revisionData = $this->initRevisionData();
            if (false === $this->ifRevisionMatchOriginal($revisionData)) {
                throw new Exception("The revision does not match the original record.");
            }
            $this->updateMainTableData();
            $this->deleteOriginalI18nData();
            $this->insertI18nTableData();
            $this->deleteOriginalExtraTableData();
            $this->insertExtraTableData();
        } catch (Exception $e) {
            throw new Exception($e->getMessage());
        }
    }

    private function getAllColumnNamesWithoutId(array $record): array

The method getAllColumnNamesWithoutId() is not used, and could be removed.

    {
        $names = array_keys($record);
        return array_diff($names, ['id', '_id']);
    }

    private function tableExists(string $tableName): bool
    {
        try {
            Db::query("select 1 from `$tableName` LIMIT 1");
        } catch (Exception $e) {
            return false;
        }
        return true;
    }
}