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
# App: File Service (AJAX server)
22
# This application is an AJAX service. Receives file handling instructions as
23
# requests. Performs actions on the student's workspace, and returns directory
26
# This rather large documentation explains the request and response to the
27
# file service app (it should probably be taken to a separate document).
29
# This is not intended to be accessed directly by the user. It is targeted by
30
# AJAX calls in applications such as browser and editor.
32
# Application usage: The input to the application is determined by the fields
33
# passed in as HTTP variables (either in the URL or message body). Also, in
34
# keeping with REST, actions only take effect if this is a POST request as
35
# opposed to a GET request (although a GET request is still allowed to just
36
# get a listing or file dump). Also, the "path" (the part of the URL
37
# after "fileservice" and before the GET variables) is taken into account.
39
# Aside from the side-effects to the server (note: side-effects are only
40
# possible for POST requests), the response takes two parts. The response
41
# header contains information about success or failure of the operation. The
42
# response body may contain the requested file.
44
# Fileservice has two separate roles: First, an action is performed. This may
45
# be a copy, write, or svn up operation. Then, either a directory listing or
46
# file contents are returned.
47
# This listing/contents may be completely separate from the action,
48
# but they are performed together because the client will usually want to
49
# perform some action, then update its display as a result of the action.
51
# The special "return" variable can be "listing" or "contents" - listing is
52
# the default if unspecified. If "listing", it will return a directory listing
53
# of the file specified. If the file is not a directory, it just returns a
54
# single "." object, with details about the file.
55
# If "contents", it will return the contents of the file specified. If the
56
# file is a directory, it will simply return the listing again.
58
# GET requests will have all variables other than "return" ignored, and the
59
# only behaviour will be to generate the directory or file listing. POST
60
# requests will result in an action if one is specified. If the action is
61
# UNSUCCESSFUL, returns the header "X-IVLE-Action-Error: <errormessage>".
62
# Successful actions succeed silently. Note that the action does not affect
63
# the HTTP response code (it may be 200 even upon failure).
65
# The path (req.path) controls which file or directory will be
66
# returned. If it is a file, returns the header "X-IVLE-Return: File" and
67
# status 200 OK. The response body is either a verbatim dump of the file
68
# specified, or a single-file directory listing, as described above.
69
# The Content-Type will probably be text/plain but should not be relied upon.
70
# If it is a directory, returns the header "X-IVLE-Return: Dir" and status
71
# 200 OK. The response body is a JSON directory listing (see below). The
72
# Content-Type cannot be relied upon. If the file is not found or there is
73
# some other read error, returns no X-IVLE-Return header, a 400-level
74
# response status. (404 File Not Found, 403 Forbidden, etc), and a header
75
# "X-IVLE-Return-Error: <errormessage>".
77
# See action.py for a full description of the actions.
78
# See listing.py for a full description of the output format of the directory
91
from ivle import (util, studpath)
93
import action, listing
96
# application/json is the "best" content type but is not good for
97
# debugging because Firefox just tries to download it
98
mime_dirlisting = "text/html"
99
#mime_dirlisting = "application/json"
102
"""Handler for the File Services application."""
103
# Make sure the logged in user has permission to see this file
104
# FIXME: Still need to authorize subpaths in actions
105
#studpath.authorize(req)
107
# Set request attributes
108
req.write_html_head_foot = False # No HTML
110
# We really, really don't want the responses to be cached.
111
req.headers_out['Cache-Control'] = 'no-store, must-revalidate'
113
# Get all the arguments, if POST.
114
# Ignore arguments if not POST, since we aren't allowed to cause
115
# side-effects on the server.
117
fields = req.get_fieldstorage()
118
if req.method == 'POST':
119
act = fields.getfirst('action')
123
action.handle_action(req, act, fields)
124
except action.ActionError, message:
125
req.headers_out['X-IVLE-Action-Error'] = \
126
urllib.quote(str(message))
128
return_type = fields.getfirst('return')
129
listing.handle_return(req, return_type == "contents")
added
removed
ivle/fileservice_lib/__init__.py
