IkiWiki/Plugin/table.pm

   1 package IkiWiki::Plugin::table;
   2 # by Victor Moral <victor@taquiones.net>
   3
   4 use warnings;
   5 use strict;
   6 use IkiWiki 2.00;
   7
   8 sub import { #{{{
   9         hook(type => "preprocess", id => "table", call => \&preprocess);
  10 } # }}}
  11
  12 sub preprocess (@) { #{{{
  13         my %params =(
  14                 format  => 'auto',
  15                 header  => 'yes',
  16                 @_
  17         );
  18
  19         if (exists $params{file}) {
  20                 if (! $pagesources{$params{file}}) {
  21                         return "[[table ".gettext("cannot find file")."]]";
  22                 }
  23                 $params{data} = readfile(srcfile($params{file}));
  24         }
  25         else {
  26                 $params{data} = IkiWiki::linkify($params{page},
  27                         $params{destpage}, $params{data});
  28         }
  29
  30         if (lc $params{format} eq 'auto') {
  31                 # first try the more simple format
  32                 if (is_dsv_data($params{data})) {
  33                         $params{format} = 'dsv';
  34                 }
  35                 else {
  36                         $params{format} = 'csv';
  37                 }
  38         }
  39
  40         my @data;
  41         if (lc $params{format} eq 'csv') {
  42                 @data=split_csv($params{data}, $params{delimiter});
  43         }
  44         elsif (lc $params{format} eq 'dsv') {
  45                 @data=split_dsv($params{data}, $params{delimiter});
  46         }
  47         else {
  48                 return "[[table ".gettext("unknown data format")."]]";
  49         }
  50
  51         my $header;
  52         if (lc($params{header}) eq "yes") {
  53                 $header=shift @data;
  54         }
  55         if (! @data) {
  56                 return "[[table ".gettext("empty data")."]]";
  57         }
  58
  59         my @lines;
  60         push @lines, defined $params{class}
  61                         ? "<table class=\"".$params{class}.'">'
  62                         : '<table>';
  63         push @lines, "\t<thead>",
  64                 genrow($params{page}, $params{destpage}, "th", @$header),
  65                 "\t</thead>" if defined $header;
  66         push @lines, "\t<tbody>";
  67         push @lines, genrow($params{page}, $params{destpage}, "td", @$_)
  68                 foreach @data;
  69         push @lines, "\t</tbody>" if defined $header;
  70         push @lines, '</table>';
  71         my $html = join("\n", @lines);
  72
  73         if (exists $params{file}) {
  74                 return $html."\n\n".
  75                         htmllink($params{page}, $params{destpage}, $params{file},
  76                                 linktext => gettext('Direct data download'));
  77         }
  78         else {
  79                 return $html;
  80         }
  81 } #}}}
  82
  83 sub is_dsv_data ($) { #{{{
  84         my $text = shift;
  85
  86         my ($line) = split(/\n/, $text);
  87         return $line =~ m{.+\|};
  88 }
  89
  90 sub split_csv ($$) { #{{{
  91         my @text_lines = split(/\n/, shift);
  92         my $delimiter = shift;
  93
  94         eval q{use Text::CSV};
  95         error($@) if $@;
  96         my $csv = Text::CSV->new({
  97                 sep_char        => defined $delimiter ? $delimiter : ",",
  98                 binary          => 1,
  99                 allow_loose_quotes => 1,
 100         }) || error("could not create a Text::CSV object");
 101
 102         my $l=0;
 103         my @data;
 104         foreach my $line (@text_lines) {
 105                 $l++;
 106                 if ($csv->parse($line)) {
 107                         push(@data, [ $csv->fields() ]);
 108                 }
 109                 else {
 110                         debug(sprintf(gettext('parse fail at line %d: %s'),
 111                                 $l, $csv->error_input()));
 112                 }
 113         }
 114
 115         return @data;
 116 } #}}}
 117
 118 sub split_dsv ($$) { #{{{
 119         my @text_lines = split(/\n/, shift);
 120         my $delimiter = shift;
 121         $delimiter="|" unless defined $delimiter;
 122
 123         my @data;
 124         foreach my $line (@text_lines) {
 125                 push @data, [ split(/\Q$delimiter\E/, $line, -1) ];
 126         }
 127
 128         return @data;
 129 } #}}}
 130
 131 sub genrow ($$$@) { #{{{
 132         my $page = shift;
 133         my $destpage = shift;
 134         my $elt = shift;
 135         my @data = @_;
 136
 137         my @ret;
 138         push @ret, "\t\t<tr>";
 139         for (my $x=0; $x < @data; $x++) {
 140                 my $cell=htmlize($page, $destpage, $data[$x]);
 141                 my $colspan=1;
 142                 while ($x+1 < @data && $data[$x+1] eq '') {
 143                         $x++;
 144                         $colspan++;
 145                 }
 146                 if ($colspan > 1) {
 147                         push @ret, "\t\t\t<$elt colspan=\"$colspan\">$cell</$elt>"
 148                 }
 149                 else {
 150                         push @ret, "\t\t\t<$elt>$cell</$elt>"
 151                 }
 152         }
 153         push @ret, "\t\t</tr>";
 154
 155         return @ret;
 156 } #}}}
 157
 158 sub htmlize ($$$) { #{{{
 159         my $page = shift;
 160         my $destpage = shift;
 161         my $text = shift;
 162
 163         $text=IkiWiki::htmlize($page, pagetype($pagesources{$page}),
 164                 IkiWiki::preprocess($page, $destpage, $text));
 165
 166         # hack to get rid of enclosing junk added by markdown
 167         $text=~s!^<p>!!;
 168         $text=~s!</p>$!!;
 169         chomp $text;
 170
 171         return $text;
 172 }
 173
 174 1