Update for release 1.7.0.

Do not redefine or reimplement standard Lua C API function
luaL_newlib, use another name (new_lib) instead.

.travis.yml

@@ -7,16 +7,16 @@ env:
   - LUA="lua 5.2"
   - LUA="lua 5.3"
   - LUA="luajit 2.0"
+  - LUA="luajit 2.1"
 
 before_install:
   - pip install --user cpp-coveralls hererocks
   - hererocks env --$LUA --luarocks latest
   - export PATH="$PWD/env/bin:$PATH"
-  - luarocks install Lua-cURL --server=https://luarocks.org/dev
   - luarocks install lua-path 
-  - luarocks install lua-cjson 
+  - luarocks install dkjson
   - luarocks install luacov
-  # install luacov-coveralls, but avoids installing luafilesystem
+  # install luacov-coveralls, but avoid installing luafilesystem
   - luarocks install luacov-coveralls --server=https://luarocks.org/dev --deps-mode=none
 
 install:

README.md

@@ -1,12 +1,13 @@
-[![Licence](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENCE.txt)
+[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)
 [![Build Status](https://travis-ci.org/keplerproject/luafilesystem.svg?branch=master)](https://travis-ci.org/keplerproject/luafilesystem)
 [![Build status](https://ci.appveyor.com/api/projects/status/y04s4ms7u16trw8e?svg=true)](https://ci.appveyor.com/project/ignacio/luafilesystem)
 [![Coverage Status](https://coveralls.io/repos/keplerproject/luafilesystem/badge.png)](https://coveralls.io/r/keplerproject/luafilesystem)
 
 # LuaFileSystem - File System Library for Lua
-Copyright 2003-2016 Kepler Project
 
-http://keplerproject.github.io/luafilesystem
+Copyright 2003-2017 Kepler Project
+
+https://keplerproject.github.io/luafilesystem
 
 # Description
 
@@ -14,7 +15,7 @@ LuaFileSystem is a Lua library developed to complement the set of functions
 related to file systems offered by the standard Lua distribution.
 
 LuaFileSystem offers a portable way to access the underlying directory structure and file attributes.
-LuaFileSystem is free software and uses the same license as Lua 5.1
+LuaFileSystem is free software and uses the same license as Lua 5.x (MIT).
 
 # LuaRocks Installation
 

doc/us/doc.css

@@ -1,182 +1,179 @@
 body { 
-    margin-left: 1em; 
-    margin-right: 1em; 
-    font-family: arial, helvetica, geneva, sans-serif;
-    background-color:#ffffff; margin:0px;
+    color: #47555c;
+    font-size: 16px;
+    font-family: "Open Sans", sans-serif;
+    margin: 0;
+    padding: 0;
+    background: #eff4ff;
+}
+
+a:link { color: #008fee; }
+a:visited { color: #008fee; }
+a:hover { color: #22a7ff; }
+
+h1 { font-size:26px; }
+h2 { font-size:24px; }
+h3 { font-size:18px; }
+h4 { font-size:16px; }
+
+hr {
+    height: 1px;
+    background: #c1cce4;
+    border: 0px;
+    margin: 20px 0;
 }
 
 code {
-    font-family: "Andale Mono", monospace; 
+    font-family: "Open Sans Mono", "Andale Mono", monospace; 
 }
 
 tt {
-    font-family: "Andale Mono", monospace; 
+    font-family: "Open Sans Mono", "Andale Mono", monospace; 
 }
 
-body, td, th { font-size: 11pt; }
-
-h1, h2, h3, h4 { margin-left: 0em; }
-
-textarea, pre, tt { font-size:10pt; }
-body, td, th { color:#000000; }
-small { font-size:0.85em; }
-h1 { font-size:1.5em; }
-h2 { font-size:1.25em; }
-h3 { font-size:1.15em; }
-h4 { font-size:1.06em; }
-
-a:link { font-weight:bold; color: #004080; text-decoration: none; }
-a:visited { font-weight:bold; color: #006699; text-decoration: none; }
-a:link:hover { text-decoration:underline; }
-hr { color:#cccccc }
-img { border-width: 0px; }
-
-h3 { padding-top: 1em; }
-
-p { margin-left: 1em; }
-
-p.name { 
-    font-family: "Andale Mono", monospace; 
-    padding-top: 1em;
-    margin-left: 0em; 
+body, td, th {
 }
 
-blockquote { margin-left: 3em; }
+textarea, pre, tt {
+    font-family: "Open Sans Mono", "Andale Mono", monospace; 
+}
+
+img {
+    border-width: 0px;
+}
 
 .example {
-    background-color: rgb(245, 245, 245);
-    border-top-width: 1px;
-    border-right-width: 1px;
-    border-bottom-width: 1px;
-    border-left-width: 1px;
-    border-top-style: solid;
-    border-right-style: solid;
-    border-bottom-style: solid;
-    border-left-style: solid;
-    border-top-color: silver;
-    border-right-color: silver;
-    border-bottom-color: silver;
-    border-left-color: silver;
-    padding: 1em;
-    margin-left: 1em;
-    margin-right: 1em;
-    font-family: "Andale Mono", monospace; 
-    font-size: smaller;
+    background-color: #323744;
+    color: white;
+    font-size: 16px;
+    padding: 16px 24px;
+    border-radius: 2px;
 }
 
-hr { 
-    margin-left: 0em;
-    background: #00007f; 
-    border: 0px;
-    height: 1px;
+div.header, div.footer {
 }
 
-ul { list-style-type: disc; }
+#container {
+}
 
-table.index { border: 1px #00007f; }
-table.index td { text-align: left; vertical-align: top; }
-table.index ul { padding-top: 0em; margin-top: 0em; }
+#product {
+    background-color: white;
+    padding: 10px;
+    height: 130px;
+    border-bottom: solid #d3dbec 1px;
+}
 
-table {
-    border: 1px solid black;
-    border-collapse: collapse;
+#product big {
+    font-size: 42px;
+}
+#product strong {
+    font-weight: normal;
+}
+
+#product_logo {
+    float: right;
+}
+
+#product_name {
+    padding-top: 15px;
+    padding-left: 30px;
+    font-size: 42px;
+    font-weight: normal;
+}
+
+#product_description {
+    padding-left: 30px;
+    color: #757779;
+}
+
+#main {
+    background: #eff4ff;
+    margin: 0;
+}
+
+#navigation {
+    width: 100%;
+    background-color: rgb(44,62,103);
+    padding: 10px;
+    margin: 0;
+}
+
+#navigation h1 {
+    display: none;
+}
+
+#navigation a:hover {
+    text-decoration: underline;
+}
+
+#navigation ul li a {
+    color: rgb(136, 208, 255);
+    font-weight: bold;
+    text-decoration: none;
+}
+
+#navigation ul li li a {
+    color: rgb(136, 208, 255);
+    font-weight: normal;
+    text-decoration: none;
+}
+
+#navigation ul {
+    display: inline;
+    color: white;
+    padding: 0px;
+    padding-top: 10px;
+    padding-bottom: 10px;
+}
+
+#navigation li {
+    display: inline;
+    list-style-type: none;
+    padding-left: 5px;
+    padding-right: 5px;
+}
+
+#navigation li {
+    padding: 10px;
+    padding: 10px;
+}
+
+#navigation li li {
+}
+
+#navigation li:hover a {
+    color: rgb(166, 238, 255);
+}
+
+#content {
+    padding: 20px;
+    width: 800px;
     margin-left: auto;
     margin-right: auto;
 }
 
-th {
-    border: 1px solid black;
-    padding: 0.5em;
-}
-
-td {
-    border: 1px solid black;
-    padding: 0.5em;
-}
-div.header, div.footer { margin-left: 0em; }
-
-#container {
-    margin-left: 1em;
-    margin-right: 1em;
-    background-color: #f0f0f0;
-}
-
-#product {
-    text-align: center;
-    border-bottom: 1px solid #cccccc;
-    background-color: #ffffff;
-}
-
-#product big {
-    font-size: 2em;
-}
-
-#product_logo {
-}
-
-#product_name {
-}
-
-#product_description {
-}
-
-#main {
-    background-color: #f0f0f0;
-    border-left: 2px solid #cccccc;
-}
-
-#navigation {
-    float: left;
-    width: 12em;
-    margin: 0;
-    vertical-align: top;
-    background-color: #f0f0f0;
-    overflow:visible;
-}
-
-#navigation h1 {
-    background-color:#e7e7e7;
-    font-size:1.1em;
-    color:#000000;
-    text-align:left;
-    margin:0px;
-    padding:0.2em;
-    border-top:1px solid #dddddd;
-    border-bottom:1px solid #dddddd;
-}
-
-#navigation ul {
-    font-size:1em;
-    list-style-type: none;
-    padding: 0;
-    margin: 1px;
-}
-
-#navigation li {
-    text-indent: -1em;
-    margin: 0em 0em 0em 0.5em;
-    display: block;
-    padding: 3px 0px 0px 12px;
-}
-
-#navigation li li a {
-    padding: 0px 3px 0px -1em;
-}
-
-#content {
-    margin-left: 12em;
-    padding: 1em;
-    border-left: 2px solid #cccccc;
-    border-right: 2px solid #cccccc;
-    background-color: #ffffff;
-}
-
 #about {
-    clear: both;
-    margin: 0;
+    display: none;
+}
+
+dl.reference {
+    background-color: white;
+    padding: 20px;
+    border: solid #d3dbec 1px;
+}
+
+dl.reference dt {
     padding: 5px;
-    border-top: 2px solid #cccccc;
-    background-color: #ffffff;
+    padding-top: 25px;
+    color: #637bbc;
+}
+
+dl.reference dl dt {
+    padding-top: 5px;
+    color: #637383;
+}
+
+dl.reference dd {
 }
 
 @media print {

doc/us/index.html

@@ -70,17 +70,30 @@ the underlying directory structure and file attributes.</p>
 
 <h2><a name="status"></a>Status</h2>
 
-<p>Current version is 1.6.3. It works with Lua 5.1, 5.2 and 5.3.</p>
+<p>Current version is 1.7.0. It works with Lua 5.1, 5.2 and 5.3, and it runs on various
+flavors of Unix (including Linux, BSDs, macOS) and Windows.</p>
 
 <h2><a name="download"></a>Download</h2>
 
-<p>LuaFileSystem source can be downloaded from its
-<a href="http://github.com/keplerproject/luafilesystem">Github</a>
-page.</p>
+<p>LuaFileSystem can be installed using <a href="https://luarocks.org">LuaRocks</a>:
+
+<pre class="example">
+$ luarocks install luafilesystem
+</pre>
+
+<p>Its source can be found at its <a href="http://github.com/keplerproject/luafilesystem">Github</a> page.</p>
 
 <h2><a name="history"></a>History</h2>
 
 <dl class="history">
+    <dt><strong>Version 1.7.0</strong> [15/Sep/2017]</dt>
+    <dd><ul>
+        <li>symlinkattributes function now provides 'target' field, containing name of the file that the symlink points to.</li>
+        <li>attributes, symlinkattributes, touch, mkdir, and rmdir functions now return system-dependent error code as the third value on error.</li>
+        <li>Fixed detection of closed files for Lua 5.2+ in setmode, lock, and unlock functions.</li>
+        <li>Fixed various compiler warnings.</li>
+    </ul></dd>
+
 	<dt><strong>Version 1.6.3</strong> [15/Jan/2015]</dt>
 	<dd><ul>
         <li>Lua 5.3 support.</li>

doc/us/license.html

@@ -84,7 +84,7 @@ Ierusalimschy, André Carregal and Tomás Guisasola.
 The implementation is not derived from licensed software.</p>
 
 <hr/>
-<p>Copyright &copy; 2003 Kepler Project.</p>
+<p>Copyright &copy; 2003 - 2017 Kepler Project.</p>
 
 <p>Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

doc/us/manual.html

@@ -104,7 +104,7 @@ LuaFileSystem offers the following functions:
 <dl class="reference">
     <dt><a name="attributes"></a><strong><code>lfs.attributes (filepath [, aname | atable])</code></strong></dt>
     <dd>Returns a table with the file attributes corresponding to
-    <code>filepath</code> (or <code>nil</code> followed by an error message
+    <code>filepath</code> (or <code>nil</code> followed by an error message and a system-dependent error code
     in case of error).
     If the second optional argument is given and is a string, then only the value of the
     named attribute is returned (this use is equivalent to
@@ -222,14 +222,14 @@ LuaFileSystem offers the following functions:
     <dt><a name="mkdir"></a><strong><code>lfs.mkdir (dirname)</code></strong></dt>
     <dd>Creates a new directory. The argument is the name of the new
     directory.<br />
-    Returns <code>true</code> if the operation was successful;
-    in case of error, it returns <code>nil</code> plus an error string.
+    Returns <code>true</code> in case of success or <code>nil</code>, an error message and
+    a system-dependent error code in case of error.
     </dd>
     
     <dt><a name="rmdir"></a><strong><code>lfs.rmdir (dirname)</code></strong></dt>
     <dd>Removes an existing directory. The argument is the name of the directory.<br />
-    Returns <code>true</code> if the operation was successful;
-    in case of error, it returns <code>nil</code> plus an error string.</dd>
+    Returns <code>true</code> in case of success or <code>nil</code>, an error message and
+    a system-dependent error code in case of error.
 
     <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt>
     <dd>Sets the writing mode for a file. The mode string can be either <code>"binary"</code> or <code>"text"</code>.
@@ -257,8 +257,8 @@ LuaFileSystem offers the following functions:
     Lua standard function <code>os.time</code>).
     If the modification time is omitted, the access time provided is used;
     if both times are omitted, the current time is used.<br />
-    Returns <code>true</code> if the operation was successful;
-    in case of error, it returns <code>nil</code> plus an error string.
+    Returns <code>true</code> in case of success or <code>nil</code>, an error message and
+    a system-dependent error code in case of error.
     </dd>
     
     <dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt>

rockspecs/luafilesystem-1.7.0-1.rockspec

@@ -0,0 +1,28 @@
+package = "LuaFileSystem"
+version = "1.7.0-1"
+source = {
+   url = "git://github.com/keplerproject/luafilesystem",
+   tag = "v1_7_0",
+}
+description = {
+   summary = "File System Library for the Lua Programming Language",
+   detailed = [[
+      LuaFileSystem is a Lua library developed to complement the set of
+      functions related to file systems offered by the standard Lua
+      distribution. LuaFileSystem offers a portable way to access the
+      underlying directory structure and file attributes.
+   ]],
+   license = "MIT/X11",
+}
+dependencies = {
+   "lua >= 5.1"
+}
+build = {
+   type = "builtin",
+   modules = {
+      lfs = "src/lfs.c"
+   },
+   copy_directories = {
+      "doc", "tests"
+   }
+}

src/lfs.c

@@ -1,6 +1,6 @@
 /*
 ** LuaFileSystem
-** Copyright Kepler Project 2003 - 2016 (http://keplerproject.github.io/luafilesystem)
+** Copyright Kepler Project 2003 - 2017 (http://keplerproject.github.io/luafilesystem)
 **
 ** File system manipulation library.
 ** This library offers these functions:
@@ -80,8 +80,10 @@
 
 #endif
 
-#if LUA_VERSION_NUM < 502
-#  define luaL_newlib(L,l) (lua_newtable(L), luaL_register(L,NULL,l))
+#if LUA_VERSION_NUM >= 502
+#  define new_lib(L, l) (luaL_newlib(L, l))
+#else
+#  define new_lib(L, l) (lua_newtable(L), luaL_register(L, NULL, l))
 #endif
 
 /* Define 'strerror' for systems that do not implement it */
@@ -121,6 +123,13 @@ typedef struct dir_data {
 #define LSTAT_FUNC lstat
 #endif
 
+#ifdef _WIN32
+  #define lfs_mkdir _mkdir
+#else
+  #define lfs_mkdir(path) (mkdir((path), \
+    S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IXOTH))
+#endif
+
 /*
 ** Utility functions
 */
@@ -135,12 +144,13 @@ static int pusherror(lua_State *L, const char *info)
         return 3;
 }
 
-static int pushresult(lua_State *L, int i, const char *info)
-{
-        if (i==-1)
-                return pusherror(L, info);
-        lua_pushinteger(L, i);
-        return 1;
+static int pushresult(lua_State *L, int res, const char *info) {
+  if (res == -1) {
+    return pusherror(L, info);
+  } else {
+    lua_pushboolean(L, 1);
+    return 1;
+  }
 }
 
 
@@ -422,16 +432,20 @@ static int file_unlock (lua_State *L) {
 ** @param #2 Name of link.
 ** @param #3 True if link is symbolic (optional).
 */
-static int make_link(lua_State *L)
-{
+static int make_link (lua_State *L) {
 #ifndef _WIN32
-        const char *oldpath = luaL_checkstring(L, 1);
-        const char *newpath = luaL_checkstring(L, 2);
-        return pushresult(L,
-                (lua_toboolean(L,3) ? symlink : link)(oldpath, newpath), NULL);
+  const char *oldpath = luaL_checkstring(L, 1);
+  const char *newpath = luaL_checkstring(L, 2);
+  int res = (lua_toboolean(L,3) ? symlink : link)(oldpath, newpath);
+  if (res == -1) {
+    return pusherror(L, NULL);
+  } else {
+    lua_pushinteger(L, 0);
+    return 1;
+  }
 #else
-        errno = ENOSYS; /* = "Function not implemented" */
-        return pushresult(L, -1, "make_link is not supported on Windows");
+  errno = ENOSYS; /* = "Function not implemented" */
+  return pushresult(L, -1, "make_link is not supported on Windows");
 #endif
 }
 
@@ -441,21 +455,8 @@ static int make_link(lua_State *L)
 ** @param #1 Directory path.
 */
 static int make_dir (lua_State *L) {
-        const char *path = luaL_checkstring (L, 1);
-        int fail;
-#ifdef _WIN32
-        fail = _mkdir (path);
-#else
-        fail =  mkdir (path, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP |
-                             S_IWGRP | S_IXGRP | S_IROTH | S_IXOTH );
-#endif
-        if (fail) {
-                lua_pushnil (L);
-        lua_pushfstring (L, "%s", strerror(errno));
-                return 2;
-        }
-        lua_pushboolean (L, 1);
-        return 1;
+  const char *path = luaL_checkstring(L, 1);
+  return pushresult(L, lfs_mkdir(path), NULL);
 }
 
 
@@ -464,18 +465,8 @@ static int make_dir (lua_State *L) {
 ** @param #1 Directory path.
 */
 static int remove_dir (lua_State *L) {
-        const char *path = luaL_checkstring (L, 1);
-        int fail;
-
-        fail = rmdir (path);
-
-        if (fail) {
-                lua_pushnil (L);
-                lua_pushfstring (L, "%s", strerror(errno));
-                return 2;
-        }
-        lua_pushboolean (L, 1);
-        return 1;
+  const char *path = luaL_checkstring(L, 1);
+  return pushresult(L, rmdir(path), NULL);
 }
 
 
@@ -662,26 +653,24 @@ static const char *mode2string (mode_t mode) {
 
 
 /*
-** Set access time and modification values for file
+** Set access time and modification values for a file.
+** @param #1 File path.
+** @param #2 Access time in seconds, current time is used if missing.
+** @param #3 Modification time in seconds, access time is used if missing.
 */
 static int file_utime (lua_State *L) {
-        const char *file = luaL_checkstring (L, 1);
-        struct utimbuf utb, *buf;
+  const char *file = luaL_checkstring(L, 1);
+  struct utimbuf utb, *buf;
 
-        if (lua_gettop (L) == 1) /* set to current date/time */
-                buf = NULL;
-        else {
-                utb.actime = (time_t)luaL_optnumber (L, 2, 0);
-                utb.modtime = (time_t) luaL_optinteger (L, 3, utb.actime);
-                buf = &utb;
-        }
-        if (utime (file, buf)) {
-                lua_pushnil (L);
-                lua_pushfstring (L, "%s", strerror (errno));
-                return 2;
-        }
-        lua_pushboolean (L, 1);
-        return 1;
+  if (lua_gettop (L) == 1) /* set to current date/time */
+    buf = NULL;
+  else {
+    utb.actime = (time_t) luaL_optnumber(L, 2, 0);
+    utb.modtime = (time_t) luaL_optinteger(L, 3, utb.actime);
+    buf = &utb;
+  }
+
+  return pushresult(L, utime(file, buf), NULL);
 }
 
 
@@ -818,7 +807,8 @@ static int _file_info_ (lua_State *L, int (*st)(const char*, STAT_STRUCT*)) {
         if (st(file, &info)) {
                 lua_pushnil(L);
                 lua_pushfstring(L, "cannot obtain information from file '%s': %s", file, strerror(errno));
-                return 2;
+                lua_pushinteger(L, errno);
+                return 3;
         }
         if (lua_isstring (L, 2)) {
                 const char *member = lua_tostring (L, 2);
@@ -914,7 +904,7 @@ static int link_info (lua_State *L) {
 ** Assumes the table is on top of the stack.
 */
 static void set_info (lua_State *L) {
-  lua_pushliteral(L, "Copyright (C) 2003-2016 Kepler Project");
+  lua_pushliteral(L, "Copyright (C) 2003-2017 Kepler Project");
   lua_setfield(L, -2, "_COPYRIGHT");
   lua_pushliteral(L, "LuaFileSystem is a Lua library developed to complement the set of functions related to file systems offered by the standard Lua distribution");
   lua_setfield(L, -2, "_DESCRIPTION");
@@ -943,7 +933,7 @@ static const struct luaL_Reg fslib[] = {
 LFS_EXPORT int luaopen_lfs (lua_State *L) {
         dir_create_meta (L);
         lock_create_meta (L);
-        luaL_newlib (L, fslib);
+        new_lib (L, fslib);
         lua_pushvalue(L, -1);
         lua_setglobal(L, LFS_LIBNAME);
         set_info (L);

src/lfs.h

@@ -1,6 +1,6 @@
 /*
 ** LuaFileSystem
-** Copyright Kepler Project 2003 - 2016 (http://keplerproject.github.io/luafilesystem)
+** Copyright Kepler Project 2003 - 2017 (http://keplerproject.github.io/luafilesystem)
 */
 
 /* Define 'chdir' for systems that do not implement it */

tests/test.lua

@@ -152,7 +152,10 @@ io.write(".")
 io.flush()
 
 -- Trying to get attributes of a non-existent file
-assert (lfs.attributes ("this couldn't be an actual file") == nil, "could get attributes of a non-existent file")
+local attr_ok, err, errno = lfs.attributes("this couldn't be an actual file")
+assert(attr_ok == nil, "could get attributes of a non-existent file")
+assert(type(err) == "string", "failed lfs.attributes did not return an error message")
+assert(type(errno) == "number", "failed lfs.attributes did not return error code")
 assert (type(lfs.attributes (upper)) == "table", "couldn't get attributes of upper directory")
 
 io.write(".")