{sitename}
$settings->sitename has got a misbehaving module installed that tried to register an invalid HTML handler with the page renderer. Please contact $settings->sitename's administrator $admin_name at $admin_email."));
}
self::$part_processors[] = $function;
return true;
}
/**
* Renders a HTML page with the content specified.
* @package core
* @param string $title The title of the page.
* @param string $content The (HTML) content of the page.
* @param boolean $body_template The HTML content template to use.
* @return string The rendered HTML, ready to send to the client :-)
*/
public static function render($title, $content, $body_template = false)
{
global $settings, $start_time, $version;
if($body_template === false)
$body_template = self::$main_content_template;
if(strlen($settings->logo_url) > 0) {
// A logo url has been specified
$logo_html = "";
switch($settings->logo_position) {
case "left":
$logo_html = "$logo_html $settings->sitename";
break;
case "right":
$logo_html .= " $settings->sitename";
break;
default:
throw new Exception("Invalid logo_position '$settings->logo_position'. Valid values are either \"left\" or \"right\" and are case sensitive.");
}
}
// Push the logo via HTTP/2.0 if possible
if($settings->favicon[0] === "/") self::$http2_push_items[] = ["image", $settings->favicon];
$parts = [
"{body}" => $body_template,
"{sitename}" => $logo_html,
"v0.18-dev" => $version,
"{favicon-url}" => $settings->favicon,
"{header-html}" => self::get_header_html(),
"{navigation-bar}" => self::render_navigation_bar($settings->nav_links, $settings->nav_links_extra, "top"),
"{navigation-bar-bottom}" => self::render_navigation_bar($settings->nav_links_bottom, [], "bottom"),
"{admin-details-name}" => $settings->admindetails_name,
"{admin-details-email}" => $settings->admindetails_email,
"{admins-name-list}" => implode(", ", array_map(function($username) { return page_renderer::render_username($username); }, $settings->admins)),
"{generation-date}" => date("l jS \of F Y \a\\t h:ia T"),
"{all-pages-datalist}" => self::generate_all_pages_datalist(),
"{footer-message}" => $settings->footer_message,
/// Secondary Parts ///
"{content}" => $content,
"{extra}" => "",
"{title}" => $title,
];
// Pass the parts through the part processors
foreach(self::$part_processors as $function) {
$function($parts);
}
$result = self::$html_template;
$result = str_replace(array_keys($parts), array_values($parts), $result);
$result = str_replace("{generation-time-taken}", round((microtime(true) - $start_time)*1000, 2), $result);
// Send the HTTP/2.0 server push indicators if possible - but not if we're sending a redirect page
if(!headers_sent() && (http_response_code() < 300 || http_response_code() >= 400)) self::send_server_push_indicators();
return $result;
}
/**
* Renders a normal HTML page.
* @package core
* @param string $title The title of the page.
* @param string $content The content of the page.
* @return string The rendered page.
*/
public static function render_main($title, $content) {
return self::render($title, $content, self::$main_content_template);
}
/**
* Renders a minimal HTML page. Useful for printable pages.
* @package core
* @param string $title The title of the page.
* @param string $content The content of the page.
* @return string The rendered page.
*/
public static function render_minimal($title, $content) {
return self::render($title, $content, self::$minimal_content_template);
}
/**
* Sends the currently registered HTTP2 server push items to the client.
* @return integer|FALSE The number of resource hints included in the link: header, or false if server pushing is disabled.
*/
public static function send_server_push_indicators() {
global $settings;
if(!$settings->http2_server_push)
return false;
// Render the preload directives
$link_header_parts = [];
foreach(self::$http2_push_items as $push_item)
$link_header_parts[] = "<{$push_item[1]}>; rel=preload; as={$push_item[0]}";
// Send them in a link: header
if(!empty($link_header_parts))
header("link: " . implode(", ", $link_header_parts));
return count(self::$http2_push_items);
}
/**
* Renders the header HTML.
* @package core
* @return string The rendered HTML that goes in the header.
*/
public static function get_header_html()
{
global $settings;
$result = self::$extraHeaderHTML;
$result .= self::get_css_as_html();
$result .= self::_get_js();
// We can't use module_exists here because sometimes global $modules
// hasn't populated yet when we get called O.o
if(class_exists("search"))
$result .= "\t\t\n";
if(!empty($settings->enable_math_rendering)) {
$result .= "";
}
return $result;
}
/**
* Figures out whether $settings->css is a url, or a string of css.
* A url is something starting with "protocol://" or simply a "/".
* @return boolean True if it's a url - false if we assume it's a string of css.
*/
public static function is_css_url() {
global $settings;
return preg_match("/^[^\/]*\/\/|^\//", $settings->css);
}
/**
* Renders all the CSS as HTML.
* @package core
* @return string The css as HTML, ready to be included in the HTML header.
*/
public static function get_css_as_html()
{
global $settings, $defaultCSS;
if(self::is_css_url()) {
if($settings->css[0] === "/") // Push it if it's a relative resource
self::add_server_push_indicator("style", $settings->css);
return "\n";
} else {
$css = $settings->css == "auto" ? $defaultCSS : $settings->css;
if(!empty($settings->optimize_pages)) {
// CSS Minification ideas by Jean from catswhocode.com
// Link: http://www.catswhocode.com/blog/3-ways-to-compress-css-files-using-php
// Remove comments
$css = preg_replace('!/\*[^*]*\*+([^/][^*]*\*+)*/!', "", $css);
// Cut down whitespace
$css = preg_replace('/\s+/', " ", $css);
// Remove whitespace after colons and semicolons
$css = str_replace([
" :",
": ",
"; ",
" { ",
" } "
], [
":",
":",
";",
"{",
"}"
], $css);
}
return "\n";
}
}
/**
* Adds the specified url to a javascript file as a reference to the page.
* @package core
* @param string $scriptUrl The url of the javascript file to reference.
*/
public function add_js_link(string $scriptUrl) {
static::$jsLinks[] = $scriptUrl;
}
/**
* Adds a javascript snippet to the page.
* @package core
* @param string $script The snippet of javascript to add.
*/
public function add_js_snippet(string $script) {
static::$jsSnippets[] = $script;
}
/**
* Renders the included javascript header for inclusion in the final
* rendered page.
* @package core
* @return string The rendered javascript ready for inclusion in the page.
*/
private static function _get_js() {
$result = "\n";
foreach(static::$jsSnippets as $snippet)
$result .= "\n";
foreach(static::$jsLinks as $link) {
// Push it via HTTP/2.0 if it's relative
if($link[0] === "/") self::add_server_push_indicator("script", $link);
$result .= "\n";
}
return $result;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Adds a string of HTML to the header of the rendered page.
* @param string $html The string of HTML to add.
*/
public static function add_header_html($html) {
self::$extraHeaderHTML .= $html;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Adds a resource to the list of items to indicate that the web server should send via HTTP/2.0 Server Push.
* Note: Only specify static files here, as you might end up with strange (and possibly dangerous) results!
* @param string $type The resource type. See https://fetch.spec.whatwg.org/#concept-request-destination for more information.
* @param string $path The *relative url path* to the resource.
*/
public static function add_server_push_indicator($type, $path) {
self::$http2_push_items[] = [ $type, $path ];
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Renders a navigation bar from an array of links. See
* $settings->nav_links for format information.
* @package core
* @param array $nav_links The links to add to the navigation bar.
* @param array $nav_links_extra The extra nav links to add to
* the "More..." menu.
* @param string $class The class(es) to assign to the rendered
* navigation bar.
*/
public static function render_navigation_bar($nav_links, $nav_links_extra, $class = "") {
global $settings, $env;
$result = "";
return $result;
}
/**
* Renders a username for inclusion in a page.
* @package core
* @param string $name The username to render.
* @return string The username rendered in HTML.
*/
public static function render_username($name) {
global $settings;
$result = "";
$result .= "";
if($settings->avatars_show)
$result .= "
";
if(in_array($name, $settings->admins))
$result .= $settings->admindisplaychar;
$result .= htmlentities($name);
$result .= "";
return $result;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Renders the datalist for the search box as HTML.
* @package core
* @return string The search box datalist as HTML.
*/
public static function generate_all_pages_datalist() {
global $settings, $pageindex;
$arrayPageIndex = get_object_vars($pageindex);
ksort($arrayPageIndex);
$result = "";
return $result;
}
}
// HTTP/2.0 Server Push static items
foreach($settings->http2_server_push_items as $push_item) {
page_renderer::add_server_push_indicator($push_item[0], $push_item[1]);
}
// Math rendering support
if(!empty($settings->enable_math_rendering))
{
page_renderer::add_js_link("https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML");
}
// alt+enter support in the search box
page_renderer::add_js_snippet('// Alt + Enter support in the top search box
window.addEventListener("load", function(event) {
document.querySelector("input[type=search]").addEventListener("keyup", function(event) {
// Listen for Alt + Enter
if(event.keyCode == 13 && event.altKey) {
event.stopPropagation();
event.preventDefault();
event.cancelBubble = true;
event.target.form.setAttribute("target", "_blank");
event.target.form.submit();
event.target.form.removeAttribute("target");
return false; // Required by some browsers
}
});
});
');
/// Finish setting up the environment object ///
$env->page = $_GET["page"];
if(isset($_GET["revision"]) and is_numeric($_GET["revision"]))
{
// We have a revision number!
$env->is_history_revision = true;
$env->history->revision_number = intval($_GET["revision"]);
// Make sure that the revision exists for later on
if(!isset($pageindex->{$env->page}->history[$env->history->revision_number]))
{
http_response_code(404);
exit(page_renderer::render_main("404: Revision Not Found - $env->page - $settings->sitename", "
Revision #{$env->history->revision_number} of $env->page doesn't appear to exist. Try viewing the list of revisions for $env->page, or viewing the latest revision instead.
")); } $env->history->revision_data = $pageindex->{$env->page}->history[$env->history->revision_number]; } // Construct the page's filename $env->page_filename = $env->storage_prefix; if($env->is_history_revision) $env->page_filename .= $pageindex->{$env->page}->history[$env->history->revision_number]->filename; else if(isset($pageindex->{$env->page})) $env->page_filename .= $pageindex->{$env->page}->filename; $env->action = strtolower($_GET["action"]); //////////////////////////////////////////////// ////////////////////////////////////// ///// Extra consistency measures ///// ////////////////////////////////////// // CHANGED: The search redirector has now been moved to below the module registration system, as it was causing a warning here // Redirect the user to the login page if: // - A login is required to view this wiki // - The user isn't already requesting the login page // Note we use $_GET here because $env->action isn't populated at this point if($settings->require_login_view === true && // If this site requires a login in order to view pages !$env->is_logged_in && // And the user isn't logged in !in_array($_GET["action"], [ "login", "checklogin", "opensearch-description", "invindex-rebuild", "stats-update" ])) // And the user isn't trying to login, or get the opensearch description, or access actions that apply their own access rules { // Redirect the user to the login page http_response_code(307); header("x-login-required: yes"); $url = "?action=login&returnto=" . rawurlencode($_SERVER["REQUEST_URI"]) . "&required=true"; header("location: $url"); exit(page_renderer::render("Login required - $settings->sitename", "$settings->sitename requires that you login before you are able to access it.
")); } ////////////////////////////////////// ////////////////////////////////////// $remote_files = []; /** * Registers a request for a remote file to be downloaded before execution. Will block until all files are downloaded. * Example definition: * [ "local_filename" => "file.ext", "remote_url": "https://example.com" ] * @param array $remote_file_def The remote file definition to register. * @throws Exception Exception Throws an exception if a definition for the requested local file already exists. */ function register_remote_file($remote_file_def) { global $remote_files; foreach($remote_files as $ex_remote_file_def) { if($ex_remote_file_def["local_filename"] == $remote_file_def["local_filename"]) throw new Exception("Error: A remote file with the local filename '{$remote_file_def["local_filename"]}' is already registered."); } $remote_files[] = $remote_file_def; } ////////////////////////// /// Module functions /// ////////////////////////// // These functions are // // used by modules to // // register themselves // // or new pages. // ////////////////////////// /** A list of all the currently loaded modules. Not guaranteed to be populated until an action is executed. */ $modules = []; /** * Registers a module. * @package core * @param array $moduledata The module data to register. */ function register_module($moduledata) { global $modules; //echo("registering module\n"); //var_dump($moduledata); $modules[] = $moduledata; } /** * Checks to see whether a module with the given id exists. * @package core * @param string $id The id to search for. * @return bool Whether a module is currently loaded with the given id. */ function module_exists($id) { global $modules; foreach($modules as $module) { if($module["id"] == $id) return true; } return false; } $actions = new stdClass(); /** * Registers a new action handler. * @package core * @param string $action_name The action to register. * @param function $func The function to call when the specified * action is requested. */ function add_action($action_name, $func) { global $actions; $actions->$action_name = $func; } /** * Figures out whether a given action is currently registered. * Only guaranteed to be accurate in inside an existing action function * @package core * @param string $action_name The name of the action to search for * @return boolean Whether an action with the specified name exists. */ function has_action($action_name) { global $actions; return !empty($actions->$action_name); } $parsers = [ "none" => [ "parser" => function() { throw new Exception("No parser registered!"); }, "hash_generator" => function() { throw new Exception("No parser registered!"); } ] ]; /** * Registers a new parser. * @package core * @param string $name The name of the new parser to register. * @param function $parser_code The function to register as a new parser. */ function add_parser($name, $parser_code, $hash_generator) { global $parsers; if(isset($parsers[$name])) throw new Exception("Can't register parser with name '$name' because a parser with that name already exists."); $parsers[$name] = [ "parser" => $parser_code, "hash_generator" => $hash_generator ]; } /** * Parses the specified page source using the parser specified in the settings * into HTML. * The specified parser may (though it's unlikely) render it to other things. * @package core * @param string $source The source to render. * @param string $use_cache Whether to use the on-disk cache. Has no effect if parser caching is disabled in peppermint.json, or the source string is too small. * @return string The source rendered to HTML. */ function parse_page_source($source, $use_cache = true) { global $settings, $paths, $parsers, $version; $start_time = microtime(true); if(!$settings->parser_cache || strlen($source) < $settings->parser_cache_min_size) $use_cache = false; if(!isset($parsers[$settings->parser])) exit(page_renderer::render_main("Parsing error - $settings->sitename", "Parsing some page source data failed. This is most likely because $settings->sitename has the parser setting set incorrectly. Please contact " . $settings->admindetails_name . ", your $settings->sitename Administrator.")); /* Not needed atm because escaping happens when saving, not when rendering * if($settings->clean_raw_html) $source = htmlentities($source, ENT_QUOTES | ENT_HTML5); */ $cache_id = $parsers[$settings->parser]["hash_generator"]($source); $cache_file = "{$paths->cache_directory}/{$cache_id}.html"; $result = null; if($use_cache && file_exists($cache_file)) { $result = file_get_contents($cache_file); $result .= "\n\n"; } if($result == null) { $result = $parsers[$settings->parser]["parser"]($source); // If we should use the cache and we failed to write to it, warn the admin. // It's not terribible if we can't write to the cache directory (so we shouldn't stop dead & refuse service), but it's still of concern. if($use_cache && !file_put_contents($cache_file, $result)) error_log("[Pepperminty Wiki] Warning: Failed to write to cache file $cache_file."); $result .= "\n\n"; } return $result; } // Function to $save_preprocessors = []; /** * Register a new proprocessor that will be executed just before * an edit is saved. * @package core * @param function $func The function to register. */ function register_save_preprocessor($func) { global $save_preprocessors; $save_preprocessors[] = $func; } $help_sections = []; /** * Adds a new help section to the help page. * @package core * @param string $index The string to index the new section under. * @param string $title The title to display above the section. * @param string $content The content to display. */ function add_help_section($index, $title, $content) { global $help_sections; $help_sections[$index] = [ "title" => $title, "content" => $content ]; } if(!empty($settings->enable_math_rendering)) add_help_section("22-mathematical-mxpressions", "Mathematical Expressions", "
$settings->sitename supports rendering of mathematical expressions. Mathematical expressions can be included practically anywhere in your page. Expressions should be written in LaTeX and enclosed in dollar signs like this: $x^2$.
Note that expression parsing is done on the viewer's computer with javascript (specifically MathJax) and not by $settings->sitename directly (also called client side rendering).
"); /** An array of the currently registerd statistic calculators. Not guaranteed to be populated until the requested action function is called. */ $statistic_calculators = []; /** * Registers a statistic calculator against the system. * @package core * @param array $stat_data The statistic object to register. */ function statistic_add($stat_data) { global $statistic_calculators; $statistic_calculators[$stat_data["id"]] = $stat_data; } /** * Checks whether a specified statistic has been registered. * @package core * @param string $stat_id The id of the statistic to check the existence of. * @return boolean Whether the specified statistic has been registered. */ function has_statistic($stat_id) { global $statistic_calculators; return !empty($statistic_calculators[$stat_id]); } ////////////////////////////////////////////////////////////////// register_module([ "name" => "Password hashing action", "version" => "0.7", "author" => "Starbeamrainbowlabs", "description" => "Adds a utility action (that anyone can use) called hash that hashes a given string. Useful when changing a user's password.", "id" => "action-hash", "code" => function() { /** * @api {get} ?action=hash&string={text} Hash a password * @apiName Hash * @apiGroup Utility * @apiPermission Anonymous * * @apiParam {string} string The string to hash. * @apiParam {boolean} raw Whether to return the hashed password as a raw string instead of as part of an HTML page. * * @apiError ParamNotFound The string parameter was not specified. */ /* * ██ ██ █████ ███████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ * ███████ ███████ ███████ ███████ * ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ██ ███████ ██ ██ */ add_action("hash", function() { global $settings; if(!isset($_GET["string"])) { http_response_code(422); exit(page_renderer::render_main("Missing parameter", "The GET parameter string must be specified.
It is strongly recommended that you utilise this page via a private or incognito window in order to prevent your password from appearing in your browser history.
")); } else if(!empty($_GET["raw"])) { header("content-type: text/plain"); exit(hash_password($_GET["string"])); } else { exit(page_renderer::render_main("Hashed string", "Algorithm: $settings->password_algorithm
" . $_GET["string"] . " → " . hash_password($_GET["string"]) . "
Page protection for $env->page has been $state.
Go back.")); } else { exit(page_renderer::render_main("Error protecting page", "
You are not allowed to protect pages because you are not logged in as a mod or admin. Please try logging out if you are logged in and then try logging in as an administrator.
")); } }); } ]); register_module([ "name" => "Random Page", "version" => "0.3", "author" => "Starbeamrainbowlabs", "description" => "Adds an action called 'random' that redirects you to a random page.", "id" => "action-random", "code" => function() { global $settings; /** * @api {get} ?action=random[&mode={modeName}] Redirects to a random page * @apiName Random * @apiGroup Page * @apiPermission Anonymous * * @apiParam {string} mode The view mode to redirect to. This parameter is basically just passed through to the direct. It works in the same way as the mode parameter on the view action does. */ add_action("random", function() { global $pageindex; $mode = preg_replace("/[^a-z-_]/i", "", $_GET["mode"] ?? ""); $pageNames = array_keys(get_object_vars($pageindex)); // Filter out pages we shouldn't send the user to $pageNames = array_values(array_filter($pageNames, function($pagename) { global $settings, $pageindex; if($settings->random_page_exclude_redirects && isset($pageindex->$pagename->redirect) && $pageindex->$pagename->redirect === true) return false; return preg_match($settings->random_page_exclude, $pagename) === 0 ? true : false; })); $randomPageName = $pageNames[array_rand($pageNames)]; http_response_code(307); $redirect_url = "?page=" . rawurlencode($randomPageName); if(!empty($mode)) $redirect_url .= "&mode=$mode"; header("location: $redirect_url"); }); add_help_section("26-random-redirect", "Jumping to a random page", "$settings->sitename has a function that can send you to a random page. To use it, click here. $settings->admindetails_name ($settings->sitename's adminstrator) may have added it to one of the menus.
"); } ]); register_module([ "name" => "Raw page source", "version" => "0.7", "author" => "Starbeamrainbowlabs", "description" => "Adds a 'raw' action that shows you the raw source of a page.", "id" => "action-raw", "code" => function() { global $settings; /** * @api {get} ?action=raw&page={pageName} Get the raw source code of a page * @apiName RawSource * @apiGroup Page * @apiPermission Anonymous * * @apiParam {string} page The page to return the source of. */ /* * ██████ █████ ██ ██ * ██ ██ ██ ██ ██ ██ * ██████ ███████ ██ █ ██ * ██ ██ ██ ██ ██ ███ ██ * ██ ██ ██ ██ ███ ███ */ add_action("raw", function() { global $pageindex, $env; if(empty($pageindex->{$env->page})) { http_response_code(404); exit("Error: The page with the name $env->page could not be found.\n"); } header("content-type: text/markdown"); header("content-length: " . filesize($env->page_filename)); exit(file_get_contents($env->page_filename)); }); add_help_section("800-raw-page-content", "Viewing Raw Page Content", "Although you can use the edit page to view a page's source, you can also ask $settings->sitename to send you the raw page source and nothing else. This feature is intented for those who want to automate their interaction with $settings->sitename.
To use this feature, navigate to the page for which you want to see the source, and then alter the action parameter in the url's query string to be raw. If the action parameter doesn't exist, add it. Note that when used on an file's page this action will return the source of the description and not the file itself.
$settings->sitename has a status page that returns some basic information about the current state of the wiki in JSON. It can be used as a connection tester - as the Pepperminty Wiki Android app does.
"); } ]); register_module([ "name" => "Sidebar", "version" => "0.3.1", "author" => "Starbeamrainbowlabs", "description" => "Adds a sidebar to the left hand side of every page. Add '\$settings->sidebar_show = true;' to your configuration, or append '&sidebar=yes' to the url to enable. Adding to the url sets a cookie to remember your setting.", "id" => "extra-sidebar", "code" => function() { global $settings; $show_sidebar = false; // Show the sidebar if it is enabled in the settings if(isset($settings->sidebar_show) && $settings->sidebar_show === true) $show_sidebar = true; // Also show and persist the sidebar if the special GET parameter // sidebar is seet if(!$show_sidebar && isset($_GET["sidebar"])) { $show_sidebar = true; // Set a cookie to persist the display of the sidebar setcookie("sidebar_show", "true", time() + (60 * 60 * 24 * 30)); } // Show the sidebar if the cookie is set if(!$show_sidebar && isset($_COOKIE["sidebar_show"])) $show_sidebar = true; // Delete the cookie and hide the sidebar if the special GET paramter // nosidebar is set if(isset($_GET["nosidebar"])) { $show_sidebar = false; unset($_COOKIE["sidebar_show"]); setcookie("sidebar_show", null, time() - 3600); } page_renderer::register_part_preprocessor(function(&$parts) use ($show_sidebar) { global $settings, $pageindex, $env; // Don't render a sidebar if the user is logging in and a login is // required in order to view pages. if($settings->require_login_view && in_array($env->action, [ "login", "checklogin" ])) return false; if($show_sidebar && !isset($_GET["printable"])) { // Show the sidebar $exec_start = microtime(true); // Sort the pageindex $sorted_pageindex = get_object_vars($pageindex); ksort($sorted_pageindex, SORT_NATURAL); $sidebar_contents = ""; $sidebar_contents .= render_sidebar($sorted_pageindex); $parts["{body}"] = "$settings->sitename has an optional sidebar which displays a list of all the current pages (but not subpages) that it is currently hosting. It may or may not be enabled.
If it isn't enabled, it can be enabled for your current browser only by appending sidebar=yes to the current page's query string.
Your comment couldn't be posted because you're not logged in. You can login here. Here's the comment you tried to post:
")); } $message_length = strlen($message); if($message_length < $settings->comment_min_length) { http_response_code(422); exit(page_renderer::render_main("Error posting comment - $settings->sitename", "Your comment couldn't be posted because it was too short. $settings->sitename needs at $settings->comment_min_length characters in a comment in order to post it.
")); } if($message_length > $settings->comment_max_length) { http_response_code(422); exit(page_renderer::renderer_main("Error posting comment - $settings->sitename", "Your comment couldn't be posted because it was too long. $settings->sitenamae can only post comments that are up to $settings->comment_max_length characters in length, and yours was $message_length characters. Try splitting it up into multiple comments! Here's the comment you tried to post:
")); } // Figure out where the comments are stored $comment_filename = get_comment_filename($env->page); if(!file_exists($comment_filename)) { if(file_put_contents($comment_filename, "[]\n") === false) { http_response_code(503); exit(page_renderer::renderer_main("Error posting comment - $settings->sitename", "$settings->sitename ran into a problem whilst creating a file to save your comment to! Please contact $settings->admindetails_name, $settings->sitename's administrator and tell them about this problem.
")); } } $comment_data = json_decode(file_get_contents($comment_filename)); $new_comment = new stdClass(); $new_comment->id = generate_comment_id(); $new_comment->timestamp = date("c"); $new_comment->username = $env->user; $new_comment->logged_in = $env->is_logged_in; $new_comment->message = $message; $new_comment->replies = []; if($reply_to == null) $comment_data[] = $new_comment; else { $parent_comment = find_comment($comment_data, $reply_to); if($parent_comment === false) { http_response_code(422); exit(page_renderer::render_main("Error posting comment - $settings->sitename", "$settings->sitename couldn't post your comment because it couldn't find the parent comment you replied to. It's possible that $settings->admindetails_name, $settings->sitename's administrator, deleted the comment. Here's the comment you tried to post:
")); } $parent_comment->replies[] = $new_comment; // Get an array of all the parent comments we need to notify $comment_thread = fetch_comment_thread($comment_data, $parent_comment->id); $email_subject = "[Notification] $env->user replied to your comment on $env->page - $settings->sitename"; foreach($comment_thread as $thread_comment) { $email_body = "Hello, {username}!\n" . "It's $settings->sitename here, letting you know that " . "someone replied to your comment (or a reply to your comment) on $env->page.\n" . "\n" . "They said:\n" . "\n" . "$new_comment->message" . "\n" . "You said on " . date("c", strtotime($thread_comment->timestamp)) . ":\n" . "\n" . "$thread_comment->message\n" . "\n"; email_user($thread_comment->username, $email_subject, $email_body); } } // Save the comments back to disk if(file_put_contents($comment_filename, json_encode($comment_data, JSON_PRETTY_PRINT)) === false) { http_response_code(503); exit(page_renderer::renderer_main("Error posting comment - $settings->sitename", "$settings->sitename ran into a problem whilst saving your comment to disk! Please contact $settings->admindetails_name, $settings->sitename's administrator and tell them about this problem.
")); } // Add a recent change if the recent changes module is installed if(module_exists("feature-recent-changes")) { add_recent_change([ "type" => "comment", "timestamp" => time(), "page" => $env->page, "user" => $env->user, "reply_depth" => count($comment_thread), "comment_id" => $new_comment->id ]); } http_response_code(307); header("location: ?action=view&page=" . rawurlencode($env->page) . "&commentsuccess=yes#comment-$new_comment->id"); exit(page_renderer::render_main("Comment posted successfully - $settings->sitename", "Your comment on $env->page was posted successfully. If your browser doesn't redirect you automagically, please click here to go to the comment you posted on the page you were viewing.
")); }); /** * @api {post} ?action=comment-delete&page={page_name}&delete_id={id_to_delete} Delete a comment * @apiName CommentDelete * @apiGroup Comment * @apiPermission User * @apiDescription Deletes a comment with the specified id. If you aren't the one who made the comment in the first place, then you must be a moderator or better to delete it. * * @apiUse PageParameter * @apiParam {string} delete_id The id of the comment to delete. * * @apiError CommentNotFound The comment to delete was not found. */ /* * ██████ ██████ ███ ███ ███ ███ ███████ ███ ██ ████████ * ██ ██ ██ ████ ████ ████ ████ ██ ████ ██ ██ * ██ ██ ██ ██ ████ ██ ██ ████ ██ █████ ██ ██ ██ ██ █████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ ██ ██ ██ ██ ███████ ██ ████ ██ * ██████ ███████ ██ ███████ ████████ ███████ * ██ ██ ██ ██ ██ ██ ██ * ██ ██ █████ ██ █████ ██ █████ * ██ ██ ██ ██ ██ ██ ██ * ██████ ███████ ███████ ███████ ██ ███████ */ add_action("comment-delete", function () { global $env, $settings; if(!isset($_GET["delete_id"])) { http_response_code(400); exit(page_renderer::render_main("Error - Deleting Comment - $settings->sitename", "You didn't specify the id of a comment to delete.
")); } // Make sure that the user is logged in before deleting a comment if(!$env->is_logged_in) { http_response_code(307); header("location: ?action=login&returnto=" . rawurlencode("?action=comment-delete&page=" . rawurlencode($env->page) . "&id=" . rawurlencode($_GET["delete_id"]))); } $comment_filename = get_comment_filename($env->page); $comments = json_decode(file_get_contents($comment_filename)); $target_id = $_GET["delete_id"]; $comment_to_delete = find_comment($comments, $target_id); if($comment_to_delete->username !== $env->user && !$env->is_admin) { http_response_code(401); exit(page_renderer::render_main("Error - Deleting Comment - $settings->sitename", "You can't delete the comment with the id " . htmlentities($target_id) . " on the page $env->page because you're logged in as " . page_renderer::render_username($env->user) . ", and " . page_renderer::render_username($comment_to_delete->username) . " made that comment. Try Logging out and then logging in again as " . page_renderer::render_username($comment_to_delete->username) . ", or as a moderator or better."));
}
if(!delete_comment($comments, $_GET["delete_id"])) {
http_response_code(404);
exit(page_renderer::render_main("Comment not found - Deleting Comment - $settings->sitename", "
The comment with the id " . htmlentities($_GET["delete_id"]) . " on the page $env->page wasn't found. Perhaps it was already deleted?
While $settings->sitename was able to delete the comment with the id " . htmlentities($target_id) . " on the page $env->page, it couldn't save the changes back to disk. Please contact $settings->admindetails_name, $settings->sitename's local friendly administrator about this issue.
The comment with the id " . htmlentities($target_id) . " on the page $env->page has been deleted successfully. Go back to " . htmlentities($env->page) . ".
$settings->sitename has a threaded commenting system on every page. You can find it below each page's content, and can either leave a new comment, or reply to an existing one. If you reply to an existing one, then the authors of all the comments above yours will get notified by email of your reply - so long as they have an email address registered in their preferences.
"); } ]); /** * Given a page name, returns the absolute file path in which that page's * comments are stored. * @package feature-comments * @param string $pagename The name pf the page to fetch the comments filename for. * @return string The path to the file that the */ function get_comment_filename($pagename) { global $env; $pagename = makepathsafe($pagename); return "$env->storage_prefix$pagename.comments.json"; } /** * Generates a new random comment id. * @package feature-comments * @return string A new random comment id. */ function generate_comment_id() { $result = base64_encode(random_bytes(16)); $result = str_replace(["+", "/", "="], ["-", "_"], $result); return $result; } /** * Finds the comment with specified id by way of an almost-breadth-first search. * @package feature-comments * @param array $comment_data The comment data to search. * @param string $comment_id The id of the comment to find. * @return object The comment data with the specified id, or * false if it wasn't found. */ function find_comment($comment_data, $comment_id) { $subtrees = []; foreach($comment_data as $comment) { if($comment->id === $comment_id) return $comment; if(count($comment->replies) > 0) { $subtrees[] = $comment->replies; } } foreach($subtrees as $subtree) { $subtree_result = find_comment($subtree, $comment_id); if($subtree_result !== false) return $subtree_result; } return false; } /** * Deletes the first comment found with the specified id. * @param array $comment_data An array of threaded comments to delete the comment from. * @param string $target_id The id of the comment to delete. * @return bool Whether the comment was found and deleted or not. */ function delete_comment(&$comment_data, $target_id) { $comment_count = count($comment_data); if($comment_count === 0) return false; for($i = 0; $i < $comment_count; $i++) { if($comment_data[$i]->id == $target_id) { if(count($comment_data[$i]->replies) == 0) { unset($comment_data[$i]); // Reindex the comment list before returning $comment_data = array_values($comment_data); } else { unset($comment_data[$i]->username); $comment_data[$i]->message = "_[Deleted]_"; } return true; } if(count($comment_data[$i]->replies) > 0 && delete_comment($comment_data[$i]->replies, $target_id)) return true; } return false; } /** * Fetches all the parent comments of the specified comment id, including the * comment itself at the end. * Useful for figuring out who needs notifying when a new comment is posted. * @package feature-comments * @param array $comment_data The comment data to search. * @param string $comment_id The comment id to fetch the thread for. * @return object[] A list of the comments in the thread, with the deepest * one at the end. */ function fetch_comment_thread($comment_data, $comment_id) { foreach($comment_data as $comment) { // If we're the comment they're looking for, then return ourselves as // the beginning of a thread if($comment->id === $comment_id) return [ $comment ]; if(count($comment->replies) > 0) { $subtree_result = fetch_comment_thread($comment->replies, $comment_id); if($subtree_result !== false) { // Prepend ourselves to the result array_unshift($subtree_result, $comment); return $subtree_result; // Return the comment thread } } } return false; } /** * Renders a given comments tree to html. * @package feature-comments * @param object[] $comments_data The comments tree to render. * @param integer $depth For internal use only. Specifies the depth * at which the comments are being rendered. * @return string The given comments tree as html. */ function render_comments($comments_data, $depth = 0) { global $settings, $env; if(count($comments_data) == 0) { if($depth == 0) return "No comments here! Start the conversation above.
"; else return ""; } $result = "You don't have permission to change $settings->sitename's master settings.
\n"; if(!$env->is_logged_in) $errorMessage .= "You could try logging in.
"; else $errorMessage .= "You could try logging out and then logging in again with a different account that has the appropriate privileges..
"; exit(page_renderer::render_main("Error - $settings->sitename", $errorMessage)); } $content = "Master Control Panel
\n"; $content .= "This page lets you configure $settings->sitename's master settings. Please be careful - you can break things easily on this page if you're not careful!
\n"; $content .= "You're currently running Pepperminty Wiki $version+" . substr($commit, 0, 7) . ".
\n"; $content .= "Actions
"; $content .= "\n"; $content .= "\n"; $content .= "
\n"; $invindex_rebuild_script = <<")); break; case "POST": // Recieve file if(!$settings->editing) { exit(page_renderer::render_main("Upload failed - $settings->sitename", "
Your upload couldn't be processed because editing is currently disabled on $settings->sitename. Please contact $settings->admindetails_name, $settings->sitename's administrator for more information - their contact details can be found at the bottom of this page. Go back to the main page.")); } // Make sure uploads are enabled if(!$settings->upload_enabled) { if(!empty($_FILES["file"])) unlink($_FILES["file"]["tmp_name"]); http_response_code(412); exit(page_renderer::render("Upload failed - $settings->sitename", "
Your upload couldn't be processed because uploads are currently disabled on $settings->sitename. Go back to the main page.
")); } // Make sure that the user is logged in if(!$env->is_logged_in) { if(!empty($_FILES["file"])) unlink($_FILES["file"]["tmp_name"]); http_response_code(401); exit(page_renderer::render("Upload failed - $settings->sitename", "Your upload couldn't be processed because you are not logged in.
Try logging in first.")); } // Check for php upload errors if($_FILES["file"]["error"] > 0) { if(!empty($_FILES["file"])) unlink($_FILES["file"]["tmp_name"]); if($_FILES["file"]["error"] == 1 || $_FILES["file"]["error"] == 2) http_response_code(413); // file is too large else http_response_code(500); // something else went wrong exit(page_renderer::render("Upload failed - $settings->sitename", "
Your upload couldn't be processed because " . (($_FILES["file"]["error"] == 1 || $_FILES["file"]["error"] == 2) ? "the file is too large" : "an error occurred") . ".
Please contact $settings->admindetails_name, $settings->sitename's administrator for help.
")); } // Calculate the target name, removing any characters we // are unsure about. $target_name = makepathsafe($_POST["name"] ?? "Users/$env->user/Avatar"); $temp_filename = $_FILES["file"]["tmp_name"]; $mimechecker = finfo_open(FILEINFO_MIME_TYPE); $mime_type = finfo_file($mimechecker, $temp_filename); finfo_close($mimechecker); if(!in_array($mime_type, $settings->upload_allowed_file_types)) { http_response_code(415); exit(page_renderer::render("Unknown file type - Upload error - $settings->sitename", "$settings->sitename recieved the file you tried to upload successfully, but detected that the type of file you uploaded is not in the allowed file types list. The file has been discarded.
The file you tried to upload appeared to be of type $mime_type, but $settings->sitename currently only allows the uploading of the following file types: " . implode(", ", $settings->upload_allowed_file_types) . ".
Go back to the Main Page.
")); } // Perform appropriate checks based on the *real* filetype if($is_avatar && substr($mime_type, 0, strpos($mime_type, "/")) !== "image") { http_response_code(415); exit(page_renderer::render_main("Error uploading avatar - $settings->sitename", "That file appears to be unsuitable as an avatar, as $settings->sitename has detected it to be of type $mime_type, which doesn't appear to be an image. Please try uploading a different file to use as your avatar.
Although the file that you uploaded appears to be an image, $settings->sitename has been unable to determine it's dimensions. The uploaded file has been discarded. Go back to try again.
You may wish to consider opening an issue against Pepperminty Wiki (the software that powers $settings->sitename) if this isn't the first time that you have seen this message.
")); } break; } $file_extension = system_mime_type_extension($mime_type); // Override the detected file extension if a file extension // is explicitly specified in the settings if(isset($settings->mime_mappings_overrides->$mime_type)) $file_extension = $settings->mime_mappings_overrides->$mime_type; if(in_array($file_extension, [ "php", ".htaccess", "asp", "aspx" ])) { http_response_code(415); exit(page_renderer::render("Upload Error - $settings->sitename", "The file you uploaded appears to be dangerous and has been discarded. Please contact $settings->sitename's administrator for assistance.
Additional information: The file uploaded appeared to be of type $mime_type, which mapped onto the extension $file_extension. This file extension has the potential to be executed accidentally by the web server.
A page or file has already been uploaded with the name '$new_filename'. Try deleting it first. If you do not have permission to delete things, try contacting one of the moderators.
")); // Delete the previously uploaded avatar, if it exists // In the future we _may_ not need this once we have // file history online. if($is_avatar && isset($pageindex->$new_pagepath) && $pageindex->$new_pagepath->uploadedfile) unlink($pageindex->$new_pagepath->uploadedfilepath); // Make sure that the palce we're uploading to exists if(!file_exists(dirname($env->storage_prefix . $new_filename))) mkdir(dirname($env->storage_prefix . $new_filename), 0775, true); if(!move_uploaded_file($temp_filename, $env->storage_prefix . $new_filename)) { http_response_code(409); exit(page_renderer::render("Upload Error - $settings->sitename", "The file you uploaded was valid, but $settings->sitename couldn't verify that it was tampered with during the upload process. This probably means that either is a configuration error, or that $settings->sitename has been attacked. Please contact " . $settings->admindetails_name . ", your $settings->sitename Administrator.
")); } $description = $_POST["description"] ?? "_(No description provided)_\n"; // Escape the raw html in the provided description if the setting is enabled if($settings->clean_raw_html) $description = htmlentities($description, ENT_QUOTES); file_put_contents($env->storage_prefix . $new_description_filename, $description); // Construct a new entry for the pageindex $entry = new stdClass(); // Point to the description's filepath since this property // should point to a markdown file $entry->filename = $new_description_filename; $entry->size = strlen($description ?? "(No description provided)"); $entry->lastmodified = time(); $entry->lasteditor = $env->user; $entry->uploadedfile = true; $entry->uploadedfilepath = $new_filename; $entry->uploadedfilemime = $mime_type; // Add the new entry to the pageindex // Assign the new entry to the image's filepath as that // should be the page name. $pageindex->$new_pagepath = $entry; // Generate a revision to keep the page history up to date if(module_exists("feature-history")) { $oldsource = ""; // Only variables can be passed by reference, not literals history_add_revision($entry, $description, $oldsource, false); } // Save the pageindex file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT)); if(module_exists("feature-recent-changes")) { add_recent_change([ "type" => "upload", "timestamp" => time(), "page" => $new_pagepath, "user" => $env->user, "filesize" => filesize($env->storage_prefix . $entry->uploadedfilepath) ]); } header("location: ?action=view&page=$new_pagepath&upload=success"); break; } }); /** * @api {get} ?action=preview&page={pageName}[&size={someSize}] Get a preview of a file * @apiName PreviewFile * @apiGroup Upload * @apiPermission Anonymous * * @apiParam {string} page The name of the file to preview. * @apiParam {number} size Optional. The size fo the resulting preview. Will be clamped to fit within the bounds specified in the wiki's settings. May also be set to the keyword 'original', which will cause the original file to be returned with it's appropriate mime type instead. * * @apiError PreviewNoFileError No file was found associated with the specified page. * @apiError PreviewUnknownFileTypeError Pepperminty Wiki was unable to generate a preview for the requested file's type. */ /* * ██████ ██████ ███████ ██ ██ ██ ███████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ █████ ██ ██ ██ █████ ██ █ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ * ██ ██ ██ ███████ ████ ██ ███████ ███ ███ */ add_action("preview", function() { global $settings, $env, $pageindex, $start_time; if(empty($pageindex->{$env->page}->uploadedfilepath)) { $im = errorimage("The page '$env->page' doesn't have an associated file."); header("content-type: image/png"); imagepng($im); exit(); } $filepath = realpath($env->storage_prefix . $pageindex->{$env->page}->uploadedfilepath); $mime_type = $pageindex->{$env->page}->uploadedfilemime; $shortFilename = substr($filepath, 1 + (strrpos($filepath, '/') !== false ? strrpos($filepath, '/') : -1)); header("content-disposition: inline; filename=\"$shortFilename\""); header("last-modified: " . gmdate('D, d M Y H:i:s T', $pageindex->{$env->page}->lastmodified)); // If the size is set to original, then send (or redirect to) the original image // Also do the same for SVGs if svg rendering is disabled. if(isset($_GET["size"]) and $_GET["size"] == "original" or (empty($settings->render_svg_previews) && $mime_type == "image/svg+xml")) { // Get the file size $filesize = filesize($filepath); // Send some headers header("content-length: $filesize"); header("content-type: $mime_type"); // Open the file and send it to the user $handle = fopen($filepath, "rb"); fpassthru($handle); fclose($handle); exit(); } // Determine the target size of the image $target_size = 512; if(isset($_GET["size"])) $target_size = intval($_GET["size"]); if($target_size < $settings->min_preview_size) $target_size = $settings->min_preview_size; if($target_size > $settings->max_preview_size) $target_size = $settings->max_preview_size; // Determine the output file type $output_mime = $settings->preview_file_type; if(isset($_GET["type"]) and in_array($_GET["type"], [ "image/png", "image/jpeg", "image/webp" ])) $output_mime = $_GET["type"]; /// ETag handling /// // Generate the etag and send it to the client $preview_etag = sha1("$output_mime|$target_size|$filepath|$mime_type"); $allheaders = getallheaders(); $allheaders = array_change_key_case($allheaders, CASE_LOWER); if(!isset($allheaders["if-none-match"])) { header("etag: $preview_etag"); } else { if($allheaders["if-none-match"] === $preview_etag) { http_response_code(304); header("x-generation-time: " . (microtime(true) - $start_time)); exit(); } } /// ETag handling end /// /* Disabled until we work out what to do about caching previews * $previewFilename = "$filepath.preview.$outputFormat"; if($target_size === $settings->default_preview_size) { // The request is for the default preview size // Check to see if we have a preview pre-rendered } */ $preview = new Imagick(); switch(substr($mime_type, 0, strpos($mime_type, "/"))) { case "image": $preview->readImage($filepath); break; case "application": if($mime_type == "application/pdf") { $preview = new imagick(); $preview->readImage("{$filepath}[0]"); $preview->setResolution(300,300); $preview->setImageColorspace(255); break; } case "video": case "audio": if($settings->data_storage_dir == ".") { // The data storage directory is the current directory // Redirect to the file isntead http_response_code(307); header("location: " . $pageindex->{$env->page}->uploadedfilepath); exit(); } // TODO: Add support for ranges here. // Get the file size $filesize = filesize($filepath); // Send some headers header("content-length: $filesize"); header("content-type: $mime_type"); // Open the file and send it to the user $handle = fopen($filepath, "rb"); fpassthru($handle); fclose($handle); exit(); break; default: http_response_code(501); $preview = errorimage("Unrecognised file type '$mime_type'.", $target_size); header("content-type: image/png"); imagepng($preview); exit(); } // Scale the image down to the target size $preview->resizeImage($target_size, $target_size, imagick::FILTER_LANCZOS, 1, true); // Send the completed preview image to the user header("content-type: $output_mime"); header("x-generation-time: " . (microtime(true) - $start_time) . "s"); $outputFormat = substr($output_mime, strpos($output_mime, "/") + 1); $preview->setImageFormat($outputFormat); echo($preview->getImageBlob()); /* Disabled while we work out what to do about caching previews * // Save a preview file if there isn't one alreaddy if(!file_exists($previewFilename)) file_put_contents($previewFilename, $preview->getImageBlob()); */ }); /* * ██████ ██████ ███████ ██ ██ ██ ███████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ █████ ██ ██ ██ █████ ██ █ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ * ██ ██ ██ ███████ ████ ██ ███████ ███ ███ * * ██████ ██ ███████ ██████ ██ █████ ██ ██ ███████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ███████ ██████ ██ ███████ ████ █████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ███████ ██ ███████ ██ ██ ██ ███████ ██ ██ */ page_renderer::register_part_preprocessor(function(&$parts) { global $pageindex, $env, $settings; // Don't do anything if the action isn't view if($env->action !== "view") return; if(isset($pageindex->{$env->page}->uploadedfile) and $pageindex->{$env->page}->uploadedfile == true) { // We are looking at a page that is paired with an uploaded file $filepath = $pageindex->{$env->page}->uploadedfilepath; $mime_type = $pageindex->{$env->page}->uploadedfilemime; $dimensions = $mime_type !== "image/svg+xml" ? getimagesize($env->storage_prefix . $filepath) : getsvgsize($env->storage_prefix . $filepath); $fileTypeDisplay = substr($mime_type, 0, strpos($mime_type, "/")); $previewUrl = "?action=preview&size=$settings->default_preview_size&page=" . rawurlencode($env->page); $preview_html = ""; switch($fileTypeDisplay) { case "application": case "image": if($mime_type == "application/pdf") $fileTypeDisplay = "file"; $originalUrl = $env->storage_prefix == "./" ? $filepath : "?action=preview&size=original&page=" . rawurlencode($env->page); $preview_sizes = [ 256, 512, 768, 1024, 1440, 1920 ]; $preview_html .= "\t\t\tFile Information
| $displayName | $displayValue |
|---|
$settings->sitename supports the uploading of files, though it is up to " . $settings->admindetails_name . ", $settings->sitename's administrator as to whether it is enabled or not (uploads are currently " . (($settings->upload_enabled) ? "enabled" : "disabled") . ").
Currently Pepperminty Wiki (the software that $settings->sitename uses) only supports the uploading of images, although more file types should be supported in the future (open an issue on GitHub if you are interested in support for more file types).
Uploading a file is actually quite simple. Click the "Upload" option in the "More..." menu to go to the upload page. The upload page will tell you what types of file $settings->sitename allows, and the maximum supported filesize for files that you upload (this is usually set by the web server that the wiki is running on).
Use the file chooser to select the file that you want to upload, and then decide on a name for it. Note that the name that you choose should not include the file extension, as this will be determined automatically. Enter a description that will appear on the file's page, and then click upload.
"); } ]); /** * Calculates the actual maximum upload size supported by the server * Returns a file size limit in bytes based on the PHP upload_max_filesize and * post_max_size * @package feature-upload * @author Lifted from Drupal by @meustrus from Stackoverflow * @see http://stackoverflow.com/a/25370978/1460422 Source Stackoverflow answer * @return integer The maximum upload size supported bythe server, in bytes. */ function get_max_upload_size() { static $max_size = -1; if ($max_size < 0) { // Start with post_max_size. $max_size = parse_size(ini_get('post_max_size')); // If upload_max_size is less, then reduce. Except if upload_max_size is // zero, which indicates no limit. $upload_max = parse_size(ini_get('upload_max_filesize')); if ($upload_max > 0 && $upload_max < $max_size) { $max_size = $upload_max; } } return $max_size; } /** * Parses a PHP size to an integer * @package feature-upload * @author Lifted from Drupal by @meustrus from Stackoverflow * @see http://stackoverflow.com/a/25370978/1460422 Source Stackoverflow answer * @param string $size The size to parse. * @return integer The number of bytees represented by the specified * size string. */ function parse_size($size) { $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size. $size = preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size. if ($unit) { // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by. return round($size * pow(1024, stripos('bkmgtpezy', $unit[0]))); } else { return round($size); } } /** * Checks an uploaded SVG file to make sure it's (at least somewhat) safe. * Sends an error to the client if a problem is found. * @package feature-upload * @param string $temp_filename The filename of the SVG file to check. * @return int[] The size of the SVG image. */ function upload_check_svg($temp_filename) { global $settings; // Check for script tags if(strpos(file_get_contents($temp_filename), "$settings->sitename detected that you uploaded an SVG image and performed some extra security checks on your file. Whilst performing these checks it was discovered that the file you uploaded contains some Javascript, which could be dangerous. The uploaded file has been discarded. Go back to try again.
You may wish to consider opening an issue against Pepperminty Wiki (the software that powers $settings->sitename) if this isn't the first time that you have seen this message.
")); } // Find and return the size of the SVG image return getsvgsize($temp_filename); } /** * Calculates the size of the specified SVG file. * @package feature-upload * @param string $svgFilename The filename to calculate the size of. * @return int[] The width and height respectively of the * specified SVG file. */ function getsvgsize($svgFilename) { global $settings; libxml_disable_entity_loader(true); // Ref: XXE Billion Laughs Attack, issue #152 $rawSvg = file_get_contents($svgFilename); $svg = simplexml_load_string($rawSvg); // Load it as XML unset($rawSvg); if($svg === false) { http_response_code(415); exit(page_renderer::render("Upload Error - $settings->sitename", "When $settings->sitename tried to open your SVG file for checking, it found some invalid syntax. The uploaded file has been discarded. Go back to try again.
")); } $rootAttrs = $svg->attributes(); $imageSize = false; if(isset($rootAttrs->width) and isset($rootAttrs->height)) $imageSize = [ intval($rootAttrs->width), intval($rootAttrs->height) ]; else if(isset($rootAttrs->viewBox)) $imageSize = array_map("intval", array_slice(explode(" ", $rootAttrs->viewBox), -2, 2)); return $imageSize; } /** * Creates an images containing the specified text. * Useful for sending errors back to the client. * @package feature-upload * @param string $text The text to include in the image. * @param integer $target_size The target width to aim for when creating * the image. * @return image The handle to the generated GD image. */ function errorimage($text, $target_size = null) { $width = 640; $height = 480; if(!empty($target_size)) { $width = $target_size; $height = $target_size * (2 / 3); } $image = imagecreatetruecolor($width, $height); imagefill($image, 0, 0, imagecolorallocate($image, 238, 232, 242)); // Set the background to #eee8f2 $fontwidth = imagefontwidth(3); imagestring($image, 3, ($width / 2) - (($fontwidth * strlen($text)) / 2), ($height / 2) - (imagefontheight(3) / 2), $text, imagecolorallocate($image, 17, 17, 17) // #111111 ); return $image; } register_module([ "name" => "User Preferences", "version" => "0.3.3", "author" => "Starbeamrainbowlabs", "description" => "Adds a user preferences page, letting people do things like change their email address and password.", "id" => "feature-user-preferences", "code" => function() { global $env, $settings; /** * @api {get} ?action=user-preferences Get a user preferences configuration page * @apiName UserPreferences * @apiGroup Settings * @apiPermission User */ /* * ██ ██ ███████ ███████ ██████ * ██ ██ ██ ██ ██ ██ * ██ ██ ███████ █████ ██████ █████ * ██ ██ ██ ██ ██ ██ * ██████ ███████ ███████ ██ ██ * * ██████ ██████ ███████ ███████ ███████ * ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ █████ █████ ███████ * ██ ██ ██ ██ ██ ██ * ██ ██ ██ ███████ ██ ███████ */ add_action("user-preferences", function() { global $env, $settings; if(!$env->is_logged_in) { exit(page_renderer::render_main("Error - $settings->sitename", "Since you aren't logged in, you can't change your preferences. This is because stored preferences are tied to each registered user account. You can login here.
")); } $statusMessages = [ "change-password" => "Password changed successfully!" ]; if(!isset($env->user_data->emailAddress)) { $env->user_data->emailAddress = ""; save_userdata(); } $content = "User Preferences
\n"; if(isset($_GET["success"]) && $_GET["success"] === "yes") { $content .= "\n"; } // If avatar support is present, allow the user to upload a new avatar if(has_action("avatar") && module_exists("feature-upload")) { $content .= "\n"; } $content .= "\n"; $content .= "\n"; $content .= "\n"; $content .= "
Change Password"; $content .= "
\n"; if($env->is_admin) $content .= "As an admin, you can also edit $settings->sitename's master settings.
\n"; exit(page_renderer::render_main("User Preferences - $settings->sitename", $content)); }); /** * @api {post} ?action=save-preferences Save your user preferences * @apiName UserPreferencesSave * @apiGroup Settings * @apiPermission User */ add_action("save-preferences", function() { global $env, $settings; if(!$env->is_logged_in) { http_response_code(400); exit(page_renderer::render_main("Error Saving Preferences - $settings->sitename", "You aren't logged in, so you can't save your preferences. Try logging in first.
")); } if(isset($_POST["email-address"])) { if(mb_strlen($_POST["email-address"]) > 320) { http_response_code(413); exit(page_renderer::render_main("Error Saving Email Address - $settings->sitename", "The email address you supplied ({$_POST['email-address']}) is too long. Email addresses can only be 320 characters long. Go back."));
}
if(mb_strpos($_POST["email-address"], "@") === false)
{
http_response_code(422);
exit(page_renderer::render_main("Error Saving Email Address - $settings->sitename", "
The email address you supplied ({$_POST['email-address']}) doesn't appear to be valid. Go back."));
}
$env->user_data->emailAddress = $_POST["email-address"];
}
// Save the user's preferences
if(!save_userdata())
{
http_response_code(503);
exit(page_renderer::render_main("Error Saving Preferences - $settings->sitename", "
$settings->sitename had some trouble saving your preferences! Please contact $settings->admindetails_name, $settings->sitename's administrator and tell them about this error if it still occurs in 5 minutes. They can be contacted by email at this address: " . hide_email($settings->admindetails_email) . ".
")); } exit(page_renderer::render_main("Preferences Saved Successfully - $settings->sitename", "Your preferences have been saved successfully! You could go back your preferences page, or on to the $settings->defaultpage.
")); }); /** * @api {post} ?action=change-password Change your password * @apiName ChangePassword * @apiGroup Settings * @apiPermission User * * @apiParam {string} current-pass Your current password. * @apiParam {string} new-pass Your new password. * @apiParam {string} new-pass-confirm Your new password again, to make sure you've typed it correctly. * * @apiError PasswordMismatchError The new password fields don't match. */ add_action("change-password", function() { global $env, $settings; // Make sure the new password was typed correctly // This comes before the current password check since that's more intensive if($_POST["new-pass"] !== $_POST["new-pass-confirm"]) { exit(page_renderer::render_main("Password mismatch - $settings->sitename", "The new password you typed twice didn't match! Go back.
")); } // Check the current password if(!verify_password($_POST["current-pass"], $env->user_data->password)) { exit(page_renderer::render_main("Password mismatch - $settings->sitename", "Error: You typed your current password incorrectly! Go back.
")); } // All's good! Go ahead and change the password. $env->user_data->password = hash_password($_POST["new-pass"]); // Save the userdata back to disk if(!save_userdata()) { http_response_code(503); exit(page_renderer::render_main("Error Saving Password - $settings->sitename", "While you entered your old password correctly, $settings->sitename encountered an error whilst saving your password to disk! Your password has not been changed. Please contact $settings->admindetails_name for assistance (you can find their email address at the bottom of this page).")); } http_response_code(307); header("location: ?action=user-preferences&success=yes&operation=change-password"); exit(page_renderer::render_main("Password Changed Successfully", "
You password was changed successfully. Go back to the user preferences page.
")); }); /* * █████ ██ ██ █████ ████████ █████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ███████ ██ ███████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ████ ██ ██ ██ ██ ██ ██ ██ */ /** * @api {get} ?action=avatar&user={username}[&size={size}] Get a user's avatar * @apiName Avatar * @apiGroup Upload * @apiPermission Anonymous * * @apiParam {string} user The username to fetch the avatar for * @apiParam {string} size The preferred size of the avatar */ add_action("avatar", function() { global $settings; $size = intval($_GET["size"] ?? 32); /// Use gravatar if there's some issue with the requested user // No user specified if(empty($_GET["user"])) { http_response_code(307); header("x-reason: no-user-specified"); header("location: https://gravatar.com/avatar/?default=blank"); } $requested_username = $_GET["user"]; // The user hasn't uploaded an avatar if(empty($pageindex->{"User/$requested_username/Avatar"}) || !$pageindex->{"User/$requested_username/Avatar"}->uploadedfile) { $user_fragment = !empty($settings->users->$requested_username->emailAddress) ? $settings->users->$requested_username->emailAddress : $requested_username; http_response_code(307); header("x-reason: no-avatar-found"); header("x-hash-method: " . ($user_fragment === $requested_username ? "username" : "email_address")); header("location: https://gravatar.com/avatar/" . md5($user_fragment) . "?default=identicon&rating=g&size=$size"); exit(); } // The user has uploaded an avatar, so we can redirec to the regular previewer :D http_response_code(307); header("x-reason: found-local-avatar"); header("location: ?action=preview&size=$size&page=" . urlencode("Users/$requested_username/Avatar")); exit("This user's avatar can be found at Files/$requested_username/Avatar"); }); // Display a help section on the user preferences, but only if the user // is logged in and so able to access them if($env->is_logged_in) { add_help_section("910-user-preferences", "User Preferences", "As you are logged in, $settings->sitename lets you configure a selection of personal preferences. These can be viewed and tweaked to you liking over on the preferences page, which can be accessed at any time by clicking the cog icon (it looks something like this: $settings->user_preferences_button_text), though the administrator of $settings->sitename ($settings->admindetails_name) may have changed its appearance.
"); } if($settings->avatars_show) { add_help_section("915-avatars", "Avatars", "$settings->sitename allows you to upload an avatar and have it displayed next to your name. If you don't have an avatar uploaded yet, then $settings->sitename will take a hash of your email address and ask Gravatar for for your Gravatar instead. If you haven't told $settings->sitename what your email address is either, a hash of your username is used instead. If you don't have a gravatar, then $settings->sitename asks Gravatar for an identicon instead.
Your avatar on $settings->sitename currently looks like this: " . ($settings->upload_enabled ? " - you can upload a new one by going to your preferences, or clicking here." : ", but $settings->sitename currently has uploads disabled, so you can't upload a new one directly to $settings->sitename. You can, however, set your email address in your preferences and create a Gravatar, and then it should show up here on $settings->sitename shortly.") . "
Only moderators (or better) may access the user table. You could try logging out and then logging in again as a moderator, or alternatively visit the user list instead, if that's what you're after.
")); } $content = "User Table
(Warning! Deleting a user will wipe all their user data! It won't delete any pages they've created, their user page, or their avatar though, as those are part of the wiki itself.)
| Username | Email Address | ||
|---|---|---|---|
| " . page_renderer::render_username($username) . " | "; if(!empty($user_data->email)) $content .= "" . htmlentities($user_data->email) . " | \n"; else $content .= "(None provided) | \n"; $content .= ""; if(module_exists("feature-user-preferences")) $content .= " | "; $content .= "Delete User"; $content .= " |
Add User
"; exit(page_renderer::render_main("User Table - $settings->sitename", $content)); }); /** * @api {post} ?action=user-add Create a user account * @apiName UserAdd * @apiGroup Settings * @apiPermission Moderator * * @apiParam {string} user The username for the new user. * @apiParam {string} email Optional. Specifies the email address for the new user account. */ /* * ██ ██ ███████ ███████ ██████ █████ ██████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ███████ █████ ██████ █████ ███████ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ███████ ███████ ██ ██ ██ ██ ██████ ██████ */ add_action("user-add", function() { global $settings, $env; if(!$env->is_admin) { http_response_code(401); exit(page_renderer::render_main("Error: Unauthorised - Add User - $settings->sitename", "Only moderators (or better) may create users. You could try logging out and then logging in again as a moderator, or alternatively visit the user list instead, if that's what you're after.
")); } if(!isset($_POST["user"])) { http_response_code(400); header("content-type: text/plain"); exit("Error: No username specified in the 'user' post parameter."); } $new_username = $_POST["user"]; $new_email = $_POST["email"] ?? null; if(preg_match('/[^0-9a-zA-Z\-_]/', $new_username) !== 0) { http_response_code(400); exit(page_renderer::render_main("Error: Invalid Username - Add User - $settings->sitename", "The username " . htmlentities($new_username) . " contains some invalid characters. Only a-z, A-Z, 0-9, -, and _ are allowed in usernames. Go back.
The email address " . htmlentities($new_email) . " appears to be invalid. Go back.
$settings->sitename failed to save the new user's data to disk. Please contact $settings->admindetails_name for assistance (their email address can be found at the bottom of this page).
")); } $welcome_email_result = email_user($new_username, "Welcome!", "Welcome to $settings->sitename, {username}! $env->user has created you an account. Here are your details: Url: " . substr(full_url(), 0, strrpos(full_url(), "?")) . " Username: {username} Password: $new_password It is advised that you change your password as soon as you login. You can do this by clicking the cog next to your name once you've logged in, and scrolling to the 'change password' heading. If you need any assistance, then the help page you can access at the bottom of every page on $settings->sitename has information on most aspects of $settings->sitename. --$settings->sitename, powered by Pepperminty Wiki https://github.com/sbrl/Pepperminty-Wiki/ "); $content = "Add User
The new user was added to $settings->sitename sucessfully! Their details are as follows:
- Username:
$new_username";
if(!empty($new_email))
$content .= " - Email Address:
$new_email\n";
if(!$welcome_email_result)
$content .= " - Password:
$new_password\n";
$content .= "
An email has been sent to the email address given above containing their login details.
\n"; $content .= "Go back to the user table.
\n"; http_response_code(201); exit(page_renderer::render_main("Add User - $settings->sitename", $content)); }); /** * @api {post} ?action=set-password Set a user's password * @apiName UserAdd * @apiGroup Settings * @apiPermission Moderator * * @apiParam {string} user The username of the account to set the password for. * @apiParam {string} new-pass The new password for the specified username. */ /* * ███████ ███████ ████████ * ██ ██ ██ * ███████ █████ ██ █████ * ██ ██ ██ * ███████ ███████ ██ * * ██████ █████ ███████ ███████ ██ ██ ██████ ██████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ███████ ███████ ███████ ██ █ ██ ██ ██ ██████ ██ ██ * ██ ██ ██ ██ ██ ██ ███ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ███████ ███████ ███ ███ ██████ ██ ██ ██████ */ add_action("set-password", function() { global $env, $settings; if(!$env->is_admin) { http_response_400(401); exit(page_renderer::render_main("Error - Set Password - $settings->sitename", "Error: You aren't logged in as a moderator, so you don't have permission to set a user's password.
")); } if(empty($_POST["user"])) { http_response_code(400); exit(page_renderer::render_main("Error - Set Password - $settings->sitename", "Error: No username was provided via the 'user' POST parameter.
")); } if(empty($_POST["new-pass"])) { http_response_code(400); exit(page_renderer::render_main("Error - Set Password - $settings->sitename", "Error: No password was provided via the 'new-pass' POST parameter.
")); } if(empty($settings->users->{$_POST["user"]})) { http_response_code(404); exit(page_renderer::render_main("User not found - Set Password - $settings->sitename", "Error: No user called {$_POST["user"]} was found, so their password can't be set. Perhaps you forgot to create the user first?
")); } $settings->users->{$_POST["user"]}->password = hash_password($_POST["new-pass"]); if(!save_settings()) { http_response_code(503); exit(page_renderer::render_main("Server Error - Set Password - $settings->sitename", "Error: $settings->sitename couldn't save the settings back to disk! Nothing has been changed. Please context $settings->admindetails_name, whose email address can be found at the bottom of this page.
")); } exit(page_renderer::render_main("Set Password - $settings->sitename", "" . htmlentities($_POST["user"]) . "'s password has been set successfully. Go back to the user table.
")); }); /** * @api {post} ?action=user-delete Delete a user account * @apiName UserDelete * @apiGroup Settings * @apiPermission Moderator * * @apiParam {string} user The username of the account to delete. username. */ /* * ██ ██ ███████ ███████ ██████ * ██ ██ ██ ██ ██ ██ * ██ ██ ███████ █████ ██████ █████ * ██ ██ ██ ██ ██ ██ * ██████ ███████ ███████ ██ ██ * * ██████ ███████ ██ ███████ ████████ ███████ * ██ ██ ██ ██ ██ ██ ██ * ██ ██ █████ ██ █████ ██ █████ * ██ ██ ██ ██ ██ ██ ██ * ██████ ███████ ███████ ███████ ██ ███████ */ add_action("user-delete", function() { global $env, $settings; if(!$env->is_admin || !$env->is_logged_in) { http_response_code(403); exit(page_renderer::render_main("Error - Delete User - $settings->sitename", "Error: You aren't logged in as a moderator, so you don't have permission to delete a user's account.
")); } if(empty($_GET["user"])) { http_response_code(400); exit(page_renderer::render_main("Error - Delete User - $settings->sitename", "Error: No username was provided in the user POST variable.
Error: No user called {$_GET["user"]} was found, so their account can't be delete. Perhaps you spelt their account name incorrectly?
")); } email_user($_GET["user"], "Account Deletion", "Hello, {$_GET["user"]}! This is a notification email from $settings->sitename, to let you know that $env->user has deleted your user account, so you won't be able to log in to your account anymore. If this was done in error, then please contact a moderator, or $settings->admindetails_name ($settings->sitename's Administrator) - whose email address can be found at the bottom of every page on $settings->sitename. --$settings->sitename Powered by Pepperminty Wiki (Received this email in error? Please contact $settings->sitename's administrator as detailed above, as replying to this email may or may not reach a human at the other end)"); // Actually delete the account unset($settings->users->{$_GET["user"]}); if(!save_settings()) { http_response_code(503); exit(page_renderer::render_main("Server Error - Delete User - $settings->sitename", "Error: $settings->sitename couldn't save the settings back to disk! Nothing has been changed. Please context $settings->admindetails_name, whose email address can be found at the bottom of this page.
")); } exit(page_renderer::render_main("Delete User - $settings->sitename", "" . htmlentities($_GET["user"]) . "'s account has been deleted successfully. Go back to the user table.
")); }); if($env->is_admin) add_help_section("949-user-table", "Managing User Accounts", "As a moderator on $settings->sitename, you can use the User Table to adminstrate the user accounts on $settings->sitename. It allows you to perform actions such as adding and removing accounts, and resetting passwords.
"); } ]); /** * Generates a new (cryptographically secure) random password that's also readable (i.e. consonant-vowel-consonant). * This implementation may be changed in the future to use random dictionary words instead - ref https://xkcd.com/936/ * @param string $length The length of password to generate. * @return string The generated random password. */ function generate_password($length) { $vowels = "aeiou"; $consonants = "bcdfghjklmnpqrstvwxyz"; $result = ""; for($i = 0; $i < $length; $i++) { if($i % 2 == 0) $result .= $consonants[random_int(0, strlen($consonants) - 1)]; else $result .= $vowels[random_int(0, strlen($vowels) - 1)]; } return $result; } register_module([ "name" => "Credits", "version" => "0.7.9", "author" => "Starbeamrainbowlabs", "description" => "Adds the credits page. You *must* have this module :D", "id" => "page-credits", "code" => function() { /** * @api {get} ?action=credits Get the credits page * @apiName Credits * @apiGroup Utility * @apiPermission Anonymous */ /* * ██████ ██████ ███████ ██████ ██ ████████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██████ █████ ██ ██ ██ ██ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ██ ███████ ██████ ██ ██ ███████ */ add_action("credits", function() { global $settings, $version, $pageindex, $modules; $credits = [ "Code" => [ "author" => "Starbeamrainbowlabs", "author_url" => "https://starbeamrainbowlabs.com/", "thing_url" => "https://github.com/sbrl/Pepprminty-Wiki", "icon" => "https://avatars0.githubusercontent.com/u/9929737?v=3&s=24" ], "Mime type to file extension mapper" => [ "author" => "Chaos", "author_url" => "https://stackoverflow.com/users/47529/chaos", "thing_url" => "https://stackoverflow.com/a/1147952/1460422", "icon" => "https://www.gravatar.com/avatar/aaee40db39ad6b164cfb89cb6ad4d176?s=328&d=identicon&s=24" ], "Parsedown" => [ "author" => "Emanuil Rusev and others", "author_url" => "https://github.com/erusev/", "thing_url" => "https://github.com/erusev/parsedown/", "icon" => "https://avatars1.githubusercontent.com/u/184170?v=3&s=24" ], "CSS Minification Code" => [ "author" => "Jean", "author_url" => "http://www.catswhocode.com/", "thing_url" => "http://www.catswhocode.com/blog/3-ways-to-compress-css-files-using-php" ], "Slightly modified version of Slimdown" => [ "author" => "Johnny Broadway", "author_url" => "https://github.com/jbroadway", "thing_url" => "https://gist.github.com/jbroadway/2836900", "icon" => "https://avatars2.githubusercontent.com/u/87886?v=3&s=24" ], "Insert tab characters into textareas" => [ "author" => "Unknown", "author_url" => "http://stackoverflow.com/q/6140632/1460422", "thing_url" => "https://jsfiddle.net/2wAzx/13/", ], "Default Favicon" => [ "author" => "bluefrog23", "author_url" => "https://openclipart.org/user-detail/bluefrog23/", "thing_url" => "https://openclipart.org/detail/19571/peppermint-candy-by-bluefrog23" ], "Bug Reports" => [ "author" => "nibreh", "author_url" => "https://github.com/nibreh/", "thing_url" => "", "icon" => "https://avatars2.githubusercontent.com/u/7314006?v=3&s=24" ], "More Bug Reports (default credentials + downloader; via Gitter)" => [ "author" => "Tyler Spivey", "author_url" => "https://github.com/tspivey/", "thing_url" => "", "icon" => "https://avatars2.githubusercontent.com/u/709407?v=4&s=24" ], "PR #135: Fix repeated page names on sidebar" => [ "author" => "ikisler", "author_url" => "https://github.com/ikisler", "thing_url" => "https://github.com/sbrl/Pepperminty-Wiki/pull/135", "icon" => "https://avatars3.githubusercontent.com/u/12506147?v=3&s=24" ], "PR #136: Fix issue where bottom nav is cut off" => [ "author" => "ikisler", "author_url" => "https://github.com/ikisler", "thing_url" => "https://github.com/sbrl/Pepperminty-Wiki/pull/136", "icon" => "https://avatars3.githubusercontent.com/u/12506147?v=3&s=24" ], "PR #140: Edit Previewing" => [ "author" => "ikisler", "author_url" => "https://github.com/ikisler", "thing_url" => "https://github.com/sbrl/Pepperminty-Wiki/pull/140", "icon" => "https://avatars3.githubusercontent.com/u/12506147?v=3&s=24" ], "Issue #153: Authenticated DOS attack (XXD billion laughs attack)" => [ "author" => "ProDigySML", "author_url" => "https://github.com/ProDigySML", "thing_url" => "https://github.com/sbrl/Pepperminty-Wiki/issues/152", "icon" => "https://avatars3.githubusercontent.com/u/16996819?s=24&v=4" ] ]; //// Credits html renderer //// $credits_html = "- \n";
foreach($credits as $thing => $author_details)
{
$credits_html .= "
- ";
$credits_html .= "$thing by ";
if(isset($author_details["icon"]))
$credits_html .= "
"; $credits_html .= "" . $author_details["author"] . ""; $credits_html .= "
\n";
}
$credits_html .= "
| Name | Version | Author | Description |
|---|---|---|---|
| " . $module["name"] . " | " . $module["version"] . " | " . $module["author"] . " | " . $module["description"] . " |
$settings->sitename credits
$settings->sitename is powered by Pepperminty Wiki - an entire wiki packed inside a single file, which was built by Starbeamrainbowlabs, and can be found on GitHub (contributors will also be listed here in the future). Pepperminty Wiki is licensed under the Mozilla Public License 2.0 (simple version).
Main Credits
$credits_htmlSite status
| Site name: | $settings->sitename ({$settings->admindisplaychar}Update, {$settings->admindisplaychar} 🔧 Edit master settings, {$settings->admindisplaychar} 👥 Edit user table, 🏛 Export as zip - Check for permission first) |
|---|---|
| Pepperminty Wiki version: | $version |
| Number of pages: | " . count(get_object_vars($pageindex)) . " |
| Number of modules: | " . count($modules) . " |
Installed Modules
$modules_html"; exit(page_renderer::render_main($title, $content)); }); } ]); register_module([ "name" => "Debug Information", "version" => "0.1.1", "author" => "Starbeamrainbowlabs", "description" => "Adds a debug action for administrator use only that collects a load of useful information to make reporting bugs easier.", "id" => "page-debug-info", "code" => function() { global $settings, $env; /** * @api {get} ?action=debug Get a debug dump * @apiName Debug * @apiGroup Utility * @apiPermission Moderator * * @apiUse UserNotModeratorError */ /* * ██████ ███████ ██████ ██ ██ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ █████ ██████ ██ ██ ██ ███ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ███████ ██████ ██████ ██████ */ add_action("debug", function() { global $settings, $env, $paths, $version, $commit; header("content-type: text/plain"); if(!$env->is_admin) { exit("You must be logged in as an moderator in order to generate debugging information."); } $title = "$settings->sitename debug report"; echo("$title\n"); echo(str_repeat("=", strlen($title)) . "\n"); echo("Powered by Pepperminty Wiki version $version+" . substr($commit, 0, 7) . ".\n"); echo("This report may contain personal information.\n\n"); echo("Environment: "); echo(var_export($env, true)); echo("\nPaths: "); var_dump(var_export($paths, true)); echo("\nServer information:\n"); echo("uname -a: " . php_uname() . "\n"); echo("Path: " . getenv("PATH") . "\n"); echo("Temporary directory: " . sys_get_temp_dir() . "\n"); echo("Server: " . $_SERVER["SERVER_SOFTWARE"] . "\n"); echo("Web root: " . $_SERVER["DOCUMENT_ROOT"] . "\n"); echo("Web server user: " . exec("whoami") . "\n"); echo("PHP version: " . phpversion() . "\n"); echo("index.php location: " . __FILE__ . "\n"); echo("index.php file permissions: " . substr(sprintf('%o', fileperms("./index.php")), -4) . "\n"); echo("Current folder permissions: " . substr(sprintf('%o', fileperms(".")), -4) . "\n"); echo("Storage directory permissions: " . substr(sprintf('%o', fileperms($env->storage_prefix)), -4) . "\n"); echo("Loaded extensions: " . implode(", ", get_loaded_extensions()) . "\n"); echo("Settings:\n-----\n"); $settings_export = explode("\n", var_export($settings, true)); foreach ($settings_export as &$row) { if(preg_match("/(sitesecret|email)/i", $row)) $row = "********* secret *********"; } echo(implode("\n", $settings_export)); echo("\n-----\n"); exit(); }); if($env->is_admin) { add_help_section("950-debug-information", "Gathering debug information", "As a moderator, $settings->sitename gives you the ability to generate a report on $settings->sitename's installation of Pepperminty Wiki for debugging purposes.
To generate such a report, visit the debug action or click here.
You tried to delete $env->page, but editing is disabled on this wiki.
If you wish to delete this page, please re-enable editing on this wiki first.
Nothing has been changed.
")); } if(!$env->is_admin) { exit(page_renderer::render_main("Error: Insufficient permissions - Deleting $env->page", "You tried to delete $env->page, but you as aren't a moderator you don't have permission to do that.
You could try logging in as an admin, or asking one of $settings->sitename's friendly moderators (find their names at the bottom of every page!) to delete it for you.
")); } if(!isset($pageindex->{$env->page})) { exit(page_renderer::render_main("Error: Non-existent page - Deleting $env->page", "You tried to delete $env->page, but that page doesn't appear to exist in the first page. Go back to the $settings->defaultpage.
")); } if(!isset($_GET["delete"]) or $_GET["delete"] !== "yes") { exit(page_renderer::render_main("Deleting $env->page", "You are about to delete $env->page" . (module_exists("feature-history")?" and all its revisions":"") . (module_exists("feature-comments")?" and all its comments":"") . ". You can't undo this!
Click here to delete $env->page.
Click here to go back.")); } $page = $env->page; // Delete the associated file if it exists if(!empty($pageindex->$page->uploadedfile)) { unlink($env->storage_prefix . $pageindex->$page->uploadedfilepath); } // While we're at it, we should delete all the revisions too foreach($pageindex->{$env->page}->history as $revisionData) { unlink($env->storage_prefix . $revisionData->filename); } // If the commenting module is installed and the page has comments, // delete those too if(module_exists("feature-comments") and file_exists(get_comment_filename($env->page))) { unlink(get_comment_filename($env->page)); } // Delete the page from the page index unset($pageindex->$page); // Save the new page index file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT)); // Remove the page's name from the id index ids::deletepagename($env->page); // Delete the page from the search index, if that module is installed if(module_exists("feature-search")) { $pageid = ids::getid($env->page); $invindex = search::load_invindex($paths->searchindex); search::delete_entry($invindex, $pageid); search::save_invindex($paths->searchindex, $invindex); } // Delete the page from the disk unlink("$env->storage_prefix$env->page.md"); // Add a recent change announcing the deletion if the recent changes // module is installed if(module_exists("feature-recent-changes")) { add_recent_change([ "type" => "deletion", "timestamp" => time(), "page" => $env->page, "user" => $env->user, ]); } exit(page_renderer::render_main("Deleting $env->page - $settings->sitename", "
$env->page has been deleted. Go back to the main page.
")); }); // Register a help section add_help_section("60-delete", "Deleting Pages", "If you are logged in as an adminitrator, then you have the power to delete pages. To do this, click "Delete" in the "More..." menu when browsing the pge you wish to delete. When you are sure that you want to delete the page, click the given link.
Warning: Once a page has been deleted, you can't bring it back! You will need to recover it from your backup, if you have one (which you really should).
"); } ]); register_module([ "name" => "Page editor", "version" => "0.17.3", "author" => "Starbeamrainbowlabs", "description" => "Allows you to edit pages by adding the edit and save actions. You should probably include this one.", "id" => "page-edit", "code" => function() { global $settings, $env; // Download diff.min.js - which we use when displaying edit conflicts register_remote_file([ "local_filename" => "diff.min.js", "remote_url" => "https://cdnjs.cloudflare.com/ajax/libs/jsdiff/2.2.2/diff.min.js" ]); /** * @api {get} ?action=edit&page={pageName}[&newpage=yes] Get an editing page * @apiDescription Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead. * @apiName EditPage * @apiGroup Editing * @apiPermission Anonymous * * @apiUse PageParameter * @apiParam {string} newpage Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the `save` action. */ /* * _ _ _ * ___ __| (_) |_ * / _ \/ _` | | __| * | __/ (_| | | |_ * \___|\__,_|_|\__| * %edit% */ add_action("edit", function() { global $pageindex, $settings, $env; $filename = "$env->storage_prefix$env->page.md"; $creatingpage = !isset($pageindex->{$env->page}); if((isset($_GET["newpage"]) and $_GET["newpage"] == "true") or $creatingpage) { $title = "Creating $env->page"; } else if(isset($_POST['preview-edit']) && isset($_POST['content'])) { $title = "Preview Edits for $env->page"; } else { $title = "Editing $env->page"; } $pagetext = ""; if(isset($pageindex->{$env->page})) { $pagetext = file_get_contents($filename); } $isOtherUsersPage = false; if( $settings->user_page_prefix == mb_substr($env->page, 0, mb_strlen($settings->user_page_prefix)) and // The current page is a user page of some sort ( !$env->is_logged_in or // the user isn't logged in..... extract_user_from_userpage($env->page) !== $env->user // ...or it's not under this user's own name ) ) { $isOtherUsersPage = true; } if((!$env->is_logged_in and !$settings->anonedits) or // if we aren't logged in and anonymous edits are disabled !$settings->editing or // or editing is disabled ( isset($pageindex->{$env->page}) and // or if the page exists isset($pageindex->{$env->page}->protect) and // the protect property exists $pageindex->{$env->page}->protect and // the protect property is true !$env->is_admin // the user isn't an admin ) or $isOtherUsersPage // this page actually belongs to another user ) { if(!$creatingpage) { // The page already exists - let the user view the page source $sourceViewContent = "$settings->sitename does not allow anonymous users to make edits. You can view the source of $env->page below, but you can't edit it. You could, however, try logging in.
\n"; if($env->is_logged_in) $sourceViewContent = "$env->page is protected, and you aren't an administrator or moderator. You can view the source of $env->page below, but you can't edit it.
\n"; if(!$settings->editing) $sourceViewContent = "$settings->sitename currently has editing disabled, so you can't make changes to this page at this time. Please contact $settings->admindetails_name, $settings->sitename's administrator for more information - their contact details can be found at the bottom of this page. Even so, you can still view the source of this page. It's disabled below:
"; if($isOtherUsersPage) $sourceViewContent = "$env->page is a special user page which acutally belongs to " . extract_user_from_userpage($env->page) . ", another user on $settings->sitename. Because of this, you are not allowed to edit it (though you can always edit your own page and any pages under it if you're logged in). You can, however, vieww it's source below.
"; // Append a view of the page's source $sourceViewContent .= ""; exit(page_renderer::render_main("Viewing source for $env->page", $sourceViewContent)); } else { $errorMessage = "The page $env->page does not exist, but you do not have permission to create it.
If you haven't already, perhaps you should try logging in.
\n"; if($isOtherUsersPage) { $errorMessage = "The page " . htmlentities($env->page) . " doesn't exist, but you can't create it because it's a page belonging to another user.
You could try logging in.
\n"; } http_response_code(404); exit(page_renderer::render_main("404 - $env->page", $errorMessage)); } } $content = "$title
\n"; $page_tags = implode(", ", (!empty($pageindex->{$env->page}->tags)) ? $pageindex->{$env->page}->tags : []); if(!$env->is_logged_in and $settings->anonedits) { $content .= "Warning: You are not logged in! Your IP address may be recorded.
"; } // Include preview, if set if(isset($_POST['preview-edit']) && isset($_POST['content'])) { // Need this for the prev-content-hash to prevent the conflict page from appearing $old_pagetext = $pagetext; // set the page content to the newly edited content $pagetext = $_POST['content']; // Set the tags to the new tags, if needed if(isset($_POST['tags'])) $page_tags = $_POST['tags']; // Insert the "view" part of the page we're editing $content .= "" . parse_page_source($pagetext); } $content .= " "; // Allow tab characters in the page editor page_renderer::add_js_snippet("window.addEventListener('load', function(event) { // Adapted from https://jsfiddle.net/2wAzx/13/ document.querySelector(\"[name=content]\").addEventListener(\"keydown\", (event) => { if(event.keyCode !== 9) return true; var currentValue = event.target.value, startPos = event.target.selectionStart, endPos = event.target.selectionEnd; event.target.value = currentValue.substring(0, startPos) + \"\\t\" + currentValue.substring(endPos); event.target.selectionStart = event.target.selectionEnd = startPos + 1; event.stopPropagation(); event.preventDefault(); return false; }); });"); // Utilise the mirror to automatically resize the textarea to fit it's content page_renderer::add_js_snippet('function updateTextSize(textarea, mirror, event) { let textareaFontSize = parseFloat(getComputedStyle(textarea).fontSize); let textareaWidth = textarea.getBoundingClientRect().width;// - parseInt(textarea.style.padding); mirror.style.width = `${textareaWidth}px`; mirror.innerText = textarea.value; textarea.style.height = `${mirror.offsetHeight + (textareaFontSize * 5)}px`; } function trackTextSize(textarea) { let mirror = textarea.nextElementSibling; textarea.addEventListener("input", updateTextSize.bind(null, textarea, mirror)); updateTextSize(textarea, mirror, null); } window.addEventListener("load", function(event) { trackTextSize(document.querySelector("textarea[name=content]")); }); '); // ~ /// ~~~ Smart saving ~~~ /// page_renderer::add_js_snippet('window.addEventListener("load", function(event) { "use strict"; // Smart saving let getSmartSaveKey = function() { return document.querySelector("main h1").innerHTML.replace("Creating ", "").replace("Editing ", "").trim(); } // Saving document.querySelector("textarea[name=content]").addEventListener("keyup", function(event) { window.localStorage.setItem(getSmartSaveKey(), event.target.value) }); // Loading var editor = document.querySelector("textarea[name=content]"); let smartsave_restore = function() { editor.value = localStorage.getItem(getSmartSaveKey()); } if(editor.value.length === 0) // Don\'t restore if there\'s data in the editor already smartsave_restore(); document.querySelector(".smartsave-restore").addEventListener("click", function(event) { event.stopPropagation(); event.preventDefault(); smartsave_restore(); }); });'); exit(page_renderer::render_main("$title - $settings->sitename", $content)); }); /** * @api {post} ?action=preview-edit&page={pageName}[&newpage=yes] Get a preview of the page * @apiDescription Gets a preview of the current edit state of a given page * @apiName PreviewPage * @apiGroup Editing * @apiPermission Anonymous * * @apiUse PageParameter * @apiParam {string} newpage Set to 'yes' if a new page is being created. * @apiParam {string} preview-edit Set to a value to preview an edit of a page. */ /* * * ██████ ██████ ███████ ██ ██ ██ ███████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ █████ ██ ██ ██ █████ ██ █ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ * ██ ██ ██ ███████ ████ ██ ███████ ███ ███ * * ███████ ██████ ██ ████████ * ██ ██ ██ ██ ██ * █████ ██ ██ ██ ██ * ██ ██ ██ ██ ██ * ███████ ██████ ██ ██ * */ add_action("preview-edit", function() { global $pageindex, $settings, $env, $actions; if(isset($_POST['preview-edit']) && isset($_POST['content'])) { // preview changes get_object_vars($actions)['edit'](); } else { // save page get_object_vars($actions)['save'](); } }); /** * @api {post} ?action=acquire-edit-key&page={pageName} Acquire an edit key for a page * @apiDescription Returns an edit key that can be used to programmatically save an edit to a page. It does _not_ necessarily mean that such an edit will be saved. For example, editing might be disabled, or you might not have permission to save an edit on a particular page. * @apiName AcquireEditKey * @apiGroup Editing * @apiPermission Anonymous * * @apiUse PageParameter * @apiPara {string} format The format ot return the edit key in. Possible values: text, json. Default: text. */ /* * █████ ██████ ██████ ██ ██ ██ ██████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ██ ██ ██ ██ ██████ █████ █████ * ██ ██ ██ ██ ▄▄ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██████ ██████ ██████ ██ ██ ██ ███████ * ▀▀ * * ███████ ██████ ██ ████████ * ██ ██ ██ ██ ██ * █████ ██ ██ ██ ██ █████ * ██ ██ ██ ██ ██ * ███████ ██████ ██ ██ * * ██ ██ ███████ ██ ██ * ██ ██ ██ ██ ██ * █████ █████ ████ * ██ ██ ██ ██ * ██ ██ ███████ ██ */ add_action("acquire-edit-key", function() { global $env; if(!file_exists($env->page_filename)) { http_response_code(404); header("content-type: text/plain"); exit("Error: The page '$env->page' couldn't be found."); } $format = $_GET["format"] ?? "text"; $page_hash = generate_page_hash(file_get_contents($env->page_filename)); switch($format) { case "text": header("content-type: text/plain"); exit("$env->page\t$page_hash"); case "json": $result = new stdClass(); $result->page = $env->page; $result->key = $page_hash; header("content-type: application/json"); exit(json_encode($result)); default: http_response_code(406); header("content-type: text/plain"); exit("Error: The format $format is not currently known. Supported formats: text, json. Default: text.\nThink this is a bug? Open an issue at https://github.com/sbrl/Pepperminty-Wiki/issues/new"); } }); /** * @api {post} ?action=save&page={pageName} Save an edit to a page * @apiDescription Saves an edit to a page. If an edit conflict is encountered, then a conflict resolution page is returned instead. * @apiName SavePage * @apiGroup Editing * @apiPermission Anonymous * * @apiUse PageParameter * @apiParam {string} newpage GET only. Set to 'yes' to indicate that this is a new page that is being saved. Only affects the HTTP response code you recieve upon success. * @apiParam {string} content POST only. The new content to save to the given filename. * @apiParam {string} tags POST only. A comma-separated list of tags to assign to the current page. Will replace the existing list of tags, if any are present. * @apiParam {string} prev-content-hash POST only. The hash of the original content before editing. If this hash is found to be different to a hash computed of the currentl saved content, a conflict resolution page will be returned instead of saving the provided content. * * @apiError UnsufficientPermissionError You don't currently have sufficient permissions to save an edit. */ /* * * ___ __ ___ _____ * / __|/ _` \ \ / / _ \ * \__ \ (_| |\ V / __/ * |___/\__,_| \_/ \___| * %save% */ add_action("save", function() { global $pageindex, $settings, $env, $save_preprocessors, $paths; if(!$settings->editing) { header("x-failure-reason: editing-disabled"); header("location: index.php?page=" . rawurlencode($env->page)); exit(page_renderer::render_main("Error saving edit", "Editing is currently disabled on this wiki.
")); } if(!$env->is_logged_in and !$settings->anonedits) { http_response_code(403); header("refresh: 5; url=index.php?page=" . rawurlencode($env->page)); header("x-login-required: yes"); exit("You are not logged in, so you are not allowed to save pages on $settings->sitename. Redirecting in 5 seconds...."); } if(( isset($pageindex->{$env->page}) and isset($pageindex->{$env->page}->protect) and $pageindex->{$env->page}->protect ) and !$env->is_admin) { http_response_code(403); header("refresh: 5; url=index.php?page=" . rawurlencode($env->page)); exit(htmlentities($env->page) . " is protected, and you aren't logged in as an administrator or moderator. Your edit was not saved. Redirecting in 5 seconds..."); } if(!isset($_POST["content"])) { http_response_code(400); header("refresh: 5; url=index.php?page=" . rawurlencode($env->page)); exit("Bad request: No content specified."); } // Make sure that the directory in which the page needs to be saved exists if(!is_dir(dirname("$env->storage_prefix$env->page.md"))) { // Recursively create the directory if needed mkdir(dirname("$env->storage_prefix$env->page.md"), 0775, true); } // Read in the new page content $pagedata = $_POST["content"]; // We don't need to santise the input here as Parsedown has an // option that does this for us, and is _way_ more intelligent about // it. // Read in the new page tags, so long as there are actually some // tags to read in $page_tags = []; if(strlen(trim($_POST["tags"])) > 0) { $page_tags = explode(",", $_POST["tags"]); // Trim off all the whitespace foreach($page_tags as &$tag) $tag = trim($tag); } // Check for edit conflicts if(!empty($pageindex->{$env->page}) && file_exists($env->storage_prefix . $pageindex->{$env->page}->filename)) { $existing_content_hash = sha1_file($env->storage_prefix . $pageindex->{$env->page}->filename); if(isset($_POST["prev-content-hash"]) and $existing_content_hash != $_POST["prev-content-hash"]) { $existingPageData = htmlentities(file_get_contents($env->storage_prefix . $env->storage_prefix . $pageindex->{$env->page}->filename)); // An edit conflict has occurred! We should get the user to fix it. $content = "Resolving edit conflict - $env->page
"; if(!$env->is_logged_in and $settings->anonedits) { $content .= "Warning: You are not logged in! Your IP address may be recorded.
"; } $content .= "An edit conflict has arisen because someone else has saved an edit to " . htmlentities($env->page) . " since you started editing it. Both texts are shown below, along the differences between the 2 conflicting revisions. To continue, please merge your changes with the existing content. Note that only the text in the existing content box will be kept when you press the \"Resolve Conflict\" button at the bottom of the page.
"; // Insert a reference to jsdiff to generate the diffs $diffScript = <<<'DIFFSCRIPT' window.addEventListener("load", function(event) { var destination = document.getElementById("highlighted-diff"), diff = JsDiff.diffWords(document.getElementById("original-content").value, document.getElementById("new-content").value), output = ""; diff.forEach(function(change) { var classes = "token"; if(change.added) classes += " diff-added"; if(change.removed) classes += " diff-removed"; output += `${change.value}`; }); destination.innerHTML = output; }); DIFFSCRIPT; // diff.min.js is downloaded above $content .= "\n \n"; header("x-failure-reason: edit-conflict"); exit(page_renderer::render_main("Edit Conflict - $env->page - $settings->sitename", $content)); } } // -----~~~==~~~----- // Update the inverted search index // Construct an index for the old and new page content $oldindex = []; $oldpagedata = ""; // We need the old page data in order to pass it to the preprocessor if(file_exists("$env->storage_prefix$env->page.md")) { $oldpagedata = file_get_contents("$env->storage_prefix$env->page.md"); $oldindex = search::index($oldpagedata); } $newindex = search::index($pagedata); // Compare the indexes of the old and new content $additions = []; $removals = []; search::compare_indexes($oldindex, $newindex, $additions, $removals); // Load in the inverted index $invindex = search::load_invindex($env->storage_prefix . "invindex.json"); // Merge the changes into the inverted index search::merge_into_invindex($invindex, ids::getid($env->page), $additions, $removals); // Save the inverted index back to disk search::save_invindex($env->storage_prefix . "invindex.json", $invindex); // -----~~~==~~~----- if(file_put_contents("$env->storage_prefix$env->page.md", $pagedata) !== false) { // Make sure that this page's parents exist check_subpage_parents($env->page); // Update the page index if(!isset($pageindex->{$env->page})) { $pageindex->{$env->page} = new stdClass(); $pageindex->{$env->page}->filename = "$env->page.md"; } $pageindex->{$env->page}->size = strlen($_POST["content"]); $pageindex->{$env->page}->lastmodified = time(); if($env->is_logged_in) $pageindex->{$env->page}->lasteditor = $env->user; else // TODO: Add an option to record the user's IP here instead $pageindex->{$env->page}->lasteditor = "anonymous"; $pageindex->{$env->page}->tags = $page_tags; // A hack to resave the pagedata if the preprocessors have // changed it. We need this because the preprocessors *must* // run _after_ the pageindex has been updated. $pagedata_orig = $pagedata; // Execute all the preprocessors foreach($save_preprocessors as $func) { $func($pageindex->{$env->page}, $pagedata, $oldpagedata); } if($pagedata !== $pagedata_orig) file_put_contents("$env->storage_prefix$env->page.md", $pagedata); file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT)); if(isset($_GET["newpage"])) http_response_code(201); else http_response_code(200); // header("content-type: text/plain"); header("location: index.php?page=" . rawurlencode($env->page) . "&edit_status=success&redirect=no"); exit(); } else { header("x-failure-reason: server-error"); http_response_code(507); exit(page_renderer::render_main("Error saving page - $settings->sitename", "$settings->sitename failed to write your changes to the server's disk. Your changes have not been saved, but you might be able to recover your edit by pressing the back button in your browser.
Please tell the administrator of this wiki (" . $settings->admindetails_name . ") about this problem.
")); } }); add_help_section("15-editing", "Editing", "To edit a page on $settings->sitename, click the edit button on the top bar. Note that you will probably need to be logged in. If you do not already have an account you will need to ask $settings->sitename's administrator for an account since there is no registration form. Note that the $settings->sitename's administrator may have changed these settings to allow anonymous edits.
Editing is simple. The edit page has a sizeable box that contains a page's current contents. Once you are done altering it, add or change the comma separated list of tags in the field below the editor and then click save page.
A reference to the syntax that $settings->sitename supports can be found below.
"); add_help_section("17-user-pages", "User Pages", "If you are logged in, $settings->sitename allocates you your own user page that only you can edit. On $settings->sitename, user pages are sub-pages of the " . htmlentities($settings->user_page_prefix) . " page, and each user page can have a nested structure of pages underneath it, just like a normal page. Your user page is located at " . htmlentities(get_user_pagename($env->user)) . ". " . (module_exists("page-user-list") ? "You can see a list of all the users on $settings->sitename and visit their user pages on the user list." : "") . "
"); } ]); /** * Generates a unique hash of a page's content for edit conflict detection * purposes. * @param string $page_data The page text to hash. * @return string A hash of the given page text. */ function generate_page_hash($page_data) { return sha1($page_data); } register_module([ "name" => "Export", "version" => "0.5", "author" => "Starbeamrainbowlabs", "description" => "Adds a page that you can use to export your wiki as a .zip file. Uses \$settings->export_only_allow_admins, which controls whether only admins are allowed to export the wiki.", "id" => "page-export", "code" => function() { global $settings; /** * @api {get} ?action=export Export the all the wiki's content * @apiDescription Export all the wiki's content. Please ask for permission before making a request to this URI. Note that some wikis may only allow moderators to export content. * @apiName Export * @apiGroup Utility * @apiPermission Anonymous * * @apiError InsufficientExportPermissionsError The wiki has the export_allow_only_admins option turned on, and you aren't logged into a moderator account. * @apiError CouldntOpenTempFileError Pepperminty Wiki couldn't open a temporary file to send the compressed archive to. * @apiError CouldntCloseTempFileError Pepperminty Wiki couldn't close the temporary file to finish creating the zip archive ready for downloading. */ /* * ███████ ██ ██ ██████ ██████ ██████ ████████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * █████ ███ ██████ ██ ██ ██████ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ██ ██████ ██ ██ ██ */ add_action("export", function() { global $settings, $pageindex, $env; if($settings->export_allow_only_admins && !$env->is_admin) { http_response_code(401); exit(page_renderer::render("Export error - $settings->sitename", "Only administrators of $settings->sitename are allowed to export the wiki as a zip. Return to the $settings->defaultpage.")); } $tmpfilename = tempnam(sys_get_temp_dir(), "pepperminty-wiki-"); $zip = new ZipArchive(); if($zip->open($tmpfilename, ZipArchive::CREATE) !== true) { http_response_code(507); exit(page_renderer::render("Export error - $settings->sitename", "Pepperminty Wiki was unable to open a temporary file to store the exported data in. Please contact $settings->sitename's administrator (" . $settings->admindetails_name . " at " . hide_email($settings->admindetails_email) . ") for assistance.")); } foreach($pageindex as $entry) { $zip->addFile("$env->storage_prefix$entry->filename", $entry->filename); if(isset($entry->uploadedfilepath)) $zip->addFile($entry->uploadedfilepath); } if($zip->close() !== true) { http_response_code(500); exit(page_renderer::render("Export error - $settings->sitename", "Pepperminty wiki was unable to close the temporary zip file after creating it. Please contact $settings->sitename's administrator (" . $settings->admindetails_name . " at " . hide_email($settings->admindetails_email) . ") for assistance.")); } header("content-type: application/zip"); header("content-disposition: attachment; filename=$settings->sitename-export.zip"); header("content-length: " . filesize($tmpfilename)); $zip_handle = fopen($tmpfilename, "rb"); fpassthru($zip_handle); fclose($zip_handle); unlink($tmpfilename); }); // Add a section to the help page add_help_section("50-export", "Exporting", "$settings->sitename supports exporting the entire wiki's content as a zip. Note that you may need to be a moderator in order to do this. Also note that you should check for permission before doing so, even if you are able to export without asking.
To perform an export, go to the credits page and click "Export as zip - Check for permission first".
"); } ]); 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 = "$settings->sitename runs on Pepperminty Wiki, an entire wiki packed into a single file. This page contains some information that developers may find useful.
A full guide to developing a Pepperminty Wiki module can be found on GitHub.
Registered Help Sections
The following help sections are currently registered:
| Index | Title | Length |
|---|---|---|
| $index | " . $section["title"] . " | " . human_filesize($sectionLength) . " |
| Total: | " . human_filesize($totalSize) . " | |
Registered Actions
"; $registeredActions = array_keys(get_object_vars($actions)); sort($registeredActions); $content .= "The following actions are currently registered:
\n"; $content .= "" . implode(", ", $registeredActions) . "
"; $content .= "Environment
\n"; $content .= "- \n";
$content .= "
- $settings->sitename's root directory is " . (!is_writeable(__DIR__) ? "not " : "") . "writeable. \n"; $content .= "
- The page index is currently " . human_filesize(filesize($paths->pageindex)) . " in size, and took " . $env->perfdata->pageindex_decode_time . "ms to decode. "; if(module_exists("feature-search")) { search::measure_invindex_load_time($paths->searchindex); $content .= "
- The search index is currently " . human_filesize(filesize($paths->searchindex)) . " in size, and took " . $env->perfdata->searchindex_decode_time . "ms to decode. "; } $content .= "
- The id index is currently " . human_filesize(filesize($paths->idindex)) . " in size, and took " . $env->perfdata->idindex_decode_time . "ms to decode. "; $content .= "
Data
\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 .= "$settings->sitename is currently " . human_filesize($wikiSize->all) . " in size.
\n"; $content .= ""; } else { $title = "Help - $settings->sitename"; $content = "$settings->sitename Help
Welcome to $settings->sitename!
$settings->sitename is powered by Pepperminty Wiki, a complete wiki in a box you can drop into your server and expect it to just work.
"; // 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 .= "" . $section["title"] . "
\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", "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.
This page, along with the credits page, can be found on the bar at the bottom of every page.
"); add_help_section("1-extra", "Extra Information", "You can find out whch version of Pepperminty Wiki $settings->sitename is using by visiting the credits page.
Information for developers can be found on this page.
"); } ]); register_module([ "name" => "Page list", "version" => "0.11", "author" => "Starbeamrainbowlabs", "description" => "Adds a page that lists all the pages in the index along with their metadata.", "id" => "page-list", "code" => function() { global $settings; /** * @api {get} ?action=list[&format={format}] List all pages * @apiDescription Gets a list of all the pages currently stored on the wiki. * @apiName ListPages * @apiGroup Page * @apiPermission Anonymous * * @apiParam {string} format The format to return the page list in. Default: html. Other foramts available: json, text */ /* * ██ ██ ███████ ████████ * ██ ██ ██ ██ * ██ ██ ███████ ██ * ██ ██ ██ ██ * ███████ ██ ███████ ██ */ add_action("list", function() { global $pageindex, $settings; $supported_formats = [ "html", "json", "text" ]; $format = $_GET["format"] ?? "html"; $sorted_pageindex = get_object_vars($pageindex); ksort($sorted_pageindex, SORT_NATURAL); switch($format) { case "html": $title = "All Pages"; $content = "$title on $settings->sitename
"; $content .= generate_page_list(array_keys($sorted_pageindex)); exit(page_renderer::render_main("$title - $settings->sitename", $content)); break; case "json": header("content-type: application/json"); exit(json_encode(array_keys($sorted_pageindex), JSON_PRETTY_PRINT)); case "text": header("content-type: text/plain"); exit(implode("\n", array_keys($sorted_pageindex))); default: http_response_code(400); exit(page_renderer::render_main("Format error - $settings->sitename", "Error: The format '$format' is not currently supported by this action on $settings->sitename. Supported formats: " . implode(", ", $supported_formats) . ".")); } }); /** * @api {get} ?action=list-tags[&tag=] Get a list of tags or pages with a certain tag * @apiDescription Gets a list of all tags on the wiki. Adding the `tag` parameter causes a list of pages with the given tag to be returned instead. * @apiName ListTags * @apiGroup Utility * @apiPermission Anonymous * * @apiParam {string} tag Optional. If provided a list of all the pages with that tag is returned instead. * @apiParam {string} format Optional. If specified sets the format of the returned result. Supported values: html, json. Default: html */ /* * ██ ██ ███████ ████████ ████████ █████ ██████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ███████ ██ █████ ██ ███████ ██ ███ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ███████ ██ ██ ██ ██ ██████ ███████ */ add_action("list-tags", function() { global $pageindex, $settings; $supported_formats = [ "html", "json", "text" ]; $format = $_GET["format"] ?? "html"; if(!in_array($format, $supported_formats)) { http_response_code(400); exit(page_renderer::render_main("Format error - $settings->sitename", "
Error: The format '$format' is not currently supported by this action on $settings->sitename. Supported formats: " . implode(", ", $supported_formats) . ".")); } if(!isset($_GET["tag"])) { // Render a list of all tags $all_tags = get_all_tags(); sort($all_tags, SORT_NATURAL); switch($format) { case "html": $content = "
All tags
\n"; exit(page_renderer::render("All tags - $settings->sitename", $content)); break; case "json": header("content-type: application/json"); exit(json_encode($all_tags, JSON_PRETTY_PRINT)); case "text": header("content-type: text/plain"); exit(implode("\n", $all_tags)); } } $tag = $_GET["tag"]; $sorted_pageindex = get_object_vars($pageindex); ksort($sorted_pageindex, SORT_NATURAL); $pagelist = []; foreach($pageindex as $pagename => $pagedetails) { if(empty($pagedetails->tags)) continue; if(in_array($tag, $pagedetails->tags)) $pagelist[] = $pagename; } switch($format) { case "html": $content = "Tag List: $tag
\n"; $content .= generate_page_list($pagelist); $content .= "(All tags)
\n"; exit(page_renderer::render("$tag - Tag List - $settings->sitename", $content)); case "json": header("content-type: application/json"); exit(json_encode($pagelist, JSON_PRETTY_PRINT)); case "text": header("content-type: text/plain"); exit(implode("\n", $pagelist)); } }); statistic_add([ "id" => "tag-count", "name" => "Number of Tags", "type" => "scalar", "update" => function($old_data) { global $pageindex; $result = new stdClass(); // value, state, completed $result->value = count(get_all_tags()); $result->completed = true; return $result; } ]); statistic_add([ "id" => "tags-per-page", "name" => "Average Number of Tags per Page", "type" => "scalar", "update" => function($old_data) { global $pageindex; $tag_counts = []; foreach($pageindex as $page_entry) $tag_counts[] = count($page_entry->tags ?? []); $result = new stdClass(); // value, state, completed $result->value = round(array_sum($tag_counts) / count($tag_counts), 3); $result->completed = true; return $result; } ]); statistic_add([ "id" => "most-tags", "name" => "Most tags on a single page", "type" => "scalar", "update" => function($old_data) { global $pageindex; $highest_tag_count = 0; $highest_tag_page = ""; foreach($pageindex as $pagename => $page_entry) { if(count($page_entry->tags ?? []) > $highest_tag_count) { $highest_tag_count = count($page_entry->tags ?? []); $highest_tag_page = $pagename; } } $result = new stdClass(); // value, state, completed $result->value = "$highest_tag_count (" . htmlentities($highest_tag_page) . ")"; $result->completed = true; return $result; } ]); statistic_add([ "id" => "untagged-pages", "name" => "Untagged Pages", "type" => "page-list", "update" => function($old_data) { global $pageindex; $untagged_pages = []; foreach($pageindex as $pagename => $page_entry) { if(empty($page_entry->tags) || count($page_entry->tags ?? []) == 0) $untagged_pages[] = $pagename; } sort($untagged_pages, SORT_STRING | SORT_FLAG_CASE); $result = new stdClass(); // value, state, completed $result->value = $untagged_pages; $result->completed = true; return $result; } ]); add_help_section("30-all-pages-tags", "Listing pages and tags", "All the pages and tags on $settings->sitename are listed on a pair of pages to aid navigation. The list of all pages on $settings->sitename can be found by clicking "All Pages" on the top bar. The list of all the tags currently in use can be found by clicking "All Tags" in the "More..." menu in the top right.
Each tag on either page can be clicked, and leads to a list of all pages that possess that particular tag.
Redirect pages are shown in italics. A page's last known editor is also shown next to each entry on a list of pages, along with the last known size (which should correct, unless it was changed outside of $settings->sitename) and the time since the last modification (hovering over this will show the exact time that the last modification was made in a tooltip).
"); } ]); /** * Gets a list of all the tags currently used across the wiki. * @package page-list * @since v0.15 * @return string[] A list of all unique tags present on all pages across the wiki. */ function get_all_tags() { global $pageindex; $all_tags = []; foreach($pageindex as $page_entry) { if(empty($page_entry->tags)) continue; foreach($page_entry->tags as $tag) { if(!in_array($tag, $all_tags)) $all_tags[] = $tag; } } return $all_tags; } /** * Renders a list of pages as HTML. * @package page-list * @param string[] $pagelist A list of page names to include in the list. * @return string The specified list of pages as HTML. */ function generate_page_list($pagelist) { global $pageindex; // ✎ ✎ 🕒 🕒 $result = "- \n";
foreach($pagelist as $pagename)
{
// Construct a list of tags that are attached to this page ready for display
$tags = "";
// Make sure that this page does actually have some tags first
if(isset($pageindex->$pagename->tags))
{
foreach($pageindex->$pagename->tags as $tag)
{
$tags .= "$tag, ";
}
$tags = substr($tags, 0, -2); // Remove the last ", " from the tag list
}
$pageDisplayName = $pagename;
if(isset($pageindex->$pagename) and
!empty($pageindex->$pagename->redirect))
$pageDisplayName = "$pageDisplayName";
$result .= "
- $pageDisplayName (" . human_filesize($pageindex->$pagename->size) . ") ✎ " . $pageindex->$pagename->lasteditor . " "; } $result .= "
Login to $settings->sitename
\n"; if(isset($_GET["failed"])) $content .= "\t\tLogin failed.
\n"; if(isset($_GET["required"])) $content .= "\t\t$settings->sitename requires that you login before continuing.
\n"; $content .= "\t\t\n"; exit(page_renderer::render_main($title, $content)); }); /** * @api {post} ?action=checklogin Perform a login * @apiName CheckLogin * @apiGroup Authorisation * @apiPermission Anonymous * * @apiParam {string} user The user name to login with. * @apiParam {string} pass The password to login with. * @apiParam {string} returnto The URL to redirect to upon a successful login. * * @apiError InvalidCredentialsError The supplied credentials were invalid. Note that this error is actually a redirect to ?action=login&failed=yes (with the returnto parameter appended if you supplied one) */ /* * ██████ ██ ██ ███████ ██████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ * ██ ███████ █████ ██ █████ * ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ██ ███████ ██████ ██ ██ * * ██ ██████ ██████ ██ ███ ██ * ██ ██ ██ ██ ██ ████ ██ * ██ ██ ██ ██ ███ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██████ ██████ ██ ██ ████ */ add_action("checklogin", function() { global $settings, $env; // Actually do the login if(isset($_POST["user"]) and isset($_POST["pass"])) { // The user wants to log in $user = $_POST["user"]; $pass = $_POST["pass"]; if(!empty($settings->users->$user) && verify_password($pass, $settings->users->$user->password)) { // Success! :D // Update the environment $env->is_logged_in = true; $env->user = $user; $env->user_data = $settings->users->{$env->user}; $new_password_hash = hash_password_update($pass, $settings->users->$user->password); // Update the password hash if($new_password_hash !== null) { $env->user_data->password = $new_password_hash; if(!save_userdata()) { http_response_code(503); exit(page_renderer::render_main("Login Error - $settings->sitename", "Your credentials were correct, but $settings->sitename was unable to log you in as an updated hash of your password couldn't be saved. Updating your password hash to the latest and strongest hashing algorithm is an important part of keeping your account secure.
Please contact $settings->admindetails_name, $settings->sitename's adminstrator, for assistance (their email address can be found at the bottom of every page, including this one).
")); } error_log("[Pepperminty Wiki] Updated password hash for $user."); } $_SESSION["$settings->sessionprefix-user"] = $user; $_SESSION["$settings->sessionprefix-pass"] = $new_password_hash ?? hash_password($pass); $_SESSION["$settings->sessionprefix-expiretime"] = time() + 60*60*24*30; // 30 days from now // Redirect to wherever the user was going http_response_code(302); header("x-login-success: yes"); if(isset($_GET["returnto"])) header("location: " . $_GET["returnto"]); else header("location: index.php"); exit(); } else { // Login failed :-( http_response_code(302); header("x-login-success: no"); $nextUrl = "index.php?action=login&failed=yes"; if(!empty($_GET["returnto"])) $nextUrl .= "&returnto=" . rawurlencode($_GET["returnto"]); header("location: $nextUrl"); exit(); } } else { http_response_code(302); $nextUrl = "index.php?action=login&failed=yes&badrequest=yes"; if(!empty($_GET["returnto"])) $nextUrl .= "&returnto=" . rawurlencode($_GET["returnto"]); header("location: $nextUrl"); exit(); } }); add_action("hash-cost-test", function() { global $env; header("content-type: text/plain"); if(!$env->is_logged_in || !$env->is_admin) { http_response_code(401); exit("Error: Only moderators are allowed to use this action."); } $time_compute = microtime(true); $cost = hash_password_compute_cost(true); $time_compute = (microtime(true) - $time_compute)*1000; $time_cost = microtime(true); password_hash("testing", PASSWORD_DEFAULT, [ "cost" => $cost ]); $time_cost = (microtime(true) - $time_cost)*1000; echo("Calculated cost: $cost ({$time_cost}ms)\n"); echo("Time taken: {$time_compute}ms\n"); exit(date("r")); }); // Register a section on logging in on the help page. add_help_section("30-login", "Logging in", "In order to edit $settings->sitename and have your edit attributed to you, you need to be logged in. Depending on the settings, logging in may be a required step if you want to edit at all. Thankfully, loggging in is not hard. Simply click the "Login" link in the top left, type your username and password, and then click login.
If you do not have an account yet and would like one, try contacting $settings->admindetails_name, $settings->sitename's administrator and ask them nicely to see if they can create you an account.
"); // Re-check the password hashing cost, if necessary do_password_hash_code_update(); } ]); /** * Recalculates and updates the password hashing cost. */ function do_password_hash_code_update() { global $settings, $paths; // There's no point if we're using Argon2i, as it doesn't take a cost if(hash_password_properties()["algorithm"] == PASSWORD_ARGON2I) return; // Skip rechecking if the automatic check has been disabled if($settings->password_cost_time_interval == -1) return; // Skip the recheck if we've done one recently if(isset($settings->password_cost_time_lastcheck) && time() - $settings->password_cost_time_lastcheck < $settings->password_cost_time_interval) return; $new_cost = hash_password_compute_cost(); // Save the new cost, but only if it's higher than the old one if($new_cost > $settings->password_cost) $settings->password_cost = $new_cost; // Save the current time in the settings $settings->password_cost_time_lastcheck = time(); file_put_contents($paths->settings_file, json_encode($settings, JSON_PRETTY_PRINT)); } /** * Figures out the appropriate algorithm & options for hashing passwords based * on the current settings. * @return array The appropriate password hashing algorithm and options. */ function hash_password_properties() { global $settings; $result = [ "algorithm" => constant($settings->password_algorithm), "options" => [ "cost" => $settings->password_cost ] ]; if(defined("PASSWORD_ARGON2I") && $result["algorithm"] == PASSWORD_ARGON2I) $result["options"] = []; return $result; } /** * Hashes the given password according to the current settings defined * in $settings. * @package page-login * @param string $pass The password to hash. * * @return string The hashed password. Uses sha3 if $settings->use_sha3 is * enabled, or sha256 otherwise. */ function hash_password($pass) { $props = hash_password_properties(); return password_hash( base64_encode(hash("sha384", $pass)), $props["algorithm"], $props["options"] ); } /** * Verifies a user's password against a pre-generated hash. * @param string $pass The user's password. * @param string $hash The hash to compare against. * @return bool Whether the password matches the has or not. */ function verify_password($pass, $hash) { $pass_transformed = base64_encode(hash("sha384", $pass)); return password_verify($pass_transformed, $hash); } /** * Determines if the provided password needs re-hashing or not. * @param string $pass The password to check. * @param string $hash The hash of the provided password to check. * @return string|null Returns null if an updaste is not required - otherwise returns the new updated hash. */ function hash_password_update($pass, $hash) { $props = hash_password_properties(); if(password_needs_rehash($hash, $props["algorithm"], $props["options"])) { return hash_password($pass); } return null; } /** * Computes the appropriate cost value for password_hash based on the settings * automatically. * Starts at 10 and works upwards in increments of 1. Goes on until a value is * found that's greater than the target - or 10x the target time elapses. * @return integer The automatically calculated password hashing cost. */ function hash_password_compute_cost($verbose = false) { global $settings; $props = hash_password_properties(); if($props["algorithm"] == PASSWORD_ARGON2I) return null; $props["options"]["cost"] = 10; $target_cost_time = $settings->password_cost_time / 1000; // The setting is in ms do { $props["options"]["cost"]++; $start_i = microtime(true); password_hash("testing", $props["algorithm"], $props["options"]); $end_i = microtime(true); if($verbose) echo("Attempt | cost = {$props["options"]["cost"]}, time = " . ($end_i - $start_i)*1000 . "ms\n"); // Iterate until we find a cost high enough // ....but don't keep going forever - try for at most 10x the target // time in total (in case the specified algorithm doesn't take a // cost parameter) } while($end_i - $start_i < $target_cost_time); return $props["options"]["cost"]; } register_module([ "name" => "Logout", "version" => "0.6.1", "author" => "Starbeamrainbowlabs", "description" => "Adds an action to let users user out. For security reasons it is wise to add this module since logging in automatically opens a session that is valid for 30 days.", "id" => "page-logout", "code" => function() { /** * @api {post} ?action=logout Logout * @apiDescription Logout. Make sure that your bot requests this URL when it is finished - this call not only clears your cookies but also clears the server's session file as well. Note that you can request this when you are already logged out and it will completely wipe your session on the server. * @apiName Logout * @apiGroup Authorisation * @apiPermission Anonymous */ /* * ██ ██████ ██████ ██████ ██ ██ ████████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ██ ███ ██ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██████ ██████ ██████ ██████ ██ */ add_action("logout", function() { global $env; $env->is_logged_in = false; unset($env->user); unset($env->user_data); //clear the session variables $_SESSION = []; session_destroy(); exit(page_renderer::render_main("Logout Successful", "Logout Successful
Logout Successful. You can login again here.
")); }); } ]); register_module([ "name" => "Page mover", "version" => "0.9.3", "author" => "Starbeamrainbowlabs", "description" => "Adds an action to allow administrators to move pages.", "id" => "page-move", "code" => function() { global $settings; /** * @api {get} ?action=move[&new_name={newPageName}] Move a page * @apiName Move * @apiGroup Page * @apiPermission Moderator * * @apiParam {string} new_name The new name to move the page to. If not set a page will be returned containing a move page form. * * @apiUse UserNotModeratorError * @apiError EditingDisabledError Editing is disabled on this wiki, so pages can't be moved. * @apiError PageExistsAtDestinationError A page already exists with the specified new name. * @apiError NonExistentPageError The page you're trying to move doesn't exist in the first place. * @apiError PreExistingFileError A pre-existing file on the server's file system was detected. */ /* * ███ ███ ██████ ██ ██ ███████ * ████ ████ ██ ██ ██ ██ ██ * ██ ████ ██ ██ ██ ██ ██ █████ * ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██████ ████ ███████ */ add_action("move", function() { global $pageindex, $settings, $env, $paths; if(!$settings->editing) { exit(page_renderer::render_main("Moving $env->page - error", "You tried to move $env->page, but editing is disabled on this wiki.
If you wish to move this page, please re-enable editing on this wiki first.
Nothing has been changed.
")); } if(!$env->is_admin) { exit(page_renderer::render_main("Moving $env->page - Error", "You tried to move $env->page, but you do not have permission to do that.
You should try logging in as an admin.
")); } if(!isset($_GET["new_name"]) or strlen($_GET["new_name"]) == 0) exit(page_renderer::render_main("Moving $env->page", "Moving $env->page
")); $new_name = makepathsafe($_GET["new_name"]); $page = $env->page; if(!isset($pageindex->$page)) exit(page_renderer::render_main("Moving $env->page - Error", "You tried to move $env->page to $new_name, but the page with the name $env->page does not exist in the first place.
Nothing has been changed.
")); if($env->page == $new_name) exit(page_renderer::render_main("Moving $env->page - Error", "You tried to move $page, but the new name you gave is the same as it's current name.
It is possible that you tried to use some characters in the new name that are not allowed and were removed.
Page names may not contain any of these characters: ?%*:|\"><()[]
Whilst moving the file associated with $env->page, $settings->sitename detected a pre-existing file on the server's file system. Because $settings->sitename can't determine whether the existing file is important to another component of $settings->sitename or it's host web server, the move have been aborted - just in case.
If you know that this move is actually safe, please get your site administrator (" . $settings->admindetails_name . ") to perform the move manually. Their contact address can be found at the bottom of every page (including this one).
")); // Move the page in the page index $pageindex->$new_name = new stdClass(); foreach($pageindex->$page as $key => $value) { $pageindex->$new_name->$key = $value; } unset($pageindex->$page); $pageindex->$new_name->filename = "$new_name.md"; // If this page has an associated file, then we should move that too if(!empty($pageindex->$new_name->uploadedfile)) { // Update the filepath to point to the description and not the image $pageindex->$new_name->filename = $pageindex->$new_name->filename . ".md"; // Move the file in the pageindex $pageindex->$new_name->uploadedfilepath = $new_name; // Move the file on disk rename($env->storage_prefix . $env->page, $env->storage_prefix . $new_name); } // Come to think about it, we should probably move the history while we're at it foreach($pageindex->$new_name->history as &$revisionData) { // We're only interested in edits if($revisionData->type !== "edit") continue; $newRevisionName = $pageindex->$new_name->filename . ".r$revisionData->rid"; // Move the revision to it's new name rename( $env->storage_prefix . $revisionData->filename, $env->storage_prefix . $newRevisionName ); // Update the pageindex entry $revisionData->filename = $newRevisionName; } // Save the updated pageindex file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT)); // Move the page on the disk rename("$env->storage_prefix$env->page.md", "$env->storage_prefix$new_name.md"); // Move the page in the id index ids::movepagename($page, $new_name); // Move the comments file as well, if it exists if(file_exists("$env->storage_prefix$env->page.comments.json")) { rename( "$env->storage_prefix$env->page.comments.json", "$env->storage_prefix$new_name.comments.json" ); } // Add a recent change announcing the move if the recent changes // module is installed if(module_exists("feature-recent-changes")) { add_recent_change([ "type" => "move", "timestamp" => time(), "oldpage" => $page, "page" => $new_name, "user" => $env->user ]); } // Exit with a nice message exit(page_renderer::render_main("Moving " . htmlentities($env->page), "" . htmlentities($env->page) . " has been moved to " . htmlentities($new_name) . " successfully.
")); }); // Register a help section add_help_section("60-move", "Moving Pages", "If you are logged in as an administrator, then you have the power to move pages. To do this, click "Move" in the "More..." menu when browsing the pge you wish to move. Type in the new name of the page, and then click "Move Page".
"); } ]); register_module([ "name" => "Update", "version" => "0.6.2", "author" => "Starbeamrainbowlabs", "description" => "Adds an update page that downloads the latest stable version of Pepperminty Wiki. This module is currently outdated as it doesn't save your module preferences.", "id" => "page-update", "code" => function() { /** * @api {get} ?action=update[do=yes] Update the wiki * @apiDescription Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. **Note also that this plugin is currently out of date. Use with extreme caution!** * @apiName Update * @apiGroup Utility * @apiPermission Moderator * * @apiParam {string} do Set to 'yes' to actually do the upgrade. Omission causes a page asking whether an update is desired instead. * @apiParam {string} secret The wiki's secret string that's stored in the settings. * * @apiUse UserNotModeratorError * @apiParam InvalidSecretError The supplied secret doesn't match up with the secret stored in the wiki's settings. */ /* * ██ ██ ██████ ██████ █████ ████████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██████ ██ ██ ███████ ██ █████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ██████ ██ ██ ██ ███████ */ add_action("update", function() { global $settings, $env; if(!$env->is_admin) { http_response_code(401); exit(page_renderer::render_main("Update - Error", "You must be an administrator to do that.
")); } if(!isset($_GET["do"]) or $_GET["do"] !== "true" or $_GET["do"] !== "yes") { exit(page_renderer::render_main("Update $settings->sitename", "This page allows you to update $settings->sitename.
Currently, $settings->sitename is using $settings->version of Pepperminty Wiki.
This script will automatically download and install the latest version of Pepperminty Wiki from the url of your choice (see settings), regardless of whether an update is actually needed (version checking isn't implemented yet).
To update $settings->sitename, fill out the form below and click click the update button.
Note that a backup system has not been implemented yet! If this script fails you will loose your wiki's code and have to re-build it.
")); } if(!isset($_GET["secret"]) or $_GET["secret"] !== $settings->sitesecret) { exit(page_renderer::render_main("Update $settings->sitename - Error", "You forgot to enter $settings->sitename's secret code or entered it incorrectly. $settings->sitename's secret can be found in the settings portion of index.php.
" . __FILE__ . ".\n";
$oldcode = file_get_contents(__FILE__);
$log .= "Fetching new code...";
$newcode = file_get_contents($settings->updateurl);
$log .= "done.\n";
$log .= "Rewriting " . __FILE__ . "...";
$settings = substr($oldcode, 0, strpos($oldcode, $settings_separator));
$code = substr($newcode, strpos($newcode, $settings_separator));
$result = $settings . $code;
$log .= "done.\n";
$log .= "Saving...";
file_put_contents(__FILE__, $result);
$log .= "done.\n";
$log .= "Update complete. I am now running on the latest version of Pepperminty Wiki.";
$log .= "The version number that I have updated to can be found on the credits or help ages.";
exit(page_renderer::render_main("Update - Success", "- " . implode("
- ", explode("\n", $log)) . "
User List
\n"; $content .= "- \n";
foreach($userList as $username)
$content .= "\t
- " . page_renderer::render_username($username) . " \n"; $content .= "
Although you can use the edit page to view a page's source, you can also ask $settings->sitename to send you the raw page source and nothing else. This feature is intented for those who want to automate their interaction with $settings->sitename.
To use this feature, navigate to the page for which you want to see the source, and then alter the action parameter in the url's query string to be raw. If the action parameter doesn't exist, add it. Note that when used on an file's page this action will return the source of the description and not the file itself.
$env->page does not exist.
Since editing is currently disabled on this wiki, you may not create this page. If you feel that this page should exist, try contacting this wiki's Administrator.
")); } } header("last-modified: " . gmdate('D, d M Y H:i:s T', $pageindex->{$env->page}->lastmodified)); // Perform a redirect if the requested page is a redirect page if(isset($pageindex->$page->redirect) && $pageindex->$page->redirect === true) { $send_redirect = true; if(isset($_GET["redirect"]) && $_GET["redirect"] == "no") $send_redirect = false; if($send_redirect) { // TODO: Send an explanatory page along with the redirect http_response_code(307); $redirectUrl = "?action=$env->action&redirected_from=" . rawurlencode($env->page); $hashCode = ""; $newPage = $pageindex->$page->redirect_target; if(strpos($newPage, "#") !== false) { // Extract the part after the hash symbol $hashCode = substr($newPage, strpos($newPage, "#") + 1); // Remove the hash from the new page name $newPage = substr($newPage, 0, strpos($newPage, "#")); } $redirectUrl .= "&page=" . rawurlencode($newPage); if(!empty($pageindex->$newPage->redirect)) $redirectUrl .= "&redirect=no"; if(strlen($hashCode) > 0) $redirectUrl .= "#$hashCode"; header("location: $redirectUrl"); exit(); } } $title = "$env->page - $settings->sitename"; if(isset($pageindex->$page->protect) && $pageindex->$page->protect === true) $title = $settings->protectedpagechar . $title; $content = ""; if(!$env->is_history_revision) $content .= "$env->page
\n"; else { $content .= "Revision #{$env->history->revision_number} of $env->page
\n"; $content .= "(Revision saved by {$env->history->revision_data->editor} " . render_timestamp($env->history->revision_data->timestamp) . ". Jump to the current revision or see a list of all revisions for this page.)
\n"; } // Add a visit parent page link if we're a subpage if(get_page_parent($env->page) !== false) $content .= "« " . htmlentities(get_page_parent($env->page)) . "
\n"; // Add an extra message if the requester was redirected from another page if(isset($_GET["redirected_from"])) $content .= "Redirected from " . $_GET["redirected_from"] . ".
\n"; $parsing_start = microtime(true); $rawRenderedSource = parse_page_source(file_get_contents($env->page_filename)); $content .= $rawRenderedSource; if(!empty($pageindex->$page->tags)) { $content .= "\n"; } /*else { $content .= "\n"; }*/ if($settings->show_subpages) { $subpages = get_object_vars(get_subpages($pageindex, $env->page)); if(count($subpages) > 0) { $content .= ""; $content .= "Subpages: "; foreach($subpages as $subpage => $times_removed) { if($times_removed <= $settings->subpages_display_depth) { $content .= "$subpage, "; } } // Remove the last comma from the content $content = substr($content, 0, -2); } } $content .= "\n\t\t\n"; // Prevent indexing of this page if it's still within the noindex // time period if(isset($settings->delayed_indexing_time) and time() - $pageindex->{$env->page}->lastmodified < $settings->delayed_indexing_time) header("x-robots-tag: noindex"); $settings->footer_message = "$env->page was last edited by {$pageindex->{$env->page}->lasteditor} at " . date('h:ia T \o\n j F Y', $pageindex->{$env->page}->lastmodified) . ".\n
" . $settings->footer_message; // Add the last edited time to the footer $mode = isset($_GET["mode"]) ? strtolower(trim($_GET["mode"])) : "normal"; switch($mode) { case "contentonly": // Content only mode: Send only the content of the page exit($content); case "parsedsourceonly": // Parsed source only mode: Send only the raw rendered source exit($rawRenderedSource); case "printable": // Printable mode: Sends a printable version of the page exit(page_renderer::render_minimal($title, $content)); case "normal": default: // Normal mode: Send a normal page exit(page_renderer::render_main($title, $content)); } }); } ]); register_module([ "name" => "Parsedown", "version" => "0.9.13", "author" => "Emanuil Rusev & Starbeamrainbowlabs", "description" => "An upgraded (now default!) parser based on Emanuil Rusev's Parsedown Extra PHP library (https://github.com/erusev/parsedown-extra), which is licensed MIT. Please be careful, as this module adds some weight to your installation, and also *requires* write access to the disk on first load.", "id" => "parser-parsedown", "code" => function() { global $settings; $parser = new PeppermintParsedown(); $parser->setInternalLinkBase("?page=%s"); add_parser("parsedown", function($source) use ($parser) { global $settings; $parser->setMarkupEscaped($settings->clean_raw_html); $result = $parser->text($source); return $result; }, function($source) { global $version, $settings, $pageindex; $id_text = "$version|$settings->parser|$source"; // Find template includes preg_match_all( '/\{\{\s*([^|]+)\s*(?:\|[^}]*)?\}\}/', $source, $includes ); foreach($includes[1] as $include_pagename) { if(empty($pageindex->$include_pagename)) $id_text .= "|$include_pagename:" . parsedown_pagename_resolve( $pageindex->$include_pagename->lastmodified ); } return str_replace(["+","/"], ["-","_"], base64_encode(hash( "sha256", $id_text, true ))); }); /* * ███████ ████████ █████ ████████ ██ ███████ ████████ ██ ██████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ███████ ██ ██ ███████ ██ ██ ██ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ██ ██ ██ ███████ ██ ██ ██████ ███████ */ statistic_add([ "id" => "wanted-pages", "name" => "Wanted Pages", "type" => "page", "update" => function($old_stats) { global $pageindex, $env; $result = new stdClass(); // completed, value, state $pages = []; foreach($pageindex as $pagename => $pagedata) { if(!file_exists($env->storage_prefix . $pagedata->filename)) continue; $page_content = file_get_contents($env->storage_prefix . $pagedata->filename); $page_links = PeppermintParsedown::extract_page_names($page_content); foreach($page_links as $linked_page) { // We're only interested in pages that don't exist if(!empty($pageindex->$linked_page)) continue; if(empty($pages[$linked_page])) $pages[$linked_page] = 0; $pages[$linked_page]++; } } arsort($pages); $result->value = $pages; $result->completed = true; return $result; }, "render" => function($stats_data) { $result = "
$stats_data->name
\n"; $result .= "| Page Name | Linking Pages |
|---|---|
| $pagename | $linking_pages |
$stats_data->name
\n"; $result .= "| Page Name | Linking Pages |
|---|---|
| $pagename_display | $link_count |
$settings->sitename's editor uses an extended version of Parsedown to render pages, which is a fantastic open source Github flavoured markdown parser. You can find a quick reference guide on Github flavoured markdown here by adam-p, or if you prefer a book Mastering Markdown by KB is a good read, and free too!
Tips
- Put 2 spaces at the end of a line to add a soft line break. Leave a blank line to add a head line break (i.e. a new paragraph).
- You can add an id to a header that you can link to. Put it in curly braces after the heading name like this:
# Heading Name {#HeadingId}. Then you can link to like like this:[[Page name#HeadingId}]]. You can also link to a heading id on the current page by omitting the page name:[[#HeadingId]].
Extra Syntax
$settings->sitename's editor also supports some extra custom syntax, some of which is inspired by Mediawiki.
| Type this | To get this | Comments |
|---|---|---|
[[Internal link]] | Internal Link | An internal link. |
[[Display Text|Internal link]] | Display Text | An internal link with some display text. |
 |  | An image floating to the right of the page that fits inside a 256px x 256px box, preserving aspect ratio. |
 | | An image with a caption that fits inside a 256px x 256px box, preserving aspect ratio. The presence of the word caption in the regular braces causes the alt text to be taken and displayed below the image itself. |
 |  | An example of the short url syntax for images. Simply enter the page name of an image (or video / audio file), and Pepperminty Wiki will sort out the url for you. |
Note that the all image image syntax above can be mixed and matched to your liking. The caption option in particular must come last or next to last.
Templating
$settings->sitename also supports including one page in another page as a template. The syntax is very similar to that of Mediawiki. For example, {{Announcement banner}} will include the contents of the \"Announcement banner\" page, assuming it exists.
You can also use variables. Again, the syntax here is very similar to that of Mediawiki - they can be referenced in the included page by surrrounding the variable name in triple curly braces (e.g. {{{Announcement text}}}), and set when including a page with the bar syntax (e.g. {{Announcement banner | importance = high | text = Maintenance has been planned for tonight.}}). Currently the only restriction in templates and variables is that you may not include a closing curly brace (}) in the page name, variable name, or value.
Special Variables
$settings->sitename also supports a number of special built-in variables. Their syntax and function are described below:
| Type this | To get this |
|---|---|
{{{@}}} | Lists all variables and their values in a table. |
{{{#}}} | Shows a 'stack trace', outlining all the parent includes of the current page being parsed. |
{{{~}}} | Outputs the requested page's name. |
{{{*}}} | Outputs a comma separated list of all the subpages of the current page. |
{{{+}}} | Shows a gallery containing all the files that are sub pages of the current page. |
| Key | Value |
|---|---|
| " . $this->escapeText($key) . " | " . $this->escapeText($value) . " |
- \n";
$variableValue .= "\t
- $env->page \n"; foreach($this->paramStack as $curStackEntry) { $variableValue .= "\t
- " . $curStackEntry["pagename"] . " \n"; } $variableValue .= "
- $variableValue
No credits page detected. The credits page is a required module!
")); } // Download all the requested remote files ini_set("user_agent", "$settings->sitename (Pepperminty-Wiki-Downloader; PHP/" . phpversion() . "; +https://github.com/sbrl/Pepperminty-Wiki/) Pepperminty-Wiki/$version"); foreach($remote_files as $remote_file_def) { if(file_exists($remote_file_def["local_filename"]) && filesize($remote_file_def["local_filename"]) > 0) continue; error_log("[ Pepperminty-Wiki/$settings->sitename ] Downloading {$remote_file_def["local_filename"]} from {$remote_file_def["remote_url"]}"); file_put_contents($remote_file_def["local_filename"], fopen($remote_file_def["remote_url"], "rb")); } ////////////////////////////////// /// Final Consistency Measures /// ////////////////////////////////// if(!isset($pageindex->{$env->page}) && isset($pageindex->{ucwords($env->page)})) { http_response_code(307); header("location: ?page=" . ucwords($env->page)); header("content-type: text/plain"); exit("$env->page doesn't exist on $settings->sitename, but " . ucwords($env->page) . " does. You should be redirected there automatically."); } // Redirect to the search page if there isn't a page with the requested name if(!isset($pageindex->{$env->page}) and isset($_GET["search-redirect"])) { http_response_code(307); $url = "?action=search&query=" . rawurlencode($env->page); header("location: $url"); exit(page_renderer::render_minimal("Non existent page - $settings->sitename", "There isn't a page on $settings->sitename with that name. However, you could search for this page name in other pages.
Alternatively, you could create this page.
")); } ////////////////////////////////// // Perform the appropriate action $action_name = $env->action; if(isset($actions->$action_name)) { $req_action_data = $actions->$action_name; $req_action_data(); } else { exit(page_renderer::render_main("Error - $settings->sitename", "No action called " . strtolower($_GET["action"]) ." has been registered. Perhaps you are missing a module?
")); } ?>
" . page_renderer::render_username($comment->username ?? "Unknown") . " said:
"; $result .= "\t"; $result .= "\t\t\n"; if($env->user == $comment->username || $env->is_admin) $result .= "Delete\n"; $result .= "\t\t🔗\n"; $result .= "\t\t\n"; $result .= "\t
\n"; $result .= "\t" . render_comments($comment->replies, $depth + 1) . "\n"; $result .= "\t