infopark_fiona_connector 7.0.1.5.2.3.rc8

data/lib/rails_connector/news.rb

@@ -0,0 +1,20 @@
+module RailsConnector
+  # The CMS news object
+  #
+  # This class models the join table between channels and objects.
+  # Instances of this class also hold information about validity range.
+  # @api public
+  class News < CmsBaseModel
+    self.primary_key = "news_id"
+
+    belongs_to :object, class_name: "Obj", foreign_key: "object_id"
+
+    def self.table_name
+      "#{table_name_prefix}" "news"
+    end
+
+    scope :active, -> { where("? BETWEEN valid_from AND valid_until", Time.now.to_s(:number)) }
+
+    scope :for_channel, ->(channel_name) { where(channel_name: channel_name) }
+  end
+end

data/lib/rails_connector/obj_class.rb

@@ -0,0 +1,138 @@
+module RailsConnector
+  # This class is used to read out the custom attributes,
+  # mandatory attributes and titles of an Obj.
+  # Warning: Dependent on the setup of your DB replication, most tables
+  # with meta information will not be available on your live system!
+  class ObjClass < CmsBaseModel
+    self.primary_key = :obj_class_id
+
+    has_many :custom_attributes_jt, class_name: "::RailsConnector::ObjClassAttr", foreign_key: "obj_class_id", primary_key: "obj_class_id"
+    has_many :custom_attributes_raw, through: :custom_attributes_jt, source: :custom_attributes_raw
+
+    alias_attribute :name, :obj_class_name
+    alias_attribute :type, :obj_type
+
+    attribute :is_enabled, :boolean
+    alias_attribute :enabled, :is_enabled
+
+    %w(attributeGroupNames attributeGroups canCreateNewsItems completionCheck
+       contentTypes createPermission workflowModification validSubObjClasses
+       validSubObjClassCheck
+       validContentTypes titles recordSetCallback presetFromParentAttributes
+       presetAttributes).each do |key|
+      define_method(key.underscore) do
+        load_blob_data
+        @blob_data[key]
+      end
+    end
+
+    # Returns the title of the file format or nil, if it was not set.
+    def title(language)
+      titles[language.to_s].presence
+    end
+
+    # returns channel feature is_activate?
+    def can_create_news_items?
+      can_create_news_items.to_i != 0
+    end
+
+    def ruby_class
+      @r_klass ||= RailsConnector::BasicObj.compute_type(name)
+    end
+
+    # Returns true, if a custom Ruby class exists.
+    def has_custom_ruby_class?
+      ruby_class != Obj
+    end
+
+    # Returns the custom attributes in the form of a Hash.
+    def custom_attributes
+      # create a Hash (with indifferent access) out of an Array of ActiveRecord objects
+      @custom_attributes ||= custom_attributes_raw.map do |attr|
+        { attr.attribute_name => attr }
+      end.reduce(HashWithIndifferentAccess.new, &:merge)
+    end
+
+    # Returns true, if the Obj Class has an attribute of the given name.
+    def custom_attribute?(attr)
+      custom_attributes.key?(attr.to_s)
+    end
+
+    # Returns an Array of String of all mandatory attributes found for this ObjClass,
+    # no matter if it is a custom or built-in attribute. Built-in attributes
+    # are underscored (valid_from, not validFrom).
+    # Possible +options+ are:
+    # <tt>:only_custom_attributes</tt>:: Return only custom attributes, omit
+    # built-in attributes like content_type or valid_from.
+    def mandatory_attribute_names(options = {})
+      only_custom_attributes ||= options[:only_custom_attributes] || false
+      build_mandatory_attribute_arrays
+      return @mandatory_custom_attributes if only_custom_attributes
+
+      @mandatory_attributes
+    end
+
+    # Returns true, if the file format has an mandatory attribute of the given name.
+    def mandatory_attribute?(attr)
+      mandatory_attribute_names.include?(attr.to_s)
+    end
+
+    # Convenience method for find_by_obj_class_name
+    def self.find_by_name(*args)
+      find_by_obj_class_name(*args)
+    end
+
+    # Reads a whole bunch of data, where only some of it is useful
+    # in a Rails application:
+    # attributeGroups, availableBlobEditors, bodyTemplateName,
+    # canCreateNewsItems, completionCheck, mandatoryAttributes,
+    # presetAttributes, recordSetCallback, titles, validSubObjClassCheck,
+    # workflowModification
+    def self.read_blob_data(name) #:nodoc:
+      blob = RailsConnector::Meta.hello_im_rails_and_im_retarted_so_please_be_patient do # these queries really pollute our logs!
+        blob_name =
+          if RailsConnector::BlobMapping.exists?
+            RailsConnector::BlobMapping.get_fingerprint("#{name}.jsonObjClassDict")
+          else
+            "#{name}.jsonObjClassDict"
+          end
+
+        RailsConnector::Blob.find_without_excluded_blob_data(blob_name)
+      end
+
+      return {} unless blob&.blob_data?
+
+      JSON.parse(blob.blob_data)
+    end
+
+    private
+
+    def load_blob_data #:nodoc:
+      return if @blob_data
+
+      @blob_data = self.class.read_blob_data(name)
+
+      # reset depending instance variables
+      @mandatory_custom_attributes = @mandatory_attributes = nil
+    end
+
+    def build_mandatory_attribute_arrays #:nodoc:
+      return if @mandatory_attributes
+
+      load_blob_data
+
+      @mandatory_custom_attributes = []
+      @mandatory_attributes = []
+      (@blob_data["mandatoryAttributes"] || []).each do |attr|
+        attr_name = attr.to_s
+        if custom_attribute?(attr_name)
+          @mandatory_custom_attributes << attr_name
+        else
+          # only modify built-in attributes; i.e. `validFrom` will become `valid_from`
+          attr_name = attr_name.underscore
+        end
+        @mandatory_attributes << attr_name
+      end
+    end
+  end
+end

data/lib/rails_connector/obj_class_attr.rb

@@ -0,0 +1,5 @@
+module RailsConnector
+  class ObjClassAttr < CmsBaseModel
+    has_many :custom_attributes_raw, class_name: "::RailsConnector::Attribute", foreign_key: "attribute_id", primary_key: "attribute_id"
+  end
+end

data/lib/rails_connector/object_with_meta_data.rb

@@ -0,0 +1,13 @@
+module RailsConnector
+  # This class allows us to read out the version and
+  # the reminder information of an Obj
+  class ObjectWithMetaData < CmsBaseModel #:nodoc:
+    # If we name the class Object, conflicts with the plain Ruby
+    # objects inside the RailsConnector will occur.
+    def self.table_name
+      "#{table_name_prefix}" "objects"
+    end
+
+    self.primary_key = :object_id
+  end
+end

data/lib/rails_connector/permission.rb

@@ -0,0 +1,37 @@
+module RailsConnector
+  # The permissions assigned to an Obj.
+  class Permission < CmsBaseModel
+    belongs_to :object, class_name: "Obj", foreign_key: "object_id"
+
+    # Returns the Array of the names of the user groups to which read permission has been granted.
+    def self.read
+      user_groups_for_permission_type(1)
+    end
+
+    # Returns the Array of the names of the user groups to which write permission has been granted
+    def self.write
+      user_groups_for_permission_type(2)
+    end
+
+    # Returns the Array of the names of the user groups to which root permission has been granted
+    def self.root
+      user_groups_for_permission_type(3)
+    end
+
+    # Returns the Array of the names of the user groups to which the children creation permission has been granted.
+    def self.create_children
+      user_groups_for_permission_type(4)
+    end
+
+    # Returns the Array of the names of the user groups to which live read permission has been granted.
+    def self.live
+      user_groups_for_permission_type(5)
+    end
+
+    def self.user_groups_for_permission_type(permission_type)
+      # Field name "user_login" is a legacy from CM tables.
+      # Actually the field contains the user group.
+      select(:user_login).where(permission_type: permission_type).map(&:user_login)
+    end
+  end
+end

data/lib/rails_connector/rack_middlewares.rb

@@ -0,0 +1,5 @@
+module RailsConnector
+  def self.rack_middlewares
+    [RailsConnector::CacheMiddleware]
+  end
+end

data/lib/rails_connector/ses.rb

@@ -0,0 +1,78 @@
+require "search_request"
+
+module RailsConnector
+  # This module accesses the Infopark Search Engine Server.
+  # @api public
+  module SES
+    autoload :VerityAccessor, "rails_connector/ses/verity_accessor"
+
+    # This method enables Obj to perform searches using the SES Search Engine Server.
+    def self.enable
+      ::Obj.extend Obj::ClassMethods
+    end
+
+    module Obj
+      # Extends the model class Obj with the class method find_with_ses.
+      module ClassMethods
+        # Queries the search engine and returns a SearchResult. The parameters
+        # are passed on to a SearchRequest (a kind of DefaultSearchRequest by default).
+        #
+        # Exceptions:
+        # * SearchError - The search engine reported an error.
+        #
+        def find_with_ses(query_string, options = {})
+          SearchRequest.new(query_string, options).fetch_hits
+        end
+      end
+    end
+
+    class SearchError < StandardError
+    end
+
+    # SearchResult is the list of hits in response to a search query. Since the
+    # maximum number of hits to return has been specified, there might be more
+    # hits available in the search engine.
+    # @api public
+    class SearchResult < Array
+      # The total number of hits.
+      # @api public
+      attr_reader :total_hits
+
+      def initialize(total_hits)
+        super()
+        @total_hits = total_hits
+      end
+    end
+
+    # A hit represents a found document for a particular search query.
+    # @api public
+    class Hit
+      # The ID of the found Obj.
+      # @api public
+      attr_reader :id, :score, :doc
+
+      # The score of the hit.
+      # @api public
+
+      # The raw result hash returned by the search engine, for a low-level access.
+      # Don't use this unless you know what you're doing.
+      # Be aware that this is not migration safe.
+      # @api public
+
+      def initialize(id, score, doc = {}, obj = nil)
+        @id = id
+        @score = score
+        @doc = doc
+        @obj = obj
+      end
+
+      # Returns the hit's corresponding Obj (or nil if none found in the database).
+      # @api public
+      def obj
+        @obj ||= ::Obj.find(@id)
+      rescue RailsConnector::ResourceNotFound
+        nil
+      end
+    end
+  end
+end

data/lib/rails_connector/ses/verity_accessor.rb

@@ -0,0 +1,127 @@
+require "builder"
+
+module RailsConnector
+  module SES
+    class VerityAccessor
+      require "net/http"
+      require "uri"
+      require "rexml/document"
+
+      #--
+      # Options: see VeritySearchRequest
+      #++
+      def initialize(query, options = {})
+        @query = query
+        @options = {
+          host: "localhost",
+          port: 3011,
+          offset: 0,
+          limit: 10,
+          min_relevance: 50,
+          max_docs: "unlimited",
+          parser: "simple",
+          sort_order: [%w(score desc), %w(name asc)],
+          collections: ["cm-contents"],
+          base_query: nil
+        }.merge(options)
+        @options[:collections] = Array(options[:collection]).flatten if options.has_key?(:collection)
+      end
+
+      # Queries the SES and returns a SearchResult.
+      #
+      # Exceptions:
+      # * SearchError - SES reported an error.
+      #
+      def search
+        parse_response_payload(send_to_ses(build_request_payload))
+      end
+
+      private
+
+      def build_request_payload
+        x = Builder::XmlMarkup.new
+        x.instruct!
+        x.tag!("ses-payload", "payload-id" => "d-1f6a64dec16aa328-00000020-i", "timestamp" => Time.now.to_iso, "version" => "6") do
+          x.tag!("ses-header") do
+            x.tag!("ses-sender", "sender-id" => "42", "name" => "infopark-rails-connector")
+          end
+          x.tag!("ses-request", "request-id" => "d-1f6a64dec16aa328-00000021-j-1", "preclusive" => "false") do
+            x.tag!("ses-search") do
+              x.query @query, parser: @options[:parser]
+              x.resultRecord do
+                x.resultField "objId"
+                x.resultField "score"
+              end
+              x.offset do
+                x.start @options[:offset].to_i + 1
+                x.length @options[:limit]
+              end
+              x.minRelevance @options[:min_relevance]
+              x.maxDocs @options[:max_docs]
+
+              unless @options[:sort_order].blank?
+                x.sortOrder do
+                  @options[:sort_order].each do |attribute, direction|
+                    x.sortField attribute, direction: direction
+                  end
+                end
+              end
+
+              x.searchBase do
+                @options[:collections].each { |item| x.collection item }
+                x.query @options[:base_query], parser: @options[:parser] if @options[:base_query]
+              end
+            end
+          end
+        end
+      end
+
+      def send_to_ses(payload)
+        res = Net::HTTP.new(@options[:host], @options[:port].to_i).start do |http|
+          req = Net::HTTP::Post.new("/xml")
+          req.body = payload
+          http.request(req)
+        end
+        res.body
+      end
+
+      def parse_response_payload(response)
+        xml = REXML::Document.new(response)
+        if xml.elements["/ses-payload/ses-response/ses-code"].attributes["numeric"] == "200"
+          build_successful_result(xml)
+        else
+          handle_error(xml)
+        end
+      end
+
+      def build_successful_result(response)
+        result = SearchResult.new(response.elements["/ses-payload/ses-response/ses-code/searchResults"].attributes["hits"].to_i)
+        response.elements.to_a("/ses-payload/ses-response/ses-code/searchResults/record").each do |record|
+          hit = Hit.new(record.elements["objId"].text.to_i, record.elements["score"].text.to_f)
+          if hit.obj.present?
+            result << hit
+          else
+            Rails.logger.warn("OBJ with ID ##{record.elements["objId"].text.to_i} not found: This search result will not be shown")
+          end
+        end
+        result
+      end
+
+      # SES raises these errors:
+      # 100171: ERROR_SYSTEM_SES_INTERNALVERITYERROR_DS
+      # 100230: ERROR_SYSTEM_SES_VERITYERROR_DS
+      # 100099: ERROR_SYSTEM_SES_DUPLICATECOLLETION_S
+      # 100173: ERROR_SYSTEM_SES_OPENCOLLECTIONFAILED
+      # 100103: ERROR_SYSTEM_SEARCHENGINE_SESSIONNEWFAILED
+      # 100177: ERROR_SYSTEM_SEARCHENGINE_BULKSUBMITFAILED
+      def handle_error(response)
+        msg = ""
+        response.elements.each("/ses-payload/ses-response/ses-code/errorStack/error") do |error|
+          msg << error.elements["phrase"].text
+          msg << "\n"
+        end
+        raise SearchError, msg
+      end
+    end
+  end
+end

data/lib/rails_connector/string_tagging.rb

@@ -0,0 +1,26 @@
+module RailsConnector
+  # adds flavour to strings
+  module StringTagging
+    # html flavour
+    def self.tag_as_html(string, source)
+      unless string.blank?
+        class << string
+          include RailsConnector::HtmlString
+        end
+        string.source = source
+      end
+      string
+    end
+
+    # markdown flavour
+    def self.tag_as_markdown(string, source)
+      unless string.blank?
+        class << string
+          include RailsConnector::MarkdownString
+        end
+        string.source = source
+      end
+      string
+    end
+  end
+end