mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-12-27 03:14:56 +00:00
9693 lines
416 KiB
PHP
9693 lines
416 KiB
PHP
<?php
|
||
/** The Pepperminty Wiki core */
|
||
$start_time = microtime(true);
|
||
mb_internal_encoding("UTF-8");
|
||
|
||
|
||
/*
|
||
* Pepperminty Wiki
|
||
* ================
|
||
* Inspired by Minty Wiki by am2064
|
||
* Link: https://github.com/am2064/Minty-Wiki
|
||
*
|
||
* Credits:
|
||
* Code by @Starbeamrainbowlabs
|
||
* Parsedown - by erusev and others on github from http://parsedown.org/
|
||
* Mathematical Expression rendering
|
||
* Code: @con-f-use <https://github.com/con-f-use>
|
||
* Rendering: MathJax (https://www.mathjax.org/)
|
||
* Bug reports:
|
||
* #2 - Incorrect closing tag - nibreh <https://github.com/nibreh/>
|
||
* #8 - Rogue <datalist /> tag - nibreh <https://github.com/nibreh/>
|
||
*/
|
||
$guiConfig = <<<'GUICONFIG'
|
||
{
|
||
"sitename": { "type": "text", "description": "Your wiki's name.", "default": "Pepperminty Wiki" },
|
||
"defaultpage": { "type": "text", "description": "The name of the page that will act as the home page for the wiki. This page will be served if you don't specify a page.", "default": "Main Page" },
|
||
"admindetails_name": { "type": "text", "description": "Your name as the wiki administrator.", "default": "Administrator" },
|
||
"admindetails_email": { "type": "email", "description": "Your email address as the wiki administrator. Will be displayed as a support contact address.", "default": "admin@localhost" },
|
||
"favicon": { "type": "url", "description": "A url that points to the favicon you want to use for your wiki. By default this is set to a data: url of a Peppermint (Credit: by bluefrog23, source: https://openclipart.org/detail/19571/peppermint-candy-by-bluefrog23)", "default": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAB3VBMVEXhERHbKCjeVVXjb2/kR0fhKirdHBziDg6qAADaHh7qLy/pdXXUNzfMAADYPj7ZPDzUNzfbHx/fERHpamrqMTHgExPdHx/bLCzhLS3fVFTjT0/ibm7kRkbiLi7aKirdISHeFBTqNDTpeHjgERHYJCTVODjYQkLaPj6/AADVOTnpbW3cIyPdFRXcJCThMjLiTU3ibW3fVVXaKyvcERH4ODj+8fH/////fHz+Fxf4KSn0UFD/CAj/AAD/Xl7/wMD/EhL//v70xMT/+Pj/iYn/HBz/g4P/IyP/Kyv/7Oz0QUH/9PT/+vr/ior/Dg7/vr7/aGj/QED/bGz/AQH/ERH/Jib/R0f/goL/0dH/qan/YWH/7e3/Cwv4R0f/MTH/enr/vLz/u7v/cHD/oKD/n5//aWn+9/f/k5P/0tL/trb/QUH/cXH/dHT/wsL/DQ3/p6f/DAz/1dX/XV3/kpL/i4v/Vlb/2Nj/9/f/pKT+7Oz/V1f/iIj/jIz/r6//Zmb/lZX/j4//T0//Dw/4MzP/GBj/+fn/o6P/TEz/xMT/b2//Tk7/OTn/HR3/hIT/ODj/Y2P/CQn/ZGT/6Oj0UlL/Gxv//f3/Bwf/YmL/6+v0w8P/Cgr/tbX0QkL+9fX4Pz/qNzd0dFHLAAAAAXRSTlMAQObYZgAAAAFiS0dEAIgFHUgAAAAJcEhZcwAACxMAAAsTAQCanBgAAAAHdElNRQfeCxINNSdmw510AAAA5ElEQVQYGQXBzSuDAQCA8eexKXOwmSZepa1JiPJxsJOrCwcnuchBjg4O/gr7D9zk4uAgJzvuMgcTpYxaUZvSm5mUj7TX7ycAqvoLIJBwStVbP0Hom1Z/ejoxrbaR1Jz6nWinbKWttGRgMSSjanPktRY6mB9WtRNTn7Ilh7LxnNpKq2/x5LnBitfz+hx0qxUaxhZ6vwqq9bx6f2XXvuUl9SVQS38NR7cvln3v15tZ9bQpuWDtZN3Lgh5DWJex3Y+z1KrVhw21+CiM74WZo83DiXq0dVBDYNJkFEU7WrwDAZhRtQrwDzwKQbT6GboLAAAAAElFTkSuQmCC" },
|
||
"logo_url": { "type": "url", "description": "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.", "default": "//starbeamrainbowlabs.com/images/logos/peppermint.png" },
|
||
"logo_position": { "type": "text", "description": "The side of the site name at which the logo should be placed.", "default": "left" },
|
||
"show_subpages": { "type": "checkbox", "description": "Whether to show a list of subpages at the bottom of the page.", "default": true},
|
||
"subpages_display_depth": { "type": "text", "description": "The depth to which we should display when listing subpages at the bottom the page.", "default": 3},
|
||
"random_page_exclude": { "type": "text", "description": "The pages names matching this regular expression won't be chosen when a random page is being picked to send you to by the random action.", "default": "/^Files\\/.*$/i" },
|
||
"random_page_exclude_redirects": { "type": "checkbox", "description": "Causes the random action to avoid sending the user to a redirect page.", "default": true },
|
||
"footer_message": { "type": "textarea", "description": "A message that will appear at the bottom of every page. May contain HTML.", "default": "All content is under <a href='?page=License' target='_blank'>this license</a>. 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." },
|
||
"editing_message": { "type": "textarea", "description": "A message that will appear just before the submit button on the editing page. May contain HTML.", "default": "<a href='?action=help#20-parser-default' target='_blank'>Formatting help</a> (<a href='https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet' target='_blank'>Markdown Cheatsheet</a>)<br />\nBy submitting your edit or uploading your file, you are agreeing to release your changes under <a href='?action=view&page=License' target='_blank'>this license</a>. 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!" },
|
||
"admindisplaychar": { "type": "text", "description": "The string that is prepended before an admin's name on the nav bar. Defaults to a diamond shape (◆).", "default": "◆" },
|
||
"protectedpagechar": { "type": "text", "description": "The string that is prepended a page's name in the page title if it is protected. Defaults to a lock symbol. (🔒)", "default": "🔒" },
|
||
"editing": { "type": "checkbox", "description": "Whether editing is enabled.", "default": true},
|
||
"anonedits": { "type": "checkbox", "description": "Whether users who aren't logged in are allowed to edit your wiki.", "default": false },
|
||
"maxpagesize": { "type": "number", "description": "The maximum page size in characters.", "default": 135000 },
|
||
"parser": { "type": "text", "description": "The parser to use when rendering pages. Defaults to an extended version of parsedown (http://parsedown.org/)", "default": "parsedown" },
|
||
"interwiki_index_location": { "type": "text", "description": "The location to find the interwiki wiki definition file, which contains a list of wikis along with their names, prefixes, and root urls. May be a URL, or simply a file path - as it's passed to file_get_contents(). If left blank, interwiki link parsing is disabled.", "default": null },
|
||
"clean_raw_html": { "type": "checkbox", "description": "Whether page sources should be cleaned of HTML before rendering. It is STRONGLY recommended that you keep this option turned on.", "default": true},
|
||
"enable_math_rendering": { "type": "checkbox", "description": "Whether to enable client side rendering of mathematical expressions with MathJax (https://www.mathjax.org/). Math expressions should be enclosed inside of dollar signs ($). Turn off if you don't use it.", "default": true},
|
||
"users": { "type": "usertable", "description": "An array of usernames and passwords - passwords should be hashed with password_hash() (the hash action can help here)", "default": {
|
||
"admin": {
|
||
"email": "admin@somewhere.com",
|
||
"password": "$2y$10$kX6QgET6SfL47GsJjxwp/.JE6SSJo4Nx8/wG13eNvLDGIduYTlCXO"
|
||
},
|
||
"user": {
|
||
"email": "example@example.net",
|
||
"password": "$2y$10$tWYjgh5WvaJrwiszZ1e2Keo3ras6mqa4ptqruwUn3de4UB6eV9cnW"
|
||
}
|
||
}},
|
||
"admins": { "type": "array", "description": "An array of usernames that are administrators. Administrators can delete and move pages.", "default": [ "admin" ]},
|
||
"anonymous_user_name": { "type": "text", "description": "The default name for anonymous users.", "default": "Anonymous" },
|
||
"user_page_prefix": { "type": "text", "description": "The prefix for user pages. All user pages will be considered to be under this page. User pages have special editing restrictions that prevent anyone other thant he user they belong to from editing them. Should not include the trailing forward slash.", "default": "Users" },
|
||
"user_preferences_button_text": { "type": "text", "description": "The text to display on the button that lets logged in users change their settings. Defaults to a cog (aka a 'gear' in unicode-land).", "default": "⚙ " },
|
||
"password_algorithm": { "type": "text", "description": "The algorithm to utilise when hashing passwords. Takes any value PHP's password_hash() does.", "default": "PASSWORD_DEFAULT" },
|
||
"password_cost": { "type": "number", "description": "The cost to use when hashing passwords.", "default": 12},
|
||
"password_cost_time": { "type": "number", "description": "The desired number of milliseconds to delay by when hashing passwords. Pepperminty Wiki will automatically update the value of password_cost to take the length of time specified here. If you're using PASSWORD_ARGON2I, then the auto-update will be disabled.", "default": 350},
|
||
"password_cost_time_interval": { "type": "number", "description": "The interval, in seconds, at which the password cost should be recalculated. Set to -1 to disable. Default: 1 week", "default": 604800},
|
||
"password_cost_time_lastcheck": { "type": "number", "description": "Pseudo-setting used to keep track of the last recalculation of password_cost. Is updated with the current unix timestamp every time password_cost is recalculated.", "default": 0},
|
||
"new_password_length": { "type": "number", "description": "The length of newly-generated passwords. This is currently used in the user table when creating new accounts.", "default": 32},
|
||
"require_login_view": { "type": "checkbox", "description": "Whether to require that users login before they do anything else. Best used with the data_storage_dir option.", "default": false},
|
||
"data_storage_dir": { "type": "text", "description": "The directory in which to store all files, except the main index.php.", "default": "." },
|
||
"delayed_indexing_time": { "type": "number", "description": "The amount of time, in seconds, that pages should be blocked from being indexed by search engines after their last edit. Aka delayed indexing.", "default": 0},
|
||
"nav_links": { "type": "nav", "description": "<p>An array of links and display text to display at the top of the site.<br />Format: <code>\"Display Text\": \"Link\"</code></p><p>You can also use strings here and they will be printed as-is, except the following special strings:</p><ul><li><code>user-status</code> - Expands to the user's login information. e.g. \"Logged in as {name}. | Logout\", or e.g. \"Browsing as Anonymous. | Login\".</li><li><code>search</code> - Expands to a search box.</li><li><code>divider</code> - Expands to a divider to separate stuff.</li><li><code>more</code> - Expands to the \"More...\" submenu.</li></ul>", "default": [
|
||
"user-status",
|
||
[
|
||
"Home",
|
||
"index.php"
|
||
],
|
||
"search",
|
||
[
|
||
"Read",
|
||
"index.php?page={page}"
|
||
],
|
||
[
|
||
"Edit",
|
||
"index.php?action=edit&page={page}"
|
||
],
|
||
[
|
||
"All Pages",
|
||
"index.php?action=list"
|
||
],
|
||
"menu"
|
||
]},
|
||
"nav_links_extra": { "type": "nav", "description": "An array of additional links in the above format that will be shown under \"More\" subsection.", "default": [
|
||
[
|
||
"⌛ Page History",
|
||
"?action=history&page={page}"
|
||
],
|
||
[
|
||
"🎫 All Tags",
|
||
"index.php?action=list-tags"
|
||
],
|
||
[
|
||
"👥 All Users",
|
||
"index.php?action=user-list"
|
||
],
|
||
[
|
||
"🎊 Random Page",
|
||
"?action=random"
|
||
],
|
||
[
|
||
"🗓 Recent changes",
|
||
"?action=recent-changes"
|
||
],
|
||
[
|
||
"📊 Statistics",
|
||
"?action=stats"
|
||
],
|
||
[
|
||
"🌥 Upload",
|
||
"index.php?action=upload"
|
||
],
|
||
[
|
||
"◆ 🚫 Delete",
|
||
"index.php?action=delete&page={page}"
|
||
],
|
||
[
|
||
"◆ 🚠 Move",
|
||
"index.php?action=move&page={page}"
|
||
],
|
||
[
|
||
"◆ 🔐 Toggle Protection",
|
||
"index.php?action=protect&page={page}"
|
||
],
|
||
[
|
||
"◆ 🔧 Edit master settings",
|
||
"index.php?action=configure"
|
||
]
|
||
]},
|
||
"nav_links_bottom": { "type": "nav", "description": "An array of links in the above format that will be shown at the bottom of the page.", "default": [
|
||
[
|
||
"🖨 Printable version",
|
||
"index.php?action=view&mode=printable&page={page}"
|
||
],
|
||
[
|
||
"Credits",
|
||
"index.php?action=credits"
|
||
],
|
||
[
|
||
"🚪 Help",
|
||
"index.php?action=help"
|
||
]
|
||
]},
|
||
"comment_max_length": { "type": "number", "description": "The maximum allowed length, in characters, for comments", "default": 5000 },
|
||
"comment_min_length": { "type": "number", "description": "The minimum allowed length, in characters, for comments", "default": 10 },
|
||
"comment_time_icon": { "type": "text", "description": "The icon to show next to the time that a comment was posted.", "default": "🕗" },
|
||
"history_max_revisions": { "type": "number", "description": "The maximum revisions that should be stored. If this limit is reached, them the oldest revision will be deleted. Defaults to -1, which is no limit.", "default": -1 },
|
||
"history_revert_require_moderator": { "type": "checkbox", "description": "Whether a user must be a moderator in order use the page reversion functionality.", "default": true },
|
||
"upload_enabled": { "type": "checkbox", "description": "Whether to allow uploads to the server.", "default": true},
|
||
"upload_allowed_file_types": { "type": "array", "description": "An array of mime types that are allowed to be uploaded.", "default": [
|
||
"image/jpeg",
|
||
"image/png",
|
||
"image/gif",
|
||
"image/webp",
|
||
"image/svg+xml",
|
||
"video/mp4",
|
||
"video/webm",
|
||
"audio/mp4",
|
||
"audio/mpeg"
|
||
]},
|
||
"preview_file_type": { "type": "text", "description": "The default file type for previews.", "default": "image/png" },
|
||
"default_preview_size": { "type": "number", "description": "The default size of preview images in pixels.", "default": 640},
|
||
"mime_extension_mappings_location": { "type": "text", "description": "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. See the configuration guide for windows instructions.", "default": "/etc/mime.types" },
|
||
"mime_mappings_overrides": { "type": "map", "description": "Override mappings to convert mime types into the appropriate file extension. Used to override the above file if it assigns weird extensions to any mime types.", "default": {
|
||
"text/plain": "txt",
|
||
"audio/mpeg": "mp3"
|
||
}},
|
||
"min_preview_size": { "type": "number", "description": "The minimum allowed size of generated preview images in pixels.", "default": 1},
|
||
"max_preview_size": { "type": "number", "description": "The maximum allowed size of generated preview images in pixels.", "default": 2048},
|
||
"avatars_show": { "type": "checkbox", "description": "Whether or not to show avatars requires the 'user-preferences' and 'upload' modules, though uploads themselvess can be turned off so long as all avatars have already been uploaded - it's only the 'preview' action that's actually used.", "default": true},
|
||
"avatars_size": { "type": "number", "description": "The image size to render avatars at. Does not affect the size they're stored at - only the inline rendered size (e.g. on the recent changes page etc.)", "default": 32},
|
||
"search_characters_context": { "type": "number", "description": "The number of characters that should be displayed either side of a matching term in the context below each search result.", "default": 75},
|
||
"search_characters_context_total": { "type": "number", "description": "The total number of characters that a search result context should display at most.", "default": 250},
|
||
"search_title_matches_weighting": { "type": "number", "description": "The weighting to give to search term matches found in a page's title.", "default": 10},
|
||
"search_tags_matches_weighting": { "type": "number", "description": "The weighting to give to search term matches found in a page's tags.", "default": 3},
|
||
"dynamic_page_suggestion_count": { "type": "number", "description": "The number of dynamic page name suggestions to fetch from the server when typing in the page search box. Note that lowering this number doesn't <em>really</em> improve performance. Set to 0 to disable.", "default": 7 },
|
||
"defaultaction": { "type": "text", "description": "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).", "default": "view" },
|
||
"updateurl": { "type": "url", "description": "The url from which to fetch updates. Defaults to the master (development) branch. MAKE SURE THAT THIS POINTS TO A *HTTPS* URL, OTHERWISE SOMEONE COULD INJECT A VIRUS INTO YOUR WIKI!", "default": "https://raw.githubusercontent.com/sbrl/pepperminty-wiki/master/index.php" },
|
||
"optimize_pages": { "type": "checkbox", "description": "Whether to optimise all webpages generated.", "default": true},
|
||
"http2_server_push": { "type": "checkbox", "description": "Whether HTTP/2.0 server should should be enabled. If true, then 'link' HTTP headers will be attached to rendered pages specifying files to push down. Note that web server support <em>also</em> has to be abled for this to work, as PHP can't push resources to the client on its own.", "default": true },
|
||
"http2_server_push_items": { "type": "server-push", "description": "An array of items to push to clients when rendering pages. Should be in the format <code>[ [type, path], [type, path], ....]</code>, where <code>type</code> is a <a href='https://fetch.spec.whatwg.org/#concept-request-destination'>resource type</a>, and <code>path</code> is a relative url path to a static file to send via <em>HTTP/2.0 Server Push</em>.<br />Note: These resources will only be pushed if your web server also has support for the link: HTTP/2.0 header, and it's a page that being rendered. If it's some other thing that being sent (e.g. an image, error message, event stream, redirect, etc.), then no server push is indicated by <em>Pepperminty Wiki</em>. Test your estup with your browser's developer tools, or <a href='https://http2-push.io/'>This testing site</a>.", "default": [] },
|
||
"max_recent_changes": { "type": "number", "description": "The maximum number of recent changes to display on the recent changes page.", "default": 512},
|
||
"export_allow_only_admins": { "type": "checkbox", "description": "Whether to only allow adminstrators to export the your wiki as a zip using the page-export module.", "default": false},
|
||
"stats_update_interval": { "type": "number", "description": "The number of seconds which should elapse before a statistics update should be scheduled. Defaults to once a day.", "default": 86400},
|
||
"stats_update_processingtime": { "type": "number", "description": "The maximum number of milliseconds that should be spent at once calculating statistics. If some statistics couldn't fit within this limit, then they are scheduled and updated on the next page load. Note that this is a target only - if an individual statistic takes longer than this, then it won't be interrupted. Defaults to 100ms.", "default": 100},
|
||
"sessionprefix": { "type": "text", "description": "You shouldn't need to change this. The prefix that should be used in the names of the session variables. Defaults to \"auto\", which automatically generates this field. See the readme for more information.", "default": "auto" },
|
||
"sessionlifetime": { "type": "number", "description": "Again, you shouldn't need to change this under normal circumstances. This setting controls the lifetime of a login session. Defaults to 24 hours, but it may get cut off sooner depending on the underlying PHP session lifetime.", "default": 86400 },
|
||
"css": { "type": "textarea", "description": "A string of css to include. Will be included in the <head> of every page inside a <style> tag. This may also be an absolute url - urls will be referenced via a <link rel='stylesheet' /> tag.", "default": "auto" }
|
||
}
|
||
GUICONFIG;
|
||
|
||
$settingsFilename = "peppermint.json";
|
||
|
||
if(file_exists("$settingsFilename.compromised")) {
|
||
http_response_code(500);
|
||
header("content-type: text/plain");
|
||
exit("Error: $settingsFilename.compromised exists on disk, so it's likely you need to block access to 'peppermint.json' from the internet. If you've done this already, please delete $settingsFilename.compromised and reload this page.");
|
||
}
|
||
|
||
$guiConfig = json_decode($guiConfig);
|
||
$settings = new stdClass();
|
||
if(!file_exists($settingsFilename))
|
||
{
|
||
// Copy the default settings over to the main settings array
|
||
foreach ($guiConfig as $key => $value)
|
||
$settings->$key = $value->default;
|
||
// Generate a random secret
|
||
$settings->secret = bin2hex(random_bytes(16));
|
||
file_put_contents("peppermint.json", json_encode($settings, JSON_PRETTY_PRINT));
|
||
}
|
||
else
|
||
$settings = json_decode(file_get_contents("peppermint.json"));
|
||
|
||
if($settings === null)
|
||
{
|
||
header("content-type: text/plain");
|
||
exit("Error: Failed to decode the settings file! Does it contain a syntax error?");
|
||
}
|
||
|
||
// Fill in any missing properties
|
||
$settingsUpgraded = false;
|
||
foreach($guiConfig as $key => $propertyData)
|
||
{
|
||
if(!isset($settings->$key))
|
||
{
|
||
$settings->$key = $propertyData->default;
|
||
$settingsUpgraded = true;
|
||
}
|
||
}
|
||
if($settingsUpgraded)
|
||
file_put_contents("peppermint.json", json_encode($settings, JSON_PRETTY_PRINT));
|
||
|
||
// Insert the default CSS if requested
|
||
$defaultCSS = <<<THEMECSS
|
||
body { margin: 2rem 0 0 0; background: #eee8f2; line-height: 1.45em; color: #111111; font-family: sans-serif; }
|
||
|
||
nav { display: flex; background-color: #8a62a7; color: #ffa74d; }
|
||
nav.top { position: absolute; top: 0; left: 0; right: 0; box-shadow: inset 0 -0.6rem 0.8rem -0.5rem rgba(50, 50, 50, 0.5); }
|
||
nav.bottom { position: absolute; left: 0; right: 0; box-shadow: inset 0 0.8rem 0.8rem -0.5rem rgba(50, 50, 50, 0.5); }
|
||
|
||
nav > span { flex: 1; text-align: center; line-height: 2; display: inline-block; margin: 0; padding: 0.3rem 0.5rem; border-left: 3px solid #442772; border-right: 3px solid #442772; }
|
||
nav:not(.nav-more-menu) a { text-decoration: none; font-weight: bolder; color: inherit; }
|
||
.nav-divider { color: transparent; }
|
||
|
||
.nav-more { position: relative; background-color: #442772; min-width: 10em; }
|
||
.nav-more label { cursor: pointer; }
|
||
.nav-more-menu { display: none; z-index: 10000; position: absolute; flex-direction: column; top: 2.6rem; right: -0.2rem; background-color: #8a62a7; border-top: 3px solid #442772; border-bottom: 3px solid #442772; }
|
||
input[type=checkbox]:checked ~ .nav-more-menu { display: block; box-shadow: 0.4rem 0.4rem 1rem 0 rgba(50, 50, 50, 0.5); }
|
||
.nav-more-menu span { min-width: 10rem; }
|
||
|
||
.inflexible { flex: none; }
|
||
.off-screen { position: absolute; top: -1000px; left: -1000px;}
|
||
|
||
input[type=search] { width: 14rem; padding: 0.3rem 0.4rem; font-size: 1rem; color: white; background: rgba(255, 255, 255, 0.4); border: 0; border-radius: 0.3rem; }
|
||
input[type=search]::-webkit-input-placeholder { color : rgba(255, 255, 255, 0.75); }
|
||
input[type=button], input[type=submit] { cursor: pointer; }
|
||
|
||
.sidebar + .main-container nav.bottom { position: relative; }
|
||
.sidebar { position: relative; z-index: 100; margin-top: 0.6rem; padding: 1rem 3rem 2rem 0.4rem; background: #9e7eb4; box-shadow: inset -0.6rem 0 0.8rem -0.5rem rgba(50, 50, 50, 0.5); }
|
||
.sidebar a { color: #ffa74d; }
|
||
|
||
.sidebar ul { position: relative; margin: 0.3rem 0.3rem 0.3rem 1rem; padding: 0.3rem 0.3rem 0.3rem 1rem; list-style-type: none; }
|
||
.sidebar li { position: relative; margin: 0.3rem; padding: 0.3rem; }
|
||
|
||
.sidebar ul:before { content: ""; position: absolute; top: 0; left: 0; height: 100%; border-left: 2px dashed rgba(50, 50, 50, 0.4); }
|
||
.sidebar li:before { content: ""; position: absolute; width: 1rem; top: 0.8rem; left: -1.2rem; border-bottom: 2px dashed rgba(50, 50, 50, 0.4); }
|
||
|
||
.preview { text-align: center; }
|
||
.preview:hover img, .preview:hover video, .preview:hover audio { --checkerboard-bg: rgba(200, 200, 200, 0.2); max-width: 100%; background-color: #eee; background-image: linear-gradient(45deg, var(--checkerboard-bg) 25%, transparent 25%, transparent 75%, var(--checkerboard-bg) 75%, var(--checkerboard-bg)), linear-gradient(45deg, var(--checkerboard-bg) 25%, transparent 25%, transparent 75%, var(--checkerboard-bg) 75%, var(--checkerboard-bg)); background-size:2em 2em; background-position:0 0, 1em 1em; }
|
||
.image-controls ul { list-style-type: none; margin: 5px; padding: 5px; }
|
||
.image-controls li { display: inline-block; margin: 5px; padding: 5px; }
|
||
.link-display { margin-left: 0.5rem; }
|
||
|
||
audio, video, img { max-width: 100%; }
|
||
figure:not(.preview) { display: inline-block; }
|
||
figure:not(.preview) > :first-child { display: block; }
|
||
figcaption { text-align: center; }
|
||
.avatar { vertical-align: middle; }
|
||
|
||
.printable { padding: 2rem; }
|
||
|
||
h1 { text-align: center; }
|
||
.sitename { margin-top: 5rem; margin-bottom: 3rem; font-size: 2.5rem; }
|
||
.logo { max-width: 4rem; max-height: 4rem; vertical-align: middle; }
|
||
.logo.small { max-width: 2rem; max-height: 2rem; }
|
||
main:not(.printable) { position: relative; z-index: 1000; padding: 2em 2em 0.5em 2em; background: #faf8fb; box-shadow: 0 0.1rem 1rem 0.3rem rgba(50, 50, 50, 0.5); }
|
||
|
||
blockquote { padding-left: 1em; border-left: 0.2em solid #442772; border-radius: 0.2rem; }
|
||
|
||
a { cursor: pointer; }
|
||
a.redlink:link { color: rgb(230, 7, 7); }
|
||
a.redlink:visited { color: rgb(130, 15, 15); /*#8b1a1a*/ }
|
||
a.interwiki_link::before { content: "\\1f6f8"; display: inline-block; margin-right: 0.25em; }
|
||
a.interwiki_link { color: #127757; }
|
||
|
||
.matching-tags-display { display: flex; margin: 0 -2em; padding: 1em 2em; background: hsla(30, 84%, 72%, 0.75); }
|
||
.matching-tags-display > label { flex: 0; font-weight: bold; color: #442772; }
|
||
.matching-tags-display > .tags { flex: 2; }
|
||
|
||
.search-result { position: relative; }
|
||
.search-result::before { content: attr(data-result-number); position: relative; top: 3rem; color: rgba(33, 33, 33, 0.3); font-size: 2rem; }
|
||
.search-result::after { content: "Rank: " attr(data-rank); position: absolute; top: 3.8rem; right: 0.7rem; color: rgba(50, 50, 50, 0.3); }
|
||
.search-result > h2 { margin-left: 3rem; }
|
||
.search-result-badges { font-size: 1rem; font-weight: normal; }
|
||
.search-context { min-height: 3em; max-height: 20em; overflow: hidden; }
|
||
|
||
textarea[name=content] { resize: none; }
|
||
.fit-text-mirror { position: absolute; left: -10000vw; word-wrap: break-word; white-space: pre-wrap; }
|
||
main label:not(.link-display-label) { display: inline-block; min-width: 16rem; }
|
||
input[type=text]:not(.link-display), input[type=password], input[type=url], input[type=email], input[type=number], textarea { margin: 0.5rem 0; }
|
||
input[type=text], input[type=password], input[type=url], input[type=email], input[type=number], textarea, textarea[name=content] + pre, #search-box { padding: 0.5rem 0.8rem; background: #d5cbf9; border: 0; border-radius: 0.3rem; font-size: 1rem; color: #442772; }
|
||
textarea { min-height: 10em; line-height: 1.3em; font-size: 1.25rem; }
|
||
textarea, textarea[name=content] + pre, textarea ~ input[type=submit], #search-box { width: calc(100% - 0.3rem); box-sizing: border-box; }
|
||
textarea ~ input[type=submit] { margin: 0.5rem 0; padding: 0.5rem; font-weight: bolder; }
|
||
.editform input[type=text] { width: calc(100% - 0.3rem); box-sizing: border-box; }
|
||
input.edit-page-button[type='submit'] { width: 49.5%; box-sizing: border-box; }
|
||
.preview-message { text-align: center; }
|
||
@media (min-width: 800px) {
|
||
.jump-to-comments { position: absolute; top: 3.5em; right: 2em; display: block; text-align: right; pointer-events: none; }
|
||
}
|
||
@media (max-width: 799px) {
|
||
.jump-to-comments { display: inline-block; }
|
||
.link-parent-page { display: inline-block; }
|
||
}
|
||
.jump-to-comments > a { pointer-events: all; }
|
||
|
||
.file-gallery { margin: 0.5em; padding: 0.5em; list-style-type: none; }
|
||
.file-gallery > li { display: inline-block; min-width: attr(data-gallery-width); padding: 1em; text-align: center; }
|
||
.file-gallery > li img, .file-gallery > li video, .file-gallery > li audio { display: block; margin: 0 auto; background-color: white; }
|
||
|
||
.page-tags-display { margin: 0.5rem 0 0 0; padding: 0; list-style-type: none; }
|
||
.page-tags-display li { display: inline-block; margin: 0.5rem; padding: 0.5rem; background: #e2d5eb; white-space: nowrap; }
|
||
.page-tags-display li a { color: #fb701a; text-decoration: none; }
|
||
.page-tags-display li::before { content: "\\A"; position: relative; top: 0.03rem; left: -0.9rem; width: 0; height: 0; border-top: 0.6rem solid transparent; border-bottom: 0.6rem solid transparent; border-right: 0.5rem solid #e2d5eb; }
|
||
|
||
.page-list { list-style-type: none; margin: 0.3rem; padding: 0.3rem; }
|
||
.page-list li:not(.header) { margin: 0.3rem; padding: 0.3rem; }
|
||
.page-list li .size { margin-left: 0.7rem; color: rgba(30, 30, 30, 0.5); }
|
||
.page-list li .editor { display: inline-block; margin: 0 0.5rem; }
|
||
.page-list li .tags { margin: 0 1rem; }
|
||
.tag-list { list-style-type: none; margin: 0.5rem; padding: 0.5rem; }
|
||
.tag-list li { display: inline-block; margin: 1rem; }
|
||
.mini-tag { background: #e2d5eb; padding: 0.2rem 0.4rem; color: #fb701a; text-decoration: none; }
|
||
|
||
.help-section-header::after { content: "#" attr(id); float: right; color: rgba(0, 0, 0, 0.4); font-size: 0.8rem; font-weight: normal; }
|
||
|
||
.stacked-bar { display: flex; }
|
||
.stacked-bar-part { break-inside: avoid; white-space: pre; padding: 0.2em 0.3em; }
|
||
|
||
.cursor-query { cursor: help; }
|
||
|
||
summary { cursor: pointer; }
|
||
|
||
.larger { color: rgb(9, 180, 0); }
|
||
.smaller, .deletion { color: rgb(207, 28, 17); }
|
||
.nochange { color: rgb(132, 123, 199); font-style: italic; }
|
||
.significant { font-weight: bolder; font-size: 1.1rem; }
|
||
.deletion, .deletion > .editor { text-decoration: line-through; }
|
||
|
||
.highlighted-diff { white-space: pre-wrap; }
|
||
.diff-added { background-color: rgba(31, 171, 36, 0.6); color: rgba(23, 125, 27, 1); }
|
||
.diff-removed { background-color: rgba(255, 96, 96, 0.6); color: rgba(191, 38, 38, 1); }
|
||
|
||
.newpage::before { content: "N"; margin: 0 0.3em 0 -1em; font-weight: bolder; text-decoration: underline dotted; }
|
||
.move::before { content: "\\1f69a"; font-size: 1.25em; margin: 0 0.1em 0 -1.1em; }
|
||
.upload::before { content: "\\1f845"; margin: 0 0.1em 0 -1.1em; }
|
||
.new-comment::before { content: "\\1f4ac"; margin: 0 0.1em 0 -1.1em; }
|
||
.reversion::before { content: "\\231b"; margin: 0 0.1em 0 -1.1em; }
|
||
|
||
.comments { padding: 1em 2em; background: hsl(31, 64%, 85%); box-shadow: 0 0.1rem 1rem 0.3rem rgba(50, 50, 50, 0.5); }
|
||
.comments textarea { background: hsl(270, 60%, 86%); }
|
||
.comments ::-webkit-input-placeholder { color: hsla(240, 61%, 67%, 0.61); }
|
||
.comments .not-logged-in { padding: 0.3em 0.65em; background: hsla(27, 92%, 68%, 0.64); border-radius: 0.2em; font-style: italic; }
|
||
|
||
.comment { margin: 1em 0; padding: 0.01em 0; background: hsla(30, 84%, 72%, 0.54); }
|
||
.comment-header { padding: 0 1em; }
|
||
.comment .name { font-weight: bold; }
|
||
.comment-body { padding: 0 1em; }
|
||
.comment-footer { padding-left: 1em; }
|
||
.comment-footer-item { padding: 0 0.3em; }
|
||
.comment-footer .delete-button { -moz-appearance: button; -webkit-appearance: button; text-decoration: none; color: #514C4C; }
|
||
.permalink-button { text-decoration: none; }
|
||
.comments-list .comments-list .comment { margin: 1em; }
|
||
|
||
.reply-box-container.active { padding: 1em; background: hsla(32, 82%, 62%, 0.3); }
|
||
|
||
footer { padding: 2rem; }
|
||
/* #ffdb6d #36962c hsl(36, 78%, 80%) hsl(262, 92%, 68%, 0.42) */
|
||
THEMECSS;
|
||
|
||
// This will automatically save to peppermint.json if an automatic takes place
|
||
// for another reason (such as password rehashing or user data updates), but it
|
||
// doesn't really matter because the site name isn't going to change all that
|
||
// often, and even if it does it shouldn't matter :P
|
||
if($settings->sessionprefix == "auto")
|
||
$settings->sessionprefix = "pepperminty-wiki-" . preg_replace('/[^a-z0-9\-_]/', "-", strtolower($settings->sitename));
|
||
|
||
|
||
|
||
/////////////////////////////////////////////////////////////////////////////
|
||
////// Do not edit below this line unless you know what you are doing! //////
|
||
/////////////////////////////////////////////////////////////////////////////
|
||
/** The version of Pepperminty Wiki currently running. */
|
||
$version = "v0.18-dev";
|
||
$commit = "e350d1cc8efeab734f9347ec9fc6f1d1e20bed45";
|
||
/// Environment ///
|
||
/** Holds information about the current request environment. */
|
||
$env = new stdClass();
|
||
/** The action requested by the user. */
|
||
$env->action = $settings->defaultaction;
|
||
/** The page name requested by the remote client. */
|
||
$env->page = "";
|
||
/** The filename that the page is stored in. */
|
||
$env->page_filename = "";
|
||
/** Whether we are looking at a history revision. */
|
||
$env->is_history_revision = false;
|
||
/** An object holding history revision information for the current request */
|
||
$env->history = new stdClass();
|
||
/** The revision number requested of the current page */
|
||
$env->history->revision_number = -1;
|
||
/** The revision data object from the page index for the requested revision */
|
||
$env->history->revision_data = false;
|
||
/** The user's name if they are logged in. Defaults to `$settings->anonymous_user_name` if the user isn't currently logged in. @var string */
|
||
$env->user = $settings->anonymous_user_name;
|
||
/** Whether the user is logged in */
|
||
$env->is_logged_in = false;
|
||
/** Whether the user is an admin (moderator) @todo Refactor this to is_moderator, so that is_admin can be for the server owner. */
|
||
$env->is_admin = false;
|
||
/** The currently logged in user's data. Please see $settings->users->username if you need to edit this - this is here for convenience :-) */
|
||
$env->user_data = new stdClass();
|
||
/** The data storage directory. Page filenames should be prefixed with this if you want their content. */
|
||
$env->storage_prefix = $settings->data_storage_dir . DIRECTORY_SEPARATOR;
|
||
/** Contains performance data statistics for the current request. */
|
||
$env->perfdata = new stdClass();
|
||
/// Paths ///
|
||
/**
|
||
* Contains a bunch of useful paths to various important files.
|
||
* None of these need to be prefixed with `$env->storage_prefix`.
|
||
*/
|
||
$paths = new stdClass();
|
||
/** The pageindex. Contains extensive information about all pages currently in this wiki. Individual entries for pages may be extended with arbitrary properties. */
|
||
$paths->pageindex = "pageindex.json";
|
||
/** The inverted index used for searching. Use the `search` class to interact with this - otherwise your brain might explode :P */
|
||
$paths->searchindex = "invindex.json";
|
||
/** The index that maps ids to page names. Use the `ids` class to interact with it :-) */
|
||
$paths->idindex = "idindex.json";
|
||
/** The cache of the most recently calculated statistics. */
|
||
$paths->statsindex = "statsindex.json";
|
||
/** The interwiki index cache */
|
||
$paths->interwiki_index = "interwiki_index.json";
|
||
|
||
// Prepend the storage data directory to all the defined paths.
|
||
foreach ($paths as &$path) {
|
||
$path = $env->storage_prefix . $path;
|
||
}
|
||
|
||
/** The master settings file @var string */
|
||
$paths->settings_file = $settingsFilename;
|
||
/** The prefix to add to uploaded files */
|
||
$paths->upload_file_prefix = "Files/";
|
||
|
||
session_start();
|
||
// Make sure that the login cookie lasts beyond the end of the user's session
|
||
setcookie(session_name(), session_id(), time() + $settings->sessionlifetime, "", "", false, true);
|
||
///////// Login System /////////
|
||
// Clear expired sessions
|
||
if(isset($_SESSION[$settings->sessionprefix . "-expiretime"]) and
|
||
$_SESSION[$settings->sessionprefix . "-expiretime"] < time())
|
||
{
|
||
// Clear the session variables
|
||
$_SESSION = [];
|
||
session_destroy();
|
||
}
|
||
|
||
if(isset($_SESSION[$settings->sessionprefix . "-user"]) and
|
||
isset($_SESSION[$settings->sessionprefix . "-pass"]))
|
||
{
|
||
// Grab the session variables
|
||
$env->user = $_SESSION[$settings->sessionprefix . "-user"];
|
||
|
||
// The user is logged in
|
||
$env->is_logged_in = true;
|
||
$env->user_data = $settings->users->{$env->user};
|
||
|
||
}
|
||
|
||
// Check to see if the currently logged in user is an admin
|
||
$env->is_admin = false;
|
||
if($env->is_logged_in)
|
||
{
|
||
foreach($settings->admins as $admin_username)
|
||
{
|
||
if($admin_username == $env->user)
|
||
{
|
||
$env->is_admin = true;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
/////// Login System End ///////
|
||
|
||
////////////////////
|
||
// APIDoc strings //
|
||
////////////////////
|
||
/**
|
||
* @apiDefine Admin Only the wiki administrator may use this call.
|
||
*/
|
||
/**
|
||
* @apiDefine Moderator Only users loggged with a moderator account may use this call.
|
||
*/
|
||
/**
|
||
* @apiDefine User Only users loggged in may use this call.
|
||
*/
|
||
/**
|
||
* @apiDefine Anonymous Anybody may use this call.
|
||
*/
|
||
/**
|
||
* @apiDefine UserNotLoggedInError
|
||
* @apiError UserNotLoggedInError You didn't log in before sending this request.
|
||
*/
|
||
/**
|
||
* @apiDefine UserNotModeratorError
|
||
* @apiError UserNotModeratorError You weren't loggged in as a moderator before sending this request.
|
||
*/
|
||
/**
|
||
* @apiDefine PageParameter
|
||
* @apiParam {string} page The page to operate on.
|
||
*/
|
||
////////////////////
|
||
|
||
///////////////////////////////////////////////////////////////////////////////
|
||
////////////////////////////////// Functions //////////////////////////////////
|
||
///////////////////////////////////////////////////////////////////////////////
|
||
/**
|
||
* Get the actual absolute origin of the request sent by the user.
|
||
* @package core
|
||
* @param array $s The $_SERVER variable contents. Defaults to $_SERVER.
|
||
* @param bool $use_forwarded_host Whether to utilise the X-Forwarded-Host header when calculating the actual origin.
|
||
* @return string The actual origin of the user's request.
|
||
*/
|
||
function url_origin( $s = false, $use_forwarded_host = false )
|
||
{
|
||
if($s === false) $s = $_SERVER;
|
||
$ssl = ( ! empty( $s['HTTPS'] ) && $s['HTTPS'] == 'on' );
|
||
$sp = strtolower( $s['SERVER_PROTOCOL'] );
|
||
$protocol = substr( $sp, 0, strpos( $sp, '/' ) ) . ( ( $ssl ) ? 's' : '' );
|
||
$port = $s['SERVER_PORT'];
|
||
$port = ( ( ! $ssl && $port=='80' ) || ( $ssl && $port=='443' ) ) ? '' : ':'.$port;
|
||
$host = ( $use_forwarded_host && isset( $s['HTTP_X_FORWARDED_HOST'] ) ) ? $s['HTTP_X_FORWARDED_HOST'] : ( isset( $s['HTTP_HOST'] ) ? $s['HTTP_HOST'] : null );
|
||
$host = isset( $host ) ? $host : $s['SERVER_NAME'] . $port;
|
||
return $protocol . '://' . $host;
|
||
}
|
||
|
||
/**
|
||
* Get the full url, as requested by the client.
|
||
* @package core
|
||
* @see http://stackoverflow.com/a/8891890/1460422 This Stackoverflow answer.
|
||
* @param array $s The $_SERVER variable. Defaults to $_SERVER.
|
||
* @param bool $use_forwarded_host Whether to take the X-Forwarded-Host header into account.
|
||
* @return string The full url, as requested by the client.
|
||
*/
|
||
function full_url( $s = false, $use_forwarded_host = false )
|
||
{
|
||
if($s == false) $s = $_SERVER;
|
||
return url_origin( $s, $use_forwarded_host ) . $s['REQUEST_URI'];
|
||
}
|
||
|
||
/**
|
||
* Converts a filesize into a human-readable string.
|
||
* @package core
|
||
* @see http://php.net/manual/en/function.filesize.php#106569 The original source
|
||
* @author rommel
|
||
* @author Edited by Starbeamrainbowlabs
|
||
* @param number $bytes The number of bytes to convert.
|
||
* @param number $decimals The number of decimal places to preserve.
|
||
* @return string A human-readable filesize.
|
||
*/
|
||
function human_filesize($bytes, $decimals = 2)
|
||
{
|
||
$sz = ["b", "kb", "mb", "gb", "tb", "pb", "eb", "yb", "zb"];
|
||
$factor = floor((strlen($bytes) - 1) / 3);
|
||
$result = round($bytes / pow(1024, $factor), $decimals);
|
||
return $result . @$sz[$factor];
|
||
}
|
||
|
||
/**
|
||
* Calculates the time since a particular timestamp and returns a
|
||
* human-readable result.
|
||
* @package core
|
||
* @see http://goo.gl/zpgLgq The original source. No longer exists, maybe the wayback machine caught it :-(
|
||
* @param integer $time The timestamp to convert.
|
||
* @return string The time since the given timestamp as
|
||
* a human-readable string.
|
||
*/
|
||
function human_time_since($time)
|
||
{
|
||
return human_time(time() - $time);
|
||
}
|
||
/**
|
||
* Renders a given number of seconds as something that humans can understand more easily.
|
||
* @package core
|
||
* @param int $seconds The number of seconds to render.
|
||
* @return string The rendered time.
|
||
*/
|
||
function human_time($seconds)
|
||
{
|
||
$tokens = array (
|
||
31536000 => 'year',
|
||
2592000 => 'month',
|
||
604800 => 'week',
|
||
86400 => 'day',
|
||
3600 => 'hour',
|
||
60 => 'minute',
|
||
1 => 'second'
|
||
);
|
||
foreach ($tokens as $unit => $text) {
|
||
if ($seconds < $unit) continue;
|
||
$numberOfUnits = floor($seconds / $unit);
|
||
return $numberOfUnits.' '.$text.(($numberOfUnits>1)?'s':'').' ago';
|
||
}
|
||
}
|
||
|
||
/**
|
||
* A recursive glob() function.
|
||
* @package core
|
||
* @see http://in.php.net/manual/en/function.glob.php#106595 The original source
|
||
* @author Mike
|
||
* @param string $pattern The glob pattern to use to find filenames.
|
||
* @param integer $flags The glob flags to use when finding filenames.
|
||
* @return array An array of the filepaths that match the given glob.
|
||
*/
|
||
function glob_recursive($pattern, $flags = 0)
|
||
{
|
||
$files = glob($pattern, $flags);
|
||
foreach (glob(dirname($pattern).'/*', GLOB_ONLYDIR|GLOB_NOSORT) as $dir)
|
||
{
|
||
$prefix = "$dir/";
|
||
// Remove the "./" from the beginning if it exists
|
||
if(substr($prefix, 0, 2) == "./") $prefix = substr($prefix, 2);
|
||
$files = array_merge($files, glob_recursive($prefix . basename($pattern), $flags));
|
||
}
|
||
return $files;
|
||
}
|
||
|
||
/**
|
||
* Gets the name of the parent page to the specified page.
|
||
* @since 0.15
|
||
* @package core
|
||
* @param string $pagename The child page to get the parent
|
||
* page name for.
|
||
* @return string|bool
|
||
*/
|
||
function get_page_parent($pagename) {
|
||
if(mb_strpos($pagename, "/") === false)
|
||
return false;
|
||
return mb_substr($pagename, 0, mb_strrpos($pagename, "/"));
|
||
}
|
||
|
||
/**
|
||
* Gets a list of all the sub pages of the current page.
|
||
* @package core
|
||
* @param object $pageindex The pageindex to use to search.
|
||
* @param string $pagename The name of the page to list the sub pages of.
|
||
* @return object An object containing all the subpages and their
|
||
* respective distances from the given page name in the pageindex tree.
|
||
*/
|
||
function get_subpages($pageindex, $pagename)
|
||
{
|
||
$pagenames = get_object_vars($pageindex);
|
||
$result = new stdClass();
|
||
|
||
$stem = "$pagename/";
|
||
$stem_length = strlen($stem);
|
||
foreach($pagenames as $entry => $value)
|
||
{
|
||
if(substr($entry, 0, $stem_length) == $stem)
|
||
{
|
||
// We found a subpage
|
||
|
||
// Extract the subpage's key relative to the page that we are searching for
|
||
$subpage_relative_key = substr($entry, $stem_length, -3);
|
||
// Calculate how many times removed the current subpage is from the current page. 0 = direct descendant.
|
||
$times_removed = substr_count($subpage_relative_key, "/");
|
||
// Store the name of the subpage we found
|
||
$result->$entry = $times_removed;
|
||
}
|
||
}
|
||
|
||
unset($pagenames);
|
||
return $result;
|
||
}
|
||
|
||
/**
|
||
* Makes sure that a subpage's parents exist.
|
||
* Note this doesn't check the pagename itself.
|
||
* @package core
|
||
* @param $pagename The pagename to check.
|
||
*/
|
||
function check_subpage_parents($pagename)
|
||
{
|
||
global $pageindex, $paths, $env;
|
||
// Save the new pageindex and return if there aren't any more parent pages to check
|
||
if(strpos($pagename, "/") === false)
|
||
{
|
||
file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT));
|
||
return;
|
||
}
|
||
|
||
$parent_pagename = substr($pagename, 0, strrpos($pagename, "/"));
|
||
$parent_page_filename = "$parent_pagename.md";
|
||
if(!file_exists($env->storage_prefix . $parent_page_filename))
|
||
{
|
||
// This parent page doesn't exist! Create it and add it to the page index.
|
||
touch($env->storage_prefix . $parent_page_filename, 0);
|
||
|
||
$newentry = new stdClass();
|
||
$newentry->filename = $parent_page_filename;
|
||
$newentry->size = 0;
|
||
$newentry->lastmodified = 0;
|
||
$newentry->lasteditor = "none";
|
||
$pageindex->$parent_pagename = $newentry;
|
||
}
|
||
|
||
check_subpage_parents($parent_pagename);
|
||
}
|
||
|
||
/**
|
||
* Makes a path (or page name) safe.
|
||
* A safe path / page name may not contain:
|
||
* Forward-slashes at the beginning
|
||
* Multiple dots in a row
|
||
* Odd characters (e.g. ?%*:|"<>() etc.)
|
||
* A safe path may, however, contain unicode characters such as éôà etc.
|
||
* @package core
|
||
* @param string $string The string to make safe.
|
||
* @return string A safe version of the given string.
|
||
*/
|
||
function makepathsafe($string)
|
||
{
|
||
// Old restrictive system
|
||
//$string = preg_replace("/[^0-9a-zA-Z\_\-\ \/\.]/i", "", $string);
|
||
// Remove reserved characters
|
||
$string = preg_replace("/[?%*:|\"><()\\[\\]]/i", "", $string);
|
||
// Collapse multiple dots into a single dot
|
||
$string = preg_replace("/\.+/", ".", $string);
|
||
// Don't allow slashes at the beginning
|
||
$string = ltrim($string, "\\/");
|
||
return $string;
|
||
}
|
||
|
||
/**
|
||
* Hides an email address from bots by adding random html entities.
|
||
* @todo Make this more clevererer :D
|
||
* @package core
|
||
* @param string $str The original email address
|
||
* @return string The mangled email address.
|
||
*/
|
||
function hide_email($str)
|
||
{
|
||
$hidden_email = "";
|
||
for($i = 0; $i < strlen($str); $i++)
|
||
{
|
||
if($str[$i] == "@")
|
||
{
|
||
$hidden_email .= "&#" . ord("@") . ";";
|
||
continue;
|
||
}
|
||
if(rand(0, 1) == 0)
|
||
$hidden_email .= $str[$i];
|
||
else
|
||
$hidden_email .= "&#" . ord($str[$i]) . ";";
|
||
}
|
||
|
||
return $hidden_email;
|
||
}
|
||
/**
|
||
* Checks to see if $haystack starts with $needle.
|
||
* @package core
|
||
* @param string $haystack The string to search.
|
||
* @param string $needle The string to search for at the beginning
|
||
* of $haystack.
|
||
* @return boolean Whether $needle can be found at the beginning
|
||
* of $haystack.
|
||
*/
|
||
function starts_with($haystack, $needle)
|
||
{
|
||
$length = strlen($needle);
|
||
return (substr($haystack, 0, $length) === $needle);
|
||
}
|
||
|
||
/**
|
||
* Case-insensitively finds all occurrences of $needle in $haystack. Handles
|
||
* UTF-8 characters correctly.
|
||
* @package core
|
||
* @see http://www.pontikis.net/tip/?id=16 the source
|
||
* @see http://www.php.net/manual/en/function.strpos.php#87061 the source that the above was based on
|
||
* @param string $haystack The string to search.
|
||
* @param string $needle The string to find.
|
||
* @return array|false An array of match indices, or false if
|
||
* nothing was found.
|
||
*/
|
||
function mb_stripos_all($haystack, $needle) {
|
||
$s = 0; $i = 0;
|
||
while(is_integer($i)) {
|
||
$i = mb_stripos($haystack, $needle, $s);
|
||
if(is_integer($i)) {
|
||
$aStrPos[] = $i;
|
||
$s = $i + (function_exists("mb_strlen") ? mb_strlen($needle) : strlen($needle));
|
||
}
|
||
}
|
||
if(isset($aStrPos))
|
||
return $aStrPos;
|
||
else
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Tests whether a string starts with a specified substring.
|
||
* @package core
|
||
* @param string $haystack The string to check against.
|
||
* @param string $needle The substring to look for.
|
||
* @return bool Whether the string starts with the specified substring.
|
||
*/
|
||
function startsWith($haystack, $needle) {
|
||
return $needle === "" || strrpos($haystack, $needle, -strlen($haystack)) !== false;
|
||
}
|
||
/**
|
||
* Tests whether a string ends with a given substring.
|
||
* @package core
|
||
* @param string $whole The string to test against.
|
||
* @param string $end The substring test for.
|
||
* @return bool Whether $whole ends in $end.
|
||
*/
|
||
function endsWith($whole, $end)
|
||
{
|
||
return (strpos($whole, $end, strlen($whole) - strlen($end)) !== false);
|
||
}
|
||
/**
|
||
* Replaces the first occurrence of $find with $replace.
|
||
* @package core
|
||
* @param string $find The string to search for.
|
||
* @param string $replace The string to replace the search string with.
|
||
* @param string $subject The string ot perform the search and replace on.
|
||
* @return string The source string after the find and replace has been performed.
|
||
*/
|
||
function str_replace_once($find, $replace, $subject)
|
||
{
|
||
$index = strpos($subject, $find);
|
||
if($index !== false)
|
||
return substr_replace($subject, $replace, $index, strlen($find));
|
||
return $subject;
|
||
}
|
||
|
||
/**
|
||
* Returns the system's mime type mappings, considering the first extension
|
||
* listed to be cacnonical.
|
||
* @package core
|
||
* @see http://stackoverflow.com/a/1147952/1460422 From this stackoverflow answer
|
||
* @author chaos
|
||
* @author Edited by Starbeamrainbowlabs
|
||
* @return array An array of mime type mappings.
|
||
*/
|
||
function system_mime_type_extensions()
|
||
{
|
||
global $settings;
|
||
$out = array();
|
||
$file = fopen($settings->mime_extension_mappings_location, 'r');
|
||
while(($line = fgets($file)) !== false) {
|
||
$line = trim(preg_replace('/#.*/', '', $line));
|
||
if(!$line)
|
||
continue;
|
||
$parts = preg_split('/\s+/', $line);
|
||
if(count($parts) == 1)
|
||
continue;
|
||
$type = array_shift($parts);
|
||
if(!isset($out[$type]))
|
||
$out[$type] = array_shift($parts);
|
||
}
|
||
fclose($file);
|
||
return $out;
|
||
}
|
||
|
||
/**
|
||
* Converts a given mime type to it's associated file extension.
|
||
* @package core
|
||
* @see http://stackoverflow.com/a/1147952/1460422 From this stackoverflow answer
|
||
* @author chaos
|
||
* @author Edited by Starbeamrainbowlabs
|
||
* @param string $type The mime type to convert.
|
||
* @return string The extension for the given mime type.
|
||
*/
|
||
function system_mime_type_extension($type)
|
||
{
|
||
static $exts;
|
||
if(!isset($exts))
|
||
$exts = system_mime_type_extensions();
|
||
return isset($exts[$type]) ? $exts[$type] : null;
|
||
}
|
||
|
||
/**
|
||
* Returns the system MIME type mapping of extensions to MIME types.
|
||
* @package core
|
||
* @see http://stackoverflow.com/a/1147952/1460422 From this stackoverflow answer
|
||
* @author chaos
|
||
* @author Edited by Starbeamrainbowlabs
|
||
* @return array An array mapping file extensions to their associated mime types.
|
||
*/
|
||
function system_extension_mime_types()
|
||
{
|
||
global $settings;
|
||
$out = array();
|
||
$file = fopen($settings->mime_extension_mappings_location, 'r');
|
||
while(($line = fgets($file)) !== false) {
|
||
$line = trim(preg_replace('/#.*/', '', $line));
|
||
if(!$line)
|
||
continue;
|
||
$parts = preg_split('/\s+/', $line);
|
||
if(count($parts) == 1)
|
||
continue;
|
||
$type = array_shift($parts);
|
||
foreach($parts as $part)
|
||
$out[$part] = $type;
|
||
}
|
||
fclose($file);
|
||
return $out;
|
||
}
|
||
/**
|
||
* Converts a given file extension to it's associated mime type.
|
||
* @package core
|
||
* @see http://stackoverflow.com/a/1147952/1460422 From this stackoverflow answer
|
||
* @author chaos
|
||
* @author Edited by Starbeamrainbowlabs
|
||
* @param string $ext The extension to convert.
|
||
* @return string The mime type associated with the given extension.
|
||
*/
|
||
function system_extension_mime_type($ext) {
|
||
static $types;
|
||
if(!isset($types))
|
||
$types = system_extension_mime_types();
|
||
$ext = strtolower($ext);
|
||
return isset($types[$ext]) ? $types[$ext] : null;
|
||
}
|
||
|
||
/**
|
||
* Generates a stack trace.
|
||
* @package core
|
||
* @param bool $log_trace Whether to send the stack trace to the error log.
|
||
* @param bool $full Whether to output a full description of all the variables involved.
|
||
* @return string A string prepresentation of a stack trace.
|
||
*/
|
||
function stack_trace($log_trace = true, $full = false)
|
||
{
|
||
$result = "";
|
||
$stackTrace = debug_backtrace();
|
||
$stackHeight = count($stackTrace);
|
||
foreach ($stackTrace as $i => $stackEntry)
|
||
{
|
||
$result .= "#" . ($stackHeight - $i) . ": ";
|
||
$result .= (isset($stackEntry["file"]) ? $stackEntry["file"] : "(unknown file)") . ":" . (isset($stackEntry["line"]) ? $stackEntry["line"] : "(unknown line)") . " - ";
|
||
if(isset($stackEntry["function"]))
|
||
{
|
||
$result .= "(calling " . $stackEntry["function"];
|
||
if(isset($stackEntry["args"]) && count($stackEntry["args"]))
|
||
{
|
||
$result .= ": ";
|
||
$result .= implode(", ", array_map($full ? "var_dump_ret" : "var_dump_short", $stackEntry["args"]));
|
||
}
|
||
}
|
||
$result .= ")\n";
|
||
}
|
||
if($log_trace)
|
||
error_log($result);
|
||
return $result;
|
||
}
|
||
/**
|
||
* Calls var_dump() and returns the output.
|
||
* @package core
|
||
* @param mixed $var The thing to pass to var_dump().
|
||
* @return string The output captured from var_dump().
|
||
*/
|
||
function var_dump_ret($var)
|
||
{
|
||
ob_start();
|
||
var_dump($var);
|
||
return ob_get_clean();
|
||
}
|
||
|
||
/**
|
||
* Calls var_dump(), shortening the output for various types.
|
||
* @package core
|
||
* @param mixed $var The thing to pass to var_dump().
|
||
* @return string A shortened version of the var_dump() output.
|
||
*/
|
||
function var_dump_short($var)
|
||
{
|
||
$result = trim(var_dump_ret($var));
|
||
if(substr($result, 0, 6) === "object" || substr($result, 0, 5) === "array")
|
||
{
|
||
$result = substr($result, 0, strpos($result, " ")) . " { ... }";
|
||
}
|
||
return $result;
|
||
}
|
||
|
||
if (!function_exists('getallheaders')) {
|
||
/**
|
||
* Polyfill for PHP's native getallheaders() function on platforms that
|
||
* don't have it.
|
||
* @package core
|
||
* @todo Identify which platforms don't have it and whether we still need this
|
||
*/
|
||
function getallheaders()
|
||
{
|
||
if (!is_array($_SERVER))
|
||
return [];
|
||
|
||
$headers = array();
|
||
foreach ($_SERVER as $name => $value) {
|
||
if (substr($name, 0, 5) == 'HTTP_') {
|
||
$headers[str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', substr($name, 5)))))] = $value;
|
||
}
|
||
}
|
||
return $headers;
|
||
}
|
||
}
|
||
/**
|
||
* Renders a timestamp in HTML.
|
||
* @package core
|
||
* @param int $timestamp The timestamp to render.
|
||
* @return string HTML representing the given timestamp.
|
||
*/
|
||
function render_timestamp($timestamp)
|
||
{
|
||
return "<time class='cursor-query' title='" . date("l jS \of F Y \a\\t h:ia T", $timestamp) . "'>" . human_time_since($timestamp) . "</time>";
|
||
}
|
||
/**
|
||
* Renders a page name in HTML.
|
||
* @package core
|
||
* @param object $rchange The recent change to render as a page name
|
||
* @return string HTML representing the name of the given page.
|
||
*/
|
||
function render_pagename($rchange)
|
||
{
|
||
global $pageindex;
|
||
$pageDisplayName = $rchange->page;
|
||
if(isset($pageindex->$pageDisplayName) and !empty($pageindex->$pageDisplayName->redirect))
|
||
$pageDisplayName = "<em>$pageDisplayName</em>";
|
||
$pageDisplayLink = "<a href='?page=" . rawurlencode($rchange->page) . "'>$pageDisplayName</a>";
|
||
return $pageDisplayName;
|
||
}
|
||
/**
|
||
* Renders an editor's or a group of editors name(s) in HTML.
|
||
* @package core
|
||
* @param string $editorName The name of the editor to render.
|
||
* @return string HTML representing the given editor's name.
|
||
*/
|
||
function render_editor($editorName)
|
||
{
|
||
return "<span class='editor'>✎ $editorName</span>";
|
||
}
|
||
|
||
/**
|
||
* Saves the settings file back to peppermint.json.
|
||
* @return bool Whether the settings were saved successfully.
|
||
*/
|
||
function save_settings() {
|
||
global $paths, $settings;
|
||
return file_put_contents($paths->settings_file, json_encode($settings, JSON_PRETTY_PRINT)) !== false;
|
||
}
|
||
|
||
/**
|
||
* Saves the currently logged in user's data back to peppermint.json.
|
||
* @package core
|
||
* @return bool Whether the user's data was saved successfully. Returns false if the user isn't logged in.
|
||
*/
|
||
function save_userdata()
|
||
{
|
||
global $env, $settings, $paths;
|
||
|
||
if(!$env->is_logged_in)
|
||
return false;
|
||
|
||
$settings->users->{$env->user} = $env->user_data;
|
||
|
||
return save_settings();
|
||
}
|
||
|
||
/**
|
||
* Figures out the path to the user page for a given username.
|
||
* Does not check to make sure the user acutally exists.
|
||
* @package core
|
||
* @param string $username The username to get the path to their user page for.
|
||
* @return string The path to the given user's page.
|
||
*/
|
||
function get_user_pagename($username) {
|
||
global $settings;
|
||
return "$settings->user_page_prefix/$username";
|
||
}
|
||
/**
|
||
* Extracts a username from a user page path.
|
||
* @package core
|
||
* @param string $userPagename The suer page path to extract from.
|
||
* @return string The name of the user that the user page belongs to.
|
||
*/
|
||
function extract_user_from_userpage($userPagename) {
|
||
global $settings;
|
||
$matches = [];
|
||
preg_match("/$settings->user_page_prefix\\/([^\\/]+)\\/?/", $userPagename, $matches);
|
||
|
||
return $matches[1];
|
||
}
|
||
|
||
/**
|
||
* Sends a plain text email to a user, replacing {username} with the specified username.
|
||
* @package core
|
||
* @param string $username The username to send the email to.
|
||
* @param string $subject The subject of the email.
|
||
* @param string $body The body of the email.
|
||
* @return boolean Whether the email was sent successfully or not. Currently, this may fail if the user doesn't have a registered email address.
|
||
*/
|
||
function email_user($username, $subject, $body)
|
||
{
|
||
global $version, $settings;
|
||
|
||
// If the user doesn't have an email address, then we can't email them :P
|
||
if(empty($settings->users->{$username}->emailAddress))
|
||
return false;
|
||
|
||
$subject = str_replace("{username}", $username, $subject);
|
||
$body = str_replace("{username}", $username, $body);
|
||
|
||
$headers = [
|
||
"content-type" => "text/plain",
|
||
"x-mailer" => "$settings->sitename Pepperminty-Wiki/$version PHP/" . phpversion(),
|
||
"reply-to" => "$settings->admindetails_name <$settings->admindetails_email>"
|
||
];
|
||
$compiled_headers = "";
|
||
foreach($headers as $header => $value)
|
||
$compiled_headers .= "$header: $value\r\n";
|
||
|
||
return mail($settings->users->{$username}->emailAddress, $subject, $body, $compiled_headers, "-t");
|
||
}
|
||
/**
|
||
* Sends a plain text email to a list of users, replacing {username} with each user's name.
|
||
* @package core
|
||
* @param string[] $usernames A list of usernames to email.
|
||
* @param string $subject The subject of the email.
|
||
* @param string $body The body of the email.
|
||
* @return integer The number of emails sent successfully.
|
||
*/
|
||
function email_users($usernames, $subject, $body)
|
||
{
|
||
$emailsSent = 0;
|
||
foreach($usernames as $username)
|
||
{
|
||
$emailsSent += email_user($username, $subject, $body) ? 1 : 0;
|
||
}
|
||
return $emailsSent;
|
||
}
|
||
|
||
///////////////////////////////////////////////////////////////////////////////
|
||
|
||
///////////////////////////////////////////////////////////////////////////////
|
||
////////////////////// Security and Consistency Measures //////////////////////
|
||
///////////////////////////////////////////////////////////////////////////////
|
||
|
||
/*
|
||
* Sort out the pageindex. Create it if it doesn't exist, and load + parse it
|
||
* if it does.
|
||
*/
|
||
if(!file_exists($paths->pageindex))
|
||
{
|
||
$glob_str = $env->storage_prefix . "*.md";
|
||
$existingpages = glob_recursive($glob_str);
|
||
// Debug statements. Uncomment when debugging the pageindex regenerator.
|
||
// var_dump($env->storage_prefix);
|
||
// var_dump($glob_str);
|
||
// var_dump($existingpages);
|
||
$pageindex = new stdClass();
|
||
// We use a for loop here because foreach doesn't loop over new values inserted
|
||
// while we were looping
|
||
for($i = 0; $i < count($existingpages); $i++)
|
||
{
|
||
$pagefilename = $existingpages[$i];
|
||
|
||
// Create a new entry
|
||
$newentry = new stdClass();
|
||
$newentry->filename = substr( // Store the filename, whilst trimming the storage prefix
|
||
$pagefilename,
|
||
mb_strlen(preg_replace("/^\.\//iu", "", $env->storage_prefix)) // glob_recursive trim the ./ from returned filenames , so we need to as well
|
||
);
|
||
// Remove the `./` from the beginning if it's still hanging around
|
||
if(substr($newentry->filename, 0, 2) == "./")
|
||
$newentry->filename = substr($newentry->filename, 2);
|
||
$newentry->size = filesize($pagefilename); // Store the page size
|
||
$newentry->lastmodified = filemtime($pagefilename); // Store the date last modified
|
||
// Todo find a way to keep the last editor independent of the page index
|
||
$newentry->lasteditor = "unknown"; // Set the editor to "unknown"
|
||
// Extract the name of the (sub)page without the ".md"
|
||
$pagekey = mb_substr($newentry->filename, 0, -3);
|
||
|
||
if(file_exists($env->storage_prefix . $pagekey) && // If it exists...
|
||
!is_dir($env->storage_prefix . $pagekey)) // ...and isn't a directory
|
||
{
|
||
// This page (potentially) has an associated file!
|
||
// Let's investigate.
|
||
|
||
// Blindly add the file to the pageindex for now.
|
||
// Future We might want to do a security check on the file later on.
|
||
// File a bug if you think we should do this.
|
||
$newentry->uploadedfile = true; // Yes this page does have an uploaded file associated with it
|
||
$newentry->uploadedfilepath = $pagekey; // It's stored here
|
||
|
||
// Work out what kind of file it really is
|
||
$mimechecker = finfo_open(FILEINFO_MIME_TYPE);
|
||
$newentry->uploadedfilemime = finfo_file($mimechecker, $env->storage_prefix . $pagekey);
|
||
}
|
||
|
||
// Debug statements. Uncomment when debugging the pageindex regenerator.
|
||
// echo("pagekey: ");
|
||
// var_dump($pagekey);
|
||
// echo("newentry: ");
|
||
// var_dump($newentry);
|
||
|
||
// Subpage parent checker
|
||
if(strpos($pagekey, "/") !== false)
|
||
{
|
||
// We have a sub page people
|
||
// Work out what our direct parent's key must be in order to check to
|
||
// make sure that it actually exists. If it doesn't, then we need to
|
||
// create it.
|
||
$subpage_parent_key = substr($pagekey, 0, strrpos($pagekey, "/"));
|
||
$subpage_parent_filename = "$env->storage_prefix$subpage_parent_key.md";
|
||
if(array_search($subpage_parent_filename, $existingpages) === false)
|
||
{
|
||
// Our parent page doesn't actually exist - create it
|
||
touch($subpage_parent_filename, 0);
|
||
// Furthermore, we should add this page to the list of existing pages
|
||
// in order for it to be indexed
|
||
$existingpages[] = $subpage_parent_filename;
|
||
}
|
||
}
|
||
|
||
// Store the new entry in the new page index
|
||
$pageindex->$pagekey = $newentry;
|
||
}
|
||
file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT));
|
||
unset($existingpages);
|
||
}
|
||
else
|
||
{
|
||
$pageindex_read_start = microtime(true);
|
||
$pageindex = json_decode(file_get_contents($paths->pageindex));
|
||
$env->perfdata->pageindex_decode_time = round((microtime(true) - $pageindex_read_start)*1000, 3);
|
||
header("x-pageindex-decode-time: " . $env->perfdata->pageindex_decode_time . "ms");
|
||
}
|
||
|
||
//////////////////////////
|
||
///// Page id system /////
|
||
//////////////////////////
|
||
if(!file_exists($paths->idindex))
|
||
file_put_contents($paths->idindex, "{}");
|
||
$idindex_decode_start = microtime(true);
|
||
$idindex = json_decode(file_get_contents($paths->idindex));
|
||
$env->perfdata->idindex_decode_time = round((microtime(true) - $idindex_decode_start)*1000, 3);
|
||
/**
|
||
* Provides an interface to interact with page ids.
|
||
* @package core
|
||
*/
|
||
class ids
|
||
{
|
||
/**
|
||
* Gets the page id associated with the given page name.
|
||
* If it doesn't exist in the id index, it will be added.
|
||
* @package core
|
||
* @param string $pagename The name of the page to fetch the id for.
|
||
* @return integer The id for the specified page name.
|
||
*/
|
||
public static function getid($pagename)
|
||
{
|
||
global $idindex;
|
||
|
||
$pagename_norm = Normalizer::normalize($pagename, Normalizer::FORM_C);
|
||
foreach ($idindex as $id => $entry)
|
||
{
|
||
// We don't need to normalise here because we normralise when assigning ids
|
||
if($entry == $pagename_norm)
|
||
return $id;
|
||
}
|
||
|
||
// This pagename doesn't have an id - assign it one quick!
|
||
return self::assign($pagename);
|
||
}
|
||
|
||
/**
|
||
* Gets the page name associated with the given page id.
|
||
* Be warned that if the id index is cleared (e.g. when the search index is
|
||
* rebuilt from scratch), the id associated with a page name may change!
|
||
* @package core
|
||
* @param int $id The id to fetch the page name for.
|
||
* @return string The page name currently associated with the specified id.
|
||
*/
|
||
public static function getpagename($id)
|
||
{
|
||
global $idindex;
|
||
|
||
if(!isset($idindex->$id))
|
||
return false;
|
||
else
|
||
return $idindex->$id;
|
||
}
|
||
|
||
/**
|
||
* Moves a page in the id index from $oldpagename to $newpagename.
|
||
* Note that this function doesn't perform any special checks to make sure
|
||
* that the destination name doesn't already exist.
|
||
* @package core
|
||
* @param string $oldpagename The old page name to move.
|
||
* @param string $newpagename The new page name to move the old page name to.
|
||
*/
|
||
public static function movepagename($oldpagename, $newpagename)
|
||
{
|
||
global $idindex, $paths;
|
||
|
||
$pageid = self::getid(Normalizer::normalize($oldpagename, Normalizer::FORM_C));
|
||
$idindex->$pageid = Normalizer::normalize($newpagename, Normalizer::FORM_C);
|
||
|
||
file_put_contents($paths->idindex, json_encode($idindex));
|
||
}
|
||
|
||
/**
|
||
* Removes the given page name from the id index.
|
||
* Note that this function doesn't handle multiple entries with the same
|
||
* name. Also note that it may get re-added during a search reindex if the
|
||
* page still exists.
|
||
* @package core
|
||
* @param string $pagename The page name to delete from the id index.
|
||
*/
|
||
public static function deletepagename($pagename)
|
||
{
|
||
global $idindex, $paths;
|
||
|
||
// Get the id of the specified page
|
||
$pageid = self::getid($pagename);
|
||
// Remove it from the pageindex
|
||
unset($idindex->$pageid);
|
||
// Save the id index
|
||
file_put_contents($paths->idindex, json_encode($idindex));
|
||
}
|
||
|
||
/**
|
||
* Clears the id index completely.
|
||
* Will break the inverted search index! Make sure you rebuild the search
|
||
* index (if the search module is installed, of course) if you want search
|
||
* to still work. Of course, note that will re-add all the pages to the id
|
||
* index.
|
||
* @package core
|
||
*/
|
||
public static function clear()
|
||
{
|
||
global $paths, $idindex;
|
||
// Delete the old id index
|
||
unlink($paths->idindex);
|
||
// Create the new id index
|
||
file_put_contents($paths->idindex, "{}");
|
||
// Reset the in-memory id index
|
||
$idindex = new stdClass();
|
||
}
|
||
|
||
/**
|
||
* Assigns an id to a pagename. Doesn't check to make sure that
|
||
* pagename doesn't already exist in the id index.
|
||
* @package core
|
||
* @param string $pagename The page name to assign an id to.
|
||
* @return integer The id assigned to the specified page name.
|
||
*/
|
||
protected static function assign($pagename)
|
||
{
|
||
global $idindex, $paths;
|
||
|
||
$pagename = Normalizer::normalize($pagename, Normalizer::FORM_C);
|
||
|
||
$nextid = count(array_keys(get_object_vars($idindex)));
|
||
// Increment the generated id until it's unique
|
||
while(isset($idindex->nextid))
|
||
$nextid++;
|
||
|
||
// Update the id index
|
||
$idindex->$nextid = $pagename;
|
||
|
||
// Save the id index
|
||
file_put_contents($paths->idindex, json_encode($idindex));
|
||
|
||
return $nextid;
|
||
}
|
||
}
|
||
//////////////////////////
|
||
//////////////////////////
|
||
|
||
// Work around an Opera + Syntaxtic bug where there is no margin at the left
|
||
// hand side if there isn't a query string when accessing a .php file.
|
||
if(!isset($_GET["action"]) and !isset($_GET["page"]) and basename(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)) == "index.php")
|
||
{
|
||
http_response_code(302);
|
||
header("location: " . dirname(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)));
|
||
exit();
|
||
}
|
||
|
||
// Make sure that the action is set
|
||
if(empty($_GET["action"]))
|
||
$_GET["action"] = $settings->defaultaction;
|
||
// Make sure that the page is set
|
||
if(empty($_GET["page"]) or strlen($_GET["page"]) === 0)
|
||
$_GET["page"] = $settings->defaultpage;
|
||
|
||
// Redirect the user to the safe version of the path if they entered an unsafe character
|
||
if(makepathsafe($_GET["page"]) !== $_GET["page"])
|
||
{
|
||
http_response_code(301);
|
||
header("location: index.php?action=" . rawurlencode($_GET["action"]) . "&page=" . makepathsafe($_GET["page"]));
|
||
header("x-requested-page: " . $_GET["page"]);
|
||
header("x-actual-page: " . makepathsafe($_GET["page"]));
|
||
exit();
|
||
}
|
||
|
||
|
||
////////////////////////////////////////////////////////////////////////////////
|
||
////////////////////////////////////////////////////////////////////////////////
|
||
|
||
////////////////////////////////////////////////////////////////////////////////
|
||
//////////////////////////////// HTML fragments ////////////////////////////////
|
||
////////////////////////////////////////////////////////////////////////////////
|
||
/**
|
||
* Renders the HTML page that is sent to the client.
|
||
* @package core
|
||
*/
|
||
class page_renderer
|
||
{
|
||
/**
|
||
* The root HTML template that all pages are built from.
|
||
* @var string
|
||
* @package core
|
||
*/
|
||
public static $html_template = "<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset='utf-8' />
|
||
<title>{title}</title>
|
||
<meta name='viewport' content='width=device-width, initial-scale=1' />
|
||
<meta name='generator' content='Pepperminty Wiki v0.18-dev' />
|
||
<link rel='shortcut-icon' href='{favicon-url}' />
|
||
<link rel='icon' href='{favicon-url}' />
|
||
{header-html}
|
||
</head>
|
||
<body>
|
||
{body}
|
||
<!-- Took {generation-time-taken}ms to generate -->
|
||
</body>
|
||
</html>
|
||
";
|
||
/**
|
||
* The main content template that is used to render normal wiki pages.
|
||
* @var string
|
||
* @package core
|
||
*/
|
||
public static $main_content_template = "{navigation-bar}
|
||
<h1 class='sitename'>{sitename}</h1>
|
||
<main>
|
||
{content}
|
||
</main>
|
||
{extra}
|
||
<footer>
|
||
<p>{footer-message}</p>
|
||
<p>Powered by Pepperminty Wiki v0.18-dev, which was built by <a href='//starbeamrainbowlabs.com/'>Starbeamrainbowlabs</a>. Send bugs to 'bugs at starbeamrainbowlabs dot com' or <a href='//github.com/sbrl/Pepperminty-Wiki' title='Github Issue Tracker'>open an issue</a>.</p>
|
||
<p>Your local friendly moderators are {admins-name-list}.</p>
|
||
<p>This wiki is managed by <a href='mailto:{admin-details-email}'>{admin-details-name}</a>.</p>
|
||
</footer>
|
||
{navigation-bar-bottom}
|
||
{all-pages-datalist}";
|
||
/**
|
||
* A specially minified content template that doesn't include the navbar and
|
||
* other elements not suitable for printing.
|
||
* @var string
|
||
* @package core
|
||
*/
|
||
public static $minimal_content_template = "<main class='printable'>{content}</main>
|
||
<footer class='printable'>
|
||
<hr class='footerdivider' />
|
||
<p><em>From {sitename}, which is managed by {admin-details-name}.</em></p>
|
||
<p>{footer-message}</p>
|
||
<p><em>Timed at {generation-date}</em></p>
|
||
<p><em>Powered by Pepperminty Wiki v0.18-dev.</em></p>
|
||
</footer>";
|
||
|
||
/**
|
||
* An array of items indicating the resources to ask the web server to push
|
||
* down to the client with HTTP/2.0 server push.
|
||
* Format: [ [type, path], [type, path], .... ]
|
||
* @var array[]
|
||
*/
|
||
protected static $http2_push_items = [];
|
||
|
||
/**
|
||
* An array of functions that have been registered to process the
|
||
* find / replace array before the page is rendered. Note that the function
|
||
* should take a *reference* to an array as its only argument.
|
||
* @var array
|
||
* @package core
|
||
*/
|
||
protected static $part_processors = [];
|
||
|
||
/**
|
||
* Registers a function as a part post processor.
|
||
* This function's use is more complicated to explain. Pepperminty Wiki
|
||
* renders pages with a very simple templating system. For example, in the
|
||
* template a page's content is denoted by `{content}`. A function
|
||
* registered here will be passed all the components of a page _just_
|
||
* before they are dropped into the template. Note that the function you
|
||
* pass in here should take a *reference* to the components, as the return
|
||
* value of the function passed is discarded.
|
||
* @package core
|
||
* @param function $function The part preprocessor to register.
|
||
*/
|
||
public static function register_part_preprocessor($function)
|
||
{
|
||
global $settings;
|
||
|
||
// Make sure that the function we are about to register is valid
|
||
if(!is_callable($function))
|
||
{
|
||
http_response_code(500);
|
||
$admin_name = $settings->admindetails_name;
|
||
$admin_email = hide_email($settings->admindetails_email);
|
||
exit(page_renderer::render("$settings->sitename - Module Error", "<p>$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 <a href='mailto:$admin_email'>$admin_email</a>."));
|
||
}
|
||
|
||
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 = "<img class='logo" . (isset($_GET["printable"]) ? " small" : "") . "' src='$settings->logo_url' />";
|
||
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::get_css_as_html();
|
||
$result .= self::getJS();
|
||
|
||
// 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<link rel='search' type='application/opensearchdescription+xml' href='?action=opensearch-description' title='$settings->sitename Search' />\n";
|
||
|
||
if(!empty($settings->enable_math_rendering))
|
||
{
|
||
$result .= "<script type='text/x-mathjax-config'>
|
||
MathJax.Hub.Config({
|
||
tex2jax: {
|
||
inlineMath: [ ['$','$'], ['\\\\(','\\\\)'] ],
|
||
processEscapes: true,
|
||
skipTags: ['script','noscript','style','textarea','pre','code']
|
||
}
|
||
});
|
||
</script>";
|
||
}
|
||
|
||
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::AddServerPushIndicator("style", $settings->css);
|
||
return "<link rel='stylesheet' href='$settings->css' />\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 "<style>$css</style>\n";
|
||
}
|
||
}
|
||
/**
|
||
* The javascript snippets that will be included in the page.
|
||
* @var string[]
|
||
* @package core
|
||
*/
|
||
private static $jsSnippets = [];
|
||
/**
|
||
* The urls of the external javascript files that should be referenced
|
||
* by the page.
|
||
* @var string[]
|
||
* @package core
|
||
*/
|
||
private static $jsLinks = [];
|
||
/**
|
||
* 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 AddJSLink(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 AddJSSnippet(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 getJS()
|
||
{
|
||
$result = "<!-- Javascript -->\n";
|
||
foreach(static::$jsSnippets as $snippet)
|
||
$result .= "<script defer>\n$snippet\n</script>\n";
|
||
foreach(static::$jsLinks as $link) {
|
||
// Push it via HTTP/2.0 if it's relative
|
||
if($link[0] === "/") self::AddServerPushIndicator("script", $link);
|
||
$result .= "<script src='" . $link . "' defer></script>\n";
|
||
}
|
||
return $result;
|
||
}
|
||
|
||
// ~
|
||
|
||
/**
|
||
* 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 AddServerPushIndicator($type, $path) {
|
||
self::$http2_push_items[] = [ $type, $path ];
|
||
}
|
||
|
||
// ~
|
||
|
||
/**
|
||
* The navigation bar divider.
|
||
* @package core
|
||
* @var string
|
||
*/
|
||
public static $nav_divider = "<span class='nav-divider inflexible'> | </span>";
|
||
|
||
/**
|
||
* 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 = "<nav class='$class'>\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": // Renders the user status box
|
||
if($env->is_logged_in)
|
||
{
|
||
$result .= "<span class='inflexible logged-in" . ($env->is_logged_in ? " moderator" : " normal-user") . "'>";
|
||
if(module_exists("feature-user-preferences")) {
|
||
$result .= "<a href='?action=user-preferences'>$settings->user_preferences_button_text</a>";
|
||
}
|
||
$result .= self::render_username($env->user);
|
||
$result .= " <small>(<a href='index.php?action=logout'>Logout</a>)</small>";
|
||
$result .= "</span>";
|
||
//$result .= page_renderer::$nav_divider;
|
||
}
|
||
else {
|
||
$returnto_url = $env->action !== "logout" ? $_SERVER["REQUEST_URI"] : "?action=view&page=" . rawurlencode($settings->defaultpage);
|
||
$result .= "<span class='not-logged-in'><a href='index.php?action=login&returnto=" . rawurlencode($returnto_url) . "'>Login</a></span>";
|
||
}
|
||
break;
|
||
|
||
case "search": // Renders the search bar
|
||
$result .= "<span class='inflexible'><form method='get' action='index.php' style='display: inline;'><input type='search' name='page' list='allpages' placeholder='Type a page name here and hit enter' /><input type='hidden' name='search-redirect' value='true' /></form></span>";
|
||
break;
|
||
|
||
case "divider": // Renders a divider
|
||
$result .= page_renderer::$nav_divider;
|
||
break;
|
||
|
||
case "menu": // Renders the "More..." menu
|
||
$result .= "<span class='inflexible nav-more'><label for='more-menu-toggler'>More...</label>
|
||
<input type='checkbox' class='off-screen' id='more-menu-toggler' />";
|
||
$result .= page_renderer::render_navigation_bar($nav_links_extra, [], "nav-more-menu");
|
||
$result .= "</span>";
|
||
break;
|
||
|
||
// It isn't a keyword, so just output it directly
|
||
default:
|
||
$result .= "<span>$item</span>";
|
||
}
|
||
}
|
||
else
|
||
{
|
||
// Output the item as a link to a url
|
||
$result .= "<span><a href='" . str_replace("{page}", rawurlencode($env->page), $item[1]) . "'>$item[0]</a></span>";
|
||
}
|
||
}
|
||
|
||
$result .= "</nav>";
|
||
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 .= "<a href='?page=" . rawurlencode(get_user_pagename($name)) . "'>";
|
||
if($settings->avatars_show)
|
||
$result .= "<img class='avatar' src='?action=avatar&user=" . urlencode($name) . "&size=$settings->avatars_size' /> ";
|
||
if(in_array($name, $settings->admins))
|
||
$result .= $settings->admindisplaychar;
|
||
$result .= htmlentities($name);
|
||
$result .= "</a>";
|
||
|
||
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 = "<datalist id='allpages'>\n";
|
||
|
||
// If dynamic page sugggestions are enabled, then we should send a loading message instead.
|
||
if($settings->dynamic_page_suggestion_count > 0)
|
||
{
|
||
$result .= "<option value='Loading suggestions...' />";
|
||
}
|
||
else
|
||
{
|
||
foreach($arrayPageIndex as $pagename => $pagedetails)
|
||
{
|
||
$escapedPageName = str_replace('"', '"', $pagename);
|
||
$result .= "\t\t\t<option value=\"$escapedPageName\" />\n";
|
||
}
|
||
}
|
||
$result .= "\t\t</datalist>";
|
||
|
||
return $result;
|
||
}
|
||
}
|
||
|
||
// HTTP/2.0 Server Push static items
|
||
foreach($settings->http2_server_push_items as $push_item) {
|
||
page_renderer::AddServerPushIndicator($push_item[0], $push_item[1]);
|
||
}
|
||
|
||
// Math rendering support
|
||
if(!empty($settings->enable_math_rendering))
|
||
{
|
||
page_renderer::AddJSLink("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::AddJSSnippet('// 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", "<p>Revision #{$env->history->revision_number} of $env->page doesn't appear to exist. Try viewing the <a href='?action=history&page=" . rawurlencode($env->page) . "'>list of revisions for $env->page</a>, or viewing <a href='?page=" . rawurlencode($env->page) . "'>the latest revision</a> instead.</p>"));
|
||
}
|
||
|
||
$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", "<p>$settings->sitename requires that you login before you are able to access it.</p>
|
||
<p><a href='$url'>Login</a>.</p>"));
|
||
}
|
||
//////////////////////////////////////
|
||
//////////////////////////////////////
|
||
|
||
$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" => 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)
|
||
{
|
||
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;
|
||
}
|
||
/**
|
||
* Parses the specified page source using the parser specified in the settings
|
||
* into HTML.
|
||
* The specified parser may (though it's unilkely) render it to other things.
|
||
* @package core
|
||
* @param string $source The source to render.
|
||
* @return string The source rendered to HTML.
|
||
*/
|
||
function parse_page_source($source)
|
||
{
|
||
global $settings, $parsers;
|
||
if(!isset($parsers[$settings->parser]))
|
||
exit(page_renderer::render_main("Parsing error - $settings->sitename", "<p>Parsing some page source data failed. This is most likely because $settings->sitename has the parser setting set incorrectly. Please contact <a href='mailto:" . hide_email($settings->admindetails_email) . "'>" . $settings->admindetails_name . "</a>, 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
|
||
$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", "<p>$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: <code>$x^2$</code>.</p>
|
||
<p>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).</p>");
|
||
|
||
/** 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", "<p>The <code>GET</code> parameter <code>string</code> must be specified.</p>
|
||
<p>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.</p>"));
|
||
}
|
||
else if(!empty($_GET["raw"]))
|
||
{
|
||
header("content-type: text/plain");
|
||
exit(hash_password($_GET["string"]));
|
||
}
|
||
else
|
||
{
|
||
exit(page_renderer::render_main("Hashed string", "<p>Algorithm: <code>$settings->password_algorithm</code></p>\n<p><code>" . $_GET["string"] . "</code> → <code>" . hash_password($_GET["string"]) . "</code></p>"));
|
||
}
|
||
});
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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() {
|
||
/**
|
||
* @api {get} ?action=protect&page={pageName} Toggle the protection of a page.
|
||
* @apiName Protect
|
||
* @apiGroup Page
|
||
* @apiPermission Moderator
|
||
*
|
||
* @apiParam {string} page The page name to toggle the protection of.
|
||
*/
|
||
|
||
/*
|
||
* ██████ ██████ ██████ ████████ ███████ ██████ ████████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██████ ██ ██ ██ █████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██████ ██ ███████ ██████ ██
|
||
*/
|
||
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, "<p>Page protection for $env->page has been $state.</p><p><a href='?action=$settings->defaultaction&page=$env->page'>Go back</a>."));
|
||
}
|
||
else
|
||
{
|
||
exit(page_renderer::render_main("Error protecting page", "<p>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.</p>"));
|
||
}
|
||
});
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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", "<p>$settings->sitename has a function that can send you to a random page. To use it, click <a href='?action=random'>here</a>. $settings->admindetails_name ($settings->sitename's adminstrator) may have added it to one of the menus.</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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", "<p>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.</p>
|
||
<p>To use this feature, navigate to the page for which you want to see the source, and then alter the <code>action</code> parameter in the url's query string to be <code>raw</code>. If the <code>action</code> 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.</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "API status",
|
||
"version" => "0.1",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Provides a basic JSON status action that provides a few useful bits of information for API consumption.",
|
||
"id" => "api-status",
|
||
"code" => function() {
|
||
global $settings;
|
||
/**
|
||
* @api {get} ?action=status[&minified=type] Get the json-formatted status of this wiki
|
||
* @apiName Status
|
||
* @apiGroup Stats
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiParam {boolean} Whether or not the result should be minified JSON. Default: false
|
||
*/
|
||
|
||
/*
|
||
* ███████ ████████ █████ ████████ ██ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ███████ ██ ██ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ██ ██ ██████ ███████
|
||
*/
|
||
add_action("status", function() {
|
||
global $version, $env, $settings, $actions;
|
||
|
||
$minified = ($_GET["minified"] ?? "false") == "true";
|
||
|
||
$action_names = array_keys(get_object_vars($actions));
|
||
sort($action_names);
|
||
|
||
$result = new stdClass();
|
||
$result->status = "ok";
|
||
$result->version = $version;
|
||
$result->available_actions = $action_names;
|
||
$result->wiki_name = $settings->sitename;
|
||
$result->logo_url = $settings->favicon;
|
||
|
||
header("content-type: application/json");
|
||
exit($minified ? json_encode($result) : json_encode($result, JSON_PRETTY_PRINT) . "\n");
|
||
});
|
||
|
||
add_help_section("960-api-status", "Wiki Status API", "<p>$settings->sitename has a <a href='?action=status'>status page</a> that returns some basic information about the current state of the wiki in <a href='http://www.secretgeek.net/json_3mins'>JSON</a>. It can be used as a connection tester - as the Pepperminty Wiki Android app does.</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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}"] = "<aside class='sidebar'>
|
||
$sidebar_contents
|
||
<!-- Sidebar rendered in " . (microtime(true) - $exec_start) . "s -->
|
||
</aside>
|
||
<div class='main-container'>" . $parts["{body}"] . "</div>
|
||
<!-------------->
|
||
<style>
|
||
body { display: flex; }
|
||
.main-container { flex: 1; }
|
||
</style>";
|
||
}
|
||
});
|
||
|
||
add_help_section("50-sidebar", "Sidebar", "<p>$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.</p>
|
||
<p>If it isn't enabled, it can be enabled for your current browser only by appending <code>sidebar=yes</code> to the current page's query string.</p>");
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* Renders the sidebar for a given pageindex.
|
||
* @package extra-sidebar
|
||
* @param array $pageindex The pageindex to render the sidebar for
|
||
* @param string $root_pagename 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.
|
||
* @return string A HTML rendering of the sidebar for the given pageindex.
|
||
*/
|
||
function render_sidebar($pageindex, $root_pagename = "")
|
||
{
|
||
global $settings;
|
||
|
||
$result = "<ul";
|
||
// If this is the very root of the tree, add an extra class to it
|
||
if($root_pagename == "") $result .= " class='sidebar-tree'";
|
||
$result .=">";
|
||
foreach ($pageindex as $pagename => $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 page already appears on the sidebar, skip it
|
||
if(preg_match("/>$pagename<\a>/m", $result) === 1)
|
||
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 .= "<li><a href='?action=$settings->defaultaction&page=$pagename'>$pagename</a>\n";
|
||
$result .= render_sidebar($pageindex, $pagename);
|
||
$result .= "</li>\n";
|
||
}
|
||
$result .= "</ul>\n";
|
||
|
||
return $result == "<ul></ul>\n" ? "" : $result;
|
||
}
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Page Comments",
|
||
"version" => "0.3.1",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds threaded comments to the bottom of every page.",
|
||
"id" => "feature-comments",
|
||
"code" => function() {
|
||
global $env, $settings;
|
||
|
||
/**
|
||
* @api {post} ?action=comment Comment on a page
|
||
* @apiName Comment
|
||
* @apiGroup Comment
|
||
* @apiPermission User
|
||
* @apiDescription Posts a comment on a page, optionally in reply to another comment. Currently, comments must be made by a logged-in user.
|
||
*
|
||
* @apiParam {string} message The comment text. Supports the same syntax that the renderer of the main page supports. The default is extended markdown - see the help page of the specific wiki for more information.
|
||
* @apiParam {string} replyto Optional. If specified the comment will be posted in reply to the comment with the specified id.
|
||
*
|
||
*
|
||
* @apiError CommentNotFound The comment to reply to was not found.
|
||
*/
|
||
|
||
/*
|
||
* ██████ ██████ ███ ███ ███ ███ ███████ ███ ██ ████████
|
||
* ██ ██ ██ ████ ████ ████ ████ ██ ████ ██ ██
|
||
* ██ ██ ██ ██ ████ ██ ██ ████ ██ █████ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██████ ██ ██ ██ ██ ███████ ██ ████ ██
|
||
*/
|
||
add_action("comment", function() {
|
||
global $settings, $env;
|
||
|
||
$reply_to = $_POST["replyto"] ?? null;
|
||
$message = $_POST["message"] ?? "";
|
||
|
||
if(!$env->is_logged_in) {
|
||
http_response_code(401);
|
||
exit(page_renderer::render_main("Error posting comment - $settings->sitename", "<p>Your comment couldn't be posted because you're not logged in. You can login <a href='?action=index'>here</a>. Here's the comment you tried to post:</p>
|
||
<textarea readonly>$message</textarea>"));
|
||
}
|
||
|
||
$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", "<p>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.</p>"));
|
||
}
|
||
if($message_length > $settings->comment_max_length) {
|
||
http_response_code(422);
|
||
exit(page_renderer::renderer_main("Error posting comment - $settings->sitename", "<p>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:</p>
|
||
<textarea readonly>$message</textarea>"));
|
||
}
|
||
|
||
// 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", "<p>$settings->sitename ran into a problem whilst creating a file to save your comment to! Please contact <a href='mailto:" . hide_email($settings->admindetails_email) . "'>$settings->admindetails_name</a>, $settings->sitename's administrator and tell them about this problem.</p>"));
|
||
}
|
||
}
|
||
|
||
$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", "<p>$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:</p>
|
||
<textarea readonly>$message</textarea>"));
|
||
}
|
||
|
||
$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", "<p>$settings->sitename ran into a problem whilst saving your comment to disk! Please contact <a href='mailto:" . hide_email($settings->admindetails_email) . "'>$settings->admindetails_name</a>, $settings->sitename's administrator and tell them about this problem.</p>"));
|
||
}
|
||
|
||
// 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", "<p>Your comment on $env->page was posted successfully. If your browser doesn't redirect you automagically, please <a href='?action=view&page=" . rawurlencode($env->page) . "commentsuccess=yes#comment-$new_comment->id'>click here</a> to go to the comment you posted on the page you were viewing.</p>"));
|
||
});
|
||
|
||
|
||
/**
|
||
* @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", "<p>You didn't specify the id of a comment to delete.</p>"));
|
||
}
|
||
|
||
// 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", "<p>You can't delete the comment with the id <code>" . htmlentities($target_id) . "</code> on the page <em>$env->page</em> 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 <a href='?action=logout'>Logging out</a> 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", "<p>The comment with the id <code>" . htmlentities($_GET["delete_id"]) . "</code> on the page <em>$env->page</em> wasn't found. Perhaps it was already deleted?</p>"));
|
||
}
|
||
|
||
if(!file_put_contents($comment_filename, json_encode($comments))) {
|
||
http_response_code(503);
|
||
exit(page_renderer::render_main("Server Error - Deleting Comment - $settings->sitename", "<p>While $settings->sitename was able to delete the comment with the id <code>" . htmlentities($target_id) . "</code> on the page <em>$env->page</em>, it couldn't save the changes back to disk. Please contact <a href='mailto:" . hide_email($settings->admindetails_email) . "'>$settings->admindetails_name</a>, $settings->sitename's local friendly administrator about this issue.</p>"));
|
||
}
|
||
|
||
exit(page_renderer::render_main("Comment Deleted - $settings->sitename", "<p>The comment with the id <code>" . htmlentities($target_id) . "</code> on the page <em>$env->page</em> has been deleted successfully. <a href='?page=" . rawurlencode($env->page) . "&redirect=no'>Go back</a> to " . htmlentities($env->page) . ".</p>"));
|
||
});
|
||
/**
|
||
* @api {post} ?action=comments-fetch&page={page_name} Fetch the comments for a page
|
||
* @apiName CommentsFetch
|
||
* @apiGroup Comment
|
||
* @apiPermission Anonymous
|
||
* @apiDescription Fetches the comments for the specified page. Returns them in a nested JSON structure.
|
||
*
|
||
* @apiUse PageParameter
|
||
* @apiError PageNoteFound The page to fetch the comments for was not found.
|
||
*/
|
||
|
||
/*
|
||
* ██████ ██████ ███ ███ ███ ███ ███████ ███ ██ ████████
|
||
* ██ ██ ██ ████ ████ ████ ████ ██ ████ ██ ██
|
||
* ██ ██ ██ ██ ████ ██ ██ ████ ██ █████ ██ ██ ██ ██ █████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██████ ██ ██ ██ ██ ███████ ██ ████ ██
|
||
*
|
||
* ███████ ███████ ████████ ██████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██
|
||
* █████ █████ ██ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ██ ███████ ██ ██████ ██ ██
|
||
*/
|
||
add_action("comments-fetch", function() {
|
||
global $env;
|
||
|
||
$comments_filename = get_comment_filename($env->page);
|
||
if(!file_exists($comments_filename)) {
|
||
http_response_code(404);
|
||
header("content-type: text/plain");
|
||
exit("Error: No comments file was found for the page '$env->page'.");
|
||
}
|
||
|
||
$comments_data = json_decode(file_get_contents($comments_filename));
|
||
|
||
$result = json_encode($comments_data);
|
||
header("content-type: application/json");
|
||
header("content-length: " . strlen($result));
|
||
exit($result);
|
||
});
|
||
|
||
|
||
if($env->action == "view") {
|
||
page_renderer::register_part_preprocessor(function(&$parts) {
|
||
global $env;
|
||
$comments_filename = get_comment_filename($env->page);
|
||
$comments_data = file_exists($comments_filename) ? json_decode(file_get_contents($comments_filename)) : [];
|
||
|
||
|
||
$comments_html = "<aside class='comments'>" .
|
||
"<h2 id='comments'>Comments</h2>\n";
|
||
|
||
if($env->is_logged_in) {
|
||
$comments_html .= "<form class='comment-reply-form' method='post' action='?action=comment&page=" . rawurlencode($env->page) . "'>\n" .
|
||
"<h3>Post a Comment</h3>\n" .
|
||
"\t<textarea name='message' placeholder='Type your comment here. You can use the same syntax you use when writing pages.'></textarea>\n" .
|
||
"\t<input type='hidden' name='replyto' />\n" .
|
||
"\t<input type='submit' value='Post Comment' />\n" .
|
||
"</form>\n";
|
||
}
|
||
else {
|
||
$comments_html .= "<form class='comment-reply-form disabled no-login'>\n" .
|
||
"\t<textarea disabled name='message' placeholder='Type your comment here. You can use the same syntax you use when writing pages.'></textarea>\n" .
|
||
"\t<p class='not-logged-in'><a href='?action=login&returnto=" . rawurlencode("?action=view&page=" . rawurlencode($env->page) . "#comments") . "'>Login</a> to post a comment.</p>\n" .
|
||
"\t<input type='hidden' name='replyto' />\n" .
|
||
"\t<input disabled type='submit' value='Post Comment' title='Login to post a comment.' />\n" .
|
||
"</form>\n";
|
||
}
|
||
|
||
$comments_html .= render_comments($comments_data);
|
||
|
||
$comments_html .= "</aside>\n";
|
||
|
||
$to_comments_link = "<div class='jump-to-comments'><a href='#comments'>Jump to comments</a></div>";
|
||
|
||
$parts["{extra}"] = $comments_html . $parts["{extra}"];
|
||
|
||
$parts["{content}"] = str_replace_once("</h1>", "</h1>\n$to_comments_link", $parts["{content}"]);
|
||
});
|
||
|
||
$reply_js_snippet = <<<'REPLYJS'
|
||
///////////////////////////////////
|
||
///////// Commenting Form /////////
|
||
///////////////////////////////////
|
||
window.addEventListener("load", function(event) {
|
||
var replyButtons = document.querySelectorAll(".reply-button");
|
||
for(let i = 0; i < replyButtons.length; i++) {
|
||
replyButtons[i].addEventListener("click", display_reply_form);
|
||
replyButtons[i].addEventListener("touchend", display_reply_form);
|
||
}
|
||
});
|
||
|
||
function display_reply_form(event)
|
||
{
|
||
// Deep-clone the comment form
|
||
var replyForm = document.querySelector(".comment-reply-form").cloneNode(true);
|
||
replyForm.classList.add("nested");
|
||
// Set the comment we're replying to
|
||
replyForm.querySelector("[name=replyto]").value = event.target.parentElement.parentElement.parentElement.dataset.commentId;
|
||
// Display the newly-cloned commenting form
|
||
var replyBoxContiner = event.target.parentElement.parentElement.parentElement.querySelector(".reply-box-container");
|
||
replyBoxContiner.classList.add("active");
|
||
replyBoxContiner.appendChild(replyForm);
|
||
// Hide the reply button so it can't be pressed more than once - that could
|
||
// be awkward :P
|
||
event.target.parentElement.removeChild(event.target);
|
||
}
|
||
|
||
REPLYJS;
|
||
page_renderer::AddJSSnippet($reply_js_snippet);
|
||
|
||
}
|
||
|
||
add_help_section("29-commenting", "Commenting", "<p>$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.</p>");
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* 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 "<p><em>No comments here! Start the conversation above.</em></p>";
|
||
else
|
||
return "";
|
||
}
|
||
|
||
$result = "<div class='comments-list" . ($depth > 0 ? " nested" : "") . "' data-depth='$depth'>";
|
||
|
||
//$comments_data = array_reverse($comments_data);
|
||
for($i = count($comments_data) - 1; $i >= 0; $i--) {
|
||
$comment = $comments_data[$i];
|
||
|
||
$result .= "\t<div class='comment' id='comment-$comment->id' data-comment-id='$comment->id'>\n";
|
||
$result .= "\t<p class='comment-header'><span class='name'>" . page_renderer::render_username($comment->username ?? "<em>Unknown</em>") . "</span> said:</p>";
|
||
$result .= "\t<div class='comment-body'>\n";
|
||
$result .= "\t\t" . parse_page_source($comment->message);
|
||
$result .= "\t</div>\n";
|
||
$result .= "\t<div class='reply-box-container'></div>\n";
|
||
$result .= "\t<p class='comment-footer'>";
|
||
$result .= "\t\t<span class='comment-footer-item'><button class='reply-button'>Reply</button></span>\n";
|
||
if($env->user == $comment->username || $env->is_admin)
|
||
$result .= "<span class='comment-footer-item'><a href='?action=comment-delete&page=" . rawurlencode($env->page) . "&delete_id=" . rawurlencode($comment->id) . "' class='delete-button' title='Permanently delete this comment'>Delete</a></span>\n";
|
||
$result .= "\t\t<span class='comment-footer-item'><a class='permalink-button' href='#comment-$comment->id' title='Permalink to this comment'>🔗</a></span>\n";
|
||
$result .= "\t\t<span class='comment-footer-item'><time datetime='" . date("c", strtotime($comment->timestamp)) . "' title='The time this comment was posted'>$settings->comment_time_icon " . date("l jS \of F Y \a\\t h:ia T", strtotime($comment->timestamp)) . "</time></span>\n";
|
||
$result .= "\t</p>\n";
|
||
$result .= "\t" . render_comments($comment->replies, $depth + 1) . "\n";
|
||
$result .= "\t</div>";
|
||
}
|
||
$result .= "</div>";
|
||
|
||
return $result;
|
||
}
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Settings GUI",
|
||
"version" => "0.1.3",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "The module everyone has been waiting for! Adds a web based gui that lets mods change the wiki settings.",
|
||
"id" => "feature-guiconfig",
|
||
"code" => function() {
|
||
global $settings;
|
||
/**
|
||
* @api {get} ?action=configure Get a page to change the global wiki settings
|
||
* @apiName ConfigureSettings
|
||
* @apiGroup Utility
|
||
* @apiPermission Moderator
|
||
*/
|
||
|
||
/*
|
||
* ██████ ██████ ███ ██ ███████ ██ ██████ ██ ██ ██████ ███████
|
||
* ██ ██ ██ ████ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ █████ ██ ██ ███ ██ ██ ██████ █████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██████ ██ ████ ██ ██ ██████ ██████ ██ ██ ███████
|
||
*/
|
||
add_action("configure", function() {
|
||
global $settings, $env, $guiConfig, $version, $commit;
|
||
|
||
if(!$env->is_admin)
|
||
{
|
||
$errorMessage = "<p>You don't have permission to change $settings->sitename's master settings.</p>\n";
|
||
if(!$env->is_logged_in)
|
||
$errorMessage .= "<p>You could try <a href='?action=login&returnto=%3Faction%3Dconfigure'>logging in</a>.</p>";
|
||
else
|
||
$errorMessage .= "<p>You could try <a href='?action=logout&returnto=%3Faction%3Dconfigure'>logging out</a> and then <a href='?action=login&returnto=%3Faction%3Dconfigure'>logging in</a> again with a different account that has the appropriate privileges.</a>.</p>";
|
||
exit(page_renderer::render_main("Error - $settings->sitename", $errorMessage));
|
||
}
|
||
|
||
$content = "<h1>Master Control Panel</h1>\n";
|
||
$content .= "<p>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!</p>\n";
|
||
$content .= "<p>You're currently running Pepperminty Wiki $version+" . substr($commit, 0, 7) . ".</p>\n";
|
||
$content .= "<h2>Actions</h2>";
|
||
|
||
$content .= "<button class='action-invindex-rebuild' title='Rebuilds the index that is consulted when searching the wiki. Hit this button if some pages are not showing up.'>Rebuild Search Index</button>\n";
|
||
$content .= "<progress class='action-invindex-rebuild-progress' min='0' max='100' value='0' style='display: none;'></progress><br />\n";
|
||
$content .= "<output class='action-invindex-rebuild-latestmessage'></output><br />\n";
|
||
|
||
$invindex_rebuild_script = <<<SCRIPT
|
||
window.addEventListener("load", function(event) {
|
||
document.querySelector(".action-invindex-rebuild").addEventListener("click", function(event) {
|
||
var rebuildActionEvents = new EventSource("?action=invindex-rebuild");
|
||
var latestMessageElement = document.querySelector(".action-invindex-rebuild-latestmessage");
|
||
var progressElement = document.querySelector(".action-invindex-rebuild-progress");
|
||
rebuildActionEvents.addEventListener("message", function(event) {
|
||
console.log(event);
|
||
let message = event.data;
|
||
latestMessageElement.value = event.data;
|
||
let parts = message.match(/^\[\s*(\d+)\s+\/\s+(\d+)\s*\]/);
|
||
if(parts != null) {
|
||
progressElement.style.display = "";
|
||
progressElement.min = 0;
|
||
progressElement.max = parseInt(parts[2]);
|
||
progressElement.value = parseInt(parts[1]);
|
||
}
|
||
if(message.startsWith("Done! Saving new search index to"))
|
||
rebuildActionEvents.close();
|
||
});
|
||
});
|
||
});
|
||
SCRIPT;
|
||
|
||
page_renderer::AddJSSnippet($invindex_rebuild_script);
|
||
|
||
$content .= "<h2>Settings</h2>";
|
||
$content .= "<p>Mouse over the name of each setting to see a description of what it does.</p>\n";
|
||
$content .= "<form action='?action=configure-save' method='post'>\n";
|
||
|
||
foreach($guiConfig as $configKey => $configData)
|
||
{
|
||
// Don't display the site secret~!
|
||
// Apparently it got lost in translation, but I'll be re-adding
|
||
// it again at some point I'm sure - so support for it is
|
||
// included here.
|
||
if($configKey == "sitesecret") continue;
|
||
|
||
$reverse = false;
|
||
$inputControl = "";
|
||
$label = "<label for='setting-$configKey' title=\"$configData->description\" class='cursor-query'>$configKey</label>";
|
||
switch($configData->type)
|
||
{
|
||
case "url":
|
||
case "email":
|
||
case "number":
|
||
case "text":
|
||
$inputControl = "<input type='$configData->type' id='$configKey' name='$configKey' value='{$settings->$configKey}' />";
|
||
break;
|
||
case "textarea":
|
||
$inputControl = "<textarea id='$configKey' name='$configKey'>{$settings->$configKey}</textarea>";
|
||
break;
|
||
case "checkbox":
|
||
$reverse = true;
|
||
$inputControl = "<input type='checkbox' id='$configKey' name='$configKey' " . ($settings->$configKey ? " checked" : "") . " />";
|
||
break;
|
||
case "usertable":
|
||
$label = "";
|
||
if(module_exists("feature-user-table"))
|
||
$inputControl = "<p>The users can be managed in the <a href='?action=user-table'>User Table</a>.</p>";
|
||
else
|
||
$inputControl = "<p><em>The users can be managed in the user table, but the required module <code>feature-user-table</code> is not installed.</em></p>";
|
||
break;
|
||
default:
|
||
$label = "";
|
||
$inputControl = "<p><em>Sorry! The <code>$configKey</code> setting isn't editable yet through the gui. Please try editing <code>peppermint.json</code> for the time being.</em></p>";
|
||
break;
|
||
}
|
||
|
||
$content .= "<div class='setting-configurator'>\n\t";
|
||
$content .= $reverse ? "$inputControl\n\t$label" : "$label\n\t$inputControl";
|
||
$content .= "\n</div>\n";
|
||
}
|
||
|
||
$content .= "<input type='submit' value='Save Settings' />";
|
||
$content .= "</form>\n";
|
||
|
||
exit(page_renderer::render_main("Master Control Panel - $settings->sitename", $content));
|
||
});
|
||
|
||
/**
|
||
* @api {post} ?action=configure-save Save changes to the global wiki settings
|
||
* @apiName ConfigureSettings
|
||
* @apiGroup Utility
|
||
* @apiPermission Moderator
|
||
*/
|
||
|
||
/*
|
||
* ██████ ██████ ███ ██ ███████ ██ ██████ ██ ██ ██████ ███████
|
||
* ██ ██ ██ ████ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ █████ ██ ██ ███ ██ ██ ██████ █████ █████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██████ ██ ████ ██ ██ ██████ ██████ ██ ██ ███████
|
||
* ███████ █████ ██ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ███████ ███████ ██ ██ █████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ████ ███████
|
||
*/
|
||
add_action("configure-save", function () {
|
||
global $env, $settings, $paths, $defaultCSS;
|
||
|
||
// If the user isn't an admin, then the regular configuration page will display an appropriate error
|
||
if(!$env->is_admin)
|
||
{
|
||
http_response_code(307);
|
||
header("location: ?action=configure");
|
||
exit();
|
||
}
|
||
|
||
// Build a new settings object
|
||
$newSettings = new stdClass();
|
||
foreach($settings as $configKey => $rawValue)
|
||
{
|
||
$configValue = $rawValue;
|
||
if(isset($_POST[$configKey]))
|
||
{
|
||
$decodedConfigValue = json_decode($_POST[$configKey]);
|
||
if(json_last_error() === JSON_ERROR_NONE)
|
||
$configValue = $decodedConfigValue;
|
||
else
|
||
$configValue = $_POST[$configKey];
|
||
|
||
// Convert boolean settings to a boolean, since POST
|
||
// parameters don't decode correctly.
|
||
if(is_bool($settings->$configKey))
|
||
$configValue = in_array($configValue, [ 1, "on"], true) ? true : false;
|
||
|
||
// If the CSS hasn't changed, then we can replace it with
|
||
// 'auto' - this will ensure that upon update the new
|
||
// default CSS will be used. Also make sure we ignore line
|
||
// ending nonsense & differences here, since they really
|
||
// don't matter
|
||
if($configKey === "css" && str_replace("\r\n", "\n", $defaultCSS) === str_replace("\r\n", "\n", $configValue))
|
||
$configValue = "auto";
|
||
}
|
||
|
||
$newSettings->$configKey = $configValue;
|
||
}
|
||
|
||
// Take a backup of the current settings file
|
||
rename($paths->settings_file, "$paths->settings_file.bak");
|
||
// Save the new settings file
|
||
file_put_contents($paths->settings_file, json_encode($newSettings, JSON_PRETTY_PRINT));
|
||
|
||
$content = "<h1>Master settings updated sucessfully</h1>\n";
|
||
$content .= "<p>$settings->sitename's master settings file has been updated successfully. A backup of the original settings has been created under the name <code>peppermint.json.bak</code>, just in case. You can <a href='?action=configure'>go back</a> and continue editing the master settings file, or you can go to the <a href='?action=view&page=" . rawurlencode($settings->defaultpage) . "'>" . htmlentities($settings->defaultpage) . "</a>.</p>\n";
|
||
$content .= "<p>For reference, the newly generated master settings file is as follows:</p>\n";
|
||
$content .= "<textarea name='content'>";
|
||
$content .= json_encode($newSettings, JSON_PRETTY_PRINT);
|
||
$content .= "</textarea>\n";
|
||
exit(page_renderer::render_main("Master Settings Updated - $settings->sitename", $content));
|
||
});
|
||
|
||
add_help_section("800-raw-page-content", "Viewing Raw Page Content", "<p>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.</p>
|
||
<p>To use this feature, navigate to the page for which you want to see the source, and then alter the <code>action</code> parameter in the url's query string to be <code>raw</code>. If the <code>action</code> 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.</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Page History",
|
||
"version" => "0.4.1",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds the ability to keep unlimited page history, limited only by your disk space. Note that this doesn't store file history (yet). Currently depends on feature-recent-changes for rendering of the history page.",
|
||
"id" => "feature-history",
|
||
"code" => function() {
|
||
/**
|
||
* @api {get} ?action=history&page={pageName}[&format={format}] Get a list of revisions for a page
|
||
* @apiName History
|
||
* @apiGroup Page
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiUse PageParameter
|
||
* @apiParam {string} format The format to return the list of pages in. available values: html, json, text. Default: html
|
||
*/
|
||
|
||
/*
|
||
* ██ ██ ██ ███████ ████████ ██████ ██████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ███████ ██ ██ ██ ██████ ████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ███████ ██ ██████ ██ ██ ██
|
||
*/
|
||
add_action("history", function() {
|
||
global $settings, $env, $pageindex;
|
||
|
||
$supported_formats = [ "html", "json", "text" ];
|
||
$format = $_GET["format"] ?? "html";
|
||
|
||
switch($format) {
|
||
case "html":
|
||
$content = "<h1>History for $env->page</h1>\n";
|
||
if(!empty($pageindex->{$env->page}->history))
|
||
{
|
||
$content .= "\t\t<ul class='page-list'>\n";
|
||
foreach(array_reverse($pageindex->{$env->page}->history) as $revisionData)
|
||
{
|
||
// Only display edits & reverts for now
|
||
if(!in_array($revisionData->type, [ "edit", "revert" ]))
|
||
continue;
|
||
|
||
// The number (and the sign) of the size difference to display
|
||
$size_display = ($revisionData->sizediff > 0 ? "+" : "") . $revisionData->sizediff;
|
||
$size_display_class = $revisionData->sizediff > 0 ? "larger" : ($revisionData->sizediff < 0 ? "smaller" : "nochange");
|
||
if($revisionData->sizediff > 500 or $revisionData->sizediff < -500)
|
||
$size_display_class .= " significant";
|
||
$size_title_display = human_filesize($revisionData->newsize - $revisionData->sizediff) . " -> " . human_filesize($revisionData->newsize);
|
||
|
||
$content .= "\t\t\t<li>";
|
||
$content .= "<a href='?page=" . rawurlencode($env->page) . "&revision=$revisionData->rid'>#$revisionData->rid</a> " . render_editor(page_renderer::render_username($revisionData->editor)) . " " . render_timestamp($revisionData->timestamp) . " <span class='cursor-query $size_display_class' title='$size_title_display'>($size_display)</span>";
|
||
if($env->is_logged_in || ($settings->history_revert_require_moderator && $env->is_admin && $env->is_logged_in))
|
||
$content .= " <small>(<a class='revert-button' href='?action=history-revert&page=" . rawurlencode($env->page) . "&revision=$revisionData->rid'>restore this revision</a>)</small>";
|
||
$content .= "</li>\n";
|
||
}
|
||
$content .= "\t\t</ul>";
|
||
}
|
||
else
|
||
{
|
||
$content .= "<p style='text-align: center;'><em>(None yet! Try editing this page and then coming back here.)</em></p>\n";
|
||
}
|
||
exit(page_renderer::render_main("$env->page - History - $settings->sitename", $content));
|
||
|
||
case "json":
|
||
$page_history = $pageindex->{$env->page}->history ?? [];
|
||
|
||
foreach($page_history as &$history_entry) {
|
||
unset($history_entry->filename);
|
||
}
|
||
header("content-type: application/json");
|
||
exit(json_encode($page_history, JSON_PRETTY_PRINT));
|
||
|
||
case "csv":
|
||
$page_history = $pageindex->{$env->page}->history ?? [];
|
||
|
||
header("content-type: text/csv");
|
||
echo("revision_id,timestamp,type,editor,newsize,sizediff\n");
|
||
foreach($page_history as $hentry) {
|
||
echo("$hentry->rid,$hentry->timestamp,$hentry->type,$hentry->editor,$hentry->newsize,$hentry->sizediff\n");
|
||
}
|
||
exit();
|
||
|
||
default:
|
||
http_response_code(400);
|
||
exit(page_renderer::render_main("Format Error - $env->page - History - $settings->sitename", "<p>The format <code>" . htmlentities($format) . "</code> isn't currently supported. Supported formats: html, json, csv"));
|
||
}
|
||
|
||
});
|
||
|
||
/**
|
||
* @api {get} ?action=history-revert&page={pageName}&revision={rid} Revert a page to a previous version
|
||
* @apiName HistoryRevert
|
||
* @apiGroup Editing
|
||
* @apiPermission User
|
||
* @apiUse PageParameter
|
||
* @apiUse UserNotLoggedInError
|
||
* @apiUse UserNotModeratorError
|
||
*
|
||
* @apiParam {string} revision The page revision number to revert to.
|
||
*/
|
||
/*
|
||
* ██ ██ ██ ███████ ████████ ██████ ██████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ███████ ██ ██ ██ ██████ ████ █████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ███████ ██ ██████ ██ ██ ██
|
||
*
|
||
* ██████ ███████ ██ ██ ███████ ██████ ████████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ █████ ██ ██ █████ ██████ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ███████ ████ ███████ ██ ██ ██
|
||
*/
|
||
add_action("history-revert", function() {
|
||
global $env, $settings, $pageindex;
|
||
|
||
if((!$env->is_admin && $settings->history_revert_require_moderator) ||
|
||
!$env->is_logged_in) {
|
||
http_response_code(401);
|
||
exit(page_renderer::render_main("Unauthorised - $settings->sitename", "<p>You can't revert pages to a previous revision because " . ($settings->history_revert_require_moderator && $env->is_logged_in ? "you aren't logged in as a moderator. You can try <a href='?action=logout'>logging out</a> and then" : "you aren't logged in. You can try") . " <a href='?action=login&returnto=" . rawurlencode("?action=history-revert&revision={$env->history->revision_number}&page=" . rawurlencode($env->page)) . "'>logging in</a>.</p>"));
|
||
}
|
||
|
||
$current_revision_filepath = "$env->storage_prefix/{$pageindex->{$env->page}->filename}";
|
||
|
||
// Figure out what we're saving
|
||
$newsource = file_get_contents($env->page_filename); // The old revision content - the Pepperminty Wiki core sorts this out for us
|
||
$oldsource = file_get_contents($current_revision_filepath); // The current revision's content
|
||
|
||
// Save the old content over the current content
|
||
file_put_contents($current_revision_filepath, $newsource);
|
||
|
||
// NOTE: We don't run the save preprocessors here because they are run when a page is edited - reversion is special and requires different treatment.
|
||
// FUTURE: We may want ot refactor the save preprocessor system ot take a single object instead - then we can add as many params as we like and we could execute the save preprocessors as normal :P
|
||
|
||
// Add the old content as a new revision
|
||
$result = history_add_revision(
|
||
$pageindex->{$env->page},
|
||
$newsource,
|
||
$oldsource,
|
||
true, // Yep, go ahead and save the page index
|
||
"revert" // It's a revert, not an edit
|
||
);
|
||
|
||
// Update the redirect metadata, if the redirect module is installed
|
||
if(module_exists("feature-redirect"))
|
||
update_redirect_metadata($pageindex->{$env->page}, $newsource);
|
||
|
||
// Add an entry to the recent changes log, if the module exists
|
||
if($result !== false && module_exists("feature-recent-changes"))
|
||
add_recent_change([
|
||
"type" => "revert",
|
||
"timestamp" => time(),
|
||
"page" => $env->page,
|
||
"user" => $env->user,
|
||
"newsize" => strlen($newsource),
|
||
"sizediff" => strlen($newsource) - strlen($oldsource)
|
||
]);
|
||
|
||
if($result === false) {
|
||
http_response_code(503);
|
||
exit(page_renderer::render_main("Server Error - Revert - $settings->sitename", "<p>A server error occurred when $settings->sitename tried to save the reversion of <code>" . htmlentities($env->page) . "</code>. Please contact $settings->sitename's administrator $settings->admindetails_name, whose email address can be found at the bottom of every page (including this one).</p>"));
|
||
}
|
||
|
||
http_response_code(201);
|
||
exit(page_renderer::render_main("Reverting " . htmlentities($env->page) . " - $settings->sitename", "<p>" . htmlentities($env->page) . " has been reverted back to revision {$env->history->revision_number} successfully.</p>
|
||
<p><a href='?page=" . rawurlencode($env->page) . "'>Go back</a> to the page, or continue <a href='?action=history&page = " . rawurlencode($env->page) . "'>reviewing its history</a>.</p>"));
|
||
|
||
// $env->page_filename
|
||
//
|
||
});
|
||
|
||
register_save_preprocessor("history_add_revision");
|
||
|
||
if(module_exists("feature-stats")) {
|
||
statistic_add([
|
||
"id" => "history_most_revisions",
|
||
"name" => "Most revised page",
|
||
"type" => "scalar",
|
||
"update" => function($old_stats) {
|
||
global $pageindex;
|
||
|
||
$target_pagename = "";
|
||
$target_revisions = -1;
|
||
foreach($pageindex as $pagename => $pagedata) {
|
||
if(!isset($pagedata->history))
|
||
continue;
|
||
|
||
$revisions_count = count($pagedata->history);
|
||
if($revisions_count > $target_revisions) {
|
||
$target_revisions = $revisions_count;
|
||
$target_pagename = $pagename;
|
||
}
|
||
}
|
||
|
||
$result = new stdClass(); // completed, value, state
|
||
$result->completed = true;
|
||
$result->value = "(no revisions saved yet)";
|
||
if($target_revisions > -1) {
|
||
$result->value = "$target_revisions (<a href='?page=" . rawurlencode($target_pagename) . "'>" . htmlentities($target_pagename) . "</a>)";
|
||
}
|
||
|
||
return $result;
|
||
}
|
||
]);
|
||
}
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* Adds a history revision against a page.
|
||
* Note: Does not updaate the current page content! This function _only_
|
||
* records a new revision against a page name. Thus it is possible to have a
|
||
* disparaty between the history revisions and the actual content displayed in
|
||
* the current revision if you're not careful!
|
||
* @param object $pageinfo The pageindex object of the page to operate on.
|
||
* @param string $newsource The page content to save as the new revision.
|
||
* @param string $oldsource The old page content that is the current revision (before the update).
|
||
* @param boolean $save_pageindex Whether the page index should be saved to disk.
|
||
* @param string $change_type The type of change to record this as in the history revision log
|
||
*/
|
||
function history_add_revision(&$pageinfo, &$newsource, &$oldsource, $save_pageindex = true, $change_type = "edit") {
|
||
global $env, $paths, $settings, $pageindex;
|
||
|
||
if(!isset($pageinfo->history))
|
||
$pageinfo->history = [];
|
||
|
||
// Save the *new source* as a revision
|
||
// This results in 2 copies of the current source, but this is ok
|
||
// since any time someone changes something, it creates a new revision
|
||
// Note that we can't save the old source here because we'd have no
|
||
// clue who edited it since $pageinfo has already been updated by
|
||
// this point
|
||
|
||
// TODO Store tag changes here
|
||
end($pageinfo->history); // Calculate the next revision id - we can't just count the reivisions here because we might have a revision limit
|
||
$nextRid = !empty($pageindex->history) ? $pageinfo->history[key($pageinfo->history)]->rid + 1 : 0;
|
||
$ridFilename = "$pageinfo->filename.r$nextRid";
|
||
// Insert a new entry into the history
|
||
$pageinfo->history[] = [
|
||
"type" => $change_type, // We might want to store other types later (e.g. page moves)
|
||
"rid" => $nextRid,
|
||
"timestamp" => time(),
|
||
"filename" => $ridFilename,
|
||
"newsize" => strlen($newsource),
|
||
"sizediff" => strlen($newsource) - strlen($oldsource),
|
||
"editor" => $pageinfo->lasteditor
|
||
];
|
||
|
||
// Save the new source as a revision
|
||
$result = file_put_contents("$env->storage_prefix$ridFilename", $newsource);
|
||
|
||
if($result !== false &&
|
||
$settings->history_max_revisions > -1) {
|
||
while(count($pageinfo->history) > $settings->history_max_revisions) {
|
||
// We've got too many revisions - trim one off & delete it
|
||
$oldest_revision = array_shift($pageinfo->history);
|
||
unlink("$env->storage_prefix/$oldest_revision->filename");
|
||
}
|
||
}
|
||
|
||
// Save the edited pageindex
|
||
if($result !== false && $save_pageindex)
|
||
$result = file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT));
|
||
|
||
|
||
return $result;
|
||
}
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Interwiki links",
|
||
"version" => "0.1",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds interwiki link support. Set the interwiki_index_location setting at an index file to activate support.",
|
||
"id" => "feature-interwiki-links",
|
||
"code" => function() {
|
||
global $env, $settings, $paths;
|
||
if(!empty($settings->interwiki_index_location)) {
|
||
// Generate the interwiki index cache file if it doesn't exist already
|
||
// NOTE: If you want to update the cache file, just delete it & it'll get regenerated automagically :-)
|
||
if(!file_exists($paths->interwiki_index))
|
||
interwiki_index_update();
|
||
else
|
||
$env->interwiki_index = json_decode(file_get_contents($paths->interwiki_index));
|
||
}
|
||
|
||
// TODO: Fill this in
|
||
$doc_help = <<<HELP_BLOCK
|
||
<p>$settings->sitename supports inter-wiki links. Such a link sends the user elsewhere on the internet. By prefixing a page name with a prefix, the convenience of the internal link syntax described above can be exploited to send users elsewhere without having to type out full urls! Here are few examples (note that these prefixes are only examples, and probably aren't available on $settings->sitename - check the list below for supported prefixes):</p>
|
||
|
||
<pre><code>[[another_wiki:Apples]]
|
||
[[trees:Apple Trees]]
|
||
[[history:The Great Rainforest|rainforest]]
|
||
[[any prefix here:page name|Display text]]
|
||
</code></pre>
|
||
|
||
<p>Note that unlike normal internal links, the page name is case-sensitive and can't be case-corrected automatically. The wikis supported by $settings->sitename are as follows:</p>
|
||
HELP_BLOCK;
|
||
|
||
$doc_help .= "<table><tr><th>Name</th><th>Prefix</th>\n";
|
||
foreach($env->interwiki_index as $interwiki_def)
|
||
$doc_help .= "<tr><td>$interwiki_def->name</td><td><code>$interwiki_def->prefix</code></td></tr>\n";
|
||
$doc_help .= "</table>";
|
||
|
||
add_help_section("22-interwiki-links", "Interwiki Links", $doc_help);
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* Updates the interwiki index cache file.
|
||
* If the interwiki_index_location isn't defined, then this function will do
|
||
* nothing.
|
||
*/
|
||
function interwiki_index_update() {
|
||
global $env, $settings, $paths;
|
||
|
||
if(empty($settings->interwiki_index_location))
|
||
return;
|
||
|
||
$env->interwiki_index = new stdClass();
|
||
$interwiki_csv_handle = fopen($settings->interwiki_index_location, "r");
|
||
if($interwiki_csv_handle === false)
|
||
throw new Exception("Error: Failed to read interwiki index from '{$settings->interwiki_index_location}'.");
|
||
|
||
fgetcsv($interwiki_csv_handle); // Discard the header line
|
||
while(($interwiki_data = fgetcsv($interwiki_csv_handle))) {
|
||
$interwiki_def = new stdClass();
|
||
$interwiki_def->name = $interwiki_data[0];
|
||
$interwiki_def->prefix = $interwiki_data[1];
|
||
$interwiki_def->root_url = $interwiki_data[2];
|
||
|
||
$env->interwiki_index->{$interwiki_def->prefix} = $interwiki_def;
|
||
}
|
||
|
||
file_put_contents($paths->interwiki_index, json_encode($env->interwiki_index, JSON_PRETTY_PRINT));
|
||
}
|
||
|
||
/**
|
||
* Parses an interwiki pagename into it's component parts.
|
||
* @param string $interwiki_pagename The interwiki pagename to parse.
|
||
* @return string[] An array containing the parsed components of the interwiki pagename, in the form ["prefix", "page_name"].
|
||
*/
|
||
function interwiki_pagename_parse($interwiki_pagename) {
|
||
if(strpos($interwiki_pagename, ":") === false)
|
||
return null;
|
||
$result = explode(":", $interwiki_pagename, 2);
|
||
return array_map("trim", $result);
|
||
}
|
||
|
||
/**
|
||
* Resolves an interwiki pagename to the associated
|
||
* interwiki definition object.
|
||
* @param string $interwiki_pagename An interwiki pagename. Should be in the form "prefix:page name".
|
||
* @return stdClass The interwiki definition object.
|
||
*/
|
||
function interwiki_pagename_resolve($interwiki_pagename) {
|
||
global $env;
|
||
|
||
if(empty($env->interwiki_index))
|
||
return null;
|
||
|
||
// If it's not an interwiki link, then don't bother confusing ourselves
|
||
if(strpos($interwiki_pagename, ":") === false)
|
||
return null;
|
||
|
||
[$prefix, $pagename] = interwiki_pagename_parse($interwiki_pagename); // Shorthand destructuring - introduced in PHP 7.1
|
||
|
||
if(empty($env->interwiki_index->$prefix))
|
||
return null;
|
||
|
||
return $env->interwiki_index->$prefix;
|
||
}
|
||
/**
|
||
* Converts an interwiki pagename into a url.
|
||
* @param string $interwiki_pagename The interwiki pagename (in the form "prefix:page name")
|
||
* @return string A url that points to the specified interwiki page.
|
||
*/
|
||
function interwiki_get_pagename_url($interwiki_pagename) {
|
||
$interwiki_def = interwiki_pagename_resolve($interwiki_pagename);
|
||
if($interwiki_def == null)
|
||
return null;
|
||
|
||
[$prefix, $pagename] = interwiki_pagename_parse($interwiki_pagename);
|
||
|
||
return str_replace(
|
||
"%s", rawurlencode($pagename),
|
||
$interwiki_def->root_url
|
||
);
|
||
}
|
||
|
||
/**
|
||
* Returns whether a given pagename is an interwiki link or not.
|
||
* Note that this doesn't guarantee that it's a _valid_ interwiki link - only that it looks like one :P
|
||
* @param string $pagename The page name to check.
|
||
* @return boolean Whether the given page name is an interwiki link or not.
|
||
*/
|
||
function is_interwiki_link($pagename) {
|
||
return strpos($pagename, ":") !== false;
|
||
}
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Recent Changes",
|
||
"version" => "0.3.5",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds recent changes. Access through the 'recent-changes' action.",
|
||
"id" => "feature-recent-changes",
|
||
"code" => function() {
|
||
global $settings, $env, $paths;
|
||
|
||
// Add the recent changes json file to $paths for convenience.
|
||
$paths->recentchanges = $env->storage_prefix . "recent-changes.json";
|
||
// Create the recent changes json file if it doesn't exist
|
||
if(!file_exists($paths->recentchanges))
|
||
file_put_contents($paths->recentchanges, "[]");
|
||
|
||
/**
|
||
* @api {get} ?action=recent-changes[&format={code}] Get a list of recent changes
|
||
* @apiName RecentChanges
|
||
* @apiGroup Stats
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiParam {string} format The format to return the recent changes in. Values: html, json. Default: html.
|
||
*/
|
||
/*
|
||
* ██████ ███████ ██████ ███████ ███ ██ ████████
|
||
* ██ ██ ██ ██ ██ ████ ██ ██
|
||
* ██████ █████ ██ █████ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ███████ ██████ ███████ ██ ████ ██
|
||
*
|
||
* ██████ ██ ██ █████ ███ ██ ██████ ███████ ███████
|
||
* ██ ██ ██ ██ ██ ████ ██ ██ ██ ██
|
||
* ██ ███████ ███████ ██ ██ ██ ██ ███ █████ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██ ██ ██ ██ ██ ████ ██████ ███████ ███████
|
||
*/
|
||
add_action("recent-changes", function() {
|
||
global $settings, $paths, $pageindex;
|
||
|
||
$format = $_GET["format"] ?? "html";
|
||
|
||
$recent_changes = json_decode(file_get_contents($paths->recentchanges));
|
||
|
||
switch($format) {
|
||
case "html":
|
||
$content = "\t\t<h1>Recent Changes</h1>\n";
|
||
|
||
if(count($recent_changes) > 0)
|
||
$content .= render_recent_changes($recent_changes);
|
||
else // No changes yet :(
|
||
$content .= "<p><em>None yet! Try making a few changes and then check back here.</em></p>\n";
|
||
|
||
exit(page_renderer::render("Recent Changes - $settings->sitename", $content));
|
||
break;
|
||
case "json":
|
||
$result = json_encode($recent_changes);
|
||
header("content-type: application/json");
|
||
header("content-length: " . strlen($result));
|
||
exit($result);
|
||
break;
|
||
}
|
||
|
||
|
||
});
|
||
|
||
register_save_preprocessor(function(&$pageinfo, &$newsource, &$oldsource) {
|
||
global $env, $settings, $paths;
|
||
|
||
// Work out the old and new page lengths
|
||
$oldsize = strlen($oldsource);
|
||
$newsize = strlen($newsource);
|
||
// Calculate the page length difference
|
||
$size_diff = $newsize - $oldsize;
|
||
|
||
$newchange = [
|
||
"type" => "edit",
|
||
"timestamp" => time(),
|
||
"page" => $env->page,
|
||
"user" => $env->user,
|
||
"newsize" => $newsize,
|
||
"sizediff" => $size_diff
|
||
];
|
||
if($oldsize == 0)
|
||
$newchange["newpage"] = true;
|
||
|
||
add_recent_change($newchange);
|
||
});
|
||
|
||
add_help_section("800-raw-page-content", "Recent Changes", "<p>The <a href='?action=recent-changes'>recent changes</a> page displays a list of all the most recent changes that have happened around $settings->sitename, arranged in chronological order. It can be found in the \"More...\" menu in the top right by default.</p>
|
||
<p>Each entry displays the name of the page in question, who edited it, how long ago they did so, and the number of characters added or removed. Pages that <em>currently</em> redirect to another page are shown in italics, and hovering over the time since the edit wil show the exact time that the edit was made.</p>");
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* Adds a new recent change to the recent changes file.
|
||
* @package feature-recent-changes
|
||
* @param array $rchange The new change to add.
|
||
*/
|
||
function add_recent_change($rchange)
|
||
{
|
||
global $settings, $paths;
|
||
|
||
$recentchanges = json_decode(file_get_contents($paths->recentchanges), true);
|
||
array_unshift($recentchanges, $rchange);
|
||
|
||
// Limit the number of entries in the recent changes file if we've
|
||
// been asked to.
|
||
if(isset($settings->max_recent_changes))
|
||
$recentchanges = array_slice($recentchanges, 0, $settings->max_recent_changes);
|
||
|
||
// Save the recent changes file back to disk
|
||
file_put_contents($paths->recentchanges, json_encode($recentchanges, JSON_PRETTY_PRINT));
|
||
}
|
||
|
||
/**
|
||
* Renders a list of recent changes to HTML.
|
||
* @package feature-recent-changes
|
||
* @param array $recent_changes The recent changes to render.
|
||
* @return string The given recent changes as HTML.
|
||
*/
|
||
function render_recent_changes($recent_changes)
|
||
{
|
||
global $pageindex;
|
||
|
||
// Cache the number of recent changes we are dealing with
|
||
$rchange_count = count($recent_changes);
|
||
|
||
// Group changes made on the same page and the same day together
|
||
for($i = 0; $i < $rchange_count; $i++)
|
||
{
|
||
for($s = $i + 1; $s < $rchange_count; $s++)
|
||
{
|
||
// Break out if we have reached the end of the day we are scanning
|
||
if(date("dmY", $recent_changes[$i]->timestamp) !== date("dmY", $recent_changes[$s]->timestamp))
|
||
break;
|
||
|
||
// If we have found a change that has been made on the same page and
|
||
// on the same day as the one that we are scanning for, move it up
|
||
// next to the change we are scanning for.
|
||
if($recent_changes[$i]->page == $recent_changes[$s]->page &&
|
||
date("j", $recent_changes[$i]->timestamp) === date("j", $recent_changes[$s]->timestamp))
|
||
{
|
||
// FUTURE: We may need to remove and insert instead of swapping changes around if this causes some changes to appear out of order.
|
||
$temp = $recent_changes[$i + 1];
|
||
$recent_changes[$i + 1] = $recent_changes[$s];
|
||
$recent_changes[$s] = $temp;
|
||
$i++;
|
||
}
|
||
}
|
||
}
|
||
|
||
$content = "<ul class='page-list'>\n";
|
||
$last_time = 0;
|
||
for($i = 0; $i < $rchange_count; $i++)
|
||
{
|
||
$rchange = $recent_changes[$i];
|
||
|
||
if($last_time !== date("dmY", $rchange->timestamp))
|
||
$content .= "<li class='header'><h2>" . date("jS F", $rchange->timestamp) . "</h2></li>\n";
|
||
|
||
$rchange_results = [];
|
||
for($s = $i; $s < $rchange_count; $s++)
|
||
{
|
||
if($recent_changes[$s]->page !== $rchange->page)
|
||
break;
|
||
|
||
$rchange_results[$s] = render_recent_change($recent_changes[$s]);
|
||
$i++;
|
||
}
|
||
// Take one from i to account for when we tick over to the next
|
||
// iteration of the main loop
|
||
$i -= 1;
|
||
|
||
$next_entry = implode("\n", $rchange_results);
|
||
// If the change count is greater than 1, then we should enclose it
|
||
// in a <details /> tag.
|
||
if(count($rchange_results) > 1)
|
||
{
|
||
reset($rchange_results);
|
||
$rchange_first = $recent_changes[key($rchange_results)];
|
||
end($rchange_results);
|
||
$rchange_last = $recent_changes[key($rchange_results)];
|
||
|
||
$pageDisplayHtml = render_pagename($rchange_first);
|
||
$timeDisplayHtml = render_timestamp($rchange_first->timestamp);
|
||
$users = [];
|
||
foreach($rchange_results as $key => $rchange_result)
|
||
{
|
||
if(!in_array($recent_changes[$key]->user, $users))
|
||
$users[] = $recent_changes[$key]->user;
|
||
}
|
||
foreach($users as &$user)
|
||
$user = page_renderer::render_username($user);
|
||
$userDisplayHtml = render_editor(implode(", ", $users));
|
||
|
||
$next_entry = "<li><details><summary><a href='?page=" . rawurlencode($rchange_first->page) . "'>$pageDisplayHtml</a> $userDisplayHtml $timeDisplayHtml</summary><ul class='page-list'>$next_entry</ul></details></li>";
|
||
|
||
$content .= "$next_entry\n";
|
||
}
|
||
else
|
||
{
|
||
$content .= implode("\n", $rchange_results);
|
||
}
|
||
|
||
$last_time = date("dmY", $rchange->timestamp);
|
||
}
|
||
$content .= "\t\t</ul>";
|
||
|
||
return $content;
|
||
}
|
||
|
||
/**
|
||
* Renders a single recent change
|
||
* @package feature-recent-changes
|
||
* @param object $rchange The recent change to render.
|
||
* @return string The recent change, rendered to HTML.
|
||
*/
|
||
function render_recent_change($rchange)
|
||
{
|
||
global $pageindex;
|
||
$pageDisplayHtml = render_pagename($rchange);
|
||
$editorDisplayHtml = render_editor(page_renderer::render_username($rchange->user));
|
||
$timeDisplayHtml = render_timestamp($rchange->timestamp);
|
||
|
||
$revisionId = false;
|
||
if(isset($pageindex->{$rchange->page}) && isset($pageindex->{$rchange->page}->history))
|
||
{
|
||
foreach($pageindex->{$rchange->page}->history as $historyEntry)
|
||
{
|
||
if($historyEntry->timestamp == $rchange->timestamp)
|
||
{
|
||
$revisionId = $historyEntry->rid;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
|
||
$result = "";
|
||
$resultClasses = [];
|
||
$rchange_type = isset($rchange->type) ? $rchange->type : "edit";
|
||
switch($rchange_type)
|
||
{
|
||
case "revert":
|
||
case "edit":
|
||
// The number (and the sign) of the size difference to display
|
||
$size_display = ($rchange->sizediff > 0 ? "+" : "") . $rchange->sizediff;
|
||
$size_display_class = $rchange->sizediff > 0 ? "larger" : ($rchange->sizediff < 0 ? "smaller" : "nochange");
|
||
if($rchange->sizediff > 500 or $rchange->sizediff < -500)
|
||
$size_display_class .= " significant";
|
||
|
||
|
||
$size_title_display = human_filesize($rchange->newsize - $rchange->sizediff) . " -> " . human_filesize($rchange->newsize);
|
||
|
||
if(!empty($rchange->newpage))
|
||
$resultClasses[] = "newpage";
|
||
if($rchange_type === "revert")
|
||
$resultClasses[] = "reversion";
|
||
|
||
$result .= "<a href='?page=" . rawurlencode($rchange->page) . ($revisionId !== false ? "&revision=$revisionId" : "") . "'>$pageDisplayHtml</a> $editorDisplayHtml $timeDisplayHtml <span class='$size_display_class' title='$size_title_display'>($size_display)</span>";
|
||
break;
|
||
|
||
case "deletion":
|
||
$resultClasses[] = "deletion";
|
||
$result .= "$pageDisplayHtml $editorDisplayHtml $timeDisplayHtml";
|
||
break;
|
||
|
||
case "move":
|
||
$resultClasses[] = "move";
|
||
$result .= "$rchange->oldpage ⭢ <a href='?page=" . rawurlencode($rchange->page) . "'>$pageDisplayHtml</a> $editorDisplayHtml $timeDisplayHtml";
|
||
break;
|
||
|
||
case "upload":
|
||
$resultClasses[] = "upload";
|
||
$result .= "<a href='?page=$rchange->page'>$pageDisplayHtml</a> $editorDisplayHtml $timeDisplayHtml (" . human_filesize($rchange->filesize) . ")";
|
||
break;
|
||
case "comment":
|
||
$resultClasses[] = "new-comment";
|
||
$result .= "<a href='?page=$rchange->page#comment-" . (!empty($rchange->comment_id) ? "$rchange->comment_id" : "unknown_comment_id") . "'>$pageDisplayHtml</a> $editorDisplayHtml";
|
||
}
|
||
|
||
$resultAttributes = " " . (count($resultClasses) > 0 ? "class='" . implode(" ", $resultClasses) . "'" : "");
|
||
$result = "\t\t\t<li$resultAttributes>$result</li>\n";
|
||
|
||
return $result;
|
||
}
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Redirect pages",
|
||
"version" => "0.3.1",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds support for redirect pages. Uses the same syntax that Mediawiki does.",
|
||
"id" => "feature-redirect",
|
||
"code" => function() {
|
||
global $settings;
|
||
|
||
register_save_preprocessor("update_redirect_metadata");
|
||
|
||
// Register a help section
|
||
add_help_section("25-redirect", "Redirect Pages", "<p>$settings->sitename supports redirect pages. To create a redirect page, enter something like <code># REDIRECT [[pagename]]</code> on the first line of the redirect page's content. This <em>must</em> appear as the first line of the page, with no whitespace before it. You can include content beneath the redirect if you want, too (such as a reason for redirecting the page).</p>");
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* Updates the metadata associated with redirects in the pageindex entry
|
||
* specified utilising the provided page content.
|
||
* @param object $index_entry The page index entry object to update.
|
||
* @param string $pagedata The page content to operate on.
|
||
*/
|
||
function update_redirect_metadata(&$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.7",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds proper search functionality to Pepperminty Wiki using an inverted index to provide a full text search engine. If pages don't show up, then you might have hit a stop word. If not, try requesting the `invindex-rebuild` action to rebuild the inverted index from scratch.",
|
||
"id" => "feature-search",
|
||
"code" => function() {
|
||
global $settings;
|
||
|
||
/**
|
||
* @api {get} ?action=index&page={pageName} Get an index of words for a given page
|
||
* @apiName SearchIndex
|
||
* @apiGroup Search
|
||
* @apiPermission Anonymous
|
||
* @apiDescription For debugging purposes. Be warned - the format could change at any time!
|
||
*
|
||
* @apiParam {string} page The page to generate a word index page.
|
||
*/
|
||
|
||
/*
|
||
* ██ ███ ██ ██████ ███████ ██ ██
|
||
* ██ ████ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ █████ ███
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ████ ██████ ███████ ██ ██
|
||
*/
|
||
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);
|
||
|
||
echo("Page name: $env->page\n");
|
||
echo("--------------- Source ---------------\n");
|
||
echo($source); echo("\n");
|
||
echo("--------------------------------------\n\n");
|
||
echo("---------------- Index ---------------\n");
|
||
foreach($index as $term => $entry) {
|
||
echo("$term: {$entry["freq"]} matches | " . implode(", ", $entry["offsets"]) . "\n");
|
||
}
|
||
echo("--------------------------------------\n");
|
||
});
|
||
|
||
/**
|
||
* @api {get} ?action=invindex-rebuild Rebuild the inverted search index from scratch
|
||
* @apiDescription Causes the inverted search index to be completely rebuilt from scratch. Can take a while for large wikis!
|
||
* @apiName SearchInvindexRebuild
|
||
* @apiGroup Search
|
||
* @apiPermission Admin
|
||
*
|
||
* @apiParam {string} secret Optional. Specify the secret from peppermint.json here in order to rebuild the search index without logging in.
|
||
*/
|
||
|
||
/*
|
||
* ██ ███ ██ ██ ██ ██ ███ ██ ██████ ███████ ██ ██
|
||
* ██ ████ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ █████ ███ █████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ████ ████ ██ ██ ████ ██████ ███████ ██ ██
|
||
*
|
||
* ██████ ███████ ██████ ██ ██ ██ ██ ██████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ █████ ██████ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ███████ ██████ ██████ ██ ███████ ██████
|
||
*/
|
||
add_action("invindex-rebuild", function() {
|
||
global $env, $settings;
|
||
if($env->is_admin ||
|
||
(
|
||
!empty($_POST["secret"]) &&
|
||
$_POST["secret"] === $settings->secret
|
||
)
|
||
)
|
||
search::rebuild_invindex();
|
||
else
|
||
{
|
||
http_response_code(401);
|
||
exit(page_renderer::render_main("Error - Search index regenerator - $settings->sitename", "<p>Error: You aren't allowed to regenerate the search index. Try logging in as an admin, or setting the <code>secret</code> POST parameter to $settings->sitename's secret - which can be found in $settings->sitename's <code>peppermint.json</code> file.</p>"));
|
||
}
|
||
});
|
||
|
||
|
||
/**
|
||
* @api {get} ?action=idindex-show Show the id index
|
||
* @apiDescription Outputs the id index. Useful if you need to verify that it's working as expected. Output is a json object.
|
||
* @apiName SearchShowIdIndex
|
||
* @apiGroup Search
|
||
* @apiPermission Anonymous
|
||
*/
|
||
add_action("idindex-show", function() {
|
||
global $idindex;
|
||
header("content-type: application/json; charset=UTF-8");
|
||
exit(json_encode($idindex, JSON_PRETTY_PRINT));
|
||
});
|
||
|
||
/**
|
||
* @api {get} ?action=search&query={text}[&format={format}] Search the wiki for a given query string
|
||
* @apiName Search
|
||
* @apiGroup Search
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiParam {string} query The query string to search for.
|
||
* @apiParam {string} format Optional. Valid values: html, json. In json mode an object is returned with page names as keys, values as search result information - sorted in ranking order.
|
||
*/
|
||
|
||
/*
|
||
* ███████ ███████ █████ ██████ ██████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ █████ ███████ ██████ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ███████ ██ ██ ██ ██ ██████ ██ ██
|
||
*/
|
||
add_action("search", function() {
|
||
global $settings, $env, $pageindex, $paths;
|
||
|
||
// Create the inverted index if it doesn't exist.
|
||
// todo In the future perhaps a CLI for this would be good?
|
||
if(!file_exists($paths->searchindex))
|
||
search::rebuild_invindex(false);
|
||
|
||
if(!isset($_GET["query"]))
|
||
exit(page_renderer::render("No Search Terms - Error - $settings->sitename", "<p>You didn't specify any search terms. Try typing some into the box above.</p>"));
|
||
|
||
$search_start = microtime(true);
|
||
|
||
|
||
$time_start = microtime(true);
|
||
$invindex = search::load_invindex($paths->searchindex);
|
||
$env->perfdata->invindex_decode_time = round((microtime(true) - $time_start)*1000, 3);
|
||
|
||
$start = microtime(true);
|
||
$results = search::query_invindex($_GET["query"], $invindex);
|
||
$resultCount = count($results);
|
||
$env->perfdata->invindex_query_time = round((microtime(true) - $time_start)*1000, 3);
|
||
|
||
header("x-invindex-decode-time: {$env->perfdata->invindex_decode_time}ms");
|
||
header("x-invindex-query-time: {$env->perfdata->invindex_query_time}ms");
|
||
|
||
$start = microtime(true);
|
||
foreach($results as &$result) {
|
||
$result["context"] = search::extract_context(
|
||
$invindex, $result["pagename"],
|
||
$_GET["query"],
|
||
file_get_contents($env->storage_prefix . $result["pagename"] . ".md")
|
||
);
|
||
}
|
||
$env->perfdata->context_generation_time = round((microtime(true) - $start)*1000, 3);
|
||
header("x-context-generation-time: {$env->perfdata->context_generation_time}ms");
|
||
|
||
$env->perfdata->search_time = round((microtime(true) - $search_start)*1000, 3);
|
||
|
||
header("x-search-time: {$env->perfdata->search_time}ms");
|
||
|
||
if(!empty($_GET["format"]) && $_GET["format"] == "json") {
|
||
header("content-type: application/json");
|
||
$json_results = new stdClass();
|
||
foreach($results as $result) $json_results->{$result["pagename"]} = $result;
|
||
exit(json_encode($json_results));
|
||
}
|
||
|
||
$title = $_GET["query"] . " - Search results - $settings->sitename";
|
||
|
||
$content = "<section>\n";
|
||
$content .= "<h1>Search Results</h1>";
|
||
|
||
/// Search Box ///
|
||
$content .= "<form method='get' action=''>\n";
|
||
$content .= " <input type='search' id='search-box' name='query' placeholder='Type your query here and then press enter.' value='" . htmlentities($_GET["query"], ENT_HTML5 | ENT_QUOTES) . "' />\n";
|
||
$content .= " <input type='hidden' name='action' value='search' />\n";
|
||
$content .= "</form>";
|
||
|
||
$content .= "<p>Found $resultCount " . ($resultCount === 1 ? "result" : "results") . " in " . $env->perfdata->search_time . "ms. ";
|
||
|
||
$query = $_GET["query"];
|
||
if(isset($pageindex->$query))
|
||
{
|
||
$content .= "There's a page on $settings->sitename called <a href='?page=" . rawurlencode($query) . "'>$query</a>.";
|
||
}
|
||
else
|
||
{
|
||
$content .= "There isn't a page called $query on $settings->sitename, but you ";
|
||
if((!$settings->anonedits && !$env->is_logged_in) || !$settings->editing)
|
||
{
|
||
$content .= "do not have permission to create it.";
|
||
if(!$env->is_logged_in)
|
||
{
|
||
$content .= " You could try <a href='?action=login&returnto=" . rawurlencode($_SERVER["REQUEST_URI"]) . "'>logging in</a>.";
|
||
}
|
||
}
|
||
else
|
||
{
|
||
$content .= "can <a href='?action=edit&page=" . rawurlencode($query) . "'>create it</a>.";
|
||
}
|
||
}
|
||
$content .= "</p>";
|
||
|
||
if(module_exists("page-list")) {
|
||
$nterms = search::tokenize($query);
|
||
$nterms_regex = implode("|", array_map(function($nterm) {
|
||
return preg_quote(strtolower(trim($nterm)));
|
||
}, $nterms));
|
||
$all_tags = get_all_tags();
|
||
$matching_tags = [];
|
||
foreach($all_tags as $tag) {
|
||
if(preg_match("/$nterms_regex/i", trim($tag)) > 0)
|
||
$matching_tags[] = $tag;
|
||
}
|
||
|
||
if(count($matching_tags) > 0) {
|
||
$content .= "<p class='matching-tags-display'><label>Matching tags</label><span class='tags'>";
|
||
foreach($matching_tags as $tag) {
|
||
$content .= "\t<a href='?action=list-tags&tag=" . rawurlencode($tag) ."' class='mini-tag'>" . htmlentities($tag) . "</a> \n";
|
||
}
|
||
$content .= "</span></p>";
|
||
}
|
||
}
|
||
|
||
$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");
|
||
|
||
//echo("Extracting context for result " . $result["pagename"] . ".\n");
|
||
$context = $result["context"];
|
||
if(mb_strlen($context) === 0)
|
||
$context = mb_substr($pagesource, 0, $settings->search_characters_context * 2);
|
||
//echo("'Generated search context for " . $result["pagename"] . ": $context'\n");
|
||
$context = search::highlight_context(
|
||
$_GET["query"],
|
||
preg_replace('/</u', '<', $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 .= "...";
|
||
}*/
|
||
|
||
$tag_list = "<span class='tags'>";
|
||
foreach($pageindex->{$result["pagename"]}->tags ?? [] as $tag) $tag_list .= "<a href='?action=list-tags&tag=" . rawurlencode($tag) . "' class='mini-tag'>$tag</a>";
|
||
$tag_list .= "</span>\n";
|
||
|
||
// Make redirect pages italics
|
||
if(!empty($pageindex->{$result["pagename"]}->redirect))
|
||
$result["pagename"] = "<em>{$result["pagename"]}</em>";
|
||
|
||
// 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 .= "<div class='search-result' data-result-number='" . ($i + 1) . "' data-rank='" . $result["rank"] . "'>\n";
|
||
$content .= " <h2><a href='$link'>" . $result["pagename"] . "</a> <span class='search-result-badges'>$tag_list</span></h2>\n";
|
||
$content .= " <p class='search-context'>$context</p>\n";
|
||
$content .= "</div>\n";
|
||
|
||
$i++;
|
||
}
|
||
|
||
$content .= "</section>\n";
|
||
|
||
header("content-type: text/html; charset=UTF-8");
|
||
exit(page_renderer::render($title, $content));
|
||
|
||
//header("content-type: text/plain");
|
||
//var_dump($results);
|
||
});
|
||
|
||
/*
|
||
* ██████ ██ ██ ███████ ██████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ █████ ██████ ████ █████
|
||
* ██ ▄▄ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██████ ███████ ██ ██ ██
|
||
* ▀▀
|
||
* ███████ ███████ █████ ██████ ██████ ██ ██ ██ ███ ██ ██████ ███████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ██
|
||
* ███████ █████ ███████ ██████ ██ ███████ ██ ██ ██ ██ ██ ██ █████ ███
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ███████ ██ ██ ██ ██ ██████ ██ ██ ██ ██ ████ ██████ ███████ ██ ██
|
||
*/
|
||
|
||
/**
|
||
* @api {get} ?action=query-searchindex&query={text} Inspect the internals of the search results for a query
|
||
* @apiName Search
|
||
* @apiGroup Search
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiParam {string} query The query string to search for.
|
||
*/
|
||
add_action("query-searchindex", function() {
|
||
global $env, $paths;
|
||
|
||
if(empty($_GET["query"])) {
|
||
http_response_code(400);
|
||
header("content-type: text/plain");
|
||
exit("Error: No query specified. Specify it with the 'query' GET parameter.");
|
||
}
|
||
|
||
$env->perfdata->searchindex_decode_start = microtime(true);
|
||
$searchIndex = search::load_invindex($paths->searchindex);
|
||
$env->perfdata->searchindex_decode_time = (microtime(true) - $env->perfdata->searchindex_decode_start) * 1000;
|
||
$env->perfdata->searchindex_query_start = microtime(true);
|
||
$searchResults = search::query_invindex($_GET["query"], $searchIndex);
|
||
$env->perfdata->searchindex_query_time = (microtime(true) - $env->perfdata->searchindex_query_start) * 1000;
|
||
|
||
header("content-type: application/json");
|
||
$result = new stdClass();
|
||
$result->time_format = "ms";
|
||
$result->decode_time = $env->perfdata->searchindex_decode_time;
|
||
$result->query_time = $env->perfdata->searchindex_query_time;
|
||
$result->total_time = $result->decode_time + $result->query_time;
|
||
$result->search_results = $searchResults;
|
||
exit(json_encode($result, JSON_PRETTY_PRINT));
|
||
});
|
||
|
||
/*
|
||
* ██████ ██████ ███████ ███ ██ ███████ ███████ █████ ██████ ██████ ██ ██
|
||
* ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██████ █████ ██ ██ ██ ███████ █████ ███████ ██████ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██ ███████ ██ ████ ███████ ███████ ██ ██ ██ ██ ██████ ██ ██
|
||
*/
|
||
/**
|
||
* @api {get} ?action=opensearch-description Get the opensearch description file
|
||
* @apiName OpenSearchDescription
|
||
* @apiGroup Search
|
||
* @apiPermission Anonymous
|
||
*/
|
||
add_action("opensearch-description", function () {
|
||
global $settings;
|
||
$siteRoot = full_url() . "/index.php";
|
||
if(!isset($_GET["debug"]))
|
||
header("content-type: application/opensearchdescription+xml");
|
||
else
|
||
header("content-type: text/plain");
|
||
|
||
exit('<?xml version="1.0" encoding="UTF-8"?' . '>' . // hack The build system strips it otherwise O.o I should really fix that.
|
||
"\n<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\">
|
||
<ShortName>Search $settings->sitename</ShortName>
|
||
<Description>Search $settings->sitename, which is powered by Pepperminty Wiki.</Description>
|
||
<Tags>$settings->sitename Wiki</Tags>
|
||
<Image type=\"image/png\">$settings->favicon</Image>
|
||
<Attribution>Search content available under the license linked to at the bottom of the search results page.</Attribution>
|
||
<Developer>Starbeamrainbowlabs (https://github.com/sbrl/Pepperminty-Wiki/graphs/contributors)</Developer>
|
||
<InputEncoding>UTF-8</InputEncoding>
|
||
<OutputEncoding>UTF-8</OutputEncoding>
|
||
|
||
<Url type=\"text/html\" method=\"get\" template=\"$siteRoot?action=view&search-redirect=yes&page={searchTerms}&offset={startIndex?}&count={count}\" />
|
||
<Url type=\"application/x-suggestions+json\" template=\"$siteRoot?action=suggest-pages&query={searchTerms}&type=opensearch\" />
|
||
</OpenSearchDescription>");
|
||
});
|
||
|
||
|
||
/**
|
||
* @api {get} ?action=suggest-pages[&type={type}] Get page name suggestions for a query
|
||
* @apiName OpenSearchDescription
|
||
* @apiGroup Search
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiParam {string} text The search query string to get search suggestions for.
|
||
* @apiParam {string} type The type of result to return. Default value: json. Available values: json, opensearch
|
||
*/
|
||
add_action("suggest-pages", function() {
|
||
global $settings, $pageindex;
|
||
|
||
if($settings->dynamic_page_suggestion_count === 0)
|
||
{
|
||
header("content-type: application/json");
|
||
header("content-length: 3");
|
||
exit("[]\n");
|
||
}
|
||
|
||
if(empty($_GET["query"])) {
|
||
http_response_code(400);
|
||
header("content-type: text/plain");
|
||
exit("Error: You didn't specify the 'query' GET parameter.");
|
||
}
|
||
|
||
$type = $_GET["type"] ?? "json";
|
||
|
||
if(!in_array($type, ["json", "opensearch"])) {
|
||
http_response_code(406);
|
||
exit("Error: The type '$type' is not one of the supported output types. Available values: json, opensearch. Default: json");
|
||
}
|
||
|
||
$literator = Transliterator::createFromRules(':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: Lower(); :: NFC;', Transliterator::FORWARD);
|
||
|
||
$query = $literator->transliterate($_GET["query"]);
|
||
|
||
|
||
// Rank each page name
|
||
$results = [];
|
||
foreach($pageindex as $pageName => $entry) {
|
||
$results[] = [
|
||
"pagename" => $pageName,
|
||
// Costs: Insert: 1, Replace: 8, Delete: 6
|
||
"distance" => levenshtein($query, $literator->transliterate($pageName), 1, 8, 6)
|
||
];
|
||
}
|
||
|
||
// Sort the page names by distance from the original query
|
||
usort($results, function($a, $b) {
|
||
if($a["distance"] == $b["distance"])
|
||
return strcmp($a["pagename"], $b["pagename"]);
|
||
return $a["distance"] < $b["distance"] ? -1 : 1;
|
||
});
|
||
|
||
// Send the results to the user
|
||
$suggestions = array_slice($results, 0, $settings->dynamic_page_suggestion_count);
|
||
switch($type)
|
||
{
|
||
case "json":
|
||
header("content-type: application/json");
|
||
exit(json_encode($suggestions));
|
||
case "opensearch":
|
||
$opensearch_output = [
|
||
$_GET["query"],
|
||
array_map(function($suggestion) { return $suggestion["pagename"]; }, $suggestions)
|
||
];
|
||
header("content-type: application/x-suggestions+json");
|
||
exit(json_encode($opensearch_output));
|
||
}
|
||
});
|
||
|
||
if($settings->dynamic_page_suggestion_count > 0)
|
||
{
|
||
page_renderer::AddJSSnippet('/// Dynamic page suggestion system
|
||
// Micro snippet 8 - Promisified GET (fetched 20th Nov 2016)
|
||
function get(u){return new Promise(function(r,t,a){a=new XMLHttpRequest();a.onload=function(b,c){b=a.status;c=a.response;if(b>199&&b<300){r(c)}else{t(c)}};a.open("GET",u,true);a.send(null)})}
|
||
|
||
window.addEventListener("load", function(event) {
|
||
var searchBox = document.querySelector("input[type=search]");
|
||
searchBox.dataset.lastValue = "";
|
||
searchBox.addEventListener("keyup", function(event) {
|
||
// Make sure that we don\'t keep sending requests to the server if nothing has changed
|
||
if(searchBox.dataset.lastValue == event.target.value)
|
||
return;
|
||
searchBox.dataset.lastValue = event.target.value;
|
||
// Fetch the suggestions from the server
|
||
get("?action=suggest-pages&query=" + encodeURIComponent(event.target.value)).then(function(response) {
|
||
var suggestions = JSON.parse(response),
|
||
dataList = document.getElementById("allpages");
|
||
|
||
// If the server sent no suggestions, then we shouldn\'t replace the contents of the datalist
|
||
if(suggestions.length == 0)
|
||
return;
|
||
|
||
console.info(`Fetched suggestions for ${event.target.value}:`, suggestions.map(s => s.pagename));
|
||
|
||
// Remove all the existing suggestions
|
||
while(dataList.firstChild) {
|
||
dataList.removeChild(dataList.firstChild);
|
||
}
|
||
|
||
// Add the new suggestions to the datalist
|
||
var optionsFrag = document.createDocumentFragment();
|
||
suggestions.forEach(function(suggestion) {
|
||
var suggestionElement = document.createElement("option");
|
||
suggestionElement.value = suggestion.pagename;
|
||
suggestionElement.dataset.distance = suggestion.distance;
|
||
optionsFrag.appendChild(suggestionElement);
|
||
});
|
||
dataList.appendChild(optionsFrag);
|
||
});
|
||
});
|
||
});
|
||
');
|
||
}
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* Holds a collection to methods to manipulate various types of search index.
|
||
*/
|
||
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", "fill", "find",
|
||
"fire", "first", "five", "for", "former", "formerly", "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", "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"
|
||
];
|
||
|
||
/**
|
||
* Converts a source string into an index of search terms that can be
|
||
* merged into an inverted index.
|
||
* @param string $source The source string to index.
|
||
* @return array An index represents the specified string.
|
||
*/
|
||
public static function index($source)
|
||
{
|
||
// We don't need to normalise or transliterate here because self::tokenize() does this for us
|
||
$source = html_entity_decode($source, ENT_QUOTES);
|
||
$source_length = mb_strlen($source);
|
||
|
||
$index = [];
|
||
|
||
$terms = self::tokenize($source, true);
|
||
foreach($terms as $term)
|
||
{
|
||
// Skip over stop words (see https://en.wikipedia.org/wiki/Stop_words)
|
||
if(in_array($term[0], self::$stop_words)) continue;
|
||
|
||
if(!isset($index[$term[0]]))
|
||
$index[$term[0]] = [ "freq" => 0, "offsets" => [] ];
|
||
|
||
$index[$term[0]]["freq"]++;
|
||
$index[$term[0]]["offsets"][] = $term[1];
|
||
}
|
||
|
||
return $index;
|
||
}
|
||
|
||
/**
|
||
* Converts a source string into a series of raw tokens.
|
||
* @param string $source The source string to process.
|
||
* @param boolean $capture_offsets Whether to capture & return the character offsets of the tokens detected. If true, then each token returned will be an array in the form [ token, char_offset ].
|
||
* @return array An array of raw tokens extracted from the specified source string.
|
||
*/
|
||
public static function tokenize($source, $capture_offsets = false)
|
||
{
|
||
/** Normalises input characters for searching & indexing */
|
||
static $literator; if($literator == null) $literator = Transliterator::createFromRules(':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: Lower(); :: NFC;', Transliterator::FORWARD);
|
||
|
||
$flags = PREG_SPLIT_NO_EMPTY; // Don't return empty items
|
||
if($capture_offsets)
|
||
$flags |= PREG_SPLIT_OFFSET_CAPTURE;
|
||
|
||
// We don't need to normalise here because the transliterator handles
|
||
// this for us. Also, we can't move the literator to a static variable
|
||
// because PHP doesn't like it very much
|
||
$source = $literator->transliterate($source);
|
||
$source = preg_replace('/[\[\]\|\{\}\/]/u', " ", $source);
|
||
return preg_split("/((^\p{P}+)|(\p{P}*\s+\p{P}*)|(\p{P}+$))|\|/u", $source, -1, $flags);
|
||
}
|
||
|
||
/**
|
||
* Removes (most) markdown markup from the specified string.
|
||
* Stripped strings are not suitable for indexing!
|
||
* @param string $source The source string to process.
|
||
* @return string The stripped string.
|
||
*/
|
||
public static function strip_markup($source)
|
||
{
|
||
return preg_replace('/([\"*_\[\]]| - |`)/u', "", $source);
|
||
}
|
||
|
||
/**
|
||
* Rebuilds the master inverted index and clears the page id index.
|
||
* @param boolean $output Whether to send progress information to the user's browser.
|
||
*/
|
||
public static function rebuild_invindex($output = true)
|
||
{
|
||
global $pageindex, $env, $paths, $settings;
|
||
|
||
if($output) {
|
||
header("content-type: text/event-stream");
|
||
ob_end_flush();
|
||
}
|
||
|
||
// Clear the id index out
|
||
ids::clear();
|
||
|
||
// Reindex each page in turn
|
||
$invindex = [];
|
||
$i = 0; $max = count(get_object_vars($pageindex));
|
||
$missing_files = 0;
|
||
foreach($pageindex as $pagename => $pagedetails)
|
||
{
|
||
$page_filename = $env->storage_prefix . $pagedetails->filename;
|
||
if(!file_exists($page_filename)) {
|
||
echo("data: [" . ($i + 1) . " / $max] Error: Can't find $page_filename\n");
|
||
flush();
|
||
$i++; $missing_files++;
|
||
continue;
|
||
}
|
||
// We do not transliterate or normalise here because the indexer will take care of this for us
|
||
$index = self::index(file_get_contents($page_filename));
|
||
|
||
$pageid = ids::getid($pagename);
|
||
self::merge_into_invindex($invindex, $pageid, $index);
|
||
|
||
if($output) {
|
||
echo("data: [" . ($i + 1) . " / $max] Added $pagename (id #$pageid) to the new search index.\n\n");
|
||
flush();
|
||
}
|
||
|
||
$i++;
|
||
}
|
||
|
||
if($output) {
|
||
echo("data: Search index rebuilding complete.\n\n");
|
||
echo("data: Couldn't find $missing_files pages on disk. If $settings->sitename couldn't find some pages on disk, then you might need to manually correct $settings->sitename's page index (stored in pageindex.json).\n\n");
|
||
echo("data: Done! Saving new search index to '$paths->searchindex'.\n\n");
|
||
}
|
||
|
||
self::save_invindex($paths->searchindex, $invindex);
|
||
}
|
||
|
||
/**
|
||
* Sorts an index alphabetically. Will also sort an inverted index.
|
||
* This allows us to do a binary search instead of a regular
|
||
* sequential search.
|
||
* @param array $index The index to sort.
|
||
*/
|
||
public static function sort_index(&$index)
|
||
{
|
||
ksort($index, SORT_NATURAL);
|
||
}
|
||
|
||
/**
|
||
* Compares two *regular* indexes to find the differences between them.
|
||
* @param array $oldindex The old index.
|
||
* @param array $newindex 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 word is new
|
||
$newindex[$nterm] !== $oldindex[$nterm]) // If this word has changed
|
||
$changed[$nterm] = $newindex[$nterm];
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Reads in and parses an inverted index.
|
||
* @param string $invindex_filename The path tp the inverted index to parse.
|
||
* @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;
|
||
}
|
||
/**
|
||
* Reads in and parses an inverted index, measuring the time it takes to do so.
|
||
* @param string $invindex_filename The path to the file inverted index to parse.
|
||
*/
|
||
public static function measure_invindex_load_time($invindex_filename) {
|
||
global $env;
|
||
|
||
$searchindex_decode_start = microtime(true);
|
||
search::load_invindex($invindex_filename);
|
||
$env->perfdata->searchindex_decode_time = round((microtime(true) - $searchindex_decode_start)*1000, 3);
|
||
}
|
||
|
||
/**
|
||
* Merge an index into an inverted index.
|
||
* @param array $invindex The inverted index to merge into.
|
||
* @param int $pageid The id of the page to assign to the index that's being merged.
|
||
* @param array $index The regular index to merge.
|
||
* @param array $removals An array of index entries to remove from the inverted index. Useful for applying changes to an inverted index instead of deleting and remerging an entire page's 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;
|
||
});
|
||
}
|
||
|
||
/**
|
||
* Deletes the given pageid from the given pageindex.
|
||
* @param inverted_index &$invindex The inverted index.
|
||
* @param number $pageid The pageid to remove.
|
||
*/
|
||
public static function delete_entry(&$invindex, $pageid)
|
||
{
|
||
$str_pageid = (string)$pageid;
|
||
foreach($invindex as $nterm => &$entry)
|
||
{
|
||
if(isset($entry[$pageid]))
|
||
unset($entry[$pageid]);
|
||
if(isset($entry[$str_pageid]))
|
||
unset($entry[$str_pageid]);
|
||
if(count($entry) === 0)
|
||
unset($invindex[$nterm]);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Saves the given inverted index back to disk.
|
||
* @param string $filename The path to the file to save the inverted index to.
|
||
* @param array $invindex The inverted index to save.
|
||
*/
|
||
public static function save_invindex($filename, &$invindex)
|
||
{
|
||
file_put_contents($filename, json_encode($invindex));
|
||
}
|
||
|
||
/**
|
||
* Searches the given inverted index for the specified search terms.
|
||
* @param string $query The search query.
|
||
* @param array $invindex The inverted index to search.
|
||
* @return array An array of matching pages.
|
||
*/
|
||
public static function query_invindex($query, &$invindex)
|
||
{
|
||
global $settings, $pageindex;
|
||
|
||
/** Normalises input characters for searching & indexing */
|
||
static $literator; if($literator == null) $literator = Transliterator::createFromRules(':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: Lower(); :: NFC;', Transliterator::FORWARD);
|
||
|
||
$query_terms = self::tokenize($query);
|
||
$matching_pages = [];
|
||
|
||
|
||
// Loop over each term in the query and find the matching page entries
|
||
$count = count($query_terms);
|
||
for($i = 0; $i < $count; $i++)
|
||
{
|
||
$qterm = $query_terms[$i];
|
||
|
||
// Stop words aren't worth the bother - make sure we don't search
|
||
// the title or the tags for them
|
||
if(in_array($qterm, self::$stop_words))
|
||
continue;
|
||
|
||
// Only search the inverted index if it actually exists there
|
||
if(isset($invindex[$qterm]))
|
||
{
|
||
// Loop over each page in the inverted index entry
|
||
reset($invindex[$qterm]); // Reset array/object pointer
|
||
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
|
||
reset($pageindex); // Reset array/object pointer
|
||
foreach ($pageindex as $pagename => $pagedata)
|
||
{
|
||
// Setup a variable to hold the current page's id
|
||
$pageid = false; // Only fill this out if we find a match
|
||
// Consider matches in the page title
|
||
// FUTURE: We may be able to optimise this further by using preg_match_all + preg_quote instead of mb_stripos_all. Experimentation / benchmarking is required to figure out which one is faster
|
||
$title_matches = mb_stripos_all($literator->transliterate($pagename), $qterm);
|
||
$title_matches_count = $title_matches !== false ? count($title_matches) : 0;
|
||
if($title_matches_count > 0)
|
||
{
|
||
$pageid = ids::getid($pagename); // Fill out the page id
|
||
// 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"] += $title_matches_count * strlen($qterm);
|
||
}
|
||
|
||
// Consider matches in the page's tags
|
||
$tag_matches = isset($pagedata->tags) ? mb_stripos_all($literator->transliterate(implode(" ", $pagedata->tags)), $qterm) : false;
|
||
$tag_matches_count = $tag_matches !== false ? count($tag_matches) : 0;
|
||
|
||
if($tag_matches_count > 0) // And we found the qterm in the tags
|
||
{
|
||
if($pageid == false) // Fill out the page id if it hasn't been already
|
||
$pageid = ids::getid($pagename);
|
||
|
||
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"] += $tag_matches_count * strlen($qterm);
|
||
}
|
||
}
|
||
}
|
||
|
||
reset($matching_pages);
|
||
foreach($matching_pages as $pageid => &$pagedata)
|
||
{
|
||
$pagedata["pagename"] = ids::getpagename($pageid);
|
||
$pagedata["rank"] = 0;
|
||
|
||
$pageOffsets = [];
|
||
|
||
// Loop over each search term found on this page
|
||
reset($pagedata["nterms"]);
|
||
foreach($pagedata["nterms"] as $pterm => $entry)
|
||
{
|
||
// Add the number of occurrences of this search term to the ranking
|
||
// Multiply it by the length of the word
|
||
$pagedata["rank"] += $entry["freq"] * strlen($pterm);
|
||
|
||
// Add the offsets to a listof all offsets on this page
|
||
foreach($entry["offsets"] as $offset)
|
||
$pageOffsets[] = $offset;
|
||
}
|
||
/*
|
||
// Sort the list of offsets
|
||
$pageOffsets = array_unique($pageOffsets);
|
||
sort($pageOffsets);
|
||
var_dump($pageOffsets);
|
||
|
||
// Calcualate the clump distances via a variable moving window size
|
||
$pageOffsetsCount = count($pageOffsets);
|
||
$clumpDistanceWindow = min($count, $pageOffsetsCount); // a.k.a. count($query_terms) - see above
|
||
$clumpDistances = [];
|
||
for($i = 0; $i < $pageOffsetsCount - $clumpDistanceWindow; $i++)
|
||
$clumpDistances[] = $pageOffsets[$i] - $pageOffsets[$i + $clumpDistanceWindow];
|
||
|
||
// Sort the new list of clump distances
|
||
sort($clumpDistances);
|
||
// Calcualate a measure of how clumped the offsets are
|
||
$tightClumpLimit = floor((count($clumpDistances) - 1) / 0.25);
|
||
$tightClumpsMeasure = $clumpDistances[$tightClumpLimit] - $clumpDistances[0];
|
||
$clumpsRange = $clumpDistances[count($clumpDistances) - 1] - $clumpDistances[0];
|
||
|
||
$clumpiness = $tightClumpsMeasure / $clumpsRange;
|
||
echo("{$pagedata["pagename"]} - $clumpiness");
|
||
*/
|
||
|
||
// 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
|
||
}
|
||
|
||
uasort($matching_pages, function($a, $b) {
|
||
if($a["rank"] == $b["rank"]) return 0;
|
||
return ($a["rank"] < $b["rank"]) ? +1 : -1;
|
||
});
|
||
|
||
return $matching_pages;
|
||
}
|
||
|
||
/**
|
||
* Extracts a context string (in HTML) given a search query that could be displayed
|
||
* in a list of search results.
|
||
* @param string $invindex The inverted index to consult.
|
||
* @param string $pagename The name of the paget that this source belongs to. Used when consulting the inverted index.
|
||
* @param string $query The search queary to generate the context for.
|
||
* @param string $source The page source to extract the context from.
|
||
* @return string The generated context string.
|
||
*/
|
||
public static function extract_context($invindex, $pagename, $query, $source)
|
||
{
|
||
global $settings;
|
||
|
||
$pageid = ids::getid($pagename);
|
||
$nterms = self::tokenize($query);
|
||
$matches = [];
|
||
|
||
foreach($nterms as $nterm) {
|
||
// Skip over words that don't appear in the inverted index (e.g. stop words)
|
||
if(!isset($invindex[$nterm]))
|
||
continue;
|
||
// Skip if the page isn't found in the inverted index for this word
|
||
if(!isset($invindex[$nterm][$pageid]))
|
||
continue;
|
||
|
||
foreach($invindex[$nterm][$pageid]["offsets"] as $next_offset)
|
||
$matches[] = [ $nterm, $next_offset ];
|
||
}
|
||
|
||
// Sort the matches by offset
|
||
usort($matches, function($a, $b) {
|
||
if($a[1] == $b[1]) return 0;
|
||
return ($a[1] > $b[1]) ? +1 : -1;
|
||
});
|
||
|
||
$sourceLength = mb_strlen($source);
|
||
|
||
$contexts = [];
|
||
|
||
$matches_count = count($matches);
|
||
$total_context_length = 0;
|
||
for($i = 0; $i < $matches_count; $i++) {
|
||
$next_context = [
|
||
"from" => max(0, $matches[$i][1] - $settings->search_characters_context),
|
||
"to" => min($sourceLength, $matches[$i][1] + mb_strlen($matches[$i][0]) + $settings->search_characters_context)
|
||
];
|
||
|
||
if(end($contexts) !== false && end($contexts)["to"] > $next_context["from"]) {
|
||
// This next context overlaps with the previous one
|
||
// Extend the last one instead of adding a new one
|
||
|
||
// The array pointer is pointing at the last element now because we called end() above
|
||
|
||
// Update the total context length counter appropriately
|
||
$total_context_length += $next_context["to"] - $contexts[key($contexts)]["to"];
|
||
$contexts[key($contexts)]["to"] = $next_context["to"];
|
||
}
|
||
else { // No overlap here! Business as usual.
|
||
$contexts[] = $next_context;
|
||
// Update the total context length counter as normal
|
||
$total_context_length += $next_context["to"] - $next_context["from"];
|
||
}
|
||
|
||
|
||
end($contexts);
|
||
$last_context = &$contexts[key($contexts)];
|
||
if($total_context_length > $settings->search_characters_context_total) {
|
||
// We've reached the limit on the number of characters this context should contain. Trim off the context to fit and break out
|
||
$last_context["to"] -= $total_context_length - $settings->search_characters_context_total;
|
||
break;
|
||
}
|
||
}
|
||
|
||
$contexts_text = [];
|
||
foreach($contexts as $context) {
|
||
$contexts_text[] = substr($source, $context["from"], $context["to"] - $context["from"]);
|
||
}
|
||
|
||
$result = implode(" … ", $contexts_text);
|
||
end($contexts); // If there's at least one item in the list and were not at the very end of the page, add an extra ellipsis
|
||
if(isset($contexts[0]) && $contexts[key($contexts)]["to"] < $sourceLength) $result .= "… ";
|
||
// Prepend an ellipsis if the context doesn't start at the beginning of a page
|
||
if(isset($contexts[0]) && $contexts[0]["from"] > 0) $result = " …$result";
|
||
|
||
return $result;
|
||
}
|
||
|
||
/**
|
||
* Highlights the keywords of a context string.
|
||
* @param string $query The query to use when highlighting.
|
||
* @param string $context The context string to highlight.
|
||
* @return string The highlighted (HTML) string.
|
||
*/
|
||
public static function highlight_context($query, $context)
|
||
{
|
||
$qterms = self::tokenize($query);
|
||
|
||
foreach($qterms as $qterm)
|
||
{
|
||
if(in_array($qterm, static::$stop_words))
|
||
continue;
|
||
|
||
// From http://stackoverflow.com/a/2483859/1460422
|
||
$context = preg_replace("/" . preg_replace('/\\//u', "\/", preg_quote($qterm)) . "/iu", "<strong class='search-term-highlight'>$0</strong>", $context);
|
||
}
|
||
|
||
return $context;
|
||
}
|
||
}
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Statistics",
|
||
"version" => "0.2",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "An extensible statistics calculation system. Comes with a range of built-in statistics, but can be extended by other modules too.",
|
||
"id" => "feature-stats",
|
||
"code" => function() {
|
||
global $settings, $env;
|
||
|
||
/**
|
||
* @api {get} ?action=stats Show wiki statistics
|
||
* @apiName Stats
|
||
* @apiGroup Utility
|
||
* @apiPermission Anonymous
|
||
* @since v0.15
|
||
* @apiParam {string} format Specify the format the data should be returned in. Supported formats: html (default), json.
|
||
* @apiParam {string} stat HTML format only. If specified the page for the stat with this id is sent instead of the list of scalar stats.
|
||
*/
|
||
|
||
/*
|
||
* ███████ ████████ █████ ████████ ███████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ███████ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ██ ██ ███████
|
||
*/
|
||
add_action("stats", function() {
|
||
global $settings, $statistic_calculators;
|
||
|
||
$allowed_formats = [ "html", "json" ];
|
||
$format = $_GET["format"] ?? "html";
|
||
|
||
if(!in_array($format, $allowed_formats)) {
|
||
http_response_code(400);
|
||
exit(page_renderer::render_main("Format error - $settings->sitename", "<p>Error: The format '$format' is not currently supported by this action on $settings->sitename. Supported formats: " . implode(", ", $allowed_formats) . "."));
|
||
}
|
||
|
||
$stats = stats_load();
|
||
|
||
if($format == "json") {
|
||
header("content-type: application/json");
|
||
exit(json_encode($stats, JSON_PRETTY_PRINT));
|
||
}
|
||
|
||
$stat_pages_list = "<a href='?action=stats'>Main</a> | ";
|
||
foreach($statistic_calculators as $stat_id => $stat_calculator) {
|
||
if($stat_calculator["type"] == "scalar")
|
||
continue;
|
||
$stat_pages_list .= "<a href='?action=stats&stat=" . rawurlencode($stat_id) . "'>{$stat_calculator["name"]}</a> | ";
|
||
}
|
||
$stat_pages_list = trim($stat_pages_list, " |");
|
||
|
||
if(!empty($_GET["stat"]) && !empty($statistic_calculators[$_GET["stat"]])) {
|
||
$stat_calculator = $statistic_calculators[$_GET["stat"]];
|
||
$content = "<h1>{$stat_calculator["name"]} - Statistics</h1>\n";
|
||
$content .= "<p>$stat_pages_list</p>\n";
|
||
switch($stat_calculator["type"]) {
|
||
case "page-list":
|
||
if(!module_exists("page-list")) {
|
||
$content .= "<p>$settings->sitename doesn't current have the page listing module installed, so HTML rendering of this statistic is currently unavailable. Try <a href='mailto:" . hide_email($settings->admindetails_email) . "'>contacting $settings->admindetails_name</a>, $settings->sitename's administrator and asking then to install the <code>page-list</code> module.</p>";
|
||
break;
|
||
}
|
||
$content .= "<p><strong>Count:</strong> " . count($stats->{$_GET["stat"]}->value) . "</p>\n";
|
||
$content .= generate_page_list($stats->{$_GET["stat"]}->value);
|
||
break;
|
||
|
||
case "page":
|
||
$content .= $stat_calculator["render"]($stats->{$_GET["stat"]});
|
||
break;
|
||
}
|
||
}
|
||
else
|
||
{
|
||
$content = "<h1>Statistics</h1>\n";
|
||
$content .= "<p>This page contains a selection of statistics about $settings->sitename's content. They are updated automatically about every " . trim(str_replace(["ago", "1 "], [""], human_time($settings->stats_update_interval))) . ", although $settings->sitename's local friendly moderators may update them earlier (you can see their names at the bottom of every page).</p>\n";
|
||
$content .= "<p>$stat_pages_list</p>\n";
|
||
|
||
$content .= "<table class='stats-table'>\n";
|
||
$content .= "\t<tr><th>Statistic</th><th>Value</th></tr>\n\n";
|
||
foreach($statistic_calculators as $stat_id => $stat_calculator) {
|
||
if($stat_calculator["type"] !== "scalar")
|
||
continue;
|
||
|
||
$content .= "\t<tr><td>{$stat_calculator["name"]}</td><td>{$stats->$stat_id->value}</td></tr>\n";
|
||
}
|
||
$content .= "</table>\n";
|
||
}
|
||
|
||
exit(page_renderer::render_main("Statistics - $settings->sitename", $content));
|
||
});
|
||
|
||
/**
|
||
* @api {get|post} ?action=stats-update Recalculate the wiki's statistics
|
||
* @apiName UpdateStats
|
||
* @apiGroup Utility
|
||
* @apiPermission Administrator
|
||
* @since v0.15
|
||
* @apiParam {string} secret POST only, optional. If you're not logged in, you can specify the wiki's sekret instead (find it in peppermint.json) using this parameter.
|
||
* @apiParam {bool} force Whether the statistics should be recalculated anyway - even if they have already recently been recalculated. Default: no. Supported values: yes, no.
|
||
*/
|
||
|
||
/*
|
||
* ███████ ████████ █████ ████████ ███████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ███████ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ██ ██ ███████
|
||
*
|
||
* ██ ██ ██████ ██████ █████ ████████ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██████ ██ ██ ███████ ██ █████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██ ██████ ██ ██ ██ ███████
|
||
*/
|
||
add_action("stats-update", function() {
|
||
global $env, $paths, $settings;
|
||
|
||
|
||
if(!$env->is_admin &&
|
||
(
|
||
empty($_POST["secret"]) ||
|
||
$_POST["secret"] !== $settings->secret
|
||
)
|
||
)
|
||
exit(page_renderer::render_main("Error - Recalculating Statistics - $settings->sitename", "<p>You need to be logged in as a moderator or better to get $settings->sitename to recalculate it's statistics. If you're logged in, try <a href='?action=logout'>logging out</a> and logging in again as a moderator. If you aren't logged in, try <a href='?action=login&returnto=%3Faction%3Dstats-update'>logging in</a>.</p>"));
|
||
|
||
// Delete the old stats cache
|
||
unlink($paths->statsindex);
|
||
|
||
update_statistics(true, ($_GET["force"] ?? "no") == "yes");
|
||
header("content-type: application/json");
|
||
echo(file_get_contents($paths->statsindex) . "\n");
|
||
});
|
||
|
||
add_help_section("150-statistics", "Statistics", "<p></p>");
|
||
|
||
//////////////////////////
|
||
/// Built-in Statisics ///
|
||
//////////////////////////
|
||
|
||
|
||
statistic_add([
|
||
"id" => "user_count",
|
||
"name" => "Users",
|
||
"type" => "scalar",
|
||
"update" => function($old_stats) {
|
||
global $settings;
|
||
|
||
$result = new stdClass(); // completed, value, state
|
||
$result->completed = true;
|
||
$result->value = count(get_object_vars($settings->users));
|
||
return $result;
|
||
}
|
||
]);
|
||
|
||
statistic_add([
|
||
"id" => "longest-pages",
|
||
"name" => "Longest Pages",
|
||
"type" => "page-list",
|
||
"update" => function($old_stats) {
|
||
global $pageindex;
|
||
|
||
$result = new stdClass(); // completed, value, state
|
||
$pages = [];
|
||
foreach($pageindex as $pagename => $pagedata) {
|
||
$pages[$pagename] = $pagedata->size;
|
||
}
|
||
arsort($pages);
|
||
|
||
$result->value = array_keys($pages);
|
||
$result->completed = true;
|
||
return $result;
|
||
}
|
||
]);
|
||
|
||
statistic_add([
|
||
"id" => "page_count",
|
||
"name" => "Page Count",
|
||
"type" => "scalar",
|
||
"update" => function($old_stats) {
|
||
global $pageindex;
|
||
|
||
$result = new stdClass(); // completed, value, state
|
||
$result->completed = true;
|
||
$result->value = count(get_object_vars($pageindex));
|
||
return $result;
|
||
}
|
||
]);
|
||
|
||
statistic_add([
|
||
"id" => "file_count",
|
||
"name" => "File Count",
|
||
"type" => "scalar",
|
||
"update" => function($old_stats) {
|
||
global $pageindex;
|
||
|
||
$result = new stdClass(); // completed, value, state
|
||
$result->completed = true;
|
||
$result->value = 0;
|
||
foreach($pageindex as $pagename => $pagedata) {
|
||
if(!empty($pagedata->uploadedfile) && $pagedata->uploadedfile)
|
||
$result->value++;
|
||
}
|
||
return $result;
|
||
}
|
||
]);
|
||
|
||
statistic_add([
|
||
"id" => "redirect_count",
|
||
"name" => "Redirect Pages",
|
||
"type" => "scalar",
|
||
"update" => function($old_stats) {
|
||
global $pageindex;
|
||
|
||
$result = new stdClass(); // completed, value, state
|
||
$result->completed = true;
|
||
$result->value = 0;
|
||
foreach($pageindex as $pagename => $pagedata) {
|
||
if(!empty($pagedata->redirect) && $pagedata->redirect)
|
||
$result->value++;
|
||
}
|
||
return $result;
|
||
}
|
||
]);
|
||
|
||
// Perform an automatic recalculation of the statistics if needed
|
||
if($env->action !== "stats-update")
|
||
update_statistics(false);
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* Updates the wiki's statistics.
|
||
* @package feature-stats
|
||
* @param boolean $update_all Whether all the statistics should be checked and recalculated, or just as many as we have time for according to the settings.
|
||
* @param boolean $force Whether we should recalculate statistics that don't currently require recalculating anyway.
|
||
*/
|
||
function update_statistics($update_all = false, $force = false)
|
||
{
|
||
global $settings, $statistic_calculators;
|
||
|
||
// Clear the existing statistics if we are asked to recalculate them all
|
||
if($force)
|
||
stats_save(new stdClass());
|
||
|
||
$stats = stats_load();
|
||
|
||
$start_time = microtime(true);
|
||
$stats_updated = 0;
|
||
foreach($statistic_calculators as $stat_id => $stat_calculator)
|
||
{
|
||
// If statistic doesn't exist or it's out of date then we should recalculate it.
|
||
// Otherwise, leave it and continue on to the next stat.
|
||
if(!empty($stats->$stat_id) && $start_time - $stats->$stat_id->lastupdated < $settings->stats_update_interval)
|
||
continue;
|
||
|
||
$mod_start_time = microtime(true);
|
||
|
||
// Run the statistic calculator, passing in the existing stats data
|
||
$calculated = $stat_calculator["update"](!empty($stats->$stat_id) ? $stats->$stat_id : new stdClass());
|
||
|
||
$new_stat_data = new stdClass();
|
||
$new_stat_data->id = $stat_id;
|
||
$new_stat_data->name = $stat_calculator["name"];
|
||
$new_stat_data->lastupdated = $calculated->completed ? $mod_start_time : $stats->$stat_id->lastupdated;
|
||
$new_stat_data->value = $calculated->value;
|
||
if(!empty($calculated->state))
|
||
$new_stat_data->state = $calculated->state;
|
||
|
||
// Save the new statistics
|
||
$stats->$stat_id = $new_stat_data;
|
||
|
||
$stats_updated++;
|
||
|
||
if(!$update_all && microtime(true) - $start_time >= $settings->stats_update_processingtime)
|
||
break;
|
||
}
|
||
|
||
header("x-stats-recalculated: $stats_updated");
|
||
//round((microtime(true) - $pageindex_read_start)*1000, 3)
|
||
header("x-stats-calctime: " . round((microtime(true) - $start_time)*1000, 3) . "ms");
|
||
|
||
stats_save($stats);
|
||
}
|
||
|
||
/**
|
||
* Loads and returns the statistics cache file.
|
||
* @package feature-stats
|
||
* @return object The loaded & decoded statistics.
|
||
*/
|
||
function stats_load()
|
||
{
|
||
global $paths;
|
||
static $stats = null;
|
||
if($stats == null)
|
||
$stats = file_exists($paths->statsindex) ? json_decode(file_get_contents($paths->statsindex)) : new stdClass();
|
||
return $stats;
|
||
}
|
||
/**
|
||
* Saves the statistics back to disk.
|
||
* @package feature-stats
|
||
* @param object The statistics cache to save.
|
||
* @return bool Whether saving succeeded or not.
|
||
*/
|
||
function stats_save($stats)
|
||
{
|
||
global $paths;
|
||
return file_put_contents($paths->statsindex, json_encode($stats, JSON_PRETTY_PRINT) . "\n");
|
||
}
|
||
|
||
|
||
register_module([
|
||
"name" => "Uploader",
|
||
"version" => "0.5.14",
|
||
"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() {
|
||
global $settings;
|
||
/**
|
||
* @api {get} ?action=upload[&avatar=yes] Get a page to let you upload a file.
|
||
* @apiName UploadFilePage
|
||
* @apiGroup Upload
|
||
* @apiPermission User
|
||
*
|
||
* @apiParam {boolean} avatar Optional. If true then a special page to upload your avatar is displayed instead.
|
||
*/
|
||
|
||
/**
|
||
* @api {post} ?action=upload Upload a file
|
||
* @apiName UploadFile
|
||
* @apiGroup Upload
|
||
* @apiPermission User
|
||
*
|
||
* @apiParam {string} name The name of the file to upload.
|
||
* @apiParam {string} description A description of the file.
|
||
* @apiParam {file} file The file to upload.
|
||
* @apiParam {boolean} avatar Whether this upload should be uploaded as the current user's avatar. If specified, any filenames provided will be ignored.
|
||
*
|
||
* @apiUse UserNotLoggedInError
|
||
* @apiError UploadsDisabledError Uploads are currently disabled in the wiki's settings.
|
||
* @apiError UnknownFileTypeError The type of the file you uploaded is not currently allowed in the wiki's settings.
|
||
* @apiError ImageDimensionsFiledError PeppermintyWiki couldn't obtain the dimensions of the image you uploaded.
|
||
* @apiError DangerousFileError The file uploaded appears to be dangerous.
|
||
* @apiError DuplicateFileError The filename specified is a duplicate of a file that already exists.
|
||
* @apiError FileTamperedError Pepperminty Wiki couldn't verify that the file wasn't tampered with during theupload process.
|
||
*/
|
||
|
||
/*
|
||
* ██ ██ ██████ ██ ██████ █████ ██████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██████ ██ ██ ██ ███████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ██ ███████ ██████ ██ ██ ██████
|
||
*/
|
||
add_action("upload", function() {
|
||
global $settings, $env, $pageindex, $paths;
|
||
|
||
$is_avatar = !empty($_POST["avatar"]) || !empty($_GET["avatar"]);
|
||
|
||
switch($_SERVER["REQUEST_METHOD"])
|
||
{
|
||
case "GET":
|
||
// Send upload page
|
||
|
||
if(!$settings->upload_enabled)
|
||
exit(page_renderer::render("Upload Disabled - $setting->sitename", "<p>You can't upload anything at the moment because $settings->sitename has uploads disabled. Try contacting $settings->admindetails_name, your site Administrator. <a href='javascript:history.back();'>Go back</a>.</p>"));
|
||
if(!$env->is_logged_in)
|
||
exit(page_renderer::render("Upload Error - $settings->sitename", "<p>You are not currently logged in, so you can't upload anything.</p>
|
||
<p>Try <a href='?action=login&returnto=" . rawurlencode("?action=upload") . "'>logging in</a> first.</p>"));
|
||
|
||
if($is_avatar) {
|
||
exit(page_renderer::render("Upload avatar - $settings->sitename", "<h1>Upload avatar</h1>
|
||
<p>Select an image below, and then press upload. $settings->sitename currently supports the following file types (though not all of them may be suitable for an avatar): " . implode(", ", $settings->upload_allowed_file_types) . "</p>
|
||
<form method='post' action='?action=upload' enctype='multipart/form-data'>
|
||
<label for='file'>Select a file to upload.</label>
|
||
<input type='file' name='file' id='file-upload-selector' tabindex='1' />
|
||
<br />
|
||
|
||
<p class='editing_message'>$settings->editing_message</p>
|
||
<input type='hidden' name='avatar' value='yes' />
|
||
<input type='submit' value='Upload' tabindex='20' />
|
||
</form>"));
|
||
}
|
||
|
||
exit(page_renderer::render("Upload - $settings->sitename", "<h1>Upload file</h1>
|
||
<p>Select an image or file 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.</p>
|
||
<p>$settings->sitename currently supports uploading of the following file types: " . implode(", ", $settings->upload_allowed_file_types) . ".</p>
|
||
<form method='post' action='?action=upload' enctype='multipart/form-data'>
|
||
<label for='file-upload-selector'>Select a file to upload.</label>
|
||
<input type='file' name='file' id='file-upload-selector' tabindex='1' />
|
||
<br />
|
||
<label for='file-upload-name'>Name:</label>
|
||
<input type='text' name='name' id='file-upload-name' tabindex='5' />
|
||
<br />
|
||
<label for='description'>Description:</label>
|
||
<textarea name='description' tabindex='10'></textarea>
|
||
<p class='editing_message'>$settings->editing_message</p>
|
||
<input type='submit' value='Upload' tabindex='20' />
|
||
</form>
|
||
<script>
|
||
document.getElementById('file-upload-selector').addEventListener('change', function(event) {
|
||
var newName = event.target.value.substring(event.target.value.lastIndexOf(\"\\\\\") + 1, event.target.value.lastIndexOf(\".\"));
|
||
console.log('Changing content of name box to:', newName);
|
||
document.getElementById('file-upload-name').value = newName;
|
||
});
|
||
</script>"));
|
||
|
||
break;
|
||
|
||
case "POST":
|
||
// Recieve file
|
||
|
||
if(!$settings->editing) {
|
||
exit(page_renderer::render_main("Upload failed - $settings->sitename", "<p>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. <a href='index.php'>Go back to the main page</a>."));
|
||
}
|
||
|
||
// 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", "<p>Your upload couldn't be processed because uploads are currently disabled on $settings->sitename. <a href='index.php'>Go back to the main page</a>.</p>"));
|
||
}
|
||
|
||
// 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", "<p>Your upload couldn't be processed because you are not logged in.</p><p>Try <a href='?action=login&returnto=" . rawurlencode("?action=upload") . "'>logging in</a> 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", "<p>Your upload couldn't be processed because " . (($_FILES["file"]["error"] == 1 || $_FILES["file"]["error"] == 2) ? "the file is too large" : "an error occurred") . ".</p><p>Please contact $settings->admindetails_name, $settings->sitename's administrator for help.</p>"));
|
||
|
||
}
|
||
|
||
// 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", "<p>$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.</p>
|
||
<p>The file you tried to upload appeared to be of type <code>$mime_type</code>, but $settings->sitename currently only allows the uploading of the following file types: <code>" . implode("</code>, <code>", $settings->upload_allowed_file_types) . "</code>.</p>
|
||
<p><a href='?action=$settings->defaultaction'>Go back</a> to the Main Page.</p>"));
|
||
}
|
||
|
||
// 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", "<p>That file appears to be unsuitable as an avatar, as $settings->sitename has detected it to be of type <code>$mime_type</code>, which doesn't appear to be an image. Please try <a href='?action=upload&avatar=yes'>uploading a different file</a> to use as your avatar.</p>"));
|
||
}
|
||
|
||
switch(substr($mime_type, 0, strpos($mime_type, "/")))
|
||
{
|
||
case "image":
|
||
$extra_data = [];
|
||
// Check SVG uploads with a special function
|
||
$imagesize = $mime_type !== "image/svg+xml" ? getimagesize($temp_filename, $extra_data) : upload_check_svg($temp_filename);
|
||
|
||
// 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", "<p>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. <a href='?action=upload'>Go back to try again</a>.</p>
|
||
<p>You may wish to consider <a href='https://github.com/sbrl/Pepperminty-Wiki'>opening an issue</a> against Pepperminty Wiki (the software that powers $settings->sitename) if this isn't the first time that you have seen this message.</p>"));
|
||
}
|
||
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", "<p>The file you uploaded appears to be dangerous and has been discarded. Please contact $settings->sitename's administrator for assistance.</p>
|
||
<p>Additional information: The file uploaded appeared to be of type <code>$mime_type</code>, which mapped onto the extension <code>$file_extension</code>. This file extension has the potential to be executed accidentally by the web server.</p>"));
|
||
}
|
||
|
||
// Rewrite the name to include the _actual_ file extension we've cleverly calculated :D
|
||
|
||
// The path to the place (relative to the wiki data root)
|
||
// that we're actually going to store the uploaded file itself
|
||
$new_filename = "$paths->upload_file_prefix$target_name.$file_extension";
|
||
// The path (relative, as before) to the description file
|
||
$new_description_filename = "$new_filename.md";
|
||
|
||
// The page path that the new file will be stored under
|
||
$new_pagepath = $new_filename;
|
||
|
||
// Rewrite the paths to store avatars in the right place
|
||
if($is_avatar) {
|
||
$new_pagepath = $target_name;
|
||
$new_filename = "$target_name.$file_extension";
|
||
}
|
||
|
||
if(isset($pageindex->$new_pagepath) && !$is_avatar)
|
||
exit(page_renderer::render("Upload Error - $settings->sitename", "<p>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.</p>"));
|
||
|
||
// 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", "<p>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.</p>"));
|
||
}
|
||
|
||
$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\t<figure class='preview'>
|
||
<a href='$originalUrl'><img src='$previewUrl' /></a>
|
||
<nav class='image-controls'>
|
||
<ul><li><a href='$originalUrl'>🌄 Original $fileTypeDisplay</a></li>";
|
||
if($mime_type !== "image/svg+xml")
|
||
{
|
||
$preview_html .= "<li>Other Sizes: ";
|
||
foreach($preview_sizes as $size)
|
||
$preview_html .= "<a href='?action=preview&page=" . rawurlencode($env->page) . "&size=$size'>$size" . "px</a> ";
|
||
$preview_html .= "</li>";
|
||
}
|
||
$preview_html .= "</ul></nav>\n\t\t\t</figure>";
|
||
break;
|
||
|
||
case "video":
|
||
$preview_html .= "\t\t\t<figure class='preview'>
|
||
<video src='$previewUrl' controls preload='metadata'>Your browser doesn't support HTML5 video, but you can still <a href='$previewUrl'>download it</a> if you'd like.</video>
|
||
</figure>";
|
||
break;
|
||
|
||
case "audio":
|
||
$preview_html .= "\t\t\t<figure class='preview'>
|
||
<audio src='$previewUrl' controls preload='metadata'>Your browser doesn't support HTML5 audio, but you can still <a href='$previewUrl'>download it</a> if you'd like.</audio>
|
||
</figure>";
|
||
}
|
||
|
||
$fileInfo = [];
|
||
$fileInfo["Name"] = str_replace("Files/", "", $filepath);
|
||
$fileInfo["Type"] = $mime_type;
|
||
$fileInfo["Size"] = human_filesize(filesize($env->storage_prefix . $filepath));
|
||
switch($fileTypeDisplay)
|
||
{
|
||
case "image":
|
||
$dimensionsKey = $mime_type !== "image/svg+xml" ? "Original dimensions" : "Native size";
|
||
$fileInfo[$dimensionsKey] = "$dimensions[0] x $dimensions[1]";
|
||
break;
|
||
}
|
||
$fileInfo["Uploaded by"] = $pageindex->{$env->page}->lasteditor;
|
||
$fileInfo["Short markdown embed code"] = "<input type='text' class='short-embed-markdown-code' value='![" . htmlentities($fileInfo["Name"], ENT_QUOTES | ENT_HTML5) . "](" . htmlentities($filepath, ENT_QUOTES | ENT_HTML5) . " | right | 350x350)' readonly /> <button class='short-embed-markdown-button'>Copy</button>";
|
||
|
||
$preview_html .= "\t\t\t<h2>File Information</h2>
|
||
<table>";
|
||
foreach ($fileInfo as $displayName => $displayValue)
|
||
{
|
||
$preview_html .= "<tr><th>$displayName</th><td>$displayValue</td></tr>\n";
|
||
}
|
||
$preview_html .= "</table>";
|
||
|
||
$parts["{content}"] = str_replace("</h1>", "</h1>\n$preview_html", $parts["{content}"]);
|
||
}
|
||
});
|
||
|
||
// Add the snippet that copies the embed markdown code to the clipboard
|
||
page_renderer::AddJSSnippet('window.addEventListener("load", function(event) {
|
||
let button = document.querySelector(".short-embed-markdown-button");
|
||
if(button == null) return;
|
||
button.addEventListener("click", function(inner_event) {
|
||
let input = document.querySelector(".short-embed-markdown-code");
|
||
input.select();
|
||
button.innerHTML = document.execCommand("copy") ? "Copied!" : "Failed to copy :-(";
|
||
});
|
||
});');
|
||
|
||
// Register a section on the help page on uploading files
|
||
add_help_section("28-uploading-files", "Uploading Files", "<p>$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") . ").</p>
|
||
<p>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 (<a href='//github.com/sbrl/Pepperminty-Wiki/issues'>open an issue on GitHub</a> if you are interested in support for more file types).</p>
|
||
<p>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).</p>
|
||
<p>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.</p>");
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* 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), "<script") !== false)
|
||
{
|
||
http_response_code(415);
|
||
exit(page_renderer::render("Upload Error - $settings->sitename", "<p>$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. <a href='?action=upload'>Go back to try again</a>.</p>
|
||
<p>You may wish to consider <a href='https://github.com/sbrl/Pepperminty-Wiki'>opening an issue</a> against Pepperminty Wiki (the software that powers $settings->sitename) if this isn't the first time that you have seen this message.</p>"));
|
||
}
|
||
|
||
// 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", "<p>When $settings->sitename tried to open your SVG file for checking, it found some invalid syntax. The uploaded file has been discarded. <a href='?action=upload'>Go back to try again</a>.</p>"));
|
||
}
|
||
$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", "<p>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 <a href='?action=login&returnto=" . rawurlencode("?action=user-preferences") . "'>here</a>.</p>"));
|
||
}
|
||
|
||
$statusMessages = [
|
||
"change-password" => "Password changed successfully!"
|
||
];
|
||
|
||
if(!isset($env->user_data->emailAddress)) {
|
||
$env->user_data->emailAddress = "";
|
||
save_userdata();
|
||
}
|
||
|
||
$content = "<h2>User Preferences</h2>\n";
|
||
if(isset($_GET["success"]) && $_GET["success"] === "yes")
|
||
{
|
||
$content .= "<p class='user-prefs-status-message'><em>" . $statusMessages[$_GET["operation"]] . "</em></p>\n";
|
||
}
|
||
// If avatar support is present, allow the user to upload a new avatar
|
||
if(has_action("avatar") && module_exists("feature-upload")) {
|
||
$content .= "<a href='?action=upload&avatar=yes' class='preview'><figure>\n";
|
||
$content .= "\t<img class='avatar' src='?action=avatar&user=" . urlencode($env->user) . "&size=256' title='Your current avatar - click to upload a new one' />\n";
|
||
$content .= "<figcaption>Upload a new avatar</figcaption>\n";
|
||
$content .= "</figure></a><br />\n";
|
||
}
|
||
$content .= "<label for='username'>Username:</label>\n";
|
||
$content .= "<input type='text' name='username' value='$env->user' readonly />\n";
|
||
$content .= "<form method='post' action='?action=save-preferences'>\n";
|
||
$content .= " <label for='email-address'>Email Address:</label>\n";
|
||
$content .= " <input type='email' id='email-address' name='email-address' placeholder='e.g. bob@bobsrockets.com' value='{$env->user_data->emailAddress}' />\n";
|
||
$content .= " <p><small>Used to send you notifications etc. Never shared with anyone except $settings->admindetails_name, $settings->sitename's administrator.</small></p>\n";
|
||
$content .= " <input type='submit' value='Save Preferences' />\n";
|
||
$content .= "</form>\n";
|
||
$content .= "<h3>Change Password</h3\n>";
|
||
$content .= "<form method='post' action='?action=change-password'>\n";
|
||
$content .= " <label for='old-pass'>Current Password:</label>\n";
|
||
$content .= " <input type='password' name='current-pass' />\n";
|
||
$content .= " <br />\n";
|
||
$content .= " <label for='new-pass'>New Password:</label>\n";
|
||
$content .= " <input type='password' name='new-pass' />\n";
|
||
$content .= " <br />\n";
|
||
$content .= " <label for='new-pass-confirm'>Confirm New Password:</label>\n";
|
||
$content .= " <input type='password' name='new-pass-confirm' />\n";
|
||
$content .= " <br />\n";
|
||
$content .= " <input type='submit' value='Change Password' />\n";
|
||
$content .= "</form>\n";
|
||
|
||
if($env->is_admin)
|
||
$content .= "<p>As an admin, you can also <a href='?action=configure'>edit $settings->sitename's master settings</a>.</p>\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", "<p>You aren't logged in, so you can't save your preferences. Try <a href='?action=login&returnto=" . rawurlencode("?action=user-preferences") . "'>logging in</a> first.</p>"));
|
||
}
|
||
|
||
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", "<p>The email address you supplied (<code>{$_POST['email-address']}</code>) is too long. Email addresses can only be 320 characters long. <a href='javascript:window.history.back();'>Go back</a>."));
|
||
}
|
||
|
||
if(mb_strpos($_POST["email-address"], "@") === false)
|
||
{
|
||
http_response_code(422);
|
||
exit(page_renderer::render_main("Error Saving Email Address - $settings->sitename", "<p>The email address you supplied (<code>{$_POST['email-address']}</code>) doesn't appear to be valid. <a href='javascript:window.history.back();'>Go back</a>."));
|
||
}
|
||
|
||
$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", "<p>$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: <a href='mailto:" . hide_email($settings->admindetails_email) . "'>" . hide_email($settings->admindetails_email) . "</a>.</p>"));
|
||
}
|
||
|
||
exit(page_renderer::render_main("Preferences Saved Successfully - $settings->sitename", "<p>Your preferences have been saved successfully! You could go back your <a href='?action=user-preferences'>preferences page</a>, or on to the <a href='?page=" . rawurlencode($settings->defaultpage) . "'>$settings->defaultpage</a>.</p>"));
|
||
});
|
||
|
||
/**
|
||
* @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", "<p>The new password you typed twice didn't match! <a href='javascript:history.back();'>Go back</a>.</p>"));
|
||
}
|
||
// Check the current password
|
||
if(!verify_password($_POST["current-pass"], $env->user_data->password)) {
|
||
exit(page_renderer::render_main("Password mismatch - $settings->sitename", "<p>Error: You typed your current password incorrectly! <a href='javascript:history.back();'>Go back</a>.</p>"));
|
||
}
|
||
|
||
// 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", "<p>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", "<p>You password was changed successfully. <a href='?action=user-preferences'>Go back to the user preferences page</a>.</p>"));
|
||
});
|
||
|
||
|
||
/*
|
||
* █████ ██ ██ █████ ████████ █████ ██████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ███████ ██ ███████ ██████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ████ ██ ██ ██ ██ ██ ██ ██
|
||
*/
|
||
|
||
/**
|
||
* @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", "<p>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 <a href='?action=user-preferences'>preferences page</a>, which can be accessed at any time by clicking the cog icon (it looks something like this: <a href='?action=user-preferences'>$settings->user_preferences_button_text</a>), though the administrator of $settings->sitename ($settings->admindetails_name) may have changed its appearance.</p>");
|
||
}
|
||
|
||
if($settings->avatars_show)
|
||
{
|
||
add_help_section("915-avatars", "Avatars", "<p>$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 <a href='https://www.techopedia.com/definition/19744/hash-function'>hash</a> of your email address and ask <a href='https://gravatar.com'>Gravatar</a> 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.</p>
|
||
<p>Your avatar on $settings->sitename currently looks like this: <img class='avatar' src='?action=avatar&user=" . urlencode($env->user) . "' />" . ($settings->upload_enabled ? " - you can upload a new one by going to your <a href='?action=user-preferences'>preferences</a>, or <a href='?action=upload&avatar=yes' />clicking here</a>." : ", 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 <a href='?action=user-preferences'>preferences</a> and <a href='https://en.gravatar.com/'>create a Gravatar</a>, and then it should show up here on $settings->sitename shortly.") . "</p>");
|
||
}
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "User Organiser",
|
||
"version" => "0.1",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds a organiser page that lets moderators (or better) control the reegistered user accounts, and perform adminstrative actions such as password resets, and adding / removing accounts.",
|
||
"id" => "feature-user-table",
|
||
"code" => function() {
|
||
global $settings, $env;
|
||
|
||
/**
|
||
* @api {get} ?action=user-table Get the user table
|
||
* @apiName UserTable
|
||
* @apiGroup Settings
|
||
* @apiPermission Moderator
|
||
*/
|
||
|
||
/*
|
||
* ██ ██ ███████ ███████ ██████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ███████ █████ ██████ █████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ██████ ███████ ███████ ██ ██
|
||
*
|
||
* ████████ █████ ██████ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ███████ ██████ ██ █████
|
||
* ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██████ ███████ ███████
|
||
*/
|
||
add_action("user-table", function() {
|
||
global $settings, $env;
|
||
|
||
if(!$env->is_logged_in || !$env->is_admin) {
|
||
http_response_code(401);
|
||
exit(page_renderer::render_main("Unauthorised - User Table - $settings->sitename", "<p>Only moderators (or better) may access the user table. You could try <a href='?action=logout'>logging out</a> and then <a href='?action=login&returnto=index.php%3Faction%3Duser-table'>logging in</a> again as a moderator, or alternatively visit the <a href='?action=user-list'>user list</a> instead, if that's what you're after.</p>"));
|
||
}
|
||
|
||
$content = "<h2>User Table</h2>
|
||
<p>(Warning! Deleting a user will wipe <em>all</em> 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.)</p>
|
||
<table class='user-table'>
|
||
<tr><th>Username</th><th>Email Address</th><th></th></tr>\n";
|
||
|
||
foreach($settings->users as $username => $user_data) {
|
||
$content .= "<tr>";
|
||
$content .= "<td>" . page_renderer::render_username($username) . "</td>";
|
||
if(!empty($user_data->email))
|
||
$content .= "<td><a href='mailto:" . htmlentities($user_data->email, ENT_HTML5 | ENT_QUOTES) . "'>" . htmlentities($user_data->email) . "</a></td>\n";
|
||
else
|
||
$content .= "<td><em>(None provided)</em></td>\n";
|
||
$content .= "<td>";
|
||
if(module_exists("feature-user-preferences"))
|
||
$content .= "<form method='post' action='?action=set-password' class='inline-form'>
|
||
<input type='hidden' name='user' value='$username' />
|
||
<input type='password' name='new-pass' placeholder='New password' />
|
||
<input type='submit' value='Reset Password' />
|
||
</form> | ";
|
||
$content .= "<a href='?action=user-delete&user=" . rawurlencode($username) . "'>Delete User</a>";
|
||
$content .= "</td></tr>";
|
||
}
|
||
|
||
$content .= "</table>\n";
|
||
|
||
$content .= "<h3>Add User</h3>
|
||
<form method='post' action='?action=user-add'>
|
||
<input type='text' id='new-username' name='user' placeholder='Username' required />
|
||
<input type='email' id='new-email' name='email' placeholder='Email address - optional' />
|
||
<input type='submit' value='Add user' />
|
||
</form>";
|
||
|
||
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", "<p>Only moderators (or better) may create users. You could try <a href='?action=logout'>logging out</a> and then <a href='?action=login&returnto%2Findex.php%3Faction%3Duser-table'>logging in</a> again as a moderator, or alternatively visit the <a href='?action=user-list'>user list</a> instead, if that's what you're after.</p>"));
|
||
}
|
||
|
||
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", "<p>The username <code>" . htmlentities($new_username) . "</code> contains some invalid characters. Only <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>-</code>, and <code>_</code> are allowed in usernames. <a href='javascript:window.history.back();'>Go back</a>.</p>"));
|
||
}
|
||
if(!empty($new_email) && !filter_var($new_email, FILTER_VALIDATE_EMAIL)) {
|
||
http_response_code(400);
|
||
exit(page_renderer::render_main("Error: Invalid Email Address - Add User - $settings->sitename", "<p>The email address <code>" . htmlentities($new_email) . "</code> appears to be invalid. <a href='javascript:window.history.back();'>Go back</a>.</p>"));
|
||
}
|
||
|
||
$new_password = generate_password($settings->new_password_length);
|
||
|
||
$user_data = new stdClass();
|
||
$user_data->password = hash_password($new_password);
|
||
if(!empty($new_email))
|
||
$user_data->email = $new_email;
|
||
|
||
$settings->users->$new_username = $user_data;
|
||
|
||
if(!save_settings()) {
|
||
http_response_code(503);
|
||
exit(page_renderer::render_main("Error: Failed to save settings - Add User - $settings->sitename", "<p>$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).</p>"));
|
||
}
|
||
|
||
|
||
$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 = "<h2>Add User</h2>
|
||
<p>The new user was added to $settings->sitename sucessfully! Their details are as follows:</p>
|
||
<ul>
|
||
<li>Username: <code>$new_username</code></li>";
|
||
if(!empty($new_email))
|
||
$content .= " <li>Email Address: <code>$new_email</code></li>\n";
|
||
if(!$welcome_email_result)
|
||
$content .= " <li>Password: <code>$new_password</code></li>\n";
|
||
$content .= "</ul>\n";
|
||
if($welcome_email_result)
|
||
$content .= "<p>An email has been sent to the email address given above containing their login details.</p>\n";
|
||
|
||
$content .= "<p><a href='?action=user-table'>Go back</a> to the user table.</p>\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", "<p>Error: You aren't logged in as a moderator, so you don't have permission to set a user's password.</p>"));
|
||
}
|
||
if(empty($_POST["user"])) {
|
||
http_response_code(400);
|
||
exit(page_renderer::render_main("Error - Set Password - $settings->sitename", "<p>Error: No username was provided via the 'user' POST parameter.</p>"));
|
||
}
|
||
if(empty($_POST["new-pass"])) {
|
||
http_response_code(400);
|
||
exit(page_renderer::render_main("Error - Set Password - $settings->sitename", "<p>Error: No password was provided via the 'new-pass' POST parameter.</p>"));
|
||
}
|
||
|
||
if(empty($settings->users->{$_POST["user"]})) {
|
||
http_response_code(404);
|
||
exit(page_renderer::render_main("User not found - Set Password - $settings->sitename", "<p>Error: No user called {$_POST["user"]} was found, so their password can't be set. Perhaps you forgot to create the user first?</p>"));
|
||
}
|
||
|
||
$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", "<p>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.</p>"));
|
||
}
|
||
|
||
exit(page_renderer::render_main("Set Password - $settings->sitename", "<p>" . htmlentities($_POST["user"]) . "'s password has been set successfully. <a href='?action=user-table'>Go back</a> to the user table.</p>"));
|
||
});
|
||
|
||
|
||
/**
|
||
* @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", "<p>Error: You aren't logged in as a moderator, so you don't have permission to delete a user's account.</p>"));
|
||
}
|
||
if(empty($_GET["user"])) {
|
||
http_response_code(400);
|
||
exit(page_renderer::render_main("Error - Delete User - $settings->sitename", "<p>Error: No username was provided in the <code>user</code> POST variable.</p>"));
|
||
}
|
||
if(empty($settings->users->{$_GET["user"]})) {
|
||
http_response_code(404);
|
||
exit(page_renderer::render_main("User not found - Delete User - $settings->sitename", "<p>Error: No user called {$_GET["user"]} was found, so their account can't be delete. Perhaps you spelt their account name incorrectly?</p>"));
|
||
}
|
||
|
||
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", "<p>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.</p>"));
|
||
}
|
||
|
||
exit(page_renderer::render_main("Delete User - $settings->sitename", "<p>" . htmlentities($_GET["user"]) . "'s account has been deleted successfully. <a href='?action=user-table'>Go back</a> to the user table.</p>"));
|
||
});
|
||
|
||
|
||
if($env->is_admin) add_help_section("949-user-table", "Managing User Accounts", "<p>As a moderator on $settings->sitename, you can use the <a href='?action=user-table'>User Table</a> to adminstrate the user accounts on $settings->sitename. It allows you to perform actions such as adding and removing accounts, and resetting passwords.</p>");
|
||
}
|
||
]);
|
||
/**
|
||
* 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 = "<ul>\n";
|
||
foreach($credits as $thing => $author_details)
|
||
{
|
||
$credits_html .= " <li>";
|
||
$credits_html .= "<a href='" . $author_details["thing_url"] . "'>$thing</a> by ";
|
||
if(isset($author_details["icon"]))
|
||
$credits_html .= "<img class='logo small' style='vertical-align: middle;' src='" . $author_details["icon"] . "' /> ";
|
||
$credits_html .= "<a href='" . $author_details["author_url"] . "'>" . $author_details["author"] . "</a>";
|
||
$credits_html .= "</li>\n";
|
||
}
|
||
$credits_html .= "</ul>";
|
||
///////////////////////////////
|
||
|
||
//// Module html renderer ////
|
||
$modules_html = "<table>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Version</th>
|
||
<th>Author</th>
|
||
<th>Description</th>
|
||
</tr>";
|
||
foreach($modules as $module)
|
||
{
|
||
$modules_html .= " <tr>
|
||
<td title='" . $module["id"] . "'>" . $module["name"] . "</td>
|
||
<td>" . $module["version"] . "</td>
|
||
<td>" . $module["author"] . "</td>
|
||
<td>" . $module["description"] . "</td>
|
||
</tr>\n";
|
||
}
|
||
$modules_html .= "</table>";
|
||
//////////////////////////////
|
||
|
||
$title = "Credits - $settings->sitename";
|
||
$content = "<h1>$settings->sitename credits</h1>
|
||
<p>$settings->sitename is powered by Pepperminty Wiki - an entire wiki packed inside a single file, which was built by <a href='//starbeamrainbowlabs.com'>Starbeamrainbowlabs</a>, and can be found <a href='//github.com/sbrl/Pepperminty-Wiki/'>on GitHub</a> (contributors will also be listed here in the future). Pepperminty Wiki is licensed under the <a target='_blank' href='https://www.mozilla.org/en-US/MPL/2.0/'>Mozilla Public License 2.0</a> (<a target='_blank' href='https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)'>simple version</a>).</p>
|
||
<h2>Main Credits</h2>
|
||
$credits_html
|
||
<h2>Site status</h2>
|
||
<table>
|
||
<tr><th>Site name:</th><td>$settings->sitename (<a href='?action=update'>{$settings->admindisplaychar}Update</a>, <a href='?action=configure'>{$settings->admindisplaychar} 🔧 Edit master settings</a>, <a href='?action=user-table'>{$settings->admindisplaychar} 👥 Edit user table</a>, <a href='?action=export'>🏛 Export as zip - Check for permission first</a>)</td></tr>
|
||
<tr><th>Pepperminty Wiki version:</th><td>$version</td></tr>
|
||
<tr><th>Number of pages:</th><td>" . count(get_object_vars($pageindex)) . "</td></tr>
|
||
<tr><th>Number of modules:</th><td>" . count($modules) . "</td></tr>
|
||
</table>
|
||
<h2>Installed Modules</h2>
|
||
$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", "<p>As a moderator, $settings->sitename gives you the ability to generate a report on $settings->sitename's installation of Pepperminty Wiki for debugging purposes.</p>
|
||
<p>To generate such a report, visit the <code>debug</code> action or <a href='?action=debug'>click here</a>.</p>");
|
||
}
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Page deleter",
|
||
"version" => "0.10",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds an action to allow administrators to delete pages.",
|
||
"id" => "page-delete",
|
||
"code" => function() {
|
||
global $settings;
|
||
/**
|
||
* @api {post} ?action=delete Delete a page
|
||
* @apiDescription Delete a page and all its associated data.
|
||
* @apiName DeletePage
|
||
* @apiGroup Page
|
||
* @apiPermission Moderator
|
||
*
|
||
* @apiParam {string} page The name of the page to delete.
|
||
* @apiParam {string} delete Set to 'yes' to actually delete the page.
|
||
*
|
||
* @apiUse UserNotModeratorError
|
||
* @apiError PageNonExistentError The specified page doesn't exist
|
||
*/
|
||
|
||
/*
|
||
* ██████ ███████ ██ ███████ ████████ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ █████ ██ █████ ██ █████
|
||
* ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ███████ ███████ ███████ ██ ███████
|
||
*/
|
||
add_action("delete", function() {
|
||
global $pageindex, $settings, $env, $paths, $modules;
|
||
if(!$settings->editing)
|
||
{
|
||
exit(page_renderer::render_main("Error: Editing disabled - Deleting $env->page", "<p>You tried to delete $env->page, but editing is disabled on this wiki.</p>
|
||
<p>If you wish to delete this page, please re-enable editing on this wiki first.</p>
|
||
<p><a href='index.php?page=$env->page'>Go back to $env->page</a>.</p>
|
||
<p>Nothing has been changed.</p>"));
|
||
}
|
||
if(!$env->is_admin)
|
||
{
|
||
exit(page_renderer::render_main("Error: Insufficient permissions - Deleting $env->page", "<p>You tried to delete $env->page, but you as aren't a moderator you don't have permission to do that.</p>
|
||
<p>You could try <a href='index.php?action=login'>logging in</a> 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.</p>"));
|
||
}
|
||
if(!isset($pageindex->{$env->page}))
|
||
{
|
||
exit(page_renderer::render_main("Error: Non-existent page - Deleting $env->page", "<p>You tried to delete $env->page, but that page doesn't appear to exist in the first page. <a href='?'>Go back</a> to the $settings->defaultpage.</p>"));
|
||
}
|
||
|
||
if(!isset($_GET["delete"]) or $_GET["delete"] !== "yes")
|
||
{
|
||
exit(page_renderer::render_main("Deleting $env->page", "<p>You are about to <strong>delete</strong> <em>$env->page</em>" . (module_exists("feature-history")?" and all its revisions":"") . (module_exists("feature-comments")?" and all its comments":"") . ". You can't undo this!</p>
|
||
<p><a href='index.php?action=delete&page=$env->page&delete=yes'>Click here to delete $env->page.</a></p>
|
||
<p><a href='index.php?action=view&page=$env->page'>Click here to go back.</a>"));
|
||
}
|
||
$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", "<p>$env->page has been deleted. <a href='index.php'>Go back to the main page</a>.</p>"));
|
||
});
|
||
|
||
// Register a help section
|
||
add_help_section("60-delete", "Deleting Pages", "<p>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.</p>
|
||
<p><strong>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).</strong></p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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 = "<p>$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 <a href='index.php?action=login&returnto=" . rawurlencode($_SERVER["REQUEST_URI"]) . "'>logging in</a>.</p>\n";
|
||
|
||
if($env->is_logged_in)
|
||
$sourceViewContent = "<p>$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.</p>\n";
|
||
|
||
if(!$settings->editing)
|
||
$sourceViewContent = "<p>$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:</p>";
|
||
|
||
if($isOtherUsersPage)
|
||
$sourceViewContent = "<p>$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.</p>";
|
||
|
||
// Append a view of the page's source
|
||
$sourceViewContent .= "<textarea name='content' readonly>$pagetext</textarea>";
|
||
|
||
exit(page_renderer::render_main("Viewing source for $env->page", $sourceViewContent));
|
||
}
|
||
else
|
||
{
|
||
$errorMessage = "<p>The page <code>$env->page</code> does not exist, but you do not have permission to create it.</p><p>If you haven't already, perhaps you should try <a href='index.php?action=login&returnto=" . rawurlencode($_SERVER["REQUEST_URI"]) . "'>logging in</a>.</p>\n";
|
||
|
||
if($isOtherUsersPage) {
|
||
$errorMessage = "<p>The page <code>" . htmlentities($env->page) . "</code> doesn't exist, but you can't create it because it's a page belonging to another user.</p>\n";
|
||
if(!$env->is_logged_in)
|
||
$errorMessage .= "<p>You could try <a href='?action=login&returnto=" . rawurlencode($_SERVER["REQUEST_URI"]) . "'>logging in</a>.</p>\n";
|
||
}
|
||
|
||
http_response_code(404);
|
||
exit(page_renderer::render_main("404 - $env->page", $errorMessage));
|
||
}
|
||
}
|
||
|
||
$content = "<h1>$title</h1>\n";
|
||
$page_tags = implode(", ", (!empty($pageindex->{$env->page}->tags)) ? $pageindex->{$env->page}->tags : []);
|
||
if(!$env->is_logged_in and $settings->anonedits)
|
||
{
|
||
$content .= "<p><strong>Warning: You are not logged in! Your IP address <em>may</em> be recorded.</strong></p>";
|
||
}
|
||
|
||
// 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 .= "<p class='preview-message'><strong>This is only a preview, so your edits haven't been saved! Scroll down to continue editing.</strong></p>" . parse_page_source($pagetext);
|
||
|
||
}
|
||
|
||
$content .= "<button class='smartsave-restore' title=\"Only works if you haven't changed the editor's content already!\">Restore Locally Saved Content</button>
|
||
<form method='post' name='edit-form' action='index.php?action=preview-edit&page=" . rawurlencode($env->page) . "' class='editform'>
|
||
<input type='hidden' name='prev-content-hash' value='" . generate_page_hash(isset($old_pagetext) ? $old_pagetext : $pagetext) . "' />
|
||
<textarea name='content' autofocus tabindex='1'>$pagetext</textarea>
|
||
<pre class='fit-text-mirror'></pre>
|
||
<input type='text' name='tags' value='" . htmlentities($page_tags, ENT_HTML5 | ENT_QUOTES) . "' placeholder='Enter some tags for the page here. Separate them with commas.' title='Enter some tags for the page here. Separate them with commas.' tabindex='2' />
|
||
<p class='editing-message'>$settings->editing_message</p>
|
||
<input name='preview-edit' class='edit-page-button' type='submit' value='Preview Changes' tabindex='4' />
|
||
<input name='submit-edit' class='edit-page-button' type='submit' value='Save Page' tabindex='3' />
|
||
</form>";
|
||
// Allow tab characters in the page editor
|
||
page_renderer::AddJSSnippet("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::AddJSSnippet('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::AddJSSnippet('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", "<p>Editing is currently disabled on this wiki.</p>"));
|
||
}
|
||
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 = "<h1>Resolving edit conflict - $env->page</h1>";
|
||
if(!$env->is_logged_in and $settings->anonedits)
|
||
{
|
||
$content .= "<p><strong>Warning: You are not logged in! Your IP address <em>may</em> be recorded.</strong></p>";
|
||
}
|
||
$content .= "<p>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.</p>
|
||
|
||
<form method='post' action='index.php?action=save&page=" . rawurlencode($env->page) . "&action=save' class='editform'>
|
||
<h2>Existing content</h2>
|
||
<textarea id='original-content' name='content' autofocus tabindex='1'>$existingPageData</textarea>
|
||
|
||
<h2>Differences</h2>
|
||
<div id='highlighted-diff' class='highlighted-diff'></div>
|
||
<!--<pre class='highlighted-diff-wrapper'><code id='highlighted-diff'></code></pre>-->
|
||
|
||
<h2>Your content</h2>
|
||
<textarea id='new-content'>$pagedata</textarea>
|
||
<input type='text' name='tags' value='" . htmlentities($_POST["tags"]) . "' placeholder='Enter some tags for the page here. Separate them with commas.' title='Enter some tags for the page here. Separate them with commas.' tabindex='2' />
|
||
<p class='editing_message'>$settings->editing_message</p>
|
||
<input name='submit-edit' type='submit' value='Resolve Conflict' tabindex='3' />
|
||
</form>";
|
||
|
||
// 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 += `<span class='${classes}'>${change.value}</span>`;
|
||
});
|
||
destination.innerHTML = output;
|
||
});
|
||
DIFFSCRIPT;
|
||
// diff.min.js is downloaded above
|
||
$content .= "\n<script src='diff.min.js'></script>
|
||
<script>$diffScript</script>\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", "<p>$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.</p>
|
||
<p>Please tell the administrator of this wiki (" . $settings->admindetails_name . ") about this problem.</p>"));
|
||
}
|
||
});
|
||
|
||
add_help_section("15-editing", "Editing", "<p>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.</p>
|
||
<p>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.</p>
|
||
<p>A reference to the syntax that $settings->sitename supports can be found below.</p>");
|
||
|
||
add_help_section("17-user-pages", "User Pages", "<p>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 <a href='?page=" . rawurlencode($settings->user_page_prefix) . "'>" . htmlentities($settings->user_page_prefix) . "</a> 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 <a href='?page=" . rawurlencode(get_user_pagename($env->user)) . "'>" . htmlentities(get_user_pagename($env->user)) . "</a>. " .
|
||
(module_exists("page-user-list") ? "You can see a list of all the users on $settings->sitename and visit their user pages on the <a href='?action=user-list'>user list</a>." : "")
|
||
. "</p>");
|
||
}
|
||
]);
|
||
/**
|
||
* 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.4",
|
||
"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. <a href='?action=$settings->defaultaction&page='>Return to the $settings->defaultpage</a>."));
|
||
}
|
||
|
||
$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);
|
||
});
|
||
|
||
// Add a section to the help page
|
||
add_help_section("50-export", "Exporting", "<p>$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.</p>
|
||
<p>To perform an export, go to the credits page and click "Export as zip - Check for permission first".</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Help page",
|
||
"version" => "0.9.3",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds a rather useful help page. Access through the 'help' action. This module also exposes help content added to Pepperminty Wiki's inbuilt invisible help section system.",
|
||
"id" => "page-help",
|
||
"code" => function() {
|
||
global $settings;
|
||
|
||
/**
|
||
* @api {get} ?action=help[&dev=yes] Get a help page
|
||
* @apiDescription Get a customised help page. This page will be slightly different for every wiki, depending on their name, settings, and installed modules.
|
||
* @apiName Help
|
||
* @apiGroup Utility
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiParam {string} dev Set to 'yes' to get a developer help page instead. The developer help page gives some general information about which modules and help page sections are registered, and other various (non-sensitive) settings.
|
||
*/
|
||
|
||
/*
|
||
* ██ ██ ███████ ██ ██████
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ███████ █████ ██ ██████
|
||
* ██ ██ ██ ██ ██
|
||
* ██ ██ ███████ ███████ ██
|
||
*/
|
||
add_action("help", function() {
|
||
global $env, $paths, $settings, $version, $help_sections, $actions;
|
||
|
||
// Sort the help sections by key
|
||
ksort($help_sections, SORT_NATURAL);
|
||
|
||
if(isset($_GET["dev"]) and $_GET["dev"] == "yes")
|
||
{
|
||
$title = "Developers Help - $settings->sitename";
|
||
$content = "<p>$settings->sitename runs on Pepperminty Wiki, an entire wiki packed into a single file. This page contains some information that developers may find useful.</p>
|
||
<p>A full guide to developing a Pepperminty Wiki module can be found <a href='//github.com/sbrl/Pepperminty-Wiki/blob/master/Module_API_Docs.md#module-api-documentation'>on GitHub</a>.</p>
|
||
<h3>Registered Help Sections</h3>
|
||
<p>The following help sections are currently registered:</p>
|
||
<table><tr><th>Index</th><th>Title</th><th>Length</th></tr>\n";
|
||
$totalSize = 0;
|
||
foreach($help_sections as $index => $section)
|
||
{
|
||
$sectionLength = strlen($section["content"]);
|
||
$totalSize += $sectionLength;
|
||
|
||
$content .= "\t\t\t<tr><td>$index</td><td>" . $section["title"] . "</td><td>" . human_filesize($sectionLength) . "</td></tr>\n";
|
||
}
|
||
$content .= "\t\t\t<tr><th colspan='2' style='text-align: right;'>Total:</th><td>" . human_filesize($totalSize) . "</td></tr>\n";
|
||
$content .= "\t\t</table>\n";
|
||
$content .= "<h3>Registered Actions</h3>";
|
||
$registeredActions = array_keys(get_object_vars($actions));
|
||
sort($registeredActions);
|
||
$content .= "<p>The following actions are currently registered:</p>\n";
|
||
$content .= "<p>" . implode(", ", $registeredActions) . "</p>";
|
||
$content .= "<h3>Environment</h3>\n";
|
||
$content .= "<ul>\n";
|
||
$content .= "<li>$settings->sitename's root directory is " . (!is_writeable(__DIR__) ? "not " : "") . "writeable.</li>\n";
|
||
$content .= "<li>The page index is currently " . human_filesize(filesize($paths->pageindex)) . " in size, and took " . $env->perfdata->pageindex_decode_time . "ms to decode.</li>";
|
||
if(module_exists("feature-search"))
|
||
{
|
||
search::measure_invindex_load_time($paths->searchindex);
|
||
$content .= "<li>The search index is currently " . human_filesize(filesize($paths->searchindex)) . " in size, and took " . $env->perfdata->searchindex_decode_time . "ms to decode.</li>";
|
||
}
|
||
|
||
$content .= "<li>The id index is currently " . human_filesize(filesize($paths->idindex)) . " in size, and took " . $env->perfdata->idindex_decode_time . "ms to decode.</li>";
|
||
|
||
$content .= "</ul>\n";
|
||
|
||
$content .= "<h3>Data</h3>\n";
|
||
|
||
$wikiSize = new stdClass();
|
||
$wikiSize->all = 0;
|
||
$wikiSize->images = 0;
|
||
$wikiSize->audio = 0;
|
||
$wikiSize->videos = 0;
|
||
$wikiSize->pages = 0;
|
||
$wikiSize->history = 0;
|
||
$wikiSize->indexes = 0;
|
||
$wikiSize->other = 0;
|
||
$wikiFiles = glob_recursive($env->storage_prefix . "*");
|
||
foreach($wikiFiles as $filename)
|
||
{
|
||
$extension = strtolower(substr($filename, strrpos($filename, ".") + 1));
|
||
if($extension === "php") continue; // Skip php files
|
||
|
||
$nextFilesize = filesize($filename);
|
||
$wikiSize->all += $nextFilesize;
|
||
if($extension[0] === "r") // It's a revision of a page
|
||
$wikiSize->history += $nextFilesize;
|
||
else if($extension == "md") // It's a page
|
||
$wikiSize->pages += $nextFilesize;
|
||
else if($extension == "json") // It's an index
|
||
$wikiSize->indexes += $nextFilesize;
|
||
else if(in_array($extension, [ // It's an uploaded image
|
||
"jpg", "jpeg", "png", "gif", "webp", "svg"
|
||
]))
|
||
$wikiSize->images += $nextFilesize;
|
||
else if(in_array($extension, [ "mp3", "ogg", "wav", "aac", "m4a" ])) // It's an audio file
|
||
$wikiSize->audio += $nextFilesize;
|
||
else if(in_array($extension, [ "avi", "mp4", "m4v", "webm" ])) // It's a video file
|
||
$wikiSize->videos += $nextFilesize;
|
||
else
|
||
$wikiSize->other += $nextFilesize;
|
||
}
|
||
|
||
$content .= "<p>$settings->sitename is currently " . human_filesize($wikiSize->all) . " in size.</p>\n";
|
||
$content .= "<div class='stacked-bar'>
|
||
<div class='stacked-bar-part' style='flex: $wikiSize->indexes; background: hsla(191, 100%, 41%, 0.6)'>Indexes: " . human_filesize($wikiSize->indexes) . "</div>
|
||
<div class='stacked-bar-part' style='flex: $wikiSize->pages; background: hsla(112, 83%, 40%, 0.6)'>Pages: " . human_filesize($wikiSize->pages) . "</div>
|
||
<div class='stacked-bar-part' style='flex: $wikiSize->history; background: hsla(116, 84%, 25%, 0.68)'>Page History: " . human_filesize($wikiSize->history) . "</div>
|
||
<div class='stacked-bar-part' style='flex: $wikiSize->images; background: hsla(266, 88%, 47%, 0.6)'>Images: " . human_filesize($wikiSize->images) . "</div>\n";
|
||
if($wikiSize->audio > 0)
|
||
$content .= "<div class='stacked-bar-part' style='flex: $wikiSize->audio; background: hsla(237, 68%, 38%, 0.64)'>Audio: " . human_filesize($wikiSize->audio) . "</div>\n";
|
||
if($wikiSize->videos > 0)
|
||
$content .= "<div class='stacked-bar-part' style='flex: $wikiSize->videos; background: hsla(338, 79%, 54%, 0.64)'>Videos: " . human_filesize($wikiSize->videos) . "</div>\n";
|
||
if($wikiSize->other > 0)
|
||
$content .= "<div class='stacked-bar-part' style='flex: $wikiSize->other; background: hsla(62, 55%, 90%, 0.6)'>Other: " . human_filesize($wikiSize->other) . "</div>\n";
|
||
$content .= "</div>";
|
||
}
|
||
else
|
||
{
|
||
$title = "Help - $settings->sitename";
|
||
|
||
$content = " <h1>$settings->sitename Help</h1>
|
||
<p>Welcome to $settings->sitename!</p>
|
||
<p>$settings->sitename is powered by Pepperminty Wiki, a complete wiki in a box you can drop into your server and expect it to just <em>work</em>.</p>";
|
||
|
||
// Todo Insert a table of contents here?
|
||
|
||
foreach($help_sections as $index => $section)
|
||
{
|
||
// Todo add a button that you can click to get a permanent link
|
||
// to this section.
|
||
$content .= "<h2 id='$index' class='help-section-header'>" . $section["title"] . "</h2>\n";
|
||
$content .= $section["content"] . "\n";
|
||
}
|
||
}
|
||
|
||
exit(page_renderer::render_main($title, $content));
|
||
});
|
||
|
||
// Register a help section on general navigation
|
||
add_help_section("5-navigation", "Navigating", "<p>All the navigation links can be found on the top bar, along with a search box (if your site administrator has enabled it). There is also a "More..." menu in the top right that contains some additional links that you may fine useful.</p>
|
||
<p>This page, along with the credits page, can be found on the bar at the bottom of every page.</p>");
|
||
|
||
add_help_section("1-extra", "Extra Information", "<p>You can find out whch version of Pepperminty Wiki $settings->sitename is using by visiting the <a href='?action=credits'>credits</a> page.</p>
|
||
<p>Information for developers can be found on <a href='?action=help&dev=yes'>this page</a>.</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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 = " <h1>$title on $settings->sitename</h1>";
|
||
|
||
$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", "<p>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", "<p>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 = "<h1>All tags</h1>
|
||
<ul class='tag-list'>\n";
|
||
foreach($all_tags as $tag)
|
||
{
|
||
$content .= " <li><a href='?action=list-tags&tag=" . rawurlencode($tag) . "' class='mini-tag'>$tag</a></li>\n";
|
||
}
|
||
$content .= "</ul>\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 = "<h1>Tag List: $tag</h1>\n";
|
||
$content .= generate_page_list($pagelist);
|
||
|
||
$content .= "<p>(<a href='?action=list-tags'>All tags</a>)</p>\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 (<a href='?page=" . rawurlencode($highest_tag_page) . "'>" . htmlentities($highest_tag_page) . "</a>)";
|
||
$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", "<p>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.</p>
|
||
<p>Each tag on either page can be clicked, and leads to a list of all pages that possess that particular tag.</p>
|
||
<p>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).</p>");
|
||
}
|
||
]);
|
||
|
||
/**
|
||
* 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 = "<ul class='page-list'>\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 .= "<a href='?action=list-tags&tag=" . rawurlencode($tag) . "' class='mini-tag'>$tag</a>, ";
|
||
}
|
||
$tags = substr($tags, 0, -2); // Remove the last ", " from the tag list
|
||
}
|
||
|
||
$pageDisplayName = $pagename;
|
||
if(isset($pageindex->$pagename) and
|
||
!empty($pageindex->$pagename->redirect))
|
||
$pageDisplayName = "<em>$pageDisplayName</em>";
|
||
|
||
$result .= "<li><a href='index.php?page=" . rawurlencode($pagename) . "'>$pageDisplayName</a>
|
||
<em class='size'>(" . human_filesize($pageindex->$pagename->size) . ")</em>
|
||
<span class='editor'><span class='texticon cursor-query' title='Last editor'>✎</span> " . $pageindex->$pagename->lasteditor . "</span>
|
||
<time class='cursor-query' title='" . date("l jS \of F Y \a\\t h:ia T", $pageindex->$pagename->lastmodified) . "'>" . human_time_since($pageindex->$pagename->lastmodified) . "</time>
|
||
<span class='tags'>$tags</span></li>";
|
||
}
|
||
$result .= " </ul>\n";
|
||
|
||
return $result;
|
||
}
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Login",
|
||
"version" => "0.9.2",
|
||
"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() {
|
||
global $settings;
|
||
|
||
/**
|
||
* @api {get} ?action=login[&failed=yes][&returnto={someUrl}] Get the login page
|
||
* @apiName Login
|
||
* @apiGroup Authorisation
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiParam {string} failed Setting to yes causes a login failure message to be displayed above the login form.
|
||
* @apiParam {string} returnto Set to the url to redirect to upon a successful login.
|
||
*/
|
||
|
||
/*
|
||
* ██ ██████ ██████ ██ ███ ██
|
||
* ██ ██ ██ ██ ██ ████ ██
|
||
* ██ ██ ██ ██ ███ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██████ ██████ ██ ██ ████
|
||
*/
|
||
add_action("login", function() {
|
||
global $settings, $env;
|
||
|
||
// Build the action url that will actually perform the login
|
||
$login_form_action_url = "index.php?action=checklogin";
|
||
if(isset($_GET["returnto"]))
|
||
$login_form_action_url .= "&returnto=" . rawurlencode($_GET["returnto"]);
|
||
|
||
if($env->is_logged_in && !empty($_GET["returnto"]))
|
||
{
|
||
http_response_code(307);
|
||
header("location: " . $_GET["returnto"]);
|
||
}
|
||
|
||
$title = "Login to $settings->sitename";
|
||
$content = "<h1>Login to $settings->sitename</h1>\n";
|
||
if(isset($_GET["failed"]))
|
||
$content .= "\t\t<p><em>Login failed.</em></p>\n";
|
||
if(isset($_GET["required"]))
|
||
$content .= "\t\t<p><em>$settings->sitename requires that you login before continuing.</em></p>\n";
|
||
$content .= "\t\t<form method='post' action='$login_form_action_url'>
|
||
<label for='user'>Username:</label>
|
||
<input type='text' name='user' id='user' autofocus />
|
||
<br />
|
||
<label for='pass'>Password:</label>
|
||
<input type='password' name='pass' id='pass' />
|
||
<br />
|
||
<input type='submit' value='Login' />
|
||
</form>\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", "<p>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.</p>
|
||
<p>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).</p>"));
|
||
}
|
||
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", "<p>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.</p>
|
||
<p>If you do not have an account yet and would like one, try contacting <a href='mailto:" . hide_email($settings->admindetails_email) . "'>$settings->admindetails_name</a>, $settings->sitename's administrator and ask them nicely to see if they can create you an account.</p>");
|
||
|
||
// 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", "<h1>Logout Successful</h1>
|
||
<p>Logout Successful. You can login again <a href='index.php?action=login'>here</a>.</p>"));
|
||
});
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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", "<p>You tried to move $env->page, but editing is disabled on this wiki.</p>
|
||
<p>If you wish to move this page, please re-enable editing on this wiki first.</p>
|
||
<p><a href='index.php?page=$env->page'>Go back to $env->page</a>.</p>
|
||
<p>Nothing has been changed.</p>"));
|
||
}
|
||
if(!$env->is_admin)
|
||
{
|
||
exit(page_renderer::render_main("Moving $env->page - Error", "<p>You tried to move $env->page, but you do not have permission to do that.</p>
|
||
<p>You should try <a href='index.php?action=login'>logging in</a> as an admin.</p>"));
|
||
}
|
||
|
||
if(!isset($_GET["new_name"]) or strlen($_GET["new_name"]) == 0)
|
||
exit(page_renderer::render_main("Moving $env->page", "<h2>Moving $env->page</h2>
|
||
<form method='get' action='index.php'>
|
||
<input type='hidden' name='action' value='move' />
|
||
<label for='old_name'>Old Name:</label>
|
||
<input type='text' name='page' value='$env->page' readonly />
|
||
<br />
|
||
<label for='new_name'>New Name:</label>
|
||
<input type='text' name='new_name' />
|
||
<br />
|
||
<input type='submit' value='Move Page' />
|
||
</form>"));
|
||
|
||
$new_name = makepathsafe($_GET["new_name"]);
|
||
|
||
$page = $env->page;
|
||
if(!isset($pageindex->$page))
|
||
exit(page_renderer::render_main("Moving $env->page - Error", "<p>You tried to move $env->page to $new_name, but the page with the name $env->page does not exist in the first place.</p>
|
||
<p>Nothing has been changed.</p>"));
|
||
|
||
if($env->page == $new_name)
|
||
exit(page_renderer::render_main("Moving $env->page - Error", "<p>You tried to move $page, but the new name you gave is the same as it's current name.</p>
|
||
<p>It is possible that you tried to use some characters in the new name that are not allowed and were removed.</p>
|
||
<p>Page names may not contain any of these characters: <code>?%*:|\"><()[]</code></p>"));
|
||
|
||
if(isset($pageindex->$page->uploadedfile) and
|
||
file_exists($new_name))
|
||
exit(page_renderer::render_main("Moving $env->page - Error - $settings->sitename", "<p>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.</p>
|
||
<p>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).</p>"));
|
||
|
||
// 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), "<p><a href='index.php?page=" . rawurlencode($env->page) . "'>" . htmlentities($env->page) . "</a> has been moved to <a href='index.php?page=" . rawurlencode($new_name) . "'>" . htmlentities($new_name) . "</a> successfully.</p>"));
|
||
});
|
||
|
||
// Register a help section
|
||
add_help_section("60-move", "Moving Pages", "<p>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".</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
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", "<p>You must be an administrator to do that.</p>"));
|
||
}
|
||
|
||
if(!isset($_GET["do"]) or $_GET["do"] !== "true" or $_GET["do"] !== "yes")
|
||
{
|
||
exit(page_renderer::render_main("Update $settings->sitename", "<p>This page allows you to update $settings->sitename.</p>
|
||
<p>Currently, $settings->sitename is using $settings->version of Pepperminty Wiki.</p>
|
||
<p>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).</p>
|
||
<p>To update $settings->sitename, fill out the form below and click click the update button.</p>
|
||
<p>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.</p>
|
||
<form method='get' action=''>
|
||
<input type='hidden' name='action' value='update' />
|
||
<input type='hidden' name='do' value='true' />
|
||
<label for='secret'>$settings->sitename's secret code</label>
|
||
<input type='text' name='secret' value='' />
|
||
<input type='submit' value='Update' />
|
||
</form>"));
|
||
}
|
||
|
||
if(!isset($_GET["secret"]) or $_GET["secret"] !== $settings->sitesecret)
|
||
{
|
||
exit(page_renderer::render_main("Update $settings->sitename - Error", "<p>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 <code>index.php</code>.</p>"));
|
||
}
|
||
|
||
$settings_separator = "/////////////// Do not edit below this line unless you know what you are doing! ///////////////";
|
||
|
||
$log = "Beginning update...\n";
|
||
|
||
$log .= "I am <code>" . __FILE__ . "</code>.\n";
|
||
$oldcode = file_get_contents(__FILE__);
|
||
$log .= "Fetching new code...";
|
||
$newcode = file_get_contents($settings->updateurl);
|
||
$log .= "done.\n";
|
||
|
||
$log .= "Rewriting <code>" . __FILE__ . "</code>...";
|
||
$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", "<ul><li>" . implode("</li><li>", explode("\n", $log)) . "</li></ul>"));
|
||
});
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "User list",
|
||
"version" => "0.1",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Adds a 'user-list' action that generates a list of users. Supports json output with 'format=json' in the queyr string.",
|
||
"id" => "page-user-list",
|
||
"code" => function() {
|
||
global $settings;
|
||
/**
|
||
* @api {get} ?action=user-list[format=json] List all users
|
||
* @apiName UserList
|
||
* @apiGroup Utility
|
||
* @apiPermission Anonymous
|
||
*/
|
||
|
||
/*
|
||
* ██ ██ ███████ ███████ ██████ ██ ██ ███████ ████████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ███████ █████ ██████ █████ ██ ██ ███████ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██████ ███████ ███████ ██ ██ ███████ ██ ███████ ██
|
||
*/
|
||
add_action("user-list", function() {
|
||
global $env, $settings;
|
||
|
||
$userList = array_keys(get_object_vars($settings->users));
|
||
if(!empty($_GET["format"]) && $_GET["format"] === "json")
|
||
{
|
||
header("content-type: application/json");
|
||
exit(json_encode($userList));
|
||
}
|
||
|
||
$content = "<h1>User List</h1>\n";
|
||
$content .= "<ul class='page-list user-list invisilist'>\n";
|
||
foreach($userList as $username)
|
||
$content .= "\t<li>" . page_renderer::render_username($username) . "</li>\n";
|
||
$content .= "</ul>\n";
|
||
|
||
exit(page_renderer::render_main("User List - $settings->sitename", $content));
|
||
});
|
||
|
||
add_help_section("800-raw-page-content", "Viewing Raw Page Content", "<p>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.</p>
|
||
<p>To use this feature, navigate to the page for which you want to see the source, and then alter the <code>action</code> parameter in the url's query string to be <code>raw</code>. If the <code>action</code> 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.</p>");
|
||
}
|
||
]);
|
||
|
||
|
||
|
||
|
||
register_module([
|
||
"name" => "Page viewer",
|
||
"version" => "0.16.7",
|
||
"author" => "Starbeamrainbowlabs",
|
||
"description" => "Allows you to view pages. You really should include this one.",
|
||
"id" => "page-view",
|
||
"code" => function() {
|
||
/**
|
||
* @api {get} ?action=view[&page={pageName}][&revision=rid][&printable=yes][&mode={mode}] View a page
|
||
* @apiName View
|
||
* @apiGroup Page
|
||
* @apiPermission Anonymous
|
||
*
|
||
* @apiUse PageParameter
|
||
* @apiParam {number} revision The revision number to display.
|
||
* @apiParam {string} mode Optional. The display mode to use. Can hold the following values: 'normal' - The default. Sends a normal page. 'printable' - Sends a printable version of the page. 'contentonly' - Sends only the content of the page, not the extra stuff around it. 'parsedsourceonly' - Sends only the raw rendered source of the page, as it appears just after it has come out of the page parser. Useful for writing external tools (see also the `raw` action).
|
||
*
|
||
* @apiError NonExistentPageError The page doesn't exist and editing is disabled in the wiki's settings. If editing isn't disabled, you will be redirected to the edit page instead.
|
||
* @apiError NonExistentRevisionError The specified revision was not found.
|
||
*/
|
||
|
||
/*
|
||
* ██ ██ ██ ███████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ █████ ██ █ ██
|
||
* ██ ██ ██ ██ ██ ███ ██
|
||
* ████ ██ ███████ ███ ███
|
||
*/
|
||
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 actually 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("404: Page not found - $env->page - $settings->sitename", "<p>$env->page does not exist.</p><p>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.</p>"));
|
||
}
|
||
}
|
||
|
||
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 .= "<h1>$env->page</h1>\n";
|
||
else
|
||
{
|
||
$content .= "<h1>Revision #{$env->history->revision_number} of $env->page</h1>\n";
|
||
$content .= "<p class='revision-note'><em>(Revision saved by {$env->history->revision_data->editor} " . render_timestamp($env->history->revision_data->timestamp) . ". <a href='?page=" . rawurlencode($env->page) . "'>Jump to the current revision</a> or see a <a href='?action=history&page=" . rawurlencode($env->page) . "'>list of all revisions</a> for this page.)</em></p>\n";
|
||
}
|
||
|
||
// Add a visit parent page link if we're a subpage
|
||
if(get_page_parent($env->page) !== false) {
|
||
$content .= "<p class='link-parent-page'><em><a href='?action=view&page=" . rawurlencode(get_page_parent($env->page)) . "'>« " . htmlentities(get_page_parent($env->page)) . "</a></em></p>\n";
|
||
}
|
||
|
||
// Add an extra message if the requester was redirected from another page
|
||
if(isset($_GET["redirected_from"]))
|
||
$content .= "<p><em>Redirected from <a href='?page=" . rawurlencode($_GET["redirected_from"]) . "&redirect=no'>" . $_GET["redirected_from"] . "</a>.</em></p>\n";
|
||
|
||
$parsing_start = microtime(true);
|
||
|
||
$rawRenderedSource = parse_page_source(file_get_contents($env->page_filename));
|
||
$content .= $rawRenderedSource;
|
||
|
||
if(!empty($pageindex->$page->tags))
|
||
{
|
||
$content .= "<ul class='page-tags-display'>\n";
|
||
foreach($pageindex->$page->tags as $tag)
|
||
{
|
||
$content .= "<li><a href='?action=list-tags&tag=" . rawurlencode($tag) . "'>$tag</a></li>\n";
|
||
}
|
||
$content .= "\n</ul>\n";
|
||
}
|
||
/*else
|
||
{
|
||
$content .= "<aside class='page-tags-display'><small><em>(No tags yet! Add some by <a href='?action=edit&page=" . rawurlencode($env->page) . "'>editing this page</a>!)</em></small></aside>\n";
|
||
}*/
|
||
|
||
if($settings->show_subpages)
|
||
{
|
||
$subpages = get_object_vars(get_subpages($pageindex, $env->page));
|
||
|
||
if(count($subpages) > 0)
|
||
{
|
||
$content .= "<hr />";
|
||
$content .= "Subpages: ";
|
||
foreach($subpages as $subpage => $times_removed)
|
||
{
|
||
if($times_removed <= $settings->subpages_display_depth)
|
||
{
|
||
$content .= "<a href='?action=view&page=" . rawurlencode($subpage) . "'>$subpage</a>, ";
|
||
}
|
||
}
|
||
// Remove the last comma from the content
|
||
$content = substr($content, 0, -2);
|
||
}
|
||
}
|
||
|
||
$content .= "\n\t\t<!-- Took " . round((microtime(true) - $parsing_start) * 1000, 2) . "ms to parse page source -->\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) . ".</p>\n<p>" . $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.12",
|
||
"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;
|
||
});
|
||
|
||
/*
|
||
* ███████ ████████ █████ ████████ ██ ███████ ████████ ██ ██████ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ███████ ██ ██ ███████ ██ ██ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ██ ██ ██ ███████ ██ ██ ██████ ███████
|
||
*/
|
||
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 = "<h2>$stats_data->name</h2>\n";
|
||
$result .= "<table class='wanted-pages'>\n";
|
||
$result .= "\t<tr><th>Page Name</th><th>Linking Pages</th></tr>\n";
|
||
foreach($stats_data->value as $pagename => $linking_pages) {
|
||
$result .= "\t<tr><td>$pagename</td><td>$linking_pages</td></tr>\n";
|
||
}
|
||
$result .= "</table>\n";
|
||
return $result;
|
||
}
|
||
]);
|
||
statistic_add([
|
||
"id" => "orphan-pages",
|
||
"name" => "Orphan Pages",
|
||
"type" => "page-list",
|
||
"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 exist
|
||
if(empty($pageindex->$linked_page)) continue;
|
||
|
||
$pages[$linked_page] = true;
|
||
}
|
||
}
|
||
|
||
$orphaned_pages = [];
|
||
foreach($pageindex as $pagename => $page_data) {
|
||
if(empty($pages[$pagename]))
|
||
$orphaned_pages[] = $pagename;
|
||
}
|
||
|
||
sort($orphaned_pages);
|
||
|
||
$result->value = $orphaned_pages;
|
||
$result->completed = true;
|
||
return $result;
|
||
}
|
||
]);
|
||
statistic_add([
|
||
"id" => "most-linked-to-pages",
|
||
"name" => "Most Linked-To 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 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) {
|
||
global $pageindex;
|
||
$result = "<h2>$stats_data->name</h2>\n";
|
||
$result .= "<table class='most-linked-to-pages'>\n";
|
||
$result .= "\t<tr><th>Page Name</th><th>Linking Pages</th></tr>\n";
|
||
foreach($stats_data->value as $pagename => $link_count) {
|
||
$pagename_display = !empty($pageindex->$pagename->redirect) && $pageindex->$pagename->redirect ? "<em>$pagename</em>" : $pagename;
|
||
$result .= "\t<tr><td><a href='?page=" . rawurlencode($pagename) . "'>$pagename_display</a></td><td>$link_count</td></tr>\n";
|
||
}
|
||
$result .= "</table>\n";
|
||
return $result;
|
||
}
|
||
]);
|
||
|
||
add_help_section("20-parser-default", "Editor Syntax",
|
||
"<p>$settings->sitename's editor uses an extended version of <a href='http://parsedown.org/'>Parsedown</a> to render pages, which is a fantastic open source Github flavoured markdown parser. You can find a quick reference guide on Github flavoured markdown <a href='https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet'>here</a> by <a href='https://github.com/adam-p/'>adam-p</a>, or if you prefer a book <a href='https://www.gitbook.com/book/roachhd/master-markdown/details'>Mastering Markdown</a> by KB is a good read, and free too!</p>
|
||
<h3>Tips</h3>
|
||
<ul>
|
||
<li>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).</li>
|
||
<li>You can add an id to a header that you can link to. Put it in curly braces after the heading name like this: <code># Heading Name {#HeadingId}</code>. Then you can link to like like this: <code>[[Page name#HeadingId}]]</code>. You can also link to a heading id on the current page by omitting the page name: <code>[[#HeadingId]]</code>.</li>
|
||
</ul>
|
||
<h3>Extra Syntax</h3>
|
||
<p>$settings->sitename's editor also supports some extra custom syntax, some of which is inspired by <a href='https://mediawiki.org/'>Mediawiki</a>.
|
||
<table>
|
||
<tr><th style='width: 40%'>Type this</th><th style='width: 20%'>To get this</th><th>Comments</th></th>
|
||
<tr><td><code>[[Internal link]]</code></td><td><a href='?page=Internal%20link'>Internal Link</a></td><td>An internal link.</td></tr>
|
||
<tr><td><code>[[Display Text|Internal link]]</code></td><td><a href='?page=Internal%20link'>Display Text</a></td><td>An internal link with some display text.</td></tr>
|
||
<tr><td><code></code></td><td><img src='http://example.com/path/to/image.png' alt='Alt text' style='float: right; max-width: 256px; max-height: 256px;' /></td><td>An image floating to the right of the page that fits inside a 256px x 256px box, preserving aspect ratio.</td></tr>
|
||
<tr><td><code></code></td><td><figure><img src='http://example.com/path/to/image.png' alt='Alt text' style='max-width: 256px; max-height: 256px;' /><figcaption>Alt text</figcaption></figure></td><td>An image with a caption that fits inside a 256px x 256px box, preserving aspect ratio. The presence of the word <code>caption</code> in the regular braces causes the alt text to be taken and displayed below the image itself.</td></tr>
|
||
<tr><td><code></code></td><td><img src='index.php?action=preview&page=Files/Cheese.png' alt='Alt text' style='' /></td><td>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.</td></tr>
|
||
</table>
|
||
<p>Note that the all image image syntax above can be mixed and matched to your liking. The <code>caption</code> option in particular must come last or next to last.</p>
|
||
<h4>Templating</h4>
|
||
<p>$settings->sitename also supports including one page in another page as a <em>template</em>. The syntax is very similar to that of Mediawiki. For example, <code>{{Announcement banner}}</code> will include the contents of the \"Announcement banner\" page, assuming it exists.</p>
|
||
<p>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. <code>{{{Announcement text}}}</code>), and set when including a page with the bar syntax (e.g. <code>{{Announcement banner | importance = high | text = Maintenance has been planned for tonight.}}</code>). Currently the only restriction in templates and variables is that you may not include a closing curly brace (<code>}</code>) in the page name, variable name, or value.</p>
|
||
<h5>Special Variables</h5>
|
||
<p>$settings->sitename also supports a number of special built-in variables. Their syntax and function are described below:</p>
|
||
<table>
|
||
<tr><th>Type this</th><th>To get this</th></tr>
|
||
<tr><td><code>{{{@}}}</code></td><td>Lists all variables and their values in a table.</td></tr>
|
||
<tr><td><code>{{{#}}}</code></td><td>Shows a 'stack trace', outlining all the parent includes of the current page being parsed.</td></tr>
|
||
<tr><td><code>{{{~}}}</code></td><td>Outputs the requested page's name.</td></tr>
|
||
<tr><td><code>{{{*}}}</code></td><td>Outputs a comma separated list of all the subpages of the current page.</td></tr>
|
||
<tr><td><code>{{{+}}}</code></td><td>Shows a gallery containing all the files that are sub pages of the current page.</td></tr>
|
||
</table>");
|
||
}
|
||
]);
|
||
|
||
/*** Parsedown versions ***
|
||
* Parsedown Core: 1.6.0 *
|
||
* Parsedown Extra: 0.7.0 *
|
||
**************************/
|
||
$env->parsedown_paths = new stdClass();
|
||
$env->parsedown_paths->parsedown = "https://cdn.rawgit.com/erusev/parsedown/3ebbd730b5c2cf5ce78bc1bf64071407fc6674b7/Parsedown.php";
|
||
$env->parsedown_paths->parsedown_extra = "https://cdn.rawgit.com/erusev/parsedown-extra/11a44e076d02ffcc4021713398a60cd73f78b6f5/ParsedownExtra.php";
|
||
|
||
// Download parsedown and parsedown extra if they don't already exist
|
||
// These must still use this old method, as the parser may be asked to render some HTML before Pepperminty Wiki has had a chance to run the downloads
|
||
if(!file_exists("./Parsedown.php") || filesize("./Parsedown.php") === 0)
|
||
file_put_contents("./Parsedown.php", fopen($env->parsedown_paths->parsedown, "r"));
|
||
if(!file_exists("./ParsedownExtra.php") || filesize("./ParsedownExtra.php") === 0)
|
||
file_put_contents("./ParsedownExtra.php", fopen($env->parsedown_paths->parsedown_extra, "r"));
|
||
|
||
require_once("./Parsedown.php");
|
||
require_once("./ParsedownExtra.php");
|
||
|
||
/*
|
||
* ██████ █████ ██████ ███████ ███████ ██████ ██████ ██ ██ ███ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ████ ██
|
||
* ██████ ███████ ██████ ███████ █████ ██ ██ ██ ██ ██ █ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ███████ ███████ ██████ ██████ ███ ███ ██ ████
|
||
*
|
||
* ███████ ██ ██ ████████ ███████ ███ ██ ███████ ██ ██████ ███ ██ ███████
|
||
* ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ████ ██ ██
|
||
* █████ ███ ██ █████ ██ ██ ██ ███████ ██ ██ ██ ██ ██ ██ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ██ ███████ ██ ████ ███████ ██ ██████ ██ ████ ███████
|
||
*/
|
||
class PeppermintParsedown extends ParsedownExtra
|
||
{
|
||
private $internalLinkBase = "./%s";
|
||
|
||
protected $maxParamDepth = 0;
|
||
protected $paramStack = [];
|
||
|
||
function __construct()
|
||
{
|
||
// Prioritise our internal link parsing over the regular link parsing
|
||
array_unshift($this->InlineTypes["["], "InternalLink");
|
||
// Prioritise our image parser over the regular image parser
|
||
array_unshift($this->InlineTypes["!"], "ExtendedImage");
|
||
|
||
$this->inlineMarkerList .= "{";
|
||
if(!isset($this->InlineTypes["{"]) or !is_array($this->InlineTypes["{"]))
|
||
$this->InlineTypes["{"] = [];
|
||
$this->InlineTypes["{"][] = "Template";
|
||
}
|
||
|
||
/*
|
||
* ████████ ███████ ███ ███ ██████ ██ █████ ████████ ██ ███ ██ ██████
|
||
* ██ ██ ████ ████ ██ ██ ██ ██ ██ ██ ██ ████ ██ ██
|
||
* ██ █████ ██ ████ ██ ██████ ██ ███████ ██ ██ ██ ██ ██ ██ ███
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ███████ ██ ██ ██ ███████ ██ ██ ██ ██ ██ ████ ██████
|
||
*/
|
||
protected function inlineTemplate($fragment)
|
||
{
|
||
global $env, $pageindex;
|
||
|
||
// Variable parsing
|
||
if(preg_match("/\{\{\{([^}]+)\}\}\}/", $fragment["text"], $matches))
|
||
{
|
||
$params = [];
|
||
if(!empty($this->paramStack))
|
||
{
|
||
$stackEntry = array_slice($this->paramStack, -1)[0];
|
||
$params = !empty($stackEntry) ? $stackEntry["params"] : false;
|
||
}
|
||
|
||
$variableKey = trim($matches[1]);
|
||
|
||
$variableValue = false;
|
||
switch ($variableKey)
|
||
{
|
||
case "@": // Lists all variables and their values
|
||
if(!empty($params)) {
|
||
$variableValue = "<table>
|
||
<tr><th>Key</th><th>Value</th></tr>\n";
|
||
foreach($params as $key => $value)
|
||
{
|
||
$variableValue .= "\t<tr><td>" . $this->escapeText($key) . "</td><td>" . $this->escapeText($value) . "</td></tr>\n";
|
||
}
|
||
$variableValue .= "</table>";
|
||
}
|
||
else {
|
||
$variableValue = "<em>(no parameters have been specified)</em>";
|
||
}
|
||
break;
|
||
case "#": // Shows a stack trace
|
||
$variableValue = "<ol start=\"0\">\n";
|
||
$variableValue .= "\t<li>$env->page</li>\n";
|
||
foreach($this->paramStack as $curStackEntry)
|
||
{
|
||
$variableValue .= "\t<li>" . $curStackEntry["pagename"] . "</li>\n";
|
||
}
|
||
$variableValue .= "</ol>\n";
|
||
break;
|
||
case "~": // Show requested page's name
|
||
if(!empty($this->paramStack))
|
||
$variableValue = $this->escapeText($env->page);
|
||
break;
|
||
case "*": // Lists subpages
|
||
$subpages = get_subpages($pageindex, $env->page);
|
||
$variableValue = [];
|
||
foreach($subpages as $pagename => $depth)
|
||
{
|
||
$variableValue[] = $pagename;
|
||
}
|
||
$variableValue = implode(", ", $variableValue);
|
||
if(strlen($variableValue) === 0)
|
||
$variableValue = "<em>(none yet!)</em>";
|
||
break;
|
||
case "+": // Shows a file gallery for subpages with files
|
||
// If the upload module isn't present, then there's no point
|
||
// in checking for uploaded files
|
||
if(!module_exists("feature-upload"))
|
||
break;
|
||
|
||
$variableValue = [];
|
||
$subpages = get_subpages($pageindex, $env->page);
|
||
foreach($subpages as $pagename => $depth)
|
||
{
|
||
// Make sure that this is an uploaded file
|
||
if(!$pageindex->$pagename->uploadedfile)
|
||
continue;
|
||
|
||
$mime_type = $pageindex->$pagename->uploadedfilemime;
|
||
|
||
$previewSize = 300;
|
||
$previewUrl = "?action=preview&size=$previewSize&page=" . rawurlencode($pagename);
|
||
|
||
$previewHtml = "";
|
||
switch(substr($mime_type, 0, strpos($mime_type, "/")))
|
||
{
|
||
case "video":
|
||
$previewHtml .= "<video src='$previewUrl' controls preload='metadata'>$pagename</video>\n";
|
||
break;
|
||
case "audio":
|
||
$previewHtml .= "<audio src='$previewUrl' controls preload='metadata'>$pagename</audio>\n";
|
||
break;
|
||
case "application":
|
||
case "image":
|
||
default:
|
||
$previewHtml .= "<img src='$previewUrl' />\n";
|
||
break;
|
||
}
|
||
$previewHtml = "<a href='?page=" . rawurlencode($pagename) . "'>$previewHtml$pagename</a>";
|
||
|
||
$variableValue[$pagename] = "<li style='min-width: $previewSize" . "px; min-height: $previewSize" . "px;'>$previewHtml</li>";
|
||
}
|
||
|
||
if(count($variableValue) === 0)
|
||
$variableValue["default"] = "<li><em>(No files found)</em></li>\n";
|
||
$variableValue = implode("\n", $variableValue);
|
||
$variableValue = "<ul class='file-gallery'>$variableValue</ul>";
|
||
break;
|
||
}
|
||
if(isset($params[$variableKey]))
|
||
{
|
||
$variableValue = $params[$variableKey];
|
||
$variableValue = $this->escapeText($variableValue);
|
||
}
|
||
|
||
if($variableValue !== false)
|
||
{
|
||
return [
|
||
"extent" => strlen($matches[0]),
|
||
"markup" => $variableValue
|
||
];
|
||
}
|
||
}
|
||
else if(preg_match("/\{\{([^}]+)\}\}/", $fragment["text"], $matches))
|
||
{
|
||
$templateElement = $this->templateHandler($matches[1]);
|
||
|
||
if(!empty($templateElement))
|
||
{
|
||
return [
|
||
"extent" => strlen($matches[0]),
|
||
"element" => $templateElement
|
||
];
|
||
}
|
||
}
|
||
}
|
||
|
||
protected function templateHandler($source)
|
||
{
|
||
global $pageindex, $env;
|
||
|
||
|
||
$parts = preg_split("/\\||¦/", trim($source, "{}"));
|
||
$parts = array_map("trim", $parts);
|
||
|
||
// Extract the name of the template page
|
||
$templatePagename = array_shift($parts);
|
||
// If the page that we are supposed to use as the tempalte doesn't
|
||
// exist, then there's no point in continuing.
|
||
if(empty($pageindex->$templatePagename))
|
||
return false;
|
||
|
||
// Parse the parameters
|
||
$this->maxParamDepth++;
|
||
$params = [];
|
||
$i = 0;
|
||
foreach($parts as $part)
|
||
{
|
||
if(strpos($part, "=") !== false)
|
||
{
|
||
// This param contains an equals sign, so it's a named parameter
|
||
$keyValuePair = explode("=", $part, 2);
|
||
$keyValuePair = array_map("trim", $keyValuePair);
|
||
$params[$keyValuePair[0]] = $keyValuePair[1];
|
||
}
|
||
else
|
||
{
|
||
// This isn't a named parameter
|
||
$params["$i"] = trim($part);
|
||
|
||
$i++;
|
||
}
|
||
}
|
||
// Add the parsed parameters to the parameter stack
|
||
$this->paramStack[] = [
|
||
"pagename" => $templatePagename,
|
||
"params" => $params
|
||
];
|
||
|
||
$templateFilePath = $env->storage_prefix . $pageindex->$templatePagename->filename;
|
||
|
||
$parsedTemplateSource = $this->text(file_get_contents($templateFilePath));
|
||
|
||
// Remove the parsed parameters from the stack
|
||
array_pop($this->paramStack);
|
||
|
||
return [
|
||
"name" => "div",
|
||
"text" => $parsedTemplateSource,
|
||
"attributes" => [
|
||
"class" => "template"
|
||
]
|
||
];
|
||
}
|
||
|
||
/*
|
||
* ██ ███ ██ ████████ ███████ ██████ ███ ██ █████ ██
|
||
* ██ ████ ██ ██ ██ ██ ██ ████ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ █████ ██████ ██ ██ ██ ███████ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ████ ██ ███████ ██ ██ ██ ████ ██ ██ ███████
|
||
*
|
||
* ██ ██ ███ ██ ██ ██ ███████
|
||
* ██ ██ ████ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ █████ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ████ ██ ██ ███████
|
||
*/
|
||
protected function inlineInternalLink($fragment)
|
||
{
|
||
global $pageindex, $env;
|
||
|
||
if(preg_match('/^\[\[([^\]]*)\]\]([^\s!?",;.()\[\]{}*=+\/]*)/u', $fragment["text"], $matches)) {
|
||
// 1: Parse parameters out
|
||
// -------------------------------
|
||
$link_page = trim($matches[1]);
|
||
$display = $link_page . trim($matches[2]);
|
||
if(strpos($matches[1], "|") !== false || strpos($matches[1], "¦") !== false)
|
||
{
|
||
// We have a bar character
|
||
$parts = preg_split("/\\||¦/", $matches[1], 2);
|
||
$link_page = trim($parts[0]); // The page to link to
|
||
$display = trim($parts[1]); // The text to display
|
||
}
|
||
|
||
|
||
// 2: Parse the hash out
|
||
// -------------------------------
|
||
$hash_code = "";
|
||
if(strpos($link_page, "#") !== false)
|
||
{
|
||
// We want to link to a subsection of a page
|
||
$hash_code = substr($link_page, strpos($link_page, "#") + 1);
|
||
$link_page = substr($link_page, 0, strpos($link_page, "#"));
|
||
|
||
// If $link_page is empty then we want to link to the current page
|
||
if(strlen($link_page) === 0)
|
||
$link_page = $env->page;
|
||
}
|
||
|
||
|
||
// 3: Page name auto-correction
|
||
// -------------------------------
|
||
$is_interwiki_link = module_exists("feature-interwiki-links") && is_interwiki_link($link_page);
|
||
if(!$is_interwiki_link && empty($pageindex->$link_page)) {
|
||
// If the page doesn't exist, check varying different
|
||
// capitalisations to see if it exists under some variant.
|
||
if(!empty($pageindex->{ucfirst($link_page)}))
|
||
$link_page = ucfirst($link_page);
|
||
else if(!empty($pageindex->{ucwords($link_page)}))
|
||
$link_page = ucwords($link_page);
|
||
}
|
||
|
||
|
||
// 4: Construct the full url
|
||
// -------------------------------
|
||
$link_url = null;
|
||
// If it's an interwiki link, then handle it as such
|
||
if($is_interwiki_link)
|
||
$link_url = interwiki_get_pagename_url($link_page);
|
||
|
||
// If it isn't (or it failed), then try it as a normal link instead
|
||
if(empty($link_url)) {
|
||
$link_url = str_replace(
|
||
"%s", rawurlencode($link_page),
|
||
$this->internalLinkBase
|
||
);
|
||
// We failed to handle it as an interwiki link, so we should
|
||
// tell everyone that
|
||
$is_interwiki_link = false;
|
||
}
|
||
|
||
if(strlen($hash_code) > 0)
|
||
$link_url .= "#$hash_code";
|
||
|
||
|
||
// 6: Result encoding
|
||
// -------------------------------
|
||
$result = [
|
||
"extent" => strlen($matches[0]),
|
||
"element" => [
|
||
"name" => "a",
|
||
"text" => $display,
|
||
"attributes" => [
|
||
"href" => $link_url
|
||
]
|
||
]
|
||
];
|
||
|
||
// Attach some useful classes based on how we handled it
|
||
$class_list = [];
|
||
// Interwiki links can never be redlinks
|
||
if(!$is_interwiki_link && empty($pageindex->{makepathsafe($link_page)}))
|
||
$class_list[] = "redlink";
|
||
if($is_interwiki_link)
|
||
$class_list[] = "interwiki_link";
|
||
|
||
$result["element"]["attributes"]["class"] = implode(" ", $class_list);
|
||
|
||
return $result;
|
||
}
|
||
}
|
||
|
||
/*
|
||
* ███████ ██ ██ ████████ ███████ ███ ██ ██████ ███████ ██████
|
||
* ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ██
|
||
* █████ ███ ██ █████ ██ ██ ██ ██ ██ █████ ██ ██
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ███████ ██ ██ ██ ███████ ██ ████ ██████ ███████ ██████
|
||
*
|
||
* ██ ███ ███ █████ ██████ ███████ ███████
|
||
* ██ ████ ████ ██ ██ ██ ██ ██
|
||
* ██ ██ ████ ██ ███████ ██ ███ █████ ███████
|
||
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
* ██ ██ ██ ██ ██ ██████ ███████ ███████
|
||
*/
|
||
protected function inlineExtendedImage($fragment)
|
||
{
|
||
global $pageindex;
|
||
|
||
if(preg_match('/^!\[(.*)\]\(([^|¦)]+)\s*(?:(?:\||¦)([^|¦)]*))?(?:(?:\||¦)([^|¦)]*))?(?:(?:\||¦)([^)]*))?\)/', $fragment["text"], $matches))
|
||
{
|
||
/*
|
||
* 0 - Everything
|
||
* 1 - Alt text
|
||
* 2 - Url
|
||
* 3 - First param (optional)
|
||
* 4 - Second param (optional)
|
||
* 5 - Third param (optional)
|
||
*/
|
||
$altText = $matches[1];
|
||
$imageUrl = trim(str_replace("&", "&", $matches[2])); // Decode & to allow it in preview urls
|
||
$param1 = empty($matches[3]) ? false : strtolower(trim($matches[3]));
|
||
$param2 = empty($matches[4]) ? false : strtolower(trim($matches[4]));
|
||
$param3 = empty($matches[5]) ? false : strtolower(trim($matches[5]));
|
||
$floatDirection = false;
|
||
$imageSize = false;
|
||
$imageCaption = false;
|
||
$shortImageUrl = false;
|
||
|
||
if($this->isFloatValue($param1))
|
||
{
|
||
// Param 1 is a valid css float: ... value
|
||
$floatDirection = $param1;
|
||
$imageSize = $this->parseSizeSpec($param2);
|
||
}
|
||
else if($this->isFloatValue($param2))
|
||
{
|
||
// Param 2 is a valid css float: ... value
|
||
$floatDirection = $param2;
|
||
$imageSize = $this->parseSizeSpec($param1);
|
||
}
|
||
else if($this->isFloatValue($param3))
|
||
{
|
||
$floatDirection = $param3;
|
||
$imageSize = $this->parseSizeSpec($param1);
|
||
}
|
||
else if($param1 === false and $param2 === false)
|
||
{
|
||
// Neither params were specified
|
||
$floatDirection = false;
|
||
$imageSize = false;
|
||
}
|
||
else
|
||
{
|
||
// Neither of them are floats, but at least one is specified
|
||
// This must mean that the first param is a size spec like
|
||
// 250x128.
|
||
$imageSize = $this->parseSizeSpec($param1);
|
||
}
|
||
|
||
if($param1 !== false && strtolower(trim($param1)) == "caption")
|
||
$imageCaption = true;
|
||
if($param2 !== false && strtolower(trim($param2)) == "caption")
|
||
$imageCaption = true;
|
||
if($param3 !== false && strtolower(trim($param3)) == "caption")
|
||
$imageCaption = true;
|
||
|
||
//echo("Image url: $imageUrl, Pageindex entry: " . var_export(isset($pageindex->$imageUrl), true) . "\n");
|
||
|
||
if(isset($pageindex->$imageUrl) and $pageindex->$imageUrl->uploadedfile)
|
||
{
|
||
// We have a short url! Expand it.
|
||
$shortImageUrl = $imageUrl;
|
||
$imageUrl = "index.php?action=preview&size=" . max($imageSize["x"], $imageSize["y"]) ."&page=" . rawurlencode($imageUrl);
|
||
}
|
||
|
||
$style = "";
|
||
if($imageSize !== false)
|
||
$style .= " max-width: " . $imageSize["x"] . "px; max-height: " . $imageSize["y"] . "px;";
|
||
if($floatDirection)
|
||
$style .= " float: $floatDirection;";
|
||
|
||
$urlExtension = pathinfo($imageUrl, PATHINFO_EXTENSION);
|
||
$urlType = system_extension_mime_type($urlExtension);
|
||
$result = [];
|
||
switch(substr($urlType, 0, strpos($urlType, "/")))
|
||
{
|
||
case "audio":
|
||
$result = [
|
||
"extent" => strlen($matches[0]),
|
||
"element" => [
|
||
"name" => "audio",
|
||
"text" => $altText,
|
||
"attributes" => [
|
||
"src" => $imageUrl,
|
||
"controls" => "controls",
|
||
"preload" => "metadata",
|
||
"style" => trim($style)
|
||
]
|
||
]
|
||
];
|
||
break;
|
||
case "video":
|
||
$result = [
|
||
"extent" => strlen($matches[0]),
|
||
"element" => [
|
||
"name" => "video",
|
||
"text" => $altText,
|
||
"attributes" => [
|
||
"src" => $imageUrl,
|
||
"controls" => "controls",
|
||
"preload" => "metadata",
|
||
"style" => trim($style)
|
||
]
|
||
]
|
||
];
|
||
break;
|
||
case "image":
|
||
default:
|
||
// If we can't work out what it is, then assume it's an image
|
||
$result = [
|
||
"extent" => strlen($matches[0]),
|
||
"element" => [
|
||
"name" => "img",
|
||
"attributes" => [
|
||
"src" => $imageUrl,
|
||
"alt" => $altText,
|
||
"title" => $altText,
|
||
"style" => trim($style)
|
||
]
|
||
]
|
||
];
|
||
break;
|
||
}
|
||
|
||
// ~ Image linker ~
|
||
|
||
$imageHref = $shortImageUrl !== false ? "?page=" . rawurlencode($shortImageUrl) : $imageUrl;
|
||
$result["element"] = [
|
||
"name" => "a",
|
||
"attributes" => [
|
||
"href" => $imageHref
|
||
],
|
||
"text" => [$result["element"]],
|
||
"handler" => "elements"
|
||
];
|
||
|
||
// ~
|
||
|
||
if($imageCaption)
|
||
{
|
||
$rawStyle = $result["element"]["text"][0]["attributes"]["style"];
|
||
$containerStyle = preg_replace('/^.*float/', "float", $rawStyle);
|
||
$mediaStyle = preg_replace('/\s*float.*;/', "", $rawStyle);
|
||
$result["element"] = [
|
||
"name" => "figure",
|
||
"attributes" => [
|
||
"style" => $containerStyle
|
||
],
|
||
"text" => [
|
||
$result["element"],
|
||
[
|
||
"name" => "figcaption",
|
||
"text" => $altText
|
||
],
|
||
],
|
||
"handler" => "elements"
|
||
];
|
||
$result["element"]["text"][0]["attributes"]["style"] = $mediaStyle;
|
||
}
|
||
return $result;
|
||
}
|
||
}
|
||
|
||
# ~
|
||
# Static Methods
|
||
# ~
|
||
|
||
public static function extract_page_names($page_text) {
|
||
global $pageindex;
|
||
preg_match_all("/\[\[([^\]]+)\]\]/", $page_text, $linked_pages);
|
||
if(count($linked_pages[1]) === 0)
|
||
return []; // No linked pages here
|
||
|
||
$result = [];
|
||
foreach($linked_pages[1] as $linked_page) {
|
||
// Strip everything after the | and the #
|
||
if(strpos($linked_page, "|") !== false)
|
||
$linked_page = substr($linked_page, 0, strpos($linked_page, "|"));
|
||
if(strpos($linked_page, "#") !== false)
|
||
$linked_page = substr($linked_page, 0, strpos($linked_page, "#"));
|
||
if(strlen($linked_page) === 0)
|
||
continue;
|
||
// Make sure we try really hard to find this page in the
|
||
// pageindex
|
||
$altered_linked_page = $linked_page;
|
||
if(!empty($pageindex->{ucfirst($linked_page)}))
|
||
$altered_linked_page = ucfirst($linked_page);
|
||
else if(!empty($pageindex->{ucwords($linked_page)}))
|
||
$altered_linked_page = ucwords($linked_page);
|
||
else // Our efforts were in vain, so reset to the original
|
||
$altered_linked_page = $linked_page;
|
||
|
||
$result[] = $altered_linked_page;
|
||
}
|
||
|
||
return $result;
|
||
}
|
||
|
||
# ~
|
||
# Utility Methods
|
||
# ~
|
||
|
||
private function isFloatValue($value)
|
||
{
|
||
return in_array(strtolower($value), [ "left", "right" ]);
|
||
}
|
||
|
||
private function parseSizeSpec($text)
|
||
{
|
||
if(strpos($text, "x") === false)
|
||
return false;
|
||
$parts = explode("x", $text, 2);
|
||
|
||
if(count($parts) != 2)
|
||
return false;
|
||
|
||
array_map("trim", $parts);
|
||
array_map("intval", $parts);
|
||
|
||
if(in_array(0, $parts))
|
||
return false;
|
||
|
||
return [
|
||
"x" => $parts[0],
|
||
"y" => $parts[1]
|
||
];
|
||
}
|
||
|
||
protected function escapeText($text)
|
||
{
|
||
return htmlentities($text, ENT_COMPAT | ENT_HTML5);
|
||
}
|
||
|
||
/**
|
||
* Sets the base url to be used for internal links. '%s' will be replaced
|
||
* with a URL encoded version of the page name.
|
||
* @param string $url The url to use when parsing internal links.
|
||
*/
|
||
public function setInternalLinkBase($url)
|
||
{
|
||
$this->internalLinkBase = $url;
|
||
}
|
||
}
|
||
|
||
|
||
|
||
// %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", "<p>No credits page detected. The credits page is a required module!</p>"));
|
||
}
|
||
|
||
// 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", "<p>There isn't a page on $settings->sitename with that name. However, you could <a href='$url'>search for this page name</a> in other pages.</p>
|
||
<p>Alternatively, you could <a href='?action=edit&page=" . rawurlencode($env->page) . "&create=true'>create this page</a>.</p>"));
|
||
}
|
||
|
||
//////////////////////////////////
|
||
|
||
|
||
// 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", "<p>No action called " . strtolower($_GET["action"]) ." has been registered. Perhaps you are missing a module?</p>"));
|
||
}
|
||
|
||
?>
|