diff --git a/.gitignore b/.gitignore
index b811090..3172655 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,30 +2,28 @@
*.md
# All the previous revisions
*.md.r*
+
# Include the README
!README.md
# ...but ignore READMEs in the build folder
build/README.md
+
# ...and the backup peppermint.json files created when using the settings GUI
peppermint.json.bak
-# And the Module API Docs
+# But keep the useful markdown files
!Module_API_Docs.md
-# And the changelog
!Changelog.md
-# And the development notes
!Development.md
-# The page index
+# Ignore the php documentor cache folder
+docs/ModuleApiCache
+
+# Ignore the various indexes created by pepperminty wiki
pageindex.json
-# The id index
idindex.json
-# The search index
invindex.json
-# The recent changes list
recent-changes.json
-# The statistics cache file
build/statsindex.json
-# The new settings file
peppermint.json
# The comments files
build/*.comments.json
diff --git a/Makefile b/Makefile
index eee4e42..9794e3d 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,6 @@
.DEFAULT_GOAL := peppermint
-.PHONY: setupApiDoc peppermint docs gh-pages
+.PHONY: setupApiDoc peppermint docs rest_docs module_api_docs
ApiDocPresent := $(shell sh -c apidoc --help 1\>/dev/null && rm -rf doc/)
@@ -8,11 +8,20 @@ peppermint:
@echo [peppermint/build] Rebuilding Pepperminty Wiki
php build.php
-docs: setupApiDoc
+docs: rest_docs module_api_docs
+
+rest_docs: setupApiDoc
@echo [peppermint/docs] Building docs
- apidoc -o './RestApiDocs/' --config apidoc.json -f '.*\.php' -e index.php
+ apidoc -o './docs/RestApi/' --config apidoc.json -f '.*\.php' -e index.php
rm -rf doc/
+module_api_docs: phpdoc
+ @echo [peppermint/module api docs] Updating module api docs
+ php phpdoc run --directory . --target docs/ModuleApi --cache-folder docs/ModuleApiCache --ignore build/,php_error.php,Parsedown*,*.html --title "Pepperminty Wiki Module API" --visibility public
+
+phpdoc:
+ curl -L https://phpdoc.org/phpDocumentor.phar -o phpdoc
+
setupApiDoc:
@echo [peppermint] Checking for apiDoc
ifndef ApiDocPresent
@@ -21,16 +30,3 @@ ifndef ApiDocPresent
npm install apidoc --global
endif
@echo [peppermint] Check complete
-
-gh-pages:
- @echo [peppermint/gh-pages] Syncing master branch with gh-pages branch.
- @echo [peppermint/gh-pages] Making sure the working directory is clean.
- # From http://unix.stackexchange.com/a/155077/64687
- git diff --exit-code
- git diff --cached --exit-code
-
- git checkout gh-pages
- git rebase master
- git push origin gh-pages
- git checkout master
- @echo '[peppermint/gh-pages] Sync complete.'
diff --git a/Module_API_Docs.md b/Module_API_Docs.md
index 90739f9..10fb87c 100644
--- a/Module_API_Docs.md
+++ b/Module_API_Docs.md
@@ -1,195 +1,28 @@
-Module API Documentation
-========================
-The core of Pepperminty Wik exposes several global objects and functions that you can use to write your own modules. This page documents these objects and functions so that you can create your own modules more easily.
+# Developer Documentation
+The core of Pepperminty Wiki exposes several global objects, classes, functions, and miscellaneous files that you can use to write your own modules. This page documents these them so that you can create your own modules more easily.
-Indexes
--------
-Pepperminty Wiki maintains several indexes containing various information about the current site that you can utilise. Some of them also have an 'API' of sorts that you can use to interact with them.
+## Table of Contents
+ - [Rest API](#rest-api)
+ - [Module API](#module-api)
+ - [Global Variables](#global-variables)
+ - [Files](#files)
+ - [`pageindex.json`](#pageindex.json)
+ - [`idindex.json`](#idindex.json)
+ - [`invindex.json`](#invindex.json)
+ - [`recent-changes.json`](#recent-changes.json)
+ - [`statsindex.json`](#statsindex.json)
-### `pageindex.json`
-This is by _far_ the most important index. It contains an entry for each page, under which a number of interesting pieces of information are stored. It's automatically loaded into the global variable `$pageindex` too, so you don't even have to read it in. Here's an example pageindex:
+## Rest API
+The REST api provided by Pepperminty Wiki itself is documented for bot owners and software developers alike over on GitHub pages [here](https://sbrl.github.io/Pepperminty-Wiki/docs/RestAPI).
-```json
-{
- "Internal link": {
- "filename": "Internal link.md",
- "size": 120,
- "lastmodified": 1446019377,
- "lasteditor": "admin",
- "tags": [
- "testing",
- "test tag with spaces",
- "really really really really really really long tag"
- ]
- },
- "Main Page": {
- "filename": "Main Page.md",
- "size": 151,
- "lastmodified": 1446388276,
- "lasteditor": "admin",
- "tags": []
- },
- "Internal link\/Sub": {
- "filename": "Internal link\/Sub.md",
- "size": 35,
- "lastmodified": 1446370194,
- "lasteditor": "admin",
- "tags": [
- "test"
- ]
- },
- "Files\/AJ Scr.png": {
- "filename": "Files\/AJ Scr.png.md",
- "size": 29,
- "lastmodified": 1445501914,
- "lasteditor": "admin",
- "uploadedfile": true,
- "uploadedfilepath": "Files\/AJ Scr.png",
- "uploadedfilemime": "image\/png"
- }
-}
-```
+## Module API
+The main PHP-based module API is documented with php documentor. The docs can be found [here](https://sbrl.github.io/Pepperminty-Wiki/docs/ModuleApi), hosted on GitHub Pages.
-Currently, Pepperminty Wiki is configured to pretty print the json in the pageindex when saving it to disk, so if you find yourself saving the pageindex please do the same.
+This documentation covers all the functions and classes available in both the Pepperminty Wiki core, and the modules stored in this repository - as well as mentioning which module they are a part of.
-Now that alternate data storage directories are supported, the `$entry->filename` will *not* contain the `$env->storage_prefix` prefix. You will need to add this manually if you use it.
+There are one or two additional things that haven't made their way into the module api docs, which are detailed below:
-### `idindex.json`
-The id index converts page ids into page names and vice versa. It's loaded into the global variable `$idindex`, but you normally wouldn't need to touch that, as there's a seamless API that you can use instead:
-
-#### `ids::getid($pagename)`
-Gets the id associated with the given pagename. If it doesn't exist it will be created.
-
-#### `ids::getpagename($id)`
-Gets the page name associated with the given id. If it doesn't exist `false` will be returned.
-
-Functions
----------
-
-### `register_module($module_info)`
-Register a new module with Pepperminty Wiki. This is the most important function. Here's an example:
-
-```php
- "Human readable module name", // The name of your module, will be shown to users
- "version" => "0.1", // The version number
- "author" => "Author Name", // Your name
- "description" => "Module Description", // A description of your module. Shown in the module downloader.
- "id" => "module-id", // An id for your module name. Should be filename safe with no spaces or capital letters.
- "code" => function() {
- // Insert your module's code here
- }
-]);
-
-?>
-
-```
-
-The function that you provide will be executed after the initial setup has been completed.
-
-### `module_exists($id)`
-Checks to see if a module with the given id is currently loaded. Very useful for providing optional integration with other modules. Note that this may return false if all the modules haven't been loaded yet. All the modules are guaranteed to be loaded by the time the code in the `"code"` function is executed.
-
-```php
- "Human readable module name",
- "version" => "0.1",
- "author" => "Author Name",
- "description" => "Module Description",
- "id" => "module-id",
- "code" => function() {
- add_action("action_name", function() {
- exit("Hello, World!");
- });
- }
-]);
-
-?>
-
-```
-
-The above adds an action called `action_name`, which, when requested, outputs the text `Hello, World!`.
-
-### `register_save_preprocessor($function)`
-Registers a function to be called every time a page is edited. The function will be passed the following parameters:
-
-1. A reference to the pageindex entry that is about to be saved.
-2. The new text that is to replace the old text.
-3. The old text that the new text is going to replace.
-
-If you make the function that you pass here take the new text that is to be saved in as a reference, you may alter it before it is saved to disk.
-
-### `page_renderer`
-You probably want your module to output a nice user-friendly page instead of a simple text-based one. Luckily, Pepperminty Wiki has a system to let you do that.
-
-#### `page_renderer::render_main($title, $content)`
-This is the main page rendering function you'll want to use. It renders and returns a page much the same as the default `view` action does. Here's an example:
-
-```php
-
-
-```
-
-
-#### `page_renderer::render_minimal($title, $content)`
-Similar to the above, but renders a printable page instead. For an example, click the "Printable" button at the top of any page on Pepperminty Wiki.
-
-```php
-
-
-```
-
-#### `page_renderer::render_username($name)`
-Renders a username. Currently all this function does is prepend `$settings->admin_display_char` to the username if they are an admin. Example:
-
-```php
-
-```
-
-#### `page_renderer::AddJSLink(string $scriptUrl)`
-Add a remote JS script to rendered pages. Links added via this method translate to something like ``.
-```php
-
-```
-
-#### `page_renderer::AddJSSnippet(string $snippet)`
-Adds a snippet of javascript to generated pages. The snippet in question will be guaranteed to run after the DOM content has loaded (but the `onload` event may not have fired yet). Snippets added via this method will be translated into something like ``.
-
-```php
-
-```
-
-#### `page_renderer::register_part_preprocessor($code)`
+### `page_renderer::register_part_preprocessor($code)`
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. Here's an example:
```php
@@ -251,9 +84,8 @@ register_module([
```
-Variables
----------
-There are a number of global variables floatign around that can give you a lot of information about the current request. ~~I will be tidying them up into a single `$env` object soon.~~ Most of the below have been tidied up into a single `$env` object now! Below is a table of all the variables Pepperminty Wiki has lying around:
+### Global Variables
+There are a number of global variables floating around that can give you a lot of information about the current request. ~~I will be tidying them up into a single `$env` object soon.~~ Most of the below have been tidied up into a single `$env` object now! Below is a table of all the variables Pepperminty Wiki has lying around:
Variable | Description
------------------------|------------------------------------------
@@ -265,3 +97,67 @@ Variable | Description
`$env->action` | The current action.
`$settings` | The settings object from the top of the file.
`$pageindex` | Contains a list of all the pages that Pepperminty Wiki currently knows about, along with information about each page. Exists to improve performance.
+
+
+## Files
+Pepperminty Wiki maintains several files (most of which are indexes) containing various information about the current site that you can utilise. Some of them also have an 'API' of sorts that you can use to interact with them - which is documented in the [module api](#module-api) above.
+
+### `pageindex.json`
+This is by _far_ the most important index. It contains an entry for each page, under which a number of interesting pieces of information are stored. It's automatically loaded into the global variable `$pageindex` too, so you don't even have to read it in. Here's an example pageindex:
+
+```json
+{
+ "Internal link": {
+ "filename": "Internal link.md",
+ "size": 120,
+ "lastmodified": 1446019377,
+ "lasteditor": "admin",
+ "tags": [
+ "testing",
+ "test tag with spaces",
+ "really really really really really really long tag"
+ ]
+ },
+ "Main Page": {
+ "filename": "Main Page.md",
+ "size": 151,
+ "lastmodified": 1446388276,
+ "lasteditor": "admin",
+ "tags": []
+ },
+ "Internal link\/Sub": {
+ "filename": "Internal link\/Sub.md",
+ "size": 35,
+ "lastmodified": 1446370194,
+ "lasteditor": "admin",
+ "tags": [
+ "test"
+ ]
+ },
+ "Files\/AJ Scr.png": {
+ "filename": "Files\/AJ Scr.png.md",
+ "size": 29,
+ "lastmodified": 1445501914,
+ "lasteditor": "admin",
+ "uploadedfile": true,
+ "uploadedfilepath": "Files\/AJ Scr.png",
+ "uploadedfilemime": "image\/png"
+ }
+}
+```
+
+Currently, Pepperminty Wiki is configured to pretty print the json in the pageindex when saving it to disk, so if you find yourself saving the pageindex please do the same.
+
+Now that alternate data storage directories are supported, the `$entry->filename` will *not* contain the `$env->storage_prefix` prefix. You will need to add this manually if you use it.
+
+### `idindex.json`
+The id index converts page ids into page names and vice versa. It's loaded into the global variable `$idindex`, but you normally wouldn't need to touch that, as there's a seamless API that you can use instead, which can be found under the `ids` class.
+
+### `invindex.json`
+This is the main search index. Obviously, it's only present if the `feature-search` module is loaded and active. It can be interacted with though the `search` class that the `feature-search` module exposes.
+
+### `recent-changes.json`
+This is not loaded automatically, but it contains a list of recent changes that have occurred throughout the wiki. You don't have to fiddle with it directly though if you just want to add a new change, because the `feature-recent-changes` module has a fewe handy methods you can use for that purpose.
+
+### `statsindex.json`
+This file is brand new as of v0.15, and contains the most recently calculated statistics about the wiki. The `feature-stats` module oversees the regeneration of this file. Consult if you need access to such statistics that might be somewhat expensive to calculate.
diff --git a/README.md b/README.md
index b1e39d7..a8c0631 100644
--- a/README.md
+++ b/README.md
@@ -171,7 +171,7 @@ Key | Value | Explanation
## Module API Reference
I have documented (most of) the current API that you can use to create your own modules. You can find it in the [Module_API_Docs.md](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Module_API_Docs.md) file in this repository.
-I've also documented Pepperminty Wiki's entire REST API using [apiDoc](http://apidocjs.com/). You can view the docs [here](https://sbrl.github.io/Pepperminty-Wiki/RestApiDocs/).
+I've also documented Pepperminty Wiki's entire REST API using [apiDoc](http://apidocjs.com/). You can view the docs [here](https://sbrl.github.io/Pepperminty-Wiki/docs/RestApiDocs/).
If you do create a module, I'd love to hear about it. Even better, [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls/new)!
diff --git a/RestApiDocs/api_data.js b/RestApiDocs/api_data.js
deleted file mode 100644
index fa18bf6..0000000
--- a/RestApiDocs/api_data.js
+++ /dev/null
@@ -1,1418 +0,0 @@
-define({ "api": [
- {
- "type": "post",
- "url": "?action=checklogin",
- "title": "Perform a login",
- "name": "CheckLogin",
- "group": "Authorisation",
- "permission": [
- {
- "name": "Anonymous",
- "title": "Anybody may use this call.",
- "description": ""
- }
- ],
- "parameter": {
- "fields": {
- "Parameter": [
- {
- "group": "Parameter",
- "type": "string",
- "optional": false,
- "field": "user",
- "description": "
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)
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.
",
- "name": "Logout",
- "group": "Authorisation",
- "permission": [
- {
- "name": "Anonymous",
- "title": "Anybody may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/page-logout.php",
- "groupTitle": "Authorisation"
- },
- {
- "type": "post",
- "url": "?action=comment",
- "title": "Comment on a page",
- "name": "Comment",
- "group": "Comment",
- "permission": [
- {
- "name": "User",
- "title": "Only users loggged in may use this call.",
- "description": ""
- }
- ],
- "description": "
Posts a comment on a page, optionally in reply to another comment. Currently, comments must be made by a logged-in user.
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.
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.
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.
Optional. The display mode to use. Can hld 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).
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.
Optional. If true then a special page to upload your avatar is displayed instead.
"
- }
- ]
- }
- },
- "version": "0.0.0",
- "filename": "./modules/feature-upload.php",
- "groupTitle": "Upload"
- },
- {
- "type": "get",
- "url": "?action=configure",
- "title": "Get a page to change the global wiki settings",
- "name": "ConfigureSettings",
- "group": "Utility",
- "permission": [
- {
- "name": "Moderator",
- "title": "Only users loggged with a moderator account may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/feature-guiconfig.php",
- "groupTitle": "Utility"
- },
- {
- "type": "post",
- "url": "?action=configure-save",
- "title": "Save changes to the global wiki settings",
- "name": "ConfigureSettings",
- "group": "Utility",
- "permission": [
- {
- "name": "Moderator",
- "title": "Only users loggged with a moderator account may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/feature-guiconfig.php",
- "groupTitle": "Utility"
- },
- {
- "type": "get",
- "url": "?action=credits",
- "title": "Get the credits page",
- "name": "Credits",
- "group": "Utility",
- "permission": [
- {
- "name": "Anonymous",
- "title": "Anybody may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/page-credits.php",
- "groupTitle": "Utility"
- },
- {
- "type": "get",
- "url": "?action=debug",
- "title": "Get a debug dump",
- "name": "Debug",
- "group": "Utility",
- "permission": [
- {
- "name": "Moderator",
- "title": "Only users loggged with a moderator account may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/page-debug-info.php",
- "groupTitle": "Utility",
- "error": {
- "fields": {
- "Error 4xx": [
- {
- "group": "Error 4xx",
- "optional": false,
- "field": "UserNotModeratorError",
- "description": "
You weren't loggged in as a moderator before sending this request.
"
- }
- ]
- }
- }
- },
- {
- "type": "get",
- "url": "?action=export",
- "title": "Export the all the wiki's content",
- "description": "
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.
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.
"
- }
- ]
- }
- },
- "version": "0.0.0",
- "filename": "./modules/page-help.php",
- "groupTitle": "Utility"
- },
- {
- "type": "get",
- "url": "?action=list-tags[&tag=]",
- "title": "Get a list of tags or pages with a certain tag",
- "description": "
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.
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!
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)
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.
",
- "name": "Logout",
- "group": "Authorisation",
- "permission": [
- {
- "name": "Anonymous",
- "title": "Anybody may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/page-logout.php",
- "groupTitle": "Authorisation"
- },
- {
- "type": "post",
- "url": "?action=comment",
- "title": "Comment on a page",
- "name": "Comment",
- "group": "Comment",
- "permission": [
- {
- "name": "User",
- "title": "Only users loggged in may use this call.",
- "description": ""
- }
- ],
- "description": "
Posts a comment on a page, optionally in reply to another comment. Currently, comments must be made by a logged-in user.
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.
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.
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.
Optional. The display mode to use. Can hld 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).
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.
Optional. If true then a special page to upload your avatar is displayed instead.
"
- }
- ]
- }
- },
- "version": "0.0.0",
- "filename": "./modules/feature-upload.php",
- "groupTitle": "Upload"
- },
- {
- "type": "get",
- "url": "?action=configure",
- "title": "Get a page to change the global wiki settings",
- "name": "ConfigureSettings",
- "group": "Utility",
- "permission": [
- {
- "name": "Moderator",
- "title": "Only users loggged with a moderator account may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/feature-guiconfig.php",
- "groupTitle": "Utility"
- },
- {
- "type": "post",
- "url": "?action=configure-save",
- "title": "Save changes to the global wiki settings",
- "name": "ConfigureSettings",
- "group": "Utility",
- "permission": [
- {
- "name": "Moderator",
- "title": "Only users loggged with a moderator account may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/feature-guiconfig.php",
- "groupTitle": "Utility"
- },
- {
- "type": "get",
- "url": "?action=credits",
- "title": "Get the credits page",
- "name": "Credits",
- "group": "Utility",
- "permission": [
- {
- "name": "Anonymous",
- "title": "Anybody may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/page-credits.php",
- "groupTitle": "Utility"
- },
- {
- "type": "get",
- "url": "?action=debug",
- "title": "Get a debug dump",
- "name": "Debug",
- "group": "Utility",
- "permission": [
- {
- "name": "Moderator",
- "title": "Only users loggged with a moderator account may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/page-debug-info.php",
- "groupTitle": "Utility",
- "error": {
- "fields": {
- "Error 4xx": [
- {
- "group": "Error 4xx",
- "optional": false,
- "field": "UserNotModeratorError",
- "description": "
You weren't loggged in as a moderator before sending this request.
"
- }
- ]
- }
- }
- },
- {
- "type": "get",
- "url": "?action=export",
- "title": "Export the all the wiki's content",
- "description": "
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.
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.
"
- }
- ]
- }
- },
- "version": "0.0.0",
- "filename": "./modules/page-help.php",
- "groupTitle": "Utility"
- },
- {
- "type": "get",
- "url": "?action=list-tags[&tag=]",
- "title": "Get a list of tags or pages with a certain tag",
- "description": "
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.
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!
You weren't loggged in as a moderator before sending this request.
"
- }
- ]
- }
- }
- },
- {
- "type": "get",
- "url": "?action=user-list[format=json]",
- "title": "List all users",
- "name": "UserList",
- "group": "Utility",
- "permission": [
- {
- "name": "Anonymous",
- "title": "Anybody may use this call.",
- "description": ""
- }
- ],
- "version": "0.0.0",
- "filename": "./modules/page-user-list.php",
- "groupTitle": "Utility"
- }
-]
diff --git a/core.php b/core.php
index cad4e91..5a29d84 100644
--- a/core.php
+++ b/core.php
@@ -1123,6 +1123,13 @@ class page_renderer
/**
* 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.
*/
diff --git a/docs/ModuleApi/.htaccess b/docs/ModuleApi/.htaccess
new file mode 100644
index 0000000..7b01f9b
--- /dev/null
+++ b/docs/ModuleApi/.htaccess
@@ -0,0 +1,5 @@
+# Fixes a vulnerability in CentOS: http://stackoverflow.com/questions/20533279/prevent-php-from-parsing-non-php-files-such-as-somefile-php-txt
+
+ RemoveHandler .php
+ ForceType text/plain
+
\ No newline at end of file
diff --git a/docs/ModuleApi/classes/PeppermintParsedown.html b/docs/ModuleApi/classes/PeppermintParsedown.html
new file mode 100644
index 0000000..efd2f0c
--- /dev/null
+++ b/docs/ModuleApi/classes/PeppermintParsedown.html
@@ -0,0 +1,376 @@
+
+
+
+
+
+ Pepperminty Wiki Module API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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.
+
+
Parameters
+
+
+
string
+
$oldpagename
+
The old page name to move.
+
+
+
string
+
$newpagename
+
The new pagee name to move the old page name to.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
deletepagename()
+
+
deletepagename(string $pagename)
+
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.
+
+
Parameters
+
+
+
string
+
$pagename
+
The page name to delete from the id index.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
clear()
+
+
clear()
+
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.
Registers a statistic calculator against the system.
+
+
+
Parameters
+
+
+
array
+
$stat_data
+
The statistic object to register.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
has_statistic()
+
+
has_statistic(string $stat_id) : boolean
+
Checks whether a specified statistic has been registered.
+
+
+
Parameters
+
+
+
string
+
$stat_id
+
The id of the statistic to check the existence of.
+
+
+
+
+
Returns
+ boolean
+ —
Whether the specified statistic has been registered.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/ModuleApi/files/core.php.txt b/docs/ModuleApi/files/core.php.txt
new file mode 100644
index 0000000..270a9df
--- /dev/null
+++ b/docs/ModuleApi/files/core.php.txt
@@ -0,0 +1,1772 @@
+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";
+
+// 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
+ // Note that the 'pass' field here is actually a hash of the password set
+ // by the login action
+ $env->user = $_SESSION[$settings->sessionprefix . "-user"];
+ $env->pass = $_SESSION[$settings->sessionprefix . "-pass"];
+
+ if($settings->users->{$env->user}->password == $env->pass)
+ {
+ // The user is logged in
+ $env->is_logged_in = true;
+ $env->user_data = $settings->users->{$env->user};
+ }
+ else
+ {
+ // The user's login details are invalid (what is going on here?)
+ // Unset the session variables, treat them as an anonymous user,
+ // and get out of here
+ $env->is_logged_in = false;
+ $env->user = $settings->anonymous_user_name;
+ $env->pass = "";
+ // Clear the session data
+ $_SESSION = []; // Delete all the variables
+ session_destroy(); // Destroy the session
+ }
+}
+
+// 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 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 )
+{
+ 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 safe.
+ * Paths may only contain alphanumeric characters, spaces, underscores, and
+ * dashes.
+ * @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 moree 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 = function_exists("mb_stripos") ? mb_stripos($haystack, $needle, $s) : 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;
+}
+/**
+ * Figures out whether a given http accepts header contains a
+ * specified mime type.
+ * @package core
+ * @param string $accept_header The accept header to search.
+ * @param string $mime_type The mime type to search for.
+ * @return bool Whether the specified mime type was found
+ * in the specified accepts header.
+ */
+function accept_contains_mime($accept_header, $mime_type)
+{
+ $accepted_mimes = explode(",", $accept_header);
+ foreach($accepted_mimes as $accepted_mime) {
+ if(explode(";", $accepted_mime)[0] == $mime_type)
+ return true;
+ }
+ return false;
+}
+
+/**
+ * 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 "";
+}
+/**
+ * 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 = "$pageDisplayName";
+ $pageDisplayLink = "$pageDisplayName";
+ 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 "✎ $editorName";
+}
+
+/**
+ * Saves the currently logged in uesr'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;
+ file_put_contents($paths->settings_file, json_encode($settings, JSON_PRETTY_PRINT));
+
+ return true;
+}
+
+/**
+ * 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";
+
+ mail($settings->users->{$username}->emailAddress, $subject, $body, $compiled_headers, "-t");
+ return true;
+}
+/**
+ * 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 = utf8_encode(substr( // Store the filename, whilst trimming the storage prefix
+ $pagefilename,
+ strlen(preg_replace("/^\.\//i", "", $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 = utf8_encode("unknown"); // Set the editor to "unknown"
+ // Extract the name of the (sub)page without the ".md"
+ $pagekey = utf8_encode(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;
+
+ foreach ($idindex as $id => $entry)
+ {
+ if($entry == $pagename)
+ 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 pagee name to move the old page name to.
+ */
+ public static function movepagename($oldpagename, $newpagename)
+ {
+ global $idindex, $paths;
+
+ $pageid = self::getid($oldpagename);
+ $idindex->$pageid = $newpagename;
+
+ 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;
+
+ $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 = utf8_encode($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 = "
+
+
+
+ {title}
+
+
+
+ {header-html}
+
+
+ {body}
+
+
+
+";
+ /**
+ * The main content template that is used to render normal wiki pages.
+ * @var string
+ * @package core
+ */
+ public static $main_content_template = "{navigation-bar}
+
{sitename}
+
+ {content}
+
+ {extra}
+
+ {navigation-bar-bottom}
+ {all-pages-datalist}";
+ /**
+ * A specially minified content template that doesn't include the navbar and
+ * other elements not suiltable for printing.
+ * @var string
+ * @package core
+ */
+ public static $minimal_content_template = "{content}
+ ";
+
+ /**
+ * 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.
+ * @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", "
$settings->sitename has got a misbehaving module installed that tried to register an invalid HTML handler with the page renderer. Please contact $settings->sitename's administrator $admin_name at $admin_email."));
+ }
+
+ self::$part_processors[] = $function;
+
+ return true;
+ }
+
+ /**
+ * Renders a HTML page with the content specified.
+ * @package core
+ * @param string $title The title of the page.
+ * @param string $content The (HTML) content of the page.
+ * @param boolean $body_template The HTML content template to use.
+ * @return string The rendered HTML, ready to send to the client :-)
+ */
+ public static function render($title, $content, $body_template = false)
+ {
+ global $settings, $start_time, $version;
+
+ if($body_template === false)
+ $body_template = self::$main_content_template;
+
+ if(strlen($settings->logo_url) > 0)
+ {
+ // A logo url has been specified
+ $logo_html = "";
+ switch($settings->logo_position)
+ {
+ case "left":
+ $logo_html = "$logo_html $settings->sitename";
+ break;
+ case "right":
+ $logo_html .= " $settings->sitename";
+ break;
+ default:
+ throw new Exception("Invalid logo_position '$settings->logo_position'. Valid values are either \"left\" or \"right\" and are case sensitive.");
+ }
+ }
+
+ $parts = [
+ "{body}" => $body_template,
+
+ "{sitename}" => $logo_html,
+ "{version}" => $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);
+ 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);
+ }
+
+ /**
+ * 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\n";
+
+ if(!empty($settings->enable_math_rendering))
+ {
+ $result .= "";
+ }
+
+ return $result;
+ }
+ /**
+ * 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;
+
+ if(preg_match("/^[^\/]*\/\/|^\//", $settings->css))
+ return "\n";
+ else
+ {
+ $css = $settings->css;
+ if(!empty($settings->optimize_pages))
+ {
+ // CSS Minification ideas by Jean from catswhocode.com
+ // Link: http://www.catswhocode.com/blog/3-ways-to-compress-css-files-using-php
+ // Remove comments
+ $css = preg_replace('!/\*[^*]*\*+([^/][^*]*\*+)*/!', "", $css);
+ // Cut down whitespace
+ $css = preg_replace('/\s+/', " ", $css);
+ // Remove whitespace after colons and semicolons
+ $css = str_replace([
+ " :",
+ ": ",
+ "; ",
+ " { ",
+ " } "
+ ], [
+ ":",
+ ":",
+ ";",
+ "{",
+ "}"
+ ], $css);
+
+ }
+ return "\n";
+ }
+ }
+ /**
+ * 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 = "\n";
+ foreach(static::$jsSnippets as $snippet)
+ $result .= "\n";
+ foreach(static::$jsLinks as $link)
+ $result .= "\n";
+ return $result;
+ }
+
+ // ~
+
+ /**
+ * The navigation bar divider.
+ * @package core
+ * @var string
+ */
+ public static $nav_divider = " | ";
+
+ /**
+ * Renders a navigation bar from an array of links. See
+ * $settings->nav_links for format information.
+ * @package core
+ * @param array $nav_links The links to add to the navigation bar.
+ * @param array $nav_links_extra The extra nav links to add to
+ * the "More..." menu.
+ * @param string $class The class(es) to assign to the rendered
+ * navigation bar.
+ */
+ public static function render_navigation_bar($nav_links, $nav_links_extra, $class = "")
+ {
+ global $settings, $env;
+ $result = "";
+ return $result;
+ }
+ /**
+ * Renders a username for inclusion in a page.
+ * @package core
+ * @param string $name The username to render.
+ * @return string The username rendered in HTML.
+ */
+ public static function render_username($name)
+ {
+ global $settings;
+ $result = "";
+ $result .= "";
+ if($settings->avatars_show)
+ $result .= " ";
+ if(in_array($name, $settings->admins))
+ $result .= $settings->admindisplaychar;
+ $result .= htmlentities($name);
+ $result .= "";
+
+ return $result;
+ }
+
+ // ~
+
+ /**
+ * Renders the datalist for the search box as HTML.
+ * @package core
+ * @return string The search box datalist as HTML.
+ */
+ public static function generate_all_pages_datalist()
+ {
+ global $settings, $pageindex;
+ $arrayPageIndex = get_object_vars($pageindex);
+ ksort($arrayPageIndex);
+ $result = "";
+
+ return $result;
+ }
+}
+
+// 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");
+ }
+ });
+});
+');
+
+/// 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", "
"));
+}
+
+// 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);
+ $url = "?action=login&returnto=" . rawurlencode($_SERVER["REQUEST_URI"]) . "&required=true";
+ header("location: $url");
+ exit(page_renderer::render("Login required - $settings->sitename", "
$settings->sitename requires that you login before you are able to access it.
"));
+}
+//////////////////////////////////////
+//////////////////////////////////////
+
+//////////////////////////
+/// Module functions ///
+//////////////////////////
+// These functions are //
+// used by modules to //
+// register themselves //
+// or new pages. //
+//////////////////////////
+/** A list of all the currentlyloaded 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", "
Parsing some page source data failed. This is most likely because $settings->sitename has the parser setting set incorrectly. Please contact " . $settings->admindetails_name . ", your $settings->sitename Administrator."));
+
+/* Not needed atm because escaping happens when saving, not when rendering *
+ if($settings->clean_raw_html)
+ $source = htmlentities($source, ENT_QUOTES | ENT_HTML5);
+*/
+ return $parsers[$settings->parser]($source);
+}
+
+// Function to
+$save_preprocessors = [];
+/**
+ * Register a new proprocessor that will be executed just before
+ * an edit is saved.
+ * @package core
+ * @param function $func The function to register.
+ */
+function register_save_preprocessor($func)
+{
+ global $save_preprocessors;
+ $save_preprocessors[] = $func;
+}
+
+$help_sections = [];
+/**
+ * Adds a new help section to the help page.
+ * @package core
+ * @param string $index The string to index the new section under.
+ * @param string $title The title to display above the section.
+ * @param string $content The content to display.
+ */
+function add_help_section($index, $title, $content)
+{
+ global $help_sections;
+
+ $help_sections[$index] = [
+ "title" => $title,
+ "content" => $content
+ ];
+}
+
+if(!empty($settings->enable_math_rendering))
+ add_help_section("22-mathematical-mxpressions", "Mathematical Expressions", "
$settings->sitename supports rendering of mathematical expressions. Mathematical expressions can be included practically anywhere in your page. Expressions should be written in LaTeX and enclosed in dollar signs like this: $x^2$.
+
Note that expression parsing is done on the viewer's computer with javascript (specifically MathJax) and not by $settings->sitename directly (also called client side rendering).
");
+
+/** An array of the currently registerd statistic calculators. Not guaranteed to be populated until the requested action function is called. */
+$statistic_calculators = [];
+/**
+ * Registers a statistic calculator against the system.
+ * @package core
+ * @param array $stat_data The statistic object to register.
+ */
+function statistic_add($stat_data) {
+ global $statistic_calculators;
+ $statistic_calculators[$stat_data["id"]] = $stat_data;
+}
+/**
+ * Checks whether a specified statistic has been registered.
+ * @package core
+ * @param string $stat_id The id of the statistic to check the existence of.
+ * @return boolean Whether the specified statistic has been registered.
+ */
+function has_statistic($stat_id) {
+ global $statistic_calculators;
+ return !empty($statistic_calculators[$stat_id]);
+}
+
+//////////////////////////////////////////////////////////////////
+
+// %next_module% //
+
+//////////////////////////////////////////////////////////////////
+
+// Execute each module's code
+foreach($modules as $moduledata)
+{
+ $moduledata["code"]();
+}
+// Make sure that the credits page exists
+if(!isset($actions->credits))
+{
+ exit(page_renderer::render_main("Error - $settings->$sitename", "
No credits page detected. The credits page is a required module!
The pagename that should be considered the root of the rendering. You don't usually need to use this, it is used by the algorithm itself since it is recursive.
+
+
+
+
+
Returns
+ string
+ —
A HTML rendering of the sidebar for the given pageindex.
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
+
+
+
+
+
Returns
+ integer
+ —
The maximum upload size supported bythe server, in bytes.
+
+
+
+
+
+
+
+
+
+
+
parse_size()
+
+
parse_size(string $size) : integer
+
Parses a PHP size to an integer
+
+
+
Parameters
+
+
+
string
+
$size
+
The size to parse.
+
+
+
+
+
Returns
+ integer
+ —
The number of bytees represented by the specified
+size string.
+
+
+
diff --git a/docs/ModuleApi/files/modules/action-hash.php.txt b/docs/ModuleApi/files/modules/action-hash.php.txt
new file mode 100644
index 0000000..d7dcf56
--- /dev/null
+++ b/docs/ModuleApi/files/modules/action-hash.php.txt
@@ -0,0 +1,51 @@
+ "Password hashing action",
+ "version" => "0.6",
+ "author" => "Starbeamrainbowlabs",
+ "description" => "Adds a utility action (that anyone can use) called hash that hashes a given string. Useful when changing a user's password.",
+ "id" => "action-hash",
+ "code" => function() {
+ /**
+ * @api {get} ?action=hash&string={text} Hash a password
+ * @apiName Hash
+ * @apiGroup Utility
+ * @apiPermission Anonymous
+ *
+ * @apiParam {string} string The string to hash.
+ * @apiParam {boolean} raw Whether to return the hashed password as a raw string instead of as part of an HTML page.
+ *
+ * @apiError ParamNotFound The string parameter was not specified.
+ */
+
+ /*
+ * ██ ██ █████ ███████ ██ ██
+ * ██ ██ ██ ██ ██ ██ ██
+ * ███████ ███████ ███████ ███████
+ * ██ ██ ██ ██ ██ ██ ██
+ * ██ ██ ██ ██ ███████ ██ ██
+ */
+ add_action("hash", function() {
+ global $settings;
+
+ if(!isset($_GET["string"]))
+ {
+ http_response_code(422);
+ exit(page_renderer::render_main("Missing parameter", "
The GET parameter string must be specified.
+
It is strongly recommended that you utilise this page via a private or incognito window in order to prevent your password from appearing in your browser history.
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.
"));
+ }
+ });
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/action-random.php.txt b/docs/ModuleApi/files/modules/action-random.php.txt
new file mode 100644
index 0000000..f7c2b9c
--- /dev/null
+++ b/docs/ModuleApi/files/modules/action-random.php.txt
@@ -0,0 +1,32 @@
+ "Random Page",
+ "version" => "0.1",
+ "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 Redirects to a random page.
+ * @apiName RawSource
+ * @apiGroup Page
+ * @apiPermission Anonymous
+ */
+
+ add_action("random", function() {
+ global $pageindex;
+
+ $pageNames = array_keys(get_object_vars($pageindex));
+ $randomPageName = $pageNames[array_rand($pageNames)];
+
+ http_response_code(307);
+ header("location: ?page=" . rawurlencode($randomPageName));
+ });
+
+ add_help_section("26-random-redirect", "Jumping to a random page", "
$settings->sitename has a function that can send you to a random page. To use it, click here. $settings->admindetails_name ($settings->sitename's adminstrator) may have added it to one of the menus.
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/action-raw.php.txt b/docs/ModuleApi/files/modules/action-raw.php.txt
new file mode 100644
index 0000000..3e3f5ce
--- /dev/null
+++ b/docs/ModuleApi/files/modules/action-raw.php.txt
@@ -0,0 +1,39 @@
+ "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 $env;
+
+ header("content-type: text/markdown");
+ exit(file_get_contents($env->page_filename));
+ });
+
+ add_help_section("800-raw-page-content", "Viewing Raw Page Content", "
Although you can use the edit page to view a page's source, you can also ask $settings->sitename to send you the raw page source and nothing else. This feature is intented for those who want to automate their interaction with $settings->sitename.
+
To use this feature, navigate to the page for which you want to see the source, and then alter the action parameter in the url's query string to be raw. If the action parameter doesn't exist, add it. Note that when used on an file's page this action will return the source of the description and not the file itself.
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/api-status.php.txt b/docs/ModuleApi/files/modules/api-status.php.txt
new file mode 100644
index 0000000..03059c4
--- /dev/null
+++ b/docs/ModuleApi/files/modules/api-status.php.txt
@@ -0,0 +1,50 @@
+ "API status",
+ "version" => "0.1",
+ "author" => "Starbeamrainbowlabs",
+ "description" => "Provides a basic JSON status action that provices a few useful bits of information for API consumption.",
+ "id" => "api-status",
+ "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("status", function() {
+ global $version, $env, $settings, $actions;
+
+ // Make sure the client can accept JSON
+ if(!accept_contains_mime($_SERVER["HTTP_ACCEPT"] ?? "application/json", "application/json")) {
+ http_response_code(406);
+ header("content-type: text/plain");
+
+ exit("Unfortunately, this API is currently only available in application/json at the moment, which you haven't indicated you accept in your http accept header. You said this in your accept header:\n" . $_SERVER["HTTP_ACCEPT"]);
+ }
+
+ $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(json_encode($result, JSON_PRETTY_PRINT) . "\n");
+ });
+
+ add_help_section("960-api-status", "Wiki Status API", "");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/extra-sidebar.php.txt b/docs/ModuleApi/files/modules/extra-sidebar.php.txt
new file mode 100644
index 0000000..cebfb36
--- /dev/null
+++ b/docs/ModuleApi/files/modules/extra-sidebar.php.txt
@@ -0,0 +1,122 @@
+ "Sidebar",
+ "version" => "0.3.1",
+ "author" => "Starbeamrainbowlabs",
+ "description" => "Adds a sidebar to the left hand side of every page. Add '\$settings->sidebar_show = true;' to your configuration, or append '&sidebar=yes' to the url to enable. Adding to the url sets a cookie to remember your setting.",
+ "id" => "extra-sidebar",
+ "code" => function() {
+ global $settings;
+
+ $show_sidebar = false;
+
+ // Show the sidebar if it is enabled in the settings
+ if(isset($settings->sidebar_show) && $settings->sidebar_show === true)
+ $show_sidebar = true;
+
+ // Also show and persist the sidebar if the special GET parameter
+ // sidebar is seet
+ if(!$show_sidebar && isset($_GET["sidebar"]))
+ {
+ $show_sidebar = true;
+ // Set a cookie to persist the display of the sidebar
+ setcookie("sidebar_show", "true", time() + (60 * 60 * 24 * 30));
+ }
+
+ // Show the sidebar if the cookie is set
+ if(!$show_sidebar && isset($_COOKIE["sidebar_show"]))
+ $show_sidebar = true;
+
+ // Delete the cookie and hide the sidebar if the special GET paramter
+ // nosidebar is set
+ if(isset($_GET["nosidebar"]))
+ {
+ $show_sidebar = false;
+ unset($_COOKIE["sidebar_show"]);
+ setcookie("sidebar_show", null, time() - 3600);
+ }
+
+ page_renderer::register_part_preprocessor(function(&$parts) use ($show_sidebar) {
+ global $settings, $pageindex, $env;
+
+ // Don't render a sidebar if the user is logging in and a login is
+ // required in order to view pages.
+ if($settings->require_login_view && in_array($env->action, [ "login", "checklogin" ]))
+ return false;
+
+ if($show_sidebar && !isset($_GET["printable"]))
+ {
+ // Show the sidebar
+ $exec_start = microtime(true);
+
+ // Sort the pageindex
+ $sorted_pageindex = get_object_vars($pageindex);
+ ksort($sorted_pageindex, SORT_NATURAL);
+
+ $sidebar_contents = "";
+ $sidebar_contents .= render_sidebar($sorted_pageindex);
+
+ $parts["{body}"] = "
+
$settings->sitename has an optional sidebar which displays a list of all the current pages (but not subpages) that it is currently hosting. It may or may not be enabled.
+
If it isn't enabled, it can be enabled for your current browser only by appending sidebar=yes to the current page's query string.
");
+ }
+]);
+
+/**
+ * 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 = " $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 .= "
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.
Your comment couldn't be posted because it was too long. $settings->sitenamae can only post comments that are up to $settings->comment_max_length characters in length, and yours was $message_length characters. Try splitting it up into multiple comments! Here's the comment you tried to post:
+ "));
+ }
+
+ // Figure out where the comments are stored
+ $comment_filename = get_comment_filename($env->page);
+ if(!file_exists($comment_filename)) {
+ if(file_put_contents($comment_filename, "[]\n") === false) {
+ http_response_code(503);
+ exit(page_renderer::renderer_main("Error posting comment - $settings->sitename", "
$settings->sitename ran into a problem whilst creating a file to save your comment to! Please contact $settings->admindetails_name, $settings->sitename's administrator and tell them about this problem.
$settings->sitename couldn't post your comment because it couldn't find the parent comment you replied to. It's possible that $settings->admindetails_name, $settings->sitename's administrator, deleted the comment. Here's the comment you tried to post:
+ "));
+ }
+
+ $parent_comment->replies[] = $new_comment;
+
+ // Get an array of all the parent comments we need to notify
+ $comment_thread = fetch_comment_thread($comment_data, $parent_comment->id);
+
+ $email_subject = "[Notification] $env->user replied to your comment on $env->page - $settings->sitename";
+
+ foreach($comment_thread as $thread_comment) {
+ $email_body = "Hello, {username}!\n" .
+ "It's $settings->sitename here, letting you know that " .
+ "someone replied to your comment (or a reply to your comment) on $env->page.\n" .
+ "\n" .
+ "They said:\n" .
+ "\n" .
+ "$new_comment->message" .
+ "\n" .
+ "You said on " . date("c", strtotime($thread_comment->timestamp)) . ":\n" .
+ "\n" .
+ "$thread_comment->message\n" .
+ "\n";
+
+ email_user($thread_comment->username, $email_subject, $email_body);
+ }
+ }
+
+ // Save the comments back to disk
+ if(file_put_contents($comment_filename, json_encode($comment_data, JSON_PRETTY_PRINT)) === false) {
+ http_response_code(503);
+ exit(page_renderer::renderer_main("Error posting comment - $settings->sitename", "
$settings->sitename ran into a problem whilst saving your comment to disk! Please contact $settings->admindetails_name, $settings->sitename's administrator and tell them about this problem.
Your comment on $env->page was posted successfully. If your browser doesn't redirect you automagically, please click here to go to the comment you posted on the page you were viewing.
";
+
+ $parts["{extra}"] = $comments_html . $parts["{extra}"];
+
+ $parts["{content}"] = str_replace_once("", "\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", "
$settings->sitename has a threaded commenting system on every page. You can find it below each page's content, and can either leave a new comment, or reply to an existing one. If you reply to an existing one, then the authors of all the comments above yours will get notified by email of your reply - so long as they have an email address registered in their preferences.
");
+ }
+]);
+
+/**
+ * Given a page name, returns the absolute file path in which that page's
+ * comments are stored.
+ * @package feature-comments
+ * @param string $pagename The name pf the page to fetch the comments filename for.
+ * @return string The path to the file that the
+ */
+function get_comment_filename($pagename)
+{
+ global $env;
+ $pagename = makepathsafe($pagename);
+ return "$env->storage_prefix$pagename.comments.json";
+}
+
+/**
+ * Generates a new random comment id.
+ * @package feature-comments
+ * @return string A new random comment id.
+ */
+function generate_comment_id()
+{
+ $result = base64_encode(random_bytes(16));
+ $result = str_replace(["+", "/", "="], ["-", "_"], $result);
+ return $result;
+}
+
+/**
+ * Finds the comment with specified id by way of an almost-breadth-first search.
+ * @package feature-comments
+ * @param array $comment_data The comment data to search.
+ * @param string $comment_id The id of the comment to find.
+ * @return object The comment data with the specified id, or
+ * false if it wasn't found.
+ */
+function find_comment($comment_data, $comment_id)
+{
+ $subtrees = [];
+ foreach($comment_data as $comment)
+ {
+ if($comment->id === $comment_id)
+ return $comment;
+
+ if(count($comment->replies) > 0) {
+ $subtrees[] = $comment->replies;
+ }
+ }
+
+ foreach($subtrees as $subtree)
+ {
+ $subtree_result = find_comment($subtree, $comment_id);
+ if($subtree_result !== false)
+ return $subtree_result;
+ }
+
+ return false;
+}
+
+/**
+ * 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;
+
+ if(count($comments_data) == 0) {
+ if($depth == 0)
+ return "
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!
Your upload couldn't be processed because uploads are currently disabled on $settings->sitename. Go back to the main page.
"));
+ }
+
+ // Make sure that the user is logged in
+ if(!$env->is_logged_in)
+ {
+ if(!empty($_FILES["file"]))
+ unlink($_FILES["file"]["tmp_name"]);
+ http_response_code(401);
+ exit(page_renderer::render("Upload failed - $settings->sitename", "
Your upload couldn't be processed because you are not logged in.
Try logging in first."));
+ }
+
+ // Check for php upload errors
+ if($_FILES["file"]["error"] > 0)
+ {
+ if(!empty($_FILES["file"]))
+ unlink($_FILES["file"]["tmp_name"]);
+ if($_FILES["file"]["error"] == 1 || $_FILES["file"]["error"] == 2)
+ http_response_code(413); // file is too large
+ else
+ http_response_code(500); // something else went wrong
+ exit(page_renderer::render("Upload failed - $settings->sitename", "
Your upload couldn't be processed because " . (($_FILES["file"]["error"] == 1 || $_FILES["file"]["error"] == 2) ? "the file is too large" : "an error occurred") . ".
Please contact $settings->admindetails_name, $settings->sitename's administrator for help.
$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) . ".
That file appears to be unsuitable as an avatar, as $settings->sitename has detected it to be of type $mime_type, which doesn't appear to be an image. Please try uploading a different file to use as your avatar.
"));
+ }
+
+ 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", "aspx" ]))
+ {
+ http_response_code(415);
+ exit(page_renderer::render("Upload Error - $settings->sitename", "
The file you uploaded appears to be dangerous and has been discarded. Please contact $settings->sitename's administrator for assistance.
+
Additional information: The file uploaded appeared to be of type $mime_type, which mapped onto the extension $file_extension. This file extension has the potential to be executed accidentally by the web server.
"));
+ }
+
+ // 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", "
A page or file has already been uploaded with the name '$new_filename'. Try deleting it first. If you do not have permission to delete things, try contacting one of the moderators.
"));
+
+ //Â Delete the previously uploaded avatar, if it exists
+ //Â In the future we _may_ not need this once we have
+ //Â file history online.
+ if($is_avatar && isset($pageindex->$new_pagepath) && $pageindex->$new_pagepath->uploadedfile)
+ unlink($pageindex->$new_pagepath->uploadedfilepath);
+
+ // Make sure that the palce we're uploading to exists
+ if(!file_exists(dirname($env->storage_prefix . $new_filename)))
+ mkdir(dirname($env->storage_prefix . $new_filename), 0775, true);
+
+ if(!move_uploaded_file($temp_filename, $env->storage_prefix . $new_filename))
+ {
+ http_response_code(409);
+ exit(page_renderer::render("Upload Error - $settings->sitename", "
The file you uploaded was valid, but $settings->sitename couldn't verify that it was tampered with during the upload process. This probably means that either is a configuration error, or that $settings->sitename has been attacked. Please contact " . $settings->admindetails_name . ", your $settings->sitename Administrator.
"));
+ }
+
+ $description = $_POST["description"] ?? "_(No description provided)_\n";
+
+ // Escape the raw html in the provided description if the setting is enabled
+ if($settings->clean_raw_html)
+ $description = htmlentities($description, ENT_QUOTES);
+
+ file_put_contents($env->storage_prefix . $new_description_filename, $description);
+
+ // Construct a new entry for the pageindex
+ $entry = new stdClass();
+ // Point to the description's filepath since this property
+ // should point to a markdown file
+ $entry->filename = $new_description_filename;
+ $entry->size = strlen($description ?? "(No description provided)");
+ $entry->lastmodified = time();
+ $entry->lasteditor = $env->user;
+ $entry->uploadedfile = true;
+ $entry->uploadedfilepath = $new_filename;
+ $entry->uploadedfilemime = $mime_type;
+ // Add the new entry to the pageindex
+ // Assign the new entry to the image's filepath as that
+ // should be the page name.
+ $pageindex->$new_pagepath = $entry;
+
+ // Generate a revision to keep the page history up to date
+ if(module_exists("feature-history"))
+ {
+ $oldsource = ""; // Only variables can be passed by reference, not literals
+ history_add_revision($entry, $description, $oldsource, false);
+ }
+
+ // Save the pageindex
+ file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT));
+
+ if(module_exists("feature-recent-changes"))
+ {
+ add_recent_change([
+ "type" => "upload",
+ "timestamp" => time(),
+ "page" => $new_pagepath,
+ "user" => $env->user,
+ "filesize" => filesize($env->storage_prefix . $entry->uploadedfilepath)
+ ]);
+ }
+
+ header("location: ?action=view&page=$new_pagepath&upload=success");
+
+ break;
+ }
+ });
+
+ /**
+ * @api {get} ?action=preview&page={pageName}[&size={someSize}] Get a preview of a file
+ * @apiName PreviewFile
+ * @apiGroup Upload
+ * @apiPermission Anonymous
+ *
+ * @apiParam {string} page The name of the file to preview.
+ * @apiParam {number} size Optional. The size fo the resulting preview. Will be clamped to fit within the bounds specified in the wiki's settings. May also be set to the keyword 'original', which will cause the original file to be returned with it's appropriate mime type instead.
+ *
+ * @apiError PreviewNoFileError No file was found associated with the specified page.
+ * @apiError PreviewUnknownFileTypeError Pepperminty Wiki was unable to generate a preview for the requested file's type.
+ */
+
+ /*
+ * ██████ ██████ ███████ ██ ██ ██ ███████ ██ ██
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
+ * ██████ ██████ █████ ██ ██ ██ █████ ██ █ ██
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██
+ * ██ ██ ██ ███████ ████ ██ ███████ ███ ███
+ */
+ add_action("preview", function() {
+ global $settings, $env, $pageindex, $start_time;
+
+ if(empty($pageindex->{$env->page}->uploadedfilepath))
+ {
+ $im = errorimage("The page '$env->page' doesn't have an associated file.");
+ header("content-type: image/png");
+ imagepng($im);
+ exit();
+ }
+
+ $filepath = realpath($env->storage_prefix . $pageindex->{$env->page}->uploadedfilepath);
+ $mime_type = $pageindex->{$env->page}->uploadedfilemime;
+ $shortFilename = substr($filepath, 1 + (strrpos($filepath, '/') !== false ? strrpos($filepath, '/') : -1));
+
+ header("content-disposition: inline; filename=\"$shortFilename\"");
+ header("last-modified: " . gmdate('D, d M Y H:i:s T', $pageindex->{$env->page}->lastmodified));
+
+ // If the size is set 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
+
+ \n\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($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;
+
+ $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.
");
+ }
+]);
+
+/**
+ * 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), "sitename", "
$settings->sitename detected that you uploaded an SVG image and performed some extra security checks on your file. Whilst performing these checks it was discovered that the file you uploaded contains some Javascript, which could be dangerous. The uploaded file has been discarded. Go back to try again.
+
You may wish to consider opening an issue against Pepperminty Wiki (the software that powers $settings->sitename) if this isn't the first time that you have seen this message.
"));
+ }
+
+ // Find and return the size of the SVG image
+ return getsvgsize($temp_filename);
+}
+
+/**
+ * Calculates the size of the specified SVG file.
+ * @package feature-upload
+ * @param string $svgFilename The filename to calculate the size of.
+ * @return int[] The width and height respectively of the
+ * specified SVG file.
+ */
+function getsvgsize($svgFilename)
+{
+ $svg = simplexml_load_file($svgFilename); // Load it as XML
+ if($svg === false)
+ {
+ http_response_code(415);
+ exit(page_renderer::render("Upload Error - $settings->sitename", "
When $settings->sitename tried to open your SVG file for checking, it found some invalid syntax. The uploaded file has been discarded. Go back to try again.
Since you aren't logged in, you can't change your preferences. This is because stored preferences are tied to each registered user account. You can login here.
The email address you supplied ({$_POST['email-address']}) is too long. Email addresses can only be 320 characters long. Go back."));
+ }
+
+ if(mb_strpos($_POST["email-address"], "@") === false)
+ {
+ http_response_code(422);
+ exit(page_renderer::render_main("Error Saving Email Address - $settings->sitename", "
The email address you supplied ({$_POST['email-address']}) doesn't appear to be valid. Go back."));
+ }
+
+ $env->user_data->emailAddress = $_POST["email-address"];
+ }
+
+ // Save the user's preferences
+ if(!save_userdata())
+ {
+ http_response_code(503);
+ exit(page_renderer::render_main("Error Saving Preferences - $settings->sitename", "
$settings->sitename had some trouble saving your preferences! Please contact $settings->admindetails_name, $settings->sitename's administrator and tell them about this error if it still occurs in 5 minutes. They can be contacted by email at this address: " . hide_email($settings->admindetails_email) . ".
"));
+ });
+
+ /**
+ * @api {post} ?action=change-password Change your password
+ * @apiName ChangePassword
+ * @apiGroup Settings
+ * @apiPermission User
+ *
+ * @apiParam {string} current-pass Your current password.
+ * @apiParam {string} new-pass Your new password.
+ * @apiParam {string} new-pass-confirm Your new password again, to make sure you've typed it correctly.
+ *
+ * @apiError PasswordMismatchError The new password fields don't match.
+ */
+ add_action("change-password", function() {
+ global $env, $settings;
+
+ // Make sure the new password was typed correctly
+ // This comes before the current password check since that's more intensive
+ if($_POST["new-pass"] !== $_POST["new-pass-confirm"]) {
+ exit(page_renderer::render_main("Password mismatch - $settings->sitename", "
The new password you typed twice didn't match! Go back.
"));
+ }
+ // Check the current password
+ if(hash_password($_POST["current-pass"]) !== $env->user_data->password) {
+ exit(page_renderer::render_main("Password mismatch - $settings->sitename", "
Error: You typed your current password incorrectly! Go back.
"));
+ }
+
+ // All's good! Go ahead and change the password.
+ $env->user_data->password = hash_password($_POST["new-pass"]);
+ // Save the userdata back to disk
+ save_userdata();
+
+ http_response_code(307);
+ header("location: ?action=user-preferences&success=yes&operation=change-password");
+ exit(page_renderer::render_main("Password Changed Successfully", "
"));
+ });
+
+
+ /*
+ * █████ ██ ██ █████ ████████ █████ ██████
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
+ * ███████ ██ ██ ███████ ██ ███████ ██████
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
+ * ██ ██ ████ ██ ██ ██ ██ ██ ██ ██
+ */
+
+ /**
+ * @api {get} ?action=avatar&user={username}[&size={size}] Get a user's avatar
+ * @apiName Avatar
+ * @apiGroup Upload
+ * @apiPermission Anonymous
+ *
+ * @apiParam {string} user The username to fetch the avatar for
+ * @apiParam {string} size The preferred size of the avatar
+ */
+ add_action("avatar", function() {
+ global $settings;
+
+ $size = intval($_GET["size"] ?? 32);
+
+ /// Use gravatar if there's some issue with the requested user
+
+ // No user specified
+ if(empty($_GET["user"])) {
+ http_response_code(307);
+ header("x-reason: no-user-specified");
+ header("location: https://gravatar.com/avatar/?default=blank");
+ }
+
+ $requested_username = $_GET["user"];
+
+ // The user hasn't uploaded an avatar
+ if(empty($pageindex->{"User/$requested_username/Avatar"}) || !$pageindex->{"User/$requested_username/Avatar"}->uploadedfile) {
+ $user_fragment = !empty($settings->users->$requested_username->emailAddress) ? $settings->users->$requested_username->emailAddress : $requested_username;
+
+ http_response_code(307);
+ header("x-reason: no-avatar-found");
+ header("x-hash-method: " . ($user_fragment === $requested_username ? "username" : "email_address"));
+ header("location: https://gravatar.com/avatar/" . md5($user_fragment) . "?default=identicon&rating=g&size=$size");
+ exit();
+ }
+
+ // The user has uploaded an avatar, so we can redirec to the regular previewer :D
+
+ http_response_code(307);
+ header("x-reason: found-local-avatar");
+ header("location: ?action=preview&size=$size&page=" . urlencode("Users/$requested_username/Avatar"));
+ exit("This user's avatar can be found at Files/$requested_username/Avatar");
+ });
+
+ // Display a help section on the user preferences, but only if the user
+ // is logged in and so able to access them
+ if($env->is_logged_in)
+ {
+ add_help_section("910-user-preferences", "User Preferences", "
As you are logged in, $settings->sitename lets you configure a selection of personal preferences. These can be viewed and tweaked to you liking over on the preferences page, which can be accessed at any time by clicking the cog icon (it looks something like this: $settings->user_preferences_button_text), though the administrator of $settings->sitename ($settings->admindetails_name) may have changed its appearance.
$settings->sitename allows you to upload an avatar and have it displayed next to your name. If you don't have an avatar uploaded yet, then $settings->sitename will take a hash of your email address and ask Gravatar for for your Gravatar instead. If you haven't told $settings->sitename what your email address is either, a hash of your username is used instead. If you don't have a gravatar, then $settings->sitename asks Gravatar for an identicon instead.
+
Your avatar on $settings->sitename currently looks like this: " . ($settings->upload_enabled ? " - you can upload a new one by going to your preferences, or clicking here." : ", but $settings->sitename currently has uploads disabled, so you can't upload a new one directly to $settings->sitename. You can, however, set your email address in your preferences and create a Gravatar, and then it should show up here on $settings->sitename shortly.") . "
$settings->sitename is powered by Pepperminty Wiki - an entire wiki packed inside a single file, which was built by Starbeamrainbowlabs, and can be found on GitHub (contributors will also be listed here in the future). Pepperminty Wiki is licensed under the Mozilla Public License 2.0 (simple version).
As a moderator, $settings->sitename gives you the ability to generate a report on $settings->sitename's installation of Pepperminty Wiki for debugging purposes.
+
To generate such a report, visit the debug action or click here.
");
+ }
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-delete.php.txt b/docs/ModuleApi/files/modules/page-delete.php.txt
new file mode 100644
index 0000000..e84379d
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-delete.php.txt
@@ -0,0 +1,120 @@
+ "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", "
You tried to delete $env->page, but editing is disabled on this wiki.
+
If you wish to delete this page, please re-enable editing on this wiki first.
You tried to delete $env->page, but you as aren't a moderator you don't have permission to do that.
+
You could try logging in as an admin, or asking one of $settings->sitename's friendly moderators (find their names at the bottom of every page!) to delete it for you.
You are about to delete$env->page" . (module_exists("feature-history")?" and all its revisions":"") . (module_exists("feature-comments")?" and all its comments":"") . ". You can't undo this!
Click here to go back."));
+ }
+ $page = $env->page;
+ // Delete the associated file if it exists
+ if(!empty($pageindex->$page->uploadedfile))
+ {
+ unlink($env->storage_prefix . $pageindex->$page->uploadedfilepath);
+ }
+
+ // While we're at it, we should delete all the revisions too
+ foreach($pageindex->{$env->page}->history as $revisionData)
+ {
+ unlink($env->storage_prefix . $revisionData->filename);
+ }
+
+ // If the commenting module is installed and the page has comments,
+ // delete those too
+ if(module_exists("feature-comments") and
+ file_exists(get_comment_filename($env->page)))
+ {
+ unlink(get_comment_filename($env->page));
+ }
+
+ // Delete the page from the page index
+ unset($pageindex->$page);
+
+ // Save the new page index
+ file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT));
+
+ // Remove the page's name from the id index
+ ids::deletepagename($env->page);
+
+ // Delete the page from the search index, if that module is installed
+ if(module_exists("feature-search"))
+ {
+ $pageid = ids::getid($env->page);
+ $invindex = search::load_invindex($paths->searchindex);
+ search::delete_entry($invindex, $pageid);
+ search::save_invindex($paths->searchindex, $invindex);
+ }
+
+ // Delete the page from the disk
+ unlink("$env->storage_prefix$env->page.md");
+
+ // Add a recent change announcing the deletion if the recent changes
+ // module is installed
+ if(module_exists("feature-recent-changes"))
+ {
+ add_recent_change([
+ "type" => "deletion",
+ "timestamp" => time(),
+ "page" => $env->page,
+ "user" => $env->user,
+ ]);
+ }
+
+ exit(page_renderer::render_main("Deleting $env->page - $settings->sitename", "
"));
+ });
+
+ // Register a help section
+ add_help_section("60-delete", "Deleting Pages", "
If you are logged in as an adminitrator, then you have the power to delete pages. To do this, click "Delete" in the "More..." menu when browsing the pge you wish to delete. When you are sure that you want to delete the page, click the given link.
+
Warning: Once a page has been deleted, you can't bring it back! You will need to recover it from your backup, if you have one (which you really should).
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-edit.php.txt b/docs/ModuleApi/files/modules/page-edit.php.txt
new file mode 100644
index 0000000..52ee6c2
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-edit.php.txt
@@ -0,0 +1,459 @@
+ "Page editor",
+ "version" => "0.16",
+ "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;
+
+ /**
+ * @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 Page
+ * @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";
+ $page = $env->page;
+ $creatingpage = !isset($pageindex->$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->$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->$page) and // or if the page exists
+ isset($pageindex->$page->protect) and // the protect property exists
+ $pageindex->$page->protect and // the protect property is true
+ !$env->is_admin // the user isn't an admin
+ ) or
+ $isOtherUsersPage // this page actually belongs to another user
+ )
+ {
+ if(!$creatingpage)
+ {
+ // The page already exists - let the user view the page source
+ $sourceViewContent = "
$settings->sitename does not allow anonymous users to make edits. You can view the source of $env->page below, but you can't edit it. You could, however, try logging in.
$env->page is a special user page which acutally belongs to " . extract_user_from_userpage($env->page) . ", another user on $settings->sitename. Because of this, you are not allowed to edit it (though you can always edit your own page and any pages under it if you're logged in). You can, however, vieww it's source below.
";
+
+ // Append a view of the page's source
+ $sourceViewContent .= "";
+
+ exit(page_renderer::render_main("Viewing source for $env->page", $sourceViewContent));
+ }
+ else
+ {
+ $errorMessage = "
The page $env->page does not exist, but you do not have permission to create it.
If you haven't already, perhaps you should try logging in.
Warning: You are not logged in! Your IP address may be recorded.
";
+ }
+
+ // Include preview, if set
+ if(isset($_POST['preview-edit']) && isset($_POST['content'])) {
+ // Need this for the prev-content-hash to prevent the conflict page from appearing
+ $old_pagetext = $pagetext;
+
+ // set the page content to the newly edited content
+ $pagetext = $_POST['content'];
+
+ // Set the tags to the new tags, if needed
+ if(isset($_POST['tags']))
+ $page_tags = $_POST['tags'];
+
+ // Insert the "view" part of the page we're editing
+ $content .= "
This is only a preview, so your edits haven't been saved! Scroll down to continue editing.
" . parse_page_source($pagetext);
+
+ }
+
+ $content .= "";
+ // 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 ~~~ ///
+ // TODO: Add a button to press that restores the content that you were working on before.
+ page_renderer::AddJSSnippet('document.addEventListener("load", function(event) {
+ // Smart saving
+ function getSmartSaveKey() { 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
+ window.addEventListener("load", function(event) {
+ var editor = document.querySelector("textarea[name=content]");
+ if(editor.value.length > 0) return; // Don\'t restore if there\'s data in the editor already
+ editor.value = localStorage.getItem(getSmartSaveKey());
+ });
+});');
+
+ 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
+ * @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=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 EditPage
+ * @apiGroup Page
+ * @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("location: index.php?page=$env->page");
+ exit(page_renderer::render_main("Error saving edit", "
Editing is currently disabled on this wiki.
"));
+ }
+ if(!$env->is_logged_in and !$settings->anonedits)
+ {
+ http_response_code(403);
+ header("refresh: 5; url=index.php?page=$env->page");
+ exit("You are not logged in, so you are not allowed to save pages on $settings->sitename. Redirecting in 5 seconds....");
+ }
+ $page = $env->page;
+ if((
+ isset($pageindex->$page) and
+ isset($pageindex->page->protect) and
+ $pageindex->$page->protect
+ ) and !$env->is_admin)
+ {
+ http_response_code(403);
+ header("refresh: 5; url=index.php?page=$env->page");
+ exit("$env->page is protected, and you aren't logged in as an administrator or moderator. Your edit was not saved. Redirecting in 5 seconds...");
+ }
+ if(!isset($_POST["content"]))
+ {
+ http_response_code(400);
+ header("refresh: 5; url=index.php?page=$env->page");
+ exit("Bad request: No content specified.");
+ }
+
+ // Make sure that the directory in which the page needs to be saved exists
+ if(!is_dir(dirname("$env->storage_prefix$env->page.md")))
+ {
+ // Recursively create the directory if needed
+ mkdir(dirname("$env->storage_prefix$env->page.md"), 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 = "
Warning: You are not logged in! Your IP address may be recorded.
";
+ }
+ $content .= "
An edit conflict has arisen because someone else has saved an edit to $env->page since you started editing it. Both texts are shown below, along the differences between the 2 conflicting revisions. To continue, please merge your changes with the existing content. Note that only the text in the existing content box will be kept when you press the \"Resolve Conflict\" button at the bottom of the page.
+
+ ";
+
+ // Insert a reference to jsdiff to generate the diffs
+ $diffScript = <<<'DIFFSCRIPT'
+window.addEventListener("load", function(event) {
+ var destination = document.getElementById("highlighted-diff"),
+ diff = JsDiff.diffWords(document.getElementById("original-content").value, document.getElementById("new-content").value),
+ output = "";
+ diff.forEach(function(change) {
+ var classes = "token";
+ if(change.added) classes += " diff-added";
+ if(change.removed) classes += " diff-removed";
+ output += `${change.value}`;
+ });
+ destination.innerHTML = output;
+});
+DIFFSCRIPT;
+
+ $content .= "\n
+ \n";
+
+ 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)
+ {
+ $page = $env->page;
+ // Make sure that this page's parents exist
+ check_subpage_parents($page);
+
+ // Update the page index
+ if(!isset($pageindex->$page))
+ {
+ $pageindex->$page = new stdClass();
+ $pageindex->$page->filename = "$env->page.md";
+ }
+ $pageindex->$page->size = strlen($_POST["content"]);
+ $pageindex->$page->lastmodified = time();
+ if($env->is_logged_in)
+ $pageindex->$page->lasteditor = utf8_encode($env->user);
+ else // TODO: Add an option to record the user's IP here instead
+ $pageindex->$page->lasteditor = utf8_encode("anonymous");
+ $pageindex->$page->tags = $page_tags;
+
+ // A hack to resave the pagedata if the preprocessors have
+ // changed it. We need this because the preprocessors *must*
+ // run _after_ the pageindex has been updated.
+ $pagedata_orig = $pagedata;
+
+ // Execute all the preprocessors
+ foreach($save_preprocessors as $func)
+ {
+ $func($pageindex->$page, $pagedata, $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=$env->page&edit_status=success&redirect=no");
+ exit();
+ }
+ else
+ {
+ http_response_code(507);
+ exit(page_renderer::render_main("Error saving page - $settings->sitename", "
$settings->sitename failed to write your changes to the server's disk. Your changes have not been saved, but you might be able to recover your edit by pressing the back button in your browser.
+
Please tell the administrator of this wiki (" . $settings->admindetails_name . ") about this problem.
To edit a page on $settings->sitename, click the edit button on the top bar. Note that you will probably need to be logged in. If you do not already have an account you will need to ask $settings->sitename's administrator for an account since there is no registration form. Note that the $settings->sitename's administrator may have changed these settings to allow anonymous edits.
+
Editing is simple. The edit page has a sizeable box that contains a page's current contents. Once you are done altering it, add or change the comma separated list of tags in the field below the editor and then click save page.
+
A reference to the syntax that $settings->sitename supports can be found below.
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-export.php.txt b/docs/ModuleApi/files/modules/page-export.php.txt
new file mode 100644
index 0000000..ad03430
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-export.php.txt
@@ -0,0 +1,77 @@
+ "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. Return to the $settings->defaultpage."));
+ }
+
+ $tmpfilename = tempnam(sys_get_temp_dir(), "pepperminty-wiki-");
+
+ $zip = new ZipArchive();
+
+ if($zip->open($tmpfilename, ZipArchive::CREATE) !== true)
+ {
+ http_response_code(507);
+ exit(page_renderer::render("Export error - $settings->sitename", "Pepperminty Wiki was unable to open a temporary file to store the exported data in. Please contact $settings->sitename's administrator (" . $settings->admindetails_name . " at " . hide_email($settings->admindetails_email) . ") for assistance."));
+ }
+
+ foreach($pageindex as $entry)
+ {
+ $zip->addFile("$env->storage_prefix$entry->filename", $entry->filename);
+ }
+
+ if($zip->close() !== true)
+ {
+ http_response_code(500);
+ exit(page_renderer::render("Export error - $settings->sitename", "Pepperminty wiki was unable to close the temporary zip file after creating it. Please contact $settings->sitename's administrator (" . $settings->admindetails_name . " at " . hide_email($settings->admindetails_email) . ") for assistance."));
+ }
+
+ header("content-type: application/zip");
+ header("content-disposition: attachment; filename=$settings->sitename-export.zip");
+ header("content-length: " . filesize($tmpfilename));
+
+ $zip_handle = fopen($tmpfilename, "rb");
+ fpassthru($zip_handle);
+ fclose($zip_handle);
+ unlink($tmpfilename);
+ });
+
+ // Add a section to the help page
+ add_help_section("50-export", "Exporting", "
$settings->sitename supports exporting the entire wiki's content as a zip. Note that you may need to be a moderator in order to do this. Also note that you should check for permission before doing so, even if you are able to export without asking.
+
To perform an export, go to the credits page and click "Export as zip - Check for permission first".
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-help.php.txt b/docs/ModuleApi/files/modules/page-help.php.txt
new file mode 100644
index 0000000..af52333
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-help.php.txt
@@ -0,0 +1,154 @@
+ "Help page",
+ "version" => "0.9.3",
+ "author" => "Starbeamrainbowlabs",
+ "description" => "Adds a rather useful help page. Access through the 'help' action. This module also exposes help content added to Pepperminty Wiki's inbuilt invisible help section system.",
+ "id" => "page-help",
+ "code" => function() {
+ global $settings;
+
+ /**
+ * @api {get} ?action=help[&dev=yes] Get a help page
+ * @apiDescription Get a customised help page. This page will be slightly different for every wiki, depending on their name, settings, and installed modules.
+ * @apiName Help
+ * @apiGroup Utility
+ * @apiPermission Anonymous
+ *
+ * @apiParam {string} dev Set to 'yes' to get a developer help page instead. The developer help page gives some general information about which modules and help page sections are registered, and other various (non-sensitive) settings.
+ */
+
+ /*
+ * ██ ██ ███████ ██ ██████
+ * ██ ██ ██ ██ ██ ██
+ * ███████ █████ ██ ██████
+ * ██ ██ ██ ██ ██
+ * ██ ██ ███████ ███████ ██
+ */
+ add_action("help", function() {
+ global $env, $paths, $settings, $version, $help_sections, $actions;
+
+ // Sort the help sections by key
+ ksort($help_sections, SORT_NATURAL);
+
+ if(isset($_GET["dev"]) and $_GET["dev"] == "yes")
+ {
+ $title = "Developers Help - $settings->sitename";
+ $content = "
$settings->sitename runs on Pepperminty Wiki, an entire wiki packed into a single file. This page contains some information that developers may find useful.
+
A full guide to developing a Pepperminty Wiki module can be found on GitHub.
+
Registered Help Sections
+
The following help sections are currently registered:
The page index is currently " . human_filesize(filesize($paths->pageindex)) . " in size, and took " . $env->perfdata->pageindex_decode_time . "ms to decode.
The search index is currently " . human_filesize(filesize($paths->searchindex)) . " in size, and took " . $env->perfdata->searchindex_decode_time . "ms to decode.
";
+ }
+
+ $content .= "
The id index is currently " . human_filesize(filesize($paths->idindex)) . " in size, and took " . $env->perfdata->idindex_decode_time . "ms to decode.
$settings->sitename is powered by Pepperminty Wiki, a complete wiki in a box you can drop into your server and expect it to just work.
";
+
+ // Todo Insert a table of contents here?
+
+ foreach($help_sections as $index => $section)
+ {
+ // Todo add a button that you can click to get a permanent link
+ // to this section.
+ $content .= "
" . $section["title"] . "
\n";
+ $content .= $section["content"] . "\n";
+ }
+ }
+
+ exit(page_renderer::render_main($title, $content));
+ });
+
+ // Register a help section on general navigation
+ add_help_section("5-navigation", "Navigating", "
All the navigation links can be found on the top bar, along with a search box (if your site administrator has enabled it). There is also a "More..." menu in the top right that contains some additional links that you may fine useful.
+
This page, along with the credits page, can be found on the bar at the bottom of every page.
You can find out whch version of Pepperminty Wiki $settings->sitename is using by visiting the credits page.
+
Information for developers can be found on this page.
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-list.php.txt b/docs/ModuleApi/files/modules/page-list.php.txt
new file mode 100644
index 0000000..17a85e6
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-list.php.txt
@@ -0,0 +1,154 @@
+ "Page list",
+ "version" => "0.10.3",
+ "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 List all pages
+ * @apiDescription Gets a list of all the pages currently stored on the wiki.
+ * @apiName ListPages
+ * @apiGroup Page
+ * @apiPermission Anonymous
+ */
+
+ /*
+ * ██ ██ ███████ ████████
+ * ██ ██ ██ ██
+ * ██ ██ ███████ ██
+ * ██ ██ ██ ██
+ * ███████ ██ ███████ ██
+ */
+ add_action("list", function() {
+ global $pageindex, $settings;
+
+ $title = "All Pages";
+ $content = "
$title on $settings->sitename
";
+
+ $sorted_pageindex = get_object_vars($pageindex);
+ ksort($sorted_pageindex, SORT_NATURAL);
+
+ $content .= generate_page_list(array_keys($sorted_pageindex));
+ exit(page_renderer::render_main("$title - $settings->sitename", $content));
+ });
+
+ /**
+ * @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.
+ */
+
+ /*
+ * ██ ██ ███████ ████████ ████████ █████ ██████ ███████
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██
+ * ██ ██ ███████ ██ █████ ██ ███████ ██ ███ ███████
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
+ * ███████ ██ ███████ ██ ██ ██ ██ ██████ ███████
+ */
+ add_action("list-tags", function() {
+ global $pageindex, $settings;
+
+ if(!isset($_GET["tag"]))
+ {
+ // Render a list of all tags
+ $all_tags = [];
+ foreach($pageindex as $entry)
+ {
+ if(!isset($entry->tags)) continue;
+ foreach($entry->tags as $tag)
+ {
+ if(!in_array($tag, $all_tags)) $all_tags[] = $tag;
+ }
+ }
+
+ sort($all_tags, SORT_NATURAL);
+
+ $content = "
\n";
+
+ exit(page_renderer::render("$tag - Tag List - $settings->sitename", $content));
+ });
+
+ add_help_section("30-all-pages-tags", "Listing pages and tags", "
All the pages and tags on $settings->sitename are listed on a pair of pages to aid navigation. The list of all pages on $settings->sitename can be found by clicking "All Pages" on the top bar. The list of all the tags currently in use can be found by clicking "All Tags" in the "More..." menu in the top right.
+
Each tag on either page can be clicked, and leads to a list of all pages that possess that particular tag.
+
Redirect pages are shown in italics. A page's last known editor is also shown next to each entry on a list of pages, along with the last known size (which should correct, unless it was changed outside of $settings->sitename) and the time since the last modification (hovering over this will show the exact time that the last modification was made in a tooltip).
");
+ }
+]);
+
+/**
+ * Renders a list of pages as HTML.
+ * @package page-list
+ * @param string[] $pagelist A list of page names to include in the list.
+ * @return string The specified list of pages as HTML.
+ */
+function generate_page_list($pagelist)
+{
+ global $pageindex;
+ // ✎ ✎ 🕒 🕒
+ $result = "
\n";
+ foreach($pagelist as $pagename)
+ {
+ // Construct a list of tags that are attached to this page ready for display
+ $tags = "";
+ // Make sure that this page does actually have some tags first
+ if(isset($pageindex->$pagename->tags))
+ {
+ foreach($pageindex->$pagename->tags as $tag)
+ {
+ $tags .= "$tag, ";
+ }
+ $tags = substr($tags, 0, -2); // Remove the last ", " from the tag list
+ }
+
+ $pageDisplayName = $pagename;
+ if(isset($pageindex->$pagename) and
+ !empty($pageindex->$pagename->redirect))
+ $pageDisplayName = "$pageDisplayName";
+
+ $result .= "
$settings->sitename requires that you login before continuing.
\n";
+ $content .= "\t\t\n";
+ exit(page_renderer::render_main($title, $content));
+ });
+
+ /**
+ * @api {post} ?action=checklogin Perform a login
+ * @apiName CheckLogin
+ * @apiGroup Authorisation
+ * @apiPermission Anonymous
+ *
+ * @apiParam {string} user The user name to login with.
+ * @apiParam {string} password 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($settings->users->$user->password == hash_password($pass))
+ {
+ $env->is_logged_in = true;
+ $expiretime = time() + 60*60*24*30; //30 days from now
+ $_SESSION["$settings->sessionprefix-user"] = $user;
+ $_SESSION["$settings->sessionprefix-pass"] = hash_password($pass);
+ $_SESSION["$settings->sessionprefix-expiretime"] = $expiretime;
+ //redirect to wherever the user was going
+ http_response_code(302);
+ if(isset($_GET["returnto"]))
+ header("location: " . $_GET["returnto"]);
+ else
+ header("location: index.php");
+ exit();
+ }
+ else
+ {
+ http_response_code(302);
+ $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();
+ }
+ });
+
+ // Register a section on logging in on the help page.
+ add_help_section("30-login", "Logging in", "
In order to edit $settings->sitename and have your edit attributed to you, you need to be logged in. Depending on the settings, logging in may be a required step if you want to edit at all. Thankfully, loggging in is not hard. Simply click the "Login" link in the top left, type your username and password, and then click login.
+
If you do not have an account yet and would like one, try contacting $settings->admindetails_name, $settings->sitename's administrator and ask them nicely to see if they can create you an account.
");
+ }
+]);
+
+/**
+ * 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)
+{
+ global $settings;
+ if($settings->use_sha3)
+ {
+ return sha3($pass, 256);
+ }
+ else
+ {
+ return hash("sha256", $pass);
+ }
+}
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-logout.php.txt b/docs/ModuleApi/files/modules/page-logout.php.txt
new file mode 100644
index 0000000..a64870b
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-logout.php.txt
@@ -0,0 +1,41 @@
+ "Logout",
+ "version" => "0.6",
+ "author" => "Starbeamrainbowlabs",
+ "description" => "Adds an action to let users user out. For security reasons it is wise to add this module since logging in automatically opens a session that is valid for 30 days.",
+ "id" => "page-logout",
+ "code" => function() {
+
+ /**
+ * @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->pass);
+ //clear the session variables
+ $_SESSION = [];
+ session_destroy();
+
+ exit(page_renderer::render_main("Logout Successful", "
Whilst moving the file associated with $env->page, $settings->sitename detected a pre-existing file on the server's file system. Because $settings->sitename can't determine whether the existing file is important to another component of $settings->sitename or it's host web server, the move have been aborted - just in case.
+
If you know that this move is actually safe, please get your site administrator (" . $settings->admindetails_name . ") to perform the move manually. Their contact address can be found at the bottom of every page (including this one).
"));
+
+ // Move the page in the page index
+ $pageindex->$new_name = new stdClass();
+ foreach($pageindex->$page as $key => $value)
+ {
+ $pageindex->$new_name->$key = $value;
+ }
+ unset($pageindex->$page);
+ $pageindex->$new_name->filename = "$new_name.md";
+
+ // If this page has an associated file, then we should move that too
+ if(!empty($pageindex->$new_name->uploadedfile))
+ {
+ // Update the filepath to point to the description and not the image
+ $pageindex->$new_name->filename = $pageindex->$new_name->filename . ".md";
+ // Move the file in the pageindex
+ $pageindex->$new_name->uploadedfilepath = $new_name;
+ // Move the file on disk
+ rename($env->storage_prefix . $env->page, $env->storage_prefix . $new_name);
+ }
+
+ // Come to think about it, we should probably move the history while we're at it
+ foreach($pageindex->$new_name->history as &$revisionData)
+ {
+ // We're only interested in edits
+ if($revisionData->type !== "edit") continue;
+ $newRevisionName = $pageindex->$new_name->filename . ".r$revisionData->rid";
+ // Move the revision to it's new name
+ rename(
+ $env->storage_prefix . $revisionData->filename,
+ $env->storage_prefix . $newRevisionName
+ );
+ // Update the pageindex entry
+ $revisionData->filename = $newRevisionName;
+ }
+
+ // Save the updated pageindex
+ file_put_contents($paths->pageindex, json_encode($pageindex, JSON_PRETTY_PRINT));
+
+ // Move the page on the disk
+ rename("$env->storage_prefix$env->page.md", "$env->storage_prefix$new_name.md");
+
+ // Move the page in the id index
+ ids::movepagename($page, $new_name);
+
+ // Exit with a nice message
+ exit(page_renderer::render_main("Moving $env->page", "
"));
+ });
+
+ // Register a help section
+ add_help_section("60-move", "Moving Pages", "
If you are logged in as an administrator, then you have the power to move pages. To do this, click "Delete" 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".
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-update.php.txt b/docs/ModuleApi/files/modules/page-update.php.txt
new file mode 100644
index 0000000..56ea649
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-update.php.txt
@@ -0,0 +1,89 @@
+ "Update",
+ "version" => "0.6.2",
+ "author" => "Starbeamrainbowlabs",
+ "description" => "Adds an update page that downloads the latest stable version of Pepperminty Wiki. This module is currently outdated as it doesn't save your module preferences.",
+ "id" => "page-update",
+ "code" => function() {
+
+ /**
+ * @api {get} ?action=update[do=yes] Update the wiki
+ * @apiDescription Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. **Note also that this plugin is currently out of date. Use with extreme caution!**
+ * @apiName Update
+ * @apiGroup Utility
+ * @apiPermission Moderator
+ *
+ * @apiParam {string} do Set to 'yes' to actually do the upgrade. Omission causes a page asking whether an update is desired instead.
+ * @apiParam {string} secret The wiki's secret string that's stored in the settings.
+ *
+ * @apiUse UserNotModeratorError
+ * @apiParam InvalidSecretError The supplied secret doesn't match up with the secret stored in the wiki's settings.
+ */
+
+ /*
+ * ██ ██ ██████ ██████ █████ ████████ ███████
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
+ * ██ ██ ██████ ██ ██ ███████ ██ █████
+ * ██ ██ ██ ██ ██ ██ ██ ██ ██
+ * ██████ ██ ██████ ██ ██ ██ ███████
+ */
+ add_action("update", function() {
+ global $settings, $env;
+
+ if(!$env->is_admin)
+ {
+ http_response_code(401);
+ exit(page_renderer::render_main("Update - Error", "
You must be an administrator to do that.
"));
+ }
+
+ if(!isset($_GET["do"]) or $_GET["do"] !== "true" or $_GET["do"] !== "yes")
+ {
+ exit(page_renderer::render_main("Update $settings->sitename", "
This page allows you to update $settings->sitename.
+
Currently, $settings->sitename is using $settings->version of Pepperminty Wiki.
+
This script will automatically download and install the latest version of Pepperminty Wiki from the url of your choice (see settings), regardless of whether an update is actually needed (version checking isn't implemented yet).
+
To update $settings->sitename, fill out the form below and click click the update button.
+
Note that a backup system has not been implemented yet! If this script fails you will loose your wiki's code and have to re-build it.
You forgot to enter $settings->sitename's secret code or entered it incorrectly. $settings->sitename's secret can be found in the settings portion of index.php.
"));
+ }
+
+ $settings_separator = "/////////////// Do not edit below this line unless you know what you are doing! ///////////////";
+
+ $log = "Beginning update...\n";
+
+ $log .= "I am " . __FILE__ . ".\n";
+ $oldcode = file_get_contents(__FILE__);
+ $log .= "Fetching new code...";
+ $newcode = file_get_contents($settings->updateurl);
+ $log .= "done.\n";
+
+ $log .= "Rewriting " . __FILE__ . "...";
+ $settings = substr($oldcode, 0, strpos($oldcode, $settings_separator));
+ $code = substr($newcode, strpos($newcode, $settings_separator));
+ $result = $settings . $code;
+ $log .= "done.\n";
+
+ $log .= "Saving...";
+ file_put_contents(__FILE__, $result);
+ $log .= "done.\n";
+
+ $log .= "Update complete. I am now running on the latest version of Pepperminty Wiki.";
+ $log .= "The version number that I have updated to can be found on the credits or help ages.";
+
+ exit(page_renderer::render_main("Update - Success", "
\n";
+ foreach($userList as $username)
+ $content .= "\t
" . page_renderer::render_username($username) . "
\n";
+ $content .= "
\n";
+
+ exit(page_renderer::render_main("User List - $settings->sitename", $content));
+ });
+
+ 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.
");
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/page-view.php.txt b/docs/ModuleApi/files/modules/page-view.php.txt
new file mode 100644
index 0000000..a086e15
--- /dev/null
+++ b/docs/ModuleApi/files/modules/page-view.php.txt
@@ -0,0 +1,181 @@
+ "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] 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 hld 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", "
$env->page does not exist.
Since editing is currently disabled on this wiki, you may not create this page. If you feel that this page should exist, try contacting this wiki's Administrator.
"));
+ }
+ }
+
+ header("last-modified: " . gmdate('D, d M Y H:i:s T', $pageindex->{$env->page}->lastmodified));
+
+ // Perform a redirect if the requested page is a redirect page
+ if(isset($pageindex->$page->redirect) &&
+ $pageindex->$page->redirect === true)
+ {
+ $send_redirect = true;
+ if(isset($_GET["redirect"]) && $_GET["redirect"] == "no")
+ $send_redirect = false;
+
+ if($send_redirect)
+ {
+ // Todo send an explanatory page along with the redirect
+ http_response_code(307);
+ $redirectUrl = "?action=$env->action&redirected_from=" . rawurlencode($env->page);
+
+ $hashCode = "";
+ $newPage = $pageindex->$page->redirect_target;
+ if(strpos($newPage, "#") !== false)
+ {
+ // Extract the part after the hash symbol
+ $hashCode = substr($newPage, strpos($newPage, "#") + 1);
+ // Remove the hash from the new page name
+ $newPage = substr($newPage, 0, strpos($newPage, "#"));
+ }
+ $redirectUrl .= "&page=" . rawurlencode($newPage);
+ if(!empty($pageindex->$newPage->redirect))
+ $redirectUrl .= "&redirect=no";
+ if(strlen($hashCode) > 0)
+ $redirectUrl .= "#$hashCode";
+
+ header("location: $redirectUrl");
+ exit();
+ }
+ }
+
+ $title = "$env->page - $settings->sitename";
+ if(isset($pageindex->$page->protect) && $pageindex->$page->protect === true)
+ $title = $settings->protectedpagechar . $title;
+ $content = "";
+ if(!$env->is_history_revision)
+ $content .= "
$env->page
\n";
+ else
+ {
+ $content .= "
Revision #{$env->history->revision_number} of $env->page
\n";
+ $content .= "
(Revision saved by {$env->history->revision_data->editor} " . render_timestamp($env->history->revision_data->timestamp) . ". Jump to the current revision or see a list of all revisions for this page.)
\n";
+ }
+
+ // Add a visit parent page link if we're a subpage
+ if(get_page_parent($env->page) !== false) {
+ $content .= "
\n";
+ }
+ /*else
+ {
+ $content .= "\n";
+ }*/
+
+ if($settings->show_subpages)
+ {
+ $subpages = get_object_vars(get_subpages($pageindex, $env->page));
+
+ if(count($subpages) > 0)
+ {
+ $content .= "";
+ $content .= "Subpages: ";
+ foreach($subpages as $subpage => $times_removed)
+ {
+ if($times_removed <= $settings->subpages_display_depth)
+ {
+ $content .= "$subpage, ";
+ }
+ }
+ // Remove the last comma from the content
+ $content = substr($content, 0, -2);
+ }
+ }
+
+ $content .= "\n\t\t\n";
+
+ // Prevent indexing of this page if it's still within the noindex
+ // time period
+ if(isset($settings->delayed_indexing_time) and
+ time() - $pageindex->{$env->page}->lastmodified < $settings->delayed_indexing_time)
+ header("x-robots-tag: noindex");
+
+ $settings->footer_message = "$env->page was last edited by {$pageindex->{$env->page}->lasteditor} at " . date('h:ia T \o\n j F Y', $pageindex->{$env->page}->lastmodified) . ".\n
" . $settings->footer_message; // Add the last edited time to the footer
+
+ $mode = isset($_GET["mode"]) ? strtolower(trim($_GET["mode"])) : "normal";
+ switch($mode)
+ {
+ case "contentonly":
+ // Content only mode: Send only the content of the page
+ exit($content);
+ case "parsedsourceonly":
+ // Parsed source only mode: Send only the raw rendered source
+ exit($rawRenderedSource);
+ case "printable":
+ // Printable mode: Sends a printable version of the page
+ exit(page_renderer::render_minimal($title, $content));
+ case "normal":
+ default:
+ // Normal mode: Send a normal page
+ exit(page_renderer::render_main($title, $content));
+ }
+ });
+ }
+]);
+
+?>
+
diff --git a/docs/ModuleApi/files/modules/parser-default-old.php.txt b/docs/ModuleApi/files/modules/parser-default-old.php.txt
new file mode 100644
index 0000000..f4ae0fd
--- /dev/null
+++ b/docs/ModuleApi/files/modules/parser-default-old.php.txt
@@ -0,0 +1,166 @@
+ "Old Default Parser",
+ "version" => "0.10",
+ "author" => "Johnny Broadway & Starbeamrainbowlabs",
+ "description" => "The *old* default parser for Pepperminty Wiki. Based on Johnny Broadway's Slimdown (with more than a few modifications). This parser's features are documented in the help page. Superceded by a customised extension of parsedown extra.",
+ "id" => "parser-default-old",
+ "optional" => true,
+ "code" => function() {
+ global $settings;
+
+ add_parser("default", function($markdown) {
+ return Slimdown::render($markdown);
+ });
+
+ // Register the help section
+ if($settings->parser != "default")
+ return; // Don't register the help section if we aren't the currently set parser.
+ add_help_section("20-parser-default", "Editor Syntax", "
$settings->sitename's editor uses a modified version of slimdown, a flavour of markdown that is implementated using regular expressions. See the credits page for more information and links to the original source for this. A quick reference can be found below:
In addition, the following extra syntax is supported for images:
+
+
Size the image to at most 250 pixels wide:
+ 
+
+ Size the image to at most 120px wide and have it float at the right ahnd size of the page:
+ 
$settings->sitename's editor uses an extended version of Parsedown to render pages, which is a fantastic open source Github flavoured markdown parser. You can find a quick reference guide on Github flavoured markdown here by adam-p, or if you prefer a book Mastering Markdown by KB is a good read, and free too!
+
Tips
+
+
Put 2 spaces at the end of a line to add a soft line break. Leave a blank line to add a head line break (i.e. a new paragraph).
+
You can add an id to a header that you can link to. Put it in curly braces after the heading name like this: # Heading Name {#HeadingId}. Then you can link to like like this: [[Page name#HeadingId}]]. You can also link to a heading id on the current page by omitting the page name: [[#HeadingId]].
+
+
Extra Syntax
+
$settings->sitename's editor also supports some extra custom syntax, some of which is inspired by Mediawiki.
+
An image with a caption that fits inside a 256px x 256px box, preserving aspect ratio. The caption is taken from the alt text.
+
An example of the short url syntax for images. Simply enter the page name of an image (or video / audio file), and Pepperminty Wiki will sort out the url for you.
+
+
Note that the all image image syntax above can be mixed and matched to your liking. The caption option in particular must come last or next to last.
+
Templating
+
$settings->sitename also supports including one page in another page as a template. The syntax is very similar to that of Mediawiki. For example, {{Announcement banner}} will include the contents of the \"Announcement banner\" page, assuming it exists.
+
You can also use variables. Again, the syntax here is very similar to that of Mediawiki - they can be referenced in the included page by surrrounding the variable name in triple curly braces (e.g. {{{Announcement text}}}), and set when including a page with the bar syntax (e.g. {{Announcement banner | importance = high | text = Maintenance has been planned for tonight.}}). Currently the only restriction in templates and variables is that you may not include a closing curly brace (}) in the page name, variable name, or value.
+
Special Variables
+
$settings->sitename also supports a number of special built-in variables. Their syntax and function are described below:
+
+
Type this
To get this
+
{{{@}}}
Lists all variables and their values in a table.
+
{{{#}}}
Shows a 'stack trace', outlining all the parent includes of the current page being parsed.
+
{{{~}}}
Outputs the requested page's name.
+
{{{*}}}
Outputs a comma separated list of all the subpages of the current page.
+
{{{+}}}
Shows a gallery containing all the files that are sub pages of the current page.
Given a page name, returns the absolute file path in which that page's
+comments are stored.
+
+
+
Parameters
+
+
+
string
+
$pagename
+
The name pf the page to fetch the comments filename for.
+
+
+
+
+
Returns
+ string
+ —
The path to the file that the
+
+
+
+
+
+
+
+
+
+
+
get_max_upload_size()
+
+
get_max_upload_size() : integer
+
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
+
+
+
+
+
Returns
+ integer
+ —
The maximum upload size supported bythe server, in bytes.
The pagename that should be considered the root of the rendering. You don't usually need to use this, it is used by the algorithm itself since it is recursive.
+
+
+
+
+
Returns
+ string
+ —
A HTML rendering of the sidebar for the given pageindex.
+
+
+
+
+
+
+
+
+
+
+
render_timestamp()
+
+
render_timestamp(integer $timestamp) : string
+
Renders a timestamp in HTML.
+
+
+
Parameters
+
+
+
integer
+
$timestamp
+
The timestamp to render.
+
+
+
+
+
Returns
+ string
+ —
HTML representing the given timestamp.
+
+
+
+
+
+
+
+
+
+
+
save_userdata()
+
+
save_userdata() : boolean
+
Saves the currently logged in uesr's data back to peppermint.json.
+
+
+
+
+
Returns
+ boolean
+ —
Whether the user's data was saved successfully. Returns false if the user isn't logged in.
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)
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)
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.
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.
",
+ "name": "Logout",
+ "group": "Authorisation",
+ "permission": [
+ {
+ "name": "Anonymous",
+ "title": "Anybody may use this call.",
+ "description": ""
+ }
+ ],
+ "version": "0.0.0",
+ "filename": "./modules/page-logout.php",
+ "groupTitle": "Authorisation"
+ },
+ {
+ "type": "post",
+ "url": "?action=comment",
+ "title": "Comment on a page",
+ "name": "Comment",
+ "group": "Comment",
+ "permission": [
+ {
+ "name": "User",
+ "title": "Only users loggged in may use this call.",
+ "description": ""
+ }
+ ],
+ "description": "
Posts a comment on a page, optionally in reply to another comment. Currently, comments must be made by a logged-in user.
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.
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.
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.
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.
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.
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.
Optional. The display mode to use. Can hld 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).
Optional. The display mode to use. Can hld 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).
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.
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.
You weren't loggged in as a moderator before sending this request.
"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "type": "get",
+ "url": "?action=export",
+ "title": "Export the all the wiki's content",
+ "description": "
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.
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.
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.
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.
"
+ }
+ ]
+ }
+ },
+ "version": "0.0.0",
+ "filename": "./modules/page-help.php",
+ "groupTitle": "Utility"
+ },
+ {
+ "type": "get",
+ "url": "?action=list-tags[&tag=]",
+ "title": "Get a list of tags or pages with a certain tag",
+ "description": "
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.
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!
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!
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)
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)
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.
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.
",
+ "name": "Logout",
+ "group": "Authorisation",
+ "permission": [
+ {
+ "name": "Anonymous",
+ "title": "Anybody may use this call.",
+ "description": ""
+ }
+ ],
+ "version": "0.0.0",
+ "filename": "./modules/page-logout.php",
+ "groupTitle": "Authorisation"
+ },
+ {
+ "type": "post",
+ "url": "?action=comment",
+ "title": "Comment on a page",
+ "name": "Comment",
+ "group": "Comment",
+ "permission": [
+ {
+ "name": "User",
+ "title": "Only users loggged in may use this call.",
+ "description": ""
+ }
+ ],
+ "description": "
Posts a comment on a page, optionally in reply to another comment. Currently, comments must be made by a logged-in user.
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.
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.
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.
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.
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.
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.
Optional. The display mode to use. Can hld 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).
Optional. The display mode to use. Can hld 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).
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.
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.
You weren't loggged in as a moderator before sending this request.
"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "type": "get",
+ "url": "?action=export",
+ "title": "Export the all the wiki's content",
+ "description": "
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.
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.
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.
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.
"
+ }
+ ]
+ }
+ },
+ "version": "0.0.0",
+ "filename": "./modules/page-help.php",
+ "groupTitle": "Utility"
+ },
+ {
+ "type": "get",
+ "url": "?action=list-tags[&tag=]",
+ "title": "Get a list of tags or pages with a certain tag",
+ "description": "
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.
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!
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!
"
+ }
+ ]
+ }
+ },
+ "version": "0.0.0",
+ "filename": "./modules/page-edit.php",
+ "group": "_home_sbrl_Documents_code_php_peppermint_modules_page_edit_php",
+ "groupTitle": "_home_sbrl_Documents_code_php_peppermint_modules_page_edit_php"
+ }
+]
diff --git a/RestApiDocs/api_project.js b/docs/RestApi/api_project.js
similarity index 89%
rename from RestApiDocs/api_project.js
rename to docs/RestApi/api_project.js
index 13359b3..9f567b3 100644
--- a/RestApiDocs/api_project.js
+++ b/docs/RestApi/api_project.js
@@ -8,7 +8,7 @@ define({
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
- "time": "2017-06-28T08:44:48.635Z",
+ "time": "2017-09-16T10:22:32.357Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}
diff --git a/RestApiDocs/api_project.json b/docs/RestApi/api_project.json
similarity index 89%
rename from RestApiDocs/api_project.json
rename to docs/RestApi/api_project.json
index 698bdaf..be23ff4 100644
--- a/RestApiDocs/api_project.json
+++ b/docs/RestApi/api_project.json
@@ -8,7 +8,7 @@
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
- "time": "2017-06-28T08:44:48.635Z",
+ "time": "2017-09-16T10:22:32.357Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}
diff --git a/RestApiDocs/css/style.css b/docs/RestApi/css/style.css
similarity index 100%
rename from RestApiDocs/css/style.css
rename to docs/RestApi/css/style.css
diff --git a/RestApiDocs/fonts/glyphicons-halflings-regular.eot b/docs/RestApi/fonts/glyphicons-halflings-regular.eot
similarity index 100%
rename from RestApiDocs/fonts/glyphicons-halflings-regular.eot
rename to docs/RestApi/fonts/glyphicons-halflings-regular.eot
diff --git a/RestApiDocs/fonts/glyphicons-halflings-regular.svg b/docs/RestApi/fonts/glyphicons-halflings-regular.svg
similarity index 100%
rename from RestApiDocs/fonts/glyphicons-halflings-regular.svg
rename to docs/RestApi/fonts/glyphicons-halflings-regular.svg
diff --git a/RestApiDocs/fonts/glyphicons-halflings-regular.ttf b/docs/RestApi/fonts/glyphicons-halflings-regular.ttf
similarity index 100%
rename from RestApiDocs/fonts/glyphicons-halflings-regular.ttf
rename to docs/RestApi/fonts/glyphicons-halflings-regular.ttf
diff --git a/RestApiDocs/fonts/glyphicons-halflings-regular.woff b/docs/RestApi/fonts/glyphicons-halflings-regular.woff
similarity index 100%
rename from RestApiDocs/fonts/glyphicons-halflings-regular.woff
rename to docs/RestApi/fonts/glyphicons-halflings-regular.woff
diff --git a/RestApiDocs/fonts/glyphicons-halflings-regular.woff2 b/docs/RestApi/fonts/glyphicons-halflings-regular.woff2
similarity index 100%
rename from RestApiDocs/fonts/glyphicons-halflings-regular.woff2
rename to docs/RestApi/fonts/glyphicons-halflings-regular.woff2
diff --git a/RestApiDocs/img/favicon.ico b/docs/RestApi/img/favicon.ico
similarity index 100%
rename from RestApiDocs/img/favicon.ico
rename to docs/RestApi/img/favicon.ico
diff --git a/RestApiDocs/img/glyphicons-halflings-white.png b/docs/RestApi/img/glyphicons-halflings-white.png
similarity index 100%
rename from RestApiDocs/img/glyphicons-halflings-white.png
rename to docs/RestApi/img/glyphicons-halflings-white.png
diff --git a/RestApiDocs/img/glyphicons-halflings.png b/docs/RestApi/img/glyphicons-halflings.png
similarity index 100%
rename from RestApiDocs/img/glyphicons-halflings.png
rename to docs/RestApi/img/glyphicons-halflings.png
diff --git a/RestApiDocs/index.html b/docs/RestApi/index.html
similarity index 100%
rename from RestApiDocs/index.html
rename to docs/RestApi/index.html
diff --git a/RestApiDocs/locales/ca.js b/docs/RestApi/locales/ca.js
similarity index 100%
rename from RestApiDocs/locales/ca.js
rename to docs/RestApi/locales/ca.js
diff --git a/RestApiDocs/locales/de.js b/docs/RestApi/locales/de.js
similarity index 100%
rename from RestApiDocs/locales/de.js
rename to docs/RestApi/locales/de.js
diff --git a/RestApiDocs/locales/es.js b/docs/RestApi/locales/es.js
similarity index 100%
rename from RestApiDocs/locales/es.js
rename to docs/RestApi/locales/es.js
diff --git a/RestApiDocs/locales/fr.js b/docs/RestApi/locales/fr.js
similarity index 100%
rename from RestApiDocs/locales/fr.js
rename to docs/RestApi/locales/fr.js
diff --git a/RestApiDocs/locales/it.js b/docs/RestApi/locales/it.js
similarity index 100%
rename from RestApiDocs/locales/it.js
rename to docs/RestApi/locales/it.js
diff --git a/RestApiDocs/locales/locale.js b/docs/RestApi/locales/locale.js
similarity index 100%
rename from RestApiDocs/locales/locale.js
rename to docs/RestApi/locales/locale.js
diff --git a/RestApiDocs/locales/nl.js b/docs/RestApi/locales/nl.js
similarity index 100%
rename from RestApiDocs/locales/nl.js
rename to docs/RestApi/locales/nl.js
diff --git a/RestApiDocs/locales/pl.js b/docs/RestApi/locales/pl.js
similarity index 100%
rename from RestApiDocs/locales/pl.js
rename to docs/RestApi/locales/pl.js
diff --git a/RestApiDocs/locales/pt_br.js b/docs/RestApi/locales/pt_br.js
similarity index 100%
rename from RestApiDocs/locales/pt_br.js
rename to docs/RestApi/locales/pt_br.js
diff --git a/RestApiDocs/locales/ro.js b/docs/RestApi/locales/ro.js
similarity index 100%
rename from RestApiDocs/locales/ro.js
rename to docs/RestApi/locales/ro.js
diff --git a/RestApiDocs/locales/ru.js b/docs/RestApi/locales/ru.js
similarity index 100%
rename from RestApiDocs/locales/ru.js
rename to docs/RestApi/locales/ru.js
diff --git a/RestApiDocs/locales/tr.js b/docs/RestApi/locales/tr.js
similarity index 100%
rename from RestApiDocs/locales/tr.js
rename to docs/RestApi/locales/tr.js
diff --git a/RestApiDocs/locales/vi.js b/docs/RestApi/locales/vi.js
similarity index 100%
rename from RestApiDocs/locales/vi.js
rename to docs/RestApi/locales/vi.js
diff --git a/RestApiDocs/locales/zh.js b/docs/RestApi/locales/zh.js
similarity index 100%
rename from RestApiDocs/locales/zh.js
rename to docs/RestApi/locales/zh.js
diff --git a/RestApiDocs/locales/zh_cn.js b/docs/RestApi/locales/zh_cn.js
similarity index 100%
rename from RestApiDocs/locales/zh_cn.js
rename to docs/RestApi/locales/zh_cn.js
diff --git a/RestApiDocs/main.js b/docs/RestApi/main.js
similarity index 100%
rename from RestApiDocs/main.js
rename to docs/RestApi/main.js
diff --git a/RestApiDocs/utils/handlebars_helper.js b/docs/RestApi/utils/handlebars_helper.js
similarity index 100%
rename from RestApiDocs/utils/handlebars_helper.js
rename to docs/RestApi/utils/handlebars_helper.js
diff --git a/RestApiDocs/utils/send_sample_request.js b/docs/RestApi/utils/send_sample_request.js
similarity index 100%
rename from RestApiDocs/utils/send_sample_request.js
rename to docs/RestApi/utils/send_sample_request.js
diff --git a/RestApiDocs/vendor/bootstrap-responsive.min.css b/docs/RestApi/vendor/bootstrap-responsive.min.css
similarity index 100%
rename from RestApiDocs/vendor/bootstrap-responsive.min.css
rename to docs/RestApi/vendor/bootstrap-responsive.min.css
diff --git a/RestApiDocs/vendor/bootstrap.min.css b/docs/RestApi/vendor/bootstrap.min.css
similarity index 100%
rename from RestApiDocs/vendor/bootstrap.min.css
rename to docs/RestApi/vendor/bootstrap.min.css
diff --git a/RestApiDocs/vendor/bootstrap.min.js b/docs/RestApi/vendor/bootstrap.min.js
similarity index 100%
rename from RestApiDocs/vendor/bootstrap.min.js
rename to docs/RestApi/vendor/bootstrap.min.js
diff --git a/RestApiDocs/vendor/diff_match_patch.min.js b/docs/RestApi/vendor/diff_match_patch.min.js
similarity index 100%
rename from RestApiDocs/vendor/diff_match_patch.min.js
rename to docs/RestApi/vendor/diff_match_patch.min.js
diff --git a/RestApiDocs/vendor/handlebars.min.js b/docs/RestApi/vendor/handlebars.min.js
similarity index 100%
rename from RestApiDocs/vendor/handlebars.min.js
rename to docs/RestApi/vendor/handlebars.min.js
diff --git a/RestApiDocs/vendor/jquery.min.js b/docs/RestApi/vendor/jquery.min.js
similarity index 100%
rename from RestApiDocs/vendor/jquery.min.js
rename to docs/RestApi/vendor/jquery.min.js
diff --git a/RestApiDocs/vendor/list.min.js b/docs/RestApi/vendor/list.min.js
similarity index 100%
rename from RestApiDocs/vendor/list.min.js
rename to docs/RestApi/vendor/list.min.js
diff --git a/RestApiDocs/vendor/lodash.custom.min.js b/docs/RestApi/vendor/lodash.custom.min.js
similarity index 100%
rename from RestApiDocs/vendor/lodash.custom.min.js
rename to docs/RestApi/vendor/lodash.custom.min.js
diff --git a/RestApiDocs/vendor/lodash.min.js b/docs/RestApi/vendor/lodash.min.js
similarity index 100%
rename from RestApiDocs/vendor/lodash.min.js
rename to docs/RestApi/vendor/lodash.min.js
diff --git a/RestApiDocs/vendor/path-to-regexp/LICENSE b/docs/RestApi/vendor/path-to-regexp/LICENSE
similarity index 100%
rename from RestApiDocs/vendor/path-to-regexp/LICENSE
rename to docs/RestApi/vendor/path-to-regexp/LICENSE
diff --git a/RestApiDocs/vendor/path-to-regexp/index.js b/docs/RestApi/vendor/path-to-regexp/index.js
similarity index 100%
rename from RestApiDocs/vendor/path-to-regexp/index.js
rename to docs/RestApi/vendor/path-to-regexp/index.js
diff --git a/RestApiDocs/vendor/polyfill.js b/docs/RestApi/vendor/polyfill.js
similarity index 100%
rename from RestApiDocs/vendor/polyfill.js
rename to docs/RestApi/vendor/polyfill.js
diff --git a/RestApiDocs/vendor/prettify.css b/docs/RestApi/vendor/prettify.css
similarity index 100%
rename from RestApiDocs/vendor/prettify.css
rename to docs/RestApi/vendor/prettify.css
diff --git a/RestApiDocs/vendor/prettify/lang-Splus.js b/docs/RestApi/vendor/prettify/lang-Splus.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-Splus.js
rename to docs/RestApi/vendor/prettify/lang-Splus.js
diff --git a/RestApiDocs/vendor/prettify/lang-aea.js b/docs/RestApi/vendor/prettify/lang-aea.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-aea.js
rename to docs/RestApi/vendor/prettify/lang-aea.js
diff --git a/RestApiDocs/vendor/prettify/lang-agc.js b/docs/RestApi/vendor/prettify/lang-agc.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-agc.js
rename to docs/RestApi/vendor/prettify/lang-agc.js
diff --git a/RestApiDocs/vendor/prettify/lang-apollo.js b/docs/RestApi/vendor/prettify/lang-apollo.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-apollo.js
rename to docs/RestApi/vendor/prettify/lang-apollo.js
diff --git a/RestApiDocs/vendor/prettify/lang-basic.js b/docs/RestApi/vendor/prettify/lang-basic.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-basic.js
rename to docs/RestApi/vendor/prettify/lang-basic.js
diff --git a/RestApiDocs/vendor/prettify/lang-cbm.js b/docs/RestApi/vendor/prettify/lang-cbm.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-cbm.js
rename to docs/RestApi/vendor/prettify/lang-cbm.js
diff --git a/RestApiDocs/vendor/prettify/lang-cl.js b/docs/RestApi/vendor/prettify/lang-cl.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-cl.js
rename to docs/RestApi/vendor/prettify/lang-cl.js
diff --git a/RestApiDocs/vendor/prettify/lang-clj.js b/docs/RestApi/vendor/prettify/lang-clj.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-clj.js
rename to docs/RestApi/vendor/prettify/lang-clj.js
diff --git a/RestApiDocs/vendor/prettify/lang-css.js b/docs/RestApi/vendor/prettify/lang-css.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-css.js
rename to docs/RestApi/vendor/prettify/lang-css.js
diff --git a/RestApiDocs/vendor/prettify/lang-dart.js b/docs/RestApi/vendor/prettify/lang-dart.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-dart.js
rename to docs/RestApi/vendor/prettify/lang-dart.js
diff --git a/RestApiDocs/vendor/prettify/lang-el.js b/docs/RestApi/vendor/prettify/lang-el.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-el.js
rename to docs/RestApi/vendor/prettify/lang-el.js
diff --git a/RestApiDocs/vendor/prettify/lang-erl.js b/docs/RestApi/vendor/prettify/lang-erl.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-erl.js
rename to docs/RestApi/vendor/prettify/lang-erl.js
diff --git a/RestApiDocs/vendor/prettify/lang-erlang.js b/docs/RestApi/vendor/prettify/lang-erlang.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-erlang.js
rename to docs/RestApi/vendor/prettify/lang-erlang.js
diff --git a/RestApiDocs/vendor/prettify/lang-fs.js b/docs/RestApi/vendor/prettify/lang-fs.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-fs.js
rename to docs/RestApi/vendor/prettify/lang-fs.js
diff --git a/RestApiDocs/vendor/prettify/lang-go.js b/docs/RestApi/vendor/prettify/lang-go.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-go.js
rename to docs/RestApi/vendor/prettify/lang-go.js
diff --git a/RestApiDocs/vendor/prettify/lang-hs.js b/docs/RestApi/vendor/prettify/lang-hs.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-hs.js
rename to docs/RestApi/vendor/prettify/lang-hs.js
diff --git a/RestApiDocs/vendor/prettify/lang-lasso.js b/docs/RestApi/vendor/prettify/lang-lasso.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-lasso.js
rename to docs/RestApi/vendor/prettify/lang-lasso.js
diff --git a/RestApiDocs/vendor/prettify/lang-lassoscript.js b/docs/RestApi/vendor/prettify/lang-lassoscript.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-lassoscript.js
rename to docs/RestApi/vendor/prettify/lang-lassoscript.js
diff --git a/RestApiDocs/vendor/prettify/lang-latex.js b/docs/RestApi/vendor/prettify/lang-latex.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-latex.js
rename to docs/RestApi/vendor/prettify/lang-latex.js
diff --git a/RestApiDocs/vendor/prettify/lang-lgt.js b/docs/RestApi/vendor/prettify/lang-lgt.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-lgt.js
rename to docs/RestApi/vendor/prettify/lang-lgt.js
diff --git a/RestApiDocs/vendor/prettify/lang-lisp.js b/docs/RestApi/vendor/prettify/lang-lisp.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-lisp.js
rename to docs/RestApi/vendor/prettify/lang-lisp.js
diff --git a/RestApiDocs/vendor/prettify/lang-ll.js b/docs/RestApi/vendor/prettify/lang-ll.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-ll.js
rename to docs/RestApi/vendor/prettify/lang-ll.js
diff --git a/RestApiDocs/vendor/prettify/lang-llvm.js b/docs/RestApi/vendor/prettify/lang-llvm.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-llvm.js
rename to docs/RestApi/vendor/prettify/lang-llvm.js
diff --git a/RestApiDocs/vendor/prettify/lang-logtalk.js b/docs/RestApi/vendor/prettify/lang-logtalk.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-logtalk.js
rename to docs/RestApi/vendor/prettify/lang-logtalk.js
diff --git a/RestApiDocs/vendor/prettify/lang-ls.js b/docs/RestApi/vendor/prettify/lang-ls.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-ls.js
rename to docs/RestApi/vendor/prettify/lang-ls.js
diff --git a/RestApiDocs/vendor/prettify/lang-lsp.js b/docs/RestApi/vendor/prettify/lang-lsp.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-lsp.js
rename to docs/RestApi/vendor/prettify/lang-lsp.js
diff --git a/RestApiDocs/vendor/prettify/lang-lua.js b/docs/RestApi/vendor/prettify/lang-lua.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-lua.js
rename to docs/RestApi/vendor/prettify/lang-lua.js
diff --git a/RestApiDocs/vendor/prettify/lang-matlab.js b/docs/RestApi/vendor/prettify/lang-matlab.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-matlab.js
rename to docs/RestApi/vendor/prettify/lang-matlab.js
diff --git a/RestApiDocs/vendor/prettify/lang-ml.js b/docs/RestApi/vendor/prettify/lang-ml.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-ml.js
rename to docs/RestApi/vendor/prettify/lang-ml.js
diff --git a/RestApiDocs/vendor/prettify/lang-mumps.js b/docs/RestApi/vendor/prettify/lang-mumps.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-mumps.js
rename to docs/RestApi/vendor/prettify/lang-mumps.js
diff --git a/RestApiDocs/vendor/prettify/lang-n.js b/docs/RestApi/vendor/prettify/lang-n.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-n.js
rename to docs/RestApi/vendor/prettify/lang-n.js
diff --git a/RestApiDocs/vendor/prettify/lang-nemerle.js b/docs/RestApi/vendor/prettify/lang-nemerle.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-nemerle.js
rename to docs/RestApi/vendor/prettify/lang-nemerle.js
diff --git a/RestApiDocs/vendor/prettify/lang-pascal.js b/docs/RestApi/vendor/prettify/lang-pascal.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-pascal.js
rename to docs/RestApi/vendor/prettify/lang-pascal.js
diff --git a/RestApiDocs/vendor/prettify/lang-proto.js b/docs/RestApi/vendor/prettify/lang-proto.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-proto.js
rename to docs/RestApi/vendor/prettify/lang-proto.js
diff --git a/RestApiDocs/vendor/prettify/lang-r.js b/docs/RestApi/vendor/prettify/lang-r.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-r.js
rename to docs/RestApi/vendor/prettify/lang-r.js
diff --git a/RestApiDocs/vendor/prettify/lang-rd.js b/docs/RestApi/vendor/prettify/lang-rd.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-rd.js
rename to docs/RestApi/vendor/prettify/lang-rd.js
diff --git a/RestApiDocs/vendor/prettify/lang-rkt.js b/docs/RestApi/vendor/prettify/lang-rkt.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-rkt.js
rename to docs/RestApi/vendor/prettify/lang-rkt.js
diff --git a/RestApiDocs/vendor/prettify/lang-rust.js b/docs/RestApi/vendor/prettify/lang-rust.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-rust.js
rename to docs/RestApi/vendor/prettify/lang-rust.js
diff --git a/RestApiDocs/vendor/prettify/lang-s.js b/docs/RestApi/vendor/prettify/lang-s.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-s.js
rename to docs/RestApi/vendor/prettify/lang-s.js
diff --git a/RestApiDocs/vendor/prettify/lang-scala.js b/docs/RestApi/vendor/prettify/lang-scala.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-scala.js
rename to docs/RestApi/vendor/prettify/lang-scala.js
diff --git a/RestApiDocs/vendor/prettify/lang-scm.js b/docs/RestApi/vendor/prettify/lang-scm.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-scm.js
rename to docs/RestApi/vendor/prettify/lang-scm.js
diff --git a/RestApiDocs/vendor/prettify/lang-sql.js b/docs/RestApi/vendor/prettify/lang-sql.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-sql.js
rename to docs/RestApi/vendor/prettify/lang-sql.js
diff --git a/RestApiDocs/vendor/prettify/lang-ss.js b/docs/RestApi/vendor/prettify/lang-ss.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-ss.js
rename to docs/RestApi/vendor/prettify/lang-ss.js
diff --git a/RestApiDocs/vendor/prettify/lang-swift.js b/docs/RestApi/vendor/prettify/lang-swift.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-swift.js
rename to docs/RestApi/vendor/prettify/lang-swift.js
diff --git a/RestApiDocs/vendor/prettify/lang-tcl.js b/docs/RestApi/vendor/prettify/lang-tcl.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-tcl.js
rename to docs/RestApi/vendor/prettify/lang-tcl.js
diff --git a/RestApiDocs/vendor/prettify/lang-tex.js b/docs/RestApi/vendor/prettify/lang-tex.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-tex.js
rename to docs/RestApi/vendor/prettify/lang-tex.js
diff --git a/RestApiDocs/vendor/prettify/lang-vb.js b/docs/RestApi/vendor/prettify/lang-vb.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-vb.js
rename to docs/RestApi/vendor/prettify/lang-vb.js
diff --git a/RestApiDocs/vendor/prettify/lang-vbs.js b/docs/RestApi/vendor/prettify/lang-vbs.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-vbs.js
rename to docs/RestApi/vendor/prettify/lang-vbs.js
diff --git a/RestApiDocs/vendor/prettify/lang-vhd.js b/docs/RestApi/vendor/prettify/lang-vhd.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-vhd.js
rename to docs/RestApi/vendor/prettify/lang-vhd.js
diff --git a/RestApiDocs/vendor/prettify/lang-vhdl.js b/docs/RestApi/vendor/prettify/lang-vhdl.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-vhdl.js
rename to docs/RestApi/vendor/prettify/lang-vhdl.js
diff --git a/RestApiDocs/vendor/prettify/lang-wiki.js b/docs/RestApi/vendor/prettify/lang-wiki.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-wiki.js
rename to docs/RestApi/vendor/prettify/lang-wiki.js
diff --git a/RestApiDocs/vendor/prettify/lang-xq.js b/docs/RestApi/vendor/prettify/lang-xq.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-xq.js
rename to docs/RestApi/vendor/prettify/lang-xq.js
diff --git a/RestApiDocs/vendor/prettify/lang-xquery.js b/docs/RestApi/vendor/prettify/lang-xquery.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-xquery.js
rename to docs/RestApi/vendor/prettify/lang-xquery.js
diff --git a/RestApiDocs/vendor/prettify/lang-yaml.js b/docs/RestApi/vendor/prettify/lang-yaml.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-yaml.js
rename to docs/RestApi/vendor/prettify/lang-yaml.js
diff --git a/RestApiDocs/vendor/prettify/lang-yml.js b/docs/RestApi/vendor/prettify/lang-yml.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/lang-yml.js
rename to docs/RestApi/vendor/prettify/lang-yml.js
diff --git a/RestApiDocs/vendor/prettify/prettify.css b/docs/RestApi/vendor/prettify/prettify.css
similarity index 100%
rename from RestApiDocs/vendor/prettify/prettify.css
rename to docs/RestApi/vendor/prettify/prettify.css
diff --git a/RestApiDocs/vendor/prettify/prettify.js b/docs/RestApi/vendor/prettify/prettify.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/prettify.js
rename to docs/RestApi/vendor/prettify/prettify.js
diff --git a/RestApiDocs/vendor/prettify/run_prettify.js b/docs/RestApi/vendor/prettify/run_prettify.js
similarity index 100%
rename from RestApiDocs/vendor/prettify/run_prettify.js
rename to docs/RestApi/vendor/prettify/run_prettify.js
diff --git a/RestApiDocs/vendor/require.min.js b/docs/RestApi/vendor/require.min.js
similarity index 100%
rename from RestApiDocs/vendor/require.min.js
rename to docs/RestApi/vendor/require.min.js
diff --git a/RestApiDocs/vendor/semver.min.js b/docs/RestApi/vendor/semver.min.js
similarity index 100%
rename from RestApiDocs/vendor/semver.min.js
rename to docs/RestApi/vendor/semver.min.js
diff --git a/RestApiDocs/vendor/webfontloader.js b/docs/RestApi/vendor/webfontloader.js
similarity index 100%
rename from RestApiDocs/vendor/webfontloader.js
rename to docs/RestApi/vendor/webfontloader.js
diff --git a/phpdoc b/phpdoc
new file mode 100644
index 0000000..a07bf72
Binary files /dev/null and b/phpdoc differ
Pepperminty Wiki Downloader
Starbeamrainbowlabs. The code is available on GitHub.
+ 
" . page_renderer::render_username($comment->username) . " said:
"; + $result .= "\t"; + $result .= "\t\t\n"; + $result .= "\t\t🔗\n"; + $result .= "\t\t\n"; + $result .= "\t
\n"; + $result .= "\t" . render_comments($comment->replies, $depth + 1) . "\n"; + $result .= "\t