root/lib/lua/loslib.c

DEFINITIONS

1. os_pushresult
2. os_execute
3. os_remove
4. os_rename
5. os_tmpname
6. os_getenv
7. os_clock
8. setfield
9. setboolfield
10. getboolfield
11. getfield
12. os_date
13. os_time
14. os_difftime
15. os_difftime
16. os_setlocale
17. os_exit
18. os_mkdir
19. get_table_optbool
20. os_listdir
21. idir_iter
22. idir_gc
23. os_idir
24. idir_register
25. os_stat
26. os_utime
27. luaopen_os

   1 /*
   2 ** $Id: loslib.c,v 1.19.1.3 2008/01/18 16:38:18 roberto Exp $
   3 ** Standard Operating System library
   4 ** See Copyright Notice in lua.h
   5 */
   7 #include <errno.h>
   8 #include <locale.h>
   9 #include <stdlib.h>
  10 #include <string.h>
  11 #include <time.h>
  12 #include <dirent.h>
  13 #ifdef HOST_LUA
  14 #include <sys/stat.h>
  15 #include <utime.h>
  16 #endif
  18 #define loslib_c
  19 #define LUA_LIB
  21 #include "lua.h"
  23 #include "lauxlib.h"
  24 #include "lualib.h"
  27 static int os_pushresult (lua_State *L, int i, const char *filename) {
  28   int en = errno;  /* calls to Lua API may change this value */
  29   if (i) {
lua_pushboolean(L, 1);
  31     return 1;
  32   }
  33   else {
lua_pushnil(L);
lua_pushfstring(L, "%s: %s", filename, strerror(en));
lua_pushinteger(L, en);
  37     return 3;
  38   }
  39 }
  42 #ifdef HOST_LUA
  43 static int os_execute (lua_State *L) {
lua_pushinteger(L, system(luaL_optstring(L, 1, NULL)));
  45   return 1;
  46 }
  47 #endif
  50 static int os_remove (lua_State *L) {
  51   const char *filename = luaL_checkstring(L, 1);
  52   return os_pushresult(L, remove(filename) == 0, filename);
  53 }
  56 static int os_rename (lua_State *L) {
  57   const char *fromname = luaL_checkstring(L, 1);
  58   const char *toname = luaL_checkstring(L, 2);
  59   return os_pushresult(L, rename(fromname, toname) == 0, fromname);
  60 }
  63 // TODO
  64 #if 0
  65 static int os_tmpname (lua_State *L) {
  66   char buff[LUA_TMPNAMBUFSIZE];
  67   int err;
lua_tmpnam(buff, err);
  69   if (err)
  70     return luaL_error(L, "unable to generate a unique filename");
lua_pushstring(L, buff);
  72   return 1;
  73 }
  74 #endif
  76 #ifdef HOST_LUA
  77 static int os_getenv (lua_State *L) {
lua_pushstring(L, getenv(luaL_checkstring(L, 1)));  /* if NULL push nil */
  79   return 1;
  80 }
  81 #endif
  83 #if 0
  84 static int os_clock (lua_State *L) {
lua_pushnumber(L, ((lua_Number)clock())/(lua_Number)CLOCKS_PER_SEC);
  86   return 1;
  87 }
  88 #endif
  91 /*
  92 ** {======================================================
  93 ** Time/Date operations
  94 ** { year=%Y, month=%m, day=%d, hour=%H, min=%M, sec=%S,
  95 **   wday=%w+1, yday=%j, isdst=? }
  96 ** =======================================================
  97 */
  99 static void setfield (lua_State *L, const char *key, int value) {
lua_pushinteger(L, value);
lua_setfield(L, -2, key);
 102 }
 104 static void setboolfield (lua_State *L, const char *key, int value) {
 105   if (value < 0)  /* undefined? */
 106     return;  /* does not set field */
lua_pushboolean(L, value);
lua_setfield(L, -2, key);
 109 }
 111 static int getboolfield (lua_State *L, const char *key) {
 112   int res;
lua_getfield(L, -1, key);
res = lua_isnil(L, -1) ? -1 : lua_toboolean(L, -1);
lua_pop(L, 1);
 116   return res;
 117 }
 120 static int getfield (lua_State *L, const char *key, int d) {
 121   int res;
lua_getfield(L, -1, key);
 123   if (lua_isnumber(L, -1))
res = (int)lua_tointeger(L, -1);
 125   else {
 126     if (d < 0)
 127       return luaL_error(L, "field " LUA_QS " missing in date table", key);
res = d;
 129   }
lua_pop(L, 1);
 131   return res;
 132 }
 135 static int os_date (lua_State *L) {
 136   const char *s = luaL_optstring(L, 1, "%c");
time_t t = luaL_opt(L, (time_t)luaL_checknumber, 2, time(NULL));
 138   struct tm *stm;
 139   if (*s == '!') {  /* UTC? */
 140   #if 0
 141   // reyalp - we have no idea about timezones, so just eat the !
 142   // and use local time
 143   // TODO some cams may be timezone/dst aware ?
stm = gmtime(&t);
 145   #endif
stm = localtime(&t);
s++;  /* skip `!' */
 148   }
 149   else
stm = localtime(&t);
 151   if (stm == NULL)  /* invalid date? */
lua_pushnil(L);
 153   else if (strcmp(s, "*t") == 0) {
lua_createtable(L, 0, 9);  /* 9 = number of fields */
setfield(L, "sec", stm->tm_sec);
setfield(L, "min", stm->tm_min);
setfield(L, "hour", stm->tm_hour);
setfield(L, "day", stm->tm_mday);
setfield(L, "month", stm->tm_mon+1);
setfield(L, "year", stm->tm_year+1900);
setfield(L, "wday", stm->tm_wday+1);
setfield(L, "yday", stm->tm_yday+1);
setboolfield(L, "isdst", stm->tm_isdst);
 164   }
 165   else {
 166     char cc[3];
luaL_Buffer b;
cc[0] = '%'; cc[2] = '\0';
luaL_buffinit(L, &b);
 170     for (; *s; s++) {
 171       if (*s != '%' || *(s + 1) == '\0')  /* no conversion specifier? */
luaL_addchar(&b, *s);
 173       else {
size_t reslen;
 175         char buff[200];  /* should be big enough for any conversion result */
cc[1] = *(++s);
reslen = strftime(buff, sizeof(buff), cc, stm);
luaL_addlstring(&b, buff, reslen);
 179       }
 180     }
luaL_pushresult(&b);
 182   }
 183   return 1;
 184 }
 187 static int os_time (lua_State *L) {
time_t t;
 189   if (lua_isnoneornil(L, 1))  /* called without args? */
t = time(NULL);  /* get current time */
 191   else {
 192     struct tm ts;
luaL_checktype(L, 1, LUA_TTABLE);
lua_settop(L, 1);  /* make sure table is at the top */
ts.tm_sec = getfield(L, "sec", 0);
ts.tm_min = getfield(L, "min", 0);
ts.tm_hour = getfield(L, "hour", 12);
ts.tm_mday = getfield(L, "day", -1);
ts.tm_mon = getfield(L, "month", -1) - 1;
ts.tm_year = getfield(L, "year", -1) - 1900;
ts.tm_isdst = getboolfield(L, "isdst");
t = mktime(&ts);
 203   }
 204   if (t == (time_t)(-1))
lua_pushnil(L);
 206   else
lua_pushnumber(L, (lua_Number)t);
 208   return 1;
 209 }
 212 #if 0
 213 static int os_difftime (lua_State *L) {
lua_pushnumber(L, difftime((time_t)(luaL_checknumber(L, 1)),
 215                              (time_t)(luaL_optnumber(L, 2, 0))));
 216   return 1;
 217 }
 218 #endif
 219 static int os_difftime (lua_State *L) {
lua_pushnumber(L, (time_t)(luaL_checknumber(L, 1) - (time_t)(luaL_optnumber(L, 2, 0))));
 221   return 1;
 222 }
 224 /* }====================================================== */
 227 #if 0
 228 static int os_setlocale (lua_State *L) {
 229   static const int cat[] = {LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY,
 230                       LC_NUMERIC, LC_TIME};
 231   static const char *const catnames[] = {"all", "collate", "ctype", "monetary",
 232      "numeric", "time", NULL};
 233   const char *l = luaL_optstring(L, 1, NULL);
 234   int op = luaL_checkoption(L, 2, "all", catnames);
lua_pushstring(L, setlocale(cat[op], l));
 236   return 1;
 237 }
 238 #endif
 240 #ifdef HOST_LUA
 241 static int os_exit (lua_State *L) {
exit(luaL_optint(L, 1, EXIT_SUCCESS));
 243 }
 244 #endif
 246 // reyalp added
 247 static int os_mkdir (lua_State *L) {
 248   const char *dirname = luaL_checkstring(L, 1);
 249 #if defined(HOST_LUA) && !defined(_WIN32)
 250   return os_pushresult(L, mkdir(dirname,0777) == 0, dirname);
 251 #else
 252   return os_pushresult(L, mkdir(dirname) == 0, dirname);
 253 #endif
 254 }
 257 static int get_table_optbool(lua_State *L, int narg, const char *fname, int d)
 258 {
 259     int r;
lua_getfield(L, narg, fname);
 261     // not set - use default
 262         if(lua_isnil(L,-1)) {
r=d;
 264         } else {// otherwise, treat as bool
r=lua_toboolean(L,-1); 
 266     }
lua_pop(L,1);
 268     return r;
 269 }
 271 /*
 272   syntax
 273     t=os.listdir("name",[showall|opts])
 274   returns array of filenames, or nil, strerror, errno
 275   if showall is true, t includes ".", ".." and deleted entries
 276   NOTE except for the root directory, names ending in / will not work
 277 */
 278 static int os_listdir (lua_State *L) {
 279 #ifdef HOST_LUA
 280   // TODO: Not implemented for 'hostlua'
 281   (void)L;
 282   return 0;
 283 #else
DIR *dir;
 285   struct dirent *de;
 286   const char *dirname = luaL_checkstring(L, 1);
 287   int all=0,od_flags=OPENDIR_FL_CHDK_LFN;
 288   if(lua_istable(L,2)) {
all=get_table_optbool(L,2,"showall",0);
od_flags=(get_table_optbool(L,2,"chdklfn",1))?OPENDIR_FL_CHDK_LFN:OPENDIR_FL_NONE;
 291   } else {
all=lua_toboolean(L, 2);
 293   }
 294   int i=1;
dir = opendir_chdk(dirname,od_flags);
 296   if(!dir) 
 297     return os_pushresult(L, 0 , dirname);
lua_newtable(L); 
 299   while((de = readdir(dir))) {
 300         if(!all && (de->d_name[0] == '\xE5' || (strcmp(de->d_name,".")==0) || (strcmp(de->d_name,"..")==0)))
 301       continue;
lua_pushinteger(L, i);
lua_pushstring(L, de->d_name);
lua_settable(L,-3);
 305         ++i;
 306   }
closedir(dir);
 308   return 1;
 309 #endif
 310 }
 312 #define IDIR_META "chdk_idir_meta"
 314 typedef struct {
DIR *dir;
 316     int all;
 317 } idir_udata_t;
 319 static int idir_iter(lua_State *L) {
 320     struct dirent *de;
idir_udata_t *ud = (idir_udata_t *)luaL_checkudata(L,1,IDIR_META);
 322     // dir may be on first call if opendir failed, or previous explicit close
 323     if(!ud->dir) {
 324         return 0;
 325     }
 326     // allow explicit close by calling iterator(ud,false)
 327     // need to check type because first invocation is called with nil
 328     if(lua_type(L, 2) == LUA_TBOOLEAN && lua_toboolean(L,2) == 0) {
closedir(ud->dir);
ud->dir=NULL;
 331         return 0;
 332     }
 333     while((de = readdir(ud->dir))) {
 334         // if not all, skip over ignored items
 335         if(!ud->all && (de->d_name[0] == '\xE5' || (strcmp(de->d_name,".")==0) || (strcmp(de->d_name,"..")==0))) {
 336             continue;
 337         }
 338         break;
 339     }
 340     if(de) {
lua_pushstring(L, de->d_name);
 342         return 1;
 343     } else { // on last, close immediately to avoid keeping the handle open until GC
closedir(ud->dir);
ud->dir=NULL;
 346         return 0;
 347     }
 348 }
 350 static int idir_gc(lua_State *L) {
idir_udata_t *ud = (idir_udata_t *)luaL_checkudata(L,1,IDIR_META);
 352     if(ud->dir) {
closedir(ud->dir);
 354     }
 355     return 0;
 356 }
 358 /*
 359   syntax
 360     iteratator, userdata = os.idir("name"[,all])
 361   each call to iterator(userdata) returns the next directory entry or nil if all
 362   entries have been returned
 363   typical usage
 364     for fname in os.idir("name"[,all]) do ...
 365 
 366   if all is true, includes ".", ".." and (depending on OS) deleted entries
 367  NOTES:
 368   Except for the root directory, names ending in / will not work
 369   If there is an error opening the directory, the results will be identical to
 370   an empty directory, unless all is true
 371   The directory handle is kept open until all directory entries are iterated
 372   or the userdata is GC'd. This means that:
 373   1) deep recursive traversals may run into handle limits. 
 374   2) If you break out of a loop using the iterator, the handle may remain open for a while.
 375   Explicitly calling iterator(userdata,false) will immediately close the handle. This cannot
 376   be used with the typical for syntax given above, you must use an explicit while loop like:
 377   local idir,ud=os.idir('A/')
 378   repeat
 379     name=idir(ud)
 380     -- break out of loop under some condition
 381     if somefunction(name) then
 382         break
 383     end
 384   until not name
 385   idir(ud,false) -- ensure directory handle is closed
 386 */
 387 static int os_idir (lua_State *L) {
 388 #ifdef HOST_LUA
 389   // TODO: Not implemented for 'hostlua'
 390   (void)L;
 391   return 0;
 392 #else
 393   const char *dirname = luaL_checkstring(L, 1);
 394   int all=0,od_flags=OPENDIR_FL_CHDK_LFN;
 395   if(lua_istable(L,2)) {
all=get_table_optbool(L,2,"showall",0);
od_flags=(get_table_optbool(L,2,"chdklfn",1))?OPENDIR_FL_CHDK_LFN:OPENDIR_FL_NONE;
 398   } else {
all=lua_toboolean(L, 2);
 400   }
lua_pushcfunction(L, idir_iter);
idir_udata_t *ud = lua_newuserdata(L,sizeof(idir_udata_t));
ud->dir = opendir_chdk(dirname,od_flags); // may be null, in which case iterator will stop on first iteration
 406                                 // no obvious way to return error status
ud->all = all;
luaL_getmetatable(L, IDIR_META);
lua_setmetatable(L, -2);
 411   return 2;
 412 #endif
 413 }
 415 static const luaL_Reg idir_meta_methods[] = {
 416   {"__gc", idir_gc},
 417   {NULL, NULL}
 418 };
 419 static void idir_register(lua_State *L) {
luaL_newmetatable(L,IDIR_META);
luaL_register(L, NULL, idir_meta_methods);  
 422 }
 424 // t = stat("name")
 425 // nil,strerror,errno on fail
 426 static int os_stat (lua_State *L) {
 427   struct stat st;
 428   const char *name = luaL_checkstring(L, 1);
 429   int result = stat(name,&st);
 430   if (result==0) {
lua_createtable(L, 0, 6);  /* = number of fields */
 432     // don't expose the fields that aren't useful
 433         // but leave them commented out for reference
 434 //#ifndef CAM_DRYOS_2_3_R39
 435 //    setfield(L,"dev",st.st_dev);              /* device ID number */
 436 //    setfield(L,"ino",st.st_ino);              /* no inodes in fat, always -1 */
 437 //    setfield(L,"mode",st.st_mode);    /* file mode (see below) */
 438 //#endif
 439 //    setfield(L,"nlink",st.st_nlink);  /* dryos 0, vxworks 1 */
 440 //    setfield(L,"uid",st.st_uid);              /* no users or groups on fat */
 441 //    setfield(L,"gid",st.st_gid);              /* " */
 442 //#if !CAM_DRYOS
 443 // doesn't appear useful, I wasn't able to stat any special files
 444 //    setfield(L,"rdev",st.st_rdev);    /* device ID, only if special file */
 445 //#endif
setfield(L,"size",st.st_size);      /* size of file, in bytes */
 447 //#ifndef CAM_DRYOS_2_3_R39
 448 //    setfield(L,"atime",st.st_atime);  /* time of last access */
 449 //#endif
setfield(L,"mtime",st.st_mtime);    /* time of last modification */
setfield(L,"ctime",st.st_ctime);    /* time of last change of file status */
 452 #ifdef HOST_LUA
 453 // fill in some sane values if we aren't running on the camera
 454 // from chdk stdlib
 455 #define DOS_ATTR_DIRECTORY      0x10            /* entry is a sub-directory */
 456 #ifndef CAM_DRYOS_2_3_R39
setfield(L,"blksize",512); 
setfield(L,"blocks",(st.st_size/512) + (st.st_size%512)?1:0); 
 459 #endif
 460     if ( S_ISDIR(st.st_mode) ) {
setfield(L,"attrib",DOS_ATTR_DIRECTORY);
setboolfield(L,"is_dir",1);
setboolfield(L,"is_file",0);
 464     }
 465     else {
setboolfield(L,"is_dir",0);
setfield(L,"attrib",0);
 468       if S_ISREG(st.st_mode) {
setboolfield(L,"is_file",1);
 470       }
 471     }
 472 #else
 473 //#ifndef CAM_DRYOS_2_3_R39
 474 //    setfield(L,"blksize",st.st_blksize); /* This is NOT the dos sector size. Appears to be 512 on all I've tested! */
 475 //    setfield(L,"blocks",st.st_blocks);   /* number of blocks required to store file. May not be the same as size on disk, per above*/
 476 //#endif
setfield(L,"attrib",st.st_attrib);  /* file attribute byte (dosFs only) */
 478         // for convenience
 479         // note volume labels are neither file nor directory
setboolfield(L,"is_dir",st.st_attrib & DOS_ATTR_DIRECTORY);
setboolfield(L,"is_file",!(st.st_attrib & (DOS_ATTR_DIRECTORY | DOS_ATTR_VOL_LABEL)));
 482 #endif
 483 #if 0
setfield(L,"reserved1",st.reserved1);
setfield(L,"reserved2",st.reserved2);
setfield(L,"reserved3",st.reserved3);
setfield(L,"reserved4",st.reserved4);
setfield(L,"reserved5",st.reserved5);
setfield(L,"reserved6",st.reserved6);
 490 #endif
 491     return 1;
 492   }
 493   else {
 494     int en = errno;
lua_pushnil(L);
lua_pushfstring(L, "%s: %s", name, strerror(en));
lua_pushinteger(L, en);
 498     return 3;
 499   }
 500 }
 502 // utime(name,[modtime,[actime]])
 503 // true | nil,strerror, errno
 504 // current time used for missing or nil args
 505 static int os_utime (lua_State *L) {
 506   const char *name = luaL_checkstring(L, 1);
 507   struct utimbuf t;
t.modtime = luaL_optnumber(L, 2, time(NULL));
t.actime = luaL_optnumber(L, 3, time(NULL));
 510   return os_pushresult(L, utime(name,&t) == 0, name);
 511 }
 513 static const luaL_Reg syslib[] = {
 514 #if 0
 515   {"clock",     os_clock},
 516 #endif
 517   {"date",      os_date},
 518   {"difftime",  os_difftime},
 519 #ifdef HOST_LUA
 520   {"execute",   os_execute},
 521   {"exit",      os_exit},
 522   {"getenv",    os_getenv},
 523 #endif
 524   {"mkdir",     os_mkdir}, // reyalp - NOT STANDARD
 525   {"listdir",   os_listdir}, // reyalp - NOT STANDARD
 526   {"idir",      os_idir}, // reyalp - NOT STANDARD
 527   {"stat",      os_stat}, // reyalp - NOT STANDARD
 528   {"utime",     os_utime}, // reyalp - NOT STANDARD
 529   {"remove",    os_remove},
 530   {"rename",    os_rename},
 531 #if 0
 532   {"setlocale", os_setlocale},
 533 #endif
 534   {"time",      os_time},
 535 #if 0
 536   {"tmpname",   os_tmpname},
 537 #endif
 538   {NULL, NULL}
 539 };
 541 /* }====================================================== */
LUALIB_API int luaopen_os (lua_State *L) {
idir_register(L);
luaL_register(L, LUA_OSLIBNAME, syslib);
 548   return 1;
 549 }