xref: /template/strap/action/imgmove.php (revision 37748cd8654635afbeca80942126742f0f4cc346)

<?php

use ComboStrap\DokuPath;
use ComboStrap\LinkUtility;
use ComboStrap\LogUtility;
use ComboStrap\Page;
use ComboStrap\PluginUtility;

if (!defined('DOKU_INC')) die();
require_once(__DIR__ . '/../ComboStrap/PluginUtility.php');
require_once(__DIR__ . '/../ComboStrap/LinkUtility.php');

/**
 * Handle the move of a image
 */
class action_plugin_combo_imgmove extends DokuWiki_Action_Plugin
{

    /**
     * As explained https://www.dokuwiki.org/plugin:move
     * @param Doku_Event_Handler $controller
     */
    function register(Doku_Event_Handler $controller)
    {
        $controller->register_hook('PLUGIN_MOVE_HANDLERS_REGISTER', 'BEFORE', $this, 'handle_move', array());
    }

    /**
     * Handle the move of a image
     * @param Doku_Event $event
     * @param $params
     */
    function handle_move(Doku_Event $event, $params)
    {
        /**
         * The handlers is the name of the component (ie refers to the {@link syntax_plugin_combo_media} handler)
         * and 'move_combo_img' to the below method
         */
        $event->data['handlers'][syntax_plugin_combo_media::COMPONENT] = array($this, 'move_combo_img');
        $event->data['handlers'][syntax_plugin_combo_frontmatter::COMPONENT] = array($this, 'move_combo_frontmatter_img');
    }

    /**
     *
     * @param $match
     * @param $state
     * @param $pos
     * @param $plugin
     * @param helper_plugin_move_handler $handler
     */
    public function move_combo_img($match, $state, $pos, $plugin, helper_plugin_move_handler $handler)
    {
        /**
         * The original move method
         * is {@link helper_plugin_move_handler::media()}
         *
         */
        $handler->media($match, $state, $pos);

    }

    /**
     *
     * @param $match
     * @param $state
     * @param $pos
     * @param $plugin
     * @param helper_plugin_move_handler $handler
     * @return string
     */
    public function move_combo_frontmatter_img($match, $state, $pos, $plugin, helper_plugin_move_handler $handler)
    {
        /**
         * The original move method
         * is {@link helper_plugin_move_handler::media()}
         *
         */
        $jsonArray = syntax_plugin_combo_frontmatter::FrontMatterMatchToAssociativeArray($match);
        if ($jsonArray === null) {
            return $match;
        } else {

            if (!isset($jsonArray[Page::IMAGE_META_PROPERTY])) {
                return $match;
            }

            try {
                $images = &$jsonArray[Page::IMAGE_META_PROPERTY];
                if (is_array($images)) {
                    foreach ($images as &$subImage) {
                        if (is_array($subImage)) {
                            foreach($subImage as &$subSubImage){
                                if(is_string($subSubImage)) {
                                    $this->moveImage($subSubImage, $handler);
                                } else {
                                    LogUtility::msg("The image frontmatter value (".hsc(var_export($subSubImage))." is not a string and cannot be therefore moved", LogUtility::LVL_MSG_ERROR,syntax_plugin_combo_frontmatter::METADATA_IMAGE_CANONICAL);
                                    return $match;
                                }
                            }
                        } else {
                            $this->moveImage( $subImage, $handler);
                        }
                    }
                } else {
                    $this->moveImage($images, $handler);
                }
            } catch(Exception $e){
                // Could not resolve the image, return the data without modification
                return $match;
            }

            $jsonEncode = json_encode($jsonArray, JSON_PRETTY_PRINT);
            if ($jsonEncode === false) {
                LogUtility::msg("A move error has occurred while trying to store the modified metadata as json (" . hsc(var_export($images, true)) . ")", LogUtility::LVL_MSG_ERROR);
                return $match;
            }
            $frontmatterStartTag = syntax_plugin_combo_frontmatter::START_TAG;
            $frontmatterEndTag = syntax_plugin_combo_frontmatter::END_TAG;

            /**
             * All good,
             * We don't modify the metadata for the page
             * because the handler does not give it unfortunately
             */

            /**
             * Return the match modified
             */
            return <<<EOF
$frontmatterStartTag
$jsonEncode
$frontmatterEndTag
EOF;

        }

    }

    /**
     * Move a single image and update the JSon
     * @param $value
     * @param helper_plugin_move_handler $handler
     * @throws Exception on bad argument
     */
    private function moveImage(&$value, $handler)
    {
        try {
            $newId = $handler->resolveMoves($value, "media");
            $value = DokuPath::IdToAbsolutePath($newId);
        } catch (Exception $e) {
            LogUtility::msg("A move error has occurred while trying to move the image ($value). The target resolution function send the following error message: " . $e->getMessage(), LogUtility::LVL_MSG_ERROR);
            throw new RuntimeException();
        }
    }


}