136603 - show_bug.cgi's XML retrieval needs a summary mode

Status: RESOLVED FIXED

(Bugzilla :: Creating/Changing Bugs, defect)

Description

[Bradley Baetz (:bbaetz)]

bots don't want every comment, and if you don't want to change data via teh
xmlrpc stuff we don't support, you may want to use the shadowdb.

We should have either a mode which allows the user to select what fields they
want, and/or a nocomments mode for xml output. This would also be useful when we
start dumping attachment data.

Comment 1

[Gervase Markham [:gerv]]

I can do this as part of the templatisation.

Gerv

Comment 2

[Matthew Tuck [:CodeMachine]]

Did you, Gerv?

Comment 3

[Gervase Markham [:gerv]]

No, because I haven't templatised XML output yet. I produced a patch, but people
were of the view that it wasn't the right approach.

Gerv

Comment 4

[Bradley Baetz (:bbaetz)]

I have half of such a patch - its mainly waiting on groups to go in, since it
changes much of the same code.

Comment 5

[Gervase Markham [:gerv]]

bbaetz: this would be pretty trivial now - a few tests on a boolean in the
template, and a bit in show_bug.cgi which turns a URL parameter into that
boolean. It wouldn't need and UI because it's for bots (we should probably
document it, though.) Are you up for this, or have you more important things to
do? :-)

Gerv

Comment 6

[Bradley Baetz (:bbaetz)]

I think we should just list the requested fields somehow, as comma separated, or
multiple params, or something.

Does that sound workable?

Comment 7

[Gervase Markham [:gerv]]

Well, we'd have to translate each individual parameter to a template variable in
the multiple parameters case. We could use a comma-separated list and create a
template variable of value "1" with the same name as each item in the list. That
would be less crufty.

...&ctype=xml&fields=bug_status,priority...

Gerv

Comment 8

[Bradley Baetz (:bbaetz)]

I was thinging along the lines of

&field=foo&field=bar&field=baz

which gives a list within perl. I split up stuff for my just-checked-in xml
patch, because comma separation doesn't work if an alias contains a comma. (Plus
long_list was inconsistent)

Thats not an issue here, though, I guess, since fields can't contain commas.

Comment 9

[Gervase Markham [:gerv]]

The field stuff sounds great. However, how are we going to make "no parameters"
mean "everything"? Are all our tests going to have to be:

[% IF !fields OR fields.bug_status %]
  <bug_status>...</bug_status>
[% END %]

?

Gerv

Comment 10

[Bradley Baetz (:bbaetz)]

Same way as from |fields| - we can set the var to the list of all fields if its
empty, from within the cgi.

Comment 11

[Gervase Markham [:gerv]]

The problem with that is that we then have to maintain a list of all the fields,
which sucks a bit. Given the choice, I'd rather have double-barrelled IF tests
than that...

Gerv

Comment 12

[Bradley Baetz (:bbaetz)]

We already have a list of all the fields - we sort of have to, if we want to
iterate through them

Check out Bug.pm::fields()

Comment 13

[Gervase Markham [:gerv]]

Attachment: Patch v.1

Here's version 1 - I think this is flexible enough for what we want.

Gerv

Comment 14

[Gervase Markham [:gerv]]

Comment on attachment 110739 [details] [diff] [review]
Patch v.1

bbaetz: another one you have an interest in...

Gerv

Comment 15

[Bradley Baetz (:bbaetz)]

Comment on attachment 110739 [details] [diff] [review]
Patch v.1

I'm happy with this. We aren't valid xml with this option, but short of making
the dtd a cgi (or having everything as optional), theres no way arround that.

Comment 16

[Dave Miller [:justdave]]

-> patch author

Comment 17

[Dave Miller [:justdave]]

/me grumbles about the enter key being too close to the shift key

Comment 18

[Gervase Markham [:gerv]]

Fixed.

Checking in template/en/default/bug/show.xml.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/bug/show.xml.tmpl,v  <--
 show.xml.tmpl
new revision: 1.2; previous revision: 1.1
done
Checking in show_bug.cgi;
/cvsroot/mozilla/webtools/bugzilla/show_bug.cgi,v  <--  show_bug.cgi
new revision: 1.22; previous revision: 1.21
done

Gerv