1 package SL::ReportGenerator;
4 use List::Util qw(max);
10 # Cause locales.pl to parse these files:
11 # parse_html_template('report_generator/html_report')
18 $self->{myconfig} = shift;
19 $self->{form} = shift;
23 'std_column_visibility' => 0,
24 'output_format' => 'HTML',
25 'allow_pdf_export' => 1,
26 'allow_csv_export' => 1,
27 'html_template' => 'report_generator/html_report',
30 'orientation' => 'landscape',
31 'font_name' => 'Verdana',
35 'margin_bottom' => 1.5,
36 'margin_right' => 1.5,
46 'eol_style' => 'Unix',
52 'variable_list' => [],
55 $self->{data_present} = 0;
59 $self->set_options(@_) if (@_);
68 $self->{columns} = \%columns;
70 foreach my $column (values %{ $self->{columns} }) {
71 $column->{visible} = $self->{options}->{std_column_visibility} unless defined $column->{visible};
74 $self->set_column_order(sort keys %{ $self->{columns} });
77 sub set_column_order {
80 $self->{column_order} = [ grep { !$seen{$_}++ } @_, sort keys %{ $self->{columns} } ];
83 sub set_sort_indicator {
86 $self->{options}->{sort_indicator_column} = shift;
87 $self->{options}->{sort_indicator_direction} = shift;
95 while (my $arg = shift) {
98 if ('ARRAY' eq ref $arg) {
101 } elsif ('HASH' eq ref $arg) {
105 $self->{form}->error('Incorrect usage -- expecting hash or array ref');
108 my @columns_with_default_alignment = grep { defined $self->{columns}->{$_}->{align} } keys %{ $self->{columns} };
110 foreach my $row (@{ $row_set }) {
111 foreach my $column (@columns_with_default_alignment) {
112 $row->{$column} ||= { };
113 $row->{$column}->{align} = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align});
116 foreach my $field (qw(data link)) {
117 map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row };
121 push @{ $self->{data} }, $row_set;
122 $last_row_set = $row_set;
124 $self->{data_present} = 1;
127 return $last_row_set;
133 push @{ $self->{data} }, { 'type' => 'separator' };
140 push @{ $self->{data} }, $data;
147 $self->{data_present} = 0;
154 while (my ($key, $value) = each %options) {
155 if ($key eq 'pdf_export') {
156 map { $self->{options}->{pdf_export}->{$_} = $value->{$_} } keys %{ $value };
158 $self->{options}->{$key} = $value;
163 sub set_options_from_form {
166 my $form = $self->{form};
167 my $myconfig = $self->{myconfig};
169 foreach my $key (qw(output_format)) {
170 my $full_key = "report_generator_${key}";
171 $self->{options}->{$key} = $form->{$full_key} if (defined $form->{$full_key});
174 foreach my $format (qw(pdf csv)) {
175 my $opts = $self->{options}->{"${format}_export"};
176 foreach my $key (keys %{ $opts }) {
177 my $full_key = "report_generator_${format}_options_${key}";
178 $opts->{$key} = $key =~ /^margin/ ? $form->parse_amount($myconfig, $form->{$full_key}) : $form->{$full_key};
183 sub set_export_options {
188 'variable_list' => [ @_ ],
192 sub set_custom_headers {
196 $self->{custom_headers} = [ @_ ];
198 delete $self->{custom_headers};
202 sub get_attachment_basename {
204 my $filename = $self->{options}->{attachment_basename} || 'report';
205 $filename =~ s|.*\\||;
206 $filename =~ s|.*/||;
211 sub generate_with_headers {
213 my $format = lc $self->{options}->{output_format};
214 my $form = $self->{form};
216 if (!$self->{columns}) {
217 $form->error('Incorrect usage -- no columns specified');
220 if ($format eq 'html') {
221 my $title = $form->{title};
222 $form->{title} = $self->{title} if ($self->{title});
224 $form->{title} = $title;
226 print $self->generate_html_content();
228 } elsif ($format eq 'csv') {
229 my $filename = $self->get_attachment_basename();
230 print qq|content-type: text/csv\n|;
231 print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
232 $self->generate_csv_content();
234 } elsif ($format eq 'pdf') {
235 $self->generate_pdf_content();
238 $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
242 sub get_visible_columns {
246 return grep { my $c = $self->{columns}->{$_}; $c && $c->{visible} && (($c->{visible} == 1) || ($c->{visible} =~ /\Q${format}\E/i)) } @{ $self->{column_order} };
253 $value = $main::locale->quote_special_chars('HTML', $value);
255 $value =~ s/\n/<br>/g;
260 sub prepare_html_content {
263 my ($column, $name, @column_headers);
265 my $opts = $self->{options};
266 my @visible_columns = $self->get_visible_columns('HTML');
268 foreach $name (@visible_columns) {
269 $column = $self->{columns}->{$name};
273 'link' => $column->{link},
274 'text' => $column->{text},
275 'show_sort_indicator' => $name eq $opts->{sort_indicator_column},
276 'sort_indicator_direction' => $opts->{sort_indicator_direction},
279 push @column_headers, $header;
283 if ($self->{custom_headers}) {
284 $header_rows = $self->{custom_headers};
286 $header_rows = [ \@column_headers ];
289 my ($outer_idx, $inner_idx) = (0, 0);
293 foreach my $row_set (@{ $self->{data} }) {
294 if ('HASH' eq ref $row_set) {
295 if ($row_set->{type} eq 'separator') {
296 if (! scalar @rows) {
297 $next_border_top = 1;
299 $rows[-1]->{BORDER_BOTTOM} = 1;
307 'IS_COLSPAN_DATA' => $row_set->{type} eq 'colspan_data',
308 'NUM_COLUMNS' => scalar @visible_columns,
309 'BORDER_TOP' => $next_border_top,
310 'data' => $row_set->{data},
313 push @rows, $row_data;
315 $next_border_top = 0;
322 foreach my $row (@{ $row_set }) {
325 foreach my $col_name (@visible_columns) {
326 my $col = $row->{$col_name};
327 $col->{CELL_ROWS} = [ ];
328 foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
329 push @{ $col->{CELL_ROWS} }, {
330 'data' => $self->html_format($col->{data}->[$i]),
331 'link' => $col->{link}->[$i],
335 # Force at least a to be displayed so that browsers
336 # will format the table cell (e.g. borders etc).
337 if (!scalar @{ $col->{CELL_ROWS} }) {
338 push @{ $col->{CELL_ROWS} }, { 'data' => ' ' };
339 } elsif ((1 == scalar @{ $col->{CELL_ROWS} }) && (!defined $col->{CELL_ROWS}->[0]->{data} || ($col->{CELL_ROWS}->[0]->{data} eq ''))) {
340 $col->{CELL_ROWS}->[0]->{data} = ' ';
345 'COLUMNS' => [ map { $row->{$_} } @visible_columns ],
346 'outer_idx' => $outer_idx,
347 'outer_idx_odd' => $outer_idx % 2,
348 'inner_idx' => $inner_idx,
349 'BORDER_TOP' => $next_border_top,
352 push @rows, $row_data;
354 $next_border_top = 0;
358 my @export_variables = $self->{form}->flatten_variables(@{ $self->{export}->{variable_list} });
360 my $allow_pdf_export = $opts->{allow_pdf_export};
362 eval { require PDF::API2; require PDF::Table; };
363 $allow_pdf_export |= 1 if (! $@);
366 'TITLE' => $opts->{title},
367 'TOP_INFO_TEXT' => $self->html_format($opts->{top_info_text}),
368 'RAW_TOP_INFO_TEXT' => $opts->{raw_top_info_text},
369 'BOTTOM_INFO_TEXT' => $self->html_format($opts->{bottom_info_text}),
370 'RAW_BOTTOM_INFO_TEXT' => $opts->{raw_bottom_info_text},
371 'ALLOW_PDF_EXPORT' => $allow_pdf_export,
372 'ALLOW_CSV_EXPORT' => $opts->{allow_csv_export},
373 'SHOW_EXPORT_BUTTONS' => ($allow_pdf_export || $opts->{allow_csv_export}) && $self->{data_present},
374 'HEADER_ROWS' => $header_rows,
375 'NUM_COLUMNS' => scalar @column_headers,
377 'EXPORT_VARIABLES' => \@export_variables,
378 'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
379 'EXPORT_NEXTSUB' => $self->{export}->{nextsub},
380 'DATA_PRESENT' => $self->{data_present},
386 sub generate_html_content {
388 my $variables = $self->prepare_html_content();
390 return $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
396 return $_[0] * 72 / 2.54;
399 sub generate_pdf_content {
406 my $variables = $self->prepare_html_content();
407 my $form = $self->{form};
408 my $myconfig = $self->{myconfig};
410 my $opts = $self->{options};
411 my $pdfopts = $opts->{pdf_export};
413 my (@data, @column_props, @cell_props);
415 my ($data_row, $cell_props_row);
416 my @visible_columns = $self->get_visible_columns('HTML');
417 my $num_columns = scalar @visible_columns;
418 my $num_header_rows = 1;
420 foreach $name (@visible_columns) {
421 push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
424 if (!$self->{custom_headers}) {
426 $cell_props_row = [];
427 push @data, $data_row;
428 push @cell_props, $cell_props_row;
430 foreach $name (@visible_columns) {
431 $column = $self->{columns}->{$name};
433 push @{ $data_row }, $column->{text};
434 push @{ $cell_props_row }, {};
438 $num_header_rows = scalar @{ $self->{custom_headers} };
440 foreach my $custom_header_row (@{ $self->{custom_headers} }) {
442 $cell_props_row = [];
443 push @data, $data_row;
444 push @cell_props, $cell_props_row;
446 foreach my $custom_header_col (@{ $custom_header_row }) {
447 push @{ $data_row }, $custom_header_col->{text};
448 push @{ $cell_props_row }, {};
453 foreach my $row_set (@{ $self->{data} }) {
454 if ('HASH' eq ref $row_set) {
455 if ($row_set->{type} eq 'colspan_data') {
456 push @data, [ $row_set->{data} ];
458 $cell_props_row = [];
459 push @cell_props, $cell_props_row;
461 foreach (0 .. $num_columns - 1) {
462 push @{ $cell_props_row }, { 'background_color' => '#666666',
463 'font_color' => '#ffffff',
464 'colspan' => $_ == 0 ? -1 : undef, };
470 foreach my $row (@{ $row_set }) {
472 push @data, $data_row;
475 foreach my $col_name (@visible_columns) {
476 my $col = $row->{$col_name};
477 push @{ $data_row }, join("\n", @{ $col->{data} });
479 $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
484 $cell_props_row = [];
485 push @cell_props, $cell_props_row;
487 foreach (0 .. $num_columns - 1) {
488 push @{ $cell_props_row }, { };
493 foreach my $i (0 .. scalar(@data) - 1) {
494 my $aref = $data[$i];
495 my $num_columns_here = scalar @{ $aref };
497 if ($num_columns_here < $num_columns) {
498 push @{ $aref }, ('') x ($num_columns - $num_columns_here);
499 } elsif ($num_columns_here > $num_columns) {
500 splice @{ $aref }, $num_columns;
505 'a3' => [ 842, 1190 ],
506 'a4' => [ 595, 842 ],
507 'a5' => [ 420, 595 ],
508 'letter' => [ 612, 792 ],
509 'legal' => [ 612, 1008 ],
512 my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
514 my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
515 my ($paper_width, $paper_height);
517 if (lc $pdfopts->{orientation} eq 'landscape') {
518 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[1, 0];
520 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[0, 1];
523 my $margin_top = _cm2bp($pdfopts->{margin_top} || 1.5);
524 my $margin_bottom = _cm2bp($pdfopts->{margin_bottom} || 1.5);
525 my $margin_left = _cm2bp($pdfopts->{margin_left} || 1.5);
526 my $margin_right = _cm2bp($pdfopts->{margin_right} || 1.5);
528 my $table = PDF::Table->new();
529 my $pdf = PDF::API2->new();
530 my $page = $pdf->page();
532 $pdf->mediabox($paper_width, $paper_height);
534 my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
535 '-encoding' => $main::dbcharset || 'ISO-8859-15');
536 my $font_size = $pdfopts->{font_size} || 7;
537 my $title_font_size = $font_size + 1;
539 my $font_height = $font_size + 2 * $padding;
540 my $title_font_height = $font_size + 2 * $padding;
542 my $header_height = 2 * $title_font_height if ($opts->{title});
543 my $footer_height = 2 * $font_height if ($pdfopts->{number});
545 my $top_text_height = 0;
547 if ($self->{options}->{top_info_text}) {
548 my $top_text = $self->{options}->{top_info_text};
549 $top_text =~ s/\r//g;
550 $top_text =~ s/\n+$//;
552 my @lines = split m/\n/, $top_text;
553 $top_text_height = $font_height * scalar @lines;
555 foreach my $line_no (0 .. scalar(@lines) - 1) {
556 my $y_pos = $paper_height - $margin_top - $header_height - $line_no * $font_height;
557 my $text_obj = $page->text();
559 $text_obj->font($font, $font_size);
560 $text_obj->translate($margin_left, $y_pos);
561 $text_obj->text($lines[$line_no]);
569 'w' => $paper_width - $margin_left - $margin_right,
570 'start_y' => $paper_height - $margin_top - $header_height - $top_text_height,
571 'next_y' => $paper_height - $margin_top - $header_height,
572 'start_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height - $top_text_height,
573 'next_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height,
575 'background_color_odd' => '#ffffff',
576 'background_color_even' => '#eeeeee',
578 'font_size' => $font_size,
579 'font_color' => '#000000',
580 'num_header_rows' => $num_header_rows,
582 'bg_color' => '#ffffff',
584 'font_color' => '#000000',
586 'column_props' => \@column_props,
587 'cell_props' => \@cell_props,
590 foreach my $page_num (1..$pdf->pages()) {
591 my $curpage = $pdf->openpage($page_num);
593 if ($pdfopts->{number}) {
594 my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages());
595 my $text_obj = $curpage->text();
597 $text_obj->font($font, $font_size);
598 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($label) / 2, $margin_bottom);
599 $text_obj->text($label);
602 if ($opts->{title}) {
603 my $text_obj = $curpage->text();
605 $text_obj->font($font, $title_font_size);
606 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($opts->{title}) / 2,
607 $paper_height - $margin_top);
608 $text_obj->text($opts->{title}, '-underline' => 1);
612 my $content = $pdf->stringify();
615 if ($pdfopts->{print} && $pdfopts->{printer_id}) {
616 $form->{printer_id} = $pdfopts->{printer_id};
617 $form->get_printer_code($myconfig);
618 $printer_command = $form->{printer_command};
621 if ($printer_command) {
622 $self->_print_content('printer_command' => $printer_command,
623 'content' => $content,
624 'copies' => $pdfopts->{copies});
625 $form->{report_generator_printed} = 1;
628 my $filename = $self->get_attachment_basename();
630 print qq|content-type: application/pdf\n|;
631 print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
637 sub verify_paper_size {
639 my $requested_paper_size = lc shift;
640 my $default_paper_size = shift;
642 my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
644 return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
651 foreach my $i (1 .. max $params{copies}, 1) {
652 my $printer = IO::File->new("| $params{printer_command}");
653 $main::form->error($main::locale->text('Could not spawn the printer command.')) if (!$printer);
654 $printer->print($params{content});
659 sub unescape_string {
662 my $iconv = $main::locale->{iconv};
664 $text = $main::locale->unquote_special_chars('HTML', $text);
665 $text = $main::locale->{iconv}->convert($text) if ($main::locale->{iconv});
670 sub generate_csv_content {
673 my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
674 my %valid_escape_chars = ('"' => 1, "'" => 1);
675 my %valid_quote_chars = ('"' => 1, "'" => 1);
677 my $opts = $self->{options}->{csv_export};
678 my $eol = $opts->{eol_style} eq 'DOS' ? "\r\n" : "\n";
679 my $sep_char = $valid_sep_chars{$opts->{sep_char}} ? $valid_sep_chars{$opts->{sep_char}} : ';';
680 my $escape_char = $valid_escape_chars{$opts->{escape_char}} ? $opts->{escape_char} : '"';
681 my $quote_char = $valid_quote_chars{$opts->{quote_char}} ? $opts->{quote_char} : '"';
683 $escape_char = $quote_char if ($opts->{escape_char} eq 'QUOTE_CHAR');
685 my $csv = Text::CSV_XS->new({ 'binary' => 1,
686 'sep_char' => $sep_char,
687 'escape_char' => $escape_char,
688 'quote_char' => $quote_char,
691 my $stdout = wraphandle(\*STDOUT);
692 my @visible_columns = $self->get_visible_columns('CSV');
694 if ($opts->{headers}) {
695 if (!$self->{custom_headers}) {
696 $csv->print($stdout, [ map { $self->unescape_string($self->{columns}->{$_}->{text}) } @visible_columns ]);
699 foreach my $custom_header_row (@{ $self->{custom_headers} }) {
700 $csv->print($stdout, [ map { $self->unescape_string($_->{text}) } @{ $custom_header_row } ]);
705 foreach my $row_set (@{ $self->{data} }) {
706 next if ('ARRAY' ne ref $row_set);
707 foreach my $row (@{ $row_set }) {
709 foreach my $col (@visible_columns) {
710 push @data, join($eol, map { s/\r?\n/$eol/g; $_ } @{ $row->{$col}->{data} });
712 $csv->print($stdout, \@data);
723 SL::ReportGenerator.pm: the Lx-Office way of getting data in shape
727 my $report = SL::ReportGenerator->new(\%myconfig, $form);
728 $report->set_options(%options); # optional
729 $report->set_columns(%column_defs);
730 $report->set_sort_indicator($column, $direction); # optional
731 $report->add_data($row1, $row2, @more_rows);
732 $report->generate_with_headers();
734 This creates a report object, sets a few columns, adds some data and generates a standard report.
735 Sorting of columns will be alphabetic, and options will be set to their defaults.
736 The report will be printed including table headers, html headers and http headers.
740 Imagine the following scenario:
741 There's a simple form, which loads some data from the database, and needs to print it out. You write a template for it.
742 Then there may be more than one line. You add a loop in the template.
743 Then there are some options made by the user, such as hidden columns. You add more to the template.
744 Then it lacks usability. You want it to be able to sort the data. You add code for that.
745 Then there are too many results, you need pagination, you want to print or export that data..... and so on.
747 The ReportGenerator class was designed because this exact scenario happened about half a dozen times in Lx-Office.
748 It's purpose is to manage all those formating, culling, sorting, and templating.
749 Which makes it almost as complicated to use as doing the work for yourself.
755 =item new \%myconfig,$form,%options
757 Creates a new ReportGenerator object, sets all given options, and returns it.
759 =item set_columns %columns
761 Sets the columns available to this report.
763 =item set_column_order @columns
765 Sets the order of columns. Any columns not present here are appended in alphabetic order.
767 =item set_sort_indicator $column,$direction
769 Sets sorting ot the table by specifying a column and a direction, where the direction will be evaluated to ascending if true.
770 Note that this is only for displaying. The data has to be presented already sorted.
772 =item add_data \@data
774 =item add_data \%data
776 Adds data to the report. A given hash_ref is interpreted as a single line of data, every array_ref as a collection of lines.
777 Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted.
778 ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by.
782 Adds a separator line to the report.
784 =item add_control \%data
786 Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
787 Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
788 Currently the only control element is a colspan element, which can be used as a mini header further down the report.
792 Deletes all data filled into the report, but keeps options set.
794 =item set_options %options
796 Sets options. For an incomplete list of options, see section configuration.
798 =item set_options_from_form
800 Tries to import options from the $form object given at creation
802 =item set_export_options $next_sub,@variable_list
804 Sets next_sub and additional variables needed for export.
806 =item get_attachment_basename
808 Returns the set attachment_basename option, or 'report' if nothing was set. See configuration for the option.
810 =item generate_with_headers
812 Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
813 for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
815 =item get_visible_columns $format
817 Returns a list of columns that will be visible in the report after considering all options or match the given format.
819 =item html_format $value
821 Escapes HTML characters in $value and substitutes newlines with '<br>'. Returns the escaped $value.
823 =item prepare_html_content $column,$name,@column_headers
825 Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
826 Should not be called extrenally, since all render and generate functions invoke it anyway.
828 =item generate_html_content
830 The html generation function. Is invoked by generate_with_headers.
832 =item generate_pdf_content
834 The PDF generation function. It is invoked by generate_with_headers, tests whether or not the Perl module PDF::API2 is installed and calls render_pdf_with_pdf_api2 if it is and render_pdf_with_html2ps otherwise.
836 =item generate_csv_content
838 The CSV generation function. Uses XS_CSV to parse the information into csv.
840 =item render_pdf_with_pdf_api2
842 PDF render function using the Perl module PDF::API2.
844 =item render_pdf_with_html2ps
846 PDF render function using the external application html2ps.
852 These are known options and their defaults. Options for pdf export and csv export need to be set as a hashref inside the export option.
854 =head2 General Options
858 =item std_column_visibility
860 Standard column visibility. Used if no visibility is set. Use this to save the trouble of enabling every column. Default is no.
864 Output format. Used by generate_with_headers to determine the format. Supported options are HTML, CSV, and PDF. Default is HTML.
866 =item allow_pdf_export
868 Used to determine if a button for PDF export should be displayed. Default is yes. The PDF button is hidden if neither the Perl module PDF::API2 nor the external applications html2ps and Ghostscript are available regardless of this parameter's value.
870 =item allow_csv_export
872 Used to determine if a button for CSV export should be displayed. Default is yes.
876 The template to be used for HTML reports. Default is 'report_generator/html_report'.
886 Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
888 =item orientation (landscape)
890 Landscape or portrait. Default is landscape.
894 Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
898 Default is 7. This option only affects the rendering with PDF::API2.
908 The paper margins in cm. They all default to 1.5.
912 Set to a true value if the pages should be numbered. Default is 1.
916 If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
934 Character to enclose entries. Default is double quote (").
938 Character to separate entries. Default is semicolon (;).
942 Character to escape the quote_char. Default is double quote (").
946 End of line style. Default is Unix.
950 Include headers? Default is yes.
958 =head1 MODULE AUTHORS
960 Moritz Bunkus E<lt>mbunkus@linet-services.deE<gt>
962 L<http://linet-services.de>