wiki:TracQuery

Version 4 (modified by trac, on Sep 24, 2015 at 1:13:19 PM) ( diff )

--

Trac Ticket Queries

Table of Contents

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

Results (1 - 3 of 3947)

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#4113 Completed Make version of Execute() that can take multiple lines. anonymous
#4112 Fixed _WinAPI_MapWindowPoints addition Jpm MattyD
#4111 Fixed GuiEdit Extensions Jpm MattyD
1 2 3 4 5 6 7 8 9 10 11 →

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#4113 Completed Make version of Execute() that can take multiple lines. anonymous
Description

I am a ware of /AutoIt3ExecuteScript switch which allows me to run entire script with my compiled autoit exe. But problem is that this doesn't allow passing context.

Example code to illustrate how I would like to interact with context.

Line 
1Func Example($DynamicCode)
2 $ContextVariable = "Untitled - Notepad"
3 $hWnd = Execute($DynamicCode)
4 WinActivate($hWnd)
5EndFunc ;==>Example
6
7$DynamicCode = "$aList = WinList()" & @CRLF & _
8"For $i = 1 To $aList[0][0]" & @CRLF & _
9" If $aList[$i][0] = $ContextVariable Then" & @CRLF & _
10" return $aList[$i][1]" & @CRLF & _
11" EndIf" & @CRLF & _
12"Next"
13
14Example($DynamicCode)

And likewise assignment to $ContextVariable inside that $DynamicCode string would change the value of $ContextVariable that Example function sees.

#4112 Fixed _WinAPI_MapWindowPoints addition Jpm MattyD
Description

Hey JP,

I thought this one would probably be a good candidate for an adding to WinAPIConv.au3. FWIW I've thrown in the $HWND_DESKTOP definition to service it, but its not really necessary. ​Microsoft Documentation.

Thanks, Matt 

Global Const $HWND_DESKTOP = 0

Func _WinAPI_MapWindowPoints($hWndFom, $hWndTo, $tPoints, $iCount)
    Local $aCall = DllCall("User32.dll", "int", "MapWindowPoints", "hwnd", $hWndFom, "hwnd", $hWndTo, "struct*", $tPoints, "int", $iCount)
    If @error Then Return SetError(@error, @extended, $aCall)
    Return $aCall[0]
EndFunc

Example: (I can simplify if need be.) 

#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7

#include <WinAPI.au3>
#include <GuiConstants.au3>

Global $g_hMainWnd, $g_hChildWnd, $g_idWinPos, $g_idClientPos, $g_idButton

_Example()

Func _Example()
        GUIRegisterMsg($WM_MOVE, "MoveSize")
        GUIRegisterMsg($WM_SIZE, "MoveSize")

        $g_hMainWnd = GUICreate("Main Window", 500, 400, -1, -1, $WS_SIZEBOX)
        GUICtrlCreateLabel("Popup window's rect, relative to the top-left of the main window's client area.", 10, 10, 500, 20)
        $g_idWinPos = GUICtrlCreateLabel("", 10, 30, 500, 20)

        GUICtrlCreateLabel("Popup's window's client rect, relative to the top-left of the main window's client area.", 10, 55, 500, 20)
        $g_idClientPos = GUICtrlCreateLabel("", 10, 75, 500, 20)

        $g_hChildWnd = GUICreate("Popup Window", 200, 125, -1, -1, BitOR($WS_POPUP, $WS_CAPTION), 0, $g_hMainWnd)
        Local $sMsg = "The popup will re-position itself relative to its parent." & @CRLF & @CRLF & _
                 "Move or resize the parent window to trigger the action."
        GUICtrlCreateLabel($sMsg, 10, 10, 180, 80, $SS_CENTER)
        $g_idButton = GUICtrlCreateButton("Re-Center", 60, 90, 80, 25)

        GUISetState(@SW_SHOW, $g_hMainWnd)
        GUISetState(@SW_SHOW, $g_hChildWnd)

        While 1
                Switch GUIGetMsg()
                        Case $GUI_EVENT_CLOSE
                                ExitLoop
                        Case $g_idButton
                                PositionPopUpWindow($g_hChildWnd)
                EndSwitch
        WEnd

        GUIDelete($g_hChildWnd)
        GUIDelete($g_hMainWnd)
EndFunc

Func MoveSize($hWnd, $iMsg, $wParam, $lParam)

        Switch $hWnd
                Case $g_hMainWnd
                        PositionPopUpWindow($g_hChildWnd)
                        If $iMsg = $WM_SIZE Then UpdateLabels()

                Case $g_hChildWnd
                        UpdateLabels()

        EndSwitch

        Return _WinAPI_DefWindowProcW($hWnd, $iMsg, $wParam, $lParam)
EndFunc

Func PositionPopUpWindow($hWnd)
        Local $hOwner = _WinAPI_GetWindow($hWnd, $GW_OWNER)

        Local $tWndPos = _WinAPI_GetWindowRect($hWnd)
        Local $iWndW =  DllStructGetData($tWndPos, "Right") - DllStructGetData($tWndPos, "Left")
        Local $iWndH =  DllStructGetData($tWndPos, "Bottom") - DllStructGetData($tWndPos, "Top")

        Local $tOwnerPos = _WinAPI_GetClientRect($hOwner)
        Local $iOwnerW =  DllStructGetData($tOwnerPos, "Right") - DllStructGetData($tOwnerPos, "Left")
        Local $iOwnerH =  DllStructGetData($tOwnerPos, "Bottom") - DllStructGetData($tOwnerPos, "Top")

        ; Position window
        ; (Convert point relative to main window -> screen coords)
        Local $tPoint = DllStructCreate($tagPOINT)
        DllStructSetData($tPoint, "X", ($iOwnerW - $iWndW)/2)
        DllStructSetData($tPoint, "Y", ($iOwnerH - $iWndH)/2)
        _WinAPI_MapWindowPoints($hOwner, 0, $tPoint, 1)

        _WinAPI_SetWindowPos($hWnd, $HWND_TOP, DllStructGetData($tPoint, "X"), DllStructGetData($tPoint, "Y"), _
                        0, 0, BitOR($SWP_NOSIZE, $SWP_NOZORDER, $SWP_SHOWWINDOW, $SWP_NOACTIVATE))
EndFunc

Func UpdateLabels()
        ; Popup window's non-client position relative to main window's client area.
        ; (Convert screen coords -> points relative to main window)
        Local $tWndPos = _WinAPI_GetWindowRect($g_hChildWnd)
        _WinAPI_MapWindowPoints(0, $g_hMainWnd, $tWndPos, 2)
        GUICtrlSetData($g_idWinPos, _
                StringFormat("Left: [ %4d ] Top: [ %4d ] Right: [ %4d ] Bottom: [ %4d ]", _
                DllStructGetData($tWndPos, "Left"), DllStructGetData($tWndPos, "Top"), _
                DllStructGetData($tWndPos, "Right"), DllStructGetData($tWndPos, "Bottom")))

        ; Popup window's client position relative to main window's client area.
        ; (Convert points relative to popup window -> points relative to main window)
        Local $tClientPos = _WinAPI_GetClientRect($g_hChildWnd)
        _WinAPI_MapWindowPoints($g_hChildWnd, $g_hMainWnd, $tClientPos, 2)
        GUICtrlSetData($g_idClientPos, _
                StringFormat("Left: [ %4d ] Top: [ %4d ] Right: [ %4d ] Bottom: [ %4d ]", _
                DllStructGetData($tClientPos, "Left"), DllStructGetData($tClientPos, "Top"), _
                DllStructGetData($tClientPos, "Right"), DllStructGetData($tClientPos, "Bottom")))
EndFunc

Func _WinAPI_MapWindowPoints($hWndFom, $hWndTo, $tPoints, $iCount)
    Local $aCall = DllCall("User32.dll", "int", "MapWindowPoints", "hwnd", $hWndFom, "hwnd", $hWndTo, "struct*", $tPoints, "int", $iCount)
    If @error Then Return SetError(@error, @extended, $aCall)
    Return $aCall[0]
EndFunc

Suggested Documentation: 

###User Defined Function###
_WinAPI_MapWindowPoints

###Description###
Converts a set of points from a coordinate space relative to one window to a coordinate space relative to another window.

###Syntax###
#include <WinAPIConv.au3>
_WinAPI_MapWindowPoints( $hWndFom, $hWndTo, $tPoints, $iCount )

###Parameters###
@@ParamTable@@
$hWndFrom
	A handle to the window from which points are converted. If this parameter is 0 or $HWND_DESKTOP, the points are presumed to be in screen coordinates.
$hWndTo
	A handle to the window to which points are converted. If this parameter is 0 or $HWND_DESKTOP, the points are converted to screen coordinates.
$tPoints
	A struct containing an array of POINT structures that contain the set of points to be converted.
$iCount
	The number of POINTs in the $tPoints struct.
@@End@@

###ReturnValue###
@@ReturnTable@@
Success:	low-order word: The number of pixels added to the horizontal coordinate of each source point.
	high-order word: The number of pixels added to the vertical coordinate of each source point.
Failure:	0. Call _WinAPI_SetLastError prior to calling this method to differentiate an error return value from a legitimate "0" return value.
@@End@@

###Remarks###
If hWndFrom or hWndTo (or both) have the $WS_EX_LAYOUTRTL extended style and precisely two points are passed in $tPoints, _WinAPI_MapWindowPoints will interpret those two points as a RECT and possibly automatically swap the left and right fields of that rectangle to ensure that left is not greater than right. If you need to map precisely two independent points and don't want the RECT logic applied to them by _WinAPI_MapWindowPoints, you must call _WinAPI_MapWindowPoints with one POINT at a time.

###Related###
_WinAPI_ScreenToClient, _WinAPI_ClientToScreen

###Example###
@@IncludeExample@@
#4111 Fixed GuiEdit Extensions Jpm MattyD
Description

Hi JPM,

Just a couple suggestions for expanding GuiEdit.au3, because I've been given a gentle nudge to submit them :) I have an attachment sitting in ​this thread with the following extensions and a couple of examples: 

Clipboard messages. (WM_CUT etc.)
 _GuiCtrlEdit_Clear - removes selected text.
 _GuiCtrlEdit_Copy
 _GuiCtrlEdit_Cut
 _GuiCtrlEdit_Paste

End of line funcs. (EM_SETENDOFLINE/EM_GETENDOFLINE) 
Includes "allowed" line-breaking chars and autodetect features.
 _GuiCtrlEdit_GetEOL
 _GuiCtrlEdit_GetEOLEx
 _GuiCtrlEdit_SetEOL
 _GuiCtrlEdit_SetEOLEx
 
Zoom funcs. (EM_SETZOOM etc.)
 _GuiCtrlEdit_GetIsZoomable
 _GuiCtrlEdit_GetZoom
 _GuiCtrlEdit_SetIsZoomable
 _GuiCtrlEdit_SetZoom

I was also thinking that wrapping WM_GETFONT/WM_SETFONT probably makes sense here too for an Edit control. So perhaps something simple like this is worth considering as well? 

; #FUNCTION# ====================================================================================================================
; Name ..........: _GUICtrlEdit_SetFont
; Description ...: Sets a control's font
; Syntax ........: _GUICtrlEdit_SetFont($hWnd, $hFont[, $bRedraw = True])
; Parameters ....: $hWnd                - Control handle or control ID.
;                  $hFont               - The font handle (HFONT) to set.
;                  $bRedraw             - [optional] If True, the control is redrawn after setting the new font. Default is True.
; Return values .: None
; Remarks .......: Font handles are not freed automatically. Both old and new should be passed to _WinAPI_DeleteObject() when
;                  they are no longer required.
; ===============================================================================================================================
Func _GUICtrlEdit_SetFont($hWnd, $hFont, $bRedraw = True)
        If Not IsHWnd($hWnd) Then $hWnd = GUICtrlGetHandle($hWnd)
        Return _SendMessage($hWnd, $WM_SETFONT, $hFont, $bRedraw)
EndFunc   ;==>_GUICtrlEdit_SetFont

; #FUNCTION# ====================================================================================================================
; Name ..........: _GUICtrlEdit_GetFont
; Description ...: Gets a control's font handle
; Syntax ........: _GUICtrlEdit_GetFont($hWnd)
; Parameters ....: $hWnd                - Control handle or control ID.
; Return values .: a font handle (HFONT)
; ===============================================================================================================================
Func _GUICtrlEdit_GetFont($hWnd)
        If Not IsHWnd($hWnd) Then $hWnd = GUICtrlGetHandle($hWnd)
        Return _SendMessage($hWnd, $WM_GETFONT, 0, 0, 0, "wparam", "lparam", "handle")
EndFunc   ;==>_GUICtrlEdit_GetFont

Many thanks, Matt

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

Note: See TracWiki for help on using the wiki.