Merge branch 'search'

Author: albanm

djity/application_skeleton/{package_name}/search_indexes.py_tmpl

@@ -0,0 +1,24 @@
+"""
+Haystack indexes definitions to make models from application {application_name} searchable.
+
+See Haystack documentation for information to write these indexes: http://docs.haystacksearch.org/dev/searchindex_api.html
+"""
+
+from haystack import indexes
+
+from {package_name}.models import {class_name}
+
+class {class_name}Index(indexes.RealTimeSearchIndex, indexes.Indexable):
+    text = indexes.CharField(document=True, model_attr='message')
+    
+    # The following is necessary so that djity search engine shall be able to narrow results by projects and according to users roles.
+    project = indexes.IntegerField(model_attr='project__id')
+    status = indexes.MultiValueField()
+
+    def prepare_status(self,obj):
+        return range(obj.status+1)
+
+
+    def get_model(self):
+        return {class_name}
+

djity/application_skeleton/{package_name}/templates/{package_name}/{module_name}_search_result.html_tmpl

@@ -0,0 +1,6 @@
+{{% load highlight %}}
+
+<a href="{{{{ result_url }}}}">{{{{ result.object.name }}}}</a><br>
+{{% highlight result.text with query %}}
+
+

djity/project/urls.py

@@ -3,6 +3,7 @@
 
 from djity.simplepage.urls import urlpatterns as simplepage_urls
 from djity.style.urls import urlpatterns as css_urls
+from djity.search.urls import urlpatterns as search_urls
 from djity.utils import djity_modules
 
 from django.utils.importlib import import_module
@@ -16,14 +17,16 @@
         url(r'^forbidden/*$','djity.project.views.forbidden',name='forbidden'),
 )
 
-
 urlpatterns = patterns('',
     # project page redirect to the first tab
     url(r'^(?P<project_name>[-\w]+)/*$','djity.project.views.first_tab',name='first_tab'),
-    # login view as a pseudo application
+    # login and navigation views as a pseudo applications
     (r'^(?P<project_name>[-\w]+)/',include(portal_urls)),
-    # all other urls are handled by djity.modules.simple_page
+    # css as a pseudo application too
     (r'^(?P<project_name>[-\w]+)/css/',include(css_urls)),
+    # and search also
+    (r'^(?P<project_name>[-\w]+)/search/',include(search_urls)),
+
 )
 
 #import urls from djity applications

djity/project_skeleton/local_settings.py_tmpl

@@ -32,6 +32,9 @@ DEBUG = {develop!r}
 TEMPLATE_DEBUG = DEBUG
 DEBUG_TOOLBAR = DEBUG
 
+DEBUG_TOOLBAR_CONFIG = {{}}
+DEBUG_TOOLBAR_CONFIG["INTERCEPT_REDIRECTS"] = False
+
 if DEBUG :
     LOG_LEVEL = 'DEBUG'
 else:

djity/project_skeleton/search_sites.py

@@ -0,0 +1,2 @@
+import haystack
+haystack.autodiscover()

djity/project_skeleton/settings.py_tmpl

@@ -111,6 +111,9 @@ INSTALLED_APPS = [
     'dajaxice',
     'dajax',
 
+    # Haystack for search
+    'haystack',
+
     #Djity Core
     'djity',
     'djity.portlet',
@@ -119,6 +122,7 @@ INSTALLED_APPS = [
     'djity.project',
     'djity.simplepage',
     'djity.transmeta',
+    'djity.search',
 ]
 
 ###########################################
@@ -158,6 +162,15 @@ STATUS_PERMISSIONS = {{
 # list of permissions to check when updating djity's context
 PERMISSIONS = ['view','edit','upload','manage']
 
+# List of visible statuses according to role (used to filter search results)
+LOWER_VISIBLE_STATUS = {{
+    ANONYMOUS:PUBLIC,
+    AWAITING:PUBLIC,
+    USER:PRIVATE,
+    CONTRIBUTOR:DRAFT,
+    MANAGER:DRAFT,
+}}
+
 # Status display in user interface
 STATUS_DISPLAY = [[DRAFT,'Draft'],[PRIVATE,'Private'],[PUBLIC,'Public']]
 
@@ -202,6 +215,34 @@ LOCALE_INDEPENDENT_PATHS = (
 
 FIXTURE_DIRS = 'data/fixtures'
 
+###########################
+# Djity indexing settings #
+###########################
+
+# Haystack search engine connections configuration
+HAYSTACK_CONNECTIONS = {{'default':{{
+        'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
+        'PATH': '%s/data/whoosh/djity_index/default' % (PROJECT_ROOT),
+        'STORAGE': 'file',
+        'POST_LIMIT': 128 * 1024 * 1024,
+        'INCLUDE_SPELLING': True,
+        'BATCH_SIZE': 100,
+    }}
+}}
+
+for (language,language_repr) in LANGUAGES:
+    HAYSTACK_CONNECTIONS['default_'+language] = {{
+        'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
+        'PATH': '%s/data/whoosh/djity_index/%s' % (PROJECT_ROOT,language),
+        'STORAGE': 'file',
+        'POST_LIMIT': 128 * 1024 * 1024,
+        'INCLUDE_SPELLING': True,
+        'BATCH_SIZE': 100,
+        'LANGUAGE': '%s' % language
+    }}
+    
+HAYSTACK_ROUTERS = ['haystack.routers.LanguageRouter']
+
 ###################################################################
 # Import local settings and those from djity apps                 #
 ###################################################################

djity/project_skeleton/urls.py_tmpl

@@ -14,7 +14,6 @@ urlpatterns = patterns('',
 
 	(r'^localeurl/', include('localeurl.urls')),
 
-
 	(r'^%s/' % settings.DAJAXICE_MEDIA_PREFIX, include('dajaxice.urls')),
 
 	(r'^jsi18n/', 'django.views.i18n.javascript_catalog',{{ 'packages': ('djity')}}),

djity/search/__init__.py

@@ -0,0 +1,15 @@
+from django import template
+
+register = template.Library()
+
+@register.simple_tag(takes_context=True)
+def search_result(context, result):
+    """
+    Will render a search result for haystack by using the appropriate template for each model type
+    """
+    if result.app_label.startswith("djity_"):
+        template_path = "%s/%s_search_result.html" % (result.app_label,result.model_name)
+    else:
+        template_path = "djity/%s/%s_search_result.html" % (result.app_label,result.model_name)
+    return template.loader.render_to_string(template_path, {'result_url':result.object.djity_url(context)}, context)
+

djity/search/forms.py

@@ -0,0 +1,6 @@
+from django.conf.urls.defaults import *
+from djity.search.views import project_search
+
+urlpatterns = patterns('djity.search.views',
+    url(r'^$', project_search, name='project_search'),
+)

djity/search/templatetags/__init__.py

@@ -0,0 +1,16 @@
+from django.conf import settings
+
+from haystack.views import basic_search
+from haystack.query import SearchQuerySet
+from haystack.forms import SearchForm
+
+from djity.utils.decorators import djity_view
+from djity.utils.context import DjityContext
+
+@djity_view(perm='view')
+def project_search(request,context=None):
+    """
+    Override haystack basic_view for customization.
+    """
+    sqs = SearchQuerySet().narrow("project:%s"% context['project'].id).narrow("status:%s" % settings.LOWER_VISIBLE_STATUS[context['role']])
+    return basic_search(request, template='djity/search/search.html', searchqueryset=sqs, form_class=SearchForm, extra_context=context, context_class=DjityContext)

djity/search/templatetags/search_result.py

@@ -0,0 +1,16 @@
+from django.conf import settings
+
+from haystack import indexes
+
+from djity.simplepage.models import SimplePage
+
+class SimplePageIndex(indexes.RealTimeSearchIndex, indexes.Indexable):
+    text = indexes.CharField(document=True, model_attr='content')
+    project = indexes.IntegerField(model_attr='project__id')
+    status = indexes.MultiValueField()
+
+    def prepare_status(self,obj):
+        return range(obj.status+1)
+
+    def get_model(self):
+        return SimplePage

djity/search/urls.py

@@ -163,11 +163,28 @@ function widgetify() {
 				$(this).removeClass("ui-state-hover");
 			}
 	);
-
+	
+	$('#search_query').keypress(function(e) {
+        if(e.which == 13) {
+            $("#search_button").click();
+        }});
+	
+	$('#search_button')
+	    .addClass("dj-mini-button")
+	    .button({
+            icons: {
+                primary: "ui-icon-search"
+            },
+            text:false,
+            })
+        .click(function(){
+                query = $("#search_query").val();
+                project_url = $("#search_button .ui-button-text").text();
+                window.location.replace(project_url+"/search/?q="+query);
+            });
 
 	$('#messages').notify();
 
-
 
 	if(dj.context.perm.manage){
 		$("#project_title").editable({simple:true,save_function:'djity.project.save_project_title'});
@@ -195,13 +212,13 @@ function toolbar() {
 	$("#toolbar").buttonset();
 	$("#toolbar a")
 		.button()
-		.addClass('dj.context.mini-button');
+		.addClass('dj-mini-button');
 };
 
 function paginator() {
 	$('#paginator a')
 		.button()
-		.addClass('dj.context.mini-button');
+		.addClass('dj-mini-button');
 
 	$('#paginator .off')
 		.button('option','disabled','true');

djity/search/views.py

@@ -127,6 +127,12 @@
 
             <nav id="portal_parameters" class="ui-helper-hidden">
             </nav>
+                 
+
+            <div id="search_form">
+                <input id="search_query" name='q' type="text"></input>
+                <span class="ui-icon ui-icon-search" title="{% trans "Search" %}" id="search_button">{% djiurl project %}</span>
+            </div>
 
 				<nav id="right_tabs" class="ui-helper-hidden" >
 					{% if perm.manage %}

djity/simplepage/search_indexes.py

@@ -0,0 +1,28 @@
+{% extends "djity/base.html" %}
+
+{% load search_result %}
+
+{% load i18n %}
+
+{% block body %}
+        {% if query %}
+            <h3>{% trans "Search results for query" %} "{{ query }}"</h3>
+            {% for result in page.object_list %}
+                <p>
+                    {% search_result result %}
+                </p>
+            {% empty %}
+                <p>{% trans "No results found." %}</p>
+            {% endfor %}
+
+            {% if page.has_previous or page.has_next %}
+                <div>
+                    {% if page.has_previous %}<a href="?q={{ query }}&amp;page={{ page.previous_page_number }}">{% endif %}&laquo; Previous{% if page.has_previous %}</a>{% endif %}
+                    |
+                    {% if page.has_next %}<a href="?q={{ query }}&amp;page={{ page.next_page_number }}">{% endif %}Next &raquo;{% if page.has_next %}</a>{% endif %}
+                </div>
+            {% endif %}
+        {% else %}
+            {% trans "Submit a query to get some results !"
+        {% endif %}
+{% endblock %}

djity/static/djity/js/djity.js

@@ -0,0 +1,5 @@
+{% load highlight %}
+
+<a href="{{ result_url }}">{{ result.object.name }}</a><br>
+{% highlight result.object.content with query %}
+

djity/templates/djity/base.html

@@ -217,6 +217,19 @@ html>body #main {
 	float:right;
 }
 
+#search_form {
+	float:right;
+	padding-right:50px;
+}
+
+#search_query {
+}
+
+#search_button {
+    right:32px;
+    border:none;
+    background:none;
+}
 
 #create_tab_button {
 	float:right;

djity/templates/djity/search/search.html

@@ -0,0 +1,22 @@
+Project management commands
+===========================
+
+ * Prepare the databases. Useful in particular if you wish to update Djity for an existing project, or are modifying the models of an application used by the current project. (This is used automatically if you select the development mode of `djity-admin.py create_project`)::
+ 
+    $ python manage.py syncdb
+ 
+ * Create initial data for an empty project. (This is used automatically if you select the development mode of `djity-admin.py create_project`)::
+ 
+    $ python manage.py create_portal
+  
+ * Run development server. (This is used automatically if you select the development mode of `djity-admin.py create_project`)::
+ 
+    $ python manage.py runserver
+  
+ * Update search indexes. When the data of indexable contents from a project is modified, you should update all search indexes::
+ 
+    $ python manage.py update_indexes --using=all
+  
+ * Install an application in the current project. You can use `djity-admin.py ls_apps` to list all installed apps in the system::
+ 
+    $ python manage.py install_app <app>

djity/templates/djity/simplepage/simplepage_search_result.html

@@ -0,0 +1,10 @@
+Administration guide
+====================
+
+Administrate a Djity based website. Still very raw.
+
+.. toctree::
+    :maxdepth: 2
+
+    commands.rst
+