add plugin safe/rebuild info (part 3 of 3)
[ikiwiki.git] / IkiWiki / Plugin / table.pm
index c08087c713a612e2086657aea3ffbb62fb216c25..1302646b130084fefd87456d2f905b8c4c2cfea6 100644 (file)
@@ -3,75 +3,99 @@ package IkiWiki::Plugin::table;
 
 use warnings;
 use strict;
+use Encode;
+use IkiWiki 2.00;
 
-use IkiWiki;
-use IkiWiki::Plugin::mdwn;
-
-my %defaults = (
-       data    => undef,
-       file    => undef,
-       format  => 'auto',
-       sep_char        =>  {
-               'csv'   => ',',
-               'dsv'   => '\|',
-       },
-       class   =>  undef,
-       header  =>  1,
-);
-                            
 sub import { #{{{
+       hook(type => "getsetup", id => "table", call => \&getsetup);
        hook(type => "preprocess", id => "table", call => \&preprocess);
 } # }}}
 
+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+} #}}}
+
 sub preprocess (@) { #{{{
-       my %params = (%defaults, @_);
+       my %params =(
+               format  => 'auto',
+               header  => 'yes',
+               @_
+       );
 
-       if (defined $params{delimiter}) {
-               $params{sep_char}->{$params{format}} = $params{delimiter};
-       }
-       if (defined $params{file}) {
+       if (exists $params{file}) {
                if (! $pagesources{$params{file}}) {
-                       return "[[table ".gettext("cannot find file")."]]";
+                       error gettext("cannot find file");
                }
                $params{data} = readfile(srcfile($params{file}));
+               add_depends($params{page}, $params{file});
        }
 
        if (lc $params{format} eq 'auto') {
                # first try the more simple format
                if (is_dsv_data($params{data})) {
                        $params{format} = 'dsv';
-                       $params{sep_char}->{dsv} = '\|';
                }
                else {
                        $params{format} = 'csv';
-                       $params{sep_char}->{csv} = ',';
                }
        }
 
        my @data;
        if (lc $params{format} eq 'csv') {
-               @data=read_csv(\%params);
+               @data=split_csv($params{data},
+                       defined $params{delimiter} ? $params{delimiter} : ",",);
+               # linkify after parsing since html link quoting can
+               # confuse CSV parsing
+               if (! exists $params{file}) {
+                       @data=map {
+                               [ map {
+                                       IkiWiki::linkify($params{page},
+                                               $params{destpage}, $_);
+                               } @$_ ]
+                       } @data;
+               }
        }
        elsif (lc $params{format} eq 'dsv') {
-               @data=read_dsv(\%params);
+               # linkify before parsing since wikilinks can contain the
+               # delimiter
+               if (! exists $params{file}) {
+                       $params{data} = IkiWiki::linkify($params{page},
+                               $params{destpage}, $params{data});
+               }
+               @data=split_dsv($params{data},
+                       defined $params{delimiter} ? $params{delimiter} : "|",);
        }
        else {
-               return "[[table ".gettext("unknown data format")."]]";
+               error gettext("unknown data format");
        }
-       
+
        my $header;
-       if ($params{header} != 1) {
+       if (lc($params{header}) eq "yes") {
                $header=shift @data;
        }
        if (! @data) {
-               return "[[table ".gettext("empty data")."]]";
+               error gettext("empty data");
        }
 
-       my $html = tidy_up(open_table(\%params, $header),
-                       build_rows(\%params, @data),
-                       close_table(\%params, $header));
-
-       if (defined $params{file}) {
+       my @lines;
+       push @lines, defined $params{class}
+                       ? "<table class=\"".$params{class}.'">'
+                       : '<table>';
+       push @lines, "\t<thead>",
+               genrow($params{page}, $params{destpage}, "th", @$header),
+               "\t</thead>" if defined $header;
+       push @lines, "\t<tbody>" if defined $header;
+       push @lines, genrow($params{page}, $params{destpage}, "td", @$_)
+               foreach @data;
+       push @lines, "\t</tbody>" if defined $header;
+       push @lines, '</table>';
+       my $html = join("\n", @lines);
+
+       if (exists $params{file}) {
                return $html."\n\n".
                        htmllink($params{page}, $params{destpage}, $params{file},
                                linktext => gettext('Direct data download'));
@@ -81,20 +105,6 @@ sub preprocess (@) { #{{{
        }            
 } #}}}
 
-sub tidy_up (@) { #{{{
-       my $html="";
-
-       foreach my $text (@_) {
-               my $indentation = $text =~ m{thead>|tbody>}   ? 0 :
-                                 $text =~ m{tr>}             ? 4 :
-                                 $text =~ m{td>|th>}         ? 8 :
-                                                               0;
-               $html .= (' ' x $indentation)."$text\n";
-       }
-
-       return $html;
-} #}}}
-
 sub is_dsv_data ($) { #{{{
        my $text = shift;
 
@@ -102,15 +112,16 @@ sub is_dsv_data ($) { #{{{
        return $line =~ m{.+\|};
 }
 
-sub read_csv ($) { #{{{
-       my $params=shift;
-       my @text_lines = split(/\n/, $params->{data});
+sub split_csv ($$) { #{{{
+       my @text_lines = split(/\n/, shift);
+       my $delimiter = shift;
 
        eval q{use Text::CSV};
        error($@) if $@;
        my $csv = Text::CSV->new({ 
-               sep_char        => $params->{sep_char}->{csv},
+               sep_char        => $delimiter,
                binary          => 1,
+               allow_loose_quotes => 1,
        }) || error("could not create a Text::CSV object");
        
        my $l=0;
@@ -118,7 +129,7 @@ sub read_csv ($) { #{{{
        foreach my $line (@text_lines) {
                $l++;
                if ($csv->parse($line)) {
-                       push(@data, [ $csv->fields() ]);
+                       push(@data, [ map { decode_utf8 $_ } $csv->fields() ]);
                }
                else {
                        debug(sprintf(gettext('parse fail at line %d: %s'), 
@@ -129,72 +140,52 @@ sub read_csv ($) { #{{{
        return @data;
 } #}}}
 
-sub read_dsv ($) { #{{{
-       my $params = shift;
-       my @text_lines = split(/\n/, $params->{data});
+sub split_dsv ($$) { #{{{
+       my @text_lines = split(/\n/, shift);
+       my $delimiter = shift;
+       $delimiter="|" unless defined $delimiter;
 
        my @data;
-       my $splitter = qr{$params->{sep_char}->{dsv}};
        foreach my $line (@text_lines) {
-               push @data, [ split($splitter, $line) ];
+               push @data, [ split(/\Q$delimiter\E/, $line, -1) ];
        }
     
        return @data;
 } #}}}
 
-sub open_table ($$) { #{{{
-       my $params = shift;
-       my $header = shift;
-
-       my @items;
-       push @items, defined $params->{class}
-                       ? "<table class=\"".$params->{class}.'">'
-                       : '<table>';
-        push @items, '<thead>','<tr>',
-                    (map { "<th>".htmlize($params, $_)."</th>" } @$header),
-                     '</tr>','</thead>' if defined $header;
-       push @items, '<tbody>';
-       
-       return @items;
-}
-
-sub build_rows ($@) { #{{{
-       my $params = shift;
-
-       my @items;
-       foreach my $record (@_) {
-               push @items, '<tr>',
-                            (map { "<td>".htmlize($params, $_)."</td>" } @$record),
-                            '</tr>';
+sub genrow ($$$@) { #{{{
+       my $page = shift;
+       my $destpage = shift;
+       my $elt = shift;
+       my @data = @_;
+
+       my @ret;
+       push @ret, "\t\t<tr>";
+       for (my $x=0; $x < @data; $x++) {
+               my $cell=htmlize($page, $destpage, $data[$x]);
+               my $colspan=1;
+               while ($x+1 < @data && $data[$x+1] eq '') {
+                       $x++;
+                       $colspan++;
+               }
+               if ($colspan > 1) {
+                       push @ret, "\t\t\t<$elt colspan=\"$colspan\">$cell</$elt>"
+               }
+               else {
+                       push @ret, "\t\t\t<$elt>$cell</$elt>"
+               }
        }
-       return @items;
-} #}}}
-                 
-sub close_table ($$) { #{{{
-       my $params = shift;
-       my $header = shift;
-
-       my @items;
-       push @items, '</tbody>' if defined $header;
-       push @items, '</table>';
-       return @items;
-} #}}}
+       push @ret, "\t\t</tr>";
 
-sub htmlize { #{{{
-       my $params = shift;
-       my $text = shift;
-
-       $text=IkiWiki::preprocess($params->{page},
-               $params->{destpage}, $text);
-       $text=IkiWiki::htmlize($params->{page},
-               pagetype($pagesources{$params->{page}}), $text);
+       return @ret;
+} #}}}
 
-       # hack to get rid of enclosing junk added by markdown
-       $text=~s!^<p>!!;
-       $text=~s!</p>$!!;
-       chomp $text;
+sub htmlize ($$$) { #{{{
+       my $page = shift;
+       my $destpage = shift;
 
-       return $text;
+       return IkiWiki::htmlize($page, $destpage, pagetype($pagesources{$page}),
+               IkiWiki::preprocess($page, $destpage, shift));
 }
 
 1