Split 3rd-party-tool-dependant parts

git-svn-id: http://luarocks.org/svn/luarocks/trunk@9 9ca3f7c1-7366-0410-b1a3-b5c78f85698c

2 files changed, 544 insertions, 0 deletions

diff --git a/src/luarocks/fs/unix/tools.lua b/src/luarocks/fs/unix/tools.lua
new file mode 100644
index 00000000..fdec7869
--- /dev/null
+++ b/src/luarocks/fs/unix/tools.lua
@@ -0,0 +1,314 @@
+
+--- fs operations implemented with third-party tools for Unix platform abstractions.
+module("luarocks.fs.unix.tools", package.seeall)
+
+local fs = require("luarocks.fs")
+
+local cfg = require("luarocks.cfg")
+
+dir_stack = {}
+
+--- Run the given command.
+-- The command is executed in the current directory in the dir stack.
+-- @param cmd string: No quoting/escaping is applied to the command.
+-- @return boolean: true if command succeeds (status code 0), false
+-- otherwise.
+function execute_string(cmd)
+   if os.execute("cd " .. fs.Q(fs.current_dir()) .. " && " .. cmd) == 0 then
+      return true
+   else
+      return false
+   end
+end
+
+--- Obtain current directory.
+-- Uses the module's internal dir stack.
+-- @return string: the absolute pathname of the current directory.
+function current_dir()
+   local current = os.getenv("PWD")
+   if not current then
+      local pipe = io.popen("pwd")
+      current = pipe:read("*l")
+      pipe:close()
+   end
+   for _, d in ipairs(fs.dir_stack) do
+      current = fs.absolute_name(d, current)
+   end
+   return current
+end
+
+--- Change the current directory.
+-- Uses the module's internal dir stack. This does not have exact
+-- semantics of chdir, as it does not handle errors the same way,
+-- but works well for our purposes for now.
+-- @param d string: The directory to switch to.
+function change_dir(d)
+   assert(type(d) == "string")
+   table.insert(fs.dir_stack, d)
+end
+
+--- Change directory to root.
+-- Allows leaving a directory (e.g. for deleting it) in
+-- a crossplatform way.
+function change_dir_to_root()
+   table.insert(fs.dir_stack, "/")
+end
+
+--- Change working directory to the previous in the dir stack.
+function pop_dir()
+   local d = table.remove(fs.dir_stack)
+   return d ~= nil
+end
+
+--- Create a directory if it does not already exist.
+-- If any of the higher levels in the path name does not exist
+-- too, they are created as well.
+-- @param d string: pathname of directory to create.
+-- @return boolean: true on success, false on failure.
+function make_dir(d)
+   assert(d)
+   return fs.execute("mkdir -p", d)
+end
+
+--- Remove a directory if it is empty.
+-- Does not return errors (for example, if directory is not empty or
+-- if already does not exist)
+-- @param dir string: pathname of directory to remove.
+function remove_dir_if_empty(d)
+   assert(d)
+   fs.execute_string("rmdir "..fs.Q(d).." 1> /dev/null 2> /dev/null")
+end
+
+--- Copy a file.
+-- @param src string: Pathname of source
+-- @param dest string: Pathname of destination
+-- @return boolean or (boolean, string): true on success, false on failure,
+-- plus an error message.
+function copy(src, dest)
+   assert(src and dest)
+   if fs.execute("cp", src, dest) then
+      return true
+   else
+      return false, "Failed copying "..src.." to "..dest
+   end
+end
+
+--- Recursively copy the contents of a directory.
+-- @param src string: Pathname of source
+-- @param dest string: Pathname of destination
+-- @return boolean or (boolean, string): true on success, false on failure,
+-- plus an error message.
+function copy_contents(src, dest)
+   assert(src and dest)
+   if fs.execute_string("cp -pPR "..fs.Q(src).."/* "..fs.Q(dest).." 1> /dev/null 2>/dev/null") then
+      return true
+   else
+      return false, "Failed copying "..src.." to "..dest
+   end
+end
+--- Delete a file or a directory and all its contents.
+-- For safety, this only accepts absolute paths.
+-- @param arg string: Pathname of source
+-- @return boolean: true on success, false on failure.
+function delete(arg)
+   assert(arg)
+   assert(arg:sub(1,1) == "/")
+   return fs.execute_string("rm -rf " .. fs.Q(arg) .. " 1> /dev/null 2>/dev/null")
+end
+
+--- List the contents of a directory. 
+-- @param at string or nil: directory to list (will be the current
+-- directory if none is given).
+-- @return table: an array of strings with the filenames representing
+-- the contents of a directory.
+function list_dir(at)
+   assert(type(at) == "string" or not at)
+   if not at then
+      at = fs.current_dir()
+   end
+   if not fs.is_dir(at) then
+      return {}
+   end
+   local result = {}
+   local pipe = io.popen("cd "..fs.Q(at).." && ls")
+   for file in pipe:lines() do
+      table.insert(result, file)
+   end
+   pipe:close()
+   return result
+end
+
+--- Recursively scan the contents of a directory. 
+-- @param at string or nil: directory to scan (will be the current
+-- directory if none is given).
+-- @return table: an array of strings with the filenames representing
+-- the contents of a directory.
+function find(at)
+   assert(type(at) == "string" or not at)
+   if not at then
+      at = fs.current_dir()
+   end
+   if not fs.is_dir(at) then
+      return {}
+   end
+   local result = {}
+   local pipe = io.popen("cd "..fs.Q(at).." && find * 2>/dev/null") 
+   for file in pipe:lines() do
+      table.insert(result, file)
+   end
+   pipe:close()
+   return result
+end
+
+--- Compress files in a .zip archive.
+-- @param zipfile string: pathname of .zip archive to be created.
+-- @param ... Filenames to be stored in the archive are given as
+-- additional arguments.
+-- @return boolean: true on success, false on failure.
+function zip(zipfile, ...)
+   return fs.execute("zip -r", zipfile, ...)
+end
+
+--- Uncompress files from a .zip archive.
+-- @param zipfile string: pathname of .zip archive to be extracted.
+-- @return boolean: true on success, false on failure.
+function unzip(zipfile)
+   assert(zipfile)
+   return fs.execute("unzip", zipfile)
+end
+
+--- Test for existance of a file.
+-- @param file string: filename to test
+-- @return boolean: true if file exists, false otherwise.
+function exists(file)
+   assert(file)
+   return fs.execute("test -r", file)
+end
+
+--- Test is file/dir is writable.
+-- @param file string: filename to test
+-- @return boolean: true if file exists, false otherwise.
+function is_writable(file)
+   assert(file)
+   return fs.execute("test -w", file)
+end
+
+--- Test is pathname is a directory.
+-- @param file string: pathname to test
+-- @return boolean: true if it is a directory, false otherwise.
+function is_dir(file)
+   assert(file)
+   return fs.execute("test -d", file)
+end
+
+--- Test is pathname is a regular file.
+-- @param file string: pathname to test
+-- @return boolean: true if it is a regular file, false otherwise.
+function is_file(file)
+   assert(file)
+   return fs.execute("test -f", file)
+end
+
+--- Download a remote file.
+-- @param url string: URL to be fetched.
+-- @param filename string or nil: this function attempts to detect the
+-- resulting local filename of the remote file as the basename of the URL;
+-- if that is not correct (due to a redirection, for example), the local
+-- filename can be given explicitly as this second argument.
+-- @return boolean: true on success, false on failure.
+function download(url, filename)
+   assert(type(url) == "string")
+   assert(type(filename) == "string" or not filename)
+
+   if cfg.downloader == "wget" then
+      local wget_cmd = "wget --user-agent="..cfg.user_agent.." --quiet --continue "
+      if filename then
+         return fs.execute(wget_cmd.." --output-document ", filename, url)
+      else
+         return fs.execute(wget_cmd, url)
+      end
+   elseif cfg.downloader == "curl" then
+      filename = filename or dir.base_name(url)
+      return fs.execute_string("curl --user-agent "..cfg.user_agent.." "..fs.Q(url).." 2> /dev/null 1> "..fs.Q(filename))
+   end
+end
+
+function chmod(pathname, mode)
+  return fs.execute("chmod "..mode, pathname)
+end
+
+--- Apply a patch.
+-- @param patchname string: The filename of the patch.
+function apply_patch(patchname)
+   return fs.execute("patch -p1 -f -i ", patchname)
+end
+
+--- Unpack an archive.
+-- Extract the contents of an archive, detecting its format by
+-- filename extension.
+-- @param archive string: Filename of archive.
+-- @return boolean or (boolean, string): true on success, false and an error message on failure.
+function unpack_archive(archive)
+   assert(type(archive) == "string")
+
+   local ok
+   if archive:match("%.tar%.gz$") or archive:match("%.tgz$") then
+      -- ok = fs.execute("tar zxvpf ", archive)
+         ok = fs.execute_string("gunzip -c "..archive.."|tar -xf -")
+   elseif archive:match("%.tar%.bz2$") then
+      -- ok = fs.execute("tar jxvpf ", archive)
+         ok = fs.execute_string("bunzip2 -c "..archive.."|tar -xf -")
+   elseif archive:match("%.zip$") then
+      ok = fs.execute("unzip ", archive)
+   elseif archive:match("%.lua$") or archive:match("%.c$") then
+      -- Ignore .lua and .c files; they don't need to be extracted.
+      return true
+   else
+      local ext = archive:match(".*(%..*)")
+      return false, "Unrecognized filename extension "..(ext or "")
+   end
+   if not ok then
+      return false, "Failed extracting "..archive
+   end
+   return true
+end
+
+--- Check the MD5 checksum for a file.
+-- @param file string: The file to be checked.
+-- @param md5sum string: The string with the expected MD5 checksum.
+-- @return boolean: true if the MD5 checksum for 'file' equals 'md5sum', false if not
+-- or if it could not perform the check for any reason.
+function check_md5(file, md5sum)
+   file = fs.absolute_name(file)
+   local computed
+   if cfg.md5checker == "md5sum" then
+      local pipe = io.popen("md5sum "..file)
+      computed = pipe:read("*l"):gsub("[^%x]+", "")
+      pipe:close()
+      if computed then
+         computed = computed:sub(1,32)
+      end
+   elseif cfg.md5checker == "openssl" then
+      local pipe = io.popen("openssl md5 "..file)
+      computed = pipe:read("*l")
+      pipe:close()
+      if computed then
+         computed = computed:sub(-32)
+      end
+   elseif cfg.md5checker == "md5" then
+      local pipe = io.popen("md5 "..file)
+      computed = pipe:read("*l")
+      pipe:close()
+      if computed then
+         computed = computed:sub(-32)
+      end
+   end
+   if not computed then
+      return false
+   end
+   if computed:match("^"..md5sum) then
+      return true
+   else
+      return false
+   end
+end
diff --git a/src/luarocks/fs/win32/tools.lua b/src/luarocks/fs/win32/tools.lua
new file mode 100644
index 00000000..9f7b829b
--- /dev/null
+++ b/src/luarocks/fs/win32/tools.lua
@@ -0,0 +1,230 @@
+
+--- fs operations implemented with third-party tools for Windows platform abstractions.
+-- Download http://unxutils.sourceforge.net/ for Windows GNU utilities
+-- used by this module.
+module("luarocks.fs.win32.tools", package.seeall)
+
+local fs = require("luarocks.fs")
+
+local function command_at(directory, cmd)
+   local drive = directory:match("^([A-Za-z]:)")
+   cmd = "cd " .. fs.Q(directory) .. " & " .. cmd
+   if drive then
+      cmd = drive .. " & " .. cmd
+   end
+   return cmd
+end
+
+--- Test for existance of a file.
+-- @param file string: filename to test
+-- @return boolean: true if file exists, false otherwise.
+function exists(file)
+   assert(file)
+   return fs.execute("if not exist " .. fs.Q(file) ..
+                     " invalidcommandname 2>NUL 1>NUL")
+end
+
+--- Test is pathname is a directory.
+-- @param file string: pathname to test
+-- @return boolean: true if it is a directory, false otherwise.
+function is_dir(file)
+   assert(file)
+   return fs.execute("chdir /D " .. fs.Q(file) .. " 2>NUL 1>NUL")
+end
+
+--- Run the given command.
+-- The command is executed in the current directory in the dir stack.
+-- @param cmd string: No quoting/escaping is applied to the command.
+-- @return boolean: true if command succeeds (status code 0), false
+-- otherwise.
+function execute_string(cmd)
+   if os.execute(command_at(fs.current_dir(), cmd)) == 0 then
+      return true
+   else
+      return false
+   end
+end
+
+--- Test is pathname is a regular file.
+-- @param file string: pathname to test
+-- @return boolean: true if it is a regular file, false otherwise.
+function is_dir(file)
+   assert(file)
+   return fs.execute("test -d" .. fs.Q(file) .. " 2>NUL 1>NUL")
+end
+
+--- Create a directory if it does not already exist.
+-- If any of the higher levels in the path name does not exist
+-- too, they are created as well.
+-- @param d string: pathname of directory to create.
+-- @return boolean: true on success, false on failure.
+function make_dir(d)
+   assert(d)
+   fs.execute("mkdir "..fs.Q(d).." 1> NUL 2> NUL")
+   return 1
+end
+
+--- Remove a directory if it is empty.
+-- Does not return errors (for example, if directory is not empty or
+-- if already does not exist)
+-- @param d string: pathname of directory to remove.
+function remove_dir_if_empty(d)
+   assert(d)
+   fs.execute_string("rmdir "..fs.Q(d).." 1> NUL 2> NUL")
+end
+
+--- Copy a file.
+-- @param src string: Pathname of source
+-- @param dest string: Pathname of destination
+-- @return boolean or (boolean, string): true on success, false on failure,
+-- plus an error message.
+function copy(src, dest)
+   assert(src and dest)
+   if dest:match("[/\\]$") then dest = dest:sub(1, -2) end
+   if fs.execute("cp", src, dest) then
+      return true
+   else
+      return false, "Failed copying "..src.." to "..dest
+   end
+end
+
+--- Recursively copy the contents of a directory.
+-- @param src string: Pathname of source
+-- @param dest string: Pathname of destination
+-- @return boolean or (boolean, string): true on success, false on failure,
+-- plus an error message.
+function copy_contents(src, dest)
+   assert(src and dest)
+   if fs.execute_string("cp -a "..src.."\\*.* "..fs.Q(dest).." 1> NUL 2> NUL") then
+      return true
+   else
+      return false, "Failed copying "..src.." to "..dest
+   end
+end
+
+--- Delete a file or a directory and all its contents.
+-- For safety, this only accepts absolute paths.
+-- @param arg string: Pathname of source
+-- @return boolean: true on success, false on failure.
+function delete(arg)
+   assert(arg)
+   assert(arg:match("^[\a-zA-Z]?:?[\\/]"))
+   fs.execute("chmod a+rw -R ", arg)
+   return fs.execute_string("rm -rf " .. fs.Q(arg) .. " 1> NUL 2> NUL")
+end
+
+--- List the contents of a directory. 
+-- @param at string or nil: directory to list (will be the current
+-- directory if none is given).
+-- @return table: an array of strings with the filenames representing
+-- the contents of a directory.
+function list_dir(at)
+   assert(type(at) == "string" or not at)
+   if not at then
+      at = fs.current_dir()
+   end
+   if not fs.is_dir(at) then
+      return {}
+   end
+   local result = {}
+   local pipe = io.popen(command_at(at, "ls"))
+   for file in pipe:lines() do
+      table.insert(result, file)
+   end
+   pipe:close()
+
+   return result
+end
+
+--- Recursively scan the contents of a directory. 
+-- @param at string or nil: directory to scan (will be the current
+-- directory if none is given).
+-- @return table: an array of strings with the filenames representing
+-- the contents of a directory. Paths are returned with forward slashes.
+function find(at)
+   assert(type(at) == "string" or not at)
+   if not at then
+      at = fs.current_dir()
+   end
+   if not fs.is_dir(at) then
+      return {}
+   end
+   local result = {}
+   local pipe = io.popen(command_at(at, "find 2> NUL")) 
+   for file in pipe:lines() do
+      -- Windows find is a bit different
+      if file:sub(1,2)==".\\" then file=file:sub(3) end
+      if file ~= "." then
+         table.insert(result, (file:gsub("\\", "/")))
+      end
+   end
+   return result
+end
+
+--- Download a remote file.
+-- @param url string: URL to be fetched.
+-- @param filename string or nil: this function attempts to detect the
+-- resulting local filename of the remote file as the basename of the URL;
+-- if that is not correct (due to a redirection, for example), the local
+-- filename can be given explicitly as this second argument.
+-- @return boolean: true on success, false on failure.
+function download(url, filename)
+   assert(type(url) == "string")
+   assert(type(filename) == "string" or not filename)
+   local wget_cmd = "wget --user-agent="..cfg.user_agent.." --quiet --continue "
+
+   if filename then   
+      return fs.execute(wget_cmd.." --output-document ", filename, url)
+   else
+      return fs.execute(wget_cmd, url)
+   end
+end
+
+--- Uncompress gzip file.
+-- @param archive string: Filename of archive.
+-- @return boolean : success status
+local function gunzip(archive)
+   local cmd = fs.execute("gunzip -h 1>NUL 2>NUL") and 'gunzip' or
+               fs.execute("gzip   -h 1>NUL 2>NUL") and 'gzip -d'
+   local ok = fs.execute(cmd, archive)
+   return ok
+end
+
+--- Unpack an archive.
+-- Extract the contents of an archive, detecting its format by
+-- filename extension.
+-- @param archive string: Filename of archive.
+-- @return boolean or (boolean, string): true on success, false and an error message on failure.
+function unpack_archive(archive)
+   assert(type(archive) == "string")
+   
+   local ok
+   if archive:match("%.tar%.gz$") then
+      ok = gunzip(archive)
+      if ok then
+         ok = fs.execute("tar -xf ", strip_extension(archive))
+      end
+   elseif archive:match("%.tgz$") then
+      ok = gunzip(archive)
+      if ok then
+         ok = fs.execute("tar -xf ", strip_extension(archive)..".tar")
+      end
+   elseif archive:match("%.tar%.bz2$") then
+      ok = fs.execute("bunzip2 ", archive)
+      if ok then
+         ok = fs.execute("tar -xf ", strip_extension(archive))
+      end
+   elseif archive:match("%.zip$") then
+      ok = fs.execute("unzip ", archive)
+   elseif archive:match("%.lua$") or archive:match("%.c$") then
+      -- Ignore .lua and .c files; they don't need to be extracted.
+      return true
+   else
+      local ext = archive:match(".*(%..*)")
+      return false, "Unrecognized filename extension "..(ext or "")
+   end
+   if not ok then
+      return false, "Failed extracting "..archive
+   end
+   return true
+end