mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-10-31 21:33:00 +00:00
155 lines
8.1 KiB
Text
155 lines
8.1 KiB
Text
|
<?php
|
||
|
|
register_module([
|
||
|
|
"name" => "Help page",
|
||
|
|
"version" => "0.9.3",
|
||
|
|
"author" => "Starbeamrainbowlabs",
|
||
|
|
"description" => "Adds a rather useful help page. Access through the 'help' action. This module also exposes help content added to Pepperminty Wiki's inbuilt invisible help section system.",
|
||
|
|
"id" => "page-help",
|
||
|
|
"code" => function() {
|
||
|
|
global $settings;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @api {get} ?action=help[&dev=yes] Get a help page
|
||
|
|
* @apiDescription Get a customised help page. This page will be slightly different for every wiki, depending on their name, settings, and installed modules.
|
||
|
|
* @apiName Help
|
||
|
|
* @apiGroup Utility
|
||
|
|
* @apiPermission Anonymous
|
||
|
|
*
|
||
|
|
* @apiParam {string} dev Set to 'yes' to get a developer help page instead. The developer help page gives some general information about which modules and help page sections are registered, and other various (non-sensitive) settings.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*
|
||
|
|
* ██ ██ ███████ ██ ██████
|
||
|
|
* ██ ██ ██ ██ ██ ██
|
||
|
|
* ███████ █████ ██ ██████
|
||
|
|
* ██ ██ ██ ██ ██
|
||
|
|
* ██ ██ ███████ ███████ ██
|
||
|
|
*/
|
||
|
|
add_action("help", function() {
|
||
|
|
global $env, $paths, $settings, $version, $help_sections, $actions;
|
||
|
|
|
||
|
|
// Sort the help sections by key
|
||
|
|
ksort($help_sections, SORT_NATURAL);
|
||
|
|
|
||
|
|
if(isset($_GET["dev"]) and $_GET["dev"] == "yes")
|
||
|
|
{
|
||
|
|
$title = "Developers Help - $settings->sitename";
|
||
|
|
$content = "<p>$settings->sitename runs on Pepperminty Wiki, an entire wiki packed into a single file. This page contains some information that developers may find useful.</p>
|
||
|
|
<p>A full guide to developing a Pepperminty Wiki module can be found <a href='//github.com/sbrl/Pepperminty-Wiki/blob/master/Module_API_Docs.md#module-api-documentation'>on GitHub</a>.</p>
|
||
|
|
<h3>Registered Help Sections</h3>
|
||
|
|
<p>The following help sections are currently registered:</p>
|
||
|
|
<table><tr><th>Index</th><th>Title</th><th>Length</th></tr>\n";
|
||
|
|
$totalSize = 0;
|
||
|
|
foreach($help_sections as $index => $section)
|
||
|
|
{
|
||
|
|
$sectionLength = strlen($section["content"]);
|
||
|
|
$totalSize += $sectionLength;
|
||
|
|
|
||
|
|
$content .= "\t\t\t<tr><td>$index</td><td>" . $section["title"] . "</td><td>" . human_filesize($sectionLength) . "</td></tr>\n";
|
||
|
|
}
|
||
|
|
$content .= "\t\t\t<tr><th colspan='2' style='text-align: right;'>Total:</th><td>" . human_filesize($totalSize) . "</td></tr>\n";
|
||
|
|
$content .= "\t\t</table>\n";
|
||
|
|
$content .= "<h3>Registered Actions</h3>";
|
||
|
|
$registeredActions = array_keys(get_object_vars($actions));
|
||
|
|
sort($registeredActions);
|
||
|
|
$content .= "<p>The following actions are currently registered:</p>\n";
|
||
|
|
$content .= "<p>" . implode(", ", $registeredActions) . "</p>";
|
||
|
|
$content .= "<h3>Environment</h3>\n";
|
||
|
|
$content .= "<ul>\n";
|
||
|
|
$content .= "<li>$settings->sitename's root directory is " . (!is_writeable(__DIR__) ? "not " : "") . "writeable.</li>\n";
|
||
|
|
$content .= "<li>The page index is currently " . human_filesize(filesize($paths->pageindex)) . " in size, and took " . $env->perfdata->pageindex_decode_time . "ms to decode.</li>";
|
||
|
|
if(module_exists("feature-search"))
|
||
|
|
{
|
||
|
|
search::measure_invindex_load_time($paths->searchindex);
|
||
|
|
$content .= "<li>The search index is currently " . human_filesize(filesize($paths->searchindex)) . " in size, and took " . $env->perfdata->searchindex_decode_time . "ms to decode.</li>";
|
||
|
|
}
|
||
|
|
|
||
|
|
$content .= "<li>The id index is currently " . human_filesize(filesize($paths->idindex)) . " in size, and took " . $env->perfdata->idindex_decode_time . "ms to decode.</li>";
|
||
|
|
|
||
|
|
$content .= "</ul>\n";
|
||
|
|
|
||
|
|
$content .= "<h3>Data</h3>\n";
|
||
|
|
|
||
|
|
$wikiSize = new stdClass();
|
||
|
|
$wikiSize->all = 0;
|
||
|
|
$wikiSize->images = 0;
|
||
|
|
$wikiSize->audio = 0;
|
||
|
|
$wikiSize->videos = 0;
|
||
|
|
$wikiSize->pages = 0;
|
||
|
|
$wikiSize->history = 0;
|
||
|
|
$wikiSize->indexes = 0;
|
||
|
|
$wikiSize->other = 0;
|
||
|
|
$wikiFiles = glob_recursive($env->storage_prefix . "*");
|
||
|
|
foreach($wikiFiles as $filename)
|
||
|
|
{
|
||
|
|
$extension = strtolower(substr($filename, strrpos($filename, ".") + 1));
|
||
|
|
if($extension === "php") continue; // Skip php files
|
||
|
|
|
||
|
|
$nextFilesize = filesize($filename);
|
||
|
|
$wikiSize->all += $nextFilesize;
|
||
|
|
if($extension[0] === "r") // It's a revision of a page
|
||
|
|
$wikiSize->history += $nextFilesize;
|
||
|
|
else if($extension == "md") // It's a page
|
||
|
|
$wikiSize->pages += $nextFilesize;
|
||
|
|
else if($extension == "json") // It's an index
|
||
|
|
$wikiSize->indexes += $nextFilesize;
|
||
|
|
else if(in_array($extension, [ // It's an uploaded image
|
||
|
|
"jpg", "jpeg", "png", "gif", "webp", "svg"
|
||
|
|
]))
|
||
|
|
$wikiSize->images += $nextFilesize;
|
||
|
|
else if(in_array($extension, [ "mp3", "ogg", "wav", "aac", "m4a" ])) // It's an audio file
|
||
|
|
$wikiSize->audio += $nextFilesize;
|
||
|
|
else if(in_array($extension, [ "avi", "mp4", "m4v", "webm" ])) // It's a video file
|
||
|
|
$wikiSize->videos += $nextFilesize;
|
||
|
|
else
|
||
|
|
$wikiSize->other += $nextFilesize;
|
||
|
|
}
|
||
|
|
|
||
|
|
$content .= "<p>$settings->sitename is currently " . human_filesize($wikiSize->all) . " in size.</p>\n";
|
||
|
|
$content .= "<div class='stacked-bar'>
|
||
|
|
<div class='stacked-bar-part' style='flex: $wikiSize->indexes; background: hsla(191, 100%, 41%, 0.6)'>Indexes: " . human_filesize($wikiSize->indexes) . "</div>
|
||
|
|
<div class='stacked-bar-part' style='flex: $wikiSize->pages; background: hsla(112, 83%, 40%, 0.6)'>Pages: " . human_filesize($wikiSize->pages) . "</div>
|
||
|
|
<div class='stacked-bar-part' style='flex: $wikiSize->history; background: hsla(116, 84%, 25%, 0.68)'>Page History: " . human_filesize($wikiSize->history) . "</div>
|
||
|
|
<div class='stacked-bar-part' style='flex: $wikiSize->images; background: hsla(266, 88%, 47%, 0.6)'>Images: " . human_filesize($wikiSize->images) . "</div>\n";
|
||
|
|
if($wikiSize->audio > 0)
|
||
|
|
$content .= "<div class='stacked-bar-part' style='flex: $wikiSize->audio; background: hsla(237, 68%, 38%, 0.64)'>Audio: " . human_filesize($wikiSize->audio) . "</div>\n";
|
||
|
|
if($wikiSize->videos > 0)
|
||
|
|
$content .= "<div class='stacked-bar-part' style='flex: $wikiSize->videos; background: hsla(338, 79%, 54%, 0.64)'>Videos: " . human_filesize($wikiSize->videos) . "</div>\n";
|
||
|
|
if($wikiSize->other > 0)
|
||
|
|
$content .= "<div class='stacked-bar-part' style='flex: $wikiSize->other; background: hsla(62, 55%, 90%, 0.6)'>Other: " . human_filesize($wikiSize->other) . "</div>\n";
|
||
|
|
$content .= "</div>";
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
$title = "Help - $settings->sitename";
|
||
|
|
|
||
|
|
$content = " <h1>$settings->sitename Help</h1>
|
||
|
|
<p>Welcome to $settings->sitename!</p>
|
||
|
|
<p>$settings->sitename is powered by Pepperminty Wiki, a complete wiki in a box you can drop into your server and expect it to just <em>work</em>.</p>";
|
||
|
|
|
||
|
|
// Todo Insert a table of contents here?
|
||
|
|
|
||
|
|
foreach($help_sections as $index => $section)
|
||
|
|
{
|
||
|
|
// Todo add a button that you can click to get a permanent link
|
||
|
|
// to this section.
|
||
|
|
$content .= "<h2 id='$index' class='help-section-header'>" . $section["title"] . "</h2>\n";
|
||
|
|
$content .= $section["content"] . "\n";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
exit(page_renderer::render_main($title, $content));
|
||
|
|
});
|
||
|
|
|
||
|
|
// Register a help section on general navigation
|
||
|
|
add_help_section("5-navigation", "Navigating", "<p>All the navigation links can be found on the top bar, along with a search box (if your site administrator has enabled it). There is also a "More..." menu in the top right that contains some additional links that you may fine useful.</p>
|
||
|
|
<p>This page, along with the credits page, can be found on the bar at the bottom of every page.</p>");
|
||
|
|
|
||
|
|
add_help_section("1-extra", "Extra Information", "<p>You can find out whch version of Pepperminty Wiki $settings->sitename is using by visiting the <a href='?action=credits'>credits</a> page.</p>
|
||
|
|
<p>Information for developers can be found on <a href='?action=help&dev=yes'>this page</a>.</p>");
|
||
|
|
}
|
||
|
|
]);
|
||
|
|
|
||
|
|
?>
|
||
|
|
|