Version 2 (modified by trac, 13 months ago) ( diff )

--

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: 663 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 663 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 396 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5198 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1073 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4340 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4146 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18633 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1059 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 35428 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1488 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 46 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 24 [[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: 32 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 32 [[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: #35839, #36202, #3362 [[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 Jacob Adrian Holovaty
Summary Create architecture for anonymous sessions

Format: list

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

This is displayed as:

No results 

[[TicketQuery(id=123)]]

This is displayed as:

#123
Typo in the model_api/#field-types

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:

Uncategorized

2001 / 2002
Bug

10175 / 10534
New feature

3714 / 4111
Cleanup/optimization

5264 / 5565

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#36209 duplicate Add HttpResponse subclasses for No Content and Created Michiel Beijen
Description

Django has HttpResponse subclasses for many status codes. Although you can use the generic HttpResponse and provide it with a status code, the subclasses provide for more readable code: it's more clear to write HttpResponseRedirect() or HttpResponsePermanentRedirect() than to use HttpResponse with a 301 or 302 status code, because that requires you to 'know' which status code is which.

However for the RESTful HTTP response codes 201 Created and 204 No Content there are no HttpResponse subclasses. It would be helpful to people writing RESTful HTTP APIs to have HttpResponse subclasses for these codes.

This patch adds HttpResponseCreated and HttpResponseNoContent subclasses. I've targeted Django 6 because 5.2 is closed for new features.

#36206 invalid Issues in the Existing SecurityMiddleware Code 1. Incorrect use of response.setdefault() instead of response.headers.setdefault() 2. In the process_request() method, HTTPS redirection is done While this works, %-formatting is less readable and slightly less performant than modern alternatives like f-strings 3. Preventing Overwriting of Existing Headers Abhijeet Kumar
Description
  1. Incorrect use of response.setdefault() instead of response.headers.setdefault()

Issue: In the original code, the Cross-Origin-Opener-Policy (COOP) header is set using: 

response.setdefault("Cross-Origin-Opener-Policy", self.cross_origin_opener_policy)

This is incorrect because:

  1. response.setdefault() does not exist in Django’s HttpResponse class.
  2. Headers should be set using response.headers.setdefault() to ensure they are only added if they don’t already exist.

Suggested Modification: Replace: 

response.setdefault("Cross-Origin-Opener-Policy", self.cross_origin_opener_policy)

With: 

response.headers.setdefault("Cross-Origin-Opener-Policy", self.cross_origin_opener_policy)
  1. Improving String Formatting for Readability & Performance

Issue: In the process_request() method, HTTPS redirection is done using: 

return HttpResponsePermanentRedirect(
    "https://%s%s" % (host, request.get_full_path())
)

While this works, %-formatting is less readable and slightly less performant than modern alternatives like f-strings.

Suggested Modification: Change: 

return HttpResponsePermanentRedirect(
    "https://%s%s" % (host, request.get_full_path())
)

To: 

return HttpResponsePermanentRedirect(f"https://{host}{request.get_full_path()}")
  1. Preventing Overwriting of Existing Headers

Issue:

The original code unconditionally sets security headers like: 

response.headers["Strict-Transport-Security"] = sts_header
response.headers["X-Content-Type-Options"] = "nosniff"

is could Override existing security policies set by other middleware or custom responses & Prevent flexibility in modifying security headers dynamically.

Suggested Modification:

Use setdefault() instead of direct assignment: 

response.headers.setdefault("Strict-Transport-Security", sts_header)
response.headers.setdefault("X-Content-Type-Options", "nosniff")

Suggested Code: 

import re

from django.conf import settings
from django.http import HttpResponsePermanentRedirect
from django.utils.deprecation import MiddlewareMixin


class SecurityMiddleware(MiddlewareMixin):
    def __init__(self, get_response):
        super().__init__(get_response)
        self.sts_seconds = settings.SECURE_HSTS_SECONDS
        self.sts_include_subdomains = settings.SECURE_HSTS_INCLUDE_SUBDOMAINS
        self.sts_preload = settings.SECURE_HSTS_PRELOAD
        self.content_type_nosniff = settings.SECURE_CONTENT_TYPE_NOSNIFF
        self.redirect = settings.SECURE_SSL_REDIRECT
        self.redirect_host = settings.SECURE_SSL_HOST
        self.redirect_exempt = [re.compile(r) for r in settings.SECURE_REDIRECT_EXEMPT]
        self.referrer_policy = settings.SECURE_REFERRER_POLICY
        self.cross_origin_opener_policy = settings.SECURE_CROSS_ORIGIN_OPENER_POLICY

    def process_request(self, request):
        path = request.path.lstrip("/")
        if (
            self.redirect
            and not request.is_secure()
            and not any(pattern.search(path) for pattern in self.redirect_exempt)
        ):
            host = self.redirect_host or request.get_host()
            return HttpResponsePermanentRedirect(f"https://{host}{request.get_full_path()}")

    def process_response(self, request, response):
        if (
            self.sts_seconds
            and request.is_secure()
            and "Strict-Transport-Security" not in response.headers
        ):
            sts_header = f"max-age={self.sts_seconds}"
            if self.sts_include_subdomains:
                sts_header += "; includeSubDomains"
            if self.sts_preload:
                sts_header += "; preload"
            response.headers.setdefault("Strict-Transport-Security", sts_header)

        if self.content_type_nosniff:
            response.headers.setdefault("X-Content-Type-Options", "nosniff")

        if self.referrer_policy:
            # Support a comma-separated string or iterable of values to allow fallback.
            response.headers.setdefault(
                "Referrer-Policy",
                ",".join(
                    [v.strip() for v in self.referrer_policy.split(",")]
                    if isinstance(self.referrer_policy, str)
                    else self.referrer_policy
                ),
            )

        if self.cross_origin_opener_policy:
            response.headers.setdefault(
                "Cross-Origin-Opener-Policy",
                self.cross_origin_opener_policy,
            )

        return response
#36205 duplicate Date format issue in Django 5.1.6 Li,Qianqian
Description

In Django 5.1.6, when setting USE_L10N = False and DATETIME_FORMAT = 'Y-m-d H:i:s', the expectation is that DateTimeField in the Admin interface displays as '2024-04-15 23:33:00'. However, it displays as 'April 15, 2024, 11:33 p.m.' (default en-us format). This worked correctly in previous versions (e.g., 5.0.x or 4.x).

Steps to reproduce:

  1. Configure settings.py as follows: LANGUAGE_CODE = 'en-us' TIME_ZONE = 'Asia/Shanghai' USE_I18N = True USE_TZ = True USE_L10N = False DATETIME_FORMAT = 'Y-m-d H:i:s'
  2. Create a model with a DateTimeField.
  3. View the field in the Admin interface; the format does not follow DATETIME_FORMAT.

Expected behavior: Displays '2024-04-15 23:33:00'. Actual behavior: Displays 'April 15, 2024, 11:33 p.m.'.

1 2 3 4 5 6 7 8 9 10 11 →

See also: TracQuery, TracTickets, TracReports

Note: See TracWiki for help on using the wiki.
Back to Top