243
by mattgiuca
Added common/zip.py. Creates a zip file from paths in the student directory. |
1 |
# IVLE - Informatics Virtual Learning Environment
|
2 |
# Copyright (C) 2007-2008 The University of Melbourne
|
|
3 |
#
|
|
4 |
# This program is free software; you can redistribute it and/or modify
|
|
5 |
# it under the terms of the GNU General Public License as published by
|
|
6 |
# the Free Software Foundation; either version 2 of the License, or
|
|
7 |
# (at your option) any later version.
|
|
8 |
#
|
|
9 |
# This program is distributed in the hope that it will be useful,
|
|
10 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
11 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
12 |
# GNU General Public License for more details.
|
|
13 |
#
|
|
14 |
# You should have received a copy of the GNU General Public License
|
|
15 |
# along with this program; if not, write to the Free Software
|
|
16 |
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
17 |
||
18 |
# Module: common.zip
|
|
19 |
# Author: Matt Giuca
|
|
20 |
# Date: 17/1/2008
|
|
21 |
||
22 |
# ZIP function wrappers. Provides easy methods for reading and writing zip
|
|
23 |
# files for the purpose of the IVLE file browser.
|
|
24 |
||
25 |
import os |
|
26 |
import os.path |
|
27 |
import zipfile |
|
28 |
||
29 |
from common import studpath |
|
30 |
||
31 |
def make_zip(basepath, paths, file, req): |
|
32 |
"""Zips up a bunch of files on the student file space and writes it as
|
|
33 |
a zip file.
|
|
34 |
||
35 |
basepath: Path relative to student home. All file paths will be made
|
|
36 |
relative to this path, such that unzipping the file in this path will
|
|
37 |
place the files back in their original places.
|
|
38 |
paths: List of paths relative to basepath. These are the files to be
|
|
39 |
zipped. All paths must be relative.
|
|
40 |
file: Either a filename to write to, or a file-like object.
|
|
41 |
||
42 |
Throws an OSError if one or more of the files cannot be read. This error
|
|
43 |
will be thrown before any writing takes place.
|
|
44 |
"""
|
|
45 |
# First make sure all the files are valid
|
|
46 |
newpaths = [] # Store tuples of (path, localpath) |
|
47 |
for path in paths: |
|
48 |
if len(path) == 0 or path[0] == os.sep: |
|
49 |
raise OSError("ZIP: Invalid path") |
|
50 |
else: |
|
51 |
# Relative to req.path
|
|
52 |
relpath = os.path.join(basepath, path) |
|
53 |
||
54 |
_, r = studpath.url_to_local(relpath) |
|
55 |
if r is None: |
|
56 |
raise OSError("ZIP: Invalid path") |
|
57 |
if not os.access(r, os.R_OK): |
|
58 |
raise OSError("ZIP: Could not access a file") |
|
59 |
newpaths.append((path, r)) |
|
60 |
||
61 |
# Now open the zip file and write each path to it
|
|
62 |
zip = zipfile.ZipFile(file, 'w') |
|
63 |
||
64 |
for (path, localpath) in newpaths: |
|
65 |
if os.path.isdir(localpath): |
|
66 |
# Walk the directory tree
|
|
67 |
if len(localpath) > 0 and localpath[-1] != os.sep: |
|
68 |
localpath += os.sep |
|
69 |
def error(err): |
|
70 |
raise OSError("ZIP: Could not access a file") |
|
71 |
for (dirpath, dirnames, filenames) in \ |
|
72 |
os.walk(localpath, onerror=error): |
|
73 |
# Do not traverse into .svn directories
|
|
74 |
try: |
|
75 |
dirnames.remove(".svn") |
|
76 |
except ValueError: |
|
77 |
pass
|
|
78 |
# dirpath is local. Make arc_dirpath, relative to root
|
|
79 |
arc_dirpath = os.path.join(path, dirpath[len(localpath):]) |
|
80 |
for filename in filenames: |
|
81 |
zip.write(os.path.join(dirpath, filename), |
|
82 |
os.path.join(arc_dirpath, filename)) |
|
83 |
else: |
|
84 |
zip.write(localpath, path) |
|
85 |
||
86 |
zip.close() |