Merge commit 'remotes/smcv/ready/among'

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

diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm
index 65b884814e9795af6f615e514868585704d9f328..dc0e0f48ee98e70313abce4d195092989e5537c6 100644 (file)
--- a/IkiWiki/Plugin/openid.pm
+++ b/IkiWiki/Plugin/openid.pm
@@ -4,38 +4,64 @@ package IkiWiki::Plugin::openid;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 3.00;
 
-sub import { #{{{
+sub import {
        hook(type => "getopt", id => "openid", call => \&getopt);
+       hook(type => "getsetup", id => "openid", call => \&getsetup);
        hook(type => "auth", id => "openid", call => \&auth);
        hook(type => "formbuilder_setup", id => "openid",
                call => \&formbuilder_setup, last => 1);
-} # }}}
+}
 
-sub getopt () { #{{{
+sub getopt () {
        eval q{use Getopt::Long};
        error($@) if $@;
        Getopt::Long::Configure('pass_through');
        GetOptions("openidsignup=s" => \$config{openidsignup});
-} #}}}
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
+               openidsignup => {
+                       type => "string",
+                       example => "http://myopenid.com/",
+                       description => "an url where users can signup for an OpenID",
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
 
-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {
        my %params=@_;
 
        my $form=$params{form};
        my $session=$params{session};
        my $cgi=$params{cgi};
-
+       
        if ($form->title eq "signin") {
+               # Give up if module is unavailable to avoid
+               # needing to depend on it.
+               eval q{use Net::OpenID::Consumer};
+               if ($@) {
+                       debug("unable to load Net::OpenID::Consumer, not enabling OpenID login ($@)");
+                       return;
+               }
+
+               # This avoids it displaying a redundant label for the
+               # OpenID fieldset.
+               $form->fieldsets("OpenID");
+
                $form->field(
                        name => "openid_url",
-                       label => "OpenID",
+                       label => gettext("Log in with")." ".htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
+                       fieldset => "OpenID",
                        size => 30,
-                       comment => '('.
-                               htmllink("", "", "OpenID", noimageinline => 1, linktext => gettext("What's this?"))
-                               .($config{openidsignup} ? " | <a href=\"$config{openidsignup}\">".gettext("Get an OpenID")."</a>" : "")
-                               .')'
+                       comment => ($config{openidsignup} ? " | <a href=\"$config{openidsignup}\">".gettext("Get an OpenID")."</a>" : "")
                );
 
                # Handle submission of an OpenID as validation.
@@ -58,13 +84,15 @@ sub formbuilder_setup (@) { #{{{
        }
        elsif ($form->title eq "preferences") {
                if (! defined $form->field(name => "name")) {
-                       $form->field(name => "OpenID", disabled => 1, value =>
-                               $session->param("name"), size => 50, force => 1);
+                       $form->field(name => "OpenID", disabled => 1,
+                               value => $session->param("name"), 
+                               size => 50, force => 1,
+                               fieldset => "login");
                }
        }
 }
 
-sub validate ($$$;$) { #{{{
+sub validate ($$$;$) {
        my $q=shift;
        my $session=shift;
        my $openid_url=shift;
@@ -93,9 +121,9 @@ sub validate ($$$;$) { #{{{
        # eventually bounce them back to auth()
        IkiWiki::redirect($q, $check_url);
        exit 0;
-} #}}}
+}
 
-sub auth ($$) { #{{{
+sub auth ($$) {
        my $q=shift;
        my $session=shift;
 
@@ -119,9 +147,9 @@ sub auth ($$) { #{{{
                # myopenid.com affiliate support
                validate($q, $session, $q->param('openid_identifier'));
        }
-} #}}}
+}
 
-sub getobj ($$) { #{{{
+sub getobj ($$) {
        my $q=shift;
        my $session=shift;
 
@@ -150,6 +178,6 @@ sub getobj ($$) { #{{{
                consumer_secret => sub { return shift()+$secret },
                required_root => $config{cgiurl},
        );
-} #}}}
+}
 
 1