Attachment.pm 27.2 KB
Newer Older
1 2 3
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
4
#
5 6
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.
7

8
package Bugzilla::Attachment;
9 10 11

use 5.10.1;
use strict;
12

13 14
=head1 NAME

15
Bugzilla::Attachment - Bugzilla attachment class.
16 17 18 19 20 21

=head1 SYNOPSIS

  use Bugzilla::Attachment;

  # Get the attachment with the given ID.
22
  my $attachment = new Bugzilla::Attachment($attach_id);
23 24

  # Get the attachments with the given IDs.
25
  my $attachments = Bugzilla::Attachment->new_from_list($attach_ids);
26 27 28

=head1 DESCRIPTION

29 30 31 32 33 34
Attachment.pm represents an attachment object. It is an implementation
of L<Bugzilla::Object>, and thus provides all methods that
L<Bugzilla::Object> provides.

The methods that are specific to C<Bugzilla::Attachment> are listed
below.
35 36 37

=cut

38
use Bugzilla::Constants;
39
use Bugzilla::Error;
40
use Bugzilla::Flag;
41
use Bugzilla::User;
42 43
use Bugzilla::Util;
use Bugzilla::Field;
44
use Bugzilla::Hook;
45

46 47 48
use File::Copy;
use List::Util qw(max);

49
use base qw(Bugzilla::Object);
50

51 52 53
###############################
####    Initialization     ####
###############################
54

55 56 57
use constant DB_TABLE   => 'attachments';
use constant ID_FIELD   => 'attach_id';
use constant LIST_ORDER => ID_FIELD;
58
# Attachments are tracked in bugs_activity.
59
use constant AUDIT_CREATES => 0;
60
use constant AUDIT_UPDATES => 0;
61

62 63
sub DB_COLUMNS {
    my $dbh = Bugzilla->dbh;
64

65 66 67 68 69 70 71 72 73 74 75 76
    return qw(
        attach_id
        bug_id
        description
        filename
        isobsolete
        ispatch
        isprivate
        mimetype
        modification_time
        submitter_id),
        $dbh->sql_date_format('attachments.creation_ts', '%Y.%m.%d %H:%i') . ' AS creation_ts';
77 78
}

79 80 81
use constant REQUIRED_FIELD_MAP => {
    bug_id => 'bug',
};
82
use constant EXTRA_REQUIRED_FIELDS => qw(data);
83 84 85 86 87 88 89 90 91 92 93 94 95

use constant UPDATE_COLUMNS => qw(
    description
    filename
    isobsolete
    ispatch
    isprivate
    mimetype
);

use constant VALIDATORS => {
    bug           => \&_check_bug,
    description   => \&_check_description,
96
    filename      => \&_check_filename,
97
    ispatch       => \&Bugzilla::Object::check_boolean,
98
    isprivate     => \&_check_is_private,
99
    mimetype      => \&_check_content_type,
100 101
};

102 103 104 105
use constant VALIDATOR_DEPENDENCIES => {
    mimetype => ['ispatch'],
};

106 107 108 109
use constant UPDATE_VALIDATORS => {
    isobsolete => \&Bugzilla::Object::check_boolean,
};

110 111 112
###############################
####      Accessors      ######
###############################
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

=pod

=head2 Instance Properties

=over

=item C<bug_id>

the ID of the bug to which the attachment is attached

=back

=cut

sub bug_id {
    my $self = shift;
    return $self->{bug_id};
}

=over

135 136 137 138 139 140 141 142 143 144 145 146
=item C<bug>

the bug object to which the attachment is attached

=back

=cut

sub bug {
    my $self = shift;

    require Bugzilla::Bug;
147
    $self->{bug} ||= Bugzilla::Bug->new({ id => $self->bug_id, cache => 1 });
148 149 150 151 152
    return $self->{bug};
}

=over

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
=item C<description>

user-provided text describing the attachment

=back

=cut

sub description {
    my $self = shift;
    return $self->{description};
}

=over

=item C<contenttype>

the attachment's MIME media type

=back

=cut

sub contenttype {
    my $self = shift;
178
    return $self->{mimetype};
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
}

=over

=item C<attacher>

the user who attached the attachment

=back

=cut

sub attacher {
    my $self = shift;
    return $self->{attacher} if exists $self->{attacher};
194
    $self->{attacher} = new Bugzilla::User($self->{submitter_id});
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    return $self->{attacher};
}

=over

=item C<attached>

the date and time on which the attacher attached the attachment

=back

=cut

sub attached {
    my $self = shift;
210
    return $self->{creation_ts};
211 212 213 214
}

=over

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
=item C<modification_time>

the date and time on which the attachment was last modified.

=back

=cut

sub modification_time {
    my $self = shift;
    return $self->{modification_time};
}

=over

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
=item C<filename>

the name of the file the attacher attached

=back

=cut

sub filename {
    my $self = shift;
    return $self->{filename};
}

=over

=item C<ispatch>

whether or not the attachment is a patch

=back

=cut

sub ispatch {
    my $self = shift;
    return $self->{ispatch};
}

=over

=item C<isobsolete>

whether or not the attachment is obsolete

=back

=cut

sub isobsolete {
    my $self = shift;
    return $self->{isobsolete};
}

=over

=item C<isprivate>

whether or not the attachment is private

=back

=cut

sub isprivate {
    my $self = shift;
    return $self->{isprivate};
}

=over

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
=item C<is_viewable>

Returns 1 if the attachment has a content-type viewable in this browser.
Note that we don't use $cgi->Accept()'s ability to check if a content-type
matches, because this will return a value even if it's matched by the generic
*/* which most browsers add to the end of their Accept: headers.

=back

=cut

sub is_viewable {
    my $self = shift;
    my $contenttype = $self->contenttype;
    my $cgi = Bugzilla->cgi;

    # We assume we can view all text and image types.
    return 1 if ($contenttype =~ /^(text|image)\//);

    # Mozilla can view XUL. Note the trailing slash on the Gecko detection to
    # avoid sending XUL to Safari.
    return 1 if (($contenttype =~ /^application\/vnd\.mozilla\./)
                 && ($cgi->user_agent() =~ /Gecko\//));

    # If it's not one of the above types, we check the Accept: header for any
    # types mentioned explicitly.
    my $accept = join(",", $cgi->Accept());
    return 1 if ($accept =~ /^(.*,)?\Q$contenttype\E(,.*)?$/);

    return 0;
}

=over

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
=item C<data>

the content of the attachment

=back

=cut

sub data {
    my $self = shift;
    return $self->{data} if exists $self->{data};

    # First try to get the attachment data from the database.
    ($self->{data}) = Bugzilla->dbh->selectrow_array("SELECT thedata
                                                      FROM attach_data
                                                      WHERE id = ?",
                                                     undef,
341
                                                     $self->id);
342 343 344 345 346

    # If there's no attachment data in the database, the attachment is stored
    # in a local file, so retrieve it from there.
    if (length($self->{data}) == 0) {
        if (open(AH, $self->_get_local_filename())) {
347
            local $/;
348 349
            binmode AH;
            $self->{data} = <AH>;
350 351 352
            close(AH);
        }
    }
353

354 355 356 357 358 359 360
    return $self->{data};
}

=over

=item C<datasize>

361
the length (in bytes) of the attachment content
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381

=back

=cut

# datasize is a property of the data itself, and it's unclear whether we should
# expose it at all, since you can easily derive it from the data itself: in TT,
# attachment.data.size; in Perl, length($attachment->{data}).  But perhaps
# it makes sense for performance reasons, since accessing the data forces it
# to get retrieved from the database/filesystem and loaded into memory,
# while datasize avoids loading the attachment into memory, calling SQL's
# LENGTH() function or stat()ing the file instead.  I've left it in for now.

sub datasize {
    my $self = shift;
    return $self->{datasize} if exists $self->{datasize};

    # If we have already retrieved the data, return its size.
    return length($self->{data}) if exists $self->{data};

382
    $self->{datasize} =
383 384 385
        Bugzilla->dbh->selectrow_array("SELECT LENGTH(thedata)
                                        FROM attach_data
                                        WHERE id = ?",
386
                                       undef, $self->id) || 0;
387

388 389 390 391
    # If there's no attachment data in the database, either the attachment
    # is stored in a local file, and so retrieve its size from the file,
    # or the attachment has been deleted.
    unless ($self->{datasize}) {
392 393 394 395 396 397 398 399 400 401
        if (open(AH, $self->_get_local_filename())) {
            binmode AH;
            $self->{datasize} = (stat(AH))[7];
            close(AH);
        }
    }

    return $self->{datasize};
}

402 403 404 405 406 407 408
sub _get_local_filename {
    my $self = shift;
    my $hash = ($self->id % 100) + 100;
    $hash =~ s/.*(\d\d)$/group.$1/;
    return bz_locations()->{'attachdir'} . "/$hash/attachment." . $self->id;
}

409 410 411 412 413 414 415 416 417 418 419 420 421
=over

=item C<flags>

flags that have been set on the attachment

=back

=cut

sub flags {
    my $self = shift;

422 423
    # Don't cache it as it must be in sync with ->flag_types.
    $self->{flags} = [map { @{$_->{flags}} } @{$self->flag_types}];
424 425 426
    return $self->{flags};
}

427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
=over

=item C<flag_types>

Return all flag types available for this attachment as well as flags
already set, grouped by flag type.

=back

=cut

sub flag_types {
    my $self = shift;
    return $self->{flag_types} if exists $self->{flag_types};

    my $vars = { target_type  => 'attachment',
                 product_id   => $self->bug->product_id,
                 component_id => $self->bug->component_id,
                 attach_id    => $self->id };

447
    $self->{flag_types} = Bugzilla::Flag->_flag_types($vars);
448 449 450
    return $self->{flag_types};
}

451 452 453 454
###############################
####      Validators     ######
###############################

455 456 457 458 459
sub set_content_type { $_[0]->set('mimetype', $_[1]); }
sub set_description  { $_[0]->set('description', $_[1]); }
sub set_filename     { $_[0]->set('filename', $_[1]); }
sub set_is_patch     { $_[0]->set('ispatch', $_[1]); }
sub set_is_private   { $_[0]->set('isprivate', $_[1]); }
460

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
sub set_is_obsolete  {
    my ($self, $obsolete) = @_;

    my $old = $self->isobsolete;
    $self->set('isobsolete', $obsolete);
    my $new = $self->isobsolete;

    # If the attachment is being marked as obsolete, cancel pending requests.
    if ($new && $old != $new) {
        my @requests = grep { $_->status eq '?' } @{$self->flags};
        return unless scalar @requests;

        my %flag_ids = map { $_->id => 1 } @requests;
        foreach my $flagtype (@{$self->flag_types}) {
            @{$flagtype->{flags}} = grep { !$flag_ids{$_->id} } @{$flagtype->{flags}};
        }
    }
}

sub set_flags {
    my ($self, $flags, $new_flags) = @_;

    Bugzilla::Flag->set_flag($self, $_) foreach (@$flags, @$new_flags);
}

486 487 488 489 490
sub _check_bug {
    my ($invocant, $bug) = @_;
    my $user = Bugzilla->user;

    $bug = ref $invocant ? $invocant->bug : $bug;
491 492 493 494

    $bug || ThrowCodeError('param_required', 
                           { function => "$invocant->create", param => 'bug' });

495 496 497 498
    ($user->can_see_bug($bug->id) && $user->can_edit_product($bug->product_id))
      || ThrowUserError("illegal_attachment_edit_bug", { bug_id => $bug->id });

    return $bug;
499 500
}

501
sub _check_content_type {
502 503 504 505
    my ($invocant, $content_type, undef, $params) = @_;
 
    my $is_patch = ref($invocant) ? $invocant->ispatch : $params->{ispatch};
    $content_type = 'text/plain' if $is_patch;
506 507 508
    $content_type = clean_text($content_type);
    # The subsets below cover all existing MIME types and charsets registered by IANA.
    # (MIME type: RFC 2045 section 5.1; charset: RFC 2278 section 3.3)
509
    my $legal_types = join('|', LEGAL_CONTENT_TYPES);
510 511 512
    if (!$content_type
        || $content_type !~ /^($legal_types)\/[a-z0-9_\-\+\.]+(;\s*charset=[a-z0-9_\-\+]+)?$/i)
    {
513 514 515 516
        ThrowUserError("invalid_content_type", { contenttype => $content_type });
    }
    trick_taint($content_type);

517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
    # $ENV{HOME} must be defined when using File::MimeInfo::Magic,
    # see https://rt.cpan.org/Public/Bug/Display.html?id=41744.
    local $ENV{HOME} = $ENV{HOME} || File::Spec->rootdir();

    # If we have autodetected application/octet-stream from the Content-Type
    # header, let's have a better go using a sniffer if available.
    if (defined Bugzilla->input_params->{contenttypemethod}
        && Bugzilla->input_params->{contenttypemethod} eq 'autodetect'
        && $content_type eq 'application/octet-stream'
        && Bugzilla->feature('typesniffer'))
    {
        import File::MimeInfo::Magic qw(mimetype);
        require IO::Scalar;

        # data is either a filehandle, or the data itself.
        my $fh = $params->{data};
        if (!ref($fh)) {
            $fh = new IO::Scalar \$fh;
        }
        elsif (!$fh->isa('IO::Handle')) {
            # CGI.pm sends us an Fh that isn't actually an IO::Handle, but
            # has a method for getting an actual handle out of it.
            $fh = $fh->handle;
            # ->handle returns an literal IO::Handle, even though the
            # underlying object is a file. So we rebless it to be a proper
            # IO::File object so that we can call ->seek on it and so on.
            # Just in case CGI.pm fixes this some day, we check ->isa first.
            if (!$fh->isa('IO::File')) {
                bless $fh, 'IO::File';
            }
        }

        my $mimetype = mimetype($fh);
        $content_type = $mimetype if $mimetype;
    }

    # Make sure patches are viewable in the browser
    if (!ref($invocant)
        && defined Bugzilla->input_params->{contenttypemethod}
        && Bugzilla->input_params->{contenttypemethod} eq 'autodetect'
        && $content_type =~ m{text/x-(?:diff|patch)})
    {
        $params->{ispatch} = 1;
        $content_type = 'text/plain';
    }

563 564 565 566 567 568
    return $content_type;
}

sub _check_data {
    my ($invocant, $params) = @_;

569
    my $data = $params->{data};
570
    $params->{filesize} = ref $data ? -s $data : length($data);
571

572
    Bugzilla::Hook::process('attachment_process_data', { data       => \$data,
573 574
                                                         attributes => $params });

575
    $params->{filesize} || ThrowUserError('zero_length_file');
576
    # Make sure the attachment does not exceed the maximum permitted size.
577 578 579 580 581 582
    my $max_size = max(Bugzilla->params->{'maxlocalattachment'} * 1048576,
                       Bugzilla->params->{'maxattachmentsize'} * 1024);

    if ($params->{filesize} > $max_size) {
        my $vars = { filesize => sprintf("%.0f", $params->{filesize}/1024) };
        ThrowUserError('file_too_large', $vars);
583 584 585 586 587 588 589 590 591 592 593 594 595
    }
    return $data;
}

sub _check_description {
    my ($invocant, $description) = @_;

    $description = trim($description);
    $description || ThrowUserError('missing_attachment_description');
    return $description;
}

sub _check_filename {
596
    my ($invocant, $filename) = @_;
597

598
    $filename = clean_text($filename);
599 600 601 602 603 604 605 606
    if (!$filename) {
        if (ref $invocant) {
            ThrowUserError('filename_not_specified');
        }
        else {
            ThrowUserError('file_not_specified');
        }
    }
607 608 609 610 611 612 613 614

    # Remove path info (if any) from the file name.  The browser should do this
    # for us, but some are buggy.  This may not work on Mac file names and could
    # mess up file names with slashes in them, but them's the breaks.  We only
    # use this as a hint to users downloading attachments anyway, so it's not
    # a big deal if it munges incorrectly occasionally.
    $filename =~ s/^.*[\/\\]//;

615 616 617
    # Truncate the filename to MAX_ATTACH_FILENAME_LENGTH characters, counting 
    # from the end of the string to make sure we keep the filename extension.
    $filename = substr($filename, 
618
                       -&MAX_ATTACH_FILENAME_LENGTH, 
619
                       MAX_ATTACH_FILENAME_LENGTH);
620
    trick_taint($filename);
621 622 623 624

    return $filename;
}

625 626
sub _check_is_private {
    my ($invocant, $is_private) = @_;
627

628
    $is_private = $is_private ? 1 : 0;
629 630 631 632
    if (((!ref $invocant && $is_private)
         || (ref $invocant && $invocant->isprivate != $is_private))
        && !Bugzilla->user->is_insider) {
        ThrowUserError('user_not_insider');
633
    }
634
    return $is_private;
635
}
636

637 638 639 640 641 642
=pod

=head2 Class Methods

=over

643
=item C<get_attachments_by_bug($bug)>
644

645 646
Description: retrieves and returns the attachments the currently logged in
             user can view for the given bug.
647

648
Params:     C<$bug> - Bugzilla::Bug object - the bug for which
649 650 651 652 653
            to retrieve and return attachments.

Returns:    a reference to an array of attachment objects.

=cut
654

655
sub get_attachments_by_bug {
656
    my ($class, $bug, $vars) = @_;
657 658 659 660 661 662
    my $user = Bugzilla->user;
    my $dbh = Bugzilla->dbh;

    # By default, private attachments are not accessible, unless the user
    # is in the insider group or submitted the attachment.
    my $and_restriction = '';
663
    my @values = ($bug->id);
664 665 666 667 668 669 670 671 672

    unless ($user->is_insider) {
        $and_restriction = 'AND (isprivate = 0 OR submitter_id = ?)';
        push(@values, $user->id);
    }

    my $attach_ids = $dbh->selectcol_arrayref("SELECT attach_id FROM attachments
                                               WHERE bug_id = ? $and_restriction",
                                               undef, @values);
673 674

    my $attachments = Bugzilla::Attachment->new_from_list($attach_ids);
675
    $_->{bug} = $bug foreach @$attachments;
676 677 678 679

    # To avoid $attachment->flags to run SQL queries itself for each
    # attachment listed here, we collect all the data at once and
    # populate $attachment->{flags} ourselves.
680
    # We also load all attachers at once for the same reason.
681
    if ($vars->{preload}) {
682
        # Preload flags.
683 684 685
        $_->{flags} = [] foreach @$attachments;
        my %att = map { $_->id => $_ } @$attachments;

686
        my $flags = Bugzilla::Flag->match({ bug_id      => $bug->id,
687 688
                                            target_type => 'attachment' });

689 690 691
        # Exclude flags for private attachments you cannot see.
        @$flags = grep {exists $att{$_->attach_id}} @$flags;

692 693
        push(@{$att{$_->attach_id}->{flags}}, $_) foreach @$flags;
        $attachments = [sort {$a->id <=> $b->id} values %att];
694 695 696 697 698 699 700 701

        # Preload attachers.
        my %user_ids = map { $_->{submitter_id} => 1 } @$attachments;
        my $users = Bugzilla::User->new_from_list([keys %user_ids]);
        my %user_map = map { $_->id => $_ } @$users;
        foreach my $attachment (@$attachments) {
            $attachment->{attacher} = $user_map{$attachment->{submitter_id}};
        }
702
    }
703
    return $attachments;
704
}
705

706 707
=pod

708
=item C<validate_can_edit($attachment, $product_id)>
709

710
Description: validates if the user is allowed to view and edit the attachment.
711
             Only the submitter or someone with editbugs privs can edit it.
712 713
             Only the submitter and users in the insider group can view
             private attachments.
714

715 716 717
Params:      $attachment - the attachment object being edited.
             $product_id - the product ID the attachment belongs to.

718
Returns:     1 on success, 0 otherwise.
719 720 721 722

=cut

sub validate_can_edit {
723
    my ($attachment, $product_id) = @_;
724 725
    my $user = Bugzilla->user;

726
    # The submitter can edit their attachments.
727 728 729
    return ($attachment->attacher->id == $user->id
            || ((!$attachment->isprivate || $user->is_insider)
                 && $user->in_group('editbugs', $product_id))) ? 1 : 0;
730 731
}

732
=item C<validate_obsolete($bug, $attach_ids)>
733 734 735

Description: validates if attachments the user wants to mark as obsolete
             really belong to the given bug and are not already obsolete.
736 737
             Moreover, a user cannot mark an attachment as obsolete if
             he cannot view it (due to restrictions on it).
738

739
Params:      $bug - The bug object obsolete attachments should belong to.
740
             $attach_ids - The list of attachments to mark as obsolete.
741

742 743
Returns:     The list of attachment objects to mark as obsolete.
             Else an error is thrown.
744 745 746 747

=cut

sub validate_obsolete {
748
    my ($class, $bug, $list) = @_;
749 750

    # Make sure the attachment id is valid and the user has permissions to view
751 752
    # the bug to which it is attached. Make sure also that the user can view
    # the attachment itself.
753
    my @obsolete_attachments;
754
    foreach my $attachid (@$list) {
755 756 757 758
        my $vars = {};
        $vars->{'attach_id'} = $attachid;

        detaint_natural($attachid)
759
          || ThrowUserError('invalid_attach_id', $vars);
760 761

        # Make sure the attachment exists in the database.
762 763
        my $attachment = new Bugzilla::Attachment($attachid)
          || ThrowUserError('invalid_attach_id', $vars);
764

765
        # Check that the user can view and edit this attachment.
766 767
        $attachment->validate_can_edit($bug->product_id)
          || ThrowUserError('illegal_attachment_edit', { attach_id => $attachment->id });
768

769 770
        if ($attachment->bug_id != $bug->bug_id) {
            $vars->{'my_bug_id'} = $bug->bug_id;
771
            ThrowUserError('mismatched_bug_ids_on_obsolete', $vars);
772 773
        }

774
        next if $attachment->isobsolete;
775 776 777 778 779 780

        push(@obsolete_attachments, $attachment);
    }
    return @obsolete_attachments;
}

781 782 783
###############################
####     Constructors     #####
###############################
784 785 786

=pod

787
=item C<create>
788

789
Description: inserts an attachment into the given bug.
790

791 792
Params:     takes a hashref with the following keys:
            C<bug> - Bugzilla::Bug object - the bug for which to insert
793
            the attachment.
794 795 796 797 798 799 800 801
            C<data> - Either a filehandle pointing to the content of the
            attachment, or the content of the attachment itself.
            C<description> - string - describe what the attachment is about.
            C<filename> - string - the name of the attachment (used by the
            browser when downloading it). If the attachment is a URL, this
            parameter has no effect.
            C<mimetype> - string - a valid MIME type.
            C<creation_ts> - string (optional) - timestamp of the insert
802
            as returned by SELECT LOCALTIMESTAMP(0).
803 804 805 806 807 808
            C<ispatch> - boolean (optional, default false) - true if the
            attachment is a patch.
            C<isprivate> - boolean (optional, default false) - true if
            the attachment is private.

Returns:    The new attachment object.
809 810 811

=cut

812
sub create {
813
    my $class = shift;
814
    my $dbh = Bugzilla->dbh;
815

816 817
    $class->check_required_create_fields(@_);
    my $params = $class->run_create_validators(@_);
818

819 820 821
    # Extract everything which is not a valid column name.
    my $bug = delete $params->{bug};
    $params->{bug_id} = $bug->id;
822 823
    my $data = delete $params->{data};
    my $size = delete $params->{filesize};
824

825 826
    my $attachment = $class->insert_create_data($params);
    my $attachid = $attachment->id;
827

828 829
    # The file is too large to be stored in the DB, so we store it locally.
    if ($size > Bugzilla->params->{'maxattachmentsize'} * 1024) {
830
        my $attachdir = bz_locations()->{'attachdir'};
831 832 833 834
        my $hash = ($attachid % 100) + 100;
        $hash =~ s/.*(\d\d)$/group.$1/;
        mkdir "$attachdir/$hash", 0770;
        chmod 0770, "$attachdir/$hash";
835 836 837
        if (ref $data) {
            copy($data, "$attachdir/$hash/attachment.$attachid");
            close $data;
838 839
        }
        else {
840 841 842 843
            open(AH, '>', "$attachdir/$hash/attachment.$attachid");
            binmode AH;
            print AH $data;
            close AH;
844
        }
845 846 847 848 849
        $data = ''; # Will be stored in the DB.
    }
    # If we have a filehandle, we need its content to store it in the DB.
    elsif (ref $data) {
        local $/;
850 851 852 853
        # Store the content in a temp variable while we close the FH.
        my $tmp = <$data>;
        close $data;
        $data = $tmp;
854
    }
855

856 857 858 859 860 861 862
    my $sth = $dbh->prepare("INSERT INTO attach_data
                             (id, thedata) VALUES ($attachid, ?)");

    trick_taint($data);
    $sth->bind_param(1, $data, $dbh->BLOB_TYPE);
    $sth->execute();

863 864
    $attachment->{bug} = $bug;

865 866 867 868 869
    # Return the new attachment object.
    return $attachment;
}

sub run_create_validators {
870
    my ($class, $params) = @_;
871

872 873
    # Let's validate the attachment content first as it may
    # alter some other attachment attributes.
874
    $params->{data} = $class->_check_data($params);
875 876
    $params = $class->SUPER::run_create_validators($params);

877
    $params->{creation_ts} ||= Bugzilla->dbh->selectrow_array('SELECT LOCALTIMESTAMP(0)');
878
    $params->{modification_time} = $params->{creation_ts};
879
    $params->{submitter_id} = Bugzilla->user->id || ThrowUserError('invalid_user');
880

881 882 883 884 885 886 887
    return $params;
}

sub update {
    my $self = shift;
    my $dbh = Bugzilla->dbh;
    my $user = Bugzilla->user;
888
    my $timestamp = shift || $dbh->selectrow_array('SELECT LOCALTIMESTAMP(0)');
889

890
    my ($changes, $old_self) = $self->SUPER::update(@_);
891 892 893 894 895

    my ($removed, $added) = Bugzilla::Flag->update_flags($self, $old_self, $timestamp);
    if ($removed || $added) {
        $changes->{'flagtypes.name'} = [$removed, $added];
    }
896 897 898 899 900 901 902 903

    # Record changes in the activity table.
    my $sth = $dbh->prepare('INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when,
                                                        fieldid, removed, added)
                             VALUES (?, ?, ?, ?, ?, ?, ?)');

    foreach my $field (keys %$changes) {
        my $change = $changes->{$field};
904 905 906
        $field = "attachments.$field" unless $field eq "flagtypes.name";
        my $fieldid = get_field_id($field);
        $sth->execute($self->bug_id, $self->id, $user->id, $timestamp,
907
                      $fieldid, $change->[0], $change->[1]);
908 909
    }

910
    if (scalar(keys %$changes)) {
911 912
      $dbh->do('UPDATE attachments SET modification_time = ? WHERE attach_id = ?',
               undef, ($timestamp, $self->id));
913
      $dbh->do('UPDATE bugs SET delta_ts = ? WHERE bug_id = ?',
914
               undef, ($timestamp, $self->bug_id));
915
    }
916

917
    return $changes;
918 919
}

920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
=pod

=item C<remove_from_db()>

Description: removes an attachment from the DB.

Params:     none

Returns:    nothing

=back

=cut

sub remove_from_db {
    my $self = shift;
    my $dbh = Bugzilla->dbh;

    $dbh->bz_start_transaction();
    $dbh->do('DELETE FROM flags WHERE attach_id = ?', undef, $self->id);
    $dbh->do('DELETE FROM attach_data WHERE id = ?', undef, $self->id);
941 942
    $dbh->do('UPDATE attachments SET mimetype = ?, ispatch = ?, isobsolete = ?
              WHERE attach_id = ?', undef, ('text/plain', 0, 1, $self->id));
943
    $dbh->bz_commit_transaction();
944 945 946 947 948

    my $filename = $self->_get_local_filename;
    if (-e $filename) {
        unlink $filename or warn "Couldn't unlink $filename: $!";
    }
949 950
}

951 952 953 954 955 956 957 958
###############################
####       Helpers        #####
###############################

# Extract the content type from the attachment form.
sub get_content_type {
    my $cgi = Bugzilla->cgi;

959
    return 'text/plain' if ($cgi->param('ispatch') || $cgi->param('attach_text'));
960 961

    my $content_type;
962 963 964 965 966 967
    my $method = $cgi->param('contenttypemethod') || '';

    if ($method eq 'list') {
        # The user selected a content type from the list, so use their
        # selection.
        $content_type = $cgi->param('contenttypeselection');
968
    }
969 970 971 972 973
    elsif ($method eq 'manual') {
        # The user entered a content type manually, so use their entry.
        $content_type = $cgi->param('contenttypeentry');
    }
    else {
974 975 976 977 978 979 980
        defined $cgi->upload('data') || ThrowUserError('file_not_specified');
        # The user asked us to auto-detect the content type, so use the type
        # specified in the HTTP request headers.
        $content_type =
            $cgi->uploadInfo($cgi->param('data'))->{'Content-Type'};
        $content_type || ThrowUserError("missing_content_type");

981 982 983 984 985
        # Internet Explorer sends image/x-png for PNG images,
        # so convert that to image/png to match other browsers.
        if ($content_type eq 'image/x-png') {
            $content_type = 'image/png';
        }
986 987 988 989 990
    }
    return $content_type;
}


991
1;
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

=head1 B<Methods in need of POD>

=over

=item set_filename

=item set_is_obsolete

=item DB_COLUMNS

=item set_is_private

=item set_content_type

=item set_description

=item get_content_type

=item set_flags

=item set_is_patch

=item update

=back