Changeset d7557b8

Timestamp:

Feb 9, 2013, 1:53:21 AM (14 years ago)

Author:

Alex Dehnert <adehnert@…>

Branches:

master, stable, stage

Children:

62f73df

Parents:

ea8e8b6

git-author:

Alex Dehnert <adehnert@…> (02/09/13 01:53:21)

git-committer:

Alex Dehnert <adehnert@…> (02/09/13 01:53:21)

Message:

Proof-of-concept reporting filters (ASA-#193)

Add proof-of-concept support for extensible filtering of the reporting page,
beyond just the fields on the Group object. At the moment, this is just a few
space-related filters, but in the future this might include groups missing
membership confirmations, groups whose presidents aren't students, groups who
have filled out the FYSM, etc..

Location:

asadb

Files:

• groups/models.py (modified) (2 diffs)
• groups/views.py (modified) (4 diffs)
• space/models.py (modified) (1 diff)

asadb/groups/models.py

@@ +1 @@
+# -*- coding: utf8 -*-
+
 from django.conf import settings
 from django.db import models
+from django.core.exceptions import ValidationError
 from django.core.validators import RegexValidator
 from django.contrib.auth.models import User
@@ -570 +573 @@
     class Meta:
         verbose_name = "Athena (Moira) account"
+
+
+
+class GroupFilter(object):
+    def __init__(self, **kwargs):
+        self.qs_thunk = kwargs['qs_thunk']
+        self.name = kwargs['name']
+        self.description = kwargs['desc']
+
+    def queryset(self, ):
+        return self.qs_thunk()
+
+
+class GroupFilterRegistry(object):
+    def __init__(self, ):
+        self.filters = {}
+        self.filter_groups = {}
+
+    def register_group(self, name, slug, ):
+        if slug in self.filter_groups:
+            raise ValueError, "Duplicate filter group %s" % (slug, )
+        if slug in self.filters:
+            raise ValueError, "Group %s matches filter" % (slug, )
+        self.filter_groups[slug] = dict(
+            name=name,
+            filters=[],
+        )
+        self.filters[slug] = GroupFilter(
+            qs_thunk=None,
+            name=name,
+            desc=None,
+        )
+
+    def register(self, **kwargs):
+        slug = kwargs.pop('slug')
+        group = kwargs.pop('group')
+        if group not in self.filter_groups:
+            raise KeyError, "Unknown filter group %s" % (group, )
+        fltr = GroupFilter(**kwargs)
+        if slug in self.filters:
+            raise ValueError, "Duplicate filter %s" % (slug, )
+        self.filters[slug] = fltr
+        self.filter_groups[group]['filters'].append(slug)
+
+    def get(self, slug):
+        return self.filters[slug]
+
+    def get_choices(self, ):
+        choices = []
+        for group_slug, grp in self.filter_groups.items():
+            choices.append((group_slug, "[%s]" % (grp['name'], )))
+            for filter_slug in grp['filters']:
+                choices.append((filter_slug, self.filters[filter_slug].name))
+            choices.append(("", ""))
+        return choices[:-1]
+
+    def validate_filter_slug(self, value, ):
+        for slug in value:
+            if slug == "":
+                raise ValidationError("Please select only filters")
+            if slug not in self.filters:
+                raise ValidationError("%s is an unknown filter" % (slug, ))
+            if slug in self.filter_groups:
+                raise ValidationError(u"%s is a filter group — please select only filters" % (self.filter_groups[slug]['name'], ))
+
+
+filter_registry = GroupFilterRegistry()
+filter_registry.register_group(name="People", slug='people', )
+filter_registry.register_group(name="Space", slug='space', )
+filter_registry.register_group(name="FYSM", slug='fysm', )

asadb/groups/views.py

@@ -1079 +1079 @@
 
 class ReportingForm(form_utils.forms.BetterForm):
+    special_filters = forms.fields.MultipleChoiceField(
+        choices=[],
+        widget=forms.SelectMultiple(attrs={'size': 10}),
+        validators=[groups.models.filter_registry.validate_filter_slug],
+        required=False,
+    )
+
     basic_fields_choices = groups.models.Group.reporting_fields()
     basic_fields_labels = dict(basic_fields_choices) # name -> verbose_name
@@ -1117 +1124 @@
             ('filter', {
                 'legend': 'Filter Groups',
-                'fields': ['name', 'abbreviation', 'activity_category', 'group_class', 'group_status', 'group_funding', ],
+                'fields': [
+                    'name', 'abbreviation',
+                    'activity_category', 'group_class', 'group_status', 'group_funding',
+                    'special_filters',
+                ],
             }),
             ('fields', {
@@ -1128 +1139 @@
             }),
         ]
+
+    def __init__(self, *args, **kwargs):
+        super(ReportingForm, self).__init__(*args, **kwargs)
+
+        registry = groups.models.filter_registry
+        self.fields['special_filters'].choices = registry.get_choices()
 
 class GroupReportingFilter(GroupFilter):
@@ -1190 +1207 @@
         # Set up query
         qs = groups_filterset.qs
+        for fltr_slug in form.cleaned_data['special_filters']:
+            fltr = groups.models.filter_registry.get(fltr_slug)
+            qs = qs.filter(pk__in=fltr.queryset())
+
         # Prefetch foreign keys
         prefetch_fields = groups.models.Group.reporting_prefetch()

asadb/space/models.py

@@ -126 +126 @@
 
 
+groups.models.filter_registry.register(
+    group='space',
+    slug='space:owners',
+    name='Space owners',
+    desc='Groups with space',
+    qs_thunk=lambda: SpaceAssignment.current.values('group'),
+)
+
+def building_filter(building):
+    building_assignments = SpaceAssignment.current.filter(
+        space__number__startswith="%s-" % (building, ),
+    )
+    owners = groups.models.Group.objects.filter(
+        pk__in=building_assignments.values('group'),
+    )
+    return owners
+
+groups.models.filter_registry.register(
+    group='space',
+    slug='space:w20',
+    name='W20 owners',
+    desc='Owners of W20 space',
+    qs_thunk=lambda: building_filter('W20'),
+)
+groups.models.filter_registry.register(
+    group='space',
+    slug='space:walker',
+    name='Walker owners',
+    desc='Owners of Walker space',
+    qs_thunk=lambda: building_filter('50'),
+)
+
 class CurrentACLEntryManager(models.Manager):
     def get_query_set(self, ):