Clean up output subsystem.
[pspp-builds.git] / src / output / html.c
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    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, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 #include <config.h>
21 #include "chart.h"
22 #include "htmlP.h"
23 #include <libpspp/message.h>
24 #include <errno.h>
25 #include <stdlib.h>
26 #include <ctype.h>
27 #include <time.h>
28 #include <unistd.h>
29
30 #include <libpspp/alloc.h>
31 #include <libpspp/compiler.h>
32 #include <libpspp/message.h>
33 #include <data/filename.h>
34 #include "error.h"
35 #include "getline.h"
36 #include "getlogin_r.h"
37 #include "output.h"
38 #include "manager.h"
39 #include "table.h"
40 #include <libpspp/version.h>
41 #include <data/make-file.h>
42
43 #include "gettext.h"
44 #define _(msgid) gettext (msgid)
45
46 static void escape_string (FILE *file,
47                            const char *text, size_t length,
48                            const char *space);
49 static bool handle_option (struct outp_driver *this,
50                            const char *key, const struct string *val);
51 static void print_title_tag (FILE *file, const char *name,
52                              const char *content);
53
54 static bool
55 html_open_driver (struct outp_driver *this, const char *options)
56 {
57   struct html_driver_ext *x;
58
59   this->ext = x = xmalloc (sizeof *x);
60   x->file_name = xstrdup ("pspp.html");
61   x->file = NULL;
62
63   outp_parse_options (options, handle_option, this);
64
65   x->file = fn_open (x->file_name, "w");
66   if (x->file == NULL)
67     {
68       error (0, errno, _("opening HTML output file: %s"), x->file_name);
69       goto error;
70     }
71  
72   fputs ("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"\n"
73          "   \"http://www.w3.org/TR/html4/loose.dtd\">\n", x->file);
74   fputs ("<HTML>\n", x->file);
75   fputs ("<HEAD>\n", x->file);
76   /* The <TITLE> tag is required, so we use a default if the user
77      didn't provide one. */
78   print_title_tag (x->file,
79                    "TITLE", outp_title ? outp_title : _("PSPP Output"));
80   fprintf (x->file, "<META NAME=\"generator\" CONTENT=\"%s\">\n", version);
81   fputs ("<META HTTP-EQUIV=\"Content-Type\" "
82          "CONTENT=\"text/html; charset=ISO-8859-1\">\n", x->file);
83   fputs ("</HEAD>\n", x->file);
84   fputs ("<BODY BGCOLOR=\"#ffffff\" TEXT=\"#000000\"\n", x->file);
85   fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", x->file);
86   print_title_tag (x->file, "H1", outp_title);
87   print_title_tag (x->file, "H2", outp_subtitle);
88
89   return true;
90
91  error:
92   this->class->close_driver (this);
93   return false;
94 }
95
96 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
97    necessary for HTML. */
98 static void
99 print_title_tag (FILE *file, const char *name, const char *content) 
100 {
101   if (content != NULL) 
102     {
103       fprintf (file, "<%s>", name);
104       escape_string (file, content, strlen (content), " ");
105       fprintf (file, "</%s>\n", name);
106     }
107 }
108
109 static bool
110 html_close_driver (struct outp_driver *this)
111 {
112   struct html_driver_ext *x = this->ext;
113   bool ok;
114  
115   if (x->file != NULL) 
116     {
117       fprintf (x->file,
118                "</BODY>\n"
119                "</HTML>\n"
120                "<!-- end of file -->\n");
121       ok = fn_close (x->file_name, x->file) == 0;
122       x->file = NULL; 
123     }
124   else
125     ok = true;
126   free (x->file_name);
127   free (x);
128    
129   return ok;
130 }
131
132 /* Link the image contained in FILE_NAME to the 
133    HTML stream in FILE. */
134 static void
135 link_image (FILE *file, char *file_name)
136 {
137   fprintf (file, "<IMG SRC=\"%s\"/>", file_name);
138  }
139
140 /* Generic option types. */
141 enum
142   {
143     string_arg,
144     nonneg_int_arg
145   };
146
147 /* All the options that the HTML driver supports. */
148 static struct outp_option option_tab[] =
149   {
150     {"output-file",             string_arg,     0},
151     {NULL, 0, 0},
152   };
153
154 static bool
155 handle_option (struct outp_driver *this,
156                const char *key, const struct string *val)
157 {
158   struct html_driver_ext *x = this->ext;
159   int subcat;
160
161   switch (outp_match_keyword (key, option_tab, &subcat))
162     {
163     case -1:
164       error (0, 0,
165              _("unknown configuration parameter `%s' for HTML device driver"),
166              key);
167       break;
168     case string_arg:
169       free (x->file_name);
170       x->file_name = xstrdup (ds_c_str (val));
171       break;
172     default:
173       abort ();
174     }
175   
176   return true;
177 }
178
179 static void output_tab_table (struct outp_driver *, struct tab_table *);
180
181 static void
182 html_submit (struct outp_driver *this, struct som_entity *s)
183 {
184   extern struct som_table_class tab_table_class;
185   struct html_driver_ext *x = this->ext;
186   
187   assert (s->class == &tab_table_class ) ;
188
189   switch (s->type) 
190     {
191     case SOM_TABLE:
192       output_tab_table ( this, (struct tab_table *) s->ext);
193       break;
194     case SOM_CHART:
195       link_image (x->file, ((struct chart *)s->ext)->filename);
196       break;
197     default:
198       abort ();
199     }
200 }
201
202 /* Write LENGTH characters in TEXT to file F, escaping characters
203    as necessary for HTML.  Spaces are replaced by SPACE, which
204    should be " " or "&nbsp;". */
205 static void
206 escape_string (FILE *file,
207                const char *text, size_t length,
208                const char *space)
209 {
210   while (length-- > 0)
211     {
212       char c = *text++;
213       switch (c)
214         {
215         case '&':
216           fputs ("&amp;", file);
217           break;
218         case '<':
219           fputs ("&lt;", file);
220           break;
221         case '>':
222           fputs ("&gt;", file);
223           break;
224         case ' ':
225           fputs (space, file);
226           break;
227         default:
228           putc (c, file);
229           break;
230         }
231     }
232 }
233   
234 /* Outputs content for a cell with options OPTS and contents
235    TEXT. */
236 void
237 html_put_cell_contents (struct outp_driver *this,
238                         unsigned int opts, struct fixed_string *text)
239 {
240   struct html_driver_ext *x = this->ext;
241
242   if (!(opts & TAB_EMPTY)) 
243     {
244       if (opts & TAB_EMPH)
245         fputs ("<EM>", x->file);
246       if (opts & TAB_FIX) 
247         {
248           fputs ("<TT>", x->file);
249           escape_string (x->file, ls_c_str (text), ls_length (text), "&nbsp;");
250           fputs ("</TT>", x->file);
251         }
252       else 
253         {
254           size_t initial_spaces = strspn (ls_c_str (text), " \t");
255           escape_string (x->file,
256                          ls_c_str (text) + initial_spaces,
257                          ls_length (text) - initial_spaces,
258                          " "); 
259         }
260       if (opts & TAB_EMPH)
261         fputs ("</EM>", x->file);
262     }
263 }
264
265 /* Write table T to THIS output driver. */
266 static void
267 output_tab_table (struct outp_driver *this, struct tab_table *t)
268 {
269   struct html_driver_ext *x = this->ext;
270   
271   if (t->nr == 1 && t->nc == 1)
272     {
273       fputs ("<P>", x->file);
274       html_put_cell_contents (this, t->ct[0], t->cc);
275       fputs ("</P>\n", x->file);
276       
277       return;
278     }
279
280   fputs ("<TABLE BORDER=1>\n", x->file);
281   
282   if (!ls_empty_p (&t->title))
283     {
284       fprintf (x->file, "  <CAPTION>");
285       escape_string (x->file, ls_c_str (&t->title), ls_length (&t->title),
286                      " ");
287       fputs ("</CAPTION>\n", x->file);
288     }
289   
290   {
291     int r;
292     unsigned char *ct = t->ct;
293
294     for (r = 0; r < t->nr; r++)
295       {
296         int c;
297         
298         fputs ("  <TR>\n", x->file);
299         for (c = 0; c < t->nc; c++, ct++)
300           {
301             struct fixed_string *cc;
302             const char *tag;
303             struct tab_joined_cell *j = NULL;
304
305             cc = t->cc + c + r * t->nc;
306             if (*ct & TAB_JOIN)
307               {
308                 j = (struct tab_joined_cell *) ls_c_str (cc);
309                 cc = &j->contents;
310                 if (j->x1 != c || j->y1 != r)
311                   continue; 
312               }
313
314             /* Output <TD> or <TH> tag. */
315             tag = (r < t->t || r >= t->nr - t->b
316                    || c < t->l || c >= t->nc - t->r) ? "TH" : "TD";
317             fprintf (x->file, "    <%s ALIGN=%s",
318                      tag,
319                      (*ct & TAB_ALIGN_MASK) == TAB_LEFT ? "LEFT"
320                      : (*ct & TAB_ALIGN_MASK) == TAB_RIGHT ? "RIGHT"
321                      : "CENTER");
322             if (*ct & TAB_JOIN)
323               {
324                 if (j->x2 - j->x1 > 1)
325                   fprintf (x->file, " COLSPAN=%d", j->x2 - j->x1);
326                 if (j->y2 - j->y1 > 1)
327                   fprintf (x->file, " ROWSPAN=%d", j->y2 - j->y1);
328               }
329             putc ('>', x->file);
330
331             /* Output cell contents. */
332             html_put_cell_contents (this, *ct, cc);
333
334             /* Output </TH> or </TD>. */
335             fprintf (x->file, "</%s>\n", tag);
336           }
337         fputs ("  </TR>\n", x->file);
338       }
339   }
340               
341   fputs ("</TABLE>\n\n", x->file);
342 }
343
344 static void
345 html_initialise_chart(struct outp_driver *d UNUSED, struct chart *ch)
346 {
347
348   FILE  *fp;
349
350   make_unique_file_stream(&fp, &ch->filename);
351
352 #ifdef NO_CHARTS
353   ch->lp = 0;
354 #else
355   ch->pl_params = pl_newplparams();
356   ch->lp = pl_newpl_r ("png", 0, fp, stderr, ch->pl_params);
357 #endif
358
359 }
360
361 static void 
362 html_finalise_chart(struct outp_driver *d UNUSED, struct chart *ch)
363 {
364   free(ch->filename);
365 }
366
367
368
369 /* HTML driver class. */
370 struct outp_class html_class =
371   {
372     "html",
373     1,
374
375     html_open_driver,
376     html_close_driver,
377
378     NULL,
379     NULL,
380
381     html_submit,
382
383     NULL,
384     NULL,
385     NULL,
386     html_initialise_chart,
387     html_finalise_chart
388   };