Putting 4.2.0 on top of 4.0.17
[usit-rt.git] / share / html / REST / 1.0 / Forms / ticket / default
CommitLineData
84fb5b46
MKG
1%# BEGIN BPS TAGGED BLOCK {{{
2%#
3%# COPYRIGHT:
4%#
403d7b0b 5%# This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
84fb5b46
MKG
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/Forms/ticket/default
49%#
50<%ARGS>
51$id
52$changes => {}
53$fields => undef
54$args => undef
55</%ARGS>
56<%INIT>
57use MIME::Entity;
58use RT::Interface::REST;
59
60my $cf_spec = RT::Interface::REST->custom_field_spec(1);
61
62my @comments;
63my ($c, $o, $k, $e) = ("", [], {}, 0);
64my %data = %$changes;
65my $ticket = RT::Ticket->new($session{CurrentUser});
66my @dates = qw(Created Starts Started Due Resolved Told LastUpdated);
67my @people = qw(Requestors Cc AdminCc);
68my @create = qw(Queue Requestor Subject Cc AdminCc Owner Status Priority
69 InitialPriority FinalPriority TimeEstimated TimeWorked
01e3b242 70 TimeLeft Starts Started Due Resolved Content-Type);
84fb5b46
MKG
71my @simple = qw(Subject Status Priority Disabled TimeEstimated TimeWorked
72 TimeLeft InitialPriority FinalPriority);
73my %dates = map {lc $_ => $_} @dates;
74my %people = map {lc $_ => $_} @people;
75my %create = map {lc $_ => $_} @create;
76my %simple = map {lc $_ => $_} @simple;
77
78# Are we dealing with an existing ticket?
79if ($id ne 'new') {
80 $ticket->Load($id);
81 if (!$ticket->Id) {
82 return [ "# Ticket $id does not exist.", [], {}, 1 ];
83 }
84 elsif ( %data ) {
01e3b242 85 if ( $data{status} && lc $data{status} eq 'deleted' && ! grep { $_ ne 'id' && $_ ne 'status' } keys %data ) {
84fb5b46
MKG
86 if ( !$ticket->CurrentUserHasRight('DeleteTicket') ) {
87 return [ "# You are not allowed to delete ticket $id.", [], {}, 1 ];
88 }
89 }
90 elsif ( !$ticket->CurrentUserHasRight('ModifyTicket') ) {
91 return [ "# You are not allowed to modify ticket $id.", [], {}, 1 ];
92 }
93 }
94 elsif (!$ticket->CurrentUserHasRight('ShowTicket')) {
95 return [ "# You are not allowed to display ticket $id.", [], {}, 1 ];
96 }
97}
98else {
99 if (!keys(%data)) {
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 $due = RT::Date->new($session{CurrentUser});
103 my $queue = RT::Queue->new($session{CurrentUser});
104 my $starts = RT::Date->new($session{CurrentUser});
105 $queue->Load(1);
106 $due->SetToNow;
107 $due->AddDays($queue->DefaultDueIn) if $queue->DefaultDueIn;
108 $starts->SetToNow;
109
110 return [
111 "# Required: id, Queue",
112 [ qw(id Queue Requestor Subject Cc AdminCc Owner Status Priority
01e3b242 113 InitialPriority FinalPriority TimeEstimated Starts Due Attachment Text) ],
84fb5b46
MKG
114 {
115 id => "ticket/new",
116 Queue => $queue->Name,
117 Requestor => $session{CurrentUser}->Name,
118 Subject => "",
119 Cc => [],
120 AdminCc => [],
121 Owner => "",
122 Status => "new",
123 Priority => $queue->InitialPriority,
124 InitialPriority => $queue->InitialPriority,
125 FinalPriority => $queue->FinalPriority,
126 TimeEstimated => 0,
127 Starts => $starts->ISO,
128 Due => $due->ISO,
01e3b242 129 Attachment => '',
84fb5b46
MKG
130 Text => "",
131 },
132 0
133 ];
134 }
135 else {
136 # We'll create a new ticket, and fall through to set fields that
137 # can't be set in the call to Create().
01e3b242 138 my (%v, $text, @atts);
84fb5b46
MKG
139
140 foreach my $k (keys %data) {
141 # flexibly parse any dates
142 if ($dates{lc $k}) {
143 my $time = RT::Date->new($session{CurrentUser});
144 $time->Set(Format => 'unknown', Value => $data{$k});
145 $data{$k} = $time->ISO;
146 }
147
148 if (exists $create{lc $k}) {
149 $v{$create{lc $k}} = delete $data{$k};
150 }
151 # Set custom field
152 elsif ($k =~ /^$cf_spec/) {
b5747ff2
MKG
153 my $key = $1 || $2;
154
155 my $cf = RT::CustomField->new( $session{CurrentUser} );
156 $cf->LoadByName( Name => $key, Queue => $data{Queue} || $v{Queue} );
157 unless ( $cf->id ) {
158 $cf->LoadByName( Name => $key, Queue => 0 );
159 }
160
161 if (not $cf->id) {
162 push @comments, "# Invalid custom field name ($key)";
84fb5b46
MKG
163 delete $data{$k};
164 next;
165 }
166 $v{"CustomField-".$cf->Id()} = delete $data{$k};
167 }
168 elsif (lc $k eq 'text') {
169 $text = delete $data{$k};
170 }
01e3b242
MKG
171 elsif (lc $k eq 'attachment') {
172 push @atts, @{ vsplit(delete $data{$k}) };
173 }
403d7b0b 174 elsif ( $k !~ /^(?:id|requestors)$/i ) {
dab09ea8
MKG
175 $e = 1;
176 push @$o, $k;
177 push(@comments, "# $k: Unknown field");
178 }
179 }
180
181 if ( $e ) {
182 unshift @comments, "# Could not create ticket.";
183 $k = \%data;
184 goto DONE;
84fb5b46
MKG
185 }
186
187 # people fields allow multiple values
188 $v{$_} = vsplit($v{$_}) foreach ( grep $create{lc $_}, @people );
189
01e3b242 190 if ($text || @atts) {
84fb5b46
MKG
191 $v{MIMEObj} =
192 MIME::Entity->build(
01e3b242 193 Type => "multipart/mixed",
84fb5b46
MKG
194 From => $session{CurrentUser}->EmailAddress,
195 Subject => $v{Subject},
403d7b0b 196 'X-RT-Interface' => 'REST',
af59614d 197 'Content-Type' => $v{'Content-Type'} || 'text/plain',
84fb5b46 198 );
01e3b242
MKG
199 $v{MIMEObj}->attach(
200 Data => $text,
201 'Content-Type' => $v{'Content-Type'} || 'text/plain',
202 ) if $text;
203 my ($status, $msg) = process_attachments($v{'MIMEObj'}, @atts);
204 unless ($status) {
205 push(@comments, "# $msg");
206 goto DONE;
207 }
208 $v{MIMEObj}->make_singlepart;
84fb5b46
MKG
209 }
210
211 my($tid,$trid,$terr) = $ticket->Create(%v);
212 unless ($tid) {
213 push(@comments, "# Could not create ticket.");
214 push(@comments, "# " . $terr);
215 goto DONE;
216 }
217
218 delete $data{id};
219 $id = $ticket->Id;
220 push(@comments, "# Ticket $id created.");
221 # see if the hash is empty
222 goto DONE if ! keys(%data);
223 }
224}
225
226# Now we know we're dealing with an existing ticket.
227if (!keys(%data)) {
228 my ($time, $key, $val, @data);
229
230 push @data, [ id => "ticket/".$ticket->Id ];
af59614d
MKG
231 push @data, [ Queue => $ticket->QueueObj->Name ]
232 if (!%$fields || exists $fields->{lc 'Queue'});
84fb5b46 233 push @data, [ Owner => $ticket->OwnerObj->Name ]
af59614d 234 if (!%$fields || exists $fields->{lc 'Owner'});
84fb5b46 235 push @data, [ Creator => $ticket->CreatorObj->Name ]
af59614d 236 if (!%$fields || exists $fields->{lc 'Creator'});
84fb5b46
MKG
237
238 foreach (qw(Subject Status Priority InitialPriority FinalPriority)) {
af59614d 239 next unless (!%$fields || (exists $fields->{lc $_}));
84fb5b46
MKG
240 push @data, [$_ => $ticket->$_ ];
241 }
242
243 foreach $key (@people) {
244 next unless (!%$fields || (exists $fields->{lc $key}));
245 push @data, [ $key => [ $ticket->$key->MemberEmailAddresses ] ];
246 }
247
248 $time = RT::Date->new ($session{CurrentUser});
249 foreach $key (@dates) {
af59614d 250 next unless (!%$fields || (exists $fields->{lc $key}));
84fb5b46
MKG
251 $time->Set(Format => 'sql', Value => $ticket->$key);
252 push @data, [ $key => $time->AsString ];
253 }
254
255 $time = RT::Date->new ($session{CurrentUser});
256 foreach $key (qw(TimeEstimated TimeWorked TimeLeft)) {
af59614d 257 next unless (!%$fields || (exists $fields->{lc $key}));
84fb5b46
MKG
258 $val = $ticket->$key || 0;
259 $val = "$val minutes" if $val;
260 push @data, [ $key => $val ];
261 }
262
263 # Display custom fields
264 my $CustomFields = $ticket->CustomFields;
265 while (my $cf = $CustomFields->Next()) {
266 next unless !%$fields
267 || exists $fields->{"cf.{".lc($cf->Name)."}"}
268 || exists $fields->{"cf-".lc $cf->Name};
269
270 my $vals = $ticket->CustomFieldValues($cf->Id());
271 my @out = ();
272 if ( $cf->SingleValue ) {
273 my $v = $vals->Next;
274 push @out, $v->Content if $v;
275 }
276 else {
277 while (my $v = $vals->Next()) {
278 my $content = $v->Content;
279 $content =~ s/'/\\'/g;
280 if ( $v->Content =~ /,/ ) {
281 push @out, q{'} . $content . q{'};
282 }
283 else {
284 push @out, $content;
285 }
286 }
287 }
288 push @data, [ ('CF.{' . $cf->Name . '}') => join ',', @out ];
289 }
290
291 my %k = map {@$_} @data;
292 $o = [ map {$_->[0]} @data ];
293 $k = \%k;
294}
295else {
296 my ($get, $set, $key, $val, $n, $s);
01e3b242 297 my $updated;
84fb5b46
MKG
298
299 foreach $key (keys %data) {
300 $val = $data{$key};
301 $key = lc $key;
302 $n = 1;
303
304 if (ref $val eq 'ARRAY') {
305 unless ($key =~ /^(?:Requestors|Cc|AdminCc)$/i) {
306 $n = 0;
307 $s = "$key may have only one value.";
308 goto SET;
309 }
310 }
311
312 if ($key =~ /^queue$/i) {
313 next if $val eq $ticket->QueueObj->Name;
314 ($n, $s) = $ticket->SetQueue($val);
315 }
316 elsif ($key =~ /^owner$/i) {
317 next if $val eq $ticket->OwnerObj->Name;
318 ($n, $s) = $ticket->SetOwner($val);
319 }
320 elsif (exists $simple{$key}) {
321 $key = $simple{$key};
322 $set = "Set$key";
dab09ea8
MKG
323 my $current = $ticket->$key;
324 $current = '' unless defined $current;
84fb5b46 325
dab09ea8 326 next if ($val eq $current) or ($current =~ /^\d+$/ && $val =~ /^\d+$/ && $val == $current);
84fb5b46
MKG
327 ($n, $s) = $ticket->$set("$val");
328 }
329 elsif (exists $dates{$key}) {
330 $key = $dates{$key};
331
332 # We try to detect whether it should update a field by checking
333 # whether its current value equals the entered value. Since the
334 # LastUpdated field is automatically updated as other columns are
335 # changed, it is not properly skipped. Users cannot update this
336 # field anyway.
337 next if $key eq 'LastUpdated';
338
339 $set = "Set$key";
340
341 my $time = RT::Date->new($session{CurrentUser});
342 $time->Set(Format => 'sql', Value => $ticket->$key);
343 next if ($val =~ /^not set$/i || $val eq $time->AsString);
344
345 $time->Set(Format => 'unknown', Value => $val);
346 ($n, $s) = $ticket->$set($time->ISO);
347 }
348 elsif (exists $people{$key}) {
349 $key = $people{$key};
350 my ($p, @msgs);
351
352 my %new = map {$_=>1} @{ vsplit($val) };
353 my %old = map {$_=>1} $ticket->$key->MemberEmailAddresses;
354 my $type = $key eq 'Requestors' ? 'Requestor' : $key;
355
356 foreach $p (keys %old) {
357 unless (exists $new{$p}) {
358 ($s, $n) = $ticket->DeleteWatcher(Type => $type,
359 Email => $p);
360 push @msgs, [ $s, $n ];
361 }
362 }
363 foreach $p (keys %new) {
84fb5b46
MKG
364 unless ($ticket->IsWatcher(Type => $type, Email => $p)) {
365 ($s, $n) = $ticket->AddWatcher(Type => $type,
366 Email => $p);
367 push @msgs, [ $s, $n ];
368 }
369 }
370
371 $n = 1;
372 if (@msgs = grep {$_->[0] == 0} @msgs) {
373 $n = 0;
374 $s = join "\n", map {"# ".$_->[1]} @msgs;
375 $s =~ s/^# //;
376 }
377 }
378 # Set custom field
379 elsif ($key =~ /^$cf_spec/) {
84fb5b46 380 $key = $1 || $2;
b5747ff2
MKG
381
382 my $cf = RT::CustomField->new( $session{CurrentUser} );
383 $cf->LoadByName( Name => $key, Queue => $ticket->Queue );
384 unless ( $cf->id ) {
385 $cf->LoadByName( Name => $key, Queue => 0 );
386 }
387
388 if (not $cf->id) {
84fb5b46
MKG
389 $n = 0;
390 $s = "Unknown custom field.";
391 }
392 else {
393 my $vals = $ticket->CustomFieldValues($cf->id);
394
403d7b0b
MKG
395 if ( !defined $val || !length $val ) {
396 while ( my $val = $vals->Next ) {
397 ($n, $s) = $ticket->DeleteCustomFieldValue(
398 Field => $cf, ValueId => $val->id,
399 );
400 $s =~ s/^# // if defined $s;
401 }
402 }
403 elsif ( $cf->SingleValue ) {
af59614d
MKG
404 ($n, $s) = $ticket->AddCustomFieldValue(
405 Field => $cf, Value => $val );
406 $s =~ s/^# // if defined $s;
84fb5b46
MKG
407 }
408 else {
409 my @new;
410 my ( $a, $b ) = split /\s*,\s*/, $val, 2;
411 while ($a) {
412 no warnings 'uninitialized';
413 if ( $a =~ /^'/ ) {
414 my $s = $a;
415 while ( $a !~ /'$/ || ( $a !~ /(\\\\)+'$/
416 && $a =~ /(\\)+'$/ ) ) {
417 ( $a, $b ) = split /\s*,\s*/, $b, 2;
418 $s .= ',' . $a;
419 }
420 $s =~ s/^'//;
421 $s =~ s/'$//;
422 $s =~ s/\\'/'/g;
423 push @new, $s;
424 }
01e3b242 425 elsif ( $a =~ /^q\{/ ) {
84fb5b46 426 my $s = $a;
01e3b242 427 while ( $a !~ /\}$/ ) {
84fb5b46
MKG
428 ( $a, $b ) = split /\s*,\s*/, $b, 2;
429 $s .= ',' . $a;
430 }
01e3b242
MKG
431 $s =~ s/^q\{//;
432 $s =~ s/\}//;
84fb5b46
MKG
433 push @new, $s;
434 }
435 else {
436 push @new, $a;
437 }
438 ( $a, $b ) = split /\s*,\s*/, $b, 2;
439 }
440
441 my %new;
442 $new{$_}++ for @new;
443
444 while (my $v = $vals->Next()) {
445 my $c = $v->Content;
446 if ( $new{$c} ) {
447 $new{$c}--;
448 }
449 else {
403d7b0b 450 $ticket->DeleteCustomFieldValue( Field => $cf, ValueId => $v->id );
84fb5b46
MKG
451 }
452 }
453 for ( @new ) {
454 while ( $new{$_} && $new{$_}-- ) {
455 ($n, $s) = $ticket->AddCustomFieldValue(
456 Field => $cf, Value => $_ );
457 $s =~ s/^# // if defined $s;
458 }
459 }
460 }
461 }
462 }
01e3b242 463 elsif ($key ne 'id' && $key ne 'type' && $key ne 'creator' && $key ne 'content-type' ) {
84fb5b46
MKG
464 $n = 0;
465 $s = "Unknown field.";
466 }
467
468 SET:
469 if ($n == 0) {
470 $e = 1;
471 push @comments, "# $key: $s";
472 unless (@$o) {
473 # move id forward
474 @$o = ("id", grep { $_ ne 'id' } keys %$changes);
475 $k = $changes;
476 }
477 }
01e3b242
MKG
478 else {
479 $updated ||= 1;
480 }
84fb5b46 481 }
01e3b242 482 push(@comments, "# Ticket ".$ticket->id." updated.") if $updated;
84fb5b46
MKG
483}
484
485DONE:
486$c ||= join("\n", @comments) if @comments;
487return [$c, $o, $k, $e];
488
489</%INIT>