File Coverage

blib/lib/Email/ARF/Report.pm

Criterion	Covered	Total	%
statement	75	75	100.0
branch	20	26	76.9
condition	8	15	53.3
subroutine	20	20	100.0
pod	10	10	100.0
total	133	146	91.1

use strict;
use warnings;
package Email::ARF::Report 0.012;
# ABSTRACT: interpret Abuse Reporting Format (ARF) messages

use Carp ();
use Email::MIME 1.929 (); # content-type attributes
use Email::MIME::ContentType 1.016 (); # type/subtype
use Scalar::Util ();
use Params::Util qw(_INSTANCE);

#pod =begin :prelude
#pod
#pod =head1 WARNING
#pod
#pod B  This is a prototype.  This module will definitely continue to
#pod exist, but maybe the interface will change radically once more people have seen
#pod it and tried to use it.  Don't rely on its interface to keep you employed, just
#pod yet.
#pod
#pod =end :prelude
#pod
#pod =head1 SYNOPSIS
#pod
#pod   my $report = Email::ARF::Report->new($text);
#pod
#pod   if ($report->field('source-ip') eq $our_ip) {
#pod     my $sender = $report->original_email->header('from');
#pod
#pod     UserManagement->disable_account($sender);
#pod   }
#pod
#pod =head1 DESCRIPTION
#pod
#pod ARF, the Abuse Feedback Report Format, is used to report email abuse incidents
#pod to an email provider.  It includes mechanisms for providing machine-readable
#pod details about the incident, a human-readable description, and a copy of the
#pod offending message.
#pod
#pod =method new
#pod
#pod   my $report = Email::ARF::Report->new($message);
#pod
#pod Given either an Email::MIME object or a string containing the text of an email
#pod message, this method returns a new Email::ARF::Report object.  If the given
#pod message source is not a valid report in ARF format, an exception is raised.
#pod
#pod =cut

sub new {
  my ($class, $source) = @_;

  Carp::croak "no report source provided" unless $source;

  my $mime = Scalar::Util::blessed $source
           ? $source
           : Email::MIME->new($source);

  Carp::croak "ARF report source could not be interpreted as MIME message"
    unless eval { $mime->isa('Email::MIME') };

  my $ct_header = $mime->content_type;
  my $ct = Email::MIME::ContentType::parse_content_type($ct_header);

  Carp::croak "non-ARF content type '$ct_header' on ARF report source"
    unless $ct->{type}  eq 'multipart'
    and    $ct->{subtype} eq 'report'
    and    $ct->{attributes}{'report-type'} eq 'feedback-report';

  Carp::croak "too few subparts for ARF report" unless $mime->subparts >= 3;

  my ($description_part, $report_part, $original_part) = $mime->subparts;

  my $report_header = $report_part->content_type;
  my $report_ct = Email::MIME::ContentType::parse_content_type($report_header);
  Carp::croak "bad content type '$report_header' for machine-readable section"
    unless $report_ct->{type}  eq 'message'
    and    $report_ct->{subtype} eq 'feedback-report';

  my $self = bless {
    mime             => $mime,
    description_part => $description_part,
    original_part    => $original_part,
  } => $class;

  $self->{fields} = $self->_email_from_body($report_part, 1)->header_obj;
  $self->{original_email} = $self->_email_from_body($original_part);

  return $self;
}

sub _email_from_body {
  my ($self, $src_email, $append_nl) = @_;

  my $src_email_body = $src_email->body;

  $src_email_body =~ s/\A(\x0d|\x0a)+//g;

  my $email = Email::MIME->new(
    $append_nl ? "$src_email_body\n" : $src_email_body
  );
}

#pod =method create
#pod
#pod   my $mail = Email::ARF::Report->create(
#pod     original_email => $email,
#pod     description    => $description,
#pod     fields         => \%fields,      # or \@fields
#pod     header_str     => \@headers,
#pod   );
#pod
#pod This method creates a new ARF report from scratch.
#pod
#pod The C parameter may be given as a string, a string reference,
#pod or as an object that provides an C method.
#pod
#pod The optional C parameter is an arrayref of name/value pairs to be
#pod added as extra headers in the ARF report.  The values are expected to be
#pod character strings, and will be MIME-encoded as needed.  To pass pre-encoded
#pod headers, use the C parameter.  These are handled by L's
#pod C constructor.
#pod
#pod Default values are provided for the following fields:
#pod
#pod   version       - 1
#pod   user-agent    - Email::ARF::Report/$VERSION
#pod   feedback-type - other
#pod
#pod =cut

sub create {
  my ($class, %arg) = @_;

  require Email::MIME::Creator;

  my $description_part = Email::MIME->create(
    attributes => { content_type => 'text/plain' },
    body       => $arg{description},
  );

  my $original_body = ref $arg{original_email}
                    ? Scalar::Util::blessed $arg{original_email}
                      ? $arg{original_email}->as_string
                      : ${ $arg{original_email} }
                    : $arg{original_email};

  $description_part->header_set('Date');

  my $original_part = Email::MIME->create(
    attributes => { content_type => 'message/rfc822' },
    body       => $original_body,
  );

  $original_part->header_set('Date');

  my $field_pairs = ref $arg{fields} eq 'HASH'
                  ? [ %{ $arg{fields} } ]
                  : $arg{fields};

  my $fields = Email::Simple->create(header => $field_pairs);

  $fields->header_set('Date');

  unless (defined $fields->header('user-agent')) {
    $fields->header_set(
      'User-Agent',
      "$class/" . ($class->VERSION || '(dev)')
    );
  }

  unless (defined $fields->header('version')) {
    $fields->header_set('Version', "1");
  }

  unless (defined $fields->header('Feedback-Type')) {
    $fields->header_set('Feedback-Type', "other");
  }

  my $report_part = Email::MIME->create(
    attributes => { content_type => 'message/feedback-report' },
    body       => $fields->header_obj->as_string,
  );

  $report_part->header_set('Date');

  my $report = Email::MIME->create(
    attributes => {
      content_type  => 'multipart/report',
      'report-type' => 'feedback-report',
    },
    parts  => [ $description_part, $report_part, $original_part ],

    header     => $arg{header}     || [],
    header_str => $arg{header_str} || [],
  );

  $class->new($report);
}

#pod =method as_email
#pod
#pod This method returns an Email::MIME object representing the report.
#pod
#pod Note!  This method returns a B Email::MIME object each time it is called.
#pod If you just want to get a string representation of the report, call
#pod C>.  If you call C and make changes to the Email::MIME
#pod object, the Email::ARF::Report will I be affected.
#pod
#pod =cut

sub as_email {
  return Email::MIME->new($_[0]->as_string)
}

#pod =method as_string
#pod
#pod This method returns a string representation of the report.
#pod
#pod =cut

sub as_string { $_[0]->{mime}->as_string }

#pod =method original_email
#pod
#pod This method returns an Email::Simple object containing the original message to
#pod which the report refers.  Bear in mind that this message may have been edited
#pod by the reporter to remove identifying information.
#pod
#pod =cut

sub original_email {
  $_[0]->{original_email}
}

#pod =method description
#pod
#pod This method returns the human-readable description of the report, taken from
#pod the body of the human-readable (first) subpart of the report.
#pod
#pod =cut

sub _description_part { $_[0]->{description_part} }

sub description {
  $_[0]->_description_part->body;
}

sub _fields { $_[0]->{fields} }

#pod =method field
#pod
#pod   my $value  = $report->field($field_name);
#pod   my @values = $report->field($field_name);
#pod
#pod This method returns the value for the given field from the second,
#pod machine-readable part of the report.  In scalar context, it returns the first
#pod value for the field.
#pod
#pod =cut

sub field {
  my ($self, $field) = @_;

  return $self->_fields->header($field);
}

#pod =head2 feedback_type
#pod
#pod =method user_agent
#pod
#pod =method arf_version
#pod
#pod These methods are shorthand for retrieving the fields of the same name, except
#pod for C, which returns the F header.  It has been renamed
#pod to avoid confusion with the universal C method.
#pod
#pod =cut

sub feedback_type { $_[0]->field('Feedback-Type'); }
sub user_agent    { $_[0]->field('User-Agent');    }
sub arf_version   { $_[0]->field('Version');       }

#pod =head1 SEE ALSO
#pod
#pod L
#pod
#pod L
#pod
#pod =cut

1;

__END__