csd 0.3.3 → 0.3.4

data/Rakefile

@@ -31,14 +31,14 @@ Jeweler::Tasks.new do |gemspec|
 
   Thank you for installing the TTA Automated Installer!
 
-  You can run it by typing `ai´ in your command line.
-
   NOTE: On DEBIAN and UBUNTU the executable `ai´ is *maybe*
         not in your PATH by default. If that is the case,
         you can fix it by running this command:
 
   echo "export PATH=\$PATH:$(gem env | grep "E D" | sed "s/[^\w]* //")" >> ~/.bashrc;. ~/.bashrc
 
+  You can run the AI by typing `ai´ in your command line.
+
 ============================================================
 }
 end

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

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

@@ -25,10 +25,17 @@ module CSD
         def install!
           define_relative_paths
           create_working_directory
+          aptitude
           process_graphics_card
           cleanup_working_directory
         end
         
+        def aptitude
+          UI.info "Installing Debian dependencies".green.bold
+          Cmd.run 'sudo apt-get update', :announce_pwd => false
+          Cmd.run "sudo apt-get install git-core --yes --fix-missing", :announce_pwd => false
+        end
+        
         # This method is to provide general introductions to users, like current working directory.
         # 
         # ====Options

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

@@ -8,8 +8,13 @@ module CSD
     module I2conf
       class Base < CSD::Application::Base
         
+        # This is to include MiniSIP component class, since MiniSIP need to be compiled before i2conf compilation.
+        # Thus, in the i2conf module AI will load methods in MiniSIP component class directly to compile MiniSIP.
+        #
         include ::CSD::Application::Minisip::Component
         
+        # Necessary contents for i2conf .desktop file. It will be used in the method of create_desktop_entry.
+        # 
         DESKTOP_ENTRY = %{
 [Desktop Entry]
 Encoding=UTF-8
@@ -23,12 +28,17 @@ Type=Application
 StartupNotify=true
 Categories=Application;Internet;Network;Chat;AudioVideo}
         
+        # This constant is to preserve the URL of the i2conf icon in github repository.
+        #
         GNOME_ICON_URL = 'http://github.com/downloads/csd/i2conf/i2conf_gnome.png'
         
         # A list of apt-get packages that are required to install i2conf.
         #
         DEBIAN_DEPENDENCIES = %w{ libboost-dev libboost-thread-dev liblog4cxx* }
         
+        # This method notifies users about following operation of AI, and initiates introduction method.
+        # The actual installation process is carried out by method install! for the purpose of keeping source code clean.
+        # 
         def install
           @minisip = ::CSD::Application::Minisip::Debian.new
           define_relative_paths
@@ -39,6 +49,8 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           install!
         end
         
+        # This method initiates corresponding methods sequentially to set up i2conf server.
+        # 
         def install!
           create_working_directory
           compile_minisip
@@ -57,6 +69,11 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           congratulations
         end
         
+        # This method compiles MiniSIP. Because i2conf will make use of MiniSIP libraries during the compilation process.
+        # However, MiniSIP is compiled without any additional option during the configuration process, since full configuration
+        # options cause conflict with 64bit system, while i2conf can also be run in 64bit system. Thus this operation assures
+        # i2conf server can be set up on both 32 and 64 bits system.
+        # 
         def compile_minisip
           return unless Options.minisip
           @minisip.aptitude
@@ -72,6 +89,12 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           Core.link_libraries
         end
         
+        # This method installs all library dependencies of i2conf server.
+        # It will first update the package index and then install all Debian dependencies.
+        # AI will force the operation to continue without being interrupted by the request for user's approval
+        # This is because users have been asked once about their willingness to continue in the introduction method,
+        # thus AI will not bother users again for each of the library dependency.
+        #
         def aptitude
           return unless Options.apt_get
           UI.info "Installing Debian dependencies for i2conf".green.bold
@@ -79,10 +102,15 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           Cmd.run "sudo apt-get install #{DEBIAN_DEPENDENCIES.sort.join(' ')} --yes --fix-missing", :announce_pwd => false
         end
         
+        # The method checks out the Lib strManager source code from git repository.
+        # strManager is a high-performance UDP packet reflector with high customizing per-flow options.
+        # 
         def checkout_strmanager
           Cmd.git_clone('strManager library', 'git://github.com/csd/strManager.git', Path.str_manager)
         end
         
+        # The method copies several files in libtool to the directory of strManager to avoid libtool version mismatch.
+        #
         def copy_libtool
           UI.info 'Copying libtool dependencies'.green.bold
           Cmd.cd Path.str_manager, :internal => true
@@ -91,6 +119,8 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           Cmd.run 'cp /usr/share/libtool/config/ltmain.sh .'
         end
         
+        # The method includes header file iostream into Manager.cpp and StatsWorker.cpp in the source code.
+        #
         def fix_str_manager
           UI.info 'Fixing strManager'.green.bold
           [Path.str_src_manager, Path.str_src_worker].each do |file|
@@ -100,20 +130,29 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           end
         end
         
+        # The method compiles strManager.
+        # After compilation process, it will run ldconfig on libstrmanager.so file to help
+        # strManager to locate necessary MiniSIP libraries.
+        #
         def compile_str_manager
           UI.info 'Compiling strManager'.green.bold
           Cmd.cd Path.str_manager, :internal => true
           Cmd.run './configure'
           Cmd.run 'aclocal'
-          Cmd.run 'make'
+          Cmd.run 'make -j 15'
           Cmd.run 'sudo make install'
           Cmd.run "sudo ldconfig /usr/local/lib/libstrmanager.so", :announce_pwd => false
         end
         
+        # The method checks out i2conf source code from git repository.
+        #
         def checkout_i2conf
           Cmd.git_clone('i2conf repository', 'git://github.com/csd/i2conf.git', Path.i2conf)
         end
         
+        # The method fixes i2conf source code. The bootstrap file of i2conf only specifies automake version from 1.7 to 1.10.
+        # AI will include the latest version 1.11 into its support list.
+        # 
         def fix_i2conf
           if Options.reveal or !File.read(Path.i2conf_bootstrap).include?('automake-1.11')
             UI.info 'Fixing i2conf automake'.green.bold
@@ -121,6 +160,8 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           end
         end
         
+        # The method fixes i2conf aclocal by removing aclocal option "-I m4".
+        #
         def fix_i2conf_aclocal
           if Options.reveal or File.read(Path.i2conf_bootstrap).include?('-I m4')
             UI.info 'Fixing i2conf aclocal'.green.bold
@@ -128,16 +169,24 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           end
         end
         
+        # The method compiles i2conf with standard process and without any additional option setting.
+        #
         def compile_i2conf
           UI.info 'Compiling i2conf'.green.bold
           Cmd.cd Path.i2conf, :internal => true
           Cmd.run './bootstrap'
           Cmd.run './configure'
           Cmd.run 'aclocal'
-          Cmd.run 'make'
+          Cmd.run 'make -j 15'
           Cmd.run 'sudo make install'
         end
         
+        # This method creates desktop entry, so users can run MCU by clicking the i2conf icon in the Applications menu.
+        # It copies the downloaded icon to pixmaps directory, so the icon can be shown at the gnome menu. 
+        # It creates a .desktop file, fulfills the file with the constant DESKTOP_ENTRY, and substitutes the PLACEHOLDER with execution commands. 
+        # Then, AI copies the .desktop file to /usr/share/applications directory and initiates the method of update_gnome_menu_cache to make all the
+        # modifications take effect. It will also updates gnome menu cache after placing every file into the right place.
+        #
         def create_desktop_entry
           UI.info "Installing Gnome menu item".green.bold
           if Cmd.download(GNOME_ICON_URL, Path.i2conf_gnome_png).success?
@@ -149,7 +198,9 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
             UI.warn "The menu item could not be created, because the image file could not be downloaded from #{GNOME_ICON_URL}.".green.bold
           end
         end
-                
+        
+        # The method creates a minimum configuration file for i2conf if it is not available.
+        # This configuration is based on 
         def configure_i2conf
           if Path.i2conf_example_conf.file?
             UI.warn "Creating no example configuration file, because it already exists: #{Path.i2conf_example_conf}. "
@@ -158,7 +209,11 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
             Cmd.touch_and_replace_content Path.i2conf_example_conf, ::CSD::Application::I2conf::CONFIG_EXAMPLE
           end
         end
-
+        
+        # This method notifies users that i2conf installation process is completed successfully.
+        # This notification will be shown on the top right of the desktop in Ubuntu system.
+        # Users can then start i2conf by clicking the icon in gnome menu.
+        #
         def send_notification
           Cmd.run %{notify-send --icon=i2conf_gnome "I2conf installation complete" "You are now ready to use your SIP MCU." }, :internal => true, :die_on_failure => false
         end

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

@@ -4,6 +4,10 @@ module CSD
   module Application
     module I2conf
       
+      # This constant defines the example configuration contents for the i2conf server.
+      # This configuration is based on the current running carenet-se service, while users can 
+      # modify the configuration manually by applying their own network service parameter.
+      #
       CONFIG_EXAMPLE = %{
 <interface>eth0</interface>
 <use_udp>true</use_udp>

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

@@ -144,6 +144,8 @@ module CSD
           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'))
+          Path.catalyst_config                    = Pathname.new(File.join('/', 'etc', 'ati', 'amdpcsdb'))
+          Path.new_catalyst_config                = Pathname.new(File.join(Path.work, 'amdpcsdb'))
         end
         
       end

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

@@ -1,5 +1,4 @@
 # -*- encoding: UTF-8 -*-
-require 'csd/application/minisip/component/core_packaging'
 require 'csd/application/minisip/component/core'
 require 'csd/application/minisip/component/ffmpeg'
 require 'csd/application/minisip/component/gnome'

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

@@ -1,5 +1,6 @@
 # -*- encoding: UTF-8 -*-
 require 'csd/application/minisip/phonebook_example'
+require 'csd/application/minisip/component/core_packaging'
 
 module CSD
   module Application
@@ -19,6 +20,8 @@ module CSD
           
           class << self
             
+            include Packaging
+
             # This method processes the MiniSIP Core component and does everything needed for compiling it. Note that
             # it is not responsible for checking depenencies here. It will just focus on compiling the internal MiniSIP libraries.
             #
@@ -36,10 +39,7 @@ module CSD
               compile_libraries # We would like to re-compile MiniSIP no matter what options were given as command-line arguments.
               link_libraries
               create_address_book
-            end
-            
-            def package!
-              Packaging.package!
+              ensure_ati_vsync
             end
             
             def remove_ffmpeg
@@ -87,6 +87,8 @@ module CSD
             # by an TTA AI developer, after having made sure that that source code version is working properly.
             #
             def checkout
+              # The untested version from the vendor was requested
+              return checkout_from_vendor if Options.vendor
               Cmd.git_clone 'MiniSIP repository', 'http://github.com/csd/minisip.git', Path.repository
               # Note that the command above will checkout the master branch.
               # In that case we are not allowed to checkout the master branch again.
@@ -100,6 +102,11 @@ module CSD
               Cmd.run 'git submodule update'
             end
             
+            def checkout_from_vendor
+              Cmd.cd Path.work, :internal => true
+              Cmd.run "svn checkout svn://svn.minisip.org/minisip/trunk minisip"
+            end
+            
             # Some places in the MiniSIP source code have to be modified before MiniSIP can be compiled.
             # * An absolute path must be replaced with the current absolute prefix path in
             #   <tt>libminisip/source/subsystem_media/video/display/OpenGLDisplay.cxx</tt>
@@ -234,13 +241,13 @@ module CSD
                   ''
               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' : ''
+              debug_options = '--enable-debug' if Options.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}"} : ''
+              common_options = %Q{--prefix="#{Path.build}" PKG_CONFIG_PATH="#{Path.build_lib_pkg_config}" ACLOCAL_FLAGS="#{Path.build_share_aclocal}" LD_LIBRARY_PATH="#{Path.build_lib}"} if Options.this_user
               # I2conf needs to compile MiniSIP without any options
-              individual_options = '' if Options.blank_minisip_configuration
+              individual_options = nil if Options.blank_minisip_configuration
               # Putting it all together
-              Cmd.run ['./configure', common_options, debug_options, individual_options].join(' ')
+              Cmd.run ['./configure', common_options, debug_options, individual_options].compact.join(' ')
             end
             
             def make
@@ -248,7 +255,7 @@ module CSD
             end
             
             def make!
-              Cmd.run("make")
+              Cmd.run("make -j 15")
             end
             
             def make_install
@@ -282,6 +289,26 @@ module CSD
               UI.info "  Phonebook successfully saved in #{Path.phonebook}".yellow
             end
             
+            # This method is agreeably a little bit out of place. Because this technically should happen whenever
+            # the graphic card drivers are installed and not when MiniSIP is installed. However, the AI is not present
+            # when the graphic card drivers are installed (because then X11 is booted down and the AI process is
+            # replaced by the proprietary ATI or nVidia installation process). So we better make sure at this point,
+            # that the vertical synching for ATI graphic cards is switched on.
+            #
+            # The reason why we want this is because otherwise we will have vertical lines in the video. It is commonly
+            # referred to as "teared images" and is caused by the monitor having a Hertz rate of 60Hz, while OpenGL has
+            # a rate of about 400Hz. So the screen picture might be refreshed by OpenGL *while* the monitor is doing his
+            # own refresh. This will result in a horizontal line on the screen. When they are synchronized, OpenGL will
+            # be reduced to about 59Hz and the video will be clear. This information was obtained by Erik, the vendor
+            # of MiniSIP.
+            #
+            def ensure_ati_vsync
+              # Return if no ATI drivers are installed
+              return unless Path.catalyst_config.file?
+              UI.info "Ensuring AMD vertical synchronization between OpenGL and Monitor".green.bold
+              Cmd.run "sudo aticonfig --set-pcs-u32=BUSID-2:0:0-0/OpenGL,VSyncControl,2", :announce_pwd => false
+            end
+            
           end
         end
       end

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

@@ -14,46 +14,71 @@ module CSD
             # TODO: Refactor this, it looks terribly sensitive.
             # TODO: Check for GPL and LGLP license conflicts.
             #
-            def package!
+            def package
+              UI.separator
+              UI.info "This operation will make debian packages for all MiniSIP libraries.".green.bold
+              UI.separator
+              packing_introduction
               Cmd.mkdir Path.packaging
               libraries.each do |library|
-                directory = Pathname.new(File.join(Path.repository, library))
+                @library = library
+                @directory = Pathname.new(File.join(Path.repository, library))
                 next if Options.only and !Options.only.include?(library)
-                UI.info "Making #{library} with target dist".green.bold
-                if Cmd.cd(directory) or Options.reveal
-                  Cmd.run("make dist")
-                  
-                  tar_filename = File.basename(Dir[File.join(directory, '*.tar.gz')].first)
-                  Cmd.move(File.join(directory, tar_filename.to_s), Path.packaging) if tar_filename or Options.reveal
-                  
-                  if Cmd.cd(Path.packaging) or Options.reveal
-                    Cmd.run("tar -xzf #{tar_filename}")
-                    tar_dirname = File.basename(tar_filename.to_s, '.tar.gz')
-                    if Cmd.cd(File.join(Path.packaging, tar_dirname))
-                      Cmd.run("dpkg-buildpackage -rfakeroot")
-                      if library == 'minisip'
-                        if Cmd.cd(Path.packaging)
-                          package = File.basename(Dir[File.join(Path.packaging, "#{library}*.deb")].first)
-                          Cmd.run("sudo dpkg -i #{package}") if package or Options.reveal
-                        end
-                      else
-                        if Cmd.cd(Path.packaging)
-                          package = File.basename(Dir[File.join(Path.packaging, "#{library}0*.deb")].first)
-                          Cmd.run("sudo dpkg -i #{package}") if package or Options.reveal
-                          dev_package = File.basename(Dir[File.join(Path.packaging, "#{library}-dev*.deb")].first)
-                          Cmd.run("sudo dpkg -i #{dev_package}") if dev_package or Options.reveal
-                        end
-                      end
-                    else
-                      UI.error "Could not enter #{File.join(Path.packaging, tar_dirname)}."
-                    end
-                    
-                  else
-                    UI.error "Could not enter #{Path.packaging}."
-                  end
-                  
-                else
-                  UI.error "Could not enter #{directory}."
+                package!
+              end
+            end
+            
+            def packing_introduction
+              UI.info " Working directory:       ".green.bold + Path.work.to_s.yellow
+              unless Path.repository.directory?
+                UI.warn "#{::CSD.executable} install minisip --no-temp"
+                raise Error::Minisip::Core::PackagingNeedsInstalledMinisip
+              end
+              UI.separator
+              if Options.help
+                UI.info Options.helptext
+                # Cleanup in case the working directory was temporary and is empty
+                Path.work.rmdir if Options.temp and Path.work.directory? and Path.work.children.empty?
+                raise CSD::Error::Argument::HelpWasRequested
+              else
+                raise Interrupt unless Options.yes or Options.reveal or UI.continue?
+              end
+            end
+        
+            def package!
+              make_dist
+              extract_tar_file
+              build_package
+            end
+            
+            def make_dist
+              UI.info "Making #{@library} with target dist".green.bold
+              Cmd.cd(@directory) or Options.reveal
+              Cmd.run("make dist")
+              @tar_filename = File.basename(Dir[File.join(@directory, '*.tar.gz')].first)
+              Cmd.move(File.join(@directory, @tar_filename.to_s), Path.packaging) if @tar_filename or Options.reveal
+            end
+            
+            def extract_tar_file
+              Cmd.cd(Path.packaging) or Options.reveal
+              Cmd.run("tar -xzf #{@tar_filename}")
+              @tar_dirname = File.basename(@tar_filename.to_s, '.tar.gz')
+            end
+              
+            def build_package
+              Cmd.cd(File.join(Path.packaging, @tar_dirname))
+              Cmd.run("dpkg-buildpackage -rfakeroot")
+              if @library == 'minisip'
+                if Cmd.cd(Path.packaging)
+                  package = File.basename(Dir[File.join(Path.packaging, "#{@library}*.deb")].first)
+                  Cmd.run("sudo dpkg -i #{package}") if package or Options.reveal
+                end
+              else
+                if Cmd.cd(Path.packaging)
+                  package = File.basename(Dir[File.join(Path.packaging, "#{@library}0*.deb")].first)
+                  Cmd.run("sudo dpkg -i #{package}") if package or Options.reveal
+                  dev_package = File.basename(Dir[File.join(Path.packaging, "#{@library}-dev*.deb")].first)
+                  Cmd.run("sudo dpkg -i #{dev_package}") if dev_package or Options.reveal
                 end
               end
             end
@@ -63,4 +88,4 @@ module CSD
       end
     end
   end
-end
+end

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

@@ -65,7 +65,7 @@ module CSD
               UI.info "Compiling and installing FFmpeg".green.bold
               Cmd.cd Path.ffmpeg_repository, :internal => true
               Cmd.run("#{c_flags} ./configure --enable-gpl --enable-libx264 --enable-x11grab")
-              Cmd.run('make')
+              Cmd.run('make -j 15')
               Cmd.run('sudo checkinstall --pkgname=ffmpeg --pkgversion "99:-`git log -1 --pretty=format:%h`" --backup=no --default')
             end
             

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

@@ -36,9 +36,9 @@ module CSD
               UI.info "Compiling HDVIPER".green.bold
               Cmd.cd Path.hdviper_x264, :internal => true
               Cmd.run('./configure')
-              Cmd.run('make')
+              Cmd.run('make -j 15')
               Cmd.cd Path.hdviper_x264_test_x264api, :internal => true
-              Cmd.run('make')
+              Cmd.run('make -j 15')
             end
           
           end

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

@@ -7,6 +7,10 @@ module CSD
         module Network
           class << self
             
+            # These IP stack buffer values have been identified as optimal by the Master Thesis students.
+            # Feel free to experiment around with other values. Erik suspects that they might have to be
+            # higher than this.
+            #
             OPTIMUM_BUFFERS = {
               'net.core.rmem_max'     => '131071',
               'net.core.wmem_max'     => '131071',

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

@@ -30,7 +30,7 @@ module CSD
               UI.info "Compiling and installing x264".green.bold
               Cmd.cd Path.x264_repository, :internal => true
               Cmd.run('./configure')
-              Cmd.run('make')
+              Cmd.run('make -j 15')
               Cmd.run('sudo checkinstall --pkgname=x264 --pkgversion "99:-`git log -1 --pretty=format:%h`" --backup=no --default')
             end
             

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

@@ -12,6 +12,7 @@ module CSD
       
       module Core
         class FFmpegInstalled < CSDError; status_code(210); end
+        class PackagingNeedsInstalledMinisip < CSDError; status_code(220); end
       end
       
     end

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

@@ -17,6 +17,10 @@ opts.on("--github-tar","Instead of fetching git repositories from Github, use ta
   self.github_tar = value
 end
 
+opts.on("--vendor","Use the latest, untested version from the vendor's repository (SVN) instead of Github") do |value|
+  self.vendor = value
+end
+
 opts.on('--branch BRANCH', 'Choose another branch than `master´ when downloading the source code') do |value|
   self.branch = value
 end

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

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

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

@@ -40,10 +40,7 @@ module CSD
         # This method is called by the AI when the user requests the task "package" for MiniSIP.
         #
         def package
-          UI.separator
-          UI.info("This operation will package ".green.bold + "an already compiled".red.bold + " MiniSIP.".green.bold)
-          introduction
-          package!
+          Core.package
         end
         
         # This is the internal compile procedure for MiniSIP and its components.

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

@@ -24,7 +24,7 @@ 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.
+        # This method notifies users about following operation of AI, and initiates introduction method.
         # The actual installation process is carried out by method install! for the purpose of keeping source code clean.
         #
         def install
@@ -35,7 +35,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           install!
         end
         
-        # The method is to set up logging server by initiate corresponding method. Its major operation includes
+        # This method sets 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.
         #
@@ -50,7 +50,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           congratulations
         end
         
-        # This method is to provide general introductions to users, like current working directory.
+        # This method provides 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.
@@ -81,7 +81,11 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           end
         end
         
-        #
+        # This method installs all library dependencies of MiniSIP logging server.
+        # It will first update the package index and then install all Debian dependencies.
+        # AI will force both of the operations continue without being interrupted by the request for user's approval
+        # This is because users have been asked once about their willingness to continue in the introduction method,
+        # thus AI will not bother users again for each of the library dependency.
         #
         def apt_get
           UI.info "Updating the package index".green.bold
@@ -89,16 +93,29 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           UI.info "Installing Debian packages".green.bold
           Cmd.run "sudo apt-get install #{DEBIAN_DEPENDENCIES.join(' ')} --yes --force-yes", :announce_pwd => false
         end
-
+        
+        # The method is to check out MiniSIP source code from git repository and place it into the current working directory.
+        #
         def download
           Cmd.git_clone 'Source code of logging server', 'git://github.com/csd/minisip-logging-server.git', Path.packages
         end
         
+        # This method compiles Java source code.
+        # It will set the constant JAVA_HOME to the value of '/usr', since Java is required when running logging server.
+        # It will also write the constant into bashrc file, so the constant will be set every time when the system boot up.
+        # However, the bashrc file cannot be reloaded systemwide from within the AI.
+        # As a workaround we derive the JAVA_HOME constant manually by the command
+        #  ENV['JAVA_HOME'] = '/usr'
+        # instead of using the '.'-command
+        #  Cmd.run ". ~/.bashrc"
+        # Then, AI will compile the Java source code by +ant+ command and give execution permissions to logging server shell scripts.
+        # AI will not execute the executable. User can start the logging server by clicking MSLog icon in the Applications menu.
+        #
         def process
           Cmd.cd Path.packages, :internal => true
           Cmd.run %{echo "export JAVA_HOME=/usr" >> ~/.bashrc} unless File.read(Path.bashrc) =~ /JAVA_HOME/
           # For some reason the bashrc file cannot be reloaded systemwide from within the AI.
-          # As a workaround we devine the JAVA_HOME constant manually instead of using the '.'-command
+          # As a workaround we derive the JAVA_HOME constant manually instead of using the '.'-command
           # Cmd.run ". ~/.bashrc"
           ENV['JAVA_HOME'] = '/usr'
           # Compiling the Java source code
@@ -107,6 +124,12 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           Cmd.run "chmod +x #{Path.logging_server_run}", :announce_pwd => false
         end
         
+        # This method creates desktop entry, so users can run logging server by clicking the MSLog icon in the Applications menu.
+        # It copies the downloaded icon to pixmaps directory, so the icon can be shown at the gnome menu. 
+        # It creates a .desktop file, fulfills the file with the constant DESKTOP_ENTRY, and substitutes the PLACEHOLDER with execution commands. 
+        # Then, AI copies the .desktop file to /usr/share/applications directory and initiates the method of update_gnome_menu_cache to make all the
+        # modifications take effect.
+        #
         def create_desktop_entry
           UI.info "Installing Gnome menu item".green.bold
           Cmd.run("sudo cp #{Path.mslog_gnome_png} #{Path.mslog_gnome_pixmap}", :announce_pwd => false)
@@ -115,16 +138,27 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           update_gnome_menu_cache
         end
         
+        # This method updates gnome menu cache. It first updates the gnome menus cash, so the icon can be shown
+        # in the menu bar. It then gives the MSLog .desktop file a root privilege for security reasons.
+        # 
         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
           Cmd.run "sudo chown root:root #{Path.mslog_desktop_entry}", :announce_pwd => false
         end
         
+        # This method notifies users that MiniSIP Logging Server installation process is completed successfully.
+        # This notification will be shown on the top right of the desktop in Ubuntu system.
+        # Users can then start MiniSIP Logging Server by clicking the icon in gnome menu.
+        #
         def send_notification
           Cmd.run %{notify-send --icon=mslog_gnome "MiniSIP Logging Server installation complete" "You are now ready to use your logging server." }, :internal => true, :die_on_failure => false
         end
         
+        # This method notifies users that MiniSIP Logging Server installation process is completed successfully.
+        # It is AI's internal notification, which will be shown on the command line interface.
+        # Users can then start MiniSIP Logging Server by clicking the icon in gnome menu.
+        # 
         def congratulations
           UI.separator
           UI.info "        MiniSIP Logging Server installation complete.".green.bold
@@ -132,6 +166,11 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           UI.separator
         end
         
+        # This method is to define relative path in mslog module. This will make the program clean and easy to read.
+        # ====Notes
+        # In the Path.bashrc constant, we use ENV['HOME'] to locate the bashrc file, because the '~/.bashrc' representation
+        # can only be accepted by Linux system, while Ruby considers it as an invalid path representation.
+        # 
         def define_relative_paths
           Path.packages                 = Pathname.new(File.join(Path.work, 'minisip-logging-server'))
           Path.bin                      = Pathname.new(File.join(Path.packages, 'bin'))

data/test/application/test_minisip.rb

@@ -146,8 +146,9 @@ class TestMinisip < Test::Unit::TestCase
           Options.debug = true
           Options.enable_debug = true
           out, err = capture { Core.compile_libraries }
+          # We will check or the flag before and after the milestone to go sure it's everywhere
           assert_match /MILESTONE_processing_libminisip.+\-\-enable\-debug.+MILESTONE_processing_minisip.+\-\-enable\-debug/m, out
-          assert_no_match /\-\-enable\-debug.+MILESTONE_processing_libminisip/m, out
+          assert_match /\-\-enable\-debug.+MILESTONE_processing_libminisip/m, out
         end
         
       end # context "in theory when compiling"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csd
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Technology Transfer Alliance Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-10 00:00:00 +02:00
+date: 2010-09-17 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -37,7 +37,30 @@ files:
 - VERSION
 - bin/ai
 - bin/ttai
-- csd.gemspec
+- img/3d1.png
+- img/bios0.jpg
+- img/bios1.jpg
+- img/bios2.jpg
+- img/camera1.jpg
+- img/camera2.jpg
+- img/decklink1.png
+- img/decklink2.png
+- img/graphics1.png
+- img/graphics2.png
+- img/graphics3.png
+- img/graphics4.png
+- img/graphics5.png
+- img/installer1.jpg
+- img/installer2.jpg
+- img/installer3.jpg
+- img/minisip1.png
+- img/reboot.png
+- img/ruby1.png
+- img/ruby2.png
+- img/ruby3.png
+- img/ruby4.png
+- img/update1.png
+- img/update2.png
 - lib/csd.rb
 - lib/csd/application.rb
 - lib/csd/application/decklink.rb
@@ -140,7 +163,7 @@ homepage: http://github.com/csd/csd
 licenses: []
 
 post_install_message: "\n\
-  ============================================================\n\n  Thank you for installing the TTA Automated Installer!\n\n  You can run it by typing `ai\xC2\xB4 in your command line.\n\n  NOTE: On DEBIAN and UBUNTU the executable `ai\xC2\xB4 is *maybe*\n        not in your PATH by default. If that is the case,\n        you can fix it by running this command:\n\n  echo \"export PATH=\\$PATH:$(gem env | grep \"E D\" | sed \"s/[^\\w]* //\")\" >> ~/.bashrc;. ~/.bashrc\n\n\
+  ============================================================\n\n  Thank you for installing the TTA Automated Installer!\n\n  NOTE: On DEBIAN and UBUNTU the executable `ai\xC2\xB4 is *maybe*\n        not in your PATH by default. If that is the case,\n        you can fix it by running this command:\n\n  echo \"export PATH=\\$PATH:$(gem env | grep \"E D\" | sed \"s/[^\\w]* //\")\" >> ~/.bashrc;. ~/.bashrc\n\n  You can run the AI by typing `ai\xC2\xB4 in your command line.\n\n\
   ============================================================\n"
 rdoc_options: 
 - --charset=UTF-8

data/csd.gemspec

@@ -1,175 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{csd}
-  s.version = "0.3.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Technology Transfer Alliance Team"]
-  s.date = %q{2010-09-10}
-  s.description = %q{CSD stands for Communication Systems Design and is a project of the Telecommunication Systems Laboratory (TSLab) of the Royal Institute of Technology in Stockholm, Sweden. Within CSD many software tools are used to build up various networks and services. This gem is supposed to automate processes to handle the compilation and installation of these software tools. Technology Transfer Alliance (TTA) is the project team, which maintains this code.}
-  s.email = %q{mtoday11@gmail.com}
-  s.executables = ["ai", "ttai"]
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "COPYING",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/ai",
-     "bin/ttai",
-     "csd.gemspec",
-     "lib/csd.rb",
-     "lib/csd/application.rb",
-     "lib/csd/application/decklink.rb",
-     "lib/csd/application/decklink/about.yml",
-     "lib/csd/application/decklink/base.rb",
-     "lib/csd/application/decklink/options/common.rb",
-     "lib/csd/application/decklink/options/common_defaults.rb",
-     "lib/csd/application/default.rb",
-     "lib/csd/application/default/base.rb",
-     "lib/csd/application/graphics.rb",
-     "lib/csd/application/graphics/about.yml",
-     "lib/csd/application/graphics/base.rb",
-     "lib/csd/application/graphics/error.rb",
-     "lib/csd/application/graphics/options/common.rb",
-     "lib/csd/application/graphics/options/common_defaults.rb",
-     "lib/csd/application/graphics/options/install.rb",
-     "lib/csd/application/graphics/options/install_defaults.rb",
-     "lib/csd/application/i2conf.rb",
-     "lib/csd/application/i2conf/about.yml",
-     "lib/csd/application/i2conf/base.rb",
-     "lib/csd/application/i2conf/config_example.rb",
-     "lib/csd/application/i2conf/options/common.rb",
-     "lib/csd/application/i2conf/options/common_defaults.rb",
-     "lib/csd/application/i2conf/options/install.rb",
-     "lib/csd/application/i2conf/options/install_defaults.rb",
-     "lib/csd/application/minisip.rb",
-     "lib/csd/application/minisip/about.yml",
-     "lib/csd/application/minisip/base.rb",
-     "lib/csd/application/minisip/component.rb",
-     "lib/csd/application/minisip/component/core.rb",
-     "lib/csd/application/minisip/component/core_packaging.rb",
-     "lib/csd/application/minisip/component/ffmpeg.rb",
-     "lib/csd/application/minisip/component/gnome.rb",
-     "lib/csd/application/minisip/component/hdviper.rb",
-     "lib/csd/application/minisip/component/network.rb",
-     "lib/csd/application/minisip/component/plugins.rb",
-     "lib/csd/application/minisip/component/x264.rb",
-     "lib/csd/application/minisip/error.rb",
-     "lib/csd/application/minisip/options/common.rb",
-     "lib/csd/application/minisip/options/common_defaults.rb",
-     "lib/csd/application/minisip/options/install.rb",
-     "lib/csd/application/minisip/options/install_defaults.rb",
-     "lib/csd/application/minisip/options/package.rb",
-     "lib/csd/application/minisip/options/package_defaults.rb",
-     "lib/csd/application/minisip/phonebook_example.rb",
-     "lib/csd/application/minisip/unix.rb",
-     "lib/csd/application/minisip/unix/darwin.rb",
-     "lib/csd/application/minisip/unix/linux.rb",
-     "lib/csd/application/minisip/unix/linux/debian.rb",
-     "lib/csd/application/minisip/unix/linux/debian/ubuntu10.rb",
-     "lib/csd/application/mslog.rb",
-     "lib/csd/application/mslog/about.yml",
-     "lib/csd/application/mslog/base.rb",
-     "lib/csd/application/mslog/options/common.rb",
-     "lib/csd/application/mslog/options/common_defaults.rb",
-     "lib/csd/applications.rb",
-     "lib/csd/commands.rb",
-     "lib/csd/container.rb",
-     "lib/csd/error.rb",
-     "lib/csd/extensions.rb",
-     "lib/csd/extensions/core/array.rb",
-     "lib/csd/extensions/core/dir.rb",
-     "lib/csd/extensions/core/kernel.rb",
-     "lib/csd/extensions/core/object.rb",
-     "lib/csd/extensions/core/open_struct.rb",
-     "lib/csd/extensions/core/option_parser.rb",
-     "lib/csd/extensions/core/pathname.rb",
-     "lib/csd/extensions/core/string.rb",
-     "lib/csd/extensions/gem/platform.rb",
-     "lib/csd/options_parser.rb",
-     "lib/csd/path_container.rb",
-     "lib/csd/user_interface.rb",
-     "lib/csd/user_interface/base.rb",
-     "lib/csd/user_interface/cli.rb",
-     "lib/csd/user_interface/silent.rb",
-     "lib/csd/vendor/active_support/MIT-LICENSE",
-     "lib/csd/vendor/active_support/inflector.rb",
-     "lib/csd/vendor/active_support/object_extensions.rb",
-     "lib/csd/vendor/term/GPL2-LICENSE",
-     "lib/csd/vendor/term/ansicolor.rb",
-     "lib/csd/vendor/zentest/zentest_assertions.rb",
-     "lib/csd/version.rb",
-     "test/application/test_minisip.rb",
-     "test/functional/test_application_base.rb",
-     "test/functional/test_application_default.rb",
-     "test/functional/test_applications.rb",
-     "test/functional/test_cli.rb",
-     "test/functional/test_commands.rb",
-     "test/functional/test_csd.rb",
-     "test/functional/test_options.rb",
-     "test/helper.rb",
-     "test/unit/test_container.rb",
-     "test/unit/test_dir.rb",
-     "test/unit/test_open_struct.rb",
-     "test/unit/test_pathname.rb",
-     "test/unit/test_platform.rb",
-     "test/unit/test_string.rb"
-  ]
-  s.homepage = %q{http://github.com/csd/csd}
-  s.post_install_message = %q{
-============================================================
-
-  Thank you for installing the TTA Automated Installer!
-
-  You can run it by typing `ai´ in your command line.
-
-  NOTE: On DEBIAN and UBUNTU the executable `ai´ is *maybe*
-        not in your PATH by default. If that is the case,
-        you can fix it by running this command:
-
-  echo "export PATH=\$PATH:$(gem env | grep "E D" | sed "s/[^\w]* //")" >> ~/.bashrc;. ~/.bashrc
-
-============================================================
-}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Installation and compilation handler for software used in CSD projects.}
-  s.test_files = [
-    "test/application/test_minisip.rb",
-     "test/functional/test_application_base.rb",
-     "test/functional/test_application_default.rb",
-     "test/functional/test_applications.rb",
-     "test/functional/test_cli.rb",
-     "test/functional/test_commands.rb",
-     "test/functional/test_csd.rb",
-     "test/functional/test_options.rb",
-     "test/helper.rb",
-     "test/unit/test_container.rb",
-     "test/unit/test_dir.rb",
-     "test/unit/test_open_struct.rb",
-     "test/unit/test_pathname.rb",
-     "test/unit/test_platform.rb",
-     "test/unit/test_string.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-