(None yet! Try editing this page and then coming back here.)
\n"; } exit(page_renderer::render_main("$env->page - History - $settings->sitename", $content)); case "json": $page_history = $pageindex->{$env->page}->history ?? []; foreach($page_history as &$history_entry) { unset($history_entry->filename); } header("content-type: application/json"); exit(json_encode($page_history, JSON_PRETTY_PRINT)); case "csv": $page_history = $pageindex->{$env->page}->history ?? []; header("content-type: text/csv"); echo("revision_id,timestamp,type,editor,newsize,sizediff\n"); foreach($page_history as $hentry) { echo("$hentry->rid,$hentry->timestamp,$hentry->type,$hentry->editor,$hentry->newsize,$hentry->sizediff\n"); } exit(); default: http_response_code(400); exit(page_renderer::render_main("Format Error - $env->page - History - $settings->sitename", "The format " . htmlentities($format) . " isn't currently supported. Supported formats: html, json, csv"));
}
});
/**
* @api {get} ?action=history-revert&page={pageName}&revision={rid} Revert a page to a previous version
* @apiName HistoryRevert
* @apiGroup Editing
* @apiPermission User
* @apiUse PageParameter
* @apiUse UserNotLoggedInError
* @apiUse UserNotModeratorError
*
* @apiParam {string} revision The page revision number to revert to.
*/
/*
* ██ ██ ██ ███████ ████████ ██████ ██████ ██ ██
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
* ███████ ██ ███████ ██ ██ ██ ██████ ████ █████
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
* ██ ██ ██ ███████ ██ ██████ ██ ██ ██
*
* ██████ ███████ ██ ██ ███████ ██████ ████████
* ██ ██ ██ ██ ██ ██ ██ ██ ██
* ██████ █████ ██ ██ █████ ██████ ██
* ██ ██ ██ ██ ██ ██ ██ ██ ██
* ██ ██ ███████ ████ ███████ ██ ██ ██
*/
add_action("history-revert", function() {
global $env, $settings, $pageindex;
if((!$env->is_admin && $settings->history_revert_require_moderator) ||
!$env->is_logged_in) {
http_response_code(401);
exit(page_renderer::render_main("Unauthorised - $settings->sitename", "
You can't revert pages to a previous revision because " . ($settings->history_revert_require_moderator && $env->is_logged_in ? "you aren't logged in as a moderator. You can try logging out and then" : "you aren't logged in. You can try") . " logging in.
")); } $current_revision_filepath = "$env->storage_prefix/{$pageindex->{$env->page}->filename}"; // Figure out what we're saving $newsource = file_get_contents($env->page_filename); // The old revision content - the Pepperminty Wiki core sorts this out for us $oldsource = file_get_contents($current_revision_filepath); // The current revision's content // Save the old content over the current content file_put_contents($current_revision_filepath, $newsource); // NOTE: We don't run the save preprocessors here because they are run when a page is edited - reversion is special and requires different treatment. // FUTURE: We may want ot refactor the save preprocessor system ot take a single object instead - then we can add as many params as we like and we could execute the save preprocessors as normal :P // Add the old content as a new revision $result = history_add_revision( $pageindex->{$env->page}, $newsource, $oldsource, true, // Yep, go ahead and save the page index "revert" // It's a revert, not an edit ); // Update the redirect metadata, if the redirect module is installed if(module_exists("feature-redirect")) update_redirect_metadata($pageindex->{$env->page}, $newsource); // Add an entry to the recent changes log, if the module exists if($result !== false && module_exists("feature-recent-changes")) add_recent_change([ "type" => "revert", "timestamp" => time(), "page" => $env->page, "user" => $env->user, "newsize" => strlen($newsource), "sizediff" => strlen($newsource) - strlen($oldsource) ]); if($result === false) { http_response_code(503); exit(page_renderer::render_main("Server Error - Revert - $settings->sitename", "A server error occurred when $settings->sitename tried to save the reversion of " . htmlentities($env->page) . ". Please contact $settings->sitename's administrator $settings->admindetails_name, whose email address can be found at the bottom of every page (including this one).
" . htmlentities($env->page) . " has been reverted back to revision {$env->history->revision_number} successfully.
Go back to the page, or continue reviewing its history.
")); // $env->page_filename // }); register_save_preprocessor("history_add_revision"); if(module_exists("feature-stats")) { statistic_add([ "id" => "history_most_revisions", "name" => "Most revised page", "type" => "scalar", "update" => function($old_stats) { global $pageindex; $target_pagename = ""; $target_revisions = -1; foreach($pageindex as $pagename => $pagedata) { if(!isset($pagedata->history)) continue; $revisions_count = count($pagedata->history); if($revisions_count > $target_revisions) { $target_revisions = $revisions_count; $target_pagename = $pagename; } } $result = new stdClass(); // completed, value, state $result->completed = true; $result->value = "(no revisions saved yet)"; if($target_revisions > -1) { $result->value = "$target_revisions (" . htmlentities($target_pagename) . ")"; } return $result; } ]); } } ]); /** * Adds a history revision against a page. * Note: Does not updaate the current page content! This function _only_ * records a new revision against a page name. Thus it is possible to have a * disparaty between the history revisions and the actual content displayed in * the current revision if you're not careful! * @param object $pageinfo The pageindex object of the page to operate on. * @param string $newsource The page content to save as the new revision. * @param string $oldsource The old page content that is the current revision (before the update). * @param boolean $save_pageindex Whether the page index should be saved to disk. * @param string $change_type The type of change to record this as in the history revision log */ function history_add_revision(&$pageinfo, &$newsource, &$oldsource, $save_pageindex = true, $change_type = "edit") { global $env, $paths, $settings, $pageindex; if(!isset($pageinfo->history)) $pageinfo->history = []; // Save the *new source* as a revision // This results in 2 copies of the current source, but this is ok // since any time someone changes something, it creates a new revision // Note that we can't save the old source here because we'd have no // clue who edited it since $pageinfo has already been updated by // this point // TODO Store tag changes here end($pageinfo->history); // Calculate the next revision id - we can't just count the reivisions here because we might have a revision limit $nextRid = !empty($pageindex->history) ? $pageinfo->history[key($pageinfo->history)]->rid + 1 : 0; $ridFilename = "$pageinfo->filename.r$nextRid"; // Insert a new entry into the history $pageinfo->history[] = [ "type" => $change_type, // We might want to store other types later (e.g. page moves) "rid" => $nextRid, "timestamp" => time(), "filename" => $ridFilename, "newsize" => strlen($newsource), "sizediff" => strlen($newsource) - strlen($oldsource), "editor" => $pageinfo->lasteditor ]; // Save the new source as a revision $result = file_put_contents("$env->storage_prefix$ridFilename", $newsource); if($result !== false && $settings->history_max_revisions > -1) { while(count($pageinfo->history) > $settings->history_max_revisions) { // We've got too many revisions - trim one off & delete it $oldest_revision = array_shift($pageinfo->history); unlink("$env->storage_prefix/$oldest_revision->filename"); } } // Save the edited pageindex if($result !== false && $save_pageindex) $result = file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT)); return $result; } ?>