path: root/IkiWiki/Plugin/htmltidy.pm

#!/usr/bin/perl
# HTML Tidy plugin
# requires 'tidy' binary, found in Debian or http://tidy.sf.net/
# mostly a proof-of-concept on how to use external filters.
# It is particularly useful when the html plugin is used.
#
# by Faidon Liambotis
package IkiWiki::Plugin::htmltidy;

use warnings;
use strict;
use IkiWiki 3.00;
use IPC::Open2;

sub import {
    hook(type => "getsetup", id => "tidy", call => \&getsetup);
    hook(type => "sanitize", id => "tidy", call => \&sanitize);
    hook(type => "checkconfig", id => "tidy", call => \&checkconfig);
}

sub getsetup () {
    return
        plugin => {
            safe => 1,
            rebuild => undef,
        },
        htmltidy => {
            type => "string",
            description => "tidy command line",
            safe => 0, # path
            rebuild => undef,
        },
}

sub checkconfig () {
    if (! defined $config{htmltidy}) {
        $config{htmltidy}="tidy -quiet -asxhtml -utf8 --show-body-only yes --show-warnings no --tidy-mark no --markup yes";
    }
}

sub sanitize (@) {
    my %params=@_;

    return $params{content} unless defined $config{htmltidy};

    my $pid;
    my $sigpipe=0;
    $SIG{PIPE}=sub { $sigpipe=1 };
    $pid=open2(*IN, *OUT, "$config{htmltidy} 2>/dev/null");

    # open2 doesn't respect "use open ':utf8'"
    binmode (IN, ':utf8');
    binmode (OUT, ':utf8');
    
    print OUT $params{content};
    close OUT;

    local $/ = undef;
    my $ret=<IN>;
    close IN;
    waitpid $pid, 0;

    $SIG{PIPE}="DEFAULT";
    if ($sigpipe || ! defined $ret) {
        return gettext("htmltidy failed to parse this html");
    }

    return $ret;
}

1