Merge branch 'master' of /var/www/trunk

[quix0rs-gnu-social.git] / actions / finishaddopenid.php

diff --git a/actions/finishaddopenid.php b/actions/finishaddopenid.php
index 07024e09151fc3fdf9f54df66f7791dd2a8ea182..8f10505cffe1b3ac40fc70dbce97385af7bef774 100644 (file)
--- a/actions/finishaddopenid.php
+++ b/actions/finishaddopenid.php
@@ -1,9 +1,12 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Laconica, the distributed open-source microblogging tool
  *
- * This program is free software: you can redistribute it and/or modify
+ * Complete adding an OpenID
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
@@ -15,25 +18,68 @@
  *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Settings
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2008-2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/openid.php');
+require_once INSTALLDIR.'/lib/openid.php';
 
-class FinishaddopenidAction extends Action {
+/**
+ * Complete adding an OpenID
+ *
+ * Handle the return from an OpenID verification
+ *
+ * @category Settings
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
 
-    function handle($args) {
+class FinishaddopenidAction extends Action
+{
+    var $msg = null;
+
+    /**
+     * Handle the redirect back from OpenID confirmation
+     *
+     * Check to see if the user's logged in, and then try
+     * to use the OpenID login system.
+     *
+     * @param array $args $_REQUEST arguments
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
         parent::handle($args);
         if (!common_logged_in()) {
-            common_user_error(_('Not logged in.'));
+            $this->clientError(_('Not logged in.'));
         } else {
-            $this->try_login();
+            $this->tryLogin();
         }
     }
-    
-    function try_login() {
 
+    /**
+     * Try to log in using OpenID
+     *
+     * Check the OpenID for validity; potentially store it.
+     *
+     * @return void
+     */
+
+    function tryLogin()
+    {
         $consumer =& oid_consumer();
 
         $response = $consumer->complete(common_local_url('finishaddopenid'));
@@ -43,10 +89,11 @@ class FinishaddopenidAction extends Action {
             return;
         } else if ($response->status == Auth_OpenID_FAILURE) {
             // Authentication failed; display the error message.
-            $this->message(sprintf(_('OpenID authentication failed: %s'), $response->message));
+            $this->message(sprintf(_('OpenID authentication failed: %s'),
+                                   $response->message));
         } else if ($response->status == Auth_OpenID_SUCCESS) {
 
-            $display = $response->getDisplayIdentifier();
+            $display   = $response->getDisplayIdentifier();
             $canonical = ($response->endpoint && $response->endpoint->canonicalID) ?
               $response->endpoint->canonicalID : $display;
 
@@ -57,6 +104,7 @@ class FinishaddopenidAction extends Action {
             }
 
             $cur =& common_current_user();
+
             $other = oid_get_user($canonical);
 
             if ($other) {
@@ -68,7 +116,7 @@ class FinishaddopenidAction extends Action {
                 return;
             }
 
-            # start a transaction
+            // start a transaction
 
             $cur->query('BEGIN');
 
@@ -85,7 +133,7 @@ class FinishaddopenidAction extends Action {
                 }
             }
 
-            # success!
+            // success!
 
             $cur->query('COMMIT');
 
@@ -95,9 +143,43 @@ class FinishaddopenidAction extends Action {
         }
     }
 
-    function message($msg) {
-        common_show_header(_('OpenID Login'));
-        common_element('p', NULL, $msg);
-        common_show_footer();
+    /**
+     * Show a failure message
+     *
+     * Something went wrong. Save the message, and show the page.
+     *
+     * @param string $msg Error message to show
+     *
+     * @return void
+     */
+
+    function message($msg)
+    {
+        $this->message = $msg;
+        $this->showPage();
+    }
+
+    /**
+     * Title of the page
+     *
+     * @return string title
+     */
+
+    function title()
+    {
+        return _('OpenID Login');
+    }
+
+    /**
+     * Show error message
+     *
+     * @return void
+     */
+
+    function showPageNotice()
+    {
+        if ($this->message) {
+            $this->element('p', 'error', $this->message);
+        }
     }
 }