/[suikacvs]/test/cvs
Suika

Contents of /test/cvs

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.29 - (hide annotations) (download)
Wed Jul 3 23:39:15 2002 UTC (21 years, 10 months ago) by wakaba
Branch: MAIN
Changes since 1.28: +17 -2 lines
2002-07-02  Wakaba <w@suika.fam.cx>

	* Util.pm (decide_newline): New function.
	* Entity.pm (parse): Call Message::Util::decide_newline
	instead of local code.

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24