Zend FrameWork 2 и авторизации c Twitter

Для мультиязычных сайтов необходима авторизация из социальных сетей, так как по статистике, более 50 % пользователей моих сайтов зарегистрированы из социальных сетей, а именно – из twitter и facebook.

Более того уровень доверия к таким сайтам намного больше, чем к тем у которых до сих пор отсутствует система авторизации на основе социальных сетей.

Что нужно для авторизации пользователей.

• Ключ приложения twitter и секрет (секретная фраза) эти данные можно плучить на сарнице dev.twitter.com/apps, создав новое приложение.
• Zend FrameWork 2
• модули для Zend FrameWork 2 - ZfcUser и ZfcBase
• Модуль Hybridauth v 2.0.10 hybridauth-v2.0.10.zip

Модуль ZfcUser и комплект скриптов hybridauth-v2.0.10.zip

Первый не сложно найти, второй располагается по адресу - hybridauth

Итак, давайте начнём со скачивания архива hybridauth-v2.0.10.zip После этого скачайте ZfcUser - ZfcBase и ZfcUser.

ZfcUser и ZfcBase два модуля, первый из которых отвечает за авторизацию пользователя, второй содержит вспомогательные классы для изменения данных пользователя и обработки события регистрации и авторизации пользователя.

Их установка не сложна - скачайте и распакуйте в директорию с модулями Zend FrameWork 2, затем подключите их в файле /config/application.config.php

Предположим Вы имеете структуру из следующих модулей (глобальный конфигурационный файл "application.config.php"):

<?php return array( 'modules' => array( 'Application', 'Suggest', 'Search', 'Album', 'ZfcUser', 'ZfcBase', ), 'module_listener_options' => array( 'config_glob_paths' => array( 'config/autoload/{,*.}{global,local}.php', ), 'module_paths' => array( './module', './vendor', ), ) );

После этого, необходимо настроить Hybridauth, для этого отредактируйте файл config.php, который находится в директории \hybridauth\hybridauth\ следующим образом, - замените полученными при регистрации вашего приложения (https://dev.twitter.com/apps) ключом и секретной фразой параметры «keys» и «secret» в файле /hybridauth/hybridauth/config.php:

Twitter" => array ( "enabled" => true, "keys" => array ( "key" => "***********", "secret" => "*************************" ) ),

После этого нужно создать новое действие, которое будет являtтся страницей авторизацией из twitter.com на вашем сайте, - например:

/** * Login from twitter */ public function twitterAction() { // подключение нужных файлов $config = $_SERVER['DOCUMENT_ROOT'] . '/hybridauth/hybridauth/config.php'; require_once( $_SERVER['DOCUMENT_ROOT']."/hybridauth/hybridauth/Hybrid/Auth.php" ); try{ // инициализация hybridauth $hybridauth = new \Hybrid_Auth( $config ); // автоматическая проверка подключения пользователя к twitter $twitter = $hybridauth->authenticate( "Twitter" ); // возвращает TRUE или False до того как вы получите доступ к twitter $is_user_logged_in = $twitter->isUserConnected(); // получение данных пользователя $user_profile = $twitter->getUserProfile(); // доступ к данным из twitter echo "Првиет! Ты в twitter: <b>{$twitter->id}</b><br />"; echo "Вы вошли как: <b>{$user_profile->displayName}</b><br />"; echo "и ваш id в twitter: <b>{$user_profile->identifier}</b><br />"; // дополнение echo "<pre>" . print_r( $user_profile, true ) . "</pre><br />"; // расскоментируйте эту линию для того чтобы получить список вfших друзей // $twitter->getUserContacts(); // расскоментируйте эту линию для написания постов // $twitter->setUserStatus( "Hello world!" ); // пример того как получить данные с hybridauth // Вернёт количество друзей, последователей, статусы и любимые пользователи. // https://dev.twitter.com/docs/api/1/get/account/totals $account_totals = $twitter->api()->get( 'account/totals.json' ); // вывод полученных данных echo "Статистика вашего аккаунта в Twitter:<br /><pre>" . print_r( $account_totals, true ) . "</pre>"; $data = array('username'=>$user_profile->firstName,'lastname'=>$user_profile->lastname,'userinfo'=>$user_profile->description,'identifier'=>$user_profile->identifier); $request = $this->getRequest(); $service = $this->getUserService(); $user = $service->RegisterFromTwitter($data); // нужно или нет? $hybridauth->restoreSessionData(); // нужно или нет? if($user) { if ($service->getOptions()->getLoginAfterRegistration()) { $identityFields = $service->getOptions()->getAuthIdentityFields(); if (in_array('email', $identityFields)) { $post['identity'] = $user->getEmail(); } elseif(in_array('username', $identityFields)) { $post['identity'] = $user->getUsername(); } $post['credential'] = $post['password']; $post['twitter'] = 1; $request->setPost(new Parameters($post)); return $this->forward()->dispatch('zfcuser', array('action' => 'authenticate','twitter'=>$post['twitter'])); } // TODO: Add the redirect parameter here... return $this->redirect()->toUrl($this->url()->fromRoute('zfcuser/login') . ($request ? '?redirect='.$request : '')); } // logout echo "Logging out.."; } catch( Exception $e ){ // In case we have errors 6 or 7, then we have to use Hybrid_Provider_Adapter::logout() to // let hybridauth forget all about the user so we can try to authenticate again. // Display the recived error, // to know more please refer to Exceptions handling section on the userguide switch( $e->getCode() ){ case 0 : echo "Unspecified error."; break; case 1 : echo "Hybridauth configuration error."; break; case 2 : echo "Provider not properly configured."; break; case 3 : echo "Unknown or disabled provider."; break; case 4 : echo "Missing provider application credentials."; break; case 5 : echo "Authentification failed. " . "The user has canceled the authentication or the provider refused the connection."; break; case 6 : echo "User profile request failed. Most likely the user is not connected " . "to the provider and he should to authenticate again."; $twitter->logout(); break; case 7 : echo "User not connected to the provider."; $twitter->logout(); break; case 8 : echo "Provider does not support this feature."; break; } // well, basically your should not display this to the end user, just give him a hint and move on.. echo "<br /><br /><b>Original error message:</b> " . $e->getMessage(); echo "<hr /><h3>Trace</h3> <pre>" . $e->getTraceAsString() . "</pre>"; /* // If you want to get the previous exception - PHP 5.3.0+ // http://www.php.net/manual/en/language.exceptions.extending.php if ( $e->getPrevious() ) { echo "<h4>Previous exception</h4> " . $e->getPrevious()->getMessage() . "<pre>" . $e->getPrevious()->getTraceAsString() . "</pre>"; } */ } }

Обратите внимание необходимо правильно указать пути до основной директории hybridauth! Заранее скажу, что так писать код не совсем соответствует правилам Zend Framework, по правилам нужно вынести подключаемые классы HybridAuth в отдельную директорю Plugin, основного класса и подключать их в качетсве плагина Zend FrameWork, но в целях упрощения и обучения, думаю, так можно поступить на первое время.

$config = $_SERVER['DOCUMENT_ROOT'] . '/hybridauth/hybridauth/config.php'; require_once( $_SERVER['DOCUMENT_ROOT']."/hybridauth/hybridauth/Hybrid/Auth.php" );

дальше мы проверяем, был ли осуществлён ранее вход с twitter

// automatically try to login with Twitter $twitter = $hybridauth->authenticate( "Twitter" );

после этого получаем данные и выводим

// get the user profile $user_profile = $twitter->getUserProfile(); // access user profile data echo "Ohai there! U are connected with: <b>{$twitter->id}</b><br />"; echo "As: <b>{$user_profile->displayName}</b><br />"; echo "And your provider user identifier is: <b>{$user_profile->identifier}</b><br />"; // or even inspect it echo "<pre>" . print_r( $user_profile, true ) . "</pre><br />";

выводим дополнительную статистику из аккаунта twitter

$account_totals = $twitter->api()->get( 'account/totals.json' );

$account_totals = $twitter->api()->get( 'account/totals.json' ); // print recived stats echo "Here some of yours stats on Twitter:<br /><pre>" . print_r( $account_totals, true ) . "</pre>";

с полученными данными делаем всё что угодно: $data = array('username'=>$user_profile->firstName,'lastname'=>$user_profile->lastname,'userinfo'=>$user_profile->description,'identifier'=>$user_profile->identifier); $request = $this->getRequest(); $service = $this->getUserService(); $user = $service->RegisterFromTwitter($data);

 

$service – переменная, хранящая результат работы класса «ServiceManager», по сути своей - это класс для доступа к другим классам нашего модуля. Полная информация о том, что такое «ServiceManager» – ServiceManager

public function getUserService() { if (!$this->userService) { $this->userService = $this->getServiceLocator()->get('zfcuser_user_service'); } return $this->userService; }

'zfcuser_user_service' – обозначение вспомогательного класса (сервиса), который находится в директории \module\ZfcUser\src\ZfcUser\Service\ в файле User.php Далее getUserService будет содержать результат выполнения метода

$user = $service->RegisterFromTwitter($data); /** * createRegisterFromTwitter * * @param array $data * @return \ZfcUser\Entity\UserInterface * @throws Exception\InvalidArgumentException */ public function RegisterFromTwitter(array $data) { $user = new \ZfcUser\Entity\User(); $identifier = $this->getUserMapper()->findByIdentifier($data['identifier']); $user->setMiddlename($data['middlename']); $user->setLastname(''); $user->setMiddlename(''); $user->setEmail($data['identifier'].'@nomail.com'); $user->setPassword(''); $user->setRegion(''); $user->setCity(''); $user->setAddress(''); $user->setSex(''); $user->setUserinfo($data['userinfo']); $user->setAvatarType(0); $user->setAvatar(0); $user->setIdentifier($data['identifier']); $user->setTypesocnet(1); if($identifier) { $user->setId($identifier->getId()); } else { } if ($this->getOptions()->getEnableUsername()) { $user->setUsername($data['username']); } if ($this->getOptions()->getEnableDisplayName()) { $user->setDisplayName($data['display_name']); } if($identifier) { $this->getUserMapper()->update($user); } else { $this->getEventManager()->trigger(__FUNCTION__, $this, array('user' => $user, 'form' => $form)); $this->getUserMapper()->insert($user); $this->getEventManager()->trigger(__FUNCTION__.'.post', $this, array('user' => $user, 'form' => $form)); } return $user; }

Интерфейс пользователя нужен для установки и модификации персональных данных пользователя, он поставляется по умолчанию вместе с модулем «ZfcUser»: $user = new \ZfcUser\Entity\User();

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

$identifier = $this->getUserMapper()->findByIdentifier($data['identifier']);

findByIdentifier может быть следующего содержания и находится по адресу \module\ZfcUser\src\ZfcUser\Mapper\User.php public function findByIdentifier($identifier) { $select = $this->select() ->from($this->tableName) ->where(array('identifier' => $identifier)); $entity = $this->selectWith($select)->current(); $this->getEventManager()->trigger('find', $this, array('entity' => $entity)); return $entity; }

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

$user->setMiddlename($data['middlename']); $user->setLastname(''); $user->setMiddlename(''); $user->setEmail($data['identifier'].'@nomail.com'); $user->setPassword(''); $user->setRegion(''); $user->setCity(''); $user->setAddress(''); $user->setSex(''); $user->setUserinfo($data['userinfo']); $user->setAvatarType(0); $user->setAvatar(0); $user->setIdentifier($data['identifier']); $user->setTypesocnet(1);

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

// нужно или нет? $hybridauth->restoreSessionData(); // нужно или нет?

        // нужно или нет?
        $hybridauth->restoreSessionData(); 
        // нужно или нет?
 

// нужно или нет? $hybridauth->restoreSessionData(); // нужно или нет?

После этого остаётся перенаправить пользователя в его аккаунт методом dispatch действию authenticate контроллёра «zfcuser», передав дополнительный параметр 'twitter'=>$post['twitter'] и не обращайте внимание на код после строки "// TODO: Add the redirect parameter here...":

if($user) { if ($service->getOptions()->getLoginAfterRegistration()) { $identityFields = $service->getOptions()->getAuthIdentityFields(); if (in_array('email', $identityFields)) { $post['identity'] = $user->getEmail(); } elseif(in_array('username', $identityFields)) { $post['identity'] = $user->getUsername(); } $post['credential'] = $post['password']; $post['twitter'] = 1; $request->setPost(new Parameters($post)); return $this->forward()->dispatch('zfcuser', array('action' => 'authenticate','twitter'=>$post['twitter'])); } // TODO: Add the redirect parameter here... return $this->redirect()->toUrl($this->url()->fromRoute('zfcuser/login') . ($request ? '?redirect='.$request : '')); }

Таким образом можно расширить стандартную аутентификацию пользователя! При этом по тому же принципу можно добавить весь набор социальных сетей, которые находятся в Hybridauth:

• Foursquare
• LinkedIn
• MySpace
• Live
• Twitter
• Facebook
• Google
• AOL
• Yahoo
• OpenID