2
# Copyright (C) 2007-2008 The University of Melbourne
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.
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.
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
18
# Module: File Service / Action
22
# Handles actions requested by the client as part of the 2-stage process of
23
# fileservice (the second part being the return listing).
27
# The most important argument is "action". This determines which action is
28
# taken. Note that action, and all other arguments, are ignored unless the
29
# request is a POST request. The other arguments depend upon the action.
30
# Note that paths are often specified as arguments. Paths that begin with a
31
# slash are taken relative to the user's home directory (the top-level
32
# directory seen when fileservice has no arguments or path). Paths without a
33
# slash are taken relative to the specified path.
35
# action=remove: Delete a file(s) or directory(s) (recursively).
36
# path: The path to the file or directory to delete. Can be specified
39
# action=move: Move or rename a file or directory.
40
# from: The path to the file or directory to be renamed.
41
# to: The path of the target filename. Error if the file already
44
# action=putfile: Upload a file to the student workspace, and optionally
45
# accept zip files which will be unpacked.
46
# path: The path to the file to be written. If it exists, will
47
# overwrite. Error if the target file is a directory.
48
# data: Bytes to be written to the file verbatim. May either be
49
# a string variable or a file upload.
50
# unpack: Optional. If "true", and the data is a valid ZIP file,
51
# will create a directory instead and unpack the ZIP file
54
# action=putfiles: Upload multiple files to the student workspace, and
55
# optionally accept zip files which will be unpacked.
56
# path: The path to the DIRECTORY to place files in. Must not be a
58
# data: A file upload (may not be a simple string). The filename
59
# will be used to determine the target filename within
61
# unpack: Optional. If "true", if any data is a valid ZIP file,
62
# will create a directory instead and unpack the ZIP file
65
# The differences between putfile and putfiles are:
66
# * putfile can only accept a single file.
67
# * putfile can accept string data, doesn't have to be a file upload.
68
# * putfile ignores the upload filename, the entire filename is specified on
69
# path. putfiles calls files after the name on the user's machine.
71
# Clipboard-based actions. Cut/copy/paste work in the same way as modern
72
# file browsers, by keeping a server-side clipboard of files that have been
73
# cut and copied. The clipboard is stored in the session data, so it persists
74
# across navigation, tabs and browser windows, but not across browser
77
# action=copy: Write file(s) to the session-based clipboard. Overrides any
78
# existing clipboard data. Does not actually copy the file.
79
# The files are physically copied when the clipboard is pasted.
80
# path: The path to the file or directory to copy. Can be specified
83
# action=cut: Write file(s) to the session-based clipboard. Overrides any
84
# existing clipboard data. Does not actually move the file.
85
# The files are physically moved when the clipboard is pasted.
86
# path: The path to the file or directory to cut. Can be specified
89
# action=paste: Copy or move the files stored in the clipboard. Clears the
90
# clipboard. The files are copied or moved to a specified dir.
91
# path: The path to the DIRECTORY to paste the files to. Must not
95
# action=svnadd: Add an existing file(s) to version control.
96
# path: The path to the file to be added. Can be specified multiple
99
# action=svnrevert: Revert a file(s) to its state as of the current revision
100
# / undo local edits.
101
# path: The path to the file to be reverted. Can be specified multiple
104
# action=svnupdate: Bring a file up to date with the head revision.
105
# path: The path to the file to be updated. Can be specified multiple
108
# action=svncommit: Commit a file(s) or directory(s) to the repository.
109
# path: The path to the file or directory to be committed. Can be
110
# specified multiple times. Directories are committed
112
# logmsg: Text of the log message. Optional. There is a default log
113
# message if unspecified.
115
# TODO: Implement the following actions:
116
# putfiles, svnrevert, svnupdate, svncommit
117
# TODO: Implement ZIP unpacking in putfile and putfiles.
118
# TODO: svnupdate needs a digest to tell the user the files that were updated.
119
# This can be implemented by some message passing between action and
120
# listing, and having the digest included in the listing. (Problem if
121
# the listing is not a directory, but we could make it an error to do an
122
# update if the path is not a directory).
129
from common import (util, studpath)
131
# Make a Subversion client object
132
svnclient = pysvn.Client()
134
DEFAULT_LOGMESSAGE = "No log message supplied."
137
# application/json is the "best" content type but is not good for
138
# debugging because Firefox just tries to download it
139
mime_dirlisting = "text/html"
140
#mime_dirlisting = "application/json"
142
class ActionError(Exception):
143
"""Represents an error processing an action. This can be
144
raised by any of the action functions, and will be caught
145
by the top-level handler, put into the HTTP response field,
148
Important Security Consideration: The message passed to this
149
exception will be relayed to the client.
153
def handle_action(req, action, fields):
154
"""Perform the "action" part of the response.
155
This function should only be called if the response is a POST.
156
This performs the action's side-effect on the server. If unsuccessful,
157
writes the X-IVLE-Action-Error header to the request object. Otherwise,
158
does not touch the request object. Does NOT write any bytes in response.
160
May throw an ActionError. The caller should put this string into the
161
X-IVLE-Action-Error header, and then continue normally.
163
action: String, the action requested. Not sanitised.
164
fields: FieldStorage object containing all arguments passed.
166
global actions_table # Table of function objects
168
action = actions_table[action]
170
# Default, just send an error but then continue
171
raise ActionError("Unknown action")
174
def actionpath_to_local(req, path):
175
"""Determines the local path upon which an action is intended to act.
176
Note that fileservice actions accept two paths: the request path,
177
and the "path" argument given to the action.
178
According to the rules, if the "path" argument begins with a '/' it is
179
relative to the user's home; if it does not, it is relative to the
182
This resolves the path, given the request and path argument.
184
May raise an ActionError("Invalid path"). The caller is expected to
185
let this fall through to the top-level handler, where it will be
186
put into the HTTP response field. Never returns None.
192
elif len(path) > 0 and path[0] == os.sep:
193
# Relative to student home
196
# Relative to req.path
197
path = os.path.join(req.path, path)
199
_, r = studpath.url_to_local(path)
201
raise ActionError("Invalid path")
204
def movefile(req, frompath, topath, copy=False):
205
"""Performs a file move, resolving filenames, checking for any errors,
206
and throwing ActionErrors if necessary. Can also be used to do a copy
209
frompath and topath are straight paths from the client. Will be checked.
211
# TODO: Do an SVN mv if the file is versioned.
212
# TODO: Disallow tampering with student's home directory
213
if frompath is None or topath is None:
214
raise ActionError("Required field missing")
215
frompath = actionpath_to_local(req, frompath)
216
topath = actionpath_to_local(req, topath)
217
if not os.path.exists(frompath):
218
raise ActionError("The source file does not exist")
219
if os.path.exists(topath):
220
if frompath == topath:
221
raise ActionError("Source and destination are the same")
222
raise ActionError("Another file already exists with that name")
226
if os.path.isdir(frompath):
227
shutil.copytree(frompath, topath)
229
shutil.copy2(frompath, topath)
231
shutil.move(frompath, topath)
233
raise ActionError("Could not move the file specified")
235
raise ActionError("Could not move the file specified")
239
def action_remove(req, fields):
240
# TODO: Do an SVN rm if the file is versioned.
241
# TODO: Disallow removal of student's home directory
242
"""Removes a list of files or directories.
244
Reads fields: 'path' (multiple)
246
paths = fields.getlist('path')
249
path = actionpath_to_local(req, path)
251
if os.path.isdir(path):
261
raise ActionError("Could not delete the file specified")
264
"Could not delete one or more of the files specified")
266
def action_move(req, fields):
267
# TODO: Do an SVN mv if the file is versioned.
268
# TODO: Disallow tampering with student's home directory
269
"""Removes a list of files or directories.
271
Reads fields: 'from', 'to'
273
frompath = fields.getfirst('from')
274
topath = fields.getfirst('to')
275
movefile(req, frompath, topath)
277
def action_putfile(req, fields):
278
"""Writes data to a file, overwriting it if it exists and creating it if
281
Reads fields: 'path', 'data' (file upload)
283
path = fields.getfirst('path')
284
data = fields.getfirst('data')
285
if path is None or data is None:
286
raise ActionError("Required field missing")
287
path = actionpath_to_local(req, path)
290
# Copy the contents of file object 'data' to the path 'path'
292
dest = open(path, 'wb')
293
shutil.copyfileobj(data, dest)
295
raise ActionError("Could not write to target file")
297
def action_copy_or_cut(req, fields, mode):
298
"""Marks specified files on the clipboard, stored in the
299
browser session. Sets clipboard for either a cut or copy operation
304
# The clipboard object created conforms to the JSON clipboard
305
# specification given at the top of listing.py.
306
# Note that we do not check for the existence of files here. That is done
307
# in the paste operation.
308
files = fields.getlist('path')
309
files = map(lambda field: field.value, files)
310
clipboard = { "mode" : mode, "base" : req.path, "files" : files }
311
session = req.get_session()
312
session['clipboard'] = clipboard
315
def action_copy(req, fields):
316
"""Marks specified files on the clipboard, stored in the
317
browser session. Sets clipboard for a "copy" action.
321
action_copy_or_cut(req, fields, "copy")
323
def action_cut(req, fields):
324
"""Marks specified files on the clipboard, stored in the
325
browser session. Sets clipboard for a "cut" action.
329
action_copy_or_cut(req, fields, "cut")
331
def action_paste(req, fields):
332
"""Performs the copy or move action with the files stored on
333
the clipboard in the browser session. Copies/moves the files
334
to the specified directory. Clears the clipboard.
340
todir = fields.getfirst('path')
342
raise ActionError("Required field missing")
343
todir_local = actionpath_to_local(req, todir)
344
if not os.path.isdir(todir_local):
345
raise ActionError("Target is not a directory")
347
session = req.get_session()
349
clipboard = session['clipboard']
350
files = clipboard['files']
351
base = clipboard['base']
352
if clipboard['mode'] == "copy":
357
raise ActionError("Clipboard was empty")
361
# The source must not be interpreted as relative to req.path
362
# Add a slash (relative to top-level)
363
frompath = os.sep + os.path.join(base, file)
364
# The destination is found by taking just the basename of the file
365
topath = os.path.join(todir, os.path.basename(file))
367
movefile(req, frompath, topath, copy)
368
except ActionError, message:
369
# Store the error for later; we want to copy as many as possible
373
# Multiple errors; generic message
374
errormsg = "One or more files could not be pasted"
375
# Add this file to errorfiles; it will be put back on the
376
# clipboard for possible future pasting.
377
errorfiles.append(file)
378
# If errors occured, augment the clipboard and raise ActionError
379
if len(errorfiles) > 0:
380
clipboard['files'] = errorfiles
381
session['clipboard'] = clipboard
383
raise ActionError(errormsg)
385
# Success: Clear the clipboard
386
del session['clipboard']
389
def action_svnadd(req, fields):
390
"""Performs a "svn add" to each file specified.
392
Reads fields: 'path' (multiple)
394
paths = fields.getlist('path')
395
paths = map(lambda path: actionpath_to_local(req, path), paths)
398
svnclient.add(paths, recurse=True, force=True)
399
except pysvn.ClientError:
400
raise ActionError("One or more files could not be added")
402
def action_svnupdate(req, fields):
403
"""Performs a "svn update" to each file specified.
407
path = fields.getfirst('path')
409
raise ActionError("Required field missing")
410
path = actionpath_to_local(req, path)
413
svnclient.update(path, recurse=True)
414
except pysvn.ClientError:
415
raise ActionError("One or more files could not be updated")
417
def action_svnrevert(req, fields):
418
"""Performs a "svn revert" to each file specified.
420
Reads fields: 'path' (multiple)
422
paths = fields.getlist('path')
423
paths = map(lambda path: actionpath_to_local(req, path), paths)
426
svnclient.revert(paths, recurse=True)
427
except pysvn.ClientError:
428
raise ActionError("One or more files could not be reverted")
430
def action_svncommit(req, fields):
431
"""Performs a "svn commit" to each file specified.
433
Reads fields: 'path' (multiple), 'logmsg' (optional)
435
paths = fields.getlist('path')
436
paths = map(lambda path: actionpath_to_local(req, str(path)), paths)
437
logmsg = str(fields.getfirst('logmsg', DEFAULT_LOGMESSAGE))
438
if logmsg == '': logmsg = DEFAULT_LOGMESSAGE
441
svnclient.checkin(paths, logmsg, recurse=True)
442
except pysvn.ClientError:
443
raise ActionError("One or more files could not be committed")
445
# Table of all action functions #
446
# Each function has the interface f(req, fields).
449
"remove" : action_remove,
450
"move" : action_move,
451
"putfile" : action_putfile,
453
"copy" : action_copy,
455
"paste" : action_paste,
457
"svnadd" : action_svnadd,
458
"svnupdate" : action_svnupdate,
459
"svnrevert" : action_svnrevert,
460
"svncommit" : action_svncommit,
added
removed
www/apps/fileservice/action.py
