Ticket #7316: 7316-timeline-render-hints-r7595.diff

trac/attachment.py

@@ -42 +42 @@
                             INavigationContributor
 from trac.web.href import Href
 from trac.wiki.api import IWikiSyntaxProvider
-from trac.wiki.formatter import format_to_oneliner
+from trac.wiki.formatter import format_to
 
 
 class InvalidAttachment(TracError):
@@ -474 +474 @@
             return tag(tag.em(os.path.basename(attachment.id)),
                        _(" attached to "), tag.em(name, title=title))
         elif field == 'description':
-            return format_to_oneliner(self.env, context(attachment.parent),
-                                      descr)
+            return format_to(self.env, None, context(attachment.parent), descr)
    
     def get_search_results(self, req, resource_realm, terms):
         """Return a search result generator suitable for ISearchSource.

trac/mimeview/api.py

@@ -124 +124 @@
         self.resource = resource
         self.href = href
         self.perm = resource and perm and perm(resource) or perm
+        self._hints = None
 
     def from_request(cls, req, resource=None, id=False, version=False,
                      absurls=False):
@@ -171 +172 @@
             context = context.parent
         return '<%s %s>' % (type(self).__name__, ' - '.join(reversed(path)))
 
-    def __call__(self, resource, id=False, version=False):
+    def __call__(self, resource=None, id=False, version=False):
         """Create a nested rendering context.
 
         `self` will be the parent for the new nested context.
 
         :param resource: either a `Resource` object or the realm string for a
                          resource specification to be associated to the new
-                         context
+                         context. If `None`, the resource will be the same
+                         as the resource of the parent context.
         :param id: the identifier part of the resource specification
         :param version: the version of the resource specification
         :return: the new context object
@@ -190 +192 @@
         True
         >>> context(ticket1).resource is ticket1
         True
+        >>> context(ticket1)().resource is ticket1
+        True
         """
-        resource = Resource(resource, id=id, version=version)
+        if resource:
+            resource = Resource(resource, id=id, version=version)
+        else:
+            resource = self.resource
         context = Context(resource, href=self.href, perm=self.perm)
         context.parent = self
 
@@ -222 +229 @@
                 return True
             context = context.parent
 
+    # Rendering hints 
+    #
+    # A rendering hint is a key/value pairs that can influence renderers,
+    # wiki formatters and processors in the way they produce their output.
+    # The keys are strings, but the values could be anything.
+    #
+    # In nested contexts, the hints are inherited from their parent context,
+    # unless overriden locally.
 
+    def set_hints(self, **keyvalues):
+        """Set rendering hints for this rendering context.
+
+        >>> ctx = Context('timeline')
+        >>> ctx.set_hints(wiki_flavor='oneliner', shorten_lines=True)
+        >>> t_ctx = ctx('ticket', 1)
+        >>> t_ctx.set_hints(wiki_flavor='html', escape_newlines=True)
+        >>> (t_ctx.get_hint('wiki_flavor'), t_ctx.get_hint('shorten_lines'), \
+             t_ctx.get_hint('escape_newlines'))
+        ('html', True, True)
+        >>> (ctx.get_hint('wiki_flavor'), ctx.get_hint('shorten_lines'), \
+             ctx.get_hint('escape_newlines'))
+        ('oneliner', True, None)
+        """
+        if self._hints is None:
+            self._hints = {}
+            hints = self._parent_hints()
+            if hints is not None:
+                self._hints.update(hints)
+        self._hints.update(keyvalues)
+
+    def get_hint(self, hint, default=None):
+        """Retrieve a rendering hint from this context or an ancestor context.
+
+        >>> ctx = Context('timeline')
+        >>> ctx.set_hints(wiki_flavor='oneliner')
+        >>> t_ctx = ctx('ticket', 1)
+        >>> t_ctx.get_hint('wiki_flavor')
+        'oneliner'
+        >>> t_ctx.get_hint('escape_newlines', True)
+        True
+        """
+        hints = self._hints
+        if hints is None:
+            hints = self._parent_hints()
+            if hints is None:
+                return default
+        return hints.get(hint, default)
+
+    def has_hint(self, hint):
+        """Test whether a rendering hint is defined in this context or in some
+        ancestor context.
+
+        >>> ctx = Context('timeline')
+        >>> ctx.set_hints(wiki_flavor='oneliner')
+        >>> t_ctx = ctx('ticket', 1)
+        >>> t_ctx.has_hint('wiki_flavor')
+        True
+        >>> t_ctx.has_hint('escape_newlines')
+        False
+        """
+        hints = self._hints
+        if hints is None:
+            hints = self._parent_hints()
+            if hints is None:
+                return False
+        return hint in hints
+
+    def _parent_hints(self):
+        p = self.parent
+        while p and p._hints is None:
+            p = p.parent
+        return p and p._hints
+
+
 # Some common MIME types and their associated keywords and/or file extensions
 
 KNOWN_MIME_TYPES = {

trac/ticket/web_ui.py

@@ -113 +113 @@
 
     timeline_newticket_formatter = Option('timeline', 'newticket_formatter',
                                           'oneliner',
-        """Which formatter flavor (e.g. 'default' or 'oneliner') should be
+        """Which formatter flavor (e.g. 'html' or 'oneliner') should be
         used when presenting the description for new tickets.
         If 'oneliner', the [timeline] abbreviated_messages option applies.
         (''since 0.11'').""")
@@ -125 +125 @@
         but keeps the old behavior for upgraded environments (i.e. 'no').
         (''since 0.11'').""")
 
+    def _must_preserve_newlines(self):
+        preserve_newlines = self.preserve_newlines
+        if preserve_newlines == 'default':
+            preserve_newlines = self.env.get_version(initial=True) >= 21 # 0.11
+        return preserve_newlines in _TRUE_VALUES
+    must_preserve_newlines = property(_must_preserve_newlines)
+
     # IContentConverter methods
 
     def get_supported_conversions(self):
@@ -339 +346 @@
             descr = message = ''
             if status == 'new':
                 message = description
-                flavor = self.timeline_newticket_formatter
             else:
                 descr = info
                 message = comment
-                flavor = 'oneliner'
-            if message:
-                if self.config['timeline'].getbool('abbreviated_messages'):
-                    message = shorten_line(message)
-                descr += format_to(self.env, flavor, context(resource=ticket),
-                                   message)
-            return descr
+            t_context = context(resource=ticket)
+            t_context.set_hints(escape_newlines=self.must_preserve_newlines)
+            if status == 'new' and \
+                    context.get_hint('wiki_flavor') == 'oneliner': 
+                flavor = self.timeline_newticket_formatter
+                t_context.set_hints(wiki_flavor=flavor,
+                                    shorten_lines=flavor == 'oneliner')
+            return descr + format_to(self.env, None, t_context, message)
 
     # Internal methods
 
@@ -578 +585 @@
         return 'ticket.html', data, None
 
     def _prepare_data(self, req, ticket, absurls=False):
-        preserve_newlines = self.preserve_newlines
-        if preserve_newlines == 'default':
-            preserve_newlines = self.env.get_version(initial=True) >= 21 # 0.11
-        preserve_newlines = preserve_newlines in _TRUE_VALUES
         return {'ticket': ticket,
                 'context': Context.from_request(req, ticket.resource,
                                                 absurls=absurls),
-                'preserve_newlines': preserve_newlines}
+                'preserve_newlines': self.must_preserve_newlines}
 
     def _toggle_cc(self, req, cc):
         """Return an (action, recipient) tuple corresponding to a change

trac/ticket/roadmap.py

@@ -42 +42 @@
 from trac.web.chrome import add_link, add_stylesheet, add_warning, \
                             INavigationContributor
 from trac.wiki.api import IWikiSyntaxProvider
-from trac.wiki.formatter import format_to_html
+from trac.wiki.formatter import format_to
 
 class ITicketGroupStatsProvider(Interface):
     def get_ticket_group_stats(ticket_ids):
@@ -532 +532 @@
         elif field == 'title':
             return tag('Milestone ', tag.em(milestone.id), ' completed')
         elif field == 'description':
-            return format_to_html(self.env, context(resource=milestone),
-                                  shorten_line(description))
+            return format_to(self.env, None, context(resource=milestone),
+                             description)
 
     # IRequestHandler methods
 

trac/versioncontrol/web_ui/changeset.py

@@ -47 +47 @@
 from trac.web.chrome import add_ctxtnav, add_link, add_script, add_stylesheet, \
                             prevnext_nav, INavigationContributor, Chrome
 from trac.wiki import IWikiSyntaxProvider, WikiParser
-from trac.wiki.formatter import format_to_html
+from trac.wiki.formatter import format_to
 
 
 class IPropertyDiffRenderer(Interface):
@@ -824 +824 @@
                 return context.href.log(rev=rev_b, stop_rev=rev_a)
             
         elif field == 'description':
-            if not self.timeline_long_messages:
-                message = shorten_line(message)
             if self.wiki_format_messages:
                 markup = ''
+                if self.timeline_long_messages: # override default flavor
+                    context = context()
+                    context.set_hints(wiki_flavor='html')
             else:
                 markup = message
                 message = None
@@ -861 +862 @@
                         files = files[:show_files] + [tag.li(u'\u2026')]
                     markup = tag(tag.ul(files, class_="changes"), markup)
             if message:
-                markup += format_to_html(self.env, context, message)
+                markup += format_to(self.env, None, context, message)
             return markup
 
         if rev_a == rev_b:

trac/wiki/web_ui.py

@@ -41 +41 @@
                             INavigationContributor, ITemplateProvider
 from trac.web import IRequestHandler
 from trac.wiki.api import IWikiPageManipulator, WikiSystem
-from trac.wiki.formatter import format_to_oneliner
+from trac.wiki.formatter import format_to
 from trac.wiki.model import WikiPage
  
 class InvalidWikiPage(TracError):
@@ -600 +600 @@
             return tag(tag.em(get_resource_name(self.env, wiki_page)),
                        wiki_page.version > 1 and ' edited' or ' created')
         elif field == 'description':
-            if self.config['timeline'].getbool('abbreviated_messages'):
-                comment = shorten_line(comment)
-            markup = format_to_oneliner(self.env, context(resource=wiki_page),
-                                        comment)
+            markup = format_to(self.env, None, context(resource=wiki_page),
+                               comment)
             if wiki_page.version > 1:
                 diff_href = context.href.wiki(
                     wiki_page.id, version=wiki_page.version, action='diff')

trac/wiki/formatter.py

@@ -1085 +1085 @@
 
 
 def format_to(env, flavor, context, wikidom, **options):
+    if flavor is None:
+        flavor = context.get_hint('wiki_flavor', 'html')
     if flavor == 'oneliner':
         return format_to_oneliner(env, context, wikidom, **options)
     else:
         return format_to_html(env, context, wikidom, **options)
 
-def format_to_html(env, context, wikidom, escape_newlines=False):
+def format_to_html(env, context, wikidom, escape_newlines=None):
     if not wikidom:
         return Markup()
+    if escape_newlines is None:
+        escape_newlines = context.get_hint('escape_newlines', False)
     return HtmlFormatter(env, context, wikidom).generate(escape_newlines)
 
-def format_to_oneliner(env, context, wikidom, shorten=False):
+def format_to_oneliner(env, context, wikidom, shorten=None):
     if not wikidom:
         return Markup()
+    if shorten is None:
+        shorten = context.get_hint('shorten_lines', False)
     return InlineHtmlFormatter(env, context, wikidom).generate(shorten)
 
 def extract_link(env, context, wikidom):

trac/timeline/web_ui.py

@@ -58 +58 @@
         Timeline. (''since 0.11'')""")
 
     abbreviated_messages = BoolOption('timeline', 'abbreviated_messages',
-                                      'true',
+                                      True,
         """Whether wiki-formatted event messages should be truncated or not.
 
         This only affects the default rendering, and can be overriden by
@@ -179 +179 @@
                     if email:
                         email_map[username] = email
             data['email_map'] = email_map
-            data['context'] = Context.from_request(req, absurls=True)
+            rss_context = Context.from_request(req, absurls=True)
+            rss_context.set_hints(wiki_flavor='html', shorten_lines=False)
+            data['context'] = rss_context
             return 'timeline.rss', data, 'application/rss+xml'
         else:
             req.session['timeline.daysback'] = daysback
+            html_context = Context.from_request(req, absurls=True)
+            html_context.set_hints(wiki_flavor='oneliner', 
+                                   shorten_lines=self.abbreviated_messages)
+            data['context'] = html_context
 
         add_stylesheet(req, 'common/css/timeline.css')
         rss_href = req.href.timeline([(f, 'on') for f in filters],
@@ -284 +290 @@
                 kind, date, author, data, provider = event
             else:
                 kind, date, author, data = event
-            render = lambda field, context: provider.render_timeline_event(
-                context, field, event)
+            render = lambda field, context: \
+                    provider.render_timeline_event(context, field, event)
         if isinstance(date, datetime):
             dateuid = to_timestamp(date)
         else: