summaryrefslogtreecommitdiff
path: root/doc/patchqueue/rst.mdwn
blob: c2790990eb75519c85b82c9f707860d3145a6b1b (plain)

This is a whole lot better than nothing, but it's a shame it forks python every page. Anyone want to get this into Debian and use it instead? --[[Joey]]

Actually, if someone adds support for it to ikiwiki, I would be glad to get the package into Debian myself --[[Joey]]

#!/usr/bin/perl
# Very simple reStructuredText processor.
#
# This plugin calls python and requires python-docutils to transform the text
# into html.
#
# It's main problem is that it does not support ikiwiki's WikiLinks nor
# Preprocessor Directives (in fact the same problem applies to the current
# Wikitext processor, although in that case the output looks less worse ;)
#
# Probably Wikilinks and Preprocessor Directives should support a list of
# extensions to process (i.e. the linkify function could be transformed into
# reStructuredText instead of HTML using a hook on rst.py instead of the
# current linkify function)
#
# by Sergio Talens-Oliag <sto@debian.org>

package IkiWiki::Plugin::rst;

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

# Simple python script, maybe it should be implemented using an external script.
# The settings_overrides are given to avoid potential security risks when
# reading external files or if raw html is included on rst pages.
my $pyCmnd = "
from docutils.core import publish_string;
from sys import stdin;
html = publish_string(stdin.read(), writer_name='html', 
       settings_overrides = { 'halt_level': 6, 
                              'file_insertion_enabled': 0,
                              'raw_enabled': 0 }
);
print html[html.find('<body>')+6:html.find('</body>')].strip();
";

sub import { #{{{
	IkiWiki::hook(type => "htmlize", id => "rst", call => \&htmlize);
} # }}}

sub htmlize ($) { #{{{
	my $content = shift;

	# Try to call python and run our command
	open2(*IN, *OUT, "python", "-c",  "$pyCmnd") or return $content;

	# open2 doesn't respect "use open ':utf8'"
	binmode (IN, ':utf8');
	binmode (OUT, ':utf8');
	
	print OUT $content;
	close OUT;
	local $/ = undef;
	return <IN>;
} # }}}

1