Template panel context cleanup.

All panels get a copy of the template context when created and use an updated
copy when rendering so they can have full access to context vars and avoid
making changes to the shared context.

Signed-off-by: Rob Hudson <[email protected]>

Author: acdha

debug_toolbar/panels/__init__.py

@@ -7,9 +7,13 @@ class DebugPanel(object):
     # name = Base
     has_content = False # If content returns something, set to true in subclass
 
+    # We'll maintain a local context instance so we can expose our template
+    # context variables to panels which need them:
+    context = {}
+
     # Panel methods
-    def __init__(self):
-        pass
+    def __init__(self, context={}):
+        self.context.update(context)
 
     def dom_id(self):
         return 'djDebug%sPanel' % (self.name.replace(' ', ''))

debug_toolbar/panels/cache.py

@@ -76,7 +76,8 @@ class CacheDebugPanel(DebugPanel):
     name = 'Cache'
     has_content = True
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super(self.__class__, self).__init__(*args, **kwargs)
         # This is hackish but to prevent threading issues is somewhat needed
         if isinstance(cache.cache, CacheStatTracker):
             cache.cache.reset()
@@ -95,9 +96,10 @@ def url(http://github.com/self):
         return ''
 
     def content(self):
-        context = dict(
-            cache_calls = len(self.cache.calls),
-            cache_time = self.cache.total_time,
-            cache = self.cache,
-        )
+        context = self.context.copy()
+        context.update({
+            'cache_calls': len(self.cache.calls),
+            'cache_time': self.cache.total_time,
+            'cache': self.cache,
+        })
         return render_to_string('debug_toolbar/panels/cache.html', context)

debug_toolbar/panels/headers.py

@@ -47,7 +47,8 @@ def process_request(self, request):
         )
 
     def content(self):
-        context = {
+        context = self.context.copy()
+        context.update({
             'headers': self.headers
-        }
+        })
         return render_to_string('debug_toolbar/panels/headers.html', context)

debug_toolbar/panels/logger.py

@@ -75,4 +75,9 @@ def content(self):
                 'file': record.pathname,
                 'line': record.lineno,
             })
-        return render_to_string('debug_toolbar/panels/logger.html', {'records': records})
+
+        context = self.context.copy()
+        context.update({'records': records})
+
+        return render_to_string('debug_toolbar/panels/logger.html', context)
+

debug_toolbar/panels/request_vars.py

@@ -27,15 +27,18 @@ def process_view(self, request, view_func, view_args, view_kwargs):
         self.view_kwargs = view_kwargs
 
     def content(self):
-        context = {
+        context = self.context.copy()
+        context.update({
             'get': [(k, self.request.GET.getlist(k)) for k in self.request.GET],
             'post': [(k, self.request.POST.getlist(k)) for k in self.request.POST],
             'cookies': [(k, self.request.COOKIES.get(k)) for k in self.request.COOKIES],
             'view_func': '%s.%s' % (self.view_func.__module__, self.view_func.__name__),
             'view_args': self.view_args,
             'view_kwargs': self.view_kwargs
-        }
+        })
         if hasattr(self.request, 'session'):
-            context['session'] = [(k, self.request.session.get(k)) for k in self.request.session.iterkeys()]
+            context.update({
+                'session': [(k, self.request.session.get(k)) for k in self.request.session.iterkeys()]
+            })
 
         return render_to_string('debug_toolbar/panels/request_vars.html', context)

debug_toolbar/panels/settings_vars.py

@@ -22,7 +22,8 @@ def url(http://github.com/self):
         return ''
 
     def content(self):
-        context = {
+        context = self.context.copy()
+        context.update({
             'settings': get_safe_settings(),
-        }
+        })
         return render_to_string('debug_toolbar/panels/settings_vars.html', context)

debug_toolbar/panels/signals.py

@@ -80,4 +80,8 @@ def content(self):
                     text = "function %s" % receiver.__name__
                 receivers.append(text)
             signals.append((name, signal, receivers))
-        return render_to_string('debug_toolbar/panels/signals.html', {'signals': signals})
+
+        context = self.context.copy()
+        context.update({'signals': signals})
+
+        return render_to_string('debug_toolbar/panels/signals.html', context)

debug_toolbar/panels/sql.py

@@ -137,7 +137,8 @@ class SQLDebugPanel(DebugPanel):
     name = 'SQL'
     has_content = True
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super(self.__class__, self).__init__(*args, **kwargs)
         self._offset = len(connection.queries)
         self._sql_time = 0
         self._queries = []
@@ -173,11 +174,13 @@ def content(self):
             query['start_offset'] = width_ratio_tally
             width_ratio_tally += query['width_ratio']
 
-        context = {
+        context = self.context.copy()
+        context.update({
             'queries': self._queries,
             'sql_time': self._sql_time,
             'is_mysql': settings.DATABASE_ENGINE == 'mysql',
-        }
+        })
+
         return render_to_string('debug_toolbar/panels/sql.html', context)
 
 def ms_from_timedelta(td):

debug_toolbar/panels/template.py

@@ -36,7 +36,8 @@ class TemplateDebugPanel(DebugPanel):
     name = 'Template'
     has_content = True
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super(self.__class__, self).__init__(*args, **kwargs)
         self.templates = []
         template_rendered.connect(self._store_template_info)
 
@@ -103,9 +104,12 @@ def content(self):
                         pass
                 info['context'] = '\n'.join(context_list)
             template_context.append(info)
-        context = {
+
+        context = self.context.copy()
+        context.update({
             'templates': template_context,
             'template_dirs': [normpath(x) for x in settings.TEMPLATE_DIRS],
             'context_processors': context_processors,
-        }
+        })
+
         return render_to_string('debug_toolbar/panels/templates.html', context)

debug_toolbar/panels/timer.py

@@ -84,7 +84,10 @@ def content(self):
 #            ('Page faults', '%d no i/o, %d requiring i/o' % (minflt, majflt)),
 #            ('Disk operations', '%d in, %d out, %d swapout' % (blkin, blkout, swap)),
         )
-        context = {
+
+        context = self.context.copy()
+        context.update({
             'rows': rows,
-        }
+        })
+
         return render_to_string('debug_toolbar/panels/timer.html', context)

debug_toolbar/panels/version.py

@@ -50,7 +50,10 @@ def content(self):
                 version = '.'.join(str(o) for o in version)
             versions[name] = version
 
-        return render_to_string('debug_toolbar/panels/versions.html', {
+        context = self.context.copy()
+        context.update({
             'versions': versions,
             'paths': sys.path,
         })
+
+        return render_to_string('debug_toolbar/panels/versions.html', context)

debug_toolbar/toolbar/loader.py

@@ -11,6 +11,9 @@ def __init__(self, request):
         self.config = {
             'INTERCEPT_REDIRECTS': True,
         }
+        self.template_context = {
+            'BASE_URL': self.request.META.get('SCRIPT_NAME', ''),
+        }
         # Override this tuple by copying to settings.py as `DEBUG_TOOLBAR_PANELS`
         self.default_panels = (
             'debug_toolbar.panels.version.VersionDebugPanel',
@@ -56,9 +59,8 @@ def load_panels(self):
                 raise exceptions.ImproperlyConfigured, 'Toolbar Panel module "%s" does not define a "%s" class' % (panel_module, panel_classname)
 
             try:
-                panel_instance = panel_class()
+                panel_instance = panel_class(context=self.template_context)
             except:
-                print panel_class
                 raise # Bubble up problem loading panel
 
             self.panels.append(panel_instance)
@@ -67,7 +69,7 @@ def render_toolbar(self):
         """
         Renders the overall Toolbar with panels inside.
         """
-        return render_to_string('debug_toolbar/base.html', {
-            'panels': self.panels,
-            'BASE_URL': self.request.META.get('SCRIPT_NAME', ''),
-        })
+        context = self.template_context.copy()
+        context.update({ 'panels': self.panels, })
+
+        return render_to_string('debug_toolbar/base.html', context)