Class luci.fs

LuCI filesystem library.

Functions

access (str) Test for file access permission on given path.
basename (path) Return the last element - usually the filename - from the given path with the directory component stripped.
chmod (path, perm) Set permissions on given file or directory.
copy (source, dest) Copies a file.
dir (path) Return a table containing all entries of the specified directory.
dirname (path) Return the directory component of the given path with the last element stripped of.
glob (filename) Evaluate given shell glob pattern and return a table containing all matching file and directory entries.
isfile (filename) Checks wheather the given path exists and points to a regular file.
link (path1, path2, symlink) Create a hard- or symlink from given file (or directory) to specified target file (or directory) path.
mkdir (path, recursive) Create a new directory, recursively on demand.
mtime (path) Get the last modification time of given file path in Unix epoch format.
readfile (filename) Read the whole content of the given file into memory.
readlink (path) Retrieve target of given symlink.
rename (source, dest) Renames a file.
rmdir (path) Remove the given empty directory.
stat (path) Get information about given file or directory.
unlink (path) Remove the given file.
writefile (filename, data) Write the contents of given string to given file.


Functions

access (str)
Test for file access permission on given path.

Parameters

  • str: String value containing the path

Return values:

  1. Number containing the return code, 0 on sucess or nil on error
  2. String containing the error description (if any)
  3. Number containing the os specific errno (if any)
basename (path)
Return the last element - usually the filename - from the given path with the directory component stripped.

Parameters

  • path: String containing the path to strip

Return value:

String containing the base name of given path

See also:

chmod (path, perm)
Set permissions on given file or directory.

Parameters

  • path: String containing the path of the directory
  • perm: String containing the permissions to set ([ugoa][+-][rwx])

Return values:

  1. Number with the return code, 0 on sucess or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
copy (source, dest)
Copies a file.

Parameters

  • source: Source file
  • dest: Destination

Return value:

Boolean containing true on success or nil on error
dir (path)
Return a table containing all entries of the specified directory.

Parameters

  • path: String containing the path of the directory to scan

Return values:

  1. Table containing file and directory entries or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
dirname (path)
Return the directory component of the given path with the last element stripped of.

Parameters

  • path: String containing the path to strip

Return value:

String containing the directory component of given path

See also:

glob (filename)
Evaluate given shell glob pattern and return a table containing all matching file and directory entries.

Parameters

  • filename: String containing the path of the file to read

Return values:

  1. Table containing file and directory entries or nil if no matches
  2. String containing the error description (if no matches)
  3. Number containing the os specific errno (if no matches)
isfile (filename)
Checks wheather the given path exists and points to a regular file.

Parameters

  • filename: String containing the path of the file to read

Return value:

Boolean indicating wheather given path points to regular file
link (path1, path2, symlink)
Create a hard- or symlink from given file (or directory) to specified target file (or directory) path.

Parameters

  • path1: String containing the source path to link
  • path2: String containing the destination path for the link
  • symlink: Boolean indicating wheather to create a symlink (optional)

Return values:

  1. Number with the return code, 0 on sucess or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
mkdir (path, recursive)
Create a new directory, recursively on demand.

Parameters

  • path: String with the name or path of the directory to create
  • recursive: Create multiple directory levels (optional, default is true)

Return values:

  1. Number with the return code, 0 on sucess or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
mtime (path)
Get the last modification time of given file path in Unix epoch format.

Parameters

  • path: String containing the path of the file or directory to read

Return values:

  1. Number containing the epoch time or nil on error
  2. String containing the error description (if any)
  3. Number containing the os specific errno (if any)
readfile (filename)
Read the whole content of the given file into memory.

Parameters

  • filename: String containing the path of the file to read

Return values:

  1. String containing the file contents or nil on error
  2. String containing the error message on error
readlink (path)
Retrieve target of given symlink.

Parameters

  • path: String containing the path of the symlink to read

Return values:

  1. String containing the link target or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
rename (source, dest)
Renames a file.

Parameters

  • source: Source file
  • dest: Destination

Return value:

Boolean containing true on success or nil on error
rmdir (path)
Remove the given empty directory.

Parameters

  • path: String containing the path of the directory to remove

Return values:

  1. Number with the return code, 0 on sucess or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
stat (path)
Get information about given file or directory.

Parameters

  • path: String containing the path of the directory to query

Return values:

  1. Table containing file or directory properties or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
unlink (path)
Remove the given file.

Parameters

  • path: String containing the path of the file to remove

Return values:

  1. Number with the return code, 0 on sucess or nil on error
  2. String containing the error description on error
  3. Number containing the os specific errno on error
writefile (filename, data)
Write the contents of given string to given file.

Parameters

  • filename: String containing the path of the file to read
  • data: String containing the data to write

Return values:

  1. Boolean containing true on success or nil on error
  2. String containing the error message on error

Valid XHTML 1.0!