(no commit message)

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

diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm
index a24ee75196b333f54e6e067e002b3e689a9cef26..7b1a17831f9155ea7034a528198ee864bb5cf6e4 100644 (file)
--- a/IkiWiki/Plugin/openid.pm
+++ b/IkiWiki/Plugin/openid.pm
@@ -4,34 +4,63 @@ package IkiWiki::Plugin::openid;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 
 

-sub import { #{{{
+sub import {

        hook(type => "getopt", id => "openid", call => \&getopt);
        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);
        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});
        eval q{use Getopt::Long};
        error($@) if $@;
        Getopt::Long::Configure('pass_through');
        GetOptions("openidsignup=s" => \$config{openidsignup});

-} #}}}
+}

 
 

-sub formbuilder_setup (@) { #{{{
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+                       section => "auth",
+               },
+               openidsignup => {
+                       type => "string",
+                       example => "http://myopenid.com/",
+                       description => "an url where users can signup for an OpenID",
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
+
+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") {
        if ($form->title eq "signin") {

-               $form->field(
+               # 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",
                        name => "openid_url",

-                       label => "OpenID",
-                       fieldset => gettext("Log in with")." ".htmllink("", "", "OpenID", noimageinline => 1),
+                       label => gettext("Log in with")." ".htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
+                       fieldset => "OpenID",

                        size => 30,
                        comment => ($config{openidsignup} ? " | <a href=\"$config{openidsignup}\">".gettext("Get an OpenID")."</a>" : "")
                );
                        size => 30,
                        comment => ($config{openidsignup} ? " | <a href=\"$config{openidsignup}\">".gettext("Get an OpenID")."</a>" : "")
                );


@@ -54,17 +83,18 @@ 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,
-                               fieldset => "login");
-               }
+       elsif ($form->title eq "preferences" &&
+              IkiWiki::openiduser($session->param("name"))) {
+               $form->field(name => "openid_url", disabled => 1,
+                       label => htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
+                       value => $session->param("name"), 
+                       size => 50, force => 1,
+                       fieldset => "login");
+               $form->field(name => "email", type => "hidden");

        }
 }
 
        }
 }
 

-sub validate ($$$;$) { #{{{
+sub validate ($$$;$) {

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


@@ -84,6 +114,28 @@ sub validate ($$$;$) { #{{{
                }
        }
 
                }
        }
 

+       # Ask for client to provide a name and email, if possible.
+       # Try sreg and ax
+       if ($claimed_identity->can("set_extension_args")) {
+               $claimed_identity->set_extension_args(
+                       'http://openid.net/extensions/sreg/1.1',
+                       {
+                               optional => 'email,fullname,nickname',
+                       },
+               );
+               $claimed_identity->set_extension_args(
+                       'http://openid.net/srv/ax/1.0',
+                       {
+                               mode => 'fetch_request',
+                               'required' => 'email,fullname,nickname,firstname',
+                               'type.email' => "http://schema.openid.net/contact/email",
+                               'type.fullname' => "http://axschema.org/namePerson",
+                               'type.nickname' => "http://axschema.org/namePerson/friendly",
+                               'type.firstname' => "http://axschema.org/namePerson/first",
+                       },
+               );
+       }
+

        my $check_url = $claimed_identity->check_url(
                return_to => IkiWiki::cgiurl(do => "postsignin"),
                trust_root => $config{cgiurl},
        my $check_url = $claimed_identity->check_url(
                return_to => IkiWiki::cgiurl(do => "postsignin"),
                trust_root => $config{cgiurl},


@@ -93,9 +145,9 @@ sub validate ($$$;$) { #{{{
        # eventually bounce them back to auth()
        IkiWiki::redirect($q, $check_url);
        exit 0;
        # eventually bounce them back to auth()
        IkiWiki::redirect($q, $check_url);
        exit 0;

-} #}}}
+}

 
 

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

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


@@ -110,6 +162,32 @@ sub auth ($$) { #{{{
                }
                elsif (my $vident = $csr->verified_identity) {
                        $session->param(name => $vident->url);
                }
                elsif (my $vident = $csr->verified_identity) {
                        $session->param(name => $vident->url);

+
+                       my @extensions;
+                       if ($vident->can("signed_extension_fields")) {
+                               @extensions=grep { defined } (
+                                       $vident->signed_extension_fields('http://openid.net/extensions/sreg/1.1'),
+                                       $vident->signed_extension_fields('http://openid.net/srv/ax/1.0'),
+                               );
+                       }
+                       foreach my $ext (@extensions) {
+                               foreach my $field (qw{value.email email}) {
+                                       if (exists $ext->{$field} &&
+                                           defined $ext->{$field} &&
+                                           length $ext->{$field}) {
+                                               $session->param(email => $ext->{$field});
+                                               last;
+                                       }
+                               }
+                               foreach my $field (qw{value.nickname nickname value.fullname fullname value.firstname}) {
+                                       if (exists $ext->{$field} &&
+                                           defined $ext->{$field} &&
+                                           length $ext->{$field}) {
+                                               $session->param(username => $ext->{$field});
+                                               last;
+                                       }
+                               }
+                       }

                }
                else {
                        error("OpenID failure: ".$csr->err);
                }
                else {
                        error("OpenID failure: ".$csr->err);


@@ -119,9 +197,9 @@ sub auth ($$) { #{{{
                # myopenid.com affiliate support
                validate($q, $session, $q->param('openid_identifier'));
        }
                # myopenid.com affiliate support
                validate($q, $session, $q->param('openid_identifier'));
        }

-} #}}}
+}

 
 

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

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


@@ -150,6 +228,6 @@ sub getobj ($$) { #{{{
                consumer_secret => sub { return shift()+$secret },
                required_root => $config{cgiurl},
        );
                consumer_secret => sub { return shift()+$secret },
                required_root => $config{cgiurl},
        );

-} #}}}
+}

 
 1
 
 1