paul@0 | 1 | # -*- coding: iso-8859-1 -*- |
paul@0 | 2 | """ |
paul@0 | 3 | MoinMoin - MoinSupport library (derived from EventAggregatorSupport) |
paul@0 | 4 | |
paul@36 | 5 | @copyright: 2008, 2009, 2010, 2011, 2012, 2013 by Paul Boddie <paul@boddie.org.uk> |
paul@0 | 6 | @copyright: 2000-2004 Juergen Hermann <jh@web.de>, |
paul@0 | 7 | 2005-2008 MoinMoin:ThomasWaldmann. |
paul@0 | 8 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@0 | 9 | """ |
paul@0 | 10 | |
paul@0 | 11 | from DateSupport import * |
paul@1 | 12 | from MoinMoin.Page import Page |
paul@25 | 13 | from MoinMoin import config, search, wikiutil |
paul@10 | 14 | from StringIO import StringIO |
paul@10 | 15 | from shlex import shlex |
paul@0 | 16 | import re |
paul@0 | 17 | import time |
paul@0 | 18 | |
paul@35 | 19 | # Moin 1.9 request parameters. |
paul@35 | 20 | |
paul@35 | 21 | try: |
paul@35 | 22 | from MoinMoin.support.werkzeug.datastructures import MultiDict |
paul@35 | 23 | except ImportError: |
paul@35 | 24 | pass |
paul@35 | 25 | |
paul@10 | 26 | __version__ = "0.2" |
paul@0 | 27 | |
paul@25 | 28 | # Extraction of shared fragments. |
paul@25 | 29 | |
paul@25 | 30 | marker_regexp_str = r"([{]{3,}|[}]{3,})" |
paul@25 | 31 | marker_regexp = re.compile(marker_regexp_str, re.MULTILINE | re.DOTALL) # {{{... or }}}... |
paul@25 | 32 | |
paul@29 | 33 | # Extraction of headings. |
paul@29 | 34 | |
paul@29 | 35 | heading_regexp = re.compile(r"^(?P<level>=+)(?P<heading>.*?)(?P=level)$", re.UNICODE | re.MULTILINE) |
paul@29 | 36 | |
paul@25 | 37 | # Category extraction from pages. |
paul@25 | 38 | |
paul@25 | 39 | category_regexp = None |
paul@25 | 40 | |
paul@25 | 41 | # Simple content parsing. |
paul@25 | 42 | |
paul@25 | 43 | verbatim_regexp = re.compile(ur'(?:' |
paul@25 | 44 | ur'<<Verbatim\((?P<verbatim>.*?)\)>>' |
paul@25 | 45 | ur'|' |
paul@25 | 46 | ur'\[\[Verbatim\((?P<verbatim2>.*?)\)\]\]' |
paul@25 | 47 | ur'|' |
paul@25 | 48 | ur'!(?P<verbatim3>.*?)(\s|$)?' |
paul@25 | 49 | ur'|' |
paul@25 | 50 | ur'`(?P<monospace>.*?)`' |
paul@25 | 51 | ur'|' |
paul@25 | 52 | ur'{{{(?P<preformatted>.*?)}}}' |
paul@25 | 53 | ur')', re.UNICODE) |
paul@25 | 54 | |
paul@25 | 55 | # Category discovery. |
paul@0 | 56 | |
paul@25 | 57 | def getCategoryPattern(request): |
paul@25 | 58 | global category_regexp |
paul@25 | 59 | |
paul@25 | 60 | try: |
paul@25 | 61 | return request.cfg.cache.page_category_regexact |
paul@25 | 62 | except AttributeError: |
paul@25 | 63 | |
paul@25 | 64 | # Use regular expression from MoinMoin 1.7.1 otherwise. |
paul@25 | 65 | |
paul@25 | 66 | if category_regexp is None: |
paul@25 | 67 | category_regexp = re.compile(u'^%s$' % ur'(?P<all>Category(?P<key>(?!Template)\S+))', re.UNICODE) |
paul@25 | 68 | return category_regexp |
paul@25 | 69 | |
paul@25 | 70 | def getCategories(request): |
paul@25 | 71 | |
paul@25 | 72 | """ |
paul@25 | 73 | From the AdvancedSearch macro, return a list of category page names using |
paul@25 | 74 | the given 'request'. |
paul@25 | 75 | """ |
paul@25 | 76 | |
paul@25 | 77 | # This will return all pages with "Category" in the title. |
paul@25 | 78 | |
paul@25 | 79 | cat_filter = getCategoryPattern(request).search |
paul@25 | 80 | return request.rootpage.getPageList(filter=cat_filter) |
paul@25 | 81 | |
paul@25 | 82 | def getCategoryMapping(category_pagenames, request): |
paul@2 | 83 | |
paul@2 | 84 | """ |
paul@25 | 85 | For the given 'category_pagenames' return a list of tuples of the form |
paul@25 | 86 | (category name, category page name) using the given 'request'. |
paul@25 | 87 | """ |
paul@25 | 88 | |
paul@25 | 89 | cat_pattern = getCategoryPattern(request) |
paul@25 | 90 | mapping = [] |
paul@25 | 91 | for pagename in category_pagenames: |
paul@25 | 92 | name = cat_pattern.match(pagename).group("key") |
paul@25 | 93 | if name != "Category": |
paul@25 | 94 | mapping.append((name, pagename)) |
paul@25 | 95 | mapping.sort() |
paul@25 | 96 | return mapping |
paul@25 | 97 | |
paul@25 | 98 | def getCategoryPages(pagename, request): |
paul@25 | 99 | |
paul@25 | 100 | """ |
paul@25 | 101 | Return the pages associated with the given category 'pagename' using the |
paul@25 | 102 | 'request'. |
paul@25 | 103 | """ |
paul@25 | 104 | |
paul@25 | 105 | query = search.QueryParser().parse_query('category:%s' % pagename) |
paul@25 | 106 | results = search.searchPages(request, query, "page_name") |
paul@27 | 107 | return filterCategoryPages(results, request) |
paul@27 | 108 | |
paul@27 | 109 | def filterCategoryPages(results, request): |
paul@27 | 110 | |
paul@27 | 111 | "Filter category pages from the given 'results' using the 'request'." |
paul@25 | 112 | |
paul@25 | 113 | cat_pattern = getCategoryPattern(request) |
paul@25 | 114 | pages = [] |
paul@25 | 115 | for page in results.hits: |
paul@25 | 116 | if not cat_pattern.match(page.page_name): |
paul@25 | 117 | pages.append(page) |
paul@25 | 118 | return pages |
paul@25 | 119 | |
paul@25 | 120 | def getAllCategoryPages(category_names, request): |
paul@25 | 121 | |
paul@25 | 122 | """ |
paul@25 | 123 | Return all pages belonging to the categories having the given |
paul@25 | 124 | 'category_names', using the given 'request'. |
paul@25 | 125 | """ |
paul@25 | 126 | |
paul@25 | 127 | pages = [] |
paul@25 | 128 | pagenames = set() |
paul@25 | 129 | |
paul@25 | 130 | for category_name in category_names: |
paul@25 | 131 | |
paul@25 | 132 | # Get the pages and page names in the category. |
paul@25 | 133 | |
paul@25 | 134 | pages_in_category = getCategoryPages(category_name, request) |
paul@25 | 135 | |
paul@25 | 136 | # Visit each page in the category. |
paul@25 | 137 | |
paul@25 | 138 | for page_in_category in pages_in_category: |
paul@25 | 139 | pagename = page_in_category.page_name |
paul@25 | 140 | |
paul@25 | 141 | # Only process each page once. |
paul@25 | 142 | |
paul@25 | 143 | if pagename in pagenames: |
paul@25 | 144 | continue |
paul@25 | 145 | else: |
paul@25 | 146 | pagenames.add(pagename) |
paul@25 | 147 | |
paul@25 | 148 | pages.append(page_in_category) |
paul@25 | 149 | |
paul@25 | 150 | return pages |
paul@25 | 151 | |
paul@28 | 152 | def getPagesForSearch(search_pattern, request): |
paul@27 | 153 | |
paul@27 | 154 | """ |
paul@27 | 155 | Return result pages for a search employing the given 'search_pattern' and |
paul@28 | 156 | using the given 'request'. |
paul@27 | 157 | """ |
paul@27 | 158 | |
paul@27 | 159 | query = search.QueryParser().parse_query(search_pattern) |
paul@27 | 160 | results = search.searchPages(request, query, "page_name") |
paul@27 | 161 | return filterCategoryPages(results, request) |
paul@27 | 162 | |
paul@25 | 163 | # WikiDict functions. |
paul@25 | 164 | |
paul@25 | 165 | def getWikiDict(pagename, request): |
paul@25 | 166 | |
paul@25 | 167 | """ |
paul@25 | 168 | Return the WikiDict provided by the given 'pagename' using the given |
paul@25 | 169 | 'request'. |
paul@2 | 170 | """ |
paul@2 | 171 | |
paul@25 | 172 | if pagename and Page(request, pagename).exists() and request.user.may.read(pagename): |
paul@25 | 173 | if hasattr(request.dicts, "dict"): |
paul@25 | 174 | return request.dicts.dict(pagename) |
paul@25 | 175 | else: |
paul@25 | 176 | return request.dicts[pagename] |
paul@0 | 177 | else: |
paul@25 | 178 | return None |
paul@25 | 179 | |
paul@25 | 180 | # Searching-related functions. |
paul@25 | 181 | |
paul@25 | 182 | def getPagesFromResults(result_pages, request): |
paul@25 | 183 | |
paul@25 | 184 | "Return genuine pages for the given 'result_pages' using the 'request'." |
paul@25 | 185 | |
paul@25 | 186 | return [Page(request, page.page_name) for page in result_pages] |
paul@25 | 187 | |
paul@25 | 188 | # Region/section parsing. |
paul@25 | 189 | |
paul@25 | 190 | def getRegions(s, include_non_regions=False): |
paul@25 | 191 | |
paul@25 | 192 | """ |
paul@25 | 193 | Parse the string 's', returning a list of explicitly declared regions. |
paul@25 | 194 | |
paul@25 | 195 | If 'include_non_regions' is specified as a true value, fragments will be |
paul@25 | 196 | included for text between explicitly declared regions. |
paul@25 | 197 | """ |
paul@25 | 198 | |
paul@25 | 199 | regions = [] |
paul@25 | 200 | marker = None |
paul@25 | 201 | is_block = True |
paul@25 | 202 | |
paul@25 | 203 | # Start a region for exposed text, if appropriate. |
paul@25 | 204 | |
paul@25 | 205 | if include_non_regions: |
paul@25 | 206 | regions.append("") |
paul@25 | 207 | |
paul@25 | 208 | for match_text in marker_regexp.split(s): |
paul@25 | 209 | |
paul@25 | 210 | # Capture section text. |
paul@25 | 211 | |
paul@25 | 212 | if is_block: |
paul@25 | 213 | if marker or include_non_regions: |
paul@25 | 214 | regions[-1] += match_text |
paul@25 | 215 | |
paul@25 | 216 | # Handle section markers. |
paul@25 | 217 | |
paul@31 | 218 | else: |
paul@25 | 219 | |
paul@25 | 220 | # Close any open sections, returning to exposed text regions. |
paul@25 | 221 | |
paul@25 | 222 | if marker: |
paul@31 | 223 | |
paul@31 | 224 | # Add any marker to the current region, regardless of whether it |
paul@31 | 225 | # successfully closes a section. |
paul@31 | 226 | |
paul@31 | 227 | regions[-1] += match_text |
paul@31 | 228 | |
paul@25 | 229 | if match_text.startswith("}") and len(marker) == len(match_text): |
paul@25 | 230 | marker = None |
paul@25 | 231 | |
paul@25 | 232 | # Start a region for exposed text, if appropriate. |
paul@25 | 233 | |
paul@25 | 234 | if include_non_regions: |
paul@25 | 235 | regions.append("") |
paul@25 | 236 | |
paul@31 | 237 | # Without a current marker, start a new section. |
paul@25 | 238 | |
paul@31 | 239 | else: |
paul@25 | 240 | marker = match_text |
paul@25 | 241 | regions.append("") |
paul@25 | 242 | |
paul@31 | 243 | # Add the marker to the new region. |
paul@25 | 244 | |
paul@31 | 245 | regions[-1] += match_text |
paul@0 | 246 | |
paul@25 | 247 | # The match text alternates between text between markers and the markers |
paul@25 | 248 | # themselves. |
paul@25 | 249 | |
paul@25 | 250 | is_block = not is_block |
paul@25 | 251 | |
paul@25 | 252 | return regions |
paul@25 | 253 | |
paul@25 | 254 | def getFragmentsFromRegions(regions): |
paul@25 | 255 | |
paul@25 | 256 | """ |
paul@25 | 257 | Return fragments from the given 'regions', each having the form |
paul@32 | 258 | (format, attributes, body text). |
paul@25 | 259 | """ |
paul@25 | 260 | |
paul@25 | 261 | fragments = [] |
paul@25 | 262 | |
paul@25 | 263 | for region in regions: |
paul@32 | 264 | format, attributes, body, header, close = getFragmentFromRegion(region) |
paul@32 | 265 | fragments.append((format, attributes, body)) |
paul@25 | 266 | |
paul@32 | 267 | return fragments |
paul@25 | 268 | |
paul@32 | 269 | def getFragmentFromRegion(region): |
paul@25 | 270 | |
paul@32 | 271 | """ |
paul@32 | 272 | Return a fragment for the given 'region' having the form (format, |
paul@32 | 273 | attributes, body text, header, close), where the 'header' is the original |
paul@32 | 274 | declaration of the 'region' or None if no explicit region is defined, and |
paul@32 | 275 | 'close' is the closing marker of the 'region' or None if no explicit region |
paul@32 | 276 | is defined. |
paul@32 | 277 | """ |
paul@25 | 278 | |
paul@32 | 279 | if region.startswith("{{{"): |
paul@25 | 280 | |
paul@32 | 281 | body = region.lstrip("{") |
paul@32 | 282 | level = len(region) - len(body) |
paul@32 | 283 | body = body.rstrip("}").lstrip() |
paul@32 | 284 | |
paul@32 | 285 | # Remove any prelude and process metadata. |
paul@32 | 286 | |
paul@32 | 287 | if body.startswith("#!"): |
paul@25 | 288 | |
paul@32 | 289 | try: |
paul@32 | 290 | declaration, body = body.split("\n", 1) |
paul@32 | 291 | except ValueError: |
paul@32 | 292 | declaration = body |
paul@32 | 293 | body = "" |
paul@25 | 294 | |
paul@32 | 295 | arguments = declaration[2:] |
paul@32 | 296 | |
paul@32 | 297 | # Get any parser/format declaration. |
paul@25 | 298 | |
paul@32 | 299 | if arguments and not arguments[0].isspace(): |
paul@32 | 300 | details = arguments.split(None, 1) |
paul@32 | 301 | if len(details) == 2: |
paul@32 | 302 | format, arguments = details |
paul@32 | 303 | else: |
paul@32 | 304 | format = details[0] |
paul@32 | 305 | arguments = "" |
paul@32 | 306 | else: |
paul@32 | 307 | format = None |
paul@25 | 308 | |
paul@32 | 309 | # Get the attributes/arguments for the region. |
paul@32 | 310 | |
paul@32 | 311 | attributes = parseAttributes(arguments, False) |
paul@25 | 312 | |
paul@32 | 313 | # Add an entry for the format in the attribute dictionary. |
paul@25 | 314 | |
paul@32 | 315 | if format and not attributes.has_key(format): |
paul@32 | 316 | attributes[format] = True |
paul@32 | 317 | |
paul@32 | 318 | return format, attributes, body, level * "{" + declaration + "\n", level * "}" |
paul@25 | 319 | |
paul@25 | 320 | else: |
paul@32 | 321 | return None, {}, body, level * "{" + "\n", level * "}" |
paul@25 | 322 | |
paul@32 | 323 | else: |
paul@32 | 324 | return None, {}, region, None, None |
paul@25 | 325 | |
paul@25 | 326 | def getFragments(s, include_non_regions=False): |
paul@25 | 327 | |
paul@25 | 328 | """ |
paul@25 | 329 | Return fragments for the given string 's', each having the form |
paul@25 | 330 | (format, arguments, body text). |
paul@25 | 331 | |
paul@25 | 332 | If 'include_non_regions' is specified as a true value, fragments will be |
paul@25 | 333 | included for text between explicitly declared regions. |
paul@25 | 334 | """ |
paul@25 | 335 | |
paul@25 | 336 | return getFragmentsFromRegions(getRegions(s, include_non_regions)) |
paul@25 | 337 | |
paul@29 | 338 | # Heading extraction. |
paul@29 | 339 | |
paul@29 | 340 | def getHeadings(s): |
paul@29 | 341 | |
paul@29 | 342 | """ |
paul@29 | 343 | Return tuples of the form (level, title, span) for headings found within the |
paul@29 | 344 | given string 's'. The span is itself a (start, end) tuple indicating the |
paul@29 | 345 | matching region of 's' for a heading declaration. |
paul@29 | 346 | """ |
paul@29 | 347 | |
paul@29 | 348 | headings = [] |
paul@29 | 349 | |
paul@29 | 350 | for match in heading_regexp.finditer(s): |
paul@29 | 351 | headings.append( |
paul@29 | 352 | (len(match.group("level")), match.group("heading"), match.span()) |
paul@29 | 353 | ) |
paul@29 | 354 | |
paul@29 | 355 | return headings |
paul@29 | 356 | |
paul@25 | 357 | # Region/section attribute parsing. |
paul@0 | 358 | |
paul@10 | 359 | def parseAttributes(s, escape=True): |
paul@10 | 360 | |
paul@10 | 361 | """ |
paul@10 | 362 | Parse the section attributes string 's', returning a mapping of names to |
paul@10 | 363 | values. If 'escape' is set to a true value, the attributes will be suitable |
paul@10 | 364 | for use with the formatter API. If 'escape' is set to a false value, the |
paul@10 | 365 | attributes will have any quoting removed. |
paul@10 | 366 | """ |
paul@10 | 367 | |
paul@10 | 368 | attrs = {} |
paul@10 | 369 | f = StringIO(s) |
paul@10 | 370 | name = None |
paul@10 | 371 | need_value = False |
paul@34 | 372 | lex = shlex(f) |
paul@34 | 373 | lex.wordchars += "-" |
paul@10 | 374 | |
paul@34 | 375 | for token in lex: |
paul@10 | 376 | |
paul@10 | 377 | # Capture the name if needed. |
paul@10 | 378 | |
paul@10 | 379 | if name is None: |
paul@10 | 380 | name = escape and wikiutil.escape(token) or strip_token(token) |
paul@10 | 381 | |
paul@10 | 382 | # Detect either an equals sign or another name. |
paul@10 | 383 | |
paul@10 | 384 | elif not need_value: |
paul@10 | 385 | if token == "=": |
paul@10 | 386 | need_value = True |
paul@10 | 387 | else: |
paul@10 | 388 | attrs[name.lower()] = escape and "true" or True |
paul@10 | 389 | name = wikiutil.escape(token) |
paul@10 | 390 | |
paul@10 | 391 | # Otherwise, capture a value. |
paul@10 | 392 | |
paul@10 | 393 | else: |
paul@10 | 394 | # Quoting of attributes done similarly to wikiutil.parseAttributes. |
paul@10 | 395 | |
paul@10 | 396 | if token: |
paul@10 | 397 | if escape: |
paul@10 | 398 | if token[0] in ("'", '"'): |
paul@10 | 399 | token = wikiutil.escape(token) |
paul@10 | 400 | else: |
paul@10 | 401 | token = '"%s"' % wikiutil.escape(token, 1) |
paul@10 | 402 | else: |
paul@10 | 403 | token = strip_token(token) |
paul@10 | 404 | |
paul@10 | 405 | attrs[name.lower()] = token |
paul@10 | 406 | name = None |
paul@10 | 407 | need_value = False |
paul@10 | 408 | |
paul@13 | 409 | # Handle any name-only attributes at the end of the collection. |
paul@13 | 410 | |
paul@13 | 411 | if name and not need_value: |
paul@13 | 412 | attrs[name.lower()] = escape and "true" or True |
paul@13 | 413 | |
paul@10 | 414 | return attrs |
paul@10 | 415 | |
paul@10 | 416 | def strip_token(token): |
paul@10 | 417 | |
paul@10 | 418 | "Return the given 'token' stripped of quoting." |
paul@10 | 419 | |
paul@10 | 420 | if token[0] in ("'", '"') and token[-1] == token[0]: |
paul@10 | 421 | return token[1:-1] |
paul@10 | 422 | else: |
paul@10 | 423 | return token |
paul@10 | 424 | |
paul@25 | 425 | # Request-related classes and associated functions. |
paul@0 | 426 | |
paul@0 | 427 | class Form: |
paul@0 | 428 | |
paul@0 | 429 | """ |
paul@0 | 430 | A wrapper preserving MoinMoin 1.8.x (and earlier) behaviour in a 1.9.x |
paul@0 | 431 | environment. |
paul@0 | 432 | """ |
paul@0 | 433 | |
paul@35 | 434 | def __init__(self, request): |
paul@35 | 435 | self.request = request |
paul@35 | 436 | self.form = request.values |
paul@0 | 437 | |
paul@0 | 438 | def has_key(self, name): |
paul@0 | 439 | return not not self.form.getlist(name) |
paul@0 | 440 | |
paul@0 | 441 | def get(self, name, default=None): |
paul@0 | 442 | values = self.form.getlist(name) |
paul@0 | 443 | if not values: |
paul@0 | 444 | return default |
paul@0 | 445 | else: |
paul@0 | 446 | return values |
paul@0 | 447 | |
paul@0 | 448 | def __getitem__(self, name): |
paul@0 | 449 | return self.form.getlist(name) |
paul@0 | 450 | |
paul@35 | 451 | def __setitem__(self, name, value): |
paul@35 | 452 | try: |
paul@35 | 453 | self.form.setlist(name, value) |
paul@35 | 454 | except TypeError: |
paul@35 | 455 | self._write_enable() |
paul@35 | 456 | self.form.setlist(name, value) |
paul@35 | 457 | |
paul@33 | 458 | def __delitem__(self, name): |
paul@35 | 459 | try: |
paul@35 | 460 | del self.form[name] |
paul@35 | 461 | except TypeError: |
paul@35 | 462 | self._write_enable() |
paul@35 | 463 | del self.form[name] |
paul@35 | 464 | |
paul@35 | 465 | def _write_enable(self): |
paul@35 | 466 | self.form = self.request.values = MultiDict(self.form) |
paul@33 | 467 | |
paul@33 | 468 | def keys(self): |
paul@33 | 469 | return self.form.keys() |
paul@33 | 470 | |
paul@32 | 471 | def items(self): |
paul@35 | 472 | return self.form.lists() |
paul@32 | 473 | |
paul@0 | 474 | class ActionSupport: |
paul@0 | 475 | |
paul@0 | 476 | """ |
paul@0 | 477 | Work around disruptive MoinMoin changes in 1.9, and also provide useful |
paul@0 | 478 | convenience methods. |
paul@0 | 479 | """ |
paul@0 | 480 | |
paul@0 | 481 | def get_form(self): |
paul@0 | 482 | return get_form(self.request) |
paul@0 | 483 | |
paul@0 | 484 | def _get_selected(self, value, input_value): |
paul@0 | 485 | |
paul@0 | 486 | """ |
paul@0 | 487 | Return the HTML attribute text indicating selection of an option (or |
paul@0 | 488 | otherwise) if 'value' matches 'input_value'. |
paul@0 | 489 | """ |
paul@0 | 490 | |
paul@0 | 491 | return input_value is not None and value == input_value and 'selected="selected"' or '' |
paul@0 | 492 | |
paul@0 | 493 | def _get_selected_for_list(self, value, input_values): |
paul@0 | 494 | |
paul@0 | 495 | """ |
paul@0 | 496 | Return the HTML attribute text indicating selection of an option (or |
paul@0 | 497 | otherwise) if 'value' matches one of the 'input_values'. |
paul@0 | 498 | """ |
paul@0 | 499 | |
paul@0 | 500 | return value in input_values and 'selected="selected"' or '' |
paul@0 | 501 | |
paul@26 | 502 | def get_option_list(self, value, values): |
paul@26 | 503 | |
paul@26 | 504 | """ |
paul@26 | 505 | Return a list of HTML element definitions for options describing the |
paul@26 | 506 | given 'values', selecting the option with the specified 'value' if |
paul@26 | 507 | present. |
paul@26 | 508 | """ |
paul@26 | 509 | |
paul@26 | 510 | options = [] |
paul@26 | 511 | for available_value in values: |
paul@26 | 512 | selected = self._get_selected(available_value, value) |
paul@26 | 513 | options.append('<option value="%s" %s>%s</option>' % ( |
paul@26 | 514 | escattr(available_value), selected, wikiutil.escape(available_value))) |
paul@26 | 515 | return options |
paul@26 | 516 | |
paul@0 | 517 | def _get_input(self, form, name, default=None): |
paul@0 | 518 | |
paul@0 | 519 | """ |
paul@0 | 520 | Return the input from 'form' having the given 'name', returning either |
paul@0 | 521 | the input converted to an integer or the given 'default' (optional, None |
paul@0 | 522 | if not specified). |
paul@0 | 523 | """ |
paul@0 | 524 | |
paul@0 | 525 | value = form.get(name, [None])[0] |
paul@0 | 526 | if not value: # true if 0 obtained |
paul@0 | 527 | return default |
paul@0 | 528 | else: |
paul@0 | 529 | return int(value) |
paul@0 | 530 | |
paul@0 | 531 | def get_form(request): |
paul@0 | 532 | |
paul@0 | 533 | "Work around disruptive MoinMoin changes in 1.9." |
paul@0 | 534 | |
paul@0 | 535 | if hasattr(request, "values"): |
paul@35 | 536 | return Form(request) |
paul@0 | 537 | else: |
paul@0 | 538 | return request.form |
paul@0 | 539 | |
paul@0 | 540 | class send_headers_cls: |
paul@0 | 541 | |
paul@0 | 542 | """ |
paul@0 | 543 | A wrapper to preserve MoinMoin 1.8.x (and earlier) request behaviour in a |
paul@0 | 544 | 1.9.x environment. |
paul@0 | 545 | """ |
paul@0 | 546 | |
paul@0 | 547 | def __init__(self, request): |
paul@0 | 548 | self.request = request |
paul@0 | 549 | |
paul@0 | 550 | def __call__(self, headers): |
paul@0 | 551 | for header in headers: |
paul@0 | 552 | parts = header.split(":") |
paul@0 | 553 | self.request.headers.add(parts[0], ":".join(parts[1:])) |
paul@0 | 554 | |
paul@0 | 555 | def get_send_headers(request): |
paul@0 | 556 | |
paul@0 | 557 | "Return a function that can send response headers." |
paul@0 | 558 | |
paul@0 | 559 | if hasattr(request, "http_headers"): |
paul@0 | 560 | return request.http_headers |
paul@0 | 561 | elif hasattr(request, "emit_http_headers"): |
paul@0 | 562 | return request.emit_http_headers |
paul@0 | 563 | else: |
paul@0 | 564 | return send_headers_cls(request) |
paul@0 | 565 | |
paul@0 | 566 | def escattr(s): |
paul@0 | 567 | return wikiutil.escape(s, 1) |
paul@0 | 568 | |
paul@0 | 569 | def getPathInfo(request): |
paul@0 | 570 | if hasattr(request, "getPathinfo"): |
paul@0 | 571 | return request.getPathinfo() |
paul@0 | 572 | else: |
paul@0 | 573 | return request.path |
paul@0 | 574 | |
paul@14 | 575 | def getHeader(request, header_name, prefix=None): |
paul@17 | 576 | |
paul@17 | 577 | """ |
paul@17 | 578 | Using the 'request', return the value of the header with the given |
paul@17 | 579 | 'header_name', using the optional 'prefix' to obtain protocol-specific |
paul@17 | 580 | headers if necessary. |
paul@17 | 581 | |
paul@17 | 582 | If no value is found for the given 'header_name', None is returned. |
paul@17 | 583 | """ |
paul@17 | 584 | |
paul@14 | 585 | if hasattr(request, "getHeader"): |
paul@14 | 586 | return request.getHeader(header_name) |
paul@14 | 587 | elif hasattr(request, "headers"): |
paul@17 | 588 | return request.headers.get(header_name) |
paul@14 | 589 | else: |
paul@17 | 590 | return request.env.get((prefix and prefix + "_" or "") + header_name.upper()) |
paul@14 | 591 | |
paul@23 | 592 | def writeHeaders(request, mimetype, metadata, status=None): |
paul@23 | 593 | |
paul@23 | 594 | """ |
paul@23 | 595 | Using the 'request', write resource headers using the given 'mimetype', |
paul@23 | 596 | based on the given 'metadata'. If the optional 'status' is specified, set |
paul@23 | 597 | the status header to the given value. |
paul@23 | 598 | """ |
paul@23 | 599 | |
paul@23 | 600 | send_headers = get_send_headers(request) |
paul@23 | 601 | |
paul@23 | 602 | # Define headers. |
paul@23 | 603 | |
paul@23 | 604 | headers = ["Content-Type: %s; charset=%s" % (mimetype, config.charset)] |
paul@23 | 605 | |
paul@23 | 606 | # Define the last modified time. |
paul@23 | 607 | # NOTE: Consider using request.httpDate. |
paul@23 | 608 | |
paul@23 | 609 | latest_timestamp = metadata.get("last-modified") |
paul@23 | 610 | if latest_timestamp: |
paul@23 | 611 | headers.append("Last-Modified: %s" % latest_timestamp.as_HTTP_datetime_string()) |
paul@23 | 612 | |
paul@23 | 613 | if status: |
paul@23 | 614 | headers.append("Status: %s" % status) |
paul@23 | 615 | |
paul@23 | 616 | send_headers(headers) |
paul@23 | 617 | |
paul@1 | 618 | # Page access functions. |
paul@1 | 619 | |
paul@1 | 620 | def getPageURL(page): |
paul@1 | 621 | |
paul@1 | 622 | "Return the URL of the given 'page'." |
paul@1 | 623 | |
paul@1 | 624 | request = page.request |
paul@1 | 625 | return request.getQualifiedURL(page.url(request, relative=0)) |
paul@1 | 626 | |
paul@1 | 627 | def getFormat(page): |
paul@1 | 628 | |
paul@1 | 629 | "Get the format used on the given 'page'." |
paul@1 | 630 | |
paul@1 | 631 | return page.pi["format"] |
paul@1 | 632 | |
paul@1 | 633 | def getMetadata(page): |
paul@1 | 634 | |
paul@1 | 635 | """ |
paul@1 | 636 | Return a dictionary containing items describing for the given 'page' the |
paul@1 | 637 | page's "created" time, "last-modified" time, "sequence" (or revision number) |
paul@1 | 638 | and the "last-comment" made about the last edit. |
paul@1 | 639 | """ |
paul@1 | 640 | |
paul@1 | 641 | request = page.request |
paul@1 | 642 | |
paul@1 | 643 | # Get the initial revision of the page. |
paul@1 | 644 | |
paul@1 | 645 | revisions = page.getRevList() |
paul@26 | 646 | |
paul@26 | 647 | if not revisions: |
paul@26 | 648 | return {} |
paul@26 | 649 | |
paul@1 | 650 | event_page_initial = Page(request, page.page_name, rev=revisions[-1]) |
paul@1 | 651 | |
paul@1 | 652 | # Get the created and last modified times. |
paul@1 | 653 | |
paul@1 | 654 | initial_revision = getPageRevision(event_page_initial) |
paul@1 | 655 | |
paul@1 | 656 | metadata = {} |
paul@1 | 657 | metadata["created"] = initial_revision["timestamp"] |
paul@1 | 658 | latest_revision = getPageRevision(page) |
paul@1 | 659 | metadata["last-modified"] = latest_revision["timestamp"] |
paul@1 | 660 | metadata["sequence"] = len(revisions) - 1 |
paul@1 | 661 | metadata["last-comment"] = latest_revision["comment"] |
paul@1 | 662 | |
paul@1 | 663 | return metadata |
paul@0 | 664 | |
paul@0 | 665 | def getPageRevision(page): |
paul@0 | 666 | |
paul@0 | 667 | "Return the revision details dictionary for the given 'page'." |
paul@0 | 668 | |
paul@0 | 669 | # From Page.edit_info... |
paul@0 | 670 | |
paul@0 | 671 | if hasattr(page, "editlog_entry"): |
paul@0 | 672 | line = page.editlog_entry() |
paul@0 | 673 | else: |
paul@0 | 674 | line = page._last_edited(page.request) # MoinMoin 1.5.x and 1.6.x |
paul@0 | 675 | |
paul@0 | 676 | # Similar to Page.mtime_usecs behaviour... |
paul@0 | 677 | |
paul@0 | 678 | if line: |
paul@0 | 679 | timestamp = line.ed_time_usecs |
paul@0 | 680 | mtime = wikiutil.version2timestamp(long(timestamp)) # must be long for py 2.2.x |
paul@0 | 681 | comment = line.comment |
paul@0 | 682 | else: |
paul@0 | 683 | mtime = 0 |
paul@0 | 684 | comment = "" |
paul@0 | 685 | |
paul@0 | 686 | # Leave the time zone empty. |
paul@0 | 687 | |
paul@0 | 688 | return {"timestamp" : DateTime(time.gmtime(mtime)[:6] + (None,)), "comment" : comment} |
paul@0 | 689 | |
paul@11 | 690 | # Page parsing and formatting of embedded content. |
paul@11 | 691 | |
paul@15 | 692 | def getPageParserClass(request): |
paul@15 | 693 | |
paul@15 | 694 | "Using 'request', return a parser class for the current page's format." |
paul@15 | 695 | |
paul@16 | 696 | return getParserClass(request, getFormat(request.page)) |
paul@15 | 697 | |
paul@11 | 698 | def getParserClass(request, format): |
paul@11 | 699 | |
paul@11 | 700 | """ |
paul@11 | 701 | Return a parser class using the 'request' for the given 'format', returning |
paul@11 | 702 | a plain text parser if no parser can be found for the specified 'format'. |
paul@11 | 703 | """ |
paul@11 | 704 | |
paul@11 | 705 | try: |
paul@11 | 706 | return wikiutil.searchAndImportPlugin(request.cfg, "parser", format or "plain") |
paul@11 | 707 | except wikiutil.PluginMissingError: |
paul@11 | 708 | return wikiutil.searchAndImportPlugin(request.cfg, "parser", "plain") |
paul@11 | 709 | |
paul@15 | 710 | def getFormatterClass(request, format): |
paul@15 | 711 | |
paul@15 | 712 | """ |
paul@15 | 713 | Return a formatter class using the 'request' for the given output 'format', |
paul@15 | 714 | returning a plain text formatter if no formatter can be found for the |
paul@15 | 715 | specified 'format'. |
paul@15 | 716 | """ |
paul@15 | 717 | |
paul@15 | 718 | try: |
paul@15 | 719 | return wikiutil.searchAndImportPlugin(request.cfg, "formatter", format or "plain") |
paul@15 | 720 | except wikiutil.PluginMissingError: |
paul@15 | 721 | return wikiutil.searchAndImportPlugin(request.cfg, "formatter", "plain") |
paul@15 | 722 | |
paul@33 | 723 | def formatText(text, request, fmt, inhibit_p=True, parser_cls=None): |
paul@15 | 724 | |
paul@15 | 725 | """ |
paul@15 | 726 | Format the given 'text' using the specified 'request' and formatter 'fmt'. |
paul@15 | 727 | Suppress line anchors in the output, and fix lists by indicating that a |
paul@15 | 728 | paragraph has already been started. |
paul@15 | 729 | """ |
paul@15 | 730 | |
paul@15 | 731 | if not parser_cls: |
paul@15 | 732 | parser_cls = getPageParserClass(request) |
paul@15 | 733 | parser = parser_cls(text, request, line_anchors=False) |
paul@15 | 734 | |
paul@15 | 735 | old_fmt = request.formatter |
paul@15 | 736 | request.formatter = fmt |
paul@15 | 737 | try: |
paul@33 | 738 | return redirectedOutput(request, parser, fmt, inhibit_p=inhibit_p) |
paul@15 | 739 | finally: |
paul@15 | 740 | request.formatter = old_fmt |
paul@15 | 741 | |
paul@11 | 742 | def redirectedOutput(request, parser, fmt, **kw): |
paul@11 | 743 | |
paul@11 | 744 | "A fixed version of the request method of the same name." |
paul@11 | 745 | |
paul@11 | 746 | buf = StringIO() |
paul@11 | 747 | request.redirect(buf) |
paul@11 | 748 | try: |
paul@11 | 749 | parser.format(fmt, **kw) |
paul@11 | 750 | if hasattr(fmt, "flush"): |
paul@11 | 751 | buf.write(fmt.flush(True)) |
paul@11 | 752 | finally: |
paul@11 | 753 | request.redirect() |
paul@11 | 754 | text = buf.getvalue() |
paul@11 | 755 | buf.close() |
paul@11 | 756 | return text |
paul@11 | 757 | |
paul@25 | 758 | # Textual representations. |
paul@25 | 759 | |
paul@25 | 760 | def getSimpleWikiText(text): |
paul@25 | 761 | |
paul@25 | 762 | """ |
paul@25 | 763 | Return the plain text representation of the given 'text' which may employ |
paul@25 | 764 | certain Wiki syntax features, such as those providing verbatim or monospaced |
paul@25 | 765 | text. |
paul@25 | 766 | """ |
paul@25 | 767 | |
paul@25 | 768 | # NOTE: Re-implementing support for verbatim text and linking avoidance. |
paul@25 | 769 | |
paul@25 | 770 | return "".join([s for s in verbatim_regexp.split(text) if s is not None]) |
paul@25 | 771 | |
paul@25 | 772 | def getEncodedWikiText(text): |
paul@25 | 773 | |
paul@25 | 774 | "Encode the given 'text' in a verbatim representation." |
paul@25 | 775 | |
paul@25 | 776 | return "<<Verbatim(%s)>>" % text |
paul@25 | 777 | |
paul@25 | 778 | def getPrettyTitle(title): |
paul@25 | 779 | |
paul@25 | 780 | "Return a nicely formatted version of the given 'title'." |
paul@25 | 781 | |
paul@25 | 782 | return title.replace("_", " ").replace("/", u" ? ") |
paul@25 | 783 | |
paul@0 | 784 | # User interface functions. |
paul@0 | 785 | |
paul@0 | 786 | def getParameter(request, name, default=None): |
paul@0 | 787 | |
paul@0 | 788 | """ |
paul@0 | 789 | Using the given 'request', return the value of the parameter with the given |
paul@0 | 790 | 'name', returning the optional 'default' (or None) if no value was supplied |
paul@0 | 791 | in the 'request'. |
paul@0 | 792 | """ |
paul@0 | 793 | |
paul@0 | 794 | return get_form(request).get(name, [default])[0] |
paul@0 | 795 | |
paul@0 | 796 | def getQualifiedParameter(request, prefix, argname, default=None): |
paul@0 | 797 | |
paul@0 | 798 | """ |
paul@0 | 799 | Using the given 'request', 'prefix' and 'argname', retrieve the value of the |
paul@0 | 800 | qualified parameter, returning the optional 'default' (or None) if no value |
paul@0 | 801 | was supplied in the 'request'. |
paul@0 | 802 | """ |
paul@0 | 803 | |
paul@0 | 804 | argname = getQualifiedParameterName(prefix, argname) |
paul@0 | 805 | return getParameter(request, argname, default) |
paul@0 | 806 | |
paul@0 | 807 | def getQualifiedParameterName(prefix, argname): |
paul@0 | 808 | |
paul@0 | 809 | """ |
paul@0 | 810 | Return the qualified parameter name using the given 'prefix' and 'argname'. |
paul@0 | 811 | """ |
paul@0 | 812 | |
paul@27 | 813 | if not prefix: |
paul@0 | 814 | return argname |
paul@0 | 815 | else: |
paul@0 | 816 | return "%s-%s" % (prefix, argname) |
paul@0 | 817 | |
paul@0 | 818 | # Page-related functions. |
paul@0 | 819 | |
paul@0 | 820 | def getPrettyPageName(page): |
paul@0 | 821 | |
paul@0 | 822 | "Return a nicely formatted title/name for the given 'page'." |
paul@0 | 823 | |
paul@0 | 824 | title = page.split_title(force=1) |
paul@0 | 825 | return getPrettyTitle(title) |
paul@0 | 826 | |
paul@25 | 827 | def linkToPage(request, page, text, query_string=None, anchor=None, **kw): |
paul@0 | 828 | |
paul@0 | 829 | """ |
paul@0 | 830 | Using 'request', return a link to 'page' with the given link 'text' and |
paul@25 | 831 | optional 'query_string' and 'anchor'. |
paul@0 | 832 | """ |
paul@0 | 833 | |
paul@0 | 834 | text = wikiutil.escape(text) |
paul@25 | 835 | return page.link_to_raw(request, text, query_string, anchor, **kw) |
paul@0 | 836 | |
paul@25 | 837 | def linkToResource(url, request, text, query_string=None, anchor=None): |
paul@0 | 838 | |
paul@0 | 839 | """ |
paul@0 | 840 | Using 'request', return a link to 'url' with the given link 'text' and |
paul@25 | 841 | optional 'query_string' and 'anchor'. |
paul@0 | 842 | """ |
paul@0 | 843 | |
paul@25 | 844 | if anchor: |
paul@25 | 845 | url += "#%s" % anchor |
paul@25 | 846 | |
paul@0 | 847 | if query_string: |
paul@0 | 848 | query_string = wikiutil.makeQueryString(query_string) |
paul@25 | 849 | url += "?%s" % query_string |
paul@0 | 850 | |
paul@0 | 851 | formatter = request.page and getattr(request.page, "formatter", None) or request.html_formatter |
paul@0 | 852 | |
paul@0 | 853 | output = [] |
paul@0 | 854 | output.append(formatter.url(1, url)) |
paul@0 | 855 | output.append(formatter.text(text)) |
paul@0 | 856 | output.append(formatter.url(0)) |
paul@0 | 857 | return "".join(output) |
paul@0 | 858 | |
paul@0 | 859 | def getFullPageName(parent, title): |
paul@0 | 860 | |
paul@0 | 861 | """ |
paul@0 | 862 | Return a full page name from the given 'parent' page (can be empty or None) |
paul@0 | 863 | and 'title' (a simple page name). |
paul@0 | 864 | """ |
paul@0 | 865 | |
paul@0 | 866 | if parent: |
paul@0 | 867 | return "%s/%s" % (parent.rstrip("/"), title) |
paul@0 | 868 | else: |
paul@0 | 869 | return title |
paul@0 | 870 | |
paul@0 | 871 | # vim: tabstop=4 expandtab shiftwidth=4 |