[gen] Ref.select can now hold a Search instance; began implementation of Ref.link == 'popup'.

fields/ref.py

@@ -18,6 +18,7 @@
 import sys, re
 from appy import Object
 from appy.fields import Field
+from appy.fields.search import Search
 from appy.px import Px
 from appy.gen.layout import Table
 from appy.gen import utils as gutils
@@ -302,6 +303,7 @@ class Ref(Field):
              batchSize=info.batchSize;
              batchNumber=len(objects);
              tiedClassName=tiedClassName|ztool.getPortalType(field.klass);
+             target=ztool.getLinksTargetInfo(field.klass);
              mayEdit=mayEdit|\
                      not field.isBack and zobj.mayEdit(field.writePermission);
              mayUnlink=False;
@@ -431,8 +433,8 @@ class Ref(Field):
      </x>''')
 
     pxCell = pxView
-    pxEdit = Px('''
+    pxEdit = Px('''<x if="(field.link) and (field.link != 'list')">
-     <select if="field.link"
+     <select if="field.link != 'popup'"
              var2="objects=field.getPossibleValues(zobj);
                    uids=[o.id for o in field.getValue(zobj, appy=False)]"
              name=":name" id=":name" size=":isMultiple and field.height or ''"
@@ -445,7 +447,19 @@ class Ref(Field):
               selected=":inRequest and (uid in requestValue) or \
                                        (uid in uids)" value=":uid"
               title=":title">:ztool.truncateValue(title, field.width)</option>
-     </select>''')
+     </select>
+     <!-- A button for opening the popup if field.link is "popup". -->
+     <a if="field.link == 'popup'" target="appyIFrame"
+        var2="tiedClassName=ztool.getPortalType(field.klass);
+              className=ztool.getPortalType(obj.klass)"
+        href=":'%s/query?className=%s&amp;search=%s:%s&amp;popup=1' % \
+               (ztool.absolute_url(), tiedClassName, className, field.name)">
+      <input type="button" class="buttonSmall button"
+             var="label=_('search_button')" value=":label"
+             style=":'%s; %s' % (url('search', bg=True), \
+                                 ztool.getButtonWidth(label))"
+             onclick="openPopup('iframePopup')"/>
+     </a></x>''')
 
     pxSearch = Px('''
      <!-- The "and" / "or" radio buttons -->
@@ -509,7 +523,8 @@ class Ref(Field):
         # "list",  the user will, on the view page, choose objects from a list
         #          of objects which is similar to those rendered in pxViewList;
         # "popup", the user will, on the edit page, choose objects from a popup
-        #          menu.
+        #          menu. In this case, parameter "select" must hold a Search
+        #          instance.
         self.link = link
         # May the user unlink existing objects?
         self.unlink = unlink
@@ -558,7 +573,6 @@ class Ref(Field):
             self.isBack = False
             # Initialise the backward reference
             self.back = back
-            back.isBack = True
             back.back = self
             # klass may be None in the case we are defining an auto-Ref to the
             # same class as the class where this field is defined. In this case,
@@ -568,6 +582,8 @@ class Ref(Field):
             # K.myField.klass = K
             # setattr(K, K.myField.back.attribute, K.myField.back)
             if klass: setattr(klass, back.attribute, back)
+        else:
+            self.isBack = True
         # When displaying a tabular list of referenced objects, must we show
         # the table headers?
         self.showHeaders = showHeaders
@@ -586,9 +602,13 @@ class Ref(Field):
         #  - necessary because in some cases we do not have an instance at our
         #    disposal, ie, when we need to compute a list of objects on a
         #    search screen.
+        # "select" can also hold a Search instance. In this case, put any name
+        # in Search's mandatory parameter "name": it will be ignored and
+        # replaced with an internal technical name.
         # NOTE that when a method is defined in field "masterValue" (see parent
         # class "Field"), it will be used instead of select (or sselect below).
         self.select = select
+        if isinstance(select, Search): self.select.name = '_field_'
         # If you want to specify, for the search screen, a list of objects that
         # is different from the one produced by self.select, define an
         # alternative method in field "sselect" below.
@@ -658,6 +678,17 @@ class Ref(Field):
                        historized, mapping, label, sdefault, scolspan, swidth,
                        sheight, persist)
         self.validable = bool(self.link)
+        self.checkParameters()
+
+    def checkParameters(self):
+        '''Ensures this Ref is correctly defined.'''
+        # For forward Refs, "add" and "link" can't both be used.
+        if not self.isBack and (self.add and self.link):
+            raise Exception('Parameters "add" and "link" can\'t both be used.')
+        # If link is "popup", "select" must hold a Search instance.
+        if (self.link == 'popup') and not isinstance(self.select, Search):
+            raise Exception('When "link" is "popup", "select" must be a ' \
+                            'appy.fields.search.Search instance.')
 
     def getDefaultLayouts(self):
         return {'view': Table('l-f', width='100%'), 'edit': 'lrv-f'}
@@ -744,6 +775,8 @@ class Ref(Field):
         '''
         req = obj.REQUEST
         obj = obj.appy()
+        paginated = startNumber != None
+        isSearch = False
         if 'masterValues' in req:
             # Convert masterValue(s) from id(s) to real object(s).
             masterValues = req['masterValues'].strip()
@@ -764,10 +797,20 @@ class Ref(Field):
                 objects = []
             else:
                 if not self.select:
-                    # No select method has been defined: we must retrieve all
+                    # No select method or search has been defined: we must
-                    # objects of the referred type that the user is allowed to
+                    # retrieve all objects of the referred type that the user
-                    # access.
+                    # is allowed to access.
                     objects = obj.search(self.klass)
+                else:
+                    if isinstance(self.select, Search):
+                        isSearch = True
+                        maxResults = paginated and self.maxPerPage or 'NO_LIMIT'
+                        start = startNumber or 0
+                        className = obj.tool.o.getPortalType(self.klass)
+                        objects = obj.o.executeQuery(className,
+                            startNumber=start, search=self.select,
+                            maxResults=maxResults)
+                        objects.objects = [o.appy() for o in objects.objects]
                     else:
                         objects = self.select(obj)
         # Remove already linked objects if required.
@@ -775,19 +818,25 @@ class Ref(Field):
             uids = getattr(obj.o.aq_base, self.name, None)
             if uids:
                 # Browse objects in reverse order and remove linked objects.
-                i = len(objects) - 1
+                if isSearch: objs = objects.objects
+                else: objs = objects
+                i = len(objs) - 1
                 while i >= 0:
-                    if objects[i].uid in uids: del objects[i]
+                    if objs[i].id in uids: del objs[i]
                     i -= 1
-        # Restrict, if required, the result to self.maxPerPage starting at
+        # If possible values are not retrieved from a Search, restrict (if
-        # p_startNumber. Unlike m_getValue, we already have all objects in
+        # required) the result to self.maxPerPage starting at p_startNumber.
-        # "objects": we can't limit objects "waking up" to at most
+        # Indeed, in this case, unlike m_getValue, we already have all objects
+        # in "objects": we can't limit objects "waking up" to at most
         # self.maxPerPage.
+        if paginated and not isSearch:
             total = len(objects)
-        if startNumber != None:
             objects = objects[startNumber:startNumber + self.maxPerPage]
         # Return the result, wrapped in a SomeObjects instance if required.
-        if not someObjects: return objects
+        if not someObjects:
+            if isSearch: return objects.objects
+            return objects
+        if isSearch: return objects
         res = gutils.SomeObjects()
         res.totalNumber = total
         res.batchSize = self.maxPerPage

fields/search.py

@@ -167,12 +167,12 @@ class UiSearch:
                 label = '%s_plural' % className
             elif search.name == 'customSearch':
                 label = 'search_results'
+            elif search.name == '_field_':
+                label = None
             else:
                 label = '%s_search_%s' % (className, search.name)
                 labelDescr = label + '_descr'
-            self.translated = tool.translate(label)
+            _ = tool.translate
-            if labelDescr:
+            self.translated = label and _(label) or ''
-                self.translatedDescr = tool.translate(labelDescr)
+            self.translatedDescr = labelDescr and _(labelDescr) or ''
-            else:
-                self.translatedDescr = ''
 # ------------------------------------------------------------------------------

gen/mixins/ToolMixin.py

@@ -73,13 +73,15 @@ class ToolMixin(BaseMixin):
                 url = self.goto('%s/home' % self.absolute_url())
         return url
 
-    def getHomeObject(self):
+    def getHomeObject(self, inPopup=False):
         '''The concept of "home object" is the object where the user must "be",
            even if he is "nowhere". For example, if the user is on a search
            screen, there is no contextual object. In this case, if we have a
            home object for him, we will use it as contextual object, and its
            portlet menu will nevertheless appear: the user will not have the
            feeling of being lost.'''
+        # If we are in the popup, we do not want any home object in the way.
+        if inPopup: return
         # If the app defines a method "getHomeObject", call it.
         try:
             return self.appy().getHomeObject()
@@ -727,6 +729,10 @@ class ToolMixin(BaseMixin):
             # It is a custom search whose parameters are in the session.
             fields = self.REQUEST.SESSION['searchCriteria']
             res = Search('customSearch', **fields)
+        elif ':' in name:
+            # The search is defined in a Ref field with link=popup
+            refClass, ref = name.split(':')
+            res = getattr(self.getAppyClass(refClass), ref).select
         elif name:
             appyClass = self.getAppyClass(className)
             # Search among static searches

gen/ui/appy.js

@@ -210,11 +210,11 @@ function askAjaxChunk(hook,mode,url,px,params,beforeSend,onGet) {
 
 /* The functions below wrap askAjaxChunk for getting specific content through
    an Ajax request. */
-function askQueryResult(hookId, objectUrl, className, searchName,
+function askQueryResult(hookId, objectUrl, className, searchName, popup,
                         startNumber, sortKey, sortOrder, filterKey) {
   // Sends an Ajax request for getting the result of a query.
   var params = {'className': className, 'search': searchName,
-                'startNumber': startNumber};
+                'startNumber': startNumber, 'popup': popup};
   if (sortKey) params['sortKey'] = sortKey;
   if (sortOrder) params['sortOrder'] = sortOrder;
   if (filterKey) {
@@ -725,15 +725,24 @@ function openPopup(popupId, msg, width, height) {
   }
   // Open the popup
   var popup = document.getElementById(popupId);
-  // Put it at the right place on the screen
+  // Put it at the right place on the screen and give it the right dimensions
   var scrollTop = document.documentElement.scrollTop || window.pageYOffset || 0;
   popup.style.top = (scrollTop + 150) + 'px';
   if (width) popup.style.width = width + 'px';
+  if (height) popup.style.height = height + 'px';
   if (popupId == 'iframePopup') {
     // Initialize iframe's width.
     var iframe = document.getElementById('appyIFrame');
+    if (!width) width = window.innerWidth - 200;
+    if (!height) {
+      height = window.innerHeight - 200;
+      popup.style.top = ((window.innerHeight - height) / 2).toFixed() + 'px';
+    }
+    popup.style.left = ((window.innerWidth - width) / 2).toFixed() + 'px';
+    popup.style.width = width + 'px';
     iframe.style.width = (width-20) + 'px';
-    if (height) iframe.style.height = height + 'px';
+    popup.style.height = height + 'px';
+    iframe.style.height = (height-20) + 'px';
   }
   popup.style.display = 'block';
 }

gen/wrappers/ToolWrapper.py

@@ -431,9 +431,9 @@ class ToolWrapper(AbstractWrapper):
                batchSize=queryResult.batchSize;
                batchNumber=len(zobjects);
                ajaxHookId='queryResult';
-               navBaseCall='askQueryResult(%s,%s,%s,%s,**v**)' % \
+               navBaseCall='askQueryResult(%s,%s,%s,%s,%s,**v**)' % \
                  (q(ajaxHookId), q(ztool.absolute_url()), q(className), \
-                  q(searchName));
+                  q(searchName),int(inPopup));
                showNewSearch=showNewSearch|True;
                enableLinks=enableLinks|True;
                newSearchUrl='%s/search?className=%s%s' % \
@@ -446,7 +446,7 @@ class ToolWrapper(AbstractWrapper):
        <!-- Display here POD templates if required. -->
        <table var="fields=ztool.getResultPodFields(className);
                    layoutType='view'"
-              if="zobjects and fields" align=":dright">
+              if="not inPopup and zobjects and fields" align=":dright">
         <tr>
          <td var="zobj=zobjects[0]; obj=zobj.appy()"
              for="field in fields"
@@ -455,7 +455,7 @@ class ToolWrapper(AbstractWrapper):
        </table>
 
        <!-- The title of the search -->
-       <p>
+       <p if="not inPopup">
         <x>::uiSearch.translated</x> (<span class="discreet">:totalNumber</span>)
         <x if="showNewSearch and (searchName == 'customSearch')">&nbsp;&mdash;
          &nbsp;<i><a href=":newSearchUrl">:_('search_new')</a></i>

gen/wrappers/UserWrapper.py

@@ -6,6 +6,7 @@ from appy.gen import utils as gutils
 # ------------------------------------------------------------------------------
 class UserWrapper(AbstractWrapper):
     workflow = WorkflowOwner
+    specialUsers = ('system', 'anon', 'admin')
 
     def showLogin(self):
         '''When must we show the login field?'''
@@ -42,7 +43,7 @@ class UserWrapper(AbstractWrapper):
         if not self.login or (login != self.login):
             # A new p_login is requested. Check if it is valid and free.
             # Some logins are not allowed.
-            if login in ('admin', 'anon', 'system'):
+            if login in self.specialUsers:
                 return self.translate('login_reserved')
             # Check that no user or group already uses this login.
             if self.count('User', noSecurity=True, login=login) or \
@@ -219,7 +220,7 @@ class UserWrapper(AbstractWrapper):
 
     def mayEdit(self):
         '''No one can edit users "system" and "anon".'''
-        if self.o.id in ('system', 'anon'): return
+        if self.o.id in ('anon', 'system'): return
         # Call custom "mayEdit" when present.
         custom = self._getCustomMethod('mayEdit')
         if custom: return self._callCustom('mayEdit')
@@ -227,7 +228,7 @@ class UserWrapper(AbstractWrapper):
 
     def mayDelete(self):
         '''No one can delete users "system", "anon" and "admin".'''
-        if self.o.id in ('system', 'anon', 'admin'): return
+        if self.o.id in self.specialUsers: return
         # Call custom "mayDelete" when present.
         custom = self._getCustomMethod('mayDelete')
         if custom: return self._callCustom('mayDelete')

gen/wrappers/__init__.py

@@ -75,16 +75,16 @@ class AbstractWrapper(object):
     # The template PX for all pages.
     pxTemplate = Px('''
      <html var="ztool=tool.o;                   user=tool.user;
-                obj=obj or ztool.getHomeObject();
+                req=ztool.REQUEST;              resp=req.RESPONSE;
+                inPopup=req.get('popup') == '1';
+                obj=obj or ztool.getHomeObject(inPopup);
                 zobj=obj and obj.o or None;
                 isAnon=user.login=='anon';      app=ztool.getApp();
                 appFolder=app.data;             url = ztool.getIncludeUrl;
                 appName=ztool.getAppName();     _=ztool.translate;
-                req=ztool.REQUEST;              resp=req.RESPONSE;
                 dummy=setattr(req, 'pxContext', _ctx_);
                 lang=ztool.getUserLanguage();   q=ztool.quote;
                 layoutType=ztool.getLayoutType();
-                inPopup=req.get('popup') == '1';
                 showPortlet=not inPopup and ztool.showPortlet(obj, layoutType);
                 dir=ztool.getLanguageDirection(lang);
                 cfg=ztool.getProductConfig(True);