Image macro should support InterMapTxt

[anonymous]

The image macro does not seem to support InterMapTxt prefixes. This would allow to easily extend the image macro with new capabilities e.g. for frequently linked badges, build status icons etc.)

[anonymous]

As a workaround a custom plugin can be written:

from trac.core import *
from trac.wiki.macros import WikiMacroBase
from trac.wiki.formatter import format_to_oneliner
from trac.wiki.interwiki import InterWikiMap

class SpecialImageMacro(WikiMacroBase):
    """Expands to `[[Image(SpecialImage:$1,link=SpecialImageLink:$1)]]`.
   
    Two InterMapTxt prefixes must be defined:
    {{{
    SpecialImage      http://example.com/$1.png
    SpecialImageLink  http://example.com/$1.html
    }}}
    """
    def expand_macro(self, formatter, name, content, args):
        intermap = InterWikiMap(self.env)
        src = intermap.url("SpecialImage", content)[0]
        link = intermap.url("SpecialImageLink", content)[0]
        wiki = "[[Image(%s,link=%s,title=Special Image %s)]]" % (src, link, content)
        return format_to_oneliner(self.env, formatter.context, wiki)

[Ryan J Ollos]

PatchWelcome.

[anonymous]

For example with this prefix:

shields https://img.shields.io/

Wiki markup like this:

[[Image(shields:travis/edgewall/trac.svg)]]
[[Image(shields:pypi/dm/trac.svg)]]
[[Image(shields:pypi/v/trac.svg)]]

should become: etc.

[Jun Omae]

See PatchWelcome.

[anonymous]

trac/wiki/macros.py

@@ -38 +38 @@
 from trac.wiki.formatter import (
     format_to_html, format_to_oneliner, extract_link, OutlineFormatter
 )
+from trac.wiki.interwiki import InterWikiMap
 
 
 # TODO: should be moved in .api
@@ -632 +633 @@
                 attachment = Resource(realm, id).child('attachment', filename)
         elif len(parts) == 2:
             realm, filename = parts
+            interwikimap = InterWikiMap(self.env)
             if realm in browser_links:  # source:path
                 # TODO: use context here as well
                 rev = None
@@ -641 +643 @@
                 raw_url = formatter.href.browser(filename, rev=rev,
                                                  format='raw')
                 desc = filespec
+            elif realm in interwikimap:
+                url, desc = interwikimap.url(realm, filename)
+                raw_url = url
             else:  # #ticket:attachment or WikiPage:attachment
                 # FIXME: do something generic about shorthand forms...
                 realm = None

[Ryan J Ollos]

Tests and documentation update were also needed. Proposed changes in log:rjollos.git:t12025.

[Ryan J Ollos]

Committed to trunk in [13988].

[Jun Omae]

I think we should respect [wiki] safe_schemes option when using InterMapTxt.

[Ryan J Ollos]

Replying to jomae:

I think we should respect [wiki] safe_schemes option when using InterMapTxt.

That sounds good, but is that a change needed in ImageMacro or InterWikiMap? If the change is in InterWikiMap, we should create a new ticket.

[Jun Omae]

Replying to rjollos:

That sounds good, but is that a change needed in ImageMacro or InterWikiMap? If the change is in InterWikiMap, we should create a new ticket.

I've created #12053.

I noticed InterWiki allows multiple parameters. However, image macro cannot accept interwiki with multiple parameters for image. Also, the link parameter allows interwiki link with multiple parameters like this.

[[Image(/chrome/common/trac_logo_mini.png, link=gmessage:trac-users:183g75yH65w/YgJ-q8AREpwJ)]]

[Jun Omae]

Proposed changes in [b12d7d12c/jomae.git] to support interwiki link with multiple parameters in image macro.

[Ryan J Ollos]

The changes look good to me.

[Jun Omae]

Thanks for the reviewing. Committed in [14047].