zammad/app/models/online_notification.rb

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

class OnlineNotification < ApplicationModel
  belongs_to :type_lookup,     class_name: 'TypeLookup'
  belongs_to :object_lookup,   class_name: 'ObjectLookup'
  belongs_to :user

  after_create    :notify_clients_after_change
  after_update    :notify_clients_after_change
  after_destroy   :notify_clients_after_change

=begin

add a new online notification for this user

  OnlineNotification.add(
    type:          'Assigned to you',
    object:        'Ticket',
    o_id:          ticket.id,
    seen:          false,
    created_by_id: 1,
    user_id:       2,
  )

=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

    record = {
      o_id: data[:o_id],
      object_lookup_id: object_id,
      type_lookup_id: type_id,
      seen: data[:seen],
      user_id: data[:user_id],
      created_by_id: data[:created_by_id]
    }

    OnlineNotification.create(record)
  end

=begin

mark online notification as seen

  OnlineNotification.seen(
    id: 2,
  )

=end

  def self.seen(data)
    notification = OnlineNotification.find(data[:id])
    notification.seen = true
    notification.save
  end

=begin

remove whole online notifications of an object

  OnlineNotification.remove( 'Ticket', 123 )

=end

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

=begin

return all online notifications of an user

  notifications = OnlineNotification.list( user, limit )

=end

  def self.list(user, limit)

    notifications = OnlineNotification.where(user_id: user.id)
                    .order( 'created_at DESC, id DESC' )
                    .limit( limit )
    list = []
    notifications.each do |item|
      data           = item.attributes
      data['object'] = ObjectLookup.by_id( data['object_lookup_id'] )
      data['type']   = TypeLookup.by_id( data['type_lookup_id'] )
      data.delete('object_lookup_id')
      data.delete('type_lookup_id')
      list.push data
    end
    list
  end

=begin

return all online notifications of an object

  notifications = OnlineNotification.list_by_object( 'Ticket', 123 )

=end

  def self.list_by_object( object_name, o_id)
    object_id = ObjectLookup.by_name( object_name )
    notifications = OnlineNotification.where(
      object_lookup_id: object_id,
      o_id: o_id,
    )
    .order( 'created_at DESC, id DESC' ) # rubocop:disable Style/MultilineOperationIndentation
    .limit( 10_000 ) # rubocop:disable Style/MultilineOperationIndentation
    notifications
  end

=begin

mark online notification as seen by object

  OnlineNotification.seen_by_object( 'Ticket', 123, user_id )

=end

  def self.seen_by_object(object_name, o_id)
    object_id     = ObjectLookup.by_name( object_name )
    notifications = OnlineNotification.where(
      object_lookup_id: object_id,
      o_id: o_id,
      seen: false,
    )
    notifications.each do |notification|
      notification.seen = true
      notification.save
    end
    true
  end

=begin

return all online notifications of an user with assets

  OnlineNotification.list_full( user )

returns:

  list = {
    stream: notifications,
    assets: assets,
  }

=end

  def self.list_full(user, limit)

    notifications = OnlineNotification.list(user, limit)
    assets = ApplicationModel.assets_of_object_list(notifications)
    {
      stream: notifications,
      assets: assets
    }
  end

  def notify_clients_after_change
    Sessions.send_to(
      user_id,
      {
        event: 'OnlineNotification::changed',
        data: {}
      }
    )
  end

=begin

cleanup old online notifications

  OnlineNotification.cleanup

=end

  def self.cleanup
    OnlineNotification.where('created_at < ?', Time.zone.now - 6.months).delete_all
    OnlineNotification.where('seen = ? AND created_at < ?', true, Time.zone.now - 4.hours).delete_all
    OnlineNotification.where('seen = ? AND updated_at < ?', true, Time.zone.now - 1.hour).delete_all

    # notify all agents
    User.of_role('Agent').each {|user|
      Sessions.send_to(
        user.id,
        {
          event: 'OnlineNotification::changed',
          data: {}
        }
      )
      sleep 2 # slow down client requests
    }

    true
  end

end