Roadmap iCalendar not compliant with rfc2445

[hvr@…]

according to ​http://www.ietf.org/rfc/rfc2445.txt (at least) the following requirements are not followed by the roadmap-generated iCalendar files, causing evolution-2.8 to ignore the VTODO items.

quoting from 4.8.4.7 Unique Identifier:

   Conformance: The property MUST be specified in the "VEVENT", "VTODO",
   "VJOURNAL" or "VFREEBUSY" calendar components.

quoting from 4.3.11 Text:

     text       = *(TSAFE-CHAR / ":" / DQUOTE / ESCAPED-CHAR)
     ; Folded according to description above

     ESCAPED-CHAR = "\\" / "\;" / "\," / "\N" / "\n")
        ; \\ encodes \, \N or \n encodes newline
        ; \; encodes ;, \, encodes ,

     TSAFE-CHAR = %x20-21 / %x23-2B / %x2D-39 / %x3C-5B
                  %x5D-7E / NON-US-ASCII
        ; Any character except CTLs not needed by the current
        ; character set, DQUOTE, ";", ":", "\", ","

[hvr@…]

The following patch against source:tags/trac-0.9.5/trac/ticket/roadmap.py​ fixes the defect for me

trac/ticket/roadmap.py

@@ -209 +209 @@
                 else: return 'CANCELLED'
             else: return ''
 
+        def escape_ics(text):
+            s = ''.join(map(lambda c: (c in ";,\\") and '\\'+c or c, text))
+            return '\\n'.join(re.split(r'[\r\n]+', s))
+ 
         def write_prop(name, value, params={}):
             text = ';'.join([name] + [k + '=' + v for k, v in params.items()]) \
-                 + ':' + '\\n'.join(re.split(r'[\r\n]+', value))
+                 + ':' + escape_ics(value)
             firstline = 1
             while text:
                 if not firstline: text = ' ' + text
@@ -254 +258 @@
                            if ticket['owner'] == user]:
                 ticket = Ticket(self.env, tkt_id)
                 write_prop('BEGIN', 'VTODO')
+                write_prop('UID', '<%s/ticket/%s@%s>' % (req.cgi_location,
+                                                         tkt_id, host))
                 if milestone.has_key('due'):
                     write_prop('RELATED-TO', uid)
                     write_date('DUE', localtime(milestone['due']))

[hvr@…]

this applies to 0.10rc1 as well

[Emmanuel Blot]

I really think we should stop adding non-critical bug fixes to 0.10.

[hvr@…]

regenerated diff for ​RFC:2445 fix against current trunk:

trac/ticket/roadmap.py

@@ -209 +209 @@
                 else: return 'CANCELLED'
             else: return ''
 
+        def escape_ics(text):
+            s = ''.join(map(lambda c: (c in ";,\\") and '\\'+c or c, text))
+            return '\\n'.join(re.split(r'[\r\n]+', s))
+
         def write_prop(name, value, params={}):
             text = ';'.join([name] + [k + '=' + v for k, v in params.items()]) \
-                 + ':' + '\\n'.join(re.split(r'[\r\n]+', value))
+                 + ':' + escape_ics(value)
             firstline = 1
             while text:
                 if not firstline: text = ' ' + text
@@ -254 +258 @@
                            if ticket['owner'] == user]:
                 ticket = Ticket(self.env, tkt_id)
                 write_prop('BEGIN', 'VTODO')
+                write_prop('UID', '<%s/ticket/%s@%s>' % (req.base_path,
+                                                         tkt_id, host))
                 if milestone.has_key('due'):
                     write_prop('RELATED-TO', uid)
                     write_date('DUE', localtime(milestone['due']))

[Christopher Lenz]

Patch looks good. Many thanks!

[Christopher Lenz]

Applied in [3793].