csd 0.3.0 → 0.3.1

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

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

@@ -29,6 +29,17 @@ module CSD
           cleanup_working_directory
         end
         
+        # This method is to provide general introductions to users, like current working directory.
+        # 
+        # ====Options
+        # [debug]  If debug option is set, users will be notified about system platform and current working module.
+        # [help]   If help option is set, AI will provide all help information and cleanup in case the working directory was temporary and is empty.
+        # [reveal] If reveal option is set, AI will continue and process the next method.
+        # [yes]    If yes option is set, AI will continue and process the next method.
+        # 
+        # If users did not specify any option, AI will ask for their willingness to continue and process the next method 
+        # after the users choose 'yes'. Or AI will terminate its operation.
+        # 
         def introduction
           UI.info " Working directory:       ".green.bold + Path.work.to_s.yellow
           if Options.debug
@@ -77,6 +88,11 @@ module CSD
           Cmd.run('lspci | grep VGA', :internal => true).output
         end
         
+        # The method is to check out ATI radeon driver from git repository and execute the shell script.
+        #
+        # * It will allow the script to be run as a program, Because  Linux system will not grant this permission to shell script for security reason.
+        # * The method will ask for users' approval before initiate the shell script.
+        #
         def install_radeon
           Cmd.git_clone 'drivers for ATI radeon', 'git://github.com/csd/ati.git', Path.radeon
           Cmd.run "chmod +x #{Path.radeon_run}", :announce_pwd => false
@@ -84,6 +100,14 @@ module CSD
           Cmd.run "sh #{Path.radeon_run}", :announce_pwd => false
         end
         
+        # The method is to check installation environment and initiate installation method of GeForce.
+        # The installation process of GeForce driver need to update users' X configuration, so AI is suppose to
+        # turn off X server before initiating the installation procedure of GeForce driver.
+        # ==== X server status
+        #
+        # [X server is running] AI will terminate X server, but this operation will also stop GNOME and AI itself. In order to continue with the installation procedure, users will start AI again from CLI.
+        # [X server has be turned off] AI will initiate the installation process, but whenever there is an error occur, AI will restart GNOME mode and clean up the working directory.
+        #
         def install_geforce
           if xserver_running? or Options.reveal
             UI.separator
@@ -103,11 +127,30 @@ module CSD
           end
         end
         
+        # The method is to check X server status.
+        # ====Returns
+        # * +true+ if X server is running
+        # * +false+ if X server is not running
+        #
         def xserver_running?
           result = Cmd.run('ps -ef', :internal => true)
           result.success? and (result.output =~ /bin\/X.+gdm/ or result.output =~ /xinit/)
         end
         
+        # The method is to check out GeForce installation script for git repository and initiate installation GUI.
+        # Currently, MiniSIP is only run on x86 systems, and GeForce driver installation is to improve the video quality
+        # of MiniSIP. Thus, before checking out GeForce installation script, AI will check the architecture of system.
+        # When it is a 64-bit system, AI will raise an error and terminate the process. While the system has a x86 architecture,
+        # AI will continue with the installation process. AI will check out the installation script from git repositoy, 
+        # and permit the script to run as a program.
+        # AI will ask for users' approval before initiate the shell script.
+        # ==== Notes
+        # we do not use Cmd.run to initiate the installation process, because the User input is not forwared to
+        # the executed application correctly. We will use Ruby's native command execution:
+        #  system "sudo #{Path.geforce_run}"
+        # instead of 
+        #  Cmd.run "sudo #{Path.geforce_run}", :announce_pwd => false, :verbose => true, :die_on_failure => false
+        #
         def install_geforce!
           raise Error::Graphics::Amd64NotSupported, "Sorry, nVIDIA GeForce is currently only supported on x86" unless Gem::Platform.local.cpu == 'x86' 
           Cmd.git_clone 'drivers for nVIDIA GeForce', 'git://github.com/csd/nvidia.git', Path.geforce
@@ -119,6 +162,9 @@ module CSD
           system "sudo #{Path.geforce_run}"
         end
         
+        # The method is to notify the user about following operation of AI and initiate the method of wait_for_confirmation,
+        # where users can choose to continue with the operation or not.
+        #
         def proprietary_continue
           UI.separator
           UI.info 'The proprietary installer for your graphic card will now be executed.'.green.bold
@@ -127,6 +173,10 @@ module CSD
           wait_for_confirmation
         end
         
+        # The method is to provide necessary tips for users to install GeForce. Because users need to allow GeForce to 
+        # update X configuration in the installation wizard and restart the system to make all changes take effect.
+        # The method will also initiate the method of wait_for_confirmation, where users can choose to continue with the operation or not.
+        #
         def proprietary_continue_for_geforce
           UI.separator
           UI.info 'The proprietary installer for your graphic card will now be executed.'.green.bold
@@ -136,6 +186,9 @@ module CSD
           wait_for_confirmation
         end
         
+        # This method is to ask users about their willingness to continue. If the user choose to continue or AI is running
+        # in reveal mode, AI will continue with its operation. Or AI will clear up the working directory and terminate the process.
+        #
         def wait_for_confirmation
            unless UI.continue? or Options.reveal
            cleanup_working_directory
@@ -143,6 +196,8 @@ module CSD
           end
         end
         
+        #This method is to define relative path in graphics module. This will make the program clean and easy to read.
+        #
         def define_relative_paths
           UI.debug "#{self.class}#define_relative_paths defines relative graphics paths now"
           Path.radeon       = Pathname.new(File.join(Path.work, 'radeon'))

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

@@ -126,6 +126,7 @@ module CSD
           Path.plugins                            = Pathname.new(File.join(Path.work, 'plugins'))
           Path.plugins_destination                = Pathname.new(File.join(Path.build_lib, 'libminisip', 'plugins'))
           Path.minisip_gnome_png                  = Pathname.new(File.join(Path.repository, 'minisip', 'share', 'icon_gnome.png'))
+          Path.minisip_gnome_png_fallback         = Pathname.new(File.join(Path.repository, 'minisip', 'share', 'minisip.png'))
           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'))

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

@@ -40,7 +40,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
+              return if Options.ffmpeg_first or !libraries.include?('libminisip') or !ffmpeg_available
               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,
@@ -88,6 +88,10 @@ module CSD
                 Cmd.cd Path.repository, :internal => true
                 Cmd.run "git checkout -b #{Options.branch} origin/#{Options.branch}"
               end
+              UI.info "Initializing any optional git submodules".green.bold
+              Cmd.cd Path.repository, :internal => true
+              Cmd.run 'git submodule init'
+              Cmd.run 'git submodule update'
             end
             
             # Some places in the MiniSIP source code have to be modified before MiniSIP can be compiled.
@@ -108,11 +112,12 @@ module CSD
               UI.info "Fixing MiniSIP OpenGL GUI source code".green.bold
               # Replacing the hardcoded path in the OpenGLDisplay.cxx
               Cmd.replace Path.repository_open_gl_display, /\tstring path = "(.+)"\+/, %{\tstring path = "#{Path.build}"+}
+              UI.info "Modifying default MiniSIP configuration parameters".green.bold
               # Removing the default SIP proxy server from the Configuration generator
               Cmd.replace Path.repository_sip_conf, 'sip.domain.example', ''
-              # 
-              
-              # Making 
+              # We would like decklink to be the default video device
+              Cmd.replace Path.repository_sip_conf, 'be->commit();', %{be->save("video_device", "decklink:0/720p50@25");be->commit();}
+              # Making
               if Options.ffmpeg_first
                 UI.info "Fixing MiniSIP Audio/Video en/decoder source code".green.bold
                 Cmd.replace Path.repository_avcoder_cxx,   'PIX_FMT_RGBA32', 'PIX_FMT_RGB32'

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

@@ -39,7 +39,10 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
               # So we do not return here now
               # return if Path.minisip_gnome_pixmap.file? and Path.minisip_desktop_entry.file?
               UI.info "Installing Gnome menu item".green.bold
-              Cmd.run("sudo cp #{Path.minisip_gnome_png} #{Path.minisip_gnome_pixmap}", :announce_pwd => false)
+              # It might be that the requested branch does not have the new gnome_icon.png in minisip/share
+              # That's why we have to use the default logo as a fallback solution
+              Path.usable_gnome_png = Path.minisip_gnome_png.file? ? Path.minisip_gnome_png : Path.minisip_gnome_png_fallback
+              Cmd.run "sudo cp #{Path.usable_gnome_png} #{Path.minisip_gnome_pixmap}", :announce_pwd => false
               Path.new_desktop_entry = Pathname.new File.join(Path.work, 'minisip.desktop')
               Cmd.touch_and_replace_content Path.new_desktop_entry, DESKTOP_ENTRY, :internal => true
               Cmd.run "sudo mv #{Path.new_desktop_entry} #{Path.minisip_desktop_entry}", :announce_pwd => false

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

@@ -2,7 +2,7 @@ self.this_user = false
 self.apt_get = true
 self.ffmpeg_first = false
 self.github_tar = false
-self.branch = nil
+self.branch = 'edge'
 self.bootstrap = true
 self.configure = true
 self.make = true

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

@@ -5,7 +5,8 @@ module CSD
   module Application
     module Mslog
       class Base < CSD::Application::Base
-        
+
+        # Necessary contents for MSLog .desktop file. It will be used in the method of create_desktop_entry.
                 DESKTOP_ENTRY = %{
 [Desktop Entry]
 Encoding=UTF-8
@@ -23,6 +24,9 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
         #
         DEBIAN_DEPENDENCIES = %w{ ant openjdk-6-jre openjdk-6-jdk libnotify-bin }
         
+        # The method is to notify users about following operation of AI, and initiate introduction method.
+        # The actual installation process is carried out by method install! for the purpose of keeping source code clean.
+        #
         def install
           UI.separator
           UI.info "This operation will install the logging server of MiniSIP.".green.bold
@@ -31,6 +35,10 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           install!
         end
         
+        # The method is to set up logging server by initiate corresponding method. Its major operation includes
+        # install library dependencies, download and install logging server, create a desktop entry for logging server.
+        # Thus users can start the logging server by simply clicking the MSLog button in the Applications menu.
+        #
         def install!
           create_working_directory
           define_relative_paths
@@ -42,6 +50,22 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           congratulations
         end
         
+        # This method is to provide general introductions to users, like current working directory.
+        # 
+        # ====Options
+        # [debug]  If debug option is set, users will be notified about system platform and current working module.
+        # [help]   If help option is set, AI will provide all help information and cleanup.
+        # [reveal] If reveal option is set, AI will continue and process the next method.
+        # [yes]    If yes option is set, AI will continue and process the next method.
+        # 
+        # If users did not specify any option, AI will ask for their willingness to continue and process the next method 
+        # after the users choose 'yes'. Or AI will terminate its operation.
+        # 
+        # ====Notes
+        # In mslog module the options of temp and work_dir will be turned off by default. The reason of doing that is because
+        # the minisip-logging-server directory and its content is needed to run the logging server. Thus AI is not going to 
+        # use temp directory to process the source code or clean up the working directory after installation procedure.
+        # 
         def introduction
           UI.info " Working directory:       ".green.bold + Path.work.to_s.yellow
           if Options.debug
@@ -57,6 +81,8 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           end
         end
         
+        #
+        #
         def apt_get
           UI.info "Updating the package index".green.bold
           Cmd.run "sudo apt-get update --yes --force-yes", :announce_pwd => false

data/lib/csd/options_parser.rb

@@ -155,16 +155,16 @@ module CSD
         opts.on("-e", "--verbose","Show more elaborate output") do |value|
           self.verbose = value
         end
-        opts.on("-d", "--debug","Show more elaborate output and debugging information about the AI") do |value|
+        opts.on("-d", "--debug","Show debugging information about the AI") do |value|
           self.debug = value
         end
         opts.on("-s", "--silent","Don't show any output") do |value|
           self.silent = value
         end
-        opts.on_tail("-a", "--developer", "Show information only relevant to AI and MiniSIP developers") do |value|
+        opts.on_tail("-a", "--developer", "Show information only relevant to software developers") do |value|
           self.developer = value
         end
-        opts.on_tail("-h", "--help", "Show detailed help (regarding the given ACTION and APPLICATION)") do |value|
+        opts.on_tail("-h", "--help", "Show detailed help (regarding the given TASK and APPLICATION)") do |value|
           self.help = value
         end
         opts.on_tail("-v", "--version", "Show the version of this AI") do

data/test/application/test_minisip.rb

@@ -82,6 +82,7 @@ class TestMinisip < Test::Unit::TestCase
         end
         
         should "know how to checkout the default branch of the source code" do
+          Options.branch = nil
           out, err = capture { Core.checkout }
           assert_match /git clone /, out
           assert_no_match /git pull/, out

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csd
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Technology Transfer Alliance Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-07 00:00:00 +02:00
+date: 2010-09-08 00:00:00 +02:00
 default_executable: 
 dependencies: []