Edgewall Software

This page documents the 1.1 release. Documentation for other releases can be found here.

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, which can be used to display tickets that meet specified criteria.

To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.

Filters

When you first go to the query page, the default filter will display tickets relevant to you:

  • If logged in then all open tickets, it will display open tickets assigned to you.
  • If not logged in but you have specified a name or email address in the preferences, then it will display all open tickets where your email (or name if email not defined) is in the CC list.
  • If not logged in and no name/email is defined in the preferences, then all open issues are displayed.

Current filters can be removed by clicking the button to the left with the minus sign on the label. New filters are added from the pulldown lists at the bottom corners of the filters box; 'And' conditions on the left, 'Or' conditions on the right. Filters with either a text box or a pulldown menu of options can be added multiple times to perform an Or on the criteria.

You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.

After you have edited your filters, click the Update button to refresh your results.

Some shortcuts can be used to manipulate checkbox filters.

  • Clicking on a filter row label toggles all checkboxes.
  • Pressing the modifier key while clicking on a filter row label inverts the state of all checkboxes.
  • Pressing the modifier key while clicking on a checkbox selects the checkbox and deselects all other checkboxes in the filter.

The modifier key is platform and browser dependent. On Mac the modified key is Option/Alt or Command. On Linux the modifier key is Ctrl + Alt. Opera on Windows seems to use Ctrl + Alt, while Alt is effective for other Windows browsers.

Clicking on one of the query results will take you to that ticket. You can navigate through the results by clicking the Next Ticket or Previous Ticket links just below the main menu bar, or click the Back to Query link to return to the query page.

You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Query links after saving your results. When you return to the query any tickets which were edited will be displayed with italicized text. If one of the tickets was edited such that it no longer matches the query criteria , the text will also be greyed. Lastly, if a new ticket matching the query criteria has been created, it will be shown in bold.

The query results can be refreshed and cleared of these status indicators by clicking the Update button again.

Saving Queries

Trac allows you to save the query as a named query accessible from the reports module. To save a query ensure that you have Updated the view and then click the Save query button displayed beneath the results. You can also save references to queries in Wiki content, as described below.

Note: one way to easily build queries like the ones below, you can build and test the queries in the Custom report module and when ready - click Save query. This will build the query string for you. All you need to do is remove the extra line breaks.

Note: you must have the REPORT_CREATE permission in order to save queries to the list of default reports. The Save query button will only appear if you are logged in as a user that has been granted this permission. If your account does not have permission to create reports, you can still use the methods below to save a query.

You may want to save some queries so that you can come back to them later. You can do this by making a link to the query from any Wiki page.

[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

Which is displayed as:

Active tickets against 1.0

This uses a very simple query language to specify the criteria, see Query Language.

Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character:

[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

Which is displayed as:

Assigned tickets by owner

Customizing the table format

You can also customize the columns displayed in the table format (format=table) by using col≤field>. You can specify multiple fields and what order they are displayed in 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 also have full rows by 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 11285)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13762 fixed Request.write with an empty str instance doesn't raise ValueError Jun Omae Jun Omae
Description
>>> from trac.test import EnvironmentStub, MockRequest
>>> env = EnvironmentStub()
>>> req = MockRequest(env)
>>> req.send(u'unicode contents')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 900, in send
    self._send(content, content_type, status)
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 1036, in _send
    self.write(content)
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 996, in write
    raise ValueError("Can't send str content")
ValueError: Can't send str content
>>> req.send(u'')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 900, in send
    self._send(content, content_type, status)
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 1037, in _send
    raise RequestDone
trac.web.api.RequestDone

Patch:

  • trac/web/api.py

    diff --git a/trac/web/api.py b/trac/web/api.py
    index 383db0a06..7f8b59bdc 100644
    a b class Request(object):  
    982982        there are multiple calls to `write`, to the cumulative length
    983983        of the *data* arguments.
    984984        """
     985        if isinstance(data, str):
     986            raise ValueError("Can't send str content")
    985987        if not self._write:
    986988            self.end_headers()
    987989        try:
  • trac/web/tests/api.py

    diff --git a/trac/web/tests/api.py b/trac/web/tests/api.py
    index 01010e120..bd14c1010 100644
    a b new\r\n\  
    440440        # anyway we're not supposed to send unicode, so we get a ValueError
    441441        with self.assertRaises(ValueError):
    442442            req.write('Föö')
     443        with self.assertRaises(ValueError):
     444            req.write('')
    443445        with self.assertRaises(ValueError):
    444446            req.write((b'F', 'öo'))
     447        with self.assertRaises(ValueError):
     448            req.write(('Föo'.encode('utf-8'), ''))
    445449
    446450    def test_send_iterable(self):
    447451        def iterable():
  • trac/web/tests/main.py

    diff --git a/trac/web/tests/main.py b/trac/web/tests/main.py
    index 1dfdd8164..d1cfbb338 100644
    a b class AuthenticateTestCase(unittest.TestCase):  
    9090            def process_request(self, req):
    9191                self.calls += 1
    9292                req.authname
    93                 req.send('')
     93                req.send(b'')
    9494
    9595        cls.authenticators['success1'] = SuccessfulAuthenticator1
    9696        cls.authenticators['success2'] = SuccessfulAuthenticator2
#13761 fixed Content-Length not sent from Request.send with a bytes instance Jun Omae Jun Omae
Description

When a bytes instance is passed to Request.send, Content-Length header is not sent. When a unicode instance is passed, the header wrongly is set (and the method fails with ValueError).

>>> from trac.test import EnvironmentStub, MockRequest
>>> env = EnvironmentStub()
>>> req = MockRequest(env)
>>> req.send(b'bytes data')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 900, in send
    self._send(content, content_type, status)
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 1037, in _send
    raise RequestDone
trac.web.api.RequestDone
>>> req.response_sent.getvalue()
b'bytes data'
>>> req.headers_sent
{'Cache-Control': 'must-revalidate', 'Expires': 'Fri, 01 Jan 1999 00:00:00 GMT', 'Content-Type': 'text/html;charset=utf-8'}
>>>
>>> req = MockRequest(env)
>>> req.send(u'unicode data')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 900, in send
    self._send(content, content_type, status)
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 1036, in _send
    self.write(content)
  File "/home/jun66j5/src/tracdev/git/trac/web/api.py", line 996, in write
    raise ValueError("Can't send str content")
ValueError: Can't send str content
>>> req.headers_sent
{'Cache-Control': 'must-revalidate', 'Expires': 'Fri, 01 Jan 1999 00:00:00 GMT', 'Content-Type': 'text/html;charset=utf-8', 'Content-Length': '12'}
  • trac/web/api.py

    diff --git a/trac/web/api.py b/trac/web/api.py
    index 383db0a06..95a060ce0 100644
    a b class Request(object):  
    10281028        self.send_header('Cache-Control', 'must-revalidate')
    10291029        self.send_header('Expires', 'Fri, 01 Jan 1999 00:00:00 GMT')
    10301030        self.send_header('Content-Type', content_type + ';charset=utf-8')
    1031         if isinstance(content, str):
     1031        if isinstance(content, bytes):
    10321032            self.send_header('Content-Length', len(content))
    10331033        self.end_headers(exc_info)
    10341034
  • trac/web/tests/api.py

    diff --git a/trac/web/tests/api.py b/trac/web/tests/api.py
    index 01010e120..589dd8650 100644
    a b new\r\n\  
    443443        with self.assertRaises(ValueError):
    444444            req.write((b'F', 'öo'))
    445445
     446    def test_send_bytes(self):
     447        req = _make_req(_make_environ(method='GET'))
     448        with self.assertRaises(RequestDone):
     449            req.send(b'\xef\xbb\xbf')
     450        self.assertEqual('3', req.headers_sent.get('Content-Length'))
     451
     452    def test_send_unicode(self):
     453        req = _make_req(_make_environ(method='GET'))
     454        with self.assertRaises(ValueError):
     455            req.send(u'\ufeff')
     456
    446457    def test_send_iterable(self):
    447458        def iterable():
    448459            yield b'line1,'
#13760 fixed threaded_comments.js should be added using add_script rather than directly from ticket.html Jun Omae Jun Omae
Description

The threaded_comments.js is added directly from ticket.html. I think it should be added using add_script rather than. Currently only this script is added from templates.

$ git grep -n htdocs_location mirror/1.6-stable -- '*.html'
mirror/1.6-stable:trac/templates/about.html:28:        <img src="${chrome.htdocs_location}trac_banner.png"
mirror/1.6-stable:trac/templates/about.html:56:        <img src="${chrome.htdocs_location}python.png"
mirror/1.6-stable:trac/templates/theme.html:147:         ><img src="${chrome.htdocs_location}trac_logo_mini.png" height="30"
mirror/1.6-stable:trac/ticket/templates/ticket.html:33:    <script src="${chrome.htdocs_location}js/threaded_comments.js"></script>
$ git grep -n '<script\s*src=' mirror/1.6-stable -- '*.html'
mirror/1.6-stable:trac/ticket/templates/ticket.html:33:    <script src="${chrome.htdocs_location}js/threaded_comments.js"></script>
  • trac/ticket/templates/ticket.html

    diff --git a/trac/ticket/templates/ticket.html b/trac/ticket/templates/ticket.html
    index db9d278d3..781bf775a 100644
    a b  
    2929
    3030    ${ super() }
    3131
    32     # if ticket.exists:
    33     <script src="${chrome.htdocs_location}js/threaded_comments.js"></script>
    34     # endif
    3532    <script>
    3633      jQuery(function($) {
    3734        $("div.description").find("h1,h2,h3,h4,h5,h6")
  • trac/ticket/web_ui.py

    diff --git a/trac/ticket/web_ui.py b/trac/ticket/web_ui.py
    index 79e152c87..fa32d643c 100644
    a b class TicketModule(Component):  
    757757                              'changes': data['changes'],
    758758                              })
    759759        add_stylesheet(req, 'common/css/ticket.css')
     760        add_script(req, 'common/js/threaded_comments.js')
    760761        chrome = Chrome(self.env)
    761762        chrome.add_wiki_toolbars(req)
    762763        if not data['disable_submit']:
1 2 3 4 5 6 7 8 9 10 11

Query Language

query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Filters are separated by ampersands (&). Each filter consists of the ticket field name, an operator and one or more values. More than one value are separated by a pipe (|), meaning that the filter matches any of the values. To include a literal & or | in a value, escape the character with a backslash (\).

The available operators are:

= the field content exactly matches one of the values
~= the field content contains one or more of the values
^= the field content starts with one of the values
$= the field content ends with one of the values

All of these operators can also be negated:

!= the field content matches none of the values
!~= the field content does not contain any of the values
!^= the field content does not start with any of the values
!$= the field content does not end with any of the values

The date fields created and modified can be constrained by using the = operator and specifying a value containing two dates separated by two dots (..). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be omitted to avoid having to quote the query string.

created=2007-01-01..2008-01-01 query tickets created in 2007
created=lastmonth..thismonth query tickets created during the previous month
modified=1weekago.. query tickets that have been modified in the last week
modified=..30daysago query tickets that have been inactive for the last 30 days

See also: TracTickets, TracReports, TracGuide, TicketQuery

Last modified 9 years ago Last modified on Aug 31, 2015, 4:52:42 AM
Note: See TracWiki for help on using the wiki.