Better Solr AltParser quoting (closes django-haystack#730)

Previously the Solr AltParser implementation embedded the search term as an
attribte inside the {!…} construct, which required it to be doubly escaped.

This change contributed by @ivirabyan moves the value outside the query,
requiring only our normal quoting:

    q=(_query_:"{!edismax}Assassin's Creed")

instead of:

    q=(_query_:"{!edismax v='Assassin's Creed'}")

Thanks @ivirabyan for the patch!

Author: acdha

haystack/backends/solr_backend.py

@@ -592,7 +592,7 @@ def build_query_fragment(self, field, filter_type, value):
 
     def build_alt_parser_query(self, parser_name, query_string='', **kwargs):
         if query_string:
-            kwargs['v'] = Clean(query_string).prepare(self)
+            query_string = Clean(query_string).prepare(self)
 
         kwarg_bits = []
 
@@ -602,7 +602,7 @@ def build_alt_parser_query(self, parser_name, query_string='', **kwargs):
             else:
                 kwarg_bits.append(u"%s=%s" % (key, kwargs[key]))
 
-        return u'_query_:"{!%s %s}"' % (parser_name, Clean(' '.join(kwarg_bits)))
+        return u'_query_:"{!%s %s}%s"' % (parser_name, Clean(' '.join(kwarg_bits)), query_string)
 
     def build_params(self, spelling_query=None, **kwargs):
         search_kwargs = {

tests/solr_tests/tests/inputs.py

@@ -78,4 +78,8 @@ def test_altparser_init(self):
     def test_altparser_prepare(self):
         altparser = inputs.AltParser('dismax', 'douglas adams', qf='author', mm=1)
         self.assertEqual(altparser.prepare(self.query_obj),
-                         u"""_query_:"{!dismax mm=1 qf=author v='douglas adams'}\"""")
+                         u"""_query_:"{!dismax mm=1 qf=author}douglas adams\"""")
+
+        altparser = inputs.AltParser('dismax', 'Don\'t panic', qf='text author', mm=1)
+        self.assertEqual(altparser.prepare(self.query_obj),
+                         u"""_query_:"{!dismax mm=1 qf='text author'}Don't panic\"""")

tests/solr_tests/tests/solr_backend.py

@@ -162,6 +162,16 @@ def get_model(self):
         return ASixthMockModel
 
 
+class SolrQuotingMockSearchIndex(indexes.SearchIndex, indexes.Indexable):
+    text = indexes.CharField(document=True, use_template=True)
+
+    def get_model(self):
+        return MockModel
+
+    def prepare_text(self, obj):
+        return u"""Don't panic but %s has been iñtërnâtiônàlizéð""" % obj.author
+
+
 class SolrSearchBackendTestCase(TestCase):
     def setUp(self):
         super(SolrSearchBackendTestCase, self).setUp()
@@ -362,7 +372,7 @@ def test_search(self):
     def test_altparser_query(self):
         self.sb.update(self.smmi, self.sample_objs)
 
-        results = self.sb.search(AltParser('dismax', 'daniel1', qf='name', mm=1).prepare(self.sq))
+        results = self.sb.search(AltParser('dismax', "daniel1", qf='name', mm=1).prepare(self.sq))
         self.assertEqual(results['hits'], 1)
 
         # This should produce exactly the same result since all we have are mockmodel instances but we simply
@@ -387,6 +397,16 @@ def test_altparser_query(self):
         self.assertEqual(len(results), 1)
         self.assertEqual(results[0].id, 'core.mockmodel.1')
 
+    def test_altparser_quoting(self):
+        test_objs = [
+            MockModel(id=1, author="Foo d'Bar", pub_date=datetime.date.today()),
+            MockModel(id=2, author="Baaz Quuz", pub_date=datetime.date.today()),
+        ]
+        self.sb.update(SolrQuotingMockSearchIndex(), test_objs)
+
+        results = self.sb.search(AltParser('dismax', "+don't +quuz", qf='text').prepare(self.sq))
+        self.assertEqual(results['hits'], 1)
+
     def test_more_like_this(self):
         self.sb.update(self.smmi, self.sample_objs)
         self.assertEqual(self.raw_solr.search('*:*').hits, 3)

tests/solr_tests/tests/solr_query.py

@@ -75,14 +75,14 @@ def test_build_query_multiple_filter_types(self):
         self.assertEqual(self.sq.build_query(), u'((why) AND pub_date:([* TO "2009-02-10 01:59:00"]) AND author:({"daniel" TO *}) AND created:({* TO "2009-02-12 12:13:00"}) AND title:(["B" TO *]) AND id:("1" OR "2" OR "3") AND rating:(["3" TO "5"]))')
 
     def test_build_complex_altparser_query(self):
-        self.sq.add_filter(SQ(content=AltParser('dismax', 'why', qf='text')))
+        self.sq.add_filter(SQ(content=AltParser('dismax', "Don't panic", qf='text')))
         self.sq.add_filter(SQ(pub_date__lte=Exact('2009-02-10 01:59:00')))
         self.sq.add_filter(SQ(author__gt='daniel'))
         self.sq.add_filter(SQ(created__lt=Exact('2009-02-12 12:13:00')))
         self.sq.add_filter(SQ(title__gte='B'))
         self.sq.add_filter(SQ(id__in=[1, 2, 3]))
         self.sq.add_filter(SQ(rating__range=[3, 5]))
-        self.assertEqual(self.sq.build_query(), u'((_query_:"{!dismax qf=text v=why}") AND pub_date:([* TO "2009-02-10 01:59:00"]) AND author:({"daniel" TO *}) AND created:({* TO "2009-02-12 12:13:00"}) AND title:(["B" TO *]) AND id:("1" OR "2" OR "3") AND rating:(["3" TO "5"]))')
+        self.assertEqual(self.sq.build_query(), u'((_query_:"{!dismax qf=text}Don\'t panic") AND pub_date:([* TO "2009-02-10 01:59:00"]) AND author:({"daniel" TO *}) AND created:({* TO "2009-02-12 12:13:00"}) AND title:(["B" TO *]) AND id:("1" OR "2" OR "3") AND rating:(["3" TO "5"]))')
 
     def test_build_query_multiple_filter_types_with_datetimes(self):
         self.sq.add_filter(SQ(content='why'))