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. Only one file may be
108
# action=svnpublish: Set the "published" flag on a file to True.
109
# path: The path to the file to be published. Can be specified
112
# action=svnunpublish: Set the "published" flag on a file to False.
113
# path: The path to the file to be unpublished. Can be specified
116
# action=svncommit: Commit a file(s) or directory(s) to the repository.
117
# path: The path to the file or directory to be committed. Can be
118
# specified multiple times. Directories are committed
120
# logmsg: Text of the log message. Optional. There is a default log
121
# message if unspecified.
123
# TODO: Implement the following actions:
124
# putfiles, svnrevert, svnupdate, svncommit
125
# TODO: Implement ZIP unpacking in putfile and putfiles.
126
# TODO: svnupdate needs a digest to tell the user the files that were updated.
127
# This can be implemented by some message passing between action and
128
# listing, and having the digest included in the listing. (Problem if
129
# the listing is not a directory, but we could make it an error to do an
130
# update if the path is not a directory).
137
from common import (util, studpath)
139
# Make a Subversion client object
140
svnclient = pysvn.Client()
142
DEFAULT_LOGMESSAGE = "No log message supplied."
145
# application/json is the "best" content type but is not good for
146
# debugging because Firefox just tries to download it
147
mime_dirlisting = "text/html"
148
#mime_dirlisting = "application/json"
150
class ActionError(Exception):
151
"""Represents an error processing an action. This can be
152
raised by any of the action functions, and will be caught
153
by the top-level handler, put into the HTTP response field,
156
Important Security Consideration: The message passed to this
157
exception will be relayed to the client.
161
def handle_action(req, action, fields):
162
"""Perform the "action" part of the response.
163
This function should only be called if the response is a POST.
164
This performs the action's side-effect on the server. If unsuccessful,
165
writes the X-IVLE-Action-Error header to the request object. Otherwise,
166
does not touch the request object. Does NOT write any bytes in response.
168
May throw an ActionError. The caller should put this string into the
169
X-IVLE-Action-Error header, and then continue normally.
171
action: String, the action requested. Not sanitised.
172
fields: FieldStorage object containing all arguments passed.
174
global actions_table # Table of function objects
176
action = actions_table[action]
178
# Default, just send an error but then continue
179
raise ActionError("Unknown action")
182
def actionpath_to_local(req, path):
183
"""Determines the local path upon which an action is intended to act.
184
Note that fileservice actions accept two paths: the request path,
185
and the "path" argument given to the action.
186
According to the rules, if the "path" argument begins with a '/' it is
187
relative to the user's home; if it does not, it is relative to the
190
This resolves the path, given the request and path argument.
192
May raise an ActionError("Invalid path"). The caller is expected to
193
let this fall through to the top-level handler, where it will be
194
put into the HTTP response field. Never returns None.
200
elif len(path) > 0 and path[0] == os.sep:
201
# Relative to student home
204
# Relative to req.path
205
path = os.path.join(req.path, path)
207
_, r = studpath.url_to_local(path)
209
raise ActionError("Invalid path")
212
def movefile(req, frompath, topath, copy=False):
213
"""Performs a file move, resolving filenames, checking for any errors,
214
and throwing ActionErrors if necessary. Can also be used to do a copy
217
frompath and topath are straight paths from the client. Will be checked.
219
# TODO: Do an SVN mv if the file is versioned.
220
# TODO: Disallow tampering with student's home directory
221
if frompath is None or topath is None:
222
raise ActionError("Required field missing")
223
frompath = actionpath_to_local(req, frompath)
224
topath = actionpath_to_local(req, topath)
225
if not os.path.exists(frompath):
226
raise ActionError("The source file does not exist")
227
if os.path.exists(topath):
228
if frompath == topath:
229
raise ActionError("Source and destination are the same")
230
raise ActionError("Another file already exists with that name")
234
if os.path.isdir(frompath):
235
shutil.copytree(frompath, topath)
237
shutil.copy2(frompath, topath)
239
shutil.move(frompath, topath)
241
raise ActionError("Could not move the file specified")
243
raise ActionError("Could not move the file specified")
247
def action_remove(req, fields):
248
# TODO: Do an SVN rm if the file is versioned.
249
# TODO: Disallow removal of student's home directory
250
"""Removes a list of files or directories.
252
Reads fields: 'path' (multiple)
254
paths = fields.getlist('path')
257
path = actionpath_to_local(req, path)
259
if os.path.isdir(path):
269
raise ActionError("Could not delete the file specified")
272
"Could not delete one or more of the files specified")
274
def action_move(req, fields):
275
# TODO: Do an SVN mv if the file is versioned.
276
# TODO: Disallow tampering with student's home directory
277
"""Removes a list of files or directories.
279
Reads fields: 'from', 'to'
281
frompath = fields.getfirst('from')
282
topath = fields.getfirst('to')
283
movefile(req, frompath, topath)
285
def action_putfile(req, fields):
286
"""Writes data to a file, overwriting it if it exists and creating it if
289
Reads fields: 'path', 'data' (file upload)
291
# Important: Data is "None" if the file submitted is empty.
292
path = fields.getfirst('path')
293
data = fields.getfirst('data')
295
raise ActionError("Required field missing")
296
path = actionpath_to_local(req, path)
300
# Copy the contents of file object 'data' to the path 'path'
302
dest = open(path, 'wb')
304
shutil.copyfileobj(data, dest)
306
raise ActionError("Could not write to target file")
308
def action_copy_or_cut(req, fields, mode):
309
"""Marks specified files on the clipboard, stored in the
310
browser session. Sets clipboard for either a cut or copy operation
315
# The clipboard object created conforms to the JSON clipboard
316
# specification given at the top of listing.py.
317
# Note that we do not check for the existence of files here. That is done
318
# in the paste operation.
319
files = fields.getlist('path')
320
files = map(lambda field: field.value, files)
321
clipboard = { "mode" : mode, "base" : req.path, "files" : files }
322
session = req.get_session()
323
session['clipboard'] = clipboard
326
def action_copy(req, fields):
327
"""Marks specified files on the clipboard, stored in the
328
browser session. Sets clipboard for a "copy" action.
332
action_copy_or_cut(req, fields, "copy")
334
def action_cut(req, fields):
335
"""Marks specified files on the clipboard, stored in the
336
browser session. Sets clipboard for a "cut" action.
340
action_copy_or_cut(req, fields, "cut")
342
def action_paste(req, fields):
343
"""Performs the copy or move action with the files stored on
344
the clipboard in the browser session. Copies/moves the files
345
to the specified directory. Clears the clipboard.
351
todir = fields.getfirst('path')
353
raise ActionError("Required field missing")
354
todir_local = actionpath_to_local(req, todir)
355
if not os.path.isdir(todir_local):
356
raise ActionError("Target is not a directory")
358
session = req.get_session()
360
clipboard = session['clipboard']
361
files = clipboard['files']
362
base = clipboard['base']
363
if clipboard['mode'] == "copy":
368
raise ActionError("Clipboard was empty")
372
# The source must not be interpreted as relative to req.path
373
# Add a slash (relative to top-level)
374
frompath = os.sep + os.path.join(base, file)
375
# The destination is found by taking just the basename of the file
376
topath = os.path.join(todir, os.path.basename(file))
378
movefile(req, frompath, topath, copy)
379
except ActionError, message:
380
# Store the error for later; we want to copy as many as possible
384
# Multiple errors; generic message
385
errormsg = "One or more files could not be pasted"
386
# Add this file to errorfiles; it will be put back on the
387
# clipboard for possible future pasting.
388
errorfiles.append(file)
389
# If errors occured, augment the clipboard and raise ActionError
390
if len(errorfiles) > 0:
391
clipboard['files'] = errorfiles
392
session['clipboard'] = clipboard
394
raise ActionError(errormsg)
396
# Success: Clear the clipboard
397
del session['clipboard']
400
def action_svnadd(req, fields):
401
"""Performs a "svn add" to each file specified.
403
Reads fields: 'path' (multiple)
405
paths = fields.getlist('path')
406
paths = map(lambda path: actionpath_to_local(req, path), paths)
409
svnclient.add(paths, recurse=True, force=True)
410
except pysvn.ClientError:
411
raise ActionError("One or more files could not be added")
413
def action_svnupdate(req, fields):
414
"""Performs a "svn update" to each file specified.
418
path = fields.getfirst('path')
420
raise ActionError("Required field missing")
421
path = actionpath_to_local(req, path)
424
svnclient.update(path, recurse=True)
425
except pysvn.ClientError:
426
raise ActionError("One or more files could not be updated")
428
def action_svnrevert(req, fields):
429
"""Performs a "svn revert" to each file specified.
431
Reads fields: 'path' (multiple)
433
paths = fields.getlist('path')
434
paths = map(lambda path: actionpath_to_local(req, path), paths)
437
svnclient.revert(paths, recurse=True)
438
except pysvn.ClientError:
439
raise ActionError("One or more files could not be reverted")
441
def action_svnpublish(req, fields):
442
"""Sets svn property "ivle:published" on each file specified.
443
Should only be called on directories (only effective on directories
448
paths = fields.getlist('path')
449
paths = map(lambda path: actionpath_to_local(req, path), paths)
453
# Note: Property value doesn't matter
454
svnclient.propset("ivle:published", "", path, recurse=False)
455
except pysvn.ClientError:
456
raise ActionError("One or more files could not be updated")
458
def action_svnunpublish(req, fields):
459
"""Deletes svn property "ivle:published" on each file specified.
463
paths = fields.getlist('path')
464
paths = map(lambda path: actionpath_to_local(req, path), paths)
468
svnclient.propdel("ivle:published", path, recurse=False)
469
except pysvn.ClientError:
470
raise ActionError("One or more files could not be updated")
472
def action_svncommit(req, fields):
473
"""Performs a "svn commit" to each file specified.
475
Reads fields: 'path' (multiple), 'logmsg' (optional)
477
paths = fields.getlist('path')
478
paths = map(lambda path: actionpath_to_local(req, str(path)), paths)
479
logmsg = str(fields.getfirst('logmsg', DEFAULT_LOGMESSAGE))
480
if logmsg == '': logmsg = DEFAULT_LOGMESSAGE
483
svnclient.checkin(paths, logmsg, recurse=True)
484
except pysvn.ClientError:
485
raise ActionError("One or more files could not be committed")
487
# Table of all action functions #
488
# Each function has the interface f(req, fields).
491
"remove" : action_remove,
492
"move" : action_move,
493
"putfile" : action_putfile,
495
"copy" : action_copy,
497
"paste" : action_paste,
499
"svnadd" : action_svnadd,
500
"svnupdate" : action_svnupdate,
501
"svnrevert" : action_svnrevert,
502
"svnpublish" : action_svnpublish,
503
"svnunpublish" : action_svnunpublish,
504
"svncommit" : action_svncommit,
added
removed
www/apps/fileservice/action.py
