bigbluebutton_rails 1.4.0 → 2.0.0

data/TODO.md

@@ -0,0 +1,13 @@
+TODO:
+* Pre-upload of slides
+* Options 'redirectClient' and 'clientURL' on 'create'
+* Option 'avatarURL' on 'join'
+* 'getDefaultConfigXML' and 'setConfigXML'. They are already used when a
+  user joins a meeting, to set the custom options configured in the target
+  room. But these API methods cannot be called individually yet.
+
+
+See:
+* http://docs.bigbluebutton.org/dev/api.html
+* http://groups.google.com/group/bigbluebutton-dev/browse_thread/thread/c214
+  cbe9bdb2268a?pli=1

data/app/controllers/bigbluebutton/playback_types_controller.rb

@@ -0,0 +1,44 @@
+class Bigbluebutton::PlaybackTypesController < ApplicationController
+  include BigbluebuttonRails::InternalControllerMethods
+
+  respond_to :html
+  respond_to :json
+  before_filter :find_playback_type, only: [:update]
+
+  def update
+    respond_with @playback_type do |format|
+      if @playback_type.update_attributes(playback_type_params)
+        format.html {
+          message = t('bigbluebutton_rails.playback_types.notice.update.success')
+          redirect_to_using_params request.referer, :notice => message
+        }
+        format.json { render :json => true, :status => :ok }
+      else
+        format.html {
+          flash[:error] = @playback_type.errors.full_messages.join(", ")
+          redirect_to_using_params request.referer
+        }
+        format.json { render :json => @playback_type.errors.full_messages, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  protected
+
+  def find_playback_type
+    @playback_type ||= BigbluebuttonPlaybackType.find(params[:id])
+  end
+
+  def playback_type_params
+    unless params[:bigbluebutton_playback_type].nil?
+      params[:bigbluebutton_playback_type].permit(*playback_type_allowed_params)
+    else
+      {}
+    end
+  end
+
+  def playback_type_allowed_params
+    [ :visible, :default ]
+  end
+
+end

data/app/controllers/bigbluebutton/recordings_controller.rb

@@ -5,9 +5,11 @@ class Bigbluebutton::RecordingsController < ApplicationController
   respond_to :json, :only => [:index, :show, :update, :destroy, :publish, :unpublish]
   before_filter :find_recording, :except => [:index]
   before_filter :check_for_server, :only => [:publish, :unpublish]
+  before_filter :find_playback, :only => [:play]
 
   def index
-    respond_with(@recordings = BigbluebuttonRecording.all)
+    @recordings ||= BigbluebuttonRecording.all
+    respond_with(@recordings)
   end
 
   def show
@@ -69,15 +71,10 @@ class Bigbluebutton::RecordingsController < ApplicationController
   end
 
   def play
-    if params[:type]
-      playback = @recording.playback_formats.where(:format_type => params[:type]).first
-    else
-      playback = @recording.playback_formats.first
-    end
     respond_with do |format|
       format.html {
-        if playback
-          redirect_to playback.url
+        if @playback
+          redirect_to @playback.url
         else
           flash[:error] = t('bigbluebutton_rails.recordings.errors.play.no_format')
           redirect_to_using_params bigbluebutton_recording_url(@recording)
@@ -97,7 +94,7 @@ class Bigbluebutton::RecordingsController < ApplicationController
   protected
 
   def find_recording
-    @recording = BigbluebuttonRecording.find_by_recordid(params[:id])
+    @recording ||= BigbluebuttonRecording.find_by_recordid(params[:id])
   end
 
   def check_for_server
@@ -146,7 +143,7 @@ class Bigbluebutton::RecordingsController < ApplicationController
     unless params[:bigbluebutton_recording].nil?
       params[:bigbluebutton_recording].permit(*recording_allowed_params)
     else
-      []
+      {}
     end
   end
 
@@ -154,4 +151,14 @@ class Bigbluebutton::RecordingsController < ApplicationController
     [ :recordid, :meetingid, :name, :published, :start_time, :end_time, :available, :description ]
   end
 
+  protected
+
+  def find_playback
+    if params[:type]
+      @playback = @recording.playback_formats.where(:playback_type_id => BigbluebuttonPlaybackType.find_by_identifier(params[:type])).first
+    else
+      @playback = @recording.default_playback_format || @recording.playback_formats.first
+    end
+  end
+
 end

data/app/controllers/bigbluebutton/rooms_controller.rb

@@ -18,7 +18,8 @@ class Bigbluebutton::RoomsController < ApplicationController
   respond_to :json, :only => [:running, :show, :new, :index, :create, :update]
 
   def index
-    respond_with(@rooms = BigbluebuttonRoom.all)
+    @rooms ||= BigbluebuttonRoom.all
+    respond_with(@rooms)
   end
 
   def show
@@ -26,7 +27,8 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def new
-    respond_with(@room = BigbluebuttonRoom.new)
+    @room ||= BigbluebuttonRoom.new
+    respond_with(@room)
   end
 
   def edit
@@ -34,7 +36,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def create
-    @room = BigbluebuttonRoom.new(room_params)
+    @room ||= BigbluebuttonRoom.new(room_params)
 
     if params[:bigbluebutton_room] and
         (not params[:bigbluebutton_room].has_key?(:meetingid) or
@@ -214,13 +216,34 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def recordings
-    respond_with(@recordings = @room.recordings)
+    @recordings ||= @room.recordings
+    respond_with(@recordings)
+  end
+
+  def generate_dial_number
+    pattern = params[:pattern].blank? ? nil : params[:pattern]
+    if @room.generate_dial_number!(pattern)
+      message = t('bigbluebutton_rails.rooms.notice.generate_dial_number.success')
+      respond_with do |format|
+        format.html { redirect_to_using_params :back, notice: message }
+        format.json { render json: true, status: :ok }
+      end
+    else
+      message = t('bigbluebutton_rails.rooms.errors.generate_dial_number.not_unique')
+      respond_with do |format|
+        format.html {
+          flash[:error] = message
+          redirect_to_using_params :back
+        }
+        format.json { render json: { message: message }, status: :error }
+      end
+    end
   end
 
   protected
 
   def find_room
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
+    @room ||= BigbluebuttonRoom.find_by_param(params[:id])
   end
 
   def set_request_headers
@@ -230,7 +253,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def join_check_room
-    @room = BigbluebuttonRoom.find_by_param(params[:id]) unless params[:id].blank?
+    @room ||= BigbluebuttonRoom.find_by_param(params[:id]) unless params[:id].blank?
     if @room.nil?
       message = t('bigbluebutton_rails.rooms.errors.join.wrong_params')
       redirect_to :back, :notice => message
@@ -250,12 +273,12 @@ class Bigbluebutton::RoomsController < ApplicationController
       @user_id = bigbluebutton_user.id
     end
 
-    # the role: nil means access denied, :password means check the room
-    # password, otherwise just use it
+    # the role: nil means access denied, :key means check the room
+    # key, otherwise just use it
     @user_role = bigbluebutton_role(@room)
     if @user_role.nil?
       raise BigbluebuttonRails::RoomAccessDenied.new
-    elsif @user_role == :password
+    elsif @user_role == :key
       @user_role = @room.user_role(params[:user])
     end
 
@@ -268,37 +291,34 @@ class Bigbluebutton::RoomsController < ApplicationController
   # Aborts and redirects to an error if the user can't create a meeting in
   # the room and it needs to be created.
   def join_check_can_create
-    begin
-      unless @room.fetch_is_running?
-        unless bigbluebutton_can_create?(@room, @user_role)
-          flash[:error] = t('bigbluebutton_rails.rooms.errors.join.cannot_create')
-          redirect_to_on_join_error
-        end
+    unless @room.fetch_is_running?
+      unless bigbluebutton_can_create?(@room, @user_role)
+        flash[:error] = t('bigbluebutton_rails.rooms.errors.join.cannot_create')
+        redirect_to_on_join_error
       end
-    rescue BigBlueButton::BigBlueButtonException => e
-      flash[:error] = e.to_s[0..200]
-      redirect_to_on_join_error
     end
+  rescue BigBlueButton::BigBlueButtonException => e
+    flash[:error] = e.to_s[0..200]
+    redirect_to_on_join_error
   end
 
   # If the user called the join from a mobile device, he will be redirected to
   # an intermediary page with information about the mobile client. A few flags set
   # in the params can override this behavior and skip this intermediary page.
   def join_check_redirect_to_mobile
-    if browser.mobile? &&
-        !BigbluebuttonRails::value_to_boolean(params[:auto_join]) &&
-        !BigbluebuttonRails::value_to_boolean(params[:desktop])
+    return if !BigbluebuttonRails.use_mobile_client?(browser) ||
+              BigbluebuttonRails.value_to_boolean(params[:auto_join]) ||
+              BigbluebuttonRails.value_to_boolean(params[:desktop])
 
-      # since we're redirecting to an intermediary page, we set in the params the params
-      # we received, including the referer, so we can go back to the previous page if needed
-      filtered_params = select_params_for_join_mobile(params.clone)
-      begin
-        filtered_params[:redir_url] = Addressable::URI.parse(request.env["HTTP_REFERER"]).path
-      rescue
-      end
-
-      redirect_to join_mobile_bigbluebutton_room_path(@room, filtered_params)
+    # since we're redirecting to an intermediary page, we set in the params the params
+    # we received, including the referer, so we can go back to the previous page if needed
+    filtered_params = select_params_for_join_mobile(params.clone)
+    begin
+      filtered_params[:redir_url] = Addressable::URI.parse(request.env["HTTP_REFERER"]).path
+    rescue
     end
+
+    redirect_to join_mobile_bigbluebutton_room_path(@room, filtered_params)
   end
 
   # Selects the params from `params` that should be passed in a redirect to `join_mobile` and
@@ -319,7 +339,9 @@ class Bigbluebutton::RoomsController < ApplicationController
       unless @room.fetch_is_running?
         if bigbluebutton_can_create?(@room, role)
           user_opts = bigbluebutton_create_options(@room)
-          @room.create_meeting(bigbluebutton_user, request, user_opts)
+          if @room.create_meeting(bigbluebutton_user, request, user_opts)
+            logger.info "Meeting created: id: #{@room.meetingid}, name: #{@room.name}, created_by: #{bigbluebutton_user.username}, time: #{Time.now.iso8601}"
+          end
         else
           flash[:error] = t('bigbluebutton_rails.rooms.errors.join.cannot_create')
           redirect_to_on_join_error
@@ -331,12 +353,17 @@ class Bigbluebutton::RoomsController < ApplicationController
       token = @room.fetch_new_token
       options = if token.nil? then {} else { :configToken => token } end
 
+      # set the create time and the user id, if they exist
+      options.merge!({ createTime: @room.create_time }) unless @room.create_time.blank?
+      options.merge!({ userID: id }) unless id.blank?
+
       # room created and running, try to join it
       url = @room.join_url(username, role, nil, options)
       unless url.nil?
 
         # change the protocol to join with a mobile device
-        if browser.mobile? && !BigbluebuttonRails::value_to_boolean(params[:desktop])
+        if BigbluebuttonRails.use_mobile_client?(browser) &&
+           !BigbluebuttonRails.value_to_boolean(params[:desktop])
           url.gsub!(/^[^:]*:\/\//i, "bigbluebutton://")
         end
 
@@ -361,14 +388,16 @@ class Bigbluebutton::RoomsController < ApplicationController
     unless params[:bigbluebutton_room].nil?
       params[:bigbluebutton_room].permit(*room_allowed_params)
     else
-      []
+      {}
     end
   end
 
   def room_allowed_params
-    [ :name, :server_id, :meetingid, :attendee_password, :moderator_password, :welcome_msg,
+    [ :name, :server_id, :meetingid, :attendee_key, :moderator_key, :welcome_msg,
       :private, :logout_url, :dial_number, :voice_bridge, :max_participants, :owner_id,
-      :owner_type, :external, :param, :record, :duration, :default_layout, :presenter_share_only,
-      :auto_start_video, :auto_start_audio, :metadata_attributes => [ :id, :name, :content, :_destroy, :owner_id ] ]
+      :owner_type, :external, :param, :record_meeting, :duration, :default_layout, :presenter_share_only,
+      :auto_start_video, :auto_start_audio, :background,
+      :moderator_only_message, :auto_start_recording, :allow_start_stop_recording,
+      :metadata_attributes => [ :id, :name, :content, :_destroy, :owner_id ] ]
   end
 end

data/app/controllers/bigbluebutton/servers_controller.rb

@@ -6,7 +6,8 @@ class Bigbluebutton::ServersController < ApplicationController
   before_filter :find_server, :except => [:index, :new, :create]
 
   def index
-    respond_with(@servers = BigbluebuttonServer.all)
+    @servers ||= BigbluebuttonServer.all
+    respond_with(@servers)
   end
 
   def show
@@ -14,7 +15,8 @@ class Bigbluebutton::ServersController < ApplicationController
   end
 
   def new
-    respond_with(@server = BigbluebuttonServer.new)
+    @server ||= BigbluebuttonServer.new
+    respond_with(@server)
   end
 
   def edit
@@ -58,7 +60,7 @@ class Bigbluebutton::ServersController < ApplicationController
   end
 
   def create
-    @server = BigbluebuttonServer.new(server_params)
+    @server ||= BigbluebuttonServer.new(server_params)
 
     respond_with @server do |format|
       if @server.save
@@ -100,11 +102,13 @@ class Bigbluebutton::ServersController < ApplicationController
   end
 
   def recordings
-    respond_with(@recordings = @server.recordings)
+    @recordings ||= @server.recordings
+    respond_with(@recordings)
   end
 
   def rooms
-    respond_with(@rooms = @server.rooms)
+    @rooms ||= @server.rooms
+    respond_with(@rooms)
   end
 
   def publish_recordings
@@ -156,7 +160,7 @@ class Bigbluebutton::ServersController < ApplicationController
   protected
 
   def find_server
-    @server = BigbluebuttonServer.find_by_param(params[:id])
+    @server ||= BigbluebuttonServer.find_by_param(params[:id])
   end
 
   def publish_unpublish(ids, publish)
@@ -188,12 +192,12 @@ class Bigbluebutton::ServersController < ApplicationController
     unless params[:bigbluebutton_server].nil?
       params[:bigbluebutton_server].permit(*server_allowed_params)
     else
-      []
+      {}
     end
   end
 
   def server_allowed_params
-    [ :name, :url, :version, :salt, :param ]
+    [ :name, :url, :salt, :param ]
   end
 
 end

data/app/models/bigbluebutton_metadata.rb

@@ -8,7 +8,7 @@ class BigbluebuttonMetadata < ActiveRecord::Base
 
   validates :name, :presence => true
   validates :name, :format => {
-    :with => /^[a-zA-Z]+[a-zA-Z\d-]*$/,
+    :with => /\A[a-zA-Z]+[a-zA-Z\d-]*\z/,
     :message => I18n.t('bigbluebutton_rails.metadata.errors.name_format')
   }
   validates :name,

data/app/models/bigbluebutton_playback_format.rb

@@ -2,8 +2,29 @@ class BigbluebuttonPlaybackFormat < ActiveRecord::Base
   include ActiveModel::ForbiddenAttributesProtection
 
   belongs_to :recording, :class_name => 'BigbluebuttonRecording'
+  belongs_to :playback_type, :class_name => 'BigbluebuttonPlaybackType'
+
+  delegate :name, :identifier, :visible, :visible?, :default, :default?, :description,
+    to: :playback_type, allow_nil: true
+  alias_attribute :format_type, :identifier
 
   validates :recording_id, :presence => true
 
-  validates :format_type, :presence => true
+  scope :ordered, -> {
+    default = joins(:playback_type).where("bigbluebutton_playback_types.default = ?", true)
+    if default.pluck(:id).empty?
+      others = all
+    else
+      others = where("id NOT IN (?)", default.pluck(:id))
+    end
+    default.concat others
+  }
+
+  def length_in_secs
+    if self.length.blank? || self.length < 0
+      0
+    else
+      self.length * 60
+    end
+  end
 end

data/app/models/bigbluebutton_playback_type.rb

@@ -0,0 +1,29 @@
+class BigbluebuttonPlaybackType < ActiveRecord::Base
+  include ActiveModel::ForbiddenAttributesProtection
+
+  validates :identifier, :presence => true
+
+  has_many :playback_formats,
+           :class_name => 'BigbluebuttonPlaybackFormat',
+           :foreign_key => 'playback_type_id',
+           :dependent => :nullify
+
+  # Ensure there will be 0 or 1 (no more) records with default=true.
+  # Setting a record with default=true will automatically set all others to default=false.
+  before_save :ensure_default_uniqueness
+  def ensure_default_uniqueness
+    if default_changed? && default?
+      self.class.where('id != ?', self.id).update_all(default: false)
+    end
+  end
+
+  def name
+    default = self.identifier.gsub("_", " ").titleize
+    I18n.t("bigbluebutton_rails.playback_types.#{self.identifier}.name", default: default)
+  end
+
+  def description
+    default = self.identifier.gsub("_", " ").titleize
+    I18n.t("bigbluebutton_rails.playback_types.#{self.identifier}.tip", default: default)
+  end
+end