IncludeMacro personalized targets based on config

[christer@…]

Possible additional functionality.

I added the following to my macros.py to allow for adding new targets behind the scenes for includes (other people can just use the usual wiki target nomenclature and need not know the target paths). I am using this for including HTML produced by a different system that requires a token to be used for certain requests - this allows me to hide the token from users of my Trac.

Note that I am not using the INCLUDE_URL or any other checks in this code (because it would fail intermittently on my system). This is based on [3693] of includemacro/0.11.

conf.ini example:

[include]
custom_source_format = google,yahoo
google.target = http://www.google.com/?
yahoo.target = http://www.yahoo.com/?

Patch:

macros.py

@@ -47 +47 @@
                 dest_format = self.default_formats[source_format]
             except KeyError:
                 pass
+
+######## config BOF
+        try:
+            conf_source_format_string = self.config.get('include', 'custom_source_format')
+            conf_source_format = conf_source_format_string.split(',', 10)
+        except ValueError: # only one configured
+            pass
+######## config EOF
         
         if source_format in ('http', 'https', 'ftp'):
             # Since I can't really do recursion checking, and because this 
@@ -84 +92 @@
             ctxt = Context.from_request(req, 'source', source_obj)
         # RFE: Add ticket: and comment: sources. <NPK>
         # RFE: Add attachment: source. <NPK>
+######## config BOF
+        elif source_format in conf_source_format:
+            if source_format in conf_source_format:
+                custom_target = self.config.get('include', source_format+'.target')
+                try:
+                    urlf = urllib2.urlopen(custom_target+source_obj)
+                    out = urlf.read()
+                except urllib2.URLError, e:
+                    return system_message('Error while retrieving file. Format: "param1=value1&param2=value2" (the base URL is configured under the "include" section: "custom_source_format", "[custom_source_format].target".', str(e))
+                except TracError, e:
+                    return system_message('Error while previewing. Format: "param1=value1&param2=value2" (the base URL is configured under the "include" section: "custom_source_format", "[custom_source_format].target".', str(e))
+                ctxt = Context.from_request(req)
+            else:
+                return system_message('Unsupported include source %s. If you were trying to use a custom target, format: "[custom_target]:param1=value1&param2=value2" (the base URL is configured under the "include" section: "custom_source_format", "[custom_source_format].target". Specified [custom_target]: "'%source+source_format+'". Configured values: '+conf_source_format_string)
+######## config EOF
         else:
             return system_message('Unsupported include source %s'%source)