templatefilters.py
436 lines
| 12.5 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 | |||
|
r25983 | from __future__ import absolute_import | ||
import cgi | ||||
import os | ||||
import re | ||||
import time | ||||
from . import ( | ||||
encoding, | ||||
hbisect, | ||||
node, | ||||
|
r32126 | pycompat, | ||
|
r28693 | registrar, | ||
|
r25983 | templatekw, | ||
util, | ||||
) | ||||
|
r5976 | |||
|
r28883 | urlerr = util.urlerr | ||
urlreq = util.urlreq | ||||
|
r32126 | if pycompat.ispy3: | ||
long = int | ||||
|
r28693 | # filters are callables like: | ||
# fn(obj) | ||||
# with: | ||||
# obj - object to be filtered (text, date, list and so on) | ||||
filters = {} | ||||
templatefilter = registrar.templatefilter(filters) | ||||
@templatefilter('addbreaks') | ||||
|
r13588 | def addbreaks(text): | ||
|
r28693 | """Any text. Add an XHTML "<br />" tag before the end of | ||
|
r13591 | every line except the last. | ||
""" | ||||
|
r13588 | return text.replace('\n', '<br/>\n') | ||
|
r8360 | |||
|
r19736 | agescales = [("year", 3600 * 24 * 365, 'Y'), | ||
("month", 3600 * 24 * 30, 'M'), | ||||
("week", 3600 * 24 * 7, 'W'), | ||||
("day", 3600 * 24, 'd'), | ||||
("hour", 3600, 'h'), | ||||
("minute", 60, 'm'), | ||||
("second", 1, 's')] | ||||
|
r5976 | |||
|
r28693 | @templatefilter('age') | ||
|
r19736 | def age(date, abbrev=False): | ||
|
r28693 | """Date. Returns a human-readable date/time difference between the | ||
|
r13591 | given date/time and the current date/time. | ||
""" | ||||
|
r5976 | |||
def plural(t, c): | ||||
if c == 1: | ||||
return t | ||||
return t + "s" | ||||
|
r19736 | def fmt(t, c, a): | ||
if abbrev: | ||||
return "%d%s" % (c, a) | ||||
|
r5976 | 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 | |||
|
r19736 | for t, s, a in agescales: | ||
|
r9029 | n = delta // s | ||
|
r5976 | if n >= 2 or s == 1: | ||
|
r13666 | if future: | ||
|
r19736 | return '%s from now' % fmt(t, n, a) | ||
return '%s ago' % fmt(t, n, a) | ||||
|
r5976 | |||
|
r28693 | @templatefilter('basename') | ||
|
r13590 | def basename(path): | ||
|
r28693 | """Any text. Treats the text as a path, and returns the last | ||
|
r13591 | 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) | ||
|
r28693 | @templatefilter('count') | ||
|
r22668 | def count(i): | ||
|
r28693 | """List or text. Returns the length as an integer.""" | ||
|
r22668 | return len(i) | ||
|
r28693 | @templatefilter('domain') | ||
|
r13588 | def domain(author): | ||
|
r28693 | """Any text. Finds the first string that looks like an email | ||
|
r13591 | 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 | ||||
|
r28693 | @templatefilter('email') | ||
|
r13590 | def email(text): | ||
|
r28693 | """Any text. Extracts the first string that looks like an email | ||
|
r13591 | address. Example: ``User <user@example.com>`` becomes | ||
``user@example.com``. | ||||
""" | ||||
|
r13590 | return util.email(text) | ||
|
r28693 | @templatefilter('escape') | ||
|
r13590 | def escape(text): | ||
|
r28693 | """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 | ||||
|
r19872 | def fill(text, width, initindent='', hangindent=''): | ||
|
r19228 | '''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()]) | ||
|
r28693 | @templatefilter('fill68') | ||
|
r13590 | def fill68(text): | ||
|
r28693 | """Any text. Wraps the text to fit in 68 columns.""" | ||
|
r13590 | return fill(text, 68) | ||
|
r28693 | @templatefilter('fill76') | ||
|
r13590 | def fill76(text): | ||
|
r28693 | """Any text. Wraps the text to fit in 76 columns.""" | ||
|
r13590 | return fill(text, 76) | ||
|
r28693 | @templatefilter('firstline') | ||
|
r5976 | def firstline(text): | ||
|
r28693 | """Any text. Returns the first line of text.""" | ||
|
r5976 | try: | ||
|
r9136 | return text.splitlines(True)[0].rstrip('\r\n') | ||
|
r5976 | except IndexError: | ||
return '' | ||||
|
r28693 | @templatefilter('hex') | ||
|
r13590 | def hexfilter(text): | ||
|
r28693 | """Any text. Convert a binary Mercurial node identifier into | ||
|
r13591 | its long hexadecimal representation. | ||
""" | ||||
|
r13590 | return node.hex(text) | ||
|
r28693 | @templatefilter('hgdate') | ||
|
r13590 | def hgdate(text): | ||
|
r28693 | """Date. Returns the date as a pair of numbers: "1157407993 | ||
|
r13591 | 25200" (Unix timestamp, timezone offset). | ||
""" | ||||
|
r13590 | return "%d %d" % text | ||
|
r28693 | @templatefilter('isodate') | ||
|
r13590 | def isodate(text): | ||
|
r28693 | """Date. Returns the date in ISO 8601 format: "2009-08-18 13:00 | ||
|
r13591 | +0200". | ||
""" | ||||
|
r13590 | return util.datestr(text, '%Y-%m-%d %H:%M %1%2') | ||
|
r28693 | @templatefilter('isodatesec') | ||
|
r13590 | def isodatesec(text): | ||
|
r28693 | """Date. Returns the date in ISO 8601 format, including | ||
|
r13591 | 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()) | ||||
|
r28693 | @templatefilter('json') | ||
|
r31782 | def json(obj, paranoid=True): | ||
|
r31780 | if obj is None: | ||
return 'null' | ||||
elif obj is False: | ||||
return 'false' | ||||
elif obj is True: | ||||
return 'true' | ||||
|
r31728 | elif isinstance(obj, (int, long, float)): | ||
|
r32127 | return pycompat.bytestr(obj) | ||
|
r32128 | elif isinstance(obj, bytes): | ||
|
r31782 | return '"%s"' % encoding.jsonescape(obj, paranoid=paranoid) | ||
|
r14967 | elif util.safehasattr(obj, 'keys'): | ||
|
r31781 | out = ['%s: %s' % (json(k), json(v)) | ||
for k, v in sorted(obj.iteritems())] | ||||
|
r6691 | return '{' + ', '.join(out) + '}' | ||
|
r14944 | elif util.safehasattr(obj, '__iter__'): | ||
|
r31781 | out = [json(i) for i in obj] | ||
|
r6691 | return '[' + ', '.join(out) + ']' | ||
else: | ||||
raise TypeError('cannot encode type %s' % obj.__class__.__name__) | ||||
|
r28693 | @templatefilter('lower') | ||
|
r24566 | def lower(text): | ||
|
r28693 | """Any text. Converts the text to lowercase.""" | ||
|
r24566 | return encoding.lower(text) | ||
|
r28693 | @templatefilter('nonempty') | ||
|
r13588 | def nonempty(str): | ||
|
r28693 | """Any text. Returns '(none)' if the string is empty.""" | ||
|
r13588 | return str or "(none)" | ||
|
r28693 | @templatefilter('obfuscate') | ||
|
r13588 | def obfuscate(text): | ||
|
r28693 | """Any text. Returns the input text rendered as a sequence of | ||
|
r13591 | XML entities. | ||
""" | ||||
|
r13588 | text = unicode(text, encoding.encoding, 'replace') | ||
return ''.join(['&#%d;' % ord(c) for c in text]) | ||||
|
r28693 | @templatefilter('permissions') | ||
|
r13588 | def permissions(flags): | ||
if "l" in flags: | ||||
return "lrwxrwxrwx" | ||||
if "x" in flags: | ||||
return "-rwxr-xr-x" | ||||
return "-rw-r--r--" | ||||
|
r28693 | @templatefilter('person') | ||
|
r13588 | def person(author): | ||
|
r28693 | """Any text. Returns the name before an email address, | ||
|
r16235 | 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 | |||
|
r28693 | @templatefilter('revescape') | ||
r25778 | def revescape(text): | |||
|
r28693 | """Any text. Escapes all "special" characters, except @. | ||
r25778 | Forward slashes are escaped twice to prevent web servers from prematurely | |||
unescaping them. For example, "@foo bar/baz" becomes "@foo%20bar%252Fbaz". | ||||
""" | ||||
|
r28883 | return urlreq.quote(text, safe='/@').replace('/', '%252F') | ||
r25778 | ||||
|
r28693 | @templatefilter('rfc3339date') | ||
|
r13590 | def rfc3339date(text): | ||
|
r28693 | """Date. Returns a date using the Internet date format | ||
|
r13591 | specified in RFC 3339: "2009-08-18T13:00:13+02:00". | ||
""" | ||||
|
r13590 | return util.datestr(text, "%Y-%m-%dT%H:%M:%S%1:%2") | ||
|
r28693 | @templatefilter('rfc822date') | ||
|
r13590 | def rfc822date(text): | ||
|
r28693 | """Date. Returns a date using the same format used in email | ||
|
r13591 | headers: "Tue, 18 Aug 2009 13:00:13 +0200". | ||
""" | ||||
|
r13590 | return util.datestr(text, "%a, %d %b %Y %H:%M:%S %1%2") | ||
|
r28693 | @templatefilter('short') | ||
|
r13590 | def short(text): | ||
|
r28693 | """Changeset hash. Returns the short form of a changeset hash, | ||
|
r13591 | i.e. a 12 hexadecimal digit string. | ||
""" | ||||
|
r13590 | return text[:12] | ||
|
r28693 | @templatefilter('shortbisect') | ||
|
r15155 | def shortbisect(text): | ||
|
r28693 | """Any text. Treats `text` as a bisection status, and | ||
|
r15155 | 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 ' ' | ||||
|
r28693 | @templatefilter('shortdate') | ||
|
r13590 | def shortdate(text): | ||
|
r28693 | """Date. Returns a date like "2006-09-18".""" | ||
|
r13590 | return util.shortdate(text) | ||
|
r28693 | @templatefilter('splitlines') | ||
|
r21820 | def splitlines(text): | ||
|
r28693 | """Any text. Split text into a list of lines.""" | ||
|
r32039 | return templatekw.hybridlist(text.splitlines(), name='line') | ||
|
r21820 | |||
|
r28693 | @templatefilter('stringescape') | ||
|
r13590 | def stringescape(text): | ||
|
r31451 | return util.escapestr(text) | ||
|
r13590 | |||
|
r28693 | @templatefilter('stringify') | ||
|
r13588 | def stringify(thing): | ||
|
r28693 | """Any type. Turns the value into text by converting values into | ||
|
r13591 | text and concatenating them. | ||
""" | ||||
|
r31880 | thing = templatekw.unwraphybrid(thing) | ||
|
r32128 | if util.safehasattr(thing, '__iter__') and not isinstance(thing, bytes): | ||
|
r13588 | return "".join([stringify(t) for t in thing if t is not None]) | ||
|
r25000 | if thing is None: | ||
return "" | ||||
|
r32127 | return pycompat.bytestr(thing) | ||
|
r13588 | |||
|
r28693 | @templatefilter('stripdir') | ||
|
r8158 | def stripdir(text): | ||
|
r28693 | """Treat the text as path and strip a directory level, if | ||
|
r13591 | 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 | ||||
|
r28693 | @templatefilter('tabindent') | ||
|
r13590 | def tabindent(text): | ||
|
r28693 | """Any text. Returns the text, with every non-empty line | ||
|
r19467 | except the first starting with a tab character. | ||
|
r13591 | """ | ||
|
r13590 | return indent(text, '\t') | ||
|
r28693 | @templatefilter('upper') | ||
|
r24566 | def upper(text): | ||
|
r28693 | """Any text. Converts the text to uppercase.""" | ||
|
r24566 | return encoding.upper(text) | ||
|
r28693 | @templatefilter('urlescape') | ||
|
r13590 | def urlescape(text): | ||
|
r28693 | """Any text. Escapes all "special" characters. For example, | ||
|
r13591 | "foo bar" becomes "foo%20bar". | ||
""" | ||||
|
r28883 | return urlreq.quote(text) | ||
|
r13590 | |||
|
r28693 | @templatefilter('user') | ||
|
r13590 | def userfilter(text): | ||
|
r28693 | """Any text. Returns a short representation of a user name or email | ||
|
r16360 | address.""" | ||
|
r13590 | return util.shortuser(text) | ||
|
r28693 | @templatefilter('emailuser') | ||
|
r16360 | def emailuser(text): | ||
|
r28693 | """Any text. Returns the user portion of an email address.""" | ||
|
r16360 | return util.emailuser(text) | ||
|
r28693 | @templatefilter('utf8') | ||
|
r28209 | def utf8(text): | ||
|
r28693 | """Any text. Converts from the local character encoding to UTF-8.""" | ||
|
r28209 | return encoding.fromlocal(text) | ||
|
r28693 | @templatefilter('xmlescape') | ||
|
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 | |||
|
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 | ||||
|
r28692 | def loadfilter(ui, extname, registrarobj): | ||
"""Load template filter from specified registrarobj | ||||
""" | ||||
for name, func in registrarobj._table.iteritems(): | ||||
filters[name] = func | ||||
|
r13591 | # tell hggettext to extract docstrings from these functions: | ||
i18nfunctions = filters.values() | ||||