src/output/html.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009, 2010 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 "libpspp/assertion.h"
  28 #include "libpspp/cast.h"
  29 #include "libpspp/compiler.h"
  30 #include "libpspp/message.h"
  31 #include "libpspp/version.h"
  32 #include "output/cairo.h"
  33 #include "output/chart-item.h"
  34 #include "output/driver-provider.h"
  35 #include "output/message-item.h"
  36 #include "output/options.h"
  37 #include "output/output-item-provider.h"
  38 #include "output/table-provider.h"
  39 #include "output/table-item.h"
  40 #include "output/text-item.h"
  41
  42 #include "error.h"
  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
  52     char *file_name;
  53     char *chart_file_name;
  54
  55     char *command_name;
  56     FILE *file;
  57     size_t chart_cnt;
  58
  59     bool in_syntax;
  60   };
  61
  62 static const struct output_driver_class html_driver_class;
  63
  64 static void html_output_table (struct html_driver *, struct table_item *);
  65 static void escape_string (FILE *file,
  66                            const char *text, size_t length,
  67                            const char *space);
  68 static void print_title_tag (FILE *file, const char *name,
  69                              const char *content);
  70
  71 static struct html_driver *
  72 html_driver_cast (struct output_driver *driver)
  73 {
  74   assert (driver->class == &html_driver_class);
  75   return UP_CAST (driver, struct html_driver, driver);
  76 }
  77
  78 static struct driver_option *
  79 opt (struct output_driver *d, struct string_map *options, const char *key,
  80      const char *default_value)
  81 {
  82   return driver_option_get (d, options, key, default_value);
  83 }
  84
  85 static struct output_driver *
  86 html_create (const char *file_name, enum settings_output_devices device_type,
  87              struct string_map *o)
  88 {
  89   struct output_driver *d;
  90   struct html_driver *html;
  91
  92   html = xzalloc (sizeof *html);
  93   d = &html->driver;
  94   output_driver_init (&html->driver, &html_driver_class, file_name,
  95                       device_type);
  96
  97   html->file_name = xstrdup (file_name);
  98   html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
  99                                                       file_name));
 100   html->file = NULL;
 101   html->chart_cnt = 1;
 102
 103   html->file = fn_open (html->file_name, "w");
 104   if (html->file == NULL)
 105     {
 106       error (0, errno, _("error opening output file `%s'"), html->file_name);
 107       goto error;
 108     }
 109
 110   fputs ("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"\n"
 111          "   \"http://www.w3.org/TR/html4/loose.dtd\">\n", html->file);
 112   fputs ("<HTML>\n", html->file);
 113   fputs ("<HEAD>\n", html->file);
 114   print_title_tag (html->file, "TITLE", _("PSPP Output"));
 115   fprintf (html->file, "<META NAME=\"generator\" CONTENT=\"%s\">\n", version);
 116   fputs ("<META http-equiv=\"Content-Style-Type\" content=\"text/css\">\n",
 117          html->file);
 118   fputs ("<META HTTP-EQUIV=\"Content-Type\" "
 119          "CONTENT=\"text/html; charset=utf-8\">\n", html->file);
 120   fputs ("<STYLE TYPE=\"text/css\">\n"
 121          "<!--\n"
 122          "body {\n"
 123          "  background: white;\n"
 124          "  color: black;\n"
 125          "  padding: 0em 12em 0em 3em;\n"
 126          "  margin: 0\n"
 127          "}\n"
 128          "body>p {\n"
 129          "  margin: 0pt 0pt 0pt 0em\n"
 130          "}\n"
 131          "body>p + p {\n"
 132          "  text-indent: 1.5em;\n"
 133          "}\n"
 134          "h1 {\n"
 135          "  font-size: 150%;\n"
 136          "  margin-left: -1.33em\n"
 137          "}\n"
 138          "h2 {\n"
 139          "  font-size: 125%;\n"
 140          "  font-weight: bold;\n"
 141          "  margin-left: -.8em\n"
 142          "}\n"
 143          "h3 {\n"
 144          "  font-size: 100%;\n"
 145          "  font-weight: bold;\n"
 146          "  margin-left: -.5em }\n"
 147          "h4 {\n"
 148          "  font-size: 100%;\n"
 149          "  margin-left: 0em\n"
 150          "}\n"
 151          "h1, h2, h3, h4, h5, h6 {\n"
 152          "  font-family: sans-serif;\n"
 153          "  color: blue\n"
 154          "}\n"
 155          "html {\n"
 156          "  margin: 0\n"
 157          "}\n"
 158          "code {\n"
 159          "  font-family: sans-serif\n"
 160          "}\n"
 161          "table {\n"
 162          "  border-collapse: collapse;\n"
 163          "  margin-bottom: 1em\n"
 164          "}\n"
 165          "th { background: #dddddd; font-weight: normal; font-style: oblique }\n"
 166          "caption {\n"
 167          "  text-align: left\n"
 168          "}\n"
 169          "-->\n"
 170          "</STYLE>\n",
 171          html->file);
 172   fputs ("</HEAD>\n", html->file);
 173   fputs ("<BODY BGCOLOR=\"#ffffff\" TEXT=\"#000000\"\n", html->file);
 174   fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", html->file);
 175
 176   return d;
 177
 178  error:
 179   output_driver_destroy (d);
 180   return NULL;
 181 }
 182
 183 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
 184    necessary for HTML. */
 185 static void
 186 print_title_tag (FILE *file, const char *name, const char *content)
 187 {
 188   if (content != NULL)
 189     {
 190       fprintf (file, "<%s>", name);
 191       escape_string (file, content, strlen (content), " ");
 192       fprintf (file, "</%s>\n", name);
 193     }
 194 }
 195
 196 static void
 197 html_destroy (struct output_driver *driver)
 198 {
 199   struct html_driver *html = html_driver_cast (driver);
 200
 201   if (html->file != NULL)
 202     {
 203       if (html->in_syntax)
 204         {
 205           fprintf (html->file, "</PRE>\n");
 206           html->in_syntax = false;
 207         }
 208       fprintf (html->file,
 209                "</BODY>\n"
 210                "</HTML>\n"
 211                "<!-- end of file -->\n");
 212       fn_close (html->file_name, html->file);
 213     }
 214   free (html->chart_file_name);
 215   free (html->file_name);
 216   free (html->command_name);
 217   free (html);
 218 }
 219
 220 static bool
 221 is_syntax_item (const struct output_item *item)
 222 {
 223   return (is_text_item (item)
 224           && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX);
 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   output_driver_track_current_command (output_item, &html->command_name);
 234
 235   if (html->in_syntax && !is_syntax_item (output_item))
 236     {
 237       fprintf (html->file, "</PRE>\n");
 238       html->in_syntax = false;
 239     }
 240
 241   if (is_table_item (output_item))
 242     {
 243       struct table_item *table_item = to_table_item (output_item);
 244       html_output_table (html, table_item);
 245     }
 246 #ifdef HAVE_CAIRO
 247   else if (is_chart_item (output_item) && html->chart_file_name != NULL)
 248     {
 249       struct chart_item *chart_item = to_chart_item (output_item);
 250       char *file_name;
 251
 252       file_name = xr_draw_png_chart (chart_item, html->chart_file_name,
 253                                      html->chart_cnt++);
 254       if (file_name != NULL)
 255         {
 256           const char *title = chart_item_get_title (chart_item);
 257           fprintf (html->file, "<IMG SRC=\"%s\" ALT=\"Chart: %s\">",
 258                    file_name, title ? title : _("No description"));
 259           free (file_name);
 260         }
 261     }
 262 #endif  /* HAVE_CAIRO */
 263   else if (is_text_item (output_item))
 264     {
 265       struct text_item *text_item = to_text_item (output_item);
 266       const char *s = text_item_get_text (text_item);
 267
 268       switch (text_item_get_type (text_item))
 269         {
 270         case TEXT_ITEM_TITLE:
 271           print_title_tag (html->file, "H1", s);
 272           break;
 273
 274         case TEXT_ITEM_SUBTITLE:
 275           print_title_tag (html->file, "H2", s);
 276           break;
 277
 278         case TEXT_ITEM_COMMAND_OPEN:
 279           fprintf (html->file, "<DIV class=\"");
 280           escape_string (html->file, s, strlen (s), "_");
 281           fprintf (html->file, "\">");
 282           print_title_tag (html->file, "H3", s);
 283           break;
 284
 285         case TEXT_ITEM_COMMAND_CLOSE:
 286           fprintf (html->file, "</DIV>\n");
 287           break;
 288
 289         case TEXT_ITEM_SUBHEAD:
 290           print_title_tag (html->file, "H4", s);
 291           break;
 292
 293         case TEXT_ITEM_SYNTAX:
 294           if (!html->in_syntax)
 295             {
 296               fprintf (html->file, "<PRE class=\"syntax\">");
 297               html->in_syntax = true;
 298             }
 299           else
 300             putc ('\n', html->file);
 301           escape_string (html->file, s, strlen (s), " ");
 302           break;
 303
 304         case TEXT_ITEM_PARAGRAPH:
 305           print_title_tag (html->file, "P", s);
 306           break;
 307
 308         case TEXT_ITEM_MONOSPACE:
 309           print_title_tag (html->file, "PRE", s); /* should be <P><TT> */
 310           break;
 311
 312         case TEXT_ITEM_BLANK_LINE:
 313           fputs ("<BR>", html->file);
 314           break;
 315
 316         case TEXT_ITEM_EJECT_PAGE:
 317           /* Nothing to do. */
 318           break;
 319
 320         case TEXT_ITEM_COMMENT:
 321         case TEXT_ITEM_ECHO:
 322           /* We print out syntax anyway, so nothing to do here either. */
 323           break;
 324         }
 325     }
 326   else if (is_message_item (output_item))
 327     {
 328       const struct message_item *message_item = to_message_item (output_item);
 329       const struct msg *msg = message_item_get_msg (message_item);
 330       char *s = msg_to_string (msg, html->command_name);
 331       print_title_tag (html->file, "P", s);
 332       free (s);
 333     }
 334 }
 335
 336 /* Write LENGTH characters in TEXT to file F, escaping characters
 337    as necessary for HTML.  Spaces are replaced by SPACE, which
 338    should be " " or "&nbsp;". */
 339 static void
 340 escape_string (FILE *file,
 341                const char *text, size_t length,
 342                const char *space)
 343 {
 344   while (length-- > 0)
 345     {
 346       char c = *text++;
 347       switch (c)
 348         {
 349         case '&':
 350           fputs ("&amp;", file);
 351           break;
 352         case '<':
 353           fputs ("&lt;", file);
 354           break;
 355         case '>':
 356           fputs ("&gt;", file);
 357           break;
 358         case ' ':
 359           fputs (space, file);
 360           break;
 361         case '"':
 362           fputs ("&quot;", file);
 363           break;
 364         default:
 365           putc (c, file);
 366           break;
 367         }
 368     }
 369 }
 370
 371 static void
 372 put_border (FILE *file, int n_borders, int style, const char *border_name)
 373 {
 374   fprintf (file, "%sborder-%s: %s",
 375            n_borders == 0 ? " STYLE=\"" : "; ",
 376            border_name,
 377            style == TAL_1 ? "thin solid" : "double");
 378 }
 379
 380 static void
 381 html_output_table (struct html_driver *html, struct table_item *item)
 382 {
 383   const struct table *t = table_item_get_table (item);
 384   const char *caption;
 385   int x, y;
 386
 387   fputs ("<TABLE>\n", html->file);
 388
 389   caption = table_item_get_caption (item);
 390   if (caption != NULL)
 391     {
 392       fputs ("  <CAPTION>", html->file);
 393       escape_string (html->file, caption, strlen (caption), " ");
 394       fputs ("</CAPTION>\n", html->file);
 395     }
 396
 397   for (y = 0; y < table_nr (t); y++)
 398     {
 399       fputs ("  <TR>\n", html->file);
 400       for (x = 0; x < table_nc (t); x++)
 401         {
 402           struct table_cell cell;
 403           const char *tag;
 404           bool is_header;
 405           int alignment, colspan, rowspan;
 406           int top, left, right, bottom, n_borders;
 407           const char *s;
 408
 409           table_get_cell (t, x, y, &cell);
 410           if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
 411             continue;
 412
 413           /* Output <TD> or <TH> tag. */
 414           is_header = (y < table_ht (t)
 415                        || y >= table_nr (t) - table_hb (t)
 416                        || x < table_hl (t)
 417                        || x >= table_nc (t) - table_hr (t));
 418           tag = is_header ? "TH" : "TD";
 419           fprintf (html->file, "    <%s", tag);
 420
 421           alignment = cell.options & TAB_ALIGNMENT;
 422           if (alignment != TAB_LEFT)
 423             fprintf (html->file, " ALIGN=\"%s\"",
 424                      alignment == TAB_RIGHT ? "RIGHT" : "CENTER");
 425
 426           colspan = table_cell_colspan (&cell);
 427           if (colspan > 1)
 428             fprintf (html->file, " COLSPAN=\"%d\"", colspan);
 429
 430           rowspan = table_cell_rowspan (&cell);
 431           if (rowspan > 1)
 432             fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
 433
 434           /* Cell borders. */
 435           n_borders = 0;
 436
 437           top = table_get_rule (t, TABLE_VERT, x, y);
 438           if (top > TAL_GAP)
 439             put_border (html->file, n_borders++, top, "top");
 440
 441           if (y == table_nr (t) - 1)
 442             {
 443               bottom = table_get_rule (t, TABLE_VERT, x, y + 1);
 444               if (bottom > TAL_GAP)
 445                 put_border (html->file, n_borders++, bottom, "bottom");
 446             }
 447
 448           left = table_get_rule (t, TABLE_HORZ, x, y);
 449           if (left > TAL_GAP)
 450             put_border (html->file, n_borders++, left, "left");
 451
 452           if (x == table_nc (t) - 1)
 453             {
 454               right = table_get_rule (t, TABLE_HORZ, x + 1, y);
 455               if (right > TAL_GAP)
 456                 put_border (html->file, n_borders++, right, "right");
 457             }
 458
 459           if (n_borders > 0)
 460             fputs ("\"", html->file);
 461
 462           putc ('>', html->file);
 463
 464           /* Output cell contents. */
 465           s = cell.contents;
 466           if (cell.options & TAB_EMPH)
 467             fputs ("<EM>", html->file);
 468           if (cell.options & TAB_FIX)
 469             {
 470               fputs ("<TT>", html->file);
 471               escape_string (html->file, s, strlen (s), "&nbsp;");
 472               fputs ("</TT>", html->file);
 473             }
 474           else
 475             {
 476               s += strspn (s, CC_SPACES);
 477               escape_string (html->file, s, strlen (s), " ");
 478             }
 479           if (cell.options & TAB_EMPH)
 480             fputs ("</EM>", html->file);
 481
 482           /* Output </TH> or </TD>. */
 483           fprintf (html->file, "</%s>\n", tag);
 484
 485           table_cell_free (&cell);
 486         }
 487       fputs ("  </TR>\n", html->file);
 488     }
 489
 490   fputs ("</TABLE>\n\n", html->file);
 491 }
 492
 493 struct output_driver_factory html_driver_factory = { "html", html_create };
 494
 495 static const struct output_driver_class html_driver_class =
 496   {
 497     "html",
 498     html_destroy,
 499     html_submit,
 500     NULL,
 501   };