Method to add script tag with in-file javascript code

[martin@…]

While it is possible to add script tags for external javascript file using the add_script function in trac.web.chrome, it isn't possible to add script tags with in-file javascript code content.

While using only external javascript files is a good web design approach, some plug-ins might need to add small dynamic generated javascript code into the generated XHTML, e.g. to set variables which value depends on trac.ini settings or external sources. I had this problem recently with the GoogleMapMacro.

Because script tags shoudn't refer to an external file and have code content, I would like to suggest a new python method and template tag:

trac/templates/layout.html

@@ -22 +22 @@
     </py:if>
     <script py:for="script in chrome.scripts"
             type="${script.type}" src="${script.href}"></script>
+    <script py:for="script in chrome.scriptscontent" type="${script.type}">
+        /*<![CDATA[*/
+        ${script.content}
+        /*]]>*/
+    </script>
     ${Markup('&lt;!--[if lt IE 7]&gt;')}
     <script type="text/javascript" src="${chrome.htdocs_location}js/ie_pre7_hacks.js"></script>
     ${Markup('&lt;![endif]--&gt;')}

Trac-0.11.1-py2.5.egg

@@ -106 +106 @@
     req.chrome.setdefault('scripts', []).append(script)
     scriptset.add(filename)
 
+def add_script_content(req, content, mimetype='text/javascript'):
+    """Add in-file javascript code to the template.
+
+    """
+    import hashlib
+    m = hashlib.md5()
+    m.update(content)
+    digest = m.hexdigest()
+
+    scriptcontentset = req.chrome.setdefault('scriptcontentset', set())
+    if digest in scriptcontentset:
+        return False # Already added that code
+
+    scriptcontent = {'content': content, 'type': mimetype}
+
+    req.chrome.setdefault('scriptscontent', []).append(scriptcontent)
+    scriptcontentset.add(digest)
+
 def add_javascript(req, filename):
     """Deprecated: use `add_script()` instead."""
     add_script(req, filename, mimetype='text/javascript')