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