#!/usr/bin/env php * Copyright (C) 2005-2013 Laurent Destailleur * Copyright (C) 2013 Juanjo Menent * Copyright (C) 2024 Frédéric France * Copyright (C) 2024 MDW * * 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 . */ /** * \file scripts/contracts/email_expire_services_to_representatives.php * \ingroup contracts * \brief Script to send a mail to dolibarr users linked to companies with services to expire */ if (!defined('NOSESSION')) { define('NOSESSION', '1'); } $sapi_type = php_sapi_name(); $script_file = basename(__FILE__); $path = __DIR__.'/'; // Test si mode batch $sapi_type = php_sapi_name(); if (substr($sapi_type, 0, 3) == 'cgi') { echo "Error: You are using PHP for CGI. To execute ".$script_file." from command line, you must use PHP for CLI mode.\n"; exit(1); } if (!isset($argv[1]) || !$argv[1] || !in_array($argv[1], array('test', 'confirm'))) { print "Usage: $script_file (test|confirm) [delay]\n"; print "\n"; print "Send an email to remind all contracts services to expire, to users that are sale representative for.\n"; print "If you choose 'test' mode, no emails are sent.\n"; print "If you add a delay (nb of days), only services with expired date < today + delay are included.\n"; exit(1); } $mode = $argv[1]; require $path."../../htdocs/master.inc.php"; require_once DOL_DOCUMENT_ROOT."/core/class/CMailFile.class.php"; $langs->loadLangs(array('main', 'contracts')); // Global variables $version = DOL_VERSION; $error = 0; $hookmanager->initHooks(array('cli')); /* * Main */ @set_time_limit(0); print "***** ".$script_file." (".$version.") pid=".dol_getmypid()." *****\n"; dol_syslog($script_file." launched with arg ".join(',', $argv)); $now = dol_now('tzserver'); $duration_value = isset($argv[2]) ? $argv[2] : 'none'; print $script_file." launched with mode ".$mode." default lang=".$langs->defaultlang.(is_numeric($duration_value) ? " delay=".$duration_value : "")."\n"; if ($mode != 'confirm') { $conf->global->MAIN_DISABLE_ALL_MAILS = 1; } /** @var DoliDB $db */ $sql = "SELECT DISTINCT c.ref, c.fk_soc, cd.date_fin_validite, cd.total_ttc, cd.description as description, p.label as plabel, s.rowid, s.nom as name, s.email, s.default_lang,"; $sql .= " u.rowid as uid, u.lastname, u.firstname, u.email, u.lang"; $sql .= " FROM ".MAIN_DB_PREFIX."societe AS s, ".MAIN_DB_PREFIX."contrat AS c, ".MAIN_DB_PREFIX."contratdet AS cd"; $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."product AS p ON p.rowid = cd.fk_product, ".MAIN_DB_PREFIX."societe_commerciaux AS sc, ".MAIN_DB_PREFIX."user AS u"; $sql .= " WHERE s.rowid = c.fk_soc AND c.rowid = cd.fk_contrat AND c.statut > 0 AND cd.statut<5"; if (is_numeric($duration_value)) { $sql .= " AND cd.date_fin_validite < '".$db->idate(dol_time_plus_duree($now, (int) $duration_value, "d"))."'"; } $sql .= " AND sc.fk_soc = s.rowid AND sc.fk_user = u.rowid"; $sql .= " ORDER BY u.email ASC, s.rowid ASC, c.ref ASC"; // Order by email to allow one message per email $resql = $db->query($sql); if ($resql) { $num = $db->num_rows($resql); $i = 0; $oldemail = 'none'; $oldsalerepresentative = ''; $olduid = 0; $oldlang = ''; $total = 0; $foundtoprocess = 0; print "We found ".$num." couples (services to expire - sale representative) qualified\n"; dol_syslog("We found ".$num." couples (services to expire - sale representative) qualified"); $message = ''; if ($num) { while ($i < $num) { $obj = $db->fetch_object($resql); if (($obj->email != $oldemail || $obj->uid != $olduid) || $oldemail == 'none') { // Break onto sales representative (new email or uid) if (dol_strlen($oldemail) && $oldemail != 'none') { sendEmailTo($mode, $oldemail, $message, price2num($total), $oldlang, $oldsalerepresentative, (int) $duration_value); } else { if ($oldemail != 'none') { print "- No email sent for ".$oldsalerepresentative.", total: ".$total."\n"; } } $oldemail = $obj->email; $olduid = $obj->uid; $oldlang = $obj->lang; $oldsalerepresentative = dolGetFirstLastname($obj->firstname, $obj->lastname); $message = ''; $total = 0; $foundtoprocess = 0; $salerepresentative = dolGetFirstLastname($obj->firstname, $obj->lastname); if (empty($obj->email)) { print "Warning: Sale representative ".$salerepresentative." has no email. Notice disabled.\n"; } } // Define line content $outputlangs = new Translate('', $conf); $outputlangs->setDefaultLang(empty($obj->lang) ? $langs->defaultlang : $obj->lang); // By default language of sale representative // Load translation files required by the page $outputlangs->loadLangs(array("main", "contracts", "bills", "products")); if (dol_strlen($obj->email)) { $message .= $outputlangs->trans("Contract")." ".$obj->ref.": ".$langs->trans("Service")." ".dol_concatdesc($obj->plabel, $obj->description)." (".price($obj->total_ttc, 0, $outputlangs, 0, 0, -1, $conf->currency).") ".$obj->name.", ".$outputlangs->trans("DateEndPlannedShort")." ".dol_print_date($db->jdate($obj->date_fin_validite), 'day')."\n\n"; dol_syslog("email_expire_services_to_representatives.php: ".$obj->email); $foundtoprocess++; } print "Service to expire ".$obj->ref.", label ".dol_concatdesc($obj->plabel, $obj->description).", due date ".dol_print_date($db->jdate($obj->date_fin_validite), 'day')." (linked to company ".$obj->name.", sale representative ".dolGetFirstLastname($obj->firstname, $obj->lastname).", email ".$obj->email."): "; if (dol_strlen($obj->email)) { print "qualified."; } else { print "disqualified (no email)."; } print "\n"; unset($outputlangs); $total += $obj->total_ttc; $i++; } // If there are remaining messages to send in the buffer if ($foundtoprocess) { if (dol_strlen($oldemail) && $oldemail != 'none') { // Break onto email (new email) sendEmailTo($mode, $oldemail, $message, price2num($total), $oldlang, $oldsalerepresentative, (int) $duration_value); } else { if ($oldemail != 'none') { print "- No email sent for ".$oldsalerepresentative.", total: ".$total."\n"; } } } } else { print "No services to expire (for companies linked to a particular commercial dolibarr user) found\n"; } exit(0); } else { dol_print_error($db); dol_syslog("email_expire_services_to_representatives.php: Error"); exit(1); } /** * Send email * * @param string $mode Mode (test | confirm) * @param string $oldemail Target Email * @param string $message Message to send * @param string $total Total amount of unpayed invoices * @param string $userlang Code lang to use for email output. * @param string $oldtarget Target name of sale representative * @param int $duration_value Duration value * @return int Int <0 if KO, >0 if OK */ function sendEmailTo($mode, $oldemail, $message, $total, $userlang, $oldtarget, $duration_value) { global $conf, $langs; if (getenv('DOL_FORCE_EMAIL_TO')) { $oldemail = getenv('DOL_FORCE_EMAIL_TO'); } $newlangs = new Translate('', $conf); $newlangs->setDefaultLang(empty($userlang) ? getDolGlobalString('MAIN_LANG_DEFAULT', 'auto') : $userlang); $newlangs->load("main"); $newlangs->load("contracts"); if ($duration_value) { if ($duration_value > 0) { $title = $newlangs->transnoentities("ListOfServicesToExpireWithDuration", $duration_value); } else { $title = $newlangs->transnoentities("ListOfServicesToExpireWithDurationNeg", $duration_value); } } else { $title = $newlangs->transnoentities("ListOfServicesToExpire"); } $subject = getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_SUBJECT', $title); $sendto = $oldemail; $from = getDolGlobalString('MAIN_MAIL_EMAIL_FROM'); $errorsto = getDolGlobalString('MAIN_MAIL_ERRORS_TO'); $msgishtml = -1; print "- Send email for ".$oldtarget." (".$oldemail."), total: ".$total."\n"; dol_syslog("email_expire_services_to_representatives.php: send mail to ".$oldemail); $usehtml = 0; if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER') && dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER'))) { $usehtml += 1; } if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER') && dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER'))) { $usehtml += 1; } $allmessage = ''; if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER')) { $allmessage .= getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER'); } else { $allmessage .= $title.($usehtml ? "
\n" : "\n").($usehtml ? "
\n" : "\n"); $allmessage .= $newlangs->transnoentities("NoteListOfYourExpiredServices").($usehtml ? "
\n" : "\n").($usehtml ? "
\n" : "\n"); } $allmessage .= $message.($usehtml ? "
\n" : "\n"); $allmessage .= $langs->trans("Total")." = ".price($total, 0, $userlang, 0, 0, -1, $conf->currency).($usehtml ? "
\n" : "\n"); if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER')) { $allmessage .= getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER'); if (dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER'))) { $usehtml += 1; } } $mail = new CMailFile($subject, $sendto, $from, $allmessage, array(), array(), array(), '', '', 0, $msgishtml); $mail->errors_to = $errorsto; // Send or not email if ($mode == 'confirm') { $result = $mail->sendfile(); if (!$result) { print "Error sending email ".$mail->error."\n"; dol_syslog("Error sending email ".$mail->error."\n"); } } else { print "No email sent (test mode)\n"; dol_syslog("No email sent (test mode)"); $mail->dump_mail(); $result = 1; } if ($result) { return 1; } else { return -1; } }