Message/Field/CSV.pm


=head1 NAME

Message::Field::CSV --- Perl module for Internet message
field body consist of comma separated values

=cut

package Message::Field::CSV;
require 5.6.0;
use strict;
use re 'eval';
use vars qw(@ISA %REG $VERSION);
$VERSION=do{my @r=(q$Revision: 1.10 $=~/\d+/g);sprintf "%d."."%02d" x $#r,@r};
require Message::Util;
require Message::Field::Structured;
push @ISA, qw(Message::Field::Structured);

use overload '""' => sub { $_[0]->stringify },
             '0+' => sub { $_[0]->count },
             '@{}' => sub { $_[0]->{value} },   ## SHOULD NOT be used
             '.=' => sub { $_[0]->add ($_[1]); $_[0] },
             fallback => 1;

*REG = \%Message::Util::REG;
## Inherited: comment, quoted_string, domain_literal, angle_quoted
        ## WSP, FWS, atext

## From usefor-article
        $REG{NON_component} = qr/[^\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5F\x61-\x7A\x80-\xFF\x2F\x3D\x3F]/;
        $REG{NON_distribution} = qr/[^\x21\x2B\x2D\x30-\x39\x41-\x5A\x5F\x61-\x7A]/;

=head1 CONSTRUCTORS

The following methods construct new objects:

=over 4

=cut

## Initialize of this class -- called by constructors
sub _init ($;%) {
  my $self = shift;
  my %options = @_;
  my %DEFAULT = (
    -_ARRAY_NAME        => 'value',
    -_MEMBERS   => [qw|value_type|],
    -_METHODS   => [qw|add replace count delete item
                       comment_add comment_delete comment_count
                       comment_item|],
    #encoding_after_encode
    #encoding_before_decode
    -field_name => 'keywords',
    #format
    #hook_encode_string
    #hook_decode_string
    -is_quoted_string   => 1,   ## Can itself quoted-string?
    -long_count => 10,
    -parse_all  => 0,
    -remove_comment     => 1,
    -separator  => ', ',
    -separator_long     => ', ',
    -max        => 0,
    #value_type
    -value_unsafe_rule  => 'NON_http_token_wsp',
  );
  $self->SUPER::_init (%DEFAULT, %options);
  $self->{value} = [];

## Keywords: foo, bar, "and so on"
## Newsgroups: local.test,local.foo,local.bar
## Accept: text/html; q=1.0, text/plain; q=0.03; *; q=0.01

  my %field_type = qw(accept-charset accept accept-encoding accept 
     accept-language accept
     content-language keywords
     followup-to newsgroups
     list-archive list- list-digest list- list-help list- 
     list-owner list- list-post list- list-subscribe list- 
     list-unsubscribe list- list-url list- uri list-
     posted-to newsgroups
     x-brother x-moe x-boss x-moe x-classmate x-moe x-daughter x-moe 
     x-dearfriend x-moe
     x-favoritesong x-moe 
     x-friend x-moe x-me x-moe
     x-respect x-moe x-sister x-moe x-son x-moe x-sublimate x-moe x-wife x-moe);
  my $field_name = lc $self->{option}->{field_name};
  $field_name = $field_type{$field_name} || $field_name;
  if ($field_name eq 'newsgroups') {
    $self->{option}->{separator} = ',';
    $self->{option}->{separator_long} = ', ';
    $self->{option}->{long_count} = 5;
    $self->{option}->{value_unsafe_rule} = 'NON_component';
    $self->{option}->{encoding_after_encode} = 'utf-8';
  } elsif ($field_name eq 'distribution') {
    $self->{option}->{separator} = ',';
    $self->{option}->{separator_long} = ', ';
    $self->{option}->{long_count} = 15;
    $self->{option}->{value_unsafe_rule} = 'NON_distribution';
  } elsif ($field_name eq 'x-moe') {
    $self->{option}->{is_quoted_string} = 0;
    $self->{option}->{value_type}->{'*default'} = ['Message::Field::XMoe'];
  } elsif ($field_name eq 'accept') {
    $self->{option}->{is_quoted_string} = 0;
    $self->{option}->{value_type}->{'*default'} = ['Message::Field::ValueParams'];
  } elsif ($field_name eq 'list-') {
    $self->{option}->{is_quoted_string} = 0;
    $self->{option}->{remove_comment} = 0;
    $self->{option}->{value_type}->{'*default'} = ['Message::Field::URI'];
  #} elsif ($field_name eq 'p3p') {
  #  $self->{option}->{is_quoted_string} = 0;
  #  $self->{option}->{value_type}->{'*default'} = ['Message::Field::Params'];
  } elsif ($field_name eq 'encrypted') {
    $self->{option}->{max} = 2;
  }
  
  if (ref $options{value} eq 'ARRAY') {
    $self->add (@{$options{value}});
  } elsif ($options{value}) {
    $self->add ($options{value});
  }
  $self;
}

=item $csv = Message::Field::CSV->new ([%options])

Constructs a new object.  You might pass some options as parameters 
to the constructor.

=cut

## Inherited

=item $csv = Message::Field::CSV->parse ($field-body, [%options])

Constructs a new object with given field body.  You might pass 
some options as parameters to the constructor.

=cut

sub parse ($$;%) {
  my $class = shift;
  my $self = bless {}, $class;
  my $field_body = shift;
  $self->_init (@_);
  $field_body = Message::Util::delete_comment ($field_body)
    if $self->{option}->{remove_comment};
  push @{$self->{value}}, $self->_parse_list ($field_body);
  $self;
}

## Parses csv string and returns array
sub _parse_list ($$) {
  my $self = shift;
  my $fb = shift;
  my @ids;
  $fb =~ s{((?:$REG{quoted_string}|$REG{angle_quoted}|$REG{domain_literal}|$REG{comment}|[^\x22\x28\x2C\x3C\x5B])+)}{
    my $s = $1;  $s =~ s/^$REG{WSP}+//;  $s =~ s/$REG{WSP}+$//;
    if ($self->{option}->{is_quoted_string}) {
      $s = $self->_parse_value ('*default' => 
        Message::Util::decode_quoted_string ($self, $s))
        if $self->{option}->{parse_all};
      push @ids, Message::Util::decode_quoted_string ($self, $s);
    } else {
      $s = $self->_parse_value ('*default' => $s) if $self->{option}->{parse_all};
      push @ids, $s;
    }
  }goex;
  @ids;
}

=back

=head1 METHODS

=over 4

=head2 $values = $csv->value ($index1, [$index2, $index3,...])

Returns C<$index>'th value(s).

=cut

sub value ($@) {
  my $self = shift;
  my @index = @_;
  my @ret = ();
  for (@index) {
    $self->{value}->[$_] = $self->_parse_value ('*default' => $self->{value}->[$_]);
    push @ret, $self->{value}->[$_];
  }
  @ret;
}

=item $number = $csv->count

Returns number of values.

=cut

sub count ($) {
  my $self = shift;
  $self->_delete_empty;
  $#{$self->{value}}+1;
}

=iterm $csv->add ($value1, [$value2, $value3,...])

Adds (appends) new value(s).

=cut

sub _add_array_check ($$\%) {
  my $self = shift;
  my ($value, $option) = @_;
  my $value_option = {};
  if (ref $value eq 'ARRAY') {
    ($value, %$value_option) = @$value;
  }
  (1, value => $value);
}

=item $field-body = $csv->stringify ()

Returns C<field-body> as a string.

=cut

sub stringify ($;%) {
  my $self = shift;
  my %o = @_;
  my %option = %{$self->{option}};
  for (grep {/^-/} keys %o) {$option{substr ($_, 1)} = $o{$_}}
  $self->_delete_empty;
  $option{max}--;
  $option{max} = $#{$self->{value}} if $option{max} <= 0;
  $option{max} = $#{$self->{value}} if $#{$self->{value}} < $option{max};
  $option{separator} = $option{separator_long}
    if $option{max} >= $option{long_count};
  join $option{separator}, 
    map {$self->_stringify_item ($_, \%option)} @{$self->{value}}[0..$option{max}];
}
*as_string = \&stringify;

sub _stringify_item ($$\%) {
  my $self = shift;
  my $item = shift;
  my $option = shift;
      if ($$option{is_quoted_string}) {
        my %s = &{$$option{hook_encode_string}} ($self, 
          $item, type => 'phrase');
        Message::Util::quote_unsafe_string ($s{value}, 
          unsafe => $$option{value_unsafe_rule});
      } else {
        $item;
      }
}

=item $option-value = $csv->option ($option-name)

Gets option value.

=item $csv->option ($option-name, $option-value, ...)

Set option value(s).  You can pass multiple option name-value pair
as parameter when setting.

=cut

## Inherited

=item $type = $csv->value_type

Gets value-type.  Value-type is package name of module
used for value modification.  A special value-type, ':none:'
is used to indicate values are non-structured (and no module
is automatically used).

=item $csv->value_type ([$type])

Set value-type.

=cut

sub value_type ($;$) {
  my $self = shift;
  my $new_value_type = shift;
  if (ref $new_value_type eq 'ARRAY') {
    $self->{option}->{value_type} = $new_value_type;
  } elsif ($new_value_type) {
    $self->{option}->{value_type}->[0] = $new_value_type;
  }
  $self->{option}->{value_type}->[0] || ':none:';
}

=item $clone = $ua->clone ()

Returns a copy of the object.

=cut

## clone, method_available: Inherited

=back

=cut

## Internal functions

sub _delete_empty ($) {
  my $self = shift;
  $self->{value} = [grep {length $_} @{$self->{value}}];
}

=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/08 09:11:31 $

=cut

1;
1	wakaba	1.1
2			=head1 NAME
3
4	wakaba	1.7	Message::Field::CSV --- Perl module for Internet message
5			field body consist of comma separated values
6	wakaba	1.1
7			=cut
8
9			package Message::Field::CSV;
10			require 5.6.0;
11			use strict;
12			use re 'eval';
13	wakaba	1.7	use vars qw(@ISA %REG $VERSION);
14	wakaba	1.11	$VERSION=do{my @r=(q$Revision: 1.10 $=~/\d+/g);sprintf "%d."."%02d" x $#r,@r};
15	wakaba	1.4	require Message::Util;
16	wakaba	1.7	require Message::Field::Structured;
17			push @ISA, qw(Message::Field::Structured);
18
19			use overload '""' => sub { $_[0]->stringify },
20			'0+' => sub { $_[0]->count },
21	wakaba	1.9	'@{}' => sub { $_[0]->{value} }, ## SHOULD NOT be used
22	wakaba	1.7	'.=' => sub { $_[0]->add ($_[1]); $_[0] },
23			fallback => 1;
24
25			*REG = \%Message::Util::REG;
26			## Inherited: comment, quoted_string, domain_literal, angle_quoted
27			## WSP, FWS, atext
28
29			## From usefor-article
30			$REG{NON_component} = qr/[^\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5F\x61-\x7A\x80-\xFF\x2F\x3D\x3F]/;
31			$REG{NON_distribution} = qr/[^\x21\x2B\x2D\x30-\x39\x41-\x5A\x5F\x61-\x7A]/;
32
33			=head1 CONSTRUCTORS
34
35			The following methods construct new objects:
36
37			=over 4
38
39			=cut
40
41			## Initialize of this class -- called by constructors
42			sub _init ($;%) {
43			my $self = shift;
44			my %options = @_;
45			my %DEFAULT = (
46	wakaba	1.10	-_ARRAY_NAME => 'value',
47	wakaba	1.11	-_MEMBERS => [qw\|value_type\|],
48			-_METHODS => [qw\|add replace count delete item
49			comment_add comment_delete comment_count
50			comment_item\|],
51	wakaba	1.9	#encoding_after_encode
52			#encoding_before_decode
53	wakaba	1.7	-field_name => 'keywords',
54	wakaba	1.9	#format
55			#hook_encode_string
56			#hook_decode_string
57	wakaba	1.7	-is_quoted_string => 1, ## Can itself quoted-string?
58			-long_count => 10,
59			-parse_all => 0,
60			-remove_comment => 1,
61			-separator => ', ',
62			-separator_long => ', ',
63			-max => 0,
64	wakaba	1.9	#value_type
65	wakaba	1.7	-value_unsafe_rule => 'NON_http_token_wsp',
66			);
67			$self->SUPER::_init (%DEFAULT, %options);
68			$self->{value} = [];
69	wakaba	1.1
70			## Keywords: foo, bar, "and so on"
71			## Newsgroups: local.test,local.foo,local.bar
72			## Accept: text/html; q=1.0, text/plain; q=0.03; *; q=0.01
73
74			my %field_type = qw(accept-charset accept accept-encoding accept
75			accept-language accept
76	wakaba	1.2	content-language keywords
77	wakaba	1.1	followup-to newsgroups
78	wakaba	1.4	list-archive list- list-digest list- list-help list-
79			list-owner list- list-post list- list-subscribe list-
80			list-unsubscribe list- list-url list- uri list-
81	wakaba	1.6	posted-to newsgroups
82	wakaba	1.10	x-brother x-moe x-boss x-moe x-classmate x-moe x-daughter x-moe
83			x-dearfriend x-moe
84	wakaba	1.9	x-favoritesong x-moe
85			x-friend x-moe x-me x-moe
86			x-respect x-moe x-sister x-moe x-son x-moe x-sublimate x-moe x-wife x-moe);
87	wakaba	1.7	my $field_name = lc $self->{option}->{field_name};
88	wakaba	1.1	$field_name = $field_type{$field_name} \|\| $field_name;
89	wakaba	1.2	if ($field_name eq 'newsgroups') {
90			$self->{option}->{separator} = ',';
91	wakaba	1.4	$self->{option}->{separator_long} = ', ';
92			$self->{option}->{long_count} = 5;
93			$self->{option}->{value_unsafe_rule} = 'NON_component';
94	wakaba	1.5	$self->{option}->{encoding_after_encode} = 'utf-8';
95	wakaba	1.4	} elsif ($field_name eq 'distribution') {
96			$self->{option}->{separator} = ',';
97			$self->{option}->{separator_long} = ', ';
98			$self->{option}->{long_count} = 15;
99			$self->{option}->{value_unsafe_rule} = 'NON_distribution';
100	wakaba	1.2	} elsif ($field_name eq 'x-moe') {
101	wakaba	1.7	$self->{option}->{is_quoted_string} = 0;
102	wakaba	1.9	$self->{option}->{value_type}->{'*default'} = ['Message::Field::XMoe'];
103	wakaba	1.1	} elsif ($field_name eq 'accept') {
104	wakaba	1.7	$self->{option}->{is_quoted_string} = 0;
105	wakaba	1.9	$self->{option}->{value_type}->{'*default'} = ['Message::Field::ValueParams'];
106	wakaba	1.4	} elsif ($field_name eq 'list-') {
107	wakaba	1.7	$self->{option}->{is_quoted_string} = 0;
108			$self->{option}->{remove_comment} = 0;
109	wakaba	1.9	$self->{option}->{value_type}->{'*default'} = ['Message::Field::URI'];
110	wakaba	1.8	#} elsif ($field_name eq 'p3p') {
111			# $self->{option}->{is_quoted_string} = 0;
112	wakaba	1.9	# $self->{option}->{value_type}->{'*default'} = ['Message::Field::Params'];
113	wakaba	1.1	} elsif ($field_name eq 'encrypted') {
114			$self->{option}->{max} = 2;
115			}
116	wakaba	1.7
117			if (ref $options{value} eq 'ARRAY') {
118			$self->add (@{$options{value}});
119			} elsif ($options{value}) {
120			$self->add ($options{value});
121			}
122	wakaba	1.1	$self;
123			}
124
125	wakaba	1.7	=item $csv = Message::Field::CSV->new ([%options])
126	wakaba	1.1
127	wakaba	1.7	Constructs a new object. You might pass some options as parameters
128			to the constructor.
129	wakaba	1.1
130			=cut
131
132	wakaba	1.7	## Inherited
133	wakaba	1.1
134	wakaba	1.7	=item $csv = Message::Field::CSV->parse ($field-body, [%options])
135	wakaba	1.1
136	wakaba	1.7	Constructs a new object with given field body. You might pass
137			some options as parameters to the constructor.
138	wakaba	1.1
139			=cut
140
141			sub parse ($$;%) {
142	wakaba	1.7	my $class = shift;
143			my $self = bless {}, $class;
144	wakaba	1.1	my $field_body = shift;
145	wakaba	1.7	$self->_init (@_);
146			$field_body = Message::Util::delete_comment ($field_body)
147			if $self->{option}->{remove_comment};
148			push @{$self->{value}}, $self->_parse_list ($field_body);
149	wakaba	1.1	$self;
150			}
151
152	wakaba	1.7	## Parses csv string and returns array
153	wakaba	1.1	sub _parse_list ($$) {
154			my $self = shift;
155			my $fb = shift;
156			my @ids;
157	wakaba	1.7	$fb =~ s{((?:$REG{quoted_string}\|$REG{angle_quoted}\|$REG{domain_literal}\|$REG{comment}\|[^\x22\x28\x2C\x3C\x5B])+)}{
158	wakaba	1.1	my $s = $1; $s =~ s/^$REG{WSP}+//; $s =~ s/$REG{WSP}+$//;
159	wakaba	1.7	if ($self->{option}->{is_quoted_string}) {
160	wakaba	1.9	$s = $self->_parse_value ('*default' =>
161			Message::Util::decode_quoted_string ($self, $s))
162	wakaba	1.7	if $self->{option}->{parse_all};
163			push @ids, Message::Util::decode_quoted_string ($self, $s);
164	wakaba	1.1	} else {
165	wakaba	1.9	$s = $self->_parse_value ('*default' => $s) if $self->{option}->{parse_all};
166	wakaba	1.7	push @ids, $s;
167	wakaba	1.1	}
168			}goex;
169			@ids;
170			}
171
172	wakaba	1.7	=back
173
174			=head1 METHODS
175
176			=over 4
177
178			=head2 $values = $csv->value ($index1, [$index2, $index3,...])
179
180			Returns C<$index>'th value(s).
181
182			=cut
183
184			sub value ($@) {
185			my $self = shift;
186			my @index = @_;
187			my @ret = ();
188			for (@index) {
189	wakaba	1.9	$self->{value}->[$_] = $self->_parse_value ('*default' => $self->{value}->[$_]);
190	wakaba	1.7	push @ret, $self->{value}->[$_];
191			}
192			@ret;
193			}
194
195			=item $number = $csv->count
196	wakaba	1.1
197	wakaba	1.7	Returns number of values.
198	wakaba	1.1
199			=cut
200
201	wakaba	1.7	sub count ($) {
202			my $self = shift;
203			$self->_delete_empty;
204			$#{$self->{value}}+1;
205			}
206
207			=iterm $csv->add ($value1, [$value2, $value3,...])
208
209			Adds (appends) new value(s).
210	wakaba	1.1
211			=cut
212
213	wakaba	1.10	sub _add_array_check ($$\%) {
214	wakaba	1.1	my $self = shift;
215	wakaba	1.10	my ($value, $option) = @_;
216			my $value_option = {};
217			if (ref $value eq 'ARRAY') {
218			($value, %$value_option) = @$value;
219			}
220			(1, value => $value);
221	wakaba	1.1	}
222
223	wakaba	1.7	=item $field-body = $csv->stringify ()
224
225			Returns C<field-body> as a string.
226
227			=cut
228
229	wakaba	1.1	sub stringify ($;%) {
230			my $self = shift;
231	wakaba	1.7	my %o = @_;
232			my %option = %{$self->{option}};
233			for (grep {/^-/} keys %o) {$option{substr ($_, 1)} = $o{$_}}
234			$self->_delete_empty;
235	wakaba	1.1	$option{max}--;
236	wakaba	1.7	$option{max} = $#{$self->{value}} if $option{max} <= 0;
237			$option{max} = $#{$self->{value}} if $#{$self->{value}} < $option{max};
238	wakaba	1.4	$option{separator} = $option{separator_long}
239			if $option{max} >= $option{long_count};
240	wakaba	1.1	join $option{separator},
241	wakaba	1.10	map {$self->_stringify_item ($_, \%option)} @{$self->{value}}[0..$option{max}];
242			}
243			*as_string = \&stringify;
244
245			sub _stringify_item ($$\%) {
246			my $self = shift;
247			my $item = shift;
248			my $option = shift;
249			if ($$option{is_quoted_string}) {
250			my %s = &{$$option{hook_encode_string}} ($self,
251			$item, type => 'phrase');
252	wakaba	1.7	Message::Util::quote_unsafe_string ($s{value},
253	wakaba	1.10	unsafe => $$option{value_unsafe_rule});
254	wakaba	1.3	} else {
255	wakaba	1.10	$item;
256	wakaba	1.3	}
257	wakaba	1.1	}
258	wakaba	1.7
259	wakaba	1.11	=item $option-value = $csv->option ($option-name)
260	wakaba	1.7
261			Gets option value.
262	wakaba	1.1
263	wakaba	1.7	=item $csv->option ($option-name, $option-value, ...)
264	wakaba	1.4
265	wakaba	1.7	Set option value(s). You can pass multiple option name-value pair
266			as parameter when setting.
267	wakaba	1.4
268			=cut
269
270	wakaba	1.7	## Inherited
271
272			=item $type = $csv->value_type
273
274			Gets value-type. Value-type is package name of module
275			used for value modification. A special value-type, ':none:'
276			is used to indicate values are non-structured (and no module
277			is automatically used).
278
279			=item $csv->value_type ([$type])
280
281			Set value-type.
282
283			=cut
284	wakaba	1.4
285	wakaba	1.7	sub value_type ($;$) {
286	wakaba	1.5	my $self = shift;
287			my $new_value_type = shift;
288	wakaba	1.7	if (ref $new_value_type eq 'ARRAY') {
289			$self->{option}->{value_type} = $new_value_type;
290			} elsif ($new_value_type) {
291	wakaba	1.5	$self->{option}->{value_type}->[0] = $new_value_type;
292			}
293			$self->{option}->{value_type}->[0] \|\| ':none:';
294			}
295
296	wakaba	1.7	=item $clone = $ua->clone ()
297	wakaba	1.1
298	wakaba	1.7	Returns a copy of the object.
299	wakaba	1.1
300	wakaba	1.7	=cut
301	wakaba	1.1
302	wakaba	1.11	## clone, method_available: Inherited
303	wakaba	1.1
304	wakaba	1.7	=back
305	wakaba	1.1
306			=cut
307
308	wakaba	1.7	## Internal functions
309	wakaba	1.1
310	wakaba	1.7	sub _delete_empty ($) {
311	wakaba	1.1	my $self = shift;
312	wakaba	1.7	$self->{value} = [grep {length $_} @{$self->{value}}];
313	wakaba	1.1	}
314
315			=head1 LICENSE
316
317			Copyright 2002 wakaba E<lt>w@suika.fam.cxE<gt>.
318
319			This program is free software; you can redistribute it and/or modify
320			it under the terms of the GNU General Public License as published by
321			the Free Software Foundation; either version 2 of the License, or
322			(at your option) any later version.
323
324			This program is distributed in the hope that it will be useful,
325			but WITHOUT ANY WARRANTY; without even the implied warranty of
326			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
327			GNU General Public License for more details.
328
329			You should have received a copy of the GNU General Public License
330			along with this program; see the file COPYING. If not, write to
331			the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
332			Boston, MA 02111-1307, USA.
333
334			=head1 CHANGE
335
336			See F<ChangeLog>.
337	wakaba	1.11	$Date: 2002/05/08 09:11:31 $
338	wakaba	1.1
339			=cut
340
341			1;