lib/Message/Header.pm


=head1 NAME

Message::Header Perl module

=head1 DESCRIPTION

Perl module for RFC 822/2822 message C<header>.

=cut

package Message::Header;
use strict;
use vars qw($VERSION %REG %DEFAULT);
$VERSION = '1.00';

use overload '@{}' => sub {shift->_delete_empty_field()->{field}},
             '""' => sub {shift->stringify};

$REG{WSP}     = qr/[\x09\x20]/;
$REG{FWS}     = qr/[\x09\x20]*/;
$REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/;
$REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/;
$REG{UNSAFE_field_name} = qr/[\x00-\x20\x3A\x7F-\xFF]/;

=head2 options

These options can be getten/set by C<get_option>/C<set_option>
method.

=head3 capitalize = 0/1

(First character of) C<field-name> is capitalized
when C<stringify>.  (Default = 1)

=head3 fold_length = numeric value

Length of line used to fold.  (Default = 70)

=head3 mail_from = 0/1

Outputs "From " line (known as Un*x From, Mail-From, and so on)
when C<stringify>.  (Default = 0)

=cut

%DEFAULT = (
  capitalize    => 1,
  fold_length   => 70,
  field_type    => {':DEFAULT' => 'Message::Field::Unstructured'},
  mail_from     => -1,
  parse_all     => -1,
);
my @field_type_Structured = qw(cancel-lock
  importance mime-version path precedence user-agent x-cite
  x-face x-mail-count x-msmail-priority x-priority x-uidl xref);
for (@field_type_Structured)
  {$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}
my @field_type_Address = qw(approved bcc cc delivered-to disposition-notification-to 
  envelope-to
  errors-to fcc from mail-followup-to mail-followup-cc mail-from reply-to resent-bcc
  resent-cc resent-to resent-from resent-sender return-path
  return-receipt-to sender to x-approved x-beenthere
  x-complaints-to x-envelope-from x-envelope-sender
  x-envelope-to x-ml-address x-ml-command x-ml-to x-nfrom x-nto);
for (@field_type_Address)
  {$DEFAULT{field_type}->{$_} = 'Message::Field::Address'}
my @field_type_Date = qw(date date-received delivery-date expires
  expire-date nntp-posting-date posted reply-by resent-date x-tcup-date);
for (@field_type_Date)
  {$DEFAULT{field_type}->{$_} = 'Message::Field::Date'}
my @field_type_MsgID = qw(content-id in-reply-to message-id
  references resent-message-id see-also supersedes);
for (@field_type_MsgID)
  {$DEFAULT{field_type}->{$_} = 'Message::Field::MsgID'}
for (qw(received x-received))
  {$DEFAULT{field_type}->{$_} = 'Message::Field::Received'}
$DEFAULT{field_type}->{'content-type'} = 'Message::Field::ContentType';
$DEFAULT{field_type}->{'content-disposition'} = 'Message::Field::ContentDisposition';
for (qw(x-face-type))
  {$DEFAULT{field_type}->{$_} = 'Message::Field::ValueParams'}
for (qw(accept accept-charset accept-encoding accept-language
  content-language 
  content-transfer-encoding encrypted followup-to keywords newsgroups
  x-brother x-daughter x-respect x-moe x-syster x-wife))
  {$DEFAULT{field_type}->{$_} = 'Message::Field::CSV'}
my @field_type_URI = qw(list-archive list-help list-owner
  list-post list-subscribe list-unsubscribe uri url x-home-page x-http_referer
  x-info x-pgp-key x-ml-url x-uri x-url x-web);
for (@field_type_URI)
  {$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}
for (qw(list-id))
  {$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}
for (qw(content-description subject title x-nsubject))
  {$DEFAULT{field_type}->{$_} = 'Message::Field::Subject'}

=head2 Message::Header->new ([%option])

Returns new Message::Header instance.  Some options can be
specified as hash.

=cut

sub new ($;%) {
  my $class = shift;
  my $self = bless {option => {@_}}, $class;
  for (keys %DEFAULT) {$self->{option}->{$_} ||= $DEFAULT{$_}}
  $self;
}

=head2 Message::Header->parse ($header, [%option])

Parses given C<header> and return a new Message::Header
object.  Some options can be specified as hash.

=cut

sub parse ($$;%) {
  my $class = shift;
  my $header = shift;
  my $self = bless {option => {@_}}, $class;
  for (keys %DEFAULT) {$self->{option}->{$_} ||= $DEFAULT{$_}}
  $header =~ s/\x0D?\x0A$REG{WSP}+/\x20/gos;    ## unfold
  for my $field (split /\x0D?\x0A/, $header) {
    if ($field =~ /$REG{M_fromline}/) {
      my $body = $1;
      $body = $self->_field_body ($body, 'mail-from')
        if $self->{option}->{parse_all}>0;
      push @{$self->{field}}, {name => 'mail-from', body => $body};
    } elsif ($field =~ /$REG{M_field}/) {
      my ($name, $body) = (lc $1, $2);
      $name =~ s/$REG{WSP}+$//;
      $body =~ s/$REG{WSP}+$//;
      $body = $self->_field_body ($body, $name) if $self->{option}->{parse_all}>0;
      push @{$self->{field}}, {name => $name, body => $body};
    }
  }
  $self;
}

=head2 $self->field ($field_name)

Returns C<field-body> of given C<field-name>.
When there are two or more C<field>s whose name is C<field-name>,
this method return all C<field-body>s as array.  (On scalar
context, only first one is returned.)

=cut

sub field ($$) {
  my $self = shift;
  my $name = lc shift;
  my @ret;
  for my $field (@{$self->{field}}) {
    if ($field->{name} eq $name) {
      unless (wantarray) {
        $field->{body} = $self->_field_body ($field->{body}, $name);
        return $field->{body};
      } else {
        $field->{body} = $self->_field_body ($field->{body}, $name);
        push @ret, $field->{body};
      }
    }
  }
  if ($#ret < 0) {
    return $self->add ($name);
  }
  @ret;
}

sub field_exist ($$) {
  my $self = shift;
  my $name = lc shift;
  my @ret;
  for my $field (@{$self->{field}}) {
    return 1 if ($field->{name} eq $name);
  }
  0;
}

=head2 $self->field_name ($index)

Returns C<field-name> of $index'th C<field>.

=head2 $self->field_body ($index)

Returns C<field-body> of $index'th C<field>.

=cut

sub field_name ($$) {
  my $self = shift;
  $self->{field}->[shift]->{name};
}
sub field_body ($$) {
  my $self = shift;
  my $i = shift;
  $self->{field}->[$i]->{body}
   = $self->_field_body ($self->{field}->[$i]->{body}, $self->{field}->[$i]->{name});
  $self->{field}->[$i]->{body};
}

sub _field_body ($$$) {
  my $self = shift;
  my ($body, $name) = @_;
  unless (ref $body) {
    my $type = $self->{option}->{field_type}->{$name}
            || $self->{option}->{field_type}->{':DEFAULT'};
    eval "require $type";
    unless ($body) {
      $body = $type->new (field_name => $name);
    } else {
      $body = $type->parse ($body, field_name => $name);
    }
  }
  $body;
}

=head2 $self->field_name_list ()

Returns list of all C<field-name>s.  (Even if there are two
or more C<field>s which have same C<field-name>,  this method
returns ALL names.)

=cut

sub field_name_list ($) {
  my $self = shift;
  $self->_delete_empty_field ();
  map {$_->{name}} @{$self->{field}};
}

=head2 $self->add ($field_name, $field_body)

Adds an new C<field>.  It is not checked whether
the field which named $field_body is already exist or not.
If you don't want duplicated C<field>s, use C<replace> method.

=cut

sub add ($$;$%) {
  my $self = shift;
  my ($name, $body) = (lc shift, shift);
  my %option = @_;
  return 0 if $name =~ /$REG{UNSAFE_field_name}/;
  $body = $self->_field_body ($body, $name);
  if ($option{prepend}) {
    unshift @{$self->{field}}, {name => $name, body => $body};
  } else {
    push @{$self->{field}}, {name => $name, body => $body};
  }
  $body;
}

=head2 $self->relace ($field_name, $field_body)

Set the C<field-body> named C<field-name> as $field_body.
If $field_name C<field> is already exists, it is replaced
by new $field_body value.  If not, new C<field> is inserted.
(If there are some C<field> named as $field_name,
first one is used and the others are not changed.)

=cut

sub replace ($$$) {
  my $self = shift;
  my ($name, $body) = (lc shift, shift);
  return 0 if $name =~ /$REG{UNSAFE_field_name}/;
  $body = $self->_field_body ($body, $name);
  for my $field (@{$self->{field}}) {
    if ($field->{name} eq $name) {
      $field->{body} = $body;
      return $body;
    }
  }
  push @{$self->{field}}, {name => $name, body => $body};
  $body;
}

=head2 $self->delete ($field_name, [$index])

Deletes C<field> named as $field_name.
If $index is specified, only $index'th C<field> is deleted.
If not, ($index == 0), all C<field>s that have the C<field-name>
$field_name are deleted.

=cut

sub delete ($$;$) {
  my $self = shift;
  my ($name, $index) = (lc shift, shift);
  my $i = 0;
  for my $field (@{$self->{field}}) {
    if ($field->{name} eq $name) {
      $i++;
      if ($index == 0 || $i == $index) {
        undef $field;
        return $self if $i == $index;
      }
    }
  }
  $self;
}

=head2 $self->count ([$field_name])

Returns the number of times the given C<field> appears.
If no $field_name is given, returns the number
of fields.  (Same as $#$self+1)

=cut

sub count ($;$) {
  my $self = shift;
  my ($name) = (lc shift);
  unless ($name) {
    $self->_delete_empty_field ();
    return $#{$self->{field}}+1;
  }
  my $count = 0;
  for my $field (@{$self->{field}}) {
    if ($field->{name} eq $name) {
      $count++;
    }
  }
  $count;
}

=head2 $self->stringify ([%option])

Returns the C<header> as a string.

=cut

sub stringify ($;%) {
  my $self = shift;
  my %OPT = @_;
  my @ret;
  $OPT{capitalize} ||= $self->{option}->{capitalize};
  $OPT{mail_from} ||= $self->{option}->{mail_from};
  push @ret, 'From '.$self->field ('mail-from') if $OPT{mail_from}>0;
  for my $field (@{$self->{field}}) {
    my $name = $field->{name};
    next unless $field->{name};
    next if $OPT{mail_from}<0 && $name eq 'mail-from';
    my $fbody = scalar $field->{body};
    next unless $fbody;
    $fbody =~ s/\x0D([^\x09\x0A\x20])/\x0D\x20$1/g;
    $fbody =~ s/\x0A([^\x09\x20])/\x0A\x20$1/g;
    $name =~ s/((?:^|-)[a-z])/uc($1)/ge if $OPT{capitalize};
    push @ret, $name.': '.$self->fold ($fbody);
  }
  my $ret = join ("\n", @ret);
  $ret? $ret."\n": "";
}

=head2 $self->get_option ($option_name)

Returns value of the option.

=head2 $self->set_option ($option_name, $option_value)

Set new value of the option.

=cut

sub get_option ($$) {
  my $self = shift;
  my ($name) = @_;
  $self->{option}->{$name};
}
sub set_option ($$$) {
  my $self = shift;
  my ($name, $value) = @_;
  $self->{option}->{$name} = $value;
  $self;
}

sub field_type ($$;$) {
  my $self = shift;
  my $field_name = shift;
  my $new_field_type = shift;
  if ($new_field_type) {
    $self->{option}->{field_type}->{$field_name} = $new_field_type;
  }
  $self->{option}->{field_type}->{$field_name}
  || $self->{option}->{field_type}->{':DEFAULT'};
}

sub _delete_empty_field ($) {
  my $self = shift;
  my @ret;
  for my $field (@{$self->{field}}) {
    push @ret, $field if $field->{name};
  }
  $self->{field} = \@ret;
  $self;
}

sub fold ($$;$) {
  my $self = shift;
  my $string = shift;
  my $len = shift || $self->{option}->{fold_length};
  $len = 60 if $len < 60;
  
  ## This code is taken from Mail::Header 1.43 in MailTools,
  ## by Graham Barr (Maintained by Mark Overmeer <mailtools@overmeer.net>).
  my $max = int($len - 5);         # 4 for leading spcs + 1 for [\,\;]
  my $min = int($len * 4 / 5) - 4;
  my $ml = $len;
  
  if (length($string) > $ml) {
     #Split the line up
     # first bias towards splitting at a , or a ; >4/5 along the line
     # next split a whitespace
     # else we are looking at a single word and probably don't want to split
     my $x = "";
     $x .= "$1\n    "
       while($string =~ s/^$REG{WSP}*(
                          [^"]{$min,$max}?[\,\;]
                          |[^"]{1,$max}$REG{WSP}
                          |[^\s"]*(?:"[^"]*"[^\s"]*)+$REG{WSP}
                          |[^\s"]+$REG{WSP}
                          )
                        //x);
     $x .= $string;
     $string = $x;
     $string =~ s/(\A$REG{WSP}+|$REG{WSP}+\Z)//sog;
     $string =~ s/\s+\n/\n/sog;
  }
  $string;
}

=head1 EXAMPLE

  ## Print field list
  
  use Message::Header;
  my $header = Message::Header->parse ($header);
  
  ## Next sample is better.
  #for my $field (@$header) {
  #  print $field->{name}, "\t=> ", $field->{body}, "\n";
  #}
  
  for my $i (0..$#$header) {
    print $header->field_name ($i), "\t=> ", $header->field_body ($i), "\n";
  }
  
  
  ## Make simple header
  
  use Message::Header;
  use Message::Field::Address;
  my $header = new Message::Header;
  
  my $from = new Message::Field::Address;
     $from->add ('foo@foo.example', name => 'F. Foo');
  my $to = new Message::Field::Address;
     $to->add ('bar@bar.example', name => 'Mr. Bar');
     $to->add ('hoge@foo.example', name => 'Hoge-san');
  $header->add ('From' => $from);
  $header->add ('To' => $to);
  $header->add ('Subject' => 'Re: Meeting');
  $header->add ('References' => '<hoge.msgid%foo@foo.example>');
  print $header;

=head1 LICENSE

Copyright 2002 wakaba E<lt>w@suika.fam.cxE<gt>.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.

=head1 CHANGE

See F<ChangeLog>.
$Date: 2002/03/23 11:43:06 $

=cut

1;
1	wakaba	1.1
2			=head1 NAME
3
4			Message::Header Perl module
5
6			=head1 DESCRIPTION
7
8			Perl module for RFC 822/2822 message C<header>.
9
10			=cut
11
12			package Message::Header;
13			use strict;
14			use vars qw($VERSION %REG %DEFAULT);
15			$VERSION = '1.00';
16
17			use overload '@{}' => sub {shift->_delete_empty_field()->{field}},
18			'""' => sub {shift->stringify};
19
20			$REG{WSP} = qr/[\x09\x20]/;
21			$REG{FWS} = qr/[\x09\x20]*/;
22			$REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/;
23			$REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/;
24			$REG{UNSAFE_field_name} = qr/[\x00-\x20\x3A\x7F-\xFF]/;
25
26			=head2 options
27
28			These options can be getten/set by C<get_option>/C<set_option>
29			method.
30
31			=head3 capitalize = 0/1
32
33			(First character of) C<field-name> is capitalized
34			when C<stringify>. (Default = 1)
35
36			=head3 fold_length = numeric value
37
38			Length of line used to fold. (Default = 70)
39
40			=head3 mail_from = 0/1
41
42			Outputs "From " line (known as Un*x From, Mail-From, and so on)
43			when C<stringify>. (Default = 0)
44
45			=cut
46
47			%DEFAULT = (
48			capitalize => 1,
49			fold_length => 70,
50	wakaba	1.7	field_type => {':DEFAULT' => 'Message::Field::Unstructured'},
51	wakaba	1.9	mail_from => -1,
52			parse_all => -1,
53	wakaba	1.1	);
54	wakaba	1.7	my @field_type_Structured = qw(cancel-lock
55			importance mime-version path precedence user-agent x-cite
56			x-face x-mail-count x-msmail-priority x-priority x-uidl xref);
57	wakaba	1.4	for (@field_type_Structured)
58			{$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}
59	wakaba	1.8	my @field_type_Address = qw(approved bcc cc delivered-to disposition-notification-to
60			envelope-to
61	wakaba	1.7	errors-to fcc from mail-followup-to mail-followup-cc mail-from reply-to resent-bcc
62	wakaba	1.4	resent-cc resent-to resent-from resent-sender return-path
63			return-receipt-to sender to x-approved x-beenthere
64			x-complaints-to x-envelope-from x-envelope-sender
65	wakaba	1.7	x-envelope-to x-ml-address x-ml-command x-ml-to x-nfrom x-nto);
66	wakaba	1.4	for (@field_type_Address)
67			{$DEFAULT{field_type}->{$_} = 'Message::Field::Address'}
68			my @field_type_Date = qw(date date-received delivery-date expires
69			expire-date nntp-posting-date posted reply-by resent-date x-tcup-date);
70			for (@field_type_Date)
71			{$DEFAULT{field_type}->{$_} = 'Message::Field::Date'}
72			my @field_type_MsgID = qw(content-id in-reply-to message-id
73	wakaba	1.6	references resent-message-id see-also supersedes);
74	wakaba	1.4	for (@field_type_MsgID)
75	wakaba	1.6	{$DEFAULT{field_type}->{$_} = 'Message::Field::MsgID'}
76	wakaba	1.7	for (qw(received x-received))
77	wakaba	1.5	{$DEFAULT{field_type}->{$_} = 'Message::Field::Received'}
78	wakaba	1.8	$DEFAULT{field_type}->{'content-type'} = 'Message::Field::ContentType';
79			$DEFAULT{field_type}->{'content-disposition'} = 'Message::Field::ContentDisposition';
80			for (qw(x-face-type))
81			{$DEFAULT{field_type}->{$_} = 'Message::Field::ValueParams'}
82	wakaba	1.7	for (qw(accept accept-charset accept-encoding accept-language
83	wakaba	1.8	content-language
84			content-transfer-encoding encrypted followup-to keywords newsgroups
85			x-brother x-daughter x-respect x-moe x-syster x-wife))
86	wakaba	1.7	{$DEFAULT{field_type}->{$_} = 'Message::Field::CSV'}
87	wakaba	1.4	my @field_type_URI = qw(list-archive list-help list-owner
88			list-post list-subscribe list-unsubscribe uri url x-home-page x-http_referer
89			x-info x-pgp-key x-ml-url x-uri x-url x-web);
90			for (@field_type_URI)
91			{$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}
92	wakaba	1.7	for (qw(list-id))
93	wakaba	1.4	{$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}
94	wakaba	1.7	for (qw(content-description subject title x-nsubject))
95	wakaba	1.5	{$DEFAULT{field_type}->{$_} = 'Message::Field::Subject'}
96	wakaba	1.1
97			=head2 Message::Header->new ([%option])
98
99			Returns new Message::Header instance. Some options can be
100			specified as hash.
101
102			=cut
103
104			sub new ($;%) {
105			my $class = shift;
106			my $self = bless {option => {@_}}, $class;
107			for (keys %DEFAULT) {$self->{option}->{$_} \|\|= $DEFAULT{$_}}
108			$self;
109			}
110
111			=head2 Message::Header->parse ($header, [%option])
112
113			Parses given C<header> and return a new Message::Header
114			object. Some options can be specified as hash.
115
116			=cut
117
118			sub parse ($$;%) {
119			my $class = shift;
120			my $header = shift;
121			my $self = bless {option => {@_}}, $class;
122			for (keys %DEFAULT) {$self->{option}->{$_} \|\|= $DEFAULT{$_}}
123			$header =~ s/\x0D?\x0A$REG{WSP}+/\x20/gos; ## unfold
124			for my $field (split /\x0D?\x0A/, $header) {
125			if ($field =~ /$REG{M_fromline}/) {
126	wakaba	1.9	my $body = $1;
127			$body = $self->_field_body ($body, 'mail-from')
128			if $self->{option}->{parse_all}>0;
129			push @{$self->{field}}, {name => 'mail-from', body => $body};
130	wakaba	1.1	} elsif ($field =~ /$REG{M_field}/) {
131	wakaba	1.9	my ($name, $body) = (lc $1, $2);
132	wakaba	1.1	$name =~ s/$REG{WSP}+$//;
133			$body =~ s/$REG{WSP}+$//;
134	wakaba	1.9	$body = $self->_field_body ($body, $name) if $self->{option}->{parse_all}>0;
135			push @{$self->{field}}, {name => $name, body => $body};
136	wakaba	1.1	}
137			}
138			$self;
139			}
140
141			=head2 $self->field ($field_name)
142
143			Returns C<field-body> of given C<field-name>.
144			When there are two or more C<field>s whose name is C<field-name>,
145			this method return all C<field-body>s as array. (On scalar
146			context, only first one is returned.)
147
148			=cut
149
150			sub field ($$) {
151			my $self = shift;
152			my $name = lc shift;
153			my @ret;
154			for my $field (@{$self->{field}}) {
155			if ($field->{name} eq $name) {
156			unless (wantarray) {
157	wakaba	1.5	$field->{body} = $self->_field_body ($field->{body}, $name);
158			return $field->{body};
159	wakaba	1.1	} else {
160	wakaba	1.5	$field->{body} = $self->_field_body ($field->{body}, $name);
161			push @ret, $field->{body};
162	wakaba	1.1	}
163			}
164			}
165	wakaba	1.9	if ($#ret < 0) {
166			return $self->add ($name);
167			}
168	wakaba	1.1	@ret;
169			}
170
171	wakaba	1.9	sub field_exist ($$) {
172			my $self = shift;
173			my $name = lc shift;
174			my @ret;
175			for my $field (@{$self->{field}}) {
176			return 1 if ($field->{name} eq $name);
177			}
178			0;
179			}
180
181	wakaba	1.2	=head2 $self->field_name ($index)
182
183			Returns C<field-name> of $index'th C<field>.
184
185			=head2 $self->field_body ($index)
186
187			Returns C<field-body> of $index'th C<field>.
188
189			=cut
190
191			sub field_name ($$) {
192			my $self = shift;
193			$self->{field}->[shift]->{name};
194			}
195			sub field_body ($$) {
196			my $self = shift;
197	wakaba	1.4	my $i = shift;
198	wakaba	1.5	$self->{field}->[$i]->{body}
199			= $self->_field_body ($self->{field}->[$i]->{body}, $self->{field}->[$i]->{name});
200			$self->{field}->[$i]->{body};
201	wakaba	1.4	}
202
203			sub _field_body ($$$) {
204			my $self = shift;
205			my ($body, $name) = @_;
206	wakaba	1.5	unless (ref $body) {
207	wakaba	1.4	my $type = $self->{option}->{field_type}->{$name}
208	wakaba	1.7	\|\| $self->{option}->{field_type}->{':DEFAULT'};
209	wakaba	1.5	eval "require $type";
210			unless ($body) {
211			$body = $type->new (field_name => $name);
212			} else {
213			$body = $type->parse ($body, field_name => $name);
214			}
215	wakaba	1.4	}
216	wakaba	1.5	$body;
217	wakaba	1.2	}
218
219	wakaba	1.1	=head2 $self->field_name_list ()
220
221			Returns list of all C<field-name>s. (Even if there are two
222			or more C<field>s which have same C<field-name>, this method
223			returns ALL names.)
224
225			=cut
226
227			sub field_name_list ($) {
228			my $self = shift;
229			$self->_delete_empty_field ();
230			map {$_->{name}} @{$self->{field}};
231			}
232
233			=head2 $self->add ($field_name, $field_body)
234
235			Adds an new C<field>. It is not checked whether
236			the field which named $field_body is already exist or not.
237			If you don't want duplicated C<field>s, use C<replace> method.
238
239			=cut
240
241	wakaba	1.9	sub add ($$;$%) {
242	wakaba	1.1	my $self = shift;
243			my ($name, $body) = (lc shift, shift);
244	wakaba	1.8	my %option = @_;
245	wakaba	1.1	return 0 if $name =~ /$REG{UNSAFE_field_name}/;
246	wakaba	1.5	$body = $self->_field_body ($body, $name);
247	wakaba	1.8	if ($option{prepend}) {
248	wakaba	1.9	unshift @{$self->{field}}, {name => $name, body => $body};
249	wakaba	1.8	} else {
250			push @{$self->{field}}, {name => $name, body => $body};
251			}
252	wakaba	1.5	$body;
253	wakaba	1.1	}
254
255			=head2 $self->relace ($field_name, $field_body)
256
257			Set the C<field-body> named C<field-name> as $field_body.
258			If $field_name C<field> is already exists, it is replaced
259			by new $field_body value. If not, new C<field> is inserted.
260			(If there are some C<field> named as $field_name,
261			first one is used and the others are not changed.)
262
263			=cut
264
265			sub replace ($$$) {
266			my $self = shift;
267			my ($name, $body) = (lc shift, shift);
268			return 0 if $name =~ /$REG{UNSAFE_field_name}/;
269	wakaba	1.9	$body = $self->_field_body ($body, $name);
270	wakaba	1.1	for my $field (@{$self->{field}}) {
271			if ($field->{name} eq $name) {
272			$field->{body} = $body;
273	wakaba	1.8	return $body;
274	wakaba	1.1	}
275			}
276			push @{$self->{field}}, {name => $name, body => $body};
277	wakaba	1.9	$body;
278	wakaba	1.1	}
279
280			=head2 $self->delete ($field_name, [$index])
281
282			Deletes C<field> named as $field_name.
283			If $index is specified, only $index'th C<field> is deleted.
284			If not, ($index == 0), all C<field>s that have the C<field-name>
285			$field_name are deleted.
286
287			=cut
288
289			sub delete ($$;$) {
290			my $self = shift;
291			my ($name, $index) = (lc shift, shift);
292			my $i = 0;
293			for my $field (@{$self->{field}}) {
294			if ($field->{name} eq $name) {
295			$i++;
296			if ($index == 0 \|\| $i == $index) {
297			undef $field;
298			return $self if $i == $index;
299			}
300			}
301			}
302			$self;
303			}
304
305	wakaba	1.2	=head2 $self->count ([$field_name])
306	wakaba	1.1
307			Returns the number of times the given C<field> appears.
308	wakaba	1.2	If no $field_name is given, returns the number
309			of fields. (Same as $#$self+1)
310	wakaba	1.1
311			=cut
312
313	wakaba	1.2	sub count ($;$) {
314	wakaba	1.1	my $self = shift;
315			my ($name) = (lc shift);
316	wakaba	1.2	unless ($name) {
317			$self->_delete_empty_field ();
318			return $#{$self->{field}}+1;
319			}
320	wakaba	1.1	my $count = 0;
321			for my $field (@{$self->{field}}) {
322			if ($field->{name} eq $name) {
323			$count++;
324			}
325			}
326			$count;
327			}
328
329			=head2 $self->stringify ([%option])
330
331			Returns the C<header> as a string.
332
333			=cut
334
335			sub stringify ($;%) {
336			my $self = shift;
337			my %OPT = @_;
338			my @ret;
339			$OPT{capitalize} \|\|= $self->{option}->{capitalize};
340			$OPT{mail_from} \|\|= $self->{option}->{mail_from};
341	wakaba	1.9	push @ret, 'From '.$self->field ('mail-from') if $OPT{mail_from}>0;
342	wakaba	1.1	for my $field (@{$self->{field}}) {
343			my $name = $field->{name};
344			next unless $field->{name};
345	wakaba	1.9	next if $OPT{mail_from}<0 && $name eq 'mail-from';
346	wakaba	1.5	my $fbody = scalar $field->{body};
347			next unless $fbody;
348	wakaba	1.9	$fbody =~ s/\x0D([^\x09\x0A\x20])/\x0D\x20$1/g;
349			$fbody =~ s/\x0A([^\x09\x20])/\x0A\x20$1/g;
350	wakaba	1.1	$name =~ s/((?:^\|-)[a-z])/uc($1)/ge if $OPT{capitalize};
351	wakaba	1.5	push @ret, $name.': '.$self->fold ($fbody);
352	wakaba	1.1	}
353	wakaba	1.3	my $ret = join ("\n", @ret);
354			$ret? $ret."\n": "";
355	wakaba	1.1	}
356
357			=head2 $self->get_option ($option_name)
358
359			Returns value of the option.
360
361			=head2 $self->set_option ($option_name, $option_value)
362
363			Set new value of the option.
364
365			=cut
366
367			sub get_option ($$) {
368			my $self = shift;
369			my ($name) = @_;
370			$self->{option}->{$name};
371			}
372			sub set_option ($$$) {
373			my $self = shift;
374			my ($name, $value) = @_;
375			$self->{option}->{$name} = $value;
376			$self;
377			}
378
379	wakaba	1.4	sub field_type ($$;$) {
380			my $self = shift;
381			my $field_name = shift;
382			my $new_field_type = shift;
383			if ($new_field_type) {
384			$self->{option}->{field_type}->{$field_name} = $new_field_type;
385			}
386			$self->{option}->{field_type}->{$field_name}
387	wakaba	1.7	\|\| $self->{option}->{field_type}->{':DEFAULT'};
388	wakaba	1.4	}
389
390	wakaba	1.1	sub _delete_empty_field ($) {
391			my $self = shift;
392			my @ret;
393			for my $field (@{$self->{field}}) {
394			push @ret, $field if $field->{name};
395			}
396			$self->{field} = \@ret;
397			$self;
398			}
399
400			sub fold ($$;$) {
401			my $self = shift;
402			my $string = shift;
403			my $len = shift \|\| $self->{option}->{fold_length};
404			$len = 60 if $len < 60;
405
406			## This code is taken from Mail::Header 1.43 in MailTools,
407			## by Graham Barr (Maintained by Mark Overmeer <mailtools@overmeer.net>).
408			my $max = int($len - 5); # 4 for leading spcs + 1 for [\,\;]
409			my $min = int($len * 4 / 5) - 4;
410			my $ml = $len;
411
412			if (length($string) > $ml) {
413			#Split the line up
414			# first bias towards splitting at a , or a ; >4/5 along the line
415			# next split a whitespace
416			# else we are looking at a single word and probably don't want to split
417			my $x = "";
418			$x .= "$1\n "
419			while($string =~ s/^$REG{WSP}*(
420			[^"]{$min,$max}?[\,\;]
421			\|[^"]{1,$max}$REG{WSP}
422			\|[^\s"](?:"[^"]"[^\s"]*)+$REG{WSP}
423			\|[^\s"]+$REG{WSP}
424			)
425			//x);
426			$x .= $string;
427			$string = $x;
428			$string =~ s/(\A$REG{WSP}+\|$REG{WSP}+\Z)//sog;
429			$string =~ s/\s+\n/\n/sog;
430			}
431			$string;
432			}
433
434			=head1 EXAMPLE
435
436			## Print field list
437
438			use Message::Header;
439			my $header = Message::Header->parse ($header);
440
441	wakaba	1.2	## Next sample is better.
442			#for my $field (@$header) {
443			# print $field->{name}, "\t=> ", $field->{body}, "\n";
444			#}
445
446			for my $i (0..$#$header) {
447			print $header->field_name ($i), "\t=> ", $header->field_body ($i), "\n";
448	wakaba	1.1	}
449
450
451			## Make simple header
452
453	wakaba	1.2	use Message::Header;
454	wakaba	1.1	use Message::Field::Address;
455			my $header = new Message::Header;
456
457			my $from = new Message::Field::Address;
458			$from->add ('foo@foo.example', name => 'F. Foo');
459			my $to = new Message::Field::Address;
460			$to->add ('bar@bar.example', name => 'Mr. Bar');
461			$to->add ('hoge@foo.example', name => 'Hoge-san');
462			$header->add ('From' => $from);
463			$header->add ('To' => $to);
464			$header->add ('Subject' => 'Re: Meeting');
465			$header->add ('References' => '<hoge.msgid%foo@foo.example>');
466			print $header;
467
468			=head1 LICENSE
469
470			Copyright 2002 wakaba E<lt>w@suika.fam.cxE<gt>.
471
472			This program is free software; you can redistribute it and/or modify
473			it under the terms of the GNU General Public License as published by
474			the Free Software Foundation; either version 2 of the License, or
475			(at your option) any later version.
476
477			This program is distributed in the hope that it will be useful,
478			but WITHOUT ANY WARRANTY; without even the implied warranty of
479			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
480			GNU General Public License for more details.
481
482			You should have received a copy of the GNU General Public License
483			along with this program; see the file COPYING. If not, write to
484			the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
485			Boston, MA 02111-1307, USA.
486
487			=head1 CHANGE
488
489			See F<ChangeLog>.
490	wakaba	1.9	$Date: 2002/03/23 11:43:06 $
491	wakaba	1.1
492			=cut
493
494			1;