# -*- coding: utf-8 -*-
## 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 .
##
'''
Message length notifier plugin.
:author: Mateusz Biliński
:since: 1st June 2008
:copyright: Copyright (2008) Mateusz Biliński
:license: GPL
'''
from gi.repository import Gtk
from gi.repository import Gdk
from gajim.plugins import GajimPlugin
from gajim.plugins.helpers import log_calls
from gajim.plugins.gui import GajimPluginConfigDialog
from gajim.plugins.plugins_i18n import _
class LengthNotifierPlugin(GajimPlugin):
@log_calls('LengthNotifierPlugin')
def init(self):
self.description = _('Highlights message entry field in chat window '
'when given length of message is exceeded.')
self.config_dialog = LengthNotifierPluginConfigDialog(self)
self.gui_extension_points = {
'chat_control' : (self.connect_with_chat_control,
self.disconnect_from_chat_control)
}
self.config_default_values = {
'MESSAGE_WARNING_LENGTH' : (140, 'Message length at which notification is invoked.'),
'CHAR_COUNTER': (True, 'Show character count'),
'WARNING_COLOR' : ('#F0DB3E', 'Background color of text entry field in chat window when notification is invoked.'),
'JIDS' : ([], 'JabberIDs that plugin should be used with (eg. restrict only to one microblogging bot). If empty plugin is used with every JID. [not implemented]')
}
@log_calls('LengthNotifierPlugin')
def textview_length_warning(self, tb, chat_control):
tv = chat_control.msg_textview
d = chat_control.length_notifier_plugin_data
if not tv.has_text():
self.counter.set_text('0')
if tv.has_text():
t = tb.get_text(tb.get_start_iter(), tb.get_end_iter(), True)
len_t = len(t)
self.counter.set_text(str(len_t))
if len_t > self.config['MESSAGE_WARNING_LENGTH']:
if not d['prev_color']:
#FIXME: That doesn't work
context = tv.get_style_context()
d['prev_color'] = context.get_background_color(
Gtk.StateFlags.NORMAL)
color = Gdk.RGBA()
Gdk.RGBA.parse(color, self.config['WARNING_COLOR'])
tv.override_background_color(Gtk.StateFlags.NORMAL, color)
elif d['prev_color']:
tv.override_background_color(Gtk.StateFlags.NORMAL,
d['prev_color'])
d['prev_color'] = None
elif d['prev_color']:
tv.override_background_color(Gtk.StateFlags.NORMAL, d['prev_color'])
d['prev_color'] = None
@log_calls('LengthNotifierPlugin')
def connect_with_chat_control(self, chat_control):
jid = chat_control.contact.jid
if self.jid_is_ok(jid):
self._create_counter(chat_control)
d = {'prev_color' : None}
tv = chat_control.msg_textview
tb = tv.get_buffer()
h_id = tb.connect('changed', self.textview_length_warning,
chat_control)
d['h_id'] = h_id
if tv.has_text():
t = tb.get_text(tb.get_start_iter(), tb.get_end_iter(), True)
len_t = len(t)
self.counter.set_text(str(len_t))
if len_t > self.config['MESSAGE_WARNING_LENGTH']:
context = tv.get_style_context()
d['prev_color'] = context.get_background_color(
Gtk.StateFlags.NORMAL)
color = Gdk.RGBA()
Gdk.RGBA.parse(color, self.config['WARNING_COLOR'])
tv.override_background_color(Gtk.StateType.NORMAL, color)
else:
self.counter.set_text('0')
chat_control.length_notifier_plugin_data = d
return True
return False
@log_calls('LengthNotifierPlugin')
def disconnect_from_chat_control(self, chat_control):
try:
actions_hbox = chat_control.xml.get_object('hbox')
actions_hbox.remove(self.counter)
d = chat_control.length_notifier_plugin_data
tv = chat_control.msg_textview
tv.get_buffer().disconnect(d['h_id'])
if d['prev_color']:
tv.override_background_color(Gtk.StateType.NORMAL,
d['prev_color'])
except AttributeError as error:
pass
#log.debug('Length Notifier Plugin was (probably) never connected with this chat window.\n Error: %s' % (error))
@log_calls('LengthNotifierPlugin')
def jid_is_ok(self, jid):
if jid in self.config['JIDS'] or not self.config['JIDS']:
return True
return False
def _create_counter(self, chat_control):
actions_hbox = chat_control.xml.get_object('hbox')
self.counter = Gtk.Label()
self.counter.set_tooltip_text(_('Number of typed characters'))
self.counter.get_style_context().add_class('dim-label')
self.counter.set_no_show_all(True)
actions_hbox.pack_start(self.counter, False, False, 0)
self.toggle_counter()
def toggle_counter(self):
if self.config['CHAR_COUNTER']:
self.counter.show()
else:
self.counter.hide()
class LengthNotifierPluginConfigDialog(GajimPluginConfigDialog):
def init(self):
self.GTK_BUILDER_FILE_PATH = self.plugin.local_file_path(
'config_dialog.ui')
self.xml = Gtk.Builder()
self.xml.set_translation_domain('gajim_plugins')
self.xml.add_objects_from_file(self.GTK_BUILDER_FILE_PATH,
['length_notifier_config_table'])
self.config_table = self.xml.get_object('length_notifier_config_table')
self.get_child().pack_start(self.config_table, False, False, 0)
self.message_length_spinbutton = self.xml.get_object(
'message_length_spinbutton')
self.message_length_spinbutton.get_adjustment().configure(140, 0, 500,
1, 10, 0)
self.char_counter = self.xml.get_object('char_counter')
self.notification_colorbutton = self.xml.get_object(
'notification_colorbutton')
self.jids_entry = self.xml.get_object('jids_entry')
self.xml.connect_signals(self)
def on_run(self):
self.message_length_spinbutton.set_value(self.plugin.config[
'MESSAGE_WARNING_LENGTH'])
color = Gdk.Color.parse(self.plugin.config['WARNING_COLOR'])[1]
self.char_counter.set_active(self.plugin.config['CHAR_COUNTER'])
self.notification_colorbutton.set_color(color)
#self.jids_entry.set_text(self.plugin.config['JIDS'])
self.jids_entry.set_text(','.join(self.plugin.config['JIDS']))
@log_calls('LengthNotifierPluginConfigDialog')
def on_message_length_spinbutton_value_changed(self, spinbutton):
self.plugin.config['MESSAGE_WARNING_LENGTH'] = spinbutton.get_value()
def _on_char_counter_toggled(self, checkbutton):
self.plugin.config['CHAR_COUNTER'] = checkbutton.get_active()
self.plugin.toggle_counter()
@log_calls('LengthNotifierPluginConfigDialog')
def on_notification_colorbutton_color_set(self, colorbutton):
self.plugin.config['WARNING_COLOR'] = colorbutton.get_color().\
to_string()
@log_calls('LengthNotifierPluginConfigDialog')
def on_jids_entry_changed(self, entry):
text = entry.get_text()
if len(text) > 0:
self.plugin.config['JIDS'] = entry.get_text().split(',')
else:
self.plugin.config['JIDS'] = []
@log_calls('LengthNotifierPluginConfigDialog')
def on_jids_entry_editing_done(self, entry):
pass