ikiwiki/IkiWiki/Plugin/relativedate.pm

#!/usr/bin/perl
package IkiWiki::Plugin::relativedate;

use warnings;
no warnings 'redefine';
use strict;
use IkiWiki 3.00;
use POSIX ();
use Encode;

sub import {
	add_underlay("javascript");
	hook(type => "getsetup", id => "relativedate", call => \&getsetup);
	hook(type => "format", id => "relativedate", call => \&format);
	inject(name => "IkiWiki::displaytime", call => \&mydisplaytime);
}

sub getsetup () {
	return
		plugin => {
			safe => 1,
			rebuild => 1,
		},
}

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

	if (! ($params{content}=~s!^(\s*</body[^>]*>)!include_javascript($params{page}).$1!em)) {
		# no <body> tag, probably in preview mode
		$params{content}=$params{content}.include_javascript(undef);
	}
	return $params{content};
}

sub include_javascript ($) {
	my $from=shift;
	
	return '<script src="'.urlto("ikiwiki/ikiwiki.js", $from).
		'" type="text/javascript" charset="utf-8"></script>'."\n".
		'<script src="'.urlto("ikiwiki/relativedate.js", $from).
		'" type="text/javascript" charset="utf-8"></script>';
}

sub mydisplaytime ($;$$) {
	my $time=shift;
	my $format=shift;
	my $pubdate=shift;

	# This needs to be in a form that can be parsed by javascript.
	# (Being fairly human readable is also nice, as it will be exposed
	# as the title if javascript is not available.)
	my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
	POSIX::setlocale(&POSIX::LC_TIME, "C");
	my $gmtime=decode_utf8(POSIX::strftime("%a, %d %b %Y %H:%M:%S %z",
			localtime($time)));
	POSIX::setlocale(&POSIX::LC_TIME, $lc_time);

	my $mid=' class="relativedate" title="'.$gmtime.'">'.
		IkiWiki::formattime($time, $format);

	if ($config{html5}) {
		return '<time datetime="'.IkiWiki::date_3339($time).'"'.
			($pubdate ? ' pubdate="pubdate"' : '').$mid.'</time>';
	}
	else {
		return '<span'.$mid.'</span>';
	}
}

1
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`#!/usr/bin/perl`
			`package IkiWiki::Plugin::relativedate;`

			`use warnings;`
fix relativedate timezone inclusion The machine parseable date needs to include a timezone. Also, simplified the interface for date display. 2008-10-20 01:13:40 +02:00			`no warnings 'redefine';`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`use strict;`
finalise version 3.00 of the plugin api 2008-12-23 22:34:19 +01:00			`use IkiWiki 3.00;`
audited use POSIX The POSIX perl module exports a huge number of functions by default, so make sure all imports are qualified. (And remove one that was not necessary.) 2010-03-19 18:10:17 +01:00			`use POSIX ();`
fix relativedate timezone inclusion The machine parseable date needs to include a timezone. Also, simplified the interface for date display. 2008-10-20 01:13:40 +02:00			`use Encode;`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`sub import {`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`add_underlay("javascript");`
add missing getsetup hook 2008-10-18 03:29:05 +02:00			`hook(type => "getsetup", id => "relativedate", call => \&getsetup);`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`hook(type => "format", id => "relativedate", call => \&format);`
function injection overhaul Add an inject function, that can be used by plugins that want to replace one of ikiwiki's functions with their own version. (This is a scary thing that grubs through the symbol table, and replaces all exported occurances of a function with the injected version.) external: RPC functions can be injected to replace exported functions. Removed the stupid displaytime hook, and use injection instead. 2008-10-21 23:57:19 +02:00			`inject(name => "IkiWiki::displaytime", call => \&mydisplaytime);`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`sub getsetup () {`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`return`
			`plugin => {`
			`safe => 1,`
			`rebuild => 1,`
			`},`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`sub format (@) {`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`my %params=@_;`

append javascript after CSS Javascript resources should be presented to browsers after CSS, and "after the fold" (ATF) according to the best practices: https://developers.google.com/speed/docs/insights/mobile#PutStylesBeforeScripts This change allows the browser to download Javascript files in parallel, by including Javascript on the closing </body> tag instead of the opening tag. We also improve the regex to tolerate spaces before the body tag, as some templates have (proper) indentation for the tag. 2017-11-06 20:15:22 +01:00			`if (! ($params{content}=~s!^(\s</body[^>]>)!include_javascript($params{page}).$1!em)) {`
correct comment; javascript is put after <body> 2010-08-12 20:29:22 +02:00			`# no <body> tag, probably in preview mode`
append javascript after CSS Javascript resources should be presented to browsers after CSS, and "after the fold" (ATF) according to the best practices: https://developers.google.com/speed/docs/insights/mobile#PutStylesBeforeScripts This change allows the browser to download Javascript files in parallel, by including Javascript on the closing </body> tag instead of the opening tag. We also improve the regex to tolerate spaces before the body tag, as some templates have (proper) indentation for the tag. 2017-11-06 20:15:22 +01:00			`$params{content}=$params{content}.include_javascript(undef);`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`}`
			`return $params{content};`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00
Use local paths when including Javascript 2010-11-23 01:06:07 +01:00			`sub include_javascript ($) {`
			`my $from=shift;`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00
Use local paths when including Javascript 2010-11-23 01:06:07 +01:00			`return '<script src="'.urlto("ikiwiki/ikiwiki.js", $from).`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`'" type="text/javascript" charset="utf-8"></script>'."\n".`
Use local paths when including Javascript 2010-11-23 01:06:07 +01:00			`'<script src="'.urlto("ikiwiki/relativedate.js", $from).`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`'" type="text/javascript" charset="utf-8"></script>';`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00
Add parameter to displaytime to specify that it is a pubdate, and in html5 mode, use time tag. 2010-05-02 19:44:13 +02:00			`sub mydisplaytime ($;$$) {`
fix relativedate timezone inclusion The machine parseable date needs to include a timezone. Also, simplified the interface for date display. 2008-10-20 01:13:40 +02:00			`my $time=shift;`
			`my $format=shift;`
Add parameter to displaytime to specify that it is a pubdate, and in html5 mode, use time tag. 2010-05-02 19:44:13 +02:00			`my $pubdate=shift;`
fix relativedate timezone inclusion The machine parseable date needs to include a timezone. Also, simplified the interface for date display. 2008-10-20 01:13:40 +02:00
			`# This needs to be in a form that can be parsed by javascript.`
relativedate: Fix problem with localised dates not working. 2010-06-09 22:16:48 +02:00			`# (Being fairly human readable is also nice, as it will be exposed`
			`# as the title if javascript is not available.)`
			`my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);`
			`POSIX::setlocale(&POSIX::LC_TIME, "C");`
need to use localtime, fix width 2008-10-20 01:39:32 +02:00			`my $gmtime=decode_utf8(POSIX::strftime("%a, %d %b %Y %H:%M:%S %z",`
			`localtime($time)));`
relativedate: Fix problem with localised dates not working. 2010-06-09 22:16:48 +02:00			`POSIX::setlocale(&POSIX::LC_TIME, $lc_time);`
fix relativedate timezone inclusion The machine parseable date needs to include a timezone. Also, simplified the interface for date display. 2008-10-20 01:13:40 +02:00
Add parameter to displaytime to specify that it is a pubdate, and in html5 mode, use time tag. 2010-05-02 19:44:13 +02:00			`my $mid=' class="relativedate" title="'.$gmtime.'">'.`
			`IkiWiki::formattime($time, $format);`

			`if ($config{html5}) {`
			`return '<time datetime="'.IkiWiki::date_3339($time).'"'.`
Use xhtml friendly pubdate setting. 2010-05-09 01:45:02 +02:00			`($pubdate ? ' pubdate="pubdate"' : '').$mid.'</time>';`
Add parameter to displaytime to specify that it is a pubdate, and in html5 mode, use time tag. 2010-05-02 19:44:13 +02:00			`}`
			`else {`
			`return '<span'.$mid.'</span>';`
			`}`
Coding style change: Remove explcit vim folding markers. 2008-12-17 21:22:16 +01:00			`}`
fix relativedate timezone inclusion The machine parseable date needs to include a timezone. Also, simplified the interface for date display. 2008-10-20 01:13:40 +02:00
relativedate: New javascript-alicious plugin that makes all dates display relative, in a very nice way, if I say so myself. 2008-10-18 02:47:32 +02:00			`1`