1<?php 2/** 3 * Changelog handling functions 4 * 5 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 6 * @author Andreas Gohr <andi@splitbrain.org> 7 */ 8 9// Constants for known core changelog line types. 10// Use these in place of string literals for more readable code. 11define('DOKU_CHANGE_TYPE_CREATE', 'C'); 12define('DOKU_CHANGE_TYPE_EDIT', 'E'); 13define('DOKU_CHANGE_TYPE_MINOR_EDIT', 'e'); 14define('DOKU_CHANGE_TYPE_DELETE', 'D'); 15define('DOKU_CHANGE_TYPE_REVERT', 'R'); 16 17/** 18 * parses a changelog line into it's components 19 * 20 * @author Ben Coburn <btcoburn@silicodon.net> 21 */ 22function parseChangelogLine($line) { 23 $tmp = explode("\t", $line); 24 if ($tmp!==false && count($tmp)>1) { 25 $info = array(); 26 $info['date'] = (int)$tmp[0]; // unix timestamp 27 $info['ip'] = $tmp[1]; // IPv4 address (127.0.0.1) 28 $info['type'] = $tmp[2]; // log line type 29 $info['id'] = $tmp[3]; // page id 30 $info['user'] = $tmp[4]; // user name 31 $info['sum'] = $tmp[5]; // edit summary (or action reason) 32 $info['extra'] = rtrim($tmp[6], "\n"); // extra data (varies by line type) 33 return $info; 34 } else { return false; } 35} 36 37/** 38 * Add's an entry to the changelog and saves the metadata for the page 39 * 40 * @param int $date Timestamp of the change 41 * @param String $id Name of the affected page 42 * @param String $type Type of the change see DOKU_CHANGE_TYPE_* 43 * @param String $summary Summary of the change 44 * @param mixed $extra In case of a revert the revision (timestmp) of the reverted page 45 * @param array $flags Additional flags in a key value array. 46 * Availible flags: 47 * - ExternalEdit - mark as an external edit. 48 * 49 * @author Andreas Gohr <andi@splitbrain.org> 50 * @author Esther Brunner <wikidesign@gmail.com> 51 * @author Ben Coburn <btcoburn@silicodon.net> 52 */ 53function addLogEntry($date, $id, $type=DOKU_CHANGE_TYPE_EDIT, $summary='', $extra='', $flags=null){ 54 global $conf, $INFO; 55 56 // check for special flags as keys 57 if (!is_array($flags)) { $flags = array(); } 58 $flagExternalEdit = isset($flags['ExternalEdit']); 59 60 $id = cleanid($id); 61 $file = wikiFN($id); 62 $created = @filectime($file); 63 $minor = ($type===DOKU_CHANGE_TYPE_MINOR_EDIT); 64 $wasRemoved = ($type===DOKU_CHANGE_TYPE_DELETE); 65 66 if(!$date) $date = time(); //use current time if none supplied 67 $remote = (!$flagExternalEdit)?clientIP(true):'127.0.0.1'; 68 $user = (!$flagExternalEdit)?$_SERVER['REMOTE_USER']:''; 69 70 $strip = array("\t", "\n"); 71 $logline = array( 72 'date' => $date, 73 'ip' => $remote, 74 'type' => str_replace($strip, '', $type), 75 'id' => $id, 76 'user' => $user, 77 'sum' => utf8_substr(str_replace($strip, '', $summary),0,255), 78 'extra' => str_replace($strip, '', $extra) 79 ); 80 81 // update metadata 82 if (!$wasRemoved) { 83 $oldmeta = p_read_metadata($id); 84 $meta = array(); 85 if (!$INFO['exists'] && empty($oldmeta['persistent']['date']['created'])){ // newly created 86 $meta['date']['created'] = $created; 87 if ($user){ 88 $meta['creator'] = $INFO['userinfo']['name']; 89 $meta['user'] = $user; 90 } 91 } elseif (!$INFO['exists'] && !empty($oldmeta['persistent']['date']['created'])) { // re-created / restored 92 $meta['date']['created'] = $oldmeta['persistent']['date']['created']; 93 $meta['date']['modified'] = $created; // use the files ctime here 94 $meta['creator'] = $oldmeta['persistent']['creator']; 95 if ($user) $meta['contributor'][$user] = $INFO['userinfo']['name']; 96 } elseif (!$minor) { // non-minor modification 97 $meta['date']['modified'] = $date; 98 if ($user) $meta['contributor'][$user] = $INFO['userinfo']['name']; 99 } 100 $meta['last_change'] = $logline; 101 p_set_metadata($id, $meta); 102 } 103 104 // add changelog lines 105 $logline = implode("\t", $logline)."\n"; 106 io_saveFile(metaFN($id,'.changes'),$logline,true); //page changelog 107 io_saveFile($conf['changelog'],$logline,true); //global changelog cache 108} 109 110/** 111 * Add's an entry to the media changelog 112 * 113 * @author Michael Hamann <michael@content-space.de> 114 * @author Andreas Gohr <andi@splitbrain.org> 115 * @author Esther Brunner <wikidesign@gmail.com> 116 * @author Ben Coburn <btcoburn@silicodon.net> 117 */ 118function addMediaLogEntry($date, $id, $type=DOKU_CHANGE_TYPE_EDIT, $summary='', $extra='', $flags=null){ 119 global $conf; 120 121 $id = cleanid($id); 122 123 if(!$date) $date = time(); //use current time if none supplied 124 $remote = clientIP(true); 125 $user = $_SERVER['REMOTE_USER']; 126 127 $strip = array("\t", "\n"); 128 $logline = array( 129 'date' => $date, 130 'ip' => $remote, 131 'type' => str_replace($strip, '', $type), 132 'id' => $id, 133 'user' => $user, 134 'sum' => utf8_substr(str_replace($strip, '', $summary),0,255), 135 'extra' => str_replace($strip, '', $extra) 136 ); 137 138 // add changelog lines 139 $logline = implode("\t", $logline)."\n"; 140 io_saveFile($conf['media_changelog'],$logline,true); //global media changelog cache 141 io_saveFile(mediaMetaFN($id,'.changes'),$logline,true); //media file's changelog 142} 143 144/** 145 * returns an array of recently changed files using the 146 * changelog 147 * 148 * The following constants can be used to control which changes are 149 * included. Add them together as needed. 150 * 151 * RECENTS_SKIP_DELETED - don't include deleted pages 152 * RECENTS_SKIP_MINORS - don't include minor changes 153 * RECENTS_SKIP_SUBSPACES - don't include subspaces 154 * RECENTS_MEDIA_CHANGES - return media changes instead of page changes 155 * RECENTS_MEDIA_PAGES_MIXED - return both media changes and page changes 156 * 157 * @param int $first number of first entry returned (for paginating 158 * @param int $num return $num entries 159 * @param string $ns restrict to given namespace 160 * @param int $flags see above 161 * @return array recently changed files 162 * 163 * @author Ben Coburn <btcoburn@silicodon.net> 164 * @author Kate Arzamastseva <pshns@ukr.net> 165 */ 166function getRecents($first,$num,$ns='',$flags=0){ 167 global $conf; 168 $recent = array(); 169 $count = 0; 170 171 if(!$num) 172 return $recent; 173 174 // read all recent changes. (kept short) 175 if ($flags & RECENTS_MEDIA_CHANGES) { 176 $lines = @file($conf['media_changelog']); 177 } else { 178 $lines = @file($conf['changelog']); 179 } 180 $lines_position = count($lines)-1; 181 $media_lines_position = 0; 182 $media_lines = array(); 183 184 if ($flags & RECENTS_MEDIA_PAGES_MIXED) { 185 $media_lines = @file($conf['media_changelog']); 186 $media_lines_position = count($media_lines)-1; 187 } 188 189 $seen = array(); // caches seen lines, _handleRecent() skips them 190 191 // handle lines 192 while ($lines_position >= 0 || (($flags & RECENTS_MEDIA_PAGES_MIXED) && $media_lines_position >=0)) { 193 if (empty($rec) && $lines_position >= 0) { 194 $rec = _handleRecent(@$lines[$lines_position], $ns, $flags, $seen); 195 if (!$rec) { 196 $lines_position --; 197 continue; 198 } 199 } 200 if (($flags & RECENTS_MEDIA_PAGES_MIXED) && empty($media_rec) && $media_lines_position >= 0) { 201 $media_rec = _handleRecent(@$media_lines[$media_lines_position], $ns, $flags | RECENTS_MEDIA_CHANGES, $seen); 202 if (!$media_rec) { 203 $media_lines_position --; 204 continue; 205 } 206 } 207 if (($flags & RECENTS_MEDIA_PAGES_MIXED) && @$media_rec['date'] >= @$rec['date']) { 208 $media_lines_position--; 209 $x = $media_rec; 210 $x['media'] = true; 211 $media_rec = false; 212 } else { 213 $lines_position--; 214 $x = $rec; 215 if ($flags & RECENTS_MEDIA_CHANGES) $x['media'] = true; 216 $rec = false; 217 } 218 if(--$first >= 0) continue; // skip first entries 219 $recent[] = $x; 220 $count++; 221 // break when we have enough entries 222 if($count >= $num){ break; } 223 } 224 return $recent; 225} 226 227/** 228 * returns an array of files changed since a given time using the 229 * changelog 230 * 231 * The following constants can be used to control which changes are 232 * included. Add them together as needed. 233 * 234 * RECENTS_SKIP_DELETED - don't include deleted pages 235 * RECENTS_SKIP_MINORS - don't include minor changes 236 * RECENTS_SKIP_SUBSPACES - don't include subspaces 237 * RECENTS_MEDIA_CHANGES - return media changes instead of page changes 238 * 239 * @param int $from date of the oldest entry to return 240 * @param int $to date of the newest entry to return (for pagination, optional) 241 * @param string $ns restrict to given namespace (optional) 242 * @param int $flags see above (optional) 243 * @return array of files 244 * 245 * @author Michael Hamann <michael@content-space.de> 246 * @author Ben Coburn <btcoburn@silicodon.net> 247 */ 248function getRecentsSince($from,$to=null,$ns='',$flags=0){ 249 global $conf; 250 $recent = array(); 251 252 if($to && $to < $from) 253 return $recent; 254 255 // read all recent changes. (kept short) 256 if ($flags & RECENTS_MEDIA_CHANGES) { 257 $lines = @file($conf['media_changelog']); 258 } else { 259 $lines = @file($conf['changelog']); 260 } 261 if(!$lines) return $recent; 262 263 // we start searching at the end of the list 264 $lines = array_reverse($lines); 265 266 // handle lines 267 $seen = array(); // caches seen lines, _handleRecent() skips them 268 269 foreach($lines as $line){ 270 $rec = _handleRecent($line, $ns, $flags, $seen); 271 if($rec !== false) { 272 if ($rec['date'] >= $from) { 273 if (!$to || $rec['date'] <= $to) { 274 $recent[] = $rec; 275 } 276 } else { 277 break; 278 } 279 } 280 } 281 282 return array_reverse($recent); 283} 284 285/** 286 * Internal function used by getRecents 287 * 288 * don't call directly 289 * 290 * @see getRecents() 291 * @author Andreas Gohr <andi@splitbrain.org> 292 * @author Ben Coburn <btcoburn@silicodon.net> 293 */ 294function _handleRecent($line,$ns,$flags,&$seen){ 295 if(empty($line)) return false; //skip empty lines 296 297 // split the line into parts 298 $recent = parseChangelogLine($line); 299 if ($recent===false) { return false; } 300 301 // skip seen ones 302 if(isset($seen[$recent['id']])) return false; 303 304 // skip minors 305 if($recent['type']===DOKU_CHANGE_TYPE_MINOR_EDIT && ($flags & RECENTS_SKIP_MINORS)) return false; 306 307 // remember in seen to skip additional sights 308 $seen[$recent['id']] = 1; 309 310 // check if it's a hidden page 311 if(isHiddenPage($recent['id'])) return false; 312 313 // filter namespace 314 if (($ns) && (strpos($recent['id'],$ns.':') !== 0)) return false; 315 316 // exclude subnamespaces 317 if (($flags & RECENTS_SKIP_SUBSPACES) && (getNS($recent['id']) != $ns)) return false; 318 319 // check ACL 320 if ($flags & RECENTS_MEDIA_CHANGES) { 321 $recent['perms'] = auth_quickaclcheck(getNS($recent['id']).':*'); 322 } else { 323 $recent['perms'] = auth_quickaclcheck($recent['id']); 324 } 325 if ($recent['perms'] < AUTH_READ) return false; 326 327 // check existance 328 if($flags & RECENTS_SKIP_DELETED){ 329 $fn = (($flags & RECENTS_MEDIA_CHANGES) ? mediaFN($recent['id']) : wikiFN($recent['id'])); 330 if(!@file_exists($fn)) return false; 331 } 332 333 return $recent; 334} 335 336/** 337 * Class ChangeLog 338 * methods for handling of changelog of pages or media files 339 */ 340abstract class ChangeLog { 341 342 /** @var string */ 343 protected $id; 344 /** @var int */ 345 protected $chunk_size; 346 /** @var array */ 347 protected $cache; 348 349 /** 350 * Constructor 351 * 352 * @param string $id page id 353 * @param int $chunk_size maximum block size read from file 354 */ 355 public function __construct($id, $chunk_size = 8192) { 356 global $cache_revinfo; 357 358 $this->cache =& $cache_revinfo; 359 if(!isset($this->cache[$id])) { 360 $this->cache[$id] = array(); 361 } 362 363 $this->id = $id; 364 $this->setChunkSize($chunk_size); 365 366 } 367 368 /** 369 * Set chunk size for file reading 370 * Chunk size zero let read whole file at once 371 * 372 * @param int $chunk_size maximum block size read from file 373 */ 374 public function setChunkSize($chunk_size) { 375 if(!is_numeric($chunk_size)) $chunk_size = 0; 376 377 $this->chunk_size = (int) max($chunk_size, 0); 378 } 379 380 /** 381 * Returns path to changelog 382 * 383 * @return string path to file 384 */ 385 abstract protected function getChangelogFilename(); 386 387 /** 388 * Returns path to current page/media 389 * 390 * @return string path to file 391 */ 392 abstract protected function getFilename(); 393 394 /** 395 * Get the changelog information for a specific page id and revision (timestamp) 396 * 397 * Adjacent changelog lines are optimistically parsed and cached to speed up 398 * consecutive calls to getRevisionInfo. For large changelog files, only the chunk 399 * containing the requested changelog line is read. 400 * 401 * @param int $rev revision timestamp 402 * @return bool|array false or array with entries: 403 * - date: unix timestamp 404 * - ip: IPv4 address (127.0.0.1) 405 * - type: log line type 406 * - id: page id 407 * - user: user name 408 * - sum: edit summary (or action reason) 409 * - extra: extra data (varies by line type) 410 * 411 * @author Ben Coburn <btcoburn@silicodon.net> 412 * @author Kate Arzamastseva <pshns@ukr.net> 413 */ 414 public function getRevisionInfo($rev) { 415 $rev = max($rev, 0); 416 417 // check if it's already in the memory cache 418 if(isset($this->cache[$this->id]) && isset($this->cache[$this->id][$rev])) { 419 return $this->cache[$this->id][$rev]; 420 } 421 422 //read lines from changelog 423 list($fp, $lines) = $this->readloglines($rev); 424 if($fp) { 425 fclose($fp); 426 } 427 if(empty($lines)) return false; 428 429 // parse and cache changelog lines 430 foreach($lines as $value) { 431 $tmp = parseChangelogLine($value); 432 if($tmp !== false) { 433 $this->cache[$this->id][$tmp['date']] = $tmp; 434 } 435 } 436 if(!isset($this->cache[$this->id][$rev])) { 437 return false; 438 } 439 return $this->cache[$this->id][$rev]; 440 } 441 442 /** 443 * Return a list of page revisions numbers 444 * 445 * Does not guarantee that the revision exists in the attic, 446 * only that a line with the date exists in the changelog. 447 * By default the current revision is skipped. 448 * 449 * The current revision is automatically skipped when the page exists. 450 * See $INFO['meta']['last_change'] for the current revision. 451 * A negative $first let read the current revision too. 452 * 453 * For efficiency, the log lines are parsed and cached for later 454 * calls to getRevisionInfo. Large changelog files are read 455 * backwards in chunks until the requested number of changelog 456 * lines are recieved. 457 * 458 * @param int $first skip the first n changelog lines 459 * @param int $num number of revisions to return 460 * @return array with the revision timestamps 461 * 462 * @author Ben Coburn <btcoburn@silicodon.net> 463 * @author Kate Arzamastseva <pshns@ukr.net> 464 */ 465 public function getRevisions($first, $num) { 466 $revs = array(); 467 $lines = array(); 468 $count = 0; 469 470 $num = max($num, 0); 471 if($num == 0) { 472 return $revs; 473 } 474 475 if($first < 0) { 476 $first = 0; 477 } else if(@file_exists($this->getFilename())) { 478 // skip current revision if the page exists 479 $first = max($first + 1, 0); 480 } 481 482 $file = $this->getChangelogFilename(); 483 484 if(!@file_exists($file)) { 485 return $revs; 486 } 487 if(filesize($file) < $this->chunk_size || $this->chunk_size == 0) { 488 // read whole file 489 $lines = file($file); 490 if($lines === false) { 491 return $revs; 492 } 493 } else { 494 // read chunks backwards 495 $fp = fopen($file, 'rb'); // "file pointer" 496 if($fp === false) { 497 return $revs; 498 } 499 fseek($fp, 0, SEEK_END); 500 $tail = ftell($fp); 501 502 // chunk backwards 503 $finger = max($tail - $this->chunk_size, 0); 504 while($count < $num + $first) { 505 $nl = $this->getNewlinepointer($fp, $finger); 506 507 // was the chunk big enough? if not, take another bite 508 if($nl > 0 && $tail <= $nl) { 509 $finger = max($finger - $this->chunk_size, 0); 510 continue; 511 } else { 512 $finger = $nl; 513 } 514 515 // read chunk 516 $chunk = ''; 517 $read_size = max($tail - $finger, 0); // found chunk size 518 $got = 0; 519 while($got < $read_size && !feof($fp)) { 520 $tmp = @fread($fp, max(min($this->chunk_size, $read_size - $got), 0)); 521 if($tmp === false) { 522 break; 523 } //error state 524 $got += strlen($tmp); 525 $chunk .= $tmp; 526 } 527 $tmp = explode("\n", $chunk); 528 array_pop($tmp); // remove trailing newline 529 530 // combine with previous chunk 531 $count += count($tmp); 532 $lines = array_merge($tmp, $lines); 533 534 // next chunk 535 if($finger == 0) { 536 break; 537 } // already read all the lines 538 else { 539 $tail = $finger; 540 $finger = max($tail - $this->chunk_size, 0); 541 } 542 } 543 fclose($fp); 544 } 545 546 // skip parsing extra lines 547 $num = max(min(count($lines) - $first, $num), 0); 548 if ($first > 0 && $num > 0) { $lines = array_slice($lines, max(count($lines) - $first - $num, 0), $num); } 549 else if($first > 0 && $num == 0) { $lines = array_slice($lines, 0, max(count($lines) - $first, 0)); } 550 else if($first == 0 && $num > 0) { $lines = array_slice($lines, max(count($lines) - $num, 0)); } 551 552 // handle lines in reverse order 553 for($i = count($lines) - 1; $i >= 0; $i--) { 554 $tmp = parseChangelogLine($lines[$i]); 555 if($tmp !== false) { 556 $this->cache[$this->id][$tmp['date']] = $tmp; 557 $revs[] = $tmp['date']; 558 } 559 } 560 561 return $revs; 562 } 563 564 /** 565 * Get the nth revision left or right handside for a specific page id and revision (timestamp) 566 * 567 * For large changelog files, only the chunk containing the 568 * reference revision $rev is read and sometimes a next chunck. 569 * 570 * Adjacent changelog lines are optimistically parsed and cached to speed up 571 * consecutive calls to getRevisionInfo. 572 * 573 * @param int $rev revision timestamp used as startdate (doesn't need to be revisionnumber) 574 * @param int $direction give position of returned revision with respect to $rev; positive=next, negative=prev 575 * @return bool|int 576 * timestamp of the requested revision 577 * otherwise false 578 */ 579 public function getRelativeRevision($rev, $direction) { 580 $rev = max($rev, 0); 581 $direction = (int) $direction; 582 583 //no direction given or last rev, so no follow-up 584 if(!$direction || ($direction > 0 && $this->isCurrentRevision($rev))) { 585 return false; 586 } 587 588 //get lines from changelog 589 list($fp, $lines, $head, $tail, $eof) = $this->readloglines($rev); 590 if(empty($lines)) return false; 591 592 // look for revisions later/earlier then $rev, when founded count till the wanted revision is reached 593 // also parse and cache changelog lines for getRevisionInfo(). 594 $revcounter = 0; 595 $relativerev = false; 596 $checkotherchunck = true; //always runs once 597 while(!$relativerev && $checkotherchunck) { 598 $tmp = array(); 599 //parse in normal or reverse order 600 $count = count($lines); 601 if($direction > 0) { 602 $start = 0; 603 $step = 1; 604 } else { 605 $start = $count - 1; 606 $step = -1; 607 } 608 for($i = $start; $i >= 0 && $i < $count; $i = $i + $step) { 609 $tmp = parseChangelogLine($lines[$i]); 610 if($tmp !== false) { 611 $this->cache[$this->id][$tmp['date']] = $tmp; 612 //look for revs older/earlier then reference $rev and select $direction-th one 613 if(($direction > 0 && $tmp['date'] > $rev) || ($direction < 0 && $tmp['date'] < $rev)) { 614 $revcounter++; 615 if($revcounter == abs($direction)) { 616 $relativerev = $tmp['date']; 617 } 618 } 619 } 620 } 621 622 //true when $rev is found, but not the wanted follow-up. 623 $checkotherchunck = $fp 624 && ($tmp['date'] == $rev || ($revcounter > 0 && !$relativerev)) 625 && !(($tail == $eof && $direction > 0) || ($head == 0 && $direction < 0)); 626 627 if($checkotherchunck) { 628 list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, $direction); 629 630 if(empty($lines)) break; 631 } 632 } 633 if($fp) { 634 fclose($fp); 635 } 636 637 return $relativerev; 638 } 639 640 /** 641 * Returns revisions around rev1 and rev2 642 * When available it returns $max entries for each revision 643 * 644 * @param int $rev1 oldest revision timestamp 645 * @param int $rev2 newest revision timestamp 646 * @param int $max maximum number of revisions returned 647 * @return array with two arrays with revisions surrounding rev1 respectively rev2 648 */ 649 public function getRevisionsAround($rev1, $rev2, $max = 50) { 650 $max = floor(abs($max) / 2)*2 + 1; 651 $rev1 = max($rev1, 0); 652 $rev2 = max($rev2, 0); 653 654 if($rev2 < $rev1) { 655 $rev = $rev2; 656 $rev2 = $rev1; 657 $rev1 = $rev; 658 } 659 //collect revisions around rev2 660 list($revs2, $allrevs, $fp, $lines, $head, $tail) = $this->retrieveRevisionsAround($rev2, $max); 661 662 if(empty($revs2)) return array(array(), array()); 663 664 //collect revisions around rev1 665 $index = array_search($rev1, $allrevs); 666 if($index === false) { 667 //no overlapping revisions 668 list($revs1,,,,,) = $this->retrieveRevisionsAround($rev1, $max); 669 if(empty($revs1)) $revs1 = array(); 670 } else { 671 //revisions overlaps, reuse revisions around rev2 672 $revs1 = $allrevs; 673 while($head > 0) { 674 for($i = count($lines) - 1; $i >= 0; $i--) { 675 $tmp = parseChangelogLine($lines[$i]); 676 if($tmp !== false) { 677 $this->cache[$this->id][$tmp['date']] = $tmp; 678 $revs1[] = $tmp['date']; 679 $index++; 680 681 if($index > floor($max / 2)) break 2; 682 } 683 } 684 685 list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, -1); 686 } 687 sort($revs1); 688 //return wanted selection 689 $revs1 = array_slice($revs1, max($index - floor($max/2), 0), $max); 690 } 691 692 return array(array_reverse($revs1), array_reverse($revs2)); 693 } 694 695 /** 696 * Returns lines from changelog. 697 * If file larger than $chuncksize, only chunck is read that could contain $rev. 698 * 699 * @param int $rev revision timestamp 700 * @return array(fp, array(changeloglines), $head, $tail, $eof)|bool 701 * returns false when not succeed. fp only defined for chuck reading, needs closing. 702 */ 703 protected function readloglines($rev) { 704 $file = $this->getChangelogFilename(); 705 706 if(!@file_exists($file)) { 707 return false; 708 } 709 710 $fp = null; 711 $head = 0; 712 $tail = 0; 713 $eof = 0; 714 715 if(filesize($file) < $this->chunk_size || $this->chunk_size == 0) { 716 // read whole file 717 $lines = file($file); 718 if($lines === false) { 719 return false; 720 } 721 } else { 722 // read by chunk 723 $fp = fopen($file, 'rb'); // "file pointer" 724 if($fp === false) { 725 return false; 726 } 727 $head = 0; 728 fseek($fp, 0, SEEK_END); 729 $eof = ftell($fp); 730 $tail = $eof; 731 732 // find chunk 733 while($tail - $head > $this->chunk_size) { 734 $finger = $head + floor(($tail - $head) / 2.0); 735 $finger = $this->getNewlinepointer($fp, $finger); 736 $tmp = fgets($fp); 737 if($finger == $head || $finger == $tail) { 738 break; 739 } 740 $tmp = parseChangelogLine($tmp); 741 $finger_rev = $tmp['date']; 742 743 if($finger_rev > $rev) { 744 $tail = $finger; 745 } else { 746 $head = $finger; 747 } 748 } 749 750 if($tail - $head < 1) { 751 // cound not find chunk, assume requested rev is missing 752 fclose($fp); 753 return false; 754 } 755 756 $lines = $this->readChunk($fp, $head, $tail); 757 } 758 return array( 759 $fp, 760 $lines, 761 $head, 762 $tail, 763 $eof 764 ); 765 } 766 767 /** 768 * Read chunk and return array with lines of given chunck. 769 * Has no check if $head and $tail are really at a new line 770 * 771 * @param $fp resource filepointer 772 * @param $head int start point chunck 773 * @param $tail int end point chunck 774 * @return array lines read from chunck 775 */ 776 protected function readChunk($fp, $head, $tail) { 777 $chunk = ''; 778 $chunk_size = max($tail - $head, 0); // found chunk size 779 $got = 0; 780 fseek($fp, $head); 781 while($got < $chunk_size && !feof($fp)) { 782 $tmp = @fread($fp, max(min($this->chunk_size, $chunk_size - $got), 0)); 783 if($tmp === false) { //error state 784 break; 785 } 786 $got += strlen($tmp); 787 $chunk .= $tmp; 788 } 789 $lines = explode("\n", $chunk); 790 array_pop($lines); // remove trailing newline 791 return $lines; 792 } 793 794 /** 795 * Set pointer to first new line after $finger and return its position 796 * 797 * @param resource $fp filepointer 798 * @param $finger int a pointer 799 * @return int pointer 800 */ 801 protected function getNewlinepointer($fp, $finger) { 802 fseek($fp, $finger); 803 $nl = $finger; 804 if($finger > 0) { 805 fgets($fp); // slip the finger forward to a new line 806 $nl = ftell($fp); 807 } 808 return $nl; 809 } 810 811 /** 812 * Check whether given revision is the current page 813 * 814 * @param int $rev timestamp of current page 815 * @return bool true if $rev is current revision, otherwise false 816 */ 817 public function isCurrentRevision($rev) { 818 return $rev == @filemtime($this->getFilename()); 819 } 820 821 /** 822 * Returns the next lines of the changelog of the chunck before head or after tail 823 * 824 * @param resource $fp filepointer 825 * @param int $head position head of last chunk 826 * @param int $tail position tail of last chunk 827 * @param int $direction positive forward, negative backward 828 * @return array with entries: 829 * - $lines: changelog lines of readed chunk 830 * - $head: head of chunk 831 * - $tail: tail of chunk 832 */ 833 protected function readAdjacentChunk($fp, $head, $tail, $direction) { 834 if(!$fp) return array(array(), $head, $tail); 835 836 if($direction > 0) { 837 //read forward 838 $head = $tail; 839 $tail = $head + floor($this->chunk_size * (2 / 3)); 840 $tail = $this->getNewlinepointer($fp, $tail); 841 } else { 842 //read backward 843 $tail = $head; 844 $head = max($tail - $this->chunk_size, 0); 845 while(true) { 846 $nl = $this->getNewlinepointer($fp, $head); 847 // was the chunk big enough? if not, take another bite 848 if($nl > 0 && $tail <= $nl) { 849 $head = max($head - $this->chunk_size, 0); 850 } else { 851 $head = $nl; 852 break; 853 } 854 } 855 } 856 857 //load next chunck 858 $lines = $this->readChunk($fp, $head, $tail); 859 return array($lines, $head, $tail); 860 } 861 862 /** 863 * Collect the $max revisions near to the timestamp $rev 864 * 865 * @param int $rev revision timestamp 866 * @param int $max maximum number of revisions to be returned 867 * @return bool|array 868 * return array with entries: 869 * - $requestedrevs: array of with $max revision timestamps 870 * - $revs: all parsed revision timestamps 871 * - $fp: filepointer only defined for chuck reading, needs closing. 872 * - $lines: non-parsed changelog lines before the parsed revisions 873 * - $head: position of first readed changelogline 874 * - $lasttail: position of end of last readed changelogline 875 * otherwise false 876 */ 877 protected function retrieveRevisionsAround($rev, $max) { 878 //get lines from changelog 879 list($fp, $lines, $starthead, $starttail, $eof) = $this->readloglines($rev); 880 if(empty($lines)) return false; 881 882 //parse chunk containing $rev, and read forward more chunks until $max/2 is reached 883 $head = $starthead; 884 $tail = $starttail; 885 $revs = array(); 886 $aftercount = $beforecount = 0; 887 while(count($lines) > 0) { 888 foreach($lines as $line) { 889 $tmp = parseChangelogLine($line); 890 if($tmp !== false) { 891 $this->cache[$this->id][$tmp['date']] = $tmp; 892 $revs[] = $tmp['date']; 893 if($tmp['date'] >= $rev) { 894 //count revs after reference $rev 895 $aftercount++; 896 if($aftercount == 1) $beforecount = count($revs); 897 } 898 //enough revs after reference $rev? 899 if($aftercount > floor($max / 2)) break 2; 900 } 901 } 902 //retrieve next chunk 903 list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, 1); 904 } 905 if($aftercount == 0) return false; 906 907 $lasttail = $tail; 908 909 //read additional chuncks backward until $max/2 is reached and total number of revs is equal to $max 910 $lines = array(); 911 $i = 0; 912 if($aftercount > 0) { 913 $head = $starthead; 914 $tail = $starttail; 915 while($head > 0) { 916 list($lines, $head, $tail) = $this->readAdjacentChunk($fp, $head, $tail, -1); 917 918 for($i = count($lines) - 1; $i >= 0; $i--) { 919 $tmp = parseChangelogLine($lines[$i]); 920 if($tmp !== false) { 921 $this->cache[$this->id][$tmp['date']] = $tmp; 922 $revs[] = $tmp['date']; 923 $beforecount++; 924 //enough revs before reference $rev? 925 if($beforecount > max(floor($max / 2), $max - $aftercount)) break 2; 926 } 927 } 928 } 929 } 930 sort($revs); 931 932 //keep only non-parsed lines 933 $lines = array_slice($lines, 0, $i); 934 //trunk desired selection 935 $requestedrevs = array_slice($revs, -$max, $max); 936 937 return array($requestedrevs, $revs, $fp, $lines, $head, $lasttail); 938 } 939} 940 941/** 942 * Class PageChangelog handles changelog of a wiki page 943 */ 944class PageChangelog extends ChangeLog { 945 946 /** 947 * Returns path to changelog 948 * 949 * @return string path to file 950 */ 951 protected function getChangelogFilename() { 952 return metaFN($this->id, '.changes'); 953 } 954 955 /** 956 * Returns path to current page/media 957 * 958 * @return string path to file 959 */ 960 protected function getFilename() { 961 return wikiFN($this->id); 962 } 963} 964 965/** 966 * Class MediaChangelog handles changelog of a media file 967 */ 968class MediaChangelog extends ChangeLog { 969 970 /** 971 * Returns path to changelog 972 * 973 * @return string path to file 974 */ 975 protected function getChangelogFilename() { 976 return mediaMetaFN($this->id, '.changes'); 977 } 978 979 /** 980 * Returns path to current page/media 981 * 982 * @return string path to file 983 */ 984 protected function getFilename() { 985 return mediaFN($this->id); 986 } 987} 988 989/** 990 * Get the changelog information for a specific page id 991 * and revision (timestamp). Adjacent changelog lines 992 * are optimistically parsed and cached to speed up 993 * consecutive calls to getRevisionInfo. For large 994 * changelog files, only the chunk containing the 995 * requested changelog line is read. 996 * 997 * @deprecated 20-11-2013 998 * 999 * @author Ben Coburn <btcoburn@silicodon.net> 1000 * @author Kate Arzamastseva <pshns@ukr.net> 1001 */ 1002function getRevisionInfo($id, $rev, $chunk_size = 8192, $media = false) { 1003 if($media) { 1004 $changelog = new MediaChangeLog($id, $chunk_size); 1005 } else { 1006 $changelog = new PageChangeLog($id, $chunk_size); 1007 } 1008 return $changelog->getRevisionInfo($rev); 1009} 1010 1011/** 1012 * Return a list of page revisions numbers 1013 * Does not guarantee that the revision exists in the attic, 1014 * only that a line with the date exists in the changelog. 1015 * By default the current revision is skipped. 1016 * 1017 * id: the page of interest 1018 * first: skip the first n changelog lines 1019 * num: number of revisions to return 1020 * 1021 * The current revision is automatically skipped when the page exists. 1022 * See $INFO['meta']['last_change'] for the current revision. 1023 * 1024 * For efficiency, the log lines are parsed and cached for later 1025 * calls to getRevisionInfo. Large changelog files are read 1026 * backwards in chunks until the requested number of changelog 1027 * lines are recieved. 1028 * 1029 * @deprecated 20-11-2013 1030 * 1031 * @author Ben Coburn <btcoburn@silicodon.net> 1032 * @author Kate Arzamastseva <pshns@ukr.net> 1033 */ 1034function getRevisions($id, $first, $num, $chunk_size = 8192, $media = false) { 1035 if($media) { 1036 $changelog = new MediaChangeLog($id, $chunk_size); 1037 } else { 1038 $changelog = new PageChangeLog($id, $chunk_size); 1039 } 1040 return $changelog->getRevisions($first, $num); 1041} 1042