Add support for grouping, ordering, and column sets to default queries

[scottb@…]

In the trac.ini file there's options for the default query strings:

[query] 
default_anonymous_query = status!=closed&cc~=$USER 
default_query = status!=closed&owner=$USER 

I'd like to see support for grouping, ordering, and column options added for these default queries. For example something like

default_query = status!=closed&owner=$USER&group=status&order=priority&col=id|summary|type 
  or
default_query = status!=closed&owner=$USER&group=status&order=priority&col=id&col=summary&col=type 

[cboos]

Right, this should also support grouping and specifying the columns to be complete.

[Daniel Kahn Gillmor <dkg-debian.org@…>]

I'd like to see this also, if possible. It's odd that ordering seems to work from a query:order=summary style link, but not from default_query. That suggests maybe there could be better code reuse?

[jorge@…]

I am also waiting for this to be implemented.

[me@…]

patch for full query support in trac.ini

[me@…]

[patch] use this one.

[Stephen Prater <me@…>]

okay, I don't know why you can't see the patch if you click on it, but if you download it it works.

it's patched against .11-stable.

[cboos]

Replying to Stephen Prater <me@stephenprater.com>:

okay, I don't know why you can't see the patch if you click on it, but if you download it it works.

No it's not a proper patch:

File to patch: trac/ticket/query.py
patching file trac/ticket/query.py
patch: **** malformed patch at line 29: @@ -759,16 +777,28 @@

it's patched against .11-stable.

Besides your added code contains a mix of space and tabs, please don't use tabs (see  PEP:0008, look for Tabs or Spaces?).

[Stephen Prater <me@…>]

well, here it cleaned up. this time i patched it against trunk.

it's definitely sort of hacky - there's problems with the "rows" vs "row" in the query language vs. the request, and i'm not sure that "faking" request arguments is really the best approach here. It seemed like the least involved.

The point being - you should definitely view this as a starting point, and not something final. I hacked it in because I needed the functionality, and I thought I'd share.

[rblank]

Patch against 0.11-stable allowing query strings in default custom queries

[rblank]

The patch above extends the default query trac.ini options to also accept query strings starting with ?, in the same way as the query: wiki syntax. This allows setting up a custom query and copy/pasting the query part of the URL directly into trac.ini.

Comments?

[cboos]

The approach looks good, but I wonder why you encode the keys into utf-8 (the name = name.encode('utf-8') part)?

[rblank]

Replying to cboos:

I wonder why you encode the keys into utf-8 (the name = name.encode('utf-8') part)?

Because the constraints for the query are used as kwargs somewhere in Query (more specifically here​), and you can't have unicode keys for that.

I could also do the conversion in Query.get_href(), but req.args has exactly this structure: utf-8 keys, unicode values (well, at least str keys, unicode values; I'm not sure the URL is encoded in utf-8, but path_info is decoded as utf-8, so I figured the query string would also have the same encoding).

[cboos]

I see, thanks!

The Query.from_string uses field = str(field) for a similar purpose, so we might want to do the same here. Looks like this encoding is expected by the user of self.constraints, in unicode_urlencode (reached from Href.__call__), so everything is fine ;-)

[rblank]

Replying to cboos:

The Query.from_string uses field = str(field) for a similar purpose, so we might want to do the same here.

Did you mean something like this?

trac/ticket/query.py

@@ -146 +146 @@
             for val in values.split('|'):
                 val = neg + mode + val # add mode of comparison
                 processed_values.append(val)
-            try:
-                field = str(field)
-                if field in kw_strs:
-                    kw[field] = processed_values[0]
-                elif field in kw_arys:
-                    kw[field] = processed_values
-                elif field in kw_bools:
-                    kw[field] = True
-                elif field == 'col':
-                    cols.extend(processed_values)
-                else:
-                    constraints[field] = processed_values
-            except UnicodeError:
-                pass # field must be a str, see `get_href()`
+            if isinstance(field, unicode):      # field must be a str,
+                field = field.encode('utf-8')   # see `get_href()`
+            if field in kw_strs:
+                kw[field] = processed_values[0]
+            elif field in kw_arys:
+                kw[field] = processed_values
+            elif field in kw_bools:
+                kw[field] = True
+            elif field == 'col':
+                cols.extend(processed_values)
+            else:
+                constraints[field] = processed_values
         report = constraints.pop('report', None)
         report = kw.pop('report', report)
         return cls(env, report, constraints=constraints, cols=cols, **kw)

[rblank]

Patch applied in [7553].