[Administration] Utilisateurs : import CSV #1332

backend/controllers/UserController.php

@@ -138,33 +138,26 @@ class UserController extends BackendController
             $this->setFlash('success', "L'utilisateur que vous souhaitez créer possède déjà un compte sur la plateforme. Il vient d'être lié à votre établissement.");
         } else {
             if ($model->load(\Yii::$app->request->post()) && $model->validate() && YII_ENV != 'demo') {
-                $model->id_producer = 0;
-                $password = Password::generate();
-                $userModule->setPassword($model, $password);
-                $userModule->generateAuthKey($model);
-                $model->username = $model->email;
-                if (!strlen($model->email)) {
-                    $model->username = 'inconnu@opendistrib.net';
-                }
-
-                $model->save();
 
-                // liaison etablissement / user
-                $useProducer = new  UserProducer();
-                $useProducer->id_user = $model->id;
-                $useProducer->id_producer = GlobalParam::getCurrentProducerId();
-                $useProducer->credit = 0;
-                $useProducer->active = 1;
-                $useProducer->newsletter = $model->newsletter;
-                $useProducer->save();
+                $model = $userModule->getBuilder()->createUser(
+                    User::TYPE_INDIVIDUAL,
+                    $model->email,
+                    $model->name,
+                    $model->lastname,
+                    $model->name_legal_person,
+                    $model->phone,
+                    $model->address,
+                    $model->newsletter,
+                    Password::generate()
+                );
 
-                $userModule->sendMailWelcome($model, $password);
                 $this->processLinkPointSale($model);
                 $this->processLinkUserGroup($model);
                 $this->processProductPricePercent($model);
 
                 $this->setFlash('success', 'Utilisateur créé.');
-                $model = $userModule->instanciateUser();
+
+                return $this->refresh();
             }
         }
 
@@ -199,10 +192,10 @@ class UserController extends BackendController
                 $this->processProductPricePercent($model);
 
                 if($model->newsletter) {
-                    $userModule->subscribeUserNewsletter($model);
+                    $userModule->getNewsletterManager()->subscribeUserNewsletter($model);
                 }
                 else {
-                    $userModule->unsubscribeUserNewsletter($model);
+                    $userModule->getNewsletterManager()->unsubscribeUserNewsletter($model);
                 }
 
                 $this->setFlash('success', 'Utilisateur <strong>'.Html::encode($userModule->getUsername($model)).'</strong> modifié.');

backend/controllers/UserImportController.php

@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * Copyright distrib (2018)
+ *
+ * contact@opendistrib.net
+ *
+ * Ce logiciel est un programme informatique servant à aider les producteurs
+ * à distribuer leur production en circuits courts.
+ *
+ * Ce logiciel est régi par la licence CeCILL soumise au droit français et
+ * respectant les principes de diffusion des logiciels libres. Vous pouvez
+ * utiliser, modifier et/ou redistribuer ce programme sous les conditions
+ * de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
+ * sur le site "http://www.cecill.info".
+ *
+ * En contrepartie de l'accessibilité au code source et des droits de copie,
+ * de modification et de redistribution accordés par cette licence, il n'est
+ * offert aux utilisateurs qu'une garantie limitée.  Pour les mêmes raisons,
+ * seule une responsabilité restreinte pèse sur l'auteur du programme,  le
+ * titulaire des droits patrimoniaux et les concédants successifs.
+ *
+ * A cet égard  l'attention de l'utilisateur est attirée sur les risques
+ * associés au chargement,  à l'utilisation,  à la modification et/ou au
+ * développement et à la reproduction du logiciel par l'utilisateur étant
+ * donné sa spécificité de logiciel libre, qui peut le rendre complexe à
+ * manipuler et qui le réserve donc à des développeurs et des professionnels
+ * avertis possédant  des  connaissances  informatiques approfondies.  Les
+ * utilisateurs sont donc invités à charger  et  tester  l'adéquation  du
+ * logiciel à leurs besoins dans des conditions permettant d'assurer la
+ * sécurité de leurs systèmes et ou de leurs données et, plus généralement,
+ * à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
+ *
+ * Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
+ * pris connaissance de la licence CeCILL, et que vous en avez accepté les
+ * termes.
+ */
+
+namespace backend\controllers;
+
+use backend\forms\UserImportUploadForm;
+use common\helpers\CSV;
+use yii\filters\AccessControl;
+use yii\web\UploadedFile;
+
+class UserImportController extends BackendController
+{
+    public function behaviors()
+    {
+        return [
+            'access' => [
+                'class' => AccessControl::class,
+                'rules' => [
+                    [
+                        'allow' => true,
+                        'roles' => ['@'],
+                        'matchCallback' => function ($rule, $action) {
+                            return $this->getUserModule()
+                                ->getAuthorizationChecker()
+                                ->isGrantedAsProducer($this->getUserCurrent());
+                        }
+                    ]
+                ],
+            ],
+        ];
+    }
+
+    public function actionIndex()
+    {
+        $model = new UserImportUploadForm();
+        if (\Yii::$app->request->isPost) {
+            $model->file = UploadedFile::getInstance($model, 'file');
+            if($model->file && $model->validate()) {
+                $this->getUserModule()->getBulkImporter()->import($model->file->tempName);
+                $this->setFlash('success', "Fichier importé.");
+            }
+        }
+
+        return $this->render('index', [
+            'model' => $model
+        ]);
+    }
+}

backend/forms/UserImportUploadForm.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace backend\forms;
+
+use yii\base\Model;
+use yii\web\UploadedFile;
+
+class UserImportUploadForm extends Model
+{
+    /**
+     * @var UploadedFile file attribute
+     */
+    public $file;
+
+    /**
+     * @return array the validation rules.
+     */
+    public function rules()
+    {
+        return [
+            [['file'], 'file', 'skipOnEmpty' => false, 'mimeTypes' => 'text/csv, text/plain'],
+        ];
+    }
+
+    public function attributeLabels()
+    {
+        return [
+            'file' => "Fichier d'import (CSV)"
+        ];
+    }
+}
+
+?>

backend/views/layouts/left.php

@@ -122,6 +122,7 @@ $isUserCurrentGrantedAsProducer = $userModule->getAuthorizationChecker()->isGran
                                 'visible' => $isUserCurrentGrantedAsProducer && $producerModule->getConfig('credit')
                             ],
                             ['label' => 'Groupes', 'icon' => 'users', 'url' => ['/user-group/index'], 'visible' => $isUserCurrentGrantedAsProducer],
+                            ['label' => 'Import', 'icon' => 'upload', 'url' => ['/user-import/index'], 'visible' => $isUserCurrentGrantedAsProducer],
                         ],
                     ],
                     ['label' => 'Abonnements', 'icon' => 'repeat', 'url' => ['/subscription/index'], 'visible' => $isUserCurrentGrantedAsProducer, 'active' => Yii::$app->controller->id == 'subscription'],

backend/views/user-import/index.php

@@ -0,0 +1,65 @@
+<?php
+
+/**
+ * Copyright distrib (2018)
+ *
+ * contact@opendistrib.net
+ *
+ * Ce logiciel est un programme informatique servant à aider les producteurs
+ * à distribuer leur production en circuits courts.
+ *
+ * Ce logiciel est régi par la licence CeCILL soumise au droit français et
+ * respectant les principes de diffusion des logiciels libres. Vous pouvez
+ * utiliser, modifier et/ou redistribuer ce programme sous les conditions
+ * de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
+ * sur le site "http://www.cecill.info".
+ *
+ * En contrepartie de l'accessibilité au code source et des droits de copie,
+ * de modification et de redistribution accordés par cette licence, il n'est
+ * offert aux utilisateurs qu'une garantie limitée.  Pour les mêmes raisons,
+ * seule une responsabilité restreinte pèse sur l'auteur du programme,  le
+ * titulaire des droits patrimoniaux et les concédants successifs.
+ *
+ * A cet égard  l'attention de l'utilisateur est attirée sur les risques
+ * associés au chargement,  à l'utilisation,  à la modification et/ou au
+ * développement et à la reproduction du logiciel par l'utilisateur étant
+ * donné sa spécificité de logiciel libre, qui peut le rendre complexe à
+ * manipuler et qui le réserve donc à des développeurs et des professionnels
+ * avertis possédant  des  connaissances  informatiques approfondies.  Les
+ * utilisateurs sont donc invités à charger  et  tester  l'adéquation  du
+ * logiciel à leurs besoins dans des conditions permettant d'assurer la
+ * sécurité de leurs systèmes et ou de leurs données et, plus généralement,
+ * à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
+ *
+ * Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
+ * pris connaissance de la licence CeCILL, et que vous en avez accepté les
+ * termes.
+ */
+
+use yii\bootstrap\ActiveForm;
+use yii\helpers\Html;
+
+$this->setTitle('Import utilisateurs');
+$this->addBreadcrumb($this->getTitle());
+
+?>
+
+<div class="product-price-import">
+    <div class="alert alert-info">
+        <i class="icon fa fa-info"></i>
+        Fichier d'exemple : <a href="<?= Yii::$app->urlManager->baseUrl ?>/csv/users-import-sample.csv">Télécharger (CSV)</a>
+    </div>
+
+    <?php $form = ActiveForm::begin([
+        'enableClientValidation' => false,
+        'options' => ['enctype' => 'multipart/form-data']
+    ]); ?>
+
+    <?= $form->field($model, 'file')->fileInput() ?>
+
+    <div class="form-group">
+        <?= Html::submitButton('Envoyer', ['class' => 'btn btn-primary']) ?>
+    </div>
+
+    <?php ActiveForm::end(); ?>
+</div>

backend/web/csv/users-import-sample.csv

@@ -0,0 +1,2 @@
+Type;Nom;Prénom;Nom personne légale;Téléphone;Email;Inscrit au bulletin d'information;Adresse
+Particulier;Durand;Paul;;600000000;durand.paul@yopmail.com;1;

common/components/ActiveRecordCommon.php

@@ -53,6 +53,17 @@ class ActiveRecordCommon extends \yii\db\ActiveRecord
         $this->populateRelation($fieldObject, $object);
     }
 
+    public function triggerEvent(string $event, array $attributes)
+    {
+        $event = new $event();
+
+        foreach($attributes as $key => $value) {
+            $event->$key = $value;
+        }
+
+        $this->trigger($event::NAME, $event);
+    }
+
     /**
      * Méthode générique de recherche utilisée pour tous les modèles. Elle a
      * pour but de construire la requête et de retourner le résultat.

common/config/main.php

@@ -43,6 +43,7 @@ use common\logic\Document\DeliveryNote\Model\DeliveryNote;
 use common\logic\Order\Order\Model\Order;
 use common\logic\Ticket\Ticket\Model\Ticket;
 use common\logic\Payment\Model\Payment;
+use common\logic\User\User\Model\User;
 
 $serverName = isset($_SERVER['SERVER_NAME']) ?? '';
 
@@ -176,6 +177,10 @@ return [
             'class'     => \justcoded\yii2\eventlistener\components\EventListener::class,
             'listeners' => [],
             'observers' => [
+                User::class => [
+                    // Producer : lien avec utilisateur
+                    common\logic\Producer\Producer\Event\UserObserver::class
+                ],
                 Order::class => [
                     // Payment : remboursement commande
                     common\logic\Payment\Event\OrderObserver::class

common/helpers/CSV.php

@@ -49,6 +49,30 @@ class CSV
         die();
     }
 
+    public static function csv2array(string $filename = '', string $delimiter = ';')
+    {
+        if(!file_exists($filename) || !is_readable($filename)) {
+            return FALSE;
+        }
+
+        $header = null;
+        $data = array();
+        if (($handle = fopen($filename, 'r')) !== FALSE) {
+            while (($row = fgetcsv($handle, 1000, $delimiter)) !== FALSE) {
+                if(!$header) {
+                    $header = $row;
+                }
+                else {
+                    //$data[] = array_combine($header, $row);
+                    $data[] = $row;
+                }
+            }
+            fclose($handle);
+        }
+
+        return $data;
+    }
+
     public static function array2csv(array &$array)
     {
         $producerModule = ProducerModule::getInstance();

common/logic/AbstractService.php

@@ -15,8 +15,8 @@ abstract class AbstractService extends AbstractSingleton implements ServiceInter
             SolverInterface::class,
             RepositoryQueryInterface::class,
             RepositoryInterface::class,
-            BuilderInterface::class,
             NotifierInterface::class,
+            BuilderInterface::class,
             ResolverInterface::class,
             GeneratorInterface::class,
             ManagerInterface::class,

common/logic/Producer/Producer/Event/UserObserver.php

@@ -0,0 +1,22 @@
+<?php
+namespace common\logic\Producer\Producer\Event;
+
+use common\logic\Producer\Producer\Module\ProducerModule;
+use common\logic\User\User\Event\UserCreateEvent;
+use justcoded\yii2\eventlistener\observers\Observer;
+
+class UserObserver extends Observer
+{
+    public function events()
+    {
+        return [
+            UserCreateEvent::NAME => 'onUserCreate'
+        ];
+    }
+
+    public function onUserCreate(UserCreateEvent $event)
+    {
+        ProducerModule::getInstance()->getBuilder()
+            ->addUser($event->user, $event->producer, true, $event->newsletter);
+    }
+}

common/logic/Producer/Producer/Service/ProducerBuilder.php

@@ -67,7 +67,7 @@ class ProducerBuilder extends AbstractBuilder
      */
     public function addUser(User $user, Producer $producer, bool $bookmark = true, bool $newsletter = true): UserProducer
     {
-        $userProducer =  $this->userProducerBuilder->createUserProducerIfNotExist($user, $producer, $bookmark, $newsletter);
+        $userProducer = $this->userProducerBuilder->createUserProducerIfNotExist($user, $producer, $bookmark, $newsletter);
 
         if (!$userProducer->getActive()) {
             $userProducer->setActive(true);

common/logic/User/User/Event/TicketObserver.php

@@ -9,9 +9,7 @@ class TicketObserver extends ActiveRecordObserver
 {
     public function inserted(AfterSaveEvent $event)
     {
-        $ticket = $event->sender;
-        $userModule = UserModule::getInstance();
-
-        $userModule->sendMailNewTicketAdmin($ticket);
+        UserModule::getInstance()->getNotifier()
+            ->sendMailNewTicketAdmin($event->sender);
     }
 }

common/logic/User/User/Event/UserCreateEvent.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace common\logic\User\User\Event;
+
+use common\logic\Producer\Producer\Model\Producer;
+use common\logic\User\User\Model\User;
+use yii\base\Event;
+
+class UserCreateEvent extends Event
+{
+    const NAME = 'user.create.event';
+
+    public User $user;
+    public Producer $producer;
+    public bool $newsletter;
+}

common/logic/User/User/Model/User.php

@@ -51,6 +51,8 @@ use common\components\ActiveRecordCommon;
  */
 class User extends ActiveRecordCommon implements IdentityInterface
 {
+    const EVENT_CREATE = 'user.event.create';
+
     const TYPE_INDIVIDUAL = 'individual';
     const TYPE_LEGAL_PERSON = 'legal-person';
     const TYPE_GUEST = 'guest';

common/logic/User/User/Module/UserModule.php

@@ -8,6 +8,7 @@ use common\logic\User\User\Repository\UserRepositoryQuery;
 use common\logic\User\User\Service\AuthorizationChecker;
 use common\logic\User\User\Service\NewsletterManager;
 use common\logic\User\User\Service\UserBuilder;
+use common\logic\User\User\Service\UserBulkImporter;
 use common\logic\User\User\Service\UserDefinition;
 use common\logic\User\User\Service\UserNotifier;
 use common\logic\User\User\Service\UsersCreditCsvGenerator;
@@ -22,6 +23,7 @@ use common\logic\User\User\Service\UserSolver;
  * @mixin UsersCreditCsvGenerator
  * @mixin NewsletterManager
  * @mixin AuthorizationChecker
+ * @mixin UserBulkImporter
  */
 class UserModule extends AbstractModule
 {
@@ -37,6 +39,7 @@ class UserModule extends AbstractModule
             UsersCreditCsvGenerator::class,
             NewsletterManager::class,
             AuthorizationChecker::class,
+            UserBulkImporter::class
         ];
     }
 
@@ -79,4 +82,9 @@ class UserModule extends AbstractModule
     {
         return AuthorizationChecker::getInstance();
     }
+
+    public function getBulkImporter(): UserBulkImporter
+    {
+        return UserBulkImporter::getInstance();
+    }
 }

common/logic/User/User/Service/UserBuilder.php

@@ -2,46 +2,116 @@
 
 namespace common\logic\User\User\Service;
 
+use common\helpers\Password;
 use common\logic\AbstractBuilder;
+use common\logic\Order\Order\Event\OrderDeleteEvent;
+use common\logic\Order\Order\Model\Order;
 use common\logic\Producer\Producer\Model\Producer;
+use common\logic\User\User\Event\UserCreateEvent;
 use common\logic\User\User\Model\User;
 use common\logic\User\User\Repository\UserRepository;
+use common\logic\User\UserProducer\Service\UserProducerBuilder;
 
 class UserBuilder extends AbstractBuilder
 {
     protected UserRepository $userRepository;
+    protected UserNotifier $userNotifier;
+    protected UserProducerBuilder $userProducerBuilder;
 
     public function loadDependencies(): void
     {
         $this->userRepository = $this->loadService(UserRepository::class);
+        $this->userNotifier = $this->loadService(UserNotifier::class);
+        $this->userProducerBuilder = $this->loadService(UserProducerBuilder::class);
     }
 
-    public function instanciateUser(): User
+    public function instanciateUser(
+        string $type = null,
+        string $email = null,
+        string $firstname = null,
+        string $lastname = null,
+        string $nameLegalPerson = null,
+        string $phone = null,
+        string $address = null,
+        string $password = null
+    ): User
     {
         $user = new User();
+        $user->id_producer = 0;
+        $user->type = $type;
+        $this->initUsername($user, $email);
+        $user->email = $email;
+        $user->name = $firstname;
+        $user->lastname = $lastname;
+        $user->name_legal_person = $nameLegalPerson;
+        $user->phone = $phone;
+        $user->address = $address;
+        $this->initPassword($user, $password);
 
         return $user;
     }
 
-    public function initPassword(User $user, string $password)
+    public function createUser(
+        string $type = null,
+        string $email = null,
+        string $firstname = null,
+        string $lastname = null,
+        string $nameLegalPerson = null,
+        string $phone = null,
+        string $address = null,
+        bool $newsletter = true,
+        string $password = null
+    ): User
     {
-        $this->setPassword($user, $password);
-        $this->generateAuthKey($user);
+        $userExist = null;
+        if($email && strlen($email)) {
+            $userExist = $this->userRepository->findOneUserByEmail($email);
+            $user = $userExist;
+        }
+
+        if(!$userExist) {
+            $user = $this->instanciateUser(
+                $type,
+                $email,
+                $firstname,
+                $lastname,
+                $nameLegalPerson,
+                $phone,
+                $address,
+                $password
+            );
+            $this->create($user);
+
+            $this->userNotifier->sendMailWelcome($user, $password);
+        }
+
+        $user->triggerEvent(
+            UserCreateEvent::class,
+            [
+                'user' => $user,
+                'producer' => $this->getProducerContext(),
+                'newsletter' => $newsletter
+            ]
+        );
+
+        return $user;
     }
 
-    public function initProducer(User $user, Producer $producer)
+    public function initUsername(User $user, string $email = null)
     {
-        $user->id_producer = $producer->id;
-        $user->status = User::STATUS_PRODUCER;
+        $user->username = $email;
+        if (!$email) {
+            $user->username = 'inconnu@opendistrib.net';
+        }
     }
 
-    /**
-     * Met à jour la date de dernière connexion de l'utilisateur.
-     */
-    public function updateUserLastConnection(User $user)
+    public function initPassword(User $user, string $password = null)
     {
-        $user->date_last_connection = date('Y-m-d H:i:s');
-        $user->save();
+        if(!$password) {
+            $password = Password::generate();
+        }
+        $this->setPassword($user, $password);
+        $this->generateAuthKey($user);
     }
 
     /**
@@ -60,6 +130,21 @@ class UserBuilder extends AbstractBuilder
         $user->auth_key = \Yii::$app->security->generateRandomString();
     }
 
+    public function initProducer(User $user, Producer $producer)
+    {
+        $user->id_producer = $producer->id;
+        $user->status = User::STATUS_PRODUCER;
+    }
+
+    /**
+     * Met à jour la date de dernière connexion de l'utilisateur.
+     */
+    public function updateUserLastConnection(User $user)
+    {
+        $user->date_last_connection = date('Y-m-d H:i:s');
+        $user->save();
+    }
+
     /**
      * Generates new password reset token
      */

common/logic/User/User/Service/UserBulkImporter.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace common\logic\User\User\Service;
+
+use common\helpers\CSV;
+use common\helpers\Password;
+use common\logic\AbstractManager;
+use common\logic\User\User\Model\User;
+use common\logic\User\UserProducer\Model\UserProducer;
+
+class UserBulkImporter extends AbstractManager
+{
+    const TYPE = 0;
+    const LASTNAME = 1;
+    const FIRSTNAME = 2;
+    const NAME_LEGAL_PERSON = 3;
+    const PHONE = 4;
+    const EMAIL = 5;
+    const NEWSLETTER = 6;
+    const ADDRESS = 7;
+
+    protected UserSolver $userSolver;
+    protected UserBuilder $userBuilder;
+
+    public function loadDependencies(): void
+    {
+        $this->userSolver = $this->loadService(UserSolver::class);
+        $this->userBuilder = $this->loadService(UserBuilder::class);
+    }
+
+    public function import(string $fileName): void
+    {
+        $usersArray = CSV::csv2array($fileName);
+
+        foreach($usersArray as $userData) {
+            $this->userBuilder->createUser(
+                $this->userSolver->getTypeIndex($userData[self::TYPE]),
+                $userData[self::EMAIL],
+                $userData[self::FIRSTNAME],
+                $userData[self::LASTNAME],
+                $userData[self::NAME_LEGAL_PERSON],
+                $userData[self::PHONE],
+                $userData[self::ADDRESS],
+                $userData[self::NEWSLETTER],
+                Password::generate()
+            );
+        }
+    }
+}

common/logic/User/User/Service/UserNotifier.php

@@ -39,7 +39,7 @@ class UserNotifier extends AbstractNotifier implements ManagerInterface
     public function sendMailWelcome(User $user, string $password): void
     {
         if (strlen($user->email)) {
-            $producer = Producer::findOne(GlobalParam::getCurrentProducerId());
+            $producer = $this->getProducerContext();
             $this->mailer->sendFromProducer(
                 'Inscription',
                 'createUserAdmin',

common/logic/User/User/Service/UserSolver.php

@@ -30,6 +30,17 @@ class UserSolver extends AbstractService implements SolverInterface
         return '';
     }
 
+    public function getTypeIndex(string $typeLabel = null): ?string
+    {
+        foreach($this->getTypeChoicesArray() as $key => $label) {
+            if($label == $typeLabel) {
+                return $key;
+            }
+        }
+
+        return null;
+    }
+
     public function isTypeValid(string $type = null): bool
     {
         return in_array($type, User::$types);