pintos-os.org Git - pspp/blob - src/output/html.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014, 2017,
   3    2020 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  17
  18 #include <config.h>
  19
  20 #include <errno.h>
  21 #include <stdint.h>
  22 #include <stdlib.h>
  23 #include <ctype.h>
  24 #include <time.h>
  25 #include <unistd.h>
  26 #include <locale.h>
  27
  28 #include "data/file-name.h"
  29 #include "data/file-handle-def.h"
  30 #include "libpspp/assertion.h"
  31 #include "libpspp/cast.h"
  32 #include "libpspp/compiler.h"
  33 #include "libpspp/i18n.h"
  34 #include "libpspp/message.h"
  35 #include "libpspp/version.h"
  36 #ifdef HAVE_CAIRO
  37 #include "output/cairo-chart.h"
  38 #endif
  39 #include "output/chart-item.h"
  40 #include "output/driver-provider.h"
  41 #include "output/message-item.h"
  42 #include "output/options.h"
  43 #include "output/output-item-provider.h"
  44 #include "output/table-provider.h"
  45 #include "output/table-item.h"
  46 #include "output/text-item.h"
  47
  48 #include "gl/minmax.h"
  49 #include "gl/xalloc.h"
  50
  51 #include "gettext.h"
  52 #define _(msgid) gettext (msgid)
  53
  54 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
  55 #define H TABLE_HORZ
  56 #define V TABLE_VERT
  57
  58 struct html_driver
  59   {
  60     struct output_driver driver;
  61 #ifdef HAVE_CAIRO
  62     struct cell_color fg;
  63     struct cell_color bg;
  64 #endif
  65     struct file_handle *handle;
  66     char *chart_file_name;
  67
  68     FILE *file;
  69     size_t chart_cnt;
  70
  71     bool bare;
  72     bool css;
  73     bool borders;
  74   };
  75
  76 static const struct output_driver_class html_driver_class;
  77
  78 static void html_output_table (struct html_driver *, const struct table_item *);
  79 static void escape_string (FILE *file, const char *text,
  80                            const char *space, const char *newline);
  81 static void print_title_tag (FILE *file, const char *name,
  82                              const char *content);
  83
  84 static struct html_driver *
  85 html_driver_cast (struct output_driver *driver)
  86 {
  87   assert (driver->class == &html_driver_class);
  88   return UP_CAST (driver, struct html_driver, driver);
  89 }
  90
  91 static struct driver_option *
  92 opt (struct output_driver *d, struct string_map *options, const char *key,
  93      const char *default_value)
  94 {
  95   return driver_option_get (d, options, key, default_value);
  96 }
  97
  98 static void
  99 put_header (struct html_driver *html)
 100 {
 101   fputs ("<!doctype html>\n", html->file);
 102   fprintf (html->file, "<html");
 103   char *ln = get_language ();
 104   if (ln)
 105     fprintf (html->file, " lang=\"%s\"", ln);
 106   free (ln);
 107   fprintf (html->file, ">\n");
 108   fputs ("<head>\n", html->file);
 109   print_title_tag (html->file, "title", _("PSPP Output"));
 110   fprintf (html->file, "<meta name=\"generator\" content=\"%s\">\n", version);
 111   fputs ("<meta http-equiv=\"content-type\" "
 112          "content=\"text/html; charset=utf-8\">\n", html->file);
 113
 114   if (html->css)
 115     {
 116       fputs ("<style>\n"
 117              "<!--\n"
 118              "body {\n"
 119              "  background: white;\n"
 120              "  color: black;\n"
 121              "  padding: 0em 12em 0em 3em;\n"
 122              "  margin: 0\n"
 123              "}\n"
 124              "body>p {\n"
 125              "  margin: 0pt 0pt 0pt 0em\n"
 126              "}\n"
 127              "body>p + p {\n"
 128              "  text-indent: 1.5em;\n"
 129              "}\n"
 130              "h1 {\n"
 131              "  font-size: 150%;\n"
 132              "  margin-left: -1.33em\n"
 133              "}\n"
 134              "h2 {\n"
 135              "  font-size: 125%;\n"
 136              "  font-weight: bold;\n"
 137              "  margin-left: -.8em\n"
 138              "}\n"
 139              "h3 {\n"
 140              "  font-size: 100%;\n"
 141              "  font-weight: bold;\n"
 142              "  margin-left: -.5em }\n"
 143              "h4 {\n"
 144              "  font-size: 100%;\n"
 145              "  margin-left: 0em\n"
 146              "}\n"
 147              "h1, h2, h3, h4, h5, h6 {\n"
 148              "  font-family: sans-serif;\n"
 149              "  color: blue\n"
 150              "}\n"
 151              "html {\n"
 152              "  margin: 0\n"
 153              "}\n"
 154              "code {\n"
 155              "  font-family: sans-serif\n"
 156              "}\n"
 157              "table {\n"
 158              "  border-collapse: collapse;\n"
 159              "  margin-bottom: 1em\n"
 160              "}\n"
 161              "caption {\n"
 162              "  text-align: left\n"
 163              "}\n"
 164
 165              "a:link {\n"
 166              "  color: #1f00ff;\n"
 167              "}\n"
 168              "a:visited {\n"
 169              "  color: #9900dd;\n"
 170              "}\n"
 171              "a:active {\n"
 172              "  color: red;\n"
 173              "}\n"
 174              "-->\n"
 175              "</style>\n",
 176              html->file);
 177     }
 178   fputs ("</head>\n", html->file);
 179   fputs ("<body>\n", html->file);
 180 }
 181
 182 static struct output_driver *
 183 html_create (struct file_handle *fh, enum settings_output_devices device_type,
 184              struct string_map *o)
 185 {
 186   struct output_driver *d;
 187   struct html_driver *html;
 188
 189   html = xzalloc (sizeof *html);
 190   d = &html->driver;
 191   output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
 192                       device_type);
 193   html->bare = parse_boolean (opt (d, o, "bare", "false"));
 194   html->css = parse_boolean (opt (d, o, "css", "true"));
 195   html->borders = parse_boolean (opt (d, o, "borders", "true"));
 196
 197   html->handle = fh;
 198   html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
 199                                                       fh_get_file_name (fh)));
 200   html->file = NULL;
 201   html->chart_cnt = 1;
 202 #ifdef HAVE_CAIRO
 203   html->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
 204   html->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
 205 #endif
 206   html->file = fn_open (html->handle, "w");
 207   if (html->file == NULL)
 208     {
 209       msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
 210       goto error;
 211     }
 212
 213   if (!html->bare)
 214     put_header (html);
 215
 216   return d;
 217
 218  error:
 219   output_driver_destroy (d);
 220   return NULL;
 221 }
 222
 223 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
 224    necessary for HTML. */
 225 static void
 226 print_title_tag (FILE *file, const char *name, const char *content)
 227 {
 228   if (content != NULL)
 229     {
 230        fprintf (file, "<%s>", name);
 231       escape_string (file, content, " ", " - ");
 232       fprintf (file, "</%s>\n", name);
 233     }
 234 }
 235
 236 static void
 237 html_destroy (struct output_driver *driver)
 238 {
 239   struct html_driver *html = html_driver_cast (driver);
 240
 241   if (html->file != NULL)
 242     {
 243       if (!html->bare)
 244         fprintf (html->file,
 245                  "</body>\n"
 246                  "</html>\n"
 247                  "<!-- end of file -->\n");
 248       fn_close (html->handle, html->file);
 249     }
 250   free (html->chart_file_name);
 251   fh_unref (html->handle);
 252   free (html);
 253 }
 254
 255 static void
 256 html_submit (struct output_driver *driver,
 257              const struct output_item *output_item)
 258 {
 259   struct html_driver *html = html_driver_cast (driver);
 260
 261   if (is_table_item (output_item))
 262     {
 263       struct table_item *table_item = to_table_item (output_item);
 264       html_output_table (html, table_item);
 265     }
 266 #ifdef HAVE_CAIRO
 267   else if (is_chart_item (output_item) && html->chart_file_name != NULL)
 268     {
 269       struct chart_item *chart_item = to_chart_item (output_item);
 270       char *file_name;
 271
 272       file_name = xr_draw_png_chart (chart_item, html->chart_file_name,
 273                                      html->chart_cnt++,
 274                                      &html->fg,
 275                                      &html->bg
 276                                 );
 277       if (file_name != NULL)
 278         {
 279           const char *title = chart_item_get_title (chart_item);
 280           fprintf (html->file, "<img src=\"%s\" alt=\"chart: %s\">",
 281                    file_name, title ? title : _("No description"));
 282           free (file_name);
 283         }
 284     }
 285 #endif  /* HAVE_CAIRO */
 286   else if (is_text_item (output_item))
 287     {
 288       struct text_item *text_item = to_text_item (output_item);
 289       const char *s = text_item_get_text (text_item);
 290
 291       switch (text_item_get_type (text_item))
 292         {
 293         case TEXT_ITEM_PAGE_TITLE:
 294           break;
 295
 296         case TEXT_ITEM_TITLE:
 297           {
 298             int level = MIN (5, output_get_group_level ()) + 1;
 299             char tag[3] = { 'H', level + '1', '\0' };
 300             print_title_tag (html->file, tag, s);
 301           }
 302           break;
 303
 304         case TEXT_ITEM_SYNTAX:
 305           fprintf (html->file, "<pre class=\"syntax\">");
 306           escape_string (html->file, s, " ", "<br>");
 307           fprintf (html->file, "</pre>\n");
 308           break;
 309
 310         case TEXT_ITEM_LOG:
 311           print_title_tag (html->file, "pre", s); /* should be <P><TT> */
 312           break;
 313         }
 314     }
 315   else if (is_message_item (output_item))
 316     {
 317       const struct message_item *message_item = to_message_item (output_item);
 318       char *s = msg_to_string (message_item_get_msg (message_item));
 319       print_title_tag (html->file, "p", s);
 320       free (s);
 321     }
 322 }
 323
 324 /* Write TEXT to file F, escaping characters as necessary for HTML.  Spaces are
 325    replaced by SPACE, which should be " " or "&nbsp;" New-lines are replaced by
 326    NEWLINE, which might be "<BR>" or "\n" or something else appropriate. */
 327 static void
 328 escape_string (FILE *file, const char *text,
 329                const char *space, const char *newline)
 330 {
 331   for (;;)
 332     {
 333       char c = *text++;
 334       switch (c)
 335         {
 336         case 0:
 337           return;
 338         case '\n':
 339           fputs (newline, file);
 340           break;
 341         case '&':
 342           fputs ("&amp;", file);
 343           break;
 344         case '<':
 345           fputs ("&lt;", file);
 346           break;
 347         case '>':
 348           fputs ("&gt;", file);
 349           break;
 350         case ' ':
 351           fputs (space, file);
 352           break;
 353         case '"':
 354           fputs ("&quot;", file);
 355           break;
 356         default:
 357           putc (c, file);
 358           break;
 359         }
 360     }
 361 }
 362
 363 static void
 364 escape_tag (FILE *file, const char *tag,
 365             const char *text, const char *space, const char *newline)
 366 {
 367   if (!text || !*text)
 368     return;
 369
 370   fprintf (file, "<%s>", tag);
 371   escape_string (file, text, space, newline);
 372   fprintf (file, "</%s>", tag);
 373 }
 374
 375 static const char *
 376 border_to_css (int border)
 377 {
 378   switch (border)
 379     {
 380     case TABLE_STROKE_NONE:
 381       return NULL;
 382
 383     case TABLE_STROKE_SOLID:
 384       return "solid";
 385
 386     case TABLE_STROKE_DASHED:
 387       return "dashed";
 388
 389     case TABLE_STROKE_THICK:
 390       return "thick solid";
 391
 392     case TABLE_STROKE_THIN:
 393       return "thin solid";
 394
 395     case TABLE_STROKE_DOUBLE:
 396       return "double";
 397
 398     default:
 399       return NULL;
 400     }
 401
 402 }
 403
 404 struct css_style
 405 {
 406   FILE *file;
 407   int n_styles;
 408 };
 409
 410 static void
 411 style_start (struct css_style *cs, FILE *file)
 412 {
 413   *cs = (struct css_style) {
 414     .file = file,
 415     .n_styles = 0,
 416   };
 417 }
 418
 419 static void
 420 style_end (struct css_style *cs)
 421 {
 422   if (cs->n_styles > 0)
 423     fputs ("'", cs->file);
 424 }
 425
 426 static void
 427 put_style (struct css_style *st, const char *name, const char *value)
 428 {
 429   bool first = !st->n_styles++;
 430   fprintf (st->file, "%s%s: %s", first ? " style='" : "; ", name, value);
 431 }
 432
 433 static bool
 434 format_color (const struct cell_color color,
 435               const struct cell_color default_color,
 436               char *buf, size_t bufsize)
 437 {
 438   bool retval = !cell_color_equal (&color, &default_color);
 439   if (retval)
 440     {
 441       if (color.alpha == 255)
 442         snprintf (buf, bufsize, "#%02x%02x%02x", color.r, color.g, color.b);
 443       else
 444         snprintf (buf, bufsize, "rgba(%d, %d, %d, %.3f)",
 445                   color.r, color.g, color.b, color.alpha / 255.0);
 446     }
 447   return retval;
 448 }
 449
 450 static void
 451 put_border (struct css_style *st, int style, const struct cell_color *color,
 452             const char *border_name)
 453 {
 454   const char *css = border_to_css (style);
 455   if (css)
 456     {
 457       if (st->n_styles++ > 0)
 458         fputs ("; ", st->file);
 459       fprintf (st->file, "border-%s: %s", border_name, css);
 460
 461       char buf[32];
 462       if (format_color (*color, (struct cell_color) CELL_COLOR_BLACK,
 463                         buf, sizeof buf))
 464         fprintf (st->file, " %s", buf);
 465     }
 466 }
 467
 468 static void
 469 put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
 470 {
 471   if (!*tfoot)
 472     {
 473       fputs ("<tfoot>\n", html->file);
 474       fputs ("<tr>\n", html->file);
 475       fprintf (html->file, "<td colspan=%d>\n", t->n[H]);
 476       *tfoot = true;
 477     }
 478   else
 479     fputs ("\n<br>", html->file);
 480 }
 481
 482 static void
 483 html_put_footnote_markers (struct html_driver *html,
 484                            const struct footnote **footnotes,
 485                            size_t n_footnotes)
 486 {
 487   if (n_footnotes > 0)
 488     {
 489       fputs ("<sup>", html->file);
 490       for (size_t i = 0; i < n_footnotes; i++)
 491         {
 492           const struct footnote *f = footnotes[i];
 493
 494           if (i > 0)
 495             putc (',', html->file);
 496           escape_string (html->file, f->marker, " ", "<br>");
 497         }
 498       fputs ("</sup>", html->file);
 499     }
 500 }
 501
 502 static void
 503 html_put_table_item_text (struct html_driver *html,
 504                           const struct table_item_text *text)
 505 {
 506   escape_string (html->file, text->content, " ", "<br>");
 507   html_put_footnote_markers (html, text->footnotes, text->n_footnotes);
 508 }
 509
 510 static void
 511 html_put_table_cell_text (struct html_driver *html,
 512                           const struct table_cell *cell)
 513 {
 514   const char *s = cell->text;
 515   if (cell->options & TAB_FIX)
 516     escape_tag (html->file, "tt", s, "&nbsp;", "<br>");
 517   else
 518     {
 519       s += strspn (s, CC_SPACES);
 520       escape_string (html->file, s, " ", "<br>");
 521     }
 522
 523   if (cell->n_subscripts)
 524     {
 525       fputs ("<sub>", html->file);
 526       for (size_t i = 0; i < cell->n_subscripts; i++)
 527         {
 528           if (i)
 529             putc (',', html->file);
 530           escape_string (html->file, cell->subscripts[i],
 531                          "&nbsp;", "<br>");
 532         }
 533       fputs ("</sub>", html->file);
 534     }
 535   if (cell->superscript)
 536     escape_tag (html->file, "sup", cell->superscript, "&nbsp;", "<br>");
 537   html_put_footnote_markers (html, cell->footnotes, cell->n_footnotes);
 538 }
 539
 540 static void
 541 html_put_table_item_layers (struct html_driver *html,
 542                             const struct table_item_layers *layers)
 543 {
 544   for (size_t i = 0; i < layers->n_layers; i++)
 545     {
 546       if (i)
 547         fputs ("<br>\n", html->file);
 548
 549       const struct table_item_layer *layer = &layers->layers[i];
 550       escape_string (html->file, layer->content, " ", "<br>");
 551       html_put_footnote_markers (html, layer->footnotes, layer->n_footnotes);
 552     }
 553 }
 554
 555 static void
 556 html_output_table (struct html_driver *html, const struct table_item *item)
 557 {
 558   const struct table *t = table_item_get_table (item);
 559   bool tfoot = false;
 560   int y;
 561
 562   fputs ("<table", html->file);
 563   if (item->notes)
 564     {
 565       fputs (" title=\"", html->file);
 566       escape_string (html->file, item->notes, " ", "\n");
 567       putc ('"', html->file);
 568     }
 569   fputs (">\n", html->file);
 570
 571   const struct table_item_text *caption = table_item_get_caption (item);
 572   if (caption)
 573     {
 574       put_tfoot (html, t, &tfoot);
 575       html_put_table_item_text (html, caption);
 576     }
 577   const struct footnote **f;
 578   size_t n_footnotes = table_collect_footnotes (item, &f);
 579
 580   for (size_t i = 0; i < n_footnotes; i++)
 581     {
 582       put_tfoot (html, t, &tfoot);
 583       escape_tag (html->file, "sup", f[i]->marker, " ", "<br>");
 584       escape_string (html->file, f[i]->content, " ", "<br>");
 585     }
 586   free (f);
 587   if (tfoot)
 588     {
 589       fputs ("</td>\n", html->file);
 590       fputs ("</tr>\n", html->file);
 591       fputs ("</tfoot>\n", html->file);
 592     }
 593
 594   const struct table_item_text *title = table_item_get_title (item);
 595   const struct table_item_layers *layers = table_item_get_layers (item);
 596   if (title || layers)
 597     {
 598       fputs ("<caption>", html->file);
 599       if (title)
 600         html_put_table_item_text (html, title);
 601       if (title && layers)
 602         fputs ("<br>\n", html->file);
 603       if (layers)
 604         html_put_table_item_layers (html, layers);
 605       fputs ("</caption>\n", html->file);
 606     }
 607
 608   fputs ("<tbody>\n", html->file);
 609
 610   for (y = 0; y < t->n[V]; y++)
 611     {
 612       int x;
 613
 614       fputs ("<tr>\n", html->file);
 615       for (x = 0; x < t->n[H];)
 616         {
 617           struct table_cell cell;
 618           const char *tag;
 619
 620           table_get_cell (t, x, y, &cell);
 621           if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
 622             goto next_1;
 623
 624           /* output <td> or <th> tag. */
 625           bool is_header = (y < t->h[V][0]
 626                             || y >= t->n[V] - t->h[V][1]
 627                             || x < t->h[H][0]
 628                             || x >= t->n[H] - t->h[H][1]);
 629           tag = is_header ? "th" : "td";
 630           fprintf (html->file, "<%s", tag);
 631
 632           struct css_style style;
 633           style_start (&style, html->file);
 634           enum table_halign halign = table_halign_interpret (
 635             cell.style->cell_style.halign, cell.options & TAB_NUMERIC);
 636
 637           switch (halign)
 638             {
 639             case TABLE_HALIGN_RIGHT:
 640               put_style (&style, "text-align", "right");
 641               break;
 642             case TABLE_HALIGN_CENTER:
 643               put_style (&style, "text-align", "center");
 644               break;
 645             default:
 646               /* Do nothing */
 647               break;
 648             }
 649
 650           if (cell.options & TAB_ROTATE)
 651             put_style (&style, "writing-mode", "sideways-lr");
 652
 653           if (cell.style->cell_style.valign != TABLE_VALIGN_TOP)
 654             {
 655               put_style (&style, "vertical-align",
 656                          (cell.style->cell_style.valign == TABLE_VALIGN_BOTTOM
 657                           ? "bottom" : "middle"));
 658             }
 659
 660           const struct font_style *fs = &cell.style->font_style;
 661           char bgcolor[32];
 662           if (format_color (fs->bg[y % 2],
 663                             (struct cell_color) CELL_COLOR_WHITE,
 664                             bgcolor, sizeof bgcolor))
 665             put_style (&style, "background", bgcolor);
 666
 667           char fgcolor[32];
 668           if (format_color (fs->fg[y % 2],
 669                             (struct cell_color) CELL_COLOR_BLACK,
 670                             fgcolor, sizeof fgcolor))
 671             put_style (&style, "color", fgcolor);
 672
 673           if (fs->typeface)
 674             {
 675               put_style (&style, "font-family", "\"");
 676               escape_string (html->file, fs->typeface, " ", "\n");
 677               putc ('"', html->file);
 678             }
 679           if (fs->bold)
 680             put_style (&style, "font-weight", "bold");
 681           if (fs->italic)
 682             put_style (&style, "font-style", "italic");
 683           if (fs->underline)
 684             put_style (&style, "text-decoration", "underline");
 685           if (fs->size)
 686             {
 687               char buf[32];
 688               snprintf (buf, sizeof buf, "%dpt", fs->size);
 689               put_style (&style, "font-size", buf);
 690             }
 691
 692           int colspan = table_cell_colspan (&cell);
 693           int rowspan = table_cell_rowspan (&cell);
 694
 695           if (html->borders)
 696             {
 697               /* Cell borders. */
 698               struct cell_color color;
 699
 700               int top = table_get_rule (t, TABLE_VERT, x, y, &color);
 701               put_border (&style, top, &color, "top");
 702
 703               if (y + rowspan == t->n[V])
 704                 {
 705                   int bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan,
 706                                            &color);
 707                   put_border (&style, bottom, &color, "bottom");
 708                 }
 709
 710               int left = table_get_rule (t, TABLE_HORZ, x, y, &color);
 711               put_border (&style, left, &color, "left");
 712
 713               if (x + colspan == t->n[H])
 714                 {
 715                   int right = table_get_rule (t, TABLE_HORZ, x + colspan, y,
 716                                           &color);
 717                   put_border (&style, right, &color, "right");
 718                 }
 719             }
 720           style_end (&style);
 721
 722           if (colspan > 1)
 723             fprintf (html->file, " colspan=\"%d\"", colspan);
 724
 725           if (rowspan > 1)
 726             fprintf (html->file, " rowspan=\"%d\"", rowspan);
 727
 728           putc ('>', html->file);
 729
 730           html_put_table_cell_text (html, &cell);
 731
 732           /* output </th> or </td>. */
 733           fprintf (html->file, "</%s>\n", tag);
 734
 735         next_1:
 736           x = cell.d[TABLE_HORZ][1];
 737         }
 738       fputs ("</tr>\n", html->file);
 739     }
 740
 741   fputs ("</tbody>\n", html->file);
 742   fputs ("</table>\n\n", html->file);
 743 }
 744
 745 struct output_driver_factory html_driver_factory =
 746   { "html", "pspp.html", html_create };
 747
 748 static const struct output_driver_class html_driver_class =
 749   {
 750     "html",
 751     html_destroy,
 752     html_submit,
 753     NULL,
 754   };