menu/helpers.py

   1 class MenuItem(object):
   2     html_id = None
   3
   4     def __init__(self, url, title, html_id=None):
   5         self.url = url
   6         self.title = title
   7         self.html_id = html_id
   8
   9     def is_active(self, request, value):
  10         return request.get_full_path() == str(self.url)
  11
  12     def check_active(self, request, value):
  13         self.active = self.is_active(request, value)
  14
  15     def get_url(self):
  16         return self.url
  17
  18     def get_title(self):
  19         return self.title
  20
  21
  22 class ObjectMenuItem(MenuItem):
  23     """Menu item corresponding to an object.
  24
  25     If no url or title is provided, get_absolute_url and __unicode__ are used.
  26     You can also provide a reverse lookup dictionary, as in {model: field_name}.
  27     """
  28     def __init__(self, obj, url=None, rev_lookups=None, title=None, html_id=None):
  29         super(ObjectMenuItem, self).__init__(url=url, title=title, html_id=html_id)
  30         self.obj = obj
  31         self.rev_lookups = rev_lookups
  32
  33     def get_title(self):
  34         return self.title or unicode(self.obj)
  35
  36     @property
  37     def get_url(self):
  38         return self.url or self.obj.get_absolute_url()
  39
  40     def is_active(self, request, value):
  41         if value == self.obj:
  42             return True
  43         if self.rev_lookups:
  44             for model, manager in self.rev_lookups.items():
  45                 if (isinstance(value, model) and
  46                         self.obj in getattr(value, manager).all()):
  47                     return True
  48         return False
  49
  50
  51 class ModelMenuItem(MenuItem):
  52     """Menu item corresponding to a model, optionally filtered by some fields."""
  53
  54     def __init__(self, model, url, field_lookups=None, title=None, html_id=None):
  55         if title is None:
  56             title = unicode(model)
  57         super(ModelMenuItem, self).__init__(title=title, url=url, html_id=html_id)
  58         self.model = model
  59         self.field_lookups = field_lookups
  60
  61     def is_active(self, request, value):
  62         if value == self.model and not self.field_lookups:
  63             return True
  64         if isinstance(value, self.model) and self.field_lookups:
  65             lookups_ok = True
  66             for field, lookup in self.field_lookups.items():
  67                 if getattr(value, field) != lookup:
  68                     lookups_ok = False
  69             if lookups_ok:
  70                 return True
  71         return False
  72
  73     def get_title(self):
  74         return self.title or unicode(self.model)