gajim-plural/src/tooltips.py

657 lines
22 KiB
Python

## tooltips.py
##
## Copyright (C) 2005-2006 Dimitur Kirov <dkirov@gmail.com>
## Copyright (C) 2005-2007 Nikos Kouremenos <kourem@gmail.com>
## Copyright (C) 2005-2006 Yann Le Boulanger <asterix@lagaule.org>
##
## This program 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 2 only.
##
## This program 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.
##
import gtk
import gobject
import os
import time
import locale
import gtkgui_helpers
from common import gajim
from common import helpers
from common import i18n
class BaseTooltip:
''' Base Tooltip class;
Usage:
tooltip = BaseTooltip()
....
tooltip.show_tooltip(data, widget_height, widget_y_position)
....
if tooltip.timeout != 0:
tooltip.hide_tooltip()
* data - the text to be displayed (extenders override this argument and
display more complex contents)
* widget_height - the height of the widget on which we want to show tooltip
* widget_y_position - the vertical position of the widget on the screen
Tooltip is displayed aligned centered to the mouse poiner and 4px below the widget.
In case tooltip goes below the visible area it is shown above the widget.
'''
def __init__(self):
self.timeout = 0
self.preferred_position = [0, 0]
self.win = None
self.id = None
def populate(self, data):
''' this method must be overriden by all extenders
This is the most simple implementation: show data as value of a label
'''
self.create_window()
self.win.add(gtk.Label(data))
def create_window(self):
''' create a popup window each time tooltip is requested '''
self.win = gtk.Window(gtk.WINDOW_POPUP)
self.win.set_border_width(3)
self.win.set_resizable(False)
self.win.set_name('gtk-tooltips')
self.win.set_events(gtk.gdk.POINTER_MOTION_MASK)
self.win.connect_after('expose_event', self.expose)
self.win.connect('size-request', self.on_size_request)
self.win.connect('motion-notify-event', self.motion_notify_event)
self.screen = self.win.get_screen()
def _get_icon_name_for_tooltip(self, contact):
''' helper function used for tooltip contacts/acounts
Tooltip on account has fake contact with sub == '', in this case we show
real status of the account
'''
if contact.ask == 'subscribe':
return 'requested'
elif contact.sub in ('both', 'to', ''):
return contact.show
return 'not in roster'
def motion_notify_event(self, widget, event):
self.hide_tooltip()
def on_size_request(self, widget, requisition):
half_width = requisition.width / 2 + 1
if self.preferred_position[0] < half_width:
self.preferred_position[0] = 0
elif self.preferred_position[0] + requisition.width > \
self.screen.get_width() + half_width:
self.preferred_position[0] = self.screen.get_width() - \
requisition.width
else:
self.preferred_position[0] -= half_width
self.screen.get_height()
if self.preferred_position[1] + requisition.height > \
self.screen.get_height():
# flip tooltip up
self.preferred_position[1] -= requisition.height + \
self.widget_height + 8
if self.preferred_position[1] < 0:
self.preferred_position[1] = 0
self.win.move(self.preferred_position[0], self.preferred_position[1])
def expose(self, widget, event):
style = self.win.get_style()
size = self.win.get_size()
style.paint_flat_box(self.win.window, gtk.STATE_NORMAL, gtk.SHADOW_OUT,
None, self.win, 'tooltip', 0, 0, -1, 1)
style.paint_flat_box(self.win.window, gtk.STATE_NORMAL, gtk.SHADOW_OUT,
None, self.win, 'tooltip', 0, size[1] - 1, -1, 1)
style.paint_flat_box(self.win.window, gtk.STATE_NORMAL, gtk.SHADOW_OUT,
None, self.win, 'tooltip', 0, 0, 1, -1)
style.paint_flat_box(self.win.window, gtk.STATE_NORMAL, gtk.SHADOW_OUT,
None, self.win, 'tooltip', size[0] - 1, 0, 1, -1)
return True
def show_tooltip(self, data, widget_height, widget_y_position):
''' show tooltip on widget.
data contains needed data for tooltip contents
widget_height is the height of the widget on which we show the tooltip
widget_y_position is vertical position of the widget on the screen
'''
# set tooltip contents
self.populate(data)
# get the X position of mouse pointer on the screen
pointer_x = self.screen.get_display().get_pointer()[1]
# get the prefered X position of the tooltip on the screen in case this position is >
# than the height of the screen, tooltip will be shown above the widget
preferred_y = widget_y_position + widget_height + 4
self.preferred_position = [pointer_x, preferred_y]
self.widget_height = widget_height
self.win.ensure_style()
self.win.show_all()
def hide_tooltip(self):
if self.timeout > 0:
gobject.source_remove(self.timeout)
self.timeout = 0
if self.win:
self.win.destroy()
self.win = None
self.id = None
class StatusTable:
''' Contains methods for creating status table. This
is used in Roster and NotificationArea tooltips '''
def __init__(self):
self.current_row = 1
self.table = None
self.text_label = None
self.spacer_label = ' '
def create_table(self):
self.table = gtk.Table(4, 1)
self.table.set_property('column-spacing', 2)
def add_text_row(self, text):
self.text_label = gtk.Label()
self.text_label.set_line_wrap(True)
self.text_label.set_alignment(0, 0)
self.text_label.set_selectable(False)
self.text_label.set_markup(text)
self.table.attach(self.text_label, 1, 4, 1, 2)
def get_status_info(self, resource, priority, show, status):
str_status = resource + ' (' + unicode(priority) + ')'
if status:
status = status.strip()
if status != '':
# make sure 'status' is unicode before we send to to reduce_chars
if isinstance(status, str):
status = unicode(status, encoding='utf-8')
# reduce to 100 chars, 1 line
status = helpers.reduce_chars_newlines(status, 100, 1)
str_status = gobject.markup_escape_text(str_status)
status = gobject.markup_escape_text(status)
str_status += ' - <i>' + status + '</i>'
return str_status
def add_status_row(self, file_path, show, str_status, status_time = None, show_lock = False):
''' appends a new row with status icon to the table '''
self.current_row += 1
state_file = show.replace(' ', '_')
files = []
files.append(os.path.join(file_path, state_file + '.png'))
files.append(os.path.join(file_path, state_file + '.gif'))
image = gtk.Image()
image.set_from_pixbuf(None)
for file in files:
if os.path.exists(file):
image.set_from_file(file)
break
spacer = gtk.Label(self.spacer_label)
image.set_alignment(1, 0.5)
self.table.attach(spacer, 1, 2, self.current_row,
self.current_row + 1, 0, 0, 0, 0)
self.table.attach(image, 2, 3, self.current_row,
self.current_row + 1, gtk.FILL, gtk.FILL, 2, 0)
status_label = gtk.Label()
status_label.set_markup(str_status)
status_label.set_alignment(0, 0)
status_label.set_line_wrap(True)
self.table.attach(status_label, 3, 4, self.current_row,
self.current_row + 1, gtk.FILL | gtk.EXPAND, 0, 0, 0)
if show_lock:
lock_image = gtk.Image()
lock_image.set_from_stock(gtk.STOCK_DIALOG_AUTHENTICATION,
gtk.ICON_SIZE_MENU)
self.table.attach(lock_image, 4, 5, self.current_row,
self.current_row + 1, 0, 0, 0, 0)
class NotificationAreaTooltip(BaseTooltip, StatusTable):
''' Tooltip that is shown in the notification area '''
def __init__(self):
BaseTooltip.__init__(self)
StatusTable.__init__(self)
def fill_table_with_accounts(self, accounts):
iconset = gajim.config.get('iconset')
if not iconset:
iconset = 'dcraven'
file_path = os.path.join(gajim.DATA_DIR, 'iconsets', iconset, '16x16')
for acct in accounts:
message = acct['message']
# before reducing the chars we should assure we send unicode, else
# there are possible pango TBs on 'set_markup'
if isinstance(message, str):
message = unicode(message, encoding = 'utf-8')
message = helpers.reduce_chars_newlines(message, 100, 1)
message = gobject.markup_escape_text(message)
if gajim.con_types.has_key(acct['name']) and \
gajim.con_types[acct['name']] in ('tls', 'ssl'):
show_lock = True
else:
show_lock = False
if message:
self.add_status_row(file_path, acct['show'],
gobject.markup_escape_text(acct['name']) + \
' - ' + message, show_lock=show_lock)
else:
self.add_status_row(file_path, acct['show'],
gobject.markup_escape_text(acct['name'])
, show_lock=show_lock)
def populate(self, data):
self.create_window()
self.create_table()
accounts = helpers.get_accounts_info()
if len(accounts) > 1:
self.table.resize(2, 1)
self.fill_table_with_accounts(accounts)
self.hbox = gtk.HBox()
self.table.set_property('column-spacing', 1)
text = helpers.get_notification_icon_tooltip_text()
text = gobject.markup_escape_text(text)
self.add_text_row(text)
self.hbox.add(self.table)
self.win.add(self.hbox)
class GCTooltip(BaseTooltip):
''' Tooltip that is shown in the GC treeview '''
def __init__(self):
self.account = None
self.text_label = gtk.Label()
self.text_label.set_line_wrap(True)
self.text_label.set_alignment(0, 0)
self.text_label.set_selectable(False)
self.avatar_image = gtk.Image()
BaseTooltip.__init__(self)
def populate(self, contact):
if not contact:
return
self.create_window()
vcard_table = gtk.Table(3, 1)
vcard_table.set_property('column-spacing', 2)
vcard_table.set_homogeneous(False)
vcard_current_row = 1
properties = []
nick_markup = '<b>' + \
gobject.markup_escape_text(contact.get_shown_name()) \
+ '</b>'
properties.append((nick_markup, None))
if contact.status: # status message
status = contact.status.strip()
if status != '':
# escape markup entities
status = helpers.reduce_chars_newlines(status, 100, 5)
status = '<i>' +\
gobject.markup_escape_text(status) + '</i>'
properties.append((status, None))
else: # no status message, show SHOW instead
show = helpers.get_uf_show(contact.show)
show = '<i>' + show + '</i>'
properties.append((show, None))
if contact.jid.strip() != '':
properties.append((_('Jabber ID: '), contact.jid))
if hasattr(contact, 'resource') and contact.resource.strip() != '':
properties.append((_('Resource: '),
gobject.markup_escape_text(contact.resource) ))
if contact.affiliation != 'none':
uf_affiliation = helpers.get_uf_affiliation(contact.affiliation)
affiliation_str = \
_('%(owner_or_admin_or_member)s of this group chat') %\
{'owner_or_admin_or_member': uf_affiliation}
properties.append((affiliation_str, None))
# Add avatar
puny_name = helpers.sanitize_filename(contact.name)
puny_room = helpers.sanitize_filename(contact.room_jid)
file = helpers.get_avatar_path(os.path.join(gajim.AVATAR_PATH, puny_room,
puny_name))
if file:
self.avatar_image.set_from_file(file)
pix = self.avatar_image.get_pixbuf()
pix = gtkgui_helpers.get_scaled_pixbuf(pix, 'tooltip')
self.avatar_image.set_from_pixbuf(pix)
else:
self.avatar_image.set_from_pixbuf(None)
while properties:
property = properties.pop(0)
vcard_current_row += 1
vertical_fill = gtk.FILL
if not properties:
vertical_fill |= gtk.EXPAND
label = gtk.Label()
label.set_alignment(0, 0)
if property[1]:
label.set_markup(property[0])
vcard_table.attach(label, 1, 2, vcard_current_row,
vcard_current_row + 1, gtk.FILL, vertical_fill, 0, 0)
label = gtk.Label()
label.set_alignment(0, 0)
label.set_markup(property[1])
label.set_line_wrap(True)
vcard_table.attach(label, 2, 3, vcard_current_row,
vcard_current_row + 1, gtk.EXPAND | gtk.FILL,
vertical_fill, 0, 0)
else:
label.set_markup(property[0])
vcard_table.attach(label, 1, 3, vcard_current_row,
vcard_current_row + 1, gtk.FILL, vertical_fill, 0)
self.avatar_image.set_alignment(0, 0)
vcard_table.attach(self.avatar_image, 3, 4, 2, vcard_current_row + 1,
gtk.FILL, gtk.FILL | gtk.EXPAND, 3, 3)
self.win.add(vcard_table)
class RosterTooltip(NotificationAreaTooltip):
''' Tooltip that is shown in the roster treeview '''
def __init__(self):
self.account = None
self.image = gtk.Image()
self.image.set_alignment(0, 0)
# padding is independent of the total length and better than alignment
self.image.set_padding(1, 2)
self.avatar_image = gtk.Image()
NotificationAreaTooltip.__init__(self)
def populate(self, contacts):
self.create_window()
self.create_table()
if not contacts or len(contacts) == 0:
# Tooltip for merged accounts row
accounts = helpers.get_accounts_info()
self.table.resize(2, 1)
self.spacer_label = ''
self.fill_table_with_accounts(accounts)
self.win.add(self.table)
return
# primary contact
prim_contact = gajim.contacts.get_highest_prio_contact_from_contacts(
contacts)
puny_jid = helpers.sanitize_filename(prim_contact.jid)
table_size = 3
file = helpers.get_avatar_path(os.path.join(gajim.AVATAR_PATH, puny_jid))
if file:
self.avatar_image.set_from_file(file)
pix = self.avatar_image.get_pixbuf()
pix = gtkgui_helpers.get_scaled_pixbuf(pix, 'tooltip')
self.avatar_image.set_from_pixbuf(pix)
table_size = 4
else:
self.avatar_image.set_from_pixbuf(None)
vcard_table = gtk.Table(table_size, 1)
vcard_table.set_property('column-spacing', 2)
vcard_table.set_homogeneous(False)
vcard_current_row = 1
properties = []
name_markup = u'<span weight="bold">' + \
gobject.markup_escape_text(prim_contact.get_shown_name())\
+ '</span>'
if self.account and prim_contact.jid in gajim.connections[
self.account].blocked_contacts:
name_markup += _(' [blocked]')
if self.account and \
gajim.interface.minimized_controls.has_key(self.account) and \
prim_contact.jid in gajim.interface.minimized_controls[self.account]:
name_markup += _(' [minimized]')
properties.append((name_markup, None))
num_resources = 0
# put contacts in dict, where key is priority
contacts_dict = {}
for contact in contacts:
if contact.resource:
num_resources += 1
if contact.priority in contacts_dict:
contacts_dict[contact.priority].append(contact)
else:
contacts_dict[contact.priority] = [contact]
if num_resources > 1:
properties.append((_('Status: '), ' '))
transport = gajim.get_transport_name_from_jid(
prim_contact.jid)
if transport:
file_path = os.path.join(gajim.DATA_DIR, 'iconsets',
'transports', transport , '16x16')
else:
iconset = gajim.config.get('iconset')
if not iconset:
iconset = 'dcraven'
file_path = os.path.join(gajim.DATA_DIR,
'iconsets', iconset, '16x16')
contact_keys = contacts_dict.keys()
contact_keys.sort()
contact_keys.reverse()
for priority in contact_keys:
for contact in contacts_dict[priority]:
status_line = self.get_status_info(contact.resource,
contact.priority, contact.show, contact.status)
icon_name = self._get_icon_name_for_tooltip(contact)
self.add_status_row(file_path, icon_name, status_line,
contact.last_status_time)
properties.append((self.table, None))
else: # only one resource
if contact.show:
show = helpers.get_uf_show(contact.show)
if contact.last_status_time:
vcard_current_row += 1
if contact.show == 'offline':
text = ' - ' + _('Last status: %s')
else:
text = _(' since %s')
if time.strftime('%j', time.localtime())== \
time.strftime('%j', contact.last_status_time):
# it's today, show only the locale hour representation
local_time = time.strftime('%X',
contact.last_status_time)
else:
# time.strftime returns locale encoded string
local_time = time.strftime('%c',
contact.last_status_time)
local_time = local_time.decode(
locale.getpreferredencoding())
text = text % local_time
show += text
if self.account and \
gajim.gc_connected[self.account].has_key(prim_contact.jid):
if gajim.gc_connected[self.account][prim_contact.jid]:
show = _('Connected')
else:
show = _('Disconnected')
show = '<i>' + show + '</i>'
# we append show below
if contact.status:
status = contact.status.strip()
if status:
# reduce long status
# (no more than 300 chars on line and no more than 5 lines)
# status is wrapped
status = helpers.reduce_chars_newlines(status, 300, 5)
# escape markup entities.
status = gobject.markup_escape_text(status)
properties.append(('<i>%s</i>' % status, None))
properties.append((show, None))
properties.append((_('Jabber ID: '), prim_contact.jid ))
# contact has only one ressource
if num_resources == 1 and contact.resource:
properties.append((_('Resource: '),
gobject.markup_escape_text(contact.resource) +\
' (' + unicode(contact.priority) + ')'))
if self.account and prim_contact.sub and prim_contact.sub != 'both' and\
not gajim.gc_connected[self.account].has_key(prim_contact.jid):
# ('both' is the normal sub so we don't show it)
properties.append(( _('Subscription: '),
gobject.markup_escape_text(helpers.get_uf_sub(prim_contact.sub))))
if prim_contact.keyID:
keyID = None
if len(prim_contact.keyID) == 8:
keyID = prim_contact.keyID
elif len(prim_contact.keyID) == 16:
keyID = prim_contact.keyID[8:]
if keyID:
properties.append((_('OpenPGP: '),
gobject.markup_escape_text(keyID)))
while properties:
property = properties.pop(0)
vcard_current_row += 1
vertical_fill = gtk.FILL
if not properties and table_size == 4:
vertical_fill |= gtk.EXPAND
label = gtk.Label()
label.set_alignment(0, 0)
if property[1]:
label.set_markup(property[0])
vcard_table.attach(label, 1, 2, vcard_current_row,
vcard_current_row + 1, gtk.FILL, vertical_fill, 0, 0)
label = gtk.Label()
label.set_alignment(0, 0)
label.set_markup(property[1])
label.set_line_wrap(True)
vcard_table.attach(label, 2, 3, vcard_current_row,
vcard_current_row + 1, gtk.EXPAND | gtk.FILL,
vertical_fill, 0, 0)
else:
if isinstance(property[0], (unicode, str)): #FIXME: rm unicode?
label.set_markup(property[0])
label.set_line_wrap(True)
else:
label = property[0]
vcard_table.attach(label, 1, 3, vcard_current_row,
vcard_current_row + 1, gtk.FILL, vertical_fill, 0)
self.avatar_image.set_alignment(0, 0)
if table_size == 4:
vcard_table.attach(self.avatar_image, 3, 4, 2,
vcard_current_row + 1, gtk.FILL, gtk.FILL | gtk.EXPAND, 3, 3)
self.win.add(vcard_table)
class FileTransfersTooltip(BaseTooltip):
''' Tooltip that is shown in the notification area '''
def __init__(self):
BaseTooltip.__init__(self)
def populate(self, file_props):
ft_table = gtk.Table(2, 1)
ft_table.set_property('column-spacing', 2)
current_row = 1
self.create_window()
properties = []
name = file_props['name']
if file_props['type'] == 'r':
(file_path, file_name) = os.path.split(file_props['file-name'])
else:
file_name = file_props['name']
properties.append((_('Name: '),
gobject.markup_escape_text(file_name)))
if file_props['type'] == 'r':
type = _('Download')
actor = _('Sender: ')
sender = unicode(file_props['sender']).split('/')[0]
name = gajim.contacts.get_first_contact_from_jid(
file_props['tt_account'], sender).get_shown_name()
else:
type = _('Upload')
actor = _('Recipient: ')
receiver = file_props['receiver']
if hasattr(receiver, 'name'):
name = receiver.get_shown_name()
else:
name = receiver.split('/')[0]
properties.append((_('Type: '), type))
properties.append((actor, gobject.markup_escape_text(name)))
transfered_len = 0
if file_props.has_key('received-len'):
transfered_len = file_props['received-len']
properties.append((_('Transferred: '), helpers.convert_bytes(transfered_len)))
status = ''
if not file_props.has_key('started') or not file_props['started']:
status = _('Not started')
elif file_props.has_key('connected'):
if file_props.has_key('stopped') and \
file_props['stopped'] == True:
status = _('Stopped')
elif file_props['completed']:
status = _('Completed')
elif file_props['connected'] == False:
if file_props['completed']:
status = _('Completed')
else:
if file_props.has_key('paused') and \
file_props['paused'] == True:
status = _('?transfer status:Paused')
elif file_props.has_key('stalled') and \
file_props['stalled'] == True:
#stalled is not paused. it is like 'frozen' it stopped alone
status = _('Stalled')
else:
status = _('Transferring')
else:
status = _('Not started')
properties.append((_('Status: '), status))
while properties:
property = properties.pop(0)
current_row += 1
label = gtk.Label()
label.set_alignment(0, 0)
label.set_markup(property[0])
ft_table.attach(label, 1, 2, current_row, current_row + 1,
gtk.FILL, gtk.FILL, 0, 0)
label = gtk.Label()
label.set_alignment(0, 0)
label.set_line_wrap(True)
label.set_markup(property[1])
ft_table.attach(label, 2, 3, current_row, current_row + 1,
gtk.EXPAND | gtk.FILL, gtk.FILL, 0, 0)
self.win.add(ft_table)
class ServiceDiscoveryTooltip(BaseTooltip):
''' Tooltip that is shown when hovering over a service discovery row '''
def populate(self, status):
self.create_window()
label = gtk.Label()
label.set_line_wrap(True)
label.set_alignment(0, 0)
label.set_selectable(False)
if status == 1:
label.set_text(
_('This service has not yet responded with detailed information'))
elif status == 2:
label.set_text(
_('This service could not respond with detailed information.\n'
'It is most likely legacy or broken'))
self.win.add(label)