xref: /dokuwiki/inc/ChangeLog/ChangeLog.php (revision dbf582dd4884cc99458c47c92e7c7878a4edea22)
10c3a5702SAndreas Gohr<?php
20c3a5702SAndreas Gohr
30c3a5702SAndreas Gohrnamespace dokuwiki\ChangeLog;
40c3a5702SAndreas Gohr
50c3a5702SAndreas Gohr/**
60c3a5702SAndreas Gohr * methods for handling of changelog of pages or media files
70c3a5702SAndreas Gohr */
80c3a5702SAndreas Gohrabstract class ChangeLog
90c3a5702SAndreas Gohr{
100c3a5702SAndreas Gohr    /** @var string */
110c3a5702SAndreas Gohr    protected $id;
120c3a5702SAndreas Gohr    /** @var int */
13bd17ac90SSatoshi Sahara    protected $currentRevision;
14bd17ac90SSatoshi Sahara    /** @var int */
150c3a5702SAndreas Gohr    protected $chunk_size;
160c3a5702SAndreas Gohr    /** @var array */
170c3a5702SAndreas Gohr    protected $cache;
180c3a5702SAndreas Gohr
190c3a5702SAndreas Gohr    /**
200c3a5702SAndreas Gohr     * Constructor
210c3a5702SAndreas Gohr     *
220c3a5702SAndreas Gohr     * @param string $id page id
230c3a5702SAndreas Gohr     * @param int $chunk_size maximum block size read from file
240c3a5702SAndreas Gohr     */
250c3a5702SAndreas Gohr    public function __construct($id, $chunk_size = 8192)
260c3a5702SAndreas Gohr    {
270c3a5702SAndreas Gohr        global $cache_revinfo;
280c3a5702SAndreas Gohr
290c3a5702SAndreas Gohr        $this->cache =& $cache_revinfo;
300c3a5702SAndreas Gohr        if (!isset($this->cache[$id])) {
310c3a5702SAndreas Gohr            $this->cache[$id] = array();
320c3a5702SAndreas Gohr        }
330c3a5702SAndreas Gohr
340c3a5702SAndreas Gohr        $this->id = $id;
350c3a5702SAndreas Gohr        $this->setChunkSize($chunk_size);
3619b5dd7eSSatoshi Sahara        // set property currentRevision and cache prior to getRevisionInfo($currentRev) call
3719b5dd7eSSatoshi Sahara        $this->getCurrentRevisionInfo();
380c3a5702SAndreas Gohr    }
390c3a5702SAndreas Gohr
400c3a5702SAndreas Gohr    /**
410c3a5702SAndreas Gohr     * Set chunk size for file reading
420c3a5702SAndreas Gohr     * Chunk size zero let read whole file at once
430c3a5702SAndreas Gohr     *
440c3a5702SAndreas Gohr     * @param int $chunk_size maximum block size read from file
450c3a5702SAndreas Gohr     */
460c3a5702SAndreas Gohr    public function setChunkSize($chunk_size)
470c3a5702SAndreas Gohr    {
480c3a5702SAndreas Gohr        if (!is_numeric($chunk_size)) $chunk_size = 0;
490c3a5702SAndreas Gohr
500c3a5702SAndreas Gohr        $this->chunk_size = (int)max($chunk_size, 0);
510c3a5702SAndreas Gohr    }
520c3a5702SAndreas Gohr
530c3a5702SAndreas Gohr    /**
540c3a5702SAndreas Gohr     * Returns path to changelog
550c3a5702SAndreas Gohr     *
560c3a5702SAndreas Gohr     * @return string path to file
570c3a5702SAndreas Gohr     */
580c3a5702SAndreas Gohr    abstract protected function getChangelogFilename();
590c3a5702SAndreas Gohr
600c3a5702SAndreas Gohr    /**
610c3a5702SAndreas Gohr     * Returns path to current page/media
620c3a5702SAndreas Gohr     *
630c3a5702SAndreas Gohr     * @return string path to file
640c3a5702SAndreas Gohr     */
650c3a5702SAndreas Gohr    abstract protected function getFilename();
660c3a5702SAndreas Gohr
67df7627d6SSatoshi Sahara
68df7627d6SSatoshi Sahara    /**
69df7627d6SSatoshi Sahara     * Check whether given revision is the current page
70df7627d6SSatoshi Sahara     *
71df7627d6SSatoshi Sahara     * @param int $rev timestamp of current page
72df7627d6SSatoshi Sahara     * @return bool true if $rev is current revision, otherwise false
73df7627d6SSatoshi Sahara     */
74df7627d6SSatoshi Sahara    public function isCurrentRevision($rev)
75df7627d6SSatoshi Sahara    {
76df7627d6SSatoshi Sahara        return $rev == $this->currentRevision();
77df7627d6SSatoshi Sahara    }
78df7627d6SSatoshi Sahara
79df7627d6SSatoshi Sahara    /**
80df7627d6SSatoshi Sahara     * Checks if the revision is last revision
81df7627d6SSatoshi Sahara     *
82df7627d6SSatoshi Sahara     * @param int $rev revision timestamp
83df7627d6SSatoshi Sahara     * @return bool true if $rev is last revision, otherwise false
84df7627d6SSatoshi Sahara     */
85df7627d6SSatoshi Sahara    public function isLastRevision($rev = null)
86df7627d6SSatoshi Sahara    {
87df7627d6SSatoshi Sahara        return $rev === $this->lastRevision();
88df7627d6SSatoshi Sahara    }
89df7627d6SSatoshi Sahara
90df7627d6SSatoshi Sahara    /**
91df7627d6SSatoshi Sahara     * Return the current revision identifer
92df7627d6SSatoshi Sahara     * @return int|false
93df7627d6SSatoshi Sahara     */
94df7627d6SSatoshi Sahara    public function currentRevision()
95df7627d6SSatoshi Sahara    {
96df7627d6SSatoshi Sahara        if (!isset($this->currentRevision)) {
97df7627d6SSatoshi Sahara            // set ChangeLog::currentRevision property
98df7627d6SSatoshi Sahara            $this->getCurrentRevisionInfo();
99df7627d6SSatoshi Sahara        }
100df7627d6SSatoshi Sahara        return $this->currentRevision;
101df7627d6SSatoshi Sahara    }
102df7627d6SSatoshi Sahara
103df7627d6SSatoshi Sahara    /**
104df7627d6SSatoshi Sahara     * Return the last revision identifer, timestamp of last entry of changelog
105df7627d6SSatoshi Sahara     * @return int|false
106df7627d6SSatoshi Sahara     */
107df7627d6SSatoshi Sahara    public function lastRevision()
108df7627d6SSatoshi Sahara    {
109df7627d6SSatoshi Sahara        $revs = $this->getRevisions(-1, 1);
110df7627d6SSatoshi Sahara        return empty($revs) ? false : $revs[0];
111df7627d6SSatoshi Sahara    }
112df7627d6SSatoshi Sahara
1130c3a5702SAndreas Gohr    /**
114b82f2411SSatoshi Sahara     * Save revision info to the cache pool
115b82f2411SSatoshi Sahara     *
116b82f2411SSatoshi Sahara     * @return bool
117b82f2411SSatoshi Sahara     */
118b82f2411SSatoshi Sahara    protected function saveRevisionInfo($info)
119b82f2411SSatoshi Sahara    {
120b82f2411SSatoshi Sahara        if (!is_array($info)) return false;
121b82f2411SSatoshi Sahara        //$this->cache[$this->id][$info['date']] ??= $info; // since php 7.4
122b82f2411SSatoshi Sahara        $this->cache[$this->id][$info['date']] = $this->cache[$this->id][$info['date']] ?? $info;
123b82f2411SSatoshi Sahara        return true;
124b82f2411SSatoshi Sahara    }
125b82f2411SSatoshi Sahara
126b82f2411SSatoshi Sahara    /**
1270c3a5702SAndreas Gohr     * Get the changelog information for a specific page id and revision (timestamp)
1280c3a5702SAndreas Gohr     *
1290c3a5702SAndreas Gohr     * Adjacent changelog lines are optimistically parsed and cached to speed up
1300c3a5702SAndreas Gohr     * consecutive calls to getRevisionInfo. For large changelog files, only the chunk
1310c3a5702SAndreas Gohr     * containing the requested changelog line is read.
1320c3a5702SAndreas Gohr     *
1330c3a5702SAndreas Gohr     * @param int $rev revision timestamp
1340c3a5702SAndreas Gohr     * @return bool|array false or array with entries:
1350c3a5702SAndreas Gohr     *      - date:  unix timestamp
1360c3a5702SAndreas Gohr     *      - ip:    IPv4 address (127.0.0.1)
1370c3a5702SAndreas Gohr     *      - type:  log line type
1380c3a5702SAndreas Gohr     *      - id:    page id
1390c3a5702SAndreas Gohr     *      - user:  user name
1400c3a5702SAndreas Gohr     *      - sum:   edit summary (or action reason)
1410c3a5702SAndreas Gohr     *      - extra: extra data (varies by line type)
142bd17ac90SSatoshi Sahara     *      - sizechange: change of filesize
1430c3a5702SAndreas Gohr     *
1440c3a5702SAndreas Gohr     * @author Ben Coburn <btcoburn@silicodon.net>
1450c3a5702SAndreas Gohr     * @author Kate Arzamastseva <pshns@ukr.net>
1460c3a5702SAndreas Gohr     */
1470c3a5702SAndreas Gohr    public function getRevisionInfo($rev)
1480c3a5702SAndreas Gohr    {
149a3984ddfSSatoshi Sahara        $rev = max(0, $rev);
150a3984ddfSSatoshi Sahara        if (!$rev) return false;
1510c3a5702SAndreas Gohr
1520c3a5702SAndreas Gohr        // check if it's already in the memory cache
1530c3a5702SAndreas Gohr        if (isset($this->cache[$this->id]) && isset($this->cache[$this->id][$rev])) {
1540c3a5702SAndreas Gohr            return $this->cache[$this->id][$rev];
1550c3a5702SAndreas Gohr        }
1560c3a5702SAndreas Gohr
1570c3a5702SAndreas Gohr        //read lines from changelog
1580c3a5702SAndreas Gohr        list($fp, $lines) = $this->readloglines($rev);
1590c3a5702SAndreas Gohr        if ($fp) {
1600c3a5702SAndreas Gohr            fclose($fp);
1610c3a5702SAndreas Gohr        }
1620c3a5702SAndreas Gohr        if (empty($lines)) return false;
1630c3a5702SAndreas Gohr
1640c3a5702SAndreas Gohr        // parse and cache changelog lines
1650c3a5702SAndreas Gohr        foreach ($lines as $value) {
166bd17ac90SSatoshi Sahara            $info = parseChangelogLine($value);
167b82f2411SSatoshi Sahara            $this->saveRevisionInfo($info);
1680c3a5702SAndreas Gohr        }
1690c3a5702SAndreas Gohr        if (!isset($this->cache[$this->id][$rev])) {
1700c3a5702SAndreas Gohr            return false;
1710c3a5702SAndreas Gohr        }
1720c3a5702SAndreas Gohr        return $this->cache[$this->id][$rev];
1730c3a5702SAndreas Gohr    }
1740c3a5702SAndreas Gohr
1750c3a5702SAndreas Gohr    /**
1760c3a5702SAndreas Gohr     * Return a list of page revisions numbers
1770c3a5702SAndreas Gohr     *
1780c3a5702SAndreas Gohr     * Does not guarantee that the revision exists in the attic,
1790c3a5702SAndreas Gohr     * only that a line with the date exists in the changelog.
1800c3a5702SAndreas Gohr     * By default the current revision is skipped.
1810c3a5702SAndreas Gohr     *
1820c3a5702SAndreas Gohr     * The current revision is automatically skipped when the page exists.
1830c3a5702SAndreas Gohr     * See $INFO['meta']['last_change'] for the current revision.
1840c3a5702SAndreas Gohr     * A negative $first let read the current revision too.
1850c3a5702SAndreas Gohr     *
1860c3a5702SAndreas Gohr     * For efficiency, the log lines are parsed and cached for later
1870c3a5702SAndreas Gohr     * calls to getRevisionInfo. Large changelog files are read
1880c3a5702SAndreas Gohr     * backwards in chunks until the requested number of changelog
1890c3a5702SAndreas Gohr     * lines are recieved.
1900c3a5702SAndreas Gohr     *
1910c3a5702SAndreas Gohr     * @param int $first skip the first n changelog lines
1920c3a5702SAndreas Gohr     * @param int $num number of revisions to return
1930c3a5702SAndreas Gohr     * @return array with the revision timestamps
1940c3a5702SAndreas Gohr     *
1950c3a5702SAndreas Gohr     * @author Ben Coburn <btcoburn@silicodon.net>
1960c3a5702SAndreas Gohr     * @author Kate Arzamastseva <pshns@ukr.net>
1970c3a5702SAndreas Gohr     */
1980c3a5702SAndreas Gohr    public function getRevisions($first, $num)
1990c3a5702SAndreas Gohr    {
2000c3a5702SAndreas Gohr        $revs = array();
2010c3a5702SAndreas Gohr        $lines = array();
2020c3a5702SAndreas Gohr        $count = 0;
2030c3a5702SAndreas Gohr
2040c3a5702SAndreas Gohr        $num = max($num, 0);
2050c3a5702SAndreas Gohr        if ($num == 0) {
2060c3a5702SAndreas Gohr            return $revs;
2070c3a5702SAndreas Gohr        }
2080c3a5702SAndreas Gohr
2090c3a5702SAndreas Gohr        if ($first < 0) {
2100c3a5702SAndreas Gohr            $first = 0;
2110c3a5702SAndreas Gohr        } else {
212df7627d6SSatoshi Sahara            $fileLastMod = $this->getFilename();
213df7627d6SSatoshi Sahara            if (file_exists($fileLastMod) && $this->isLastRevision(filemtime($fileLastMod))) {
214df7627d6SSatoshi Sahara                // skip last revision if the page exists
2150c3a5702SAndreas Gohr                $first = max($first + 1, 0);
2160c3a5702SAndreas Gohr            }
2170c3a5702SAndreas Gohr        }
2180c3a5702SAndreas Gohr
2190c3a5702SAndreas Gohr        $file = $this->getChangelogFilename();
2200c3a5702SAndreas Gohr
2210c3a5702SAndreas Gohr        if (!file_exists($file)) {
2220c3a5702SAndreas Gohr            return $revs;
2230c3a5702SAndreas Gohr        }
2240c3a5702SAndreas Gohr        if (filesize($file) < $this->chunk_size || $this->chunk_size == 0) {
2250c3a5702SAndreas Gohr            // read whole file
2260c3a5702SAndreas Gohr            $lines = file($file);
2270c3a5702SAndreas Gohr            if ($lines === false) {
2280c3a5702SAndreas Gohr                return $revs;
2290c3a5702SAndreas Gohr            }
2300c3a5702SAndreas Gohr        } else {
2310c3a5702SAndreas Gohr            // read chunks backwards
2320c3a5702SAndreas Gohr            $fp = fopen($file, 'rb'); // "file pointer"
2330c3a5702SAndreas Gohr            if ($fp === false) {
2340c3a5702SAndreas Gohr                return $revs;
2350c3a5702SAndreas Gohr            }
2360c3a5702SAndreas Gohr            fseek($fp, 0, SEEK_END);
2370c3a5702SAndreas Gohr            $tail = ftell($fp);
2380c3a5702SAndreas Gohr
2390c3a5702SAndreas Gohr            // chunk backwards
2400c3a5702SAndreas Gohr            $finger = max($tail - $this->chunk_size, 0);
2410c3a5702SAndreas Gohr            while ($count < $num + $first) {
2420c3a5702SAndreas Gohr                $nl = $this->getNewlinepointer($fp, $finger);
2430c3a5702SAndreas Gohr
2440c3a5702SAndreas Gohr                // was the chunk big enough? if not, take another bite
2450c3a5702SAndreas Gohr                if ($nl > 0 && $tail <= $nl) {
2460c3a5702SAndreas Gohr                    $finger = max($finger - $this->chunk_size, 0);
2470c3a5702SAndreas Gohr                    continue;
2480c3a5702SAndreas Gohr                } else {
2490c3a5702SAndreas Gohr                    $finger = $nl;
2500c3a5702SAndreas Gohr                }
2510c3a5702SAndreas Gohr
2520c3a5702SAndreas Gohr                // read chunk
2530c3a5702SAndreas Gohr                $chunk = '';
2540c3a5702SAndreas Gohr                $read_size = max($tail - $finger, 0); // found chunk size
2550c3a5702SAndreas Gohr                $got = 0;
2560c3a5702SAndreas Gohr                while ($got < $read_size && !feof($fp)) {
2570c3a5702SAndreas Gohr                    $tmp = @fread($fp, max(min($this->chunk_size, $read_size - $got), 0));
2580c3a5702SAndreas Gohr                    if ($tmp === false) {
2590c3a5702SAndreas Gohr                        break;
2600c3a5702SAndreas Gohr                    } //error state
2610c3a5702SAndreas Gohr                    $got += strlen($tmp);
2620c3a5702SAndreas Gohr                    $chunk .= $tmp;
2630c3a5702SAndreas Gohr                }
2640c3a5702SAndreas Gohr                $tmp = explode("\n", $chunk);
2650c3a5702SAndreas Gohr                array_pop($tmp); // remove trailing newline
2660c3a5702SAndreas Gohr
2670c3a5702SAndreas Gohr                // combine with previous chunk
2680c3a5702SAndreas Gohr                $count += count($tmp);
2690c3a5702SAndreas Gohr                $lines = array_merge($tmp, $lines);
2700c3a5702SAndreas Gohr
2710c3a5702SAndreas Gohr                // next chunk
2720c3a5702SAndreas Gohr                if ($finger == 0) {
2730c3a5702SAndreas Gohr                    break;
274e24a74c0SAndreas Gohr                } else { // already read all the lines
2750c3a5702SAndreas Gohr                    $tail = $finger;
2760c3a5702SAndreas Gohr                    $finger = max($tail - $this->chunk_size, 0);
2770c3a5702SAndreas Gohr                }
2780c3a5702SAndreas Gohr            }
2790c3a5702SAndreas Gohr            fclose($fp);
2800c3a5702SAndreas Gohr        }
2810c3a5702SAndreas Gohr
2820c3a5702SAndreas Gohr        // skip parsing extra lines
2830c3a5702SAndreas Gohr        $num = max(min(count($lines) - $first, $num), 0);
2840c3a5702SAndreas Gohr        if ($first > 0 && $num > 0) {
2850c3a5702SAndreas Gohr            $lines = array_slice($lines, max(count($lines) - $first - $num, 0), $num);
286df7627d6SSatoshi Sahara        } elseif ($first > 0 && $num == 0) {
2870c3a5702SAndreas Gohr            $lines = array_slice($lines, 0, max(count($lines) - $first, 0));
2880c3a5702SAndreas Gohr        } elseif ($first == 0 && $num > 0) {
2890c3a5702SAndreas Gohr            $lines = array_slice($lines, max(count($lines) - $num, 0));
2900c3a5702SAndreas Gohr        }
2910c3a5702SAndreas Gohr
2920c3a5702SAndreas Gohr        // handle lines in reverse order
2930c3a5702SAndreas Gohr        for ($i = count($lines) - 1; $i >= 0; $i--) {
294bd17ac90SSatoshi Sahara            $info = parseChangelogLine($lines[$i]);
295b82f2411SSatoshi Sahara            if ($this->saveRevisionInfo($info)) {
296bd17ac90SSatoshi Sahara                $revs[] = $info['date'];
2970c3a5702SAndreas Gohr            }
2980c3a5702SAndreas Gohr        }
2990c3a5702SAndreas Gohr
3000c3a5702SAndreas Gohr        return $revs;
3010c3a5702SAndreas Gohr    }
3020c3a5702SAndreas Gohr
3030c3a5702SAndreas Gohr    /**
3040c3a5702SAndreas Gohr     * Get the nth revision left or right handside  for a specific page id and revision (timestamp)
3050c3a5702SAndreas Gohr     *
3060c3a5702SAndreas Gohr     * For large changelog files, only the chunk containing the
3070c3a5702SAndreas Gohr     * reference revision $rev is read and sometimes a next chunck.
3080c3a5702SAndreas Gohr     *
3090c3a5702SAndreas Gohr     * Adjacent changelog lines are optimistically parsed and cached to speed up
3100c3a5702SAndreas Gohr     * consecutive calls to getRevisionInfo.
3110c3a5702SAndreas Gohr     *
3120c3a5702SAndreas Gohr     * @param int $rev revision timestamp used as startdate (doesn't need to be revisionnumber)
3130c3a5702SAndreas Gohr     * @param int $direction give position of returned revision with respect to $rev; positive=next, negative=prev
3140c3a5702SAndreas Gohr     * @return bool|int
3150c3a5702SAndreas Gohr     *      timestamp of the requested revision
3160c3a5702SAndreas Gohr     *      otherwise false
3170c3a5702SAndreas Gohr     */
3180c3a5702SAndreas Gohr    public function getRelativeRevision($rev, $direction)
3190c3a5702SAndreas Gohr    {
3200c3a5702SAndreas Gohr        $rev = max($rev, 0);
3210c3a5702SAndreas Gohr        $direction = (int)$direction;
3220c3a5702SAndreas Gohr
3230c3a5702SAndreas Gohr        //no direction given or last rev, so no follow-up
3240c3a5702SAndreas Gohr        if (!$direction || ($direction > 0 && $this->isCurrentRevision($rev))) {
3250c3a5702SAndreas Gohr            return false;
3260c3a5702SAndreas Gohr        }
3270c3a5702SAndreas Gohr
3280c3a5702SAndreas Gohr        //get lines from changelog
3290c3a5702SAndreas Gohr        list($fp, $lines, $head, $tail, $eof) = $this->readloglines($rev);
3300c3a5702SAndreas Gohr        if (empty($lines)) return false;
3310c3a5702SAndreas Gohr
3325d9428a0SSatoshi Sahara        // look for revisions later/earlier than $rev, when founded count till the wanted revision is reached
3330c3a5702SAndreas Gohr        // also parse and cache changelog lines for getRevisionInfo().
3340c3a5702SAndreas Gohr        $revcounter = 0;
3350c3a5702SAndreas Gohr        $relativerev = false;
3360c3a5702SAndreas Gohr        $checkotherchunck = true; //always runs once
3370c3a5702SAndreas Gohr        while (!$relativerev && $checkotherchunck) {
338bd17ac90SSatoshi Sahara            $info = array();
3390c3a5702SAndreas Gohr            //parse in normal or reverse order
3400c3a5702SAndreas Gohr            $count = count($lines);
3410c3a5702SAndreas Gohr            if ($direction > 0) {
3420c3a5702SAndreas Gohr                $start = 0;
3430c3a5702SAndreas Gohr                $step = 1;
3440c3a5702SAndreas Gohr            } else {
3450c3a5702SAndreas Gohr                $start = $count - 1;
3460c3a5702SAndreas Gohr                $step = -1;
3470c3a5702SAndreas Gohr            }
3480c3a5702SAndreas Gohr            for ($i = $start; $i >= 0 && $i < $count; $i = $i + $step) {
349bd17ac90SSatoshi Sahara                $info = parseChangelogLine($lines[$i]);
350b82f2411SSatoshi Sahara                if ($this->saveRevisionInfo($info)) {
3510c3a5702SAndreas Gohr                    //look for revs older/earlier then reference $rev and select $direction-th one
352bd17ac90SSatoshi Sahara                    if (($direction > 0 && $info['date'] > $rev) || ($direction < 0 && $info['date'] < $rev)) {
3530c3a5702SAndreas Gohr                        $revcounter++;
3540c3a5702SAndreas Gohr                        if ($revcounter == abs($direction)) {
355bd17ac90SSatoshi Sahara                            $relativerev = $info['date'];
3560c3a5702SAndreas Gohr                        }
3570c3a5702SAndreas Gohr                    }
3580c3a5702SAndreas Gohr                }
3590c3a5702SAndreas Gohr            }
3600c3a5702SAndreas Gohr
3610c3a5702SAndreas Gohr            //true when $rev is found, but not the wanted follow-up.
3620c3a5702SAndreas Gohr            $checkotherchunck = $fp
363bd17ac90SSatoshi Sahara                && ($info['date'] == $rev || ($revcounter > 0 && !$relativerev))
3640c3a5702SAndreas Gohr                && !(($tail == $eof && $direction > 0) || ($head == 0 && $direction < 0));
3650c3a5702SAndreas Gohr
3660c3a5702SAndreas Gohr            if ($checkotherchunck) {
3670c3a5702SAndreas Gohr                list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, $direction);
3680c3a5702SAndreas Gohr
3690c3a5702SAndreas Gohr                if (empty($lines)) break;
3700c3a5702SAndreas Gohr            }
3710c3a5702SAndreas Gohr        }
3720c3a5702SAndreas Gohr        if ($fp) {
3730c3a5702SAndreas Gohr            fclose($fp);
3740c3a5702SAndreas Gohr        }
3750c3a5702SAndreas Gohr
3760c3a5702SAndreas Gohr        return $relativerev;
3770c3a5702SAndreas Gohr    }
3780c3a5702SAndreas Gohr
3790c3a5702SAndreas Gohr    /**
3800c3a5702SAndreas Gohr     * Returns revisions around rev1 and rev2
3810c3a5702SAndreas Gohr     * When available it returns $max entries for each revision
3820c3a5702SAndreas Gohr     *
3830c3a5702SAndreas Gohr     * @param int $rev1 oldest revision timestamp
3840c3a5702SAndreas Gohr     * @param int $rev2 newest revision timestamp (0 looks up last revision)
3850c3a5702SAndreas Gohr     * @param int $max maximum number of revisions returned
3860c3a5702SAndreas Gohr     * @return array with two arrays with revisions surrounding rev1 respectively rev2
3870c3a5702SAndreas Gohr     */
3880c3a5702SAndreas Gohr    public function getRevisionsAround($rev1, $rev2, $max = 50)
3890c3a5702SAndreas Gohr    {
3905d9428a0SSatoshi Sahara        $max = intval(abs($max) / 2) * 2 + 1;
3910c3a5702SAndreas Gohr        $rev1 = max($rev1, 0);
3920c3a5702SAndreas Gohr        $rev2 = max($rev2, 0);
3930c3a5702SAndreas Gohr
3940c3a5702SAndreas Gohr        if ($rev2) {
3950c3a5702SAndreas Gohr            if ($rev2 < $rev1) {
3960c3a5702SAndreas Gohr                $rev = $rev2;
3970c3a5702SAndreas Gohr                $rev2 = $rev1;
3980c3a5702SAndreas Gohr                $rev1 = $rev;
3990c3a5702SAndreas Gohr            }
4000c3a5702SAndreas Gohr        } else {
4010c3a5702SAndreas Gohr            //empty right side means a removed page. Look up last revision.
402bd17ac90SSatoshi Sahara            $rev2 = $this->currentRevision();
4030c3a5702SAndreas Gohr        }
4040c3a5702SAndreas Gohr        //collect revisions around rev2
4050c3a5702SAndreas Gohr        list($revs2, $allrevs, $fp, $lines, $head, $tail) = $this->retrieveRevisionsAround($rev2, $max);
4060c3a5702SAndreas Gohr
4070c3a5702SAndreas Gohr        if (empty($revs2)) return array(array(), array());
4080c3a5702SAndreas Gohr
4090c3a5702SAndreas Gohr        //collect revisions around rev1
4100c3a5702SAndreas Gohr        $index = array_search($rev1, $allrevs);
4110c3a5702SAndreas Gohr        if ($index === false) {
4120c3a5702SAndreas Gohr            //no overlapping revisions
4130c3a5702SAndreas Gohr            list($revs1, , , , ,) = $this->retrieveRevisionsAround($rev1, $max);
4140c3a5702SAndreas Gohr            if (empty($revs1)) $revs1 = array();
4150c3a5702SAndreas Gohr        } else {
4160c3a5702SAndreas Gohr            //revisions overlaps, reuse revisions around rev2
4175d9428a0SSatoshi Sahara            $lastrev = array_pop($allrevs); //keep last entry that could be external edit
4180c3a5702SAndreas Gohr            $revs1 = $allrevs;
4190c3a5702SAndreas Gohr            while ($head > 0) {
4200c3a5702SAndreas Gohr                for ($i = count($lines) - 1; $i >= 0; $i--) {
421bd17ac90SSatoshi Sahara                    $info = parseChangelogLine($lines[$i]);
422b82f2411SSatoshi Sahara                    if ($this->saveRevisionInfo($info)) {
423bd17ac90SSatoshi Sahara                        $revs1[] = $info['date'];
4240c3a5702SAndreas Gohr                        $index++;
4250c3a5702SAndreas Gohr
4265d9428a0SSatoshi Sahara                        if ($index > intval($max / 2)) break 2;
4270c3a5702SAndreas Gohr                    }
4280c3a5702SAndreas Gohr                }
4290c3a5702SAndreas Gohr
4300c3a5702SAndreas Gohr                list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, -1);
4310c3a5702SAndreas Gohr            }
4320c3a5702SAndreas Gohr            sort($revs1);
4335d9428a0SSatoshi Sahara            $revs1[] = $lastrev; //push back last entry
4345d9428a0SSatoshi Sahara
4350c3a5702SAndreas Gohr            //return wanted selection
4365d9428a0SSatoshi Sahara            $revs1 = array_slice($revs1, max($index - intval($max / 2), 0), $max);
4370c3a5702SAndreas Gohr        }
4380c3a5702SAndreas Gohr
4390c3a5702SAndreas Gohr        return array(array_reverse($revs1), array_reverse($revs2));
4400c3a5702SAndreas Gohr    }
4410c3a5702SAndreas Gohr
442923e149aSMichael Große
443923e149aSMichael Große    /**
444923e149aSMichael Große     * Checks if the ID has old revisons
445923e149aSMichael Große     * @return boolean
446923e149aSMichael Große     */
447923e149aSMichael Große    public function hasRevisions() {
448923e149aSMichael Große        $file = $this->getChangelogFilename();
449923e149aSMichael Große        return file_exists($file);
450923e149aSMichael Große    }
451923e149aSMichael Große
4520c3a5702SAndreas Gohr    /**
4530c3a5702SAndreas Gohr     * Returns lines from changelog.
4540c3a5702SAndreas Gohr     * If file larger than $chuncksize, only chunck is read that could contain $rev.
4550c3a5702SAndreas Gohr     *
456bd17ac90SSatoshi Sahara     * When reference timestamp $rev is outside time range of changelog, readloglines() will return
457bd17ac90SSatoshi Sahara     * lines in first or last chunk, but they obviously does not contain $rev.
458bd17ac90SSatoshi Sahara     *
4590c3a5702SAndreas Gohr     * @param int $rev revision timestamp
4600c3a5702SAndreas Gohr     * @return array|false
4610c3a5702SAndreas Gohr     *     if success returns array(fp, array(changeloglines), $head, $tail, $eof)
4620c3a5702SAndreas Gohr     *     where fp only defined for chuck reading, needs closing.
4630c3a5702SAndreas Gohr     *     otherwise false
4640c3a5702SAndreas Gohr     */
4650c3a5702SAndreas Gohr    protected function readloglines($rev)
4660c3a5702SAndreas Gohr    {
4670c3a5702SAndreas Gohr        $file = $this->getChangelogFilename();
4680c3a5702SAndreas Gohr
4690c3a5702SAndreas Gohr        if (!file_exists($file)) {
4700c3a5702SAndreas Gohr            return false;
4710c3a5702SAndreas Gohr        }
4720c3a5702SAndreas Gohr
4730c3a5702SAndreas Gohr        $fp = null;
4740c3a5702SAndreas Gohr        $head = 0;
4750c3a5702SAndreas Gohr        $tail = 0;
4760c3a5702SAndreas Gohr        $eof = 0;
4770c3a5702SAndreas Gohr
4780c3a5702SAndreas Gohr        if (filesize($file) < $this->chunk_size || $this->chunk_size == 0) {
4790c3a5702SAndreas Gohr            // read whole file
4800c3a5702SAndreas Gohr            $lines = file($file);
4810c3a5702SAndreas Gohr            if ($lines === false) {
4820c3a5702SAndreas Gohr                return false;
4830c3a5702SAndreas Gohr            }
4840c3a5702SAndreas Gohr        } else {
4850c3a5702SAndreas Gohr            // read by chunk
4860c3a5702SAndreas Gohr            $fp = fopen($file, 'rb'); // "file pointer"
4870c3a5702SAndreas Gohr            if ($fp === false) {
4880c3a5702SAndreas Gohr                return false;
4890c3a5702SAndreas Gohr            }
4900c3a5702SAndreas Gohr            $head = 0;
4910c3a5702SAndreas Gohr            fseek($fp, 0, SEEK_END);
4920c3a5702SAndreas Gohr            $eof = ftell($fp);
4930c3a5702SAndreas Gohr            $tail = $eof;
4940c3a5702SAndreas Gohr
4950c3a5702SAndreas Gohr            // find chunk
4960c3a5702SAndreas Gohr            while ($tail - $head > $this->chunk_size) {
4975d9428a0SSatoshi Sahara                $finger = $head + intval(($tail - $head) / 2);
4980c3a5702SAndreas Gohr                $finger = $this->getNewlinepointer($fp, $finger);
4990c3a5702SAndreas Gohr                $tmp = fgets($fp);
5000c3a5702SAndreas Gohr                if ($finger == $head || $finger == $tail) {
5010c3a5702SAndreas Gohr                    break;
5020c3a5702SAndreas Gohr                }
503bd17ac90SSatoshi Sahara                $info = parseChangelogLine($tmp);
504bd17ac90SSatoshi Sahara                $finger_rev = $info['date'];
5050c3a5702SAndreas Gohr
5060c3a5702SAndreas Gohr                if ($finger_rev > $rev) {
5070c3a5702SAndreas Gohr                    $tail = $finger;
5080c3a5702SAndreas Gohr                } else {
5090c3a5702SAndreas Gohr                    $head = $finger;
5100c3a5702SAndreas Gohr                }
5110c3a5702SAndreas Gohr            }
5120c3a5702SAndreas Gohr
5130c3a5702SAndreas Gohr            if ($tail - $head < 1) {
5140c3a5702SAndreas Gohr                // cound not find chunk, assume requested rev is missing
5150c3a5702SAndreas Gohr                fclose($fp);
5160c3a5702SAndreas Gohr                return false;
5170c3a5702SAndreas Gohr            }
5180c3a5702SAndreas Gohr
5190c3a5702SAndreas Gohr            $lines = $this->readChunk($fp, $head, $tail);
5200c3a5702SAndreas Gohr        }
5210c3a5702SAndreas Gohr        return array(
5220c3a5702SAndreas Gohr            $fp,
5230c3a5702SAndreas Gohr            $lines,
5240c3a5702SAndreas Gohr            $head,
5250c3a5702SAndreas Gohr            $tail,
5260c3a5702SAndreas Gohr            $eof,
5270c3a5702SAndreas Gohr        );
5280c3a5702SAndreas Gohr    }
5290c3a5702SAndreas Gohr
5300c3a5702SAndreas Gohr    /**
5310c3a5702SAndreas Gohr     * Read chunk and return array with lines of given chunck.
5320c3a5702SAndreas Gohr     * Has no check if $head and $tail are really at a new line
5330c3a5702SAndreas Gohr     *
5340c3a5702SAndreas Gohr     * @param resource $fp resource filepointer
5350c3a5702SAndreas Gohr     * @param int $head start point chunck
5360c3a5702SAndreas Gohr     * @param int $tail end point chunck
5370c3a5702SAndreas Gohr     * @return array lines read from chunck
5380c3a5702SAndreas Gohr     */
5390c3a5702SAndreas Gohr    protected function readChunk($fp, $head, $tail)
5400c3a5702SAndreas Gohr    {
5410c3a5702SAndreas Gohr        $chunk = '';
5420c3a5702SAndreas Gohr        $chunk_size = max($tail - $head, 0); // found chunk size
5430c3a5702SAndreas Gohr        $got = 0;
5440c3a5702SAndreas Gohr        fseek($fp, $head);
5450c3a5702SAndreas Gohr        while ($got < $chunk_size && !feof($fp)) {
5460c3a5702SAndreas Gohr            $tmp = @fread($fp, max(min($this->chunk_size, $chunk_size - $got), 0));
5470c3a5702SAndreas Gohr            if ($tmp === false) { //error state
5480c3a5702SAndreas Gohr                break;
5490c3a5702SAndreas Gohr            }
5500c3a5702SAndreas Gohr            $got += strlen($tmp);
5510c3a5702SAndreas Gohr            $chunk .= $tmp;
5520c3a5702SAndreas Gohr        }
5530c3a5702SAndreas Gohr        $lines = explode("\n", $chunk);
5540c3a5702SAndreas Gohr        array_pop($lines); // remove trailing newline
5550c3a5702SAndreas Gohr        return $lines;
5560c3a5702SAndreas Gohr    }
5570c3a5702SAndreas Gohr
5580c3a5702SAndreas Gohr    /**
5590c3a5702SAndreas Gohr     * Set pointer to first new line after $finger and return its position
5600c3a5702SAndreas Gohr     *
5610c3a5702SAndreas Gohr     * @param resource $fp filepointer
5620c3a5702SAndreas Gohr     * @param int $finger a pointer
5630c3a5702SAndreas Gohr     * @return int pointer
5640c3a5702SAndreas Gohr     */
5650c3a5702SAndreas Gohr    protected function getNewlinepointer($fp, $finger)
5660c3a5702SAndreas Gohr    {
5670c3a5702SAndreas Gohr        fseek($fp, $finger);
5680c3a5702SAndreas Gohr        $nl = $finger;
5690c3a5702SAndreas Gohr        if ($finger > 0) {
5700c3a5702SAndreas Gohr            fgets($fp); // slip the finger forward to a new line
5710c3a5702SAndreas Gohr            $nl = ftell($fp);
5720c3a5702SAndreas Gohr        }
5730c3a5702SAndreas Gohr        return $nl;
5740c3a5702SAndreas Gohr    }
5750c3a5702SAndreas Gohr
5760c3a5702SAndreas Gohr    /**
5770c3a5702SAndreas Gohr     * Return an existing revision for a specific date which is
5780c3a5702SAndreas Gohr     * the current one or younger or equal then the date
5790c3a5702SAndreas Gohr     *
5800c3a5702SAndreas Gohr     * @param number $date_at timestamp
5810c3a5702SAndreas Gohr     * @return string revision ('' for current)
5820c3a5702SAndreas Gohr     */
5830c3a5702SAndreas Gohr    public function getLastRevisionAt($date_at)
5840c3a5702SAndreas Gohr    {
5850c3a5702SAndreas Gohr        //requested date_at(timestamp) younger or equal then modified_time($this->id) => load current
5860c3a5702SAndreas Gohr        if (file_exists($this->getFilename()) && $date_at >= @filemtime($this->getFilename())) {
5870c3a5702SAndreas Gohr            return '';
5880c3a5702SAndreas Gohr        } else {
5890c3a5702SAndreas Gohr            if ($rev = $this->getRelativeRevision($date_at + 1, -1)) { //+1 to get also the requested date revision
5900c3a5702SAndreas Gohr                return $rev;
5910c3a5702SAndreas Gohr            } else {
5920c3a5702SAndreas Gohr                return false;
5930c3a5702SAndreas Gohr            }
5940c3a5702SAndreas Gohr        }
5950c3a5702SAndreas Gohr    }
5960c3a5702SAndreas Gohr
5970c3a5702SAndreas Gohr    /**
5980c3a5702SAndreas Gohr     * Returns the next lines of the changelog  of the chunck before head or after tail
5990c3a5702SAndreas Gohr     *
6000c3a5702SAndreas Gohr     * @param resource $fp filepointer
6010c3a5702SAndreas Gohr     * @param int $head position head of last chunk
6020c3a5702SAndreas Gohr     * @param int $tail position tail of last chunk
6030c3a5702SAndreas Gohr     * @param int $direction positive forward, negative backward
6040c3a5702SAndreas Gohr     * @return array with entries:
6050c3a5702SAndreas Gohr     *    - $lines: changelog lines of readed chunk
6060c3a5702SAndreas Gohr     *    - $head: head of chunk
6070c3a5702SAndreas Gohr     *    - $tail: tail of chunk
6080c3a5702SAndreas Gohr     */
6090c3a5702SAndreas Gohr    protected function readAdjacentChunk($fp, $head, $tail, $direction)
6100c3a5702SAndreas Gohr    {
6110c3a5702SAndreas Gohr        if (!$fp) return array(array(), $head, $tail);
6120c3a5702SAndreas Gohr
6130c3a5702SAndreas Gohr        if ($direction > 0) {
6140c3a5702SAndreas Gohr            //read forward
6150c3a5702SAndreas Gohr            $head = $tail;
6165d9428a0SSatoshi Sahara            $tail = $head + intval($this->chunk_size * (2 / 3));
6170c3a5702SAndreas Gohr            $tail = $this->getNewlinepointer($fp, $tail);
6180c3a5702SAndreas Gohr        } else {
6190c3a5702SAndreas Gohr            //read backward
6200c3a5702SAndreas Gohr            $tail = $head;
6210c3a5702SAndreas Gohr            $head = max($tail - $this->chunk_size, 0);
6220c3a5702SAndreas Gohr            while (true) {
6230c3a5702SAndreas Gohr                $nl = $this->getNewlinepointer($fp, $head);
6240c3a5702SAndreas Gohr                // was the chunk big enough? if not, take another bite
6250c3a5702SAndreas Gohr                if ($nl > 0 && $tail <= $nl) {
6260c3a5702SAndreas Gohr                    $head = max($head - $this->chunk_size, 0);
6270c3a5702SAndreas Gohr                } else {
6280c3a5702SAndreas Gohr                    $head = $nl;
6290c3a5702SAndreas Gohr                    break;
6300c3a5702SAndreas Gohr                }
6310c3a5702SAndreas Gohr            }
6320c3a5702SAndreas Gohr        }
6330c3a5702SAndreas Gohr
6340c3a5702SAndreas Gohr        //load next chunck
6350c3a5702SAndreas Gohr        $lines = $this->readChunk($fp, $head, $tail);
6360c3a5702SAndreas Gohr        return array($lines, $head, $tail);
6370c3a5702SAndreas Gohr    }
6380c3a5702SAndreas Gohr
6390c3a5702SAndreas Gohr    /**
6400c3a5702SAndreas Gohr     * Collect the $max revisions near to the timestamp $rev
6410c3a5702SAndreas Gohr     *
642bd17ac90SSatoshi Sahara     * Ideally, half of retrieved timestamps are older than $rev, another half are newer.
643bd17ac90SSatoshi Sahara     * The returned array $requestedrevs may not contain the reference timestamp $rev
644bd17ac90SSatoshi Sahara     * when it does not match any revision value recorded in changelog.
645bd17ac90SSatoshi Sahara     *
6460c3a5702SAndreas Gohr     * @param int $rev revision timestamp
6470c3a5702SAndreas Gohr     * @param int $max maximum number of revisions to be returned
6480c3a5702SAndreas Gohr     * @return bool|array
6490c3a5702SAndreas Gohr     *     return array with entries:
6500c3a5702SAndreas Gohr     *       - $requestedrevs: array of with $max revision timestamps
6510c3a5702SAndreas Gohr     *       - $revs: all parsed revision timestamps
6520c3a5702SAndreas Gohr     *       - $fp: filepointer only defined for chuck reading, needs closing.
6530c3a5702SAndreas Gohr     *       - $lines: non-parsed changelog lines before the parsed revisions
6540c3a5702SAndreas Gohr     *       - $head: position of first readed changelogline
6550c3a5702SAndreas Gohr     *       - $lasttail: position of end of last readed changelogline
6560c3a5702SAndreas Gohr     *     otherwise false
6570c3a5702SAndreas Gohr     */
6580c3a5702SAndreas Gohr    protected function retrieveRevisionsAround($rev, $max)
6590c3a5702SAndreas Gohr    {
660a3984ddfSSatoshi Sahara        $revs = array();
661a3984ddfSSatoshi Sahara        $aftercount = $beforecount = 0;
662a3984ddfSSatoshi Sahara
6630c3a5702SAndreas Gohr        //get lines from changelog
664bd17ac90SSatoshi Sahara        list($fp, $lines, $starthead, $starttail, $eof) = $this->readloglines($rev);
665bd17ac90SSatoshi Sahara        if (empty($lines)) return false;
6660c3a5702SAndreas Gohr
667bd17ac90SSatoshi Sahara        //parse changelog lines in chunk, and read forward more chunks until $max/2 is reached
6680c3a5702SAndreas Gohr        $head = $starthead;
6690c3a5702SAndreas Gohr        $tail = $starttail;
6700c3a5702SAndreas Gohr        while (count($lines) > 0) {
6710c3a5702SAndreas Gohr            foreach ($lines as $line) {
672bd17ac90SSatoshi Sahara                $info = parseChangelogLine($line);
673b82f2411SSatoshi Sahara                if ($this->saveRevisionInfo($info)) {
674bd17ac90SSatoshi Sahara                    $revs[] = $info['date'];
675bd17ac90SSatoshi Sahara                    if ($info['date'] >= $rev) {
6760c3a5702SAndreas Gohr                        //count revs after reference $rev
6770c3a5702SAndreas Gohr                        $aftercount++;
6780c3a5702SAndreas Gohr                        if ($aftercount == 1) $beforecount = count($revs);
6790c3a5702SAndreas Gohr                    }
6800c3a5702SAndreas Gohr                    //enough revs after reference $rev?
6815d9428a0SSatoshi Sahara                    if ($aftercount > intval($max / 2)) break 2;
6820c3a5702SAndreas Gohr                }
6830c3a5702SAndreas Gohr            }
6840c3a5702SAndreas Gohr            //retrieve next chunk
6850c3a5702SAndreas Gohr            list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, 1);
6860c3a5702SAndreas Gohr        }
6870c3a5702SAndreas Gohr        $lasttail = $tail;
6880c3a5702SAndreas Gohr
689bd17ac90SSatoshi Sahara        // add a possible revision of external edit, create or deletion
690df7627d6SSatoshi Sahara        if ($lasttail == $eof && $aftercount <= intval($max / 2) &&
691df7627d6SSatoshi Sahara            count($revs) && !$this->isCurrentRevision($revs[count($revs)-1])
692df7627d6SSatoshi Sahara        ) {
693bd17ac90SSatoshi Sahara            $revs[] = $this->currentRevision;
694bd17ac90SSatoshi Sahara            $aftercount++;
695bd17ac90SSatoshi Sahara        }
696bd17ac90SSatoshi Sahara
697bd17ac90SSatoshi Sahara        if ($aftercount == 0) {
698bd17ac90SSatoshi Sahara            //given timestamp $rev is newer than the most recent line in chunk
699bd17ac90SSatoshi Sahara            return false; //FIXME: or proceed to collect older revisions?
700bd17ac90SSatoshi Sahara        }
701bd17ac90SSatoshi Sahara
702bd17ac90SSatoshi Sahara        //read more chunks backward until $max/2 is reached and total number of revs is equal to $max
7030c3a5702SAndreas Gohr        $lines = array();
7040c3a5702SAndreas Gohr        $i = 0;
7050c3a5702SAndreas Gohr        if ($aftercount > 0) {
7060c3a5702SAndreas Gohr            $head = $starthead;
7070c3a5702SAndreas Gohr            $tail = $starttail;
7080c3a5702SAndreas Gohr            while ($head > 0) {
7090c3a5702SAndreas Gohr                list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, -1);
7100c3a5702SAndreas Gohr
7110c3a5702SAndreas Gohr                for ($i = count($lines) - 1; $i >= 0; $i--) {
712bd17ac90SSatoshi Sahara                    $info = parseChangelogLine($lines[$i]);
713b82f2411SSatoshi Sahara                    if ($this->saveRevisionInfo($info)) {
714bd17ac90SSatoshi Sahara                        $revs[] = $info['date'];
7150c3a5702SAndreas Gohr                        $beforecount++;
7160c3a5702SAndreas Gohr                        //enough revs before reference $rev?
7175d9428a0SSatoshi Sahara                        if ($beforecount > max(intval($max / 2), $max - $aftercount)) break 2;
7180c3a5702SAndreas Gohr                    }
7190c3a5702SAndreas Gohr                }
7200c3a5702SAndreas Gohr            }
7210c3a5702SAndreas Gohr        }
7220c3a5702SAndreas Gohr        //keep only non-parsed lines
7230c3a5702SAndreas Gohr        $lines = array_slice($lines, 0, $i);
724bd17ac90SSatoshi Sahara
725bd17ac90SSatoshi Sahara        sort($revs);
726bd17ac90SSatoshi Sahara
7270c3a5702SAndreas Gohr        //trunk desired selection
7280c3a5702SAndreas Gohr        $requestedrevs = array_slice($revs, -$max, $max);
7290c3a5702SAndreas Gohr
7300c3a5702SAndreas Gohr        return array($requestedrevs, $revs, $fp, $lines, $head, $lasttail);
7310c3a5702SAndreas Gohr    }
732a3984ddfSSatoshi Sahara
733a3984ddfSSatoshi Sahara    /**
734bd17ac90SSatoshi Sahara     * Get the current revision information, considering external edit, create or deletion
735bd17ac90SSatoshi Sahara     *
736bd17ac90SSatoshi Sahara     * The "current" revison is the last timestamp of the page in the context of changelog.
737bd17ac90SSatoshi Sahara     * However it is often recognised that is in sight now from the DokuWiki user perspective.
738bd17ac90SSatoshi Sahara     * The current page is accessible without any revision identifier (eg. doku.php?id=foo),
739bd17ac90SSatoshi Sahara     * but it has unique modification time of the source txt file and kept in changelog.
740bd17ac90SSatoshi Sahara     * When the page is deleted by saving blank text in the DokuWiki editor, the deletion
741bd17ac90SSatoshi Sahara     * time is to be kept as its revision identifier in the changelog.
742bd17ac90SSatoshi Sahara     *
743bd17ac90SSatoshi Sahara     * External edit will break consistency between the file and changelog. A page source
744bd17ac90SSatoshi Sahara     * file might be modified, created or deleted without using DokuWiki editor, instead
745bd17ac90SSatoshi Sahara     * by accessing direct to the file stored in data directory via server console.
746bd17ac90SSatoshi Sahara     * Such editions are never recorded in changelog. However after external file edit,
747bd17ac90SSatoshi Sahara     * now we can see new "current" content of the edited page!
748bd17ac90SSatoshi Sahara     *
749bd17ac90SSatoshi Sahara     * A tentative revision should be assigned for the external edition to handle whole
750bd17ac90SSatoshi Sahara     * revisions successfully in DokuWiki revision list and diff view interface.
751bd17ac90SSatoshi Sahara     * As far as the source file of the edition exists, a unique revision can be decided
752bd17ac90SSatoshi Sahara     * using function filemtime(), but it could be unknown if the foo.txt file had deleted
753bd17ac90SSatoshi Sahara     * or moved to foo.bak file.
754df7627d6SSatoshi Sahara     * In such case, we assume unknown revision as "last timestamp in changelog" +1
755bd17ac90SSatoshi Sahara     * to ensure that current one should be newer than any revisions in changelog.
756bd17ac90SSatoshi Sahara     * Another case of external edit: when foo.bak file moved back to foo.txt, the current
757bd17ac90SSatoshi Sahara     * one could become older than latest timestamp in changelog. In this case, we should
758bd17ac90SSatoshi Sahara     * assume the revison as "last timestamp in chagelog" +1, instead of its timestamp.
759bd17ac90SSatoshi Sahara     *
760bd17ac90SSatoshi Sahara     * @return bool|array false when page had never existed or array with entries:
761bd17ac90SSatoshi Sahara     *      - date:  revision identifier (timestamp or last revision +1)
762bd17ac90SSatoshi Sahara     *      - ip:    IPv4 address (127.0.0.1)
763bd17ac90SSatoshi Sahara     *      - type:  log line type
764bd17ac90SSatoshi Sahara     *      - id:    id of page or media
765bd17ac90SSatoshi Sahara     *      - user:  user name
766bd17ac90SSatoshi Sahara     *      - sum:   edit summary (or action reason)
767bd17ac90SSatoshi Sahara     *      - extra: extra data (varies by line type)
768bd17ac90SSatoshi Sahara     *      - sizechange: change of filesize
769*dbf582ddSSatoshi Sahara     *      - timestamp: unix timestamp or false (key set only for external edit occurred)
770bd17ac90SSatoshi Sahara     *
771bd17ac90SSatoshi Sahara     * @author  Satoshi Sahara <sahara.satoshi@gmail.com>
772bd17ac90SSatoshi Sahara     */
773bd17ac90SSatoshi Sahara    public function getCurrentRevisionInfo()
774bd17ac90SSatoshi Sahara    {
775bd17ac90SSatoshi Sahara        global $lang;
776bd17ac90SSatoshi Sahara
777bd17ac90SSatoshi Sahara        if (isset($this->currentRevision)) return $this->getRevisionInfo($this->currentRevision);
778bd17ac90SSatoshi Sahara
779bd17ac90SSatoshi Sahara        // get revision id from the item file timestamp and chagelog
780*dbf582ddSSatoshi Sahara        $fileLastMod = $this->getFilename();
781*dbf582ddSSatoshi Sahara        $fileRev = @filemtime($fileLastMod); // false when the file not exist
782df7627d6SSatoshi Sahara        $lastRev = $this->lastRevision();    // false when no changelog
783bd17ac90SSatoshi Sahara
784df7627d6SSatoshi Sahara        if (!$fileRev && !$lastRev) {                // has never existed
785df7627d6SSatoshi Sahara            $this->currentRevision = false;
786bd17ac90SSatoshi Sahara            return false;
787bd17ac90SSatoshi Sahara        } elseif ($fileRev === $lastRev) {           // not external edit
788bd17ac90SSatoshi Sahara            $this->currentRevision = $lastRev;
7895ec96136SSatoshi Sahara            return $this->getRevisionInfo($lastRev);
790bd17ac90SSatoshi Sahara        }
791bd17ac90SSatoshi Sahara
792bd17ac90SSatoshi Sahara        if (!$fileRev && $lastRev) {                 // item file does not exist
793bd17ac90SSatoshi Sahara            // check consistency against changelog
794bd17ac90SSatoshi Sahara            $revInfo = $this->getRevisionInfo($lastRev);
795bd17ac90SSatoshi Sahara            if ($revInfo['type'] == DOKU_CHANGE_TYPE_DELETE) {
796bd17ac90SSatoshi Sahara                $this->currentRevision = $lastRev;
7975ec96136SSatoshi Sahara                return $this->getRevisionInfo($lastRev);
798bd17ac90SSatoshi Sahara            }
799bd17ac90SSatoshi Sahara
800bd17ac90SSatoshi Sahara            // externally deleted
801bd17ac90SSatoshi Sahara            $revInfo = [
802bd17ac90SSatoshi Sahara                'date' => $lastRev +1,
803bd17ac90SSatoshi Sahara                'ip'   => '127.0.0.1',
804bd17ac90SSatoshi Sahara                'type' => DOKU_CHANGE_TYPE_DELETE,
805bd17ac90SSatoshi Sahara                'id'   => $this->id,
806bd17ac90SSatoshi Sahara                'user' => '',
807df7627d6SSatoshi Sahara                'sum'  => $lang['deleted'].' - '.$lang['external_edit'].' ('.$lang['unknowndate'].')',
808bd17ac90SSatoshi Sahara                'extra' => '',
809bd17ac90SSatoshi Sahara                'sizechange' => -io_getSizeFile($this->getFilename($lastRev)),
810*dbf582ddSSatoshi Sahara                'timestamp' => false,
811bd17ac90SSatoshi Sahara            ];
812bd17ac90SSatoshi Sahara
813bd17ac90SSatoshi Sahara        } elseif ($fileRev) {                        // item file exist
814bd17ac90SSatoshi Sahara            // here, file timestamp is different with last revision in changelog
815df7627d6SSatoshi Sahara            $isJustCreated = $lastRev === false || (
816e39c2efbSSatoshi Sahara                    $fileRev > $lastRev &&
817e39c2efbSSatoshi Sahara                    $this->getRevisionInfo($lastRev)['type'] == DOKU_CHANGE_TYPE_DELETE
818e39c2efbSSatoshi Sahara            );
819bd17ac90SSatoshi Sahara            $filesize_new = filesize($this->getFilename());
820804096eaSSatoshi Sahara            $filesize_old = $isJustCreated ? 0 : io_getSizeFile($this->getFilename($lastRev));
821bd17ac90SSatoshi Sahara            $sizechange = $filesize_new - $filesize_old;
822bd17ac90SSatoshi Sahara
823*dbf582ddSSatoshi Sahara            if ($isJustCreated) {
824bd17ac90SSatoshi Sahara                $rev = $timestamp = $fileRev;
825bd17ac90SSatoshi Sahara                $sum = $lang['created'].' - '.$lang['external_edit'];
826bd17ac90SSatoshi Sahara            } elseif ($fileRev > $lastRev) {
827bd17ac90SSatoshi Sahara                $rev = $timestamp = $fileRev;
828bd17ac90SSatoshi Sahara                $sum = $lang['external_edit'];
829bd17ac90SSatoshi Sahara            } else {
830bd17ac90SSatoshi Sahara                // $fileRev is older than $lastRev, externally reverted an old file
831bd17ac90SSatoshi Sahara                $rev = max($fileRev, $lastRev +1);
832*dbf582ddSSatoshi Sahara                $timestamp = false;
833df7627d6SSatoshi Sahara                $sum = $lang['external_edit'].' ('.$lang['unknowndate'].')';
834bd17ac90SSatoshi Sahara            }
835bd17ac90SSatoshi Sahara
836bd17ac90SSatoshi Sahara            // externally created or edited
837bd17ac90SSatoshi Sahara            $revInfo = [
838bd17ac90SSatoshi Sahara                'date' => $rev,
839bd17ac90SSatoshi Sahara                'ip'   => '127.0.0.1',
840bd17ac90SSatoshi Sahara                'type' => $isJustCreated ? DOKU_CHANGE_TYPE_CREATE : DOKU_CHANGE_TYPE_EDIT,
841bd17ac90SSatoshi Sahara                'id'   => $this->id,
842bd17ac90SSatoshi Sahara                'user' => '',
843bd17ac90SSatoshi Sahara                'sum'  => $sum,
844bd17ac90SSatoshi Sahara                'extra' => '',
845bd17ac90SSatoshi Sahara                'sizechange' => $sizechange,
846bd17ac90SSatoshi Sahara                'timestamp' => $timestamp,
847bd17ac90SSatoshi Sahara            ];
848bd17ac90SSatoshi Sahara        }
849bd17ac90SSatoshi Sahara
850bd17ac90SSatoshi Sahara        // cache current revision information of external edition
851bd17ac90SSatoshi Sahara        $this->currentRevision = $revInfo['date'];
852bd17ac90SSatoshi Sahara        $this->cache[$this->id][$this->currentRevision] = $revInfo;
853bd17ac90SSatoshi Sahara        return $this->getRevisionInfo($this->currentRevision);
854bd17ac90SSatoshi Sahara    }
8550c3a5702SAndreas Gohr}
856