Changeset 27 for trunk/openid-comment

Timestamp:

04/23/06 08:17:13 (4 years ago)

Author:

jallen

Message:

Updating openid-comment to v1.6

Location:

trunk/openid-comment

Files:

• Changes (modified) (1 diff)
• LICENSE (modified) (1 diff)
• README (modified) (3 diffs)
• php (added)
• php/plugins (added)
• php/plugins/function.MTCommentAuthorPictureURL.php (added)
• php/plugins/function.MTLiveJournalSignOnThunk.php (added)
• php/plugins/function.MTOpenIDSignOnThunk.php (added)
• php/plugins/function.MTOpenIDSignOnURL.php (added)
• php/plugins/init.openid-comment.php (added)
• plugins/openid-comment/lib/MT (added)
• plugins/openid-comment/lib/MT/Plugin (added)
• plugins/openid-comment/lib/MT/Plugin/OpenIDIdentity.pm (added)
• plugins/openid-comment/openid-comment.pl (modified) (6 diffs)
• plugins/openid-comment/signon.cgi (modified) (6 diffs)
• plugins/openid-comment/tmpl/blog_config.tmpl (modified) (1 diff)
• pm_to_blib (added)

trunk/openid-comment/Changes

@@ -1 +1 @@
 Revision history for OpenID Comments for MT
 
+1.6    14 April 2006
+       Provide commenters' depictions from their FOAF documents, if available,
+       with a CommentAuthorPictureURL tag.
+       Option to disable inline CSS styles in the SignOnThunk tags.
+       Using the "sign out" link no longer signs OpenID users out of TypeKey.
+1.5    14 November 2005
+       Use commenters' names in FOAF and Atom documents, if available.
+1.4    24 October 2005
+       Dynamic publishing support
+       Save new schema version properly after upgrade
+1.3    24 September 2005
+       Add support for MySQL and Postgres databases
+       Use BigPAPI callbacks to fix List Commenters and Edit Commenter views
+       Unify asset path building in CommentAuthorIdentity and OpenIDSignOnThunk
+       Fix error with Blogger and Atom API posting
+       Error earlier when blog requires commenters' email addresses
+       Use special LJ handling for domain and tilde URLs
+       Improve quality and stylability of thunk HTML
 1.2    16 August 2005
        Don't assume availability of Digest::MD5

trunk/openid-comment/LICENSE

@@ -1 @@
-OpenID Comment 1.0 for Movable Type
+OpenID Comments for Movable Type
 Mark Paschal <markpasc@markpasc.org>
 

trunk/openid-comment/README

@@ -1 +1 @@
 OpenID Comments for MT
 
-This is a Movable Type plugin that empowers commenters on your
-Movable Type site to log in using OpenID.
+This is a Movable Type plugin that empowers commenters on your Movable Type
+site to log in using OpenID.
 
 http://www.sixapart.com/movabletype/
@@ -35 +35 @@
            <MTOpenIDSignOnThunk>
 
+    4. If "Require E-mail Addresses" is enabled on blogs that should
+       accept OpenID sign-ins, disable it. The OpenID protocol does
+       not provide commenters' email addresses, so this option is
+       incompatible with OpenID sign-ins.
+
+
+CONFIGURATION
+
+If the <MTOpenIDSignOnThunk> tag does not meet your needs, you can insert the
+necessary HTML into your templates yourself and customize it. The HTML is:
+
+    <div id="openid">
+        <form method="post" action="<MTOpenIDSignOnURL>">
+            <input type="hidden" name="entry_id" value="<MTEntryID>" />
+            <input type="hidden" name="__mode" value="signon" />
+            <p>
+                <label>Your blog URL:</label>
+                <input name="openid_url" size="35" value="" />
+                <input type="submit" value="Sign in" />
+            </p>
+        </form>
+    </div>
+
+There is also an <MTLiveJournalSignOnThunk> tag that allows your visitors to
+sign in with OpenID by entering just their LiveJournal usernames.
+
 
 COPYRIGHT AND LICENCE
@@ -40 +66 @@
 Copyright 2005 Mark Paschal <markpasc@markpasc.org>
 
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+This library is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.
 

trunk/openid-comment/plugins/openid-comment/openid-comment.pl

@@ -6 +6 @@
 package MT::Plugin::OpenIDComment;
 
-
-MT::Template::Context->add_tag(CommentAuthorIdentity => \&identity_link);
-MT::Template::Context->add_tag(OpenIDSignOnURL => \&signon_url);
-MT::Template::Context->add_tag(OpenIDSignOnThunk => \&signon_thunk);
-MT::Template::Context->add_tag(LiveJournalSignOnThunk => \&signon_thunk);
-
+our $VERSION = '1.6';
 
 our $plugin_obj = MT::Plugin->new({
     name => 'OpenID Comments',
-    version => 1.2,
+    version => $VERSION,
     description => 'Empowers commenters to sign in with OpenID to comment',
 
     settings => MT::PluginSettings->new([
-        ['enable',     { Default => 1, Scope => 'blog' }],
-        ['special_lj', { Default => 1, Scope => 'blog' }],
+        ['enable',       { Default => 1, Scope => 'blog' }],
+        ['special_lj',   { Default => 1, Scope => 'blog' }],
+        ['inline_style', { Default => 1, Scope => 'blog' }],
     ]),
     blog_config_template => 'blog_config.tmpl',
@@ -26 +22 @@
 MT->add_plugin($plugin_obj);
 
+sub instance { $plugin_obj; }
+
+
+MT::Template::Context->add_tag(CommentAuthorIdentity   => \&identity_link);
+MT::Template::Context->add_tag(CommentAuthorPictureURL => \&identity_pic_url);
+MT::Template::Context->add_tag(OpenIDSignOnURL         => \&signon_url);
+MT::Template::Context->add_tag(OpenIDSignOnThunk       => \&signon_thunk);
+MT::Template::Context->add_tag(LiveJournalSignOnThunk  => \&signon_thunk);
+
+sub schema_version { 2 }
 
 sub identity_link {
@@ -35 +41 @@
     ## then OpenID is disabled.
     if($cmt->commenter_id) {
+        require MT::Author;
         my $auth = MT::Author->load($cmt->commenter_id) or return "?";
         my $name = $auth->name;
-        if($name =~ m(^openid\n(.*)$)) {
+        if($name =~ m(^openid\n)) {
             my $cfg = MT::ConfigMgr->instance;
-            my $assets_path = ($cfg->StaticWebPath || $cfg->CGIPath) . 'openid-comment';
-            my $identity = $1;
-            if($config->{special_lj} && $identity =~ m(^http://www.livejournal.com/users/([^/]+))) {
-                return qq(<a class="commenter-profile" href="${identity}info"><img alt="[LiveJournal user info]" src="$assets_path/livejournal.gif" width="17" height="17" /></a>);
+            my $assets_path = MT::Template::Context::_hdlr_static_path($ctx, {}) . 'openid-comment';
+
+            require MT::Plugin::OpenIDIdentity;
+            my $id = MT::Plugin::OpenIDIdentity->load({ author_id => $auth->id });
+            my $identity = $id->url;
+
+            if($config->{special_lj}) {
+                if( $identity =~ m(^http://www\.livejournal\.com\/users/[^/]+/$) ||
+                    $identity =~ m(^http://www\.livejournal\.com\/~[^/]+/$) ||
+                    $identity =~ m(^http://[^\.]+\.livejournal\.com\/$)
+                ) {
+                    return qq(<a class="commenter-profile" href="${identity}info"><img alt="[LiveJournal user info]" src="$assets_path/livejournal.gif" width="17" height="17" /></a>);
+                }
             }
             return qq(<a class="commenter-profile" href="$identity"><img alt="[OpenID Commenter Profile]" src="$assets_path/openid.gif" width="16" height="16" /></a>);
@@ -50 +66 @@
 }
 
+sub identity_pic_url {
+    my ($ctx, $args) = @_;
+    my $cmt = $ctx->stash('comment')
+        or return $ctx->_no_comment_error('MT' . $ctx->stash('tag'));
+    my $config = $plugin_obj->get_config_hash('blog:'. $ctx->stash('blog_id'));
+    ## Don't check for enablement here, so we can handle if OpenID comments are made,
+    ## then OpenID is disabled.
+    if($cmt->commenter_id) {
+        require MT::Author;
+        my $auth = MT::Author->load($cmt->commenter_id) or return "?";
+        my $name = $auth->name;
+        if($name =~ m(^openid\n)) {
+            require MT::Plugin::OpenIDIdentity;
+            my $id = MT::Plugin::OpenIDIdentity->load({ author_id => $auth->id });
+
+            if(my $pic_url = $id->pic_url) {
+                return $pic_url;
+            }
+        }
+    }
+    return $args->{default} || '';
+}
+
 sub signon_url {
     my ($ctx, $args) = @_;
     my $cgipath = $ctx->_hdlr_cgi_path;
-    "${cgipath}plugins/openid-comment/signon.cgi";
+    return "${cgipath}plugins/openid-comment/signon.cgi";
 }
 
@@ -59 +98 @@
     my ($ctx, $args) = @_;
     my $signon_url = signon_url($ctx, $args);
-    my $assets_path = MT->instance->static_path . 'openid-comment';
+    my $assets_path = MT::Template::Context::_hdlr_static_path($ctx, {}) . 'openid-comment';
     my $entry_id = $ctx->stash('entry')->id;
 
     my $livejournal = $ctx->stash('tag') eq 'LiveJournalSignOnThunk' ? 1 : 0;
     my $field_label = $livejournal ? 'Your LiveJournal username' : 'Your blog URL';
-    my $field_name  = $livejournal ? 'user' : 'openid_url';
+    my $field_name  = $livejournal ? 'lj_user' : 'openid_url';
     my $image_name  = $livejournal ? 'livejournal' : 'openid';
+
+    my $style = $plugin_obj->get_config_value('inline_style', 'blog:' . $ctx->stash('blog')->id)
+        ? qq( style="background:white url($assets_path/$image_name.gif) no-repeat; padding-left: 18px;")
+        : ''
+        ;
     
     <<EOF;
-<div id="openid">
+<div id="signon-$image_name">
 <form method="post" action="$signon_url">
 <input type="hidden" name="entry_id" value="$entry_id" />
 <input type="hidden" name="__mode" value="signon" />
 <p>
-<label>$field_label: <input name="$field_name" size="30" value="" style="background: url($assets_path/$image_name.gif) no-repeat; padding-left: 18px;" /></label>
-<input type="submit" value="Sign in" />
+<label for="$field_name">$field_label:</label> <input class="identity" id="$field_name" name="$field_name" size="30" value=""$style />
+<input class="signin" type="submit" value="Sign in" />
 </p>
 </form>
@@ -81 +125 @@
 }
 
+my $original_handle_sign_in = \&MT::App::Comments::handle_sign_in;
+*MT::App::Comments::handle_sign_in = sub {
+    my $app = shift;
+    my $q = $app->{query};
+
+    if($q->param('logout') && $q->param('entry_id')) {
+        my (undef, $commenter) = $app->_get_commenter_session();
+        if($commenter->name =~ m{ \A openid\n }xms) {
+            ## Remove cookie.
+            my $entry  = MT::Entry->load($q->param('entry_id'))
+                or die "No such entry";
+            my $weblog = MT::Blog->load($q->param('blog_id') || $entry->blog_id);
+            $app->_handle_sign_in($weblog);
+
+            ## But don't redirect through TypeKey.
+
+            return $app->redirect($entry->permalink);
+        }
+    }
+
+    return $original_handle_sign_in->($app);
+};
+
+MT->add_callback('bigpapi::template::list_commenters', 5, $plugin_obj, sub {
+    my ($cb, $app, $template) = @_;
+    $$template =~ s((?<=<TMPL_VAR NAME=PROFILE_PAGE>)/)()s;
+});
+
+sub _fix_identity {
+    my ($author_id, $blog_id) = @_;
+    my ($author_name, $author_url, $is_livejournal);
+    
+    require MT::Plugin::OpenIDIdentity;
+    my $id = MT::Plugin::OpenIDIdentity->load({ author_id => $author_id })
+        or return $app->error('No OpenID identity for openid\n author');
+    my $identity = $id->url;
+   
+    my $profile_url = $identity;
+    my $special_lj = $plugin_obj->get_config_value('special_lj', 'blog:' . $blog_id);
+    if($special_lj && (
+        $identity =~ m(^http://www\.livejournal\.com\/users/[^/]+/$) ||
+        $identity =~ m(^http://www\.livejournal\.com\/~[^/]+/$) ||
+        $identity =~ m(^http://[^\.]+\.livejournal\.com\/$)
+    )) {
+        $profile_url .= 'info';
+    }
+    
+    my $display_url = $identity;
+    $display_url =~ s(^\w+://)();
+    $display_url =~ s((?<=^.{40}).+)(...)s;
+
+    return ($display_url, $profile_url);
+}
+
+MT->add_callback('bigpapi::param::list_commenters', 5, $plugin_obj, sub {
+    my ($cb, $app, $param) = @_;
+
+    my $special_lj = $plugin_obj->get_config_value('special_lj', 'blog:' . $param->{blog_id});
+    
+    for my $table (@{ $param->{commenter_table} }) {
+        for my $cmtr (@{ $table->{object_loop} }) {
+            if($cmtr->{author} =~ m(^openid\n)) {
+                ($cmtr->{author}, $cmtr->{profile_page}) = _fix_identity(
+                    $cmtr->{author_id}, $param->{blog_id});
+            }
+        }
+    }
+});
+
+MT->add_callback('bigpapi::param::edit_commenter', 5, $plugin_obj, sub {
+    my ($cb, $app, $param) = @_;
+    if($param->{name} =~ m(^openid\n)) {
+        ($param->{name}, $param->{profile_page}) = _fix_identity(
+            $param->{id}, $param->{blog_id});
+    }
+});
+
 
 1;

trunk/openid-comment/plugins/openid-comment/signon.cgi

@@ -41 +41 @@
 
 use Net::OpenID::Consumer;
+use XML::XPath;
 
 sub init {
@@ -47 +48 @@
 
     $app->add_methods(
-        oops => \&oops,
+        oops   => \&oops,
         signon => \&signon,
         verify => \&verify,
@@ -76 +77 @@
 
     my $identity = $q->param('openid_url');
-    if(!$identity && $q->param('user')) {
-        $identity = 'http://www.livejournal.com/users/' . $q->param('user');
+    if(!$identity && $q->param('lj_user')) {
+        $identity = 'http://www.livejournal.com/users/' . $q->param('lj_user');
     }
 
@@ -93 +94 @@
 }
 
+sub _rand {
+    my ($app) = @_;
+    $app->{__have_md5} = (eval { require Digest::MD5; 1 } ? 1 : 0)
+        unless exists $app->{__have_md5};
+    $app->{__have_md5} ? substr(rand(), 2) :
+        Digest::MD5::md5_hex(Digest::MD5::md5_hex(time() . {} . rand() . $$));
+}
+
+sub add_step {
+    my ($app, @step) = @_;
+    push @{ $app->{__upgrade_steps} }, \@step;
+}
+
+sub progress { 1 }
+
+sub do_upgrade {
+    my $app = shift;
+    my $pl = MT::Plugin::OpenIDComment->instance;
+    my $schema = $pl->get_config_value('schema_version', 'system') || 0;
+    my $real_version = MT::Plugin::OpenIDComment->schema_version;
+    if($schema < $real_version) {
+        ## Make schema changes with MT::Upgrade.
+        {
+            require MT::Upgrade;  # feel the burn
+            my $upg = MT::Upgrade->new;
+            local $MT::Upgrade::App = $app;
+            $upg->check_class('MT::Plugin::OpenIDIdentity');
+            $upg->run_step($_) for @{ $app->{__upgrade_steps} };
+        };
+
+        ## Make data changes.
+        if($schema < 1) {
+            ## Delete duplicate OpenIDIdentities that don't contain a real URL.
+            my $id_iter = MT::Plugin::OpenIDIdentity->load_iter;
+            my @to_delete;
+            IDENTITY:
+            while(my $id = $id_iter->()) {
+                next IDENTITY if $id->url =~ m{ \A http }xms;
+                push @to_delete, $id;
+            }
+            $_->remove for @to_delete;
+            
+            ## Make OpenIDIdentities for any openid Author who successfully
+            ## left a comment and doesn't already have one.
+            my $au_iter = MT::Author->load_iter({ type => MT::Author::COMMENTER });
+            AUTHOR:
+            while(my $author = $au_iter->()) {
+                $author->name =~ m{ \A openid \n (.*) }xms;
+                my $url = $1;
+
+                next AUTHOR if !$url;
+                next AUTHOR if $url !~ m{ \A http }xms;
+                next AUTHOR if !MT::Comment->count({ commenter_id => $author->id });
+                next AUTHOR if MT::Plugin::OpenIDIdentity->load({
+                    author_id => $author->id });
+
+                my $id = MT::Plugin::OpenIDIdentity->new;
+                $id->url($url);
+                $id->author_id($author->id);
+                $id->save or return $app->error($id->errstr);
+            }
+        }
+
+        ## All done! Record the upgrade.
+        $pl->set_config_value('schema_version', $real_version, 'system');
+        MT::log('OpenID Comments upgraded its database schema to schema version ' .
+            $pl->get_config_value('schema_version') .' (plugin version '.
+            MT::Plugin::OpenIDComment->instance->version . ')');
+    }
+}
+
+sub _get_profile_data {
+    my ($app, $vident, $blog_id) = @_;
+
+    my $ua = eval { require LWPx::ParanoidAgent; 1; }
+           ? LWPx::ParanoidAgent->new
+           : LWP::UserAgent->new
+           ;
+
+    my $profile = {};
+           
+    ## FOAF
+    if(my $foaf_url = $vident->declared_foaf) {
+        MT::log('FOUND A FOAF URL');
+        my $resp = $ua->get($foaf_url);
+        if($resp->is_success) {
+            MT::log('GOT SOME FOAF');
+            my $xml = XML::XPath->new( xml => $resp->content );
+            $xml->set_namespace('RDF', 'http://www.w3.org/1999/02/22-rdf-syntax-ns#');
+            $xml->set_namespace('FOAF', 'http://xmlns.com/foaf/0.1/');
+            if(my ($name_el) = $xml->findnodes('/RDF:RDF/FOAF:Person/FOAF:name')) {
+                $profile->{nickname} = $name_el->string_value;
+            }
+            if(my ($pic_el) = $xml->findnodes('/RDF:RDF/FOAF:Person/FOAF:depiction/@RDF:resource')) {
+                $profile->{pic_url} = $pic_el->string_value;
+            } elsif(my ($pic_el) = $xml->findnodes('/RDF:RDF/FOAF:Person/FOAF:img/@RDF:resource')) {
+                $profile->{pic_url} = $pic_el->string_value;
+            }
+            $xml->cleanup;
+        }
+        
+        return $profile if $profile->{nickname} && $profile->{pic_url};
+    }
+    
+    ## Atom
+    if(my $atom_url = $vident->declared_atom) {
+        my $resp = $ua->get($atom_url);
+        if($resp->is_success) {
+            my $xml = XML::XPath->new( xml => $resp->content );
+            if(!$profile->{nickname}) {
+                if(my ($name_el) = $xml->findnodes('/feed/author/name')) {
+                    $profile->{nickname} = $name_el->string_value;
+                }
+            }
+            $xml->cleanup;
+        }
+
+        return $profile if $profile->{nickname};
+    }
+    
+    ## LJ username
+    if(MT::Plugin::OpenIDComment->instance->get_config_value('special_lj',
+        'blog:' . $blog_id)
+    ) {
+        my $url = $vident->url;
+        if( $url =~ m(^https?://www\.livejournal\.com\/users/([^/]+)/$) ||
+            $url =~ m(^https?://www\.livejournal\.com\/~([^/]+)/$) ||
+            $url =~ m(^https?://([^\.]+)\.livejournal\.com\/$)
+        ) {
+            $profile->{nickname} = $1;
+        }
+
+        return $profile if $profile->{nickname};
+    }
+
+    $profile->{nickname} ||= $vident->display;
+    return $profile;
+}
+
 sub verify {
     my $app = shift;
@@ -99 +239 @@
         or return $app->error('Invalid entry id '. $q->param('entry_id') .' in verification');
     return $app->error('OpenID signons are not available on this blog')
-        unless $MT::Plugin::OpenIDComment::plugin_obj->get_config_value('enable',
+        unless MT::Plugin::OpenIDComment->instance->get_config_value('enable',
             'blog:' . $entry->blog_id);
+    my $fake_email = 0;
+    if(MT::Blog->count({ id => $entry->blog_id, require_comment_emails => 1 })) {
+        if(MT::Plugin::OpenIDComment->instance->get_config_value('fake_email')) {
+            $fake_email = 1;
+        } else {
+            return $app->error('This blog requires email addresses from commenters, which are not available when signing in with OpenID. Please inform the owner of the blog that the "Require E-mail Address" option should be disabled to allow OpenID sign-ins.');
+        }
+    }
+
+    ## Uh-oh, no errors. We have to do real work. First make sure we can.
+    $app->do_upgrade;
 
     my $csr = $app->_get_csr;
@@ -107 +258 @@
         return $app->redirect($setup_url);
     } elsif(my $vident = $csr->verified_identity) {
-        ## Verified, so set up a new commenter obj and cookie.
-        my $name = "openid\n" . $vident->url;
-        my $nickname = ($vident->url =~ m(^https?://www.livejournal.com/users/([^/]+))) ? $1 : $vident->display;
-        $app->_make_commenter( name => $name, email => '', nickname => $nickname );
-        my $session_id = eval { require Digest::MD5; 1 } ? rand() :
-            Digest::MD5::md5_hex(Digest::MD5::md5_hex(time() . {} . rand() . $$));
-        $app->_make_commenter_session($session_id, '', $name, $nickname);
-
+        ## Verified, so set up the commenter obj and session.
+        my ($author);
+        
+        ## Discern nickname.
+        my $profile = $app->_get_profile_data($vident, $entry->blog_id);
+
+        require MT::Plugin::OpenIDIdentity;
+        my $id = MT::Plugin::OpenIDIdentity->load({ url => $vident->url });
+        if($id) {
+            $author = $id->author;
+            if($author->nickname ne $profile->{nickname}) {
+                $author->nickname($profile->{nickname});
+                $author->save or return $app->error($author->errstr);
+            }
+
+            if(!defined $id->pic_url || $id->pic_url ne $profile->{pic_url}) {
+                $id->pic_url($profile->{pic_url});
+                $id->save or return $app->error($id->errstr);
+            }
+        } else {
+            require MT::Author;
+            ## Find an unused name.
+            my $name = "openid\n" . $app->_rand;
+            $name = "openid\n" . $app->_rand while MT::Author->count({ name => $name });
+            
+            $author = MT::Author->new;
+            $author->set_values({
+                type => MT::Author::COMMENTER,
+                name => $name,
+                ## TODO: fake email to circumvent requirement
+                email => '',
+                nickname => $profile->{nickname},
+                password => '(none)',
+                url => $vident->url,
+            });
+            $author->save or return $app->error($author->errstr);
+
+            $id = MT::Plugin::OpenIDIdentity->new;
+            $id->url($vident->url);
+            $id->author_id($author->id);
+            $id->pic_url($profile->{pic_url});
+            $id->save or return $app->error($id->errstr);
+        }
+        
+        my $session_id = $app->_rand;
+        ## TODO: fake email to circumvent requirement
+        $app->_make_commenter_session($session_id, '', $author->name, $profile->{nickname});
+
+        return $app->redirect($entry->permalink);
+    } elsif($q->param('openid.mode') eq 'cancel') {
+        ## Cancelled!
         return $app->redirect($entry->permalink);
     }

trunk/openid-comment/plugins/openid-comment/tmpl/blog_config.tmpl

@@ -13 +13 @@
 </div>
 
+<div class="label">Use inline CSS styles:</div>
+<div class="field">
+<p><label><input type="checkbox" name="inline_style"<TMPL_IF NAME=INLINE_STYLE> checked="checked"</TMPL_IF> value="1" />
+Use inline <code>style</code> CSS to style the sign on thunk fields. Disable this if you want to style the form with your own CSS instead.</label></p>
 </div>
 
+</div>
+