# -*- coding: utf-8 -*- from DateTime import DateTime from plone.app.contentlisting.interfaces import IContentListing from Products.CMFCore.utils import getToolByName from Products.CMFPlone.browser.navtree import getNavigationRoot from Products.CMFPlone.PloneBatch import Batch from Products.ZCTextIndex.ParseTree import ParseError from zope.component import getMultiAdapter from zope.i18nmessageid import MessageFactory from zope.publisher.browser import BrowserView from ZTUtils import make_query _ = MessageFactory('plone') # We should accept both a simple space, unicode u'\u0020 but also a # multi-space, so called 'waji-kankaku', unicode u'\u3000' MULTISPACE = u'\u3000'.encode('utf-8') EVER = DateTime('1970-01-03') def quote_chars(s): # We need to quote parentheses when searching text indices if '(' in s: s = s.replace('(', '"("') if ')' in s: s = s.replace(')', '")"') if MULTISPACE in s: s = s.replace(MULTISPACE, ' ') return s class Search(BrowserView): valid_keys = ('sort_on', 'sort_order', 'sort_limit', 'fq', 'fl', 'facet') def results(self, query=None, batch=True, b_size=10, b_start=0): """ Get properly wrapped search results from the catalog. Everything in Plone that performs searches should go through this view. 'query' should be a dictionary of catalog parameters. """ if query is None: query = {} if batch: query['b_start'] = b_start = int(b_start) query['b_size'] = b_size query = self.filter_query(query) if query is None: results = [] else: catalog = getToolByName(self.context, 'portal_catalog') try: results = catalog(**query) except ParseError: return [] results = IContentListing(results) if batch: results = Batch(results, b_size, b_start) return results def _filter_query(self, query): request = self.request catalog = getToolByName(self.context, 'portal_catalog') valid_indexes = tuple(catalog.indexes()) valid_keys = self.valid_keys + valid_indexes text = query.get('SearchableText', None) if text is None: text = request.form.get('SearchableText', '') if not text: # Without text, must provide a meaningful non-empty search valid = set(valid_indexes).intersection(request.form.keys()) or \ set(valid_indexes).intersection(query.keys()) if not valid: return for k, v in request.form.items(): if v and ((k in valid_keys) or k.startswith('facet.')): query[k] = v if text: query['SearchableText'] = quote_chars(text) # don't filter on created at all if we want all results created = query.get('created') if created: try: if created.get('query') and created['query'][0] <= EVER: del query['created'] except AttributeError: # created not a mapping del query['created'] # respect `types_not_searched` setting types = query.get('portal_type', []) if 'query' in types: types = types['query'] query['portal_type'] = self.filter_types(types) # respect effective/expiration date query['show_inactive'] = False # respect navigation root if 'path' not in query: query['path'] = getNavigationRoot(self.context) return query def filter_query(self, query): query = self._filter_query(query) if query is None: query = {} # explicitly set a sort; if no `sort_on` is present, the catalog sorts # by relevance if 'sort_on' not in query: site_properties = getToolByName(self.context, 'portal_properties').site_properties sort_on = site_properties.getProperty('sort_on', 'relevance') if sort_on != 'relevance': query['sort_on'] = sort_on elif query['sort_on'] == 'relevance': del query['sort_on'] if query.get('sort_on', '') == 'Date': query['sort_order'] = 'reverse' elif 'sort_order' in query: del query['sort_order'] if not query: return None return query def filter_types(self, types): plone_utils = getToolByName(self.context, 'plone_utils') if not isinstance(types, list): types = [types] return plone_utils.getUserFriendlyTypes(types) def types_list(self): # only show those types that have any content catalog = getToolByName(self.context, 'portal_catalog') used_types = catalog._catalog.getIndex('portal_type').uniqueValues() return self.filter_types(list(used_types)) def sort_options(self): """ Sorting options for search results view. """ if 'sort_on' not in self.request.form: site_properties = getToolByName(self.context, "portal_properties").site_properties sort_on = site_properties.getProperty('sort_on', 'relevance') self.request.form['sort_on'] = sort_on return ( SortOption(self.request, _(u'relevance'), 'relevance'), SortOption( self.request, _(u'date (newest first)'), 'Date', reverse=True ), SortOption(self.request, _(u'alphabetically'), 'sortable_title'), ) def show_advanced_search(self): """Whether we need to show advanced search options a.k.a. filters?""" show = self.request.get('advanced_search', None) if not show or show == 'False': return False return True def advanced_search_trigger(self): """URL builder for show/close advanced search filters.""" query = self.request.get('QUERY_STRING', None) url = self.request.get('ACTUAL_URL', self.context.absolute_url()) if not query: return url if 'advanced_search' in query: if 'advanced_search=True' in query: query = query.replace('advanced_search=True', '') if 'advanced_search=False' in query: query = query.replace('advanced_search=False', '') else: query = query + '&advanced_search=True' return url + '?' + query def breadcrumbs(self, item): obj = item.getObject() view = getMultiAdapter((obj, self.request), name='breadcrumbs_view') # cut off the item itself breadcrumbs = list(view.breadcrumbs())[:-1] if len(breadcrumbs) == 0: # don't show breadcrumbs if we only have a single element return None if len(breadcrumbs) > 3: # if we have too long breadcrumbs, emit the middle elements empty = {'absolute_url': '', 'Title': unicode('…', 'utf-8')} breadcrumbs = [breadcrumbs[0], empty] + breadcrumbs[-2:] return breadcrumbs def navroot_url(self): if not hasattr(self, '_navroot_url'): state = self.context.unrestrictedTraverse('@@plone_portal_state') self._navroot_url = state.navigation_root_url() return self._navroot_url class SortOption(object): def __init__(self, request, title, sortkey='', reverse=False): self.request = request self.title = title self.sortkey = sortkey self.reverse = reverse def selected(self): sort_on = self.request.get('sort_on', '') return sort_on == self.sortkey def url(self): q = {} q.update(self.request.form) if 'sort_on' in q.keys(): del q['sort_on'] if 'sort_order' in q.keys(): del q['sort_order'] q['sort_on'] = self.sortkey if self.reverse: q['sort_order'] = 'reverse' base_url = self.request.URL # After the AJAX call the request is changed and thus the URL part of # it as well. In this case we need to tweak the URL to point to have # correct URLs if '@@updated_search' in base_url: base_url = base_url.replace('@@updated_search', '@@search') return base_url + '?' + make_query(q)