paul@0 | 1 | # -*- coding: iso-8859-1 -*- |
paul@0 | 2 | """ |
paul@0 | 3 | MoinMoin - ImprovedMoinSearch library |
paul@0 | 4 | |
paul@0 | 5 | @copyright: 2010 Paul Boddie <paul@boddie.org.uk> |
paul@0 | 6 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@0 | 7 | """ |
paul@0 | 8 | |
paul@0 | 9 | from MoinMoin.search import searchPages |
paul@0 | 10 | from MoinMoin.Page import Page |
paul@1 | 11 | from MoinMoin import wikiutil |
paul@0 | 12 | import re |
paul@0 | 13 | |
paul@0 | 14 | heading_regexp = re.compile(r"^(?P<level>=+)(?P<heading>.*?)(?P=level)$", re.UNICODE | re.MULTILINE) |
paul@0 | 15 | heading_options_regexp = re.compile(r"heading\s*(?P<min>\d+)?(?:\s*-\s*(?P<max>\d+))?", re.UNICODE) |
paul@0 | 16 | |
paul@0 | 17 | def getSearchResultPages(request, query, **kw): |
paul@0 | 18 | |
paul@0 | 19 | """ |
paul@0 | 20 | Return matching pages using the given 'request' and search 'query'. Optional |
paul@0 | 21 | keyword arguments are passed to the underlying search infrastructure. |
paul@0 | 22 | """ |
paul@0 | 23 | |
paul@0 | 24 | results = searchPages(request, query, **kw) |
paul@0 | 25 | return results.hits |
paul@0 | 26 | |
paul@0 | 27 | def getFirstPageHeading(request, page, min_level=1, max_level=1): |
paul@0 | 28 | |
paul@0 | 29 | """ |
paul@0 | 30 | Using the given 'request', return the first heading in the given 'page' |
paul@0 | 31 | having a heading level of at least 'min_level' (which is 1 if not specified) |
paul@0 | 32 | and at most 'max_level' (which is 1 if not specified). |
paul@0 | 33 | """ |
paul@0 | 34 | |
paul@0 | 35 | full_page = Page(request, page.page_name) |
paul@0 | 36 | body = full_page.get_raw_body() |
paul@0 | 37 | |
paul@0 | 38 | for match in heading_regexp.finditer(body): |
paul@0 | 39 | level = len(match.group("level")) |
paul@0 | 40 | |
paul@0 | 41 | if (min_level is None or level >= min_level) and \ |
paul@0 | 42 | (max_level is None or level <= max_level): |
paul@0 | 43 | |
paul@0 | 44 | return match.group("heading") |
paul@0 | 45 | |
paul@0 | 46 | return None |
paul@0 | 47 | |
paul@1 | 48 | def formatResultPages(request, formatter, pages, paging, format, page_from=0): |
paul@0 | 49 | |
paul@0 | 50 | """ |
paul@0 | 51 | Using the given 'request' and 'formatter', return a formatted string showing |
paul@0 | 52 | the result 'pages', providing paging controls when 'paging' is set to a true |
paul@0 | 53 | value, and providing page details according to the given 'format'. |
paul@1 | 54 | |
paul@1 | 55 | If the optional 'pages_from' parameter is set, the result pages from the |
paul@1 | 56 | given result (specified within a range from 0 to the length of the 'pages' |
paul@1 | 57 | collection) will be shown. |
paul@0 | 58 | """ |
paul@0 | 59 | |
paul@1 | 60 | if format: |
paul@1 | 61 | m = heading_options_regexp.search(format) |
paul@1 | 62 | else: |
paul@1 | 63 | m = None |
paul@1 | 64 | |
paul@0 | 65 | if m: |
paul@0 | 66 | format = "heading" |
paul@0 | 67 | min_level = int_or_none(m.group("min")) |
paul@0 | 68 | max_level = int_or_none(m.group("max")) |
paul@0 | 69 | else: |
paul@0 | 70 | format = "name" |
paul@0 | 71 | |
paul@1 | 72 | # Use paging only when there are enough results. |
paul@1 | 73 | |
paul@1 | 74 | results_per_page = request.cfg.search_results_per_page |
paul@1 | 75 | paging = paging and len(pages) > results_per_page |
paul@1 | 76 | |
paul@1 | 77 | if paging: |
paul@1 | 78 | pages_to_show = pages[page_from:page_from + results_per_page] |
paul@1 | 79 | else: |
paul@1 | 80 | pages_to_show = pages |
paul@1 | 81 | |
paul@1 | 82 | # Prepare the output. |
paul@1 | 83 | |
paul@0 | 84 | output = [] |
paul@2 | 85 | output.append(formatter.number_list(on=1, start=page_from + 1)) |
paul@0 | 86 | |
paul@1 | 87 | for page in pages_to_show: |
paul@0 | 88 | output.append(formatter.listitem(on=1)) |
paul@0 | 89 | |
paul@0 | 90 | if format == "heading": |
paul@0 | 91 | text = getFirstPageHeading(request, page, min_level, max_level) or page.page_name |
paul@0 | 92 | else: |
paul@0 | 93 | text = page.page_name |
paul@0 | 94 | |
paul@0 | 95 | output.append(formatter.pagelink(on=1, pagename=page.page_name)) |
paul@0 | 96 | output.append(formatter.text(text)) |
paul@0 | 97 | output.append(formatter.pagelink(on=0)) |
paul@0 | 98 | output.append(formatter.listitem(on=0)) |
paul@0 | 99 | |
paul@0 | 100 | output.append(formatter.number_list(on=0)) |
paul@0 | 101 | |
paul@1 | 102 | # Show paging navigation. |
paul@1 | 103 | |
paul@1 | 104 | if paging: |
paul@1 | 105 | output.append(formatPagingNavigation(request, formatter, pages, page_from)) |
paul@1 | 106 | |
paul@0 | 107 | return "".join(output) |
paul@0 | 108 | |
paul@1 | 109 | def formatPagingNavigation(request, formatter, pages, page_from=0): |
paul@1 | 110 | |
paul@1 | 111 | """ |
paul@1 | 112 | Using the given 'request' and 'formatter', return a formatted string showing |
paul@1 | 113 | the paging navigation for the result 'pages', according to the 'page_from' |
paul@1 | 114 | indicator which provides the current position in the result set. |
paul@1 | 115 | """ |
paul@1 | 116 | |
paul@2 | 117 | page = formatter.page |
paul@2 | 118 | pagename = page.page_name |
paul@1 | 119 | _ = request.getText |
paul@1 | 120 | |
paul@1 | 121 | output = [] |
paul@1 | 122 | |
paul@1 | 123 | results_per_page = request.cfg.search_results_per_page |
paul@1 | 124 | number_of_results = len(pages) |
paul@1 | 125 | |
paul@1 | 126 | pages_total = number_of_results / results_per_page |
paul@1 | 127 | pages_before = page_from / results_per_page |
paul@1 | 128 | pages_after = ((number_of_results - page_from) / results_per_page) - 1 |
paul@1 | 129 | |
paul@1 | 130 | querydict = wikiutil.parseQueryString(request.query_string) |
paul@1 | 131 | |
paul@1 | 132 | output.append(formatter.paragraph(on=1)) |
paul@1 | 133 | output.append(formatter.text(_("Result pages:"))) |
paul@1 | 134 | output.append(formatter.text(" ")) |
paul@1 | 135 | |
paul@1 | 136 | n = 0 |
paul@1 | 137 | while n < pages_before: |
paul@2 | 138 | output.append(formatter.pagelink(on=1, pagename=pagename, querystr=getPagingQueryString(querydict, n * results_per_page))) |
paul@1 | 139 | output.append(formatter.text(str(n + 1))) |
paul@1 | 140 | output.append(formatter.pagelink(on=0)) |
paul@1 | 141 | output.append(formatter.text(" ")) |
paul@1 | 142 | n += 1 |
paul@1 | 143 | |
paul@1 | 144 | output.append(formatter.text(str(n + 1))) |
paul@1 | 145 | output.append(formatter.text(" ")) |
paul@1 | 146 | n += 1 |
paul@1 | 147 | |
paul@2 | 148 | while n <= pages_total: |
paul@2 | 149 | output.append(formatter.pagelink(on=1, pagename=pagename, querystr=getPagingQueryString(querydict, n * results_per_page))) |
paul@1 | 150 | output.append(formatter.text(str(n + 1))) |
paul@1 | 151 | output.append(formatter.pagelink(on=0)) |
paul@1 | 152 | output.append(formatter.text(" ")) |
paul@1 | 153 | n += 1 |
paul@1 | 154 | |
paul@1 | 155 | output.append(formatter.paragraph(on=0)) |
paul@1 | 156 | |
paul@1 | 157 | return "".join(output) |
paul@1 | 158 | |
paul@1 | 159 | def getPagingQueryString(querydict, page_from): |
paul@1 | 160 | querydict["from"] = page_from |
paul@1 | 161 | return wikiutil.makeQueryString(querydict) |
paul@1 | 162 | |
paul@0 | 163 | def int_or_none(x): |
paul@0 | 164 | if x is None: |
paul@0 | 165 | return x |
paul@0 | 166 | else: |
paul@0 | 167 | return int(x) |
paul@0 | 168 | |
paul@0 | 169 | # vim: tabstop=4 expandtab shiftwidth=4 |