dolibarr  20.0.0-alpha
email_expire_services_to_customers.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 
28 if (!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();
38 if (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 
43 if (!isset($argv[1]) || !$argv[1] || !in_array($argv[1], array('test', 'confirm')) || !in_array($argv[2], array('thirdparties', 'contacts'))) {
44  print "Usage: $script_file (test|confirm) (thirdparties|contacts) [delay] [after]\n";
45  print "\n";
46  print "Send an email to customers to remind all contracts services to expire or expired.\n";
47  print "If you choose 'test' mode, no emails are sent.\n";
48  print "If you add param delay (nb of days), only services with expired date < today + delay are included.\n";
49  print "If you add param after (nb of days), only services with expired date >= today + delay are included.\n";
50  exit(1);
51 }
52 $mode = $argv[1];
53 $targettype = $argv[2];
54 
55 require $path."../../htdocs/master.inc.php";
56 require_once DOL_DOCUMENT_ROOT."/core/class/CMailFile.class.php";
57 
58 $langs->loadLangs(array('main', 'contracts'));
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);
72 print "***** ".$script_file." (".$version.") pid=".dol_getmypid()." *****\n";
73 dol_syslog($script_file." launched with arg ".join(',', $argv));
74 
75 $now = dol_now('tzserver');
76 $duration_value = isset($argv[3]) ? $argv[3] : 'none';
77 $duration_value2 = isset($argv[4]) ? $argv[4] : 'none';
78 
79 $error = 0;
80 print $script_file." launched with mode ".$mode." default lang=".$langs->defaultlang.(is_numeric($duration_value) ? " delay=".$duration_value : "").(is_numeric($duration_value2) ? " after=".$duration_value2 : "")."\n";
81 
82 if ($mode != 'confirm') {
83  $conf->global->MAIN_DISABLE_ALL_MAILS = 1;
84 }
85 
86 $sql = "SELECT c.ref, cd.date_fin_validite, cd.total_ttc, cd.description as description, p.label as plabel,";
87 $sql .= " s.rowid as sid, s.nom as name, s.email, s.default_lang";
88 if ($targettype == 'contacts') {
89  $sql .= ", sp.rowid as cid, sp.firstname as cfirstname, sp.lastname as clastname, sp.email as cemail";
90 }
91 $sql .= " FROM ".MAIN_DB_PREFIX."societe AS s";
92 if ($targettype == 'contacts') {
93  $sql .= ", ".MAIN_DB_PREFIX."socpeople as sp";
94 }
95 $sql .= ", ".MAIN_DB_PREFIX."contrat AS c";
96 $sql .= ", ".MAIN_DB_PREFIX."contratdet AS cd";
97 $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."product AS p ON p.rowid = cd.fk_product";
98 $sql .= " WHERE s.rowid = c.fk_soc AND c.rowid = cd.fk_contrat AND c.statut > 0 AND cd.statut < 5";
99 if (is_numeric($duration_value2)) {
100  $sql .= " AND cd.date_fin_validite >= '".$db->idate(dol_time_plus_duree($now, $duration_value2, "d"))."'";
101 }
102 if (is_numeric($duration_value)) {
103  $sql .= " AND cd.date_fin_validite < '".$db->idate(dol_time_plus_duree($now, $duration_value, "d"))."'";
104 }
105 if ($targettype == 'contacts') {
106  $sql .= " AND s.rowid = sp.fk_soc";
107 }
108 $sql .= " ORDER BY";
109 if ($targettype == 'contacts') {
110  $sql .= " sp.email, sp.rowid,";
111 }
112 $sql .= " s.email ASC, s.rowid ASC, cd.date_fin_validite ASC"; // Order by email to allow one message per email
113 
114 // print $sql;
115 $resql = $db->query($sql);
116 if ($resql) {
117  $num = $db->num_rows($resql);
118  $i = 0;
119  $oldemail = 'none';
120  $oldsid = 0;
121  $oldcid = 0;
122  $oldlang = '';
123  $total = 0;
124  $foundtoprocess = 0;
125  $trackthirdpartiessent = array();
126 
127  print "We found ".$num." couples (services to expire-".$targettype.") qualified\n";
128  dol_syslog("We found ".$num." couples (services to expire-".$targettype.") qualified");
129  $message = '';
130  $oldtarget = '';
131 
132  if ($num) {
133  while ($i < $num) {
134  $obj = $db->fetch_object($resql);
135 
136  $newemail = empty($obj->cemail) ? $obj->email : $obj->cemail;
137 
138  // Check if this record is a break after previous one
139  $startbreak = false;
140  if ($newemail != $oldemail || $oldemail == 'none') {
141  $startbreak = true;
142  }
143  if ($obj->sid && $obj->sid != $oldsid) {
144  $startbreak = true;
145  }
146  if ($targettype == 'contacts') {
147  if ($obj->cid && $obj->cid != $oldcid) {
148  $startbreak = true;
149  }
150  }
151 
152  if ($startbreak) {
153  // Break onto sales representative (new email or cid)
154  if (dol_strlen($oldemail) && $oldemail != 'none' && empty($trackthirdpartiessent[$oldsid.'|'.$oldemail])) {
155  sendEmailTo($mode, $oldemail, $message, $total, $oldlang, $oldtarget, $duration_value);
156  $trackthirdpartiessent[$oldsid.'|'.$oldemail] = 'contact id '.$oldcid;
157  } else {
158  if ($oldemail != 'none') {
159  if (empty($trackthirdpartiessent[$oldsid.'|'.$oldemail])) {
160  print "- No email sent for '".$oldtarget."', total: ".$total."\n";
161  } else {
162  print "- No email sent for '".$oldtarget."', total: ".$total." (already sent to ".$trackthirdpartiessent[$oldsid.'|'.$oldemail].")\n";
163  }
164  }
165  }
166  $oldemail = $newemail;
167  $oldsid = $obj->sid;
168  if ($targettype == 'contacts') {
169  $oldcid = $obj->cid;
170  }
171  $oldlang = $obj->default_lang;
172  $oldtarget = (empty($obj->cfirstname) && empty($obj->clastname)) ? $obj->name : ($obj->clastname." ".$obj->cfirstname);
173  $message = '';
174  $total = 0;
175  $foundtoprocess = 0;
176  // if (empty($newemail)) print "Warning: Customer ".$target." has no email. Notice disabled.\n";
177  }
178 
179  // Define line content
180  $outputlangs = new Translate('', $conf);
181  $outputlangs->setDefaultLang(empty($obj->default_lang) ? $langs->defaultlang : $obj->default_lang); // By default language of customer
182 
183  // Load translation files required by the page
184  $outputlangs->loadLangs(array("main", "contracts", "bills", "products"));
185 
186  if (dol_strlen($newemail)) {
187  $message .= $outputlangs->trans("Contract")." ".$obj->ref.": ".$outputlangs->trans("Service")." ".dol_concatdesc($obj->plabel, $obj->description)." (".price($obj->total_ttc, 0, $outputlangs, 0, 0, -1, $conf->currency)."), ".$outputlangs->trans("DateEndPlannedShort")." ".dol_print_date($db->jdate($obj->date_fin_validite), 'day')."\n\n";
188  dol_syslog("email_expire_services_to_customers.php: ".$newemail." ".$message);
189  $foundtoprocess++;
190  }
191  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').", customer id ".$obj->sid." ".$obj->name.", ".(isset($obj->cid) ? "contact id ".$obj->cid." ".$obj->clastname." ".$obj->cfirstname.", " : "")."email ".$newemail.", lang ".$outputlangs->defaultlang.": ";
192  if (dol_strlen($newemail)) {
193  print "qualified.";
194  } else {
195  print "disqualified (no email).";
196  }
197  print "\n";
198 
199  unset($outputlangs);
200 
201  $total += $obj->total_ttc;
202 
203  $i++;
204  }
205 
206  // Si il reste des envois en buffer
207  if ($foundtoprocess) {
208  if (dol_strlen($oldemail) && $oldemail != 'none' && empty($trackthirdpartiessent[$oldsid.'|'.$oldemail])) { // Break onto email (new email)
209  sendEmailTo($mode, $oldemail, $message, $total, $oldlang, $oldtarget, $duration_value);
210  $trackthirdpartiessent[$oldsid.'|'.$oldemail] = 'contact id '.$oldcid;
211  } else {
212  if ($oldemail != 'none') {
213  if (empty($trackthirdpartiessent[$oldsid.'|'.$oldemail])) {
214  print "- No email sent for '".$oldtarget."', total: ".$total."\n";
215  } else {
216  print "- No email sent for '".$oldtarget."', total: ".$total." (already sent to ".$trackthirdpartiessent[$oldsid.'|'.$oldemail].")\n";
217  }
218  }
219  }
220  }
221  } else {
222  print "No services to expire found\n";
223  }
224 
225  exit(0);
226 } else {
227  dol_print_error($db);
228  dol_syslog("email_expire_services_to_customers.php: Error");
229 
230  exit(1);
231 }
232 
245 function sendEmailTo($mode, $oldemail, $message, $total, $userlang, $oldtarget, $duration_value)
246 {
247  global $conf, $langs;
248 
249  if (getenv('DOL_FORCE_EMAIL_TO')) {
250  $oldemail = getenv('DOL_FORCE_EMAIL_TO');
251  }
252 
253  $newlangs = new Translate('', $conf);
254  $newlangs->setDefaultLang(empty($userlang) ? getDolGlobalString('MAIN_LANG_DEFAULT', 'auto') : $userlang);
255  $newlangs->load("main");
256  $newlangs->load("contracts");
257 
258  if ($duration_value) {
259  if ($duration_value > 0) {
260  $title = $newlangs->transnoentities("ListOfServicesToExpireWithDuration", $duration_value);
261  } else {
262  $title = $newlangs->transnoentities("ListOfServicesToExpireWithDurationNeg", $duration_value);
263  }
264  } else {
265  $title = $newlangs->transnoentities("ListOfServicesToExpire");
266  }
267 
268  $subject = getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_SUBJECT', $title);
269  $sendto = $oldemail;
270  $from = getDolGlobalString('MAIN_MAIL_EMAIL_FROM');
271  $errorsto = getDolGlobalString('MAIN_MAIL_ERRORS_TO');
272  $msgishtml = -1;
273 
274  print "- Send email to '".$oldtarget."' (".$oldemail."), total: ".$total."\n";
275  dol_syslog("email_expire_services_to_customers.php: send mail to ".$oldemail);
276 
277  $usehtml = 0;
278  if (dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_FOOTER'))) {
279  $usehtml += 1;
280  }
281  if (dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_HEADER'))) {
282  $usehtml += 1;
283  }
284 
285  $allmessage = '';
286  if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_HEADER')) {
287  $allmessage .= getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_HEADER');
288  } else {
289  $allmessage .= "Dear customer".($usehtml ? "<br>\n" : "\n").($usehtml ? "<br>\n" : "\n");
290  $allmessage .= "Please, find a summary of the services contracted by you that are about to expire.".($usehtml ? "<br>\n" : "\n").($usehtml ? "<br>\n" : "\n");
291  }
292  $allmessage .= $message.($usehtml ? "<br>\n" : "\n");
293  // $allmessage.= $langs->trans("Total")." = ".price($total,0,$userlang,0,0,-1,$conf->currency).($usehtml?"<br>\n":"\n");
294  if (getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_FOOTER')) {
295  $allmessage .= getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_FOOTER');
296  if (dol_textishtml(getDolGlobalString('SCRIPT_EMAIL_EXPIRE_SERVICES_CUSTOMERS_FOOTER'))) {
297  $usehtml += 1;
298  }
299  }
300 
301  $mail = new CMailFile($subject, $sendto, $from, $allmessage, array(), array(), array(), '', '', 0, $msgishtml);
302 
303  $mail->errors_to = $errorsto;
304 
305  // Send or not email
306  if ($mode == 'confirm') {
307  $result = $mail->sendfile();
308  if (!$result) {
309  print "Error sending email ".$mail->error."\n";
310  dol_syslog("Error sending email ".$mail->error."\n");
311  }
312  } else {
313  print "No email sent (test mode)\n";
314  dol_syslog("No email sent (test mode)");
315  $mail->dump_mail();
316  $result = 1;
317  }
318 
319  unset($newlangs);
320  if ($result) {
321  return 1;
322  } else {
323  return -1;
324  }
325 }
Class to send emails (with attachments or not) Usage: $mailfile = new CMailFile($subject,...
Class to manage translations.
if(isModEnabled('invoice') && $user->hasRight('facture', 'lire')) if((isModEnabled('fournisseur') &&!getDolGlobalString('MAIN_USE_NEW_SUPPLIERMOD') && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') && $user->hasRight('don', 'lire')) if(isModEnabled('tax') && $user->hasRight('tax', 'charges', 'lire')) if(isModEnabled('invoice') &&isModEnabled('order') && $user->hasRight("commande", "lire") &&!getDolGlobalString('WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER')) $sql
Social contributions to pay.
Definition: index.php:744
dol_time_plus_duree($time, $duration_value, $duration_unit, $ruleforendofmonth=0)
Add a delay to a date.
Definition: date.lib.php:123
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).
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.
if(!defined( 'CSRFCHECK_WITH_TOKEN'))