sinicum 0.5.0

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+
+task default: [:spec, :rubocop]
+
+desc "Create Sinicum plugin documentation"
+task :doc do |doc|
+
+  require 'yard'
+
+  gem_root = File.dirname(__FILE__)
+
+  docdir = ENV['docdir'] || File.join(gem_root, "doc")
+  rm_r Dir.glob(docdir + "/*") if File.exists?(docdir)
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = [File.join(gem_root, "lib", "**", "*.rb")]   # optional
+    t.options = ['-m', 'markdown', '--protected', '-o', docdir,
+      '-r', File.join(gem_root, "README.md")]
+  end
+  Rake::Task[:yard].invoke
+end

data/app/assets/javascripts/sinicum/magnolia_client.js.coffee

@@ -0,0 +1,233 @@
+sinicum = sinicum ? { }
+
+sinicum.renderDocumentReady = true
+
+
+class sinicum.MagnoliaClient
+  setMainBar: (elements) ->
+    jQuery.each(elements, (index, value) ->
+      element = jQuery(value)
+      config = {}
+      config['dialog'] = element.data("dialog")
+      config['label'] = element.data("label")
+      config['adminButtonVisible'] = element.data("admin-button-visible")
+      config['repository'] = element.data("repository")
+      config['nodePath'] = element.data("node-path")
+      element.wrapInner(new sinicum.MainBar(config).render())
+    )
+
+  setMainBarPreview: (elements) ->
+    jQuery.each(elements, (index, value) ->
+      element = jQuery(value)
+      element.wrapInner(new sinicum.MainBarPreview().render())
+    )
+
+  setNewBar: (elements) ->
+    jQuery.each(elements, (index, value) ->
+      element = jQuery(value)
+      config = {}
+      config['contentNodeCollectionName'] = element.data("content-node-collection-name")
+      config['contentNodeName'] = element.data("content-node-name")
+      config['label'] = element.data("label")
+      config['paragraph'] = element.data("paragraph")
+      config['repository'] = element.data("repository")
+      config['nodePath'] = element.data("node-path")
+      element.wrapInner(new sinicum.NewBar(config).render())
+    )
+
+  setEditBar: (elements) ->
+    jQuery.each(elements, (index, value) ->
+      element = jQuery(value)
+      config = {}
+      config['repository'] = element.data("repository")
+      config['nodePath'] = element.data("node-path")
+      config['paragraph'] = element.data("paragraph")
+      config['contentNodeCollectionName'] = element.data("content-node-collection-name")
+      config['contentNodeIteratorIndex'] = element.attr("data-content-node-iterator-index")
+      config['contentNodeIteratorPath'] = element.data("content-node-iterator-path")
+      config['deleteLabel'] = element.data("delete-label")
+      config['editLabel'] = element.data("edit-label")
+      config['moveLabel'] = element.data("move-label")
+      element.wrapInner(new sinicum.EditBar(config).render())
+    )
+
+
+class sinicum.MainBar
+  constructor: (options) ->
+    @label = "Properties"
+    @adminButtonVisible = true
+    if options
+      @dialog = options['dialog']
+      @repository = options['repository']
+      @nodePath = options['nodePath']
+      if options['label']
+        @label = options['label']
+      if options['adminButtonVisible'] == false || options['adminButtonVisible'] == 'false'
+        @adminButtonVisible = false
+
+  render: ->
+    wrapper = jQuery("<div class\"mgnlMainBar\" style=\"top:0px;left:0px;width:100%;\"></div>")
+    wrapper.append(this.renderControlBarTable())
+
+  renderControlBarTable: ->
+    # left
+    leftColumn = jQuery("<td class=\"mgnlBtnsLeft\"></td>")
+    leftColumn.append(btn.render()) for btn in this.leftButtons()
+    # right
+    rightColumn = jQuery("<td class=\"mgnlBtnsRight\"></td>")
+    rightColumn.append(btn.render()) for btn in this.rightButtons()
+    # table structure
+    row = jQuery("<tr></tr>").append(leftColumn).append(rightColumn)
+    body = jQuery("<tbody></tbody>").append(row)
+    table = jQuery("<table class=\"mgnlControlBar\"></table>").append(body)
+    table
+
+  leftButtons: ->
+    buttons = []
+    buttons.push(new sinicum.MgnlButton("« Preview", "mgnlPreview(true)"))
+    if @adminButtonVisible
+      buttons.push(new sinicum.MgnlButton("AdminCentral",
+        "MgnlAdminCentral.showTree(\'#{this.escJs(@repository)}\'," +
+        "\'#{this.escJs(@nodePath)}\')"))
+    buttons
+
+  rightButtons: ->
+    [
+      new sinicum.MgnlButton(@label,
+        "mgnlOpenDialog(\'#{this.escJs(@nodePath)}\',\'\',\'\',\'#{this.escJs(@dialog)}\'," +
+        "\'#{this.escJs(@repository)}\',null, null, null)")
+    ]
+
+  escJs: (string) ->
+    if string
+      string.replace(/\'/g, "\\'")
+
+class sinicum.MainBarPreview
+  render: ->
+    html = "<div class=\"mgnlMainbarPreview\" style=\"top:4px;left:4px;\">" +
+      "<span onmousedown=\"mgnlShiftPushButtonDown(this);\" " +
+      "onmouseout=\"mgnlShiftPushButtonOut(this);\" " +
+      "onclick=\"mgnlShiftPushButtonClick(this);mgnlPreview(false);\" " +
+      "class=\"mgnlControlButton\" style=\"\">»</span>" +
+      "</div>"
+    jQuery(html)
+
+
+class sinicum.NewBar
+  constructor: (options) ->
+    @contentNodeCollectionName = options['contentNodeCollectionName']
+    @contentNodeName = options['contentNodeName']
+    @label = "New" || options['label']
+    @paragraph = options['paragraph']
+    @repository = options['repository']
+    @nodePath = options['nodePath']
+
+  render: ->
+    html = "<table onmousedown=\"mgnlMoveNodeEnd(this,'#{@nodePath}');\" " +
+      "onmouseout=\"mgnlMoveNodeReset(this);\" onmouseover=\"mgnlMoveNodeHigh(this);\" " +
+      "class=\"mgnlControlBarSmall\" id=\"#{@contentNodeCollectionName}__mgnlNew\" cellspacing=\"0\">" +
+      "<tbody><tr><td class=\"mgnlBtnsLeft\">" +
+      "<span onmousedown=\"mgnlShiftPushButtonDown(this);\" " +
+      "onmouseout=\"mgnlShiftPushButtonOut(this);\" " +
+      "onclick=\"mgnlShiftPushButtonClick(this);" +
+      "mgnlOpenDialog('#{@nodePath}',"
+    if @contentNodeCollectionName
+      html += "'#{@contentNodeCollectionName}','mgnlNew',"
+    else if @contentNodeName
+      html += "'','#{@contentNodeName}',"
+    html += "'#{@paragraph}','#{@repository}'," +
+      "'.magnolia/dialogs/#{this.editPageName()}', null, null);\" " +
+      "class=\"mgnlControlButtonSmall\" style=\"background-color: transparent; " +
+      "background-position: initial initial; background-repeat: initial initial; \">" +
+      "New</span></td></tr></tbody></table>"
+    wrapper = jQuery(html)
+    wrapper
+
+  editPageName: ->
+    pageName = "editParagraph.html"
+    if @paragraph && @paragraph.indexOf(",") > 0
+      pageName = "selectParagraph.html"
+    pageName
+
+
+class sinicum.EditBar
+  constructor: (options) ->
+    @repository = options['repository']
+    @nodePath = options['nodePath']
+    @paragraph = options['paragraph']
+    @deleteLabel = options['deleteLabel'] || "Delete"
+    @editLabel = options['editLabel'] || "Edit"
+    @moveLabel = options['moveLabel'] || "Move"
+    @contentNodeCollectionName = options['contentNodeCollectionName']
+    @contentNodeIteratorIndex = options['contentNodeIteratorIndex']
+    @contentNodeIteratorPath = options['contentNodeIteratorPath']
+
+  render: ->
+    html = "<table onmousedown=\"mgnlMoveNodeEnd(this,'#{@nodePath}');\" " +
+      "onmouseout=\"mgnlMoveNodeReset(this);\" onmouseover=\"mgnlMoveNodeHigh(this);\" " +
+      "class=\"mgnlControlBarSmall\" id=\"__#{@contentNodeIteratorIndex || 0}\" cellspacing=\"0\">" +
+      "<tbody><tr><td class=\"mgnlBtnsLeft\">" +
+
+      "<span onmousedown=\"mgnlShiftPushButtonDown(this);\" " +
+      "onmouseout=\"mgnlShiftPushButtonOut(this);\" " +
+      "onclick=\"mgnlShiftPushButtonClick(this);mgnlOpenDialog("
+    if @contentNodeCollectionName
+      html += "'#{@nodePath}','','#{@contentNodeIteratorIndex}',"
+    else
+      html += "'#{@nodePath}','','',"
+    html += "'#{@paragraph}','#{@repository}'," +
+      "'.magnolia/dialogs/#{this.editPageName()}', null, null);\" " +
+      "class=\"mgnlControlButtonSmall\" style=\"background:transparent;\">#{@editLabel}</span>"
+
+    if @contentNodeCollectionName
+      html += "<span onmousedown=\"mgnlShiftPushButtonDown(this);\" " +
+      "onmouseout=\"mgnlShiftPushButtonOut(this);\" " +
+      "onclick=\"mgnlShiftPushButtonClick(this);mgnlMoveNodeStart('','#{@contentNodeIteratorIndex}','__#{@contentNodeIteratorIndex}');\" " +
+      "class=\"mgnlControlButtonSmall\" style=\"background:transparent;\">#{@moveLabel}</span></td>"
+
+    html += "<td class=\"mgnlBtnsRight\"><span onmousedown=\"mgnlShiftPushButtonDown(this);\" " +
+      "onmouseout=\"mgnlShiftPushButtonOut(this);\" onclick=\"mgnlShiftPushButtonClick(this);"
+    if @contentNodeCollectionName
+      html += "mgnlDeleteNode('#{@nodePath}','','#{@contentNodeIteratorIndex}');\" "
+    else
+      html += "mgnlDeleteNode('#{@nodePath}');\" "
+    html += "class=\"mgnlControlButtonSmall\" style=\"background:transparent;\">#{@deleteLabel}" +
+      "</span></td></tr></tbody></table>"
+    wrapper = jQuery(html)
+    wrapper
+
+  editPageName: ->
+    pageName = "editParagraph.html"
+    if @paragraph && @paragraph.indexOf(",") > 0
+      pageName = "selectParagraph.html"
+    pageName
+
+
+class sinicum.MgnlButton
+  constructor: (@text, @onclickAction) ->
+
+  render: ->
+    button = jQuery("<span></span>")
+    button.addClass("mgnlControlButton")
+    button = button.attr("onmousedown", "mgnlShiftPushButtonDown(this);")
+    button = button.attr("onmouseout", "mgnlShiftPushButtonOut(this);")
+    button = button.attr("onclick", "mgnlShiftPushButtonClick(this);#{@onclickAction};")
+    button = button.css("background", "transparent")
+    button = button.text(@text)
+    button
+
+sinicum.renderBars = ->
+  client = new sinicum.MagnoliaClient()
+  client.setMainBar(jQuery(".sinicum-mgnl-main-bar"))
+  client.setMainBarPreview(jQuery(".sinicum-mgnl-main-bar-preview"))
+  client.setEditBar(jQuery(".sinicum-mgnl-edit-bar"))
+  client.setNewBar(jQuery(".sinicum-mgnl-new-bar"))
+
+sinicum.preventDefaultRender = ->
+  sinicum.renderDocumentReady = false
+
+window.sinicum = sinicum
+
+jQuery ->
+  if sinicum.renderDocumentReady
+    sinicum.renderBars()

data/app/controllers/sinicum/controller_base.rb

@@ -0,0 +1,173 @@
+# encoding: utf-8
+
+module Sinicum
+  module ControllerBase
+    HTML_SUFFIX = ".html"
+    extend ActiveSupport::Concern
+    include Controllers::CacheAware
+
+    included do
+      prepend_before_filter ::Sinicum::Controllers::GlobalStateCache
+      prepend_before_filter :remove_html_suffix
+      after_filter ::Sinicum::Controllers::GlobalStateCache
+    end
+
+    def index
+      cms_render
+    end
+
+    def render(options = {}, locals = {}, &block)
+      find_original_content_for_path(content_path)
+      unless redirect_redirect_page
+        check_for_content!
+        options[:layout] = layout_file_name_or_fallback
+        block_given? ? super(options, locals, block) : super(options, locals)
+      end
+    end
+
+    # Deprecated!
+    def cms_render
+      client_cache_control
+      render inline: "", use_sinicum_template_layout: true
+    end
+
+    protected
+
+    def content_path
+      request.path
+    end
+
+    def find_original_content_for_path(path = nil)
+      path ||= content_path
+      original_content = Content::WebsiteContentResolver.find_for_path(path)
+      Content::Aggregator.original_content = original_content
+    end
+
+    # Constructs the name of the layout file. Per default: Name of the template without special
+    # characters and spaces. Override in subclasses.
+    #
+    # @return [String] the layout filename (without 'html.erb')
+    def layout_file_name
+      layout = "application"
+      fail unless Content::Aggregator.original_content
+      prepare_layout(layout)
+    end
+
+    private
+
+    def prepare_layout(layout)
+      if Content::Aggregator.original_content &&
+          Content::Aggregator.original_content.mgnl_template
+        layout = Content::Aggregator.original_content.mgnl_template.dup
+      end
+      layout = handle_mgnl45_names(layout)
+      layout = handle_umlauts(layout)
+      layout.downcase!
+      layout.gsub!(/\s/, '_')
+      layout.gsub!(/[^\w\/-]/, '')
+      add_sinicum_layout_prefix(layout)
+    end
+
+    def add_sinicum_layout_prefix(layout)
+      if self.class.sinicum_layout_prefix.present?
+        layout = self.class.sinicum_layout_prefix + "/" + layout
+      end
+      layout
+    end
+
+    def check_for_content!
+      unless Sinicum::Content::Aggregator.content_data
+        fail ActionController::RoutingError.new("Page not found.")
+      end
+    end
+
+    def handle_mgnl45_names(layout_name)
+      result = layout_name
+      if result.index(":pages/")
+        parts = layout_name.split(":")
+        result = parts[0] + "/"
+        result << parts[1][":pages/".size - 1, parts[1].size]
+      end
+      result
+    end
+
+    def redirect_redirect_page
+      return false if request.headers["HTTP_X_MGNL_ADMIN"].present?
+      page = ::Sinicum::Content::Aggregator.content_data
+      if redirect_page_45?(page) || redirect_page_44?(page)
+        redirect_target = page[:redirect_link]
+        if Sinicum::Util.is_a_uuid?(redirect_target)
+          redirect_target = Sinicum::Jcr::Node.find_by_uuid("website", redirect_target).try(:path)
+        end
+        redirect_to redirect_target
+        true
+      end
+      false
+    end
+
+    def redirect_page_44?(page)
+      template_exists?(page) && page.mgnl_template == "redirect" && page[:redirect_link]
+    end
+
+    def redirect_page_45?(page)
+      template_exists?(page) && page.mgnl_template.index("pages/redirect") && page[:redirect_link]
+    end
+
+    def template_exists?(page)
+      page && page.mgnl_template
+    end
+
+    # Determines the name of the layout file that is _actually_ used by the controller.
+    # By default it's the result of `layout_file_name`. If this file cannot be found, a
+    # default replacement (`application`) is used
+    #
+    # @return [String] the name of the layout file actually used
+    def layout_file_name_or_fallback
+      ActionController::Base.view_paths.each do |path|
+        ActionView::Template::Handlers.extensions.each do |engine_suffix|
+          format = params[:format].presence || "html"
+          file_in_path = File.join(
+            path.to_s, "layouts", "#{layout_file_name}.#{format}.#{engine_suffix}"
+          )
+          return layout_file_name if File.exist?(file_in_path)
+        end
+      end
+      fallback = "application"
+      if self.class.sinicum_layout_prefix.present?
+        fallback = self.class.sinicum_layout_prefix + "/" + fallback
+      end
+      fallback
+    end
+
+    def remove_html_suffix
+      if request.get? && request.path =~ /#{HTML_SUFFIX}$/i
+        new_path = request.path[0, request.path.length - HTML_SUFFIX.length]
+        if request.query_string && !request.query_string.blank?
+          new_path << "?#{request.query_string}"
+        end
+        redirect_to new_path
+      end
+    end
+
+    def find_content_for_request
+      find_original_content_for_path(content_path)
+      yield
+    end
+
+    def handle_umlauts(layout)
+      if !layout.respond_to?(:encode)
+        @_iconv ||= Iconv.new("US-ASCII//IGNORE", "UTF-8")
+        layout = @_iconv.iconv(layout)
+      elsif layout
+        layout = layout.encode(
+          "US-ASCII", undef: :replace, invalid: :replace, replace: '-'
+        )
+      end
+      layout
+    end
+
+    module ClassMethods
+      attr_accessor :sinicum_layout_prefix
+    end
+  end
+end

data/app/controllers/sinicum/controllers/cache_aware.rb

@@ -0,0 +1,16 @@
+module Sinicum
+  module Controllers
+    module CacheAware
+      DEFAULT_CACHE_EXPIRATION_TIME = 10.minutes
+      TIMESTAMP_ASSET_EXPIRATION_TIME = 30.days
+
+      # Sets the HTTP cache parameters. By default, an expiration time of 10 minutes and a
+      # public cache is used when `Rails.env` is `production`
+      def client_cache_control
+        if Rails.application.config.action_controller.perform_caching
+          expires_in(DEFAULT_CACHE_EXPIRATION_TIME, public: true)
+        end
+      end
+    end
+  end
+end