/usr/share/pyshared/lazr/restful/publisher.py is in python-lazr.restful 0.19.3-0ubuntu2.
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 | # Copyright 2009 Canonical Ltd. All rights reserved.
"""Publisher mixins for the webservice.
This module defines classes that are usually needed for integration
with the Zope publisher.
"""
__metaclass__ = type
__all__ = [
'browser_request_to_web_service_request',
'WebServicePublicationMixin',
'WebServiceRequestTraversal',
]
import simplejson
import urllib
import urlparse
from zope.component import (
adapter,
getMultiAdapter,
getUtility,
queryAdapter,
queryMultiAdapter,
)
from zope.component.interfaces import ComponentLookupError
from zope.interface import (
alsoProvides,
implementer,
implements,
)
from zope.publisher.interfaces import NotFound
from zope.publisher.interfaces.browser import IBrowserRequest
from zope.schema.interfaces import IBytes
from zope.security.checker import ProxyFactory
from lazr.uri import URI
from lazr.restful import (
CollectionResource,
EntryField,
EntryFieldResource,
EntryResource,
ScopedCollection,
)
from lazr.restful.interfaces import (
IByteStorage,
ICollection,
ICollectionField,
IEntry,
IEntryField,
IHTTPResource,
INotificationsProvider,
IReference,
IServiceRootResource,
IWebBrowserInitiatedRequest,
IWebServiceClientRequest,
IWebServiceConfiguration,
)
from lazr.restful.utils import tag_request_with_version_name
class WebServicePublicationMixin:
"""A mixin for webservice publication.
This should usually be mixed-in with ZopePublication, or Browser,
or HTTPPublication.
"""
def traverseName(self, request, ob, name):
"""See `zope.publisher.interfaces.IPublication`.
In addition to the default traversal implementation, this publication
also handles traversal to collection scoped into an entry.
"""
# If this is the last traversal step, then look first for a scoped
# collection. This is done because although Navigation handles
# traversal to entries in a scoped collection, they don't usually
# handle traversing to the scoped collection itself.
if len(request.getTraversalStack()) == 0:
try:
entry = getMultiAdapter((ob, request), IEntry)
except ComponentLookupError:
# This doesn't look like a lazr.restful object. Let
# the superclass handle traversal.
pass
else:
if name.endswith("_link"):
# The user wants to access the link resource itself,
# rather than the object on the other side of the link.
if name.endswith("_collection_link"):
schema_name = name[:-16]
else:
schema_name = name[:-5]
field = entry.schema.get(schema_name)
return EntryField(entry, field, name)
field = entry.schema.get(name)
if ICollectionField.providedBy(field):
result = self._traverseToScopedCollection(
request, entry, field, name)
if result is not None:
return result
elif IBytes.providedBy(field):
return self._traverseToByteStorage(
request, entry, field, name)
elif IReference.providedBy(field):
sub_entry = getattr(entry, name, None)
if sub_entry is None:
raise NotFound(ob, name, request)
else:
return sub_entry
elif field is not None:
return EntryField(entry, field, name)
else:
# Falls through to our parent version.
pass
return super(WebServicePublicationMixin, self).traverseName(
request, ob, name)
def _traverseToByteStorage(self, request, entry, field, name):
"""Try to traverse to a byte storage resource in entry."""
# Even if the library file is None, we want to allow
# traversal, because the request might be a PUT request
# creating a file here.
return getMultiAdapter((entry, field.bind(entry)), IByteStorage)
def _traverseToScopedCollection(self, request, entry, field, name):
"""Try to traverse to a collection in entry.
This is done because we don't usually traverse to attributes
representing a collection in our regular Navigation.
This method returns None if a scoped collection cannot be found.
"""
collection = getattr(entry, name, None)
if collection is None:
return None
scoped_collection = ScopedCollection(entry.context, entry, request)
# Tell the IScopedCollection object what collection it's managing,
# and what the collection's relationship is to the entry it's
# scoped to.
scoped_collection.collection = collection
scoped_collection.relationship = field
return scoped_collection
def getDefaultTraversal(self, request, ob):
"""See `zope.publisher.interfaces.browser.IBrowserPublication`.
The WebService doesn't use the getDefaultTraversal() extension
mechanism, because it only applies to GET, HEAD, and POST methods.
See getResource() for the alternate mechanism.
"""
# Don't traverse to anything else.
return ob, None
def getResource(self, request, ob):
"""Return the resource that can publish the object ob.
This is done at the end of traversal. If the published object
supports the ICollection, or IEntry interface we wrap it into the
appropriate resource.
"""
if (ICollection.providedBy(ob) or
queryMultiAdapter((ob, request), ICollection) is not None):
# Object supports ICollection protocol.
resource = CollectionResource(ob, request)
elif (IEntry.providedBy(ob) or
queryMultiAdapter((ob, request), IEntry) is not None):
# Object supports IEntry protocol.
resource = EntryResource(ob, request)
elif (IEntryField.providedBy(ob) or
queryAdapter(ob, IEntryField) is not None):
# Object supports IEntryField protocol.
resource = EntryFieldResource(ob, request)
elif queryMultiAdapter((ob, request), IHTTPResource) is not None:
# Object can be adapted to a resource.
resource = queryMultiAdapter((ob, request), IHTTPResource)
elif IHTTPResource.providedBy(ob):
# A resource knows how to take care of itself.
return ob
else:
# This object should not be published on the web service.
raise NotFound(ob, '')
# Wrap the resource in a security proxy.
return ProxyFactory(resource)
def _processNotifications(self, request):
"""Add any notification messages to the response headers.
If the webservice has defined an INotificationsProvider adaptor, use
it to include with the response the relevant notification messages
and their severity levels.
"""
notifications_provider = INotificationsProvider(request, None)
notifications = []
if (notifications_provider is not None
and notifications_provider.notifications):
notifications = ([(notification.level, notification.message)
for notification in notifications_provider.notifications])
json_notifications = simplejson.dumps(notifications)
request.response.setHeader(
'X-Lazr-Notifications', json_notifications)
def callObject(self, request, object):
"""Help web browsers handle redirects correctly."""
value = super(
WebServicePublicationMixin, self).callObject(request, object)
self._processNotifications(request)
if request.response.getStatus() / 100 == 3:
vhost = URI(request.getApplicationURL()).host
if IWebBrowserInitiatedRequest.providedBy(request):
# This request was (probably) sent by a web
# browser. Because web browsers, content negotiation,
# and redirects are a deadly combination, we're going
# to help the browser out a little.
#
# We're going to take the current request's "Accept"
# header and put it into the URL specified in the
# Location header. When the web browser makes its
# request, it will munge the original 'Accept' header,
# but because the URL it's accessing will include the
# old header in the "ws.accept" header, we'll still be
# able to serve the right document.
location = request.response.getHeader("Location", None)
if location is not None:
accept = request.getHeader("Accept", "application/json")
qs_append = "ws.accept=" + urllib.quote(accept)
# We don't use the URI class because it will raise
# an exception if the Location contains invalid
# characters. Invalid characters may indeed be a
# problem, but let the problem be handled
# somewhere else.
(scheme, netloc, path, query, fragment) = (
urlparse.urlsplit(location))
if query == '':
query = qs_append
else:
query += '&' + qs_append
uri = urlparse.urlunsplit(
(scheme, netloc, path, query, fragment))
request.response.setHeader("Location", str(uri))
return value
class WebServiceRequestTraversal(object):
"""Mixin providing web-service resource wrapping in traversal.
This should be mixed in the request using to the base publication used.
"""
implements(IWebServiceClientRequest)
VERSION_ANNOTATION = 'lazr.restful.version'
def traverse(self, ob):
"""See `zope.publisher.interfaces.IPublisherRequest`.
This is called once at the beginning of the traversal process.
WebService requests call the `WebServicePublication.getResource()`
on the result of the base class's traversal.
"""
self._removeVirtualHostTraversals()
# We don't trust the value of 'ob' passed in (it's probably
# None) because the publication depends on which version of
# the web service was requested.
# _removeVirtualHostTraversals() has determined which version
# was requested and has set the application appropriately, so
# now we can get a good value for 'ob' and traverse it.
ob = self.publication.getApplication(self)
result = super(WebServiceRequestTraversal, self).traverse(ob)
return self.publication.getResource(self, result)
def _removeVirtualHostTraversals(self):
"""Remove the /[path_override] and /[version] traversal names."""
names = list()
start_stack = list(self.getTraversalStack())
config = getUtility(IWebServiceConfiguration)
if config.path_override is not None:
api = self._popTraversal(config.path_override)
if api is not None:
names.append(api)
# Requests that use the webservice path override are
# usually made by web browsers. Mark this request as one
# initiated by a web browser, for the sake of
# optimizations later in the request lifecycle.
alsoProvides(self, IWebBrowserInitiatedRequest)
# Only accept versioned URLs. Any of the active_versions is
# acceptable.
version = None
for version_string in config.active_versions:
if version_string is not None:
version = self._popTraversal(version_string)
if version is not None:
names.append(version)
self.setVirtualHostRoot(names=names)
break
if version is None:
raise NotFound(self, '', self)
tag_request_with_version_name(self, version)
# Find the appropriate service root for this version and set
# the publication's application appropriately.
try:
# First, try to find a version-specific service root.
service_root = getUtility(IServiceRootResource, name=self.version)
except ComponentLookupError:
# Next, try a version-independent service root.
service_root = getUtility(IServiceRootResource)
self.publication.application = service_root
def _popTraversal(self, name=None):
"""Remove a name from the traversal stack, if it is present.
:name: The string to look for in the stack, or None to accept
any string.
:return: The name of the element removed, or None if the stack
wasn't changed.
"""
stack = self.getTraversalStack()
if len(stack) > 0 and (name is None or stack[-1] == name):
item = stack.pop()
self.setTraversalStack(stack)
return item
return None
@implementer(IWebServiceClientRequest)
@adapter(IBrowserRequest)
def browser_request_to_web_service_request(
website_request, web_service_version=None):
"""An adapter from a browser request to a web service request.
Used to instantiate Resource objects when handling normal web
browser requests.
"""
config = getUtility(IWebServiceConfiguration)
if web_service_version is None:
web_service_version = config.active_versions[-1]
body = website_request.bodyStream.getCacheStream()
environ = dict(website_request.environment)
# Zope picks up on SERVER_URL when setting the _app_server attribute
# of the new request.
environ['SERVER_URL'] = website_request.getApplicationURL()
web_service_request = config.createRequest(body, environ)
web_service_request.setVirtualHostRoot(
names=[config.path_override, web_service_version])
tag_request_with_version_name(web_service_request, web_service_version)
web_service_request._vh_root = website_request.getVirtualHostRoot()
return web_service_request
|