6. Search and the Django-CMS

Currently the best way to integrate search with the Django-CMS is Haystack, however it is not officially supported.

6.1. Haystack

If you go the Haystack way, you’ll need a search_indexes.py.　Haystack doesn’t care if it’s in the same app as the models, so you can put it into any app within your project.

Here is an example untested and unsupported search_indexes.py:

  1. from django.conf import settings
  2. from django.utils.translation import string_concat, ugettext_lazy
  4. from haystack import indexes, site
  6. from cms.models.managers import PageManager
  7. from cms.models.pagemodel import Page
  9. def page_index_factory(lang, lang_name):
  10.     if isinstance(lang_name, basestring):
  11.         lang_name = ugettext_lazy(lang_name)
  13.     def get_absolute_url(self):
  14.         return '/%s%s' % (lang, Page.get_absolute_url(self))
  16.     class Meta:
  17.         proxy = True
  18.         app_label = 'cms'
  19.         verbose_name = string_concat(Page._meta.verbose_name, ' (', lang_name, ')')
  20.         verbose_name_plural = string_concat(Page._meta.verbose_name_plural, ' (', lang_name, ')')
  22.     attrs = {'__module__': Page.__module__, 
  23.              'Meta': Meta,
  24.              'objects': PageManager(),
  25.              'get_absolute_url': get_absolute_url}
  27.     _PageProxy = type("Page%s" % lang.title() , (Page,), attrs)
  29.     _PageProxy._meta.parent_attr = 'parent'
  30.     _PageProxy._meta.left_attr = 'lft'
  31.     _PageProxy._meta.right_attr = 'rght'
  32.     _PageProxy._meta.tree_id_attr = 'tree_id'
  34.     class _PageIndex(indexes.SearchIndex):
  35.         language = lang
  37.         text = indexes.CharField(document=True, use_template=False)
  38.         pub_date = indexes.DateTimeField(model_attr='publication_date')
  39.         login_required = indexes.BooleanField(model_attr='login_required')
  40.         url = indexes.CharField(stored=True, indexed=False, model_attr='get_absolute_url')
  41.         title = indexes.CharField(stored=True, indexed=False, model_attr='get_title')
  43.         def prepare(self, obj):
  44.             self.prepared_data = super(_PageIndex, self).prepare(obj)
  45.             plugins = obj.cmsplugin_set.filter(language=lang)
  46.             text = ''
  47.             for plugin in plugins:
  48.                 instance, _ = plugin.get_plugin_instance()
  49.                 if hasattr(instance, 'search_fields'):
  50.                     text += ''.join(getattr(instance, field) for field in instance.search_fields)
  51.             self.prepared_data['text'] = text
  52.             return self.prepared_data
  54.         def get_queryset(self):
  55.             return _PageProxy.objects.published().filter(title_set__language=lang, publisher_is_draft=False).distinct()
  57.     return _PageProxy, _PageIndex
  59. for lang_tuple in settings.LANGUAGES:
  60.     lang, lang_name = lang_tuple
  61.     site.register(*page_index_factory(lang, lang_name))