Module luarocks.fs.lua
Native Lua implementation of filesystem and platform abstractions, using LuaFileSystem, LZLib, MD5 and LuaCurl.
Functions
| Q (arg) | Quote argument for shell processing. |
| is_writable (file) | Test is file/dir is writable. |
| make_temp_dir (name) | Create a temporary directory. |
| execute (command, ...) | Run the given command, quoting its arguments. |
| check_md5 (file, md5sum) | Check the MD5 checksum for a file. |
| execute_string (cmd) | Run the given command. |
| current_dir () | Obtain current directory. |
| change_dir (d) | Change the current directory. |
| change_dir_to_root () | Change directory to root. |
| pop_dir () | Change working directory to the previous in the dir stack. |
| make_dir (directory) | Create a directory if it does not already exist. |
| remove_dir_if_empty (d) | Remove a directory if it is empty. |
| remove_dir_tree_if_empty (d) | Remove a directory if it is empty. |
| copy (src, dest) | Copy a file. |
| copy_contents (src, dest) | Recursively copy the contents of a directory. |
| delete (arg) | Delete a file or a directory and all its contents. |
| list_dir (at) | List the contents of a directory. |
| find (at) | Recursively scan the contents of a directory. |
| exists (file) | Test for existance of a file. |
| is_dir (file) | Test is pathname is a directory. |
| is_file (file) | Test is pathname is a regular file. |
| unzip (zipfile) | Uncompress files from a .zip archive. |
| download (url, filename) | Download a remote file. |
| download (url, filename) | Download a remote file. |
| get_md5 (file) | Get the MD5 checksum for a file. |
| apply_patch (patchname, patchdata) | Apply a patch. |
| move (src, dest) | Move a file. |
Functions
- Q (arg)
-
Quote argument for shell processing.
Adds single quotes and escapes.
Parameters:
arg: string: Unquoted argument.
Returns:
-
string: Quoted argument.
- is_writable (file)
-
Test is file/dir is writable.
Warning: testing if a file/dir is writable does not guarantee
that it will remain writable and therefore it is no replacement
for checking the result of subsequent operations.
Parameters:
file: string: filename to test
Returns:
-
boolean: true if file exists, false otherwise.
- make_temp_dir (name)
-
Create a temporary directory.
Parameters:
name: string: name pattern to use for avoiding conflicts when creating temporary directory.
Returns:
-
string or nil: name of temporary directory or nil on failure.
- execute (command, ...)
-
Run the given command, quoting its arguments.
The command is executed in the current directory in the dir stack.
Parameters:
command: string: The command to be executed. No quoting/escaping is applied....: Strings containing additional arguments, which are quoted.
Returns:
-
boolean: true if command succeeds (status code 0), false
otherwise.
- check_md5 (file, md5sum)
-
Check the MD5 checksum for a file.
Parameters:
file: string: The file to be checked.md5sum: string: The string with the expected MD5 checksum.
Returns:
-
boolean: true if the MD5 checksum for 'file' equals 'md5sum', false if not
or if it could not perform the check for any reason.
- execute_string (cmd)
-
Run the given command.
The command is executed in the current directory in the dir stack.
Parameters:
cmd: string: No quoting/escaping is applied to the command.
Returns:
-
boolean: true if command succeeds (status code 0), false
otherwise.
- current_dir ()
-
Obtain current directory.
Uses the module's internal dir stack.
Returns:
-
string: the absolute pathname of the current directory.
- change_dir (d)
-
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.
Parameters:
d: string: The directory to switch to.
- change_dir_to_root ()
- Change directory to root. Allows leaving a directory (e.g. for deleting it) in a crossplatform way.
- pop_dir ()
-
Change working directory to the previous in the dir stack.
Returns:
-
true if a pop ocurred, false if the stack was empty.
- make_dir (directory)
-
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.
Parameters:
directory: string: pathname of directory to create.
Returns:
-
boolean: true on success, false on failure.
- remove_dir_if_empty (d)
-
Remove a directory if it is empty.
Does not return errors (for example, if directory is not empty or
if already does not exist)
Parameters:
d: string: pathname of directory to remove.
- remove_dir_tree_if_empty (d)
-
Remove a directory if it is empty.
Does not return errors (for example, if directory is not empty or
if already does not exist)
Parameters:
d: string: pathname of directory to remove.
- copy (src, dest)
-
Copy a file.
Parameters:
src: string: Pathname of sourcedest: string: Pathname of destination
Returns:
-
boolean or (boolean, string): true on success, false on failure,
plus an error message.
- copy_contents (src, dest)
-
Recursively copy the contents of a directory.
Parameters:
src: string: Pathname of sourcedest: string: Pathname of destination
Returns:
-
boolean or (boolean, string): true on success, false on failure,
plus an error message.
- delete (arg)
-
Delete a file or a directory and all its contents.
For safety, this only accepts absolute paths.
Parameters:
arg: string: Pathname of source
Returns:
-
boolean: true on success, false on failure.
- list_dir (at)
-
List the contents of a directory.
Parameters:
at: string or nil: directory to list (will be the current directory if none is given).
Returns:
-
table: an array of strings with the filenames representing
the contents of a directory.
- find (at)
-
Recursively scan the contents of a directory.
Parameters:
at: string or nil: directory to scan (will be the current directory if none is given).
Returns:
-
table: an array of strings with the filenames representing
the contents of a directory.
- exists (file)
-
Test for existance of a file.
Parameters:
file: string: filename to test
Returns:
-
boolean: true if file exists, false otherwise.
- is_dir (file)
-
Test is pathname is a directory.
Parameters:
file: string: pathname to test
Returns:
-
boolean: true if it is a directory, false otherwise.
- is_file (file)
-
Test is pathname is a regular file.
Parameters:
file: string: pathname to test
Returns:
-
boolean: true if it is a file, false otherwise.
- unzip (zipfile)
-
Uncompress files from a .zip archive.
Parameters:
zipfile: string: pathname of .zip archive to be extracted.
Returns:
-
boolean: true on success, false on failure.
- download (url, filename)
-
Download a remote file.
Parameters:
url: string: URL to be fetched.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.
Returns:
-
boolean: true on success, false on failure.
- download (url, filename)
-
Download a remote file.
Parameters:
url: string: URL to be fetched.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.
Returns:
-
boolean: true on success, false on failure.
[[
- get_md5 (file)
-
Get the MD5 checksum for a file.
Parameters:
file: string: The file to be computed.
Returns:
-
string: The MD5 checksum
- apply_patch (patchname, patchdata)
-
Apply a patch.
Parameters:
patchname: string: The filename of the patch.patchdata:
- move (src, dest)
-
Move a file.
Parameters:
src: string: Pathname of sourcedest: string: Pathname of destination
Returns:
-
boolean or (boolean, string): true on success, false on failure,
plus an error message.