DocumentHistory.php

Go to the documentation of this file.

<?php

 
namespace Depage\XmlDb;
 
class DocumentHistory
{
    private $pdo;
    private $dbNs;
    private $tableHistory;
 
    private $document;
    private $dateFormat = 'Y-m-d H:i:s';
    public function __construct(\Depage\Db\Pdo $pdo, $tablePrefix, Document $document)
    {
        $this->document = $document;
 
        $this->pdo = $pdo;
 
        $this->dbNs = new XmlNs('db', 'http://cms.depagecms.net/ns/database');
 
        $this->tableHistory = $tablePrefix . '_history';
    }

    public function getVersions($published = null, $maxResults = null)
    {
        $query = "SELECT h.hash, h.last_saved_at, h.first_saved_at, h.user_id, h.published
            FROM {$this->tableHistory} AS h
            WHERE h.doc_id = :doc_id";
 
        $params = [
            'doc_id' => $this->document->getDocId(),
        ];
 
        if ($published !== null) {
            $query .= ' AND h.published = :published';
            $params['published'] = $published ? 1 : 0;
        }
 
        $query .= ' ORDER BY h.last_saved_at DESC';
 
        if ($maxResults > 0) {
            $query .= ' LIMIT :maxResults';
            $params['maxResults'] = $maxResults;
        }
 
        $query .= ';';
 
        $sth = $this->pdo->prepare($query);
 
        $versions = [];
 
        if ($sth->execute($params)) {
            $results = $sth->fetchAll();
 
            foreach ($results as &$result) {
                $versions[strtotime($result['last_saved_at'])] = (object) [
                    'firstsaved' => new \DateTime($result['first_saved_at']),
                    'lastsaved' => new \DateTime($result['last_saved_at']),
                    'userId' => $result['user_id'],
                    'published' => $result['published'],
                    'hash' => $result['hash'],
                ];
            }
        }
 
        return $versions;
    }

    public function getLatestVersion()
    {
        $versions = $this->getVersions(true, 1);
 
        return reset($versions);
    }

    public function getXml($timestamp, $addIdAttribute = true)
    {
        $doc = false;
        $docId = $this->document->getDocId();
 
        $query = $this->pdo->prepare(
            "SELECT
                h.xml,
                h.last_saved_at as lastchange,
                h.user_id as uid
            FROM {$this->tableHistory} AS h
            WHERE h.doc_id = :doc_id
                AND h.last_saved_at <= :timestamp
            ORDER BY h.last_saved_at DESC
            LIMIT 1"
        );
 
        $params = [
            'doc_id' => $docId,
            'timestamp' => date($this->dateFormat, $timestamp),
        ];
 
        if ($query->execute($params) && $result = $query->fetchObject()) {
            $doc = new \Depage\Xml\Document();
            $doc->loadXML($result->xml);
            if (!$addIdAttribute) {
                Document::removeNodeAttr($doc, $this->dbNs, 'id');
            }
            $doc->documentElement->setAttribute('db:docid', $docId);
            $doc->documentElement->setAttribute('db:lastchange', $result->lastchange);
        }
 
        return $doc;
    }

    public function getLastPublishedXml($addIdAttribute = true)
    {
        $versions = $this->getVersions(true, 1);
        reset($versions);
        $latest = key($versions);
 
        return $this->getXml($latest, $addIdAttribute);
    }

    public function save($userId, $published = false)
    {
        $result = false;
        $timestamp = time();
 
        $doc = $this->document->getXml();
        $dth = $this->document->getDoctypeHandler();
        Document::removeNodeAttr($doc, $this->dbNs, 'lastchange');
        Document::removeNodeAttr($doc, $this->dbNs, 'docid');
 
        $dth->testDocumentForHistory($doc);
 
        $xml = $doc->saveXml();
        $hash = $this->document->hashDomNode($doc);
 
        $latestVersion = $this->getLatestVersion();
 
        if (!$latestVersion || $latestVersion->hash != $hash) {
            // insert new version into history
            $query = $this->pdo->prepare(
                "INSERT INTO {$this->tableHistory} (doc_id, hash, xml, first_saved_at, last_saved_at, user_id, published)
                VALUES(:doc_id, :hash, :xml, :timestamp1, :timestamp2, :user_id, :published);"
            );
 
            $params = [
                'doc_id' => $this->document->getDocId(),
                'hash' => $hash,
                'xml' => $xml,
                'timestamp1' => date($this->dateFormat, $timestamp),
                'timestamp2' => date($this->dateFormat, $timestamp),
                'user_id' => $userId,
                'published' => $published ? 1 : 0,
            ];
 
            $query->execute($params);
            $dth->onHistorySave();
        } else {
            // update date of latest version
            $query = $this->pdo->prepare(
                "UPDATE {$this->tableHistory}
                SET last_saved_at = :timestamp
                WHERE
                    doc_id = :doc_id AND
                    hash = :hash
                ;"
            );
 
            $params = [
                'doc_id' => $this->document->getDocId(),
                'hash' => $hash,
                'timestamp' => date($this->dateFormat, $timestamp),
            ];
 
            $query->execute($params);
        }
 
        // the release state reported in getDocInfo is derived from the
        // history, drop the memoized info
        $this->document->clearDocInfoCache();
 
        $result = $timestamp;
 
        return $result;
    }

    public function restore($timestamp)
    {
        $success = false;
        $xmlDoc = $this->getXml($timestamp);
 
        if ($this->document->save($xmlDoc)) {
            $success = $xmlDoc;
        }
 
        return $success;
    }

    public function delete($timestamp)
    {
        $query = $this->pdo->prepare(
            "DELETE FROM {$this->tableHistory}
             WHERE doc_id = :doc_id AND last_saved_at = :timestamp;"
        );
 
        $params = [
            'doc_id' => $this->document->getDocId(),
            'timestamp' => date($this->dateFormat, $timestamp),
        ];
 
        if ($query->execute($params)) {
            // deleting a version may change the release state reported
            // in getDocInfo, drop the memoized info
            $this->document->clearDocInfoCache();
 
            return $query->rowCount() > 0;
        }
 
        return false;
    }
}
 
/* vim:set ft=php sw=4 sts=4 fdm=marker et : */