Merge branch 'master' of git://github.com/melinath/philo

[philo.git] / philo / contrib / sobol / models.py

diff --git a/philo/contrib/sobol/models.py b/philo/contrib/sobol/models.py
index 82fe947..b35133e 100644 (file)
--- a/philo/contrib/sobol/models.py
+++ b/philo/contrib/sobol/models.py
@@ -11,7 +11,7 @@ from django.http import HttpResponseRedirect, Http404, HttpResponse
 from django.utils import simplejson as json
 from django.utils.datastructures import SortedDict
 
 from django.utils import simplejson as json
 from django.utils.datastructures import SortedDict
 

-from philo.contrib.sobol import registry
+from philo.contrib.sobol import registry, get_search_instance

 from philo.contrib.sobol.forms import SearchForm
 from philo.contrib.sobol.utils import HASH_REDIRECT_GET_KEY, URL_REDIRECT_GET_KEY, SEARCH_ARG_GET_KEY, check_redirect_hash, RegistryIterator
 from philo.exceptions import ViewCanNotProvideSubpath
 from philo.contrib.sobol.forms import SearchForm
 from philo.contrib.sobol.utils import HASH_REDIRECT_GET_KEY, URL_REDIRECT_GET_KEY, SEARCH_ARG_GET_KEY, check_redirect_hash, RegistryIterator
 from philo.exceptions import ViewCanNotProvideSubpath


@@ -79,6 +79,8 @@ class Search(models.Model):
                                        self._favored_results += subresults
                                else:
                                        break
                                        self._favored_results += subresults
                                else:
                                        break

+                       if len(self._favored_results) == len(results):
+                               self._favored_results = []

                return self._favored_results
        
        class Meta:
                return self._favored_results
        
        class Meta:


@@ -168,14 +170,14 @@ try:
 except ImportError:
        pass
 else:
 except ImportError:
        pass
 else:

-       add_introspection_rules([], ["^philo\.contrib\.shipherd\.models\.RegistryChoiceField"])
+       add_introspection_rules([], ["^philo\.contrib\.sobol\.models\.RegistryChoiceField"])

 
 
 class SearchView(MultiView):
 
 
 class SearchView(MultiView):

-       """Handles a view for the results of a search, and an AJAX API for asynchronous search result loading. This can be particularly useful if some searches are slow."""
+       """Handles a view for the results of a search, anonymously tracks the selections made by end users, and provides an AJAX API for asynchronous search result loading. This can be particularly useful if some searches are slow."""

        #: :class:`ForeignKey` to a :class:`.Page` which will be used to render the search results.
        results_page = models.ForeignKey(Page, related_name='search_results_related')
        #: :class:`ForeignKey` to a :class:`.Page` which will be used to render the search results.
        results_page = models.ForeignKey(Page, related_name='search_results_related')

-       #: A class:`.SlugMultipleChoiceField` whose choices are the contents of the :class:`.SearchRegistry`
+       #: A :class:`.SlugMultipleChoiceField` whose choices are the contents of the :class:`.SearchRegistry`

        searches = RegistryChoiceField(choices=registry.iterchoices())
        #: A :class:`BooleanField` which controls whether or not the AJAX API is enabled.
        #:
        searches = RegistryChoiceField(choices=registry.iterchoices())
        #: A :class:`BooleanField` which controls whether or not the AJAX API is enabled.
        #:


@@ -206,15 +208,11 @@ class SearchView(MultiView):
                        )
                return urlpatterns
        
                        )
                return urlpatterns
        

-       def get_search_instance(self, slug, search_string):
-               """Returns an instance of the :class:`.BaseSearch` subclass corresponding to ``slug`` in the :class:`.SearchRegistry` and instantiated with ``search_string``."""
-               return registry[slug](search_string.lower())
-       

        def results_view(self, request, extra_context=None):
                """
                Renders :attr:`results_page` with a context containing an instance of :attr:`search_form`. If the form was submitted and was valid, then one of two things has happened:
                
        def results_view(self, request, extra_context=None):
                """
                Renders :attr:`results_page` with a context containing an instance of :attr:`search_form`. If the form was submitted and was valid, then one of two things has happened:
                

-               * A search has been initiated. In this case, a list of search instances will be added to the context as 'searches'. If :attr:`enable_ajax_api` is enabled, each instance will have an "ajax_api_url" attribute containing the url needed to make an AJAX request for the search results.
+               * A search has been initiated. In this case, a list of search instances will be added to the context as ``searches``. If :attr:`enable_ajax_api` is enabled, each instance will have an ``ajax_api_url`` attribute containing the url needed to make an AJAX request for the search results.

                * A link has been chosen. In this case, corresponding :class:`Search`, :class:`ResultURL`, and :class:`Click` instances will be created and the user will be redirected to the link's actual url.
                
                """
                * A link has been chosen. In this case, corresponding :class:`Search`, :class:`ResultURL`, and :class:`Click` instances will be created and the user will be redirected to the link's actual url.
                
                """


@@ -245,11 +243,12 @@ class SearchView(MultiView):
                                
                                search_instances = []
                                for slug in self.searches:
                                
                                search_instances = []
                                for slug in self.searches:

-                                       search_instance = self.get_search_instance(slug, search_string)
-                                       search_instances.append(search_instance)
+                                       if slug in registry:
+                                               search_instance = get_search_instance(slug, search_string)
+                                               search_instances.append(search_instance)

                                        
                                        

-                                       if self.enable_ajax_api:
-                                               search_instance.ajax_api_url = "%s?%s=%s" % (self.reverse('ajax_api_view', kwargs={'slug': slug}, node=request.node), SEARCH_ARG_GET_KEY, search_string)
+                                               if self.enable_ajax_api:
+                                                       search_instance.ajax_api_url = "%s?%s=%s" % (self.reverse('ajax_api_view', kwargs={'slug': slug}, node=request.node), SEARCH_ARG_GET_KEY, search_string)

                                
                                if eventlet and not self.enable_ajax_api:
                                        pool = eventlet.GreenPool()
                                
                                if eventlet and not self.enable_ajax_api:
                                        pool = eventlet.GreenPool()


@@ -258,8 +257,16 @@ class SearchView(MultiView):
                                        pool.waitall()
                                
                                context.update({
                                        pool.waitall()
                                
                                context.update({

-                                       'searches': search_instances
+                                       'searches': search_instances,
+                                       'favored_results': []

                                })
                                })

+                               
+                               try:
+                                       search = Search.objects.get(string=search_string)
+                               except Search.DoesNotExist:
+                                       pass
+                               else:
+                                       context['favored_results'] = [r.url for r in search.get_favored_results()]

                else:
                        form = SearchForm()
                
                else:
                        form = SearchForm()
                


@@ -270,23 +277,30 @@ class SearchView(MultiView):
        
        def ajax_api_view(self, request, slug, extra_context=None):
                """
        
        def ajax_api_view(self, request, slug, extra_context=None):
                """

-               Returns a JSON string containing two keyed lists.
+               Returns a JSON object containing the following variables:

                
                

+               search
+                       Contains the slug for the search.

                results
                        Contains the results of :meth:`.Result.get_context` for each result.
                results
                        Contains the results of :meth:`.Result.get_context` for each result.

-               

                rendered
                        Contains the results of :meth:`.Result.render` for each result.
                rendered
                        Contains the results of :meth:`.Result.render` for each result.

+               hasMoreResults
+                       ``True`` or ``False`` whether the search has more results according to :meth:`BaseSearch.has_more_results`
+               moreResultsURL
+                       Contains ``None`` or a querystring which, once accessed, will note the :class:`Click` and redirect the user to a page containing more results.

                
                """
                search_string = request.GET.get(SEARCH_ARG_GET_KEY)
                
                
                """
                search_string = request.GET.get(SEARCH_ARG_GET_KEY)
                

-               if not request.is_ajax() or not self.enable_ajax_api or slug not in self.searches or search_string is None:
+               if not request.is_ajax() or not self.enable_ajax_api or slug not in registry or slug not in self.searches or search_string is None:

                        raise Http404
                
                        raise Http404
                

-               search_instance = self.get_search_instance(slug, search_string)
+               search_instance = get_search_instance(slug, search_string)

                
                return HttpResponse(json.dumps({
                
                return HttpResponse(json.dumps({

+                       'search': search_instance.slug,

                        'results': [result.get_context() for result in search_instance.results],
                        'results': [result.get_context() for result in search_instance.results],

-                       'rendered': [result.render() for result in search_instance.results]
+                       'hasMoreResults': search_instance.has_more_results,
+                       'moreResultsURL': search_instance.more_results_url,

                }), mimetype="application/json")
\ No newline at end of file
                }), mimetype="application/json")
\ No newline at end of file