templatefilters.py
405 lines
| 11.9 KiB
| text/x-python
|
PythonLexer
/ mercurial / templatefilters.py
|
r5976 | # template-filters.py - common template expansion filters | ||
# | ||||
# Copyright 2005-2008 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r5976 | |||
|
r11297 | import cgi, re, os, time, urllib | ||
|
r19227 | import encoding, node, util | ||
|
r15155 | import hbisect | ||
|
r5976 | |||
|
r13588 | def addbreaks(text): | ||
|
r13591 | """:addbreaks: Any text. Add an XHTML "<br />" tag before the end of | ||
every line except the last. | ||||
""" | ||||
|
r13588 | return text.replace('\n', '<br/>\n') | ||
|
r8360 | |||
|
r10601 | agescales = [("year", 3600 * 24 * 365), | ||
("month", 3600 * 24 * 30), | ||||
|
r5976 | ("week", 3600 * 24 * 7), | ||
|
r10601 | ("day", 3600 * 24), | ||
("hour", 3600), | ||||
("minute", 60), | ||||
|
r10787 | ("second", 1)] | ||
|
r5976 | |||
def age(date): | ||||
|
r13591 | """:age: Date. Returns a human-readable date/time difference between the | ||
given date/time and the current date/time. | ||||
""" | ||||
|
r5976 | |||
def plural(t, c): | ||||
if c == 1: | ||||
return t | ||||
return t + "s" | ||||
def fmt(t, c): | ||||
return "%d %s" % (c, plural(t, c)) | ||||
now = time.time() | ||||
then = date[0] | ||||
|
r13666 | future = False | ||
|
r7682 | if then > now: | ||
|
r13666 | future = True | ||
delta = max(1, int(then - now)) | ||||
if delta > agescales[0][1] * 30: | ||||
return 'in the distant future' | ||||
else: | ||||
delta = max(1, int(now - then)) | ||||
if delta > agescales[0][1] * 2: | ||||
return util.shortdate(date) | ||||
|
r9722 | |||
|
r5976 | for t, s in agescales: | ||
|
r9029 | n = delta // s | ||
|
r5976 | if n >= 2 or s == 1: | ||
|
r13666 | if future: | ||
return '%s from now' % fmt(t, n) | ||||
|
r9721 | return '%s ago' % fmt(t, n) | ||
|
r5976 | |||
|
r13590 | def basename(path): | ||
|
r13591 | """:basename: Any text. Treats the text as a path, and returns the last | ||
component of the path after splitting by the path separator | ||||
(ignoring trailing separators). For example, "foo/bar/baz" becomes | ||||
"baz" and "foo/bar//" becomes "bar". | ||||
""" | ||||
|
r13590 | return os.path.basename(path) | ||
def datefilter(text): | ||||
|
r13591 | """:date: Date. Returns a date in a Unix date format, including the | ||
timezone: "Mon Sep 04 15:13:13 2006 0700". | ||||
""" | ||||
|
r13590 | return util.datestr(text) | ||
|
r13588 | def domain(author): | ||
|
r13591 | """:domain: Any text. Finds the first string that looks like an email | ||
address, and extracts just the domain component. Example: ``User | ||||
<user@example.com>`` becomes ``example.com``. | ||||
""" | ||||
|
r13588 | f = author.find('@') | ||
if f == -1: | ||||
return '' | ||||
author = author[f + 1:] | ||||
f = author.find('>') | ||||
if f >= 0: | ||||
author = author[:f] | ||||
return author | ||||
|
r13590 | def email(text): | ||
|
r13591 | """:email: Any text. Extracts the first string that looks like an email | ||
address. Example: ``User <user@example.com>`` becomes | ||||
``user@example.com``. | ||||
""" | ||||
|
r13590 | return util.email(text) | ||
def escape(text): | ||||
|
r13591 | """:escape: Any text. Replaces the special XML/XHTML characters "&", "<" | ||
|
r17772 | and ">" with XML entities, and filters out NUL characters. | ||
|
r13591 | """ | ||
|
r17772 | return cgi.escape(text.replace('\0', ''), True) | ||
|
r13590 | |||
|
r5976 | para_re = None | ||
space_re = None | ||||
|
r19228 | def fill(text, width, initindent = '', hangindent = ''): | ||
'''fill many paragraphs with optional indentation.''' | ||||
|
r5976 | global para_re, space_re | ||
if para_re is None: | ||||
para_re = re.compile('(\n\n|\n\\s*[-*]\\s*)', re.M) | ||||
space_re = re.compile(r' +') | ||||
def findparas(): | ||||
start = 0 | ||||
while True: | ||||
m = para_re.search(text, start) | ||||
if not m: | ||||
|
r11297 | uctext = unicode(text[start:], encoding.encoding) | ||
w = len(uctext) | ||||
while 0 < w and uctext[w - 1].isspace(): | ||||
|
r10282 | w -= 1 | ||
|
r11297 | yield (uctext[:w].encode(encoding.encoding), | ||
uctext[w:].encode(encoding.encoding)) | ||||
|
r5976 | break | ||
yield text[start:m.start(0)], m.group(1) | ||||
start = m.end(1) | ||||
|
r19228 | return "".join([util.wrap(space_re.sub(' ', util.wrap(para, width)), | ||
width, initindent, hangindent) + rest | ||||
|
r5976 | for para, rest in findparas()]) | ||
|
r13590 | def fill68(text): | ||
|
r13591 | """:fill68: Any text. Wraps the text to fit in 68 columns.""" | ||
|
r13590 | return fill(text, 68) | ||
def fill76(text): | ||||
|
r13591 | """:fill76: Any text. Wraps the text to fit in 76 columns.""" | ||
|
r13590 | return fill(text, 76) | ||
|
r5976 | def firstline(text): | ||
|
r13591 | """:firstline: Any text. Returns the first line of text.""" | ||
|
r5976 | try: | ||
|
r9136 | return text.splitlines(True)[0].rstrip('\r\n') | ||
|
r5976 | except IndexError: | ||
return '' | ||||
|
r13590 | def hexfilter(text): | ||
|
r13591 | """:hex: Any text. Convert a binary Mercurial node identifier into | ||
its long hexadecimal representation. | ||||
""" | ||||
|
r13590 | return node.hex(text) | ||
def hgdate(text): | ||||
|
r13591 | """:hgdate: Date. Returns the date as a pair of numbers: "1157407993 | ||
25200" (Unix timestamp, timezone offset). | ||||
""" | ||||
|
r13590 | return "%d %d" % text | ||
def isodate(text): | ||||
|
r13591 | """:isodate: Date. Returns the date in ISO 8601 format: "2009-08-18 13:00 | ||
+0200". | ||||
""" | ||||
|
r13590 | return util.datestr(text, '%Y-%m-%d %H:%M %1%2') | ||
def isodatesec(text): | ||||
|
r13591 | """:isodatesec: Date. Returns the date in ISO 8601 format, including | ||
seconds: "2009-08-18 13:00:13 +0200". See also the rfc3339date | ||||
filter. | ||||
""" | ||||
|
r13590 | return util.datestr(text, '%Y-%m-%d %H:%M:%S %1%2') | ||
|
r5976 | def indent(text, prefix): | ||
'''indent each non-empty line of text after first with prefix.''' | ||||
lines = text.splitlines() | ||||
num_lines = len(lines) | ||||
|
r9387 | endswithnewline = text[-1:] == '\n' | ||
|
r5976 | def indenter(): | ||
for i in xrange(num_lines): | ||||
l = lines[i] | ||||
if i and l.strip(): | ||||
yield prefix | ||||
yield l | ||||
|
r9387 | if i < num_lines - 1 or endswithnewline: | ||
|
r5976 | yield '\n' | ||
return "".join(indenter()) | ||||
|
r6691 | def json(obj): | ||
if obj is None or obj is False or obj is True: | ||||
return {None: 'null', False: 'false', True: 'true'}[obj] | ||||
elif isinstance(obj, int) or isinstance(obj, float): | ||||
return str(obj) | ||||
elif isinstance(obj, str): | ||||
|
r11765 | u = unicode(obj, encoding.encoding, 'replace') | ||
|
r11890 | return '"%s"' % jsonescape(u) | ||
|
r6691 | elif isinstance(obj, unicode): | ||
|
r11890 | return '"%s"' % jsonescape(obj) | ||
|
r14967 | elif util.safehasattr(obj, 'keys'): | ||
|
r6691 | out = [] | ||
for k, v in obj.iteritems(): | ||||
s = '%s: %s' % (json(k), json(v)) | ||||
out.append(s) | ||||
return '{' + ', '.join(out) + '}' | ||||
|
r14944 | elif util.safehasattr(obj, '__iter__'): | ||
|
r6691 | out = [] | ||
for i in obj: | ||||
out.append(json(i)) | ||||
return '[' + ', '.join(out) + ']' | ||||
else: | ||||
raise TypeError('cannot encode type %s' % obj.__class__.__name__) | ||||
|
r13589 | def _uescape(c): | ||
|
r13588 | if ord(c) < 0x80: | ||
return c | ||||
else: | ||||
return '\\u%04x' % ord(c) | ||||
_escapes = [ | ||||
('\\', '\\\\'), ('"', '\\"'), ('\t', '\\t'), ('\n', '\\n'), | ||||
('\r', '\\r'), ('\f', '\\f'), ('\b', '\\b'), | ||||
] | ||||
def jsonescape(s): | ||||
for k, v in _escapes: | ||||
s = s.replace(k, v) | ||||
|
r13589 | return ''.join(_uescape(c) for c in s) | ||
|
r13588 | |||
|
r13590 | def localdate(text): | ||
|
r13591 | """:localdate: Date. Converts a date to local date.""" | ||
|
r17755 | return (util.parsedate(text)[0], util.makedate()[1]) | ||
|
r13590 | |||
|
r13588 | def nonempty(str): | ||
|
r13591 | """:nonempty: Any text. Returns '(none)' if the string is empty.""" | ||
|
r13588 | return str or "(none)" | ||
def obfuscate(text): | ||||
|
r13591 | """:obfuscate: Any text. Returns the input text rendered as a sequence of | ||
XML entities. | ||||
""" | ||||
|
r13588 | text = unicode(text, encoding.encoding, 'replace') | ||
return ''.join(['&#%d;' % ord(c) for c in text]) | ||||
def permissions(flags): | ||||
if "l" in flags: | ||||
return "lrwxrwxrwx" | ||||
if "x" in flags: | ||||
return "-rwxr-xr-x" | ||||
return "-rw-r--r--" | ||||
def person(author): | ||||
|
r16235 | """:person: Any text. Returns the name before an email address, | ||
interpreting it as per RFC 5322. | ||||
|
r16251 | |||
>>> person('foo@bar') | ||||
'foo' | ||||
>>> person('Foo Bar <foo@bar>') | ||||
'Foo Bar' | ||||
>>> person('"Foo Bar" <foo@bar>') | ||||
'Foo Bar' | ||||
>>> person('"Foo \"buz\" Bar" <foo@bar>') | ||||
'Foo "buz" Bar' | ||||
>>> # The following are invalid, but do exist in real-life | ||||
... | ||||
>>> person('Foo "buz" Bar <foo@bar>') | ||||
'Foo "buz" Bar' | ||||
>>> person('"Foo Bar <foo@bar>') | ||||
'Foo Bar' | ||||
|
r16235 | """ | ||
|
r16686 | if '@' not in author: | ||
|
r13588 | return author | ||
f = author.find('<') | ||||
|
r13951 | if f != -1: | ||
|
r16235 | return author[:f].strip(' "').replace('\\"', '"') | ||
|
r13951 | f = author.find('@') | ||
return author[:f].replace('.', ' ') | ||||
|
r13588 | |||
|
r13590 | def rfc3339date(text): | ||
|
r13591 | """:rfc3339date: Date. Returns a date using the Internet date format | ||
specified in RFC 3339: "2009-08-18T13:00:13+02:00". | ||||
""" | ||||
|
r13590 | return util.datestr(text, "%Y-%m-%dT%H:%M:%S%1:%2") | ||
def rfc822date(text): | ||||
|
r13591 | """:rfc822date: Date. Returns a date using the same format used in email | ||
headers: "Tue, 18 Aug 2009 13:00:13 +0200". | ||||
""" | ||||
|
r13590 | return util.datestr(text, "%a, %d %b %Y %H:%M:%S %1%2") | ||
def short(text): | ||||
|
r13591 | """:short: Changeset hash. Returns the short form of a changeset hash, | ||
i.e. a 12 hexadecimal digit string. | ||||
""" | ||||
|
r13590 | return text[:12] | ||
|
r15155 | def shortbisect(text): | ||
""":shortbisect: Any text. Treats `text` as a bisection status, and | ||||
returns a single-character representing the status (G: good, B: bad, | ||||
S: skipped, U: untested, I: ignored). Returns single space if `text` | ||||
is not a valid bisection status. | ||||
""" | ||||
return hbisect.shortlabel(text) or ' ' | ||||
|
r13590 | def shortdate(text): | ||
|
r13591 | """:shortdate: Date. Returns a date like "2006-09-18".""" | ||
|
r13590 | return util.shortdate(text) | ||
def stringescape(text): | ||||
return text.encode('string_escape') | ||||
|
r13588 | def stringify(thing): | ||
|
r13591 | """:stringify: Any type. Turns the value into text by converting values into | ||
text and concatenating them. | ||||
""" | ||||
|
r14944 | if util.safehasattr(thing, '__iter__') and not isinstance(thing, str): | ||
|
r13588 | return "".join([stringify(t) for t in thing if t is not None]) | ||
return str(thing) | ||||
|
r13590 | def strip(text): | ||
|
r13591 | """:strip: Any text. Strips all leading and trailing whitespace.""" | ||
|
r13590 | return text.strip() | ||
|
r8158 | def stripdir(text): | ||
|
r13591 | """:stripdir: Treat the text as path and strip a directory level, if | ||
possible. For example, "foo" and "foo/bar" becomes "foo". | ||||
""" | ||||
|
r8158 | dir = os.path.dirname(text) | ||
if dir == "": | ||||
return os.path.basename(text) | ||||
else: | ||||
return dir | ||||
|
r13590 | def tabindent(text): | ||
|
r19467 | """:tabindent: Any text. Returns the text, with every non-empty line | ||
except the first starting with a tab character. | ||||
|
r13591 | """ | ||
|
r13590 | return indent(text, '\t') | ||
def urlescape(text): | ||||
|
r13591 | """:urlescape: Any text. Escapes all "special" characters. For example, | ||
"foo bar" becomes "foo%20bar". | ||||
""" | ||||
|
r13590 | return urllib.quote(text) | ||
def userfilter(text): | ||||
|
r16360 | """:user: Any text. Returns a short representation of a user name or email | ||
address.""" | ||||
|
r13590 | return util.shortuser(text) | ||
|
r16360 | def emailuser(text): | ||
""":emailuser: Any text. Returns the user portion of an email address.""" | ||||
return util.emailuser(text) | ||||
|
r13588 | def xmlescape(text): | ||
text = (text | ||||
.replace('&', '&') | ||||
.replace('<', '<') | ||||
.replace('>', '>') | ||||
.replace('"', '"') | ||||
.replace("'", ''')) # ' invalid in HTML | ||||
return re.sub('[\x00-\x08\x0B\x0C\x0E-\x1F]', ' ', text) | ||||
|
r8234 | |||
|
r5976 | filters = { | ||
|
r13587 | "addbreaks": addbreaks, | ||
|
r13586 | "age": age, | ||
|
r13590 | "basename": basename, | ||
"date": datefilter, | ||||
|
r5976 | "domain": domain, | ||
|
r13590 | "email": email, | ||
"escape": escape, | ||||
"fill68": fill68, | ||||
"fill76": fill76, | ||||
|
r5976 | "firstline": firstline, | ||
|
r13590 | "hex": hexfilter, | ||
"hgdate": hgdate, | ||||
"isodate": isodate, | ||||
"isodatesec": isodatesec, | ||||
|
r8014 | "json": json, | ||
"jsonescape": jsonescape, | ||||
|
r13590 | "localdate": localdate, | ||
|
r8234 | "nonempty": nonempty, | ||
|
r5976 | "obfuscate": obfuscate, | ||
"permissions": permissions, | ||||
"person": person, | ||||
|
r13590 | "rfc3339date": rfc3339date, | ||
"rfc822date": rfc822date, | ||||
"short": short, | ||||
|
r15155 | "shortbisect": shortbisect, | ||
|
r13590 | "shortdate": shortdate, | ||
"stringescape": stringescape, | ||||
|
r8360 | "stringify": stringify, | ||
|
r13590 | "strip": strip, | ||
|
r13586 | "stripdir": stripdir, | ||
|
r13590 | "tabindent": tabindent, | ||
"urlescape": urlescape, | ||||
"user": userfilter, | ||||
|
r16360 | "emailuser": emailuser, | ||
|
r6174 | "xmlescape": xmlescape, | ||
|
r6691 | } | ||
|
r13591 | |||
|
r18627 | def websub(text, websubtable): | ||
""":websub: Any text. Only applies to hgweb. Applies the regular | ||||
expression replacements defined in the websub section. | ||||
""" | ||||
if websubtable: | ||||
for regexp, format in websubtable: | ||||
text = regexp.sub(format, text) | ||||
return text | ||||
|
r13591 | # tell hggettext to extract docstrings from these functions: | ||
i18nfunctions = filters.values() | ||||