Mercurial > libervia-desktop-kivy
annotate cagou/plugins/plugin_wid_file_sharing.py @ 196:519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
FilterBehavior do a smooth animation for filtering out children of a layout according to a text content.
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 23 May 2018 21:25:08 +0200 |
parents | a68c9baa6694 |
children | 60b63c3e63a1 |
rev | line source |
---|---|
192 | 1 #!/usr/bin/python |
2 # -*- coding: utf-8 -*- | |
3 | |
4 # Cagou: desktop/mobile frontend for Salut à Toi XMPP client | |
5 # Copyright (C) 2016-2018 Jérôme Poisson (goffi@goffi.org) | |
6 | |
7 # This program is free software: you can redistribute it and/or modify | |
8 # it under the terms of the GNU Affero General Public License as published by | |
9 # the Free Software Foundation, either version 3 of the License, or | |
10 # (at your option) any later version. | |
11 | |
12 # This program is distributed in the hope that it will be useful, | |
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 # GNU Affero General Public License for more details. | |
16 | |
17 # You should have received a copy of the GNU Affero General Public License | |
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 | |
20 | |
21 from sat.core import log as logging | |
22 from sat.core import exceptions | |
23 log = logging.getLogger(__name__) | |
24 from sat.core.i18n import _ | |
25 from sat.tools.common import files_utils | |
26 from sat_frontends.quick_frontend import quick_widgets | |
27 from sat_frontends.tools import jid | |
28 from cagou.core.constants import Const as C | |
29 from cagou.core import cagou_widget | |
196
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
30 from cagou.core.utils import FilterBehavior |
192 | 31 from cagou import G |
32 from kivy import properties | |
33 from kivy.uix.label import Label | |
34 from kivy.uix.button import Button | |
35 from kivy.uix.boxlayout import BoxLayout | |
36 from kivy.garden import modernmenu | |
37 from kivy.clock import Clock | |
38 from kivy.metrics import dp | |
39 from functools import partial | |
40 import os.path | |
41 import json | |
42 | |
43 | |
44 PLUGIN_INFO = { | |
45 "name": _(u"file sharing"), | |
46 "main": "FileSharing", | |
47 "description": _(u"share/transfer files between devices"), | |
48 "icon_symbol": u"exchange", | |
49 } | |
50 MODE_VIEW = u"view" | |
51 MODE_LOCAL = u"local" | |
194
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
52 SELECT_INSTRUCTIONS = _(u"Please select entities to share with") |
192 | 53 |
54 | |
55 dist = modernmenu.dist | |
56 | |
57 | |
58 class ModeBtn(Button): | |
59 | |
60 def __init__(self, parent, **kwargs): | |
61 super(ModeBtn, self).__init__(**kwargs) | |
62 parent.bind(mode=self.on_mode) | |
63 self.on_mode(parent, parent.mode) | |
64 | |
65 def on_mode(self, parent, new_mode): | |
66 if new_mode == MODE_VIEW: | |
67 self.text = _(u"view shared files") | |
68 elif new_mode == MODE_LOCAL: | |
69 self.text = _(u"share local files") | |
70 else: | |
71 exceptions.InternalError(u"Unknown mode: {mode}".format(mode=new_mode)) | |
72 | |
73 | |
74 class Identities(object): | |
75 | |
76 def __init__(self, entity_ids): | |
77 identities = {} | |
78 for cat, type_, name in entity_ids: | |
79 identities.setdefault(cat, {}).setdefault(type_, []).append(name) | |
80 self.identities = identities | |
81 | |
82 @property | |
83 def name(self): | |
84 return self.identities.values()[0].values()[0][0] | |
85 | |
86 | |
87 class ItemWidget(BoxLayout): | |
88 click_timeout = properties.NumericProperty(0.4) | |
89 base_width = properties.NumericProperty(dp(100)) | |
90 | |
91 def __init__(self, sharing_wid, name): | |
92 self.sharing_wid = sharing_wid | |
93 self.name = name | |
94 super(ItemWidget, self).__init__() | |
95 | |
96 def on_touch_down(self, touch): | |
97 if not self.collide_point(*touch.pos): | |
98 return | |
99 t = partial(self.open_menu, touch) | |
100 touch.ud['menu_timeout'] = t | |
101 Clock.schedule_once(t, self.click_timeout) | |
102 return super(ItemWidget, self).on_touch_down(touch) | |
103 | |
104 def do_item_action(self, touch): | |
105 pass | |
106 | |
107 def on_touch_up(self, touch): | |
108 if touch.ud.get('menu_timeout'): | |
109 Clock.unschedule(touch.ud['menu_timeout']) | |
110 if self.collide_point(*touch.pos) and self.sharing_wid.menu is None: | |
111 self.do_item_action(touch) | |
112 return super(ItemWidget, self).on_touch_up(touch) | |
113 | |
114 def open_menu(self, touch, dt): | |
115 self.sharing_wid.open_menu(self, touch) | |
116 del touch.ud['menu_timeout'] | |
117 | |
118 def getMenuChoices(self): | |
119 """return choice adapted to selected item | |
120 | |
121 @return (list[dict]): choices ad expected by ModernMenu | |
122 """ | |
123 return [] | |
124 | |
125 | |
126 class PathWidget(ItemWidget): | |
127 | |
128 def __init__(self, sharing_wid, filepath): | |
129 name = os.path.basename(filepath) | |
130 self.filepath = os.path.normpath(filepath) | |
131 if self.filepath == u'.': | |
132 self.filepath = u'' | |
133 super(PathWidget, self).__init__(sharing_wid, name) | |
134 | |
135 @property | |
136 def is_dir(self): | |
137 raise NotImplementedError | |
138 | |
139 def do_item_action(self, touch): | |
140 if self.is_dir: | |
141 self.sharing_wid.current_dir = self.filepath | |
142 | |
143 def open_menu(self, touch, dt): | |
144 log.debug(_(u"opening menu for {path}").format(path=self.filepath)) | |
145 super(PathWidget, self).open_menu(touch, dt) | |
146 | |
147 | |
148 class LocalPathWidget(PathWidget): | |
149 | |
150 @property | |
151 def is_dir(self): | |
152 return os.path.isdir(self.filepath) | |
153 | |
154 def getMenuChoices(self): | |
155 choices = [] | |
156 if self.shared: | |
157 choices.append(dict(text=_(u'unshare'), | |
158 index=len(choices)+1, | |
159 callback=self.sharing_wid.unshare)) | |
160 else: | |
161 choices.append(dict(text=_(u'share'), | |
162 index=len(choices)+1, | |
163 callback=self.sharing_wid.share)) | |
164 return choices | |
165 | |
166 | |
167 class RemotePathWidget(PathWidget): | |
168 | |
169 def __init__(self, sharing_wid, filepath, type_): | |
170 self.type_ = type_ | |
171 super(RemotePathWidget, self).__init__(sharing_wid, filepath) | |
172 | |
173 @property | |
174 def is_dir(self): | |
175 return self.type_ == C.FILE_TYPE_DIRECTORY | |
176 | |
177 def do_item_action(self, touch): | |
178 if self.is_dir: | |
179 if self.filepath == u'..': | |
180 self.sharing_wid.remote_entity = u'' | |
181 else: | |
182 super(RemotePathWidget, self).do_item_action(touch) | |
183 else: | |
184 self.sharing_wid.request_item(self) | |
185 return True | |
186 | |
187 | |
188 class DeviceWidget(ItemWidget): | |
189 | |
190 def __init__(self, sharing_wid, entity_jid, identities): | |
191 self.entity_jid = entity_jid | |
192 self.identities = identities | |
193 self.own_device = entity_jid.bare == next(G.host.profiles.itervalues()).whoami | |
194 name = self.identities.name if self.own_device else self.entity_jid.node | |
195 super(DeviceWidget, self).__init__(sharing_wid, name) | |
196 | |
197 def do_item_action(self, touch): | |
198 self.sharing_wid.remote_entity = self.entity_jid | |
199 self.sharing_wid.remote_dir = u'' | |
200 | |
201 | |
202 class CategorySeparator(Label): | |
203 pass | |
204 | |
205 | |
206 class Menu(modernmenu.ModernMenu): | |
207 pass | |
208 | |
209 | |
196
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
210 class FileSharing(quick_widgets.QuickWidget, cagou_widget.CagouWidget, FilterBehavior): |
192 | 211 SINGLE=False |
212 float_layout = properties.ObjectProperty() | |
213 layout = properties.ObjectProperty() | |
214 mode = properties.OptionProperty(MODE_LOCAL, options=[MODE_VIEW, MODE_LOCAL]) | |
215 local_dir = properties.StringProperty(os.path.expanduser(u'~')) | |
216 remote_dir = properties.StringProperty(u'') | |
217 remote_entity = properties.StringProperty(u'') | |
218 shared_paths = properties.ListProperty() | |
219 signals_registered = False | |
220 | |
221 def __init__(self, host, target, profiles): | |
222 quick_widgets.QuickWidget.__init__(self, host, target, profiles) | |
223 cagou_widget.CagouWidget.__init__(self) | |
196
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
224 FilterBehavior.__init__(self) |
192 | 225 self.mode_btn = ModeBtn(self) |
226 self.mode_btn.bind(on_release=self.change_mode) | |
227 self.headerInputAddExtra(self.mode_btn) | |
228 self.bind(local_dir=self.update_view, | |
229 remote_dir=self.update_view, | |
230 remote_entity=self.update_view) | |
231 self.update_view() | |
232 self.menu = None | |
233 self.menu_item = None | |
234 self.float_layout.bind(children=self.clean_fl_children) | |
235 if not FileSharing.signals_registered: | |
236 # FIXME: we use this hack (registering the signal for the whole class) now | |
237 # as there is currently no unregisterSignal available in bridges | |
238 G.host.registerSignal("FISSharedPathNew", handler=FileSharing.shared_path_new, iface="plugin") | |
239 G.host.registerSignal("FISSharedPathRemoved", handler=FileSharing.shared_path_removed, iface="plugin") | |
240 FileSharing.signals_registered = True | |
241 G.host.bridge.FISLocalSharesGet(self.profile, | |
242 callback=self.fill_paths, | |
243 errback=G.host.errback) | |
244 | |
245 @property | |
246 def current_dir(self): | |
247 return self.local_dir if self.mode == MODE_LOCAL else self.remote_dir | |
248 | |
249 @current_dir.setter | |
250 def current_dir(self, new_dir): | |
251 if self.mode == MODE_LOCAL: | |
252 self.local_dir = new_dir | |
253 else: | |
254 self.remote_dir = new_dir | |
255 | |
256 def fill_paths(self, shared_paths): | |
257 self.shared_paths.extend(shared_paths) | |
258 | |
259 def change_mode(self, mode_btn): | |
260 self.clear_menu() | |
261 opt = self.__class__.mode.options | |
262 new_idx = (opt.index(self.mode)+1) % len(opt) | |
263 self.mode = opt[new_idx] | |
264 | |
265 def on_mode(self, instance, new_mode): | |
266 print(instance) | |
267 self.update_view(None, self.local_dir) | |
268 | |
194
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
269 def onHeaderInput(self): |
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
270 if u'/' in self.header_input.text or self.header_input.text == u'~': |
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
271 self.current_dir = os.path.expanduser(self.header_input.text) |
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
272 |
196
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
273 def onHeaderInputComplete(self, wid, text, **kwargs): |
192 | 274 """we filter items when text is entered in input box""" |
194
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
275 if u'/' in text: |
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
276 return |
196
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
277 self.do_filter(self.layout.children, |
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
278 text, |
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
279 lambda c: c.name, |
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
280 width_cb=lambda c: c.base_width, |
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
281 height_cb=lambda c: c.minimum_height, |
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
282 continue_tests=[lambda c: not isinstance(c, ItemWidget), |
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
283 lambda c: c.name == u'..']) |
519b3a29743c
utils, plugin file sharing: new utils module, with a FilterBehavior:
Goffi <goffi@goffi.org>
parents:
194
diff
changeset
|
284 |
192 | 285 |
286 ## remote sharing callback ## | |
287 | |
288 def _discoFindByFeaturesCb(self, data): | |
289 entities_services, entities_own, entities_roster = data | |
290 for entities_map, title in ((entities_services, | |
291 _(u'services')), | |
292 (entities_own, | |
293 _(u'your devices')), | |
294 (entities_roster, | |
295 _(u'your contacts devices'))): | |
296 if entities_map: | |
297 self.layout.add_widget(CategorySeparator(text=title)) | |
298 for entity_str, entity_ids in entities_map.iteritems(): | |
299 entity_jid = jid.JID(entity_str) | |
300 item = DeviceWidget(self, | |
301 entity_jid, | |
302 Identities(entity_ids)) | |
303 self.layout.add_widget(item) | |
304 | |
305 def discover_devices(self): | |
306 """Looks for devices handling file "File Information Sharing" and display them""" | |
307 try: | |
308 namespace = self.host.ns_map['fis'] | |
309 except KeyError: | |
310 msg = _(u"can't find file information sharing namespace, is the plugin running?") | |
311 log.warning(msg) | |
312 G.host.addNote(_(u"missing plugin"), msg, C.XMLUI_DATA_LVL_ERROR) | |
313 return | |
314 self.host.bridge.discoFindByFeatures( | |
315 [namespace], [], False, True, True, True, self.profile, | |
316 callback=self._discoFindByFeaturesCb, | |
317 errback=partial(G.host.errback, | |
318 title=_(u"shared folder error"), | |
319 message=_(u"can't check sharing devices: {msg}"))) | |
320 | |
321 def FISListCb(self, files_data): | |
322 for file_data in files_data: | |
323 filepath = os.path.join(self.current_dir, file_data[u'name']) | |
324 item = RemotePathWidget( | |
325 self, | |
326 filepath=filepath, | |
327 type_=file_data[u'type']) | |
328 self.layout.add_widget(item) | |
329 | |
330 def FISListEb(self, failure_): | |
331 self.remote_dir = u'' | |
332 G.host.addNote( | |
333 _(u"shared folder error"), | |
334 _(u"can't list files for {remote_entity}: {msg}").format( | |
335 remote_entity=self.remote_entity, | |
336 msg=failure_), | |
337 level=C.XMLUI_DATA_LVL_WARNING) | |
338 | |
339 ## view generation ## | |
340 | |
341 def update_view(self, *args): | |
342 """update items according to current mode, entity and dir""" | |
343 log.debug(u'updating {}, {}'.format(self.current_dir, args)) | |
344 self.layout.clear_widgets() | |
345 self.header_input.text = u'' | |
194
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
346 self.header_input.hint_text = self.current_dir |
a68c9baa6694
plugin file sharing: use header hint to show current path, and open new path:
Goffi <goffi@goffi.org>
parents:
192
diff
changeset
|
347 |
192 | 348 if self.mode == MODE_LOCAL: |
349 filepath = os.path.join(self.local_dir, u'..') | |
350 self.layout.add_widget(LocalPathWidget(sharing_wid=self, filepath=filepath)) | |
351 files = sorted(os.listdir(self.local_dir)) | |
352 for f in files: | |
353 filepath = os.path.join(self.local_dir, f) | |
354 self.layout.add_widget(LocalPathWidget(sharing_wid=self, filepath=filepath)) | |
355 elif self.mode == MODE_VIEW: | |
356 if not self.remote_entity: | |
357 self.discover_devices() | |
358 else: | |
359 # we always a way to go back | |
360 # so user can return to previous list even in case of error | |
361 parent_path = os.path.join(self.remote_dir, u'..') | |
362 item = RemotePathWidget( | |
363 self, | |
364 filepath = parent_path, | |
365 type_ = C.FILE_TYPE_DIRECTORY) | |
366 self.layout.add_widget(item) | |
367 self.host.bridge.FISList( | |
368 self.remote_entity, | |
369 self.remote_dir, | |
370 {}, | |
371 self.profile, | |
372 callback=self.FISListCb, | |
373 errback=self.FISListEb) | |
374 | |
375 ## menu methods ## | |
376 | |
377 def clean_fl_children(self, layout, children): | |
378 """insure that self.menu and self.menu_item are None when menu is dimissed""" | |
379 if self.menu is not None and self.menu not in children: | |
380 self.menu = self.menu_item = None | |
381 | |
382 def clear_menu(self): | |
383 """remove menu if there is one""" | |
384 if self.menu is not None: | |
385 self.menu.dismiss() | |
386 self.menu = None | |
387 self.menu_item = None | |
388 | |
389 def open_menu(self, item, touch): | |
390 """open menu for item | |
391 | |
392 @param item(PathWidget): item when the menu has been requested | |
393 @param touch(kivy.input.MotionEvent): touch data | |
394 """ | |
395 if self.menu_item == item: | |
396 return | |
397 self.clear_menu() | |
398 pos = self.to_widget(*touch.pos) | |
399 choices = item.getMenuChoices() | |
400 if not choices: | |
401 return | |
402 self.menu = Menu(choices=choices, | |
403 center=pos, | |
404 size_hint=(None, None)) | |
405 self.float_layout.add_widget(self.menu) | |
406 self.menu.start_display(touch) | |
407 self.menu_item = item | |
408 | |
409 ## Share methods ## | |
410 | |
411 def share(self, menu): | |
412 item = self.menu_item | |
413 self.clear_menu() | |
414 G.host.bridge.FISSharePath( | |
415 item.name, | |
416 item.filepath, | |
417 json.dumps({}, ensure_ascii=False), | |
418 self.profile, | |
419 callback=lambda name: G.host.addNote( | |
420 _(u"sharing folder"), | |
421 _(u"{name} is now shared").format(name=name)), | |
422 errback=partial(G.host.errback, | |
423 title=_(u"sharing folder"), | |
424 message=_(u"can't share folder: {msg}"))) | |
425 | |
426 def unshare(self, menu): | |
427 item = self.menu_item | |
428 self.clear_menu() | |
429 G.host.bridge.FISUnsharePath( | |
430 item.filepath, | |
431 self.profile, | |
432 callback=lambda: G.host.addNote( | |
433 _(u"sharing folder"), | |
434 _(u"{name} is not shared anymore").format(name=item.name)), | |
435 errback=partial(G.host.errback, | |
436 title=_(u"sharing folder"), | |
437 message=_(u"can't unshare folder: {msg}"))) | |
438 | |
439 def fileJingleRequestCb(self, progress_id, item, dest_path): | |
440 G.host.addNote( | |
441 _(u"file request"), | |
442 _(u"{name} download started at {dest_path}").format( | |
443 name = item.name, | |
444 dest_path = dest_path)) | |
445 | |
446 def request_item(self, item): | |
447 """Retrieve an item from remote entity | |
448 | |
449 @param item(RemotePathWidget): item to retrieve | |
450 """ | |
451 path, name = os.path.split(item.filepath) | |
452 assert name | |
453 assert self.remote_entity | |
454 extra = {'path': path} | |
455 dest_path = files_utils.get_unique_name(os.path.join(G.host.downloads_dir, name)) | |
456 G.host.bridge.fileJingleRequest(self.remote_entity, | |
457 dest_path, | |
458 name, | |
459 u'', | |
460 u'', | |
461 extra, | |
462 self.profile, | |
463 callback=partial(self.fileJingleRequestCb, | |
464 item=item, | |
465 dest_path=dest_path), | |
466 errback=partial(G.host.errback, | |
467 title = _(u"file request error"), | |
468 message = _(u"can't request file: {msg}"))) | |
469 | |
470 @classmethod | |
471 def shared_path_new(cls, shared_path, name, profile): | |
472 for wid in G.host.getVisibleList(cls): | |
473 if shared_path not in wid.shared_paths: | |
474 wid.shared_paths.append(shared_path) | |
475 | |
476 @classmethod | |
477 def shared_path_removed(cls, shared_path, profile): | |
478 for wid in G.host.getVisibleList(cls): | |
479 if shared_path in wid.shared_paths: | |
480 wid.shared_paths.remove(shared_path) | |
481 else: | |
482 log.warning(_(u"shared path {path} not found in {widget}".format( | |
483 path = shared_path, widget = wid))) |