]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/passwordauth.pm
Merge branch 'master' of ssh://git.ikiwiki.info
[git.ikiwiki.info.git] / IkiWiki / Plugin / passwordauth.pm
index 82afeef989e517171a416749d27194a1e435b672..0cf2a26ea99380b6dd395824945bfcebd42c33b9 100644 (file)
@@ -4,17 +4,23 @@ package IkiWiki::Plugin::passwordauth;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 
-sub import { #{{{
+sub import {
        hook(type => "getsetup", id => "passwordauth", "call" => \&getsetup);
        hook(type => "getsetup", id => "passwordauth", "call" => \&getsetup);
-        hook(type => "formbuilder_setup", id => "passwordauth", call => \&formbuilder_setup);
-        hook(type => "formbuilder", id => "passwordauth", call => \&formbuilder);
+       hook(type => "formbuilder_setup", id => "passwordauth", call => \&formbuilder_setup);
+       hook(type => "formbuilder", id => "passwordauth", call => \&formbuilder);
        hook(type => "sessioncgi", id => "passwordauth", call => \&sessioncgi);
        hook(type => "sessioncgi", id => "passwordauth", call => \&sessioncgi);
-} # }}}
+       hook(type => "auth", id => "passwordauth", call => \&auth);
+}
 
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+                       section => "auth",
+               },
                account_creation_password => {
                        type => "string",
                        example => "s3cr1t",
                account_creation_password => {
                        type => "string",
                        example => "s3cr1t",
@@ -29,10 +35,10 @@ sub getsetup () { #{{{
                        safe => 1,
                        rebuild => 0,
                },
                        safe => 1,
                        rebuild => 0,
                },
-} #}}}
+}
 
 # Checks if a string matches a user's password, and returns true or false.
 
 # Checks if a string matches a user's password, and returns true or false.
-sub checkpassword ($$;$) { #{{{
+sub checkpassword ($$;$) {
        my $user=shift;
        my $password=shift;
        my $field=shift || "password";
        my $user=shift;
        my $password=shift;
        my $field=shift || "password";
@@ -70,9 +76,9 @@ sub checkpassword ($$;$) { #{{{
        }
 
        return $ret;
        }
 
        return $ret;
-} #}}}
+}
 
 
-sub setpassword ($$;$) { #{{{
+sub setpassword ($$;$) {
        my $user=shift;
        my $password=shift;
        my $field=shift || "password";
        my $user=shift;
        my $password=shift;
        my $field=shift || "password";
@@ -90,20 +96,88 @@ sub setpassword ($$;$) { #{{{
        else {
                IkiWiki::userinfo_set($user, $field, $password);
        }
        else {
                IkiWiki::userinfo_set($user, $field, $password);
        }
-} #}}}
 
 
-sub formbuilder_setup (@) { #{{{
+       # Setting the password clears any passwordless login token.
+       if ($field ne 'passwordless') {
+               IkiWiki::userinfo_set($user, "passwordless", "");
+       }
+}
+
+# Generates a token that can be used to log the user in.
+# This needs to be hard to guess. Generating a cgi session id will
+# make it as hard to guess as any cgi session.
+sub gentoken ($$;$) {
+       my $user=shift;
+       my $tokenfield=shift;
+       my $reversable=shift;
+
+       eval q{use CGI::Session};
+       error($@) if $@;
+       my $token = CGI::Session->new->id;
+       if (! $reversable) {
+               setpassword($user, $token, $tokenfield);
+       }
+       else {
+               IkiWiki::userinfo_set($user, $tokenfield, $token);
+       }
+       return $token;
+}
+
+# An anonymous user has no normal password, only a passwordless login
+# token. Given an email address, this sets up such a user for that email,
+# unless one already exists, and returns the username.
+sub anonuser ($) {
+       my $email=shift;
+
+       # Want a username for this email that won't overlap with any other.
+       my $user=$email;
+       $user=~s/@/_/g;
+
+       my $userinfo=IkiWiki::userinfo_retrieve();
+       if (! exists $userinfo->{$user} || ! ref $userinfo->{$user}) {
+               if (IkiWiki::userinfo_setall($user, {
+                       'email' => $email,
+                       'regdate' => time})) {
+                       gentoken($user, "passwordless", 1);
+                       return $user;
+               }
+               else {
+                       error(gettext("Error creating account."));
+               }
+       }
+       elsif (defined anonusertoken($userinfo->{$user})) {
+               return $user;
+       }
+       else {
+               return undef;
+       }
+}
+
+sub anonusertoken ($) {
+       my $userhash=shift;
+       if (exists $userhash->{passwordless} &&
+           length $userhash->{passwordless}) {
+               return $userhash->{passwordless};
+       }
+       else {
+               return undef;
+       }
+}
+
+sub formbuilder_setup (@) {
        my %params=@_;
 
        my $form=$params{form};
        my $session=$params{session};
        my $cgi=$params{cgi};
 
        my %params=@_;
 
        my $form=$params{form};
        my $session=$params{session};
        my $cgi=$params{cgi};
 
-       if ($form->title eq "signin" || $form->title eq "register") {
+       my $do_register=defined $cgi->param("do") && $cgi->param("do") eq "register";
+
+       if ($form->title eq "signin" || $form->title eq "register" || $do_register) {
                $form->field(name => "name", required => 0);
                $form->field(name => "password", type => "password", required => 0);
                
                $form->field(name => "name", required => 0);
                $form->field(name => "password", type => "password", required => 0);
                
-               if ($form->submitted eq "Register" || $form->submitted eq "Create Account") {
+               if ($form->submitted eq "Register" || $form->submitted eq "Create Account" || $do_register) {
                        $form->field(name => "confirm_password", type => "password");
                        $form->field(name => "account_creation_password", type => "password")
                                 if (defined $config{account_creation_password} &&
                        $form->field(name => "confirm_password", type => "password");
                        $form->field(name => "account_creation_password", type => "password")
                                 if (defined $config{account_creation_password} &&
@@ -202,23 +276,38 @@ sub formbuilder_setup (@) { #{{{
                }
        }
        elsif ($form->title eq "preferences") {
                }
        }
        elsif ($form->title eq "preferences") {
-               $form->field(name => "name", disabled => 1, 
-                       value => $session->param("name"), force => 1,
-                       fieldset => "login");
-               $form->field(name => "password", type => "password",
-                       fieldset => "login",
-                       validate => sub {
-                               shift eq $form->field("confirm_password");
-                       }),
-               $form->field(name => "confirm_password", type => "password",
-                       fieldset => "login",
-                       validate => sub {
-                               shift eq $form->field("password");
-                       }),
+               my $user=$session->param("name");
+               if (! IkiWiki::openiduser($user)) {
+                       $form->field(name => "name", disabled => 1, 
+                               value => $user, force => 1,
+                               fieldset => "login");
+                       $form->field(name => "password", type => "password",
+                               fieldset => "login",
+                               validate => sub {
+                                       shift eq $form->field("confirm_password");
+                               });
+                       $form->field(name => "confirm_password", type => "password",
+                               fieldset => "login",
+                               validate => sub {
+                                       shift eq $form->field("password");
+                               });
+                       
+                       my $userpage=IkiWiki::userpage($user);
+                       if (exists $pagesources{$userpage}) {
+                               $form->text(gettext("Your user page: ").
+                                       htmllink("", "", $userpage,
+                                               noimageinline => 1));
+                       }
+                       else {
+                               $form->text("<a href=\"".
+                                       IkiWiki::cgiurl(do => "edit", page => $userpage).
+                                       "\">".gettext("Create your user page")."</a>");
+                       }
+               }
        }
 }
 
        }
 }
 
-sub formbuilder (@) { #{{{
+sub formbuilder (@) {
        my %params=@_;
 
        my $form=$params{form};
        my %params=@_;
 
        my $form=$params{form};
@@ -226,8 +315,10 @@ sub formbuilder (@) { #{{{
        my $cgi=$params{cgi};
        my $buttons=$params{buttons};
 
        my $cgi=$params{cgi};
        my $buttons=$params{buttons};
 
+       my $do_register=defined $cgi->param("do") && $cgi->param("do") eq "register";
+
        if ($form->title eq "signin" || $form->title eq "register") {
        if ($form->title eq "signin" || $form->title eq "register") {
-               if ($form->submitted && $form->validate) {
+               if (($form->submitted && $form->validate) || $do_register) {
                        if ($form->submitted eq 'Login') {
                                $session->param("name", $form->field("name"));
                                IkiWiki::cgi_postsignin($cgi, $session);
                        if ($form->submitted eq 'Login') {
                                $session->param("name", $form->field("name"));
                                IkiWiki::cgi_postsignin($cgi, $session);
@@ -252,27 +343,20 @@ sub formbuilder (@) { #{{{
                                if (! length $email) {
                                        error(gettext("No email address, so cannot email password reset instructions."));
                                }
                                if (! length $email) {
                                        error(gettext("No email address, so cannot email password reset instructions."));
                                }
-                               
-                               # Store a token that can be used once
-                               # to log the user in. This needs to be hard
-                               # to guess. Generating a cgi session id will
-                               # make it as hard to guess as any cgi session.
-                               eval q{use CGI::Session};
-                               error($@) if $@;
-                               my $token = CGI::Session->new->id;
-                               setpassword($user_name, $token, "resettoken");
+
+                               my $token=gentoken($user_name, "resettoken");
                                
                                my $template=template("passwordmail.tmpl");
                                $template->param(
                                        user_name => $user_name,
                                
                                my $template=template("passwordmail.tmpl");
                                $template->param(
                                        user_name => $user_name,
-                                       passwordurl => IkiWiki::cgiurl(
+                                       passwordurl => IkiWiki::cgiurl_abs(
                                                'do' => "reset",
                                                'name' => $user_name,
                                                'token' => $token,
                                        ),
                                        wikiurl => $config{url},
                                        wikiname => $config{wikiname},
                                                'do' => "reset",
                                                'name' => $user_name,
                                                'token' => $token,
                                        ),
                                        wikiurl => $config{url},
                                        wikiname => $config{wikiname},
-                                       REMOTE_ADDR => $ENV{REMOTE_ADDR},
+                                       remote_addr => $session->remote_addr(),
                                );
                                
                                eval q{use Mail::Sendmail};
                                );
                                
                                eval q{use Mail::Sendmail};
@@ -290,7 +374,7 @@ sub formbuilder (@) { #{{{
                                $form->field(name => "name", required => 0);
                                push @$buttons, "Reset Password";
                        }
                                $form->field(name => "name", required => 0);
                                push @$buttons, "Reset Password";
                        }
-                       elsif ($form->submitted eq "Register") {
+                       elsif ($form->submitted eq "Register" || $do_register) {
                                @$buttons="Create Account";
                        }
                }
                                @$buttons="Create Account";
                        }
                }
@@ -304,14 +388,14 @@ sub formbuilder (@) { #{{{
        elsif ($form->title eq "preferences") {
                if ($form->submitted eq "Save Preferences" && $form->validate) {
                        my $user_name=$form->field('name');
        elsif ($form->title eq "preferences") {
                if ($form->submitted eq "Save Preferences" && $form->validate) {
                        my $user_name=$form->field('name');
-                       if ($form->field("password") && length $form->field("password")) {
+                       if (defined $form->field("password") && length $form->field("password")) {
                                setpassword($user_name, $form->field('password'));
                        }
                }
        }
                                setpassword($user_name, $form->field('password'));
                        }
                }
        }
-} #}}}
+}
 
 
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 
@@ -331,6 +415,36 @@ sub sessioncgi ($$) { #{{{
                IkiWiki::cgi_prefs($q, $session);
                exit;
        }
                IkiWiki::cgi_prefs($q, $session);
                exit;
        }
-} #}}}
+       elsif ($q->param('do') eq 'tokenauth') {
+               my $name=$q->param("name");
+               my $token=$q->param("token");
+
+               if (! defined $name || ! defined $token ||
+                   ! length $name  || ! length $token) {
+                       error(gettext("incorrect url"));
+               }
+               if (! checkpassword($name, $token, "passwordless")) {
+                       error(gettext("access denied"));
+               }
+
+               $session->param("name", $name);
+               IkiWiki::cgi_prefs($q, $session);
+               exit;
+       }
+       elsif ($q->param("do") eq "register") {
+               # After registration, need to go somewhere, so show prefs page.
+               $session->param(postsignin => "do=prefs");
+               # Due to do=register, this will run in registration-only
+               # mode.
+               IkiWiki::cgi_signin($q, $session);
+               exit;
+       }
+}
+
+sub auth ($$) {
+       # While this hook is not currently used, it needs to exist
+       # so ikiwiki knows that the wiki supports logins, and will
+       # enable the Preferences page.
+}
 
 1
 
 1