/**
* Returns the render instructions for a file
*
* Uses and creates a serialized cache file
*
* @author Andreas Gohr <*****@*****.**>
*/
function p_cached_instructions($file, $cacheonly = false, $id = '')
{
global $conf;
static $run = null;
if (is_null($run)) {
$run = array();
}
$cache = new cache_instructions($id, $file);
if ($cacheonly || $cache->useCache() || isset($run[$file])) {
return $cache->retrieveCache();
} else {
if (@file_exists($file)) {
// no cache - do some work
$ins = p_get_instructions(io_readWikiPage($file, $id));
if ($cache->storeCache($ins)) {
$run[$file] = true;
// we won't rebuild these instructions in the same run again
} else {
msg('Unable to save cache file. Hint: disk full; file permissions; safe_mode setting.', -1);
}
return $ins;
}
}
return null;
}
/**
* Returns the render instructions for a file
*
* Uses and creates a serialized cache file
*
* @author Andreas Gohr <*****@*****.**>
*/
function p_cached_instructions($file, $cacheonly = false, $id = '')
{
global $conf;
$cache = new cache_instructions($id, $file);
if ($cacheonly || $cache->useCache()) {
return $cache->retrieveCache();
} else {
if (@file_exists($file)) {
// no cache - do some work
$ins = p_get_instructions(io_readfile($file));
$cache->storeCache($ins);
return $ins;
}
}
return NULL;
}
/**
* Saves a wikitext by calling io_writeWikiPage.
* Also directs changelog and attic updates.
*
* @author Andreas Gohr <*****@*****.**>
* @author Ben Coburn <*****@*****.**>
*/
function saveWikiText($id, $text, $summary, $minor = false)
{
/* Note to developers:
This code is subtle and delicate. Test the behavior of
the attic and changelog with dokuwiki and external edits
after any changes. External edits change the wiki page
directly without using php or dokuwiki.
*/
global $conf;
global $lang;
global $REV;
// ignore if no changes were made
if ($text == rawWiki($id, '')) {
return;
}
$file = wikiFN($id);
$old = @filemtime($file);
// from page
$wasRemoved = trim($text) == '';
// check for empty or whitespace only
$wasCreated = !@file_exists($file);
$wasReverted = $REV == true;
$newRev = false;
$oldRev = getRevisions($id, -1, 1, 1024);
// from changelog
$oldRev = (int) (empty($oldRev) ? 0 : $oldRev[0]);
if (!@file_exists(wikiFN($id, $old)) && @file_exists($file) && $old >= $oldRev) {
// add old revision to the attic if missing
saveOldRevision($id);
// add a changelog entry if this edit came from outside dokuwiki
if ($old > $oldRev) {
addLogEntry($old, $id, DOKU_CHANGE_TYPE_EDIT, $lang['external_edit'], '', array('ExternalEdit' => true));
// remove soon to be stale instructions
$cache = new cache_instructions($id, $file);
$cache->removeCache();
}
}
if ($wasRemoved) {
// Send "update" event with empty data, so plugins can react to page deletion
$data = array(array($file, '', false), getNS($id), noNS($id), false);
trigger_event('IO_WIKIPAGE_WRITE', $data);
// pre-save deleted revision
@touch($file);
clearstatcache();
$newRev = saveOldRevision($id);
// remove empty file
@unlink($file);
// don't remove old meta info as it should be saved, plugins can use IO_WIKIPAGE_WRITE for removing their metadata...
// purge non-persistant meta data
p_purge_metadata($id);
$del = true;
// autoset summary on deletion
if (empty($summary)) {
$summary = $lang['deleted'];
}
// remove empty namespaces
io_sweepNS($id, 'datadir');
io_sweepNS($id, 'mediadir');
} else {
// save file (namespace dir is created in io_writeWikiPage)
io_writeWikiPage($file, $text, $id);
// pre-save the revision, to keep the attic in sync
$newRev = saveOldRevision($id);
$del = false;
}
// select changelog line type
$extra = '';
$type = DOKU_CHANGE_TYPE_EDIT;
if ($wasReverted) {
$type = DOKU_CHANGE_TYPE_REVERT;
$extra = $REV;
} else {
if ($wasCreated) {
$type = DOKU_CHANGE_TYPE_CREATE;
} else {
if ($wasRemoved) {
$type = DOKU_CHANGE_TYPE_DELETE;
} else {
if ($minor && $conf['useacl'] && $_SERVER['REMOTE_USER']) {
$type = DOKU_CHANGE_TYPE_MINOR_EDIT;
}
}
}
}
//minor edits only for logged in users
addLogEntry($newRev, $id, $type, $summary, $extra);
// send notify mails
notify($id, 'admin', $old, $summary, $minor);
notify($id, 'subscribers', $old, $summary, $minor);
// update the purgefile (timestamp of the last time anything within the wiki was changed)
io_saveFile($conf['cachedir'] . '/purgefile', time());
// if useheading is enabled, purge the cache of all linking pages
if (useHeading('content')) {
$pages = ft_backlinks($id);
foreach ($pages as $page) {
$cache = new cache_renderer($page, wikiFN($page), 'xhtml');
$cache->removeCache();
}
}
}
/**
* Saves a wikitext by calling io_writeWikiPage.
* Also directs changelog and attic updates.
*
* @author Andreas Gohr <*****@*****.**>
* @author Ben Coburn <*****@*****.**>
*/
function saveWikiText($id, $text, $summary, $minor = false)
{
/* Note to developers:
This code is subtle and delicate. Test the behavior of
the attic and changelog with dokuwiki and external edits
after any changes. External edits change the wiki page
directly without using php or dokuwiki.
*/
global $conf;
global $lang;
global $REV;
// ignore if no changes were made
if ($text == rawWiki($id, '')) {
return;
}
$file = wikiFN($id);
$old = @filemtime($file);
// from page
$wasRemoved = empty($text);
$wasCreated = !@file_exists($file);
$wasReverted = $REV == true;
$newRev = false;
$oldRev = getRevisions($id, -1, 1, 1024);
// from changelog
$oldRev = (int) (empty($oldRev) ? 0 : $oldRev[0]);
if (!@file_exists(wikiFN($id, $old)) && @file_exists($file) && $old >= $oldRev) {
// add old revision to the attic if missing
saveOldRevision($id);
// add a changelog entry if this edit came from outside dokuwiki
if ($old > $oldRev) {
addLogEntry($old, $id);
// send notify mails
notify($id, 'admin', $oldRev, '', false);
notify($id, 'subscribers', $oldRev, '', false);
// remove soon to be stale instructions
$cache = new cache_instructions($id, $file);
$cache->removeCache();
}
}
if ($wasRemoved) {
// pre-save deleted revision
@touch($file);
clearstatcache();
$newRev = saveOldRevision($id);
// remove empty file
@unlink($file);
// remove old meta info...
$mfiles = metaFiles($id);
$changelog = metaFN($id, '.changes');
foreach ($mfiles as $mfile) {
// but keep per-page changelog to preserve page history
if (@file_exists($mfile) && $mfile !== $changelog) {
@unlink($mfile);
}
}
$del = true;
// autoset summary on deletion
if (empty($summary)) {
$summary = $lang['deleted'];
}
// remove empty namespaces
io_sweepNS($id, 'datadir');
io_sweepNS($id, 'mediadir');
} else {
// save file (namespace dir is created in io_writeWikiPage)
io_writeWikiPage($file, $text, $id);
// pre-save the revision, to keep the attic in sync
$newRev = saveOldRevision($id);
$del = false;
}
// select changelog line type
$extra = '';
$type = 'E';
if ($wasReverted) {
$type = 'R';
$extra = $REV;
} else {
if ($wasCreated) {
$type = 'C';
} else {
if ($wasRemoved) {
$type = 'D';
} else {
if ($minor && $conf['useacl'] && $_SERVER['REMOTE_USER']) {
$type = 'e';
}
}
}
}
//minor edits only for logged in users
addLogEntry($newRev, $id, $type, $summary, $extra);
// send notify mails
notify($id, 'admin', $old, $summary, $minor);
notify($id, 'subscribers', $old, $summary, $minor);
// update the purgefile (timestamp of the last time anything within the wiki was changed)
io_saveFile($conf['cachedir'] . '/purgefile', time());
}
/**
* Checks if the current page version is newer than the last entry in the page's
* changelog. If so, we assume it has been an external edit and we create an
* attic copy and add a proper changelog line.
*
* This check is only executed when the page is about to be saved again from the
* wiki, triggered in @see saveWikiText()
*
* @param string $id the page ID
*/
function detectExternalEdit($id)
{
global $lang;
$fileLastMod = wikiFN($id);
$lastMod = @filemtime($fileLastMod);
// from page
$pagelog = new PageChangeLog($id, 1024);
$lastRev = $pagelog->getRevisions(-1, 1);
// from changelog
$lastRev = (int) (empty($lastRev) ? 0 : $lastRev[0]);
if (!file_exists(wikiFN($id, $lastMod)) && file_exists($fileLastMod) && $lastMod >= $lastRev) {
// add old revision to the attic if missing
saveOldRevision($id);
// add a changelog entry if this edit came from outside dokuwiki
if ($lastMod > $lastRev) {
$fileLastRev = wikiFN($id, $lastRev);
$revinfo = $pagelog->getRevisionInfo($lastRev);
if (empty($lastRev) || !file_exists($fileLastRev) || $revinfo['type'] == DOKU_CHANGE_TYPE_DELETE) {
$filesize_old = 0;
} else {
$filesize_old = io_getSizeFile($fileLastRev);
}
$filesize_new = filesize($fileLastMod);
$sizechange = $filesize_new - $filesize_old;
addLogEntry($lastMod, $id, DOKU_CHANGE_TYPE_EDIT, $lang['external_edit'], '', array('ExternalEdit' => true), $sizechange);
// remove soon to be stale instructions
$cache = new cache_instructions($id, $fileLastMod);
$cache->removeCache();
}
}
}
private function sync($id)
{
global $ID;
// save $ID
$save_ID = $ID;
$pages_path = DOKU_DATA . 'pages/' . implode('/', explode(':', $this->ID)) . '/';
$path = $pages_path . $id . '.txt';
$ID = $this->ID . ":" . $id;
// clear cache
$cache = new cache_renderer($ID, $path, 'metadata');
$cache->removeCache();
$cache = new cache_renderer($ID, $path, 'xhtml');
$cache->removeCache();
$cache = new cache_instructions($ID, $path);
$cache->removeCache();
p_cached_output($path, 'metadata', $ID);
// restore $ID
$ID = $save_ID;
}
