utils.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. (function (root, factory) {
  2. define(['es6-promise', 'mock', 'wait-until-promise'], factory);
  3. }(this, function (Promise, mock, waitUntilPromise) {
  4. var _ = converse.env._;
  5. var $msg = converse.env.$msg;
  6. var $pres = converse.env.$pres;
  7. var $iq = converse.env.$iq;
  8. var Strophe = converse.env.Strophe;
  9. var sizzle = converse.env.sizzle;
  10. var u = converse.env.utils;
  11. var utils = {};
  12. if (typeof window.Promise === 'undefined') {
  13. waitUntilPromise.setPromiseImplementation(Promise);
  14. }
  15. utils.waitUntil = waitUntilPromise.default;
  16. utils.waitUntilDiscoConfirmed = async function (_converse, entity_jid, identities, features=[], items=[], type='info') {
  17. const iq = await utils.waitUntil(() => {
  18. return _.filter(
  19. _converse.connection.IQ_stanzas,
  20. (iq) => sizzle(`iq[to="${entity_jid}"] query[xmlns="http://jabber.org/protocol/disco#${type}"]`, iq).length
  21. ).pop();
  22. }, 300);
  23. const stanza = $iq({
  24. 'type': 'result',
  25. 'from': entity_jid,
  26. 'to': 'romeo@montague.lit/orchard',
  27. 'id': iq.getAttribute('id'),
  28. }).c('query', {'xmlns': 'http://jabber.org/protocol/disco#'+type});
  29. _.forEach(identities, function (identity) {
  30. stanza.c('identity', {'category': identity.category, 'type': identity.type}).up()
  31. });
  32. _.forEach(features, function (feature) {
  33. stanza.c('feature', {'var': feature}).up();
  34. });
  35. _.forEach(items, function (item) {
  36. stanza.c('item', {'jid': item}).up();
  37. });
  38. _converse.connection._dataRecv(utils.createRequest(stanza));
  39. }
  40. utils.createRequest = function (iq) {
  41. iq = typeof iq.tree == "function" ? iq.tree() : iq;
  42. var req = new Strophe.Request(iq, function() {});
  43. req.getResponse = function () {
  44. var env = new Strophe.Builder('env', {type: 'mock'}).tree();
  45. env.appendChild(iq);
  46. return env;
  47. };
  48. return req;
  49. };
  50. utils.closeAllChatBoxes = function (converse) {
  51. var i, chatbox;
  52. for (i=converse.chatboxes.models.length-1; i>-1; i--) {
  53. chatbox = converse.chatboxes.models[i];
  54. converse.chatboxviews.get(chatbox.get('id')).close();
  55. }
  56. return this;
  57. };
  58. utils.openControlBox = function () {
  59. const toggle = document.querySelector(".toggle-controlbox");
  60. if (!u.isVisible(document.querySelector("#controlbox"))) {
  61. if (!u.isVisible(toggle)) {
  62. u.removeClass('hidden', toggle);
  63. }
  64. toggle.click();
  65. }
  66. return this;
  67. };
  68. utils.closeControlBox = function () {
  69. var controlbox = document.querySelector("#controlbox");
  70. if (u.isVisible(controlbox)) {
  71. var button = controlbox.querySelector(".close-chatbox-button");
  72. if (!_.isNull(button)) {
  73. button.click();
  74. }
  75. }
  76. return this;
  77. };
  78. utils.openChatBoxes = function (converse, amount) {
  79. var i = 0, jid, views = [];
  80. for (i; i<amount; i++) {
  81. jid = mock.cur_names[i].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  82. views[i] = converse.roster.get(jid).trigger("open");
  83. }
  84. return views;
  85. };
  86. utils.openChatBoxFor = function (_converse, jid) {
  87. _converse.roster.get(jid).trigger("open");
  88. return utils.waitUntil(() => _converse.chatboxviews.get(jid), 1000);
  89. };
  90. utils.openChatRoomViaModal = async function (_converse, jid, nick='') {
  91. // Opens a new chatroom
  92. utils.openControlBox(_converse);
  93. const roomspanel = _converse.chatboxviews.get('controlbox').roomspanel;
  94. roomspanel.el.querySelector('.show-add-muc-modal').click();
  95. utils.closeControlBox(_converse);
  96. const modal = roomspanel.add_room_modal;
  97. await utils.waitUntil(() => u.isVisible(modal.el), 1500)
  98. modal.el.querySelector('input[name="chatroom"]').value = jid;
  99. if (nick) {
  100. modal.el.querySelector('input[name="nickname"]').value = nick;
  101. }
  102. modal.el.querySelector('form input[type="submit"]').click();
  103. await utils.waitUntil(() => _converse.chatboxviews.get(jid), 1000);
  104. return _converse.chatboxviews.get(jid);
  105. };
  106. utils.openChatRoom = async function (_converse, room, server) {
  107. const model = await _converse.api.rooms.open(`${room}@${server}`);
  108. await model.messages.fetched;
  109. return model;
  110. };
  111. utils.getRoomFeatures = async function (_converse, room, server, features=[]) {
  112. const room_jid = `${room}@${server}`.toLowerCase();
  113. const stanzas = _converse.connection.IQ_stanzas;
  114. const index = stanzas.length-1;
  115. const stanza = await utils.waitUntil(() => _.filter(
  116. stanzas.slice(index),
  117. iq => iq.querySelector(
  118. `iq[to="${room_jid}"] query[xmlns="http://jabber.org/protocol/disco#info"]`
  119. )).pop());
  120. const features_stanza = $iq({
  121. 'from': room_jid,
  122. 'id': stanza.getAttribute('id'),
  123. 'to': 'romeo@montague.lit/desktop',
  124. 'type': 'result'
  125. }).c('query', { 'xmlns': 'http://jabber.org/protocol/disco#info'})
  126. .c('identity', {
  127. 'category': 'conference',
  128. 'name': room[0].toUpperCase() + room.slice(1),
  129. 'type': 'text'
  130. }).up();
  131. features = features.length ? features : [
  132. 'http://jabber.org/protocol/muc',
  133. 'jabber:iq:register',
  134. Strophe.NS.SID,
  135. Strophe.NS.MAM,
  136. 'muc_passwordprotected',
  137. 'muc_hidden',
  138. 'muc_temporary',
  139. 'muc_open',
  140. 'muc_unmoderated',
  141. 'muc_anonymous']
  142. features.forEach(f => features_stanza.c('feature', {'var': f}).up());
  143. features_stanza.c('x', { 'xmlns':'jabber:x:data', 'type':'result'})
  144. .c('field', {'var':'FORM_TYPE', 'type':'hidden'})
  145. .c('value').t('http://jabber.org/protocol/muc#roominfo').up().up()
  146. .c('field', {'type':'text-single', 'var':'muc#roominfo_description', 'label':'Description'})
  147. .c('value').t('This is the description').up().up()
  148. .c('field', {'type':'text-single', 'var':'muc#roominfo_occupants', 'label':'Number of occupants'})
  149. .c('value').t(0);
  150. _converse.connection._dataRecv(utils.createRequest(features_stanza));
  151. };
  152. utils.openAndEnterChatRoom = async function (_converse, room, server, nick, features=[]) {
  153. const room_jid = `${room}@${server}`.toLowerCase();
  154. const stanzas = _converse.connection.IQ_stanzas;
  155. await _converse.api.rooms.open(room_jid);
  156. await utils.getRoomFeatures(_converse, room, server, features);
  157. const iq = await utils.waitUntil(() => _.filter(
  158. stanzas,
  159. s => sizzle(`iq[to="${room_jid}"] query[node="x-roomuser-item"]`, s).length
  160. ).pop());
  161. // We remove the stanza, otherwise we might get stale stanzas returned in our filter above.
  162. stanzas.splice(stanzas.indexOf(iq), 1)
  163. // The XMPP server returns the reserved nick for this user.
  164. const view = _converse.chatboxviews.get(room_jid);
  165. const IQ_id = iq.getAttribute('id');
  166. const stanza = $iq({
  167. 'type': 'result',
  168. 'id': IQ_id,
  169. 'from': view.model.get('jid'),
  170. 'to': _converse.connection.jid
  171. }).c('query', {'xmlns': 'http://jabber.org/protocol/disco#info', 'node': 'x-roomuser-item'})
  172. .c('identity', {'category': 'conference', 'name': nick, 'type': 'text'});
  173. _converse.connection._dataRecv(utils.createRequest(stanza));
  174. await utils.waitUntil(() => view.model.get('nick'));
  175. // The user has just entered the room (because join was called)
  176. // and receives their own presence from the server.
  177. // See example 24: https://xmpp.org/extensions/xep-0045.html#enter-pres
  178. const presence = $pres({
  179. to: _converse.connection.jid,
  180. from: `${room_jid}/${nick}`,
  181. id: u.getUniqueId()
  182. }).c('x').attrs({xmlns:'http://jabber.org/protocol/muc#user'})
  183. .c('item').attrs({
  184. affiliation: 'owner',
  185. jid: _converse.bare_jid,
  186. role: 'moderator'
  187. }).up()
  188. .c('status').attrs({code:'110'});
  189. _converse.connection._dataRecv(utils.createRequest(presence));
  190. await utils.waitUntil(() => (view.model.get('connection_status') === converse.ROOMSTATUS.ENTERED));
  191. // Now we return the (empty) member lists
  192. const member_IQ = await utils.waitUntil(() => _.filter(
  193. stanzas,
  194. s => sizzle(`iq[to="${room_jid}"] query[xmlns="${Strophe.NS.MUC_ADMIN}"] item[affiliation="member"]`, s).length
  195. ).pop());
  196. const member_list_stanza = $iq({
  197. 'from': 'coven@chat.shakespeare.lit',
  198. 'id': member_IQ.getAttribute('id'),
  199. 'to': 'romeo@montague.lit/orchard',
  200. 'type': 'result'
  201. }).c('query', {'xmlns': Strophe.NS.MUC_ADMIN});
  202. _converse.connection._dataRecv(utils.createRequest(member_list_stanza));
  203. const admin_IQ = await utils.waitUntil(() => _.filter(
  204. stanzas,
  205. s => sizzle(`iq[to="${room_jid}"] query[xmlns="${Strophe.NS.MUC_ADMIN}"] item[affiliation="admin"]`, s).length
  206. ).pop());
  207. const admin_list_stanza = $iq({
  208. 'from': 'coven@chat.shakespeare.lit',
  209. 'id': admin_IQ.getAttribute('id'),
  210. 'to': 'romeo@montague.lit/orchard',
  211. 'type': 'result'
  212. }).c('query', {'xmlns': Strophe.NS.MUC_ADMIN});
  213. _converse.connection._dataRecv(utils.createRequest(admin_list_stanza));
  214. const owner_IQ = await utils.waitUntil(() => _.filter(
  215. stanzas,
  216. s => sizzle(`iq[to="${room_jid}"] query[xmlns="${Strophe.NS.MUC_ADMIN}"] item[affiliation="owner"]`, s).length
  217. ).pop());
  218. const owner_list_stanza = $iq({
  219. 'from': 'coven@chat.shakespeare.lit',
  220. 'id': owner_IQ.getAttribute('id'),
  221. 'to': 'romeo@montague.lit/orchard',
  222. 'type': 'result'
  223. }).c('query', {'xmlns': Strophe.NS.MUC_ADMIN});
  224. _converse.connection._dataRecv(utils.createRequest(owner_list_stanza));
  225. };
  226. utils.clearBrowserStorage = function () {
  227. window.localStorage.clear();
  228. window.sessionStorage.clear();
  229. return this;
  230. };
  231. utils.clearChatBoxMessages = function (converse, jid) {
  232. var view = converse.chatboxviews.get(jid);
  233. view.el.querySelector('.chat-content').innerHTML = '';
  234. view.model.messages.reset();
  235. view.model.messages.browserStorage._clear();
  236. };
  237. utils.createContacts = function (converse, type, length) {
  238. /* Create current (as opposed to requesting or pending) contacts
  239. * for the user's roster.
  240. *
  241. * These contacts are not grouped. See below.
  242. */
  243. var names, jid, subscription, requesting, ask;
  244. if (type === 'requesting') {
  245. names = mock.req_names;
  246. subscription = 'none';
  247. requesting = true;
  248. ask = null;
  249. } else if (type === 'pending') {
  250. names = mock.pend_names;
  251. subscription = 'none';
  252. requesting = false;
  253. ask = 'subscribe';
  254. } else if (type === 'current') {
  255. names = mock.cur_names;
  256. subscription = 'both';
  257. requesting = false;
  258. ask = null;
  259. } else if (type === 'all') {
  260. this.createContacts(converse, 'current')
  261. .createContacts(converse, 'requesting')
  262. .createContacts(converse, 'pending');
  263. return this;
  264. } else {
  265. throw Error("Need to specify the type of contact to create");
  266. }
  267. if (typeof length === 'undefined') {
  268. length = names.length;
  269. }
  270. for (var i=0; i<length; i++) {
  271. jid = names[i].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  272. if (!converse.roster.get(jid)) {
  273. converse.roster.create({
  274. 'ask': ask,
  275. 'name': names[i],
  276. 'jid': jid,
  277. 'requesting': requesting,
  278. 'subscription': subscription
  279. });
  280. }
  281. }
  282. return this;
  283. };
  284. utils.waitForRoster = async function (_converse, type='current', length, include_nick=true) {
  285. const iq = await utils.waitUntil(() =>
  286. _.filter(
  287. _converse.connection.IQ_stanzas,
  288. iq => sizzle(`iq[type="get"] query[xmlns="${Strophe.NS.ROSTER}"]`, iq).length
  289. ).pop());
  290. const result = $iq({
  291. 'to': _converse.connection.jid,
  292. 'type': 'result',
  293. 'id': iq.getAttribute('id')
  294. }).c('query', {
  295. 'xmlns': 'jabber:iq:roster'
  296. });
  297. if (type === 'pending' || type === 'all') {
  298. mock.pend_names.slice(0, length).map(name =>
  299. result.c('item', {
  300. jid: name.replace(/ /g,'.').toLowerCase() + '@montague.lit',
  301. name: include_nick ? name : undefined,
  302. subscription: 'to'
  303. }).up()
  304. );
  305. } else if (type === 'current' || type === 'all') {
  306. mock.cur_names.slice(0, length).map(name =>
  307. result.c('item', {
  308. jid: name.replace(/ /g,'.').toLowerCase() + '@montague.lit',
  309. name: include_nick ? name : undefined,
  310. subscription: 'both'
  311. }).up()
  312. );
  313. }
  314. _converse.connection._dataRecv(utils.createRequest(result));
  315. await _converse.api.waitUntil('rosterContactsFetched');
  316. };
  317. utils.createGroupedContacts = function (converse) {
  318. /* Create grouped contacts
  319. */
  320. let i=0, j=0;
  321. _.each(_.keys(mock.groups), function (name) {
  322. j = i;
  323. for (i=j; i<j+mock.groups[name]; i++) {
  324. converse.roster.create({
  325. 'jid': mock.cur_names[i].replace(/ /g,'.').toLowerCase() + '@montague.lit',
  326. 'subscription': 'both',
  327. 'ask': null,
  328. 'groups': name === 'ungrouped'? [] : [name],
  329. 'name': mock.cur_names[i]
  330. });
  331. }
  332. });
  333. };
  334. utils.createChatMessage = function (_converse, sender_jid, message) {
  335. return $msg({
  336. from: sender_jid,
  337. to: _converse.connection.jid,
  338. type: 'chat',
  339. id: (new Date()).getTime()
  340. })
  341. .c('body').t(message).up()
  342. .c('active', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  343. }
  344. utils.sendMessage = function (view, message) {
  345. const promise = new Promise((resolve, reject) => view.on('messageInserted', resolve));
  346. view.el.querySelector('.chat-textarea').value = message;
  347. view.onKeyDown({
  348. target: view.el.querySelector('textarea.chat-textarea'),
  349. preventDefault: _.noop,
  350. keyCode: 13
  351. });
  352. return promise;
  353. };
  354. return utils;
  355. }));