rt/html/REST/1.0/search/ticket

   1 %# {{{ BEGIN BPS TAGGED BLOCK
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2004 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 %#
  27 %#
  28 %# CONTRIBUTION SUBMISSION POLICY:
  29 %#
  30 %# (The following paragraph is not intended to limit the rights granted
  31 %# to you to modify and distribute this software under the terms of
  32 %# the GNU General Public License and is only of importance to you if
  33 %# you choose to contribute your changes and enhancements to the
  34 %# community by submitting them to Best Practical Solutions, LLC.)
  35 %#
  36 %# By intentionally submitting any modifications, corrections or
  37 %# derivatives to this work, or any other work intended for use with
  38 %# Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 %# you are the copyright holder for those contributions and you grant
  40 %# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 %# royalty-free, perpetual, license to use, copy, create derivative
  42 %# works based on those contributions, and sublicense and distribute
  43 %# those contributions and any derivatives thereof.
  44 %#
  45 %# }}} END BPS TAGGED BLOCK
  46 %# REST/1.0/search/ticket
  47 %#
  48 <%ARGS>
  49 $query
  50 $format => undef
  51 $orderby => undef
  52 $fields => undef
  53 </%ARGS>
  54 <%INIT>
  55 my $output = "";
  56 my $status = "200 Ok";
  57 my $tickets = new RT::Tickets $session{CurrentUser};
  58
  59 # Parse and validate any field specifications.
  60 my $field  = '[a-zA-Z][a-zA-Z0-9_-]*';
  61 my (%fields, @fields);
  62 if ($fields) {
  63     $format = "l";
  64     unless ($fields =~ /^(?:$field,)*$field$/) {
  65         $status = "400 Bad Request";
  66         $output = "Invalid field specification: $fields";
  67         goto OUTPUT;
  68     }
  69     @fields = map lc, split /,/, $fields;
  70     @fields{@fields} = ();
  71     unless (exists $fields{id}) {
  72         unshift @fields, "id";
  73         $fields{id} = ();
  74     }
  75 }
  76
  77 $format ||= "s";
  78 if ($format !~ /^[isl]$/) {
  79     $status = "400 Bad request";
  80     $output = "Unknown listing format: $format. (Use i, s, or l.)\n";
  81     goto OUTPUT;
  82 }
  83
  84 my ($n, $s);
  85 eval {
  86     ($n, $s) = $tickets->FromSQL($query);
  87 };
  88 my $sortstring = "";
  89 if ($orderby) {
  90     $sortstring = 'FIELD => ';
  91     my $order = substr($orderby, 0, 1);
  92     if ($order eq '+' || $order eq '-') {
  93         $sortstring .= 'substr($orderby, 1)';
  94         if ($order eq '+') {
  95             $sortstring .= ", ORDER => 'ASC'";
  96         } elsif ($order eq '-') {
  97             $sortstring .= ", ORDER => 'DESC'";
  98         }
  99     } else {
 100         $sortstring .= '$orderby';
 101     }
 102     my $foo = 'FIELD => ';
 103     $foo .= '$orderby';
 104     $tickets->OrderBy(eval $sortstring);
 105 }
 106 if ($@ || $n == 0) {
 107     $s ||= $@;
 108     $status = "400 Bad request";
 109     $output = "Invalid query: '$s'.\n";
 110     goto OUTPUT;
 111 }
 112
 113 $n = 0;
 114 my @output;
 115 while (my $ticket = $tickets->Next) {
 116     $n++;
 117
 118     if ($format eq "i") {
 119         $output .= "ticket/" . $ticket->Id . "\n";
 120     }
 121     elsif ($format eq "s") {
 122         $output .= $ticket->Id . ": ". $ticket->Subject . "\n";
 123     }
 124     else {
 125         my $id = $ticket->Id;
 126         my $d = $m->comp("$RT::WebPath/REST/1.0/Forms/ticket/default", id => $id, format => $format, fields => \%fields);
 127         my ($c, $o, $k, $e) = @$d;
 128         push @output, [ $c, $o, $k ];
 129     }
 130 }
 131 if ($n == 0 && $format ne "i") {
 132     $output = "No matching results.\n";
 133 }
 134
 135 $output = form_compose(\@output) if @output;
 136
 137 OUTPUT:
 138 $m->out("RT/". $RT::VERSION . " " . $status);
 139
 140 $m->out($output );
 141 </%INIT>