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 8.0KB

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