e988b6c9d54228345574fd923c93d727d124baee
[wolnelektury.git] / apps / newtagging / models.py
1 """
2 Models and managers for generic tagging.
3 """
4 # Python 2.3 compatibility
5 if not hasattr(__builtins__, 'set'):
6     from sets import Set as set
7
8 from django.contrib.contenttypes import generic
9 from django.contrib.contenttypes.models import ContentType
10 from django.db import connection, models
11 from django.utils.translation import ugettext_lazy as _
12 from django.db.models.base import ModelBase
13
14 qn = connection.ops.quote_name
15
16 try:
17     from django.db.models.query import parse_lookup
18 except ImportError:
19     parse_lookup = None
20
21
22 def get_queryset_and_model(queryset_or_model):
23     """
24     Given a ``QuerySet`` or a ``Model``, returns a two-tuple of
25     (queryset, model).
26
27     If a ``Model`` is given, the ``QuerySet`` returned will be created
28     using its default manager.
29     """
30     try:
31         return queryset_or_model, queryset_or_model.model
32     except AttributeError:
33         return queryset_or_model._default_manager.all(), queryset_or_model
34
35
36 ############
37 # Managers #
38 ############
39 class TagManager(models.Manager):
40     def __init__(self, intermediary_table_model):
41         super(TagManager, self).__init__()
42         self.intermediary_table_model = intermediary_table_model
43     
44     def update_tags(self, obj, tags):
45         """
46         Update tags associated with an object.
47         """
48         content_type = ContentType.objects.get_for_model(obj)
49         current_tags = list(self.filter(items__content_type__pk=content_type.pk,
50                                         items__object_id=obj.pk))
51         updated_tags = self.model.get_tag_list(tags)
52     
53         # Remove tags which no longer apply
54         tags_for_removal = [tag for tag in current_tags \
55                             if tag not in updated_tags]
56         if len(tags_for_removal):
57             self.intermediary_table_model._default_manager.filter(content_type__pk=content_type.pk,
58                                                object_id=obj.pk,
59                                                tag__in=tags_for_removal).delete()
60         # Add new tags
61         for tag in updated_tags:
62             if tag not in current_tags:
63                 self.intermediary_table_model._default_manager.create(tag=tag, content_object=obj)
64     
65     def get_for_object(self, obj):
66         """
67         Create a queryset matching all tags associated with the given
68         object.
69         """
70         ctype = ContentType.objects.get_for_model(obj)
71         return self.filter(items__content_type__pk=ctype.pk,
72                            items__object_id=obj.pk)
73     
74     def _get_usage(self, model, counts=False, min_count=None, extra_joins=None, extra_criteria=None, params=None, extra=None):
75         """
76         Perform the custom SQL query for ``usage_for_model`` and
77         ``usage_for_queryset``.
78         """
79         if min_count is not None: counts = True
80
81         model_table = qn(model._meta.db_table)
82         model_pk = '%s.%s' % (model_table, qn(model._meta.pk.column))
83         tag_columns = self._get_tag_columns()
84         
85         if extra is None: extra = {}
86         extra_where = ''
87         if 'where' in extra:
88             extra_where = 'AND ' + ' AND '.join(extra['where'])
89         
90         query = """
91         SELECT DISTINCT %(tag_columns)s%(count_sql)s
92         FROM
93             %(tag)s
94             INNER JOIN %(tagged_item)s
95                 ON %(tag)s.id = %(tagged_item)s.tag_id
96             INNER JOIN %(model)s
97                 ON %(tagged_item)s.object_id = %(model_pk)s
98             %%s
99         WHERE %(tagged_item)s.content_type_id = %(content_type_id)s
100             %%s
101             %(extra_where)s
102         GROUP BY %(tag)s.id, %(tag)s.name
103         %%s
104         ORDER BY %(tag)s.%(ordering)s ASC""" % {
105             'tag': qn(self.model._meta.db_table),
106             'ordering': ', '.join(qn(field) for field in self.model._meta.ordering),
107             'tag_columns': tag_columns,
108             'count_sql': counts and (', COUNT(%s)' % model_pk) or '',
109             'tagged_item': qn(self.intermediary_table_model._meta.db_table),
110             'model': model_table,
111             'model_pk': model_pk,
112             'extra_where': extra_where,
113             'content_type_id': ContentType.objects.get_for_model(model).pk,
114         }
115
116         min_count_sql = ''
117         if min_count is not None:
118             min_count_sql = 'HAVING COUNT(%s) >= %%s' % model_pk
119             params.append(min_count)
120
121         cursor = connection.cursor()
122         cursor.execute(query % (extra_joins, extra_criteria, min_count_sql), params)
123         tags = []
124         for row in cursor.fetchall():
125             t = self.model(*row[:len(self.model._meta.fields)])
126             if counts:
127                 t.count = row[len(self.model._meta.fields)]
128             tags.append(t)
129         return tags
130
131     def usage_for_model(self, model, counts=False, min_count=None, filters=None, extra=None):
132         """
133         Obtain a list of tags associated with instances of the given
134         Model class.
135
136         If ``counts`` is True, a ``count`` attribute will be added to
137         each tag, indicating how many times it has been used against
138         the Model class in question.
139
140         If ``min_count`` is given, only tags which have a ``count``
141         greater than or equal to ``min_count`` will be returned.
142         Passing a value for ``min_count`` implies ``counts=True``.
143
144         To limit the tags (and counts, if specified) returned to those
145         used by a subset of the Model's instances, pass a dictionary
146         of field lookups to be applied to the given Model as the
147         ``filters`` argument.
148         """
149         if extra is None: extra = {}
150         if filters is None: filters = {}
151
152         if not parse_lookup:
153             # post-queryset-refactor (hand off to usage_for_queryset)
154             queryset = model._default_manager.filter()
155             for f in filters.items():
156                 queryset.query.add_filter(f)
157             usage = self.usage_for_queryset(queryset, counts, min_count, extra)
158         else:
159             # pre-queryset-refactor
160             extra_joins = ''
161             extra_criteria = ''
162             params = []
163             if len(filters) > 0:
164                 joins, where, params = parse_lookup(filters.items(), model._meta)
165                 extra_joins = ' '.join(['%s %s AS %s ON %s' % (join_type, table, alias, condition)
166                                         for (alias, (table, join_type, condition)) in joins.items()])
167                 extra_criteria = 'AND %s' % (' AND '.join(where))
168             usage = self._get_usage(model, counts, min_count, extra_joins, extra_criteria, params, extra)
169
170         return usage
171
172     def usage_for_queryset(self, queryset, counts=False, min_count=None, extra=None):
173         """
174         Obtain a list of tags associated with instances of a model
175         contained in the given queryset.
176
177         If ``counts`` is True, a ``count`` attribute will be added to
178         each tag, indicating how many times it has been used against
179         the Model class in question.
180
181         If ``min_count`` is given, only tags which have a ``count``
182         greater than or equal to ``min_count`` will be returned.
183         Passing a value for ``min_count`` implies ``counts=True``.
184         """
185         if parse_lookup:
186             raise AttributeError("'TagManager.usage_for_queryset' is not compatible with pre-queryset-refactor versions of Django.")
187
188         extra_joins = ' '.join(queryset.query.get_from_clause()[0][1:])
189         where, params = queryset.query.where.as_sql()
190         if where:
191             extra_criteria = 'AND %s' % where
192         else:
193             extra_criteria = ''
194         return self._get_usage(queryset.model, counts, min_count, extra_joins, extra_criteria, params, extra)
195
196     def related_for_model(self, tags, model, counts=False, min_count=None, extra=None):
197         """
198         Obtain a list of tags related to a given list of tags - that
199         is, other tags used by items which have all the given tags.
200
201         If ``counts`` is True, a ``count`` attribute will be added to
202         each tag, indicating the number of items which have it in
203         addition to the given list of tags.
204
205         If ``min_count`` is given, only tags which have a ``count``
206         greater than or equal to ``min_count`` will be returned.
207         Passing a value for ``min_count`` implies ``counts=True``.
208         """
209         if min_count is not None: counts = True
210         tags = self.model.get_tag_list(tags)
211         tag_count = len(tags)
212         tagged_item_table = qn(self.intermediary_table_model._meta.db_table)
213         tag_columns = self._get_tag_columns()
214         
215         if extra is None: extra = {}
216         extra_where = ''
217         if 'where' in extra:
218             extra_where = 'AND ' + ' AND '.join(extra['where'])
219         
220         # Temporary table in this query is a hack to prevent MySQL from executing
221         # inner query as dependant query (which could result in severe performance loss)
222         query = """
223         SELECT %(tag_columns)s%(count_sql)s
224         FROM %(tagged_item)s INNER JOIN %(tag)s ON %(tagged_item)s.tag_id = %(tag)s.id
225         WHERE %(tagged_item)s.content_type_id = %(content_type_id)s
226         AND %(tagged_item)s.object_id IN
227         (
228             SELECT temporary.object_id 
229             FROM (
230                 SELECT %(tagged_item)s.object_id
231                 FROM %(tagged_item)s, %(tag)s
232                 WHERE %(tagged_item)s.content_type_id = %(content_type_id)s
233                   AND %(tag)s.id = %(tagged_item)s.tag_id
234                   AND %(tag)s.id IN (%(tag_id_placeholders)s)
235                 GROUP BY %(tagged_item)s.object_id
236                 HAVING COUNT(%(tagged_item)s.object_id) = %(tag_count)s
237             ) AS temporary
238         )
239         %(extra_where)s
240         GROUP BY %(tag_columns)s
241         %(min_count_sql)s
242         ORDER BY %(tag)s.%(ordering)s ASC""" % {
243             'tag': qn(self.model._meta.db_table),
244             'ordering': ', '.join(qn(field) for field in self.model._meta.ordering),
245             'tag_columns': tag_columns,
246             'count_sql': counts and ', COUNT(%s.object_id)' % tagged_item_table or '',
247             'tagged_item': tagged_item_table,
248             'content_type_id': ContentType.objects.get_for_model(model).pk,
249             'tag_id_placeholders': ','.join(['%s'] * tag_count),
250             'extra_where': extra_where,
251             'tag_count': tag_count,
252             'min_count_sql': min_count is not None and ('HAVING COUNT(%s.object_id) >= %%s' % tagged_item_table) or '',
253         }
254
255         params = [tag.pk for tag in tags] * 2
256         if min_count is not None:
257             params.append(min_count)
258
259         cursor = connection.cursor()
260         cursor.execute(query, params)
261         related = []
262         for row in cursor.fetchall():
263             tag = self.model(*row[:len(self.model._meta.fields)])
264             if counts is True:
265                 tag.count = row[len(self.model._meta.fields)]
266             related.append(tag)
267         return related
268
269     def _get_tag_columns(self):
270         tag_table = qn(self.model._meta.db_table)
271         return ', '.join('%s.%s' % (tag_table, qn(field.column)) for field in self.model._meta.fields)
272
273
274 class TaggedItemManager(models.Manager):
275     """
276     FIXME There's currently no way to get the ``GROUP BY`` and ``HAVING``
277           SQL clauses required by many of this manager's methods into
278           Django's ORM.
279
280           For now, we manually execute a query to retrieve the PKs of
281           objects we're interested in, then use the ORM's ``__in``
282           lookup to return a ``QuerySet``.
283
284           Once the queryset-refactor branch lands in trunk, this can be
285           tidied up significantly.
286     """
287     def __init__(self, tag_model):
288         super(TaggedItemManager, self).__init__()
289         self.tag_model = tag_model
290     
291     def get_by_model(self, queryset_or_model, tags):
292         """
293         Create a ``QuerySet`` containing instances of the specified
294         model associated with a given tag or list of tags.
295         """
296         tags = self.tag_model.get_tag_list(tags)
297         tag_count = len(tags)
298         if tag_count == 0:
299             # No existing tags were given
300             queryset, model = get_queryset_and_model(queryset_or_model)
301             return model._default_manager.none()
302         elif tag_count == 1:
303             # Optimisation for single tag - fall through to the simpler
304             # query below.
305             tag = tags[0]
306         else:
307             return self.get_intersection_by_model(queryset_or_model, tags)
308
309         queryset, model = get_queryset_and_model(queryset_or_model)
310         content_type = ContentType.objects.get_for_model(model)
311         opts = self.model._meta
312         tagged_item_table = qn(opts.db_table)
313         return queryset.extra(
314             tables=[opts.db_table],
315             where=[
316                 '%s.content_type_id = %%s' % tagged_item_table,
317                 '%s.tag_id = %%s' % tagged_item_table,
318                 '%s.%s = %s.object_id' % (qn(model._meta.db_table),
319                                           qn(model._meta.pk.column),
320                                           tagged_item_table)
321             ],
322             params=[content_type.pk, tag.pk],
323         )
324
325     def get_intersection_by_model(self, queryset_or_model, tags):
326         """
327         Create a ``QuerySet`` containing instances of the specified
328         model associated with *all* of the given list of tags.
329         """
330         tags = self.tag_model.get_tag_list(tags)
331         tag_count = len(tags)
332         queryset, model = get_queryset_and_model(queryset_or_model)
333
334         if not tag_count:
335             return model._default_manager.none()
336
337         model_table = qn(model._meta.db_table)
338         # This query selects the ids of all objects which have all the
339         # given tags.
340         query = """
341         SELECT %(model_pk)s
342         FROM %(model)s, %(tagged_item)s
343         WHERE %(tagged_item)s.content_type_id = %(content_type_id)s
344           AND %(tagged_item)s.tag_id IN (%(tag_id_placeholders)s)
345           AND %(model_pk)s = %(tagged_item)s.object_id
346         GROUP BY %(model_pk)s
347         HAVING COUNT(%(model_pk)s) = %(tag_count)s""" % {
348             'model_pk': '%s.%s' % (model_table, qn(model._meta.pk.column)),
349             'model': model_table,
350             'tagged_item': qn(self.model._meta.db_table),
351             'content_type_id': ContentType.objects.get_for_model(model).pk,
352             'tag_id_placeholders': ','.join(['%s'] * tag_count),
353             'tag_count': tag_count,
354         }
355
356         cursor = connection.cursor()
357         cursor.execute(query, [tag.pk for tag in tags])
358         object_ids = [row[0] for row in cursor.fetchall()]
359         if len(object_ids) > 0:
360             return queryset.filter(pk__in=object_ids)
361         else:
362             return model._default_manager.none()
363
364     def get_union_by_model(self, queryset_or_model, tags):
365         """
366         Create a ``QuerySet`` containing instances of the specified
367         model associated with *any* of the given list of tags.
368         """
369         tags = self.tag_model.get_tag_list(tags)
370         tag_count = len(tags)
371         queryset, model = get_queryset_and_model(queryset_or_model)
372
373         if not tag_count:
374             return model._default_manager.none()
375
376         model_table = qn(model._meta.db_table)
377         # This query selects the ids of all objects which have any of
378         # the given tags.
379         query = """
380         SELECT %(model_pk)s
381         FROM %(model)s, %(tagged_item)s
382         WHERE %(tagged_item)s.content_type_id = %(content_type_id)s
383           AND %(tagged_item)s.tag_id IN (%(tag_id_placeholders)s)
384           AND %(model_pk)s = %(tagged_item)s.object_id
385         GROUP BY %(model_pk)s""" % {
386             'model_pk': '%s.%s' % (model_table, qn(model._meta.pk.column)),
387             'model': model_table,
388             'tagged_item': qn(self.model._meta.db_table),
389             'content_type_id': ContentType.objects.get_for_model(model).pk,
390             'tag_id_placeholders': ','.join(['%s'] * tag_count),
391         }
392
393         cursor = connection.cursor()
394         cursor.execute(query, [tag.pk for tag in tags])
395         object_ids = [row[0] for row in cursor.fetchall()]
396         if len(object_ids) > 0:
397             return queryset.filter(pk__in=object_ids)
398         else:
399             return model._default_manager.none()
400
401     def get_related(self, obj, queryset_or_model, num=None):
402         """
403         Retrieve a list of instances of the specified model which share
404         tags with the model instance ``obj``, ordered by the number of
405         shared tags in descending order.
406
407         If ``num`` is given, a maximum of ``num`` instances will be
408         returned.
409         """
410         queryset, model = get_queryset_and_model(queryset_or_model)
411         model_table = qn(model._meta.db_table)
412         content_type = ContentType.objects.get_for_model(obj)
413         related_content_type = ContentType.objects.get_for_model(model)
414         query = """
415         SELECT %(model_pk)s, COUNT(related_tagged_item.object_id) AS %(count)s
416         FROM %(model)s, %(tagged_item)s, %(tag)s, %(tagged_item)s related_tagged_item
417         WHERE %(tagged_item)s.object_id = %%s
418           AND %(tagged_item)s.content_type_id = %(content_type_id)s
419           AND %(tag)s.id = %(tagged_item)s.tag_id
420           AND related_tagged_item.content_type_id = %(related_content_type_id)s
421           AND related_tagged_item.tag_id = %(tagged_item)s.tag_id
422           AND %(model_pk)s = related_tagged_item.object_id"""
423         if content_type.pk == related_content_type.pk:
424             # Exclude the given instance itself if determining related
425             # instances for the same model.
426             query += """
427           AND related_tagged_item.object_id != %(tagged_item)s.object_id"""
428         query += """
429         GROUP BY %(model_pk)s
430         ORDER BY %(count)s DESC
431         %(limit_offset)s"""
432         query = query % {
433             'model_pk': '%s.%s' % (model_table, qn(model._meta.pk.column)),
434             'count': qn('count'),
435             'model': model_table,
436             'tagged_item': qn(self.model._meta.db_table),
437             'tag': qn(self.model._meta.get_field('tag').rel.to._meta.db_table),
438             'content_type_id': content_type.pk,
439             'related_content_type_id': related_content_type.pk,
440             'limit_offset': num is not None and connection.ops.limit_offset_sql(num) or '',
441         }
442
443         cursor = connection.cursor()
444         cursor.execute(query, [obj.pk])
445         object_ids = [row[0] for row in cursor.fetchall()]
446         if len(object_ids) > 0:
447             # Use in_bulk here instead of an id__in lookup, because id__in would
448             # clobber the ordering.
449             object_dict = queryset.in_bulk(object_ids)
450             return [object_dict[object_id] for object_id in object_ids \
451                     if object_id in object_dict]
452         else:
453             return []
454
455
456 ##########
457 # Models #
458 ##########
459 def create_intermediary_table_model(model):
460     """Create an intermediary table model for the specific tag model"""
461     name = model.__name__ + 'Relation'
462      
463     class Meta:
464         db_table = '%s_relation' % model._meta.db_table
465         unique_together = (('tag', 'content_type', 'object_id'),)
466
467     def obj_unicode(self):
468         return u'%s [%s]' % (self.content_type.get_object_for_this_type(pk=self.object_id), self.tag)
469         
470     # Set up a dictionary to simulate declarations within a class    
471     attrs = {
472         '__module__': model.__module__,
473         'Meta': Meta,
474         'tag': models.ForeignKey(model, verbose_name=_('tag'), related_name='items'),
475         'content_type': models.ForeignKey(ContentType, verbose_name=_('content type')),
476         'object_id': models.PositiveIntegerField(_('object id'), db_index=True),
477         'content_object': generic.GenericForeignKey('content_type', 'object_id'),
478         '__unicode__': obj_unicode,
479     }
480
481     return type(name, (models.Model,), attrs)
482
483
484 class TagMeta(ModelBase):
485     "Metaclass for tag models (models inheriting from TagBase)."
486     def __new__(cls, name, bases, attrs):
487         model = super(TagMeta, cls).__new__(cls, name, bases, attrs)
488         if not model._meta.abstract:
489             # Create an intermediary table and register custom managers for concrete models
490             model.intermediary_table_model = create_intermediary_table_model(model)
491             TagManager(model.intermediary_table_model).contribute_to_class(model, 'objects')
492             TaggedItemManager(model).contribute_to_class(model.intermediary_table_model, 'objects')
493         return model
494
495
496 class TagBase(models.Model):
497     """Abstract class to be inherited by model classes."""
498     __metaclass__ = TagMeta
499     
500     class Meta:
501         abstract = True
502     
503     @staticmethod
504     def get_tag_list(tag_list):
505         """
506         Utility function for accepting tag input in a flexible manner.
507         
508         You should probably override this method in your subclass.
509         """
510         if isinstance(tag_list, TagBase):
511             return [tag_list]
512         else:
513             return tag_list
514