558 lines
19 KiB
Python
558 lines
19 KiB
Python
## notify.py
|
|
##
|
|
## Copyright (C) 2005-2006 Yann Le Boulanger <asterix@lagaule.org>
|
|
## Copyright (C) 2005-2007 Nikos Kouremenos <kourem@gmail.com>
|
|
## Copyright (C) 2005-2006 Andrew Sayman <lorien420@myrealbox.com>
|
|
## Copyright (C) 2007 Stephan Erb <steve-e@h3c.de>
|
|
##
|
|
## Notification daemon connection via D-Bus code:
|
|
## Copyright (C) 2005 by Sebastian Estienne
|
|
##
|
|
## This file is part of Gajim.
|
|
##
|
|
## Gajim is free software; you can redistribute it and/or modify
|
|
## it under the terms of the GNU General Public License as published
|
|
## by the Free Software Foundation; version 3 only.
|
|
##
|
|
## Gajim is distributed in the hope that it will be useful,
|
|
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
## GNU General Public License for more details.
|
|
##
|
|
## You should have received a copy of the GNU General Public License
|
|
## along with Gajim. If not, see <http://www.gnu.org/licenses/>.
|
|
##
|
|
|
|
import os
|
|
import time
|
|
import dialogs
|
|
import gobject
|
|
import gtkgui_helpers
|
|
|
|
from common import gajim
|
|
from common import helpers
|
|
|
|
from common import dbus_support
|
|
if dbus_support.supported:
|
|
import dbus
|
|
import dbus.glib
|
|
import dbus.service
|
|
|
|
|
|
USER_HAS_PYNOTIFY = True # user has pynotify module
|
|
try:
|
|
import pynotify
|
|
pynotify.init('Gajim Notification')
|
|
except ImportError:
|
|
USER_HAS_PYNOTIFY = False
|
|
|
|
def get_show_in_roster(event, account, contact):
|
|
'''Return True if this event must be shown in roster, else False'''
|
|
if event == 'gc_message_received':
|
|
return True
|
|
num = get_advanced_notification(event, account, contact)
|
|
if num != None:
|
|
if gajim.config.get_per('notifications', str(num), 'roster') == 'yes':
|
|
return True
|
|
if gajim.config.get_per('notifications', str(num), 'roster') == 'no':
|
|
return False
|
|
if event == 'message_received':
|
|
chat_control = helpers.get_chat_control(account, contact)
|
|
if chat_control:
|
|
return False
|
|
return True
|
|
|
|
def get_show_in_systray(event, account, contact):
|
|
'''Return True if this event must be shown in systray, else False'''
|
|
num = get_advanced_notification(event, account, contact)
|
|
if num != None:
|
|
if gajim.config.get_per('notifications', str(num), 'systray') == 'yes':
|
|
return True
|
|
if gajim.config.get_per('notifications', str(num), 'systray') == 'no':
|
|
return False
|
|
return gajim.config.get('trayicon_notification_on_events')
|
|
|
|
def get_advanced_notification(event, account, contact):
|
|
'''Returns the number of the first (top most)
|
|
advanced notification else None'''
|
|
num = 0
|
|
notif = gajim.config.get_per('notifications', str(num))
|
|
while notif:
|
|
recipient_ok = False
|
|
status_ok = False
|
|
tab_opened_ok = False
|
|
# test event
|
|
if gajim.config.get_per('notifications', str(num), 'event') == event:
|
|
# test recipient
|
|
recipient_type = gajim.config.get_per('notifications', str(num),
|
|
'recipient_type')
|
|
recipients = gajim.config.get_per('notifications', str(num),
|
|
'recipients').split()
|
|
if recipient_type == 'all':
|
|
recipient_ok = True
|
|
elif recipient_type == 'contact' and contact.jid in recipients:
|
|
recipient_ok = True
|
|
elif recipient_type == 'group':
|
|
for group in contact.groups:
|
|
if group in contact.groups:
|
|
recipient_ok = True
|
|
break
|
|
if recipient_ok:
|
|
# test status
|
|
our_status = gajim.SHOW_LIST[gajim.connections[account].connected]
|
|
status = gajim.config.get_per('notifications', str(num), 'status')
|
|
if status == 'all' or our_status in status.split():
|
|
status_ok = True
|
|
if status_ok:
|
|
# test window_opened
|
|
tab_opened = gajim.config.get_per('notifications', str(num),
|
|
'tab_opened')
|
|
if tab_opened == 'both':
|
|
tab_opened_ok = True
|
|
else:
|
|
chat_control = helpers.get_chat_control(account, contact)
|
|
if (chat_control and tab_opened == 'yes') or (not chat_control and \
|
|
tab_opened == 'no'):
|
|
tab_opened_ok = True
|
|
if tab_opened_ok:
|
|
return num
|
|
|
|
num += 1
|
|
notif = gajim.config.get_per('notifications', str(num))
|
|
|
|
def notify(event, jid, account, parameters, advanced_notif_num = None):
|
|
'''Check what type of notifications we want, depending on basic
|
|
and the advanced configuration of notifications and do these notifications;
|
|
advanced_notif_num holds the number of the first (top most) advanced
|
|
notification'''
|
|
# First, find what notifications we want
|
|
do_popup = False
|
|
do_sound = False
|
|
do_cmd = False
|
|
if event == 'status_change':
|
|
new_show = parameters[0]
|
|
status_message = parameters[1]
|
|
# Default: No popup for status change
|
|
elif event == 'contact_connected':
|
|
status_message = parameters
|
|
j = gajim.get_jid_without_resource(jid)
|
|
server = gajim.get_server_from_jid(j)
|
|
account_server = account + '/' + server
|
|
block_transport = False
|
|
if account_server in gajim.block_signed_in_notifications and \
|
|
gajim.block_signed_in_notifications[account_server]:
|
|
block_transport = True
|
|
if helpers.allow_showing_notification(account, 'notify_on_signin') and \
|
|
not gajim.block_signed_in_notifications[account] and not block_transport:
|
|
do_popup = True
|
|
if gajim.config.get_per('soundevents', 'contact_connected',
|
|
'enabled') and not gajim.block_signed_in_notifications[account] and \
|
|
not block_transport:
|
|
do_sound = True
|
|
elif event == 'contact_disconnected':
|
|
status_message = parameters
|
|
if helpers.allow_showing_notification(account, 'notify_on_signout'):
|
|
do_popup = True
|
|
if gajim.config.get_per('soundevents', 'contact_disconnected',
|
|
'enabled'):
|
|
do_sound = True
|
|
elif event == 'new_message':
|
|
message_type = parameters[0]
|
|
is_first_message = parameters[1]
|
|
nickname = parameters[2]
|
|
if gajim.config.get('notification_preview_message'):
|
|
message = parameters[3]
|
|
else:
|
|
# We don't want message preview, do_preview = False
|
|
message = ''
|
|
if helpers.allow_showing_notification(account, 'notify_on_new_message',
|
|
advanced_notif_num, is_first_message):
|
|
do_popup = True
|
|
if is_first_message and helpers.allow_sound_notification(
|
|
'first_message_received', advanced_notif_num):
|
|
do_sound = True
|
|
elif not is_first_message and helpers.allow_sound_notification(
|
|
'next_message_received', advanced_notif_num):
|
|
do_sound = True
|
|
else:
|
|
print '*Event not implemeted yet*'
|
|
|
|
if advanced_notif_num is not None and gajim.config.get_per('notifications',
|
|
str(advanced_notif_num), 'run_command'):
|
|
do_cmd = True
|
|
|
|
# Do the wanted notifications
|
|
if do_popup:
|
|
if event in ('contact_connected', 'contact_disconnected',
|
|
'status_change'): # Common code for popup for these three events
|
|
if event == 'contact_disconnected':
|
|
show_image = 'offline.png'
|
|
suffix = '_notif_size_bw.png'
|
|
else: #Status Change or Connected
|
|
# FIXME: for status change,
|
|
# we don't always 'online.png', but we
|
|
# first need 48x48 for all status
|
|
show_image = 'online.png'
|
|
suffix = '_notif_size_colored.png'
|
|
transport_name = gajim.get_transport_name_from_jid(jid)
|
|
img = None
|
|
if transport_name:
|
|
img = os.path.join(helpers.get_transport_path(transport_name),
|
|
'48x48', show_image)
|
|
if not img or not os.path.isfile(img):
|
|
iconset = gajim.config.get('iconset')
|
|
img = os.path.join(helpers.get_iconset_path(iconset), '48x48',
|
|
show_image)
|
|
path = gtkgui_helpers.get_path_to_generic_or_avatar(img,
|
|
jid = jid, suffix = suffix)
|
|
if event == 'status_change':
|
|
title = _('%(nick)s Changed Status') % \
|
|
{'nick': gajim.get_name_from_jid(account, jid)}
|
|
text = _('%(nick)s is now %(status)s') % \
|
|
{'nick': gajim.get_name_from_jid(account, jid),\
|
|
'status': helpers.get_uf_show(gajim.SHOW_LIST[new_show])}
|
|
if status_message:
|
|
text = text + " : " + status_message
|
|
popup(_('Contact Changed Status'), jid, account,
|
|
path_to_image = path, title = title, text = text)
|
|
elif event == 'contact_connected':
|
|
title = _('%(nickname)s Signed In') % \
|
|
{'nickname': gajim.get_name_from_jid(account, jid)}
|
|
text = ''
|
|
if status_message:
|
|
text = status_message
|
|
popup(_('Contact Signed In'), jid, account,
|
|
path_to_image = path, title = title, text = text)
|
|
elif event == 'contact_disconnected':
|
|
title = _('%(nickname)s Signed Out') % \
|
|
{'nickname': gajim.get_name_from_jid(account, jid)}
|
|
text = ''
|
|
if status_message:
|
|
text = status_message
|
|
popup(_('Contact Signed Out'), jid, account,
|
|
path_to_image = path, title = title, text = text)
|
|
elif event == 'new_message':
|
|
if message_type == 'normal': # single message
|
|
event_type = _('New Single Message')
|
|
img = os.path.join(gajim.DATA_DIR, 'pixmaps', 'events',
|
|
'single_msg_recv.png')
|
|
title = _('New Single Message from %(nickname)s') % \
|
|
{'nickname': nickname}
|
|
text = message
|
|
elif message_type == 'pm': # private message
|
|
event_type = _('New Private Message')
|
|
room_name = gajim.get_nick_from_jid(jid)
|
|
img = os.path.join(gajim.DATA_DIR, 'pixmaps', 'events',
|
|
'priv_msg_recv.png')
|
|
title = _('New Private Message from group chat %s') % room_name
|
|
if message:
|
|
text = _('%(nickname)s: %(message)s') % {'nickname': nickname,
|
|
'message': message}
|
|
else:
|
|
text = _('Messaged by %(nickname)s') % {'nickname': nickname}
|
|
|
|
else: # chat message
|
|
event_type = _('New Message')
|
|
img = os.path.join(gajim.DATA_DIR, 'pixmaps', 'events',
|
|
'chat_msg_recv.png')
|
|
title = _('New Message from %(nickname)s') % \
|
|
{'nickname': nickname}
|
|
text = message
|
|
path = gtkgui_helpers.get_path_to_generic_or_avatar(img)
|
|
popup(event_type, jid, account, message_type,
|
|
path_to_image = path, title = title, text = text)
|
|
|
|
if do_sound:
|
|
snd_file = None
|
|
snd_event = None # If not snd_file, play the event
|
|
if event == 'new_message':
|
|
if advanced_notif_num is not None and gajim.config.get_per(
|
|
'notifications', str(advanced_notif_num), 'sound') == 'yes':
|
|
snd_file = gajim.config.get_per('notifications',
|
|
str(advanced_notif_num), 'sound_file')
|
|
elif advanced_notif_num is not None and gajim.config.get_per(
|
|
'notifications', str(advanced_notif_num), 'sound') == 'no':
|
|
pass # do not set snd_event
|
|
elif is_first_message:
|
|
snd_event = 'first_message_received'
|
|
else:
|
|
snd_event = 'next_message_received'
|
|
elif event in ('contact_connected', 'contact_disconnected'):
|
|
snd_event = event
|
|
if snd_file:
|
|
helpers.play_sound_file(snd_file)
|
|
if snd_event:
|
|
helpers.play_sound(snd_event)
|
|
|
|
if do_cmd:
|
|
command = gajim.config.get_per('notifications', str(advanced_notif_num),
|
|
'command')
|
|
try:
|
|
helpers.exec_command(command)
|
|
except:
|
|
pass
|
|
|
|
def popup(event_type, jid, account, msg_type = '', path_to_image = None,
|
|
title = None, text = None):
|
|
'''Notifies a user of an event. It first tries to a valid implementation of
|
|
the Desktop Notification Specification. If that fails, then we fall back to
|
|
the older style PopupNotificationWindow method.'''
|
|
text = gobject.markup_escape_text(text)
|
|
title = gobject.markup_escape_text(title)
|
|
|
|
if gajim.config.get('use_notif_daemon') and dbus_support.supported:
|
|
try:
|
|
DesktopNotification(event_type, jid, account, msg_type,
|
|
path_to_image, title, text)
|
|
return # sucessfully did D-Bus Notification procedure!
|
|
except dbus.DBusException, e:
|
|
# Connection to D-Bus failed
|
|
gajim.log.debug(str(e))
|
|
except TypeError, e:
|
|
# This means that we sent the message incorrectly
|
|
gajim.log.debug(str(e))
|
|
# we failed to speak to notification daemon via D-Bus
|
|
if USER_HAS_PYNOTIFY: # try via libnotify
|
|
if not text and event_type == 'new_message':
|
|
# empty text for new_message means do_preview = False
|
|
text = gajim.get_name_from_jid(account, jid) # default value of text
|
|
if not title:
|
|
title = event_type
|
|
# default image
|
|
if not path_to_image:
|
|
path_to_image = os.path.abspath(
|
|
os.path.join(gajim.DATA_DIR, 'pixmaps', 'events',
|
|
'chat_msg_recv.png')) # img to display
|
|
|
|
|
|
notification = pynotify.Notification(title, text)
|
|
timeout = gajim.config.get('notification_timeout') * 1000 # make it ms
|
|
notification.set_timeout(timeout)
|
|
|
|
notification.set_category(event_type)
|
|
notification.set_data('event_type', event_type)
|
|
notification.set_data('jid', jid)
|
|
notification.set_data('account', account)
|
|
notification.set_data('msg_type', msg_type)
|
|
notification.set_property('icon-name', path_to_image)
|
|
notification.add_action('default', 'Default Action',
|
|
on_pynotify_notification_clicked)
|
|
|
|
try:
|
|
notification.show()
|
|
return
|
|
except gobject.GError, e:
|
|
# Connection to notification-daemon failed, see #2893
|
|
gajim.log.debug(str(e))
|
|
|
|
# go old style
|
|
instance = dialogs.PopupNotificationWindow(event_type, jid, account,
|
|
msg_type, path_to_image, title, text)
|
|
gajim.interface.roster.popup_notification_windows.append(instance)
|
|
|
|
def on_pynotify_notification_clicked(notification, action):
|
|
jid = notification.get_data('jid')
|
|
account = notification.get_data('account')
|
|
msg_type = notification.get_data('msg_type')
|
|
|
|
notification.close()
|
|
gajim.interface.handle_event(account, jid, msg_type)
|
|
|
|
class NotificationResponseManager:
|
|
'''Collects references to pending DesktopNotifications and manages there
|
|
signalling. This is necessary due to a bug in DBus where you can't remove
|
|
a signal from an interface once it's connected.'''
|
|
def __init__(self):
|
|
self.pending = {}
|
|
self.received = []
|
|
self.interface = None
|
|
|
|
def attach_to_interface(self):
|
|
if self.interface is not None:
|
|
return
|
|
self.interface = dbus_support.get_notifications_interface()
|
|
self.interface.connect_to_signal('ActionInvoked', self.on_action_invoked)
|
|
self.interface.connect_to_signal('NotificationClosed', self.on_closed)
|
|
|
|
def on_action_invoked(self, id, reason):
|
|
self.received.append((id, time.time(), reason))
|
|
if self.pending.has_key(id):
|
|
notification = self.pending[id]
|
|
notification.on_action_invoked(id, reason)
|
|
del self.pending[id]
|
|
if len(self.received) > 20:
|
|
curt = time.time()
|
|
for rec in self.received:
|
|
diff = curt - rec[1]
|
|
if diff > 10:
|
|
self.received.remove(rec)
|
|
|
|
def on_closed(self, id, reason = None):
|
|
if self.pending.has_key(id):
|
|
del self.pending[id]
|
|
|
|
def add_pending(self, id, object):
|
|
# Check to make sure that we handle an event immediately if we're adding
|
|
# an id that's already been triggered
|
|
for rec in self.received:
|
|
if rec[0] == id:
|
|
object.on_action_invoked(id, rec[2])
|
|
self.received.remove(rec)
|
|
return
|
|
if id not in self.pending:
|
|
# Add it
|
|
self.pending[id] = object
|
|
else:
|
|
# We've triggered an event that has a duplicate ID!
|
|
gajim.log.debug('Duplicate ID of notification. Can\'t handle this.')
|
|
|
|
notification_response_manager = NotificationResponseManager()
|
|
|
|
class DesktopNotification:
|
|
'''A DesktopNotification that interfaces with D-Bus via the Desktop
|
|
Notification specification'''
|
|
def __init__(self, event_type, jid, account, msg_type = '',
|
|
path_to_image = None, title = None, text = None):
|
|
self.path_to_image = path_to_image
|
|
self.event_type = event_type
|
|
self.title = title
|
|
self.text = text
|
|
'''0.3.1 is the only version of notification daemon that has no way to determine which version it is. If no method exists, it means they're using that one.'''
|
|
self.default_version = [0, 3, 1]
|
|
self.account = account
|
|
self.jid = jid
|
|
self.msg_type = msg_type
|
|
|
|
# default value of text
|
|
if not text and event_type == 'new_message':
|
|
# empty text for new_message means do_preview = False
|
|
self.text = gajim.get_name_from_jid(account, jid)
|
|
|
|
if not title:
|
|
self.title = event_type # default value
|
|
|
|
if event_type == _('Contact Signed In'):
|
|
ntype = 'presence.online'
|
|
elif event_type == _('Contact Signed Out'):
|
|
ntype = 'presence.offline'
|
|
elif event_type in (_('New Message'), _('New Single Message'),
|
|
_('New Private Message')):
|
|
ntype = 'im.received'
|
|
elif event_type == _('File Transfer Request'):
|
|
ntype = 'transfer'
|
|
elif event_type == _('File Transfer Error'):
|
|
ntype = 'transfer.error'
|
|
elif event_type in (_('File Transfer Completed'), _('File Transfer Stopped')):
|
|
ntype = 'transfer.complete'
|
|
elif event_type == _('New E-mail'):
|
|
ntype = 'email.arrived'
|
|
elif event_type == _('Groupchat Invitation'):
|
|
ntype = 'im.invitation'
|
|
elif event_type == _('Contact Changed Status'):
|
|
ntype = 'presence.status'
|
|
elif event_type == _('Connection Failed'):
|
|
ntype = 'connection.failed'
|
|
else:
|
|
# default failsafe values
|
|
self.path_to_image = os.path.abspath(
|
|
os.path.join(gajim.DATA_DIR, 'pixmaps', 'events',
|
|
'chat_msg_recv.png')) # img to display
|
|
ntype = 'im' # Notification Type
|
|
|
|
self.notif = dbus_support.get_notifications_interface()
|
|
if self.notif is None:
|
|
raise dbus.DBusException('unable to get notifications interface')
|
|
self.ntype = ntype
|
|
|
|
self.get_version()
|
|
|
|
def attempt_notify(self):
|
|
version = self.version
|
|
timeout = gajim.config.get('notification_timeout') # in seconds
|
|
ntype = self.ntype
|
|
if version[:2] == [0, 2]:
|
|
try:
|
|
self.notif.Notify(
|
|
dbus.String(_('Gajim')),
|
|
dbus.String(self.path_to_image),
|
|
dbus.UInt32(0),
|
|
ntype,
|
|
dbus.Byte(0),
|
|
dbus.String(self.title),
|
|
dbus.String(self.text),
|
|
[dbus.String(self.path_to_image)],
|
|
{'default': 0},
|
|
[''],
|
|
True,
|
|
dbus.UInt32(timeout),
|
|
reply_handler=self.attach_by_id,
|
|
error_handler=self.notify_another_way)
|
|
except AttributeError:
|
|
version = [0, 3, 1] # we're actually dealing with the newer version
|
|
if version > [0, 3]:
|
|
if version >= [0, 3, 2]:
|
|
hints = {}
|
|
hints['urgency'] = dbus.Byte(0) # Low Urgency
|
|
hints['category'] = dbus.String(ntype)
|
|
self.notif.Notify(
|
|
dbus.String(_('Gajim')),
|
|
dbus.UInt32(0), # this notification does not replace other
|
|
dbus.String(self.path_to_image),
|
|
dbus.String(self.title),
|
|
dbus.String(self.text),
|
|
( dbus.String('default'), dbus.String(self.event_type) ),
|
|
hints,
|
|
dbus.UInt32(timeout*1000),
|
|
reply_handler=self.attach_by_id,
|
|
error_handler=self.notify_another_way)
|
|
else:
|
|
self.notif.Notify(
|
|
dbus.String(_('Gajim')),
|
|
dbus.String(self.path_to_image),
|
|
dbus.UInt32(0),
|
|
dbus.String(self.title),
|
|
dbus.String(self.text),
|
|
dbus.String(''),
|
|
{},
|
|
dbus.UInt32(timeout*1000),
|
|
reply_handler=self.attach_by_id,
|
|
error_handler=self.notify_another_way)
|
|
|
|
def attach_by_id(self, id):
|
|
self.id = id
|
|
notification_response_manager.attach_to_interface()
|
|
notification_response_manager.add_pending(self.id, self)
|
|
|
|
def notify_another_way(self,e):
|
|
gajim.log.debug(str(e))
|
|
gajim.log.debug('Need to implement a new way of falling back')
|
|
|
|
def on_action_invoked(self, id, reason):
|
|
if self.notif is None:
|
|
return
|
|
self.notif.CloseNotification(dbus.UInt32(id))
|
|
self.notif = None
|
|
if not self.msg_type:
|
|
self.msg_type = 'chat'
|
|
gajim.interface.handle_event(self.account, self.jid, self.msg_type)
|
|
|
|
def version_reply_handler(self, name, vendor, version, spec_version = None):
|
|
version_list = version.split('.')
|
|
self.version = []
|
|
while len(version_list):
|
|
self.version.append(int(version_list.pop(0)))
|
|
self.attempt_notify()
|
|
|
|
def get_version(self):
|
|
self.notif.GetServerInfo(
|
|
reply_handler=self.version_reply_handler,
|
|
error_handler=self.version_error_handler_2_x_try)
|
|
|
|
def version_error_handler_2_x_try(self, e):
|
|
self.notif.GetServerInformation(reply_handler=self.version_reply_handler,
|
|
error_handler=self.version_error_handler_3_x_try)
|
|
|
|
def version_error_handler_3_x_try(self, e):
|
|
self.version = self.default_version
|
|
self.attempt_notify()
|