Система предварительной регистрации и приглашения Symfony2

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

Наконец, мы «закрываем» весь сайт ( ^/ , за исключением тех шаблонов URI, которые были определены ранее) для всех, кроме «инсайдеров» ( ROLE_USER или ROLE_ADMIN ).

AppBundle:User объект

Я предпочитаю, чтобы AppBundle:User объект создавался путем импорта существующей структуры БД. Этот объект сам по себе еще не может использоваться процессом аутентификации. Нам нужны дальнейшие модификации:

 <?php namespace AppBundle\Entity; use Symfony\Component\Security\Core\User\UserInterface; /** * User */ class User implements UserInterface, \Serializable { /** * @var integer */ private $id; //All the table properties follow... public function getId() { return $this->id; } //All the getters/setters follow... /** * Get roles * * @return [string] */ public function getRoles() { return [$this->roles]; } public function eraseCredentials() { return; } public function serialize() { ... } public function unserialize($serialized) { ... } public function getSalt() { ... } } 

Класс User должен реализовывать два интерфейса: Symfony\Component\Security\Core\User\UserInterface и \Serializable . Это потребует от нас определения дополнительных методов, включая eraseCredentials , serialize , unserialize и getSalt .

Примечание об определении метода getRoles . roles — это поле в нашей user таблице, поэтому метод получения автоматически генерируется следующим образом:

 public function getRoles() { return $this->roles; } 

Это потому, что мы определяем поле roles так же просто, как VARCHAR(255) , который вернет сохраненную нами строку. Однако для Symfony требуются роли в формате массива, поэтому, несмотря на то, что для нашего пользователя на данный момент сохранена только одна строковая роль, мы учитываем систему с несколькими ролями и требование ролей как массив, разбивая эту строку. Таким образом, если мы хотим, чтобы у пользователя было несколько ролей, мы можем сохранить их в виде списка через запятую ( ROLE_ADMIN, ROLE_BLOGGER, ROLE_ACCOUNTANT ). Таким образом, мы настраиваем метод следующим образом:

 public function getRoles() { return explode(',', $this->roles); } 

Пришло время перейти к логике, но перед этим давайте создадим самого первого пользователя root с максимальными правами доступа.

Для пользователя легко заполнить все поля в user таблице, кроме одного: поля password . Мы используем bcrypt для хэширования нашего пароля, поэтому мы не можем вставить в него простой текстовый пароль. Чтобы помочь нам справиться с этой утомительной задачей, мы используем этот онлайн-инструмент . Мой пример SQL INSERT оператора root (хэш, рассчитанный для пароля «test») приведен ниже:

 INSERT INTO `user` (`username`, `password`, `email`, `roles`, `active`) VALUES ('root', '$2a$12$3INF/uK0.pmZAMFW0In0uOrfpq.yaVIK0xwmWO8Yjxhs4m8CC1Ei2', '[email protected]', 'ROLE_ADMIN', '1'); 

У вас есть приглашение от ADMIN

Когда администратор посещает страницу /invite , он может ввести адрес электронной почты, чтобы пригласить кого-то. Затем приложение создаст письмо и отправит его. Письмо будет содержать ссылку для регистрации получателя и уникальный код приглашения, чтобы проверить, что приглашение поступает из надежного источника. Это все. В серверной части адрес электронной почты получателя, код приглашения и срок действия будут сохранены в таблице базы данных.

Код этого метода приведен ниже:

 public function doinviteAction(Request $req) { $email = $req->get('email'); $userid = $req->get('user'); $hash = $this->setInvite($userid, $email); $this->sendMail($email, $hash); $url = $this->generateUrl('invite'); return $this->redirect($url); } private function setInvite($userid, $email) { $em = $this->getDoctrine()->getManager(); $user_repo = $em->getRepository('AppBundle:User'); $user = $user_repo->find($userid); //The user who initiates the invitation $invite = new Invite(); $invite->setInvited($email); $invite->setWhoinvite($user); $now = new \DateTime(); $int = new \DateInterval('P1D'); $now->add($int); $invite->setExpires($now); //Set invitation expirary $random = rand(10000, 99999); $invite->setHash($random); //A random number is used but stricter method to create a verification code can be used. $em->persist($invite); $em->flush(); return $random; } private function sendMail($email, $hash) { $mailer = $this->get('mailer'); $message = $mailer->createMessage() ->setSubject('Someone invites you to join thisdomain.com') ->setFrom('[email protected]') ->setTo($email) ->setBody( $this->renderView('AppBundle:Default:email.html.twig', ['email' => $email, 'hash' => $hash]), 'text/html' ); $mailer->send($message); } 

Мы получаем пользователя, который отправляет приглашение ( $userid ), и пользователя, которого они намереваются пригласить ( $email ). Затем мы создаем запись приглашения и генерируем случайное число, связанное с этим приглашением, в качестве кода приглашения. Вся информация, необходимая для отправки приглашения (включая код приглашения), будет сохранена и сохранена. Наконец, мы возвращаем код приглашения.

После того, как приглашение сохранено, мы отправляем электронное письмо. Я использую почтовый сервис Symfony по умолчанию для этого. Обратите внимание, что для тела письма я использую шаблон Twig для рендеринга богатого контента.

Поскольку только администратор может пригласить другого человека, нам нужно контролировать содержимое страницы на основе авторизации пользователя. Механизм шаблонов по умолчанию, используемый в Symfony, Twig, имеет помощника для этого:

 {% if is_granted('ROLE_ADMIN') %} <li><a href="{{path('invite')}}"><i class="large-icon-share"></i>&nbsp;&nbsp;Invite</a></li> {% endif %} 

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

Регистрация начинается

Когда получатель получает приглашение от администратора, он может щелкнуть ссылку и проверить приглашение.

Действующее приглашение должно удовлетворять следующим условиям:

1. Письмо действительно приглашено.
2. Срок действия приглашения не истек.
3. Код подтверждения проверен и связан с этим электронным письмом.

Все вышеперечисленное делается в соответствующем действии контроллера:

 public function preregisterAction(Request $req) { $email = $req->get('email'); $invitationCode = $req->get('code'); try { $this->verify($email, $invitationCode); } catch (\Exception $e) { $this->addFlash('error', $e->getMessage()); return $this->redirectToRoute('error'); } $registration = new User(); $form = $this->createForm(new RegistrationType(), $registration, ['action' => $this->generateUrl('create'), 'method' => 'POST']); return $this->render('AppBundle:Default:register2.html.twig', ['form' => $form->createView(), 'email' => $email]); } private function verify($email, $code) { $repo = $this->getDoctrine()->getManager()->getRepository('AppBundle:Invite'); $invites = $repo->findBy(['invited' => $email]); if (count($invites) == 0) { throw new \Exception("This email is not invited."); } $invite = $invites[0]; $exp = $invite->getExpires(); $now = new \DateTime(); if ($exp < $now) { throw new \Exception("Invitation expires."); } if ($invite->getCode() !== $code) { throw new \Exception('Wrong invitation code.'); } } 

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

Вывод

Это подводит нас к концу первой части Symfony 2 Security Management, которая охватывает настройку приложения (database и security.yml ) и этап предварительной регистрации, на котором пользователь проверяет с помощью приложения, что они действительно приглашены.

В нашей части 2 мы рассмотрим следующие два шага: регистрация и вход в систему. Мы также разработаем наш обработчик после входа в систему для выполнения некоторых действий для конкретного приложения после успешного входа пользователя.

Будьте на связи!