How does Open Office compress its files?

Question

I'm trying to create an Open Office spreadsheet programmatically but for some reason simply compressing a folder with all the necessary files makes Open Office flag the file as corrupted.

How did I get to this? I started by creating a normal spreadsheet in Open Office with some values in it. After saving I change the extension to .zip and make a copy of the folder. I then compress the second folder using command line zip and change the file extension to .ods. When trying to open the resulting file I get an error from Open Office saying the file is corrupt.

Does Open Office use a special compression algorithm? Doing a "file test.ods" shows it as a compressed zip, so what does Open Office add during the compression routine to make it work?

Answer 1

Documentation here. This steps worked for me:

1. Uncompress the original document file (it's a normal zip file) to some directory:

   $ mkdir document
   $ cd document
   $ unzip ../document.odt
   

2. Modify the uncompressed data.

3. Create a new odt:

   $ zip -0 -X ../document2.odt mimetype
   $ zip -r ../document2.odt * -x mimetype
   

Answer 2

Section 17 Of the OASIS OpenOffice Specification defines how OpenDocument Packages need to be packaged.

Section 17.4 MIME Type Stream reads like this:

If a MIME type for a document that makes use of packages is existing, then the package SHOULD contain a stream called "mimetype". This stream SHOULD be first stream of the package's zip file, it MUST NOT be compressed, and it MUST NOT use an 'extra field' in its header (see [ZIP])..

The purpose is to allow packaged files to be identified through 'magic number' mechanisms, such as Unix's file/magic utility. If a ZIP file contains a stream at the beginning of the file that is uncompressed, and has no extra data in the header, then the stream name and the stream content can be found at fixed positions. More specifically, one will find:

• a string 'PK' at position 0 of all zip files
• a string 'mimetype' at position 30 of all such package files
• the mimetype itself at position 38 of such a package.

Answer 3

I have tried tokland suggestion, but I have founded that LibreOffice 4 require specific order (only for the first ones?):

1. mimetype (uncompressed)
2. meta.xml
3. settings.xml
4. content.xml
5. Thumbnails/thumbnail.png
6. Configurations2/images/Bitmaps/
7. Configurations2/popupmenu/
8. Configurations2/toolpanel/
9. Configurations2/statusbar/
10. Configurations2/progressbar/
11. Configurations2/toolbar/
12. Configurations2/menubar/
13. Configurations2/accelerator/current.xml
14. Configurations2/floater/
15. styles.xml
16. META-INF/manifest.xml

I create a script to do that folder2od.sh:

#!/bin/sh

# Convert folder (unzipped OpenDocument file) to OpenDocument file (odt, ods, etc.)
# Usage: ./folder2od.sh "path/to/folder" "file.odt"

cmdfolder=$(cd `dirname "$0"`; pwd -P)
folder=$(cd `dirname "$2"`; pwd -P)
file=$(basename "$2")
absfile="$folder/$file"

cd "$1"
zip -0 -X "$file" "mimetype"

list=$(cat <<'END_HEREDOC'
meta.xml
settings.xml
content.xml
Thumbnails/thumbnail.png
Configurations2/images/Bitmaps/
Configurations2/popupmenu/
Configurations2/toolpanel/
Configurations2/statusbar/
Configurations2/progressbar/
Configurations2/toolbar/
Configurations2/menubar/
Configurations2/accelerator/current.xml
Configurations2/floater/
styles.xml
META-INF/manifest.xml
END_HEREDOC
)

for f in $list
do
    zip "$absfile" "$f"
done

cd "$cmdfolder"

I've found some interesting infos here: http://www.jejik.com/articles/2010/03/how_to_correctly_create_odf_documents_using_zip/

Answer 4

The shell script worked for me, too :) I had problems zipping back up, after unzipping an odt file. Guess the manifest part was what's missing.

The shell script above did not handle inline pictures/graphics, however, so I made some small adjustments which worked for me (also, the script had a bug in that END_HEREDOC was not on a dedicated line):

#!/bin/sh

# Convert folder (unzipped OpenDocument file) to OpenDocument file (odt, ods, etc.)
# Usage: ./folder2od.sh "path/to/folder" "file.odt"

cmdfolder=$(cd `dirname "$0"`; pwd -P)
folder=$(cd `dirname "$2"`; pwd -P)
file=$(basename "$2")
absfile="$folder/$file"

cd "$1"
zip -0 -X "$file" "mimetype"

list=$(cat <<'END_HEREDOC'
meta.xml
settings.xml
content.xml
Pictures/
Thumbnails/
Configurations2/
styles.xml
manifest.rdf
META-INF/manifest.xml
END_HEREDOC
)

for f in $list
do
    zip -r "$absfile" "$f"
done

cd "$cmdfolder"

Answer 5

Even if this is old, also in 2021, to manipulate open documents works as easy as before, if it was generated with microsoft office, office 365, google docs, libreoffice or openoffice:

1. make a copy of you document

2. rename extension of the copied document to .zip (because every open document is a zip file!)

3. create a folder with the document name, without extension

4. copy the renamed document (zip file) from step 2) into this folder

5. extract the (document) zip file within this folder

6. delete the zip file!

7. ... change xml data and binary objects as you like

8. mark all files an folders within this folder and add them to a new zip file (only use standard zip compression!)

9. now you should have a new zip file within the folder you created before in setp 3)

10. rename the extension of this new zip file back to o.odt or .odp or whatever the original open document type was, you renamed in step 2)

11. try to open this new, renamed open document in any office software able to handle open document files

Please remember:

a) every open document is a (compressed) zip file

b) the zip file contains xml files which represent the structure and text-content of this document and it also contains supfolders with binary datas (objects), like media data (images, audio or video data, and ole objects), some of them may appear as base64 coded within an xml file.

c) you can extract the content of each open document into a new folder

d) never compress the folder where you put all your data, to create a new zip file/open document file. ONLY compress the content of this folder, to create a valid open document and rename the so created zip file to the open document extension his original source file used!

Sources: https://en.wikipedia.org/wiki/OpenDocument_technical_specification

Tools you can use to manipulate open document files:

a) https://7-zip.de/download.html (to extract and compress)

b) https://notepad-plus-plus.org/downloads/ (to edit the XML content)

c) https://www.bulkrenameutility.co.uk/ (to bulk rename files and folders if you do not know the command under windows, linux ...see: https://unix.stackexchange.com/questions/181141/rename-multiple-files-with-mv-to-change-the-extension)