Files
CHIEFSOFT\ameye df3a033196 first commit
2024-06-08 17:09:23 -04:00

677 lines
23 KiB
PHP

<?php
/**
* @file classes/submission/reviewAssignment/ReviewAssignmentDAO.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 ReviewAssignmentDAO
*
* @ingroup submission
*
* @see ReviewAssignment
*
* @brief Class for DAO relating reviewers to submissions.
*/
namespace PKP\submission\reviewAssignment;
use APP\core\Application;
use APP\facades\Repo;
use Exception;
use Illuminate\Support\Facades\DB;
use PKP\db\DAORegistry;
use PKP\notification\NotificationDAO;
use PKP\reviewForm\ReviewFormResponseDAO;
use PKP\submission\ReviewFilesDAO;
use PKP\submission\reviewRound\ReviewRoundDAO;
class ReviewAssignmentDAO extends \PKP\db\DAO
{
/**
* Retrieve review assignments for the passed review round id.
*
* @param int $reviewRoundId
*
* @return array
*/
public function getByReviewRoundId($reviewRoundId)
{
$params = [(int)$reviewRoundId];
$query = $this->_getSelectQuery() .
' WHERE r.review_round_id = ? ORDER BY review_id';
return $this->_getReviewAssignmentsArray($query, $params);
}
/**
* Retrieve open review assignments for the passed review round id.
*
* @param int $reviewRoundId
*
* @return array
*/
public function getOpenReviewsByReviewRoundId($reviewRoundId)
{
$params = [(int)$reviewRoundId, ReviewAssignment::SUBMISSION_REVIEW_METHOD_OPEN];
$query = $this->_getSelectQuery() .
' WHERE r.review_round_id = ? AND r.review_method = ? AND r.date_confirmed IS NOT NULL AND r.declined <> 1 ORDER BY review_id';
return $this->_getReviewAssignmentsArray($query, $params);
}
/**
* Retrieve review assignments from table using the passed
* sql query and parameters.
*
* @param string $query
* @param array $queryParams
*
* @return array
*/
public function _getReviewAssignmentsArray($query, $queryParams)
{
$result = $this->retrieve($query, $queryParams);
$reviewAssignments = [];
foreach ($result as $row) {
$reviewAssignments[$row->review_id] = $this->_fromRow((array) $row);
}
return $reviewAssignments;
}
/**
* Get the review_rounds join string. Must be implemented
* by subclasses.
*
* @return string
*/
public function getReviewRoundJoin()
{
return 'r.review_round_id = r2.review_round_id';
}
//
// Public methods.
//
/**
* Retrieve a review assignment by review round and reviewer.
*
* @param int $reviewRoundId
* @param int $reviewerId
*
* @return ReviewAssignment
*/
public function getReviewAssignment($reviewRoundId, $reviewerId)
{
$result = $this->retrieve(
$this->_getSelectQuery() .
' WHERE r.review_round_id = ? AND
r.reviewer_id = ?',
[
(int) $reviewRoundId,
(int) $reviewerId
]
);
$row = $result->current();
return $row ? $this->_fromRow((array) $row) : null;
}
/**
* Retrieve a review assignment by review assignment id.
*
* @param int $reviewId
*
* @return ReviewAssignment
*/
public function getById($reviewId)
{
$result = $this->retrieve(
'SELECT r.*, r2.review_revision
FROM review_assignments r
LEFT JOIN review_rounds r2 ON (' . $this->getReviewRoundJoin() . ')
WHERE r.review_id = ?',
[(int) $reviewId]
);
$row = $result->current();
return $row ? $this->_fromRow((array) $row) : null;
}
/**
* Get all incomplete review assignments for all journals/conferences/presses
*
* @return array ReviewAssignments
*/
public function getIncompleteReviewAssignments()
{
$result = $this->retrieve(
'SELECT r.*, r2.review_revision
FROM review_assignments r
LEFT JOIN review_rounds r2 ON (' . $this->getReviewRoundJoin() . ')
WHERE' . $this->getIncompleteReviewAssignmentsWhereString() .
' ORDER BY r.submission_id'
);
$reviewAssignments = [];
foreach ($result as $row) {
$reviewAssignments[] = $this->_fromRow((array) $row);
}
return $reviewAssignments;
}
/**
* Get the WHERE sql string to filter incomplete review
* assignments.
*
* @return string
*/
public function getIncompleteReviewAssignmentsWhereString()
{
return ' r.date_notified IS NOT NULL AND
r.date_completed IS NULL AND
r.declined <> 1 AND
r.cancelled <> 1';
}
/**
* Get all review assignments for a submission.
*
* @param int $submissionId Submission ID
* @param int $reviewRoundId Review round ID
* @param int $stageId Optional stage ID
*
* @return array ReviewAssignments
*/
public function getBySubmissionId($submissionId, $reviewRoundId = null, $stageId = null)
{
$query = $this->_getSelectQuery() .
' WHERE r.submission_id = ?';
$orderBy = ' ORDER BY review_id';
$queryParams[] = (int) $submissionId;
if ($reviewRoundId != null) {
$query .= ' AND r2.review_round_id = ?';
$queryParams[] = (int) $reviewRoundId;
} else {
$orderBy .= ', r2.review_round_id';
}
if ($stageId != null) {
$query .= ' AND r2.stage_id = ?';
$queryParams[] = (int) $stageId;
} else {
$orderBy .= ', r2.stage_id';
}
$query .= $orderBy;
return $this->_getReviewAssignmentsArray($query, $queryParams);
}
/**
* Retrieve all review assignments by submission and reviewer.
*
* @param int $submissionId
* @param int $reviewerId
* @param int $stageId optional
*
* @return array
*/
public function getBySubmissionReviewer($submissionId, $reviewerId, $stageId = null)
{
$query = $this->_getSelectQuery() .
' WHERE r.submission_id = ? AND r.reviewer_id = ?';
$queryParams = [(int) $submissionId, (int) $reviewerId];
if ($stageId != null) {
$query .= ' AND r.stage_id = ?';
$queryParams[] = (int) $stageId;
}
return $this->_getReviewAssignmentsArray($query, $queryParams);
}
/**
* Get all review assignments for a reviewer.
*
* @param int $userId
*
* @return array ReviewAssignments
*/
public function getByUserId($userId)
{
$reviewRoundJoinString = $this->getReviewRoundJoin();
if (!$reviewRoundJoinString) {
throw new Exception('Review round join string not specified');
}
$result = $this->retrieve(
'SELECT r.*, r2.review_revision
FROM review_assignments r
LEFT JOIN review_rounds r2 ON (' . $reviewRoundJoinString . ')
WHERE r.reviewer_id = ?
ORDER BY round, review_id',
[(int) $userId]
);
$reviewAssignments = [];
foreach ($result as $row) {
$reviewAssignments[] = $this->_fromRow((array) $row);
}
return $reviewAssignments;
}
/**
* Check if a reviewer is assigned to a specified submission.
*
* @param int $reviewRoundId
* @param int $reviewerId
*
* @return bool
*/
public function reviewerExists($reviewRoundId, $reviewerId)
{
$result = $this->retrieve(
'SELECT COUNT(*) AS row_count
FROM review_assignments
WHERE review_round_id = ? AND
reviewer_id = ?',
[(int) $reviewRoundId, (int) $reviewerId]
);
$row = (array) $result->current();
return $row && $row['row_count'] == 1;
}
/**
* Get all review assignments for a review form.
*
* @param int $reviewFormId
*
* @return array ReviewAssignments
*/
public function getByReviewFormId($reviewFormId)
{
$reviewRoundJoinString = $this->getReviewRoundJoin();
if (!$reviewRoundJoinString) {
throw new Exception('Review round join string not specified');
}
$result = $this->retrieve(
'SELECT r.*, r2.review_revision
FROM review_assignments r
LEFT JOIN review_rounds r2 ON (' . $reviewRoundJoinString . ')
WHERE r.review_form_id = ?
ORDER BY round, review_id',
[(int) $reviewFormId]
);
$reviewAssignments = [];
foreach ($result as $row) {
$reviewAssignments[] = $this->_fromRow((array) $row);
}
return $reviewAssignments;
}
/**
* Determine the order of active reviews for the given round of the given submission
*
* @param int $submissionId Submission ID
* @param int $reviewRoundId Review round ID
*
* @return array Associating review ID with number, i.e. if review ID 26 is first returned['26']=0.
*/
public function getReviewIndexesForRound($submissionId, $reviewRoundId)
{
$result = $this->retrieve(
'SELECT review_id
FROM review_assignments
WHERE submission_id = ? AND
review_round_id = ?
ORDER BY review_id',
[(int) $submissionId, (int) $reviewRoundId]
);
$index = 0;
$returner = [];
foreach ($result as $row) {
$returner[$row->review_id] = $index++;
}
return $returner;
}
/**
* Insert a new Review Assignment.
*
* @param ReviewAssignment $reviewAssignment
*/
public function insertObject($reviewAssignment)
{
$result = $this->update(
sprintf(
'INSERT INTO review_assignments (
submission_id,
reviewer_id,
stage_id,
review_method,
round,
step,
competing_interests,
recommendation,
declined,
cancelled,
date_assigned, date_notified, date_confirmed,
date_completed, date_acknowledged, date_due, date_response_due,
quality, date_rated,
last_modified,
date_reminded, reminder_was_automatic,
review_form_id,
review_round_id,
considered,
request_resent
) VALUES (
?, ?, ?, ?, ?, ?, ?, ?, ?, ?, %s, %s, %s, %s, %s, %s, %s, ?, %s, %s, %s, ?, ?, ?, ?, ?
)',
$this->datetimeToDB($reviewAssignment->getDateAssigned()),
$this->datetimeToDB($reviewAssignment->getDateNotified()),
$this->datetimeToDB($reviewAssignment->getDateConfirmed()),
$this->datetimeToDB($reviewAssignment->getDateCompleted()),
$this->datetimeToDB($reviewAssignment->getDateAcknowledged()),
$this->datetimeToDB($reviewAssignment->getDateDue()),
$this->datetimeToDB($reviewAssignment->getDateResponseDue()),
$this->datetimeToDB($reviewAssignment->getDateRated()),
$this->datetimeToDB($reviewAssignment->getLastModified()),
$this->datetimeToDB($reviewAssignment->getDateReminded())
),
[
(int) $reviewAssignment->getSubmissionId(),
(int) $reviewAssignment->getReviewerId(),
(int) $reviewAssignment->getStageId(),
(int) $reviewAssignment->getReviewMethod(),
max((int) $reviewAssignment->getRound(), 1),
max((int) $reviewAssignment->getStep(), 1),
$reviewAssignment->getCompetingInterests(),
$reviewAssignment->getRecommendation(),
(int) $reviewAssignment->getDeclined(),
(int) $reviewAssignment->getCancelled(),
$reviewAssignment->getQuality(),
(int) $reviewAssignment->getReminderWasAutomatic(),
$reviewAssignment->getReviewFormId(),
(int) $reviewAssignment->getReviewRoundId(),
(int) $reviewAssignment->getConsidered(),
(int) $reviewAssignment->getRequestResent(),
]
);
$reviewAssignment->setId($this->getInsertId());
// Update review stage status whenever a review assignment is changed
$this->updateReviewRoundStatus($reviewAssignment);
}
/**
* Update an existing review assignment.
*
* @param ReviewAssignment $reviewAssignment
*/
public function updateObject($reviewAssignment)
{
$result = $this->update(
sprintf(
'UPDATE review_assignments
SET submission_id = ?,
reviewer_id = ?,
stage_id = ?,
review_method = ?,
round = ?,
step = ?,
competing_interests = ?,
recommendation = ?,
declined = ?,
cancelled = ?,
date_assigned = %s,
date_notified = %s,
date_confirmed = %s,
date_completed = %s,
date_acknowledged = %s,
date_due = %s,
date_response_due = %s,
quality = ?,
date_rated = %s,
last_modified = %s,
date_reminded = %s,
reminder_was_automatic = ?,
review_form_id = ?,
review_round_id = ?,
considered = ?,
request_resent = ?
WHERE review_id = ?',
$this->datetimeToDB($reviewAssignment->getDateAssigned()),
$this->datetimeToDB($reviewAssignment->getDateNotified()),
$this->datetimeToDB($reviewAssignment->getDateConfirmed()),
$this->datetimeToDB($reviewAssignment->getDateCompleted()),
$this->datetimeToDB($reviewAssignment->getDateAcknowledged()),
$this->datetimeToDB($reviewAssignment->getDateDue()),
$this->datetimeToDB($reviewAssignment->getDateResponseDue()),
$this->datetimeToDB($reviewAssignment->getDateRated()),
$this->datetimeToDB($reviewAssignment->getLastModified()),
$this->datetimeToDB($reviewAssignment->getDateReminded())
),
[
(int) $reviewAssignment->getSubmissionId(),
(int) $reviewAssignment->getReviewerId(),
(int) $reviewAssignment->getStageId(),
(int) $reviewAssignment->getReviewMethod(),
(int) $reviewAssignment->getRound(),
(int) $reviewAssignment->getStep(),
$reviewAssignment->getCompetingInterests(),
$reviewAssignment->getRecommendation(),
(int) $reviewAssignment->getDeclined(),
(int) $reviewAssignment->getCancelled(),
$reviewAssignment->getQuality(),
$reviewAssignment->getReminderWasAutomatic() ? 1 : 0,
$reviewAssignment->getReviewFormId(),
(int) $reviewAssignment->getReviewRoundId(),
(int) $reviewAssignment->getConsidered(),
(int) $reviewAssignment->getRequestResent(),
(int) $reviewAssignment->getId(),
]
);
// Update review stage status whenever a review assignment is changed
$this->updateReviewRoundStatus($reviewAssignment);
}
/**
* Update the status of the review round an assignment is attached to. This
* should be fired whenever a reviewer assignment is modified.
*
* @param ReviewAssignment $reviewAssignment
*/
public function updateReviewRoundStatus($reviewAssignment)
{
$reviewRoundDao = DAORegistry::getDAO('ReviewRoundDAO'); /** @var ReviewRoundDAO $reviewRoundDao */
$reviewRound = $reviewRoundDao->getReviewRound(
$reviewAssignment->getSubmissionId(),
$reviewAssignment->getStageId(),
$reviewAssignment->getRound()
);
// Review round may not exist if submission is being deleted
if ($reviewRound) {
return $reviewRoundDao->updateStatus($reviewRound);
}
return false;
}
/**
* Internal function to return a review assignment object from a row.
*
* @param array $row
*
* @return ReviewAssignment
*/
public function _fromRow($row)
{
$reviewAssignment = $this->newDataObject(); /** @var ReviewAssignment $reviewAssignment */
$user = Repo::user()->get($row['reviewer_id'], true);
$reviewAssignment->setId((int) $row['review_id']);
$reviewAssignment->setSubmissionId((int) $row['submission_id']);
$reviewAssignment->setReviewerId((int) $row['reviewer_id']);
$reviewAssignment->setReviewerFullName($user->getFullName());
$reviewAssignment->setCompetingInterests($row['competing_interests']);
$reviewAssignment->setRecommendation($row['recommendation']);
$reviewAssignment->setDateAssigned($this->datetimeFromDB($row['date_assigned']));
$reviewAssignment->setDateNotified($this->datetimeFromDB($row['date_notified']));
$reviewAssignment->setDateConfirmed($this->datetimeFromDB($row['date_confirmed']));
$reviewAssignment->setDateCompleted($this->datetimeFromDB($row['date_completed']));
$reviewAssignment->setDateAcknowledged($this->datetimeFromDB($row['date_acknowledged']));
$reviewAssignment->setDateDue($this->datetimeFromDB($row['date_due']));
$reviewAssignment->setDateResponseDue($this->datetimeFromDB($row['date_response_due']));
$reviewAssignment->setLastModified($this->datetimeFromDB($row['last_modified']));
$reviewAssignment->setDeclined((int) $row['declined']);
$reviewAssignment->setCancelled((int) $row['cancelled']);
$reviewAssignment->setQuality($row['quality']);
$reviewAssignment->setDateRated($this->datetimeFromDB($row['date_rated']));
$reviewAssignment->setDateReminded($this->datetimeFromDB($row['date_reminded']));
$reviewAssignment->setReminderWasAutomatic((int) $row['reminder_was_automatic']);
$reviewAssignment->setRound((int) $row['round']);
$reviewAssignment->setStep((int) $row['step']);
$reviewAssignment->setReviewFormId($row['review_form_id']);
$reviewAssignment->setReviewRoundId((int) $row['review_round_id']);
$reviewAssignment->setReviewMethod((int) $row['review_method']);
$reviewAssignment->setStageId((int) $row['stage_id']);
$reviewAssignment->setConsidered((int) $row['considered']);
$reviewAssignment->setRequestResent((int) $row['request_resent'] ?? null);
return $reviewAssignment;
}
/**
* Return a new review assignment data object.
*
* @return ReviewAssignment
*/
public function newDataObject()
{
return new ReviewAssignment();
}
/**
* Delete review assignment.
*
* @param int $reviewId
*/
public function deleteById($reviewId)
{
$reviewFormResponseDao = DAORegistry::getDAO('ReviewFormResponseDAO'); /** @var ReviewFormResponseDAO $reviewFormResponseDao */
$reviewFormResponseDao->deleteByReviewId($reviewId);
$reviewFilesDao = DAORegistry::getDAO('ReviewFilesDAO'); /** @var ReviewFilesDAO $reviewFilesDao */
$reviewFilesDao->revokeByReviewId($reviewId);
$notificationDao = DAORegistry::getDAO('NotificationDAO'); /** @var NotificationDAO $notificationDao */
$notificationDao->deleteByAssoc(Application::ASSOC_TYPE_REVIEW_ASSIGNMENT, $reviewId);
// Retrieve the review assignment before it's deleted, so it can be
// be used to fire an update on the review round status.
$reviewAssignment = $this->getById($reviewId);
$result = $this->update('DELETE FROM review_assignments WHERE review_id = ?', [(int) $reviewId]);
$this->updateReviewRoundStatus($reviewAssignment);
return $result;
}
/**
* Delete review assignments by submission ID.
*
* @param int $submissionId
*
* @return bool
*/
public function deleteBySubmissionId($submissionId)
{
$result = $this->retrieve(
'SELECT review_id FROM review_assignments WHERE submission_id = ?',
[(int) $submissionId]
);
$returner = false;
foreach ($result as $row) {
$this->deleteById($row->review_id);
$returner = true;
}
return $returner;
}
/**
* Get the last review round review assignment for a given user.
*
* @param int $submissionId
* @param int $reviewerId
*
* @return ?ReviewAssignment
*/
public function getLastReviewRoundReviewAssignmentByReviewer($submissionId, $reviewerId)
{
$result = $this->retrieve(
$this->_getSelectQuery() . ' WHERE r.submission_id = ? AND r.reviewer_id = ? ORDER BY r2.stage_id DESC, r2.round DESC',
[(int) $submissionId, (int) $reviewerId]
);
$row = (array) $result->current();
return $row ? $this->_fromRow($row) : null;
}
/**
* Return the review methods translation keys.
*
* @return array
*/
public function getReviewMethodsTranslationKeys()
{
return [
ReviewAssignment::SUBMISSION_REVIEW_METHOD_DOUBLEANONYMOUS => 'editor.submissionReview.doubleAnonymous',
ReviewAssignment::SUBMISSION_REVIEW_METHOD_ANONYMOUS => 'editor.submissionReview.anonymous',
ReviewAssignment::SUBMISSION_REVIEW_METHOD_OPEN => 'editor.submissionReview.open',
];
}
/**
* Get sql query to select review assignments.
*
* @return string
*/
public function _getSelectQuery()
{
return 'SELECT r.*, r2.review_revision FROM review_assignments r
LEFT JOIN review_rounds r2 ON (r.review_round_id = r2.review_round_id)';
}
/**
* Delete review assignments by review round ID.
*
* @param int $reviewRoundId
*
* @return int Number of deleted review assignments.
*/
public function deleteByReviewRoundId($reviewRoundId): int
{
return DB::table('review_assignments')
->select(['review_id', 'review_round_id'])
->where('review_round_id', $reviewRoundId)
->get()
->pluck('review_id')
->map(fn ($reviewId) => $this->deleteById($reviewId))
->count();
}
}
if (!PKP_STRICT_MODE) {
class_alias('\PKP\submission\reviewAssignment\ReviewAssignmentDAO', '\ReviewAssignmentDAO');
}