26if (!defined(
'NOSESSION')) {
27 define(
'NOSESSION',
'1');
30$sapi_type = php_sapi_name();
31$script_file = basename(__FILE__);
35if (substr($sapi_type, 0, 3) ==
'cgi') {
36 echo
"Error: You are using PHP for CGI. To execute ".$script_file.
" from command line, you must use PHP for CLI mode.\n";
41require_once $path.
"../../htdocs/master.inc.php";
43require_once DOL_DOCUMENT_ROOT.
"/compta/facture/class/facture.class.php";
44require_once DOL_DOCUMENT_ROOT.
"/core/modules/facture/modules_facture.php";
45require_once DOL_DOCUMENT_ROOT.
"/core/lib/date.lib.php";
46require_once DOL_DOCUMENT_ROOT.
'/core/lib/invoice2.lib.php';
52$version = DOL_VERSION;
55$hookmanager->initHooks(array(
'cli'));
63print
"***** ".$script_file.
" (".$version.
") pid=".
dol_getmypid().
" *****\n";
64dol_syslog($script_file.
" launched with arg ".join(
',', $argv));
67if (!isset($argv[1])) {
72if (!empty($dolibarr_main_db_readonly)) {
73 print
"Error: instance in read-onyl mode\n";
77$diroutputpdf = $conf->facture->dir_output.
'/temp';
82$fileprefix =
'mergedpdf';
85$paymentdateafter =
'';
86$paymentdatebefore =
'';
90foreach ($argv as $key => $value) {
94 if (preg_match(
'/^lang=/i', $value)) {
96 $valarray = explode(
'=', $value);
97 $newlangid = $valarray[1];
98 print
'Use language '.$newlangid.
".\n";
100 if (preg_match(
'/^prefix=/i', $value)) {
102 $valarray = explode(
'=', $value);
103 $fileprefix = $valarray[1];
104 print
'Use prefix for filename '.$fileprefix.
".\n";
107 if (preg_match(
'/^regenerate=(.*)/i', $value, $reg)) {
108 if (!in_array($reg[1], array(
'',
'0',
'no'))) {
110 $regenerate = $reg[1];
111 print
'Regeneration of PDF is requested with template '.$regenerate.
"\n";
115 if ($value ==
'filter=all') {
117 $option .= (empty($option) ?
'' :
'_').
'all';
120 print
'Rebuild PDF for all invoices'.
"\n";
123 if ($value ==
'filter=date') {
125 $option .= (empty($option) ?
'' :
'_').
'date_'.$argv[$key + 1].
'_'.$argv[$key + 2];
130 print
'Rebuild PDF for invoices validated between '.dol_print_date($dateafterdate,
'day',
'gmt').
" and ".
dol_print_date($datebeforedate,
'day',
'gmt').
".\n";
133 if ($value ==
'filter=payments') {
135 $option .= (empty($option) ?
'' :
'_').
'payments_'.$argv[$key + 1].
'_'.$argv[$key + 2];
136 $filter[] =
'payments';
140 if (empty($paymentdateafter) || empty($paymentdatebefore)) {
141 print
'Error: Bad date format or value'.
"\n";
144 print
'Rebuild PDF for invoices with at least one payment between '.dol_print_date($paymentdateafter,
'day',
'gmt').
" and ".
dol_print_date($paymentdatebefore,
'day',
'gmt').
".\n";
147 if ($value ==
'filter=nopayment') {
149 $option .= (empty($option) ?
'' :
'_').
'nopayment';
150 $filter[] =
'nopayment';
152 print
'Rebuild PDF for invoices with no payment done yet.'.
"\n";
155 if ($value ==
'filter=bank') {
157 $option .= (empty($option) ?
'' :
'_').
'bank_'.$argv[$key + 1];
160 $paymentonbankref = $argv[$key + 1];
161 $bankaccount =
new Account($db);
162 $result = $bankaccount->fetch(0, $paymentonbankref);
164 print
'Error: Bank account with ref "'.$paymentonbankref.
'" not found'.
"\n";
167 $paymentonbankid = $bankaccount->id;
168 print
'Rebuild PDF for invoices with at least one payment on financial account '.$bankaccount->ref.
"\n";
171 if ($value ==
'filter=nodeposit') {
173 $option .= (empty($option) ?
'' :
'_').
'nodeposit';
174 $filter[] =
'nodeposit';
176 print
'Exclude deposit invoices'.
"\n";
178 if ($value ==
'filter=noreplacement') {
180 $option .= (empty($option) ?
'' :
'_').
'noreplacement';
181 $filter[] =
'noreplacement';
183 print
'Exclude replacement invoices'.
"\n";
185 if ($value ==
'filter=nocreditnote') {
187 $option .= (empty($option) ?
'' :
'_').
'nocreditnote';
188 $filter[] =
'nocreditnote';
190 print
'Exclude credit note invoices'.
"\n";
193 if ($value ==
'filter=excludethirdparties') {
195 $filter[] =
'excludethirdparties';
197 $thirdpartiesid = explode(
',', $argv[$key + 1]);
198 print
'Exclude thirdparties with id in list ('.join(
',', $thirdpartiesid).
").\n";
200 $option .= (empty($option) ?
'' :
'_').
'excludethirdparties'.join(
'-', $thirdpartiesid);
202 if ($value ==
'filter=onlythirdparties') {
204 $filter[] =
'onlythirdparties';
206 $thirdpartiesid = explode(
',', $argv[$key + 1]);
207 print
'Only thirdparties with id in list ('.join(
',', $thirdpartiesid).
").\n";
209 $option .= (empty($option) ?
'' :
'_').
'onlythirdparty'.join(
'-', $thirdpartiesid);
212 if (!$found && preg_match(
'/filter=/i', $value)) {
219if (empty($option) && count($filter) <= 0) {
224if (in_array(
'payments', $filter) && in_array(
'nopayment', $filter)) {
228if (in_array(
'bank', $filter) && in_array(
'nopayment', $filter)) {
235$result =
rebuild_merge_pdf($db, $langs, $conf, $diroutputpdf, $newlangid, $filter, $dateafterdate, $datebeforedate, $paymentdateafter, $paymentdatebefore, 1, $regenerate, $option, $paymentonbankid, $thirdpartiesid, $fileprefix);
241 print
'--- end ok'.
"\n";
244 print
'--- end error code='.$error.
"\n";
260 print
"Rebuild PDF files for some invoices and merge PDF files into one.\n";
262 print
"To build/merge PDF for invoices in a date range:\n";
263 print
"Usage: ".$script_file.
" filter=date dateafter datebefore\n";
264 print
"To build/merge PDF for invoices with at least one payment in a date range:\n";
265 print
"Usage: ".$script_file.
" filter=payments dateafter datebefore\n";
266 print
"To build/merge PDF for invoices with at least one payment onto a bank account:\n";
267 print
"Usage: ".$script_file.
" filter=bank bankref\n";
268 print
"To build/merge PDF for all invoices, use filter=all\n";
269 print
"Usage: ".$script_file.
" filter=all\n";
270 print
"To build/merge PDF for invoices with no payments, use filter=nopayment\n";
271 print
"Usage: ".$script_file.
" filter=nopayment\n";
272 print
"To exclude credit notes, use filter=nocreditnote\n";
273 print
"To exclude replacement invoices, use filter=noreplacement\n";
274 print
"To exclude deposit invoices, use filter=nodeposit\n";
275 print
"To exclude some thirdparties, use filter=excludethirdparties id1,id2...\n";
276 print
"To limit to some thirdparties, use filter=onlythirdparties id1,id2...\n";
277 print
"To regenerate existing PDF, use regenerate=templatename\n";
278 print
"To generate invoices in a language, use lang=xx_XX\n";
279 print
"To set prefix of generated file name, use prefix=myfileprefix\n";
281 print
"Example: ".$script_file.
" filter=payments 20080101 20081231 lang=fr_FR regenerate=crabe\n";
282 print
"Example: ".$script_file.
" filter=all lang=en_US\n";
284 print
"Note that some filters can be cumulated.\n";
Class to manage bank accounts.
dol_stringtotime($string, $gm=1)
Convert a string date into a GM Timestamps date Warning: YYYY-MM-DDTHH:MM:SS+02:00 (RFC3339) is not s...
dol_getmypid()
Return getmypid() or random PID when function is disabled Some web hosts disable this php function fo...
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_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
rebuild_merge_pdf($db, $langs, $conf, $diroutputpdf, $newlangid, $filter, $dateafterdate, $datebeforedate, $paymentdateafter, $paymentdatebefore, $usestdout, $regenerate=0, $filesuffix='', $paymentbankid='', $thirdpartiesid=[], $fileprefix='mergedpdf')
Function to build a compiled PDF.
rebuild_merge_pdf_usage()
Show usage of script.