3629a7f69769cd578748331a51d3ab4ae46c9338
[WebKit-https.git] / Websites / bugs.webkit.org / attachment.cgi
1 #!/usr/bin/env perl -wT
2 # -*- Mode: perl; indent-tabs-mode: nil -*-
3 #
4 # The contents of this file are subject to the Mozilla Public
5 # License Version 1.1 (the "License"); you may not use this file
6 # except in compliance with the License. You may obtain a copy of
7 # the License at http://www.mozilla.org/MPL/
8 #
9 # Software distributed under the License is distributed on an "AS
10 # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
11 # implied. See the License for the specific language governing
12 # rights and limitations under the License.
13 #
14 # The Original Code is the Bugzilla Bug Tracking System.
15 #
16 # The Initial Developer of the Original Code is Netscape Communications
17 # Corporation. Portions created by Netscape are
18 # Copyright (C) 1998 Netscape Communications Corporation. All
19 # Rights Reserved.
20 #
21 # Contributor(s): Terry Weissman <terry@mozilla.org>
22 #                 Myk Melez <myk@mozilla.org>
23 #                 Daniel Raichle <draichle@gmx.net>
24 #                 Dave Miller <justdave@syndicomm.com>
25 #                 Alexander J. Vincent <ajvincent@juno.com>
26 #                 Max Kanat-Alexander <mkanat@bugzilla.org>
27 #                 Greg Hendricks <ghendricks@novell.com>
28 #                 Frédéric Buclin <LpSolit@gmail.com>
29 #                 Marc Schumann <wurblzap@gmail.com>
30 #                 Byron Jones <bugzilla@glob.com.au>
31
32 ################################################################################
33 # Script Initialization
34 ################################################################################
35
36 # Make it harder for us to do dangerous things in Perl.
37 use strict;
38
39 use lib qw(. lib);
40
41 use Bugzilla;
42 use Bugzilla::Constants;
43 use Bugzilla::Error;
44 use Bugzilla::Flag; 
45 use Bugzilla::FlagType; 
46 use Bugzilla::User;
47 use Bugzilla::Util;
48 use Bugzilla::Bug;
49 use Bugzilla::Field;
50 use Bugzilla::Attachment;
51 use Bugzilla::Attachment::PatchReader;
52 use Bugzilla::Token;
53 use Bugzilla::Keyword;
54
55 #if WEBKIT_CHANGES
56 use Apache2::SubProcess ();
57 use Apache2::RequestUtil ();
58 #endif // WEBKIT_CHANGES
59
60 # For most scripts we don't make $cgi and $template global variables. But
61 # when preparing Bugzilla for mod_perl, this script used these
62 # variables in so many subroutines that it was easier to just
63 # make them globals.
64 local our $cgi = Bugzilla->cgi;
65 local our $template = Bugzilla->template;
66 local our $vars = {};
67
68 ################################################################################
69 # Main Body Execution
70 ################################################################################
71
72 # All calls to this script should contain an "action" variable whose
73 # value determines what the user wants to do.  The code below checks
74 # the value of that variable and runs the appropriate code. If none is
75 # supplied, we default to 'view'.
76
77 # Determine whether to use the action specified by the user or the default.
78 my $action = $cgi->param('action') || 'view';
79
80 # You must use the appropriate urlbase/sslbase param when doing anything
81 # but viewing an attachment.
82 if ($action ne 'view') {
83     my $urlbase = Bugzilla->params->{'urlbase'};
84     my $sslbase = Bugzilla->params->{'sslbase'};
85     my $path_regexp = $sslbase ? qr/^(\Q$urlbase\E|\Q$sslbase\E)/ : qr/^\Q$urlbase\E/;
86     if (use_attachbase() && $cgi->self_url !~ /$path_regexp/) {
87         $cgi->redirect_to_urlbase;
88     }
89     Bugzilla->login();
90 }
91
92 # Determine if PatchReader is installed
93 eval {
94     require PatchReader;
95     $vars->{'patchviewerinstalled'} = 1;
96 };
97
98 # When viewing an attachment, do not request credentials if we are on
99 # the alternate host. Let view() decide when to call Bugzilla->login.
100 if ($action eq "view")
101 {
102     view();
103 }
104 elsif ($action eq "interdiff")
105 {
106     interdiff();
107 }
108 elsif ($action eq "diff")
109 {
110     diff();
111 }
112 elsif ($action eq "viewall") 
113
114     viewall(); 
115 }
116 elsif ($action eq "enter") 
117
118     Bugzilla->login(LOGIN_REQUIRED);
119     enter(); 
120 }
121 elsif ($action eq "insert")
122 {
123     Bugzilla->login(LOGIN_REQUIRED);
124     insert();
125 }
126 elsif ($action eq "edit") 
127
128     edit(); 
129 }
130 #if WEBKIT_CHANGES
131 elsif ($action eq "review")
132 {
133     prettyPatch();
134 }
135 elsif ($action eq "reviewform")
136 {
137     edit("reviewform");
138 }
139 elsif ($action eq "rietveldreview")
140 {
141     edit("rietveldreview");
142 }
143 #endif // WEBKIT_CHANGES
144 elsif ($action eq "update") 
145
146     Bugzilla->login(LOGIN_REQUIRED);
147     update();
148 }
149 #if WEBKIT_CHANGES
150 elsif ($action eq "prettypatch")
151 {
152     prettyPatch();
153 }
154 #endif // WEBKIT_CHANGES
155 elsif ($action eq "delete") {
156     delete_attachment();
157 }
158 else 
159
160   ThrowCodeError("unknown_action", { action => $action });
161 }
162
163 exit;
164
165 ################################################################################
166 # Data Validation / Security Authorization
167 ################################################################################
168
169 # Validates an attachment ID. Optionally takes a parameter of a form
170 # variable name that contains the ID to be validated. If not specified,
171 # uses 'id'.
172 # If the second parameter is true, the attachment ID will be validated,
173 # however the current user's access to the attachment will not be checked.
174 # Will throw an error if 1) attachment ID is not a valid number,
175 # 2) attachment does not exist, or 3) user isn't allowed to access the
176 # attachment.
177 #
178 # Returns an attachment object.
179
180 sub validateID {
181     my($param, $dont_validate_access) = @_;
182     $param ||= 'id';
183
184     # If we're not doing interdiffs, check if id wasn't specified and
185     # prompt them with a page that allows them to choose an attachment.
186     # Happens when calling plain attachment.cgi from the urlbar directly
187     if ($param eq 'id' && !$cgi->param('id')) {
188         print $cgi->header();
189         $template->process("attachment/choose.html.tmpl", $vars) ||
190             ThrowTemplateError($template->error());
191         exit;
192     }
193     
194     my $attach_id = $cgi->param($param);
195
196     # Validate the specified attachment id. detaint kills $attach_id if
197     # non-natural, so use the original value from $cgi in our exception
198     # message here.
199     detaint_natural($attach_id)
200      || ThrowUserError("invalid_attach_id", { attach_id => $cgi->param($param) });
201   
202     # Make sure the attachment exists in the database.
203     my $attachment = Bugzilla::Attachment->get($attach_id)
204       || ThrowUserError("invalid_attach_id", { attach_id => $attach_id });
205
206     return $attachment if ($dont_validate_access || check_can_access($attachment));
207 }
208
209 # Make sure the current user has access to the specified attachment.
210 sub check_can_access {
211     my $attachment = shift;
212     my $user = Bugzilla->user;
213
214     # Make sure the user is authorized to access this attachment's bug.
215     ValidateBugID($attachment->bug_id);
216     if ($attachment->isprivate && $user->id != $attachment->attacher->id && !$user->is_insider) {
217         ThrowUserError('auth_failure', {action => 'access',
218                                         object => 'attachment'});
219     }
220     return 1;
221 }
222
223 # Determines if the attachment is public -- that is, if users who are
224 # not logged in have access to the attachment
225 sub attachmentIsPublic {
226     my $attachment = shift;
227
228     return 0 if Bugzilla->params->{'requirelogin'};
229     return 0 if $attachment->isprivate;
230
231     my $anon_user = new Bugzilla::User;
232     return $anon_user->can_see_bug($attachment->bug_id);
233 }
234
235 # Validates format of a diff/interdiff. Takes a list as an parameter, which
236 # defines the valid format values. Will throw an error if the format is not
237 # in the list. Returns either the user selected or default format.
238 sub validateFormat
239 {
240   # receives a list of legal formats; first item is a default
241   my $format = $cgi->param('format') || $_[0];
242   if ( lsearch(\@_, $format) == -1)
243   {
244      ThrowUserError("invalid_format", { format  => $format, formats => \@_ });
245   }
246
247   return $format;
248 }
249
250 # Validates context of a diff/interdiff. Will throw an error if the context
251 # is not number, "file" or "patch". Returns the validated, detainted context.
252 sub validateContext
253 {
254   my $context = $cgi->param('context') || "patch";
255   if ($context ne "file" && $context ne "patch") {
256     detaint_natural($context)
257       || ThrowUserError("invalid_context", { context => $cgi->param('context') });
258   }
259
260   return $context;
261 }
262
263 sub validateCanChangeBug
264 {
265     my ($bugid) = @_;
266     my $dbh = Bugzilla->dbh;
267     my ($productid) = $dbh->selectrow_array(
268             "SELECT product_id
269              FROM bugs 
270              WHERE bug_id = ?", undef, $bugid);
271
272     Bugzilla->user->can_edit_product($productid)
273       || ThrowUserError("illegal_attachment_edit_bug",
274                         { bug_id => $bugid });
275 }
276
277 ################################################################################
278 # Functions
279 ################################################################################
280
281 # Display an attachment.
282 sub view {
283     my $attachment;
284
285     if (use_attachbase()) {
286         $attachment = validateID(undef, 1);
287         # Replace %bugid% by the ID of the bug the attachment belongs to, if present.
288         my $attachbase = Bugzilla->params->{'attachment_base'};
289         my $bug_id = $attachment->bug_id;
290         $attachbase =~ s/%bugid%/$bug_id/;
291         my $path = 'attachment.cgi?id=' . $attachment->id;
292
293         # Make sure the attachment is served from the correct server.
294         if ($cgi->self_url !~ /^\Q$attachbase\E/) {
295             # We couldn't call Bugzilla->login earlier as we first had to make sure
296             # we were not going to request credentials on the alternate host.
297             Bugzilla->login();
298             if (attachmentIsPublic($attachment)) {
299                 # No need for a token; redirect to attachment base.
300                 print $cgi->redirect(-location => $attachbase . $path);
301                 exit;
302             } else {
303                 # Make sure the user can view the attachment.
304                 check_can_access($attachment);
305                 # Create a token and redirect.
306                 my $token = url_quote(issue_session_token($attachment->id));
307                 print $cgi->redirect(-location => $attachbase . "$path&t=$token");
308                 exit;
309             }
310         } else {
311             # No need to validate the token for public attachments. We cannot request
312             # credentials as we are on the alternate host.
313             if (!attachmentIsPublic($attachment)) {
314                 my $token = $cgi->param('t');
315                 my ($userid, undef, $token_attach_id) = Bugzilla::Token::GetTokenData($token);
316                 unless ($userid
317                         && detaint_natural($token_attach_id)
318                         && ($token_attach_id == $attachment->id))
319                 {
320                     # Not a valid token.
321                     print $cgi->redirect('-location' => correct_urlbase() . $path);
322                     exit;
323                 }
324                 # Change current user without creating cookies.
325                 Bugzilla->set_user(new Bugzilla::User($userid));
326                 # Tokens are single use only, delete it.
327                 delete_token($token);
328             }
329         }
330     } else {
331         # No alternate host is used. Request credentials if required.
332         Bugzilla->login();
333         $attachment = validateID();
334     }
335
336     # At this point, Bugzilla->login has been called if it had to.
337     my $contenttype = $attachment->contenttype;
338     my $filename = $attachment->filename;
339
340     # Bug 111522: allow overriding content-type manually in the posted form
341     # params.
342     if (defined $cgi->param('content_type'))
343     {
344         $cgi->param('contenttypemethod', 'manual');
345         $cgi->param('contenttypeentry', $cgi->param('content_type'));
346         Bugzilla::Attachment->validate_content_type(THROW_ERROR);
347         $contenttype = $cgi->param('content_type');
348     }
349
350     # Return the appropriate HTTP response headers.
351     $attachment->datasize || ThrowUserError("attachment_removed");
352
353     $filename =~ s/^.*[\/\\]//;
354     # escape quotes and backslashes in the filename, per RFCs 2045/822
355     $filename =~ s/\\/\\\\/g; # escape backslashes
356     $filename =~ s/"/\\"/g; # escape quotes
357
358     my $disposition = Bugzilla->params->{'allow_attachment_display'} ? 'inline' : 'attachment';
359
360     print $cgi->header(-type=>"$contenttype; name=\"$filename\"",
361                        -content_disposition=> "$disposition; filename=\"$filename\"",
362                        -content_length => $attachment->datasize);
363     disable_utf8();
364     print $attachment->data;
365 }
366
367 sub interdiff {
368     # Retrieve and validate parameters
369     my $old_attachment = validateID('oldid');
370     my $new_attachment = validateID('newid');
371     my $format = validateFormat('html', 'raw');
372     my $context = validateContext();
373
374     Bugzilla::Attachment::PatchReader::process_interdiff(
375         $old_attachment, $new_attachment, $format, $context);
376 }
377
378 #if WEBKIT_CHANGES
379 sub prettyPatch
380 {
381     # Retrieve and validate parameters
382     my $attachment = validateID();
383     my $format = validateFormat('html', 'raw');
384     my $context = validateContext();
385
386     # If it is not a patch, view normally.
387     if (!$attachment->ispatch) {
388       view();
389       return;
390     }
391
392     use vars qw($cgi);
393     print $cgi->header(-type => 'text/html',
394                        -expires => '+3M');
395
396     my @prettyargs = ("-I", "/var/www/html/PrettyPatch", "/var/www/html/PrettyPatch/prettify.rb", "--html-exceptions");
397     my $r = Apache2::RequestUtil->request;
398     my ($in, $out, $err) = $r->spawn_proc_prog("/usr/bin/ruby", \@prettyargs);
399     print $in $attachment->data;
400     close($in);
401     while (<$out>) {
402         print;
403     }
404     close($out);
405     close($err);
406 }
407 #endif // WEBKIT_CHANGES
408
409 sub diff {
410     # Retrieve and validate parameters
411     my $attachment = validateID();
412     my $format = validateFormat('html', 'raw');
413     my $context = validateContext();
414
415     # If it is not a patch, view normally.
416     if (!$attachment->ispatch) {
417         view();
418         return;
419     }
420
421     Bugzilla::Attachment::PatchReader::process_diff($attachment, $format, $context);
422 }
423
424 # Display all attachments for a given bug in a series of IFRAMEs within one
425 # HTML page.
426 sub viewall {
427     # Retrieve and validate parameters
428     my $bugid = $cgi->param('bugid');
429     ValidateBugID($bugid);
430     my $bug = new Bugzilla::Bug($bugid);
431
432     my $attachments = Bugzilla::Attachment->get_attachments_by_bug($bugid);
433
434     # Define the variables and functions that will be passed to the UI template.
435     $vars->{'bug'} = $bug;
436     $vars->{'attachments'} = $attachments;
437
438     print $cgi->header();
439
440     # Generate and return the UI (HTML page) from the appropriate template.
441     $template->process("attachment/show-multiple.html.tmpl", $vars)
442       || ThrowTemplateError($template->error());
443 }
444
445 # Display a form for entering a new attachment.
446 sub enter {
447   # Retrieve and validate parameters
448   my $bugid = $cgi->param('bugid');
449   ValidateBugID($bugid);
450   validateCanChangeBug($bugid);
451   my $dbh = Bugzilla->dbh;
452   my $user = Bugzilla->user;
453
454   my $bug = new Bugzilla::Bug($bugid, $user->id);
455   # Retrieve the attachments the user can edit from the database and write
456   # them into an array of hashes where each hash represents one attachment.
457   my $canEdit = "";
458   if (!$user->in_group('editbugs', $bug->product_id)) {
459       $canEdit = "AND submitter_id = " . $user->id;
460   }
461   my $attach_ids = $dbh->selectcol_arrayref("SELECT attach_id FROM attachments
462                                              WHERE bug_id = ? AND isobsolete = 0 $canEdit
463                                              ORDER BY attach_id", undef, $bugid);
464
465   # Define the variables and functions that will be passed to the UI template.
466   $vars->{'bug'} = $bug;
467   $vars->{'attachments'} = Bugzilla::Attachment->get_list($attach_ids);
468
469   my $flag_types = Bugzilla::FlagType::match({'target_type'  => 'attachment',
470                                               'product_id'   => $bug->product_id,
471                                               'component_id' => $bug->component_id});
472   $vars->{'flag_types'} = $flag_types;
473   $vars->{'any_flags_requesteeble'} = grep($_->is_requesteeble, @$flag_types);
474   $vars->{'token'} = issue_session_token('createattachment:');
475
476   print $cgi->header();
477
478   # Generate and return the UI (HTML page) from the appropriate template.
479   $template->process("attachment/create.html.tmpl", $vars)
480     || ThrowTemplateError($template->error());
481 }
482
483 # Insert a new attachment into the database.
484 sub insert {
485     my $dbh = Bugzilla->dbh;
486     my $user = Bugzilla->user;
487
488     $dbh->bz_start_transaction;
489
490     # Retrieve and validate parameters
491     my $bugid = $cgi->param('bugid');
492     ValidateBugID($bugid);
493     validateCanChangeBug($bugid);
494     my ($timestamp) = Bugzilla->dbh->selectrow_array("SELECT NOW()");
495
496     # Detect if the user already used the same form to submit an attachment
497     my $token = trim($cgi->param('token'));
498     if ($token) {
499         my ($creator_id, $date, $old_attach_id) = Bugzilla::Token::GetTokenData($token);
500         unless ($creator_id 
501             && ($creator_id == $user->id) 
502                 && ($old_attach_id =~ "^createattachment:")) 
503         {
504             # The token is invalid.
505             ThrowUserError('token_does_not_exist');
506         }
507     
508         $old_attach_id =~ s/^createattachment://;
509    
510         if ($old_attach_id) {
511             $vars->{'bugid'} = $bugid;
512             $vars->{'attachid'} = $old_attach_id;
513             print $cgi->header();
514             $template->process("attachment/cancel-create-dupe.html.tmpl",  $vars)
515                 || ThrowTemplateError($template->error());
516             exit;
517         }
518     }
519
520     my $bug = new Bugzilla::Bug($bugid);
521     my $attachment =
522         Bugzilla::Attachment->insert_attachment_for_bug(THROW_ERROR, $bug, $user,
523                                                         $timestamp, $vars);
524
525     # Insert a comment about the new attachment into the database.
526     my $comment = "Created an attachment (id=" . $attachment->id . ")\n" .
527                   $attachment->description . "\n";
528     $comment .= ("\n" . $cgi->param('comment')) if defined $cgi->param('comment');
529
530     $bug->add_comment($comment, { isprivate => $attachment->isprivate });
531
532   # Assign the bug to the user, if they are allowed to take it
533   my $owner = "";
534   if ($cgi->param('takebug') && $user->in_group('editbugs', $bug->product_id)) {
535       # When taking a bug, we have to follow the workflow.
536       my $bug_status = $cgi->param('bug_status') || '';
537       ($bug_status) = grep {$_->name eq $bug_status} @{$bug->status->can_change_to};
538
539       if ($bug_status && $bug_status->is_open
540           && ($bug_status->name ne 'UNCONFIRMED' || $bug->product_obj->votes_to_confirm))
541       {
542           $bug->set_status($bug_status->name);
543           $bug->clear_resolution();
544       }
545       # Make sure the person we are taking the bug from gets mail.
546       $owner = $bug->assigned_to->login;
547       $bug->set_assigned_to($user);
548   }
549   $bug->update($timestamp);
550
551   if ($token) {
552       trick_taint($token);
553       $dbh->do('UPDATE tokens SET eventdata = ? WHERE token = ?', undef,
554                ("createattachment:" . $attachment->id, $token));
555   }
556
557   $dbh->bz_commit_transaction;
558
559   # Define the variables and functions that will be passed to the UI template.
560   $vars->{'mailrecipients'} =  { 'changer' => $user->login,
561                                  'owner'   => $owner };
562   $vars->{'attachment'} = $attachment;
563   # We cannot reuse the $bug object as delta_ts has eventually been updated
564   # since the object was created.
565   $vars->{'bugs'} = [new Bugzilla::Bug($bugid)];
566   $vars->{'header_done'} = 1;
567   $vars->{'contenttypemethod'} = $cgi->param('contenttypemethod');
568   $vars->{'use_keywords'} = 1 if Bugzilla::Keyword::keyword_count();
569
570   print $cgi->header();
571   # Generate and return the UI (HTML page) from the appropriate template.
572   $template->process("attachment/created.html.tmpl", $vars)
573     || ThrowTemplateError($template->error());
574 }
575
576 # Displays a form for editing attachment properties.
577 # Any user is allowed to access this page, unless the attachment
578 # is private and the user does not belong to the insider group.
579 # Validations are done later when the user submits changes.
580 sub edit {
581 #if WEBKIT_CHANGES
582   my ($template_name) = @_;
583   $template_name = $template_name || "edit";
584 #endif // WEBKIT_CHANGES
585
586   my $attachment = validateID();
587   my $dbh = Bugzilla->dbh;
588
589   # Retrieve a list of attachments for this bug as well as a summary of the bug
590   # to use in a navigation bar across the top of the screen.
591   my $bugattachments =
592       Bugzilla::Attachment->get_attachments_by_bug($attachment->bug_id);
593   # We only want attachment IDs.
594   @$bugattachments = map { $_->id } @$bugattachments;
595
596   my ($bugsummary, $product_id, $component_id) =
597       $dbh->selectrow_array('SELECT short_desc, product_id, component_id
598                                FROM bugs
599                               WHERE bug_id = ?', undef, $attachment->bug_id);
600
601   # Get a list of flag types that can be set for this attachment.
602   my $flag_types = Bugzilla::FlagType::match({ 'target_type'  => 'attachment' ,
603                                                'product_id'   => $product_id ,
604                                                'component_id' => $component_id });
605   foreach my $flag_type (@$flag_types) {
606     $flag_type->{'flags'} = Bugzilla::Flag->match({ 'type_id'   => $flag_type->id,
607                                                     'attach_id' => $attachment->id });
608   }
609   $vars->{'flag_types'} = $flag_types;
610   $vars->{'any_flags_requesteeble'} = grep($_->is_requesteeble, @$flag_types);
611   $vars->{'attachment'} = $attachment;
612   $vars->{'bugsummary'} = $bugsummary; 
613   $vars->{'attachments'} = $bugattachments;
614
615 #if WEBKIT_CHANGES
616   if ($attachment->ispatch) {
617       my $quotedpatch = $attachment->data;
618       $quotedpatch =~ s/^/> /mg;
619       $vars->{'quotedpatch'} = $quotedpatch;
620   }
621 #endif // WEBKIT_CHANGES
622
623   print $cgi->header();
624
625   # Generate and return the UI (HTML page) from the appropriate template.
626   $template->process("attachment/$template_name.html.tmpl", $vars) # WEBKIT_CHANGES
627     || ThrowTemplateError($template->error());
628 }
629
630 # Updates an attachment record. Users with "editbugs" privileges, (or the
631 # original attachment's submitter) can edit the attachment's description,
632 # content type, ispatch and isobsolete flags, and statuses, and they can
633 # also submit a comment that appears in the bug.
634 # Users cannot edit the content of the attachment itself.
635 sub update {
636     my $user = Bugzilla->user;
637     my $dbh = Bugzilla->dbh;
638
639     # Retrieve and validate parameters
640     my $attachment = validateID();
641     my $bug = new Bugzilla::Bug($attachment->bug_id);
642     $attachment->validate_can_edit($bug->product_id);
643     validateCanChangeBug($bug->id);
644     Bugzilla::Attachment->validate_description(THROW_ERROR);
645     Bugzilla::Attachment->validate_is_patch(THROW_ERROR);
646     Bugzilla::Attachment->validate_content_type(THROW_ERROR) unless $cgi->param('ispatch');
647     $cgi->param('isobsolete', $cgi->param('isobsolete') ? 1 : 0);
648     $cgi->param('isprivate', $cgi->param('isprivate') ? 1 : 0);
649
650     # Now make sure the attachment has not been edited since we loaded the page.
651     if (defined $cgi->param('delta_ts')
652         && $cgi->param('delta_ts') ne $attachment->modification_time)
653     {
654         ($vars->{'operations'}) =
655             Bugzilla::Bug::GetBugActivity($bug->id, $attachment->id, $cgi->param('delta_ts'));
656
657         # The token contains the old modification_time. We need a new one.
658         $cgi->param('token', issue_hash_token([$attachment->id, $attachment->modification_time]));
659
660         # If the modification date changed but there is no entry in
661         # the activity table, this means someone commented only.
662         # In this case, there is no reason to midair.
663         if (scalar(@{$vars->{'operations'}})) {
664             $cgi->param('delta_ts', $attachment->modification_time);
665             $vars->{'attachment'} = $attachment;
666
667             print $cgi->header();
668             # Warn the user about the mid-air collision and ask them what to do.
669             $template->process("attachment/midair.html.tmpl", $vars)
670               || ThrowTemplateError($template->error());
671             exit;
672         }
673     }
674
675     # We couldn't do this check earlier as we first had to validate attachment ID
676     # and display the mid-air collision page if modification_time changed.
677     my $token = $cgi->param('token');
678     check_hash_token($token, [$attachment->id, $attachment->modification_time]);
679
680     # If the submitter of the attachment is not in the insidergroup,
681     # be sure that he cannot overwrite the private bit.
682     # This check must be done before calling Bugzilla::Flag*::validate(),
683     # because they will look at the private bit when checking permissions.
684     # XXX - This is a ugly hack. Ideally, we shouldn't have to look at the
685     # old private bit twice (first here, and then below again), but this is
686     # the less risky change.
687     unless ($user->is_insider) {
688         $cgi->param('isprivate', $attachment->isprivate);
689     }
690
691     # If the user submitted a comment while editing the attachment,
692     # add the comment to the bug. Do this after having validated isprivate!
693     if ($cgi->param('comment')) {
694         # Prepend a string to the comment to let users know that the comment came
695         # from the "edit attachment" screen.
696         my $comment = "(From update of attachment " . $attachment->id . ")\n" .
697                       $cgi->param('comment');
698
699         $bug->add_comment($comment, { isprivate => $cgi->param('isprivate') });
700     }
701
702     # The order of these function calls is important, as Flag::validate
703     # assumes User::match_field has ensured that the values in the
704     # requestee fields are legitimate user email addresses.
705     Bugzilla::User::match_field($cgi, {
706         '^requestee(_type)?-(\d+)$' => { 'type' => 'multi' }
707     });
708     Bugzilla::Flag::validate($bug->id, $attachment->id);
709
710     # Start a transaction in preparation for updating the attachment.
711     $dbh->bz_start_transaction();
712
713   # Quote the description and content type for use in the SQL UPDATE statement.
714   my $description = $cgi->param('description');
715   my $contenttype = $cgi->param('contenttype');
716   my $filename = $cgi->param('filename');
717   # we can detaint this way thanks to placeholders
718   trick_taint($description);
719   trick_taint($contenttype);
720   trick_taint($filename);
721
722   # Figure out when the changes were made.
723   my ($timestamp) = $dbh->selectrow_array("SELECT NOW()");
724     
725   # Update flags.  We have to do this before committing changes
726   # to attachments so that we can delete pending requests if the user
727   # is obsoleting this attachment without deleting any requests
728   # the user submits at the same time.
729   Bugzilla::Flag->process($bug, $attachment, $timestamp, $vars);
730
731   # Update the attachment record in the database.
732   $dbh->do("UPDATE  attachments 
733             SET     description = ?,
734                     mimetype    = ?,
735                     filename    = ?,
736                     ispatch     = ?,
737                     isobsolete  = ?,
738                     isprivate   = ?,
739                     modification_time = ?
740             WHERE   attach_id   = ?",
741             undef, ($description, $contenttype, $filename,
742             $cgi->param('ispatch'), $cgi->param('isobsolete'), 
743             $cgi->param('isprivate'), $timestamp, $attachment->id));
744
745   my $updated_attachment = Bugzilla::Attachment->get($attachment->id);
746   # Record changes in the activity table.
747   my $sth = $dbh->prepare('INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when,
748                                                       fieldid, removed, added)
749                            VALUES (?, ?, ?, ?, ?, ?, ?)');
750
751   if ($attachment->description ne $updated_attachment->description) {
752     my $fieldid = get_field_id('attachments.description');
753     $sth->execute($bug->id, $attachment->id, $user->id, $timestamp, $fieldid,
754                   $attachment->description, $updated_attachment->description);
755   }
756   if ($attachment->contenttype ne $updated_attachment->contenttype) {
757     my $fieldid = get_field_id('attachments.mimetype');
758     $sth->execute($bug->id, $attachment->id, $user->id, $timestamp, $fieldid,
759                   $attachment->contenttype, $updated_attachment->contenttype);
760   }
761   if ($attachment->filename ne $updated_attachment->filename) {
762     my $fieldid = get_field_id('attachments.filename');
763     $sth->execute($bug->id, $attachment->id, $user->id, $timestamp, $fieldid,
764                   $attachment->filename, $updated_attachment->filename);
765   }
766   if ($attachment->ispatch != $updated_attachment->ispatch) {
767     my $fieldid = get_field_id('attachments.ispatch');
768     $sth->execute($bug->id, $attachment->id, $user->id, $timestamp, $fieldid,
769                   $attachment->ispatch, $updated_attachment->ispatch);
770   }
771   if ($attachment->isobsolete != $updated_attachment->isobsolete) {
772     my $fieldid = get_field_id('attachments.isobsolete');
773     $sth->execute($bug->id, $attachment->id, $user->id, $timestamp, $fieldid,
774                   $attachment->isobsolete, $updated_attachment->isobsolete);
775   }
776   if ($attachment->isprivate != $updated_attachment->isprivate) {
777     my $fieldid = get_field_id('attachments.isprivate');
778     $sth->execute($bug->id, $attachment->id, $user->id, $timestamp, $fieldid,
779                   $attachment->isprivate, $updated_attachment->isprivate);
780   }
781   
782   # Commit the transaction now that we are finished updating the database.
783   $dbh->bz_commit_transaction();
784
785   # Commit the comment, if any.
786   $bug->update();
787
788   # Define the variables and functions that will be passed to the UI template.
789   $vars->{'mailrecipients'} = { 'changer' => Bugzilla->user->login };
790   $vars->{'attachment'} = $attachment;
791   # We cannot reuse the $bug object as delta_ts has eventually been updated
792   # since the object was created.
793   $vars->{'bugs'} = [new Bugzilla::Bug($bug->id)];
794   $vars->{'header_done'} = 1;
795   $vars->{'use_keywords'} = 1 if Bugzilla::Keyword::keyword_count();
796
797   print $cgi->header();
798
799   # Generate and return the UI (HTML page) from the appropriate template.
800   $template->process("attachment/updated.html.tmpl", $vars)
801     || ThrowTemplateError($template->error());
802 }
803
804 # Only administrators can delete attachments.
805 sub delete_attachment {
806     my $user = Bugzilla->login(LOGIN_REQUIRED);
807     my $dbh = Bugzilla->dbh;
808
809     print $cgi->header();
810
811     $user->in_group('admin')
812       || ThrowUserError('auth_failure', {group  => 'admin',
813                                          action => 'delete',
814                                          object => 'attachment'});
815
816     Bugzilla->params->{'allow_attachment_deletion'}
817       || ThrowUserError('attachment_deletion_disabled');
818
819     # Make sure the administrator is allowed to edit this attachment.
820     my $attachment = validateID();
821     validateCanChangeBug($attachment->bug_id);
822
823     $attachment->datasize || ThrowUserError('attachment_removed');
824
825     # We don't want to let a malicious URL accidentally delete an attachment.
826     my $token = trim($cgi->param('token'));
827     if ($token) {
828         my ($creator_id, $date, $event) = Bugzilla::Token::GetTokenData($token);
829         unless ($creator_id
830                   && ($creator_id == $user->id)
831                   && ($event eq 'attachment' . $attachment->id))
832         {
833             # The token is invalid.
834             ThrowUserError('token_does_not_exist');
835         }
836
837         my $bug = new Bugzilla::Bug($attachment->bug_id);
838
839         # The token is valid. Delete the content of the attachment.
840         my $msg;
841         $vars->{'attachment'} = $attachment;
842         $vars->{'date'} = $date;
843         $vars->{'reason'} = clean_text($cgi->param('reason') || '');
844         $vars->{'mailrecipients'} = { 'changer' => $user->login };
845
846         $template->process("attachment/delete_reason.txt.tmpl", $vars, \$msg)
847           || ThrowTemplateError($template->error());
848
849         # Paste the reason provided by the admin into a comment.
850         $bug->add_comment($msg);
851
852         # If the attachment is stored locally, remove it.
853         if (-e $attachment->_get_local_filename) {
854             unlink $attachment->_get_local_filename;
855         }
856         $attachment->remove_from_db();
857
858         # Now delete the token.
859         delete_token($token);
860
861         # Insert the comment.
862         $bug->update();
863
864         # Required to display the bug the deleted attachment belongs to.
865         $vars->{'bugs'} = [$bug];
866         $vars->{'header_done'} = 1;
867         $vars->{'use_keywords'} = 1 if Bugzilla::Keyword::keyword_count();
868
869         $template->process("attachment/updated.html.tmpl", $vars)
870           || ThrowTemplateError($template->error());
871     }
872     else {
873         # Create a token.
874         $token = issue_session_token('attachment' . $attachment->id);
875
876         $vars->{'a'} = $attachment;
877         $vars->{'token'} = $token;
878
879         $template->process("attachment/confirm-delete.html.tmpl", $vars)
880           || ThrowTemplateError($template->error());
881     }
882 }