[Officeshots] Proposed new file structure for Officeshots results

[Sander Marechal]

Hi all,

I have been thinking about a new way to lay out the filesystem structure 
of request and results in Officeshots and I would like your comments.

The current system looks like this:

All requests go in files/requests/<unique-id>.<ext>
All results go in files/results/<unique-id>.<ext>

When a user requests a zipfile, the layout of the zipfile is as follows:

officeshots-<document-name>/
+-- <document-name>.<ext>			(the original document)
+-- <application>_<version>_<platform>.<ext>	(a result)
+-- <application>_<version>_<platform>.<ext>	(another result)

For example, if the uploaded document was foobar.odt:

officeshots-foobar/
+-- foobar.odt
+-- abiword_2.6.4_linux_bsd.odt
+-- openoffice_writer_3.2_windows.pdf

There a a couple of shortcomings in this system.

1) Generating the zips is computationally expensive because the 
on-system layout does not match the zipfile structure.

2) Since the current system was implemented, Galleries and ODF 
Validators have been added. I want to be able to include the 
descriptions and the validator results in the downloads as well.

3) I'm working on integrating test-suites. Some are quite complicated 
and have a nested structure. I want to maintain this structure so 
lumping all requests and results together doesn't work anymore.

Here is what I am currently thinking about:

<document-name>.<ext>/
+-- description.txt				(description page)
+-- source/
     +-- <document-name>.<ext>			(original document)
+-- <application>_<version>_<platform>		(result directory)
     +-- <document-name>.<ext>			(the result)
     +-- description.txt				(result description)
     +-- <validator>-validator.<ext>		(validator result)

So, for the above foobar.odt example you would get something like this:

foobar.odt/
+-- description.txt
+-- source/
     +-- foobar.odt
+-- abiword_2.6.4_linux_bsd/
     +-- foobar.odt
     +-- foobar.png
     +-- description.txt
     +-- cyclone3-validator.txt
     +-- officeotron-validator.html
     +-- odftoolkit-validator.txt
+-- openoffice_writer_3.2_windows/
     +-- foobar.pdf

The same structure can be used for exporting galleries. For example

My_Gallery/
+-- description.txt
+-- document-1.odt/
      ...
+-- document-2.odt/
      ...

And for nested test suites, such as the OpenDocument Fellowship test 
suite structure:

OpenDocumentFellowship/
+-- General/
+-- FormattingProperties/
     +-- ColumnFormattingProperties/
         +-- breakBeforeAndBreakAfter/
             +-- source/
             +-- abiword_2.6.8_windows/
             ...
         +-- columnWidth/
         ....
     +-- ParagraphFormattingProperties/
     ...
+-- TextContents/
...

Any comments? Suggestions? Ideas? Flames? Please let me know.

-- 
Sander Marechal
Officeshots.org