Zopeを理解しようということで、コード読みです。
プログラマでなくてもわかるZope 3紹介をみてオブジェクトパブリッシャがキモのようなので、それっぽいところを拾ってきて読むことにした。
読みの対象したブツ
commit e0cf424a7dcf28d776da2a7765884bc9f97e6755
Author: hannosch
Date: Mon Feb 23 12:49:08 2009 +0000
OFS.ObjectManager now fully implements the zope.container.IContainer interface and no longer just claims to do so. See the changelo
git-svn-id: svn://svn.zope.org/repos/main/Zope/trunk@97155 62d5b8a3-27da-0310-9561-8e5933582275
「class DefaultPublishTravers」でgoogle code検索すれば大体同じようなところにたどり着きます。
src/ZPublisher/BaseRequest.py class BaseRequestのメソッドtraverseである。
まずは準備。
def traverse(self, path, response=None, validated_hook=None):
"""Traverse the object space
The REQUEST must already have a PARENTS item with at least one
object in it. This is typically the root object.
"""
request=self
request_get=request.get
if response is None: response=self.response
# remember path for later use
browser_path = path
pathの正規化。あまりよくない。
- /path/to/this → path/to/this
- path/to/this/ → path/to/this
- path/./to/./this → [path, to, this]
- path/../path/to/this → [path, to, this]
をやっている。cleanという名前もどうかと思うし、この部分だけmake_path_listとか関数にすりゃいい。長くてかなわない。pathという名前がさしているものがstrからlistに変わっていて気持ち悪い。
# Cleanup the path list
if path[:1]=='/': path=path[1:]
if path[-1:]=='/': path=path[:-1]
clean=[]
for item in path.split('/'):
# Make sure that certain things that dont make sense
# cannot be traversed.
if item in ('REQUEST', 'aq_self', 'aq_base'):
return response.notFoundError(path)
if not item or item=='.':
continue
elif item == '..':
del clean[-1]
else: clean.append(item)
path=clean
acquireはなんでしょ。裏が取れてませんが、WebDAVのLockでしょう。
# How did this request come in? (HTTP GET, PUT, POST, etc.)
method=req_method=request_get('REQUEST_METHOD', 'GET').upper()
if method=='GET' or method=='POST' and not isinstance(response,
xmlrpc.Response):
# Probably a browser
no_acquire_flag=0
# index_html is still the default method, only any object can
# override it by implementing its own __browser_default__ method
method = 'index_html'
elif self.maybe_webdav_client:
# Probably a WebDAV client.
no_acquire_flag=1
else:
no_acquire_flag=0
request=selfとrequest_get=request.getなのだ。requestはdictっぽいなにか。HTTP Requestの各headerが収まっていると見ていいでしょう。組み込みのobjectがここで隠されるので注意（ぶー）。
URL=request['URL']
parents=request['PARENTS']
object=parents[-1]
del parents[:]
__bobo_があると挙動が変わるらしい。boboってなんの略だ？
self.roles = getRoles(None, None, object, UNSPECIFIED_ROLES)
# if the top object has a __bobo_traverse__ method, then use it
# to possibly traverse to an alternate top-level object.
if hasattr(object,'__bobo_traverse__'):
try:
object=object.__bobo_traverse__(request)
self.roles = getRoles(None, None, object, UNSPECIFIED_ROLES)
except: pass
pathとmethodのどちらも存在しないとこｔは、応答するリソース存在しないこと。
if not path and not method:
return response.forbiddenError(self['URL'])
__of__を持っていると特別扱い。
# Traverse the URL to find the object:
if hasattr(object, '__of__'):
# Try to bind the top-level object to the request
# This is how you get 'self.REQUEST'
object=object.__of__(RequestContainer(REQUEST=request))
parents.append(object)
資料によればobjectはtreeをなしているらしく、そのルートからたどる時のスタックをpathから作る、最後のフェーズ。
reverse()をしているのは.pop()を使って後ろからとりだすため。pathを抽象化する何かを作って、コンストラクタにurlを渡すとかではなく、べたべたに書いている。
steps=self.steps
self._steps = _steps = map(quote, steps)
path.reverse()
request['TraversalRequestNameStack'] = request.path = path
request['ACTUAL_URL'] = request['URL'] + quote(browser_path)
こいつは、とりあえずは、無視していい。
# Set the posttraverse for duration of the traversal here
self._post_traverse = post_traverse = []
かなり長いtry/finally, finallyは
ここ。
rootからたどってname(str)のlist(path)からobjectのlist(parents)を作る。
try/finallyすることで途中でたどれなくても、できたところまでのobjectを返す。
entry_name = ''
try:
# We build parents in the wrong order, so we
# need to make sure we reverse it when we're done.
path(nameのlist)に関してのループ。一見してなんのループかわからない。
while 1:
bpth = getattr(object, '__before_publishing_traverse__', None)
if bpth is not None:
bpth(object, self)
path = request.path = request['TraversalRequestNameStack']
# Check for method:
if path:
entry_name = path.pop()
else:
# If we have reached the end of the path, we look to see
# if we can find IBrowserPublisher.browserDefault. If so,
# we call it to let the object tell us how to publish it.
# BrowserDefault returns the object to be published
# (usually self) and a sequence of names to traverse to
# find the method to be published.
# This is webdav support. The last object in the path
# should not be acquired. Instead, a NullResource should
# be given if it doesn't exist:
if (no_acquire_flag and
hasattr(object, 'aq_base') and
not hasattr(object,'__bobo_traverse__')):
if object.aq_parent is not object.aq_inner.aq_parent:
from webdav.NullResource import NullResource
object = NullResource(parents[-2], object.getId(),
self).__of__(parents[-2])
特定の（この場合はIBrowserPublisher）の指定する能力を持つobjectかどうかを判定している。無い場合は、アダプタを探し回る。
if IBrowserPublisher.providedBy(object):
adapter = object
else:
adapter = queryMultiAdapter((object, self),
IBrowserPublisher)
if adapter is None:
# Zope2 doesn't set up its own adapters in a lot
# of cases so we will just use a default adapter.
adapter = DefaultPublishTraverse(object, self)
再び名前objectを上書き。詳細はわからないが、treeのnodeをdownしているのは間違いないだろう。default_pathはadapter.browserDefaultしだい。
object, default_path = adapter.browserDefault(self)
if default_path:
request._hacked_path=1
if len(default_path) > 1:
path = list(default_path)
method = path.pop()
request['TraversalRequestNameStack'] = path
continue
else:
entry_name = default_path[0]
/で終わる名前の場合。HTTP METHODでかつそのMETHOD名に相当するmethod(python objectの)がある場合、methodはindex_htmlが使われる。このへんはIBrowserPublisherを見ればわかるはず。
elif (method and hasattr(object,method)
and entry_name != method
and getattr(object, method) is not None):
request._hacked_path=1
entry_name = method
method = 'index_html'
適切な表現とはいいがたいが、cgiっぽい挙動をする。objectが__call__を持っているとそいつを呼ぶのだろう。返す結果が実行結果かどうかはちょっとわからない。動的に生成されたobjectではなく、methodからroleを決定している。
else:
if hasattr(object, '__call__'):
self.roles = getRoles(object, '__call__', object.__call__,
self.roles)
if request._hacked_path:
i=URL.rfind('/')
if i > 0: response.setBase(URL[:i])
break
下に行く。どのobjectのどのattributeを見るかはurlから直接決まるのではなく、entry_nameで決まる。stepはそれのquoteしたもので、それから実際に返事をしたobjectのURLを作る。
step = quote(entry_name)
_steps.append(step)
request['URL'] = URL = '%s/%s' % (request['URL'], step)
try:
subobject = self.traverseName(object, entry_name)
if (hasattr(object,'__bobo_traverse__') or
hasattr(object, entry_name)):
check_name = entry_name
else:
check_name = None
self.roles = getRoles(
object, check_name, subobject,
self.roles)
object = subobject
例外から推定するに辞書だった場合は、__getitem__して、そうじゃない場合は__dict__を見るようだ。
except (KeyError, AttributeError):
if response.debug_mode:
return response.debugError(
"Cannot locate object at: %s" % URL)
else:
return response.notFoundError(URL)
except Forbidden, e:
if self.response.debug_mode:
return response.debugError(e.args)
else:
return response.forbiddenError(entry_name)
チェックしたものをappendする。
parents.append(object)
steps.append(entry_name)
parentsはreverseするのにstepsはしない。何故？
finally:
parents.reverse()
とりあえず無視。
# Note - no_acquire_flag is necessary to support
# things like DAV. We have to make sure
# that the target object is not acquired
# if the request_method is other than GET
# or POST. Otherwise, you could never use
# PUT to add a new object named 'test' if
# an object 'test' existed above it in the
# heirarchy -- you'd always get the
# existing object :(
if (no_acquire_flag and
hasattr(parents[1], 'aq_base') and
not hasattr(parents[1],'__bobo_traverse__')):
if not (hasattr(parents[1].aq_base, entry_name) or
parents[1].aq_base.has_key(entry_name)):
raise AttributeError, entry_name
# After traversal post traversal hooks aren't available anymore
del self._post_traverse
reverseしたあとなので、一番最後に見つかったやつが[0]にいる。びみょー。
request['PUBLISHED'] = parents.pop(0)
# Do authorization checks
user=groups=None
i=0
if 1: # Always perform authentication.
どのobjectの__allow_groups__をgroupsとして使うかを決める。
parerntsはleafからrootに向かって配列されているので、自分で決められないと親にとあわせが行く。以下、再帰的に。これも_get_groupsとかでまとめて書いてほしい・・・。
last_parent_index=len(parents)
if hasattr(object, '__allow_groups__'):
groups=object.__allow_groups__
inext=0
else:
inext=None
for i in range(last_parent_index):
if hasattr(parents[i],'__allow_groups__'):
groups=parents[i].__allow_groups__
inext=i+1
break
groupsを使って仕事をする。
if inext is not None:
i=inext
old_validationは関数。default_validationじゃなくて、old_validationなのは、おそらく歴史的理由なのだろう。
def old_validation(groups, request, auth,
roles=UNSPECIFIED_ROLES):
if hasattr(groups, 'validate'): v=groups.validate
else: v=old_validation
auth=request._auth
認証に使う関数を探す。
if v is old_validation and self.roles is UNSPECIFIED_ROLES:
# No roles, so if we have a named group, get roles from
# group keys
if hasattr(groups,'keys'): self.roles=groups.keys()
else:
try: groups=groups()
except: pass
try: self.roles=groups.keys()
except: pass
if groups is None:
# Public group, hack structures to get it to validate
self.roles=None
auth=''
認証を実行。
if v is old_validation:
user=old_validation(groups, request, auth, self.roles)
ちょっと意味不明。vの引数が違うのか？？
elif self.roles is UNSPECIFIED_ROLES: user=v(request, auth)
else: user=v(request, auth, self.roles)
認証の結果userが決まらなかったときに、path上のすべてのobjectについて、leafからrootに向かって、認証をこころみる。
while user is None and i < last_parent_index:
parent=parents[i]
i=i+1
if hasattr(parent, '__allow_groups__'):
groups=parent.__allow_groups__
else: continue
if hasattr(groups,'validate'): v=groups.validate
else: v=old_validation
if v is old_validation:
user=old_validation(groups, request, auth, self.roles)
elif self.roles is UNSPECIFIED_ROLES: user=v(request, auth)
else: user=v(request, auth, self.roles)
userがNoneでかつ、何らかの認証が要求されていたら、それは認証失敗。
if user is None and self.roles != UNSPECIFIED_ROLES:
response.unauthorized()
認証が成功していたら、それにまつわるフックがあれば実行して、認証の情報をセット。
if user is not None:
if validated_hook is not None: validated_hook(self, user)
request['AUTHENTICATED_USER']=user
request['AUTHENTICATION_PATH']='/'.join(steps[:-i])
# Remove http request method from the URL.
request['URL']=URL
とりあえず無視。
# Run post traversal hooks
if post_traverse:
result = exec_callables(post_traverse)
if result is not None:
object = result
お疲れ様。
return object
投稿
