1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009-2014 Free Software Foundation, Inc.
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.
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.
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/>. */
19 /* A driver for creating OpenDocument Format text files from PSPP's output */
23 #include <libxml/xmlwriter.h>
28 #include <sys/types.h>
32 #include "libpspp/assertion.h"
33 #include "libpspp/cast.h"
34 #include "libpspp/message.h"
35 #include "libpspp/str.h"
36 #include "libpspp/temp-file.h"
37 #include "libpspp/version.h"
38 #include "libpspp/zip-writer.h"
39 #include "data/file-handle-def.h"
40 #include "output/driver-provider.h"
41 #include "output/message-item.h"
42 #include "output/options.h"
43 #include "output/tab.h"
44 #include "output/table-item.h"
45 #include "output/table-provider.h"
46 #include "output/text-item.h"
48 #include "gl/xalloc.h"
51 #define _(msgid) gettext (msgid)
53 #define _xml(X) (CHAR_CAST (const xmlChar *, X))
57 struct output_driver driver;
59 struct zip_writer *zip; /* ZIP file writer. */
60 char *file_name; /* Output file name. */
63 xmlTextWriterPtr content_wtr; /* XML writer. */
64 FILE *content_file; /* Temporary file. */
67 xmlTextWriterPtr manifest_wtr; /* XML writer. */
68 FILE *manifest_file; /* Temporary file. */
70 /* Number of tables so far. */
73 /* Number of footnotes so far. */
77 static const struct output_driver_class odt_driver_class;
79 static struct odt_driver *
80 odt_driver_cast (struct output_driver *driver)
82 assert (driver->class == &odt_driver_class);
83 return UP_CAST (driver, struct odt_driver, driver);
86 /* Create the "mimetype" file needed by ODF */
88 create_mimetype (struct zip_writer *zip)
92 fp = create_temp_file ();
95 msg_error (errno, _("error creating temporary file"));
99 fprintf (fp, "application/vnd.oasis.opendocument.text");
100 zip_writer_add (zip, fp, "mimetype");
101 close_temp_file (fp);
106 /* Creates a new temporary file and stores it in *FILE, then creates an XML
107 writer for it and stores it in *W. */
109 create_writer (FILE **file, xmlTextWriterPtr *w)
111 /* XXX this can fail */
112 *file = create_temp_file ();
113 *w = xmlNewTextWriter (xmlOutputBufferCreateFile (*file, NULL));
115 xmlTextWriterStartDocument (*w, NULL, "UTF-8", NULL);
120 register_file (struct odt_driver *odt, const char *filename)
122 assert (odt->manifest_wtr);
123 xmlTextWriterStartElement (odt->manifest_wtr, _xml("manifest:file-entry"));
124 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:media-type"), _xml("text/xml"));
125 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:full-path"), _xml (filename));
126 xmlTextWriterEndElement (odt->manifest_wtr);
130 write_style_data (struct odt_driver *odt)
135 create_writer (&file, &w);
136 register_file (odt, "styles.xml");
138 xmlTextWriterStartElement (w, _xml ("office:document-styles"));
139 xmlTextWriterWriteAttribute (w, _xml ("xmlns:office"),
140 _xml ("urn:oasis:names:tc:opendocument:xmlns:office:1.0"));
142 xmlTextWriterWriteAttribute (w, _xml ("xmlns:style"),
143 _xml ("urn:oasis:names:tc:opendocument:xmlns:style:1.0"));
145 xmlTextWriterWriteAttribute (w, _xml ("xmlns:fo"),
146 _xml ("urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0") );
148 xmlTextWriterWriteAttribute (w, _xml ("office:version"), _xml ("1.1"));
152 xmlTextWriterStartElement (w, _xml ("office:styles"));
156 xmlTextWriterStartElement (w, _xml ("style:style"));
157 xmlTextWriterWriteAttribute (w, _xml ("style:name"),
160 xmlTextWriterWriteAttribute (w, _xml ("style:family"),
163 xmlTextWriterWriteAttribute (w, _xml ("style:class"),
166 xmlTextWriterEndElement (w); /* style:style */
170 xmlTextWriterStartElement (w, _xml ("style:style"));
171 xmlTextWriterWriteAttribute (w, _xml ("style:name"),
172 _xml ("Table_20_Contents"));
174 xmlTextWriterWriteAttribute (w, _xml ("style:display-name"),
175 _xml ("Table Contents"));
177 xmlTextWriterWriteAttribute (w, _xml ("style:family"),
180 xmlTextWriterWriteAttribute (w, _xml ("style:parent-style-name"),
183 xmlTextWriterWriteAttribute (w, _xml ("style:class"),
186 xmlTextWriterEndElement (w); /* style:style */
190 xmlTextWriterStartElement (w, _xml ("style:style"));
191 xmlTextWriterWriteAttribute (w, _xml ("style:name"),
192 _xml ("Table_20_Heading"));
194 xmlTextWriterWriteAttribute (w, _xml ("style:display-name"),
195 _xml ("Table Heading"));
197 xmlTextWriterWriteAttribute (w, _xml ("style:family"),
200 xmlTextWriterWriteAttribute (w, _xml ("style:parent-style-name"),
201 _xml ("Table_20_Contents"));
203 xmlTextWriterWriteAttribute (w, _xml ("style:class"),
207 xmlTextWriterStartElement (w, _xml ("style:text-properties"));
208 xmlTextWriterWriteAttribute (w, _xml ("fo:font-weight"), _xml ("bold"));
209 xmlTextWriterWriteAttribute (w, _xml ("style:font-weight-asian"), _xml ("bold"));
210 xmlTextWriterWriteAttribute (w, _xml ("style:font-weight-complex"), _xml ("bold"));
211 xmlTextWriterEndElement (w); /* style:text-properties */
213 xmlTextWriterEndElement (w); /* style:style */
217 xmlTextWriterEndElement (w); /* office:styles */
218 xmlTextWriterEndElement (w); /* office:document-styles */
220 xmlTextWriterEndDocument (w);
221 xmlFreeTextWriter (w);
222 zip_writer_add (odt->zip, file, "styles.xml");
223 close_temp_file (file);
227 write_meta_data (struct odt_driver *odt)
232 create_writer (&file, &w);
233 register_file (odt, "meta.xml");
235 xmlTextWriterStartElement (w, _xml ("office:document-meta"));
236 xmlTextWriterWriteAttribute (w, _xml ("xmlns:office"), _xml ("urn:oasis:names:tc:opendocument:xmlns:office:1.0"));
237 xmlTextWriterWriteAttribute (w, _xml ("xmlns:dc"), _xml ("http://purl.org/dc/elements/1.1/"));
238 xmlTextWriterWriteAttribute (w, _xml ("xmlns:meta"), _xml ("urn:oasis:names:tc:opendocument:xmlns:meta:1.0"));
239 xmlTextWriterWriteAttribute (w, _xml ("xmlns:ooo"), _xml("http://openoffice.org/2004/office"));
240 xmlTextWriterWriteAttribute (w, _xml ("office:version"), _xml("1.1"));
242 xmlTextWriterStartElement (w, _xml ("office:meta"));
244 xmlTextWriterStartElement (w, _xml ("meta:generator"));
245 xmlTextWriterWriteString (w, _xml (version));
246 xmlTextWriterEndElement (w);
252 time_t t = time (NULL);
253 struct tm *tm = localtime (&t);
255 strftime (buf, 30, "%Y-%m-%dT%H:%M:%S", tm);
257 xmlTextWriterStartElement (w, _xml ("meta:creation-date"));
258 xmlTextWriterWriteString (w, _xml (buf));
259 xmlTextWriterEndElement (w);
261 xmlTextWriterStartElement (w, _xml ("dc:date"));
262 xmlTextWriterWriteString (w, _xml (buf));
263 xmlTextWriterEndElement (w);
268 struct passwd *pw = getpwuid (getuid ());
271 xmlTextWriterStartElement (w, _xml ("meta:initial-creator"));
272 xmlTextWriterWriteString (w, _xml (strtok (pw->pw_gecos, ",")));
273 xmlTextWriterEndElement (w);
275 xmlTextWriterStartElement (w, _xml ("dc:creator"));
276 xmlTextWriterWriteString (w, _xml (strtok (pw->pw_gecos, ",")));
277 xmlTextWriterEndElement (w);
282 xmlTextWriterEndElement (w);
283 xmlTextWriterEndElement (w);
284 xmlTextWriterEndDocument (w);
285 xmlFreeTextWriter (w);
286 zip_writer_add (odt->zip, file, "meta.xml");
287 close_temp_file (file);
290 static struct output_driver *
291 odt_create (struct file_handle *fh, enum settings_output_devices device_type,
292 struct string_map *o UNUSED)
294 struct output_driver *d;
295 struct odt_driver *odt;
296 struct zip_writer *zip;
297 const char *file_name = fh_get_file_name (fh);
299 zip = zip_writer_create (file_name);
303 odt = xzalloc (sizeof *odt);
306 output_driver_init (d, &odt_driver_class, file_name, device_type);
309 odt->file_name = xstrdup (file_name);
311 if (!create_mimetype (zip))
313 output_driver_destroy (d);
317 /* Create the manifest */
318 create_writer (&odt->manifest_file, &odt->manifest_wtr);
320 xmlTextWriterStartElement (odt->manifest_wtr, _xml("manifest:manifest"));
321 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("xmlns:manifest"),
322 _xml("urn:oasis:names:tc:opendocument:xmlns:manifest:1.0"));
325 /* Add a manifest entry for the document as a whole */
326 xmlTextWriterStartElement (odt->manifest_wtr, _xml("manifest:file-entry"));
327 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:media-type"), _xml("application/vnd.oasis.opendocument.text"));
328 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:full-path"), _xml("/"));
329 xmlTextWriterEndElement (odt->manifest_wtr);
332 write_meta_data (odt);
333 write_style_data (odt);
335 create_writer (&odt->content_file, &odt->content_wtr);
336 register_file (odt, "content.xml");
339 /* Some necessary junk at the start */
340 xmlTextWriterStartElement (odt->content_wtr, _xml("office:document-content"));
341 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("xmlns:office"),
342 _xml("urn:oasis:names:tc:opendocument:xmlns:office:1.0"));
344 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("xmlns:text"),
345 _xml("urn:oasis:names:tc:opendocument:xmlns:text:1.0"));
347 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("xmlns:table"),
348 _xml("urn:oasis:names:tc:opendocument:xmlns:table:1.0"));
350 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("office:version"), _xml("1.1"));
352 xmlTextWriterStartElement (odt->content_wtr, _xml("office:body"));
353 xmlTextWriterStartElement (odt->content_wtr, _xml("office:text"));
357 /* Close the manifest */
358 xmlTextWriterEndElement (odt->manifest_wtr);
359 xmlTextWriterEndDocument (odt->manifest_wtr);
360 xmlFreeTextWriter (odt->manifest_wtr);
361 zip_writer_add (odt->zip, odt->manifest_file, "META-INF/manifest.xml");
362 close_temp_file (odt->manifest_file);
368 odt_destroy (struct output_driver *driver)
370 struct odt_driver *odt = odt_driver_cast (driver);
372 if (odt->content_wtr != NULL)
374 xmlTextWriterEndElement (odt->content_wtr); /* office:text */
375 xmlTextWriterEndElement (odt->content_wtr); /* office:body */
376 xmlTextWriterEndElement (odt->content_wtr); /* office:document-content */
378 xmlTextWriterEndDocument (odt->content_wtr);
379 xmlFreeTextWriter (odt->content_wtr);
380 zip_writer_add (odt->zip, odt->content_file, "content.xml");
381 close_temp_file (odt->content_file);
383 zip_writer_close (odt->zip);
386 free (odt->file_name);
391 write_xml_with_line_breaks (struct odt_driver *odt, const char *line_)
393 xmlTextWriterPtr writer = odt->content_wtr;
395 if (!strchr (line_, '\n'))
396 xmlTextWriterWriteString (writer, _xml(line_));
399 char *line = xstrdup (line_);
403 for (p = line; *p; p = newline + 1)
405 newline = strchr (p, '\n');
409 xmlTextWriterWriteString (writer, _xml(p));
414 if (newline > p && newline[-1] == '\r')
418 xmlTextWriterWriteString (writer, _xml(p));
419 xmlTextWriterWriteElement (writer, _xml("text:line-break"), _xml(""));
425 write_footnote (struct odt_driver *odt, const char *footnote)
429 xmlTextWriterStartElement (odt->content_wtr, _xml("text:note"));
430 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:note-class"),
433 xmlTextWriterStartElement (odt->content_wtr, _xml("text:note-citation"));
434 str_format_26adic (++odt->n_footnotes, false, marker, sizeof marker);
435 if (strlen (marker) > 1)
436 xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("text:label"),
439 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:label"),
441 xmlTextWriterEndElement (odt->content_wtr);
443 xmlTextWriterStartElement (odt->content_wtr, _xml("text:note-body"));
444 xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
445 write_xml_with_line_breaks (odt, footnote);
446 xmlTextWriterEndElement (odt->content_wtr);
447 xmlTextWriterEndElement (odt->content_wtr);
449 xmlTextWriterEndElement (odt->content_wtr);
453 write_table (struct odt_driver *odt, const struct table_item *item)
455 const struct table *tab = table_item_get_table (item);
456 const char *caption = table_item_get_caption (item);
457 const char *title = table_item_get_title (item);
460 /* Write a heading for the table */
463 xmlTextWriterStartElement (odt->content_wtr, _xml("text:h"));
464 xmlTextWriterWriteFormatAttribute (odt->content_wtr,
465 _xml("text:outline-level"), "%d", 2);
466 xmlTextWriterWriteString (odt->content_wtr,
467 _xml (table_item_get_title (item)) );
468 xmlTextWriterEndElement (odt->content_wtr);
472 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table"));
473 xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("table:name"),
474 "TABLE-%d", odt->table_num++);
477 /* Start column definitions */
478 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-column"));
479 xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("table:number-columns-repeated"), "%d", table_nc (tab));
480 xmlTextWriterEndElement (odt->content_wtr);
483 /* Deal with row headers */
484 if ( table_ht (tab) > 0)
485 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-header-rows"));
488 /* Write all the rows */
489 for (r = 0 ; r < table_nr (tab); ++r)
491 /* Start row definition */
492 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-row"));
494 /* Write all the columns */
495 for (c = 0 ; c < table_nc (tab) ; ++c)
497 struct table_cell cell;
500 table_get_cell (tab, c, r, &cell);
502 if (c == cell.d[TABLE_HORZ][0] && r == cell.d[TABLE_VERT][0])
504 int colspan = table_cell_colspan (&cell);
505 int rowspan = table_cell_rowspan (&cell);
507 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-cell"));
508 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("office:value-type"), _xml("string"));
511 xmlTextWriterWriteFormatAttribute (
512 odt->content_wtr, _xml("table:number-columns-spanned"),
516 xmlTextWriterWriteFormatAttribute (
517 odt->content_wtr, _xml("table:number-rows-spanned"),
520 for (i = 0; i < cell.n_contents; i++)
522 const struct cell_contents *contents = &cell.contents[i];
525 xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
527 if ( r < table_ht (tab) || c < table_hl (tab) )
528 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Heading"));
530 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Contents"));
532 write_xml_with_line_breaks (odt, contents->text);
534 for (j = 0; j < contents->n_footnotes; j++)
535 write_footnote (odt, contents->footnotes[j]);
537 xmlTextWriterEndElement (odt->content_wtr); /* text:p */
539 xmlTextWriterEndElement (odt->content_wtr); /* table:table-cell */
543 xmlTextWriterStartElement (odt->content_wtr, _xml("table:covered-table-cell"));
544 xmlTextWriterEndElement (odt->content_wtr);
547 table_cell_free (&cell);
550 xmlTextWriterEndElement (odt->content_wtr); /* row */
552 if ( table_ht (tab) > 0 && r == table_ht (tab) - 1)
553 xmlTextWriterEndElement (odt->content_wtr); /* table-header-rows */
556 xmlTextWriterEndElement (odt->content_wtr); /* table */
558 /* Write a caption for the table */
561 xmlTextWriterStartElement (odt->content_wtr, _xml("text:h"));
562 xmlTextWriterWriteFormatAttribute (odt->content_wtr,
563 _xml("text:outline-level"), "%d", 2);
564 xmlTextWriterWriteString (odt->content_wtr,
565 _xml (table_item_get_caption (item)) );
566 xmlTextWriterEndElement (odt->content_wtr);
572 odt_output_text (struct odt_driver *odt, const char *text)
574 xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
575 xmlTextWriterWriteString (odt->content_wtr, _xml(text));
576 xmlTextWriterEndElement (odt->content_wtr);
579 /* Submit a table to the ODT driver */
581 odt_submit (struct output_driver *driver,
582 const struct output_item *output_item)
584 struct odt_driver *odt = odt_driver_cast (driver);
586 if (is_table_item (output_item))
587 write_table (odt, to_table_item (output_item));
588 else if (is_text_item (output_item))
590 struct text_item *text_item = to_text_item (output_item);
592 if (text_item_get_type (text_item) != TEXT_ITEM_COMMAND_CLOSE)
593 odt_output_text (odt, text_item_get_text (text_item));
595 else if (is_message_item (output_item))
597 const struct message_item *message_item = to_message_item (output_item);
598 const struct msg *msg = message_item_get_msg (message_item);
599 char *s = msg_to_string (msg, message_item->command_name);
600 odt_output_text (odt, s);
605 struct output_driver_factory odt_driver_factory =
606 { "odt", "pspp.odf", odt_create };
608 static const struct output_driver_class odt_driver_class =