zammad/app/models/activity_stream.rb

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

class ActivityStream < ApplicationModel
  include ActivityStream::Assets

  self.table_name = 'activity_streams'

  # rubocop:disable Rails/InverseOf
  belongs_to :object, class_name: 'ObjectLookup', foreign_key: 'activity_stream_object_id', optional: true
  belongs_to :type,   class_name: 'TypeLookup',   foreign_key: 'activity_stream_type_id', optional: true
  # rubocop:enable Rails/InverseOf

  # the noop is needed since Layout/EmptyLines detects
  # the block commend below wrongly as the measurement of
  # the wanted indentation of the rubocop re-enabling above
  def noop; end

=begin

add a new activity entry for an object

  ActivityStream.add(
    type: 'update',
    object: 'Ticket',
    permission: 'admin.user',
    o_id: ticket.id,
    created_by_id: 1,
    created_at: '2013-06-04 10:00:00',
  )

=end

  def self.add(data)

    # lookups
    if data[:type]
      type_id = TypeLookup.by_name(data[:type])
    end
    if data[:object]
      object_id = ObjectLookup.by_name(data[:object])
    end

    permission_id = nil
    if data[:permission]
      permission = Permission.lookup(name: data[:permission])
      if !permission
        raise "No such Permission #{data[:permission]}"
      end

      permission_id = permission.id
    end

    # check if object for online notification exists
    exists_by_object_and_id?(data[:object], data[:o_id])

    # check newest entry - is needed
    result = ActivityStream.where(
      o_id:                      data[:o_id],
      # :activity_stream_type_id  => type_id,
      permission_id:             permission_id,
      activity_stream_object_id: object_id,
      created_by_id:             data[:created_by_id]
    ).reorder(created_at: :desc).first

    # return if old entry is really fresh
    if result
      activity_record_delay = 90.seconds
      return result if result.created_at.to_i >= (data[:created_at].to_i - activity_record_delay)
    end

    # create history
    record = {
      o_id:                      data[:o_id],
      activity_stream_type_id:   type_id,
      activity_stream_object_id: object_id,
      permission_id:             permission_id,
      group_id:                  data[:group_id],
      created_at:                data[:created_at],
      created_by_id:             data[:created_by_id]
    }

    ActivityStream.create(record)
  end

=begin

remove whole activity entries of an object

  ActivityStream.remove('Ticket', 123)

=end

  def self.remove(object_name, o_id)
    object_id = ObjectLookup.by_name(object_name)
    ActivityStream.where(
      activity_stream_object_id: object_id,
      o_id:                      o_id,
    ).destroy_all
  end

=begin

return all activity entries of an user

  activity_stream = ActivityStream.list(user, limit)

=end

  def self.list(user, limit)
    ActivityStreamPolicy::Scope.new(user, self).resolve
                               .reorder(created_at: :desc)
                               .limit(limit)
  end

=begin

cleanup old stream messages

  ActivityStream.cleanup

optional you can put the max oldest stream entries as argument

  ActivityStream.cleanup(3.months)

=end

  def self.cleanup(diff = 3.months)
    where(created_at: ...diff.ago)
      .delete_all

    true
  end

end