openid: Use Openid Simple Registration or OpenID Attribute Exchange to get the user...

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

diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm
index bc9311d9c04aec49b1db6f269663bc52b379391b..9355cd85ad1cc27178b9c993d0f6d2a0245d36bf 100644 (file)
--- a/IkiWiki/Plugin/openid.pm
+++ b/IkiWiki/Plugin/openid.pm
@@ -4,36 +4,40 @@ package IkiWiki::Plugin::openid;
 
 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 => "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 () { #{{{
+sub getsetup () {
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+                       section => "auth",
+               },
                openidsignup => {
                        type => "string",
-                       default => "",
                        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};
@@ -45,7 +49,7 @@ sub formbuilder_setup (@) { #{{{
                # needing to depend on it.
                eval q{use Net::OpenID::Consumer};
                if ($@) {
-                       debug("unable to load Net::OpenID::Consumer, not enabling OpenID login");
+                       debug("unable to load Net::OpenID::Consumer, not enabling OpenID login ($@)");
                        return;
                }
 
@@ -53,7 +57,7 @@ sub formbuilder_setup (@) { #{{{
                # OpenID fieldset.
                $form->fieldsets("OpenID");
 
-               $form->field(
+               $form->field(
                        name => "openid_url",
                        label => gettext("Log in with")." ".htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
                        fieldset => "OpenID",
@@ -79,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;
@@ -109,6 +114,26 @@ sub validate ($$$;$) { #{{{
                }
        }
 
+       # Ask for client to provide a name and email, if possible.
+       # Try sreg and ax
+       $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},
@@ -118,9 +143,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;
 
@@ -135,6 +160,29 @@ sub auth ($$) { #{{{
                }
                elsif (my $vident = $csr->verified_identity) {
                        $session->param(name => $vident->url);
+
+                       my @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);
@@ -144,9 +192,9 @@ sub auth ($$) { #{{{
                # myopenid.com affiliate support
                validate($q, $session, $q->param('openid_identifier'));
        }
-} #}}}
+}
 
-sub getobj ($$) { #{{{
+sub getobj ($$) {
        my $q=shift;
        my $session=shift;
 
@@ -175,33 +223,6 @@ sub getobj ($$) { #{{{
                consumer_secret => sub { return shift()+$secret },
                required_root => $config{cgiurl},
        );
-} #}}}
-
-package IkiWiki;
-
-# This is not used by this plugin, but this seems the best place to put it.
-# Used elsewhere to pretty-display the name of an openid user.
-sub openiduser ($) { #{{{
-       my $user=shift;
-
-       if ($user =~ m!^https?://! &&
-           eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
-               my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
-               my $display=$oid->display;
-               # Convert "user.somehost.com" to "user [somehost.com]".
-               if ($display !~ /\[/) {
-                       $display=~s/^(.*?)\.([^.]+\.[a-z]+)$/$1 [$2]/;
-               }
-               # Convert "http://somehost.com/user" to "user [somehost.com]".
-               if ($display !~ /\[/) {
-                       $display=~s/^https?:\/\/(.+)\/([^\/]+)$/$2 [$1]/;
-               }
-               $display=~s!^https?://!!; # make sure this is removed
-               eval q{use CGI 'escapeHTML'};
-               error($@) if $@;
-               return escapeHTML($display);
-       }
-       return;
 }
 
 1