/[suikacvs]/test/cvs
Suika

Diff of /test/cvs

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

revision 1.14 by wakaba, Wed Apr 3 13:31:36 2002 UTC revision 1.20 by wakaba, Sat May 25 09:53:24 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    %REG = %Message::Util::REG;
16  $REG{WSP}     = qr/[\x09\x20]/;          $REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/;
17  $REG{FWS}     = qr/[\x09\x20]*/;          $REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/;
18  $REG{M_field} = qr/^([^\x3A]+):$REG{FWS}([\x00-\xFF]*)$/;          $REG{ftext} = qr/[\x21-\x39\x3B-\x7E]+/;        ## [2]822
19  $REG{M_fromline} = qr/^\x3E?From$REG{WSP}+([\x00-\xFF]*)$/;          $REG{NON_ftext} = qr/[^\x21-\x39\x3B-\x7E]/;    ## [2]822
20  $REG{UNSAFE_field_name} = qr/[\x00-\x20\x3A\x7F-\xFF]/;          $REG{NON_ftext_usefor} = qr/[^0-9A-Za-z-]/;     ## name-character
21            $REG{NON_ftext_http} = $REG{NON_http_token};
22  =head2 options  
23    ## Namespace support
24  These options can be getten/set by C<get_option>/C<set_option>          our %NS_phname2uri;     ## PH-namespace name -> namespace URI
25  method.          our %NS_uri2phpackage;  ## namespace URI -> PH-package name
26            require Message::Header::Default;       ## Default namespace
27  =head3 capitalize = 0/1  
28    ## Initialize of this class -- called by constructors
29  (First character of) C<field-name> is capitalized  %DEFAULT = (
30  when C<stringify>.  (Default = 1)      -_HASH_NAME => 'value',
31        -_METHODS   => [qw|field field_exist field_type add replace count delete subject id is|],
32  =head3 fold_length = numeric value      -_MEMBERS   => [qw|value|],
33        -M_namsepace_prefix_regex => qr/(?!)/,
34  Length of line used to fold.  (Default = 70)      -_VALTYPE_DEFAULT   => ':default',
35        -by => 'name',      ## (Reserved for method level option)
36  =head3 mail_from = 0/1      -field_format_pattern       => '%s: %s',
37        -field_name_capitalize      => 1,
38  Outputs "From " line (known as Un*x From, Mail-From, and so on)      -field_name_case_sensible   => 0,
39  when C<stringify>.  (Default = 0)      -field_name_unsafe_rule     => 'NON_ftext',
40        -field_name_validation      => 1,   ## Method level option.
41  =cut      -field_sort => 0,
42        #-format    => 'mail-rfc2822',
43  my %DEFAULT = (      -linebreak_strict   => 0,   ## Not implemented completely
44    capitalize    => 1,      -line_length_max    => 60,  ## For folding
45    fold_length   => 70,      -ns_default_uri     => $Message::Header::Default::OPTION{namespace_uri},
46    #field_type   => {},      -output_bcc => 0,
47    format        => 'mail-rfc2822',      -output_folding     => 1,
48    mail_from     => 0,      -output_mail_from   => 0,
49    output_bcc    => 0,      #-parse_all => 0,
50    parse_all     => 0,      -translate_underscore       => 1,
51    sort  => 'none',      #-uri_mailto_safe
52    translate_underscore  => 1,      -uri_mailto_safe_level      => 4,
53    validate      => 1,      -use_folding        => 1,
54        #-value_type
55  );  );
56  $DEFAULT{field_type} = {    $DEFAULT{-uri_mailto_safe}    = {
57          ':DEFAULT'      => 'Message::Field::Unstructured',          ## 1 all (no check)     2 no trace & bcc & from
58            ## 3 no sender's info   4 (default) (currently not used)
59            ## 5 only a few
60            ':default'      => 4,
61            'cc'    => 5,
62            'bcc'   => 1,
63            'body'  => 1,
64            'comment'       => 5,
65            'content-id'    => 1,
66            'date'  => 1,
67            'from'  => 1,
68            'keywords'      => 5,
69            'list-id'       => 1,
70            'mail-from'     => 1,
71            'message-id'    => 1,
72            'received'      => 1,
73            'resent-bcc'    => 1,
74            'resent-date'   => 1,
75            'resent-from'   => 1,
76            'resent-sender' => 1,
77            'return-path'   => 1,
78            'sender'        => 1,
79            'subject'       => 5,
80            'summary'       => 5,
81            'to'    => 5,
82            'user-agent'    => 3,
83            'x-face'        => 2,
84            'x-mailer'      => 3,
85            'x-nsubject'    => 5,
86            'x-received'    => 1,
87            'x400-received' => 1,
88            };
89    
90    $DEFAULT{-value_type} = {
91            ':default'      => ['Message::Field::Unstructured'],
92            
93            received        => ['Message::Field::Received'],
94            'x-received'    => ['Message::Field::Received'],
95                    
96          received        => 'Message::Field::Received',          p3p     => ['Message::Field::Params'],
97          'x-received'    => 'Message::Field::Received',          'auto-submitted'        => ['Message::Field::ValueParams'],
98            link    => ['Message::Field::ValueParams'],
99            archive => ['Message::Field::ValueParams'],
100            'x-face-type'   => ['Message::Field::ValueParams'],
101            'x-mozilla-draft-info'  => ['Message::Field::ValueParams'],
102                    
103          'content-type'  => 'Message::Field::ContentType',          subject => ['Message::Field::Subject'],
104          'content-disposition'   => 'Message::Field::ContentDisposition',          'x-nsubject'    => ['Message::Field::Subject'],
         link    => 'Message::Field::ValueParams',  
         archive => 'Message::Field::ValueParams',  
         'x-face-type'   => 'Message::Field::ValueParams',  
105                    
106          subject => 'Message::Field::Subject',          'list-software' => ['Message::Field::UA'],
107          'x-nsubject'    => 'Message::Field::Subject',          'user-agent'    => ['Message::Field::UA'],
108            'resent-user-agent'     => ['Message::Field::UA'],
109            server  => ['Message::Field::UA'],
110                    
111          'list-software' => 'Message::Field::UA',          ## A message id
112          'user-agent'    => 'Message::Field::UA',          'message-id'    => ['Message::Field::MsgID'],
113          server  => 'Message::Field::UA',          'resent-message-id'     => ['Message::Field::MsgID'],
114                    
115          'content-length'        => 'Message::Field::Numval',          ## Numeric value
116          lines   => 'Message::Field::Numval',          lines   => ['Message::Field::Numval'],
117          'max-forwards'  => 'Message::Field::Numval',          'max-forwards'  => ['Message::Field::Numval'],
118          'mime-version'  => 'Message::Field::Numval',          'mime-version'  => ['Message::Field::Numval'],
119            'x-jsmail-priority'     => ['Message::Field::Numval'],
120            'x-mail-count'  => ['Message::Field::Numval'],
121            'x-ml-count'    => ['Message::Field::Numval'],
122            'x-priority'    => ['Message::Field::Numval'],
123                    
124          path    => 'Message::Field::Path',          path    => ['Message::Field::Path'],
125  };  };
126  for (qw(cancel-lock importance   precedence list-id  for (qw(archive cancel-lock
127    x-face x-mail-count x-msmail-priority x-priority xref))    disposition-notification-options encoding
128    {$DEFAULT{field_type}->{$_} = 'Message::Field::Structured'}    importance injector-info
129  for (qw(approved bcc cc delivered-to disposition-notification-to envelope-to    pics-label posted-and-mailed precedence list-id message-type
130    errors-to fcc from mail-followup-to mail-followup-cc reply-to resent-bcc    original-recipient priority x-list-id
131      sensitivity status x-face x-msmail-priority xref))
132      {$DEFAULT{-value_type}->{$_} = ['Message::Field::Structured']}
133            ## Not supported yet, but to be supported...
134            # x-list: unstructured, ml name
135    for (qw(abuse-reports-to apparently-to approved approved-by bcc cc complaints-to
136      delivered-to disposition-notification-to envelope-to
137      errors-to  from mail-copies-to mail-followup-to mail-reply-to
138      notice-requested-upon-delivery-to read-receipt-to register-mail-reply-requested-by
139      reply-to resent-bcc
140    resent-cc resent-to resent-from resent-sender return-path    resent-cc resent-to resent-from resent-sender return-path
141    return-receipt-to sender to x-approved x-beenthere    return-receipt-to return-receipt-requested-to sender to x-abuse-reports-to
142      x-admin x-approved x-beenthere x-confirm-reading-to
143    x-complaints-to x-envelope-from x-envelope-sender    x-complaints-to x-envelope-from x-envelope-sender
144    x-envelope-to x-ml-address x-ml-command x-ml-to x-nfrom x-nto))    x-envelope-to x-ml-address x-ml-command x-ml-to x-nfrom x-nto
145    {$DEFAULT{field_type}->{$_} = 'Message::Field::Address'}    x-rcpt-to x-sender x-x-sender))
146  for (qw(date date-received delivery-date expires    {$DEFAULT{-value_type}->{$_} = ['Message::Field::Addresses']}
147    expire-date nntp-posting-date posted reply-by resent-date x-tcup-date))  for (qw(client-date date date-received delivery-date expires
148    {$DEFAULT{field_type}->{$_} = 'Message::Field::Date'}    expire-date nntp-posting-date posted posted-date received-date
149  for (qw(article-updates client-date content-id in-reply-to message-id    reply-by resent-date
150    references resent-message-id see-also supersedes))    x-originalarrivaltime x-tcup-date))
151    {$DEFAULT{field_type}->{$_} = 'Message::Field::MsgID'}    {$DEFAULT{-value_type}->{$_} = ['Message::Field::Date']}
152    for (qw(article-updates in-reply-to
153      obsoletes references replaces see-also supersedes))
154      {$DEFAULT{-value_type}->{$_} = ['Message::Field::MsgIDs']}
155  for (qw(accept accept-charset accept-encoding accept-language  for (qw(accept accept-charset accept-encoding accept-language
156    content-language    content-language
157    content-transfer-encoding encrypted followup-to keywords    encrypted followup-to keywords
158    list-archive list-digest list-help list-owner    list-archive list-digest list-help list-owner
159    list-post list-subscribe list-unsubscribe list-url uri newsgroups    list-post list-subscribe list-unsubscribe list-url uri newsgroups
160    x-brother x-daughter x-respect x-moe x-syster x-wife))    posted-to))
161    {$DEFAULT{field_type}->{$_} = 'Message::Field::CSV'}    {$DEFAULT{-value_type}->{$_} = ['Message::Field::CSV']}
162  for (qw(content-alias content-base content-location location referer  for (qw(x-brother x-boss x-classmate x-daughter x-dearfriend x-favoritesong
163    url x-home-page x-http_referer    x-friend x-me
164      x-moe x-respect
165      x-sublimate x-son x-sister x-wife))
166      {$DEFAULT{-value_type}->{$_} =[ 'Message::Field::CSV']}       ## NOT M::F::XMOE!
167    for (qw(location referer url x-home-page x-http_referer
168    x-info x-pgp-key x-ml-url x-uri x-url x-web))    x-info x-pgp-key x-ml-url x-uri x-url x-web))
169    {$DEFAULT{field_type}->{$_} = 'Message::Field::URI'}    {$DEFAULT{-value_type}->{$_} = ['Message::Field::URI']}
170    
171    my %header_goodcase = (
172            'article-i.d.'  => 'Article-I.D.',
173            etag    => 'ETag',
174            'pics-label'    => 'PICS-Label',
175            te      => 'TE',
176            url     => 'URL',
177            'www-authenticate'      => 'WWW-Authenticate',
178    );
179    $DEFAULT{-field_name_capitalize} = sub {
180      my $self = shift;
181      my $name = shift;
182      if ($header_goodcase{$name}) {
183        return $header_goodcase{$name};
184      }
185      $name =~ s/(?:^|-)cgi-/uc $&/ge;
186      $name =~ s/(?:^|-)[a-z]/uc $&/ge;
187      $name;
188    };
189    
190  ## taken from L<HTTP::Header>  ## taken from L<HTTP::Header>
191  # "Good Practice" order of HTTP message headers:  # "Good Practice" order of HTTP message headers:
# Line 140  my @header_order = qw( Line 217  my @header_order = qw(
217  );  );
218  my %header_order;  my %header_order;
219    
220    =head1 CONSTRUCTORS
221    
222    The following methods construct new C<Message::Header> objects:
223    
224    =over 4
225    
226    =cut
227    
228  sub _init ($;%) {  sub _init ($;%) {
229    my $self = shift;    my $self = shift;
230    my %options = @_;    my %options = @_;
231    $self->{field} = [];    my $DEFAULT = Message::Util::make_clone (\%DEFAULT);
232    $self->{option} = \%DEFAULT;    $self->SUPER::_init (%$DEFAULT, %options);
233      $self->{value} = [];
234      $self->_ns_load_ph ('default');
235      $self->{ns}->{default_phuri} = $self->{ns}->{phname2uri}->{'default'};
236      $self->_ns_load_ph ('rfc822');
237      $self->{ns}->{default_phuri} = $self->{ns}->{phname2uri}->{'rfc822'};
238      
239    my @new_fields = ();    my @new_fields = ();
240    for my $name (keys %options) {    for my $name (keys %options) {
241      if (substr ($name, 0, 1) eq '-') {      unless (substr ($name, 0, 1) eq '-') {
       $self->{option}->{substr ($name, 1)} = $options{$name};  
     } else {  
242        push @new_fields, ($name => $options{$name});        push @new_fields, ($name => $options{$name});
243      }      }
244    }    }
245    $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';  
   } elsif ($format =~ /^http/) {  
     $self->{option}->{sort} = 'good-practice';  
   }  
     
246    # Make alternative representations of @header_order.  This is used    # Make alternative representations of @header_order.  This is used
247    # for sorting.    # for sorting.
248    my $i = 1;    my $i = 1;
249    for (@header_order) {    for (@header_order) {
250        $header_order{$_} = $i++ unless $header_order{$_};        $header_order{$_} = $i++ unless $header_order{$_};
251    }    }
252      
253      $self->add (@new_fields, -parse => $self->{option}->{parse_all})
254        if $#new_fields > -1;
255  }  }
256    
257  =head2 Message::Header->new ([%initial-fields/options])  sub _init_by_format ($$\%) {
258      my $self = shift;
259      my ($format, $option) = @_;
260      if ($format =~ /rfc822/) {
261        $header_goodcase{bcc} = 'bcc';
262        $header_goodcase{cc} = 'cc';
263        $header_goodcase{'resent-bcc'} = 'Resent-bcc';
264        $header_goodcase{'resent-cc'} = 'Resent-cc';
265      } elsif ($format =~ /cgi/) {
266        unshift @header_order, qw(content-type location);
267        $option->{field_sort} = 'good-practice';
268        $option->{use_folding} = 0;
269      } elsif ($format =~ /http/) {
270        $option->{field_sort} = 'good-practice';
271      }
272      if ($format =~ /uri-url-mailto/) {
273        $option->{output_bcc} = 0;
274        $option->{field_name_capitalize} = 0;
275        $option->{field_format_pattern} = '%s=%s';
276        $option->{output_folding} = sub {
277          $_[1] =~ s/([^:@+\$A-Za-z0-9\-_.!~*])/sprintf('%%%02X', ord $1)/ge;
278          $_[1];
279        };  ## Yes, this is not folding!
280      }
281    }
282    
283    =item $msg = Message::Header->new ([%initial-fields/options])
284    
285  Constructs a new C<Message::Headers> object.  You might pass some initial  Constructs a new C<Message::Headers> object.  You might pass some initial
286  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.
287    
288  =head3 example  Example:
289    
290   $hdr = new Message::Headers   $hdr = new Message::Headers
291          Date         => 'Thu, 03 Feb 1994 00:00:00 +0000',          Date         => 'Thu, 03 Feb 1994 00:00:00 +0000',
# Line 188  C<field-name>-C<field-body> pairs and/or Line 296  C<field-name>-C<field-body> pairs and/or
296    
297  =cut  =cut
298    
299  sub new ($;%) {  ## Inherited
   my $class = shift;  
   my $self = bless {}, $class;  
   $self->_init (@_);  
   $self;  
 }  
300    
301  =head2 Message::Header->parse ($header, [%initial-fields/options])  =item $msg = Message::Header->parse ($header, [%initial-fields/options])
302    
303  Parses given C<header> and constructs a new C<Message::Headers>  Parses given C<header> and constructs a new C<Message::Headers>
304  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 207  sub parse ($$;%) { Line 310  sub parse ($$;%) {
310    my $class = shift;    my $class = shift;
311    my $header = shift;    my $header = shift;
312    my $self = bless {}, $class;    my $self = bless {}, $class;
313    $self->_init (@_);    $self->_init (@_);    ## BUG: don't check linebreak_strict
314    $header =~ s/\x0D?\x0A$REG{WSP}/\x20/gos;     ## unfold    $header =~ s/\x0D?\x0A$REG{WSP}/\x20/gos if $self->{option}->{use_folding};
315    for my $field (split /\x0D?\x0A/, $header) {    for my $field (split /\x0D?\x0A/, $header) {
316      if ($field =~ /$REG{M_fromline}/) {      if ($field =~ /$REG{M_fromline}/) {
317        my $body = $1;        my ($s,undef,$value) = $self->_value_to_arrayitem
318        $body = $self->_field_body ($body, 'mail-from')          ('mail-from' => $1, $self->{option});
319          if $self->{option}->{parse_all};        push @{$self->{value}}, $value if $s;
       push @{$self->{field}}, {name => 'mail-from', body => $body};  
320      } elsif ($field =~ /$REG{M_field}/) {      } elsif ($field =~ /$REG{M_field}/) {
321        my ($name, $body) = (lc $1, $2);        my ($name, $body) = ($1, $2);
       $name =~ s/$REG{WSP}+$//;  
322        $body =~ s/$REG{WSP}+$//;        $body =~ s/$REG{WSP}+$//;
323        $body = $self->_field_body ($body, $name) if $self->{option}->{parse_all};        my ($s,undef,$value) = $self->_value_to_arrayitem
324        push @{$self->{field}}, {name => $name, body => $body};          ($name => $body, $self->{option});
325          push @{$self->{value}}, $value if $s;
326      }      }
327    }    }
328    $self;    $self;
329  }  }
330    
331    =item $msg = Message::Header->parse_array (\@header, [%initial-fields/options])
332    
333    Parses given C<header> and constructs a new C<Message::Headers>
334    object.  Same as C<Message::Header-E<lt>parse> but this method
335    is given an array reference.  You might pass some additional
336    C<field-name>-C<field-body> pairs or/and initial options
337    as parameters to the constructor.
338    
339    =cut
340    
341  sub parse_array ($\@;%) {  sub parse_array ($\@;%) {
342    my $class = shift;    my $class = shift;
343    my $header = shift;    my $header = shift;
# Line 235  sub parse_array ($\@;%) { Line 347  sub parse_array ($\@;%) {
347    $self->_init (@_);    $self->_init (@_);
348    while (1) {    while (1) {
349      my $field = shift @$header;      my $field = shift @$header;
350      while (1) {      if ($self->{option}->{use_folding}) {
351        if ($$header[0] =~ /^$REG{WSP}/) {        while (1) {
352          $field .= shift @$header;          if ($$header[0] =~ /^$REG{WSP}/) {
353        } else {last}            $field .= shift @$header;
354            } else {last}
355          }
356        }
357        if ($self->{option}->{linebreak_strict}) {
358          $field =~ s/\x0D\x0A//g;
359        } else {
360          $field =~ tr/\x0D\x0A//d;
361      }      }
362      $field =~ tr/\x0D\x0A//d;   ## BUG: not safe for bar CR/LF      local $self->{option}->{parse} = $self->{option}->{parse_all};
363      if ($field =~ /$REG{M_fromline}/) {      if ($field =~ /$REG{M_fromline}/) {
364        my $body = $1;        my ($s,undef,$value) = $self->_value_to_arrayitem
365        $body = $self->_field_body ($body, 'mail-from')          ('mail-from' => $1, $self->{option});
366          if $self->{option}->{parse_all};        push @{$self->{value}}, $value if $s;
       push @{$self->{field}}, {name => 'mail-from', body => $body};  
367      } elsif ($field =~ /$REG{M_field}/) {      } elsif ($field =~ /$REG{M_field}/) {
368        my ($name, $body) = (lc $1, $2);        my ($name, $body) = ($self->_n11n_field_name ($1), $2);
       $name =~ s/$REG{WSP}+$//;  
369        $body =~ s/$REG{WSP}+$//;        $body =~ s/$REG{WSP}+$//;
370        $body = $self->_field_body ($body, $name) if $self->{option}->{parse_all};        my ($s,undef,$value) = $self->_value_to_arrayitem
371        push @{$self->{field}}, {name => $name, body => $body};          ($name => $body, $self->{option});
372          push @{$self->{value}}, $value if $s;
373      }      }
374      last if $#$header < 0;      last if $#$header < 0;
375    }    }
376    $self;    $self;
377  }  }
378    
379    =back
380    
381    =head1 METHODS
382    
383  =head2 $self->field ($field_name)  =head2 $self->field ($field_name)
384    
385  Returns C<field-body> of given C<field-name>.  Returns C<field-body> of given C<field-name>.
# Line 267  context, only first one is returned.) Line 389  context, only first one is returned.)
389    
390  =cut  =cut
391    
392  sub field ($$) {  sub field ($@) {shift->SUPER::item (@_)}
393    sub field_exist ($@) {shift->SUPER::item_exist (@_)}
394    
395    ## item-by?, \$checked-item, {item-key => 1}, \%option
396    sub _item_match ($$\$\%\%) {
397    my $self = shift;    my $self = shift;
398    my $name = lc shift;    my ($by, $i, $list, $option) = @_;
399    my @ret;    return 0 unless ref $$i;  ## Already removed
400    for my $field (@{$self->{field}}) {    if ($by eq 'name') {
401      if ($field->{name} eq $name) {      my %o = %$option; $o{parse} = 0;
402        unless (wantarray) {      my %l;
403          $field->{body} = $self->_field_body ($field->{body}, $name);      for (keys %$list) {
404          return $field->{body};        my ($s, undef, $v) = $self->_value_to_arrayitem ($_, '', %o);
405          if ($s) {
406            $l{$v->{name} . ':' . ( $option->{ns} || $v->{ns} ) } = 1;
407        } else {        } else {
408          $field->{body} = $self->_field_body ($field->{body}, $name);          $l{$v->{name} .':'. ( $option->{ns} || $self->{ns}->{default_phuri} ) } = 1;
         push @ret, $field->{body};  
409        }        }
410      }      }
411        return 1 if $l{$$i->{name} . ':' . $$i->{ns}};
412    }    }
413    if ($#ret < 0) {    0;
     return $self->add ($name);  
   }  
   @ret;  
414  }  }
415    *_delete_match = \&_item_match;
416    
417  sub field_exist ($$) {  ## Returns returned item value    \$item-value, \%option
418    my $self = shift;  sub _item_return_value ($\$\%) {
419    my $name = lc shift;    if (ref ${$_[1]}->{body}) {
420    my @ret;      ${$_[1]}->{body};
421    for my $field (@{$self->{field}}) {    } else {
422      return 1 if ($field->{name} eq $name);      ${$_[1]}->{body} = $_[0]->_parse_value (${$_[1]}->{name} => ${$_[1]}->{body},
423          ns => ${$_[1]}->{ns});
424        ${$_[1]}->{body};
425    }    }
   0;  
426  }  }
427    
428  =head2 $self->field_name ($index)  ## Returns returned (new created) item value    $name, \%option
429    sub _item_new_value ($$\%) {
430  Returns C<field-name> of $index'th C<field>.      my ($s,undef,$value) = $_[0]->_value_to_arrayitem
431            ($_[1] => '', $_[2]);
432  =head2 $self->field_body ($index)      $s? $value: undef;
433    }
 Returns C<field-body> of $index'th C<field>.  
434    
 =cut  
435    
 sub field_name ($$) {  
   my $self = shift;  
   $self->{field}->[shift]->{name};  
 }  
 sub field_body ($$) {  
   my $self = shift;  
   my $i = shift;  
   $self->{field}->[$i]->{body}  
    = $self->_field_body ($self->{field}->[$i]->{body}, $self->{field}->[$i]->{name});  
   $self->{field}->[$i]->{body};  
 }  
436    
437  sub _field_body ($$$) {  ## $self->_parse_value ($type, $value, %options);
438    my $self = shift;  sub _parse_value ($$$;%) {
439    my ($body, $name) = @_;    my $self = shift;
440    unless (ref $body) {    my $name = shift ;#|| $self->{option}->{_VALTYPE_DEFAULT};
441      my $type = $self->{option}->{field_type}->{$name}    my $value = shift;  return $value if ref $value;
442              || $self->{option}->{field_type}->{':DEFAULT'};    my %option = @_;
443      eval "require $type" or Carp::croak ("_field_body: $type: $@");    my $vtype; { no strict 'refs';
444      unless ($body) {      $vtype = ${&_NS_uri2phpackage ($option{ns}).'::OPTION'}{value_type};
445        $body = $type->new (-field_name => $name,      if (ref $vtype) { $vtype = $vtype->{$name} }
446          -format => $self->{option}->{format});      unless (ref $vtype) { $vtype = $vtype->{$self->{option}->{_VALTYPE_DEFAULT}} }
447      } else {      ## For compatiblity.
448        $body = $type->parse ($body, -field_name => $name,      unless (ref $vtype) { $vtype = $self->{option}->{value_type}->{$name}
449          -format => $self->{option}->{format});        || $self->{option}->{value_type}->{$self->{option}->{_VALTYPE_DEFAULT}} }
450      }    }
451      my $vpackage = $vtype->[0];
452      my %vopt = %{$vtype->[1]} if ref $vtype->[1];
453      if ($vpackage eq ':none:') {
454        return $value;
455      } elsif (defined $value) {
456        eval "require $vpackage" or Carp::croak qq{<parse>: $vpackage: Can't load package: $@};
457        return $vpackage->parse ($value,
458          -format   => $self->{option}->{format},
459          -field_name       => $name,
460          -parse_all        => $self->{option}->{parse_all},
461        %vopt);
462      } else {
463        eval "require $vpackage" or Carp::croak qq{<parse>: $vpackage: Can't load package: $@};
464        return $vpackage->new (
465          -format   => $self->{option}->{format},
466          -field_name       => $name,
467          -parse_all        => $self->{option}->{parse_all},
468        %vopt);
469    }    }
   $body;  
470  }  }
471    
472  =head2 $self->field_name_list ()  =head2 $self->field_name_list ()
# Line 348  returns ALL names.) Line 479  returns ALL names.)
479    
480  sub field_name_list ($) {  sub field_name_list ($) {
481    my $self = shift;    my $self = shift;
482    $self->_delete_empty_field ();    $self->_delete_empty ();
483    map {$_->{name}} @{$self->{field}};    map { $_->{name} . ':' . $_->{ns} } @{$self->{value}};
484    }
485    
486    sub namespace_ph_default ($;$) {
487      my $self = shift;
488      if (defined $_[0]) {
489        no strict 'refs';
490        $self->{ns}->{default_phuri} = $_[0];
491        $self->_ns_load_ph (${&_NS_uri2phpackage ($self->{ns}->{default_phuri}).'::OPTION'}{namespace_phname});
492      }
493      $self->{ns}->{default_phuri};
494  }  }
495    
496  =head2 $self->add ($field-name, $field-body, [$name, $body, ...])  =item $hdr->add ($field-name, $field-body, [$name, $body, ...])
497    
498  Adds an new C<field>.  It is not checked whether  Adds some field name/body pairs.  Even if there are
499  the field which named $field_body is already exist or not.  one or more fields named given C<$field-name>,
500  If you don't want duplicated C<field>s, use C<replace> method.  given name/body pairs are ADDed.  Use C<replace>
501    to remove same-name-fields.
502    
503  Instead of field name-body pair, you might pass some options.  Instead of field name-body pair, you might pass some options.
504  Four options are available for this method.  Four options are available for this method.
# Line 374  C<-validate>: Checks whether C<field-nam Line 516  C<-validate>: Checks whether C<field-nam
516    
517  =cut  =cut
518    
519  sub add ($%) {  ## [Name: Value] pair -> internal array item
520    my $self = shift;  ## $self->_value_to_arrayitem ($name => $value, {%options})
521    my %fields = @_;  ## or
522    my %option = %{$self->{option}};  ## $self->_value_to_arrayitem ($name => [$value, %value_options], {%options})
523    $option{parse} = defined wantarray unless defined $option{parse};  ##
524    for (grep {/^-/} keys %fields) {$option{substr ($_, 1)} = $fields{$_}}  ## Return: ((1 = success / 0 = failue), $full_name, $arrayitem)
525    my $body;  sub _value_to_arrayitem ($$$\%) {
526    for (grep {/^[^-]/} keys %fields) {    my $self = shift;
527      my $name = lc $_;  $body = $fields{$_};    my ($name, $value, $option) = @_;
528      $name =~ tr/_/-/ if $option{translate_underscore};    my $value_option = {};
529      Carp::croak "add: $name: invalid field-name"    if (ref $value eq 'ARRAY') {
530        if $option{validate} && $name =~ /$REG{UNSAFE_field_name}/;      ($value, %$value_option) = @$value;
531      $body = $self->_field_body ($body, $name) if $option{parse};    }
532      if ($option{prepend}) {    my $nsuri = $self->{ns}->{default_phuri};
533        unshift @{$self->{field}}, {name => $name, body => $body};    no strict 'refs';
534      } else {    if ($option->{ns}) {
535        push @{$self->{field}}, {name => $name, body => $body};      $nsuri = $option->{ns};
536      }    } elsif ($name =~ s/^([Xx]-[A-Za-z]+|[A-Za-z]+)-//) {
537    }      my $oprefix = $1;
538    $body if $option{parse};      my $prefix
539          = &{${&_NS_uri2phpackage ($nsuri).'::OPTION'}{n11n_prefix}}
540            ($self, &_NS_uri2phpackage ($nsuri), $oprefix);
541        $self->_ns_load_ph ($prefix);
542        $nsuri = $self->{ns}->{phname2uri}->{$prefix};
543        unless ($nsuri) {
544          $name = $oprefix . '-' . $name;
545          $nsuri = $self->{ns}->{default_phuri};
546        }
547      }
548      $name
549        = &{${&_NS_uri2phpackage ($nsuri).'::OPTION'}{n11n_name}}
550          ($self, &_NS_uri2phpackage ($nsuri), $name);
551      Carp::croak "$name: invalid field-name"
552        if $option->{field_name_validation}
553          && $name =~ /$REG{$option->{field_name_unsafe_rule}}/;
554      $value = $self->_parse_value ($name => $value, ns => $nsuri) if $$option{parse};
555      $$option{parse} = 0;
556      (1, $name.':'.$nsuri => {name => $name, body => $value, ns => $nsuri});
557  }  }
558    *_add_hash_check = \&_value_to_arrayitem;
559    *_replace_hash_check = \&_value_to_arrayitem;
560    
561  =head2 $self->relace ($field_name, $field_body)  =head2 $self->relace ($field_name, $field_body)
562    
# Line 406  first one is used and the others are not Line 568  first one is used and the others are not
568    
569  =cut  =cut
570    
571  sub replace ($%) {  sub _replace_hash_shift ($\%$\%) {
572    my $self = shift;    shift; my $r = shift;  my $n = $_[0]->{name};
573    my %params = @_;    if ($$r{$n}) {
574    my %option = %{$self->{option}};      my $d = $$r{$n};
575    $option{parse} = defined wantarray unless defined $option{parse};      delete $$r{$n};
576    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}      return $d;
   my (%new_field, $body);  
   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{$_};  
   }  
   for my $field (@{$self->{field}}) {  
     if (defined $new_field{$field->{name}}) {  
       $body = $new_field {$field->{name}};  
       $field->{body} = $body;  
       $new_field{$field->{name}} = undef;  
     }  
   }  
   for (keys %new_field) {  
     push @{$self->{field}}, {name => $_, body => $new_field{$_}};  
577    }    }
578    $body if $option{parse};    undef;
579  }  }
580    
581  =head2 $self->delete ($field-name, [$name, ...])  =head2 $self->delete ($field-name, [$name, ...])
# Line 440  Deletes C<field> named as $field_name. Line 584  Deletes C<field> named as $field_name.
584    
585  =cut  =cut
586    
 sub delete ($@) {  
   my $self = shift;  
   my %delete;  
   for (@_) {$delete{lc $_} = 1}  
   for my $field (@{$self->{field}}) {  
     undef $field if $delete{$field->{name}};  
   }  
 }  
587    
588  =head2 $self->count ([$field_name])  =head2 $self->count ([$field_name])
589    
# Line 457  of fields.  (Same as $#$self+1) Line 593  of fields.  (Same as $#$self+1)
593    
594  =cut  =cut
595    
596  sub count ($;$) {  sub _count_by_name ($$\%) {
597    my $self = shift;    my $self = shift;
598    my ($name) = (lc shift);    my ($array, $option) = @_;
599    unless ($name) {    my $name = $self->_n11n_field_name ($$option{-name});
600      $self->_delete_empty_field ();    my @a = grep {$_->{name} eq $name} @{$self->{$array}};
601      return $#{$self->{field}}+1;    $#a + 1;
602    }  }
603    my $count = 0;  
604    for my $field (@{$self->{field}}) {  ## Delete empty items
605      if ($field->{name} eq $name) {  sub _delete_empty ($) {
606        $count++;    my $self = shift;
607      }    my $array = $self->{option}->{_HASH_NAME};
608    }    $self->{$array} = [grep {ref $_ && length $_->{name}} @{$self->{$array}}];
   $count;  
609  }  }
610    
611  =head2 $self->rename ($field-name, $new-name, [$old, $new,...])  =head2 $self->rename ($field-name, $new-name, [$old, $new,...])
# Line 486  sub rename ($%) { Line 621  sub rename ($%) {
621    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}
622    my %new_name;    my %new_name;
623    for (grep {/^[^-]/} keys %params) {    for (grep {/^[^-]/} keys %params) {
624      my ($old => $new) = (lc $_ => lc $params{$_});      my ($old => $new)
625          = ($self->_n11n_field_name ($_) => $self->_n11n_field_name ($params{$_}));
626        $old =~ tr/_/-/ if $option{translate_underscore};
627      $new =~ tr/_/-/ if $option{translate_underscore};      $new =~ tr/_/-/ if $option{translate_underscore};
628      Carp::croak "rename: $new: invalid field-name"      Carp::croak "rename: $new: invalid field-name"
629        if $option{validate} && $new =~ /$REG{UNSAFE_field_name}/;        if $option{field_name_validation}
630            && $new =~ /$REG{$option{field_name_unsafe_rule}}/;
631      $new_name{$old} = $new;      $new_name{$old} = $new;
632    }    }
633    for my $field (@{$self->{field}}) {    for my $field (@{$self->{value}}) {
634      if (length $new_name{$field->{name}}) {      if (length $new_name{$field->{name}}) {
635        $field->{name} = $new_name{$field->{name}};        $field->{name} = $new_name{$field->{name}};
636      }      }
# Line 510  for each value. Line 648  for each value.
648    
649  =cut  =cut
650    
651  sub scan ($&) {  sub _scan_sort ($\@\%) {
652    my ($self, $sub) = @_;    my $self = shift;
653      my ($array, $option) = @_;
654    my $sort;    my $sort;
655    $sort = \&_header_cmp if $self->{option}->{sort} eq 'good-practice';    $sort = \&_header_cmp if $option->{field_sort} eq 'good-practice';
656    $sort = {$a cmp $b} if $self->{option}->{sort} eq 'alphabetic';    $sort = {$a cmp $b} if $option->{field_sort} eq 'alphabetic';
657    my @field = @{$self->{field}};    return ( sort $sort @$array ) if ref $sort;
658    if (ref $sort) {    @$array;
659      @field = sort $sort @{$self->{field}};  }
660    }  
661    for my $field (@field) {  sub _n11n_field_name ($$) {
662      next if $field->{name} =~ /^_/;    my $self = shift;
663      &$sub($field->{name} => $field->{body});    my $s = shift;
664    }    $s =~ s/^$REG{WSP}+//; $s =~ s/$REG{WSP}+$//;
665      $s = lc $s ;#unless $self->{option}->{field_name_case_sensible};
666      $s;
667  }  }
668    
669  # Compare function which makes it easy to sort headers in the  # Compare function which makes it easy to sort headers in the
# Line 550  sub stringify ($;%) { Line 691  sub stringify ($;%) {
691    my $self = shift;    my $self = shift;
692    my %params = @_;    my %params = @_;
693    my %option = %{$self->{option}};    my %option = %{$self->{option}};
694      $option{format} = $params{-format} if $params{-format};
695      $self->_init_by_format ($option{format}, \%option);
696    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}    for (grep {/^-/} keys %params) {$option{substr ($_, 1)} = $params{$_}}
697    my @ret;    my @ret;
698    if ($option{mail_from}) {    my $_stringify = sub {
699      my $fromline = $self->field ('mail-from');      no strict 'refs';
700      push @ret, 'From '.$fromline if $fromline;        my ($name, $body, $nsuri) = ($_[1]->{name}, $_[1]->{body}, $_[1]->{ns});
701    }        return unless length $name;
702    $self->scan (sub {        return if $option{output_mail_from} && $name eq 'mail-from';
703      my ($name, $body) = (@_);        return if !$option{output_bcc} && ($name eq 'bcc' || $name eq 'resent-bcc');
704      return unless length $name;        my $nspackage = &_NS_uri2phpackage ($nsuri);
705      return if $option{mail_from} && $name eq 'mail-from';        my $oname;        ## Outputed field-name
706      return if !$option{output_bcc} && ($name eq 'bcc' || $name eq 'resent-bcc');        my $prefix = ${$nspackage.'::OPTION'} {namespace_phname_goodcase}
707      my $fbody;                  || $self->{ns}->{uri2phname}->{$nsuri};
708      if (ref $body) {        $prefix = undef if $nsuri eq $self->{ns}->{default_phuri};
709        $fbody = $body->stringify (-format => $option{format});        my $gc = ${$nspackage.'::OPTION'} {to_be_goodcase};
710          if (ref $gc) { $oname = &$gc ($self, $nspackage, $name) }
711          else { $oname = $name }
712          if ($prefix) { $oname = $prefix . '-' . $oname }
713          if ($option{format} =~ /uri-url-mailto/) {
714            return if ((   $option{uri_mailto_safe}->{$name}
715                 || $option{uri_mailto_safe}->{':default'})
716                  < $option{uri_mailto_safe_level});
717            if ($name eq 'to') {
718              $body = $self->field ('to', -new_item_unless_exist => 0);
719              if (ref $body && $body->have_group) {
720                #
721              } elsif (ref $body && $body->count > 1) {
722                $body = $body->clone;
723                $body->delete ({-by => 'index'}, 0);
724              }
725            }
726          }
727          my $fbody;
728          if (ref $body) {
729            $fbody = $body->stringify (-format => $option{format});
730          } else {
731            $fbody = $body;
732          }
733          return unless length $fbody;
734          unless ($option{linebreak_strict}) {
735            ## bare \x0D and bare \x0A are unsafe
736            $fbody =~ s/\x0D(?=[^\x09\x0A\x20])/\x0D\x20/g;
737            $fbody =~ s/\x0A(?=[^\x09\x20])/\x0A\x20/g;
738          } else {
739            $fbody =~ s/\x0D\x0A(?=[^\x09\x20])/\x0D\x0A\x20/g;
740          }
741          if ($option{use_folding}) {
742            if (ref $option{output_folding}) {
743              $fbody = &{$option{output_folding}} ($self, $fbody,
744                -initial_length => length ($oname) +2);
745            } elsif ($option{output_folding}) {
746              $fbody = $self->_fold ($fbody, -initial_length => length ($oname) +2);
747            }
748          }
749          push @ret, sprintf $option{field_format_pattern}, $oname, $fbody;
750        };
751      if ($option{format} =~ /uri-url-mailto/) {
752        if ($option{format} =~ /uri-url-mailto-to/) {
753          my $to = $self->field ('to', -new_item_unless_exist => 0);
754          if ($to) {
755            unless ($to->have_group) {
756              my $fbody = $to->stringify (-format => $option{format}, -max => 1);
757              return &{$option{output_folding}} ($self, $fbody);
758            }
759          }
760          '';
761        } elsif ($option{format} =~ /uri-url-mailto-rfc1738/) {
762          my $to = $self->field ('to', -new_item_unless_exist => 0);
763          if ($to) {
764            my $fbody = $to->addr_spec (-format => $option{format});
765            return &{$option{output_folding}} ($self, $fbody);
766          }
767          '';
768      } else {      } else {
769        $fbody = $body;        $self->scan ($_stringify);
770      }        my $ret = join ('&', @ret);
771      return unless length $fbody;        $ret;
772      $fbody =~ s/\x0D(?=[^\x09\x0A\x20])/\x0D\x20/g;      }
773      $fbody =~ s/\x0A(?=[^\x09\x20])/\x0A\x20/g;    } else {
774      $name =~ s/((?:^|-)[a-z])/uc($1)/ge if $option{capitalize};      if ($option{output_mail_from}) {
775      push @ret, $name.': '.$self->fold ($fbody);        my $fromline = $self->field ('mail-from', -new_item_unless_exist => 0);
776    });        push @ret, 'From '.$fromline if $fromline;
777    my $ret = join ("\n", @ret);      }
778    $ret? $ret."\n": '';      $self->scan ($_stringify);
779        my $ret = join ("\x0D\x0A", @ret);
780        $ret? $ret."\x0D\x0A": '';
781      }
782  }  }
783  *as_string = \&stringify;  *as_string = \&stringify;
784    
# Line 590  sub option ($@) { Line 794  sub option ($@) {
794      return $self->{option}->{ shift (@_) };      return $self->{option}->{ shift (@_) };
795    }    }
796    while (my ($name, $value) = splice (@_, 0, 2)) {    while (my ($name, $value) = splice (@_, 0, 2)) {
     $name =~ s/^-//;  
797      $self->{option}->{$name} = $value;      $self->{option}->{$name} = $value;
798      if ($name eq 'format') {      if ($name eq 'format') {
799        for my $f (@{$self->{field}}) {        for my $f (@{$self->{field}}) {
# Line 602  sub option ($@) { Line 805  sub option ($@) {
805    }    }
806  }  }
807    
808  sub field_type ($$;$) {  sub field_type ($@) {shift->SUPER::value_type (@_)}
809    
810    ## $self->_fold ($string, %option = (-max, -initial_length(for field-name)) )
811    sub _fold ($$;%) {
812    my $self = shift;    my $self = shift;
813    my $field_name = shift;    my $string = shift;
814    my $new_field_type = shift;    my %option = @_;
815    if ($new_field_type) {    my $max = $self->{option}->{line_length_max};
816      $self->{option}->{field_type}->{$field_name} = $new_field_type;    $max = 20 if $max < 20;
817    }    
818    $self->{option}->{field_type}->{$field_name}    my $l = $option{-initial_length} || 0;
819    || $self->{option}->{field_type}->{':DEFAULT'};    $string =~ s{([\x09\x20][^\x09\x20]+)}{
820        my $s = $1;
821        if ($l + length $s > $max) {
822          $s = "\x0D\x0A\x20" . $s;
823          $l = length ($s) - 2;
824        } else { $l += length $s }
825        $s;
826      }gex;
827      $string;
828  }  }
829    
830  sub _delete_empty_field ($) {  sub _ns_load_ph ($$) {
831    my $self = shift;    my $self = shift;
832    my @ret;    my $name = shift;     ## normalized prefix (without HYPHEN-MINUS)
833    for my $field (@{$self->{field}}) {    return if $self->{ns}->{phname2uri}->{$name};
834      push @ret, $field if $field->{name};    $self->{ns}->{phname2uri}->{$name} = $NS_phname2uri{$name};
835    }    return unless $self->{ns}->{phname2uri}->{$name};
836    $self->{field} = \@ret;    $self->{ns}->{uri2phname}->{$self->{ns}->{phname2uri}->{$name}} = $name;
   $self;  
837  }  }
838    
839  sub fold ($$;$) {  sub _NS_uri2phpackage ($) {
840    my $self = shift;    $NS_uri2phpackage{$_[0]}
841    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;  
842  }  }
843    
844  =head2 $self->clone ()  =head2 $self->clone ()
# Line 663  Returns a copy of Message::Header object Line 847  Returns a copy of Message::Header object
847    
848  =cut  =cut
849    
850  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;  
 }  
851    
852  =head1 NOTE  =head1 NOTE
853    
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.20
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24