beginning of review and updated patch

master
joey 2007-02-20 05:25:30 +00:00
parent 0bb4eaad09
commit aa7fc21824
1 changed files with 288 additions and 1 deletions

View File

@ -239,4 +239,291 @@ How about doing the index stuff only on the output side? (Or does the latter pat
>>> How do you apply a patch created by svn diff? I've been curious about this for a long time. The use_dirs patch looks OK but I'd like to play with it. --Ethan >>> How do you apply a patch created by svn diff? I've been curious about this for a long time. The use_dirs patch looks OK but I'd like to play with it. --Ethan
>>>> Just do `svn co svn://ikiwiki.kitenet.net/ikiwiki/trunk ikiwiki` then `cd ikiwiki && patch -p0 <use_dirs.diff`. :-) Same would work with a tarball as well. >>>> Just do `svn co svn://ikiwiki.kitenet.net/ikiwiki/trunk ikiwiki` then `cd ikiwiki && patch -p0 <use_dirs.diff`. :-) Same would work with a tarball as well.
----
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?
* 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
pages (though not for the toplevel `index`).
* This does make the resulting wikis much less browsable directly on the
filesystem, since `dir` to `dir/index.html` conversion is only handled by web
servers and so you end up browsing to a directory index all the time.
Wouldn't it be better to make the links themselves include the index.html?
* Some of the generated links are missing the trailing / , which is
innefficient since it leads to a http redirect when clicking on that
link. Seems to be limited to ".." links, and possibly only to
parentlinks. (Already fixed it for "." links.)
This is only a first pass, I still need to check to see if there are any
code paths where it adds expensive operations such as `abs2rel` that were
not needed before. And I have not audited all the plugins to see if any are
broken by the changes.
--[[Joey]]
Updated version of Tumov's patch follows:
<pre>
Index: IkiWiki/Render.pm
===================================================================
--- IkiWiki/Render.pm (revision 2700)
+++ IkiWiki/Render.pm (working copy)
@@ -32,8 +32,8 @@
my @links;
return unless $backlinks{$page};
foreach my $p (keys %{$backlinks{$page}}) {
- my $href=abs2rel(htmlpage($p), dirname($page));
-
+ my $href=urlto($p, $page);
+
# Trim common dir prefixes from both pages.
my $p_trimmed=$p;
my $page_trimmed=$page;
@@ -55,18 +55,14 @@
my @ret;
my $pagelink="";
my $path="";
- my $skip=1;
+ my $title=$config{wikiname};
+
return if $page eq 'index'; # toplevel
- foreach my $dir (reverse split("/", $page)) {
- if (! $skip) {
- $path.="../";
- unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
- }
- else {
- $skip=0;
- }
+ foreach my $dir (split("/", $page)) {
+ push @ret, { url => urlto($path, $page), page => $title };
+ $path.="/".$dir;
+ $title=pagetitle($dir);
}
- unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
return @ret;
} #}}}
Index: IkiWiki/Plugin/inline.pm
===================================================================
--- IkiWiki/Plugin/inline.pm (revision 2700)
+++ IkiWiki/Plugin/inline.pm (working copy)
@@ -110,8 +110,8 @@
add_depends($params{page}, $params{pages});
- my $rssurl=rsspage(basename($params{page}));
- my $atomurl=atompage(basename($params{page}));
+ my $rssurl=basename(rsspage($params{page}));
+ my $atomurl=basename(atompage($params{page}));
my $ret="";
if (exists $params{rootpage} && $config{cgiurl}) {
@@ -151,8 +151,7 @@
# 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}));
+ $link=urlto($link, $params{destpage});
$template->param(pageurl => $link);
$template->param(title => pagetitle(basename($page)));
$template->param(ctime => displaytime($pagectime{$page}));
@@ -205,15 +204,17 @@
}
if ($rss) {
- will_render($params{page}, rsspage($params{page}));
- writefile(rsspage($params{page}), $config{destdir},
+ my $rssp=rsspage($params{page});
+ will_render($params{page}, $rssp);
+ writefile($rssp, $config{destdir},
genfeed("rss", $rssurl, $desc, $params{page}, @list));
$toping{$params{page}}=1 unless $config{rebuild};
$feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
}
if ($atom) {
- will_render($params{page}, atompage($params{page}));
- writefile(atompage($params{page}), $config{destdir},
+ my $atomp=atompage($params{page});
+ will_render($params{page}, $atomp);
+ writefile($atomp, $config{destdir},
genfeed("atom", $atomurl, $desc, $params{page}, @list));
$toping{$params{page}}=1 unless $config{rebuild};
$feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
@@ -288,16 +289,25 @@
return $content;
} #}}}
+sub basepage ($) { #{{{
+ my $page=shift;
+
+ $page=htmlpage($page);
+ $page =~ s/\.html$//;
+
+ return $page;
+} #}}}
+
sub rsspage ($) { #{{{
my $page=shift;
- return $page.".rss";
+ return basepage($page).".rss";
} #}}}
sub atompage ($) { #{{{
my $page=shift;
- return $page.".atom";
+ return basepage($page).".atom";
} #}}}
sub genfeed ($$$$@) { #{{{
Index: ikiwiki.in
===================================================================
--- 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];
},
Index: doc/usage.mdwn
===================================================================
--- doc/usage.mdwn (revision 2700)
+++ doc/usage.mdwn (working copy)
@@ -244,6 +244,10 @@
Log to syslog(3).
+* --usedirs
+
+ Create output files named page/index.html instead of page.html.
+
* --w3mmode, --no-w3mmode
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 (working copy)
@@ -412,6 +412,10 @@
This is the standard gettext function, although slightly optimised.
+#### `urlto($$)`
+
+Construct a relative url to the first parameter from the second.
+
## RCS plugins
ikiwiki's support for revision control systems also uses pluggable perl
Index: doc/ikiwiki.setup
===================================================================
--- doc/ikiwiki.setup (revision 2700)
+++ doc/ikiwiki.setup (working copy)
@@ -94,6 +94,8 @@
syslog => 0,
# To link to user pages in a subdirectory of the wiki.
#userdir => "users",
+ # To enable alternate output filenames.
+ #usedirs => 1,
# 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 @@
"\">?</a>$linktext</span>"
}
- $bestlink=abs2rel($bestlink, dirname($page));
+ $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
+ $bestlink=beautify_url($bestlink);
if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
return "<img src=\"$bestlink\" alt=\"$linktext\" />";
</pre>