fig 0.1.77 → 0.1.79

data/lib/fig/grammar/v1.treetop

@@ -45,29 +45,29 @@ module Fig
       end
 
       rule archive
-        statement_start:'archive' ws_or_comment+ url:asset_url {
+        statement_start:'archive' ws_or_comment+ location:asset_location {
           def to_package_statement(build_state)
             return build_state.new_asset_statement(
-              Statement::Archive, statement_start, url
+              Statement::Archive, statement_start, location
             )
           end
         }
       end
 
       rule resource
-        statement_start:'resource' ws_or_comment+ url:asset_url {
+        statement_start:'resource' ws_or_comment+ location:asset_location {
           def to_package_statement(build_state)
             return build_state.new_asset_statement(
-              Statement::Resource, statement_start, url
+              Statement::Resource, statement_start, location
             )
           end
         }
       end
 
-      rule asset_url
-        '"' [^"]* '"' /
-        "'" [^']* "'" /
-        [\S]+
+      rule asset_location
+        '"' ( [^"\\] / '\\' . )* '"' /
+        "'" ( [^'\\] / '\\' . )* "'" /
+        [^\s#]+
       end
 
       rule retrieve
@@ -79,6 +79,8 @@ module Fig
       end
 
       rule retrieve_path
+        # TODO: this should match asset location rules, but handling of
+        # "[package]" substitution is going to be interesting.
         [a-zA-Z0-9_/.\[\]-]+
       end
 
@@ -130,44 +132,54 @@ module Fig
         }
       end
 
-      rule path
-        statement_start:('add' / 'append' / 'path') ws_or_comment+ name_value:[\S]+ {
+      rule environment_variable_name
+        [a-zA-Z0-9_]+
+      end
+
+      rule set
+        statement_start:'set' ws_or_comment+ environment_variable_name_value {
           def to_config_statement(build_state)
             return build_state.new_environment_variable_statement(
-              Statement::Path, statement_start, name_value
+              Statement::Set, statement_start, environment_variable_name_value
             )
           end
         }
       end
 
-      rule environment_variable_name
-        [a-zA-Z0-9_]+
-      end
-
-      rule set
-        statement_start:'set' ws_or_comment+ name_value:[\S]+ {
+      rule path
+        statement_start:('add' / 'append' / 'path') ws_or_comment+ environment_variable_name_value {
           def to_config_statement(build_state)
             return build_state.new_environment_variable_statement(
-              Statement::Set, statement_start, name_value
+              Statement::Path, statement_start, environment_variable_name_value
             )
           end
         }
       end
 
+      rule environment_variable_name_value
+        # Should result in somewhat reasonable handling by Treetop when
+        # encountering mis-quoted constructs.
+        [^\s#\\"]* '"' ( [^"\\] / '\\' . )* '"' /
+        [^\s#\\']* "'" ( [^'\\] / '\\' . )* "'" /
+        [^\s#]+
+      end
+
       rule command
-        statement_start:'command' ws_or_comment+ string {
+        statement_start:'command' ws_or_comment+ command_line {
           def to_config_statement(build_state)
-            return build_state.new_command_statement(statement_start, string)
+            return build_state.new_command_statement(
+              statement_start, command_line
+            )
           end
         }
       end
 
-      rule string
+      rule command_line
         '"' value:[^"]* '"'
       end
 
       rule descriptor_string
-        [\S]+
+        [^\s#]+
       end
     end
   end

data/lib/fig/operating_system.rb

@@ -1,3 +1,4 @@
+require 'cgi'
 require 'fileutils'
 require 'find'
 # Must specify absolute path of ::Archive when using
@@ -16,15 +17,54 @@ require 'highline/import'
 require 'fig/at_exit'
 require 'fig/environment_variables/case_insensitive'
 require 'fig/environment_variables/case_sensitive'
+require 'fig/file_not_found_error'
 require 'fig/logging'
 require 'fig/network_error'
-require 'fig/not_found_error'
 
 module Fig; end
 
 # Does things requiring real O/S interaction, primarilly taking care of file
 # transfers and running external commands.
 class Fig::OperatingSystem
+  WINDOWS_FILE_NAME_ILLEGAL_CHARACTERS = %w[ \\ / : * ? " < > | ]
+  UNIX_FILE_NAME_ILLEGAL_CHARACTERS    = %w[ / ]
+
+  def self.windows?
+    RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+  end
+
+  def self.java?
+    RUBY_PLATFORM == 'java'
+  end
+
+  def self.unix?
+    !windows?
+  end
+
+  def self.file_name_illegal_characters()
+    if Fig::OperatingSystem.windows?
+      return WINDOWS_FILE_NAME_ILLEGAL_CHARACTERS
+    end
+
+    return UNIX_FILE_NAME_ILLEGAL_CHARACTERS
+  end
+
+  def self.wrap_variable_name_with_shell_expansion(variable_name)
+    if Fig::OperatingSystem.windows?
+      return "%#{variable_name}%"
+    else
+      return "$#{variable_name}"
+    end
+  end
+
+  def self.get_environment_variables(initial_values = nil)
+    if Fig::OperatingSystem.windows?
+      return Fig::EnvironmentVariables::CaseInsensitive.new(initial_values)
+    end
+
+    return Fig::EnvironmentVariables::CaseSensitive.new(initial_values)
+  end
+
   def initialize(login)
     @login = login
     @username = ENV['FIG_USERNAME']
@@ -67,10 +107,6 @@ class Fig::OperatingSystem
     File.open(path, 'wb') { |f| f.binmode; f << content }
   end
 
-  SUCCESS = 0
-  NOT_MODIFIED = 3
-  NOT_FOUND = 4
-
   def strip_paths_for_list(ls_output, packages, path)
     if not ls_output.nil?
       ls_output = ls_output.gsub(path + '/', '').gsub(path, '').split("\n")
@@ -106,12 +142,13 @@ class Fig::OperatingSystem
       packages
     when 'file'
       packages = []
-      return packages if ! File.exist?(uri.path)
+      unescaped_path = CGI.unescape uri.path
+      return packages if ! File.exist?(unescaped_path)
 
       ls = ''
-      Find.find(uri.path) { |file| ls << file.to_s; ls << "\n" }
+      Find.find(unescaped_path) { |file| ls << file.to_s; ls << "\n" }
 
-      strip_paths_for_list(ls, packages, uri.path)
+      strip_paths_for_list(ls, packages, unescaped_path)
       return packages
     else
       Fig::Logging.fatal "Protocol not supported: #{url}"
@@ -158,6 +195,49 @@ class Fig::OperatingSystem
     all_packages.flatten.sort
   end
 
+  # Determine whether we need to update something.  Returns nil to indicate
+  # "don't know".
+  def path_up_to_date?(url, path)
+    return false if ! File.exist? path
+
+    uri = URI.parse(url)
+    case uri.scheme
+    when 'ftp'
+      begin
+        ftp = Net::FTP.new(uri.host)
+        ftp_login(ftp, uri.host)
+
+        if ftp.mtime(uri.path) <= File.mtime(path)
+          return true
+        end
+
+        return false
+      rescue Net::FTPPermError => error
+        Fig::Logging.debug error.message
+        raise Fig::FileNotFoundError.new error.message, url
+      rescue SocketError => error
+        Fig::Logging.debug error.message
+        raise Fig::FileNotFoundError.new error.message, url
+      end
+    when 'http'
+      return nil # Not implemented
+    when 'ssh'
+    when 'file'
+      begin
+        unescaped_path = CGI.unescape uri.path
+        if File.mtime(unescaped_path) <= File.mtime(path)
+          return true
+        end
+
+        return false
+      rescue Errno::ENOENT => error
+        raise Fig::FileNotFoundError.new error.message, url
+      end
+    else
+      raise_unknown_protocol(url)
+    end
+  end
+
   # Returns whether the file was not downloaded because the file already
   # exists and is already up-to-date.
   def download(url, path)
@@ -179,10 +259,10 @@ class Fig::OperatingSystem
         end
       rescue Net::FTPPermError => error
         Fig::Logging.debug error.message
-        raise Fig::NotFoundError.new error.message, url
+        raise Fig::FileNotFoundError.new error.message, url
       rescue SocketError => error
         Fig::Logging.debug error.message
-        raise Fig::NotFoundError.new error.message, url
+        raise Fig::FileNotFoundError.new error.message, url
       end
     when 'http'
       log_download(url, path)
@@ -193,29 +273,29 @@ class Fig::OperatingSystem
           download_via_http_get(url, file)
         rescue SystemCallError => error
           Fig::Logging.debug error.message
-          raise Fig::NotFoundError.new error.message, url
+          raise Fig::FileNotFoundError.new error.message, url
         rescue SocketError => error
           Fig::Logging.debug error.message
-          raise Fig::NotFoundError.new error.message, url
+          raise Fig::FileNotFoundError.new error.message, url
         end
       end
     when 'ssh'
       # TODO need better way to do conditional download
       timestamp = File.exist?(path) ? File.mtime(path).to_i : 0
       # Requires that remote installation of fig be at the same location as the local machine.
-      cmd = `which fig-download`.strip + " #{timestamp} #{uri.path}"
+      command = `which fig-download`.strip + " #{timestamp} #{uri.path}"
       log_download(url, path)
-      ssh_download(uri.user, uri.host, path, cmd)
+      ssh_download(uri.user, uri.host, path, command)
     when 'file'
       begin
-        FileUtils.cp(uri.path, path)
+        unescaped_path = CGI.unescape uri.path
+        FileUtils.cp(unescaped_path, path)
         return true
       rescue Errno::ENOENT => error
-        raise Fig::NotFoundError.new error.message, url
+        raise Fig::FileNotFoundError.new error.message, url
       end
     else
-      Fig::Logging.fatal "Unknown protocol: #{url}"
-      raise Fig::NetworkError.new("Unknown protocol: #{url}")
+      raise_unknown_protocol(url)
     end
   end
 
@@ -223,7 +303,7 @@ class Fig::OperatingSystem
   def download_resource(url, download_directory)
     FileUtils.mkdir_p(download_directory)
 
-    basename = URI.parse(url).path.split('/').last
+    basename = CGI.unescape URI.parse(url).path.split('/').last
     path     = File.join(download_directory, basename)
 
     download(url, path)
@@ -234,7 +314,7 @@ class Fig::OperatingSystem
   def download_and_unpack_archive(url, download_directory)
     basename, path = download_resource(url, download_directory)
 
-    case basename
+    case path
     when /\.tar\.gz$/
       unpack_archive(download_directory, path)
     when /\.tgz$/
@@ -265,8 +345,8 @@ class Fig::OperatingSystem
       ftp_root_dirs = ftp_uri.path.split('/')
       remote_publish_path = uri.path[0, uri.path.rindex('/')]
       remote_publish_dirs = remote_publish_path.split('/')
-      # Use array subtraction to deduce which project/version folder to upload to,
-      # i.e. [1,2,3] - [2,3,4] = [1]
+      # Use array subtraction to deduce which project/version folder to upload
+      # to, i.e. [1,2,3] - [2,3,4] = [1]
       remote_project_dirs = remote_publish_dirs - ftp_root_dirs
       Net::FTP.open(uri.host) do |ftp|
         ftp_login(ftp, uri.host)
@@ -284,11 +364,11 @@ class Fig::OperatingSystem
         ftp.putbinaryfile(local_file)
       end
     when 'file'
-      FileUtils.mkdir_p(File.dirname(uri.path))
-      FileUtils.cp(local_file, uri.path)
+      unescaped_path = CGI.unescape uri.path
+      FileUtils.mkdir_p(File.dirname(unescaped_path))
+      FileUtils.cp(local_file, unescaped_path)
     else
-      Fig::Logging.fatal "Unknown protocol: #{uri}"
-      raise Fig::NetworkError.new("Unknown protocol: #{uri}")
+      raise_unknown_protocol(uri)
     end
   end
 
@@ -370,58 +450,48 @@ class Fig::OperatingSystem
     end
   end
 
-  def self.windows?
-    RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
-  end
-
-  def self.java?
-    RUBY_PLATFORM == 'java'
-  end
-
-  def self.unix?
-    !windows?
+  def shell_exec(command)
+    if Fig::OperatingSystem.windows?
+      plain_exec( [ ENV['ComSpec'], '/c', command.join(' ') ] )
+    else
+      plain_exec( [ ENV['SHELL'],   '-c', command.join(' ') ] )
+    end
   end
 
-  def shell_exec(cmd)
+  def plain_exec(command)
     # Kernel#exec won't run Kernel#at_exit handlers.
     Fig::AtExit.execute()
     if ENV['FIG_COVERAGE']
       SimpleCov.at_exit.call
     end
 
-    if Fig::OperatingSystem.windows?
-      Kernel.exec(ENV['ComSpec'], '/c', cmd.join(' '))
-    else
-      Kernel.exec(ENV['SHELL'], '-c', cmd.join(' '))
-    end
+    Kernel.exec(*command)
   end
 
-  def self.wrap_variable_name_with_shell_expansion(variable_name)
-    if Fig::OperatingSystem.windows?
-      return "%#{variable_name}%"
+  # *sigh* Apparently Ruby < v1.9.3 does some wacko thing with single argument
+  # exec that causes it to not invoke the shell, so we've got this mess.
+  def plain_or_shell_exec(command)
+    if command.size > 1
+      plain_exec(command)
     else
-      return "$#{variable_name}"
+      shell_exec(command)
     end
   end
 
-  def self.get_environment_variables(initial_values = nil)
-    if Fig::OperatingSystem.windows?
-      return Fig::EnvironmentVariables::CaseInsensitive.new(initial_values)
-    end
-
-    return Fig::EnvironmentVariables::CaseSensitive.new(initial_values)
-  end
-
   private
 
+  SUCCESS = 0
+  NOT_MODIFIED = 3
+  NOT_FOUND = 4
+
   # path = The local path the file should be downloaded to.
-  # cmd = The command to be run on the remote host.
-  def ssh_download(user, host, path, cmd)
+  # command = The command to be run on the remote host.
+  def ssh_download(user, host, path, command)
     return_code = nil
     tempfile = Tempfile.new('tmp')
     Net::SSH.start(host, user) do |ssh|
       ssh.open_channel do |channel|
-        channel.exec(cmd)
+        channel.exec(command)
         channel.on_data() { |ch, data| tempfile << data }
         channel.on_extended_data() { |ch, type, data| Fig::Logging.error "SSH Download ERROR: #{data}" }
         channel.on_request('exit-status') { |ch, request|
@@ -438,7 +508,7 @@ class Fig::OperatingSystem
       return false
     when NOT_FOUND
       tempfile.delete
-      raise Fig::NotFoundError.new 'Remote path not found', path
+      raise Fig::FileNotFoundError.new 'Remote path not found', path
     when SUCCESS
       FileUtils.mv(tempfile.path, path)
       return true
@@ -463,7 +533,7 @@ class Fig::OperatingSystem
   def download_via_http_get(uri_string, file, redirection_limit = 10)
     if redirection_limit < 1
       Fig::Logging.debug 'Too many HTTP redirects.'
-      raise Fig::NotFoundError.new 'Too many HTTP redirects.', uri_string
+      raise Fig::FileNotFoundError.new 'Too many HTTP redirects.', uri_string
     end
 
     response = Net::HTTP.get_response(URI(uri_string))
@@ -477,7 +547,7 @@ class Fig::OperatingSystem
       download_via_http_get(location, file, limit - 1)
     else
       Fig::Logging.debug "Download failed: #{response.code} #{response.message}."
-      raise Fig::NotFoundError.new(
+      raise Fig::FileNotFoundError.new(
         "Download failed: #{response.code} #{response.message}.", uri_string
       )
     end
@@ -485,6 +555,15 @@ class Fig::OperatingSystem
     return
   end
 
+  def raise_unknown_protocol(url)
+    Fig::Logging.fatal %Q<Don't know how to handle the protocol in "#{url}".>
+    raise Fig::NetworkError.new(
+      %Q<Don't know how to handle the protocol in "#{url}".>
+    )
+
+    return
+  end
+
   def log_download(url, path)
     Fig::Logging.debug "Downloading #{url} to #{path}."
   end