rt/html/REST/1.0/search/ticket

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
   6 %#                                          <jesse@bestpractical.com>
   7 %#
   8 %# (Except where explicitly superseded by other copyright notices)
   9 %#
  10 %#
  11 %# LICENSE:
  12 %#
  13 %# This work is made available to you under the terms of Version 2 of
  14 %# the GNU General Public License. A copy of that license should have
  15 %# been provided with this software, but in any event can be snarfed
  16 %# from www.gnu.org.
  17 %#
  18 %# This work is distributed in the hope that it will be useful, but
  19 %# WITHOUT ANY WARRANTY; without even the implied warranty of
  20 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 %# General Public License for more details.
  22 %#
  23 %# You should have received a copy of the GNU General Public License
  24 %# along with this program; if not, write to the Free Software
  25 %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 %# 02110-1301 or visit their web page on the internet at
  27 %# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 %#
  29 %#
  30 %# CONTRIBUTION SUBMISSION POLICY:
  31 %#
  32 %# (The following paragraph is not intended to limit the rights granted
  33 %# to you to modify and distribute this software under the terms of
  34 %# the GNU General Public License and is only of importance to you if
  35 %# you choose to contribute your changes and enhancements to the
  36 %# community by submitting them to Best Practical Solutions, LLC.)
  37 %#
  38 %# By intentionally submitting any modifications, corrections or
  39 %# derivatives to this work, or any other work intended for use with
  40 %# Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 %# you are the copyright holder for those contributions and you grant
  42 %# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 %# royalty-free, perpetual, license to use, copy, create derivative
  44 %# works based on those contributions, and sublicense and distribute
  45 %# those contributions and any derivatives thereof.
  46 %#
  47 %# END BPS TAGGED BLOCK }}}
  48 %# REST/1.0/search/ticket
  49 %#
  50 <%ARGS>
  51 $query
  52 $format => undef
  53 $orderby => undef
  54 $fields => undef
  55 </%ARGS>
  56 <%INIT>
  57 my $output = "";
  58 my $status = "200 Ok";
  59 my $tickets = new RT::Tickets $session{CurrentUser};
  60
  61 # Parse and validate any field specifications.
  62 my $field  = '[a-zA-Z](?:[a-zA-Z0-9_-]|\s+)*';
  63 my (%fields, @fields);
  64 if ($fields) {
  65     $format ||= "l";
  66     unless ($fields =~ /^(?:$field,)*$field$/) {
  67         $status = "400 Bad Request";
  68         $output = "Invalid field specification: $fields";
  69         goto OUTPUT;
  70     }
  71     @fields = map lc, split /,/, $fields;
  72     @fields{@fields} = ();
  73     unless (exists $fields{id}) {
  74         unshift @fields, "id";
  75         $fields{id} = ();
  76     }
  77 }
  78
  79 $format ||= "s";
  80 if ($format !~ /^[isl]$/) {
  81     $status = "400 Bad request";
  82     $output = "Unknown listing format: $format. (Use i, s, or l.)\n";
  83     goto OUTPUT;
  84 }
  85
  86 my ($n, $s);
  87 eval {
  88     ($n, $s) = $tickets->FromSQL($query);
  89 };
  90 my $sortstring = "";
  91 if ($orderby) {
  92     $sortstring = 'FIELD => ';
  93     my $order = substr($orderby, 0, 1);
  94     if ($order eq '+' || $order eq '-') {
  95         $sortstring .= 'substr($orderby, 1)';
  96         if ($order eq '+') {
  97             $sortstring .= ", ORDER => 'ASC'";
  98         } elsif ($order eq '-') {
  99             $sortstring .= ", ORDER => 'DESC'";
 100         }
 101     } else {
 102         $sortstring .= '$orderby';
 103     }
 104     my $foo = 'FIELD => ';
 105     $foo .= '$orderby';
 106     $tickets->OrderBy(eval $sortstring);
 107 }
 108 if ($@ || $n == 0) {
 109     $s ||= $@;
 110     $status = "400 Bad request";
 111     $output = "Invalid query: '$s'.\n";
 112     goto OUTPUT;
 113 }
 114
 115 $n = 0;
 116 my @output;
 117 while (my $ticket = $tickets->Next) {
 118     $n++;
 119
 120         my $id = $ticket->Id;
 121     if ($format eq "i") {
 122         $output .= "ticket/" . $id . "\n";
 123     }
 124     elsif ($format eq "s") {
 125         if ($fields) {
 126                 my $result = $m->comp("/REST/1.0/Forms/ticket/default", id => $id, format => $format, fields => \%fields);
 127                 my ($notes, $order, $key_values, $errors) = @$result;
 128                 # If it's the first time through, add our header
 129                 if ($n == 1) {
 130                         $output .= join("\t",@$order)."\n";
 131                 }
 132                 # Cut off the annoying ticket/ before the id;
 133                 $key_values->{'id'} = $id;
 134                 $output .= join("\t", map {$key_values->{$_}} @$order)."\n";
 135
 136
 137         } else {
 138                 $output .= $ticket->Id . ": ". $ticket->Subject . "\n";
 139         }
 140     }
 141     else {
 142         my $d = $m->comp("/REST/1.0/Forms/ticket/default", id => $id, format => $format, fields => \%fields);
 143         my ($c, $o, $k, $e) = @$d;
 144         push @output, [ $c, $o, $k ];
 145     }
 146 }
 147 if ($n == 0 && $format ne "i") {
 148     $output = "No matching results.\n";
 149 }
 150
 151 $output = form_compose(\@output) if @output;
 152
 153 OUTPUT:
 154 $m->out("RT/". $RT::VERSION . " " . $status ."\n\n");
 155
 156 $m->out($output );
 157 return();
 158 </%INIT>