Ticket #3425: orderedconfig.patch

trac/config.py

@@ -14 +14 @@
 #
 # Author: Christopher Lenz <cmlenz@gmx.de>
 
-from ConfigParser import ConfigParser
+from ConfigParser import ConfigParser, DuplicateSectionError, DEFAULTSECT
+from odict import OrderedDict
 import os
 try:
     set
@@ -31 +32 @@
 
 _TRUE_VALUES = ('yes', 'true', 'on', 'aye', '1', 1, True)
 
+class OrderedConfigParser(ConfigParser):
+    """ """
+    def __init__(self, defaults=None):
+        """Override default constructor"""
+        self._sections = OrderedDict()
+        if defaults is None:
+            self._defaults = OrderedDict()
+        else:
+            self._defaults = defaults
+            
+    def add_section(self, section):
+        """Override RawConfigParser method"""
+        if section in self._sections:
+            raise DuplicateSectionError(section)
+        self._sections[section] = OrderedDict()
+        
+    def _read(self, fp, fpname):
+        """Override RawConfigParser method"""
+        cursect = None                            # None, or a dictionary
+        optname = None
+        lineno = 0
+        e = None                                  # None, or an exception
+        while True:
+            line = fp.readline()
+            if not line:
+                break
+            lineno = lineno + 1
+            # comment or blank line?
+            if line.strip() == '' or line[0] in '#;':
+                continue
+            if line.split(None, 1)[0].lower() == 'rem' and line[0] in "rR":
+                # no leading whitespace
+                continue
+            # continuation line?
+            if line[0].isspace() and cursect is not None and optname:
+                value = line.strip()
+                if value:
+                    cursect[optname] = "%s\n%s" % (cursect[optname], value)
+            # a section header or option header?
+            else:
+                # is it a section header?
+                mo = self.SECTCRE.match(line)
+                if mo:
+                    sectname = mo.group('header')
+                    if sectname in self._sections:
+                        cursect = self._sections[sectname]
+                    elif sectname == DEFAULTSECT:
+                        cursect = self._defaults
+                    else:
+                        cursect = OrderedDict()
+                        cursect['__name__'] = sectname
+                        self._sections[sectname] = cursect
+                    # So sections can't start with a continuation line
+                    optname = None
+                # no section header in the file?
+                elif cursect is None:
+                    raise MissingSectionHeaderError(fpname, lineno, `line`)
+                # an option line?
+                else:
+                    mo = self.OPTCRE.match(line)
+                    if mo:
+                        optname, vi, optval = mo.group('option', 'vi', 'value')
+                        if vi in ('=', ':') and ';' in optval:
+                            # ';' is a comment delimiter only if it follows
+                            # a spacing character
+                            pos = optval.find(';')
+                            if pos != -1 and optval[pos-1].isspace():
+                                optval = optval[:pos]
+                        optval = optval.strip()
+                        # allow empty values
+                        if optval == '""':
+                            optval = ''
+                        optname = self.optionxform(optname.rstrip())
+                        cursect[optname] = optval
+                    else:
+                        # a non-fatal parsing error occurred.  set up the
+                        # exception but keep going. the exception will be
+                        # raised at the end of the file and will contain a
+                        # list of all bogus lines
+                        if not e:
+                            e = ParsingError(fpname)
+                        e.append(lineno, `line`)
+        # if any parsing errors occurred, raise an exception
+        if e:
+            raise e
 
 class ConfigurationError(TracError):
     """Exception raised when a value in the configuration file is not valid."""
@@ -46 +132 @@
     def __init__(self, filename):
         self._sections = {}
         self.filename = filename
-        self.parser = ConfigParser()
+        self.parser = OrderedConfigParser()
         self._lastmtime = 0
         self.site_filename = os.path.join(default_dir('conf'), 'trac.ini')
-        self.site_parser = ConfigParser()
+        self.site_parser = OrderedConfigParser()
         self._lastsitemtime = 0
         self.parse_if_needed()
 
@@ -142 +228 @@
             return
 
         # Only save options that differ from the defaults
-        config = ConfigParser()
+        empty_sections = []
         for section in self.sections():
             for option in self[section]:
                 default = self.site_parser.has_option(section, option) and \
                           self.site_parser.get(section, option)
                 current = self.parser.has_option(section, option) and \
                           self.parser.get(section, option)
-                if current is not False and current != default:
-                    if not config.has_section(section):
-                        config.add_section(section)
-                    config.set(section, option, current or '')
+                if default and current and current == default:
+                    self.parser.remove_option(section, option)
+            if not self.parser.options(section):
+                empty_sections.append(section)
+        if empty_sections:
+            map(self.parser.remove_section, empty_sections)
 
         fileobj = file(self.filename, 'w')
         try:
-            config.write(fileobj)
+            self.parser.write(fileobj)
         finally:
             fileobj.close()