csd 0.1.10 → 0.1.11

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.1.11

data/bin/ai

@@ -2,7 +2,7 @@
 
 # NOTE: If you would like to execute this file as a developer
 #       but not install the CSD gem, you can use this command:
-#       ruby -I path/to/csd/lib path/to/csd/bin/tta
+#       ruby -I path/to/csd/lib path/to/csd/bin/ai
 
 # First, let's load the RubyGems framework and the CSD gem.
 # Even though RubyGems is already loaded for Ruby >= 1.9,

data/csd.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{csd}
-  s.version = "0.1.10"
+  s.version = "0.1.11"
 
   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-08-03}
+  s.date = %q{2010-08-04}
   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}
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/csd/application/decklink.rb",
      "lib/csd/application/decklink/about.yml",
      "lib/csd/application/decklink/base.rb",
+     "lib/csd/application/decklink/options/install.rb",
      "lib/csd/application/default.rb",
      "lib/csd/application/default/base.rb",
      "lib/csd/application/minisip.rb",
@@ -47,6 +48,7 @@ Gem::Specification.new do |s|
      "lib/csd/application/minisip/options/common.rb",
      "lib/csd/application/minisip/options/compile.rb",
      "lib/csd/application/minisip/options/package.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",

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

@@ -5,13 +5,43 @@ module CSD
   module Application
     module Decklink
       class Base < CSD::Application::Base
-       
+        
+        # A list of apt-get packages that are required to install the decklink drivers.
+        #
+        DEBIAN_DEPENDENCIES = %w{ libnotify-bin libmng1 dkms }
+        
         def install
+          UI.separator
+          UI.info "This operation will download and install the DeckLink device drivers.".green.bold
+          UI.separator
+          introduction
+          install!
+        end
+        
+        def install!
           create_working_directory
           define_relative_paths
           download
           extract
           apply
+          send_notification
+        end
+        
+        def introduction
+          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?
+            raise CSD::Error::Argument::HelpWasRequested
+          else
+            raise Interrupt unless Options.yes or Options.reveal or UI.continue?
+          end
         end
         
         def download
@@ -41,8 +71,12 @@ module CSD
           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
+          Cmd.run "sudo apt-get install #{DEBIAN_DEPENDENCIES} --yes", :announce_pwd => false
+          Cmd.run "sudo dpkg -i #{file.first || '[DRIVER FILE FOR THIS ARCHITECTURE]'}", :announce_pwd => false
+        end
+        
+        def send_notification
+          Cmd.run %{notify-send --icon=gdm-setup "DeckLink installation complete" "You are now ready to use your Blackmagic Design DeckLink device." }, :internal => true, :die_on_failure => false
         end
         
         def define_relative_paths
@@ -54,8 +88,6 @@ module CSD
           Path.packages         = Pathname.new(File.join(Path.work, decklink_basename))
         end
         
-        
-        
       end
     end
   end

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

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

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

@@ -24,10 +24,10 @@ module CSD
         if Options.work_dir
           # The user specified the working directory manually
           path = Options.work_dir
-        elsif Options.temp
+        elsif Options.temp and !Options.this_user
           # The user specified the working directory to be a system's temporary directory
           # Note that only with this option, the directory is actually created at this point
-          path = Dir.mktmpdir 
+          path = Dir.mktmpdir
         else
           # Other than that, we create a subdirectory in the current directory and use that
           app_name = Applications.current ? Applications.current.name : 'application'
@@ -43,6 +43,14 @@ module CSD
         end
       end
       
+      def cleanup_working_directory
+        if !Options.work_dir and Options.temp and !Options.this_user and Path.work.directory?
+          UI.info "Removing working directory".green.bold
+          UI.debug "MILESTONE: deleting-work-dir"
+          Cmd.run "rm -Rf #{Path.work}", :announce_pwd => false
+        end
+      end
+      
     end
   end
 end

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

@@ -31,7 +31,6 @@ module CSD
         # This methods prints general information about this application module.
         #
         def introduction
-          UI.separator
           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
@@ -95,6 +94,7 @@ module CSD
           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'))
+          Path.phonebook                          = Pathname.new(File.join(ENV['HOME'], '.minisip.addr'))
         end
         
       end

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

@@ -1,4 +1,5 @@
 # -*- encoding: UTF-8 -*-
+require 'csd/application/minisip/phonebook_example'
 
 module CSD
   module Application
@@ -23,17 +24,7 @@ module CSD
             #
             def compile
               UI.debug "#{self}.compile was called"
-              ffmpeg_available = Cmd.run('ffmpeg -h', :internal => true, :die_on_failure => false).success?
-              if ffmpeg_available and Options.configure and !Options.reveal and libraries.include?('libminisip')
-                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!
-                  UI.info "Removing FFmpeg before re-compiling MiniSIP".green.bold
-                  Cmd.run "sudo apt-get remove ffmpeg --yes", :announce_pwd => false
-                else
-                  # On other linux distributions we don't know how to remove ffmpeg
-                  raise Error::Minisip::Core::FFmpegInstalled, "Please remove ffmpeg from your system first, or run the #{CSD.executable} with --no-configure"
-                end
-              end
+              remove_ffmpeg
               if Path.repository.directory? and !Options.reveal
                 UI.warn "The MiniSIP source code will not be downloaded, because the directory #{Path.repository.enquote} already exists."
               else
@@ -41,9 +32,24 @@ module CSD
                 modify_source_code
               end
               modify_dirlist
-              # We would like to re-compile MiniSIP no matter what options were given as command-line arguments.
-              compile_libraries
+              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 remove_ffmpeg
+              ffmpeg_available = Cmd.run('ffmpeg -h', :internal => true, :die_on_failure => false).success?
+              return if Options.ffmpeg_first or !Options.configure or !Options.reveal or !libraries.include?('libminisip') or !ffmpeg_available
+              if Gem::Platform.local.debian?
+                # Note that FFmpeg must have been installed via apt-get or via the AI in order for this to work,
+                # because manual compilations of FFmpeg cannot be removed automatically
+                UI.info "Removing FFmpeg before re-compiling MiniSIP".green.bold
+                UI.info "You can skip this step by giving the option --force-ffmpeg".yellow
+                Cmd.run "sudo apt-get remove ffmpeg --yes", :announce_pwd => false
+              else
+                # On other linux distributions we don't know how to remove ffmpeg
+                raise Error::Minisip::Core::FFmpegInstalled, "Please remove ffmpeg from your system first, or run the #{CSD.executable} with --no-configure"
+              end
             end
             
             # This method provides upfront information to the user about how the MiniSIP Core component will be processed.
@@ -93,6 +99,7 @@ module CSD
               UI.info "Fixing MiniSIP OpenGL GUI source code".green.bold
               Cmd.replace(Path.repository_open_gl_display, '/home/erik', Path.build)
               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')
                 Cmd.replace(Path.repository_avdecoder_cxx, 'PIX_FMT_RGBA32', 'PIX_FMT_RGB32')
               end
@@ -112,7 +119,7 @@ module CSD
             end
             
             def link_libraries
-              UI.info "Linking shared MiniSIP libraries"
+              UI.info "Linking shared MiniSIP libraries".green.bold
               Cmd.run "sudo ldconfig #{Path.build_lib_libminisip_so}", :announce_pwd => false
             end
             
@@ -215,9 +222,9 @@ module CSD
             def run_gtkgui
               UI.info "Executing MiniSIP".green.bold
               if Options.this_user
-                Cmd.run(Path.build_gtkgui, :die_on_failure => false, :announce_pwd => false)
+                Cmd.run Path.build_gtkgui, :die_on_failure => false, :announce_pwd => false
               else
-                Cmd.run('minisip_gtkgui')
+                Cmd.run 'minisip_gtkgui', :die_on_failure => false, :announce_pwd => false
               end
             end
             
@@ -230,6 +237,13 @@ module CSD
               end
             end
             
+            def create_address_book
+              return if Path.phonebook.file?
+              UI.info "Creating default MiniSIP phonebook".green.bold
+              Cmd.touch_and_replace_content Path.phonebook, ::CSD::Application::Minisip::PHONEBOOK_EXAMPLE, :internal => true
+              UI.info "  Phonebook successfully saved in #{Path.phonebook}".yellow
+            end
+            
             # Iteratively makes debian packages of the internal MiniSIP libraries.
             # TODO: Refactor this, it looks terribly sensitive.
             # TODO: Check for GPL and LGLP license conflicts.

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

@@ -50,7 +50,6 @@ module CSD
             # is compiled _before_ MiniSIP.
             #
             def modify_libavutil
-              return
               if Path.ffmpeg_libavutil_common_backup.file? and !Options.reveal
                 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

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

@@ -30,15 +30,21 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
               else
                 create_desktop_entry
               end
+              send_notification
             end
             
             def create_desktop_entry
+              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) unless Path.minisip_gnome_pixmap.file?
+              Cmd.run("sudo cp #{Path.minisip_gnome_png} #{Path.minisip_gnome_pixmap}", :announce_pwd => false)
               Path.new_desktop_entry = Pathname.new File.join(Dir.mktmpdir, '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
             end
+            
+            def send_notification
+              Cmd.run %{notify-send --icon=minisip_gnome "MiniSIP installation complete" "Please have a look in your Applications menu -> Internet." }, :internal => true, :die_on_failure => false
+            end
           
           end
         end

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

@@ -41,7 +41,7 @@ module CSD
                   end
                 end
               else
-                UI.warn "The target plugin directory could not be found: #{Path.plugins_destination.enquote}".green.bold
+                UI.warn "The target plugin directory could not be found: #{Path.plugins_destination.enquote}"
               end
             end
           

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

@@ -3,11 +3,11 @@
 opts.headline 'WORKING DIRECTORY OPTIONS'.green.bold
 
 self.temp = true
-opts.on("--no-temp", "Use the current directory as working directory and not a system's temporary directory.") do |value|
-  self.temp = !value
+opts.on("--no-temp", "Use a subdirectory in the current directory as working directory and not /tmp.") do |value|
+  self.temp = value
 end
 
 self.work_dir = nil
-opts.on("--work-dir [PATH]", "Defines and/or creates the working directory. This will override the --pwd option.") do |value|
+opts.on("--work-dir [PATH]", "Defines and/or creates the working directory. This will override the --no-temp option.") do |value|
   self.work_dir = value
 end

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

@@ -2,7 +2,7 @@
 # This file gets eval'ed by the global options parser in lib/csd/options_parser
 
 self.this_user = false
-opts.on("--this-user","Compile MiniSIP not for all users (sudo), but only for the current user") do |value|
+opts.on("--this-user","Compile MiniSIP only for the current user (enforces the --no-temp option)") do |value|
   self.this_user = value
 end
 
@@ -12,10 +12,15 @@ opts.on("--no-apt-get","Don't run any apt-get commands") do |value|
 end
 
 self.ffmpeg_first = false
-opts.on("--ffmpeg-first","Compile FFmpeg before compiling MiniSIP (default is first MiniSIP)") do |value|
+opts.on("--force-ffmpeg","Do not remove FFmpeg before compiling MiniSIP and compile FFmpeg before MiniSIP") do |value|
   self.ffmpeg_first = value
 end
 
+self.github_tar = false
+opts.on("--github-tar","Instead of fetching git repositories from Github, use tarball downloads") do |value|
+  self.github_tar = value
+end
+
 self.branch = nil
 opts.on('--branch BRANCH', 'Choose another branch than `master´ when downloading the source code') do |lib|
   self.branch = value

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

@@ -0,0 +1,108 @@
+# -*- encoding: UTF-8 -*-
+
+module CSD
+  module Application
+    module Minisip
+      
+      PHONEBOOK_EXAMPLE = %{
+<phonebook>
+	<name>
+		TTA
+	</name>
+	<contact>
+		<name>
+			TTA HDVC
+		</name>
+		<pop>
+			<desc>
+				Client 1
+			</desc>
+			<uri>
+				sip:client1@carenet-se.se
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				Client2
+			</desc>
+			<uri>
+				sip:client2@carenet-se.se
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				Client3
+			</desc>
+			<uri>
+				sip:client3@carenet-se.se
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				Client4
+			</desc>
+			<uri>
+				ip:client4@carenet-se.se
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				Client5
+			</desc>
+			<uri>
+				ip:client5@carenet-se.se
+			</uri>
+		</pop>
+		<pop>
+			<desc>
+				Clien6
+			</desc>
+			<uri>
+				ip:client6@carenet-se.se
+			</uri>
+		</pop>
+	</contact>
+	<contact>
+		<name>
+			Carenet-SE
+		</name>
+		<pop>
+			<desc>
+				Reflector
+			</desc>
+			<uri>
+				sip:mcu@carenet-se.se
+			</uri>
+		</pop>
+	</contact>
+	<contact>
+		<name>
+			Tandberg
+		</name>
+		<pop>
+			<desc>
+				Tandberg Client1
+			</desc>
+			<uri>
+				sip:tandberg1@carenet-se.se
+			</uri>
+		</pop>
+	</contact>
+	<contact>
+		<name>
+			Tandberg
+		</name>
+		<pop>
+			<desc>
+				Tandberg Client2
+			</desc>
+			<uri>
+				sip:tandberg2@carenet-se.se
+			</uri>
+		</pop>
+	</contact>
+</phonebook>}
+
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module CSD
         
         # A list of apt-get packages that are required to compile minisip including hdviper and ffmpeg
         #
-        DEBIAN_DEPENDENCIES = %w{ automake build-essential checkinstall git-core libasound2-dev libavcodec-dev libglademm-2.4-dev libgtkmm-2.4-dev libltdl3-dev libsdl-dev libsdl-ttf2.0-dev libssl-dev libtool libswscale-dev libx11-dev libxv-dev nasm subversion yasm }
+        DEBIAN_DEPENDENCIES = %w{ automake build-essential checkinstall git-core libnotify-bin libasound2-dev libavcodec-dev libglademm-2.4-dev libgtkmm-2.4-dev libltdl3-dev libsdl-dev libsdl-ttf2.0-dev libssl-dev libtool libswscale-dev libx11-dev libxv-dev nasm subversion yasm }
 
         def compile!
           aptitude if Options.apt_get

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

@@ -9,11 +9,14 @@ module CSD
         # This method presents a general overview about the task that is to be performed.
         #
         def introduction
-          Core.introduction
-          # FFmpeg.introduction
-          # HDVIPER.introduction
-          # X264.introduction
-          # Plugins.introduction
+          if Options.developer
+            Core.introduction
+            # FFmpeg.introduction
+            # HDVIPER.introduction
+            # X264.introduction
+            # Plugins.introduction
+            UI.separator
+          end
           super
         end
         
@@ -23,6 +26,8 @@ module CSD
           UI.separator
           UI.info "This operation will compile MiniSIP and its dependencies.".green.bold
           UI.separator
+          install_mode = Options.this_user ? 'Only for this user (inside the working directory)' : 'For all users (sudo)'
+          UI.info " Installation mode:       ".green.bold + install_mode.yellow
           introduction
           compile!
         end
@@ -52,7 +57,21 @@ module CSD
           end
           Plugins.compile
           Gnome.compile
-          Core.run_gtkgui
+          congratulations
+        end
+        
+        def congratulations
+          if Options.this_user
+            Core.run_gtkgui
+          else
+            cleanup_working_directory
+            UI.separator
+            UI.info "MiniSIP installation complete.".green.bold
+            UI.info "Please have a look in your Applications menu -> Internet."
+            UI.separator
+            # Core.run_gtkgui # At this point we could run MiniSIP instead of ending the AI -- if we wanted to.
+          end
+          
         end
         
       end

data/lib/csd/commands.rb

@@ -295,8 +295,24 @@ module CSD
         return result
       end
       UI.info "Downloading #{name} to #{destination.enquote}".green.bold
-      # We will simply return the CommandResult of the run-method.
-      Cmd.run("git clone #{repository} #{destination}", :announce_pwd => false)
+      if Options.github_tar and repository =~ /github.com/
+        Cmd.mkdir destination
+        Cmd.cd destination
+        repository = repository.gsub('.git', '/tarball/master')
+        Cmd.run "wget #{repository}", :announce_pwd => false
+        if tar_file = Dir[File.join(destination, '*.tar*')].first or Options.reveal
+          Cmd.run "tar -xzf #{tar_file || '[NAME OF THE TARFILE]'}"
+          Cmd.run "rm #{tar_file || '[NAME OF THE TARFILE]'}"
+        end
+        if extracted_directory = Dir[File.join(destination, '*')].first or Options.reveal
+          content = Options.reveal ? File.join('[EXTRACTED DIRECTORY]', '*') : File.join(extracted_directory, '*')
+          Cmd.run "mv #{content} #{destination}", :announce_pwd => false
+          Cmd.run "rm -r #{extracted_directory || '[EXTRACTED DIRECTORY]'}"
+        end
+      else
+        # We will simply return the CommandResult of the run-method.
+        Cmd.run("git clone #{repository} #{destination}", :announce_pwd => false)
+      end
     end
   
   end

data/test/application/test_minisip.rb

@@ -20,6 +20,21 @@ class TestMinisip < Test::Unit::TestCase
       assert @app.respond_to?(:compile)
     end
     
+    context "in the whole workflow" do
+      
+      setup do
+        Options.clear
+      end
+
+      should "remove the working directory when in root installation mode and using tmp" do
+        Options.this_user = false
+        Options.temp = true
+        
+        
+      end
+      
+    end # context "in the whole workflow"
+    
     context "in the Core component" do
 
       setup do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csd
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 1
-  - 10
-  version: 0.1.10
+  - 11
+  version: 0.1.11
 platform: ruby
 authors: 
 - Technology Transfer Alliance Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 +02:00
+date: 2010-08-04 00:00:00 +02:00
 default_executable: ai
 dependencies: []
 
@@ -41,6 +41,7 @@ files:
 - lib/csd/application/decklink.rb
 - lib/csd/application/decklink/about.yml
 - lib/csd/application/decklink/base.rb
+- lib/csd/application/decklink/options/install.rb
 - lib/csd/application/default.rb
 - lib/csd/application/default/base.rb
 - lib/csd/application/minisip.rb
@@ -57,6 +58,7 @@ files:
 - lib/csd/application/minisip/options/common.rb
 - lib/csd/application/minisip/options/compile.rb
 - lib/csd/application/minisip/options/package.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