1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010 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>
26 #include <sys/types.h>
30 #include "libpspp/assertion.h"
31 #include "libpspp/cast.h"
32 #include "libpspp/str.h"
33 #include "libpspp/version.h"
34 #include "output/driver-provider.h"
35 #include "output/options.h"
36 #include "output/tab.h"
37 #include "output/table-item.h"
38 #include "output/table-provider.h"
39 #include "output/text-item.h"
41 #include "gl/xalloc.h"
45 #define _(msgid) gettext (msgid)
47 #define _xml(X) (const xmlChar *)(X)
51 struct output_driver driver;
53 char *file_name; /* Output file name. */
56 /* The name of the temporary directory used to construct the ODF */
59 /* Writer for the content.xml file */
60 xmlTextWriterPtr content_wtr;
62 /* Writer fot the manifest.xml file */
63 xmlTextWriterPtr manifest_wtr;
65 /* Number of tables so far. */
69 static const struct output_driver_class odt_driver_class;
71 static struct odt_driver *
72 odt_driver_cast (struct output_driver *driver)
74 assert (driver->class == &odt_driver_class);
75 return UP_CAST (driver, struct odt_driver, driver);
78 /* Create the "mimetype" file needed by ODF */
80 create_mimetype (const char *dirname)
83 struct string filename;
84 ds_init_cstr (&filename, dirname);
85 ds_put_cstr (&filename, "/mimetype");
86 fp = fopen (ds_cstr (&filename), "w");
90 error (0, errno, _("failed to create output file %s"),
92 ds_destroy (&filename);
95 ds_destroy (&filename);
97 fprintf (fp, "application/vnd.oasis.opendocument.text");
103 /* Create a new XML file called FILENAME in the temp directory, and return a writer for it */
104 static xmlTextWriterPtr
105 create_writer (const struct odt_driver *driver, const char *filename)
110 ds_init_cstr (&str, driver->dirname);
111 ds_put_cstr (&str, "/");
112 ds_put_cstr (&str, filename);
114 /* dirname modifies its argument, so we must copy it */
115 copy = xstrdup (ds_cstr (&str));
116 mkdir (dirname (copy), 0700);
119 w = xmlNewTextWriterFilename (ds_cstr (&str), 0);
123 xmlTextWriterStartDocument (w, NULL, "UTF-8", NULL);
130 register_file (struct odt_driver *odt, const char *filename)
132 assert (odt->manifest_wtr);
133 xmlTextWriterStartElement (odt->manifest_wtr, _xml("manifest:file-entry"));
134 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:media-type"), _xml("text/xml"));
135 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:full-path"), _xml (filename));
136 xmlTextWriterEndElement (odt->manifest_wtr);
140 write_style_data (struct odt_driver *odt)
142 xmlTextWriterPtr w = create_writer (odt, "styles.xml");
143 register_file (odt, "styles.xml");
145 xmlTextWriterStartElement (w, _xml ("office:document-styles"));
146 xmlTextWriterWriteAttribute (w, _xml ("xmlns:office"),
147 _xml ("urn:oasis:names:tc:opendocument:xmlns:office:1.0"));
149 xmlTextWriterWriteAttribute (w, _xml ("xmlns:style"),
150 _xml ("urn:oasis:names:tc:opendocument:xmlns:style:1.0"));
152 xmlTextWriterWriteAttribute (w, _xml ("xmlns:fo"),
153 _xml ("urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0") );
155 xmlTextWriterWriteAttribute (w, _xml ("office:version"), _xml ("1.1"));
159 xmlTextWriterStartElement (w, _xml ("office:styles"));
163 xmlTextWriterStartElement (w, _xml ("style:style"));
164 xmlTextWriterWriteAttribute (w, _xml ("style:name"),
167 xmlTextWriterWriteAttribute (w, _xml ("style:family"),
170 xmlTextWriterWriteAttribute (w, _xml ("style:class"),
173 xmlTextWriterEndElement (w); /* style:style */
177 xmlTextWriterStartElement (w, _xml ("style:style"));
178 xmlTextWriterWriteAttribute (w, _xml ("style:name"),
179 _xml ("Table_20_Contents"));
181 xmlTextWriterWriteAttribute (w, _xml ("style:display-name"),
182 _xml ("Table Contents"));
184 xmlTextWriterWriteAttribute (w, _xml ("style:family"),
187 xmlTextWriterWriteAttribute (w, _xml ("style:parent-style-name"),
190 xmlTextWriterWriteAttribute (w, _xml ("style:class"),
193 xmlTextWriterEndElement (w); /* style:style */
197 xmlTextWriterStartElement (w, _xml ("style:style"));
198 xmlTextWriterWriteAttribute (w, _xml ("style:name"),
199 _xml ("Table_20_Heading"));
201 xmlTextWriterWriteAttribute (w, _xml ("style:display-name"),
202 _xml ("Table Heading"));
204 xmlTextWriterWriteAttribute (w, _xml ("style:family"),
207 xmlTextWriterWriteAttribute (w, _xml ("style:parent-style-name"),
208 _xml ("Table_20_Contents"));
210 xmlTextWriterWriteAttribute (w, _xml ("style:class"),
214 xmlTextWriterStartElement (w, _xml ("style:text-properties"));
215 xmlTextWriterWriteAttribute (w, _xml ("fo:font-weight"), _xml ("bold"));
216 xmlTextWriterWriteAttribute (w, _xml ("style:font-weight-asian"), _xml ("bold"));
217 xmlTextWriterWriteAttribute (w, _xml ("style:font-weight-complex"), _xml ("bold"));
218 xmlTextWriterEndElement (w); /* style:text-properties */
220 xmlTextWriterEndElement (w); /* style:style */
224 xmlTextWriterEndElement (w); /* office:styles */
225 xmlTextWriterEndElement (w); /* office:document-styles */
227 xmlTextWriterEndDocument (w);
228 xmlFreeTextWriter (w);
232 write_meta_data (struct odt_driver *odt)
234 xmlTextWriterPtr w = create_writer (odt, "meta.xml");
235 register_file (odt, "meta.xml");
237 xmlTextWriterStartElement (w, _xml ("office:document-meta"));
238 xmlTextWriterWriteAttribute (w, _xml ("xmlns:office"), _xml ("urn:oasis:names:tc:opendocument:xmlns:office:1.0"));
239 xmlTextWriterWriteAttribute (w, _xml ("xmlns:dc"), _xml ("http://purl.org/dc/elements/1.1/"));
240 xmlTextWriterWriteAttribute (w, _xml ("xmlns:meta"), _xml ("urn:oasis:names:tc:opendocument:xmlns:meta:1.0"));
241 xmlTextWriterWriteAttribute (w, _xml ("xmlns:ooo"), _xml("http://openoffice.org/2004/office"));
242 xmlTextWriterWriteAttribute (w, _xml ("office:version"), _xml("1.1"));
244 xmlTextWriterStartElement (w, _xml ("office:meta"));
246 xmlTextWriterStartElement (w, _xml ("meta:generator"));
247 xmlTextWriterWriteString (w, _xml (stat_version));
248 xmlTextWriterEndElement (w);
254 struct passwd *pw = getpwuid (getuid ());
255 time_t t = time (NULL);
256 struct tm *tm = localtime (&t);
258 strftime (buf, 30, "%Y-%m-%dT%H:%M:%S", tm);
260 xmlTextWriterStartElement (w, _xml ("meta:initial-creator"));
261 xmlTextWriterWriteString (w, _xml (strtok (pw->pw_gecos, ",")));
262 xmlTextWriterEndElement (w);
264 xmlTextWriterStartElement (w, _xml ("meta:creation-date"));
265 xmlTextWriterWriteString (w, _xml (buf));
266 xmlTextWriterEndElement (w);
268 xmlTextWriterStartElement (w, _xml ("dc:creator"));
269 xmlTextWriterWriteString (w, _xml (strtok (pw->pw_gecos, ",")));
271 xmlTextWriterEndElement (w);
273 xmlTextWriterStartElement (w, _xml ("dc:date"));
274 xmlTextWriterWriteString (w, _xml (buf));
275 xmlTextWriterEndElement (w);
278 xmlTextWriterEndElement (w);
279 xmlTextWriterEndElement (w);
280 xmlTextWriterEndDocument (w);
281 xmlFreeTextWriter (w);
290 static struct driver_option *
291 opt (struct output_driver *d, struct string_map *options, const char *key,
292 const char *default_value)
294 return driver_option_get (d, options, key, default_value);
297 static struct output_driver *
298 odt_create (const char *file_name, enum settings_output_devices device_type,
299 struct string_map *o)
301 struct output_driver *d;
302 struct odt_driver *odt;
304 odt = xzalloc (sizeof *odt);
306 output_driver_init (d, &odt_driver_class, file_name, device_type);
308 odt->file_name = xstrdup (file_name);
309 odt->debug = parse_boolean (opt (d, o, "debug", "false"));
311 odt->dirname = xstrdup ("odt-XXXXXX");
312 mkdtemp (odt->dirname);
314 if (!create_mimetype (odt->dirname))
316 output_driver_destroy (d);
320 /* Create the manifest */
321 odt->manifest_wtr = create_writer (odt, "META-INF/manifest.xml");
323 xmlTextWriterStartElement (odt->manifest_wtr, _xml("manifest:manifest"));
324 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("xmlns:manifest"),
325 _xml("urn:oasis:names:tc:opendocument:xmlns:manifest:1.0"));
328 /* Add a manifest entry for the document as a whole */
329 xmlTextWriterStartElement (odt->manifest_wtr, _xml("manifest:file-entry"));
330 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:media-type"), _xml("application/vnd.oasis.opendocument.text"));
331 xmlTextWriterWriteAttribute (odt->manifest_wtr, _xml("manifest:full-path"), _xml("/"));
332 xmlTextWriterEndElement (odt->manifest_wtr);
335 write_meta_data (odt);
336 write_style_data (odt);
338 odt->content_wtr = create_writer (odt, "content.xml");
339 register_file (odt, "content.xml");
342 /* Some necessary junk at the start */
343 xmlTextWriterStartElement (odt->content_wtr, _xml("office:document-content"));
344 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("xmlns:office"),
345 _xml("urn:oasis:names:tc:opendocument:xmlns:office:1.0"));
347 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("xmlns:text"),
348 _xml("urn:oasis:names:tc:opendocument:xmlns:text:1.0"));
350 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("xmlns:table"),
351 _xml("urn:oasis:names:tc:opendocument:xmlns:table:1.0"));
353 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("office:version"), _xml("1.1"));
355 xmlTextWriterStartElement (odt->content_wtr, _xml("office:body"));
356 xmlTextWriterStartElement (odt->content_wtr, _xml("office:text"));
360 /* Close the manifest */
361 xmlTextWriterEndElement (odt->manifest_wtr);
362 xmlTextWriterEndDocument (odt->manifest_wtr);
363 xmlFreeTextWriter (odt->manifest_wtr);
369 odt_destroy (struct output_driver *driver)
371 struct odt_driver *odt = odt_driver_cast (driver);
373 if (odt->content_wtr != NULL)
375 struct string zip_cmd;
377 xmlTextWriterEndElement (odt->content_wtr); /* office:text */
378 xmlTextWriterEndElement (odt->content_wtr); /* office:body */
379 xmlTextWriterEndElement (odt->content_wtr); /* office:document-content */
381 xmlTextWriterEndDocument (odt->content_wtr);
382 xmlFreeTextWriter (odt->content_wtr);
384 /* Zip up the directory */
385 ds_init_empty (&zip_cmd);
386 ds_put_format (&zip_cmd,
387 "cd %s ; rm -f ../%s; zip -q -X ../%s mimetype; zip -q -X -u -r ../%s .",
388 odt->dirname, odt->file_name, odt->file_name, odt->file_name);
389 system (ds_cstr (&zip_cmd));
390 ds_destroy (&zip_cmd);
395 /* Remove the temp dir */
396 struct string rm_cmd;
398 ds_init_empty (&rm_cmd);
399 ds_put_format (&rm_cmd, "rm -r %s", odt->dirname);
400 system (ds_cstr (&rm_cmd));
401 ds_destroy (&rm_cmd);
404 fprintf (stderr, "Not removing directory %s\n", odt->dirname);
411 odt_submit_table (struct odt_driver *odt, struct table_item *item)
413 const struct table *tab = table_item_get_table (item);
414 const char *caption = table_item_get_caption (item);
417 /* Write a heading for the table */
420 xmlTextWriterStartElement (odt->content_wtr, _xml("text:h"));
421 xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("text:level"),
423 xmlTextWriterWriteString (odt->content_wtr,
424 _xml (table_item_get_caption (item)) );
425 xmlTextWriterEndElement (odt->content_wtr);
429 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table"));
430 xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("table:name"),
431 "TABLE-%d", odt->table_num++);
434 /* Start column definitions */
435 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-column"));
436 xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("table:number-columns-repeated"), "%d", table_nc (tab));
437 xmlTextWriterEndElement (odt->content_wtr);
440 /* Deal with row headers */
441 if ( table_ht (tab) > 0)
442 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-header-rows"));
445 /* Write all the rows */
446 for (r = 0 ; r < table_nr (tab); ++r)
448 /* Start row definition */
449 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-row"));
451 /* Write all the columns */
452 for (c = 0 ; c < table_nc (tab) ; ++c)
454 struct table_cell cell;
456 table_get_cell (tab, c, r, &cell);
458 if (c == cell.d[TABLE_HORZ][0] && r == cell.d[TABLE_VERT][0])
460 int colspan = table_cell_colspan (&cell);
461 int rowspan = table_cell_rowspan (&cell);
463 xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-cell"));
464 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("office:value-type"), _xml("string"));
467 xmlTextWriterWriteFormatAttribute (
468 odt->content_wtr, _xml("table:number-columns-spanned"),
472 xmlTextWriterWriteFormatAttribute (
473 odt->content_wtr, _xml("table:number-rows-spanned"),
476 xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
478 if ( r < table_ht (tab) || c < table_hl (tab) )
479 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Heading"));
481 xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Contents"));
483 xmlTextWriterWriteString (odt->content_wtr, _xml(cell.contents));
485 xmlTextWriterEndElement (odt->content_wtr); /* text:p */
486 xmlTextWriterEndElement (odt->content_wtr); /* table:table-cell */
490 xmlTextWriterStartElement (odt->content_wtr, _xml("table:covered-table-cell"));
491 xmlTextWriterEndElement (odt->content_wtr);
494 table_cell_free (&cell);
497 xmlTextWriterEndElement (odt->content_wtr); /* row */
499 if ( table_ht (tab) > 0 && r == table_ht (tab) - 1)
500 xmlTextWriterEndElement (odt->content_wtr); /* table-header-rows */
503 xmlTextWriterEndElement (odt->content_wtr); /* table */
506 /* Submit a table to the ODT driver */
508 odt_submit (struct output_driver *driver,
509 const struct output_item *output_item)
511 struct odt_driver *odt = odt_driver_cast (driver);
512 if (is_table_item (output_item))
513 odt_submit_table (odt, to_table_item (output_item));
514 else if (is_text_item (output_item))
516 const struct text_item *text_item = to_text_item (output_item);
517 const char *text = text_item_get_text (text_item);
519 /* XXX apply different styles based on text_item's type. */
520 xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
521 xmlTextWriterWriteString (odt->content_wtr, _xml(text));
522 xmlTextWriterEndElement (odt->content_wtr);
526 struct output_driver_factory odt_driver_factory = { "odt", odt_create };
528 static const struct output_driver_class odt_driver_class =