Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Custom AdminFilters for dealing with RDF structures #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added Custom AdminFilters for dealing with RDF structures #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 154 additions & 0 deletions src/rdflib_django/admin_filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
from django.contrib.admin import RelatedFieldListFilter, AllValuesFieldListFilter, FieldListFilter
from django.contrib.admin.options import IncorrectLookupParameters
from django.core.exceptions import ValidationError
from django.utils.encoding import smart_text
from django.utils.translation import ugettext_lazy as _
from django.db import models
from rdflib import URIRef, Literal
from rdflib_django.fields import URIField, LiteralField

__author__ = '[email protected]'


def last_part_related_filter(p_name, length=15, custom_template=None):
"""returns a django.contrib.admin.filters.RelatedFieldListFilter subclass
that will override lookup_choices: will return only last word after the last /

Useful for Context.

"""
class _FieldListFilter(RelatedFieldListFilter):
def __init__(self, field, request, params, model, model_admin, field_path):
super(_FieldListFilter, self).__init__(field, request, params, model, model_admin, field_path)
self.lookup_choices = [(k, v.rstrip('/').split('/')[-1], '/'.join(v.rstrip('/').split('/')[:-1])) for k,v in self.lookup_choices]

parameter_name = p_name
title = p_name

def choices(self, cl):
from django.contrib.admin.views.main import EMPTY_CHANGELIST_VALUE
yield {
'selected': self.lookup_val is None and not self.lookup_val_isnull,
'query_string': cl.get_query_string({},
[self.lookup_kwarg, self.lookup_kwarg_isnull]),
'display': _('All'),
'hint': ''
}
for pk_val, val, hint in self.lookup_choices:
yield {
'selected': self.lookup_val == smart_text(pk_val),
'query_string': cl.get_query_string({
self.lookup_kwarg: pk_val,
}, [self.lookup_kwarg_isnull]),
'display': val,
'hint': hint
}
if (isinstance(self.field, models.related.RelatedObject)
and self.field.field.null or hasattr(self.field, 'rel')
and self.field.null):
yield {
'selected': bool(self.lookup_val_isnull),
'query_string': cl.get_query_string({
self.lookup_kwarg_isnull: 'True',
}, [self.lookup_kwarg]),
'display': EMPTY_CHANGELIST_VALUE,
'hint': ''
}

if custom_template:
_FieldListFilter.template = custom_template
return (p_name, _FieldListFilter)


class URIRefFieldFilter(AllValuesFieldListFilter):
template = "rdflib_django/grouped_filter.html"

def queryset(self, request, queryset):
try:
uri_ref = self.used_parameters.pop(self.lookup_kwarg, None)
if uri_ref:
self.used_parameters[self.lookup_kwarg] = URIRef(uri_ref)
return queryset.filter(**self.used_parameters)
except ValidationError as e:
raise IncorrectLookupParameters(e)

def choices(self, cl):
from django.contrib.admin.views.main import EMPTY_CHANGELIST_VALUE
yield {
'selected': (self.lookup_val is None
and self.lookup_val_isnull is None),
'query_string': cl.get_query_string({},
[self.lookup_kwarg, self.lookup_kwarg_isnull]),
'display': _('All'),
}
include_none = False
for val in self.lookup_choices:
if val is None:
include_none = True
continue
val = smart_text(val)
prefix = val.split('#')
yield {
'selected': self.lookup_val == val,
'query_string': cl.get_query_string({
self.lookup_kwarg: val,
}, [self.lookup_kwarg_isnull]),
'prefix': prefix[0] if len(prefix)>1 else "",
'display': prefix[1] if len(prefix)>1 else val,
}
if include_none:
yield {
'selected': bool(self.lookup_val_isnull),
'query_string': cl.get_query_string({
self.lookup_kwarg_isnull: 'True',
}, [self.lookup_kwarg]),
'display': EMPTY_CHANGELIST_VALUE,
}

FieldListFilter.register(lambda f: isinstance(f, URIField), URIRefFieldFilter, take_priority=True)

class LiteralFieldFilter(AllValuesFieldListFilter):
def queryset(self, request, queryset):
try:
uri_ref = self.used_parameters.pop(self.lookup_kwarg, None)
if uri_ref:
splitted = uri_ref.split("^^^^")
literal = Literal(splitted[0], datatype=URIRef(splitted[1])) if len(splitted)>1 and splitted[1] else Literal(splitted[0])
self.used_parameters[self.lookup_kwarg] = literal
return queryset.filter(**self.used_parameters)
except ValidationError as e:
raise IncorrectLookupParameters(e)

def choices(self, cl):
from django.contrib.admin.views.main import EMPTY_CHANGELIST_VALUE
yield {
'selected': (self.lookup_val is None
and self.lookup_val_isnull is None),
'query_string': cl.get_query_string({},
[self.lookup_kwarg, self.lookup_kwarg_isnull]),
'display': _('All'),
}
include_none = False
for val in self.lookup_choices:
if val is None:
include_none = True
continue
val = smart_text(val)
splitted = val.split("^^^^")
yield {
'selected': self.lookup_val == val,
'query_string': cl.get_query_string({
self.lookup_kwarg: val,
}, [self.lookup_kwarg_isnull]),
'display': val if len(splitted)>1 and splitted[1] else splitted[0],
}
if include_none:
yield {
'selected': bool(self.lookup_val_isnull),
'query_string': cl.get_query_string({
self.lookup_kwarg_isnull: 'True',
}, [self.lookup_kwarg]),
'display': EMPTY_CHANGELIST_VALUE,
}

FieldListFilter.register(lambda f: isinstance(f, LiteralField), LiteralFieldFilter, take_priority=True)
22 changes: 22 additions & 0 deletions src/rdflib_django/templates/rdflib_django/grouped_filter.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{% load i18n %}
{% regroup choices by prefix as choices_list %}

<select data-name="{{ field_name }}"
class="auto-width search-filter{% if spec.lookup_val or spec.used_parameters %} active{% endif %}"
style="max-width: 200px">
{% for choice_group in choices_list %}
{% if forloop.first %}
<option value="">{{ title|capfirst }}</option>
<option value="">---</option>
{% else %}
{% if choice_group.grouper %}<optgroup label="{{ choice_group.grouper }}">{% endif %}
{% for choice in choice_group.list %}

<option{% if choice.additional %} data-additional="{{ choice.additional }}"{% endif %} data-name="{{ choice.name }}"
value="{{ choice.val }}" {{ choice.selected|yesno:' selected="selected",' }}>
{% if choice.selected %}{{ title|capfirst }}: {% endif %}{{ choice.display }}</option>
{% endfor %}
{% if choice_group.grouper %}</optgroup>{% endif %}
{% endif %}
{% endfor %}
</select>