annotate pydertron.py @ 22:915fdf283ac5

Moved docs out to a separate file.
author Atul Varma <varmaa@toolness.com>
date Thu, 10 Sep 2009 16:59:18 -0700
parents cb73bb169b67
children c2c369402a2e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
1 # ***** BEGIN LICENSE BLOCK *****
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
2 # Version: MPL 1.1/GPL 2.0/LGPL 2.1
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
3 #
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
4 # The contents of this file are subject to the Mozilla Public License Version
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
5 # 1.1 (the "License"); you may not use this file except in compliance with
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
6 # the License. You may obtain a copy of the License at
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
7 # http://www.mozilla.org/MPL/
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
8 #
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
9 # Software distributed under the License is distributed on an "AS IS" basis,
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
10 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
11 # for the specific language governing rights and limitations under the
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
12 # License.
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
13 #
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
14 # The Original Code is Pydertron.
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
15 #
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
16 # The Initial Developer of the Original Code is Mozilla.
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
17 # Portions created by the Initial Developer are Copyright (C) 2007
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
18 # the Initial Developer. All Rights Reserved.
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
19 #
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
20 # Contributor(s):
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
21 # Atul Varma <atul@mozilla.com>
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
22 #
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
23 # Alternatively, the contents of this file may be used under the terms of
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
24 # either the GNU General Public License Version 2 or later (the "GPL"), or
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
25 # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
26 # in which case the provisions of the GPL or the LGPL are applicable instead
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
27 # of those above. If you wish to allow use of your version of this file only
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
28 # under the terms of either the GPL or the LGPL, and not to allow others to
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
29 # use your version of this file under the terms of the MPL, indicate your
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
30 # decision by deleting the provisions above and replace them with the notice
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
31 # and other provisions required by the GPL or the LGPL. If you do not delete
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
32 # the provisions above, a recipient may use your version of this file under
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
33 # the terms of any one of the MPL, the GPL or the LGPL.
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
34 #
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
35 # ***** END LICENSE BLOCK *****
9fe3f115f951 Added license blocks.
Atul Varma <varmaa@toolness.com>
parents: 16
diff changeset
36
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
37 """
22
915fdf283ac5 Moved docs out to a separate file.
Atul Varma <varmaa@toolness.com>
parents: 21
diff changeset
38 Pydertron is a high-level wrapper for Pydermonkey that
21
cb73bb169b67 Added html docs.
Atul Varma <varmaa@toolness.com>
parents: 20
diff changeset
39 provides convenient, secure object wrapping between JS and Python
cb73bb169b67 Added html docs.
Atul Varma <varmaa@toolness.com>
parents: 20
diff changeset
40 space.
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
41 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
42
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
43 import sys
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
44 import threading
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
45 import traceback
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
46 import weakref
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
47 import types
7
2117265e4dfe Fixed some threading issues.
Atul Varma <varmaa@toolness.com>
parents: 6
diff changeset
48 import atexit
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
49
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
50 import pydermonkey
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
51
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
52 class ContextWatchdogThread(threading.Thread):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
53 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
54 Watches active JS contexts and triggers their operation callbacks
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
55 at a regular interval.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
56 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
57
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
58 # Default interval, in seconds, that the operation callbacks are
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
59 # triggered at.
8
fb0b161542b1 Improved performance of watchdog thread.
Atul Varma <varmaa@toolness.com>
parents: 7
diff changeset
60 DEFAULT_INTERVAL = 0.25
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
61
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
62 def __init__(self, interval=DEFAULT_INTERVAL):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
63 threading.Thread.__init__(self)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
64 self._lock = threading.Lock()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
65 self._stop = threading.Event()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
66 self._contexts = []
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
67 self.interval = interval
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
68
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
69 def add_context(self, cx):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
70 self._lock.acquire()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
71 try:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
72 self._contexts.append(weakref.ref(cx))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
73 finally:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
74 self._lock.release()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
75
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
76 def join(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
77 self._stop.set()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
78 threading.Thread.join(self)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
79
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
80 def run(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
81 while not self._stop.isSet():
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
82 new_list = []
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
83 self._lock.acquire()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
84 try:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
85 for weakcx in self._contexts:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
86 cx = weakcx()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
87 if cx:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
88 new_list.append(weakcx)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
89 cx.trigger_operation_callback()
7
2117265e4dfe Fixed some threading issues.
Atul Varma <varmaa@toolness.com>
parents: 6
diff changeset
90 del cx
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
91 self._contexts = new_list
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
92 finally:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
93 self._lock.release()
8
fb0b161542b1 Improved performance of watchdog thread.
Atul Varma <varmaa@toolness.com>
parents: 7
diff changeset
94 self._stop.wait(self.interval)
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
95
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
96 # Create a global watchdog.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
97 watchdog = ContextWatchdogThread()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
98 watchdog.start()
7
2117265e4dfe Fixed some threading issues.
Atul Varma <varmaa@toolness.com>
parents: 6
diff changeset
99 atexit.register(watchdog.join)
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
100
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
101 class InternalError(BaseException):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
102 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
103 Represents an error in a JS-wrapped Python function that wasn't
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
104 expected to happen; because it's derived from BaseException, it
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
105 unrolls the whole JS/Python stack so that the error can be
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
106 reported to the outermost calling code.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
107 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
108
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
109 def __init__(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
110 BaseException.__init__(self)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
111 self.exc_info = sys.exc_info()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
112
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
113 class SafeJsObjectWrapper(object):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
114 """
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
115 Securely wraps a JS object to behave like any normal Python
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
116 object. Like JS objects, though, accessing undefined object
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
117 results merely in pydermonkey.undefined.
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
118
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
119 Object properties may be accessed either via attribute or
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
120 item-based lookup.
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
121 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
122
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
123 __slots__ = ['_jsobject', '_sandbox', '_this']
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
124
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
125 def __init__(self, sandbox, jsobject, this):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
126 if not isinstance(jsobject, pydermonkey.Object):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
127 raise TypeError("Cannot wrap '%s' object" %
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
128 type(jsobject).__name__)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
129 object.__setattr__(self, '_sandbox', sandbox)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
130 object.__setattr__(self, '_jsobject', jsobject)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
131 object.__setattr__(self, '_this', this)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
132
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
133 @property
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
134 def wrapped_jsobject(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
135 return self._jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
136
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
137 def _wrap_to_python(self, jsvalue):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
138 return self._sandbox.wrap_jsobject(jsvalue, self._jsobject)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
139
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
140 def _wrap_to_js(self, value):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
141 return self._sandbox.wrap_pyobject(value)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
142
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
143 def __eq__(self, other):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
144 if isinstance(other, SafeJsObjectWrapper):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
145 return self._jsobject == other._jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
146 else:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
147 return False
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
148
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
149 def __str__(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
150 return self.toString()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
151
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
152 def __unicode__(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
153 return self.toString()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
154
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
155 def __setitem__(self, item, value):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
156 self.__setattr__(item, value)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
157
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
158 def __setattr__(self, name, value):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
159 cx = self._sandbox.cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
160 jsobject = self._jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
161
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
162 cx.define_property(jsobject, name,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
163 self._wrap_to_js(value))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
164
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
165 def __getitem__(self, item):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
166 return self.__getattr__(item)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
167
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
168 def __getattr__(self, name):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
169 cx = self._sandbox.cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
170 jsobject = self._jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
171
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
172 return self._wrap_to_python(cx.get_property(jsobject, name))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
173
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
174 def __contains__(self, item):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
175 cx = self._sandbox.cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
176 jsobject = self._jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
177
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
178 return cx.has_property(jsobject, item)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
179
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
180 def __iter__(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
181 cx = self._sandbox.cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
182 jsobject = self._jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
183
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
184 properties = cx.enumerate(jsobject)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
185 for property in properties:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
186 yield property
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
187
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
188 class SafeJsFunctionWrapper(SafeJsObjectWrapper):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
189 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
190 Securely wraps a JS function to behave like any normal Python object.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
191 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
192
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
193 def __init__(self, sandbox, jsfunction, this):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
194 if not isinstance(jsfunction, pydermonkey.Function):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
195 raise TypeError("Cannot wrap '%s' object" %
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
196 type(jsobject).__name__)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
197 SafeJsObjectWrapper.__init__(self, sandbox, jsfunction, this)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
198
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
199 def __call__(self, *args):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
200 cx = self._sandbox.cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
201 jsobject = self._jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
202 this = self._this
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
203
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
204 arglist = []
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
205 for arg in args:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
206 arglist.append(self._wrap_to_js(arg))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
207
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
208 obj = cx.call_function(this, jsobject, tuple(arglist))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
209 return self._wrap_to_python(obj)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
210
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
211 def format_stack(js_stack, open=open):
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
212 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
213 Returns a formatted Python-esque stack traceback of the given
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
214 JS stack.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
215 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
216
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
217 STACK_LINE =" File \"%(filename)s\", line %(lineno)d, in %(name)s"
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
218
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
219 lines = []
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
220 while js_stack:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
221 script = js_stack['script']
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
222 function = js_stack['function']
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
223 if script:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
224 frameinfo = dict(filename = script.filename,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
225 lineno = js_stack['lineno'],
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
226 name = '<module>')
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
227 elif function and not function.is_python:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
228 frameinfo = dict(filename = function.filename,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
229 lineno = js_stack['lineno'],
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
230 name = function.name)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
231 else:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
232 frameinfo = None
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
233 if frameinfo:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
234 lines.insert(0, STACK_LINE % frameinfo)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
235 try:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
236 filelines = open(frameinfo['filename']).readlines()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
237 line = filelines[frameinfo['lineno'] - 1].strip()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
238 lines.insert(1, " %s" % line)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
239 except Exception:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
240 pass
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
241 js_stack = js_stack['caller']
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
242 lines.insert(0, "Traceback (most recent call last):")
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
243 return '\n'.join(lines)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
244
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
245 def jsexposed(name=None, on=None):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
246 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
247 Decorator used to expose the decorated function or method to
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
248 untrusted JS.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
249
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
250 'name' is an optional alternative name for the function.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
251
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
252 'on' is an optional SafeJsObjectWrapper that the function can be
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
253 automatically attached as a property to.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
254 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
255
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
256 if callable(name):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
257 func = name
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
258 func.__jsexposed__ = True
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
259 return func
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
260
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
261 def make_exposed(func):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
262 if name:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
263 func.__name__ = name
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
264 func.__jsexposed__ = True
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
265 if on:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
266 on[func.__name__] = func
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
267 return func
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
268 return make_exposed
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
269
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
270 class JsExposedObject(object):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
271 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
272 Trivial base/mixin class for any Python classes that choose to
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
273 expose themselves to JS code.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
274 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
275
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
276 pass
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
277
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
278 class JsSandbox(object):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
279 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
280 A JS runtime and associated functionality capable of securely
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
281 loading and executing scripts.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
282 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
283
19
2dc43c316df9 Added opcb parameter
Atul Varma <varmaa@toolness.com>
parents: 18
diff changeset
284 def __init__(self, fs, watchdog=watchdog, opcb=None):
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
285 rt = pydermonkey.Runtime()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
286 cx = rt.new_context()
2
b6f9d743a2b5 Refined require() implementation.
Atul Varma <varmaa@toolness.com>
parents: 1
diff changeset
287 root_proto = cx.new_object()
b6f9d743a2b5 Refined require() implementation.
Atul Varma <varmaa@toolness.com>
parents: 1
diff changeset
288 cx.init_standard_classes(root_proto)
b6f9d743a2b5 Refined require() implementation.
Atul Varma <varmaa@toolness.com>
parents: 1
diff changeset
289 root = cx.new_object(None, root_proto)
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
290
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
291 cx.set_operation_callback(self._opcb)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
292 cx.set_throw_hook(self._throwhook)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
293 watchdog.add_context(cx)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
294
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
295 self.fs = fs
19
2dc43c316df9 Added opcb parameter
Atul Varma <varmaa@toolness.com>
parents: 18
diff changeset
296 self.opcb = opcb
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
297 self.rt = rt
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
298 self.cx = cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
299 self.curr_exc = None
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
300 self.py_stack = None
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
301 self.js_stack = None
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
302 self.__modules = {}
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
303 self.__py_to_js = {}
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
304 self.__type_protos = {}
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
305 self.__globals = {}
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
306 self.__root_proto = root_proto
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
307 self.root = self.wrap_jsobject(root, root)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
308
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
309 def set_globals(self, **globals):
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
310 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
311 Sets the global properties for the root object and all global
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
312 scopes (e.g., SecurableModules). This should be called before
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
313 any scripts are executed.
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
314 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
315
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
316 self.__globals.update(globals)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
317 self._install_globals(self.root)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
318
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
319 def finish(self):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
320 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
321 Cleans up all resources used by the sandbox, breaking any reference
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
322 cycles created due to issue #2 in pydermonkey:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
323
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
324 http://code.google.com/p/pydermonkey/issues/detail?id=2
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
325 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
326
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
327 for jsobj in self.__py_to_js.values():
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
328 self.cx.clear_object_private(jsobj)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
329 del self.__py_to_js
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
330 del self.__type_protos
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
331 del self.curr_exc
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
332 del self.py_stack
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
333 del self.js_stack
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
334 del self.cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
335 del self.rt
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
336
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
337 def _opcb(self, cx):
19
2dc43c316df9 Added opcb parameter
Atul Varma <varmaa@toolness.com>
parents: 18
diff changeset
338 # Note that if a keyboard interrupt was triggered,
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
339 # it'll get raised here automatically.
19
2dc43c316df9 Added opcb parameter
Atul Varma <varmaa@toolness.com>
parents: 18
diff changeset
340 if self.opcb:
2dc43c316df9 Added opcb parameter
Atul Varma <varmaa@toolness.com>
parents: 18
diff changeset
341 self.opcb()
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
342
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
343 def _throwhook(self, cx):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
344 curr_exc = cx.get_pending_exception()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
345 if self.curr_exc != curr_exc:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
346 self.curr_exc = curr_exc
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
347 self.py_stack = traceback.extract_stack()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
348 self.js_stack = cx.get_stack()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
349
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
350 def __wrap_pycallable(self, func, pyproto=None):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
351 if func in self.__py_to_js:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
352 return self.__py_to_js[func]
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
353
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
354 if hasattr(func, '__name__'):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
355 name = func.__name__
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
356 else:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
357 name = ""
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
358
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
359 if pyproto:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
360 def wrapper(func_cx, this, args):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
361 try:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
362 arglist = []
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
363 for arg in args:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
364 arglist.append(self.wrap_jsobject(arg))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
365 instance = func_cx.get_object_private(this)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
366 if instance is None or not isinstance(instance, pyproto):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
367 raise pydermonkey.error("Method type mismatch")
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
368
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
369 # TODO: Fill in extra required params with
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
370 # pymonkey.undefined? or automatically throw an
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
371 # exception to calling js code?
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
372 return self.wrap_pyobject(func(instance, *arglist))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
373 except pydermonkey.error:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
374 raise
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
375 except Exception:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
376 raise InternalError()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
377 else:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
378 def wrapper(func_cx, this, args):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
379 try:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
380 arglist = []
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
381 for arg in args:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
382 arglist.append(self.wrap_jsobject(arg))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
383
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
384 # TODO: Fill in extra required params with
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
385 # pymonkey.undefined? or automatically throw an
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
386 # exception to calling js code?
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
387 return self.wrap_pyobject(func(*arglist))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
388 except pydermonkey.error:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
389 raise
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
390 except Exception:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
391 raise InternalError()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
392 wrapper.wrapped_pyobject = func
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
393 wrapper.__name__ = name
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
394
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
395 jsfunc = self.cx.new_function(wrapper, name)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
396 self.__py_to_js[func] = jsfunc
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
397
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
398 return jsfunc
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
399
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
400 def __wrap_pyinstance(self, value):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
401 pyproto = type(value)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
402 if pyproto not in self.__type_protos:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
403 jsproto = self.cx.new_object()
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
404 if hasattr(pyproto, '__jsprops__'):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
405 define_getter = self.cx.get_property(jsproto,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
406 '__defineGetter__')
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
407 define_setter = self.cx.get_property(jsproto,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
408 '__defineSetter__')
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
409 for name in pyproto.__jsprops__:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
410 prop = getattr(pyproto, name)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
411 if not type(prop) == property:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
412 raise TypeError("Expected attribute '%s' to "
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
413 "be a property" % name)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
414 getter = None
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
415 setter = None
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
416 if prop.fget:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
417 getter = self.__wrap_pycallable(prop.fget,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
418 pyproto)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
419 if prop.fset:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
420 setter = self.__wrap_pycallable(prop.fset,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
421 pyproto)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
422 if getter:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
423 self.cx.call_function(jsproto,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
424 define_getter,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
425 (name, getter))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
426 if setter:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
427 self.cx.call_function(jsproto,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
428 define_setter,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
429 (name, setter,))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
430 for name in dir(pyproto):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
431 attr = getattr(pyproto, name)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
432 if (isinstance(attr, types.UnboundMethodType) and
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
433 hasattr(attr, '__jsexposed__') and
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
434 attr.__jsexposed__):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
435 jsmethod = self.__wrap_pycallable(attr, pyproto)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
436 self.cx.define_property(jsproto, name, jsmethod)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
437 self.__type_protos[pyproto] = jsproto
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
438 return self.cx.new_object(value, self.__type_protos[pyproto])
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
439
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
440 def wrap_pyobject(self, value):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
441 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
442 Wraps the given Python object for export to untrusted JS.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
443
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
444 If the Python object isn't of a type that can be exposed to JS,
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
445 a TypeError is raised.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
446 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
447
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
448 if (isinstance(value, (int, basestring, float, bool)) or
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
449 value is pydermonkey.undefined or
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
450 value is None):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
451 return value
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
452 if isinstance(value, SafeJsObjectWrapper):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
453 # It's already wrapped, just unwrap it.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
454 return value.wrapped_jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
455 elif callable(value):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
456 if not (hasattr(value, '__jsexposed__') and
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
457 value.__jsexposed__):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
458 raise ValueError("Callable isn't configured for exposure "
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
459 "to untrusted JS code")
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
460 return self.__wrap_pycallable(value)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
461 elif isinstance(value, JsExposedObject):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
462 return self.__wrap_pyinstance(value)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
463 else:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
464 raise TypeError("Can't expose objects of type '%s' to JS." %
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
465 type(value).__name__)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
466
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
467 def wrap_jsobject(self, jsvalue, this=None):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
468 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
469 Wraps the given pydermonkey.Object for import to trusted
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
470 Python code. If the type is just a primitive, it's simply
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
471 returned, since no wrapping is needed.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
472 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
473
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
474 if this is None:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
475 this = self.root.wrapped_jsobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
476 if isinstance(jsvalue, pydermonkey.Function):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
477 if jsvalue.is_python:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
478 # It's a Python function, just unwrap it.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
479 return self.cx.get_object_private(jsvalue).wrapped_pyobject
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
480 return SafeJsFunctionWrapper(self, jsvalue, this)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
481 elif isinstance(jsvalue, pydermonkey.Object):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
482 # It's a wrapped Python object instance, just unwrap it.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
483 instance = self.cx.get_object_private(jsvalue)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
484 if instance:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
485 if not isinstance(instance, JsExposedObject):
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
486 raise AssertionError("Object private is not of type "
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
487 "JsExposedObject")
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
488 return instance
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
489 else:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
490 return SafeJsObjectWrapper(self, jsvalue, this)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
491 else:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
492 # It's a primitive value.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
493 return jsvalue
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
494
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
495 def new_array(self, *contents):
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
496 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
497 Creates a new JavaScript array with the given contents and
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
498 returns a wrapper for it.
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
499 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
500
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
501 array = self.wrap_jsobject(self.cx.new_array_object())
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
502 for item in contents:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
503 array.push(item)
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
504 return array
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
505
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
506 def new_object(self, **contents):
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
507 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
508 Creates a new JavaScript object with the given properties and
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
509 returns a wrapper for it.
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
510 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
511
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
512 obj = self.wrap_jsobject(self.cx.new_object())
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
513 for name in contents:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
514 obj[name] = contents[name]
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
515 return obj
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
516
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
517 def get_calling_script(self):
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
518 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
519 Returns the filename of the current stack's most recent
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
520 JavaScript caller.
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
521 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
522
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
523 frame = self.cx.get_stack()['caller']
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
524 curr_script = None
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
525 while frame and curr_script is None:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
526 if frame['function'] and frame['function'].filename:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
527 curr_script = frame['function'].filename
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
528 elif frame['script']:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
529 curr_script = frame['script'].filename
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
530 frame = frame['caller']
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
531
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
532 if curr_script is None:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
533 raise RuntimeError("Can't find calling script")
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
534 return curr_script
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
535
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
536 def _install_globals(self, object):
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
537 for name in self.__globals:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
538 object[name] = self.__globals[name]
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
539 object['require'] = self._require
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
540
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
541 @jsexposed(name='require')
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
542 def _require(self, path):
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
543 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
544 Implementation for the global require() function, implemented
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
545 as per the CommonJS SecurableModule specification:
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
546
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
547 http://wiki.commonjs.org/wiki/CommonJS/Modules/SecurableModules
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
548 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
549
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
550 filename = self.fs.find_module(self.get_calling_script(), path)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
551 if not filename:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
552 raise pydermonkey.error('Module not found: %s' % path)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
553 if not filename in self.__modules:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
554 cx = self.cx
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
555 module = cx.new_object(None, self.__root_proto)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
556 cx.init_standard_classes(module)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
557 exports = cx.new_object()
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
558 cx.define_property(module, 'exports', exports)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
559 self._install_globals(self.wrap_jsobject(module))
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
560 self.__modules[filename] = self.wrap_jsobject(exports)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
561 contents = self.fs.open(filename).read()
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
562 cx.evaluate_script(module, contents, filename, 1)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
563 return self.__modules[filename]
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
564
6
97adec8c8127 Now passing all CommonJS SecurableModule compliance tests.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
565 def run_script(self, contents, filename='<string>', lineno=1,
20
d382ca63d43f Added docs with doctests.
Atul Varma <varmaa@toolness.com>
parents: 19
diff changeset
566 callback=None, stderr=None):
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
567 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
568 Runs the given JS script, returning 0 on success, -1 on failure.
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
569 """
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
570
20
d382ca63d43f Added docs with doctests.
Atul Varma <varmaa@toolness.com>
parents: 19
diff changeset
571 if stderr is None:
d382ca63d43f Added docs with doctests.
Atul Varma <varmaa@toolness.com>
parents: 19
diff changeset
572 stderr = sys.stderr
d382ca63d43f Added docs with doctests.
Atul Varma <varmaa@toolness.com>
parents: 19
diff changeset
573
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
574 retval = -1
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
575 cx = self.cx
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
576 try:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
577 result = cx.evaluate_script(self.root.wrapped_jsobject,
6
97adec8c8127 Now passing all CommonJS SecurableModule compliance tests.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
578 contents, filename, lineno)
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
579 if callback:
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
580 callback(self.wrap_jsobject(result))
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
581 retval = 0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
582 except pydermonkey.error, e:
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
583 params = dict(
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
584 stack_trace = format_stack(self.js_stack, self.fs.open),
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
585 error = e.args[1]
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
586 )
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
587 stderr.write("%(stack_trace)s\n%(error)s\n" % params)
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
588 except InternalError, e:
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
589 stderr.write("An internal error occurred.\n")
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
590 traceback.print_tb(e.exc_info[2], None, stderr)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
591 stderr.write("%s\n" % e.exc_info[1])
0
a5b09b685df4 Origination
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
592 return retval
1
ab09b8a10876 Added trivial half-baked implementation of securable modules.
Atul Varma <varmaa@toolness.com>
parents: 0
diff changeset
593
14
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
594 class HttpFileSystem(object):
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
595 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
596 File system through which all resources are loaded over HTTP.
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
597 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
598
14
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
599 def __init__(self, base_url):
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
600 self.base_url = base_url
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
601
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
602 def find_module(self, curr_url, path):
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
603 import urlparse
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
604
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
605 if path.startswith("."):
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
606 base_url = curr_url
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
607 else:
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
608 base_url = self.base_url
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
609
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
610 url = "%s.js" % urlparse.urljoin(base_url, path)
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
611 if not url.startswith(self.base_url):
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
612 return None
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
613 return url
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
614
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
615 def open(self, url):
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
616 import urllib
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
617
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
618 return urllib.urlopen(url)
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
619
16
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
620 class LocalFileSystem(object):
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
621 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
622 File system through which all resources are loaded over the local
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
623 filesystem.
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
624 """
9426f9fa6dc0 Added docs.
Atul Varma <varmaa@toolness.com>
parents: 14
diff changeset
625
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
626 def __init__(self, root_dir):
3
14d8d73774d7 Refactored securable module loader.
Atul Varma <varmaa@toolness.com>
parents: 2
diff changeset
627 self.root_dir = root_dir
2
b6f9d743a2b5 Refined require() implementation.
Atul Varma <varmaa@toolness.com>
parents: 1
diff changeset
628
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
629 def find_module(self, curr_script, path):
14
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
630 import os
16fe9c63aedb Added HttpFileSystem
Atul Varma <varmaa@toolness.com>
parents: 12
diff changeset
631
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
632 if path.startswith("."):
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
633 base_dir = os.path.dirname(curr_script)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
634 else:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
635 base_dir = self.root_dir
2
b6f9d743a2b5 Refined require() implementation.
Atul Varma <varmaa@toolness.com>
parents: 1
diff changeset
636
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
637 ospath = path.replace('/', os.path.sep)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
638 filename = os.path.join(base_dir, "%s.js" % ospath)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
639 filename = os.path.normpath(filename)
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
640 if (filename.startswith(self.root_dir) and
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
641 (os.path.exists(filename) and
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
642 not os.path.isdir(filename))):
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
643 return filename
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
644 else:
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
645 return None
3
14d8d73774d7 Refactored securable module loader.
Atul Varma <varmaa@toolness.com>
parents: 2
diff changeset
646
11
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
647 def open(self, filename):
665f69f61716 Some refactorings
Atul Varma <varmaa@toolness.com>
parents: 9
diff changeset
648 return open(filename, 'r')