Opendistrib/common/models/Producer.php

<?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 common\models;

use Yii;
use common\components\ActiveRecordCommon ;
use common\helpers\Departments;
use yii\helpers\Html;

/**
 * This is the model class for table "etablissement".
 *
 * @property integer $id
 * @property string $name
 * @property string $siret
 * @property string $logo
 * @property string $photo
 * @property string $description
 * @property string $postcode
 * @property string $city
 * @property float credit_limit_reminder
 * @property boolean online_payment
 * @property string mentions
 * @property string gcs
 * @property boolean option_allow_user_gift
 * @property string credit_functioning
 * @property boolean use_credit_checked_default
 * @property float credit_limit
 * @property string background_color_logo
 * 
 */
class Producer extends  ActiveRecordCommon
{
    const CREDIT_FUNCTIONING_MANDATORY = 'mandatory' ;
    const CREDIT_FUNCTIONING_OPTIONAL = 'optional' ;
    const CREDIT_FUNCTIONING_USER = 'user' ;
    
    const HINT_CREDIT_FUNCTIONING = '<ul>'
        . '<li>Optionnelle : l\'utilisateur choisit s\'il utilise son Crédit ou non. Les commandes peuvent être payées ou impayées.</li>'
        . '<li>Obligatoire : toutes les commandes de l\'utilisateur son comptabilisées au niveau du Crédit. Toutes les commandes sont payées.</li>'
        . '<li>Basée sur l\'utilisateur : Crédit obligatoire si l\'utilisateur a le crédit activé au niveau de son compte, système de Crédit non affiché sinon.</li>'
        . '</ul>' ;
    
    public static $creditFunctioningArray = [
        self::CREDIT_FUNCTIONING_MANDATORY => 'Obligatoire',
        self::CREDIT_FUNCTIONING_OPTIONAL => 'Optionnelle',
        self::CREDIT_FUNCTIONING_USER => 'Basée sur l\'utilisateur',
    ];
    
    const BEHAVIOR_DELETE_ORDER_DELETE = 'delete' ;
    const BEHAVIOR_DELETE_ORDER_STATUS = 'status' ;
    
    var $secret_key_payplug ;
    
    /**
     * @inheritdoc
     */
    public static function tableName() 
    {
        return 'producer';
    }

    /**
     * @inheritdoc
     */
    public function rules() 
    {
        return [
            [['name','type'], 'required'],
            [['tiller_provider_token','tiller_restaurant_token'], 'required', 'when' => function($model) {
                return $model->tiller == true ;
            }],
            [['order_deadline', 'order_delay'], 'integer'],
            ['order_deadline', 'in', 'range' => [8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24]],
            ['order_delay', 'in', 'range' => [1, 2, 3, 4, 5, 6, 7]],
            ['code', function($attribute, $params) {
                    $code = $this->$attribute;
                    $producer = Producer::findOne(['code' => $code]);
                    if ($producer && $producer->id != $this->id) {
                        $this->addError($attribute, 'Ce code est déjà utilisé par un autre producteur.');
                    }
                }],
            [['description','mentions','gcs','order_infos','slug','secret_key_payplug','background_color_logo','option_behavior_cancel_order','tiller_provider_token','tiller_restaurant_token'], 'string'],
            [['negative_balance', 'credit', 'active','online_payment','user_manage_subscription', 'option_allow_user_gift','use_credit_checked_default','tiller'], 'boolean'],
            [['name', 'siret', 'logo', 'photo', 'postcode', 'city', 'code','type','credit_functioning','option_behavior_cancel_order'], 'string', 'max' => 255],
            [['free_price', 'credit_limit_reminder','credit_limit'], 'double'],
            ['free_price', 'compare', 'compareValue' => 0, 'operator' => '>=', 'type' => 'number', 'message' => 'Prix libre doit être supérieur ou égal à 0'],
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels() 
    {
        return [
            'id' => 'ID',
            'name' => 'Nom',
            'siret' => 'Siret',
            'logo' => 'Logo',
            'photo' => 'Photo',
            'description' => 'Description',
            'postcode' => 'Code postal',
            'city' => 'Ville',
            'code' => 'Code',
            'order_deadline' => 'Heure limite de commande',
            'order_delay' => 'Délai de commande',
            'negative_balance' => 'Solde négatif',
            'credit' => 'Crédit pain',
            'active' => 'Actif',
            'date_creation' => 'Date de création',
            'order_infos' => 'Informations',
            'slug' => 'Slug',
            'type' => 'Type de producteur',
            'credit_limit_reminder' => 'Seuil de crédit limite avant relance',
            'online_payment' => 'Activer le paiement en ligne',
            'secret_key_payplug' => 'Clé secrète Payplug',
            'user_manage_subscription' => 'Autoriser les utilisateurs à gérer leurs abonnements',
            'mentions' => 'Mentions légales',
            'gcs' => 'Conditions générales de vente',
            'option_allow_user_gift' => 'Autoriser les utilisateurs à effectuer un don à la plateforme lors de leur commande',
            'credit_functioning' => 'Utilisation du Crédit par l\'utilisateur',
            'credit_limit' => 'Crédit limite',
            'use_credit_checked_default' => 'Cocher par défaut l\'option "Utiliser mon crédit" lors de la commande de l\'utilisateur',
            'background_color_logo' => 'Couleur de fond du logo',
            'option_behavior_cancel_order' => 'Comportement lors de la suppression d\'une commande',
            'tiller' => 'Tiller',
            'tiller_provider_token' => 'Token provider',
            'tiller_restaurant_token' => 'Token restaurant',
        ];
    }

    /*
     * Relations
     */
    
    public function getUserProducer() 
    {
        return $this->hasMany(
            UserProducer::className(), 
            ['id_producer' => 'id']
        );
    }

    public function getUser() 
    {
        return $this->hasMany(User::className(), ['id_producer' => 'id']);
    }
    
    public function getContact() 
    {
        return $this->hasMany(User::className(),['id_producer' => 'id'])
                ->where(['status' => User::STATUS_PRODUCER]);
    }
    
    /**
     * Retourne les options de base nécessaires à la fonction de recherche.
     * 
     * @return array
     */
    public static function defaultOptionsSearch() {
        return [
            'with' => [],
            'join_with' => [],
            'orderby' => 'name ASC',
            'attribute_id_producer' => 'id'
        ] ;
    }

    /**
     * Retourne la liste des établissements pour l'initialisation d'une liste
     * sélective.
     * 
     * @return array 
     */
    public static function getProducerPopulateDropdown() 
    {   
        $producers = Producer::find()
            ->where([
                'active' => true,
            ])
            ->orderBy('postcode, city ASC')
            ->all() ; 
                
        $departments = Departments::get();
        $dataProducers = [];
        $optionsProducers = [];
        foreach ($producers as $p) {
            if (!key_exists('d' . substr($p->postcode, 0, 2), $dataProducers)) {
                $dataProducers['d' . substr($p->postcode, 0, 2)] = '<strong>' . $departments[substr($p->postcode, 0, 2)] . '</strong>';
                $optionsProducers['d' . substr($p->postcode, 0, 2)] = ['disabled' => true];
            }

            $dataProducers[$p->id] = '<span class="glyphicon glyphicon-lock"></span> ' . Html::encode($p->name) . ' - ' . Html::encode($p->postcode) . ' ' . Html::encode($p->city) . ' <span class="glyphicon glyphicon-lock"></span>';

            if (strlen($p->code)) {
                $optionsProducers[$p->id] = ['class' => 'lock'];
            }
        }

        return ['data' => $dataProducers, 'options' => $optionsProducers];
    }

    /**
     * Retourne le CA de l'établissement pour un mois donné.
     * 
     * @param string $period
     * @param boolean $format
     * @return string
     */
    public function getTurnover($period = '', $format = false) 
    {
        if (!$period) {
            $period = date('Y-m');
        }
        
        $connection = Yii::$app->getDb();
        $command = $connection->createCommand('
            SELECT SUM(product_order.price * product_order.quantity) AS turnover
            FROM `order`, product_order, distribution, product
            WHERE `order`.id = product_order.id_order
            AND distribution.id_producer = :id_producer
            AND `order`.id_distribution = distribution.id
            AND product_order.id_product = product.id
            AND distribution.date > :date_begin
            AND distribution.date < :date_end', [
                    ':date_begin' => date('Y-m-31', strtotime("-1 month", strtotime($period))),
                    ':date_end' => date('Y-m-01', strtotime("+1 month", strtotime($period))),
                    ':id_producer' => $this->id
        ]);

        $result = $command->queryOne();
        $turnover = $result['turnover'];

        if ($format) {
            return number_format($turnover, 2) . ' €';
        }
        else {
            return $turnover;
        }
    }

    /**
     * Retourne le montant à facturer pour une période donnée.
     * 
     * @param string $periode
     * @param float $ca
     * @param boolean $format
     * @return string
     */
    public function getMAmountBilled($format = false) 
    {
        if ($format) {
            return number_format($this->free_price, 2) . ' €' ;
        } else {
            return $this->free_price ;
        }
    }

    /**
     * Retourne la facture d'une période donnée.
     * 
     * @param string $periode
     * @return Facture
     */
    public function getInvoice($period = '') 
    {
        if (!$period) {
            $period = date('Y-m', strtotime('-1 month'));
        }
            
        $invoice = Invoice::searchOne(
            ['id_producer' => $this->id, 'period' => ':period'],
            ['params' => [':period' => $period]]
        ) ;

        return $facture;
    }

    /**
     * Retourne la facture du mois dernier.
     * 
     * @return Facture
     */
    public function getInvoiceLastMonth() 
    {
        return $this->getInvoice(date('Y-m', strtotime('-1 month')));
    }

    /**
     * Retourne une configuration d'un établissement donné.
     * 
     * @param string $config
     * @param integer $id_etablissement
     * @return mixed
     */
    public static function getConfig($config = '', $idProducer = 0) 
    {
        if (strlen($config)) {
            if (!$idProducer) {
                $idProducer = Producer::getId() ;
            }
            
            $producer = self::findOne($idProducer);
            if ($producer) {
                return $producer->$config;
            }
        }

        return false;
    }

    /**
     * Retourne le montant de l'abonnement à prix libre définit par 
     * le producteur.
     * 
     * @param boolean $format
     * @return mixed
     */
    public function getFreePrice($format = true) 
    {
        if (!is_null($this->free_price)) {
            if($format) {
                return number_format($this->free_price, 2, ',', false) . ' € HT';
            }
            else {
                return $this->free_price;
            }
        }
    }
    
    /**
     * Lie un utilisateur à un producteur. 
     * 
     * @param integer $id_user
     * @param integer $id_producer
     * @return UserProducer
     */
    public static function addUser($idUser, $idProducer, $bookmark = 1) 
    {
        $userProducer = UserProducer::searchOne([
            'user_producer.id_user' => $idUser,
            'user_producer.id_producer' => $idProducer
        ]) ;

        if (!$userProducer) {
            $newUserProducer = new UserProducer;
            $newUserProducer->id_producer = $idProducer;
            $newUserProducer->id_user = $idUser;
            $newUserProducer->credit = 0;
            $newUserProducer->active = 1;
            $newUserProducer->bookmark = (int) $bookmark ;
            $newUserProducer->save();
        } else {
            if (!$userProducer->active) {
                $userProducer->active = 1;
                $userProducer->save();
            }
        }
        
        return $userProducer ;
    }
    
    /**
     * Retourne l'ID du producteur courant.
     * 
     * @return integer|boolean
     */
    public static function getId() 
    {   
        if(Yii::$app->controller->module->id == 'app-backend') {
            if(!Yii::$app->user->isGuest) {
                return Yii::$app->user->identity->id_producer ;
            }
        }
        else {
            return Yii::$app->controller->getProducer()->id ; ;
        }
        
        return false ;
    }
    
    /**
     * Retourne le producteur courant.
     * 
     * @return Producer|boolean
     */
    public static function getCurrent() 
    {
        if(self::getId()) {
            return self::searchOne() ;
        }
        
        return false ;
    }
    
    /**
     * Retourne la date la plus proche où il est possible de commander.
     * Attention, cette méthode ne garantit pas qu'une distribution a été initialisée
     * à cette date.
     * 
     * @return string
     */
    public function getEarliestDateOrder() 
    {
        $deadline = 20;
        $earliestDateOrder = date('Y-m-d');
        
        if($this->order_deadline) {
            $deadline = $this->order_deadline;
        }
        if (date('H') >= $deadline) {
            $earliestDateOrder = date('Y-m-d', strtotime(date('Y-m-d')) + ($this->order_delay) * (24 * 60 * 60));
        } else {
            $earliestDateOrder = date('Y-m-d', strtotime(date('Y-m-d')) + ($this->order_delay - 1) * (24 * 60 * 60));
        }
        
        return $earliestDateOrder ;
    }
    
    /**
     * Retourne le chemin vers le fichier contenant la clé secrète d'API de Payplug
     * 
     * @return string
     */
    public function getFilenameSecretKeyPayplug() 
    {
        return '../../common/config/payplug/'.$this->id.'.key' ;
    }
    
    /**
     * Enregistre la clé secrète d'API de Payplug dans un fichier
     */
    public function saveSecretKeyPayplug() 
    {
        if($this->online_payment) {
            $handle = fopen($this->getFilenameSecretKeyPayplug(),"w");
            fwrite($handle,$this->secret_key_payplug);
            fclose($handle);
        }
    }
    
    /**
     * Retourne la clé secrète d'API de Payplug.
     * 
     * @return string
     */
    public function getSecretKeyPayplug() 
    {
        if(file_exists($this->getFilenameSecretKeyPayplug())) {
            $handle = fopen($this->getFilenameSecretKeyPayplug(), "r") ;
            $filesize = filesize($this->getFilenameSecretKeyPayplug()) ;
            if($handle && $filesize) {
                $secretKey = fread($handle, $filesize);
                fclose($handle);
                return $secretKey ;
            }
        }
        
        return '' ;
    }
    
    /**
     * Retourne le compte producteur de démonstration.
     * 
     * @return Producer
     */
    public static function getDemoAccount() 
    {
        $producer = Producer::find()->where('name LIKE \'Démo\'')->one() ;
        return $producer ;
    }
    
    /**
     * Retourne true si le compte est un compte de démo.
     * 
     * @return boolean
     */
    public function isDemo() 
    {
        if(strpos($this->name, 'Démo') !== false) {
            return true ;
        }
        
        return false ;
    }
}