scrivito_sdk 0.12.0

data/lib/scrivito/editing_context.rb

@@ -0,0 +1,106 @@
+module Scrivito
+
+class EditingContext
+  # +options+:
+  #   +:selected_workspace_id+: The id of the selected workspace. If empty +published+ workspace is used.
+  #   +:display_mode+: Can be +view+, +editing+, +added+ or +deleted+. If empty +view+ is used.
+  #   +:editor+: A block, which is lazy evaluated on first access, to determine the editor (details see {Scrivito::Configuation.editing_auth})
+  # @param [Hash] options
+  def initialize(options = {})
+    @selected_workspace_id = options[:selected_workspace_id]
+    @display_mode = options[:display_mode] || "view"
+    @editor_callback = options[:editor] || proc { false }
+  end
+
+  def editor
+    unless @editor_already_evaluated
+      @editor_already_evaluated = true
+      @editor = @editor_callback.call
+    end
+
+    @editor
+  end
+
+  # true iff {editor} truish
+  def authenticated_editor?
+    editor.present?
+  end
+
+  # @return [String]
+  def display_mode
+    if authenticated_editor? && !selected_workspace.published?
+      @display_mode
+    else
+      'view'
+    end
+  end
+
+  # defaults to "published" if no workspace with `selected_workspace_id` can be found.
+  # @return [Workspace]
+  def selected_workspace
+    unless @selected_workspace
+      if @selected_workspace_id
+        begin
+          @selected_workspace = Workspace.find(@selected_workspace_id)
+        rescue Scrivito::ResourceNotFound
+          @selected_workspace = Workspace.default
+        end
+      else
+        @selected_workspace = Workspace.default
+      end
+    end
+
+    @selected_workspace
+  end
+
+  # when authenticated_editor? return selected_workspace, otherwise published workspace.
+  # @return [Workspace]
+  def visible_workspace
+    unless @visible_workspace
+      if authenticated_editor?
+        if display_mode == 'deleted'
+          @visible_workspace = Workspace.default
+        else
+          @visible_workspace = selected_workspace
+        end
+      else
+        @visible_workspace = Workspace.default
+      end
+    end
+
+    @visible_workspace
+  end
+
+  def comparison
+    @comparison ||=
+      begin
+        revision = compare_revision
+        Comparison.new(
+          revision, display_mode == 'deleted', revision ? display_mode : nil
+        )
+      end
+  end
+
+  def to_params
+    {
+      '_scrivito_display_mode' => display_mode,
+      '_scrivito_workspace_id' => selected_workspace.id,
+    }
+  end
+
+  private
+
+  # @return [Revision] or +nil+
+  def compare_revision
+    case display_mode
+    when 'added'
+      selected_workspace.base_revision
+    when 'deleted'
+      selected_workspace.revision
+    when 'diff'
+      selected_workspace.base_revision
+    end
+  end
+end
+
+end # module Scrivito

data/lib/scrivito/editing_context_middleware.rb

@@ -0,0 +1,60 @@
+require 'multi_json'
+
+module Scrivito
+
+class EditingContextMiddleware
+  ENVKEY = 'SCRIVITO_EDITING_CONTEXT'
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+
+    url_params    = parse_url_params(request)
+    header_params = parse_header_params(env)
+    cookie_params = parse_cookie_params(request)
+
+    display_mode = url_params['display_mode'] ||
+        header_params['display_mode'] ||
+        cookie_params['display_mode']
+
+    workspace_id = url_params['workspace_id'] ||
+        header_params['workspace_id'] ||
+        cookie_params['workspace_id']
+
+    env[ENVKEY] = EditingContext.new(
+      display_mode: display_mode,
+      editor: -> { Configuration.editing_auth_callback.call(env) },
+      selected_workspace_id: workspace_id
+    )
+
+    @app.call(env)
+  end
+
+  private
+
+  def parse_url_params(request)
+    {
+      'display_mode' => request.params['_scrivito_display_mode'],
+      'workspace_id' => request.params['_scrivito_workspace_id'],
+    }
+  end
+
+  def parse_header_params(env)
+    parse_json_params(env['HTTP_SCRIVITO_EDITING_CONTEXT'])
+  end
+
+  def parse_cookie_params(request)
+    parse_json_params(request.cookies['scrivito_editing_context'])
+  end
+
+  def parse_json_params(json_params)
+    MultiJson.decode(json_params)
+  rescue MultiJson::ParseError
+    {}
+  end
+end
+
+end

data/lib/scrivito/engine.rb

@@ -0,0 +1,65 @@
+require "rails"
+require "action_view"
+require "active_model"
+
+require 'jquery-rails'
+
+require 'scrivito/configuration'
+
+module ::Scrivito
+  class Engine < Rails::Engine
+    config.to_prepare { Scrivito::Configuration.to_prepare }
+
+    # make sure our exceptions cause an adequate error page and http status code
+    config.action_dispatch.rescue_responses.merge!("Scrivito::ResourceNotFound" => :not_found)
+
+    initializer "scrivito.add_cms_routing_paths", :after => :add_routing_paths do |app|
+      cms_route = File.expand_path("cms_routes.rb", paths['config'].to_a.first)
+      app.routes_reloader.paths.push(cms_route)
+    end
+
+    # Expose Scrivito SDK runtime to controller for logging.
+    initializer "scrivito.log_runtime" do |app|
+      runtime =
+        begin
+          Scrivito::ControllerRuntime
+        rescue NameError
+          nil
+        end
+
+      if runtime
+        Scrivito::LogSubscriber.attach_to :scrivito
+        ActiveSupport.on_load(:action_controller) do
+          include runtime
+        end
+      end
+    end
+
+    initializer "scrivito.configure_database", :before => :load_config_initializers do |app|
+      Scrivito::Configuration.configure_cms_database
+    end
+
+    initializer "scrivito.routing_helpers" do
+      if Rails.env == 'test'
+        ActionDispatch::TestRequest.__send__(:include, Scrivito::CmsTestRequest)
+      end
+
+      ActionController::Base.__send__(:include, CmsRoutingHelper)
+      ActionView::Base.__send__(:include, CmsRoutingHelper)
+    end
+
+    initializer "scrivito.add_assets" do |app|
+      # Specify which file should be precompiled for packaging
+      app.config.assets.precompile += %w( scrivito_editing.js scrivito_editing.css scrivito.css )
+      app.config.assets.precompile += %w(*.png *.jpg *.jpeg *.gif)
+    end
+
+    config.autoload_paths += paths['lib'].to_a
+    config.autoload_once_paths += paths['lib'].to_a
+
+    config.app_middleware.use "Scrivito::EditingContextMiddleware"
+    config.app_middleware.use "Scrivito::CacheMiddleware"
+    config.app_middleware.use "Scrivito::WorkspaceSelectionMiddleware"
+  end
+end
+

data/lib/scrivito/errors.rb

@@ -0,0 +1,11 @@
+module Scrivito
+
+# @api public
+class ScrivitoError < StandardError
+end
+
+# @api public
+class ResourceNotFound < ScrivitoError
+end
+
+end # module Scrivito

data/lib/scrivito/html_string.rb

@@ -0,0 +1,18 @@
+module Scrivito
+
+  # Include this module in order to tag the string as one with HTML content
+  module HtmlString
+    # Returns whether the String contains HTML (default to true, overrides String.html?).
+    def html?
+      true
+    end
+  end
+
+end
+
+class String
+  # Returns whether the String contains HTML (default to false).
+  def html?
+    false
+  end
+end

data/lib/scrivito/link.rb

@@ -0,0 +1,187 @@
+module Scrivito
+  # This class provides an interfaces for handling CMS Links.
+  # To format a link for rendering in an html page, use the +cms_path+ or +cms_url+ methods.
+  # @api public
+  class Link
+
+    extend ActiveModel::Naming
+
+    # Parses a url and returns a {Link} object. Determines internal urls based on the given
+    # +hostname+ and +port+.
+    # @api public
+    # @param [String] url
+    # @param host [String] the hostname of internal urls
+    # @param port [String] the port of internal urls
+    def self.parse(url, host, port)
+      LinkParser.new(host, port).parse(url)
+    end
+
+    # Create a new link obj
+    # @api public
+    # @param [Hash] link_data
+    # @option link_data [String] url
+    # @option link_data [Obj] obj
+    # @option link_data [String] title
+    # @option link_data [String] query
+    # @option link_data [String] target
+    # @option link_data [String] fragment
+    def initialize(link_data)
+      @link_data = link_data.with_indifferent_access
+    end
+
+    # The link's external url. Only available for external links.
+    # Warning: Do not output the url directly unless you know what you are doing.
+    # Normally you want to use the +cms_path+ or +cms_url+ methods to format a link.
+    # @api public
+    def url
+      @link_data[:url]
+    end
+
+    # Set the link's external url. This will lead to an external link.
+    # @api public
+    # @param value [String] the url of the link
+    def url=(value)
+      @link_data[:url] = value
+    end
+
+    # Returns the {BasicObj Obj} this link is referencing. May be nil if the
+    # link is external.
+    # @api public
+    def obj
+      @link_data[:obj]
+    end
+
+    # Set the {BasicObj Obj} this link is referencing. May be nil if the
+    # link is external.
+    # @api public
+    # @param value [Obj] the obj this link should be referencing
+    def obj=(value)
+      @link_data[:obj] = value
+    end
+
+    # The link's title.
+    # @api public
+    def title
+      @link_data[:title]
+    end
+
+    # Set the link's title.
+    # @api public
+    # @param value [String] the link's title
+    def title=(value)
+      @link_data[:title] = value
+    end
+
+    # Returns the link's query string as in "index.html?query_string".
+    # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
+    def query
+      @link_data[:query]
+    end
+
+    # Set the link's query string as in "index.html?query_string".
+    # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
+    # @param value [String] the query string of the link
+    def query=(value)
+      @link_data[:query] = value
+    end
+
+    # Returns the link's anchor as in "index.html#anchor".
+    # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
+    def fragment
+      @link_data[:fragment]
+    end
+
+    # Set the link's anchor as in "index.html#anchor".
+    # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
+    # @param value [String] the anchor or fragement of the link
+    def fragment=(value)
+      @link_data[:fragment] = value
+    end
+
+    def target
+      @link_data[:target]
+    end
+
+    def target=(value)
+      @link_data[:target] = value
+    end
+
+    # Returns the file extension (e.g. zip, pdf) of this link's (internal or external) target.
+    # Returns an empty string if the file extension is can not be determined.
+    # @api public
+    def file_extension
+      if internal?
+        obj ? obj.file_extension : ""
+      else
+        path = URI.parse(url).path rescue nil
+        path.blank? ? "" : File.extname(path)[1..-1] || ""
+      end
+    end
+
+    # Returns the title of this Link if it is set.
+    # Otherwise it returns the display_title of the destination object for internal Links
+    # or the URL for external Links.
+    # @api public
+    def display_title
+      dt = title
+      dt = obj.display_title if dt.blank? && !external?
+      dt = url if dt.blank?
+      dt
+    end
+
+    # Returns true this Link links to a CMS Object.
+    # @api public
+    def internal?
+      url.nil?
+    end
+
+    # Returns true if this Link links to an external URL.
+    # @api public
+    def external?
+      !internal?
+    end
+
+    def resolved?
+      external? || !obj.nil?
+    end
+
+    def query_and_fragment
+      str = ''
+      str << "?#{query}" if query.present?
+      str << "##{fragment}" if fragment.present?
+      str
+    end
+
+    def internal_url
+      "objid:#{obj.id}"
+    end
+
+    def to_cms_api_html_url
+      if internal?
+        "#{internal_url}#{query_and_fragment}"
+      else
+        url
+      end
+    end
+
+    def to_cms_api_linklist_params
+      params = {}
+
+      if internal?
+        params[:obj_id] = obj.id
+        params[:title] = title if title
+        params[:query] = query if query
+        params[:fragment] = fragment if fragment
+      else
+        params[:url] = url
+        params[:title] = title if title
+      end
+
+      params
+    end
+  end
+end