csd 0.1.18 → 0.2.0

data/lib/csd/application/i2conf/config_example.rb

@@ -0,0 +1,22 @@
+# -*- encoding: UTF-8 -*-
+
+module CSD
+  module Application
+    module I2conf
+      
+      CONFIG_EXAMPLE = %{
+<interface>eth0</interface>
+<use_udp>true</use_udp>
+<use_tcp>false</use_tcp>
+<sip_identity>
+  <uri>mcu@carenet-se.se</uri>
+  <local_port>5060</local_port>
+  <register>true</register>
+  <username>mcu</username>
+  <password>YOURPASSWORD</password>
+  <realm>carenet-se.se</realm>
+</sip_identity>}
+
+    end
+  end
+end

data/lib/csd/application/i2conf/options/common.rb

@@ -0,0 +1,11 @@
+# -*- encoding: UTF-8 -*-
+
+opts.headline 'WORKING DIRECTORY OPTIONS'.green.bold
+
+opts.on("--no-temp", "Use a subdirectory in the current directory as working directory and not /tmp.") do |value|
+  self.temp = value
+end
+
+opts.on("--work-dir [PATH]", "Defines and/or creates the working directory. This will override the --no-temp option.") do |value|
+  self.work_dir = value
+end

data/lib/csd/application/i2conf/options/common_defaults.rb

@@ -0,0 +1,4 @@
+# -*- encoding: UTF-8 -*-
+
+self.temp = true
+self.work_dir = nil

data/lib/csd/application/i2conf/options/install.rb

@@ -0,0 +1,10 @@
+# -*- encoding: UTF-8 -*-
+# This file gets eval'ed by the global options parser in lib/csd/options_parser
+
+opts.on("--no-apt-get","Don't run any apt-get commands") do |value|
+  self.apt_get = value
+end
+
+opts.on("--no-minisip","Don't install the MiniSIP libraries (needed by i2conf)") do |value|
+  self.minisip = value
+end

data/lib/csd/application/i2conf/options/install_defaults.rb

@@ -0,0 +1,4 @@
+# -*- encoding: UTF-8 -*-
+
+self.apt_get = true
+self.minisip = true

data/lib/csd/application/minisip.rb

@@ -54,19 +54,15 @@ module CSD
                   # 32 bit
                   UI.debug "#{self}.instance supports Linux (32 bit)"
                   UI.debug "#{self}.instance analyzes the Linux kernel release #{Gem::Platform.local.kernel_release.to_s.enquote}"
-                  case Gem::Platform.local.kernel_release
-
-                    when '2.6.32-21-generic', '2.6.32-22-generic'
-                      # Ubuntu 10.04
-                      UI.debug "#{self}.instance supports Ubuntu 10.04"
-                      Ubuntu10.new
-
-                    else
-                      # Any other Linux (currently only Debian is supported)
-                      UI.debug "#{self}.instance supports Debian"
-                      Debian.new
+                  if Gem::Platform.local.ubuntu_10?
+                    # Ubuntu 10.04
+                    UI.debug "#{self}.instance supports Ubuntu 10.04"
+                    Ubuntu10.new
+                  else
+                    # Any other Linux (currently only Debian is supported)
+                    UI.debug "#{self}.instance supports Debian"
+                    Debian.new
                   end
-                
                 else
                   # 64 bit
                   UI.debug "#{self}.instance found the architecture to be other than 'x86', but 64 bit is not supported"

data/lib/csd/application/minisip/about.yml

@@ -1,14 +1,22 @@
+# -*- encoding: UTF-8 -*-
 human: MiniSIP
 description: An open-source SIP client for high-definition video conferencing.
 actions:
   public:
     #- show: Shows further information about MiniSIP
     #- download: Downloads MiniSIP components (e.g. source code, configurations, docs,...)
-    - compile: Downloads and compiles MiniSIP from scratch
-    #- package: Downloads, compiles and packages MiniSIP from scratch
+    - install: Downloads and compiles MiniSIP from scratch
     #- install: Installs an application
-    #- check: Checks whether the environment dependencies for the application are satisfied
   developer:
+    - check: Checks whether the environment dependencies for MiniSIP are satisfied
+    - package: Downloads, compiles and packages MiniSIP from scratch
     #- publish: Submits a compiled package to the CSD package repository
 scopes:
-  --- {}
+  install:
+    - core: Install only the Core component of MiniSIP
+    - ffmpeg: Install only the FFmpeg component of MiniSIP
+    - gnome: Install only the GNOME component of MiniSIP
+    - hdviper: Install only the HDVIPER component of MiniSIP
+    - network: Install only the Network component of MiniSIP
+    - plugins: Install only the Plugins component of MiniSIP
+    - x264: Install only the x264 component of MiniSIP

data/lib/csd/application/minisip/base.rb

@@ -15,6 +15,13 @@ module CSD
           super
           define_relative_paths
         end
+        
+        # Running the install task.
+        # Currently this corresponds to the compile task.
+        #
+        def install
+          compile
+        end
 
         # Running the compile task.
         #
@@ -27,6 +34,31 @@ module CSD
         def package
           UI.error 'Currently not supported for this platform. Sorry.'
         end
+
+        # Running the check task.
+        #
+        def check
+          UI.error 'Currently not supported for this platform. Sorry.'
+        end
+        
+        # Determines which components of MiniSIP should be processed, because the scope parameter might be set
+        # by the user, requesting for only a particular component.
+        #
+        def components
+          Options.scope ? [Options.scope] : Options.scopes_names
+        end
+        
+        # Determine whether all components should be processed or not.
+        #
+        def all_components?
+          components == Options.scopes_names
+        end
+        
+        # Determines whether a particular component should be processed.
+        #
+        def component?(name)
+          components.include? name
+        end
         
         # This methods prints general information about this application module.
         #
@@ -50,6 +82,7 @@ module CSD
         # Defines all paths ever needed for the MiniSIP module based on the working directory.
         #
         def define_relative_paths
+          UI.debug "#{self.class}#define_relative_paths defines relative MiniSIP paths now"
           if Options.this_user
             Path.build = Pathname.new(File.join(Path.work, 'build'))
           else
@@ -68,7 +101,7 @@ module CSD
           Path.build_share_aclocal                = Pathname.new(File.join(Path.build_share, 'aclocal'))
           Path.giomm_header                       = Pathname.new(File.join('/', 'usr', 'include', 'giomm-2.4', 'giomm.h'))
           Path.giomm_header_backup                = Pathname.new(File.join('/', 'usr', 'include', 'giomm-2.4', 'giomm.h.ai-backup'))
-          Path.repository                         = Pathname.new(File.join(Path.work, 'repository'))
+          Path.repository                         = Pathname.new(File.join(Path.work, 'minisip'))
           Path.repository_libminisip_rules        = Pathname.new(File.join(Path.repository, 'libminisip', 'debian', 'rules'))
           Path.repository_libminisip_rules_backup = Pathname.new(File.join(Path.repository, 'libminisip', 'debian', 'rules.ai-backup'))
           Path.repository_grabber                 = Pathname.new(File.join(Path.repository, 'libminisip', 'source', 'subsystem_media', 'video', 'grabber'))
@@ -95,6 +128,12 @@ module CSD
           Path.minisip_gnome_pixmap               = Pathname.new(File.join('/', 'usr', 'share', 'pixmaps', 'minisip_gnome.png'))
           Path.minisip_desktop_entry              = Pathname.new(File.join('/', 'usr', 'share', 'applications', 'minisip.desktop'))
           Path.phonebook                          = Pathname.new(File.join(ENV['HOME'], '.minisip.addr'))
+          Path.realtek_firmware                   = Pathname.new(File.join(Path.work, 'realtek'))
+          Path.intel_firmware                     = Pathname.new(File.join(Path.work, 'intel'))
+          Path.intel_firmware_src                 = Pathname.new(File.join(Path.intel_firmware, 'src'))
+          Path.sysctl_conf                        = Pathname.new(File.join('/', 'etc', 'sysctl.conf'))
+          Path.sysctl_conf_backup                 = Pathname.new(File.join('/', 'etc', 'sysctl.conf.ai-backup'))
+          Path.new_sysctl_conf                    = Pathname.new(File.join(Path.work, 'sysctl.conf'))
         end
         
       end

data/lib/csd/application/minisip/component.rb

@@ -5,4 +5,6 @@ require 'csd/application/minisip/component/gnome'
 require 'csd/application/minisip/component/hdviper'
 require 'csd/application/minisip/component/plugins'
 require 'csd/application/minisip/component/x264'
+require 'csd/application/minisip/component/network'
+
 

data/lib/csd/application/minisip/component/core.rb

@@ -41,7 +41,7 @@ module CSD
             def remove_ffmpeg
               ffmpeg_available = Cmd.run('ffmpeg -h', :internal => true, :die_on_failure => false).success?
               return if Options.ffmpeg_first or !Options.configure or !libraries.include?('libminisip') or !ffmpeg_available
-              UI.debug "MILESTONE: removing_ffmpeg"
+              UI.debug "MILESTONE_removing_ffmpeg"
               if Gem::Platform.local.debian?
                 # Note that FFmpeg must have been installed via apt-get or via the AI in order for this to work,
                 # because manual compilations of FFmpeg cannot be removed automatically
@@ -50,7 +50,7 @@ module CSD
                 Cmd.run "sudo apt-get remove ffmpeg --yes", :announce_pwd => false
               else
                 # On other linux distributions we don't know how to remove ffmpeg
-                UI.debug "MILESTONE: cannot_remove_ffmpeg"
+                UI.debug "MILESTONE_cannot_remove_ffmpeg"
                 raise Error::Minisip::Core::FFmpegInstalled, "Please remove ffmpeg from your system first, or run the #{CSD.executable} with --no-configure" unless Options.testmode
               end
             end
@@ -143,10 +143,11 @@ module CSD
             #
             def compile_libraries
               create_build_dir
+              UI.debug "MILESTONE_processing_libraries"
               libraries.each do |library|
                 directory = Pathname.new(File.join(Path.repository, library))
                 if Cmd.cd(directory, :internal => true).success? or Options.reveal
-                  UI.debug "MILESTONE: processing_#{library}"
+                  UI.debug "MILESTONE_processing_#{library}"
                   UI.info "Processing MiniSIP -> #{library}".green.bold
                   bootstrap
                   configure library
@@ -192,14 +193,20 @@ module CSD
             def configure!(name='')
               individual_options = case name
                 when 'libminisip'
-                  %Q{--enable-debug --enable-video --enable-opengl --disable-mil --enable-decklink --disable-sdl #{libminisip_cpp_flags} #{libminisip_ld_flags}}
+                  %Q{--enable-video --enable-opengl --disable-mil --enable-decklink --disable-sdl #{libminisip_cpp_flags} #{libminisip_ld_flags}}
                 when 'minisip'
-                  %Q{--enable-debug --enable-video --enable-opengl --enable-textui}
+                  %Q{--enable-video --enable-opengl --enable-textui}
                 else
                   ''
               end
+              # The --enable-debug option should only be there if specifically requested
+              debug_options = (Options.enable_debug and (name == 'libminisip' or name == 'minisip')) ? '--enable-debug' : ''
+              # These options are used by all libraries
               common_options = Options.this_user ? %Q{--prefix="#{Path.build}" PKG_CONFIG_PATH="#{Path.build_lib_pkg_config}" ACLOCAL_FLAGS="#{Path.build_share_aclocal}" LD_LIBRARY_PATH="#{Path.build_lib}"} : ''
-              Cmd.run ['./configure', common_options, individual_options].join(' ')
+              # I2conf needs to compile MiniSIP without any options
+              individual_options = '' if Options.blank_minisip_configuration
+              # Putting it all together
+              Cmd.run ['./configure', common_options, debug_options, individual_options].join(' ')
             end
             
             def make

data/lib/csd/application/minisip/component/gnome.rb

@@ -50,6 +50,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
             # If this step would not be done, the MiniSIP menu item would disappear after restarting Ubuntu.
             #
             def update_gnome_menu_cache
+              return unless Gem::Platform.local.ubuntu_10?
               Cmd.run %{sudo sh -c "/usr/share/gnome-menus/update-gnome-menus-cache /usr/share/applications/ > /usr/share/applications/desktop.${LANG}.cache"}, :announce_pwd => false
             end
             

data/lib/csd/application/minisip/component/network.rb

@@ -0,0 +1,95 @@
+# -*- encoding: UTF-8 -*-
+
+module CSD
+  module Application
+    module Minisip
+      module Component
+        module Network
+          class << self
+            
+            OPTIMUM_BUFFERS = {
+              'net.core.rmem_max'     => '131071',
+              'net.core.wmem_max'     => '131071',
+              'net.core.rmem_default' => '114688',
+              'net.core.wmem_default' => '114688',
+              'net.ipv4.udp_mem'      => '81120 108160 162240',
+              'net.ipv4.udp_rmem_min' => '4096',
+              'net.ipv4.udp_wmem_min' => '4096'
+            }
+            
+            def compile
+              UI.debug "#{self}.compile was called"
+              fix_udp_buffer
+              permanent_udp_buffer
+              lsmod = Cmd.run 'lsmod', :die_on_failure => false, :internal => true
+              lspci = Cmd.run 'lspci -v | grep Ethernet', :die_on_failure => false, :internal => true
+              UI.debug "#{self}.compile had this lsmod output: #{lsmod.output}"
+              UI.debug "#{self}.compile had this lspci output: #{lspci.output}"
+              update_realtek if (lsmod.success? and lsmod.output !~ /r8168/ and lspci.output =~ /RTL8111\/8168B/) or Options.reveal
+              update_intel if (lspci.success? and lspci.output =~ /82572EI/) or Options.reveal
+            end
+            
+            def fix_udp_buffer
+              return unless Gem::Platform.local.debian? or Options.reveal
+              UI.info 'Fixing UDP buffer size'.green.bold
+              OPTIMUM_BUFFERS.each do |key, value|
+                Cmd.run %{sudo sysctl -w #{key}="#{value}"}, :announce_pwd => false
+              end
+            end
+            
+            def permanent_udp_buffer
+              if Path.sysctl_conf_backup.file? and !Options.reveal
+                UI.warn "The UDP buffer modifications seems to be permanent already. Delete #{Path.sysctl_conf_backup.enquote} to enforce it."
+              else
+                UI.info 'Making the UDP buffer modifications permanent'.green.bold
+                content = Path.sysctl_conf.file? ? File.read(Path.sysctl_conf) : ''
+                Cmd.copy Path.sysctl_conf, Path.new_sysctl_conf
+                UI.info "Adding modifications to #{Path.new_sysctl_conf}".cyan
+                modifications = ['', '# Changes made by the AI'] + OPTIMUM_BUFFERS.map { |key, value| %{#{key} = #{value}} }
+                Cmd.touch_and_replace_content Path.new_sysctl_conf, modifications.join("\n"), :internal => true
+                # We cannot use Cmd.copy here, because Cmd.copy has no superuser privileges.
+                # And since we are for sure on Ubuntu, these commands will work.
+                Cmd.run "sudo cp #{Path.sysctl_conf} #{Path.sysctl_conf_backup}", :announce_pwd => false
+                Cmd.run "sudo cp #{Path.new_sysctl_conf} #{Path.sysctl_conf}", :announce_pwd => false
+              end
+            end
+            
+            def update_realtek
+              checkout_realtek
+              compile_realtek
+            end
+            
+            def update_intel
+              checkout_intel
+              compile_intel
+            end
+            
+            def checkout_realtek
+              Cmd.git_clone 'Realtek firmware', 'git://github.com/csd/realtek.git', Path.realtek_firmware
+            end
+            
+            def checkout_intel
+              Cmd.git_clone 'Intel firmware', 'git://github.com/csd/intel.git', Path.intel_firmware
+            end
+            
+            def compile_realtek
+              UI.info 'Compiling Realtek firmware'.green.bold
+              Cmd.cd Path.realtek_firmware, :internal => true
+              Cmd.run 'sudo ./autorun.sh'
+            end
+            
+            def compile_intel
+              UI.info 'Compiling Intel firmware'.green.bold
+              Cmd.cd Path.intel_firmware_src, :internal => true
+              Cmd.run 'sudo make install'
+            end
+            
+            def introduction
+            end
+            
+          end
+        end
+      end
+    end
+  end
+end

data/lib/csd/application/minisip/component/plugins.rb

@@ -27,7 +27,7 @@ module CSD
             # Copies the plugins from the repository to the final destination.
             #
             def copy
-              if Path.plugins_destination.directory?
+              if Path.plugins_destination.directory? or Options.reveal
                 UI.info "Installing optional MiniSIP plugins".green.bold
                 UI.info "Copying from `#{Path.plugins_destination}´ to `#{Path.plugins}´".yellow
                 Dir[File.join(Path.plugins, '{md,mg,mvideo}*.{a,la,so}')].each do |plugin|

data/lib/csd/application/minisip/options/{compile.rb → install.rb}

@@ -42,3 +42,7 @@ end
 opts.on("--only libmutil,libmsip,etc.", Array, "Process only these libraries") do |list|
   self.only = list
 end
+
+opts.on("--enable-debug","Enable MiniSIP-internal debugging") do |value|
+  self.enable_debug = value
+end

data/lib/csd/application/minisip/options/{compile_defaults.rb → install_defaults.rb}

@@ -7,4 +7,5 @@ self.bootstrap = true
 self.configure = true
 self.make = true
 self.make_install = true
-self.only = nil
+self.only = nil
+self.enable_debug = false

data/lib/csd/application/minisip/phonebook_example.rb

@@ -18,7 +18,7 @@ module CSD
 				Client 1
 			</desc>
 			<uri>
-				sip:client1@carenet-se.se
+				client1@carenet-se.se
 			</uri>
 		</pop>
 		<pop>
@@ -26,7 +26,7 @@ module CSD
 				Client2
 			</desc>
 			<uri>
-				sip:client2@carenet-se.se
+				client2@carenet-se.se
 			</uri>
 		</pop>
 		<pop>
@@ -34,7 +34,7 @@ module CSD
 				Client3
 			</desc>
 			<uri>
-				sip:client3@carenet-se.se
+				client3@carenet-se.se
 			</uri>
 		</pop>
 		<pop>
@@ -42,7 +42,7 @@ module CSD
 				Client4
 			</desc>
 			<uri>
-				sip:client4@carenet-se.se
+				client4@carenet-se.se
 			</uri>
 		</pop>
 		<pop>
@@ -50,7 +50,7 @@ module CSD
 				Client5
 			</desc>
 			<uri>
-				sip:client5@carenet-se.se
+				client5@carenet-se.se
 			</uri>
 		</pop>
 		<pop>
@@ -58,28 +58,57 @@ module CSD
 				Client6
 			</desc>
 			<uri>
-				sip:client6@carenet-se.se
+				client6@carenet-se.se
 			</uri>
 		</pop>
 	</contact>
 	<contact>
 		<name>
-			Carenet-SE
+			Virtual Rooms
 		</name>
 		<pop>
 			<desc>
-				Multiparty Conference Room
+				Carenet-SE MCU
+			</desc>
+			<uri>
+				mcu@carenet-se.se
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				CESNET MCU
+			</desc>
+			<uri>
+				950087999@cesnet.cz
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				TTA MCU
 			</desc>
 			<uri>
-				sip:mcu@carenet-se.se
+			ttamcu@carenet-se.se
 			</uri>
 		</pop>
+	</contact>
+	<contact>
+		<name>
+			Carenet-SE
+		</name>
 		<pop>
 			<desc>
 				Carenet Support Hotline
 			</desc>
 			<uri>
-				sip:uri@carenet-se.se
+				support@carenet-se.se
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				SIP test account
+			</desc>
+			<uri>
+				test@carenet-se.se
 			</uri>
 		</pop>
 	</contact>
@@ -92,7 +121,7 @@ module CSD
 				Tandberg Client1
 			</desc>
 			<uri>
-				sip:tandberg1@carenet-se.se
+				tandberg1@carenet-se.se
 			</uri>
 		</pop>
 		<pop>
@@ -100,7 +129,7 @@ module CSD
 				Tandberg Client2
 			</desc>
 			<uri>
-				sip:tandberg2@carenet-se.se
+				tandberg2@carenet-se.se
 			</uri>
 		</pop>
 	</contact>