review.php

<?php
// review.php -- HotCRP paper review display/edit page
// Copyright (c) 2006-2020 Eddie Kohler; see LICENSE.

require_once("src/initweb.php");
require_once("src/papertable.php");

$rf = $Conf->review_form();
$Me->add_overrides(Contact::OVERRIDE_CHECK_TIME);
if (session_id() === "" && $Me->is_reviewer()) {
    ensure_session();
}


// header
function review_header() {
    global $paperTable, $Qreq;
    PaperTable::do_header($paperTable, "review", $Qreq->mode, $Qreq);
}

function review_error($msg) {
    review_header();
    Ht::stash_script("hotcrp.shortcut().add()");
    $msg && Conf::msg_error($msg);
    Conf::$main->footer();
    exit;
}


// collect paper ID
function review_load() {
    global $Conf, $Me, $Qreq, $prow, $paperTable;
    if (!($prow = PaperTable::fetch_paper_request($Qreq, $Me))) {
        $whyNot = $Qreq->checked_annex("paper_whynot", "PermissionProblem");
        review_error(whyNotText($whyNot->set("listViewable", true)));
    }
    $paperTable = new PaperTable($prow, $Qreq);
    $paperTable->resolveReview(true);
}
review_load();


// general error messages
if ($Qreq->post && $Qreq->post_empty()) {
    $Conf->post_missing_msg();
} else if ($Qreq->post && $Qreq->default) {
    if ($Qreq->has_file("uploadedFile")) {
        $Qreq->uploadForm = 1;
    } else {
        $Qreq->update = 1;
    }
} else if ($Qreq->submitreview) {
    $Qreq->update = $Qreq->ready = 1;
} else if ($Qreq->savedraft) {
    $Qreq->update = 1;
    unset($Qreq->ready);
}


// cancel action
if ($Qreq->cancel) {
    $Conf->redirect_self($Qreq);
}


// upload review form action
if (isset($Qreq->uploadForm)
    && $Qreq->has_file("uploadedFile")
    && $Qreq->valid_post()) {
    // parse form, store reviews
    $tf = ReviewValues::make_text($rf, $Qreq->file_contents("uploadedFile"),
            $Qreq->file_filename("uploadedFile"));
    if ($tf->parse_text($Qreq->override)) {
        $tf->check_and_save($Me, $prow, $paperTable->editrrow);
    }
    if (!$tf->has_error() && $tf->parse_text($Qreq->override)) {
        $tf->msg_at(null, 'Only the first review form in the file was parsed. <a href="' . hoturl("offline") . '">Upload multiple-review files here.</a>', MessageSet::WARNING);
    }
    $tf->report();
    review_load();
} else if (isset($Qreq->uploadForm)) {
    Conf::msg_error("Select a review form to upload.");
}


// check review submit requirements
if (isset($Qreq->unsubmitreview)
    && $paperTable->editrrow
    && $paperTable->editrrow->reviewStatus >= ReviewInfo::RS_DELIVERED
    && $Me->can_administer($prow)
    && $Qreq->valid_post()) {
    $result = $Me->unsubmit_review_row($paperTable->editrrow);
    if (!Dbl::is_error($result) && $result->affected_rows) {
        $Me->log_activity_for($paperTable->editrrow->contactId, "Review {$paperTable->editrrow->reviewId} unsubmitted", $prow);
        $Conf->confirmMsg("Unsubmitted review.");
    }
    $Conf->redirect_self($Qreq);             // normally does not return
    review_load();
} else if (isset($Qreq->update)
           && $paperTable->editrrow
           && $paperTable->editrrow->reviewStatus >= ReviewInfo::RS_COMPLETED) {
    $Qreq->ready = 1;
}


// update review action
if (isset($Qreq->update) && $Qreq->valid_post()) {
    $tf = new ReviewValues($rf);
    $tf->paperId = $prow->paperId;
    if (($whyNot = $Me->perm_submit_review($prow, $paperTable->editrrow))) {
        $tf->msg_at(null, whyNotText($whyNot), MessageSet::ERROR);
    } else if ($tf->parse_web($Qreq, $Qreq->override)) {
        if (isset($Qreq->approvesubreview)
            && $paperTable->editrrow
            && $Me->can_approve_review($prow, $paperTable->editrrow)) {
            $tf->set_adopt();
        }
        if ($tf->check_and_save($Me, $prow, $paperTable->editrrow)
            && !$tf->has_problem_at("ready")) {
            $tf->report();
            $Conf->redirect_self($Qreq); // normally does not return
        }
    }
    review_load();
    $tf->report();
    $paperTable->set_review_values($tf);
} else if ($Qreq->has_annex("after_login")) {
    $tf = new ReviewValues($rf);
    $tf->parse_web($Qreq, $Qreq->override);
    $paperTable->set_review_values($tf);
}


// adopt review action
if (isset($Qreq->adoptreview)
    && $Qreq->valid_post()
    && $paperTable->editrrow
    && $Me->can_approve_review($prow, $paperTable->editrrow)) {
    $tf = new ReviewValues($rf);
    $tf->paperId = $prow->paperId;
    $my_rrow = $prow->review_of_user($Me);
    if (($whyNot = $Me->perm_submit_review($prow, $my_rrow))) {
        $tf->msg_at(null, whyNotText($whyNot), MessageSet::ERROR);
    } else if ($tf->parse_web($Qreq, $Qreq->override)) {
        $tf->set_ready($Qreq->adoptsubmit);
        if ($tf->check_and_save($Me, $prow, $my_rrow)
            && !$tf->has_problem_at("ready")) {
            $tf->report();

            // mark the review as approved
            $tfx = new ReviewValues($rf);
            $tfx->set_adopt();
            $tfx->check_and_save($Me, $prow, $paperTable->editrrow);
        }
    }
    if (($my_rrow = $prow->fresh_review_of_user($Me))) {
        $Qreq->r = $my_rrow->reviewId;
    }
    $Conf->redirect_self($Qreq); // normally does not return
}


// delete review action
if (isset($Qreq->deletereview)
    && $Qreq->valid_post()
    && $Me->can_administer($prow)) {
    if (!$paperTable->editrrow) {
        Conf::msg_error("No review to delete.");
    } else {
        $result = $Conf->qe("delete from PaperReview where paperId=? and reviewId=?", $prow->paperId, $paperTable->editrrow->reviewId);
        if (!Dbl::is_error($result) && $result->affected_rows) {
            $Me->log_activity_for($paperTable->editrrow->contactId, "Review {$paperTable->editrrow->reviewId} deleted", $prow);
            $Conf->confirmMsg("Deleted review.");
            $Conf->qe("delete from ReviewRating where paperId=? and reviewId=?", $prow->paperId, $paperTable->editrrow->reviewId);
            if ($paperTable->editrrow->reviewToken !== 0) {
                $Conf->update_rev_tokens_setting(-1);
            }
            if ($paperTable->editrrow->reviewType == REVIEW_META) {
                $Conf->update_metareviews_setting(-1);
            }

            // perhaps a delegatee needs to redelegate
            if ($paperTable->editrrow->reviewType < REVIEW_SECONDARY
                && $paperTable->editrrow->requestedBy > 0) {
                $Me->update_review_delegation($paperTable->editrrow->paperId, $paperTable->editrrow->requestedBy, -1);
            }

            unset($Qreq->r, $Qreq->reviewId);
            $Qreq->paperId = $Qreq->p = $paperTable->editrrow->paperId;
            $Conf->redirect_hoturl("paper", ["p" => $Qreq->paperId]);
        }
        $Conf->redirect_self($Qreq);         // normally does not return
        review_load();
    }
}


// download review form action
function downloadForm($qreq) {
    global $rf, $Conf, $Me, $prow, $paperTable;
    $rrow = $paperTable->rrow;
    $use_request = (!$rrow || $rrow->contactId == $Me->contactId)
        && $prow->review_type($Me) > 0;
    $filename = "review-{$prow->paperId}";
    if ($rrow && $rrow->reviewOrdinal) {
        $filename .= unparseReviewOrdinal($rrow->reviewOrdinal);
    }
    $Conf->make_csvg($filename, CsvGenerator::TYPE_STRING)
        ->set_inline(false)
        ->add_string($rf->textFormHeader(false) . $rf->textForm($prow, $rrow, $Me, $use_request ? $qreq : null))
        ->download();
    exit;
}

if (isset($Qreq->downloadForm)) {
    downloadForm($Qreq);
}


function download_all_text_reviews() {
    global $rf, $Conf, $Me, $prow, $paperTable;
    $lastrc = null;
    $text = "";
    foreach ($prow->viewable_submitted_reviews_and_comments($Me) as $rc) {
        $text .= PaperInfo::review_or_comment_text_separator($lastrc, $rc);
        if (isset($rc->reviewId)) {
            $text .= $rf->unparse_text($prow, $rc, $Me, ReviewForm::UNPARSE_NO_TITLE);
        } else {
            $text .= $rc->unparse_text($Me, ReviewForm::UNPARSE_NO_TITLE);
        }
        $lastrc = $rc;
    }
    if ($text === "") {
        $whyNot = $Me->perm_view_review($prow, null) ? : $prow->make_whynot();
        return Conf::msg_error(whyNotText($whyNot));
    }
    $Conf->make_csvg("reviews-{$prow->paperId}", CsvGenerator::TYPE_STRING)
        ->add_string($Conf->short_name . " Paper #{$prow->paperId} Reviews and Comments\n"
            . str_repeat("=", 75) . "\n"
            . prefix_word_wrap("", "Paper #{$prow->paperId} {$prow->title}", 0, 75)
            . "\n\n" . $text)
        ->download();
    exit;
}

function download_one_text_review(ReviewInfo $rrow) {
    global $rf, $Conf, $Me, $prow, $paperTable;
    $filename = "review-{$prow->paperId}";
    if ($rrow->reviewOrdinal) {
        $filename .= unparseReviewOrdinal($rrow->reviewOrdinal);
    }
    $Conf->make_csvg($filename, CsvGenerator::TYPE_STRING)
        ->add_string($rf->unparse_text($prow, $rrow, $Me))
        ->download();
    exit;
}

if (isset($Qreq->text)) {
    if ($paperTable->rrow) {
        download_one_text_review($paperTable->rrow);
    } else {
        download_all_text_reviews();
    }
}


// retract review request
if ((isset($Qreq->refuse) || isset($Qreq->decline))
    && ($Qreq->valid_post()
        || ($Me->capability("@ra" . $prow->paperId) && !$Qreq->is_head()))) {
    $decline_email = null;
    if ($paperTable->editrrow) {
        $Qreq->email = $decline_email = $paperTable->editrrow->email;
    } else if (($ra_cid = $Me->capability("@ra" . $prow->paperId))
               && ($ra_user = $Conf->cached_user_by_id($ra_cid))) {
        $Qreq->email = $decline_email = $ra_user->email;
    }
    $result = RequestReview_API::declinereview($Me, $Qreq, $prow);
    $result = JsonResult::make($result);
    if ($result->content["ok"]) {
        if (($Qreq->refuse === "1" || $Qreq->decline === "1")
            && $decline_email
            && !isset($Qreq->reason)) {
            $Conf->confirmMsg("<p>Thank you for telling us that you cannot complete your review. If you’d like, you may enter a brief explanation here.</p>"
                . Ht::form($Conf->hoturl_post("api/declinereview", ["p" => $prow->paperId, "email" => $decline_email, "redirect" => $Conf->hoturl_site_relative_raw("index")]))
                . Ht::textarea("reason", $result->content["reason"], ["rows" => 3, "cols" => 40, "spellcheck" => true])
                . '<hr class="c">'
                . Ht::submit("Update explanation", ["class" => "btn-primary"])
                . '</form>');
        } else {
            $Conf->confirmMsg("Review declined. Thank you for telling us that you cannot complete your review.");
            unset($Qreq->email, $Qreq->firstName, $Qreq->lastName, $Qreq->affiliation, $Qreq->round, $Qreq->reason, $Qreq->override, $Qreq->retract);
            $Conf->redirect_self($Qreq);
        }
    } else {
        $result->export_errors();
    }
    review_load();
}

if (isset($Qreq->accept)
    && ($Qreq->valid_post()
        || ($Me->capability("@ra" . $prow->paperId) && !$Qreq->is_head()))) {
    $rrow = $paperTable->editrrow;
    if (!$rrow
        || (!$Me->is_my_review($rrow) && !$Me->can_administer($prow))) {
        Conf::msg_error("This review was not assigned to you, so you cannot confirm your intention to write it.");
    } else {
        if ($rrow->reviewStatus < ReviewInfo::RS_ACCEPTED) {
            Dbl::qe("update PaperReview set reviewModified=1, timeRequestNotified=greatest(?,timeRequestNotified)
                where paperId=? and reviewId=? and reviewModified<=0",
                Conf::$now, $prow->paperId, $rrow->reviewId);
            if ($Me->is_signed_in()) {
                $rrow->delete_acceptor();
            }
            $Me->log_activity_for($rrow->contactId, "Review {$rrow->reviewId} accepted", $prow);
        }
        $Conf->confirmMsg("Thank you for confirming your intention to finish this review. You can download the paper and review form below.");
        $Conf->redirect_self($Qreq);
        review_load();
    }
}


// can we view/edit reviews?
$viewAny = $Me->can_view_review($prow, null);
$editAny = $Me->can_review($prow, null);


// can we see any reviews?
if (!$viewAny && !$editAny) {
    if (($whyNotPaper = $Me->perm_view_paper($prow))) {
        review_error(whyNotText($whyNotPaper->set("listViewable", true)));
    }
    if (isset($Qreq->reviewId)) {
        Conf::msg_error("You can’t see the reviews for this paper. "
                        . whyNotText($Me->perm_view_review($prow, null)));
        $Conf->redirect_hoturl("paper", "p=$prow->paperId");
    }
}


// mode
$paperTable->fixReviewMode();
if ($paperTable->mode == "edit") {
    $Conf->redirect_hoturl("paper", ["p" => $prow->paperId]);
}


// paper table
review_header();

$paperTable->initialize(false, false);
$paperTable->paptabBegin();
$paperTable->resolveComments();

if (!$viewAny
    && !$editAny
    && (!$paperTable->rrow
        || !$Me->can_view_review($prow, $paperTable->rrow))) {
    $paperTable->paptabEndWithReviewMessage();
} else {
    if ($paperTable->mode === "re") {
        $paperTable->paptabEndWithEditableReview();
        $paperTable->paptabComments();
    } else {
        $paperTable->paptabEndWithReviewsAndComments();
    }
}

echo "</article>\n";
$Conf->footer();