Lexer->addSpecialPattern('---json.*?---', $mode, PluginUtility::getModeForComponent($this->getPluginComponent())); } } /** * * The handle function goal is to parse the matched syntax through the pattern function * and to return the result for use in the renderer * This result is always cached until the page is modified. * @param string $match * @param int $state * @param int $pos * @param Doku_Handler $handler * @return array|bool * @see DokuWiki_Syntax_Plugin::handle() * */ function handle($match, $state, $pos, Doku_Handler $handler) { if ($state == DOKU_LEXER_SPECIAL) { global $ID; // strip // from start `---json` + eol = 8 // from end `---` + eol = 4 $match = substr($match, 7, -3); // Empty front matter if (trim($match) == "") { $this->closeParsing(); return array(self::STATUS => self::PARSING_STATE_EMPTY); } // Otherwise you get an object ie $arrayFormat-> syntax $arrayFormat = true; $json = json_decode($match, $arrayFormat); // Decodage problem if ($json == null) { return array( self::STATUS => self::PARSING_STATE_ERROR, PluginUtility::PAYLOAD => $match ); } $notModifiableMeta = [ "date", "user", "last_change", "creator", "contributor" ]; $result = array(); foreach ($json as $key => $value) { $lowerCaseKey = trim(strtolower($key)); // Not modifiable metadata if (in_array($lowerCaseKey, $notModifiableMeta)) { LogUtility::msg("Front Matter: The metadata ($lowerCaseKey) is a protected metadata and cannot be modified", LogUtility::LVL_MSG_WARNING); continue; } switch ($lowerCaseKey) { case Page::DESCRIPTION_PROPERTY: $result["description"] = $value; /** * Overwrite also the actual description */ p_set_metadata($ID, array(Page::DESCRIPTION_PROPERTY => array( "abstract" => $value, "origin" => syntax_plugin_combo_frontmatter::CANONICAL ))); /** * Continue because * the description value was already stored * We don't want to override it * And continue 2 because continue == break in a switch */ continue 2; break; /** * Pass the title to the metadata * to advertise that it's in the front-matter * for the quality rules */ case Page::TITLE_PROPERTY: $result[Page::TITLE_PROPERTY] = $value; break; /** * Pass the low quality indicator * to advertise that it's in the front-matter */ case Page::LOW_QUALITY_PAGE_INDICATOR: $result[Page::LOW_QUALITY_PAGE_INDICATOR] = $value; break; // Canonical should be lowercase case Page::CANONICAL_PROPERTY: $result[Page::CANONICAL_PROPERTY] = $value; $value = strtolower($value); break; } // Set the value persistently p_set_metadata($ID, array($lowerCaseKey => $value)); } $this->closeParsing($json); $result[self::STATUS] = self::PARSING_STATE_SUCCESSFUL; return $result; } return array(); } /** * Render the output * @param string $format * @param Doku_Renderer $renderer * @param array $data - what the function handle() return'ed * @return boolean - rendered correctly? (however, returned value is not used at the moment) * @see DokuWiki_Syntax_Plugin::render() * * */ function render($format, Doku_Renderer $renderer, $data) { switch ($format) { case 'xhtml': global $ID; /** @var Doku_Renderer_xhtml $renderer */ $state = $data[self::STATUS]; if ($state == self::PARSING_STATE_ERROR) { $json = $data[PluginUtility::PAYLOAD]; LogUtility::msg("Front Matter: The json object for the page ($ID) is not valid. See the errors it by clicking on this link.", LogUtility::LVL_MSG_ERROR); } break; case Analytics::RENDERER_FORMAT: /** @var renderer_plugin_combo_analytics $renderer */ if (array_key_exists("description", $data)) { $renderer->setMeta("description", $data["description"]); } if (array_key_exists(Page::CANONICAL_PROPERTY, $data)) { $renderer->setMeta(Page::CANONICAL_PROPERTY, $data[Page::CANONICAL_PROPERTY]); } if (array_key_exists(Page::TITLE_PROPERTY, $data)) { $renderer->setMeta(Page::TITLE_PROPERTY, $data[Page::TITLE_PROPERTY]); } if (array_key_exists(Page::LOW_QUALITY_PAGE_INDICATOR, $data)) { $renderer->setMeta(Page::LOW_QUALITY_PAGE_INDICATOR, $data[Page::LOW_QUALITY_PAGE_INDICATOR]); } break; } return true; } /** * * @param array $json - The Json * Delete the controlled meta that are no more present if they exists * @return bool */ public function closeParsing(array $json = array()) { global $ID; /** * The managed meta with the exception of * the {@link action_plugin_combo_metadescription::DESCRIPTION_META_KEY description} * because it's already managed by dokuwiki in description['abstract'] */ $managedMeta = [ Page::CANONICAL_PROPERTY, action_plugin_combo_metatitle::TITLE_META_KEY, syntax_plugin_combo_disqus::META_DISQUS_IDENTIFIER ]; $meta = p_read_metadata($ID); foreach ($managedMeta as $metaKey) { if (!array_key_exists($metaKey, $json)) { if (isset($meta['persistent'][$metaKey])) { unset($meta['persistent'][$metaKey]); } } } return p_save_metadata($ID, $meta); } }