Iniciando com Zend_Auth By Rob Allen, Document Revision Copyright 2007

Transcrição

1 Iniciando com Zend_Auth By Rob Allen, Document Revision Copyright 2007 Este tutorial é destinado a oferecer uma bem básica introdução para o uso do componente Zend_Auth com o Zend Framework. Este tutorial tem como base o tutorial anterior Getting Started with the Zend Tutorial que está disponível em NOTA: Este tutorial foi testado nas versões 1.0.0, e do Zend Framework. Ele tem grandes chances de funcionar em versões mais novas. Antes de Iniciar A implementação da autenticação que nós estamos fazendo para usar neste tutorial usa sessões em PHP. Esteja seguro de que o diretório configurado para o session.save_path no php.ini tenha permissão de escrita para o servidor web, caso contrário você receberá uma antiga exception thrown. Autenticação Para o uso deste tutorial, autenticação é o processo de alguém fazer login em uma aplicação web. Iremos modificar a aplicação criada em Getting Started with the Zend Framework para que seja requerido login ao acessar qualquer arquivo da aplicação. Basicamente faremos: Criar a tabela de usuários e popular com um usuário. Criar um formulário de login. Criar um controller contendo ações para login e logout. Alterar o rodapé (footer) para permitir logout Garantir que o usuário sempre esteja logado antes de permitir seu acesso à aplicação. Tabela de usuários (users) A primeira coisa que precisamos é de uma tabela users. Isto não precisa ser complicado, terá um esquema como o seguinte (se usando MySQL): CREATE TABLE users ( id int(11) NOT NULL auto_increment, username varchar(50) NOT NULL, password varchar(50) NOT NULL, real_name varchar(100) NOT NULL, PRIMARY KEY (id), UNIQUE KEY username (username) ); Precisamos de um usuário que possa fazer login: INSERT INTO users (id, username, password, real_name) VALUES (1, 'rob', 'rob', 'Rob Allen'); Rode estas instruções em um cliente do MySQL como o phpmyadmin ou na linha de comando do MySQL (obviamente você pode escolher um melhor username e password).

2 Alterações no Bootstrap Com a finalidade de nos mantermos informados sobre o fato de que o usuário está logado, nós utilizaremos session. O Zend Framework provém Zend_Session_Namespace que oferece uma adequada interface orientada a objetos para o session. A alteração para o index.php é: zf-tutorial/index.php: Zend_Loader::loadClass('Zend_Db_Table'); Zend_Loader::loadClass('Zend_Debug'); Zend_Loader::loadClass('Zend_Auth'); // load configuration and.. // setup database $db = Zend_Db::factory($config->db->adapter, $config->db->config->toarray()); Zend_Db_Table::setDefaultAdapter($db); Zend_Registry::set('db', $db); // setup controller $frontcontroller = Zend_Controller_Front::getInstance(); Tudo o que temos que fazer aqui é garantir que nós temos carregado a classe Zend_Auth e registrado o adaptador de banco de dados com o registry. Nós armazenamos este no registry pois nós necessitamos deste quando formos autenticar depois. O Controller Auth Precisamos de um controller para manipular as ações login e logout. Por isso faz sentido chamar isso de AuthController. Estamos iniciando isto com o básico do IndexController: zf-tutorial/application/controllers/authcontroller.php: <?php function init() $this->initview(); $this->view->baseurl = $this->_request->getbaseurl(); function indexaction() Configuramos o init() logo que a view é inicializada e que baseurl é atribuída para e ele. Também criamos uma função indexaction() como algo requerido pela Zend_Controller_Action. Não precisamos de indexaction() mas como estamos indo usar loginaction() e logoutaction(), por isso basta voltar ao redirecionamento defualt se alguém navegar para a índex de auth.

3 Efetuando Login Para efetuar login na aplicação precisamos de um form, To log into the application we need a form, de forma que a ação login irá funcionar de uma forma muito similar que outro form no IndexController. O form template deve ficar em views/scripts/auth/login.phtml e o código deve estar em AuthController::loginAction(). O form é muito simples, requer apenas dois campos: username e password: zf-tutorial/application/views/scripts/auth/login.phtml: <?php echo $this->render('header.phtml');?> <h1><?php echo $this->escape($this->title);?></h1> <?php if(!empty($this->message)) :?> <div id="message"> <?php echo $this->escape($this->message);?> <?php endif;?> <form action="<?php echo $this->baseurl?>/auth/login" method="post"> <div> <label for="username">username</label> <input type="text" name="username" value=""/> <div> <label for="password">password</label> <input type="password" name="password" value=""/> <div id="formbutton"> <input type="submit" name="login" value="login" /> </form> <?php echo $this->render('footer.phtml');?> O template renderiza o header.phtml e o footer.phtml para o topo e para o rodapé como usual. Note que nós exibimos a mensagem somente se $this->message não for vazia. Isto é usado para avisar ao usuário que seu login falhou. O restante do template é o próprio formulário de login. Agora que temos um form, nós precisamos criar a ação controller para executar esta. Esta é adicionada ao AuthController.php: zf-tutorial/application/controllers/authcontroller.php: function loginaction() $this->view->message = ''; $this->view->title = "Log in"; Inicialmente, tudo que precisamos fazer e ajustar a mensagem do título e então renderizar o form. Se você navegar para então verá o form de login. Quanto ao processamento do form após ser submetido? Para fazer isso faremos de forma semelhante ao que fizemos nos forms add e edit no IndexController e realizar o processamento para a requisição do método post. Altere o loginaction() que nós já criamos:

4 zf-tutorial/application/controllers/authcontroller.php: function loginaction() $this->view->message = ''; if ($this->_request->ispost()) // collect the data from the user Zend_Loader::loadClass('Zend_Filter_StripTags'); $f = new Zend_Filter_StripTags(); $username = $f->filter($this->_request->getpost('username')); $password = $f->filter($this->_request->getpost('password')); if (empty($username)) $this->view->message = 'Please provide a username.'; else // setup Zend_Auth adapter for a database table Zend_Loader::loadClass('Zend_Auth_Adapter_DbTable'); $db = Zend_Registry::get('db'); $authadapter = new Zend_Auth_Adapter_DbTable($db); $authadapter->settablename('users'); $authadapter->setidentitycolumn('username'); $authadapter->setcredentialcolumn('password'); // Set the input credential values to authenticate against $authadapter->setidentity($username); $authadapter->setcredential($password); // do the authentication $auth = Zend_Auth::getInstance(); $result = $auth->authenticate($authadapter); if ($result->isvalid()) // success: store database row to auth's storage // system. (Not the password though!) $data = $authadapter->getresultrowobject(null, 'password'); $auth->getstorage()->write($data); else // failure: clear database row from session $this->view->message = 'Login failed.'; $this->view->title = "Log in"; Tem muita coisa acontecendo aqui, então comentemos: // collect the data from the user Zend_Loader::loadClass('Zend_Filter_StripTags'); $f = new Zend_Filter_StripTags(); $username = $f->filter($this->_request->getpost('username')); $password = $f->filter($this->_request->getpost('password')); if (empty($username)) $this->view->message = 'Please provide a username.'; else Usualmente configuramos um filtro e então extraimos os campos username e password dos dados de POST do form. Note que usamos a requisição da função getpost() como esta deve manipular o check isset() para nós e retornar uma string vazia se o campo não existir no array do POST. Caso o username seja vazio, então não teremos várias tentativas de autenticação (e Zend_Auth deve throw uma exception se nós tentarmos!), caso nós chequemos por um username vazio e informarmos o usuário ao invés.

5 // setup Zend_Auth adapter for a database table Zend_Loader::loadClass('Zend_Auth_Adapter_DbTable'); $db = Zend_Registry::get('db'); $authadapter = new Zend_Auth_Adapter_DbTable($db); $authadapter->settablename('users'); $authadapter->setidentitycolumn('username'); $authadapter->setcredentialcolumn('password'); Zend_Auth usa um sistema de adaptação que permite a você usar qualquer número de sistemas para atualmente realizar pouca autenticação. Desejamos usar uma tabela de banco de dados usando Zend_Auth_Adapter_DbTable. Para configurar o adaptador, passamos o campo a usar e a senha de uma conexão válida de banco de dados. // Set the input credential values to authenticate against $authadapter->setidentity($username); $authadapter->setcredential($password); Nós precisamos passar ao adaptador exatamente o username e password que o usuário entrou no form. // do the authentication $auth = Zend_Auth::getInstance(); $result = $auth->authenticate($authadapter); Para autenticar atualmente nós chamamos a função authenticate() do Zend_Auth. Isto garante que o resultado da autenticação será armazenado na sessão automaticamente para nós. if ($result->isvalid()) // success : store database row to auth's storage // system. (not the password though!) $data = $authadapter->getresultrowobject(null, 'password'); $auth->getstorage()->write($data); Caso tenha sucesso, nós armazenaremos o registro completo no banco de dados no singleton Zend_Auth. Isso garante que podemos coletar o nome do usuário para exibir no rodapé. else // failure: clear database row from session $this->view->message = 'Login failed.'; Caso a autenticação falhe, nós setamos a mensagem para que o usuário saiba o que houve. O processo de autenticação por login agora está completo. Logout (Sair) O logout é mais simples que o login, pois tudo que precisamos fazer é passar o singleton Zend_Auth para limpar seus dados. Isto será feito em uma nova ação logoutaction() com o AuthController e nós podemos navegar para para que o usuário faça o logout (saia): zf-tutorial/application/controllers/authcontroller.php: function logoutaction() Zend_Auth::getInstance()->clearIdentity();

6 A função logoutaction() é simples, não posso dizer nada sobre ela! Nós agora precisamos prover o usuário com um link para ele fazer o logout da aplicação. Isto é mais fácil no rodapé. Nós também vamos avisar ao usuário seu nome, avisando que ele está logado atualmente. Seu nome é armazenado no campo real_name da tabela users e agora disponível na instância Zend_Auth. A primeira coisa a fazer é mandar este para a view, que nós fazemos na função init() do IndexController(): zf-tutorial/application/controllers/indexcontroller.php: class IndexController extends Zend_Controller_Action function init() $this->initview(); Zend_Loader::loadClass('Album'); $this->view->baseurl = $this->_request->getbaseurl(); $this->view->user = Zend_Auth::getInstance()->getIdentity(); Isto certamente é conveniente pois Zend_Auth é um singleton, de outra forma nós armazenaremos no registro por enquanto! Agora precisamos adicionar algum HTML para o footer.phtml: zf-tutorial/application/views/scripts/footer.phtml: <?php if($this->user) :?> <p id="logged-in">logged in as <?php echo $this->escape($this->user->real_name);?>. <a href="<?php echo $this->baseurl?>/auth/logout">logout</a></p> <?php endif;?> </body> </html> Este HTML deverá parecer ligeiramente familiar, pois nada de novo por aqui. Usamos escape() para garantir que o o real_name seja exibido corretamente e usamos baseurl para configurar o href da âncora na localização adequada. Aqui está tudo que é requerido para o logout.

7 Protegendo as Ações Tudo isso à esquerda é para garantir que nenhuma outra ação seja acessível se você não estiver logado. Para fazer isso precisamos adicionar algum código para a função predispatch() do IndexController. zf-tutorial/application/controllers/indexcontroller.php: class IndexController extends Zend_Controller_Action function predispatch() $auth = Zend_Auth::getInstance(); if (!$auth->hasidentity()) $this->_redirect('auth/login'); predispatch() é chamada antes de cada ação no controller. Nós pegamos a instância do Zend_Auth e então a sua função hasidentity() nos informa se algum usuário está logado. Caso não esteja então nos redireciona para a ação auth/login. E é tudo que precisamos fazer. Conclusion Isto conclui nossa breve olhada na integração do Zend_Auth em uma aplicação MVC. Claramente existe algo mais que você pode fazer com Zend_Auth e existem muitas formas de melhorar a forma como o código trabalha, especialmente se você tem múltiplos controllers a serem protegidos. Note que nós não descemos a detalhes para autenticação aqui, da forma como é coberto pelo componente Zend_Acl. Zend_Acl pode ser usado em conjunto com Zend_Auth para implantar diferentes níveis de acesso para ações ou dados, mas isso é assunto para outro tutorial. Faço votos que que você tenha achado interessante e tenha aprendido algo. Caso tenha encontrado algo errado, por favor me avise pelo rob@akrabat.com. Tradução de Ribamar FS