Mercurial > libervia-desktop-kivy
view cagou/core/common.py @ 404:f7476818f9fb
core (common): JidSelector + behaviors various improvments:
- renamed *Behaviour => *Behavior to be consistent with Kivy + moved to new
"core.behaviors" modules
- use a dedicated property in ContactItem for notification counter (which is now named
"badge")
- in JidSelector, well-known strings now create use a dedicated layout, add separator
(except if new `add_separators` property is set to False), and are added to attribute of
the same name
- a new `item_class` property is now used to indicate the class to instanciate for items
(by default it's a ContactItem)
- FilterBahavior.do_filter now expect the parent layout instead of directly the children,
this is to allow a FilterBahavior to manage several children layout at once (used with
JidSelector)
- core.utils has been removed, as the behavior there has been moved to core.behaviors
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 12 Feb 2020 20:02:58 +0100 |
parents | 54f6a47cc60a |
children | 84ff5c917064 |
line wrap: on
line source
#!/usr/bin/env python3 # Cagou: desktop/mobile frontend for Salut à Toi XMPP client # Copyright (C) 2016-2020 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero 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 Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. """common simple widgets""" import json from functools import partial from sat.core.i18n import _ from sat.core import log as logging from kivy.uix.widget import Widget from kivy.uix.image import Image from kivy.uix.label import Label from kivy.uix.behaviors import ButtonBehavior from kivy.uix.behaviors import ToggleButtonBehavior from kivy.uix.stacklayout import StackLayout from kivy.uix.boxlayout import BoxLayout from kivy.uix.scrollview import ScrollView from kivy.event import EventDispatcher from kivy.metrics import dp from kivy import properties from sat_frontends.quick_frontend import quick_chat from .constants import Const as C from .common_widgets import CategorySeparator from cagou import G log = logging.getLogger(__name__) UNKNOWN_SYMBOL = 'Unknown symbol name' class IconButton(ButtonBehavior, Image): pass class Avatar(Image): pass class NotifLabel(Label): pass class ContactItem(BoxLayout): """An item from ContactList The item will drawn as an icon (JID avatar) with its jid below. If "notifs" are present in data, a notification counter will be drawn above the avatar. """ base_width = dp(150) avatar_layout = properties.ObjectProperty() avatar = properties.ObjectProperty() badge = properties.ObjectProperty(allownone=True) badge_text = properties.StringProperty('') profile = properties.StringProperty() data = properties.DictProperty() jid = properties.StringProperty('') def on_badge_text(self, wid, text): if text: if self.badge is not None: self.badge.text = text else: self.badge = NotifLabel( pos_hint={"right": 0.8, "y": 0}, text=text, ) self.avatar_layout.add_widget(self.badge) else: if self.badge is not None: self.avatar_layout.remove_widget(self.badge) self.badge = None class ContactButton(ButtonBehavior, ContactItem): pass class JidItem(BoxLayout): bg_color = properties.ListProperty([0.2, 0.2, 0.2, 1]) color = properties.ListProperty([1, 1, 1, 1]) jid = properties.StringProperty() profile = properties.StringProperty() nick = properties.StringProperty() avatar = properties.ObjectProperty() def on_avatar(self, wid, jid_): if self.jid and self.profile: self.getImage() def on_jid(self, wid, jid_): if self.profile and self.avatar: self.getImage() def on_profile(self, wid, profile): if self.jid and self.avatar: self.getImage() def getImage(self): host = G.host if host.contact_lists[self.profile].isRoom(self.jid.bare): self.avatar.opacity = 0 self.avatar.source = "" else: self.avatar.source = ( host.getAvatar(self.jid, profile=self.profile) or host.getDefaultAvatar(self.jid) ) class JidButton(ButtonBehavior, JidItem): pass class JidToggle(ToggleButtonBehavior, JidItem): selected_color = properties.ListProperty(C.COLOR_SEC_DARK) class Symbol(Label): symbol_map = None symbol = properties.StringProperty() def __init__(self, **kwargs): if self.symbol_map is None: with open(G.host.app.expand('{media}/fonts/fontello/config.json')) as f: fontello_conf = json.load(f) Symbol.symbol_map = {g['css']:g['code'] for g in fontello_conf['glyphs']} super(Symbol, self).__init__(**kwargs) def on_symbol(self, instance, symbol): try: code = self.symbol_map[symbol] except KeyError: log.warning(_("Invalid symbol {symbol}").format(symbol=symbol)) else: self.text = chr(code) class SymbolButton(ButtonBehavior, Symbol): pass class SymbolLabel(ButtonBehavior, BoxLayout): symbol = properties.StringProperty("") text = properties.StringProperty("") color = properties.ListProperty(C.COLOR_SEC) bold = properties.BooleanProperty(True) symbol_wid = properties.ObjectProperty() label = properties.ObjectProperty() class ActionSymbol(Symbol): pass class ActionIcon(BoxLayout): plugin_info = properties.DictProperty() def on_plugin_info(self, instance, plugin_info): self.clear_widgets() try: symbol = plugin_info['icon_symbol'] except KeyError: icon_src = plugin_info['icon_medium'] icon_wid = Image(source=icon_src, allow_stretch=True) self.add_widget(icon_wid) else: icon_wid = ActionSymbol(symbol=symbol) self.add_widget(icon_wid) class JidSelectorCategoryLayout(StackLayout): pass class JidSelector(ScrollView, EventDispatcher): layout = properties.ObjectProperty(None) # if item_class is changed, the properties must be the same as for ContactButton # and ordering must be supported item_class = properties.ObjectProperty(ContactButton) add_separators = properties.ObjectProperty(True) # list of item to show, can be: # - a well-known string which can be: # * "roster": all roster jids # * "opened_chats": all opened chat widgets # * "bookmarks": MUC bookmarks # A layout will be created each time and stored in the attribute of the same # name. # If add_separators is True, a CategorySeparator will be added on top of each # layout. # - a kivy Widget, which will be added to the layout (notable useful with # common_widgets.CategorySeparator) # - a callable, which must return an iterable of kwargs for ContactButton to_show = properties.ListProperty(['roster']) # if True, update() is called automatically when widget is created # if False, you'll have to call update() at least once manually implicit_update = properties.ObjectProperty(True) def __init__(self, **kwargs): self.register_event_type('on_select') # list of layouts containing items self.items_layouts = [] # jid to list of ContactButton instances map self.items_map = {} super().__init__(**kwargs) def on_kv_post(self, wid): if self.implicit_update: self.update() def on_select(self, wid): pass def on_parent(self, wid, parent): if parent is None: log.debug("removing contactsFilled listener") G.host.removeListener("contactsFilled", self.onContactsFilled) else: G.host.addListener("contactsFilled", self.onContactsFilled) def onContactsFilled(self, profile): log.debug("onContactsFilled event received") self.update() def _createItem(self, **kwargs): item = self.item_class(**kwargs) jid = kwargs['jid'] self.items_map.setdefault(jid, []).append(item) return item def update(self): log.debug("starting update") self.layout.clear_widgets() for item in self.to_show: if isinstance(item, str): if item == 'roster': self.addRosterItems() elif item == 'bookmarks': self.addBookmarksItems() elif item == 'opened_chats': self.addOpenedChatsItems() else: log.error(f'unknown "to_show" magic string {item!r}') elif isinstance(item, Widget): self.layout.add_widget(item) elif callable(item): items_kwargs = item() for item_kwargs in items_kwargs: item = self._createItem(**items_kwargs) item.bind(on_press=partial(self.dispatch, 'on_select')) self.layout.add_widget(item) else: log.error(f"unmanaged to_show item type: {item!r}") def addCategoryLayout(self, label=None): category_layout = JidSelectorCategoryLayout() if label and self.add_separators: category_layout.add_widget(CategorySeparator(text=label)) self.layout.add_widget(category_layout) self.items_layouts.append(category_layout) return category_layout def getItemFromWid(self, wid): """create JidSelector item from QuickChat widget""" contact_list = G.host.contact_lists[wid.profile] data=contact_list.getItem(wid.target) try: item = self._createItem( jid=wid.target, data=data, profile=wid.profile, ) except Exception as e: log.warning(f"Can't add contact {wid.target}: {e}") return notifs = list(G.host.getNotifs(wid.target, profile=wid.profile)) if notifs: item.badge_text = str(len(notifs)) item.bind(on_press=partial(self.dispatch, 'on_select')) return item def addOpenedChatsItems(self): self.opened_chats = category_layout = self.addCategoryLayout(_("Opened chats")) widgets = sorted(G.host.widgets.getWidgets( quick_chat.QuickChat, profiles = G.host.profiles, with_duplicates=False)) for wid in widgets: item = self.getItemFromWid(wid) if item is None: continue category_layout.add_widget(item) def addRosterItems(self): self.roster = category_layout = self.addCategoryLayout(_("Your contacts")) for profile in G.host.profiles: contact_list = G.host.contact_lists[profile] for entity_jid in sorted(contact_list.roster): item = self._createItem( jid=entity_jid, data=contact_list.getItem(entity_jid), profile=profile, ) item.bind(on_press=partial(self.dispatch, 'on_select')) category_layout.add_widget(item) def addBookmarksItems(self): self.bookmarks = category_layout = self.addCategoryLayout(_("Your chat rooms")) for profile in G.host.profiles: profile_manager = G.host.profiles[profile] try: bookmarks = profile_manager._bookmarks except AttributeError: log.warning(f"no bookmark in cache for profile {profile}") continue contact_list = G.host.contact_lists[profile] for entity_jid in bookmarks: try: cache = contact_list.getItem(entity_jid) except KeyError: cache = {} item = self._createItem( jid=entity_jid, data=cache, profile=profile, ) item.bind(on_press=partial(self.dispatch, 'on_select')) category_layout.add_widget(item)