E_ALL | E_STRICT ]); } /* * Pepperminty Wiki * ================ * Inspired by Minty Wiki by am2064: * Link: https://github.com/am2064/Minty-Wiki * * Credits: * Code by @Starbeamrainbowlabs * Slimdown - by Johnny Broadway from https://gist.github.com/jbroadway/2836900 * Bug reports: * #2 - Incorrect closing tag - nibreh * #8 - Rogue tag - nibreh */ // Initialises a new object to store your wiki's settings in. Please don't touch this. $settings = new stdClass(); // The site's name. Used all over the place. // Note that by default the session cookie is prefixed with a variant of the // sitename so changing this will log everyone out! $settings->sitename = "Pepperminty Wiki"; // A url that points to the site's logo. Leave blank to disable. When enabled // the logo will be inserted next to the site name on every page. $settings->logo_url = "//starbeamrainbowlabs.com/images/logos/peppermint.png"; // The side of the site name at which the logo should be placed. May be set to // either "left" or "right". Only has an effect if the above is not set to an // empty string. $settings->logo_position = "left"; // The url from which to fetch updates. Defaults to the master (development) // branch If there is sufficient demand, a separate stable branch will be // created. Note that if you use the automatic updater currently it won't save // your module choices. // MAKE SURE THAT THIS POINTS TO A *HTTPS* URL, OTHERWISE SOMEONE COULD INJECT // A VIRUS INTO YOUR WIKI $settings->updateurl = "https://raw.githubusercontent.com/sbrl/pepperminty-wiki/master/index.php"; // The secret key used to perform 'dangerous' actions, like updating the wiki, // and deleting pages. It is strongly advised that you change this! $settings->sitesecret = "ed420502615bac9037f8f12abd4c9f02"; // The directory in which to store all files, except this main index.php. // A single dot ('.') denotes the current directory. // Remember to omit the trailing slash from the directory name, as it is added // automatically by Pepperminty Wiki. // Note that this setting is currently experimental. $settings->data_storage_dir = "../data_test"; // Determined whether edit is enabled. Set to false to disable disting for all // users (anonymous or otherwise). $settings->editing = true; // The maximum number of characters allowed in a single page. The default is // 135,000 characters, which is about 50 pages. $settings->maxpagesize = 135000; // Whether page sources should be cleaned of HTML before rendering. If set to // true any raw HTML will be escaped before rendering. Note that this shouldn't // affect code blocks - they should alwys be escaped. It is STRONGLY // recommended that you keep this option turned on, *ESPECIALLY* if you allow // anonymous edits as no sanitizing what so ever is performed on the HTML. // Also note that some parsers may override this setting and escape HTML // sequences anyway. $settings->clean_raw_html = true; // Determined whether users who aren't logged in are allowed to edit your wiki. // Set to true to allow anonymous users to log in. $settings->anonedits = false; // The name of the page that will act as the home page for the wiki. This page // will be served if the user didn't specify a page. $settings->defaultpage = "Main Page"; // The default action. This action will be performed if no other action is // specified. It is recommended you set this to "view" - that way the user // automatically views the default page (see above). $settings->defaultaction = "view"; // The parser to use when rendering pages. Defaults to 'default', which is a // modified version of slimdown, originally written by // Johnny Broadway . $settings->parser = "default"; // Whether to show a list of subpages at the bottom of the page. $settings->show_subpages = true; // The depth to which we should display when listing subpages at the bottom of // the page. $settings->subpages_display_depth = 3; // An array of usernames and passwords - passwords should be hashed with // sha256. Put one user / password on each line, remembering the comma at the // end. The last user in the list doesn't need a comma after their details though. $settings->users = [ "admin" => "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8", //password "user" => "873ac9ffea4dd04fa719e8920cd6938f0c23cd678af330939cff53c3d2855f34" //cheese ]; // Whether to use the new sha3 hashing algorithm that was standardised on the // 8th August 2015. Only works if you have strawbrary's sha3 extension // installed. Get it here: https://github.com/strawbrary/php-sha3 // Note: If you change this settings, make sure to update the password hashes // above! Note that the hash action is aware of this option and will hash // passwords appropriately based on this setting. $settings->use_sha3 = false; // An array of usernames that are administrators. Administrators can delete and // move pages. $settings->admins = [ "admin" ]; // The string that is prepended before an admin's name on the nav bar. Defaults // to a diamond shape (◆). $settings->admindisplaychar = "◆"; // The string that is prepended a page's name in the page title if it is // protected. Defaults to a lock symbol. $settings->protectedpagechar = "🔒"; // Contact details for the site administrator. Since users can only be added by // editing this file, people will need a contact address to use to ask for an // account. Displayed at the bottom of the page, and will be appropriately // obfusticated to deter spammers. $settings->admindetails = [ "name" => "Administrator", "email" => "admin@localhost" ]; // Whether to only allow adminstrators to export the your wiki as a zip using // the page-export module. $settings->export_allow_only_admins = false; // Array of links and display text to display at the top of the site. // Format: // [ "Display Text", "Link" ] // You can also use strings here and they will be printed as-is, except the // following special strings: // user-status Expands to the user's login information // e.g. "Logged in as {name}. | Logout". // e.g. "Browsing as Anonymous. | Login". // // search Expands to a search box. // // divider Expands to a divider to separate stuff. // // more Expands to the "More..." submenu. $settings->nav_links = [ "user-status", [ "Home", "index.php" ], // [ "Login", "index.php?action=login" ], "search", [ "Read", "index.php?page={page}" ], [ "Edit", "index.php?action=edit&page={page}" ], [ "Printable", "index.php?action=view&printable=yes&page={page}" ], //"divider", [ "All Pages", "index.php?action=list" ], "menu" ]; // An array of additional links in the above format that will be shown under // "More" subsection. $settings->nav_links_extra = [ [ "Upload", "index.php?action=upload" ], [ $settings->admindisplaychar . "Delete", "index.php?action=delete&page={page}" ], [ $settings->admindisplaychar . "Move", "index.php?action=move&page={page}" ], [ $settings->admindisplaychar . "Toggle Protection", "index.php?action=protect&page={page}" ] ]; // An array of links in the above format that will be shown at the bottom of // the page. $settings->nav_links_bottom = [ [ "Credits", "index.php?action=credits" ], [ "Help", "index.php?action=help" ] ]; // A message that will appear at the bottom of every page. May contain HTML. $settings->footer_message = "All content is under this license. Please make sure that you read and understand the license, especially if you are thinking about copying some (or all) of this site's content, as it may restrict you from doing so."; // A message that will appear just before the submit button on the editing // page. May contain HTML. $settings->editing_message = "By submitting your edit, you are agreeing to release your changes under this license. Also note that if you don't want your work to be edited by other users of this site, please don't submit it here!"; // Whether to allow image uploads to the server. Currently disabled temporarily // for security reasons while I finish writing the file uploader. $settings->upload_enabled = true; // An array of mime types that are allowed to be uploaded. $settings->upload_allowed_file_types = [ "image/jpeg", "image/png", "image/gif", "image/webp" ]; // The default file type for previews. Defaults to image/png. Also supports // image/jpeg and image/webp. image/webp is a new image format that reduces // image sizez by ~20%, but PHP still has some issues with invalid webp images. $settings->preview_file_type = "image/png"; // The default size of preview images. $settings->default_preview_size = 640; // The location of a file that maps mime types onto file extensions and vice // versa. Used to generate the file extension for an uploaded file. Set to the // default location of the mime.types file on Linux. If you aren't using linux, // download this pastebin and point this setting at it instead: // http://pastebin.com/mjM3zKjz $settings->mime_extension_mappings_location = "/etc/mime.types"; // The minimum and maximum sizes of generated preview images in pixels. $settings->min_preview_size = 1; $settings->max_preview_size = 2048; // The maximum distance terms should be apart in the context display below // search results. This is purely aesthetical - it doesn't affect the search // algorithm. $settings->search_max_distance_context_display = 100; // The number of characters that should be displayed either side of a matching // term in the context below each search result. $settings->search_characters_context = 200; // The weighting to give to search term matches found in a page's title. $settings->search_title_matches_weighting = 10; // The weighting to give to search term matches found in a page's tags. $settings->search_tags_matches_weighting = 3; // A string of css to include. Will be included in the of every page // inside a "; } public static $nav_divider = " | "; /* * @summary Function to render a navigation bar from an array of links. See * $settings->nav_links for format information. * * @param $nav_links - The links to add to the navigation bar. * @param $nav_links_extra - The extra nav links to add to the "More..." * menu. */ public static function render_navigation_bar($nav_links, $nav_links_extra, $class = "") { global $settings, $env; $result = "

\n"; // Loop over all the navigation links foreach($nav_links as $item) { if(is_string($item)) { // The item is a string switch($item) { //keywords case "user-status": if($env->is_logged_in) { $result .= "Logged in as " . self::render_username($env->user) . ". "/* . page_renderer::$nav_divider*/; $result .= "Logout"; $result .= page_renderer::$nav_divider; } else $result .= "Browsing as Anonymous." . /*page_renderer::$nav_divider . */"Login" . page_renderer::$nav_divider; break; case "search": // Displays a search bar $result .= ""; break; case "divider": // Displays a divider $result .= page_renderer::$nav_divider; break; case "menu": $result .= "More... "; $result .= page_renderer::render_navigation_bar($nav_links_extra, [], "nav-more-menu"); $result .= ""; break; // It isn't a keyword, so just output it directly default: $result .= "$item"; } } else { // Output the item as a link to a url $result .= "$item[0]"; } } $result .= "

"; return $result; } public static function render_username($name) { global $settings; $result = ""; if(in_array($name, $settings->admins)) $result .= $settings->admindisplaychar; $result .= $name; return $result; } public static function generate_all_pages_datalist() { global $pageindex; $result = "\n"; foreach($pageindex as $pagename => $pagedetails) { $result .= "\t\t\t"; return $result; } } ////////////////////////////////////// ///// Extra consistency measures ///// ////////////////////////////////////// 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("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.

")); } ////////////////////////////////////// ////////////////////////////////////// ////////////////////////// /// Module functions /// ////////////////////////// // These functions are // // used by modules to // // register themselves // // or new pages. // ////////////////////////// $modules = []; // List that contains all the loaded modules // Function to register a module function register_module($moduledata) { global $modules; //echo("registering module\n"); //var_dump($moduledata); $modules[] = $moduledata; } // Function to register an action handler $actions = new stdClass(); function add_action($action_name, $func) { global $actions; //echo("adding $action_name\n"); $actions->$action_name = $func; } // Function to register a new parser. $parsers = [ "none" => function() { throw new Exception("No parser registered!"); } ]; function add_parser($name, $parser_code) { 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_code; } function parse_page_source($source) { global $settings, $parsers; 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); */ return $parsers[$settings->parser]($source); } // Function to register a new proprocessor that will be executed just before // an edit is saved. $save_preprocessors = []; function register_save_preprocessor($func) { global $save_preprocessors; $save_preprocessors[] = $func; } ////////////////////////////////////////////////////////////////// register_module([ "name" => "Password hashing action", "version" => "0.5", "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() { 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 { exit(page_renderer::render_main("Hashed string", "

Algorithm: " . ($settings->use_sha3 ? "sha3" : "sha256") . "

" . $_GET["string"] . " → " . hash_password($_GET["string"]) . "

")); } }); } ]); register_module([ "name" => "Page protection", "version" => "0.2", "author" => "Starbeamrainbowlabs", "description" => "Exposes Pepperminty Wiki's new page protection mechanism and makes the protect button in the 'More...' menu on the top bar work.", "id" => "action-protect", "code" => function() { add_action("protect", function() { global $env, $pageindex, $paths, $settings; // Make sure that the user is logged in as an admin / mod. if($env->is_admin) { // They check out ok, toggle the page's protection. $page = $env->page; if(!isset($pageindex->$page->protect)) { $pageindex->$page->protect = true; } else if($pageindex->$page->protect === true) { $pageindex->$page->protect = false; } else if($pageindex->$page->protect === false) { $pageindex->$page->protect = true; } // Save the pageindex file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT)); $state = ($pageindex->$page->protect ? "enabled" : "disabled"); $title = "Page protection $state."; exit(page_renderer::render_main($title, "

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" => "Raw page source", "version" => "0.4", "author" => "Starbeamrainbowlabs", "description" => "Adds a 'raw' action that shows you the raw source of a page.", "id" => "action-raw", "code" => function() { add_action("raw", function() { global $env; http_response_code(307); header("x-filename: " . rawurlencode($env->page) . ".md"); header("content-type: text/markdown"); exit(file_get_contents("$env->storage_prefix$env->page.md")); exit(); }); } ]); register_module([ "name" => "Sidebar", "version" => "0.2", "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() { $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; 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}"] = "

" . $parts["{body}"] . "

"; } }); } ]); /* * @summary Renders the sidebar for a given pageindex. * * @param $pageindex {array} - The pageindex to render the sidebar for * @param $root_pagename {string} - The pagename that should be considered the root of the rendering. You don't usually need to use this, it is used by the algorithm itself since it is recursive. * * @returns {string} A HTML rendering of the sidebar for the given pageindex */ function render_sidebar($pageindex, $root_pagename = "") { global $settings; $result = " $details) { // If we have a valid root pagename, and it isn't present at the // beginning of the current pagename, skip it if($root_pagename !== "" && strpos($pagename, $root_pagename) !== 0) continue; // The current page is the same as the root page, skip it if($pagename == $root_pagename) continue; // If the part of the current pagename that comes after the root // pagename has a slash in it, skip it as it is a sub-sub page. if(strpos(substr($pagename, strlen($root_pagename)), "/") !== false) continue; $result .= "

$pagename\n"; $result .= render_sidebar($pageindex, $pagename); $result .= "

\n"; } $result .= "\n"; return $result == "

\n" ? "" : $result; } register_module([ "name" => "Redirect pages", "version" => "0.1", "author" => "Starbeamrainbowlabs", "description" => "Adds support for redirect pages. Uses the same syntax that Mediawiki does.", "id" => "feature-redirect", "code" => function() { register_save_preprocessor(function(&$index_entry, &$pagedata) { $matches = []; if(preg_match("/^# ?REDIRECT ?\[\[([^\]]+)\]\]/i", $pagedata, $matches) === 1) { error_log("matches: " . var_export($matches, true)); // We have found a redirect page! // Update the metadata to reflect this. $index_entry->redirect = true; $index_entry->redirect_target = $matches[1]; } else { // This page isn't a redirect. Unset the metadata just in case. if(isset($index_entry->redirect)) unset($index_entry->redirect); if(isset($index_entry->redirect_target)) unset($index_entry->redirect_target); } }); } ]); register_module([ "name" => "Search", "version" => "0.2", "author" => "Starbeamrainbowlabs", "description" => "Adds proper search functionality to Pepperminty Wiki. Note that this module, at the moment, just contains test code while I figure out how best to write a search engine.", "id" => "feature-search", "code" => function() { add_action("index", function() { global $settings, $env; $breakable_chars = "\r\n\t .,\\/!\"£$%^&*[]()+`_~#"; header("content-type: text/plain"); $source = file_get_contents("$env->storage_prefix$env->page.md"); $index = search::index($source); var_dump($env->page); var_dump($source); var_dump($index); }); add_action("invindex-rebuild", function() { search::rebuild_invindex(); }); add_action("search", function() { global $settings, $env, $pageindex, $paths; if(!isset($_GET["query"])) exit(page_renderer::render("No Search Terms - Error - $settings->sitename", "

You didn't specify any search terms. Try typing some into the box above.

")); $search_start = microtime(true); $invindex = search::load_invindex($paths->searchindex); $results = search::query_invindex($_GET["query"], $invindex); $search_end = microtime(true) - $search_start; $title = $_GET["query"] . " - Search results - $settings->sitename"; $content = "

\n"; $content .= "

Search Results

"; /// Search Box /// $content .= ""; $query = $_GET["query"]; if(isset($pageindex->$query)) { $content .= "

There's a page on $settings->sitename called $query.

"; } else { $content .= "

There isn't a page called $query on $settings->sitename, but you can create it.

"; } $i = 0; // todo use $_GET["offset"] and $_GET["result-count"] or something foreach($results as $result) { $link = "?page=" . rawurlencode($result["pagename"]); $pagesource = file_get_contents($env->storage_prefix . $result["pagename"] . ".md"); $context = search::extract_context($_GET["query"], $pagesource); $context = search::highlight_context($_GET["query"], $context); /*if(strlen($context) == 0) { $context = search::strip_markup(file_get_contents("$env->page.md", null, null, null, $settings->search_characters_context * 2)); if($pageindex->{$env->page}->size > $settings->search_characters_context * 2) $context .= "..."; }*/ // We add 1 to $i here to convert it from an index to a result // number as people expect it to start from 1 $content .= "

\n"; $content .= "

" . $result["pagename"] . "

\n"; $content .= "

$context

\n"; $content .= "

\n"; $i++; } $content .= "

\n"; exit(page_renderer::render($title, $content)); //header("content-type: text/plain"); //var_dump($results); }); } ]); class search { // Words that we should exclude from the inverted index. public static $stop_words = [ "a", "about", "above", "above", "across", "after", "afterwards", "again", "against", "all", "almost", "alone", "along", "already", "also", "although", "always", "am", "among", "amongst", "amoungst", "amount", "an", "and", "another", "any", "anyhow", "anyone", "anything", "anyway", "anywhere", "are", "around", "as", "at", "back", "be", "became", "because", "become", "becomes", "becoming", "been", "before", "beforehand", "behind", "being", "below", "beside", "besides", "between", "beyond", "bill", "both", "bottom", "but", "by", "call", "can", "cannot", "cant", "co", "con", "could", "couldnt", "cry", "de", "describe", "detail", "do", "done", "down", "due", "during", "each", "eg", "eight", "either", "eleven", "else", "elsewhere", "empty", "enough", "etc", "even", "ever", "every", "everyone", "everything", "everywhere", "except", "few", "fifteen", "fify", "fill", "find", "fire", "first", "five", "for", "former", "formerly", "forty", "found", "four", "from", "front", "full", "further", "get", "give", "go", "had", "has", "hasnt", "have", "he", "hence", "her", "here", "hereafter", "hereby", "herein", "hereupon", "hers", "herself", "him", "himself", "his", "how", "however", "hundred", "ie", "if", "in", "inc", "indeed", "interest", "into", "is", "it", "its", "itself", "keep", "last", "latter", "latterly", "least", "less", "ltd", "made", "many", "may", "me", "meanwhile", "might", "mine", "more", "moreover", "most", "mostly", "move", "much", "must", "my", "myself", "name", "namely", "neither", "never", "nevertheless", "next", "nine", "no", "none", "nor", "not", "nothing", "now", "nowhere", "of", "off", "often", "on", "once", "one", "only", "onto", "or", "other", "others", "otherwise", "our", "ours", "ourselves", "out", "over", "own", "part", "per", "perhaps", "please", "put", "rather", "re", "same", "see", "seem", "seemed", "seeming", "seems", "serious", "several", "she", "should", "show", "side", "since", "sincere", "six", "sixty", "so", "some", "somehow", "someone", "something", "sometime", "sometimes", "somewhere", "still", "such", "system", "take", "ten", "than", "that", "the", "their", "them", "themselves", "then", "thence", "there", "thereafter", "thereby", "therefore", "therein", "thereupon", "these", "they", "thickv", "thin", "third", "this", "those", "though", "three", "through", "throughout", "thru", "thus", "to", "together", "too", "top", "toward", "towards", "twelve", "twenty", "two", "un", "under", "until", "up", "upon", "us", "very", "via", "was", "we", "well", "were", "what", "whatever", "when", "whence", "whenever", "where", "whereafter", "whereas", "whereby", "wherein", "whereupon", "wherever", "whether", "which", "while", "whither", "who", "whoever", "whole", "whom", "whose", "why", "will", "with", "within", "without", "would", "yet", "you", "your", "yours", "yourself", "yourselves" ]; public static function index($source) { $source = html_entity_decode($source, ENT_QUOTES); $source_length = strlen($source); $index = []; $terms = self::tokenize($source); $i = 0; foreach($terms as $term) { $nterm = $term; // Skip over stop words (see https://en.wikipedia.org/wiki/Stop_words) if(in_array($nterm, self::$stop_words)) continue; if(!isset($index[$nterm])) { $index[$nterm] = [ "freq" => 0, "offsets" => [] ]; } $index[$nterm]["freq"]++; $index[$nterm]["offsets"][] = $i; $i++; } return $index; } public static function tokenize($source) { $source = strtolower($source); return preg_split("/((^\p{P}+)|(\p{P}*\s+\p{P}*)|(\p{P}+$))|\|/", $source, -1, PREG_SPLIT_NO_EMPTY); } public static function strip_markup($source) { return str_replace([ "[", "]", "\"", "*", "_", " - ", "`" ], "", $source); } public static function rebuild_invindex() { global $pageindex, $env, $paths; $invindex = []; foreach($pageindex as $pagename => $pagedetails) { $pagesource = file_get_contents("$env->storage_prefix$pagename.md"); $index = self::index($pagesource); self::merge_into_invindex($invindex, ids::getid($pagename), $index); } self::save_invindex($paths->searchindex, $invindex); } /* * @summary Sorts an index alphabetically. Will also sort an inverted index. * This allows us to do a binary search instead of a regular * sequential search. */ public static function sort_index(&$index) { ksort($index, SORT_NATURAL); } /* * @summary Compares two *regular* indexes to find the differences between them. * * @param {array} $indexa - The old index. * @param {array} $indexb - The new index. * @param {array} $changed - An array to be filled with the nterms of all * the changed entries. * @param {array} $removed - An array to be filled with the nterms of all * the removed entries. */ public static function compare_indexes($oldindex, $newindex, &$changed, &$removed) { foreach($oldindex as $nterm => $entry) { if(!isset($newindex[$nterm])) $removed[] = $nterm; } foreach($newindex as $nterm => $entry) { if(!isset($oldindex[$nterm]) or // If this world is new $newindex[$nterm] !== $oldindex[$nterm]) // If this word has changed $changed[$nterm] = $newindex[$nterm]; } } /* * @summary Reads in and parses an inverted index. */ // Todo remove this function and make everything streamable public static function load_invindex($invindex_filename) { $invindex = json_decode(file_get_contents($invindex_filename), true); return $invindex; } /* * @summary Merge an index into an inverted index. */ public static function merge_into_invindex(&$invindex, $pageid, &$index, &$removals = []) { // Remove all the subentries that were removed since last time foreach($removals as $nterm) { unset($invindex[$nterm][$pageid]); } // Merge all the new / changed index entries into the inverted index foreach($index as $nterm => $newentry) { // If the nterm isn't in the inverted index, then create a space for it if(!isset($invindex[$nterm])) $invindex[$nterm] = []; $invindex[$nterm][$pageid] = $newentry; // Sort the page entries for this word by frequency uasort($invindex[$nterm], function($a, $b) { if($a["freq"] == $b["freq"]) return 0; return ($a["freq"] < $b["freq"]) ? +1 : -1; }); } // Sort the inverted index by rank uasort($invindex, function($a, $b) { $ac = count($a); $bc = count($b); if($ac == $bc) return 0; return ($ac < $bc) ? +1 : -1; }); } public static function save_invindex($filename, &$invindex) { file_put_contents($filename, json_encode($invindex)); } public static function query_invindex($query, &$invindex) { global $settings, $pageindex; $query_terms = self::tokenize($query); $matching_pages = []; // Loop over each term in the query and find the matching page entries for($i = 0; $i < count($query_terms); $i++) { $qterm = $query_terms[$i]; // Only search the inverted index if it actually exists there if(isset($invindex[$qterm])) { // Loop over each page in the inverted index entry foreach($invindex[$qterm] as $pageid => $page_entry) { // Create an entry in the matching pages array if it doesn't exist if(!isset($matching_pages[$pageid])) $matching_pages[$pageid] = [ "nterms" => [] ]; $matching_pages[$pageid]["nterms"][$qterm] = $page_entry; } } // Loop over the pageindex and search the titles / tags foreach ($pageindex as $pagename => $pagedata) { // Get the current page's id $pageid = ids::getid($pagename); // Consider matches in the page title if(stripos($pagename, $qterm) !== false) { // We found the qterm in the title if(!isset($matching_pages[$pageid])) $matching_pages[$pageid] = [ "nterms" => [] ]; // Set up a counter for page title matches if it doesn't exist already if(!isset($matching_pages[$pageid]["title-matches"])) $matching_pages[$pageid]["title-matches"] = 0; $matching_pages[$pageid]["title-matches"] += count(mb_stripos_all($pagename, $qterm)); } // Consider matches in the page's tags if(isset($pagedata->tags) and // If this page has tags stripos(implode(" ", $pagedata->tags), $qterm) !== false) // And we found the qterm in the tags { if(!isset($matching_pages[$pageid])) $matching_pages[$pageid] = [ "nterms" => [] ]; // Set up a counter for tag match if there isn't one already if(!isset($matching_pages[$pageid]["tag-matches"])) $matching_pages[$pageid]["tag-matches"] = 0; $matching_pages[$pageid]["tag-matches"] += count(mb_stripos_all(implode(" ", $pagedata->tags), $qterm)); } } } foreach($matching_pages as $pageid => &$pagedata) { $pagedata["pagename"] = ids::getpagename($pageid); $pagedata["rank"] = 0; foreach($pagedata["nterms"] as $pterm => $entry) { $pagedata["rank"] += $entry["freq"]; // todo rank by context here } // Consider matches in the title / tags if(isset($pagedata["title-matches"])) $pagedata["rank"] += $pagedata["title-matches"] * $settings->search_title_matches_weighting; if(isset($pagedata["tag-matches"])) $pagedata["rank"] += $pagedata["tag-matches"] * $settings->search_tags_matches_weighting; // todo remove items if the rank is below a threshold } // todo sort by rank here uasort($matching_pages, function($a, $b) { if($a["rank"] == $b["rank"]) return 0; return ($a["rank"] < $b["rank"]) ? +1 : -1; }); return $matching_pages; } public static function extract_context($query, $source) { global $settings; $nterms = self::tokenize($query); $matches = []; // Loop over each nterm and find it in the source foreach($nterms as $nterm) { $all_offsets = mb_stripos_all($source, $nterm); // Skip over adding matches if there aren't any if($all_offsets === false) continue; foreach($all_offsets as $offset) { $matches[] = [ $nterm, $offset ]; } } usort($matches, function($a, $b) { if($a[1] == $b[1]) return 0; return ($a[1] < $b[1]) ? +1 : -1; }); $contexts = []; $basepos = 0; $matches_count = count($matches); while($basepos < $matches_count) { // Store the next match along - all others will be relative to that // one $group = [$matches[$basepos]]; // Start scanning at the next one along - we always store the first match $scanpos = $basepos + 1; $distance = 0; while(true) { // Break out if we reach the end if($scanpos >= $matches_count) break; // Find the distance between the current one and the last one $distance = $matches[$scanpos][1] - $matches[$scanpos - 1][1]; // Store it if the distance is below the threshold if($distance < $settings->search_characters_context) $group[] = $matches[$scanpos]; else break; $scanpos++; } $context_start = $group[0][1] - $settings->search_characters_context; $context_end = $group[count($group) - 1][1] + $settings->search_characters_context; $context = substr($source, $context_start, $context_end - $context_start); // Strip the markdown from the context - it's most likely going to // be broken anyway. $context = self::strip_markup($context); $contexts[] = $context; $basepos = $scanpos + 1; } return implode(" ... ", $contexts); } public static function highlight_context($query, $context) { $qterms = self::tokenize($query); foreach($qterms as $qterm) { // From http://stackoverflow.com/a/2483859/1460422 $context = preg_replace("/" . preg_quote($qterm) . "/i", "$0", $context); } return $context; } } register_module([ "name" => "Uploader", "version" => "0.2", "author" => "Starbeamrainbowlabs", "description" => "Adds the ability to upload files to Pepperminty Wiki. Uploaded files act as pages and have the special 'File:' prefix.", "id" => "feature-upload", "code" => function() { add_action("upload", function() { global $settings, $env, $pageindex, $paths; switch($_SERVER["REQUEST_METHOD"]) { case "GET": // Send upload page if(!$settings->upload_enabled) exit(page_renderer::render("Upload Disabled - $setting->sitename", "

You can't upload anything at the moment because $settings->sitename has uploads disabled. Try contacting " . $settings->admindetails["name"] . ", your site Administrator. Go back.

")); if(!$env->is_logged_in) exit(page_renderer::render("Upload Error - $settings->sitename", "

You are not currently logged in, so you can't upload anything.

Try logging in first.

")); exit(page_renderer::render("Upload - $settings->sitename", "

Select an image below, and then type a name for it in the box. This server currently supports uploads up to " . human_filesize(get_max_upload_size()) . " in size.

$settings->sitename currently supports uploading of the following file types: " . implode(", ", $settings->upload_allowed_file_types) . ".

")); break; case "POST": // Recieve file // Make sure uploads are enabled if(!$settings->upload_enabled) { 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) { 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.")); } // Calculate the target ename, removing any characters we // are unsure about. $target_name = makepathsafe($_POST["name"]); $temp_filename = $_FILES["file"]["tmp_name"]; $mimechecker = finfo_open(FILEINFO_MIME_TYPE); $mime_type = finfo_file($mimechecker, $temp_filename); finfo_close($mimechecker); // Perform appropriate checks based on the *real* filetype switch(substr($mime_type, 0, strpos($mime_type, "/"))) { case "image": $extra_data = []; $imagesize = getimagesize($temp_filename, $extra_data); // Make sure that the image size is defined if(!is_int($imagesize[0]) or !is_int($imagesize[1])) { http_response_code(415); exit(page_renderer::render("Upload Error - $settings->sitename", "

The file that you uploaded doesn't appear to be an image. $settings->sitename currently only supports uploading images (videos coming soon). Go back to try again.

")); } break; case "video": http_response_code(501); exit(page_renderer::render("Upload Error - $settings->sitename", "

You uploaded a video, but $settings->sitename doesn't support them yet. Please try again later.

")); default: http_response_code(415); exit(page_renderer::render("Upload Error - $settings->sitename", "

You uploaded an unnknown file type which couldn't be processed. $settings->sitename thinks that the file you uploaded was a(n) '$mime_type', which isn't supported.

")); } $file_extension = system_mime_type_extension($mime_type); $new_filename = "$paths->upload_file_prefix$target_name.$file_extension"; $new_description_filename = "$new_filename.md"; if(isset($pageindex->$new_filename)) exit(page_renderer::render("Upload Error - $settings->sitename", "

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.

")); if(!file_exists("Files")) mkdir("Files", 0664); 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 $settings->sitename has been attacked. Please contact " . $settings->admindetails . ", your $settings->sitename Administrator.

")); } $description = $_POST["description"]; // 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); $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_filename = $entry; // Save the pageindex file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT)); header("location: ?action=view&page=$new_filename&upload=success"); break; } }); add_action("preview", function() { global $settings, $env, $pageindex; $filepath = $env->storage_prefix . $pageindex->{$env->page}->uploadedfilepath; $mime_type = $pageindex->{$env->page}->uploadedfilemime; if(isset($_GET["size"]) and $_GET["size"] == "original") { // 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"]; switch(substr($mime_type, 0, strpos($mime_type, "/"))) { case "image": $image = false; switch($mime_type) { case "image/jpeg": $image = imagecreatefromjpeg($filepath); break; case "image/gif": $image = imagecreatefromgif($filepath); break; case "image/png": $image = imagecreatefrompng($filepath); break; case "image/webp": $image = imagecreatefromwebp($filepath); break; default: http_response_code(415); $image = errorimage("Unsupported image type."); break; } $raw_width = imagesx($image); $raw_height = imagesy($image); $preview_image = resize_image($image, $target_size); header("content-type: $output_mime"); switch($output_mime) { case "image/jpeg": imagejpeg($preview_image); break; case "image/png": imagepng($preview_image); break; default: case "image/webp": imagewebp($preview_image); break; } imagedestroy($preview_image); break; default: http_response_code(501); exit("Unrecognised file type."); } }); page_renderer::register_part_preprocessor(function(&$parts) { global $pageindex, $env, $settings; // Todo add the preview to the top of the page here, but only if the current action is view and we are on a page that is a file 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 = getimagesize($env->storage_prefix . $filepath); $preview_sizes = [ 256, 512, 768, 1024, 1536 ]; $preview_html = "

File Information

Name	" . str_replace("File/", "", $filepath) . "
Type	$mime_type
Size	" . human_filesize(filesize($filepath)) . "
Original dimensions	$dimensions[0] x $dimensions[1]
Uploaded by	" . $pageindex->{$env->page}->lasteditor . "

Description

"; $parts["{content}"] = str_replace("", "\n$preview_html", $parts["{content}"]); } }); } ]); //// Pair of functions to calculate the actual maximum upload size supported by the server //// Lifted from Drupal by @meustrus from Stackoverflow. Link to answer: //// http://stackoverflow.com/a/25370978/1460422 // Returns a file size limit in bytes based on the PHP upload_max_filesize // and post_max_size 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; } 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); } } function errorimage($text) { $width = 640; $height = 480; $image = imagecreatetruecolor($width, $height); imagefill($image, 0, 0, imagecolorallocate($image, 238, 232, 242)); // Set the background to #eee8f2 $fontwidth = imagefontwidth(3); imagetext($image, 3, ($width / 2) - (($fontwidth * strlen($text)) / 2), ($height / 2) - (imagefontheight(3) / 2), $text, imagecolorallocate($image, 17, 17, 17) // #111111 ); return $image; } function resize_image($image, $size) { $cur_width = imagesx($image); $cur_height = imagesy($image); if($cur_width < $size and $cur_height < $size) return $image; $width_ratio = $size / $cur_width; $height_ratio = $size / $cur_height; $ratio = min($width_ratio, $height_ratio); $new_height = floor($cur_height * $ratio); $new_width = floor($cur_width * $ratio); header("x-resize-to: $new_width x $new_height\n"); return imagescale($image, $new_width, $new_height); } register_module([ "name" => "Credits", "version" => "0.6", "author" => "Starbeamrainbowlabs", "description" => "Adds the credits page. You *must* have this module :D", "id" => "page-credits", "code" => function() { add_action("credits", function() { global $settings, $version, $pageindex, $modules; $credits = [ "Code" => [ "author" => "Starbeamrainbowlabs", "author_url" => "https://starbeamrmainbowlabs.com/", "thing_url" => "https://github.com/sbrl/Pepprminty-Wiki" ], "Slightly modified version of Slimdown" => [ "author" => "Johnny Broadway", "author_url" => "https://github.com/jbroadway", "thing_url" => "https://gist.github.com/jbroadway/2836900" ], "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" => "" ] ]; //// Credits html renderer //// $credits_html = "

"; $credits_html .= "$thing by "; $credits_html .= "" . $author_details["author"] . ""; $credits_html .= "

"; /////////////////////////////// //// Module html renderer //// $modules_html = ""; foreach($modules as $module) { $modules_html .= " \n"; } $modules_html .= "

Name	Version	Author	Description
" . $module["name"] . "	" . $module["version"] . "	" . $module["author"] . "	" . $module["description"] . "

"; ////////////////////////////// $title = "Credits - $settings->sitename"; $content = "

$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 ablso be listed here in the future).

Main Credits

$credits_html

Site status

Site name:	$settings->sitename (Update - Administrators only, 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" => "Page deleter", "version" => "0.8", "author" => "Starbeamrainbowlabs", "description" => "Adds an action to allow administrators to delete pages.", "id" => "page-delete", "code" => function() { add_action("delete", function() { global $pageindex, $settings, $env, $paths; if(!$settings->editing) { exit(page_renderer::render_main("Deleting $env->page - error", "

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.

Go back to $env->page.

Nothing has been changed.

")); } if(!$env->is_admin) { exit(page_renderer::render_main("Deleting $env->page - error", "

You tried to delete $env->page, but you are not an admin so you don't have permission to do that.

You should try logging in as an admin.

")); } if(!isset($_GET["delete"]) or $_GET["delete"] !== "yes") { exit(page_renderer::render_main("Deleting $env->page", "

You are about to delete $env->page. 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); } // 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 disk unlink("$env->storage_prefix$env->page.md"); exit(page_renderer::render_main("Deleting $env->page - $settings->sitename", "

$env->page has been deleted. Go back to the main page.

")); }); } ]); register_module([ "name" => "Page editor", "version" => "0.12", "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() { /* * _ _ _ * ___ __| (_) |_ * / _ \/ _` | | __| * | __/ (_| | | |_ * \___|\__,_|_|\__| * %edit% */ add_action("edit", function() { global $pageindex, $settings, $env; $filename = "$env->storage_prefix$env->page.md"; $page = $env->page; $creatingpage = !isset($pageindex->$page); if((isset($_GET["newpage"]) and $_GET["newpage"] == "true") or $creatingpage) { $title = "Creating $env->page"; } else { $title = "Editing $env->page"; } $pagetext = ""; if(isset($pageindex->$page)) { $pagetext = file_get_contents($filename); } if((!$env->is_logged_in and !$settings->anonedits) or // if we aren't logged in and anonymous edits are disbled !$settings->editing or// or editing is disabled ( isset($pageindex->$page) and // the page exists isset($pageindex->$page->protect) and // the protect property exists $pageindex->$page->protect and // the protect property is true !$env->is_admin // the user isn't an admin ) ) { if(!$creatingpage) { // The page already exists - let the user view the page source exit(page_renderer::render_main("Viewing source for $env->page", "

$settings->sitename does not allow anonymous users to make edits. If you are in fact logged in, then this page is probably protected, and you aren't an administrator or moderator. You can view the source of $env->page below, but you can't edit it.

$pagetext

")); } else { http_response_code(404); exit(page_renderer::render_main("404 - $env->page", "

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.

")); } } $content = "

$title

"; $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.

"; } $content .= ""; exit(page_renderer::render_main("$title - $settings->sitename", $content)); }); /* * * ___ __ ___ _____ * / __|/ _` \ \ / / _ \ * \__ \ (_| |\ V / __/ * |___/\__,_| \_/ \___| * %save% */ add_action("save", function() { global $pageindex, $settings, $env, $save_preprocessors, $paths; if(!$settings->editing) { header("location: index.php?page=$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=$env->page"); exit("You are not logged in, so you are not allowed to save pages on $settings->sitename. Redirecting in 5 seconds...."); } $page = $env->page; if(( isset($pageindex->$page) and isset($pageindex->page->protect) and $pageindex->$page->protect ) and !$env->is_admin) { http_response_code(403); header("refresh: 5; url=index.php?page=$env->page"); exit("$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=$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"), null, true); } // Read in the new page content $pagedata = $_POST["content"]; // Santise it if necessary if($settings->clean_raw_html) $pagedata = htmlentities($pagedata, ENT_QUOTES); // 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); } // Update the inverted search index // Construct an index for the old and new page content $oldindex = search::index(file_get_contents("$env->page.md")); $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("./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("invindex.json", $invindex); if(file_put_contents("$env->storage_prefix$env->page.md", $pagedata) !== false) { $page = $env->page; // Make sure that this page's parents exist check_subpage_parents($page); // Update the page index if(!isset($pageindex->$page)) { $pageindex->$page = new stdClass(); $pageindex->$page->filename = "$env->page.md"; } $pageindex->$page->size = strlen($_POST["content"]); $pageindex->$page->lastmodified = time(); if($env->is_logged_in) $pageindex->$page->lasteditor = utf8_encode($env->user); else $pageindex->$page->lasteditor = utf8_encode("anonymous"); $pageindex->$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->$page, $pagedata); } 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=$env->page&edit_status=success&redirect=no"); exit(); } else { 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.

")); } }); } ]); register_module([ "name" => "Export", "version" => "0.3", "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() { 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($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); }); } ]); register_module([ "name" => "Help page", "version" => "0.6", "author" => "Starbeamrainbowlabs", "description" => "Adds the help action. You really want this one.", "id" => "page-help", "code" => function() { add_action("help", function() { global $settings, $version; $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.

Navigating

All the navigation links can be found in the top right corner, along with a box in which you can type a page name and hit enter to be taken to that page (if your site administrator has enabled it).

In order to edit pages on $settings->sitename, you 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 not registration form. Note that the $settings->sitename's administrator may have changed these settings to allow anonymous edits.

Editing

$settings->sitename's editor uses a modified version of slimdown, a flavour of markdown that is implementated using regular expressions. See the credits page for more information and links to the original source for this. A quick reference can be found below:

Type This	To get this
`_italics_`	italics
`bold`	bold
`~~Strikethrough~~`	~~Strikethough~~
`code`	`code`
`# Heading`	Heading
`## Sub Heading`	Sub Heading
`[[Internal Link]]`	Internal Link
`[[Display Text\|Internal Link]]`	Display Text
`[Display text](//google.com/)`	Display Text
`> Blockquote > Some text`	Blockquote Some text
`- Apples * Oranges`	Apples Oranges
`1. This is 2. an ordered list`	This is an ordered list
`---`
`![Alt text](//starbeamrainbowlabs.com/favicon-small.png)`

In addition, the following extra syntax is supported for images:

Size the image to at most 250 pixels wide:
![Alt text](//starbeamrainbowlabs.com/favicon-small.png 250px)

Size the image to at most 120px wide and have it float at the right ahnd size of the page:
![Alt text](//starbeamrainbowlabs.com/favicon-small.png 120px right)

Administrator Actions

By default, the delete and move actions are shown on the nav bar. These can be used by administrators to delete or move pages.

The other thing admininistrators can do is update the wiki (provided they know the site's secret). This page can be found here: Update $settings->sitename.

$settings->sitename is currently running on Pepperminty Wiki $version

"; exit(page_renderer::render_main($title, $content)); }); } ]); register_module([ "name" => "Page list", "version" => "0.6", "author" => "Starbeamrainbowlabs", "description" => "Adds a page that lists all the pages in the index along with their metadata.", "id" => "page-list", "code" => function() { add_action("list", function() { global $pageindex, $settings; $title = "All Pages"; $content = "

$title on $settings->sitename

"; $sorted_pageindex = get_object_vars($pageindex); ksort($sorted_pageindex, SORT_NATURAL); $content .= generate_page_list(array_keys($sorted_pageindex)); exit(page_renderer::render_main("$title - $settings->sitename", $content)); }); add_action("list-tags", function() { global $pageindex, $settings; if(!isset($_GET["tag"])) { // Render a list of all tags $all_tags = []; foreach($pageindex as $entry) { if(!isset($entry->tags)) continue; foreach($entry->tags as $tag) { if(!in_array($tag, $all_tags)) $all_tags[] = $tag; } } $content = "

All tags

$tag

"; exit(page_renderer::render("All tags - $settings->sitename", $content)); } $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; } $content = "

$tag

\n"; $content .= generate_page_list($pagelist); exit(page_renderer::render("$tag - Page List - $settings->sitename", $content)); }); } ]); function generate_page_list($pagelist) { global $pageindex; $result = "\n"; foreach($pagelist as $pagename) { $result .= "\t\t\n"; } $result .= "

Page Name	Size	Last Editor	Last Edit Time
$pagename	" . human_filesize($pageindex->$pagename->size) . "	" . $pageindex->$pagename->lasteditor . "	" . human_time_since($pageindex->$pagename->lastmodified) . " (" . date("l jS \of F Y \a\\t h:ia T", $pageindex->$pagename->lastmodified) . ")

"; return $result; } register_module([ "name" => "Login", "version" => "0.7", "author" => "Starbeamrainbowlabs", "description" => "Adds a pair of actions (login and checklogin) that allow users to login. You need this one if you want your users to be able to login.", "id" => "page-login", "code" => function() { /* * _ _ * | | ___ __ _(_)_ __ * | |/ _ \ / _` | | '_ \ * | | (_) | (_| | | | | | * |_|\___/ \__, |_|_| |_| * |___/ %login% */ add_action("login", function() { global $settings; $title = "Login to $settings->sitename"; $content = "

Login to $settings->sitename

\n"; if(isset($_GET["failed"])) $content .= "\t\t

Login failed.

\n"; $content .= "\t\t"; exit(page_renderer::render_main($title, $content)); }); /* * _ _ _ _ * ___| |__ ___ ___| | _| | ___ __ _(_)_ __ * / __| '_ \ / _ \/ __| |/ / |/ _ \ / _` | | '_ \ * | (__| | | | __/ (__| <| | (_) | (_| | | | | | * \___|_| |_|\___|\___|_|\_\_|\___/ \__, |_|_| |_| * %checklogin% |___/ */ 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($settings->users[$user] == hash_password($pass)) { $env->is_logged_in = true; $expiretime = time() + 60*60*24*30; //30 days from now $_SESSION["$settings->sessionprefix-user"] = $user; $_SESSION["$settings->sessionprefix-pass"] = hash_password($pass); $_SESSION["$settings->sessionprefix-expiretime"] = $expiretime; //redirect to wherever the user was going http_response_code(302); if(isset($_POST["goto"])) header("location: " . $_POST["returnto"]); else header("location: index.php"); exit(); } else { http_response_code(302); header("location: index.php?action=login&failed=yes"); exit(); } } else { http_response_code(302); header("location: index.php?action=login&failed=yes&badrequest=yes"); exit(); } }); } ]); /* * @summary Hashes the given password according to the current settings defined * in $settings. * * @param $pass {string} The password to hash. * * @returns {string} The hashed password. Uses sha3 if $settings->use_sha3 is * enabled, or sha256 otherwise. */ function hash_password($pass) { global $settings; if($settings->use_sha3) { return sha3($pass, 256); } else { return hash("sha256", $pass); } } register_module([ "name" => "Logout", "version" => "0.6", "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() { add_action("logout", function() { global $env; $env->is_logged_in = false; unset($env->user); unset($env->pass); //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.7", "author" => "Starbeamrainbowlabs", "description" => "Adds an action to allow administrators to move pages.", "id" => "page-move", "code" => function() { 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.

Go back to $env->page.

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 only contain alphanumeric characters, dashes, and underscores.

")); //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; // 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); } 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); // Exit with a nice message exit(page_renderer::render_main("Moving $env->page", "

$env->page has been moved to $new_name successfully.

")); }); } ]); register_module([ "name" => "Update", "version" => "0.6.1", "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() { 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") { 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.

")); } $settings_separator = "/////////////// Do not edit below this line unless you know what you are doing! ///////////////"; $log = "Beginning update...\n"; $log .= "I am " . __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)) . "

")); }); } ]); register_module([ "name" => "Page viewer", "version" => "0.11", "author" => "Starbeamrainbowlabs", "description" => "Allows you to view pages. You reallyshould include this one.", "id" => "page-view", "code" => function() { add_action("view", function() { global $pageindex, $settings, $env; // Check to make sure that the page exists $page = $env->page; if(!isset($pageindex->$page)) { // todo make this intelligent so we only redirect if the user is acutally able to create the page if($settings->editing) { // Editing is enabled, redirect to the editing page http_response_code(307); // Temporary redirect header("location: index.php?action=edit&newpage=yes&page=" . rawurlencode($env->page)); exit(); } else { // Editing is disabled, show an error message http_response_code(404); exit(page_renderer::render_main("$env->page - 404 - $settings->sitename", "

$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.

")); } } // 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); header("location: ?action=$env->action&page=" . $pageindex->$page->redirect_target . "&redirected_from=$env->page"); exit(); } } $title = "$env->page - $settings->sitename"; if(isset($pageindex->$page->protect) && $pageindex->$page->protect === true) $title = $settings->protectedpagechar . $title; $content = "

$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"] . ".

"; $parsing_start = microtime(true); $content .= parse_page_source(file_get_contents("$env->storage_prefix$env->page.md")); if(!empty($pageindex->$page->tags)) { $content .= "

$tag

\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"; if(isset($_GET["printable"]) and $_GET["printable"] === "yes") exit(page_renderer::render_minimal($title, $content)); else exit(page_renderer::render_main($title, $content)); }); } ]); register_module([ "name" => "Default Parser", "version" => "0.8", "author" => "Johnny Broadway & Starbeamrainbowlabs", "description" => "The default parser for Pepperminty Wiki. Based on Johnny Broadway's Slimdown (with more than a few modifications). This parser's features are documented in the help page.", "id" => "parser-default", "code" => function() { add_parser("default", function($markdown) { return Slimdown::render($markdown); }); } ]); //////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////// Slimdown ///////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// %slimdown% // //////////////////////////////////////////////////////////////////////////////////////////// /** * Slimdown - A very basic regex-based Markdown parser. Supports the * following elements (and can be extended via Slimdown::add_rule()): * * - Headers * - Links * - Bold * - Emphasis * - Deletions * - Quotes * - Inline code * - Blockquotes * - Ordered/unordered lists * - Horizontal rules * * Author: Johnny Broadway * Website: https://gist.github.com/jbroadway/2836900 * License: MIT */ /** * Modified by Starbeamrainbowlabs (starbeamrainbowlabs) * * Changed bold to use single asterisks * Changed italics to use single underscores * Added one to add the heading levels (no

tags allowed) * Added wiki style internal link parsing * Added wiki style internal link parsing with display text * Added image support / class Slimdown { public static $rules = array ( '/\r\n/' => "\n", // new line normalisation '/^(#+)(.)/' => 'self::header', // headers '/(\+)(.?)\1/' => '\2', // bold '/(_)(.?)\1/' => '\2', // emphasis '/!\[(.)\]$([^\s]+)\s(\d+.+)\s(left|right)$/' => ' $\1$ ', // images with size '/!\[(.)\]$([^\s]+)\s(\d+.+)$/' => ' $\1$ ', // images with size '/!\[(.)\]$(.)$/' => ' $\1$ ', // basic images '/\[\[([a-zA-Z0-9\_\- ]+)\|([a-zA-Z0-9\_\- ]+)\]\]/' => '\2', //internal links with display text '/\[\[([a-zA-Z0-9\_\- ]+)\]\]/' => '\1', //internal links '/\[([^\[]+)\]$([^$]+)\)/' => '\1', // links '/\~\~(.?)\~\~/' => '\1', // del '/\:\"(.?)\"\:/' => '\1', // quote '/`(.?)`/' => '`\1`', // inline code '/\n\s(\|-)(.)/' => 'self::ul_list', // ul lists '/\n[0-9]+\.(.)/' => 'self::ol_list', // ol lists '/\n(>|\>)(.*)/' => 'self::blockquote', // blockquotes '/\n-{3,}/' => "\n
", // horizontal rule '/\n([^\n]+)\n\n/' => 'self::para', // add paragraphs '/<\/ul>\s?
/' => '', // fix extra ul '/<\/ol>\s?
/' => '', // fix extra ol '/<\/blockquote>
/' => "\n" // fix extra blockquote ); private static function para ($regs) { $line = $regs[1]; $trimmed = trim ($line); if (preg_match ('/^<\/?(ul|ol|li|h|p|bl)/', $trimmed)) { return "\n" . $line . "\n"; } return sprintf ("\n
%s
\n", $trimmed); } private static function ul_list ($regs) { $item = $regs[2]; return sprintf ("\n
\n\t
%s
\n
", trim($item)); } private static function ol_list ($regs) { $item = $regs[1]; return sprintf ("\n
\n\t
%s
\n
", trim($item)); } private static function blockquote ($regs) { $item = $regs[2]; return sprintf ("\n
%s
", trim($item)); } private static function header ($regs) { list ($tmp, $chars, $header) = $regs; $level = strlen ($chars); return sprintf ('%s', $level + 1, trim($header), $level + 1); } /** * Add a rule. */ public static function add_rule ($regex, $replacement) { self::$rules[$regex] = $replacement; } /** * Render some Markdown into HTML. */ public static function render ($text) { foreach (self::$rules as $regex => $replacement) { if (is_callable ( $replacement)) { $text = preg_replace_callback ($regex, $replacement, $text); } else { $text = preg_replace ($regex, $replacement, $text); } } return trim ($text); } } //////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////// // %next_module% // // Execute each module's code foreach($modules as $moduledata) { $moduledata["code"](); } // Make sure that the credits page exists if(!isset($actions->credits)) { exit(page_renderer::render_main("Error - $settings->$sitename", "
No credits page detected. The credits page is a required module!
")); } // 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?
")); } ?>

Search Results

" . $result["pagename"] . "

File Information

Description

$settings->sitename credits

Main Credits

Site status

Installed Modules

$title

$settings->sitename Help

Navigating

Editing

Heading

Sub Heading

Administrator Actions

$title on $settings->sitename

All tags

$tag

Login to $settings->sitename

Logout Successful

Moving $env->page

$env->page