html2odt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94e165a5f9ab5a021c0e4b07c79c86ab5ef0213f
+  data.tar.gz: d4f2a69cb1db7d641cc05914d738758782b38d95
+SHA512:
+  metadata.gz: 4758a732062fc1483a70a619f1740f56b5d4cc53238b556cc27926d878214e9a5c1bd6cb928f1c44736e9e5adda7fcce01726deea08dcc62d70157c34b3644be
+  data.tar.gz: 075d0444c1b5e61066d87e461edfd3d97711dcb37c36ab277e72901142fd0b83db5a86bd46cd15e863bc328b052c73a4d7518ddadbbf39c6f052f5d45f887fbf

data/.gitignore

@@ -0,0 +1 @@
+/pkg/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 - 2016-05-20 - Initial release
+
+Provides initial feature set, tranforming HTML fragments to ODT documents.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at schmidt@nach-vorne.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html2odt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    html2odt (0.1.0)
+      dimensions (~> 1.3.0)
+      nokogiri (~> 1.6.7.2)
+      rubyzip (~> 1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.3)
+    dimensions (1.3.0)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rake (10.5.0)
+    rubyzip (1.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  byebug
+  html2odt!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.12.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Gregor Schmidt - Planio GmbH, Berlin, Germany
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,163 @@
+# html2odt
+
+This gem provides a Ruby wrapper around the set of XLST stylesheets published as
+[xhtml2odt](https://github.com/abompard/xhtml2odt).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html2odt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html2odt
+
+## Usage
+
+### Basic usage
+
+```ruby
+# Create an Html2Odt::Document instance
+doc = Html2Odt::Document.new
+
+# Set the input HTML
+doc.html <<HTML
+<h1>Hello, World!</h1>
+<p>It works.</p>
+HTML
+
+# Set author and title
+doc.author = "Jane Doe"
+doc.title = "Example Document"
+
+
+# Write ODT to disk
+doc.write_to "demo.odt"
+
+# Or get binary content as string
+doc.data
+```
+
+### Configuration options
+
+`html2odt` comes with a basic `template.odt`, which is as a boilerplate to create
+the desired ODT file. If you like to provide your own styles or additional
+content next to the content added via the API, you may provide your own template
+in the `Html2Odt::Document` constructor.
+
+*Please note:* If the template file cannot be read or if it does not appear to
+be a valid ODT file, an `ArgumentError` will be raised.
+
+The template needs to contain an otherwise empty paragraph containing the string
+`{{content}}`.
+
+```ruby
+# Provide optional template file
+doc = Html2Odt::Document.new(template: "template.odt")
+```
+
+
+
+
+The HTML which should become part of the document may also be provided via the
+constructor
+
+```ruby
+# Provide HTML in constructor
+doc = Html2Odt::Document.new(html: <<HTML)
+  <h1>Hello, World!</h1>
+  <p>It works.</p>
+HTML
+```
+
+### Image handling
+
+`html2odt` provides basic image inlining, i.e. images referenced in the HTML
+code will be embeded into the ODT file by default. This is true for images
+referenced with a full `file://`, `http://`, or `https://` URL. Absolute URLs
+(i.e. starting `/`) and relative URLs are not supported, since `html2odt` has no
+idea, which server or document they are relating to.
+
+Images referencing an unsupported resource will be replaced with a link
+containing the alt text of the image.
+
+If you are using `html2odt` in a web application context, you will probably want
+to provide some special handling for resources residing on your own server. This
+should be done for security reasons or to save roundtrips.
+
+`html2odt` provides the following API to map image `src` attributes to local
+file locations.
+
+```ruby
+# Provide custom mapping for image locations
+doc = Html2Odt::Document.new
+
+doc.image_location_mapping = lambda do |src|
+  # Attention! Add protection against directory traversal attacks
+  "/var/www/mywebsite/#{src}"
+end
+```
+
+Registering an `image_location_mapping` callback will deactivate the default
+behaviour of including images with `file` and `http` URLs automatically.
+
+
+## License
+
+Files within the `xsl` directory belong to the [xhtml2odt
+project](https://github.com/abompard/xhtml2odt) published by Aurelien Bompard
+(2009-2010) under the terms of the GNU LGP v2.1 or later:
+http://www.gnu.org/licenses/lgpl-2.1.html
+
+The remaining files are licensed under the terms of the MIT license.
+
+```
+Copyright (c) 2016 Gregor Schmidt - Planio GmbH, Berlin, Germany
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then,
+run `rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/planio-gmbh/html2odt. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html2odt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/html2odt.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html2odt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html2odt"
+  spec.version       = Html2Odt::VERSION
+  spec.authors       = ["Gregor Schmidt (Planio)"]
+  spec.email         = ["gregor@plan.io", "support@plan.io"]
+
+  spec.summary       = %q{html2odt generates ODT documents based on HTML fragments}
+  spec.description   = %q{html2odt generates ODT documents based on HTML fragments using xhtml2odt}
+  spec.homepage      = "https://github.com/planio-gmbh/html2odt"
+
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dimensions", "~> 1.3.0"
+  spec.add_dependency "nokogiri", "~> 1.6.7.2"
+  spec.add_dependency "rubyzip", "~> 1.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/html2odt/document.rb

@@ -0,0 +1,309 @@
+class Html2Odt::Document
+  CONTENT_REGEX = /<text:p[^>]*>{{content}}<\/text:p>/
+  INCH_TO_CM = 2.54
+
+  # The following value was determined by comparing the generated result with
+  # an image dropped into LibreOffice interactively. Though this might be
+  # related to the fact, that my screen has a native resolution of 114 dpi.
+  #
+  # xhtml2odt uses 96 by default.
+  DPI = 114.0
+
+  attr_accessor :image_location_mapping
+
+  # Document meta data
+  attr_accessor :author, :title
+
+  def initialize(template: Html2Odt::ODT_TEMPLATE, html: nil)
+    @html     = html
+    @template = template
+
+    read_xmls
+  end
+
+  def html=(html)
+    reset
+    @html = html
+  end
+
+  def html
+    @html
+  end
+
+  def content_xml
+    @content_xml ||= begin
+
+      html = prepare_html
+
+      xml = xslt_tranform(html, Html2Odt::XHTML2ODT_XSL)
+
+      xml = xml.sub('<?xml version="1.0" encoding="utf-8"?>', '')
+      xml = @tpl_content_xml.sub(CONTENT_REGEX, xml)
+
+      xml = xslt_tranform(xml, Html2Odt::XHTML2ODT_STYLES_XSL)
+
+      xml
+    end
+  end
+
+  def styles_xml
+    @styles_xml ||= xslt_tranform(@tpl_styles_xml, Html2Odt::XHTML2ODT_STYLES_XSL)
+  end
+
+  def manifest_xml
+    @manifest_xml ||= begin
+      content_xml # trigger HTML parsing
+
+      if @images.nil? or @images.empty?
+        @tpl_manifest_xml
+      else
+        doc = Nokogiri::XML(@tpl_manifest_xml)
+
+        @images.each do |image|
+          entry = create_node(doc, "manifest:file-entry")
+          entry["manifest:full-path"]  = image.target
+          entry["manifest:media-type"] = image.mime_type
+
+          doc.root.add_child entry
+        end
+
+        doc.to_xml
+      end
+    end
+  end
+
+  def meta_xml
+    @meta_xml ||= begin
+       doc = Nokogiri::XML(@tpl_meta_xml)
+
+       meta = doc.at_xpath("office:document-meta/office:meta")
+
+       meta.xpath("meta:generator").remove
+       meta.add_child create_node(doc, "meta:generator", "html2odt.rb/#{Html2Odt::VERSION}")
+
+       meta.xpath("meta:creation-date").remove
+       meta.add_child create_node(doc, "meta:creation-date", Time.now.utc.iso8601)
+
+       meta.xpath("dc:date").remove
+       meta.add_child create_node(doc, "dc:date", Time.now.utc.iso8601)
+
+       meta.xpath("meta:editing-duration").remove
+       meta.add_child create_node(doc, "meta:editing-duration", "P0D")
+
+       meta.xpath("meta:editing-cycles").remove
+       meta.add_child create_node(doc, "meta:editing-cycles", "1")
+
+       meta.xpath("meta:initial-creator").remove
+       meta.add_child create_node(doc, "meta:initial-creator", author) if author
+
+       meta.xpath("dc:creator").remove
+       meta.add_child create_node(doc, "dc:creator", author) if author
+
+       meta.xpath("dc:title").remove
+       meta.add_child create_node(doc, "dc:title", title) if title
+
+       doc.to_xml
+    end
+  end
+
+  def data
+    @data ||= begin
+      buffer = Zip::OutputStream.write_buffer do |output_stream|
+        # Copy contents from template, while replacing content.xml and
+        # styles.xml
+        Zip::File.open(@template) do |file|
+          file.each do |entry|
+            next if entry.directory?
+
+            entry.get_input_stream do |input_stream|
+              data = case entry.name
+              when "content.xml"
+                content_xml
+              when "meta.xml"
+                meta_xml
+              when "styles.xml"
+                styles_xml
+              when "META-INF/manifest.xml"
+                manifest_xml
+              else
+                input_stream.sysread
+              end
+
+              output_stream.put_next_entry(entry.name)
+              output_stream.write data
+            end
+          end
+        end
+
+        # Adding images found in the HTML sources
+        (@images || []).each do |image|
+          output_stream.put_next_entry(image.target)
+          output_stream.write File.read(image.source)
+        end
+      end
+
+      buffer.string
+    end
+  end
+
+  def write_to(path)
+    File.write(path, data)
+  end
+
+  protected
+
+
+  def read_xmls
+    unless File.readable?(@template)
+      raise ArgumentError, "Cannot read template file #{@template.inspect}"
+    end
+
+    Zip::File.open(@template) do |zip_file|
+      @tpl_content_xml  = zip_file.read("content.xml")
+      @tpl_manifest_xml = zip_file.read("META-INF/manifest.xml")
+      @tpl_meta_xml     = zip_file.read("meta.xml")
+      @tpl_styles_xml   = zip_file.read("styles.xml")
+    end
+
+    unless @tpl_content_xml =~ CONTENT_REGEX
+      raise ArgumentError, "Template file does not contain `{{content}}` paragraph"
+    end
+
+  rescue Zip::Error
+    raise ArgumentError, "Template file does not look like a ODT file - #{$!.message}"
+  rescue Errno::ENOENT
+    raise ArgumentError, "Template file does not contain expected file - #{$!.message}"
+  end
+
+
+  def prepare_html
+    html = self.html
+    html = fix_images_in_html(html)
+    html = create_document(html)
+    html
+  end
+
+
+  def create_document(html)
+    %Q{<html xmlns="http://www.w3.org/1999/xhtml">#{html}</html>}
+  end
+
+  def fix_images_in_html(html)
+    doc = Nokogiri::HTML::DocumentFragment.parse(html)
+
+    @images = []
+    doc.css("img").each_with_index do |img, index|
+      image = Html2Odt::Image.new(index)
+
+      image.source = file_path_for(img["src"])
+
+      if image.valid?
+        update_img_tag(img, image)
+        @images << image
+      else
+        # Replace img with link if alt tag is present
+        alt = img["alt"]
+
+        if alt.nil? || alt.empty?
+          img.remove
+        else
+          a = create_node(doc, "a")
+          a["href"] = img["src"]
+          a.content = alt
+
+          img.replace(a)
+        end
+      end
+    end
+
+    doc.to_xml
+  end
+
+  def file_path_for(src)
+    if image_location_mapping
+      return image_location_mapping.call(src)
+    end
+
+    case src
+    when /\Afile:\/\//
+      # local file URL
+      #
+      # TODO: Verify, that this does not pose a security threat, maybe make
+      # this optional. In any case, it's useful for testing.
+
+      src[7..-1]
+
+    when /\Ahttps?:\/\//
+      # remote image URL
+      #
+      # TODO: Verify, that this does not pose a security threat, maybe make
+      # this optional.
+
+      uri = URI.parse(src)
+      file = Tempfile.new("html2odt")
+      file.binmode
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
+        resp = http.get(uri.path)
+
+        file.write(resp.body)
+        file.flush
+        file
+      end
+
+      file.path
+    else
+      # cannot handle image properly, return nil
+      nil
+    end
+  end
+
+  def update_img_tag(img, image)
+    img["src"] = image.target
+
+    if img["width"] and img["height"]
+      # use values supplied in HTML
+      width  = img["width"].to_i
+      height = img["height"].to_i
+    elsif img["width"]
+      # compute height based on width keeping aspect ratio
+      width = img["width"].to_i
+      height = width * image.width / image.height
+    elsif img["height"]
+      # compute width based on height keeping aspect ratio
+      height = img["height"].to_i
+      width = height * image.height / image.width
+    else
+      width  = image.width
+      height = image.height
+    end
+
+    img["width"]  = "#{(width  / DPI * INCH_TO_CM).round(2)}cm"
+    img["height"] = "#{(height / DPI * INCH_TO_CM).round(2)}cm"
+  end
+
+
+  def xslt_tranform(xml, xsl)
+    xslt = File.open(xsl) do |file|
+      Nokogiri::XSLT(file)
+    end
+
+    xml = Nokogiri::XML(xml)
+
+    # raises RuntimeError or Nokogiri::XML::SyntaxError if something goes wrong
+    xslt.transform(xml).to_s
+  end
+
+  def reset
+    @content_xml  = nil
+    @manifest_xml = nil
+    @data         = nil
+    @images       = nil
+  end
+
+  def create_node(doc, tagname, content = nil)
+    entry = Nokogiri::XML::Node.new tagname, doc
+    entry.content = content unless content.nil?
+    entry
+  end
+end