Commits November 2020

commits@gajim.org

1 participants
43 discussions

[Git][gajim/python-nbxmpp][master] UserNickame: Add option to make node public
by Philipp Hörist 17 Nov '20

17 Nov '20

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: 225bfb59 by lovetox at 2020-11-17T21:08:59+01:00 UserNickame: Add option to make node public - - - - - 1 changed file: - nbxmpp/modules/nickname.py Changes: ===================================== nbxmpp/modules/nickname.py ===================================== @@ -91,13 +91,24 @@ class Nickname(BaseModule): return nickname.getData() or None @iq_request_task - def set_nickname(self, nickname): + def set_nickname(self, nickname, public=False): task = yield + access_model = 'open' if public else 'presence' + + options = { + 'pubsub#persist_items': 'true', + 'pubsub#access_model': access_model, + } + item = Node('nick', {'xmlns': Namespace.NICK}) if nickname is not None: item.addData(nickname) - result = yield self.publish(Namespace.NICK, item, id_='current') + result = yield self.publish(Namespace.NICK, + item, + id_='current', + options=options, + force_node_options=True) yield finalize(task, result) View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/225bfb597875ee6e0578d0a1… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/225bfb597875ee6e0578d0a1… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] DOAP: Add XEP-0333
by Daniel Brötzmann 16 Nov '20

16 Nov '20

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: 27eaa334 by wurstsalat at 2020-11-16T17:47:10+01:00 DOAP: Add XEP-0333 - - - - - 1 changed file: - data/gajim.doap Changes: ===================================== data/gajim.doap ===================================== @@ -525,6 +525,14 @@ <xmpp:version>1.0</xmpp:version> </xmpp:SupportedXep> </implements> + <implements> + <xmpp:SupportedXep> + <xmpp:xep rdf:resource="https://xmpp.org/extensions/xep-0333.html" /> + <xmpp:status>partial</xmpp:status> + <xmpp:version>0.4</xmpp:version> + <xmpp:note>'displayed' markers are supported, but 'acknowledged' markers are not.</xmpp:note> + </xmpp:SupportedXep> + </implements> <implements> <xmpp:SupportedXep> <xmpp:xep rdf:resource="https://xmpp.org/extensions/xep-0363.html" /> View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/27eaa3347b16a3295c16c12fd76694fa… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/27eaa3347b16a3295c16c12fd76694fa… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim] Deleted branch chat_markers
by Philipp Hörist 15 Nov '20

15 Nov '20

Philipp Hörist deleted branch chat_markers at gajim / gajim -- You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] Add Chat Markers (XEP-0333)
by Philipp Hörist 15 Nov '20

15 Nov '20

Philipp Hörist pushed to branch master at gajim / gajim Commits: e55d282b by wurstsalat at 2020-11-15T20:59:58+01:00 Add Chat Markers (XEP-0333) - - - - - 18 changed files: - gajim/chat_control.py - gajim/chat_control_base.py - gajim/common/const.py - gajim/common/events.py - gajim/common/helpers.py - gajim/common/modules/__init__.py - + gajim/common/modules/chat_markers.py - gajim/common/modules/message.py - gajim/common/setting_values.py - gajim/common/settings.py - gajim/common/structs.py - gajim/conversation_textview.py - gajim/data/style/gajim.css - gajim/groupchat_control.py - gajim/gtk/accounts.py - gajim/gtk/groupchat_settings.py - gajim/gui_interface.py - gajim/gui_menu_builder.py Changes: ===================================== gajim/chat_control.py ===================================== @@ -123,7 +123,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): # Menu for the HeaderBar self.control_menu = gui_menu_builder.get_singlechat_menu( - self.control_id, self.account, self.contact.jid) + self.control_id, self.account, self.contact.jid, self._type) # Settings menu self.xml.settings_menu.set_menu_model(self.control_menu) @@ -228,6 +228,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): ('mam-decrypted-message-received', ged.GUI1, self._on_mam_decrypted_message_received), ('decrypted-message-received', ged.GUI1, self._on_decrypted_message_received), ('receipt-received', ged.GUI1, self._receipt_received), + ('displayed-received', ged.GUI1, self._displayed_received), ('message-error', ged.GUI1, self._on_message_error), ('zeroconf-error', ged.GUI1, self._on_zeroconf_error), ]) @@ -271,6 +272,15 @@ def add_actions(self): act.connect('change-state', self._on_send_chatstate) self.parent_win.window.add_action(act) + marker = self.contact.settings.get('send_marker') + + act = Gio.SimpleAction.new_stateful( + f'send-marker-{self.control_id}', + None, + GLib.Variant.new_boolean(marker)) + act.connect('change-state', self._on_send_marker) + self.parent_win.window.add_action(act) + def update_actions(self): win = self.parent_win.window online = app.account_is_connected(self.account) @@ -338,6 +348,12 @@ def update_actions(self): tooltip_text = _('No File Transfer available') self.xml.sendfile_button.set_tooltip_text(tooltip_text) + # Chat markers + state = GLib.Variant.new_boolean( + self.contact.settings.get('send_marker')) + win.lookup_action( + f'send-marker-{self.control_id}').change_state(state) + # Convert to GC if app.settings.get_account_setting(self.account, 'is_zeroconf'): win.lookup_action( @@ -363,6 +379,7 @@ def remove_actions(self): 'information-', 'start-call-', 'send-chatstate-', + 'send-marker-', ] for action in actions: self.parent_win.window.remove_action(f'{action}{self.control_id}') @@ -435,6 +452,10 @@ def _on_send_chatstate(self, action, param): action.set_state(param) self.contact.settings.set('send_chatstate', param.get_string()) + def _on_send_marker(self, action, param): + action.set_state(param) + self.contact.settings.set('send_marker', param.get_boolean()) + def subscribe_events(self): """ Register listeners to the events class @@ -643,6 +664,10 @@ def _on_message_sent(self, event): def _receipt_received(self, event): self.conv_textview.show_receipt(event.receipt_id) + @event_filter(['account', 'jid']) + def _displayed_received(self, event): + self.conv_textview.show_displayed(event.marker_id) + @event_filter(['account', 'jid']) def _on_zeroconf_error(self, event): self.add_status_message(event.message) @@ -1385,6 +1410,14 @@ def read_queue(self): self.set_session(event.session) if message_ids: app.storage.archive.set_read_messages(message_ids) + + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None app.events.remove_events(self.account, jid_with_resource, types=[str(self._type)]) ===================================== gajim/chat_control_base.py ===================================== @@ -218,6 +218,9 @@ def __init__(self, parent_win, widget_name, contact, acct, self.received_history_pos = 0 self.orig_msg = None + # For XEP-0333 + self.last_msg_id = None + self.correcting = False self.last_sent_msg = None @@ -1116,6 +1119,7 @@ def add_message(self, displaymarking=None, msg_log_id=None, message_id=None, + stanza_id=None, correct_id=None, additional_data=None, marker=None, @@ -1159,6 +1163,12 @@ def add_message(self, if restored: return + if message_id: + if self._type.is_groupchat: + self.last_msg_id = stanza_id or message_id + else: + self.last_msg_id = message_id + if kind == 'incoming': if (not self._type.is_groupchat or self.contact.can_notify() or @@ -1203,7 +1213,10 @@ def add_message(self, event = event_type(text, subject, - self, msg_log_id, + self, + msg_log_id, + message_id=message_id, + stanza_id=stanza_id, show_in_roster=show_in_roster, show_in_systray=show_in_systray) app.events.add_event(self.account, full_jid, event) @@ -1355,7 +1368,7 @@ def set_control_active(self, state): jid = self.contact.jid if self.conv_textview.autoscroll: # we are at the end - type_ = ['printed_%s' % self._type] + type_ = [f'printed_{self._type}'] if self._type.is_groupchat: type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] if not app.events.remove_events(self.account, @@ -1363,6 +1376,12 @@ def set_control_active(self, state): types=type_): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> marker + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None # send chatstate inactive to the one we're leaving # and active to the one we visit if self.msg_textview.has_text(): @@ -1391,20 +1410,27 @@ def _on_edge_reached(self, _scrolledwindow, pos): types_list = [] if self._type.is_groupchat: types_list = ['printed_gc_msg', 'gc_msg', 'printed_marked_gc_msg'] - else: # Not a GC - types_list = ['printed_%s' % self._type, str(self._type)] + else: + types_list = [f'printed_{self._type}', str(self._type)] if not app.events.get_events(self.account, jid, types_list): return if not self.parent_win: return - if self.parent_win.get_active_control() == self and \ - self.parent_win.window.is_active(): + if (self.parent_win.get_active_control() == self and + self.parent_win.window.is_active()): # we are at the end if not app.events.remove_events( self.account, jid, types=types_list): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> tag + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_scrollbar_button_release(self, scrollbar, event): if event.get_button()[1] != 1: @@ -1469,6 +1495,8 @@ def redraw_after_event_removed(self, jid): We just removed a 'printed_*' event, redraw contact in roster or gc_roster and titles in roster and msg_win """ + if not self.parent_win: # minimized groupchat + return self.parent_win.redraw_tab(self) self.parent_win.show_title() # TODO : get the contact and check get_show_in_roster() ===================================== gajim/common/const.py ===================================== @@ -970,6 +970,7 @@ def is_error(self): Namespace.SECLABEL, Namespace.CONFERENCE, Namespace.CORRECT, + Namespace.CHATMARKERS, Namespace.EME, Namespace.XHTML_IM, Namespace.HASHES_2, ===================================== gajim/common/events.py ===================================== @@ -91,13 +91,16 @@ class PmEvent(ChatEvent): class PrintedChatEvent(Event): type_ = 'printed_chat' def __init__(self, message, subject, control, msg_log_id, time_=None, - show_in_roster=False, show_in_systray=True): + message_id=None, stanza_id=None, show_in_roster=False, + show_in_systray=True): Event.__init__(self, time_, show_in_roster=show_in_roster, - show_in_systray=show_in_systray) + show_in_systray=show_in_systray) self.message = message self.subject = subject self.control = control self.msg_log_id = msg_log_id + self.message_id = message_id + self.stanza_id = stanza_id class PrintedGcMsgEvent(PrintedChatEvent): type_ = 'printed_gc_msg' ===================================== gajim/common/helpers.py ===================================== @@ -1406,3 +1406,13 @@ def get_group_chat_nick(account, room_jid): nick = bookmark.nick return nick + + +def get_muc_context(jid): + disco_info = app.storage.cache.get_last_disco_info(jid) + if disco_info is None: + return None + + if (disco_info.muc_is_members_only and disco_info.muc_is_nonanonymous): + return 'private' + return 'public' ===================================== gajim/common/modules/__init__.py ===================================== @@ -40,6 +40,7 @@ 'bookmarks', 'caps', 'carbons', + 'chat_markers', 'chatstates', 'delimiter', 'discovery', ===================================== gajim/common/modules/chat_markers.py ===================================== @@ -0,0 +1,123 @@ +# 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/>. + +# Chat Markers (XEP-0333) + +from nbxmpp.namespaces import Namespace +from nbxmpp.structs import StanzaHandler + +from gajim.common import app +from gajim.common.nec import NetworkEvent +from gajim.common.modules.base import BaseModule +from gajim.common.structs import OutgoingMessage + + +class ChatMarkers(BaseModule): + + _nbxmpp_extends = 'ChatMarkers' + + def __init__(self, con): + BaseModule.__init__(self, con) + + self.handlers = [ + StanzaHandler(name='message', + callback=self._process_chat_marker, + ns=Namespace.CHATMARKERS, + priority=47), + ] + + def _process_chat_marker(self, _con, _stanza, properties): + if not properties.is_marker or not properties.marker.is_displayed: + return + + if properties.type.is_error: + return + + if properties.type.is_groupchat: + manager = self._con.get_module('MUC').get_manager() + muc_data = manager.get(properties.muc_jid) + if muc_data is None: + return + + if properties.muc_nickname != muc_data.nick: + return + + self._raise_event('read-state-sync', properties) + return + + if properties.is_carbon_message and properties.carbon.is_sent: + self._raise_event('read-state-sync', properties) + return + + if properties.is_mam_message: + if properties.from_.bareMatch(self._con.get_own_jid()): + return + + self._raise_event('displayed-received', properties) + + def _raise_event(self, name, properties): + self._log.info('%s: %s %s', + name, + properties.jid, + properties.marker.id) + + jid = properties.jid + if not properties.is_muc_pm and not properties.type.is_groupchat: + jid = properties.jid.bare + + app.nec.push_outgoing_event( + NetworkEvent(name, + account=self._account, + jid=jid, + properties=properties, + type=properties.type, + is_muc_pm=properties.is_muc_pm, + marker_id=properties.marker.id)) + + def _send_marker(self, contact, marker, id_, type_): + jid = contact.jid + if contact.is_pm_contact: + jid = app.get_jid_without_resource(contact.jid) + + if type_ in ('gc', 'pm'): + disco_info = app.storage.cache.get_last_disco_info(jid) + + context = 'public' + if disco_info is not None and disco_info.muc_is_members_only: + context = 'private' + + if not app.settings.get_group_chat_setting( + self._account, jid, 'send_marker', context=context): + return + else: + if not app.settings.get_contact_setting( + self._account, jid, 'send_marker'): + return + + typ = 'groupchat' if type_ == 'gc' else 'chat' + message = OutgoingMessage(account=self._account, + contact=contact, + message=None, + type_=typ, + marker=(marker, id_), + play_sound=False) + self._con.send_message(message) + self._log.info('Send %s: %s', marker, contact.jid) + + def send_displayed_marker(self, contact, id_, type_): + self._send_marker(contact, 'displayed', id_, str(type_)) + + +def get_instance(*args, **kwargs): + return ChatMarkers(*args, **kwargs), 'ChatMarkers' ===================================== gajim/common/modules/message.py ===================================== @@ -350,6 +350,13 @@ def build_message_stanza(self, message): stanza.setTag('no-store', namespace=Namespace.MSG_HINTS) + # XEP-0333 + if message.message: + stanza.setMarkable() + if message.marker: + marker, id_ = message.marker + stanza.setMarker(marker, id_) + # Add other nodes if message.nodes is not None: for node in message.nodes: ===================================== gajim/common/setting_values.py ===================================== @@ -255,12 +255,16 @@ class _ACCOUNT_DEFAULT: 'filetransfer_preference': 'httpupload', 'send_chatstate_default': 'composing_only', 'gc_send_chatstate_default': 'composing_only', + 'send_marker_default': True, + 'gc_send_marker_private_default': True, + 'gc_send_marker_public_default': False, 'chat_history_max_age': -1, }, 'contact': { 'speller_language': '', 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', }, @@ -272,6 +276,7 @@ class _ACCOUNT_DEFAULT: 'minimize_on_autojoin': True, 'minimize_on_close': True, 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', 'sync_threshold': HAS_APP_DEFAULT, }, ===================================== gajim/common/settings.py ===================================== @@ -33,6 +33,7 @@ from gajim.common import app from gajim.common import configpaths from gajim.common import optparser +from gajim.common.helpers import get_muc_context from gajim.common.setting_values import APP_SETTINGS from gajim.common.setting_values import ACCOUNT_SETTINGS from gajim.common.setting_values import PROXY_SETTINGS @@ -678,11 +679,16 @@ def set_group_chat_setting(self, def set_group_chat_settings(self, setting: str, - value: SETTING_TYPE) -> None: + value: SETTING_TYPE, + context: str = None) -> None: for account in self._account_settings: for jid in self._account_settings[account]['group_chat']: - self.set_group_chat_setting(account, jid, setting, value) + if context is not None: + if get_muc_context(jid) != context: + continue + self.set_group_chat_setting( + account, jid, setting, value, context) def get_contact_setting(self, account: str, ===================================== gajim/common/structs.py ===================================== @@ -55,6 +55,7 @@ def __init__(self, type_, subject=None, chatstate=None, + marker=None, resource=None, user_nick=None, label=None, @@ -69,7 +70,7 @@ def __init__(self, if type_ not in ('chat', 'groupchat', 'normal', 'headline'): raise ValueError('Unknown message type: %s' % type_) - if not message and chatstate is None: + if not message and chatstate is None and marker is None: raise ValueError('Trying to send message without content') self.account = account @@ -91,6 +92,7 @@ def __init__(self, self.subject = subject self.chatstate = chatstate + self.marker = marker self.resource = resource self.user_nick = user_nick self.label = label ===================================== gajim/conversation_textview.py ===================================== @@ -38,6 +38,7 @@ from gajim.common import helpers from gajim.common import i18n from gajim.common.i18n import _ +from gajim.common.i18n import Q_ from gajim.common.helpers import AdditionalDataDict from gajim.common.const import StyleAttr from gajim.common.const import Trust @@ -311,6 +312,12 @@ def show_receipt(self, id_): return line.set_receipt() + def show_displayed(self, id_): + line = self._get_message_line(id_) + if line is None: + return + line.set_displayed() + def show_error(self, id_, error): line = self._get_message_line(id_) if line is None: @@ -1194,16 +1201,27 @@ def __init__(self, id_, timestamp, message_icons, start_mark): self.timestamp = timestamp self.start_mark = start_mark self._has_receipt = False + self._has_displayed = False self._message_icons = message_icons @property def has_receipt(self): return self._has_receipt + @property + def has_displayed(self): + return self._has_displayed + def set_receipt(self): self._has_receipt = True + if self._has_displayed: + return self._message_icons.set_receipt_icon_visible(True) + def set_displayed(self): + self._has_displayed = True + self._message_icons.set_displayed_icon_visible(True) + def set_correction(self, tooltip): self._message_icons.set_correction_icon_visible(True) self._message_icons.set_correction_tooltip(tooltip) @@ -1222,12 +1240,12 @@ def __init__(self): 'document-edit-symbolic', Gtk.IconSize.MENU) self._correction_image.set_no_show_all(True) - self._receipt_image = Gtk.Image.new_from_icon_name( + self._marker_image = Gtk.Image.new_from_icon_name( 'emblem-ok-symbolic', Gtk.IconSize.MENU) - self._receipt_image.get_style_context().add_class( + self._marker_image.get_style_context().add_class( 'receipt-received-color') - self._receipt_image.set_tooltip_text(_('Received')) - self._receipt_image.set_no_show_all(True) + self._marker_image.set_tooltip_text(_('Received')) + self._marker_image.set_no_show_all(True) self._error_image = Gtk.Image.new_from_icon_name( 'dialog-warning-symbolic', Gtk.IconSize.MENU) @@ -1235,14 +1253,22 @@ def __init__(self): self._error_image.set_no_show_all(True) self.add(self._correction_image) - self.add(self._receipt_image) + self.add(self._marker_image) self.add(self._error_image) self.show_all() def set_receipt_icon_visible(self, visible): if not app.settings.get('positive_184_ack'): return - self._receipt_image.set_visible(visible) + self._marker_image.set_visible(visible) + + def set_displayed_icon_visible(self, visible): + self._marker_image.set_visible(visible) + self._marker_image.get_style_context().remove_class( + 'receipt-received-color') + self._marker_image.get_style_context().add_class( + 'displayed-received-color') + self._marker_image.set_tooltip_text(Q_('?Message state:Read')) def set_correction_icon_visible(self, visible): self._correction_image.set_visible(visible) ===================================== gajim/data/style/gajim.css ===================================== @@ -295,6 +295,7 @@ button.flat.link { padding: 0; border: 0; } /*Receipts*/ .receipt-received-color { color: rgb(75, 181, 67); } +.displayed-received-color { color: rgb(0, 141, 242); } /*Dataforms*/ .field-fixed { font-size: 16px; font-weight: bold; padding-top:5px;} ===================================== gajim/groupchat_control.py ===================================== @@ -658,6 +658,17 @@ def on_groupchat_maximize(self): self.update_actions() self.set_lock_image() self.draw_banner_text() + type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] + if not app.events.remove_events(self.account, + self.get_full_jid(), + types=type_): + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_roster_row_activated(self, _roster, nick): self._start_private_message(nick) @@ -796,17 +807,21 @@ def _on_gc_message_received(self, event): else: if event.properties.muc_nickname == self.nick: self.last_sent_txt = event.msgtxt + stanza_id = None + if event.properties.stanza_id: + stanza_id = event.properties.stanza_id.id self.add_message(event.msgtxt, contact=event.properties.muc_nickname, tim=event.properties.timestamp, displaymarking=event.displaymarking, correct_id=event.correct_id, message_id=event.properties.id, + stanza_id=stanza_id, additional_data=event.additional_data) event.needs_highlight = self.needs_visual_notification(event.msgtxt) def on_private_message(self, nick, sent, msg, tim, session, additional_data, - msg_log_id=None, displaymarking=None): + message_id, msg_log_id=None, displaymarking=None): # Do we have a queue? fjid = self.room_jid + '/' + nick @@ -819,7 +834,9 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, session=session, displaymarking=displaymarking, sent_forwarded=sent, - additional_data=additional_data) + additional_data=additional_data, + message_id=message_id) + app.events.add_event(self.account, fjid, event) if allow_popup_window(self.account): @@ -837,7 +854,7 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, def add_message(self, text, contact='', tim=None, displaymarking=None, correct_id=None, message_id=None, - additional_data=None): + stanza_id=None, additional_data=None): """ Add message to the ConversationsTextview @@ -887,6 +904,7 @@ def add_message(self, text, contact='', tim=None, displaymarking=displaymarking, correct_id=correct_id, message_id=message_id, + stanza_id=stanza_id, additional_data=additional_data) def get_nb_unread(self): @@ -1057,6 +1075,7 @@ def _on_decrypted_message_received(self, event): event.properties.timestamp, self.session, event.additional_data, + event.properties.id, msg_log_id=event.msg_log_id, displaymarking=event.displaymarking) ===================================== gajim/gtk/accounts.py ===================================== @@ -730,6 +730,19 @@ def __init__(self, account): 'button-style': 'destructive-action', 'button-callback': self._reset_gc_send_chatstate}), + Setting(SettingKind.SWITCH, + _('Send Read Markers'), + SettingType.VALUE, + app.settings.get_account_setting( + account, 'send_marker_default'), + callback=self._send_read_marker, + desc=_('Default for chats and private group chats'), + props={'button-text': _('Reset'), + 'button-tooltip': _('Reset all chats to the ' + 'current default value'), + 'button-style': 'destructive-action', + 'button-callback': self._reset_send_read_marker}), + Setting(SettingKind.POPOVER, _('Keep Chat History'), SettingType.ACCOUNT_CONFIG, @@ -749,6 +762,20 @@ def _reset_gc_send_chatstate(button): button.set_sensitive(False) app.settings.set_group_chat_settings('send_chatstate', None) + def _send_read_marker(self, state, _data): + app.settings.set_account_setting( + self._account, 'send_marker_default', state) + app.settings.set_account_setting( + self._account, 'gc_send_marker_private_default', state) + + def _reset_send_read_marker(self, button): + button.set_sensitive(False) + app.settings.set_contact_settings('send_marker', None) + app.settings.set_group_chat_settings( + 'send_marker', None, context='private') + for ctrl in app.interface.msg_win_mgr.get_controls(acct=self._account): + ctrl.update_actions() + class ConnectionPage(GenericSettingPage): ===================================== gajim/gtk/groupchat_settings.py ===================================== @@ -71,6 +71,13 @@ def __init__(self, account, jid, context): 'send_chatstate', props={'entries': chat_state}), + Setting(SettingKind.SWITCH, + _('Send Chat Markers'), + SettingType.GROUP_CHAT, + 'send_marker', + context=context, + desc=_('Let others know if you read up to this point')), + Setting(SettingKind.POPOVER, _('Sync Threshold'), SettingType.GROUP_CHAT, ===================================== gajim/gui_interface.py ===================================== @@ -242,6 +242,43 @@ def handle_event_presence(self, obj): if ctrl and ctrl.session and len(obj.contact_list) > 1: ctrl.remove_session(ctrl.session) + @staticmethod + def handle_event_read_state_sync(event): + if event.type.is_groupchat: + control = app.get_groupchat_control( + event.account, event.jid.bare) + if control is None: + log.warning('Groupchat control not found') + return + + jid = event.jid.bare + types = ['printed_gc_msg', 'printed_marked_gc_msg'] + + else: + types = ['chat', 'pm', 'printed_chat', 'printed_pm'] + jid = event.jid + + control = app.interface.msg_win_mgr.get_control(jid, event.account) + + # Compare with control.last_msg_id. + events_ = app.events.get_events(event.account, jid, types) + if not events_: + log.warning('No Events') + return + + if event.type.is_groupchat: + id_ = events_[-1].stanza_id or events_[-1].message_id + else: + id_ = events_[-1].message_id + + if id_ != event.marker_id: + return + + if not app.events.remove_events(event.account, jid, types=types): + # There were events to remove + if control is not None: + control.redraw_after_event_removed(event.jid) + @staticmethod def handle_event_msgsent(obj): if not obj.play_sound: @@ -1060,6 +1097,7 @@ def create_core_handlers_list(self): 'unsubscribed-presence-received': [ self.handle_event_unsubscribed_presence], 'zeroconf-name-conflict': [self.handle_event_zc_name_conflict], + 'read-state-sync': [self.handle_event_read_state_sync], } def register_core_handlers(self): ===================================== gajim/gui_menu_builder.py ===================================== @@ -511,12 +511,13 @@ def get_transport_menu(contact, account): return menu -def get_singlechat_menu(control_id, account, jid): +def get_singlechat_menu(control_id, account, jid, type_): singlechat_menu = [ (_('Send File'), [ ('win.send-file-httpupload-', _('Upload File…')), ('win.send-file-jingle-', _('Send File Directly…')), ]), + ('win.send-marker-', _('Send Read Markers')), (_('Send Chatstate'), ['chatstate']), ('win.invite-contacts-', _('Invite Contacts…')), ('win.add-to-roster-', _('Add to Contact List…')), @@ -545,6 +546,9 @@ def build_menu(preset): for item in preset: if isinstance(item[1], str): action_name, label = item + if action_name == 'win.send-marker-' and type_ == 'pm': + continue + if action_name == 'app.browse-history': menuitem = Gio.MenuItem.new(label, action_name) dict_ = {'account': GLib.Variant('s', account), View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/e55d282b5b64f9c9db2521742df55b43… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/e55d282b5b64f9c9db2521742df55b43… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][chat_markers] Add Chat Markers (XEP-0333)
by Philipp Hörist 15 Nov '20

15 Nov '20

Philipp Hörist pushed to branch chat_markers at gajim / gajim Commits: e55d282b by wurstsalat at 2020-11-15T20:59:58+01:00 Add Chat Markers (XEP-0333) - - - - - 18 changed files: - gajim/chat_control.py - gajim/chat_control_base.py - gajim/common/const.py - gajim/common/events.py - gajim/common/helpers.py - gajim/common/modules/__init__.py - + gajim/common/modules/chat_markers.py - gajim/common/modules/message.py - gajim/common/setting_values.py - gajim/common/settings.py - gajim/common/structs.py - gajim/conversation_textview.py - gajim/data/style/gajim.css - gajim/groupchat_control.py - gajim/gtk/accounts.py - gajim/gtk/groupchat_settings.py - gajim/gui_interface.py - gajim/gui_menu_builder.py Changes: ===================================== gajim/chat_control.py ===================================== @@ -123,7 +123,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): # Menu for the HeaderBar self.control_menu = gui_menu_builder.get_singlechat_menu( - self.control_id, self.account, self.contact.jid) + self.control_id, self.account, self.contact.jid, self._type) # Settings menu self.xml.settings_menu.set_menu_model(self.control_menu) @@ -228,6 +228,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): ('mam-decrypted-message-received', ged.GUI1, self._on_mam_decrypted_message_received), ('decrypted-message-received', ged.GUI1, self._on_decrypted_message_received), ('receipt-received', ged.GUI1, self._receipt_received), + ('displayed-received', ged.GUI1, self._displayed_received), ('message-error', ged.GUI1, self._on_message_error), ('zeroconf-error', ged.GUI1, self._on_zeroconf_error), ]) @@ -271,6 +272,15 @@ def add_actions(self): act.connect('change-state', self._on_send_chatstate) self.parent_win.window.add_action(act) + marker = self.contact.settings.get('send_marker') + + act = Gio.SimpleAction.new_stateful( + f'send-marker-{self.control_id}', + None, + GLib.Variant.new_boolean(marker)) + act.connect('change-state', self._on_send_marker) + self.parent_win.window.add_action(act) + def update_actions(self): win = self.parent_win.window online = app.account_is_connected(self.account) @@ -338,6 +348,12 @@ def update_actions(self): tooltip_text = _('No File Transfer available') self.xml.sendfile_button.set_tooltip_text(tooltip_text) + # Chat markers + state = GLib.Variant.new_boolean( + self.contact.settings.get('send_marker')) + win.lookup_action( + f'send-marker-{self.control_id}').change_state(state) + # Convert to GC if app.settings.get_account_setting(self.account, 'is_zeroconf'): win.lookup_action( @@ -363,6 +379,7 @@ def remove_actions(self): 'information-', 'start-call-', 'send-chatstate-', + 'send-marker-', ] for action in actions: self.parent_win.window.remove_action(f'{action}{self.control_id}') @@ -435,6 +452,10 @@ def _on_send_chatstate(self, action, param): action.set_state(param) self.contact.settings.set('send_chatstate', param.get_string()) + def _on_send_marker(self, action, param): + action.set_state(param) + self.contact.settings.set('send_marker', param.get_boolean()) + def subscribe_events(self): """ Register listeners to the events class @@ -643,6 +664,10 @@ def _on_message_sent(self, event): def _receipt_received(self, event): self.conv_textview.show_receipt(event.receipt_id) + @event_filter(['account', 'jid']) + def _displayed_received(self, event): + self.conv_textview.show_displayed(event.marker_id) + @event_filter(['account', 'jid']) def _on_zeroconf_error(self, event): self.add_status_message(event.message) @@ -1385,6 +1410,14 @@ def read_queue(self): self.set_session(event.session) if message_ids: app.storage.archive.set_read_messages(message_ids) + + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None app.events.remove_events(self.account, jid_with_resource, types=[str(self._type)]) ===================================== gajim/chat_control_base.py ===================================== @@ -218,6 +218,9 @@ def __init__(self, parent_win, widget_name, contact, acct, self.received_history_pos = 0 self.orig_msg = None + # For XEP-0333 + self.last_msg_id = None + self.correcting = False self.last_sent_msg = None @@ -1116,6 +1119,7 @@ def add_message(self, displaymarking=None, msg_log_id=None, message_id=None, + stanza_id=None, correct_id=None, additional_data=None, marker=None, @@ -1159,6 +1163,12 @@ def add_message(self, if restored: return + if message_id: + if self._type.is_groupchat: + self.last_msg_id = stanza_id or message_id + else: + self.last_msg_id = message_id + if kind == 'incoming': if (not self._type.is_groupchat or self.contact.can_notify() or @@ -1203,7 +1213,10 @@ def add_message(self, event = event_type(text, subject, - self, msg_log_id, + self, + msg_log_id, + message_id=message_id, + stanza_id=stanza_id, show_in_roster=show_in_roster, show_in_systray=show_in_systray) app.events.add_event(self.account, full_jid, event) @@ -1355,7 +1368,7 @@ def set_control_active(self, state): jid = self.contact.jid if self.conv_textview.autoscroll: # we are at the end - type_ = ['printed_%s' % self._type] + type_ = [f'printed_{self._type}'] if self._type.is_groupchat: type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] if not app.events.remove_events(self.account, @@ -1363,6 +1376,12 @@ def set_control_active(self, state): types=type_): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> marker + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None # send chatstate inactive to the one we're leaving # and active to the one we visit if self.msg_textview.has_text(): @@ -1391,20 +1410,27 @@ def _on_edge_reached(self, _scrolledwindow, pos): types_list = [] if self._type.is_groupchat: types_list = ['printed_gc_msg', 'gc_msg', 'printed_marked_gc_msg'] - else: # Not a GC - types_list = ['printed_%s' % self._type, str(self._type)] + else: + types_list = [f'printed_{self._type}', str(self._type)] if not app.events.get_events(self.account, jid, types_list): return if not self.parent_win: return - if self.parent_win.get_active_control() == self and \ - self.parent_win.window.is_active(): + if (self.parent_win.get_active_control() == self and + self.parent_win.window.is_active()): # we are at the end if not app.events.remove_events( self.account, jid, types=types_list): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> tag + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_scrollbar_button_release(self, scrollbar, event): if event.get_button()[1] != 1: @@ -1469,6 +1495,8 @@ def redraw_after_event_removed(self, jid): We just removed a 'printed_*' event, redraw contact in roster or gc_roster and titles in roster and msg_win """ + if not self.parent_win: # minimized groupchat + return self.parent_win.redraw_tab(self) self.parent_win.show_title() # TODO : get the contact and check get_show_in_roster() ===================================== gajim/common/const.py ===================================== @@ -970,6 +970,7 @@ def is_error(self): Namespace.SECLABEL, Namespace.CONFERENCE, Namespace.CORRECT, + Namespace.CHATMARKERS, Namespace.EME, Namespace.XHTML_IM, Namespace.HASHES_2, ===================================== gajim/common/events.py ===================================== @@ -91,13 +91,16 @@ class PmEvent(ChatEvent): class PrintedChatEvent(Event): type_ = 'printed_chat' def __init__(self, message, subject, control, msg_log_id, time_=None, - show_in_roster=False, show_in_systray=True): + message_id=None, stanza_id=None, show_in_roster=False, + show_in_systray=True): Event.__init__(self, time_, show_in_roster=show_in_roster, - show_in_systray=show_in_systray) + show_in_systray=show_in_systray) self.message = message self.subject = subject self.control = control self.msg_log_id = msg_log_id + self.message_id = message_id + self.stanza_id = stanza_id class PrintedGcMsgEvent(PrintedChatEvent): type_ = 'printed_gc_msg' ===================================== gajim/common/helpers.py ===================================== @@ -1406,3 +1406,13 @@ def get_group_chat_nick(account, room_jid): nick = bookmark.nick return nick + + +def get_muc_context(jid): + disco_info = app.storage.cache.get_last_disco_info(jid) + if disco_info is None: + return None + + if (disco_info.muc_is_members_only and disco_info.muc_is_nonanonymous): + return 'private' + return 'public' ===================================== gajim/common/modules/__init__.py ===================================== @@ -40,6 +40,7 @@ 'bookmarks', 'caps', 'carbons', + 'chat_markers', 'chatstates', 'delimiter', 'discovery', ===================================== gajim/common/modules/chat_markers.py ===================================== @@ -0,0 +1,123 @@ +# 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/>. + +# Chat Markers (XEP-0333) + +from nbxmpp.namespaces import Namespace +from nbxmpp.structs import StanzaHandler + +from gajim.common import app +from gajim.common.nec import NetworkEvent +from gajim.common.modules.base import BaseModule +from gajim.common.structs import OutgoingMessage + + +class ChatMarkers(BaseModule): + + _nbxmpp_extends = 'ChatMarkers' + + def __init__(self, con): + BaseModule.__init__(self, con) + + self.handlers = [ + StanzaHandler(name='message', + callback=self._process_chat_marker, + ns=Namespace.CHATMARKERS, + priority=47), + ] + + def _process_chat_marker(self, _con, _stanza, properties): + if not properties.is_marker or not properties.marker.is_displayed: + return + + if properties.type.is_error: + return + + if properties.type.is_groupchat: + manager = self._con.get_module('MUC').get_manager() + muc_data = manager.get(properties.muc_jid) + if muc_data is None: + return + + if properties.muc_nickname != muc_data.nick: + return + + self._raise_event('read-state-sync', properties) + return + + if properties.is_carbon_message and properties.carbon.is_sent: + self._raise_event('read-state-sync', properties) + return + + if properties.is_mam_message: + if properties.from_.bareMatch(self._con.get_own_jid()): + return + + self._raise_event('displayed-received', properties) + + def _raise_event(self, name, properties): + self._log.info('%s: %s %s', + name, + properties.jid, + properties.marker.id) + + jid = properties.jid + if not properties.is_muc_pm and not properties.type.is_groupchat: + jid = properties.jid.bare + + app.nec.push_outgoing_event( + NetworkEvent(name, + account=self._account, + jid=jid, + properties=properties, + type=properties.type, + is_muc_pm=properties.is_muc_pm, + marker_id=properties.marker.id)) + + def _send_marker(self, contact, marker, id_, type_): + jid = contact.jid + if contact.is_pm_contact: + jid = app.get_jid_without_resource(contact.jid) + + if type_ in ('gc', 'pm'): + disco_info = app.storage.cache.get_last_disco_info(jid) + + context = 'public' + if disco_info is not None and disco_info.muc_is_members_only: + context = 'private' + + if not app.settings.get_group_chat_setting( + self._account, jid, 'send_marker', context=context): + return + else: + if not app.settings.get_contact_setting( + self._account, jid, 'send_marker'): + return + + typ = 'groupchat' if type_ == 'gc' else 'chat' + message = OutgoingMessage(account=self._account, + contact=contact, + message=None, + type_=typ, + marker=(marker, id_), + play_sound=False) + self._con.send_message(message) + self._log.info('Send %s: %s', marker, contact.jid) + + def send_displayed_marker(self, contact, id_, type_): + self._send_marker(contact, 'displayed', id_, str(type_)) + + +def get_instance(*args, **kwargs): + return ChatMarkers(*args, **kwargs), 'ChatMarkers' ===================================== gajim/common/modules/message.py ===================================== @@ -350,6 +350,13 @@ def build_message_stanza(self, message): stanza.setTag('no-store', namespace=Namespace.MSG_HINTS) + # XEP-0333 + if message.message: + stanza.setMarkable() + if message.marker: + marker, id_ = message.marker + stanza.setMarker(marker, id_) + # Add other nodes if message.nodes is not None: for node in message.nodes: ===================================== gajim/common/setting_values.py ===================================== @@ -255,12 +255,16 @@ class _ACCOUNT_DEFAULT: 'filetransfer_preference': 'httpupload', 'send_chatstate_default': 'composing_only', 'gc_send_chatstate_default': 'composing_only', + 'send_marker_default': True, + 'gc_send_marker_private_default': True, + 'gc_send_marker_public_default': False, 'chat_history_max_age': -1, }, 'contact': { 'speller_language': '', 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', }, @@ -272,6 +276,7 @@ class _ACCOUNT_DEFAULT: 'minimize_on_autojoin': True, 'minimize_on_close': True, 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', 'sync_threshold': HAS_APP_DEFAULT, }, ===================================== gajim/common/settings.py ===================================== @@ -33,6 +33,7 @@ from gajim.common import app from gajim.common import configpaths from gajim.common import optparser +from gajim.common.helpers import get_muc_context from gajim.common.setting_values import APP_SETTINGS from gajim.common.setting_values import ACCOUNT_SETTINGS from gajim.common.setting_values import PROXY_SETTINGS @@ -678,11 +679,16 @@ def set_group_chat_setting(self, def set_group_chat_settings(self, setting: str, - value: SETTING_TYPE) -> None: + value: SETTING_TYPE, + context: str = None) -> None: for account in self._account_settings: for jid in self._account_settings[account]['group_chat']: - self.set_group_chat_setting(account, jid, setting, value) + if context is not None: + if get_muc_context(jid) != context: + continue + self.set_group_chat_setting( + account, jid, setting, value, context) def get_contact_setting(self, account: str, ===================================== gajim/common/structs.py ===================================== @@ -55,6 +55,7 @@ def __init__(self, type_, subject=None, chatstate=None, + marker=None, resource=None, user_nick=None, label=None, @@ -69,7 +70,7 @@ def __init__(self, if type_ not in ('chat', 'groupchat', 'normal', 'headline'): raise ValueError('Unknown message type: %s' % type_) - if not message and chatstate is None: + if not message and chatstate is None and marker is None: raise ValueError('Trying to send message without content') self.account = account @@ -91,6 +92,7 @@ def __init__(self, self.subject = subject self.chatstate = chatstate + self.marker = marker self.resource = resource self.user_nick = user_nick self.label = label ===================================== gajim/conversation_textview.py ===================================== @@ -38,6 +38,7 @@ from gajim.common import helpers from gajim.common import i18n from gajim.common.i18n import _ +from gajim.common.i18n import Q_ from gajim.common.helpers import AdditionalDataDict from gajim.common.const import StyleAttr from gajim.common.const import Trust @@ -311,6 +312,12 @@ def show_receipt(self, id_): return line.set_receipt() + def show_displayed(self, id_): + line = self._get_message_line(id_) + if line is None: + return + line.set_displayed() + def show_error(self, id_, error): line = self._get_message_line(id_) if line is None: @@ -1194,16 +1201,27 @@ def __init__(self, id_, timestamp, message_icons, start_mark): self.timestamp = timestamp self.start_mark = start_mark self._has_receipt = False + self._has_displayed = False self._message_icons = message_icons @property def has_receipt(self): return self._has_receipt + @property + def has_displayed(self): + return self._has_displayed + def set_receipt(self): self._has_receipt = True + if self._has_displayed: + return self._message_icons.set_receipt_icon_visible(True) + def set_displayed(self): + self._has_displayed = True + self._message_icons.set_displayed_icon_visible(True) + def set_correction(self, tooltip): self._message_icons.set_correction_icon_visible(True) self._message_icons.set_correction_tooltip(tooltip) @@ -1222,12 +1240,12 @@ def __init__(self): 'document-edit-symbolic', Gtk.IconSize.MENU) self._correction_image.set_no_show_all(True) - self._receipt_image = Gtk.Image.new_from_icon_name( + self._marker_image = Gtk.Image.new_from_icon_name( 'emblem-ok-symbolic', Gtk.IconSize.MENU) - self._receipt_image.get_style_context().add_class( + self._marker_image.get_style_context().add_class( 'receipt-received-color') - self._receipt_image.set_tooltip_text(_('Received')) - self._receipt_image.set_no_show_all(True) + self._marker_image.set_tooltip_text(_('Received')) + self._marker_image.set_no_show_all(True) self._error_image = Gtk.Image.new_from_icon_name( 'dialog-warning-symbolic', Gtk.IconSize.MENU) @@ -1235,14 +1253,22 @@ def __init__(self): self._error_image.set_no_show_all(True) self.add(self._correction_image) - self.add(self._receipt_image) + self.add(self._marker_image) self.add(self._error_image) self.show_all() def set_receipt_icon_visible(self, visible): if not app.settings.get('positive_184_ack'): return - self._receipt_image.set_visible(visible) + self._marker_image.set_visible(visible) + + def set_displayed_icon_visible(self, visible): + self._marker_image.set_visible(visible) + self._marker_image.get_style_context().remove_class( + 'receipt-received-color') + self._marker_image.get_style_context().add_class( + 'displayed-received-color') + self._marker_image.set_tooltip_text(Q_('?Message state:Read')) def set_correction_icon_visible(self, visible): self._correction_image.set_visible(visible) ===================================== gajim/data/style/gajim.css ===================================== @@ -295,6 +295,7 @@ button.flat.link { padding: 0; border: 0; } /*Receipts*/ .receipt-received-color { color: rgb(75, 181, 67); } +.displayed-received-color { color: rgb(0, 141, 242); } /*Dataforms*/ .field-fixed { font-size: 16px; font-weight: bold; padding-top:5px;} ===================================== gajim/groupchat_control.py ===================================== @@ -658,6 +658,17 @@ def on_groupchat_maximize(self): self.update_actions() self.set_lock_image() self.draw_banner_text() + type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] + if not app.events.remove_events(self.account, + self.get_full_jid(), + types=type_): + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_roster_row_activated(self, _roster, nick): self._start_private_message(nick) @@ -796,17 +807,21 @@ def _on_gc_message_received(self, event): else: if event.properties.muc_nickname == self.nick: self.last_sent_txt = event.msgtxt + stanza_id = None + if event.properties.stanza_id: + stanza_id = event.properties.stanza_id.id self.add_message(event.msgtxt, contact=event.properties.muc_nickname, tim=event.properties.timestamp, displaymarking=event.displaymarking, correct_id=event.correct_id, message_id=event.properties.id, + stanza_id=stanza_id, additional_data=event.additional_data) event.needs_highlight = self.needs_visual_notification(event.msgtxt) def on_private_message(self, nick, sent, msg, tim, session, additional_data, - msg_log_id=None, displaymarking=None): + message_id, msg_log_id=None, displaymarking=None): # Do we have a queue? fjid = self.room_jid + '/' + nick @@ -819,7 +834,9 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, session=session, displaymarking=displaymarking, sent_forwarded=sent, - additional_data=additional_data) + additional_data=additional_data, + message_id=message_id) + app.events.add_event(self.account, fjid, event) if allow_popup_window(self.account): @@ -837,7 +854,7 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, def add_message(self, text, contact='', tim=None, displaymarking=None, correct_id=None, message_id=None, - additional_data=None): + stanza_id=None, additional_data=None): """ Add message to the ConversationsTextview @@ -887,6 +904,7 @@ def add_message(self, text, contact='', tim=None, displaymarking=displaymarking, correct_id=correct_id, message_id=message_id, + stanza_id=stanza_id, additional_data=additional_data) def get_nb_unread(self): @@ -1057,6 +1075,7 @@ def _on_decrypted_message_received(self, event): event.properties.timestamp, self.session, event.additional_data, + event.properties.id, msg_log_id=event.msg_log_id, displaymarking=event.displaymarking) ===================================== gajim/gtk/accounts.py ===================================== @@ -730,6 +730,19 @@ def __init__(self, account): 'button-style': 'destructive-action', 'button-callback': self._reset_gc_send_chatstate}), + Setting(SettingKind.SWITCH, + _('Send Read Markers'), + SettingType.VALUE, + app.settings.get_account_setting( + account, 'send_marker_default'), + callback=self._send_read_marker, + desc=_('Default for chats and private group chats'), + props={'button-text': _('Reset'), + 'button-tooltip': _('Reset all chats to the ' + 'current default value'), + 'button-style': 'destructive-action', + 'button-callback': self._reset_send_read_marker}), + Setting(SettingKind.POPOVER, _('Keep Chat History'), SettingType.ACCOUNT_CONFIG, @@ -749,6 +762,20 @@ def _reset_gc_send_chatstate(button): button.set_sensitive(False) app.settings.set_group_chat_settings('send_chatstate', None) + def _send_read_marker(self, state, _data): + app.settings.set_account_setting( + self._account, 'send_marker_default', state) + app.settings.set_account_setting( + self._account, 'gc_send_marker_private_default', state) + + def _reset_send_read_marker(self, button): + button.set_sensitive(False) + app.settings.set_contact_settings('send_marker', None) + app.settings.set_group_chat_settings( + 'send_marker', None, context='private') + for ctrl in app.interface.msg_win_mgr.get_controls(acct=self._account): + ctrl.update_actions() + class ConnectionPage(GenericSettingPage): ===================================== gajim/gtk/groupchat_settings.py ===================================== @@ -71,6 +71,13 @@ def __init__(self, account, jid, context): 'send_chatstate', props={'entries': chat_state}), + Setting(SettingKind.SWITCH, + _('Send Chat Markers'), + SettingType.GROUP_CHAT, + 'send_marker', + context=context, + desc=_('Let others know if you read up to this point')), + Setting(SettingKind.POPOVER, _('Sync Threshold'), SettingType.GROUP_CHAT, ===================================== gajim/gui_interface.py ===================================== @@ -242,6 +242,43 @@ def handle_event_presence(self, obj): if ctrl and ctrl.session and len(obj.contact_list) > 1: ctrl.remove_session(ctrl.session) + @staticmethod + def handle_event_read_state_sync(event): + if event.type.is_groupchat: + control = app.get_groupchat_control( + event.account, event.jid.bare) + if control is None: + log.warning('Groupchat control not found') + return + + jid = event.jid.bare + types = ['printed_gc_msg', 'printed_marked_gc_msg'] + + else: + types = ['chat', 'pm', 'printed_chat', 'printed_pm'] + jid = event.jid + + control = app.interface.msg_win_mgr.get_control(jid, event.account) + + # Compare with control.last_msg_id. + events_ = app.events.get_events(event.account, jid, types) + if not events_: + log.warning('No Events') + return + + if event.type.is_groupchat: + id_ = events_[-1].stanza_id or events_[-1].message_id + else: + id_ = events_[-1].message_id + + if id_ != event.marker_id: + return + + if not app.events.remove_events(event.account, jid, types=types): + # There were events to remove + if control is not None: + control.redraw_after_event_removed(event.jid) + @staticmethod def handle_event_msgsent(obj): if not obj.play_sound: @@ -1060,6 +1097,7 @@ def create_core_handlers_list(self): 'unsubscribed-presence-received': [ self.handle_event_unsubscribed_presence], 'zeroconf-name-conflict': [self.handle_event_zc_name_conflict], + 'read-state-sync': [self.handle_event_read_state_sync], } def register_core_handlers(self): ===================================== gajim/gui_menu_builder.py ===================================== @@ -511,12 +511,13 @@ def get_transport_menu(contact, account): return menu -def get_singlechat_menu(control_id, account, jid): +def get_singlechat_menu(control_id, account, jid, type_): singlechat_menu = [ (_('Send File'), [ ('win.send-file-httpupload-', _('Upload File…')), ('win.send-file-jingle-', _('Send File Directly…')), ]), + ('win.send-marker-', _('Send Read Markers')), (_('Send Chatstate'), ['chatstate']), ('win.invite-contacts-', _('Invite Contacts…')), ('win.add-to-roster-', _('Add to Contact List…')), @@ -545,6 +546,9 @@ def build_menu(preset): for item in preset: if isinstance(item[1], str): action_name, label = item + if action_name == 'win.send-marker-' and type_ == 'pm': + continue + if action_name == 'app.browse-history': menuitem = Gio.MenuItem.new(label, action_name) dict_ = {'account': GLib.Variant('s', account), View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/e55d282b5b64f9c9db2521742df55b43… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/e55d282b5b64f9c9db2521742df55b43… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][chat_markers] Add Chat Markers (XEP-0333)
by Philipp Hörist 15 Nov '20

15 Nov '20

Philipp Hörist pushed to branch chat_markers at gajim / gajim Commits: 8b70a766 by wurstsalat at 2020-11-15T20:54:30+01:00 Add Chat Markers (XEP-0333) - - - - - 18 changed files: - gajim/chat_control.py - gajim/chat_control_base.py - gajim/common/const.py - gajim/common/events.py - gajim/common/helpers.py - gajim/common/modules/__init__.py - + gajim/common/modules/chat_markers.py - gajim/common/modules/message.py - gajim/common/setting_values.py - gajim/common/settings.py - gajim/common/structs.py - gajim/conversation_textview.py - gajim/data/style/gajim.css - gajim/groupchat_control.py - gajim/gtk/accounts.py - gajim/gtk/groupchat_settings.py - gajim/gui_interface.py - gajim/gui_menu_builder.py Changes: ===================================== gajim/chat_control.py ===================================== @@ -123,7 +123,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): # Menu for the HeaderBar self.control_menu = gui_menu_builder.get_singlechat_menu( - self.control_id, self.account, self.contact.jid) + self.control_id, self.account, self.contact.jid, self._type) # Settings menu self.xml.settings_menu.set_menu_model(self.control_menu) @@ -228,6 +228,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): ('mam-decrypted-message-received', ged.GUI1, self._on_mam_decrypted_message_received), ('decrypted-message-received', ged.GUI1, self._on_decrypted_message_received), ('receipt-received', ged.GUI1, self._receipt_received), + ('displayed-received', ged.GUI1, self._displayed_received), ('message-error', ged.GUI1, self._on_message_error), ('zeroconf-error', ged.GUI1, self._on_zeroconf_error), ]) @@ -271,6 +272,15 @@ def add_actions(self): act.connect('change-state', self._on_send_chatstate) self.parent_win.window.add_action(act) + marker = self.contact.settings.get('send_marker') + + act = Gio.SimpleAction.new_stateful( + f'send-marker-{self.control_id}', + None, + GLib.Variant.new_boolean(marker)) + act.connect('change-state', self._on_send_marker) + self.parent_win.window.add_action(act) + def update_actions(self): win = self.parent_win.window online = app.account_is_connected(self.account) @@ -338,6 +348,12 @@ def update_actions(self): tooltip_text = _('No File Transfer available') self.xml.sendfile_button.set_tooltip_text(tooltip_text) + # Chat markers + state = GLib.Variant.new_boolean( + self.contact.settings.get('send_marker')) + win.lookup_action( + f'send-marker-{self.control_id}').change_state(state) + # Convert to GC if app.settings.get_account_setting(self.account, 'is_zeroconf'): win.lookup_action( @@ -363,6 +379,7 @@ def remove_actions(self): 'information-', 'start-call-', 'send-chatstate-', + 'send-marker-', ] for action in actions: self.parent_win.window.remove_action(f'{action}{self.control_id}') @@ -435,6 +452,10 @@ def _on_send_chatstate(self, action, param): action.set_state(param) self.contact.settings.set('send_chatstate', param.get_string()) + def _on_send_marker(self, action, param): + action.set_state(param) + self.contact.settings.set('send_marker', param.get_boolean()) + def subscribe_events(self): """ Register listeners to the events class @@ -643,6 +664,10 @@ def _on_message_sent(self, event): def _receipt_received(self, event): self.conv_textview.show_receipt(event.receipt_id) + @event_filter(['account', 'jid']) + def _displayed_received(self, event): + self.conv_textview.show_displayed(event.marker_id) + @event_filter(['account', 'jid']) def _on_zeroconf_error(self, event): self.add_status_message(event.message) @@ -1385,6 +1410,14 @@ def read_queue(self): self.set_session(event.session) if message_ids: app.storage.archive.set_read_messages(message_ids) + + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None app.events.remove_events(self.account, jid_with_resource, types=[str(self._type)]) ===================================== gajim/chat_control_base.py ===================================== @@ -218,6 +218,9 @@ def __init__(self, parent_win, widget_name, contact, acct, self.received_history_pos = 0 self.orig_msg = None + # For XEP-0333 + self.last_msg_id = None + self.correcting = False self.last_sent_msg = None @@ -1116,6 +1119,7 @@ def add_message(self, displaymarking=None, msg_log_id=None, message_id=None, + stanza_id=None, correct_id=None, additional_data=None, marker=None, @@ -1159,6 +1163,12 @@ def add_message(self, if restored: return + if message_id: + if self._type.is_groupchat: + self.last_msg_id = stanza_id or message_id + else: + self.last_msg_id = message_id + if kind == 'incoming': if (not self._type.is_groupchat or self.contact.can_notify() or @@ -1203,7 +1213,10 @@ def add_message(self, event = event_type(text, subject, - self, msg_log_id, + self, + msg_log_id, + message_id=message_id, + stanza_id=stanza_id, show_in_roster=show_in_roster, show_in_systray=show_in_systray) app.events.add_event(self.account, full_jid, event) @@ -1355,7 +1368,7 @@ def set_control_active(self, state): jid = self.contact.jid if self.conv_textview.autoscroll: # we are at the end - type_ = ['printed_%s' % self._type] + type_ = [f'printed_{self._type}'] if self._type.is_groupchat: type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] if not app.events.remove_events(self.account, @@ -1363,6 +1376,12 @@ def set_control_active(self, state): types=type_): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> marker + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None # send chatstate inactive to the one we're leaving # and active to the one we visit if self.msg_textview.has_text(): @@ -1391,20 +1410,27 @@ def _on_edge_reached(self, _scrolledwindow, pos): types_list = [] if self._type.is_groupchat: types_list = ['printed_gc_msg', 'gc_msg', 'printed_marked_gc_msg'] - else: # Not a GC - types_list = ['printed_%s' % self._type, str(self._type)] + else: + types_list = [f'printed_{self._type}', str(self._type)] if not app.events.get_events(self.account, jid, types_list): return if not self.parent_win: return - if self.parent_win.get_active_control() == self and \ - self.parent_win.window.is_active(): + if (self.parent_win.get_active_control() == self and + self.parent_win.window.is_active()): # we are at the end if not app.events.remove_events( self.account, jid, types=types_list): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> tag + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_scrollbar_button_release(self, scrollbar, event): if event.get_button()[1] != 1: @@ -1469,6 +1495,8 @@ def redraw_after_event_removed(self, jid): We just removed a 'printed_*' event, redraw contact in roster or gc_roster and titles in roster and msg_win """ + if not self.parent_win: # minimized groupchat + return self.parent_win.redraw_tab(self) self.parent_win.show_title() # TODO : get the contact and check get_show_in_roster() ===================================== gajim/common/const.py ===================================== @@ -970,6 +970,7 @@ def is_error(self): Namespace.SECLABEL, Namespace.CONFERENCE, Namespace.CORRECT, + Namespace.CHATMARKERS, Namespace.EME, Namespace.XHTML_IM, Namespace.HASHES_2, ===================================== gajim/common/events.py ===================================== @@ -91,13 +91,16 @@ class PmEvent(ChatEvent): class PrintedChatEvent(Event): type_ = 'printed_chat' def __init__(self, message, subject, control, msg_log_id, time_=None, - show_in_roster=False, show_in_systray=True): + message_id=None, stanza_id=None, show_in_roster=False, + show_in_systray=True): Event.__init__(self, time_, show_in_roster=show_in_roster, - show_in_systray=show_in_systray) + show_in_systray=show_in_systray) self.message = message self.subject = subject self.control = control self.msg_log_id = msg_log_id + self.message_id = message_id + self.stanza_id = stanza_id class PrintedGcMsgEvent(PrintedChatEvent): type_ = 'printed_gc_msg' ===================================== gajim/common/helpers.py ===================================== @@ -1406,3 +1406,13 @@ def get_group_chat_nick(account, room_jid): nick = bookmark.nick return nick + + +def get_muc_context(jid): + disco_info = app.storage.cache.get_last_disco_info(jid) + if disco_info is None: + return + + if (disco_info.muc_is_members_only and disco_info.muc_is_nonanonymous): + return 'private' + return 'public' ===================================== gajim/common/modules/__init__.py ===================================== @@ -40,6 +40,7 @@ 'bookmarks', 'caps', 'carbons', + 'chat_markers', 'chatstates', 'delimiter', 'discovery', ===================================== gajim/common/modules/chat_markers.py ===================================== @@ -0,0 +1,123 @@ +# 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/>. + +# Chat Markers (XEP-0333) + +from nbxmpp.namespaces import Namespace +from nbxmpp.structs import StanzaHandler + +from gajim.common import app +from gajim.common.nec import NetworkEvent +from gajim.common.modules.base import BaseModule +from gajim.common.structs import OutgoingMessage + + +class ChatMarkers(BaseModule): + + _nbxmpp_extends = 'ChatMarkers' + + def __init__(self, con): + BaseModule.__init__(self, con) + + self.handlers = [ + StanzaHandler(name='message', + callback=self._process_chat_marker, + ns=Namespace.CHATMARKERS, + priority=47), + ] + + def _process_chat_marker(self, _con, _stanza, properties): + if not properties.is_marker or not properties.marker.is_displayed: + return + + if properties.type.is_error: + return + + if properties.type.is_groupchat: + manager = self._con.get_module('MUC').get_manager() + muc_data = manager.get(properties.muc_jid) + if muc_data is None: + return + + if properties.muc_nickname != muc_data.nick: + return + + self._raise_event('read-state-sync', properties) + return + + if properties.is_carbon_message and properties.carbon.is_sent: + self._raise_event('read-state-sync', properties) + return + + if properties.is_mam_message: + if properties.from_.bareMatch(self._con.get_own_jid()): + return + + self._raise_event('displayed-received', properties) + + def _raise_event(self, name, properties): + self._log.info('%s: %s %s', + name, + properties.jid, + properties.marker.id) + + jid = properties.jid + if not properties.is_muc_pm and not properties.type.is_groupchat: + jid = properties.jid.bare + + app.nec.push_outgoing_event( + NetworkEvent(name, + account=self._account, + jid=jid, + properties=properties, + type=properties.type, + is_muc_pm=properties.is_muc_pm, + marker_id=properties.marker.id)) + + def _send_marker(self, contact, marker, id_, type_): + jid = contact.jid + if contact.is_pm_contact: + jid = app.get_jid_without_resource(contact.jid) + + if type_ in ('gc', 'pm'): + disco_info = app.storage.cache.get_last_disco_info(jid) + + context = 'public' + if disco_info is not None and disco_info.muc_is_members_only: + context = 'private' + + if not app.settings.get_group_chat_setting( + self._account, jid, 'send_marker', context=context): + return + else: + if not app.settings.get_contact_setting( + self._account, jid, 'send_marker'): + return + + typ = 'groupchat' if type_ == 'gc' else 'chat' + message = OutgoingMessage(account=self._account, + contact=contact, + message=None, + type_=typ, + marker=(marker, id_), + play_sound=False) + self._con.send_message(message) + self._log.info('Send %s: %s', marker, contact.jid) + + def send_displayed_marker(self, contact, id_, type_): + self._send_marker(contact, 'displayed', id_, str(type_)) + + +def get_instance(*args, **kwargs): + return ChatMarkers(*args, **kwargs), 'ChatMarkers' ===================================== gajim/common/modules/message.py ===================================== @@ -350,6 +350,13 @@ def build_message_stanza(self, message): stanza.setTag('no-store', namespace=Namespace.MSG_HINTS) + # XEP-0333 + if message.message: + stanza.setMarkable() + if message.marker: + marker, id_ = message.marker + stanza.setMarker(marker, id_) + # Add other nodes if message.nodes is not None: for node in message.nodes: ===================================== gajim/common/setting_values.py ===================================== @@ -255,12 +255,16 @@ class _ACCOUNT_DEFAULT: 'filetransfer_preference': 'httpupload', 'send_chatstate_default': 'composing_only', 'gc_send_chatstate_default': 'composing_only', + 'send_marker_default': True, + 'gc_send_marker_private_default': True, + 'gc_send_marker_public_default': False, 'chat_history_max_age': -1, }, 'contact': { 'speller_language': '', 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', }, @@ -272,6 +276,7 @@ class _ACCOUNT_DEFAULT: 'minimize_on_autojoin': True, 'minimize_on_close': True, 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', 'sync_threshold': HAS_APP_DEFAULT, }, ===================================== gajim/common/settings.py ===================================== @@ -33,6 +33,7 @@ from gajim.common import app from gajim.common import configpaths from gajim.common import optparser +from gajim.common.helpers import get_muc_context from gajim.common.setting_values import APP_SETTINGS from gajim.common.setting_values import ACCOUNT_SETTINGS from gajim.common.setting_values import PROXY_SETTINGS @@ -678,11 +679,16 @@ def set_group_chat_setting(self, def set_group_chat_settings(self, setting: str, - value: SETTING_TYPE) -> None: + value: SETTING_TYPE, + context: str = None) -> None: for account in self._account_settings: for jid in self._account_settings[account]['group_chat']: - self.set_group_chat_setting(account, jid, setting, value) + if context is not None: + if get_muc_context(jid) != context: + continue + self.set_group_chat_setting( + account, jid, setting, value, context) def get_contact_setting(self, account: str, ===================================== gajim/common/structs.py ===================================== @@ -55,6 +55,7 @@ def __init__(self, type_, subject=None, chatstate=None, + marker=None, resource=None, user_nick=None, label=None, @@ -69,7 +70,7 @@ def __init__(self, if type_ not in ('chat', 'groupchat', 'normal', 'headline'): raise ValueError('Unknown message type: %s' % type_) - if not message and chatstate is None: + if not message and chatstate is None and marker is None: raise ValueError('Trying to send message without content') self.account = account @@ -91,6 +92,7 @@ def __init__(self, self.subject = subject self.chatstate = chatstate + self.marker = marker self.resource = resource self.user_nick = user_nick self.label = label ===================================== gajim/conversation_textview.py ===================================== @@ -38,6 +38,7 @@ from gajim.common import helpers from gajim.common import i18n from gajim.common.i18n import _ +from gajim.common.i18n import Q_ from gajim.common.helpers import AdditionalDataDict from gajim.common.const import StyleAttr from gajim.common.const import Trust @@ -311,6 +312,12 @@ def show_receipt(self, id_): return line.set_receipt() + def show_displayed(self, id_): + line = self._get_message_line(id_) + if line is None: + return + line.set_displayed() + def show_error(self, id_, error): line = self._get_message_line(id_) if line is None: @@ -1194,16 +1201,27 @@ def __init__(self, id_, timestamp, message_icons, start_mark): self.timestamp = timestamp self.start_mark = start_mark self._has_receipt = False + self._has_displayed = False self._message_icons = message_icons @property def has_receipt(self): return self._has_receipt + @property + def has_displayed(self): + return self._has_displayed + def set_receipt(self): self._has_receipt = True + if self._has_displayed: + return self._message_icons.set_receipt_icon_visible(True) + def set_displayed(self): + self._has_displayed = True + self._message_icons.set_displayed_icon_visible(True) + def set_correction(self, tooltip): self._message_icons.set_correction_icon_visible(True) self._message_icons.set_correction_tooltip(tooltip) @@ -1222,12 +1240,12 @@ def __init__(self): 'document-edit-symbolic', Gtk.IconSize.MENU) self._correction_image.set_no_show_all(True) - self._receipt_image = Gtk.Image.new_from_icon_name( + self._marker_image = Gtk.Image.new_from_icon_name( 'emblem-ok-symbolic', Gtk.IconSize.MENU) - self._receipt_image.get_style_context().add_class( + self._marker_image.get_style_context().add_class( 'receipt-received-color') - self._receipt_image.set_tooltip_text(_('Received')) - self._receipt_image.set_no_show_all(True) + self._marker_image.set_tooltip_text(_('Received')) + self._marker_image.set_no_show_all(True) self._error_image = Gtk.Image.new_from_icon_name( 'dialog-warning-symbolic', Gtk.IconSize.MENU) @@ -1235,14 +1253,22 @@ def __init__(self): self._error_image.set_no_show_all(True) self.add(self._correction_image) - self.add(self._receipt_image) + self.add(self._marker_image) self.add(self._error_image) self.show_all() def set_receipt_icon_visible(self, visible): if not app.settings.get('positive_184_ack'): return - self._receipt_image.set_visible(visible) + self._marker_image.set_visible(visible) + + def set_displayed_icon_visible(self, visible): + self._marker_image.set_visible(visible) + self._marker_image.get_style_context().remove_class( + 'receipt-received-color') + self._marker_image.get_style_context().add_class( + 'displayed-received-color') + self._marker_image.set_tooltip_text(Q_('?Message state:Read')) def set_correction_icon_visible(self, visible): self._correction_image.set_visible(visible) ===================================== gajim/data/style/gajim.css ===================================== @@ -295,6 +295,7 @@ button.flat.link { padding: 0; border: 0; } /*Receipts*/ .receipt-received-color { color: rgb(75, 181, 67); } +.displayed-received-color { color: rgb(0, 141, 242); } /*Dataforms*/ .field-fixed { font-size: 16px; font-weight: bold; padding-top:5px;} ===================================== gajim/groupchat_control.py ===================================== @@ -658,6 +658,17 @@ def on_groupchat_maximize(self): self.update_actions() self.set_lock_image() self.draw_banner_text() + type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] + if not app.events.remove_events(self.account, + self.get_full_jid(), + types=type_): + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_roster_row_activated(self, _roster, nick): self._start_private_message(nick) @@ -796,17 +807,21 @@ def _on_gc_message_received(self, event): else: if event.properties.muc_nickname == self.nick: self.last_sent_txt = event.msgtxt + stanza_id = None + if event.properties.stanza_id: + stanza_id = event.properties.stanza_id.id self.add_message(event.msgtxt, contact=event.properties.muc_nickname, tim=event.properties.timestamp, displaymarking=event.displaymarking, correct_id=event.correct_id, message_id=event.properties.id, + stanza_id=stanza_id, additional_data=event.additional_data) event.needs_highlight = self.needs_visual_notification(event.msgtxt) def on_private_message(self, nick, sent, msg, tim, session, additional_data, - msg_log_id=None, displaymarking=None): + message_id, msg_log_id=None, displaymarking=None): # Do we have a queue? fjid = self.room_jid + '/' + nick @@ -819,7 +834,9 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, session=session, displaymarking=displaymarking, sent_forwarded=sent, - additional_data=additional_data) + additional_data=additional_data, + message_id=message_id) + app.events.add_event(self.account, fjid, event) if allow_popup_window(self.account): @@ -837,7 +854,7 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, def add_message(self, text, contact='', tim=None, displaymarking=None, correct_id=None, message_id=None, - additional_data=None): + stanza_id=None, additional_data=None): """ Add message to the ConversationsTextview @@ -887,6 +904,7 @@ def add_message(self, text, contact='', tim=None, displaymarking=displaymarking, correct_id=correct_id, message_id=message_id, + stanza_id=stanza_id, additional_data=additional_data) def get_nb_unread(self): @@ -1057,6 +1075,7 @@ def _on_decrypted_message_received(self, event): event.properties.timestamp, self.session, event.additional_data, + event.properties.id, msg_log_id=event.msg_log_id, displaymarking=event.displaymarking) ===================================== gajim/gtk/accounts.py ===================================== @@ -730,6 +730,19 @@ def __init__(self, account): 'button-style': 'destructive-action', 'button-callback': self._reset_gc_send_chatstate}), + Setting(SettingKind.SWITCH, + _('Send Read Markers'), + SettingType.VALUE, + app.settings.get_account_setting( + account, 'send_marker_default'), + callback=self._send_read_marker, + desc=_('Default for chats and private group chats'), + props={'button-text': _('Reset'), + 'button-tooltip': _('Reset all chats to the ' + 'current default value'), + 'button-style': 'destructive-action', + 'button-callback': self._reset_send_read_marker}), + Setting(SettingKind.POPOVER, _('Keep Chat History'), SettingType.ACCOUNT_CONFIG, @@ -749,6 +762,20 @@ def _reset_gc_send_chatstate(button): button.set_sensitive(False) app.settings.set_group_chat_settings('send_chatstate', None) + def _send_read_marker(self, state, _data): + app.settings.set_account_setting( + self._account, 'send_marker_default', state) + app.settings.set_account_setting( + self._account, 'gc_send_marker_private_default', state) + + def _reset_send_read_marker(self, button): + button.set_sensitive(False) + app.settings.set_contact_settings('send_marker', None) + app.settings.set_group_chat_settings( + 'send_marker', None, context='private') + for ctrl in app.interface.msg_win_mgr.get_controls(acct=self._account): + ctrl.update_actions() + class ConnectionPage(GenericSettingPage): ===================================== gajim/gtk/groupchat_settings.py ===================================== @@ -71,6 +71,13 @@ def __init__(self, account, jid, context): 'send_chatstate', props={'entries': chat_state}), + Setting(SettingKind.SWITCH, + _('Send Chat Markers'), + SettingType.GROUP_CHAT, + 'send_marker', + context=context, + desc=_('Let others know if you read up to this point')), + Setting(SettingKind.POPOVER, _('Sync Threshold'), SettingType.GROUP_CHAT, ===================================== gajim/gui_interface.py ===================================== @@ -242,6 +242,43 @@ def handle_event_presence(self, obj): if ctrl and ctrl.session and len(obj.contact_list) > 1: ctrl.remove_session(ctrl.session) + @staticmethod + def handle_event_read_state_sync(event): + if event.type.is_groupchat: + control = app.get_groupchat_control( + event.account, event.jid.bare) + if control is None: + log.warning('Groupchat control not found') + return + + jid = event.jid.bare + types = ['printed_gc_msg', 'printed_marked_gc_msg'] + + else: + types = ['chat', 'pm', 'printed_chat', 'printed_pm'] + jid = event.jid + + control = app.interface.msg_win_mgr.get_control(jid, event.account) + + # Compare with control.last_msg_id. + events_ = app.events.get_events(event.account, jid, types) + if not events_: + log.warning('No Events') + return + + if event.type.is_groupchat: + id_ = events_[-1].stanza_id or events_[-1].message_id + else: + id_ = events_[-1].message_id + + if id_ != event.marker_id: + return + + if not app.events.remove_events(event.account, jid, types=types): + # There were events to remove + if control is not None: + control.redraw_after_event_removed(event.jid) + @staticmethod def handle_event_msgsent(obj): if not obj.play_sound: @@ -1060,6 +1097,7 @@ def create_core_handlers_list(self): 'unsubscribed-presence-received': [ self.handle_event_unsubscribed_presence], 'zeroconf-name-conflict': [self.handle_event_zc_name_conflict], + 'read-state-sync': [self.handle_event_read_state_sync], } def register_core_handlers(self): ===================================== gajim/gui_menu_builder.py ===================================== @@ -511,12 +511,13 @@ def get_transport_menu(contact, account): return menu -def get_singlechat_menu(control_id, account, jid): +def get_singlechat_menu(control_id, account, jid, type_): singlechat_menu = [ (_('Send File'), [ ('win.send-file-httpupload-', _('Upload File…')), ('win.send-file-jingle-', _('Send File Directly…')), ]), + ('win.send-marker-', _('Send Read Markers')), (_('Send Chatstate'), ['chatstate']), ('win.invite-contacts-', _('Invite Contacts…')), ('win.add-to-roster-', _('Add to Contact List…')), @@ -545,6 +546,9 @@ def build_menu(preset): for item in preset: if isinstance(item[1], str): action_name, label = item + if action_name == 'win.send-marker-' and type_ == 'pm': + continue + if action_name == 'app.browse-history': menuitem = Gio.MenuItem.new(label, action_name) dict_ = {'account': GLib.Variant('s', account), View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/8b70a7666a2bdcb42315dc37be8b6091… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/8b70a7666a2bdcb42315dc37be8b6091… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][chat_markers] 5 commits: UserAvatar: Adapt to nbxmpp changes
by Philipp Hörist 15 Nov '20

15 Nov '20

Philipp Hörist pushed to branch chat_markers at gajim / gajim Commits: fc3b9c4c by lovetox at 2020-11-08T07:32:31+01:00 UserAvatar: Adapt to nbxmpp changes - - - - - 29110347 by wurstsalat at 2020-11-11T22:37:32+01:00 Accounts: Add icon to Add Account page - - - - - e40d17a7 by Yann Leboulanger at 2020-11-15T14:19:19+01:00 Add Chat Markers (XEP-0333) - - - - - 9d722383 by wurstsalat at 2020-11-15T14:19:19+01:00 Improvements - - - - - 79cb44c7 by wurstsalat at 2020-11-15T14:19:19+01:00 Improvements 2 - - - - - 18 changed files: - gajim/chat_control.py - gajim/chat_control_base.py - gajim/common/const.py - gajim/common/events.py - gajim/common/modules/__init__.py - + gajim/common/modules/chat_markers.py - gajim/common/modules/message.py - gajim/common/modules/user_avatar.py - gajim/common/setting_values.py - gajim/common/settings.py - gajim/common/structs.py - gajim/conversation_textview.py - gajim/data/style/gajim.css - gajim/groupchat_control.py - gajim/gtk/accounts.py - gajim/gtk/groupchat_settings.py - gajim/gui_interface.py - gajim/gui_menu_builder.py Changes: ===================================== gajim/chat_control.py ===================================== @@ -123,7 +123,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): # Menu for the HeaderBar self.control_menu = gui_menu_builder.get_singlechat_menu( - self.control_id, self.account, self.contact.jid) + self.control_id, self.account, self.contact.jid, self._type) # Settings menu self.xml.settings_menu.set_menu_model(self.control_menu) @@ -228,6 +228,7 @@ def __init__(self, parent_win, contact, acct, session, resource=None): ('mam-decrypted-message-received', ged.GUI1, self._on_mam_decrypted_message_received), ('decrypted-message-received', ged.GUI1, self._on_decrypted_message_received), ('receipt-received', ged.GUI1, self._receipt_received), + ('displayed-received', ged.GUI1, self._displayed_received), ('message-error', ged.GUI1, self._on_message_error), ('zeroconf-error', ged.GUI1, self._on_zeroconf_error), ]) @@ -271,6 +272,15 @@ def add_actions(self): act.connect('change-state', self._on_send_chatstate) self.parent_win.window.add_action(act) + marker = self.contact.settings.get('send_marker') + + act = Gio.SimpleAction.new_stateful( + f'send-marker-{self.control_id}', + None, + GLib.Variant.new_boolean(marker)) + act.connect('change-state', self._on_send_marker) + self.parent_win.window.add_action(act) + def update_actions(self): win = self.parent_win.window online = app.account_is_connected(self.account) @@ -338,6 +348,12 @@ def update_actions(self): tooltip_text = _('No File Transfer available') self.xml.sendfile_button.set_tooltip_text(tooltip_text) + # Chat markers + state = GLib.Variant.new_boolean( + self.contact.settings.get('send_marker')) + win.lookup_action( + f'send-marker-{self.control_id}').change_state(state) + # Convert to GC if app.settings.get_account_setting(self.account, 'is_zeroconf'): win.lookup_action( @@ -363,6 +379,7 @@ def remove_actions(self): 'information-', 'start-call-', 'send-chatstate-', + 'send-marker-', ] for action in actions: self.parent_win.window.remove_action(f'{action}{self.control_id}') @@ -435,6 +452,10 @@ def _on_send_chatstate(self, action, param): action.set_state(param) self.contact.settings.set('send_chatstate', param.get_string()) + def _on_send_marker(self, action, param): + action.set_state(param) + self.contact.settings.set('send_marker', param.get_boolean()) + def subscribe_events(self): """ Register listeners to the events class @@ -643,6 +664,10 @@ def _on_message_sent(self, event): def _receipt_received(self, event): self.conv_textview.show_receipt(event.receipt_id) + @event_filter(['account', 'jid']) + def _displayed_received(self, event): + self.conv_textview.show_displayed(event.marker_id) + @event_filter(['account', 'jid']) def _on_zeroconf_error(self, event): self.add_status_message(event.message) @@ -1385,6 +1410,14 @@ def read_queue(self): self.set_session(event.session) if message_ids: app.storage.archive.set_read_messages(message_ids) + + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None app.events.remove_events(self.account, jid_with_resource, types=[str(self._type)]) ===================================== gajim/chat_control_base.py ===================================== @@ -218,6 +218,9 @@ def __init__(self, parent_win, widget_name, contact, acct, self.received_history_pos = 0 self.orig_msg = None + # For XEP-0333 + self.last_msg_id = None + self.correcting = False self.last_sent_msg = None @@ -1116,6 +1119,7 @@ def add_message(self, displaymarking=None, msg_log_id=None, message_id=None, + stanza_id=None, correct_id=None, additional_data=None, marker=None, @@ -1159,6 +1163,12 @@ def add_message(self, if restored: return + if message_id: + if self._type.is_groupchat: + self.last_msg_id = stanza_id or message_id + else: + self.last_msg_id = message_id + if kind == 'incoming': if (not self._type.is_groupchat or self.contact.can_notify() or @@ -1203,7 +1213,10 @@ def add_message(self, event = event_type(text, subject, - self, msg_log_id, + self, + msg_log_id, + message_id=message_id, + stanza_id=stanza_id, show_in_roster=show_in_roster, show_in_systray=show_in_systray) app.events.add_event(self.account, full_jid, event) @@ -1355,7 +1368,7 @@ def set_control_active(self, state): jid = self.contact.jid if self.conv_textview.autoscroll: # we are at the end - type_ = ['printed_%s' % self._type] + type_ = [f'printed_{self._type}'] if self._type.is_groupchat: type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] if not app.events.remove_events(self.account, @@ -1363,6 +1376,12 @@ def set_control_active(self, state): types=type_): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> marker + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None # send chatstate inactive to the one we're leaving # and active to the one we visit if self.msg_textview.has_text(): @@ -1391,20 +1410,27 @@ def _on_edge_reached(self, _scrolledwindow, pos): types_list = [] if self._type.is_groupchat: types_list = ['printed_gc_msg', 'gc_msg', 'printed_marked_gc_msg'] - else: # Not a GC - types_list = ['printed_%s' % self._type, str(self._type)] + else: + types_list = [f'printed_{self._type}', str(self._type)] if not app.events.get_events(self.account, jid, types_list): return if not self.parent_win: return - if self.parent_win.get_active_control() == self and \ - self.parent_win.window.is_active(): + if (self.parent_win.get_active_control() == self and + self.parent_win.window.is_active()): # we are at the end if not app.events.remove_events( self.account, jid, types=types_list): # There were events to remove self.redraw_after_event_removed(jid) + # XEP-0333 Send <displayed> tag + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_scrollbar_button_release(self, scrollbar, event): if event.get_button()[1] != 1: @@ -1469,6 +1495,8 @@ def redraw_after_event_removed(self, jid): We just removed a 'printed_*' event, redraw contact in roster or gc_roster and titles in roster and msg_win """ + if not self.parent_win: # minimized groupchat + return self.parent_win.redraw_tab(self) self.parent_win.show_title() # TODO : get the contact and check get_show_in_roster() ===================================== gajim/common/const.py ===================================== @@ -970,6 +970,7 @@ def is_error(self): Namespace.SECLABEL, Namespace.CONFERENCE, Namespace.CORRECT, + Namespace.CHATMARKERS, Namespace.EME, Namespace.XHTML_IM, Namespace.HASHES_2, ===================================== gajim/common/events.py ===================================== @@ -91,13 +91,16 @@ class PmEvent(ChatEvent): class PrintedChatEvent(Event): type_ = 'printed_chat' def __init__(self, message, subject, control, msg_log_id, time_=None, - show_in_roster=False, show_in_systray=True): + message_id=None, stanza_id=None, show_in_roster=False, + show_in_systray=True): Event.__init__(self, time_, show_in_roster=show_in_roster, - show_in_systray=show_in_systray) + show_in_systray=show_in_systray) self.message = message self.subject = subject self.control = control self.msg_log_id = msg_log_id + self.message_id = message_id + self.stanza_id = stanza_id class PrintedGcMsgEvent(PrintedChatEvent): type_ = 'printed_gc_msg' ===================================== gajim/common/modules/__init__.py ===================================== @@ -40,6 +40,7 @@ 'bookmarks', 'caps', 'carbons', + 'chat_markers', 'chatstates', 'delimiter', 'discovery', ===================================== gajim/common/modules/chat_markers.py ===================================== @@ -0,0 +1,123 @@ +# 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/>. + +# Chat Markers (XEP-0333) + +from nbxmpp.namespaces import Namespace +from nbxmpp.structs import StanzaHandler + +from gajim.common import app +from gajim.common.nec import NetworkEvent +from gajim.common.modules.base import BaseModule +from gajim.common.structs import OutgoingMessage + + +class ChatMarkers(BaseModule): + + _nbxmpp_extends = 'ChatMarkers' + + def __init__(self, con): + BaseModule.__init__(self, con) + + self.handlers = [ + StanzaHandler(name='message', + callback=self._process_chat_marker, + ns=Namespace.CHATMARKERS, + priority=47), + ] + + def _process_chat_marker(self, _con, _stanza, properties): + if not properties.is_marker or not properties.marker.is_displayed: + return + + if properties.type.is_error: + return + + if properties.type.is_groupchat: + manager = self._con.get_module('MUC').get_manager() + muc_data = manager.get(properties.muc_jid) + if muc_data is None: + return + + if properties.muc_nickname != muc_data.nick: + return + + self._raise_event('read-state-sync', properties) + return + + if properties.is_carbon_message and properties.carbon.is_sent: + self._raise_event('read-state-sync', properties) + return + + if properties.is_mam_message: + if properties.from_.bareMatch(self._con.get_own_jid()): + return + + self._raise_event('displayed-received', properties) + + def _raise_event(self, name, properties): + self._log.info('%s: %s %s', + name, + properties.jid, + properties.marker.id) + + jid = properties.jid + if not properties.is_muc_pm and not properties.type.is_groupchat: + jid = properties.jid.bare + + app.nec.push_outgoing_event( + NetworkEvent(name, + account=self._account, + jid=jid, + properties=properties, + type=properties.type, + is_muc_pm=properties.is_muc_pm, + marker_id=properties.marker.id)) + + def _send_marker(self, contact, marker, id_, type_): + jid = contact.jid + if contact.is_pm_contact: + jid = app.get_jid_without_resource(contact.jid) + + if type_ in ('gc', 'pm'): + disco_info = app.storage.cache.get_last_disco_info(jid) + + context = 'public' + if disco_info is not None and disco_info.muc_is_members_only: + context = 'private' + + if not app.settings.get_group_chat_setting( + self._account, jid, 'send_marker', context=context): + return + else: + if not app.settings.get_contact_setting( + self._account, jid, 'send_marker'): + return + + typ = 'groupchat' if type_ == 'gc' else 'chat' + message = OutgoingMessage(account=self._account, + contact=contact, + message=None, + type_=typ, + marker=(marker, id_), + play_sound=False) + self._con.send_message(message) + self._log.info('Send %s: %s', marker, contact.jid) + + def send_displayed_marker(self, contact, id_, type_): + self._send_marker(contact, 'displayed', id_, str(type_)) + + +def get_instance(*args, **kwargs): + return ChatMarkers(*args, **kwargs), 'ChatMarkers' ===================================== gajim/common/modules/message.py ===================================== @@ -350,6 +350,13 @@ def build_message_stanza(self, message): stanza.setTag('no-store', namespace=Namespace.MSG_HINTS) + # XEP-0333 + if message.message: + stanza.setMarkable() + if message.marker: + marker, id_ = message.marker + stanza.setMarker(marker, id_) + # Add other nodes if message.nodes is not None: for node in message.nodes: ===================================== gajim/common/modules/user_avatar.py ===================================== @@ -26,7 +26,8 @@ class UserAvatar(BaseModule): _nbxmpp_extends = 'UserAvatar' _nbxmpp_methods = [ - 'request_avatar', + 'request_avatar_metadata', + 'request_avatar_data', 'set_avatar', ] @@ -60,14 +61,14 @@ def _avatar_metadata_received(self, _con, _stanza, properties): avatar_info = metadata.infos[0] self._log.info('Request: %s %s', jid, avatar_info.id) - self._request_avatar(jid, avatar_info) + self._request_avatar_data(jid, avatar_info) @as_task - def _request_avatar(self, jid, avatar_info): + def _request_avatar_data(self, jid, avatar_info): _task = yield - avatar = yield self._nbxmpp('UserAvatar').request_avatar( - avatar_info, jid=jid) + avatar = yield self._nbxmpp('UserAvatar').request_avatar_data( + avatar_info.id, jid=jid) if is_error(avatar): self._log.warning(avatar) @@ -77,10 +78,9 @@ def _request_avatar(self, jid, avatar_info): app.interface.save_avatar(avatar.data) if self._con.get_own_jid().bare_match(jid): - app.config.set_per('accounts', - self._account, - 'avatar_sha', - avatar.sha) + app.settings.set_account_setting(self._account, + 'avatar_sha', + avatar.sha) else: self._con.get_module('Roster').set_avatar_sha( str(jid), avatar.sha) ===================================== gajim/common/setting_values.py ===================================== @@ -255,12 +255,16 @@ class _ACCOUNT_DEFAULT: 'filetransfer_preference': 'httpupload', 'send_chatstate_default': 'composing_only', 'gc_send_chatstate_default': 'composing_only', + 'send_marker_default': True, + 'gc_send_marker_private_default': True, + 'gc_send_marker_public_default': False, 'chat_history_max_age': -1, }, 'contact': { 'speller_language': '', 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', }, @@ -272,6 +276,7 @@ class _ACCOUNT_DEFAULT: 'minimize_on_autojoin': True, 'minimize_on_close': True, 'send_chatstate': HAS_ACCOUNT_DEFAULT, + 'send_marker': HAS_ACCOUNT_DEFAULT, 'encryption': '', 'sync_threshold': HAS_APP_DEFAULT, }, ===================================== gajim/common/settings.py ===================================== @@ -678,11 +678,13 @@ def set_group_chat_setting(self, def set_group_chat_settings(self, setting: str, - value: SETTING_TYPE) -> None: + value: SETTING_TYPE, + context: str = None) -> None: for account in self._account_settings: for jid in self._account_settings[account]['group_chat']: - self.set_group_chat_setting(account, jid, setting, value) + self.set_group_chat_setting( + account, jid, setting, value, context) def get_contact_setting(self, account: str, ===================================== gajim/common/structs.py ===================================== @@ -55,6 +55,7 @@ def __init__(self, type_, subject=None, chatstate=None, + marker=None, resource=None, user_nick=None, label=None, @@ -69,7 +70,7 @@ def __init__(self, if type_ not in ('chat', 'groupchat', 'normal', 'headline'): raise ValueError('Unknown message type: %s' % type_) - if not message and chatstate is None: + if not message and chatstate is None and marker is None: raise ValueError('Trying to send message without content') self.account = account @@ -91,6 +92,7 @@ def __init__(self, self.subject = subject self.chatstate = chatstate + self.marker = marker self.resource = resource self.user_nick = user_nick self.label = label ===================================== gajim/conversation_textview.py ===================================== @@ -38,6 +38,7 @@ from gajim.common import helpers from gajim.common import i18n from gajim.common.i18n import _ +from gajim.common.i18n import Q_ from gajim.common.helpers import AdditionalDataDict from gajim.common.const import StyleAttr from gajim.common.const import Trust @@ -311,6 +312,12 @@ def show_receipt(self, id_): return line.set_receipt() + def show_displayed(self, id_): + line = self._get_message_line(id_) + if line is None: + return + line.set_displayed() + def show_error(self, id_, error): line = self._get_message_line(id_) if line is None: @@ -1194,16 +1201,27 @@ def __init__(self, id_, timestamp, message_icons, start_mark): self.timestamp = timestamp self.start_mark = start_mark self._has_receipt = False + self._has_displayed = False self._message_icons = message_icons @property def has_receipt(self): return self._has_receipt + @property + def has_displayed(self): + return self._has_displayed + def set_receipt(self): self._has_receipt = True + if self._has_displayed: + return self._message_icons.set_receipt_icon_visible(True) + def set_displayed(self): + self._has_displayed = True + self._message_icons.set_displayed_icon_visible(True) + def set_correction(self, tooltip): self._message_icons.set_correction_icon_visible(True) self._message_icons.set_correction_tooltip(tooltip) @@ -1222,12 +1240,12 @@ def __init__(self): 'document-edit-symbolic', Gtk.IconSize.MENU) self._correction_image.set_no_show_all(True) - self._receipt_image = Gtk.Image.new_from_icon_name( + self._marker_image = Gtk.Image.new_from_icon_name( 'emblem-ok-symbolic', Gtk.IconSize.MENU) - self._receipt_image.get_style_context().add_class( + self._marker_image.get_style_context().add_class( 'receipt-received-color') - self._receipt_image.set_tooltip_text(_('Received')) - self._receipt_image.set_no_show_all(True) + self._marker_image.set_tooltip_text(_('Received')) + self._marker_image.set_no_show_all(True) self._error_image = Gtk.Image.new_from_icon_name( 'dialog-warning-symbolic', Gtk.IconSize.MENU) @@ -1235,14 +1253,22 @@ def __init__(self): self._error_image.set_no_show_all(True) self.add(self._correction_image) - self.add(self._receipt_image) + self.add(self._marker_image) self.add(self._error_image) self.show_all() def set_receipt_icon_visible(self, visible): if not app.settings.get('positive_184_ack'): return - self._receipt_image.set_visible(visible) + self._marker_image.set_visible(visible) + + def set_displayed_icon_visible(self, visible): + self._marker_image.set_visible(visible) + self._marker_image.get_style_context().remove_class( + 'receipt-received-color') + self._marker_image.get_style_context().add_class( + 'displayed-received-color') + self._marker_image.set_tooltip_text(Q_('?Message state:Read')) def set_correction_icon_visible(self, visible): self._correction_image.set_visible(visible) ===================================== gajim/data/style/gajim.css ===================================== @@ -295,6 +295,7 @@ button.flat.link { padding: 0; border: 0; } /*Receipts*/ .receipt-received-color { color: rgb(75, 181, 67); } +.displayed-received-color { color: rgb(0, 141, 242); } /*Dataforms*/ .field-fixed { font-size: 16px; font-weight: bold; padding-top:5px;} ===================================== gajim/groupchat_control.py ===================================== @@ -658,6 +658,17 @@ def on_groupchat_maximize(self): self.update_actions() self.set_lock_image() self.draw_banner_text() + type_ = ['printed_gc_msg', 'printed_marked_gc_msg'] + if not app.events.remove_events(self.account, + self.get_full_jid(), + types=type_): + # XEP-0333 Send <displayed> marker + con = app.connections[self.account] + con.get_module('ChatMarkers').send_displayed_marker( + self.contact, + self.last_msg_id, + self._type) + self.last_msg_id = None def _on_roster_row_activated(self, _roster, nick): self._start_private_message(nick) @@ -796,17 +807,21 @@ def _on_gc_message_received(self, event): else: if event.properties.muc_nickname == self.nick: self.last_sent_txt = event.msgtxt + stanza_id = None + if event.properties.stanza_id: + stanza_id = event.properties.stanza_id.id self.add_message(event.msgtxt, contact=event.properties.muc_nickname, tim=event.properties.timestamp, displaymarking=event.displaymarking, correct_id=event.correct_id, message_id=event.properties.id, + stanza_id=stanza_id, additional_data=event.additional_data) event.needs_highlight = self.needs_visual_notification(event.msgtxt) def on_private_message(self, nick, sent, msg, tim, session, additional_data, - msg_log_id=None, displaymarking=None): + message_id, msg_log_id=None, displaymarking=None): # Do we have a queue? fjid = self.room_jid + '/' + nick @@ -819,7 +834,9 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, session=session, displaymarking=displaymarking, sent_forwarded=sent, - additional_data=additional_data) + additional_data=additional_data, + message_id=message_id) + app.events.add_event(self.account, fjid, event) if allow_popup_window(self.account): @@ -837,7 +854,7 @@ def on_private_message(self, nick, sent, msg, tim, session, additional_data, def add_message(self, text, contact='', tim=None, displaymarking=None, correct_id=None, message_id=None, - additional_data=None): + stanza_id=None, additional_data=None): """ Add message to the ConversationsTextview @@ -887,6 +904,7 @@ def add_message(self, text, contact='', tim=None, displaymarking=displaymarking, correct_id=correct_id, message_id=message_id, + stanza_id=stanza_id, additional_data=additional_data) def get_nb_unread(self): @@ -1057,6 +1075,7 @@ def _on_decrypted_message_received(self, event): event.properties.timestamp, self.session, event.additional_data, + event.properties.id, msg_log_id=event.msg_log_id, displaymarking=event.displaymarking) ===================================== gajim/gtk/accounts.py ===================================== @@ -555,14 +555,24 @@ def _disable(): class AddNewAccountPage(Gtk.Box): def __init__(self): - Gtk.Box.__init__(self, orientation=Gtk.Orientation.VERTICAL) + Gtk.Box.__init__(self, + orientation=Gtk.Orientation.VERTICAL, + spacing=18) self.set_vexpand(True) self.set_hexpand(True) + self.set_margin_top(24) + pixbuf = Gtk.IconTheme.load_icon_for_scale( + Gtk.IconTheme.get_default(), + 'org.gajim.Gajim-symbolic', + 100, + self.get_scale_factor(), + 0) + self.add(Gtk.Image.new_from_pixbuf(pixbuf)) + button = Gtk.Button(label=_('Add Account')) button.get_style_context().add_class('suggested-action') button.set_action_name('app.add-account') button.set_halign(Gtk.Align.CENTER) - button.set_valign(Gtk.Align.CENTER) self.add(button) @@ -720,6 +730,19 @@ def __init__(self, account): 'button-style': 'destructive-action', 'button-callback': self._reset_gc_send_chatstate}), + Setting(SettingKind.SWITCH, + _('Send Read Markers'), + SettingType.VALUE, + app.settings.get_account_setting( + account, 'send_marker_default'), + callback=self._send_read_marker, + desc=_('Default for chats and private group chats'), + props={'button-text': _('Reset'), + 'button-tooltip': _('Reset all chats to the ' + 'current default value'), + 'button-style': 'destructive-action', + 'button-callback': self._reset_send_read_marker}), + Setting(SettingKind.POPOVER, _('Keep Chat History'), SettingType.ACCOUNT_CONFIG, @@ -739,6 +762,20 @@ def _reset_gc_send_chatstate(button): button.set_sensitive(False) app.settings.set_group_chat_settings('send_chatstate', None) + def _send_read_marker(self, state, _data): + app.settings.set_account_setting( + self._account, 'send_marker_default', state) + app.settings.set_account_setting( + self._account, 'gc_send_marker_private_default', state) + + def _reset_send_read_marker(self, button): + button.set_sensitive(False) + app.settings.set_contact_settings('send_marker', None) + app.settings.set_group_chat_settings( + 'send_marker', None, context='private') + for ctrl in app.interface.msg_win_mgr.get_controls(acct=self._account): + ctrl.update_actions() + class ConnectionPage(GenericSettingPage): ===================================== gajim/gtk/groupchat_settings.py ===================================== @@ -71,6 +71,13 @@ def __init__(self, account, jid, context): 'send_chatstate', props={'entries': chat_state}), + Setting(SettingKind.SWITCH, + _('Send Chat Markers'), + SettingType.GROUP_CHAT, + 'send_marker', + context=context, + desc=_('Let others know if you read up to this point')), + Setting(SettingKind.POPOVER, _('Sync Threshold'), SettingType.GROUP_CHAT, ===================================== gajim/gui_interface.py ===================================== @@ -242,6 +242,43 @@ def handle_event_presence(self, obj): if ctrl and ctrl.session and len(obj.contact_list) > 1: ctrl.remove_session(ctrl.session) + @staticmethod + def handle_event_read_state_sync(event): + if event.type.is_groupchat: + control = app.get_groupchat_control( + event.account, event.jid.bare) + if control is None: + log.warning('Groupchat control not found') + return + + jid = event.jid.bare + types = ['printed_gc_msg', 'printed_marked_gc_msg'] + + else: + types = ['chat', 'pm', 'printed_chat', 'printed_pm'] + jid = event.jid + + control = app.interface.msg_win_mgr.get_control(jid, event.account) + + # Compare with control.last_msg_id. + events_ = app.events.get_events(event.account, jid, types) + if not events_: + log.warning('No Events') + return + + if event.type.is_groupchat: + id_ = events_[-1].stanza_id or events_[-1].message_id + else: + id_ = events_[-1].message_id + + if id_ != event.marker_id: + return + + if not app.events.remove_events(event.account, jid, types=types): + # There were events to remove + if control is not None: + control.redraw_after_event_removed(event.jid) + @staticmethod def handle_event_msgsent(obj): if not obj.play_sound: @@ -1060,6 +1097,7 @@ def create_core_handlers_list(self): 'unsubscribed-presence-received': [ self.handle_event_unsubscribed_presence], 'zeroconf-name-conflict': [self.handle_event_zc_name_conflict], + 'read-state-sync': [self.handle_event_read_state_sync], } def register_core_handlers(self): ===================================== gajim/gui_menu_builder.py ===================================== @@ -511,12 +511,13 @@ def get_transport_menu(contact, account): return menu -def get_singlechat_menu(control_id, account, jid): +def get_singlechat_menu(control_id, account, jid, type_): singlechat_menu = [ (_('Send File'), [ ('win.send-file-httpupload-', _('Upload File…')), ('win.send-file-jingle-', _('Send File Directly…')), ]), + ('win.send-marker-', _('Send Read Markers')), (_('Send Chatstate'), ['chatstate']), ('win.invite-contacts-', _('Invite Contacts…')), ('win.add-to-roster-', _('Add to Contact List…')), @@ -545,6 +546,9 @@ def build_menu(preset): for item in preset: if isinstance(item[1], str): action_name, label = item + if action_name == 'win.send-marker-' and type_ == 'pm': + continue + if action_name == 'app.browse-history': menuitem = Gio.MenuItem.new(label, action_name) dict_ = {'account': GLib.Variant('s', account), View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/de1acdc0f4bf0a2693e06339effe212… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/de1acdc0f4bf0a2693e06339effe212… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] Remove unused import
by Philipp Hörist 13 Nov '20

13 Nov '20

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: fda964ed by lovetox at 2020-11-13T21:05:36+01:00 Remove unused import - - - - - 1 changed file: - nbxmpp/modules/vcard4.py Changes: ===================================== nbxmpp/modules/vcard4.py ===================================== @@ -17,7 +17,6 @@ import logging -from typing import Dict from typing import List from typing import Optional from typing import Set View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/fda964ed010d0035168c8c0c… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/fda964ed010d0035168c8c0c… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] VCard4: Add Parameters object
by Philipp Hörist 13 Nov '20

13 Nov '20

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: c98cfd58 by lovetox at 2020-11-13T21:03:04+01:00 VCard4: Add Parameters object - - - - - 1 changed file: - nbxmpp/modules/vcard4.py Changes: ===================================== nbxmpp/modules/vcard4.py ===================================== @@ -1,6 +1,26 @@ - +# Copyright (C) 2020 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# 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; either version 3 +# of the License, or (at your option) any later version. +# +# 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. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +import logging + +from typing import Dict from typing import List from typing import Optional +from typing import Set from dataclasses import dataclass from dataclasses import field @@ -15,6 +35,9 @@ from nbxmpp.modules.util import raise_if_error from nbxmpp.modules.util import finalize +log = logging.getLogger('nbxmpp.m.vcard4') + + ALLOWED_SEX_VALUES = ['M', 'F', 'O', 'N', 'U'] ALLOWED_KIND_VALUES = ['individual', 'group', 'org', 'location'] @@ -84,7 +107,7 @@ def get_data_from_children(node, child_name): def add_children(node, child_name, values): for value in values: - node.addchild(child_name, payload=value) + node.addChild(child_name, payload=value) def get_multiple_type_value(node, types): @@ -98,7 +121,7 @@ def get_multiple_type_value(node, types): def make_parameters(parameters): parameters_node = Node('parameters') - for parameter in parameters: + for parameter in parameters.values(): parameters_node.addChild(node=parameter.to_node()) return parameters_node @@ -109,9 +132,9 @@ def get_parameters(node): allowed_parameters = definition[0] parameters_node = node.getTag('parameters') if parameters_node is None: - return [] + return Parameters() - parameters = [] + parameters = {} for parameter in allowed_parameters: parameter_node = parameters_node.getTag(parameter) if parameter_node is None: @@ -122,9 +145,9 @@ def get_parameters(node): continue parameter = parameter_class.from_node(parameter_node) - parameters.append(parameter) + parameters[parameter.name] = parameter - return parameters + return Parameters(parameters) @dataclass @@ -157,7 +180,7 @@ class MultiParameter: name: str type: str - values: str + values: Set[str] @classmethod def from_node(cls, node): @@ -169,11 +192,11 @@ class MultiParameter: if not value_nodes: raise ValueError('no parameter value found') - values = [] + values = set() for value_node in value_nodes: value = value_node.getData() if value: - values.append(value) + values.add(value) if not values: raise ValueError('no parameter value found') @@ -272,6 +295,43 @@ class TzParameter: return node +class Parameters: + def __init__(self, parameters=None): + if parameters is None: + parameters = {} + self._parameters = parameters + + def values(self): + return self._parameters.values() + + def get_types(self): + parameter = self._parameters.get('type') + if parameter is None: + return set() + + return parameter.values + + def remove_types(self, types): + parameter = self._parameters.get('type') + if parameter is None: + raise ValueError('no type parameter') + + for type_ in types: + parameter.values.discard(type_) + + if not parameter.values: + self._parameters.pop('type') + + def add_types(self, types): + parameter = self._parameters.get('type') + if parameter is None: + parameter = TypeParameter(set(types)) + self._parameters['type'] = parameter + return + + parameter.values.update(types) + + PARAMETER_CLASSES = { 'language': LanguageParameter, 'pref': PrefParameter, @@ -291,7 +351,7 @@ class UriProperty: name: str value: str - parameters: List[Parameter] = field(default_factory=list) + parameters: Parameters = field(default_factory=Parameters) @classmethod def from_node(cls, node): @@ -320,7 +380,7 @@ class TextProperty: name: str value: str - parameters: List[Parameter] = field(default_factory=list) + parameters: Parameters = field(default_factory=Parameters) @classmethod def from_node(cls, node): @@ -349,7 +409,7 @@ class TextListProperty: name: str values: List[str] - parameters: List[Parameter] = field(default_factory=list) + parameters: Parameters = field(default_factory=Parameters) @classmethod def from_node(cls, node): @@ -381,7 +441,7 @@ class MultipleValueProperty: name: str value_type: str value: str - parameters: List[Parameter] = field(default_factory=list) + parameters: Parameters = field(default_factory=Parameters) @classmethod def from_node(cls, node): @@ -683,7 +743,7 @@ class RelatedProperty(MultipleValueProperty): @dataclass class CategoriesProperty(TextListProperty): - name: str = field(default='org', init=False) + name: str = field(default='categories', init=False) @dataclass @@ -844,7 +904,12 @@ def get_property_from_name(name, node): property_class = PROPERTY_CLASSES.get(name) if property_class is None: return None - return property_class.from_node(node) + + try: + return property_class.from_node(node) + except Exception as error: + log.warning('invalid vcard property: %s %s', error, node) + return None class VCard: @@ -908,6 +973,20 @@ class VCard: def add_property(self, name, *args, **kwargs): prop = PROPERTY_CLASSES.get(name)(*args, **kwargs) self._properties.append((None, prop)) + return prop + + def remove_property(self, prop): + for _group, props in list(self._properties): + if isinstance(props, list): + if prop in props: + props.remove(prop) + return + + elif prop is props: + self._properties.remove((None, props)) + return + + raise ValueError('prop not found in vcard') class VCard4(BaseModule): @@ -965,7 +1044,7 @@ def _get_vcard(item): try: vcard = VCard.from_node(vcard) - except Exception: - raise MalformedStanzaError('invalid vcard', item) + except Exception as error: + raise MalformedStanzaError('invalid vcard: %s' % error, item) return vcard View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/c98cfd5868beb2d86af27a5b… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/c98cfd5868beb2d86af27a5b… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] Accounts: Add icon to Add Account page
by Daniel Brötzmann 11 Nov '20

11 Nov '20

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: 29110347 by wurstsalat at 2020-11-11T22:37:32+01:00 Accounts: Add icon to Add Account page - - - - - 1 changed file: - gajim/gtk/accounts.py Changes: ===================================== gajim/gtk/accounts.py ===================================== @@ -555,14 +555,24 @@ def _disable(): class AddNewAccountPage(Gtk.Box): def __init__(self): - Gtk.Box.__init__(self, orientation=Gtk.Orientation.VERTICAL) + Gtk.Box.__init__(self, + orientation=Gtk.Orientation.VERTICAL, + spacing=18) self.set_vexpand(True) self.set_hexpand(True) + self.set_margin_top(24) + pixbuf = Gtk.IconTheme.load_icon_for_scale( + Gtk.IconTheme.get_default(), + 'org.gajim.Gajim-symbolic', + 100, + self.get_scale_factor(), + 0) + self.add(Gtk.Image.new_from_pixbuf(pixbuf)) + button = Gtk.Button(label=_('Add Account')) button.get_style_context().add_class('suggested-action') button.set_action_name('app.add-account') button.set_halign(Gtk.Align.CENTER) - button.set_valign(Gtk.Align.CENTER) self.add(button) View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/29110347c6368321e7a9a01419be2102… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/29110347c6368321e7a9a01419be2102… You're receiving this email because of your account on dev.gajim.org.

1 0

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

Commits November 2020