Азы работы с Zend Framework (3/3) - Авторизация и ACL

Доброго времени суток, уважаемые посетители сайта ruseller.com! Как и было обещано, мы представляем третий и, на данный момент, заключительный урок из серии «Азы работы с Zend Framework». Сегодня я покажу вам, как осуществить процесс авторизации с Zend_Auth. Также мы пройдёмся по тому, как использовать Zend_Acl для распределения ресурсов и ролей в нашем тестовом проекте. Итак, вперёд!

Учимся работать с Zend_Auth

Для того чтобы реализовать авторизацию в тестовом проекте, нам потребуется создать ещё одну таблицу, которая будет хранить пользователей. Структура новой таблицы:

  1. id INT NOT NULL – уникальный идентификатор;
  2. username VARCHAR(255) NOT NULL – поле для хранения логина пользователя;
  3. password VARCHAR(255) NOT NULL – поле для хранения пароля. Внимание: в данном уроке мы будем хранить пароль в обычном виде без всяких md5, солей и тому подобных средств, с целью упростить понимание работы Zend_Auth;
  4. role VARCHAR(255) NOT NULL – поле, предназначенное для хранения роли пользователя;

Вставьте этот код в ваш phpMyAdmin, и таблица благополучно будет создана:

CREATE TABLE `zfdemo`.`users` (`id` INT NOT NULL AUTO_INCREMENT PRIMARY KEY, `username` VARCHAR(255) NOT NULL, `password` VARCHAR(255) NOT NULL, `role` VARCHAR(255) NOT NULL) ENGINE = InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci;

Теперь я бы хотел остановиться на четвёртом поле, которое будет содержать название роли, к которой относится тот или иной пользователь. В нашем примере у нас будет один пользователь с именем admin, паролем admin и ролью admin :)

INSERT INTO `zfdemo`.`users` (`id`, `username`, `password`, `role`) VALUES ('1', 'admin', 'admin', 'admin');

Для демонстрации работы Zend_Acl нам потребуется ещё один тип пользователя. Им будет обычный посетитель нашего сайта – гость, но об этом чуть позже.

Для того чтобы залогиниться в систему и получить возможность добавлять любимые фильмы, админ должен заполнить поля формы, которой у нас ещё нет. Так давайте создадим её: откройте командную строку или консоль, перейдите в корневой каталог вашего сайта и наберите следующую команду:

Данная строчка создаст новый файл в папке application/forms. Откройте новоиспечённый файл, для того чтобы создать форму для входа администратора в систему. Вот что мы туда впишем:

<?php

class Application_Form_Login extends Zend_Form
{
    public function init()
    {
        // указываем имя формы
        $this->setName('login');
        
        // сообщение о незаполненном поле
        $isEmptyMessage = 'Значение является обязательным и не может быть пустым';
        
        // создаём текстовый элемент
        $username = new Zend_Form_Element_Text('username');
        
        // задаём ему label и отмечаем как обязательное поле;
        // также добавляем фильтры и валидатор с переводом
        $username->setLabel('Логин:')
            ->setRequired(true)
            ->addFilter('StripTags')
            ->addFilter('StringTrim')
            ->addValidator('NotEmpty', true,
                array('messages' => array('isEmpty' => $isEmptyMessage))
            );
        
        // создаём элемент формы для пароля
        $password = new Zend_Form_Element_Password('password');
        
        // задаём ему label и отмечаем как обязательное поле;
        // также добавляем фильтры и валидатор с переводом
        $password->setLabel('Пароль:')
            ->setRequired(true)
            ->addFilter('StripTags')
            ->addFilter('StringTrim')
            ->addValidator('NotEmpty', true,
                array('messages' => array('isEmpty' => $isEmptyMessage))
            );
        
        // создаём кнопку submit
        $submit = new Zend_Form_Element_Submit('login');
        $submit->setLabel('Войти в систему');
        
        // добавляем элементы в форму
        $this->addElements(array($username, $password, $submit));
        
        // указываем метод передачи данных
        $this->setMethod('post');
    }
}

Работу с формами мы подробно проходили в прошлом уроке, так что тем, кто отстал, советую посмотреть его. Расскажу вкратце, что мы тут делаем: создаём форму, состоящую из двух текстовых полей для логина и пароля, а также кнопку submit, при нажатии на которую будет произведена проверка на подлинность админа.

Теперь для того чтобы реализовать процесс авторизации, нам необходимо создать новый контроллер, предназначенный специально для этих целей. Наберите в командной строке следующую команду:

zf create controller auth

Нам понадобятся 2 action: 1 для того чтобы вывести форму авторизации пользователю, а второй для выхода из системы. Наберите следующие команды в командной строке:

zf create action login auth
zf create action logout auth

Теперь в папке application/controllers у вас появился новый контроллер с набором действий. Первое действие, которое мы реализуем, будет login:

    public function loginAction()
    {
        // проверяем, авторизирован ли пользователь
        if (Zend_Auth::getInstance()->hasIdentity()) {
            // если да, то делаем редирект, чтобы исключить многократную авторизацию
            $this->_helper->redirector('index', 'index');
        }
        
        // создаём форму и передаём её во view
        $form = new Application_Form_Login();
        $this->view->form = $form;
        
        // Если к нам идёт Post запрос
        if ($this->getRequest()->isPost()) {
            // Принимаем его
            $formData = $this->getRequest()->getPost();
            
            // Если форма заполнена верно
            if ($form->isValid($formData)) {
                // Получаем адаптер подключения к базе данных
                $authAdapter = new Zend_Auth_Adapter_DbTable(Zend_Db_Table::getDefaultAdapter());
                
                // указываем таблицу, где необходимо искать данные о пользователях
                // колонку, где искать имена пользователей,
                // а также колонку, где хранятся пароли
                $authAdapter->setTableName('users')
                    ->setIdentityColumn('username')
                    ->setCredentialColumn('password');
                
                // получаем введённые данные
                $username = $this->getRequest()->getPost('username');
                $password = $this->getRequest()->getPost('password');
                
                // подставляем полученные данные из формы
                $authAdapter->setIdentity($username)
                    ->setCredential($password);
                
                // получаем экземпляр Zend_Auth
                $auth = Zend_Auth::getInstance();
                
                // делаем попытку авторизировать пользователя
                $result = $auth->authenticate($authAdapter);
                
                // если авторизация прошла успешно
                if ($result->isValid()) {
                    // используем адаптер для извлечения оставшихся данных о пользователе
                    $identity = $authAdapter->getResultRowObject();
                    
                    // получаем доступ к хранилищу данных Zend
                    $authStorage = $auth->getStorage();
                    
                    // помещаем туда информацию о пользователе,
                    // чтобы иметь к ним доступ при конфигурировании Acl
                    $authStorage->write($identity);
                    
                    // Используем библиотечный helper для редиректа
                    // на controller = index, action = index
                    $this->_helper->redirector('index', 'index');
                } else {
                    $this->view->errMessage = 'Вы ввели неверное имя пользователя или неверный пароль';
                }
            }
        }
    }

Как я уже говорил ранее, для авторизации пользователей в Zend Framework существует специальный класс Zend_Auth. Данный класс использует множество других классов для своей работы, и одним из них является Zend_Auth_Adapter_DbTable. Данный класс следует использовать в том случае, если информация о пользователях хранится в таблице базы данных. Создав адаптер подключения к базе, мы при помощи метода setTableName указываем, в какой таблице хранятся наши пользователи. При помощи метода setIdentityColumn, указываем колонку, которая хранит логины и setCredentialColumn для указания колонки с паролями.

Для того чтобы создать объект Zend_Auth, достаточно вот такой записи: Zend_Auth::getInstance(); Далее при помощи простого метода authenticate мы можем проверить подлинность введённых данных. Чтобы получить результат, можем использовать метод isValid().

Несмотря на то, что код содержит подробные комментарии, я подробнее остановлюсь на работе данного action.

В самом начале кода мы проверяем, авторизирован ли пользователь, для того чтобы исключить возможность двойной авторизации. Нам такого не надо. Для того чтобы это проверить, нам необходимо получить экземпляр Zend_Auth и воспользоваться методом hasIdentity(). Если данный метод вернёт true, то пользователь авторизирован, если нет, то выводим ему форму. В том случае, если на страницу делается запрос POST, это значит, что пользователь ввёл данные в форму и пытается войти в систему. В этом случае нам необходимо проверить полученные данные, и если авторизация прошла успешно, мы достаём остальные данные о пользователе (для Acl) при помощи метода getResultRowObject() и помещаем их в глобальное хранилище. Для того чтобы это сделать, нам нужно получить к нему доступ при помощи getStorage(), а затем воспользоваться методом write, чтобы записать необходимую информацию.

Теперь самое время отобразить форму пользователям. Добавьте следующий код в файл login.phtml, который находится в application/views/scripts/auth:

<?php
    $this->title = "Вход в систему";
    echo $this->errMessage;
    echo $this->form;
?>

Для того чтобы при заходе на действие index контроллера auth пользователь не втыкал в белый экран, сделаем перенаправление:

    public function indexAction()
    {
        $this->_helper->redirector('login');
    }

Теперь самая пора реализовать выход пользователя из системы. Если вы помните, для этого у нас был создан специальный action:

    public function logoutAction()
    {
        // уничтожаем информацию об авторизации пользователя
        Zend_Auth::getInstance()->clearIdentity();
        
        // и отправляем его на главную
        $this->_helper->redirector('index', 'index');
    }

В этом фрагменте кода мы просто уничтожаем информацию об авторизации при помощи clearIdentity(), и перенаправляем пользователя на главную страницу нашего сайта.

Для того чтобы отобразить авторизированному пользователю кнопку выход внесём изменения в layout.phtml, который находится в application/layout/scripts:

<?php
    $this->headMeta()->appendHttpEquiv('Content-Type', 'text/html;charset=utf-8');
    $this->headTitle()->setSeparator(' - ');
    $this->headTitle('Уроки по Zend Framework от Ruseller.com');
    
    echo $this->doctype();
?>

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
    <?php echo $this->headMeta(); ?>
    <?php echo $this->headTitle(); ?>
    <?php echo $this->headLink()->prependStylesheet($this->baseUrl().'/css/site.css'); ?>
</head>
<body>
<?php
    // Применяем уже знакомый метод для проверки авторизации пользователя
    if (Zend_Auth::getInstance()->hasIdentity()) {
        $url = $this->url(array('controller'=>'auth', 'action'=>'logout'));
        // если пользователь авторизирован, показываем ему кнопку "Выход"
        echo "<a href=\"{$url}\">Выход</a>";
    }
?>
    <div id="content">
        <h1><?php echo $this->escape($this->title); ?></h1>
        <?php echo $this->layout()->content; ?>
    </div>
</body>
</html>

Знакомимся с Zend_Acl

Теперь мы приступим к реализации ACL. Этот инструмент позволит нам определить, какая роль у текущего пользователя, и в зависимости от его привилегий, допускать его или нет в определённые части сайта. Нашего гостя мы допустим только до главной страницы, а также до формы авторизации и выхода из системы. Администратору позволим создавать, редактировать и удалять записи о любимых фильмах.

Распределение ролей Zend Framework традиционно реализуется в Bootstrap.php,который находится в каталоге application. Данный файл служит чем-то вроде отправного пункта для вашего приложения. Всю глобальную, инициализирующую функциональность следует помещать в этот файл. Для того чтобы метод в Bootstrap.php запускался автоматически, в его названии необходимо указать префикс _init. Добавьте следующий код в данный файл:

<?php

class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
{
    protected function _initAcl()
    {
        // Создаём объект Zend_Acl
        $acl = new Zend_Acl();
        
        // Добавляем ресурсы нашего сайта,
        // другими словами указываем контроллеры и действия
        
        // указываем, что у нас есть ресурс index
        $acl->addResource('index');
        
        // ресурс add является потомком ресурса index
        $acl->addResource('add', 'index');
        
        // ресурс edit является потомком ресурса index
        $acl->addResource('edit', 'index');
        
        // ресурс delete является потомком ресурса index
        $acl->addResource('delete', 'index');
        
        // указываем, что у нас есть ресурс error
        $acl->addResource('error');
        
        // указываем, что у нас есть ресурс auth
        $acl->addResource('auth');
        
        // ресурс login является потомком ресурса auth
        $acl->addResource('login', 'auth');
        
        // ресурс logout является потомком ресурса auth
        $acl->addResource('logout', 'auth');
        
        // далее переходим к созданию ролей, которых у нас 2:
        // гость (неавторизированный пользователь)
        $acl->addRole('guest');
        
        // администратор, который наследует доступ от гостя
        $acl->addRole('admin', 'guest');
        
        // разрешаем гостю просматривать ресурс index
        $acl->allow('guest', 'index', array('index'));
        
        // разрешаем гостю просматривать ресурс auth и его подресурсы
        $acl->allow('guest', 'auth', array('index', 'login', 'logout'));
        
        // даём администратору доступ к ресурсам 'add', 'edit' и 'delete'
        $acl->allow('admin', 'index', array('add', 'edit', 'delete'));
        
        // разрешаем администратору просматривать страницу ошибок
        $acl->allow('admin', 'error');
        
        // получаем экземпляр главного контроллера
        $fc = Zend_Controller_Front::getInstance();
        
        // регистрируем плагин с названием AccessCheck, в который передаём
        // на ACL и экземпляр Zend_Auth
        $fc->registerPlugin(new Application_Plugin_AccessCheck($acl, Zend_Auth::getInstance()));
    }
}

Функция _initAcl инициализирует данные для ACL. В первую очередь мы указываем ресурсы нашего сайта и роли при помощи методов addResource() и addRole(), а затем определяем, какие роли к каким ресурсам относятся при помощи метода allow(). Прошу обратить внимание на процесс наследования, который присутствует тут сплошь и рядом. Если мы наследуем администратора от гостя, то это значит, что все что доступно гостю – будет доступно и администратору, НО не наоборот.

Теперь нам необходимо написать плагин, который будет осуществлять проверку роли пользователя. Почему плагин? Дело в том, что нам необходимо, чтобы проверка осуществлялась на каждой странице. Именно поэтому целесообразно создать плагин, который будет запускаться перед формированием страницы. Что-то типа традиционной проверки в начале файла.

Создайте каталог plugins в папке application и поместите туда файл AccessCheck.php. Содержимое данного файла будет таково:

<?php
class Application_Plugin_AccessCheck extends Zend_Controller_Plugin_Abstract
{
    private $_acl = null;
    private $_auth = null;
    
    /*
     * Инициализируем данные
     */
    public function __construct(Zend_Acl $acl, Zend_Auth $auth)
    {
        $this->_acl = $acl;
        $this->_auth = $auth;
    }
    
    public function preDispatch(Zend_Controller_Request_Abstract $request) {
        // получаем имя текущего ресурса
        $resource = $request->getControllerName();
        
        // получаем имя action
        $action = $request->getActionName();
        
        // получаем доступ к хранилищу данных Zend,
        // и достаём роль пользователя
        $identity = $this->_auth->getStorage()->read();
        
        // если в хранилище ничего нет, то значит мы имеем дело с гостем
        $role = !empty($identity->role) ? $identity->role : 'guest';
        
        // если пользователь не допущен до данного ресурса,
        // то отсылаем его на страницу авторизации 
        if (!$this->_acl->isAllowed($role, $resource, $action)) {
            $request->setControllerName('auth')->setActionName('index');
        }
    }
}

Нам необходимо, чтобы данный код запускался ещё тогда, когда MVC ещё не сольются воедино – поэтому мы используем метод preDispatch() с тем числом аргументов, которое мы передали при регистрации плагина.

Для проверки доступа пользователя к текущему ресурсу, мы получаем имя контроллера и действия (ресурсов к которым пытается подключиться пользователь); Затем мы извлекаем данные из хранилища и проверяем наличие роли у пользователя. Если у пользователя роли нет, то это значит, что мы никого не авторизовали и перед нами гость. В противном случае записываем в переменную $role роль пользователя и делаем проверку при помощи метода isAllowed(). Если пользователь с данной ролью не доступен до ресурса, то перенаправляем его на страницу авторизации.

Вот и всё. Просто и эффективно.

Надеюсь, вам понравилась серия наших уроков по самому мощному PHP фрэймворку – Zend Framework. Благодаря ему вы можете создавать крепкие и надёжные сайты, используя кучу готовых классов для большинства задач. Представьте, сколько вам понадобилось кода, чтобы реализовать подобное приложения с нуля…

Всего хорошего!

Источник: http://feedproxy.google.com/~r/ruseller/CdHX/~3/2yPxl_7po5Q/lessons.php

Читать комменты и комментировать

Добавить комментарий / отзыв



Защитный код
Обновить

Азы работы с Zend Framework (3/3) - Авторизация и ACL | | 2012-06-24 16:22:32 | | Статьи Web-мастеру | | Доброго времени суток, уважаемые посетители сайта ruseller.com! Как и было обещано, мы представляем третий и, на данный момент, заключительный урок из серии «Азы работы с Zend Framework». Сегодня я | РэдЛайн, создание сайта, заказать сайт, разработка сайтов, реклама в Интернете, продвижение, маркетинговые исследования, дизайн студия, веб дизайн, раскрутка сайта, создать сайт компании, сделать сайт, создание сайтов, изготовление сайта, обслуживание сайтов, изготовление сайтов, заказать интернет сайт, создать сайт, изготовить сайт, разработка сайта, web студия, создание веб сайта, поддержка сайта, сайт на заказ, сопровождение сайта, дизайн сайта, сайт под ключ, заказ сайта, реклама сайта, хостинг, регистрация доменов, хабаровск, краснодар, москва, комсомольск |
 
Поделиться с друзьями: