[entity] introduce a new 'adapters' registry
This changeset introduces the notion in adapters (as in Zope Component Architecture)
in a cubicweb way, eg using a specific registry of appobjects.
This allows nicer code structure, by avoid clutering entity classes and moving
code usually specific to a place of the ui (or something else) together with the
code that use the interface.
We don't use actual interface anymore, they are implied by adapters (which
may be abstract), whose reg id is an interface name.
Appobjects that used to 'implements(IFace)' should now be rewritten by:
* coding an IFaceAdapter(EntityAdapter) defining (implementing if desired)
the interface, usually with __regid__ = 'IFace'
* use "adaptable('IFace')" as selector instead
Also, the implements_adapter_compat decorator eases backward compatibility
with adapter's methods that may still be found on entities implementing
the interface.
Notice that unlike ZCA, we don't support automatic adapters chain (yagni?).
All interfaces defined in cubicweb have been turned into adapters, also
some new ones have been introduced to cleanup Entity / AnyEntity classes
namespace. At the end, the pluggable mixins mecanism should disappear in
favor of adapters as well.
# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>.
"""twisted server configurations:
* the "twisted" configuration to get a web instance running in a standalone
twisted web server which talk to a repository server using Pyro
* the "all-in-one" configuration to get a web instance running in a twisted
web server integrating a repository server in the same process (only available
if the repository part of the software is installed
"""
__docformat__ = "restructuredtext en"
from os.path import join
from logilab.common.configuration import Method
from cubicweb.web.webconfig import WebConfiguration, merge_options
class TwistedConfiguration(WebConfiguration):
"""web instance (in a twisted web server) client of a RQL server"""
name = 'twisted'
options = merge_options((
# ctl configuration
('port',
{'type' : 'int',
'default': None,
'help': 'http server port number (default to 8080)',
'group': 'web', 'level': 0,
}),
('max-post-length',
{'type' : 'bytes',
'default': '100MB',
'help': 'maximum length of HTTP request. Default to 100 MB.',
'group': 'web', 'level': 1,
}),
('profile',
{'type' : 'string',
'default': None,
'help': 'profile code and use the specified file to store stats if this option is set',
'group': 'web', 'level': 3,
}),
('host',
{'type' : 'string',
'default': None,
'help': 'host name if not correctly detectable through gethostname',
'group': 'main', 'level': 1,
}),
('pid-file',
{'type' : 'string',
'default': Method('default_pid_file'),
'help': 'repository\'s pid file',
'group': 'main', 'level': 2,
}),
('uid',
{'type' : 'string',
'default': None,
'help': 'if this option is set, use the specified user to start \
the repository rather than the user running the command',
'group': 'main', 'level': WebConfiguration.mode == 'system'
}),
('session-time',
{'type' : 'time',
'default': '30min',
'help': 'session expiration time, default to 30 minutes',
'group': 'main', 'level': 1,
}),
('pyro-server',
{'type' : 'yn',
# pyro is only a recommends by default, so don't activate it here
'default': False,
'help': 'run a pyro server',
'group': 'main', 'level': 1,
}),
) + WebConfiguration.options)
def server_file(self):
return join(self.apphome, '%s-%s.py' % (self.appid, self.name))
def default_base_url(self):
from socket import gethostname
return 'http://%s:%s/' % (self['host'] or gethostname(), self['port'] or 8080)
try:
from cubicweb.server.serverconfig import ServerConfiguration
class AllInOneConfiguration(TwistedConfiguration, ServerConfiguration):
"""repository and web instance in the same twisted process"""
name = 'all-in-one'
repo_method = 'inmemory'
options = merge_options(TwistedConfiguration.options
+ ServerConfiguration.options)
cubicweb_appobject_path = TwistedConfiguration.cubicweb_appobject_path | ServerConfiguration.cubicweb_appobject_path
cube_appobject_path = TwistedConfiguration.cube_appobject_path | ServerConfiguration.cube_appobject_path
def pyro_enabled(self):
"""tell if pyro is activated for the in memory repository"""
return self['pyro-server']
except ImportError:
pass