zammad/app/models/application_model.rb

# Copyright (C) 2012-2014 Zammad Foundation, http://zammad-foundation.org/

class ApplicationModel < ActiveRecord::Base
  include ApplicationModel::Assets
  include ApplicationModel::HistoryLogBase
  include ApplicationModel::ActivityStreamBase
  include ApplicationModel::SearchIndexBase

  self.abstract_class = true

  before_create  :check_attributes_protected, :check_limits, :cache_delete, :fill_up_user_create
  before_update  :check_limits, :fill_up_user_update
  before_destroy :destroy_dependencies

  after_create  :cache_delete
  after_update  :cache_delete
  after_touch   :cache_delete
  after_destroy :cache_delete

  after_create  :attachments_buffer_check
  after_update  :attachments_buffer_check

  after_create  :activity_stream_create
  after_update  :activity_stream_update
  before_destroy :activity_stream_destroy

  after_create  :history_create
  after_update  :history_update
  after_destroy :history_destroy

  after_create  :search_index_update
  after_update  :search_index_update
  after_touch   :search_index_update
  after_destroy :search_index_destroy

  before_destroy :recent_view_destroy

  # create instance accessor
  class << self
    attr_accessor :activity_stream_support_config, :history_support_config, :search_index_support_config
  end

  attr_accessor :history_changes_last_done

  def check_attributes_protected

    import_class_list = ['Ticket', 'Ticket::Article', 'History', 'Ticket::State', 'Ticket::StateType', 'Ticket::Priority', 'Group', 'User', 'Role' ]

    # do noting, use id as it is
    return if !Setting.get('system_init_done')
    return if Setting.get('import_mode') && import_class_list.include?(self.class.to_s)

    self[:id] = nil
  end

=begin

remove all not used model attributes of params

  result = Model.param_cleanup(params)

  for object creation, ignore id's

  result = Model.param_cleanup(params, true)

returns

  result = params # params with valid attributes of model

=end

  def self.param_cleanup(params, new_object = false)

    if params.respond_to?('permit!')
      params.permit!
    end

    if params.nil?
      raise "No params for #{self}!"
    end

    data = {}
    params.each { |key, value|
      data[key.to_sym] = value
    }

    # ignore id for new objects
    if new_object && params[:id]
      data.delete(:id)
    end

    # only use object attributes
    clean_params = {}
    new.attributes.each { |attribute, _value|
      next if !data.key?(attribute.to_sym)
      clean_params[attribute.to_sym] = data[attribute.to_sym]
    }

    # we do want to set this via database
    param_validation(clean_params)
  end

=begin

set relations of model based on params

  model = Model.find(1)
  result = model.param_set_associations(params)

returns

  result = true|false

=end

  def param_set_associations(params)

    # set relations by id/verify if ref exists
    self.class.reflect_on_all_associations.map { |assoc|
      real_ids = assoc.name.to_s[0, assoc.name.to_s.length - 1] + '_ids'
      real_ids = real_ids.to_sym
      next if !params.key?(real_ids)
      list_of_items = params[real_ids]
      if params[real_ids].class != Array
        list_of_items = [ params[real_ids] ]
      end
      list = []
      list_of_items.each { |item_id|
        next if !item_id
        lookup = assoc.klass.lookup(id: item_id)

        # complain if we found no reference
        if !lookup
          raise "No value found for '#{assoc.name}' with id #{item_id.inspect}"
        end
        list.push item_id
      }
      #p "SEND #{real_ids} = #{list.inspect}"
      send("#{real_ids}=", list)
    }

    # set relations by name/lookup
    self.class.reflect_on_all_associations.map { |assoc|
      real_ids = assoc.name.to_s[0, assoc.name.to_s.length - 1] + '_ids'
      next if !respond_to?(real_ids)
      real_values = assoc.name.to_s[0, assoc.name.to_s.length - 1] + 's'
      real_values = real_values.to_sym
      next if !respond_to?(real_values)
      next if !params[real_values]
      next if params[real_values].class != Array
      list = []
      class_object = assoc.klass
      params[real_values].each { |value|
        lookup = nil
        if class_object == User
          if !lookup
            lookup = class_object.lookup(login: value)
          end
          if !lookup
            lookup = class_object.lookup(email: value)
          end
        else
          lookup = class_object.lookup(name: value)
        end

        # complain if we found no reference
        if !lookup
          raise "No lookup value found for '#{assoc.name}': #{value.inspect}"
        end
        list.push lookup.id
      }
      #p "SEND #{real_ids} = #{list.inspect}"
      send("#{real_ids}=", list)
    }
  end

=begin

get relations of model based on params

  model = Model.find(1)
  attributes = model.attributes_with_associations

returns

  hash with attributes and association ids

=end

  def attributes_with_associations

    # get relations
    attributes = self.attributes
    self.class.reflect_on_all_associations.map { |assoc|
      real_ids = assoc.name.to_s[0, assoc.name.to_s.length - 1] + '_ids'
      next if !respond_to?(real_ids)
      attributes[real_ids] = send(real_ids)
    }
    attributes
  end

=begin

get relation name of model based on params

  model = Model.find(1)
  attributes = model.attributes_with_relation_names

returns

  hash with attributes, association ids, association names and relation name

=end

  def attributes_with_relation_names

    # get relations
    attributes = attributes_with_associations
    self.class.reflect_on_all_associations.map { |assoc|
      next if !respond_to?(assoc.name)
      ref = send(assoc.name)
      next if !ref
      if ref.respond_to?(:first)
        attributes[assoc.name.to_s] = []
        ref.each { |item|
          if item[:login]
            attributes[assoc.name.to_s].push item[:login]
            next
          end
          next if !item[:name]
          attributes[assoc.name.to_s].push item[:name]
        }
        if ref.count > 0 && attributes[assoc.name.to_s].empty?
          attributes.delete(assoc.name.to_s)
        end
        next
      end
      if ref[:login]
        attributes[assoc.name.to_s] = ref[:login]
        next
      end
      next if !ref[:name]
      attributes[assoc.name.to_s] = ref[:name]
    }

    # fill created_by/updated_by
    {
      'created_by_id' => 'created_by',
      'updated_by_id' => 'updated_by',
    }.each { |source, destination|
      next if !attributes[source]
      user = User.lookup(id: attributes[source])
      next if !user
      attributes[destination] = user.login
    }

    # remove forbitten attributes
    %w(password token tokens token_ids).each { |item|
      attributes.delete(item)
    }

    attributes
  end

=begin

remove all not used params of object (per default :updated_at, :created_at, :updated_by_id and :created_by_id)

  result = Model.param_validation(params)

returns

  result = params # params without listed attributes

=end

  def self.param_validation(data)

    # we do want to set this via database
    [:action, :controller, :updated_at, :created_at, :updated_by_id, :created_by_id, :updated_by, :created_by].each { |key|
      data.delete(key)
    }

    data
  end

=begin

do name/login/email based lookup for associations

  params = {
    login: 'some login',
    firstname: 'some firstname',
    lastname: 'some lastname',
    email: 'some email',
    organization: 'some organization',
    roles: ['Agent', 'Admin'],
  }

  attributes = Model.param_association_lookup(params)

returns

  attributes = params # params with possible lookups

  attributes = {
    login: 'some login',
    firstname: 'some firstname',
    lastname: 'some lastname',
    email: 'some email',
    organization_id: 123,
    role_ids: [2,1],
  }

=end

  def self.param_association_lookup(params)

    data = {}
    params.each { |key, value|
      data[key.to_sym] = value
    }

    data.symbolize_keys!
    available_attributes = attribute_names
    reflect_on_all_associations.map { |assoc|
      value = data[assoc.name.to_sym]
      next if !value # next if we do not have a value
      ref_name = "#{assoc.name}_id"

      # handle _id values
      if available_attributes.include?(ref_name) # if we do have an _id attribute
        next if data[ref_name.to_sym] # next if we have already the _id filled

        # get association class and do lookup
        class_object = assoc.klass
        lookup = nil
        if class_object == User
          if value.class == String
            if !lookup
              lookup = class_object.lookup(login: value)
            end
            if !lookup
              lookup = class_object.lookup(email: value)
            end
          else
            raise "String is needed as ref value #{value.inspect} for '#{assoc.name}'"
          end
        else
          lookup = class_object.lookup(name: value)
        end

        # complain if we found no reference
        if !lookup
          raise "No lookup value found for '#{assoc.name}': #{value.inspect}"
        end

        # release data value
        data.delete(assoc.name.to_sym)

        # remember id reference
        data[ref_name.to_sym] = lookup.id
        next
      end

      next if value.class != Array
      next if value.empty?
      next if value[0].class != String

      # handle _ids values
      ref_names = "#{assoc.name[0, assoc.name.length - 1]}_ids"
      generic_object_tmp = new
      next unless generic_object_tmp.respond_to?(ref_names) # if we do have an _ids attribute
      next if data[ref_names.to_sym] # next if we have already the _ids filled

      # get association class and do lookup
      class_object = assoc.klass
      lookup_ids = []
      value.each { |item|
        lookup = nil
        if class_object == User
          if item.class == String
            if !lookup
              lookup = class_object.lookup(login: item)
            end
            if !lookup
              lookup = class_object.lookup(email: item)
            end
          else
            raise "String is needed in array ref as ref value #{value.inspect} for '#{assoc.name}'"
          end
        else
          lookup = class_object.lookup(name: item)
        end

        # complain if we found no reference
        if !lookup
          raise "No lookup value found for '#{assoc.name}': #{item.inspect}"
        end
        lookup_ids.push lookup.id
      }

      # release data value
      data.delete(assoc.name.to_sym)

      # remember id reference
      data[ref_names.to_sym] = lookup_ids
    }

    data
  end

=begin

set created_by_id & updated_by_id if not given based on UserInfo (current session)

Used as before_create callback, no own use needed

  result = Model.fill_up_user_create(params)

returns

  result = params # params with updated_by_id & created_by_id if not given based on UserInfo (current session)

=end

  def fill_up_user_create
    if self.class.column_names.include? 'updated_by_id'
      if UserInfo.current_user_id
        if updated_by_id && updated_by_id != UserInfo.current_user_id
          logger.info "NOTICE create - self.updated_by_id is different: #{updated_by_id}/#{UserInfo.current_user_id}"
        end
        self.updated_by_id = UserInfo.current_user_id
      end
    end

    return if !self.class.column_names.include? 'created_by_id'

    return if !UserInfo.current_user_id

    if created_by_id && created_by_id != UserInfo.current_user_id
      logger.info "NOTICE create - self.created_by_id is different: #{created_by_id}/#{UserInfo.current_user_id}"
    end
    self.created_by_id = UserInfo.current_user_id
  end

=begin

set updated_by_id if not given based on UserInfo (current session)

Used as before_update callback, no own use needed

  result = Model.fill_up_user_update(params)

returns

  result = params # params with updated_by_id & created_by_id if not given based on UserInfo (current session)

=end

  def fill_up_user_update
    return if !self.class.column_names.include? 'updated_by_id'
    return if !UserInfo.current_user_id

    self.updated_by_id = UserInfo.current_user_id
  end

  def cache_update(o)
    cache_delete if respond_to?('cache_delete')
    o.cache_delete if o.respond_to?('cache_delete')
  end

  def cache_delete

    # delete id caches
    key = "#{self.class}::#{id}"
    Cache.delete(key)

    # delete old name / login caches
    if changed?
      if changes.key?('name')
        name = changes['name'][0]
        key = "#{self.class}::#{name}"
        Cache.delete(key.to_s)
      end
      if changes.key?('login')
        name = changes['login'][0]
        key = "#{self.class}::#{name}"
        Cache.delete(key)
      end
    end

    # delete name caches
    if self[:name]
      key = "#{self.class}::#{self.name}"
      Cache.delete(key)
    end

    # delete login caches
    return if !self[:login]

    Cache.delete("#{self.class}::#{login}")
  end

  def self.cache_set(data_id, data)
    key = "#{self}::#{data_id}"
    Cache.write(key, data)
  end

  def self.cache_get(data_id)
    key = "#{self}::#{data_id}"
    Cache.get(key)
  end

=begin

generate uniq name (will check name of model and generates _1 sequenze)

Used as before_update callback, no own use needed

  name = Model.genrate_uniq_name('some name')

returns

  result = 'some name_X'

=end

  def self.genrate_uniq_name(name)
    return name if !find_by(name: name)
    (1..100).each { |counter|
      name = "#{name}_#{counter}"
      exists = find_by(name: name)
      next if exists
      break
    }
    name
  end

=begin

lookup model from cache (if exists) or retrieve it from db, id, name, login or email possible

  result = Model.lookup(id: 123)
  result = Model.lookup(name: 'some name')
  result = Model.lookup(login: 'some login')
  result = Model.lookup(email: 'some login')

returns

  result = model # with all attributes

=end

  def self.lookup(data)
    if data[:id]
      cache = cache_get(data[:id])
      return cache if cache

      record = find_by(id: data[:id])
      cache_set(data[:id], record)
      return record
    elsif data[:name]
      cache = cache_get(data[:name])
      return cache if cache

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(name) = LOWER(?)', data[:name])
                else
                  where(name: data[:name])
                end
      records.each { |loop_record|
        if loop_record.name == data[:name]
          cache_set(data[:name], loop_record)
          return loop_record
        end
      }
      return
    elsif data[:login]
      cache = cache_get(data[:login])
      return cache if cache

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(login) = LOWER(?)',  data[:login])
                else
                  where(login: data[:login])
                end
      records.each { |loop_record|
        if loop_record.login == data[:login]
          cache_set(data[:login], loop_record)
          return loop_record
        end
      }
      return
    elsif data[:email]
      cache = cache_get(data[:email])
      return cache if cache

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(email) = LOWER(?)',  data[:email])
                else
                  where(email: data[:email])
                end
      records.each { |loop_record|
        if loop_record.email == data[:email]
          cache_set(data[:email], loop_record)
          return loop_record
        end
      }
      return
    end

    raise 'Need name, id, login or email for lookup()'
  end

=begin

create model if not exists (check exists based on id, name, login, email or locale)

  result = Model.create_if_not_exists(attributes)

returns

  result = model # with all attributes

=end

  def self.create_if_not_exists(data)
    if data[:id]
      record = find_by(id: data[:id])
      return record if record
    elsif data[:name]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(name) = LOWER(?)', data[:name])
                else
                  where(name: data[:name])
                end
      records.each { |loop_record|
        return loop_record if loop_record.name == data[:name]
      }
    elsif data[:login]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(login) = LOWER(?)', data[:login])
                else
                  where(login: data[:login])
                end
      records.each { |loop_record|
        return loop_record if loop_record.login == data[:login]
      }
    elsif data[:email]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(email) = LOWER(?)', data[:email])
                else
                  where(email: data[:email])
                end
      records.each { |loop_record|
        return loop_record if loop_record.email == data[:email]
      }
    elsif data[:locale] && data[:source]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(locale) = LOWER(?) AND LOWER(source) = LOWER(?)', data[:locale], data[:source])
                else
                  where(locale: data[:locale], source: data[:source])
                end
      records.each { |loop_record|
        return loop_record if loop_record.source == data[:source]
      }
    end
    create(data)
  end

=begin

Model.create_if_not_exists with ref lookups

  result = Model.create_if_not_exists_with_ref(attributes)

returns

  result = model # with all attributes

=end

  def self.create_if_not_exists_with_ref(data)
    data = param_association_lookup(data)
    create_or_update(data)
  end

=begin

create or update model (check exists based on id, name, login, email or locale)

  result = Model.create_or_update(attributes)

returns

  result = model # with all attributes

=end

  def self.create_or_update(data)
    if data[:id]
      record = find_by(id: data[:id])
      if record
        record.update_attributes(data)
        return record
      end
      record = new(data)
      record.save
      return record
    elsif data[:name]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(name) = LOWER(?)', data[:name])
                else
                  where(name: data[:name])
                end
      records.each { |loop_record|
        if loop_record.name == data[:name]
          loop_record.update_attributes(data)
          return loop_record
        end
      }
      record = new(data)
      record.save
      return record
    elsif data[:login]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(login) = LOWER(?)', data[:login])
                else
                  where(login: data[:login])
                end
      records.each { |loop_record|
        if loop_record.login.casecmp(data[:login]).zero?
          loop_record.update_attributes(data)
          return loop_record
        end
      }
      record = new(data)
      record.save
      return record
    elsif data[:email]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(email) = LOWER(?)',  data[:email])
                else
                  where(email: data[:email])
                end
      records.each { |loop_record|
        if loop_record.email.casecmp(data[:email]).zero?
          loop_record.update_attributes(data)
          return loop_record
        end
      }
      record = new(data)
      record.save
      return record
    elsif data[:locale]

      # do lookup with == to handle case insensitive databases
      records = if Rails.application.config.db_case_sensitive
                  where('LOWER(locale) = LOWER(?)', data[:locale])
                else
                  where(locale: data[:locale])
                end
      records.each { |loop_record|
        if loop_record.locale.casecmp(data[:locale]).zero?
          loop_record.update_attributes(data)
          return loop_record
        end
      }
      record = new(data)
      record.save
      return record
    else
      raise 'Need name, login, email or locale for create_or_update()'
    end
  end

=begin

Model.create_or_update with ref lookups

  result = Model.create_or_update(attributes)

returns

  result = model # with all attributes

=end

  def self.create_or_update_with_ref(data)
    data = param_association_lookup(data)
    create_or_update(data)
  end

=begin

activate latest change on create, update, touch and destroy

class Model < ApplicationModel
  latest_change_support
end

=end

  def self.latest_change_support
    after_create  :latest_change_set_from_observer
    after_update  :latest_change_set_from_observer
    after_touch   :latest_change_set_from_observer
    after_destroy :latest_change_set_from_observer_destroy
  end

  def latest_change_set_from_observer
    self.class.latest_change_set(updated_at)
  end

  def latest_change_set_from_observer_destroy
    self.class.latest_change_set(nil)
  end

  def self.latest_change_set(updated_at)
    key        = "#{new.class.name}_latest_change"
    expires_in = 31_536_000 # 1 year

    if updated_at.nil?
      Cache.delete(key)
    else
      Cache.write(key, updated_at, { expires_in: expires_in })
    end
  end

=begin

  get latest updated_at object timestamp

  latest_change = Ticket.latest_change

returns

  result = timestamp

=end

  def self.latest_change
    key        = "#{new.class.name}_latest_change"
    updated_at = Cache.get(key)

    # if we do not have it cached, do lookup
    if !updated_at
      o = select(:updated_at).order(updated_at: :desc).limit(1).first
      if o
        updated_at = o.updated_at
        latest_change_set(updated_at)
      end
    end
    updated_at
  end

=begin

activate client notify support on create, update, touch and destroy

class Model < ApplicationModel
  notify_clients_support
end

=end

  def self.notify_clients_support
    after_create  :notify_clients_after_create
    after_update  :notify_clients_after_update
    after_touch   :notify_clients_after_touch
    after_destroy :notify_clients_after_destroy
  end

=begin

notify_clients_after_create after model got created

used as callback in model file

class OwnModel < ApplicationModel
  after_create    :notify_clients_after_create
  after_update    :notify_clients_after_update
  after_touch     :notify_clients_after_touch
  after_destroy   :notify_clients_after_destroy

  [...]

=end

  def notify_clients_after_create

    # return if we run import mode
    return if Setting.get('import_mode')
    logger.debug "#{self.class.name}.find(#{id}) notify created " + created_at.to_s
    class_name = self.class.name
    class_name.gsub!(/::/, '')
    Sessions.broadcast(
      event: class_name + ':create',
      data: { id: id, updated_at: updated_at }
    )
  end

=begin

notify_clients_after_update after model got updated

used as callback in model file

class OwnModel < ApplicationModel
  after_create    :notify_clients_after_create
  after_update    :notify_clients_after_update
  after_touch     :notify_clients_after_touch
  after_destroy   :notify_clients_after_destroy

  [...]

=end

  def notify_clients_after_update

    # return if we run import mode
    return if Setting.get('import_mode')
    logger.debug "#{self.class.name}.find(#{id}) notify UPDATED " + updated_at.to_s
    class_name = self.class.name
    class_name.gsub!(/::/, '')
    Sessions.broadcast(
      event: class_name + ':update',
      data: { id: id, updated_at: updated_at }
    )
  end

=begin

notify_clients_after_touch after model got touched

used as callback in model file

class OwnModel < ApplicationModel
  after_create    :notify_clients_after_create
  after_update    :notify_clients_after_update
  after_touch     :notify_clients_after_touch
  after_destroy   :notify_clients_after_destroy

  [...]

=end

  def notify_clients_after_touch

    # return if we run import mode
    return if Setting.get('import_mode')
    logger.debug "#{self.class.name}.find(#{id}) notify TOUCH " + updated_at.to_s
    class_name = self.class.name
    class_name.gsub!(/::/, '')
    Sessions.broadcast(
      event: class_name + ':touch',
      data: { id: id, updated_at: updated_at }
    )
  end

=begin

notify_clients_after_destroy after model got destroyed

used as callback in model file

class OwnModel < ApplicationModel
  after_create    :notify_clients_after_create
  after_update    :notify_clients_after_update
  after_touch     :notify_clients_after_touch
  after_destroy   :notify_clients_after_destroy

  [...]

=end
  def notify_clients_after_destroy

    # return if we run import mode
    return if Setting.get('import_mode')
    logger.debug "#{self.class.name}.find(#{id}) notify DESTOY " + updated_at.to_s
    class_name = self.class.name
    class_name.gsub!(/::/, '')
    Sessions.broadcast(
      event: class_name + ':destroy',
      data: { id: id, updated_at: updated_at }
    )
  end

=begin

serve methode to configure and enable search index support for this model

class Model < ApplicationModel
  search_index_support
    ignore_attributes: {
      create_article_type_id:   true,
      create_article_sender_id: true,
      article_count:            true,
    },
    ignore_ids: [1,2,4]

end

=end

  def self.search_index_support(data = {})
    @search_index_support_config = data
  end

=begin

update search index, if configured - will be executed automatically

  model = Model.find(123)
  model.search_index_update

=end

  def search_index_update
    config = self.class.search_index_support_config
    return if !config
    return if config[:ignore_ids] && config[:ignore_ids].include?(id)

    # start background job to transfer data to search index
    return if !SearchIndexBackend.enabled?
    Delayed::Job.enqueue(ApplicationModel::BackgroundJobSearchIndex.new(self.class.to_s, id))
  end

=begin

delete search index object, will be executed automatically

  model = Model.find(123)
  model.search_index_destroy

=end

  def search_index_destroy
    config = self.class.search_index_support_config
    return if !config
    return if config[:ignore_ids] && config[:ignore_ids].include?(id)

    SearchIndexBackend.remove(self.class.to_s, id)
  end

=begin

reload search index with full data

  Model.search_index_reload

=end

  def self.search_index_reload
    config = @search_index_support_config
    return if !config
    tolerance = 5
    tolerance_count = 0
    all_ids = select('id').all.order('created_at DESC')
    all_ids.each { |item_with_id|
      next if config[:ignore_ids] && config[:ignore_ids].include?(item_with_id.id)
      item = find(item_with_id.id)
      begin
        item.search_index_update_backend
      rescue => e
        logger.error "Unable to send #{item.class}.find(#{item.id}) backend: #{e.inspect}"
        tolerance_count += 1
        raise "Unable to send #{item.class}.find(#{item.id}) backend: #{e.inspect}" if tolerance_count == tolerance
      end
    }
  end

=begin

serve methode to configure and enable activity stream support for this model

class Model < ApplicationModel
  activity_stream_support role: 'Admin'
end

=end

  def self.activity_stream_support(data = {})
    @activity_stream_support_config = data
  end

=begin

log object create activity stream, if configured - will be executed automatically

  model = Model.find(123)
  model.activity_stream_create

=end

  def activity_stream_create
    return if !self.class.activity_stream_support_config
    activity_stream_log('create', self['created_by_id'])
  end

=begin

log object update activity stream, if configured - will be executed automatically

  model = Model.find(123)
  model.activity_stream_update

=end

  def activity_stream_update
    return if !self.class.activity_stream_support_config

    return if !changed?

    # default ignored attributes
    ignore_attributes = {
      created_at: true,
      updated_at: true,
      created_by_id: true,
      updated_by_id: true,
    }
    if self.class.activity_stream_support_config[:ignore_attributes]
      self.class.activity_stream_support_config[:ignore_attributes].each { |key, value|
        ignore_attributes[key] = value
      }
    end

    log = false
    changes.each { |key, _value|

      # do not log created_at and updated_at attributes
      next if ignore_attributes[key.to_sym] == true

      log = true
    }

    return if !log

    activity_stream_log('update', self['updated_by_id'])
  end

=begin

delete object activity stream, will be executed automatically

  model = Model.find(123)
  model.activity_stream_destroy

=end

  def activity_stream_destroy
    return if !self.class.activity_stream_support_config
    ActivityStream.remove(self.class.to_s, id)
  end

=begin

serve methode to configure and enable history support for this model

class Model < ApplicationModel
  history_support
end

class Model < ApplicationModel
  history_support ignore_attributes: { article_count: true }
end

=end

  def self.history_support(data = {})
    @history_support_config = data
  end

=begin

log object create history, if configured - will be executed automatically

  model = Model.find(123)
  model.history_create

=end

  def history_create
    return if !self.class.history_support_config
    #logger.debug 'create ' + self.changes.inspect
    history_log('created', created_by_id)

  end

=begin

log object update history with all updated attributes, if configured - will be executed automatically

  model = Model.find(123)
  model.history_update

=end

  def history_update
    return if !self.class.history_support_config

    return if !changed?

    # return if it's no update
    return if new_record?

    # new record also triggers update, so ignore new records
    changes = self.changes
    if history_changes_last_done
      history_changes_last_done.each { |key, value|
        if changes.key?(key) && changes[key] == value
          changes.delete(key)
        end
      }
    end
    self.history_changes_last_done = changes
    #logger.info 'updated ' + self.changes.inspect

    return if changes['id'] && !changes['id'][0]

    # default ignored attributes
    ignore_attributes = {
      created_at: true,
      updated_at: true,
      created_by_id: true,
      updated_by_id: true,
    }
    if self.class.history_support_config[:ignore_attributes]
      self.class.history_support_config[:ignore_attributes].each { |key, value|
        ignore_attributes[key] = value
      }
    end

    changes.each { |key, value|

      # do not log created_at and updated_at attributes
      next if ignore_attributes[key.to_sym] == true

      # get attribute name
      attribute_name = key.to_s
      if attribute_name[-3, 3] == '_id'
        attribute_name = attribute_name[ 0, attribute_name.length - 3 ]
      end

      value_id = []
      value_str = [ value[0], value[1] ]
      if key.to_s[-3, 3] == '_id'
        value_id[0] = value[0]
        value_id[1] = value[1]

        if respond_to?(attribute_name) && send(attribute_name)
          relation_class = send(attribute_name).class
          if relation_class && value_id[0]
            relation_model = relation_class.lookup(id: value_id[0])
            if relation_model
              if relation_model['name']
                value_str[0] = relation_model['name']
              elsif relation_model.respond_to?('fullname')
                value_str[0] = relation_model.send('fullname')
              end
            end
          end
          if relation_class && value_id[1]
            relation_model = relation_class.lookup(id: value_id[1])
            if relation_model
              if relation_model['name']
                value_str[1] = relation_model['name']
              elsif relation_model.respond_to?('fullname')
                value_str[1] = relation_model.send('fullname')
              end
            end
          end
        end
      end
      data = {
        history_attribute: attribute_name,
        value_from: value_str[0].to_s,
        value_to: value_str[1].to_s,
        id_from: value_id[0],
        id_to: value_id[1],
      }
      #logger.info "HIST NEW #{self.class.to_s}.find(#{self.id}) #{data.inspect}"
      history_log('updated', updated_by_id, data)
    }
  end

=begin

delete object history, will be executed automatically

  model = Model.find(123)
  model.history_destroy

=end

  def history_destroy
    return if !self.class.history_support_config
    History.remove(self.class.to_s, id)
  end

=begin

get list of attachments of this object

  item = Model.find(123)
  list = item.attachments

returns

  # array with Store model objects

=end

  def attachments
    Store.list(object: self.class.to_s, o_id: id)
  end

=begin

store attachments for this object

  item = Model.find(123)
  item.attachments = [ Store-Object1, Store-Object2 ]

=end

  def attachments=(attachments)
    self.attachments_buffer = attachments

    # update if object already exists
    return if !(id && id.nonzero?)

    attachments_buffer_check
  end

=begin

return object and assets

  data = Model.full(123)
  data = {
    id:     123,
    assets: assets,
  }

=end

  def self.full(id)
    object = find(id)
    assets = object.assets({})
    {
      id: id,
      assets: assets,
    }
  end

=begin

get assets of object list

  list = [
    {
      object => 'Ticket',
      o_id   => 1,
    },
    {
      object => 'User',
      o_id   => 121,
    },
  ]

  assets = Model.assets_of_object_list(list, assets)

=end

  def self.assets_of_object_list(list, assets = {})
    list.each { |item|
      require item['object'].to_filename
      record = Kernel.const_get(item['object']).find(item['o_id'])
      assets = record.assets(assets)
      if item['created_by_id']
        user = User.find(item['created_by_id'])
        assets = user.assets(assets)
      end
      if item['updated_by_id']
        user = User.find(item['updated_by_id'])
        assets = user.assets(assets)
      end
    }
    assets
  end

=begin

get assets and record_ids of selector

  model = Model.find(123)

  assets = model.assets_of_selector('attribute_name_of_selector', assets)

=end

  def assets_of_selector(selector, assets = {})

    # get assets of condition
    models = Models.all
    send(selector).each { |item, content|
      attribute = item.split(/\./)
      next if !attribute[1]
      begin
        attribute_class = attribute[0].to_classname.constantize
      rescue => e
        logger.error "Unable to get asset for '#{attribute[0]}': #{e.inspect}"
        next
      end
      reflection = attribute[1].sub(/_id$/, '')
      #reflection = reflection.to_sym
      next if !models[attribute_class]
      next if !models[attribute_class][:reflections]
      next if !models[attribute_class][:reflections][reflection]
      next if !models[attribute_class][:reflections][reflection].klass
      attribute_ref_class = models[attribute_class][:reflections][reflection].klass
      if content['value'].class == Array
        content['value'].each { |item_id|
          attribute_object = attribute_ref_class.find_by(id: item_id)
          if attribute_object
            assets = attribute_object.assets(assets)
          end
        }
      else
        attribute_object = attribute_ref_class.find_by(id: content['value'])
        if attribute_object
          assets = attribute_object.assets(assets)
        end
      end
    }
    assets
  end

=begin

touch references by params

  Model.touch_reference_by_params(
    object: 'Ticket',
    o_id: 123,
  )

=end

  def self.touch_reference_by_params(data)

    object_class = Kernel.const_get(data[:object])
    object = object_class.lookup(id: data[:o_id])
    return if !object
    object.touch
  rescue => e
    logger.error e.message
    logger.error e.backtrace.inspect

  end

  private

  def attachments_buffer
    @attachments_buffer_data
  end

  def attachments_buffer=(attachments)
    @attachments_buffer_data = attachments
  end

  def attachments_buffer_check

    # do nothing if no attachment exists
    return 1 if attachments_buffer.nil?

    # store attachments
    article_store = []
    attachments_buffer.each do |attachment|
      article_store.push Store.add(
        object: self.class.to_s,
        o_id: id,
        data: attachment.content,
        filename: attachment.filename,
        preferences: attachment.preferences,
        created_by_id: created_by_id,
      )
    end
    attachments_buffer = nil
  end

=begin

delete object recent viewed list, will be executed automatically

  model = Model.find(123)
  model.recent_view_destroy

=end

  def recent_view_destroy
    RecentView.log_destroy(self.class.to_s, id)
  end

=begin

check string/varchar size and cut them if needed

=end

  def check_limits
    attributes.each { |attribute|
      next if !self[ attribute[0] ]
      next if self[ attribute[0] ].class != String
      next if self[ attribute[0] ].empty?
      column = self.class.columns_hash[ attribute[0] ]
      next if !column
      limit = column.limit
      if column && limit
        current_length = attribute[1].to_s.length
        if limit < current_length
          logger.warn "WARNING: cut string because of database length #{self.class}.#{attribute[0]}(#{limit} but is #{current_length}:#{attribute[1]})"
          self[ attribute[0] ] = attribute[1][ 0, limit ]
        end
      end

      # strip 4 bytes utf8 chars if needed
      if column && self[ attribute[0] ]
        self[attribute[0]] = self[ attribute[0] ].utf8_to_3bytesutf8
      end
    }
  end

=begin

destory object dependencies, will be executed automatically

=end

  def destroy_dependencies
  end

end