rt/share/html/REST/1.0/search/ticket

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
   6 %#                                          <sales@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 use RT::Interface::REST;
  58 my $output = "";
  59 my $status = "200 Ok";
  60 my $tickets = RT::Tickets->new($session{CurrentUser});
  61
  62 # Parse and validate any field specifications.
  63 my $field  = RT::Interface::REST->field_spec;
  64 my (%fields, @fields);
  65 if ($fields) {
  66     $format ||= "l";
  67     unless ($fields =~ /^(?:$field,)*$field$/) {
  68         $status = "400 Bad Request";
  69         $output = "Invalid field specification: $fields";
  70         goto OUTPUT;
  71     }
  72     @fields = map lc, split /\s*,\s*/, $fields;
  73     @fields{@fields} = ();
  74     unless (exists $fields{id}) {
  75         unshift @fields, "id";
  76         $fields{id} = ();
  77     }
  78 }
  79
  80 $format ||= "s";
  81 if ($format !~ /^[isl]$/) {
  82     $status = "400 Bad request";
  83     $output = "Unknown listing format: $format. (Use i, s, or l.)\n";
  84     goto OUTPUT;
  85 }
  86
  87 my ($n, $s);
  88 eval {
  89     ($n, $s) = $tickets->FromSQL($query);
  90 };
  91
  92 if ($orderby) {
  93     my %args;
  94
  95     my $order = substr($orderby, 0, 1);
  96     if ($order eq '+' || $order eq '-') {
  97         # remove the +/- sorting sigil
  98         substr($orderby, 0, 1, '');
  99
 100         if ($order eq '+') {
 101             $args{ORDER} = 'ASC';
 102         }
 103         elsif ($order eq '-') {
 104             $args{ORDER} = 'DESC';
 105         }
 106     }
 107
 108     $tickets->OrderBy(
 109         FIELD => $orderby,
 110         %args,
 111     );
 112 }
 113
 114 if ($@ || $n == 0) {
 115     $s ||= $@;
 116     $status = "400 Bad request";
 117     $output = "Invalid query: '$s'.\n";
 118     goto OUTPUT;
 119 }
 120
 121 $n = 0;
 122 my @output;
 123 while (my $ticket = $tickets->Next) {
 124     $n++;
 125
 126         my $id = $ticket->Id;
 127     if ($format eq "i") {
 128         $output .= "ticket/" . $id . "\n";
 129     }
 130     elsif ($format eq "s") {
 131         if ($fields) {
 132                 my $result = $m->comp("/REST/1.0/Forms/ticket/default", id => $id, format => $format, fields => \%fields);
 133                 my ($notes, $order, $key_values, $errors) = @$result;
 134                 # If it's the first time through, add our header
 135                 if ($n == 1) {
 136                         $output .= join("\t",@$order)."\n";
 137                 }
 138                 # Cut off the annoying ticket/ before the id;
 139                 $key_values->{'id'} = $id;
 140                 $output .= join("\t", map { ref $key_values->{$_} eq 'ARRAY' ?
 141 join( ', ', @{$key_values->{$_}} ) : $key_values->{$_} } @$order)."\n";
 142
 143
 144         } else {
 145                 $output .= $ticket->Id . ": ". $ticket->Subject . "\n";
 146         }
 147     }
 148     else {
 149         my $d = $m->comp("/REST/1.0/Forms/ticket/default", id => $id, format => $format, fields => \%fields);
 150         my ($c, $o, $k, $e) = @$d;
 151         push @output, [ $c, $o, $k ];
 152     }
 153 }
 154 if ($n == 0 && $format ne "i") {
 155     $output = "No matching results.\n";
 156 }
 157
 158 $output = form_compose(\@output) if @output;
 159
 160 OUTPUT:
 161 $m->out("RT/". $RT::VERSION . " " . $status ."\n\n");
 162
 163 $m->out($output );
 164 return();
 165 </%INIT>