Edgewall Software

Version 28 (modified by Steffen Hoffmann, 13 years ago) ( diff )

add new macro-based language navigation

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

Note: this page documents the 0.12 version of Trac, see 0.11/TracQuery if you need the previous version

Trac Ticket Queries

Languages:

In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of 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 and no name/email defined in the preferences then all open issues are displayed.

Current filters can be removed by clicking the button to the right 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 of 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.

Once you've edited your filters click the Update button to refresh your results.

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.

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

Using the [[TicketQuery]] Macro

The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example:

[[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

Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language.

A more compact representation without the ticket summaries is also available:

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

This is displayed as:

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

Finally if you wish to receive only the number of defects that match the query using the count parameter.

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

This is displayed as:

10

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 by placing pipes (|) between the columns like below:

[[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> like below:

[[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 11263)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13747 fixed IndexError raised from GitRepository.normalize_rev('FFFF') if the repository has 5000+ revisions Jun Omae Jun Omae
Description
Traceback (most recent call last):
  File "/venv/lib/python2.7/site-packages/trac/timeline/web_ui.py", line 198, in process_request
    filters) or []:
  File "/venv/lib/python2.7/site-packages/trac/versioncontrol/web_ui/changeset.py", line 917, in get_timeline_events
    for event in generate_changesets(repos):
  File "/venv/lib/python2.7/site-packages/trac/versioncontrol/web_ui/changeset.py", line 892, in generate_changesets
    for cset in changesets:
  File "/venv/lib/python2.7/site-packages/tracopt/versioncontrol/git/git_fs.py", line 72, in get_changesets
    csets = list(csets)
  File "/venv/lib/python2.7/site-packages/trac/versioncontrol/cache.py", line 82, in get_changesets
    yield self.get_changeset(rev)
  File "/venv/lib/python2.7/site-packages/tracopt/versioncontrol/git/git_fs.py", line 85, in get_changeset
    return GitCachedChangeset(self, self.normalize_rev(rev), self.env)
  File "/venv/lib/python2.7/site-packages/tracopt/versioncontrol/git/git_fs.py", line 56, in normalize_rev
    normrev = self.repos.git.verifyrev(rev)
  File "/venv/lib/python2.7/site-packages/tracopt/versioncontrol/git/PyGIT.py", line 710, in verifyrev
    fullrev = self.fullrev(rev)
  File "/venv/lib/python2.7/site-packages/tracopt/versioncontrol/git/PyGIT.py", line 780, in fullrev
    srevs = _rev_cache.srev_dict[self.__rev_key(srev)]
IndexError: list index out of range

git-data.sh

#! /bin/sh
n="$1"
echo 'blob'
echo 'mark :1'
echo 'data 0'
echo
echo 'reset refs/heads/master'
for i in $(seq 1 "$n"); do
    ts=$((999999999 + $i))
    echo 'commit refs/heads/master'
    echo 'mark :2'
    echo "author Joe <joe@example.com> $ts +0000"
    echo "committer Joe <joe@example.com> $ts +0000"
    echo 'data 2'
    echo '.'
    echo 'M 100644 :1 .gitignore'
    echo
done

Creating test repository with 5,500 revisions

$ git init --bare /dev/shm/git-repos
$ /dev/shm/git-data.sh 5500 | git --git-dir /dev/shm/git-repos fast-import
$ git --git-dir /dev/shm/git-repos rev-list --all | wc -l
5500
$ git --git-dir /dev/shm/git-repos rev-list --all | sed -e 's/^\(....\).*/\1/' | sort -u | wc -l
5272
$ git --git-dir /dev/shm/git-repos rev-list --all | sed -e 's/^\(....\).*/\1/' | sort -u | tail -1
fff9

Trying GitRepository.normalize_rev('FFFF')

$ (cd / && ~/venv/trac/1.6/bin/python)
Python 3.11.9 (main, Apr  6 2024, 17:59:24) [GCC 9.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from trac.test import EnvironmentStub
>>> from tracopt.versioncontrol.git.git_fs import GitConnector
>>> env = EnvironmentStub()
>>> connector = GitConnector(env)
>>> repos = connector.get_repository('git', '/dev/shm/git-repos', {'id': 42, 'name': ''})
>>> repos.git.rev_cache
RevCache(youngest_rev=b'39f74414152cc0645367502e8d05a83e34f9c084', oldest_rev=b'86989f7deb1be18dcb970f221d017c58417c56a2', rev_dict=5500 entries, refs_dict=2 entries, srev_dict=65530 entries)
>>> type(repos.git.rev_cache.srev_dict)
<class 'list'>
>>> repos.normalize_rev('FFFF')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/jun66j5/venv/trac/1.6/lib/python3.11/site-packages/tracopt/versioncontrol/git/git_fs.py", line 569, in normalize_rev
    normrev = self.git.verifyrev(rev)
              ^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jun66j5/venv/trac/1.6/lib/python3.11/site-packages/tracopt/versioncontrol/git/PyGIT.py", line 796, in verifyrev
    result = get_verifyrev(self._fs_from_unicode(rev))
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jun66j5/venv/trac/1.6/lib/python3.11/site-packages/tracopt/versioncontrol/git/PyGIT.py", line 771, in get_verifyrev
    fullrev = self.fullrev(rev)
              ^^^^^^^^^^^^^^^^^
  File "/home/jun66j5/venv/trac/1.6/lib/python3.11/site-packages/tracopt/versioncontrol/git/PyGIT.py", line 847, in fullrev
    srevs = _rev_cache.srev_dict[self.__rev_key(rev)]
            ~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^
IndexError: list index out of range
>>> repos.normalize_rev('FFF9')
'fff9a43563e57b091ed4a44ffa3e244082f51175'
>>> repos.git.rev_cache.srev_dict[0xFFF9]
(b'fff9a43563e57b091ed4a44ffa3e244082f51175',)

Patch

  • tracopt/versioncontrol/git/PyGIT.py

    diff --git a/tracopt/versioncontrol/git/PyGIT.py b/tracopt/versioncontrol/git/PyGIT.py
    index e1e660b19..62f0a4bf0 100644
    a b class Storage(object):  
    845845
    846846        try:
    847847            srevs = _rev_cache.srev_dict[self.__rev_key(rev)]
    848         except KeyError:
     848        except (KeyError, IndexError):
    849849            return None
    850850
    851851        resolved = None
#13744 fixed [PATCH] SpamFilter: Support pillow 10 for ImageCaptcha Dirk Stöcker niels.reedijk@…
Description

Currently the ImageCaptcha component is not compatible with a modern pillow, due to API changes. This patch makes it compatible with Pillow 10 (tested with 10.2.0) and bumps the minimum required version.

#13742 fixed spamfilter.bayes is missing a dependency Dirk Stöcker bmispelon
Description

Hi,

We recently updated our Trac instance to 1.6 (thanks for the release by the way) and were hit by a spam wave almost immediately after. We're using the TracSpamFilter plugin [1] (https://trac.edgewall.org/browser/plugins/trunk/spam-filter?rev=17752&format=zip is the line in our requirements file) but somehow the bots were still getting around it.

After scratching our heads for a few ours, we finally saw this in the log:

01:30:52 PM Trac[loader] ERROR: Skipping "spamfilter.bayes = tracspamfilter.filters.bayes": ModuleNotFoundError: No module named 'filelock'

As far as I could find, the requirement for filelock is not listed anywhere on the plugin page [2] either.

[1] https://pypi.org/project/TracSpamFilter/ [2] https://trac.edgewall.org/wiki/SpamFilter

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. Basically, the filters are separated by ampersands (&). Each filter then 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 litteral & 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 left out 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

Note: See TracWiki for help on using the wiki.