csd 0.1.9 → 0.1.10

data/.gitignore

@@ -13,10 +13,14 @@ tmtags
 ## VIM
 *.swp
 
+## ECLIPSE
+.loadpath
+.project
+
 ## PROJECT::GENERAL
 coverage
 rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-drop
+drop

data/Rakefile

@@ -29,18 +29,18 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.post_install_message = %q{
 ============================================================
 
- Thank you for installing the TTA Automated Installer!
+  Thank you for installing the TTA Automated Installer!
 
- You can run it by typing `tta´ in your command line.
+  You can run it by typing `ai´ in your command line.
 
- NOTE: On DEBIAN and UBUNTU the executable `tta´ is *maybe*
-       not in your PATH by default. If that is the case,
-       you can fix it by running this command:
+  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
+  echo "export PATH=\$PATH:$(gem env | grep "E D" | sed "s/[^\w]* //")" >> ~/.bashrc;. ~/.bashrc
 
 ============================================================
-    }
+}
 end
 
 # Here we define the default task when no task was specified by the user

data/VERSION

@@ -1 +1 @@
-0.1.9
+0.1.10

data/bin/ai

@@ -22,5 +22,5 @@ rescue Interrupt
   # Lastly, close the AI gracefully on abnormal termination
   CSD.ui.separator
   CSD.ui.info "Quitting the AI...".red
-  exit
+  exit 1
 end

data/csd.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{csd}
-  s.version = "0.1.9"
+  s.version = "0.1.10"
 
   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-07-29}
+  s.date = %q{2010-08-03}
   s.default_executable = %q{ai}
   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}
@@ -28,11 +28,21 @@ Gem::Specification.new do |s|
      "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/default.rb",
      "lib/csd/application/default/base.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/ffmpeg.rb",
+     "lib/csd/application/minisip/component/gnome.rb",
+     "lib/csd/application/minisip/component/hdviper.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/compile.rb",
@@ -83,24 +93,25 @@ Gem::Specification.new do |s|
      "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!
+  Thank you for installing the TTA Automated Installer!
 
- You can run it by typing `tta´ in your command line.
+  You can run it by typing `ai´ in your command line.
 
- NOTE: On DEBIAN and UBUNTU the executable `tta´ is *maybe*
-       not in your PATH by default. If that is the case,
-       you can fix it by running this command:
+  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
+  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}
@@ -119,6 +130,7 @@ Gem::Specification.new do |s|
      "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"
   ]
 

data/lib/csd.rb

@@ -8,29 +8,37 @@ Dir[File.join(File.dirname(__FILE__), 'csd', '*.rb')].sort.each { |path| require
 #
 module CSD
   class << self
-    
+  
     # This String holds the name of the executable the user used to bootstrap this gem
     attr_reader :executable
-    
+  
     # This method "runs" the whole CSD gem, so to speak.
     #
     def bootstrap(options={})
       @executable = options[:executable]
       Options.parse!
       respond_to_incomplete_arguments
+      UI.debug "#{self}.bootstrap initializes the task #{Options.action.enquote} of the application #{Applications.current.name.to_s.enquote} now"
       Applications.current.instance.send("#{Options.action}".to_sym)
     end
-    
+  
     private
-    
+  
     # This method check the arguments the user has provided and terminates the AI with
     # some helpful message if the arguments are invalid.
     #
     def respond_to_incomplete_arguments
-      choose_application unless Applications.current
-      choose_action unless Options.valid_action?
+      if !Applications.current and ARGV.include?('update')
+        # Updating the AI
+        UI.info "Updating the AI to the newest version".green.bold
+        Cmd.run "sudo gem update csd", :announce_pwd => false, :verbose => true
+        exit # The only smooth status code 0 exit in this whole application :)
+      else
+        choose_application unless Applications.current
+        choose_action unless Options.valid_action?
+      end
     end
-    
+  
     # This methods lists all available applications
     #
     def choose_application
@@ -74,5 +82,4 @@ module CSD
     end
 
   end
-  
 end

data/lib/csd/application/decklink.rb

@@ -0,0 +1,27 @@
+# -*- encoding: UTF-8 -*-
+require 'csd/application/default/base'
+require 'csd/application/decklink/base'
+
+module CSD
+  module Application
+    # This is the Application Module for Decklink, a capture card device used in MiniSIP.
+    #
+    module Decklink
+      class << self
+
+        include CSD::Application::Default
+
+        # This method will check which system we're on and initialize the correct sub-module
+        #
+        def instance
+          if Gem::Platform.local.debian?
+            Base.new
+          else
+            raise 'Operating system not supported'
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+human: DeckLink
+description: Capture card drivers for the Blackmagic Design DeckLink device used by MiniSIP.
+actions:
+  public:
+    - install: Download and install the DeckLink drivers.
+scopes:
+  --- {}

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

@@ -0,0 +1,62 @@
+# -*- encoding: UTF-8 -*-
+require 'csd/application/default/base'
+
+module CSD
+  module Application
+    module Decklink
+      class Base < CSD::Application::Base
+       
+        def install
+          create_working_directory
+          define_relative_paths
+          download
+          extract
+          apply
+        end
+        
+        def download
+          if Path.tar.file?
+            UI.warn "The driver will not be downloaded, because it already exists: #{Path.tar.enquote}"
+          else
+            UI.info "Downloading DeckLink drivers from Blackmagic Design".green.bold
+            Cmd.cd Path.work, :internal => true
+            Cmd.run "wget #{Path.decklink_url}", :verbose => false
+          end
+        end
+        
+        def extract
+          if Path.packages.directory?
+            UI.warn "The tar file will not be extracted, because package repositot already exist: #{Path.packages.enquote}"
+          else
+            UI.info "Extracting DeckLink drivers".green.bold
+            Cmd.mkdir Path.packages
+            Cmd.cd Path.packages, :internal => true
+            Cmd.run "tar -xzf #{Path.tar}"
+          end
+        end
+        
+        def apply
+          Cmd.cd Path.packages, :internal => true
+          archflag = Gem::Platform.local.cpu =~ /64/ ? 'amd64' : 'i386'
+          file = Dir[File.join(Path.packages, "Deck*#{archflag}*.deb")]
+          UI.debug "#{self.class} identified these applicable packages: #{file.join(', ')}"
+          UI.info "Installing Debian packages".green.bold
+          Cmd.run "sudo apt-get install libmng1", :announce_pwd => false
+          Cmd.run "sudo dpkg -i #{file.first}", :announce_pwd => false
+        end
+        
+        def define_relative_paths
+          blacklink_repository  = 'http://www.blackmagic-design.com/downloads/software/'
+          decklink_basename     = 'DeckLink_Linux_7.7.3'
+          decklink_extension    = '.tar.gz'
+          Path.decklink_url     = blacklink_repository + decklink_basename + decklink_extension
+          Path.tar              = Pathname.new(File.join(Path.work, "#{decklink_basename + decklink_extension}"))
+          Path.packages         = Pathname.new(File.join(Path.work, decklink_basename))
+        end
+        
+        
+        
+      end
+    end
+  end
+end

data/lib/csd/application/default.rb

@@ -38,7 +38,11 @@ module CSD
         # TODO: about.scopes[:action]
         []
       end
-    
+      
+      # This method will look for application and task specific optionsfiles of the current application module.
+      # It returns the Ruby code in a +String+ to be eval'd by the OptionsParser.
+      # If there are no files in myapplication/options, an empty +String+ is returned instead.
+      #
       def options(action='')
         options_dir      = File.join(Path.applications, name, 'options')
         common_file      = File.join(options_dir, "common.rb")

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

@@ -9,6 +9,9 @@ module CSD
     #
     class Base
       
+      # Running recommended actions for all Applications on initialization.
+      # Simple applications might not have to call this via +super+.
+      #
       def initialize
         define_working_directory
       end
@@ -33,6 +36,13 @@ module CSD
         Path.work = path.pathnamify.expand_path
       end
       
+      def create_working_directory
+        unless Path.work.directory?
+          UI.info "Creating working directory".green.bold
+          Cmd.mkdir Path.work
+        end
+      end
+      
     end
   end
 end

data/lib/csd/application/minisip.rb

@@ -38,32 +38,35 @@ module CSD
         # * +unknown+
         #
         def instance
+          UI.debug "#{self}.instance checks whether MiniSIP is supported for the OS #{Gem::Platform.local.os.enquote}"
           @instance ||= case Gem::Platform.local.os
             
             when 'darwin'
               # Mac OS X
-              UI.debug "Mac OS X identified"
+              UI.debug "#{self}.instance supports Mac OS X"
               Darwin.new
             
             when 'linux'
               # Linux
-              UI.debug "Analyzing Linux kernel release: #{Gem::Platform.local.kernel_release}"
+              UI.debug "#{self}.instance supports Linux"
+              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 "Ubuntu 10.04 identified"
+                  UI.debug "#{self}.instance supports Ubuntu 10.04"
                   Ubuntu10.new
                 
                 else
                   # Any other Linux (currently only Debian is supported)
-                  UI.debug "Debian identified"
+                  UI.debug "#{self}.instance supports Debian"
                   Debian.new
               end
               
             else
               # Microsoft Windows, Java, Solaris, etc...
-              UI.debug "This Operating System is not supported."
+              UI.debug "#{self}.instance does not support #{Gem::Platform.local.os.enquote}"
+              # NOTE: The AI should actually abort here as long as there is no MiniSIP for these platforms at all...
               Base.new
           end
         end

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

@@ -5,7 +5,7 @@ actions:
     #- 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
+    #- package: Downloads, compiles and packages MiniSIP from scratch
     #- install: Installs an application
     #- check: Checks whether the environment dependencies for the application are satisfied
   developer:

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

@@ -1,133 +1,69 @@
 # -*- encoding: UTF-8 -*-
 require 'csd/application/default/base'
+require 'csd/application/minisip/component'
 
 module CSD
   module Application
     module Minisip
       class Base < CSD::Application::Base
         
-        # This is an +Array+ containing the names of the internal MiniSIP libraries. Note that they
-        # are sorted according to the sequence in which they need to be compiled.
-        #
-        LIBRARIES = %w{ libmutil libmnetutil libmcrypto libmikey libmsip libmstun libminisip minisip }
+        include Component
         
-        # Tasks to be done before the introduction is evoked.
+        # Tasks to be done before the introduction is evoked by the AI.
         #
         def initialize
           super
           define_relative_paths
         end
-        
-        # MAIN APPLICATION OPERATIONS
-        
+
+        # Running the compile task.
+        #
         def compile
           UI.error 'Currently not supported for this platform. Sorry.'
         end
         
+        # Running the package task.
+        #
         def package
           UI.error 'Currently not supported for this platform. Sorry.'
         end
         
-        # GENERAL USER INFORMATION
-        
+        # This methods prints general information about this application module.
+        #
         def introduction
           UI.separator
-          UI.info " Working directory:              ".green + Path.work.to_s.yellow
-          UI.info " Your Platform:                  ".green + Gem::Platform.local.humanize.to_s.yellow
-          UI.info(" Application module:             ".green + self.class.name.to_s.yellow)
+          UI.info " Working directory:       ".green.bold + Path.work.to_s.yellow
+          if Options.debug
+            UI.info " Your Platform:           ".green + Gem::Platform.local.humanize.to_s.yellow
+            UI.info(" Application module:      ".green + self.class.name.to_s.yellow)
+          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?
-            exit
+            raise CSD::Error::Argument::HelpWasRequested
           else
-            raise Interrupt unless (Options.yes or Options.reveal or UI.ask_yes_no("Continue?".red.bold, true))
+            raise Interrupt unless Options.yes or Options.reveal or UI.continue?
           end
         end
         
-        # OTHER CROSS-PLATFORM TASKS
-        
-        # Determines which libraries of MiniSIP should be processed, because the --only parameter might be set.
+        # Defines all paths ever needed for the MiniSIP module based on the working directory.
         #
-        def libraries
-          Options.only ? LIBRARIES.map { |lib| lib if Options.only.to_a.include?(lib) }.compact : LIBRARIES
-        end
-
-        # CHECKOUTS
-        
-        def checkout_minisip
-          Cmd.git_clone('MiniSIP repository', 'http://github.com/csd/minisip.git', Path.repository)
-        end
-        
-        def checkout_plugins
-          Cmd.git_clone('additional MiniSIP plugins', 'http://github.com/csd/minisip-plugins.git', Path.plugins)
-        end
-
-        def checkout_hdviper
-          Cmd.git_clone('HDVIPER', 'http://github.com/csd/libraries.git', Path.hdviper)
-        end
-        
-        def checkout_ffmpeg
-          Cmd.git_clone('ffmpeg repository', 'http://github.com/csd/ffmpeg.git', Path.ffmpeg_repository)
-        end
-        
-        def checkout_libswscale
-          Cmd.git_clone('ffmpeg libswscale sub-repository', 'http://github.com/csd/libswscale.git', Path.ffmpeg_libswscale)
-        end
-        
-        def checkout_x264
-          Cmd.git_clone('x264 repository', 'http://github.com/csd/x264.git', Path.x264_repository)
-        end
-        
-        # MODIFYING FILES
-        
-        def modify_minisip
-          Cmd.replace(Path.repository_open_gl_display, '/home/erik', Path.build)
-          if Options.ffmpeg_first
-            # See http://www.howgeek.com/2010/03/01/ffmpeg-php-error-‘pix_fmt_rgba32’-undeclared-first-use-in-this-function/
-            # and http://ffmpeg.org/doxygen/0.5/pixfmt_8h.html#33d341c4f443d24492a95fb7641d0986
-            Cmd.replace(Path.repository_avcoder_cxx,   'PIX_FMT_RGBA32', 'PIX_FMT_RGB32')
-            Cmd.replace(Path.repository_avdecoder_cxx, 'PIX_FMT_RGBA32', 'PIX_FMT_RGB32')
-          end
-        end
-        
-        def modify_libavutil
-          if Path.ffmpeg_libavutil_common_backup.file?
-            UI.warn "The libavutil common.h file seems to be fixed already, I won't touch it now. Delete #{Path.ffmpeg_libavutil_common_backup.enquote} to enforce it."
-          else
-            Cmd.copy Path.ffmpeg_libavutil_common, Path.ffmpeg_libavutil_common_backup
-            Cmd.replace Path.ffmpeg_libavutil_common, '    if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (a>>63) ^ 0x7FFFFFFF;', "    // MODIFIED BY THE AUTOMATED INSTALLER\n    // if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (a>>63) ^ 0x7FFFFFFF;\n    if ((a+0x80000000u) & ~(0xFFFFFFFFULL)) return (a>>63) ^ 0x7FFFFFFF;"
-          end
-        end
-        
-        # FLAGS
-        
-        # See http://code.google.com/p/ffmpegsource/issues/detail?id=11
-        # But for some reason it did not fix tue issue for us :|
-        #
-        def libminisip_c_flags
-          %{CFLAGS="-D__STDC_CONSTANT_MACROS"}
-        end
-
-        def libminisip_cpp_flags
-          if Options.ffmpeg_first
-            %{CPPFLAGS="-I#{Path.hdviper_x264} -I#{Path.hdviper_x264_test_x264api} -I#{Path.ffmpeg_libavutil} -I#{Path.ffmpeg_libavcodec} -I#{Path.ffmpeg_libswscale} -I#{Path.repository_grabber} -I#{Path.repository_decklinksdk}"}
+        def define_relative_paths
+          if Options.this_user
+            Path.build = Pathname.new(File.join(Path.work, 'build'))
           else
-            %{CPPFLAGS="-I#{Path.hdviper_x264} -I#{Path.hdviper_x264_test_x264api} -I#{Path.repository_grabber} -I#{Path.repository_decklinksdk}"}
+            Path.build = Pathname.new(File.join('/', 'usr', 'local'))
+            # This is tricky, but should work for most linux distributions
+            # On Windows it will just crash here, unless we determine where the heck sudo make install is targetting at :)
+            raise Error::Minisip::BuildDirNotFound, "Sorry, `/usr/local´ could not be found but was requested as MiniSIP target. Use `#{CSD.executable}´ with the option `--this-user´ instead." unless Path.build.directory?
           end
-        end
-        
-        def libminisip_ld_flags
-          %{LDFLAGS="#{Path.hdviper_libx264api} #{Path.hdviper_libtidx264} -lpthread -lrt"}
-        end
-        
-        def define_relative_paths
-          Path.build                              = Pathname.new(File.join(Path.work, 'build'))
           Path.build_bin                          = Pathname.new(File.join(Path.build, 'bin'))
           Path.build_gtkgui                       = Pathname.new(File.join(Path.build_bin, 'minisip_gtkgui'))
           Path.build_include                      = Pathname.new(File.join(Path.build, 'include'))
           Path.build_lib                          = Pathname.new(File.join(Path.build, 'lib'))
+          Path.build_lib_libminisip_so            = Pathname.new(File.join(Path.build_lib, 'libminisip.so.0'))
           Path.build_lib_pkg_config               = Pathname.new(File.join(Path.build_lib, 'pkgconfig'))
           Path.build_share                        = Pathname.new(File.join(Path.build, 'share'))
           Path.build_share_aclocal                = Pathname.new(File.join(Path.build_share, 'aclocal'))
@@ -156,6 +92,9 @@ module CSD
           Path.hdviper_libx264api                 = Pathname.new(File.join(Path.hdviper_x264_test_x264api, 'libx264api.a'))
           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_pixmap               = Pathname.new(File.join('/', 'usr', 'share', 'pixmaps', 'minisip_gnome.png'))
+          Path.minisip_desktop_entry              = Pathname.new(File.join('/', 'usr', 'share', 'applications', 'minisip.desktop'))
         end
         
       end