2 * Implements the file command for jim
4 * (c) 2008 Steve Bennett <steveb@workware.net.au>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials
15 * provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
19 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21 * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * The views and conclusions contained in the software and documentation
31 * are those of the authors and should not be interpreted as representing
32 * official policies, either expressed or implied, of the Jim Tcl Project.
34 * Based on code originally from Tcl 6.7:
36 * Copyright 1987-1991 Regents of the University of California
37 * Permission to use, copy, modify, and distribute this
38 * software and its documentation for any purpose and without
39 * fee is hereby granted, provided that the above copyright
40 * notice appear in all copies. The University of California
41 * makes no representations about the suitability of this
42 * software for any purpose. It is provided "as is" without
43 * express or implied warranty.
53 #include <jimautoconf.h>
54 #include <jim-subcmd.h>
61 #elif defined(_MSC_VER)
66 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
67 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
71 # define MAXPATHLEN JIM_PATH_LEN
75 *----------------------------------------------------------------------
79 * Given a mode word, returns a string identifying the type of a
83 * A static text string giving the file type from mode.
88 *----------------------------------------------------------------------
91 static const char *JimGetFileType(int mode
)
96 else if (S_ISDIR(mode
)) {
100 else if (S_ISCHR(mode
)) {
101 return "characterSpecial";
105 else if (S_ISBLK(mode
)) {
106 return "blockSpecial";
110 else if (S_ISFIFO(mode
)) {
115 else if (S_ISLNK(mode
)) {
120 else if (S_ISSOCK(mode
)) {
128 *----------------------------------------------------------------------
132 * This is a utility procedure that breaks out the fields of a
133 * "stat" structure and stores them in textual form into the
134 * elements of an associative array.
137 * Returns a standard Tcl return value. If an error occurs then
138 * a message is left in interp->result.
141 * Elements of the associative array given by "varName" are modified.
143 *----------------------------------------------------------------------
146 static int set_array_int_value(Jim_Interp
*interp
, Jim_Obj
*container
, const char *key
,
149 Jim_Obj
*nameobj
= Jim_NewStringObj(interp
, key
, -1);
150 Jim_Obj
*valobj
= Jim_NewWideObj(interp
, value
);
152 if (Jim_SetDictKeysVector(interp
, container
, &nameobj
, 1, valobj
, JIM_ERRMSG
) != JIM_OK
) {
153 Jim_FreeObj(interp
, nameobj
);
154 Jim_FreeObj(interp
, valobj
);
160 static int set_array_string_value(Jim_Interp
*interp
, Jim_Obj
*container
, const char *key
,
163 Jim_Obj
*nameobj
= Jim_NewStringObj(interp
, key
, -1);
164 Jim_Obj
*valobj
= Jim_NewStringObj(interp
, value
, -1);
166 if (Jim_SetDictKeysVector(interp
, container
, &nameobj
, 1, valobj
, JIM_ERRMSG
) != JIM_OK
) {
167 Jim_FreeObj(interp
, nameobj
);
168 Jim_FreeObj(interp
, valobj
);
174 static int StoreStatData(Jim_Interp
*interp
, Jim_Obj
*varName
, const struct stat
*sb
)
176 if (set_array_int_value(interp
, varName
, "dev", sb
->st_dev
) != JIM_OK
) {
177 Jim_SetResultFormatted(interp
, "can't set \"%#s(dev)\": variable isn't array", varName
);
180 set_array_int_value(interp
, varName
, "ino", sb
->st_ino
);
181 set_array_int_value(interp
, varName
, "mode", sb
->st_mode
);
182 set_array_int_value(interp
, varName
, "nlink", sb
->st_nlink
);
183 set_array_int_value(interp
, varName
, "uid", sb
->st_uid
);
184 set_array_int_value(interp
, varName
, "gid", sb
->st_gid
);
185 set_array_int_value(interp
, varName
, "size", sb
->st_size
);
186 set_array_int_value(interp
, varName
, "atime", sb
->st_atime
);
187 set_array_int_value(interp
, varName
, "mtime", sb
->st_mtime
);
188 set_array_int_value(interp
, varName
, "ctime", sb
->st_ctime
);
189 set_array_string_value(interp
, varName
, "type", JimGetFileType((int)sb
->st_mode
));
191 /* And also return the value */
192 Jim_SetResult(interp
, Jim_GetVariable(interp
, varName
, 0));
197 static int file_cmd_dirname(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
199 const char *path
= Jim_String(argv
[0]);
200 const char *p
= strrchr(path
, '/');
202 if (!p
&& path
[0] == '.' && path
[1] == '.' && path
[2] == '\0') {
203 Jim_SetResultString(interp
, "..", -1);
205 Jim_SetResultString(interp
, ".", -1);
207 else if (p
== path
) {
208 Jim_SetResultString(interp
, "/", -1);
210 #if defined(__MINGW32__) || defined(_MSC_VER)
211 else if (p
[-1] == ':') {
213 Jim_SetResultString(interp
, path
, p
- path
+ 1);
217 Jim_SetResultString(interp
, path
, p
- path
);
222 static int file_cmd_rootname(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
224 const char *path
= Jim_String(argv
[0]);
225 const char *lastSlash
= strrchr(path
, '/');
226 const char *p
= strrchr(path
, '.');
228 if (p
== NULL
|| (lastSlash
!= NULL
&& lastSlash
> p
)) {
229 Jim_SetResult(interp
, argv
[0]);
232 Jim_SetResultString(interp
, path
, p
- path
);
237 static int file_cmd_extension(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
239 const char *path
= Jim_String(argv
[0]);
240 const char *lastSlash
= strrchr(path
, '/');
241 const char *p
= strrchr(path
, '.');
243 if (p
== NULL
|| (lastSlash
!= NULL
&& lastSlash
>= p
)) {
246 Jim_SetResultString(interp
, p
, -1);
250 static int file_cmd_tail(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
252 const char *path
= Jim_String(argv
[0]);
253 const char *lastSlash
= strrchr(path
, '/');
256 Jim_SetResultString(interp
, lastSlash
+ 1, -1);
259 Jim_SetResult(interp
, argv
[0]);
264 static int file_cmd_normalize(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
267 const char *path
= Jim_String(argv
[0]);
268 char *newname
= Jim_Alloc(MAXPATHLEN
+ 1);
270 if (realpath(path
, newname
)) {
271 Jim_SetResult(interp
, Jim_NewStringObjNoAlloc(interp
, newname
, -1));
276 Jim_SetResultFormatted(interp
, "can't normalize \"%#s\": %s", argv
[0], strerror(errno
));
280 Jim_SetResultString(interp
, "Not implemented", -1);
285 static int file_cmd_join(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
288 char *newname
= Jim_Alloc(MAXPATHLEN
+ 1);
289 char *last
= newname
;
293 /* Simple implementation for now */
294 for (i
= 0; i
< argc
; i
++) {
296 const char *part
= Jim_GetString(argv
[i
], &len
);
299 /* Absolute component, so go back to the start */
302 #if defined(__MINGW32__) || defined(_MSC_VER)
303 else if (strchr(part
, ':')) {
304 /* Absolute compontent on mingw, so go back to the start */
308 else if (part
[0] == '.') {
309 if (part
[1] == '/') {
313 else if (part
[1] == 0 && last
!= newname
) {
314 /* Adding '.' to an existing path does nothing */
319 /* Add a slash if needed */
320 if (last
!= newname
&& last
[-1] != '/') {
325 if (last
+ len
- newname
>= MAXPATHLEN
) {
327 Jim_SetResultString(interp
, "Path too long", -1);
330 memcpy(last
, part
, len
);
334 /* Remove a slash if needed */
335 if (last
> newname
+ 1 && last
[-1] == '/') {
342 /* Probably need to handle some special cases ... */
344 Jim_SetResult(interp
, Jim_NewStringObjNoAlloc(interp
, newname
, last
- newname
));
349 static int file_access(Jim_Interp
*interp
, Jim_Obj
*filename
, int mode
)
351 const char *path
= Jim_String(filename
);
352 int rc
= access(path
, mode
);
354 Jim_SetResultBool(interp
, rc
!= -1);
359 static int file_cmd_readable(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
361 return file_access(interp
, argv
[0], R_OK
);
364 static int file_cmd_writable(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
366 return file_access(interp
, argv
[0], W_OK
);
369 static int file_cmd_executable(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
372 return file_access(interp
, argv
[0], X_OK
);
374 /* XXX: X_OK doesn't work under Windows.
375 * In any case, may need to add .exe, etc. so just lie!
377 Jim_SetResultBool(interp
, 1);
382 static int file_cmd_exists(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
384 return file_access(interp
, argv
[0], F_OK
);
387 static int file_cmd_delete(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
389 int force
= Jim_CompareStringImmediate(interp
, argv
[0], "-force");
391 if (force
|| Jim_CompareStringImmediate(interp
, argv
[0], "--")) {
397 const char *path
= Jim_String(argv
[0]);
399 if (unlink(path
) == -1 && errno
!= ENOENT
) {
400 if (rmdir(path
) == -1) {
401 /* Maybe try using the script helper */
402 if (!force
|| Jim_EvalPrefix(interp
, "file delete force", 1, argv
) != JIM_OK
) {
403 Jim_SetResultFormatted(interp
, "couldn't delete file \"%s\": %s", path
,
414 #ifdef HAVE_MKDIR_ONE_ARG
415 #define MKDIR_DEFAULT(PATHNAME) mkdir(PATHNAME)
417 #define MKDIR_DEFAULT(PATHNAME) mkdir(PATHNAME, 0755)
421 * Create directory, creating all intermediate paths if necessary.
423 * Returns 0 if OK or -1 on failure (and sets errno)
425 * Note: The path may be modified.
427 static int mkdir_all(char *path
)
431 /* First time just try to make the dir */
435 /* Must have failed the first time, so recursively make the parent and try again */
437 char *slash
= strrchr(path
, '/');
439 if (slash
&& slash
!= path
) {
441 if (mkdir_all(path
) != 0) {
448 if (MKDIR_DEFAULT(path
) == 0) {
451 if (errno
== ENOENT
) {
452 /* Create the parent and try again */
455 /* Maybe it already exists as a directory */
456 if (errno
== EEXIST
) {
459 if (stat(path
, &sb
) == 0 && S_ISDIR(sb
.st_mode
)) {
471 static int file_cmd_mkdir(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
474 char *path
= Jim_StrDup(Jim_String(argv
[0]));
475 int rc
= mkdir_all(path
);
479 Jim_SetResultFormatted(interp
, "can't create directory \"%#s\": %s", argv
[0],
489 static int file_cmd_tempfile(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
493 const char *template = "/tmp/tcl.tmp.XXXXXX";
496 template = Jim_String(argv
[0]);
498 filename
= Jim_StrDup(template);
500 fd
= mkstemp(filename
);
502 Jim_SetResultString(interp
, "Failed to create tempfile", -1);
507 Jim_SetResult(interp
, Jim_NewStringObjNoAlloc(interp
, filename
, -1));
512 static int file_cmd_rename(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
519 if (!Jim_CompareStringImmediate(interp
, argv
[0], "-force")) {
527 source
= Jim_String(argv
[0]);
528 dest
= Jim_String(argv
[1]);
530 if (!force
&& access(dest
, F_OK
) == 0) {
531 Jim_SetResultFormatted(interp
, "error renaming \"%#s\" to \"%#s\": target exists", argv
[0],
536 if (rename(source
, dest
) != 0) {
537 Jim_SetResultFormatted(interp
, "error renaming \"%#s\" to \"%#s\": %s", argv
[0], argv
[1],
545 static int file_stat(Jim_Interp
*interp
, Jim_Obj
*filename
, struct stat
*sb
)
547 const char *path
= Jim_String(filename
);
549 if (stat(path
, sb
) == -1) {
550 Jim_SetResultFormatted(interp
, "could not read \"%#s\": %s", filename
, strerror(errno
));
560 static int file_lstat(Jim_Interp
*interp
, Jim_Obj
*filename
, struct stat
*sb
)
562 const char *path
= Jim_String(filename
);
564 if (lstat(path
, sb
) == -1) {
565 Jim_SetResultFormatted(interp
, "could not read \"%#s\": %s", filename
, strerror(errno
));
571 static int file_cmd_atime(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
575 if (file_stat(interp
, argv
[0], &sb
) != JIM_OK
) {
578 Jim_SetResultInt(interp
, sb
.st_atime
);
582 static int file_cmd_mtime(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
589 struct timeval times
[2];
591 if (Jim_GetWide(interp
, argv
[1], &newtime
) != JIM_OK
) {
595 times
[1].tv_sec
= times
[0].tv_sec
= newtime
;
596 times
[1].tv_usec
= times
[0].tv_usec
= 0;
598 if (utimes(Jim_String(argv
[0]), times
) != 0) {
599 Jim_SetResultFormatted(interp
, "can't set time on \"%#s\": %s", argv
[0], strerror(errno
));
603 Jim_SetResultString(interp
, "Not implemented", -1);
607 if (file_stat(interp
, argv
[0], &sb
) != JIM_OK
) {
610 Jim_SetResultInt(interp
, sb
.st_mtime
);
614 static int file_cmd_copy(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
616 return Jim_EvalPrefix(interp
, "file copy", argc
, argv
);
619 static int file_cmd_size(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
623 if (file_stat(interp
, argv
[0], &sb
) != JIM_OK
) {
626 Jim_SetResultInt(interp
, sb
.st_size
);
630 static int file_cmd_isdirectory(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
635 if (file_stat(interp
, argv
[0], &sb
) == JIM_OK
) {
636 ret
= S_ISDIR(sb
.st_mode
);
638 Jim_SetResultInt(interp
, ret
);
642 static int file_cmd_isfile(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
647 if (file_stat(interp
, argv
[0], &sb
) == JIM_OK
) {
648 ret
= S_ISREG(sb
.st_mode
);
650 Jim_SetResultInt(interp
, ret
);
655 static int file_cmd_owned(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
660 if (file_stat(interp
, argv
[0], &sb
) == JIM_OK
) {
661 ret
= (geteuid() == sb
.st_uid
);
663 Jim_SetResultInt(interp
, ret
);
668 #if defined(HAVE_READLINK)
669 static int file_cmd_readlink(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
671 const char *path
= Jim_String(argv
[0]);
672 char *linkValue
= Jim_Alloc(MAXPATHLEN
+ 1);
674 int linkLength
= readlink(path
, linkValue
, MAXPATHLEN
);
676 if (linkLength
== -1) {
678 Jim_SetResultFormatted(interp
, "couldn't readlink \"%#s\": %s", argv
[0], strerror(errno
));
681 linkValue
[linkLength
] = 0;
682 Jim_SetResult(interp
, Jim_NewStringObjNoAlloc(interp
, linkValue
, linkLength
));
687 static int file_cmd_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
691 if (file_lstat(interp
, argv
[0], &sb
) != JIM_OK
) {
694 Jim_SetResultString(interp
, JimGetFileType((int)sb
.st_mode
), -1);
698 static int file_cmd_lstat(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
702 if (file_lstat(interp
, argv
[0], &sb
) != JIM_OK
) {
705 return StoreStatData(interp
, argv
[1], &sb
);
708 static int file_cmd_stat(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
712 if (file_stat(interp
, argv
[0], &sb
) != JIM_OK
) {
715 return StoreStatData(interp
, argv
[1], &sb
);
718 static const jim_subcmd_type file_command_table
[] = {
724 /* Description: Last access time */
731 /* Description: Get or set last modification time */
734 "?-force? source dest",
738 /* Description: Copy source file to destination file */
745 /* Description: Directory part of the name */
752 /* Description: Name without any extension */
759 /* Description: Last extension including the dot */
766 /* Description: Last component of the name */
773 /* Description: Normalized path of name */
780 /* Description: Join multiple path components */
787 /* Description: Is file readable */
794 /* Description: Is file writable */
801 /* Description: Is file executable */
808 /* Description: Does file exist */
811 "?-force|--? name ...",
815 /* Description: Deletes the files or directories (must be empty unless -force) */
822 /* Description: Creates the directories */
830 /* Description: Creates a temporary filename */
834 "?-force? source dest",
838 /* Description: Renames a file */
840 #if defined(HAVE_READLINK)
846 /* Description: Value of the symbolic link */
854 /* Description: Size of file */
861 /* Description: Stores results of stat in var array */
868 /* Description: Stores results of lstat in var array */
875 /* Description: Returns type of the file */
883 /* Description: Returns 1 if owned by the current owner */
888 file_cmd_isdirectory
,
891 /* Description: Returns 1 if name is a directory */
898 /* Description: Returns 1 if name is a file */
905 static int Jim_CdCmd(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
910 Jim_WrongNumArgs(interp
, 1, argv
, "dirname");
914 path
= Jim_String(argv
[1]);
916 if (chdir(path
) != 0) {
917 Jim_SetResultFormatted(interp
, "couldn't change working directory to \"%s\": %s", path
,
924 static int Jim_PwdCmd(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
926 const int cwd_len
= 2048;
927 char *cwd
= malloc(cwd_len
);
929 if (getcwd(cwd
, cwd_len
) == NULL
) {
930 Jim_SetResultString(interp
, "Failed to get pwd", -1);
933 #if defined(__MINGW32__) || defined(_MSC_VER)
935 /* Try to keep backlashes out of paths */
937 while ((p
= strchr(p
, '\\')) != NULL
) {
943 Jim_SetResultString(interp
, cwd
, -1);
949 int Jim_fileInit(Jim_Interp
*interp
)
951 if (Jim_PackageProvide(interp
, "file", "1.0", JIM_ERRMSG
))
954 Jim_CreateCommand(interp
, "file", Jim_SubCmdProc
, (void *)file_command_table
, NULL
);
955 Jim_CreateCommand(interp
, "pwd", Jim_PwdCmd
, NULL
, NULL
);
956 Jim_CreateCommand(interp
, "cd", Jim_CdCmd
, NULL
, NULL
);