/usr/lib/python2.7/dist-packages/sagenb/simple/twist.py is in python-sagenb 0.13+ds1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | # -*- coding: utf-8 -*
r"""nodoctest
Simple Sage Server API
This module provides a very simple API for interacting with a Sage session
over HTTP. It runs as part of the notebook server.
.. warning::
This code currently doesn't work, since the notebook moved to a
flask-based architecture. Volunteers are welcome to port this to
the new flask notebook.
.. note::
The exact data in the JSON header may vary over time (for example,
further data may be added), but should remain backwards compatible
if it is being parsed as JSON data.
TESTS:
Here's a usage example which demonstrates all the features of this
server/API.
Start the notebook server.::
sage: from sagenb.misc.misc import find_next_available_port
sage: port = find_next_available_port(9000, verbose=False)
sage: from sagenb.notebook.notebook_object import test_notebook
sage: passwd = str(randint(1,1<<128))
sage: nb = test_notebook(passwd, secure=False, address='localhost', port=port, verbose=True)
...
Notebook started.
Now here's what you can do on the client side. Import `urllib
<http://docs.python.org/library/urllib.html>`_ and define a convenience
function::
sage: import urllib, re
sage: def get_url(url): h = urllib.urlopen(url); data = h.read(); h.close(); return data
Login to a new session::
sage: sleep(1)
sage: login_page = get_url('http://localhost:%s/simple/login?username=admin&password=%s' % (port, passwd))
sage: print login_page # random session id
{
"session": "2afee978c09b3d666c88b9b845c69608"
}
___S_A_G_E___
sage: session = re.match(r'.*"session": "([^"]*)"', login_page, re.DOTALL).groups()[0]
Run a command::
sage: sleep(0.5)
sage: print get_url('http://localhost:%s/simple/compute?session=%s&code=2*2&timeout=60' % (port, session))
{
"status": "done",
"files": [],
"cell_id": 1
}
___S_A_G_E___
4
This API returns information as a string, the first part of which is a
`JSON-encoded <http://www.json.org/>`_ dictionary. The second part --
after the separator ``___S_A_G_E___`` -- is the text of the output. To
parse output, you just need to split the string and parse the JSON data
into your local format.
Do a longer-running example::
sage: n = next_prime(10^25)*next_prime(10^30)
sage: print get_url('http://localhost:%s/simple/compute?session=%s&code=factor(%s)&timeout=0.1' % (port, session, n))
{
"status": "computing",
"files": [],
"cell_id": 2
}
___S_A_G_E___
Get the status of the computation::
sage: print get_url('http://localhost:%s/simple/status?session=%s&cell=2' % (port, session))
{
"status": "computing",
"files": [],
"cell_id": 2
}
___S_A_G_E___
Interrupt the computation::
sage: _ = get_url('http://localhost:%s/simple/interrupt?session=%s' % (port, session))
You can download files that your code creates on the remote server. Here
we write a file, and then download it to our client::
sage: code = "h = open('a.txt', 'w'); h.write('test'); h.close()"
sage: print get_url('http://localhost:%s/simple/compute?session=%s&code=%s' % (port, session, urllib.quote(code)))
{
"status": "done",
"files": ["a.txt"],
"cell_id": 3
}
___S_A_G_E___
sage: print get_url('http://localhost:%s/simple/file?session=%s&cell=3&file=a.txt' % (port, session))
test
When you are done, log out::
sage: _ = get_url('http://localhost:%s/simple/logout?session=%s' % (port, session))
sage: nb.dispose()
.. warning::
It's important that your code log out the session. Otherwise, it is
very easy to create an unintentional denial-of-service attack by
having the server accumulate a large number of idle worksheets which
consume a lot of memory and make the server unresponsive!
"""
#############################################################################
# Copyright (C) 2007 Robert Bradshaw <robertwb@math.washington.edu>
# Distributed under the terms of the GNU General Public License (GPL)
# The full text of the GPL is available at:
# http://www.gnu.org/licenses/
#############################################################################
#
# 2010 - David Poetzsch-Heffter: Fixed trac #9327
#
import re, random, os.path, shutil, time
from twisted.internet.task import LoopingCall
from twisted.python import log
from twisted.internet import defer, reactor
from twisted.cred import credentials
from twisted.web2 import server, http, resource, channel
from twisted.web2 import static, http_headers, responsecode
sessions = {}
# There must be a better way to avoid circular imports...
late_import_done = False
def late_import():
global SEP, notebook_twist, late_import_done
if not late_import_done:
from sagenb.notebook.twist import SEP
import sagenb.notebook.twist as notebook_twist
late_import_done = True
def simple_jsonize(data):
"""
This will be replaced by a JSON spkg when Python 2.6 gets into Sage.
EXAMPLES::
sage: from sagenb.simple.twist import simple_jsonize
sage: print simple_jsonize({'a': [1,2,3], 'b': "yep"})
{ "a": [1, 2, 3], "b": "yep" }
"""
if isinstance(data, dict):
values = ['"%s": %s' % (key, simple_jsonize(value)) for key, value in data.iteritems()]
return "{\n%s\n}" % ',\n'.join(values)
elif isinstance(data, (list, tuple)):
values = [simple_jsonize(value) for value in data]
return "[%s]" % ",\n".join(values)
elif isinstance(data, bool):
return str(data).lower()
elif data is None:
return "null"
else:
value = str(data)
if re.match(r'^\d+(\.\d*)?$', value):
return value
else:
return '"%s"' % value
class SessionObject:
def __init__(self, id, username, worksheet, timeout=5):
self.id = id
self.username = username
self.worksheet = worksheet
self.default_timeout = timeout
def get_status(self):
"""
Return a dictionary to be returned (in JSON format) representing
the status of self.
TEST::
sage: from sagenb.simple.twist import SessionObject
sage: s = SessionObject(id=1, username=None, worksheet=None)
sage: s.get_status()
{'session': 1}
"""
return {
'session': self.id
}
class LoginResource(resource.Resource):
def render(self, ctx):
late_import()
try:
username = ctx.args['username'][0]
password = ctx.args['password'][0]
U = notebook_twist.notebook.user(username)
if not U.password_is(password):
raise ValueError # want to return the same error message
except KeyError, ValueError:
return http.Response(stream = "Invalid login.")
worksheet = notebook_twist.notebook.create_new_worksheet("_simple_session_", username, add_to_list=False)
worksheet.sage() # create the sage session
worksheet.initialize_sage()
# is this a secure enough random number?
session_id = "%x" % random.randint(1, 1 << 128)
session = SessionObject(session_id, username, worksheet)
sessions[session_id] = session
status = session.get_status()
print ctx.args
return http.Response(stream = "%s\n%s\n" % (simple_jsonize(status), SEP))
class LogoutResource(resource.Resource):
def render(self, ctx):
try:
session = sessions[ctx.args['session'][0]]
except KeyError:
return http.Response(stream = "Invalid session.")
session.worksheet.quit()
shutil.rmtree(session.worksheet.directory())
status = session.get_status()
del sessions[ctx.args['session'][0]]
return http.Response(stream = "%s\n%s\n" % (simple_jsonize(status), SEP))
class InterruptResource(resource.Resource):
def render(self, ctx):
try:
session = sessions[ctx.args['session'][0]]
except KeyError:
return http.Response(stream = "Invalid session.")
session.worksheet.interrupt()
status = session.get_status()
return http.Response(stream = "%s\n%s\n" % (simple_jsonize(status), SEP))
class RestartResource(resource.Resource):
def render(self, ctx):
try:
session = sessions[ctx.args['session'][0]]
except KeyError:
return http.Response(stream = "Invalid session.")
session.worksheet.restart_sage()
status = session.get_status()
return http.Response(stream = "%s\n%s\n" % (simple_jsonize(status), SEP))
class CellResource(resource.Resource):
def start_comp(self, cell, timeout):
start_time = time.time()
looper_list = []
looper = LoopingCall(self.check_comp, cell, start_time, timeout, looper_list)
looper_list.append(looper) # so check_comp has access
looper.cell = cell # to pass it on
d = looper.start(0.25, now=True)
d.addCallback(self.render_cell_result)
return d
def check_comp(self, cell, start_time, timeout, looper_list):
cell.worksheet().check_comp(wait=0.01) # don't want to block, delay handled by twisted
if not cell.computing() or time.time() - start_time > timeout:
looper_list[0].stop()
def render_cell_result(self, looper):
cell = looper.cell
if cell.interrupted():
cell_status = 'interrupted'
elif cell.computing():
cell_status = 'computing'
else:
cell_status = 'done'
status = { 'cell_id': cell.id(), 'status': cell_status, 'files': cell.files() }
result = cell.output_text(raw=True)
# The conversion to str must be done because unicode strings are somehow not
# supported by http.Response
return http.Response(stream = str("\n".join([simple_jsonize(status), SEP, result])))
class ComputeResource(CellResource):
def render(self, ctx):
print ctx.args
try:
session = sessions[ctx.args['session'][0]]
except KeyError:
return http.Response(stream = "Invalid session.")
try:
timeout = float(ctx.args['timeout'][0])
except (KeyError, ValueError), msg:
timeout = session.default_timeout
cell = session.worksheet.append_new_cell()
cell.set_input_text(ctx.args['code'][0])
cell.evaluate(username = session.username)
print cell
return self.start_comp(cell, timeout)
class StatusResource(CellResource):
def render(self, ctx):
try:
session = sessions[ctx.args['session'][0]]
except KeyError:
return http.Response(stream = "Invalid session.")
try:
cell_id = int(ctx.args['cell'][0])
cell = session.worksheet.get_cell_with_id(cell_id)
try:
timeout = float(ctx.args['timeout'][0])
except KeyError, ValueError:
timeout = -1
return self.start_comp(cell, timeout)
except KeyError:
status = session.get_status()
return http.Response(stream = "%s\n%s\n" % (simple_jsonize(status), SEP))
class FileResource(resource.Resource):
"""
This differs from the rest as it does not print a header, just the
raw file data.
"""
def render(self, ctx):
try:
session = sessions[ctx.args['session'][0]]
except KeyError:
return http.Response(code=404, stream = "Invalid session.")
try:
cell_id = int(ctx.args['cell'][0])
file_name = ctx.args['file'][0]
except KeyError:
return http.Response(code=404, stream = "Unspecified cell or file.")
cell = session.worksheet.get_cell_with_id(cell_id)
if file_name in cell.files():
return static.File(os.path.join(cell.directory(), file_name))
else:
return http.Response(code=404, stream = "No such file %s in cell %s." % (file_name, cell_id))
class SimpleServer(resource.Resource):
child_login = LoginResource()
child_logout = LogoutResource()
child_interrupt = InterruptResource()
child_restart = RestartResource()
child_compute = ComputeResource()
child_status = StatusResource()
child_file = FileResource()
def render(self, ctx):
return http.Response(stream="Please login.")
|