urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/IkiWiki/Plugin/recentchangesdiff.pm

81 lines
1.8 KiB
Perl
Raw Permalink Normal View History

* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
#!/usr/bin/perl
package IkiWiki::Plugin::recentchangesdiff;
use warnings;
use strict;
finalise version 3.00 of the plugin api
2008-12-23 22:34:19 +01:00
use IkiWiki 3.00;
improve escaping of wikilinks and preprocessor directives The old method failed for '[' x 3.
2008-11-18 08:43:17 +01:00
use HTML::Entities;
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
truncate recentchangesdiffs after 200 lines This works around a perl crasher bug, and also avoids bloating pages with enormous diffs. rcs_recentchanges modified to return a list in an array context.
2008-03-12 20:45:10 +01:00
my $maxlines=200;
Coding style change: Remove explcit vim folding markers.
2008-12-17 21:22:16 +01:00
sub import {
include manually the toggle js code
2012-07-19 16:32:02 +02:00
add_underlay("javascript");
add plugin safe/rebuild info (part 2 of 3) (brain.. melting..)
2008-08-03 23:20:21 +02:00
hook(type => "getsetup", id => "recentchangesdiff",
call => \&getsetup);
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
hook(type => "pagetemplate", id => "recentchangesdiff",
call => \&pagetemplate);
include manually the toggle js code
2012-07-19 16:32:02 +02:00
hook(type => "format", id => "recentchangesdiff.pm", call => \&format);
Coding style change: Remove explcit vim folding markers.
2008-12-17 21:22:16 +01:00
}
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01: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,
},
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
Coding style change: Remove explcit vim folding markers.
2008-12-17 21:22:16 +01:00
sub pagetemplate (@) {
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
my %params=@_;
my $template=$params{template};
if ($config{rcs} && exists $params{rev} && length $params{rev} &&
$template->query(name => "diff")) {
Add a second parameter to the rcs_diff hook, and avoid bloating memory reading in enormous commits.
2010-12-30 00:58:49 +01:00
my @lines=IkiWiki::rcs_diff($params{rev}, $maxlines+1);
truncate recentchangesdiffs after 200 lines This works around a perl crasher bug, and also avoids bloating pages with enormous diffs. rcs_recentchanges modified to return a list in an array context.
2008-03-12 20:45:10 +01:00
if (@lines) {
my $diff;
recentchangesdiff: truncate extremely large diffs A diff was already truncated after 200 lines. But it could still be arbitrarily enormous, if a spammer or other random noise source likes long lines. That could use a lot of memory to html encode etc the diff and fill it into the template. Truncating after 100kb seems sufficient; it allows for 200 lines of up to 512 characters each.
2012-01-23 23:36:33 +01:00
my $trunc=0;
truncate recentchangesdiffs after 200 lines This works around a perl crasher bug, and also avoids bloating pages with enormous diffs. rcs_recentchanges modified to return a list in an array context.
2008-03-12 20:45:10 +01:00
if (@lines > $maxlines) {
recentchangesdiff: truncate extremely large diffs A diff was already truncated after 200 lines. But it could still be arbitrarily enormous, if a spammer or other random noise source likes long lines. That could use a lot of memory to html encode etc the diff and fill it into the template. Truncating after 100kb seems sufficient; it allows for 200 lines of up to 512 characters each.
2012-01-23 23:36:33 +01:00
$diff=join("", @lines[0..($maxlines-1)]);
$trunc=1;
truncate recentchangesdiffs after 200 lines This works around a perl crasher bug, and also avoids bloating pages with enormous diffs. rcs_recentchanges modified to return a list in an array context.
2008-03-12 20:45:10 +01:00
}
else {
$diff=join("", @lines);
}
recentchangesdiff: truncate extremely large diffs A diff was already truncated after 200 lines. But it could still be arbitrarily enormous, if a spammer or other random noise source likes long lines. That could use a lot of memory to html encode etc the diff and fill it into the template. Truncating after 100kb seems sufficient; it allows for 200 lines of up to 512 characters each.
2012-01-23 23:36:33 +01:00
if (length $diff > 102400) {
$diff=substr($diff, 0, 10240);
$trunc=1;
}
if ($trunc) {
$diff.="\n".gettext("(Diff truncated)");
}
html escaping complication Can't escape things to entities if the template then escapes the entities. (aggregate doesn't have this problem.)
2008-11-18 08:48:24 +01:00
# escape html
$diff = encode_entities($diff);
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
# escape links and preprocessor stuff
improve escaping of wikilinks and preprocessor directives The old method failed for '[' x 3.
2008-11-18 08:43:17 +01:00
$diff = encode_entities($diff, '\[\]');
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
$template->param(diff => $diff);
}
}
Coding style change: Remove explcit vim folding markers.
2008-12-17 21:22:16 +01:00
}
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
include manually the toggle js code
2012-07-19 16:32:02 +02:00
sub format (@) {
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)) {
include manually the toggle js code
2012-07-19 16:32:02 +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);
include manually the toggle js code
2012-07-19 16:32:02 +02:00
}
return $params{content};
}
# taken verbatim from toggle.pm
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/toggle.js", $from).
'" type="text/javascript" charset="utf-8"></script>';
}
* Add recentchangesdiff plugin that adds diffs to the recentchanges feeds. * rcs_diff is a new function that rcs modules should implement. * Implemented rcs_diff for git, svn, and tla (tla version untested). Mercurial and monotone still todo.
2008-03-03 21:53:34 +01:00
1