Add file and exec (along with subcmd support)

1 files changed, 677 insertions, 0 deletions

diff --git a/jim-file.c b/jim-file.c
new file mode 100644
index 0000000..beb7147
--- /dev/null
+++ b/jim-file.c
@@ -0,0 +1,677 @@
+/* 
+ * (c) 2008 Steve Bennett <steveb@workware.net.au>
+ *
+ * Implements the file command for jim
+ *
+ * The FreeBSD license
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above
+ *    copyright notice, this list of conditions and the following
+ *    disclaimer in the documentation and/or other materials
+ *    provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * The views and conclusions contained in the software and documentation
+ * are those of the authors and should not be interpreted as representing
+ * official policies, either expressed or implied, of the Jim Tcl Project.
+ *
+ * Based on code originally from Tcl 6.7:
+ *
+ * Copyright 1987-1991 Regents of the University of California
+ * Permission to use, copy, modify, and distribute this
+ * software and its documentation for any purpose and without
+ * fee is hereby granted, provided that the above copyright
+ * notice appear in all copies.  The University of California
+ * makes no representations about the suitability of this
+ * software for any purpose.  It is provided "as is" without
+ * express or implied warranty.
+ */
+
+#include <limits.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <errno.h>
+#include <sys/stat.h>
+#include <sys/param.h>
+
+#include "jim.h"
+#include "jim-subcmd.h"
+
+/*
+ *----------------------------------------------------------------------
+ *
+ * GetFileType --
+ *
+ *  Given a mode word, returns a string identifying the type of a
+ *  file.
+ *
+ * Results:
+ *  A static text string giving the file type from mode.
+ *
+ * Side effects:
+ *  None.
+ *
+ *----------------------------------------------------------------------
+ */
+
+static const char *GetFileType(int mode)
+{
+    if (S_ISREG(mode)) {
+        return "file";
+    } else if (S_ISDIR(mode)) {
+        return "directory";
+    } else if (S_ISCHR(mode)) {
+        return "characterSpecial";
+    } else if (S_ISBLK(mode)) {
+        return "blockSpecial";
+    } else if (S_ISFIFO(mode)) {
+        return "fifo";
+    } else if (S_ISLNK(mode)) {
+        return "link";
+    } else if (S_ISSOCK(mode)) {
+        return "socket";
+    }
+    return "unknown";
+}
+
+static void Jim_SetIntResult(Jim_Interp *interp, jim_wide wide)
+{
+    Jim_SetResult(interp, Jim_NewIntObj(interp, wide));
+}
+
+/*
+ *----------------------------------------------------------------------
+ *
+ * StoreStatData --
+ *
+ *  This is a utility procedure that breaks out the fields of a
+ *  "stat" structure and stores them in textual form into the
+ *  elements of an associative array.
+ *
+ * Results:
+ *  Returns a standard Tcl return value.  If an error occurs then
+ *  a message is left in interp->result.
+ *
+ * Side effects:
+ *  Elements of the associative array given by "varName" are modified.
+ *
+ *----------------------------------------------------------------------
+ */
+
+static int set_array_int_value(Jim_Interp *interp, Jim_Obj *container, const char *key, jim_wide value)
+{
+    Jim_Obj *nameobj = Jim_NewStringObj(interp, key, -1);
+    Jim_Obj *valobj = Jim_NewWideObj(interp, value);
+
+    if (Jim_SetDictKeysVector(interp, container, &nameobj, 1, valobj) != JIM_OK) {
+        Jim_FreeObj(interp, nameobj);
+        Jim_FreeObj(interp, valobj);
+        return JIM_ERR;
+    }
+    return JIM_OK;
+}
+
+static int set_array_string_value(Jim_Interp *interp, Jim_Obj *container, const char *key, const char *value)
+{
+    Jim_Obj *nameobj = Jim_NewStringObj(interp, key, -1);
+    Jim_Obj *valobj = Jim_NewStringObj(interp, value, -1);
+
+    if (Jim_SetDictKeysVector(interp, container, &nameobj, 1, valobj) != JIM_OK) {
+        Jim_FreeObj(interp, nameobj);
+        Jim_FreeObj(interp, valobj);
+        return JIM_ERR;
+    }
+    return JIM_OK;
+}
+
+static int
+StoreStatData(Jim_Interp *interp, Jim_Obj *varName, const struct stat *sb)
+{
+    if (set_array_int_value(interp, varName, "dev", sb->st_dev) != JIM_OK) {
+        Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
+        Jim_AppendStrings(interp, Jim_GetResult(interp), "can't set \"", Jim_GetString(varName, NULL), "(dev)\": variable isn't array", NULL);
+        return JIM_ERR;
+    }
+    set_array_int_value(interp, varName, "ino", sb->st_ino);
+    set_array_int_value(interp, varName, "mode", sb->st_mode);
+    set_array_int_value(interp, varName, "nlink", sb->st_nlink);
+    set_array_int_value(interp, varName, "uid", sb->st_uid);
+    set_array_int_value(interp, varName, "gid", sb->st_gid);
+    set_array_int_value(interp, varName, "size", sb->st_size);
+    set_array_int_value(interp, varName, "atime", sb->st_atime);
+    set_array_int_value(interp, varName, "mtime", sb->st_mtime);
+    set_array_int_value(interp, varName, "ctime", sb->st_ctime);
+    set_array_string_value(interp, varName, "type", GetFileType((int) sb->st_mode));
+
+    /* And also return the value */
+    Jim_SetResult(interp, Jim_GetVariable(interp, varName, 0));
+
+    return JIM_OK;
+}
+
+static int file_cmd_dirname(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *path = Jim_GetString(argv[0], NULL);
+    const char *p = strrchr(path, '/');
+    if (!p) {
+        Jim_SetResultString(interp, ".", -1);
+    }
+    else if (p == path) {
+        Jim_SetResultString(interp, "/", -1);
+    }
+    else {
+        Jim_SetResultString(interp, path, p - path);
+    }
+    return JIM_OK;
+}
+
+static int file_cmd_rootname(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *path = Jim_GetString(argv[0], NULL);
+    const char *lastSlash = strrchr(path, '/');
+    const char *p = strrchr(path, '.');
+    if (p == NULL || (lastSlash != NULL && lastSlash > p)) {
+        Jim_SetResult(interp, argv[0]);
+    }
+    else {
+        Jim_SetResultString(interp, path, p - path);
+    }
+    return JIM_OK;
+}
+
+static int file_cmd_extension(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *path = Jim_GetString(argv[0], NULL);
+    const char *lastSlash = strrchr(path, '/');
+    const char *p = strrchr(path, '.');
+
+    if (p == NULL || (lastSlash != NULL && lastSlash >= p)) {
+        p = "";
+    }
+    Jim_SetResultString(interp, p, -1);
+    return JIM_OK;
+}
+
+static int file_cmd_tail(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *path = Jim_GetString(argv[0], NULL);
+    const char *lastSlash = strrchr(path, '/');
+
+    if (lastSlash) {
+        Jim_SetResultString(interp, lastSlash + 1, -1);
+    }
+    else {
+        Jim_SetResult(interp, argv[0]);
+    }
+    return JIM_OK;
+}
+
+static int file_cmd_normalize(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *path = Jim_GetString(argv[0], NULL);
+    char *newname = Jim_Alloc(MAXPATHLEN + 1);
+
+    if (realpath(path, newname)) {
+        Jim_SetResult(interp, Jim_NewStringObjNoAlloc(interp, newname, -1));
+    }
+    else {
+        Jim_Free(newname);
+        Jim_SetResult(interp, argv[0]);
+    }
+    return JIM_OK;
+}
+
+static int file_access(Jim_Interp *interp, Jim_Obj *filename, int mode)
+{
+    const char *path = Jim_GetString(filename, NULL);
+    int rc = access(path, mode);
+
+    Jim_SetResult(interp, Jim_NewIntObj(interp, rc != -1));
+
+    return JIM_OK;
+}
+
+static int file_cmd_readable(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    return file_access(interp, argv[0], R_OK);
+}
+
+static int file_cmd_writable(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    return file_access(interp, argv[0], W_OK);
+}
+
+static int file_cmd_executable(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    return file_access(interp, argv[0], X_OK);
+}
+
+static int file_cmd_exists(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    return file_access(interp, argv[0], F_OK);
+}
+
+static int file_cmd_delete(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    while (argc--) {
+        const char *path = Jim_GetString(argv[0], NULL);
+        if (unlink(path) == -1 && errno != ENOENT) {
+            Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
+            Jim_AppendStrings(interp, Jim_GetResult(interp), "couldn't delete \"", path, "\"", NULL);
+            return JIM_ERR;
+        }
+        argv++;
+    }
+    return JIM_OK;
+}
+
+static int mkdir_all(const char *path)
+{
+    /* REVISIT: create intermediate dirs if necessary */
+    mkdir(path, 0755);
+    return 0;
+}
+
+static int file_cmd_mkdir(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    while (argc--) {
+        mkdir_all(Jim_GetString(argv[0], NULL));
+        argv++;
+    }
+    return JIM_OK;
+}
+
+static int file_cmd_rename(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *source = Jim_GetString(argv[0], NULL);
+    const char *dest;
+    int force = 0;
+
+    if (argc == 3) {
+        if (strcmp(source, "-force") != 0) {
+            return -1;
+        }
+        force++;
+        source = Jim_GetString(argv[1], NULL);
+    }
+    dest = Jim_GetString(argv[force + 1], NULL);
+
+    if (!force && access(dest, F_OK) == 0) {
+        Jim_SetResultString(interp, "", 0);
+        Jim_AppendStrings(interp, Jim_GetResult(interp), "error renaming \"", source, "\" to \"", dest, "\": ", strerror(errno), NULL);
+        return JIM_ERR;
+    }
+
+    if (rename(source, dest) != 0) {
+        Jim_SetResultString(interp, "", 0);
+        Jim_AppendStrings(interp, Jim_GetResult(interp), "error renaming \"", source, "\": ", strerror(errno), NULL);
+        return JIM_ERR;
+    }
+
+    return JIM_OK;
+}
+
+static int file_stat(Jim_Interp *interp, Jim_Obj *filename, struct stat *sb)
+{
+    const char *path = Jim_GetString(filename, NULL);
+    if (stat(path, sb) == -1) {
+        Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
+        Jim_AppendStrings(interp, Jim_GetResult(interp), "could not read \"", path, "\": ", strerror(errno), NULL);
+        return JIM_ERR;
+    }
+    return JIM_OK;
+}
+
+static int file_lstat(Jim_Interp *interp, Jim_Obj *filename, struct stat *sb)
+{
+    const char *path = Jim_GetString(filename, NULL);
+    if (lstat(path, sb) == -1) {
+        Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
+        Jim_AppendStrings(interp, Jim_GetResult(interp), "could not read \"", path, "\": ", strerror(errno), NULL);
+        return JIM_ERR;
+    }
+    return JIM_OK;
+}
+
+static int file_cmd_atime(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+
+    if (file_stat(interp, argv[0], &sb) != JIM_OK) {
+        return JIM_ERR;
+    }
+    Jim_SetIntResult(interp, sb.st_atime);
+    return JIM_OK;
+}
+
+static int file_cmd_mtime(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+
+    if (file_stat(interp, argv[0], &sb) != JIM_OK) {
+    return JIM_ERR;
+    }
+    Jim_SetIntResult(interp, sb.st_mtime);
+    return JIM_OK;
+}
+
+static int file_cmd_size(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+
+    if (file_stat(interp, argv[0], &sb) != JIM_OK) {
+    return JIM_ERR;
+    }
+    Jim_SetIntResult(interp, sb.st_size);
+    return JIM_OK;
+}
+
+static int file_cmd_isdirectory(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+    int ret = 0;
+
+    if (file_stat(interp, argv[0], &sb) == JIM_OK) {
+    ret = S_ISDIR(sb.st_mode);
+    }
+    Jim_SetIntResult(interp, ret);
+    return JIM_OK;
+}
+
+static int file_cmd_isfile(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+    int ret = 0;
+
+    if (file_stat(interp, argv[0], &sb) == JIM_OK) {
+    ret = S_ISREG(sb.st_mode);
+    }
+    Jim_SetIntResult(interp, ret);
+    return JIM_OK;
+}
+
+static int file_cmd_owned(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+    int ret = 0;
+
+    if (file_stat(interp, argv[0], &sb) == JIM_OK) {
+    ret = (geteuid() == sb.st_uid);
+    }
+    Jim_SetIntResult(interp, ret);
+    return JIM_OK;
+}
+
+#ifdef S_IFLNK
+static int file_cmd_readlink(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *path = Jim_GetString(argv[0], NULL);
+    char *linkValue = Jim_Alloc(MAXPATHLEN + 1);
+
+    int linkLength = readlink(path, linkValue, MAXPATHLEN);
+    if (linkLength == -1) {
+        Jim_Free(linkValue);
+        Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
+        Jim_AppendStrings(interp, Jim_GetResult(interp), "couldn't readlink \"", path, "\"", NULL);
+        return JIM_ERR;
+    }
+    Jim_SetResult(interp, Jim_NewStringObjNoAlloc(interp, linkValue, linkLength));
+    return JIM_OK;
+}
+#endif
+
+static int file_cmd_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+
+    if (file_lstat(interp, argv[0], &sb) != JIM_OK) {
+        return JIM_ERR;
+    }
+    Jim_SetIntResult(interp, sb.st_mode);
+    return JIM_OK;
+}
+
+static int file_cmd_lstat(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+
+    if (file_lstat(interp, argv[0], &sb) != JIM_OK) {
+        return JIM_ERR;
+    }
+    return StoreStatData(interp, argv[1], &sb);
+}
+
+static int file_cmd_stat(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    struct stat sb;
+
+    if (file_stat(interp, argv[0], &sb) != JIM_OK) {
+        return JIM_ERR;
+    }
+    return StoreStatData(interp, argv[1], &sb);
+}
+
+static const jim_subcmd_type command_table[] = {
+    {   .cmd = "atime",
+        .args = "name",
+        .function = file_cmd_atime,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Last access time"
+    },
+    {   .cmd = "mtime",
+        .args = "name",
+        .function = file_cmd_mtime,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Last modification time"
+    },
+    {   .cmd = "dirname",
+        .args = "name",
+        .function = file_cmd_dirname,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Directory part of the name"
+    },
+    {   .cmd = "rootname",
+        .args = "name",
+        .function = file_cmd_rootname,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Name without any extension"
+    },
+    {   .cmd = "extension",
+        .args = "name",
+        .function = file_cmd_extension,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Last extension including the dot"
+    },
+    {   .cmd = "tail",
+        .args = "name",
+        .function = file_cmd_tail,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Last component of the name"
+    },
+    {   .cmd = "normalize",
+        .args = "name",
+        .function = file_cmd_normalize,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Normalized path of name"
+    },
+    {   .cmd = "readable",
+        .args = "name",
+        .function = file_cmd_readable,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Is file readable"
+    },
+    {   .cmd = "writable",
+        .args = "name",
+        .function = file_cmd_writable,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Is file writable"
+    },
+    {   .cmd = "executable",
+        .args = "name",
+        .function = file_cmd_executable,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Is file executable"
+    },
+    {   .cmd = "exists",
+        .args = "name",
+        .function = file_cmd_exists,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Does file exist"
+    },
+    {   .cmd = "delete",
+        .args = "name ...",
+        .function = file_cmd_delete,
+        .minargs = 1,
+        .maxargs = -1,
+        .description = "Deletes the file(s)"
+    },
+    {   .cmd = "mkdir",
+        .args = "dir ...",
+        .function = file_cmd_mkdir,
+        .minargs = 1,
+        .maxargs = -1,
+        .description = "Creates the directories"
+    },
+    {   .cmd = "rename",
+        .args = "?-force? source dest",
+        .function = file_cmd_rename,
+        .minargs = 2,
+        .maxargs = 3,
+        .description = "Renames a file"
+    },
+#ifdef S_IFLNK
+    {   .cmd = "readlink",
+        .args = "name",
+        .function = file_cmd_readlink,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Value of the symbolic link"
+    },
+#endif
+    {   .cmd = "size",
+        .args = "name",
+        .function = file_cmd_size,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Size of file"
+    },
+    {   .cmd = "stat",
+        .args = "name var",
+        .function = file_cmd_stat,
+        .minargs = 2,
+        .maxargs = 2,
+        .description = "Stores results of stat in var array"
+    },
+    {   .cmd = "lstat",
+        .args = "name var",
+        .function = file_cmd_lstat,
+        .minargs = 2,
+        .maxargs = 2,
+        .description = "Stores results of lstat in var array"
+    },
+    {   .cmd = "type",
+        .args = "name",
+        .function = file_cmd_type,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Returns type of the file"
+    },
+    {   .cmd = "owned",
+        .args = "name",
+        .function = file_cmd_owned,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Returns 1 if owned by the current owner"
+    },
+    {   .cmd = "isdirectory",
+        .args = "name",
+        .function = file_cmd_isdirectory,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Returns 1 if name is a directory"
+    },
+    {   .cmd = "isfile",
+        .args = "name",
+        .function = file_cmd_isfile,
+        .minargs = 1,
+        .maxargs = 1,
+        .description = "Returns 1 if name is a file"
+    },
+    {
+        .cmd = 0
+    }
+};
+
+static int Jim_CdCmd(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const char *path;
+
+    if (argc != 2) {
+        Jim_WrongNumArgs(interp, 1, argv, "dirname");   
+        return JIM_ERR;
+    }
+
+    path = Jim_GetString(argv[1], NULL);
+
+    if (chdir(path) != 0) {
+        Jim_SetResultString(interp, "", 0);
+        Jim_AppendStrings(interp, Jim_GetResult(interp), 
+            "couldn't change working directory to \"", path, "\": ", strerror(errno), NULL);
+        return JIM_ERR;
+    }
+    return JIM_OK;
+}
+
+static int Jim_PwdCmd(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    const int cwd_len=2048;
+    char *cwd=malloc(cwd_len);
+    getcwd(cwd, cwd_len);
+
+    Jim_SetResultString(interp, cwd, -1);
+
+    free(cwd);
+    return JIM_OK;
+}
+
+int Jim_FileInit(Jim_Interp *interp)
+{
+    if (Jim_PackageProvide(interp, "file", "1.0", JIM_ERRMSG) != JIM_OK) {
+        return JIM_ERR;
+    }
+    Jim_CreateCommand(interp, "file", Jim_SubCmdProc, (void *)command_table, NULL);
+    Jim_CreateCommand(interp, "pwd", Jim_PwdCmd, NULL, NULL);
+    Jim_CreateCommand(interp, "cd", Jim_CdCmd, NULL, NULL);
+    return JIM_OK;
+}