[gen] Pod field: added param 'getChecked': if you specify there the name of a Ref field of the same gen class, within the pod template you will be able to know what linked objects are currently selected in the user interface.

fields/pod.py

@@ -45,11 +45,12 @@ class Pod(Field):
 
     # Icon allowing to generate a given template in a given format.
     pxIcon = Px('''
-     <img var="iconSuffix=frozen and 'Frozen' or ''"
+     <img var="iconSuffix=frozen and 'Frozen' or '';
+               gc=field.getChecked and q(field.getChecked) or 'null'"
           src=":url(fmt + iconSuffix)" class="clickable"
           title=":field.getIconTitle(obj, fmt, frozen)"
-          onclick=":'generatePod(%s,%s,%s,%s,%s)' % (q(uid), q(name), \
+          onclick=":'generatePod(%s,%s,%s,%s,%s,null,%s)' % (q(uid), q(name), \
-                    q(info.template), q(fmt), q(ztool.getQueryInfo()))"/>''')
+                   q(info.template), q(fmt), q(ztool.getQueryInfo()), gc)"/>''')
 
     pxView = pxCell = Px('''
      <x var="uid=obj.uid"
@@ -117,7 +118,7 @@ class Pod(Field):
                  focus=False, historized=False, mapping=None, label=None,
                  template=None, templateName=None, showTemplate=None,
                  freezeTemplate=None, context=None, stylesMapping={},
-                 formats=None):
+                 formats=None, getChecked=None):
         # Param "template" stores the path to the pod template(s).
         if not template: raise Exception(Pod.NO_TEMPLATE)
         if isinstance(template, basestring):
@@ -184,6 +185,13 @@ class Pod(Field):
         self.stylesMapping = stylesMapping
         # What are the output formats when generating documents from this pod ?
         self.formats = formats
+        # Parameter "getChecked" can specify the name of a Ref field belonging
+        # to the same gen class. If it is the case, the context of the pod
+        # template will contain an additional object, name "_checked", and
+        # "_checked.<name of the Ref field>" will contain the list of the UIDs
+        # of the referred objects via the Ref field that are currently selected
+        # in the user interface.
+        self.getChecked = getChecked
         if not formats:
             # Compute default ones
             if self.template[0].endswith('.ods'):
@@ -248,7 +256,7 @@ class Pod(Field):
         return res
 
     def getValue(self, obj, template=None, format=None, result=None,
-                 queryData=None, customParams=None, noSecurity=False):
+                 queryData=None, customContext=None, noSecurity=False):
         '''For a pod field, getting its value means computing a pod document or
            returning a frozen one. A pod field differs from other field types
            because there can be several ways to produce the field value (ie:
@@ -263,9 +271,9 @@ class Pod(Field):
              the OS temp folder;
            * if the pod document is related to a query, the query parameters
              needed to re-trigger the query are given in p_queryData;
-           * p_customParams may be specified. Every custom param must have form
+           * dict p_customContext may be specified and will override any other
-             "name:value". Custom params override any other value available in
+             value available in the context, including values from the
-             the context, including values from the field-specific context.
+             field-specific context.
         '''
         obj = obj.appy()
         template = template or self.template[0]
@@ -315,13 +323,9 @@ class Pod(Field):
                      sortBy=sortKey, sortOrder=sortOrder, filterKey=filterKey,
                      filterValue=filterValue, maxResults='NO_LIMIT')
             podContext['objects'] = [o.appy() for o in objs.objects]
-        # Add the field-specific context if present.
+        # Add the field-specific and custom contexts if present.
-        if specificContext:
+        if specificContext: podContext.update(specificContext)
-            podContext.update(specificContext)
+        if customContext: podContext.update(customContext)
-        # If a custom param comes from the request, add it to the context.
-        if customParams:
-            paramsDict = eval(customParams)
-            podContext.update(paramsDict)
         # Define a potential global styles mapping
         if callable(self.stylesMapping):
             stylesMapping = self.callMethod(obj, self.stylesMapping)
@@ -456,6 +460,30 @@ class Pod(Field):
             res += ' (%s)' % obj.translate('frozen')
         return res
 
+    def getCustomContext(self, obj, rq):
+        '''Before calling pod to compute a result, if specific elements must be
+           added to the context, compute it here.'''
+        res = {}
+        # Get potential custom params from the request. Custom params must be
+        # coded as a string containing a valid Python dict.
+        customParams = rq.get('customParams')
+        if customParams:
+            paramsDict = eval(customParams)
+            res.update(paramsDict)
+        # Compute the selected UIDS if self.getChecked is specified.
+        if self.getChecked:
+            # Get the UIDs specified in the request
+            reqUids = rq['checkedUids'] and rq['checkedUids'].split(',') or []
+            unchecked = rq['checkedSem'] == 'unchecked'
+            uids = {}
+            for uid in getattr(obj.o.aq_base, self.getChecked, ()):
+                if unchecked: condition = uid not in reqUids
+                else:         condition = uid in reqUids
+                if condition: uids[uid] = None
+            res['_checked'] = Object()
+            setattr(res['_checked'], self.getChecked, uids)
+        return res
+
     def onUiRequest(self, obj, rq):
         '''This method is called when an action tied to this pod field
            (generate, freeze, upload...) is triggered from the user
@@ -472,7 +500,7 @@ class Pod(Field):
             # Generate a (or get a frozen) document.
             res = self.getValue(obj, template=template, format=format,
                                 queryData=rq.get('queryData'),
-                                customParams=rq.get('customParams'))
+                                customContext=self.getCustomContext(obj, rq))
             if isinstance(res, basestring):
                 # An error has occurred, and p_res contains the error message.
                 obj.say(res)

gen/ui/appy.js

@@ -656,7 +656,8 @@ function toggleCookie(cookieId) {
 }
 
 // Function that allows to generate a document from a pod template.
-function generatePod(uid,fieldName,template,podFormat,queryData,customParams) {
+function generatePod(uid, fieldName, template, podFormat, queryData,
+                     customParams, getChecked) {
   var f = document.getElementById('podForm');
   f.objectUid.value = uid;
   f.fieldName.value = fieldName;
@@ -666,6 +667,18 @@ function generatePod(uid,fieldName,template,podFormat,queryData,customParams) {
   if (customParams) { f.customParams.value = customParams; }
   else { f.customParams.value = ''; }
   f.action.value = 'generate';
+  f.checkedUids.value = '';
+  f.checkedSem.value = '';
+  if (getChecked) {
+    // We must collect selected objects from a Ref field.
+    var node = document.getElementById(uid + '_' + getChecked);
+    if (node && node.hasOwnProperty('_appy_objs_cbs')) {
+      var uids = [];
+      for (var uid in node['_appy_objs_cbs']) uids.push(uid);
+      f.checkedUids.value = uids.join();
+      f.checkedSem.value = node['_appy_objs_sem'];
+    }
+  }
   f.submit();
 }
 

gen/wrappers/ToolWrapper.py

@@ -139,6 +139,8 @@ class ToolWrapper(AbstractWrapper):
       <input type="hidden" name="podFormat"/>
       <input type="hidden" name="queryData"/>
       <input type="hidden" name="customParams"/>
+      <input type="hidden" name="checkedUids"/>
+      <input type="hidden" name="checkedSem"/>
       <input type="hidden" name="action" value="generate"/>
      </form>''')