wiki:TracQuery

Trac Ticket Queries

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

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

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:

No results

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. This also allows displaying the link and description of a single ticket:

[[TicketQuery(id=123)]]

This is displayed as:

No results

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

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

This is displayed as:

No results

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

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

This is displayed as:

0

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:

Results (1 - 3 of 22)

1 2 3 4 5 6 7 8
Ticket Resolution Summary Owner Reporter
#43 invalid Applet not streaming.. purl
#36 fixed Your logo says "Futenbach" bbaren kcr
#35 fixed Permissions error when creating temp files kaduk
1 2 3 4 5 6 7 8

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 22)

1 2 3 4 5 6 7 8
Ticket Resolution Summary Owner Reporter
#43 invalid Applet not streaming.. purl
Description

When I open the applet it freezes...

#36 fixed Your logo says "Futenbach" bbaren kcr
Description

The F-clef is (surprise!) a stylized F. You want a G clef.

#35 fixed Permissions error when creating temp files kaduk
Description

I mentioned briefly on zephyr, but when zsr came back up, jobs submitted from non-cups (or is it non-IPP?) clients were getting stuck in a held state: root@zygorthian-space-raiders:~# lpstat -l -osipbmp3 sipbmp3-13382 kaduk 3861504 Fri 03 Dec 2010 9:18:00 PM EST

Alerts: job-hold-until-specified queued for sipbmp3

(jobs submitted using cups clients played uneventfully)

Looking at /tmp/gutenbach.log , we see a bunch of things like: STDERR FROM SPOOL FILTER Got @ARGV: $VAR1 = [

'13388', 'kaduk', '07 Sell Sell Sell.mp3', '1', 'document-name=07
Sell
Sell
Sell.mp3

job-originating-host-name=SYSTEM-LOW-SIPB.MIT.EDU job-uuid=urn:uuid:e9613623-8429-345f-618c-a7f31183fe60'

];

Odd number of elements in anonymous hash at /usr/lib/cups/backend/gutenbach line 72. Error in tempfile() using gutenbachXXXXX: Could not create temp file gutenbacheAbjj: Permission denied at /usr/lib/cups/backend/gutenbach line 85

There is more in /var/log/cups/error_log (.1.gz at the moment), but it is less interesting: D [03/Dec/2010:21:03:56 -0500] [Job 13381] The following messages were recorded from 09:03:56 PM to 09:03:56 PM D [03/Dec/2010:21:03:56 -0500] [Job 13381] Job submission timed out. D [03/Dec/2010:21:03:56 -0500] [Job 13381] Sending job to queue tagged as raw... D [03/Dec/2010:21:03:56 -0500] [Job 13381] job-sheets=standard D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[0]="sipbmp3" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[1]="13381" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[2]="kaduk" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[3]="07 Sell Sell Sell.mp3" [...] D [03/Dec/2010:21:03:56 -0500] [Job 13381] envp[27]="CUPS_FILETYPE=job-sheet" D [03/Dec/2010:21:03:56 -0500] [Job 13381] Started filter /usr/lib/cups/filter/gziptoany (PID 29625) D [03/Dec/2010:21:03:56 -0500] [Job 13381] Started backend /usr/lib/cups/backend/gutenbach (PID 29626) D [03/Dec/2010:21:03:56 -0500] [Job 13381] Sending job to queue tagged as raw... D [03/Dec/2010:21:03:56 -0500] [Job 13381] job-sheets=standard D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[0]="sipbmp3" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[1]="13381" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[2]="kaduk" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[3]="07 Sell Sell Sell.mp3" D [03/Dec/2010:21:03:56 -0500] [Job 13381] envp[27]="CUPS_FILETYPE=job-sheet" D [03/Dec/2010:21:03:56 -0500] [Job 13381] Started filter /usr/lib/cups/filter/gziptoany (PID 29625) D [03/Dec/2010:21:03:56 -0500] [Job 13381] Started backend /usr/lib/cups/backend/gutenbach (PID 29626) D [03/Dec/2010:21:03:56 -0500] [Job 13381] Sending job to queue tagged as raw... D [03/Dec/2010:21:03:56 -0500] [Job 13381] job-sheets=standard D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[0]="sipbmp3" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[1]="13381" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[2]="kaduk" D [03/Dec/2010:21:03:56 -0500] [Job 13381] argv[3]="07 Sell Sell Sell.mp3" [...] D [03/Dec/2010:21:03:56 -0500] [Job 13381] Started filter /usr/lib/cups/filter/gziptoany (PID 29627) D [03/Dec/2010:21:03:56 -0500] [Job 13381] PAGE: 1 1 D [03/Dec/2010:21:03:56 -0500] [Job 13381] PAGE: 1 1 D [03/Dec/2010:21:03:56 -0500] [Job 13381] Backend returned status 13 (unknown) D [03/Dec/2010:21:03:56 -0500] [Job 13381] End of messages D [03/Dec/2010:21:03:56 -0500] [Job 13381] printer-state=3(idle) D [03/Dec/2010:21:03:56 -0500] [Job 13381] printer-state-message="/usr/lib/cups/filter/gziptoany failed" D [03/Dec/2010:21:03:56 -0500] [Job 13381] printer-state-reasons=none E [03/Dec/2010:21:04:46 -0500] PID 30115 (/usr/lib/cups/filter/gziptoany) crashed on signal 13!

So the gziptoany filter's error is what is shown in the super-verbose lpstat output, which is a bit confusing to users.

Going back to the error in gutenbach.log, it's coming from here:

69 # If we weren't given a filename, we need to read from stdin. Since 70 # mplayer really wants a file, let's write out to a temporary file 71 # first. 72 if (!$arguments{"file"}) { 73 my ($fh, $file) = tempfile("gutenbachXXXXX", UNLINK => 1); # Ask File::Temp for a safe temporary file 74 my $buf; 75 while (read(STDIN, $buf, 1024*1024)) { # Read 1M at a time and put it in the temporary file 76 print $fh $buf; 77 } 78 close($fh); 79 $arguments{"file"} = $file; 80 }

The call to tempfile() on line 73 fails, I presume because it is running as an unprivileged user (lp?) in a PWD (/root ?) that it is not authorized to write to. The workaround that I put in place was to just hardcode the tempfile path to begin in /tmp -- but I'm not very happy with that, not knowing for sure where it was trying to write and as what user.

1 2 3 4 5 6 7 8

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

Last modified 5 years ago Last modified on Sep 5, 2014, 1:28:38 PM