doc/todo/source_link.mdwn

   1 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?
   2
   3  I'd like this too (and might try to implement it). -- [[users/jon]]
   4
   5 I just implemented this.  There is one [[patch]] to the default page template, and a new plugin.  -- [[Will]]
   6
   7 > The use of sessioncgi here seems undesirable: on wikis where anonymity is
   8 > not allowed, you'll be asked to log in. Couldn't you achieve the same thing
   9 > by loading the index with IkiWiki::loadindex, like [[plugins/goto]] does?
  10 > --[[smcv]]
  11
  12 [[!template id=gitbranch branch=smcv/ready/getsource
  13   author="[[Will]]/[[smcv]]"]]
  14
  15 >> I've applied the patch below in a git branch, fixed my earlier criticism,
  16 >> and also fixed a couple of other issues I noticed:
  17 >>
  18 >> * missing pages could be presented better as a real 404 page
  19 >> * the default Content-type should probably be UTF-8 since the rest of
  20 >>   IkiWiki tends to assume that
  21 >> * emitting attachments (images, etc.) as text/plain isn't going to work :-)
  22 >>
  23 >> Any opinions on my branch? I think it's ready for merge, if Joey approves.
  24 >>
  25 >> --[[smcv]]
  26
  27 >>> I need a copyright&license statement, so debian/copyright can be updated for
  28 >>> the plugin, before I can merge this. Otherwise ready. --[[Joey]]
  29
  30 >>> 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
  31 >>>  `print readfile(srcfile(pagesources{$page}));` at the appropriate point. -- [[Will]]
  32
  33 >>>> OK, I've committed that. --[[smcv]]
  34
  35 ----
  36
  37     diff --git a/templates/page.tmpl b/templates/page.tmpl
  38     index f2f9c34..3176bed 100644
  39     --- a/templates/page.tmpl
  40     +++ b/templates/page.tmpl
  41     @@ -46,6 +46,9 @@
  42      <TMPL_IF NAME="HISTORYURL">
  43      <li><a href="<TMPL_VAR HISTORYURL>">History</a></li>
  44      </TMPL_IF>
  45     +<TMPL_IF NAME="GETSOURCEURL">
  46     +<li><a href="<TMPL_VAR GETSOURCEURL>">Get Source</a></li>
  47     +</TMPL_IF>
  48      <TMPL_IF NAME="PREFSURL">
  49      <li><a href="<TMPL_VAR PREFSURL>">Preferences</a></li>
  50      </TMPL_IF>
  51
  52 ----
  53
  54     #!/usr/bin/perl
  55     package IkiWiki::Plugin::getsource;
  56
  57     use warnings;
  58     use strict;
  59     use IkiWiki;
  60     use open qw{:utf8 :std};
  61
  62     sub import {
  63         hook(type => "getsetup", id => "getsource", call => \&getsetup);
  64         hook(type => "pagetemplate", id => "getsource", call => \&pagetemplate);
  65         hook(type => "sessioncgi", id => "getsource", call => \&cgi_getsource);
  66     }
  67
  68     sub getsetup () {
  69         return
  70                 plugin => {
  71                         safe => 1,
  72                         rebuild => 1,
  73                 },
  74                 getsource_mimetype => {
  75                         type => "string",
  76                         example => "application/octet-stream",
  77                         description => "Mime type for returned source.",
  78                         safe => 1,
  79                         rebuild => 0,
  80                 },
  81     }
  82
  83     sub pagetemplate (@) {
  84         my %params=@_;
  85
  86         my $page=$params{page};
  87         my $template=$params{template};
  88
  89         if (length $config{cgiurl}) {
  90                 $template->param(getsourceurl => IkiWiki::cgiurl(do => "getsource", page => $page));
  91                 $template->param(have_actions => 1);
  92         }
  93     }
  94
  95     sub cgi_getsource ($$) {
  96         my $cgi=shift;
  97         my $session=shift;
  98
  99         # Note: we use sessioncgi rather than just cgi
 100         # because we need $IkiWiki::pagesources{} to be
 101         # populated.
 102
 103         return unless (defined $cgi->param('do') &&
 104                                         $cgi->param("do") eq "getsource");
 105
 106         IkiWiki::decode_cgi_utf8($cgi);
 107
 108         my $page=$cgi->param('page');
 109
 110         if ($IkiWiki::pagesources{$page}) {
 111
 112                 my $data = IkiWiki::readfile(IkiWiki::srcfile($IkiWiki::pagesources{$page}));
 113
 114                 if (! $config{getsource_mimetype}) {
 115                         $config{getsource_mimetype} = "text/plain";
 116                 }
 117
 118                 print "Content-Type: $config{getsource_mimetype}\r\n";
 119
 120                 print ("\r\n");
 121
 122                 print $data;
 123
 124                 exit 0;
 125         }
 126
 127         error("Unable to find page source for page: $page");
 128
 129         exit 0;
 130     }
 131
 132     1