source: spip-zone/_plugins_/spipdf/spipdf.php @ 65475

Last change on this file since 65475 was 65475, checked in by cedric@…, 7 years ago

indentation

File size: 13.6 KB
Line 
1<?php
2
3/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 ff=unix fenc=utf8: */
4
5/**
6 * Génération d'article SPIP au format PDF
7 *
8 * @package      spiPDF
9 * @author       Yves Tannier [grafactory.net]
10 * @copyright    2010 Yves Tannier
11 * @link         http://www.spip-contrib.net/spiPDF-generer-des-contenus-sur-mesure-en-PDF
12 * @link         http://zone.spip.org/trac/spip-zone/browser/_plugins_/spipdf
13 * @link         http://www.grafactory.net/
14 * @license      GPL Gnu Public Licence
15 * @version      0.2
16 */
17
18// Options pour les marges des PDF, valables seulement pour la librairie mPDF
19// définissez vos options par défaut directement dans votre mes_options.php
20if (!defined('_SPIPDF_FORMAT')){
21        define('_SPIPDF_FORMAT', 'A4');
22}
23if (!defined('_SPIPDF_MARGIN_TOP')){
24        define('_SPIPDF_MARGIN_TOP', 20);
25}
26if (!defined('_SPIPDF_MARGIN_RIGHT')){
27        define('_SPIPDF_MARGIN_RIGHT', 20);
28}
29if (!defined('_SPIPDF_MARGIN_BOTTOM')){
30        define('_SPIPDF_MARGIN_BOTTOM', 15);
31}
32if (!defined('_SPIPDF_MARGIN_LEFT')){
33        define('_SPIPDF_MARGIN_LEFT', 15);
34}
35if (!defined('_SPIPDF_MARGIN_HEADER')){
36        define('_SPIPDF_MARGIN_HEADER', 2);
37}
38if (!defined('_SPIPDF_MARGIN_FOOTER')){
39        define('_SPIPDF_MARGIN_FOOTER', 2);
40}
41
42// Charset (qui peut être défini dans un fichier d'options
43if (!defined('SPIPDF_CHARSET')){
44        define('SPIPDF_CHARSET', 'UTF-8');
45        //define('SPIPDF_CHARSET', 'ISO-8859-15');
46}
47
48// utilisé pour le constructeur de HTML2PDF
49if (SPIPDF_CHARSET=='UTF-8'){
50        define('SPIPDF_UNICODE', true);
51} else {
52        define('SPIPDF_UNICODE', false);
53}
54
55// les librairies necessaires doivent-être dans "lib". A la racine ou dans le répertoire du plugin
56if (!defined('_DIR_LIB')){
57        define('_DIR_LIB', _DIR_RACINE . 'lib/');
58}
59
60// pour les function unicode2charset
61include_spip('inc/charsets');
62
63// repris dans le plugin article_pdf => a modifier
64// http://zone.spip.org/trac/spip-zone/browser/_plugins_/article_pdf
65function spipdf_first_clean($texte){
66
67        // supprimer les remarques HTML (du Couteau Suisse ?)
68        $texte = preg_replace(',<!-- .* -->,msU', '', $texte);
69
70        $trans = array();
71        $trans["<br />\n"] = '<BR>'; // Pour éviter que le \n ne se tranforme en espace dans les <DIV class=spip_code> (TT, tag SPIP : code)
72
73        // gestion d'un encodage latin1
74        if (SPIPDF_CHARSET=='ISO-8859-15' || SPIPDF_CHARSET=='iso-8859-15'){
75                $trans['&#176;'] = '°';
76                $trans["&#339;"] = 'oe';
77                $trans["&#8211;"] = '-';
78                $trans["&#8216;"] = '\'';
79                $trans["&#8217;"] = '\'';
80                $trans["&#8220;"] = '"';
81                $trans["&#8221;"] = '"';
82                $trans["&#8230;"] = '...';
83                $trans["&#8364;"] = 'Euros';
84                $trans["&ucirc;"] = "û";
85                $trans['->'] = '-»';
86                $trans['<-'] = '«-';
87                $trans['&mdash;'] = '-';
88                $trans['&deg;'] = '°';
89                $trans['œ'] = 'oe';
90                $trans['Œ'] = 'OE';
91                $trans['…'] = '...';
92                $trans['&euro;'] = 'Euros';
93                $trans['€'] = 'Euros';
94                $trans['&copy;'] = '©';
95        }
96        // pas d'insécable
97        $trans['&nbsp;'] = ' ';
98
99        // certains titles font paniquer l'analyse
100        // TODO : a peaufiner car ils sont necessaires pour les signets
101        // <bookmark title="Compatibilité" level="0" ></bookmark>
102        // http://wiki.spipu.net/doku.php?id=html2pdf:fr:v4:bookmark
103        //$texte = preg_replace(',title=".*",msU', 'title=""', $texte);
104
105        $texte = strtr($texte, $trans);
106        if (SPIPDF_CHARSET=='UTF-8'){
107                $texte = charset2unicode($texte);
108        } else {
109                $texte = unicode2charset(charset2unicode($texte), SPIPDF_CHARSET); // Repasser tout dans le charset demandé
110        }
111
112        // Décoder les codes HTML dans le charset final
113        $texte = html_entity_decode($texte, ENT_NOQUOTES, SPIPDF_CHARSET);
114
115        return $texte;
116}
117
118
119function spipdf_nettoyer_html($html, $params_pdf = array()){
120
121        // supprimer les spans autour des images et récupérer le placement
122        $patterns_float = '/<span class=\'spip_document_.*spip_documents.*float:(.*);.*>(.*)<\/span>/iUms';
123        if (!empty($params_pdf['float'])){
124                //function remplaceSpan($matches) { return str_replace('img', 'img style="padding:5px;" style="float:'.$matches[1].'"', $matches[2]); }
125                function remplaceSpan($matches){
126                        return str_replace('img', 'img style="padding:5px;" class="pdf_img_float_' . $matches[1] . '"', $matches[2]);
127                }
128        } else {
129                function remplaceSpan($matches){
130                        return str_replace('img', 'img style="padding:5px;" align="' . $matches[1] . '"', $matches[2]);
131                }
132        }
133        $html = preg_replace_callback($patterns_float, 'remplaceSpan', $html);
134
135        // supprimer les spans autour des images
136        $patterns_float = '/<span class=\'spip_document_.*spip_documents.*>(.*)<\/span>/iUms';
137        function remplaceSpanCenter($matches){
138                return $matches[1];
139        }
140
141        $html = preg_replace_callback($patterns_float, 'remplaceSpanCenter', $html);
142
143        // supprimer les dl autour des images et récupérer le placement
144        $patterns_float = '/<dl class=\'spip_document_.*spip_documents.*float:(.*);.*<dt>(.*)<\/dt>.*<\/dl>/iUms';
145        if (!empty($params_pdf['float'])){
146                //function remplaceDt($matches) { return str_replace('img', 'img style="padding:5px;" style="float:'.$matches[1].'"', $matches[2]); }
147                function remplaceDt($matches){
148                        return str_replace('img', 'img style="padding:5px;" class="pdf_img_float_' . $matches[1] . '"', $matches[2]);
149                }
150        } else {
151                function remplaceDt($matches){
152                        return str_replace('img', 'img style="padding:5px;" align="' . $matches[1] . '"', $matches[2]);
153                }
154        }
155        $html = preg_replace_callback($patterns_float, 'remplaceDt', $html);
156
157        // replacer id par name pour les notes
158        $patterns_note = '/<a.*href.*class=\'spip_note\'.*>/iUms';
159        function remplaceIdParName($matches){
160                return str_replace('id=\'', 'name=\'', $matches[0]);
161        }
162
163        $html = preg_replace_callback($patterns_note, 'remplaceIdParName', $html);
164
165        // float sur les puces graphiques TODO
166        $patterns_puce = '/<a.*href.*class=\'puce\'.*>/iUms';
167        function remplaceFloatPuce($matches){
168                return str_replace('style=\'', 'style=\'float:left;', $matches[0]);
169        }
170
171        //$html = preg_replace_callback($patterns_puce, 'remplaceFloatPuce', $html);
172        //img src="local/cache-vignettes/L8xH11/puce-32883.gif" class="puce" alt="-" style="height: 11px; width: 8px;" height="11" width="8">
173
174        // supprimer les dl autour des images centrer
175        $patterns_float = '/<dl class=\'spip_document_.*spip_documents.*<dt>(.*)<\/dt>.*<\/dl>/iUms';
176        function remplaceDtCenter($matches){
177                return $matches[1];
178        }
179
180        $html = preg_replace_callback($patterns_float, 'remplaceDtCenter', $html);
181
182        // remplacer les captions
183        if (!empty($params_pdf['caption'])){
184                $patterns_caption = '/<table(.*)<caption>(.*)<\/caption>(.*)<\/table>/iUms';
185                function remplaceCaption($matches){
186                        $table = '<table style="border:none;"' . $matches[1] . '<tr><td style="text-align: center;border:none;">' . $matches[2] . '</td></tr>';
187                        $table .= '<tr><td style="border:none;">';
188                        $table .= '<table' . $matches[1] . $matches[3] . '</table>';
189                        $table .= '</td></tr></table>';
190                        return $table;
191                }
192
193                $html = preg_replace_callback($patterns_caption, 'remplaceCaption', $html);
194        }
195
196        // tableaux centré
197        $html = preg_replace('/<table/iUms', '<table align="center"', $html);
198
199        // gestion des caractères spéciaux et de charset
200        $html = spipdf_first_clean($html);
201
202        return $html;
203
204}
205
206// traiter la balise page
207function traite_balise_page($html){
208
209        // on teste la balise page
210        if (preg_match('/<page(.*)>/iUms', $html, $matches)){
211                // on crée un tableau avec (beurk) Global pour accèder aux valeurs de pages
212                if (!empty($matches[1])){
213                        $balise_page = $matches[1];
214                        $pattern = '/(.*)="(.*)"/iUms';
215                        function getBalise($matches){
216                                $matches[2] = str_replace('mm', '', $matches[2]);
217                                $GLOBALS['valeurs_page'][trim($matches[1])] = trim($matches[2]);
218                        }
219
220                        $balise_page = preg_replace_callback($pattern, 'getBalise', $balise_page);
221
222                        // supprimer <page> et </page>
223                        $html = preg_replace('/<\/?page(.*)>/iUms', '', $html);
224
225                        return $html;
226                }
227
228        } else {
229                return $html;
230        }
231
232}
233
234// supprimer le puces graphiques (d'après le plugin couteau suisse)
235function spipdf_pre_typo($texte){
236        return preg_replace('/^-\s*(?![-*#])/m', '-* ', $texte);
237}
238
239// traitement principal. avec ce pipeline, le PDF est mis en cache et recalculé "normalement"
240function spipdf_recuperer_fond($flux){
241
242        // Le squelette est-il appelé par spipdf.html
243        if ($flux['args']['contexte']['html2pdf']=='oui'){
244
245                // récupérer le contenu et le nettoyer pour la génération
246                $html = $flux['data']['texte'];
247
248                // les librairies possibles
249                $possible_librairies = array(
250                        'mpdf' => array( // gére le float d'image mais pas les captions de tableau
251                                'float' => true,
252                                'caption' => true,
253                                'traite_balise_page' => true
254                        ),
255                        'html2pdf' => array( // ne gére pas le float d'image et les captions
256                                'float' => false,
257                                'caption' => true
258                        ),
259                        'dompdf' => array( // domPDF beta 0.6 EXPERIMENTAL
260                                'float' => false,
261                                'caption' => true,
262                                'traite_balise_page' => true
263                        ),
264                );
265
266                // choix de la classe de génération via la balise <page lib>
267                if (preg_match('/\<page*.lib_pdf=["|\'](.*)["|\']/iUms', $html, $match_librairie)
268                        && !empty($match_librairie[1])
269                        && array_key_exists(strtolower($match_librairie[1]), $possible_librairies)
270                ){
271                        $librairie_pdf = strtolower($match_librairie[1]);
272                } else {
273                        $librairie_pdf = 'mpdf';
274                }
275
276                // tester si la librairie est dans /lib à la racine du spip ou dans le répertoire du plugin
277                if (is_dir(_DIR_LIB . $librairie_pdf)){
278                        $dir_librairie_pdf = _DIR_LIB . $librairie_pdf . '/';
279                } elseif (is_dir(dirname(__FILE__) . '/lib/' . $librairie_pdf)) {
280                        $dir_librairie_pdf = dirname(__FILE__) . '/lib/' . $librairie_pdf . '/';
281                } else {
282                        die('Impossible de trouver la librairie de génération de PDF ' . $librairie_pdf . '. vérifiez que vous l\'avez bien téléchargée et installée dans /lib');
283                }
284
285                // nettoyer le HTML et gérer les placements d'image en fonction de la librairie utilisée
286                $html = spipdf_nettoyer_html($html, $possible_librairies[$librairie_pdf]);
287
288                // Debug = voir le html sans génération de PDF
289                if (isset($_GET['debug_spipdf'])){
290                        echo $html;
291                        exit;
292                }
293
294                // du A4 par defaut
295                $format_page = _SPIPDF_FORMAT;
296
297                // traiter la balise page pour les librairies qui ne la comprennent pas
298                if (!empty($possible_librairies[$librairie_pdf]['traite_balise_page'])){
299
300                        $html = traite_balise_page($html);
301
302                        // dans balise_page, on ne récupère que quelques possibilité dont le format
303                        if (!empty($GLOBALS['valeurs_page'])){
304                                if (!empty($GLOBALS['valeurs_page']['format']))
305                                        $format_page = $GLOBALS['valeurs_page']['format'];
306                                if (!empty($GLOBALS['valeurs_page']['backtop']))
307                                        $backtop = $GLOBALS['valeurs_page']['backtop'];
308                                else
309                                        $backtop = _SPIPDF_MARGIN_TOP;
310                                if (!empty($GLOBALS['valeurs_page']['backbottom']))
311                                        $backbottom = $GLOBALS['valeurs_page']['backbottom'];
312                                else
313                                        $backbottom = _SPIPDF_MARGIN_BOTTOM;
314                                if (!empty($GLOBALS['valeurs_page']['backleft']))
315                                        $backleft = $GLOBALS['valeurs_page']['backleft'];
316                                else
317                                        $backleft = _SPIPDF_MARGIN_LEFT;
318                                if (!empty($GLOBALS['valeurs_page']['backright']))
319                                        $backright = $GLOBALS['valeurs_page']['backright'];
320                                else
321                                        $backright = _SPIPDF_MARGIN_RIGHT;
322                                if (!empty($GLOBALS['valeurs_page']['margin_header']))
323                                        $margin_header = $GLOBALS['valeurs_page']['margin_header'];
324                                else
325                                        $margin_header = _SPIPDF_MARGIN_HEADER;
326                                if (!empty($GLOBALS['valeurs_page']['margin_footer']))
327                                        $margin_footer = $GLOBALS['valeurs_page']['margin_footer'];
328                                else
329                                        $margin_footer = _SPIPDF_MARGIN_FOOTER;
330                        }
331                }
332
333                if ($librairie_pdf=='mpdf'){ // la librairie mPDF
334
335                        // si il y a des options dans la balise page
336                        // http://mpdf1.com/manual/index.php?tid=307
337
338                        // le chemin relatif vers mPDF
339                        define('_MPDF_PATH', $dir_librairie_pdf);
340                        include_once(_MPDF_PATH . 'mpdf.php');
341
342                        // la classe mPDF
343                        $mpdf = new mPDF(SPIPDF_CHARSET, $format_page, 0, "", $backleft, $backright, $backtop, $backbottom, $margin_header, $margin_footer);
344                        $mpdf->WriteHTML($html);
345
346                        $flux['data']['texte'] = $mpdf->Output('', 'S'); // envoyer le code binaire du PDF dans le flux
347                        $echap_special_pdf_chars = true;
348
349                } elseif ($librairie_pdf=='dompdf') { // la librairie dompdf beta 0.6 // EXPERIMENTAL
350
351                        // le chemin relatif vers mPDF
352                        require_once(_DIR_LIB . 'dompdf/dompdf_config.inc.php');
353
354                        $dompdf = new DOMPDF();
355                        $dompdf->load_html($html, SPIPDF_CHARSET);
356                        $dompdf->set_paper($format_page);
357                        $dompdf->render();
358
359                        $flux['data']['texte'] = $dompdf->output(); // envoyer le code binaire du PDF dans le flux
360                        $echap_special_pdf_chars = true;
361
362                } else { // la librairie HTML2PDF par défaut
363
364                        // appel de la classe HTML2pdf
365                        require_once($dir_librairie_pdf . 'html2pdf.class.php');
366                        try {
367                                // les paramétres d'orientation et de format son écrasé par ceux défini dans la balise <page> du squelette
368                                $html2pdf = new HTML2PDF('P', $format_page, $flux['args']['contexte']['lang'], SPIPDF_UNICODE, SPIPDF_CHARSET);
369
370                                // mode debug de HTML2PDF
371                                if (defined('SPIPDF_DEBUG_HTML2PDF')){
372                                        $html2pdf->setModeDebug();
373                                }
374                                // police différente selon unicode ou latin
375                                if (SPIPDF_UNICODE){
376                                        $police_caractere = 'FreeSans';
377                                } else {
378                                        $police_caractere = 'Arial';
379                                }
380                                $html2pdf->setDefaultFont($police_caractere);
381                                $html2pdf->writeHTML($html);
382
383                                $flux['data']['texte'] = $html2pdf->Output('', true); // envoyer le code binaire du PDF dans le flux
384                                $echap_special_pdf_chars = true;
385                        } catch (HTML2PDF_exception $e) {
386                                echo $e;
387                        }
388
389                }
390
391                // On échappe les suites de caractères <? pour éviter des erreurs d'évaluation PHP (seront remis en place avec affichage_final)
392                // l'erreur d'évaluation est liée à la directive short_open_tag=On dans la configuration de PHP
393                if (!empty($echap_special_pdf_chars)){
394                        $flux['data']['texte'] = preg_replace('/<\?/', '<§§§§§>', $flux['data']['texte']);
395                }
396
397        }
398
399        return $flux;
400
401}
402
403// On rétablit les <? du code PDF
404function spipdf_affichage_final($texte){
405        return preg_replace('/<§§§§§>/', '<?', $texte);
406}
407
408?>
Note: See TracBrowser for help on using the repository browser.