# SPDX-License-Identifier: AGPL-3.0-or-later
# Copyright (C) 2018-2024 Colin B. Macdonald
# Copyright (C) 2019-2021 Andrew Rechnitzer
# Copyright (C) 2020 Dryden Wiebe
# Copyright (C) 2024 Aden Chan
# Copyright (C) 2025 Aidan Murphy
"""Gather reassembled papers with html page for digital return."""
import html
import os
import sys
import shutil
from pathlib import Path
from plom.rules import isValidStudentID, StudentIDLength
from plom.finish import CSVFilename
from .return_tools import csv_add_return_codes
def do_renaming(fromdir, todir, sns):
print("Searching for foo_<studentnumber>.pdf files in {0}...".format(fromdir))
todir = Path(todir)
fromdir = Path(fromdir)
numfiles = 0
for file in os.scandir(fromdir):
if file.name.endswith(".pdf"):
oldname = file.name.partition(".")[0]
sn = oldname.split("_")[-1]
assert isValidStudentID(sn)
code = sns[sn]
newname = "{0}_{1}.pdf".format(oldname, code)
newname = todir / newname
print(
' found SN {0}: code {1}, copying "{2}" to "{3}"'.format(
sn, code, file.name, newname
)
)
shutil.copyfile(fromdir / file.name, newname)
numfiles += 1
return numfiles
[docs]
def make_coded_return_webpage(
shortname: str,
*,
longname: str = "Plom Assessment",
use_hex: bool = True,
digits: int = 9,
salt=None,
solutions=False,
) -> None:
"""Make the secret codes and the return-code webpage.
Args:
shortname: an abbreviated name for the assessment being returned.
Keyword Args:
longname: a human-readable name for this assessment. We will
escape parts of it as appropriate for HTML. If omitted,
defaults to "Plom Assessment".
use_hex (bool): use random hex digits, otherwise an integer
without leading zeros.
digits (int): length of secret code.
salt (str): instead of random, hash from student ID salted
with this string. Defaults to None, which means do not
do this, use random secret codes.
solutions (bool): add a solutions link to the website. Not supported
Returns:
None.
"""
longname = html.escape(longname)
codedReturnDir = Path("codedReturn")
reassembles = ["reassembled", "reassembled_ID_but_not_marked"]
if os.path.isdir(reassembles[0]) and os.path.isdir(reassembles[1]):
print('You have more than one "reassembled*" directory:')
print(" decide what you trying to do and run me again.")
sys.exit(2)
elif os.path.isdir(reassembles[0]):
fromdir = reassembles[0]
elif os.path.isdir(reassembles[1]):
fromdir = reassembles[1]
else:
print("I cannot find any of the dirs: " + ", ".join(reassembles))
print(" Have you called the `reassemble` command yet?")
sys.exit(3)
print('We will take pdf files from "{0}".'.format(fromdir))
if codedReturnDir.exists() or os.path.exists("return_codes.csv"):
print(
'Directory "{}" and/or "return_codes.csv" already exist:\n'
" if you want to re-run this script, delete them first.".format(
codedReturnDir
)
)
sys.exit(4)
os.makedirs(codedReturnDir)
print("Generating return codes spreadsheet...")
if salt:
print('Salt string "{}" can reproduce these return codes'.format(salt))
else:
print("These return codes will be random and non-reproducible")
sns = csv_add_return_codes(
CSVFilename, "return_codes.csv", "StudentID", use_hex, digits, salt
)
print('The return codes are in "return_codes.csv"')
numfiles = do_renaming(fromdir, codedReturnDir, sns)
if numfiles > 0:
print("Copied (and renamed) {0} files".format(numfiles))
else:
print('no pdf files in "{0}"? Stopping!'.format(fromdir))
sys.exit(5)
if solutions:
print('"solutions" option is no longer supported,')
print("skipping copying solutions files.")
print("Adding index.html file")
from .html_view_test_template import htmlsrc
htmlsrc = htmlsrc.replace("__COURSENAME__", longname)
htmlsrc = htmlsrc.replace("__TESTNAME__", shortname)
htmlsrc = htmlsrc.replace("__CODE_LENGTH__", str(digits))
htmlsrc = htmlsrc.replace("__SID_LENGTH__", str(StudentIDLength))
with open(codedReturnDir / "index.html", "w") as htmlfile:
htmlfile.write(htmlsrc)
print("All done! Next tasks:")
print(' * Copy "{}" to your webserver'.format(codedReturnDir))
print(' * Privately communicate info from "return_codes.csv"')
print(" - E.g., see `contrib/plom-return_codes_to_canvas_csv.py`")
print(" * Read docs about the security implications of all this.")