update info on my split-view setup, and ask for plugin advice

[git.ikiwiki.info.git] / IkiWiki / Plugin / table.pm

diff --git a/IkiWiki/Plugin/table.pm b/IkiWiki/Plugin/table.pm
index 26e434b1fa2264fdb9c24ceb8031775bf49f64fe..f3c425a37dacd9d1389f0c53a0d7fbc52469c70b 100644 (file)
--- a/IkiWiki/Plugin/table.pm
+++ b/IkiWiki/Plugin/table.pm
@@ -3,26 +3,54 @@ package IkiWiki::Plugin::table;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

+use Encode;
+use IkiWiki 3.00;

 
 

-use IkiWiki;
-use IkiWiki::Plugin::mdwn;
+sub import {
+       hook(type => "getsetup", id => "table", call => \&getsetup);
+       hook(type => "preprocess", id => "table", call => \&preprocess, scan => 1);
+}

 
 

-sub import { #{{{
-       hook(type => "preprocess", id => "table", call => \&preprocess);
-} # }}}
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+                       section => "widget",
+               },
+}

 
 

-sub preprocess (@) { #{{{
+sub preprocess (@) {

        my %params =(
                format  => 'auto',
        my %params =(
                format  => 'auto',

-               header  => 'yes',
+               header  => 'row',

                @_
        );
 
        if (exists $params{file}) {
                @_
        );
 
        if (exists $params{file}) {

-               if (! $pagesources{$params{file}}) {
-                       return "[[table ".gettext("cannot find file")."]]";
+               if (! exists $pagesources{$params{file}}) {
+                       error gettext("cannot find file");

                }
                $params{data} = readfile(srcfile($params{file}));
                }
                $params{data} = readfile(srcfile($params{file}));

+               add_depends($params{page}, $params{file});
+       }
+
+       if (! defined wantarray) {
+               # scan mode --  if the table uses an external file, need to
+               # scan that file too.
+               return unless exists $params{file};
+
+               # Preprocess in scan-only mode.
+               IkiWiki::preprocess($params{page}, $params{page}, $params{data}, 1);
+
+               IkiWiki::run_hooks(scan => sub {
+                       shift->(
+                               page => $params{page},
+                               content => $params{data},
+                       );
+               });
+
+               return;

        }
 
        if (lc $params{format} eq 'auto') {
        }
 
        if (lc $params{format} eq 'auto') {


@@ -37,44 +65,46 @@ sub preprocess (@) { #{{{
 
        my @data;
        if (lc $params{format} eq 'csv') {
 
        my @data;
        if (lc $params{format} eq 'csv') {

-               @data=split_csv($params{data}, $params{delimiter});
+               @data=split_csv($params{data},
+                       defined $params{delimiter} ? $params{delimiter} : ",",);
+               # linkify after parsing since html link quoting can
+               # confuse CSV parsing
+               @data=map {
+                       [ map {
+                               IkiWiki::linkify($params{page},
+                                       $params{destpage}, $_);
+                       } @$_ ]
+               } @data;

        }
        elsif (lc $params{format} eq 'dsv') {
        }
        elsif (lc $params{format} eq 'dsv') {

-               @data=split_dsv($params{data}, $params{delimiter});
+               # linkify before parsing since wikilinks can contain the
+               # delimiter
+               $params{data} = IkiWiki::linkify($params{page},
+                       $params{destpage}, $params{data});
+               @data=split_dsv($params{data},
+                       defined $params{delimiter} ? $params{delimiter} : "|",);

        }
        else {
        }
        else {

-               return "[[table ".gettext("unknown data format")."]]";
+               error gettext("unknown data format");

        }
 
        my $header;
        }
 
        my $header;

-       if (lc($params{header}) eq "yes") {
+       if (lc($params{header}) eq "row" || IkiWiki::yesno($params{header})) {

                $header=shift @data;
        }
        if (! @data) {
                $header=shift @data;
        }
        if (! @data) {

-               return "[[table ".gettext("empty data")."]]";
+               error gettext("empty data");

        }
 
        my @lines;
        push @lines, defined $params{class}
                        ? "<table class=\"".$params{class}.'">'
                        : '<table>';
        }
 
        my @lines;
        push @lines, defined $params{class}
                        ? "<table class=\"".$params{class}.'">'
                        : '<table>';

-       push @lines, "\t<thead>","\t\t<tr>",
-               (map {
-                       "\t\t\t<th>".
-                       htmlize($params{page}, $params{destpage}, $_).
-                       "</th>"
-               } @$header),
-               "\t\t</tr>", "\t</thead>" if defined $header;
-       push @lines, "\t<tbody>";
-       foreach my $record (@data) {
-               push @lines, "\t\t<tr>",
-                       (map {
-                               "\t\t\t<td>".
-                               htmlize($params{page}, $params{destpage}, $_).
-                               "</td>"
-                       } @$record),
-                       "\t\t</tr>";
-       }
+       push @lines, "\t<thead>",
+               genrow(\%params, "th", @$header),
+               "\t</thead>" if defined $header;
+       push @lines, "\t<tbody>" if defined $header;
+       push @lines, genrow(\%params, "td", @$_) foreach @data;

        push @lines, "\t</tbody>" if defined $header;
        push @lines, '</table>';
        my $html = join("\n", @lines);
        push @lines, "\t</tbody>" if defined $header;
        push @lines, '</table>';
        my $html = join("\n", @lines);


@@ -87,24 +117,25 @@ sub preprocess (@) { #{{{
        else {  
                return $html;
        }            
        else {  
                return $html;
        }            

-} #}}}
+}

 
 

-sub is_dsv_data ($) { #{{{
+sub is_dsv_data ($) {

        my $text = shift;
 
        my ($line) = split(/\n/, $text);
        return $line =~ m{.+\|};
 }
 
        my $text = shift;
 
        my ($line) = split(/\n/, $text);
        return $line =~ m{.+\|};
 }
 

-sub split_csv ($$) { #{{{
+sub split_csv ($$) {

        my @text_lines = split(/\n/, shift);
        my $delimiter = shift;
 
        eval q{use Text::CSV};
        error($@) if $@;
        my $csv = Text::CSV->new({ 
        my @text_lines = split(/\n/, shift);
        my $delimiter = shift;
 
        eval q{use Text::CSV};
        error($@) if $@;
        my $csv = Text::CSV->new({ 

-               sep_char        => defined $delimiter ? $delimiter : ",",
+               sep_char        => $delimiter,

                binary          => 1,
                binary          => 1,

+               allow_loose_quotes => 1,

        }) || error("could not create a Text::CSV object");
        
        my $l=0;
        }) || error("could not create a Text::CSV object");
        
        my $l=0;


@@ -112,7 +143,7 @@ sub split_csv ($$) { #{{{
        foreach my $line (@text_lines) {
                $l++;
                if ($csv->parse($line)) {
        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'), 
                }
                else {
                        debug(sprintf(gettext('parse fail at line %d: %s'), 


@@ -121,35 +152,59 @@ sub split_csv ($$) { #{{{
        }
 
        return @data;
        }
 
        return @data;

-} #}}}
+}

 
 

-sub split_dsv ($$) { #{{{
+sub split_dsv ($$) {

        my @text_lines = split(/\n/, shift);
        my $delimiter = shift;
        $delimiter="|" unless defined $delimiter;
 
        my @data;
        foreach my $line (@text_lines) {
        my @text_lines = split(/\n/, shift);
        my $delimiter = shift;
        $delimiter="|" unless defined $delimiter;
 
        my @data;
        foreach my $line (@text_lines) {

-               push @data, [ split(/\Q$delimiter\E/, $line) ];
+               push @data, [ split(/\Q$delimiter\E/, $line, -1) ];

        }
     
        return @data;
        }
     
        return @data;

-} #}}}
+}

 
 

-sub htmlize ($$$){ #{{{
-       my $page = shift;
-       my $destpage = shift;
-       my $text = shift;
+sub genrow ($@) {
+       my %params=%{shift()};
+       my $elt = shift;
+       my @data = @_;
+
+       my $page=$params{page};
+       my $destpage=$params{destpage};
+       my $type=pagetype($pagesources{$page});
+
+       my @ret;
+       push @ret, "\t\t<tr>";
+       for (my $x=0; $x < @data; $x++) {
+               my $cell=IkiWiki::htmlize($page, $destpage, $type,
+                        IkiWiki::preprocess($page, $destpage, $data[$x]));
+
+               # automatic colspan for empty cells
+               my $colspan=1;
+               while ($x+1 < @data && $data[$x+1] eq '') {
+                       $x++;
+                       $colspan++;
+               }

 
 

-       $text=IkiWiki::htmlize($page, pagetype($pagesources{$page}),
-               IkiWiki::preprocess($page, $destpage, $text));
+               # check if the first column should be a header
+               my $e=$elt;
+               if ($x == 0 && lc($params{header}) eq "column") {
+                       $e="th";
+               }

 
 

-       # hack to get rid of enclosing junk added by markdown
-       $text=~s!^<p>!!;
-       $text=~s!</p>$!!;
-       chomp $text;
+               if ($colspan > 1) {
+                       push @ret, "\t\t\t<$e colspan=\"$colspan\">$cell</$e>"
+               }
+               else {
+                       push @ret, "\t\t\t<$e>$cell</$e>"
+               }
+       }
+       push @ret, "\t\t</tr>";

 
 

-       return $text;
+       return @ret;

 }
 
 1
 }
 
 1