=head1 NAME

Message::Field::Address Perl module

=head1 DESCRIPTION

Perl module for RFC 822/2822 address related C<field>s.

=cut

package Message::Field::Address;
require 5.6.0;
use strict;
use re 'eval';
use vars qw(%DEFAULT %REG $VERSION);
$VERSION = '1.00';
use Message::Util;
use overload '@{}' => sub {shift->{address}},
             '""' => sub {shift->stringify};

$REG{comment} = qr/\x28(?:\x5C[\x00-\xFF]|[\x00-\x0C\x0E-\x27\x2A-\x5B\x5D-\xFF]+|(??{$REG{comment}}))*\x29/;
$REG{quoted_string} = qr/\x22(?:\x5C[\x00-\xFF]|[\x00-\x0C\x0E-\x21\x23-\x5B\x5D-\xFF])*\x22/;
$REG{domain_literal} = qr/\x5B(?:\x5C[\x00-\xFF]|[\x00-\x0C\x0E-\x5A\x5E-\xFF])*\x5D/;

$REG{WSP} = qr/[\x20\x09]+/;
$REG{FWS} = qr/[\x20\x09]*/;
$REG{atext} = qr/[\x21\x23-\x27\x2A\x2B\x2D\x2F\x30-\x39\x3D\x3F\x41-\x5A\x5E-\x7E]+/;
$REG{dot_atom} = qr/$REG{atext}(?:$REG{FWS}\x2E$REG{FWS}$REG{atext})*/;
$REG{dot_word} = qr/(?:$REG{atext}|$REG{quoted_string})(?:$REG{FWS}\x2E$REG{FWS}(?:$REG{atext}|$REG{quoted_string}))*/;
$REG{phrase} = qr/(?:$REG{atext}|$REG{quoted_string})(?:$REG{atext}|$REG{quoted_string}|\.|$REG{FWS})*/;
$REG{obs_route} = qr/(?:\x40$REG{FWS}(?:$REG{dot_word}|$REG{domain_literal})(?:$REG{FWS},?$REG{FWS}\x40$REG{FWS}(?:$REG{dot_word}|$REG{domain_literal}))*):/;
$REG{addr_spec} = qr/$REG{dot_word}$REG{FWS}\x40$REG{FWS}(?:$REG{dot_atom}|$REG{domain_literal})/;
$REG{mailbox} = qr/(?:(?:$REG{phrase})?<$REG{FWS}(?:(?:$REG{obs_route})?$REG{FWS}$REG{addr_spec}$REG{FWS})?>|$REG{addr_spec}|$REG{atext})/;
$REG{mailbox_list} = qr/$REG{mailbox}(?:$REG{FWS},(?:$REG{FWS}$REG{mailbox})?)*/;
$REG{address} = qr/(?:(?:$REG{phrase})?(?:<$REG{FWS}(?:(?:$REG{obs_route})?$REG{FWS}$REG{addr_spec}$REG{FWS})?>|:$REG{FWS}(?:$REG{mailbox_list}$REG{FWS})?;)|$REG{addr_spec}|$REG{atext})/;
$REG{address_list} = qr/$REG{address}(?:$REG{FWS},(?:$REG{FWS}$REG{address})?)*/;
$REG{M_group} = qr/($REG{phrase}):/;
$REG{M_mailbox} = qr/(?:($REG{phrase})?<$REG{FWS}($REG{obs_route})?$REG{FWS}($REG{addr_spec})$REG{FWS}>|($REG{addr_spec}))/;
$REG{M_mailbox_empty} = qr/(?:($REG{phrase})?<$REG{FWS}>)/;
$REG{M_quoted_string} = qr/\x22((?:\x5C[\x00-\xFF]|[\x00-\x0C\x0E-\x21\x23-\x5B\x5D-\xFF])*)\x22/;

$REG{NON_atom} = qr/[^\x09\x20\x21\x23-\x27\x2A\x2B\x2D\x2F\x30-\x39\x3D\x3F\x41-\x5A\x5E-\x7E]/;

%DEFAULT = (
  dont_reply	=> -1,	## See C<$self->dont_reply>
  dont_reply_display_name	=> '',
  encoding_after_encode	=> '*default',
  encoding_before_decode	=> '*default',
  format	=> 'rfc2822',
  hook_encode_string	=> #sub {shift; (value => shift, @_)},
  	\&Message::Util::encode_header_string,
  hook_decode_string	=> #sub {shift; (value => shift, @_)},
  	\&Message::Util::decode_header_string,
  is_mailbox	=> -1,	## Allow multiple mail addresses?
  is_return_path	=> -1,
  use_display_name	=> 1,
  use_dont_reply	=> -1,	## See C<$self->dont_reply>
  use_group	=> 1,
  use_keyword	=> -1,	## See C<$self->keyword>
  use_keyword_multiple	=> -1,
);
## RFC 2822 C<mailbox>	=> is_mailbox = +1, (use_group = -1)
## RFC 2822 C<mailbox-list>	=> is_mailbox = -1, use_group = -1
## RFC 2822 C<address-list>	=> is_mailbox = -1, use_group = +1

## Initialization of option value by C<field-name> and 
## version of specification(s).
sub _init_option ($$) {
  my $self = shift;
  my $name = shift;
  my $spec = $self->{option}->{format};
  my %is_mailbox_name	= (	## C<is_mailbox>
    'complaints-to'	=> 1,
    'mail-copies-to'	=> 1, 'resent-sender'	=> 1,
    'return-path'	=> 1, sender	=> 1, 
    'x-complaints-to'	=> 1,
  );
  my %use_group_name	= (	## C<use_group>
    'approved'	=> -1,
    'from'	=> -1, 'resent-from'	=> -1,
  );
  if ($is_mailbox_name{$name}) {
    $self->{option}->{is_mailbox} = $is_mailbox_name{$name};
  } elsif ($use_group_name{$name}) {
    $self->{option}->{use_group} = $use_group_name{$name};
  }
  if ($spec eq 'usefor') {
    if ($name eq 'reply-to') {
      $self->{option}->{use_group} = -1;
      $self->{option}->{use_dont_reply} = 1;
    }
  }
  if ($name eq 'mail-copies-to') {
    $self->{option}->{use_keyword} = 1;
  }
  if ($name eq 'return-path') {
    $self->{option}->{is_return_path} = 1;
    $self->{option}->{use_display_name} = -1;
  }
  $self;
}

=head2 Message::Field::Address->new ()

Return empty address object.

=cut

sub new ($;%) {
  my $self = bless {type => '_ROOT'}, shift;
  my %option = @_;
  for (%DEFAULT) {$option{$_} ||= $DEFAULT{$_}}
  $self->{option} = \%option;
  $self->_init_option ($self->{option}->{field_name});
  $self;
}

=head2 Message::Field::Address->parse ($unfolded_field_body)

Parse structured C<field-body> contain of C<address-list>.

=cut

sub parse ($$;%) {
  my $self = bless {}, shift;
  my $field_body = shift;
  my %option = @_;
  for (%DEFAULT) {$option{$_} ||= $DEFAULT{$_}}
  $self->{option} = \%option;
  $self->_init_option ($self->{option}->{field_name});
  $field_body = $self->delete_comment ($field_body);
  my %addr = $self->parse_address_list ($field_body);
  $self->{address} = $addr{address};
  $self->{type}    = $addr{type};
  $self;
}

=head2 $self->address ()

Return address list in the format described in
L<$self-E<gt>parse_address_list ()>.

=cut

sub address ($) {@{shift->{address}}}

=head2 $self->addr_spec ([$index])

Returns (C<$index>'th or all) C<addr-spec>.
(First C<addr-spec>'s C<$index> is C<1>, not C<0>.)

=cut

sub addr_spec ($;$) {
  my $self = shift;
  my $i = shift;
  #return $self->{address}->[$i]->{addr_spec}
  #  if defined $i && ref $self->{address}->[$i];
  #map {$_->{addr_spec}} @{$self->{address}};
  my @r = ();  my $j = 0;
  for my $m (@{$self->{address}}) {
    if ($m->{type} eq 'group') {
      for my $n (@{$m->{address}}) {
        $j++;
        return $n->{addr_spec} if $j == $i;
        push @r, $m->{addr_spec};
      }
    } else {
      $j++;
      return $m->{addr_spec} if $j == $i;
      push @r, $m->{addr_spec};
    }
  }
  @r;
}

sub have_group ($) {
  my $self = shift;
  for (@{$self->{address}}) {
    return 1 if $_->{type} eq 'group';
  }
  0;
}

=head2 $self->add ($addr_spec, [%option])

Add an mail address to C<$self> (address object).
%option = (name => C<display-name>, route => C<route>, 
           group => C<display-name> of C<group>)

Note that this method (and other methods) does not check
$addr_spec and $option{route} is valid or not.

=cut

sub add ($$;%) {
  my $self = shift;
  my ($addr, %option) = @_;
  my $name = $option{name} || $option{display_name};
  unless ($option{group}) {
    push @{$self->{address}}, {type => 'mailbox',
         addr_spec => $addr, display_name => $name, route => $option{route}};
  } else {
    for my $i (@{$self->{address}}) {
      if ($i->{type} eq 'group' && $i->{display_name} eq $option{group}) {
        push @{$i->{address}}, {type => 'mailbox',
             addr_spec => $addr, display_name => $name, route => $option{route}};
        return $self;
      }
    }
    push @{$self->{address}}, {type => 'group', display_name => $option{group},
         address => [
           {type => 'mailbox',
            addr_spec => $addr, display_name => $name, route => $option{route}}
         ]};
  }
  $self;
}

sub stringify ($;%) {
  my $self = shift;
  my %option = @_;  
  $option{is_mailbox} ||= $self->{option}->{is_mailbox};
  $option{is_return_path} ||= $self->{option}->{is_return_path};
  $option{use_display_name} ||= $self->{option}->{use_display_name};
  $option{use_group} ||= $self->{option}->{use_group};
  $option{use_keyword} ||= $self->{option}->{use_keyword};
  $option{use_keyword_multiple} ||= $self->{option}->{use_keyword_multiple};
  $option{use_dont_reply} ||= $self->{option}->{use_dont_reply};
  $option{dont_reply} ||= $self->{option}->{dont_reply};
  $option{dont_reply_display_name} = $self->{option}->{dont_reply_display_name}
    unless defined $option{dont_reply_display_name};
  if ($option{use_dont_reply}>0 && $option{dont_reply}>0) {
  ## usefor-article Reply-To:
        my $g_return = '';
        if ($option{dont_reply_display_name} && $option{use_display_name}>0) {
          my %s = &{$self->{option}->{hook_encode_string}} ($self, 
            $option{dont_reply_display_name}, type => 'phrase');
          $g_return = $self->quote_unsafe_string ($s{value}) .' ';
        }
        $g_return .= '<>';
    return $g_return;
  }
  my @return;
  if ($option{use_keyword}>0) {
    my @kw = grep {$self->{keyword}->{$_}>0} keys %{$self->{keyword}};
    return $kw[0] if $kw[0] && $option{use_keyword_multiple}<0;
    push @return, @kw;
  }
  for my $address (@{$self->{address}}) {
    my $return = '';
    next if !$address->{addr_spec} && $address->{type} ne 'group';
    if ($address->{display_name} && $option{use_display_name}>0) {
      if ($address->{type} eq 'group' && $option{use_group}>0) {
        my %s = &{$self->{option}->{hook_encode_string}} ($self, 
          $address->{display_name}, type => 'phrase');
        $return = $self->quote_unsafe_string ($s{value}).': ';
      #} else {
      #  my %s = &{$self->{option}->{hook_encode_string}} ($self, 
      #    $address->{display_name}, type => 'comment');
      #  $s{value} =~ s/[\x28\x29\x5C]/\\$&/g;
      #  $return = '('.$s{value}.') ';
      } elsif ($address->{type} ne 'group') {
        my %s = &{$self->{option}->{hook_encode_string}} ($self, 
          $address->{display_name}, type => 'phrase');
        $return = $self->quote_unsafe_string ($s{value}).' ';
      }
    }
    if ($address->{type} ne 'group') {
      $return .= '<'.$address->{route}.$address->{addr_spec}.'>';
    } else {
      my (@g_return);
      for my $mailbox (@{$address->{address}}) {
        next unless $mailbox->{addr_spec};
        my $g_return = '';
        if ($mailbox->{display_name} && $option{use_display_name}>0) {
          my %s = &{$self->{option}->{hook_encode_string}} ($self, 
            $mailbox->{display_name}, type => 'phrase');
          $g_return = $self->quote_unsafe_string ($s{value}) .' ';
        }
        $g_return .= '<'.$mailbox->{route}.$mailbox->{addr_spec}.'>';
        push @g_return, $g_return;
        last if $option{is_mailbox}>0;
      }
      $return .= join ', ', @g_return;
      $return .= ';' if $address->{type} eq 'group' && $option{use_group}>0;
    }
    push @return, $return;
    last if $option{is_mailbox}>0;
  }
  if ($#return == -1) {
    if ($option{is_return_path}>0) {
      push @return, '<>';
    #} elsif ($option{use_dont_reply}>0) {	## usefor-article Reply-To:
    #    my $g_return = '';
    #    if ($option{dont_reply_display_name} && $option{use_display_name}>0) {
    #      my %s = &{$self->{option}->{hook_encode_string}} ($self, 
    #        $option{dont_reply_display_name}, type => 'phrase');
    #      $g_return = $self->quote_unsafe_string ($s{value}) .' ';
    #    }
    #    $g_return .= '<>';
    #  push @return, $g_return;
    }
  }
  join ', ', @return;
}

=head2 $self->dont_reply ([$don't_reply?, [$display_name]])

Set/gets whether C<field-body> content is "don't reply!"
or not.  Second argument is short string used as C<display-name>.

This function returns an array of C<($don't_reply?, $display_name)>.
<$don't_reply> takes value C<1> (true) or C<-1> (false).

Note: This don't reply convention is defined by draft-usefor-article.
You should not use this in RFC 2822 mail message.

Enable this, set C<use_dont_reply> option to C<1>.  (Default is C<-1>.

Note: Set this value does not mean clear address list that
current C<Message::Field::Address> has.  You can get it
as well as before setting new value.  But C<stringify> method
does not output any of addresses if <$don't_reply> is C<1>.

=head3 example

  my $a = Message::Field::Address->new (use_reply => 1);
  $a->dont_reply (1, 'Please do not reply');
  print $a;	# "Please do not reply <>"

=cut

sub dont_reply ($;$$) {
  my $self = shift;
  my $dr = shift;
  my $dname = shift;
  $self->{option}->{dont_reply} = $dr if $dr;
  $self->{option}->{dont_reply_display_name} = $dname if defined $dname;
  ($self->{dont_reply}, $self->{dont_reply_display_name});
}

=head2 $self->keyword ($keyword, [$true_of_false])

Set/gets whether keyword is specified.  C<$true_or_false>
takes values C<1> and C<-1>.

This function is intended to be used for keyword(s) allowed
mail addresses field, such as C<Mail-Copies-To:> defined by
draft-usefor-article.

There are two related options, C<use_keyword> and C<use_keyword_multiple>.
Former is on/off switch of this function.  Later allows
multiple options/addresses, such as C<keyworda, E<lt>foo@bar.exampleE<gt>>.

=cut

sub keyword ($$;$) {
  my $self = shift;
  my $key = shift;
  my $tf = shift;
  $self->{keyword}->{$key} = $tf if $tf;
  $self->{keyword}->{$key} || -1;
}

sub quote_unsafe_string ($$) {
  my $self = shift;
  my $string = shift;
  if ($string =~ /$REG{NON_atom}/ || $string =~ /$REG{WSP}$REG{WSP}+/) {
    $string =~ s/([\x22\x5C])/\x5C$1/g;
    $string = '"'.$string.'"';
  }
  $string;
}

=head2 $self->unquote_quoted_string ($string)

Unquote C<quoted-string>.  Get rid of C<DQUOTE>s and
C<REVERSED SOLIDUS> included in C<quoted-pair>.
This method is intended for internal use.

=cut

sub unquote_quoted_string ($$) {
  my $self = shift;
  my $quoted_string = shift;
  $quoted_string =~ s{$REG{M_quoted_string}}{
    my $qtext = $1;
    $qtext =~ s/\x5C([\x00-\xFF])/$1/g;
    $qtext;
  }goex;
  $quoted_string;
}

sub _decode_quoted_string ($$) {
  my $self = shift;
  my $quoted_string = shift;
  $quoted_string =~ s{$REG{M_quoted_string}|([^\x22]+)}{
    my ($qtext,$t) = ($1, $2);
    if ($t) {
      my %s = &{$self->{option}->{hook_decode_string}} ($self, $t,
                type => 'value');
      $s{value};
    } else {
      $qtext =~ s/\x5C([\x00-\xFF])/$1/g;
      my %s = &{$self->{option}->{hook_decode_string}} ($self, $qtext,
                type => 'value/quoted');
      $s{value};
    }
  }goex;
  $quoted_string;
}

=head2 $self->parse_mailbox ($mailbox)

Parse C<mailbox> and return array of C<addr-spec>,
C<display-name> and C<route> (aka C<obs-route> of RFC 2822).
This method is intended for internal use.

=cut

sub parse_mailbox ($$) {
  my $self = shift;
  my $mailbox = shift;
  if ($mailbox =~ /$REG{M_mailbox}/) {
    my ($display_name, $route, $addr_spec) = ($1, $2, $3 || $4);
    $display_name =~ s/$REG{WSP}+$//;
    $display_name = $self->_decode_quoted_string ($display_name);
    $addr_spec =~ s{($REG{quoted_string}|$REG{domain_literal})|$REG{WSP}}{$1}go;
    $route =~ s{($REG{quoted_string}|$REG{domain_literal})|$REG{WSP}}{$1}go;
    return ($addr_spec, $display_name, $route);
  } elsif ($mailbox =~ /$REG{M_mailbox_empty}/) {
    my ($display_name) = ($1);
    $display_name =~ s/$REG{WSP}+$//;
    $display_name = $self->_decode_quoted_string ($display_name);
    return ('', $display_name, 'dummy');
  } elsif ($mailbox =~ /^$REG{atext}$/) {
    $self->{keyword}->{$mailbox} = 1;
  }
  (undef, undef, undef);
}

=head2 $self->parse_address_list ($address_list)

Parse C<address-list> and return hash.
This method is intended for internal use.

=head3 Structure of hash returned by parse_address_list

%address = (

  type	=> '_ROOT',
  address	=> [
  
    ## mailbox
    {
      type	=> 'mailbox',
      display_name	=> 'Foo H. Bar',
      addr_spec	=> 'foo@bar.example',
      route	=> '@hoge.example:',
    },
    
    ## group
    {
      type	=> 'group',
      display_name	=> 'The committee',
      address	=> [
        
        ## mailbox
        {
          type	=> 'mailbox',
          display_name	=> 'Tom (Director)',
          addr_spec	=> 'tom@committee.example',
          route	=> '',
        }
        
      ],
    },
  
  ],

);

=cut

sub parse_address_list ($$) {
  my $self = shift;
  my $address_list = shift;
  my %r_addr = (type => '_ROOT');
  $address_list =~ s{($REG{address})}{
    my $address = $1;
    if ($address =~ /^$REG{M_group}/) {
      my %r_group = (type => 'group', display_name => $1);
      $r_group{display_name} =~ s/$REG{WSP}+$//;
      $r_group{display_name} = $self->unquote_quoted_string ($r_group{display_name});
      $address =~ s{($REG{mailbox})}{
        my ($addr, $name, $route) = $self->parse_mailbox ($1);
        push @{$r_group{address}}, {type => 'mailbox',
           display_name => $name, route => $route, addr_spec => $addr}
           if $addr;
      }goex;
      push @{$r_addr{address}}, \%r_group;
    } else {
      my ($addr, $name, $route) = $self->parse_mailbox ($address);
      if ($addr) {
        push @{$r_addr{address}}, {type => 'mailbox',
             display_name => $name, route => $route, addr_spec => $addr};
      } elsif ($route) {	# dummy
        $self->{option}->{dont_reply} = 1;
        $self->{option}->{dont_reply_display_name} = $name;
      }
    }
  }goex;
  %r_addr;
}

=head2 $self->delete_comment ($field_body)

Remove all C<comment> in given strictured C<field-body>.
This method is intended for internal use.

=cut

sub delete_comment ($$) {
  my $self = shift;
  my $body = shift;
  $body =~ s{($REG{quoted_string}|$REG{domain_literal})|$REG{comment}}{
    my $o = $1;  $o? $o : ' ';
  }gex;
  $body;
}

=head1 EXAMPLE

  ## Compose field-body for To: field.
  
  use Message::Field::Address;
  my $addr = new Message::Field::Address;
  $addr->add ('foo@example.org', name => 'Mr. foo bar');
  $addr->add ('webmaster@example.org', group => 'administrators');
  $addr->add ('postmaster@example.org', group => 'administrators');
  
  my $field_body = $addr->stringify ();


  ## Output parsed address-list tree.
  
  use Message::Field::Address;
  my $addr = Message::Field::Address->parse ($field_body);
  
  for my $i (@$addr) {
    if ($i->{type} eq 'group') {
      print "\x40 $i->{display_name}: \n";
      for my $j (@{$i->{address}}) {
        print "\t- $j->{display_name} <$j->{route}$j->{addr_spec}>\n";
      }
    } else {
      print "- $i->{display_name} <$i->{route}$i->{addr_spec}>\n";
    }
  }

=head1 LICENSE

Copyright 2002 wakaba E<lt>w@suika.fam.cxE<gt>.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.

=head1 CHANGE

See F<ChangeLog>.
$Date: 2002/05/15 07:29:09 $

=cut

1;