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

<?php

use ComboStrap\CacheDependencies;
use ComboStrap\CacheLog;
use ComboStrap\CacheManager;
use ComboStrap\Event;
use ComboStrap\ExceptionCombo;
use ComboStrap\FileSystems;
use ComboStrap\LogUtility;
use ComboStrap\MetadataDokuWikiStore;
use ComboStrap\Page;
use ComboStrap\PagePath;
use ComboStrap\Reference;
use ComboStrap\References;


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

/**
 * Refresh the analytics when a backlink mutation occurs for a page
 */
class action_plugin_combo_backlinkmutation extends DokuWiki_Action_Plugin
{


    public const BACKLINK_MUTATION_EVENT_NAME = 'backlink_mutation';


    public function register(Doku_Event_Handler $controller)
    {


        /**
         * create the async event
         */
        $controller->register_hook(MetadataDokuWikiStore::PAGE_METADATA_MUTATION_EVENT, 'AFTER', $this, 'create_backlink_mutation', array());

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


    }


    public function handle_backlink_mutation(Doku_Event $event, $param)
    {


        $data = $event->data;
        $pagePath = $data[PagePath::getPersistentName()];
        $reference = Page::createPageFromQualifiedPath($pagePath);

        if ($reference->isSecondarySlot()) {
            return;
        }

        /**
         * Delete and recompute analytics
         */
        CacheLog::deleteCacheIfExistsAndLog(
            $reference->getAnalyticsDocument(),
            self::BACKLINK_MUTATION_EVENT_NAME,
            "Backlink mutation"
        );
        try {
            $reference->getDatabasePage()->replicateAnalytics();
        } catch (ExceptionCombo $e) {
            LogUtility::msg("Backlink Mutation: Error while trying to replicate the analytics. Error: {$e->getMessage()}");
        }

        /**
         * Render the (footer slot) if it has a backlink dependency
         */
        CacheDependencies::reRenderSecondarySlotsIfNeeded(
            $pagePath,
            CacheDependencies::BACKLINKS_DEPENDENCY,
            self::BACKLINK_MUTATION_EVENT_NAME
        );



    }

    /**
     */
    function create_backlink_mutation(Doku_Event $event, $params)
    {


        $data = $event->data;

        /**
         * If this is not a mutation on references we return.
         */
        if ($data["name"] !== References::getPersistentName()) {
            return;
        };

        $newRows = $data["new_value"];
        $oldRows = $data["old_value"];

        $afterReferences = [];
        if ($newRows !== null) {
            foreach ($newRows as $rowNewValue) {
                $reference = $rowNewValue[Reference::getPersistentName()];
                $afterReferences[$reference] = $reference;
            }
        }

        if ($oldRows !== null) {
            foreach ($oldRows as $oldRow) {
                $beforeReference = $oldRow[Reference::getPersistentName()];
                if (isset($afterReferences[$beforeReference])) {
                    unset($afterReferences[$beforeReference]);
                } else {
                    Event::createEvent(
                        action_plugin_combo_backlinkmutation::BACKLINK_MUTATION_EVENT_NAME,
                        [
                            PagePath::getPersistentName() => $beforeReference
                        ]
                    );
                }
            }
        }
        foreach ($afterReferences as $newReference) {
            Event::createEvent(
                action_plugin_combo_backlinkmutation::BACKLINK_MUTATION_EVENT_NAME,
                [PagePath::getPersistentName() => $newReference]);
        }


    }


}