Edgewall Software

This page documents the 1.0 (latest stable) release. See 0.12/TracQuery if you need the previous version.

Trac Ticket Queries

Languages:

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

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#12594 cantfix Not recieving email notification when using trac API's labraham@…
Description

I am using the trac API's - ticket.create, ticket.update to create and update new tickets on our trac system. However when I use them I do not get email notifications for anything.

If the same actions are executed using UI, I successfully get the email notifications. Please let me know if there are any configurations by changing which I can get emails for updates done using API's as well or let me know if anything else has to be done.

Below mentioned are the details of the the trac server :

Trac Version:  Trac 1.0.11
Operating System : CentOS Linux release 7.2.1511
Python version used : Python 2.7.5 (rpm)
Database backend and their bindings if relevant : Sqlite3 bundled with Trac
The versioning system and their bindings if relevant : You are not using any versioning system associated with Trac

Let me know if any additional details are required. Thanks, Lijo.

#12592 fixed Batch modify should require POST method Jun Omae Jun Omae
Description

Batch modify doesn't check whether HTTP method is POST. We should require POST.

  • trac/ticket/batch.py

    diff --git a/trac/ticket/batch.py b/trac/ticket/batch.py
    index 5fcedc4ef..464cd18af 100644
    a b from trac.ticket.notification import BatchTicketNotifyEmail 
    2828from trac.util.datefmt import datetime_now, utc
    2929from trac.util.text import exception_to_unicode, to_unicode
    3030from trac.util.translation import _, tag_
    31 from trac.web.api import IRequestFilter, IRequestHandler
     31from trac.web.api import IRequestFilter, IRequestHandler, HTTPBadRequest
    3232from trac.web.chrome import add_warning, add_script_data
    3333
    3434
    class BatchModifyModule(Component): 
    5353        return req.path_info == '/batchmodify'
    5454
    5555    def process_request(self, req):
     56        if req.method != 'POST':
     57            raise HTTPBadRequest(_("Invalid request arguments."))
    5658        req.perm.assert_permission('TICKET_BATCH_MODIFY')
    5759
    5860        comment = req.args.get('batchmod_value_comment', '')
  • trac/ticket/tests/batch.py

    diff --git a/trac/ticket/tests/batch.py b/trac/ticket/tests/batch.py
    index c05cf765f..eff9daf0c 100644
    a b from trac.ticket import default_workflow, web_ui 
    2323from trac.ticket.batch import BatchModifyModule
    2424from trac.ticket.model import Ticket
    2525from trac.util.datefmt import datetime_now, utc
     26from trac.web.api import HTTPBadRequest, RequestDone
    2627from trac.web.chrome import web_context
    2728
    2829
    class BatchModifyTestCase(unittest.TestCase): 
    106107        selected_tickets = batch._get_selected_tickets(self.req)
    107108        self.assertEqual(selected_tickets, [])
    108109
     110    def test_require_post_method(self):
     111        batch = BatchModifyModule(self.env)
     112        req = MockRequest(self.env, method='GET', path_info='/batchmodify')
     113        self.assertTrue(batch.match_request(req))
     114        self.assertRaises(HTTPBadRequest, batch.process_request, req)
     115        req = MockRequest(self.env, method='POST', path_info='/batchmodify',
     116                          args={'selected_tickets': ''})
     117        self.assertTrue(batch.match_request(req))
     118        self.assertRaises(RequestDone, batch.process_request, req)
     119
    109120    # Assign list items
    110121
    111122    def test_change_list_replace_empty_with_single(self):
#12591 fixed Implement IRequestFilter in BatchModifyModule for adding template data to query request Ryan J Ollos Ryan J Ollos
Description

Implementing IRequestFilter in batch.py would avoid the need to import BatchModifyModule in query.py and check if the component is enabled.

First discussed in comment:58:ticket:11901.

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 10 months ago Last modified on Dec 11, 2015, 12:05:26 PM