Always sort MultilinkHTMLProperty in the correct order...

...usually alphabetically (feature [SF#790512]).

Extract find_sort_key method.

Use nested scopes in make_sort_function.

Author: Johannes Gijsbers

CHANGES.txt

@@ -15,6 +15,8 @@ Feature:
 - Existing trackers (ie. live ones) may be used as templates for new
   trackers - the TEMPLATE-INFO.txt name entry has the tracker's dir name
   appended (so the demo tracker's template name is "classic-demo")
+- Always sort MultilinkHTMLProperty in the correct order, usually
+  alphabetically (sf feature 790512).
 
 Fixed:
 - mysql documentation fixed to note requirement of 4.0+ and InnoDB
@@ -55,7 +57,7 @@ Fixed:
 - Added note to upgrading doc for detectors fix in 0.6.2
 - Added script to help migrating queries from pre-0.6 trackers
 - Fixed "documentation" of getnodeids in roundup.hyperdb
-- Added flush() to DevNull (sf bug #835365)
+- Added flush() to DevNull (sf bug 835365)
 - Fixed javascript for help window for only one checkbox case
 - Date arithmetic was utterly broken, and has been for a long time.
   Date +/- Interval now works, and Date - Date also works (produces

roundup/cgi/templating.py

@@ -1,3 +1,5 @@
+from __future__ import nested_scopes
+
 import sys, cgi, urllib, os, re, os.path, time, errno, mimetypes
 
 from roundup import hyperdb, date, rcsv
@@ -1193,9 +1195,6 @@ def menu(self, size=None, height=None, showid=0, additional=[],
         '''
         value = self._value
 
-        # sort function
-        sortfunc = make_sort_function(self._db, self._prop.classname)
-
         linkcl = self._db.getclass(self._prop.classname)
         l = ['<select name="%s">'%self._formname]
         k = linkcl.labelprop(1)
@@ -1250,6 +1249,11 @@ class MultilinkHTMLProperty(HTMLProperty):
         Also be iterable, returning a wrapper object like the Link case for
         each entry in the multilink.
     '''
+    def __init__(self, *args, **kwargs):
+        HTMLProperty.__init__(self, *args, **kwargs)
+        if self._value:
+            self._value.sort(make_sort_function(self._db, self._prop.classname))
+    
     def __len__(self):
         ''' length of the multilink '''
         return len(self._value)
@@ -1302,11 +1306,8 @@ def plain(self, escape=0):
     def field(self, size=30, showid=0):
         ''' Render a form edit field for the property
         '''
-        sortfunc = make_sort_function(self._db, self._prop.classname)
         linkcl = self._db.getclass(self._prop.classname)
         value = self._value[:]
-        if value:
-            value.sort(sortfunc)
         # map the id to the label property
         if not linkcl.getkey():
             showid=1
@@ -1322,15 +1323,9 @@ def menu(self, size=None, height=None, showid=0, additional=[],
         '''
         value = self._value
 
-        # sort function
-        sortfunc = make_sort_function(self._db, self._prop.classname)
-
         linkcl = self._db.getclass(self._prop.classname)
-        if linkcl.getprops().has_key('order'):  
-            sort_on = ('+', 'order')
-        else:  
-            sort_on = ('+', linkcl.labelprop())
-        options = linkcl.filter(None, conditions, sort_on, (None,None)) 
+        sort_on = ('+', find_sort_key(linkcl))
+        options = linkcl.filter(None, conditions, sort_on)
         height = height or min(len(options), 7)
         l = ['<select multiple name="%s" size="%s">'%(self._formname, height)]
         k = linkcl.labelprop(1)
@@ -1386,14 +1381,17 @@ def make_sort_function(db, classname):
     '''Make a sort function for a given class
     '''
     linkcl = db.getclass(classname)
-    if linkcl.getprops().has_key('order'):
-        sort_on = 'order'
-    else:
-        sort_on = linkcl.labelprop()
-    def sortfunc(a, b, linkcl=linkcl, sort_on=sort_on):
+    sort_on = find_sort_key(linkcl)
+    def sortfunc(a, b):
         return cmp(linkcl.get(a, sort_on), linkcl.get(b, sort_on))
     return sortfunc
 
+def find_sort_key(linkcl):
+    if linkcl.getprops().has_key('order'):
+        return 'order'
+    else:
+        return linkcl.labelprop()
+
 def handleListCGIValue(value):
     ''' Value is either a single item or a list of items. Each item has a
         .value that we're actually interested in.