fix recurring typo: occured --> occurred

browser/add.py

@@ -0,0 +1,185 @@
+##############################################################################
+#
+# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Add Form View class
+
+$Id$
+"""
+__docformat__ = 'restructuredtext'
+
+import sys
+
+from zope.app import zapi
+from zope.component.interfaces import IFactory
+from zope.event import notify
+from zope.interface import Interface
+
+from zope.app.event.objectevent import ObjectCreatedEvent
+from zope.app.event.objectevent import ObjectModifiedEvent
+from zope.app.event.objectevent import Attributes
+from zope.app.form.utility import setUpWidgets, getWidgetsData
+from zope.app.i18n import ZopeMessageIDFactory as _
+from zope.app.form.interfaces import IInputWidget, WidgetsError
+from zope.app.pagetemplate.simpleviewclass import SimpleViewClass
+from zope.app.pagetemplate.viewpagetemplatefile import ViewPageTemplateFile
+from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+from zope.schema.interfaces import ValidationError
+from zope.security.checker import defineChecker, NamesChecker
+from editview import EditView
+from submit import Update
+
+class AddView(EditView):
+    """Simple edit-view base class.
+
+    Subclasses should provide a schema attribute defining the schema
+    to be edited.
+    """
+
+    def _setUpWidgets(self):
+        setUpWidgets(self, self.schema, IInputWidget, names=self.fieldNames)
+
+    def update(self):
+
+        if self.update_status is not None:
+            # We've been called before. Just return the previous result.
+            return self.update_status
+
+        if Update in self.request:
+
+            self.update_status = ''
+            try:
+                data = getWidgetsData(self, self.schema, names=self.fieldNames)
+                self.createAndAdd(data)
+            except WidgetsError, errors:
+                self.errors = errors
+                self.update_status = _("An error occurred.")
+                return self.update_status
+
+            self.request.response.redirect(self.nextURL())
+
+        return self.update_status
+
+    def create(self, *args, **kw):
+        """Do the actual instantiation."""
+        return self._factory(*args, **kw)
+
+    def createAndAdd(self, data):
+        """Add the desired object using the data in the data argument.
+
+        The data argument is a dictionary with the data entered in the form.
+        """
+
+        args = []
+        if self._arguments:
+            for name in self._arguments:
+                args.append(data[name])
+
+        kw = {}
+        if self._keyword_arguments:
+            for name in self._keyword_arguments:
+                if name in data:
+                    kw[str(name)] = data[name]
+
+        content = self.create(*args, **kw)
+
+        errors = []
+
+        if self._set_before_add:
+            adapted = self.schema(content)
+            for name in self._set_before_add:
+                if name in data:
+                    field = self.schema[name]
+                    try:
+                        field.set(adapted, data[name])
+                    except ValidationError:
+                        errors.append(sys.exc_info()[1])
+
+        if errors:
+            raise WidgetsError(*errors)
+
+        notify(ObjectCreatedEvent(content))
+
+        content = self.add(content)
+
+        if self._set_after_add:
+            adapted = self.schema(content)
+            for name in self._set_after_add:
+                if name in data:
+                    field = self.schema[name]
+                    try:
+                        field.set(adapted, data[name])
+                    except ValidationError:
+                        errors.append(sys.exc_info()[1])
+
+            # We have modified the object, so we need to publish an
+            # object-modified event:
+            description = Attributes(self.schema, *self._set_after_add)
+            notify(ObjectModifiedEvent(content, description))
+
+        if errors:
+            raise WidgetsError(*errors)
+
+        return content
+
+    def add(self, content):
+        return self.context.add(content)
+
+    def nextURL(self):
+        return self.context.nextURL()
+
+# helper for factory resp. content_factory handling
+def _getFactory(self):
+    # get factory or factory id
+    factory = self.__dict__.get('_factory_or_id', self._factory_or_id)
+
+    if type(factory) is str: # factory id
+        return zapi.getUtility(IFactory, factory, self.context)
+    else:
+        return factory
+
+def _setFactory(self, value):
+    self.__dict__['_factory_or_id'] = value
+
+
+def AddViewFactory(name, schema, label, permission, layer,
+                   template, default_template, bases, for_,
+                   fields, content_factory, arguments,
+                   keyword_arguments, set_before_add, set_after_add):
+
+    class_  = SimpleViewClass(
+        template, used_for=schema, bases=bases, name=name)
+
+    class_.schema = schema
+    class_.label = label
+    class_.fieldNames = fields
+    class_._factory_or_id = content_factory
+    class_._factory = property(_getFactory, _setFactory)
+    class_._arguments = arguments
+    class_._keyword_arguments = keyword_arguments
+    class_._set_before_add = set_before_add
+    class_._set_after_add = set_after_add
+
+    class_.generated_form = ViewPageTemplateFile(default_template)
+
+    defineChecker(class_,
+                  NamesChecker(
+                    ("__call__", "__getitem__",
+                     "browserDefault", "publishTraverse"),
+                    permission,
+                    )
+                  )
+    if layer is None:
+        layer = IDefaultBrowserLayer
+
+    s = zapi.getGlobalSiteManager()
+    s.provideAdapter((for_, layer), Interface, name, class_)

browser/editview.py

@@ -0,0 +1,149 @@
+##############################################################################
+#
+# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Edit View Classes
+
+$Id$
+"""
+__docformat__ = 'restructuredtext'
+
+from datetime import datetime
+import transaction
+
+from zope.interface import Interface
+from zope.schema import getFieldNamesInOrder
+from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+from zope.security.checker import defineChecker, NamesChecker
+
+from zope.app import zapi
+from zope.event import notify
+from zope.app.event.objectevent import ObjectModifiedEvent
+from zope.app.event.objectevent import Attributes
+from zope.app.i18n import ZopeMessageIDFactory as _
+from zope.app.form.interfaces import WidgetsError
+from zope.app.pagetemplate.viewpagetemplatefile import ViewPageTemplateFile
+from zope.app.pagetemplate.simpleviewclass import SimpleViewClass
+from zope.app.publisher.browser import BrowserView
+
+from zope.app.form.utility import setUpEditWidgets, applyWidgetsChanges
+from zope.app.form.browser.submit import Update
+
+
+class EditView(BrowserView):
+    """Simple edit-view base class
+
+    Subclasses should provide a `schema` attribute defining the schema
+    to be edited.
+
+    The automatically generated widgets are available by name through
+    the attributes `*_widget`.
+    (E.g. ``view.title_widget for the title widget``)
+    """
+
+    errors = ()
+    update_status = None
+    label = ''
+
+    # Fall-back field names computes from schema
+    fieldNames = property(lambda self: getFieldNamesInOrder(self.schema))
+    # Fall-back template
+    generated_form = ViewPageTemplateFile('edit.pt')
+
+    def __init__(self, context, request):
+        super(EditView, self).__init__(context, request)
+        self._setUpWidgets()
+
+    def _setUpWidgets(self):
+        self.adapted = self.schema(self.context)
+        setUpEditWidgets(self, self.schema, source=self.adapted, 
+                         names=self.fieldNames)
+
+    def setPrefix(self, prefix):
+        for widget in self.widgets():
+            widget.setPrefix(prefix)
+
+    def widgets(self):
+        return [getattr(self, name+'_widget')
+                for name in self.fieldNames]
+
+    def changed(self):
+        # This method is overridden to execute logic *after* changes
+        # have been made.
+        pass
+
+    def update(self):
+        if self.update_status is not None:
+            # We've been called before. Just return the status we previously
+            # computed.
+            return self.update_status
+
+        status = ''
+
+        content = self.adapted
+
+        if Update in self.request:
+            changed = False
+            try:
+                changed = applyWidgetsChanges(self, self.schema,
+                    target=content, names=self.fieldNames)
+                # We should not generate events when an adapter is used.
+                # That's the adapter's job.
+                if changed and self.context is self.adapted:
+                    description = Attributes(self.schema, *self.fieldNames)
+                    notify(ObjectModifiedEvent(content, description))
+            except WidgetsError, errors:
+                self.errors = errors
+                status = _("An error occurred.")
+                transaction.abort()
+            else:
+                setUpEditWidgets(self, self.schema, source=self.adapted,
+                                 ignoreStickyValues=True, 
+                                 names=self.fieldNames)
+                if changed:
+                    self.changed()
+                    formatter = self.request.locale.dates.getFormatter(
+                        'dateTime', 'medium')
+                    status = _("Updated on ${date_time}")
+                    status.mapping = {'date_time': formatter.format(
+                        datetime.utcnow())}
+
+        self.update_status = status
+        return status
+
+
+def EditViewFactory(name, schema, label, permission, layer,
+                    template, default_template, bases, for_, fields,
+                    fulledit_path=None, fulledit_label=None):
+
+    class_ = SimpleViewClass(template, used_for=schema, bases=bases, name=name)
+    class_.schema = schema
+    class_.label = label
+    class_.fieldNames = fields
+
+    class_.fulledit_path = fulledit_path
+    if fulledit_path and (fulledit_label is None):
+        fulledit_label = "Full edit"
+
+    class_.fulledit_label = fulledit_label
+
+    class_.generated_form = ViewPageTemplateFile(default_template)
+
+    defineChecker(class_,
+                  NamesChecker(("__call__", "__getitem__",
+                                "browserDefault", "publishTraverse"),
+                               permission))
+    if layer is None:
+        layer = IDefaultBrowserLayer
+
+    s = zapi.getGlobalSiteManager()
+    s.provideAdapter((for_, layer), Interface, name, class_)