Added a document indexing list view

apps/document_indexing/admin.py

@@ -13,7 +13,7 @@ class IndexInstanceInline(admin.StackedInline):
 
 
 class IndexAdmin(MPTTModelAdmin):
-    list_display = ('expression', 'enabled', 'link_document')
+    list_display = ('expression', 'enabled', 'link_documents')
     
     
 class IndexInstanceAdmin(MPTTModelAdmin):

apps/document_indexing/api.py

@@ -1,4 +1,7 @@
 from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import ugettext
+from django.core.urlresolvers import reverse
+from django.utils.safestring import mark_safe
 
 from metadata.classes import MetadataObject
 
@@ -14,7 +17,7 @@ def evaluate_index(eval_dict, document, node, parent_index_instance=None):
         try:
             result = eval(node.expression, eval_dict, AVAILABLE_INDEXING_FUNCTIONS)
             index_instance, created = IndexInstance.objects.get_or_create(index=node, value=result, parent=parent_index_instance)
-            if node.link_document:
+            if node.link_documents:
                 index_instance.documents.add(document)
                 
             for children in node.get_children():
@@ -42,7 +45,6 @@ def update_indexes(document):
     eval_dict['metadata'] = MetadataObject(metadata_dict)
 
     for root in Index.objects.filter(parent=None):
-        #for node in root.get_children():
         index_warnings = evaluate_index(eval_dict, document, root)
         warnings.extend(index_warnings)
 
@@ -51,3 +53,40 @@ def update_indexes(document):
     
 def delete_indexes(document):
     print 'delete_indexes'
+
+
+def get_instance_link(index_instance=None, text=None, simple=False):
+    if simple:
+        # Just display the instance's value or overrided text, no
+        # HTML anchor
+        template = u'%(value)s'
+    else:
+        template = u'<a href="%(url)s">%(value)s</a>'
+    if index_instance:
+        return template % {
+            'url': index_instance.get_absolute_url(), 'value': text if text else index_instance
+        }
+    else:
+        # Root node
+        return template % {
+            'url': reverse('index_instance_list'), 'value': ugettext(u'root')
+        }
+        
+
+def get_breadcrumbs(index_instance, simple=False, single_link=False):
+    result = []
+    if single_link:
+        # Return the entire breadcrumb as a single HTML anchor
+        simple = True
+    
+    result.append(get_instance_link(simple=simple))
+
+    for instance in index_instance.get_ancestors():
+        result.append(get_instance_link(instance, simple=simple))
+
+    result.append(get_instance_link(index_instance, simple=simple))
+
+    if single_link:
+        return mark_safe(get_instance_link(index_instance=index_instance, text=(u' / '.join(result))))
+    else:
+        return mark_safe(u' / '.join(result))

apps/document_indexing/models.py

@@ -1,7 +1,8 @@
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 
-from mptt.models import MPTTModel, TreeForeignKey
+from mptt.models import MPTTModel
+from mptt.fields import TreeForeignKey
 
 from documents.models import Document
 
@@ -15,10 +16,10 @@ class Index(MPTTModel):
     expression = models.CharField(max_length=128, verbose_name=_(u'indexing expression'), help_text=_(u'Enter a python string expression to be evaluated.'))
         # % available_indexing_functions_string)
     enabled = models.BooleanField(default=True, verbose_name=_(u'enabled'))
-    link_document = models.BooleanField(default=False, verbose_name=_(u'link document'))
+    link_documents = models.BooleanField(default=False, verbose_name=_(u'link documents'))
     
     def __unicode__(self):
-        return self.expression if not self.link_document else u'%s/[document]' % self.expression
+        return self.expression if not self.link_documents else u'%s/[document]' % self.expression
 
     class Meta:
         verbose_name = _(u'index')
@@ -34,9 +35,12 @@ class IndexInstance(MPTTModel):
     def __unicode__(self):
         return self.value
 
+    @models.permalink
+    def get_absolute_url(self):
+        return ('index_instance_list', [self.pk])
+
     def get_document_list_display(self):
         return u', '.join([d.file_filename for d in self.documents.all()])
-        
 
     class Meta:
         verbose_name = _(u'index instance')

apps/document_indexing/urls.py

@@ -0,0 +1,6 @@
+from django.conf.urls.defaults import patterns, url
+
+urlpatterns = patterns('document_indexing.views',
+    url(r'^(?P<index_id>\d+)/list/$', 'index_instance_list', (), 'index_instance_list'),
+    url(r'^list/$', 'index_instance_list', (), 'index_instance_list'),
+)

apps/document_indexing/utils.py

@@ -0,0 +1,23 @@
+from django.utils.translation import ugettext_lazy as _
+
+from document_indexing.api import get_breadcrumbs
+
+
+def get_document_indexing_subtemplate(document):
+    """
+    Return all the settings to render a subtemplate containing a
+    list of index instances where a document may be found
+    """
+    object_list = []
+    
+    for index_instance in document.indexinstance_set.all():
+        object_list.append(get_breadcrumbs(index_instance, single_link=True))
+    
+    return {
+            'name': 'generic_list_subtemplate.html',
+            'context': {
+                'title': _(u'index links'),
+                'object_list': object_list,
+                'hide_link': True
+            }
+        }

apps/document_indexing/views.py

@@ -1 +1,37 @@
-# Create your views here.
+from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import ugettext
+from django.http import HttpResponseRedirect
+from django.shortcuts import render_to_response, get_object_or_404
+from django.template import RequestContext
+from django.contrib import messages
+from django.core.urlresolvers import reverse
+from django.conf import settings
+from django.utils.safestring import mark_safe
+
+from document_indexing.models import IndexInstance
+from document_indexing.api import get_breadcrumbs, get_instance_link
+
+
+def index_instance_list(request, index_id=None):
+    #TODO: check_permissions
+    #check_permissions(request.user, 'documents', [PERMISSION_DOCUMENT_VIEW])
+
+    if index_id:
+        index_instance = get_object_or_404(IndexInstance, pk=index_id)
+        index_instance_list = [index for index in index_instance.get_children()]
+        breadcrumbs = get_breadcrumbs(index_instance)
+        if index_instance.documents.count():
+            for document in index_instance.documents.all():
+                index_instance_list.append(document)
+    else:
+        index_instance_list = IndexInstance.objects.filter(parent=None)
+        breadcrumbs = get_instance_link()
+
+    title = mark_safe(_(u'contents for index: %s') % breadcrumbs)
+        
+    return render_to_response('generic_list.html', {
+        'object_list': index_instance_list,
+        'title': title,
+        'hide_links': True,
+    }, context_instance=RequestContext(request))
+