infopark_rails_connector 6.8.0.beta.200.621.4c8e1b0

data/lib/rails_connector/configuration.rb

@@ -0,0 +1,235 @@
+require "helpful_configuration"
+
+require "rails_connector/cms_base_model"
+require "rails_connector/blob"
+
+module RailsConnector
+
+  # RailsConnector::Configuration is used to en/disable and initialize addons.
+  class Configuration
+    DEFAULT_MODE = :live
+
+    #
+    # Default fields which the +DefaultUserController+ will store in the session.
+    #
+    DEFAULT_STORE_USER_ATTRS_IN_SESSION = [:login, :first_name, :last_name, :email, :id]
+
+    @features = {}
+
+    class << self
+      # Automatically generate editmarkers when rendering liquid templates in editor mode.
+      attr_accessor :auto_liquid_editmarkers
+
+      # 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>.
+      attr_accessor :mode
+
+      # default options for SearchRequest
+      attr_writer :search_options
+
+      def search_options
+        @search_options || local_config_file["search"].symbolize_keys
+      end
+
+      def mode=(new_mode) #:nodoc:#
+        new_mode = new_mode.to_sym
+        raise ArgumentError, "Unknown Mode #{new_mode}" unless [:editor, :preview, :live].include?(new_mode)
+        @mode = new_mode
+      end
+
+      def mode #:nodoc:#
+        @mode || DEFAULT_MODE
+      end
+
+      #
+      # Sets the array of fields which the +DefaultUserController+ will store in the session.
+      # Defaults to +DEFAULT_STORE_USER_ATTRS_IN_SESSION+.
+      #
+      attr_writer :store_user_attrs_in_session
+
+      #
+      # Returns fields which the +DefaultUserController+ stores in the session.
+      #
+      def store_user_attrs_in_session
+        @store_user_attrs_in_session || DEFAULT_STORE_USER_ATTRS_IN_SESSION
+      end
+
+      def editor_interface_enabled? #:nodoc:#
+        mode == :editor
+      end
+
+      def use_edited_content? #:nodoc:#
+        mode == :preview || mode == :editor
+      end
+
+      def register_features(*features) #:nodoc:
+        features.each do |f|
+          @features.merge!(f.to_sym => false)
+        end
+      end
+      alias :register_feature :register_features
+
+      def registered_features #:nodoc:
+        @features.keys
+      end
+
+      # Rails Connector Addons can be enabled as follows (in <tt>config/rails_connector.rb</tt>):
+      #
+      #   RailsConnector::Configuration.enable(
+      #     :search,
+      #     :time_machine,
+      #     :pdf_generator,
+      #     :crm
+      #   )
+      #
+      def enable(*features)
+        features.each do |f|
+          assert_feature_is_known(f)
+          @features[f.to_sym] = true
+        end
+        initialize_addon_mixins
+      end
+
+      # Returns true if +feature+ is enabled, else false.
+      def enabled?(feature)
+        assert_feature_is_known(feature)
+        @features[feature.to_sym] == true
+      end
+
+      # Configures your CMS instance name.
+      #
+      # Example call as to be used in <tt>rails_connector.rb</tt>:
+      #   RailsConnector::Configuration.instance_name = 'internet'
+      def instance_name=(name)
+        RailsConnector::CmsBaseModel.instance_name = name
+      end
+
+      def after_initialize #:nodoc:
+        enable_authentication
+        # Hier muss explizit der Namespace verwendet werden, da diese Methode von Rails
+        # während der Initialisierung aufgerufen wird.
+        ::RailsConnector::Obj.configure_for_content(
+          ::RailsConnector::Configuration.use_edited_content? ? :edited : :released
+        )
+      end
+
+      def to_prepare #:nodoc:
+        unless Rails.configuration.cache_classes
+          after_initialize
+          NamedLink.reset_cache
+          initialize_addon_mixins
+        end
+      end
+
+      def configure_cms_database
+        if RailsConnector::CmsBaseModel.superclass.to_s == "ActiveRecord::Base"
+          CmsBaseModel.configure_database("cms")
+        else
+          CmsBaseModel.configure_database(local_config_file["cms_database"])
+          Blob.configure(local_config_file["cms_blob_storage"])
+        end
+      end
+
+      def license #:nodoc:
+        license_file.read
+      end
+
+      def license_file #:nodoc:
+        @license_file.presence || Rails.root + "config" + "license.xml"
+      end
+
+      def license_file=(license_file) #:nodoc:
+        @license_file = license_file.presence && Pathname(license_file)
+      end
+
+      def cms_routes(*args) #:nodoc:
+        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) #:nodoc:
+        raise 'Configuration.use_x_sendfile is now available as Rails configuration:'\
+              ' config.action_dispatch.x_sendfile_header = "X-Sendfile"'
+      end
+
+      def initialize_addon_mixins #:nodoc:
+        ::ApplicationController.__send__(:helper, :cms)
+        if enabled?(:search)
+          require "rails_connector/ses"
+          RailsConnector::SES.enable
+        end
+        RailsConnector::Crm.enable if enabled?(:crm)
+        ::Obj.__send__(:include, RailsConnector::Syndicateable) if enabled?(:rss)
+        ::Obj.__send__(:include, RailsConnector::Commentable) if enabled?(:comments)
+        ::Obj.__send__(:include, RailsConnector::Rateable) if enabled?(:ratings)
+      end
+
+      def local_config_file #:nodoc:
+        @local_config_file ||= read_local_config_file
+      end
+
+      def local_config_file_name #:nodoc:
+        (Rails.root + "config/rails_connector.yml").expand_path
+      end
+
+      # for test purposes only
+      def reset_local_config_file_cache #:nodoc:
+        @local_config_file = nil
+      end
+
+      protected
+
+      def read_local_config_file
+        contents = YAML.load_file(local_config_file_name) if File.exists?(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(
+          "search",
+          "a hash of options that specify access to the search server"
+        )
+
+        config
+      end
+
+      def assert_feature_is_known(f) #:nodoc:
+        raise ArgumentError, "unknown feature: #{f.inspect}" unless @features.keys.include?(f.to_sym)
+      end
+
+      def enable_authentication #:nodoc:
+        # Wenn das OMC-Features an ist, dann braucht man keine Standardimplementierung
+        # für die Authentifizierung.
+        unless enabled?(:crm)
+          ::ApplicationController.__send__(:include, RailsConnector::Authenticable)
+        end
+      end
+    end
+
+    # defaults
+    self.auto_liquid_editmarkers = true
+
+    register_features(
+      :search, :time_machine, :pdf_generator, :rss, :comments, :ratings,
+      :crm, :seo_sitemap, :google_analytics
+    )
+  end
+
+  class ConfigurationError < StandardError # :nodoc:
+  end
+end

data/lib/rails_connector/core_extensions/time.rb

@@ -0,0 +1,18 @@
+class Time #:nodoc:
+
+  # 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($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $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/core_extensions.rb

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

data/lib/rails_connector/crm.rb

@@ -0,0 +1,282 @@
+module RailsConnector
+
+  # This module provides high-level access to the Infopark Online Marketing Cockpit.
+  #
+  # Methods from the +AuthenticationSupport+ module are included
+  # in all controllers when enabling the Crm feature in your RailsConnector configuration:
+  #
+  #   RailsConnector::Configuration.enable(
+  #     :crm
+  #   )
+  module Crm
+
+    # This method requires the omc_connector gem.
+    #
+    # If the gem is available, it does the following:
+    #  * require it
+    #  * include +AuthenticationSupport+ in +ApplicationController+
+    #  * declares helper methods in +ApplicationController+
+    #  * adds a class-inheritable array to +ApplicationController+ for convenience
+    #    (see +session_attributes_for+)
+    #
+    # If not, it raises a +LoadError+.
+    def self.enable #:nodoc:
+      require 'infopark_crm_connector'
+      ApplicationController.__send__(:include, AuthenticationSupport)
+    end
+
+    module AuthenticationSupport
+
+      protected
+
+      def self.included(base) # :nodoc:
+        base.helper_method :logged_in?, :current_user, :admin?
+      end
+
+      #
+      # Returns a hash of attributes for the given user that are to be stored in the session.
+      #
+      # Uses the array +RailsConnector::Configuration.store_user_attrs_in_session+ to determine which
+      # fields to store.
+      # Because the field <tt>:id</tt> must always be stored in the session, it is always in the array
+      # returned by +session_attributes_for+, independent on the fields specified by
+      # +RailsConnector::Configuration.store_user_attrs_in_session+.
+      #
+      # User live_server_groups are stored in the session by default.
+      #
+      def session_attributes_for(user) # :nodoc:
+        attributes = {}
+        serialized_attributes = \
+            user.attributes.merge(:live_server_groups => user.live_server_groups).symbolize_keys
+        (RailsConnector::Configuration.store_user_attrs_in_session + [:id]).each do |attr|
+          attributes[attr.to_sym] = serialized_attributes[attr.to_sym]
+        end
+        attributes[:live_server_groups] = serialized_attributes[:live_server_groups]
+        attributes
+      end
+
+      # Determines if the user is logged in.
+      # Defined as helper method in +ApplicationController+ when enabling the Crm feature.
+      def logged_in?
+        !session[:user].blank?
+      end
+
+      #
+      # Returns a +Contact+ object with attributes stored in the session.
+      #
+      # To change which fields +DefaultUserController+ stores in the session use
+      # +RailsConnector::Configuration.store_user_attrs_in_session+.
+      #
+      def current_user
+        @current_user ||= if logged_in?
+          user_session = session[:user].dup
+          live_server_groups = user_session.delete(:live_server_groups)
+          user = Infopark::Crm::Contact.new(user_session || {})
+          user.live_server_groups = live_server_groups
+          user
+        end
+      end
+
+      # Takes a +Contact+ object and stores its user attributes in the session.
+      #
+      # This can be helpful if you want to set a user for e.g. Googlebot.
+      def current_user=(user)
+        @current_user = user
+        session[:user] = user.nil? ? nil : session_attributes_for(user)
+      end
+
+      # Reloads the +Contact+ object in +current_user+ from the WebCRM,
+      # and updates the user attribute cached in the session.
+      def reload_current_user
+        user = current_user
+        user.reload
+        self.current_user = user
+      end
+
+      # Determines if the current user is admin (+false+ by default).
+      # Being admin eables to user to delete comments and reset ratings.
+      # Defined as helper method in +ApplicationController+ when enabling the CRM feature.
+      #
+      # To change the default behavior overwride <tt>admin?</tt> in your ApplicationController.
+      #
+      #   class ApplicationController < ActionController::Base
+      #
+      #     private
+      #
+      #     def admin?
+      #       logged_in? && current_user.live_server_groups.include?("admins")
+      #     end
+      #
+      #   end
+      def admin?
+        false
+      end
+
+    end
+
+    # :stopdoc:
+    module Localizable
+      # --------------------------------------------
+      # This module can be included in controllers
+      # that interface the WebCRM so error messages
+      # are localized
+      # --------------------------------------------
+      def self.included(base)
+        base.before_filter :set_crm_language
+      end
+
+      private
+
+      def set_crm_language
+        Infopark::Crm.configure {|config| config.locale = I18n.locale.to_s }
+      end
+    end
+    # :startdoc:
+
+    # :stopdoc:
+    module Sanitization
+      # --------------------------------------------
+      # This module is included in controllers to
+      # sanitize user input, in reference to a given
+      # whitelist
+      # --------------------------------------------
+
+      private
+
+      def sanitize_user_params(user_params_or_nil, whitelist)
+        user_params = user_params_or_nil || {}
+
+        filtered_contact_attrs = filter_params_hash(
+          user_params, whitelist[:contact]
+        )
+
+        filtered_contact_attrs
+      end
+
+      def filter_params_hash(source_hash, allowed_keys_unstringified)
+        return {} unless source_hash
+        allowed_keys = allowed_keys_unstringified.map(&:to_s)
+        source_hash.reject { |key, value| !allowed_keys.include?(key) }
+      end
+    end
+    # :startdoc:
+
+    # This module is included in +DefaultUserController+ to provide callbacks for user functionality.
+    #
+    # If you want to add behavior before or after authentication, logout or register, override any of
+    # the methods included in this module in your +UserController+.
+    module Callbacks
+
+      # :stopdoc:
+      # --------------------------------------------
+      # This module is documented in sections
+      # because RDoc orders methods alphabetically,
+      # which doesn't make sense here.
+      # --------------------------------------------
+      # :startdoc:
+
+      private
+
+      # :section: "Before" callbacks
+
+      # Called by +DefaultUserController+ on POST requests before a user is authenticated,
+      # i.e. the user has already provided credentials in a form.
+      #
+      # By default, it doesn't do anything.
+      def before_authenticate
+      end
+
+      # Called by +DefaultUserController+ before a user is logged out,
+      # i.e. the session is reset.
+      #
+      # By default, it doesn't do anything.
+      def before_logout
+      end
+
+      # Called by +DefaultUserController+ on POST requests before a user is created,
+      # i.e. the user has already provided name, e-mail etc. in a form.
+      #
+      # By default, it doesn't do anything.
+      def before_register
+      end
+
+      # :section: "After" callbacks
+
+      # Called by +DefaultUserController+ on POST requests after a user is authenticated,
+      # i.e. the user has already provided correct credentials but the session has not yet been set.
+      #
+      # By default, it doesn't do anything.
+      def after_authenticate
+      end
+
+      # Called by +DefaultUserController+ after a user is logged out,
+      # i.e. the session is reset.
+      #
+      # By default, it doesn't do anything.
+      def after_logout
+      end
+
+      # Called by +DefaultUserController+ on POST requests after a user is created,
+      # i.e. a WebCRM activity has been created or the user has been created directly in the WebCRM.
+      #
+      # By default, it doesn't do anything.
+      def after_register
+      end
+
+      # :section: WebCRM error handling
+
+      # Called by +DefaultUserController+ whenever requests to the WebCRM fail.
+      # This includes <tt>Errno::ECONNREFUSED</tt> or the ActiveResource errors +ForbiddenAccess+,
+      # +UnauthorizedAccess+, and +BadRequest+.
+      #
+      # By default, it raises an error so that administrators are notified immediately
+      # if the WebCRM is down or not configured properly.
+      def on_crm_error(exception)
+        raise exception
+      end
+
+    end
+
+    # :stopdoc:
+    # Default attributes for WebCRM's Contact.
+    #
+    # Helpers like +form_for+ will fail on +ActiveResource+ attributes
+    # until those attributes are set.
+    # See http://www.ruby-forum.com/topic/113542
+    #
+    # This constant provides default values for nearly all attributes.
+    #
+    # You are free to use any of these attributes in your views.
+    # If you try to use others, +form_for+ will fail.
+    CONTACT_DEFAULT_ATTRS = {
+      :id => '',
+      :account_id => '',
+      :org_name_address => '',
+      :org_unit_address => '',
+      :extended_address => '',
+      :street_address => '',
+      :postalcode => '',
+      :locality => '',
+      :region => '',
+      :country => '',
+      :email => '',
+      :fax => '',
+      :first_name => '',
+      :gender => 'N',
+      :job_title => '',
+      :language => 'en',
+      :last_name => '',
+      :login => '',
+      :mobile_phone => '',
+      :name_prefix => '',
+      :phone => '',
+      :want_geo_location => '',
+      :want_email => 0,
+      :want_phonecall => 0,
+      :want_snailmail => 0
+    }.stringify_keys
+    # :startdoc:
+
+  end
+
+end

data/lib/rails_connector/engine.rb

@@ -0,0 +1,78 @@
+require "rails"
+require "action_view"
+require "will_paginate"
+
+require 'jquery-rails'
+
+require 'rails_connector/configuration'
+
+module ::RailsConnector
+  class Engine < Rails::Engine #:nodoc:
+    config.to_prepare { RailsConnector::Configuration.to_prepare }
+    config.after_initialize { RailsConnector::Configuration.after_initialize }
+
+    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
+
+    # 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
+
+    # make sure our exceptions cause an adequate error page and http status code
+    initializer "rails_connector.register_exceptions" do |app|
+      responses = ActionDispatch::ShowExceptions.rescue_responses
+      responses["RailsConnector::ResourceNotFound"] = :not_found
+    end
+
+    initializer "rails_connector.configure_database" do |app|
+      RailsConnector::Configuration.configure_cms_database
+    end
+
+    initializer "rails_connector.liquid_support" do
+      # Liquid Gem integration
+      ActionView::Template.register_template_handler(
+        :liquid, ::RailsConnector::LiquidSupport::LiquidTemplateHandler
+      )
+      if Rails.env.test? && ::RailsConnector::LiquidSupport.raise_template_errors == nil
+        ::RailsConnector::LiquidSupport.raise_template_errors = true
+      end
+    end
+
+    initializer "rails_connector.routing_helpers" do
+      if Rails.env == 'test'
+        ActionDispatch::TestRequest.__send__(:include, RailsConnector::CmsTestRequest)
+      end
+
+      ActionController::Base.__send__(:include, CmsRoutingHelper)
+      ActionView::Base.__send__(:include, CmsRoutingHelper)
+    end
+
+    initializer "rails_connector.config_local", :after => :load_config_initializers,
+        :before => :engines_blank_point do
+      Dir.glob(Rails.root.join('config', 'local', '*.rb')).each do |file|
+        require file
+      end
+    end
+
+    config.autoload_paths += paths['lib'].to_a
+    config.autoload_once_paths += paths['app/helpers'].to_a + paths['lib'].to_a
+
+    RailsConnector.rack_middlewares.each { |middleware| config.app_middleware.use middleware }
+  end
+end
+

data/lib/rails_connector/fop.rb

@@ -0,0 +1,18 @@
+module RailsConnector
+  module Fop
+    #
+    # Is raised if the PDF generation fails.
+    # The error message contains the Java error stack trace of the Apache FOP.
+    #
+    class GenerationFailed < RuntimeError; end
+
+    CMD = 'fop -xml "%s" -xsl "%s" -pdf "%s" 2>&1' # :nodoc:
+
+    def self.generate_pdf(xml, xsl, pdf) # :nodoc:
+      output = `#{CMD % [xml, xsl, pdf]}`
+      unless `file -pb "#{pdf}"`.include?('PDF')
+        raise GenerationFailed, output
+      end
+    end
+  end
+end

data/lib/rails_connector/fop_on_rails/document/dom_tree.rb

@@ -0,0 +1,42 @@
+require 'tidy'
+require "rexml/document"
+
+module RailsConnector
+  module FopOnRails
+    module Document # :nodoc: all
+      module DomTree
+        TIDY_CONF = {
+          'clean' => true,
+          'doctype' => 'omit',
+          'output-xhtml' => true,
+          'numeric-entities' => true,
+          'drop-font-tags' => true,
+          'enclose-block-text' => true,
+          'char-encoding' => 'utf8'
+        }
+
+        def self.repair(data)
+          xml = REXML::Document.new(tidy(data))
+          clean_namespace(xml)
+          return xml
+        end
+
+        private
+
+        def self.tidy(data)
+          %w(dylib so).each do |ext|
+            if File.exist?(path = "/usr/lib/libtidy.#{ext}")
+              Tidy.path = path
+              break
+            end
+          end
+          Tidy.open(TIDY_CONF) { |tidy| tidy.clean(data) }
+        end
+
+        def self.clean_namespace(xml)
+          xml.root.delete_namespace
+        end
+      end
+    end
+  end
+end