581 lines
18 KiB
Python
581 lines
18 KiB
Python
# Copyright (C) 2018 Marcin Mielniczuk <marmistrz.dev AT zoho.eu>
|
|
# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com>
|
|
#
|
|
# 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/>.
|
|
|
|
from typing import Any
|
|
from typing import List
|
|
from typing import Tuple
|
|
from typing import Optional
|
|
|
|
import os
|
|
import sys
|
|
import logging
|
|
import xml.etree.ElementTree as ET
|
|
from pathlib import Path
|
|
from functools import wraps
|
|
|
|
from gi.repository import Gdk
|
|
from gi.repository import Gtk
|
|
from gi.repository import GLib
|
|
import cairo
|
|
|
|
from gajim.common import app
|
|
from gajim.common import configpaths
|
|
from gajim.common import i18n
|
|
from gajim.common.i18n import _
|
|
from gajim.common.const import MOODS
|
|
from gajim.common.const import ACTIVITIES
|
|
from gajim.common.const import LOCATION_DATA
|
|
|
|
from gajim.gtk.const import GajimIconSet
|
|
|
|
_icon_theme = Gtk.IconTheme.get_default()
|
|
if _icon_theme is not None:
|
|
_icon_theme.append_search_path(configpaths.get('ICONS'))
|
|
|
|
log = logging.getLogger('gajim.gtk.util')
|
|
|
|
|
|
class NickCompletionGenerator:
|
|
def __init__(self, self_nick: str) -> None:
|
|
self.nick = self_nick
|
|
self.sender_list = [] # type: List[str]
|
|
self.attention_list = [] # type: List[str]
|
|
|
|
def change_nick(self, new_nick: str) -> None:
|
|
self.nick = new_nick
|
|
|
|
def record_message(self, contact: str, highlight: bool) -> None:
|
|
if contact == self.nick:
|
|
return
|
|
|
|
log.debug('Recorded a message from %s, highlight; %s', contact,
|
|
highlight)
|
|
if highlight:
|
|
try:
|
|
self.attention_list.remove(contact)
|
|
except ValueError:
|
|
pass
|
|
if len(self.attention_list) > 6:
|
|
self.attention_list.pop(0) # remove older
|
|
self.attention_list.append(contact)
|
|
|
|
# TODO implement it in a more efficient way
|
|
# Currently it's O(n*m + n*s), where n is the number of participants and
|
|
# m is the number of messages processed, s - the number of times the
|
|
# suggestions are requested
|
|
#
|
|
# A better way to do it would be to keep a dict: contact -> timestamp
|
|
# with expected O(1) insert, and sort it by timestamps in O(n log n)
|
|
# for each suggestion (currently generating the suggestions is O(n))
|
|
# this would give the expected complexity of O(m + s * n log n)
|
|
try:
|
|
self.sender_list.remove(contact)
|
|
except ValueError:
|
|
pass
|
|
self.sender_list.append(contact)
|
|
|
|
def contact_renamed(self, contact_old: str, contact_new: str) -> None:
|
|
log.debug('Contact %s renamed to %s', contact_old, contact_new)
|
|
for lst in (self.attention_list, self.sender_list):
|
|
for idx, contact in enumerate(lst):
|
|
if contact == contact_old:
|
|
lst[idx] = contact_new
|
|
|
|
|
|
def generate_suggestions(self, nicks: List[str],
|
|
beginning: str) -> List[str]:
|
|
"""
|
|
Generate the order of suggested MUC autocompletions
|
|
|
|
`nicks` is the list of contacts currently participating in a MUC
|
|
`beginning` is the text already typed by the user
|
|
"""
|
|
def nick_matching(nick: str) -> bool:
|
|
return nick != self.nick \
|
|
and nick.lower().startswith(beginning.lower())
|
|
|
|
if beginning == '':
|
|
# empty message, so just suggest recent mentions
|
|
potential_matches = self.attention_list
|
|
else:
|
|
# nick partially typed, try completing it
|
|
potential_matches = self.sender_list
|
|
|
|
potential_matches_set = set(potential_matches)
|
|
log.debug('Priority matches: %s', potential_matches_set)
|
|
|
|
matches = [n for n in potential_matches if nick_matching(n)]
|
|
# the most recent nick is the last one on the list
|
|
matches.reverse()
|
|
|
|
# handle people who have not posted/mentioned us
|
|
other_nicks = [
|
|
n for n in nicks if nick_matching(n) and n not in potential_matches_set
|
|
]
|
|
other_nicks.sort(key=str.lower)
|
|
log.debug('Other matches: %s', other_nicks)
|
|
|
|
return matches + other_nicks
|
|
|
|
|
|
class Builder:
|
|
def __init__(self,
|
|
filename: str,
|
|
widgets: List[str] = None,
|
|
domain: str = None,
|
|
gettext_: Any = None) -> None:
|
|
self._builder = Gtk.Builder()
|
|
|
|
if domain is None:
|
|
domain = i18n.DOMAIN
|
|
self._builder.set_translation_domain(domain)
|
|
|
|
if gettext_ is None:
|
|
gettext_ = _
|
|
|
|
file_path = os.path.join(configpaths.get('GUI'), filename)
|
|
|
|
if sys.platform == "win32":
|
|
# This is a workaround for non working translation on Windows
|
|
tree = ET.parse(file_path)
|
|
for node in tree.iter():
|
|
if 'translatable' in node.attrib and node.text is not None:
|
|
node.text = gettext_(node.text)
|
|
|
|
xml_text = ET.tostring(tree.getroot(),
|
|
encoding='unicode',
|
|
method='xml')
|
|
|
|
if widgets is not None:
|
|
self._builder.add_objects_from_string(xml_text, widgets)
|
|
else:
|
|
# Workaround
|
|
# https://gitlab.gnome.org/GNOME/pygobject/issues/255
|
|
Gtk.Builder.__mro__[1].add_from_string(
|
|
self._builder, xml_text, len(xml_text.encode("utf-8")))
|
|
else:
|
|
if widgets is not None:
|
|
self._builder.add_objects_from_file(file_path, widgets)
|
|
else:
|
|
self._builder.add_from_file(file_path)
|
|
|
|
def __getattr__(self, name):
|
|
try:
|
|
return getattr(self._builder, name)
|
|
except AttributeError:
|
|
return self._builder.get_object(name)
|
|
|
|
|
|
def get_builder(file_name: str, widgets: List[str] = None) -> Builder:
|
|
return Builder(file_name, widgets)
|
|
|
|
|
|
def set_urgency_hint(window: Any, setting: bool) -> None:
|
|
if app.config.get('use_urgency_hint'):
|
|
window.set_urgency_hint(setting)
|
|
|
|
|
|
def icon_exists(name: str) -> bool:
|
|
return _icon_theme.has_icon(name)
|
|
|
|
|
|
def load_icon(icon_name, widget=None, size=16, pixbuf=False,
|
|
scale=None, flags=Gtk.IconLookupFlags.FORCE_SIZE):
|
|
|
|
if widget is not None:
|
|
scale = widget.get_scale_factor()
|
|
|
|
if not scale:
|
|
log.warning('Could not determine scale factor')
|
|
scale = 1
|
|
|
|
try:
|
|
iconinfo = _icon_theme.lookup_icon_for_scale(
|
|
icon_name, size, scale, flags)
|
|
if pixbuf:
|
|
return iconinfo.load_icon()
|
|
return iconinfo.load_surface(None)
|
|
except GLib.GError as error:
|
|
log.error('Unable to load icon %s: %s', icon_name, str(error))
|
|
|
|
|
|
def get_app_icon_list(scale_widget):
|
|
pixbufs = []
|
|
for size in (16, 32, 48, 64, 128):
|
|
pixbuf = load_icon('org.gajim.Gajim', scale_widget, size, pixbuf=True)
|
|
if pixbuf is not None:
|
|
pixbufs.append(pixbuf)
|
|
return pixbufs
|
|
|
|
|
|
def get_icon_name(name: str,
|
|
iconset: Optional[str] = None,
|
|
transport: Optional[str] = None) -> str:
|
|
if name == 'not in roster':
|
|
name = 'notinroster'
|
|
|
|
if iconset is not None:
|
|
return '%s-%s' % (iconset, name)
|
|
|
|
if transport is not None:
|
|
return '%s-%s' % (transport, name)
|
|
|
|
iconset = app.config.get('iconset')
|
|
if not iconset:
|
|
iconset = app.config.DEFAULT_ICONSET
|
|
return '%s-%s' % (iconset, name)
|
|
|
|
|
|
def load_user_iconsets():
|
|
iconsets_path = Path(configpaths.get('MY_ICONSETS'))
|
|
if not iconsets_path.exists():
|
|
return
|
|
|
|
for path in iconsets_path.iterdir():
|
|
if not path.is_dir():
|
|
continue
|
|
log.info('Found iconset: %s', path.stem)
|
|
_icon_theme.append_search_path(str(path))
|
|
|
|
|
|
def get_available_iconsets():
|
|
iconsets = []
|
|
for iconset in GajimIconSet:
|
|
iconsets.append(iconset.value)
|
|
|
|
iconsets_path = Path(configpaths.get('MY_ICONSETS'))
|
|
if not iconsets_path.exists():
|
|
return iconsets
|
|
|
|
for path in iconsets_path.iterdir():
|
|
if not path.is_dir():
|
|
continue
|
|
iconsets.append(path.stem)
|
|
return iconsets
|
|
|
|
|
|
def get_total_screen_geometry() -> Tuple[int, int]:
|
|
screen = Gdk.Screen.get_default()
|
|
window = Gdk.Screen.get_root_window(screen)
|
|
width, height = window.get_width(), window.get_height()
|
|
log.debug('Get screen geometry: %s %s', width, height)
|
|
return width, height
|
|
|
|
|
|
def resize_window(window: Gtk.Window, width: int, height: int) -> None:
|
|
"""
|
|
Resize window, but also checks if huge window or negative values
|
|
"""
|
|
screen_w, screen_h = get_total_screen_geometry()
|
|
if not width or not height:
|
|
return
|
|
if width > screen_w:
|
|
width = screen_w
|
|
if height > screen_h:
|
|
height = screen_h
|
|
window.resize(abs(width), abs(height))
|
|
|
|
|
|
def move_window(window: Gtk.Window, pos_x: int, pos_y: int) -> None:
|
|
"""
|
|
Move the window, but also check if out of screen
|
|
"""
|
|
screen_w, screen_h = get_total_screen_geometry()
|
|
if pos_x < 0:
|
|
pos_x = 0
|
|
if pos_y < 0:
|
|
pos_y = 0
|
|
width, height = window.get_size()
|
|
if pos_x + width > screen_w:
|
|
pos_x = screen_w - width
|
|
if pos_y + height > screen_h:
|
|
pos_y = screen_h - height
|
|
window.move(pos_x, pos_y)
|
|
|
|
|
|
def get_completion_liststore(entry: Gtk.Entry) -> Gtk.ListStore:
|
|
"""
|
|
Create a completion model for entry widget completion list consists of
|
|
(Pixbuf, Text) rows
|
|
"""
|
|
completion = Gtk.EntryCompletion()
|
|
liststore = Gtk.ListStore(str, str)
|
|
|
|
render_pixbuf = Gtk.CellRendererPixbuf()
|
|
completion.pack_start(render_pixbuf, False)
|
|
completion.add_attribute(render_pixbuf, 'icon_name', 0)
|
|
|
|
render_text = Gtk.CellRendererText()
|
|
completion.pack_start(render_text, True)
|
|
completion.add_attribute(render_text, 'text', 1)
|
|
completion.set_property('text_column', 1)
|
|
completion.set_model(liststore)
|
|
entry.set_completion(completion)
|
|
return liststore
|
|
|
|
|
|
def get_cursor(attr: str) -> Gdk.Cursor:
|
|
display = Gdk.Display.get_default()
|
|
cursor = getattr(Gdk.CursorType, attr)
|
|
return Gdk.Cursor.new_for_display(display, cursor)
|
|
|
|
|
|
def scroll_to_end(widget: Gtk.ScrolledWindow) -> bool:
|
|
"""Scrolls to the end of a GtkScrolledWindow.
|
|
|
|
Args:
|
|
widget (GtkScrolledWindow)
|
|
|
|
Returns:
|
|
bool: The return value is False so it can be used with GLib.idle_add.
|
|
"""
|
|
adj_v = widget.get_vadjustment()
|
|
if adj_v is None:
|
|
# This can happen when the Widget is already destroyed when called
|
|
# from GLib.idle_add
|
|
return False
|
|
max_scroll_pos = adj_v.get_upper() - adj_v.get_page_size()
|
|
adj_v.set_value(max_scroll_pos)
|
|
|
|
adj_h = widget.get_hadjustment()
|
|
adj_h.set_value(0)
|
|
return False
|
|
|
|
|
|
def at_the_end(widget: Gtk.ScrolledWindow) -> bool:
|
|
"""Determines if a Scrollbar in a GtkScrolledWindow is at the end.
|
|
|
|
Args:
|
|
widget (GtkScrolledWindow)
|
|
|
|
Returns:
|
|
bool: The return value is True if at the end, False if not.
|
|
"""
|
|
adj_v = widget.get_vadjustment()
|
|
max_scroll_pos = adj_v.get_upper() - adj_v.get_page_size()
|
|
return adj_v.get_value() == max_scroll_pos
|
|
|
|
|
|
def get_image_button(icon_name, tooltip, toggle=False):
|
|
if toggle:
|
|
button = Gtk.ToggleButton()
|
|
image = Gtk.Image.new_from_icon_name(icon_name, Gtk.IconSize.MENU)
|
|
button.set_image(image)
|
|
else:
|
|
button = Gtk.Button.new_from_icon_name(icon_name, Gtk.IconSize.MENU)
|
|
button.set_tooltip_text(tooltip)
|
|
return button
|
|
|
|
|
|
def get_image_from_icon_name(icon_name: str, scale: int) -> Any:
|
|
icon = get_icon_name(icon_name)
|
|
surface = _icon_theme.load_surface(icon, 16, scale, None, 0)
|
|
return Gtk.Image.new_from_surface(surface)
|
|
|
|
|
|
def python_month(month: int) -> int:
|
|
return month + 1
|
|
|
|
|
|
def gtk_month(month: int) -> int:
|
|
return month - 1
|
|
|
|
|
|
def convert_rgb_to_hex(rgb_string: str) -> str:
|
|
rgb = Gdk.RGBA()
|
|
rgb.parse(rgb_string)
|
|
rgb.to_color()
|
|
|
|
red = int(rgb.red * 255)
|
|
green = int(rgb.green * 255)
|
|
blue = int(rgb.blue * 255)
|
|
return '#%02x%02x%02x' % (red, green, blue)
|
|
|
|
|
|
def get_monitor_scale_factor() -> int:
|
|
display = Gdk.Display.get_default()
|
|
monitor = display.get_primary_monitor()
|
|
if monitor is None:
|
|
log.warning('Could not determine scale factor')
|
|
return 1
|
|
return monitor.get_scale_factor()
|
|
|
|
|
|
def get_metacontact_surface(icon_name, expanded, scale):
|
|
icon_size = 16
|
|
state_surface = _icon_theme.load_surface(
|
|
icon_name, icon_size, scale, None, 0)
|
|
if 'event' in icon_name:
|
|
return state_surface
|
|
|
|
if expanded:
|
|
icon = get_icon_name('opened')
|
|
expanded_surface = _icon_theme.load_surface(
|
|
icon, icon_size, scale, None, 0)
|
|
else:
|
|
icon = get_icon_name('closed')
|
|
expanded_surface = _icon_theme.load_surface(
|
|
icon, icon_size, scale, None, 0)
|
|
ctx = cairo.Context(state_surface)
|
|
ctx.rectangle(0, 0, icon_size, icon_size)
|
|
ctx.set_source_surface(expanded_surface)
|
|
ctx.fill()
|
|
return state_surface
|
|
|
|
|
|
def get_affiliation_surface(icon_name, affiliation, scale):
|
|
surface = _icon_theme.load_surface(
|
|
icon_name, 16, scale, None, 0)
|
|
|
|
ctx = cairo.Context(surface)
|
|
ctx.rectangle(16 - 4, 16 - 4, 4, 4)
|
|
if affiliation == 'owner':
|
|
ctx.set_source_rgb(204/255, 0, 0)
|
|
elif affiliation == 'admin':
|
|
ctx.set_source_rgb(255/255, 140/255, 0)
|
|
elif affiliation == 'member':
|
|
ctx.set_source_rgb(0, 255/255, 0)
|
|
ctx.fill()
|
|
return surface
|
|
|
|
|
|
def get_show_in_roster(event, session=None):
|
|
"""
|
|
Return True if this event must be shown in roster, else False
|
|
"""
|
|
if event == 'gc_message_received':
|
|
return True
|
|
if event == 'message_received':
|
|
if app.config.get('autopopup_chat_opened'):
|
|
return True
|
|
if session and session.control:
|
|
return False
|
|
return True
|
|
|
|
|
|
def get_show_in_systray(type_, jid):
|
|
"""
|
|
Return True if this event must be shown in systray, else False
|
|
"""
|
|
notify = app.config.notify_for_muc(jid)
|
|
if type_ == 'printed_gc_msg' and not notify:
|
|
# it's not an highlighted message, don't show in systray
|
|
return False
|
|
return app.config.get('trayicon_notification_on_events')
|
|
|
|
|
|
def get_primary_accel_mod():
|
|
"""
|
|
Returns the primary Gdk.ModifierType modifier.
|
|
cmd on osx, ctrl everywhere else.
|
|
"""
|
|
return Gtk.accelerator_parse("<Primary>")[1]
|
|
|
|
|
|
def get_hardware_key_codes(keyval):
|
|
keymap = Gdk.Keymap.get_for_display(Gdk.Display.get_default())
|
|
|
|
valid, key_map_keys = keymap.get_entries_for_keyval(keyval)
|
|
if not valid:
|
|
return []
|
|
return [key.keycode for key in key_map_keys]
|
|
|
|
|
|
def ensure_not_destroyed(func):
|
|
@wraps(func)
|
|
def func_wrapper(self, *args, **kwargs):
|
|
if self._destroyed:
|
|
return
|
|
return func(self, *args, **kwargs)
|
|
return func_wrapper
|
|
|
|
|
|
def ensure_proper_control(func):
|
|
@wraps(func)
|
|
def func_wrapper(self, event):
|
|
if event.account != self.account:
|
|
return
|
|
if event.jid != self.contact.jid:
|
|
return
|
|
return func(self, event)
|
|
return func_wrapper
|
|
|
|
|
|
def format_mood(mood, text):
|
|
if mood is None:
|
|
return ''
|
|
mood = MOODS[mood]
|
|
markuptext = '<b>%s</b>' % GLib.markup_escape_text(mood)
|
|
if text is not None:
|
|
markuptext += ' (%s)' % GLib.markup_escape_text(text)
|
|
return markuptext
|
|
|
|
|
|
def format_activity(activity, subactivity, text):
|
|
if activity is None:
|
|
return
|
|
|
|
if subactivity in ACTIVITIES[activity]:
|
|
subactivity = ACTIVITIES[activity][subactivity]
|
|
activity = ACTIVITIES[activity]['category']
|
|
|
|
markuptext = '<b>' + GLib.markup_escape_text(activity)
|
|
if subactivity:
|
|
markuptext += ': ' + GLib.markup_escape_text(subactivity)
|
|
markuptext += '</b>'
|
|
if text:
|
|
markuptext += ' (%s)' % GLib.markup_escape_text(text)
|
|
return markuptext
|
|
|
|
|
|
def get_activity_icon_name(activity, subactivity=None):
|
|
icon_name = 'activity-%s' % activity.replace('_', '-')
|
|
if subactivity is not None:
|
|
icon_name += '-%s' % subactivity.replace('_', '-')
|
|
return icon_name
|
|
|
|
|
|
def format_tune(artist, length, rating, source, title, track, uri):
|
|
if artist is None and title is None and source is None:
|
|
return
|
|
artist = GLib.markup_escape_text(artist or _('Unknown Artist'))
|
|
title = GLib.markup_escape_text(title or _('Unknown Title'))
|
|
source = GLib.markup_escape_text(source or _('Unknown Source'))
|
|
|
|
tune_string = _('<b>"%(title)s"</b> by <i>%(artist)s</i>\n'
|
|
'from <i>%(source)s</i>') % {'title': title,
|
|
'artist': artist,
|
|
'source': source}
|
|
return tune_string
|
|
|
|
|
|
def format_location(location):
|
|
location = location._asdict()
|
|
location_string = ''
|
|
for attr, value in location.items():
|
|
if value is None:
|
|
continue
|
|
text = GLib.markup_escape_text(value)
|
|
# Translate standard location tag
|
|
tag = LOCATION_DATA.get(attr)
|
|
if tag is None:
|
|
continue
|
|
location_string += '\n<b>%(tag)s</b>: %(text)s' % {
|
|
'tag': tag.capitalize(), 'text': text}
|
|
|
|
return location_string.strip()
|