clarification

[git.ikiwiki.info.git] / IkiWiki / Plugin / passwordauth.pm

diff --git a/IkiWiki/Plugin/passwordauth.pm b/IkiWiki/Plugin/passwordauth.pm
index f3f1aa4bf2b7b5f761859d7a75a2c0d68f8b4eb7..8cf5af51ed03d47ff90963dd1aece3c9ea773cbb 100644 (file)
--- a/IkiWiki/Plugin/passwordauth.pm
+++ b/IkiWiki/Plugin/passwordauth.pm
@@ -4,18 +4,40 @@ package IkiWiki::Plugin::passwordauth;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 
 

-sub import { #{{{
-        hook(type => "formbuilder_setup", id => "passwordauth",
-               call => \&formbuilder_setup);
-        hook(type => "formbuilder", id => "passwordauth",
-               call => \&formbuilder);
+sub import {
+       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 => "sessioncgi", id => "passwordauth", call => \&sessioncgi);
        hook(type => "sessioncgi", id => "passwordauth", call => \&sessioncgi);

-} # }}}
+       hook(type => "auth", id => "passwordauth", call => \&auth);
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
+               account_creation_password => {
+                       type => "string",
+                       example => "s3cr1t",
+                       description => "a password that must be entered when signing up for an account",
+                       safe => 1,
+                       rebuild => 0,
+               },
+               password_cost => {
+                       type => "integer",
+                       example => 8,
+                       description => "cost of generating a password using Authen::Passphrase::BlowfishCrypt",
+                       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";


@@ -53,9 +75,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";


@@ -73,9 +95,9 @@ sub setpassword ($$;$) { #{{{
        else {
                IkiWiki::userinfo_set($user, $field, $password);
        }
        else {
                IkiWiki::userinfo_set($user, $field, $password);
        }

-} #}}}
+}

 
 

-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {

        my %params=@_;
 
        my $form=$params{form};
        my %params=@_;
 
        my $form=$params{form};


@@ -88,7 +110,9 @@ sub formbuilder_setup (@) { #{{{
                
                if ($form->submitted eq "Register" || $form->submitted eq "Create Account") {
                        $form->field(name => "confirm_password", type => "password");
                
                if ($form->submitted eq "Register" || $form->submitted eq "Create Account") {
                        $form->field(name => "confirm_password", type => "password");

-                       $form->field(name => "account_creation_password", type => "password") if (length $config{account_creation_password});
+                       $form->field(name => "account_creation_password", type => "password")
+                                if (defined $config{account_creation_password} &&
+                                    length $config{account_creation_password});

                        $form->field(name => "email", size => 50);
                        $form->title("register");
                        $form->text("");
                        $form->field(name => "email", size => 50);
                        $form->title("register");
                        $form->text("");


@@ -125,7 +149,8 @@ sub formbuilder_setup (@) { #{{{
                                                shift eq $config{account_creation_password};
                                        },
                                        required => 1,
                                                shift eq $config{account_creation_password};
                                        },
                                        required => 1,

-                               ) if (length $config{account_creation_password});
+                               ) if (defined $config{account_creation_password} &&
+                                     length $config{account_creation_password});

                                $form->field(
                                        name => "email",
                                        validate => "EMAIL",
                                $form->field(
                                        name => "email",
                                        validate => "EMAIL",


@@ -198,7 +223,7 @@ sub formbuilder_setup (@) { #{{{
        }
 }
 
        }
 }
 

-sub formbuilder (@) { #{{{
+sub formbuilder (@) {

        my %params=@_;
 
        my $form=$params{form};
        my %params=@_;
 
        my $form=$params{form};


@@ -259,7 +284,9 @@ sub formbuilder (@) { #{{{
                                error($@) if $@;
                                sendmail(
                                        To => IkiWiki::userinfo_get($user_name, "email"),
                                error($@) if $@;
                                sendmail(
                                        To => IkiWiki::userinfo_get($user_name, "email"),

-                                       From => "$config{wikiname} admin <$config{adminemail}>",
+                                       From => "$config{wikiname} admin <".
+                                               (defined $config{adminemail} ? $config{adminemail} : "")
+                                               .">",

                                        Subject => "$config{wikiname} information",
                                        Message => $template->output,
                                ) or error(gettext("Failed to send mail"));
                                        Subject => "$config{wikiname} information",
                                        Message => $template->output,
                                ) or error(gettext("Failed to send mail"));


@@ -287,9 +314,9 @@ sub formbuilder (@) { #{{{
                        }
                }
        }
                        }
                }
        }

-} #}}}
+}

 
 

-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {

        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 


@@ -309,6 +336,12 @@ sub sessioncgi ($$) { #{{{
                IkiWiki::cgi_prefs($q, $session);
                exit;
        }
                IkiWiki::cgi_prefs($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