X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f9cf2cba2c1743bff8fb7a77680420e34460fedf..32be1324a904ebe97e1a3336be9e6fd05be92a69:/doc/patchqueue/index.html_allowed.mdwn diff --git a/doc/patchqueue/index.html_allowed.mdwn b/doc/patchqueue/index.html_allowed.mdwn index 528eb7d39..bd8c66738 100644 --- a/doc/patchqueue/index.html_allowed.mdwn +++ b/doc/patchqueue/index.html_allowed.mdwn @@ -246,26 +246,7 @@ How about doing the index stuff only on the output side? (Or does the latter pat ---- First pass over Tumov's patch -- which doesn't cleanly apply anymore, so -I'll attach an updated and slightly modified version below. - -* `urlto()` is O(N) to the number of pages in the wiki, which leads to - O(N^2) behavior, which could be a scalability problem. This happens because - of the lookup for `$to` in `%renderedfiles`, which shouldn't be necessary - most of the time. Couldn't it just be required that `$to` be a html page - name on input? Or require it be a non-html page name and always run - htmlpage on it. - - > Perhaps it would be possible to require that, but it seems like a - > very artificial restriction. The renderedfiles search is just a - > copy-paste from htmllink, and I'm no perl (or ikiwiki internals) - > expert... maybe there would be a faster way to do the check whether - > name translation is needed? No more than O(log n) steps should be - > needed for a simple search, after all, and maybe there would be shortcuts - > for even constant-time (in n) checks. --[[tuomov]] - - >> Ah, so much easier to critque other people's code than your own. - >> You're right, this is a general problem, and I can get it to log n - >> if I really want to. --[[Joey]] +I'll attach an updated and modified version below. --[[Joey]] * As we discussed in email, this will break handling of `foo/index.mdwn` pages. Needs to be changed to generate `foo/index/index.html` for such @@ -332,7 +313,9 @@ I'll attach an updated and slightly modified version below. if ( !length $to ) { return baseurl($from); } - + + >> Indeed, this brings the number of abs2rels closer to par, as well + >> as fixing the .. links. --[[Joey]] * It calles abs2rel about 16% more often with the patch, which makes it a bit slower, since abs2rel is not very efficient. (This omits abs2rel @@ -351,93 +334,25 @@ I'll attach an updated and slightly modified version below. >> good time to make such a changes. Not required to accept this patch >> though. -* `aggregate.pm` uses htmlpage in a way that breaks with its new behavior. - It will need to be changed as follows: - -
-Index: aggregate.pm -=================================================================== ---- aggregate.pm (revision 2700) -+++ aggregate.pm (working copy) -@@ -320,7 +320,7 @@ - # NB: This doesn't check for path length limits. - eval q{use POSIX}; - my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX); -- if (defined $max && length(htmlpage($page)) >= $max) { -+ if (defined $max && length(htmlfn($page)) >= $max) { - $c=""; - $page=$feed->{dir}."/item"; - while (exists $IkiWiki::pagecase{lc $page.$c} || -@@ -356,7 +356,7 @@ - if (ref $feed->{tags}) { - $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]); - } -- writefile(htmlpage($guid->{page}), $config{srcdir}, -+ writefile(htmlfn($guid->{page}), $config{srcdir}, - $template->output); - - # Set the mtime, this lets the build process get the right creation -@@ -434,4 +434,8 @@ - return "$config{srcdir}/".htmlpage($page); - } #}}} - -+sub htmlfn ($) { #{{{ -+ return shift().".html"; -+} #}}} -+ - 1 -- -* `linkmap.pm` uses `htmlpage` to construct a link and should probably be - changed like this (untested): + >>> [...] in fact, all uses of htmlpage in the plugins are used to + >>> construct an absolute address: the absolute url in most cases, so an `absurl` + >>> call could be added to be used instead of htmlpage + >>> --[[tuomov]] -
-Index: linkmap.pm -=================================================================== ---- linkmap.pm (revision 2700) -+++ linkmap.pm (working copy) -@@ -50,8 +50,7 @@ - foreach my $item (keys %links) { - if (pagespec_match($item, $params{pages}, $params{page})) { - my $link=htmlpage($item); -- $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page})); -- $mapitems{$item}=$link; -+ $mapitems{$item}=urlto($link, $params{destpage}); - } - } -+ >>>> Or it could use urlto("index", $page) instead. --[[Joey]] -> This is probably supposed to be `$mapitems{$item}=urlto($item, $params{destpage});`, -> which does indeed remove one more `htmlpage` call from the plugins. I can't actually -> try it: "failed writing to dst/ts.png.ikiwiki-new: Inappropriate ioctl for device". -> After this probable fix, in fact, all uses of htmlpage in the plugins are used to -> construct an absolute address: the absolute url in most cases, so an `absurl` -> call could be added to be used instead of htmlpage, and something else in the -> aggregate plugin (above), that I also think isn't what's wanted: -> aren't `foo.html` pages also "rendered", so that they get moved as `foo/index.html`? -> --[[tuomov]] + >>>>> That is, however, a relative URL, and maybe an absolute one + >>>>> is wanted. Perhaps `urlto($targetpage)` should return the + >>>>> absolute version --[[tuomov]] -* `inline.pm` uses htmlpage and `abs2rel` to generate a link, and probably - needs to be changed to either use `urlto` or to call `beautify_url` like - htmllink does. This might work: +* > and something else in the + > aggregate plugin (above), that I also think isn't what's wanted: + > aren't `foo.html` pages also "rendered", so that they get moved as `foo/index.html`? + > --[[tuomov]] -
-Index: inline.pm -=================================================================== ---- inline.pm (revision 2700) -+++ inline.pm (working copy) -@@ -150,10 +150,7 @@ - # Don't use htmllink because this way the - # title is separate and can be overridden by - # other plugins. -- my $link=bestlink($params{page}, $page); -- $link=htmlpage($link) if defined $type; -- $link=abs2rel($link, dirname($params{destpage})); -- $template->param(pageurl => $link); -+ $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage})); - $template->param(title => pagetitle(basename($page))); - $template->param(ctime => displaytime($pagectime{$page})); -+ >> Yes, the aggregate plugin will save the files as foo.html in the + >> sourcedir, and that will result in foo/index.html in the web site, same + >> as any other page. --[[Joey]] * `img.pm` makes some assumptions about name of the page that will be linking to the image, which are probably broken. @@ -445,14 +360,111 @@ Index: inline.pm * The changes to htmlpage's behavior probably call for the plugin interface version number to be changed. ---[[Joey]] - -Updated version of Tumov's patch follows: +Latest version of my patch... with most of the stuff that's been discussed, including `targetpage`. +Also available [here](http://iki.fi/tuomov/use_dirs-20070221.diff). (BTW, this posting, applying, and +updating of plain-old-diffs containing all the previous changes is starting to be painful. Reminds +me why I use darcs..) --[[tuomov]]
+Index: IkiWiki.pm +=================================================================== +--- IkiWiki.pm (revision 2806) ++++ IkiWiki.pm (working copy) +@@ -14,7 +14,7 @@ + use Exporter q{import}; + our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match + bestlink htmllink readfile writefile pagetype srcfile pagename +- displaytime will_render gettext ++ displaytime will_render gettext urlto targetpage + %config %links %renderedfiles %pagesources); + our $VERSION = 1.02; # plugin interface version, next is ikiwiki version + our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE +@@ -73,6 +73,7 @@ + sslcookie => 0, + httpauth => 0, + userdir => "", ++ usedirs => 0 + } #}}} + + sub checkconfig () { #{{{ +@@ -224,10 +225,21 @@ + return $page; + } #}}} + ++sub targetpage ($$) { #{{{ ++ my $page=shift; ++ my $ext=shift; ++ ++ if (! $config{usedirs} || $page =~ /^index$/ ) { ++ return $page.".".$ext; ++ } else { ++ return $page."/index.".$ext; ++ } ++} #}}} ++ + sub htmlpage ($) { #{{{ + my $page=shift; +- +- return $page.".html"; ++ ++ return targetpage($page, "html"); + } #}}} + + sub srcfile ($) { #{{{ +@@ -393,6 +405,7 @@ + + return "$config{url}/" if ! defined $page; + ++ $page=htmlpage($page); + $page=~s/[^\/]+$//; + $page=~s/[^\/]+\//..\//g; + return $page; +@@ -422,6 +435,32 @@ + $config{timeformat}, localtime($time))); + } #}}} + ++sub beautify_url ($) { #{{{ ++ my $url=shift; ++ ++ $url =~ s!/index.html$!/!; ++ $url =~ s!^$!./!; # Browsers don't like empty links... ++ ++ return $url; ++} #}}} ++ ++sub urlto ($$) { #{{{ ++ my $to=shift; ++ my $from=shift; ++ ++ if (! length $to) { ++ return beautify_url(baseurl($from)); ++ } ++ ++ if (! grep { $_ eq $to } map { @{$_} } values %renderedfiles) { ++ $to=htmlpage($to); ++ } ++ ++ my $link = abs2rel($to, dirname(htmlpage($from))); ++ ++ return beautify_url($link); ++} #}}} ++ + sub htmllink ($$$;@) { #{{{ + my $lpage=shift; # the page doing the linking + my $page=shift; # the page that will contain the link (different for inline) +@@ -457,7 +496,8 @@ + "\">?$linktext" + } + +- $bestlink=abs2rel($bestlink, dirname($page)); ++ $bestlink=abs2rel($bestlink, dirname(htmlpage($page))); ++ $bestlink=beautify_url($bestlink); + + if (! $opts{noimageinline} && isinlinableimage($bestlink)) { + return ""; Index: IkiWiki/Render.pm =================================================================== ---- IkiWiki/Render.pm (revision 2700) +--- IkiWiki/Render.pm (revision 2806) +++ IkiWiki/Render.pm (working copy) @@ -32,8 +32,8 @@ my @links; @@ -492,7 +504,7 @@ Index: IkiWiki/Render.pm Index: IkiWiki/Plugin/inline.pm =================================================================== ---- IkiWiki/Plugin/inline.pm (revision 2700) +--- IkiWiki/Plugin/inline.pm (revision 2806) +++ IkiWiki/Plugin/inline.pm (working copy) @@ -110,8 +110,8 @@ @@ -505,17 +517,19 @@ Index: IkiWiki/Plugin/inline.pm my $ret=""; if (exists $params{rootpage} && $config{cgiurl}) { -@@ -151,8 +151,7 @@ +@@ -150,10 +150,7 @@ + # Don't use htmllink because this way the # title is separate and can be overridden by # other plugins. - my $link=bestlink($params{page}, $page); +- my $link=bestlink($params{page}, $page); - $link=htmlpage($link) if defined $type; - $link=abs2rel($link, dirname($params{destpage})); -+ $link=urlto($link, $params{destpage}); - $template->param(pageurl => $link); +- $template->param(pageurl => $link); ++ $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage})); $template->param(title => pagetitle(basename($page))); $template->param(ctime => displaytime($pagectime{$page})); -@@ -205,15 +204,17 @@ + +@@ -205,15 +202,17 @@ } if ($rss) { @@ -537,49 +551,82 @@ Index: IkiWiki/Plugin/inline.pm genfeed("atom", $atomurl, $desc, $params{page}, @list)); $toping{$params{page}}=1 unless $config{rebuild}; $feedlinks{$params{destpage}}=qq{}; -@@ -288,16 +289,25 @@ +@@ -288,16 +287,21 @@ return $content; } #}}} +-sub rsspage ($) { #{{{ +sub basepage ($) { #{{{ -+ my $page=shift; + my $page=shift; + + $page=htmlpage($page); + $page =~ s/\.html$//; + + return $page; +} #}}} -+ - sub rsspage ($) { #{{{ - my $page=shift; - return $page.".rss"; -+ return basepage($page).".rss"; ++sub rsspage ($) { #{{{ ++ return targetpage(shift, "rss"); } #}}} sub atompage ($) { #{{{ - my $page=shift; - +- my $page=shift; +- - return $page.".atom"; -+ return basepage($page).".atom"; ++ return targetpage(shift, "atom"); } #}}} sub genfeed ($$$$@) { #{{{ -Index: ikiwiki.in +Index: IkiWiki/Plugin/aggregate.pm =================================================================== ---- ikiwiki.in (revision 2700) -+++ ikiwiki.in (working copy) -@@ -46,6 +46,7 @@ - "sslcookie!" => \$config{sslcookie}, - "httpauth!" => \$config{httpauth}, - "userdir=s" => \$config{userdir}, -+ "usedirs!" => \$config{usedirs}, - "exclude=s@" => sub { - push @{$config{wiki_file_prune_regexps}}, $_[1]; - }, +--- IkiWiki/Plugin/aggregate.pm (revision 2806) ++++ IkiWiki/Plugin/aggregate.pm (working copy) +@@ -320,7 +320,7 @@ + # NB: This doesn't check for path length limits. + eval q{use POSIX}; + my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX); +- if (defined $max && length(htmlpage($page)) >= $max) { ++ if (defined $max && length(htmlfn($page)) >= $max) { + $c=""; + $page=$feed->{dir}."/item"; + while (exists $IkiWiki::pagecase{lc $page.$c} || +@@ -356,7 +356,7 @@ + if (ref $feed->{tags}) { + $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]); + } +- writefile(htmlpage($guid->{page}), $config{srcdir}, ++ writefile(htmlfn($guid->{page}), $config{srcdir}, + $template->output); + + # Set the mtime, this lets the build process get the right creation +@@ -434,4 +434,8 @@ + return "$config{srcdir}/".htmlpage($page); + } #}}} + ++sub htmlfn ($) { #{{{ ++ return shift().".html"; ++} #}}} ++ + 1 +Index: IkiWiki/Plugin/linkmap.pm +=================================================================== +--- IkiWiki/Plugin/linkmap.pm (revision 2806) ++++ IkiWiki/Plugin/linkmap.pm (working copy) +@@ -49,9 +49,7 @@ + my %mapitems = (); + foreach my $item (keys %links) { + if (pagespec_match($item, $params{pages}, $params{page})) { +- my $link=htmlpage($item); +- $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page})); +- $mapitems{$item}=$link; ++ $mapitems{$item}=urlto($item, $params{destpage}); + } + } + Index: doc/usage.mdwn =================================================================== ---- doc/usage.mdwn (revision 2700) +--- doc/usage.mdwn (revision 2806) +++ doc/usage.mdwn (working copy) @@ -244,6 +244,10 @@ @@ -594,7 +641,7 @@ Index: doc/usage.mdwn Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, Index: doc/plugins/write.mdwn =================================================================== ---- doc/plugins/write.mdwn (revision 2700) +--- doc/plugins/write.mdwn (revision 2806) +++ doc/plugins/write.mdwn (working copy) @@ -412,6 +412,10 @@ @@ -609,7 +656,7 @@ Index: doc/plugins/write.mdwn ikiwiki's support for revision control systems also uses pluggable perl Index: doc/ikiwiki.setup =================================================================== ---- doc/ikiwiki.setup (revision 2700) +--- doc/ikiwiki.setup (revision 2806) +++ doc/ikiwiki.setup (working copy) @@ -94,6 +94,8 @@ syslog => 0, @@ -620,86 +667,4 @@ Index: doc/ikiwiki.setup # To add plugins, list them here. #add_plugins => [qw{goodstuff openid search wikitext camelcase -Index: IkiWiki.pm -=================================================================== ---- IkiWiki.pm (revision 2700) -+++ IkiWiki.pm (working copy) -@@ -14,7 +14,7 @@ - use Exporter q{import}; - our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match - bestlink htmllink readfile writefile pagetype srcfile pagename -- displaytime will_render gettext -+ displaytime will_render gettext urlto - %config %links %renderedfiles %pagesources); - our $VERSION = 1.02; # plugin interface version, next is ikiwiki version - our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE -@@ -72,6 +72,7 @@ - sslcookie => 0, - httpauth => 0, - userdir => "", -+ usedirs => 0 - } #}}} - - sub checkconfig () { #{{{ -@@ -226,7 +227,11 @@ - sub htmlpage ($) { #{{{ - my $page=shift; - -- return $page.".html"; -+ if (! $config{usedirs} || $page =~ /^index$/ || $page =~ /\/index$/) { -+ return $page.".html"; -+ } else { -+ return $page."/index.html"; -+ } - } #}}} - - sub srcfile ($) { #{{{ -@@ -390,6 +395,7 @@ - - return "$config{url}/" if ! defined $page; - -+ $page=htmlpage($page); - $page=~s/[^\/]+$//; - $page=~s/[^\/]+\//..\//g; - return $page; -@@ -419,6 +425,29 @@ - $config{timeformat}, localtime($time))); - } #}}} - -+sub beautify_url ($) { #{{{ -+ my $url=shift; -+ -+ $url =~ s!/index.html$!/!; -+ $url =~ s!^$!./!; # Browsers don't like empty links... -+ -+ return $url; -+} #}}} -+ -+sub urlto ($$) { #{{{ -+ my $to=shift; -+ my $from=shift; -+ -+ if (length $to && -+ ! grep { $_ eq $to } map { @{$_} } values %renderedfiles) { -+ $to=htmlpage($to); -+ } -+ -+ my $link = abs2rel($to, dirname(htmlpage($from))); -+ -+ return beautify_url($link); -+} #}}} -+ - sub htmllink ($$$;@) { #{{{ - my $lpage=shift; # the page doing the linking - my $page=shift; # the page that will contain the link (different for inline) -@@ -454,7 +483,8 @@ - "\">?$linktext" - } - -- $bestlink=abs2rel($bestlink, dirname($page)); -+ $bestlink=abs2rel($bestlink, dirname(htmlpage($page))); -+ $bestlink=beautify_url($bestlink); - - if (! $opts{noimageinline} && isinlinableimage($bestlink)) { - return "";