Create Account Manager plugin implementing the Account Management specification
Add Account Manager support to the OpenID plugin
This commit is contained in:
Craig Andrews
parent
8d54809c35
commit
6f95ccd37d
|
|
@ -0,0 +1,98 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* StatusNet, the distributed open-source microblogging tool
|
||||||
|
*
|
||||||
|
* Implements the JSON Account Management endpoint
|
||||||
|
*
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* 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 AccountManager
|
||||||
|
* @package StatusNet
|
||||||
|
* @author Craig Andrews <candrews@integralblue.com>
|
||||||
|
* @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
|
||||||
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
|
* @link http://status.net/
|
||||||
|
*/
|
||||||
|
|
||||||
|
if (!defined('STATUSNET')) {
|
||||||
|
exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the JSON Account Management endpoint
|
||||||
|
*
|
||||||
|
* @category AccountManager
|
||||||
|
* @package StatusNet
|
||||||
|
* @author ECraig Andrews <candrews@integralblue.com>
|
||||||
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
|
* @link http://status.net/
|
||||||
|
*/
|
||||||
|
|
||||||
|
class AccountManagementControlDocumentAction extends Action
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* handle the action
|
||||||
|
*
|
||||||
|
* @param array $args unused.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
|
||||||
|
function handle($args)
|
||||||
|
{
|
||||||
|
parent::handle($args);
|
||||||
|
|
||||||
|
header('Content-Type: application/json; charset=utf-8');
|
||||||
|
|
||||||
|
$amcd = array();
|
||||||
|
|
||||||
|
if(Event::handle('StartAccountManagementControlDocument', array(&$amcd))) {
|
||||||
|
|
||||||
|
$amcd['version'] = 1;
|
||||||
|
$amcd['sessionstatus'] = array(
|
||||||
|
'method' => 'GET',
|
||||||
|
'path' => common_local_url('AccountManagementSessionStatus')
|
||||||
|
);
|
||||||
|
$amcd['auth-methods'] = array(
|
||||||
|
'username-password-form' => array(
|
||||||
|
'connect' => array(
|
||||||
|
'method' => 'POST',
|
||||||
|
'path' => common_local_url('login'),
|
||||||
|
'params' => array(
|
||||||
|
'username' => 'nickname',
|
||||||
|
'password' => 'password'
|
||||||
|
)
|
||||||
|
),
|
||||||
|
'disconnect' => array(
|
||||||
|
'method' => 'GET',
|
||||||
|
'path' => common_local_url('logout')
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
Event::handle('EndAccountManagementControlDocument', array(&$amcd));
|
||||||
|
}
|
||||||
|
|
||||||
|
print json_encode($amcd);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isReadOnly()
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,73 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* StatusNet, the distributed open-source microblogging tool
|
||||||
|
*
|
||||||
|
* Implements the session status Account Management endpoint
|
||||||
|
*
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* 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 AccountManager
|
||||||
|
* @package StatusNet
|
||||||
|
* @author Craig Andrews <candrews@integralblue.com>
|
||||||
|
* @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
|
||||||
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
|
* @link http://status.net/
|
||||||
|
*/
|
||||||
|
|
||||||
|
if (!defined('STATUSNET')) {
|
||||||
|
exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the session status Account Management endpoint
|
||||||
|
*
|
||||||
|
* @category AccountManager
|
||||||
|
* @package StatusNet
|
||||||
|
* @author ECraig Andrews <candrews@integralblue.com>
|
||||||
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
|
* @link http://status.net/
|
||||||
|
*/
|
||||||
|
|
||||||
|
class AccountManagementSessionStatusAction extends Action
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* handle the action
|
||||||
|
*
|
||||||
|
* @param array $args unused.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
|
||||||
|
function handle($args)
|
||||||
|
{
|
||||||
|
parent::handle($args);
|
||||||
|
|
||||||
|
$cur = common_current_user();
|
||||||
|
if(empty($cur)) {
|
||||||
|
print 'none';
|
||||||
|
} else {
|
||||||
|
//TODO it seems " should be escaped in the name and id, but the spec doesn't seem to indicate how to do that
|
||||||
|
print 'active; name="' . $cur->nickname . '"; id="' . $cur->nickname . '"';
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isReadOnly()
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
115
plugins/AccountManager/AccountManagerPlugin.php
Normal file
115
plugins/AccountManager/AccountManagerPlugin.php
Normal file
|
|
@ -0,0 +1,115 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* StatusNet, the distributed open-source microblogging tool
|
||||||
|
*
|
||||||
|
* Plugin to implement the Account Manager specification
|
||||||
|
*
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* 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 Plugin
|
||||||
|
* @package StatusNet
|
||||||
|
* @author Craig Andrews <candrews@integralblue.com>
|
||||||
|
* @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
|
||||||
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
|
* @link http://status.net/
|
||||||
|
*/
|
||||||
|
|
||||||
|
if (!defined('STATUSNET') && !defined('LACONICA')) {
|
||||||
|
exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
class AccountManagerPlugin extends Plugin
|
||||||
|
{
|
||||||
|
|
||||||
|
const AM_REL = 'acct-mgmt';
|
||||||
|
|
||||||
|
function __construct()
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
function onAutoload($cls)
|
||||||
|
{
|
||||||
|
switch ($cls)
|
||||||
|
{
|
||||||
|
case 'AccountManagementControlDocumentAction':
|
||||||
|
require_once(INSTALLDIR.'/plugins/AccountManager/AccountManagementControlDocumentAction.php');
|
||||||
|
return false;
|
||||||
|
case 'AccountManagementSessionStatusAction':
|
||||||
|
require_once(INSTALLDIR.'/plugins/AccountManager/AccountManagementSessionStatusAction.php');
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hook for RouterInitialized event.
|
||||||
|
*
|
||||||
|
* @param Net_URL_Mapper $m path-to-action mapper
|
||||||
|
* @return boolean hook return
|
||||||
|
*/
|
||||||
|
function onRouterInitialized($m)
|
||||||
|
{
|
||||||
|
// Discovery actions
|
||||||
|
$m->connect('main/amcd.json',
|
||||||
|
array('action' => 'AccountManagementControlDocument'));
|
||||||
|
$m->connect('main/amsessionstatus',
|
||||||
|
array('action' => 'AccountManagementSessionStatus'));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function onStartHostMetaLinks(&$links) {
|
||||||
|
$links[] = array('rel' => AccountManagerPlugin::AM_REL,
|
||||||
|
'href' => common_local_url('AccountManagementControlDocument'));
|
||||||
|
}
|
||||||
|
|
||||||
|
function onStartShowHTML($action)
|
||||||
|
{
|
||||||
|
//Account management discovery link
|
||||||
|
header('Link: <'.common_local_url('AccountManagementControlDocument').'>; rel="'. AccountManagerPlugin::AM_REL.'"; type="application/json"');
|
||||||
|
|
||||||
|
//Account management login status
|
||||||
|
$cur = common_current_user();
|
||||||
|
if(empty($cur)) {
|
||||||
|
header('X-Account-Management-Status: none');
|
||||||
|
} else {
|
||||||
|
//TODO it seems " should be escaped in the name and id, but the spec doesn't seem to indicate how to do that
|
||||||
|
header('X-Account-Management-Status: active; name="' . $cur->nickname . '"; id="' . $cur->nickname . '"');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function onLoginAction($action, &$login) {
|
||||||
|
switch ($action)
|
||||||
|
{
|
||||||
|
case 'AccountManagementControlDocument':
|
||||||
|
$login = true;
|
||||||
|
return false;
|
||||||
|
default:
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function onPluginVersion(&$versions)
|
||||||
|
{
|
||||||
|
$versions[] = array('name' => 'AccountManager',
|
||||||
|
'version' => STATUSNET_VERSION,
|
||||||
|
'author' => 'Craig Andrews',
|
||||||
|
'homepage' => 'http://status.net/wiki/Plugin:AccountManager',
|
||||||
|
'rawdescription' =>
|
||||||
|
_m('The Account Manager plugin implements the Account Manager specification.'));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
16
plugins/AccountManager/README
Normal file
16
plugins/AccountManager/README
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
The Account Manager plugin implements the Account Manager specification to "allow a server to describe an account-based user identification process in terms that a user-agent can understand."
|
||||||
|
|
||||||
|
See https://wiki.mozilla.org/Labs/Weave/Identity/Account_Manager/Spec/Latest
|
||||||
|
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
add "addPlugin('accountManager');"
|
||||||
|
to the bottom of your config.php
|
||||||
|
|
||||||
|
Settings
|
||||||
|
========
|
||||||
|
none
|
||||||
|
|
||||||
|
Example
|
||||||
|
=======
|
||||||
|
addPlugin('accountManager');
|
||||||
|
|
@ -630,6 +630,28 @@ class OpenIDPlugin extends Plugin
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add OpenID information to the Account Management Control Document
|
||||||
|
* Event supplied by the Account Manager plugin
|
||||||
|
*
|
||||||
|
* @param array &$amcd Array that expresses the AMCD
|
||||||
|
*
|
||||||
|
* @return boolean hook value
|
||||||
|
*/
|
||||||
|
|
||||||
|
function onEndAccountManagementControlDocument(&$amcd)
|
||||||
|
{
|
||||||
|
$amcd['auth-methods']['openid'] = array(
|
||||||
|
'connect' => array(
|
||||||
|
'method' => 'POST',
|
||||||
|
'path' => common_local_url('openidlogin'),
|
||||||
|
'params' => array(
|
||||||
|
'identity' => 'openid_url'
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add our version information to output
|
* Add our version information to output
|
||||||
*
|
*
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user