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@65 | 6 | @copyright: 2000-2004 Juergen Hermann <jh@web.de> |
paul@65 | 7 | 2004 by Florian Festi |
paul@65 | 8 | 2006 by Mikko Virkkil |
paul@65 | 9 | 2005-2008 MoinMoin:ThomasWaldmann |
paul@65 | 10 | 2007 MoinMoin:ReimarBauer |
paul@65 | 11 | 2008 MoinMoin:FlorianKrupicka (redirectedOutput code) |
paul@0 | 12 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@0 | 13 | """ |
paul@0 | 14 | |
paul@0 | 15 | from DateSupport import * |
paul@58 | 16 | from MoinMoin.parser import text_moin_wiki |
paul@95 | 17 | from MoinMoin.Page import Page |
paul@25 | 18 | from MoinMoin import config, search, wikiutil |
paul@10 | 19 | from shlex import shlex |
paul@0 | 20 | import re |
paul@0 | 21 | import time |
paul@37 | 22 | import os |
paul@66 | 23 | import codecs |
paul@66 | 24 | |
paul@66 | 25 | try: |
paul@66 | 26 | from cStringIO import StringIO |
paul@66 | 27 | except ImportError: |
paul@66 | 28 | from StringIO import StringIO |
paul@0 | 29 | |
paul@35 | 30 | # Moin 1.9 request parameters. |
paul@35 | 31 | |
paul@35 | 32 | try: |
paul@35 | 33 | from MoinMoin.support.werkzeug.datastructures import MultiDict |
paul@35 | 34 | except ImportError: |
paul@35 | 35 | pass |
paul@35 | 36 | |
paul@95 | 37 | __version__ = "0.4.2" |
paul@0 | 38 | |
paul@25 | 39 | # Extraction of shared fragments. |
paul@25 | 40 | |
paul@25 | 41 | marker_regexp_str = r"([{]{3,}|[}]{3,})" |
paul@25 | 42 | marker_regexp = re.compile(marker_regexp_str, re.MULTILINE | re.DOTALL) # {{{... or }}}... |
paul@25 | 43 | |
paul@29 | 44 | # Extraction of headings. |
paul@29 | 45 | |
paul@29 | 46 | heading_regexp = re.compile(r"^(?P<level>=+)(?P<heading>.*?)(?P=level)$", re.UNICODE | re.MULTILINE) |
paul@29 | 47 | |
paul@25 | 48 | # Category extraction from pages. |
paul@25 | 49 | |
paul@25 | 50 | category_regexp = None |
paul@25 | 51 | |
paul@25 | 52 | # Simple content parsing. |
paul@25 | 53 | |
paul@25 | 54 | verbatim_regexp = re.compile(ur'(?:' |
paul@25 | 55 | ur'<<Verbatim\((?P<verbatim>.*?)\)>>' |
paul@25 | 56 | ur'|' |
paul@25 | 57 | ur'\[\[Verbatim\((?P<verbatim2>.*?)\)\]\]' |
paul@25 | 58 | ur'|' |
paul@25 | 59 | ur'!(?P<verbatim3>.*?)(\s|$)?' |
paul@25 | 60 | ur'|' |
paul@25 | 61 | ur'`(?P<monospace>.*?)`' |
paul@25 | 62 | ur'|' |
paul@25 | 63 | ur'{{{(?P<preformatted>.*?)}}}' |
paul@25 | 64 | ur')', re.UNICODE) |
paul@25 | 65 | |
paul@25 | 66 | # Category discovery. |
paul@0 | 67 | |
paul@25 | 68 | def getCategoryPattern(request): |
paul@25 | 69 | global category_regexp |
paul@25 | 70 | |
paul@25 | 71 | try: |
paul@25 | 72 | return request.cfg.cache.page_category_regexact |
paul@25 | 73 | except AttributeError: |
paul@25 | 74 | |
paul@25 | 75 | # Use regular expression from MoinMoin 1.7.1 otherwise. |
paul@25 | 76 | |
paul@25 | 77 | if category_regexp is None: |
paul@25 | 78 | category_regexp = re.compile(u'^%s$' % ur'(?P<all>Category(?P<key>(?!Template)\S+))', re.UNICODE) |
paul@25 | 79 | return category_regexp |
paul@25 | 80 | |
paul@25 | 81 | def getCategories(request): |
paul@25 | 82 | |
paul@25 | 83 | """ |
paul@25 | 84 | From the AdvancedSearch macro, return a list of category page names using |
paul@25 | 85 | the given 'request'. |
paul@25 | 86 | """ |
paul@25 | 87 | |
paul@25 | 88 | # This will return all pages with "Category" in the title. |
paul@25 | 89 | |
paul@25 | 90 | cat_filter = getCategoryPattern(request).search |
paul@25 | 91 | return request.rootpage.getPageList(filter=cat_filter) |
paul@25 | 92 | |
paul@25 | 93 | def getCategoryMapping(category_pagenames, request): |
paul@2 | 94 | |
paul@2 | 95 | """ |
paul@25 | 96 | For the given 'category_pagenames' return a list of tuples of the form |
paul@25 | 97 | (category name, category page name) using the given 'request'. |
paul@25 | 98 | """ |
paul@25 | 99 | |
paul@25 | 100 | cat_pattern = getCategoryPattern(request) |
paul@25 | 101 | mapping = [] |
paul@25 | 102 | for pagename in category_pagenames: |
paul@25 | 103 | name = cat_pattern.match(pagename).group("key") |
paul@25 | 104 | if name != "Category": |
paul@25 | 105 | mapping.append((name, pagename)) |
paul@25 | 106 | mapping.sort() |
paul@25 | 107 | return mapping |
paul@25 | 108 | |
paul@25 | 109 | def getCategoryPages(pagename, request): |
paul@25 | 110 | |
paul@25 | 111 | """ |
paul@25 | 112 | Return the pages associated with the given category 'pagename' using the |
paul@25 | 113 | 'request'. |
paul@25 | 114 | """ |
paul@25 | 115 | |
paul@25 | 116 | query = search.QueryParser().parse_query('category:%s' % pagename) |
paul@25 | 117 | results = search.searchPages(request, query, "page_name") |
paul@27 | 118 | return filterCategoryPages(results, request) |
paul@27 | 119 | |
paul@27 | 120 | def filterCategoryPages(results, request): |
paul@27 | 121 | |
paul@27 | 122 | "Filter category pages from the given 'results' using the 'request'." |
paul@25 | 123 | |
paul@25 | 124 | cat_pattern = getCategoryPattern(request) |
paul@25 | 125 | pages = [] |
paul@25 | 126 | for page in results.hits: |
paul@25 | 127 | if not cat_pattern.match(page.page_name): |
paul@25 | 128 | pages.append(page) |
paul@25 | 129 | return pages |
paul@25 | 130 | |
paul@25 | 131 | def getAllCategoryPages(category_names, request): |
paul@25 | 132 | |
paul@25 | 133 | """ |
paul@25 | 134 | Return all pages belonging to the categories having the given |
paul@25 | 135 | 'category_names', using the given 'request'. |
paul@25 | 136 | """ |
paul@25 | 137 | |
paul@25 | 138 | pages = [] |
paul@25 | 139 | pagenames = set() |
paul@25 | 140 | |
paul@25 | 141 | for category_name in category_names: |
paul@25 | 142 | |
paul@25 | 143 | # Get the pages and page names in the category. |
paul@25 | 144 | |
paul@25 | 145 | pages_in_category = getCategoryPages(category_name, request) |
paul@25 | 146 | |
paul@25 | 147 | # Visit each page in the category. |
paul@25 | 148 | |
paul@25 | 149 | for page_in_category in pages_in_category: |
paul@25 | 150 | pagename = page_in_category.page_name |
paul@25 | 151 | |
paul@25 | 152 | # Only process each page once. |
paul@25 | 153 | |
paul@25 | 154 | if pagename in pagenames: |
paul@25 | 155 | continue |
paul@25 | 156 | else: |
paul@25 | 157 | pagenames.add(pagename) |
paul@25 | 158 | |
paul@25 | 159 | pages.append(page_in_category) |
paul@25 | 160 | |
paul@25 | 161 | return pages |
paul@25 | 162 | |
paul@28 | 163 | def getPagesForSearch(search_pattern, request): |
paul@27 | 164 | |
paul@27 | 165 | """ |
paul@27 | 166 | Return result pages for a search employing the given 'search_pattern' and |
paul@28 | 167 | using the given 'request'. |
paul@27 | 168 | """ |
paul@27 | 169 | |
paul@27 | 170 | query = search.QueryParser().parse_query(search_pattern) |
paul@27 | 171 | results = search.searchPages(request, query, "page_name") |
paul@27 | 172 | return filterCategoryPages(results, request) |
paul@27 | 173 | |
paul@25 | 174 | # WikiDict functions. |
paul@25 | 175 | |
paul@64 | 176 | def getWikiDict(pagename, request, superuser=False): |
paul@25 | 177 | |
paul@25 | 178 | """ |
paul@25 | 179 | Return the WikiDict provided by the given 'pagename' using the given |
paul@64 | 180 | 'request'. If the optional 'superuser' is specified as a true value, no read |
paul@64 | 181 | access check will be made. |
paul@2 | 182 | """ |
paul@2 | 183 | |
paul@64 | 184 | if pagename and Page(request, pagename).exists() and (superuser or request.user.may.read(pagename)): |
paul@25 | 185 | if hasattr(request.dicts, "dict"): |
paul@25 | 186 | return request.dicts.dict(pagename) |
paul@25 | 187 | else: |
paul@25 | 188 | return request.dicts[pagename] |
paul@0 | 189 | else: |
paul@25 | 190 | return None |
paul@25 | 191 | |
paul@25 | 192 | # Searching-related functions. |
paul@25 | 193 | |
paul@25 | 194 | def getPagesFromResults(result_pages, request): |
paul@25 | 195 | |
paul@25 | 196 | "Return genuine pages for the given 'result_pages' using the 'request'." |
paul@25 | 197 | |
paul@25 | 198 | return [Page(request, page.page_name) for page in result_pages] |
paul@25 | 199 | |
paul@25 | 200 | # Region/section parsing. |
paul@25 | 201 | |
paul@25 | 202 | def getRegions(s, include_non_regions=False): |
paul@25 | 203 | |
paul@25 | 204 | """ |
paul@25 | 205 | Parse the string 's', returning a list of explicitly declared regions. |
paul@25 | 206 | |
paul@25 | 207 | If 'include_non_regions' is specified as a true value, fragments will be |
paul@25 | 208 | included for text between explicitly declared regions. |
paul@25 | 209 | """ |
paul@25 | 210 | |
paul@25 | 211 | regions = [] |
paul@25 | 212 | marker = None |
paul@25 | 213 | is_block = True |
paul@25 | 214 | |
paul@25 | 215 | # Start a region for exposed text, if appropriate. |
paul@25 | 216 | |
paul@25 | 217 | if include_non_regions: |
paul@25 | 218 | regions.append("") |
paul@25 | 219 | |
paul@25 | 220 | for match_text in marker_regexp.split(s): |
paul@25 | 221 | |
paul@25 | 222 | # Capture section text. |
paul@25 | 223 | |
paul@25 | 224 | if is_block: |
paul@25 | 225 | if marker or include_non_regions: |
paul@25 | 226 | regions[-1] += match_text |
paul@25 | 227 | |
paul@25 | 228 | # Handle section markers. |
paul@25 | 229 | |
paul@31 | 230 | else: |
paul@25 | 231 | |
paul@25 | 232 | # Close any open sections, returning to exposed text regions. |
paul@25 | 233 | |
paul@25 | 234 | if marker: |
paul@31 | 235 | |
paul@31 | 236 | # Add any marker to the current region, regardless of whether it |
paul@31 | 237 | # successfully closes a section. |
paul@31 | 238 | |
paul@31 | 239 | regions[-1] += match_text |
paul@31 | 240 | |
paul@25 | 241 | if match_text.startswith("}") and len(marker) == len(match_text): |
paul@25 | 242 | marker = None |
paul@25 | 243 | |
paul@25 | 244 | # Start a region for exposed text, if appropriate. |
paul@25 | 245 | |
paul@25 | 246 | if include_non_regions: |
paul@25 | 247 | regions.append("") |
paul@25 | 248 | |
paul@31 | 249 | # Without a current marker, start a new section. |
paul@25 | 250 | |
paul@31 | 251 | else: |
paul@25 | 252 | marker = match_text |
paul@25 | 253 | regions.append("") |
paul@25 | 254 | |
paul@31 | 255 | # Add the marker to the new region. |
paul@25 | 256 | |
paul@31 | 257 | regions[-1] += match_text |
paul@0 | 258 | |
paul@25 | 259 | # The match text alternates between text between markers and the markers |
paul@25 | 260 | # themselves. |
paul@25 | 261 | |
paul@25 | 262 | is_block = not is_block |
paul@25 | 263 | |
paul@25 | 264 | return regions |
paul@25 | 265 | |
paul@25 | 266 | def getFragmentsFromRegions(regions): |
paul@25 | 267 | |
paul@25 | 268 | """ |
paul@25 | 269 | Return fragments from the given 'regions', each having the form |
paul@32 | 270 | (format, attributes, body text). |
paul@25 | 271 | """ |
paul@25 | 272 | |
paul@25 | 273 | fragments = [] |
paul@25 | 274 | |
paul@25 | 275 | for region in regions: |
paul@32 | 276 | format, attributes, body, header, close = getFragmentFromRegion(region) |
paul@32 | 277 | fragments.append((format, attributes, body)) |
paul@25 | 278 | |
paul@32 | 279 | return fragments |
paul@25 | 280 | |
paul@32 | 281 | def getFragmentFromRegion(region): |
paul@25 | 282 | |
paul@32 | 283 | """ |
paul@32 | 284 | Return a fragment for the given 'region' having the form (format, |
paul@32 | 285 | attributes, body text, header, close), where the 'header' is the original |
paul@32 | 286 | declaration of the 'region' or None if no explicit region is defined, and |
paul@32 | 287 | 'close' is the closing marker of the 'region' or None if no explicit region |
paul@32 | 288 | is defined. |
paul@32 | 289 | """ |
paul@25 | 290 | |
paul@32 | 291 | if region.startswith("{{{"): |
paul@25 | 292 | |
paul@32 | 293 | body = region.lstrip("{") |
paul@32 | 294 | level = len(region) - len(body) |
paul@32 | 295 | body = body.rstrip("}").lstrip() |
paul@32 | 296 | |
paul@32 | 297 | # Remove any prelude and process metadata. |
paul@32 | 298 | |
paul@32 | 299 | if body.startswith("#!"): |
paul@25 | 300 | |
paul@32 | 301 | try: |
paul@32 | 302 | declaration, body = body.split("\n", 1) |
paul@32 | 303 | except ValueError: |
paul@32 | 304 | declaration = body |
paul@32 | 305 | body = "" |
paul@25 | 306 | |
paul@32 | 307 | arguments = declaration[2:] |
paul@32 | 308 | |
paul@32 | 309 | # Get any parser/format declaration. |
paul@25 | 310 | |
paul@32 | 311 | if arguments and not arguments[0].isspace(): |
paul@32 | 312 | details = arguments.split(None, 1) |
paul@32 | 313 | if len(details) == 2: |
paul@32 | 314 | format, arguments = details |
paul@32 | 315 | else: |
paul@32 | 316 | format = details[0] |
paul@32 | 317 | arguments = "" |
paul@32 | 318 | else: |
paul@32 | 319 | format = None |
paul@25 | 320 | |
paul@32 | 321 | # Get the attributes/arguments for the region. |
paul@32 | 322 | |
paul@32 | 323 | attributes = parseAttributes(arguments, False) |
paul@25 | 324 | |
paul@32 | 325 | # Add an entry for the format in the attribute dictionary. |
paul@25 | 326 | |
paul@32 | 327 | if format and not attributes.has_key(format): |
paul@32 | 328 | attributes[format] = True |
paul@32 | 329 | |
paul@32 | 330 | return format, attributes, body, level * "{" + declaration + "\n", level * "}" |
paul@25 | 331 | |
paul@25 | 332 | else: |
paul@32 | 333 | return None, {}, body, level * "{" + "\n", level * "}" |
paul@25 | 334 | |
paul@32 | 335 | else: |
paul@32 | 336 | return None, {}, region, None, None |
paul@25 | 337 | |
paul@25 | 338 | def getFragments(s, include_non_regions=False): |
paul@25 | 339 | |
paul@25 | 340 | """ |
paul@25 | 341 | Return fragments for the given string 's', each having the form |
paul@25 | 342 | (format, arguments, body text). |
paul@25 | 343 | |
paul@25 | 344 | If 'include_non_regions' is specified as a true value, fragments will be |
paul@25 | 345 | included for text between explicitly declared regions. |
paul@25 | 346 | """ |
paul@25 | 347 | |
paul@25 | 348 | return getFragmentsFromRegions(getRegions(s, include_non_regions)) |
paul@25 | 349 | |
paul@29 | 350 | # Heading extraction. |
paul@29 | 351 | |
paul@29 | 352 | def getHeadings(s): |
paul@29 | 353 | |
paul@29 | 354 | """ |
paul@29 | 355 | Return tuples of the form (level, title, span) for headings found within the |
paul@29 | 356 | given string 's'. The span is itself a (start, end) tuple indicating the |
paul@29 | 357 | matching region of 's' for a heading declaration. |
paul@29 | 358 | """ |
paul@29 | 359 | |
paul@29 | 360 | headings = [] |
paul@29 | 361 | |
paul@29 | 362 | for match in heading_regexp.finditer(s): |
paul@29 | 363 | headings.append( |
paul@29 | 364 | (len(match.group("level")), match.group("heading"), match.span()) |
paul@29 | 365 | ) |
paul@29 | 366 | |
paul@29 | 367 | return headings |
paul@29 | 368 | |
paul@25 | 369 | # Region/section attribute parsing. |
paul@0 | 370 | |
paul@10 | 371 | def parseAttributes(s, escape=True): |
paul@10 | 372 | |
paul@10 | 373 | """ |
paul@10 | 374 | Parse the section attributes string 's', returning a mapping of names to |
paul@10 | 375 | values. If 'escape' is set to a true value, the attributes will be suitable |
paul@10 | 376 | for use with the formatter API. If 'escape' is set to a false value, the |
paul@10 | 377 | attributes will have any quoting removed. |
paul@66 | 378 | |
paul@66 | 379 | Because Unicode was probably not around when shlex, used here to tokenise |
paul@66 | 380 | the attributes, was introduced, and since StringIO is not Unicode-capable, |
paul@66 | 381 | any non-ASCII characters should be quoted in attributes. |
paul@10 | 382 | """ |
paul@10 | 383 | |
paul@10 | 384 | attrs = {} |
paul@66 | 385 | f = StringIO(s.encode("utf-8")) |
paul@10 | 386 | name = None |
paul@10 | 387 | need_value = False |
paul@34 | 388 | lex = shlex(f) |
paul@34 | 389 | lex.wordchars += "-" |
paul@10 | 390 | |
paul@34 | 391 | for token in lex: |
paul@66 | 392 | token = unicode(token, "utf-8") |
paul@10 | 393 | |
paul@10 | 394 | # Capture the name if needed. |
paul@10 | 395 | |
paul@10 | 396 | if name is None: |
paul@10 | 397 | name = escape and wikiutil.escape(token) or strip_token(token) |
paul@10 | 398 | |
paul@10 | 399 | # Detect either an equals sign or another name. |
paul@10 | 400 | |
paul@10 | 401 | elif not need_value: |
paul@10 | 402 | if token == "=": |
paul@10 | 403 | need_value = True |
paul@10 | 404 | else: |
paul@10 | 405 | attrs[name.lower()] = escape and "true" or True |
paul@10 | 406 | name = wikiutil.escape(token) |
paul@10 | 407 | |
paul@10 | 408 | # Otherwise, capture a value. |
paul@10 | 409 | |
paul@10 | 410 | else: |
paul@10 | 411 | # Quoting of attributes done similarly to wikiutil.parseAttributes. |
paul@10 | 412 | |
paul@10 | 413 | if token: |
paul@10 | 414 | if escape: |
paul@10 | 415 | if token[0] in ("'", '"'): |
paul@10 | 416 | token = wikiutil.escape(token) |
paul@10 | 417 | else: |
paul@10 | 418 | token = '"%s"' % wikiutil.escape(token, 1) |
paul@10 | 419 | else: |
paul@10 | 420 | token = strip_token(token) |
paul@10 | 421 | |
paul@10 | 422 | attrs[name.lower()] = token |
paul@10 | 423 | name = None |
paul@10 | 424 | need_value = False |
paul@10 | 425 | |
paul@13 | 426 | # Handle any name-only attributes at the end of the collection. |
paul@13 | 427 | |
paul@13 | 428 | if name and not need_value: |
paul@13 | 429 | attrs[name.lower()] = escape and "true" or True |
paul@13 | 430 | |
paul@10 | 431 | return attrs |
paul@10 | 432 | |
paul@10 | 433 | def strip_token(token): |
paul@10 | 434 | |
paul@10 | 435 | "Return the given 'token' stripped of quoting." |
paul@10 | 436 | |
paul@10 | 437 | if token[0] in ("'", '"') and token[-1] == token[0]: |
paul@10 | 438 | return token[1:-1] |
paul@10 | 439 | else: |
paul@10 | 440 | return token |
paul@10 | 441 | |
paul@46 | 442 | # Macro argument parsing. |
paul@46 | 443 | |
paul@46 | 444 | def parseMacroArguments(args): |
paul@46 | 445 | |
paul@46 | 446 | """ |
paul@46 | 447 | Interpret the arguments. To support commas in labels, the label argument |
paul@46 | 448 | should be quoted. For example: |
paul@46 | 449 | |
paul@46 | 450 | "label=No, thanks!" |
paul@46 | 451 | """ |
paul@46 | 452 | |
paul@46 | 453 | try: |
paul@46 | 454 | parsed_args = args and wikiutil.parse_quoted_separated(args, name_value=False) or [] |
paul@46 | 455 | except AttributeError: |
paul@46 | 456 | parsed_args = args.split(",") |
paul@46 | 457 | |
paul@46 | 458 | pairs = [] |
paul@46 | 459 | for arg in parsed_args: |
paul@46 | 460 | if arg: |
paul@46 | 461 | pair = arg.split("=", 1) |
paul@46 | 462 | if len(pair) < 2: |
paul@46 | 463 | pairs.append((None, arg)) |
paul@46 | 464 | else: |
paul@46 | 465 | pairs.append(tuple(pair)) |
paul@46 | 466 | |
paul@46 | 467 | return pairs |
paul@46 | 468 | |
paul@62 | 469 | def parseDictEntry(entry, unqualified=None): |
paul@62 | 470 | |
paul@62 | 471 | """ |
paul@62 | 472 | Return the parameters specified by the given dict 'entry' string. The |
paul@62 | 473 | optional 'unqualified' parameter can be used to indicate parameters that |
paul@62 | 474 | need not be specified together with a keyword and can therefore be populated |
paul@62 | 475 | in the given order as such unqualified parameters are encountered. |
paul@62 | 476 | |
paul@62 | 477 | NOTE: This is similar to parseMacroArguments but employs space as a |
paul@62 | 478 | NOTE: separator and attempts to assign unqualified parameters. |
paul@62 | 479 | """ |
paul@62 | 480 | |
paul@62 | 481 | parameters = {} |
paul@62 | 482 | unqualified = unqualified or () |
paul@62 | 483 | |
paul@62 | 484 | try: |
paul@62 | 485 | parsed_args = entry and wikiutil.parse_quoted_separated(entry, separator=None, name_value=False) or [] |
paul@62 | 486 | except AttributeError: |
paul@62 | 487 | parsed_args = entry.split() |
paul@62 | 488 | |
paul@62 | 489 | for arg in parsed_args: |
paul@62 | 490 | try: |
paul@62 | 491 | argname, argvalue = arg.split("=", 1) |
paul@62 | 492 | |
paul@62 | 493 | # Detect unlikely parameter names. |
paul@62 | 494 | |
paul@62 | 495 | if not argname.isalpha(): |
paul@62 | 496 | raise ValueError |
paul@62 | 497 | |
paul@62 | 498 | parameters[argname] = argvalue |
paul@62 | 499 | |
paul@62 | 500 | # Unqualified parameters are assumed to be one of a recognised set. |
paul@62 | 501 | |
paul@62 | 502 | except ValueError: |
paul@62 | 503 | for argname in unqualified: |
paul@62 | 504 | if not parameters.has_key(argname): |
paul@62 | 505 | parameters[argname] = arg |
paul@62 | 506 | break |
paul@62 | 507 | |
paul@62 | 508 | return parameters |
paul@62 | 509 | |
paul@84 | 510 | # Macro argument quoting. |
paul@84 | 511 | |
paul@84 | 512 | def quoteMacroArguments(args): |
paul@84 | 513 | |
paul@84 | 514 | """ |
paul@84 | 515 | Quote the given 'args' - a collection of (name, value) tuples - returning a |
paul@84 | 516 | string containing the comma-separated, quoted arguments. |
paul@84 | 517 | """ |
paul@84 | 518 | |
paul@84 | 519 | quoted = [] |
paul@84 | 520 | |
paul@84 | 521 | for name, value in args: |
paul@84 | 522 | quoted.append(quoteMacroArgument(name, value)) |
paul@84 | 523 | |
paul@84 | 524 | return ",".join(quoted) |
paul@84 | 525 | |
paul@84 | 526 | def quoteMacroArgument(name, value): |
paul@84 | 527 | |
paul@84 | 528 | """ |
paul@84 | 529 | Quote the argument with the given 'name' (or None indicating an unnamed |
paul@84 | 530 | argument) and 'value' so that it can be used with a macro. |
paul@84 | 531 | """ |
paul@84 | 532 | |
paul@84 | 533 | value = unicode(value).replace('"', '""') |
paul@84 | 534 | if name is None: |
paul@84 | 535 | return '"%s"' % value |
paul@84 | 536 | else: |
paul@84 | 537 | return '"%s=%s"' % (name, value) |
paul@84 | 538 | |
paul@25 | 539 | # Request-related classes and associated functions. |
paul@0 | 540 | |
paul@0 | 541 | class Form: |
paul@0 | 542 | |
paul@0 | 543 | """ |
paul@0 | 544 | A wrapper preserving MoinMoin 1.8.x (and earlier) behaviour in a 1.9.x |
paul@0 | 545 | environment. |
paul@0 | 546 | """ |
paul@0 | 547 | |
paul@35 | 548 | def __init__(self, request): |
paul@35 | 549 | self.request = request |
paul@35 | 550 | self.form = request.values |
paul@0 | 551 | |
paul@0 | 552 | def has_key(self, name): |
paul@0 | 553 | return not not self.form.getlist(name) |
paul@0 | 554 | |
paul@0 | 555 | def get(self, name, default=None): |
paul@0 | 556 | values = self.form.getlist(name) |
paul@0 | 557 | if not values: |
paul@0 | 558 | return default |
paul@0 | 559 | else: |
paul@0 | 560 | return values |
paul@0 | 561 | |
paul@0 | 562 | def __getitem__(self, name): |
paul@0 | 563 | return self.form.getlist(name) |
paul@0 | 564 | |
paul@35 | 565 | def __setitem__(self, name, value): |
paul@35 | 566 | try: |
paul@35 | 567 | self.form.setlist(name, value) |
paul@35 | 568 | except TypeError: |
paul@35 | 569 | self._write_enable() |
paul@35 | 570 | self.form.setlist(name, value) |
paul@35 | 571 | |
paul@33 | 572 | def __delitem__(self, name): |
paul@35 | 573 | try: |
paul@35 | 574 | del self.form[name] |
paul@35 | 575 | except TypeError: |
paul@35 | 576 | self._write_enable() |
paul@35 | 577 | del self.form[name] |
paul@35 | 578 | |
paul@35 | 579 | def _write_enable(self): |
paul@35 | 580 | self.form = self.request.values = MultiDict(self.form) |
paul@33 | 581 | |
paul@33 | 582 | def keys(self): |
paul@33 | 583 | return self.form.keys() |
paul@33 | 584 | |
paul@32 | 585 | def items(self): |
paul@35 | 586 | return self.form.lists() |
paul@32 | 587 | |
paul@0 | 588 | class ActionSupport: |
paul@0 | 589 | |
paul@0 | 590 | """ |
paul@0 | 591 | Work around disruptive MoinMoin changes in 1.9, and also provide useful |
paul@0 | 592 | convenience methods. |
paul@0 | 593 | """ |
paul@0 | 594 | |
paul@0 | 595 | def get_form(self): |
paul@0 | 596 | return get_form(self.request) |
paul@0 | 597 | |
paul@0 | 598 | def _get_selected(self, value, input_value): |
paul@0 | 599 | |
paul@0 | 600 | """ |
paul@0 | 601 | Return the HTML attribute text indicating selection of an option (or |
paul@0 | 602 | otherwise) if 'value' matches 'input_value'. |
paul@0 | 603 | """ |
paul@0 | 604 | |
paul@0 | 605 | return input_value is not None and value == input_value and 'selected="selected"' or '' |
paul@0 | 606 | |
paul@0 | 607 | def _get_selected_for_list(self, value, input_values): |
paul@0 | 608 | |
paul@0 | 609 | """ |
paul@0 | 610 | Return the HTML attribute text indicating selection of an option (or |
paul@0 | 611 | otherwise) if 'value' matches one of the 'input_values'. |
paul@0 | 612 | """ |
paul@0 | 613 | |
paul@0 | 614 | return value in input_values and 'selected="selected"' or '' |
paul@0 | 615 | |
paul@26 | 616 | def get_option_list(self, value, values): |
paul@26 | 617 | |
paul@26 | 618 | """ |
paul@26 | 619 | Return a list of HTML element definitions for options describing the |
paul@26 | 620 | given 'values', selecting the option with the specified 'value' if |
paul@26 | 621 | present. |
paul@26 | 622 | """ |
paul@26 | 623 | |
paul@26 | 624 | options = [] |
paul@26 | 625 | for available_value in values: |
paul@26 | 626 | selected = self._get_selected(available_value, value) |
paul@26 | 627 | options.append('<option value="%s" %s>%s</option>' % ( |
paul@26 | 628 | escattr(available_value), selected, wikiutil.escape(available_value))) |
paul@26 | 629 | return options |
paul@26 | 630 | |
paul@0 | 631 | def _get_input(self, form, name, default=None): |
paul@0 | 632 | |
paul@0 | 633 | """ |
paul@0 | 634 | Return the input from 'form' having the given 'name', returning either |
paul@0 | 635 | the input converted to an integer or the given 'default' (optional, None |
paul@0 | 636 | if not specified). |
paul@0 | 637 | """ |
paul@0 | 638 | |
paul@0 | 639 | value = form.get(name, [None])[0] |
paul@0 | 640 | if not value: # true if 0 obtained |
paul@0 | 641 | return default |
paul@0 | 642 | else: |
paul@0 | 643 | return int(value) |
paul@0 | 644 | |
paul@0 | 645 | def get_form(request): |
paul@0 | 646 | |
paul@0 | 647 | "Work around disruptive MoinMoin changes in 1.9." |
paul@0 | 648 | |
paul@0 | 649 | if hasattr(request, "values"): |
paul@35 | 650 | return Form(request) |
paul@0 | 651 | else: |
paul@0 | 652 | return request.form |
paul@0 | 653 | |
paul@0 | 654 | class send_headers_cls: |
paul@0 | 655 | |
paul@0 | 656 | """ |
paul@0 | 657 | A wrapper to preserve MoinMoin 1.8.x (and earlier) request behaviour in a |
paul@0 | 658 | 1.9.x environment. |
paul@0 | 659 | """ |
paul@0 | 660 | |
paul@0 | 661 | def __init__(self, request): |
paul@0 | 662 | self.request = request |
paul@0 | 663 | |
paul@0 | 664 | def __call__(self, headers): |
paul@0 | 665 | for header in headers: |
paul@0 | 666 | parts = header.split(":") |
paul@0 | 667 | self.request.headers.add(parts[0], ":".join(parts[1:])) |
paul@0 | 668 | |
paul@0 | 669 | def get_send_headers(request): |
paul@0 | 670 | |
paul@0 | 671 | "Return a function that can send response headers." |
paul@0 | 672 | |
paul@0 | 673 | if hasattr(request, "http_headers"): |
paul@0 | 674 | return request.http_headers |
paul@0 | 675 | elif hasattr(request, "emit_http_headers"): |
paul@0 | 676 | return request.emit_http_headers |
paul@0 | 677 | else: |
paul@0 | 678 | return send_headers_cls(request) |
paul@0 | 679 | |
paul@0 | 680 | def escattr(s): |
paul@0 | 681 | return wikiutil.escape(s, 1) |
paul@0 | 682 | |
paul@0 | 683 | def getPathInfo(request): |
paul@0 | 684 | if hasattr(request, "getPathinfo"): |
paul@0 | 685 | return request.getPathinfo() |
paul@0 | 686 | else: |
paul@0 | 687 | return request.path |
paul@0 | 688 | |
paul@14 | 689 | def getHeader(request, header_name, prefix=None): |
paul@17 | 690 | |
paul@17 | 691 | """ |
paul@17 | 692 | Using the 'request', return the value of the header with the given |
paul@17 | 693 | 'header_name', using the optional 'prefix' to obtain protocol-specific |
paul@17 | 694 | headers if necessary. |
paul@17 | 695 | |
paul@17 | 696 | If no value is found for the given 'header_name', None is returned. |
paul@17 | 697 | """ |
paul@17 | 698 | |
paul@14 | 699 | if hasattr(request, "getHeader"): |
paul@14 | 700 | return request.getHeader(header_name) |
paul@14 | 701 | elif hasattr(request, "headers"): |
paul@17 | 702 | return request.headers.get(header_name) |
paul@64 | 703 | elif hasattr(request, "env"): |
paul@64 | 704 | return request.env.get((prefix and prefix + "_" or "") + header_name.upper()) |
paul@14 | 705 | else: |
paul@64 | 706 | return None |
paul@14 | 707 | |
paul@23 | 708 | def writeHeaders(request, mimetype, metadata, status=None): |
paul@23 | 709 | |
paul@23 | 710 | """ |
paul@23 | 711 | Using the 'request', write resource headers using the given 'mimetype', |
paul@23 | 712 | based on the given 'metadata'. If the optional 'status' is specified, set |
paul@23 | 713 | the status header to the given value. |
paul@23 | 714 | """ |
paul@23 | 715 | |
paul@23 | 716 | send_headers = get_send_headers(request) |
paul@23 | 717 | |
paul@23 | 718 | # Define headers. |
paul@23 | 719 | |
paul@23 | 720 | headers = ["Content-Type: %s; charset=%s" % (mimetype, config.charset)] |
paul@23 | 721 | |
paul@23 | 722 | # Define the last modified time. |
paul@23 | 723 | # NOTE: Consider using request.httpDate. |
paul@23 | 724 | |
paul@23 | 725 | latest_timestamp = metadata.get("last-modified") |
paul@23 | 726 | if latest_timestamp: |
paul@23 | 727 | headers.append("Last-Modified: %s" % latest_timestamp.as_HTTP_datetime_string()) |
paul@23 | 728 | |
paul@23 | 729 | if status: |
paul@23 | 730 | headers.append("Status: %s" % status) |
paul@23 | 731 | |
paul@23 | 732 | send_headers(headers) |
paul@23 | 733 | |
paul@1 | 734 | # Page access functions. |
paul@1 | 735 | |
paul@1 | 736 | def getPageURL(page): |
paul@1 | 737 | |
paul@1 | 738 | "Return the URL of the given 'page'." |
paul@1 | 739 | |
paul@1 | 740 | request = page.request |
paul@1 | 741 | return request.getQualifiedURL(page.url(request, relative=0)) |
paul@1 | 742 | |
paul@1 | 743 | def getFormat(page): |
paul@1 | 744 | |
paul@1 | 745 | "Get the format used on the given 'page'." |
paul@1 | 746 | |
paul@1 | 747 | return page.pi["format"] |
paul@1 | 748 | |
paul@1 | 749 | def getMetadata(page): |
paul@1 | 750 | |
paul@1 | 751 | """ |
paul@1 | 752 | Return a dictionary containing items describing for the given 'page' the |
paul@1 | 753 | page's "created" time, "last-modified" time, "sequence" (or revision number) |
paul@1 | 754 | and the "last-comment" made about the last edit. |
paul@1 | 755 | """ |
paul@1 | 756 | |
paul@1 | 757 | request = page.request |
paul@1 | 758 | |
paul@1 | 759 | # Get the initial revision of the page. |
paul@1 | 760 | |
paul@1 | 761 | revisions = page.getRevList() |
paul@26 | 762 | |
paul@26 | 763 | if not revisions: |
paul@26 | 764 | return {} |
paul@26 | 765 | |
paul@1 | 766 | event_page_initial = Page(request, page.page_name, rev=revisions[-1]) |
paul@1 | 767 | |
paul@1 | 768 | # Get the created and last modified times. |
paul@1 | 769 | |
paul@1 | 770 | initial_revision = getPageRevision(event_page_initial) |
paul@1 | 771 | |
paul@1 | 772 | metadata = {} |
paul@1 | 773 | metadata["created"] = initial_revision["timestamp"] |
paul@1 | 774 | latest_revision = getPageRevision(page) |
paul@1 | 775 | metadata["last-modified"] = latest_revision["timestamp"] |
paul@1 | 776 | metadata["sequence"] = len(revisions) - 1 |
paul@1 | 777 | metadata["last-comment"] = latest_revision["comment"] |
paul@1 | 778 | |
paul@1 | 779 | return metadata |
paul@0 | 780 | |
paul@0 | 781 | def getPageRevision(page): |
paul@0 | 782 | |
paul@0 | 783 | "Return the revision details dictionary for the given 'page'." |
paul@0 | 784 | |
paul@0 | 785 | # From Page.edit_info... |
paul@0 | 786 | |
paul@0 | 787 | if hasattr(page, "editlog_entry"): |
paul@0 | 788 | line = page.editlog_entry() |
paul@0 | 789 | else: |
paul@0 | 790 | line = page._last_edited(page.request) # MoinMoin 1.5.x and 1.6.x |
paul@0 | 791 | |
paul@0 | 792 | # Similar to Page.mtime_usecs behaviour... |
paul@0 | 793 | |
paul@0 | 794 | if line: |
paul@0 | 795 | timestamp = line.ed_time_usecs |
paul@0 | 796 | mtime = wikiutil.version2timestamp(long(timestamp)) # must be long for py 2.2.x |
paul@0 | 797 | comment = line.comment |
paul@0 | 798 | else: |
paul@0 | 799 | mtime = 0 |
paul@0 | 800 | comment = "" |
paul@0 | 801 | |
paul@56 | 802 | # Give the time zone as UTC. |
paul@0 | 803 | |
paul@56 | 804 | return {"timestamp" : DateTime(time.gmtime(mtime)[:6] + ("UTC",)), "comment" : comment} |
paul@0 | 805 | |
paul@11 | 806 | # Page parsing and formatting of embedded content. |
paul@11 | 807 | |
paul@65 | 808 | def getOutputTypes(request, format): |
paul@65 | 809 | |
paul@65 | 810 | """ |
paul@65 | 811 | Using the 'request' and the 'format' of a fragment, return the media types |
paul@65 | 812 | available for the fragment. |
paul@65 | 813 | """ |
paul@65 | 814 | |
paul@65 | 815 | return getParserOutputTypes(getParserClass(request, format)) |
paul@65 | 816 | |
paul@65 | 817 | def getParserOutputTypes(parser): |
paul@65 | 818 | |
paul@65 | 819 | "Return the media types supported by the given 'parser'." |
paul@65 | 820 | |
paul@65 | 821 | # This uses an extended parser API method if available. |
paul@65 | 822 | |
paul@65 | 823 | if parser and hasattr(parser, "getOutputTypes"): |
paul@65 | 824 | return parser.getOutputTypes() |
paul@65 | 825 | else: |
paul@65 | 826 | return ["text/html"] |
paul@65 | 827 | |
paul@15 | 828 | def getPageParserClass(request): |
paul@15 | 829 | |
paul@15 | 830 | "Using 'request', return a parser class for the current page's format." |
paul@15 | 831 | |
paul@16 | 832 | return getParserClass(request, getFormat(request.page)) |
paul@15 | 833 | |
paul@11 | 834 | def getParserClass(request, format): |
paul@11 | 835 | |
paul@11 | 836 | """ |
paul@11 | 837 | Return a parser class using the 'request' for the given 'format', returning |
paul@11 | 838 | a plain text parser if no parser can be found for the specified 'format'. |
paul@11 | 839 | """ |
paul@11 | 840 | |
paul@11 | 841 | try: |
paul@11 | 842 | return wikiutil.searchAndImportPlugin(request.cfg, "parser", format or "plain") |
paul@11 | 843 | except wikiutil.PluginMissingError: |
paul@11 | 844 | return wikiutil.searchAndImportPlugin(request.cfg, "parser", "plain") |
paul@11 | 845 | |
paul@15 | 846 | def getFormatterClass(request, format): |
paul@15 | 847 | |
paul@15 | 848 | """ |
paul@15 | 849 | Return a formatter class using the 'request' for the given output 'format', |
paul@15 | 850 | returning a plain text formatter if no formatter can be found for the |
paul@15 | 851 | specified 'format'. |
paul@15 | 852 | """ |
paul@15 | 853 | |
paul@15 | 854 | try: |
paul@15 | 855 | return wikiutil.searchAndImportPlugin(request.cfg, "formatter", format or "plain") |
paul@15 | 856 | except wikiutil.PluginMissingError: |
paul@15 | 857 | return wikiutil.searchAndImportPlugin(request.cfg, "formatter", "plain") |
paul@15 | 858 | |
paul@33 | 859 | def formatText(text, request, fmt, inhibit_p=True, parser_cls=None): |
paul@15 | 860 | |
paul@15 | 861 | """ |
paul@15 | 862 | Format the given 'text' using the specified 'request' and formatter 'fmt'. |
paul@15 | 863 | Suppress line anchors in the output, and fix lists by indicating that a |
paul@15 | 864 | paragraph has already been started. |
paul@15 | 865 | """ |
paul@15 | 866 | |
paul@15 | 867 | if not parser_cls: |
paul@15 | 868 | parser_cls = getPageParserClass(request) |
paul@15 | 869 | parser = parser_cls(text, request, line_anchors=False) |
paul@15 | 870 | |
paul@15 | 871 | old_fmt = request.formatter |
paul@15 | 872 | request.formatter = fmt |
paul@15 | 873 | try: |
paul@61 | 874 | if isinstance(parser, text_moin_wiki.Parser): |
paul@58 | 875 | return redirectedOutput(request, parser, fmt, inhibit_p=inhibit_p) |
paul@58 | 876 | else: |
paul@58 | 877 | return redirectedOutput(request, parser, fmt) |
paul@15 | 878 | finally: |
paul@15 | 879 | request.formatter = old_fmt |
paul@15 | 880 | |
paul@65 | 881 | def formatTextForOutputType(text, request, parser_cls, output_type): |
paul@65 | 882 | |
paul@65 | 883 | """ |
paul@65 | 884 | Format the given 'text' using the specified 'request' and parser class |
paul@65 | 885 | 'parser_cls', producing output of the given 'output_type'. |
paul@65 | 886 | """ |
paul@65 | 887 | |
paul@65 | 888 | parser = parser_cls(text, request) |
paul@66 | 889 | buf = codecs.getwriter("utf-8")(StringIO()) |
paul@65 | 890 | try: |
paul@65 | 891 | parser.formatForOutputType(output_type, buf.write) |
paul@66 | 892 | return unicode(buf.getvalue(), "utf-8") |
paul@65 | 893 | finally: |
paul@65 | 894 | buf.close() |
paul@65 | 895 | |
paul@11 | 896 | def redirectedOutput(request, parser, fmt, **kw): |
paul@11 | 897 | |
paul@11 | 898 | "A fixed version of the request method of the same name." |
paul@11 | 899 | |
paul@66 | 900 | buf = codecs.getwriter("utf-8")(StringIO()) |
paul@11 | 901 | request.redirect(buf) |
paul@11 | 902 | try: |
paul@11 | 903 | parser.format(fmt, **kw) |
paul@11 | 904 | if hasattr(fmt, "flush"): |
paul@11 | 905 | buf.write(fmt.flush(True)) |
paul@11 | 906 | finally: |
paul@11 | 907 | request.redirect() |
paul@11 | 908 | text = buf.getvalue() |
paul@11 | 909 | buf.close() |
paul@66 | 910 | return unicode(text, "utf-8") |
paul@11 | 911 | |
paul@46 | 912 | # Finding components for content types. |
paul@46 | 913 | |
paul@46 | 914 | def getParsersForContentType(cfg, mimetype): |
paul@46 | 915 | |
paul@46 | 916 | """ |
paul@46 | 917 | Find parsers that support the given 'mimetype', constructing a dictionary |
paul@46 | 918 | mapping content types to lists of parsers that is then cached in the 'cfg' |
paul@46 | 919 | object. A list of suitable parsers is returned for 'mimetype'. |
paul@46 | 920 | """ |
paul@46 | 921 | |
paul@46 | 922 | if not hasattr(cfg.cache, "MIMETYPE_TO_PARSER"): |
paul@46 | 923 | available = {} |
paul@46 | 924 | |
paul@46 | 925 | for name in wikiutil.getPlugins("parser", cfg): |
paul@46 | 926 | |
paul@46 | 927 | # Import each parser in order to inspect supported content types. |
paul@46 | 928 | |
paul@46 | 929 | try: |
paul@46 | 930 | parser_cls = wikiutil.importPlugin(cfg, "parser", name, "Parser") |
paul@46 | 931 | except wikiutil.PluginMissingError: |
paul@46 | 932 | continue |
paul@46 | 933 | |
paul@46 | 934 | # Attempt to determine supported content types. |
paul@46 | 935 | # NOTE: Extensions and /etc/mime.types (or equivalent) could also be |
paul@46 | 936 | # NOTE: used. |
paul@46 | 937 | |
paul@46 | 938 | if hasattr(parser_cls, "input_mimetypes"): |
paul@46 | 939 | for input_mimetype in parser_cls.input_mimetypes: |
paul@46 | 940 | if not available.has_key(input_mimetype): |
paul@46 | 941 | available[input_mimetype] = [] |
paul@46 | 942 | available[input_mimetype].append(parser_cls) |
paul@46 | 943 | |
paul@46 | 944 | # Support some basic parsers. |
paul@46 | 945 | |
paul@46 | 946 | elif name == "text_moin_wiki": |
paul@46 | 947 | available["text/moin-wiki"] = [parser_cls] |
paul@46 | 948 | available["text/moin"] = [parser_cls] |
paul@58 | 949 | elif name == "text_html": |
paul@58 | 950 | available["text/html"] = [parser_cls] |
paul@59 | 951 | available["application/xhtml+xml"] = [parser_cls] |
paul@46 | 952 | |
paul@46 | 953 | cfg.cache.MIMETYPE_TO_PARSER = available |
paul@46 | 954 | |
paul@46 | 955 | return cfg.cache.MIMETYPE_TO_PARSER.get(mimetype, []) |
paul@46 | 956 | |
paul@25 | 957 | # Textual representations. |
paul@25 | 958 | |
paul@25 | 959 | def getSimpleWikiText(text): |
paul@25 | 960 | |
paul@25 | 961 | """ |
paul@25 | 962 | Return the plain text representation of the given 'text' which may employ |
paul@25 | 963 | certain Wiki syntax features, such as those providing verbatim or monospaced |
paul@25 | 964 | text. |
paul@25 | 965 | """ |
paul@25 | 966 | |
paul@25 | 967 | # NOTE: Re-implementing support for verbatim text and linking avoidance. |
paul@25 | 968 | |
paul@87 | 969 | l = [] |
paul@87 | 970 | last = 0 |
paul@87 | 971 | |
paul@87 | 972 | for m in verbatim_regexp.finditer(text): |
paul@87 | 973 | start, end = m.span() |
paul@87 | 974 | l.append(text[last:start]) |
paul@87 | 975 | |
paul@87 | 976 | # Process the verbatim macro arguments. |
paul@87 | 977 | |
paul@87 | 978 | args = m.group("verbatim") or m.group("verbatim2") |
paul@87 | 979 | if args: |
paul@87 | 980 | l += [v for (n, v) in parseMacroArguments(args)] |
paul@87 | 981 | |
paul@87 | 982 | # Or just add the match groups. |
paul@87 | 983 | |
paul@87 | 984 | else: |
paul@87 | 985 | l += [s for s in m.groups() if s] |
paul@87 | 986 | |
paul@87 | 987 | last = end |
paul@87 | 988 | |
paul@87 | 989 | l.append(text[last:]) |
paul@87 | 990 | return "".join(l) |
paul@25 | 991 | |
paul@25 | 992 | def getEncodedWikiText(text): |
paul@25 | 993 | |
paul@25 | 994 | "Encode the given 'text' in a verbatim representation." |
paul@25 | 995 | |
paul@85 | 996 | return "<<Verbatim(%s)>>" % quoteMacroArgument(None, text) |
paul@25 | 997 | |
paul@25 | 998 | def getPrettyTitle(title): |
paul@25 | 999 | |
paul@25 | 1000 | "Return a nicely formatted version of the given 'title'." |
paul@25 | 1001 | |
paul@25 | 1002 | return title.replace("_", " ").replace("/", u" ? ") |
paul@25 | 1003 | |
paul@0 | 1004 | # User interface functions. |
paul@0 | 1005 | |
paul@0 | 1006 | def getParameter(request, name, default=None): |
paul@0 | 1007 | |
paul@0 | 1008 | """ |
paul@0 | 1009 | Using the given 'request', return the value of the parameter with the given |
paul@0 | 1010 | 'name', returning the optional 'default' (or None) if no value was supplied |
paul@0 | 1011 | in the 'request'. |
paul@0 | 1012 | """ |
paul@0 | 1013 | |
paul@0 | 1014 | return get_form(request).get(name, [default])[0] |
paul@0 | 1015 | |
paul@0 | 1016 | def getQualifiedParameter(request, prefix, argname, default=None): |
paul@0 | 1017 | |
paul@0 | 1018 | """ |
paul@0 | 1019 | Using the given 'request', 'prefix' and 'argname', retrieve the value of the |
paul@0 | 1020 | qualified parameter, returning the optional 'default' (or None) if no value |
paul@0 | 1021 | was supplied in the 'request'. |
paul@0 | 1022 | """ |
paul@0 | 1023 | |
paul@0 | 1024 | argname = getQualifiedParameterName(prefix, argname) |
paul@0 | 1025 | return getParameter(request, argname, default) |
paul@0 | 1026 | |
paul@0 | 1027 | def getQualifiedParameterName(prefix, argname): |
paul@0 | 1028 | |
paul@0 | 1029 | """ |
paul@0 | 1030 | Return the qualified parameter name using the given 'prefix' and 'argname'. |
paul@0 | 1031 | """ |
paul@0 | 1032 | |
paul@27 | 1033 | if not prefix: |
paul@0 | 1034 | return argname |
paul@0 | 1035 | else: |
paul@0 | 1036 | return "%s-%s" % (prefix, argname) |
paul@0 | 1037 | |
paul@0 | 1038 | # Page-related functions. |
paul@0 | 1039 | |
paul@0 | 1040 | def getPrettyPageName(page): |
paul@0 | 1041 | |
paul@0 | 1042 | "Return a nicely formatted title/name for the given 'page'." |
paul@0 | 1043 | |
paul@0 | 1044 | title = page.split_title(force=1) |
paul@0 | 1045 | return getPrettyTitle(title) |
paul@0 | 1046 | |
paul@25 | 1047 | def linkToPage(request, page, text, query_string=None, anchor=None, **kw): |
paul@0 | 1048 | |
paul@0 | 1049 | """ |
paul@0 | 1050 | Using 'request', return a link to 'page' with the given link 'text' and |
paul@25 | 1051 | optional 'query_string' and 'anchor'. |
paul@0 | 1052 | """ |
paul@0 | 1053 | |
paul@0 | 1054 | text = wikiutil.escape(text) |
paul@25 | 1055 | return page.link_to_raw(request, text, query_string, anchor, **kw) |
paul@0 | 1056 | |
paul@25 | 1057 | def linkToResource(url, request, text, query_string=None, anchor=None): |
paul@0 | 1058 | |
paul@0 | 1059 | """ |
paul@0 | 1060 | Using 'request', return a link to 'url' with the given link 'text' and |
paul@25 | 1061 | optional 'query_string' and 'anchor'. |
paul@0 | 1062 | """ |
paul@0 | 1063 | |
paul@25 | 1064 | if anchor: |
paul@25 | 1065 | url += "#%s" % anchor |
paul@25 | 1066 | |
paul@0 | 1067 | if query_string: |
paul@0 | 1068 | query_string = wikiutil.makeQueryString(query_string) |
paul@25 | 1069 | url += "?%s" % query_string |
paul@0 | 1070 | |
paul@0 | 1071 | formatter = request.page and getattr(request.page, "formatter", None) or request.html_formatter |
paul@0 | 1072 | |
paul@0 | 1073 | output = [] |
paul@0 | 1074 | output.append(formatter.url(1, url)) |
paul@0 | 1075 | output.append(formatter.text(text)) |
paul@0 | 1076 | output.append(formatter.url(0)) |
paul@0 | 1077 | return "".join(output) |
paul@0 | 1078 | |
paul@0 | 1079 | def getFullPageName(parent, title): |
paul@0 | 1080 | |
paul@0 | 1081 | """ |
paul@0 | 1082 | Return a full page name from the given 'parent' page (can be empty or None) |
paul@0 | 1083 | and 'title' (a simple page name). |
paul@0 | 1084 | """ |
paul@0 | 1085 | |
paul@0 | 1086 | if parent: |
paul@0 | 1087 | return "%s/%s" % (parent.rstrip("/"), title) |
paul@0 | 1088 | else: |
paul@0 | 1089 | return title |
paul@0 | 1090 | |
paul@0 | 1091 | # vim: tabstop=4 expandtab shiftwidth=4 |