/[suikacvs]/test/cvs
Suika

Contents of /test/cvs

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.32 - (hide annotations) (download)
Sat Jul 6 11:37:01 2002 UTC (21 years, 10 months ago) by wakaba
Branch: MAIN
Changes since 1.31: +34 -24 lines
2002-07-06  Wakaba <w@suika.fam.cx>

	* Header.pm: Support of RFC 2774 namespace.

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24