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 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_TITLE:
 265           print_title_tag (html->file, "H1", s);
 266           break;
 267
 268         case TEXT_ITEM_SUBTITLE:
 269           print_title_tag (html->file, "H2", s);
 270           break;
 271
 272         case TEXT_ITEM_COMMAND_OPEN:
 273           fprintf (html->file, "<DIV class=\"");
 274           escape_string (html->file, s, strlen (s), "_", "<BR>");
 275           fprintf (html->file, "\">");
 276           print_title_tag (html->file, "H3", s);
 277           break;
 278
 279         case TEXT_ITEM_COMMAND_CLOSE:
 280           fprintf (html->file, "</DIV>\n");
 281           break;
 282
 283         case TEXT_ITEM_SUBHEAD:
 284           print_title_tag (html->file, "H4", s);
 285           break;
 286
 287         case TEXT_ITEM_SYNTAX:
 288           fprintf (html->file, "<PRE class=\"syntax\">");
 289           escape_string (html->file, s, strlen (s), " ", "<BR>");
 290           fprintf (html->file, "</PRE>\n");
 291           break;
 292
 293         case TEXT_ITEM_PARAGRAPH:
 294           print_title_tag (html->file, "P", s);
 295           break;
 296
 297         case TEXT_ITEM_MONOSPACE:
 298           print_title_tag (html->file, "PRE", s); /* should be <P><TT> */
 299           break;
 300
 301         case TEXT_ITEM_BLANK_LINE:
 302           fputs ("<BR>", html->file);
 303           break;
 304
 305         case TEXT_ITEM_EJECT_PAGE:
 306           /* Nothing to do. */
 307           break;
 308
 309         case TEXT_ITEM_COMMENT:
 310         case TEXT_ITEM_ECHO:
 311           /* We print out syntax anyway, so nothing to do here either. */
 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       const struct msg *msg = message_item_get_msg (message_item);
 319       char *s = msg_to_string (msg, message_item->command_name);
 320       print_title_tag (html->file, "P", s);
 321       free (s);
 322     }
 323 }
 324
 325 /* Write LENGTH characters in TEXT to file F, escaping characters as necessary
 326    for HTML.  Spaces are replaced by SPACE, which should be " " or "&nbsp;"
 327    New-lines are replaced by NEWLINE, which might be "<BR>" or "\n" or
 328    something else appropriate. */
 329 static void
 330 escape_string (FILE *file,
 331                const char *text, size_t length,
 332                const char *space, const char *newline)
 333 {
 334   while (length-- > 0)
 335     {
 336       char c = *text++;
 337       switch (c)
 338         {
 339         case '\n':
 340           fputs (newline, file);
 341           break;
 342         case '&':
 343           fputs ("&amp;", file);
 344           break;
 345         case '<':
 346           fputs ("&lt;", file);
 347           break;
 348         case '>':
 349           fputs ("&gt;", file);
 350           break;
 351         case ' ':
 352           fputs (space, file);
 353           break;
 354         case '"':
 355           fputs ("&quot;", file);
 356           break;
 357         default:
 358           putc (c, file);
 359           break;
 360         }
 361     }
 362 }
 363
 364 static const char *
 365 border_to_css (int border)
 366 {
 367   switch (border)
 368     {
 369     case TAL_NONE:
 370       return NULL;
 371
 372     case TAL_SOLID:
 373       return "solid";
 374
 375     case TAL_DASHED:
 376       return "dashed";
 377
 378     case TAL_THICK:
 379       return "thick solid";
 380
 381     case TAL_THIN:
 382       return "thin solid";
 383
 384     case TAL_DOUBLE:
 385       return "double";
 386
 387     default:
 388       return NULL;
 389     }
 390
 391 }
 392
 393 static void
 394 put_border (FILE *file, int *n_borders, int style, const char *border_name)
 395 {
 396   const char *css = border_to_css (style);
 397   if (css)
 398     {
 399       fprintf (file, "%sborder-%s: %s",
 400                (*n_borders)++ == 0 ? " STYLE=\"" : "; ",
 401                border_name, css);
 402     }
 403 }
 404
 405 static void
 406 put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
 407 {
 408   if (!*tfoot)
 409     {
 410       fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>", table_nc (t));
 411       *tfoot = true;
 412     }
 413   else
 414     fputs ("\n<BR>", html->file);
 415 }
 416
 417 static void
 418 html_put_footnote_markers (struct html_driver *html,
 419                            const struct footnote **footnotes,
 420                            size_t n_footnotes)
 421 {
 422   if (n_footnotes > 0)
 423     {
 424       fputs ("<SUP>", html->file);
 425       for (size_t i = 0; i < n_footnotes; i++)
 426         {
 427           const struct footnote *f = footnotes[i];
 428
 429           if (i > 0)
 430             putc (',', html->file);
 431           escape_string (html->file, f->marker,
 432                          strlen (f->marker), " ", "<BR>");
 433         }
 434       fputs ("</SUP>", html->file);
 435     }
 436 }
 437
 438 static void
 439 html_put_table_item_text (struct html_driver *html,
 440                           const struct table_item_text *text)
 441 {
 442   escape_string (html->file, text->content, strlen (text->content),
 443                  " ", "<BR>");
 444   html_put_footnote_markers (html, text->footnotes, text->n_footnotes);
 445 }
 446
 447 static void
 448 html_output_table (struct html_driver *html, const struct table_item *item)
 449 {
 450   const struct table *t = table_item_get_table (item);
 451   bool tfoot = false;
 452   int y;
 453
 454   fputs ("<TABLE>", html->file);
 455
 456   const struct table_item_text *caption = table_item_get_caption (item);
 457   if (caption)
 458     {
 459       put_tfoot (html, t, &tfoot);
 460       html_put_table_item_text (html, caption);
 461     }
 462   const struct footnote **f;
 463   size_t n_footnotes = table_collect_footnotes (item, &f);
 464
 465   for (size_t i = 0; i < n_footnotes; i++)
 466     if (f[i])
 467       {
 468         put_tfoot (html, t, &tfoot);
 469         fputs ("<SUP>", html->file);
 470         escape_string (html->file, f[i]->marker, strlen (f[i]->marker),
 471                        " ", "<BR>");
 472         fputs ("</SUP> ", html->file);
 473         escape_string (html->file, f[i]->content, strlen (f[i]->content),
 474                        " ", "<BR>");
 475       }
 476   free (f);
 477   if (tfoot)
 478     fputs ("</TD></TR></TFOOT>\n", html->file);
 479
 480   fputs ("<TBODY VALIGN=\"TOP\">\n", html->file);
 481
 482   const struct table_item_text *title = table_item_get_title (item);
 483   if (title)
 484     {
 485       fputs ("  <CAPTION>", html->file);
 486       html_put_table_item_text (html, title);
 487       fputs ("</CAPTION>\n", html->file);
 488     }
 489
 490   for (y = 0; y < table_nr (t); y++)
 491     {
 492       int x;
 493
 494       fputs ("  <TR>\n", html->file);
 495       for (x = 0; x < table_nc (t); )
 496         {
 497           const struct cell_contents *c;
 498           struct table_cell cell;
 499           const char *tag;
 500           bool is_header;
 501           int colspan, rowspan;
 502           int top, left, right, bottom;
 503
 504           table_get_cell (t, x, y, &cell);
 505           if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
 506             goto next_1;
 507
 508           /* Output <TD> or <TH> tag. */
 509           is_header = (y < table_ht (t)
 510                        || y >= table_nr (t) - table_hb (t)
 511                        || x < table_hl (t)
 512                        || x >= table_nc (t) - table_hr (t));
 513           tag = is_header ? "TH" : "TD";
 514           fprintf (html->file, "    <%s", tag);
 515
 516           int halign = (cell.n_contents > 0
 517                         ? cell.contents[0].options & TAB_HALIGN
 518                         : TAB_LEFT);
 519           if (halign != TAB_LEFT)
 520             fprintf (html->file, " ALIGN=\"%s\"",
 521                      halign == TAB_RIGHT ? "RIGHT" : "CENTER");
 522
 523           int valign = (cell.n_contents > 0
 524                         ? cell.contents[0].options & TAB_VALIGN
 525                         : TAB_LEFT);
 526           if (valign != TAB_TOP)
 527             fprintf (html->file, " ALIGN=\"%s\"",
 528                      valign == TAB_BOTTOM ? "BOTTOM" : "MIDDLE");
 529
 530           colspan = table_cell_colspan (&cell);
 531           if (colspan > 1)
 532             fprintf (html->file, " COLSPAN=\"%d\"", colspan);
 533
 534           rowspan = table_cell_rowspan (&cell);
 535           if (rowspan > 1)
 536             fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
 537
 538           if (html->borders)
 539             {
 540               /* Cell borders. */
 541               int n_borders = 0;
 542
 543               top = table_get_rule (t, TABLE_VERT, x, y);
 544               put_border (html->file, &n_borders, top, "top");
 545
 546               if (y + rowspan == table_nr (t))
 547                 {
 548                   bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan);
 549                   put_border (html->file, &n_borders, bottom, "bottom");
 550                 }
 551
 552               left = table_get_rule (t, TABLE_HORZ, x, y);
 553               put_border (html->file, &n_borders, left, "left");
 554
 555               if (x + colspan == table_nc (t))
 556                 {
 557                   right = table_get_rule (t, TABLE_HORZ, x + colspan, y);
 558                   put_border (html->file, &n_borders, right, "right");
 559                 }
 560
 561               if (n_borders > 0)
 562                 fputs ("\"", html->file);
 563             }
 564
 565           putc ('>', html->file);
 566
 567           /* Output cell contents. */
 568           for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
 569             {
 570               const char *s = c->text;
 571
 572               if (c->options & TAB_EMPH)
 573                 fputs ("<EM>", html->file);
 574               if (c->options & TAB_FIX)
 575                 {
 576                   fputs ("<TT>", html->file);
 577                   escape_string (html->file, s, strlen (s), "&nbsp;", "<BR>");
 578                   fputs ("</TT>", html->file);
 579                 }
 580               else
 581                 {
 582                   s += strspn (s, CC_SPACES);
 583                   escape_string (html->file, s, strlen (s), " ", "<BR>");
 584                 }
 585               if (c->options & TAB_EMPH)
 586                 fputs ("</EM>", html->file);
 587
 588               html_put_footnote_markers (html, c->footnotes, c->n_footnotes);
 589             }
 590
 591           /* Output </TH> or </TD>. */
 592           fprintf (html->file, "</%s>\n", tag);
 593
 594         next_1:
 595           x = cell.d[TABLE_HORZ][1];
 596           table_cell_free (&cell);
 597         }
 598       fputs ("  </TR>\n", html->file);
 599     }
 600
 601   fputs ("</TBODY></TABLE>\n\n", html->file);
 602 }
 603
 604 struct output_driver_factory html_driver_factory =
 605   { "html", "pspp.html", html_create };
 606
 607 static const struct output_driver_class html_driver_class =
 608   {
 609     "html",
 610     html_destroy,
 611     html_submit,
 612     NULL,
 613   };