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