wiki:TicketQuery

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: 57 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 42 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 23 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 13 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 19 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 28 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 463 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 27 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 823 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 0 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 2 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 0 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 0 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 0 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 0 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 0 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 0 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #826, #825, #414 [[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 Olly Betts Olly Betts
Summary Put Xapian in a namespace

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

#123
Adding large documents to remote db may cause a timeout

Format: compact

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

This is displayed as:

No results

Format: count

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

This is displayed as:

0

Format: progress

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

This is displayed as:

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:

Results (1 - 3 of 723)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#824 fixed Out-of-bounds array access on table open if root info level is corrupt Olly Betts group13
#823 fixed Unit test ioblock1 failure Olly Betts someplaceguy
#821 fixed SOCKLEN_T not defined when compiling with mingw32. Olly Betts mgautier
1 2 3 4 5 6 7 8 9 10 11

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#824 fixed Out-of-bounds array access on table open if root info level is corrupt Olly Betts group13
Description

In the Glass backend, the RootInfo level field comes from disk and is used before it is checked, which means that e.g. this snippet...

void
GlassTable::basic_open(const RootInfo * root_info, glass_revision_number_t rev)
{
    ...
    level =		   root_info->get_level();
    ...
    for (int j = 0; j <= level; ++j) {
	C[j].init(block_size);
    }

...is UB if the level in the file exceeds BTREE_CURSOR_LEVELS for whatever reason (perhaps file corruption on disk). If so, even if the table is otherwise unused, this runs past the end of the C array here and again when the GlassTable is destroyed. In practice, this results in a segmentation fault/crash; because it happens so early, it cannot be recovered through xapian-check.

We would instead expect that a Xapian::DatabaseCorruptError or similar would be thrown in this case.

We've confirmed that this happens with 1.4.24, on Linux, using the Glass backend in single-file mode. The Chert backend may be affected as well.

This issue was found by running the AFL++ fuzzer to generate corrupted single-file Glass database files.

#823 fixed Unit test ioblock1 failure Olly Betts someplaceguy
Description

The ioblock1 unit test is failing for me on Xapian 1.4.24:

$ ./runtest ./unittest -v ioblock1
Running test: ioblock1... FAILED
unittest.cc:945: (statbuf.st_blocks) >= (BLOCK_SIZE / 512 * 2)
Evaluates to: 1 >= 4

The issue seems to be that the unit test expects the filesystem to allocate at least 2048 bytes (i.e. 4 * 512B) for this file.

However, I'm running ZFS with compression enabled (which is a very common configuration for ZFS), but for this file, ZFS only allocates 512 bytes worth of data:

$ hexdump -C .unittest_ioutils1
00000000  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |................|
*
00000400  78 78 78 78 78 78 78 78  78 78 78 78 78 78 78 78  |xxxxxxxxxxxxxxxx|
*
00000800  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |................|
*
00003000  78 78 78 78 78 78 78 78  78 78 78 78 78 78 78 78  |xxxxxxxxxxxxxxxx|
*
00003400

$ stat .unittest_ioutils1
  File: .unittest_ioutils1
  Size: 13312           Blocks: 1          IO Block: 13312  regular file
Device: 0,30    Inode: 4497130     Links: 1
Access: (0644/-rw-r--r--)  Uid: (30001/ nixbld1)   Gid: (30000/  nixbld)
Access: 2023-12-19 20:37:53.120683138 +0000
Modify: 2023-12-19 20:44:54.815831585 +0000
Change: 2023-12-19 20:44:54.815831585 +0000
 Birth: 2023-12-19 20:37:53.120683138 +0000
#821 fixed SOCKLEN_T not defined when compiling with mingw32. Olly Betts mgautier
Description

Cross compilation of xapian fails when cross-compiling from linux to windows using mingw32.

To provided patch fix the compilation. Another way to fix it is to replace SOCKLEN_T with int as it is how it is defined in ws2tcpip.h

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 4 years ago Last modified on 24/11/19 00:43:22
Note: See TracWiki for help on using the wiki.