2016-06-03 07:45:17 +00:00
< ? php
register_module ([
" name " => " Page History " ,
2016-06-04 19:16:30 +00:00
" version " => " 0.3 " ,
2016-06-03 07:45:17 +00:00
" author " => " Starbeamrainbowlabs " ,
2016-06-03 08:16:16 +00:00
" description " => " Adds the ability to keep unlimited page history, limited only by your disk space. Note that this doesn't store file history (yet). Currently depends on feature-recent-changes for rendering of the history page. " ,
2016-06-03 07:45:17 +00:00
" id " => " feature-history " ,
" code " => function () {
2016-06-12 20:15:43 +00:00
/**
* @ api { get } ? action = history & page = { pageName } Get a list of revisions for a page
* @ apiName History
* @ apiGroup Page
* @ apiPermission Anonymous
*
* @ apiParam { string } page The page name to return a revision list for .
*/
2016-06-03 07:45:17 +00:00
/*
* ██ ██ ██ ███████ ████████ ██████ ██████ ██ ██
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
* ███████ ██ ███████ ██ ██ ██ ██████ ████
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
* ██ ██ ██ ███████ ██ ██████ ██ ██ ██
*/
add_action ( " history " , function () {
2016-06-03 08:16:16 +00:00
global $settings , $env , $pageindex ;
2016-06-03 07:45:17 +00:00
2016-06-03 08:16:16 +00:00
$content = " <h1>History for $env->page </h1> \n " ;
if ( ! empty ( $pageindex -> { $env -> page } -> history ))
{
$content .= " \t \t <ul class='page-list'> \n " ;
2016-06-08 17:06:16 +00:00
foreach ( array_reverse ( $pageindex -> { $env -> page } -> history ) as $revisionData )
2016-06-03 08:16:16 +00:00
{
// Only display edits for now
if ( $revisionData -> type != " edit " )
continue ;
// The number (and the sign) of the size difference to display
$size_display = ( $revisionData -> sizediff > 0 ? " + " : " " ) . $revisionData -> sizediff ;
$size_display_class = $revisionData -> sizediff > 0 ? " larger " : ( $revisionData -> sizediff < 0 ? " smaller " : " nochange " );
if ( $revisionData -> sizediff > 500 or $revisionData -> sizediff < - 500 )
$size_display_class .= " significant " ;
$size_title_display = human_filesize ( $revisionData -> newsize - $revisionData -> sizediff ) . " -> " . human_filesize ( $revisionData -> newsize );
2017-06-18 13:18:14 +00:00
$content .= " <li><a href='?page= " . rawurlencode ( $env -> page ) . " &revision= $revisionData->rid '># $revisionData->rid </a> " . render_editor ( page_renderer :: render_username ( $revisionData -> editor )) . " " . render_timestamp ( $revisionData -> timestamp ) . " <span class='cursor-query $size_display_class ' title=' $size_title_display '>( $size_display )</span> " ;
2016-06-03 08:16:16 +00:00
}
}
else
{
$content .= " <p style='text-align: center;'><em>(None yet! Try editing this page and then coming back here.)</em></p> \n " ;
}
exit ( page_renderer :: render_main ( " $env->page - History - $settings->sitename " , $content ));
2016-06-03 07:45:17 +00:00
});
2016-06-04 12:52:45 +00:00
register_save_preprocessor ( " history_add_revision " );
2016-06-03 07:45:17 +00:00
}
]);
2016-06-04 12:52:45 +00:00
function history_add_revision ( & $pageinfo , & $newsource , & $oldsource , $save_pageindex = true ) {
global $pageindex , $paths , $env ;
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 create 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
$nextRid = count ( $pageinfo -> history ); // The next revision id
$ridFilename = " $pageinfo->filename .r $nextRid " ;
// Insert a new entry into the history
$pageinfo -> history [] = [
" type " => " edit " , // 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
file_put_contents ( " $env->storage_prefix $ridFilename " , $newsource );
// Save the edited pageindex
if ( $save_pageindex )
file_put_contents ( $paths -> pageindex , json_encode ( $pageindex , JSON_PRETTY_PRINT ));
}
2016-06-03 07:45:17 +00:00
?>