/class.xmodmonetique.inc

<?php
/**
 * \file     class.xmodmonetique.inc
 * \name     XModMonetique
 * \author   Vladimir Monari
 * \version  1.0
 * \date     1 Septembre 2013
 */

/**
 * \brief Classe MTransaction.
 * Classe représentant une transaction.
 * \version 1.0
 * \note 
 * - Pour Paybox et Atos une transaction en état WAITTING signifie que le serveur n'était pas disponible lors de l'appel.
 * - Pour SystemPay une transaction en état WAITTING signifie que le status en banque de la transaction ne permet pas cette action pour le moment. Elle devra donc être rejouée. Exemple: 
 * - Un remboursement ne peut être éfféctué que si la transaction à été remisé. Si le remboursement est intégral, on peut annuler la transaction, sinon il faudra attendre.
 */

/*************************************************************************
 * TEST MULTI WEB_PAYMENT :
 * - $order->options['nbDeadLine'] = 3;
 * - $order->options['frequencyDuplicate'] = 31;
 * - $order->options['captureDay'] = 10; ///< Spécifique à paybox (numéro du jour de prélèvement dans le mois)
 * - $order->options['captureDelay'] = 10;
 * - $order->options['noCapture'] = true; ///< Demande d'autorisation uniquement
 *
 * TEST D'ENROLLEMENT :
 * - $order->options['enrollement']= true;
 * - $order->options['refAbonnement'] = 'Atos Refus';
 ***************************************************************************/


class MTransaction{
  public $oid = null; ///< Identifiant de la transaction.
  public $orderOid = null; ///< Identifiant oid de la commande.
  public $orderReference = null; ///< Référence de la commande.
  public $customerOid = null; ///< Identifiant oid du client.
  public $customerEmail = null;	///< Email du client.
  public $dateCreated = null; ///< Date de création de la transaction.
  public $responseCode = null; ///< Code reponse de la banque.
  public $amount = null; ///< Float $amount : Montant de la transaction en euros.
  /** 
   * \brief Status de la transaction.
   * \details Peut-être valorisé à :
   * - XModMonetique::RUNNING.
   * - XModMonetique::WAITTING. 
   * - XModMonetique::SUCCESS. 
   * - XModMonetique::ERROR. 
   * - XModMonetique::INVALID.
   */
  public $status = null; 
  /** 
   * \brief Type de la transaction.
   * \details Peut-être valorisé à :
   * - XModMonetique::DUPLICATE.
   * - XModMonetique::WEB_PAYMENT. 
   * - XModMonetique::REFUND. 
   */
  public $type = null;
  public $dateTimeOut = null; ///< Date et heure d'envoi en banque des paramètres de la transaction.
  public $dateTimeIn = null; ///< Date et heure du retour banque de la transaction.
  public $transOri = null; ///< Lien vers la transaction d'origine (oid de la transaction d'origine). 
  public $shopMoid = null; ///< Identifiant du module de la boutique.
  public $shopClass = null;///< Classe de la boutique.
  public $shopName = null;///< Nom de la boutique.
  /** 
   * \brief  Mode de la notification boutique.
   * \details Peut-être valorisé à :
   * - \link XModMonetique::ASYNC_RESPONSE \endlink
   * - \link XModMonetique::SYNC_RESPONSE \endlink
   * - \link XModMonetique::RESPONSE_NONE \endlink
   */
  public $autoResponseMode = null;
  public $shopCallBack = null; ///< Fonction de la boutique permettant le traitement de la réponse.
  public $statusComplement = null;  ///< Complément de statut de la transaction. Donne des informations complémentaire sur l'état de la transaction.
  public $callParms = null; ///< Paramètres bruts transmis lors de l'appel en banque.
  public $responseParms = null;  ///< Réponse brute retournée par la banque.
  public $refAbonneBoutique = null; ///< Référence d'abonné attribué à un client lors d'une commande définissant un enrollement. 
  public $monetiqueMoid = null; ///< Identifiant du module de gestion des transaction utilisé pour celle-ci.
  public $nbReturn = null; ///< Nombre de retour banque (Utile à Paybox uniquement, maximum 3 trois retour pour un paiement web).
  /** 
   * \brief  Statut de la notification boutique.
   * \details Peut-être valorisé à :
   * - XModMonetique::RESPONSE_STATUS_SENT \endlink
   * - XModMonetique::RESPONSE_STATUS_TO_SEND \endlink
   * - XModMonetique::RESPONSE_STATUS_NOT_TO_SEND \endlink
   */
  public $responseStatus = null;
  public $transId = null; ///< Identifiant en bancaire de la transaction.
  public $modeTest = True; ///< Mode test par defaut.
  public $captureDelay = '0'; ///< Capture immédiate par défaut.
  /**
   *\brief Capture par défaut, sinon simple demande d'autorisation.
   * \details Peut-être valorisé à :
   * - \link XModMonetique::AUTHORIZATION_ONLY \endlink
   * - \link XModMonetique::CATCH_PAYMENT \endlink
   */
  public $captureMode = null; 
  public $frequencyDuplicate = null; ///< Capture immédiate par défaut.
  public $enrollement = False; ///< Pas d'enrollement par défaut
  public $nbDeadLine = 1; ///< Nombre d'échéances par défaut
}

/**
 * \brief Classe MOrderInfos.
 * Classe représentant une commande.
 * \version 1.0
 */
class MOrderInfos{
  public $oid = null; ///< Identifiant oid de la commande.
  public $reference = null; ///< Référence de la commande.
  public $amount = null; ///< Montant de la commande.
  /** 
   * \brief Contient les options éventuelles de la commande.
   * \details Doit être valorisé à :
   * - Pour un enrollement :
   *  - $order->options['enrollement']= true;
   *  - $order->options['refAbonnement'] = '<Référence de l'abonné>';
   * - Pour un paiement multiple :
   *  - $order->options['nbDeadLine'] = 3;
   *  - Facultatif:
   *   - $order->options['frequencyDuplicate'] = 31; Fréquence de prélevement en jours. Par défaut 30.
   *   - $order->options['captureDay'] = 10; Spécifique à paybox : Numéro du jour de prelevement dans le mois. Par défaut le 1.
   * - Pour modifier le délai de la capture :
   *   - $order->options['captureDelay'] = 10; Délais de capture réelle de la transaction en jours. Par défaut 0. 
   *  - Pour une demande d'autorisation seule :
   *   - $order->options['noCapture'] = true; ///< Demande d'autorisation uniquement
   */
  public $options = array();
  public $cardsType = array();
}

/**
 * \brief Classe MCustomerInfos.
 * Classe représentant un client.
 * \version 1.0
 */
class MCustomerInfos{
  public $oid = null;  ///< Identifiant oid du client.
  public $email = null; ///< Email du client.
}

/**
 * \brief Classe MShopInfos.
 * Classe contenant les paramètres de la boutique.
 * \version 1.0
 */
class MShopInfos{
  public $moid = null; ///< Identifiant du module de la boutique.
  public $class = null;///< Classe de la boutique.
  public $name = null;///< Nom de la boutique.
  public $autoResponseMode = null;///< Mode de reponse.
  public $autoResponseCallBack = null;///< Fonction de la boutique permettant le traitement de la réponse.
  public $cardsType =null; ///< Tableau des cartes voulue par la boutique
}

/**
 * \brief   Classe abstraite, base des modules "monetique/VAD".
 * \details Cette classe permet d'unifier les appels et retours des différents modules de paiements en ligne (ATOS/SIPS, SystemPay et Paybox).
 */

abstract class XModMonetique extends XModtable{
  // Options communes à tout (ou presque) les modules de paiements
  const CATCH_PAYMENT = 'capture';
  const AUTHORIZATION_ONLY = 'autorisation';

  // Constantes correspondant au type de transaction.
  const DUPLICATE = 'subscdebit'; ///< Prelèvement 'manuel' sur un abonné / enrollé.
  const WEB_PAYMENT = 'webpayment';    ///< Paiement de base par internet.
  const REFUND = 'refund';   ///< Remboursement.
  
  // Constantes pour la gestion du retour vers la boutique.
  const ASYNC_RESPONSE = 'async'; ///< Notifier la boutique en arrière plan. 
  const SYNC_RESPONSE = 'sync';   ///< Notifier la boutique dès le retour.
  const RESPONSE_NONE = 'none';   ///< Ne pas notifier la boutique.

  // Status de notification de la réponse vers la boutique.
  const RESPONSE_STATUS_SENT = 'sent';     ///< Boutique notifiée.
  const RESPONSE_STATUS_TO_SEND = 'tosend'; ///< Boutique à notifier.
  const RESPONSE_STATUS_NOT_TO_SEND = 'nottosend'; ///< Boutique à notifier.

  // Constantes correspondant à l'état d'une transaction
  const RUNNING = 'running';  ///< En cours de traitement (on attend le retour banque, qui ne viendra peut être jamais, si le client n'arrive pas au bout de la transaction).
  const WAITTING = 'waitting'; ///< Opération en attente (Soit le serveur ATOS n'est pas disponible, soit il faut attendre que la transaction est un status permettant l'opération en attente pour SystemPay.
  const SUCCESS = 'success';   ///< Opération réalisée avec succés, que ce soit un paiement web, un remboursement ou une duplication.
  const ERROR = 'error';    ///< Opération échoué, motifs exacte dans compelement de status (statusComplement) \link MTransaction::$statusComplement \endlink
  const INVALID = 'invalid';    ///< Correspond à une erreur de vérification de signature.
  
  /**
   * \brief Type de carte géré par le module XmodMonetique. 
   * \details Ce tableau est utilisable UNIQUEMENT avec SystemPay. Les autres modules de gestion, ne permette de préciser qu'un seul type de carte.
   * Pour utiliser ce tableau, il faut que la boutique est le même tableau avec les cartes qu'elle autorise à 'true'.
   */
  public $cardsType = array(
			    'AMEX' => false, 
			    'AURORE' => false,
			    'BUYSTER' => false,
			    'CB' => false, 
			    'COFINOGA' => false,
			    'MASTERCARD' => false, 
			    'JCB' => false,
			    'VISA' => false, 
			    'FINAREF' => false,
			    'FNAC' => false,
			    'CYRILLUS' => false,
			    'PRINTEMPS' => false,
			    'KANGOUROU' => false,
			    'SURCOUF' => false,
			    'POCKETCARD' => false,
			    'CONFORAMA' => false,
			    'NUITEA' => false,
			    'PASS' => false,
			    'PASS2' => false,
			    'PASS3FOIS' => false,
			    'CBPASS' => false,
			    'PEUGEOT' => false,
			    'ACCORD' => false,
			    'FRANFINANCE' => false,
			    '1EUROCOM' => false,
			    '4ETOILES' => false,
			    'COFIDIS_3X' => false,
			    'PROFILPLUS' => false,
			    'LIBRAVOU' => false,
			    'DINERS' => false,
			    'SOLO' => false,
			    'SWITCH' => false,
			    'DELTA' => false,
			    'BANCONTACTMISTERCASH'  => false,
			    'VISA_ELECTRON' => false,
			    'COF3XCB' => false,
			    'COF3XCB_SB' => false,
			    'MAESTRO' => false,
			    'E-CARTEBLEUE' => false,
			    'ONEY' => false,
			    'ONEY_SANDBOX' => false,
			    'PAYPAL' => false,
			    'PAYPAL_SB' => false,
			    'PAYSAFECARD' => false,	
			    'SOFINCO' => false,	   
			    'AVANTAGES' => false,
			    'CDGP' => false,
			    'RIVE GAUCHE' => false,
			    'WEXPAY' => false,
			    'KADEOS' => false,
			    'SVS' => false,
			    'LASER' => false,
			    'KWIXO' => false,
			    'LEETCHI' => false,
			    'MAXICHEQUE' => false,
			    'PAYBUTTON ING' => false,
			    'iDEAL' => false
			    );

  // Constante définissants le mode de capture
  public $siteId = null; ///< Identifiant du site marchand.
  public $urlPayed = null; ///< Url de redirection du client pour un paiement accepté.
  public $urlCancelled = null; ///< Url de redirection du client en cas d'annulation.
  public $urlRefused = null; ///< Url de redirection du client en cas d'erreur.
  public $urlAutoResponse = null; ///< Url de retour automatique serveur.
  public $lang  = "fr"; ///< Langue par defaut.
  public $defaultForeignLang = "en"; ///< Langue par defaut si pas de traduction disponible.
  public $defaultCurrencyCode = "978"; ///< La devise par défaut en l'euro.
  protected $defaultTemplate = null; ///< Template par defaut. 
  
  /// Constructeur standard d'un module console.
  function __construct($ar=NULL){
    parent::__construct($ar);
  }

  /* Fonctions de paiements boutique */

  /**
   * \brief Méthode de génération des données de paiement.
   * Cette fonction permet de générer les données d'un paiement et l'insert dans la table TRANSACMONETIQUE.
   * \param MOrderInfos $order :  Objet des données issues de la commande. 
   * \param MCustomerInfos $customer : Objet des données issues du client.
   * \param MShopInfos $shop : Objet comportant les paramètres de la boutique.
   * \note
   * - Gestion du paiement à multiple écheances. \link MOrderInfos::$options \endlink
   * - Mémorise le nombre de retour banque (Spécifique à Paybox, maximum 3).
   * - Gestion de l'enrollement. \link insertAbonne($donnees) \endlink, \link MOrderInfos::$options \endlink
   * \exception:  
   * - Error : \link webPaymentHandling(MOrderInfos $order, MCustomerInfos $customer, MShopInfos $shop, $transactionOid) \endlink.	
   * \return array :
   * - String ok/ko.
   * - Array $formulaireAppel : Contient le formulaire envoyé en banque
   * - String $template : Le template correspondant correspondant un module de traitement
   * - String $tplentry : L'entrée smarty du template.
   * - Sring $transaction->oid : L'oid de la transaction \link MTransaction::$oid \endlink
   * \note
   * - Vérifie que toutes les infos nécésaires sont bien présentes
   * - Paramètres la transaction, l'insère en base et récupère son oid.
   * - Délègue au module approprié la création du formaulaire.
   * - Mémorise les données brutes d'appel et le status.
   */
  public function paymentCall(MOrderInfos $order, MCustomerInfos $customer, MShopInfos $shop){
    // Vérifie que toutes les infos nécésaires sont bien présentes.
    $this->checkPaymentData($order, $customer, $shop);
    $transaction = new MTransaction();

    if(isset($shop->cardsType)){
      $transaction->cardsType = $shop->cardsType;
    }
    // Définition des paramètres de la transaction
    if($this->testMode(true)){
      $transaction->testMode = True;
    }else{
      $transaction->testMode = False;
    }
    $transaction->status = self::RUNNING;
    $transaction->type = self::WEB_PAYMENT;
    /* Vérification des paramètres de la commande */
    $transaction->orderOid = $order->oid;
    $transaction->orderReference = $order->reference;
    $transaction->amount = $order->amount;
    // Préparation des paiement à multiples échéances
    if (isset($order->options['nbDeadLine']) && $order->options['nbDeadLine']>1) { 
      $transaction->nbDeadLine = $order->options['nbDeadLine'];
      // Définition de la fréquence de prélèvement en jours
      if(empty($order->options['frequencyDuplicate'])){
	$transaction->frequencyDuplicate = '30';
      }else{
	$transaction->frequencyDuplicate = $order->options['frequencyDuplicate'];
      }
      // Par défaut le jour de prélèvement est la date courante
      if(!empty($order->options['captureDay'])){
	$transaction->captureDay = $order->options['captureDay'];
      }
      else{
	$transaction->captureDay =  date('d');
      }
    } else {
      // Paiement à une seule échéances par défaut
      $transaction->nbDeadLine = '1';
    }
    // Si la commande indique que la capture doit être différé
    if(isset($order->options['captureDelay'])){
      $transaction->captureDelay =  $order->options['captureDelay'];
    }else{
      $transaction->captureDelay =  '0';
    }
    // Gestion du mode de capture (Capture par défaut, sinon autorisation seulement)
    if( $order->options['noCapture'] == true){
      $transaction->captureMode =  self::AUTHORIZATION_ONLY;
    }
    else{
      $transaction->captureMode =  self::CATCH_PAYMENT;
    }
    // Vérification de l'option enrollement
    if (isset($order->options['refAbonnement']) && $order->options['enrollement'] == true) {
      $transaction->enrollement = true;
      $transaction->refAbonneBoutique = $order->options['refAbonnement'];
    }   
    $transaction->customerOid = $customer->oid;
    if(isset($customer->email)){
      $transaction->customerEmail = $customer->email;
    }
    if(isset($shop->class)){
      $transaction->shopClass = $shop->class;
    }
    // Paramètres de traitement de la réponse.
    $transaction->autoResponseMode = $shop->autoResponseMode;
    $transaction->shopCallBack = $shop->autoResponseCallBack;
    $transaction->shopName = $shop->name;
    $transaction->shopMoid = $shop->moid;
    $transaction->dateCreated = date('Y-m-d H:i:s');
    // champs plus spécifiques (pas communs à strictement toutes les vads)
    if (isset($order->options['specificsfields'])){
      if (isset($order->options['specificsfields']['transId'])){
	$transaction->transId = $order->options['specificsfields']['transId'];
      }
    }
    // Créer la transaction en base et récupère son oid pour les paramètres d'appel.
    $transaction->oid = $this->insertWebPayment($transaction);
    // Tentative de crétion du formulaire.
    try{
      // Appel au module concerné
      list($transaction, $formulaireAppel, $template, $tplentry) = $this->webPaymentHandling($transaction);
      $returnValue = array('ok', $formulaireAppel, $template, $tplentry, $transaction->oid);

    } catch(Exception $e){
      $transaction->status = self::ERROR;
      $transaction->statusComplement = $e->getMessage().' '.$e->getCode();
      XLogs::critical(get_class($this).' ::paymentCall ',XLabels::getSysLabel('xmodmonetique','exceptionPaymentCall').$transaction->statusComplement);
     
      $transactionParams = (array) $transaction;
      $transactionParams['_options'] = array('local'=>1);
      $transactionParams['options'] = array('callParms'=>array('raw'=>true,'toxml'=>true));
      $this->xset->procEdit($transactionParams);
      throw new Exception(get_class($this).' ::paymentCall : '.$transaction->statusComplement);
    }

    // Mémorisation de la date d'émission
    $transaction->dateTimeOut = date('Y-m-d H:i:s');
    // Gestion de l'enrollement.
    if (isset($order->options['refAbonnement']) && $order->options['enrollement'] == true) {
      $transaction->refAbonnement = $order->options['refAbonnement'];
      $this->insertAbonne($transaction); 
    }
    // Enregistrement des paramètres d'appel
    $transactionParams = (array) $transaction;
    $transactionParams['_options'] = array('local'=>1);
    $transactionParams['options'] = array('callParms'=>array('raw'=>true,'toxml'=>true));
    $this->xset->procEdit($transactionParams);
    return $returnValue;
  }

  /**
   * \brief Fonction de traitement du retour banque automatique.
   * Cette fonction permet de faire le traitement du retour banque en passant par le module approprié.
   * \exception:
   * - Transaction introuvable.
   * - Montant d'appel et de réponse incohérents.
   * - Nombre de retour Paybox supérieur à 3.
   * - Trop grand nombre de retour pour une transaction.
   * \todo 
   * - Exception si une transaction d'un module différent de paybox possède un statut différent de running. Ce cas se présente quand :
   *  - Une réponse à déjà été reçue.
   * \return boolean : True (Pour un succès) ou False ( Error : \link webPaymentUnFoldReponse() \endlink )
   * \note
   * - Traite la réponse avec le module approprié. \link webPaymentUnFoldReponse() \endlink. 
   * - Si l'oid de la transaction est introuvable, elle crée une nouvelle transaction pour mémoriser le paramètres reçus et lève une exception.
   * - Récupère les informations de la transaction d'origine. \link getTransaction($transactionOid) \endlink
   * - Lève une exception si une transaction d'un module différent de paybox possède un statut différent de running.
   * - Lève une exception si il y a une incohérence du montant, entre les paramètres d'appel et de réponse du serveur bancaire.
   * - Mémorise le retour.
   * - Gestion de l'enrollement. \link editAbonne($transaction) \endlink. 
   * - Recupère tous les champs de la transaction non renseigné dans la reponse.
   * - Si la signature est vérifié, gestion de la notification boutique.
   * \todo Voir l'équivalent de instanceof pour voir si une classe appartient à une classe mère (pour Paybox).
   */
  public function autoresponse() { 
    // Tentative de traitement de la réponse par le module approprié
    try{
      $transaction = $this->webPaymentUnFoldReponse();
      $ret = array(true, $transaction->oid);
    }catch(Exception $e){
      // Erreur de traitement de la réponse
      $transaction->status = self::ERROR;
      $transaction->statusComplement = 'Message : '.$e->getMessage().' Code : '.$e->getCode();
      $transactionParams = (array) $transaction;
      $transactionParams['_options'] = array('local'=>1);
      $transactionParams['options'] = array('callParms'=>array('raw'=>true,'toxml'=>true));
      $this->xset->procEdit($transactionParams);
      XLogs::critical(get_class($this).' ::autoresponse ' , $transaction->statusComplement);
      return false;
    }
    XLogs::critical(get_class($this).' ::autoresponse ', print_r($transaction, true));
    // Vérification de la réponse de la banque
    if($transaction->responseCode == '00'){
      $transaction->status = self::SUCCESS;
    }
    else{
      $transaction->status = self::ERROR;
    }
    // Si l'oid de la transaction n'a pas été trouvé par le module approprié, on crée une nouvelle transaction pour mémoriser le paramètres reçus.
    if ($transaction->oid == null){
      $transaction->statusComplement .= XLabels::getSysLabel('xmodmonetique','exceptionUnknowTransaction');
      $paramToMemorize = (array) $transaction;
      $paramToMemorize['options'] = array('responseParms'=>array('raw'=>true,'toxml'=>true));
      $r = $this->xset->procInput( (array) $paramToMemorize);
      XLogs::critical(get_class($this).' ::autoresponse '. XLabels::getSysLabel('xmodmonetique','exceptionUnknowTransaction'), print_r($transaction, true));
      // En cas de problème d'insertion de cette réponse, on log les paramètres reçus
      if (empty($r)) {
	XLogs::critical(get_class($this).' ::autoresponse : Problème d\'insertion de la transaction : ', print_r($transaction, true));
      }
      throw new Exception(get_class($this).' ::autoresponse :'.XLabels::getSysLabel('xmodmonetique','exceptionUnknowTransaction'));
    }
    // Si la transaction à été trouvée, on récupère les informations de la transaction d'origine
    $paramsOri = $this->getTransaction($transaction->oid);
    // Incrémentation du nombre de retour (3 maximum pour un paiement Web)
    if(empty($paramsOri->nbReturn)){
      $transaction->nbReturn = 1; ///< Premier retour 
    }else{
      $transaction->nbReturn++; ///< Retours suivants
    }
    // Si le nombres de retour Paybox est supérieur à 3 on lève une exception
    if ( (($transaction->nbReturn > 3) && ($transaction->nbDeadLine == 1) || ($transaction->nbReturn > $transaction->nbDeadLine+2 )  ) && ((get_class($this)=='XModPaybox') || ($this instanceof XModPaybox == 1)) ){ 
      XLogs::update('update', $transaction->oid, $this->array2html($transaction->responseParms, true));
      XLogs::critical(get_class($this)."::autoresponse ".XLabels::getSysLabel('xmodmonetique','overmuchResponse'), print_r($transaction, true));
      throw new Exception(get_class($this).' ::autoresponse '.XLabels::getSysLabel('xmodmonetique','overmuchResponse').$transaction->oid);
    }
    // Si une transaction d'un module différent de paybox possède un statut différent de running (C'est qu'une réponse à déjà été reçu, ou qu'elle comportait une erreur de paramètre), donc on lève une execption  
    if ( ( ($paramsOri->status != self::RUNNING) && ($paramsOri->nbDeadLine < $transaction->nbReturn))  && ((get_class($this)!='XModPaybox') &&  ($this instanceof XModPaybox != 1)) ) {
      $transaction->autoResponseMode = self::RESPONSE_NONE;
      $transaction->statusComplement = 'Erreur, trop de retour pour cette transaction on déjà été traité : '.$transaction->status.'/'.$transaction->statusComplement;
      // on garde la "reponse" dans les log de la transaction
      XLogs::update('update', $transaction->oid, print_r($transaction->responseParms, true));
      XLogs::critical(get_class($this).' ::autoresponse '.$transaction->statusComplement, print_r($transaction, true));
      throw new Exception('::autoresponse '.$transaction->statusComplement);
    }     

    XLogs::critical(get_class($this).' ::autoresponse->transaction(initialiser par unfold) ', print_r($transaction, true));
    XLogs::critical(get_class($this).' ::autoresponse params ori', print_r($paramsOri, true));

    // Paypal ne fournisant pas le montant total pour un paiement multiple, il faut recalculer le montant de l'échéance
    if($paramsOri->nbDeadLine > 1){
      if((get_class($this)=='XModPaypal') || ($this instanceof XModPaypal == 1)){
	$montant = $paramsOri->amount / $paramsOri->nbDeadLine; 
	$montant = round($montant , 2);
	// Calcule de la différence du aux arrondis
	$diff= $paramsOri->amount - ($montant* $paramsOri->nbDeadLine); 
	if( !empty($transaction->responseParms['mc_amount1']) && ($transaction->responseParms['mc_amount1']==$montant+$diff) && ($transaction->responseParms['mc_amount1']==$montant) ){
	  $transaction->amount= $paramsOri->amount;
	  XLogs::critical(get_class($this).' ::autoresponse ', 'Montants OK');
	}else{
	  list($firstDeadLine,$otherDeadLine) = $this->getAmountDeadLine($transaction->oid);
	  if(  $transaction->amount==$firstDeadLine || $transaction->amount==$otherDeadLine){
	    $transaction->amount= $paramsOri->amount;
	  }
	}
      }
    }
    // Vérification de la cohérence du montant, entre les paramètres d'appel et de réponse du serveur bancaire
    if (!$this->checkResponseAmount($transaction->amount, $paramsOri->amount)){
      $amountCall = XLabels::getSysLabel('xmodmonetique','amountCall').$paramsOri->amount;
      $amountResponse =XLabels::getSysLabel('xmodmonetique','amountResp').$transaction->amount ;
      $transaction->statusComplement = XLabels::getSysLabel('xmodmonetique','errorAmount').$amountCall.' : '.$amountResponse;
      $this->xset->procEdit(array('_options'=>array('local'=>1),
				  'oid'=> $transaction->oid,
				  'responseParms'=>$transaction->responseParms,
				  'status'=>self::ERROR,
				  'dateTimeIn'=>date('Y-m-d H:i:s'),
				  'statusComplement'=>$transaction->statusComplement,
				  'nbReturn'=>$transaction->nbReturn,
				  'responseStatus'=>'NA'
				  ));
      XLogs::critical(get_class($this)."::autoresponse ",  $transaction->statusComplement);
      throw new Exception(get_class($this).' ::autoresponse '.$transaction->statusComplement);
    }
    // Affectation du libellé du code erreur dans le statusComplement si il est vide
    if(empty( $transaction->statusComplement)){
      $transaction->statusComplement = $this->getErrorCode($transaction->responseCode);
    }
    // Mémorisation de la réponse
    $transaction->dateTimeIn = date('Y-m-d H:i:s');
    $infosToMemorize = (array) $transaction;
    $infosToMemorize['_options'] = array('local'=>1);
    $infosToMemorize['options'] = array('responseParms'=>array('raw'=>true,'toxml'=>true));
    $this->xset->procEdit($infosToMemorize);
    // Récupération des informations d'origine afin de traiter l'enrollement s'il y a lieu
    foreach ($paramsOri as $key => $value){
      // On vérifie que le champs est vide afin de ne pas écraser d'informations.
      if(empty($transaction->$key)){
	$transaction->$key = $value;
      }
    }
    // Si la transaction d'origine indique qu'il faut mettre à jour la table des enrollements
    if (!empty($transaction->refAbonneBoutique)){
      // Si la transaction est un echec on le mémorise également dans la table des enrollements
      if($transaction->status != self::SUCCESS){
	$transaction->porteur= XLabels::getSysLabel('xmodmonetique','enrollementError');
	$transaction->dateVal = XLabels::getSysLabel('xmodmonetique','enrollementError');
	$transaction->cvv = XLabels::getSysLabel('xmodmonetique','enrollementError'); 
	$transaction->numCarte = XLabels::getSysLabel('xmodmonetique','enrollementError');
      }
      // Mise à jour de l'enrollement
      $this->editAbonne($transaction); 
    }
    // Si nécessaire on notifie le retour à la boutique
    if ($transaction->autoResponseMode === self::SYNC_RESPONSE){
      $this->notifyShop($transaction);
    } 
    // Sinon on valorise le statut de réponse à : RESPONSE_STATUS_TO_SEND, afin qu'il soit traité de manière asynchrone
    elseif($transaction->autoResponseMode === self::ASYNC_RESPONSE){
      $this->xset->procEdit(array('_options'=>array('local'=>true), 'oid'=>$transaction->oid, 'responseStatus'=>self::RESPONSE_STATUS_TO_SEND));  
    }
    $GLOBALS['XSHELL']->response = (object)array('complete' => true, 'content' => '');
    return true;
  }
 
  /**
   * \brief Fonction d'insertion d'une transaction en base.
   * Cette fonction permet d'inserer une transaction avant l'appel en banque.
   * \param MTransaction $transaction : La transaction paramètré par paymentCall.
   * \return String Oid de la transaction associée à ce paiement.
   */
  protected function insertWebPayment(MTransaction $transaction){
    $transaction->monetiqueMoid = $this->_moid;
    $transaction->responseStatus = self::RESPONSE_NONE;
    $r = $this->xset->procInput( (array) $transaction);
    if (empty($r)) {
      XLogs::critical(get_class($this).XLabels::getSysLabel('xmodmonetique','errorInsertWebPayment'), print_r($transactionParams, true));
      ;
    }
    return $r['oid'];
  }

  /**
   * \brief Fonction de création d'un abonné.
   * Cette fonction permet d'inserer un nouvel abonné avant l'appel en banque.
   * \param MTransaction $transaction : La transaction contenant les paramètres d'enrollement :
   * - $transaction->customerOid. \link MTransaction::$customerOid \endlink
   * - $transaction->refAbonneBoutique.  \link MTransaction::$refAbonneBoutique \endlink
   * - $transaction->oid']. \link MTransaction::$oid \endlink
   * \note
   * - Récupère la table des abonnés.
   * - Prépare les paramètres à mémoriser.
   * - Insère les informations.
   * \return String Oid du nouvel enrollement.
   */
  protected function insertAbonne($transaction) {
    // Récupération de la table des abonnés
    $tableAbonne = XDataSource::objectFactoryHelper8('BCLASS=XDSTable&SPECS='.'ENROMONETIQUE');   
    // Préparation des paramètres à mémoriser
    $infosAbonne = array(
			 'customerOid' => $transaction->customerOid,
			 'refAbonne'=> $transaction->refAbonneBoutique,
			 'transOri' => $transaction->oid
			 );
    // Insertion des informations
    $r = $tableAbonne->procInput($infosAbonne);
    if (empty($r)) {
      XLogs::critical(get_class($this).XLabels::getSysLabel('xmodmonetique','errorInsertAbonne'), print_r($infosAbonne), true);
    }
    return $r['oid'];
  }
  
  /**
   * \brief Fonction de mise à jour d'un abonné.
   * Cette fonction permet de mettre à jour un abonné à la suite d'un retour banque.
   * \param MTransaction $transaction : La transaction donné par le retour banque.
   * - Doit contenir:
   *  - $transaction->customerOid. \link MTransaction::$customerOid \endlink
   *  - $transaction->refAbonneBoutique. \link MTransaction::$refAbonneBoutique \endlink
   * \note
   * - Récupère la table des abonnés.
   * - Vérifie que l'enrollement à été créé avant l'appel en banque.
   * - Prépare les paramètres à mémoriser
   * - Insère les informations.
   * \return String Oid du nouvel enrollement.
   */
  protected function editAbonne($transaction) {
    // Récupération de la table des abonnés
    $tableAbonne = XDataSource::objectFactoryHelper8('BCLASS=XDSTable&SPECS='.'ENROMONETIQUE');
    // On vérifie que l'enrollement à été créé avant l'appel bancaire
    $custEnro =  $this->getEnrollement($transaction->customerOid,$transaction->refAbonneBoutique);
    if(!empty($custEnro)){
      // Préparation des paramètres à mémoriser
      $lar = array('_options'=>array('local'=>1),
		   'oid'=>$custEnro->KOID,
		   'refAbonne'=>$transaction->refAbonneBoutique,
		   'customerOid'=> $transaction->customerOid,
		   'porteur'=>$transaction->porteur,
		   'dateVal'=>$transaction->dateVal,
		   'cvv'=>$transaction->cvv,
		   'numCarte'=>$transaction->numCarte,
		   );
      // Insertion des informations
      $r = $tableAbonne->procEdit($lar);
      if (empty($r)) {
	XLogs::critical(get_class($this).' ::editAbonne : '.XLabels::getSysLabel('xmodmonetique','errorUpdateAbonne'), print_r($lar), true);
      }
    }
    else{
      XLogs::critical(get_class($this).XLabels::getSysLabel('xmodmonetique','errorUnknowAbonne'), print_r($transaction), true);
    }    
    return $r['oid'];
  }

  /**********************************************************
   *************** Fonctions de remboursement ***************
   *********************************************************/

  /**
   * \brief Fonction création d'un remboursement.
   * Cette fonction permet de mettre à jour un abonné à la suite d'un retour banque.
   * \param String $transactionOriginOid : Identifiant de la transaction d'origine. \link MTransaction::$oid \endlink
   * \param MOrderInfos $order : Commande à l'origine du remboursement, avec le montant du remboursement.
   * - $order->amount est obligatoire.\link MOrderInfos::$amount \endlink
   * \param MShopInfos $shop : Comporte les paramètres de la boutique (autoResponseCallBack, autoResponseMode, ...).\link MShopInfos \endlink
   * \return Array :
   * - String ok/ko.
   * - String oid de la nouvelle transaction. \link MTransaction::$oid \endlink
   * \exception: 
   * - Error : \link refundHandling(& $transaction) \endlink.
   * - Impossible de trouver la transaction d'origine.
   * - Si $order->amount n'est pas initialisé. \link MOrderInfos::$amount \endlink
   * - Si la signature est invalide, levée par \link refundHandling(& $transaction) \endlink
   * \note
   * - Si $transactionOriginOid (\link MTransaction::$oid \endlink) est null, cherche la transaction à partir de l'order->reference (\link MTransaction::$reference \endlink).
   * - Vérification que le montant à rembourser à été saisi.
   * - Initialise les paramètres de base de la nouvelle transaction.
   * - Copie les informations manquantes à partir de la transaction d'origine.
   * - Crée la transaction en base. \link insertRefund ($transaction, $shop) \endlink. 
   * - Formate le montant passé en paramètres. \link formatOrderAmount($amount); \endlink
   * - Met à jour les attributs de $newTransaction. \link refundHandling(& $transaction) \endlink.
   * - Mémorise les données brutes de reponse et le status.
   * - Si la signature est vérifié, gestion de la notification boutique.
   * \see
   * - getIdTransactionWithOrderRef($orderReference);
   * - getTransaction ($transactionOid);
   * - refundHandling(& $transaction);
   * \todo Factoriser le contrôle du montant dans monétique
   */
  public function refundCall($transactionOriginOid, $order, $shop){
    // Recherche la transaction d'origine
    // Si l'on ne possède que l'order->reference, on cherche la transaction à partir de celui-ci
    if(!empty($order->reference) && empty($transactionOriginOid)){
      // Récupération de l'oid de la transaction d'origine
      $transactionOriginOid = $this->getIdTransactionWithOrderRef($order->reference); 
      // Récupération de toutres les infos relatives à cette transaction
      $transactionOrigin = $this->getTransaction($transactionOriginOid);
      // Mémorisation de l'oid d'origine
      $transactionOrigin->oid = $transactionOriginOid; 
    }
    // Sinon on cherche la transaction à partir de son oid
    else if(!empty($transactionOriginOid)){
      // Récupération de toutres les infos relatives à cette transaction
      $transactionOrigin = $this->getTransaction($transactionOriginOid);
      // Mémorisation de l'oid d'origine
      $transactionOrigin->oid = $transactionOriginOid; 
    }
    // Problème de paramètres, impossible de trouver la transaction d'origine
    if(empty($transactionOrigin->oid)){
      throw new Exception(get_class($this).' ::refundCall '.XLabels::getSysLabel('xmodmonetique','exceptionUnknowTransaction').' Order reference : '.$order->reference.' Transaction oid : '.$transactionOriginOid);
    }    
    // Vérification que le montant à rembourser à été saisi
    if(empty($order->amount)){
      throw new Exception(get_class($this).' ::refundCall :'.XLabels::getSysLabel('xmodmonetique','noAmount'));
    }    
    /* Initialisation des paramètres de base de la nouvelle transaction */
    // Mémorisation de la transaction d'origine
    $newTransaction->transOri = $transactionOrigin->oid;
    // Affectation de la date de création du remboursement
    $newTransaction->dateCreated =  date('Y-m-d H:i:s');
    // Affectation du montant à rembourser 
    $newTransaction->amount = $order->amount; 
    // Récupération de l'oid de la commande à remboursée
    $newTransaction->orderOid = $transactionOrigin->orderOid;
    // Génération de la référence de la commande de remboursement
    $newTransaction->orderReference = 'N/A'; //$this->genOrderRef('Y%m%d%H%i%s');
    // Le remboursement est immédiat
    $newTransaction->captureMode = self::CATCH_PAYMENT;
    // Le traitement est en cours
    $newTransaction->status = self::RUNNING;
    // Le type de transaction est un remboursement
    $newTransaction->type = self::REFUND;
    // Il n'y a pas de dalai, si c'est faisable, on le fait
    $newTransaction->captureDelay = 0;
    // Récupération de l'oid du client à remboursée
    $newTransaction->customerOid = $transactionOrigin->customerOid;
    // On regarde s'il y a des infos supplémentaires au sujet du client
    if(isset($transactionOrigin->refAbonneBoutique)){
      $newTransaction->refAbonneBoutique = $transactionOrigin->refAbonneBoutique;
    }
    if(isset($transactionOrigin->customerEmail)){
      $newTransaction->customerEmail = $transactionOrigin->customerEmail;
    }
    /* Paramètres de la boutique */
    // On mémorise dans la transaction le mode de réponse attendu par la boutique.
    $newTransaction->autoResponseMode = $shop->autoResponseMode;
    // On mémorise dans la transaction la fonction de traitement de la reponse attendu par la boutique.
    $newTransaction->shopCallBack = $shop->autoResponseCallBack;
    $newTransaction->monetiqueMoid = $this->_moid;
    $newTransaction->shopMoid = $shop->moid;
    $newTransaction->shopName = $shop->name;
    $newTransaction->shopClass = $shop->class;
    // Tant qu'on n'a pas de réponse on ne cherche pas à notifier la boutique
    $newTransaction->responseStatus = self::RESPONSE_NONE;
    // Créer la transaction en base. On a besoin de son oid pour les paramètres d'appel
    $newTransaction->oid = $this->insertRefund($newTransaction, $shop);
    // Traiter la requête
    try{
      // Cette méthode retourne la transaction après l'appel en banque
      $transaction = $this->refundHandling($newTransaction);
      $returnValue = array('ok', $newTransaction->oid);
    } 
    catch(Exception $e){
      XLogs::critical(get_class($this).'::refundCall ',print_r($newTransaction,true) );
      $newTransaction->status = self::ERROR;
      XLogs::critical(get_class($this), '::refundCall -> ::refundHandling '.$e->getMessage().' Code '.$e->getCode());
      $newTransaction->statusComplement = $e->getMessage();
      // Mémorise les données brutes de reponse et le status
      $this->xset->procEdit(array('_options'=>array('local'=>1),
				  'oid'=>$newTransaction->oid,
				  'responseParms'=>$newTransaction->responseParms,
				  'status'=> $newTransaction->status,
				  'dateTimeIn'=>date('Y-m-d H:i:s'),
				  'statusComplement'=> $newTransaction->statusComplement,
				  'responseCode'=>$newTransaction->responseCode,
				  'options'=>array('responseParms'=>array('raw'=>true,'toxml'=>true))
				  ));
      $returnValue = array('ko', $newTransaction->oid);
      throw new Exception(get_class($this).' ::refundCall : '.$newTransaction->statusComplement);
    }
    XLogs::critical(get_class($this).' ::refundCall', print_r($transaction,true));
    // Mémorise les données brutes de reponse et le status
    $this->xset->procEdit(array('_options'=>array('local'=>1),
				'oid'=>$transaction->oid,
				'responseParms'=>$transaction->responseParms,
				'status'=> $transaction->status,
				'dateTimeIn'=>date('Y-m-d H:i:s'),
				'statusComplement'=> $transaction->statusComplement,
				'responseCode'=>$transaction->responseCode,
				'options'=>array('responseParms'=>array('raw'=>true,'toxml'=>true))
				));
    // si nécessaire notifier le retour à la boutique
    if ($newTransaction->autoResponseMode === self::SYNC_RESPONSE){
      $this->notifyShop($newTransaction);
    } 
    // Sinon mise à jour pour traitement asynchrone
    elseif($newTransaction->autoResponseMode === self::ASYNC_RESPONSE){
      $this->xset->procEdit(array('_options'=>array('local'=>true), 
				  'oid'=>$newTransaction->oid, 
				  'responseStatus'=>self::RESPONSE_STATUS_TO_SEND
				  ));  
    }
    return $returnValue;
  }

  /**
   * \brief Fonction d'insertion d'un remboursement en base.
   * Cette fonction permet d'inserer une transaction avant l'appel en banque.
   * \param MTransaction $transaction : Contient les informations relatives au remboursement. \link MTransaction \endlink
   * \return String Oid de la transaction associée à ce remboursement.  \link MTransaction::$oid \endlink
   */
  protected function insertRefund($transaction, $shop){
    $r = $this->xset->procInput( (array) $transaction);
    if (empty($r)) {
      XLogs::critical(get_class($this).' ::insertRefund :'.XLabels::getSysLabel('xmodmonetique','noAmount'), print_r($infosToMemorize), true);
    }
    return $r['oid'];
  }

  /**
   * \brief Fonction de ré-émission des remboursements ayant le status waitting.
   * Cette fonction permet de rejouer les remboursement en attente.
   * \return Array :
   * - Int $nbTotal : Nombre total de transactions rejouée.
   * - Int $nbSucces : Nombre total de succès.
   * - Array $error : Le details des erreurs (statusComplement de chaque transaction échouée).
   * \throws: 
   * - Error : \link refundHandling(& $transaction) \endlink.
   * - Impossible de trouver la transaction d'origine.
   * \note
   * - Séléctionne des transaction à rejouer.
   * - Pour chaque transaction :
   *  - Formate le montant de la transaction en centimes.
   *  - Transforme les paramètres d'appels mémorisés en XML en tableau associatif.
   *  - Appel à la fonction refundReplay spécifique au module de la transaction.
   *  - Mémorise la réponse et les paramètres de la transaction.
   *  - Si la signature est vérifié, gestion de la notification boutique.
   * \see
   * - XModMonetique::refundReplay(& $transaction);
   */
  public function refundAsyncHandling(){
    // Séléction des transaction à rejouer
    $rs = selectQuery('select * from '.$this->xset->getTable().' where status = "'.self::WAITTING.'" and type = "'.self::REFUND.'" and monetiqueMoid =  "'.$this->_moid.'" ');
    // Initialisation des variables locales
    $nbTotal = $rs->rowcount();
    $nbSucces = '0';
    $error = array();
    // Tant qu'il y a des transactions à rejouer
    while($ors = $rs->fetch()){
      foreach ($ors as $key => $value){
	// Si c'est le montant on le formate en centimes et on le mémorise dans la transaction
	$transaction->$key = $value;
      }
      // On transforme les paramètres d'appels mémorisés en XML en tableau associatif
      $transaction->callParms = XSystem::xml2array($transaction->callParms);	
      // Appel à la fonction refundReplay spécifique au module de la transaction
      $transaction = $this->refundReplay($transaction);
      // Mémorise la réponse et les paramètres de la transaction
      $this->xset->procEdit(array(
				  '_options'=>array('local'=>1),
				  'oid'=>$transaction->KOID,
				  'responseParms'=>$transaction->responseParms,
				  'statusComplement'=> $transaction->statusComplement,
				  'status'=>$transaction->status,
				  'options'=>array('responseParms'=>array('raw'=>true,'toxml'=>true))
				  ));
      if($transaction->status == self::SUCCESS){
	$nbSucces++;
      }else{
	$error[$ors['KOID']][$transaction->status] = $transaction->statusComplement;
      }
      // si nécessaire notifier le retour à la boutique
      if ($ors->autoResponseMode === self::SYNC_RESPONSE){
	$this->notifyShop($ors->oid);
      } 
      elseif($ors->autoResponseMode === self::ASYNC_RESPONSE){
	$this->xset->procEdit(array('_options'=>array('local'=>true), 'oid'=>$ors->oid, 'responseStatus'=>self::RESPONSE_STATUS_TO_SEND));  
      }
    }
    return array($nbTotal, $nbSucces, $error);
  }

  /* Fonctions de débit forcé d'un abonné */
  
  /**
   * \brief Fonction de génération des données de prelevement.
   * Cette fonction permet de dupliquer un paiement à partir d'un paiement web ayant généré un enrollement.
   * \param MOrderInfos $order : Commande relative à la duplication, avec le montant de la duplication. 
   * - $order->amount est obligatoire.
   * \param MCustomerInfos $customer : Le client qui va être débité.
   * - $customer->oid et $customer->refAbonne sont obligatoire.
   * \param MShopInfos $shop : Comporte les paramètres de la boutique (autoResponseCallBack, autoResponseMode, ...).
   * \return MTransaction $transaction : La transaction après l'appel banque avec tous ses paramètres renseignés.
   * \exception:
   * - Error : \link refundHandling(& $transaction) \endlink
   * - Si $order->amount n'est pas initialisé. 
   * - Si \link XModMonetique::getEnrollement($customerOid,$refAbonne)  \endlink retourne null.
   * - Impossible de trouver la transaction d'origine.
   * \note
   * - Vérifie que le montant est saisi.
   * - Récupère les informations concernant l'abonné. \link getEnrollement($customerOid,$refAbonne); \endlink
   * - Initialise les paramètres de base de la nouvelle transaction.
   * - Formate le montant passé en paramètres. \link formatOrderAmount($amount); \endlink
   * - Récupère les informations de la transaction d'origine. \link getTransaction($transactionOid) \endlink
   * - Crée la transaction en base, avant l'appel en banque.  \link insertDuplicate($transaction); \endlink
   * - L'appel à \link marshallRemboursement(& $newTransaction); \endlink permet de laissé le traitement de la duplication au module concerné. Cette appel renseigne le retour dans $newTransaction.
   * - Mémorise les données brutes de reponse et le status.
   * - Si la signature est vérifié, gestion de la notification boutique.
   * \see
   * - getEnrollement($customerOid,$refAbonne);
   * - formatOrderAmount($amount);
   * - getTransaction ($transactionOid);
   * - refundHandling($transaction);
   */
  public function duplicateCall(MOrderInfos $order, MCustomerInfos $customer, MShopInfos $shop){
    // Vérification que le montant est saisi
    if(empty($order->amount)){
      throw new Exception(get_class($this).' ::duplicateCall :'.XLabels::getSysLabel('xmodmonetique','noAmount'));
    }
    // Récupération des informations concernant l'abonné
    $customerEnrollment = $this->getEnrollement($customer->oid, $customer->refAbonne);
    // Si l'abonné existe dans ENROMONETIQUE
    if (!empty($customerEnrollment)){
      $newTransaction = new MTransaction();
      // Préparation des paiement à multiples échéances
      if (isset($order->options['nbDeadLine'])) { 
	$newTransaction->nbDeadLine = $order->options['nbDeadLine'];
	// Définition de la fréquence de prélèvement en jours
	if(empty($order->options['frequencyDuplicate'])){
	  $newTransaction->frequencyDuplicate = '30';
	}else{
	  $newTransaction->frequencyDuplicate = $order->options['frequencyDuplicate'];
	}
	// Par défaut le jour de prélévement est la date courante
	if(!empty($order->options['captureDay'])){
	  $newTransaction->captureDay = $order->options['captureDay'];
	}
	else{
	  $newTransaction->captureDay =  date('d');
	}
      }
      // Paiement à une seule échéances par défaut
      else {
	$newTransaction->nbDeadLine = '1';
      }
      // Si la commande indique que la capture doit être différé
      if(isset($order->options['captureDelay'])){
	$newTransaction->captureDelay =  $order->options['captureDelay'];
      }else{
	$newTransaction->captureDelay =  '0';
      }
      // Gestion du mode de capture (Capture par défaut, sinon autorisation seulement)
      if( $order->options['noCapture'] == true){
	$newTransaction->captureMode =  self::AUTHORIZATION_ONLY;
      }
      else{
	$newTransaction->captureMode =  self::CATCH_PAYMENT;
      }
      // Affectation du type de transaction : DEBIT
      $newTransaction->type = self::DUPLICATE; 
      // Mémorisation de la transaction d'origine
      $newTransaction->transOri =$customerEnrollment->transOri;
      // Mémorisation de la référence abonné 
      $newTransaction->refAbonneBoutique =$customerEnrollment->refAbonne; 
      // Mémorisation du cvv
      $newTransaction->cvv =$customerEnrollment->cvv; 
      // Mémorisation du porteur
      $newTransaction->porteur =$customerEnrollment->porteur; 
      // Mémorisation de la date de validitée de la carte
      $newTransaction->dateVal =$customerEnrollment->dateVal;
      // Affectation du montant à rembourser
      $newTransaction->amount =$order->amount; 
      // Définition du status
      $newTransaction->status = self::RUNNING; 
      // Pas de notification tant qu'il n'y a pas de reponse
      $newTransaction->responseStatus = self::RESPONSE_NONE; 
      // Récupération de la référence
      $newTransaction->orderReference = $order->reference;
      // Récupération de l'oid de la commande
      $newTransaction->orderOid = $order->oid; 
      // Si la boutique fournis le mode de réponse attendu. Sinon on utilisera le même mode que la transaction d'origine.
      if(isset($shop->autoResponseMode)){
	$newTransaction->autoResponseMode = $shop->autoResponseMode;
      }
      // Si la boutique fournis la fonction de traitement de la reponse. Sinon on utilisera la même fonction que la transaction d'origine.
      if(isset($shop->autoResponseCallBack)){
	$newTransaction->shopCallBack = $shop->autoResponseCallBack;
      }
      $newTransaction->monetiqueMoid = $this->_moid;
      $newTransaction->shopMoid = $shop->moid;
      $newTransaction->shopName = $shop->name;
      $newTransaction->shopClass = $shop->class;
      $newTransaction->dateCreated = date('Y-m-d H:i:s');
      // Récupération de la transaction d'origine
      $transactionOrigin = $this->getTransaction($customerEnrollment->transOri);
      // Si la transaction d'origine à n'a pas été trouvée, on lève une exception.
      if(empty($transactionOrigin)){
	XLogs::critical(get_class($this).' ::duplicateCall '.XLabels::getSysLabel('xmodmonetique','exceptionUnknowTransaction'), print_r($customerEnrollment, true)) ;
	throw new Exception(get_class($this).' ::duplicateCall '.XLabels::getSysLabel('xmodmonetique','exceptionUnknowTransaction'));
      }
      // Récupération des informations concernant le client
      if(isset($transactionOrigin->customerOid)){
	$newTransaction->customerOid = $transactionOrigin->customerOid;
      }
      if(isset($transactionOrigin->customerEmail)){
	$newTransaction->customerEmail = $transactionOrigin->customerEmail;
      }
      // Créer la transaction en base. On a besoin de son oid pour les paramètres d'appel
      $newTransaction->oid = $this->insertDuplicate($newTransaction);
      // Traiter la requète
      try{ 
	// Cette méthode retoutne la transaction après l'appel banque.
	$transaction = $this->duplicateHandling($newTransaction);
	$returnValue = $transaction;
      } catch(Exception $e){
	$newTransaction->statusComplement = $e->getMessage().' '.$e->getCode();
	$newTransaction->status = self::ERROR;
	XLogs::critical(get_class($this).' ::duplicateCall : '.XLabels::getSysLabel('xmodmonetique','exceptionDuplicateCall'), print_r($newTransaction, true));
	throw new Exception('::duplicateCall :'.XLabels::getSysLabel('xmodmonetique','exceptionDuplicateCall').$newTransaction->statusComplement);
      }
      // On mémorise les données brutes et le status
      $this->xset->procEdit(array(
				  '_options'=>array('local'=>1),
				  'oid'=>$transaction->oid,
				  'responseParms'=>$transaction->responseParms,
				  'status'=> $transaction->status,
				  'dateTimeIn'=>date('Y-m-d H:i:s'),
				  'statusComplement'=> $transaction->statusComplement,
				  'responseCode'=>$transaction->responseCode,
				  'options'=>array('responseParms'=>array('raw'=>true,'toxml'=>true))
				  ));
      // si nécessaire notifier le retour à la boutique
      if ($newTransaction->autoResponseMode === self::SYNC_RESPONSE){
	$this->notifyShop($newTransaction);
      } elseif($newTransaction->autoResponseMode === self::ASYNC_RESPONSE){
	$this->xset->procEdit(array('_options'=>array('local'=>true), 'oid'=>$transaction->oid, 'responseStatus'=>self::RESPONSE_STATUS_TO_SEND));  
      }
      return $returnValue;
    }
    // Si l'enrollement est introuvable
    else{
      XLogs::critical(get_class($this), '::duplicateCall erreur : Customer enrollemnt introuvable.');
      throw new Exception('::duplicateCall erreur : Customer enrollemnt introuvable.');
    }
  }

  /**
   * \brief Fonction d'insertion d'une duplication en base.
   * Cette fonction permet d'inserer une duplication avant l'appel en banque.
   * \param MTransaction $transaction : Contient les informations relatives au remboursement.
   * \return String Oid de la transaction associée à cette duplication.
   */   
  protected function insertDuplicate($transaction){
    $r = $this->xset->procInput((array) $transaction);
    if (empty($r)) {
      XLogs::critical(get_class($this), 'Problème d\'insertion de la transaction');
      XLogs::critical(get_class($this), print_r($lar), true);
    }
    return $r['oid'];
  }

  /**
   * \brief Fonction de ré-émission des duplications ayant le status waitting.
   * Cette fonction permet de rejouer les duplications en attente.
   * \return Array :
   * - Int $nbTotal : Nombre total de transactions rejouée.
   * - Int $nbSucces : Nombre total de succès.
   * - Array $error : Le details des erreurs (statusComplement de chaque transaction échouée).
   * \exception: 
   * - Error : \link refundHandling(& $transaction) \endlink.
   * - Impossible de trouver la transaction d'origine.
   * \note
   * - Séléctionne des transaction à rejouer.
   * - Pour chaque transaction :
   *  - Formate le montant de la transaction en centimes.
   *  - Transforme les paramètres d'appels mémorisés en XML en tableau associatif.
   *  - Appel à la fonction refundReplay spécifique au module de la transaction.
   *  - Mémorise la réponse et les paramètres de la transaction.
   *  - Si la signature est vérifié, gestion de la notification boutique.
   * \see
   * - duplicateReplay(& $transaction);
   */
  public function duplicateAsyncHandling(){
    $rs = selectQuery('select * from '.$this->xset->getTable().' where status = "'.self::WAITTING.'" and type = "'.self::DUPLICATE.'"');
    $nbTotal = $rs->rowcount();
    $nbSucces = 0;
    $error = array();
    while ($ors = $rs->fetch()) {
      foreach ($ors as $key => $value){
	$transaction->$key = $value;
      }
      // On transforme les paramètres d'appels mémorisés en XML en tableau associatif     
      $transaction->callParms = XSystem::xml2array($transaction->callParms);	
      // Appel à la fonction duplicateReplay spécifique au module de la transaction 
      $transaction = $this->duplicateReplay($transaction);
      // On mémorise le retour
      $this->xset->procEdit(array(
				  '_options'=>array('local'=>1),
				  'oid'=>$transaction->KOID,
				  'responseParms'=>$transaction->responseParms,
				  'statusComplement'=> $transaction->statusComplement,
				  'status'=>$transaction->status,
				  'options'=>array('responseParms'=>array('raw'=>true,'toxml'=>true))
				  ));
      if($transaction->status == self::SUCCESS){
	$nbSucces++;
      }
      else{
	$error[$ors['KOID']][$transaction->status] = $transaction->statusComplement;
      }
      // On vérifie s'il faut notifier la boutique
      if ($ors->autoResponseMode === self::SYNC_RESPONSE){
	$this->notifyShop($ors->oid);
      } 
      elseif($ors->autoResponseMode === self::ASYNC_RESPONSE){
	$this->xset->procEdit(array('_options'=>array('local'=>true), 'oid'=>$ors->oid, 'responseStatus'=>self::RESPONSE_STATUS_TO_SEND));  
      }
    }
    return array($nbTotal, $nbSucces, $error);
  }

  /* Fonctions de notifications boutique */

  /**
   * \brief Fonction de notification de la boutique.
   * Cette fonction permet de notifier la boutique au sujet du paiement d'une commande.
   * \param MTransaction $transaction : Transaction à partir de laquelle la boutique sera notifiée.
   * Il faut au minimum :
   * - $transaction->shopMoid ou $transaction->shopClass. \link MTransaction::$shopMoid \endlink \link MTransaction::$shopClass \endlink
   * - $transaction->orderOid. \link MTransaction::$orderOid \endlink 
   * - $transaction->shopCallBack.  \link MTransaction::$shopCallBack \endlink 
   * - $transaction->oid. \link MTransaction::$oid \endlink 
   * \note
   * - Vérifie que la transaction est initialisée.
   * - Si la transaction connait le moid de la boutique, cette fonction pourra la notifier.
   */
  protected function notifyShop($transaction){
    // On vérifie que la transaction est initialisée
    if ($transaction == null){
      Xlogs::critical(get_class($this), '::notifyShop notif module : transaction null');
    }
    // Si la transaction connait le moid de la boutique elle pourra la notifier
    if (!empty($transaction->shopMoid)){
      Xlogs::notice(get_class($this), '::notifyShop notif module : '.$transaction->shopMoid.'function '.$transaction->shopCallBack.', order '.$transaction->orderOid);
      $mod = XModule::objectFactory(array('moid'=>$transaction->shopMoid, 'interactive'=>0, 'tplentry'=>TZR_RETURN_DATA));
      $f = $transaction->shopCallBack;
      $mod->$f($transaction->orderOid, $transaction);
    } elseif (!empty($transaction->shopClass)){
      Xlogs::notice(get_class($this), '::notifyShop notif classe : '.$transaction->shopClass.'function '.$transaction->shopCallBack.', order '.$transaction->orderOid);
      $c = new $transaction->shopClass();
      $f = $transaction->shopCallBack;
      $c->$f($transaction->orderOid, $transaction);
    }
    // Mise à jour du status de reponse à la boutique
    $this->xset->procEdit(array('_options'=>array('local'=>true), 'oid'=>$transaction->oid, 'responseStatus'=>self::RESPONSE_STATUS_SENT));
  }
 
  /**
   * \brief Fonction de notification en asynchone des retours de paiement.
   * Cette fonction permet de notifier la boutique de manière asynchrone au sujet du paiement d'une commande.
   * \note
   * - Séléctionne toute les transaction ayant un status différent de ( \link XModMonetique::ERROR \endlink ou  \link XModMonetique::INVALID \endlink) et un autoResponseMode =  \link XModMonetique::ASYNC_RESPONSE \endlink et un responseStatus =  \link XModMonetique::RESPONSE_STATUS_TO_SEND \endlink .
   * - Pour chaque transaction :
   *  - Appel à \link notifyShop($transaction) \endlink
   */
  public function notifyShopAsync(){
    $rs = selectQuery('select KOID from '.$this->xset->getTable().' where (status != "'.self::ERROR.'" or status != "'.self::INVALID.'" ) and autoResponseMode="'.self::ASYNC_RESPONSE.'" and responseStatus="'.self::RESPONSE_STATUS_TO_SEND.'"');   
    while($ors = $rs->fetch()){
      $transaction = $this->getTransaction($ors['KOID']);
      $transaction->oid = $ors['KOID'];
      $this->notifyShop($transaction);
    }
  }

  /* Fonctions utilitaires */
  
  /**
   * \brief Fonction de controle des paramètres attendus pour le paiement d'une commande.
   * Cette fonction permet de controler :
   * - $order->oid : L'oid de la commande correspondant à la transaction. \link MOrderInfos::oid \endlink
   * - $order->amount : Le montant de la commande. \link MOrderInfos::amount \endlink
   * - $shop->moid ou $shop->class : La boutique à l'origine de la commande. \link MShopInfos::moid \endlink \link MShopInfos::class  \endlink
   * - $order->reference : La référence de la commande. \link MOrderInfos::reference \endlink
   * - $shop->autoResponseMode : Le mode de reponse doit être cohérent avec les paramètres attendus. \link MShopInfos::autoResponseMode \endlink
   * \exception:
   * - Si l'un de tous ces champs n'est pas correctement initialisé.
   */
  protected function checkPaymentData(MOrderInfos $order, MCustomerInfos $customer, MShopInfos $shop){
    if (empty($order->oid)){
      throw new Exception('order oid is not set',01);
    }
    if (empty($order->amount)){
      throw new Exception('order amount is not set',02);
    }
    if (empty($shop->moid) && empty($shop->class)){
      throw new Exception('must provide shopMoid or shop class',03);
    }
    if (empty($order->reference)){
      throw new Exception('must provide order reference',04);
    }
    if (!in_array($shop->autoResponseMode, array(self::RESPONSE_NONE, self::ASYNC_RESPONSE, self::SYNC_RESPONSE))){
      throw new Exception('must provide options auo response (none|async|live)',05);
    }
  }

  /**
   * \brief Fonction de chargement d'une transaction depuis la table grace à son KOID.
   * Cette fonction permet de récupérer tous les paramètres d'une transaction depuis la table.
   * \param String $transactionOid : L'identifiant d'une transaction. \link MTransaction::$oid \endlink
   * \return MTransaction $transaction.
   * \see
   * MTransaction.
   */
  protected function getTransaction($transactionOid){
    if ($ors == NULL){
      $rs = selectQuery('select * from '.$this->xset->getTable().' where KOID="'.$transactionOid.'"');
    }
    if ($rs->rowcount() == 1){
      $ors = $rs->fetch();
      $transaction  = new MTransaction();
      foreach($ors as $k=>$v){
	$transaction->{$k} = $v;
      }
    } else {
      $transaction = null;
      XLogs::critical(get_class($this), 'Impossible de trouver la transaction ayant pour KOID : '.$transactionOid);
    }
    return $transaction;
  }

  /**
   * \brief Fonction de recherche du KOID d'une transaction depuis la table grâce à la référence commande.
   * Cette fonction permet de récupérer le KOID d'une transaction depuis la table du module.
   * \param String $orderReference : La référence d'une commande. \link MTransaction::$orderReference \endlink
   * \return String $transactionOid : \link MTransaction::$oid \endlink
   * \see
   * MTransaction.
   */
  protected function getIdTransactionWithOrderRef($orderReference){
    $rs = selectQuery('select KOID from '.$this->xset->getTable().' where `orderReference`="'.$orderReference.'"'); 
    $transactionOid = null;
    if($rs->rowCount()==1){
      $transactionOid  = $rs->fetch(PDO::FETCH_COLUMN);
    }
    else{
      XLogs::critical(get_class($this), 'Transaction de la commande '.$orderReference.' non trouvé!');
    }
    return $transactionOid;
  }

  /**
   * \brief Fonction de recherche du type de capture d'une transaction.
   * Cette fonction permet de récupérer le captureMode d'une transaction depuis la table du module.
   * \param MTransaction $transaction : La transaction pour laquelle on veut connaitre le captureMode. \link MTransaction::$captureMode \endlink
   * \return String $captureMode.
   * \see
   * MTransaction.
   */
  protected function getCaptureMode($transaction){
    $rs = selectQuery('select captureMode from '.$this->xset->getTable().' where `KOID`="'.$transaction->oid.'"'); 
    $res = null;
    if($rs->rowCount()==1){
      $res  = $rs->fetch(PDO::FETCH_COLUMN);
    }
    else{
      XLogs::critical(get_class($this), 'Transaction ayant pour KOID '.$transaction->oid.' non trouvé!');
    }
    return $res;
  }

  /**
   * \brief Fonction de recherche du nombre d'échéances d'une transaction.
   * Cette fonction permet de récupérer le nombre d'échéances d'une transaction depuis la table du module.
   * \param MTransaction $transaction : La transaction pour laquelle on veut connaitre le nombre d'échéances. \link MTransaction::$nbDeadLine \endlink
   * \return Int $nbDeadLine.
   * \see
   * MTransaction.
   */
  protected function getNbDeadLine($transaction){
    $rs = selectQuery('select nbDeadLine from '.$this->xset->getTable().' where `KOID`="'.$transaction->oid.'"'); 
    $res = null;
    if($rs->rowCount()==1){
      $res  = $rs->fetch(PDO::FETCH_COLUMN);
    }
    else{
      XLogs::critical(get_class($this), 'Transaction ayant pour KOID '.$transaction->oid.' non trouvé!');
    }
    return $res;
  }

  /**
   * \brief Fonction de chargement d'une transaction depuis la table grace à la référence commande.
   * Cette fonction permet de récupérer tous les paramètres d'une transaction depuis la table.
   * \param String $orderReference : La référence d'une commande. \link MTransaction::$orderReference \endlink
   * \return MTransaction $transaction.
   * \see
   * MTransaction.
   */
  protected function getTransactionWithOrderRef($orderReference){
    $rs = selectQuery('select * from '.$this->xset->getTable().' where `orderReference`="'.$orderReference.'"'); 
    $transactionOid = null;
    if($rs->rowCount()==1){
      $transaction  = $rs->fetch();
    }
    else{
      XLogs::critical(get_class($this), 'Transaction de la commande '.$orderReference.' non trouvé!');
    }
    return $transaction;
  }


  /**
   * \brief Fonction de recherche d'un enrollement dans la table ENROMONETIQUE.
   * Cette fonction permet de récupérer tous les paramètres d'un enrollement.
   * \param String $customerOid : L'identifiant d'un client. \link MCustomerInfos::$oid \endlink
   * \param String $refAbonne : La référence abonné d'un client. \link MCustomerInfos::$refAbonne \endlink
   * \return $customerEnrollement : Les paramètres nécéssaires au remboursement ou à la duplication d'une transaction.
   */
  protected function getEnrollement($customerOid,$refAbonne){
    $rs = selectQuery('select * from ENROMONETIQUE where `customerOid`="'.$customerOid.'" and `refAbonne`="'.$refAbonne.'"' );
    if($rs->rowCount()==1){
      $ors  = $rs->fetch();
      foreach($ors as $k=>$v){
	$customerEnrollement->{$k} = $v;
      }   
    } else {
      $customerEnrollement = null;
      XLogs::critical(get_class($this), 'Impossible de trouver l\'enrollement ayant pour customerOid :'.$customerOid);
    }
    return $customerEnrollement;
  }


  public function genOrderRef($format, $vars = null){
 
    $ressource = 'refCommande';
    while(!getLock($ressource, 10)){
      XLogs::notice(get_class($this), 'waiting for lock '.$ressource);
    }
    $key = 'xmodmonetique::hourlychrono';
    $hour = date('H');
    $date = date('Y-m-d');
    $vchrono=XDbIni::get($key, 'val');
    if($vchrono == NULL){
      $init = true;
    }
    list($ldate, $lhour, $chrono) = explode(',', $vchrono);
    if ($lhour != $hour || $ldate != $date){
      $init = true;
    }
    if ($init){
      $day = date('d');
      $year = date('Y');
      $month = date('m');
      $ors = selectQueryGetAll('select ifnull(max(substring(orderReference, -4)), 0) as lchrono from TRANSACMONETIQUE where year(dateCreated)='.$year.' and month(dateCreated)='.$month.' and day(dateCreated)='.$day.' and hour(dateCreated)='.$hour);
      if (!$ors || !is_array($ors)){
	XLogs::critical(get_class($this), '::genOrderRef erreur lecture dernier chrono');
	$chrono = 0;
      } else {
	$chrono = $ors[0]['lchrono'];
      }
    }
    $chrono += 1;
    XDBIni::set($key, $date.','.$hour.','.$chrono);
    $refbase = strftime($format, strtotime(date('Y-m-d H:i:s')));
    if (!empty($vars)){
      $refbase = str_replace($vars[0], $vars[1], $refbase);
    }
    releaseLock($ressource);
    return $refbase.sprintf('%04d', $chrono);
  }
  
  /**
   * \brief Fonction de génération d'un idantifiant de transaction unique pour la journée.
   * Cette fonction utilise \b checkPidFiles() pour assurer un accès unique à la ressource.
   * \return String $newTransId : l'identifiant une d'une transaction (6 charactères).
   */
  protected function genTransId(){
    $ressource = TZR_VAR2_DIR.'/transId';
    // Fonction limitant l'accès à une personne en même temps, et n'accordant qu'une tentative
    $r = checkPidFiles($ressource, 1, 1) ;
    // Si une commande est en cours de traitement, on génère un id maximal
    if($r == 'unavailable'){
      $newTransId = $this->getMaxDayTransId();
    }
    // Sinon on génère un id habituel
    else{
      $newTransId = date('His');
    }
    return $newTransId;
  } 

  /**
   * \brief Fonction qui retourne le nouvel identifiant de transaction la plus haut du jour courant pour une transaction en collision (2 commandes en même temps).
   * Cette fonction recherche dans la table des transactions, l'identifiant de transaction le plus haut (avec une heure supérieur à 24), ce cas ce produit quand deux génération d'identifiant de transaction s'execute au même moment. La première aura comme identifiant le vrai jour et la seconde 24. Si ce cas se reproduit la même journée, la seconde sera incrémentee à partir de la plus haute, soit 24 et aura donc 25 comme value pour l'heure.
   * \return String $newTransId : Le nouvel identifiant de transaction déjà incrémenté.
   */
  protected function getMaxDayTransId(){
    // Récupère la date courante
    $date = date('Ymd');
    // Selectionne la transaction (ayant subis une collision) et ayant la référence la plus haute
    $rs = selectQuery('select transId from '.$this->xset->getTable().' where `transId` >=  "'.$date.'500000" order by orderReference desc limit 1')->fetch();
    // Si ce n'est pas la première collision de la journée
    if(!empty($rs)){
      // On extrait la value remplaçant le jour par sa value incrémentée
      $incremente = substr($rs['transId'], 8,2);
      $incremente++;
      // On retourne la nouvelle référence
      return $newTransId = $incremente.date('is');
    }
    // Si c'est la première collision de la journée
    else{
      $newTransId = '24'.date('is');
    }
    return $newTransId;
  }  

  /**
   * \brief Fonction retourne un motant en euros passé en paramètre, en centimes.
   * \param Float $amount : Un montant en euros.
   * \return Int $amount*100 : Le montant en centimes.
   */
  protected function formatOrderAmount($amount){
    return $amount*100;
  }

  /**
   * \brief Fonction retourne un motant en euros passé en paramètre, en centimes.
   * \param String $amount: Un montant en centimes.
   * \param MTransaction $transaction: Une transaction dont $transaction->amount est en euros.
   * \return Bool $test : Renvoi True si le montant est le même, False sinon.
   */
  protected function checkResponseAmount($amountResponse, $amountOri){
    return ($amountResponse == $amountOri);
  }

  /**
   * \brief Fonction retourne un motant en euros passé en paramètre, en centimes.
   * \param String $amount: Un montant en centimes.
   * \param MTransaction $transaction: Une transaction dont $transaction->amount est en euros.
   * \return Bool $test : Renvoi True si le montant est le même, False sinon.
   */
  protected function checkNbDeadLine($nbDeadLineResponse, $nbDeadLineOri){
    return ($nbDeadLineResponse == $nbDeadLineOri);
  }

  /*
   * codification des langues pour l'interface de banque
   * par defaut = celle reçue en option
   *
   * \brief Fonction retourne un motant en euros passé en paramètre, en centimes.
   * \param String $amount: Un montant en centimes.
   * \param MTransaction $transaction: Une transaction dont $transaction->amount est en euros.
   * \return Bool $test : Renvoi True si le montant est le même, False sinon.
   *
   protected function getLanguageCode($lang){
   if (empty($lang)){
   $lang = $this->defaultLang;
   }
   return $lang;
   }*/

  /**
   * \brief Fonction qui permet de choisir le fomat d'une référence.
   * \param String $format : Le format de la référence désiré. Ex :'%Y%m%d%H%i%s%$myVar'
   * \return Array:
   * - String $formatDate : La manière dont on souhaite représenter la date.
   * - String $refSpe : Le key de la variable à concatener à la référence.
   * - Bool $refAfterDate : Renvoi true si la variable que l'on souhaite concatener, se place après la date.
   */
  protected function formatOrderRef($format){
    // Sépare les paramètres grâce au caractère d'échapement '%'
    $params = explode('%', $format);
    $formatDate = $refSpe = null;
    $i = 0;
    // Pour tous les paramètres
    foreach($params as $val){
      // S'il font partis de la date ou d'un caractère d'échappement
      if (($val == 'Y') || ($val == 'y') || ($val == 'm') || ($val == 'd')
	  || ($val == 'D') || ($val == 'H') || ($val == 'h') 
	  || ($val == 'i') || ($val == 's')  || ($val == ':')  || ($val == ' ')  || ($val == '-') ) {
	$i++;
	// On concatène le nouveau paramètre au format requis pour la date
	$formatDate = $formatDate.$val;	
      }else{
	// si c'est une variable
	if($val[0] == '$'){
	  $refSpe = $val;
	  // Mémorise si la date va avant ou apres la variable personalisée
	  if($i > 0){
	    $refAfterDate = true;
	  }else{
	    $refAfterDate = false;
	  }
	}	
      }  
    }
    return array($formatDate,$refSpe, $refAfterDate);
  }

  public function secGroups($function, $group=NULL) {
    $g=array();
    $g['autoresponse'] = array('none');

    if(isset($g[$function])) {
      return $g[$function];
    }
    if(isset($g[$function])) {
      if(!empty($group)){
	return in_array($group, $g[$function]);
      }
      return $g[$function];
    }
    return parent::secGroups($function,$group);
  }
  
  /**
   * \brief Fonction qui retourne le libellé d'une erreur à partir de son code.
   * \param Int $errorCode : Le code erreur retourné par la banque pour une transaction. 
   * \return String $errorLabel : Le libellé de l'erreur ou  'Code erreur non documenté'
   */
  protected function getErrorCode ($errorCode) {
    $errorTab= array( '00' => 'Paiement autorisé.',
		      '02' => 'Contacter l’émetteur de carte.',
		      '03' => 'Accepteur invalide.',
		      '04' => 'Conserver la carte.',
		      '05' => 'Ne pas honorer.',
		      '07' => 'Conserver la carte, conditions spéciales.',
		      '08' => 'Approuver après identification.',
		      '12' => 'Transaction invalide.',
		      '13' => 'Montant invalide.',
		      '14' => 'Numéro de porteur invalide.',
		      '17' => 'Annulation du client.',
		      '24' => 'Opération impossible. L\'opération que vous souhaitez réaliser n\'est pas compatible avec l\'état de la transaction.',
		      '30' => 'Error de format.',
		      '31' => 'Identifiant de l\'organisme acquéreur inconnu.',
		      '33' => 'Date de validité de la carte dépassée.',
		      '34' => 'Suspicion de fraude.',
		      '41' => 'Carte perdue.',
		      '43' => 'Carte volée.',
		      '51' => 'Provision insuffisante ou crédit dépassé.',
		      '54' => 'Date de validité de la carte dépassée.',
		      '56' => 'Carte absente du fichier.',
		      '57' => 'Transaction non permise à ce porteur.',
		      '58' => 'Transaction interdite au terminal.',
		      '59' => 'Suspicion de fraude.',
		      '60' => 'L\'accepteur de carte doit contacter l’acquéreur.',
		      '61' => 'Montant de retrait hors limite.',
		      '63' => 'Règles de sécurité non respectées.',
		      '68' => 'Réponse non parvenue ou reçue trop tard.',
		      '75' => 'Nombre de tentatives de saisie du numéro de carte dépassé.', 
		      '90' => 'Arret momentané du système.',
		      '91' => 'Emetteur de cartes inaccessible.',
		      '94' => 'Transaction dupliquée.',
		      '96' => 'Mauvais fonctionnement du système.',
		      '97' => 'Echéance de la temporisation de surveillance globale.',
		      '98' => 'Serveur indisponible routage réseau demandé à nouveau.',
		      '99' => 'Incident domaine initiateur.');
    // Si le code erreur existe dans le tableau
    if(array_key_exists($errorCode,$errorTab)){
      $errorLabel = $errorTab[$errorCode];
      return $errorLabel;
    }
    // Si le ccode erreur n'est pas répertorié.
    else{
      return 'Code erreur non documenté';
    }
  }

  /**
   * Translate a result array into a HTML table
   *
   * @author Aidan Lister <aidan@php.net>
   * @version 1.3.2
   * @link http://aidanlister.com/repos/v/function.array2table.php
   * @param array $array The result (numericaly keyed, associative inner) array.
   * @param bool $recursive Recursively generate tables for multi-dimensional arrays
   * @param string $null String to output for blank cells
   */
  function array2html($array, $recursive = false, $null = '&nbsp;') {
    // Sanity check
    if (empty($array) || !is_array($array)) {
      return false;
    }
    if (!isset($array[0]) || !is_array($array[0])) {
      $array = array($array);
    }
    // Start the table
    $table = "<table>\n";
    // The header
    $table .= "\t<tr>";
    // Take the keys from the first row as the headings
    foreach (array_keys($array[0]) as $heading) {
      $table .= '<th>' . $heading . '</th>';
    }
    $table .= "</tr>\n";
    // The body
    foreach ($array as $row) {
      $table .= "\t<tr>" ;
      foreach ($row as $cell) {
	$table .= '<td>';
	// Cast objects
	if (is_object($cell)) { 
	  $cell = (array) $cell;
	}
	if ($recursive === true && is_array($cell) && !empty($cell)) {
	  // Recursive mode
	  $table .= "\n" . array2table($cell, true, true) . "\n";
	} else {
	  $table .= (strlen($cell) > 0) ?
	    htmlspecialchars((string) $cell) :
	    $null;
	}
	$table .= '</td>';
      }
      $table .= "</tr>\n";
    }
    $table .= '</table>';
    return $table;
  }

  /**
   * \brief Fonction d'initialisation des options communes à tout les sytèmes de paiement (permet d'ajouter dans champs dans les proprètés du module).
   * Permet d'initialiser les options communes aux trois modules (Paybox, SystemPay et Atos). 
   * \note 
   * Crée les champs:
   * - siteId \link XModMonetique::$siteId \endlink
   * - urlPayed \link XModMonetique::$urlPayed \endlink
   * - urlCancelled \link XModMonetique::$urlCancelled \endlink  
   * - urlAutoResponse \link XModMonetique::$urlAutoResponse \endlink
   */
  public function initOptions() {
    parent::initOptions();
    $alabel = XLabels::getSysLabel('xmodmonetique.modulename');
    $this->_options->setOpt(XLabels::getSysLabel('xmodmonetique','siteid'), 'siteId','text',NULL,NULL,$alabel);   
    $this->_options->setOpt(XLabels::getSysLabel('xmodmonetique','urlPayed'), 'urlPayed','text',NULL,NULL,$alabel);
    $this->_options->setOpt(XLabels::getSysLabel('xmodmonetique','urlCancelled'), 'urlCancelled','text',NULL,NULL,$alabel);
    $this->_options->setOpt(XLabels::getSysLabel('xmodmonetique','urlAutoResponse'),'urlAutoResponse','text',NULL,NULL,$alabel);
  }

  /**
   * \brief Méthode de vérification de la présence du fichier de retour automatique.
   * Permet d'afficher une erreur dans les propriètés du module si le fichier de retour automatique n'est pas présent. 
   */
  public function editProperties($ar) {
    parent::editProperties($ar);
    if (!preg_match('@^(?:https?://)?[^/]+/([^?]*)(\?[^?]*)?$@', $this->urlAutoResponse, $matches))
      setSessionVar('message', 'Url de retour automatique incorrecte : '.$this->urlAutoResponse);
    // Si le fichier n'exite pas, affiche l'erreur
    elseif(!file_exists(TZR_WWW_DIR.$matches[1]) ){
      setSessionVar('message', 'Fichier de retour automatique non présent à l\'adresse : '.TZR_WWW_DIR.$matches[1]);
    }
  }

  /**
   * \brief Fonction abstraite de preparation des paramètres d'appel en banque spécifique à chaques module.
   * \param MOrderInfos $order : La commande à l'origine de la transaction.
   * \param MCustomerInfos $customer : Le client à l'origine de la commande.
   * \param MShopInfos $shop : La boutique demandant la création de la transaction.
   * \param MTransaction $transaction : La transaction en cours de préparation.
   * @return Array :
   * - MTransaction $transaction : La transaction avec ses paramètres.
   * - Array $payboxForm : Le formulaire à soumettre à la banque.
   * - String $template : Le template à utilisé pour afficher le formulaire avant l'envoi en banque.
   * - String $tplEntry : L'entrée smarty du template. 
   * \see
   * - XModPaybox::webPaymentHandling(MOrderInfos $order, MCustomerInfos $customer, MShopInfos $shop, $transaction);
   * - XModSystemPay::webPaymentHandling(MOrderInfos $order, MCustomerInfos $customer, MShopInfos $shop, $transaction);
   * - XModAtos::webPaymentHandling(MOrderInfos $order, MCustomerInfos $customer, MShopInfos $shop, $transaction);
   */
  abstract protected function webPaymentHandling(MTransaction $transaction);

  /**
   * \brief Fonction abstraite de traitement automatique d'un retour banque spécifique à chaques module.
   * @return 
   * MTransaction $transaction : La transaction avec ses paramètres concernée par le retour.
   * \see
   * - XModPaybox::webPaymentUnFoldReponse();
   * - XModSystemPay::webPaymentUnFoldReponse();
   * - XModAtos::webPaymentUnFoldReponse();
   */
  abstract protected function webPaymentUnFoldReponse();

  /**
   * \brief Fonction abstraite de création d'un remboursement.
   * Cette fonction permet à chaque module héritant de cette classe, de créer un remboursement avec les paramètres attendus par la banque.
   * \param MTransaction &$newTransaction : Transaction relative au remboursement.
   * \return MTransaction $newTransaction : La transaction passé en paramètre, contenant les paramètres d'appel et la réponse.
   * \see
   * - XModPaybox::refundHandling(& $transaction);
   * - XModAtos::refundHandling(& $transaction);
   * - XModSystemPay::refundHandling(& $transaction);
   */
  abstract protected function refundHandling($newTransaction);

  /**
   * \brief Fonction abstraite de réémission d'un remboursement.
   * Cette fonction permet à chaque module héritant de cette classe, de rejouer un remboursement avec les même paramètres.
   * \param MTransaction &$newTransaction : Transaction relative au remboursement.
   * \return MTransaction $newTransaction : La transaction contenant les paramètres d'appel et la réponse.
   * \see
   * - XModPaybox::refundReplay(& $transaction);
   * - XModAtos::refundReplay(& $transaction);
   * - XModSystemPay::refundReplay(& $transaction);
   */
  abstract protected function refundReplay($newTransaction);

  /**
   * \brief Fonction abstraite de création d'une duplication.
   * Cette fonction permet à chaque module héritant de cette classe, de créer une duplication avec les paramètres attendus par la banque.
   * \param MTransaction &$newTransaction : Transaction relative à la duplication.
   * \return MTransaction $newTransaction : La transaction passé en paramètre mis à jour.
   * \see
   * - XModPaybox::duplicateHandling(& $transaction);
   * - XModAtos::duplicateHandling(& $transaction);
   * - XModSystemPay::duplicateHandling(& $transaction);
   */
  abstract protected function duplicateHandling($newTransaction);

  /**
   * \brief Fonction abstraite de réémission d'une duplication.
   * Cette fonction permet à chaque module héritant de cette classe, de rejouer une duplication avec les même paramètres.
   * \param MTransaction &$newTransaction : Transaction relative à la duplication.
   * \return MTransaction $newTransaction : La transaction passé en paramètre mis à jour.
   * \see
   * - XModPaybox::duplicateReplay(& $transaction);
   * - XModAtos::duplicateReplay(& $transaction);
   * - XModSystemPay::duplicateReplay(& $transaction);
   */
  abstract protected function duplicateReplay($newTransaction);

}


class Mutex
{
  private $lock_ = null;

  // create a mutex with with a given id. This ID must be system unique.
  // [string] id - a unique id
  // return - true on success
  public function Initialize($id)
  {
    $this->lock_ = fopen($id, 'a');
    return is_resource($this->lock_);
  }

  // destroy the mutex
  public function Destroy()
  {
    $result = false;
    if (is_resource($this->lock_));
    {
      $result = flock($this->lock_, LOCK_UN);
      $result &= fclose($this->lock_);
      $this->lock_ = null;
    }
    return $result;
  }

  // exclusively lock the resource
  // return - true on success
  public function Lock()
  {
    if (is_resource($this->lock_)){
      XLogs::notice(get_class($this), 'waiting for lock on boucle '.$this->lock_);
      return flock($this->lock_, LOCK_EX);
    }
    return false;
  }

  // release the locked resource
  // return - true on success
  public function Release()
  {
    if (is_resource($this->lock_))
      return flock($this->lock_, LOCK_UN);
    return false;
  }
}



/******************* NOTIFICATION BOUTIQUE REFUND: **************************
 * 
 *  // Si la transaction correspond à un remboursement
 *  if( ($transaction->type == XModMonetique::REFUND) ){
 *    // Si la transaction retourne une erreur
 *    if ($transaction->status == XModMonetique::ERROR){
 *	$transaction->etat = XModMonetique::REFUNDERROR; 
 *	$transaction->newAmount = $order->CURRENTAMOUNT;
 *	XLogs::critical(get_class($this).'::monetiqueRetourAutoBanque', "Error de montant de remboursement.");
 *	XLogs::critical(get_class($this).'::monetiqueRetourAutoBanque', print_r($order, true));
 *	XLogs::critical(get_class($this).'::monetiqueRetourAutoBanque', print_r($transaction, true));
 *    }
 *    // Si il n'y a pas eu d'erreur sur la transaction
 *    else{
 *	// On récupère la commande
 *	$order = $this->getOrder($orderoid);
 *	// On calcule le nouveau montant 
 *	$transaction->newAmount = sprintf("%.2f",$order->CURRENTAMOUNT - sprintf("%.2f",$transaction->amount/100));
 *	// Si c'est un remboursement partiel
 *	if($transaction->newAmount > 0){
 *	  // Si la transaction est en attente de traitement
 *	  if($transaction->status == XModMonetique::WAITTING){
 *	    $transaction->etat = XModMonetique::PARTIALREFUNDWAITTING; 
 *	  }
 *	  // Si la transaction s'est déroulé intégralement
 *	  else  if($transaction->status == XModMonetique::SUCCESS){
 *	    $transaction->etat = XModMonetique::PARTIALREFUND;  ///< On affecte l'etat de la transaction par rapport à la commande
 *	  }
 *	}
 *	// Si c'est un remboursement integral
 *	else if($transaction->newAmount == 0){
 *	  // Si la transaction est en attente de traitement
 *	  if($transaction->status == XModMonetique::WAITTING){
 *	    $transaction->etat = XModMonetique::REFUNDCOMPLETEWAITTING; 
 *	  }
 *	  // Si la transaction s'est déroulé intégralement
 *	  else  if($transaction->status == XModMonetique::SUCCESS){
 *	    $transaction->etat = XModMonetique::REFUNDCOMPLETE;  ///< On affecte l'etat de la transaction par rapport à la commande
 *	  }
 *	}
 *	// Si on à rembourser plus que le montant initial (Ou qu'un tel remboursement est en attente
 *	else{	
 *	  // Si la transaction est en attente de traitement
 *	  if($transaction->status == XModMonetique::WAITTING){
 *	    $transaction->etat = XModMonetique::REFUNDERRORWAIT; ///< On affecte l'etat de la transaction par rapport à la commande
 *	  }
 *	  // Si la transaction s'est déroulé intégralement
 *	  else if($transaction->status == XModMonetique::SUCCESS){
 *	    $transaction->etat = XModMonetique::REFUNDERROR; ///< On affecte l'etat de la transaction par rapport à la commande
 *	  }
 *	  // On log l'erreur
 *	  XLogs::critical(get_class($this).'::monetiqueRetourAutoBanque', "Error de montant de remboursement, à vérifier d'urgence.");
 *	  XLogs::critical(get_class($this).'::monetiqueRetourAutoBanque', print_r($order, true));
 *	  XLogs::critical(get_class($this).'::monetiqueRetourAutoBanque', print_r($transaction, true));
 *	}
 *	// Dans tous les cas on mémorise le retour
 *	$this->dsorder->procEdit(array('_options'=>array('local'=>true), 
 *				       'oid'=>$orderoid, 
 *				       'ETATFABRICATION'=>$transaction->etat,
 *				       'CURRENTAMOUNT'=>$transaction->newAmount
 *				       ));
 *    }
 *  }
 ************************************************************************************************/

?>