length_notifier/ 0000775 0001755 0001755 00000000000 14760551532 014002 5 ustar debacle debacle length_notifier/__init__.py 0000664 0001755 0001755 00000000122 14760551532 016106 0 ustar debacle debacle from .length_notifier import LengthNotifierPlugin # pyright: ignore # noqa: F401
length_notifier/config_dialog.py 0000664 0001755 0001755 00000005610 14760551532 017142 0 ustar debacle debacle # 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, either version 3 of the License, or
# (at your option) any later version.
#
# 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 .
from __future__ import annotations
from typing import Any
from typing import TYPE_CHECKING
from gi.repository import Gtk
from gajim.gtk.const import Setting
from gajim.gtk.const import SettingKind
from gajim.gtk.const import SettingType
from gajim.gtk.settings import SettingsDialog
from gajim.plugins.plugins_i18n import _
if TYPE_CHECKING:
from .length_notifier import LengthNotifierPlugin
class LengthNotifierConfigDialog(SettingsDialog):
def __init__(self, plugin: LengthNotifierPlugin, parent: Gtk.Window) -> None:
self.plugin = plugin
jids = self.plugin.config["JIDS"] or ""
if isinstance(jids, list):
# Gajim 1.0 stored this as list[str]
jids = ",".join(jids)
settings = [
Setting(
SettingKind.SPIN,
_("Message Length"),
SettingType.VALUE,
str(self.plugin.config["MESSAGE_WARNING_LENGTH"]),
callback=self._on_setting,
data="MESSAGE_WARNING_LENGTH",
desc=_("Message length at which the highlight is shown"),
props={"range_": (1, 1000, 1)},
),
Setting(
SettingKind.COLOR,
_("Color"),
SettingType.VALUE,
self.plugin.config["WARNING_COLOR"],
callback=self._on_setting,
data="WARNING_COLOR",
desc=_("Highlight color for the message input"),
),
Setting(
SettingKind.ENTRY,
_("Selected Addresses"),
SettingType.VALUE,
jids,
callback=self._on_setting,
data="JIDS",
desc=_(
"Enable the plugin for selected XMPP addresses "
"only (comma separated)"
),
),
]
SettingsDialog.__init__(
self,
parent,
_("Length Notifier Configuration"),
Gtk.DialogFlags.MODAL,
settings,
"",
)
def _on_setting(self, value: Any, data: Any) -> None:
if isinstance(value, str):
value.strip()
self.plugin.config[data] = value
self.plugin.update()
length_notifier/length_notifier.png 0000664 0001755 0001755 00000000662 14760551532 017674 0 ustar debacle debacle PNG
IHDR a tEXtSoftware Adobe ImageReadyqe< TIDATxb,\(H8YIM^UK$ݷݳw&* ' \?!r N`_<%! if/Veb#÷?L _Bw02L7A}a] J KU}ŀ}tx]!!H"]?`d/#
j1\p7=n>K_fcD2, &`x
t0!ꅃ]!AQAG
KL | / }5ӈ = , d,gff&%7(0 $& IENDB` length_notifier/length_notifier.py 0000664 0001755 0001755 00000017235 14760551532 017544 0 ustar debacle debacle # 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 __future__ import annotations
from typing import Any
from typing import cast
import logging
from functools import partial
from gi.repository import Gdk
from gi.repository import GObject
from gi.repository import Gtk
from nbxmpp.protocol import JID
from gajim.common import app
from gajim.common import types
from gajim.gtk.message_actions_box import MessageActionsBox
from gajim.gtk.message_input import MessageInputTextView
from gajim.plugins import GajimPlugin
from gajim.plugins.gajimplugin import GajimPluginConfig
from gajim.plugins.plugins_i18n import _
from length_notifier.config_dialog import LengthNotifierConfigDialog
log = logging.getLogger("gajim.p.length_notifier")
class LengthNotifierPlugin(GajimPlugin):
def init(self) -> None:
self.description = _(
"Highlights the chat window’s message input if "
"a specified message length is exceeded."
)
self.config_dialog = partial(LengthNotifierConfigDialog, self)
self.gui_extension_points = {
"message_actions_box": (self._message_actions_box_created, None),
"switch_contact": (self._on_switch_contact, None),
}
self.config_default_values = {
"MESSAGE_WARNING_LENGTH": (
140,
"Message length at which the highlight is shown",
),
"WARNING_COLOR": (
"rgb(240, 220, 60)",
"Highlight color for the message input",
),
"JIDS": (
"",
"Enable the plugin for selected XMPP addresses "
"only (comma separated)",
),
}
self._message_action_box = None
self._actions_box_widget = None
self._counter = None
self._contact = None
def activate(self) -> None:
if self._counter is not None and self._contact is not None:
self._counter.update_contact(self._contact)
def deactivate(self) -> None:
assert self._counter is not None
assert self._actions_box_widget is not None
self._counter.reset()
self._actions_box_widget.remove(self._counter)
del self._counter
def _create_counter(self) -> None:
assert self._message_action_box is not None
assert self._actions_box_widget is not None
self._counter = Counter(self._message_action_box.msg_textview, self.config)
self._actions_box_widget.append(self._counter)
def _message_actions_box_created(
self, message_actions_box: MessageActionsBox, gtk_box: Gtk.Box
) -> None:
self._message_action_box = message_actions_box
self._actions_box_widget = gtk_box
self._create_counter()
def _on_switch_contact(self, contact: types.ChatContactT) -> None:
assert self._counter is not None
self._contact = contact
self._counter.update_contact(contact)
def update(self):
assert self._counter is not None
if self._contact is not None:
self._counter.update_config(self.config)
class Counter(Gtk.Label):
def __init__(
self, message_input: MessageInputTextView, config: GajimPluginConfig
) -> None:
Gtk.Label.__init__(self)
self.set_tooltip_text(_("Number of typed characters"))
self.add_css_class("dim-label")
self._config = config
self._contact = None
self._max_length = None
self._color = None
self._inverted_color = None
self._provider = Gtk.CssProvider()
self._textview = message_input
context = self._textview.get_style_context()
context.add_provider(self._provider, Gtk.STYLE_PROVIDER_PRIORITY_USER)
self._signal_id = self._textview.connect("buffer-changed", self._update)
self._parse_config()
self._set_css()
def do_unroot(self) -> None:
if GObject.signal_handler_is_connected(self._textview, self._signal_id):
self._textview.disconnect(self._signal_id)
self._textview.get_style_context().remove_provider(self._provider)
del self._config
del self._provider
del self._textview
app.check_finalize(self)
def _parse_config(self) -> None:
self._max_length = cast(int, self._config["MESSAGE_WARNING_LENGTH"])
self._color = cast(str, self._config["WARNING_COLOR"])
rgba = Gdk.RGBA()
rgba.parse(self._color)
red = int(255 - rgba.red * 255)
green = int(255 - rgba.green * 255)
blue = int(255 - rgba.blue * 255)
self._inverted_color = f"rgb({red}, {green}, {blue})"
def _set_css(self) -> None:
css = """
.length-warning {
color: %s;
background-color: %s;
}
""" % (
self._inverted_color,
self._color,
)
self._provider.load_from_string(css)
def _set_count(self, count: int) -> None:
self.set_label(str(count))
def _update(self, *args: Any) -> bool:
if self._contact is None:
return False
enable = self._jid_allowed(self._contact.jid)
if enable:
self.show()
else:
self.hide()
assert self._max_length is not None
if self._textview.has_text and enable:
text = self._textview.get_text()
len_text = len(text)
self._set_count(len_text)
if len_text > self._max_length:
self._textview.add_css_class("length-warning")
else:
self._textview.remove_css_class("length-warning")
else:
self._set_count(0)
self._textview.remove_css_class("length-warning")
return False
def _jid_allowed(self, current_jid: JID) -> bool:
jids = cast(str, self._config["JIDS"])
assert isinstance(jids, str)
if not jids:
# Not restricted to any JIDs
return True
allowed_jids = jids.split(",")
for allowed_jid in allowed_jids:
try:
address = JID.from_string(allowed_jid.strip())
except Exception as error:
log.error("Error parsing JID: %s (%s)", error, allowed_jid)
continue
if address.is_domain:
if current_jid.domain == address:
log.debug("Show counter for Domain %s", address)
return True
if current_jid == address:
log.debug("Show counter for JID %s", address)
return True
return False
def update_config(self, config: GajimPluginConfig) -> None:
self._config = config
self.reset()
self._update()
def update_contact(self, contact: types.ChatContactT) -> None:
self._contact = contact
self._update()
def reset(self) -> None:
self._textview.remove_css_class("length-warning")
self._parse_config()
self._set_css()
length_notifier/org.gajim.Gajim.Plugin.length_notifier.metainfo.xml 0000664 0001755 0001755 00000001020 14760551532 025635 0 ustar debacle debacle
org.gajim.Gajim.Plugin.length_notifier
org.gajim.Gajim
Message Length Notifier Plugin
Highlight the chat window’s message input if a specified message length is exceeded
https://gajim.org/
CC-BY-SA-3.0
GPL-3.0-only
gajim-devel_AT_gajim.org
length_notifier/plugin-manifest.json 0000664 0001755 0001755 00000001043 14760551532 017775 0 ustar debacle debacle {
"authors": [
"Mateusz Biliński "
],
"description": "Highlights the chat window’s message input if a specified message length is exceeded",
"homepage": "https://dev.gajim.org/gajim/gajim-plugins/wikis/LengthNotifierPlugin",
"config_dialog": true,
"name": "Message Length Notifier",
"platforms": [
"others",
"linux",
"darwin",
"win32"
],
"requirements": [
"gajim>=2.0.0"
],
"short_name": "length_notifier",
"version": "1.6.0"
}