AuthorRequirementsPlugin.php

<?php

/**
 * @file plugins/generic/authorRequirements/AuthorRequirementsPlugin.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2003-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class AuthorRequirementsPlugin
 * @ingroup plugins_generic_authorRequirements
 *
 * @brief Author Requirements plugin class
 */

namespace APP\plugins\generic\authorRequirements;

use APP\notification\NotificationManager;
use PKP\components\forms\Field;
use PKP\components\forms\publication\ContributorForm;
use PKP\core\JSONMessage;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\plugins\GenericPlugin;
use PKP\plugins\Hook;

class AuthorRequirementsPlugin extends GenericPlugin
{
    /**
     * Get the display name of this plugin
     * @return string
     */
    public function getDisplayName()
    {
        return __('plugins.generic.authorRequirements.displayName');
    }

    /**
     * Get the description of this plugin
     * @return string
     */
    public function getDescription()
    {
        return __('plugins.generic.authorRequirements.description');
    }

    /**
     * @copydoc Plugin::register()
     */
    public function register($category, $path, $mainContextId = null)
    {

        // Register the plugin even when it is not enabled
        $success = parent::register($category, $path);

        if ($success && $this->getEnabled()) {

            $contextId = $this->getCurrentContextId();

            // Deals with making email optional
            if ($this->getSetting($contextId, 'emailOptional')) {
                Hook::add('Form::config::before', [$this, 'modifyContributorForm']);
                Hook::add('Schema::get::author', [$this, 'modifyAuthorSchema']);
            }
        }
        return $success;
    }

    /**
     * Make contributor email optional in ContributorForm
     */
    public function modifyContributorForm($hookName, $form): bool
    {
        if (!$form instanceof ContributorForm) {
            return Hook::CONTINUE;
        }

        $form->fields = array_map(function(Field $field) {
            if ($field->name === 'email') {
                $field->isRequired = false;
            }

            return $field;
        }, $form->fields);

        return Hook::CONTINUE;
    }

    /**
     * Make email nullable in author schema
     */
    public function modifyAuthorSchema($hookName, $args): bool
    {
        $schema = &$args[0];
        $schema->required = array_filter($schema->required, fn ($item) => $item !== 'email');
        $schema->properties->email->validation[] = 'nullable';

        return Hook::CONTINUE;
    }

    /**
     * @copydoc Plugin::getActions()
     */
    public function getActions($request, $verb)
    {
        $actions = parent::getActions($request, $verb);
        if (!$this->getEnabled()) {
            return $actions;
        }

        $router = $request->getRouter();
        $url = $router->url($request, null, null, 'manage', null, ['verb' => 'settings', 'plugin' => $this->getName(), 'category' => 'generic']);
        array_unshift($actions, new LinkAction('settings', new AjaxModal($url, $this->getDisplayName()), __('manager.plugins.settings')));
        return $actions;
    }

    /**
     * @copydoc Plugin::manage()
     */
    public function manage($args, $request): JSONMessage
    {
        if ($request->getUserVar('verb') !== 'settings') {
            return parent::manage($args, $request);
        }

        $form = new AuthorRequirementsSettingsForm($this, $request->getContext()->getId());
        if (!$request->getUserVar('save')) {
            $form->initData();
            return new JSONMessage(true, $form->fetch($request));
        }

        $form->readInputData();
        if (!$form->validate()) {
            return new JSONMessage(true, $form->fetch($request));
        }

        try {
            $form->execute();
            $notificationManager = new NotificationManager();
            $notificationManager->createTrivialNotification($request->getUser()->getId());
        } catch (\Exception $exception) {
            $notificationManager = new NotificationManager();
            $notificationManager->createTrivialNotification(
                $request->getUser()->getId(),
                \PKPNotification::NOTIFICATION_TYPE_ERROR,
                ['contents' => __('common.error.databaseError', ['error' => $exception->getMessage()])],
            );
        }
        return new JSONMessage(true);
    }
}