WIP: Helpers

buildout.cfg

@@ -25,6 +25,7 @@ plone.rest = git ${remotes:plone}/plone.rest.git pushurl=${remotes:plone_push}/p
 recipe = plone.recipe.zope2instance
 user = admin:admin
 http-address = 8080
+resources = ${buildout:directory}/resources
 eggs =
     Plone
     Pillow
@@ -69,7 +70,7 @@ setuptools = 8.3
 zc.buildout = 2.2.5
 zc.recipe.egg = 2.0.1
 
-flake8 = 2.3.0
+flake8 = 2.4.0
 
 robotframework = 2.8.4
 robotframework-ride = 1.3

setup.py

@@ -46,6 +46,7 @@
         'plone.app.dexterity',
         'jsonutil',
         'collective.instancebehavior',
+        'pyquery',
         'plone.restapi',
     ],
     extras_require={

src/Products/CMFPlomino/browser/configure.zcml

@@ -2,6 +2,7 @@
     xmlns="http://namespaces.zope.org/zope"
     xmlns:browser="http://namespaces.zope.org/browser"
     xmlns:plone="http://namespaces.plone.org/plone"
+    xmlns:z3c="http://namespaces.zope.org/z3c"
     i18n_domain="Products.CMFPlomino">
 
     <!-- permissions -->
@@ -95,6 +96,13 @@
         permission="zope.Public"
         />
 
+    <browser:page
+        for="Products.CMFPlomino.contents.form.IPlominoForm"
+        name="page"
+        class=".form.PageView"
+        permission="zope.Public"
+        />
+
     <browser:page
         for="Products.CMFPlomino.contents.form.IPlominoForm"
         name="add-field"
@@ -162,43 +170,36 @@
     <browser:page
         name="tinyform"
         for="Products.CMFPlomino.contents.form.IPlominoForm"
-        class=".tinymce.PlominoForm"
+        class=".tinymce.PlominoFormSettings"
         permission="zope.Public"
         allowed_attributes="getField addField addLabel addAction addHidewhen addCache addSubForm action_template"
         />
 
    <browser:page
         name="tinyfield"
         for="Products.CMFPlomino.contents.field.IPlominoField"
-        class=".tinymce.PlominoField"
+        class=".tinymce.PlominoFieldSettings"
         permission="zope.Public"
         allowed_attributes="setFieldProperties"
         />
 
    <browser:page
         name="tinyhidewhen"
         for="Products.CMFPlomino.contents.hidewhen.IPlominoHidewhen"
-        class=".tinymce.PlominoHidewhen"
+        class=".tinymce.PlominoHidewhenSettings"
         permission="zope.Public"
         allowed_attributes="setHidewhenProperties"
         />
 
    <browser:page
         name="tinyaction"
         for="Products.CMFPlomino.contents.action.IPlominoAction"
-        class=".tinymce.PlominoAction"
+        class=".tinymce.PlominoActionSettings"
         permission="zope.Public"
         allowed_attributes="setActionProperties"
         />
 
     <!--
-   <browser:page
-        name="tinyhidewhen"
-        for="Products.CMFPlomino.contents..IPlominoHidewhen"
-        class=".hidewhen.PlominoHidewhen"
-        permission="zope.Public"
-        allowed_attributes="setHidewhenProperties"
-        />
 
    <browser:page
         name="tinycache"
@@ -209,6 +210,89 @@
         />
     -->
 
+    <!--<browser:page-->
+        <!--for="Products.CMFPlomino.contents.form.IPlominoForm"-->
+        <!--name="HelperForm"-->
+        <!--class=".helpers.HelperView"-->
+        <!--attribute="openform"-->
+        <!--permission="zope.Public"-->
+        <!--/>-->
+
+  <adapter
+      factory="Products.CMFPlomino.browser.helpers.SubformWidget"
+      provides="z3c.form.interfaces.IFieldWidget"
+      for="zope.schema.interfaces.IAbstractSet
+           zope.schema.interfaces.IObject
+           plone.app.z3cform.interfaces.IPloneFormLayer"
+      />
+  <adapter factory=".helpers.SubformWidgetConverter" />
+    <subscriber
+      for="Products.CMFPlomino.contents.form.IPlominoForm
+           zope.lifecycleevent.interfaces.IObjectModifiedEvent"
+      handler=".helpers.update_helpers"
+      />
+    <subscriber
+      for="Products.CMFPlomino.contents.field.IPlominoField
+           zope.lifecycleevent.interfaces.IObjectModifiedEvent"
+      handler=".helpers.update_helpers"
+      />
+    <subscriber
+      for="Products.CMFPlomino.contents.action.IPlominoAction
+           zope.lifecycleevent.interfaces.IObjectModifiedEvent"
+      handler=".helpers.update_helpers"
+      />
+    <subscriber
+      for="Products.CMFPlomino.contents.hidewhen.IPlominoHidewhen
+           zope.lifecycleevent.interfaces.IObjectModifiedEvent"
+      handler=".helpers.update_helpers"
+      />
+    <subscriber
+      for="Products.CMFPlomino.contents.view.IPlominoView
+           zope.lifecycleevent.interfaces.IObjectModifiedEvent"
+      handler=".helpers.update_helpers"
+      />
+
+    <plone:behavior
+        title="Helpers"
+        description="Lets an object use external forms to generate its formulas"
+        provides=".helpers.IHelpers"
+        factory=".helpers.Helpers"
+        />
+        <!--for="Products.CMFPlomino.contents.form.IPlominoForm"-->
+    <!--<plone:behavior-->
+        <!--title="Helpers"-->
+        <!--description="Lets an object use external forms to generate its formulas"-->
+        <!--provides=".helpers.IHelpers"-->
+        <!--for="Products.CMFPlomino.contents.field.IPlominoField"-->
+        <!--/>-->
+    <!--<plone:behavior-->
+        <!--title="Helpers"-->
+        <!--description="Lets an object use external forms to generate its formulas"-->
+        <!--provides=".helpers.IHelpers"-->
+        <!--for="Products.CMFPlomino.contents.action.IPlominoAction"-->
+        <!--/>-->
+    <!--<plone:behavior-->
+        <!--title="Helpers"-->
+        <!--description="Lets an object use external forms to generate its formulas"-->
+        <!--provides=".helpers.IHelpers"-->
+        <!--for="Products.CMFPlomino.contents.hidewhen.IPlominoHidewhen"-->
+        <!--/>-->
+    <!--<plone:behavior-->
+        <!--title="Helpers"-->
+        <!--description="Lets an object use external forms to generate its formulas"-->
+        <!--provides=".helpers.IHelpers"-->
+        <!--for="Products.CMFPlomino.contents.view.IPlominoView"-->
+        <!--/>-->
+
+  <z3c:widgetTemplate
+      mode="input"
+      widget=".helpers.ISubformWidget"
+      layer="plone.app.z3cform.interfaces.IPloneFormLayer"
+      template="templates/multi_helpers.pt"
+      />
+
+
+
   <plone:portlet
       name="plomino.designportlet"
       interface=".portlet.IPortlet"

src/Products/CMFPlomino/browser/document.py

@@ -6,6 +6,8 @@
 from Products.Five.browser import BrowserView
 
 from ..config import DESIGN_PERMISSION
+from ..config import SCRIPT_ID_DELIMITER
+from ..exceptions import PlominoScriptException
 
 
 class DocumentView(BrowserView):
@@ -26,6 +28,20 @@ def __init__(self, context, request):
         self.form = None
 
     def publishTraverse(self, request, name):
+        if name == "page" or name == "pageview":
+            # Stop traversing
+            request['TraversalRequestNameStack'] = []
+            self.action = name
+            # Default page is page 1
+            self.page = 1
+            # Ignore everything past the first page
+            if request.path:
+                try:
+                    self.page = int(request.path[0])
+                except ValueError:
+                    pass
+            self.request['plomino_current_page'] = self.page
+            return self
         if name == "OpenDocument" or name == "view":
             self.action = "view"
             return self
@@ -71,7 +87,14 @@ def publishTraverse(self, request, name):
         return self
 
     def render(self):
+        if self.action == "page":
+            return self._page_edit()
+        if self.action == "pageview":
+            return self._page_view()
         if self.action == "edit":
+            # If a user tries to edit a multipage form
+            if self.target.getIsMulti():
+                return self.redirect('page', '1')
             return self.edit_template()
         if self.action == "bareedit":
             return self.bare_edit_template()
@@ -94,7 +117,143 @@ def render(self):
             else:
                 raise Unauthorized("You cannot read this content")
         else:
+            # If a user tries to view a multipage form
+            if self.target.getIsMulti():
+                return self.redirect('pageview', '1')
             return self.view_template()
 
     def __call__(self):
         return self.render()
+
+    def _page_edit(self):
+        # Multipage edit mode
+        form = self.target.getForm()
+
+        # Get multi page information
+        current_page = form._get_current_page()
+        num_pages = form._get_num_pages()
+
+        # If they have gone past the end of the form, send them back
+        if current_page > num_pages:
+            return self.redirect('page', num_pages)
+
+        # Handle POST requests differently.
+        if self.request['REQUEST_METHOD'] == 'POST':
+            # Look up the form. This might be the context, or the parent form
+            # or a value from the request
+
+            if 'back' in self.request.form or 'previous' in self.request.form:
+                next_page = form._get_next_page(self.request, doc=self.target, action='back')
+                return self.redirect('page', next_page)
+
+            # Handle linking
+            linkto = False
+            for key in self.request.form.keys():
+                if key.startswith('plominolinkto-'):
+                    linkto = key.replace('plominolinkto-', '')
+                    next_page = form._get_next_page(self.request, doc=self.target, action='linkto', target=linkto)
+                    return self.redirect('page', next_page)
+
+            # Pass in the current doc as well. This ensures that fields on other
+            # pages are included (possibly needed for calculations)
+            errors = form.validateInputs(self.request, doc=self.target)
+
+            if errors:
+                self.page_errors = errors
+                return self.edit_template()
+
+            # Any buttons progress the user through the form
+            # XXX: We need to handle other types of buttons here
+            if current_page < (num_pages):
+                next_page = form._get_next_page(self.request, doc=self.target, action='continue')
+            else:
+                # Don't go past the end of the form
+                next_page = num_pages
+
+            # execute the beforeSave code of the form
+            error = None
+            try:
+                error = self.target.runFormulaScript(
+                        SCRIPT_ID_DELIMITER.join(['form', form.id, 'beforesave']),
+                        self.target,
+                        form.beforeSaveDocument)
+            except PlominoScriptException, e:
+                e.reportError('Form submitted, but beforeSave formula failed')
+
+            if error:
+                errors.append({'field': 'beforeSave', 'error': error})
+                self.page_errors = errors
+                # Stay on this page
+                return self.edit_template()
+
+            # Now save and move forwards
+            self.target.setItem('Form', form.id)
+
+            # process editable fields (we read the submitted value in the request)
+            form.readInputs(self.target, self.request, process_attachments=True)
+
+            # refresh computed values, run onSave, reindex. Should never be creation.
+            self.target.save(form, False)
+
+            # If there is a redirect, redirect to it:
+            redirect = self.request.get('plominoredirecturl')
+            if not redirect:
+                redirect = self.target.getItem("plominoredirecturl")
+
+            if redirect:
+                return self.request.RESPONSE.redirect(redirect)
+
+            # Otherwise continue to the next page of the document
+            return self.redirect('page', next_page)
+
+        return self.edit_template()
+
+    def _page_view(self):
+        # Multipage view mode. No need to check validation in this mode.
+        form = self.target.getForm()
+
+        # Get multi page information
+        current_page = form._get_current_page()
+        num_pages = form._get_num_pages()
+
+        # If there is something in the form (i.e. a paging request)
+        if self.request.form:
+            # If they have gone past the end of the form, send them back
+            if current_page > num_pages:
+                return self.redirect('pageview', num_pages)
+
+            if 'back' in self.request.form or 'previous' in self.request.form:
+                next_page = form._get_next_page(
+                    self.request,
+                    doc=self.target,
+                    action='back'
+                )
+                return self.redirect('pageview', next_page)
+
+            # Handle linking
+            linkto = False
+            for key in self.request.form.keys():
+                if key.startswith('plominolinkto-'):
+                    linkto = key.replace('plominolinkto-', '')
+                    next_page = form._get_next_page(self.request, doc=self.target, action='linkto', target=linkto)
+                    return self.redirect('pageview', next_page)
+
+            # Any buttons progress the user through the form
+            # XXX: We need to handle other types of buttons here
+            if current_page < (num_pages):
+                next_page = form._get_next_page(
+                    self.request,
+                    doc=self.target,
+                    action='continue'
+                )
+            else:
+                # Don't go past the end of the form
+                next_page = num_pages
+
+            return self.redirect('pageview', next_page)
+
+        return self.view_template()
+
+    def redirect(self, view, page):
+        url = '%s/%s/%s' % (self.target.absolute_url(), view, page)
+        return self.request.RESPONSE.redirect(url)