dolibarr 21.0.0-alpha
email_unpaid_invoices_to_representatives.php
Go to the documentation of this file.
1#!/usr/bin/env php
2<?php
3/*
4 * Copyright (C) 2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
5 * Copyright (C) 2005-2013 Laurent Destailleur <eldy@users.sourceforge.net>
6 * Copyright (C) 2013 Juanjo Menent <jmenent@2byte.es>
7 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
8 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
30if (!defined('NOSESSION')) {
31 define('NOSESSION', '1');
32}
33
34$sapi_type = php_sapi_name();
35$script_file = basename(__FILE__);
36$path = __DIR__.'/';
37
38// Test si mode batch
39$sapi_type = php_sapi_name();
40if (substr($sapi_type, 0, 3) == 'cgi') {
41 echo "Error: You are using PHP for CGI. To execute ".$script_file." from command line, you must use PHP for CLI mode.\n";
42 exit(1);
43}
44
45if (!isset($argv[1]) || !$argv[1] || !in_array($argv[1], array('test', 'confirm'))) {
46 print "Usage: $script_file (test|confirm) [delay]\n";
47 print "\n";
48 print "Send an email to users to remind all unpaid customer invoices user is sale representative for.\n";
49 print "If you choose 'test' mode, no emails are sent.\n";
50 print "If you add a delay (nb of days), only invoice with due date < today + delay are included.\n";
51 exit(1);
52}
53$mode = $argv[1];
54
55require $path."../../htdocs/master.inc.php";
56require_once DOL_DOCUMENT_ROOT."/core/class/CMailFile.class.php";
57
58$langs->load('main');
59
60// Global variables
61$version = DOL_VERSION;
62$error = 0;
63
64$hookmanager->initHooks(array('cli'));
65
66
67/*
68 * Main
69 */
70
71@set_time_limit(0);
72print "***** ".$script_file." (".$version.") pid=".dol_getmypid()." *****\n";
73dol_syslog($script_file." launched with arg ".join(',', $argv));
74
75$now = dol_now('tzserver');
76$duration_value = isset($argv[2]) ? $argv[2] : 'none';
77
78print $script_file." launched with mode ".$mode." default lang=".$langs->defaultlang.(is_numeric($duration_value) ? " delay=".$duration_value : "")."\n";
79
80if ($mode != 'confirm') {
81 $conf->global->MAIN_DISABLE_ALL_MAILS = 1;
82}
83
84if (!empty($dolibarr_main_db_readonly)) {
85 print "Error: instance in read-onyl mode\n";
86 exit(1);
87}
88
89$sql = "SELECT f.ref, f.total_ttc, f.date_lim_reglement as due_date, s.nom as name, s.email, s.default_lang,";
90$sql .= " u.rowid as uid, u.lastname, u.firstname, u.email, u.lang";
91$sql .= " FROM ".MAIN_DB_PREFIX."facture as f";
92$sql .= " , ".MAIN_DB_PREFIX."societe as s";
93$sql .= " , ".MAIN_DB_PREFIX."societe_commerciaux as sc";
94$sql .= " , ".MAIN_DB_PREFIX."user as u";
95$sql .= " WHERE f.fk_statut = 1 AND f.paye = 0";
96$sql .= " AND f.fk_soc = s.rowid";
97if (is_numeric($duration_value)) {
98 $sql .= " AND f.date_lim_reglement < '".$db->idate(dol_time_plus_duree($now, (int) $duration_value, "d"))."'";
99}
100$sql .= " AND sc.fk_soc = s.rowid";
101$sql .= " AND sc.fk_user = u.rowid";
102$sql .= " ORDER BY u.email ASC, s.rowid ASC, f.ref ASC"; // Order by email to allow one message per email
103
104// print $sql;
105$resql = $db->query($sql);
106if ($resql) {
107 $num = $db->num_rows($resql);
108 $i = 0;
109 $oldemail = 'none';
110 $olduid = 0;
111 $oldlang = '';
112 $total = 0;
113 $foundtoprocess = 0;
114
115 print "We found ".$num." couples (unpayed validated invoice - sale representative) qualified\n";
116 dol_syslog("We found ".$num." couples (unpayed validated invoice - sale representative) qualified");
117 $message = '';
118 $oldsalerepresentative = 0;
119
120 if ($num) {
121 while ($i < $num) {
122 $obj = $db->fetch_object($resql);
123
124 if (($obj->email != $oldemail || $obj->uid != $olduid) || $oldemail == 'none') {
125 // Break onto sales representative (new email or uid)
126 if (dol_strlen($oldemail) && $oldemail != 'none') {
127 envoi_mail($mode, $oldemail, $message, $total, $oldlang, $oldsalerepresentative);
128 } else {
129 if ($oldemail != 'none') {
130 print "- No email sent for ".$oldsalerepresentative.", total: ".$total."\n";
131 }
132 }
133 $oldemail = $obj->email;
134 $olduid = $obj->uid;
135 $oldlang = $obj->lang;
136 $oldsalerepresentative = dolGetFirstLastname($obj->firstname, $obj->lastname);
137 $message = '';
138 $total = 0;
139 $foundtoprocess = 0;
140 $salerepresentative = dolGetFirstLastname($obj->firstname, $obj->lastname);
141 if (empty($obj->email)) {
142 print "Warning: Sale representative ".$salerepresentative." has no email. Notice disabled.\n";
143 }
144 }
145
146 // Define line content
147 $outputlangs = new Translate('', $conf);
148 $outputlangs->setDefaultLang(empty($obj->lang) ? $langs->defaultlang : $obj->lang); // By default language of sale representative
149
150 // Load translation files required by the page
151 $outputlangs->loadLangs(array("main", "bills"));
152
153 if (dol_strlen($obj->email)) {
154 $message .= $outputlangs->trans("Invoice")." ".$obj->ref." : ".price($obj->total_ttc, 0, $outputlangs, 0, 0, -1, $conf->currency)." : ".$obj->name."\n";
155 dol_syslog("email_unpaid_invoices_to_representatives.php: ".$obj->email);
156 $foundtoprocess++;
157 }
158 print "Unpaid invoice ".$obj->ref.", price ".price2num($obj->total_ttc).", due date ".dol_print_date($db->jdate($obj->due_date), 'day')." (linked to company ".$obj->name.", sale representative ".dolGetFirstLastname($obj->firstname, $obj->lastname).", email ".$obj->email.", lang ".$outputlangs->defaultlang."): ";
159 if (dol_strlen($obj->email)) {
160 print "qualified.";
161 } else {
162 print "disqualified (no email).";
163 }
164 print "\n";
165
166 unset($outputlangs);
167
168 $total += $obj->total_ttc;
169 $i++;
170 }
171
172 // If there are remaining messages to send in the buffer
173 if ($foundtoprocess) {
174 if (dol_strlen($oldemail) && $oldemail != 'none') { // Break onto email (new email)
175 envoi_mail($mode, $oldemail, $message, $total, $oldlang, $oldsalerepresentative);
176 } else {
177 if ($oldemail != 'none') {
178 print "- No email sent for ".$oldsalerepresentative.", total: ".$total."\n";
179 }
180 }
181 }
182 } else {
183 print "No unpaid invoices (for companies linked to a particular commercial dolibarr user) found\n";
184 }
185
186 exit(0);
187} else {
188 dol_print_error($db);
189 dol_syslog("email_unpaid_invoices_to_representatives.php: Error");
190
191 exit(1);
192}
193
205function envoi_mail($mode, $oldemail, $message, $total, $userlang, $oldtarget)
206{
207 global $conf, $langs;
208
209 if (getenv('DOL_FORCE_EMAIL_TO')) {
210 $oldemail = getenv('DOL_FORCE_EMAIL_TO');
211 }
212
213 $newlangs = new Translate('', $conf);
214 $newlangs->setDefaultLang(empty($userlang) ? getDolGlobalString('MAIN_LANG_DEFAULT', 'auto') : $userlang);
215 $newlangs->load("main");
216 $newlangs->load("bills");
217
218 $subject = getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_SUBJECT', $newlangs->trans("ListOfYourUnpaidInvoices"));
219 $sendto = $oldemail;
220 $from = getDolGlobalString('MAIN_MAIL_EMAIL_FROM');
221 $errorsto = getDolGlobalString('MAIN_MAIL_ERRORS_TO');
222 $msgishtml = -1;
223
224 print "- Send email for ".$oldtarget." (".$oldemail."), total: ".$total."\n";
225 dol_syslog("email_unpaid_invoices_to_representatives.php: send mail to ".$oldemail);
226
227 $usehtml = 0;
228 if (getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_FOOTER') && dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_FOOTER'))) {
229 $usehtml += 1;
230 }
231 if (getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_HEADER') && dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_HEADER'))) {
232 $usehtml += 1;
233 }
234
235 $allmessage = '';
236 if (getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_HEADER')) {
237 $allmessage .= getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_HEADER');
238 } else {
239 $allmessage .= $newlangs->transnoentities("ListOfYourUnpaidInvoices").($usehtml ? "<br>\n" : "\n").($usehtml ? "<br>\n" : "\n");
240 $allmessage .= $newlangs->transnoentities("NoteListOfYourUnpaidInvoices").($usehtml ? "<br>\n" : "\n");
241 }
242 $allmessage .= $message.($usehtml ? "<br>\n" : "\n");
243 $allmessage .= $langs->trans("Total")." = ".price($total, 0, $newlangs, 0, 0, -1, $conf->currency).($usehtml ? "<br>\n" : "\n");
244 if (getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_FOOTER')) {
245 $allmessage .= getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_FOOTER');
246 if (dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_UNPAID_INVOICES_SALESREPRESENTATIVES_FOOTER'))) {
247 $usehtml += 1;
248 }
249 }
250
251 $mail = new CMailFile($subject, $sendto, $from, $allmessage, array(), array(), array(), '', '', 0, $msgishtml);
252
253 $mail->errors_to = $errorsto;
254
255 // Send or not email
256 if ($mode == 'confirm') {
257 $result = $mail->sendfile();
258 if (!$result) {
259 print "Error sending email ".$mail->error."\n";
260 dol_syslog("Error sending email ".$mail->error."\n");
261 }
262 } else {
263 print "No email sent (test mode)\n";
264 dol_syslog("No email sent (test mode)");
265 $mail->dump_mail();
266 $result = 1;
267 }
268
269 if ($result) {
270 return 1;
271 } else {
272 return -1;
273 }
274}
Class to send emails (with attachments or not) Usage: $mailfile = new CMailFile($subject,...
Class to manage translations.
dol_time_plus_duree($time, $duration_value, $duration_unit, $ruleforendofmonth=0)
Add a delay to a date.
Definition date.lib.php:124
envoi_mail($mode, $oldemail, $message, $total, $userlang, $oldtarget)
Send email.
dol_getmypid()
Return getmypid() or random PID when function is disabled Some web hosts disable this php function fo...
price2num($amount, $rounding='', $option=0)
Function that return a number with universal decimal format (decimal separator is '.
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.
price($amount, $form=0, $outlangs='', $trunc=1, $rounding=-1, $forcerounding=-1, $currency_code='')
Function to format a value into an amount for visual output Function used into PDF and HTML pages.
dol_now($mode='auto')
Return date for now.
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
dolGetFirstLastname($firstname, $lastname, $nameorder=-1)
Return firstname and lastname in correct order.
dol_textishtml($msg, $option=0)
Return if a text is a html content.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.