trabajo-afectivo/public/assets/chat/chat.coffee

459 lines
13 KiB
CoffeeScript
Raw Normal View History

2015-10-15 09:14:19 +00:00
do($ = window.jQuery, window) ->
# Define the plugin class
class ZammadChat
defaults:
invitationPhrase: '<strong>Chat</strong> with us!'
agentPhrase: ' is helping you'
2015-10-15 09:14:19 +00:00
show: true
target: $('body')
_messageCount: 0
2015-10-15 09:14:19 +00:00
isOpen: false
blinkOnlineInterval: null
stopBlinOnlineStateTimeout: null
showTimeEveryXMinutes: 1
lastTimestamp: null
lastAddedType: null
inputTimeout: null
isTyping: false
isOnline: true
initialQueueDelay: 10000,
debug: true
host: 'ws://localhost:6042'
2015-10-15 09:14:19 +00:00
strings:
'Online': 'Online'
'Offline': 'Offline'
'Connecting': 'Verbinden'
2015-10-15 09:14:19 +00:00
'Connection re-established': 'Connection re-established'
'Today': 'Heute'
'Send': 'Senden'
'Compose your message...': 'Ihre Nachricht...'
'All colleges are busy.': 'Alle Kollegen sind belegt.'
'You are on waiting list position <strong>%s</strong>.': 'Sie sind in der Warteliste an der Position <strong>%s</strong>.'
'': ''
'': ''
'': ''
2015-11-12 10:44:37 +00:00
sessionId: undefined
T: (string, items...) =>
if !@strings[string]
@log 'notice', "Translation needed for '#{string}'"
translation = @strings[string] || string
if items
for item in items
translation = translation.replace(/%s/, item)
translation
log: (level, string...) =>
return if !@debug && level is 'debug'
console.log level, string
2015-10-15 09:14:19 +00:00
view: (name) =>
return (options) =>
if !options
options = {}
options.T = @T
return window.zammadChatTemplates[name](options)
2015-10-15 09:14:19 +00:00
constructor: (el, options) ->
@options = $.extend {}, @defaults, options
@el = $(@view('chat')(@options))
2015-10-15 09:14:19 +00:00
@options.target.append @el
@input = @el.find('.zammad-chat-input')
2015-11-11 10:44:10 +00:00
@el.find('.js-chat-open').click @open
@el.find('.js-chat-close').click @close
2015-10-15 09:14:19 +00:00
@el.find('.zammad-chat-controls').on 'submit', @onSubmit
@input.on
2015-10-15 09:14:19 +00:00
keydown: @checkForEnter
input: @onInput
if !window.WebSocket or !sessionStorage
@log 'notice', 'Chat: Browser not supported!'
2015-10-15 15:07:18 +00:00
return
@connect()
2015-10-15 15:07:18 +00:00
#@onReady()
2015-11-11 10:44:10 +00:00
2015-10-15 09:14:19 +00:00
checkForEnter: (event) =>
if not event.shiftKey and event.keyCode is 13
event.preventDefault()
@sendMessage()
2015-11-10 14:01:04 +00:00
send: (event, data) =>
@log 'debug', 'ws:send', event, data
pipe = JSON.stringify
2015-11-10 14:01:04 +00:00
event: event
data: data
@ws.send pipe
onWebSocketMessage: (e) =>
2015-11-10 14:01:04 +00:00
pipes = JSON.parse( e.data )
for pipe in pipes
@log 'debug', 'ws:onmessage', pipe
2015-11-10 14:01:04 +00:00
switch pipe.event
when 'chat_session_message'
return if pipe.data.self_written
@receiveMessage pipe.data
when 'chat_session_typing'
return if pipe.data.self_written
@onAgentTypingStart()
when 'chat_session_start'
@onConnectionEstablished pipe.data
2015-11-12 10:44:37 +00:00
when 'chat_session_queue'
@onQueue pipe.data
when 'chat_session_closed'
@onSessionClosed pipe.data
when 'chat_session_left'
@onSessionClosed pipe.data
2015-11-11 10:24:19 +00:00
when 'chat_status_customer'
2015-11-10 14:01:04 +00:00
switch pipe.data.state
when 'online'
@onReady()
@log 'debug', 'Zammad Chat: ready'
2015-11-10 14:01:04 +00:00
when 'offline'
@log 'debug', 'Zammad Chat: No agent online'
2015-11-10 14:01:04 +00:00
when 'chat_disabled'
@log 'debug', 'Zammad Chat: Chat is disabled'
2015-11-10 14:01:04 +00:00
when 'no_seats_available'
@log 'debug', 'Zammad Chat: Too many clients in queue. Clients in queue: ', pipe.data.queue
when 'reconnect'
@log 'debug', 'old messages', pipe.data.session
@openSession pipe.data.session
onReady: =>
2015-11-11 09:48:54 +00:00
if @options.show
@show()
openSession: (session) =>
for message in session
console.log "message in session", message
@renderMessage
message: message.content
id: message.id
from: if message.created_by_id then 'agent' else 'customer'
if sessionStorage.getItem 'unfinished_message'
@input.val( sessionStorage.getItem('unfinished_message') ).focus()
@show()
@open
showLoader: false
animate: false
2015-10-15 09:14:19 +00:00
onInput: =>
# remove unread-state from messages
@el.find('.zammad-chat-message--unread')
.removeClass 'zammad-chat-message--unread'
sessionStorage.setItem 'unfinished_message', @input.val()
2015-11-10 14:01:04 +00:00
@onTypingStart()
2015-10-15 09:14:19 +00:00
2015-11-10 14:01:04 +00:00
onTypingStart: ->
2015-10-15 09:14:19 +00:00
2015-11-10 14:01:04 +00:00
clearTimeout(@isTypingTimeout) if @isTypingTimeout
# fire typingEnd after 5 seconds
@isTypingTimeout = setTimeout @onTypingEnd, 1500
2015-10-15 09:14:19 +00:00
# send typing start event
2015-11-10 14:01:04 +00:00
if !@isTyping
@isTyping = true
@send 'chat_session_typing',
2015-11-12 10:44:37 +00:00
session_id: @sessionId
2015-10-15 09:14:19 +00:00
onTypingEnd: =>
@isTyping = false
onSubmit: (event) =>
event.preventDefault()
@sendMessage()
sendMessage: ->
message = @input.val()
2015-10-15 09:14:19 +00:00
return if !message
2015-10-15 09:14:19 +00:00
sessionStorage.removeItem 'unfinished_message'
messageElement = @view('message')
message: message
from: 'customer'
id: @_messageCount++
2015-10-15 09:14:19 +00:00
@maybeAddTimestamp()
2015-10-15 09:14:19 +00:00
# add message before message typing loader
if @el.find('.zammad-chat-message--typing').size()
@lastAddedType = 'typing-placeholder'
2015-11-11 10:24:19 +00:00
@el.find('.zammad-chat-message--typing').before messageElement
else
@lastAddedType = 'message--customer'
@el.find('.zammad-chat-body').append messageElement
2015-10-15 09:14:19 +00:00
@el.find('.zammad-chat-input').val('')
@scrollToBottom()
2015-10-15 09:14:19 +00:00
@isTyping = false
# send message event
2015-11-10 14:01:04 +00:00
@send 'chat_session_message',
content: message
id: @_messageCount
2015-11-12 10:44:37 +00:00
session_id: @sessionId
receiveMessage: (data) =>
2015-10-15 09:14:19 +00:00
# hide writing indicator
@onAgentTypingEnd()
@maybeAddTimestamp()
@renderMessage
2015-11-10 14:01:04 +00:00
message: data.message.content
id: data.id
2015-10-15 09:26:56 +00:00
from: 'agent'
renderMessage: (data) =>
@lastAddedType = "message--#{ data.from }"
unread = document.hidden ? " zammad-chat-message--unread" : ""
@el.find('.zammad-chat-body').append @view('message')(data)
2015-10-15 09:14:19 +00:00
@scrollToBottom()
open: (options = { showLoader: true, animate: true }) =>
2015-11-11 10:44:10 +00:00
return if @isOpen
2015-10-15 09:14:19 +00:00
if options.showLoader
@showLoader()
2015-10-15 09:14:19 +00:00
@el
.addClass('zammad-chat-is-open')
if options.animate
@el.animate { bottom: 0 }, 500, @onOpenAnimationEnd
else
@el.css 'bottom', 0
@onOpenAnimationEnd()
2015-10-15 09:14:19 +00:00
@isOpen = true
2015-11-11 10:44:10 +00:00
onOpenAnimationEnd: =>
#setTimeout @onQueue, 1180
# setTimeout @onConnectionEstablished, 1180
# setTimeout @onAgentTypingStart, 2000
# setTimeout @receiveMessage, 5000, "Hello! How can I help you?"
@session_init()
2015-10-15 09:14:19 +00:00
2015-11-11 10:44:10 +00:00
close: (event) =>
event.stopPropagation() if event
@ws.close()
sessionStorage.removeItem 'sessionId'
sessionStorage.removeItem 'unfinished_message'
@closeWindow()
closeWindow: =>
2015-10-15 09:14:19 +00:00
remainerHeight = @el.height() - @el.find('.zammad-chat-header').outerHeight()
2015-10-15 13:28:30 +00:00
@el.animate { bottom: -remainerHeight }, 500, @onCloseAnimationEnd
2015-10-15 09:14:19 +00:00
onCloseAnimationEnd: =>
@el.removeClass('zammad-chat-is-open')
@disconnect()
@isOpen = false
@send 'chat_session_close',
2015-11-12 10:44:37 +00:00
session_id: @sessionId
2015-10-15 09:14:19 +00:00
hide: ->
@el.removeClass('zammad-chat-is-visible')
show: ->
@el.addClass('zammad-chat-is-visible')
2015-10-15 13:28:30 +00:00
remainerHeight = @el.outerHeight() - @el.find('.zammad-chat-header').outerHeight()
2015-10-15 09:14:19 +00:00
@el.css 'bottom', -remainerHeight
@el.find('.zammad-chat-input').autoGrow
extraLine: false
disableInput: ->
@el.find('.zammad-chat-input').prop('disabled', true)
@el.find('.zammad-chat-send').prop('disabled', true)
enableInput: ->
@el.find('.zammad-chat-input').prop('disabled', false)
@el.find('.zammad-chat-send').prop('disabled', false)
onQueueScreen: (data) =>
# delay initial queue position, show connecting first
show = =>
@onQueue data.position
if @initialQueueDelay && !@onInitialQueueDelayId
@onInitialQueueDelayId = setTimeout(show, @initialQueueDelay)
return
# stop delay of initial queue position
if @onInitialQueueDelayId
clearTimeout(@onInitialQueueDelayId)
# show queue position
show()
onQueue: (position) =>
@log 'notice', 'onQueue', position
@inQueue = true
@setSessionId data.session_id
@el.find('.zammad-chat-body').html @view('waiting')
position: data.position
2015-10-15 09:14:19 +00:00
onAgentTypingStart: =>
2015-11-11 10:24:19 +00:00
if @stopTypingId
clearTimeout(@stopTypingId)
@stopTypingId = setTimeout(@onAgentTypingEnd, 3000)
# never display two typing indicators
2015-10-15 09:14:19 +00:00
return if @el.find('.zammad-chat-message--typing').size()
@maybeAddTimestamp()
@el.find('.zammad-chat-body').append @view('typingIndicator')()
@scrollToBottom()
onAgentTypingEnd: =>
@el.find('.zammad-chat-message--typing').remove()
maybeAddTimestamp: ->
timestamp = Date.now()
2015-10-15 09:26:56 +00:00
if !@lastTimestamp or (timestamp - @lastTimestamp) > @showTimeEveryXMinutes * 60000
2015-10-15 09:14:19 +00:00
label = @T('Today')
time = new Date().toTimeString().substr 0,5
if @lastAddedType is 'timestamp'
# update last time
@updateLastTimestamp label, time
@lastTimestamp = timestamp
else
# add new timestamp
@addStatus label, time
@lastTimestamp = timestamp
@lastAddedType = 'timestamp'
updateLastTimestamp: (label, time) ->
@el.find('.zammad-chat-body')
.find('.zammad-chat-status')
.last()
.replaceWith @view('status')
label: label
time: time
addStatus: (label, time) ->
2015-10-15 09:26:56 +00:00
@el.find('.zammad-chat-body').append @view('status')
2015-10-15 09:14:19 +00:00
label: label
time: time
scrollToBottom: ->
@el.find('.zammad-chat-body').scrollTop($('.zammad-chat-body').prop('scrollHeight'))
session_init: ->
2015-11-10 14:01:04 +00:00
@send('chat_session_init')
2015-10-15 09:14:19 +00:00
connect: =>
@log 'notice', "Connecting to #{@host}"
@ws = new window.WebSocket(@host)
@ws.onopen = @onWebSocketOpen
@ws.onmessage = @onWebSocketMessage
@ws.onclose = (e) =>
@log 'debug', 'close websocket connection'
@reconnect()
@setAgentOnlineState(false)
@ws.onerror = (e) =>
@log 'debug', 'ws:onerror', e
onWebSocketOpen: =>
@sessionId = sessionStorage.getItem('sessionId')
@log 'debug', 'ws connected'
@send 'chat_status_customer',
session_id: @sessionId
@setAgentOnlineState(true)
2015-10-15 09:14:19 +00:00
reconnect: =>
# set status to connecting
@log 'notice', 'reconnecting'
@disableInput()
2015-10-15 09:14:19 +00:00
@lastAddedType = 'status'
@el.find('.zammad-chat-agent-status').attr('data-status', 'connecting').text @T('Reconnecting')
2015-10-15 09:14:19 +00:00
@addStatus @T('Connection lost')
if @reconnectDelayId
clearTimeout(@reconnectDelayId)
@reconnectDelayId = setTimeout(@connect, 5000)
2015-10-15 09:14:19 +00:00
onConnectionReestablished: =>
# set status back to online
@lastAddedType = 'status'
@el.find('.zammad-chat-agent-status').attr('data-status', 'online').text @T('Online')
@addStatus @T('Connection re-established')
onSessionClosed: (data) ->
@addStatus @T('Chat closed by %s', data.realname)
@disableInput()
2015-10-15 09:14:19 +00:00
disconnect: ->
@showLoader()
@el.find('.zammad-chat-welcome').removeClass('zammad-chat-is-hidden')
@el.find('.zammad-chat-agent').addClass('zammad-chat-is-hidden')
@el.find('.zammad-chat-agent-status').addClass('zammad-chat-is-hidden')
onConnectionEstablished: (agent) =>
# stop delay of initial queue position
if @onInitialQueueDelayId
clearTimeout(@onInitialQueueDelayId)
@inQueue = false
@agent = data.agent
@setSessionId data.session_id
@el.find('.zammad-chat-agent').html @view('agent')
agent: @agent
@enableInput()
@el.find('.zammad-chat-body').empty()
@el.find('.zammad-chat-welcome').addClass('zammad-chat-is-hidden')
@el.find('.zammad-chat-agent').removeClass('zammad-chat-is-hidden')
@el.find('.zammad-chat-agent-status').removeClass('zammad-chat-is-hidden')
@el.find('.zammad-chat-input').focus()
showLoader: ->
@el.find('.zammad-chat-body').html @view('loader')()
2015-10-15 09:14:19 +00:00
setAgentOnlineState: (state) =>
@isOnline = state
@el
.find('.zammad-chat-agent-status')
.toggleClass('zammad-chat-is-online', state)
.text if state then @T('Online') else @T('Offline')
$(document).ready ->
window.zammadChat = new ZammadChat()