Custom Query should support a dynamic $USER variable

[muti@…]

I'm making the custom query module the default for View Tickets and am moving a list of reports to the Wiki using query: syntax. One limitation so far is that there is no support for a "My Tickets" query:. The attached patch allows $USER replacement with the active user so that query?status=new&status=assigned&status=reopened&owner=$USER will show all tickets owned by the user clicking the link.

It will also work with multiple users, i.e. query?owner=$USER&owner=joeblow, and the is not restriction, i.e. query?owner=!$USER.

[Christopher Lenz]

I think it might make more sense to put this support into the query string parser, so that you could use this variable from the TicketQuery macro and query: links.

[Christian Boos]

#3967 requested the same thing but for the [[TicketQuery]] macro, so we'll probably do both together.

[Christian Boos]

Implemented in r3999.

Note that in the unlikely case you'd like to match something which ends with the 'USER' string, you'd have to use $=USER instead of =$USER.

[anonymous]

This fix works for queries defined using TracQuery#QueryLanguage but doesn't work when the query string has been copied complete with the ?.

e.g. this works:

[query:status=new|assigned|reopened&owner=$USER My Tickets]

this does not:

[query:?status=new&status=assigned&status=reopened&owner=$USER My Tickets]

[Christian Boos]

Ok, I'll look into this.

[Christian Boos]

Fixed in r5195. Thanks for the report!

[Matthew Good]

r3999 and r5195 both make changes to the public API. I'm working on a simple fix for this that does not break the API.

[Christian Boos]

You're right, the API unnecessarily changed from 0.10 due to the above changesets. I've fixed that in r5217.

But I think the feature itself as implemented in r5195 is OK, let me know if you think we can close this one now.

[Christian Boos]

Works now as expected, with no changes to the 0.10 API.

[Marcin Wojdyr <wojdyr@…>]

the SQL query is generated as expected and the list of results is also correct, but there is one minor issue.

If the query is, say, "owner=$USER" in the filters box on query page instead of: owner is foo there is: owner ends with USER

tested in 0.11rc1

[Kamil Kisiel <kamil@…>]

There's also the problem in #7258

[osimons]

Replying to Marcin Wojdyr:

If the query is, say, "owner=$USER" in the filters box on query page instead of: owner is foo there is: owner ends with USER

Verified, and this is quite tricky. Trac uses the $ as marker for 'endswith', so that if you actually do an endswith $USER selection it works correctly - it gets like user=$$USER in query string, strips one off, and keeps the remainder correctly.

The problem is when you use 'is' that has no defined prefix. The double useage of $ means that Trac cannot distinguish between is $USER and endswith USER as the querystring for both will look like owner=$USER. Trac selects the latter, but we could change that to test specially for known substitutions first and always prefer that interpretation.

Certainly as both default queries know contain $USER, the changed strategy is likely to be more right than wrong - although as long as the double meaning is maintained, we could always get cases that gets interpreted wrong.

Below is a 0.11-stable patch that changes the evaluation for known substitutions - please test:

trac/ticket/query.py

@@ -61 +61 @@
         self.groupdesc = groupdesc
         self.default_page = 1
         self.items_per_page = QueryModule(self.env).items_per_page
+        self.substitutions = ['$USER']
 
         # getting page number (default_page if unspecified)
         if not page:
@@ -134 +135 @@
                 raise QuerySyntaxError(_('Query filter requires field name'))
             # from last char of `field`, get the mode of comparison
             mode, neg = '', ''
-            if field[-1] in ('~', '^', '$'):
+            if field[-1] in ('~', '^', '$') \
+                                and not field in self.substitutions:
                 mode = field[-1]
                 field = field[:-1]
             if field[-1] == '!':
@@ -570 +572 @@
                 if neg:
                     val = val[1:]
                 mode = ''
-                if val[:1] in ('~', '^', '$'):
+                if val[:1] in ('~', '^', '$') \
+                                    and not val in self.substitutions:
                     mode, val = val[:1], val[1:]
                 constraint['mode'] = (neg and '!' or '') + mode
                 constraint['values'].append(val)

[osimons]

Committed in [7445:7446].