rejetprelevement.class.php

<?php
/* Copyright (C) 2005		Rodolphe Quiedeville	<rodolphe@quiedeville.org>
 * Copyright (C) 2005-2009	Regis Houssin			<regis.houssin@inodbox.com>
 * Copyright (C) 2010-2013	Juanjo Menent			<jmenent@2byte.es>
 * Copyright (C) 2021       OpenDsi					<support@open-dsi.fr>
 * Copyright (C) 2024       Laurent Destailleur     <eldy@users.sourceforge.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

/**
 *  \file       htdocs/compta/prelevement/class/rejetprelevement.class.php
 *  \ingroup    prelevement
 *  \brief      File of class to manage standing orders rejects
 */


/**
 *	Class to manage standing orders rejects
 */
class RejetPrelevement
{
	/**
	 * @var int ID
	 */
	public $id;

	/**
	 * @var DoliDB Database handler.
	 */
	public $db;

	public $type; //prelevement or bank transfer
	public $bon_id;
	public $user;
	public $date_rejet;

	/**
	 * @var array	Reason of error
	 */
	public $motif;
	/**
	 * @var array	Label status of invoicing
	 */
	public $invoicing;

	/**
	 * @var array	Labels of reason
	 */
	public $motifs;
	/**
	 * @var array	Labels of invoicing status
	 */
	public $labelsofinvoicing;

	/**
	 *  Constructor
	 *
	 *  @param	DoliDB	$db			Database handler
	 *  @param 	User	$user       Object user
	 *  @param	string	$type		Type ('direct-debit' for direct debit or 'bank-transfer' for credit transfer)
	 */
	public function __construct($db, $user, $type)
	{
		global $langs;

		$this->db = $db;
		$this->user = $user;
		$this->type = $type;

		$this->motifs = array();
		$this->labelsofinvoicing = array();

		$this->motifs[0] = "";
		$this->motifs[1] = $langs->trans("StatusMotif1");
		$this->motifs[2] = $langs->trans("StatusMotif2");
		$this->motifs[3] = $langs->trans("StatusMotif3");
		$this->motifs[4] = $langs->trans("StatusMotif4");
		$this->motifs[5] = $langs->trans("StatusMotif5");
		$this->motifs[6] = $langs->trans("StatusMotif6");
		$this->motifs[7] = $langs->trans("StatusMotif7");
		$this->motifs[8] = $langs->trans("StatusMotif8");

		$this->labelsofinvoicing[0] = $langs->trans("NoInvoiceRefused");
		$this->labelsofinvoicing[1] = $langs->trans("InvoiceRefused");
	}

	/**
	 * Create a reject
	 *
	 * @param 	User		$user				User object
	 * @param 	int			$id					Id
	 * @param 	string		$motif				Motif
	 * @param 	int			$date_rejet			Date reject
	 * @param 	int			$bonid				Bon id
	 * @param 	int			$facturation		1=Bill the reject
	 * @return	int								Return >=0 if OK, <0 if KO
	 */
	public function create($user, $id, $motif, $date_rejet, $bonid, $facturation = 0)
	{
		global $langs;

		$error = 0;
		$this->id = $id;
		$this->bon_id = $bonid;
		$now = dol_now();

		dol_syslog("RejetPrelevement::Create id ".$id);

		$bankaccount = ($this->type == 'bank-transfer' ? getDolGlobalString('PAYMENTBYBANKTRANSFER_ID_BANKACCOUNT') : getDolGlobalString('PRELEVEMENT_ID_BANKACCOUNT'));
		$facs = $this->getListInvoices(1);

		require_once DOL_DOCUMENT_ROOT.'/compta/prelevement/class/ligneprelevement.class.php';
		$lipre = new LignePrelevement($this->db);
		$lipre->fetch($id);

		$this->db->begin();

		// Insert refused line into database
		$sql = "INSERT INTO ".MAIN_DB_PREFIX."prelevement_rejet (";
		$sql .= "fk_prelevement_lignes";
		$sql .= ", date_rejet";
		$sql .= ", motif";
		$sql .= ", fk_user_creation";
		$sql .= ", date_creation";
		$sql .= ", afacturer";
		$sql .= ") VALUES (";
		$sql .= ((int) $id);
		$sql .= ", '".$this->db->idate($date_rejet)."'";
		$sql .= ", ".((int) $motif);
		$sql .= ", ".((int) $user->id);
		$sql .= ", '".$this->db->idate($now)."'";
		$sql .= ", ".((int) $facturation);
		$sql .= ")";

		$result = $this->db->query($sql);

		if (!$result) {
			dol_syslog("RejetPrelevement::create Erreur 4 $sql");
			$error++;
		}

		// Tag the line to refused
		$sql = " UPDATE ".MAIN_DB_PREFIX."prelevement_lignes ";
		$sql .= " SET statut = 3";
		$sql .= " WHERE rowid = ".((int) $id);

		if (!$this->db->query($sql)) {
			dol_syslog("RejetPrelevement::create Erreur 5");
			$error++;
		}

		$num = count($facs);
		for ($i = 0; $i < $num; $i++) {
			if ($this->type == 'bank-transfer') {
				$fac = new FactureFournisseur($this->db);
				$pai = new PaiementFourn($this->db);
			} else {
				$fac = new Facture($this->db);
				$pai = new Paiement($this->db);
			}

			$fac->fetch($facs[$i][0]);

			$amountrejected = $facs[$i][1];

			// Make a negative payment
			// Amount must be an array (id of invoice -> amount)
			$pai->amounts = array();
			$pai->amounts[$facs[$i][0]] = price2num($amountrejected * -1);		// The payment must be negative because it is a refund

			$pai->datepaye = $date_rejet;
			$pai->paiementid = 3; // type of payment: withdrawal
			$pai->num_paiement = $langs->trans('Rejection').' '.$fac->ref;
			$pai->num_payment = $langs->trans('Rejection').' '.$fac->ref;
			$pai->id_prelevement = $this->bon_id;
			$pai->num_prelevement = $lipre->bon_ref;

			if ($pai->create($this->user) < 0) {
				$error++;
				dol_syslog("RejetPrelevement::Create Error creation payment invoice ".$facs[$i][0]);
			} else {
				// We record entry into bank
				$mode = 'payment';
				if ($this->type == 'bank-transfer') {
					$mode = 'payment_supplier';
				}

				$result = $pai->addPaymentToBank($user, $mode, '(InvoiceRefused)', $bankaccount, '', '');
				if ($result < 0) {
					dol_syslog("RejetPrelevement::Create AddPaymentToBan Error");
					$error++;
				}

				// Payment validation
				if ($pai->validate($user) < 0) {
					$error++;
					dol_syslog("RejetPrelevement::Create Error payment validation");
				}
			}
			//Tag invoice as unpaid
			dol_syslog("RejetPrelevement::Create set_unpaid fac ".$fac->ref);

			$fac->setUnpaid($user);

			//TODO: Must be managed by notifications module
			// Send email to sender of the standing order request
			$this->_send_email($fac);
		}

		if ($error == 0) {
			dol_syslog("RejetPrelevement::Create Commit");
			$this->db->commit();

			return 1;
		} else {
			dol_syslog("RejetPrelevement::Create Rollback");
			$this->db->rollback();

			return -1;
		}
	}

	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
	/**
	 *  Send email to all users that has asked the withdraw request
	 *
	 * 	@param	Facture		$fac			Invoice object
	 * 	@return	void
	 */
	private function _send_email($fac)
	{
		// phpcs:enable
		global $langs;

		$userid = 0;

		$sql = "SELECT fk_user_demande";
		$sql .= " FROM ".MAIN_DB_PREFIX."prelevement_demande as pfd";
		$sql .= " WHERE pfd.fk_prelevement_bons = ".((int) $this->bon_id);
		$sql .= " AND pfd.fk_facture".($this->type == 'bank-transfer' ? '_fourn' : '').' = '.((int) $fac->id);

		$resql = $this->db->query($sql);
		if ($resql) {
			$num = $this->db->num_rows($resql);
			if ($num > 0) {
				$row = $this->db->fetch_row($resql);
				$userid = $row[0];
			}
		} else {
			dol_syslog("RejetPrelevement::_send_email Erreur lecture user");
		}

		if ($userid > 0) {
			$emuser = new User($this->db);
			$emuser->fetch($userid);

			$soc = new Societe($this->db);
			$soc->fetch($fac->socid);

			require_once DOL_DOCUMENT_ROOT.'/core/class/CMailFile.class.php';

			$subject = $langs->transnoentities("InfoRejectSubject");
			$sendto = $emuser->getFullName($langs)." <".$emuser->email.">";
			$from = $this->user->getFullName($langs)." <".$this->user->email.">";
			$msgishtml = 1;
			$trackid = 'use'.$emuser->id;

			$arr_file = array();
			$arr_mime = array();
			$arr_name = array();
			$facref = $fac->ref;
			$socname = $soc->name;
			$amount = price($fac->total_ttc);
			$userinfo = $this->user->getFullName($langs);

			$message = $langs->trans("InfoRejectMessage", $facref, $socname, $amount, $userinfo);

			$mailfile = new CMailFile($subject, $sendto, $from, $message, $arr_file, $arr_mime, $arr_name, '', '', 0, $msgishtml, $this->user->email, '', $trackid);

			$result = $mailfile->sendfile();
			if ($result) {
				dol_syslog("RejetPrelevement::_send_email email envoye");
			} else {
				dol_syslog("RejetPrelevement::_send_email Erreur envoi email");
			}
		} else {
			dol_syslog("RejetPrelevement::_send_email Userid invalid");
		}
	}

	/**
	 * Retrieve the list of invoices
	 *
	 * @param 	int		$amounts 	If you want to get the amount of the order for each invoice
	 * @return	array				Array List of invoices related to the withdrawal line
	 * @todo	A withdrawal line is today linked to one and only one invoice. So the function should return only one object ?
	 */
	private function getListInvoices($amounts = 0)
	{
		global $conf;

		$arr = array();

		//Returns all invoices of a withdrawal
		$sql = "SELECT f.rowid as facid, pl.amount";
		$sql .= " FROM ".MAIN_DB_PREFIX."prelevement as pf";
		if ($this->type == 'bank-transfer') {
			$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."facture_fourn as f ON (pf.fk_facture_fourn = f.rowid)";
		} else {
			$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."facture as f ON (pf.fk_facture = f.rowid)";
		}
		$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."prelevement_lignes as pl ON (pf.fk_prelevement_lignes = pl.rowid)";
		$sql .= " WHERE pf.fk_prelevement_lignes = ".((int) $this->id);
		$sql .= " AND f.entity IN  (".getEntity('invoice').")";

		$resql = $this->db->query($sql);
		if ($resql) {
			$num = $this->db->num_rows($resql);

			if ($num) {
				$i = 0;
				while ($i < $num) {
					$row = $this->db->fetch_row($resql);
					if (!$amounts) {
						$arr[$i] = $row[0];
					} else {
						$arr[$i] = array(
							$row[0],
							$row[1]
						);
					}
					$i++;
				}
			}
			$this->db->free($resql);
		} else {
			dol_syslog("getListInvoices", LOG_ERR);
		}

		return $arr;
	}

	/**
	 *    Retrieve withdrawal object
	 *
	 *    @param    int		$rowid       id of invoice to retrieve
	 *    @return	int
	 */
	public function fetch($rowid)
	{
		$sql = "SELECT pr.date_rejet as dr, motif, afacturer";
		$sql .= " FROM ".MAIN_DB_PREFIX."prelevement_rejet as pr";
		$sql .= " WHERE pr.fk_prelevement_lignes =".((int) $rowid);

		$resql = $this->db->query($sql);
		if ($resql) {
			if ($this->db->num_rows($resql)) {
				$obj = $this->db->fetch_object($resql);

				$this->id = $rowid;
				$this->date_rejet = $this->db->jdate($obj->dr);
				$this->motif = $this->motifs[$obj->motif];
				$this->invoicing = $this->labelsofinvoicing[$obj->afacturer];

				$this->db->free($resql);

				return 0;
			} else {
				dol_syslog("RejetPrelevement::Fetch Erreur rowid=".$rowid." numrows=0");
				return -1;
			}
		} else {
			dol_syslog("RejetPrelevement::Fetch Erreur rowid=".$rowid);
			return -2;
		}
	}
}