Ticket #5516: show-enabled-plugins-in-error-page-r6658.diff

trac/htdocs/css/trac.css

@@ -489 +489 @@
 #content.error form.newticket { display: inline; }
 #content.error form.newticket textarea { display: none; }
 
-#content.error #systeminfo { margin: 1em; width: auto; }
-#content.error #systeminfo th { font-weight: bold; text-align: right; }
+#content.error #systeminfo,
+#content.error #plugins { margin: 1em; width: auto; }
+#content.error #systeminfo th,
+#content.error #plugins th { font-weight: bold; text-align: right; }
 
 #content.error #traceback { margin-left: 1em; }
 #content.error #traceback :link, #content.error #traceback :visited {
@@ -504 +506 @@
   font-style: normal;
   font-weight: bold;
 }
-#content.error #traceback span.file { color: #666; font-size: 85%; }
+#content.error #traceback span.file,
+#content.error #plugins span.file { color: #666; font-size: 85%; }
+
 #content.error #traceback ul { list-style: none; margin: .5em 0; padding: 0; }
 #content.error #traceback ol {
   border: 1px dotted #d7d7d7;

trac/admin/web_ui.py

@@ -466 +466 @@
         if changes:
             self.config.save()
 
-    def _render_view(self, req):
+    def get_plugins_data(self):
         plugins = {}
         plugins_dir = os.path.realpath(os.path.join(self.env.path, 'plugins'))
         plugins_dir = os.path.normcase(plugins_dir) # needs to match loader.py
@@ -530 +530 @@
         addons.sort()
         plugin_list += [plugins[category] for category in addons]
 
-        data = {
+        return {
             'plugins': plugin_list,
             'readonly': not os.access(plugins_dir, os.F_OK + os.W_OK)
         }
-        return 'admin_plugins.html', data
 
+    def _render_view(self, req):
+        return 'admin_plugins.html', self.get_plugins_data()
+
     def _find_distribution(self, module):
         path = get_module_path(module)
         if path == self.trac_path:

trac/templates/error.html

@@ -71 +71 @@
 <py:for each="k, v in trac.systeminfo">
 || '''$k''' || ${'`%s`' % (v and v.replace('\n', '` [[br]] `'))} ||</py:for>
 
+<py:if test="plugins_list">
+==== Enabled Plugins ====
+<py:for each="plugin in plugins_list">
+|| '''`$plugin.name`''' || $plugin.version || `$plugin.path` ||</py:for>
+</py:if>
+
 ==== Python Traceback ====
 {{{
 ${traceback}
@@ -180 +186 @@
                   <td>$value</td>
                 </tr>
               </table>
+              <py:if test="plugins_list">
+                <h2>Enabled Plugins</h2>
+                <table class="listing" id="plugins">
+                  <tr py:for="plugin in plugins_list">
+                    <th py:with="url = plugin.info.home_page;
+                                 email = plugin.info.author_email;
+                                 report_url = url or email and 'mailto:'+email">
+                        <a py:strip="not report_url" href="$report_url">$plugin.name</a>
+                    </th>
+                    <td>$plugin.version</td>
+                    <td>
+                      <span class="file"><a py:strip="not plugin.frame_idx" href="#frame$plugin.frame_idx">$plugin.path</a></span>
+                    </td>
+                  </tr>
+                </table>
+                <py:with vars="faulty_plugins = [p for p in plugins_list if 'frame_idx' in p]">
+                  <p py:if="faulty_plugins" py:choose="len(faulty_plugins)">
+                    <py:when test="1">
+                      The ${faulty_plugins[0].name} seems to be involved in this problem. 
+                    </py:when>
+                    <py:otherwise>
+                      The following plugins seem to be involved in this problem: 
+                      ${', '.join([p.name for p in faulty_plugins])}.
+                    </py:otherwise>
+                    <br />
+                    <strong>Please <em>first</em> report this issue to the plugin maintainer.</strong>
+                  </p>
+                </py:with>
+              </py:if>
+
             </py:otherwise>
           </py:choose>
         </py:when>

trac/web/main.py

@@ -39 +39 @@
 from trac.perm import PermissionCache, PermissionError, PermissionSystem
 from trac.resource import ResourceNotFound
 from trac.util import get_lines_from_file, get_last_traceback, hex_entropy
-from trac.util.compat import partial, reversed
+from trac.util.compat import partial, reversed, any
 from trac.util.datefmt import format_datetime, http_date, localtz, timezone
 from trac.util.text import shorten_line, to_unicode
 from trac.web.api import *
@@ -471 +471 @@
                                     'vars': tb.tb_frame.f_locals}]
                     tb = tb.tb_next
 
+            # TODO: move get_plugins_data at trac.admin.web_ui toplevel
+            from trac.admin.web_ui import PluginAdminPanel
+            plugins_data = PluginAdminPanel(env).get_plugins_data()
+            # only consider plugins that have at least one component enabled
+            plugins_list = [p for p in plugins_data['plugins'][1:]
+                            if any([c['enabled'] for c in p['components']])]
+            # check whether a plugin is involved in the backtrace
+            # FIXME: this currently only works well for single-file plugins 
+            #        those installed in develop mode
+            for plugin in plugins_list:
+                plugin_base = os.path.splitext(plugin['path'])[0]
+                for i, f in enumerate(frames):
+                    if f['filename'].startswith(plugin_base):
+                        plugin['frame_idx'] = i
+                        break
+
             data = {'title': 'Internal Error',
                     'type': 'internal', 'message': message,
                     'traceback': traceback, 'frames': frames,
-                    'shorten_line': shorten_line}
+                    'shorten_line': shorten_line, 
+                    'plugins_list': plugins_list}
 
             try:
                 req.send_error(exc_info, status=500, env=env, data=data)