IkiWiki/Plugin/table.pm

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