Deprecate and remove usge of TracLinks for embedding images

[markus]

Seems like Trac doesn't like jpegs. ;-)

While source:/folder/image.jpg/ works, source:/folder/image.jpg doesn't. It's the same with source:/folder/image.jpeg/ and source:/folder/image.jpeg.

[markus]

Just noticed that that Firefox displays the second links as plain text, while Internet Explorer displays (broken) image links. So, I guess that the ones that don't get escaped as hyperlinks are TracLinks for embedding images. Oops.

[markus]

Well, I'm still wondering why some images (like jpg, jpeg, png) are always broken and others (like bmp) get escaped as hyperlinks.

source:trunk/setup_wininst.bmp: source:trunk/setup_wininst.bmp​
source:trunk/htdocs/trac_banner.png: source:trunk/htdocs/trac_banner.png

[Christian Boos]

The current behavior of guessing if the source path is an image, and if so, display it, is buggy and should be phased out.

I'm reopening the ticket for that.

Plain source links should always go to the browser page for the given path.

If one wants to have an inline display of an image stored in the repository, use the Image macro and give it source:<the_path> as argument; this works fine, e.g. [[Image(source:trunk/htdocs/trac_banner.png,width=50)]] →

Also, we should interpret links like source:<the_path>?format=raw to make a link to the raw document (see #2168).

[Christian Boos]

browser.py

@@ -27 +27 @@
 from trac.wiki import wiki_to_html, wiki_to_oneliner, IWikiSyntaxProvider
 from trac.versioncontrol.web_ui.util import *
 
-IMG_RE = re.compile(r"\.(gif|jpg|jpeg|png)(\?.*)?$", re.IGNORECASE)
-
 CHUNK_SIZE = 4096
 
 DIGITS = re.compile(r'[0-9]+')
@@ -237 +235 @@
                 ('browser', self._format_link)]
 
     def _format_link(self, formatter, ns, path, label):
-        match = IMG_RE.search(path)
-        if formatter.flavor != 'oneliner' and match:
-            return '<img src="%s" alt="%s" />' % \
-                   (formatter.href.file(path, format='raw'), label)
         path, rev, line = get_path_rev_line(path)
         if line is not None:
             anchor = '#L%d' % line

[anonymous]

Thanks for clarification, Christian. I totally agree with your first comment. The way you describe these links should work is exactly what I was expecting from Trac and but ran into problems then.

[Christopher Lenz]

I agree, but I don't think we should do this for 0.9. People/sites who've been using the image linking syntax will break.

[Christian Boos]

It's already broken, for source: links.

source:trunk/htdocs/trac_banner.png

source:trunk/htdocs/trac_banner.png

[markus]

Erm, yes… That's what I was trying to say. :-p

[Christopher Lenz]

The thing is that people are probably using the syntax (using the ?format=raw parameter where necessary).

Simply removing this support now will make those embedded images simply links. Maybe that's not so bad after all?

[anonymous]

Let's say there are people using the source: syntax (with or without ?format=raw) for embedding images. With the current version of Trac (0.9) this syntax will never lead to an embedded image inside a wiki page or ticket comment, because it simply doesn't work (it's broken for both with and without ?format=raw)

So, for existing tickets/wiki pages with this syntax in them this means that the browsers show broken image links. IMHO that's not what these people wanted to embed and so having a simple (but working) link to the TracBrowser displaying this image should be better than that.

[Matthew Good]

Well, the reason that the "source:" image links are broken is because they point to the "/file" path, which was phased out and should now be "/browser". That should be fixed for now to keep the old behavior.

I agree that the automatic conversion of "source:" image links should be deprecated, although I think that we need to come up with some reasonable policy on how to handle deprecating features and when they will be removed.

P.S. the reason that ".bmp" links are not converted to <img> tags is because you really shouldn't be using ".bmp" files in a webpage.

[Christian Boos]

Something like that?

browser.py

@@ -240 +240 @@
         match = IMG_RE.search(path)
         if formatter.flavor != 'oneliner' and match:
             return '<img src="%s" alt="%s" />' % \
-                   (formatter.href.file(path, format='raw'), label)
+                   (formatter.href.browser(path, format='raw'),
+                    'WARNING: deprecated form, use [[Image(%s)]] instead' \
+                    % path)
         path, rev, line = get_path_rev_line(path)
         if line is not None:
             anchor = '#L%d' % line

[Christian Boos]

Deprecation warning added for milestone:0.10 in r3329, now scheduling removal for milestone:0.11.

[Christian Boos]

Actually, the removal was done in r3454. Mentioning this in the source:trunk/RELEASE for milestone:0.10 should be enough.

[markus]

Yippie, thanks! ;-)