dolibarr 18.0.6
rebuild_merge_pdf.php
Go to the documentation of this file.
1#!/usr/bin/env php
2<?php
3/*
4 * Copyright (C) 2009-2012 Laurent Destailleur <eldy@users.sourceforge.net>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
26if (!defined('NOSESSION')) {
27 define('NOSESSION', '1');
28}
29
30$sapi_type = php_sapi_name();
31$script_file = basename(__FILE__);
32$path = __DIR__.'/';
33
34// Test if batch mode
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";
37 exit(-1);
38}
39
40// Include Dolibarr environment
41require_once $path."../../htdocs/master.inc.php";
42// After this $db is an opened handler to database. We close it at end of file.
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';
47
48// Load main language strings
49$langs->load("main");
50
51// Global variables
52$version = DOL_VERSION;
53$error = 0;
54
55
56/*
57 * Main
58 */
59
60@set_time_limit(0);
61print "***** ".$script_file." (".$version.") pid=".dol_getmypid()." *****\n";
62dol_syslog($script_file." launched with arg ".join(',', $argv));
63
64// Check parameters
65if (!isset($argv[1])) {
67 exit(-1);
68}
69
70if (!empty($dolibarr_main_db_readonly)) {
71 print "Error: instance in read-onyl mode\n";
72 exit(-1);
73}
74
75$diroutputpdf = $conf->facture->dir_output.'/temp';
76$newlangid = 'en_EN'; // To force a new lang id
77$filter = array();
78$regenerate = ''; // Ask regenerate (contains name of model to use)
79$option = '';
80$fileprefix = 'mergedpdf';
81$dateafterdate = '';
82$datebeforedate = '';
83$paymentdateafter = '';
84$paymentdatebefore = '';
85$paymentonbankid = 0;
86$thirdpartiesid = 0;
87
88foreach ($argv as $key => $value) {
89 $found = false;
90
91 // Define options
92 if (preg_match('/^lang=/i', $value)) {
93 $found = true;
94 $valarray = explode('=', $value);
95 $newlangid = $valarray[1];
96 print 'Use language '.$newlangid.".\n";
97 }
98 if (preg_match('/^prefix=/i', $value)) {
99 $found = true;
100 $valarray = explode('=', $value);
101 $fileprefix = $valarray[1];
102 print 'Use prefix for filename '.$fileprefix.".\n";
103 }
104
105 if (preg_match('/^regenerate=(.*)/i', $value, $reg)) {
106 if (!in_array($reg[1], array('', '0', 'no'))) {
107 $found = true;
108 $regenerate = $reg[1];
109 print 'Regeneration of PDF is requested with template '.$regenerate."\n";
110 }
111 }
112
113 if ($value == 'filter=all') {
114 $found = true;
115 $option .= (empty($option) ? '' : '_').'all';
116 $filter[] = 'all';
117
118 print 'Rebuild PDF for all invoices'."\n";
119 }
120
121 if ($value == 'filter=date') {
122 $found = true;
123 $option .= (empty($option) ? '' : '_').'date_'.$argv[$key + 1].'_'.$argv[$key + 2];
124 $filter[] = 'date';
125
126 $dateafterdate = dol_stringtotime($argv[$key + 1]);
127 $datebeforedate = dol_stringtotime($argv[$key + 2]);
128 print 'Rebuild PDF for invoices validated between '.dol_print_date($dateafterdate, 'day', 'gmt')." and ".dol_print_date($datebeforedate, 'day', 'gmt').".\n";
129 }
130
131 if ($value == 'filter=payments') {
132 $found = true;
133 $option .= (empty($option) ? '' : '_').'payments_'.$argv[$key + 1].'_'.$argv[$key + 2];
134 $filter[] = 'payments';
135
136 $paymentdateafter = dol_stringtotime($argv[$key + 1].'000000');
137 $paymentdatebefore = dol_stringtotime($argv[$key + 2].'235959');
138 if (empty($paymentdateafter) || empty($paymentdatebefore)) {
139 print 'Error: Bad date format or value'."\n";
140 exit(-1);
141 }
142 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";
143 }
144
145 if ($value == 'filter=nopayment') {
146 $found = true;
147 $option .= (empty($option) ? '' : '_').'nopayment';
148 $filter[] = 'nopayment';
149
150 print 'Rebuild PDF for invoices with no payment done yet.'."\n";
151 }
152
153 if ($value == 'filter=bank') {
154 $found = true;
155 $option .= (empty($option) ? '' : '_').'bank_'.$argv[$key + 1];
156 $filter[] = 'bank';
157
158 $paymentonbankref = $argv[$key + 1];
159 $bankaccount = new Account($db);
160 $result = $bankaccount->fetch(0, $paymentonbankref);
161 if ($result <= 0) {
162 print 'Error: Bank account with ref "'.$paymentonbankref.'" not found'."\n";
163 exit(-1);
164 }
165 $paymentonbankid = $bankaccount->id;
166 print 'Rebuild PDF for invoices with at least one payment on financial account '.$bankaccount->ref."\n";
167 }
168
169 if ($value == 'filter=nodeposit') {
170 $found = true;
171 $option .= (empty($option) ? '' : '_').'nodeposit';
172 $filter[] = 'nodeposit';
173
174 print 'Exclude deposit invoices'."\n";
175 }
176 if ($value == 'filter=noreplacement') {
177 $found = true;
178 $option .= (empty($option) ? '' : '_').'noreplacement';
179 $filter[] = 'noreplacement';
180
181 print 'Exclude replacement invoices'."\n";
182 }
183 if ($value == 'filter=nocreditnote') {
184 $found = true;
185 $option .= (empty($option) ? '' : '_').'nocreditnote';
186 $filter[] = 'nocreditnote';
187
188 print 'Exclude credit note invoices'."\n";
189 }
190
191 if ($value == 'filter=excludethirdparties') {
192 $found = true;
193 $filter[] = 'excludethirdparties';
194
195 $thirdpartiesid = explode(',', $argv[$key + 1]);
196 print 'Exclude thirdparties with id in list ('.join(',', $thirdpartiesid).").\n";
197
198 $option .= (empty($option) ? '' : '_').'excludethirdparties'.join('-', $thirdpartiesid);
199 }
200 if ($value == 'filter=onlythirdparties') {
201 $found = true;
202 $filter[] = 'onlythirdparties';
203
204 $thirdpartiesid = explode(',', $argv[$key + 1]);
205 print 'Only thirdparties with id in list ('.join(',', $thirdpartiesid).").\n";
206
207 $option .= (empty($option) ? '' : '_').'onlythirdparty'.join('-', $thirdpartiesid);
208 }
209
210 if (!$found && preg_match('/filter=/i', $value)) {
212 exit(-1);
213 }
214}
215
216// Check if an option and a filter has been provided
217if (empty($option) && count($filter) <= 0) {
219 exit(-1);
220}
221// Check if there is no uncompatible choice
222if (in_array('payments', $filter) && in_array('nopayment', $filter)) {
224 exit(-1);
225}
226if (in_array('bank', $filter) && in_array('nopayment', $filter)) {
228 exit(-1);
229}
230
231// Define SQL and SQL request to select invoices
232// Use $filter, $dateafterdate, datebeforedate, $paymentdateafter, $paymentdatebefore
233$result = rebuild_merge_pdf($db, $langs, $conf, $diroutputpdf, $newlangid, $filter, $dateafterdate, $datebeforedate, $paymentdateafter, $paymentdatebefore, 1, $regenerate, $option, $paymentonbankid, $thirdpartiesid, $fileprefix);
234
235// -------------------- END OF YOUR CODE --------------------
236
237if ($result >= 0) {
238 $error = 0;
239 print '--- end ok'."\n";
240} else {
241 $error = $result;
242 print '--- end error code='.$error."\n";
243}
244
245$db->close();
246
247exit($error);
248
255{
256 global $script_file;
257
258 print "Rebuild PDF files for some invoices and merge PDF files into one.\n";
259 print "\n";
260 print "To build/merge PDF for invoices in a date range:\n";
261 print "Usage: ".$script_file." filter=date dateafter datebefore\n";
262 print "To build/merge PDF for invoices with at least one payment in a date range:\n";
263 print "Usage: ".$script_file." filter=payments dateafter datebefore\n";
264 print "To build/merge PDF for invoices with at least one payment onto a bank account:\n";
265 print "Usage: ".$script_file." filter=bank bankref\n";
266 print "To build/merge PDF for all invoices, use filter=all\n";
267 print "Usage: ".$script_file." filter=all\n";
268 print "To build/merge PDF for invoices with no payments, use filter=nopayment\n";
269 print "Usage: ".$script_file." filter=nopayment\n";
270 print "To exclude credit notes, use filter=nocreditnote\n";
271 print "To exclude replacement invoices, use filter=noreplacement\n";
272 print "To exclude deposit invoices, use filter=nodeposit\n";
273 print "To exclude some thirdparties, use filter=excludethirdparties id1,id2...\n";
274 print "To limit to some thirdparties, use filter=onlythirdparties id1,id2...\n";
275 print "To regenerate existing PDF, use regenerate=templatename\n";
276 print "To generate invoices in a language, use lang=xx_XX\n";
277 print "To set prefix of generated file name, use prefix=myfileprefix\n";
278 print "\n";
279 print "Example: ".$script_file." filter=payments 20080101 20081231 lang=fr_FR regenerate=crabe\n";
280 print "Example: ".$script_file." filter=all lang=en_US\n";
281 print "\n";
282 print "Note that some filters can be cumulated.\n";
283}
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...
Definition date.lib.php:409
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='', $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.