bulkassign.php

<?php
// bulkassign.php -- HotCRP bulk paper assignment page
// HotCRP is Copyright (c) 2006-2017 Eddie Kohler and Regents of the UC
// Distributed under an MIT-like license; see LICENSE

require_once("src/initweb.php");
require_once("src/papersearch.php");
require_once("src/assigners.php");
if (!$Me->is_manager())
    $Me->escape();
if (check_post())
    header("X-Accel-Buffering: no");  // NGINX: do not hold on to file
$null_mailer = new HotCRPMailer(null, null, array("requester_contact" => $Me,
                                                  "other_contact" => $Me /* backwards compat */,
                                                  "reason" => "",
                                                  "width" => false));
$Error = array();

$_GET["rev_round"] = $_POST["rev_round"] = $_REQUEST["rev_round"] =
    (string) $Conf->sanitize_round_name(req("rev_round"));


function assignment_defaults() {
    $defaults = array("action" => req("default_action"),
                      "round" => $_REQUEST["rev_round"]);
    if (req("requestreview_notify") && req("requestreview_body"))
        $defaults["extrev_notify"] = ["subject" => req("requestreview_subject"),
                                      "body" => req("requestreview_body")];
    return $defaults;
}

$csv_lineno = 0;
$csv_preparing = false;
$csv_started = 0;
function keep_browser_alive($assignset, $lineno, $line) {
    global $Conf, $csv_lineno, $csv_preparing, $csv_started;
    $time = microtime(true);
    $csv_lineno = $lineno;
    if (!$csv_started)
        $csv_started = $time;
    else if ($time - $csv_started > 1) {
        if (!$csv_preparing) {
            echo "<div id='foldmail' class='foldc fold2o'>",
                "<div class='fn fx2 merror'>Preparing assignments.<br /><span id='mailcount'></span></div>",
                "</div>";
            $csv_preparing = true;
        }
        if ($assignset->filename)
            $text = "<span class='lineno'>"
                . htmlspecialchars($assignset->filename) . ":$lineno:</span>";
        else
            $text = "<span class='lineno'>line $lineno:</span>";
        if ($line === false)
            $text .= " processing";
        else
            $text .= " <code>" . htmlspecialchars(join(",", $line)) . "</code>";
        echo Ht::unstash_script("\$\$('mailcount').innerHTML=" . json_encode($text) . ";");
        flush();
        while (@ob_end_flush())
            /* skip */;
    }
}

function finish_browser_alive() {
    global $csv_preparing;
    if ($csv_preparing)
        echo Ht::unstash_script("fold('mail',null)");
}

function complete_assignment($callback) {
    global $Me;
    $assignset = new AssignmentSet($Me, false);
    $assignset->parse($_POST["file"], get($_POST, "filename"),
                      assignment_defaults(), $callback);
    $SSel = SearchSelection::make(make_qreq(), $Me);
    $assignset->restrict_papers($SSel->selection());
    return $assignset->execute(true);
}


if (isset($_REQUEST["saveassignment"]) && check_post()
    && (isset($_REQUEST["cancel"])
        || (isset($_POST["file"]) && get($_POST, "assignment_size_estimate") < 1000
            && complete_assignment(null))))
    /*redirectSelf()*/;


$Conf->header("Assignments &nbsp;&#x2215;&nbsp; <strong>Bulk update</strong>", "bulkassign", actionBar());
echo '<div class="psmode">',
    '<div class="papmode"><a href="', hoturl("autoassign"), '">Automatic</a></div>',
    '<div class="papmode"><a href="', hoturl("manualassign"), '">Manual</a></div>',
    '<div class="papmodex"><a href="', hoturl("bulkassign"), '">Bulk update</a></div>',
    '</div><hr class="c" />';


// Help list
echo "<div class='helpside'><div class='helpinside'>
Assignment methods:
<ul><li><a href='", hoturl("autoassign"), "'>Automatic</a></li>
 <li><a href='", hoturl("manualassign"), "'>Manual by PC member</a></li>
 <li><a href='", hoturl("assign"), "'>Manual by paper</a></li>
 <li><a href='", hoturl("bulkassign"), "' class='q'><strong>Bulk update</strong></a></li>
</ul>
<hr class='hr' />
Types of PC review:
<dl><dt>" . review_type_icon(REVIEW_PRIMARY) . " Primary</dt><dd>Mandatory, may not be delegated</dd>
  <dt>" . review_type_icon(REVIEW_SECONDARY) . " Secondary</dt><dd>Mandatory, may be delegated to external reviewers</dd>
  <dt>" . review_type_icon(REVIEW_PC) . " Optional</dt><dd>May be declined</dd></dl>
</div></div>";


// upload review form action
if (isset($_POST["bulkentry"]) && trim($_POST["bulkentry"]) === "Enter assignments")
    unset($_POST["bulkentry"]);
if (isset($_GET["upload"]) && check_post()
    && ((isset($_POST["bulkentry"]) && $_POST["bulkentry"])
        || file_uploaded($_FILES["bulk"]))) {
    flush();
    while (@ob_end_flush())
        /* do nothing */;
    if (file_uploaded($_FILES["bulk"])) {
        $text = file_get_contents($_FILES["bulk"]["tmp_name"]);
        $filename = $_FILES["bulk"]["name"];
    } else {
        $text = $_POST["bulkentry"];
        $filename = "";
    }
    if ($text === false)
        Conf::msg_error("Internal error: cannot read file.");
    else {
        $assignset = new AssignmentSet($Me, false);
        $defaults = assignment_defaults();
        $text = convert_to_utf8($text);
        $assignset->parse($text, $filename, $defaults, "keep_browser_alive");
        finish_browser_alive();
        if ($assignset->has_error())
            $assignset->report_errors();
        else if ($assignset->is_empty())
            $Conf->warnMsg("That assignment file makes no changes.");
        else {
            $atype = $assignset->type_description();
            echo '<h3>Proposed ', $atype ? $atype . " " : "", 'assignment</h3>';
            $Conf->infoMsg("Select “Apply changes” if this looks OK. (You can always alter the assignment afterwards.)");

            list($atypes, $apids) = $assignset->types_and_papers(true);
            echo Ht::form_div(hoturl_post("bulkassign",
                                          ["saveassignment" => 1,
                                           "assigntypes" => join(" ", $atypes),
                                           "assignpids" => join(" ", $apids)]));

            $assignset->echo_unparse_display();

            echo '<div class="g"></div>',
                '<div class="aahc"><div class="aa">',
                Ht::submit("Apply changes"),
                ' &nbsp;', Ht::submit("cancel", "Cancel"),
                Ht::hidden("default_action", $defaults["action"]),
                Ht::hidden("rev_round", $defaults["round"]),
                Ht::hidden("file", $text),
                Ht::hidden("assignment_size_estimate", $csv_lineno),
                Ht::hidden("filename", $filename),
                Ht::hidden("requestreview_notify", req("requestreview_notify")),
                Ht::hidden("requestreview_subject", req("requestreview_subject")),
                Ht::hidden("requestreview_body", req("requestreview_body")),
                Ht::hidden("bulkentry", req("bulkentry")),
                '</div></div></div></form>', "\n";
            $Conf->footer();
            exit;
        }
    }
}

if (isset($_REQUEST["saveassignment"]) && check_post()
    && isset($_POST["file"]) && get($_POST, "assignment_size_estimate") >= 1000) {
    complete_assignment("keep_browser_alive");
    finish_browser_alive();
}


echo Ht::form_div(hoturl_post("bulkassign", "upload=1"),
                  array("divstyle" => "margin-top:1em"));

// Upload
echo '<div class="f-contain"><div class="f-i"><div class="f-e">',
    Ht::textarea("bulkentry", req_s("bulkentry"),
                 ["rows" => 1, "cols" => 80, "placeholder" => "Enter assignments", "class" => "need-autogrow"]),
    '</div></div></div>';

echo '<div class="g"><strong>OR</strong> &nbsp;',
    '<input type="file" name="bulk" accept="text/plain,text/csv" size="30" /></div>';

echo '<div id="foldoptions" class="lg foldc fold2o fold3c">',
    'By default, assign&nbsp; ',
    Ht::select("default_action", array("primary" => "primary reviews",
                                       "secondary" => "secondary reviews",
                                       "pcreview" => "optional PC reviews",
                                       "review" => "external reviews",
                                       "conflict" => "PC conflicts",
                                       "lead" => "discussion leads",
                                       "shepherd" => "shepherds",
                                       "tag" => "add tags",
                                       "settag" => "replace tags",
                                       "preference" => "reviewer preferences"),
               defval($_REQUEST, "default_action", "primary"),
               array("id" => "tsel", "onchange" => "fold(\"options\",this.value!=\"review\");fold(\"options\",!/^(?:primary|secondary|(?:pc)?review)$/.test(this.value),2)"));
$rev_rounds = $Conf->round_selector_options();
if (count($rev_rounds) > 1)
    echo '<span class="fx2">&nbsp; in round &nbsp;',
        Ht::select("rev_round", $rev_rounds, $_REQUEST["rev_round"] ? : "unnamed"),
        '</span>';
else if (!get($rev_rounds, "unnamed"))
    echo '<span class="fx2">&nbsp; in round ', $Conf->assignment_round_name(false), '</span>';
echo '<div class="g"></div>', "\n";

$requestreview_template = $null_mailer->expand_template("requestreview");
echo Ht::hidden("requestreview_subject", $requestreview_template["subject"]);
if (isset($_REQUEST["requestreview_body"]))
    $t = $_REQUEST["requestreview_body"];
else
    $t = $requestreview_template["body"];
echo "<table class='fx'><tr><td>",
    Ht::checkbox("requestreview_notify", 1, true),
    "&nbsp;</td><td>", Ht::label("Send email to external reviewers:"), "</td></tr>
<tr><td></td><td>",
    Ht::textarea("requestreview_body", $t, array("class" => "tt", "cols" => 80, "rows" => 20, "spellcheck" => "true", "class" => "need-autogrow")),
    "</td></tr></table>\n";

echo '<div class="lg"></div>', Ht::submit("Prepare assignments", ["class" => "btn btn-default"]),
    " &nbsp; <span class='hint'>You’ll be able to check the assignment before it is saved.</span></div>\n";

echo '<div style="margin-top:1.5em"><a href="', hoturl_post("search", "t=manager&q=&get=pcassignments&p=all"), '">Download current PC assignments</a></div>';

echo "</div></form>

<hr style='margin-top:1em' />

<div class='helppagetext'>
<h3>Instructions</h3>

<p>Upload a comma-separated value file to prepare an assignment of reviews,
conflicts, leads, shepherds, and tags. HotCRP calculates the minimal changes
between the current state and the requested assignment; you’ll confirm those
changes before they are committed.</p>

<p>A simple example:</p>

<pre class='entryexample'>paper,assignment,email
1,primary,man@alice.org
2,secondary,slugger@manny.com
1,primary,slugger@manny.com</pre>

<p>This assigns PC members man@alice.org and slugger@manny.com as primary
reviewers for paper #1, and slugger@manny.com as a secondary
reviewer for paper #2. Errors will be reported if those users aren’t PC
members, or if they have conflicts with their assigned papers.</p>

<p>A more complex example:</p>

<pre class='entryexample'>paper,assignment,email,round
all,clearreview,all,R2
1,primary,man@alice.org,R2
10,primary,slugger@manny.com,R2
#manny OR #ramirez,primary,slugger@manny.com,R2</pre>

<p>The first assignment line clears all review assignments in
round R2. (Review assignments in other rounds are left alone.) The next
lines assign man@alice.org as a primary reviewer for paper #1, and slugger@manny.com
as a primary reviewer for paper #10. The last line assigns slugger@manny.com
as a primary reviewer for all papers tagged #manny or #ramirez.</p>

<p>Assignment types are:</p>

<dl class=\"spaced\">
<dt><code>review</code></dt>

<dd>Assign a review. The <code>email</code> and/or <code>name</code> columns
locate the user. (<code>first</code> and <code>last</code> columns may be used
in place of <code>name</code>.) The <code>reviewtype</code> column sets the
review type; it can be <code>primary</code>, <code>secondary</code>,
<code>pcreview</code> (optional PC review), or <code>external</code>, or
<code>clear</code> to unassign the review. The optional
<code>round</code> column sets the review round.

<p>Only PC members can be assigned primary, secondary, and optional PC
reviews. Accounts will be created for new external reviewers as necessary. The
<code>clear</code> action doesn’t delete reviews that have already been
entered.</p>

<p>Assignments can create new reviews or change existing reviews. Use
“<code>any</code>” or “old:new” syntax in the <code>round</code> and/or
<code>reviewtype</code> columns to restrict assignments to existing reviews.
For example, to create a new assignment or modify an existing review:</p>

<pre class=\"entryexample\">paper,assignment,email,reviewtype,round
1,review,drew@harvard.edu,primary,R2</pre>

<p>To modify an existing review’s round (“<code>any</code>” restricts the
assignment to existing reviews):</p>

<pre class=\"entryexample\">paper,assignment,email,reviewtype,round
1,review,drew@harvard.edu,any,R2</pre>

<p>To change an existing review from round R1 to round R2:</p>

<pre class=\"entryexample\">paper,assignment,email,reviewtype,round
1,review,drew@harvard.edu,any,R1:R2</pre>

<p>To change all round-R1 primary reviews to round R2:</p>

<pre class=\"entryexample\">paper,assignment,email,reviewtype,round
all,review,all,primary,R1:R2</pre>

</dd>

<dt><code>primary</code>, <code>secondary</code>, <code>pcreview</code>,
<code>external</code>, <code>clearreview</code></dt>
<dd>Like <code>review</code>, assign a primary, secondary, optional PC, or
external review, or clear existing reviews.</dd>

<dt><code>unsubmitreview</code></dt>
<dd>Unsubmit a submitted review. The <code>email</code>, <code>name</code>,
<code>reviewtype</code>, and <code>round</code> columns locate the review.</dd>

<dt><code>lead</code></dt>
<dd>Set the discussion lead. The <code>email</code>, <code>name</code>,
and/or <code>user</code> columns locate the PC user. To clear the discussion lead,
use email <code>none</code> or assignment type <code>clearlead</code>.</dd>

<dt><code>shepherd</code></dt>
<dd>Set the shepherd. The <code>email</code>, <code>name</code>,
and/or <code>user</code> columns locate the PC user. To clear the shepherd,
use email <code>none</code> or assignment type <code>clearshepherd</code>.</dd>

<dt><code>conflict</code></dt>
<dd>Mark a PC conflict. The <code>email</code>, <code>name</code>,
and/or <code>user</code> columns locate the PC user. To clear a conflict,
use assignment type <code>clearconflict</code>.</dd>

<dt><code>tag</code></dt>
<dd>Add a tag. The <code>tag</code> column names the tag and the optional
<code>value</code> column sets the tag value.
To clear a tag, use assignment type <code>cleartag</code> or value <code>none</code>.</dd>

<dt><code>preference</code></dt>
<dd>Set reviewer preference and expertise. The <code>preference</code> column
gives the preference value.</dd>
</dl>

</div>\n";

Ht::stash_script('$("#tsel").trigger("change")');
$Conf->footer();