Split bookmarks plugin into headless and views

Fixes #1577

src/converse-bookmarks.js → src/converse-bookmark-views.js

@@ -1,7 +1,7 @@
 // Converse.js (A browser based XMPP chat client)
 // https://conversejs.org
 //
-// Copyright (c) 2012-2017, Jan-Carel Brand <jc@opkode.com>
+// Copyright (c) 2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
 /*global define */
@@ -21,7 +21,7 @@ const { Backbone, Promise, Strophe, $iq, sizzle, _ } = converse.env;
 const u = converse.env.utils;
 
 
-converse.plugins.add('converse-bookmarks', {
+converse.plugins.add('converse-bookmark-views', {
 
     /* Plugin dependencies are other plugins which might be
      * overridden or relied upon, and therefore need to be loaded before
@@ -88,23 +88,6 @@ converse.plugins.add('converse-bookmarks', {
                 }
             },
 
-            checkForReservedNick () {
-                /* Check if the user has a bookmark with a saved nickanme
-                 * for this groupchat, and if so use it.
-                 * Otherwise delegate to the super method.
-                 */
-                const { _converse } = this.__super__;
-                if (_.isUndefined(_converse.bookmarks) || !_converse.allow_bookmarks) {
-                    return this.__super__.checkForReservedNick.apply(this, arguments);
-                }
-                const model = _converse.bookmarks.findWhere({'jid': this.model.get('jid')});
-                if (!_.isUndefined(model) && model.get('nick')) {
-                    this.join(model.get('nick'));
-                } else {
-                    return this.__super__.checkForReservedNick.apply(this, arguments);
-                }
-            },
-
             onBookmarked () {
                 const { _converse } = this.__super__,
                       { __ } = _converse;
@@ -160,9 +143,7 @@ converse.plugins.add('converse-bookmarks', {
                 if (!models.length) {
                     this.renderBookmarkForm();
                 } else {
-                    _.forEach(models, function (model) {
-                        model.destroy();
-                    });
+                    models.forEach(model => model.destroy());
                     this.el.querySelector('.toggle-bookmark').classList.remove('button-on');
                 }
             }
@@ -181,15 +162,11 @@ converse.plugins.add('converse-bookmarks', {
         // Refer to docs/source/configuration.rst for explanations of these
         // configuration settings.
         _converse.api.settings.update({
-            allow_bookmarks: true,
-            allow_public_bookmarks: false,
             hide_open_bookmarks: true,
             muc_respect_autojoin: true
         });
-        // Promises exposed by this plugin
-        _converse.api.promises.add('bookmarksInitialized');
 
-        // Pure functions on the _converse object
+
         Object.assign(_converse, {
             removeBookmarkViaEvent (ev) {
                 /* Remove a bookmark as determined by the passed in
@@ -214,161 +191,6 @@ converse.plugins.add('converse-bookmarks', {
             },
         });
 
-        _converse.Bookmark = Backbone.Model;
-
-        _converse.Bookmarks = Backbone.Collection.extend({
-            model: _converse.Bookmark,
-            comparator: (item) => item.get('name').toLowerCase(),
-
-            initialize () {
-                this.on('add', _.flow(this.openBookmarkedRoom, this.markRoomAsBookmarked));
-                this.on('remove', this.markRoomAsUnbookmarked, this);
-                this.on('remove', this.sendBookmarkStanza, this);
-
-                const storage = _converse.config.get('storage'),
-                      cache_key = `converse.room-bookmarks${_converse.bare_jid}`;
-                this.fetched_flag = cache_key+'fetched';
-                this.browserStorage = new Backbone.BrowserStorage[storage](cache_key);
-            },
-
-            openBookmarkedRoom (bookmark) {
-                if ( _converse.muc_respect_autojoin && bookmark.get('autojoin')) {
-                    const groupchat = _converse.api.rooms.create(bookmark.get('jid'), bookmark.get('nick'));
-                    groupchat.maybeShow();
-                }
-                return bookmark;
-            },
-
-            fetchBookmarks () {
-                const deferred = u.getResolveablePromise();
-                if (this.browserStorage.records.length > 0) {
-                    this.fetch({
-                        'success': _.bind(this.onCachedBookmarksFetched, this, deferred),
-                        'error':  _.bind(this.onCachedBookmarksFetched, this, deferred)
-                    });
-                } else if (! window.sessionStorage.getItem(this.fetched_flag)) {
-                    // There aren't any cached bookmarks and the
-                    // `fetched_flag` is off, so we query the XMPP server.
-                    // If nothing is returned from the XMPP server, we set
-                    // the `fetched_flag` to avoid calling the server again.
-                    this.fetchBookmarksFromServer(deferred);
-                } else {
-                    deferred.resolve();
-                }
-                return deferred;
-            },
-
-            onCachedBookmarksFetched (deferred) {
-                return deferred.resolve();
-            },
-
-            createBookmark (options) {
-                this.create(options);
-                this.sendBookmarkStanza().catch(iq => this.onBookmarkError(iq, options));
-            },
-
-            sendBookmarkStanza () {
-                const stanza = $iq({
-                        'type': 'set',
-                        'from': _converse.connection.jid,
-                    })
-                    .c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
-                        .c('publish', {'node': 'storage:bookmarks'})
-                            .c('item', {'id': 'current'})
-                                .c('storage', {'xmlns':'storage:bookmarks'});
-                this.each(model => {
-                    stanza.c('conference', {
-                        'name': model.get('name'),
-                        'autojoin': model.get('autojoin'),
-                        'jid': model.get('jid'),
-                    }).c('nick').t(model.get('nick')).up().up();
-                });
-                stanza.up().up().up();
-                stanza.c('publish-options')
-                    .c('x', {'xmlns': Strophe.NS.XFORM, 'type':'submit'})
-                        .c('field', {'var':'FORM_TYPE', 'type':'hidden'})
-                            .c('value').t('http://jabber.org/protocol/pubsub#publish-options').up().up()
-                        .c('field', {'var':'pubsub#persist_items'})
-                            .c('value').t('true').up().up()
-                        .c('field', {'var':'pubsub#access_model'})
-                            .c('value').t('whitelist');
-                return _converse.api.sendIQ(stanza);
-            },
-
-            onBookmarkError (iq, options) {
-                _converse.log("Error while trying to add bookmark", Strophe.LogLevel.ERROR);
-                _converse.log(iq);
-                _converse.api.alert.show(
-                    Strophe.LogLevel.ERROR,
-                    __('Error'), [__("Sorry, something went wrong while trying to save your bookmark.")]
-                )
-                this.findWhere({'jid': options.jid}).destroy();
-            },
-
-            fetchBookmarksFromServer (deferred) {
-                const stanza = $iq({
-                    'from': _converse.connection.jid,
-                    'type': 'get',
-                }).c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
-                    .c('items', {'node': 'storage:bookmarks'});
-                _converse.api.sendIQ(stanza)
-                    .then((iq) => this.onBookmarksReceived(deferred, iq))
-                    .catch((iq) => this.onBookmarksReceivedError(deferred, iq)
-                );
-            },
-
-            markRoomAsBookmarked (bookmark) {
-                const groupchat = _converse.chatboxes.get(bookmark.get('jid'));
-                if (!_.isUndefined(groupchat)) {
-                    groupchat.save('bookmarked', true);
-                }
-            },
-
-            markRoomAsUnbookmarked (bookmark) {
-                const groupchat = _converse.chatboxes.get(bookmark.get('jid'));
-                if (!_.isUndefined(groupchat)) {
-                    groupchat.save('bookmarked', false);
-                }
-            },
-
-            createBookmarksFromStanza (stanza) {
-                const bookmarks = sizzle(
-                    `items[node="storage:bookmarks"] item storage[xmlns="storage:bookmarks"] conference`,
-                    stanza
-                );
-                _.forEach(bookmarks, (bookmark) => {
-                    const jid = bookmark.getAttribute('jid');
-                    this.create({
-                        'jid': jid,
-                        'name': bookmark.getAttribute('name') || jid,
-                        'autojoin': bookmark.getAttribute('autojoin') === 'true',
-                        'nick': _.get(bookmark.querySelector('nick'), 'textContent')
-                    });
-                });
-            },
-
-            onBookmarksReceived (deferred, iq) {
-                this.createBookmarksFromStanza(iq);
-                if (!_.isUndefined(deferred)) {
-                    return deferred.resolve();
-                }
-            },
-
-            onBookmarksReceivedError (deferred, iq) {
-                window.sessionStorage.setItem(this.fetched_flag, true);
-                _converse.log('Error while fetching bookmarks', Strophe.LogLevel.ERROR);
-                _converse.log(iq.outerHTML, Strophe.LogLevel.DEBUG);
-                if (!_.isNil(deferred)) {
-                    if (iq.querySelector('error[type="cancel"] item-not-found')) {
-                        // Not an exception, the user simply doesn't have
-                        // any bookmarks.
-                        return deferred.resolve();
-                    } else {
-                        return deferred.reject(new Error("Could not fetch bookmarks"));
-                    }
-                }
-            }
-        });
 
         _converse.MUCBookmarkForm = Backbone.VDOMView.extend({
             className: 'muc-bookmark-form',
@@ -413,11 +235,6 @@ converse.plugins.add('converse-bookmarks', {
             }
         });
 
-        _converse.BookmarksList = Backbone.Model.extend({
-            defaults: {
-                "toggle-state":  _converse.OPENED
-            }
-        });
 
         _converse.BookmarkView = Backbone.VDOMView.extend({
             toHTML () {
@@ -436,6 +253,7 @@ converse.plugins.add('converse-bookmarks', {
             }
         });
 
+
         _converse.BookmarksView = Backbone.OrderedListView.extend({
             tagName: 'div',
             className: 'bookmarks-list list-container rooms-list-container',
@@ -547,65 +365,18 @@ converse.plugins.add('converse-bookmarks', {
             }
         });
 
-        _converse.checkBookmarksSupport = async function () {
-            const identity = await _converse.api.disco.getIdentity('pubsub', 'pep', _converse.bare_jid);
-            if (_converse.allow_public_bookmarks) {
-                return !!identity;
-            } else {
-                return _converse.api.disco.supports(Strophe.NS.PUBSUB+'#publish-options', _converse.bare_jid);
-            }
-        }
-
-        const initBookmarks = async function () {
-            if (!_converse.allow_bookmarks) {
-                return;
-            }
-            const supported = await _converse.checkBookmarksSupport();
-            if (supported) {
-                _converse.bookmarks = new _converse.Bookmarks();
-                _converse.bookmarksview = new _converse.BookmarksView({'model': _converse.bookmarks});
-                await _converse.bookmarks.fetchBookmarks();
-            }
+        const initBookmarkViews = async function () {
+            await _converse.api.waitUntil('roomsPanelRendered');
+            _converse.bookmarksview = new _converse.BookmarksView({'model': _converse.bookmarks});
             /**
              * Triggered once the _converse.Bookmarks collection and _converse.BookmarksView view
              * has been created and cached bookmarks have been fetched.
-             *
-             * Also gets emitted if it was determined that the server doesn't
-             * have sufficient support for PEP-based bookmarks (in which case
-             * the above two instances don't get created).
-             * @event _converse#bookmarksInitialized
-             * @example _converse.api.listen.on('bookmarksInitialized', () => { ... });
+             * @event _converse#bookmarkViewsInitialized
+             * @example _converse.api.listen.on('bookmarkViewsInitialized', () => { ... });
              */
-            _converse.api.trigger('bookmarksInitialized');
+            _converse.api.trigger('bookmarkViewsInitialized');
         }
 
-        _converse.api.listen.on('clearSession', () => {
-            if (!_.isUndefined(_converse.bookmarks)) {
-                _converse.bookmarks.reset();
-                _converse.bookmarks.browserStorage._clear();
-                window.sessionStorage.removeItem(_converse.bookmarks.fetched_flag);
-            }
-        });
-
-        _converse.api.listen.on('reconnected', initBookmarks);
-
-        _converse.api.listen.on('connected', async () =>  {
-            // Add a handler for bookmarks pushed from other connected clients
-            // (from the same user obviously)
-            _converse.connection.addHandler(message => {
-                if (sizzle('event[xmlns="'+Strophe.NS.PUBSUB+'#event"] items[node="storage:bookmarks"]', message).length) {
-                    _converse.api.waitUntil('bookmarksInitialized')
-                        .then(() => _converse.bookmarks.createBookmarksFromStanza(message))
-                        .catch(_.partial(_converse.log, _, Strophe.LogLevel.FATAL));
-                }
-            }, null, 'message', 'headline', null, _converse.bare_jid);
-
-            await Promise.all([
-                _converse.api.waitUntil('chatBoxesFetched'),
-                _converse.api.waitUntil('roomsPanelRendered')
-            ]);
-            initBookmarks();
-        });
-
+        _converse.api.listen.on('bookmarksInitialized', initBookmarkViews);
     }
 });

src/converse-roomslist.js

@@ -48,7 +48,7 @@ converse.plugins.add('converse-roomslist', {
 
             comparator (room) {
                 if (room.get('bookmarked')) {
-                    const bookmark = _.head(_converse.bookmarksview.model.where({'jid': room.get('jid')}));
+                    const bookmark = _.head(_converse.bookmarks.where({'jid': room.get('jid')}));
                     return bookmark.get('name');
                 } else {
                     return room.get('name');
@@ -139,8 +139,8 @@ converse.plugins.add('converse-roomslist', {
             },
 
             getRoomsListElementName () {
-                if (this.model.get('bookmarked') && _converse.bookmarksview) {
-                    const bookmark = _.head(_converse.bookmarksview.model.where({'jid': this.model.get('jid')}));
+                if (this.model.get('bookmarked') && _converse.bookmarks) {
+                    const bookmark = _.head(_converse.bookmarks.where({'jid': this.model.get('jid')}));
                     return bookmark.get('name');
                 } else {
                     return this.model.get('name');

src/converse.js

@@ -8,8 +8,9 @@ import "@converse/headless/converse-mam";             // XEP-0313 Message Archiv
 import "@converse/headless/converse-ping";            // XEP-0199 XMPP Ping
 import "@converse/headless/converse-pubsub";          // XEP-0060 PubSub
 import "@converse/headless/converse-vcard";           // XEP-0054 VCard-temp
+import "@converse/headless/converse-bookmarks";       // XEP-0048 Bookmarks
 import "converse-autocomplete";
-import "converse-bookmarks";       // XEP-0048 Bookmarks
+import "converse-bookmark-views";  // Views for XEP-0048 Bookmarks
 import "converse-chatview";        // Renders standalone chat boxes for single user chat
 import "converse-controlbox";      // The control box
 import "converse-dragresize";      // Allows chat boxes to be resized by dragging them
@@ -31,7 +32,7 @@ import converse from "@converse/headless/converse-core";
 
 const WHITELISTED_PLUGINS = [
     'converse-autocomplete',
-    'converse-bookmarks',
+    'converse-bookmark-views',
     'converse-chatboxviews',
     'converse-chatview',
     'converse-controlbox',

src/headless/converse-bookmarks.js

@@ -1,7 +1,7 @@
 // Converse.js (A browser based XMPP chat client)
 // https://conversejs.org
 //
-// Copyright (c) 2012-2017, Jan-Carel Brand <jc@opkode.com>
+// Copyright (c) 2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
 /*global define */
@@ -65,6 +65,8 @@ converse.plugins.add('converse-bookmarks', {
             allow_public_bookmarks: false
         });
 
+        _converse.api.promises.add('bookmarksInitialized');
+
         /**
           * Check if the user has a bookmark with a saved nickanme
           * for this groupchat and return it.
@@ -72,7 +74,7 @@ converse.plugins.add('converse-bookmarks', {
           * @method _converse#getNicknameFromBookmark
           */
         _converse.getNicknameFromBookmark = function (jid) {
-            if (_converse.bookmarks || !_converse.allow_bookmarks) {
+            if (!_converse.bookmarks || !_converse.allow_bookmarks) {
                 return null;
             }
             const bookmark = _converse.bookmarks.findWhere({'jid': jid});

src/headless/converse-core.js

@@ -86,6 +86,7 @@ pluggable.enable(_converse, '_converse', 'pluggable');
 // These are just the @converse/headless plugins, for the full converse,
 // the other plugins are whitelisted in src/converse.js
 _converse.core_plugins = [
+    'converse-bookmarks',
     'converse-caps',
     'converse-chatboxes',
     'converse-disco',
@@ -352,7 +353,7 @@ function initPlugins() {
         {'_converse': _converse},
         whitelist, _converse.blacklisted_plugins
     );
-    
+
     /**
      * Triggered once all plugins have been initialized. This is a useful event if you want to
      * register event handlers but would like your own handlers to be overridable by

src/headless/headless.js

@@ -3,6 +3,7 @@
  * Any of the following components may be removed if they're not needed.
  */
 import "./converse-pubsub";      // XEP-0199 XMPP Ping
+import "./converse-bookmarks";   // XEP-0199 XMPP Ping
 import "./converse-chatboxes";   // Backbone Collection and Models for chat boxes
 import "./converse-disco";       // Service discovery plugin
 import "./converse-mam";         // XEP-0313 Message Archive Management