string-array: New function string_array_parse().
[pspp] / src / output / html.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014, 2017 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include <errno.h>
20 #include <stdint.h>
21 #include <stdlib.h>
22 #include <ctype.h>
23 #include <time.h>
24 #include <unistd.h>
25
26 #include "data/file-name.h"
27 #include "data/file-handle-def.h"
28 #include "libpspp/assertion.h"
29 #include "libpspp/cast.h"
30 #include "libpspp/compiler.h"
31 #include "libpspp/message.h"
32 #include "libpspp/version.h"
33 #include "output/cairo.h"
34 #include "output/chart-item.h"
35 #include "output/driver-provider.h"
36 #include "output/message-item.h"
37 #include "output/options.h"
38 #include "output/output-item-provider.h"
39 #include "output/table-provider.h"
40 #include "output/table-item.h"
41 #include "output/text-item.h"
42
43 #include "gl/minmax.h"
44 #include "gl/xalloc.h"
45
46 #include "gettext.h"
47 #define _(msgid) gettext (msgid)
48
49 struct html_driver
50   {
51     struct output_driver driver;
52 #ifdef HAVE_CAIRO
53     struct cell_color fg;
54     struct cell_color bg;
55 #endif
56     struct file_handle *handle;
57     char *chart_file_name;
58
59     FILE *file;
60     size_t chart_cnt;
61
62     bool css;
63     bool borders;
64   };
65
66 static const struct output_driver_class html_driver_class;
67
68 static void html_output_table (struct html_driver *, const struct table_item *);
69 static void escape_string (FILE *file,
70                            const char *text, size_t length,
71                            const char *space, const char *newline);
72 static void print_title_tag (FILE *file, const char *name,
73                              const char *content);
74
75 static struct html_driver *
76 html_driver_cast (struct output_driver *driver)
77 {
78   assert (driver->class == &html_driver_class);
79   return UP_CAST (driver, struct html_driver, driver);
80 }
81
82 static struct driver_option *
83 opt (struct output_driver *d, struct string_map *options, const char *key,
84      const char *default_value)
85 {
86   return driver_option_get (d, options, key, default_value);
87 }
88
89 static struct output_driver *
90 html_create (struct file_handle *fh, enum settings_output_devices device_type,
91              struct string_map *o)
92 {
93   struct output_driver *d;
94   struct html_driver *html;
95
96   html = xzalloc (sizeof *html);
97   d = &html->driver;
98   output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
99                       device_type);
100   html->css = parse_boolean (opt (d, o, "css", "true"));
101   html->borders = parse_boolean (opt (d, o, "borders", "true"));
102
103   html->handle = fh;
104   html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
105                                                       fh_get_file_name (fh)));
106   html->file = NULL;
107   html->chart_cnt = 1;
108 #ifdef HAVE_CAIRO
109   parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &html->bg);
110   parse_color (d, o, "foreground-color", "#000000000000", &html->fg);
111 #endif
112   html->file = fn_open (html->handle, "w");
113   if (html->file == NULL)
114     {
115       msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
116       goto error;
117     }
118
119   fputs ("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"\n"
120          "   \"http://www.w3.org/TR/html4/loose.dtd\">\n", html->file);
121   fputs ("<HTML>\n", html->file);
122   fputs ("<HEAD>\n", html->file);
123   print_title_tag (html->file, "TITLE", _("PSPP Output"));
124   fprintf (html->file, "<META NAME=\"generator\" CONTENT=\"%s\">\n", version);
125   fputs ("<META HTTP-EQUIV=\"Content-Type\" "
126          "CONTENT=\"text/html; charset=utf-8\">\n", html->file);
127
128   if ( html->css)
129     {
130       fputs ("<META http-equiv=\"Content-Style-Type\" content=\"text/css\">\n",
131              html->file);
132       fputs ("<STYLE TYPE=\"text/css\">\n"
133              "<!--\n"
134              "body {\n"
135              "  background: white;\n"
136              "  color: black;\n"
137              "  padding: 0em 12em 0em 3em;\n"
138              "  margin: 0\n"
139              "}\n"
140              "body>p {\n"
141              "  margin: 0pt 0pt 0pt 0em\n"
142              "}\n"
143              "body>p + p {\n"
144              "  text-indent: 1.5em;\n"
145              "}\n"
146              "h1 {\n"
147              "  font-size: 150%;\n"
148              "  margin-left: -1.33em\n"
149              "}\n"
150              "h2 {\n"
151              "  font-size: 125%;\n"
152              "  font-weight: bold;\n"
153              "  margin-left: -.8em\n"
154              "}\n"
155              "h3 {\n"
156              "  font-size: 100%;\n"
157              "  font-weight: bold;\n"
158              "  margin-left: -.5em }\n"
159              "h4 {\n"
160              "  font-size: 100%;\n"
161              "  margin-left: 0em\n"
162              "}\n"
163              "h1, h2, h3, h4, h5, h6 {\n"
164              "  font-family: sans-serif;\n"
165              "  color: blue\n"
166              "}\n"
167              "html {\n"
168              "  margin: 0\n"
169              "}\n"
170              "code {\n"
171              "  font-family: sans-serif\n"
172              "}\n"
173              "table {\n"
174              "  border-collapse: collapse;\n"
175              "  margin-bottom: 1em\n"
176              "}\n"
177              "th { background: #dddddd; font-weight: normal; font-style: oblique }\n"
178              "caption {\n"
179              "  text-align: left\n"
180              "}\n"
181              "-->\n"
182              "</STYLE>\n",
183              html->file);
184     }
185   fputs ("</HEAD>\n", html->file);
186   fputs ("<BODY BGCOLOR=\"#ffffff\" TEXT=\"#000000\"\n", html->file);
187   fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", html->file);
188
189   return d;
190
191  error:
192   output_driver_destroy (d);
193   return NULL;
194 }
195
196 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
197    necessary for HTML. */
198 static void
199 print_title_tag (FILE *file, const char *name, const char *content)
200 {
201   if (content != NULL)
202     {
203        fprintf (file, "<%s>", name);
204       escape_string (file, content, strlen (content), " ", " - ");
205       fprintf (file, "</%s>\n", name);
206     }
207 }
208
209 static void
210 html_destroy (struct output_driver *driver)
211 {
212   struct html_driver *html = html_driver_cast (driver);
213
214   if (html->file != NULL)
215     {
216       fprintf (html->file,
217                "</BODY>\n"
218                "</HTML>\n"
219                "<!-- end of file -->\n");
220       fn_close (html->handle, html->file);
221     }
222   free (html->chart_file_name);
223   fh_unref (html->handle);
224   free (html);
225 }
226
227 static void
228 html_submit (struct output_driver *driver,
229              const struct output_item *output_item)
230 {
231   struct html_driver *html = html_driver_cast (driver);
232
233   if (is_table_item (output_item))
234     {
235       struct table_item *table_item = to_table_item (output_item);
236       html_output_table (html, table_item);
237     }
238 #ifdef HAVE_CAIRO
239   else if (is_chart_item (output_item) && html->chart_file_name != NULL)
240     {
241       struct chart_item *chart_item = to_chart_item (output_item);
242       char *file_name;
243
244       file_name = xr_draw_png_chart (chart_item, html->chart_file_name,
245                                      html->chart_cnt++,
246                                      &html->fg,
247                                      &html->bg
248                                      );
249       if (file_name != NULL)
250         {
251           const char *title = chart_item_get_title (chart_item);
252           fprintf (html->file, "<IMG SRC=\"%s\" ALT=\"Chart: %s\">",
253                    file_name, title ? title : _("No description"));
254           free (file_name);
255         }
256     }
257 #endif  /* HAVE_CAIRO */
258   else if (is_text_item (output_item))
259     {
260       struct text_item *text_item = to_text_item (output_item);
261       const char *s = text_item_get_text (text_item);
262
263       switch (text_item_get_type (text_item))
264         {
265         case TEXT_ITEM_PAGE_TITLE:
266           break;
267
268         case TEXT_ITEM_TITLE:
269           {
270             int level = MIN (5, output_get_group_level ()) + 1;
271             char tag[3] = { 'H', level + '1', '\0' };
272             print_title_tag (html->file, tag, s);
273           }
274           break;
275
276         case TEXT_ITEM_SYNTAX:
277           fprintf (html->file, "<PRE class=\"syntax\">");
278           escape_string (html->file, s, strlen (s), " ", "<BR>");
279           fprintf (html->file, "</PRE>\n");
280           break;
281
282         case TEXT_ITEM_LOG:
283           print_title_tag (html->file, "PRE", s); /* should be <P><TT> */
284           break;
285
286         case TEXT_ITEM_EJECT_PAGE:
287           /* Nothing to do. */
288           break;
289         }
290     }
291   else if (is_message_item (output_item))
292     {
293       const struct message_item *message_item = to_message_item (output_item);
294       char *s = msg_to_string (message_item_get_msg (message_item));
295       print_title_tag (html->file, "P", s);
296       free (s);
297     }
298 }
299
300 /* Write LENGTH characters in TEXT to file F, escaping characters as necessary
301    for HTML.  Spaces are replaced by SPACE, which should be " " or "&nbsp;"
302    New-lines are replaced by NEWLINE, which might be "<BR>" or "\n" or
303    something else appropriate. */
304 static void
305 escape_string (FILE *file,
306                const char *text, size_t length,
307                const char *space, const char *newline)
308 {
309   while (length-- > 0)
310     {
311       char c = *text++;
312       switch (c)
313         {
314         case '\n':
315           fputs (newline, file);
316           break;
317         case '&':
318           fputs ("&amp;", file);
319           break;
320         case '<':
321           fputs ("&lt;", file);
322           break;
323         case '>':
324           fputs ("&gt;", file);
325           break;
326         case ' ':
327           fputs (space, file);
328           break;
329         case '"':
330           fputs ("&quot;", file);
331           break;
332         default:
333           putc (c, file);
334           break;
335         }
336     }
337 }
338
339 static const char *
340 border_to_css (int border)
341 {
342   switch (border)
343     {
344     case TAL_NONE:
345       return NULL;
346
347     case TAL_SOLID:
348       return "solid";
349
350     case TAL_DASHED:
351       return "dashed";
352
353     case TAL_THICK:
354       return "thick solid";
355
356     case TAL_THIN:
357       return "thin solid";
358
359     case TAL_DOUBLE:
360       return "double";
361
362     default:
363       return NULL;
364     }
365
366 }
367
368 static void
369 put_border (FILE *file, int *n_borders, int style, const char *border_name)
370 {
371   const char *css = border_to_css (style);
372   if (css)
373     {
374       fprintf (file, "%sborder-%s: %s",
375                (*n_borders)++ == 0 ? " STYLE=\"" : "; ",
376                border_name, css);
377     }
378 }
379
380 static void
381 put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
382 {
383   if (!*tfoot)
384     {
385       fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>", table_nc (t));
386       *tfoot = true;
387     }
388   else
389     fputs ("\n<BR>", html->file);
390 }
391
392 static void
393 html_put_footnote_markers (struct html_driver *html,
394                            const struct footnote **footnotes,
395                            size_t n_footnotes)
396 {
397   if (n_footnotes > 0)
398     {
399       fputs ("<SUP>", html->file);
400       for (size_t i = 0; i < n_footnotes; i++)
401         {
402           const struct footnote *f = footnotes[i];
403
404           if (i > 0)
405             putc (',', html->file);
406           escape_string (html->file, f->marker,
407                          strlen (f->marker), " ", "<BR>");
408         }
409       fputs ("</SUP>", html->file);
410     }
411 }
412
413 static void
414 html_put_table_item_text (struct html_driver *html,
415                           const struct table_item_text *text)
416 {
417   escape_string (html->file, text->content, strlen (text->content),
418                  " ", "<BR>");
419   html_put_footnote_markers (html, text->footnotes, text->n_footnotes);
420 }
421
422 static void
423 html_output_table (struct html_driver *html, const struct table_item *item)
424 {
425   const struct table *t = table_item_get_table (item);
426   bool tfoot = false;
427   int y;
428
429   fputs ("<TABLE>", html->file);
430
431   const struct table_item_text *caption = table_item_get_caption (item);
432   if (caption)
433     {
434       put_tfoot (html, t, &tfoot);
435       html_put_table_item_text (html, caption);
436     }
437   const struct footnote **f;
438   size_t n_footnotes = table_collect_footnotes (item, &f);
439
440   for (size_t i = 0; i < n_footnotes; i++)
441     if (f[i])
442       {
443         put_tfoot (html, t, &tfoot);
444         fputs ("<SUP>", html->file);
445         escape_string (html->file, f[i]->marker, strlen (f[i]->marker),
446                        " ", "<BR>");
447         fputs ("</SUP> ", html->file);
448         escape_string (html->file, f[i]->content, strlen (f[i]->content),
449                        " ", "<BR>");
450       }
451   free (f);
452   if (tfoot)
453     fputs ("</TD></TR></TFOOT>\n", html->file);
454
455   fputs ("<TBODY VALIGN=\"TOP\">\n", html->file);
456
457   const struct table_item_text *title = table_item_get_title (item);
458   const struct table_item_text *layers = table_item_get_layers (item);
459   if (title || layers)
460     {
461       fputs ("  <CAPTION>", html->file);
462       if (title)
463         html_put_table_item_text (html, title);
464       if (title && layers)
465         fputs ("<BR>\n", html->file);
466       if (layers)
467         html_put_table_item_text (html, layers);
468       fputs ("</CAPTION>\n", html->file);
469     }
470
471   for (y = 0; y < table_nr (t); y++)
472     {
473       int x;
474
475       fputs ("  <TR>\n", html->file);
476       for (x = 0; x < table_nc (t); )
477         {
478           struct table_cell cell;
479           const char *tag;
480           bool is_header;
481           int colspan, rowspan;
482           int top, left, right, bottom;
483
484           table_get_cell (t, x, y, &cell);
485           if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
486             goto next_1;
487
488           /* Output <TD> or <TH> tag. */
489           is_header = (y < table_ht (t)
490                        || y >= table_nr (t) - table_hb (t)
491                        || x < table_hl (t)
492                        || x >= table_nc (t) - table_hr (t));
493           tag = is_header ? "TH" : "TD";
494           fprintf (html->file, "    <%s", tag);
495
496           enum table_halign halign = table_halign_interpret (
497             cell.style->cell_style.halign, cell.options & TAB_NUMERIC);
498           if (halign != TABLE_HALIGN_LEFT)
499             {
500               fprintf (html->file, " ALIGN=\"%s\"",
501                        (halign == TABLE_HALIGN_RIGHT ? "RIGHT"
502                         : halign == TABLE_HALIGN_CENTER ? "CENTER"
503                         : "CHAR"));
504               if (cell.style->cell_style.decimal_char)
505                 fprintf (html->file, " CHAR=\"%c\"",
506                          cell.style->cell_style.decimal_char);
507             }
508
509           if (cell.style->cell_style.valign != TABLE_VALIGN_TOP)
510             fprintf (html->file, " ALIGN=\"%s\"",
511                      (cell.style->cell_style.valign == TABLE_VALIGN_BOTTOM
512                       ? "BOTTOM" : "MIDDLE"));
513
514           colspan = table_cell_colspan (&cell);
515           if (colspan > 1)
516             fprintf (html->file, " COLSPAN=\"%d\"", colspan);
517
518           rowspan = table_cell_rowspan (&cell);
519           if (rowspan > 1)
520             fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
521
522           if (html->borders)
523             {
524               /* Cell borders. */
525               int n_borders = 0;
526
527               struct cell_color color;
528               top = table_get_rule (t, TABLE_VERT, x, y, &color);
529               put_border (html->file, &n_borders, top, "top");
530
531               if (y + rowspan == table_nr (t))
532                 {
533                   bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan,
534                                            &color);
535                   put_border (html->file, &n_borders, bottom, "bottom");
536                 }
537
538               left = table_get_rule (t, TABLE_HORZ, x, y, &color);
539               put_border (html->file, &n_borders, left, "left");
540
541               if (x + colspan == table_nc (t))
542                 {
543                   right = table_get_rule (t, TABLE_HORZ, x + colspan, y,
544                                           &color);
545                   put_border (html->file, &n_borders, right, "right");
546                 }
547
548               if (n_borders > 0)
549                 fputs ("\"", html->file);
550             }
551
552           putc ('>', html->file);
553
554           /* Output cell contents. */
555           const char *s = cell.text;
556           if (cell.options & TAB_FIX)
557             {
558               fputs ("<TT>", html->file);
559               escape_string (html->file, s, strlen (s), "&nbsp;", "<BR>");
560               fputs ("</TT>", html->file);
561             }
562           else
563             {
564               s += strspn (s, CC_SPACES);
565               escape_string (html->file, s, strlen (s), " ", "<BR>");
566             }
567
568           html_put_footnote_markers (html, cell.footnotes, cell.n_footnotes);
569
570           /* Output </TH> or </TD>. */
571           fprintf (html->file, "</%s>\n", tag);
572
573         next_1:
574           x = cell.d[TABLE_HORZ][1];
575           table_cell_free (&cell);
576         }
577       fputs ("  </TR>\n", html->file);
578     }
579
580   fputs ("</TBODY></TABLE>\n\n", html->file);
581 }
582
583 struct output_driver_factory html_driver_factory =
584   { "html", "pspp.html", html_create };
585
586 static const struct output_driver_class html_driver_class =
587   {
588     "html",
589     html_destroy,
590     html_submit,
591     NULL,
592   };