|
| 1 | +<?php |
| 2 | + |
| 3 | +/* |
| 4 | + * This file is part of the Symfony package. |
| 5 | + * |
| 6 | + * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | + * |
| 8 | + * For the full copyright and license information, please view the LICENSE |
| 9 | + * file that was distributed with this source code. |
| 10 | + */ |
| 11 | + |
| 12 | +namespaceAppBundle\Command; |
| 13 | + |
| 14 | +useSymfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; |
| 15 | +useSymfony\Component\Console\Input\InputArgument; |
| 16 | +useSymfony\Component\Console\Input\InputInterface; |
| 17 | +useSymfony\Component\Console\Input\InputOption; |
| 18 | +useSymfony\Component\Console\Output\OutputInterface; |
| 19 | +useSymfony\Component\Console\Question\Question; |
| 20 | +useDoctrine\Common\Persistence\ObjectManager; |
| 21 | +useAppBundle\Entity\User; |
| 22 | + |
| 23 | +/** |
| 24 | + * A command console that creates users and stores them in the database. |
| 25 | + * To use this command, open a terminal window, enter into your project |
| 26 | + * directory and execute the following: |
| 27 | + * $ php app/console app:add-user |
| 28 | + * |
| 29 | + * To output detailed information, increase the command verbosity: |
| 30 | + * $ php app/console app:add-user -vv |
| 31 | + * |
| 32 | + * See http://symfony.com/doc/current/cookbook/console/console_command.html |
| 33 | + * |
| 34 | + * @author Javier Eguiluz <javier.eguiluz@gmail.com> |
| 35 | + */ |
| 36 | +class AddUserCommandextends ContainerAwareCommand |
| 37 | +{ |
| 38 | +constMAX_ATTEMPTS =5; |
| 39 | + |
| 40 | +/** @var ObjectManager */ |
| 41 | +private$em; |
| 42 | + |
| 43 | +protectedfunctionconfigure() |
| 44 | + { |
| 45 | +$this |
| 46 | +// a good practice is to use the 'app:' prefix to group all your custom application commands |
| 47 | + ->setName('app:add-user') |
| 48 | + ->setDescription('Creates users and stores them in the database') |
| 49 | + ->setHelp($this->getCommandHelp()) |
| 50 | +// commands can optionally define arguments and/or options (mandatory and optional) |
| 51 | +// see http://symfony.com/doc/current/components/console/console_arguments.html |
| 52 | + ->addArgument('username', InputArgument::OPTIONAL,'The username of the new user') |
| 53 | + ->addArgument('password', InputArgument::OPTIONAL,'The plain password of the new user') |
| 54 | + ->addArgument('email', InputArgument::OPTIONAL,'The email of the new user') |
| 55 | + ->addOption('is-admin',null, InputOption::VALUE_NONE,'If set, the user is created as an administrator') |
| 56 | + ; |
| 57 | + } |
| 58 | + |
| 59 | +/** |
| 60 | + * This method is executed before initialize() and execute(). Its purpose is |
| 61 | + * to check if some of the options/arguments are missing and interactively |
| 62 | + * ask the user for those values. |
| 63 | + * |
| 64 | + * This method is completely optional. If you are developing an internal console |
| 65 | + * command, you probably should not implement this method because it requires |
| 66 | + * quite a lot of work. However, if the command is meant to be used by external |
| 67 | + * users, this method is a nice way to fall back and prevent errors. |
| 68 | + */ |
| 69 | +protectedfunctioninteract(InputInterface$input,OutputInterface$output) |
| 70 | + { |
| 71 | +if (null !==$input->getArgument('username') &&null !==$input->getArgument('password') &&null !==$input->getArgument('email')) { |
| 72 | +return; |
| 73 | + } |
| 74 | + |
| 75 | +$output->writeln(''); |
| 76 | +$output->writeln('Add User Command Interactive Wizard'); |
| 77 | +$output->writeln('-----------------------------------'); |
| 78 | + |
| 79 | +$output->writeln(array( |
| 80 | +'', |
| 81 | +'If you prefer to not use this interactive wizard, provide the', |
| 82 | +'arguments required by this command as follows:', |
| 83 | +'', |
| 84 | +' $ php app/console app:add-user username password email@example.com', |
| 85 | +'', |
| 86 | + )); |
| 87 | + |
| 88 | +$output->writeln(array( |
| 89 | +'', |
| 90 | +'Now we\'ll ask you for the value of all the missing command arguments.', |
| 91 | +'', |
| 92 | + )); |
| 93 | + |
| 94 | +// See http://symfony.com/doc/current/components/console/helpers/questionhelper.html |
| 95 | +$console =$this->getHelper('question'); |
| 96 | + |
| 97 | +// Ask for the username if it's not defined |
| 98 | +if (null ===$username =$input->getArgument('username')) { |
| 99 | +$question =newQuestion(' > <info>Username</>:'); |
| 100 | +$question->setValidator(function ($answer) { |
| 101 | +if (empty($answer)) { |
| 102 | +thrownew \RuntimeException('The username cannot be empty'); |
| 103 | + } |
| 104 | + |
| 105 | +return$answer; |
| 106 | + }); |
| 107 | +$question->setMaxAttempts(self::MAX_ATTEMPTS); |
| 108 | + |
| 109 | +$username =$console->ask($input,$output,$question); |
| 110 | +$input->setArgument('username',$username); |
| 111 | + }else { |
| 112 | +$output->writeln(' > <info>Username</>:'.$username); |
| 113 | + } |
| 114 | + |
| 115 | +// Ask for the password if it's not defined |
| 116 | +if (null ===$password =$input->getArgument('password')) { |
| 117 | +$question =newQuestion(' > <info>Password</> (your type will be hidden):'); |
| 118 | +$question->setValidator(array($this,'passwordValidator')); |
| 119 | +$question->setHidden(true); |
| 120 | +$question->setMaxAttempts(self::MAX_ATTEMPTS); |
| 121 | + |
| 122 | +$password =$console->ask($input,$output,$question); |
| 123 | +$input->setArgument('password',$password); |
| 124 | + }else { |
| 125 | +$output->writeln(' > <info>Password</>:'.str_repeat('*',strlen($password))); |
| 126 | + } |
| 127 | + |
| 128 | +// Ask for the email if it's not defined |
| 129 | +if (null ===$email =$input->getArgument('email')) { |
| 130 | +$question =newQuestion(' > <info>Email</>:'); |
| 131 | +$question->setValidator(array($this,'emailValidator')); |
| 132 | +$question->setMaxAttempts(self::MAX_ATTEMPTS); |
| 133 | + |
| 134 | +$email =$console->ask($input,$output,$question); |
| 135 | +$input->setArgument('email',$email); |
| 136 | + }else { |
| 137 | +$output->writeln(' > <info>Email</>:'.$email); |
| 138 | + } |
| 139 | + } |
| 140 | + |
| 141 | +/** |
| 142 | + * This method is executed after the interact() and before the execute() |
| 143 | + * method. It's main purpose is to initialize the variables used in the rest |
| 144 | + * of the command methods. |
| 145 | + */ |
| 146 | +protectedfunctioninitialize(InputInterface$input,OutputInterface$output) |
| 147 | + { |
| 148 | +$this->em =$this->getContainer()->get('doctrine')->getManager(); |
| 149 | + } |
| 150 | + |
| 151 | +/** |
| 152 | + * This method is executed after interact() and initialize(). It usually |
| 153 | + * contains the logic to execute to complete this command task. |
| 154 | + */ |
| 155 | +protectedfunctionexecute(InputInterface$input,OutputInterface$output) |
| 156 | + { |
| 157 | +$startTime =microtime(true); |
| 158 | + |
| 159 | +$username =$input->getArgument('username'); |
| 160 | +$plainPassword =$input->getArgument('password'); |
| 161 | +$email =$input->getArgument('email'); |
| 162 | +$isAdmin =$input->getOption('is-admin'); |
| 163 | + |
| 164 | +// first check if a user with the same username already exists |
| 165 | +$existingUser =$this->em->getRepository('AppBundle:User')->findOneBy(array('username' =>$username)); |
| 166 | + |
| 167 | +if (null !==$existingUser) { |
| 168 | +thrownew \RuntimeException(sprintf('There is already a user registered with the "%s" username.',$username)); |
| 169 | + } |
| 170 | + |
| 171 | +// create the user and encode its password |
| 172 | +$user =newUser(); |
| 173 | +$user->setUsername($username); |
| 174 | +$user->setEmail($email); |
| 175 | +$user->setRoles(array($isAdmin ?'ROLE_ADMIN' :'ROLE_USER')); |
| 176 | + |
| 177 | +// See http://symfony.com/doc/current/book/security.html#security-encoding-password |
| 178 | +$encoder =$this->getContainer()->get('security.password_encoder'); |
| 179 | +$encodedPassword =$encoder->encodePassword($user,$plainPassword); |
| 180 | +$user->setPassword($encodedPassword); |
| 181 | + |
| 182 | +$this->em->persist($user); |
| 183 | +$this->em->flush($user); |
| 184 | + |
| 185 | +$output->writeln(''); |
| 186 | +$output->writeln(sprintf('[OK] %s was successfully created: %s (%s)',$isAdmin ?'Administrator user' :'User',$user->getUsername(),$user->getEmail())); |
| 187 | + |
| 188 | +if ($output->isVerbose()) { |
| 189 | +$finishTime =microtime(true); |
| 190 | +$elapsedTime =$finishTime -$startTime; |
| 191 | + |
| 192 | +$output->writeln(sprintf('[INFO] New user database id: %d / Elapsed time: %.2f ms',$user->getId(),$elapsedTime*1000)); |
| 193 | + } |
| 194 | + } |
| 195 | + |
| 196 | +/** |
| 197 | + * This internal method should be private, but it's declared as public to |
| 198 | + * maintain PHP 5.3 compatibility when using it in a callback. |
| 199 | + * |
| 200 | + * @internal |
| 201 | + */ |
| 202 | +publicfunctionpasswordValidator($plainPassword) |
| 203 | + { |
| 204 | +if (empty($plainPassword)) { |
| 205 | +thrownew \Exception('The password can not be empty'); |
| 206 | + } |
| 207 | + |
| 208 | +if (strlen(trim($plainPassword)) <6) { |
| 209 | +thrownew \Exception('The password must be at least 6 characters long'); |
| 210 | + } |
| 211 | + |
| 212 | +return$plainPassword; |
| 213 | + } |
| 214 | + |
| 215 | +/** |
| 216 | + * This internal method should be private, but it's declared as public to |
| 217 | + * maintain PHP 5.3 compatibility when using it in a callback. |
| 218 | + * |
| 219 | + * @internal |
| 220 | + */ |
| 221 | +publicfunctionemailValidator($email) |
| 222 | + { |
| 223 | +if (empty($email)) { |
| 224 | +thrownew \Exception('The email can not be empty'); |
| 225 | + } |
| 226 | + |
| 227 | +if (false ===strpos($email,'@')) { |
| 228 | +thrownew \Exception('The email should look like a real email'); |
| 229 | + } |
| 230 | + |
| 231 | +return$email; |
| 232 | + } |
| 233 | + |
| 234 | +/** |
| 235 | + * The command help is usually included in the configure() method, but when |
| 236 | + * it's too long, it's better to define a separate method to maintain the |
| 237 | + * code readability. |
| 238 | + */ |
| 239 | +privatefunctiongetCommandHelp() |
| 240 | + { |
| 241 | +return<<<HELP |
| 242 | +The <info>%command.name%</info> command creates new users and saves them in the database: |
| 243 | +
|
| 244 | + <info>php %command.full_name%</info> <comment>username password email</comment> |
| 245 | +
|
| 246 | +By default the command creates regular users. To create administrator users, |
| 247 | +add the <comment>--is-admin</comment> option: |
| 248 | +
|
| 249 | + <info>php %command.full_name%</info> username password email <comment>--is-admin</comment> |
| 250 | +
|
| 251 | +If you omit any of the three required arguments, the command will ask you to |
| 252 | +provide the missing values: |
| 253 | +
|
| 254 | + # command will ask you for the email |
| 255 | + <info>php %command.full_name%</info> <comment>username password</comment> |
| 256 | +
|
| 257 | + # command will ask you for the email and password |
| 258 | + <info>php %command.full_name%</info> <comment>username</comment> |
| 259 | +
|
| 260 | + # command will ask you for all arguments |
| 261 | + <info>php %command.full_name%</info> |
| 262 | +
|
| 263 | +HELP; |
| 264 | + } |
| 265 | +} |