ThothPlugin.inc.php

<?php

/**
 * @file plugins/generic/thoth/ThothPlugin.php
 *
 * Copyright (c) 2014-2020 Simon Fraser University
 * Copyright (c) 2003-2020 John Willinsky
 * Copyright (c) 2024 Lepidus Tecnologia
 * Copyright (c) 2024 Thoth
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class ThothPlugin
 *
 * @ingroup plugins_generic_thoth
 *
 * @brief Plugin for integration with Thoth for communication and synchronization of book data between the two platforms
 */

use APP\core\Application;
use PKP\core\JSONMessage;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;

import('plugins.generic.thoth.classes.api.ThothEndpoint');
import('plugins.generic.thoth.classes.components.forms.config.PublishFormConfig');
import('plugins.generic.thoth.classes.filters.ThothSectionFilter');
import('plugins.generic.thoth.classes.listeners.PublicationEditListener');
import('plugins.generic.thoth.classes.listeners.PublicationPublishListener');
import('plugins.generic.thoth.classes.notification.ThothNotification');
import('plugins.generic.thoth.classes.schema.ThothSchema');

class ThothPlugin extends \PKP\plugins\GenericPlugin
{
    public function register($category, $path, $mainContextId = null)
    {
        $success = parent::register($category, $path);

        if ($success && $this->getEnabled()) {
            $this->addToSchema();
            $this->addFormConfig();
            $this->addListeners();
            $this->addEndpoints();
            HookRegistry::register('TemplateManager::display', [$this, 'addTemplateFilters']);
            HookRegistry::register('TemplateManager::display', [$this, 'addScripts']);
            HookRegistry::register('TemplateManager::display', [$this, 'addMenu']);
            HookRegistry::register('LoadHandler', [$this, 'addHandlers']);
        }

        return $success;
    }

    public function getDisplayName()
    {
        return __('plugins.generic.thoth.name');
    }

    public function getDescription()
    {
        return __('plugins.generic.thoth.description');
    }

    public function getActions($request, $verb)
    {
        $parentActions = parent::getActions($request, $verb);

        if (!$this->getEnabled()) {
            return $parentActions;
        }

        $router = $request->getRouter();

        import('lib.pkp.classes.linkAction.request.AjaxModal');
        $linkAction = new LinkAction(
            'settings',
            new AjaxModal(
                $router->url(
                    $request,
                    null,
                    null,
                    'manage',
                    null,
                    [
                        'verb' => 'settings',
                        'plugin' => $this->getName(),
                        'category' => 'generic'
                    ]
                ),
                $this->getDisplayName()
            ),
            __('manager.plugins.settings'),
            null
        );

        array_unshift($parentActions, $linkAction);

        return $parentActions;
    }

    public function manage($args, $request)
    {
        switch ($request->getUserVar('verb')) {
            case 'settings':
                $context = $request->getContext();

                $this->import('ThothSettingsForm');
                $form = new ThothSettingsForm($this, $context->getId());

                if ($request->getUserVar('save')) {
                    $form->readInputData();
                    if ($form->validate()) {
                        $form->execute();
                        return new JSONMessage(true);
                    }
                } else {
                    $form->initData();
                }
                return new JSONMessage(true, $form->fetch($request));
        }
        return parent::manage($args, $request);
    }

    public function addToSchema()
    {
        $thothSchema = new ThothSchema();
        HookRegistry::register('Schema::get::submission', [$thothSchema, 'addWorkIdToSchema']);
        HookRegistry::register('Schema::get::eventLog', [$thothSchema, 'addReasonToSchema']);
        HookRegistry::register('Submission::getSubmissionsListProps', [$thothSchema, 'addToSubmissionsListProps']);
    }

    public function addTemplateFilters($hookName, $args)
    {
        $templateMgr = $args[0];
        $template = $args[1];

        $thothSectionFilter = new ThothSectionFilter();
        $thothSectionFilter->registerFilter($templateMgr, $template, $this);
    }

    public function addScripts($hookName, $args)
    {
        $templateMgr = $args[0];
        $template = $args[1];
        $request = Application::get()->getRequest();

        $thothSectionFilter = new ThothSectionFilter();
        $thothSectionFilter->addJavaScriptData($request, $templateMgr, $template);
        $thothSectionFilter->addJavaScript($request, $templateMgr, $this);
        $thothSectionFilter->addStyleSheet($request, $templateMgr, $this);

        $thothNotification = new ThothNotification();
        $thothNotification->addJavaScriptData($request, $templateMgr);
        $thothNotification->addJavaScript($request, $templateMgr, $this);
    }

    public function addFormConfig()
    {
        $publishFormConfig = new PublishFormConfig();
        HookRegistry::register('Form::config::before', [$publishFormConfig, 'addConfig']);
    }

    public function addListeners()
    {
        $publicationPublishListener = new PublicationPublishListener();
        HookRegistry::register('Publication::validatePublish', [$publicationPublishListener, 'validate']);
        HookRegistry::register('Publication::publish', [$publicationPublishListener, 'registerThothBook']);

        $publicationEditListener = new PublicationEditListener();
        HookRegistry::register('Publication::edit', [$publicationEditListener, 'updateThothBook']);
    }

    public function addEndpoints()
    {
        $thothEndpoint = new ThothEndpoint();
        HookRegistry::register('APIHandler::endpoints', [$thothEndpoint, 'addEndpoints']);
    }

    public function addMenu($hookName, $args)
    {
        $templateMgr = $args[0];

        $request = Application::get()->getRequest();
        $router = $request->getRouter();
        $userRoles = (array) $router->getHandler()->getAuthorizedContextObject(Application::ASSOC_TYPE_USER_ROLES);

        $menu = $templateMgr->getState('menu');

        if (empty($menu)) {
            return false;
        }

        if (in_array(ROLE_ID_MANAGER, $userRoles)) {
            $menu = array_slice($menu, 0, 3, true) +
            [
                'thoth' => [
                    'name' => __('plugins.generic.thoth.navigation.thoth'),
                    'url' => $router->url($request, null, 'thoth'),
                    'isCurrent' => $router->getRequestedPage($request) === 'thoth',
                ]
            ] +
            array_slice($menu, 2, null, true);
        }

        $templateMgr->setState(['menu' => $menu]);
    }

    public function addHandlers($hookName, $args)
    {
        $page = $args[0];
        $op = $args[1];

        if (!$this->getEnabled() || $page !== 'thoth') {
            return false;
        }

        if ($op === 'register') {
            $this->import('controllers/modal/RegisterHandler');
            define('HANDLER_CLASS', 'RegisterHandler');
            return true;
        }

        if ($op === 'index') {
            $this->import('pages/thoth/ThothHandler');
            define('HANDLER_CLASS', 'ThothHandler');
            return true;
        }

        return false;
    }
}