X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7558a6d8aa56f38908c613882db44a009d33ae37..c47839389abb8e21a94606a2c105e5c1ecf6ed32:/doc/todo/source_link.mdwn?ds=sidebyside

diff --git a/doc/todo/source_link.mdwn b/doc/todo/source_link.mdwn
index 53dffb0c6..cf3e69487 100644
--- a/doc/todo/source_link.mdwn
+++ b/doc/todo/source_link.mdwn
@@ -1 +1,135 @@
 How about a direct link from the page header to the source of the latest version, to avoid the need to either use edit or navigate to the current version via the history link?
+
+ I'd like this too (and might try to implement it). -- [[users/jon]]
+
+I just implemented this.  There is one [[patch]] to the default page template, and a new plugin.  -- [[Will]]
+
+All of this code is licensed under the GPLv2+. -- [[Will]]
+
+> The use of sessioncgi here seems undesirable: on wikis where anonymity is
+> not allowed, you'll be asked to log in. Couldn't you achieve the same thing
+> by loading the index with IkiWiki::loadindex, like [[plugins/goto]] does?
+> --[[smcv]]
+
+[[done]]
+
+>> I've applied the patch below in a git branch, fixed my earlier criticism,
+>> and also fixed a couple of other issues I noticed:
+>>
+>> * missing pages could be presented better as a real 404 page
+>> * the default Content-type should probably be UTF-8 since the rest of
+>>   IkiWiki tends to assume that
+>> * emitting attachments (images, etc.) as text/plain isn't going to work :-)
+>>
+>> Any opinions on my branch? I think it's ready for merge, if Joey approves.
+>>
+>> --[[smcv]]
+
+>>> I need a copyright&license statement, so debian/copyright can be updated for
+>>> the plugin, before I can merge this. Otherwise ready. --[[Joey]]
+
+>>> That looks like a nice set of fixes.  One more that might be worthwhile: instead of reading the page source into a var, and then writing it out later, it might be nice to just
+>>>  `print readfile(srcfile(pagesources{$page}));` at the appropriate point. -- [[Will]]
+
+>>>> OK, I've committed that. --[[smcv]]
+
+----
+
+    diff --git a/templates/page.tmpl b/templates/page.tmpl
+    index f2f9c34..3176bed 100644
+    --- a/templates/page.tmpl
+    +++ b/templates/page.tmpl
+    @@ -46,6 +46,9 @@
+     <TMPL_IF NAME="HISTORYURL">
+     <li><a href="<TMPL_VAR HISTORYURL>">History</a></li>
+     </TMPL_IF>
+    +<TMPL_IF NAME="GETSOURCEURL">
+    +<li><a href="<TMPL_VAR GETSOURCEURL>">Get Source</a></li>
+    +</TMPL_IF>
+     <TMPL_IF NAME="PREFSURL">
+     <li><a href="<TMPL_VAR PREFSURL>">Preferences</a></li>
+     </TMPL_IF>
+
+----
+
+    #!/usr/bin/perl
+    package IkiWiki::Plugin::getsource;
+    
+    use warnings;
+    use strict;
+    use IkiWiki;
+    use open qw{:utf8 :std};
+    
+    sub import {
+    	hook(type => "getsetup", id => "getsource", call => \&getsetup);
+    	hook(type => "pagetemplate", id => "getsource", call => \&pagetemplate);
+    	hook(type => "sessioncgi", id => "getsource", call => \&cgi_getsource);
+    }
+    
+    sub getsetup () {
+    	return
+    		plugin => {
+    			safe => 1,
+    			rebuild => 1,
+    		},
+    		getsource_mimetype => {
+    			type => "string",
+    			example => "application/octet-stream",
+    			description => "Mime type for returned source.",
+    			safe => 1,
+    			rebuild => 0,
+    		},
+    }
+    
+    sub pagetemplate (@) {
+    	my %params=@_;
+    
+    	my $page=$params{page};
+    	my $template=$params{template};
+    
+    	if (length $config{cgiurl}) {
+    		$template->param(getsourceurl => IkiWiki::cgiurl(do => "getsource", page => $page));
+    		$template->param(have_actions => 1);
+    	}
+    }
+    
+    sub cgi_getsource ($$) {
+    	my $cgi=shift;
+    	my $session=shift;
+    
+    	# Note: we use sessioncgi rather than just cgi
+    	# because we need $IkiWiki::pagesources{} to be
+    	# populated.
+    	
+    	return unless (defined $cgi->param('do') &&
+    					$cgi->param("do") eq "getsource");
+    
+    	IkiWiki::decode_cgi_utf8($cgi);
+    
+    	my $page=$cgi->param('page');
+    
+    	if ($IkiWiki::pagesources{$page}) {
+    		
+    		my $data = IkiWiki::readfile(IkiWiki::srcfile($IkiWiki::pagesources{$page}));
+    		
+    		if (! $config{getsource_mimetype}) {
+    			$config{getsource_mimetype} = "text/plain";
+    		}
+    		
+    		print "Content-Type: $config{getsource_mimetype}\r\n";
+    		
+    		print ("\r\n");
+    		
+    		print $data;
+    		
+    		exit 0;
+    	}
+    	
+    	error("Unable to find page source for page: $page");
+    
+    	exit 0;
+    }
+    
+    1
+
+[[done]] --[[smcv]]