/[suikacvs]/test/cvs
Suika

Contents of /test/cvs

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.23 - (show annotations) (download)
Sun Jun 9 11:20:24 2002 UTC (21 years, 10 months ago) by wakaba
Branch: MAIN
Changes since 1.22: +10 -2 lines
2002-06-09  wakaba <w@suika.fam.cx>

	* Entity.pm:
	- (stringify): Minimumize MIME charset name when MIME'izing.
	- (mime-entity): New 'format' type.
	- (default_media_subtype): New option.  Now 'default_media_type'
	is used for only (narrower meaning of) media type.
	- (content_type): See 'default_media_type' and
	'default_media_subtype'.  (Was hardcoded as 'text/plain'.)
	- (option): '-resucrive': new option.
	* Header.pm (parse, parse_array): Don't discard invalid
	line (non-'field' line).  (Treat as "X-Unknown" field.)

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24