xref: /plugin/combo/action/pagesystemmutation.php (revision 4cadd4f8c541149bdda95f080e38a6d4e3a640ca)

<?php

use ComboStrap\CacheDependencies;
use ComboStrap\Event;
use ComboStrap\FileSystems;
use ComboStrap\LocalPath;
use ComboStrap\Page;
use ComboStrap\PagePath;
use ComboStrap\Site;


require_once(__DIR__ . '/../ComboStrap/PluginUtility.php');

/**
 * When a page is added or deleted from the file system
 */
class action_plugin_combo_pagesystemmutation extends DokuWiki_Action_Plugin
{


    public const PAGE_SYSTEM_MUTATION_EVENT_NAME = 'page_system_mutation';

    const TYPE_ATTRIBUTE = "type";
    const TYPE_CREATION = "creation";
    const TYPE_DELETION = "deletion";


    public function register(Doku_Event_Handler $controller)
    {


        /**
         * To delete sidebar (cache) cache when a page was modified in a namespace
         * https://combostrap.com/sideslots
         */
        $controller->register_hook('IO_WIKIPAGE_WRITE', 'BEFORE', $this, 'createFileSystemMutation', array());

        /**
         * process the Async event
         */
        $controller->register_hook(self::PAGE_SYSTEM_MUTATION_EVENT_NAME, 'AFTER', $this, 'handleFileSystemMutation');

    }

    /**
     * @param $event
     * @throws Exception
     * @link https://www.dokuwiki.org/devel:event:io_wikipage_write
     */
    function createFileSystemMutation($event)
    {

        $data = $event->data;
        $pageName = $data[2];

        /**
         * Modification to the secondary slot are not processed
         */
        if (in_array($pageName, Site::getSecondarySlotNames())) return;


        /**
         * File creation
         *
         * ```
         * Page creation may be detected by checking if the file already exists and the revision is false.
         * ```
         * From https://www.dokuwiki.org/devel:event:io_wikipage_write
         *
         */
        $rev = $data[3];
        $filePath = $data[0][0];
        $file = LocalPath::createFromPath($filePath);
        if (!FileSystems::exists($file) && $rev === false) {
            Event::createEvent(
                action_plugin_combo_pagesystemmutation::PAGE_SYSTEM_MUTATION_EVENT_NAME,
                [
                    self::TYPE_ATTRIBUTE => self::TYPE_CREATION,
                    PagePath::getPersistentName() => $file->toDokuPath()->toString()
                ]
            );
            return;
        }

        /**
         * File deletion
         * (No content)
         *
         * ```
         * Page deletion may be detected by checking for empty page content.
         * On update to an existing page this event is called twice, once for the transfer of the old version to the attic (rev will have a value)
         * and once to write the new version of the page into the wiki (rev is false)
         * ```
         * From https://www.dokuwiki.org/devel:event:io_wikipage_write
         */
        $append = $data[0][2];
        if (!$append) {

            $content = $data[0][1];
            if (empty($content) && $rev === false) {
                // Deletion
                Event::createEvent(
                    action_plugin_combo_pagesystemmutation::PAGE_SYSTEM_MUTATION_EVENT_NAME,
                    [
                        self::TYPE_ATTRIBUTE => self::TYPE_DELETION,
                        PagePath::getPersistentName() => $file->toDokuPath()->toString()
                    ]
                );
            }
        }

    }

    public function handleFileSystemMutation($event)
    {

        /**
         * We need to re-render the slot
         * that are {@link \ComboStrap\CacheDependencies::PAGE_SYSTEM_DEPENDENCY}
         * dependent
         */
        $data = $event->data;

        /**
         * Re-render
         */
        $path = $data[PagePath::getPersistentName()];
        CacheDependencies::reRenderSecondarySlotsIfNeeded(
            $path,
            CacheDependencies::PAGE_SYSTEM_DEPENDENCY,
            self::PAGE_SYSTEM_MUTATION_EVENT_NAME
        );

    }


}