/[suikacvs]/test/cvs
Suika

Contents of /test/cvs

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.21 - (show annotations) (download)
Sun May 26 01:20:09 2002 UTC (21 years, 11 months ago) by wakaba
Branch: MAIN
Changes since 1.20: +13 -121 lines
2002-05-26  wakaba <w@suika.fam.cx>

	* Header.pm (url_mailto_safe): Removed.
	(Moved to Message::Header::RFC822.)
	
	* Makefile: New file.

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24