/[suikacvs]/test/cvs
Suika

Diff of /test/cvs

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.17 by wakaba, Sun Apr 21 04:28:46 2002 UTC revision 1.26 by wakaba, Sun Jun 16 10:45:54 2002 UTC
# Line 1  Line 1 
1    
2  =head1 NAME  =head1 NAME
3    
4  Message::Header Perl module  Message::Header --- A Perl Module for Internet Message Headers
   
 =head1 DESCRIPTION  
   
 Perl module for RFC 822/2822 message C<header>.  
5    
6  =cut  =cut
7    
8  package Message::Header;  package Message::Header;
9  use strict;  use strict;
10  use vars qw($VERSION %REG);  use vars qw(%DEFAULT @ISA %REG $VERSION);
11  $VERSION = '1.00';  $VERSION=do{my @r=(q$Revision$=~/\d+/g);sprintf "%d."."%02d" x $#r,@r};
12  use Carp ();  require Message::Field::Structured;     ## This may seem silly:-)
13  use overload '@{}' => sub { shift->_delete_empty_field->{field} },  push @ISA, qw(Message::Field::Structured);
14               '""' => sub { shift->stringify },  
15               fallback => 1;  %REG = %Message::Util::REG;
16            $REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/;
17  $REG{WSP}     = qr/[\x09\x20]/;          $REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/;
18  $REG{FWS}     = qr/[\x09\x20]*/;          $REG{ftext} = qr/[\x21-\x39\x3B-\x7E]+/;        ## [2]822
19  $REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/;          $REG{NON_ftext} = qr/[^\x21-\x39\x3B-\x7E]/;    ## [2]822
20  $REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/;          $REG{NON_ftext_usefor} = qr/[^0-9A-Za-z-]/;     ## name-character
21  $REG{UNSAFE_field_name} = qr/[\x00-\x20\x3A\x7F-\xFF]/;          $REG{NON_ftext_http} = $REG{NON_http_token};
22    
23  =head2 options  ## Namespace support
24            our %NS_phname2uri;     ## PH-namespace name -> namespace URI
25  These options can be getten/set by C<get_option>/C<set_option>          our %NS_uri2phpackage;  ## namespace URI -> PH-package name
26  method.          require Message::Header::Default;       ## Default namespace
27    
28  =head3 capitalize = 0/1  ## Initialize of this class -- called by constructors
29    %DEFAULT = (
30  (First character of) C<field-name> is capitalized      -_HASH_NAME => 'value',
31  when C<stringify>.  (Default = 1)      -_METHODS   => [qw|field field_exist field_type add replace count delete subject id is|],
32        -_MEMBERS   => [qw|value|],
33  =head3 fold_length = numeric value      -_VALTYPE_DEFAULT   => ':default',
34        -by => 'name',      ## (Reserved for method level option)
35  Length of line used to fold.  (Default = 70)      -field_format_pattern       => '%s: %s',
36        -field_name_case_sensible   => 0,
37  =head3 mail_from = 0/1      -field_name_unsafe_rule     => 'NON_ftext',
38        -field_name_validation      => 1,   ## Method level option.
39  Outputs "From " line (known as Un*x From, Mail-From, and so on)      -field_sort => 0,
40  when C<stringify>.  (Default = 0)      #-format    => 'mail-rfc2822',
41        -linebreak_strict   => 0,   ## Not implemented completely
42  =cut      -line_length_max    => 60,  ## For folding
43        #ns_default_phuri
44  =head1 CONSTRUCTORS      -output_bcc => 0,
45        -output_folding     => 1,
46  The following methods construct new C<Message::Header> objects:      -output_mail_from   => 0,
47        #-parse_all => 0,
48  =over 4      -translate_underscore       => 1,
49        #-uri_mailto_safe
50  =cut      -uri_mailto_safe_level      => 4,
51        -use_folding        => 1,
52  ## Initialize      #-value_type
 my %DEFAULT = (  
   capitalize    => 1,  
   fold  => 1,  
   fold_length   => 70,  
   field_format_pattern  => '%s: %s',  
   #field_type   => {},  
   format        => 'mail-rfc2822',  
   mail_from     => 0,  
   output_bcc    => 0,  
   parse_all     => 0,  
   sort  => 'none',  
   translate_underscore  => 1,  
   validate      => 1,  
53  );  );
54  $DEFAULT{field_type} = {  
55          ':DEFAULT'      => 'Message::Field::Unstructured',  $DEFAULT{-value_type} = {
56                    ':default'      => ['Message::Field::Unstructured'],
         received        => 'Message::Field::Received',  
         'x-received'    => 'Message::Field::Received',  
           
         'content-type'  => 'Message::Field::ContentType',  
         'auto-submitted'        => 'Message::Field::ValueParams',  
         'content-disposition'   => 'Message::Field::ValueParams',  
         link    => 'Message::Field::ValueParams',  
         archive => 'Message::Field::ValueParams',  
         'x-face-type'   => 'Message::Field::ValueParams',  
           
         subject => 'Message::Field::Subject',  
         'x-nsubject'    => 'Message::Field::Subject',  
           
         'list-software' => 'Message::Field::UA',  
         'user-agent'    => 'Message::Field::UA',  
         server  => 'Message::Field::UA',  
57                    
58          ## Numeric value          p3p     => ['Message::Field::Params'],
59          'content-length'        => 'Message::Field::Numval',          link    => ['Message::Field::ValueParams'],
         lines   => 'Message::Field::Numval',  
         'max-forwards'  => 'Message::Field::Numval',  
         'mime-version'  => 'Message::Field::Numval',  
         'x-jsmail-priority'     => 'Message::Field::Numval',  
         'x-mail-count'  => 'Message::Field::Numval',  
         'x-ml-count'    => 'Message::Field::Numval',  
         'x-priority'    => 'Message::Field::Numval',  
60                    
61          path    => 'Message::Field::Path',          'user-agent'    => ['Message::Field::UA'],
62            server  => ['Message::Field::UA'],
63  };  };
64  for (qw(archive cancel-lock content-features content-md5  for (qw(date expires))
65    disposition-notification-options encoding    {$DEFAULT{-value_type}->{$_} = ['Message::Field::Date']}
66    importance injector-info  for (qw(accept accept-charset accept-encoding accept-language uri))
67    pics-label posted-and-mailed precedence list-id message-type    {$DEFAULT{-value_type}->{$_} = ['Message::Field::CSV']}
68    original-recipient priority  for (qw(location referer))
69    sensitivity status x-face x-msmail-priority xref))    {$DEFAULT{-value_type}->{$_} = ['Message::Field::URI']}
70    {$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}  
71          ## Not supported yet, but to be supported...  my %header_goodcase = (
72  for (qw(abuse-reports-to apparently-to approved approved-by bcc cc complaints-to          'article-i.d.'  => 'Article-I.D.',
73    delivered-to disposition-notification-to envelope-to          etag    => 'ETag',
74    errors-to  from mail-copies-to mail-followup-to mail-reply-to          'pics-label'    => 'PICS-Label',
75    notice-requested-upon-delivery-to read-receipt-to register-mail-reply-requested-by          te      => 'TE',
76    reply-to resent-bcc          url     => 'URL',
77    resent-cc resent-to resent-from resent-sender return-path          'www-authenticate'      => 'WWW-Authenticate',
78    return-receipt-to return-receipt-requested-to sender to x-abuse-reports-to  );
   x-admin x-approved  
   x-beenthere  
   x-confirm-reading-to  
   x-complaints-to x-envelope-from x-envelope-sender  
   x-envelope-to x-ml-address x-ml-command x-ml-to x-nfrom x-nto  
   x-rcpt-to x-sender x-x-sender))  
   {$DEFAULT{field_type}->{$_} = 'Message::Field::Address'}  
 for (qw(date date-received delivery-date expires  
   expire-date nntp-posting-date posted posted-date reply-by resent-date  
   x-originalarrivaltime x-tcup-date))  
   {$DEFAULT{field_type}->{$_} = 'Message::Field::Date'}  
 for (qw(article-updates client-date content-id in-reply-to message-id  
   obsoletes references replaces resent-message-id see-also supersedes))  
   {$DEFAULT{field_type}->{$_} = 'Message::Field::MsgID'}  
 for (qw(accept accept-charset accept-encoding accept-language  
   content-language  
   content-transfer-encoding encrypted followup-to keywords  
   list-archive list-digest list-help list-owner  
   list-post list-subscribe list-unsubscribe list-url uri newsgroups  
   posted-to  
   x-brother x-daughter x-respect x-moe x-syster x-wife))  
   {$DEFAULT{field_type}->{$_} = 'Message::Field::CSV'}  
 for (qw(content-alias content-base content-location location referer  
   url x-home-page x-http_referer  
   x-info x-pgp-key x-ml-url x-uri x-url x-web))  
   {$DEFAULT{field_type}->{$_} = 'Message::Field::URI'}  
79    
80  ## taken from L<HTTP::Header>  ## taken from L<HTTP::Header>
81  # "Good Practice" order of HTTP message headers:  # "Good Practice" order of HTTP message headers:
# Line 172  my @header_order = qw( Line 107  my @header_order = qw(
107  );  );
108  my %header_order;  my %header_order;
109    
110    =head1 CONSTRUCTORS
111    
112    The following methods construct new C<Message::Header> objects:
113    
114    =over 4
115    
116    =cut
117    
118  sub _init ($;%) {  sub _init ($;%) {
119    my $self = shift;    my $self = shift;
120    my %options = @_;    my %options = @_;
121    $self->{field} = [];    my $DEFAULT = Message::Util::make_clone (\%DEFAULT);
122    $self->{option} = \%DEFAULT;    $self->SUPER::_init (%$DEFAULT, %options);
123      $self->{value} = [];
124      $self->_ns_load_ph ('default');
125      $self->_ns_load_ph ('rfc822');
126      $self->{option}->{ns_default_phuri} = $self->{ns}->{phname2uri}->{'rfc822'}
127        unless $self->{option}->{ns_default_phuri};
128      
129    my @new_fields = ();    my @new_fields = ();
130    for my $name (keys %options) {    for my $name (keys %options) {
131      if (substr ($name, 0, 1) eq '-') {      unless (substr ($name, 0, 1) eq '-') {
       $self->{option}->{substr ($name, 1)} = $options{$name};  
     } else {  
132        push @new_fields, ($name => $options{$name});        push @new_fields, ($name => $options{$name});
133      }      }
134    }    }
135    $self->add (@new_fields, -parse => $self->{option}->{parse_all})    $self->_init_by_format ($self->{option}->{format}, $self->{option});
     if $#new_fields > -1;  
     
   my $format = $self->{option}->{format};  
   if ($format =~ /cgi/) {  
     unshift @header_order, qw(content-type location);  
     $self->{option}->{sort} = 'good-practice';  
     $self->{option}->{fold} = 0;  
   } elsif ($format =~ /^http/) {  
     $self->{option}->{sort} = 'good-practice';  
   }  
     
136    # Make alternative representations of @header_order.  This is used    # Make alternative representations of @header_order.  This is used
137    # for sorting.    # for sorting.
138    my $i = 1;    my $i = 1;
139    for (@header_order) {    for (@header_order) {
140        $header_order{$_} = $i++ unless $header_order{$_};        $header_order{$_} = $i++ unless $header_order{$_};
141    }    }
142      
143      $self->add (@new_fields, -parse => $self->{option}->{parse_all})
144        if $#new_fields > -1;
145    }
146    
147    sub _init_by_format ($$\%) {
148      my $self = shift;
149      my ($format, $option) = @_;
150      if ($format =~ /cgi/) {
151        unshift @header_order, qw(content-type location);
152        $option->{field_sort} = 'good-practice';
153        $option->{use_folding} = 0;
154      } elsif ($format =~ /http/) {
155        $option->{field_sort} = 'good-practice';
156      }
157      if ($format =~ /uri-url-mailto/) {
158        $option->{output_bcc} = 0;
159        $option->{field_format_pattern} = '%s=%s';
160        $option->{output_folding} = sub {
161          $_[1] =~ s/([^:@+\$A-Za-z0-9\-_.!~*])/sprintf('%%%02X', ord $1)/ge;
162          $_[1];
163        };  ## Yes, this is not folding!
164      }
165  }  }
166    
167  =item Message::Header->new ([%initial-fields/options])  =item $msg = Message::Header->new ([%initial-fields/options])
168    
169  Constructs a new C<Message::Headers> object.  You might pass some initial  Constructs a new C<Message::Headers> object.  You might pass some initial
170  C<field-name>-C<field-body> pairs and/or options as parameters to the constructor.  C<field-name>-C<field-body> pairs and/or options as parameters to the constructor.
# Line 221  Example: Line 180  Example:
180    
181  =cut  =cut
182    
183  sub new ($;%) {  ## Inherited
   my $class = shift;  
   my $self = bless {}, $class;  
   $self->_init (@_);  
   $self;  
 }  
184    
185  =item Message::Header->parse ($header, [%initial-fields/options])  =item $msg = Message::Header->parse ($header, [%initial-fields/options])
186    
187  Parses given C<header> and constructs a new C<Message::Headers>  Parses given C<header> and constructs a new C<Message::Headers>
188  object.  You might pass some additional C<field-name>-C<field-body> pairs  object.  You might pass some additional C<field-name>-C<field-body> pairs
# Line 240  sub parse ($$;%) { Line 194  sub parse ($$;%) {
194    my $class = shift;    my $class = shift;
195    my $header = shift;    my $header = shift;
196    my $self = bless {}, $class;    my $self = bless {}, $class;
197    $self->_init (@_);    $self->_init (@_);    ## BUG: don't check linebreak_strict
198    $header =~ s/\x0D?\x0A$REG{WSP}/\x20/gos;     ## unfold    $header =~ s/\x0D?\x0A$REG{WSP}/\x20/gos if $self->{option}->{use_folding};
199    for my $field (split /\x0D?\x0A/, $header) {    for my $field (split /\x0D?\x0A/, $header) {
200      if ($field =~ /$REG{M_fromline}/) {      if ($field =~ /$REG{M_fromline}/) {
201        my $body = $1;        my ($s,undef,$value) = $self->_value_to_arrayitem
202        $body = $self->_field_body ($body, 'mail-from')          ('mail-from' => $1, $self->{option});
203          if $self->{option}->{parse_all};        push @{$self->{value}}, $value if $s;
       push @{$self->{field}}, {name => 'mail-from', body => $body};  
204      } elsif ($field =~ /$REG{M_field}/) {      } elsif ($field =~ /$REG{M_field}/) {
205        my ($name, $body) = (lc $1, $2);        my ($name, $body) = ($1, $2);
       $name =~ s/$REG{WSP}+$//;  
206        $body =~ s/$REG{WSP}+$//;        $body =~ s/$REG{WSP}+$//;
207        $body = $self->_field_body ($body, $name) if $self->{option}->{parse_all};        my ($s,undef,$value) = $self->_value_to_arrayitem
208        push @{$self->{field}}, {name => $name, body => $body};          ($name => $body, $self->{option});
209          push @{$self->{value}}, $value if $s;
210        } elsif (length $field) {
211          my ($s,undef,$value) = $self->_value_to_arrayitem
212            ('x-unknown' => $field, $self->{option});
213          push @{$self->{value}}, $value if $s;
214      }      }
215    }    }
216    $self;    $self;
217  }  }
218    
219  =item Message::Header->parse_array (\@header, [%initial-fields/options])  =item $msg = Message::Header->parse_array (\@header, [%initial-fields/options])
220    
221  Parses given C<header> and constructs a new C<Message::Headers>  Parses given C<header> and constructs a new C<Message::Headers>
222  object.  Same as C<Message::Header-E<lt>parse> but this method  object.  Same as C<Message::Header-E<lt>parse> but this method
# Line 278  sub parse_array ($\@;%) { Line 235  sub parse_array ($\@;%) {
235    $self->_init (@_);    $self->_init (@_);
236    while (1) {    while (1) {
237      my $field = shift @$header;      my $field = shift @$header;
238      while (1) {      if ($self->{option}->{use_folding}) {
239        if ($$header[0] =~ /^$REG{WSP}/) {        while (1) {
240          $field .= shift @$header;          if ($$header[0] =~ /^$REG{WSP}/) {
241        } else {last}            $field .= shift @$header;
242            } else {last}
243          }
244        }
245        if ($self->{option}->{linebreak_strict}) {
246          $field =~ s/\x0D\x0A//g;
247        } else {
248          $field =~ tr/\x0D\x0A//d;
249      }      }
250      $field =~ tr/\x0D\x0A//d;   ## BUG: not safe for bar CR/LF      local $self->{option}->{parse} = $self->{option}->{parse_all};
251      if ($field =~ /$REG{M_fromline}/) {      if ($field =~ /$REG{M_fromline}/) {
252        my $body = $1;        my ($s,undef,$value) = $self->_value_to_arrayitem
253        $body = $self->_field_body ($body, 'mail-from')          ('mail-from' => $1, $self->{option});
254          if $self->{option}->{parse_all};        push @{$self->{value}}, $value if $s;
       push @{$self->{field}}, {name => 'mail-from', body => $body};  
255      } elsif ($field =~ /$REG{M_field}/) {      } elsif ($field =~ /$REG{M_field}/) {
256        my ($name, $body) = (lc $1, $2);        my ($name, $body) = ($self->_n11n_field_name ($1), $2);
       $name =~ s/$REG{WSP}+$//;  
257        $body =~ s/$REG{WSP}+$//;        $body =~ s/$REG{WSP}+$//;
258        $body = $self->_field_body ($body, $name) if $self->{option}->{parse_all};        my ($s,undef,$value) = $self->_value_to_arrayitem
259        push @{$self->{field}}, {name => $name, body => $body};          ($name => $body, $self->{option});
260          push @{$self->{value}}, $value if $s;
261        } elsif (length $field) {
262          my ($s,undef,$value) = $self->_value_to_arrayitem
263            ('x-unknown' => $field, $self->{option});
264          push @{$self->{value}}, $value if $s;
265      }      }
266      last if $#$header < 0;      last if $#$header < 0;
267    }    }
# Line 314  context, only first one is returned.) Line 281  context, only first one is returned.)
281    
282  =cut  =cut
283    
284  sub field ($$) {  sub field ($@) {shift->SUPER::item (@_)}
285    sub field_exist ($@) {shift->SUPER::item_exist (@_)}
286    
287    ## item-by?, \$checked-item, {item-key => 1}, \%option
288    sub _item_match ($$\$\%\%) {
289    my $self = shift;    my $self = shift;
290    my $name = lc shift;    my ($by, $i, $list, $option) = @_;
291    my @ret;    return 0 unless ref $$i;  ## Already removed
292    for my $field (@{$self->{field}}) {    if ($by eq 'name') {
293      if ($field->{name} eq $name) {      my %o = %$option; $o{parse} = 0;
294        unless (wantarray) {      my %l;
295          $field->{body} = $self->_field_body ($field->{body}, $name);      for (keys %$list) {
296          return $field->{body};        my ($s, undef, $v) = $self->_value_to_arrayitem ($_, '', %o);
297          if ($s) {
298            $l{$v->{name} . ':' . ( $option->{ns} || $v->{ns} ) } = 1;
299        } else {        } else {
300          $field->{body} = $self->_field_body ($field->{body}, $name);          $l{$v->{name} .':'. ( $option->{ns} || $self->{option}->{ns_default_phuri} ) } = 1;
         push @ret, $field->{body};  
301        }        }
302      }      }
303    }      return 1 if $l{$$i->{name} . ':' . $$i->{ns}};
304    if ($#ret < 0) {    } elsif ($by eq 'ns') {
305      return $self->add ($name);      return 1 if $list->{ $$i->{ns} };
   }  
   @ret;  
 }  
   
 sub field_exist ($$) {  
   my $self = shift;  
   my $name = lc shift;  
   my @ret;  
   for my $field (@{$self->{field}}) {  
     return 1 if ($field->{name} eq $name);  
306    }    }
307    0;    0;
308  }  }
309    *_delete_match = \&_item_match;
310    
311  =head2 $self->field_name ($index)  ## Returns returned item value    \$item-value, \%option
312    sub _item_return_value ($\$\%) {
313  Returns C<field-name> of $index'th C<field>.    if (ref ${$_[1]}->{body}) {
314        ${$_[1]}->{body};
315  =head2 $self->field_body ($index)    } else {
316        ${$_[1]}->{body} = $_[0]->_parse_value (${$_[1]}->{name} => ${$_[1]}->{body},
317          ns => ${$_[1]}->{ns});
318        ${$_[1]}->{body};
319      }
320    }
321    *_add_return_value = \&_item_return_value;
322    *_replace_return_value = \&_item_return_value;
323    
324    ## Returns returned (new created) item value    $name, \%option
325    sub _item_new_value ($$\%) {
326        my ($s,undef,$value) = $_[0]->_value_to_arrayitem
327            ($_[1] => '', $_[2]);
328        $s? $value: undef;
329    }
330    
 Returns C<field-body> of $index'th C<field>.  
331    
 =cut  
332    
333  sub field_name ($$) {  ## $self->_parse_value ($type, $value, %options);
334    my $self = shift;  sub _parse_value ($$$;%) {
335    $self->{field}->[shift]->{name};    my $self = shift;
336  }    my $name = shift ;#|| $self->{option}->{_VALTYPE_DEFAULT};
337  sub field_body ($$) {    my $value = shift;  return $value if ref $value;
338    my $self = shift;    my %option = @_;
339    my $i = shift;    my $vtype; { no strict 'refs';
340    $self->{field}->[$i]->{body}      my $vt = ${&_NS_uri2phpackage ($option{ns}).'::OPTION'}{value_type};
341     = $self->_field_body ($self->{field}->[$i]->{body}, $self->{field}->[$i]->{name});      if (ref $vt) {
342    $self->{field}->[$i]->{body};        $vtype = $vt->{$name} || $vt->{$self->{option}->{_VALTYPE_DEFAULT}};
343  }      }
344        ## For compatiblity.
345  sub _field_body ($$$) {      unless (ref $vtype) { $vtype = $self->{option}->{value_type}->{$name}
346    my $self = shift;        || $self->{option}->{value_type}->{$self->{option}->{_VALTYPE_DEFAULT}} }
347    my ($body, $name) = @_;    }
348    unless (ref $body) {    my $vpackage = $vtype->[0];
349      my $type = $self->{option}->{field_type}->{$name}    my %vopt = %{$vtype->[1]} if ref $vtype->[1];
350              || $self->{option}->{field_type}->{':DEFAULT'};    if ($vpackage eq ':none:') {
351      eval "require $type" or Carp::croak ("_field_body: $type: $@");      return $value;
352      unless ($body) {    } elsif (defined $value) {
353        $body = $type->new (-field_name => $name,      eval "require $vpackage" or Carp::croak qq{<parse>: $vpackage: Can't load package: $@};
354          -format => $self->{option}->{format}      return $vpackage->parse ($value,
355          , field_name => $name, format => $self->{option}->{format});        -format   => $self->{option}->{format},
356      } else {        -field_ns => $option{ns},
357        $body = $type->parse ($body, -field_name => $name,        -field_name       => $name,
358          -format => $self->{option}->{format},        -parse_all        => $self->{option}->{parse_all},
359           field_name => $name,format => $self->{option}->{format});      %vopt);
360      }    } else {
361        eval "require $vpackage" or Carp::croak qq{<parse>: $vpackage: Can't load package: $@};
362        return $vpackage->new (
363          -format   => $self->{option}->{format},
364          -field_ns => $option{ns},
365          -field_name       => $name,
366          -parse_all        => $self->{option}->{parse_all},
367        %vopt);
368    }    }
   $body;  
369  }  }
370    
371  =head2 $self->field_name_list ()  =head2 $self->field_name_list ()
# Line 397  returns ALL names.) Line 378  returns ALL names.)
378    
379  sub field_name_list ($) {  sub field_name_list ($) {
380    my $self = shift;    my $self = shift;
381    $self->_delete_empty_field ();    $self->_delete_empty ();
382    map {$_->{name}} @{$self->{field}};    map { $_->{name} . ':' . $_->{ns} } @{$self->{value}};
383    }
384    
385    sub namespace_ph_default ($;$) {
386      my $self = shift;
387      if (defined $_[0]) {
388        no strict 'refs';
389        $self->{option}->{ns_default_phuri} = $_[0];
390        $self->_ns_load_ph (${&_NS_uri2phpackage ($self->{option}->{ns_default_phuri}).'::OPTION'}{namespace_phname});
391      }
392      $self->{option}->{ns_default_phuri};
393  }  }
394    
395  =item $hdr->add ($field-name, $field-body, [$name, $body, ...])  =item $hdr->add ($field-name, $field-body, [$name, $body, ...])
# Line 424  C<-validate>: Checks whether C<field-nam Line 415  C<-validate>: Checks whether C<field-nam
415    
416  =cut  =cut
417    
418  sub add ($%) {  ## [Name: Value] pair -> internal array item
419    my $self = shift;  ## $self->_value_to_arrayitem ($name => $value, {%options})
420    my %fields = @_;  ## or
421    my %option = %{$self->{option}};  ## $self->_value_to_arrayitem ($name => [$value, %value_options], {%options})
422    $option{parse} = defined wantarray unless defined $option{parse};  ##
423    for (grep {/^-/} keys %fields) {$option{substr ($_, 1)} = $fields{$_}}  ## Return: ((1 = success / 0 = failue), $full_name, $arrayitem)
424    my $body;  sub _value_to_arrayitem ($$$\%) {
425    for (grep {/^[^-]/} keys %fields) {    my $self = shift;
426      my $name = lc $_;  $body = $fields{$_};    my ($name, $value, $option) = @_;
427      $name =~ tr/_/-/ if $option{translate_underscore};    my $value_option = {};
428      Carp::croak "add: $name: invalid field-name"    if (ref $value eq 'ARRAY') {
429        if $option{validate} && $name =~ /$REG{UNSAFE_field_name}/;      ($value, %$value_option) = @$value;
     $body = $self->_field_body ($body, $name) if $option{parse};  
     if ($option{prepend}) {  
       unshift @{$self->{field}}, {name => $name, body => $body};  
     } else {  
       push @{$self->{field}}, {name => $name, body => $body};  
     }  
430    }    }
431    $body if $option{parse};    my $nsuri = $self->{option}->{ns_default_phuri};
432      
433      no strict 'refs';
434      if ($value_option->{ns}) {
435        $nsuri = $value_option->{ns};
436      } elsif ($option->{ns}) {
437        $nsuri = $option->{ns};
438      } elsif ($name =~ s/^([Xx]-[A-Za-z]+|[A-Za-z]+)-//) {
439        my $oprefix = $1;
440        my $prefix
441          = &{${&_NS_uri2phpackage ($nsuri).'::OPTION'}{n11n_prefix}}
442            ($self, &_NS_uri2phpackage ($nsuri), $oprefix);
443        $self->_ns_load_ph ($prefix);
444        $nsuri = $self->{ns}->{phname2uri}->{$prefix};
445        unless ($nsuri) {
446          $name = $oprefix . '-' . $name;
447          $nsuri = $self->{option}->{ns_default_phuri};
448        }
449      }
450      $name
451        = &{${&_NS_uri2phpackage ($nsuri).'::OPTION'}{n11n_name}}
452          ($self, &_NS_uri2phpackage ($nsuri), $name);
453      Carp::croak "$name: invalid field-name"
454        if $option->{field_name_validation}
455          && $name =~ /$REG{$option->{field_name_unsafe_rule}}/;
456      $value = $self->_parse_value ($name => $value, ns => $nsuri)
457        if $$option{parse} || $$option{parse_all};
458      $$option{parse} = 0;
459      (1, $name.':'.$nsuri => {name => $name, body => $value, ns => $nsuri});
460  }  }
461    *_add_hash_check = \&_value_to_arrayitem;
462    *_replace_hash_check = \&_value_to_arrayitem;
463    
464  =head2 $self->relace ($field_name, $field_body)  =head2 $self->relace ($field_name, $field_body)
465    
# Line 456  first one is used and the others are not Line 471  first one is used and the others are not
471    
472  =cut  =cut
473    
474  sub replace ($%) {  sub _replace_hash_shift ($\%$\%) {
475    my $self = shift;    shift; my $r = shift;  my $n = $_[0]->{name} . ':' . $_[0]->{ns};
476    my %params = @_;    if ($$r{$n}) {
477    my %option = %{$self->{option}};      my $d = $$r{$n};
478    $option{parse} = defined wantarray unless defined $option{parse};      delete $$r{$n};
479    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}      return $d;
   my (%new_field);  
   for (grep {/^[^-]/} keys %params) {  
     my $name = lc $_;  
     $name =~ tr/_/-/ if $option{translate_underscore};  
     Carp::croak "replace: $name: invalid field-name"  
       if $option{validate} && $name =~ /$REG{UNSAFE_field_name}/;  
     $params{$_} = $self->_field_body ($params{$_}, $name) if $option{parse};  
     $new_field{$name} = $params{$_};  
   }  
   my $body = (%new_field)[-1];  
   for my $field (@{$self->{field}}) {  
     if (defined $new_field{$field->{name}}) {  
       $field->{body} = $new_field {$field->{name}};  
       $new_field{$field->{name}} = undef;  
     }  
480    }    }
481    for (keys %new_field) {    undef;
     push @{$self->{field}}, {name => $_, body => $new_field{$_}};  
   }  
   $body if $option{parse};  
482  }  }
483    
484  =head2 $self->delete ($field-name, [$name, ...])  =head2 $self->delete ($field-name, [$name, ...])
# Line 490  Deletes C<field> named as $field_name. Line 487  Deletes C<field> named as $field_name.
487    
488  =cut  =cut
489    
 sub delete ($@) {  
   my $self = shift;  
   my %delete;  for (@_) {$delete{lc $_} = 1}  
   for my $field (@{$self->{field}}) {  
     undef $field if $delete{$field->{name}};  
   }  
 }  
490    
491  =head2 $self->count ([$field_name])  =head2 $self->count ([$field_name])
492    
# Line 506  of fields.  (Same as $#$self+1) Line 496  of fields.  (Same as $#$self+1)
496    
497  =cut  =cut
498    
499  sub count ($;$) {  sub _count_by_name ($$\%) {
500    my $self = shift;    my $self = shift;
501    my ($name) = (lc shift);    my ($array, $option) = @_;
502    unless ($name) {    my $name = $self->_n11n_field_name ($$option{-name});
503      $self->_delete_empty_field ();    my @a = grep {$_->{name} eq $name} @{$self->{$array}};
504      return $#{$self->{field}}+1;    $#a + 1;
505    }  }
506    my $count = 0;  
507    for my $field (@{$self->{field}}) {  ## Delete empty items
508      if ($field->{name} eq $name) {  sub _delete_empty ($) {
509        $count++;    my $self = shift;
510      }    my $array = $self->{option}->{_HASH_NAME};
511    }    $self->{$array} = [grep {ref $_ && length $_->{name}} @{$self->{$array}}];
   $count;  
512  }  }
513    
514  =head2 $self->rename ($field-name, $new-name, [$old, $new,...])  =head2 $self->rename ($field-name, $new-name, [$old, $new,...])
# Line 535  sub rename ($%) { Line 524  sub rename ($%) {
524    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}
525    my %new_name;    my %new_name;
526    for (grep {/^[^-]/} keys %params) {    for (grep {/^[^-]/} keys %params) {
527      my ($old => $new) = (lc $_ => lc $params{$_});      my ($old => $new)
528          = ($self->_n11n_field_name ($_) => $self->_n11n_field_name ($params{$_}));
529        $old =~ tr/_/-/ if $option{translate_underscore};
530      $new =~ tr/_/-/ if $option{translate_underscore};      $new =~ tr/_/-/ if $option{translate_underscore};
531      Carp::croak "rename: $new: invalid field-name"      Carp::croak "rename: $new: invalid field-name"
532        if $option{validate} && $new =~ /$REG{UNSAFE_field_name}/;        if $option{field_name_validation}
533            && $new =~ /$REG{$option{field_name_unsafe_rule}}/;
534      $new_name{$old} = $new;      $new_name{$old} = $new;
535    }    }
536    for my $field (@{$self->{field}}) {    for my $field (@{$self->{value}}) {
537      if (length $new_name{$field->{name}}) {      if (length $new_name{$field->{name}}) {
538        $field->{name} = $new_name{$field->{name}};        $field->{name} = $new_name{$field->{name}};
539      }      }
# Line 559  for each value. Line 551  for each value.
551    
552  =cut  =cut
553    
554  sub scan ($&) {  sub _scan_sort ($\@\%) {
555    my ($self, $sub) = @_;    my $self = shift;
556      my ($array, $option) = @_;
557    my $sort;    my $sort;
558    $sort = \&_header_cmp if $self->{option}->{sort} eq 'good-practice';    $sort = \&_header_cmp if $option->{field_sort} eq 'good-practice';
559    $sort = {$a cmp $b} if $self->{option}->{sort} eq 'alphabetic';    $sort = {$a cmp $b} if $option->{field_sort} eq 'alphabetic';
560    my @field = @{$self->{field}};    return ( sort $sort @$array ) if ref $sort;
561    if (ref $sort) {    @$array;
562      @field = sort $sort @{$self->{field}};  }
563    }  
564    for my $field (@field) {  sub _n11n_field_name ($$) {
565      next if $field->{name} =~ /^_/;    my $self = shift;
566      &$sub($field->{name} => $field->{body});    my $s = shift;
567    }    $s =~ s/^$REG{WSP}+//; $s =~ s/$REG{WSP}+$//;
568      $s = lc $s unless ${&_NS_uri2phpackage ($self->{option}->{ns_default_phuri}).'::OPTION'}{case_sensible};
569      $s;
570  }  }
571    
572  # Compare function which makes it easy to sort headers in the  # Compare function which makes it easy to sort headers in the
# Line 599  sub stringify ($;%) { Line 594  sub stringify ($;%) {
594    my $self = shift;    my $self = shift;
595    my %params = @_;    my %params = @_;
596    my %option = %{$self->{option}};    my %option = %{$self->{option}};
597      $option{format} = $params{-format} if $params{-format};
598      $self->_init_by_format ($option{format}, \%option);
599    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}
600    my @ret;    my @ret;
601    if ($option{mail_from}) {    my $_stringify = sub {
602      my $fromline = $self->field ('mail-from');      no strict 'refs';
603      push @ret, 'From '.$fromline if $fromline;        my ($name, $body, $nsuri) = ($_[1]->{name}, $_[1]->{body}, $_[1]->{ns});
604    }        return unless length $name;
605    $self->scan (sub {        return if $option{output_mail_from} && $name eq 'mail-from';
606      my ($name, $body) = (@_);        return if !$option{output_bcc} && ($name eq 'bcc' || $name eq 'resent-bcc');
607      return unless length $name;        my $nspackage = &_NS_uri2phpackage ($nsuri);
608      return if $option{mail_from} && $name eq 'mail-from';        my $oname;        ## Outputed field-name
609      return if !$option{output_bcc} && ($name eq 'bcc' || $name eq 'resent-bcc');        my $prefix = ${$nspackage.'::OPTION'} {namespace_phname_goodcase}
610      my $fbody;                  || $self->{ns}->{uri2phname}->{$nsuri};
611      if (ref $body) {        $prefix = undef if $nsuri eq $self->{option}->{ns_default_phuri};
612        $fbody = $body->stringify (-format => $option{format});        my $gc = ${$nspackage.'::OPTION'} {to_be_goodcase};
613          if (ref $gc) { $oname = &$gc ($self, $nspackage, $name, \%option) }
614          else { $oname = $name }
615          if ($prefix) { $oname = $prefix . '-' . $oname }
616          if ($option{format} =~ /uri-url-mailto/) {
617            return if (( ${$nspackage.'::OPTION'} {uri_mailto_safe}->{$name}
618                      || ${$nspackage.'::OPTION'} {uri_mailto_safe}->{':default'})
619                      < $option{uri_mailto_safe_level});
620            if ($name eq 'to') {
621              $body = $self->field ('to', -new_item_unless_exist => 0);
622              if (ref $body && $body->have_group) {
623                #
624              } elsif (ref $body && $body->count > 1) {
625                $body = $body->clone;
626                $body->delete ({-by => 'index'}, 0);
627              }
628            }
629          }
630          my $fbody;
631          if (ref $body) {
632            $fbody = $body->stringify (-format => $option{format});
633          } else {
634            $fbody = $body;
635          }
636          return unless length $fbody;
637          unless ($option{linebreak_strict}) {
638            ## bare \x0D and bare \x0A are unsafe
639            $fbody =~ s/\x0D(?=[^\x09\x0A\x20])/\x0D\x20/g;
640            $fbody =~ s/\x0A(?=[^\x09\x20])/\x0A\x20/g;
641          } else {
642            $fbody =~ s/\x0D\x0A(?=[^\x09\x20])/\x0D\x0A\x20/g;
643          }
644          if ($option{use_folding}) {
645            if (ref $option{output_folding}) {
646              $fbody = &{$option{output_folding}} ($self, $fbody,
647                -initial_length => length ($oname) +2);
648            } elsif ($option{output_folding}) {
649              $fbody = $self->_fold ($fbody, -initial_length => length ($oname) +2);
650            }
651          }
652          push @ret, sprintf $option{field_format_pattern}, $oname, $fbody;
653        };
654      if ($option{format} =~ /uri-url-mailto/) {
655        if ($option{format} =~ /uri-url-mailto-to/) {
656          my $to = $self->field ('to', -new_item_unless_exist => 0);
657          if ($to) {
658            unless ($to->have_group) {
659              my $fbody = $to->stringify (-format => $option{format}, -max => 1);
660              return &{$option{output_folding}} ($self, $fbody);
661            }
662          }
663          '';
664        } elsif ($option{format} =~ /uri-url-mailto-rfc1738/) {
665          my $to = $self->field ('to', -new_item_unless_exist => 0);
666          if ($to) {
667            my $fbody = $to->addr_spec (-format => $option{format});
668            return &{$option{output_folding}} ($self, $fbody);
669          }
670          '';
671      } else {      } else {
672        $fbody = $body;        $self->scan ($_stringify);
673      }        my $ret = join ('&', @ret);
674      return unless length $fbody;        $ret;
675      $fbody =~ s/\x0D(?=[^\x09\x0A\x20])/\x0D\x20/g;      }
676      $fbody =~ s/\x0A(?=[^\x09\x20])/\x0A\x20/g;    } else {
677      $name =~ s/((?:^|-)[a-z])/uc($1)/ge if $option{capitalize};      if ($option{output_mail_from}) {
678      $fbody = $self->_fold ($fbody) if $self->{option}->{fold};        my $fromline = $self->field ('mail-from', -new_item_unless_exist => 0);
679      push @ret, sprintf $self->{option}->{field_format_pattern}, $name, $fbody;        push @ret, 'From '.$fromline if $fromline;
680    });      }
681    my $ret = join ("\n", @ret);      $self->scan ($_stringify);
682    $ret? $ret."\n": '';      my $ret = join ("\x0D\x0A", @ret);
683        $ret? $ret."\x0D\x0A": '';
684      }
685  }  }
686  *as_string = \&stringify;  *as_string = \&stringify;
687    
# Line 640  sub option ($@) { Line 697  sub option ($@) {
697      return $self->{option}->{ shift (@_) };      return $self->{option}->{ shift (@_) };
698    }    }
699    while (my ($name, $value) = splice (@_, 0, 2)) {    while (my ($name, $value) = splice (@_, 0, 2)) {
     $name =~ s/^-//;  
700      $self->{option}->{$name} = $value;      $self->{option}->{$name} = $value;
701      if ($name eq 'format') {      if ($name eq 'format') {
702        for my $f (@{$self->{field}}) {        for my $f (@{$self->{field}}) {
# Line 652  sub option ($@) { Line 708  sub option ($@) {
708    }    }
709  }  }
710    
711  sub field_type ($$;$) {  sub field_type ($@) {shift->SUPER::value_type (@_)}
712    
713    ## $self->_fold ($string, %option = (-max, -initial_length(for field-name)) )
714    sub _fold ($$;%) {
715    my $self = shift;    my $self = shift;
716    my $field_name = shift;    my $string = shift;
717    my $new_field_type = shift;    my %option = @_;
718    if ($new_field_type) {    my $max = $self->{option}->{line_length_max};
719      $self->{option}->{field_type}->{$field_name} = $new_field_type;    $max = 20 if $max < 20;
720    }    
721    $self->{option}->{field_type}->{$field_name}    my $l = $option{-initial_length} || 0;
722    || $self->{option}->{field_type}->{':DEFAULT'};    $string =~ s{((?:^|[\x09\x20])[^\x09\x20]+)}{
723        my $s = $1;
724        if ($l + length $s > $max) {
725          $s = "\x0D\x0A\x20" . $s;
726          $l = length ($s) - 2;
727        } else { $l += length $s }
728        $s;
729      }gex;
730      $string;
731  }  }
732    
733  sub _delete_empty_field ($) {  sub _ns_load_ph ($$) {
734    my $self = shift;    my $self = shift;
735    my @ret;    my $name = shift;     ## normalized prefix (without HYPHEN-MINUS)
736    for my $field (@{$self->{field}}) {    return if $self->{ns}->{phname2uri}->{$name};
737      push @ret, $field if $field->{name};    $self->{ns}->{phname2uri}->{$name} = $NS_phname2uri{$name};
738    }    return unless $self->{ns}->{phname2uri}->{$name};
739    $self->{field} = \@ret;    $self->{ns}->{uri2phname}->{$self->{ns}->{phname2uri}->{$name}} = $name;
   $self;  
740  }  }
741    
742  sub _fold ($$;$) {  sub _NS_uri2phpackage ($) {
743    my $self = shift;    $NS_uri2phpackage{$_[0]}
744    my $string = shift;    || $NS_uri2phpackage{$Message::Header::Default::OPTION{namespace_uri}};
   my $len = shift || $self->{option}->{fold_length};  
   $len = 60 if $len < 60;  
     
   ## This code is taken from Mail::Header 1.43 in MailTools,  
   ## by Graham Barr (Maintained by Mark Overmeer <mailtools@overmeer.net>).  
   my $max = int($len - 5);         # 4 for leading spcs + 1 for [\,\;]  
   my $min = int($len * 4 / 5) - 4;  
   my $ml = $len;  
     
   if (length($string) > $ml) {  
      #Split the line up  
      # first bias towards splitting at a , or a ; >4/5 along the line  
      # next split a whitespace  
      # else we are looking at a single word and probably don't want to split  
      my $x = "";  
      $x .= "$1\n "  
        while($string =~ s/^$REG{WSP}*(  
                           [^"]{$min,$max}?[\,\;]  
                           |[^"]{1,$max}$REG{WSP}  
                           |[^\s"]*(?:"[^"]*"[^\s"]*)+$REG{WSP}  
                           |[^\s"]+$REG{WSP}  
                           )  
                         //x);  
      $x .= $string;  
      $string = $x;  
      $string =~ s/(\A$REG{WSP}+|$REG{WSP}+\Z)//sog;  
      $string =~ s/\s+\n/\n/sog;  
   }  
   $string;  
745  }  }
746    
747  =head2 $self->clone ()  =head2 $self->clone ()
# Line 713  Returns a copy of Message::Header object Line 750  Returns a copy of Message::Header object
750    
751  =cut  =cut
752    
753  sub clone ($) {  ## Inhreited
   my $self = shift;  
   my $clone = new Message::Header;  
   for my $name (%{$self->{option}}) {  
     if (ref $self->{option}->{$name} eq 'HASH') {  
       $clone->{option}->{$name} = {%{$self->{option}->{$name}}};  
     } elsif (ref $self->{option}->{$name} eq 'ARRAY') {  
       $clone->{option}->{$name} = [@{$self->{option}->{$name}}];  
     } else {  
       $clone->{option}->{$name} = $self->{option}->{$name};  
     }  
   }  
   for (@{$self->{field}}) {  
     $clone->add ($_->{name}, scalar $_->{body});  
   }  
   $clone;  
 }  
754    
755  =head1 NOTE  =head1 NOTE
756    
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.26
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24