1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
|
#!/usr/bin/env python
# IVLE - Informatics Virtual Learning Environment
# Copyright (C) 2007-2009 The University of Melbourne
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# Program: Fetch Submissions
# Author: Matt Giuca
# Script to retrieve all submissions for a particular project.
# Requires root to run.
from __future__ import with_statement
import sys
import os
import shutil
import datetime
import codecs
import optparse
import zipfile
import traceback
import pysvn
if os.getuid() != 0:
print >>sys.stderr, "Must run %s as root." % os.path.basename(sys.argv[0])
sys.exit()
import ivle.config
import ivle.database
import ivle.util
from ivle.database import Project, ProjectSet, Offering, Subject
# Is Python version 2.6 or higher?
PYTHON26 = map(int, sys.version[:3].split('.')) >= [2, 6]
def fetch_submission(submission, target, svnclient, config, zip=False,
txt=False, verbose=False):
"""Fetch a submission from a user's repository, and dump it in a given
directory.
@param submission: Submission object, detailing the submission.
@param target: Target directory for the project (will create a
subdirectory for each submission).
@param svnclient: pysvn.Client object.
@param config: Config object.
@param zip: If True, zips up the submission.
@param txt: If True, writes an extra text file with metadata about the
submission.
@param verbose: If True, writes the name of each submission to stdout.
"""
# submission_name is the name of the user or group who owns the repo
submission_name = submission.assessed.principal.short_name
# target_final is the directory to place the files in
target_final = os.path.join(target,
submission.assessed.principal.short_name)
target_final = target_final.encode('utf-8')
if os.path.exists(target_final):
# Remove the existing file or directory before re-checking out
if os.path.isdir(target_final):
ivle.util.safe_rmtree(target_final)
else:
os.remove(target_final)
url = get_repo_url(submission, config)
revision = pysvn.Revision(pysvn.opt_revision_kind.number,
submission.revision)
svnclient.export(url, target_final, force=True,
revision=revision, recurse=True)
if txt:
# info_final is the directory to place the metadata info files in
info_final = target_final + ".txt"
write_submission_info(info_final, submission)
# If required, zip up the directory
if zip:
make_zip(target_final, target_final + ".zip")
# Remove the target tree
if os.path.isdir(target_final):
ivle.util.safe_rmtree(target_final)
else:
os.remove(target_final)
if verbose:
print "Exported submission by: %s (%s)" % (
submission.assessed.principal.short_name,
submission.assessed.principal.display_name)
def get_repo_url(submission, config):
"""Gets a local (file:) URL to the repository for a given submission.
This will consult submission.path to find the path within the repository
to check out.
@param submission: Submission object, detailing the submission.
@param config: Config object.
"""
# NOTE: This code is mostly copied from services/usrmgt-server
if submission.assessed.is_group:
# The offering this group is in
offering = submission.assessed.project.project_set.offering
groupname = submission.assessed.principal.short_name
# The name of the repository directory within 'groups' is
# SUBJECT_YEAR_SEMESTER_GROUP
namespace = "_".join([offering.subject.short_name,
offering.semester.year, offering.semester.semester, groupname])
repo_path = os.path.join(config['paths']['svn']['repo_path'],
'groups', namespace)
else:
# The name of the repository directory within 'users' is the username
username = submission.assessed.principal.short_name
repo_path = os.path.join(config['paths']['svn']['repo_path'],
'users', username)
path_in_repo = submission.path
# Change an absolute path into a relative one (to the top of SVN)
if path_in_repo[:1] == os.sep or path_in_repo[:1] == os.altsep:
path_in_repo = path_in_repo[1:]
# Attach "file://" to the front of the absolute path, to make it a URL
return "file://" + os.path.join(os.path.abspath(repo_path), path_in_repo)
def make_zip(source, dest):
"""Zip up a directory tree or file. The ZIP file will always contain just
a single directory or file at the top level (it will not be a ZIP bomb).
XXX In Python 2.5 and earlier, this does NOT create empty directories
(it's not possible with the Python2.5 version of zipfile).
@param source: Path to a directory or file to zip up.
@param dest: Path to a zip file to create.
"""
# NOTE: This code is mostly copied from ivle.zip (but very different)
zip = zipfile.ZipFile(dest, 'w')
# Write the source file/directory itself
# (If this is a directory it will NOT recurse)
if PYTHON26 or not os.path.isdir(source):
# Python < 2.6 errors if you add a directory
# (This means you can't add an empty directory)
zip.write(source, os.path.basename(source))
if os.path.isdir(source):
# All paths within the zip file are relative to relativeto
relativeto = os.path.dirname(source)
# Write the top-level directory
# Walk the directory tree
def error(err):
raise OSError("Could not access a file (zipping)")
for (dirpath, dirnames, filenames) in \
os.walk(source, onerror=error):
arc_dirpath = ivle.util.relpath(dirpath, relativeto)
# Python < 2.6 errors if you add a directory
# (This means you can't add an empty directory)
if PYTHON26:
filenames = dirnames + filenames
for filename in filenames:
zip.write(os.path.join(dirpath, filename),
os.path.join(arc_dirpath, filename))
if not PYTHON26:
# XXX Write this _didModify attribute of zip, to trick it into writing
# footer bytes even if there are no files in the archive (otherwise it
# writes a 0-byte archive which is invalid).
# Note that in Python2.6 we avoid this by always writing the top-level
# file or directory, at least.
zip._didModify = True
zip.close()
def write_submission_info(filename, submission):
"""Write human-readable meta-data about a submission to a file.
@param filename: Filename to write to.
@param submission: Submission object.
"""
with codecs.open(filename, 'w', 'utf-8') as f:
if submission.assessed.is_group:
# A group project
print >>f, "Group: %s (%s)" % (
submission.assessed.principal.short_name,
submission.assessed.principal.display_name)
else:
# A solo project
# Only show the two fields if they are different (only in rare
# circumstances)
if submission.assessed.principal != submission.submitter:
print >>f, "Author: %s (%s)" % (
submission.assessed.principal.short_name,
submission.assessed.principal.display_name)
print >>f, "Submitter: %s (%s)" % (
submission.submitter.short_name,
submission.submitter.display_name)
print >>f, "Date: %s" % (
submission.date_submitted.strftime("%Y-%m-%d %H:%M:%S"))
print >>f, "SVN Revision: %s" % submission.revision
print >>f, "SVN Path: %s" % submission.path
def main(argv=None):
global store
if argv is None:
argv = sys.argv
usage = """usage: %prog [options] subject projname
(requires root)
Retrieves all submissions for a given project. Places each submission in
its own directory, in a subdirectory of '.'. Any errors are reported to
stderr (otherwise is silent).
subject/projname is the subject/project's short name.
"""
# Parse arguments
parser = optparse.OptionParser(usage)
parser.add_option("-s", "--semester",
action="store", dest="semester", metavar="YEAR/SEMESTER",
help="Semester of the subject's offering (eg. 2009/1). "
"Defaults to the currently active semester.",
default=None)
parser.add_option("-d", "--dest",
action="store", dest="dest", metavar="PATH",
help="Destination directory (default to '.', creates a subdirectory, "
"so will not pollute PATH).",
default=".")
parser.add_option("-z", "--zip",
action="store_true", dest="zip",
help="Store each submission in a Zip file.",
default=False)
parser.add_option("-v", "--verbose",
action="store_true", dest="verbose",
help="Print out the name of each submission as it is extracted.",
default=False)
parser.add_option("--no-txt",
action="store_false", dest="txt",
help="Disable writing a text file with data about each submission.",
default=True)
(options, args) = parser.parse_args(argv[1:])
if len(args) < 2:
parser.print_help()
parser.exit()
subject_name = unicode(args[0])
project_name = unicode(args[1])
if options.semester is None:
year, semester = None, None
else:
try:
year, semester = options.semester.split('/')
if len(year) == 0 or len(semester) == 0:
raise ValueError()
except ValueError:
parser.error('Invalid semester (must have form "year/semester")')
svnclient = pysvn.Client()
config = ivle.config.Config(plugins=False)
store = ivle.database.get_store(config)
# Get the subject from the DB
subject = store.find(Subject,
Subject.short_name == subject_name).one()
if subject is None:
print >>sys.stderr, "No subject with short name '%s'" % subject_name
return 1
# Get the offering from the DB
if semester is None:
# None specified - get the current offering from the DB
offerings = list(subject.active_offerings())
if len(offerings) == 0:
print >>sys.stderr, ("No active offering for subject '%s'"
% subject_name)
return 1
elif len(offerings) > 1:
print >>sys.stderr, ("Multiple active offerings for subject '%s':"
% subject_name)
print >>sys.stderr, "Please use one of:"
for offering in offerings:
print >>sys.stderr, (" --semester=%s/%s"
% (offering.semester.year, offering.semester.semester))
return 1
else:
offering = offerings[0]
else:
# Get the offering for the specified semester
offering = subject.offering_for_semester(year, semester)
if offering is None:
print >>sys.stderr, (
"No offering for subject '%s' in semester %s/%s"
% (subject_name, year, semester))
return 1
# Get the project from the DB
project = store.find(Project,
Project.project_set_id == ProjectSet.id,
ProjectSet.offering == offering,
Project.short_name == project_name).one()
if project is None:
print >>sys.stderr, "No project with short name '%s'" % project_name
return 1
# Target directory is DEST/subject/year/semester/project
target_dir = os.path.join(options.dest, subject_name,
offering.semester.year, offering.semester.semester, project_name)
if not os.path.exists(target_dir):
os.makedirs(target_dir)
for submission in project.latest_submissions:
try:
fetch_submission(submission, target_dir, svnclient, config,
zip=options.zip, txt=options.txt,
verbose=options.verbose)
except Exception, e:
# Catch all exceptions (to ensure if one student has a problem, it
# is reported, and we can continue)
print >>sys.stderr, "ERROR on submission for %s:" % (
submission.assessed.principal.display_name)
traceback.print_exc()
if __name__ == "__main__":
sys.exit(main(sys.argv))
|