reformat OpenIDPlugin for PHPCS
This commit is contained in:
Evan Prodromou
parent
5b0b6097e0
commit
fcdbf421ab
|
|
@ -59,6 +59,8 @@ class OpenIDPlugin extends Plugin
|
|||
*
|
||||
* Hook for RouterInitialized event.
|
||||
*
|
||||
* @param Net_URL_Mapper $m URL mapper
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
|
|
@ -67,54 +69,87 @@ class OpenIDPlugin extends Plugin
|
|||
$m->connect('main/openid', array('action' => 'openidlogin'));
|
||||
$m->connect('main/openidtrust', array('action' => 'openidtrust'));
|
||||
$m->connect('settings/openid', array('action' => 'openidsettings'));
|
||||
$m->connect('index.php?action=finishopenidlogin', array('action' => 'finishopenidlogin'));
|
||||
$m->connect('index.php?action=finishaddopenid', array('action' => 'finishaddopenid'));
|
||||
$m->connect('index.php?action=finishopenidlogin',
|
||||
array('action' => 'finishopenidlogin'));
|
||||
$m->connect('index.php?action=finishaddopenid',
|
||||
array('action' => 'finishaddopenid'));
|
||||
$m->connect('main/openidserver', array('action' => 'openidserver'));
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Public XRDS output hook
|
||||
*
|
||||
* Puts the bits of code needed by some OpenID providers to show
|
||||
* we're good citizens.
|
||||
*
|
||||
* @param Action $action Action being executed
|
||||
* @param XMLOutputter &$xrdsOutputter Output channel
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onEndPublicXRDS($action, &$xrdsOutputter)
|
||||
{
|
||||
$xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
|
||||
'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
|
||||
'version' => '2.0'));
|
||||
'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
|
||||
'version' => '2.0'));
|
||||
$xrdsOutputter->element('Type', null, 'xri://$xrds*simple');
|
||||
//consumer
|
||||
foreach (array('finishopenidlogin', 'finishaddopenid') as $finish) {
|
||||
$xrdsOutputter->showXrdsService(Auth_OpenID_RP_RETURN_TO_URL_TYPE,
|
||||
common_local_url($finish));
|
||||
common_local_url($finish));
|
||||
}
|
||||
//provider
|
||||
$xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/server',
|
||||
common_local_url('openidserver'),
|
||||
null,
|
||||
null,
|
||||
'http://specs.openid.net/auth/2.0/identifier_select');
|
||||
common_local_url('openidserver'),
|
||||
null,
|
||||
null,
|
||||
'http://specs.openid.net/auth/2.0/identifier_select');
|
||||
$xrdsOutputter->elementEnd('XRD');
|
||||
}
|
||||
|
||||
/**
|
||||
* User XRDS output hook
|
||||
*
|
||||
* Puts the bits of code needed to discover OpenID endpoints.
|
||||
*
|
||||
* @param Action $action Action being executed
|
||||
* @param XMLOutputter &$xrdsOutputter Output channel
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onEndUserXRDS($action, &$xrdsOutputter)
|
||||
{
|
||||
$xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
|
||||
'xml:id' => 'openid',
|
||||
'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
|
||||
'version' => '2.0'));
|
||||
'xml:id' => 'openid',
|
||||
'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
|
||||
'version' => '2.0'));
|
||||
$xrdsOutputter->element('Type', null, 'xri://$xrds*simple');
|
||||
|
||||
//consumer
|
||||
$xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/return_to',
|
||||
common_local_url('finishopenidlogin'));
|
||||
common_local_url('finishopenidlogin'));
|
||||
|
||||
//provider
|
||||
$xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/signon',
|
||||
common_local_url('openidserver'),
|
||||
null,
|
||||
null,
|
||||
common_profile_url($action->user->nickname));
|
||||
common_local_url('openidserver'),
|
||||
null,
|
||||
null,
|
||||
common_profile_url($action->user->nickname));
|
||||
$xrdsOutputter->elementEnd('XRD');
|
||||
}
|
||||
|
||||
/**
|
||||
* Menu item for login
|
||||
*
|
||||
* @param Action &$action Action being executed
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onEndLoginGroupNav(&$action)
|
||||
{
|
||||
$action_name = $action->trimmed('action');
|
||||
|
|
@ -127,6 +162,14 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Menu item for OpenID admin
|
||||
*
|
||||
* @param Action &$action Action being executed
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onEndAccountSettingsNav(&$action)
|
||||
{
|
||||
$action_name = $action->trimmed('action');
|
||||
|
|
@ -139,68 +182,102 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Autoloader
|
||||
*
|
||||
* Loads our classes if they're requested.
|
||||
*
|
||||
* @param string $cls Class requested
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onAutoload($cls)
|
||||
{
|
||||
switch ($cls)
|
||||
{
|
||||
case 'OpenidloginAction':
|
||||
case 'FinishopenidloginAction':
|
||||
case 'FinishaddopenidAction':
|
||||
case 'XrdsAction':
|
||||
case 'PublicxrdsAction':
|
||||
case 'OpenidsettingsAction':
|
||||
case 'OpenidserverAction':
|
||||
case 'OpenidtrustAction':
|
||||
require_once(INSTALLDIR.'/plugins/OpenID/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
|
||||
case 'OpenidloginAction':
|
||||
case 'FinishopenidloginAction':
|
||||
case 'FinishaddopenidAction':
|
||||
case 'XrdsAction':
|
||||
case 'PublicxrdsAction':
|
||||
case 'OpenidsettingsAction':
|
||||
case 'OpenidserverAction':
|
||||
case 'OpenidtrustAction':
|
||||
require_once INSTALLDIR.'/plugins/OpenID/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
|
||||
return false;
|
||||
case 'User_openid':
|
||||
require_once(INSTALLDIR.'/plugins/OpenID/User_openid.php');
|
||||
case 'User_openid':
|
||||
require_once INSTALLDIR.'/plugins/OpenID/User_openid.php';
|
||||
return false;
|
||||
case 'User_openid_trustroot':
|
||||
require_once(INSTALLDIR.'/plugins/OpenID/User_openid_trustroot.php');
|
||||
case 'User_openid_trustroot':
|
||||
require_once INSTALLDIR.'/plugins/OpenID/User_openid_trustroot.php';
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
function onSensitiveAction($action, &$ssl)
|
||||
{
|
||||
switch ($action)
|
||||
{
|
||||
case 'finishopenidlogin':
|
||||
case 'finishaddopenid':
|
||||
$ssl = true;
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
function onLoginAction($action, &$login)
|
||||
{
|
||||
switch ($action)
|
||||
{
|
||||
case 'openidlogin':
|
||||
case 'finishopenidlogin':
|
||||
case 'openidserver':
|
||||
$login = true;
|
||||
return false;
|
||||
default:
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* We include a <meta> element linking to the publicxrds page, for OpenID
|
||||
* Sensitive actions
|
||||
*
|
||||
* These actions should use https when SSL support is 'sometimes'
|
||||
*
|
||||
* @param Action $action Action to form an URL for
|
||||
* @param boolean &$ssl Whether to mark it for SSL
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onSensitiveAction($action, &$ssl)
|
||||
{
|
||||
switch ($action)
|
||||
{
|
||||
case 'finishopenidlogin':
|
||||
case 'finishaddopenid':
|
||||
$ssl = true;
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Login actions
|
||||
*
|
||||
* These actions should be visible even when the site is marked private
|
||||
*
|
||||
* @param Action $action Action to show
|
||||
* @param boolean &$login Whether it's a login action
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onLoginAction($action, &$login)
|
||||
{
|
||||
switch ($action)
|
||||
{
|
||||
case 'openidlogin':
|
||||
case 'finishopenidlogin':
|
||||
case 'openidserver':
|
||||
$login = true;
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* We include a <meta> element linking to the userxrds page, for OpenID
|
||||
* client-side authentication.
|
||||
*
|
||||
* @param Action $action Action being shown
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
||||
function onEndShowHeadElements($action)
|
||||
{
|
||||
if($action instanceof ShowstreamAction){
|
||||
if ($action instanceof ShowstreamAction) {
|
||||
$action->element('link', array('rel' => 'openid2.provider',
|
||||
'href' => common_local_url('openidserver')));
|
||||
$action->element('link', array('rel' => 'openid2.local_id',
|
||||
|
|
@ -216,6 +293,9 @@ class OpenIDPlugin extends Plugin
|
|||
/**
|
||||
* Redirect to OpenID login if they have an OpenID
|
||||
*
|
||||
* @param Action $action Action being executed
|
||||
* @param User $user User doing the action
|
||||
*
|
||||
* @return boolean whether to continue
|
||||
*/
|
||||
|
||||
|
|
@ -228,13 +308,21 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Show some extra instructions for using OpenID
|
||||
*
|
||||
* @param Action $action Action being executed
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onEndShowPageNotice($action)
|
||||
{
|
||||
$name = $action->trimmed('action');
|
||||
|
||||
switch ($name)
|
||||
{
|
||||
case 'register':
|
||||
case 'register':
|
||||
if (common_logged_in()) {
|
||||
$instr = '(Have an [OpenID](http://openid.net/)? ' .
|
||||
'[Add an OpenID to your account](%%action.openidsettings%%)!';
|
||||
|
|
@ -244,12 +332,12 @@ class OpenIDPlugin extends Plugin
|
|||
'(%%action.openidlogin%%)!)';
|
||||
}
|
||||
break;
|
||||
case 'login':
|
||||
case 'login':
|
||||
$instr = '(Have an [OpenID](http://openid.net/)? ' .
|
||||
'Try our [OpenID login]'.
|
||||
'(%%action.openidlogin%%)!)';
|
||||
break;
|
||||
default:
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
|
||||
|
|
@ -258,13 +346,21 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load our document if requested
|
||||
*
|
||||
* @param string &$title Title to fetch
|
||||
* @param string &$output HTML to output
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onStartLoadDoc(&$title, &$output)
|
||||
{
|
||||
if ($title == 'openid')
|
||||
{
|
||||
if ($title == 'openid') {
|
||||
$filename = INSTALLDIR.'/plugins/OpenID/doc-src/openid';
|
||||
|
||||
$c = file_get_contents($filename);
|
||||
$c = file_get_contents($filename);
|
||||
$output = common_markup_to_html($c);
|
||||
return false; // success!
|
||||
}
|
||||
|
|
@ -272,10 +368,18 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add our document to the global menu
|
||||
*
|
||||
* @param string $title Title being fetched
|
||||
* @param string &$output HTML being output
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onEndLoadDoc($title, &$output)
|
||||
{
|
||||
if ($title == 'help')
|
||||
{
|
||||
if ($title == 'help') {
|
||||
$menuitem = '* [OpenID](%%doc.openid%%) - what OpenID is and how to use it with this service';
|
||||
|
||||
$output .= common_markup_to_html($menuitem);
|
||||
|
|
@ -284,7 +388,16 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
function onCheckSchema() {
|
||||
/**
|
||||
* Data definitions
|
||||
*
|
||||
* Assure that our data objects are available in the DB
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onCheckSchema()
|
||||
{
|
||||
$schema = Schema::get();
|
||||
$schema->ensureTable('user_openid',
|
||||
array(new ColumnDef('canonical', 'varchar',
|
||||
|
|
@ -307,6 +420,15 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add our tables to be deleted when a user is deleted
|
||||
*
|
||||
* @param User $user User being deleted
|
||||
* @param array &$tables Array of table names
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onUserDeleteRelated($user, &$tables)
|
||||
{
|
||||
$tables[] = 'User_openid';
|
||||
|
|
@ -314,6 +436,14 @@ class OpenIDPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add our version information to output
|
||||
*
|
||||
* @param array &$versions Array of version-data arrays
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onPluginVersion(&$versions)
|
||||
{
|
||||
$versions[] = array('name' => 'OpenID',
|
||||
|
|
|
|||
Loading…
Reference in New Issue