diff --git a/.gitignore b/.gitignore
index c46d453..03d07bf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -19,6 +19,8 @@ idindex.json
invindex.json
# The recent changes list
recent-changes.json
+# The new settings file
+peppermint.json
# The automatically downloaded parsedown files
Parsedown.php
diff --git a/build/index.php b/build/index.php
index bf5d21b..da6b40e 100644
--- a/build/index.php
+++ b/build/index.php
@@ -1,305 +1,305 @@
- * Rendering: MathJax (https://www.mathjax.org/)
- * Bug reports:
- * #2 - Incorrect closing tag - nibreh
- * #8 - Rogue tag - 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": "text", "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},
- "footer_message": {"type": "text", "description": "A message that will appear at the bottom of every page. May contain HTML.", "default": "All content is under this license. Please make sure that you read and understand the license, especially if you are thinking about copying some (or all) of this site's content, as it may restrict you from doing so."},
- "editing_message": {"type": "text", "description": "A message that will appear just before the submit button on the editing page. May contain HTML.", "default": "Formatting help (Markdown Cheatsheet) \nBy submitting your edit or uploading your file, you are agreeing to release your changes under this license. Also note that if you don't want your work to be edited by other users of this site, please don't submit it here!"},
- "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"},
- "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": "map", "description": "An array of usernames and passwords - passwords should be hashed with sha256 (or sha3 if you have that option turned on)", "default": {
- "admin": "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8",
- "user": "873ac9ffea4dd04fa719e8920cd6938f0c23cd678af330939cff53c3d2855f34"
- }},
- "admins": {"type": "array", "description": "An array of usernames that are administrators. Administrators can delete and move pages.", "default": [ "admin" ]},
- "use_sha3": {"type": "checkbox", "description": "Whether to use the new sha3 hashing algorithm for passwords etc.", "default": false},
- "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": "array", "description": "
An array of links and display text to display at the top of the site. Format: \"Display Text\": \"Link\"
You can also use strings here and they will be printed as-is, except the following special strings:
user-status - Expands to the user's login information. e.g. \"Logged in as {name}. | Logout\", or e.g. \"Browsing as Anonymous. | Login\".
search - Expands to a search box.
divider - Expands to a divider to separate stuff.
more - Expands to the \"More...\" submenu.
", "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": "array", "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"
- ],
- [
- "Recent changes",
- "?action=recent-changes"
- ],
- [
- "🡅 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}"
- ]
- ]},
- "nav_links_bottom": {"type": "text", "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&printable=yes&page={page}"
- ],
- [
- "Credits",
- "index.php?action=credits"
- ],
- [
- "Help",
- "index.php?action=help"
- ]
- ]},
- "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},
- "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": 200},
- "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},
- "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},
- "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},
- "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"},
- "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 a url - urls will be referenced via a <link rel='stylesheet' /> tag.", "default": "auto"}
-}
-GUICONFIG;
-
-$guiConfig = json_decode($guiConfig);
-$settings = new stdClass();
-if(!file_exists("peppermint.json"))
-{
- // 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(openssl_random_pseudo_bytes(16));
- file_put_contents("peppermint.json", json_encode($settings, JSON_PRETTY_PRINT));
-}
-else
- $settings = json_decode(file_get_contents("peppermint.json"));
-
-if($settings->css === "auto")
-{
- $settings->css = << 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; }
-.nav-more label { cursor: pointer; }
-.nav-more-menu { display: none; 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 { 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; }
-
-figure:not(.preview) { display: inline-block; }
-figure:not(.preview) > :first-child { display: block; }
-figcaption { text-align: center; }
-
-.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) { padding: 2rem 2rem 0.5rem 2rem; 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.redlink:link { color: rgb(230, 7, 7); }
-a.redlink:visited { color: rgb(130, 15, 15); #8b1a1a }
-
-.search-result { position: relative; }
-.search-result::before { content: attr(data-result-number); position: relative; top: 3.2rem; 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: 2rem; }
-
-label:not(.link-display-label) { display: inline-block; min-width: 7rem; }
-input[type=text]:not(.link-display), input[type=password], textarea { margin: 0.5rem 0; }
-input[type=text], input[type=password], textarea, #search-box { padding: 0.5rem 0.8rem; background: #d5cbf9; border: 0; border-radius: 0.3rem; font-size: 1rem; color: #442772; }
-textarea { min-height: 35rem; line-height: 1.3em; font-size: 1.25rem; }
-textarea, 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; }
-
-.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: #D2C3DD; 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 #D2C3DD; }
-
-.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: #d2c3dd; 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; }
-
-.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; }
-.upload::before { content: "\\1f845"; margin: 0 0.1em 0 -1.1em; }
-
-footer { padding: 2rem; }
-/* #ffdb6d #36962c */
-THEMECSS;
-}
-
-/*** Notes ***
-Actions:
- view - view a page
- page - page name
- printable=[yes/no] - make output printable
- edit - open editor for page
- page - page name
- save - save edits to page
- page - page name
- list - list pages
- category - the category to list [optional] [unimplemented]
- login - login to the site
- logout - logout
- checklogin - check login credentials and set cookie
- hash - hash a string with sha256
- string - string to hash
- help - get help
- update - update the wiki
- do - set to `true` to actually update the wiki
- secret - set to the value of the site's secret
- credits - view the credits
- delete - delete a page
- page - page name
- delete=yes - actually do the deletion (otherwise we display a prompt)
- *************/
-
+
+/*
+ * 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
+ * Rendering: MathJax (https://www.mathjax.org/)
+ * Bug reports:
+ * #2 - Incorrect closing tag - nibreh
+ * #8 - Rogue tag - 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": "text", "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},
+ "footer_message": {"type": "text", "description": "A message that will appear at the bottom of every page. May contain HTML.", "default": "All content is under this license. Please make sure that you read and understand the license, especially if you are thinking about copying some (or all) of this site's content, as it may restrict you from doing so."},
+ "editing_message": {"type": "text", "description": "A message that will appear just before the submit button on the editing page. May contain HTML.", "default": "Formatting help (Markdown Cheatsheet) \nBy submitting your edit or uploading your file, you are agreeing to release your changes under this license. Also note that if you don't want your work to be edited by other users of this site, please don't submit it here!"},
+ "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"},
+ "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": "map", "description": "An array of usernames and passwords - passwords should be hashed with sha256 (or sha3 if you have that option turned on)", "default": {
+ "admin": "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8",
+ "user": "873ac9ffea4dd04fa719e8920cd6938f0c23cd678af330939cff53c3d2855f34"
+ }},
+ "admins": {"type": "array", "description": "An array of usernames that are administrators. Administrators can delete and move pages.", "default": [ "admin" ]},
+ "use_sha3": {"type": "checkbox", "description": "Whether to use the new sha3 hashing algorithm for passwords etc.", "default": false},
+ "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": "array", "description": "
An array of links and display text to display at the top of the site. Format: \"Display Text\": \"Link\"
You can also use strings here and they will be printed as-is, except the following special strings:
user-status - Expands to the user's login information. e.g. \"Logged in as {name}. | Logout\", or e.g. \"Browsing as Anonymous. | Login\".
search - Expands to a search box.
divider - Expands to a divider to separate stuff.
more - Expands to the \"More...\" submenu.
", "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": "array", "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"
+ ],
+ [
+ "Recent changes",
+ "?action=recent-changes"
+ ],
+ [
+ "🡅 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}"
+ ]
+ ]},
+ "nav_links_bottom": {"type": "text", "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&printable=yes&page={page}"
+ ],
+ [
+ "Credits",
+ "index.php?action=credits"
+ ],
+ [
+ "Help",
+ "index.php?action=help"
+ ]
+ ]},
+ "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},
+ "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": 200},
+ "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},
+ "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},
+ "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},
+ "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"},
+ "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 a url - urls will be referenced via a <link rel='stylesheet' /> tag.", "default": "auto"}
+}
+GUICONFIG;
+
+$guiConfig = json_decode($guiConfig);
+$settings = new stdClass();
+if(!file_exists("peppermint.json"))
+{
+ // 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(openssl_random_pseudo_bytes(16));
+ file_put_contents("peppermint.json", json_encode($settings, JSON_PRETTY_PRINT));
+}
+else
+ $settings = json_decode(file_get_contents("peppermint.json"));
+
+if($settings->css === "auto")
+{
+ $settings->css = << 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; }
+.nav-more label { cursor: pointer; }
+.nav-more-menu { display: none; 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 { 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; }
+
+figure:not(.preview) { display: inline-block; }
+figure:not(.preview) > :first-child { display: block; }
+figcaption { text-align: center; }
+
+.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) { padding: 2rem 2rem 0.5rem 2rem; 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.redlink:link { color: rgb(230, 7, 7); }
+a.redlink:visited { color: rgb(130, 15, 15); #8b1a1a }
+
+.search-result { position: relative; }
+.search-result::before { content: attr(data-result-number); position: relative; top: 3.2rem; 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: 2rem; }
+
+label:not(.link-display-label) { display: inline-block; min-width: 7rem; }
+input[type=text]:not(.link-display), input[type=password], textarea { margin: 0.5rem 0; }
+input[type=text], input[type=password], textarea, #search-box { padding: 0.5rem 0.8rem; background: #d5cbf9; border: 0; border-radius: 0.3rem; font-size: 1rem; color: #442772; }
+textarea { min-height: 35rem; line-height: 1.3em; font-size: 1.25rem; }
+textarea, 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; }
+
+.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: #D2C3DD; 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 #D2C3DD; }
+
+.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: #d2c3dd; 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; }
+
+.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; }
+.upload::before { content: "\\1f845"; margin: 0 0.1em 0 -1.1em; }
+
+footer { padding: 2rem; }
+/* #ffdb6d #36962c */
+THEMECSS;
+}
+
+/*** Notes ***
+Actions:
+ view - view a page
+ page - page name
+ printable=[yes/no] - make output printable
+ edit - open editor for page
+ page - page name
+ save - save edits to page
+ page - page name
+ list - list pages
+ category - the category to list [optional] [unimplemented]
+ login - login to the site
+ logout - logout
+ checklogin - check login credentials and set cookie
+ hash - hash a string with sha256
+ string - string to hash
+ help - get help
+ update - update the wiki
+ do - set to `true` to actually update the wiki
+ secret - set to the value of the site's secret
+ credits - view the credits
+ delete - delete a page
+ page - page name
+ delete=yes - actually do the deletion (otherwise we display a prompt)
+ *************/
+
///////////////////////////////////////////////////////////////////////////////////////////////
@@ -350,7 +350,7 @@ else
{
$env->user = $_SESSION[$settings->sessionprefix . "-user"];
$env->pass = $_SESSION[$settings->sessionprefix . "-pass"];
- if($settings->users[$env->user] == $env->pass)
+ if($settings->users->{$env->user} == $env->pass)
{
// The user is logged in
$env->is_logged_in = true;
@@ -1226,7 +1226,7 @@ class page_renderer
if($env->is_logged_in)
{
$result .= "" . self::render_username($env->user) . " (Logout)";
- $result .= page_renderer::$nav_divider;
+ //$result .= page_renderer::$nav_divider;
}
else
$result .= "Login";
@@ -1479,109 +1479,109 @@ register_module([
+
+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, "
You are not allowed to protect pages because you are not logged in as a mod or admin. Please try logging out if you are logged in and then try logging in as an administrator.
"));
+ }
+ });
+ }
+]);
+
+
-register_module([
- "name" => "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, "
You are not allowed to protect pages because you are not logged in as a mod or admin. Please try logging out if you are logged in and then try logging in as an administrator.
"));
- }
- });
- }
-]);
-
-
-
-
-register_module([
- "name" => "Raw page source",
- "version" => "0.6",
- "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 $env;
-
- header("x-filename: " . rawurlencode($env->page) . ".md");
- header("content-type: text/markdown");
- exit(file_get_contents("$env->storage_prefix$env->page.md"));
- exit();
- });
-
- add_help_section("800-raw-page-content", "Viewing Raw Page Content", "
Although you can use the edit page to view a page's source, you can also ask $settings->sitename to send you the raw page source and nothing else. This feature is intented for those who want to automate their interaction with $settings->sitename.
-
To use this feature, navigate to the page for which you want to see the source, and then alter the action parameter in the url's query string to be raw. If the action parameter doesn't exist, add it. Note that when used on an file's page this action will return the source of the description and not the file itself.
");
- }
-]);
-
-
+
+register_module([
+ "name" => "Raw page source",
+ "version" => "0.6",
+ "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 $env;
+
+ header("x-filename: " . rawurlencode($env->page) . ".md");
+ header("content-type: text/markdown");
+ exit(file_get_contents("$env->storage_prefix$env->page.md"));
+ exit();
+ });
+
+ add_help_section("800-raw-page-content", "Viewing Raw Page Content", "
Although you can use the edit page to view a page's source, you can also ask $settings->sitename to send you the raw page source and nothing else. This feature is intented for those who want to automate their interaction with $settings->sitename.
+
To use this feature, navigate to the page for which you want to see the source, and then alter the action parameter in the url's query string to be raw. If the action parameter doesn't exist, add it. Note that when used on an file's page this action will return the source of the description and not the file itself.
The recent changes 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.
+
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 currently 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.
");
+ }
+]);
+
+/**
+ * Adds a new recent change to the recent changes file.
+ * @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, -$settings->max_recent_changes);
+
+ // Save the recent changes file back to disk
+ file_put_contents($paths->recentchanges, json_encode($recentchanges, JSON_PRETTY_PRINT));
+}
+
+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 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)
+ {
+ // 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 = "
The recent changes 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.
-
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 currently 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.
");
- }
-]);
-
-/**
- * Adds a new recent change to the recent changes file.
- * @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, -$settings->max_recent_changes);
-
- // Save the recent changes file back to disk
- file_put_contents($paths->recentchanges, json_encode($recentchanges, JSON_PRETTY_PRINT));
-}
-
-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 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)
- {
- // 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 = "
\n";
-
- return $result;
-}
-
-
-
-
-register_module([
- "name" => "Redirect pages",
- "version" => "0.3",
- "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(function(&$index_entry, &$pagedata) {
- $matches = [];
- if(preg_match("/^# ?REDIRECT ?\[\[([^\]]+)\]\]/i", $pagedata, $matches) === 1)
- {
- //error_log("matches: " . var_export($matches, true));
- // We have found a redirect page!
- // Update the metadata to reflect this.
- $index_entry->redirect = true;
- $index_entry->redirect_target = $matches[1];
- }
- else
- {
- // This page isn't a redirect. Unset the metadata just in case.
- if(isset($index_entry->redirect))
- unset($index_entry->redirect);
- if(isset($index_entry->redirect_target))
- unset($index_entry->redirect_target);
- }
- });
-
- // Register a help section
- add_help_section("25-redirect", "Redirect Pages", "
$settings->sitename supports redirect pages. To create a redirect page, enter something like # REDIRECT [[pagename]] on the first line of the redirect page's content. This must 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).
");
- }
-]);
-
-
-
-
-register_module([
- "name" => "Search",
- "version" => "0.2.1",
- "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() {
- /**
- * @api {get} ?action=index&page={pageName} Get an index of words for a given page
- * @apiName SearchIndex
- * @apiGroup Search
- * @apiPermission Anonymous
- *
- * @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);
-
- var_dump($env->page);
- var_dump($source);
-
- var_dump($index);
- });
-
- /**
- * @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 Anonymous
- */
-
- /*
- * ██ ███ ██ ██ ██ ██ ███ ██ ██████ ███████ ██ ██
- * ██ ████ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ██
- * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ █████ ███ █████
- * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
- * ██ ██ ████ ████ ██ ██ ████ ██████ ███████ ██ ██
- *
- * ██████ ███████ ██████ ██ ██ ██ ██ ██████
- * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
- * ██████ █████ ██████ ██ ██ ██ ██ ██ ██
- * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
- * ██ ██ ███████ ██████ ██████ ██ ███████ ██████
- */
- add_action("invindex-rebuild", function() {
- search::rebuild_invindex();
- });
-
- /**
- * @api {get} ?action=search&query={text} Search the wiki for a given query string
- * @apiName Search
- * @apiGroup Search
- * @apiPermission Anonymous
- *
- * @apiParam {string} query The query string to search for.
- */
-
- /*
- * ███████ ███████ █████ ██████ ██████ ██ ██
- * ██ ██ ██ ██ ██ ██ ██ ██ ██
- * ███████ █████ ███████ ██████ ██ ███████
- * ██ ██ ██ ██ ██ ██ ██ ██ ██
- * ███████ ███████ ██ ██ ██ ██ ██████ ██ ██
- */
- 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();
-
- if(!isset($_GET["query"]))
- exit(page_renderer::render("No Search Terms - Error - $settings->sitename", "
You didn't specify any search terms. Try typing some into the box above.
There's a page on $settings->sitename called $query.
";
- }
- 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 logging in.";
- }
- }
- else
- {
- $content .= "can create it.
";
- }
- }
-
- $i = 0; // todo use $_GET["offset"] and $_GET["result-count"] or something
- foreach($results as $result)
- {
- $link = "?page=" . rawurlencode($result["pagename"]);
- $pagesource = file_get_contents($env->storage_prefix . $result["pagename"] . ".md");
- $context = search::extract_context($_GET["query"], $pagesource);
- $context = search::highlight_context($_GET["query"], $context);
- /*if(strlen($context) == 0)
- {
- $context = search::strip_markup(file_get_contents("$env->page.md", null, null, null, $settings->search_characters_context * 2));
- if($pageindex->{$env->page}->size > $settings->search_characters_context * 2)
- $context .= "...";
- }*/
-
-
- // We add 1 to $i here to convert it from an index to a result
- // number as people expect it to start from 1
- $content .= "
\n";
-
- $i++;
- }
-
- $content .= "\n";
-
- exit(page_renderer::render($title, $content));
-
- //header("content-type: text/plain");
- //var_dump($results);
- });
- }
-]);
-
-class search
-{
- // Words that we should exclude from the inverted index.
- public static $stop_words = [
- "a", "about", "above", "above", "across", "after", "afterwards", "again",
- "against", "all", "almost", "alone", "along", "already", "also",
- "although", "always", "am", "among", "amongst", "amoungst", "amount",
- "an", "and", "another", "any", "anyhow", "anyone", "anything", "anyway",
- "anywhere", "are", "around", "as", "at", "back", "be", "became",
- "because", "become", "becomes", "becoming", "been", "before",
- "beforehand", "behind", "being", "below", "beside", "besides",
- "between", "beyond", "bill", "both", "bottom", "but", "by", "call",
- "can", "cannot", "cant", "co", "con", "could", "couldnt", "cry", "de",
- "describe", "detail", "do", "done", "down", "due", "during", "each",
- "eg", "eight", "either", "eleven", "else", "elsewhere", "empty",
- "enough", "etc", "even", "ever", "every", "everyone", "everything",
- "everywhere", "except", "few", "fifteen", "fify", "fill", "find",
- "fire", "first", "five", "for", "former", "formerly", "forty", "found",
- "four", "from", "front", "full", "further", "get", "give", "go", "had",
- "has", "hasnt", "have", "he", "hence", "her", "here", "hereafter",
- "hereby", "herein", "hereupon", "hers", "herself", "him", "himself",
- "his", "how", "however", "hundred", "ie", "if", "in", "inc", "indeed",
- "interest", "into", "is", "it", "its", "itself", "keep", "last",
- "latter", "latterly", "least", "less", "ltd", "made", "many", "may",
- "me", "meanwhile", "might", "mine", "more", "moreover", "most",
- "mostly", "move", "much", "must", "my", "myself", "name", "namely",
- "neither", "never", "nevertheless", "next", "nine", "no", "none",
- "nor", "not", "nothing", "now", "nowhere", "of", "off", "often", "on",
- "once", "one", "only", "onto", "or", "other", "others", "otherwise",
- "our", "ours", "ourselves", "out", "over", "own", "part", "per",
- "perhaps", "please", "put", "rather", "re", "same", "see", "seem",
- "seemed", "seeming", "seems", "serious", "several", "she", "should",
- "show", "side", "since", "sincere", "six", "sixty", "so", "some",
- "somehow", "someone", "something", "sometime", "sometimes",
- "somewhere", "still", "such", "system", "take", "ten", "than", "that",
- "the", "their", "them", "themselves", "then", "thence", "there",
- "thereafter", "thereby", "therefore", "therein", "thereupon", "these",
- "they", "thickv", "thin", "third", "this", "those", "though", "three",
- "through", "throughout", "thru", "thus", "to", "together", "too", "top",
- "toward", "towards", "twelve", "twenty", "two", "un", "under", "until",
- "up", "upon", "us", "very", "via", "was", "we", "well", "were", "what",
- "whatever", "when", "whence", "whenever", "where", "whereafter",
- "whereas", "whereby", "wherein", "whereupon", "wherever", "whether",
- "which", "while", "whither", "who", "whoever", "whole", "whom", "whose",
- "why", "will", "with", "within", "without", "would", "yet", "you",
- "your", "yours", "yourself", "yourselves"
- ];
-
- public static function index($source)
- {
- $source = html_entity_decode($source, ENT_QUOTES);
- $source_length = strlen($source);
-
- $index = [];
-
- $terms = self::tokenize($source);
- $i = 0;
- foreach($terms as $term)
- {
- $nterm = $term;
-
- // Skip over stop words (see https://en.wikipedia.org/wiki/Stop_words)
- if(in_array($nterm, self::$stop_words)) continue;
-
- if(!isset($index[$nterm]))
- {
- $index[$nterm] = [ "freq" => 0, "offsets" => [] ];
- }
-
- $index[$nterm]["freq"]++;
- $index[$nterm]["offsets"][] = $i;
-
- $i++;
- }
-
- return $index;
- }
-
- public static function tokenize($source)
- {
- $source = strtolower($source);
- return preg_split("/((^\p{P}+)|(\p{P}*\s+\p{P}*)|(\p{P}+$))|\|/", $source, -1, PREG_SPLIT_NO_EMPTY);
- }
-
- public static function strip_markup($source)
- {
- return str_replace([ "[", "]", "\"", "*", "_", " - ", "`" ], "", $source);
- }
-
- public static function rebuild_invindex()
- {
- global $pageindex, $env, $paths;
-
- $invindex = [];
- foreach($pageindex as $pagename => $pagedetails)
- {
- $pagesource = file_get_contents("$env->storage_prefix$pagename.md");
- $index = self::index($pagesource);
-
- self::merge_into_invindex($invindex, ids::getid($pagename), $index);
- }
-
- self::save_invindex($paths->searchindex, $invindex);
- }
-
- /*
- * @summary Sorts an index alphabetically. Will also sort an inverted index.
- * This allows us to do a binary search instead of a regular
- * sequential search.
- */
- public static function sort_index(&$index)
- {
- ksort($index, SORT_NATURAL);
- }
-
- /*
- * @summary Compares two *regular* indexes to find the differences between them.
- *
- * @param {array} $indexa - The old index.
- * @param {array} $indexb - The new index.
- * @param {array} $changed - An array to be filled with the nterms of all
- * the changed entries.
- * @param {array} $removed - An array to be filled with the nterms of all
- * the removed entries.
- */
- public static function compare_indexes($oldindex, $newindex, &$changed, &$removed)
- {
- foreach($oldindex as $nterm => $entry)
- {
- if(!isset($newindex[$nterm]))
- $removed[] = $nterm;
- }
- foreach($newindex as $nterm => $entry)
- {
- if(!isset($oldindex[$nterm]) or // If this world is new
- $newindex[$nterm] !== $oldindex[$nterm]) // If this word has changed
- $changed[$nterm] = $newindex[$nterm];
- }
- }
-
- /*
- * @summary Reads in and parses an inverted index.
- */
- // Todo remove this function and make everything streamable
- public static function load_invindex($invindex_filename) {
- $invindex = json_decode(file_get_contents($invindex_filename), true);
- return $invindex;
- }
-
- /*
- * @summary Merge an index into an inverted index.
- */
- public static function merge_into_invindex(&$invindex, $pageid, &$index, &$removals = [])
- {
- // Remove all the subentries that were removed since last time
- foreach($removals as $nterm)
- {
- unset($invindex[$nterm][$pageid]);
- }
-
- // Merge all the new / changed index entries into the inverted index
- foreach($index as $nterm => $newentry)
- {
- // If the nterm isn't in the inverted index, then create a space for it
- if(!isset($invindex[$nterm])) $invindex[$nterm] = [];
- $invindex[$nterm][$pageid] = $newentry;
-
- // Sort the page entries for this word by frequency
- uasort($invindex[$nterm], function($a, $b) {
- if($a["freq"] == $b["freq"]) return 0;
- return ($a["freq"] < $b["freq"]) ? +1 : -1;
- });
- }
-
- // Sort the inverted index by rank
- uasort($invindex, function($a, $b) {
- $ac = count($a); $bc = count($b);
- if($ac == $bc) return 0;
- return ($ac < $bc) ? +1 : -1;
- });
- }
-
- /**
- * 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]);
- }
- }
-
- public static function save_invindex($filename, &$invindex)
- {
- file_put_contents($filename, json_encode($invindex));
- }
-
- public static function query_invindex($query, &$invindex)
- {
- global $settings, $pageindex;
-
- $query_terms = self::tokenize($query);
- $matching_pages = [];
-
-
- // Loop over each term in the query and find the matching page entries
- $count = count($query_terms);
- for($i = 0; $i < $count; $i++)
- {
- $qterm = $query_terms[$i];
-
- // Only search the inverted index if it actually exists there
- if(isset($invindex[$qterm]))
- {
- // Loop over each page in the inverted index entry
- foreach($invindex[$qterm] as $pageid => $page_entry)
- {
- // Create an entry in the matching pages array if it doesn't exist
- if(!isset($matching_pages[$pageid]))
- $matching_pages[$pageid] = [ "nterms" => [] ];
- $matching_pages[$pageid]["nterms"][$qterm] = $page_entry;
- }
- }
-
-
- // Loop over the pageindex and search the titles / tags
- foreach ($pageindex as $pagename => $pagedata)
- {
- // Get the current page's id
- $pageid = ids::getid($pagename);
- // Consider matches in the page title
- if(stripos($pagename, $qterm) !== false)
- {
- // We found the qterm in the title
- if(!isset($matching_pages[$pageid]))
- $matching_pages[$pageid] = [ "nterms" => [] ];
-
- // Set up a counter for page title matches if it doesn't exist already
- if(!isset($matching_pages[$pageid]["title-matches"]))
- $matching_pages[$pageid]["title-matches"] = 0;
-
- $matching_pages[$pageid]["title-matches"] += count(mb_stripos_all($pagename, $qterm));
- }
-
- // Consider matches in the page's tags
- if(isset($pagedata->tags) and // If this page has tags
- stripos(implode(" ", $pagedata->tags), $qterm) !== false) // And we found the qterm in the tags
- {
- if(!isset($matching_pages[$pageid]))
- $matching_pages[$pageid] = [ "nterms" => [] ];
-
- // Set up a counter for tag match if there isn't one already
- if(!isset($matching_pages[$pageid]["tag-matches"]))
- $matching_pages[$pageid]["tag-matches"] = 0;
- $matching_pages[$pageid]["tag-matches"] += count(mb_stripos_all(implode(" ", $pagedata->tags), $qterm));
- }
- }
- }
-
-
- foreach($matching_pages as $pageid => &$pagedata)
- {
- $pagedata["pagename"] = ids::getpagename($pageid);
- $pagedata["rank"] = 0;
-
- foreach($pagedata["nterms"] as $pterm => $entry)
- {
- $pagedata["rank"] += $entry["freq"];
-
- // todo rank by context here
- }
-
- // Consider matches in the title / tags
- if(isset($pagedata["title-matches"]))
- $pagedata["rank"] += $pagedata["title-matches"] * $settings->search_title_matches_weighting;
- if(isset($pagedata["tag-matches"]))
- $pagedata["rank"] += $pagedata["tag-matches"] * $settings->search_tags_matches_weighting;
-
- // todo remove items if the rank is below a threshold
- }
-
- // todo sort by rank here
- uasort($matching_pages, function($a, $b) {
- if($a["rank"] == $b["rank"]) return 0;
- return ($a["rank"] < $b["rank"]) ? +1 : -1;
- });
-
- return $matching_pages;
- }
-
- public static function extract_context($query, $source)
- {
- global $settings;
-
- $nterms = self::tokenize($query);
- $matches = [];
- // Loop over each nterm and find it in the source
- foreach($nterms as $nterm)
- {
- $all_offsets = mb_stripos_all($source, $nterm);
- // Skip over adding matches if there aren't any
- if($all_offsets === false)
- continue;
- foreach($all_offsets as $offset)
- {
- $matches[] = [ $nterm, $offset ];
- }
- }
-
- usort($matches, function($a, $b) {
- if($a[1] == $b[1]) return 0;
- return ($a[1] < $b[1]) ? +1 : -1;
- });
-
- $contexts = [];
- $basepos = 0;
- $matches_count = count($matches);
- while($basepos < $matches_count)
- {
- // Store the next match along - all others will be relative to that
- // one
- $group = [$matches[$basepos]];
-
- // Start scanning at the next one along - we always store the first match
- $scanpos = $basepos + 1;
- $distance = 0;
-
- while(true)
- {
- // Break out if we reach the end
- if($scanpos >= $matches_count) break;
-
- // Find the distance between the current one and the last one
- $distance = $matches[$scanpos][1] - $matches[$scanpos - 1][1];
-
- // Store it if the distance is below the threshold
- if($distance < $settings->search_characters_context)
- $group[] = $matches[$scanpos];
- else
- break;
-
- $scanpos++;
- }
-
- $context_start = $group[0][1] - $settings->search_characters_context;
- $context_end = $group[count($group) - 1][1] + $settings->search_characters_context;
-
- $context = substr($source, $context_start, $context_end - $context_start);
-
- // Strip the markdown from the context - it's most likely going to
- // be broken anyway.
- $context = self::strip_markup($context);
-
- $contexts[] = $context;
-
- $basepos = $scanpos + 1;
- }
-
- return implode(" ... ", $contexts);
- }
-
- public static function highlight_context($query, $context)
- {
- $qterms = self::tokenize($query);
-
- foreach($qterms as $qterm)
- {
- // From http://stackoverflow.com/a/2483859/1460422
- $context = preg_replace("/" . str_replace("/", "\/", preg_quote($qterm)) . "/i", "$0", $context);
- }
-
- return $context;
- }
-}
-
-
-
-
-register_module([
- "name" => "Uploader",
- "version" => "0.5.6",
- "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 Get a page to let you upload a file.
- * @apiName UploadFilePage
- * @apiGroup Upload
- * @apiPermission User
- */
-
- /**
- * @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.
- *
- * @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;
-
- switch($_SERVER["REQUEST_METHOD"])
- {
- case "GET":
- // Send upload page
-
- if(!$settings->upload_enabled)
- exit(page_renderer::render("Upload Disabled - $setting->sitename", "
You can't upload anything at the moment because $settings->sitename has uploads disabled. Try contacting $settings->admindetails_name, your site Administrator. Go back.
Select an image below, and then type a name for it in the box. This server currently supports uploads up to " . human_filesize(get_max_upload_size()) . " in size.
-
$settings->sitename currently supports uploading of the following file types: " . implode(", ", $settings->upload_allowed_file_types) . ".
Your upload couldn't be processed because uploads are currently disabled on $settings->sitename. Go back to the main page.
"));
- }
-
- // Make sure that the user is logged in
- if(!$env->is_logged_in)
- {
- unlink($_FILES["file"]["tmp_name"]);
- http_response_code(401);
- exit(page_renderer::render("Upload failed - $settings->sitename", "
Your upload couldn't be processed because you are not logged in.
Try logging in first."));
- }
-
- // Calculate the target name, removing any characters we
- // are unsure about.
- $target_name = makepathsafe($_POST["name"]);
- $temp_filename = $_FILES["file"]["tmp_name"];
-
- $mimechecker = finfo_open(FILEINFO_MIME_TYPE);
- $mime_type = finfo_file($mimechecker, $temp_filename);
- finfo_close($mimechecker);
-
- if(!in_array($mime_type, $settings->upload_allowed_file_types))
- {
- http_response_code(415);
- exit(page_renderer::render("Unknown file type - Upload error - $settings->sitename", "
$settings->sitename recieved the file you tried to upload successfully, but detected that the type of file you uploaded is not in the allowed file types list. The file has been discarded.
-
The file you tried to upload appeared to be of type $mime_type, but $settings->sitename currently only allows the uploading of the following file types: " . implode(", ", $settings->upload_allowed_file_types) . ".
"));
- }
-
- // Perform appropriate checks based on the *real* filetype
- 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", "
Although the file that you uploaded appears to be an image, $settings->sitename has been unable to determine it's dimensions. The uploaded file has been discarded. Go back to try again.
-
You may wish to consider opening an issue against Pepperminty Wiki (the software that powers $settings->sitename) if this isn't the first time that you have seen this message.
"));
- }
- break;
- }
-
- $file_extension = system_mime_type_extension($mime_type);
-
- // Override the detected file extension if a file extension
- // is explicitly specified in the settings
- if(isset($settings->mime_mappings_overrides[$mime_type]))
- $file_extension = $settings->mime_mappings_overrides[$mime_type];
-
- if(in_array($file_extension, [ "php", ".htaccess", "asp" ]))
- {
- http_response_code(415);
- exit(page_renderer::render("Upload Error - $settings->sitename", "
The file you uploaded appears to be dangerous and has been discarded. Please contact $settings->sitename's administrator for assistance.
-
Additional information: The file uploaded appeared to be of type $mime_type, which mapped onto the extension $file_extension. This file extension has the potential to be executed accidentally by the web server.
A page or file has already been uploaded with the name '$new_filename'. Try deleting it first. If you do not have permission to delete things, try contacting one of the moderators.
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 $settings->sitename has been attacked. Please contact " . $settings->admindetails_name . ", your $settings->sitename Administrator.
"));
- }
-
- $description = $_POST["description"];
-
- // Escape the raw html in the provided description if the setting is enabled
- if($settings->clean_raw_html)
- $description = htmlentities($description, ENT_QUOTES);
-
- file_put_contents($env->storage_prefix . $new_description_filename, $description);
-
- // Construct a new entry for the pageindex
- $entry = new stdClass();
- // Point to the description's filepath since this property
- // should point to a markdown file
- $entry->filename = $new_description_filename;
- $entry->size = strlen($description);
- $entry->lastmodified = time();
- $entry->lasteditor = $env->user;
- $entry->uploadedfile = true;
- $entry->uploadedfilepath = $new_filename;
- $entry->uploadedfilemime = $mime_type;
- // Add the new entry to the pageindex
- // Assign the new entry to the image's filepath as that
- // should be the page name.
- $pageindex->$new_filename = $entry;
-
- // 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_filename,
- "user" => $env->user,
- "filesize" => filesize($entry->uploadedfilepath)
- ]);
- }
-
- header("location: ?action=view&page=$new_filename&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 = $env->storage_prefix . $pageindex->{$env->page}->uploadedfilepath;
- $mime_type = $pageindex->{$env->page}->uploadedfilemime;
-
- // If the size is set or 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";
-
- $preview_sizes = [ 256, 512, 768, 1024, 1440 ];
- $preview_html .= "\t\t\t";
- break;
-
- case "video":
- $preview_html .= "\t\t\t";
- break;
-
- case "audio":
- $preview_html .= "\t\t\t";
- }
-
- $fileInfo = [];
- $fileInfo["Name"] = str_replace("File/", "", $filepath);
- $fileInfo["Type"] = $mime_type;
- $fileInfo["Size"] = human_filesize(filesize($filepath));
- switch($fileTypeDisplay)
- {
- case "image":
- $dimensionsKey = $mime_type !== "image/svg+xml" ? "Original demensions" : "Native size";
- $fileInfo[$dimensionsKey] = "$dimensions[0] x $dimensions[1]";
- break;
- }
- $fileInfo["Uploaded by"] = $pageindex->{$env->page}->lasteditor;
-
- $preview_html .= "\t\t\t
";
-
- $parts["{content}"] = str_replace("", "\n$preview_html", $parts["{content}"]);
- }
- });
-
- // Register a section on the help page on uploading files
- add_help_section("28-uploading-files", "Uploading Files", "
$settings->sitename supports the uploading of files, though it is up to " . $settings->admindetails_name . ", $settings->sitename's administrator as to whether it is enabled or not (uploads are currently " . (($settings->upload_enabled) ? "enabled" : "disabled") . ").
-
Currently Pepperminty Wiki (the software that $settings->sitename uses) only supports the uploading of images, although more file types should be supported in the future (open an issue on GitHub if you are interested in support for more file types).
-
Uploading a file is actually quite simple. Click the "Upload" option in the "More..." menu to go to the upload page. The upload page will tell you what types of file $settings->sitename allows, and the maximum supported filesize for files that you upload (this is usually set by the web server that the wiki is running on).
-
Use the file chooser to select the file that you want to upload, and then decide on a name for it. Note that the name that you choose should not include the file extension, as this will be determined automatically. Enter a description that will appear on the file's page, and then click upload.
");
- }
-]);
-
-//// Pair of functions to calculate the actual maximum upload size supported by the server
-//// Lifted from Drupal by @meustrus from Stackoverflow. Link to answer:
-//// http://stackoverflow.com/a/25370978/1460422
-// Returns a file size limit in bytes based on the PHP upload_max_filesize
-// and post_max_size
-function get_max_upload_size()
-{
- static $max_size = -1;
- if ($max_size < 0) {
- // Start with post_max_size.
- $max_size = parse_size(ini_get('post_max_size'));
- // If upload_max_size is less, then reduce. Except if upload_max_size is
- // zero, which indicates no limit.
- $upload_max = parse_size(ini_get('upload_max_filesize'));
- if ($upload_max > 0 && $upload_max < $max_size) {
- $max_size = $upload_max;
- }
- }
- return $max_size;
-}
-
-function parse_size($size) {
- $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
- $size = preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size.
- if ($unit) {
- // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
- return round($size * pow(1024, stripos('bkmgtpezy', $unit[0])));
- } else {
- return round($size);
- }
-}
-
-function upload_check_svg($temp_filename)
-{
- global $settings;
- // Check for script tags
- if(strpos(file_get_contents($temp_filename), "