You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

mod_speakerstats_component.lua 7.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. local get_room_from_jid = module:require "util".get_room_from_jid;
  2. local room_jid_match_rewrite = module:require "util".room_jid_match_rewrite;
  3. local jid_resource = require "util.jid".resource;
  4. local ext_events = module:require "ext_events"
  5. local st = require "util.stanza";
  6. local socket = require "socket";
  7. local json = require "util.json";
  8. -- we use async to detect Prosody 0.10 and earlier
  9. local have_async = pcall(require, "util.async");
  10. if not have_async then
  11. module:log("warn", "speaker stats will not work with Prosody version 0.10 or less.");
  12. return;
  13. end
  14. local muc_component_host = module:get_option_string("muc_component");
  15. if muc_component_host == nil then
  16. log("error", "No muc_component specified. No muc to operate on!");
  17. return;
  18. end
  19. log("info", "Starting speakerstats for %s", muc_component_host);
  20. -- receives messages from client currently connected to the room
  21. -- clients indicates their own dominant speaker events
  22. function on_message(event)
  23. -- Check the type of the incoming stanza to avoid loops:
  24. if event.stanza.attr.type == "error" then
  25. return; -- We do not want to reply to these, so leave.
  26. end
  27. local speakerStats
  28. = event.stanza:get_child('speakerstats', 'http://jitsi.org/jitmeet');
  29. if speakerStats then
  30. local roomAddress = speakerStats.attr.room;
  31. local room = get_room_from_jid(room_jid_match_rewrite(roomAddress));
  32. if not room then
  33. log("warn", "No room found %s", roomAddress);
  34. return false;
  35. end
  36. local roomSpeakerStats = room.speakerStats;
  37. local from = event.stanza.attr.from;
  38. local occupant = room:get_occupant_by_real_jid(from);
  39. if not occupant then
  40. log("warn", "No occupant %s found for %s", from, roomAddress);
  41. return false;
  42. end
  43. local newDominantSpeaker = roomSpeakerStats[occupant.jid];
  44. local oldDominantSpeakerId = roomSpeakerStats['dominantSpeakerId'];
  45. if oldDominantSpeakerId then
  46. local oldDominantSpeaker = roomSpeakerStats[oldDominantSpeakerId];
  47. if oldDominantSpeaker then
  48. oldDominantSpeaker:setDominantSpeaker(false);
  49. end
  50. end
  51. if newDominantSpeaker then
  52. newDominantSpeaker:setDominantSpeaker(true);
  53. end
  54. room.speakerStats['dominantSpeakerId'] = occupant.jid;
  55. end
  56. return true
  57. end
  58. --- Start SpeakerStats implementation
  59. local SpeakerStats = {};
  60. SpeakerStats.__index = SpeakerStats;
  61. function new_SpeakerStats(nick, context_user)
  62. return setmetatable({
  63. totalDominantSpeakerTime = 0;
  64. _dominantSpeakerStart = 0;
  65. nick = nick;
  66. context_user = context_user;
  67. displayName = nil;
  68. }, SpeakerStats);
  69. end
  70. -- Changes the dominantSpeaker data for current occupant
  71. -- saves start time if it is new dominat speaker
  72. -- or calculates and accumulates time of speaking
  73. function SpeakerStats:setDominantSpeaker(isNowDominantSpeaker)
  74. log("debug",
  75. "set isDominant %s for %s", tostring(isNowDominantSpeaker), self.nick);
  76. if not self:isDominantSpeaker() and isNowDominantSpeaker then
  77. self._dominantSpeakerStart = socket.gettime()*1000;
  78. elseif self:isDominantSpeaker() and not isNowDominantSpeaker then
  79. local now = socket.gettime()*1000;
  80. local timeElapsed = math.floor(now - self._dominantSpeakerStart);
  81. self.totalDominantSpeakerTime
  82. = self.totalDominantSpeakerTime + timeElapsed;
  83. self._dominantSpeakerStart = 0;
  84. end
  85. end
  86. -- Returns true if the tracked user is currently a dominant speaker.
  87. function SpeakerStats:isDominantSpeaker()
  88. return self._dominantSpeakerStart > 0;
  89. end
  90. --- End SpeakerStats
  91. -- create speakerStats for the room
  92. function room_created(event)
  93. local room = event.room;
  94. room.speakerStats = {};
  95. end
  96. -- Create SpeakerStats object for the joined user
  97. function occupant_joined(event)
  98. local room = event.room;
  99. local occupant = event.occupant;
  100. local nick = jid_resource(occupant.nick);
  101. if room.speakerStats then
  102. -- lets send the current speaker stats to that user, so he can update
  103. -- its local stats
  104. if next(room.speakerStats) ~= nil then
  105. local users_json = {};
  106. for jid, values in pairs(room.speakerStats) do
  107. -- skip reporting those without a nick('dominantSpeakerId')
  108. -- and skip focus if sneaked into the table
  109. if values.nick ~= nil and values.nick ~= 'focus' then
  110. local resultSpeakerStats = {};
  111. local totalDominantSpeakerTime
  112. = values.totalDominantSpeakerTime;
  113. -- before sending we need to calculate current dominant speaker
  114. -- state
  115. if values:isDominantSpeaker() then
  116. local timeElapsed = math.floor(
  117. socket.gettime()*1000 - values._dominantSpeakerStart);
  118. totalDominantSpeakerTime = totalDominantSpeakerTime
  119. + timeElapsed;
  120. end
  121. resultSpeakerStats.displayName = values.displayName;
  122. resultSpeakerStats.totalDominantSpeakerTime
  123. = totalDominantSpeakerTime;
  124. users_json[values.nick] = resultSpeakerStats;
  125. end
  126. end
  127. local body_json = {};
  128. body_json.type = 'speakerstats';
  129. body_json.users = users_json;
  130. local stanza = st.message({
  131. from = module.host;
  132. to = occupant.jid; })
  133. :tag("json-message", {xmlns='http://jitsi.org/jitmeet'})
  134. :text(json.encode(body_json)):up();
  135. room:route_stanza(stanza);
  136. end
  137. local context_user = event.origin and event.origin.jitsi_meet_context_user or nil;
  138. room.speakerStats[occupant.jid] = new_SpeakerStats(nick, context_user);
  139. end
  140. end
  141. -- Occupant left set its dominant speaker to false and update the store the
  142. -- display name
  143. function occupant_leaving(event)
  144. local room = event.room;
  145. local occupant = event.occupant;
  146. local speakerStatsForOccupant = room.speakerStats[occupant.jid];
  147. if speakerStatsForOccupant then
  148. speakerStatsForOccupant:setDominantSpeaker(false);
  149. -- set display name
  150. local displayName = occupant:get_presence():get_child_text(
  151. 'nick', 'http://jabber.org/protocol/nick');
  152. speakerStatsForOccupant.displayName = displayName;
  153. end
  154. end
  155. -- Conference ended, send speaker stats
  156. function room_destroyed(event)
  157. local room = event.room;
  158. ext_events.speaker_stats(room, room.speakerStats);
  159. end
  160. module:hook("message/host", on_message);
  161. -- executed on every host added internally in prosody, including components
  162. function process_host(host)
  163. if host == muc_component_host then -- the conference muc component
  164. module:log("info","Hook to muc events on %s", host);
  165. local muc_module = module:context(host);
  166. muc_module:hook("muc-room-created", room_created, -1);
  167. muc_module:hook("muc-occupant-joined", occupant_joined, -1);
  168. muc_module:hook("muc-occupant-pre-leave", occupant_leaving, -1);
  169. muc_module:hook("muc-room-destroyed", room_destroyed, -1);
  170. end
  171. end
  172. if prosody.hosts[muc_component_host] == nil then
  173. module:log("info","No muc component found, will listen for it: %s", muc_component_host)
  174. -- when a host or component is added
  175. prosody.events.add_handler("host-activated", process_host);
  176. else
  177. process_host(muc_component_host);
  178. end