summaryrefslogtreecommitdiff
path: root/src/bookmarks.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/bookmarks.py')
-rw-r--r--src/bookmarks.py289
1 files changed, 0 insertions, 289 deletions
diff --git a/src/bookmarks.py b/src/bookmarks.py
deleted file mode 100644
index c7d26a51..00000000
--- a/src/bookmarks.py
+++ /dev/null
@@ -1,289 +0,0 @@
-"""
-Bookmarks module
-
-Therein the bookmark class is defined, representing one conference room.
-This object is used to generate elements for both local and remote
-bookmark storage. It can also parse xml Elements.
-
-This module also defines several functions for retrieving and updating
-bookmarks, both local and remote.
-
-Poezio start scenario:
-
-- upon inital connection, poezio will disco#info the server
-- the available storage methods will be stored in the available_storage dict
- (either 'pep' or 'privatexml')
-- if only one is available, poezio will set the use_bookmarks_method config option
- to it. If both are, it will be set to 'privatexml' (or if it was previously set, the
- value will be kept).
-- it will then query the preferred storages for bookmarks and cache them locally
- (Bookmark objects with a method='remote' attribute)
-
-Adding a remote bookmark:
-
-- New Bookmark object added to the list with storage='remote'
-- All bookmarks are sent to the storage selected in use_bookmarks_method
- if there was an error, the user is notified.
-
-
-"""
-
-import functools
-import logging
-
-from slixmpp.plugins.xep_0048 import Bookmarks, Conference, URL
-from slixmpp import JID
-from common import safeJID
-from config import config
-
-log = logging.getLogger(__name__)
-
-
-class Bookmark(object):
-
- def __init__(self, jid, name=None, autojoin=False, nick=None, password=None, method='local'):
- self.jid = jid
- self.name = name or jid
- self.autojoin = autojoin
- self.nick = nick
- self.password = password
- self._method = method
-
- @property
- def method(self):
- return self._method
-
- @method.setter
- def method(self, value):
- if value not in ('local', 'remote'):
- log.debug('Could not set bookmark storing method: %s', value)
- return
- self._method = value
-
- def __repr__(self):
- return '<%s%s|%s>' % (self.jid,
- ('/'+self.nick) if self.nick else '',
- self.method)
-
- def stanza(self):
- """
- Generate a <conference/> stanza from the instance
- """
- el = Conference()
- el['name'] = self.name
- el['jid'] = self.jid
- el['autojoin'] = 'true' if self.autojoin else 'false'
- if self.nick:
- el['nick'] = self.nick
- if self.password:
- el['password'] = self.password
- return el
-
- def local(self):
- """Generate a str for local storage"""
- local = self.jid
- if self.nick:
- local += '/%s' % self.nick
- local += ':'
- if self.password:
- config.set_and_save('password', self.password, section=self.jid)
- return local
-
- @functools.singledispatch
- @staticmethod
- def parse(el):
- """
- Generate a Bookmark object from a <conference/> element
- (this is a fallback for raw XML Elements)
- """
- jid = el.get('jid')
- name = el.get('name')
- autojoin = True if el.get('autojoin', 'false').lower() in ('true', '1') else False
- nick = None
- for n in el.iter('nick'):
- nick = n.text
- password = None
- for p in el.iter('password'):
- password = p.text
-
- return Bookmark(jid, name, autojoin, nick, password, method='remote')
-
- @staticmethod
- @parse.register(Conference)
- def parse_from_stanza(el):
- """
- Parse a Conference element into a Bookmark object
- """
- jid = el['jid']
- autojoin = el['autojoin']
- password = el['password']
- nick = el['nick']
- name = el['name']
- return Bookmark(jid, name, autojoin, nick, password, method='remote')
-
-class BookmarkList(object):
-
- def __init__(self):
- self.bookmarks = []
- preferred = config.get('use_bookmarks_method').lower()
- if preferred not in ('pep', 'privatexml'):
- preferred = 'privatexml'
- self.preferred = preferred
- self.available_storage = {
- 'privatexml': False,
- 'pep': False,
- }
-
- def __getitem__(self, key):
- if isinstance(key, (str, JID)):
- for i in self.bookmarks:
- if key == i.jid:
- return i
- else:
- return self.bookmarks[key]
-
- def __in__(self, key):
- if isinstance(key, (str, JID)):
- for bookmark in self.bookmarks:
- if bookmark.jid == key:
- return True
- else:
- return key in self.bookmarks
- return False
-
- def remove(self, key):
- if isinstance(key, (str, JID)):
- for i in self.bookmarks[:]:
- if i.jid == key:
- self.bookmarks.remove(i)
- else:
- self.bookmarks.remove(key)
-
- def __iter__(self):
- return iter(self.bookmarks)
-
- def local(self):
- return [bm for bm in self.bookmarks if bm.method == 'local']
-
- def remote(self):
- return [bm for bm in self.bookmarks if bm.method == 'remote']
-
- def set(self, new):
- self.bookmarks = new
-
- def append(self, bookmark):
- bookmark_exists = self[bookmark.jid]
- if not bookmark_exists:
- self.bookmarks.append(bookmark)
- else:
- self.bookmarks.remove(bookmark_exists)
- self.bookmarks.append(bookmark)
-
- def set_bookmarks_method(self, value):
- if self.available_storage.get(value):
- self.preferred = value
- config.set_and_save('use_bookmarks_method', value)
-
- def save_remote(self, xmpp, callback):
- """Save the remote bookmarks."""
- if not any(self.available_storage.values()):
- return
- method = 'xep_0049' if self.preferred == 'privatexml' else 'xep_0223'
-
- if method:
- xmpp.plugin['xep_0048'].set_bookmarks(stanza_storage(self.bookmarks),
- method=method,
- callback=callback)
- def save_local(self):
- """Save the local bookmarks."""
- local = ''.join(bookmark.local() for bookmark in self if bookmark.method == 'local')
- config.set_and_save('rooms', local)
-
- def save(self, xmpp, core=None, callback=None):
- """Save all the bookmarks."""
- self.save_local()
- def _cb(iq):
- if callback:
- callback(iq)
- if iq["type"] == "error" and core:
- core.information('Could not save remote bookmarks.', 'Error')
- elif core:
- core.information('Bookmarks saved', 'Info')
- if config.get('use_remote_bookmarks'):
- self.save_remote(xmpp, _cb)
-
- def get_pep(self, xmpp, callback):
- """Add the remotely stored bookmarks via pep to the list."""
- def _cb(iq):
- if iq['type'] == 'result':
- for conf in iq['pubsub']['items']['item']['bookmarks']['conferences']:
- if isinstance(conf, URL):
- continue
- b = Bookmark.parse(conf)
- self.append(b)
- if callback:
- callback(iq)
-
- xmpp.plugin['xep_0048'].get_bookmarks(method='xep_0223', callback=_cb)
-
- def get_privatexml(self, xmpp, callback):
- """
- Fetch the remote bookmarks stored via privatexml.
- """
- def _cb(iq):
- if iq['type'] == 'result':
- for conf in iq['private']['bookmarks']['conferences']:
- b = Bookmark.parse(conf)
- self.append(b)
- if callback:
- callback(iq)
-
- xmpp.plugin['xep_0048'].get_bookmarks(method='xep_0049', callback=_cb)
-
- def get_remote(self, xmpp, information, callback):
- """Add the remotely stored bookmarks to the list."""
- force = config.get('force_remote_bookmarks')
- if xmpp.anon or not (any(self.available_storage.values()) or force):
- information('No remote bookmark storage available', 'Warning')
- return
-
- if force and not any(self.available_storage.values()):
- old_callback = callback
- method = 'pep' if self.preferred == 'pep' else 'privatexml'
- def new_callback(result):
- if result['type'] != 'error':
- self.available_storage[method] = True
- old_callback(result)
- else:
- information('No remote bookmark storage available', 'Warning')
- callback = new_callback
-
- if self.preferred == 'pep':
- self.get_pep(xmpp, callback=callback)
- else:
- self.get_privatexml(xmpp, callback=callback)
-
- def get_local(self):
- """Add the locally stored bookmarks to the list."""
- rooms = config.get('rooms')
- if not rooms:
- return
- rooms = rooms.split(':')
- for room in rooms:
- jid = safeJID(room)
- if jid.bare == '':
- continue
- if jid.resource != '':
- nick = jid.resource
- else:
- nick = None
- passwd = config.get_by_tabname('password', jid.bare, fallback=False) or None
- b = Bookmark(jid.bare, autojoin=True, nick=nick, password=passwd, method='local')
- self.append(b)
-
-def stanza_storage(bookmarks):
- """Generate a <storage/> stanza with the conference elements."""
- storage = Bookmarks()
- for b in (b for b in bookmarks if b.method == 'remote'):
- storage.append(b.stanza())
- return storage
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-06 19:09:46 +0000