From f7725943f89a4d5cf7f671ab67968138b0bdeed1 Mon Sep 17 00:00:00 2001
From: JC Brand <jc@opkode.com>
Date: Tue, 1 Mar 2016 21:57:27 +0000
Subject: [PATCH] Emit an event 'contactRequest' when a subscription request is
 received

---
 docs/source/development.rst |  2 ++
 spec/protocol.js            |  2 ++
 src/converse-core.js        | 49 +++++++++++++++++++++----------------
 3 files changed, 32 insertions(+), 21 deletions(-)

diff --git a/docs/source/development.rst b/docs/source/development.rst
index 341e6778a..f30e1c8a0 100644
--- a/docs/source/development.rst
+++ b/docs/source/development.rst
@@ -751,6 +751,8 @@ Here are the different events that are emitted:
 +---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
 | **chatBoxToggled**              | When a chat box has been minimized or maximized.                                                  | ``converse.listen.on('chatBoxToggled', function (event, chatbox) { ... });``                         |
 +---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
+| **contactRequest**              | Someone has requested to subscribe to your presence (i.e. to be your contact).                    | ``converse.listen.on('contactRequest', function (event, user_data) { ... });``             |
++---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
 | **contactStatusChanged**        | When a chat buddy's chat status has changed.                                                      | ``converse.listen.on('contactStatusChanged', function (event, buddy, status) { ... });``             |
 +---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
 | **contactStatusMessageChanged** | When a chat buddy's custom status message has changed.                                            | ``converse.listen.on('contactStatusMessageChanged', function (event, buddy, messageText) { ... });`` |
diff --git a/spec/protocol.js b/spec/protocol.js
index 726dee74a..b734645b7 100644
--- a/spec/protocol.js
+++ b/spec/protocol.js
@@ -501,6 +501,7 @@
                 });
                 waits(50);
                 runs(function () {
+                    spyOn(converse, "emit");
                     /*
                     * <presence
                     *     from='user@example.com'
@@ -513,6 +514,7 @@
                         'type': 'subscribe'
                     });
                     this.connection._dataRecv(test_utils.createRequest(stanza));
+                    expect(converse.emit).toHaveBeenCalledWith('contactRequest', jasmine.any(Object));
                     var $header = $('a:contains("Contact requests")');
                     expect($header.length).toBe(1);
                     expect($header.is(":visible")).toBeTruthy();
diff --git a/src/converse-core.js b/src/converse-core.js
index 88072a062..32dfd1c75 100755
--- a/src/converse-core.js
+++ b/src/converse-core.js
@@ -1024,13 +1024,14 @@
 
             sendContactAddIQ: function (jid, name, groups, callback, errback) {
                 /*  Send an IQ stanza to the XMPP server to add a new roster contact.
-                *  Parameters:
-                *    (String) jid - The Jabber ID of the user being added
-                *    (String) name - The name of that user
-                *    (Array of Strings) groups - Any roster groups the user might belong to
-                *    (Function) callback - A function to call once the VCard is returned
-                *    (Function) errback - A function to call if an error occured
-                */
+                 *
+                 *  Parameters:
+                 *    (String) jid - The Jabber ID of the user being added
+                 *    (String) name - The name of that user
+                 *    (Array of Strings) groups - Any roster groups the user might belong to
+                 *    (Function) callback - A function to call once the VCard is returned
+                 *    (Function) errback - A function to call if an error occured
+                 */
                 name = _.isEmpty(name)? jid: name;
                 var iq = $iq({type: 'set'})
                     .c('query', {xmlns: Strophe.NS.ROSTER})
@@ -1041,15 +1042,16 @@
 
             addContact: function (jid, name, groups, attributes) {
                 /* Adds a RosterContact instance to converse.roster and
-                * registers the contact on the XMPP server.
-                * Returns a promise which is resolved once the XMPP server has
-                * responded.
-                *  Parameters:
-                *    (String) jid - The Jabber ID of the user being added and subscribed to.
-                *    (String) name - The name of that user
-                *    (Array of Strings) groups - Any roster groups the user might belong to
-                *    (Object) attributes - Any additional attributes to be stored on the user's model.
-                */
+                 * registers the contact on the XMPP server.
+                 * Returns a promise which is resolved once the XMPP server has
+                 * responded.
+                 *
+                 *  Parameters:
+                 *    (String) jid - The Jabber ID of the user being added and subscribed to.
+                 *    (String) name - The name of that user
+                 *    (Array of Strings) groups - Any roster groups the user might belong to
+                 *    (Object) attributes - Any additional attributes to be stored on the user's model.
+                 */
                 var deferred = new $.Deferred();
                 groups = groups || [];
                 name = _.isEmpty(name)? jid: name;
@@ -1212,9 +1214,12 @@
                 }
             },
 
-            createContactFromVCard: function (iq, jid, fullname, img, img_type, url) {
+            createRequestingContactFromVCard: function (iq, jid, fullname, img, img_type, url) {
+                /* A contact request was recieved, and we then asked for the
+                 * VCard of that user.
+                 */
                 var bare_jid = Strophe.getBareJidFromJid(jid);
-                this.create({
+                var user_data = {
                     jid: bare_jid,
                     subscription: 'none',
                     ask: null,
@@ -1224,7 +1229,9 @@
                     image_type: img_type,
                     url: url,
                     vcard_updated: moment().format()
-                });
+                };
+                this.create(user_data);
+                converse.emit('contactRequest', user_data);
             },
 
             handleIncomingSubscription: function (jid) {
@@ -1248,10 +1255,10 @@
                         }
                     } else if (!contact) {
                         converse.getVCard(
-                            bare_jid, this.createContactFromVCard.bind(this),
+                            bare_jid, this.createRequestingContactFromVCard.bind(this),
                             function (iq, jid) {
                                 converse.log("Error while retrieving vcard for "+jid);
-                                this.createContactFromVCard.call(this, iq, jid);
+                                this.createRequestingContactFromVCard.call(this, iq, jid);
                             }.bind(this)
                         );
                     }