Ticket default_description cannot include new lines

[Ryan J Ollos]

Two issues were discussed on the ​mailing list:

1. It should be documented that lines 2:end need to be indented with whitespace to have a multi-line ticket description. For example,

   [ticket]
   default_description = line1 
    line2
    line3
    line4
   

   This would be applicable to any textarea. Description is currently the only one in [ticket] section (TracIni#ticket-section), but we may also need to consider the value parameter of textarea custom fields (TracTicketsCustomFields#AvailableFieldTypesandOptions).

2. Empty lines can't be included in the [ticket] default_description because ConfigParser in Python 2.x does not appear to support empty lines. The empty lines are stripped out. We'll need a workaround such as specifying empty lines with a single \ character, and then stripping out the character before rendering an empty line in the ticket description.

[Jun Omae]

[project] descr option also can be saved multi-lines via admin view.

Another thing is that leading spaces are stripped.

[project]
admin =
admin_trac_url = .
descr = My example project
  2nd line
   3rd line
 
 5th line

[Ryan J Ollos]

The quality of the regexes could probably be improved, but here is what I came up with:

• Test for multi-line strings
• Wrap multi-line strings in double quotes.

There are probably corner cases that need to be dealt with (escape inline double-quotes?). I'm just posting this now in case someone has a better idea for approaching the problem.

trac/config.py

@@ -17 +17 @@
 from ConfigParser import ConfigParser
 from copy import deepcopy
 import os.path
+import re
 
 from genshi.builder import tag
 from trac.admin import AdminCommandError, IAdminCommandProvider
@@ -398 +399 @@
             value = u''
         elif isinstance(value, basestring):
             value = to_unicode(value)
+            if re.search(r'[\r\n]+', value):
+                value = re.sub(r'^"|"$', '', value, flags=re.M)
         self._cache[key] = value
         return value
 
@@ -507 +510 @@
             value_str = ''
         else:
             value_str = _to_utf8(value)
+        # Escape whitespace on multi-line strings
+        if re.search(r'[\r\n]+', value_str):
+            value_str = re.sub(r'^([^\r\n]*)', r'"\1"', value_str, flags=re.M)
         return self.config.parser.set(name_str, key_str, value_str)
 
     def remove(self, key):

​ConfigParser in Python 3.3 allows empty lines through the empty_lines_in_values option, but there's no support for leading or trailing whitespace on the lines.

[Ryan J Ollos]

Moved ticket assigned to next-stable-1.0.x since maintenance of 1.0.x is coming to a close. Please move the ticket back if it's critical to fix on 1.0.x.

[Ryan J Ollos]

Milestone renamed