Edgewall Software

This page documents the 1.4 (latest stable) release. Documentation for other releases can be found here.

TicketQuery Wiki Macro

The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. The query language used by the [[TicketQuery]] macro is described in the TracQuery page.

Usage

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value".

If the key is the name of a field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage. Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character. Commas (,) can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a literal or argument.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is presented:

  • list — the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
  • compact — the tickets are presented as a comma-separated list of ticket IDs.
  • count — only the count of matching tickets is displayed
  • rawcount — only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
  • table — a view similar to the custom query view (but without the controls)
  • progress — a view similar to the milestone progress bars

The max parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets (defaults to id).

The desc parameter indicates whether the order of the tickets should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets (defaults to not being set).

The groupdesc parameter indicates whether the natural display order of the groups should be reversed (defaults to false).

The verbose parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the rows parameter

The rows parameter can be used to specify which field(s) should be viewed as a row, e.g. rows=description|summary

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format. Also, using "&" as a field separator still works (except for order) but is deprecated.

Examples

Example Result Macro
Number of Triage tickets: 22 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 1052 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 3 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 14 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 1510 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1412 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 2182 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 986 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 4489 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 23 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 12225 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1829 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 1 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 13 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 12 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 1 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 24 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 25 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 1 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #3162, #7452, #978 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:

[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]

Ticket Owner Reporter
#1 anonymous
Summary Add a new project summary module.

Format: list

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

#181
Wiki preview injects new lines
#204
request for colour legend (or something similar) for ticket groups in reports
#226
Ticket Dependencies
#239
Link to diff of specifik wiki change instead of the page itself
#351
All ticket modifications should be tracked in timeline
#413
Installing on Windows, drive other than C:
#450
Diffviewer should try to convert the text into utf-8.
#475
merging of similar tickets
#519
Python process sometimes hangs on Windows Server 2003
#529
IE 5-6 over HTTPS broken downloads

[[TicketQuery(id=123)]]

This is displayed as:

#123
No SQL error display

Format: compact

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

#181, #204, #226, #239, #351, #413, #450, #475, #519, #529

Format: count

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

10

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

defect

5 / 5

enhancement

2 / 2

Format: table

You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed by placing pipes (|) between the columns:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Full rows

In table format you can specify full rows using rows=<field>:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]

This is displayed as:

Results (1 - 3 of 11156)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13405 fixed Git version rendered with bytes type representation on System Information table Ryan J Ollos Ryan J Ollos
Description

#13404 fixed ImportError: cannot import name 'soft_unicode' from 'jinja2.utils' with Jinja2 3.0.x Jun Omae Jun Omae
Description
======================================================================
ERROR: test (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: test
Traceback (most recent call last):
  File "/opt/python/3.9.1/lib/python3.9/unittest/loader.py", line 154, in loadTestsFromName
    module = __import__(module_name)
  File "/home/travis/build/edgewall/trac/trac/test.py", line 47, in <module>
    from trac.env import Environment
  File "/home/travis/build/edgewall/trac/trac/env.py", line 52, in <module>
    from trac.web.chrome import Chrome
  File "/home/travis/build/edgewall/trac/trac/web/chrome.py", line 40, in <module>
    from trac.mimeview.api import RenderingContext, get_mimetype
  File "/home/travis/build/edgewall/trac/trac/mimeview/__init__.py", line 14, in <module>
    from trac.mimeview.api import *
  File "/home/travis/build/edgewall/trac/trac/mimeview/api.py", line 70, in <module>
    from trac.resource import Resource
  File "/home/travis/build/edgewall/trac/trac/resource.py", line 21, in <module>
    from trac.util.presentation import classes
  File "/home/travis/build/edgewall/trac/trac/util/presentation.py", line 26, in <module>
    from jinja2.utils import soft_unicode
ImportError: cannot import name 'soft_unicode' from 'jinja2.utils' (/home/travis/virtualenv/python3.9.1/lib/python3.9/site-packages/jinja2/utils.py)

Jinja2 2.11.3 says the following warning when calling soft_unicode() but no warnings when importing it.

$ ~/venv/py39/bin/python
Python 3.9.4 (default, Apr  9 2021, 01:15:05)
[GCC 5.4.0 20160609] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import jinja2
>>> jinja2.__version__
'2.11.3'
>>> from jinja2.utils import soft_unicode
>>> soft_unicode('***')
<stdin>:1: DeprecationWarning: 'jinja2.utils.soft_unicode' will be removed in version 3.0. Use 'markupsafe.soft_unicode' instead.
'***'
#13403 fixed Trac 1.5.3 with Apache+fcgi and Python 3.8.10 doesn't work Jun Omae bobben@…
Description

Hi!

Just tried Trac 1.5.3 which is supposed to run on Python 3.5+ but I can't get it to work.

Running track-admin works fine, such as these commands:

sudo trac-admin /www/trac upgrade
sudo trac-admin /www/trac wiki upgrade
sudo trac-admin /www/trac deploy /www/trac/deploy
sudo trac-admin /www/trac repository resync '*'

But the front-end won't work.

I get this error in my Apache logs:

Content-Type: text/plain

 Oops...

Trac detected an internal error:

No module named 'dummy_thread'

Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/trac/web/_fcgi.py", line 53, in <module>
    import thread
ModuleNotFoundError: No module named 'thread'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Library/WebServer/CGI-Executables/trac.fcgi", line 33, in <module>
    from trac.web import fcgi_frontend
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/trac/web/fcgi_frontend.py", line 51, in <module>
    from ._fcgi import WSGIServer
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/trac/web/_fcgi.py", line 57, in <module>
    import dummy_thread as thread
ModuleNotFoundError: No module named 'dummy_thread'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Library/WebServer/CGI-Executables/trac.fcgi", line 47, in <module>
    tb = io.Bytes()
AttributeError: module 'io' has no attribute 'Bytes'
[Tue May 11 00:02:50.663862 2021] [:warn] [pid 11858:tid 123145536704512] mod_fcgid: error reading data, FastCGI server closed connection
[Tue May 11 00:02:50.663958 2021] [:error] [pid 11858:tid 123145536704512] End of script output before headers: trac.fcgi

So I Googled and found that you could create a thread.py file (with some content) in the site-packages directory which fixed the problem "no module named 'thread'", but then I got this error message instead:

Content-Type: text/plain

 Oops...

Trac detected an internal error:

'OSError' object is not subscriptable

Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/trac/web/_fcgi.py", line 987, in _setupSocket
    sock.getpeername()
OSError: [Errno 57] Socket is not connected

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Library/WebServer/CGI-Executables/trac.fcgi", line 34, in <module>
    fcgi_frontend.run()
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/trac/web/fcgi_frontend.py", line 54, in run
    WSGIServer(dispatch_request, **params).run()
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/trac/web/_fcgi.py", line 1064, in run
    sock = self._setupSocket()
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/trac/web/_fcgi.py", line 989, in _setupSocket
    if e[0] == errno.ENOTSOCK:
TypeError: 'OSError' object is not subscriptable

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Library/WebServer/CGI-Executables/trac.fcgi", line 47, in <module>
    tb = io.Bytes()
AttributeError: module 'io' has no attribute 'Bytes'
[Mon May 10 23:18:28.531449 2021] [:warn] [pid 11858:tid 123145537777664] mod_fcgid: error reading data, FastCGI server closed connection
[Mon May 10 23:18:28.531739 2021] [:error] [pid 11858:tid 123145537777664] End of script output before headers: trac.fcgi

I am using the latest trac.fcgi from installation of Trac 1.5.3, which points to the Python 3.8 binary and the trac.fcgi file has execute permissions for the 'www' user of Apache.

Some googling suggested that the error 'End of script output' and Apache error 500 is because of insufficient execute permissions of the trac.fcgi in the cgi-bin for Apache.

Used 'r-x------' (500) for user 'www' successfully with Python 2.7 and Trac 1.4.2, but even tried 'r-x--x--x' (511) with this new version, but doesn't help.

I'm currently running Apache 2.4.46, mod_fcgid 2.3.9, subversion 1.14.1 and Python 3.8.10 on macOS 10.13.6.

Kind regards Pär

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 21 months ago Last modified on Oct 15, 2019, 6:35:53 AM
Note: See TracWiki for help on using the wiki.