myGrid/ruby-ro-bundle

#------------------------------------------------------------------------------
# Copyright (c) 2014 The University of Manchester, UK.
#
# BSD Licenced. See LICENCE.rdoc for details.
#
# Author: Robert Haines
#------------------------------------------------------------------------------

#
module ROBundle

  # The managed .ro directory entry of a Research Object.
  #
  # For internal use only.
  class RODir < ZipContainer::ManagedDirectory

    DIR_NAME = ".ro" # :nodoc:

    # :call-seq:
    #   new(manifest)
    #
    # Create a new .ro managed directory entry with the specified manifest
    # file object.
    def initialize(manifest)
      @manifest = manifest
      @annotations_directory = AnnotationsDir.new

      super(DIR_NAME, :required => true,
        :entries => [@manifest, @annotations_directory])
    end

    # :stopdoc:
    def cleanup_annotation_data
      container.glob("#{@annotations_directory.full_name}/*",
        :include_hidden => true) do |file|

        found = false
        @manifest.annotations.each do |ann|
          content_name = normalize_content_name(ann.content)

          if content_name == file.name
            found = true
            break
          end
        end

        container.remove(file.name, true) unless found
      end
    end

    def write_annotation_data(source, options)
      uuid = UUID.generate

      if options[:aggregate]
        entry = uuid
        content = "/#{uuid}"
      else
        mk_annotations_dir
        content = "#{@annotations_directory.name}/#{uuid}"
        entry = "#{full_name}/#{content}"
      end

      if ::File.exist?(source)
        container.add(entry, source, options)
      else
        container.file.open(entry, "w") do |annotation|
          annotation.write source.to_s
        end

        if options[:aggregate]
          @manifest.add_aggregate(entry)
        end
      end

      content
    end
    # :startdoc:

    private

    def mk_annotations_dir
      dir_name = "#{full_name}/#{@annotations_directory.name}"
      if container.find_entry(dir_name, :include_hidden => true).nil?
        container.mkdir dir_name
      end
    end

    # Convert an annotation content field into something compatible with the
    # rubyzip file naming convention (i.e. full paths not prefixed with /).
    def normalize_content_name(name)
      return if name.nil?

      if name.start_with?(@annotations_directory.name)
        "#{full_name}/#{name}"
      elsif name.start_with?("/#{@annotations_directory.full_name}")
        name.slice(1, name.length)
      else
        nil
      end
    end

    # The managed annotations directory within the .ro directory.
    #
    # For internal use only.
    class AnnotationsDir < ZipContainer::ManagedDirectory

      DIR_NAME = "annotations" # :nodoc:

      # :call-seq:
      #   new
      #
      # Create a new annotations managed directory. The directory is hidden
      # under normal circumstances.
      def initialize
        super(DIR_NAME, :hidden => true)
      end

    end
  end
end