<?php

/**
 * @file controllers/tab/authorDashboard/AuthorDashboardReviewRoundTabHandler.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 AuthorDashboardReviewRoundTabHandler
 *
 * @ingroup controllers_tab_authorDashboard
 *
 * @brief Handle AJAX operations for review round tabs on author dashboard page.
 */

namespace PKP\controllers\tab\authorDashboard;

use APP\core\Application;
use APP\core\Request;
use APP\notification\Notification;
use APP\pages\authorDashboard\AuthorDashboardHandler;
use APP\template\TemplateManager;
use PKP\core\JSONMessage;
use PKP\db\DAORegistry;
use PKP\log\SubmissionEmailLogDAO;
use PKP\log\SubmissionEmailLogEntry;
use PKP\notification\PKPNotification;
use PKP\security\authorization\internal\ReviewRoundRequiredPolicy;
use PKP\security\authorization\internal\WorkflowStageRequiredPolicy;
use PKP\security\Role;
use PKP\submission\reviewAssignment\ReviewAssignmentDAO;

class AuthorDashboardReviewRoundTabHandler extends AuthorDashboardHandler
{
    /** @var bool Overwrite backend page handling of AuthorDashboardHandler */
    public $_isBackendPage = false;

    /**
     * Constructor
     */
    public function __construct()
    {
        parent::__construct();
        $this->addRoleAssignment([Role::ROLE_ID_AUTHOR], ['fetchReviewRoundInfo']);
    }


    //
    // Extended methods from Handler
    //
    /**
     * @copydoc PKPHandler::authorize()
     */
    public function authorize($request, &$args, $roleAssignments)
    {
        $stageId = (int)$request->getUserVar('stageId');

        // Authorize stage id.
        $this->addPolicy(new WorkflowStageRequiredPolicy($stageId));

        // We need a review round id in request.
        $this->addPolicy(new ReviewRoundRequiredPolicy($request, $args));

        return parent::authorize($request, $args, $roleAssignments);
    }


    //
    // Public handler operations
    //
    /**
     * Fetch information for the author on the specified review round
     *
     * @param array $args
     * @param Request $request
     *
     * @return JSONMessage JSON object
     */
    public function fetchReviewRoundInfo($args, $request)
    {
        $this->setupTemplate($request);
        $templateMgr = TemplateManager::getManager($request);

        $reviewRound = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_REVIEW_ROUND);
        $submission = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
        $stageId = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_WORKFLOW_STAGE);
        if ($stageId !== WORKFLOW_STAGE_ID_INTERNAL_REVIEW && $stageId !== WORKFLOW_STAGE_ID_EXTERNAL_REVIEW) {
            fatalError('Invalid Stage Id');
        }

        $templateMgr->assign([
            'stageId' => $stageId,
            'reviewRoundId' => $reviewRound->getId(),
            'submission' => $submission,
            'reviewRoundNotificationRequestOptions' => [
                Notification::NOTIFICATION_LEVEL_NORMAL => [
                    PKPNotification::NOTIFICATION_TYPE_REVIEW_ROUND_STATUS => [Application::ASSOC_TYPE_REVIEW_ROUND, $reviewRound->getId()]],
                Notification::NOTIFICATION_LEVEL_TRIVIAL => []
            ],
        ]);

        // If open reviews exist, show the reviewers grid
        $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /** @var ReviewAssignmentDAO $reviewAssignmentDao */
        if ($reviewAssignmentDao->getOpenReviewsByReviewRoundId($reviewRound->getId())) {
            $templateMgr->assign('showReviewerGrid', true);
        }

        // Display notification emails to the author related to editorial decisions
        $submissionEmailLogDao = DAORegistry::getDAO('SubmissionEmailLogDAO'); /** @var SubmissionEmailLogDAO $submissionEmailLogDao */
        $templateMgr->assign([
            'submissionEmails' => $submissionEmailLogDao->getByEventType(
                $submission->getId(),
                SubmissionEmailLogEntry::SUBMISSION_EMAIL_EDITOR_NOTIFY_AUTHOR,
                $request->getUser()->getId()
            ),
            'showReviewAttachments' => true,
        ]);

        return $templateMgr->fetchJson('authorDashboard/reviewRoundInfo.tpl');
    }
}