dolibarr 20.0.0
email_expire_services_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 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
28if (!defined('NOSESSION')) {
29 define('NOSESSION', '1');
30}
31
32$sapi_type = php_sapi_name();
33$script_file = basename(__FILE__);
34$path = __DIR__.'/';
35
36// Test si mode batch
37$sapi_type = php_sapi_name();
38if (substr($sapi_type, 0, 3) == 'cgi') {
39 echo "Error: You are using PHP for CGI. To execute ".$script_file." from command line, you must use PHP for CLI mode.\n";
40 exit(1);
41}
42
43if (!isset($argv[1]) || !$argv[1] || !in_array($argv[1], array('test', 'confirm'))) {
44 print "Usage: $script_file (test|confirm) [delay]\n";
45 print "\n";
46 print "Send an email to remind all contracts services to expire, to users that are sale representative for.\n";
47 print "If you choose 'test' mode, no emails are sent.\n";
48 print "If you add a delay (nb of days), only services with expired date < today + delay are included.\n";
49 exit(1);
50}
51$mode = $argv[1];
52
53require $path."../../htdocs/master.inc.php";
54require_once DOL_DOCUMENT_ROOT."/core/class/CMailFile.class.php";
55
56$langs->loadLangs(array('main', 'contracts'));
57
58// Global variables
59$version = DOL_VERSION;
60$error = 0;
61
62$hookmanager->initHooks(array('cli'));
63
64
65/*
66 * Main
67 */
68
69@set_time_limit(0);
70print "***** ".$script_file." (".$version.") pid=".dol_getmypid()." *****\n";
71dol_syslog($script_file." launched with arg ".join(',', $argv));
72
73$now = dol_now('tzserver');
74$duration_value = isset($argv[2]) ? $argv[2] : 'none';
75
76print $script_file." launched with mode ".$mode." default lang=".$langs->defaultlang.(is_numeric($duration_value) ? " delay=".$duration_value : "")."\n";
77
78if ($mode != 'confirm') {
79 $conf->global->MAIN_DISABLE_ALL_MAILS = 1;
80}
81
82$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,";
83$sql .= " u.rowid as uid, u.lastname, u.firstname, u.email, u.lang";
84$sql .= " FROM ".MAIN_DB_PREFIX."societe AS s, ".MAIN_DB_PREFIX."contrat AS c, ".MAIN_DB_PREFIX."contratdet AS cd";
85$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";
86$sql .= " WHERE s.rowid = c.fk_soc AND c.rowid = cd.fk_contrat AND c.statut > 0 AND cd.statut<5";
87if (is_numeric($duration_value)) {
88 $sql .= " AND cd.date_fin_validite < '".$db->idate(dol_time_plus_duree($now, $duration_value, "d"))."'";
89}
90$sql .= " AND sc.fk_soc = s.rowid AND sc.fk_user = u.rowid";
91$sql .= " ORDER BY u.email ASC, s.rowid ASC, c.ref ASC"; // Order by email to allow one message per email
92
93// print $sql;
94$resql = $db->query($sql);
95if ($resql) {
96 $num = $db->num_rows($resql);
97 $i = 0;
98 $oldemail = 'none';
99 $oldsalerepresentative = '';
100 $olduid = 0;
101 $oldlang = '';
102 $total = 0;
103 $foundtoprocess = 0;
104 print "We found ".$num." couples (services to expire - sale representative) qualified\n";
105 dol_syslog("We found ".$num." couples (services to expire - sale representative) qualified");
106 $message = '';
107
108 if ($num) {
109 while ($i < $num) {
110 $obj = $db->fetch_object($resql);
111
112 if (($obj->email != $oldemail || $obj->uid != $olduid) || $oldemail == 'none') {
113 // Break onto sales representative (new email or uid)
114 if (dol_strlen($oldemail) && $oldemail != 'none') {
115 sendEmailTo($mode, $oldemail, $message, $total, $oldlang, $oldsalerepresentative, $duration_value);
116 } else {
117 if ($oldemail != 'none') {
118 print "- No email sent for ".$oldsalerepresentative.", total: ".$total."\n";
119 }
120 }
121 $oldemail = $obj->email;
122 $olduid = $obj->uid;
123 $oldlang = $obj->lang;
124 $oldsalerepresentative = dolGetFirstLastname($obj->firstname, $obj->lastname);
125 $message = '';
126 $total = 0;
127 $foundtoprocess = 0;
128 $salerepresentative = dolGetFirstLastname($obj->firstname, $obj->lastname);
129 if (empty($obj->email)) {
130 print "Warning: Sale representative ".$salerepresentative." has no email. Notice disabled.\n";
131 }
132 }
133
134 // Define line content
135 $outputlangs = new Translate('', $conf);
136 $outputlangs->setDefaultLang(empty($obj->lang) ? $langs->defaultlang : $obj->lang); // By default language of sale representative
137
138 // Load translation files required by the page
139 $outputlangs->loadLangs(array("main", "contracts", "bills", "products"));
140
141 if (dol_strlen($obj->email)) {
142 $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";
143 dol_syslog("email_expire_services_to_representatives.php: ".$obj->email);
144 $foundtoprocess++;
145 }
146 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."): ";
147 if (dol_strlen($obj->email)) {
148 print "qualified.";
149 } else {
150 print "disqualified (no email).";
151 }
152 print "\n";
153
154 unset($outputlangs);
155
156 $total += $obj->total_ttc;
157 $i++;
158 }
159
160 // Si il reste des envois en buffer
161 if ($foundtoprocess) {
162 if (dol_strlen($oldemail) && $oldemail != 'none') { // Break onto email (new email)
163 sendEmailTo($mode, $oldemail, $message, $total, $oldlang, $oldsalerepresentative, $duration_value);
164 } else {
165 if ($oldemail != 'none') {
166 print "- No email sent for ".$oldsalerepresentative.", total: ".$total."\n";
167 }
168 }
169 }
170 } else {
171 print "No services to expire (for companies linked to a particular commercial dolibarr user) found\n";
172 }
173
174 exit(0);
175} else {
176 dol_print_error($db);
177 dol_syslog("email_expire_services_to_representatives.php: Error");
178
179 exit(1);
180}
181
194function sendEmailTo($mode, $oldemail, $message, $total, $userlang, $oldtarget, $duration_value)
195{
196 global $conf, $langs;
197
198 if (getenv('DOL_FORCE_EMAIL_TO')) {
199 $oldemail = getenv('DOL_FORCE_EMAIL_TO');
200 }
201
202 $newlangs = new Translate('', $conf);
203 $newlangs->setDefaultLang(empty($userlang) ? getDolGlobalString('MAIN_LANG_DEFAULT', 'auto') : $userlang);
204 $newlangs->load("main");
205 $newlangs->load("contracts");
206
207 if ($duration_value) {
208 if ($duration_value > 0) {
209 $title = $newlangs->transnoentities("ListOfServicesToExpireWithDuration", $duration_value);
210 } else {
211 $title = $newlangs->transnoentities("ListOfServicesToExpireWithDurationNeg", $duration_value);
212 }
213 } else {
214 $title = $newlangs->transnoentities("ListOfServicesToExpire");
215 }
216
217 $subject = getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_SUBJECT', $title);
218 $sendto = $oldemail;
219 $from = getDolGlobalString('MAIN_MAIL_EMAIL_FROM');
220 $errorsto = getDolGlobalString('MAIN_MAIL_ERRORS_TO');
221 $msgishtml = -1;
222
223 print "- Send email for ".$oldtarget." (".$oldemail."), total: ".$total."\n";
224 dol_syslog("email_expire_services_to_representatives.php: send mail to ".$oldemail);
225
226 $usehtml = 0;
227 if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER') && dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER'))) {
228 $usehtml += 1;
229 }
230 if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER') && dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER'))) {
231 $usehtml += 1;
232 }
233
234 $allmessage = '';
235 if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER')) {
236 $allmessage .= getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_HEADER');
237 } else {
238 $allmessage .= $title.($usehtml ? "<br>\n" : "\n").($usehtml ? "<br>\n" : "\n");
239 $allmessage .= $newlangs->transnoentities("NoteListOfYourExpiredServices").($usehtml ? "<br>\n" : "\n").($usehtml ? "<br>\n" : "\n");
240 }
241 $allmessage .= $message.($usehtml ? "<br>\n" : "\n");
242 $allmessage .= $langs->trans("Total")." = ".price($total, 0, $userlang, 0, 0, -1, $conf->currency).($usehtml ? "<br>\n" : "\n");
243 if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER')) {
244 $allmessage .= getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER');
245 if (dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_SALESREPRESENTATIVES_FOOTER'))) {
246 $usehtml += 1;
247 }
248 }
249
250 $mail = new CMailFile($subject, $sendto, $from, $allmessage, array(), array(), array(), '', '', 0, $msgishtml);
251
252 $mail->errors_to = $errorsto;
253
254 // Send or not email
255 if ($mode == 'confirm') {
256 $result = $mail->sendfile();
257 if (!$result) {
258 print "Error sending email ".$mail->error."\n";
259 dol_syslog("Error sending email ".$mail->error."\n");
260 }
261 } else {
262 print "No email sent (test mode)\n";
263 dol_syslog("No email sent (test mode)");
264 $mail->dump_mail();
265 $result = 1;
266 }
267
268 if ($result) {
269 return 1;
270 } else {
271 return -1;
272 }
273}
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:125
sendEmailTo($mode, $oldemail, $message, $total, $userlang, $oldtarget, $duration_value)
Send email.
dol_getmypid()
Return getmypid() or random PID when function is disabled Some web hosts disable this php function fo...
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_concatdesc($text1, $text2, $forxml=false, $invert=false)
Concat 2 descriptions with a new line between them (second operand after first one with appropriate n...
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 dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.