bigbluebutton_rails 1.4.0 → 2.0.0

data/app/models/bigbluebutton_room_options.rb

@@ -6,10 +6,6 @@ class BigbluebuttonRoomOptions < ActiveRecord::Base
   belongs_to :room, :class_name => 'BigbluebuttonRoom'
   validates :room_id, :presence => true
 
-  def get_available_layouts
-    ["Default", "Video Chat", "Meeting", "Webinar", "Lecture assistant", "Lecture"]
-  end
-
   # Sets the attributes from the model into the config.xml passed in the arguments.
   # If anything was modified in the XML, returns the new XML generated as string.
   # Otherwise returns false.
@@ -17,7 +13,7 @@ class BigbluebuttonRoomOptions < ActiveRecord::Base
   # xml (string):: The config.xml in which the attributes will be set
   def set_on_config_xml(xml)
     config_xml = BigBlueButton::BigBlueButtonConfigXml.new(xml)
-    unless self.default_layout.blank?
+    if self.default_layout.present?
       config_xml.set_attribute("layout", "defaultLayout", self.default_layout, false)
     end
     unless self.presenter_share_only.nil?
@@ -30,6 +26,9 @@ class BigbluebuttonRoomOptions < ActiveRecord::Base
     unless self.auto_start_audio.nil?
       config_xml.set_attribute("PhoneModule", "autoJoin", self.auto_start_audio, true)
     end
+    if self.background.present?
+      config_xml.set_attribute("branding", "background", self.background, false)
+    end
     if config_xml.is_modified?
       config_xml.as_string
     else
@@ -39,8 +38,12 @@ class BigbluebuttonRoomOptions < ActiveRecord::Base
 
   # Returns true if any of the attributes was set. Is used to check whether the options
   # have to be sent to the server (setConfigXML) or not.
+  # Note: have to use ".nil?" for booleans, otherwise setting it to 'false' would be
+  # taken as not setting it.
   def is_modified?
-    !self.default_layout.nil? || !self.presenter_share_only.nil? || !self.auto_start_audio.nil? ||
-    !self.auto_start_video.nil?
+    booleans = [ :presenter_share_only, :auto_start_audio, :auto_start_video ]
+    others = [ :default_layout, :background ]
+    booleans.any? { |method| !self.send(method).nil? } ||
+      others.any? { |method| self.send(method).present? }
   end
 end

data/app/models/bigbluebutton_server.rb

@@ -13,6 +13,16 @@ class BigbluebuttonServer < ActiveRecord::Base
            :foreign_key => 'server_id',
            :dependent => :nullify
 
+  has_one :config,
+          class_name: 'BigbluebuttonServerConfig',
+          foreign_key: 'server_id',
+          dependent: :destroy
+
+  delegate :update_config, to: :config
+  delegate :available_layouts, to: :config
+  delegate :available_layouts_names, to: :config
+  delegate :available_layouts_for_select, to: :config
+
   validates :name,
             :presence => true,
             :uniqueness => true,
@@ -22,14 +32,14 @@ class BigbluebuttonServer < ActiveRecord::Base
             :presence => true,
             :uniqueness => true,
             :length => { :maximum => 500 },
-            :format => { :with => /http:\/\/.*\/bigbluebutton\/api/,
+            :format => { :with => /http[s]?:\/\/.*\/bigbluebutton\/api/,
                          :message => I18n.t('bigbluebutton_rails.servers.errors.url_format') }
 
   validates :param,
             :presence => true,
             :uniqueness => true,
             :length => { :minimum => 3 },
-            :format => { :with => /^[a-zA-Z\d_]+[a-zA-Z\d_-]*[a-zA-Z\d_]+$/,
+            :format => { :with => /\A[a-zA-Z\d_]+[a-zA-Z\d_-]*[a-zA-Z\d_]+\z/,
                          :message => I18n.t('bigbluebutton_rails.servers.errors.param_format') }
 
   validates :salt,
@@ -37,8 +47,8 @@ class BigbluebuttonServer < ActiveRecord::Base
             :length => { :minimum => 1, :maximum => 500 }
 
   validates :version,
-            :presence => true,
-            :inclusion => { :in => ['0.7', '0.8'] }
+            :inclusion => { :in => ['0.8', '0.81', '0.9', '1.0'] },
+            :allow_blank => true
 
   # Array of <tt>BigbluebuttonMeeting</tt>
   attr_reader :meetings
@@ -46,14 +56,26 @@ class BigbluebuttonServer < ActiveRecord::Base
   after_initialize :init
   before_validation :set_param
 
+  after_create :create_config
+  after_create :update_config
+
+  before_save :check_for_version_update
+  after_update :check_for_config_update
+
+  # In case there's no config created yet, build one.
+  def config_with_initialize
+    config_without_initialize || build_config
+  end
+  alias_method_chain :config, :initialize
+
   # Returns the API object (<tt>BigBlueButton::BigBlueButtonAPI</tt> defined in
   # <tt>bigbluebutton-api-ruby</tt>) associated with this server.
   def api
-    if @api.nil?
-      @api = BigBlueButton::BigBlueButtonApi.new(self.url, self.salt,
-                                                 self.version.to_s, false)
-    end
-    @api
+    return @api if @api.present?
+
+    version = self.version
+    version = set_api_version_from_server if version.blank?
+    @api = BigBlueButton::BigBlueButtonApi.new(self.url, self.salt, version.to_s, false)
   end
 
   # Fetches the meetings currently created in the server (running or not).
@@ -72,11 +94,11 @@ class BigbluebuttonServer < ActiveRecord::Base
       # TODO: there might be more attributes returned by the API, review them all
       if room.nil?
         room = BigbluebuttonRoom.new(:server => self, :meetingid => attr[:meetingID],
-                                     :name => attr[:meetingID], :attendee_password => attr[:attendeePW],
-                                     :moderator_password => attr[:moderatorPW], :external => true, :private => true)
+                                     :name => attr[:meetingID], :attendee_api_password => attr[:attendeePW],
+                                     :moderator_api_password => attr[:moderatorPW], :external => true, :private => true)
       else
-        room.update_attributes(:attendee_password => attr[:attendeePW],
-                               :moderator_password => attr[:moderatorPW])
+        room.update_attributes(:attendee_api_password => attr[:attendeePW],
+                               :moderator_api_password => attr[:moderatorPW])
       end
       room.running = attr[:running]
       room.update_current_meeting
@@ -131,6 +153,20 @@ class BigbluebuttonServer < ActiveRecord::Base
     self.param
   end
 
+  def set_api_version_from_server
+    begin
+      # creating the object with version=nil makes the gem fetch the version from the server
+      api = BigBlueButton::BigBlueButtonApi.new(self.url, self.salt, nil, false)
+      self.version = api.version
+    rescue BigBlueButton::BigBlueButtonException
+      # we just ignore errors in case the server is not responding
+      # in these cases, the version will be fetched later on
+      Rails.logger.error "Could not fetch the API version from the server #{self.id}. The URL probably incorrect."
+      self.version = nil
+    end
+    self.version
+  end
+
   protected
 
   def init
@@ -145,4 +181,24 @@ class BigbluebuttonServer < ActiveRecord::Base
     end
   end
 
+  def create_config
+    BigbluebuttonServerConfig.create(server: self)
+  end
+
+  # Checks if we have to update the server version or not and do it if needed.
+  # If the user only changes the version, we assume he's trying to force an API version.
+  # If the user changes url/salt and the version, we also assume that he wants
+  # to force the API version
+  def check_for_version_update
+    if [:url, :salt, :version].any? { |k| self.changes.key?(k) }
+      self.set_api_version_from_server
+    end
+  end
+
+  def check_for_config_update
+    if [:url, :salt, :version].any?{ |k| self.changes.key?(k) }
+      self.update_config
+    end
+  end
+
 end

data/app/models/bigbluebutton_server_config.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+require 'bigbluebutton_api'
+
+class BigbluebuttonServerConfig < ActiveRecord::Base
+  include ActiveModel::ForbiddenAttributesProtection
+
+  belongs_to :server, class_name: 'BigbluebuttonServer'
+  validates :server_id, presence: true
+
+  serialize :available_layouts, Array
+
+  # This is called when the config.xml is requested to update the info that is
+  # being stored locally. Currently the only info stored is about the available
+  # layouts. It is also called without the config_xml parameter when we are
+  # forcing the update (via Resque task for example).
+  def update_config(config_xml = nil)
+    begin
+      config_xml = self.server.api.get_default_config_xml if config_xml.nil?
+      layouts = self.server.api.get_available_layouts(config_xml)
+      self.update_attributes(available_layouts: layouts) unless layouts.nil?
+    rescue BigBlueButton::BigBlueButtonException
+      Rails.logger.error "Could not fetch configurations for the server #{self.server.id}. The URL probably incorrect."
+    end
+  end
+
+  def available_layouts_names
+    # Translate the keys that come from server.available_layouts.
+    # If it's not a valid key (e.g. it's already a name) keep it as it is.
+    available_layouts.map { |layout|
+      # Ignores everything up to the last point
+      # e.g. from 'bbb.layout.name.defaultlayout' to 'defaultlayout'
+      # e.g. from 'defaultlayout' to 'defaultlayout'
+      basename = layout.gsub(/(.*[.])?/, '')
+
+      # We parameterize the id since the value can be anything, possibly an invalid
+      # key for yml (e.g. "Reunião").
+      key = "bigbluebutton_rails.server_configs.layouts.#{basename.parameterize('_')}"
+
+      I18n.t(key, default: basename)
+    }
+  end
+
+  # Returns an array of arrays for showing layouts in a select.
+  # The first member of the internal array is the layout's name, the second is the
+  # layout's ID (the raw value used to set the layout in the webconf server).
+  def available_layouts_for_select
+    available_layouts_names.zip(available_layouts)
+  end
+end

data/app/views/bigbluebutton/recordings/_form.html.erb

@@ -50,6 +50,10 @@
     <%= f.label :description %><br />
     <%= f.text_field :description %>
   </div>
+  <div class="field">
+    <%= f.label :size %><br />
+    <%= f.text_field :size %>
+  </div>
 
   <p>
     <b><%= BigbluebuttonRecording.human_attribute_name(:metadata) %>:</b>

data/app/views/bigbluebutton/recordings/_recordings.html.erb

@@ -1,6 +1,6 @@
 <div id="bbbrails_recordings_links">
   <%= link_to('View server list', bigbluebutton_servers_path) %><br/>
-  <%= link_to('View room list', bigbluebutton_rooms_path) %>
+  <%= link_to('View room list', bigbluebutton_rooms_path) %><br/>
 </div>
 
 <ul id="bbbrails_list">
@@ -23,6 +23,7 @@
       <div class="field"><label><%= BigbluebuttonRecording.human_attribute_name(:start_time) %></label> <%= recording.start_time %></div>
       <div class="field"><label><%= BigbluebuttonRecording.human_attribute_name(:end_time) %></label> <%= recording.end_time %></div>
       <div class="field"><label><%= BigbluebuttonRecording.human_attribute_name(:description) %></label> <%= recording.description %></div>
+      <div class="field"><label><%= BigbluebuttonRecording.human_attribute_name(:size) %></label> <%= recording.size %></div>
       <div class="field">
         <label><%= BigbluebuttonRecording.human_attribute_name(:metadata) %></label>
         <div>
@@ -48,8 +49,14 @@
       </div>
       <div class="field"><label>Play</label>
         <%= link_to "default", play_bigbluebutton_recording_path(recording) %>
-        <% recording.playback_formats.each do |format| %>
-          <%= link_to format.format_type, play_bigbluebutton_recording_path(recording, :type => format.format_type) %>
+        |
+        <% recording.playback_formats.ordered.each do |format| %>
+          <%= link_to format.name, play_bigbluebutton_recording_path(recording, :type => format.playback_type.identifier), :title => format.description %>
+          <%= "(visible: #{format.visible})" %>
+          <% if format.default? %>
+            <%= "(duration: #{format.length} mins)" %>
+          <% end %>
+          |
         <% end %>
       </div>
     </li>

data/app/views/bigbluebutton/rooms/_form.html.erb

@@ -37,12 +37,12 @@
     <%= f.check_box :private %>
   </div>
   <div class="field">
-    <%= f.label :attendee_password %><br />
-    <%= f.text_field :attendee_password %>
+    <%= f.label :attendee_key %><br />
+    <%= f.text_field :attendee_key %>
   </div>
   <div class="field">
-    <%= f.label :moderator_password %><br />
-    <%= f.text_field :moderator_password %>
+    <%= f.label :moderator_key %><br />
+    <%= f.text_field :moderator_key %>
   </div>
   <div class="field">
     <%= f.label :welcome_msg %><br />
@@ -73,13 +73,25 @@
     <%= f.text_field :param %>
   </div>
   <div class="field">
-    <%= f.label :record %><br />
-    <%= f.check_box :record %>
+    <%= f.label :record_meeting %><br />
+    <%= f.check_box :record_meeting %>
   </div>
   <div class="field">
     <%= f.label :duration %><br />
     <%= f.text_field :duration %>
   </div>
+  <div class="field">
+    <%= f.label :moderator_only_message %><br />
+    <%= f.text_field :moderator_only_message %><br />
+  </div>
+  <div class="field">
+    <%= f.label :auto_start_recording %><br />
+    <%= f.check_box :auto_start_recording %><br />
+  </div>
+  <div class="field">
+    <%= f.label :allow_start_stop_recording %><br />
+    <%= f.check_box :allow_start_stop_recording %><br />
+  </div>
   <div class="field">
     <b>Metadata</b> (by default we have 10 metadata in this view, but it's not limited to it)<br />
     <%= f.fields_for :metadata do |metadata_form| %>

data/app/views/bigbluebutton/rooms/_rooms.html.erb

@@ -15,8 +15,8 @@
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:name) %></label> <%= room.name %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:meetingid) %></label> <%= room.meetingid %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:private) %></label> <%= room.private %></div>
-      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:attendee_password) %></label> <%= room.attendee_password %></div>
-      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:moderator_password) %></label> <%= room.moderator_password %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:attendee_key) %></label> <%= room.attendee_key %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:moderator_key) %></label> <%= room.moderator_key %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:welcome_msg) %></label> <%= room.welcome_msg %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:logout_url) %></label> <%= room.logout_url %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:dial_number) %></label> <%= room.dial_number %></div>
@@ -24,8 +24,11 @@
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:max_participants) %></label> <%= room.max_participants %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:external) %></label> <%= room.external %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:param) %></label> <%= room.param %></div>
-      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:record) %></label> <%= room.record %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:record_meeting) %></label> <%= room.record_meeting %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:duration) %></label> <%= room.duration %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:moderator_only_message) %></label> <%= room.moderator_only_message %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:auto_start_recording) %></label> <%= room.auto_start_recording %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:allow_start_stop_recording) %></label> <%= room.allow_start_stop_recording %></div>
       <div class="field">
         <label><%= BigbluebuttonRoom.human_attribute_name(:metadata) %></label>
         <div>

data/app/views/bigbluebutton/rooms/invite.html.erb

@@ -43,7 +43,7 @@ $(document).ready(function(){
   <% end %>
 </div>
 
-<p><%= @room.name %> requires a name and/or password to join:</p>
+<p><%= @room.name %> requires a name and/or key to join:</p>
 <%= form_tag join_bigbluebutton_room_path(@room, :mobile => params[:mobile]) do %>
 
   <div class="field">
@@ -55,13 +55,13 @@ $(document).ready(function(){
     <% end %>
   </div>
   <div class="field">
-    <label for="user_password">Password:</label><br />
+    <label for="user_key">Key:</label><br />
     <% if @user_role == :attendee %>
-      <%= password_field_tag "user[password]", @room.attendee_password, :readonly => true %>
+      <%= password_field_tag "user[key]", @room.attendee_key, :readonly => true %>
     <% elsif @user_role == :moderator %>
-      <%= password_field_tag "user[password]", @room.moderator_password, :readonly => true %>
+      <%= password_field_tag "user[key]", @room.moderator_key, :readonly => true %>
     <% else %>
-      <%= password_field_tag "user[password]", "" %>
+      <%= password_field_tag "user[key]", "" %>
     <% end %>
   </div>
 

data/app/views/bigbluebutton/rooms/show.html.erb

@@ -21,12 +21,12 @@
   <%= @room.private %>
 </p>
 <p>
-  <b><%= BigbluebuttonRoom.human_attribute_name(:attendee_password) %>:</b>
-  <%= @room.attendee_password %>
+  <b><%= BigbluebuttonRoom.human_attribute_name(:attendee_key) %>:</b>
+  <%= @room.attendee_key %>
 </p>
 <p>
-  <b><%= BigbluebuttonRoom.human_attribute_name(:moderator_password) %>:</b>
-  <%= @room.moderator_password %>
+  <b><%= BigbluebuttonRoom.human_attribute_name(:moderator_key) %>:</b>
+  <%= @room.moderator_key %>
 </p>
 <p>
   <b><%= BigbluebuttonRoom.human_attribute_name(:welcome_msg) %>:</b>
@@ -57,13 +57,25 @@
   <%= @room.param %>
 </p>
 <p>
-  <b><%= BigbluebuttonRoom.human_attribute_name(:record) %>:</b>
-  <%= @room.record %>
+  <b><%= BigbluebuttonRoom.human_attribute_name(:record_meeting) %>:</b>
+  <%= @room.record_meeting %>
 </p>
 <p>
   <b><%= BigbluebuttonRoom.human_attribute_name(:duration) %>:</b>
   <%= @room.duration %>
 </p>
+<p>
+  <b><%= BigbluebuttonRoom.human_attribute_name(:moderator_only_message) %>:</b>
+  <%= @room.moderator_only_message %>
+</p>
+<p>
+  <b><%= BigbluebuttonRoom.human_attribute_name(:auto_start_recording) %>:</b>
+  <%= @room.auto_start_recording %>
+</p>
+<p>
+  <b><%= BigbluebuttonRoom.human_attribute_name(:allow_start_stop_recording) %>:</b>
+  <%= @room.allow_start_stop_recording %>
+</p>
 <p>
   <b><%= BigbluebuttonRoom.human_attribute_name(:metadata) %></b>
   <% @room.metadata.each do |metadata| %>

data/app/views/bigbluebutton/servers/_form.html.erb

@@ -28,7 +28,7 @@
   </div>
   <div class="field">
     <%= f.label :version %><br />
-    <%= f.text_field :version %>
+    <%= f.text_field :version, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :param %><br />

data/app/views/bigbluebutton/servers/show.html.erb

@@ -59,6 +59,11 @@
   <%= @server.param %>
 </p>
 
+<p>
+  <b><%= BigbluebuttonServerConfig.human_attribute_name(:available_layouts) %></b>
+  <%= @server.config.available_layouts %>
+</p>
+
 <p>
   <span>Access:</span>
   <%= link_to 'Edit', edit_bigbluebutton_server_path(@server) %> |

data/app/workers/bigbluebutton_finish_meetings.rb

@@ -0,0 +1,11 @@
+# A resque worker to check for meetings that already finished and mark
+# them as finished.
+# Same as "rake bigbluebutton_rails:meetings:finish".
+class BigbluebuttonFinishMeetings
+  @queue = :bigbluebutton_rails
+
+  def self.perform
+    Rails.logger.info "BigbluebuttonFinishMeetings worker running"
+    BigbluebuttonRails::BackgroundTasks.finish_meetings
+  end
+end