"Parsedown", "version" => "0.12.3", "author" => "Emanuil Rusev & Starbeamrainbowlabs", "description" => "An upgraded (now default!) parser based on Emanuil Rusev's Parsedown Extra PHP library (https://github.com/erusev/parsedown-extra), which is licensed MIT. Please be careful, as this module adds some weight to your installation.", "extra_data" => [ /********** Parsedown versions ********** * Parsedown Core: 1.8.0-beta-7 * * Parsedown Extra: 0.8.0-beta-1 * * Parsedown Extreme: 0.1.6 *removed* * ****************************************/ "Parsedown.php" => "https://raw.githubusercontent.com/erusev/parsedown/1610e4747c88a53676f94f752b447f4eff03c28d/Parsedown.php", // "ParsedownExtra.php" => "https://raw.githubusercontent.com/erusev/parsedown-extra/91ac3ff98f0cea243bdccc688df43810f044dcef/ParsedownExtra.php", // "Parsedown.php" => "https://raw.githubusercontent.com/erusev/parsedown/3825db53a2be5d9ce54436a9cc557c6bdce1808a/Parsedown.php", "ParsedownExtra.php" => "https://raw.githubusercontent.com/erusev/parsedown-extra/352d03d941fc801724e82e49424ff409175261fd/ParsedownExtra.php" // Parsedown Extreme is causing PHP 7.4+ errors, and isn't rendering correctly with the security features we have turned on. // "ParsedownExtended.php" => "https://raw.githubusercontent.com/BenjaminHoegh/ParsedownExtended/8e1224e61a199cb513c47398353a27f6ba822da6/ParsedownExtended.php" // "ParsedownExtreme.php" => "https://raw.githubusercontent.com/BenjaminHoegh/parsedown-extreme/adae4136534ad1e4159fe04c74c4683681855b84/ParsedownExtreme.php" ], "id" => "parser-parsedown", "code" => function() { global $settings; $parser = new PeppermintParsedown(); $parser->setInternalLinkBase("?page=%s"); add_parser("parsedown", function($source, $untrusted) use ($parser) { global $settings; $parser->setsafeMode($untrusted || $settings->all_untrusted); $parser->setMarkupEscaped($settings->clean_raw_html); $result = $parser->text($source); return $result; }, function($source) { global $version, $settings, $pageindex; $id_text = "$version|$settings->parser|$source"; // Find template includes preg_match_all( '/\{\{\s*([^|]+)\s*(?:\|[^}]*)?\}\}/', $source, $includes ); foreach($includes[1] as $include_pagename) { if(empty($pageindex->$include_pagename)) continue; $id_text .= "|$include_pagename:" . parsedown_pagename_resolve( $pageindex->$include_pagename->lastmodified ); } return str_replace(["+","/"], ["-","_"], base64_encode(hash( "sha256", $id_text, true ))); }); add_action("parsedown-render-ext", function() { global $settings, $env, $paths; if(!$settings->parser_ext_renderers_enabled) { http_response_code(403); header("content-type: image/png"); imagepng(errorimage("Error: External diagram renderer support\nhas been disabled on $settings->sitename.\nTry contacting {$settings->admindetails_name}, $settings->sitename's administrator.")); exit(); } if(!isset($_GET["source"])) { http_response_code(400); header("content-type: image/png"); imagepng(errorimage("Error: No source text \nspecified.")); exit(); } if(!isset($_GET["language"])) { http_response_code(400); header("content-type: image/png"); imagepng(errorimage("Error: No external renderer \nlanguage specified.")); exit(); } $source = $_GET["source"]; $language = $_GET["language"]; if(!isset($settings->parser_ext_renderers->$language)) { $message = "Error: Unknown language {$_GET["language"]}.\nSupported languages:\n"; foreach($settings->parser_ext_renderers as $language => $spec) $message .= "$spec->name ($language)\n"; http_response_code(400); header("content-type: image/png"); imagepng(errorimage(trim($message))); exit(); } $renderer = $settings->parser_ext_renderers->$language; $cache_id = hash("sha256", hash("sha256", $language) . hash("sha256", $source) . ($_GET["immutable_key"] ?? "") ); $cache_file_location = "{$paths->cache_directory}/render_ext/$cache_id." . system_mime_type_extension($renderer->output_format); // If it exists on disk already, then serve that instead if(file_exists($cache_file_location)) { header("cache-control: public, max-age=31536000, immutable"); header("content-type: $renderer->output_format"); header("content-length: " . filesize($cache_file_location)); header("x-cache: render_ext/hit"); readfile($cache_file_location); exit(); } if(!$settings->parser_ext_allow_anon && !$env->is_logged_in) { http_response_code(401); header("content-type: image/png"); imagepng(errorimage(wordwrap("Error: You aren't logged in, that image hasn't yet been cached, and $settings->sitename does not allow anonymous users to invoke external renderers, so that image can't be generated right now. Try contacting $settings->admindetails_name, $settings->sitename's administrator (their details can be found at the bottom of every page)."))); exit(); } // Create the cache directory if doesn't exist already if(!file_exists(dirname($cache_file_location))) mkdir(dirname($cache_file_location), 0750, true); $cli_to_execute = $renderer->cli; $descriptors = [ 0 => null, // stdin 1 => null, // stdout 2 => tmpfile() // stderr ]; switch ($renderer->cli_mode) { case "pipe": // Fill stdin with the input text $descriptors[0] = tmpfile(); fwrite($descriptors[0], $source); fseek($descriptors[0], 0); // Pipe the output to be the cache file $descriptors[1] = fopen($cache_file_location, "wb+"); break; case "substitution_pipe": // Update the command that we're going to execute $cli_to_execute = str_replace( "{input_text}", escapeshellarg($source), $cli_to_execute ); // Set the descriptors $descriptors[0] = tmpfile(); $descriptors[1] = fopen($cache_file_location, "wb+"); break; case "file": $descriptors[0] = tmpfile(); fwrite($descriptors[0], $source); $descriptors[1] = tmpfile(); $cli_to_execute = str_replace( [ "{input_file}", "{output_file}" ], [ escapeshellarg(stream_get_meta_data($descriptors[0])["uri"]), escapeshellarg($cache_file_location) ], $cli_to_execute ); break; default: http_response_code(503); header("cache-control: no-cache, no-store, must-revalidate"); header("content-type: image/png"); imagepng(errorimage("Error: Unknown external renderer mode '$renderer->cli_mode'.\nPlease contact $settings->admindetails_name, $settings->sitename's administrator.")); exit(); break; } if('\\' !== DIRECTORY_SEPARATOR) { // We're not on Windows, so we can use timeout to force-kill if it takes too long $cli_to_execute = "timeout {$settings->parser_ext_time_limit} $cli_to_execute"; } $start_time = microtime(true); $process_handle = proc_open( $cli_to_execute, $descriptors, $pipes, null, // working directory null // environment variables ); if(!is_resource($process_handle)) { fclose($descriptors[0]); fclose($descriptors[1]); fclose($descriptors[2]); if(file_exists($cache_file_location)) unlink($cache_file_location); http_response_code(503); header("cache-control: no-cache, no-store, must-revalidate"); header("content-type: image/png"); imagepng(errorimage("Error: Failed to start external renderer.\nIs $renderer->name installed?")); exit(); } // Wait for it to exit $exit_code = proc_close($process_handle); fclose($descriptors[0]); fclose($descriptors[1]); $time_taken = round((microtime(true) - $start_time) * 1000, 2); if($exit_code !== 0 || !file_exists($cache_file_location)) { fseek($descriptors[2], 0); $error_details = stream_get_contents($descriptors[2]); // Delete the cache file, which is guaranteed to exist because // we pre-emptively create it above if(file_exists($cache_file_location)) unlink($cache_file_location); http_response_code(503); header("content-type: image/png"); imagepng(errorimage( "Error: The external renderer ($renderer->name)\nexited with code $exit_code,\nor potentially did not create the output file.\nDetails:\n" . wordwrap($error_details) )); exit(); } header("cache-control: public, max-age=31536000, immutable"); header("content-type: $renderer->output_format"); header("content-length: " . filesize($cache_file_location)); header("x-cache: render_ext/miss, renderer took {$time_taken}ms"); readfile($cache_file_location); }); /* * ███████ ████████ █████ ████████ ██ ███████ ████████ ██ ██████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ███████ ██ ██ ███████ ██ ██ ██ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ██ ██ ██ ███████ ██ ██ ██████ ███████ */ statistic_add([ "id" => "wanted-pages", "name" => "Wanted Pages", "type" => "page", "update" => function($old_stats) { global $pageindex, $env; $result = new stdClass(); // completed, value, state $pages = []; foreach($pageindex as $pagename => $pagedata) { if(!file_exists($env->storage_prefix . $pagedata->filename)) continue; $page_content = file_get_contents($env->storage_prefix . $pagedata->filename); $page_links = PeppermintParsedown::extract_page_names($page_content); foreach($page_links as $linked_page) { // We're only interested in pages that don't exist if(!empty($pageindex->$linked_page)) continue; if(empty($pages[$linked_page])) $pages[$linked_page] = 0; $pages[$linked_page]++; } } arsort($pages); $result->value = $pages; $result->completed = true; return $result; }, "render" => function($stats_data) { $result = "

$stats_data->name

\n"; $result .= "\n"; $result .= "\t\n"; foreach($stats_data->value as $pagename => $linking_pages) { $result .= "\t\n"; } $result .= "
Page NameLinking Pages
$pagename$linking_pages
\n"; return $result; } ]); statistic_add([ "id" => "orphan-pages", "name" => "Orphan Pages", "type" => "page-list", "update" => function($old_stats) { global $pageindex, $env; $result = new stdClass(); // completed, value, state $pages = []; foreach($pageindex as $pagename => $pagedata) { if(!file_exists($env->storage_prefix . $pagedata->filename)) continue; $page_content = file_get_contents($env->storage_prefix . $pagedata->filename); $page_links = PeppermintParsedown::extract_page_names($page_content); foreach($page_links as $linked_page) { // We're only interested in pages that exist if(empty($pageindex->$linked_page)) continue; $pages[$linked_page] = true; } } $orphaned_pages = []; foreach($pageindex as $pagename => $page_data) { if(empty($pages[$pagename])) $orphaned_pages[] = $pagename; } $sorter = new Collator(""); $sorter->sort($orphaned_pages); $result->value = $orphaned_pages; $result->completed = true; return $result; } ]); statistic_add([ "id" => "most-linked-to-pages", "name" => "Most Linked-To Pages", "type" => "page", "update" => function($old_stats) { global $pageindex, $env; $result = new stdClass(); // completed, value, state $pages = []; foreach($pageindex as $pagename => $pagedata) { if(!file_exists($env->storage_prefix . $pagedata->filename)) continue; $page_content = file_get_contents($env->storage_prefix . $pagedata->filename); $page_links = PeppermintParsedown::extract_page_names($page_content); foreach($page_links as $linked_page) { // We're only interested in pages that exist if(empty($pageindex->$linked_page)) continue; if(empty($pages[$linked_page])) $pages[$linked_page] = 0; $pages[$linked_page]++; } } arsort($pages); $result->value = $pages; $result->completed = true; return $result; }, "render" => function($stats_data) { global $pageindex; $result = "

$stats_data->name

\n"; $result .= "\n"; $result .= "\t\n"; foreach($stats_data->value as $pagename => $link_count) { $pagename_display = !empty($pageindex->$pagename->redirect) && $pageindex->$pagename->redirect ? "$pagename" : $pagename; $result .= "\t\n"; } $result .= "
Page NameLinking Pages
$pagename_display$link_count
\n"; return $result; } ]); add_help_section("20-parser-default", "Editor Syntax", "

$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

Extra Syntax

$settings->sitename's editor also supports some extra custom syntax, some of which is inspired by Mediawiki.
Type thisTo get thisComments
[[Internal link]]Internal LinkAn internal link.
[[Internal link|Display Text]]Display TextAn internal link with some display text.
![Alt text](http://example.com/path/to/image.png | 256x256 | right)Alt textAn image floating to the right of the page that fits inside a 256px x 256px box, preserving aspect ratio.
![Alt text](http://example.com/path/to/image.png | 256x256 | caption)
Alt text
Alt text
An image with a caption that fits inside a 256px x 256px box, preserving aspect ratio. The presence of the word caption in the regular braces causes the alt text to be taken and displayed below the image itself.
![Alt text](Files/Cheese.png)Alt textAn 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.
Some text ==marked text== more textSome text marked text more textMarked / highlighted text
Some text^superscript^ more textSome textsuperscript more textSuperscript
Some text~subscript~ more textSome textsubscript more textSubscript (note that we use a single tilda ~ here - a double results in strikethrough text instead)
[ ] Unticked checkbox Unticked checkboxAn unticked checkbox. Must be at the beginning of a line or directly after a list item (e.g. - or 1. ).
[x] Ticked checkbox Ticked checkboxAn ticked checkbox. The same rules as unticked checkboxes apply here too.
some text >!spoiler text!< more textsome text spoiler text more textA spoiler. Users must click it to reveal the content hidden beneath.
some text ||spoiler text|| more textsome text spoiler text more textAlternative spoiler syntax inspired by Discord.
[__TOC__]An automatic table of contents. Note that this must be on a line by itself with no text before or after it on that line for it to work.

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

Note that a page does not need to be included as a template to use these variables."); if($settings->parser_ext_renderers_enabled) { $doc_help = "

$settings->sitename supports external renderers. External renderers take the content of a code fence block, like this:

```language_code
Insert text here
```

...and render it to an image. This is based on the language_code specified, as is done in the above example. Precisely what the output of a external renderer is depends on the external renderers defined, but $settings->sitename currently has the following external renderers registered:

"; foreach($settings->parser_ext_renderers as $code => $renderer) { $row = array_map(function($value) { return htmlentities($value, ENT_COMPAT|ENT_HTML5); }, [ $renderer->name, $code, $renderer->description, $renderer->url ]); $row[3] = "🔗"; $doc_help .= "\n"; } $doc_help .= "
NameLanguage codeDescriptionReference Link
".implode("", $row)."
$settings->admindetails_name can register more external renderers - see the documentation for more information.

"; add_help_section("24-external-renderers", "External Renderers", $doc_help); } } ]); require_once("$paths->extra_data_directory/parser-parsedown/Parsedown.php"); require_once("$paths->extra_data_directory/parser-parsedown/ParsedownExtra.php"); // require_once("$paths->extra_data_directory/parser-parsedown/ParsedownExtended.php"); /** * Attempts to 'auto-correct' a page name by trying different capitalisation * combinations. * * @param string $pagename The page name to auto-correct. * @return string The auto-corrected page name. */ function parsedown_pagename_resolve($pagename) { global $pageindex; // If the page doesn't exist, check varying different // capitalisations to see if it exists under some variant. if(!empty($pageindex->$pagename)) return $pagename; $pagename = ucfirst($pagename); if(!empty($pageindex->$pagename)) return $pagename; $pagename = ucwords($pagename); return $pagename; } /* * ██████ █████ ██████ ███████ ███████ ██████ ██████ ██ ██ ███ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ████ ██ * ██████ ███████ ██████ ███████ █████ ██ ██ ██ ██ ██ █ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ███████ ███████ ██████ ██████ ███ ███ ██ ████ * * ███████ ██ ██ ████████ ███████ ███ ██ ███████ ██ ██████ ███ ██ ███████ * ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ████ ██ ██ * █████ ███ ██ █████ ██ ██ ██ ███████ ██ ██ ██ ██ ██ ██ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ██ ███████ ██ ████ ███████ ██ ██████ ██ ████ ███████ */ /** * The Peppermint-flavoured Parsedown parser. */ class PeppermintParsedown extends ParsedownExtra { /** * A long random and extremely unlikely string to identify where we want * to put a table of contents. * Hopefully nobody is unlucky enough to include this in a page...! * @var string */ private const TOC_ID = "█yyZiy9c9oHVExhVummYZId_dO9-fvaGFvgQirEapxOtaL-s7WnK34lF9ObBoQ0EH2kvtd6VKcAL2█"; /** * The base directory with which internal links will be resolved. * @var string */ private $internalLinkBase = "./%s"; /** * The parameter stack. Used for recursive templating. * @var array */ protected $paramStack = []; /** * Creates a new Peppermint Parsedown instance. */ function __construct() { parent::__construct(); array_unshift($this->BlockTypes["["], "TableOfContents"); array_unshift($this->BlockTypes["["], "OneBox"); // Prioritise our internal link parsing over the regular link parsing $this->addInlineType("[", "InternalLink", true); // Prioritise the checkbox handling - this is fine 'cause it doesn't step on InternalLink's toes $this->addInlineType("[", "Checkbox", true); // Prioritise our image parser over the regular image parser $this->addInlineType("!", "ExtendedImage", true); $this->addInlineType("{", "Template"); $this->addInlineType("=", "Mark"); $this->addInlineType("^", "Superscript"); $this->addInlineType("~", "Subscript"); $this->addInlineType(">", "Spoiler", true); $this->addInlineType("|", "Spoiler", true); } /** * Helper method to add an inline type. * @param string $char The char to match against. * @param string $function_id The name bit of the function to call. * @param boolean $before_others Whether to prioritise this function over other existing ones (default: false). */ protected function addInlineType(string $char, string $function_id, bool $before_others = false) { if(mb_strlen($char) > 1) throw new Exception("Error: '$char' is longer than a single character."); if(!isset($this->InlineTypes[$char]) or !is_array($this->InlineTypes[$char])) $this->InlineTypes[$char] = []; if(strpos($this->inlineMarkerList, $char) === false) $this->inlineMarkerList .= $char; if(!$before_others) $this->InlineTypes[$char][] = $function_id; else array_unshift($this->InlineTypes[$char], $function_id); } /* * Override the text method here to insert the table of contents after * rendering has been completed */ public function text($text) { $result = parent::text($text); $toc_html = $this->generateTableOfContents(); $result = str_replace(self::TOC_ID, $toc_html, $result); return $result; } /* * ████████ ███████ ███ ███ ██████ ██ █████ ████████ ██ ███ ██ ██████ * ██ ██ ████ ████ ██ ██ ██ ██ ██ ██ ██ ████ ██ ██ * ██ █████ ██ ████ ██ ██████ ██ ███████ ██ ██ ██ ██ ██ ██ ███ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ███████ ██ ██ ██ ███████ ██ ██ ██ ██ ██ ████ ██████ * %templating */ /** * Parses templating definitions. * @param string $fragment The fragment to parse it out from. */ protected function inlineTemplate($fragment) { global $env, $pageindex; // Variable parsing if(preg_match("/\{\{\{([^}]+)\}\}\}/", $fragment["text"], $matches)) { $params = []; if(!empty($this->paramStack)) { $stackEntry = array_slice($this->paramStack, -1)[0]; $params = !empty($stackEntry) ? $stackEntry["params"] : null; } $variableKey = trim($matches[1]); $variableValue = false; switch ($variableKey) { case "@": // Lists all variables and their values if(!empty($params)) { $variableValue = "\n"; foreach($params as $key => $value) { $variableValue .= "\t\n"; } $variableValue .= "
KeyValue
" . $this->escapeText($key) . "" . $this->escapeText($value) . "
"; } else { $variableValue = "(no variables are currently defined)"; } break; case "#": // Shows a stack trace $variableValue = "
    \n"; $variableValue .= "\t
  1. $env->page
  2. \n"; foreach($this->paramStack as $curStackEntry) { $variableValue .= "\t
  3. " . $curStackEntry["pagename"] . "
  4. \n"; } $variableValue .= "
\n"; break; case "~": // Show requested page's name if(!empty($this->paramStack)) $variableValue = $this->escapeText($env->page); break; case "*": // Lists subpages $subpages = get_subpages($pageindex, $env->page); $variableValue = []; foreach($subpages as $pagename => $depth) { $variableValue[] = $pagename; } $variableValue = implode(", ", $variableValue); if(strlen($variableValue) === 0) $variableValue = "(none yet!)"; break; case "+": // Shows a file gallery for subpages with files // If the upload module isn't present, then there's no point // in checking for uploaded files if(!module_exists("feature-upload")) break; $variableValue = []; $subpages = get_subpages($pageindex, $env->page); foreach($subpages as $pagename => $depth) { // Make sure that this is an uploaded file if(!$pageindex->$pagename->uploadedfile) continue; $mime_type = $pageindex->$pagename->uploadedfilemime; $previewSize = 300; $previewUrl = "?action=preview&size=$previewSize&page=" . rawurlencode($pagename); $previewType = substr($mime_type, 0, strpos($mime_type, "/")); if($mime_type == "application/pdf") $previewType = "pdf"; $previewHtml = ""; switch($previewType) { case "video": $previewHtml .= "\n"; break; case "audio": $previewHtml .= "\n"; break; case "pdf": $previewHtml .= ""; break; case "application": case "image": default: $previewHtml .= "\n"; break; } $previewHtml = "$previewHtml$pagename"; $variableValue[$pagename] = "
  • $previewHtml
  • "; } if(count($variableValue) === 0) $variableValue["default"] = "
  • (No files found)
  • \n"; $variableValue = implode("\n", $variableValue); $variableValue = ""; break; } if(isset($params[$variableKey])) $variableValue = $this->escapeText($params[$variableKey]); if($variableValue !== false) { return [ "extent" => strlen($matches[0]), "element" => [ "name" => "span", "attributes" => [ "class" => "template-var-value" ], // rawHtml is fine here 'cause we escape above // Note also that we *must* return some sort of element here: we can't just return rawHtml directly. It needs to be a property of an element. "rawHtml" => $variableValue ] ]; } } else if(preg_match("/\{\{([^}]+)\}\}/", $fragment["text"], $matches)) { $templateElement = $this->templateHandler($matches[1]); if(!empty($templateElement)) { return [ "extent" => strlen($matches[0]), "element" => $templateElement ]; } } } /** * Handles parsing out templates - recursively - and the parameter stack associated with it. * @param string $source The source string to process. * @return array The parsed result */ protected function templateHandler($source) { global $pageindex, $env; $parts = preg_split("/\\||¦/", trim($source, "{}")); $parts = array_map("trim", $parts); // Extract the name of the template page $templatePagename = array_shift($parts); // If the page that we are supposed to use as the template doesn't // exist, then there's no point in continuing. if(empty($pageindex->$templatePagename)) return false; // Parse the parameters $params = []; $i = 0; foreach($parts as $part) { if(strpos($part, "=") !== false) { // This param contains an equals sign, so it's a named parameter $keyValuePair = explode("=", $part, 2); $keyValuePair = array_map("trim", $keyValuePair); $params[$keyValuePair[0]] = $keyValuePair[1]; } else { // This isn't a named parameter $params["$i"] = trim($part); $i++; } } // Add the parsed parameters to the parameter stack $this->paramStack[] = [ "pagename" => $templatePagename, "params" => $params ]; $templateFilePath = $env->storage_prefix . $pageindex->$templatePagename->filename; // We use linesElements here to avoid resetting $this->DefinitionData (which is done in ->textElements) // Consequently, we have to do what textElements does directly $parsedTemplateSource = $this->linesElements(explode("\n", trim(str_replace(["\r\n", "\r"], "\n", file_get_contents($templateFilePath)), "\n") )); // Render it out. Important to preserve scope. $parsedTemplateSource = $this->elements($parsedTemplateSource); // HACK: Find/replace to ensure variables are inserted inside HTML. Note this does NOTE support special variables inside HTML - only simple ones. // This would cause issues if we later allow variables to be unset. foreach($params as $param_key => $param_value) { $parsedTemplateSource = str_replace("{{{".$param_key."}}}", $param_value, $parsedTemplateSource); } // Remove the parsed parameters from the stack array_pop($this->paramStack); return [ "name" => "div", "element" => [ "rawHtml" => $parsedTemplateSource, ], "attributes" => [ "class" => "template" ] ]; } /* * ██████ ██ ██ ███████ ██████ ██ ██ ██████ ██████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ███████ █████ ██ █████ ██████ ██ ██ ███ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ██ ███████ ██████ ██ ██ ██████ ██████ ██ ██ * %checkbox */ protected function inlineCheckbox($fragment) { // We're not interested if it's not at the beginning of a line if(strpos($fragment["context"], $fragment["text"]) !== 0) return; // If it doesn't match, then we're not interested if(preg_match('/\[([ x])\]/u', $fragment["text"], $matches) !== 1) return; $checkbox_content = $matches[1]; $result = [ "extent" => 3, "element" => [ "name" => "input", "attributes" => [ "type" => "checkbox", "disabled" => "disabled" ] ] ]; if($checkbox_content === "x") $result["element"]["attributes"]["checked"] = "checked"; return $result; } /* * ███ ███ █████ ██████ ██ ██ ███████ ██████ * ████ ████ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ████ ██ ███████ ██████ █████ █████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ███████ ██████ * * ████████ ███████ ██ ██ ████████ * ██ ██ ██ ██ ██ * ██ █████ ███ ██ * ██ ██ ██ ██ ██ * ██ ███████ ██ ██ ██ * %markedtext */ protected function inlineMark($fragment) { // A question mark makes the PCRE 1-or-more + there lazy instead of greedy. // Ref https://www.rexegg.com/regex-quantifiers.html#greedytrap if(preg_match('/==([^=]+?)==/', $fragment["text"], $matches) !== 1) return; $marked_text = $matches[1]; $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "mark", "handler" => [ "function" => "lineElements", "argument" => $marked_text, "destination" => "elements" ] ] ]; return $result; } /* * ██████ ██ ██ ██████ ██ ██████ ██ ██ ██████ ███████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ██████ ██ ███████ ██ ██ ██████ █████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ ██████ ██ ██████ ██████ ██ ███████ ██ ██ * * ██████ ██████ ██████ ██ ██████ ████████ * ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██████ ██ ██████ ██ * ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ ██ ██ ██ ██ ██ * %subsuperscript */ protected function inlineSuperscript($fragment) { if(preg_match('/\^([^^]+?)\^/', $fragment["text"], $matches) !== 1) return; $superscript_text = $matches[1]; $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "sup", "handler" => [ "function" => "lineElements", "argument" => $superscript_text, "destination" => "elements" ] ] ]; return $result; } protected function inlineSubscript($fragment) { if(preg_match('/~([^~]+?)~/', $fragment["text"], $matches) !== 1) return; $subscript_text = $matches[1]; $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "sub", "handler" => [ "function" => "lineElements", "argument" => $subscript_text, "destination" => "elements" ] ] ]; return $result; } /* * ███████ ██████ ██████ ██ ██ ███████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██████ ██ ██ ██ ██ █████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██████ ██ ███████ ███████ ██ ██ * %spoiler */ protected function inlineSpoiler($fragment) { if(preg_match('/(?:\|\||>!)([^|]+?)(?:\|\||!<)/', $fragment["text"], $matches) !== 1) return; $spoiler_text = $matches[1]; $id = "spoiler-".crypto_id(24); $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "a", "attributes" => [ "id" => $id, "class" => "spoiler", "href" => "#$id" ], "handler" => [ "function" => "lineElements", "argument" => $spoiler_text, "destination" => "elements" ] ] ]; return $result; } /* * ██ ███ ██ ████████ ███████ ██████ ███ ██ █████ ██ * ██ ████ ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ * ██ ██ ██ ██ ██ █████ ██████ ██ ██ ██ ███████ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ████ ██ ███████ ██ ██ ██ ████ ██ ██ ███████ * * ██ ██ ███ ██ ██ ██ ███████ * ██ ██ ████ ██ ██ ██ ██ * ██ ██ ██ ██ ██ █████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ████ ██ ██ ███████ * %internallinks */ /** * Parses internal links * @param string $fragment The fragment to parse. */ protected function inlineInternalLink($fragment) { global $pageindex, $env; if(preg_match('/^\[\[([^\]]*?)\]\]([^\s!?",;.()\[\]{}*=+\/]*)/u', $fragment["text"], $matches) === 1) { // 1: Parse parameters out // ------------------------------- $link_page = str_replace(["\r", "\n"], [" ", " "], trim($matches[1])); $display = $link_page . trim($matches[2]); if(strpos($matches[1], "|") !== false || strpos($matches[1], "¦") !== false) { // We have a bar character $parts = preg_split("/\\||¦/", $matches[1], 2); $link_page = trim($parts[0]); // The page to link to $display = trim($parts[1]); // The text to display } // 2: Parse the hash out // ------------------------------- $hash_code = ""; if(strpos($link_page, "#") !== false) { // We want to link to a subsection of a page $hash_code = substr($link_page, strpos($link_page, "#") + 1); $link_page = substr($link_page, 0, strpos($link_page, "#")); // If $link_page is empty then we want to link to the current page if(strlen($link_page) === 0) $link_page = $env->page; } // 3: Page name auto-correction // ------------------------------- $is_interwiki_link = module_exists("feature-interwiki-links") && is_interwiki_link($link_page); // Try different variants on the pagename to try and get it to // match something automagically if(!$is_interwiki_link && empty($pageindex->$link_page)) $link_page = parsedown_pagename_resolve($link_page); // 4: Construct the full url // ------------------------------- $link_url = null; // If it's an interwiki link, then handle it as such if($is_interwiki_link) $link_url = interwiki_get_pagename_url($link_page); // If it isn't (or it failed), then try it as a normal link instead if(empty($link_url)) { $link_url = str_replace( "%s", rawurlencode($link_page), $this->internalLinkBase ); // We failed to handle it as an interwiki link, so we should // tell everyone that $is_interwiki_link = false; } // 5: Construct the title // ------------------------------- $title = $link_page; if($is_interwiki_link) $title = interwiki_pagename_resolve($link_page)->name . ": " . interwiki_pagename_parse($link_page)[1] . " (Interwiki)"; if(strlen($hash_code) > 0) $link_url .= "#$hash_code"; // 6: Result encoding // ------------------------------- $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "a", "text" => $display, "attributes" => [ "href" => $link_url, "title" => $title ] ] ]; // Attach some useful classes based on how we handled it $class_list = []; // Interwiki links can never be redlinks if(!$is_interwiki_link && empty($pageindex->{makepathsafe($link_page)})) $class_list[] = "redlink"; if($is_interwiki_link) $class_list[] = "interwiki_link"; $result["element"]["attributes"]["class"] = implode(" ", $class_list); return $result; } } /* ███ █████ ███ ██ ██ ██████ ███ ███ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ████ ████ ██ ██ ██ ██ ███████ ██ ██ ██ ██████ ██ ████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ ██ ███ ██ ██ ██ ██████ ██ ██ ██ ██████ ██ */ // This wraps the native [display text](url) syntax protected function inlineLink($fragment) { global $settings; // If this feature is disabled, defer to the parent implementation unconditionally if(!$settings->parser_mangle_external_links) return parent::inlineLink($fragment); // Extract the URL from the internal link. If it fails defer to the parent function // 1 = display text, 2 = url if(preg_match("/^\[([^[\]]+?)\]\(\s*([^()]+)\s*\)/", $fragment["text"], $matches) !== 1) return parent::inlineLink($fragment); // Check the URL. If it doesn't match our *exact* format, then it doesn't happen. if(!is_string($matches[2]) || preg_match("/^\.\/(.+)\.md$/", $matches[2], $matches_url) !== 1) return parent::inlineLink($fragment); // The page name is made safe when Pepperminty Wiki does initial consistency checks (if it's unsafe it results in a 301 redirect) $page_name = parsedown_pagename_resolve($matches_url[1]); $internal_link_text = "[[${page_name}]]"; if(!empty($matches[1])) // If the display text isn't empty, then respect it $internal_link_text = "[[${page_name}¦{$matches[1]}]]"; $result = $this->inlineInternalLink([ "text" => $internal_link_text ]); $result["extent"] = strlen($fragment["text"]); // Parsedown isn't mb_ friendly return $result; } /* * ███████ ██ ██ ████████ ███████ ███ ██ ██████ ███████ ██████ * ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ██ * █████ ███ ██ █████ ██ ██ ██ ██ ██ █████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ ██ ██ ██ ███████ ██ ████ ██████ ███████ ██████ * * ██ ███ ███ █████ ██████ ███████ ███████ * ██ ████ ████ ██ ██ ██ ██ ██ * ██ ██ ████ ██ ███████ ██ ███ █████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ██████ ███████ ███████ * %extendedimages */ /** * Parses the extended image syntax. * @param string $fragment The source fragment to parse. */ protected function inlineExtendedImage($fragment) { global $pageindex; if(preg_match('/^!\[(.*)\]\(([^|¦)]+)\s*(?:(?:\||¦)([^|¦)]*))?(?:(?:\||¦)([^|¦)]*))?(?:(?:\||¦)([^)]*))?\)/', $fragment["text"], $matches)) { /* * 0 - Everything * 1 - Alt text * 2 - Url * 3 - First param (optional) * 4 - Second param (optional) * 5 - Third param (optional) */ $altText = $matches[1]; $imageUrl = trim(str_replace("&", "&", $matches[2])); // Decode & to allow it in preview urls $param1 = empty($matches[3]) ? false : strtolower(trim($matches[3])); $param2 = empty($matches[4]) ? false : strtolower(trim($matches[4])); $param3 = empty($matches[5]) ? false : strtolower(trim($matches[5])); $floatDirection = false; $imageSize = false; $imageCaption = false; $shortImageUrl = false; if($this->isFloatValue($param1)) { // Param 1 is a valid css float: ... value $floatDirection = $param1; $imageSize = $this->parseSizeSpec($param2); } else if($this->isFloatValue($param2)) { // Param 2 is a valid css float: ... value $floatDirection = $param2; $imageSize = $this->parseSizeSpec($param1); } else if($this->isFloatValue($param3)) { $floatDirection = $param3; $imageSize = $this->parseSizeSpec($param1); } else if($param1 === false and $param2 === false) { // Neither params were specified $floatDirection = false; $imageSize = false; } else { // Neither of them are floats, but at least one is specified // This must mean that the first param is a size spec like // 250x128. $imageSize = $this->parseSizeSpec($param1); } if($param1 !== false && strtolower(trim($param1)) == "caption") $imageCaption = true; if($param2 !== false && strtolower(trim($param2)) == "caption") $imageCaption = true; if($param3 !== false && strtolower(trim($param3)) == "caption") $imageCaption = true; //echo("Image url: $imageUrl, Pageindex entry: " . var_export(isset($pageindex->$imageUrl), true) . "\n"); if(isset($pageindex->$imageUrl) and $pageindex->$imageUrl->uploadedfile) { // We have a short url! Expand it. $shortImageUrl = $imageUrl; $imageUrl = "index.php?action=preview"; if($imageSize !== false) $imageUrl .= "&size=" . max($imageSize["x"], $imageSize["y"]); else $imageUrl .= "&size=original"; // This has to be last in order for the extension auto-detection to work correctly $imageUrl .= "&page=" . rawurlencode($shortImageUrl); } $style = ""; if($imageSize !== false) $style .= " max-width: " . $imageSize["x"] . "px; max-height: " . $imageSize["y"] . "px;"; if($floatDirection) $style .= " float: $floatDirection;"; $urlExtension = pathinfo($imageUrl, PATHINFO_EXTENSION); $urlType = system_extension_mime_type($urlExtension); $embed_type = substr($urlType, 0, strpos($urlType, "/")); if($urlType == "application/pdf") $embed_type = "pdf"; // Check if the URL is a recognised external provider $ext_provider_result = $this->__make_embed($imageUrl, $altText); if($ext_provider_result !== null) $embed_type = "ext_provider"; $result = []; switch($embed_type) { case "pdf": $imageUrl = preg_replace("/&size=[0-9]+/", "&size=original", $imageUrl); if($imageSize === false) $style .= "width: 100%;"; else $style = str_replace("max-width", "width", $style); $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "object", "text" => "", "attributes" => [ "type" => "application/pdf", "data" => $imageUrl, "style" => trim($style) ] ] ]; break; case "ext_provider": $result = [ "extent" => strlen($matches[0]), "element" => $ext_provider_result ]; break; case "audio": $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "audio", "text" => $altText, "attributes" => [ "src" => $imageUrl, "controls" => "controls", "preload" => "metadata", "style" => trim($style) ] ] ]; break; case "video": $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "video", "text" => $altText, "attributes" => [ "src" => $imageUrl, "controls" => "controls", "preload" => "metadata", "style" => trim($style) ] ] ]; break; case "image": default: // If we can't work out what it is, then assume it's an image $result = [ "extent" => strlen($matches[0]), "element" => [ "name" => "img", "attributes" => [ "src" => $imageUrl, "alt" => $altText, "title" => $altText, "style" => trim($style) ] ] ]; break; } // ~ Image linker ~ $imageHref = $shortImageUrl !== false ? "?page=" . rawurlencode($shortImageUrl) : $imageUrl; if($embed_type !== "pdf") { $result["element"] = [ "name" => "a", "attributes" => [ "href" => $imageHref ], "text" => [$result["element"]], "handler" => "elements" ]; } // ~ if($imageCaption) { $rawStyle = $result["element"]["text"][0]["attributes"]["style"]; $containerStyle = preg_replace('/^.*float/', "float", $rawStyle); $mediaStyle = preg_replace('/\s*float.*;/', "", $rawStyle); $result["element"] = [ "name" => "figure", "attributes" => [ "style" => $containerStyle ], "text" => [ $result["element"], [ "name" => "figcaption", // We use lineElements here because of issue #209 - in short it makes it appear as part of the same document to avoid breaking footnotes // Specifically ->text() calls ->textElements(), which resets $this->DefinitionData, which is used to hold information about footnotes // lineElements = inline text, and linesElements = multiline text "handler" => [ "function" => "lineElements", "argument" => $altText, "destination" => "elements" ] ], ], "handler" => "elements" ]; $result["element"]["text"][0]["attributes"]["style"] = $mediaStyle; } return $result; } } /** * Makes an embed HTML tree for a given URL. * Example URLs include YouTube links, Vimeo, etc. * @param string $url The URL to generate an embed for. * @return array|null The embed HTML tree, or null if generation failed (e.g. if the URL wasn't recognised). */ protected function __make_embed(string $url_text, string $alt_text) { // 1: URL parsing $url = parse_url($url_text); $url["host"] = preg_replace("/^www\./", "", $url["host"] ?? ""); parse_str($url["query"] ?? "", $query); // 2: Pre-generation transforms switch($url["host"]) { case "player.vimeo.com": $url["host"] = "vimeo.com"; $url["path"] = preg_replace("/^\/video/", "", $url["path"]); break; case "youtu.be": $query["v"] = preg_replace("/^\//", "", $url["path"]); $url["host"] = "youtube.com"; $url["path"] = "/watch"; break; } // 3: Actual embed generation switch ($url["host"]) { case "youtube.com": if($url["path"] !== "/watch" || empty($query["v"])) return null; return [ "name" => "iframe", "attributes" => [ "src" => "https://www.youtube.com/embed/{$query["v"]}", "frameborder" => "0", "allow" => "fullscreen; encrypted-media; picture-in-picture" ], "text" => "YouTube: $alt_text" ]; break; case "vimeo.com": if(strlen($url["path"]) <= 1 || preg_match("/[^0-9\/]/", $url["path"]) === 1) return null; return [ "name" => "iframe", "attributes" => [ "src" => "https://player.vimeo.com/video{$url["path"]}", "frameborder" => "0", "allow" => "fullscreen; picture-in-picture" ], "text" => "Vimeo: $alt_text" ]; break; default: return null; } } /* * ██████ ██████ ██████ ███████ ██████ ██ ██████ ██████ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ██ ██ █████ ██████ ██ ██ ██ ██ █████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██████ ██████ ███████ ██████ ███████ ██████ ██████ ██ ██ * * ██ ██ ██████ ██████ ██████ █████ ██████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██████ ██ ███ ██████ ███████ ██ ██ █████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ██████ ██ ██ ██ ██ ██████ ███████ * %codeblockupgrade */ protected function blockFencedCodeComplete($block) { global $settings; $result = parent::blockFencedCodeComplete($block); // Default value: "text" $language = preg_replace("/^language-/", "", $block["element"]["element"]["attributes"]["class"] ?? "language-text"); if(!isset($settings->parser_ext_renderers->$language)) return $result; $text = $result["element"]["element"]["text"]; $renderer = $settings->parser_ext_renderers->$language; $result["element"] = [ "name" => "p", "element" => [ "name" => "img", "attributes" => [ "alt" => "Diagram rendered by {$renderer->name}", "src" => "?action=parsedown-render-ext&language=".rawurlencode($language)."&immutable_key=".hash("crc32b", json_encode($renderer))."&source=".rawurlencode($text) ] ] ]; if(!empty($renderer->output_classes)) $result["element"]["element"]["attributes"]["class"] = implode(" ", $renderer->output_classes); return $result; } /* * ██ ██ ███████ █████ ██████ ███████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ███████ █████ ███████ ██ ██ █████ ██████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ███████ ██ ██ ██████ ███████ ██ ██ * %header %toc */ private $headingIdsUsed = []; private $tableOfContents = []; /** * Inserts an item into the table of contents. * @param int $level The level to insert it at (valid values: 1 - 6) * @param string $id The id of the item. * @param string $text The text to display. */ protected function addTableOfContentsEntry(int $level, string $id, string $text) : void { $new_obj = (object) [ "level" => $level, "id" => $id, "text" => $text, "children" => [] ]; if(count($this->tableOfContents) == 0) { $this->tableOfContents[] = $new_obj; return; } $lastEntry = end($this->tableOfContents); if($level > $lastEntry->level) { $this->insertTableOfContentsObject($new_obj, $lastEntry); return; } $this->tableOfContents[] = $new_obj; return; } private function insertTableOfContentsObject(object $obj, object $target) { if($obj->level - 1 > $target->level && !empty($target->children)) { $this->insertTableOfContentsObject($obj, end($target->children)); return; } $target->children[] = $obj; } protected function generateTableOfContents() : string { global $settings; $elements = [ $this->generateTableOfContentsElement($this->tableOfContents) ]; if($settings->parser_toc_heading_level > 1) array_unshift( $elements, [ "name" => "h$settings->parser_toc_heading_level", "text" => "Table of Contents", "attributes" => [ "id" => "table-of-contents" ] ] ); return trim($this->elements($elements), "\n"); } private function generateTableOfContentsElement($toc) : array { $elements = []; foreach($toc as $entry) { $next = [ "name" => "li", "attributes" => [ "data-level" => $entry->level ], "elements" => [ [ "name" => "a", "attributes" => [ "href" => "#$entry->id" ], "handler" => [ "function" => "lineElements", "argument" => $entry->text, "destination" => "elements" ] ] ] ]; if(isset($entry->children)) $next["elements"][] = $this->generateTableOfContentsElement($entry->children); $elements[] = $next; } return [ "name" => "ul", "elements" => $elements ]; } protected function blockHeader($line) { // This function overrides the header function defined in ParsedownExtra $result = parent::blockHeader($line); // If this heading doesn't have an id already, add an automatic one if(!isset($result["element"]["attributes"]["id"])) { $heading_id = str_replace(" ", "-", mb_strtolower(makepathsafe( $result["element"]["handler"]["argument"] )) ); $suffix = ""; while(in_array($heading_id . $suffix, $this->headingIdsUsed)) { $heading_number = intval(str_replace("_", "", $suffix)); if($heading_number == 0) $heading_number++; $suffix = "_" . ($heading_number + 1); } $result["element"]["attributes"]["id"] = $heading_id . $suffix; $this->headingIdsUsed[] = $result["element"]["attributes"]["id"]; } $this->addTableOfContentsEntry( intval(strtr($result["element"]["name"], [ "h" => "" ])), $result["element"]["attributes"]["id"], $result["element"]["handler"]["argument"] ); return $result; } /* * Inserts a special string to identify where we need to put the table of contents later */ protected function blockTableOfContents($fragment) { // Indent? Don't even want to know if($fragment["indent"] > 0) return; // If it doesn't match, then we're not interested if(preg_match('/^\[_*(?:TOC|toc)_*\]$/u', $fragment["text"], $matches) !== 1) return; $result = [ "element" => [ "text" => self::TOC_ID ] ]; return $result; } /* * ██████ ███ ██ ███████ ██████ ██████ ██ ██ ██ ███ ██ ██████ * ██ ██ ████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ████ ██ ██ * ██ ██ ██ ██ ██ █████ ██████ ██ ██ ███ ██ ██ ██ ██ ██ ███ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ████ ███████ ██████ ██████ ██ ██ ██ ██ ████ ██████ */ protected function blockOneBox($fragment, $current_block) { global $env, $settings, $pageindex; // error_log("FRAGMENT ".var_export($fragment, true)); if($fragment["indent"] > 0 || !$settings->parser_onebox_enabled) return; if(preg_match('/^\[\[\[([^\]]*?)\]\]\]$/u', $fragment["text"], $matches) !== 1) return; // 1: Parse parameters out // ------------------------------- $link_page = trim(str_replace(["\r", "\n"], [" ", " "], $matches[1])); if(empty($pageindex->$link_page)) return; $link_page_content = file_get_contents($env->storage_prefix.$pageindex->$link_page->filename); $preview = $link_page_content; if(mb_strlen($preview) > $settings->parser_onebox_preview_length) $preview = mb_substr($preview, 0, $settings->parser_onebox_preview_length) . "…"; // 2: Generate onebox // ------------------------------- $result = [ "element" => [ "name" => "a", "attributes" => [ "class" => "onebox", "href" => "?page=".rawurlencode($link_page) ], "elements" => [ [ "name" => "div", "attributes" => [ "class" => "onebox-header" ], "text" => $link_page ], [ "name" => "div", "attributes" => [ "class" => "onebox-preview" ], "text" => $preview ] ] ] ]; return $result; } # ~ # Static Methods # ~ /** * Extracts the page names from internal links in a given markdown source. * Does not actually _parse_ the source - only extracts via a regex. * @param string $page_text The source text to extract a list of page names from. * @return array A list of page names that the given source text links to. */ public static function extract_page_names($page_text) { global $pageindex; preg_match_all("/\[\[([^\]]+)\]\]/u", $page_text, $linked_pages); if(count($linked_pages[1]) === 0) return []; // No linked pages here $result = []; foreach($linked_pages[1] as $linked_page) { // Strip everything after the | and the # $linked_page = preg_replace("/[|¦#].*/u", "", $linked_page); if(strlen($linked_page) === 0) continue; // Make sure we try really hard to find this page in the // pageindex $altered_linked_page = $linked_page; if(!empty($pageindex->{ucfirst($linked_page)})) $altered_linked_page = ucfirst($linked_page); else if(!empty($pageindex->{ucwords($linked_page)})) $altered_linked_page = ucwords($linked_page); else // Our efforts were in vain, so reset to the original $altered_linked_page = $linked_page; $result[] = $altered_linked_page; } return $result; } /* * ██ ██ ████████ ██ ██ ██ ████████ ██ ███████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██ ██ ██ ██ ██ ██ ██ ██ █████ ███████ * ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ * ██████ ██ ██ ███████ ██ ██ ██ ███████ ███████ * %utilities */ /** * Returns whether a string is a valid float: XXXXXX; value. * Used in parsing the extended image syntax. * @param string $value The value check. * @return bool Whether it's valid or not. */ private function isFloatValue(string $value) { return in_array(strtolower($value), [ "left", "right" ]); } /** * Parses a size specifier into an array. * @param string $text The source text to parse. e.g. "256x128" * @return array|bool The parsed size specifier. Example: ["x" => 256, "y" => 128]. Returns false if parsing failed. */ private function parseSizeSpec(string $text) { if(strpos($text, "x") === false) return false; $parts = explode("x", $text, 2); if(count($parts) != 2) return false; array_map("trim", $parts); array_map("intval", $parts); if(in_array(0, $parts)) return false; return [ "x" => $parts[0], "y" => $parts[1] ]; } /** * Escapes the source text via htmlentities. * @param string $text The text to escape. * @return string The escaped string. */ protected function escapeText($text) { return htmlentities($text, ENT_COMPAT | ENT_HTML5); } /** * Sets the base url to be used for internal links. '%s' will be replaced * with a URL encoded version of the page name. * @param string $url The url to use when parsing internal links. */ public function setInternalLinkBase($url) { $this->internalLinkBase = $url; } } ?>