source: spip-zone/_plugins_/spipdf/spipdf_fonctions.php @ 65481

Last change on this file since 65481 was 65481, checked in by cedric@…, 9 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
119//function spipdf_remplaceSpan($matches) { return str_replace('img', 'img style="padding:5px;" style="float:'.$matches[1].'"', $matches[2]); }
120function spipdf_remplaceSpan_wfloat($matches){
121        return str_replace('img', 'img style="padding:5px;" class="pdf_img_float_' . $matches[1] . '"', $matches[2]);
122}
123
124function spipdf_remplaceSpan($matches){
125        return str_replace('img', 'img style="padding:5px;" align="' . $matches[1] . '"', $matches[2]);
126}
127
128function spipdf_remplaceSpanCenter($matches){
129        return $matches[1];
130}
131
132//function spipdf_remplaceDt($matches) { return str_replace('img', 'img style="padding:5px;" style="float:'.$matches[1].'"', $matches[2]); }
133function spipdf_remplaceDt_wfloat($matches){
134        return str_replace('img', 'img style="padding:5px;" class="pdf_img_float_' . $matches[1] . '"', $matches[2]);
135}
136
137function spipdf_remplaceDt($matches){
138        return str_replace('img', 'img style="padding:5px;" align="' . $matches[1] . '"', $matches[2]);
139}
140
141function spipdf_remplaceIdParName($matches){
142        return str_replace('id=\'', 'name=\'', $matches[0]);
143}
144
145function spipdf_remplaceFloatPuce($matches){
146        return str_replace('style=\'', 'style=\'float:left;', $matches[0]);
147}
148
149function spipdf_remplaceDtCenter($matches){
150        return $matches[1];
151}
152
153function spipdf_remplaceCaption($matches){
154        $table = '<table style="border:none;"' . $matches[1] . '<tr><td style="text-align: center;border:none;">' . $matches[2] . '</td></tr>';
155        $table .= '<tr><td style="border:none;">';
156        $table .= '<table' . $matches[1] . $matches[3] . '</table>';
157        $table .= '</td></tr></table>';
158        return $table;
159}
160
161function spipdf_nettoyer_html($html, $params_pdf = array()){
162        // supprimer les spans autour des images et récupérer le placement
163        $patterns_float = '/<span class=\'spip_document_.*spip_documents.*float:(.*);.*>(.*)<\/span>/iUms';
164        $html = preg_replace_callback($patterns_float, !empty($params_pdf['float']) ? 'spipdf_remplaceSpan' : 'spipdf_remplaceSpan_wfloat', $html);
165
166        // supprimer les spans autour des images
167        $patterns_float = '/<span class=\'spip_document_.*spip_documents.*>(.*)<\/span>/iUms';
168        $html = preg_replace_callback($patterns_float, 'spipdf_remplaceSpanCenter', $html);
169
170        // supprimer les dl autour des images et récupérer le placement
171        $patterns_float = '/<dl class=\'spip_document_.*spip_documents.*float:(.*);.*<dt>(.*)<\/dt>.*<\/dl>/iUms';
172        $html = preg_replace_callback($patterns_float, !empty($params_pdf['float']) ? 'spipdf_remplaceDt' : 'spipdf_remplaceDt_wfloat', $html);
173
174        // replacer id par name pour les notes
175        $patterns_note = '/<a.*href.*class=\'spip_note\'.*>/iUms';
176        $html = preg_replace_callback($patterns_note, 'spipdf_remplaceIdParName', $html);
177
178        // float sur les puces graphiques TODO
179        $patterns_puce = '/<a.*href.*class=\'puce\'.*>/iUms';
180        //$html = preg_replace_callback($patterns_puce, 'spipdf_remplaceFloatPuce', $html);
181        //img src="local/cache-vignettes/L8xH11/puce-32883.gif" class="puce" alt="-" style="height: 11px; width: 8px;" height="11" width="8">
182
183        // supprimer les dl autour des images centrer
184        $patterns_float = '/<dl class=\'spip_document_.*spip_documents.*<dt>(.*)<\/dt>.*<\/dl>/iUms';
185        $html = preg_replace_callback($patterns_float, 'spipdf_remplaceDtCenter', $html);
186
187        // remplacer les captions
188        if (!empty($params_pdf['caption'])){
189                $patterns_caption = '/<table(.*)<caption>(.*)<\/caption>(.*)<\/table>/iUms';
190                $html = preg_replace_callback($patterns_caption, 'spipdf_remplaceCaption', $html);
191        }
192
193        // tableaux centré
194        $html = preg_replace('/<table/iUms', '<table align="center"', $html);
195
196        // gestion des caractères spéciaux et de charset
197        $html = spipdf_first_clean($html);
198
199        return $html;
200
201}
202
203// traiter la balise page
204function traite_balise_page($html){
205
206        // on teste la balise page
207        if (preg_match('/<page(.*)>/iUms', $html, $matches)){
208                // on crée un tableau avec (beurk) Global pour accèder aux valeurs de pages
209                if (!empty($matches[1])){
210                        $balise_page = $matches[1];
211                        $pattern = '/(.*)="(.*)"/iUms';
212                        function getBalise($matches){
213                                $matches[2] = str_replace('mm', '', $matches[2]);
214                                $GLOBALS['valeurs_page'][trim($matches[1])] = trim($matches[2]);
215                        }
216
217                        $balise_page = preg_replace_callback($pattern, 'getBalise', $balise_page);
218
219                        // supprimer <page> et </page>
220                        $html = preg_replace('/<\/?page(.*)>/iUms', '', $html);
221
222                        return $html;
223                }
224
225        } else {
226                return $html;
227        }
228
229}
230
231// supprimer le puces graphiques (d'après le plugin couteau suisse)
232function spipdf_pre_typo($texte){
233        return preg_replace('/^-\s*(?![-*#])/m', '-* ', $texte);
234}
235
236// traitement principal. avec ce pipeline, le PDF est mis en cache et recalculé "normalement"
237function spipdf_html2pdf($html){
238
239        // les librairies possibles
240        $possible_librairies = array(
241                'mpdf' => array( // gére le float d'image mais pas les captions de tableau
242                        'float' => true,
243                        'caption' => true,
244                        'traite_balise_page' => true
245                ),
246                'html2pdf' => array( // ne gére pas le float d'image et les captions
247                        'float' => false,
248                        'caption' => true
249                ),
250                'dompdf' => array( // domPDF beta 0.6 EXPERIMENTAL
251                        'float' => false,
252                        'caption' => true,
253                        'traite_balise_page' => true
254                ),
255        );
256
257        // choix de la classe de génération via la balise <page lib>
258        if (preg_match('/\<page*.lib_pdf=["|\'](.*)["|\']/iUms', $html, $match_librairie)
259                && !empty($match_librairie[1])
260                && array_key_exists(strtolower($match_librairie[1]), $possible_librairies)
261        ){
262                $librairie_pdf = strtolower($match_librairie[1]);
263        } else {
264                $librairie_pdf = 'mpdf';
265        }
266
267        // tester si la librairie est dans /lib à la racine du spip ou dans le répertoire du plugin
268        if (is_dir(_DIR_LIB . $librairie_pdf)){
269                $dir_librairie_pdf = _DIR_LIB . $librairie_pdf . '/';
270        } elseif (is_dir(dirname(__FILE__) . '/lib/' . $librairie_pdf)) {
271                $dir_librairie_pdf = dirname(__FILE__) . '/lib/' . $librairie_pdf . '/';
272        } else {
273                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');
274        }
275
276        // nettoyer le HTML et gérer les placements d'image en fonction de la librairie utilisée
277        $html = spipdf_nettoyer_html($html, $possible_librairies[$librairie_pdf]);
278
279        // Debug = voir le html sans génération de PDF
280        if (isset($_GET['debug_spipdf'])){
281                echo $html;
282                exit;
283        }
284
285        // du A4 par defaut
286        $format_page = _SPIPDF_FORMAT;
287
288        // traiter la balise page pour les librairies qui ne la comprennent pas
289        if (!empty($possible_librairies[$librairie_pdf]['traite_balise_page'])){
290
291                $html = traite_balise_page($html);
292
293                // dans balise_page, on ne récupère que quelques possibilité dont le format
294                if (!empty($GLOBALS['valeurs_page'])){
295                        if (!empty($GLOBALS['valeurs_page']['format']))
296                                $format_page = $GLOBALS['valeurs_page']['format'];
297                        if (!empty($GLOBALS['valeurs_page']['backtop']))
298                                $backtop = $GLOBALS['valeurs_page']['backtop'];
299                        else
300                                $backtop = _SPIPDF_MARGIN_TOP;
301                        if (!empty($GLOBALS['valeurs_page']['backbottom']))
302                                $backbottom = $GLOBALS['valeurs_page']['backbottom'];
303                        else
304                                $backbottom = _SPIPDF_MARGIN_BOTTOM;
305                        if (!empty($GLOBALS['valeurs_page']['backleft']))
306                                $backleft = $GLOBALS['valeurs_page']['backleft'];
307                        else
308                                $backleft = _SPIPDF_MARGIN_LEFT;
309                        if (!empty($GLOBALS['valeurs_page']['backright']))
310                                $backright = $GLOBALS['valeurs_page']['backright'];
311                        else
312                                $backright = _SPIPDF_MARGIN_RIGHT;
313                        if (!empty($GLOBALS['valeurs_page']['margin_header']))
314                                $margin_header = $GLOBALS['valeurs_page']['margin_header'];
315                        else
316                                $margin_header = _SPIPDF_MARGIN_HEADER;
317                        if (!empty($GLOBALS['valeurs_page']['margin_footer']))
318                                $margin_footer = $GLOBALS['valeurs_page']['margin_footer'];
319                        else
320                                $margin_footer = _SPIPDF_MARGIN_FOOTER;
321                }
322        }
323
324        if ($librairie_pdf=='mpdf'){ // la librairie mPDF
325
326                // si il y a des options dans la balise page
327                // http://mpdf1.com/manual/index.php?tid=307
328
329                // le chemin relatif vers mPDF
330                define('_MPDF_PATH', $dir_librairie_pdf);
331                include_once(_MPDF_PATH . 'mpdf.php');
332
333                // la classe mPDF
334                $mpdf = new mPDF(SPIPDF_CHARSET, $format_page, 0, "", $backleft, $backright, $backtop, $backbottom, $margin_header, $margin_footer);
335                $mpdf->WriteHTML($html);
336
337                $html = $mpdf->Output('', 'S'); // envoyer le code binaire du PDF dans le flux
338                $echap_special_pdf_chars = true;
339
340        } elseif ($librairie_pdf=='dompdf') { // la librairie dompdf beta 0.6 // EXPERIMENTAL
341
342                // le chemin relatif vers mPDF
343                require_once(_DIR_LIB . 'dompdf/dompdf_config.inc.php');
344
345                $dompdf = new DOMPDF();
346                $dompdf->load_html($html, SPIPDF_CHARSET);
347                $dompdf->set_paper($format_page);
348                $dompdf->render();
349
350                $html = $dompdf->output(); // envoyer le code binaire du PDF dans le flux
351                $echap_special_pdf_chars = true;
352
353        } else { // la librairie HTML2PDF par défaut
354
355                // appel de la classe HTML2pdf
356                require_once($dir_librairie_pdf . 'html2pdf.class.php');
357                try {
358                        // les paramétres d'orientation et de format son écrasé par ceux défini dans la balise <page> du squelette
359                        $html2pdf = new HTML2PDF('P', $format_page, $flux['args']['contexte']['lang'], SPIPDF_UNICODE, SPIPDF_CHARSET);
360
361                        // mode debug de HTML2PDF
362                        if (defined('SPIPDF_DEBUG_HTML2PDF')){
363                                $html2pdf->setModeDebug();
364                        }
365                        // police différente selon unicode ou latin
366                        if (SPIPDF_UNICODE){
367                                $police_caractere = 'FreeSans';
368                        } else {
369                                $police_caractere = 'Arial';
370                        }
371                        $html2pdf->setDefaultFont($police_caractere);
372                        $html2pdf->writeHTML($html);
373
374                        $html = $html2pdf->Output('', true); // envoyer le code binaire du PDF dans le flux
375                        $echap_special_pdf_chars = true;
376                } catch (HTML2PDF_exception $e) {
377                        echo $e;
378                }
379
380        }
381
382        // On échappe les suites de caractères <? pour éviter des erreurs d'évaluation PHP (seront remis en place avec affichage_final)
383        // l'erreur d'évaluation est liée à la directive short_open_tag=On dans la configuration de PHP
384        if (!empty($echap_special_pdf_chars)
385                AND strpos($html, "<" . "?")!==false
386        ){
387                $html = str_replace("<" . "?", "<\2\2?", $html);
388        }
389
390        return $html;
391
392}
393
394/**
395 * On rétablit les <? du code PDF si necessaire
396 * on n'agit que sur les pages non html
397 *
398 * @param string $texte
399 * @return string
400 */
401function spipdf_affichage_final($texte){
402        if ($GLOBALS['html']==false
403                AND strpos($texte, "<\2\2?")!==false
404        ){
405                $texte = str_replace("<\2\2?", "<" . "?", $texte);
406        }
407        return $texte;
408}
409
410?>
Note: See TracBrowser for help on using the repository browser.