def get_macro_description(self, name):
description = cleandoc_(
"""
Display the list of available repositories.
Can be given the following named arguments:
''format''::
Select the rendering format:
- ''compact'' produces a comma-separated list of repository prefix
names (default)
- ''list'' produces a description list of repository prefix names
- ''table'' produces a table view, similar to the one visible in
the ''Browse View'' page
''glob''::
Do a glob-style filtering on the repository names (defaults to '*')
''order''::
Order repositories by the given column (one of "name", "date" or
"author")
''desc''::
When set to 1, order by descending order
(''since 0.12'')
"""
)
return "messages", description
class TitleIndexMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Insert an alphabetic list of all wiki pages into the output.
Accepts a prefix string as parameter: if provided, only pages with names
that start with the prefix are included in the resulting list. If this
parameter is omitted, all pages are listed.
If the prefix is specified, a second argument of value `hideprefix`
can be given as well, in order to remove that prefix from the output.
Alternate `format` and `depth` named parameters can be specified:
- `format=compact`: The pages are displayed as comma-separated links.
- `format=group`: The list of pages will be structured in groups
according to common prefix. This format also supports a `min=n`
argument, where `n` is the minimal number of pages for a group.
- `format=hierarchy`: The list of pages will be structured according
to the page name path hierarchy. This format also supports a `min=n`
argument, where higher `n` flatten the display hierarchy
- `depth=n`: limit the depth of the pages to list. If set to 0,
only toplevel pages will be shown, if set to 1, only immediate
children pages will be shown, etc. If not set, or set to -1,
all pages in the hierarchy will be shown.
- `include=page1:page*2`: include only pages that match an item in the
colon-separated list of pages. If the list is empty, or if no `include`
argument is given, include all pages.
- `exclude=page1:page*2`: exclude pages that match an item in the colon-
separated list of pages.
The `include` and `exclude` lists accept shell-style patterns.
""")
SPLIT_RE = re.compile(r"(/| )")
NUM_SPLIT_RE = re.compile(r"([0-9.]+)")
def expand_macro(self, formatter, name, content):
args, kw = parse_args(content)
prefix = args[0].strip() if args else None
hideprefix = args and len(args) > 1 and args[1].strip() == 'hideprefix'
minsize = max(int(kw.get('min', 1)), 1)
minsize_group = max(minsize, 2)
depth = int(kw.get('depth', -1))
start = prefix.count('/') if prefix else 0
format = kw.get('format', '')
def parse_list(name):
return [inc.strip() for inc in kw.get(name, '').split(':')
if inc.strip()]
includes = parse_list('include') or ['*']
excludes = parse_list('exclude')
if hideprefix:
omitprefix = lambda page: page[len(prefix):]
else:
omitprefix = lambda page: page
wiki = formatter.wiki
pages = sorted(page for page in wiki.get_pages(prefix)
if (depth < 0 or depth >= page.count('/') - start)
and 'WIKI_VIEW' in formatter.perm('wiki', page)
and any(fnmatchcase(page, inc) for inc in includes)
and not any(fnmatchcase(page, exc) for exc in excludes))
if format == 'compact':
return tag(
separated((tag.a(wiki.format_page_name(omitprefix(p)),
href=formatter.href.wiki(p)) for p in pages),
', '))
# the function definitions for the different format styles
# the different page split formats, each corresponding to its rendering
def split_pages_group(pages):
"""Return a list of (path elements, page_name) pairs,
where path elements correspond to the page name (without prefix)
splitted at Camel Case word boundaries, numbers and '/'.
"""
page_paths = []
for page in pages:
path = [elt.strip() for elt in self.SPLIT_RE.split(
self.NUM_SPLIT_RE.sub(r" \1 ",
wiki.format_page_name(omitprefix(page), split=True)))]
page_paths.append(([elt for elt in path if elt], page))
return page_paths
def split_pages_hierarchy(pages):
"""Return a list of (path elements, page_name) pairs,
where path elements correspond to the page name (without prefix)
splitted according to the '/' hierarchy.
"""
return [(wiki.format_page_name(omitprefix(page)).split("/"), page)
for page in pages]
# the different tree structures, each corresponding to its rendering
def tree_group(entries):
"""Transform a flat list of entries into a tree structure.
`entries` is a list of `(path_elements, page_name)` pairs
Return a list organized in a tree structure, in which:
- a leaf is a page name
- a node is a `(key, nodes)` pairs, where:
- `key` is the leftmost of the path elements, common to the
grouped (path element, page_name) entries
- `nodes` is a list of nodes or leaves
"""
groups = []
for key, grouper in groupby(entries, lambda (elts, name):
elts[0] if elts else ''):
# remove key from path_elements in grouped entries for further
# grouping
grouped_entries = [(path_elements[1:], page_name)
for path_elements, page_name in grouper]
if key and len(grouped_entries) >= minsize_group:
subnodes = tree_group(sorted(grouped_entries))
if len(subnodes) == 1:
subkey, subnodes = subnodes[0]
node = (key + subkey, subnodes)
groups.append(node)
elif self.SPLIT_RE.match(key):
for elt in subnodes:
if isinstance(elt, tuple):
subkey, subnodes = elt
elt = (key + subkey, subnodes)
groups.append(elt)
else:
node = (key, subnodes)
groups.append(node)
else:
for path_elements, page_name in grouped_entries:
groups.append(page_name)
return groups
def tree_hierarchy(entries):
"""Transform a flat list of entries into a tree structure.
`entries` is a list of `(path_elements, page_name)` pairs
Return a list organized in a tree structure, in which:
- a leaf is a `(rest, page)` pair, where:
- `rest` is the rest of the path to be shown
- `page` is a page name
- a node is a `(key, nodes, page)` pair, where:
- `key` is the leftmost of the path elements, common to the
grouped (path element, page_name) entries
- `page` is a page name (if one exists for that node)
- `nodes` is a list of nodes or leaves
"""
groups = []
for key, grouper in groupby(entries, lambda (elts, name):
elts[0] if elts else ''):
grouped_entries = [e for e in grouper]
sub_entries = [e for e in grouped_entries if len(e[0]) > 1]
key_entries = [e for e in grouped_entries if len(e[0]) == 1]
key_entry = key_entries[0] if key_entries else None
key_page = key_entry[1] if key_entries else None
if key and len(sub_entries) >= minsize:
# remove key from path_elements in grouped entries for
# further grouping
sub_entries = [(path_elements[1:], page)
for path_elements, page in sub_entries]
subnodes = tree_hierarchy(sorted(sub_entries))
node = (key, key_page, subnodes)
groups.append(node)
else:
if key_entry:
groups.append(key_entry)
groups.extend(sub_entries)
return groups
class RecentChangesMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""List all pages that have recently been modified, grouping them by the
day they were last modified.
This macro accepts two parameters. The first is a prefix string: if
provided, only pages with names that start with the prefix are included in
the resulting list. If this parameter is omitted, all pages are listed.
The second parameter is a number for limiting the number of pages returned.
For example, specifying a limit of 5 will result in only the five most
recently changed pages to be included in the list.
""")
def expand_macro(self, formatter, name, content):
prefix = limit = None
if content:
argv = [arg.strip() for arg in content.split(',')]
if len(argv) > 0:
prefix = argv[0]
if len(argv) > 1:
limit = int(argv[1])
sql = """SELECT name, max(version) AS max_version,
max(time) AS max_time FROM wiki"""
args = []
if prefix:
sql += " WHERE name LIKE %s"
args.append(prefix + '%')
sql += " GROUP BY name ORDER BY max_time DESC"
if limit:
sql += " LIMIT %s"
args.append(limit)
entries_per_date = []
prevdate = None
for name, version, ts in self.env.db_query(sql, args):
if not 'WIKI_VIEW' in formatter.perm('wiki', name, version):
continue
req = formatter.req
date = user_time(req, format_date, from_utimestamp(ts))
if date != prevdate:
prevdate = date
entries_per_date.append((date, []))
version = int(version)
diff_href = None
if version > 1:
diff_href = formatter.href.wiki(name,
action='diff',
version=version)
page_name = formatter.wiki.format_page_name(name)
entries_per_date[-1][1].append(
(page_name, name, version, diff_href))
return tag.div(
(tag.h3(date),
tag.ul(
tag.li(
tag.a(page, href=formatter.href.wiki(name)),
' ', diff_href and tag.small(
'(', tag.a('diff', href=diff_href), ')') or None)
for page, name, version, diff_href in entries))
for date, entries in entries_per_date)
class ImageMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Embed an image in wiki-formatted text.
The first argument is the file specification. The file specification may
reference attachments in three ways:
* `module:id:file`, where module can be either '''wiki''' or '''ticket''',
to refer to the attachment named ''file'' of the specified wiki page or
ticket.
* `id:file`: same as above, but id is either a ticket shorthand or a Wiki
page name.
* `file` to refer to a local attachment named 'file'. This only works from
within that wiki page or a ticket.
Also, the file specification may refer to repository files, using the
`source:file` syntax (`source:file@rev` works also).
Files can also be accessed with a direct URLs; `/file` for a
project-relative, `//file` for a server-relative, or `http://server/file`
for absolute location of the file.
The remaining arguments are optional and allow configuring the attributes
and style of the rendered `<img>` element:
* digits and unit are interpreted as the size (ex. 120, 25%)
for the image
* `right`, `left`, `center`, `top`, `bottom` and `middle` are interpreted
as the alignment for the image (alternatively, the first three can be
specified using `align=...` and the last three using `valign=...`)
* `link=some TracLinks...` replaces the link to the image source by the
one specified using a TracLinks. If no value is specified, the link is
simply removed.
* `nolink` means without link to image source (deprecated, use `link=`)
* `key=value` style are interpreted as HTML attributes or CSS style
indications for the image. Valid keys are:
* align, valign, border, width, height, alt, title, longdesc, class,
margin, margin-(left,right,top,bottom), id and usemap
* `border`, `margin`, and `margin-`* can only be a single number
* `margin` is superseded by `center` which uses auto margins
Examples:
{{{
[[Image(photo.jpg)]] # simplest
[[Image(photo.jpg, 120px)]] # with image width size
[[Image(photo.jpg, right)]] # aligned by keyword
[[Image(photo.jpg, nolink)]] # without link to source
[[Image(photo.jpg, align=right)]] # aligned by attribute
}}}
You can use image from other page, other ticket or other module.
{{{
[[Image(OtherPage:foo.bmp)]] # if current module is wiki
[[Image(base/sub:bar.bmp)]] # from hierarchical wiki page
[[Image(#3:baz.bmp)]] # if in a ticket, point to #3
[[Image(ticket:36:boo.jpg)]]
[[Image(source:/images/bee.jpg)]] # straight from the repository!
[[Image(htdocs:foo/bar.png)]] # image file in project htdocs dir.
}}}
''Adapted from the Image.py macro created by Shun-ichi Goto
<*****@*****.**>''
""")
def is_inline(self, content):
return True
def expand_macro(self, formatter, name, content):
# args will be null if the macro is called without parenthesis.
if not content:
return ''
# parse arguments
# we expect the 1st argument to be a filename (filespec)
args = content.split(',')
if len(args) == 0:
raise Exception("No argument.")
# strip unicode white-spaces and ZWSPs are copied from attachments
# section (#10668)
filespec = stripws(args.pop(0))
# style information
size_re = re.compile('[0-9]+(%|px)?$')
attr_re = re.compile('(align|valign|border|width|height|alt'
'|margin(?:-(?:left|right|top|bottom))?'
'|title|longdesc|class|id|usemap)=(.+)')
quoted_re = re.compile("(?:[\"'])(.*)(?:[\"'])$")
attr = {}
style = {}
link = ''
# helper for the special case `source:`
#
from trac.versioncontrol.web_ui import BrowserModule
# FIXME: somehow use ResourceSystem.get_known_realms()
# ... or directly trac.wiki.extract_link
try:
browser_links = [res[0] for res in
BrowserModule(self.env).get_link_resolvers()]
except Exception:
browser_links = []
while args:
arg = args.pop(0).strip()
if size_re.match(arg):
# 'width' keyword
attr['width'] = arg
elif arg == 'nolink':
link = None
elif arg.startswith('link='):
val = arg.split('=', 1)[1]
elt = extract_link(self.env, formatter.context, val.strip())
elt = find_element(elt, 'href')
link = None
if elt is not None:
link = elt.attrib.get('href')
elif arg in ('left', 'right'):
style['float'] = arg
elif arg == 'center':
style['margin-left'] = style['margin-right'] = 'auto'
style['display'] = 'block'
style.pop('margin', '')
elif arg in ('top', 'bottom', 'middle'):
style['vertical-align'] = arg
else:
match = attr_re.match(arg)
if match:
key, val = match.groups()
if (key == 'align' and
val in ('left', 'right', 'center')) or \
(key == 'valign' and \
val in ('top', 'middle', 'bottom')):
args.append(val)
elif key in ('margin-top', 'margin-bottom'):
style[key] = ' %dpx' % int(val)
elif key in ('margin', 'margin-left', 'margin-right') \
and 'display' not in style:
style[key] = ' %dpx' % int(val)
elif key == 'border':
style['border'] = ' %dpx solid' % int(val)
else:
m = quoted_re.search(val) # unquote "..." and '...'
if m:
val = m.group(1)
attr[str(key)] = val # will be used as a __call__ kwd
# parse filespec argument to get realm and id if contained.
parts = filespec.split(':')
url = raw_url = desc = None
attachment = None
if (parts and parts[0] in ('http', 'https', 'ftp')): # absolute
raw_url = url = filespec
desc = url.rsplit('?')[0]
elif filespec.startswith('//'): # server-relative
raw_url = url = filespec[1:]
desc = url.rsplit('?')[0]
elif filespec.startswith('/'): # project-relative
params = ''
if '?' in filespec:
filespec, params = filespec.rsplit('?', 1)
url = formatter.href(filespec)
if params:
url += '?' + params
raw_url, desc = url, filespec
elif len(parts) == 3: # realm:id:attachment-filename
# # or intertrac:realm:id
realm, id, filename = parts
intertrac_target = "%s:%s" % (id, filename)
it = formatter.get_intertrac_url(realm, intertrac_target)
if it:
url, desc = it
raw_url = url + unicode_quote('?format=raw')
else:
attachment = Resource(realm, id).child('attachment', filename)
elif len(parts) == 2:
realm, filename = parts
if realm in browser_links: # source:path
# TODO: use context here as well
rev = None
if '@' in filename:
filename, rev = filename.rsplit('@', 1)
url = formatter.href.browser(filename, rev=rev)
raw_url = formatter.href.browser(filename, rev=rev,
format='raw')
desc = filespec
else: # #ticket:attachment or WikiPage:attachment
# FIXME: do something generic about shorthand forms...
realm = None
id, filename = parts
if id and id[0] == '#':
realm = 'ticket'
id = id[1:]
elif id == 'htdocs':
raw_url = url = formatter.href.chrome('site', filename)
desc = os.path.basename(filename)
else:
realm = 'wiki'
if realm:
attachment = Resource(realm, id).child('attachment',
filename)
elif len(parts) == 1: # it's an attachment of the current resource
attachment = formatter.resource.child('attachment', filespec)
else:
raise TracError('No filespec given')
if attachment and 'ATTACHMENT_VIEW' in formatter.perm(attachment):
url = get_resource_url(self.env, attachment, formatter.href)
raw_url = get_resource_url(self.env, attachment, formatter.href,
format='raw')
try:
desc = get_resource_summary(self.env, attachment)
except ResourceNotFound, e:
raw_url = formatter.href.chrome('common/attachment.png')
desc = _('No image "%(id)s" attached to %(parent)s',
id=attachment.id,
parent=get_resource_name(self.env, attachment.parent))
for key in ('title', 'alt'):
if desc and not key in attr:
attr[key] = desc
if style:
attr['style'] = '; '.join('%s:%s' % (k, escape(v))
for k, v in style.iteritems())
result = tag.img(src=raw_url, **attr)
if link is not None:
result = tag.a(result, href=link or url,
style='padding:0; border:none')
return result
class TracIniMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Produce documentation for the Trac configuration file.
Typically, this will be used in the TracIni page.
Optional arguments are a configuration section filter,
and a configuration option name filter: only the configuration
options whose section and name start with the filters are output.
""")
def expand_macro(self, formatter, name, args):
from trac.config import ConfigSection, Option
section_filter = key_filter = ''
args, kw = parse_args(args)
if args:
section_filter = args.pop(0).strip()
if args:
key_filter = args.pop(0).strip()
registry = ConfigSection.get_registry(self.compmgr)
sections = dict((name, dgettext(section.doc_domain,
to_unicode(section.__doc__)))
for name, section in registry.iteritems()
if name.startswith(section_filter))
registry = Option.get_registry(self.compmgr)
options = {}
for (section, key), option in registry.iteritems():
if section.startswith(section_filter):
options.setdefault(section, {})[key] = option
sections.setdefault(section, '')
def default_cell(option):
default = option.default
if default is True:
default = 'true'
elif default is False:
default = 'false'
elif default == 0:
default = '0.0' if isinstance(default, float) else '0'
elif default:
default = ', '.join(to_unicode(val) for val in default) \
if isinstance(default, (list, tuple)) \
else to_unicode(default)
else:
return tag.td(_("(no default)"), class_='nodefault')
return tag.td(tag.code(default), class_='default')
return tag.div(class_='tracini')(
(tag.h3(tag.code('[%s]' % section), id='%s-section' % section),
format_to_html(self.env, formatter.context, section_doc),
tag.table(class_='wiki')(tag.tbody(
tag.tr(tag.td(tag.tt(option.name)),
tag.td(format_to_oneliner(
self.env, formatter.context,
dgettext(option.doc_domain,
to_unicode(option.__doc__)))),
default_cell(option))
for option in sorted(options.get(section, {}).itervalues(),
key=lambda o: o.name)
if option.name.startswith(key_filter))))
for section, section_doc in sorted(sections.iteritems()))
class RecentChangesMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""List all pages that have recently been modified, ordered by the
time they were last modified.
This macro accepts two ordered arguments and a named argument. The named
argument can be placed in any position within the argument list.
The first parameter is a prefix string: if provided, only pages with names
that start with the prefix are included in the resulting list. If this
parameter is omitted, all pages are included in the list.
The second parameter is the maximum number of pages to include in the
list.
The `group` parameter determines how the list is presented:
`group=date` :: The pages are presented in bulleted lists that are
grouped by date (default).
`group=none` :: The pages are presented in a single bulleted list.
Tip: if you only want to specify a maximum number of entries and
don't want to filter by prefix, specify an empty first parameter,
e.g. `[[RecentChanges(,10,group=none)]]`.
""")
def expand_macro(self, formatter, name, content):
args, kw = parse_args(content)
prefix = args[0].strip() if args else None
limit = int(args[1].strip()) if len(args) > 1 else None
group = kw.get('group', 'date')
sql = """SELECT name, max(version) AS max_version,
max(time) AS max_time FROM wiki"""
args = []
if prefix:
sql += " WHERE name LIKE %s"
args.append(prefix + '%')
sql += " GROUP BY name ORDER BY max_time DESC"
if limit:
sql += " LIMIT %s"
args.append(limit)
entries_per_date = []
prevdate = None
for name, version, ts in self.env.db_query(sql, args):
if not 'WIKI_VIEW' in formatter.perm('wiki', name, version):
continue
req = formatter.req
date = user_time(req, format_date, from_utimestamp(ts))
if date != prevdate:
prevdate = date
entries_per_date.append((date, []))
version = int(version)
diff_href = None
if version > 1:
diff_href = formatter.href.wiki(name, action='diff',
version=version)
page_name = formatter.wiki.format_page_name(name)
entries_per_date[-1][1].append((page_name, name, version,
diff_href))
items_per_date = (
(date, (tag.li(tag.a(page, href=formatter.href.wiki(name)),
tag.small(' (', tag.a('diff', href=diff_href), ')')
if diff_href else None, '\n')
for page, name, version, diff_href in entries))
for date, entries in entries_per_date)
if group == 'date':
out = ((tag.h3(date), tag.ul(entries))
for date, entries in items_per_date)
else:
out = tag.ul((entries)
for date, entries in items_per_date)
return tag.div(out)
class PageOutlineMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Display a structural outline of the current wiki page, each item in the
outline being a link to the corresponding heading.
This macro accepts four optional parameters:
* The first is a number or range that allows configuring the minimum and
maximum level of headings that should be included in the outline. For
example, specifying "1" here will result in only the top-level headings
being included in the outline. Specifying "2-3" will make the outline
include all headings of level 2 and 3, as a nested list. The default is
to include all heading levels.
* The second parameter can be used to specify a custom title (the default
is no title).
* The third parameter selects the style of the outline. This can be
either `inline` or `pullout` (the latter being the default). The
`inline` style renders the outline as normal part of the content, while
`pullout` causes the outline to be rendered in a box that is by default
floated to the right side of the other content.
* The fourth parameter specifies whether the outline is numbered or not.
It can be either `numbered` or `unnumbered` (the former being the
default). This parameter only has an effect in `inline` style.
""")
def expand_macro(self, formatter, name, content):
min_depth, max_depth = 1, 6
title = None
inline = False
numbered = True
if content:
argv = [arg.strip() for arg in content.split(',')]
if len(argv) > 0:
depth = argv[0]
if '-' in depth:
min_depth, max_depth = [int(d)
for d in depth.split('-', 1)]
else:
min_depth = max_depth = int(depth)
if len(argv) > 1:
title = argv[1].strip()
for arg in argv[2:]:
arg = arg.strip().lower()
if arg == 'inline':
inline = True
elif arg == 'unnumbered':
numbered = False
# TODO: - integrate the rest of the OutlineFormatter directly here
# - use formatter.wikidom instead of formatter.source
out = StringIO()
oformatter = OutlineFormatter(self.env, formatter.context)
oformatter.format(formatter.source, out, max_depth, min_depth,
shorten=not inline)
outline = Markup(out.getvalue())
if title:
outline = tag.h4(title) + outline
if not inline:
outline = tag.div(outline, class_='wiki-toc')
elif not numbered:
outline = tag.div(outline, class_='wiki-toc-un')
return outline
class TracIniMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Produce documentation for the Trac configuration file.
Typically, this will be used in the TracIni page.
Optional arguments are a configuration section filter,
and a configuration option name filter: only the configuration
options whose section and name start with the filters are output.
""")
def expand_macro(self, formatter, name, content):
from trac.config import ConfigSection, Option
section_filter = key_filter = ''
args, kw = parse_args(content)
if args:
section_filter = args.pop(0).strip()
if args:
key_filter = args.pop(0).strip()
def getdoc(option_or_section):
doc = to_unicode(option_or_section.__doc__)
if doc:
doc = dgettext(option_or_section.doc_domain, doc)
return doc
registry = ConfigSection.get_registry(self.compmgr)
sections = dict((name, getdoc(section))
for name, section in registry.iteritems()
if name.startswith(section_filter))
registry = Option.get_registry(self.compmgr)
options = {}
for (section, key), option in registry.iteritems():
if section.startswith(section_filter):
options.setdefault(section, {})[key] = option
sections.setdefault(section, '')
def default_cell(option):
default = option.default
if default is not None and default != '':
return tag.td(tag.code(option.dumps(default)),
class_='default')
else:
return tag.td(_("(no default)"), class_='nodefault')
return tag.div(class_='tracini')(
(tag.h3(tag.code('[%s]' % section), id='%s-section' % section),
format_to_html(self.env, formatter.context, section_doc),
tag.table(class_='wiki')(tag.tbody(
tag.tr(tag.td(tag.tt(option.name)),
tag.td(
format_to_html(self.env, formatter.context,
getdoc(option))),
default_cell(option),
class_='odd' if idx % 2 else 'even')
for idx, option in enumerate(
sorted(options.get(section, {}).itervalues(),
key=lambda o: o.name))
if option.name.startswith(key_filter))))
for section, section_doc in sorted(sections.iteritems()))
class MacroListMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Display a list of all installed Wiki macros, including documentation if
available.
Optionally, the name of a specific macro can be provided as an argument. In
that case, only the documentation for that macro will be rendered.
Note that this macro will not be able to display the documentation of
macros if the `PythonOptimize` option is enabled for mod_python!
""")
def expand_macro(self, formatter, name, content):
from trac.wiki.formatter import system_message
content = content.strip() if content else ''
name_filter = content.strip('*')
def get_macro_descr():
for macro_provider in formatter.wiki.macro_providers:
names = list(macro_provider.get_macros() or [])
if name_filter and not any(
name.startswith(name_filter) for name in names):
continue
try:
name_descriptions = [
(name, macro_provider.get_macro_description(name))
for name in names
]
except Exception, e:
yield system_message(
_("Error: Can't get description for macro %(name)s",
name=names[0]), e), names
else:
for descr, pairs in groupby(name_descriptions,
key=lambda p: p[1]):
if descr:
if isinstance(descr, (tuple, list)):
descr = dgettext(descr[0],
to_unicode(descr[1])) \
if descr[1] else ''
else:
descr = to_unicode(descr) or ''
if content == '*':
descr = format_to_oneliner(self.env,
formatter.context,
descr,
shorten=True)
else:
descr = format_to_html(self.env,
formatter.context,
descr)
yield descr, [name for name, descr in pairs]
return tag.div(class_='trac-macrolist')(
(tag.h3(tag.code('[[', names[0], ']]'), id='%s-macro' % names[0]),
len(names) > 1 and tag.p(
tag.strong(_("Aliases:")),
[tag.code(' [[', alias, ']]')
for alias in names[1:]]) or None,
description or tag.em(_("Sorry, no documentation found")))
for description, names in sorted(get_macro_descr(),
key=lambda item: item[1][0]))
class TracIniMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Produce documentation for the Trac configuration file.
Typically, this will be used in the TracIni page. The macro accepts
two ordered arguments and two named arguments.
The ordered arguments are a configuration section filter,
and a configuration option name filter: only the configuration
options whose section and name start with the filters are output.
The named arguments can be specified:
section :: a glob-style filtering on the section names
option :: a glob-style filtering on the option names
""")
def expand_macro(self, formatter, name, content):
from trac.config import ConfigSection, Option
args, kw = parse_args(content)
filters = {}
for name, index in (('section', 0), ('option', 1)):
pattern = kw.get(name, '').strip()
if pattern:
filters[name] = fnmatch.translate(pattern)
continue
prefix = args[index].strip() if index < len(args) else ''
if prefix:
filters[name] = re.escape(prefix)
has_option_filter = 'option' in filters
for name in ('section', 'option'):
filters[name] = re.compile(filters[name], re.IGNORECASE).match \
if name in filters \
else lambda v: True
section_filter = filters['section']
option_filter = filters['option']
section_registry = ConfigSection.get_registry(self.compmgr)
option_registry = Option.get_registry(self.compmgr)
options = {}
for (section, key), option in option_registry.iteritems():
if section_filter(section) and option_filter(key):
options.setdefault(section, {})[key] = option
if not has_option_filter:
for section in section_registry:
if section_filter(section):
options.setdefault(section, {})
for section in options:
options[section] = sorted(options[section].itervalues(),
key=lambda option: option.name)
sections = [(section, section_registry[section].doc
if section in section_registry else '')
for section in sorted(options)]
def default_cell(option):
default = option.default
if default is not None and default != '':
return tag.td(tag.code(option.dumps(default)),
class_='default')
else:
return tag.td(_("(no default)"), class_='nodefault')
def options_table(section, options):
if options:
return tag.table(class_='wiki')(tag.tbody(
tag.tr(tag.td(
tag.a(tag.code(option.name),
class_='tracini-option',
href='#%s-%s-option' % (section, option.name))),
tag.td(
format_to_html(self.env, formatter.context,
option.doc)),
default_cell(option),
id='%s-%s-option' % (section, option.name),
class_='odd' if idx % 2 else 'even')
for idx, option in enumerate(options)))
return tag.div(class_='tracini')(
(tag.h3(tag.code('[%s]' % section), id='%s-section' % section),
format_to_html(self.env, formatter.context, section_doc),
options_table(section, options.get(section)))
for section, section_doc in sections)
class WorkflowMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Render a workflow graph.
This macro accepts a TracWorkflow configuration and renders the states
and transitions as a directed graph. If no parameters are given, the
current ticket workflow is rendered.
In [WikiProcessors WikiProcessor] mode the `width` and `height`
arguments can be specified (Defaults: `width = 800` and `height = 600`).
The repository-scoped path of a workflow file can be specified as either
a macro or !WikiProcessor `file` argument. The file revision can be
specified by appending `@<rev>` to the path. The `file` argument value
must be enclosed in single or double quotes. //(Since 1.3.2)//.
Examples:
{{{
[[Workflow()]]
[[Workflow(go = here -> there; return = there -> here)]]
[[Workflow(file=/contrib/workflow/enterprise-workflow.ini@1)]]
{{{#!Workflow file="/contrib/workflow/enterprise-workflow.ini"
}}}
{{{#!Workflow width=700 height=700
leave = * -> *
leave.operations = leave_status
leave.default = 1
create = <none> -> new
create.default = 1
create_and_assign = <none> -> assigned
create_and_assign.label = assign
create_and_assign.permissions = TICKET_MODIFY
create_and_assign.operations = may_set_owner
accept = new,assigned,accepted,reopened -> accepted
accept.permissions = TICKET_MODIFY
accept.operations = set_owner_to_self
resolve = new,assigned,accepted,reopened -> closed
resolve.permissions = TICKET_MODIFY
resolve.operations = set_resolution
reassign = new,assigned,accepted,reopened -> assigned
reassign.permissions = TICKET_MODIFY
reassign.operations = set_owner
reopen = closed -> reopened
reopen.permissions = TICKET_CREATE
reopen.operations = del_resolution
}}}
}}}
""")
def expand_macro(self, formatter, name, content, args=None):
if content is not None:
content = content.strip()
if not args and not content:
raw_actions = self.config.options('ticket-workflow')
else:
is_macro = args is None
if is_macro:
kwargs = parse_args(content)[1]
file = kwargs.get('file')
else:
file = args.get('file')
if not file and not content:
raise ProcessorError("Invalid argument(s).")
if file:
print(file)
text = RepositoryManager(self.env).read_file_by_path(file)
if text is None:
raise ProcessorError(
tag_("The file %(file)s does not exist.",
file=tag.code(file)))
elif is_macro:
text = '\n'.join(line.lstrip() for line in content.split(';'))
else:
text = content
if '[ticket-workflow]' not in text:
text = '[ticket-workflow]\n' + text
parser = RawConfigParser()
try:
parser.readfp(io.StringIO(text))
except ParsingError as e:
if is_macro:
raise MacroError(exception_to_unicode(e))
else:
raise ProcessorError(exception_to_unicode(e))
raw_actions = list(parser.items('ticket-workflow'))
actions = parse_workflow_config(raw_actions)
states = list(
{state for action in actions.values()
for state in action['oldstates']} |
{action['newstate'] for action in actions.values()})
action_labels = [attrs['label'] for attrs in actions.values()]
action_names = list(actions)
edges = []
for name, action in actions.items():
new_index = states.index(action['newstate'])
name_index = action_names.index(name)
for old_state in action['oldstates']:
old_index = states.index(old_state)
edges.append((old_index, new_index, name_index))
args = args or {}
width = args.get('width', 800)
height = args.get('height', 600)
graph = {'nodes': states, 'actions': action_labels, 'edges': edges,
'width': width, 'height': height}
graph_id = '%012x' % id(graph)
req = formatter.req
add_script(req, 'common/js/workflow_graph.js')
add_script_data(req, {'graph_%s' % graph_id: graph})
return tag(
tag.div('', class_='trac-workflow-graph trac-noscript',
id='trac-workflow-graph-%s' % graph_id,
style="display:inline-block;width:%spx;height:%spx" %
(width, height)),
tag.noscript(
tag.div(_("Enable JavaScript to display the workflow graph."),
class_='system-message')))
class WorkflowMacro(WikiMacroBase):
_domain = 'messages'
_description = cleandoc_(
"""Render a workflow graph.
This macro accepts a TracWorkflow configuration and renders the states
and transitions as a directed graph. If no parameters are given, the
current ticket workflow is rendered. In WikiProcessors mode the `width`
and `height` arguments can be specified.
(Defaults: `width = 800` and `height = 600`)
Examples:
{{{
[[Workflow()]]
[[Workflow(go = here -> there; return = there -> here)]]
{{{
#!Workflow width=700 height=700
leave = * -> *
leave.operations = leave_status
leave.default = 1
accept = new,assigned,accepted,reopened -> accepted
accept.permissions = TICKET_MODIFY
accept.operations = set_owner_to_self
resolve = new,assigned,accepted,reopened -> closed
resolve.permissions = TICKET_MODIFY
resolve.operations = set_resolution
reassign = new,assigned,accepted,reopened -> assigned
reassign.permissions = TICKET_MODIFY
reassign.operations = set_owner
reopen = closed -> reopened
reopen.permissions = TICKET_CREATE
reopen.operations = del_resolution
}}}
}}}
""")
def expand_macro(self, formatter, name, text, args):
if not text:
raw_actions = self.config.options('ticket-workflow')
else:
if args is None:
text = '\n'.join([line.lstrip() for line in text.split(';')])
if not '[ticket-workflow]' in text:
text = '[ticket-workflow]\n' + text
parser = RawConfigParser()
parser.readfp(StringIO(text))
raw_actions = list(parser.items('ticket-workflow'))
actions = parse_workflow_config(raw_actions)
states = list(set(
[state for action in actions.itervalues()
for state in action['oldstates']] +
[action['newstate'] for action in actions.itervalues()]))
action_names = actions.keys()
edges = []
for name, action in actions.items():
new_index = states.index(action['newstate'])
name_index = action_names.index(name)
for old_state in action['oldstates']:
old_index = states.index(old_state)
edges.append((old_index, new_index, name_index))
args = args or {}
graph = {'nodes': states, 'actions': action_names, 'edges': edges,
'width': args.get('width', 800),
'height': args.get('height', 600)}
graph_id = '%012x' % id(graph)
req = formatter.req
add_script(req, 'common/js/excanvas.js', ie_if='IE')
add_script(req, 'common/js/workflow_graph.js')
add_script_data(req, {'graph_%s' % graph_id: graph})
return tag.div(_("Enable JavaScript to display the workflow graph."),
class_='trac-workflow-graph system-message',
id='trac-workflow-graph-%s' % graph_id)
