1.1 new file mode 100644
     1.2 --- /dev/null
     1.3 +++ b/CHANGES.txt
     1.4 @@ -0,0 +1,449 @@
     1.5 +============
     1.6 +Five Changes
     1.7 +============
     1.8 +
     1.9 +Five 1.3c (unreleased)
    1.10 +======================
    1.11 +
    1.12 +This version is also included in Zope 2.9b1.
    1.13 +
    1.14 +Restructuring
    1.15 +-------------
    1.16 +
    1.17 +* (b6) Added ``original`` parameter to ObjectCopiedEvent backported from
    1.18 +  Zope 3.2
    1.19 +
    1.20 +* (b4) Cleaned up security test.
    1.21 +
    1.22 +* (b4) Made Five send a ContainerModifiedEvent when appropriate.
    1.23 +
    1.24 +Bugfixes
    1.25 +--------
    1.26 +
    1.27 +* (b6) Added backward compatibility for old _setObject and _delObject
    1.28 +  implementations without suppress_events.
    1.29 +
    1.30 +* (b3) Made the creation of custom skins work again.  It was broken in
    1.31 +  the port to Zope 3.2.
    1.32 +
    1.33 +* (b2) Fixed bug that broke WebDAV access for five:defaultViewable
    1.34 +  objects. The __browser_default__ now modifies only GET and POST
    1.35 +  requests.
    1.36 +
    1.37 +* (b2) Fixed some event recursion compatibility modes.
    1.38 +
    1.39 +Five 1.3b2 (2005-11-10)
    1.40 +=======================
    1.41 +
    1.42 +This version is also included in Zope 2.9b1.
    1.43 +
    1.44 +Changes compared to Five 1.3b:
    1.45 +
    1.46 +Bugfixes
    1.47 +--------
    1.48 +
    1.49 +* Fixed bug that broke WebDAV access for five:defaultViewable objects. The
    1.50 +  __browser_default__ now modifies only GET and POST requests.
    1.51 +
    1.52 +* Fixed some event recursion compatibility modes.
    1.53 +
    1.54 +Five 1.3b (2005-11-02)
    1.55 +======================
    1.56 +
    1.57 +Restructuring
    1.58 +-------------
    1.59 +
    1.60 +* Support for Zope 3.2 was added. Five now requires Zope 2.9 (which
    1.61 +  ships with Zope 3.2).
    1.62 +
    1.63 +* As scheduled, the temporary fork of the new test runner
    1.64 +  (``zope.testing``) at ``Five.testing`` was removed.  So was the
    1.65 +  ``runtests.py`` script.  Use the regular Zope test runner
    1.66 +  (``test.py`` or ``bin/zopectl test``) to run tests.
    1.67 +
    1.68 +* To reflect the Component Architecture simplification in Zope 3 since
    1.69 +  the X3 3.0 release, ``IFiveUtilityService`` was renamed to
    1.70 +  ``IFiveUtilityRegistry`` and ``SimpleLocalUtilityService`` was
    1.71 +  renamed to ``SimpleLocalUtilityRegistry``.  The old names are still
    1.72 +  available for a short period of time.
    1.73 +
    1.74 +* Event support: ``<five:containerEvents/>`` is the default.
    1.75 +
    1.76 +* Due to an incompatability with Zope 3.2's ObjectWidget and Zope 2's
    1.77 +  Page Templates, Five now ships with its own ObjectWidget
    1.78 +  implementation (which is just a thin wrapper around Zope's one to
    1.79 +  make it work in Zope 2).  If you use the ObjectWidget, please change
    1.80 +  your imports to ``Products.Five.form.objectwidget.ObjectWidget``.
    1.81 +
    1.82 +* Backwards compatability for Zope 3-style interfaces of Zope 2
    1.83 +  components has been removed as that functionality is now in the Zope
    1.84 +  2 core as of Zope 2.9.
    1.85 +
    1.86 +Five 1.2 (unreleased)
    1.87 +=====================
    1.88 +
    1.89 +Bugfixes
    1.90 +--------
    1.91 +
    1.92 +* Fixed bug that broke WebDAV access for five:defaultViewable objects. The
    1.93 +  __browser_default__ now modifies only GET and POST requests.
    1.94 +
    1.95 +* Fixed some event recursion compatibility modes.
    1.96 +
    1.97 +* Fixed loops in zcml loading due to events in some cases.
    1.98 +
    1.99 +* Made Five send a ContainerModifiedEvent when appropriate.
   1.100 +
   1.101 +Restructuring
   1.102 +-------------
   1.103 +
   1.104 +* Cleaned up security test.
   1.105 +
   1.106 +* Added monkey so that ++skin++ works with Zope <= 2.8.4.
   1.107 +
   1.108 +Five 1.2b (2005-11-02)
   1.109 +======================
   1.110 +
   1.111 +Features
   1.112 +--------
   1.113 +
   1.114 +* Added IMarkerInterfaces adapter: This adapter provides methods for
   1.115 +  inspecting and assigning marker interfaces. 'edit-markers.html' (or
   1.116 +  'manage_interfaces' in the ZMI) allows to change the behavior of specific
   1.117 +  objects by adding or removing marker interfaces TTW.
   1.118 +
   1.119 +* Added the five:registerClass directive: This does the necessary Zope 2
   1.120 +  registration for Five-based content. It is no longer necessary to add an
   1.121 +  ``initialize()`` function to the product's __init__ in order to register
   1.122 +  a meta type to be addable through the ZMI. See doc/products/ViewsTutorial
   1.123 +  for an example how to use the directive.
   1.124 +
   1.125 +* Local site support: Five has now support for creating local sites
   1.126 +  and thereby local utilities. This is mostly needed for allowing CMF
   1.127 +  to convert it's portal tools into local utilities.  See
   1.128 +  doc/localsite.txt for more information
   1.129 +
   1.130 +* Event support: When ``<five:containerEvents/>`` is specified, Five
   1.131 +  makes the standard Zope 2 containers send events instead of using
   1.132 +  manage_afterAdd, manage_beforeDelete and manage_afterClone. These
   1.133 +  methods are still called for a class declared
   1.134 +  ``<five:deprecatedManageAddDelete class=.../>``, and are called in
   1.135 +  compatibility mode with a deprecation warning for classes that don't
   1.136 +  use this directive.
   1.137 +
   1.138 +Restructuring
   1.139 +-------------
   1.140 +
   1.141 +* Removed backwards compatibility for Five 1.0 Zope core interfaces.
   1.142 +
   1.143 +* Removed backwards compatibility for Zope 2.7 and 2.8.0.
   1.144 +
   1.145 +* Added a (temporarily) forked copy of the "new-and-improved" test
   1.146 +  runner and supporting ``zope.testing`` package, lifted from
   1.147 +  http://svn.zope.org/zope.testing.  This code should be removed for
   1.148 +  Five 1.3, which will use the updated version of ``zope.testing`` in
   1.149 +  the Zope 2.9 / Zope 3.2 tree.
   1.150 +
   1.151 +  There is a test runner invoking script in the ``Five`` package.  For
   1.152 +  example, to run the Five tests with the new test runner, simply
   1.153 +  execute the following command line from your instance home::
   1.154 +
   1.155 +    $ bin/zopectl run Products/Five/runtests.py -v -s Products.Five
   1.156 +
   1.157 +* Moved the ``Five.testing`` package down to ``Five.tests.testing``,
   1.158 +  in order to make room for the 'zope.testing' code.
   1.159 +
   1.160 +* Removed backwards compatibility for some moved classes (AddForm,
   1.161 +  EditForm, ContentAdding)
   1.162 +
   1.163 +Five 1.1 (2005-10-04)
   1.164 +=====================
   1.165 +
   1.166 +Features
   1.167 +--------
   1.168 +
   1.169 +* When Zope was not in debug mode, an error in a ZCML file would cause Five to
   1.170 +  stop loading ZCML completely, making all subsequent products "dead". The
   1.171 +  effect would typically be that objects appeared to have no views at all. 
   1.172 +  Now a ZCML error will only stop the ZCML loading for that product, but the 
   1.173 +  rest of the products will load as usual. A traceback will still be printed 
   1.174 +  in the event log.
   1.175 +
   1.176 +  In debug mode the behaviour has not changed; a ZCML error will stop Zope 
   1.177 +  startup completely, and print a traceback if running in foreground mode.
   1.178 +  
   1.179 +Restructuring
   1.180 +-------------
   1.181 +
   1.182 +* The deprecated FivePageTemplateFile was removed, and the erroneous use of 
   1.183 +  this by EditView was changed.
   1.184 +
   1.185 +Bugfixes
   1.186 +--------
   1.187 +
   1.188 +* Repaired 'forms.txt' test which expected an error page when passing
   1.189 +  'handle_errors' as False;  it now expects an Unauthorized traceback.
   1.190 +  Note that this test fails on Zope 2.8.1, which incorrectly ignored
   1.191 +  'handle_errors'.
   1.192 +
   1.193 +* FiveTraversable should only do a view lookup and not call the traverse 
   1.194 +  method of its superclass.
   1.195 +
   1.196 +* Fixed manage_beforeDelete triggering for classes using five:sendEvents.
   1.197 +
   1.198 +* The redefinePermission directive was falsely registered under the
   1.199 +  ``zope`` namespace, not the ``meta`` namespace as it is in Zope 3.
   1.200 +
   1.201 +* Some parts of add.pt and edit.pt were not translated correctly or not
   1.202 +  translated at all. The fix depends on TAL changes in Zope 2.8.1 and changes
   1.203 +  in Zope X3-3.0.1 (shipped with 2.8.1). Form i18n is still broken with older
   1.204 +  Zope versions.
   1.205 +
   1.206 +* 'zope' domain translations are now set up by default. Form i18n needs them.
   1.207 +
   1.208 +* Added backwards compatibility for some moved classes (AddForm, EditForm, 
   1.209 +  ContentAdding)
   1.210 +
   1.211 +* The ZPT variable 'container' makes little sense in Zope3/Five, but is now
   1.212 +  always set to be the same as 'here' which is normal Zope2 behaviour.
   1.213 +  It is in Five 1.0.x set to be the same as 'view' which breaks some templates.
   1.214 +  
   1.215 +* In some hard to replicate cases, using the "modules" variable in ZPT cause
   1.216 +  an AuthenticationError. Using the secure module importer fixes this.
   1.217 +
   1.218 +* If you used some parts of Zope 3 (for example the mail delivery) Five 1.1
   1.219 +  transaction backport would conflict with Zope 3s transaction module.
   1.220 +  This is now solved.
   1.221 +
   1.222 +Five 1.1b (2005-07-13)
   1.223 +======================
   1.224 +
   1.225 +Features
   1.226 +--------
   1.227 +
   1.228 +* Zope 3-style i18n support has been provided.  Apart from being able
   1.229 +  to register translations through ZCML, Five now lets Zope 2 ZPTs
   1.230 +  automatically use Zope 3 translation domains.  Fallback to an
   1.231 +  old-style translation service (e.g. Localizer or PTS) is supported.
   1.232 +  This also includes the detection of preferred languages.  See
   1.233 +  ``doc/i18n.txt`` for more information.
   1.234 +
   1.235 +* Added support for Zope 3 -> Zope 2 interface bridging.  This
   1.236 +  functionality will be part of Zope 2.9, with Five you can already
   1.237 +  use it in Zope 2.7/2.8.  Since Zope 2 interfaces are rarely used and
   1.238 +  their Zope 3 equivalents are more meaningful (for the Component
   1.239 +  Architecture), the preferred way of dealing with interface migration
   1.240 +  is to write Zope 3 interfaces and bridge them to Zope 2 ones as
   1.241 +  needed.  To bridge, use the ``Interface.bridge.fromZ3Interface()``
   1.242 +  function.
   1.243 +
   1.244 +* Support for the standard <factory />, <modulealias /> and <hook />
   1.245 +  ZCML directives was added.
   1.246 +
   1.247 +* The default browser view name for all objects is now 'index.html',
   1.248 +  just as it is in Zope 3.  This means that a view by that name will
   1.249 +  be looked up if no specific view name is given in the URL.
   1.250 +
   1.251 +Restructuring
   1.252 +-------------
   1.253 +
   1.254 +* Restructured the Five source code to be easier to navigate in.
   1.255 +  Three subpackages were created, Five.browser, Five.form and
   1.256 +  Five.skin.
   1.257 +
   1.258 +* The former test product, ``FiveTest``, was converted into separate
   1.259 +  modules that provide the mock objects for the corresponding tests
   1.260 +  and are located right next to them.  Common test helpers have been
   1.261 +  moved to the Five.testing package.  Overall, the testing framework
   1.262 +  was much simplified and the individual tests clean up after
   1.263 +  themselves much like they do in Zope 3.
   1.264 +
   1.265 +* Relocated Zope core interfaces. Future Zope versions will ship with their
   1.266 +  own z3 interfaces. Five now patches the older Zope versions to make sure
   1.267 +  you can always find the interfaces in 'AccessControl.interfaces',
   1.268 +  'Acquisition.interfaces', 'App.interfaces', 'OFS.interfaces' and
   1.269 +  'webdav.interfaces'. Please don't use the aliases in 'Five.interfaces' or
   1.270 +  'Five.bbb.*interfaces' - they are only provided for backwards
   1.271 +  compatibility.
   1.272 +
   1.273 +* Zope 2.8 HTTPRequest is no longer patched. It has the required methods.
   1.274 +
   1.275 +Bugfixes
   1.276 +--------
   1.277 +
   1.278 +* The ZPT variable 'container' did not always contain the parent object
   1.279 +  of the context.
   1.280 +
   1.281 +* The deprecated get_transaction method is no longer used in Zope 2.8.
   1.282 +
   1.283 +Five 1.0.2 (2005-07-12)
   1.284 +=======================
   1.285 +
   1.286 +This version is also included in Zope 2.8.1
   1.287 +
   1.288 +* Fixed some issues with bridged interfaces: Bases and Methods were not
   1.289 +  bridged correctly. extends() was never True.
   1.290 +
   1.291 +* zope.security.checkPermission now behaves exactly like
   1.292 +  Five.security.checkPermission (in fact, the former now calls the
   1.293 +  latter through the indirection of Zope 3 security policies).
   1.294 +
   1.295 +* Fixed a bug with resource directories.  Resources within those were
   1.296 +  not rendering their absolute URL correctly.
   1.297 +
   1.298 +Five 1.0.1 (2005-05-31)
   1.299 +=======================
   1.300 +
   1.301 +This version is also included in Zope 2.8.0
   1.302 +
   1.303 +* Changed license headers to the ones used in the Zope.org repository.
   1.304 +  This makes merging between the main development line of Five (hosted
   1.305 +  on codespeak.net) and the version integrated into Zope 2.8 much
   1.306 +  easier.  The actual copyright ownership isn't affected because Five
   1.307 +  had been contributed to the Zope project anyway (which was blessed
   1.308 +  by all Five contributors).
   1.309 +
   1.310 +* Made automatically generated add and edit forms unicode-aware.
   1.311 +  ZPublisher does not automatically decode incoming form values to
   1.312 +  unicode, so AddView and EditView emulate this behaviour themselves
   1.313 +  now.  They also take care of setting the right charset on the
   1.314 +  outgoing form so that ZPublisher will encode it accordingly when
   1.315 +  sending the response to the client.  (In Zope 3, all charset
   1.316 +  negotation between the client and the server takes place in the
   1.317 +  publisher.)
   1.318 +
   1.319 +* Added ``IHTTPCharset`` adapter for ``IHTTPRequest`` so that
   1.320 +  application can find out the preferred character set of the HTTP
   1.321 +  client (Zope 2 applications needs to take care of their own charset
   1.322 +  header).  The adapter is used for the automatically-generated forms
   1.323 +  when determining encodings for unicode field content.
   1.324 +
   1.325 +* Modified edit.pt to make sure editforms have only one body tag.
   1.326 +
   1.327 +* Fixed the ``INameChooser`` adapter for ObjectManagers (e.g. Zope 2
   1.328 +  folders) and added unit tests.
   1.329 +
   1.330 +* Fixed small bug in BrowserDefault which caused an error if the class is
   1.331 +  defaultViewable but the object's interfaces have no defaultView.
   1.332 +
   1.333 +Five 1.0 (2005-04-27)
   1.334 +=====================
   1.335 +
   1.336 +Features
   1.337 +--------
   1.338 +
   1.339 +* Zope 3 style ``ISized`` adapters for objects are now exposed to the
   1.340 +  ZMI and other Zope 2 frameworks via the known ``get_size`` method,
   1.341 +  provided this is turned for the class in question via the
   1.342 +  five:sizable ZCML directive.
   1.343 +
   1.344 +* There is now a standard standard_macros. Five page templates can use
   1.345 +  context/@@standard_macros/view to get the default site layout, and
   1.346 +  people can register their own standard_macros in a skin.
   1.347 +
   1.348 +* The addform and editform directive now supports the widget ZCML
   1.349 +  subdirective, which previously was ignored.
   1.350 +
   1.351 +* Five now supports the vocabulary ZCML directive.
   1.352 +
   1.353 +Bugfixes
   1.354 +--------
   1.355 +
   1.356 +* Add and edit forms are now protected properly.
   1.357 +
   1.358 +* The checkbox widget did not work correctly in its off state, this
   1.359 +  has been fixed.
   1.360 +
   1.361 +Five 0.3 (2005-03-11)
   1.362 +=====================
   1.363 +
   1.364 +* Five now uses the Zope 2 page template engine, not the Zope 3
   1.365 +  engine. This allows better integration with Zope 2-based page
   1.366 +  templates, such as macros.
   1.367 +
   1.368 +  It uses TrustedExecutables technology (thanks to Dieter Maurer) to
   1.369 +  turn off Zope 2 security in page templates, so Five's security
   1.370 +  behavior is very similar to what it was before.
   1.371 +
   1.372 +* Five now supports the browser:menu, menuItem and menuItems
   1.373 +  directives.
   1.374 +
   1.375 +* A new Five-specific directive has been added:
   1.376 +  five:pagesFromDirectory.  This adds one page for each .pt file in a
   1.377 +  directory to the specified interface. This is useful for Five
   1.378 +  integration with CMF and other systems that have Page Templates
   1.379 +  macros that need to be shared between Zope2 and Five.
   1.380 +
   1.381 +* Five.security.checkPermission has been changed from a (unused)
   1.382 +  method for checking the existence of permissions. Use
   1.383 +  zope.app.security.permission.checkPermission if you need that
   1.384 +  functionality.
   1.385 +
   1.386 +  Instead Five.security.checkPermission is now a Five version of
   1.387 +  zope.security.checkPermission, which checks if the current user has
   1.388 +  a permission on an object.
   1.389 +
   1.390 +* Support for browser:editform. You can now use schemas for editing.
   1.391 +
   1.392 +* Support for browser:addform; add forms using '+'. You can now browse
   1.393 +  to 'container/+/addsomething.html' to get to a schema-driven add
   1.394 +  form.
   1.395 +
   1.396 +* Fixed a traversal bug which caused Zope to give the wrong error when
   1.397 +  a page could not be found (missing docstring instead of not
   1.398 +  found). Zope 2.7.4 (or higher) is required for this fix.
   1.399 +
   1.400 +Five 0.2b (2004-09-24)
   1.401 +======================
   1.402 +
   1.403 +* Added utility module, 'bridge', allowing reuse of Zope 2 interfaces
   1.404 +  (by introspecting them to create equivalent Zope 3 interfaces).
   1.405 +
   1.406 +* five:viewable was renamed to five:traversable, five:viewable still
   1.407 +  works but is deprecated; a deprecation warning is emitted when it is
   1.408 +  used.
   1.409 +
   1.410 +* like in Zope3, an ITraverser adapter is looked up to determine what
   1.411 +  happens when traversing into a Five traversable object.
   1.412 +
   1.413 +* added five:defaultViewable to make instances of a class directly
   1.414 +  viewable using browser:defaultView. This is hookable by the use of a
   1.415 +  IBrowserDefault adapter
   1.416 +
   1.417 +* deprecated use of Products.Five.api as public API for other products
   1.418 +  to use, instead import directly from Products.Five. Retired
   1.419 +  Traversable and Viewable from the public API; use ZCML directives
   1.420 +  (five:traversable, five:defaultView) instead of mixins to make
   1.421 +  instances of classes work with Five.
   1.422 +
   1.423 +* classes that Five monkeypatches now have a __five_method__
   1.424 +  attribute, making it easier for Five not to stomp on existing methods.
   1.425 +
   1.426 +* registered absolute_url view and IAbsoluteURL adapter for *
   1.427 +
   1.428 +* zope.app.traversing is registered by default, to make special
   1.429 +  namespaces available (eg: @@, ++resource++)
   1.430 +
   1.431 +* we now have resources (FileResource, ImageResource,
   1.432 +  PageTemplateResource) and directory resources.
   1.433 +
   1.434 +* Zope 3 'StandardMacros' now works with Five as well.
   1.435 +
   1.436 +* browser:page now correctly handles the allow_attributes and protects
   1.437 +  the named attributes on the view with the same permission used for
   1.438 +  the view.
   1.439 +
   1.440 +* zopeconf.py will try to find etc/zope.conf on INSTANCE_HOME. This
   1.441 +  requires Zope 2.7.2, as earlier Zope versions have a bug in this
   1.442 +  area which causes them to look in lib/python/Testing.
   1.443 +
   1.444 +* Exposed the Zope 3 event system to Five. A class can be made to send
   1.445 +  out event notifications using the five:sendEvents directive. Events can
   1.446 +  be subscribed to using the subscriber directive.
   1.447 +
   1.448 +* Change in findProducts so that non-filesystem products are skipped.
   1.449 +
   1.450 +Five 0.1 (2004-07-30)
   1.451 +=====================
   1.452 +
   1.453 +Initial public release (mainly Martijn's work)

     2.1 new file mode 100644
     2.2 --- /dev/null
     2.3 +++ b/COPYING.txt
     2.4 @@ -0,0 +1,16 @@
     2.5 +Five is distributed under the provisions of the Zope Public License
     2.6 +(ZPL) v2.1.  See doc/ZopePublicLicense.txt for the license text.
     2.7 +
     2.8 +Copyright (C) 2005 Five Contributors. See CREDITS.txt for a list of
     2.9 +Five contributors.
    2.10 +
    2.11 +Five contains source code derived from:
    2.12 +
    2.13 +- Zope 3, copyright (C) 2001-2005 by Zope Corporation.
    2.14 +
    2.15 +- metaclass.py is derived from PEAK, copyright (C) 1996-2004 by
    2.16 +  Phillip J. Eby and Tyler C. Sarna. PEAK may be used under the same
    2.17 +  terms as Zope.
    2.18 +
    2.19 +- TrustedExecutables. Dieter Mauer kindly allow licensing this under the
    2.20 +  ZPL 2.1.

     3.1 new file mode 100644
     3.2 --- /dev/null
     3.3 +++ b/CREDITS.txt
     3.4 @@ -0,0 +1,54 @@
     3.5 +Five contributors
     3.6 +-----------------
     3.7 +
     3.8 +- Martijn Faassen (faassen@infrae.com)
     3.9 +
    3.10 +- Sidnei da Silva (sidnei@awkly.org)
    3.11 +
    3.12 +- Philipp von Weitershausen (philikon@philikon.de)
    3.13 +
    3.14 +- Lennart Regebro (regebro@nuxeo.com)
    3.15 +
    3.16 +- Tres Seaver (tseaver@palladion.com)
    3.17 +
    3.18 +- Jan-Wijbrand Kolman (jw@infrae.com)
    3.19 +
    3.20 +- Stefan Holek (ssh@epy.co.at)
    3.21 +
    3.22 +- Florent Guillaume (fg@nuxeo.com)
    3.23 +
    3.24 +- Godefroid Chapelle (gotcha@bubblenet.be)
    3.25 +
    3.26 +- Andy Adiwidjaja (mail@adiwidjaja.com)
    3.27 +
    3.28 +- Stuart Bishop (stuart@stuartbishop.net)
    3.29 +
    3.30 +- Simon Eisenmann (simon@struktur.de)
    3.31 +
    3.32 +- Dieter Maurer (dieter@handshake.de)
    3.33 +
    3.34 +- Yvo Schubbe (y.2005-@wcm-solutions.de)
    3.35 +
    3.36 +- Malcolm Cleaton (malcolm@jamkit.com)
    3.37 +
    3.38 +- Tarek Ziadé (tziade@nuxeo.com)
    3.39 +
    3.40 +- Whit Morriss (whit@longnow.org)
    3.41 +
    3.42 +
    3.43 +Thank you
    3.44 +---------
    3.45 +
    3.46 +Infrae for the initial development and continuing support.
    3.47 +
    3.48 +Martijn Faassen would like to thank ETH Zurich for their support and
    3.49 +encouragement during the initial development of Five. 
    3.50 +
    3.51 +Nuxeo for significant contributions to making Five usable in the real
    3.52 +world.
    3.53 +
    3.54 +Dieter Maurer for use of code from TrustedExecutables within Five
    3.55 +under the ZPL.
    3.56 +
    3.57 +The Five developers would like to thank the Zope 3 developers, in
    3.58 +particular Jim Fulton, for the mountain to stand on.

     4.1 new file mode 100644
     4.2 --- /dev/null
     4.3 +++ b/INSTALL.txt
     4.4 @@ -0,0 +1,39 @@
     4.5 +How to install Five
     4.6 +===================
     4.7 +
     4.8 +Requirements for Five 1.2
     4.9 +-------------------------
    4.10 +
    4.11 +* Zope 2.8.1+ with Python 2.3.x.  Zope 2.8.5+ is recommended as it
    4.12 +  contains a bugfix regarding Zope 3-style skins.
    4.13 +
    4.14 +Note that Five 1.0 is already part of Zope 2.8.  This doesn't matter,
    4.15 +though, you can still install Five 1.2 into your Zope 2.8 instances.
    4.16 +It will override Zope's older version of Five.
    4.17 +
    4.18 +
    4.19 +Compatability matrix
    4.20 +--------------------
    4.21 +
    4.22 +The following table shows which Five version can and should be used
    4.23 +with which Zope 2 and Zope 3 versions.
    4.24 +
    4.25 +============ ======================= =========== ========
    4.26 +.                    Zope 2.7         Zope 2.8   Zope 2.9
    4.27 +------------ ----------------------- ----------- --------
    4.28 +.            Zope X3 3.0 (not incl.) Zope X3 3.0 Zope 3.2
    4.29 +============ ======================= =========== ========
    4.30 +Five 1.0                X             included
    4.31 +Five 1.1[#]_            X                 X
    4.32 +Five 1.2                                  X
    4.33 +Five 1.3                                         included
    4.34 +============ ======================= =========== ========
    4.35 +
    4.36 +.. [#] This branch is no longer actively maintained.
    4.37 +
    4.38 +
    4.39 +Running the tests
    4.40 +-----------------
    4.41 +
    4.42 +For information on how to install the automatic Five tests, please see
    4.43 +``tests/README.txt``.

     5.1 new file mode 100644
     5.2 --- /dev/null
     5.3 +++ b/README.txt
     5.4 @@ -0,0 +1,51 @@
     5.5 +Introduction
     5.6 +------------
     5.7 +
     5.8 +"It was the dawn of the third age of Zope. The Five project was a dream
     5.9 +given form. Its goal: to use Zope 3 technologies in Zope 2.7 by
    5.10 +creating a Zope 2 product where Zope 3 and Zope 2 could work out their
    5.11 +differences peacefully." -- Babylon 5, creatively quoted
    5.12 +
    5.13 +"The Law of Fives states simply that: ALL THINGS HAPPEN IN FIVES, OR
    5.14 +ARE DIVISIBLE BY OR ARE MULTIPLES OF FIVE, OR ARE SOMEHOW DIRECTLY OR
    5.15 +INDIRECTLY RELATED TO FIVE.
    5.16 +
    5.17 +THE LAW OF FIVES IS NEVER WRONG." -- Principia Discordia
    5.18 +
    5.19 +What is Five?
    5.20 +-------------
    5.21 +
    5.22 +The goal of five is to allow Zope 2 developers to use Zope 3
    5.23 +technology right now, inside of Zope 2. Additionally, this allows a
    5.24 +gradual evolution of Zope 2 code to Zope 3.
    5.25 +
    5.26 +Five already makes the following Zope 3 technologies available in Zope
    5.27 +2:
    5.28 +
    5.29 +* Zope 3 interfaces
    5.30 +
    5.31 +* ZCML (Zope Configuration Markup Language)
    5.32 +
    5.33 +* Adapters
    5.34 +
    5.35 +* Zope 3 views, even for standard Zope objects
    5.36 +
    5.37 +* layers & skins
    5.38 +
    5.39 +* schema/forms machinery, including edit and add forms.
    5.40 +
    5.41 +* Zope 2 security declarations in ZCML instead of in Python code.
    5.42 +
    5.43 +Together with another product, CMFonFive, Five can integrate into CMF.
    5.44 +
    5.45 +For more information, see ``doc/features.txt``.
    5.46 +
    5.47 +How to install Five
    5.48 +-------------------
    5.49 +
    5.50 +See ``INSTALL.txt``.
    5.51 +
    5.52 +How to use Five
    5.53 +---------------
    5.54 +
    5.55 +Please see ``doc/manual.txt``.

     6.1 new file mode 100644
     6.2 --- /dev/null
     6.3 +++ b/__init__.py
     6.4 @@ -0,0 +1,33 @@
     6.5 +##############################################################################
     6.6 +#
     6.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
     6.8 +# All Rights Reserved.
     6.9 +#
    6.10 +# This software is subject to the provisions of the Zope Public License,
    6.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
    6.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
    6.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    6.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
    6.15 +# FOR A PARTICULAR PURPOSE.
    6.16 +#
    6.17 +##############################################################################
    6.18 +"""Initialize the Five product
    6.19 +
    6.20 +$Id: __init__.py 12884 2005-05-30 13:10:41Z philikon $
    6.21 +"""
    6.22 +import Acquisition
    6.23 +from Globals import INSTANCE_HOME
    6.24 +
    6.25 +import monkey
    6.26 +import zcml
    6.27 +
    6.28 +# trigger monkey patches
    6.29 +monkey.monkeyPatch()
    6.30 +
    6.31 +# public API provided by Five
    6.32 +# usage: from Products.Five import <something>
    6.33 +from browser import BrowserView
    6.34 +from skin.standardmacros import StandardMacros
    6.35 +
    6.36 +def initialize(context):
    6.37 +    zcml.load_site()

     7.1 new file mode 100644
     7.2 --- /dev/null
     7.3 +++ b/bbb/AccessControl_interfaces.py
     7.4 @@ -0,0 +1,235 @@
     7.5 +##############################################################################
     7.6 +#
     7.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
     7.8 +# All Rights Reserved.
     7.9 +#
    7.10 +# This software is subject to the provisions of the Zope Public License,
    7.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
    7.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
    7.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    7.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
    7.15 +# FOR A PARTICULAR PURPOSE.
    7.16 +#
    7.17 +##############################################################################
    7.18 +"""AccessControl z3 interfaces.
    7.19 +
    7.20 +$Id: AccessControl_interfaces.py 12884 2005-05-30 13:10:41Z philikon $
    7.21 +"""
    7.22 +from zope.interface import Attribute
    7.23 +from zope.interface import Interface
    7.24 +
    7.25 +
    7.26 +# XXX: might contain non-API methods and outdated comments;
    7.27 +#      not synced with ZopeBook API Reference;
    7.28 +#      based on AccessControl.Owned.Owned
    7.29 +class IOwned(Interface):
    7.30 +
    7.31 +    manage_owner = Attribute("""Manage owner view""")
    7.32 +
    7.33 +    def owner_info():
    7.34 +        """Get ownership info for display
    7.35 +        """
    7.36 +
    7.37 +    def getOwner(info=0):
    7.38 +        """Get the owner
    7.39 +
    7.40 +        If a true argument is provided, then only the owner path and id are
    7.41 +        returned. Otherwise, the owner object is returned.
    7.42 +        """
    7.43 +
    7.44 +    def getOwnerTuple():
    7.45 +        """Return a tuple, (userdb_path, user_id) for the owner.
    7.46 +
    7.47 +        o Ownership can be acquired, but only from the containment path.
    7.48 +
    7.49 +        o If unowned, return None.
    7.50 +        """
    7.51 +
    7.52 +    def getWrappedOwner():
    7.53 +        """Get the owner, modestly wrapped in the user folder.
    7.54 +
    7.55 +        o If the object is not owned, return None.
    7.56 +
    7.57 +        o If the owner's user database doesn't exist, return Nobody.
    7.58 +
    7.59 +        o If the owner ID does not exist in the user database, return Nobody.
    7.60 +        """
    7.61 +
    7.62 +    def changeOwnership(user, recursive=0):
    7.63 +        """Change the ownership to the given user.  If 'recursive' is
    7.64 +        true then also take ownership of all sub-objects, otherwise
    7.65 +        sub-objects retain their ownership information."""
    7.66 +
    7.67 +    def userCanTakeOwnership():
    7.68 +        """ """
    7.69 +
    7.70 +    def manage_takeOwnership(REQUEST, RESPONSE, recursive=0):
    7.71 +        """
    7.72 +        Take ownership (responsibility) for an object. If 'recursive'
    7.73 +        is true, then also take ownership of all sub-objects.
    7.74 +        """
    7.75 +
    7.76 +    def manage_changeOwnershipType(explicit=1,
    7.77 +                                   RESPONSE=None, REQUEST=None):
    7.78 +        """Change the type (implicit or explicit) of ownership.
    7.79 +        """
    7.80 +
    7.81 +    def _deleteOwnershipAfterAdd():
    7.82 +        """ """
    7.83 +
    7.84 +    def manage_fixupOwnershipAfterAdd():
    7.85 +        """ """
    7.86 +
    7.87 +
    7.88 +# XXX: might contain non-API methods and outdated comments;
    7.89 +#      not synced with ZopeBook API Reference;
    7.90 +#      based on AccessControl.PermissionMapping.RoleManager
    7.91 +class IPermissionMappingSupport(Interface):
    7.92 +
    7.93 +    def manage_getPermissionMapping():
    7.94 +        """Return the permission mapping for the object
    7.95 +
    7.96 +        This is a list of dictionaries with:
    7.97 +
    7.98 +          permission_name -- The name of the native object permission
    7.99 +
   7.100 +          class_permission -- The class permission the permission is
   7.101 +             mapped to.
   7.102 +        """
   7.103 +
   7.104 +    def manage_setPermissionMapping(permission_names=[],
   7.105 +                                    class_permissions=[], REQUEST=None):
   7.106 +        """Change the permission mapping
   7.107 +        """
   7.108 +
   7.109 +
   7.110 +# XXX: might contain non-API methods and outdated comments;
   7.111 +#      not synced with ZopeBook API Reference;
   7.112 +#      based on AccessControl.Role.RoleManager
   7.113 +class IRoleManager(IPermissionMappingSupport):
   7.114 +
   7.115 +    """An object that has configurable permissions"""
   7.116 +
   7.117 +    permissionMappingPossibleValues = Attribute("""Acquired attribute""")
   7.118 +
   7.119 +    def ac_inherited_permissions(all=0):
   7.120 +        """Get all permissions not defined in ourself that are inherited.
   7.121 +
   7.122 +        This will be a sequence of tuples with a name as the first item and an
   7.123 +        empty tuple as the second.
   7.124 +        """
   7.125 +
   7.126 +    def permission_settings(permission=None):
   7.127 +        """Return user-role permission settings. If 'permission' 
   7.128 +           is passed to the method then only the settings for 'permission'
   7.129 +           is returned.
   7.130 +        """
   7.131 +
   7.132 +    manage_roleForm = Attribute(""" """)
   7.133 +
   7.134 +    def manage_role(role_to_manage, permissions=[], REQUEST=None):
   7.135 +        """Change the permissions given to the given role"""
   7.136 +
   7.137 +    manage_acquiredForm = Attribute(""" """)
   7.138 +
   7.139 +    def manage_acquiredPermissions(permissions=[], REQUEST=None):
   7.140 +        """Change the permissions that acquire"""
   7.141 +
   7.142 +    manage_permissionForm = Attribute(""" """)
   7.143 +
   7.144 +    def manage_permission(permission_to_manage,
   7.145 +                          roles=[], acquire=0, REQUEST=None):
   7.146 +        """Change the settings for the given permission
   7.147 +
   7.148 +        If optional arg acquire is true, then the roles for the permission
   7.149 +        are acquired, in addition to the ones specified, otherwise the
   7.150 +        permissions are restricted to only the designated roles."""
   7.151 +
   7.152 +    def manage_access(REQUEST, **kw):
   7.153 +        """Return an interface for making permissions settings"""
   7.154 +
   7.155 +    def manage_changePermissions(REQUEST):
   7.156 +        """Change all permissions settings, called by management screen"""
   7.157 +
   7.158 +    def permissionsOfRole(role):
   7.159 +        """used by management screen"""
   7.160 +
   7.161 +    def rolesOfPermission(permission):
   7.162 +        """used by management screen"""
   7.163 +
   7.164 +    def acquiredRolesAreUsedBy(permission):
   7.165 +        """used by management screen"""
   7.166 +
   7.167 +
   7.168 +    # Local roles support
   7.169 +    # -------------------
   7.170 +    #
   7.171 +    # Local roles allow a user to be given extra roles in the context
   7.172 +    # of a particular object (and its children). When a user is given
   7.173 +    # extra roles in a particular object, an entry for that user is made
   7.174 +    # in the __ac_local_roles__ dict containing the extra roles.
   7.175 +
   7.176 +    __ac_local_roles__  = Attribute(""" """)
   7.177 +
   7.178 +    manage_listLocalRoles = Attribute(""" """)
   7.179 +
   7.180 +    manage_editLocalRoles = Attribute(""" """)
   7.181 +
   7.182 +    def has_local_roles():
   7.183 +        """ """
   7.184 +
   7.185 +    def get_local_roles():
   7.186 +        """ """
   7.187 +
   7.188 +    def users_with_local_role(role):
   7.189 +        """ """
   7.190 +
   7.191 +    def get_valid_userids():
   7.192 +        """ """
   7.193 +
   7.194 +    def get_local_roles_for_userid(userid):
   7.195 +        """ """
   7.196 +
   7.197 +    def manage_addLocalRoles(userid, roles, REQUEST=None):
   7.198 +        """Set local roles for a user."""
   7.199 +
   7.200 +    def manage_setLocalRoles(userid, roles, REQUEST=None):
   7.201 +        """Set local roles for a user."""
   7.202 +
   7.203 +    def manage_delLocalRoles(userids, REQUEST=None):
   7.204 +        """Remove all local roles for a user."""
   7.205 +
   7.206 +    #------------------------------------------------------------
   7.207 +
   7.208 +    def access_debug_info():
   7.209 +        """Return debug info"""
   7.210 +
   7.211 +    def valid_roles():
   7.212 +        """Return list of valid roles"""
   7.213 +
   7.214 +    def validate_roles(roles):
   7.215 +        """Return true if all given roles are valid"""
   7.216 +
   7.217 +    def userdefined_roles():
   7.218 +        """Return list of user-defined roles"""
   7.219 +
   7.220 +    def manage_defined_roles(submit=None, REQUEST=None):
   7.221 +        """Called by management screen."""
   7.222 +
   7.223 +    def _addRole(role, REQUEST=None):
   7.224 +        """ """
   7.225 +
   7.226 +    def _delRoles(roles, REQUEST=None):
   7.227 +        """ """
   7.228 +
   7.229 +    def _has_user_defined_role(role):
   7.230 +        """ """
   7.231 +
   7.232 +    def manage_editRoles(REQUEST, acl_type='A', acl_roles=[]):
   7.233 +        """ """
   7.234 +
   7.235 +    def _setRoles(acl_type, acl_roles):
   7.236 +        """ """
   7.237 +
   7.238 +    def possible_permissions():
   7.239 +        """ """

     8.1 new file mode 100644
     8.2 --- /dev/null
     8.3 +++ b/bbb/Acquisition_interfaces.py
     8.4 @@ -0,0 +1,60 @@
     8.5 +##############################################################################
     8.6 +#
     8.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
     8.8 +# All Rights Reserved.
     8.9 +#
    8.10 +# This software is subject to the provisions of the Zope Public License,
    8.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
    8.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
    8.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    8.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
    8.15 +# FOR A PARTICULAR PURPOSE.
    8.16 +#
    8.17 +##############################################################################
    8.18 +"""Acquisition z3 interfaces.
    8.19 +
    8.20 +$Id: Acquisition_interfaces.py 12884 2005-05-30 13:10:41Z philikon $
    8.21 +"""
    8.22 +from zope.interface import Attribute
    8.23 +from zope.interface import Interface
    8.24 +
    8.25 +
    8.26 +class IAcquirer(Interface):
    8.27 +
    8.28 +    """Acquire attributes from containers."""
    8.29 +
    8.30 +    def __of__(context):
    8.31 +        """Get the object in a context."""
    8.32 +
    8.33 +
    8.34 +class IAcquisitionWrapper(Interface):
    8.35 +
    8.36 +    """Wrapper object for acquisition."""
    8.37 +
    8.38 +    def aq_acquire(name, filter=None, extra=None, explicit=True, default=0,
    8.39 +                   containment=0):
    8.40 +        """Get an attribute, acquiring it if necessary."""
    8.41 +
    8.42 +    def aq_inContextOf(obj, inner=1):
    8.43 +        """Test whether the object is currently in the context of the argument.
    8.44 +        """
    8.45 +
    8.46 +    aq_base = Attribute(
    8.47 +        """Get the object unwrapped."""
    8.48 +        )
    8.49 +
    8.50 +    aq_parent = Attribute(
    8.51 +        """Get the parent of an object."""
    8.52 +        )
    8.53 +
    8.54 +    aq_self = Attribute(
    8.55 +        """Get the object with the outermost wrapper removed."""
    8.56 +        )
    8.57 +
    8.58 +    aq_inner = Attribute(
    8.59 +        """Get the object with all but the innermost wrapper removed."""
    8.60 +        )
    8.61 +
    8.62 +    aq_chain = Attribute(
    8.63 +        """Get a list of objects in the acquisition environment."""
    8.64 +        )

     9.1 new file mode 100644
     9.2 --- /dev/null
     9.3 +++ b/bbb/App_interfaces.py
     9.4 @@ -0,0 +1,78 @@
     9.5 +##############################################################################
     9.6 +#
     9.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
     9.8 +# All Rights Reserved.
     9.9 +#
    9.10 +# This software is subject to the provisions of the Zope Public License,
    9.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
    9.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
    9.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    9.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
    9.15 +# FOR A PARTICULAR PURPOSE.
    9.16 +#
    9.17 +##############################################################################
    9.18 +"""App z3 interfaces.
    9.19 +
    9.20 +$Id: App_interfaces.py 12884 2005-05-30 13:10:41Z philikon $
    9.21 +"""
    9.22 +from zope.interface import Attribute
    9.23 +from zope.interface import Interface
    9.24 +
    9.25 +
    9.26 +# XXX: might contain non-API methods and outdated comments;
    9.27 +#      not synced with ZopeBook API Reference;
    9.28 +#      based on App.Management.Navigation
    9.29 +class INavigation(Interface):
    9.30 +
    9.31 +    """Basic navigation UI support"""
    9.32 +
    9.33 +    manage = Attribute(""" """)
    9.34 +    manage_menu = Attribute(""" """)
    9.35 +    manage_top_frame = Attribute(""" """)
    9.36 +    manage_page_header = Attribute(""" """)
    9.37 +    manage_page_footer = Attribute(""" """)
    9.38 +    manage_form_title = Attribute("""Add Form""")
    9.39 +    zope_quick_start = Attribute(""" """)
    9.40 +    manage_copyright = Attribute(""" """)
    9.41 +    manage_zmi_prefs = Attribute(""" """)
    9.42 +
    9.43 +    def manage_zmi_logout(REQUEST, RESPONSE):
    9.44 +        """Logout current user"""
    9.45 +
    9.46 +INavigation.setTaggedValue('manage_page_style.css', Attribute(""" """))
    9.47 +
    9.48 +
    9.49 +# XXX: might contain non-API methods and outdated comments;
    9.50 +#      not synced with ZopeBook API Reference;
    9.51 +#      based on App.PersistentExtra.PersistentUtil
    9.52 +class IPersistentExtra(Interface):
    9.53 +
    9.54 +    def bobobase_modification_time():
    9.55 +        """ """
    9.56 +
    9.57 +    def locked_in_version():
    9.58 +        """Was the object modified in any version?
    9.59 +        """
    9.60 +
    9.61 +    def modified_in_version():
    9.62 +        """Was the object modified in this version?
    9.63 +        """
    9.64 +
    9.65 +
    9.66 +# XXX: might contain non-API methods and outdated comments;
    9.67 +#      not synced with ZopeBook API Reference;
    9.68 +#      based on App.Undo.UndoSupport
    9.69 +class IUndoSupport(Interface):
    9.70 +
    9.71 +    manage_UndoForm = Attribute("""Manage Undo form""")
    9.72 +
    9.73 +    def get_request_var_or_attr(name, default):
    9.74 +        """ """
    9.75 +
    9.76 +    def undoable_transactions(first_transaction=None,
    9.77 +                              last_transaction=None,
    9.78 +                              PrincipiaUndoBatchSize=None):
    9.79 +        """ """
    9.80 +
    9.81 +    def manage_undo_transactions(transaction_info=(), REQUEST=None):
    9.82 +        """ """

    10.1 new file mode 100644
    10.2 --- /dev/null
    10.3 +++ b/bbb/OFS_event.py
    10.4 @@ -0,0 +1,61 @@
    10.5 +##############################################################################
    10.6 +#
    10.7 +# Copyright (c) 2005 Zope Corporation and Contributors.
    10.8 +# All Rights Reserved.
    10.9 +#
   10.10 +# This software is subject to the provisions of the Zope Public License,
   10.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   10.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   10.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   10.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   10.15 +# FOR A PARTICULAR PURPOSE.
   10.16 +#
   10.17 +##############################################################################
   10.18 +"""
   10.19 +OFS event definitions.
   10.20 +
   10.21 +$Id: OFS_event.py 19416 2005-11-02 15:18:34Z efge $
   10.22 +"""
   10.23 +
   10.24 +from zope.interface import implements
   10.25 +from zope.app.event.objectevent import ObjectEvent
   10.26 +import OFS_interfaces
   10.27 +
   10.28 +class ObjectWillBeMovedEvent(ObjectEvent):
   10.29 +    """An object will be moved."""
   10.30 +    implements(OFS_interfaces.IObjectWillBeMovedEvent)
   10.31 +
   10.32 +    def __init__(self, object, oldParent, oldName, newParent, newName):
   10.33 +        ObjectEvent.__init__(self, object)
   10.34 +        self.oldParent = oldParent
   10.35 +        self.oldName = oldName
   10.36 +        self.newParent = newParent
   10.37 +        self.newName = newName
   10.38 +
   10.39 +class ObjectWillBeAddedEvent(ObjectWillBeMovedEvent):
   10.40 +    """An object will be added to a container."""
   10.41 +    implements(OFS_interfaces.IObjectWillBeAddedEvent)
   10.42 +
   10.43 +    def __init__(self, object, newParent=None, newName=None):
   10.44 +        #if newParent is None:
   10.45 +        #    newParent = object.__parent__
   10.46 +        #if newName is None:
   10.47 +        #    newName = object.__name__
   10.48 +        ObjectWillBeMovedEvent.__init__(self, object, None, None,
   10.49 +                                        newParent, newName)
   10.50 +
   10.51 +class ObjectWillBeRemovedEvent(ObjectWillBeMovedEvent):
   10.52 +    """An object will be removed from a container."""
   10.53 +    implements(OFS_interfaces.IObjectWillBeRemovedEvent)
   10.54 +
   10.55 +    def __init__(self, object, oldParent=None, oldName=None):
   10.56 +        #if oldParent is None:
   10.57 +        #    oldParent = object.__parent__
   10.58 +        #if oldName is None:
   10.59 +        #    oldName = object.__name__
   10.60 +        ObjectWillBeMovedEvent.__init__(self, object, oldParent, oldName,
   10.61 +                                        None, None)
   10.62 +
   10.63 +class ObjectClonedEvent(ObjectEvent):
   10.64 +    """An object has been cloned into a container."""
   10.65 +    implements(OFS_interfaces.IObjectClonedEvent)

    11.1 new file mode 100644
    11.2 --- /dev/null
    11.3 +++ b/bbb/OFS_interfaces.py
    11.4 @@ -0,0 +1,771 @@
    11.5 +##############################################################################
    11.6 +#
    11.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
    11.8 +# All Rights Reserved.
    11.9 +#
   11.10 +# This software is subject to the provisions of the Zope Public License,
   11.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   11.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   11.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   11.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   11.15 +# FOR A PARTICULAR PURPOSE.
   11.16 +#
   11.17 +##############################################################################
   11.18 +"""OFS z3 interfaces.
   11.19 +
   11.20 +$Id: OFS_interfaces.py 19416 2005-11-02 15:18:34Z efge $
   11.21 +"""
   11.22 +from zope.interface import Attribute
   11.23 +from zope.interface import Interface
   11.24 +from zope.schema import Bool, BytesLine, Tuple
   11.25 +from zope.app.traversing.interfaces import IContainmentRoot
   11.26 +
   11.27 +from AccessControl_interfaces import IOwned
   11.28 +from AccessControl_interfaces import IRoleManager
   11.29 +from Acquisition_interfaces import IAcquirer
   11.30 +from App_interfaces import INavigation
   11.31 +from App_interfaces import IUndoSupport
   11.32 +from persistent.interfaces import IPersistent
   11.33 +from webdav_interfaces import IDAVCollection
   11.34 +from webdav_interfaces import IDAVResource
   11.35 +
   11.36 +
   11.37 +# create IOrderedContainer
   11.38 +from Products.Five.fiveconfigure import createZope2Bridge
   11.39 +from OFS.IOrderSupport import IOrderedContainer as z2IOrderedContainer
   11.40 +import OFS_interfaces
   11.41 +
   11.42 +createZope2Bridge(z2IOrderedContainer, OFS_interfaces, 'IOrderedContainer')
   11.43 +
   11.44 +del createZope2Bridge
   11.45 +del z2IOrderedContainer
   11.46 +del OFS_interfaces
   11.47 +
   11.48 +
   11.49 +# XXX: might contain non-API methods and outdated comments;
   11.50 +#      not synced with ZopeBook API Reference;
   11.51 +#      based on OFS.CopySupport.CopySource
   11.52 +class ICopySource(Interface):
   11.53 +
   11.54 +    """Interface for objects which allow themselves to be copied."""
   11.55 +
   11.56 +    def _canCopy(op=0):
   11.57 +        """Called to make sure this object is copyable. The op var
   11.58 +        is 0 for a copy, 1 for a move."""
   11.59 +
   11.60 +    def _notifyOfCopyTo(container, op=0):
   11.61 +        """Overide this to be pickly about where you go! If you dont
   11.62 +        want to go there, raise an exception. The op variable is
   11.63 +        0 for a copy, 1 for a move."""
   11.64 +
   11.65 +    def _getCopy(container):
   11.66 +        """ """
   11.67 +
   11.68 +    def _postCopy(container, op=0):
   11.69 +        """Called after the copy is finished to accomodate special cases.
   11.70 +        The op var is 0 for a copy, 1 for a move."""
   11.71 +
   11.72 +    def _setId(id):
   11.73 +        """Called to set the new id of a copied object."""
   11.74 +
   11.75 +    def cb_isCopyable():
   11.76 +        """Is object copyable? Returns 0 or 1"""
   11.77 +
   11.78 +    def cb_isMoveable():
   11.79 +        """Is object moveable? Returns 0 or 1"""
   11.80 +
   11.81 +    def cb_userHasCopyOrMovePermission():
   11.82 +        """ """
   11.83 +
   11.84 +
   11.85 +# XXX: might contain non-API methods and outdated comments;
   11.86 +#      not synced with ZopeBook API Reference;
   11.87 +#      based on OFS.FTPInterface.FTPInterface
   11.88 +class IFTPAccess(Interface):
   11.89 +
   11.90 +    """Provide support for FTP access"""
   11.91 +
   11.92 +    def manage_FTPstat(REQUEST):
   11.93 +        """Returns a stat-like tuple. (marshalled to a string) Used by
   11.94 +        FTP for directory listings, and MDTM and SIZE"""
   11.95 +
   11.96 +    def manage_FTPlist(REQUEST):
   11.97 +        """Returns a directory listing consisting of a tuple of
   11.98 +        (id,stat) tuples, marshaled to a string. Note, the listing it
   11.99 +        should include '..' if there is a Folder above the current
  11.100 +        one.
  11.101 +
  11.102 +        In the case of non-foldoid objects it should return a single
  11.103 +        tuple (id,stat) representing itself."""
  11.104 +
  11.105 +
  11.106 +# XXX: might contain non-API methods and outdated comments;
  11.107 +#      not synced with ZopeBook API Reference;
  11.108 +#      based on OFS.Traversable.Traversable
  11.109 +class ITraversable(Interface):
  11.110 +
  11.111 +    def absolute_url(relative=0):
  11.112 +        """Return the absolute URL of the object.
  11.113 +
  11.114 +        This a canonical URL based on the object's physical
  11.115 +        containment path.  It is affected by the virtual host
  11.116 +        configuration, if any, and can be used by external
  11.117 +        agents, such as a browser, to address the object.
  11.118 +
  11.119 +        If the relative argument is provided, with a true value, then
  11.120 +        the value of virtual_url_path() is returned.
  11.121 +
  11.122 +        Some Products incorrectly use '/'+absolute_url(1) as an
  11.123 +        absolute-path reference.  This breaks in certain virtual
  11.124 +        hosting situations, and should be changed to use
  11.125 +        absolute_url_path() instead.
  11.126 +        """
  11.127 +
  11.128 +    def absolute_url_path():
  11.129 +        """Return the path portion of the absolute URL of the object.
  11.130 +
  11.131 +        This includes the leading slash, and can be used as an
  11.132 +        'absolute-path reference' as defined in RFC 2396.
  11.133 +        """
  11.134 +
  11.135 +    def virtual_url_path():
  11.136 +        """Return a URL for the object, relative to the site root.
  11.137 +
  11.138 +        If a virtual host is configured, the URL is a path relative to
  11.139 +        the virtual host's root object.  Otherwise, it is the physical
  11.140 +        path.  In either case, the URL does not begin with a slash.
  11.141 +        """
  11.142 +
  11.143 +    def getPhysicalPath():
  11.144 +        '''Returns a path (an immutable sequence of strings)
  11.145 +        that can be used to access this object again
  11.146 +        later, for example in a copy/paste operation.  getPhysicalRoot()
  11.147 +        and getPhysicalPath() are designed to operate together.
  11.148 +        '''
  11.149 +
  11.150 +    def unrestrictedTraverse(path, default=None, restricted=0):
  11.151 +        """Lookup an object by path,
  11.152 +
  11.153 +        path -- The path to the object. May be a sequence of strings or a slash
  11.154 +        separated string. If the path begins with an empty path element
  11.155 +        (i.e., an empty string or a slash) then the lookup is performed
  11.156 +        from the application root. Otherwise, the lookup is relative to
  11.157 +        self. Two dots (..) as a path element indicates an upward traversal
  11.158 +        to the acquisition parent.
  11.159 +
  11.160 +        default -- If provided, this is the value returned if the path cannot
  11.161 +        be traversed for any reason (i.e., no object exists at that path or
  11.162 +        the object is inaccessible).
  11.163 +
  11.164 +        restricted -- If false (default) then no security checking is performed.
  11.165 +        If true, then all of the objects along the path are validated with
  11.166 +        the security machinery. Usually invoked using restrictedTraverse().
  11.167 +        """
  11.168 +
  11.169 +    def restrictedTraverse(path, default=None):
  11.170 +        """Trusted code traversal code, always enforces security"""
  11.171 +
  11.172 +
  11.173 +# XXX: might contain non-API methods and outdated comments;
  11.174 +#      not synced with ZopeBook API Reference;
  11.175 +#      based on many classes
  11.176 +class IZopeObject(Interface):
  11.177 +
  11.178 +    isPrincipiaFolderish = Bool(
  11.179 +        title=u"Is a folderish object",
  11.180 +        description=u"Should be false for simple items",
  11.181 +        )
  11.182 +
  11.183 +    meta_type = BytesLine(
  11.184 +        title=u"Meta type",
  11.185 +        description=u"The object's Zope2 meta type",
  11.186 +        )
  11.187 +
  11.188 +
  11.189 +# XXX: might contain non-API methods and outdated comments;
  11.190 +#      not synced with ZopeBook API Reference;
  11.191 +#      based on OFS.SimpleItem.Item and App.Management.Tabs
  11.192 +class IManageable(Interface):
  11.193 +
  11.194 +    """Something that is manageable in the ZMI"""
  11.195 +
  11.196 +    manage_tabs = Attribute("""Management tabs""")
  11.197 +
  11.198 +    manage_options = Tuple(
  11.199 +        title=u"Manage options",
  11.200 +        )
  11.201 +
  11.202 +    def manage(URL1):
  11.203 +        """Show management screen"""
  11.204 +
  11.205 +    def manage_afterAdd(item, container):
  11.206 +        """Gets called after being added to a container"""
  11.207 +
  11.208 +    def manage_beforeDelete(item, container):
  11.209 +        """Gets called before being deleted"""
  11.210 +
  11.211 +    def manage_afterClone(item):
  11.212 +        """Gets called after being cloned"""
  11.213 +
  11.214 +    def manage_editedDialog(REQUEST, **args):
  11.215 +        """Show an 'edited' dialog"""
  11.216 +
  11.217 +    def filtered_manage_options(REQUEST=None):
  11.218 +        """ """
  11.219 +
  11.220 +    def manage_workspace(REQUEST):
  11.221 +        """Dispatch to first interface in manage_options
  11.222 +        """
  11.223 +
  11.224 +    def tabs_path_default(REQUEST):
  11.225 +        """ """
  11.226 +
  11.227 +    def tabs_path_info(script, path):
  11.228 +        """ """
  11.229 +
  11.230 +    def class_manage_path():
  11.231 +        """ """
  11.232 +
  11.233 +
  11.234 +# XXX: might contain non-API methods and outdated comments;
  11.235 +#      not synced with ZopeBook API Reference;
  11.236 +#      based on OFS.SimpleItem.Item
  11.237 +class IItem(IZopeObject, IManageable, IFTPAccess, IDAVResource,
  11.238 +            ICopySource, ITraversable, IOwned, IUndoSupport):
  11.239 +
  11.240 +    __name__ = BytesLine(
  11.241 +        title=u"Name"
  11.242 +        )
  11.243 +
  11.244 +    title = BytesLine(
  11.245 +        title=u"Title"
  11.246 +        )
  11.247 +
  11.248 +    icon = BytesLine(
  11.249 +        title=u"Icon",
  11.250 +        description=u"Name of icon, relative to SOFTWARE_URL",
  11.251 +        )
  11.252 +
  11.253 +    def getId():
  11.254 +        """Return the id of the object as a string.
  11.255 +
  11.256 +        This method should be used in preference to accessing an id
  11.257 +        attribute of an object directly. The getId method is public.
  11.258 +        """
  11.259 +
  11.260 +    def title_or_id():
  11.261 +        """Returns the title if it is not blank and the id otherwise."""
  11.262 +
  11.263 +    def title_and_id():
  11.264 +        """Returns the title if it is not blank and the id otherwise.  If the
  11.265 +        title is not blank, then the id is included in parens."""
  11.266 +
  11.267 +    def raise_standardErrorMessage(client=None, REQUEST={},
  11.268 +                                   error_type=None, error_value=None, tb=None,
  11.269 +                                   error_tb=None, error_message='',
  11.270 +                                   tagSearch=None, error_log_url=''):
  11.271 +        """Raise standard error message"""
  11.272 +
  11.273 +
  11.274 +# XXX: based on OFS.SimpleItem.Item_w__name__
  11.275 +class IItemWithName(IItem):
  11.276 +
  11.277 +    """Item with name"""
  11.278 +
  11.279 +
  11.280 +# XXX: based on OFS.SimpleItem.SimpleItem
  11.281 +class ISimpleItem(IItem, IPersistent, IAcquirer, IRoleManager):
  11.282 +
  11.283 +    """Not-so-simple item"""
  11.284 +
  11.285 +
  11.286 +# XXX: might contain non-API methods and outdated comments;
  11.287 +#      not synced with ZopeBook API Reference;
  11.288 +#      based on OFS.CopySupport.CopyContainer
  11.289 +class ICopyContainer(Interface):
  11.290 +
  11.291 +    """Interface for containerish objects which allow cut/copy/paste"""
  11.292 +
  11.293 +    # The following three methods should be overridden to store sub-objects
  11.294 +    # as non-attributes.
  11.295 +    def _setOb(id, object):
  11.296 +        """ """
  11.297 +
  11.298 +    def _delOb(id):
  11.299 +        """ """
  11.300 +
  11.301 +    def _getOb(id, default=None):
  11.302 +        """ """
  11.303 +
  11.304 +    def manage_CopyContainerFirstItem(REQUEST):
  11.305 +        """ """
  11.306 +
  11.307 +    def manage_CopyContainerAllItems(REQUEST):
  11.308 +        """ """
  11.309 +
  11.310 +    def manage_cutObjects(ids=None, REQUEST=None):
  11.311 +        """Put a reference to the objects named in ids in the clip board"""
  11.312 +
  11.313 +    def manage_copyObjects(ids=None, REQUEST=None, RESPONSE=None):
  11.314 +        """Put a reference to the objects named in ids in the clip board"""
  11.315 +
  11.316 +    def _get_id(id):
  11.317 +        """Allow containers to override the generation of object copy id by
  11.318 +        attempting to call its _get_id method, if it exists."""
  11.319 +
  11.320 +    def manage_pasteObjects(cb_copy_data=None, REQUEST=None):
  11.321 +        """Paste previously copied objects into the current object.
  11.322 +           If calling manage_pasteObjects from python code, pass
  11.323 +           the result of a previous call to manage_cutObjects or
  11.324 +           manage_copyObjects as the first argument."""
  11.325 +
  11.326 +    manage_renameForm = Attribute("""Rename management view""")
  11.327 +
  11.328 +    def manage_renameObjects(ids=[], new_ids=[], REQUEST=None):
  11.329 +        """Rename several sub-objects"""
  11.330 +
  11.331 +    def manage_renameObject(id, new_id, REQUEST=None):
  11.332 +        """Rename a particular sub-object"""
  11.333 +
  11.334 +    def manage_clone(ob, id, REQUEST=None):
  11.335 +        """Clone an object, creating a new object with the given id."""
  11.336 +
  11.337 +    def cb_dataValid():
  11.338 +        """Return true if clipboard data seems valid."""
  11.339 +
  11.340 +    def cb_dataItems():
  11.341 +        """List of objects in the clip board"""
  11.342 +
  11.343 +    def _verifyObjectPaste(object, validate_src=1):
  11.344 +        """Verify whether the current user is allowed to paste the passed
  11.345 +        object into self. This is determined by checking to see if the
  11.346 +        user could create a new object of the same meta_type of the
  11.347 +        object passed in and checking that the user actually is
  11.348 +        allowed to access the passed in object in its existing
  11.349 +        context.
  11.350 +
  11.351 +        Passing a false value for the validate_src argument will skip
  11.352 +        checking the passed in object in its existing context. This is
  11.353 +        mainly useful for situations where the passed in object has no
  11.354 +        existing context, such as checking an object during an import
  11.355 +        (the object will not yet have been connected to the
  11.356 +        acquisition hierarchy)."""
  11.357 +
  11.358 +
  11.359 +# XXX: might contain non-API methods and outdated comments;
  11.360 +#      not synced with ZopeBook API Reference;
  11.361 +#      based on OFS.ObjectManager.ObjectManager
  11.362 +class IObjectManager(IZopeObject, ICopyContainer, INavigation, IManageable,
  11.363 +                     IAcquirer, IPersistent, IDAVCollection, ITraversable):
  11.364 +
  11.365 +    """Generic object manager
  11.366 +
  11.367 +    This interface provides core behavior for collections of heterogeneous
  11.368 +    objects.
  11.369 +    """
  11.370 +
  11.371 +    meta_types = Tuple(
  11.372 +        title=u"Meta types",
  11.373 +        description=u"Sub-object types that are specific to this object",
  11.374 +        )
  11.375 +
  11.376 +    isAnObjectManager = Bool(
  11.377 +        title=u"Is an object manager",
  11.378 +        )
  11.379 +
  11.380 +    manage_main = Attribute(""" """)
  11.381 +    manage_index_main = Attribute(""" """)
  11.382 +    manage_addProduct = Attribute(""" """)
  11.383 +    manage_importExportForm = Attribute(""" """)
  11.384 +
  11.385 +    def all_meta_types(interfaces=None):
  11.386 +        """ """
  11.387 +
  11.388 +    def _subobject_permissions():
  11.389 +        """ """
  11.390 +
  11.391 +    def filtered_meta_types(user=None):
  11.392 +        """Return a list of the types for which the user has adequate
  11.393 +        permission to add that type of object."""
  11.394 +
  11.395 +    def _setOb(id, object):
  11.396 +        """ """
  11.397 +
  11.398 +    def _delOb(id):
  11.399 +        """ """
  11.400 +
  11.401 +    def _getOb(id, default=None):
  11.402 +        """ """
  11.403 +
  11.404 +    def _setObject(id, object, roles=None, user=None, set_owner=1):
  11.405 +        """ """
  11.406 +
  11.407 +    def _delObject(id, dp=1):
  11.408 +        """ """
  11.409 +
  11.410 +    def objectIds(spec=None):
  11.411 +        """List the IDs of the subobjects of the current object.
  11.412 +
  11.413 +        If 'spec' is specified, returns only objects whose meta_types match
  11.414 +        'spec'.
  11.415 +        """
  11.416 +
  11.417 +    def objectValues(spec=None):
  11.418 +        """List the subobjects of the current object.
  11.419 +
  11.420 +        If 'spec' is specified, returns only objects whose meta_types match
  11.421 +        'spec'.
  11.422 +        """
  11.423 +
  11.424 +    def objectItems(spec=None):
  11.425 +        """List (ID, subobject) tuples for subobjects of the current object.
  11.426 +
  11.427 +        If 'spec' is specified, returns only objects whose meta_types match
  11.428 +        'spec'.
  11.429 +        """
  11.430 +
  11.431 +    def objectMap():
  11.432 +        """Return a tuple of mappings containing subobject meta-data"""
  11.433 +
  11.434 +    def superValues(t):
  11.435 +        """Return all of the objects of a given type located in this object
  11.436 +        and containing objects."""
  11.437 +
  11.438 +    def manage_delObjects(ids=[], REQUEST=None):
  11.439 +        """Delete a subordinate object
  11.440 +
  11.441 +        The objects specified in 'ids' get deleted.
  11.442 +        """
  11.443 +
  11.444 +    def tpValues():
  11.445 +        """Return a list of subobjects, used by tree tag."""
  11.446 +
  11.447 +    def manage_exportObject(id='', download=None, toxml=None,
  11.448 +                            RESPONSE=None,REQUEST=None):
  11.449 +        """Exports an object to a file and returns that file."""
  11.450 +
  11.451 +    def manage_importObject(file, REQUEST=None, set_owner=1):
  11.452 +        """Import an object from a file"""
  11.453 +
  11.454 +    def _importObjectFromFile(filepath, verify=1, set_owner=1):
  11.455 +        """ """
  11.456 +
  11.457 +    def __getitem__(key):
  11.458 +        """ """
  11.459 +
  11.460 +
  11.461 +# XXX: might contain non-API methods and outdated comments;
  11.462 +#      not synced with ZopeBook API Reference;
  11.463 +#      based on OFS.FindSupport.FindSupport
  11.464 +class IFindSupport(Interface):
  11.465 +
  11.466 +    """Find support for Zope Folders"""
  11.467 +
  11.468 +    manage_findFrame = Attribute(""" """)
  11.469 +    manage_findForm = Attribute(""" """)
  11.470 +    manage_findAdv = Attribute(""" """)
  11.471 +    manage_findResult = Attribute(""" """)
  11.472 +
  11.473 +    def ZopeFind(obj, obj_ids=None, obj_metatypes=None,
  11.474 +                 obj_searchterm=None, obj_expr=None,
  11.475 +                 obj_mtime=None, obj_mspec=None,
  11.476 +                 obj_permission=None, obj_roles=None,
  11.477 +                 search_sub=0,
  11.478 +                 REQUEST=None, result=None, pre=''):
  11.479 +        """Zope Find interface"""
  11.480 +
  11.481 +    PrincipiaFind = ZopeFind
  11.482 +
  11.483 +    def ZopeFindAndApply(obj, obj_ids=None, obj_metatypes=None,
  11.484 +                         obj_searchterm=None, obj_expr=None,
  11.485 +                         obj_mtime=None, obj_mspec=None,
  11.486 +                         obj_permission=None, obj_roles=None,
  11.487 +                         search_sub=0,
  11.488 +                         REQUEST=None, result=None, pre='',
  11.489 +                         apply_func=None, apply_path=''):
  11.490 +        """Zope Find interface and apply"""
  11.491 +
  11.492 +
  11.493 +# XXX: might contain non-API methods and outdated comments;
  11.494 +#      not synced with ZopeBook API Reference;
  11.495 +#      based on OFS.PropertyManager.PropertyManager
  11.496 +class IPropertyManager(Interface):
  11.497 +
  11.498 +    """
  11.499 +    The PropertyManager mixin class provides an object with
  11.500 +    transparent property management. An object which wants to
  11.501 +    have properties should inherit from PropertyManager.
  11.502 +
  11.503 +    An object may specify that it has one or more predefined
  11.504 +    properties, by specifying an _properties structure in its
  11.505 +    class::
  11.506 +
  11.507 +      _properties=({'id':'title', 'type': 'string', 'mode': 'w'},
  11.508 +                   {'id':'color', 'type': 'string', 'mode': 'w'},
  11.509 +                   )
  11.510 +
  11.511 +    The _properties structure is a sequence of dictionaries, where
  11.512 +    each dictionary represents a predefined property. Note that if a
  11.513 +    predefined property is defined in the _properties structure, you
  11.514 +    must provide an attribute with that name in your class or instance
  11.515 +    that contains the default value of the predefined property.
  11.516 +
  11.517 +    Each entry in the _properties structure must have at least an 'id'
  11.518 +    and a 'type' key. The 'id' key contains the name of the property,
  11.519 +    and the 'type' key contains a string representing the object's type.
  11.520 +    The 'type' string must be one of the values: 'float', 'int', 'long',
  11.521 +    'string', 'lines', 'text', 'date', 'tokens', 'selection', or
  11.522 +    'multiple section'.
  11.523 +
  11.524 +    For 'selection' and 'multiple selection' properties, there is an
  11.525 +    addition item in the property dictionay, 'select_variable' which
  11.526 +    provides the name of a property or method which returns a list of
  11.527 +    strings from which the selection(s) can be chosen.
  11.528 +
  11.529 +    Each entry in the _properties structure may *optionally* provide a
  11.530 +    'mode' key, which specifies the mutability of the property. The 'mode'
  11.531 +    string, if present, must contain 0 or more characters from the set
  11.532 +    'w','d'.
  11.533 +
  11.534 +    A 'w' present in the mode string indicates that the value of the
  11.535 +    property may be changed by the user. A 'd' indicates that the user
  11.536 +    can delete the property. An empty mode string indicates that the
  11.537 +    property and its value may be shown in property listings, but that
  11.538 +    it is read-only and may not be deleted.
  11.539 +
  11.540 +    Entries in the _properties structure which do not have a 'mode' key
  11.541 +    are assumed to have the mode 'wd' (writeable and deleteable).
  11.542 +
  11.543 +    To fully support property management, including the system-provided
  11.544 +    tabs and user interfaces for working with properties, an object which
  11.545 +    inherits from PropertyManager should include the following entry in
  11.546 +    its manage_options structure::
  11.547 +
  11.548 +      {'label':'Properties', 'action':'manage_propertiesForm',}
  11.549 +
  11.550 +    to ensure that a 'Properties' tab is displayed in its management
  11.551 +    interface. Objects that inherit from PropertyManager should also
  11.552 +    include the following entry in its __ac_permissions__ structure::
  11.553 +
  11.554 +      ('Manage properties', ('manage_addProperty',
  11.555 +                             'manage_editProperties',
  11.556 +                             'manage_delProperties',
  11.557 +                             'manage_changeProperties',)),
  11.558 +    """
  11.559 +    manage_propertiesForm = Attribute(""" """)
  11.560 +    manage_propertyTypeForm = Attribute(""" """)
  11.561 +
  11.562 +    title = BytesLine(
  11.563 +        title=u"Title"
  11.564 +        )
  11.565 +
  11.566 +    _properties = Tuple(
  11.567 +        title=u"Properties",
  11.568 +        )
  11.569 +
  11.570 +    propertysheets = Attribute(""" """)
  11.571 +
  11.572 +    def valid_property_id(id):
  11.573 +        """ """
  11.574 +
  11.575 +    def hasProperty(id):
  11.576 +        """Return true if object has a property 'id'"""
  11.577 +
  11.578 +    def getProperty(id, d=None):
  11.579 +        """Get the property 'id', returning the optional second
  11.580 +           argument or None if no such property is found."""
  11.581 +
  11.582 +    def getPropertyType(id):
  11.583 +        """Get the type of property 'id', returning None if no
  11.584 +           such property exists"""
  11.585 +
  11.586 +    def _wrapperCheck(object):
  11.587 +        """Raise an error if an object is wrapped."""
  11.588 +
  11.589 +    def _setPropValue(id, value):
  11.590 +        """ """
  11.591 +
  11.592 +    def _delPropValue(id):
  11.593 +        """ """
  11.594 +
  11.595 +    def _setProperty(id, value, type='string'):
  11.596 +        """Set property.
  11.597 +
  11.598 +        For selection and multiple selection properties the value argument
  11.599 +        indicates the select variable of the property.
  11.600 +        """
  11.601 +
  11.602 +    def _updateProperty(id, value):
  11.603 +        """Update the value of an existing property.
  11.604 +
  11.605 +        If value is a string, an attempt will be made to convert the value to
  11.606 +        the type of the existing property.
  11.607 +        """
  11.608 +
  11.609 +    def _delProperty(id):
  11.610 +        """ """
  11.611 +
  11.612 +    def propertyIds():
  11.613 +        """Return a list of property ids """
  11.614 +
  11.615 +    def propertyValues():
  11.616 +        """Return a list of actual property objects """
  11.617 +
  11.618 +    def propertyItems():
  11.619 +        """Return a list of (id,property) tuples """
  11.620 +
  11.621 +    def _propertyMap():
  11.622 +        """Return a tuple of mappings, giving meta-data for properties """
  11.623 +
  11.624 +    def propertyMap():
  11.625 +        """
  11.626 +        Return a tuple of mappings, giving meta-data for properties.
  11.627 +        Return copies of the real definitions for security.
  11.628 +        """
  11.629 +
  11.630 +    def propertyLabel(id):
  11.631 +        """Return a label for the given property id
  11.632 +        """
  11.633 +
  11.634 +    def propdict():
  11.635 +        """ """
  11.636 +
  11.637 +    # Web interface
  11.638 +
  11.639 +    def manage_addProperty(id, value, type, REQUEST=None):
  11.640 +        """Add a new property via the web. Sets a new property with
  11.641 +        the given id, type, and value."""
  11.642 +
  11.643 +    def manage_editProperties(REQUEST):
  11.644 +        """Edit object properties via the web.
  11.645 +        The purpose of this method is to change all property values,
  11.646 +        even those not listed in REQUEST; otherwise checkboxes that
  11.647 +        get turned off will be ignored.  Use manage_changeProperties()
  11.648 +        instead for most situations.
  11.649 +        """
  11.650 +
  11.651 +    def manage_changeProperties(REQUEST=None, **kw):
  11.652 +        """Change existing object properties.
  11.653 +
  11.654 +        Change object properties by passing either a mapping object
  11.655 +        of name:value pairs {'foo':6} or passing name=value parameters
  11.656 +        """
  11.657 +
  11.658 +    def manage_changePropertyTypes(old_ids, props, REQUEST=None):
  11.659 +        """Replace one set of properties with another
  11.660 +
  11.661 +        Delete all properties that have ids in old_ids, then add a
  11.662 +        property for each item in props.  Each item has a new_id,
  11.663 +        new_value, and new_type.  The type of new_value should match
  11.664 +        new_type.
  11.665 +        """
  11.666 +
  11.667 +    def manage_delProperties(ids=None, REQUEST=None):
  11.668 +        """Delete one or more properties specified by 'ids'."""
  11.669 +
  11.670 +
  11.671 +# XXX: based on OFS.Folder.Folder
  11.672 +class IFolder(IObjectManager, IPropertyManager, IRoleManager,
  11.673 +              IDAVCollection, IItem, IFindSupport):
  11.674 +
  11.675 +    """Folders are basic container objects that provide a standard
  11.676 +    interface for object management. Folder objects also implement a
  11.677 +    management interface and can have arbitrary properties."""
  11.678 +
  11.679 +
  11.680 +# XXX: based on OFS.OrderedFolder.OrderedFolder
  11.681 +class IOrderedFolder(IOrderedContainer, IFolder):
  11.682 +
  11.683 +    """Ordered folder"""
  11.684 +
  11.685 +
  11.686 +# XXX: might contain non-API methods and outdated comments;
  11.687 +#      not synced with ZopeBook API Reference;
  11.688 +#      based on OFS.Application.Application
  11.689 +class IApplication(IFolder, IContainmentRoot):
  11.690 +
  11.691 +    """Top-level system object"""
  11.692 +
  11.693 +    isTopLevelPrincipiaApplicationObject = Bool(
  11.694 +        title=u"Is top level Principa application object",
  11.695 +        )
  11.696 +
  11.697 +    HelpSys = Attribute("Help system")
  11.698 +
  11.699 +    p_ = Attribute(""" """)
  11.700 +    misc_ = Attribute("Misc.")
  11.701 +
  11.702 +    def PrincipiaRedirect(destination, URL1):
  11.703 +        """Utility function to allow user-controlled redirects"""
  11.704 +
  11.705 +    Redirect = ZopeRedirect = PrincipiaRedirect
  11.706 +
  11.707 +    def __bobo_traverse__(REQUEST, name=None):
  11.708 +        """Bobo traverse"""
  11.709 +
  11.710 +    def PrincipiaTime(*args):
  11.711 +        """Utility function to return current date/time"""
  11.712 +
  11.713 +    ZopeTime = PrincipiaTime
  11.714 +
  11.715 +    def ZopeAttributionButton():
  11.716 +        """Returns an HTML fragment that displays the 'powered by zope'
  11.717 +        button along with a link to the Zope site."""
  11.718 +
  11.719 +    test_url = ZopeAttributionButton
  11.720 +
  11.721 +    def absolute_url(relative=0):
  11.722 +        '''The absolute URL of the root object is BASE1 or "/".'''
  11.723 +
  11.724 +    def absolute_url_path():
  11.725 +        '''The absolute URL path of the root object is BASEPATH1 or "/".'''
  11.726 +
  11.727 +    def virtual_url_path():
  11.728 +        '''The virtual URL path of the root object is empty.'''
  11.729 +
  11.730 +    def getPhysicalPath():
  11.731 +        '''Returns a path that can be used to access this object again
  11.732 +        later, for example in a copy/paste operation.  Designed to
  11.733 +        be used with getPhysicalRoot().
  11.734 +        '''
  11.735 +
  11.736 +    def getPhysicalRoot():
  11.737 +        """Returns self"""
  11.738 +
  11.739 +    def fixupZClassDependencies(rebuild=0):
  11.740 +        """ """
  11.741 +
  11.742 +    def checkGlobalRegistry():
  11.743 +        """Check the global (zclass) registry for problems, which can
  11.744 +        be caused by things like disk-based products being deleted.
  11.745 +        Return true if a problem is found"""
  11.746 +
  11.747 +
  11.748 +##################################################
  11.749 +# Event interfaces
  11.750 +
  11.751 +from zope.app.event.interfaces import IObjectEvent
  11.752 +
  11.753 +class IObjectWillBeMovedEvent(IObjectEvent):
  11.754 +    """An object will be moved."""
  11.755 +    oldParent = Attribute("The old location parent for the object.")
  11.756 +    oldName = Attribute("The old location name for the object.")
  11.757 +    newParent = Attribute("The new location parent for the object.")
  11.758 +    newName = Attribute("The new location name for the object.")
  11.759 +
  11.760 +class IObjectWillBeAddedEvent(IObjectWillBeMovedEvent):
  11.761 +    """An object will be added to a container."""
  11.762 +
  11.763 +class IObjectWillBeRemovedEvent(IObjectWillBeMovedEvent):
  11.764 +    """An object will be removed from a container"""
  11.765 +
  11.766 +class IObjectClonedEvent(IObjectEvent):
  11.767 +    """An object has been cloned (a la Zope 2).
  11.768 +
  11.769 +    This is for Zope 2 compatibility, subscribers should really use
  11.770 +    IObjectCopiedEvent or IObjectAddedEvent, depending on their use
  11.771 +    cases.
  11.772 +
  11.773 +    event.object is the copied object, already added to its container.
  11.774 +    Note that this event is dispatched to all sublocations.
  11.775 +    """

    12.1 new file mode 100644
    12.2 --- /dev/null
    12.3 +++ b/bbb/OFS_subscribers.py
    12.4 @@ -0,0 +1,162 @@
    12.5 +##############################################################################
    12.6 +#
    12.7 +# Copyright (c) 2005 Zope Corporation and Contributors.
    12.8 +# All Rights Reserved.
    12.9 +#
   12.10 +# This software is subject to the provisions of the Zope Public License,
   12.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   12.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   12.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   12.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   12.15 +# FOR A PARTICULAR PURPOSE.
   12.16 +#
   12.17 +##############################################################################
   12.18 +"""
   12.19 +Five subscriber definitions.
   12.20 +
   12.21 +$Id: OFS_subscribers.py 19705 2005-11-10 14:00:27Z efge $
   12.22 +"""
   12.23 +
   12.24 +import warnings
   12.25 +import sys
   12.26 +
   12.27 +from zLOG import LOG, ERROR
   12.28 +from Acquisition import aq_base
   12.29 +from App.config import getConfiguration
   12.30 +from AccessControl import getSecurityManager
   12.31 +from ZODB.POSException import ConflictError
   12.32 +from OFS.ObjectManager import BeforeDeleteException
   12.33 +from zope.app.container.contained import dispatchToSublocations
   12.34 +from OFS_interfaces import IObjectManager
   12.35 +
   12.36 +
   12.37 +deprecatedManageAddDeleteClasses = []
   12.38 +
   12.39 +
   12.40 +def compatibilityCall(method_name, *args):
   12.41 +    """Call a method if events have not been setup yet.
   12.42 +
   12.43 +    This is the case for some unit tests that have not been converted to
   12.44 +    use the component architecture.
   12.45 +    """
   12.46 +    if deprecatedManageAddDeleteClasses:
   12.47 +        # Events initialized, don't do compatibility call
   12.48 +        return
   12.49 +    if method_name == 'manage_afterAdd':
   12.50 +        callManageAfterAdd(*args)
   12.51 +    elif method_name == 'manage_beforeDelete':
   12.52 +        callManageBeforeDelete(*args)
   12.53 +    else:
   12.54 +        callManageAfterClone(*args)
   12.55 +
   12.56 +def maybeWarnDeprecated(ob, method_name):
   12.57 +    """Send a warning if a method is deprecated.
   12.58 +    """
   12.59 +    if not deprecatedManageAddDeleteClasses:
   12.60 +        # Directives not fully loaded
   12.61 +        return
   12.62 +    for cls in deprecatedManageAddDeleteClasses:
   12.63 +        if isinstance(ob, cls):
   12.64 +            # Already deprecated through zcml
   12.65 +            return
   12.66 +    if getattr(getattr(ob, method_name), '__five_method__', False):
   12.67 +        # Method knows it's deprecated
   12.68 +        return
   12.69 +    class_ = ob.__class__
   12.70 +    warnings.warn(
   12.71 +        "%s.%s.%s is deprecated and will be removed in Zope 2.11, "
   12.72 +        "you should use event subscribers instead, and meanwhile "
   12.73 +        "mark the class with <five:deprecatedManageAddDelete/>"
   12.74 +        % (class_.__module__, class_.__name__, method_name),
   12.75 +        DeprecationWarning)
   12.76 +
   12.77 +
   12.78 +##################################################
   12.79 +# Adapters and subscribers
   12.80 +
   12.81 +class ObjectManagerSublocations(object):
   12.82 +    """Get the sublocations for an ObjectManager.
   12.83 +    """
   12.84 +    def __init__(self, container):
   12.85 +        self.container = container
   12.86 +
   12.87 +    def sublocations(self):
   12.88 +        for ob in self.container.objectValues():
   12.89 +            yield ob
   12.90 +
   12.91 +# The following subscribers should really be defined in ZCML
   12.92 +# but we don't have enough control over subscriber ordering for
   12.93 +# that to work exactly right.
   12.94 +# (Sometimes IItem comes before IObjectManager, sometimes after,
   12.95 +# depending on some of Zope's classes.)
   12.96 +# This code can be simplified when Zope is completely rid of
   12.97 +# manage_afterAdd & co, then IItem wouldn't be relevant anymore and we
   12.98 +# could have a simple subscriber for IObjectManager that directly calls
   12.99 +# dispatchToSublocations.
  12.100 +
  12.101 +def dispatchObjectWillBeMovedEvent(ob, event):
  12.102 +    """Multi-subscriber for IItem + IObjectWillBeMovedEvent.
  12.103 +    """
  12.104 +    # First, dispatch to sublocations
  12.105 +    if IObjectManager.providedBy(ob):
  12.106 +        dispatchToSublocations(ob, event)
  12.107 +    # Next, do the manage_beforeDelete dance
  12.108 +    callManageBeforeDelete(ob, event.object, event.oldParent)
  12.109 +
  12.110 +def dispatchObjectMovedEvent(ob, event):
  12.111 +    """Multi-subscriber for IItem + IObjectMovedEvent.
  12.112 +    """
  12.113 +    # First, do the manage_afterAdd dance
  12.114 +    callManageAfterAdd(ob, event.object, event.newParent)
  12.115 +    # Next, dispatch to sublocations
  12.116 +    if IObjectManager.providedBy(ob):
  12.117 +        dispatchToSublocations(ob, event)
  12.118 +
  12.119 +def dispatchObjectClonedEvent(ob, event):
  12.120 +    """Multi-subscriber for IItem + IObjectClonedEvent.
  12.121 +    """
  12.122 +    # First, do the manage_afterClone dance
  12.123 +    callManageAfterClone(ob, event.object)
  12.124 +    # Next, dispatch to sublocations
  12.125 +    if IObjectManager.providedBy(ob):
  12.126 +        dispatchToSublocations(ob, event)
  12.127 +
  12.128 +
  12.129 +def callManageAfterAdd(ob, item, container):
  12.130 +    """Compatibility subscriber for manage_afterAdd.
  12.131 +    """
  12.132 +    if container is None:
  12.133 +        return
  12.134 +    if getattr(aq_base(ob), 'manage_afterAdd', None) is None:
  12.135 +        return
  12.136 +    maybeWarnDeprecated(ob, 'manage_afterAdd')
  12.137 +    ob.manage_afterAdd(item, container)
  12.138 +
  12.139 +def callManageBeforeDelete(ob, item, container):
  12.140 +    """Compatibility subscriber for manage_beforeDelete.
  12.141 +    """
  12.142 +    if container is None:
  12.143 +        return
  12.144 +    if getattr(aq_base(ob), 'manage_beforeDelete', None) is None:
  12.145 +        return
  12.146 +    maybeWarnDeprecated(ob, 'manage_beforeDelete')
  12.147 +    try:
  12.148 +        ob.manage_beforeDelete(item, container)
  12.149 +    except BeforeDeleteException:
  12.150 +        raise
  12.151 +    except ConflictError:
  12.152 +        raise
  12.153 +    except:
  12.154 +        LOG('Zope', ERROR, '_delObject() threw', error=sys.exc_info())
  12.155 +        # In debug mode when non-Manager, let exceptions propagate.
  12.156 +        if getConfiguration().debug_mode:
  12.157 +            if not getSecurityManager().getUser().has_role('Manager'):
  12.158 +                raise
  12.159 +
  12.160 +def callManageAfterClone(ob, item):
  12.161 +    """Compatibility subscriber for manage_afterClone.
  12.162 +    """
  12.163 +    if getattr(aq_base(ob), 'manage_afterClone', None) is None:
  12.164 +        return
  12.165 +    maybeWarnDeprecated(ob, 'manage_afterClone')
  12.166 +    ob.manage_afterClone(item)

    13.1 new file mode 100644
    13.2 --- /dev/null
    13.3 +++ b/bbb/__init__.py
    13.4 @@ -0,0 +1,1 @@
    13.5 +# make this directory a package

    14.1 new file mode 100644
    14.2 --- /dev/null
    14.3 +++ b/bbb/webdav_interfaces.py
    14.4 @@ -0,0 +1,153 @@
    14.5 +##############################################################################
    14.6 +#
    14.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
    14.8 +# All Rights Reserved.
    14.9 +#
   14.10 +# This software is subject to the provisions of the Zope Public License,
   14.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   14.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   14.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   14.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   14.15 +# FOR A PARTICULAR PURPOSE.
   14.16 +#
   14.17 +##############################################################################
   14.18 +"""webdav z3 interfaces.
   14.19 +
   14.20 +$Id: webdav_interfaces.py 12884 2005-05-30 13:10:41Z philikon $
   14.21 +"""
   14.22 +from zope.interface import Interface
   14.23 +from zope.schema import Bool, Tuple
   14.24 +
   14.25 +
   14.26 +# create IWriteLock
   14.27 +from Products.Five.fiveconfigure import createZope2Bridge
   14.28 +from webdav.WriteLockInterface import WriteLockInterface
   14.29 +import webdav_interfaces
   14.30 +
   14.31 +createZope2Bridge(WriteLockInterface, webdav_interfaces, 'IWriteLock')
   14.32 +
   14.33 +del createZope2Bridge
   14.34 +del WriteLockInterface
   14.35 +del webdav_interfaces
   14.36 +
   14.37 +
   14.38 +# XXX: might contain non-API methods and outdated comments;
   14.39 +#      not synced with ZopeBook API Reference;
   14.40 +#      based on webdav.Resource.Resource
   14.41 +class IDAVResource(IWriteLock):
   14.42 +
   14.43 +    """Provide basic WebDAV support for non-collection objects."""
   14.44 +
   14.45 +    __dav_resource__ = Bool(
   14.46 +        title=u"Is DAV resource"
   14.47 +        )
   14.48 +
   14.49 +    __http_methods__ = Tuple(
   14.50 +        title=u"HTTP methods",
   14.51 +        description=u"Sequence of valid HTTP methods"
   14.52 +        )
   14.53 +
   14.54 +    def dav__init(request, response):
   14.55 +        """Init expected HTTP 1.1 / WebDAV headers which are not
   14.56 +        currently set by the base response object automagically.
   14.57 +
   14.58 +        Also, we sniff for a ZServer response object, because we don't
   14.59 +        want to write duplicate headers (since ZS writes Date
   14.60 +        and Connection itself).
   14.61 +        """
   14.62 +
   14.63 +    def dav__validate(object, methodname, REQUEST):
   14.64 +        """ """
   14.65 +
   14.66 +    def dav__simpleifhandler(request, response, method='PUT',
   14.67 +                             col=0, url=None, refresh=0):
   14.68 +        """ """
   14.69 +
   14.70 +    def HEAD(REQUEST, RESPONSE):
   14.71 +        """Retrieve resource information without a response body."""
   14.72 +
   14.73 +    def PUT(REQUEST, RESPONSE):
   14.74 +        """Replace the GET response entity of an existing resource.
   14.75 +        Because this is often object-dependent, objects which handle
   14.76 +        PUT should override the default PUT implementation with an
   14.77 +        object-specific implementation. By default, PUT requests
   14.78 +        fail with a 405 (Method Not Allowed)."""
   14.79 +
   14.80 +    def OPTIONS(REQUEST, RESPONSE):
   14.81 +        """Retrieve communication options."""
   14.82 +
   14.83 +    def TRACE(REQUEST, RESPONSE):
   14.84 +        """Return the HTTP message received back to the client as the
   14.85 +        entity-body of a 200 (OK) response. This will often usually
   14.86 +        be intercepted by the web server in use. If not, the TRACE
   14.87 +        request will fail with a 405 (Method Not Allowed), since it
   14.88 +        is not often possible to reproduce the HTTP request verbatim
   14.89 +        from within the Zope environment."""
   14.90 +
   14.91 +    def DELETE(REQUEST, RESPONSE):
   14.92 +        """Delete a resource. For non-collection resources, DELETE may
   14.93 +        return either 200 or 204 (No Content) to indicate success."""
   14.94 +
   14.95 +    def PROPFIND(REQUEST, RESPONSE):
   14.96 +        """Retrieve properties defined on the resource."""
   14.97 +
   14.98 +    def PROPPATCH(REQUEST, RESPONSE):
   14.99 +        """Set and/or remove properties defined on the resource."""
  14.100 +
  14.101 +    def MKCOL(REQUEST, RESPONSE):
  14.102 +        """Create a new collection resource. If called on an existing
  14.103 +        resource, MKCOL must fail with 405 (Method Not Allowed)."""
  14.104 +
  14.105 +    def COPY(REQUEST, RESPONSE):
  14.106 +        """Create a duplicate of the source resource whose state
  14.107 +        and behavior match that of the source resource as closely
  14.108 +        as possible. Though we may later try to make a copy appear
  14.109 +        seamless across namespaces (e.g. from Zope to Apache), COPY
  14.110 +        is currently only supported within the Zope namespace."""
  14.111 +
  14.112 +    def MOVE(REQUEST, RESPONSE):
  14.113 +        """Move a resource to a new location. Though we may later try to
  14.114 +        make a move appear seamless across namespaces (e.g. from Zope
  14.115 +        to Apache), MOVE is currently only supported within the Zope
  14.116 +        namespace."""
  14.117 +
  14.118 +    def LOCK(REQUEST, RESPONSE):
  14.119 +        """Lock a resource"""
  14.120 +
  14.121 +    def UNLOCK(REQUEST, RESPONSE):
  14.122 +        """Remove an existing lock on a resource."""
  14.123 +
  14.124 +    def manage_DAVget():
  14.125 +        """Gets the document source"""
  14.126 +
  14.127 +    def listDAVObjects():
  14.128 +        """ """
  14.129 +
  14.130 +
  14.131 +# XXX: might contain non-API methods and outdated comments;
  14.132 +#      not synced with ZopeBook API Reference;
  14.133 +#      based on webdav.Collection.Collection
  14.134 +class IDAVCollection(IDAVResource):
  14.135 +
  14.136 +    """The Collection class provides basic WebDAV support for
  14.137 +    collection objects. It provides default implementations
  14.138 +    for all supported WebDAV HTTP methods. The behaviors of some
  14.139 +    WebDAV HTTP methods for collections are slightly different
  14.140 +    than those for non-collection resources."""
  14.141 +
  14.142 +    __dav_collection__ = Bool(
  14.143 +        title=u"Is a DAV collection",
  14.144 +        description=u"Should be true",
  14.145 +        )
  14.146 +
  14.147 +    def PUT(REQUEST, RESPONSE):
  14.148 +        """The PUT method has no inherent meaning for collection
  14.149 +        resources, though collections are not specifically forbidden
  14.150 +        to handle PUT requests. The default response to a PUT request
  14.151 +        for collections is 405 (Method Not Allowed)."""
  14.152 +
  14.153 +    def DELETE(REQUEST, RESPONSE):
  14.154 +        """Delete a collection resource. For collection resources, DELETE
  14.155 +        may return either 200 (OK) or 204 (No Content) to indicate total
  14.156 +        success, or may return 207 (Multistatus) to indicate partial
  14.157 +        success. Note that in Zope a DELETE currently never returns 207."""

    15.1 new file mode 100644
    15.2 --- /dev/null
    15.3 +++ b/bridge.py
    15.4 @@ -0,0 +1,89 @@
    15.5 +##############################################################################
    15.6 +#
    15.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
    15.8 +# All Rights Reserved.
    15.9 +#
   15.10 +# This software is subject to the provisions of the Zope Public License,
   15.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   15.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   15.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   15.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   15.15 +# FOR A PARTICULAR PURPOSE.
   15.16 +#
   15.17 +##############################################################################
   15.18 +""" Z2 -> Z3 bridge utilities.
   15.19 +
   15.20 +$Id: bridge.py 14504 2005-07-11 15:49:59Z yuppie $
   15.21 +"""
   15.22 +from Interface._InterfaceClass import Interface as Z2_InterfaceClass
   15.23 +from Interface import Interface as Z2_Interface
   15.24 +from Interface import Attribute as Z2_Attribute
   15.25 +from Interface.Method import Method as Z2_Method
   15.26 +
   15.27 +from zope.interface.interface import InterfaceClass as Z3_InterfaceClass
   15.28 +from zope.interface.interface import Interface as Z3_Interface
   15.29 +from zope.interface.interface import Attribute as Z3_Attribute
   15.30 +from zope.interface.interface import Method as Z3_Method
   15.31 +
   15.32 +_bridges = {Z2_Interface: Z3_Interface}
   15.33 +
   15.34 +def fromZ2Interface(z2i):
   15.35 +    """ Return a Zope 3 interface corresponding to 'z2i'.
   15.36 +
   15.37 +    o 'z2i' must be a Zope 2 interface.
   15.38 +    """
   15.39 +    if not isinstance(z2i, Z2_InterfaceClass):
   15.40 +        raise ValueError, 'Not a Zope 2 interface!'
   15.41 +
   15.42 +    if z2i in _bridges:
   15.43 +        return _bridges[z2i]
   15.44 +
   15.45 +    name = z2i.getName()
   15.46 +    bases = [ fromZ2Interface(x) for x in z2i.getBases() ]
   15.47 +    attrs = {}
   15.48 +
   15.49 +    for k, v in z2i.namesAndDescriptions():
   15.50 +        if isinstance(v, Z2_Method):
   15.51 +            v = fromZ2Method(v)
   15.52 +
   15.53 +        elif isinstance(v, Z2_Attribute):
   15.54 +            v = fromZ2Attribute(v)
   15.55 +
   15.56 +        attrs[k] = v
   15.57 +
   15.58 +    # XXX: Note that we pass the original interface's __module__;
   15.59 +    #      we may live to regret that.
   15.60 +    z3i = Z3_InterfaceClass(name=name,
   15.61 +                            bases=tuple(bases),
   15.62 +                            attrs=attrs,
   15.63 +                            __doc__=z2i.getDoc(),
   15.64 +                            __module__=z2i.__module__)
   15.65 +    _bridges[z2i] = z3i
   15.66 +    return z3i
   15.67 +
   15.68 +def fromZ2Attribute(z2a):
   15.69 +    """ Return a Zope 3 interface attribute corresponding to 'z2a'.
   15.70 +
   15.71 +    o 'z2a' must be a Zope 2 interface attribute.
   15.72 +    """
   15.73 +    if not isinstance(z2a, Z2_Attribute):
   15.74 +        raise ValueError, 'Not a Zope 2 interface attribute!'
   15.75 +
   15.76 +    return Z3_Attribute(z2a.getName(), z2a.getDoc())
   15.77 +
   15.78 +def fromZ2Method(z2m):
   15.79 +    """ Return a Zope 3 interface method corresponding to 'z2m'.
   15.80 +
   15.81 +    o 'z2m' must be a Zope 2 interface method.
   15.82 +    """
   15.83 +    if not isinstance(z2m, Z2_Method):
   15.84 +        raise ValueError, 'Not a Zope 2 interface method!'
   15.85 +
   15.86 +    z3m = Z3_Method(z2m.getName(), z2m.getDoc())
   15.87 +    sig = z2m.getSignatureInfo()
   15.88 +    z3m.positional = sig['positional']
   15.89 +    z3m.required = sig['required']
   15.90 +    z3m.optional = sig['optional']
   15.91 +    z3m.varargs = sig['varargs']
   15.92 +    z3m.kwargs = sig['kwargs']
   15.93 +    return z3m

    16.1 new file mode 100644
    16.2 --- /dev/null
    16.3 +++ b/browser/ReuseUtils.py
    16.4 @@ -0,0 +1,32 @@
    16.5 +##############################################################################
    16.6 +#
    16.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
    16.8 +# All Rights Reserved.
    16.9 +#
   16.10 +# This software is subject to the provisions of the Zope Public License,
   16.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   16.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   16.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   16.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   16.15 +# FOR A PARTICULAR PURPOSE.
   16.16 +#
   16.17 +##############################################################################
   16.18 +"""Utils to be reused
   16.19 +
   16.20 +$Id: ReuseUtils.py 12907 2005-05-31 06:26:15Z philikon $
   16.21 +"""
   16.22 +from new import function
   16.23 +
   16.24 +def rebindFunction(f,rebindDir=None,**rebinds):
   16.25 +  '''return *f* with some globals rebound.'''
   16.26 +  d= {}
   16.27 +  if rebindDir : d.update(rebindDir)
   16.28 +  if rebinds: d.update(rebinds)
   16.29 +  if not d: return f
   16.30 +  f= getattr(f,'im_func',f)
   16.31 +  fd= f.func_globals.copy()
   16.32 +  fd.update(d)
   16.33 +  nf= function(f.func_code,fd,f.func_name,f.func_defaults or ())
   16.34 +  nf.__doc__= f.__doc__
   16.35 +  if f.__dict__ is not None: nf.__dict__= f.__dict__.copy()
   16.36 +  return nf

    17.1 new file mode 100644
    17.2 --- /dev/null
    17.3 +++ b/browser/TrustedExpression.py
    17.4 @@ -0,0 +1,108 @@
    17.5 +##############################################################################
    17.6 +#
    17.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
    17.8 +# All Rights Reserved.
    17.9 +#
   17.10 +# This software is subject to the provisions of the Zope Public License,
   17.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   17.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   17.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   17.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   17.15 +# FOR A PARTICULAR PURPOSE.
   17.16 +#
   17.17 +##############################################################################
   17.18 +"""Trusted expression
   17.19 +
   17.20 +$Id: TrustedExpression.py 18543 2005-10-14 13:37:26Z regebro $
   17.21 +"""
   17.22 +from sys import modules
   17.23 +
   17.24 +from Products.PageTemplates.PythonExpr import PythonExpr
   17.25 +
   17.26 +from Products.PageTemplates.Expressions import \
   17.27 +     SubPathExpr, PathExpr, \
   17.28 +     StringExpr, \
   17.29 +     getEngine, installHandlers,\
   17.30 +     SecureModuleImporter
   17.31 +
   17.32 +from ReuseUtils import rebindFunction
   17.33 +
   17.34 +ModuleImporter = SecureModuleImporter
   17.35 +
   17.36 +def trustedTraverse(ob, path, ignored,):
   17.37 +  if not path: return self
   17.38 +
   17.39 +  get = getattr
   17.40 +  has = hasattr
   17.41 +  N = None
   17.42 +  M = rebindFunction # artifical marker
   17.43 +
   17.44 +  if isinstance(path, str): path = path.split('/')
   17.45 +  else: path=list(path)
   17.46 +  
   17.47 +  REQUEST={'TraversalRequestNameStack': path}
   17.48 +  path.reverse()
   17.49 +  pop=path.pop
   17.50 +
   17.51 +  if len(path) > 1 and not path[0]:
   17.52 +    # Remove trailing slash
   17.53 +    path.pop(0)
   17.54 +
   17.55 +  if not path[-1]:
   17.56 +    # If the path starts with an empty string, go to the root first.
   17.57 +    pop()
   17.58 +    self=ob.getPhysicalRoot()
   17.59 +
   17.60 +  object = ob
   17.61 +  while path:
   17.62 +    name=pop()
   17.63 +    __traceback_info__ = path, name
   17.64 +
   17.65 +    if name == '..':
   17.66 +      o=getattr(object, 'aq_parent', M)
   17.67 +      if o is not M:
   17.68 +        object=o
   17.69 +        continue
   17.70 +
   17.71 +    t=get(object, '__bobo_traverse__', M)
   17.72 +    if t is not M: o=t(REQUEST, name)
   17.73 +    else:
   17.74 +      o = get(object, name, M)
   17.75 +      if o is M:
   17.76 +        try: o = object[name]
   17.77 +        except (AttributeError, TypeError): # better exception
   17.78 +          raise AttributeError(name)
   17.79 +    object = o
   17.80 +
   17.81 +  return object
   17.82 +
   17.83 +
   17.84 +class SubPathExpr(SubPathExpr):
   17.85 +  _eval = rebindFunction(SubPathExpr._eval.im_func,
   17.86 +                         restrictedTraverse=trustedTraverse,
   17.87 +                         )
   17.88 +
   17.89 +class PathExpr(PathExpr):
   17.90 +  __init__ = rebindFunction(PathExpr.__init__.im_func,
   17.91 +                            SubPathExpr=SubPathExpr,
   17.92 +                            )
   17.93 +
   17.94 +class StringExpr(StringExpr):
   17.95 +  __init__ = rebindFunction(StringExpr.__init__.im_func,
   17.96 +                            PathExpr=PathExpr,
   17.97 +                            )
   17.98 +  
   17.99 +installHandlers = rebindFunction(installHandlers,
  17.100 +                                 PathExpr=PathExpr,
  17.101 +                                 StringExpr=StringExpr,
  17.102 +                                 PythonExpr=PythonExpr,
  17.103 +                                 )
  17.104 +
  17.105 +_engine=None
  17.106 +getEngine = rebindFunction(getEngine,
  17.107 +                           _engine=_engine,
  17.108 +                           installHandlers=installHandlers
  17.109 +                           )
  17.110 +
  17.111 +
  17.112 +  

    18.1 new file mode 100644
    18.2 --- /dev/null
    18.3 +++ b/browser/__init__.py
    18.4 @@ -0,0 +1,32 @@
    18.5 +##############################################################################
    18.6 +#
    18.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
    18.8 +# All Rights Reserved.
    18.9 +#
   18.10 +# This software is subject to the provisions of the Zope Public License,
   18.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   18.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   18.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   18.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   18.15 +# FOR A PARTICULAR PURPOSE.
   18.16 +#
   18.17 +##############################################################################
   18.18 +"""Provide basic browser functionality
   18.19 +
   18.20 +$Id: __init__.py 12884 2005-05-30 13:10:41Z philikon $
   18.21 +"""
   18.22 +import Acquisition
   18.23 +from AccessControl import ClassSecurityInfo
   18.24 +from Globals import InitializeClass
   18.25 +
   18.26 +class BrowserView(Acquisition.Explicit):
   18.27 +    security = ClassSecurityInfo()
   18.28 +
   18.29 +    def __init__(self, context, request):
   18.30 +        self.context = context
   18.31 +        self.request = request
   18.32 +
   18.33 +    # XXX do not create any methods on the subclass called index_html,
   18.34 +    # as this makes Zope 2 traverse into that first!
   18.35 +
   18.36 +InitializeClass(BrowserView)

    19.1 new file mode 100644
    19.2 --- /dev/null
    19.3 +++ b/browser/absoluteurl.py
    19.4 @@ -0,0 +1,84 @@
    19.5 +##############################################################################
    19.6 +#
    19.7 +# Copyright (c) 2004, 2005 Zope Corporation and Contributors.
    19.8 +# All Rights Reserved.
    19.9 +#
   19.10 +# This software is subject to the provisions of the Zope Public License,
   19.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   19.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   19.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   19.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   19.15 +# FOR A PARTICULAR PURPOSE.
   19.16 +#
   19.17 +##############################################################################
   19.18 +"""Absolute URL
   19.19 +
   19.20 +$Id: absoluteurl.py 13254 2005-06-09 21:40:41Z philikon $
   19.21 +"""
   19.22 +from Acquisition import aq_inner, aq_parent
   19.23 +from OFS.interfaces import ITraversable
   19.24 +
   19.25 +from zope.interface import implements
   19.26 +from zope.app import zapi
   19.27 +from zope.app.traversing.browser.interfaces import IAbsoluteURL
   19.28 +
   19.29 +from Products.Five.browser import BrowserView
   19.30 +
   19.31 +class AbsoluteURL(BrowserView):
   19.32 +    """An adapter for Zope3-style absolute_url using Zope2 methods
   19.33 +
   19.34 +    (original: zope.app.traversing.browser.absoluteurl)
   19.35 +    """
   19.36 +    implements(IAbsoluteURL)
   19.37 +
   19.38 +    def __init__(self, context, request):
   19.39 +        self.context, self.request = context, request
   19.40 +
   19.41 +    def __str__(self):
   19.42 +        context = aq_inner(self.context)
   19.43 +        return context.absolute_url()
   19.44 +
   19.45 +    __call__ = __str__
   19.46 +
   19.47 +    def breadcrumbs(self):
   19.48 +        context = aq_inner(self.context)
   19.49 +        container = aq_parent(context)
   19.50 +        request = self.request
   19.51 +
   19.52 +        name = context.getId()
   19.53 +        
   19.54 +        if container is None or self._isVirtualHostRoot() \
   19.55 +            or not ITraversable.providedBy(container):
   19.56 +            return (
   19.57 +                {'name': name, 'url': context.absolute_url()},)
   19.58 +
   19.59 +        view = zapi.getViewProviding(container, IAbsoluteURL, request)
   19.60 +        base = tuple(view.breadcrumbs())
   19.61 +        base += (
   19.62 +            {'name': name, 'url': ("%s/%s" % (base[-1]['url'], name))},)
   19.63 +
   19.64 +        return base
   19.65 +
   19.66 +    def _isVirtualHostRoot(self):
   19.67 +        virtualrootpath = self.request.get('VirtualRootPhysicalPath', None)
   19.68 +        if virtualrootpath is None:
   19.69 +            return False
   19.70 +        context = aq_inner(self.context)
   19.71 +        return context.restrictedTraverse(virtualrootpath) == context
   19.72 +
   19.73 +class SiteAbsoluteURL(AbsoluteURL):
   19.74 +    """An adapter for Zope3-style absolute_url using Zope2 methods
   19.75 +
   19.76 +    This one is just used to stop breadcrumbs from crumbing up
   19.77 +    to the Zope root.
   19.78 +
   19.79 +    (original: zope.app.traversing.browser.absoluteurl)
   19.80 +    """
   19.81 +
   19.82 +    def breadcrumbs(self):
   19.83 +        context = self.context
   19.84 +        request = self.request
   19.85 +
   19.86 +        return ({'name': context.getId(),
   19.87 +                 'url': context.absolute_url()
   19.88 +                 },)

    20.1 new file mode 100644
    20.2 --- /dev/null
    20.3 +++ b/browser/adding.pt
    20.4 @@ -0,0 +1,7 @@
    20.5 +<html metal:use-macro="context/@@standard_macros/page">
    20.6 +<body>
    20.7 +<div metal:fill-slot="main">
    20.8 +  <p>+ screen not yet supported by Five</p>
    20.9 +</div>
   20.10 +</body>
   20.11 +</html>

    21.1 new file mode 100644
    21.2 --- /dev/null
    21.3 +++ b/browser/adding.py
    21.4 @@ -0,0 +1,261 @@
    21.5 +##############################################################################
    21.6 +#
    21.7 +# Copyright (c) 2002-2005 Zope Corporation and Contributors.
    21.8 +# All Rights Reserved.
    21.9 +#
   21.10 +# This software is subject to the provisions of the Zope Public License,
   21.11 +# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
   21.12 +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
   21.13 +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   21.14 +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
   21.15 +# FOR A PARTICULAR PURPOSE.
   21.16 +#
   21.17 +##############################################################################
   21.18 +"""Adding View
   21.19 +
   21.20 +The Adding View is used to add new objects to a container. It is sort of a
   21.21 +factory screen.
   21.22 +"""
   21.23 +__docformat__ = 'restructuredtext'
   21.24 +
   21.25 +from warnings import warn
   21.26 +from zope.interface import implements
   21.27 +from zope.publisher.interfaces import IPublishTraverse
   21.28 +from zope.component.interfaces import IFactory
   21.29 +
   21.30 +from zope.app.exception.interfaces import UserError
   21.31 +from zope.app.container.interfaces import IAdding, INameChooser
   21.32 +from zope.app.container.interfaces import IContainerNamesContainer
   21.33 +from zope.app.container.constraints import checkFactory, checkObject
   21.34 +
   21.35 +from zope.app import zapi
   21.36 +from zope.app.event.objectevent import ObjectCreatedEvent
   21.37 +from zope.event import notify
   21.38 +
   21.39 +from zExceptions import BadRequest
   21.40 +
   21.41 +from Products.Five import BrowserView
   21.42 +from Products.Five.traversable import Traversable
   21.43 +from Products.Five.browser.pagetemplatefile import ZopeTwoPageTemplateFile
   21.44 +
   21.45 +from Acquisition import Implicit
   21.46 +from OFS.SimpleItem import SimpleItem
   21.47 +
   21.48 +class BasicAdding(Implicit, BrowserView):
   21.49 +    implements(IAdding, IPublishTraverse)
   21.50 +
   21.51 +    def add(self, content):
   21.52 +        """See zope.app.container.interfaces.IAdding
   21.53 +        """
   21.54 +        container = self.context
   21.55 +        name = self.contentName
   21.56 +        chooser = INameChooser(container)
   21.57 +
   21.58 +        # check precondition
   21.59 +        checkObject(container, name, content)
   21.60 +
   21.61 +        if IContainerNamesContainer.providedBy(container):
   21.62 +            # The container picks it's own names.
   21.63 +            # We need to ask it to pick one.
   21.64 +            name = chooser.chooseName(self.contentName or '', content)
   21.65 +        else:
   21.66 +            request = self.request
   21.67 +            name = request.get('add_input_name', name)
   21.68 +
   21.69 +            if name is None:
   21.70 +                name = chooser.chooseName(self.contentName or '', content)
   21.71 +            elif name == '':
   21.72 +                name = chooser.chooseName('', content)
   21.73 +            else:
   21.74 +                # Invoke the name chooser even when we have a
   21.75 +                # name. It'll do useful things with it like converting
   21.76 +                # the incoming unicode to an ASCII string.
   21.77 +                name = chooser.chooseName(name, container)
   21.78 +        
   21.79 +        content.id = name
   21.80 +        container._setObject(name, content)
   21.81 +        self.contentName = name # Set the added object Name
   21.82 +        return container._getOb(name)
   21.83 +
   21.84 +    contentName = None # usually set by Adding traverser
   21.85 +
   21.86 +    def nextURL(self):
   21.87 +        """See zope.app.container.interfaces.IAdding"""
   21.88 +        # XXX this is definitely not right for all or even most uses
   21.89 +        # of Five, but can be overridden by an AddView subclass, using
   21.90 +        # the class attribute of a zcml:addform directive
   21.91 +        return (str(zapi.getView(self.context, "absolute_url", self.request))
   21.92 +                + '/manage_main')
   21.93 +
   21.94 +    # set in BrowserView.__init__
   21.95 +    request = None 
   21.96 +    context = None
   21.97 +
   21.98 +    def renderAddButton(self):
   21.99 +        warn("The renderAddButton method is deprecated, use nameAllowed",
  21.100 +            DeprecationWarning, 2)
  21.101 +    
  21.102 +
  21.103 +    def publishTraverse(self, request, name):
  21.104 +        """See zope.app.container.interfaces.IAdding"""
  21.105 +        if '=' in name:
  21.106 +            view_name, content_name = name.split("=", 1)
  21.107 +            self.contentName = content_name
  21.108 +
  21.109 +            if view_name.startswith('@@'):
  21.110 +                view_name = view_name[2:]
  21.111 +            return zapi.getView(self, view_name, request)
  21.112 +
  21.113 +        if name.startswith('@@'):
  21.114 +            view_name = name[2:]
  21.115 +        else:
  21.116 +            view_name = name
  21.117 +
  21.118 +        view = zapi.queryView(self, view_name, request)
  21.119 +        if view is not None:
  21.120 +            return view
  21.121 +
  21.122 +        factory = zapi.queryUtility(IFactory, name)
  21.123 +        if factory is None:
  21.124 +            return super(BasicAdding, self).publishTraverse(request, name)
  21.125 +
  21.126 +        return factory
  21.127 +
  21.128 +    def action(self, type_name='', id=''):
  21.129 +        if not type_name:
  21.130 +            raise UserError("You must select the type of object to add.")
  21.131 +
  21.132 +        if type_name.startswith('@@'):
  21.133 +            type_name = type_name[2:]
  21.134 +
  21.135 +        if '/' in type_name:
  21.136 +            view_name  = type_name.split('/', 1)[0]
  21.137 +        else:
  21.138 +            view_name = type_name
  21.139 +
  21.140 +        if zapi.queryView(self, view_name, self.request) is not None:
  21.141 +            url = "%s/%s=%s" % (
  21.142 +                zapi.getView(self, "absolute_url", self.request),
  21.143 +                type_name, id)
  21.144 +            self.request.response.redirect(url)
  21.145 +            return
  21.146 +
  21.147 +        if not self.contentName:
  21.148 +            self.contentName = id
  21.149 +
  21.150 +        factory = zapi.getUtility(IFactory, type_name)
  21.151 +        content = factory()
  21.152 +
  21.153 +        notify(ObjectCreatedEvent(content))
  21.154 +        self.add(content)
  21.155 +        self.request.response.redirect(self.nextURL())
  21.156 +
  21.157 +    def namesAccepted(self):
  21.158 +        return not IContainerNamesContainer.providedBy(self.context)
  21.159 +
  21.160 +    def nameAllowed(self):
  21.161 +        """Return whether names can be input by the user."""
  21.162 +        return not IContainerNamesContainer.providedBy(self.context)
  21.163 +    
  21.164 +
  21.165 +class Adding(BasicAdding):
  21.166 +
  21.167 +    menu_id = None
  21.168 +    index = ZopeTwoPageTemplateFile("adding.pt")
  21.169 +
  21.170 +    def addingInfo(self):
  21.171 +        """Return menu data.
  21.172 +
  21.173 +        This is sorted by title.
  21.174 +        """
  21.175 +        container = self.context
  21.176 +        menu_service = zapi.getService("BrowserMenu")
  21.177 +        result = []
  21.178 +        for menu_id in (self.menu_id, 'zope.app.container.add'):
  21.179 +            if not menu_id:
  21.180 +                continue
  21.181 +            for item in menu_service.getMenu(menu_id, self, self.request):
  21.182 +                extra = item.get('extra')
  21.183 +                if extra:
  21.184 +                    factory = extra.get('factory')
  21.185 +                    if factory:
  21.186 +                        factory = zapi.getUtility(IFactory, factory)
  21.187 +                        if not checkFactory(container, None, factory):
  21.188 +                            continue
  21.189 +                        elif item['extra']['factory'] != item['action']:
  21.190 +                            item['has_custom_add_view']=True
  21.191 +                result.append(item)
  21.192 +
  21.193 +        result.sort(lambda a, b: cmp(a['title'], b['title']))
  21.194 +        return result
  21.195 +
  21.196 +    def isSingleMenuItem(self):
  21.197 +        "Return whether there is single menu item or not."
  21.198 +        return len(self.addingInfo()) == 1
  21.199 +
  21.200 +    def hasCustomAddView(self):
  21.201 +       "This should be called only if there is `singleMenuItem` else return 0"
  21.202 +       if self.isSingleMenuItem():
  21.203 +           menu_item = self.addingInfo()[0]
  21.204 +           if 'has_custom_add_view' in menu_item:
  21.205 +               return True
  21.206 +       return False
  21.207 +
  21.208 +class ContentAdding(Adding, Traversable, SimpleItem):
  21.209 +
  21.210 +    menu_id = "add_content"
  21.211 +
  21.212 +class ObjectManagerNameChooser:
  21.213 +    """A name chooser for a Zope object manager.
  21.214 +    """
  21.215 +    
  21.216 +    implements(INameChooser)
  21.217 +    
  21.218 +    def __init__(self, context):
  21.219 +        self.context = context
  21.220 +
  21.221 +    def checkName(self, name, object):
  21.222 +        # ObjectManager can only deal with ASCII names. Specially
  21.223 +        # ObjectManager._checkId can only deal with strings.
  21.224 +        try:
  21.225 +            name = name.encode('ascii')
  21.226 +        except UnicodeDecodeError:
  21.227 +            raise UserError, "Id must contain only ASCII characters."
  21.228 +
  21.229 +        try:
  21.230 +            self.context._checkId(name, allow_dup=False)
  21.231 +        except BadRequest, e:
  21.232 +            msg = ' '.join(e.args) or "Id is in use or invalid"
  21.233 +            raise UserError, msg
  21.234 +
  21.235 +    def chooseName(self, name, object):
  21.236 +        if not name:
  21.237 +            name = object.__class__.__name__
  21.238 +        else:
  21.239 +            try:
  21.240 +                name = name.encode('ascii')
  21.241 +            except UnicodeDecodeError:
  21.242 +                raise UserError, "Id must contain only ASCII characters."
  21.243 +
  21.244 +        dot = name.rfind('.')
  21.245 +        if dot >= 0:
  21.246 +            suffix = name[dot:]
  21.247 +            name = name[:dot]
  21.248 +        else:
  21.249 +            suffix = ''
  21.250 +
  21.251 +        n = name + suffix
  21.252 +        i = 0
  21.253 +        while True:
  21.254 +            i += 1
  21.255 +            try:
  21.256 +                self.context._getOb(n)
  21.257 +            except AttributeError:
  21.258 +                break
  21.259 +            n = name + '-' + str(i) + suffix
  21.260 +            
  21.261 +        # Make sure the name is valid.  We may have started with
  21.262 +        # something bad.
  21.263 +        self.checkName(n, object)
  21.264 +
  21.265 +        return n