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

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