odt2html 0.1.0

data/lib/odt2html/base.rb

@@ -0,0 +1,238 @@
+module ODT2HTML
+  class Base
+    include AnalyzeContent
+    include AnalyzeGraphics
+    include AnalyzeStyles
+
+    def initialize( )
+
+      @@debug = 0
+
+      @doc = nil
+      @input_filename = nil
+
+      @output_filename = nil
+      @output_doc = nil
+
+      @head = nil
+      @body = nil
+
+      @css_filename = nil
+
+      @image_dir = nil
+
+      @namespace_urn = {
+        "urn:oasis:names:tc:opendocument:xmlns:office:1.0"=>"office",
+        "urn:oasis:names:tc:opendocument:xmlns:style:1.0"=>"style",
+        "urn:oasis:names:tc:opendocument:xmlns:text:1.0"=>"text",
+        "urn:oasis:names:tc:opendocument:xmlns:table:1.0"=>"table",
+        "urn:oasis:names:tc:opendocument:xmlns:drawing:1.0"=>"draw",
+        "urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"=>"fo",
+        "http://www.w3.org/1999/xlink"=>"xlink",
+        "http://purl.org/dc/elements/1.1/"=>"dc",
+        "urn:oasis:names:tc:opendocument:xmlns:meta:1.0"=>"meta",
+        "urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0"=>"number",
+        "urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0"=>"svg",
+        "urn:oasis:names:tc:opendocument:xmlns:chart:1.0"=>"chart",
+        "urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0"=>"dr3d",
+        "http://www.w3.org/1998/Math/MathML"=>"math",
+        "urn:oasis:names:tc:opendocument:xmlns:form:1.0"=>"form",
+        "urn:oasis:names:tc:opendocument:xmlns:script:1.0"=>"script",
+        "http://openoffice.org/2004/office"=>"ooo",
+        "http://openoffice.org/2004/writer"=>"ooow",
+        "http://openoffice.org/2004/calc"=>"oooc",
+        "http://www.w3.org/2001/xml-events"=>"dom"
+      }
+
+      #
+      # These are the "canonical forms" of the styles we want to process.
+      # when we get the namespaces, we'll push them into the @style_dispatch
+      # hash. If a style name ends with a *, the next entry is the name of
+      # a method that handles that entry. Otherwise, process_normal_style_attr
+      # gets put into @style_dispatch
+      #
+      @valid_style = %w(
+        style:font-name* process_font_name
+        fo:color
+        fo:background-color
+        fo:font-size
+        fo:font-style
+        fo:font-weight
+        fo:margin-top
+        fo:margin-right
+        fo:margin-bottom
+        fo:margin-left
+        fo:margin
+        fo:padding-top fo:padding-right fo:padding-bottom fo:padding-left
+        fo:padding
+        fo:border-top fo:border-right fo:border-bottom fo:border-left
+        fo:border
+        fo:text-align* process_text_align
+        fo:text-indent
+        style:column-width* process_column_width
+        style:text-underline-style* process_underline_style
+        style:text-position* process_style_text_position
+      )
+
+      # The style dispatch hash's key is a style name;
+      # the value is the name of the function to call to
+      # process that style.
+      @style_dispatch = Hash.new
+
+      # The keys for <tt>@nshash</tt> are canonical namespace names;
+      # the values are the actual namespace prefixes used in the
+      # document being processed.
+      @nshash = Hash.new
+
+      # The <tt>@style_info</tt> hash gives a style name as its key;
+      # the value is a <tt>DeclarationBlock</tt>. When a style is
+      # actually used in the document, we set the style's
+      # <tt>@block_used</tt> property to <tt>true</tt>.
+      #
+      @style_info = Hash.new
+
+      #
+      # Paragraphs merge borders by default; this means we
+      # must remember the last paragraph style emitted
+      # and a reference to the paragraph
+      @previous_para_style = nil
+      @previous_para = nil
+    end
+
+    #
+    # Establish a mapping between "standard" namespaces (in @namespace_urn)
+    # and namespace prefixes used in the document at hand.
+    #
+    # This code dynamically creates instance variables for the namespaces
+    # with "_ns" added to the variable name to avoid collisions.
+    # It is also added to the namespace hash <tt>@nshash</tt>
+    #
+    # The technique comes from a post to comp.lang.ruby by Guy Decoux
+    #
+    def get_namespaces
+      @nshash.clear
+      root_element = @doc.root
+      root_element.attributes.each_attribute do |attr|
+        if @namespace_urn.has_key?( attr.value ) then
+          @nshash[@namespace_urn[attr.value]] = attr.name
+          self.class.send(:attr_accessor, @namespace_urn[attr.value] + "_ns")
+          send("#{@namespace_urn[attr.value]+'_ns'}=", attr.name)
+        end
+      end
+    end
+
+    def get_options
+      opts = GetoptLong.new(
+        ["--in", GetoptLong::REQUIRED_ARGUMENT],
+        ["--out", GetoptLong::OPTIONAL_ARGUMENT],
+        ["--css", GetoptLong::REQUIRED_ARGUMENT],
+        ["--images", GetoptLong::REQUIRED_ARGUMENT]
+      )
+      opts.each do |opt, arg|
+        case opt
+          when "--in"
+            @input_filename = arg
+          when "--out"
+            @output_filename = arg
+          when "--css"
+            @css_filename = arg
+          when "--images"
+            @image_dir = arg
+        end
+      end
+    end
+
+    def get_xml( member_name )
+      zipfile = Zip::ZipFile::open( @input_filename )
+      stream = zipfile.get_entry( member_name ).get_input_stream
+      doc = REXML::Document.new stream.read
+      zipfile.close
+      return doc
+    end
+
+    def add_xhtml_head_info
+      @head.add_element("meta",
+        "http-equiv"=>"content-type", "content"=>"text/html; charset=utf-8")
+      @head.add_element("title").add_text( @input_filename )
+    end
+
+    def collect_styles
+      str = ""
+      @style_info.keys.sort.each do |style|
+        if (@style_info[style].length > 0 && yield(@style_info[style])) then
+          str << style_to_s(style) << "\n"
+        end
+      end
+      return str
+    end
+
+    def convert
+      get_options
+
+      if (@input_filename == nil)
+        usage
+        raise ArgumentError, "No input file name given"
+      end
+
+      # if (@output_filename == nil)
+      #   usage
+      #   raise ArgumentError, "No output file name given"
+      # end
+
+
+      if (@image_dir != nil)
+        if (!File.exist?(@image_dir))
+          Dir.mkdir(@image_dir)
+        end
+      end
+
+      str = <<HDR
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+</html>
+HDR
+      @output_doc = REXML::Document.new str
+      @head = @output_doc.root.add_element("head")
+      @body = @output_doc.root.add_element("body")
+      add_xhtml_head_info
+
+      @doc = get_xml("styles.xml")
+      analyze_styles_xml
+
+      @doc = get_xml("content.xml")
+      analyze_content_xml
+
+      all_styles = collect_styles { |item| item.block_used }
+
+      if (@css_filename != nil) then
+        css_file = File.open( @css_filename, "w" )
+        @head.add_element("link",
+          {"rel" => "stylesheet", "type" => "text/css",
+          "href" => @css_filename} )
+        css_file.puts(all_styles)
+      else
+        style_el = @head.add_element("style", {"type" => "text/css"} )
+        style_el.add_text( all_styles )
+      end
+
+      if (@output_filename) then
+        output_file = File.open( @output_filename, "w")
+      else
+        output_file = $stdout
+      end
+
+      @output_doc.write( output_file, 2 )
+      output_file.close
+
+      rescue Exception => e
+        puts "Cannot convert file: #{e}"
+        puts e.backtrace.join("\n")
+    end
+
+    def usage
+      puts "Usage: #{$0} --in inputfile --out outputfile [--css cssfile] [--images imagedir]"
+    end
+
+  end
+end

data/lib/odt2html/declaration.rb

@@ -0,0 +1,15 @@
+module ODT2HTML
+  # This class represents a CSS declaration; a
+  # property/value pair
+  class Declaration
+    attr_accessor( :property, :value )
+    def initialize( property=nil, value=nil )
+      @property = property
+      @value = value
+    end
+
+    def to_s
+      return "#{property}: #{value}"
+    end
+  end
+end

data/lib/odt2html/declaration_block.rb

@@ -0,0 +1,35 @@
+module ODT2HTML
+  # Represents a CSS declaration block; a sequence of zero
+  # or more +Declaration+s.
+  class DeclarationBlock < Array
+    attr_accessor( :block_used )
+
+    def initialize(*arglist)
+      if (arglist[0].kind_of? DeclarationBlock) then
+        dblock = arglist[0]
+        super( 0 )
+        dblock.each do |item|
+          push Declaration.new( item.property, item.value )
+        end
+      else
+        super
+      end
+      @block_used = false
+    end
+
+    def has_top_border?
+    result = detect {|item| item.property =~ /border(-top)?/}
+      return (result != nil) ? true : nil
+    end
+
+    def to_s
+      result = "{\n"
+      each { |item|
+        result << "\t#{item.property}: #{item.value};\n"
+      }
+      result << "}\n"
+      return result
+    end
+
+  end
+end

data/lib/odt2html.rb

@@ -0,0 +1,26 @@
+require 'rexml/document'
+require 'rexml/xpath'
+require 'zip/zip'
+require 'stringio'
+require 'getoptlong'
+
+module ODT2HTML
+
+  VERSION = "0.1.0"
+  ROOT_PATH = File.expand_path(File.dirname(__FILE__))
+
+  autoload :Base,             "#{ROOT_PATH}/odt2html/base"
+  autoload :AnalyzeContent,   "#{ROOT_PATH}/odt2html/analyze_content"
+  autoload :AnalyzeGraphics,  "#{ROOT_PATH}/odt2html/analyze_graphics"
+  autoload :AnalyzeStyles,    "#{ROOT_PATH}/odt2html/analyze_styles"
+  autoload :Declaration,      "#{ROOT_PATH}/odt2html/declaration"
+  autoload :DeclarationBlock, "#{ROOT_PATH}/odt2html/declaration_block"
+
+end
+
+class REXML::Element
+  def attribute_value( name, namespace=nil )
+    attr = attribute( name, namespace )
+  return (attr != nil) ? attr.value : nil
+  end
+end

data/odt2html.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "odt2html"
+
+Gem::Specification.new do |s|
+  s.name        = "odt2html"
+  s.version     = ODT2HTML::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bernard Potocki"]
+  s.email       = ["bernard.potocki@imanel.org"]
+  s.homepage    = "http://github.com/imanel/odt2html"
+  s.summary     = %q{OpenDocument text to HTML converter}
+  s.description = %q{OpenDocument text to HTML converter}
+
+  s.add_dependency 'rubyzip'
+  s.add_development_dependency 'rspec', '~> 2.4.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/fixtures/example.html

@@ -0,0 +1,117 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta content='text/html; charset=utf-8' http-equiv='content-type'/>
+    <title>
+      [TITLE_HERE]
+    </title>
+    <style type='text/css'>
+      .P1{ font-size: 18pt; color: #000000; font-family: Times New Roman;
+      text-align: center; font-weight: bold; } .P2{ font-size: 12pt; color:
+      #000000; font-family: Luxi Sans; margin-bottom: 0.0835in; margin-top: 0in;
+      text-align: center; } .P3{ font-size: 12pt; color: #000000; font-family:
+      Luxi Sans; margin-bottom: 0.0835in; margin-top: 0in; text-align: left; }
+      .Quotations{ font-size: 12pt; color: #000000; font-family: Luxi Sans;
+      margin-bottom: 0.1965in; text-indent: 0in; margin-top: 0in; margin-left:
+      0.3937in; margin-right: 0.3937in; } .T1{ font-weight: bold; }
+      .Text_20_body{ font-size: 12pt; color: #000000; font-family: Luxi Sans;
+      margin-bottom: 0.0835in; margin-top: 0in; } 
+    </style>
+  </head>
+  <body>
+    <p class='P1'>
+      &quot;ODF Alliance&quot; formed to support OpenDocument format 
+    </p>
+    <p class='P2'/>
+    <p class='P3'>
+      3/3/2006 8:25:36 PM, by 
+      <a href='mailto:jeremy@arstechnica.com'>
+        Jeremy Reimer
+      </a>
+    </p>
+    <p class='Text_20_body'>
+      A consortium of companies and organizations have banded together to form
+      the 
+      <a href='http://www.odfalliance.org/news.asp'>
+        &quot;ODF Alliance,&quot;
+      </a>
+       a group dedicated to promoting the office software file format first
+      implemented by OpenOffice.org. The alliance consists of more than 35
+      members from various countries around the world. It includes companies
+      such as Red Hat, IBM, Novell, Sun Microsystems, and Corel, and
+      governmental organizations such as the American Library Association and
+      the Information and Communications Technology council for the city of
+      Vienna.
+    </p>
+    <p class='Text_20_body'>
+      The
+      <span class='T1'>
+         OpenDocument
+      </span>
+       file format was formed by the industry consortium OASIS, a group headed
+      by Sun Microsystems, and was based on OpenOffice.org&apos;s native file
+      format. OpenOffice.org is itself an open-sourced version of Star Office,
+      the proprietary office suite that Sun purchased when it acquired the
+      German company Star Division in 1999. The idea behind OpenDocument was to
+      use a text-based XML format (compressed in a zip file to conserve disk
+      space) in order to make it easy for other products to interoperate with
+      it. The specification was finalized in 2005 and OpenOffice.org was the
+      first software suite to support it. Other projects, such as KOffice,
+      AbiWord, and IBM Workplace are adding support for the ODF format, either
+      natively or through plug-in format translators.
+    </p>
+    <p class='Text_20_body'>
+      In today&apos;s highly networked world, it turns out that operability is a
+      very useful thing to have, which is why Microsoft decided that they would
+      also jump on the XML bandwagon, introducing a new XML-based file format
+      (.docx) for Office 2003. Not only that, but the company is planning to
+      make the next version of the Office XML format the default for Office 2007
+      (formerly known as Office 12). This means that when users of Office 2007
+      go to save a file, they will automatically save in .docx, not .doc.
+    </p>
+    <p class='Text_20_body'>
+      While most people don&apos;t consider file formats to be terribly
+      exciting, the question of which format to adopt led to an increasingly
+      dramatic series of announcements from the government of Massachusetts. In
+      January 2005, the government 
+      <a href='http://www.crn.com/sections/breakingnews/breakingnews.jhtml;jsessionid=GCCZBBT3QQVBGQSNDBOCKHSCJUMEKJVN?articleId=57701551'>
+        approved
+      </a>
+       Office XML 2003 as an appropriate file format, then in September of that
+      year 
+      <a href='http://arstechnica.com/news.ars/post/20050906-5279.html'>
+        reversed
+      </a>
+       their decision, stating that Office XML was unacceptable and that only
+      OpenDocument and PDF files would be allowed. They went 
+      <a href='http://arstechnica.com/news.ars/post/20051128-5637.html'>
+        back again
+      </a>
+       in November, stating that they were &quot;very pleased&quot; with
+      Microsoft&apos;s submission of Office XML to the ECMA standards body, and
+      that they were &quot;optimistic that Office Open XML will meet our new
+      standards for acceptable open formats.&quot; The champion of ODF in
+      Massachusetts, CIO Peter Quinn, then suddenly announced his 
+      <a href='http://arstechnica.com/news.ars/post/20060104-5895.html'>
+        resignation
+      </a>
+       in January. This announcement was followed with an assurance from
+      Quinn&apos;s former boss that their position on ODF &quot;remained
+      unchanged&quot; and that they were still committed to supporting that
+      format.
+    </p>
+    <p class='Text_20_body'>
+      Confused yet? The so-called &quot;controversy&quot; over the ODF switch
+      has generated an unbelievable amount of press, and various groups are now
+      busy pushing governments worldwide to switch over to the ODF format. This
+      new &quot;alliance&quot; joins the groups SpreadOpenDocument.org, the
+      OpenDocument Fellowship, and the &quot;Friends of OpenDocument&quot; in
+      their quest to promote the format. My own inbox is now slowly filling up
+      with pro-ODF announcements and press releases. The push seems overtly
+      political, as evidenced by the rhetoric used by the ODF Alliance: 
+    </p>
+    <p class='Quotations'>
+      [...]
+    </p>
+  </body>
+</html>

data/spec/integration/files_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "files" do
+  it "should read ODT file and generate matching HTML file" do
+    odt_path = File.join(File.dirname(__FILE__), *%w[.. fixtures example.odt])
+    html_path = File.join(File.dirname(__FILE__), *%w[.. fixtures example.html])
+    html_file = File.open(html_path)
+    tempfile = Tempfile.new('html')
+
+    begin
+      parser = ODT2HTML::Base.new
+      parser.instance_variable_set('@input_filename', odt_path)
+      parser.instance_variable_set('@output_filename', tempfile.path)
+
+      parser.convert
+
+      tempfile.rewind
+      html_content = html_file.read.gsub("[TITLE_HERE]", odt_path)
+      tempfile.read.should eql(html_content)
+    ensure
+      tempfile.close!
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rspec'
+
+require 'odt2html'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: odt2html
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bernard Potocki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id002
+description: OpenDocument text to HTML converter
+email: 
+- bernard.potocki@imanel.org
+executables: 
+- odt2html
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/odt2html
+- lib/odt2html.rb
+- lib/odt2html/analyze_content.rb
+- lib/odt2html/analyze_graphics.rb
+- lib/odt2html/analyze_styles.rb
+- lib/odt2html/base.rb
+- lib/odt2html/declaration.rb
+- lib/odt2html/declaration_block.rb
+- odt2html.gemspec
+- spec/fixtures/example.html
+- spec/fixtures/example.odt
+- spec/integration/files_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/imanel/odt2html
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: OpenDocument text to HTML converter
+test_files: 
+- spec/fixtures/example.html
+- spec/fixtures/example.odt
+- spec/integration/files_spec.rb
+- spec/spec_helper.rb