GullFOSS postings related to ODF@WWW:
19 Jun 2008 - ODF@WWW (An ODF Wiki)
27 Jun 2008 - ODF@WWW -How it works
04 Jul 2008 - ODF@WWW - Simply Install
22 Jul 2008 - ODF@WWW - Going forward ...

As all of you are hopefully by now as enthusiastic about the ODF@WWW as I am, and as all of you by now know how it works, I would like to give detailed instructions on how to install it.

The prerequisites are the following:

• A UNIX like operating system such as Linux or OpenSolaris.
• An Apache web server with WebDAV and ReWrite extensions installed.
• A Bourne compatible shell.
• A Make utility, I use GNU make, as this is my favorite.
• An OpenOffice.org suite on the client and on the server.
• A helper utility (JODConverter) downloadable from softpedia to convert ODF to HTML on the server.
• A recent Java, because JODConverter is implemented in Java, I use JDK1.6.
  

You need some documents and images to get started with the ODF Wiki.

• Some images for the buttons:
• "tbbtn.png" - The image of the "Edit..." button.
• "tbbtn-text.png" - The image of the "Edit Text Document..." button.
• "tbbtn-sheet.png" - The image of the "Edit Spreadsheet..." button.
• "tbbg.png" - The background image fo all buttons.

• Some basic documents explainning the usage and how to configure the browsers:
• "index.odt" - This is the start page.
• "context.odt" - This is the table of contents.
• "ClientSupport.odt" - This explains how to configure your web browser.
• "Usage.odt" - This gives a brief overview how to use the ODF Wiki.
• "aspread.ods" - An example spreadsheet.
• "atext.odt" - An example text document.
• "dummy.odt" - The template for generating new text documents.
• "dummy.ods" - The template for generating new spreadsheets.

Last but not least you need some glue code, to tie everything together.

• An "http.conf" file, enabling WevDAV in Apache as well as URL rewriting.
• Two scripts to be called by Apache,
• "convert.sh" for generating HTML on the fly, and
• "redirect-odf.sh" for generating redirections for the browser download.
• A makefile to be called by "convert.sh", which updates or generates HTML or ODF files on the fly.
• Three scripts to be called by make,
• "convert_odt.sh" converts an ".odt" file to HTML,
• "convert_ods.sh" converts an ".ods" file to HTML,
• "make_dummy.sh" creates a dummy HTML file offering "Edit as Textdocument" respectively "Edit as Spreadsheet".

For your safety&convenience I packed everything into a tar file to be downloaded from mediacast. On my system I use the following directories:

  "/var/www" - For all the content, e.g. the documents listed above.

  "/usr/lib/cgi-bin" - For all the scritpts, and finally ...

  "/etc/apache2/" - For the httpd.conf file.

I did unzip the JODConverter in the "/usr/lib/cgi-bin" directory for easy access. You may need to move the files to the appropriate directories and may slightly need to adapt them to match your system. I just needed to untar the "odf-at-www.tgz" in the root directory:

  > su -
  > cd /
  > tar -xvzf odf-at-www.tgz
  > apache2ctl restart
  > soffice -accept="socket,port=8100;urp;"

That's it ... I hope you enjoy it :*)

Best regards

     Kay

And here comes the code (without any warranty ;-) :

httpd.conf

  LoadModule dav_module     /usr/lib/apache2/modules/mod_dav.so 
  LoadModule dav_fs_module  /usr/lib/apache2/modules/mod_dav_fs.so
  LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so

  DAVLockDB /var/apache2/DAVLock
  <Directory /var/www>
    Dav On
    RewriteEngine On

    # Rewrite directory "/" to index.html, apply other rules.
    RewriteRule ^/$         /index.html [next]
    
    # Forward any html request to the converter.
    RewriteRule ^.*\.html$  cgi-bin/convert.sh       [PT=application/x-httpd-cgi]
  
    # Forward any odf indirector request to redirector.
    RewriteRule ^.*\.od.r$  cgi-bin/redirect-odf.sh [PT=application/x-httpd-cgi]
  </Directory>

convert.sh

  #!/bin/sh

  # Abort on error.
  set -e 

  # Save stdout and stderr.
  exec 6>&1
  exec 7>&2

  # Redirect stdout and stderr to log file.
  exec 2>&1 > /tmp/convert.sh.log

  # Do some logging.
  echo '********arg********\n' $* 
  echo '********env********\n' $(env)
  echo '********set********\n' $(set)
  echo '*******************'

  # The file we need to provide.
  file=$DOCUMENT_ROOT$REDIRECT_URL

  # Ensure that a HTML file is available.
  make -f convert.mk $file

  # Reset stdout redirection.
  exec 1>&6

  # Dump the content.
  echo "Content-Type: text/html"
  echo
  cat $file
  echo

redirect-odf.sh

  #!/bin/sh

  # Abort on error.
  set -e 

  # Save stdout and stderr
  exec 6>&1
  exec 7>&2

  # Redirect stdout and stderr to log file.
  exec 2>&1 > /tmp/redirect-odf.sh.log

  # Do some logging.
  echo '********arg********\n' $* 
  echo '********env********\n' $(env)
  echo '********set********\n' $(set)
  echo '*******************'

  # The documents base file name
  # is everything but the last 'r'.
  bfile=${REDIRECT_URL%r}

  # Ensure that an ODF file is available.
  make -f convert.mk "$DOCUMENT_ROOT$bfile"

  # Reset stdout redirection.
  exec 1>&6

  # Dump the content.
  echo "Content-Type: text/url"
  echo
  echo "http://$HTTP_HOST$bfile"

convert.mk

  # Don't delete any intermediates.
  .SECONDARY:

  # Create a '.html' from an '.ods'.
  %.html: %.ods
        ./convert_ods.sh $^ $@ $(notdir $*)

  # Create a '.html' from an '.odt'.
  %.html: %.odt
	./convert_odt.sh $^ $@ $(notdir $*)

  # Create a '.html' from template.
  %.html:
	./make_dummy.sh $(dir $@)/dummy.html $@ $(notdir $*) 


  # Create an '.odt' from template.
  %.odt:
  	cp $(dir $@)/dummy.odt $@

  # Create an '.ods' from template.
  %.ods:
	cp $(dir $@)/dummy.ods $@

convert_odt.sh

  #!/bin/sh

  # Abort on error.
  set -e 

  source=$1 ; shift
  target=$1 ; shift
  stem=$1   ; shift

  thisDir=$(dirname $0)/

  temp=$(mktemp)
  java -jar ${thisDir}jodconverter-2.2.1/lib/jodconverter-cli-2.2.1.jar $source $temp.html

  btemp=$(basename $temp)

  body_tag='<BODY LANG="en-US" DIR="LTR">'
  edit_tag='<div style="position: fixed; background: url('tbbg.png') repeat-x; height: 38px; left: 0%; 
    padding-left: 5px; width: 100%; top: 0px; bottom: 38px;">\n  <a href="http://'${HTTP_HOST}
    /${stem}.odtr'">\n    <img alt="Edit..." src="tbbtn.png" width="112" height="38" border="0" 
    longdesc="Edit document in OpenOffice.org"/>\n  </a>\n</div>\n<br>\n<br>'

  sed "s!smb://!http://!g"                     $temp.html | \
  sed "s!\.odt\"!\.html\"!g"                              | \
  sed "s!\.ods\"!\.html\"!g"                              | \
  sed "s!SRC=\"$btemp!SRC=\"$stem!g"                      | \
  sed "s!${body_tag}!${body_tag}${edit_tag}!"             > $target

  set +e
  files=$(ls ${temp}_html_*)
  set -e

  target_stem=${target%%.*}
  for file in $files ; do
    varpart=${file##*_}

    cp $file ${target_stem}_html_${varpart}
  done

convert_ods.sh

  #!/bin/sh

  # Abort on error.
  set -e 

  source=$1 ; shift
  target=$1 ; shift
  stem=$1   ; shift

  thisDir=$(dirname $0)/

  temp=$(mktemp)
  java -jar ${thisDir}jodconverter-2.2.1/lib/jodconverter-cli-2.2.1.jar $source $temp.html

  btemp=$(basename $temp)

  body_tag='<BODY TEXT="#000000">'
  edit_tag='<div style="position: fixed; background: url('tbbg.png') repeat-x; height: 38px; left: 0%;
    padding-left: 5px; width: 100%; top: 0px; bottom: 38px;">\n  <a href="http://'${HTTP_HOST}
    /${stem}.odsr'">\n    <img alt="Edit..." src="tbbtn.png" width="112" height="38" border="0" 
    longdesc="Edit document in OpenOffice.org"/>\n  </a>\n</div>\n<br>\n<br>
    \n<br>'

  sed "s!\.odt\"!\.html\"!g"                  $temp.html | \
  sed "s!\.ods\"!\.html\"!g"                             | \
  sed 's!file://!http://localhost!g'                     | \

  sed "s!SRC=\"$btemp!SRC=\"$stem!g"                     | \
  sed "s!${body_tag}!${body_tag}${edit_tag}!"            > $target

  set +e
  files=$(ls ${temp}_html_*)
  set -e

  target_stem=${target%%.*}
  for file in $files ; do
    varpart=${file##*_}

    cp $file ${target_stem}_html_${varpart}
  done

make_dummy.sh

  #!/bin/sh

  # Abort on error.
  set -e 

  # Save stdout and stderr
  exec 6>&1
  exec 7>&2

  # Redirect stdout and stderr to log file.
  exec 2>&1 > /tmp/make_dummy.sh.log

  # Do some logging.
  echo '********arg********\n' $* 
  echo '********env********\n' $(env)
  echo '********set********\n' $(set)
  echo '*******************'

  source=$1 ; shift
  target=$1 ; shift
  stem=$1   ; shift

  sed 's!localhost/dddddddd!'$HTTP_HOST/$stem'!g' $source > $target

tags: apache odf opendocument openoffice.org wiki