*/ /** * Class responsible for rendering the fededated login form. * * @author Aoi Karasu */ class fa_login extends fa_base { /** * Creates the class instance bound to a plugin instance and an authentication provider. * * @param objref $manager object reference to the action plugin * @param string $cmd name of the command to handle * @param string $provid (optional) an authentication provider id */ function __construct(&$manager, $cmd, $provid='') { parent::__construct(&$manager, $cmd, $provid); } /** * No pocessing when displaying federated login form. * This method is intended to suppress the 'unknown command' message only. */ function process_login() { $this->success = true; return null; } /** * Renders the feredated login form. */ function html_login() { $this->html_login_service_from(); } /** * Returns the 'click to ...' text. */ function getLoginText() { return empty($_SERVER['REMOTE_USER']) ? $this->lang['clicktologin'] : $this->lang['clicktoadd']; } /** * Returns the user authentication data storage manager. * * @return the user authentication data storage manager object */ function &getUserStore() { $hfile = FEDAUTH_PLUGIN . "classes/usr/fa_filestore.class.php"; require_once($hfile); return new fa_filestore(); } /** * Returns the service consumer depending on provider's service type. * * @param object $pro the authentication service provider configuration object * @return the service consumer object */ function &getService($pro) { // TODO: change to getType() once it is implemented in the fa_provider class $id = "fa_" . "openid" /*$pro->getType()*/; $hfile = FEDAUTH_PLUGIN . "classes/svc/$id.svc.class.php"; require_once($hfile); $class = $id . "_svc"; return new $class($pro); } /** * Builds an URL to redirect to, based on arbitrary conditions: * - uses $_GET value stored in session before authentication request, if it's available * - sets command to display logins management, if a new identity has been added * - or else uses current page $ID only * * @return string URL to be used as the redirect location */ function restoreLocation() { global $ID; if (isset($_SESSION[DOKU_COOKIE]['fedauth']['stor'])) { $get = $_SESSION[DOKU_COOKIE]['fedauth']['stor']['gt']; $get = array_diff_key($get, array('id' => '')); if (!empty($get)) { $params = array_implode($get); return wl($ID, $params, true, '&'); } } if (($_REQUEST['mode'] == 'add') || ($_REQUEST['mode'] == 'removed')) { return wl($ID, 'do=fedauth', true, '&'); } if ($_REQUEST['mode'] == 'register') { return wl($ID, 'do=fedauth', true, '&') . '&fa[register]'; } return wl($ID); } /** * Renders the feredated login form. * * @param bool $return (optional) indicates whether the form should be returned as string or printed * @return mixed generated form string or true, if printed */ function html_login_service_from($return=false) { global $ID, $conf, $auth; $user = $_SERVER['REMOTE_USER']; $out = '

' . '

'.$this->lang['gotlogin'].' '.$this->getLoginText().'

' . '

'; if ($return) return $out; print $out; return true; } /** * Renders the service provider link buttons. * * @param arrayref $source the source providers array * @param bool $large (optional) true for large buttons, false for small */ function html_providers_list(&$source, $large=false) { global $ID, $do; if (!is_array($source)) return ''; $out = ''; $sectok = getSecurityToken(); foreach ($source as $id => $pro) { if (!$pro->isEnabled() || ($pro->getURL() == null)) continue; $btn = $this->cmd; $class = $large ? 'btnplarge' : 'btnpsmall'; $mode = $large ? PROV_LARGE : PROV_SMALL; $class .= $this->provid == $id ? ' selected' : ''; if ($pro->hasUsername()) { $act = $do; $cmd = 'select'; } else { $act = 'fedauth'; $cmd = 'signin'; } $out .= '' . $pro->getImageXHTML($mode, $class) . ''; } return $out; } /** * Renders the form part with username input, if the service requires it. */ function html_service_signin() { if (!($pro = $this->manager->providers->get($this->provid))) { return ''; } if (!$pro->isEnabled() || !$pro->hasUsername()) { return ''; } $out = '

' . '

'.str_replace('@PROVID@', $pro->getName(), $this->lang['enterlogin']).'

' . '' . '' . '

'; return $out; } /** * Renders the form part for general OpenID login. */ function html_general_openid() { if (!($pro = $this->manager->providers->get('openid'))) { return ''; } if (!$pro->isEnabled()) { return ''; } $out = '

' . '

'.$this->lang['manualopenid'].':

' . $pro->getImageXHTML(PROV_SMALL, 'manualoid') . '' . '' . '

'; return $out; } } /* fa_login */ /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */