reorg

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

diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm
index e8dbe964ffb2e901f759e22bb72aaf8ebec11c8a..5424c57e2c6f8e8093eb56d1aba6aee696a05b39 100644 (file)
--- a/IkiWiki/Plugin/openid.pm
+++ b/IkiWiki/Plugin/openid.pm
@@ -4,38 +4,54 @@ 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,
+               },
+               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};
        

-       # 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;
-       }
-

        if ($form->title eq "signin") {
        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");
                # This avoids it displaying a redundant label for the
                # OpenID fieldset.
                $form->fieldsets("OpenID");


@@ -76,7 +92,7 @@ sub formbuilder_setup (@) { #{{{
        }
 }
 
        }
 }
 

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

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


@@ -105,9 +121,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;
 


@@ -131,9 +147,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;
 


@@ -162,6 +178,35 @@ sub getobj ($$) { #{{{
                consumer_secret => sub { return shift()+$secret },
                required_root => $config{cgiurl},
        );
                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]"
+               # (also "user.somehost.co.uk")
+               if ($display !~ /\[/) {
+                       $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
+               }
+               # Convert "http://somehost.com/user" to "user [somehost.com]".
+               # (also "https://somehost.com/user/")
+               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
 
 1