1 %# BEGIN BPS TAGGED BLOCK {{{
5 %# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC
6 %# <sales@bestpractical.com>
8 %# (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 %# CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 %# END BPS TAGGED BLOCK }}}
48 %# REST/1.0/Forms/ticket/default
58 use RT::Interface::REST;
60 my $cf_spec = RT::Interface::REST->custom_field_spec(1);
63 my ($c, $o, $k, $e) = ("", [], {}, 0);
65 my $ticket = RT::Ticket->new($session{CurrentUser});
66 my @dates = qw(Created Starts Started Due Resolved Told LastUpdated);
67 my @people = qw(Requestors Cc AdminCc);
68 my @create = qw(Queue Requestor Subject Cc AdminCc Owner Status Priority
69 InitialPriority FinalPriority TimeEstimated TimeWorked
70 TimeLeft Starts Started Due Resolved Content-Type);
71 my @simple = qw(Subject Status Priority Disabled TimeEstimated TimeWorked
72 TimeLeft InitialPriority FinalPriority);
73 my %dates = map {lc $_ => $_} @dates;
74 my %people = map {lc $_ => $_} @people;
75 my %create = map {lc $_ => $_} @create;
76 my %simple = map {lc $_ => $_} @simple;
78 # Are we dealing with an existing ticket?
82 return [ "# Ticket $id does not exist.", [], {}, 1 ];
85 if ( $data{status} && lc $data{status} eq 'deleted' && ! grep { $_ ne 'id' && $_ ne 'status' } keys %data ) {
86 if ( !$ticket->CurrentUserHasRight('DeleteTicket') ) {
87 return [ "# You are not allowed to delete ticket $id.", [], {}, 1 ];
90 elsif ( !$ticket->CurrentUserHasRight('ModifyTicket') ) {
91 return [ "# You are not allowed to modify ticket $id.", [], {}, 1 ];
94 elsif (!$ticket->CurrentUserHasRight('ShowTicket')) {
95 return [ "# You are not allowed to display ticket $id.", [], {}, 1 ];
100 # GET ticket/new: Return a suitable default form.
101 # We get defaults from queue/1 (XXX: What if it isn't there?).
102 my $queue = RT::Queue->new($session{CurrentUser});
106 if ($queue->DefaultDueIn) {
107 $due = RT::Date->new($session{CurrentUser});
109 $due->AddDays($queue->DefaultDueIn);
111 my $starts = RT::Date->new($session{CurrentUser});
115 "# Required: id, Queue",
116 [ qw(id Queue Requestor Subject Cc AdminCc Owner Status Priority
117 InitialPriority FinalPriority TimeEstimated Starts Due Attachment Text) ],
120 Queue => $queue->Name,
121 Requestor => $session{CurrentUser}->Name,
127 Priority => $queue->InitialPriority,
128 InitialPriority => $queue->InitialPriority,
129 FinalPriority => $queue->FinalPriority,
131 Starts => $starts->ISO(Timezone => 'user'),
132 Due => $due ? $due->ISO(Timezone => 'user') : undef,
140 # We'll create a new ticket, and fall through to set fields that
141 # can't be set in the call to Create().
142 my (%v, $text, @atts);
144 foreach my $k (keys %data) {
145 # flexibly parse any dates
147 my $time = RT::Date->new($session{CurrentUser});
148 $time->Set(Format => 'unknown', Value => $data{$k});
149 $data{$k} = $time->ISO;
152 if (exists $create{lc $k}) {
153 $v{$create{lc $k}} = delete $data{$k};
156 elsif ($k =~ /^$cf_spec/) {
159 my $cf = RT::CustomField->new( $session{CurrentUser} );
162 LookupType => RT::Ticket->CustomFieldLookupType,
163 ObjectId => $data{Queue} || $v{Queue},
168 push @comments, "# Invalid custom field name ($key)";
172 my $val = delete $data{$k};
173 next unless defined $val && length $val;
174 $v{"CustomField-".$cf->Id()} = $cf->SingleValue ? $val : vsplit($val,1);
176 elsif (lc $k eq 'text') {
177 $text = delete $data{$k};
179 elsif (lc $k eq 'attachment') {
180 push @atts, @{ vsplit(delete $data{$k}) };
182 elsif ( $k !~ /^(?:id|requestors)$/i ) {
185 push(@comments, "# $k: Unknown field");
190 unshift @comments, "# Could not create ticket.";
195 # people fields allow multiple values
196 $v{$_} = vsplit($v{$_}) foreach ( grep $create{lc $_}, @people );
198 if ($text || @atts) {
201 Type => "multipart/mixed",
202 From => Encode::encode( "UTF-8", $session{CurrentUser}->EmailAddress ),
203 Subject => Encode::encode( "UTF-8", $v{Subject}),
204 'X-RT-Interface' => 'REST',
207 Type => $v{'Content-Type'} || 'text/plain',
209 Data => Encode::encode( "UTF-8", $text ),
211 my ($status, $msg) = process_attachments($v{'MIMEObj'}, @atts);
213 push(@comments, "# $msg");
216 $v{MIMEObj}->make_singlepart;
219 my($tid,$trid,$terr) = $ticket->Create(%v);
221 push(@comments, "# Could not create ticket.");
222 push(@comments, "# " . $terr);
228 push(@comments, "# Ticket $id created.");
229 # see if the hash is empty
230 goto DONE if ! keys(%data);
234 # Now we know we're dealing with an existing ticket.
236 my ($time, $key, $val, @data);
238 push @data, [ id => "ticket/".$ticket->Id ];
239 push @data, [ Queue => $ticket->QueueObj->Name ]
240 if (!%$fields || exists $fields->{lc 'Queue'});
241 push @data, [ Owner => $ticket->OwnerObj->Name ]
242 if (!%$fields || exists $fields->{lc 'Owner'});
243 push @data, [ Creator => $ticket->CreatorObj->Name ]
244 if (!%$fields || exists $fields->{lc 'Creator'});
246 foreach (qw(Subject Status Priority InitialPriority FinalPriority)) {
247 next unless (!%$fields || (exists $fields->{lc $_}));
248 push @data, [$_ => $ticket->$_ ];
251 foreach $key (@people) {
252 next unless (!%$fields || (exists $fields->{lc $key}));
253 push @data, [ $key => [ $ticket->$key->MemberEmailAddresses ] ];
256 $time = RT::Date->new ($session{CurrentUser});
257 foreach $key (@dates) {
258 next unless (!%$fields || (exists $fields->{lc $key}));
259 $time->Set(Format => 'sql', Value => $ticket->$key);
260 push @data, [ $key => $time->AsString ];
263 $time = RT::Date->new ($session{CurrentUser});
264 foreach $key (qw(TimeEstimated TimeWorked TimeLeft)) {
265 next unless (!%$fields || (exists $fields->{lc $key}));
266 $val = $ticket->$key || 0;
267 $val = "$val minutes" if $val;
268 push @data, [ $key => $val ];
271 # Display custom fields
272 my $CustomFields = $ticket->CustomFields;
273 while (my $cf = $CustomFields->Next()) {
274 next unless !%$fields
275 || exists $fields->{"cf.{".lc($cf->Name)."}"}
276 || exists $fields->{"cf-".lc $cf->Name};
278 my $vals = $ticket->CustomFieldValues($cf->Id());
280 if ( $cf->SingleValue ) {
282 push @out, $v->Content if $v;
285 while (my $v = $vals->Next()) {
286 my $content = $v->Content;
287 if ( $v->Content =~ /,/ ) {
288 $content =~ s/([\\'])/\\$1/g;
289 push @out, q{'} . $content . q{'};
296 push @data, [ ('CF.{' . $cf->Name . '}') => join ',', @out ];
299 my %k = map {@$_} @data;
300 $o = [ map {$_->[0]} @data ];
304 my ($get, $set, $key, $val, $n, $s);
307 foreach $key (keys %data) {
312 if (ref $val eq 'ARRAY') {
313 unless ($key =~ /^(?:Requestors|Cc|AdminCc)$/i) {
315 $s = "$key may have only one value.";
320 if ($key =~ /^queue$/i) {
321 next if $val eq $ticket->QueueObj->Name;
322 ($n, $s) = $ticket->SetQueue($val);
324 elsif ($key =~ /^owner$/i) {
325 next if $val eq $ticket->OwnerObj->Name;
326 ($n, $s) = $ticket->SetOwner($val);
328 elsif (exists $simple{$key}) {
329 $key = $simple{$key};
331 my $current = $ticket->$key;
332 $current = '' unless defined $current;
334 next if ($val eq $current) or ($current =~ /^\d+$/ && $val =~ /^\d+$/ && $val == $current);
335 ($n, $s) = $ticket->$set("$val");
337 elsif (exists $dates{$key}) {
340 # We try to detect whether it should update a field by checking
341 # whether its current value equals the entered value. Since the
342 # LastUpdated field is automatically updated as other columns are
343 # changed, it is not properly skipped. Users cannot update this
345 next if $key eq 'LastUpdated';
349 my $time = RT::Date->new($session{CurrentUser});
350 $time->Set(Format => 'sql', Value => $ticket->$key);
351 next if ($val =~ /^not set$/i || $val eq $time->AsString);
353 $time->Set(Format => 'unknown', Value => $val);
354 ($n, $s) = $ticket->$set($time->ISO);
356 elsif (exists $people{$key}) {
357 $key = $people{$key};
360 my %new = map {$_=>1} @{ vsplit($val) };
361 my %old = map {$_=>1} $ticket->$key->MemberEmailAddresses;
362 my $type = $key eq 'Requestors' ? 'Requestor' : $key;
364 foreach $p (keys %old) {
365 unless (exists $new{$p}) {
366 ($s, $n) = $ticket->DeleteWatcher(Type => $type,
368 push @msgs, [ $s, $n ];
371 foreach $p (keys %new) {
372 unless ($ticket->IsWatcher(Type => $type, Email => $p)) {
373 ($s, $n) = $ticket->AddWatcher(Type => $type,
375 push @msgs, [ $s, $n ];
380 if (@msgs = grep {$_->[0] == 0} @msgs) {
382 $s = join "\n", map {"# ".$_->[1]} @msgs;
387 elsif ($key =~ /^$cf_spec/) {
390 my $cf = RT::CustomField->new( $session{CurrentUser} );
391 $cf->ContextObject( $ticket );
394 LookupType => RT::Ticket->CustomFieldLookupType,
395 ObjectId => $ticket->Queue,
401 $s = "Unknown custom field.";
404 my $vals = $ticket->CustomFieldValues($cf->id);
406 if ( !defined $val || !length $val ) {
407 while ( my $val = $vals->Next ) {
408 ($n, $s) = $ticket->DeleteCustomFieldValue(
409 Field => $cf, ValueId => $val->id,
411 $s =~ s/^# // if defined $s;
414 elsif ( $cf->SingleValue ) {
415 ($n, $s) = $ticket->AddCustomFieldValue(
416 Field => $cf, Value => $val );
417 $s =~ s/^# // if defined $s;
420 my @new = @{vsplit($val, 1)};
425 while (my $v = $vals->Next()) {
431 $ticket->DeleteCustomFieldValue( Field => $cf, ValueId => $v->id );
435 while ( $new{$_} && $new{$_}-- ) {
436 ($n, $s) = $ticket->AddCustomFieldValue(
437 Field => $cf, Value => $_ );
438 $s =~ s/^# // if defined $s;
444 elsif ($key ne 'id' && $key ne 'type' && $key ne 'creator' && $key ne 'content-type' ) {
446 $s = "Unknown field.";
452 push @comments, "# $key: $s";
455 @$o = ("id", grep { $_ ne 'id' } keys %$changes);
463 push(@comments, "# Ticket ".$ticket->id." updated.") if $updated;
467 $c ||= join("\n", @comments) if @comments;
468 return [$c, $o, $k, $e];