aboutsummaryrefslogtreecommitdiffstats
path: root/debug_toolbar/toolbar.py
blob: 32dc1b75478b1da36e6628e93e3076a6894f6789 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
"""
The main DebugToolbar class that loads and renders the Toolbar.
"""

from __future__ import unicode_literals

from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
from django.template.loader import render_to_string
from django.utils.datastructures import SortedDict
from django.utils.importlib import import_module

from debug_toolbar.utils import settings as dt_settings


class DebugToolbar(object):

    def __init__(self, request):
        self.request = request
        self._panels = SortedDict()
        base_url = self.request.META.get('SCRIPT_NAME', '')
        self.config = {}
        self.config.update(dt_settings.CONFIG)
        self.template_context = {
            'BASE_URL': base_url,  # for backwards compatibility
            'STATIC_URL': settings.STATIC_URL,
            'TOOLBAR_ROOT_TAG_ATTRS': self.config['ROOT_TAG_ATTRS'],
        }

        self.load_panels()
        self.stats = {}

    def _get_panels(self):
        return list(self._panels.values())
    panels = property(_get_panels)

    def get_panel(self, cls):
        return self._panels[cls]

    def load_panels(self):
        """
        Populate debug panels
        """
        for panel_class in self.get_panel_classes():
            panel_instance = panel_class(self, context=self.template_context)
            self._panels[panel_class] = panel_instance

    def render_toolbar(self):
        """
        Renders the overall Toolbar with panels inside.
        """
        context = self.template_context.copy()
        context.update({
            'panels': self.panels,
            'storage_id': self.store(),
        })
        return render_to_string('debug_toolbar/base.html', context)

    # Handle storing toolbars in memory and fetching them later on

    _counter = 0
    _storage = SortedDict()

    def store(self):
        cls = type(self)
        cls._counter += 1
        cls._storage[cls._counter] = self
        for _ in range(len(cls._storage) - dt_settings.CONFIG['RESULTS_CACHE_SIZE']):
            # When we drop support for Python 2.6 and switch to
            # collections.OrderedDict, use popitem(last=False).
            del cls._storage[cls._storage.keyOrder[0]]
        return cls._counter

    @classmethod
    def fetch(cls, storage_id):
        return cls._storage.get(storage_id)

    # Manually implement class-level caching of the list of panels because
    # it's more obvious than going through an abstraction.

    _panel_classes = None

    @classmethod
    def get_panel_classes(cls):
        if cls._panel_classes is None:
            # Load panels in a temporary variable for thread safety.
            panel_classes = []
            for panel_path in dt_settings.PANELS:
                # This logic could be replaced with import_by_path in Django 1.6.
                try:
                    panel_module, panel_classname = panel_path.rsplit('.', 1)
                except ValueError:
                    raise ImproperlyConfigured(
                        "%s isn't a debug panel module" % panel_path)
                try:
                    mod = import_module(panel_module)
                except ImportError as e:
                    raise ImproperlyConfigured(
                        'Error importing debug panel %s: "%s"' %
                        (panel_module, e))
                try:
                    panel_class = getattr(mod, panel_classname)
                except AttributeError:
                    raise ImproperlyConfigured(
                        'Toolbar Panel module "%s" does not define a "%s" class' %
                        (panel_module, panel_classname))
                panel_classes.append(panel_class)
            cls._panel_classes = panel_classes
        return cls._panel_classes