← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to src/common/interpret.py

  • Committer: mattgiuca
  • Date: 2007-12-20 01:47:43 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:91
common/studpath.py: url_to_jailpaths - The "jail" path returned is now
    absolute instead of relative to the common jails dir.
    Reason: Much less specific to our system and easier to check that it's in
    the correct directory than explain all over the place what the jails root
    is.
common/interpret.py: Updated comments to the above effect.
trampolines: Accept absolute jails and check their root instead of doing a
    path join.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/common/interpret.py
 
1
# IVLE
 
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: Interpret
 
19
# Author: Matt Giuca
 
20
# Date: 20/12/2007
 
21
 
 
22
# Runs a student script in a safe execution environment.
 
23
 
 
24
from common import studpath
 
25
import conf
 
26
import functools
 
27
 
 
28
import os
 
29
import pwd
 
30
import subprocess
 
31
 
 
32
def interpret_file(req, owner, filename, interpreter):
 
33
    """Serves a file by interpreting it using one of IVLE's builtin
 
34
    interpreters. All interpreters are intended to run in the user's jail. The
 
35
    jail location is provided as an argument to the interpreter but it is up
 
36
    to the individual interpreters to create the jail.
 
37
 
 
38
    req: An IVLE request object.
 
39
    owner: Username of the user who owns the file being served.
 
40
    filename: Filename in the local file system.
 
41
    interpreter: A function object to call.
 
42
    """
 
43
    # Make sure the file exists (otherwise some interpreters may not actually
 
44
    # complain).
 
45
    # Don't test for execute permission, that will only be required for
 
46
    # certain interpreters.
 
47
    if not os.access(filename, os.R_OK):
 
48
        req.throw_error(req.HTTP_NOT_FOUND)
 
49
 
 
50
    # Get the UID of the owner of the file
 
51
    # (Note: files are executed by their owners, not the logged in user.
 
52
    # This ensures users are responsible for their own programs and also
 
53
    # allows them to be executed by the public).
 
54
    try:
 
55
        (_,_,uid,_,_,_,_) = pwd.getpwnam(owner)
 
56
    except KeyError:
 
57
        # The user does not exist. This should have already failed the
 
58
        # previous test.
 
59
        req.throw_error(req.HTTP_INTERNAL_SERVER_ERROR)
 
60
 
 
61
    # Split up req.path again, this time with respect to the jail
 
62
    (_, jail_dir, path) = studpath.url_to_jailpaths(req.path)
 
63
    path = os.path.join('/', path)
 
64
    (working_dir, _) = os.path.split(path)
 
65
    # jail_dir is the absolute jail directory.
 
66
    # path is the filename relative to the user's jail.
 
67
    # working_dir is the directory containing the file relative to the user's
 
68
    # jail.
 
69
    # (Note that paths "relative" to the jail actually begin with a '/' as
 
70
    # they are absolute in the jailspace)
 
71
 
 
72
    return interpreter(uid, jail_dir, working_dir, path, req)
 
73
 
 
74
# Used to store mutable data
 
75
class Dummy:
 
76
    pass
 
77
 
 
78
def execute_cgi(trampoline, uid, jail_dir, working_dir, script_path, req):
 
79
    """
 
80
    trampoline: Full path on the local system to the CGI wrapper program
 
81
        being executed.
 
82
    uid: User ID of the owner of the file.
 
83
    jail_dir: Absolute path of owner's jail directory.
 
84
    working_dir: Directory containing the script file relative to owner's
 
85
        jail.
 
86
    script_path: CGI script relative to the owner's jail.
 
87
    req: IVLE request object.
 
88
 
 
89
    The called CGI wrapper application shall be called using popen and receive
 
90
    the HTTP body on stdin. It shall receive the CGI environment variables to
 
91
    its environment.
 
92
    """
 
93
 
 
94
    # Get the student program's directory and execute it from that context.
 
95
    (tramp_dir, _) = os.path.split(trampoline)
 
96
 
 
97
    # TODO: Don't create a file if the body length is known to be 0
 
98
    # Write the HTTP body to a temporary file so it can be passed as a *real*
 
99
    # file to popen.
 
100
    f = os.tmpfile()
 
101
    body = req.read()
 
102
    if body is not None:
 
103
        f.write(body)
 
104
        f.flush()
 
105
        f.seek(0)       # Rewind, for reading
 
106
 
 
107
    # usage: tramp uid jail_dir working_dir script_path
 
108
    pid = subprocess.Popen(
 
109
        [trampoline, str(uid), jail_dir, working_dir, script_path],
 
110
        stdin=f, stdout=subprocess.PIPE, cwd=tramp_dir)
 
111
 
 
112
    # process_cgi_line: Reads a single line of CGI output and processes it.
 
113
    # Prints to req, and also does fancy HTML warnings if Content-Type
 
114
    # omitted.
 
115
    cgiflags = Dummy()
 
116
    cgiflags.got_cgi_header = False
 
117
    cgiflags.started_cgi_body = False
 
118
    cgiflags.wrote_html_warning = False
 
119
    def process_cgi_line(line):
 
120
        # FIXME? Issue with binary files (processing per-line?)
 
121
        if cgiflags.started_cgi_body:
 
122
            # FIXME: HTML escape text if wrote_html_warning
 
123
            req.write(line)
 
124
        else:
 
125
            # Read CGI headers
 
126
            if line.strip() == "" and cgiflags.got_cgi_header:
 
127
                cgiflags.started_cgi_body = True
 
128
            elif line.startswith("Content-Type:"):
 
129
                req.content_type = line[13:].strip()
 
130
                cgiflags.got_cgi_header = True
 
131
            elif line.startswith("Location:"):
 
132
                # TODO
 
133
                cgiflags.got_cgi_header = True
 
134
            elif line.startswith("Status:"):
 
135
                # TODO
 
136
                cgiflags.got_cgi_header = True
 
137
            elif cgiflags.got_cgi_header:
 
138
                # Invalid header
 
139
                # TODO
 
140
                req.write("Invalid header")
 
141
                pass
 
142
            else:
 
143
                # Assume the user is not printing headers and give a warning
 
144
                # about that.
 
145
                # User program did not print header.
 
146
                # Make a fancy HTML warning for them.
 
147
                req.content_type = "text/html"
 
148
                req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 
149
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
150
<html xmlns="http://www.w3.org/1999/xhtml">
 
151
<head>
 
152
  <meta http-equiv="Content-Type"
 
153
    content="text/html; charset=utf-8" />
 
154
</head>
 
155
<body style="margin: 0; padding: 0; font-family: sans;">
 
156
  <div style="background-color: #faa; border-bottom: 1px solid black;
 
157
    padding: 8px;">
 
158
    <p><strong>Warning</strong>: You did not print a "Content-Type" header.
 
159
    CGI requires you to print some content type. You may wish to try:</p>
 
160
    <pre style="margin-left: 1em">Content-Type: text/html</pre>
 
161
  </div>
 
162
  <div style="margin: 8px;">
 
163
    <pre>
 
164
""")
 
165
                cgiflags.got_cgi_header = True
 
166
                cgiflags.wrote_html_warning = True
 
167
                cgiflags.started_cgi_body = True
 
168
                req.write(line)
 
169
 
 
170
    # Read from the process's stdout into req
 
171
    for line in pid.stdout:
 
172
        process_cgi_line(line)
 
173
 
 
174
    # If we wrote an HTML warning header, write the footer
 
175
    if cgiflags.wrote_html_warning:
 
176
        req.write("""</pre>
 
177
  </div>
 
178
</body>
 
179
</html>""")
 
180
 
 
181
# TODO: Replace mytest with cgi trampoline handler script
 
182
location_cgi_python = os.path.join(conf.ivlepath, "bin/trampoline-python")
 
183
 
 
184
# Mapping of interpreter names (as given in conf/app/server.py) to
 
185
# interpreter functions.
 
186
 
 
187
interpreter_objects = {
 
188
    'cgi-python'
 
189
        : functools.partial(execute_cgi, location_cgi_python),
 
190
    # Should also have:
 
191
    # cgi-generic
 
192
    # python-server-page
 
193
}
 
194