Add a bookmarkstab (fixes #2004)

now we can edit stuff, save or cancel those modifications, and change
the chose storage easily

2 files changed, 148 insertions, 0 deletions

diff --git a/src/tabs/__init__.py b/src/tabs/__init__.py
index eaf41a2f..d0a881a6 100644
--- a/src/tabs/__init__.py
+++ b/src/tabs/__init__.py
@@ -10,3 +10,4 @@ from . listtab import ListTab
 from . muclisttab import MucListTab
 from . adhoc_commands_list import AdhocCommandsListTab
 from . data_forms import DataFormsTab
+from . bookmarkstab import BookmarksTab
diff --git a/src/tabs/bookmarkstab.py b/src/tabs/bookmarkstab.py
new file mode 100644
index 00000000..68cbbf40
--- /dev/null
+++ b/src/tabs/bookmarkstab.py
@@ -0,0 +1,147 @@
+"""
+Defines the data-forms Tab
+"""
+
+import logging
+log = logging.getLogger(__name__)
+
+import windows
+from bookmarks import Bookmark, BookmarkList, stanza_storage
+from tabs import Tab
+from common import safeJID
+
+from gettext import gettext as _
+
+
+class BookmarksTab(Tab):
+    """
+    A tab displaying lines of bookmarks, each bookmark having
+    a 4 widgets to set the jid/password/autojoin/storage method
+    """
+    plugin_commands = {}
+    def __init__(self, bookmarks: BookmarkList):
+        Tab.__init__(self)
+        self.name = "Bookmarks"
+        self.bookmarks = bookmarks
+        self.new_bookmarks = []
+        self.removed_bookmarks = []
+        self.header_win = windows.ColumnHeaderWin(('room@server/nickname',
+                                                   'password',
+                                                   'autojoin',
+                                                   'storage'))
+        self.bookmarks_win = windows.BookmarksWin(self.bookmarks,
+                                                  self.height-4,
+                                                  self.width, 1, 0)
+        self.help_win = windows.HelpText(_('Ctrl+Y: save, Ctrl+G: cancel, '
+                                           '↑↓: change lines, tab: change '
+                                           'column, M-a: add bookmark, C-k'
+                                           ': delete bookmark'))
+        self.info_header = windows.BookmarksInfoWin()
+        self.key_func['KEY_UP'] = self.bookmarks_win.go_to_previous_line_input
+        self.key_func['KEY_DOWN'] = self.bookmarks_win.go_to_next_line_input
+        self.key_func['^I'] = self.bookmarks_win.go_to_next_horizontal_input
+        self.key_func['^G'] = self.on_cancel
+        self.key_func['^Y'] = self.on_save
+        self.key_func['M-a'] = self.add_bookmark
+        self.key_func['^K'] = self.del_bookmark
+        self.resize()
+        self.update_commands()
+
+    def add_bookmark(self):
+        new_bookmark = Bookmark(safeJID('room@example.tld/nick'), method='local')
+        self.new_bookmarks.append(new_bookmark)
+        self.bookmarks_win.add_bookmark(new_bookmark)
+
+    def del_bookmark(self):
+        current = self.bookmarks_win.del_current_bookmark()
+        if current in self.new_bookmarks:
+            self.new_bookmarks.remove(current)
+        else:
+            self.removed_bookmarks.append(current)
+
+    def on_cancel(self):
+        self.core.close_tab()
+        return True
+
+    def on_save(self):
+        self.bookmarks_win.save()
+        if find_duplicates(self.new_bookmarks):
+            self.core.information(_('Duplicate bookmarks in list (saving aborted)'), 'Error')
+            return
+        for bm in self.new_bookmarks:
+            if safeJID(bm.jid):
+                if not self.bookmarks[bm.jid]:
+                    self.bookmarks.append(bm)
+            else:
+                self.core.information(_('Invalid JID for bookmark: %s/%s') % (bm.jid, bm.nick), 'Error')
+                return
+
+        for bm in self.removed_bookmarks:
+            if bm in self.bookmarks:
+                self.bookmarks.remove(bm)
+
+        def send_cb(success):
+            if success:
+                self.core.information(_('Bookmarks saved.'), 'Info')
+            else:
+                self.core.information(_('Remote bookmarks not saved.'), 'Error')
+        log.debug('alerte %s', str(stanza_storage(self.bookmarks.bookmarks)))
+        self.bookmarks.save(self.core.xmpp, callback=send_cb)
+        self.core.close_tab()
+        return True
+
+    def on_input(self, key, raw=False):
+        if key in self.key_func:
+            res = self.key_func[key]()
+            if res:
+                return res
+            self.bookmarks_win.refresh_current_input()
+        else:
+            self.bookmarks_win.on_input(key)
+
+    def resize(self):
+        self.need_resize = False
+        self.header_win.resize_columns({
+            'room@server/nickname': self.width//3,
+            'password': self.width//3,
+            'autojoin': self.width//6,
+            'storage': self.width//6
+            })
+        info_height = self.core.information_win_size
+        tab_height = Tab.tab_win_height()
+        self.header_win.resize(1, self.width, 0, 0)
+        self.bookmarks_win.resize(self.height - 3 - tab_height - info_height,
+                             self.width, 1, 0)
+        self.help_win.resize(1, self.width, self.height - 1, 0)
+        self.info_header.resize(1, self.width,
+                                 self.height - 2 - tab_height - info_height, 0)
+
+    def on_info_win_size_changed(self):
+        if self.core.information_win_size >= self.height - 3:
+            return
+        info_height = self.core.information_win_size
+        tab_height = Tab.tab_win_height()
+        self.bookmarks_win.resize(self.height - 3 - tab_height - info_height,
+                             self.width, 1, 0)
+        self.info_header.resize(1, self.width,
+                                 self.height - 2 - tab_height - info_height, 0)
+
+    def refresh(self):
+        if self.need_resize:
+            self.resize()
+        self.header_win.refresh()
+        self.refresh_tab_win()
+        self.help_win.refresh()
+        self.info_header.refresh(self.bookmarks.preferred)
+        self.info_win.refresh()
+        self.bookmarks_win.refresh()
+
+
+def find_duplicates(bm_list):
+    jids = set()
+    for bookmark in bm_list:
+        if bookmark.jid in jids:
+            return True
+        jids.add(bookmark.jid)
+    return False
+