flashplayer-task 0.1.0

data/lib/sprout/flash_player_task.rb

@@ -0,0 +1,319 @@
+=begin
+Copyright (c) 2007 Pattern Park
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+=end
+require 'sprout'
+
+module Sprout
+  class FlashPlayerError < StandardError; end
+
+  class FlashPlayerTask < Rake::Task
+    DEFAULT_VERSION = '>= 9.60.0'
+    EXECUTABLE_NAME = 'flashplayer'
+    
+    @@test_result_pre_delimiter = '<XMLResultPrinter>'
+    @@test_result_post_delimiter = '</XMLResultPrinter>'
+    @@home = nil
+    @@trust = nil
+
+    attr_accessor :version,
+                  :name,
+                  :swf,
+                  :test_result_file
+
+    def FlashPlayerTask.define_task(args, &block)
+      t = super
+      yield t if block_given?
+      t.define
+    end
+
+    def FlashPlayerTask.trust
+      if(@@trust)
+        return @@trust
+      end
+      @@trust = File.join(FlashPlayerTask.home, '#Security', 'FlashPlayerTrust', 'sprout.cfg')
+      return @@trust
+    end
+
+    def FlashPlayerTask.home
+      if(@@home)
+        return @@home
+      end
+
+      FlashPlayerTask.home_paths.each do |path|
+        if(File.exists?(path))
+          return @@home = path
+        end
+      end
+
+      if(@@home.nil?)
+        raise FlashPlayerError.new('FlashPlayer unable to find home folder for your platform')
+      end
+      return @@home
+    end
+
+    # Enumerate the potential locations of the Flash Player Home
+    # For each supported Platform, the first existing location
+    # will be used.
+    def FlashPlayerTask.home_paths
+      return [File.join(User.library, 'Preferences', 'Macromedia', 'Flash Player'),
+              File.join(User.library, 'Application Support', 'Macromedia'),
+              File.join(User.home, 'Application Data', 'Macromedia', 'Flash Player'),
+              File.join(User.home, '.macromedia', 'Flash_Player')]
+    end
+
+    def initialize(task_name, app)
+      super(task_name, app)
+      @version = DEFAULT_VERSION
+      @inside_test_result = false
+      @test_result = ''
+    end
+
+    def execute
+      log_file = nil
+
+      # Don't let trust or log file failures break other features...
+#      begin
+        log_file = FlashPlayerConfig.new().log
+#        FlashPlayerTrust.new(File.dirname(@swf))
+
+        if(File.exists?(log_file))
+          File.open(log_file, 'w') do |f|
+            f.write('')
+          end
+        else
+          FileUtils.mkdir_p(File.dirname(log_file))
+          FileUtils.touch(log_file)
+        end
+
+#      rescue
+#        puts '[WARNING] FlashPlayer encountered an error working with the mm.cfg log and/or editing the Trust file'
+#      end
+
+      @running_process = nil
+      thread = run(EXECUTABLE_NAME, version, swf)
+      read_log(thread, log_file)
+      thread.join
+    end
+    
+    def close
+      Process.kill("SIGALRM", @player_pid)
+    end
+
+    def run(tool, version, swf)
+      puts "execute flash player now!"
+
+      usr = User.new()
+      target = Sprout.get_executable(tool, nil, version)
+      
+      puts "target #{target}"
+      target = User.clean_path(target)
+
+      @player_pid = nil
+      @swf_pid = nil
+      @parent_pid = nil
+      
+      if(usr.is_a?(OSXUser))
+        return Thread.new {
+          @player_pid = Process.fork do
+            exec(target)
+          end
+          @swf_pid = Process.fork do
+             exec("open #{swf}")
+          end
+          Process.waitpid(@player_pid)
+        }
+      else
+        return Thread.new {
+          @player_pid = exec("#{target} ./#{swf}")
+#            IO.popen("#{target} ./#{swf}") do |p|
+#            end
+        }
+      end
+
+    end
+    
+    def define
+      task @name => [@swf]
+
+      if(@test_result_file)
+        CLEAN.add(@test_result_file)
+      end
+    end
+
+    def read_log(thread, log_file)
+      lines_put = 0
+
+      if(!File.exists?(log_file))
+        raise FlashPlayerError.new('[ERROR] Unable to find the trace output log file in the expected location: ' + log_file)
+      end
+
+      while(thread.alive?)
+        sleep(0.2)
+        lines_read = 0
+
+        File.open(log_file, 'r') do |file|
+          file.readlines.each do |line|
+            lines_read = lines_read + 1
+            if(lines_read > lines_put)
+              puts "[trace] #{line}"
+              parse_test_result(line, thread)
+              $stdout.flush
+              lines_put = lines_put + 1
+            end
+          end
+        end
+      end
+    end
+      
+    def parse_test_result(line, thread)
+      if(test_result_file.nil?)
+        return
+      end
+      
+      if(@inside_test_result)
+        if(line.index(@@test_result_post_delimiter))
+          @inside_test_result = false
+          write_test_result(@test_result)
+          close
+        else
+          @test_result << line
+        end
+      end
+
+      if(line.index(@@test_result_pre_delimiter))
+        @inside_test_result = true
+      end
+    end
+      
+    def write_test_result(result)
+      FileUtils.makedirs(File.dirname(test_result_file))
+      File.open(test_result_file, File::CREAT|File::TRUNC|File::RDWR) do |f|
+        f.puts(result)
+      end
+    end
+  end
+
+  ##########################################
+  # FlashPlayerConfig Class
+
+  class FlashPlayerConfig
+
+    @@file_name = 'mm.cfg'
+
+    def initialize
+      osx_fp9 = File.join(User.library, 'Application Support', 'Macromedia')
+      if(FlashPlayerTask.home == osx_fp9)
+        @config = File.join(osx_fp9, @@file_name)
+      else
+        @config = File.join(User.home, @@file_name)
+      end
+      
+      if(!File.exists?(@config))
+        write_config(@config, content)
+      end
+    end
+
+    def log
+      path = File.join(FlashPlayerTask.home, 'Logs', 'flashlog.txt')
+      if(User.new().is_a?(CygwinUser))
+        parts = path.split("/")
+        parts.shift()
+        part = parts.shift() # shift cygdrive
+        if(part != 'cygdrive')
+          Log.puts "[WARNING] There may have been a problem writing mm.cfg, please check the path in #{@config} and make sure it's a windows path..."
+          return path
+        end
+        drive = parts.shift()
+        parts.unshift(drive.upcase + ":")
+        path = parts.join("/")
+      end
+      return path
+    end
+
+    def content
+      return <<EOF
+ErrorReportingEnable=1
+MaxWarnings=0
+TraceOutputEnable=1
+TraceOutputFileName=#{log}
+EOF
+    end
+
+    private
+    def write_config(location, content)
+      puts <<EOF
+
+Correctly configured mm.cfg file not found at: #{location}
+
+This file is required in order to capture trace output.
+
+Would you like this file created automatically? [Yn]
+
+EOF
+      answer = $stdin.gets.chomp.downcase
+      if(answer == 'y' || answer == '')
+        File.open(location, 'w') do |f|
+          f.write(content)
+        end
+        Log.puts ">> Created file: " + File.expand_path(location)
+      else
+        raise FlashPlayerError.new("[ERROR] Unable to create mm.cfg file at: #{location}")
+      end
+    end
+  end
+
+  ##########################################
+  # FlashPlayerTrust Class
+
+  class FlashPlayerTrust
+
+    def initialize(path)
+      trust_file = FlashPlayerTask.trust
+      if(!File.exists?(trust_file))
+        FileUtils.touch(trust_file)
+      end
+
+      parts = path.split(File::SEPARATOR)
+      if(parts.size == 1)
+        path = File::SEPARATOR + path
+      end
+
+      if(!has_path?(trust_file, path))
+        File.open(trust_file, 'a') do |f|
+          f.puts path
+        end
+        Log.puts ">> Added #{path} to Flash Player Trust file at: #{trust_file}"
+      end
+    end
+
+    def has_path?(file, path)
+      File.open(file, 'r') do |f|
+        return (f.read.index(path))
+      end
+    end
+  end
+
+end
+
+def flash_player(args, &block)
+  Sprout::FlashPlayerTask.define_task(args, &block)
+end

data/lib/sprout/flash_player_task/version.rb

@@ -0,0 +1,12 @@
+module Sprout
+  class FlashPlayerTask
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+      MAJOR_MINOR = [MAJOR, MINOR].join('.')
+    end
+  end
+end

data/sample/rakefile.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+# Run the flash player task from version control:
+require File.dirname(__FILE__) + '/../lib/sprout/flashplayertask'
+
+# Run the installed version:
+#require 'sprout/flashplayertask'
+
+# To run the sample:
+# 1) Open a terminal
+# 2) cd into the directory that contains this file
+# 3) run 'rake'
+# 4) the flash player should block the shell input and launch in your os
+# 5) Close the flash player and you should return to the shell
+
+# Make the default (no-name)
+# rake task compile using mxmlc
+task :default => :run
+
+desc "Launch a swf with the Flash Player"
+flash_player :run do |t|
+  t.swf = 'bin/SomeProject.swf'
+  t.version = '>= 9.60.0' # Default value is: '>= 9.115.0'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: flashplayer-task
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-12-28 00:00:00 -08:00
+summary: Flash Player Task provides rake tasks to launch and close SWF files in the Adobe Flash Player
+require_paths: 
+- lib
+email: projectsprouts@googlegroups.com
+homepage: http://www.projectsprouts.org
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Luke Bayes
+files: 
+- lib/sprout
+- lib/sprout/flash_player_task
+- lib/sprout/flash_player_task/version.rb
+- lib/sprout/flash_player_task.rb
+- sample/bin
+- sample/bin/SomeProject.swf
+- sample/rakefile.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sprout
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.1
+    version: