annotate cagou/plugins/plugin_wid_contact_list.py @ 219:9faccd140119

plugin contact list: refactoring: - contacts are now displayed in a grid - they can be filtered thanks to FilterBehaviour - use the new update system of QuickContactList - a new "add a contact" button is visible, but not implemented yet.
author Goffi <goffi@goffi.org>
date Sun, 24 Jun 2018 22:26:15 +0200
parents 0ddd2b20cc6b
children e1a385a791cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/python
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # Cagou: desktop/mobile frontend for Salut à Toi XMPP client
126
cd99f70ea592 global file reorganisation:
Goffi <goffi@goffi.org>
parents: 110
diff changeset
5 # Copyright (C) 2016-2018 Jérôme Poisson (goffi@goffi.org)
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21 from sat.core import log as logging
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
22 log = logging.getLogger(__name__)
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
23 from cagou.core.constants import Const as C
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
24 from sat.core.i18n import _
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from sat_frontends.quick_frontend.quick_contact_list import QuickContactList
22
74117b733bac plugin chat: first draft:
Goffi <goffi@goffi.org>
parents: 17
diff changeset
26 from sat_frontends.tools import jid
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
27 from kivy.uix.boxlayout import BoxLayout
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
28 from kivy.uix.behaviors import ButtonBehavior
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
29 from cagou.core.utils import FilterBehavior
110
34dfe0e32064 contact list: text entered in header input do filtering in shown contacts
Goffi <goffi@goffi.org>
parents: 90
diff changeset
30 from kivy.metrics import dp
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
31 from kivy import properties
15
56838ad5c84b files reorganisation, cagou is now launched with python2 cagou.py in src/
Goffi <goffi@goffi.org>
parents: 14
diff changeset
32 from cagou.core import cagou_widget
56838ad5c84b files reorganisation, cagou is now launched with python2 cagou.py in src/
Goffi <goffi@goffi.org>
parents: 14
diff changeset
33 from cagou.core import image
16
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
34 from cagou import G
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
35 import bisect
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
36
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
37
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
38 PLUGIN_INFO = {
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
39 "name": _(u"contacts"),
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
40 "main": "ContactList",
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
41 "description": _(u"list of contacts"),
180
0ddd2b20cc6b plugins chat, contact_list, settings, widget_selector: changed icons theme
Goffi <goffi@goffi.org>
parents: 126
diff changeset
42 "icon_medium": u"{media}/icons/muchoslava/png/contact_list_no_border_blue_44.png"
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
43 }
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
44
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 10
diff changeset
45
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
46 class Avatar(image.Image):
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
47 pass
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
48
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
49
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
50 class ContactItem(ButtonBehavior, BoxLayout):
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
51 base_width = dp(150)
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
52 data = properties.DictProperty()
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
53 jid = properties.StringProperty('')
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
54
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
55 def __init__(self, **kwargs):
50
c45d6e9ec731 contact list: fixed contact list display
Goffi <goffi@goffi.org>
parents: 39
diff changeset
56 super(ContactItem, self).__init__(**kwargs)
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
57
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
58 def on_release(self):
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
59 # XXX: for now clicking on an item launch the corresponding Chat widget
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
60 # behaviour should change in the future
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
61 try:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
62 # FIXME: Q&D way to get chat plugin, should be replaced by a clean method
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
63 # in host
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
64 plg_infos = [p for p in G.host.getPluggedWidgets()
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
65 if 'chat' in p['import_name']][0]
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
66 except IndexError:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
67 log.warning(u"No plugin widget found to display chat")
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
68 else:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
69 factory = plg_infos['factory']
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
70 G.host.switchWidget(self, factory(plg_infos,
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
71 jid.JID(self.jid),
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
72 profiles=iter(G.host.profiles)))
22
74117b733bac plugin chat: first draft:
Goffi <goffi@goffi.org>
parents: 17
diff changeset
73
74117b733bac plugin chat: first draft:
Goffi <goffi@goffi.org>
parents: 17
diff changeset
74
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
75 class ContactList(QuickContactList, cagou_widget.CagouWidget, FilterBehavior):
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
76 float_layout = properties.ObjectProperty()
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
77 layout = properties.ObjectProperty()
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
78
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
79 def __init__(self, host, target, profiles):
16
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
80 QuickContactList.__init__(self, G.host, profiles)
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
81 cagou_widget.CagouWidget.__init__(self)
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
82 FilterBehavior.__init__(self)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
83 self._wid_map = {} # (profile, bare_jid) to widget map
17
5c9feaa060a5 contact list: added call to the new postInit method
Goffi <goffi@goffi.org>
parents: 16
diff changeset
84 self.postInit()
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
85 if len(self.profiles) != 1:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
86 raise NotImplementedError('multi profiles is not implemented yet')
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
87 self.update(profile=next(iter(self.profiles)))
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
88
110
34dfe0e32064 contact list: text entered in header input do filtering in shown contacts
Goffi <goffi@goffi.org>
parents: 90
diff changeset
89 def onHeaderInputComplete(self, wid, text):
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
90 self.do_filter(self.layout.children,
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
91 text,
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
92 lambda c: c.jid,
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
93 width_cb=lambda c: c.base_width,
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
94 height_cb=lambda c: c.minimum_height,
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
95 )
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
96
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
97 def _addContactItem(self, bare_jid, profile):
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
98 """Create a new ContactItem instance, and add it
110
34dfe0e32064 contact list: text entered in header input do filtering in shown contacts
Goffi <goffi@goffi.org>
parents: 90
diff changeset
99
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
100 item will be added in a sorted position
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
101 @param bare_jid(jid.JID): entity bare JID
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
102 @param profile(unicode): profile where the contact is
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
103 """
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
104 data = G.host.contact_lists[profile].getItem(bare_jid)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
105 wid = ContactItem(data=data, jid=bare_jid)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
106 child_jids = [c.jid for c in reversed(self.layout.children)]
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
107 idx = bisect.bisect_right(child_jids, bare_jid)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
108 self.layout.add_widget(wid, -idx)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
109 self._wid_map[(profile, bare_jid)] = wid
9
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
110
7b0a53d2afd3 contact list: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
111 def update(self, entities=None, type_=None, profile=None):
50
c45d6e9ec731 contact list: fixed contact list display
Goffi <goffi@goffi.org>
parents: 39
diff changeset
112 log.debug("update: %s %s %s" % (entities, type_, profile))
219
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
113 if type_ == None or type_ == C.UPDATE_STRUCTURE:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
114 log.debug("full contact list update")
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
115 self.layout.clear_widgets()
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
116 for bare_jid, data in self.items_sorted.iteritems():
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
117 wid = ContactItem(data=data, jid=bare_jid)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
118 self.layout.add_widget(wid)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
119 self._wid_map[(profile, bare_jid)] = wid
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
120 elif type_ == C.UPDATE_MODIFY:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
121 for entity in entities:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
122 entity_bare = entity.bare
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
123 wid = self._wid_map[(profile, entity_bare)]
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
124 wid.data = G.host.contact_lists[profile].getItem(entity_bare)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
125 elif type_ == C.UPDATE_ADD:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
126 for entity in entities:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
127 self._addContactItem(entity.bare, profile)
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
128 elif type_ == C.UPDATE_DELETE:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
129 for entity in entities:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
130 try:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
131 self.layout.remove_widget(self._wid_map.pop((profile, entity.bare)))
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
132 except KeyError:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
133 log.debug("entity not found: {entity}".format(entity=entity.bare))
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
134 else:
9faccd140119 plugin contact list: refactoring:
Goffi <goffi@goffi.org>
parents: 180
diff changeset
135 log.debug("update type not handled: {update_type}".format(update_type=type_))