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