| Server IP : 172.66.157.178 / Your IP : 172.16.20.3 Web Server : Apache/2.4.25 (Debian) System : Linux f64a392e70de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 User : application ( 1000) PHP Version : 5.6.40 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /app/classes/submission/reviewer/ |
Upload File : |
<?php
/**
* @file classes/submission/reviewer/ReviewerAction.inc.php
*
* Copyright (c) 2013-2019 Simon Fraser University
* Copyright (c) 2003-2019 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class ReviewerAction
* @ingroup submission
*
* @brief ReviewerAction class.
*/
import('classes.submission.common.Action');
class ReviewerAction extends Action {
/**
* Constructor.
*/
function ReviewerAction() {
}
/**
* Actions.
*/
/**
* Records whether or not the reviewer accepts the review assignment.
* @param $user object
* @param $reviewerSubmission object
* @param $decline boolean
* @param $send boolean
* @param $request object
*/
function confirmReview($reviewerSubmission, $decline, $send, $request) {
$reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
$userDao =& DAORegistry::getDAO('UserDAO');
$reviewId = $reviewerSubmission->getReviewId();
$reviewAssignment =& $reviewAssignmentDao->getById($reviewId);
$reviewer =& $userDao->getUser($reviewAssignment->getReviewerId());
if (!isset($reviewer)) return true;
// Only confirm the review for the reviewer if
// he has not previously done so.
if ($reviewAssignment->getDateConfirmed() == null) {
import('classes.mail.ArticleMailTemplate');
$email = new ArticleMailTemplate($reviewerSubmission, $decline?'REVIEW_DECLINE':'REVIEW_CONFIRM');
// Must explicitly set sender because we may be here on an access
// key, in which case the user is not technically logged in
$email->setFrom($reviewer->getEmail(), $reviewer->getFullName());
if (!$email->isEnabled() || ($send && !$email->hasErrors())) {
HookRegistry::call('ReviewerAction::confirmReview', array(&$reviewerSubmission, &$email, $decline));
if ($email->isEnabled()) {
$email->send($request);
}
$reviewAssignment->setDateReminded(null);
$reviewAssignment->setReminderWasAutomatic(null);
$reviewAssignment->setDeclined($decline);
$reviewAssignment->setDateConfirmed(Core::getCurrentDate());
$reviewAssignment->stampModified();
$reviewAssignmentDao->updateReviewAssignment($reviewAssignment);
// Add log
import('classes.article.log.ArticleLog');
ArticleLog::logEventHeadless($request->getJournal(), $reviewer->getId(), $reviewerSubmission, $decline?ARTICLE_LOG_REVIEW_DECLINE:ARTICLE_LOG_REVIEW_ACCEPT, $decline?'log.review.reviewDeclined':'log.review.reviewAccepted', array('reviewerName' => $reviewer->getFullName(), 'articleId' => $reviewAssignment->getSubmissionId(), 'round' => $reviewAssignment->getRound(), 'reviewId' => $reviewAssignment->getId()));
return true;
} else {
if (!$request->getUserVar('continued')) {
$assignedEditors = $email->ccAssignedEditors($reviewerSubmission->getId());
$reviewingSectionEditors = $email->toAssignedReviewingSectionEditors($reviewerSubmission->getId());
if (empty($assignedEditors) && empty($reviewingSectionEditors)) {
$journal =& $request->getJournal();
$email->addRecipient($journal->getSetting('contactEmail'), $journal->getSetting('contactName'));
$editorialContactName = $journal->getSetting('contactName');
} else {
if (!empty($reviewingSectionEditors)) $editorialContact = array_shift($reviewingSectionEditors);
else $editorialContact = array_shift($assignedEditors);
$editorialContactName = $editorialContact->getEditorFullName();
}
$email->promoteCcsIfNoRecipients();
// Format the review due date
$reviewDueDate = strtotime($reviewAssignment->getDateDue());
$dateFormatShort = Config::getVar('general', 'date_format_short');
if ($reviewDueDate == -1) $reviewDueDate = $dateFormatShort; // Default to something human-readable if no date specified
else $reviewDueDate = strftime($dateFormatShort, $reviewDueDate);
$email->assignParams(array(
'editorialContactName' => $editorialContactName,
'reviewerName' => $reviewer->getFullName(),
'reviewDueDate' => $reviewDueDate
));
}
$paramArray = array('reviewId' => $reviewId);
if ($decline) $paramArray['declineReview'] = 1;
$email->displayEditForm($request->url(null, 'reviewer', 'confirmReview'), $paramArray);
return false;
}
}
return true;
}
/**
* Records the reviewer's submission recommendation.
* @param $reviewId int
* @param $recommendation int
* @param $send boolean
* @param $request object
*/
function recordRecommendation(&$reviewerSubmission, $recommendation, $send, $request) {
$reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
$userDao =& DAORegistry::getDAO('UserDAO');
// Check validity of selected recommendation
$reviewerRecommendationOptions =& ReviewAssignment::getReviewerRecommendationOptions();
if (!isset($reviewerRecommendationOptions[$recommendation])) return true;
$reviewAssignment =& $reviewAssignmentDao->getById($reviewerSubmission->getReviewId());
$reviewer =& $userDao->getUser($reviewAssignment->getReviewerId());
if (!isset($reviewer)) return true;
// Only record the reviewers recommendation if
// no recommendation has previously been submitted.
if ($reviewAssignment->getRecommendation() === null || $reviewAssignment->getRecommendation() === '') {
import('classes.mail.ArticleMailTemplate');
$email = new ArticleMailTemplate($reviewerSubmission, 'REVIEW_COMPLETE');
// Must explicitly set sender because we may be here on an access
// key, in which case the user is not technically logged in
$email->setFrom($reviewer->getEmail(), $reviewer->getFullName());
if (!$email->isEnabled() || ($send && !$email->hasErrors())) {
HookRegistry::call('ReviewerAction::recordRecommendation', array(&$reviewerSubmission, &$email, $recommendation));
if ($email->isEnabled()) {
$email->send($request);
}
$reviewAssignment->setRecommendation($recommendation);
$reviewAssignment->setDateCompleted(Core::getCurrentDate());
$reviewAssignment->stampModified();
$reviewAssignmentDao->updateReviewAssignment($reviewAssignment);
// Add log
import('classes.article.log.ArticleLog');
ArticleLog::logEventHeadless($request->getJournal(), $reviewer->getId(), $reviewerSubmission, ARTICLE_LOG_REVIEW_RECOMMENDATION, 'log.review.reviewRecommendationSet', array('reviewerName' => $reviewer->getFullName(), 'articleId' => $reviewAssignment->getSubmissionId(), 'round' => $reviewAssignment->getRound(), 'reviewId' => $reviewAssignment->getId()));
} else {
if (!$request->getUserVar('continued')) {
$assignedEditors = $email->ccAssignedEditors($reviewerSubmission->getId());
$reviewingSectionEditors = $email->toAssignedReviewingSectionEditors($reviewerSubmission->getId());
if (empty($assignedEditors) && empty($reviewingSectionEditors)) {
$journal =& Request::getJournal();
$email->addRecipient($journal->getSetting('contactEmail'), $journal->getSetting('contactName'));
$editorialContactName = $journal->getSetting('contactName');
} else {
if (!empty($reviewingSectionEditors)) $editorialContact = array_shift($reviewingSectionEditors);
else $editorialContact = array_shift($assignedEditors);
$editorialContactName = $editorialContact->getEditorFullName();
}
$reviewerRecommendationOptions =& ReviewAssignment::getReviewerRecommendationOptions();
$email->assignParams(array(
'editorialContactName' => $editorialContactName,
'reviewerName' => $reviewer->getFullName(),
'articleTitle' => strip_tags($reviewerSubmission->getLocalizedTitle()),
'recommendation' => __($reviewerRecommendationOptions[$recommendation])
));
}
$email->displayEditForm($request->url(null, 'reviewer', 'recordRecommendation'),
array('reviewId' => $reviewerSubmission->getReviewId(), 'recommendation' => $recommendation)
);
return false;
}
}
return true;
}
/**
* Upload the annotated version of an article.
* @param $reviewId int
* @param $reviewerSubmission object
* @param $request object
*/
function uploadReviewerVersion($reviewId, $reviewerSubmission, $request) {
import('classes.file.ArticleFileManager');
$reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
$reviewAssignment =& $reviewAssignmentDao->getById($reviewId);
$articleFileManager = new ArticleFileManager($reviewAssignment->getSubmissionId());
// Only upload the file if the reviewer has yet to submit a recommendation
// and if review forms are not used
if (($reviewAssignment->getRecommendation() === null || $reviewAssignment->getRecommendation() === '') && !$reviewAssignment->getCancelled()) {
$fileName = 'upload';
if ($articleFileManager->uploadedFileExists($fileName)) {
HookRegistry::call('ReviewerAction::uploadReviewFile', array(&$reviewAssignment));
if ($reviewAssignment->getReviewerFileId() != null) {
$fileId = $articleFileManager->uploadReviewFile($fileName, $reviewAssignment->getReviewerFileId());
} else {
$fileId = $articleFileManager->uploadReviewFile($fileName);
}
}
}
if (isset($fileId) && $fileId != 0) {
$reviewAssignment->setReviewerFileId($fileId);
$reviewAssignment->stampModified();
$reviewAssignmentDao->updateReviewAssignment($reviewAssignment);
$userDao =& DAORegistry::getDAO('UserDAO');
$reviewer =& $userDao->getUser($reviewAssignment->getReviewerId());
// Add log
import('classes.article.log.ArticleLog');
ArticleLog::logEventHeadless($request->getJournal(), $reviewer->getId(), $reviewerSubmission, ARTICLE_LOG_REVIEW_FILE, 'log.review.reviewerFile', array('reviewId' => $reviewAssignment->getId()));
}
}
/**
* Delete an annotated version of an article.
* @param $reviewId int
* @param $fileId int
* @param $revision int If null, then all revisions are deleted.
*/
function deleteReviewerVersion($reviewId, $fileId, $revision = null) {
import('classes.file.ArticleFileManager');
$articleId = Request::getUserVar('articleId');
$reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
$reviewAssignment =& $reviewAssignmentDao->getById($reviewId);
if (!HookRegistry::call('ReviewerAction::deleteReviewerVersion', array(&$reviewAssignment, &$fileId, &$revision))) {
$articleFileManager = new ArticleFileManager($reviewAssignment->getSubmissionId());
$articleFileManager->deleteFile($fileId, $revision);
}
}
/**
* View reviewer comments.
* @param $user object Current user
* @param $article object
* @param $reviewId int
*/
function viewPeerReviewComments(&$user, &$article, $reviewId) {
if (!HookRegistry::call('ReviewerAction::viewPeerReviewComments', array(&$user, &$article, &$reviewId))) {
import('classes.submission.form.comment.PeerReviewCommentForm');
$commentForm = new PeerReviewCommentForm($article, $reviewId, ROLE_ID_REVIEWER);
$commentForm->setUser($user);
$commentForm->initData();
$commentForm->setData('reviewId', $reviewId);
$commentForm->display();
}
}
/**
* Post reviewer comments.
* @param $user object Current user
* @param $article object
* @param $reviewId int
* @param $emailComment boolean
* @param $request Request
*/
function postPeerReviewComment(&$user, &$article, $reviewId, $emailComment, $request) {
if (!HookRegistry::call('ReviewerAction::postPeerReviewComment', array(&$user, &$article, &$reviewId, &$emailComment))) {
import('classes.submission.form.comment.PeerReviewCommentForm');
$commentForm = new PeerReviewCommentForm($article, $reviewId, ROLE_ID_REVIEWER);
$commentForm->setUser($user);
$commentForm->readInputData();
if ($commentForm->validate()) {
$commentForm->execute();
// Send a notification to associated users
import('classes.notification.NotificationManager');
$notificationManager = new NotificationManager();
$notificationUsers = $article->getAssociatedUserIds(false, false);
foreach ($notificationUsers as $userRole) {
$notificationManager->createNotification(
$request, $userRole['id'], NOTIFICATION_TYPE_REVIEWER_COMMENT,
$article->getJournalId(), ASSOC_TYPE_ARTICLE, $article->getId()
);
}
if ($emailComment) {
$commentForm->email($request);
}
} else {
$commentForm->display();
return false;
}
return true;
}
}
/**
* Edit review form response.
* @param $reviewId int
* @param $reviewFormId int
*/
function editReviewFormResponse($reviewId, $reviewFormId) {
if (!HookRegistry::call('ReviewerAction::editReviewFormResponse', array($reviewId, $reviewFormId))) {
import('classes.submission.form.ReviewFormResponseForm');
$reviewForm = new ReviewFormResponseForm($reviewId, $reviewFormId);
$reviewForm->initData();
$reviewForm->display();
}
}
/**
* Save review form response.
* @param $reviewId int
* @param $reviewFormId int
* @param $request Request
*/
function saveReviewFormResponse($reviewId, $reviewFormId, $request) {
if (!HookRegistry::call('ReviewerAction::saveReviewFormResponse', array($reviewId, $reviewFormId))) {
import('classes.submission.form.ReviewFormResponseForm');
$reviewForm = new ReviewFormResponseForm($reviewId, $reviewFormId);
$reviewForm->readInputData();
if ($reviewForm->validate()) {
$reviewForm->execute();
// Send a notification to associated users
import('classes.notification.NotificationManager');
$notificationManager = new NotificationManager();
$reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
$reviewAssignment = $reviewAssignmentDao->getById($reviewId);
$articleId = $reviewAssignment->getSubmissionId();
$articleDao =& DAORegistry::getDAO('ArticleDAO');
$article =& $articleDao->getArticle($articleId);
$notificationUsers = $article->getAssociatedUserIds(false, false);
foreach ($notificationUsers as $userRole) {
$notificationManager->createNotification(
$request, $userRole['id'], NOTIFICATION_TYPE_REVIEWER_FORM_COMMENT,
$article->getJournalId(), ASSOC_TYPE_ARTICLE, $article->getId()
);
}
} else {
$reviewForm->display();
return false;
}
return true;
}
}
//
// Misc
//
/**
* Download a file a reviewer has access to.
* @param $reviewId int
* @param $article object
* @param $fileId int
* @param $revision int
*/
function downloadReviewerFile($reviewId, $article, $fileId, $revision = null) {
$reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
$reviewAssignment =& $reviewAssignmentDao->getById($reviewId);
$journal =& Request::getJournal();
$canDownload = false;
// Reviewers have access to:
// 1) The current revision of the file to be reviewed.
// 2) Any file that he uploads.
// 3) Any supplementary file that is visible to reviewers.
if ((!$reviewAssignment->getDateConfirmed() || $reviewAssignment->getDeclined()) && $journal->getSetting('restrictReviewerFileAccess')) {
// Restrict files until review is accepted
} else if ($reviewAssignment->getReviewFileId() == $fileId) {
if ($revision != null) {
$canDownload = ($reviewAssignment->getReviewRevision() == $revision);
}
} else if ($reviewAssignment->getReviewerFileId() == $fileId) {
$canDownload = true;
} else {
foreach ($reviewAssignment->getSuppFiles() as $suppFile) {
if ($suppFile->getFileId() == $fileId && $suppFile->getShowReviewers()) {
$canDownload = true;
}
}
}
$result = false;
if (!HookRegistry::call('ReviewerAction::downloadReviewerFile', array(&$article, &$fileId, &$revision, &$canDownload, &$result))) {
if ($canDownload) {
return Action::downloadFile($article->getId(), $fileId, $revision);
} else {
return false;
}
}
return $result;
}
/**
* Edit comment.
* @param $commentId int
*/
function editComment ($article, $comment, $reviewId) {
if (!HookRegistry::call('ReviewerAction::editComment', array(&$article, &$comment, &$reviewId))) {
import ('classes.submission.form.comment.EditCommentForm');
$commentForm = new EditCommentForm ($article, $comment);
$commentForm->initData();
$commentForm->setData('reviewId', $reviewId);
$commentForm->display(array('reviewId' => $reviewId));
}
}
}
?>