Merge branch 'anon_login'

.gitignore

@@ -15,6 +15,7 @@ analytics.js
 .sass-cache
 ruby
 bourbon
+Gemfile.lock
 
 Backbone.Overview
 tags

converse.js

@@ -182,6 +182,10 @@
 
         // Constants
         // ---------
+        var LOGIN = "login";
+        var ANONYMOUS  = "anonymous";
+        var PREBIND = "prebind";
+
         var UNENCRYPTED = 0;
         var UNVERIFIED= 1;
         var VERIFIED= 2;
@@ -240,6 +244,7 @@
             allow_registration: true,
             animate: true,
             auto_list_rooms: false,
+            auto_login: false, // Currently only used in connection with anonymous login
             auto_reconnect: false,
             auto_subscribe: false,
             bosh_service_url: undefined, // The BOSH connection manager URL.
@@ -256,7 +261,9 @@
             message_carbons: false,
             no_trimming: false, // Set to true for phantomjs tests (where browser apparently has no width)
             play_sounds: false,
-            prebind: false,
+            password: undefined,
+            authentication: 'login', // Available values are "login", "prebind", "anonymous".
+            prebind: false, // XXX: Deprecated, use "authentication" instead.
             prebind_url: null,
             providers_link: 'https://xmpp.net/directory.php', // Link to XMPP providers shown on registration page
             rid: undefined,
@@ -284,6 +291,16 @@
         // Allow only whitelisted configuration attributes to be overwritten
         _.extend(this, _.pick(settings, Object.keys(this.default_settings)));
 
+        // BBB
+        if (this.prebind === true) { this.authentication = PREBIND; }
+
+        if (this.authentication === ANONYMOUS) {
+            if (!this.jid) {
+                throw("Config Error: you need to provide the server's domain via the " +
+                        "'jid' option when using anonymous authentication.");
+            }
+        }
+
         if (settings.visible_toolbar_buttons) {
             _.extend(
                 this.visible_toolbar_buttons,
@@ -431,7 +448,7 @@
 
         this.reconnect = function () {
             converse.giveFeedback(__('Reconnecting'), 'error');
-            if (!converse.prebind) {
+            if (converse.authentication !== "prebind") {
                 this.connection.connect(
                     this.connection.jid,
                     this.connection.pass,
@@ -690,7 +707,7 @@
         this.OTR = Backbone.Model.extend({
             // A model for managing OTR settings.
             getSessionPassphrase: function () {
-                if (converse.prebind) {
+                if (converse.authentication === 'prebind') {
                     var key = b64_sha1(converse.connection.jid),
                         pass = window.sessionStorage[key];
                     if (typeof pass === 'undefined') {
@@ -1730,8 +1747,7 @@
             },
 
             addContact: function (jid, name) {
-                name = _.isEmpty(name)? jid: name;
+                converse.connection.roster.add(jid, _.isEmpty(name)? jid: name, [], function (iq) {
-                converse.connection.roster.add(jid, name, [], function (iq) {
                     converse.connection.roster.subscribe(jid, null, converse.xmppstatus.get('fullname'));
                 });
             }
@@ -3139,13 +3155,6 @@
                     });
                 }
                 if (msgid && chatbox.messages.findWhere({msgid: msgid})) {
-                    // FIXME: There's still a bug here..
-                    // If a duplicate message is received just after the chat
-                    // box was closed, then it'll open again (due to it being
-                    // created here above), with no new messages.
-                    // The solution is mostly likely to not let chat boxes show
-                    // automatically when they are created, but to require
-                    // "show" to be called explicitly.
                     return true; // We already have this message stored.
                 }
                 if (!this.isOnlyChatStateNotification($message) && from !== converse.bare_jid) {
@@ -5154,8 +5163,14 @@
             initialize: function (cfg) {
                 cfg.$parent.html(this.$el.html(
                     converse.templates.login_panel({
+                        'LOGIN': LOGIN,
+                        'ANONYMOUS': ANONYMOUS,
+                        'PREBIND': PREBIND,
+                        'auto_login': converse.auto_login,
+                        'authentication': converse.authentication,
                         'label_username': __('XMPP Username:'),
                         'label_password': __('Password:'),
+                        'label_anon_login': __('Click here to log in anonymously'),
                         'label_login': __('Log In')
                     })
                 ));
@@ -5173,8 +5188,12 @@
 
             authenticate: function (ev) {
                 if (ev && ev.preventDefault) { ev.preventDefault(); }
-                var $form = $(ev.target),
+                var $form = $(ev.target);
-                    $jid_input = $form.find('input[name=jid]'),
+                if (converse.authentication === ANONYMOUS) {
+                    this.connect($form, converse.jid, null);
+                    return;
+                }
+                var $jid_input = $form.find('input[name=jid]'),
                     jid = $jid_input.val(),
                     $pw_input = $form.find('input[name=password]'),
                     password = $pw_input.val(),
@@ -5203,12 +5222,15 @@
             },
 
             connect: function ($form, jid, password) {
+                var resource;
                 if ($form) {
                     $form.find('input[type=submit]').hide().after('<span class="spinner login-submit"/>');
                 }
-                var resource = Strophe.getResourceFromJid(jid);
+                if (jid) {
-                if (!resource) {
+                    resource = Strophe.getResourceFromJid(jid);
-                    jid += '/converse.js-' + Math.floor(Math.random()*139749825).toString();
+                    if (!resource) {
+                        jid += '/converse.js-' + Math.floor(Math.random()*139749825).toString();
+                    }
                 }
                 converse.connection.connect(jid, password, converse.onConnect);
             },
@@ -5341,7 +5363,7 @@
                     rid = this.session.get('rid');
                     sid = this.session.get('sid');
                     jid = this.session.get('jid');
-                    if (this.prebind) {
+                    if (this.authentication === "prebind") {
                         if (!this.jid) {
                             throw new Error("initConnection: when using 'keepalive' with 'prebind, you must supply the JID of the current user.");
                         }
@@ -5359,11 +5381,23 @@
                         if (rid && sid && jid) {
                             this.session.save({rid: rid}); // The RID needs to be increased with each request.
                             this.connection.attach(jid, sid, rid, this.onConnect);
+                        } else if (this.auto_login) {
+                            if (!this.jid) {
+                                throw new Error("initConnection: If you use auto_login, you also need to provide a jid value");
+                            }
+                            if (this.authentication === ANONYMOUS) {
+                                this.connection.connect(this.jid, null, this.onConnect);
+                            } else if (this.authentication === LOGIN) {
+                                if (!this.password) {
+                                    throw new Error("initConnection: If you use auto_login and "+
+                                        "authentication='login' then you also need to provide a password.");
+                                }
+                                this.connection.connect(this.jid, this.password, this.onConnect);
+                            }
                         }
                     }
-
+                } else if (this.authentication == "prebind") {
-                // Prebind without keepalive
+                    // prebind is used without keepalive
-                } else if (this.prebind) {
                     if (this.jid && this.sid && this.rid) {
                         this.connection.attach(this.jid, this.sid, this.rid, this.onConnect);
                     } else {
@@ -5517,7 +5551,6 @@
                 converse.connection.roster.add(jid, _.isEmpty(name)? jid: name, [], function (iq) {
                     converse.connection.roster.subscribe(jid, null, converse.xmppstatus.get('fullname'));
                 });
-                return true;
             }
         },
         'chats': {

css/converse.css

@@ -353,7 +353,8 @@
   #conversejs .hor_centered {
     text-align: center;
     display: block;
-    margin: 0 auto; }
+    margin: 0 auto;
+    clear: both; }
   #conversejs .toggle-controlbox,
   #conversejs #minimized-chats {
     border-top-left-radius: 4px;
@@ -788,27 +789,32 @@
     text-overflow: ellipsis;
     overflow-x: hidden; }
   #conversejs dd.available-chatroom {
-    display: inline-block;
+    border: none;
-    overflow-x: hidden;
+    clear: both;
-    text-overflow: ellipsis;
+    color: #6C4C44;
+    display: block;
+    font-weight: bold;
+    overflow: hidden;
     padding: 0.25em 0.5em;
+    text-overflow: ellipsis;
+    text-shadow: 0 1px 0 #FAFAFA;
     white-space: nowrap; }
     #conversejs dd.available-chatroom a.open-room {
       width: 150px; }
-  #conversejs dd.available-chatroom:hover a.room-info {
+    #conversejs dd.available-chatroom:hover {
-    display: inline-block;
+      background-color: #E3C9C1; }
-    font-size: 14px; }
+      #conversejs dd.available-chatroom:hover .room-info {
-  #conversejs dd.available-chatroom,
+        display: inline-block;
+        font-size: 14px; }
   #conversejs #converse-roster dd {
-    font-weight: bold;
     border: none;
-    display: block;
-    color: #6C4C44;
-    text-shadow: 0 1px 0 #FAFAFA;
     clear: both;
-    overflow-y: hidden; }
+    color: #6C4C44;
+    display: block;
+    font-weight: bold;
+    overflow-y: hidden;
+    text-shadow: 0 1px 0 #FAFAFA; }
   #conversejs .roster-group:hover,
-  #conversejs dd.available-chatroom:hover,
   #conversejs #converse-roster dd:hover {
     background-color: #E3C9C1; }
   #conversejs .chatbox,
@@ -981,15 +987,15 @@
     font-weight: bold;
     height: auto;
     margin: 4px; }
-  #conversejs #converse-register .login-submit,
+  #conversejs #converse-register .login-submit, #conversejs #converse-register .submit, #conversejs #converse-login .login-submit, #conversejs #converse-login .submit {
-  #conversejs #converse-login .login-submit,
-  #conversejs #converse-register .submit,
-  #conversejs #converse-login .submit {
     height: 30px;
     padding: 0px;
     font-size: 14px; }
-  #conversejs #converse-login .submit {
+  #conversejs #converse-register .submit, #conversejs #converse-login .submit {
     margin: 1em 0; }
+  #conversejs #converse-register .login-anon, #conversejs #converse-login .login-anon {
+    height: auto;
+    white-space: normal; }
   #conversejs form.add-chatroom {
     background: none;
     padding: 0.5em; }

dev.html

@@ -52,6 +52,11 @@
 <script>
     require(['converse'], function (converse) {
         converse.initialize({
+            auto_login: true,
+            allow_registration: false,
+            allow_logout: false,
+            authentication: "anonymous",
+            jid: "opkode.im",
             bosh_service_url: 'https://conversejs.org/http-bind/', // Please use this connection manager only for testing purposes
             i18n: locales['en'], // Refer to ./locale/locales.js to see which locales are supported
             keepalive: true,

docs/source/configuration.rst

@@ -28,284 +28,30 @@ JS file so that it will include the new settings. Please refer to the
 Configuration variables
 =======================
 
-allow_contact_removal
+authentication
----------------------
-
-Default:  ``true``
-
-Allow the user to remove roster contacts by clicking on the delete icon
-(i.e. traschcan) next to a contact's name in the roster.
-
-allow_contact_requests
-----------------------
-
-Default:  ``true``
-
-Allow users to add one another as contacts. If this is set to false, the
-**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
-sections will all not appear. Additionally, all incoming contact requests will be
-ignored.
-
-allow_muc
----------
-
-Default:  ``true``
-
-Allow multi-user chat (muc) in chatrooms. Setting this to ``false`` will remove
-the ``Chatrooms`` tab from the control box.
-
-allow_otr
----------
-
-Default:  ``true``
-
-Allow Off-the-record encryption of single-user chat messages.
-
-allow_registration
-------------------
-
-Default:  ``true``
-
-Support for `XEP-0077: In band registration <http://xmpp.org/extensions/xep-0077.html>`_
-
-Allow XMPP account registration showing the corresponding UI register form interface.
-
-animate
--------
-
-Default:  ``true``
-
-Show animations, for example when opening and closing chat boxes.
-
-auto_list_rooms
----------------
-
-Default:  ``false``
-
-If true, and the XMPP server on which the current user is logged in supports
-multi-user chat, then a list of rooms on that server will be fetched.
-
-Not recommended for servers with lots of chat rooms.
-
-For each room on the server a query is made to fetch further details (e.g.
-features, number of occupants etc.), so on servers with many rooms this
-option will create lots of extra connection traffic.
-
-auto_reconnect
 --------------
 
-Default:  ``true``
+* Default:  ``login``
+* Allowed values: `login`_, `anonymous`_, `prebind`_
 
-Automatically reconnect to the XMPP server if the connection drops
+This option states the way converse.js will authenticate.
-unexpectedly.
 
-auto_subscribe
+login
---------------
+~~~~~
 
-Default:  ``false``
+The default means is ``login``, which means that the user either logs in manually with their
+username and password, or automatically if used together with ``auto_login=true``
+and ``jid`` and ``password`` values. See `auto_login`_.
 
-If true, the user will automatically subscribe back to any contact requests.
+anonymous
+~~~~~~~~~
 
-.. _`bosh-service-url`:
+This enables anonymous login if the XMPP server supports it. This option can be
-
+used together with `auto_login`_ to automatically and anonymously log a user in
-bosh_service_url
+as soon as the page loads.
-----------------
-
-Default: ``undefined``
-
-To connect to an XMPP server over HTTP you need a `BOSH <https://en.wikipedia.org/wiki/BOSH>`_
-connection manager which acts as a middle man between the HTTP and XMPP
-protocols.
-
-The bosh_service_url setting takes the URL of a BOSH connection manager.
-
-Please refer to your XMPP server's documentation on how to enable BOSH.
-For more information, read this blog post: `Which BOSH server do you need? <http://metajack.im/2008/09/08/which-bosh-server-do-you-need>`_
-
-A more modern alternative to BOSH is to use `websockets <https://developer.mozilla.org/en/docs/WebSockets>`_.
-Please see the :ref:`websocket-url` configuration setting.
-
-cache_otr_key
--------------
-
-Default:  ``false``
-
-Let the `OTR (Off-the-record encryption) <https://otr.cypherpunks.ca>`_ private
-key be cached in your browser's session storage.
-
-The browser's session storage persists across page loads but is deleted once
-the tab or window is closed.
-
-If this option is set to ``false``, a new OTR private key will be generated
-for each page load. While more inconvenient, this is a much more secure option.
-
-This setting can only be used together with ``allow_otr = true``.
-
-.. note::
-    A browser window's session storage is accessible by all javascript that
-    is served from the same domain. So if there is malicious javascript served by
-    the same server (or somehow injected via an attacker), then they will be able
-    to retrieve your private key and read your all the chat messages in your
-    current session. Previous sessions however cannot be decrypted.
-
-debug
------
-
-Default:  ``false``
-
-If set to true, debugging output will be logged to the browser console.
-
-domain_placeholder
-------------------
-
-Default: ``e.g. conversejs.org``
-
-The placeholder text shown in the domain input on the registration form.
-
-jid
----
-
-The Jabber ID or "JID" of the current user. The JID uniquely identifies a user
-on the XMPP network. It looks like an email address, but it's used for instant
-messaging instead.
-
-This value needs to be provided when using the :ref:`keepalive` option together
-with `prebind`_.
-
-
-.. _`keepalive`:
-
-keepalive
----------
-
-Default:    ``true``
-
-Determines whether Converse.js will maintain the chat session across page
-loads.
-
-This setting should also be used in conjunction with :ref:`prebind`.
-
-When using ``keepalive`` and ``prebind``, you will have to provide the `jid`_
-of the current user to ensure that a cached session is only resumed if it
-belongs to the current user.
-
-See also:
-
-* :ref:`session-support`
-* `Using prebind in connection with keepalive`_
-
-.. note::
-    Currently the "keepalive" setting only works with BOSH and not with
-    websockets. This is because XMPP over websocket does not use the same
-    session token as with BOSH. A possible solution for this is to implement
-    `XEP-0198 <http://xmpp.org/extensions/xep-0198.html>`_, specifically
-    with regards to "stream resumption".
-
-message_carbons
----------------
-
-Default:  ``false``
-
-Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_
-
-In order to keep all IM clients for a user engaged in a conversation,
-outbound messages are carbon-copied to all interested resources.
-
-This is especially important in webchat, like converse.js, where each browser
-tab serves as a separate IM client.
-
-Both message_carbons and `forward_messages`_ try to solve the same problem
-(showing sent messages in all connected chat clients aka resources), but go about it
-in two different ways.
-
-Message carbons is the XEP (Jabber protocol extension) specifically drafted to
-solve this problem, while `forward_messages`_ uses
-`stanza forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
-
-expose_rid_and_sid
-------------------
-
-Default:  ``false``
-
-Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed
-globally via the API. This allows other scripts served on the same page to use
-these values.
-
-*Beware*: a malicious script could use these tokens to assume your identity
-and inject fake chat messages.
-
-forward_messages
-----------------
-
-Default:  ``false``
-
-If set to ``true``, sent messages will also be forwarded to the sending user's
-bare JID (their Jabber ID independent of any chat clients aka resources).
-
-This means that sent messages are visible from all the user's chat clients,
-and not just the one from which it was actually sent.
-
-This is especially important for web chat, such as converse.js, where each
-browser tab functions as a separate chat client, with its own resource.
-
-This feature uses Stanza forwarding, see also `XEP 0297: Stanza Forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
-
-For an alternative approach, see also `message_carbons`_.
-
-fullname
---------
-
-If you are using prebinding, can specify the fullname of the currently
-logged in user, otherwise the user's vCard will be fetched.
-
-hide_muc_server
----------------
-
-Default:  ``false``
-
-Hide the ``server`` input field of the form inside the ``Room`` panel of the
-controlbox. Useful if you want to restrict users to a specific XMPP server of
-your choosing.
-
-hide_offline_users
-------------------
-
-Default:  ``false``
-
-If set to ``true``, then don't show offline users.
-
-i18n
-----
-
-Specify the locale/language. The language must be in the ``locales`` object. Refer to
-``./locale/locales.js`` to see which locales are supported.
-
-.. _`play-sounds`:
-
-play_sounds
------------
-
-Default:  ``false``
-
-Plays a notification sound when you receive a personal message or when your
-nickname is mentioned in a chat room.
-
-Inside the ``./sounds`` directory of the Converse.js repo, you'll see MP3 and Ogg
-formatted sound files. We need both, because neither format is supported by all browsers.
-
-Sound files are looked up by convention, not configuration. So to have
-a sound play when a message is received, make sure that your webserver serves
-it in both formats as ``http://yoursite.com/sounds/msg_received.mp3`` and
-``http://yoursite.com/sounds/msg_received.ogg``.
-
-``http://yoursite.com`` should of course be your site's URL.
-
-.. _`prebind`:
 
 prebind
---------
+~~~~~~~
-
-Default:  ``false``
 
 See also: :ref:`session-support`
 
@@ -342,19 +88,297 @@ Here's an example of converse.js being initialized with these three options:
     converse.initialize({
         bosh_service_url: 'https://bind.example.com',
         keepalive: true,
-        jid: me@example.com,
+        jid: 'me@example.com',
-        prebind: true,
+        authentication: 'prebind',
         prebind_url: 'http://example.com/api/prebind',
         allow_logout: false
     });
 
-.. note:: The ``prebind_url`` configuration setting is new in version 0.9 and
-    simplifies the code needed to set up and maintain prebinded sessions.
 
-    When using ``prebind``, ``prebind_url`` and ``keepalive``, you don't need
+allow_contact_removal
-    to manually pass in the RID, SID tokens anymore, but you still need to
+---------------------
-    provide the JID.
 
+* Default:  ``true``
+
+Allow the user to remove roster contacts by clicking on the delete icon
+(i.e. traschcan) next to a contact's name in the roster.
+
+allow_contact_requests
+----------------------
+
+* Default:  ``true``
+
+Allow users to add one another as contacts. If this is set to false, the
+**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
+sections will all not appear. Additionally, all incoming contact requests will be
+ignored.
+
+allow_muc
+---------
+
+* Default:  ``true``
+
+Allow multi-user chat (muc) in chatrooms. Setting this to ``false`` will remove
+the ``Chatrooms`` tab from the control box.
+
+allow_otr
+---------
+
+* Default:  ``true``
+
+Allow Off-the-record encryption of single-user chat messages.
+
+allow_registration
+------------------
+
+* Default:  ``true``
+
+Support for `XEP-0077: In band registration <http://xmpp.org/extensions/xep-0077.html>`_
+
+Allow XMPP account registration showing the corresponding UI register form interface.
+
+animate
+-------
+
+* Default:  ``true``
+
+Show animations, for example when opening and closing chat boxes.
+
+auto_list_rooms
+---------------
+
+* Default:  ``false``
+
+If true, and the XMPP server on which the current user is logged in supports
+multi-user chat, then a list of rooms on that server will be fetched.
+
+Not recommended for servers with lots of chat rooms.
+
+For each room on the server a query is made to fetch further details (e.g.
+features, number of occupants etc.), so on servers with many rooms this
+option will create lots of extra connection traffic.
+
+auto_login
+----------
+
+* Default:  ``false``
+
+This option can be used to let converse.js automatically log the user in as
+soon as the page loads.
+
+It should be used either with ``authentication`` set to ``anonymous`` or to
+``login``.
+
+If ``authentication`` is set to ``login``, then you will also need to provide a
+valid ``jid`` and ``password`` values.
+
+auto_reconnect
+--------------
+
+* Default:  ``true``
+
+Automatically reconnect to the XMPP server if the connection drops
+unexpectedly.
+
+auto_subscribe
+--------------
+
+* Default:  ``false``
+
+If true, the user will automatically subscribe back to any contact requests.
+
+.. _`bosh-service-url`:
+
+bosh_service_url
+----------------
+
+* Default: ``undefined``
+
+To connect to an XMPP server over HTTP you need a `BOSH <https://en.wikipedia.org/wiki/BOSH>`_
+connection manager which acts as a middle man between the HTTP and XMPP
+protocols.
+
+The bosh_service_url setting takes the URL of a BOSH connection manager.
+
+Please refer to your XMPP server's documentation on how to enable BOSH.
+For more information, read this blog post: `Which BOSH server do you need? <http://metajack.im/2008/09/08/which-bosh-server-do-you-need>`_
+
+A more modern alternative to BOSH is to use `websockets <https://developer.mozilla.org/en/docs/WebSockets>`_.
+Please see the :ref:`websocket-url` configuration setting.
+
+cache_otr_key
+-------------
+
+* Default:  ``false``
+
+Let the `OTR (Off-the-record encryption) <https://otr.cypherpunks.ca>`_ private
+key be cached in your browser's session storage.
+
+The browser's session storage persists across page loads but is deleted once
+the tab or window is closed.
+
+If this option is set to ``false``, a new OTR private key will be generated
+for each page load. While more inconvenient, this is a much more secure option.
+
+This setting can only be used together with ``allow_otr = true``.
+
+.. note::
+    A browser window's session storage is accessible by all javascript that
+    is served from the same domain. So if there is malicious javascript served by
+    the same server (or somehow injected via an attacker), then they will be able
+    to retrieve your private key and read your all the chat messages in your
+    current session. Previous sessions however cannot be decrypted.
+
+debug
+-----
+
+* Default:  ``false``
+
+If set to true, debugging output will be logged to the browser console.
+
+domain_placeholder
+------------------
+
+* Default: ``e.g. conversejs.org``
+
+The placeholder text shown in the domain input on the registration form.
+
+jid
+---
+
+The Jabber ID or "JID" of the current user. The JID uniquely identifies a user
+on the XMPP network. It looks like an email address, but it's used for instant
+messaging instead.
+
+This value needs to be provided when using the :ref:`keepalive` option together
+with `prebind`_.
+
+
+.. _`keepalive`:
+
+keepalive
+---------
+
+* Default:    ``true``
+
+Determines whether Converse.js will maintain the chat session across page
+loads.
+
+This setting should also be used in conjunction with ``authentication`` set to `prebind`_.
+
+When using ``keepalive`` and ``prebind``, you will have to provide the `jid`_
+of the current user to ensure that a cached session is only resumed if it
+belongs to the current user.
+
+See also:
+
+* :ref:`session-support`
+
+.. note::
+    Currently the "keepalive" setting only works with BOSH and not with
+    websockets. This is because XMPP over websocket does not use the same
+    session token as with BOSH. A possible solution for this is to implement
+    `XEP-0198 <http://xmpp.org/extensions/xep-0198.html>`_, specifically
+    with regards to "stream resumption".
+
+message_carbons
+---------------
+
+* Default:  ``false``
+
+Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_
+
+In order to keep all IM clients for a user engaged in a conversation,
+outbound messages are carbon-copied to all interested resources.
+
+This is especially important in webchat, like converse.js, where each browser
+tab serves as a separate IM client.
+
+Both message_carbons and `forward_messages`_ try to solve the same problem
+(showing sent messages in all connected chat clients aka resources), but go about it
+in two different ways.
+
+Message carbons is the XEP (Jabber protocol extension) specifically drafted to
+solve this problem, while `forward_messages`_ uses
+`stanza forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
+
+expose_rid_and_sid
+------------------
+
+* Default:  ``false``
+
+Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed
+globally via the API. This allows other scripts served on the same page to use
+these values.
+
+*Beware*: a malicious script could use these tokens to assume your identity
+and inject fake chat messages.
+
+forward_messages
+----------------
+
+* Default:  ``false``
+
+If set to ``true``, sent messages will also be forwarded to the sending user's
+bare JID (their Jabber ID independent of any chat clients aka resources).
+
+This means that sent messages are visible from all the user's chat clients,
+and not just the one from which it was actually sent.
+
+This is especially important for web chat, such as converse.js, where each
+browser tab functions as a separate chat client, with its own resource.
+
+This feature uses Stanza forwarding, see also `XEP 0297: Stanza Forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
+
+For an alternative approach, see also `message_carbons`_.
+
+fullname
+--------
+
+If you are using prebinding, can specify the fullname of the currently
+logged in user, otherwise the user's vCard will be fetched.
+
+hide_muc_server
+---------------
+
+* Default:  ``false``
+
+Hide the ``server`` input field of the form inside the ``Room`` panel of the
+controlbox. Useful if you want to restrict users to a specific XMPP server of
+your choosing.
+
+hide_offline_users
+------------------
+
+* Default:  ``false``
+
+If set to ``true``, then don't show offline users.
+
+i18n
+----
+
+Specify the locale/language. The language must be in the ``locales`` object. Refer to
+``./locale/locales.js`` to see which locales are supported.
+
+.. _`play-sounds`:
+
+play_sounds
+-----------
+
+* Default:  ``false``
+
+Plays a notification sound when you receive a personal message or when your
+nickname is mentioned in a chat room.
+
+Inside the ``./sounds`` directory of the Converse.js repo, you'll see MP3 and Ogg
+formatted sound files. We need both, because neither format is supported by all browsers.
+
+Sound files are looked up by convention, not configuration. So to have
+a sound play when a message is received, make sure that your webserver serves
+it in both formats as ``http://yoursite.com/sounds/msg_received.mp3`` and
+``http://yoursite.com/sounds/msg_received.ogg``.
+
+``http://yoursite.com`` should of course be your site's URL.
 
 .. _`prebind_url`:
 
@@ -366,7 +390,7 @@ prebind_url
 
 See also: :ref:`session-support`
 
-This setting should be used in conjunction with :ref:`prebind` and :ref:`keepalive`.
+This setting should be used in conjunction with ``authentication`` set to `prebind` and :ref:`keepalive` set to ``true``.
 
 It allows you to specify a URL which converse.js will call when it needs to get
 the RID and SID (Request ID and Session ID) tokens of a BOSH connection, which
@@ -384,7 +408,7 @@ three tokens::
 providers_link
 --------------
 
-Default:  ``https://xmpp.net/directory.php``
+* Default:  ``https://xmpp.net/directory.php``
 
 The hyperlink on the registration form which points to a directory of public
 XMPP servers.
@@ -393,7 +417,7 @@ XMPP servers.
 roster_groups
 -------------
 
-Default:  ``false``
+* Default:  ``false``
 
 If set to ``true``, converse.js will show any roster groups you might have
 configured.
@@ -406,7 +430,7 @@ configured.
 show_controlbox_by_default
 --------------------------
 
-Default:  ``false``
+* Default:  ``false``
 
 The "controlbox" refers to the special chatbox containing your contacts roster,
 status widget, chatrooms and other controls.
@@ -420,7 +444,7 @@ page load.
 show_only_online_users
 ----------------------
 
-Default:  ``false``
+* Default:  ``false``
 
 If set to ``true``, only online users will be shown in the contacts roster.
 Users with any other status (e.g. away, busy etc.) will not be shown.
@@ -428,7 +452,7 @@ Users with any other status (e.g. away, busy etc.) will not be shown.
 storage
 -------
 
-Default: ``session``
+* Default: ``session``
 
 Valid options: ``session``, ``local``.
 
@@ -457,7 +481,7 @@ Data in localStorage on the other hand is kept indefinitely.
 use_otr_by_default
 ------------------
 
-Default:  ``false``
+* Default:  ``false``
 
 If set to ``true``, Converse.js will automatically try to initiate an OTR (off-the-record)
 encrypted chat session every time you open a chat box.
@@ -465,7 +489,7 @@ encrypted chat session every time you open a chat box.
 use_vcards
 ----------
 
-Default:  ``true``
+* Default:  ``true``
 
 Determines whether the XMPP server will be queried for roster contacts' VCards
 or not. VCards contain extra personal information such as your fullname and
@@ -474,7 +498,7 @@ avatar image.
 visible_toolbar_buttons
 -----------------------
 
-Default:
+* Default:
 
 .. code-block:: javascript
 
@@ -508,7 +532,7 @@ Allows you to show or hide buttons on the chat boxes' toolbars.
 websocket_url
 -------------
 
-Default: ``undefined``
+* Default: ``undefined``
 
 This option is used to specify a 
 `websocket <https://developer.mozilla.org/en/docs/WebSockets>`_ URI to which
@@ -533,7 +557,7 @@ support.
 xhr_custom_status
 -----------------
 
-Default:  ``false``
+* Default:  ``false``
 
 .. note::
     XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
@@ -547,7 +571,7 @@ xhr_custom_status_url
 .. note::
     XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
 
-Default:  Empty string
+* Default:  Empty string
 
 Used only in conjunction with ``xhr_custom_status``.
 
@@ -559,7 +583,7 @@ The message itself is sent in the request under the key ``msg``.
 xhr_user_search
 ---------------
 
-Default:  ``false``
+* Default:  ``false``
 
 .. note::
     XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
@@ -582,7 +606,7 @@ xhr_user_search_url
 .. note::
     XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
 
-Default:  Empty string
+* Default:  Empty string
 
 Used only in conjunction with ``xhr_user_search``.
 

docs/source/quickstart.rst

@@ -28,12 +28,8 @@ bottom of your page (after the closing *</body>* element).
 
     require(['converse'], function (converse) {
         converse.initialize({
-            auto_list_rooms: false,
-            auto_subscribe: false,
             bosh_service_url: 'https://bind.conversejs.org', // Please use this connection manager only for testing purposes
-            hide_muc_server: false,
             i18n: locales.en, // Refer to ./locale/locales.js to see which locales are supported
-            prebind: false,
             show_controlbox_by_default: true,
             roster_groups: true
         });

sass/converse.scss

@@ -289,6 +289,7 @@
     text-align: center;
     display: block;
     margin: 0 auto;
+    clear: both;
   }
 
   .toggle-controlbox,
@@ -897,34 +898,39 @@
   }
 
   dd.available-chatroom {
-    display: inline-block;
+    border: none;
-    overflow-x: hidden;
+    clear: both;
-    text-overflow: ellipsis;
+    color: $text-color;
+    display: block;
+    font-weight: bold;
+    overflow: hidden;
     padding: 0.25em 0.5em;
+    text-overflow: ellipsis;
+    text-shadow: 0 1px 0 $text-shadow-color;
     white-space: nowrap;
     a.open-room {
       width: 150px;
     }
+    &:hover {
+      background-color: $highlight-color;
+      .room-info {
+        display: inline-block;
+        font-size: 14px;
+      }
+    }
   }
 
-  dd.available-chatroom:hover a.room-info {
-    display: inline-block;
-    font-size: 14px;
-  }
-
-  dd.available-chatroom,
   #converse-roster dd {
-    font-weight: bold;
     border: none;
-    display: block;
-    color: $text-color;
-    text-shadow: 0 1px 0 $text-shadow-color;
     clear: both;
+    color: $text-color;
+    display: block;
+    font-weight: bold;
     overflow-y: hidden;
+    text-shadow: 0 1px 0 $text-shadow-color;
   }
 
   .roster-group:hover,
-  dd.available-chatroom:hover,
   #converse-roster dd:hover {
     background-color: $highlight-color;
   }
@@ -1162,19 +1168,21 @@
     margin: 4px;
   }
 
-  #converse-register .login-submit,
+  #converse-register, #converse-login {
-  #converse-login .login-submit,
+    .login-submit, .submit {
-  #converse-register .submit,
+      height: 30px;
-  #converse-login .submit {
+      padding: 0px;
-    height: 30px;
+      font-size: $font-size;
-    padding: 0px;
+    }
-    font-size: $font-size;
+    .submit {
+      margin: 1em 0;
+    }
+    .login-anon {
+      height: auto;
+      white-space: normal;
+    }
   }
-
+  
-  #converse-login .submit {
-    margin: 1em 0;
-  }
-
   form.add-chatroom {
     background: none;
     padding: 0.5em;

spec/converse.js

@@ -20,37 +20,39 @@
 
             describe("with prebind", function () {
                 it("needs a jid when also using keepalive", function () {
+                    var authentication = converse.authentication;
                     var connection = converse.connection;
                     var jid = converse.jid;
                     converse.bosh_service_url = "localhost";
                     converse.connection = undefined;
                     converse.jid = undefined;
                     converse.keepalive = true;
-                    converse.prebind = true;
+                    converse.authentication = "prebind";
                     expect(converse.initConnection.bind(converse)).toThrow(
                         new Error("initConnection: when using 'keepalive' with 'prebind, you must supply the JID of the current user."));
+                    converse.authentication= authentication;
                     converse.bosh_service_url = undefined;
                     converse.connection = connection;
                     converse.jid = jid;
                     converse.keepalive = undefined;
-                    converse.prebind = undefined;
                 });
 
                 it("needs jid, rid and sid values when not using keepalive", function () {
+                    var authentication = converse.authentication;
                     var connection = converse.connection;
                     var jid = converse.jid;
                     converse.bosh_service_url = "localhost";
                     converse.connection = undefined;
                     converse.jid = undefined;
                     converse.keepalive = false;
-                    converse.prebind = true;
+                    converse.authentication = "prebind";
                     expect(converse.initConnection.bind(converse)).toThrow(
                         new Error("initConnection: If you use prebind and not keepalive, then you MUST supply JID, RID and SID values"));
+                    converse.authentication= authentication;
                     converse.bosh_service_url = undefined;
                     converse.connection = connection;
                     converse.jid = jid;
                     converse.keepalive = undefined;
-                    converse.prebind = undefined;
                 });
             });
         });

spec/otr.js

@@ -21,7 +21,7 @@
             var pp;
             // With no prebind, the user's XMPP password is used and nothing is
             // stored in session storage.
-            this.prebind = false;
+            this.authentication = "manual";
             this.connection.pass = 's3cr3t!';
             expect(this.otr.getSessionPassphrase()).toBe(this.connection.pass);
             expect(window.sessionStorage.length).toBe(0);
@@ -29,7 +29,7 @@
 
             // With prebind, a random passphrase is generated and stored in
             // session storage.
-            this.prebind = true;
+            this.authentication = "prebind";
             pp = this.otr.getSessionPassphrase();
             expect(pp).not.toBe(this.connection.pass);
             expect(window.sessionStorage.length).toBe(1);
@@ -37,7 +37,7 @@
             expect(pp).toBe(window.sessionStorage[b64_sha1(converse.connection.jid)]);
 
             // Clean up
-            this.prebind = false;
+            this.authentication = "manual";
         }, converse));
     }, converse, mock, test_utils));
 }));

src/templates/login_panel.html

@@ -1,8 +1,21 @@
 <form id="converse-login" method="post">
-    <label>{{label_username}}</label>
+    {[ if (auto_login) { ]}
-    <input type="email" name="jid" placeholder="user@server">
+        <span class="spinner login-submit"/>
-    <label>{{label_password}}</label>
+    {[ } ]}
-    <input type="password" name="password" placeholder="password">
+    {[ if (!auto_login) { ]}
-    <input class="submit" type="submit" value="{{label_login}}">
+        {[ if (authentication == LOGIN) { ]}
-    <span class="conn-feedback"></span>
+            <label>{{label_username}}</label>
+            <input type="email" name="jid" placeholder="user@server">
+            <label>{{label_password}}</label>
+            <input type="password" name="password" placeholder="password">
+            <input class="submit" type="submit" value="{{label_login}}">
+            <span class="conn-feedback"></span>
+        {[ } ]}
+        {[ if (authentication == ANONYMOUS) { ]}
+            <input type="submit" class="submit login-anon" value="{{label_anon_login}}"/>
+        {[ } ]}
+        {[ if (authentication == PREBIND) { ]}
+            <p>Disconnected.</p>
+        {[ } ]}
+    {[ } ]}
 </form>