]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/xrds.php
Update copyright dates in files modified in 2009
[quix0rs-gnu-social.git] / actions / xrds.php
index 54baf64be11dcbf7847e696fff9b0905d448f39a..9327a3c83145ecbdf1bc354f790f5e7597e8efdc 100644 (file)
@@ -1,7 +1,19 @@
 <?php
-/*
+
+/**
+ * XRDS for OpenID
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Robin Millette <millette@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ *
  * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+ * Copyright (C) 2008, 2009, Control Yourself, Inc.
  *
  * 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
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/omb.php');
+require_once INSTALLDIR.'/lib/omb.php';
 
-class XrdsAction extends Action {
-
-    function is_readonly() {                
+/**
+ * XRDS for OpenID
+ *
+ * @category Action
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Robin Millette <millette@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ */
+class XrdsAction extends Action
+{
+    /**
+     * Is read only?
+     *
+     * @return boolean true
+     */
+    function isReadOnly($args)
+    {
         return true;
     }
 
-    function handle($args) {
+    /**
+     * Class handler.
+     *
+     * @param array $args query arguments
+     *
+     * @return void
+     */
+    function handle($args)
+    {
         parent::handle($args);
         $nickname = $this->trimmed('nickname');
-        $user = User::staticGet('nickname', $nickname);
+        $user     = User::staticGet('nickname', $nickname);
         if (!$user) {
-            common_user_error(_('No such user.'));
+            $this->clientError(_('No such user.'));
             return;
         }
-        $this->show_xrds($user);
+        $this->showXrds($user);
     }
 
-    function show_xrds($user) {
-
+    /**
+     * Show XRDS for a user.
+     *
+     * @param class $user XRDS for this user.
+     *
+     * @return void
+     */
+    function showXrds($user)
+    {
         header('Content-Type: application/xrds+xml');
+        $this->startXML();
+        $this->elementStart('XRDS', array('xmlns' => 'xri://$xrds'));
 
-        common_start_xml();
-        common_element_start('XRDS', array('xmlns' => 'xri://$xrds'));
-
-        common_element_start('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
+        $this->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
                                           'xml:id' => 'oauth',
                                           'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
                                           'version' => '2.0'));
-
-        common_element('Type', null, 'xri://$xrds*simple');
-
-        $this->show_service(OAUTH_ENDPOINT_REQUEST,
+        $this->element('Type', null, 'xri://$xrds*simple');
+        $this->showService(OAUTH_ENDPOINT_REQUEST,
                             common_local_url('requesttoken'),
                             array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
                             array(OAUTH_HMAC_SHA1),
                             $user->uri);
-
-        $this->show_service(OAUTH_ENDPOINT_AUTHORIZE,
+        $this->showService(OAUTH_ENDPOINT_AUTHORIZE,
                             common_local_url('userauthorization'),
                             array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
                             array(OAUTH_HMAC_SHA1));
-
-        $this->show_service(OAUTH_ENDPOINT_ACCESS,
+        $this->showService(OAUTH_ENDPOINT_ACCESS,
                             common_local_url('accesstoken'),
                             array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
                             array(OAUTH_HMAC_SHA1));
-
-        $this->show_service(OAUTH_ENDPOINT_RESOURCE,
+        $this->showService(OAUTH_ENDPOINT_RESOURCE,
                             null,
                             array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
                             array(OAUTH_HMAC_SHA1));
+        $this->elementEnd('XRD');
 
-        common_element_end('XRD');
-
-        # XXX: decide whether to include user's ID/nickname in postNotice URL
-
-        common_element_start('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
+        // XXX: decide whether to include user's ID/nickname in postNotice URL
+        $this->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
                                           'xml:id' => 'omb',
                                           'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
                                           'version' => '2.0'));
-
-        common_element('Type', null, 'xri://$xrds*simple');
-
-        $this->show_service(OMB_ENDPOINT_POSTNOTICE,
+        $this->element('Type', null, 'xri://$xrds*simple');
+        $this->showService(OMB_ENDPOINT_POSTNOTICE,
                             common_local_url('postnotice'));
-
-        $this->show_service(OMB_ENDPOINT_UPDATEPROFILE,
+        $this->showService(OMB_ENDPOINT_UPDATEPROFILE,
                             common_local_url('updateprofile'));
-
-        common_element_end('XRD');
-
-        common_element_start('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
+        $this->elementEnd('XRD');
+        $this->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
                                           'version' => '2.0'));
-
-        common_element('Type', null, 'xri://$xrds*simple');
-
-        $this->show_service(OAUTH_DISCOVERY,
+        $this->element('Type', null, 'xri://$xrds*simple');
+        $this->showService(OAUTH_DISCOVERY,
                             '#oauth');
-        $this->show_service(OMB_NAMESPACE,
+        $this->showService(OMB_NAMESPACE,
                             '#omb');
-
-        common_element_end('XRD');
-
-        common_element_end('XRDS');
-        common_end_xml();
+        $this->elementEnd('XRD');
+        $this->elementEnd('XRDS');
+        $this->endXML();
     }
 
-    function show_service($type, $uri, $params=null, $sigs=null, $localId=null) {
-        common_element_start('Service');
+    /**
+     * Show service.
+     *
+     * @param string $type    XRDS type
+     * @param string $uri     URI
+     * @param array  $params  type parameters, null by default
+     * @param array  $sigs    type signatures, null by default
+     * @param string $localId local ID, null by default
+     *
+     * @return void
+     */
+    function showService($type, $uri, $params=null, $sigs=null, $localId=null)
+    {
+        $this->elementStart('Service');
         if ($uri) {
-            common_element('URI', null, $uri);
+            $this->element('URI', null, $uri);
         }
-        common_element('Type', null, $type);
+        $this->element('Type', null, $type);
         if ($params) {
             foreach ($params as $param) {
-                common_element('Type', null, $param);
+                $this->element('Type', null, $param);
             }
         }
         if ($sigs) {
             foreach ($sigs as $sig) {
-                common_element('Type', null, $sig);
+                $this->element('Type', null, $sig);
             }
         }
         if ($localId) {
-            common_element('LocalID', null, $localId);
+            $this->element('LocalID', null, $localId);
         }
-        common_element_end('Service');
+        $this->elementEnd('Service');
     }
-}
\ No newline at end of file
+}
+