sinicum 0.5.0

data/lib/generators/sinicum/templates/rails/_content.html.haml

@@ -0,0 +1,2 @@
+- mgnl_components.each do |component|
+  = mgnl_render_component(component)

data/lib/generators/sinicum/templates/rails/_meta.html.haml

@@ -0,0 +1,9 @@
+<!--[if lt IE 9]>
+<script>'article aside footer header nav section time'.replace(/\w+/g,function(n){document.createElement(n)})</script>
+<![endif]-->
+= mgnl_meta
+= mgnl_init
+= csrf_meta_tags
+%meta(charset="utf-8")
+%meta(http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1")
+%meta(name="viewport" content="width=device-width, initial-scale=1.0")

data/lib/generators/sinicum/templates/rails/application.html.haml

@@ -0,0 +1,11 @@
+!!!
+%html
+  %head
+    = render partial: "shared/meta"
+    = stylesheet_link_tag     "application"
+    = javascript_include_tag  "application"
+  
+  %body
+
+    = yield
+    = mgnl_area :content

data/lib/generators/sinicum/templates/rails/content_controller.rb

@@ -0,0 +1,5 @@
+# Base Controller all Magnolia-related controllers should inherit
+# from.
+class ContentController < ApplicationController
+  include Sinicum::ControllerBase
+end

data/lib/generators/sinicum/templates/rails/imaging.yml

@@ -0,0 +1,8 @@
+renderer:
+
+  default:
+    render_type: resize_crop
+    format: jpeg
+    x: 307
+    y: 202
+    hires_factor: 2

data/lib/generators/sinicum/templates/rails/sinicum_server.yml

@@ -0,0 +1,15 @@
+development: &sinicumconnect
+  host: localhost
+  port: 8080
+  username: superuser
+  password: superuser
+
+test:
+  <<: *sinicumconnect
+  port: 8081
+
+author:
+  <<: *sinicumconnect
+
+production:
+  <<: *sinicumconnect

data/lib/sinicum.rb

@@ -0,0 +1,53 @@
+require 'active_support/core_ext'
+require 'sinicum/engine'
+
+module Sinicum
+  require 'sinicum/logger'
+
+  require 'sinicum/content/aggregator'
+  require 'sinicum/content/website_content_resolver'
+
+  require 'sinicum/util'
+
+  require 'sinicum/imaging'
+  require 'sinicum/imaging/config'
+  require 'sinicum/imaging/converter'
+  require 'sinicum/imaging/imaging'
+  require 'sinicum/imaging/max_size_converter'
+  require 'sinicum/imaging/resize_crop_converter'
+  require 'sinicum/imaging/default_converter'
+  require 'sinicum/imaging/image_size_converter'
+  require 'sinicum/imaging/imaging_middleware'
+  require 'sinicum/imaging/imaging_file'
+
+  require 'sinicum/jcr/jcr_configuration'
+  require 'sinicum/jcr/api_queries'
+  require 'sinicum/jcr/api_client'
+  require 'sinicum/jcr/query_sanitizer'
+  require 'sinicum/jcr/node_queries'
+  require 'sinicum/jcr/mgnl4_compatibility'
+  require 'sinicum/jcr/node'
+  require 'sinicum/jcr/node_initializer'
+
+  require 'sinicum/jcr/dam/document'
+  require 'sinicum/jcr/dam/image'
+
+  require 'sinicum/jcr/type_translators/translator_base'
+  require 'sinicum/jcr/type_translators/default_translator'
+  require 'sinicum/jcr/type_translators/component_translator'
+  require 'sinicum/jcr/type_translators/dam_translator'
+  require 'sinicum/jcr/type_translators/data_translator'
+  require 'sinicum/jcr/type_translator'
+
+  require 'sinicum/jcr/cache/global_cache'
+
+  require 'sinicum/templating/templating_utils'
+  require 'sinicum/templating/dialog_resolver'
+  require 'sinicum/templating/area_handler'
+
+  require 'sinicum/navigation/navigation_element'
+  require 'sinicum/navigation/navigation_status'
+  require 'sinicum/navigation/default_navigation_element'
+  require 'sinicum/navigation/navigation_handler'
+  require 'sinicum/navigation/navigation_element_list'
+end

data/lib/sinicum/content/aggregator.rb

@@ -0,0 +1,173 @@
+# encoding: utf-8
+module Sinicum
+  module Content
+    # Public: Handles the content and provides access to it during a request
+    class Aggregator
+      include Sinicum::Logger
+      class << self
+        # Public: Set the "original content" of a request, i.e. the content object
+        # that represents the "base" of the request, before any other object is
+        # subsequently pushed. Usually the content object of the node corresponding
+        # to the URI called.
+        #
+        # Usually, this method should only be called once during a request.
+        #
+        # When this method is called, all other stacks (`content_data`,
+        # `content_node`) are being reset.
+        #
+        # node - The Node with the original content object.
+        #
+        # Returns nothing.
+        def original_content=(node)
+          clean
+          Thread.current[:__cms_original_content] = node
+        end
+
+        # Retrieves the `original_content` object.
+        #
+        # Returns a Node with the original content object.
+        def original_content
+          Thread.current[:__cms_original_content]
+        end
+
+        # Retrieves the current "active page", comparable to the Magnolia property
+        # "actpage".
+        #
+        # Returns the Node with the current "active page" or the `original_content`
+        # if no active page has explicitly been set.
+        def active_page
+          stack(:__cms_active_page).first || original_content
+        end
+
+        # Sets a new "active page", makes it the new `cms_content_data` and executes
+        # the given block in this context. Resets all changes afterwards.
+        #
+        # node - The node with the active active page.
+        def push_active_page(node, &block)
+          stack(:__cms_active_page).push(node)
+          begin
+            push(node) do
+              yield
+            end
+          ensure
+            pop(:__cms_active_page)
+          end
+        end
+
+        # Retrieves the `content_data` object currently on top of the stack.
+        #
+        # Returns the current Node.
+        def content_data
+          if stack && stack.length > 0
+            stack.last
+          else
+            original_content
+          end
+        end
+
+        # Push a new `content_data` object on top of the stack and pop it after
+        # returning from the block
+        #
+        # node - The Node to push on top of the stack
+        def push(node, &block)
+          stack.push(node)
+          begin
+            yield
+          ensure
+            pop
+          end
+        end
+
+        # Push a new `Content` object on top of the stack and update Magnolia's
+        # `current_content`.
+        #
+        # node - The object to push, must wrap a Magnolia `Content` object.
+        def push_current_content(node, &block)
+          stack.push(node)
+          begin
+            yield
+          ensure
+            pop
+          end
+        end
+
+        def push_node_iterator(node, key)
+          stack(:__content_iterator_stack).push(node)
+          stack(:__content_iterator_stack_key).push(key)
+          begin
+            yield
+          ensure
+            pop(:__content_iterator_stack)
+            pop(:__content_iterator_stack_key)
+          end
+        end
+
+        def node_iterator_key
+          stack(:__content_iterator_stack_key).last
+        end
+
+        def node_iterator
+          stack(:__content_iterator_stack).last
+        end
+
+        # Convenience method for pushing the _contents_ of a `ContentNode` with the _name_
+        # `content_node_name`, based on the current `content_data` object, on top of the stack
+        # and popping it afterwards. If no node with the name exists, an empty `Hash` is pushed.
+        #
+        # Primarily intended to be used with the `cms_content_node` helper
+        #
+        # @param [String] content_node_name the name of the `content_node` as it is stored in the
+        # current `content_data` object
+        def push_content_node(content_node_name, &block)
+          node_data = nil
+          if content_data && content_data.key?(content_node_name)
+            node_data = content_data[content_node_name]
+          else
+            node_data = {}
+          end
+          stack(:__content_node_stack).push(content_node_name)
+          stack.push(node_data)
+          begin
+            yield
+          ensure
+            pop
+            pop(:__content_node_stack)
+          end
+        end
+
+        # Retrieves the current `content_node` or `nil` if none is set
+        #
+        # @return [Content, nil] _Usually_ a `Content`-like object, `nil` if no `content_node`
+        # has been set
+        def content_node
+          if stack(:__content_node_stack) && stack(:__content_node_stack).length > 0
+            stack(:__content_node_stack).last
+          else
+            nil
+          end
+        end
+
+        # Resets all stacks. Should always be called at the end of a request
+        def clean
+          Thread.current[:__cms_original_content] = nil
+          Thread.current[:__cms_active_page] = nil
+          Thread.current[:__cms_stack] = nil
+          Thread.current[:__content_node_stack] = nil
+          Thread.current[:__content_iterator_stack] = nil
+          Thread.current[:__content_iterator_stack_key] = nil
+        end
+
+        private
+
+        def pop(stack_name = :__cms_stack)
+          stack(stack_name).pop
+        end
+
+        def stack(stack_name = :__cms_stack)
+          Thread.current[stack_name] ||= []
+          Thread.current[stack_name]
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/content/website_content_resolver.rb

@@ -0,0 +1,10 @@
+module Sinicum
+  module Content
+    # Public: Fetches the content from Magnolia based on the path of the request.
+    class WebsiteContentResolver
+      def self.find_for_path(path)
+        ::Sinicum::Jcr::Node.find_by_path(:website, path) if path
+      end
+    end
+  end
+end

data/lib/sinicum/engine.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module Sinicum
+  # Internal: Initialize the Gem in a Rails environment
+  class Engine < Rails::Engine
+    SINICUM_SERVER_CONFIG_FILE = File.join("config", "sinicum_server.yml")
+
+    initializer "configure_jcr" do |app|
+      config_file = File.join(Rails.root, SINICUM_SERVER_CONFIG_FILE)
+      if File.exist?(config_file)
+        jcr_config_file = File.read(config_file)
+        config = YAML.load(jcr_config_file)[Rails.env]
+        ::Sinicum::Jcr::ApiQueries.configure_jcr = config
+      else
+        Rails.logger.warn("Sinicum configuration file not found, Sinicum is not configured.")
+      end
+    end
+
+    initializer "sinicum.add_middleware" do |app|
+      app.middleware.insert_after ActionDispatch::Callbacks, Sinicum::Imaging::ImagingMiddleware
+    end
+  end
+end

data/lib/sinicum/imaging.rb

@@ -0,0 +1,29 @@
+module Sinicum
+  module Imaging
+    DEFAULT_CONVERTER_NAME = "default"
+    DEFAULT_IMAGING_PREFIX = "/damfiles"
+    DEFAULT_IMAGING_DMS_PREFIX = "/dmsfiles"
+    DEFAULT_DAM_PREFIX = "/dam"
+    DEFAULT_DMS_PREFIX = "/dms"
+
+    def self.default_converter_name
+      DEFAULT_CONVERTER_NAME
+    end
+
+    def self.path_prefix_mgnl4
+      DEFAULT_IMAGING_DMS_PREFIX
+    end
+
+    def self.path_prefix
+      DEFAULT_IMAGING_PREFIX
+    end
+
+    def self.dam_path_prefix
+      DEFAULT_DAM_PREFIX
+    end
+
+    def self.dms_path_prefix
+      DEFAULT_DMS_PREFIX
+    end
+  end
+end

data/lib/sinicum/imaging/config.rb

@@ -0,0 +1,133 @@
+module Sinicum
+  module Imaging
+    # Represents the configuraiton of the imaging module and its renderers
+    class Config
+      IMAGING_CONFIG_FILE = "config/imaging.yml"
+
+      require 'fileutils'
+
+      include Sinicum::Logger
+
+      # The version number of the imaging directory format. Stored in the file `VERSION`.
+      VERSION = "1.0"
+
+      # Default Root directory
+      DEFAULT_ROOT_DIR = File.join("tmp", "imaging")
+
+      # If the directory sturcture is already set up
+      @@dir_setup = false
+
+      # The root directory under which all files are stored
+      attr_reader :root_dir
+
+      # The directory to store all rendered files in
+      #
+      # @return [String]
+      def file_dir
+        File.join(@root_dir, "files")
+      end
+
+      # The directory to store temporary files in
+      #
+      # @return [String]
+      def tmp_dir
+        File.join(@root_dir, "tmp")
+      end
+
+      # Path of the file that stores the version of the directory format.
+      #
+      # @return [String]
+      def version_file
+        File.join(@root_dir, "VERSION")
+      end
+
+      # Initialize and setup the configuration
+      #
+      # @param [String, nil] configfile Path of the configuration file. If `nil`,
+      # `Rails.root/config/imaging.yml` will be used.
+      def self.configure(configfile)
+        config = Config.send(:new, configfile)
+        @@__instance__ = config
+        @@config = true
+        config
+      end
+
+      # Obtain an instance of the imaging configuration.
+      def self.instance
+        @@__instance__ ||= false
+        fail "Class is not yet configured" unless @@__instance__
+        @@__instance__
+      end
+
+      # Returns the converter class for a given renderer
+      #
+      # @param [Symbol] the renderer to use
+      # @return [Sinicum::Imaging::Converter] the converter to use for this renderer
+      def converter(renderer)
+        result = nil
+        renderer_config = read_config[renderer.to_s]
+        result = render_type(renderer_config) if renderer_config
+        result ||= DefaultConverter.new(nil)
+        result
+      end
+
+      def self.read_configuration
+        config_file = File.join(Rails.root, IMAGING_CONFIG_FILE)
+        if Rails.env.production?
+          @@conf ||= configure(config_file)
+        else
+          configure(config_file)
+        end
+      end
+
+      private
+
+      attr_reader :config_file
+
+      def render_type(renderer_config)
+        case renderer_config["render_type"]
+        when "default" then
+          Sinicum::Imaging::DefaultConverter.new(renderer_config)
+        when "resize_crop" then
+          Sinicum::Imaging::ResizeCropConverter.new(renderer_config)
+        when "resize_max" then
+          Sinicum::Imaging::MaxSizeConverter.new(renderer_config)
+        else nil
+        end
+      end
+
+      def read_config
+        config = YAML.load_file(config_file)
+        @root_dir = config['root_dir'] || File.join(Rails.root, DEFAULT_ROOT_DIR)
+        setup_directory_structure(@root_dir)
+        config['renderer']
+      end
+
+      def setup_directory_structure(dir)
+        unless @@dir_setup
+          @@dir_setup = true
+          FileUtils.mkdir_p(root_dir) unless File.exist?(root_dir)
+          unless File.exist?(version_file)
+            File.open(version_file, "w") { |f| f.write(VERSION + "\n") }
+          end
+          FileUtils.mkdir_p(dir) unless File.exist?(dir)
+          FileUtils.mkdir_p(tmp_dir) unless File.exist?(tmp_dir)
+          FileUtils.mkdir_p(file_dir) unless File.exist?(file_dir)
+        end
+      end
+
+      def initialize(configfile)
+        @config_file = configfile
+        read_config
+      end
+
+      def self.new(*args)
+        super
+      end
+
+      def self.allocate
+        super
+      end
+    end
+  end
+end