infopark_fiona_connector 7.0.1.5.2.3.rc7

data/lib/rails_connector/cms_test_request.rb

@@ -0,0 +1,8 @@
+module RailsConnector
+  module CmsTestRequest
+    def for_cms_object(test_obj = nil)
+      # prepare the env as if the given obj was loaded by CmsEnv
+      env[RailsConnector::CmsEnv::OBJ_ENV_KEY] = test_obj if test_obj
+    end
+  end
+end

data/lib/rails_connector/configuration.rb

@@ -0,0 +1,174 @@
+require "helpful_configuration"
+require "rails_connector/cms_base_model"
+require "rails_connector/blob"
+
+module RailsConnector
+  # @api public
+  class Configuration
+    # @api public
+    DEFAULT_MODE = :live
+
+    class << self
+      # there are three available modes for the rails connector:
+      # <tt>live</tt> (show released contents only),
+      # <tt>preview</tt> (show edited contents)
+      # <tt>editor</tt> (show edited contents and editor interface (e.g. edit markers))
+      # Default mode is <tt>live</tt>.
+      # @api public
+      attr_accessor :blob_cache_dir, :choose_homepage_callback
+
+      # default options for {SearchRequest}
+      # @api public
+      attr_writer :search_options
+
+      # default options for {SearchRequest}
+      # @api public
+      def search_options
+        @search_options || local_config_file["search"].symbolize_keys
+      end
+
+      # define a non-default blob cache dir.
+      # +fiona connector+ only. has no effect when used with the +cloud connector+.
+      # @api public
+
+      # @api public
+      def mode=(new_mode)
+        new_mode = new_mode.to_sym
+        raise ArgumentError, "Unknown Mode #{new_mode}" unless %i(editor preview live).include?(new_mode)
+
+        @mode = new_mode
+      end
+
+      # there are three available modes for the rails connector:
+      # <tt>live</tt> (show released contents only),
+      # <tt>preview</tt> (show edited contents)
+      # <tt>editor</tt> (show edited contents and editor interface (e.g. edit markers))
+      # Default mode is <tt>live</tt>.
+      # @api public
+      def mode
+        @mode || DEFAULT_MODE
+      end
+
+      def editor_interface_enabled?
+        mode == :editor
+      end
+
+      def use_edited_content?
+        mode == :preview || mode == :editor
+      end
+
+      # Configures your CMS instance name.
+      #
+      # Example call as to be used in <tt>rails_connector.rb</tt>:
+      #   RailsConnector::Configuration.instance_name = 'internet'
+      # @api public
+      def instance_name=(name)
+        RailsConnector::CmsBaseModel.instance_name = name if RailsConnector.platform_fiona?
+      end
+
+      def after_initialize
+        enable_ses
+        enable_authentication
+        ::RailsConnector::BasicObj.configure_for_content(
+          ::RailsConnector::Configuration.use_edited_content? ? :edited : :released
+        )
+      end
+
+      def to_prepare
+        BasicObj.reset_reflections
+
+        unless Rails.configuration.cache_classes
+          after_initialize
+          NamedLink.reset_cache
+          BasicObj.reset_type_cache
+          ::ApplicationController.__send__(:helper, :cms)
+        end
+      end
+
+      def configure_cms_database
+        RailsConnector::CmsBaseModel.configure_database(:cms)
+      end
+
+      # Configure a callback to be invoked when the rails connector delivers the homepage.
+      # The given callback will receive the rack env
+      # and must return an Obj to be used as the homepage.
+      # If no callback is configured, Obj.homepage will be used as the default.
+      # @api public
+      def choose_homepage(&block)
+        self.choose_homepage_callback = block
+      end
+
+      def cms_routes(*_args)
+        raise <<-EOS.gsub(/\s+/, " ")
+        Calling RailsConnector::Configuration.cms_routes is not needed anymore.
+        Please remove it from config/routes.rb
+        EOS
+      end
+
+      def use_x_sendfile=(_value)
+        raise "Configuration.use_x_sendfile is now available as Rails configuration:"\
+              ' config.action_dispatch.x_sendfile_header = "X-Sendfile"'
+      end
+
+      def local_config_file
+        @local_config_file ||= read_local_config_file
+      end
+
+      def local_config_file_name
+        (Rails.root + "config/rails_connector.yml").expand_path
+      end
+
+      # for test purposes only
+      def reset_local_config_file_cache
+        @local_config_file = nil
+      end
+
+      protected
+
+      def enable_authentication
+        ::ApplicationController.include RailsConnector::Authenticable
+      end
+
+      def read_local_config_file
+        contents = YAML.load_file(local_config_file_name) if File.exist?(local_config_file_name)
+        contents ||= {}
+
+        config = HelpfulConfiguration.new(
+          contents,
+          local_config_file_name
+        )
+        config.explain(
+          "cms_database",
+          "a hash of options, including type, that specify the database configuration"
+        )
+        config.explain(
+          "cms_blob_storage",
+          "a hash of options, including type, that specify the cms blob storage configuration"
+        )
+        config.explain(
+          "cms_dict_storage",
+          "a hash of options, including type, that specify the cms dict storage configuration"
+        )
+        config.explain(
+          "search",
+          "a hash of options that specify access to the search server"
+        )
+        config.explain(
+          "cms_api",
+          "a hash of options that specify access to the cms api"
+        )
+        config.explain "content_service", "a hash of options that specify access to content service"
+        config
+      end
+
+      def enable_ses
+        require "rails_connector/ses"
+
+        RailsConnector::SES.enable
+      end
+    end
+  end
+
+  class ConfigurationError < StandardError
+  end
+end

data/lib/rails_connector/content.rb

@@ -0,0 +1,7 @@
+module RailsConnector
+  # This class allows us to read out the editor of an Obj,
+  # if it has edited content
+  class Content < CmsBaseModel
+    self.primary_key = :content_id
+  end
+end

data/lib/rails_connector/core_extensions.rb

@@ -0,0 +1 @@
+require "rails_connector/core_extensions/time"

data/lib/rails_connector/core_extensions/time.rb

@@ -0,0 +1,17 @@
+class Time
+  # Returns a new Time created from the ISO date format String "YYYYMMDDhhmmss"
+  def self.from_iso(t)
+    return nil unless t
+
+    if t.to_s =~ /^(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/
+      utc(Regexp.last_match(1).to_i, Regexp.last_match(2).to_i, Regexp.last_match(3).to_i, Regexp.last_match(4).to_i, Regexp.last_match(5).to_i, Regexp.last_match(6).to_i)
+    else
+      raise ArgumentError, "invalid iso time format: #{t}"
+    end
+  end
+
+  # Returns the Time as ISO date format String "YYYYMMDDhhmmss"
+  def to_iso
+    getutc.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/rails_connector/date_attribute.rb

@@ -0,0 +1,26 @@
+module RailsConnector
+  # Adds support for string columns which contain ISO dates
+  module DateAttribute
+    module ClassMethods
+      def date_attribute(*names)
+        names.each do |name|
+          module_eval %!
+            def #{name}
+              DateAttribute.parse(#{name}_before_type_cast) unless #{name}_before_type_cast.nil?
+            end
+          !
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def self.parse(iso_date_time)
+      Time.from_iso(iso_date_time).in_time_zone
+    rescue ArgumentError
+      raise "The value is not a valid ISO date time: #{iso_date_time.inspect}"
+    end
+  end
+end

data/lib/rails_connector/default_search_request.rb

@@ -0,0 +1,6 @@
+module RailsConnector
+  # This class provides a default implementation for accessing the search server.
+  # It is used by {DefaultSearchController}.
+  class DefaultSearchRequest < VeritySearchRequest
+  end
+end

data/lib/rails_connector/engine.rb

@@ -0,0 +1,65 @@
+require "rails"
+require "active_record/railtie"
+require "action_view"
+
+require "jquery-rails"
+
+require "rails_connector/configuration"
+
+module ::RailsConnector
+  class Engine < Rails::Engine
+    config.to_prepare { RailsConnector::Configuration.to_prepare }
+    config.after_initialize { RailsConnector::Configuration.after_initialize }
+
+    # make sure our exceptions cause an adequate error page and http status code
+    config.action_dispatch.rescue_responses["RailsConnector::ResourceNotFound"] = :not_found
+
+    initializer "rails_connector.add_fiona_time_type" do
+      ActiveRecord::Type.register(:fiona_datetime, ::FionaDateTime)
+    end
+
+    initializer "rails_connector.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
+
+    initializer "rails_connector.add_assets" do |app|
+      app.config.assets.precompile += %w(
+        editmarker.css editmarker.js
+      )
+    end
+
+    # Expose rails connector runtime to controller for logging.
+    initializer "rails_connector.log_runtime" do |_app|
+      runtime =
+        begin
+          RailsConnector::ControllerRuntime
+        rescue NameError
+          nil
+        end
+
+      if runtime
+        RailsConnector::LogSubscriber.attach_to :rails_connector
+        ActiveSupport.on_load(:action_controller) do
+          include runtime
+        end
+      end
+    end
+
+    initializer "rails_connector.configure_database", before: :load_config_initializers do |_app|
+      RailsConnector::Configuration.configure_cms_database
+    end
+
+    initializer "rails_connector.routing_helpers" do
+      ActionDispatch::TestRequest.include RailsConnector::CmsTestRequest if Rails.env == "test"
+
+      ActionController::Base.include CmsRoutingHelper
+      ActionView::Base.include CmsRoutingHelper
+    end
+
+    config.autoload_paths += paths["lib"].to_a
+    config.autoload_once_paths += paths["lib"].to_a
+
+    RailsConnector.rack_middlewares.each { |middleware| config.app_middleware.use middleware }
+  end
+end

data/lib/rails_connector/errors.rb

@@ -0,0 +1,6 @@
+require "active_record/errors"
+
+module RailsConnector
+  # @api public
+  ResourceNotFound = ActiveRecord::RecordNotFound
+end # module RailsConnector

data/lib/rails_connector/fiona_datetime.rb

@@ -0,0 +1,14 @@
+require "active_record/type"
+class FionaDateTime < ActiveRecord::Type::Time
+  def type
+    :fiona_datetime
+  end
+
+  def serialize(value)
+    value&.to_iso
+  end
+
+  def deserialize(value)
+    Time.from_iso(value).in_time_zone if value
+  end
+end

data/lib/rails_connector/fiona_engine.rb

@@ -0,0 +1,8 @@
+module ::RailsConnector
+  class FionaEngine < Rails::Engine
+    initializer "rails_connector.config_local", after: :load_config_initializers,
+                                                before: :engines_blank_point do
+      Dir[Rails.root + "config/local/*.rb"].map(&method(:require))
+    end
+  end
+end

data/lib/rails_connector/html_string.rb

@@ -0,0 +1,17 @@
+module RailsConnector
+  # Include this module in order to tag the string as one with HTML content
+  module HtmlString
+    include LinkResolvable
+    # 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/rails_connector/job.rb

@@ -0,0 +1,10 @@
+module RailsConnector
+  # This class allows us to read out basic information about jobs
+  class Job < CmsBaseModel
+    self.primary_key = "job_id"
+
+    def self.table_name
+      "#{table_name_prefix}" "jobs"
+    end
+  end
+end

data/lib/rails_connector/link.rb

@@ -0,0 +1,148 @@
+module RailsConnector
+  # 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
+
+    def initialize(link_data, destination_object = nil)
+      @link_data = link_data.symbolize_keys
+      @destination_object = destination_object
+    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
+
+    # The link's title.
+    # @api public
+    def title
+      @link_data[:title]
+    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[:search]
+    end
+
+    # Deprecated: use Link#query instead.
+    # 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 search
+      query
+    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
+
+    # Returns the browser window or browser frame to be used as a target for this link.
+    # Example: Links that should be opened in a new window will return "_blank" as their target.
+    # @api public
+    def target
+      @link_data[:target]
+    end
+
+    def id
+      @link_data[:link_id]
+    end
+
+    def tag_name
+      @link_data[:tag_name]
+    end
+
+    def markdown_type
+      @link_data[:markdown_type]
+    end
+
+    def markdown?
+      "markdown" == @link_data[:source_format]
+    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?
+        destination_object ? destination_object.file_extension : ""
+      else
+        path = begin
+                 URI.parse(url).path
+               rescue StandardError
+                 nil
+               end
+        path.blank? ? "" : File.extname(path)[1..-1] || ""
+      end
+    end
+
+    # Returns the id of the Links' destination_object.
+    # @api public
+    def destination_object_id
+      destination
+    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 = destination_object.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
+
+    # An internal Link is active if it's destination object is active.
+    # An external Link is always active.
+    # @api public
+    def active?
+      external? || destination_object&.active?
+    end
+
+    def external_prefix?
+      url =~ /\s?external:/
+    end
+
+    def resolved?
+      external? || resolved_internal?
+    end
+
+    # Returns the destination object (+Obj+) of this Link.
+    # @api public
+    def destination_object
+      @destination_object ||= Obj.find(destination) if resolved_internal?
+    end
+
+    private
+
+    def resolved_internal?
+      internal? && !destination.nil?
+    end
+
+    def destination
+      @link_data[:destination]
+    end
+  end
+end