| 1 |
|
|
| 2 |
=head1 NAME |
=head1 NAME |
| 3 |
|
|
| 4 |
Message::Header Perl module |
Message::Header --- A Perl Module for Internet Message Headers |
|
|
|
|
=head1 DESCRIPTION |
|
|
|
|
|
Perl module for RFC 822/2822 message C<header>. |
|
| 5 |
|
|
| 6 |
=cut |
=cut |
| 7 |
|
|
| 8 |
package Message::Header; |
package Message::Header; |
| 9 |
use strict; |
use strict; |
| 10 |
use vars qw($VERSION %REG %DEFAULT); |
use vars qw(%DEFAULT @ISA %REG $VERSION); |
| 11 |
$VERSION = '1.00'; |
$VERSION=do{my @r=(q$Revision$=~/\d+/g);sprintf "%d."."%02d" x $#r,@r}; |
| 12 |
|
require Message::Field::Structured; ## This may seem silly:-) |
| 13 |
|
push @ISA, qw(Message::Field::Structured); |
| 14 |
|
|
| 15 |
|
%REG = %Message::Util::REG; |
| 16 |
|
$REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/; |
| 17 |
|
$REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/; |
| 18 |
|
$REG{ftext} = qr/[\x21-\x39\x3B-\x7E]+/; ## [2]822 |
| 19 |
|
$REG{NON_ftext} = qr/[^\x21-\x39\x3B-\x7E]/; ## [2]822 |
| 20 |
|
$REG{NON_ftext_usefor} = qr/[^0-9A-Za-z-]/; ## name-character |
| 21 |
|
$REG{NON_ftext_http} = $REG{NON_http_token}; |
| 22 |
|
|
| 23 |
|
## Namespace support |
| 24 |
|
our %NS_phname2uri; ## PH-namespace name -> namespace URI |
| 25 |
|
our %NS_uri2package; ## namespace URI -> Package name |
| 26 |
|
our %NS_uri2phpackage; ## namespace URI -> PH-Package name |
| 27 |
|
require Message::Header::Default; ## Default namespace |
| 28 |
|
|
| 29 |
|
## Initialize of this class -- called by constructors |
| 30 |
|
%DEFAULT = ( |
| 31 |
|
-_HASH_NAME => 'value', |
| 32 |
|
-_METHODS => [qw|field field_exist field_type add replace count delete subject id is|], |
| 33 |
|
-_MEMBERS => [qw|value|], |
| 34 |
|
-_VALTYPE_DEFAULT => ':default', |
| 35 |
|
-by => 'name', |
| 36 |
|
-field_format_pattern => '%s: %s', |
| 37 |
|
-field_name_case_sensible => 0, |
| 38 |
|
-field_name_unsafe_rule => 'NON_ftext', |
| 39 |
|
-field_name_validation => 0, |
| 40 |
|
-field_sort => 0, |
| 41 |
|
-format => 'mail-rfc2822', |
| 42 |
|
-header_default_charset => 'iso-2022-int-1', |
| 43 |
|
-header_default_charset_input => 'iso-2022-int-1', |
| 44 |
|
-hook_init_fill_options => sub {}, |
| 45 |
|
-hook_stringify_fill_fields => sub {}, |
| 46 |
|
-linebreak_strict => 0, |
| 47 |
|
-line_length_max => 60, ## For folding |
| 48 |
|
#ns_default_phuri |
| 49 |
|
-output_bcc => 0, |
| 50 |
|
-output_folding => 1, |
| 51 |
|
-output_mail_from => 0, |
| 52 |
|
#parse_all |
| 53 |
|
-translate_underscore => 1, |
| 54 |
|
#uri_mailto_safe |
| 55 |
|
-uri_mailto_safe_level => 4, |
| 56 |
|
-use_folding => 1, |
| 57 |
|
#value_type |
| 58 |
|
); |
| 59 |
|
|
| 60 |
use overload '@{}' => sub {shift->_delete_empty_field()->{field}}, |
## taken from L<HTTP::Header> |
| 61 |
'""' => sub {shift->stringify}; |
# "Good Practice" order of HTTP message headers: |
| 62 |
|
# - General-Headers |
| 63 |
|
# - Request-Headers |
| 64 |
|
# - Response-Headers |
| 65 |
|
# - Entity-Headers |
| 66 |
|
# (From draft-ietf-http-v11-spec-rev-01, Nov 21, 1997) |
| 67 |
|
my @header_order = qw( |
| 68 |
|
mail-from x-envelope-from relay-version path status |
| 69 |
|
|
| 70 |
|
cache-control connection date pragma transfer-encoding upgrade trailer via |
| 71 |
|
|
| 72 |
|
accept accept-charset accept-encoding accept-language |
| 73 |
|
authorization expect from host |
| 74 |
|
if-modified-since if-match if-none-match if-range if-unmodified-since |
| 75 |
|
max-forwards proxy-authorization range referer te user-agent |
| 76 |
|
|
| 77 |
|
accept-ranges age location proxy-authenticate retry-after server vary |
| 78 |
|
warning www-authenticate |
| 79 |
|
|
| 80 |
|
mime-version |
| 81 |
|
allow content-base content-encoding content-language content-length |
| 82 |
|
content-location content-md5 content-range content-type |
| 83 |
|
etag expires last-modified content-style-type content-script-type |
| 84 |
|
link |
| 85 |
|
|
| 86 |
$REG{WSP} = qr/[\x09\x20]/; |
xref |
| 87 |
$REG{FWS} = qr/[\x09\x20]*/; |
); |
| 88 |
$REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/; |
my %header_order; |
|
$REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/; |
|
|
$REG{UNSAFE_field_name} = qr/[\x00-\x20\x3A\x7F-\xFF]/; |
|
| 89 |
|
|
| 90 |
=head2 options |
=head1 CONSTRUCTORS |
| 91 |
|
|
| 92 |
These options can be getten/set by C<get_option>/C<set_option> |
The following methods construct new C<Message::Header> objects: |
|
method. |
|
| 93 |
|
|
| 94 |
=head3 capitalize = 0/1 |
=over 4 |
| 95 |
|
|
| 96 |
(First character of) C<field-name> is capitalized |
=cut |
| 97 |
when C<stringify>. (Default = 1) |
|
| 98 |
|
sub _init ($;%) { |
| 99 |
|
my $self = shift; |
| 100 |
|
my %options = @_; |
| 101 |
|
my $DEFAULT = Message::Util::make_clone (\%DEFAULT); |
| 102 |
|
$self->SUPER::_init (%$DEFAULT, %options); |
| 103 |
|
$self->{value} = []; |
| 104 |
|
$self->_ns_load_ph ('default'); |
| 105 |
|
$self->_ns_load_ph ('x-rfc822'); |
| 106 |
|
$self->_ns_load_ph ('x-http'); |
| 107 |
|
$self->{option}->{ns_default_phuri} = $self->{ns}->{phname2uri}->{'x-rfc822'} |
| 108 |
|
unless $self->{option}->{ns_default_phuri}; |
| 109 |
|
|
| 110 |
|
## For text/rfc822-headers |
| 111 |
|
if (ref $options{entity_header}) { |
| 112 |
|
$self->{entity_header} = $options{entity_header}; |
| 113 |
|
delete $options{entity_header}; |
| 114 |
|
} |
| 115 |
|
my @new_fields = (); |
| 116 |
|
for my $name (keys %options) { |
| 117 |
|
unless (substr ($name, 0, 1) eq '-') { |
| 118 |
|
push @new_fields, ($name => $options{$name}); |
| 119 |
|
} |
| 120 |
|
} |
| 121 |
|
&{ $self->{option}->{hook_init_fill_options} } ($self, $self->{option}); |
| 122 |
|
$self->_init_by_format ($self->{option}->{format}, $self->{option}); |
| 123 |
|
# Make alternative representations of @header_order. This is used |
| 124 |
|
# for sorting. |
| 125 |
|
my $i = 1; |
| 126 |
|
for (@header_order) { |
| 127 |
|
$header_order{$_} = $i++ unless $header_order{$_}; |
| 128 |
|
} |
| 129 |
|
|
| 130 |
|
$self->add (@new_fields, -parse => $self->{option}->{parse_all}) |
| 131 |
|
if $#new_fields > -1; |
| 132 |
|
} |
| 133 |
|
|
| 134 |
|
sub _init_by_format ($$\%) { |
| 135 |
|
my $self = shift; |
| 136 |
|
my ($format, $option) = @_; |
| 137 |
|
return if $format eq $option->{format}; |
| 138 |
|
if ($format =~ /http/) { |
| 139 |
|
$option->{ns_default_phuri} = $self->{ns}->{phname2uri}->{'x-http'}; |
| 140 |
|
if ($format =~ /cgi/) { |
| 141 |
|
unshift @header_order, qw(content-type location); |
| 142 |
|
$option->{field_sort} = 'good-practice'; |
| 143 |
|
$option->{use_folding} = 0; |
| 144 |
|
} else { |
| 145 |
|
$option->{field_sort} = 'good-practice'; |
| 146 |
|
} |
| 147 |
|
} elsif ($format =~ /mail|news/) { ## RFC 822 |
| 148 |
|
$option->{ns_default_phuri} = $self->{ns}->{phname2uri}->{'x-rfc822'}; |
| 149 |
|
} |
| 150 |
|
if ($format =~ /uri-url-mailto/) { |
| 151 |
|
$option->{output_bcc} = 0; |
| 152 |
|
$option->{field_format_pattern} = '%s=%s'; |
| 153 |
|
$option->{output_folding} = sub { |
| 154 |
|
$_[1] =~ s/([^:@+\$A-Za-z0-9\-_.!~*])/sprintf('%%%02X', ord $1)/ge; |
| 155 |
|
$_[1]; |
| 156 |
|
}; ## Yes, this is not folding! |
| 157 |
|
} |
| 158 |
|
} |
| 159 |
|
|
| 160 |
=head3 fold_length = numeric value |
=item $msg = Message::Header->new ([%initial-fields/options]) |
| 161 |
|
|
| 162 |
Length of line used to fold. (Default = 70) |
Constructs a new C<Message::Headers> object. You might pass some initial |
| 163 |
|
C<field-name>-C<field-body> pairs and/or options as parameters to the constructor. |
| 164 |
|
|
| 165 |
=head3 mail_from = 0/1 |
Example: |
| 166 |
|
|
| 167 |
Outputs "From " line (known as Un*x From, Mail-From, and so on) |
$hdr = new Message::Headers |
| 168 |
when C<stringify>. (Default = 0) |
Date => 'Thu, 03 Feb 1994 00:00:00 +0000', |
| 169 |
|
Content_Type => 'text/html', |
| 170 |
|
Content_Location => 'http://www.foo.example/', |
| 171 |
|
-format => 'mail-rfc2822' ## not to be header field |
| 172 |
|
; |
| 173 |
|
|
| 174 |
=cut |
=cut |
| 175 |
|
|
| 176 |
%DEFAULT = ( |
## Inherited |
|
capitalize => 1, |
|
|
fold_length => 70, |
|
|
field_type => {':DEFAULT' => 'Message::Field::Unstructured'}, |
|
|
mail_from => -1, |
|
|
output_bcc => -1, |
|
|
parse_all => -1, |
|
|
); |
|
|
my @field_type_Structured = qw(cancel-lock |
|
|
importance mime-version path precedence 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(subject title x-nsubject)) |
|
|
{$DEFAULT{field_type}->{$_} = 'Message::Field::Subject'} |
|
|
for (qw(list-software user-agent server)) |
|
|
{$DEFAULT{field_type}->{$_} = 'Message::Field::UA'} |
|
| 177 |
|
|
| 178 |
=head2 Message::Header->new ([%option]) |
=item $msg = Message::Header->parse ($header, [%initial-fields/options]) |
| 179 |
|
|
| 180 |
Returns new Message::Header instance. Some options can be |
Parses given C<header> and constructs a new C<Message::Headers> |
| 181 |
specified as hash. |
object. You might pass some additional C<field-name>-C<field-body> pairs |
| 182 |
|
or/and initial options as parameters to the constructor. |
| 183 |
|
|
| 184 |
=cut |
=cut |
| 185 |
|
|
| 186 |
sub new ($;%) { |
sub parse ($$;%) { |
| 187 |
my $class = shift; |
my $class = shift; |
| 188 |
my $self = bless {option => {@_}}, $class; |
my $header = shift; |
| 189 |
for (keys %DEFAULT) {$self->{option}->{$_} ||= $DEFAULT{$_}} |
my $self = bless {}, $class; |
| 190 |
|
$self->_init (@_); |
| 191 |
|
if ($self->{option}->{linebreak_strict}) { |
| 192 |
|
$header =~ s/\x0D\x0A$REG{WSP}/\x20/gos if $self->{option}->{use_folding}; |
| 193 |
|
} else { |
| 194 |
|
$header =~ s/\x0D?\x0A$REG{WSP}/\x20/gos if $self->{option}->{use_folding}; |
| 195 |
|
} |
| 196 |
|
my %option = (%{ $self->{option} }); |
| 197 |
|
$option{parse_all} = 0; |
| 198 |
|
for my $field (split /\x0D?\x0A/, $header) { |
| 199 |
|
if ($field =~ /$REG{M_fromline}/) { |
| 200 |
|
my ($s,undef,$value) = $self->_value_to_arrayitem |
| 201 |
|
('mail-from' => $1, \%option); |
| 202 |
|
push @{$self->{value}}, $value if $s; |
| 203 |
|
} elsif ($field =~ /$REG{M_field}/) { |
| 204 |
|
my ($name, $body) = ($1, $2); |
| 205 |
|
$body =~ s/$REG{WSP}+$//; |
| 206 |
|
my ($s,undef,$value) = $self->_value_to_arrayitem |
| 207 |
|
($name => $body, \%option); |
| 208 |
|
push @{$self->{value}}, $value if $s; |
| 209 |
|
} elsif (length $field) { |
| 210 |
|
my ($s,undef,$value) = $self->_value_to_arrayitem |
| 211 |
|
('x-unknown' => $field, \%option); |
| 212 |
|
push @{$self->{value}}, $value if $s; |
| 213 |
|
} |
| 214 |
|
} |
| 215 |
|
$self->_ns_associate_numerical_prefix; ## RFC 2774 namespace |
| 216 |
|
for (@{ $self->{value} }) { |
| 217 |
|
no strict 'refs'; |
| 218 |
|
$_->{name} |
| 219 |
|
= &{ ${ &_NS_uri2package ($_->{ns}).'::OPTION' }{n11n_name} } |
| 220 |
|
($self, &_NS_uri2package ($_->{ns}), $_->{name}); |
| 221 |
|
$_->{body} = $self->_parse_value ($_->{name} => $_->{body}, ns => $_->{ns}) |
| 222 |
|
if $self->{option}->{parse_all}; |
| 223 |
|
} |
| 224 |
$self; |
$self; |
| 225 |
} |
} |
| 226 |
|
|
| 227 |
=head2 Message::Header->parse ($header, [%option]) |
=item $msg = Message::Header->parse_array (\@header, [%initial-fields/options]) |
| 228 |
|
|
| 229 |
Parses given C<header> and return a new Message::Header |
Parses given C<header> and constructs a new C<Message::Headers> |
| 230 |
object. Some options can be specified as hash. |
object. Same as C<Message::Header-E<lt>parse> but this method |
| 231 |
|
is given an array reference. You might pass some additional |
| 232 |
|
C<field-name>-C<field-body> pairs or/and initial options |
| 233 |
|
as parameters to the constructor. |
| 234 |
|
|
| 235 |
=cut |
=cut |
| 236 |
|
|
| 237 |
sub parse ($$;%) { |
sub parse_array ($\@;%) { |
| 238 |
my $class = shift; |
my $class = shift; |
| 239 |
my $header = shift; |
my $header = shift; |
| 240 |
my $self = bless {option => {@_}}, $class; |
Carp::croak "parse_array: first argument is not an array reference" |
| 241 |
for (keys %DEFAULT) {$self->{option}->{$_} ||= $DEFAULT{$_}} |
unless ref $header eq 'ARRAY'; |
| 242 |
$header =~ s/\x0D?\x0A$REG{WSP}+/\x20/gos; ## unfold |
my $self = bless {}, $class; |
| 243 |
for my $field (split /\x0D?\x0A/, $header) { |
$self->_init (@_); |
| 244 |
|
while (1) { |
| 245 |
|
my $field = shift @$header; |
| 246 |
|
if ($self->{option}->{use_folding}) { |
| 247 |
|
while (1) { |
| 248 |
|
if ($$header[0] =~ /^$REG{WSP}/) { |
| 249 |
|
$field .= shift @$header; |
| 250 |
|
} else {last} |
| 251 |
|
} |
| 252 |
|
} |
| 253 |
|
if ($self->{option}->{linebreak_strict}) { |
| 254 |
|
$field =~ s/\x0D\x0A//g; |
| 255 |
|
} else { |
| 256 |
|
$field =~ tr/\x0D\x0A//d; |
| 257 |
|
} |
| 258 |
|
local $self->{option}->{parse} = $self->{option}->{parse_all}; |
| 259 |
if ($field =~ /$REG{M_fromline}/) { |
if ($field =~ /$REG{M_fromline}/) { |
| 260 |
my $body = $1; |
my ($s,undef,$value) = $self->_value_to_arrayitem |
| 261 |
$body = $self->_field_body ($body, 'mail-from') |
('mail-from' => $1, $self->{option}); |
| 262 |
if $self->{option}->{parse_all}>0; |
push @{$self->{value}}, $value if $s; |
|
push @{$self->{field}}, {name => 'mail-from', body => $body}; |
|
| 263 |
} elsif ($field =~ /$REG{M_field}/) { |
} elsif ($field =~ /$REG{M_field}/) { |
| 264 |
my ($name, $body) = (lc $1, $2); |
my ($name, $body) = ($self->_n11n_field_name ($1), $2); |
|
$name =~ s/$REG{WSP}+$//; |
|
| 265 |
$body =~ s/$REG{WSP}+$//; |
$body =~ s/$REG{WSP}+$//; |
| 266 |
$body = $self->_field_body ($body, $name) if $self->{option}->{parse_all}>0; |
my ($s,undef,$value) = $self->_value_to_arrayitem |
| 267 |
push @{$self->{field}}, {name => $name, body => $body}; |
($name => $body, $self->{option}); |
| 268 |
|
push @{$self->{value}}, $value if $s; |
| 269 |
|
} elsif (length $field) { |
| 270 |
|
my ($s,undef,$value) = $self->_value_to_arrayitem |
| 271 |
|
('x-unknown' => $field, $self->{option}); |
| 272 |
|
push @{$self->{value}}, $value if $s; |
| 273 |
} |
} |
| 274 |
|
last if $#$header < 0; |
| 275 |
} |
} |
| 276 |
|
$self->_ns_associate_numerical_prefix; ## RFC 2774 namespace |
| 277 |
$self; |
$self; |
| 278 |
} |
} |
| 279 |
|
|
| 280 |
|
=back |
| 281 |
|
|
| 282 |
|
=head1 METHODS |
| 283 |
|
|
| 284 |
=head2 $self->field ($field_name) |
=head2 $self->field ($field_name) |
| 285 |
|
|
| 286 |
Returns C<field-body> of given C<field-name>. |
Returns C<field-body> of given C<field-name>. |
| 290 |
|
|
| 291 |
=cut |
=cut |
| 292 |
|
|
| 293 |
sub field ($$) { |
sub field ($@) {shift->SUPER::item (@_)} |
| 294 |
|
sub field_exist ($@) {shift->SUPER::item_exist (@_)} |
| 295 |
|
|
| 296 |
|
## item-by?, \$checked-item, {item-key => 1}, \%option |
| 297 |
|
sub _item_match ($$\$\%\%) { |
| 298 |
my $self = shift; |
my $self = shift; |
| 299 |
my $name = lc shift; |
my ($by, $i, $list, $option) = @_; |
| 300 |
my @ret; |
return 0 unless ref $$i; ## Already removed |
| 301 |
for my $field (@{$self->{field}}) { |
if ($by eq 'name') { |
| 302 |
if ($field->{name} eq $name) { |
my %o = %$option; #$o{parse} = 0; |
| 303 |
unless (wantarray) { |
my %l; |
| 304 |
$field->{body} = $self->_field_body ($field->{body}, $name); |
for (keys %$list) { |
| 305 |
return $field->{body}; |
my ($s, undef, $v) = $self->_value_to_arrayitem ($_, '', \%o); |
| 306 |
|
if ($s) { |
| 307 |
|
$l{$v->{name} . ':' . ( $option->{ns} || $v->{ns} ) } = 1; |
| 308 |
} else { |
} else { |
| 309 |
$field->{body} = $self->_field_body ($field->{body}, $name); |
$l{$v->{name} .':'. ( $option->{ns} || $self->{option}->{ns_default_phuri} ) } = 1; |
| 310 |
push @ret, $field->{body}; |
} |
| 311 |
|
} |
| 312 |
|
return 1 if $l{$$i->{name} . ':' . $$i->{ns}}; |
| 313 |
|
} elsif ($by eq 'ns') { |
| 314 |
|
return 1 if $list->{ $$i->{ns} }; |
| 315 |
|
} elsif ($by eq 'http-ns-define') { |
| 316 |
|
if ($$i->{ns} eq $self->{ns}->{phname2uri}->{'x-http'} |
| 317 |
|
|| $$i->{ns} eq $self->{ns}->{phname2uri}->{'x-http-c'}) { |
| 318 |
|
my $n = $$i->{name}; |
| 319 |
|
if ($n eq 'opt' || $n eq 'c-opt' || $n eq 'man' || $n eq 'c-man') { |
| 320 |
|
$option->{parse} = 0; |
| 321 |
|
$$i->{body} = $self->_parse_value ($$i->{name} => $$i->{body}, ns => $$i->{ns}); |
| 322 |
|
for my $j (0..$$i->{body}->count-1) { |
| 323 |
|
return 1 if $list->{ ($$i->{body}->value ($j))[0]->value }; |
| 324 |
|
} |
| 325 |
} |
} |
| 326 |
} |
} |
| 327 |
} |
} |
| 328 |
if ($#ret < 0) { |
0; |
|
return $self->add ($name); |
|
|
} |
|
|
@ret; |
|
| 329 |
} |
} |
| 330 |
|
*_delete_match = \&_item_match; |
| 331 |
|
|
| 332 |
sub field_exist ($$) { |
## Returns returned item value \$item-value, \%option |
| 333 |
my $self = shift; |
sub _item_return_value ($\$\%) { |
| 334 |
my $name = lc shift; |
if (ref ${$_[1]}->{body}) { |
| 335 |
my @ret; |
${$_[1]}->{body}; |
| 336 |
for my $field (@{$self->{field}}) { |
} else { |
| 337 |
return 1 if ($field->{name} eq $name); |
${$_[1]}->{body} = $_[0]->_parse_value (${$_[1]}->{name} => ${$_[1]}->{body}, |
| 338 |
|
ns => ${$_[1]}->{ns}); |
| 339 |
|
${$_[1]}->{body}; |
| 340 |
|
} |
| 341 |
|
} |
| 342 |
|
*_add_return_value = \&_item_return_value; |
| 343 |
|
*_replace_return_value = \&_item_return_value; |
| 344 |
|
|
| 345 |
|
## Returns returned (new created) item value $name, \%option |
| 346 |
|
sub _item_new_value ($$\%) { |
| 347 |
|
my $self = shift; |
| 348 |
|
my ($name, $option) = @_; |
| 349 |
|
if ($option->{by} eq 'http-ns-define') { |
| 350 |
|
my $value = $self->_parse_value (opt => '', ns => $self->{ns}->{phname2uri}->{'x-http'}); |
| 351 |
|
($value->value (0))[0]->value ($name); |
| 352 |
|
{name => 'opt', body => $value, ns => $self->{ns}->{phname2uri}->{'x-http'}}; |
| 353 |
|
} else { |
| 354 |
|
my ($s,undef,$value) = $self->_value_to_arrayitem |
| 355 |
|
($name => '', $option); |
| 356 |
|
$s? $value: undef; |
| 357 |
} |
} |
|
0; |
|
| 358 |
} |
} |
| 359 |
|
|
|
=head2 $self->field_name ($index) |
|
|
|
|
|
Returns C<field-name> of $index'th C<field>. |
|
|
|
|
|
=head2 $self->field_body ($index) |
|
| 360 |
|
|
|
Returns C<field-body> of $index'th C<field>. |
|
|
|
|
|
=cut |
|
| 361 |
|
|
| 362 |
sub field_name ($$) { |
## $self->_parse_value ($type, $value, %options); |
| 363 |
|
sub _parse_value ($$$;%) { |
| 364 |
my $self = shift; |
my $self = shift; |
| 365 |
$self->{field}->[shift]->{name}; |
my $name = shift ;#|| $self->{option}->{_VALTYPE_DEFAULT}; |
| 366 |
} |
my $value = shift; return $value if ref $value; |
| 367 |
sub field_body ($$) { |
my %option = @_; |
| 368 |
my $self = shift; |
my $vtype; { no strict 'refs'; |
| 369 |
my $i = shift; |
my $vt = ${&_NS_uri2package ($option{ns}).'::OPTION'}{value_type}; |
| 370 |
$self->{field}->[$i]->{body} |
if (ref $vt) { |
| 371 |
= $self->_field_body ($self->{field}->[$i]->{body}, $self->{field}->[$i]->{name}); |
$vtype = $vt->{$name} || $vt->{$self->{option}->{_VALTYPE_DEFAULT}}; |
| 372 |
$self->{field}->[$i]->{body}; |
} |
| 373 |
|
## For compatiblity. |
| 374 |
|
unless (ref $vtype) { $vtype = $self->{option}->{value_type}->{$name} |
| 375 |
|
|| $self->{option}->{value_type}->{$self->{option}->{_VALTYPE_DEFAULT}} } |
| 376 |
|
} |
| 377 |
|
my $vpackage = $vtype->[0]; |
| 378 |
|
my %vopt = %{$vtype->[1]} if ref $vtype->[1]; |
| 379 |
|
if ($vpackage eq ':none:') { |
| 380 |
|
return $value; |
| 381 |
|
} elsif (defined $value) { |
| 382 |
|
eval "require $vpackage" or Carp::croak qq{<parse>: $vpackage: Can't load package: $@}; |
| 383 |
|
return $vpackage->parse ($value, |
| 384 |
|
-format => $self->{option}->{format}, |
| 385 |
|
-field_ns => $option{ns}, |
| 386 |
|
-field_name => $name, |
| 387 |
|
-header_default_charset => $self->{option}->{header_default_charset}, |
| 388 |
|
-header_default_charset_input => $self->{option}->{header_default_charset_input}, |
| 389 |
|
-parse_all => $self->{option}->{parse_all}, |
| 390 |
|
%vopt); |
| 391 |
|
} else { |
| 392 |
|
eval "require $vpackage" or Carp::croak qq{<parse>: $vpackage: Can't load package: $@}; |
| 393 |
|
return $vpackage->new ( |
| 394 |
|
-format => $self->{option}->{format}, |
| 395 |
|
-field_ns => $option{ns}, |
| 396 |
|
-field_name => $name, |
| 397 |
|
-header_default_charset => $self->{option}->{header_default_charset}, |
| 398 |
|
-header_default_charset_input => $self->{option}->{header_default_charset_input}, |
| 399 |
|
-parse_all => $self->{option}->{parse_all}, |
| 400 |
|
%vopt); |
| 401 |
|
} |
| 402 |
} |
} |
| 403 |
|
|
| 404 |
sub _field_body ($$$) { |
## Defined for text/rfc822-headers |
| 405 |
my $self = shift; |
sub entity_header ($;$) { |
| 406 |
my ($body, $name) = @_; |
my $self = shift; |
| 407 |
unless (ref $body) { |
my $new_header = shift; |
| 408 |
my $type = $self->{option}->{field_type}->{$name} |
if (ref $new_header) { |
| 409 |
|| $self->{option}->{field_type}->{':DEFAULT'}; |
$self->{header} = $new_header; |
|
eval "require $type"; |
|
|
unless ($body) { |
|
|
$body = $type->new (field_name => $name); |
|
|
} else { |
|
|
$body = $type->parse ($body, field_name => $name); |
|
|
} |
|
| 410 |
} |
} |
| 411 |
$body; |
$self->{header}; |
| 412 |
} |
} |
| 413 |
|
|
| 414 |
=head2 $self->field_name_list () |
=head2 $self->field_name_list () |
| 421 |
|
|
| 422 |
sub field_name_list ($) { |
sub field_name_list ($) { |
| 423 |
my $self = shift; |
my $self = shift; |
| 424 |
$self->_delete_empty_field (); |
$self->_delete_empty (); |
| 425 |
map {$_->{name}} @{$self->{field}}; |
map { $_->{name} . ':' . $_->{ns} } @{$self->{value}}; |
| 426 |
} |
} |
| 427 |
|
|
| 428 |
=head2 $self->add ($field_name, $field_body) |
sub namespace_ph_default ($;$) { |
| 429 |
|
my $self = shift; |
| 430 |
|
if (defined $_[0]) { |
| 431 |
|
no strict 'refs'; |
| 432 |
|
$self->{option}->{ns_default_phuri} = $_[0]; |
| 433 |
|
$self->_ns_load_ph (${&_NS_uri2package ($self->{option}->{ns_default_phuri}).'::OPTION'}{namespace_phname}); |
| 434 |
|
} |
| 435 |
|
$self->{option}->{ns_default_phuri}; |
| 436 |
|
} |
| 437 |
|
|
| 438 |
|
=item $hdr->add ($field-name, $field-body, [$name, $body, ...]) |
| 439 |
|
|
| 440 |
|
Adds some field name/body pairs. Even if there are |
| 441 |
|
one or more fields named given C<$field-name>, |
| 442 |
|
given name/body pairs are ADDed. Use C<replace> |
| 443 |
|
to remove same-name-fields. |
| 444 |
|
|
| 445 |
|
Instead of field name-body pair, you might pass some options. |
| 446 |
|
Four options are available for this method. |
| 447 |
|
|
| 448 |
|
C<-parse>: Parses and validates C<field-body>, and returns |
| 449 |
|
C<field-body> object. (When multiple C<field-body>s are |
| 450 |
|
added, returns only last one.) (Default: C<defined wantarray>) |
| 451 |
|
|
| 452 |
Adds an new C<field>. It is not checked whether |
C<-prepend>: New fields are not appended, |
| 453 |
the field which named $field_body is already exist or not. |
but prepended to current fields. (Default: C<0>) |
| 454 |
If you don't want duplicated C<field>s, use C<replace> method. |
|
| 455 |
|
C<-translate-underscore>: Do C<field-name> =~ tr/_/-/. (Default: C<1>) |
| 456 |
|
|
| 457 |
|
C<-validate>: Checks whether C<field-name> is valid or not. |
| 458 |
|
|
| 459 |
=cut |
=cut |
| 460 |
|
|
| 461 |
sub add ($$;$%) { |
## [Name: Value] pair -> internal array item |
| 462 |
|
## $self->_value_to_arrayitem ($name => $value, {%options}) |
| 463 |
|
## or |
| 464 |
|
## $self->_value_to_arrayitem ($name => [$value, %value_options], {%options}) |
| 465 |
|
## |
| 466 |
|
## Return: ((1 = success / 0 = failue), $full_name, $arrayitem) |
| 467 |
|
sub _value_to_arrayitem ($$$\%) { |
| 468 |
my $self = shift; |
my $self = shift; |
| 469 |
my ($name, $body) = (lc shift, shift); |
my ($name, $value, $option) = @_; |
| 470 |
my %option = @_; |
my $value_option = {}; |
| 471 |
return 0 if $name =~ /$REG{UNSAFE_field_name}/; |
if (ref $value eq 'ARRAY') { |
| 472 |
$body = $self->_field_body ($body, $name); |
($value, %$value_option) = @$value; |
| 473 |
if ($option{prepend}) { |
} |
| 474 |
unshift @{$self->{field}}, {name => $name, body => $body}; |
my $default_ns = $option->{ns_default_phuri}; |
| 475 |
} else { |
my $nsuri = $default_ns; |
| 476 |
push @{$self->{field}}, {name => $name, body => $body}; |
$name =~ s/^$REG{WSP}+//; $name =~ s/$REG{WSP}+$//; |
| 477 |
|
|
| 478 |
|
no strict 'refs'; |
| 479 |
|
if ($value_option->{ns}) { |
| 480 |
|
$nsuri = $value_option->{ns}; |
| 481 |
|
} elsif ($option->{ns}) { |
| 482 |
|
$nsuri = $option->{ns}; |
| 483 |
|
} elsif (($default_ns eq $self->{ns}->{uri2phname}->{'x-http'} |
| 484 |
|
&& $name =~ s/^([0-9]+)-//) |
| 485 |
|
|| ($name =~ s/^x-http-([0-9]+)-//i)) { ## Numric namespace prefix, RFC 2774 |
| 486 |
|
my $prefix = 0+$1; |
| 487 |
|
$nsuri = $self->{ns}->{number2uri}->{ $prefix }; |
| 488 |
|
unless ($nsuri) { |
| 489 |
|
$self->{ns}->{number2uri}->{ $prefix } = 'urn:x-suika-fam-cx:msgpm:header:x-temp:'.$prefix; |
| 490 |
|
$nsuri = $self->{ns}->{number2uri}->{ $prefix }; |
| 491 |
|
} |
| 492 |
|
} elsif ( |
| 493 |
|
${ &_NS_uri2package ($default_ns).'::OPTION' }{use_ph_namespace} |
| 494 |
|
&& ( |
| 495 |
|
($name =~ s/^([Xx]-[A-Za-z0-9]+|[A-Za-z]*[A-WYZa-wyz0-9][A-Za-z0-9]*)- |
| 496 |
|
([Xx]-[A-Za-z0-9]+|[A-Za-z0-9]*[A-WYZa-wyz0-9][A-Za-z0-9]*)-//x) |
| 497 |
|
|| $name =~ s/^([Xx]-[A-Za-z0-9]+|[A-Za-z0-9]*[A-WYZa-wyz0-9][A-Za-z0-9]*)-// |
| 498 |
|
)) { |
| 499 |
|
my ($prefix1, $prefix2) = ($1, $2); |
| 500 |
|
my $original_prefix = $&; my $one_prefix = 0; |
| 501 |
|
unless ($prefix2) { |
| 502 |
|
$prefix2 = $prefix1; |
| 503 |
|
$prefix1 = $self->{ns}->{uri2phname}->{ $default_ns }; |
| 504 |
|
$one_prefix = 1; |
| 505 |
|
} |
| 506 |
|
my $prefix |
| 507 |
|
= &{ ${ &_NS_uri2package ($nsuri).'::OPTION' }{n11n_prefix} } |
| 508 |
|
($self, &_NS_uri2package ($nsuri), $prefix1.'-'.$prefix2); |
| 509 |
|
$self->_ns_load_ph ($prefix); |
| 510 |
|
$nsuri = $self->{ns}->{phname2uri}->{ $prefix }; |
| 511 |
|
unless ($nsuri) { |
| 512 |
|
$nsuri = $default_ns; |
| 513 |
|
$prefix |
| 514 |
|
= &{ ${ &_NS_uri2package ($nsuri).'::OPTION' }{n11n_prefix} } |
| 515 |
|
($self, &_NS_uri2package ($nsuri), $one_prefix? $prefix2: $prefix1); |
| 516 |
|
$self->_ns_load_ph ($prefix); |
| 517 |
|
$nsuri = $self->{ns}->{phname2uri}->{ $prefix }; |
| 518 |
|
if ($nsuri) { |
| 519 |
|
$name = $prefix2 . '-' . $name unless $one_prefix; |
| 520 |
|
} else { |
| 521 |
|
$name = $original_prefix . $name; |
| 522 |
|
$nsuri = $default_ns; |
| 523 |
|
} |
| 524 |
|
} |
| 525 |
} |
} |
| 526 |
$body; |
$name |
| 527 |
|
= &{ ${ &_NS_uri2package ($nsuri).'::OPTION' }{n11n_name} } |
| 528 |
|
($self, &_NS_uri2package ($nsuri), $name); |
| 529 |
|
Carp::croak "$name: invalid field-name" |
| 530 |
|
if $option->{field_name_validation} |
| 531 |
|
&& $name =~ /$REG{ $option->{field_name_unsafe_rule} }/; |
| 532 |
|
$value = $self->_parse_value ($name => $value, ns => $nsuri) |
| 533 |
|
if $option->{parse} || $option->{parse_all}; |
| 534 |
|
$option->{parse} = 0; |
| 535 |
|
(1, $name.':'.$nsuri => {name => $name, body => $value, ns => $nsuri}); |
| 536 |
} |
} |
| 537 |
|
*_add_hash_check = \&_value_to_arrayitem; |
| 538 |
|
*_replace_hash_check = \&_value_to_arrayitem; |
| 539 |
|
|
| 540 |
=head2 $self->relace ($field_name, $field_body) |
=head2 $self->relace ($field_name, $field_body) |
| 541 |
|
|
| 547 |
|
|
| 548 |
=cut |
=cut |
| 549 |
|
|
| 550 |
sub replace ($$$) { |
sub _replace_hash_shift ($\%$\%) { |
| 551 |
my $self = shift; |
shift; my $r = shift; my $n = $_[0]->{name} . ':' . $_[0]->{ns}; |
| 552 |
my ($name, $body) = (lc shift, shift); |
if ($$r{$n}) { |
| 553 |
return 0 if $name =~ /$REG{UNSAFE_field_name}/; |
my $d = $$r{$n}; |
| 554 |
$body = $self->_field_body ($body, $name); |
delete $$r{$n}; |
| 555 |
for my $field (@{$self->{field}}) { |
return $d; |
|
if ($field->{name} eq $name) { |
|
|
$field->{body} = $body; |
|
|
return $body; |
|
|
} |
|
| 556 |
} |
} |
| 557 |
push @{$self->{field}}, {name => $name, body => $body}; |
undef; |
|
$body; |
|
| 558 |
} |
} |
| 559 |
|
|
| 560 |
=head2 $self->delete ($field_name, [$index]) |
=head2 $self->delete ($field-name, [$name, ...]) |
| 561 |
|
|
| 562 |
Deletes C<field> named as $field_name. |
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. |
|
| 563 |
|
|
| 564 |
=cut |
=cut |
| 565 |
|
|
|
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; |
|
|
} |
|
| 566 |
|
|
| 567 |
=head2 $self->count ([$field_name]) |
=head2 $self->count ([$field_name]) |
| 568 |
|
|
| 572 |
|
|
| 573 |
=cut |
=cut |
| 574 |
|
|
| 575 |
sub count ($;$) { |
sub _count_by_name ($$\%) { |
| 576 |
my $self = shift; |
my $self = shift; |
| 577 |
my ($name) = (lc shift); |
my ($array, $option) = @_; |
| 578 |
unless ($name) { |
my $name = $self->_n11n_field_name ($$option{-name}); |
| 579 |
$self->_delete_empty_field (); |
my @a = grep {$_->{name} eq $name} @{$self->{$array}}; |
| 580 |
return $#{$self->{field}}+1; |
$#a + 1; |
|
} |
|
|
my $count = 0; |
|
|
for my $field (@{$self->{field}}) { |
|
|
if ($field->{name} eq $name) { |
|
|
$count++; |
|
|
} |
|
|
} |
|
|
$count; |
|
| 581 |
} |
} |
| 582 |
|
|
| 583 |
=head2 $self->stringify ([%option]) |
## Delete empty items |
| 584 |
|
sub _delete_empty ($) { |
| 585 |
|
my $self = shift; |
| 586 |
|
my $array = $self->{option}->{_HASH_NAME}; |
| 587 |
|
$self->{$array} = [grep {ref $_ && length $_->{name}} @{$self->{$array}}]; |
| 588 |
|
} |
| 589 |
|
|
| 590 |
Returns the C<header> as a string. |
=head2 $self->rename ($field-name, $new-name, [$old, $new,...]) |
| 591 |
|
|
| 592 |
|
Renames C<$field-name> as C<$new-name>. |
| 593 |
|
|
| 594 |
=cut |
=cut |
| 595 |
|
|
| 596 |
sub stringify ($;%) { |
sub rename ($%) { |
| 597 |
my $self = shift; |
my $self = shift; |
| 598 |
my %OPT = @_; |
my %params = @_; |
| 599 |
my @ret; |
my %option = %{$self->{option}}; |
| 600 |
$OPT{capitalize} ||= $self->{option}->{capitalize}; |
for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}} |
| 601 |
$OPT{mail_from} ||= $self->{option}->{mail_from}; |
my %new_name; |
| 602 |
$OPT{output_bcc} ||= $self->{option}->{output_bcc}; |
for (grep {/^[^-]/} keys %params) { |
| 603 |
push @ret, 'From '.$self->field ('mail-from') if $OPT{mail_from}>0; |
my ($old => $new) |
| 604 |
for my $field (@{$self->{field}}) { |
= ($self->_n11n_field_name ($_) => $self->_n11n_field_name ($params{$_})); |
| 605 |
my $name = $field->{name}; |
$old =~ tr/_/-/ if $option{translate_underscore}; |
| 606 |
next unless $name; |
$new =~ tr/_/-/ if $option{translate_underscore}; |
| 607 |
next if $OPT{mail_from}<0 && $name eq 'mail-from'; |
Carp::croak "rename: $new: invalid field-name" |
| 608 |
next if $OPT{output_bcc}<0 && ($name eq 'bcc' || $name eq 'resent-bcc'); |
if $option{field_name_validation} |
| 609 |
my $fbody = scalar $field->{body}; |
&& $new =~ /$REG{$option{field_name_unsafe_rule}}/; |
| 610 |
next unless $fbody; |
$new_name{$old} = $new; |
|
$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); |
|
| 611 |
} |
} |
| 612 |
my $ret = join ("\n", @ret); |
for my $field (@{$self->{value}}) { |
| 613 |
$ret? $ret."\n": ""; |
if (length $new_name{$field->{name}}) { |
| 614 |
|
$field->{name} = $new_name{$field->{name}}; |
| 615 |
|
} |
| 616 |
|
} |
| 617 |
|
$self if defined wantarray; |
| 618 |
} |
} |
| 619 |
|
|
|
=head2 $self->get_option ($option_name) |
|
|
|
|
|
Returns value of the option. |
|
| 620 |
|
|
| 621 |
=head2 $self->set_option ($option_name, $option_value) |
=item $self->scan(\&doit) |
| 622 |
|
|
| 623 |
Set new value of the option. |
Apply a subroutine to each header field in turn. The callback routine is |
| 624 |
|
called with two parameters; the name of the field and a single value. |
| 625 |
|
If the header has more than one value, then the routine is called once |
| 626 |
|
for each value. |
| 627 |
|
|
| 628 |
=cut |
=cut |
| 629 |
|
|
| 630 |
sub get_option ($$) { |
sub _scan_sort ($\@\%) { |
| 631 |
my $self = shift; |
my $self = shift; |
| 632 |
my ($name) = @_; |
my ($array, $option) = @_; |
| 633 |
$self->{option}->{$name}; |
my $sort; |
| 634 |
|
$sort = \&_header_cmp if $option->{field_sort} eq 'good-practice'; |
| 635 |
|
$sort = {$a cmp $b} if $option->{field_sort} eq 'alphabetic'; |
| 636 |
|
return ( sort $sort @$array ) if ref $sort; |
| 637 |
|
@$array; |
| 638 |
} |
} |
| 639 |
sub set_option ($$$) { |
|
| 640 |
|
sub _n11n_field_name ($$) { |
| 641 |
|
no strict 'refs'; |
| 642 |
my $self = shift; |
my $self = shift; |
| 643 |
my ($name, $value) = @_; |
my $s = shift; |
| 644 |
$self->{option}->{$name} = $value; |
$s =~ s/^$REG{WSP}+//; $s =~ s/$REG{WSP}+$//; |
| 645 |
$self; |
$s = lc $s unless ${&_NS_uri2package ($self->{option}->{ns_default_phuri}).'::OPTION'}{case_sensible}; |
| 646 |
|
$s; |
| 647 |
|
} |
| 648 |
|
|
| 649 |
|
# Compare function which makes it easy to sort headers in the |
| 650 |
|
# recommended "Good Practice" order. |
| 651 |
|
## taken from HTTP::Header |
| 652 |
|
sub _header_cmp |
| 653 |
|
{ |
| 654 |
|
my ($na, $nb) = ($a->{name}, $b->{name}); |
| 655 |
|
# Unknown headers are assign a large value so that they are |
| 656 |
|
# sorted last. This also helps avoiding a warning from -w |
| 657 |
|
# about comparing undefined values. |
| 658 |
|
$header_order{$na} = 999 unless defined $header_order{$na}; |
| 659 |
|
$header_order{$nb} = 999 unless defined $header_order{$nb}; |
| 660 |
|
|
| 661 |
|
$header_order{$na} <=> $header_order{$nb} || $na cmp $nb; |
| 662 |
} |
} |
| 663 |
|
|
| 664 |
sub field_type ($$;$) { |
=head2 $self->stringify ([%option]) |
| 665 |
|
|
| 666 |
|
Returns the C<header> as a string. |
| 667 |
|
|
| 668 |
|
=cut |
| 669 |
|
|
| 670 |
|
sub stringify ($;%) { |
| 671 |
my $self = shift; |
my $self = shift; |
| 672 |
my $field_name = shift; |
my %params = @_; |
| 673 |
my $new_field_type = shift; |
my %option = %{$self->{option}}; |
| 674 |
if ($new_field_type) { |
$option{format} = $params{-format} if $params{-format}; |
| 675 |
$self->{option}->{field_type}->{$field_name} = $new_field_type; |
$self->_init_by_format ($option{format}, \%option); |
| 676 |
|
for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}} |
| 677 |
|
## Fill required fields |
| 678 |
|
my %exist; |
| 679 |
|
for ($self->field_name_list) {$exist{$_} = 1} |
| 680 |
|
&{ $option{hook_stringify_fill_fields} } ($self, \%exist, \%option); |
| 681 |
|
my @ret; |
| 682 |
|
## RFC 2774 numerical field name prefix |
| 683 |
|
my %nprefix; |
| 684 |
|
{no strict 'refs'; |
| 685 |
|
%nprefix = reverse %{ $self->{ns}->{number2uri} }; |
| 686 |
|
my $i = (sort { $a <=> $b } keys %{ $self->{ns}->{number2uri} })[-1] + 1; |
| 687 |
|
$i = 10 if $i < 10; |
| 688 |
|
my $hprefix = ${ &_NS_uri2package |
| 689 |
|
($self->{ns}->{phname2uri}->{'x-http'}) |
| 690 |
|
.'::OPTION' } {namespace_phname_goodcase}; |
| 691 |
|
for my $uri (keys %nprefix) { |
| 692 |
|
if ($nprefix{ $uri } < 10) { |
| 693 |
|
$nprefix{ $uri } = $i++; |
| 694 |
|
} |
| 695 |
|
my $nsfs = $self->item ($uri, -by => 'http-ns-define'); |
| 696 |
|
for my $i (0..$nsfs->count-1) { |
| 697 |
|
my $nsf = ($nsfs->value ($i))[0]; |
| 698 |
|
if ($nsf->value eq $uri) { |
| 699 |
|
$nsf->replace (ns => $nprefix{ $uri }); |
| 700 |
|
$nprefix{ $uri } = $hprefix . '-' . $nprefix{ $uri }; |
| 701 |
|
last; |
| 702 |
|
} |
| 703 |
|
} |
| 704 |
|
} |
| 705 |
|
} |
| 706 |
|
my $_stringify = sub { |
| 707 |
|
no strict 'refs'; |
| 708 |
|
my ($name, $body, $nsuri) = ($_[1]->{name}, $_[1]->{body}, $_[1]->{ns}); |
| 709 |
|
return unless length $name; |
| 710 |
|
return if $option{output_mail_from} && $name eq 'mail-from'; |
| 711 |
|
$body = '' if !$option{output_bcc} && $name eq 'bcc'; |
| 712 |
|
my $nspackage = &_NS_uri2package ($nsuri); |
| 713 |
|
my $oname; ## Outputed field-name |
| 714 |
|
my $prefix = $nprefix{ $nsuri } |
| 715 |
|
|| ${$nspackage.'::OPTION'} {namespace_phname_goodcase} |
| 716 |
|
|| $self->{ns}->{uri2phname}->{ $nsuri }; |
| 717 |
|
my $default_prefix = ${ &_NS_uri2package ($option{ns_default_phuri}) |
| 718 |
|
.'::OPTION'} {namespace_phname_goodcase}; |
| 719 |
|
$prefix = '' if $prefix eq $default_prefix; |
| 720 |
|
$prefix =~ s/^\Q$default_prefix\E-//; |
| 721 |
|
my $gc = ${$nspackage.'::OPTION'} {to_be_goodcase}; |
| 722 |
|
if (ref $gc) { $oname = &$gc ($self, $nspackage, $name, \%option) } |
| 723 |
|
else { $oname = $name } |
| 724 |
|
if ($prefix) { $oname = $prefix . '-' . $oname } |
| 725 |
|
if ($option{format} =~ /uri-url-mailto/) { |
| 726 |
|
return if (( ${$nspackage.'::OPTION'} {uri_mailto_safe}->{$name} |
| 727 |
|
|| ${$nspackage.'::OPTION'} {uri_mailto_safe}->{':default'}) |
| 728 |
|
< $option{uri_mailto_safe_level}); |
| 729 |
|
if ($name eq 'to') { |
| 730 |
|
$body = $self->field ('to', -new_item_unless_exist => 0); |
| 731 |
|
if (ref $body && $body->have_group) { |
| 732 |
|
# |
| 733 |
|
} elsif (ref $body && $body->count > 1) { |
| 734 |
|
$body = $body->clone; |
| 735 |
|
$body->delete ({-by => 'index'}, 0); |
| 736 |
|
} |
| 737 |
|
} |
| 738 |
|
} |
| 739 |
|
my $fbody; |
| 740 |
|
if (ref $body) { |
| 741 |
|
$fbody = $body->stringify (-format => $option{format}); |
| 742 |
|
} else { |
| 743 |
|
$fbody = $body; |
| 744 |
|
} |
| 745 |
|
unless (${$nspackage.'::OPTION'} {field}->{$name}->{empty_body}) { |
| 746 |
|
return unless length $fbody; |
| 747 |
|
} |
| 748 |
|
unless ($option{linebreak_strict}) { |
| 749 |
|
## bare \x0D and bare \x0A are unsafe |
| 750 |
|
$fbody =~ s/\x0D(?=[^\x09\x0A\x20])/\x0D\x20/g; |
| 751 |
|
$fbody =~ s/\x0A(?=[^\x09\x20])/\x0A\x20/g; |
| 752 |
|
} else { |
| 753 |
|
$fbody =~ s/\x0D\x0A(?=[^\x09\x20])/\x0D\x0A\x20/g; |
| 754 |
|
} |
| 755 |
|
if ($option{use_folding}) { |
| 756 |
|
if (ref $option{output_folding}) { |
| 757 |
|
$fbody = &{$option{output_folding}} ($self, $fbody, |
| 758 |
|
-initial_length => length ($oname) +2); |
| 759 |
|
} elsif ($option{output_folding}) { |
| 760 |
|
$fbody = $self->_fold ($fbody, -initial_length => length ($oname) +2); |
| 761 |
|
} |
| 762 |
|
} |
| 763 |
|
push @ret, sprintf $option{field_format_pattern}, $oname, $fbody; |
| 764 |
|
}; |
| 765 |
|
if ($option{format} =~ /uri-url-mailto/) { |
| 766 |
|
if ($option{format} =~ /uri-url-mailto-to/) { |
| 767 |
|
my $to = $self->field ('to', -new_item_unless_exist => 0); |
| 768 |
|
if ($to) { |
| 769 |
|
unless ($to->have_group) { |
| 770 |
|
my $fbody = $to->stringify (-format => $option{format}, -max => 1); |
| 771 |
|
return &{$option{output_folding}} ($self, $fbody); |
| 772 |
|
} |
| 773 |
|
} |
| 774 |
|
''; |
| 775 |
|
} elsif ($option{format} =~ /uri-url-mailto-rfc1738/) { |
| 776 |
|
my $to = $self->field ('to', -new_item_unless_exist => 0); |
| 777 |
|
if ($to) { |
| 778 |
|
my $fbody = $to->addr_spec (-format => $option{format}); |
| 779 |
|
return &{$option{output_folding}} ($self, $fbody); |
| 780 |
|
} |
| 781 |
|
''; |
| 782 |
|
} else { |
| 783 |
|
$self->scan ($_stringify); |
| 784 |
|
my $ret = join ('&', @ret); |
| 785 |
|
$ret; |
| 786 |
|
} |
| 787 |
|
} else { |
| 788 |
|
if ($option{output_mail_from}) { |
| 789 |
|
my $fromline = $self->field ('mail-from', -new_item_unless_exist => 0); |
| 790 |
|
push @ret, 'From '.$fromline if $fromline; |
| 791 |
|
} |
| 792 |
|
$self->scan ($_stringify); |
| 793 |
|
my $ret = join ("\x0D\x0A", @ret); |
| 794 |
|
$ret? $ret."\x0D\x0A": ''; |
| 795 |
} |
} |
|
$self->{option}->{field_type}->{$field_name} |
|
|
|| $self->{option}->{field_type}->{':DEFAULT'}; |
|
| 796 |
} |
} |
| 797 |
|
*as_string = \&stringify; |
| 798 |
|
|
| 799 |
|
=head2 $self->option ($option_name, [$option_value]) |
| 800 |
|
|
| 801 |
|
Set/gets new value of the option. |
| 802 |
|
|
| 803 |
sub _delete_empty_field ($) { |
=cut |
| 804 |
|
|
| 805 |
|
sub option ($@) { |
| 806 |
my $self = shift; |
my $self = shift; |
| 807 |
my @ret; |
if (@_ == 1) { |
| 808 |
for my $field (@{$self->{field}}) { |
return $self->{option}->{ shift (@_) }; |
| 809 |
push @ret, $field if $field->{name}; |
} |
| 810 |
|
while (my ($name, $value) = splice (@_, 0, 2)) { |
| 811 |
|
$self->{option}->{$name} = $value; |
| 812 |
|
if ($name eq 'format') { |
| 813 |
|
for my $f (@{$self->{field}}) { |
| 814 |
|
if (ref $f->{body}) { |
| 815 |
|
$f->{body}->option (-format => $value); |
| 816 |
|
} |
| 817 |
|
} |
| 818 |
|
} |
| 819 |
} |
} |
|
$self->{field} = \@ret; |
|
|
$self; |
|
| 820 |
} |
} |
| 821 |
|
|
| 822 |
sub fold ($$;$) { |
sub field_type ($@) {shift->SUPER::value_type (@_)} |
| 823 |
|
|
| 824 |
|
## $self->_fold ($string, %option = (-max, -initial_length(for field-name)) ) |
| 825 |
|
sub _fold ($$;%) { |
| 826 |
my $self = shift; |
my $self = shift; |
| 827 |
my $string = shift; |
my $string = shift; |
| 828 |
my $len = shift || $self->{option}->{fold_length}; |
my %option = @_; |
| 829 |
$len = 60 if $len < 60; |
my $max = $self->{option}->{line_length_max}; |
| 830 |
|
$max = 20 if $max < 20; |
|
## 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; |
|
| 831 |
|
|
| 832 |
if (length($string) > $ml) { |
my $l = $option{-initial_length} || 0; |
| 833 |
#Split the line up |
$l += length $1 if $string =~ /^([^\x09\x20]+)/; |
| 834 |
# first bias towards splitting at a , or a ; >4/5 along the line |
$string =~ s{([\x09\x20][^\x09\x20]+)}{ |
| 835 |
# next split a whitespace |
my $s = $1; |
| 836 |
# else we are looking at a single word and probably don't want to split |
if (($l + length $s) > $max) { |
| 837 |
my $x = ""; |
$s = "\x0D\x0A\x20" . $s; |
| 838 |
$x .= "$1\n " |
$l = 1 + length $s; |
| 839 |
while($string =~ s/^$REG{WSP}*( |
} else { $l += length $s } |
| 840 |
[^"]{$min,$max}?[\,\;] |
$s; |
| 841 |
|[^"]{1,$max}$REG{WSP} |
}gex; |
|
|[^\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; |
|
|
} |
|
| 842 |
$string; |
$string; |
| 843 |
} |
} |
| 844 |
|
|
| 845 |
|
sub _ns_load_ph ($$) { |
| 846 |
|
my $self = shift; |
| 847 |
|
my $name = shift; ## normalized prefix (without HYPHEN-MINUS) |
| 848 |
|
return if $self->{ns}->{phname2uri}->{$name}; |
| 849 |
|
$self->{ns}->{phname2uri}->{$name} = $NS_phname2uri{$name}; |
| 850 |
|
return unless $self->{ns}->{phname2uri}->{$name}; |
| 851 |
|
$self->{ns}->{uri2phname}->{$self->{ns}->{phname2uri}->{$name}} = $name; |
| 852 |
|
} |
| 853 |
|
|
| 854 |
|
sub _ns_associate_numerical_prefix ($) { |
| 855 |
|
my $self = shift; |
| 856 |
|
$self->scan (sub {shift; |
| 857 |
|
my $f = shift; return unless $f->{name}; |
| 858 |
|
if ($f->{ns} eq $self->{ns}->{phname2uri}->{'x-http'} |
| 859 |
|
|| $f->{ns} eq $self->{ns}->{phname2uri}->{'x-http-c'}) { |
| 860 |
|
my $fn = $f->{name}; |
| 861 |
|
if ($fn eq 'opt' || $fn eq 'man') { |
| 862 |
|
$f->{body} = $self->_parse_value ($fn => $f->{body}, ns => $f->{ns}); |
| 863 |
|
for ($f->{body}->value (0..$f->{body}->count-1)) { |
| 864 |
|
my ($nsuri, $number) = ($_->value, $_->item ('ns')); |
| 865 |
|
if ($number && $nsuri) { |
| 866 |
|
$self->{ns}->{number2uri}->{ $number } = $nsuri; |
| 867 |
|
} |
| 868 |
|
} |
| 869 |
|
} |
| 870 |
|
} |
| 871 |
|
}); |
| 872 |
|
$self->scan (sub {shift; |
| 873 |
|
my $f = shift; |
| 874 |
|
if ($f->{ns} =~ /urn:x-suika-fam-cx:msgpm:header:x-temp:([0-9]+)$/ && $self->{ns}->{number2uri}->{ $1 }) { |
| 875 |
|
$f->{ns} = $self->{ns}->{number2uri}->{ $1 }; |
| 876 |
|
} |
| 877 |
|
}); |
| 878 |
|
} |
| 879 |
|
|
| 880 |
|
## $package_name = Message::Header::_NS_uri2phpackage ($nsuri) |
| 881 |
|
## (For internal use of Message::* modules) |
| 882 |
|
sub _NS_uri2phpackage ($) { |
| 883 |
|
$NS_uri2phpackage{$_[0]} |
| 884 |
|
|| $NS_uri2phpackage{$Message::Header::Default::OPTION{namespace_uri}}; |
| 885 |
|
} |
| 886 |
|
sub _NS_uri2package ($) { |
| 887 |
|
$NS_uri2package{$_[0]} |
| 888 |
|
|| $NS_uri2phpackage{$_[0]} |
| 889 |
|
|| $NS_uri2phpackage{$Message::Header::Default::OPTION{namespace_uri}}; |
| 890 |
|
} |
| 891 |
|
|
| 892 |
|
=head2 $self->clone () |
| 893 |
|
|
| 894 |
|
Returns a copy of Message::Header object. |
| 895 |
|
|
| 896 |
|
=cut |
| 897 |
|
|
| 898 |
|
## Inhreited |
| 899 |
|
|
| 900 |
|
=head1 NOTE |
| 901 |
|
|
| 902 |
|
=head2 C<field-name> |
| 903 |
|
|
| 904 |
|
The header field name is not case sensitive. To make the life |
| 905 |
|
easier for perl users who wants to avoid quoting before the => operator, |
| 906 |
|
you can use '_' as a synonym for '-' in header field names |
| 907 |
|
(this behaviour can be suppressed by setting |
| 908 |
|
C<translate_underscore> option to C<0> value). |
| 909 |
|
|
| 910 |
=head1 EXAMPLE |
=head1 EXAMPLE |
| 911 |
|
|
| 912 |
## Print field list |
## Print field list |
| 914 |
use Message::Header; |
use Message::Header; |
| 915 |
my $header = Message::Header->parse ($header); |
my $header = Message::Header->parse ($header); |
| 916 |
|
|
|
## Next sample is better. |
|
|
#for my $field (@$header) { |
|
|
# print $field->{name}, "\t=> ", $field->{body}, "\n"; |
|
|
#} |
|
|
|
|
| 917 |
for my $i (0..$#$header) { |
for my $i (0..$#$header) { |
| 918 |
print $header->field_name ($i), "\t=> ", $header->field_body ($i), "\n"; |
print $header->field_name ($i), "\t=> ", $header->field_body ($i), "\n"; |
| 919 |
} |
} |
| 936 |
$header->add ('References' => '<hoge.msgid%foo@foo.example>'); |
$header->add ('References' => '<hoge.msgid%foo@foo.example>'); |
| 937 |
print $header; |
print $header; |
| 938 |
|
|
| 939 |
|
=head1 ACKNOWLEDGEMENTS |
| 940 |
|
|
| 941 |
|
Some of codes are taken from other modules such as |
| 942 |
|
HTTP::Header, Mail::Header. |
| 943 |
|
|
| 944 |
=head1 LICENSE |
=head1 LICENSE |
| 945 |
|
|
| 946 |
Copyright 2002 wakaba E<lt>w@suika.fam.cxE<gt>. |
Copyright 2002 wakaba E<lt>w@suika.fam.cxE<gt>. |
Parent Directory
| 
Revision Log
| 
Patch