summaryrefslogtreecommitdiff
path: root/actions/xrds.php
diff options
context:
space:
mode:
Diffstat (limited to 'actions/xrds.php')
-rw-r--r--actions/xrds.php263
1 files changed, 152 insertions, 111 deletions
diff --git a/actions/xrds.php b/actions/xrds.php
index 1d516aab7..075831803 100644
--- a/actions/xrds.php
+++ b/actions/xrds.php
@@ -1,5 +1,17 @@
<?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.
*
@@ -17,116 +29,145 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/omb.php');
-
-class XrdsAction extends Action {
-
- function is_readonly() {
- return true;
- }
-
- function handle($args) {
- parent::handle($args);
- $nickname = $this->trimmed('nickname');
- $user = User::staticGet('nickname', $nickname);
- if (!$user) {
- common_user_error(_('No such user.'));
- return;
- }
- $this->show_xrds($user);
- }
-
- function show_xrds($user) {
-
- header('Content-Type: application/xrds+xml');
-
- common_start_xml();
- common_element_start('XRDS', array('xmlns' => 'xri://$xrds'));
-
- common_element_start('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,
- common_local_url('requesttoken'),
- array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
- array(OAUTH_HMAC_SHA1),
- $user->uri);
-
- $this->show_service(OAUTH_ENDPOINT_AUTHORIZE,
- common_local_url('userauthorization'),
- array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
- array(OAUTH_HMAC_SHA1));
+if (!defined('LACONICA')) {
+ exit(1);
+}
- $this->show_service(OAUTH_ENDPOINT_ACCESS,
- common_local_url('accesstoken'),
- array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
- array(OAUTH_HMAC_SHA1));
+require_once INSTALLDIR.'/lib/omb.php';
- $this->show_service(OAUTH_ENDPOINT_RESOURCE,
- NULL,
- array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
- array(OAUTH_HMAC_SHA1));
-
- 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)',
- '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,
- common_local_url('postnotice'));
-
- $this->show_service(OMB_ENDPOINT_UPDATEPROFILE,
- common_local_url('updateprofile'));
-
- common_element_end('XRD');
-
- common_element_start('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
- 'version' => '2.0'));
-
- common_element('Type', NULL, 'xri://$xrds*simple');
-
- $this->show_service(OAUTH_DISCOVERY,
- '#oauth');
- $this->show_service(OMB_NAMESPACE,
- '#omb');
-
- common_element_end('XRD');
-
- common_element_end('XRDS');
- common_end_xml();
- }
+/**
+ * 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()
+ {
+ return true;
+ }
+
+ /**
+ * Class handler.
+ *
+ * @param array $args query arguments
+ *
+ * @return void
+ */
+ function handle($args)
+ {
+ parent::handle($args);
+ $nickname = $this->trimmed('nickname');
+ $user = User::staticGet('nickname', $nickname);
+ if (!$user) {
+ $this->clientError(_('No such user.'));
+ return;
+ }
+ $this->showXrds($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'));
+
+ $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'));
+ $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->showService(OAUTH_ENDPOINT_AUTHORIZE,
+ common_local_url('userauthorization'),
+ array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
+ array(OAUTH_HMAC_SHA1));
+ $this->showService(OAUTH_ENDPOINT_ACCESS,
+ common_local_url('accesstoken'),
+ array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
+ array(OAUTH_HMAC_SHA1));
+ $this->showService(OAUTH_ENDPOINT_RESOURCE,
+ null,
+ array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY),
+ array(OAUTH_HMAC_SHA1));
+ $this->elementEnd('XRD');
+
+ // 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'));
+ $this->element('Type', null, 'xri://$xrds*simple');
+ $this->showService(OMB_ENDPOINT_POSTNOTICE,
+ common_local_url('postnotice'));
+ $this->showService(OMB_ENDPOINT_UPDATEPROFILE,
+ common_local_url('updateprofile'));
+ $this->elementEnd('XRD');
+ $this->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
+ 'version' => '2.0'));
+ $this->element('Type', null, 'xri://$xrds*simple');
+ $this->showService(OAUTH_DISCOVERY,
+ '#oauth');
+ $this->showService(OMB_NAMESPACE,
+ '#omb');
+ $this->elementEnd('XRD');
+ $this->elementEnd('XRDS');
+ $this->endXML();
+ }
+
+ /**
+ * 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) {
+ $this->element('URI', null, $uri);
+ }
+ $this->element('Type', null, $type);
+ if ($params) {
+ foreach ($params as $param) {
+ $this->element('Type', null, $param);
+ }
+ }
+ if ($sigs) {
+ foreach ($sigs as $sig) {
+ $this->element('Type', null, $sig);
+ }
+ }
+ if ($localId) {
+ $this->element('LocalID', null, $localId);
+ }
+ $this->elementEnd('Service');
+ }
+}
- function show_service($type, $uri, $params=NULL, $sigs=NULL, $localId=NULL) {
- common_element_start('Service');
- if ($uri) {
- common_element('URI', NULL, $uri);
- }
- common_element('Type', NULL, $type);
- if ($params) {
- foreach ($params as $param) {
- common_element('Type', NULL, $param);
- }
- }
- if ($sigs) {
- foreach ($sigs as $sig) {
- common_element('Type', NULL, $sig);
- }
- }
- if ($localId) {
- common_element('LocalID', NULL, $localId);
- }
- common_element_end('Service');
- }
-} \ No newline at end of file
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2024-07-09 12:23:10 +0000