csd 0.1.5 → 0.1.6

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
 require 'tmpdir'
 
 module CSD

data/lib/csd/application/minisip.rb

@@ -1,31 +1,63 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
 require 'ostruct'
-require File.join(File.dirname(__FILE__), 'default')
-require File.join(File.dirname(__FILE__), 'minisip', 'error')
-require File.join(File.dirname(__FILE__), 'minisip', 'base')
-require File.join(File.dirname(__FILE__), 'minisip', 'unix', 'linux', 'debian', 'ubuntu10')
+require 'csd/application/default'
+require 'csd/application/minisip/error'
+require 'csd/application/minisip/base'
+require 'csd/application/minisip/unix'
+require 'csd/application/minisip/unix/darwin'
+require 'csd/application/minisip/unix/linux'
+require 'csd/application/minisip/unix/linux/debian'
+require 'csd/application/minisip/unix/linux/debian/ubuntu10'
 
 module CSD
   module Application
+    # This is the Application Module for MiniSIP, an open-source high-definition video conferencing client.
+    #
     module Minisip
       class << self
-        
+
         include CSD::Application::Default
-        
+
+        # This method will check which operating system we're on and initialize the correct sub-module
+        # (see http://github.com/rubygems/rubygems/blob/master/lib/rubygems/platform.rb#L65 for supported
+        # platform identifiers).
+        #
+        # Currently these platforms can generally exist: 
+        # * +cygwin+ (a Linux-like environment for Windows)
+        # * +darwin+ (Mac OS X)
+        # * +freebsd+
+        # * +hpux+ (Hewlett Packard UniX)
+        # * +java+
+        # * +dotnet+
+        # * +linux+ (Debian, OpenSUSE, Ubuntu, Red Hat, Fedora...)
+        # * +mingw32+ (Minimalist GNU for Windows)
+        # * +mswin*+ (Microsoft Windows, e.g. +mswin32+, +mswin64+)
+        # * +netbsdelf+
+        # * +openbsd+
+        # * +solaris+
+        # * +unknown+
+        #
         def instance
           @instance ||= case Gem::Platform.local.os
+            
+            when 'darwin'
+              Darwin.new
+              
             when 'linux'
-              UI.debug "Analyzing kernel version: #{Gem::Platform.local.kernel_version}"
-              case Gem::Platform.local.kernel_version
-                when /(36-Ubuntu)|(37-Ubuntu)/
+              UI.debug "Analyzing Linux kernel release: #{Gem::Platform.local.kernel_release}"
+              case Gem::Platform.local.kernel_release
+                
+                when '2.6.32-21-generic', '2.6.32-22-generic'
                   UI.debug "Ubuntu 10.04 identified"
                   Ubuntu10.new
+                  
                 else
                   UI.debug "Debian identified"
                   Debian.new
               end
+              
             else
-              UI.debug "Nothing identified"
+              UI.debug "This Operating System is not supported."
               Base.new
           end
         end

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

@@ -1,14 +1,14 @@
 human: MiniSIP
 description: An open-source SIP client for high-definition video conferencing.
 actions:
-  :public:
+  public:
     #- show: Shows further information about MiniSIP
-    - download: Downloads MiniSIP components (e.g. source code, configurations, docs,...)
-    #- install: Installs an application
-    #- check: Checks whether the environment dependencies for the application are satisfied
-  :developer:
+    #- 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: Installs an application
+    #- check: Checks whether the environment dependencies for the application are satisfied
+  developer:
     #- publish: Submits a compiled package to the CSD package repository
 scopes:
   --- {}

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

@@ -1,100 +1,112 @@
-# encoding: utf-8
-require File.join(File.dirname(__FILE__), '..', 'default', 'base')
+# -*- encoding: UTF-8 -*-
+require 'csd/application/default/base'
 
 module CSD
   module Application
     module Minisip
       class Base < CSD::Application::Base
         
-        LIBRARIES = %w{ libmutil libmnetutil libmcrypto libmikey libmsip libmstun libminisip minisip } unless defined?(LIBRARIES)
-
-        def package
+        LIBRARIES = %w{ libmutil libmnetutil libmcrypto libmikey libmsip libmstun libminisip minisip }
+        
+        # MAIN APPLICATION OPERATIONS
+        
+        def compile
           UI.error 'Currently not supported for this platform. Sorry.'
         end
         
-        def compile
+        def package
           UI.error 'Currently not supported for this platform. Sorry.'
         end
         
-        def define_root_path
-          if Options.path
-            if File.directory?(Options.path)
-              Path.root = File.expand_path(Options.path)
-            else
-              raise Error::Options::PathNotFound, "The path `#{Options.path}´ doesn't exist."
-            end
+        # GENERAL USER INFORMATION
+        
+        def introduction
+          define_root_path
+          define_paths
+          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.separator
+          if Options.help
+            UI.info Options.helptext
+            abort
           else
-            Path.root = Options.temp ? Dir.mktmpdir : Dir.pwd
+            raise(Interrupt) unless (Options.yes or UI.ask_yes_no("Continue?".red.bold, true))
           end
         end
         
-        def define_paths
-          Path.work                      = Pathname.new(File.join(Path.root, 'minisip'))
-          Path.repository                = Pathname.new(File.join(Path.work, 'repository'))
-          Path.plugins                   = Pathname.new(File.join(Path.work, 'plugins'))
-          Path.packaging                 = Pathname.new(File.join(Path.work, 'packaging'))
-          Path.open_gl_display           = Pathname.new(File.join(Path.repository, 'libminisip', 'source', 'subsystem_media', 'video', 'display', 'OpenGLDisplay.cxx'))
-          Path.hdviper                   = Pathname.new(File.join(Path.work, 'hdviper'))
-          Path.hdviper_x264              = Pathname.new(File.join(Path.hdviper, 'x264'))
-          Path.hdviper_x264_test_x264api = Pathname.new(File.join(Path.hdviper_x264, 'test', 'x264API'))
-          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_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'))
-          Path.giomm_header              = Pathname.new(File.join('/', 'usr', 'include', 'giomm-2.4', 'giomm.h'))
-        end
+        # CROSS-PLATFORM TASKS
         
-        def checkout_minisip # TODO: Refactor because redudancy with checkout_hdviper
-          if Path.repository.directory?
-            UI.warn "Skipping repository download, because the directory already exists: #{Path.repository}"
-          else
-            if Path.repository.parent.writable? or Options.dry
-              UI.info "Downloading minisip repository to: #{Path.repository}".green.bold
-              Cmd.run("git clone http://github.com/csd/minisip.git #{Path.repository}")
-              # Fixing hard-coded stuff
-              Cmd.replace(Path.open_gl_display, '/home/erik', Path.build)
-            else
-              UI.error "Could not download minisip repository (no permission): #{Path.repository}"
-            end
-          end
+        def libraries
+          Options.only ? LIBRARIES.map { |lib| lib if Options.only.to_a.include?(lib) }.compact : LIBRARIES
         end
         
-        def checkout_plugins # TODO: Refactor because redudancy with checkout_hdviper
-          if Path.plugins.directory?
-            UI.warn "Skipping plugins download, because the directory already exists: #{Path.plugins}"
-          else
-            if Path.plugins.parent.writable? or Options.dry
-              UI.info "Downloading minisip plugins to: #{Path.plugins}".green.bold
-              Cmd.run("git clone http://github.com/csd/minisip-plugins.git #{Path.plugins}")
-            else
-              UI.error "Could not download minisip plugins (no permission): #{Path.plugins}"
-            end
-          end
+        def checkout_minisip
+          Cmd.git_clone('MiniSIP repository', 'http://github.com/csd/minisip.git', Path.repository)
         end
         
+        def modify_minisip
+          Cmd.replace(Path.repository_open_gl_display, '/home/erik', Path.build)
+        end
+
+        def checkout_plugins
+          Cmd.git_clone('additional MiniSIP plugins', 'http://github.com/csd/minisip-plugins.git', Path.plugins)
+        end
+
         def checkout_hdviper
-          if Path.hdviper.directory?
-            UI.warn "Skipping hdviper, because the directory already exists: #{Path.hdviper}"
-          else
-            if Path.hdviper.parent.writable? or Options.dry
-              UI.info "Downloading hdviper to: #{Path.hdviper}".green.bold
-              Cmd.run("git clone http://github.com/csd/libraries.git #{Path.hdviper}")
-              #Cmd.run("svn co --quiet svn://hdviper.org/hdviper/wp3/src #{Path.hdviper}")
-              return true
+          Cmd.git_clone('HDVIPER', 'http://github.com/csd/libraries.git', Path.hdviper)
+        end
+        
+        # CROSS-PLATFORM INFORMATION
+        
+        def cpp_flags
+          "CPPFLAGS=\"-I#{Path.hdviper_x264} -I#{Path.hdviper_x264_test_x264api} -I#{Path.repository_grabber} -I#{Path.repository_decklinksdk}\""
+        end
+        
+        def ld_flags
+          "LDFLAGS=\"#{Path.hdviper_libx264api} #{Path.hdviper_libtidx264} -lpthread -lrt\""
+        end
+        
+        # DEFINING PATHS ETC...
+        
+        def define_root_path
+          if Options.path
+            if File.directory?(Options.path)
+              Path.root = File.expand_path(Options.path)
             else
-              UI.error "Could not download hdviper (no permission): #{Path.hdviper}"
+              raise Error::Options::PathNotFound, "The path `#{Options.path}´ doesn't exist."
             end
+          else
+            Path.root = Options.temp ? Dir.mktmpdir : Dir.pwd
           end
         end
         
-        def before_compile
-        end
-
-        def after_compile
+        def define_paths
+          Path.work                               = Pathname.new(File.join(Path.root, 'minisip'))
+          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_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'))
+          Path.repository_open_gl_display         = Pathname.new(File.join(Path.repository, 'libminisip', 'source', 'subsystem_media', 'video', 'display', 'OpenGLDisplay.cxx'))
+          Path.repository_decklinksdk             = Pathname.new(File.join(Path.repository_grabber, 'decklinksdk'))
+          Path.plugins                            = Pathname.new(File.join(Path.work, 'plugins'))
+          Path.packaging                          = Pathname.new(File.join(Path.work, 'packaging'))
+          Path.hdviper                            = Pathname.new(File.join(Path.work, 'hdviper'))
+          Path.hdviper_x264                       = Pathname.new(File.join(Path.hdviper, 'x264'))
+          Path.hdviper_libtidx264                 = Pathname.new(File.join(Path.hdviper_x264, 'libtidx264.a'))
+          Path.hdviper_x264_test_x264api          = Pathname.new(File.join(Path.hdviper_x264, 'test', 'x264API'))
+          Path.hdviper_libx264api                 = Pathname.new(File.join(Path.hdviper_x264_test_x264api, 'libx264api.a'))
+          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_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'))
         end
         
       end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
 require File.join(File.dirname(__FILE__), '..', '..', 'error')
 
 module CSD

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

@@ -1 +1 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
 # This file gets eval'ed by the global options parser in lib/csd/rb
 # TODO: There must be a nicer solution for this.
 

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
 # This file gets eval'ed by the global options parser in lib/csd/rb
 # TODO: There must be a nicer solution for this.
 

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

@@ -1,25 +1,25 @@
-# encoding: utf-8
-require File.join(File.dirname(__FILE__), 'base')
+# -*- encoding: UTF-8 -*-
+require 'csd/application/minisip/base'
 
 module CSD
   module Application
     module Minisip
       class Unix < Base
         
+        # OPERATION INTRODUCTION
+        
         def introduction
-          define_root_path
-          define_paths
           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) if Options.developer
+          UI.info " Libraries to process:   ".green + libraries.join(', ').yellow
+          super
+        end
+        
+        def compile
           UI.separator
-          if Options.help
-            UI.info Options.helptext
-            exit
-          else
-            exit unless (Options.yes or UI.ask_yes_no("Continue?".red.bold, true))
-          end
+          UI.info "This operation will download and compile MiniSIP.".green.bold
+          introduction
+          compile!
+          run_minisip_gtk_gui
         end
         
         def package
@@ -29,11 +29,16 @@ module CSD
           package!
         end
         
-        def compile
-          UI.separator
-          UI.info "This operation will download and compile MiniSIP.".green.bold
-          introduction
-          compile!
+        # OPERATIONS
+        
+        def compile!
+          Cmd.mkdir Path.work
+          checkout_hdviper
+          make_hdviper
+          checkout_minisip
+          modify_minisip
+          checkout_plugins
+          make_minisip
         end
         
         def make_hdviper
@@ -44,12 +49,17 @@ module CSD
           Cmd.run('make')
         end
         
-        def make_minisip
+        def create_build_dir
+          UI.info "Creating target build directories".green.bold
           [Path.build, Path.build_include, Path.build_lib, Path.build_share, Path.build_share_aclocal].each { |target| Cmd.mkdir target }
-          LIBRARIES.each do |library|
+        end
+        
+        def make_minisip
+          create_build_dir
+          libraries.each do |library|
             directory = Pathname.new(File.join(Path.repository, library))
             next if Options.only and !Options.only.include?(library)
-            if Cmd.cd(directory) or Options.dry or Options.reveal
+            if Cmd.cd(directory) or Options.reveal
               if Options.bootstrap
                 UI.info "Bootstrapping #{library}".green.bold
                 Cmd.run("./bootstrap -I #{Path.build_share_aclocal.enquote}")
@@ -58,14 +68,14 @@ module CSD
                 UI.info "Configuring #{library}".green.bold
                 individual_options = case library
                   when 'libminisip'
-                    %Q{--enable-debug --enable-video --disable-mil --enable-decklink --enable-opengl --disable-sdl CPPFLAGS="-I#{Path.hdviper_x264_test_x264api} -I#{Path.hdviper_x264}" LDFLAGS="#{File.join(Path.hdviper_x264_test_x264api, 'libx264api.a')} #{File.join(Path.hdviper_x264, 'libtidx264.a')} -lpthread -lrt"}
+                    %Q{--enable-debug --enable-video --disable-mil --enable-decklink --enable-opengl --disable-sdl CPPFLAGS="-I#{Path.hdviper_x264_test_x264api} -I#{Path.hdviper_x264}" #{ld_flags}}
                     #%Q{--enable-debug --enable-video --disable-mil --disable-decklink --enable-opengl --disable-sdl CPPFLAGS="-I#{Path.hdviper_x264}" LDFLAGS="#{File.join(Path.hdviper_x264, 'libx264.a')} -lpthread -lrt"}
                   when 'minisip'
                     %Q{--enable-debug --enable-video --enable-textui --enable-opengl}
                   else
                     ''
                 end
-                Cmd.run(%Q{./configure #{individual_options} --prefix=#{Path.build.enquote} PKG_CONFIG_PATH=#{Path.build_lib_pkg_config.enquote} ACLOCAL_FLAGS=#{Path.build_share_aclocal} LD_LIBRARY_PATH=#{Path.build_lib.enquote} --silent})
+                Cmd.run(%Q{./configure #{individual_options} --prefix=#{Path.build.enquote} PKG_CONFIG_PATH=#{Path.build_lib_pkg_config.enquote} ACLOCAL_FLAGS=#{Path.build_share_aclocal} LD_LIBRARY_PATH=#{Path.build_lib.enquote}})
               end
               if Options.make
                 UI.info "Make #{library}".green.bold
@@ -84,17 +94,17 @@ module CSD
         
         def package!
           Cmd.mkdir(Path.packaging)
-          LIBRARIES.each do |library|
+          libraries.each do |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.dry or Options.reveal
+            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.dry 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))
@@ -125,7 +135,10 @@ module CSD
             end
           end
           Cmd.cd Path.root
-          Cmd.run 'minisip_gtkgui'
+        end
+        
+        def run_minisip_gtk_gui
+          Cmd.run(Path.build_gtkgui, :die_on_failure => false)
         end
         
       end

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

@@ -0,0 +1,12 @@
+# -*- encoding: UTF-8 -*-
+require File.join(File.dirname(__FILE__), '..', 'unix')
+
+module CSD
+  module Application
+    module Minisip
+      class Darwin < Unix
+        
+      end
+    end
+  end
+end