ikiwiki/IkiWiki/Plugin/otl.pm

#!/usr/bin/perl
# outline markup
package IkiWiki::Plugin::otl;

use warnings;
use strict;
use IkiWiki 3.00;
use open qw{:utf8 :std};

sub import {
	hook(type => "getsetup", id => "otl", call => \&getsetup);
	hook(type => "htmlize", id => "otl", call => \&htmlize);
}

sub getsetup () {
	return 
		plugin => {
			safe => 1,
			rebuild => 1, # format plugin
			section => "format",
		},
}

sub htmlize (@) {
	my %params=@_;
	
	# Munge up check boxes to look a little bit better.
	my $checked=htmllink($params{page}, $params{page},
		"smileys/star_on.png", linktext => "[X]");
	my $unchecked=htmllink($params{page}, $params{page},
		"smileys/star_off.png", linktext => "[_]");
	$params{content}=~s/^(\s*)\[X\]\s/${1}$checked /mg;
	$params{content}=~s/^(\s*)\[_\]\s/${1}$unchecked /mg;

	# Can't use open2 since otl2html doesn't play nice with buffering.
	# Instead, fork off a child process that will run otl2html and feed
	# it the content. Then read otl2html's response.

	my $tries=10;
	my $pid;
	do {
		$pid = open(KID_TO_READ, "-|");
		unless (defined $pid) {
			$tries--;
			if ($tries < 1) {
				debug("failed to fork: $@");
				return $params{content};
			}
		}
	} until defined $pid;

	if (! $pid) {
		$tries=10;
		$pid=undef;

		do {
			$pid = open(KID_TO_WRITE, "|-");
			unless (defined $pid) {
				$tries--;
				if ($tries < 1) {
					debug("failed to fork: $@");
					print $params{content};
					exit;
				}
			}
		} until defined $pid;

		if (! $pid) {
			if (! exec 'otl2html', '-S', '/dev/null', '-T', '/dev/stdin') {
				debug("failed to run otl2html: $@");
				print $params{content};
				exit;
			}
		}

		print KID_TO_WRITE $params{content};
		close KID_TO_WRITE;
		waitpid $pid, 0;
		exit;
	}
	
	local $/ = undef;
	my $ret=<KID_TO_READ>;
	close KID_TO_READ;
	waitpid $pid, 0;

	$ret=~s/.*<body>//s;
	$ret=~s/<body>.*//s;
	$ret=~s/<div class="Footer">.*//s;
	return $ret;
}

1
* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00			`#!/usr/bin/perl`
			`# outline markup`
			`package IkiWiki::Plugin::otl;`

			`use warnings;`
			`use strict;`
finalise version 3.00 of the plugin api 2008-12-23 22:34:19 +01:00			`use IkiWiki 3.00;`
otl: Support utf-8 files. (Recai Oktaş) 2008-07-09 02:52:30 +02:00			`use open qw{:utf8 :std};`
* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`sub import {`
add plugin safe/rebuild info (part 2 of 3) (brain.. melting..) 2008-08-03 23:20:21 +02:00			`hook(type => "getsetup", id => "otl", call => \&getsetup);`
* Work on firming up the plugin interface: - Plugins should not need to load IkiWiki::Render to get commonly used functions, so moved some functions from there to IkiWiki. - Picked out the set of functions and variables that most plugins use, documented them, and made IkiWiki export them by default, like a proper perl module should. - Use the other functions at your own risk. - This is not quite complete, I still have to decide whether to export some other things. * Changed all plugins included in ikiwiki to not use "IkiWiki::" when referring to stuff now exported by the IkiWiki module. * Anyone with a third-party ikiwiki plugin is strongly enrouraged to make like changes to it and avoid use of non-exported symboles from "IkiWiki::". * Link debian/changelog and debian/news to NEWS and CHANGELOG. * Support hyperestradier version 1.4.2, which adds a new required phraseform setting. 2006-09-10 00:50:27 +02:00			`hook(type => "htmlize", id => "otl", call => \&htmlize);`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
add in a hack to improve the look of check marks in outline 2006-08-19 20:27:57 +02:00
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`sub getsetup () {`
add plugin safe/rebuild info (part 2 of 3) (brain.. melting..) 2008-08-03 23:20:21 +02:00			`return`
			`plugin => {`
			`safe => 1,`
			`rebuild => 1, # format plugin`
format plugin categorization 2010-02-12 07:10:36 +01:00			`section => "format",`
add plugin safe/rebuild info (part 2 of 3) (brain.. melting..) 2008-08-03 23:20:21 +02:00			`},`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
add plugin safe/rebuild info (part 2 of 3) (brain.. melting..) 2008-08-03 23:20:21 +02:00
otl: Avoid globally filtering non-otl pages Through a complex chain of circumstances, that filtering was causing dumpsetup to trigger undefined warning messages from the po plugin. But anyway, munging the otl in htmlize is less error-prone and less expensive, a win all around. 2009-09-23 21:11:51 +02:00			`sub htmlize (@) {`
add in a hack to improve the look of check marks in outline 2006-08-19 20:27:57 +02:00			`my %params=@_;`
otl: Avoid globally filtering non-otl pages Through a complex chain of circumstances, that filtering was causing dumpsetup to trigger undefined warning messages from the po plugin. But anyway, munging the otl in htmlize is less error-prone and less expensive, a win all around. 2009-09-23 21:11:51 +02:00
			`# Munge up check boxes to look a little bit better.`
* Work on firming up the plugin interface: - Plugins should not need to load IkiWiki::Render to get commonly used functions, so moved some functions from there to IkiWiki. - Picked out the set of functions and variables that most plugins use, documented them, and made IkiWiki export them by default, like a proper perl module should. - Use the other functions at your own risk. - This is not quite complete, I still have to decide whether to export some other things. * Changed all plugins included in ikiwiki to not use "IkiWiki::" when referring to stuff now exported by the IkiWiki module. * Anyone with a third-party ikiwiki plugin is strongly enrouraged to make like changes to it and avoid use of non-exported symboles from "IkiWiki::". * Link debian/changelog and debian/news to NEWS and CHANGELOG. * Support hyperestradier version 1.4.2, which adds a new required phraseform setting. 2006-09-10 00:50:27 +02:00			`my $checked=htmllink($params{page}, $params{page},`
* Changed calling convention for httmllink slightly. The first three parameters remain the same, but additional options are now passed in using named parameters. * Change plugin interface version to 1.02 to reflect this change. * Add a new anchor option to htmllink. Thanks Ben for the idea. * Support anchors in wikilinks. * Add a "more" plugin based on one contributed by Ben to allow implementing those dreaded "Read more" links in blogs. 2007-02-20 04:05:47 +01:00			`"smileys/star_on.png", linktext => "[X]");`
* Work on firming up the plugin interface: - Plugins should not need to load IkiWiki::Render to get commonly used functions, so moved some functions from there to IkiWiki. - Picked out the set of functions and variables that most plugins use, documented them, and made IkiWiki export them by default, like a proper perl module should. - Use the other functions at your own risk. - This is not quite complete, I still have to decide whether to export some other things. * Changed all plugins included in ikiwiki to not use "IkiWiki::" when referring to stuff now exported by the IkiWiki module. * Anyone with a third-party ikiwiki plugin is strongly enrouraged to make like changes to it and avoid use of non-exported symboles from "IkiWiki::". * Link debian/changelog and debian/news to NEWS and CHANGELOG. * Support hyperestradier version 1.4.2, which adds a new required phraseform setting. 2006-09-10 00:50:27 +02:00			`my $unchecked=htmllink($params{page}, $params{page},`
* Changed calling convention for httmllink slightly. The first three parameters remain the same, but additional options are now passed in using named parameters. * Change plugin interface version to 1.02 to reflect this change. * Add a new anchor option to htmllink. Thanks Ben for the idea. * Support anchors in wikilinks. * Add a "more" plugin based on one contributed by Ben to allow implementing those dreaded "Read more" links in blogs. 2007-02-20 04:05:47 +01:00			`"smileys/star_off.png", linktext => "[_]");`
fix regexp 2006-08-19 20:28:40 +02:00			`$params{content}=~s/^(\s*)\[X\]\s/${1}$checked /mg;`
			`$params{content}=~s/^(\s*)\[_\]\s/${1}$unchecked /mg;`
* Change htmlize, format, and sanitize hooks to use named parameters. 2006-08-28 20:17:59 +02:00
* Add a missing -n to tla undo call. * otl2hmtl can't be safely used with IPC::Open2 since it sometimes writes before consuming its whole stdin. Avoid this deadlock. * Fix alt tags for outline checkboxes. 2006-09-08 22:33:49 +02:00			`# Can't use open2 since otl2html doesn't play nice with buffering.`
			`# Instead, fork off a child process that will run otl2html and feed`
			`# it the content. Then read otl2html's response.`

* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00			`my $tries=10;`
* Add proper waitpid calls for open2ed processes throughout to avoid zombies; this hit htmltidy especially badly. 2006-09-03 22:11:39 +02:00			`my $pid;`
* Add a missing -n to tla undo call. * otl2hmtl can't be safely used with IPC::Open2 since it sometimes writes before consuming its whole stdin. Avoid this deadlock. * Fix alt tags for outline checkboxes. 2006-09-08 22:33:49 +02:00			`do {`
			`$pid = open(KID_TO_READ, "-\|");`
			`unless (defined $pid) {`
			`$tries--;`
			`if ($tries < 1) {`
* Work on firming up the plugin interface: - Plugins should not need to load IkiWiki::Render to get commonly used functions, so moved some functions from there to IkiWiki. - Picked out the set of functions and variables that most plugins use, documented them, and made IkiWiki export them by default, like a proper perl module should. - Use the other functions at your own risk. - This is not quite complete, I still have to decide whether to export some other things. * Changed all plugins included in ikiwiki to not use "IkiWiki::" when referring to stuff now exported by the IkiWiki module. * Anyone with a third-party ikiwiki plugin is strongly enrouraged to make like changes to it and avoid use of non-exported symboles from "IkiWiki::". * Link debian/changelog and debian/news to NEWS and CHANGELOG. * Support hyperestradier version 1.4.2, which adds a new required phraseform setting. 2006-09-10 00:50:27 +02:00			`debug("failed to fork: $@");`
* Add a missing -n to tla undo call. * otl2hmtl can't be safely used with IPC::Open2 since it sometimes writes before consuming its whole stdin. Avoid this deadlock. * Fix alt tags for outline checkboxes. 2006-09-08 22:33:49 +02:00			`return $params{content};`
			`}`
* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00			`}`
* Add a missing -n to tla undo call. * otl2hmtl can't be safely used with IPC::Open2 since it sometimes writes before consuming its whole stdin. Avoid this deadlock. * Fix alt tags for outline checkboxes. 2006-09-08 22:33:49 +02:00			`} until defined $pid;`

			`if (! $pid) {`
			`$tries=10;`
			`$pid=undef;`

			`do {`
			`$pid = open(KID_TO_WRITE, "\|-");`
			`unless (defined $pid) {`
			`$tries--;`
			`if ($tries < 1) {`
* Work on firming up the plugin interface: - Plugins should not need to load IkiWiki::Render to get commonly used functions, so moved some functions from there to IkiWiki. - Picked out the set of functions and variables that most plugins use, documented them, and made IkiWiki export them by default, like a proper perl module should. - Use the other functions at your own risk. - This is not quite complete, I still have to decide whether to export some other things. * Changed all plugins included in ikiwiki to not use "IkiWiki::" when referring to stuff now exported by the IkiWiki module. * Anyone with a third-party ikiwiki plugin is strongly enrouraged to make like changes to it and avoid use of non-exported symboles from "IkiWiki::". * Link debian/changelog and debian/news to NEWS and CHANGELOG. * Support hyperestradier version 1.4.2, which adds a new required phraseform setting. 2006-09-10 00:50:27 +02:00			`debug("failed to fork: $@");`
* Add a missing -n to tla undo call. * otl2hmtl can't be safely used with IPC::Open2 since it sometimes writes before consuming its whole stdin. Avoid this deadlock. * Fix alt tags for outline checkboxes. 2006-09-08 22:33:49 +02:00			`print $params{content};`
			`exit;`
			`}`
			`}`
			`} until defined $pid;`

			`if (! $pid) {`
			`if (! exec 'otl2html', '-S', '/dev/null', '-T', '/dev/stdin') {`
* Work on firming up the plugin interface: - Plugins should not need to load IkiWiki::Render to get commonly used functions, so moved some functions from there to IkiWiki. - Picked out the set of functions and variables that most plugins use, documented them, and made IkiWiki export them by default, like a proper perl module should. - Use the other functions at your own risk. - This is not quite complete, I still have to decide whether to export some other things. * Changed all plugins included in ikiwiki to not use "IkiWiki::" when referring to stuff now exported by the IkiWiki module. * Anyone with a third-party ikiwiki plugin is strongly enrouraged to make like changes to it and avoid use of non-exported symboles from "IkiWiki::". * Link debian/changelog and debian/news to NEWS and CHANGELOG. * Support hyperestradier version 1.4.2, which adds a new required phraseform setting. 2006-09-10 00:50:27 +02:00			`debug("failed to run otl2html: $@");`
* Add a missing -n to tla undo call. * otl2hmtl can't be safely used with IPC::Open2 since it sometimes writes before consuming its whole stdin. Avoid this deadlock. * Fix alt tags for outline checkboxes. 2006-09-08 22:33:49 +02:00			`print $params{content};`
			`exit;`
			`}`
			`}`

			`print KID_TO_WRITE $params{content};`
			`close KID_TO_WRITE;`
			`waitpid $pid, 0;`
			`exit;`
* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00			`}`

			`local $/ = undef;`
* Add a missing -n to tla undo call. * otl2hmtl can't be safely used with IPC::Open2 since it sometimes writes before consuming its whole stdin. Avoid this deadlock. * Fix alt tags for outline checkboxes. 2006-09-08 22:33:49 +02:00			`my $ret=<KID_TO_READ>;`
			`close KID_TO_READ;`
* Add proper waitpid calls for open2ed processes throughout to avoid zombies; this hit htmltidy especially badly. 2006-09-03 22:11:39 +02:00			`waitpid $pid, 0;`

* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00			`$ret=~s/.*<body>//s;`
			`$ret=~s/<body>.*//s;`
kill footer 2006-08-19 05:06:32 +02:00			`$ret=~s/<div class="Footer">.*//s;`
* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00			`return $ret;`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
* Add otl format plugin, which handles files as created by vimoutliner. 2006-08-18 23:48:03 +02:00
			`1`