Skip to content

Show both course id and the archive file when they differ when listing course archives in the admin course. #3116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alex-Jordan merged 2 commits into from
Aug 6, 2026
+27 −31
Merged

Show both course id and the archive file when they differ when listing course archives in the admin course. #3116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f6aa10
Show both the course id and the archive file when listing course arch…
drgrice1 Aug 5, 2026
d3c04e3
Only show the filename if it without the extension it differs from th…
drgrice1 Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 15 additions & 26 deletions lib/WeBWorK/Utils/CourseManagement.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,15 @@ sub listCourses {
=item listArchivedCourses($ce)

Lists the courses which have been archived (end in .tar.gz). The courses found
are returned as a hash whose keys are the course ids and the values are
references to hashes containing the C<filename> (the basename of the file
including the .tar.gz extension) and file C<size>. For example,
are returned as a hash whose keys are the filenames (the basename of the file
including the .tar.gz extension) and the values are references to hashes
containing the C<courseID>, file C<size>, and C<lastModified> time. For example,

{
myTestCourse => {
filename => 'myTestCourse.tar.gz',
size => '605 KB'
'myTestCourse.tar.gz' => {
courseID => 'myTestCourse',
size => '605 KB',
lastModified => 1778667472
}
}

Expand All @@ -134,23 +135,19 @@ sub listArchivedCourses {
my $archiveDataFile = $archivesDir->child('archive-cache.json');
my $archiveData = eval { decode_json($archiveDataFile->slurp) } || {};

my $archiveDataUpdated = 0;
my %updatedArchiveData;
my %return;
for (@$archives) {
my $basename = $_->basename;
my $lastModified = $_->stat->mtime;

if ($archiveData->{$basename} && $archiveData->{$basename}{lastModified} >= $lastModified) {
$return{ $archiveData->{$basename}{courseID} } = {
filename => $basename,
size => $archiveData->{$basename}{size}
}
if defined $archiveData->{$basename}{courseID};
$updatedArchiveData{$basename} = $archiveData->{$basename};
$return{$basename} = $updatedArchiveData{$basename} if defined $archiveData->{$basename}{courseID};
next;
}

$archiveDataUpdated = 1;
$archiveData->{$basename} = { lastModified => $lastModified };
$updatedArchiveData{$basename} = { lastModified => $lastModified };

my $archive = Archive::Tar->new($_);
my %top_level;
Expand All @@ -164,20 +161,12 @@ sub listArchivedCourses {
}
my ($currCourseID) = keys %top_level;

$archiveData->{$basename}{courseID} = $currCourseID;
$archiveData->{$basename}{size} = getHumanReadableFileSize($_);
$return{$currCourseID} = { filename => $basename, size => $archiveData->{$basename}{size} };
}

my %archives = map { $_->basename => 1 } @$archives;
for (keys %$archiveData) {
unless ($archives{$_}) {
delete $archiveData->{$_};
$archiveDataUpdated = 1;
}
$updatedArchiveData{$basename}{courseID} = $currCourseID;
$updatedArchiveData{$basename}{size} = getHumanReadableFileSize($_);
$return{$basename} = $updatedArchiveData{$basename};
}

$archiveDataFile->spew(encode_json($archiveData)) if $archiveDataUpdated;
$archiveDataFile->spew(encode_json(\%updatedArchiveData));

return %return;
}
Expand Down
6 changes: 5 additions & 1 deletion templates/ContentGenerator/CourseAdmin.html.ep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@
<ol>
% my %courseArchives = listArchivedCourses($ce);
% for (sort { lc($a) cmp lc($b) } keys %courseArchives) {
<li><%= "$_ ($courseArchives{$_}{size})" %></li>
<li>
<%= "$courseArchives{$_}{courseID} ("
. ($courseArchives{$_}{courseID} eq ($_ =~ s/\.tar\.gz$//ir) ? '' : "$_, ")
. "$courseArchives{$_}{size})" %>
</li>
% }
</ol>
% }
11 changes: 7 additions & 4 deletions templates/ContentGenerator/CourseAdmin/unarchive_course_form.html.ep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
%
% # Find courses which have been archived.
% my %courseArchives = listArchivedCourses($ce);
% my @courseIDs = sort { lc($a) cmp lc($b) } keys %courseArchives;
% my @archiveFiles = sort { lc($a) cmp lc($b) } keys %courseArchives;
%
% if (@courseIDs) {
% if (@archiveFiles) {
<%= form_for current_route, method => 'POST', begin =%>
<%= $c->hidden_authen_fields =%>
<%= $c->hidden_fields('subDisplay') =%>
Expand All @@ -20,8 +20,11 @@
class => 'col-md-2 pe-0 col-form-label fw-bold' =%>
<div class="col-lg-9 col-md-8">
<%= select_field
unarchive_courseID =>
[ map { [ "$_ ($courseArchives{$_}{size})" => $courseArchives{$_}{filename} ] } @courseIDs ],
unarchive_courseID => [
map { [ "$courseArchives{$_}{courseID} ("
. ($courseArchives{$_}{courseID} eq ($_ =~ s/\.tar\.gz$//ir) ? '' : "$_, ")
. "$courseArchives{$_}{size})" => $_ ] } @archiveFiles
],
id => 'unarchive_courseID',
class => 'form-select',
size => 10 =%>
Expand Down