summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/contrib/cvs.mdwn12
-rw-r--r--doc/plugins/contrib/cvs/discussion.mdwn4
-rw-r--r--doc/plugins/contrib/unixauth.mdwn204
-rw-r--r--doc/plugins/po.mdwn16
4 files changed, 30 insertions, 206 deletions
diff --git a/doc/plugins/contrib/cvs.mdwn b/doc/plugins/contrib/cvs.mdwn
index 6b600eef7..1c43fb272 100644
--- a/doc/plugins/contrib/cvs.mdwn
+++ b/doc/plugins/contrib/cvs.mdwn
@@ -5,7 +5,9 @@
This plugin allows ikiwiki to use [[!wikipedia desc="CVS" Concurrent Versions System]] as an [[rcs]].
### Usage
-7. Install [cvsps](http://www.cobite.com/cvsps/), [[!cpan IPC::Cmd]], [[!cpan String::ShellQuote]], and [cvsweb](http://www.freebsd.org/projects/cvsweb.html) or the like.
+7. Install [cvsps](http://www.cobite.com/cvsps/), [[!cpan IPC::Cmd]],
+[[!cpan String::ShellQuote]], [[!cpan File::ReadBackwards]], and
+[cvsweb](http://www.freebsd.org/projects/cvsweb.html) or the like.
7. Adjust CVS-related parameters in your setup file.
Consider creating `$HOME/.cvsrc` if you don't have one already; the plugin doesn't need it, but you yourself might. Here's a good general-purpose one:
@@ -18,7 +20,11 @@ Consider creating `$HOME/.cvsrc` if you don't have one already; the plugin doesn
### Implementation details
* `cvs.pm` started life as a copy of [[3.14159|news/version_3.14159]]'s `svn.pm`.
-* `IkiWiki.pm:wiki_file_prune_regexps` avoids copying CVS metadata into `$DESTDIR`.
+* `IkiWiki.pm:wiki_file_prune_regexps` avoids copying CVS metadata
+into `$DESTDIR`.
+* `IkiWiki/Wrapper.pm` avoids calling ikiwiki from post-commit if it's a
+directory being `cvs add`ed (this check is only compiled into the wrapper
+iff the configured VCS is "cvs").
* [[ikiwiki-makerepo]]:
* creates a repository,
* imports `$SRCDIR` into top-level module `ikiwiki` (vendor tag IKIWIKI, release tag PRE_CVS),
@@ -27,7 +33,5 @@ Consider creating `$HOME/.cvsrc` if you don't have one already; the plugin doesn
### To do
* Add automated tests. (Blindly adding svn-like tests to `t/file_pruned.t` doesn't do the trick.)
-* If the argument to `cvs add` smells like a binary file, `cvs add -kb` it (for [[plugins/attachment]] support).
-* Don't slurp the entire `cvsps` output into memory (!).
* Instead of resource-intensively scraping changesets with `cvsps`, have `ikiwiki-makerepo` set up NetBSD-like `log_accum` and `commit_prep` scripts that coalesce and keep records of commits. `cvsps` can be used as a fallback for repositories without such records.
* Perhaps prevent web edits from attempting to create `.../CVS/foo.mdwn` (and `.../cvs/foo.mdwn` on case-insensitive filesystems); thanks to the CVS metadata directory, the attempt will fail anyway (and much more confusingly) if we don't.
diff --git a/doc/plugins/contrib/cvs/discussion.mdwn b/doc/plugins/contrib/cvs/discussion.mdwn
index e1fa6e428..e142452d0 100644
--- a/doc/plugins/contrib/cvs/discussion.mdwn
+++ b/doc/plugins/contrib/cvs/discussion.mdwn
@@ -52,6 +52,10 @@ the "cvs add <directory>" call and avoid doing anything in that case?
>>>>>> I don't see how there could possibly be a difference between
>>>>>> ikiwiki's C wrapper and your shell wrapper wrapper here. --[[Joey]]
+>>>>>>> I was comparing strings overly precisely. Fixed on my branch.
+>>>>>>> I've also knocked off the two most pressing to-do items. I
+>>>>>>> think the plugin's ready for prime time. --[[schmonz]]
+
> Thing 2 I'm less sure of. (I'd like to see the web UI return
> immediately on save anyway, to a temporary "rebuilding, please wait
> if you feel like knowing when it's done" page, but this problem
diff --git a/doc/plugins/contrib/unixauth.mdwn b/doc/plugins/contrib/unixauth.mdwn
index 6108ebfae..137195139 100644
--- a/doc/plugins/contrib/unixauth.mdwn
+++ b/doc/plugins/contrib/unixauth.mdwn
@@ -1,6 +1,8 @@
[[!template id=plugin name=unixauth core=0 author="[[schmonz]]"]]
[[!tag type/auth]]
+[[!template id=gitbranch branch=schmonz author="[[schmonz]]"]]
+
This plugin authenticates users against the Unix user database. It presents a similar UI to [[plugins/passwordauth]], but simpler, as there's no need to be able to register or change one's password.
To authenticate, either [checkpassword](http://cr.yp.to/checkpwd.html) or [pwauth](http://www.unixpapa.com/pwauth/) must be installed and configured. `checkpassword` is strongly preferred. If your web server runs as an unprivileged user -- as it darn well should! -- then `checkpassword` needs to be setuid root. (Or your ikiwiki CGI wrapper, I guess, but don't do that.) Other checkpassword implementations are available, notably [checkpassword-pam](http://checkpasswd-pam.sourceforge.net/).
@@ -17,205 +19,3 @@ __Security__: [As with passwordauth](/security/#index14h2), be wary of sending u
`unixauth` needs the `HTTPS` environment variable, available in ikiwiki 2.67 or later (fixed in #[502047](http://bugs.debian.org/502047)), without which it fails closed.
The plugin has not been tested with newer versions of ikiwiki. [[schmonz]] hopes to have time to polish this plugin soon.
-
-[[!toggle id="code" text="unixauth.pm"]]
-
-[[!toggleable id="code" text="""
-
- #!/usr/bin/perl
- # Ikiwiki unixauth authentication.
- package IkiWiki::Plugin::unixauth;
-
- use warnings;
- use strict;
- use IkiWiki 2.00;
-
- sub import {
- hook(type => "getsetup", id => "unixauth", call => \&getsetup);
- hook(type => "formbuilder_setup", id => "unixauth",
- call => \&formbuilder_setup);
- hook(type => "formbuilder", id => "unixauth",
- call => \&formbuilder);
- hook(type => "sessioncgi", id => "unixauth", call => \&sessioncgi);
- }
-
- sub getsetup () {
- return
- unixauth_type => {
- type => "string",
- example => "checkpassword",
- description => "type of authenticator; can be 'checkpassword' or 'pwauth'",
- safe => 0,
- rebuild => 1,
- },
- unixauth_command => {
- type => "string",
- example => "/path/to/checkpassword",
- description => "full path and any arguments",
- safe => 0,
- rebuild => 1,
- },
- unixauth_requiressl => {
- type => "boolean",
- example => "1",
- description => "require SSL? strongly recommended",
- safe => 0,
- rebuild => 1,
- },
- plugin => {
- description => "Unix user authentication",
- safe => 0,
- rebuild => 1,
- },
- }
-
- # Checks if a string matches a user's password, and returns true or false.
- sub checkpassword ($$;$) {
- my $user=shift;
- my $password=shift;
- my $field=shift || "password";
-
- # It's very important that the user not be allowed to log in with
- # an empty password!
- if (! length $password) {
- return 0;
- }
-
- my $ret=0;
- if (! exists $config{unixauth_type}) {
- # admin needs to carefully think over his configuration
- return 0;
- }
- elsif ($config{unixauth_type} eq "checkpassword") {
- open UNIXAUTH, "|$config{unixauth_command} true 3<&0" or die("Could not run $config{unixauth_type}");
- print UNIXAUTH "$user\0$password\0Y123456\0";
- close UNIXAUTH;
- $ret=!($?>>8);
- }
- elsif ($config{unixauth_type} eq "pwauth") {
- open UNIXAUTH, "|$config{unixauth_command}" or die("Could not run $config{unixauth_type}");
- print UNIXAUTH "$user\n$password\n";
- close UNIXAUTH;
- $ret=!($?>>8);
- }
- else {
- # no such authentication type
- return 0;
- }
-
- if ($ret) {
- my $userinfo=IkiWiki::userinfo_retrieve();
- if (! length $user || ! defined $userinfo ||
- ! exists $userinfo->{$user} || ! ref $userinfo->{$user}) {
- IkiWiki::userinfo_setall($user, {
- 'email' => '',
- 'regdate' => time,
- });
- }
- }
-
- return $ret;
- }
-
- sub formbuilder_setup (@) {
- my %params=@_;
-
- my $form=$params{form};
- my $session=$params{session};
- my $cgi=$params{cgi};
-
- # if not under SSL, die before even showing a login form,
- # unless the admin explicitly says it's fine
- if (! exists $config{unixauth_requiressl}) {
- $config{unixauth_requiressl} = 1;
- }
- if ($config{unixauth_requiressl}) {
- if ((! $config{sslcookie}) || (! exists $ENV{'HTTPS'})) {
- die("SSL required to login. Contact your administrator.<br>");
- }
- }
-
- if ($form->title eq "signin") {
- $form->field(name => "name", required => 0);
- $form->field(name => "password", type => "password", required => 0);
-
- if ($form->submitted) {
- my $submittype=$form->submitted;
- # Set required fields based on how form was submitted.
- my %required=(
- "Login" => [qw(name password)],
- );
- foreach my $opt (@{$required{$submittype}}) {
- $form->field(name => $opt, required => 1);
- }
-
- # Validate password against name for Login.
- if ($submittype eq "Login") {
- $form->field(
- name => "password",
- validate => sub {
- checkpassword($form->field("name"), shift);
- },
- );
- }
-
- # XXX is this reachable? looks like no
- elsif ($submittype eq "Login") {
- $form->field(
- name => "name",
- validate => sub {
- my $name=shift;
- length $name &&
- IkiWiki::userinfo_get($name, "regdate");
- },
- );
- }
- }
- else {
- # First time settings.
- $form->field(name => "name");
- if ($session->param("name")) {
- $form->field(name => "name", value => $session->param("name"));
- }
- }
- }
- elsif ($form->title eq "preferences") {
- $form->field(name => "name", disabled => 1,
- value => $session->param("name"), force => 1,
- fieldset => "login");
- $form->field(name => "password", disabled => 1, type => "password",
- fieldset => "login"),
- }
- }
-
- sub formbuilder (@) {
- my %params=@_;
-
- my $form=$params{form};
- my $session=$params{session};
- my $cgi=$params{cgi};
- my $buttons=$params{buttons};
-
- if ($form->title eq "signin") {
- if ($form->submitted && $form->validate) {
- if ($form->submitted eq 'Login') {
- $session->param("name", $form->field("name"));
- IkiWiki::cgi_postsignin($cgi, $session);
- }
- }
- }
- elsif ($form->title eq "preferences") {
- if ($form->submitted eq "Save Preferences" && $form->validate) {
- my $user_name=$form->field('name');
- }
- }
- }
-
- sub sessioncgi ($$) {
- my $q=shift;
- my $session=shift;
- }
-
- 1
-
-"""]]
diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 04420c115..38b6b12cd 100644
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -323,6 +323,22 @@ when building a non-english page? Then the directives would get translated.
t/po is currently failing tests 57 and 59 (and I would like to release
soon..) --[[Joey]]
+> They are failing because of commit cdc3576c8d1e (po: do not inject
+> custom bestlink function when `po_link_to` eq `default`). The test
+> suite changes `$config{po_link_to}`, but the `checkconfig` hook is
+> not re-run. I could manually run it when needed in the test-suite,
+> but this would lead to this function being injected several times,
+> and then `$origsubs{'bestlink'}` to be sometimes set to a wrong
+> value, which would break other parts of the test-suite. The best
+> solution I can think of (apart of reverting this commit or disabling
+> these two tests) is to split the test-suite into 3 parts, depending
+> on the `$config{po_link_to}` setting, either in 3 different `.t`
+> files, or inside the existing one and completely reset the IkiWiki
+> environment at the start of these parts... which I did not manage to
+> achieve in the last 2 hours :/ --[[intrigeri]]
+
+>> I've reverted it. --[[Joey]]
+
Documentation
-------------