Mercurial > public > sg101

annotate custom_search/forms.py @ 1171:c855a88f9d78

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge mainline into V3 dev branch
author Brian Neal <bgneal@gmail.com>
date Sun, 07 Jan 2018 12:00:24 -0600
parents 829d3b7fc0f7
children
rev   line source
bgneal@469 1 """
bgneal@469 2 This module contains custom forms to tailor the Haystack search application to
bgneal@469 3 our needs.
bgneal@469 4
bgneal@469 5 """
bgneal@753 6 import logging
bgneal@753 7
bgneal@469 8 from django import forms
bgneal@753 9 from django.conf import settings
bgneal@469 10 from haystack.forms import ModelSearchForm
bgneal@469 11
bgneal@469 12
bgneal@469 13 MODEL_CHOICES = (
bgneal@469 14 ('forums.topic', 'Forum Topics'),
bgneal@469 15 ('forums.post', 'Forum Posts'),
bgneal@469 16 ('news.story', 'News Stories'),
bgneal@469 17 ('bio.userprofile', 'User Profiles'),
bgneal@469 18 ('weblinks.link', 'Links'),
bgneal@469 19 ('downloads.download', 'Downloads'),
bgneal@469 20 ('podcast.item', 'Podcasts'),
bgneal@469 21 ('ygroup.post', 'Yahoo Group Archives'),
bgneal@469 22 )
bgneal@469 23
bgneal@753 24 logger = logging.getLogger(__name__)
bgneal@753 25
bgneal@469 26
bgneal@469 27 class CustomModelSearchForm(ModelSearchForm):
bgneal@469 28 """
bgneal@469 29 This customized ModelSearchForm allows us to explictly label and order
bgneal@469 30 the model choices.
bgneal@469 31
bgneal@753 32 We also provide "all words", "exact phrase", and "exclude" text input boxes.
bgneal@753 33 Haystack 2.1.0's auto_query() function did not seem to work right so we just
bgneal@753 34 rolled our own.
bgneal@753 35
bgneal@763 36 This form can optionally receive the user making the search as a keyword
bgneal@763 37 argument ('user') to __init__. This will be used for logging search queries.
bgneal@763 38
bgneal@469 39 """
bgneal@753 40 q = forms.CharField(required=False, label='All these words',
bgneal@1127 41 widget=forms.TextInput(attrs={'type': 'search'}))
bgneal@753 42 exact = forms.CharField(required=False, label='This exact word or phrase',
bgneal@1127 43 widget=forms.TextInput(attrs={'type': 'search'}))
bgneal@753 44 exclude = forms.CharField(required=False, label='None of these words',
bgneal@1127 45 widget=forms.TextInput(attrs={'type': 'search'}))
bgneal@469 46
bgneal@469 47 def __init__(self, *args, **kwargs):
bgneal@763 48 self.user = kwargs.pop('user', None)
bgneal@469 49 super(CustomModelSearchForm, self).__init__(*args, **kwargs)
bgneal@469 50 self.fields['models'] = forms.MultipleChoiceField(choices=MODEL_CHOICES,
bgneal@753 51 label='Search in', widget=forms.CheckboxSelectMultiple)
bgneal@753 52
bgneal@753 53 def clean(self):
bgneal@956 54 super(CustomModelSearchForm, self).clean()
bgneal@753 55 if not settings.SEARCH_QUEUE_ENABLED:
bgneal@753 56 raise forms.ValidationError("Our search function is offline for "
bgneal@753 57 "maintenance. Please try again later. "
bgneal@753 58 "We apologize for any inconvenience.")
bgneal@753 59
bgneal@956 60 q = self.cleaned_data.get('q')
bgneal@956 61 exact = self.cleaned_data.get('exact')
bgneal@956 62 exclude = self.cleaned_data.get('exclude')
bgneal@956 63
bgneal@956 64 if not (q or exact or exclude):
bgneal@753 65 raise forms.ValidationError('Please supply some search terms')
bgneal@753 66
bgneal@753 67 return self.cleaned_data
bgneal@753 68
bgneal@943 69 def clean_exact(self):
bgneal@943 70 exact_field = self.cleaned_data['exact']
bgneal@943 71 if "'" in exact_field or '"' in exact_field:
bgneal@943 72 raise forms.ValidationError("Quotes are not needed in this field")
bgneal@943 73 return exact_field
bgneal@943 74
bgneal@753 75 def search(self):
bgneal@753 76 if not self.is_valid():
bgneal@753 77 return self.no_query_found()
bgneal@753 78
bgneal@763 79 if self.user is None:
bgneal@763 80 username = 'UNKNOWN'
bgneal@763 81 elif self.user.is_authenticated():
bgneal@763 82 username = self.user.username
bgneal@763 83 else:
bgneal@763 84 username = 'ANONYMOUS'
bgneal@763 85
bgneal@763 86 logger.info('Search executed: /%s/%s/%s/ in %s by %s',
bgneal@753 87 self.cleaned_data['q'],
bgneal@753 88 self.cleaned_data['exact'],
bgneal@753 89 self.cleaned_data['exclude'],
bgneal@763 90 self.cleaned_data['models'],
bgneal@763 91 username)
bgneal@753 92
bgneal@753 93 # Note that in Haystack 2.x content is untrusted and is automatically
bgneal@753 94 # auto-escaped for us.
bgneal@753 95 #
bgneal@943 96 # Gather regular search terms
bgneal@1034 97 terms = u' '.join(self.cleaned_data['q'].split())
bgneal@753 98
bgneal@753 99 # Exact words or phrases:
bgneal@943 100 exact = self.cleaned_data['exact'].strip()
bgneal@943 101 if exact:
bgneal@1034 102 exact = u'"{}"'.format(exact)
bgneal@753 103
bgneal@753 104 # Exclude terms:
bgneal@1034 105 exclude = [u"-{}".format(term) for term in self.cleaned_data['exclude'].split()]
bgneal@1034 106 exclude = u' '.join(exclude)
bgneal@943 107
bgneal@1034 108 query = u' '.join([terms, exact, exclude]).strip()
bgneal@943 109 logger.debug("auto_query: %s", query)
bgneal@943 110
bgneal@943 111 sqs = self.searchqueryset.auto_query(query)
bgneal@753 112
bgneal@753 113 if self.load_all:
bgneal@753 114 sqs = sqs.load_all()
bgneal@753 115
bgneal@753 116 # Apply model filtering
bgneal@753 117 sqs = sqs.models(*self.get_models())
bgneal@753 118
bgneal@753 119 return sqs