view MoinMoin/macro/ @ 5887:b397401dda7f

fix typos, correct is: 'occurred'
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Wed, 19 Sep 2012 11:29:46 +0200
parents 8e5559a0a08b
line wrap: on
line source

# -*- coding: iso-8859-1 -*-
    MoinMoin - FullSearch Macro

        displays a search dialog, as it always did.

        does the same as clicking on the page title, only that
        the result is embedded into the page. note the '()' after
        the macro name, which is an empty argument list.

        embeds a search result into a page, as if you entered
        'Help' into the search box.

    The macro creates a page list without context or match info, just
    like PageList macro. It does not make sense to have context in non
    interactive search, and this kind of search is used usually for
    Category pages, where we don't care about the context.

    TODO: If we need to have context for some cases, either we add a context argument,
          or make another macro that uses context, which may be easier to use.

    @copyright: 2000-2004 Juergen Hermann <>,
                2006 MoinMoin:FranzPletz
    @license: GNU GPL, see COPYING for details.

from MoinMoin import wikiutil, search

Dependencies = ["pages"]

def search_box(type, macro):
    """ Make a search box

    Make both Title Search and Full Search boxes, according to type.

    @param type: search box type: 'titlesearch' or 'fullsearch'
    @rtype: unicode
    @return: search box html fragment
    _ = macro._
    if 'value' in macro.request.values:
        default = wikiutil.escape(macro.request.values["value"], quote=1)
        default = ''

    # Title search settings
    boxes = ''
    button = _("Search Titles")

    # Special code for fullsearch
    if type == "fullsearch":
        boxes = [
            u'<input type="checkbox" name="context" value="160" checked="checked">',
            _('Display context of search results'),
            u'<input type="checkbox" name="case" value="1">',
            _('Case-sensitive searching'),
        boxes = u'\n'.join(boxes)
        button = _("Search Text")

    # Format
    type = (type == "titlesearch")
    html = [
        u'<form method="get" action="%s">' % macro.request.href(,
        u'<input type="hidden" name="action" value="fullsearch">',
        u'<input type="hidden" name="titlesearch" value="%i">' % type,
        u'<input type="text" name="value" size="30" value="%s">' % default,
        u'<input type="submit" value="%s">' % button,
    html = u'\n'.join(html)
    return macro.formatter.rawHTML(html)

def execute(macro, needle, titlesearch=False, case=False):
    request = macro.request
    _ = request.getText

    # if no args given, invoke "classic" behavior
    if needle is None:
        return search_box("fullsearch", macro)

    highlight_titles = getattr(request.cfg, "search_macro_highlight_titles", 1)
    highlight_pages = getattr(request.cfg, "search_macro_highlight_pages", 1)

    err = None
    # It is needed because otherwise macro instances like
    # <<FullSearch(..., highlight=1)>> (which found occurrences of "...," and
    # "highlight=1" before the change) begin behaving differently.
    if getattr(request.cfg, "search_macro_parse_args", False):
        needle_found = False

        # parse_quoted_separated() is used instead of rsplit() and such for
        # proper parsing cases like FullSearch(",") and so.
        args = wikiutil.parse_quoted_separated_ext(needle,

        # First non-tuple item in resulting list to be needle
        for arg in args:
            if isinstance(arg, tuple):
                val = arg[1].lower() in [u'1', u'true', u'y']
                if arg[0] == u"highlight_pages":
                    highlight_pages = val
                elif arg[0] == u"highlight_titles":
                    highlight_titles = val
                    err = _(u"Unknown macro parameter: %s.") % arg[0]
            elif isinstance(arg, basestring):
                if not needle_found:
                    needle_found = True
                    needle = arg
                    err = _(u"More than one needle with "
                             "search_macro_parse_args config option enabled "
                             "('%(needle)s' found already, '%(arg)s' occurred)"
                             ) % {'needle': wikiutil.escape(needle),
                                  'arg': wikiutil.escape(arg)}

        if not needle_found:
            needle = ''

    # With empty arguments, simulate title click (backlinks to page)
    if needle == '' and not titlesearch:
        needle = u'"%s"' %

    # With whitespace argument, show error message like the one used in the search box
    # TODO: search should implement those errors message for clients
    elif not needle.strip():
        err = _(u'Please use a more selective search term instead of '
                '{{{"%s"}}}', wiki=True) % needle

    if err:
        return u'<span class="error">%s</span>' % err

    needle = needle.strip()

    # Search the pages and return the results
        results = search.searchPages(request, needle, titlesearch=titlesearch,
                                     case=case, sort='page_name')

        ret = results.pageList(request, macro.formatter, paging=False,
            highlight_titles=highlight_titles, highlight_pages=highlight_pages)

    except ValueError:
        # same error as in MoinMoin/action/, keep it that way!
        ret = ''.join([macro.formatter.text(u'<<%s(' %,
                      _(u'Your search query {{{"%s"}}} is invalid. Please refer '
                        'to HelpOnSearching for more information.', wiki=True,
                        percent=True) % wikiutil.escape(needle),

    return ret