/********************************************************************** file.c - $Author: usa $ created at: Mon Nov 15 12:24:34 JST 1993 Copyright (C) 1993-2007 Yukihiro Matsumoto Copyright (C) 2000 Network Applied Communication Laboratory, Inc. Copyright (C) 2000 Information-technology Promotion Agency, Japan **********************************************************************/ #ifdef _WIN32 #include "missing/file.h" #endif #ifdef __CYGWIN__ #include #include #include #endif #ifdef __APPLE__ #include #endif #include "id.h" #include "ruby/encoding.h" #include "ruby/io.h" #include "ruby/util.h" #include "ruby/thread.h" #include "internal.h" #include "dln.h" #include "encindex.h" #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_SYS_TIME_H # include #endif #ifdef HAVE_SYS_FILE_H # include #else int flock(int, int); #endif #ifdef HAVE_SYS_PARAM_H # include #endif #ifndef MAXPATHLEN # define MAXPATHLEN 1024 #endif #include #include #ifdef HAVE_UTIME_H #include #elif defined HAVE_SYS_UTIME_H #include #endif #ifdef HAVE_PWD_H #include #endif #ifdef HAVE_SYS_SYSMACROS_H #include #endif #include #include #ifdef HAVE_SYS_MKDEV_H #include #endif #if defined(HAVE_FCNTL_H) #include #endif #if defined(HAVE_SYS_TIME_H) #include #endif #if !defined HAVE_LSTAT && !defined lstat #define lstat stat #endif /* define system APIs */ #ifdef _WIN32 #include "win32/file.h" #define STAT(p, s) rb_w32_ustati128((p), (s)) #undef lstat #define lstat(p, s) rb_w32_ulstati128((p), (s)) #undef access #define access(p, m) rb_w32_uaccess((p), (m)) #undef truncate #define truncate(p, n) rb_w32_utruncate((p), (n)) #undef chmod #define chmod(p, m) rb_w32_uchmod((p), (m)) #undef chown #define chown(p, o, g) rb_w32_uchown((p), (o), (g)) #undef lchown #define lchown(p, o, g) rb_w32_ulchown((p), (o), (g)) #undef utimensat #define utimensat(s, p, t, f) rb_w32_uutimensat((s), (p), (t), (f)) #undef link #define link(f, t) rb_w32_ulink((f), (t)) #undef unlink #define unlink(p) rb_w32_uunlink(p) #undef rename #define rename(f, t) rb_w32_urename((f), (t)) #undef symlink #define symlink(s, l) rb_w32_usymlink((s), (l)) #else #define STAT(p, s) stat((p), (s)) #endif #if defined _WIN32 || defined __APPLE__ # define USE_OSPATH 1 # define TO_OSPATH(str) rb_str_encode_ospath(str) #else # define USE_OSPATH 0 # define TO_OSPATH(str) (str) #endif /* utime may fail if time is out-of-range for the FS [ruby-dev:38277] */ #if defined DOSISH || defined __CYGWIN__ # define UTIME_EINVAL #endif VALUE rb_cFile; VALUE rb_mFileTest; VALUE rb_cStat; #define insecure_obj_p(obj, level) ((level) > 0 && OBJ_TAINTED(obj)) static VALUE file_path_convert(VALUE name) { #ifndef _WIN32 /* non Windows == Unix */ int fname_encidx = ENCODING_GET(name); int fs_encidx; if (ENCINDEX_US_ASCII != fname_encidx && ENCINDEX_ASCII != fname_encidx && (fs_encidx = rb_filesystem_encindex()) != fname_encidx && rb_default_internal_encoding() && !rb_enc_str_asciionly_p(name)) { /* Don't call rb_filesystem_encoding() before US-ASCII and ASCII-8BIT */ /* fs_encoding should be ascii compatible */ rb_encoding *fname_encoding = rb_enc_from_index(fname_encidx); rb_encoding *fs_encoding = rb_enc_from_index(fs_encidx); name = rb_str_conv_enc(name, fname_encoding, fs_encoding); } #endif return name; } static rb_encoding * check_path_encoding(VALUE str) { rb_encoding *enc = rb_enc_get(str); if (!rb_enc_asciicompat(enc)) { rb_raise(rb_eEncCompatError, "path name must be ASCII-compatible (%s): %"PRIsVALUE, rb_enc_name(enc), rb_str_inspect(str)); } return enc; } VALUE rb_get_path_check_to_string(VALUE obj, int level) { VALUE tmp; ID to_path; if (insecure_obj_p(obj, level)) { rb_insecure_operation(); } if (RB_TYPE_P(obj, T_STRING)) { return obj; } CONST_ID(to_path, "to_path"); tmp = rb_check_funcall_default(obj, to_path, 0, 0, obj); StringValue(tmp); return tmp; } VALUE rb_get_path_check_convert(VALUE obj, VALUE tmp, int level) { tmp = file_path_convert(tmp); if (obj != tmp && insecure_obj_p(tmp, level)) { rb_insecure_operation(); } check_path_encoding(tmp); if (!rb_str_to_cstr(tmp)) { rb_raise(rb_eArgError, "path name contains null byte"); } return rb_str_new4(tmp); } VALUE rb_get_path_check(VALUE obj, int level) { VALUE tmp = rb_get_path_check_to_string(obj, level); return rb_get_path_check_convert(obj, tmp, level); } VALUE rb_get_path_no_checksafe(VALUE obj) { return rb_get_path_check(obj, 0); } VALUE rb_get_path(VALUE obj) { return rb_get_path_check(obj, rb_safe_level()); } VALUE rb_str_encode_ospath(VALUE path) { #if USE_OSPATH int encidx = ENCODING_GET(path); #ifdef _WIN32 if (encidx == ENCINDEX_ASCII) { encidx = rb_filesystem_encindex(); } #endif if (encidx != ENCINDEX_UTF_8) { rb_encoding *enc = rb_enc_from_index(encidx); rb_encoding *utf8 = rb_utf8_encoding(); path = rb_str_conv_enc(path, enc, utf8); } #endif return path; } #ifdef __APPLE__ # define NORMALIZE_UTF8PATH 1 static VALUE rb_str_append_normalized_ospath(VALUE str, const char *ptr, long len) { CFIndex buflen = 0; CFRange all; CFStringRef s = CFStringCreateWithBytesNoCopy(kCFAllocatorDefault, (const UInt8 *)ptr, len, kCFStringEncodingUTF8, FALSE, kCFAllocatorNull); CFMutableStringRef m = CFStringCreateMutableCopy(kCFAllocatorDefault, len, s); long oldlen = RSTRING_LEN(str); CFStringNormalize(m, kCFStringNormalizationFormC); all = CFRangeMake(0, CFStringGetLength(m)); CFStringGetBytes(m, all, kCFStringEncodingUTF8, '?', FALSE, NULL, 0, &buflen); rb_str_modify_expand(str, buflen); CFStringGetBytes(m, all, kCFStringEncodingUTF8, '?', FALSE, (UInt8 *)(RSTRING_PTR(str) + oldlen), buflen, &buflen); rb_str_set_len(str, oldlen + buflen); CFRelease(m); CFRelease(s); return str; } VALUE rb_str_normalize_ospath(const char *ptr, long len) { const char *p = ptr; const char *e = ptr + len; const char *p1 = p; VALUE str = rb_str_buf_new(len); rb_encoding *enc = rb_utf8_encoding(); rb_enc_associate(str, enc); while (p < e) { int l, c; int r = rb_enc_precise_mbclen(p, e, enc); if (!MBCLEN_CHARFOUND_P(r)) { /* invalid byte shall not happen but */ static const char invalid[3] = "\xEF\xBF\xBD"; rb_str_append_normalized_ospath(str, p1, p-p1); rb_str_cat(str, invalid, sizeof(invalid)); p += 1; p1 = p; continue; } l = MBCLEN_CHARFOUND_LEN(r); c = rb_enc_mbc_to_codepoint(p, e, enc); if ((0x2000 <= c && c <= 0x2FFF) || (0xF900 <= c && c <= 0xFAFF) || (0x2F800 <= c && c <= 0x2FAFF)) { if (p - p1 > 0) { rb_str_append_normalized_ospath(str, p1, p-p1); } rb_str_cat(str, p, l); p += l; p1 = p; } else { p += l; } } if (p - p1 > 0) { rb_str_append_normalized_ospath(str, p1, p-p1); } return str; } static int ignored_char_p(const char *p, const char *e, rb_encoding *enc) { unsigned char c; if (p+3 > e) return 0; switch ((unsigned char)*p) { case 0xe2: switch ((unsigned char)p[1]) { case 0x80: c = (unsigned char)p[2]; /* c >= 0x200c && c <= 0x200f */ if (c >= 0x8c && c <= 0x8f) return 3; /* c >= 0x202a && c <= 0x202e */ if (c >= 0xaa && c <= 0xae) return 3; return 0; case 0x81: c = (unsigned char)p[2]; /* c >= 0x206a && c <= 0x206f */ if (c >= 0xaa && c <= 0xaf) return 3; return 0; } break; case 0xef: /* c == 0xfeff */ if ((unsigned char)p[1] == 0xbb && (unsigned char)p[2] == 0xbf) return 3; break; } return 0; } #else # define NORMALIZE_UTF8PATH 0 #endif #define apply2args(n) (rb_check_arity(argc, n, UNLIMITED_ARGUMENTS), argc-=n) struct apply_filename { const char *ptr; VALUE path; }; struct apply_arg { int i; int argc; int errnum; int (*func)(const char *, void *); void *arg; struct apply_filename fn[FLEX_ARY_LEN]; }; static void * no_gvl_apply2files(void *ptr) { struct apply_arg *aa = ptr; for (aa->i = 0; aa->i < aa->argc; aa->i++) { if (aa->func(aa->fn[aa->i].ptr, aa->arg) < 0) { aa->errnum = errno; break; } } return 0; } #ifdef UTIME_EINVAL NORETURN(static void utime_failed(struct apply_arg *)); static int utime_internal(const char *, void *); #endif static VALUE apply2files(int (*func)(const char *, void *), int argc, VALUE *argv, void *arg) { VALUE v; const size_t size = sizeof(struct apply_filename); const long len = (long)(offsetof(struct apply_arg, fn) + (size * argc)); struct apply_arg *aa = ALLOCV(v, len); aa->errnum = 0; aa->argc = argc; aa->arg = arg; aa->func = func; for (aa->i = 0; aa->i < argc; aa->i++) { VALUE path = rb_get_path(argv[aa->i]); path = rb_str_encode_ospath(path); aa->fn[aa->i].ptr = RSTRING_PTR(path); aa->fn[aa->i].path = path; } rb_thread_call_without_gvl(no_gvl_apply2files, aa, RUBY_UBF_IO, 0); if (aa->errnum) { #ifdef UTIME_EINVAL if (func == utime_internal) { utime_failed(aa); } #endif rb_syserr_fail_path(aa->errnum, aa->fn[aa->i].path); } if (v) { ALLOCV_END(v); } return LONG2FIX(argc); } /* * call-seq: * file.path -> filename * file.to_path -> filename * * Returns the pathname used to create file as a string. Does * not normalize the name. * * The pathname may not point to the file corresponding to file. * For instance, the pathname becomes void when the file has been * moved or deleted. * * This method raises IOError for a file created using * File::Constants::TMPFILE because they don't have a pathname. * * File.new("testfile").path #=> "testfile" * File.new("/tmp/../tmp/xxx", "w").path #=> "/tmp/../tmp/xxx" * */ static VALUE rb_file_path(VALUE obj) { rb_io_t *fptr; fptr = RFILE(rb_io_taint_check(obj))->fptr; rb_io_check_initialized(fptr); if (NIL_P(fptr->pathv)) { rb_raise(rb_eIOError, "File is unnamed (TMPFILE?)"); } return rb_obj_taint(rb_str_dup(fptr->pathv)); } static size_t stat_memsize(const void *p) { return sizeof(struct stat); } static const rb_data_type_t stat_data_type = { "stat", {NULL, RUBY_TYPED_DEFAULT_FREE, stat_memsize,}, 0, 0, RUBY_TYPED_FREE_IMMEDIATELY }; static VALUE stat_new_0(VALUE klass, const struct stat *st) { struct stat *nst = 0; VALUE obj = TypedData_Wrap_Struct(klass, &stat_data_type, 0); if (st) { nst = ALLOC(struct stat); *nst = *st; RTYPEDDATA_DATA(obj) = nst; } return obj; } VALUE rb_stat_new(const struct stat *st) { return stat_new_0(rb_cStat, st); } static struct stat* get_stat(VALUE self) { struct stat* st; TypedData_Get_Struct(self, struct stat, &stat_data_type, st); if (!st) rb_raise(rb_eTypeError, "uninitialized File::Stat"); return st; } static struct timespec stat_mtimespec(struct stat *st); /* * call-seq: * stat <=> other_stat -> -1, 0, 1, nil * * Compares File::Stat objects by comparing their respective modification * times. * * +nil+ is returned if +other_stat+ is not a File::Stat object * * f1 = File.new("f1", "w") * sleep 1 * f2 = File.new("f2", "w") * f1.stat <=> f2.stat #=> -1 */ static VALUE rb_stat_cmp(VALUE self, VALUE other) { if (rb_obj_is_kind_of(other, rb_obj_class(self))) { struct timespec ts1 = stat_mtimespec(get_stat(self)); struct timespec ts2 = stat_mtimespec(get_stat(other)); if (ts1.tv_sec == ts2.tv_sec) { if (ts1.tv_nsec == ts2.tv_nsec) return INT2FIX(0); if (ts1.tv_nsec < ts2.tv_nsec) return INT2FIX(-1); return INT2FIX(1); } if (ts1.tv_sec < ts2.tv_sec) return INT2FIX(-1); return INT2FIX(1); } return Qnil; } #define ST2UINT(val) ((val) & ~(~1UL << (sizeof(val) * CHAR_BIT - 1))) #ifndef NUM2DEVT # define NUM2DEVT(v) NUM2UINT(v) #endif #ifndef DEVT2NUM # define DEVT2NUM(v) UINT2NUM(v) #endif #ifndef PRI_DEVT_PREFIX # define PRI_DEVT_PREFIX "" #endif /* * call-seq: * stat.dev -> integer * * Returns an integer representing the device on which stat * resides. * * File.stat("testfile").dev #=> 774 */ static VALUE rb_stat_dev(VALUE self) { return DEVT2NUM(get_stat(self)->st_dev); } /* * call-seq: * stat.dev_major -> integer * * Returns the major part of File_Stat#dev or * nil. * * File.stat("/dev/fd1").dev_major #=> 2 * File.stat("/dev/tty").dev_major #=> 5 */ static VALUE rb_stat_dev_major(VALUE self) { #if defined(major) return UINT2NUM(major(get_stat(self)->st_dev)); #else return Qnil; #endif } /* * call-seq: * stat.dev_minor -> integer * * Returns the minor part of File_Stat#dev or * nil. * * File.stat("/dev/fd1").dev_minor #=> 1 * File.stat("/dev/tty").dev_minor #=> 0 */ static VALUE rb_stat_dev_minor(VALUE self) { #if defined(minor) return UINT2NUM(minor(get_stat(self)->st_dev)); #else return Qnil; #endif } /* * call-seq: * stat.ino -> integer * * Returns the inode number for stat. * * File.stat("testfile").ino #=> 1083669 * */ static VALUE rb_stat_ino(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_INOHIGH /* assume INTEGER_PACK_LSWORD_FIRST and st_inohigh is just next of st_ino */ return rb_integer_unpack(&get_stat(self)->st_ino, 2, SIZEOF_STRUCT_STAT_ST_INO, 0, INTEGER_PACK_LSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER| INTEGER_PACK_2COMP); #elif SIZEOF_STRUCT_STAT_ST_INO > SIZEOF_LONG return ULL2NUM(get_stat(self)->st_ino); #else return ULONG2NUM(get_stat(self)->st_ino); #endif } /* * call-seq: * stat.mode -> integer * * Returns an integer representing the permission bits of * stat. The meaning of the bits is platform dependent; on * Unix systems, see stat(2). * * File.chmod(0644, "testfile") #=> 1 * s = File.stat("testfile") * sprintf("%o", s.mode) #=> "100644" */ static VALUE rb_stat_mode(VALUE self) { return UINT2NUM(ST2UINT(get_stat(self)->st_mode)); } /* * call-seq: * stat.nlink -> integer * * Returns the number of hard links to stat. * * File.stat("testfile").nlink #=> 1 * File.link("testfile", "testfile.bak") #=> 0 * File.stat("testfile").nlink #=> 2 * */ static VALUE rb_stat_nlink(VALUE self) { return UINT2NUM(get_stat(self)->st_nlink); } /* * call-seq: * stat.uid -> integer * * Returns the numeric user id of the owner of stat. * * File.stat("testfile").uid #=> 501 * */ static VALUE rb_stat_uid(VALUE self) { return UIDT2NUM(get_stat(self)->st_uid); } /* * call-seq: * stat.gid -> integer * * Returns the numeric group id of the owner of stat. * * File.stat("testfile").gid #=> 500 * */ static VALUE rb_stat_gid(VALUE self) { return GIDT2NUM(get_stat(self)->st_gid); } /* * call-seq: * stat.rdev -> integer or nil * * Returns an integer representing the device type on which * stat resides. Returns nil if the operating * system doesn't support this feature. * * File.stat("/dev/fd1").rdev #=> 513 * File.stat("/dev/tty").rdev #=> 1280 */ static VALUE rb_stat_rdev(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_RDEV return DEVT2NUM(get_stat(self)->st_rdev); #else return Qnil; #endif } /* * call-seq: * stat.rdev_major -> integer * * Returns the major part of File_Stat#rdev or * nil. * * File.stat("/dev/fd1").rdev_major #=> 2 * File.stat("/dev/tty").rdev_major #=> 5 */ static VALUE rb_stat_rdev_major(VALUE self) { #if defined(HAVE_STRUCT_STAT_ST_RDEV) && defined(major) return UINT2NUM(major(get_stat(self)->st_rdev)); #else return Qnil; #endif } /* * call-seq: * stat.rdev_minor -> integer * * Returns the minor part of File_Stat#rdev or * nil. * * File.stat("/dev/fd1").rdev_minor #=> 1 * File.stat("/dev/tty").rdev_minor #=> 0 */ static VALUE rb_stat_rdev_minor(VALUE self) { #if defined(HAVE_STRUCT_STAT_ST_RDEV) && defined(minor) return UINT2NUM(minor(get_stat(self)->st_rdev)); #else return Qnil; #endif } /* * call-seq: * stat.size -> integer * * Returns the size of stat in bytes. * * File.stat("testfile").size #=> 66 */ static VALUE rb_stat_size(VALUE self) { return OFFT2NUM(get_stat(self)->st_size); } /* * call-seq: * stat.blksize -> integer or nil * * Returns the native file system's block size. Will return nil * on platforms that don't support this information. * * File.stat("testfile").blksize #=> 4096 * */ static VALUE rb_stat_blksize(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE return ULONG2NUM(get_stat(self)->st_blksize); #else return Qnil; #endif } /* * call-seq: * stat.blocks -> integer or nil * * Returns the number of native file system blocks allocated for this * file, or nil if the operating system doesn't * support this feature. * * File.stat("testfile").blocks #=> 2 */ static VALUE rb_stat_blocks(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_BLOCKS # if SIZEOF_STRUCT_STAT_ST_BLOCKS > SIZEOF_LONG return ULL2NUM(get_stat(self)->st_blocks); # else return ULONG2NUM(get_stat(self)->st_blocks); # endif #else return Qnil; #endif } static struct timespec stat_atimespec(struct stat *st) { struct timespec ts; ts.tv_sec = st->st_atime; #if defined(HAVE_STRUCT_STAT_ST_ATIM) ts.tv_nsec = st->st_atim.tv_nsec; #elif defined(HAVE_STRUCT_STAT_ST_ATIMESPEC) ts.tv_nsec = st->st_atimespec.tv_nsec; #elif defined(HAVE_STRUCT_STAT_ST_ATIMENSEC) ts.tv_nsec = (long)st->st_atimensec; #else ts.tv_nsec = 0; #endif return ts; } static VALUE stat_atime(struct stat *st) { struct timespec ts = stat_atimespec(st); return rb_time_nano_new(ts.tv_sec, ts.tv_nsec); } static struct timespec stat_mtimespec(struct stat *st) { struct timespec ts; ts.tv_sec = st->st_mtime; #if defined(HAVE_STRUCT_STAT_ST_MTIM) ts.tv_nsec = st->st_mtim.tv_nsec; #elif defined(HAVE_STRUCT_STAT_ST_MTIMESPEC) ts.tv_nsec = st->st_mtimespec.tv_nsec; #elif defined(HAVE_STRUCT_STAT_ST_MTIMENSEC) ts.tv_nsec = (long)st->st_mtimensec; #else ts.tv_nsec = 0; #endif return ts; } static VALUE stat_mtime(struct stat *st) { struct timespec ts = stat_mtimespec(st); return rb_time_nano_new(ts.tv_sec, ts.tv_nsec); } static struct timespec stat_ctimespec(struct stat *st) { struct timespec ts; ts.tv_sec = st->st_ctime; #if defined(HAVE_STRUCT_STAT_ST_CTIM) ts.tv_nsec = st->st_ctim.tv_nsec; #elif defined(HAVE_STRUCT_STAT_ST_CTIMESPEC) ts.tv_nsec = st->st_ctimespec.tv_nsec; #elif defined(HAVE_STRUCT_STAT_ST_CTIMENSEC) ts.tv_nsec = (long)st->st_ctimensec; #else ts.tv_nsec = 0; #endif return ts; } static VALUE stat_ctime(struct stat *st) { struct timespec ts = stat_ctimespec(st); return rb_time_nano_new(ts.tv_sec, ts.tv_nsec); } #define HAVE_STAT_BIRTHTIME #if defined(HAVE_STRUCT_STAT_ST_BIRTHTIMESPEC) static VALUE stat_birthtime(struct stat *st) { struct timespec *ts = &st->st_birthtimespec; return rb_time_nano_new(ts->tv_sec, ts->tv_nsec); } #elif defined(_WIN32) # define stat_birthtime stat_ctime #else # undef HAVE_STAT_BIRTHTIME #endif /* * call-seq: * stat.atime -> time * * Returns the last access time for this file as an object of class * Time. * * File.stat("testfile").atime #=> Wed Dec 31 18:00:00 CST 1969 * */ static VALUE rb_stat_atime(VALUE self) { return stat_atime(get_stat(self)); } /* * call-seq: * stat.mtime -> aTime * * Returns the modification time of stat. * * File.stat("testfile").mtime #=> Wed Apr 09 08:53:14 CDT 2003 * */ static VALUE rb_stat_mtime(VALUE self) { return stat_mtime(get_stat(self)); } /* * call-seq: * stat.ctime -> aTime * * Returns the change time for stat (that is, the time * directory information about the file was changed, not the file * itself). * * Note that on Windows (NTFS), returns creation time (birth time). * * File.stat("testfile").ctime #=> Wed Apr 09 08:53:14 CDT 2003 * */ static VALUE rb_stat_ctime(VALUE self) { return stat_ctime(get_stat(self)); } #if defined(HAVE_STAT_BIRTHTIME) /* * call-seq: * stat.birthtime -> aTime * * Returns the birth time for stat. * * If the platform doesn't have birthtime, raises NotImplementedError. * * File.write("testfile", "foo") * sleep 10 * File.write("testfile", "bar") * sleep 10 * File.chmod(0644, "testfile") * sleep 10 * File.read("testfile") * File.stat("testfile").birthtime #=> 2014-02-24 11:19:17 +0900 * File.stat("testfile").mtime #=> 2014-02-24 11:19:27 +0900 * File.stat("testfile").ctime #=> 2014-02-24 11:19:37 +0900 * File.stat("testfile").atime #=> 2014-02-24 11:19:47 +0900 * */ static VALUE rb_stat_birthtime(VALUE self) { return stat_birthtime(get_stat(self)); } #else # define rb_stat_birthtime rb_f_notimplement #endif /* * call-seq: * stat.inspect -> string * * Produce a nicely formatted description of stat. * * File.stat("/etc/passwd").inspect * #=> "#" */ static VALUE rb_stat_inspect(VALUE self) { VALUE str; size_t i; static const struct { const char *name; VALUE (*func)(VALUE); } member[] = { {"dev", rb_stat_dev}, {"ino", rb_stat_ino}, {"mode", rb_stat_mode}, {"nlink", rb_stat_nlink}, {"uid", rb_stat_uid}, {"gid", rb_stat_gid}, {"rdev", rb_stat_rdev}, {"size", rb_stat_size}, {"blksize", rb_stat_blksize}, {"blocks", rb_stat_blocks}, {"atime", rb_stat_atime}, {"mtime", rb_stat_mtime}, {"ctime", rb_stat_ctime}, #if defined(HAVE_STRUCT_STAT_ST_BIRTHTIMESPEC) {"birthtime", rb_stat_birthtime}, #endif }; struct stat* st; TypedData_Get_Struct(self, struct stat, &stat_data_type, st); if (!st) { return rb_sprintf("#<%s: uninitialized>", rb_obj_classname(self)); } str = rb_str_buf_new2("#<"); rb_str_buf_cat2(str, rb_obj_classname(self)); rb_str_buf_cat2(str, " "); for (i = 0; i < sizeof(member)/sizeof(member[0]); i++) { VALUE v; if (i > 0) { rb_str_buf_cat2(str, ", "); } rb_str_buf_cat2(str, member[i].name); rb_str_buf_cat2(str, "="); v = (*member[i].func)(self); if (i == 2) { /* mode */ rb_str_catf(str, "0%lo", (unsigned long)NUM2ULONG(v)); } else if (i == 0 || i == 6) { /* dev/rdev */ rb_str_catf(str, "0x%"PRI_DEVT_PREFIX"x", NUM2DEVT(v)); } else { rb_str_append(str, rb_inspect(v)); } } rb_str_buf_cat2(str, ">"); OBJ_INFECT(str, self); return str; } typedef struct no_gvl_stat_data { struct stat *st; union { const char *path; int fd; } file; } no_gvl_stat_data; static VALUE no_gvl_fstat(void *data) { no_gvl_stat_data *arg = data; return (VALUE)fstat(arg->file.fd, arg->st); } static int fstat_without_gvl(int fd, struct stat *st) { no_gvl_stat_data data; data.file.fd = fd; data.st = st; return (int)(VALUE)rb_thread_io_blocking_region(no_gvl_fstat, &data, fd); } static void * no_gvl_stat(void * data) { no_gvl_stat_data *arg = data; return (void *)(VALUE)STAT(arg->file.path, arg->st); } static int stat_without_gvl(const char *path, struct stat *st) { no_gvl_stat_data data; data.file.path = path; data.st = st; return (int)(VALUE)rb_thread_call_without_gvl(no_gvl_stat, &data, RUBY_UBF_IO, NULL); } static int rb_stat(VALUE file, struct stat *st) { VALUE tmp; int result; tmp = rb_check_convert_type_with_id(file, T_FILE, "IO", idTo_io); if (!NIL_P(tmp)) { rb_io_t *fptr; GetOpenFile(tmp, fptr); result = fstat_without_gvl(fptr->fd, st); file = tmp; } else { FilePathValue(file); file = rb_str_encode_ospath(file); result = stat_without_gvl(RSTRING_PTR(file), st); } RB_GC_GUARD(file); return result; } /* * call-seq: * File.stat(file_name) -> stat * * Returns a File::Stat object for the named file (see * File::Stat). * * File.stat("testfile").mtime #=> Tue Apr 08 12:58:04 CDT 2003 * */ static VALUE rb_file_s_stat(VALUE klass, VALUE fname) { struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (stat_without_gvl(RSTRING_PTR(fname), &st) < 0) { rb_sys_fail_path(fname); } return rb_stat_new(&st); } /* * call-seq: * ios.stat -> stat * * Returns status information for ios as an object of type * File::Stat. * * f = File.new("testfile") * s = f.stat * "%o" % s.mode #=> "100644" * s.blksize #=> 4096 * s.atime #=> Wed Apr 09 08:53:54 CDT 2003 * */ static VALUE rb_io_stat(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return rb_stat_new(&st); } #ifdef HAVE_LSTAT static void * no_gvl_lstat(void *ptr) { no_gvl_stat_data *arg = ptr; return (void *)(VALUE)lstat(arg->file.path, arg->st); } static int lstat_without_gvl(const char *path, struct stat *st) { no_gvl_stat_data data; data.file.path = path; data.st = st; return (int)(VALUE)rb_thread_call_without_gvl(no_gvl_lstat, &data, RUBY_UBF_IO, NULL); } #endif /* HAVE_LSTAT */ /* * call-seq: * File.lstat(file_name) -> stat * * Same as File::stat, but does not follow the last symbolic * link. Instead, reports on the link itself. * * File.symlink("testfile", "link2test") #=> 0 * File.stat("testfile").size #=> 66 * File.lstat("link2test").size #=> 8 * File.stat("link2test").size #=> 66 * */ static VALUE rb_file_s_lstat(VALUE klass, VALUE fname) { #ifdef HAVE_LSTAT struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (lstat_without_gvl(StringValueCStr(fname), &st) == -1) { rb_sys_fail_path(fname); } return rb_stat_new(&st); #else return rb_file_s_stat(klass, fname); #endif } /* * call-seq: * file.lstat -> stat * * Same as IO#stat, but does not follow the last symbolic * link. Instead, reports on the link itself. * * File.symlink("testfile", "link2test") #=> 0 * File.stat("testfile").size #=> 66 * f = File.new("link2test") * f.lstat.size #=> 8 * f.stat.size #=> 66 */ static VALUE rb_file_lstat(VALUE obj) { #ifdef HAVE_LSTAT rb_io_t *fptr; struct stat st; VALUE path; GetOpenFile(obj, fptr); if (NIL_P(fptr->pathv)) return Qnil; path = rb_str_encode_ospath(fptr->pathv); if (lstat_without_gvl(RSTRING_PTR(path), &st) == -1) { rb_sys_fail_path(fptr->pathv); } return rb_stat_new(&st); #else return rb_io_stat(obj); #endif } static int rb_group_member(GETGROUPS_T gid) { #if defined(_WIN32) || !defined(HAVE_GETGROUPS) return FALSE; #else int rv = FALSE; int groups = 16; VALUE v = 0; GETGROUPS_T *gary; int anum = -1; if (getgid() == gid || getegid() == gid) return TRUE; /* * On Mac OS X (Mountain Lion), NGROUPS is 16. But libc and kernel * accept more larger value. * So we don't trunk NGROUPS anymore. */ while (groups <= RB_MAX_GROUPS) { gary = ALLOCV_N(GETGROUPS_T, v, groups); anum = getgroups(groups, gary); if (anum != -1 && anum != groups) break; groups *= 2; if (v) { ALLOCV_END(v); v = 0; } } if (anum == -1) return FALSE; while (--anum >= 0) { if (gary[anum] == gid) { rv = TRUE; break; } } if (v) ALLOCV_END(v); return rv; #endif } #ifndef S_IXUGO # define S_IXUGO (S_IXUSR | S_IXGRP | S_IXOTH) #endif #if defined(S_IXGRP) && !defined(_WIN32) && !defined(__CYGWIN__) #define USE_GETEUID 1 #endif #ifndef HAVE_EACCESS int eaccess(const char *path, int mode) { #ifdef USE_GETEUID struct stat st; rb_uid_t euid; euid = geteuid(); /* no setuid nor setgid. run shortcut. */ if (getuid() == euid && getgid() == getegid()) return access(path, mode); if (STAT(path, &st) < 0) return -1; if (euid == 0) { /* Root can read or write any file. */ if (!(mode & X_OK)) return 0; /* Root can execute any file that has any one of the execute bits set. */ if (st.st_mode & S_IXUGO) return 0; return -1; } if (st.st_uid == euid) /* owner */ mode <<= 6; else if (rb_group_member(st.st_gid)) mode <<= 3; if ((int)(st.st_mode & mode) == mode) return 0; return -1; #else return access(path, mode); #endif } #endif struct access_arg { const char *path; int mode; }; static void * nogvl_eaccess(void *ptr) { struct access_arg *aa = ptr; return (void *)(VALUE)eaccess(aa->path, aa->mode); } static int rb_eaccess(VALUE fname, int mode) { struct access_arg aa; FilePathValue(fname); fname = rb_str_encode_ospath(fname); aa.path = StringValueCStr(fname); aa.mode = mode; return (int)(VALUE)rb_thread_call_without_gvl(nogvl_eaccess, &aa, RUBY_UBF_IO, 0); } static void * nogvl_access(void *ptr) { struct access_arg *aa = ptr; return (void *)(VALUE)access(aa->path, aa->mode); } static int rb_access(VALUE fname, int mode) { struct access_arg aa; FilePathValue(fname); fname = rb_str_encode_ospath(fname); aa.path = StringValueCStr(fname); aa.mode = mode; return (int)(VALUE)rb_thread_call_without_gvl(nogvl_access, &aa, RUBY_UBF_IO, 0); } /* * Document-class: FileTest * * FileTest implements file test operations similar to * those used in File::Stat. It exists as a standalone * module, and its methods are also insinuated into the File * class. (Note that this is not done by inclusion: the interpreter cheats). * */ /* * Document-method: directory? * * call-seq: * File.directory?(file_name) -> true or false * * Returns true if the named file is a directory, * or a symlink that points at a directory, and false * otherwise. * * _file_name_ can be an IO object. * * File.directory?(".") */ VALUE rb_file_directory_p(VALUE obj, VALUE fname) { #ifndef S_ISDIR # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR) #endif struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISDIR(st.st_mode)) return Qtrue; return Qfalse; } /* * call-seq: * File.pipe?(file_name) -> true or false * * Returns true if the named file is a pipe. * * _file_name_ can be an IO object. */ static VALUE rb_file_pipe_p(VALUE obj, VALUE fname) { #ifdef S_IFIFO # ifndef S_ISFIFO # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO) # endif struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISFIFO(st.st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * File.symlink?(file_name) -> true or false * * Returns true if the named file is a symbolic link. */ static VALUE rb_file_symlink_p(VALUE obj, VALUE fname) { #ifndef S_ISLNK # ifdef _S_ISLNK # define S_ISLNK(m) _S_ISLNK(m) # else # ifdef _S_IFLNK # define S_ISLNK(m) (((m) & S_IFMT) == _S_IFLNK) # else # ifdef S_IFLNK # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK) # endif # endif # endif #endif #ifdef S_ISLNK struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (lstat_without_gvl(StringValueCStr(fname), &st) < 0) return Qfalse; if (S_ISLNK(st.st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * File.socket?(file_name) -> true or false * * Returns true if the named file is a socket. * * _file_name_ can be an IO object. */ static VALUE rb_file_socket_p(VALUE obj, VALUE fname) { #ifndef S_ISSOCK # ifdef _S_ISSOCK # define S_ISSOCK(m) _S_ISSOCK(m) # else # ifdef _S_IFSOCK # define S_ISSOCK(m) (((m) & S_IFMT) == _S_IFSOCK) # else # ifdef S_IFSOCK # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK) # endif # endif # endif #endif #ifdef S_ISSOCK struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISSOCK(st.st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * File.blockdev?(file_name) -> true or false * * Returns true if the named file is a block device. * * _file_name_ can be an IO object. */ static VALUE rb_file_blockdev_p(VALUE obj, VALUE fname) { #ifndef S_ISBLK # ifdef S_IFBLK # define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK) # else # define S_ISBLK(m) (0) /* anytime false */ # endif #endif #ifdef S_ISBLK struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISBLK(st.st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * File.chardev?(file_name) -> true or false * * Returns true if the named file is a character device. * * _file_name_ can be an IO object. */ static VALUE rb_file_chardev_p(VALUE obj, VALUE fname) { #ifndef S_ISCHR # define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR) #endif struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISCHR(st.st_mode)) return Qtrue; return Qfalse; } /* * call-seq: * File.exist?(file_name) -> true or false * * Return true if the named file exists. * * _file_name_ can be an IO object. * * "file exists" means that stat() or fstat() system call is successful. */ static VALUE rb_file_exist_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; return Qtrue; } /* * call-seq: * File.exists?(file_name) -> true or false * * Deprecated method. Don't use. */ static VALUE rb_file_exists_p(VALUE obj, VALUE fname) { const char *s = "FileTest#"; if (obj == rb_mFileTest) { s = "FileTest."; } else if (obj == rb_cFile || (RB_TYPE_P(obj, T_CLASS) && RTEST(rb_class_inherited_p(obj, rb_cFile)))) { s = "File."; } rb_warning("%sexists? is a deprecated name, use %sexist? instead", s, s); return rb_file_exist_p(obj, fname); } /* * call-seq: * File.readable?(file_name) -> true or false * * Returns true if the named file is readable by the effective * user and group id of this process. See eaccess(3). */ static VALUE rb_file_readable_p(VALUE obj, VALUE fname) { if (rb_eaccess(fname, R_OK) < 0) return Qfalse; return Qtrue; } /* * call-seq: * File.readable_real?(file_name) -> true or false * * Returns true if the named file is readable by the real * user and group id of this process. See access(3). */ static VALUE rb_file_readable_real_p(VALUE obj, VALUE fname) { if (rb_access(fname, R_OK) < 0) return Qfalse; return Qtrue; } #ifndef S_IRUGO # define S_IRUGO (S_IRUSR | S_IRGRP | S_IROTH) #endif #ifndef S_IWUGO # define S_IWUGO (S_IWUSR | S_IWGRP | S_IWOTH) #endif /* * call-seq: * File.world_readable?(file_name) -> integer or nil * * If file_name is readable by others, returns an integer * representing the file permission bits of file_name. Returns * nil otherwise. The meaning of the bits is platform * dependent; on Unix systems, see stat(2). * * _file_name_ can be an IO object. * * File.world_readable?("/etc/passwd") #=> 420 * m = File.world_readable?("/etc/passwd") * sprintf("%o", m) #=> "644" */ static VALUE rb_file_world_readable_p(VALUE obj, VALUE fname) { #ifdef S_IROTH struct stat st; if (rb_stat(fname, &st) < 0) return Qnil; if ((st.st_mode & (S_IROTH)) == S_IROTH) { return UINT2NUM(st.st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } #endif return Qnil; } /* * call-seq: * File.writable?(file_name) -> true or false * * Returns true if the named file is writable by the effective * user and group id of this process. See eaccess(3). */ static VALUE rb_file_writable_p(VALUE obj, VALUE fname) { if (rb_eaccess(fname, W_OK) < 0) return Qfalse; return Qtrue; } /* * call-seq: * File.writable_real?(file_name) -> true or false * * Returns true if the named file is writable by the real * user and group id of this process. See access(3) */ static VALUE rb_file_writable_real_p(VALUE obj, VALUE fname) { if (rb_access(fname, W_OK) < 0) return Qfalse; return Qtrue; } /* * call-seq: * File.world_writable?(file_name) -> integer or nil * * If file_name is writable by others, returns an integer * representing the file permission bits of file_name. Returns * nil otherwise. The meaning of the bits is platform * dependent; on Unix systems, see stat(2). * * _file_name_ can be an IO object. * * File.world_writable?("/tmp") #=> 511 * m = File.world_writable?("/tmp") * sprintf("%o", m) #=> "777" */ static VALUE rb_file_world_writable_p(VALUE obj, VALUE fname) { #ifdef S_IWOTH struct stat st; if (rb_stat(fname, &st) < 0) return Qnil; if ((st.st_mode & (S_IWOTH)) == S_IWOTH) { return UINT2NUM(st.st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } #endif return Qnil; } /* * call-seq: * File.executable?(file_name) -> true or false * * Returns true if the named file is executable by the effective * user and group id of this process. See eaccess(3). */ static VALUE rb_file_executable_p(VALUE obj, VALUE fname) { if (rb_eaccess(fname, X_OK) < 0) return Qfalse; return Qtrue; } /* * call-seq: * File.executable_real?(file_name) -> true or false * * Returns true if the named file is executable by the real * user and group id of this process. See access(3). */ static VALUE rb_file_executable_real_p(VALUE obj, VALUE fname) { if (rb_access(fname, X_OK) < 0) return Qfalse; return Qtrue; } #ifndef S_ISREG # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG) #endif /* * call-seq: * File.file?(file) -> true or false * * Returns +true+ if the named +file+ exists and is a regular file. * * +file+ can be an IO object. * * If the +file+ argument is a symbolic link, it will resolve the symbolic link * and use the file referenced by the link. */ static VALUE rb_file_file_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISREG(st.st_mode)) return Qtrue; return Qfalse; } /* * call-seq: * File.zero?(file_name) -> true or false * * Returns true if the named file exists and has * a zero size. * * _file_name_ can be an IO object. */ static VALUE rb_file_zero_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (st.st_size == 0) return Qtrue; return Qfalse; } /* * call-seq: * File.size?(file_name) -> Integer or nil * * Returns +nil+ if +file_name+ doesn't exist or has zero size, the size of the * file otherwise. * * _file_name_ can be an IO object. */ static VALUE rb_file_size_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qnil; if (st.st_size == 0) return Qnil; return OFFT2NUM(st.st_size); } /* * call-seq: * File.owned?(file_name) -> true or false * * Returns true if the named file exists and the * effective used id of the calling process is the owner of * the file. * * _file_name_ can be an IO object. */ static VALUE rb_file_owned_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (st.st_uid == geteuid()) return Qtrue; return Qfalse; } static VALUE rb_file_rowned_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (st.st_uid == getuid()) return Qtrue; return Qfalse; } /* * call-seq: * File.grpowned?(file_name) -> true or false * * Returns true if the named file exists and the * effective group id of the calling process is the owner of * the file. Returns false on Windows. * * _file_name_ can be an IO object. */ static VALUE rb_file_grpowned_p(VALUE obj, VALUE fname) { #ifndef _WIN32 struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (rb_group_member(st.st_gid)) return Qtrue; #endif return Qfalse; } #if defined(S_ISUID) || defined(S_ISGID) || defined(S_ISVTX) static VALUE check3rdbyte(VALUE fname, int mode) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (st.st_mode & mode) return Qtrue; return Qfalse; } #endif /* * call-seq: * File.setuid?(file_name) -> true or false * * Returns true if the named file has the setuid bit set. * * _file_name_ can be an IO object. */ static VALUE rb_file_suid_p(VALUE obj, VALUE fname) { #ifdef S_ISUID return check3rdbyte(fname, S_ISUID); #else return Qfalse; #endif } /* * call-seq: * File.setgid?(file_name) -> true or false * * Returns true if the named file has the setgid bit set. * * _file_name_ can be an IO object. */ static VALUE rb_file_sgid_p(VALUE obj, VALUE fname) { #ifdef S_ISGID return check3rdbyte(fname, S_ISGID); #else return Qfalse; #endif } /* * call-seq: * File.sticky?(file_name) -> true or false * * Returns true if the named file has the sticky bit set. * * _file_name_ can be an IO object. */ static VALUE rb_file_sticky_p(VALUE obj, VALUE fname) { #ifdef S_ISVTX return check3rdbyte(fname, S_ISVTX); #else return Qnil; #endif } /* * call-seq: * File.identical?(file_1, file_2) -> true or false * * Returns true if the named files are identical. * * _file_1_ and _file_2_ can be an IO object. * * open("a", "w") {} * p File.identical?("a", "a") #=> true * p File.identical?("a", "./a") #=> true * File.link("a", "b") * p File.identical?("a", "b") #=> true * File.symlink("a", "c") * p File.identical?("a", "c") #=> true * open("d", "w") {} * p File.identical?("a", "d") #=> false */ static VALUE rb_file_identical_p(VALUE obj, VALUE fname1, VALUE fname2) { #ifndef _WIN32 struct stat st1, st2; if (rb_stat(fname1, &st1) < 0) return Qfalse; if (rb_stat(fname2, &st2) < 0) return Qfalse; if (st1.st_dev != st2.st_dev) return Qfalse; if (st1.st_ino != st2.st_ino) return Qfalse; return Qtrue; #else extern VALUE rb_w32_file_identical_p(VALUE, VALUE); return rb_w32_file_identical_p(fname1, fname2); #endif } /* * call-seq: * File.size(file_name) -> integer * * Returns the size of file_name. * * _file_name_ can be an IO object. */ static VALUE rb_file_s_size(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return OFFT2NUM(st.st_size); } static VALUE rb_file_ftype(const struct stat *st) { const char *t; if (S_ISREG(st->st_mode)) { t = "file"; } else if (S_ISDIR(st->st_mode)) { t = "directory"; } else if (S_ISCHR(st->st_mode)) { t = "characterSpecial"; } #ifdef S_ISBLK else if (S_ISBLK(st->st_mode)) { t = "blockSpecial"; } #endif #ifdef S_ISFIFO else if (S_ISFIFO(st->st_mode)) { t = "fifo"; } #endif #ifdef S_ISLNK else if (S_ISLNK(st->st_mode)) { t = "link"; } #endif #ifdef S_ISSOCK else if (S_ISSOCK(st->st_mode)) { t = "socket"; } #endif else { t = "unknown"; } return rb_usascii_str_new2(t); } /* * call-seq: * File.ftype(file_name) -> string * * Identifies the type of the named file; the return string is one of * ``file'', ``directory'', * ``characterSpecial'', ``blockSpecial'', * ``fifo'', ``link'', * ``socket'', or ``unknown''. * * File.ftype("testfile") #=> "file" * File.ftype("/dev/tty") #=> "characterSpecial" * File.ftype("/tmp/.X11-unix/X0") #=> "socket" */ static VALUE rb_file_s_ftype(VALUE klass, VALUE fname) { struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (lstat_without_gvl(StringValueCStr(fname), &st) == -1) { rb_sys_fail_path(fname); } return rb_file_ftype(&st); } /* * call-seq: * File.atime(file_name) -> time * * Returns the last access time for the named file as a Time object. * * _file_name_ can be an IO object. * * File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003 * */ static VALUE rb_file_s_atime(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return stat_atime(&st); } /* * call-seq: * file.atime -> time * * Returns the last access time (a Time object) * for file, or epoch if file has not been accessed. * * File.new("testfile").atime #=> Wed Dec 31 18:00:00 CST 1969 * */ static VALUE rb_file_atime(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return stat_atime(&st); } /* * call-seq: * File.mtime(file_name) -> time * * Returns the modification time for the named file as a Time object. * * _file_name_ can be an IO object. * * File.mtime("testfile") #=> Tue Apr 08 12:58:04 CDT 2003 * */ static VALUE rb_file_s_mtime(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return stat_mtime(&st); } /* * call-seq: * file.mtime -> time * * Returns the modification time for file. * * File.new("testfile").mtime #=> Wed Apr 09 08:53:14 CDT 2003 * */ static VALUE rb_file_mtime(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return stat_mtime(&st); } /* * call-seq: * File.ctime(file_name) -> time * * Returns the change time for the named file (the time at which * directory information about the file was changed, not the file * itself). * * _file_name_ can be an IO object. * * Note that on Windows (NTFS), returns creation time (birth time). * * File.ctime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003 * */ static VALUE rb_file_s_ctime(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return stat_ctime(&st); } /* * call-seq: * file.ctime -> time * * Returns the change time for file (that is, the time directory * information about the file was changed, not the file itself). * * Note that on Windows (NTFS), returns creation time (birth time). * * File.new("testfile").ctime #=> Wed Apr 09 08:53:14 CDT 2003 * */ static VALUE rb_file_ctime(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return stat_ctime(&st); } #if defined(HAVE_STAT_BIRTHTIME) /* * call-seq: * File.birthtime(file_name) -> time * * Returns the birth time for the named file. * * _file_name_ can be an IO object. * * File.birthtime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003 * * If the platform doesn't have birthtime, raises NotImplementedError. * */ static VALUE rb_file_s_birthtime(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return stat_birthtime(&st); } #else # define rb_file_s_birthtime rb_f_notimplement #endif #if defined(HAVE_STAT_BIRTHTIME) /* * call-seq: * file.birthtime -> time * * Returns the birth time for file. * * File.new("testfile").birthtime #=> Wed Apr 09 08:53:14 CDT 2003 * * If the platform doesn't have birthtime, raises NotImplementedError. * */ static VALUE rb_file_birthtime(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return stat_birthtime(&st); } #else # define rb_file_birthtime rb_f_notimplement #endif /* * call-seq: * file.size -> integer * * Returns the size of file in bytes. * * File.new("testfile").size #=> 66 * */ static VALUE rb_file_size(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fptr->mode & FMODE_WRITABLE) { rb_io_flush_raw(obj, 0); } if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return OFFT2NUM(st.st_size); } static int chmod_internal(const char *path, void *mode) { return chmod(path, *(mode_t *)mode); } /* * call-seq: * File.chmod(mode_int, file_name, ... ) -> integer * * Changes permission bits on the named file(s) to the bit pattern * represented by mode_int. Actual effects are operating system * dependent (see the beginning of this section). On Unix systems, see * chmod(2) for details. Returns the number of files * processed. * * File.chmod(0644, "testfile", "out") #=> 2 */ static VALUE rb_file_s_chmod(int argc, VALUE *argv) { mode_t mode; apply2args(1); mode = NUM2MODET(*argv++); return apply2files(chmod_internal, argc, argv, &mode); } /* * call-seq: * file.chmod(mode_int) -> 0 * * Changes permission bits on file to the bit pattern * represented by mode_int. Actual effects are platform * dependent; on Unix systems, see chmod(2) for details. * Follows symbolic links. Also see File#lchmod. * * f = File.new("out", "w"); * f.chmod(0644) #=> 0 */ static VALUE rb_file_chmod(VALUE obj, VALUE vmode) { rb_io_t *fptr; mode_t mode; #if !defined HAVE_FCHMOD || !HAVE_FCHMOD VALUE path; #endif mode = NUM2MODET(vmode); GetOpenFile(obj, fptr); #ifdef HAVE_FCHMOD if (fchmod(fptr->fd, mode) == -1) { if (HAVE_FCHMOD || errno != ENOSYS) rb_sys_fail_path(fptr->pathv); } else { if (!HAVE_FCHMOD) return INT2FIX(0); } #endif #if !defined HAVE_FCHMOD || !HAVE_FCHMOD if (NIL_P(fptr->pathv)) return Qnil; path = rb_str_encode_ospath(fptr->pathv); if (chmod(RSTRING_PTR(path), mode) == -1) rb_sys_fail_path(fptr->pathv); #endif return INT2FIX(0); } #if defined(HAVE_LCHMOD) static int lchmod_internal(const char *path, void *mode) { return lchmod(path, *(mode_t *)mode); } /* * call-seq: * File.lchmod(mode_int, file_name, ...) -> integer * * Equivalent to File::chmod, but does not follow symbolic * links (so it will change the permissions associated with the link, * not the file referenced by the link). Often not available. * */ static VALUE rb_file_s_lchmod(int argc, VALUE *argv) { mode_t mode; apply2args(1); mode = NUM2MODET(*argv++); return apply2files(lchmod_internal, argc, argv, &mode); } #else #define rb_file_s_lchmod rb_f_notimplement #endif static inline rb_uid_t to_uid(VALUE u) { if (NIL_P(u)) { return (rb_uid_t)-1; } return NUM2UIDT(u); } static inline rb_gid_t to_gid(VALUE g) { if (NIL_P(g)) { return (rb_gid_t)-1; } return NUM2GIDT(g); } struct chown_args { rb_uid_t owner; rb_gid_t group; }; static int chown_internal(const char *path, void *arg) { struct chown_args *args = arg; return chown(path, args->owner, args->group); } /* * call-seq: * File.chown(owner_int, group_int, file_name, ...) -> integer * * Changes the owner and group of the named file(s) to the given * numeric owner and group id's. Only a process with superuser * privileges may change the owner of a file. The current owner of a * file may change the file's group to any group to which the owner * belongs. A nil or -1 owner or group id is ignored. * Returns the number of files processed. * * File.chown(nil, 100, "testfile") * */ static VALUE rb_file_s_chown(int argc, VALUE *argv) { struct chown_args arg; apply2args(2); arg.owner = to_uid(*argv++); arg.group = to_gid(*argv++); return apply2files(chown_internal, argc, argv, &arg); } /* * call-seq: * file.chown(owner_int, group_int ) -> 0 * * Changes the owner and group of file to the given numeric * owner and group id's. Only a process with superuser privileges may * change the owner of a file. The current owner of a file may change * the file's group to any group to which the owner belongs. A * nil or -1 owner or group id is ignored. Follows * symbolic links. See also File#lchown. * * File.new("testfile").chown(502, 1000) * */ static VALUE rb_file_chown(VALUE obj, VALUE owner, VALUE group) { rb_io_t *fptr; rb_uid_t o; rb_gid_t g; #ifndef HAVE_FCHOWN VALUE path; #endif o = to_uid(owner); g = to_gid(group); GetOpenFile(obj, fptr); #ifndef HAVE_FCHOWN if (NIL_P(fptr->pathv)) return Qnil; path = rb_str_encode_ospath(fptr->pathv); if (chown(RSTRING_PTR(path), o, g) == -1) rb_sys_fail_path(fptr->pathv); #else if (fchown(fptr->fd, o, g) == -1) rb_sys_fail_path(fptr->pathv); #endif return INT2FIX(0); } #if defined(HAVE_LCHOWN) static int lchown_internal(const char *path, void *arg) { struct chown_args *args = arg; return lchown(path, args->owner, args->group); } /* * call-seq: * File.lchown(owner_int, group_int, file_name,..) -> integer * * Equivalent to File::chown, but does not follow symbolic * links (so it will change the owner associated with the link, not the * file referenced by the link). Often not available. Returns number * of files in the argument list. * */ static VALUE rb_file_s_lchown(int argc, VALUE *argv) { struct chown_args arg; apply2args(2); arg.owner = to_uid(*argv++); arg.group = to_gid(*argv++); return apply2files(lchown_internal, argc, argv, &arg); } #else #define rb_file_s_lchown rb_f_notimplement #endif struct utime_args { const struct timespec* tsp; VALUE atime, mtime; int follow; /* Whether to act on symlinks (1) or their referent (0) */ }; #ifdef UTIME_EINVAL NORETURN(static void utime_failed(struct apply_arg *)); static void utime_failed(struct apply_arg *aa) { int e = aa->errnum; VALUE path = aa->fn[aa->i].path; struct utime_args *ua = aa->arg; if (ua->tsp && e == EINVAL) { VALUE e[2], a = Qnil, m = Qnil; int d = 0; VALUE atime = ua->atime; VALUE mtime = ua->mtime; if (!NIL_P(atime)) { a = rb_inspect(atime); } if (!NIL_P(mtime) && mtime != atime && !rb_equal(atime, mtime)) { m = rb_inspect(mtime); } if (NIL_P(a)) e[0] = m; else if (NIL_P(m) || rb_str_cmp(a, m) == 0) e[0] = a; else { e[0] = rb_str_plus(a, rb_str_new_cstr(" or ")); rb_str_append(e[0], m); d = 1; } if (!NIL_P(e[0])) { if (path) { if (!d) e[0] = rb_str_dup(e[0]); rb_str_append(rb_str_cat2(e[0], " for "), path); } e[1] = INT2FIX(EINVAL); rb_exc_raise(rb_class_new_instance(2, e, rb_eSystemCallError)); } } rb_syserr_fail_path(e, path); } #endif #if defined(HAVE_UTIMES) static int utime_internal(const char *path, void *arg) { struct utime_args *v = arg; const struct timespec *tsp = v->tsp; struct timeval tvbuf[2], *tvp = NULL; #if defined(HAVE_UTIMENSAT) static int try_utimensat = 1; # ifdef AT_SYMLINK_NOFOLLOW static int try_utimensat_follow = 1; # else const int try_utimensat_follow = 0; # endif int flags = 0; if (v->follow ? try_utimensat_follow : try_utimensat) { # ifdef AT_SYMLINK_NOFOLLOW if (v->follow) { flags = AT_SYMLINK_NOFOLLOW; } # endif if (utimensat(AT_FDCWD, path, tsp, flags) < 0) { if (errno == ENOSYS) { # ifdef AT_SYMLINK_NOFOLLOW try_utimensat_follow = 0; # endif if (!v->follow) try_utimensat = 0; goto no_utimensat; } return -1; /* calls utime_failed */ } return 0; } no_utimensat: #endif if (tsp) { tvbuf[0].tv_sec = tsp[0].tv_sec; tvbuf[0].tv_usec = (int)(tsp[0].tv_nsec / 1000); tvbuf[1].tv_sec = tsp[1].tv_sec; tvbuf[1].tv_usec = (int)(tsp[1].tv_nsec / 1000); tvp = tvbuf; } #ifdef HAVE_LUTIMES if (v->follow) return lutimes(path, tvp); #endif return utimes(path, tvp); } #else #if !defined HAVE_UTIME_H && !defined HAVE_SYS_UTIME_H struct utimbuf { long actime; long modtime; }; #endif static int utime_internal(const char *path, void *arg) { struct utime_args *v = arg; const struct timespec *tsp = v->tsp; struct utimbuf utbuf, *utp = NULL; if (tsp) { utbuf.actime = tsp[0].tv_sec; utbuf.modtime = tsp[1].tv_sec; utp = &utbuf; } return utime(path, utp); } #endif static VALUE utime_internal_i(int argc, VALUE *argv, int follow) { struct utime_args args; struct timespec tss[2], *tsp = NULL; apply2args(2); args.atime = *argv++; args.mtime = *argv++; args.follow = follow; if (!NIL_P(args.atime) || !NIL_P(args.mtime)) { tsp = tss; tsp[0] = rb_time_timespec(args.atime); if (args.atime == args.mtime) tsp[1] = tsp[0]; else tsp[1] = rb_time_timespec(args.mtime); } args.tsp = tsp; return apply2files(utime_internal, argc, argv, &args); } /* * call-seq: * File.utime(atime, mtime, file_name, ...) -> integer * * Sets the access and modification times of each named file to the * first two arguments. If a file is a symlink, this method acts upon * its referent rather than the link itself; for the inverse * behavior see File.lutime. Returns the number of file * names in the argument list. */ static VALUE rb_file_s_utime(int argc, VALUE *argv) { return utime_internal_i(argc, argv, FALSE); } #if defined(HAVE_UTIMES) && (defined(HAVE_LUTIMES) || (defined(HAVE_UTIMENSAT) && defined(AT_SYMLINK_NOFOLLOW))) /* * call-seq: * File.lutime(atime, mtime, file_name, ...) -> integer * * Sets the access and modification times of each named file to the * first two arguments. If a file is a symlink, this method acts upon * the link itself as opposed to its referent; for the inverse * behavior, see File.utime. Returns the number of file * names in the argument list. */ static VALUE rb_file_s_lutime(int argc, VALUE *argv) { return utime_internal_i(argc, argv, TRUE); } #else #define rb_file_s_lutime rb_f_notimplement #endif #ifdef RUBY_FUNCTION_NAME_STRING # define syserr_fail2(e, s1, s2) syserr_fail2_in(RUBY_FUNCTION_NAME_STRING, e, s1, s2) #else # define syserr_fail2_in(func, e, s1, s2) syserr_fail2(e, s1, s2) #endif #define sys_fail2(s1, s2) syserr_fail2(errno, s1, s2) NORETURN(static void syserr_fail2_in(const char *,int,VALUE,VALUE)); static void syserr_fail2_in(const char *func, int e, VALUE s1, VALUE s2) { VALUE str; #ifdef MAX_PATH const int max_pathlen = MAX_PATH; #else const int max_pathlen = MAXPATHLEN; #endif if (e == EEXIST) { rb_syserr_fail_path(e, rb_str_ellipsize(s2, max_pathlen)); } str = rb_str_new_cstr("("); rb_str_append(str, rb_str_ellipsize(s1, max_pathlen)); rb_str_cat2(str, ", "); rb_str_append(str, rb_str_ellipsize(s2, max_pathlen)); rb_str_cat2(str, ")"); #ifdef RUBY_FUNCTION_NAME_STRING rb_syserr_fail_path_in(func, e, str); #else rb_syserr_fail_path(e, str); #endif } #ifdef HAVE_LINK /* * call-seq: * File.link(old_name, new_name) -> 0 * * Creates a new name for an existing file using a hard link. Will not * overwrite new_name if it already exists (raising a subclass * of SystemCallError). Not available on all platforms. * * File.link("testfile", ".testfile") #=> 0 * IO.readlines(".testfile")[0] #=> "This is line one\n" */ static VALUE rb_file_s_link(VALUE klass, VALUE from, VALUE to) { FilePathValue(from); FilePathValue(to); from = rb_str_encode_ospath(from); to = rb_str_encode_ospath(to); if (link(StringValueCStr(from), StringValueCStr(to)) < 0) { sys_fail2(from, to); } return INT2FIX(0); } #else #define rb_file_s_link rb_f_notimplement #endif #ifdef HAVE_SYMLINK /* * call-seq: * File.symlink(old_name, new_name) -> 0 * * Creates a symbolic link called new_name for the existing file * old_name. Raises a NotImplemented exception on * platforms that do not support symbolic links. * * File.symlink("testfile", "link2test") #=> 0 * */ static VALUE rb_file_s_symlink(VALUE klass, VALUE from, VALUE to) { FilePathValue(from); FilePathValue(to); from = rb_str_encode_ospath(from); to = rb_str_encode_ospath(to); if (symlink(StringValueCStr(from), StringValueCStr(to)) < 0) { sys_fail2(from, to); } return INT2FIX(0); } #else #define rb_file_s_symlink rb_f_notimplement #endif #ifdef HAVE_READLINK /* * call-seq: * File.readlink(link_name) -> file_name * * Returns the name of the file referenced by the given link. * Not available on all platforms. * * File.symlink("testfile", "link2test") #=> 0 * File.readlink("link2test") #=> "testfile" */ static VALUE rb_file_s_readlink(VALUE klass, VALUE path) { return rb_readlink(path, rb_filesystem_encoding()); } #ifndef _WIN32 struct readlink_arg { const char *path; char *buf; size_t size; }; static void * nogvl_readlink(void *ptr) { struct readlink_arg *ra = ptr; return (void *)(VALUE)readlink(ra->path, ra->buf, ra->size); } static ssize_t readlink_without_gvl(VALUE path, VALUE buf, size_t size) { struct readlink_arg ra; ra.path = RSTRING_PTR(path); ra.buf = RSTRING_PTR(buf); ra.size = size; return (ssize_t)rb_thread_call_without_gvl(nogvl_readlink, &ra, RUBY_UBF_IO, 0); } VALUE rb_readlink(VALUE path, rb_encoding *enc) { int size = 100; ssize_t rv; VALUE v; FilePathValue(path); path = rb_str_encode_ospath(path); v = rb_enc_str_new(0, size, enc); while ((rv = readlink_without_gvl(path, v, size)) == size #ifdef _AIX || (rv < 0 && errno == ERANGE) /* quirky behavior of GPFS */ #endif ) { rb_str_modify_expand(v, size); size *= 2; rb_str_set_len(v, size); } if (rv < 0) { int e = errno; rb_str_resize(v, 0); rb_syserr_fail_path(e, path); } rb_str_resize(v, rv); return v; } #endif #else #define rb_file_s_readlink rb_f_notimplement #endif static int unlink_internal(const char *path, void *arg) { return unlink(path); } /* * call-seq: * File.delete(file_name, ...) -> integer * File.unlink(file_name, ...) -> integer * * Deletes the named files, returning the number of names * passed as arguments. Raises an exception on any error. * Since the underlying implementation relies on the * unlink(2) system call, the type of * exception raised depends on its error type (see * https://linux.die.net/man/2/unlink) and has the form of * e.g. Errno::ENOENT. * * See also Dir::rmdir. */ static VALUE rb_file_s_unlink(int argc, VALUE *argv, VALUE klass) { return apply2files(unlink_internal, argc, argv, 0); } struct rename_args { const char *src; const char *dst; }; static void * no_gvl_rename(void *ptr) { struct rename_args *ra = ptr; return (void *)(VALUE)rename(ra->src, ra->dst); } /* * call-seq: * File.rename(old_name, new_name) -> 0 * * Renames the given file to the new name. Raises a * SystemCallError if the file cannot be renamed. * * File.rename("afile", "afile.bak") #=> 0 */ static VALUE rb_file_s_rename(VALUE klass, VALUE from, VALUE to) { struct rename_args ra; VALUE f, t; FilePathValue(from); FilePathValue(to); f = rb_str_encode_ospath(from); t = rb_str_encode_ospath(to); ra.src = StringValueCStr(f); ra.dst = StringValueCStr(t); #if defined __CYGWIN__ errno = 0; #endif if ((int)(VALUE)rb_thread_call_without_gvl(no_gvl_rename, &ra, RUBY_UBF_IO, 0) < 0) { int e = errno; #if defined DOSISH switch (e) { case EEXIST: if (chmod(ra.dst, 0666) == 0 && unlink(ra.dst) == 0 && rename(ra.src, ra.dst) == 0) return INT2FIX(0); } #endif syserr_fail2(e, from, to); } return INT2FIX(0); } /* * call-seq: * File.umask() -> integer * File.umask(integer) -> integer * * Returns the current umask value for this process. If the optional * argument is given, set the umask to that value and return the * previous value. Umask values are subtracted from the * default permissions, so a umask of 0222 would make a * file read-only for everyone. * * File.umask(0006) #=> 18 * File.umask #=> 6 */ static VALUE rb_file_s_umask(int argc, VALUE *argv) { mode_t omask = 0; if (argc == 0) { omask = umask(0); umask(omask); } else if (argc == 1) { omask = umask(NUM2MODET(argv[0])); } else { rb_check_arity(argc, 0, 1); } return MODET2NUM(omask); } #ifdef __CYGWIN__ #undef DOSISH #endif #if defined __CYGWIN__ || defined DOSISH #define DOSISH_UNC #define DOSISH_DRIVE_LETTER #define FILE_ALT_SEPARATOR '\\' #endif #ifdef FILE_ALT_SEPARATOR #define isdirsep(x) ((x) == '/' || (x) == FILE_ALT_SEPARATOR) # ifdef DOSISH static const char file_alt_separator[] = {FILE_ALT_SEPARATOR, '\0'}; # endif #else #define isdirsep(x) ((x) == '/') #endif #ifndef USE_NTFS #if defined _WIN32 #define USE_NTFS 1 #else #define USE_NTFS 0 #endif #endif #ifndef USE_NTFS_ADS # if USE_NTFS # define USE_NTFS_ADS 1 # else # define USE_NTFS_ADS 0 # endif #endif #if USE_NTFS #define istrailinggarbage(x) ((x) == '.' || (x) == ' ') #else #define istrailinggarbage(x) 0 #endif #if USE_NTFS_ADS # define isADS(x) ((x) == ':') #else # define isADS(x) 0 #endif #define Next(p, e, enc) ((p) + rb_enc_mbclen((p), (e), (enc))) #define Inc(p, e, enc) ((p) = Next((p), (e), (enc))) #if defined(DOSISH_UNC) #define has_unc(buf) (isdirsep((buf)[0]) && isdirsep((buf)[1])) #else #define has_unc(buf) 0 #endif #ifdef DOSISH_DRIVE_LETTER static inline int has_drive_letter(const char *buf) { if (ISALPHA(buf[0]) && buf[1] == ':') { return 1; } else { return 0; } } #ifndef _WIN32 static char* getcwdofdrv(int drv) { char drive[4]; char *drvcwd, *oldcwd; drive[0] = drv; drive[1] = ':'; drive[2] = '\0'; /* the only way that I know to get the current directory of a particular drive is to change chdir() to that drive, so save the old cwd before chdir() */ oldcwd = ruby_getcwd(); if (chdir(drive) == 0) { drvcwd = ruby_getcwd(); chdir(oldcwd); xfree(oldcwd); } else { /* perhaps the drive is not exist. we return only drive letter */ drvcwd = strdup(drive); } return drvcwd; } #endif static inline int not_same_drive(VALUE path, int drive) { const char *p = RSTRING_PTR(path); if (RSTRING_LEN(path) < 2) return 0; if (has_drive_letter(p)) { return TOLOWER(p[0]) != TOLOWER(drive); } else { return has_unc(p); } } #endif static inline char * skiproot(const char *path, const char *end, rb_encoding *enc) { #ifdef DOSISH_DRIVE_LETTER if (path + 2 <= end && has_drive_letter(path)) path += 2; #endif while (path < end && isdirsep(*path)) path++; return (char *)path; } #define nextdirsep rb_enc_path_next char * rb_enc_path_next(const char *s, const char *e, rb_encoding *enc) { while (s < e && !isdirsep(*s)) { Inc(s, e, enc); } return (char *)s; } #if defined(DOSISH_UNC) || defined(DOSISH_DRIVE_LETTER) #define skipprefix rb_enc_path_skip_prefix #else #define skipprefix(path, end, enc) (path) #endif char * rb_enc_path_skip_prefix(const char *path, const char *end, rb_encoding *enc) { #if defined(DOSISH_UNC) || defined(DOSISH_DRIVE_LETTER) #ifdef DOSISH_UNC if (path + 2 <= end && isdirsep(path[0]) && isdirsep(path[1])) { path += 2; while (path < end && isdirsep(*path)) path++; if ((path = rb_enc_path_next(path, end, enc)) < end && path[0] && path[1] && !isdirsep(path[1])) path = rb_enc_path_next(path + 1, end, enc); return (char *)path; } #endif #ifdef DOSISH_DRIVE_LETTER if (has_drive_letter(path)) return (char *)(path + 2); #endif #endif return (char *)path; } static inline char * skipprefixroot(const char *path, const char *end, rb_encoding *enc) { #if defined(DOSISH_UNC) || defined(DOSISH_DRIVE_LETTER) char *p = skipprefix(path, end, enc); while (isdirsep(*p)) p++; return p; #else return skiproot(path, end, enc); #endif } #define strrdirsep rb_enc_path_last_separator char * rb_enc_path_last_separator(const char *path, const char *end, rb_encoding *enc) { char *last = NULL; while (path < end) { if (isdirsep(*path)) { const char *tmp = path++; while (path < end && isdirsep(*path)) path++; if (path >= end) break; last = (char *)tmp; } else { Inc(path, end, enc); } } return last; } static char * chompdirsep(const char *path, const char *end, rb_encoding *enc) { while (path < end) { if (isdirsep(*path)) { const char *last = path++; while (path < end && isdirsep(*path)) path++; if (path >= end) return (char *)last; } else { Inc(path, end, enc); } } return (char *)path; } char * rb_enc_path_end(const char *path, const char *end, rb_encoding *enc) { if (path < end && isdirsep(*path)) path++; return chompdirsep(path, end, enc); } #if USE_NTFS static char * ntfs_tail(const char *path, const char *end, rb_encoding *enc) { while (path < end && *path == '.') path++; while (path < end && !isADS(*path)) { if (istrailinggarbage(*path)) { const char *last = path++; while (path < end && istrailinggarbage(*path)) path++; if (path >= end || isADS(*path)) return (char *)last; } else if (isdirsep(*path)) { const char *last = path++; while (path < end && isdirsep(*path)) path++; if (path >= end) return (char *)last; if (isADS(*path)) path++; } else { Inc(path, end, enc); } } return (char *)path; } #endif #define BUFCHECK(cond) do {\ bdiff = p - buf;\ if (cond) {\ do {buflen *= 2;} while (cond);\ rb_str_resize(result, buflen);\ buf = RSTRING_PTR(result);\ p = buf + bdiff;\ pend = buf + buflen;\ }\ } while (0) #define BUFINIT() (\ p = buf = RSTRING_PTR(result),\ buflen = RSTRING_LEN(result),\ pend = p + buflen) #ifdef __APPLE__ # define SKIPPATHSEP(p) ((*(p)) ? 1 : 0) #else # define SKIPPATHSEP(p) 1 #endif #define BUFCOPY(srcptr, srclen) do { \ const int skip = SKIPPATHSEP(p); \ rb_str_set_len(result, p-buf+skip); \ BUFCHECK(bdiff + ((srclen)+skip) >= buflen); \ p += skip; \ memcpy(p, (srcptr), (srclen)); \ p += (srclen); \ } while (0) #define WITH_ROOTDIFF(stmt) do { \ long rootdiff = root - buf; \ stmt; \ root = buf + rootdiff; \ } while (0) static VALUE copy_home_path(VALUE result, const char *dir) { char *buf; #if defined DOSISH || defined __CYGWIN__ char *p, *bend; rb_encoding *enc; #endif long dirlen; int encidx; dirlen = strlen(dir); rb_str_resize(result, dirlen); memcpy(buf = RSTRING_PTR(result), dir, dirlen); encidx = rb_filesystem_encindex(); rb_enc_associate_index(result, encidx); #if defined DOSISH || defined __CYGWIN__ enc = rb_enc_from_index(encidx); for (bend = (p = buf) + dirlen; p < bend; Inc(p, bend, enc)) { if (*p == '\\') { *p = '/'; } } #endif return result; } VALUE rb_home_dir_of(VALUE user, VALUE result) { #ifdef HAVE_PWD_H struct passwd *pwPtr; #else extern char *getlogin(void); const char *pwPtr = 0; # define endpwent() ((void)0) #endif const char *dir, *username = RSTRING_PTR(user); rb_encoding *enc = rb_enc_get(user); #if defined _WIN32 rb_encoding *fsenc = rb_utf8_encoding(); #else rb_encoding *fsenc = rb_filesystem_encoding(); #endif if (enc != fsenc) { dir = username = RSTRING_PTR(rb_str_conv_enc(user, enc, fsenc)); } #ifdef HAVE_PWD_H pwPtr = getpwnam(username); #else if (strcasecmp(username, getlogin()) == 0) dir = pwPtr = getenv("HOME"); #endif if (!pwPtr) { endpwent(); rb_raise(rb_eArgError, "user %"PRIsVALUE" doesn't exist", user); } #ifdef HAVE_PWD_H dir = pwPtr->pw_dir; #endif copy_home_path(result, dir); endpwent(); return result; } #ifndef _WIN32 VALUE rb_default_home_dir(VALUE result) { const char *dir = getenv("HOME"); #if defined HAVE_PWD_H if (!dir) { /* We'll look up the user's default home dir in the password db by * login name, if possible, and failing that will fall back to looking * the information up by uid (as would be needed for processes that * are not a descendant of login(1) or a work-alike). * * While the lookup by uid is more likely to succeed (since we always * have a uid, but may or may not have a login name), we prefer first * looking up by name to accommodate the possibility of multiple login * names (each with its own record in the password database, so each * with a potentially different home directory) being mapped to the * same uid (as explicitly allowed for by POSIX; see getlogin(3posix)). */ VALUE login_name = rb_getlogin(); # if !defined(HAVE_GETPWUID_R) && !defined(HAVE_GETPWUID) /* This is a corner case, but for backward compatibility reasons we * want to emit this error if neither the lookup by login name nor * lookup by getuid() has a chance of succeeding. */ if (NIL_P(login_name)) { rb_raise(rb_eArgError, "couldn't find login name -- expanding `~'"); } # endif VALUE pw_dir = rb_getpwdirnam_for_login(login_name); if (NIL_P(pw_dir)) { pw_dir = rb_getpwdiruid(); if (NIL_P(pw_dir)) { rb_raise(rb_eArgError, "couldn't find home for uid `%ld'", (long)getuid()); } } /* found it */ copy_home_path(result, RSTRING_PTR(pw_dir)); rb_str_resize(pw_dir, 0); return result; } #endif if (!dir) { rb_raise(rb_eArgError, "couldn't find HOME environment -- expanding `~'"); } return copy_home_path(result, dir); } static VALUE ospath_new(const char *ptr, long len, rb_encoding *fsenc) { #if NORMALIZE_UTF8PATH VALUE path = rb_str_normalize_ospath(ptr, len); rb_enc_associate(path, fsenc); return path; #else return rb_enc_str_new(ptr, len, fsenc); #endif } static char * append_fspath(VALUE result, VALUE fname, char *dir, rb_encoding **enc, rb_encoding *fsenc) { char *buf, *cwdp = dir; VALUE dirname = Qnil; size_t dirlen = strlen(dir), buflen = rb_str_capacity(result); if (NORMALIZE_UTF8PATH || *enc != fsenc) { rb_encoding *direnc = rb_enc_check(fname, dirname = ospath_new(dir, dirlen, fsenc)); if (direnc != fsenc) { dirname = rb_str_conv_enc(dirname, fsenc, direnc); RSTRING_GETMEM(dirname, cwdp, dirlen); } else if (NORMALIZE_UTF8PATH) { RSTRING_GETMEM(dirname, cwdp, dirlen); } *enc = direnc; } do {buflen *= 2;} while (dirlen > buflen); rb_str_resize(result, buflen); buf = RSTRING_PTR(result); memcpy(buf, cwdp, dirlen); xfree(dir); if (!NIL_P(dirname)) rb_str_resize(dirname, 0); rb_enc_associate(result, *enc); return buf + dirlen; } VALUE rb_file_expand_path_internal(VALUE fname, VALUE dname, int abs_mode, int long_name, VALUE result) { const char *s, *b, *fend; char *buf, *p, *pend, *root; size_t buflen, bdiff; int tainted; rb_encoding *enc, *fsenc = rb_filesystem_encoding(); s = StringValuePtr(fname); fend = s + RSTRING_LEN(fname); enc = rb_enc_get(fname); BUFINIT(); tainted = OBJ_TAINTED(fname); if (s[0] == '~' && abs_mode == 0) { /* execute only if NOT absolute_path() */ long userlen = 0; tainted = 1; if (isdirsep(s[1]) || s[1] == '\0') { buf = 0; b = 0; rb_str_set_len(result, 0); if (*++s) ++s; rb_default_home_dir(result); } else { s = nextdirsep(b = s, fend, enc); b++; /* b[0] is '~' */ userlen = s - b; BUFCHECK(bdiff + userlen >= buflen); memcpy(p, b, userlen); ENC_CODERANGE_CLEAR(result); rb_str_set_len(result, userlen); rb_enc_associate(result, enc); rb_home_dir_of(result, result); buf = p + 1; p += userlen; } if (!rb_is_absolute_path(RSTRING_PTR(result))) { if (userlen) { rb_enc_raise(enc, rb_eArgError, "non-absolute home of %.*s%.0"PRIsVALUE, (int)userlen, b, fname); } else { rb_raise(rb_eArgError, "non-absolute home"); } } BUFINIT(); p = pend; } #ifdef DOSISH_DRIVE_LETTER /* skip drive letter */ else if (has_drive_letter(s)) { if (isdirsep(s[2])) { /* specified drive letter, and full path */ /* skip drive letter */ BUFCHECK(bdiff + 2 >= buflen); memcpy(p, s, 2); p += 2; s += 2; rb_enc_copy(result, fname); } else { /* specified drive, but not full path */ int same = 0; if (!NIL_P(dname) && !not_same_drive(dname, s[0])) { rb_file_expand_path_internal(dname, Qnil, abs_mode, long_name, result); BUFINIT(); if (has_drive_letter(p) && TOLOWER(p[0]) == TOLOWER(s[0])) { /* ok, same drive */ same = 1; } } if (!same) { char *e = append_fspath(result, fname, getcwdofdrv(*s), &enc, fsenc); tainted = 1; BUFINIT(); p = e; } else { rb_enc_associate(result, enc = rb_enc_check(result, fname)); p = pend; } p = chompdirsep(skiproot(buf, p, enc), p, enc); s += 2; } } #endif else if (!rb_is_absolute_path(s)) { if (!NIL_P(dname)) { rb_file_expand_path_internal(dname, Qnil, abs_mode, long_name, result); rb_enc_associate(result, rb_enc_check(result, fname)); BUFINIT(); p = pend; } else { char *e = append_fspath(result, fname, ruby_getcwd(), &enc, fsenc); tainted = 1; BUFINIT(); p = e; } #if defined DOSISH || defined __CYGWIN__ if (isdirsep(*s)) { /* specified full path, but not drive letter nor UNC */ /* we need to get the drive letter or UNC share name */ p = skipprefix(buf, p, enc); } else #endif p = chompdirsep(skiproot(buf, p, enc), p, enc); } else { size_t len; b = s; do s++; while (isdirsep(*s)); len = s - b; p = buf + len; BUFCHECK(bdiff >= buflen); memset(buf, '/', len); rb_str_set_len(result, len); rb_enc_associate(result, rb_enc_check(result, fname)); } if (p > buf && p[-1] == '/') --p; else { rb_str_set_len(result, p-buf); BUFCHECK(bdiff + 1 >= buflen); *p = '/'; } rb_str_set_len(result, p-buf+1); BUFCHECK(bdiff + 1 >= buflen); p[1] = 0; root = skipprefix(buf, p+1, enc); b = s; while (*s) { switch (*s) { case '.': if (b == s++) { /* beginning of path element */ switch (*s) { case '\0': b = s; break; case '.': if (*(s+1) == '\0' || isdirsep(*(s+1))) { /* We must go back to the parent */ char *n; *p = '\0'; if (!(n = strrdirsep(root, p, enc))) { *p = '/'; } else { p = n; } b = ++s; } #if USE_NTFS else { do ++s; while (istrailinggarbage(*s)); } #endif break; case '/': #if defined DOSISH || defined __CYGWIN__ case '\\': #endif b = ++s; break; default: /* ordinary path element, beginning don't move */ break; } } #if USE_NTFS else { --s; case ' ': { const char *e = s; while (s < fend && istrailinggarbage(*s)) s++; if (s >= fend) { s = e; goto endpath; } } } #endif break; case '/': #if defined DOSISH || defined __CYGWIN__ case '\\': #endif if (s > b) { WITH_ROOTDIFF(BUFCOPY(b, s-b)); *p = '/'; } b = ++s; break; default: #ifdef __APPLE__ { int n = ignored_char_p(s, fend, enc); if (n) { if (s > b) { WITH_ROOTDIFF(BUFCOPY(b, s-b)); *p = '\0'; } b = s += n; break; } } #endif Inc(s, fend, enc); break; } } if (s > b) { #if USE_NTFS # if USE_NTFS_ADS static const char prime[] = ":$DATA"; enum {prime_len = sizeof(prime) -1}; # endif endpath: # if USE_NTFS_ADS if (s > b + prime_len && strncasecmp(s - prime_len, prime, prime_len) == 0) { /* alias of stream */ /* get rid of a bug of x64 VC++ */ if (isADS(*(s - (prime_len+1)))) { s -= prime_len + 1; /* prime */ } else if (memchr(b, ':', s - prime_len - b)) { s -= prime_len; /* alternative */ } } # endif #endif BUFCOPY(b, s-b); rb_str_set_len(result, p-buf); } if (p == skiproot(buf, p + !!*p, enc) - 1) p++; #if USE_NTFS *p = '\0'; if ((s = strrdirsep(b = buf, p, enc)) != 0 && !strpbrk(s, "*?")) { VALUE tmp, v; size_t len; int encidx; WCHAR *wstr; WIN32_FIND_DATAW wfd; HANDLE h; #ifdef __CYGWIN__ #ifdef HAVE_CYGWIN_CONV_PATH char *w32buf = NULL; const int flags = CCP_POSIX_TO_WIN_A | CCP_RELATIVE; #else char w32buf[MAXPATHLEN]; #endif const char *path; ssize_t bufsize; int lnk_added = 0, is_symlink = 0; struct stat st; p = (char *)s; len = strlen(p); if (lstat_without_gvl(buf, &st) == 0 && S_ISLNK(st.st_mode)) { is_symlink = 1; if (len > 4 && STRCASECMP(p + len - 4, ".lnk") != 0) { lnk_added = 1; } } path = *buf ? buf : "/"; #ifdef HAVE_CYGWIN_CONV_PATH bufsize = cygwin_conv_path(flags, path, NULL, 0); if (bufsize > 0) { bufsize += len; if (lnk_added) bufsize += 4; w32buf = ALLOCA_N(char, bufsize); if (cygwin_conv_path(flags, path, w32buf, bufsize) == 0) { b = w32buf; } } #else bufsize = MAXPATHLEN; if (cygwin_conv_to_win32_path(path, w32buf) == 0) { b = w32buf; } #endif if (is_symlink && b == w32buf) { *p = '\\'; strlcat(w32buf, p, bufsize); if (lnk_added) { strlcat(w32buf, ".lnk", bufsize); } } else { lnk_added = 0; } *p = '/'; #endif rb_str_set_len(result, p - buf + strlen(p)); encidx = ENCODING_GET(result); tmp = result; if (encidx != ENCINDEX_UTF_8 && rb_enc_str_coderange(result) != ENC_CODERANGE_7BIT) { tmp = rb_str_encode_ospath(result); } len = MultiByteToWideChar(CP_UTF8, 0, RSTRING_PTR(tmp), -1, NULL, 0); wstr = ALLOCV_N(WCHAR, v, len); MultiByteToWideChar(CP_UTF8, 0, RSTRING_PTR(tmp), -1, wstr, len); if (tmp != result) rb_str_set_len(tmp, 0); h = FindFirstFileW(wstr, &wfd); ALLOCV_END(v); if (h != INVALID_HANDLE_VALUE) { size_t wlen; FindClose(h); len = lstrlenW(wfd.cFileName); #ifdef __CYGWIN__ if (lnk_added && len > 4 && wcscasecmp(wfd.cFileName + len - 4, L".lnk") == 0) { wfd.cFileName[len -= 4] = L'\0'; } #else p = (char *)s; #endif ++p; wlen = (int)len; len = WideCharToMultiByte(CP_UTF8, 0, wfd.cFileName, wlen, NULL, 0, NULL, NULL); if (tmp == result) { BUFCHECK(bdiff + len >= buflen); WideCharToMultiByte(CP_UTF8, 0, wfd.cFileName, wlen, p, len + 1, NULL, NULL); } else { rb_str_modify_expand(tmp, len); WideCharToMultiByte(CP_UTF8, 0, wfd.cFileName, wlen, RSTRING_PTR(tmp), len + 1, NULL, NULL); rb_str_cat_conv_enc_opts(result, bdiff, RSTRING_PTR(tmp), len, rb_utf8_encoding(), 0, Qnil); BUFINIT(); rb_str_resize(tmp, 0); } p += len; } #ifdef __CYGWIN__ else { p += strlen(p); } #endif } #endif if (tainted) OBJ_TAINT(result); rb_str_set_len(result, p - buf); rb_enc_check(fname, result); ENC_CODERANGE_CLEAR(result); return result; } #endif /* _WIN32 */ #define EXPAND_PATH_BUFFER() rb_usascii_str_new(0, MAXPATHLEN + 2) static VALUE str_shrink(VALUE str) { rb_str_resize(str, RSTRING_LEN(str)); return str; } #define expand_path(fname, dname, abs_mode, long_name, result) \ str_shrink(rb_file_expand_path_internal(fname, dname, abs_mode, long_name, result)) #define check_expand_path_args(fname, dname) \ (((fname) = rb_get_path(fname)), \ (void)(NIL_P(dname) ? (dname) : ((dname) = rb_get_path(dname)))) static VALUE file_expand_path_1(VALUE fname) { return rb_file_expand_path_internal(fname, Qnil, 0, 0, EXPAND_PATH_BUFFER()); } VALUE rb_file_expand_path(VALUE fname, VALUE dname) { check_expand_path_args(fname, dname); return expand_path(fname, dname, 0, 1, EXPAND_PATH_BUFFER()); } VALUE rb_file_expand_path_fast(VALUE fname, VALUE dname) { return expand_path(fname, dname, 0, 0, EXPAND_PATH_BUFFER()); } /* * call-seq: * File.expand_path(file_name [, dir_string] ) -> abs_file_name * * Converts a pathname to an absolute pathname. Relative paths are * referenced from the current working directory of the process unless * +dir_string+ is given, in which case it will be used as the * starting point. The given pathname may start with a * ``~'', which expands to the process owner's home * directory (the environment variable +HOME+ must be set * correctly). ``~user'' expands to the named * user's home directory. * * File.expand_path("~oracle/bin") #=> "/home/oracle/bin" * * A simple example of using +dir_string+ is as follows. * File.expand_path("ruby", "/usr/bin") #=> "/usr/bin/ruby" * * A more complex example which also resolves parent directory is as follows. * Suppose we are in bin/mygem and want the absolute path of lib/mygem.rb. * * File.expand_path("../../lib/mygem.rb", __FILE__) * #=> ".../path/to/project/lib/mygem.rb" * * So first it resolves the parent of __FILE__, that is bin/, then go to the * parent, the root of the project and appends +lib/mygem.rb+. */ VALUE rb_file_s_expand_path(int argc, const VALUE *argv) { rb_check_arity(argc, 1, 2); return rb_file_expand_path(argv[0], argc > 1 ? argv[1] : Qnil); } VALUE rb_file_absolute_path(VALUE fname, VALUE dname) { check_expand_path_args(fname, dname); return expand_path(fname, dname, 1, 1, EXPAND_PATH_BUFFER()); } /* * call-seq: * File.absolute_path(file_name [, dir_string] ) -> abs_file_name * * Converts a pathname to an absolute pathname. Relative paths are * referenced from the current working directory of the process unless * dir_string is given, in which case it will be used as the * starting point. If the given pathname starts with a ``~'' * it is NOT expanded, it is treated as a normal directory name. * * File.absolute_path("~oracle/bin") #=> "/~oracle/bin" */ VALUE rb_file_s_absolute_path(int argc, const VALUE *argv) { rb_check_arity(argc, 1, 2); return rb_file_absolute_path(argv[0], argc > 1 ? argv[1] : Qnil); } enum rb_realpath_mode { RB_REALPATH_CHECK, RB_REALPATH_DIR, RB_REALPATH_STRICT, RB_REALPATH_MODE_MAX }; static int realpath_rec(long *prefixlenp, VALUE *resolvedp, const char *unresolved, VALUE fallback, VALUE loopcheck, enum rb_realpath_mode mode, int last) { const char *pend = unresolved + strlen(unresolved); rb_encoding *enc = rb_enc_get(*resolvedp); ID resolving; CONST_ID(resolving, "resolving"); while (unresolved < pend) { const char *testname = unresolved; const char *unresolved_firstsep = rb_enc_path_next(unresolved, pend, enc); long testnamelen = unresolved_firstsep - unresolved; const char *unresolved_nextname = unresolved_firstsep; while (unresolved_nextname < pend && isdirsep(*unresolved_nextname)) unresolved_nextname++; unresolved = unresolved_nextname; if (testnamelen == 1 && testname[0] == '.') { } else if (testnamelen == 2 && testname[0] == '.' && testname[1] == '.') { if (*prefixlenp < RSTRING_LEN(*resolvedp)) { const char *resolved_str = RSTRING_PTR(*resolvedp); const char *resolved_names = resolved_str + *prefixlenp; const char *lastsep = strrdirsep(resolved_names, resolved_str + RSTRING_LEN(*resolvedp), enc); long len = lastsep ? lastsep - resolved_names : 0; rb_str_resize(*resolvedp, *prefixlenp + len); } } else { VALUE checkval; VALUE testpath = rb_str_dup(*resolvedp); if (*prefixlenp < RSTRING_LEN(testpath)) rb_str_cat2(testpath, "/"); #if defined(DOSISH_UNC) || defined(DOSISH_DRIVE_LETTER) if (*prefixlenp > 1 && *prefixlenp == RSTRING_LEN(testpath)) { const char *prefix = RSTRING_PTR(testpath); const char *last = rb_enc_left_char_head(prefix, prefix + *prefixlenp - 1, prefix + *prefixlenp, enc); if (!isdirsep(*last)) rb_str_cat2(testpath, "/"); } #endif rb_str_cat(testpath, testname, testnamelen); checkval = rb_hash_aref(loopcheck, testpath); if (!NIL_P(checkval)) { if (checkval == ID2SYM(resolving)) { if (mode == RB_REALPATH_CHECK) { errno = ELOOP; return -1; } rb_syserr_fail_path(ELOOP, testpath); } else { *resolvedp = rb_str_dup(checkval); } } else { struct stat sbuf; int ret; ret = lstat_without_gvl(RSTRING_PTR(testpath), &sbuf); if (ret == -1) { int e = errno; if (e == ENOENT && !NIL_P(fallback)) { if (stat_without_gvl(RSTRING_PTR(fallback), &sbuf) == 0) { rb_str_replace(*resolvedp, fallback); return 0; } } if (mode == RB_REALPATH_CHECK) return -1; if (e == ENOENT) { if (mode == RB_REALPATH_STRICT || !last || *unresolved_firstsep) rb_syserr_fail_path(e, testpath); *resolvedp = testpath; break; } else { rb_syserr_fail_path(e, testpath); } } #ifdef HAVE_READLINK if (S_ISLNK(sbuf.st_mode)) { VALUE link; VALUE link_orig = Qnil; const char *link_prefix, *link_names; long link_prefixlen; rb_hash_aset(loopcheck, testpath, ID2SYM(resolving)); link = rb_readlink(testpath, enc); link_prefix = RSTRING_PTR(link); link_names = skipprefixroot(link_prefix, link_prefix + RSTRING_LEN(link), rb_enc_get(link)); link_prefixlen = link_names - link_prefix; if (link_prefixlen > 0) { rb_encoding *tmpenc, *linkenc = rb_enc_get(link); link_orig = link; link = rb_str_subseq(link, 0, link_prefixlen); tmpenc = rb_enc_check(*resolvedp, link); if (tmpenc != linkenc) link = rb_str_conv_enc(link, linkenc, tmpenc); *resolvedp = link; *prefixlenp = link_prefixlen; } if (realpath_rec(prefixlenp, resolvedp, link_names, testpath, loopcheck, mode, !*unresolved_firstsep)) return -1; RB_GC_GUARD(link_orig); rb_hash_aset(loopcheck, testpath, rb_str_dup_frozen(*resolvedp)); } else #endif { VALUE s = rb_str_dup_frozen(testpath); rb_hash_aset(loopcheck, s, s); *resolvedp = testpath; } } } } return 0; } static VALUE rb_check_realpath_internal(VALUE basedir, VALUE path, enum rb_realpath_mode mode) { long prefixlen; VALUE resolved; VALUE unresolved_path; VALUE loopcheck; VALUE curdir = Qnil; rb_encoding *enc, *origenc; char *path_names = NULL, *basedir_names = NULL, *curdir_names = NULL; char *ptr, *prefixptr = NULL, *pend; long len; unresolved_path = rb_str_dup_frozen(path); if (!NIL_P(basedir)) { FilePathValue(basedir); basedir = TO_OSPATH(rb_str_dup_frozen(basedir)); } enc = rb_enc_get(unresolved_path); origenc = enc; unresolved_path = TO_OSPATH(unresolved_path); RSTRING_GETMEM(unresolved_path, ptr, len); path_names = skipprefixroot(ptr, ptr + len, rb_enc_get(unresolved_path)); if (ptr != path_names) { resolved = rb_str_subseq(unresolved_path, 0, path_names - ptr); goto root_found; } if (!NIL_P(basedir)) { RSTRING_GETMEM(basedir, ptr, len); basedir_names = skipprefixroot(ptr, ptr + len, rb_enc_get(basedir)); if (ptr != basedir_names) { resolved = rb_str_subseq(basedir, 0, basedir_names - ptr); goto root_found; } } curdir = rb_dir_getwd_ospath(); RSTRING_GETMEM(curdir, ptr, len); curdir_names = skipprefixroot(ptr, ptr + len, rb_enc_get(curdir)); resolved = rb_str_subseq(curdir, 0, curdir_names - ptr); root_found: RSTRING_GETMEM(resolved, prefixptr, prefixlen); pend = prefixptr + prefixlen; ptr = chompdirsep(prefixptr, pend, enc); if (ptr < pend) { prefixlen = ++ptr - prefixptr; rb_str_set_len(resolved, prefixlen); } #ifdef FILE_ALT_SEPARATOR while (prefixptr < ptr) { if (*prefixptr == FILE_ALT_SEPARATOR) { *prefixptr = '/'; } Inc(prefixptr, pend, enc); } #endif switch (rb_enc_to_index(enc)) { case ENCINDEX_ASCII: case ENCINDEX_US_ASCII: rb_enc_associate_index(resolved, rb_filesystem_encindex()); } loopcheck = rb_hash_new(); if (curdir_names) { if (realpath_rec(&prefixlen, &resolved, curdir_names, Qnil, loopcheck, mode, 0)) return Qnil; } if (basedir_names) { if (realpath_rec(&prefixlen, &resolved, basedir_names, Qnil, loopcheck, mode, 0)) return Qnil; } if (realpath_rec(&prefixlen, &resolved, path_names, Qnil, loopcheck, mode, 1)) return Qnil; if (origenc != rb_enc_get(resolved)) { if (rb_enc_str_asciionly_p(resolved)) { rb_enc_associate(resolved, origenc); } else { resolved = rb_str_conv_enc(resolved, NULL, origenc); } } rb_obj_taint(resolved); RB_GC_GUARD(unresolved_path); RB_GC_GUARD(curdir); return resolved; } VALUE rb_realpath_internal(VALUE basedir, VALUE path, int strict) { const enum rb_realpath_mode mode = strict ? RB_REALPATH_STRICT : RB_REALPATH_DIR; return rb_check_realpath_internal(basedir, path, mode); } VALUE rb_check_realpath(VALUE basedir, VALUE path) { return rb_check_realpath_internal(basedir, path, RB_REALPATH_CHECK); } /* * call-seq: * File.realpath(pathname [, dir_string]) -> real_pathname * * Returns the real (absolute) pathname of _pathname_ in the actual * filesystem not containing symlinks or useless dots. * * If _dir_string_ is given, it is used as a base directory * for interpreting relative pathname instead of the current directory. * * All components of the pathname must exist when this method is * called. */ static VALUE rb_file_s_realpath(int argc, VALUE *argv, VALUE klass) { VALUE basedir = (rb_check_arity(argc, 1, 2) > 1) ? argv[1] : Qnil; VALUE path = argv[0]; FilePathValue(path); return rb_realpath_internal(basedir, path, 1); } /* * call-seq: * File.realdirpath(pathname [, dir_string]) -> real_pathname * * Returns the real (absolute) pathname of _pathname_ in the actual filesystem. * The real pathname doesn't contain symlinks or useless dots. * * If _dir_string_ is given, it is used as a base directory * for interpreting relative pathname instead of the current directory. * * The last component of the real pathname can be nonexistent. */ static VALUE rb_file_s_realdirpath(int argc, VALUE *argv, VALUE klass) { VALUE basedir = (rb_check_arity(argc, 1, 2) > 1) ? argv[1] : Qnil; VALUE path = argv[0]; FilePathValue(path); return rb_realpath_internal(basedir, path, 0); } static size_t rmext(const char *p, long l0, long l1, const char *e, long l2, rb_encoding *enc) { int len1, len2; unsigned int c; const char *s, *last; if (!e || !l2) return 0; c = rb_enc_codepoint_len(e, e + l2, &len1, enc); if (rb_enc_ascget(e + len1, e + l2, &len2, enc) == '*' && len1 + len2 == l2) { if (c == '.') return l0; s = p; e = p + l1; last = e; while (s < e) { if (rb_enc_codepoint_len(s, e, &len1, enc) == c) last = s; s += len1; } return last - p; } if (l1 < l2) return l1; s = p+l1-l2; if (rb_enc_left_char_head(p, s, p+l1, enc) != s) return 0; #if CASEFOLD_FILESYSTEM #define fncomp strncasecmp #else #define fncomp strncmp #endif if (fncomp(s, e, l2) == 0) { return l1-l2; } return 0; } const char * ruby_enc_find_basename(const char *name, long *baselen, long *alllen, rb_encoding *enc) { const char *p, *q, *e, *end; #if defined DOSISH_DRIVE_LETTER || defined DOSISH_UNC const char *root; #endif long f = 0, n = -1; end = name + (alllen ? (size_t)*alllen : strlen(name)); name = skipprefix(name, end, enc); #if defined DOSISH_DRIVE_LETTER || defined DOSISH_UNC root = name; #endif while (isdirsep(*name)) name++; if (!*name) { p = name - 1; f = 1; #if defined DOSISH_DRIVE_LETTER || defined DOSISH_UNC if (name != root) { /* has slashes */ } #ifdef DOSISH_DRIVE_LETTER else if (*p == ':') { p++; f = 0; } #endif #ifdef DOSISH_UNC else { p = "/"; } #endif #endif } else { if (!(p = strrdirsep(name, end, enc))) { p = name; } else { while (isdirsep(*p)) p++; /* skip last / */ } #if USE_NTFS n = ntfs_tail(p, end, enc) - p; #else n = chompdirsep(p, end, enc) - p; #endif for (q = p; q - p < n && *q == '.'; q++); for (e = 0; q - p < n; Inc(q, end, enc)) { if (*q == '.') e = q; } if (e) f = e - p; else f = n; } if (baselen) *baselen = f; if (alllen) *alllen = n; return p; } /* * call-seq: * File.basename(file_name [, suffix] ) -> base_name * * Returns the last component of the filename given in * file_name (after first stripping trailing separators), * which can be formed using both File::SEPARATOR and * File::ALT_SEPARATOR as the separator when * File::ALT_SEPARATOR is not nil. If * suffix is given and present at the end of file_name, * it is removed. If suffix is ".*", any extension will be * removed. * * File.basename("/home/gumby/work/ruby.rb") #=> "ruby.rb" * File.basename("/home/gumby/work/ruby.rb", ".rb") #=> "ruby" * File.basename("/home/gumby/work/ruby.rb", ".*") #=> "ruby" */ static VALUE rb_file_s_basename(int argc, VALUE *argv) { VALUE fname, fext, basename; const char *name, *p; long f, n; rb_encoding *enc; fext = Qnil; if (rb_check_arity(argc, 1, 2) == 2) { fext = argv[1]; StringValue(fext); enc = check_path_encoding(fext); } fname = argv[0]; FilePathStringValue(fname); if (NIL_P(fext) || !(enc = rb_enc_compatible(fname, fext))) { enc = rb_enc_get(fname); fext = Qnil; } if ((n = RSTRING_LEN(fname)) == 0 || !*(name = RSTRING_PTR(fname))) return rb_str_new_shared(fname); p = ruby_enc_find_basename(name, &f, &n, enc); if (n >= 0) { if (NIL_P(fext)) { f = n; } else { const char *fp; fp = StringValueCStr(fext); if (!(f = rmext(p, f, n, fp, RSTRING_LEN(fext), enc))) { f = n; } RB_GC_GUARD(fext); } if (f == RSTRING_LEN(fname)) return rb_str_new_shared(fname); } basename = rb_str_new(p, f); rb_enc_copy(basename, fname); OBJ_INFECT(basename, fname); return basename; } /* * call-seq: * File.dirname(file_name) -> dir_name * * Returns all components of the filename given in file_name * except the last one (after first stripping trailing separators). * The filename can be formed using both File::SEPARATOR * and File::ALT_SEPARATOR as the separator when * File::ALT_SEPARATOR is not nil. * * File.dirname("/home/gumby/work/ruby.rb") #=> "/home/gumby/work" */ static VALUE rb_file_s_dirname(VALUE klass, VALUE fname) { return rb_file_dirname(fname); } VALUE rb_file_dirname(VALUE fname) { const char *name, *root, *p, *end; VALUE dirname; rb_encoding *enc; FilePathStringValue(fname); name = StringValueCStr(fname); end = name + RSTRING_LEN(fname); enc = rb_enc_get(fname); root = skiproot(name, end, enc); #ifdef DOSISH_UNC if (root > name + 1 && isdirsep(*name)) root = skipprefix(name = root - 2, end, enc); #else if (root > name + 1) name = root - 1; #endif p = strrdirsep(root, end, enc); if (!p) { p = root; } if (p == name) return rb_usascii_str_new2("."); #ifdef DOSISH_DRIVE_LETTER if (has_drive_letter(name) && isdirsep(*(name + 2))) { const char *top = skiproot(name + 2, end, enc); dirname = rb_str_new(name, 3); rb_str_cat(dirname, top, p - top); } else #endif dirname = rb_str_new(name, p - name); #ifdef DOSISH_DRIVE_LETTER if (has_drive_letter(name) && root == name + 2 && p - name == 2) rb_str_cat(dirname, ".", 1); #endif rb_enc_copy(dirname, fname); OBJ_INFECT(dirname, fname); return dirname; } /* * accept a String, and return the pointer of the extension. * if len is passed, set the length of extension to it. * returned pointer is in ``name'' or NULL. * returns *len * no dot NULL 0 * dotfile top 0 * end with dot dot 1 * .ext dot len of .ext * .ext:stream dot len of .ext without :stream (NT only) * */ const char * ruby_enc_find_extname(const char *name, long *len, rb_encoding *enc) { const char *p, *e, *end = name + (len ? *len : (long)strlen(name)); p = strrdirsep(name, end, enc); /* get the last path component */ if (!p) p = name; else do name = ++p; while (isdirsep(*p)); e = 0; while (*p && *p == '.') p++; while (*p) { if (*p == '.' || istrailinggarbage(*p)) { #if USE_NTFS const char *last = p++, *dot = last; while (istrailinggarbage(*p)) { if (*p == '.') dot = p; p++; } if (!*p || isADS(*p)) { p = last; break; } if (*last == '.' || dot > last) e = dot; continue; #else e = p; /* get the last dot of the last component */ #endif } #if USE_NTFS else if (isADS(*p)) { break; } #endif else if (isdirsep(*p)) break; Inc(p, end, enc); } if (len) { /* no dot, or the only dot is first or end? */ if (!e || e == name) *len = 0; else if (e+1 == p) *len = 1; else *len = p - e; } return e; } /* * call-seq: * File.extname(path) -> string * * Returns the extension (the portion of file name in +path+ * starting from the last period). * * If +path+ is a dotfile, or starts with a period, then the starting * dot is not dealt with the start of the extension. * * An empty string will also be returned when the period is the last character * in +path+. * * File.extname("test.rb") #=> ".rb" * File.extname("a/b/d/test.rb") #=> ".rb" * File.extname(".a/b/d/test.rb") #=> ".rb" * File.extname("foo.") #=> "" * File.extname("test") #=> "" * File.extname(".profile") #=> "" * File.extname(".profile.sh") #=> ".sh" * */ static VALUE rb_file_s_extname(VALUE klass, VALUE fname) { const char *name, *e; long len; VALUE extname; FilePathStringValue(fname); name = StringValueCStr(fname); len = RSTRING_LEN(fname); e = ruby_enc_find_extname(name, &len, rb_enc_get(fname)); if (len <= 1) return rb_str_new(0, 0); extname = rb_str_subseq(fname, e - name, len); /* keep the dot, too! */ OBJ_INFECT(extname, fname); return extname; } /* * call-seq: * File.path(path) -> string * * Returns the string representation of the path * * File.path("/dev/null") #=> "/dev/null" * File.path(Pathname.new("/tmp")) #=> "/tmp" * */ static VALUE rb_file_s_path(VALUE klass, VALUE fname) { return rb_get_path(fname); } /* * call-seq: * File.split(file_name) -> array * * Splits the given string into a directory and a file component and * returns them in a two-element array. See also * File::dirname and File::basename. * * File.split("/home/gumby/.profile") #=> ["/home/gumby", ".profile"] */ static VALUE rb_file_s_split(VALUE klass, VALUE path) { FilePathStringValue(path); /* get rid of converting twice */ return rb_assoc_new(rb_file_dirname(path), rb_file_s_basename(1,&path)); } static VALUE rb_file_join(VALUE ary); static VALUE file_inspect_join(VALUE ary, VALUE arg, int recur) { if (recur || ary == arg) rb_raise(rb_eArgError, "recursive array"); return rb_file_join(arg); } static VALUE rb_file_join(VALUE ary) { long len, i; VALUE result, tmp; const char *name, *tail; int checked = TRUE; rb_encoding *enc; if (RARRAY_LEN(ary) == 0) return rb_str_new(0, 0); len = 1; for (i=0; i string * * Returns a new string formed by joining the strings using * "/". * * File.join("usr", "mail", "gumby") #=> "usr/mail/gumby" * */ static VALUE rb_file_s_join(VALUE klass, VALUE args) { return rb_file_join(args); } #if defined(HAVE_TRUNCATE) || defined(HAVE_CHSIZE) struct truncate_arg { const char *path; #if defined(HAVE_TRUNCATE) #define NUM2POS(n) NUM2OFFT(n) off_t pos; #else #define NUM2POS(n) NUM2LONG(n) long pos; #endif }; static void * nogvl_truncate(void *ptr) { struct truncate_arg *ta = ptr; #ifdef HAVE_TRUNCATE return (void *)(VALUE)truncate(ta->path, ta->pos); #else /* defined(HAVE_CHSIZE) */ { int tmpfd = rb_cloexec_open(ta->path, 0, 0); if (tmpfd < 0) return (void *)-1; rb_update_max_fd(tmpfd); if (chsize(tmpfd, ta->pos) < 0) { int e = errno; close(tmpfd); errno = e; return (void *)-1; } close(tmpfd); return 0; } #endif } /* * call-seq: * File.truncate(file_name, integer) -> 0 * * Truncates the file file_name to be at most integer * bytes long. Not available on all platforms. * * f = File.new("out", "w") * f.write("1234567890") #=> 10 * f.close #=> nil * File.truncate("out", 5) #=> 0 * File.size("out") #=> 5 * */ static VALUE rb_file_s_truncate(VALUE klass, VALUE path, VALUE len) { struct truncate_arg ta; int r; ta.pos = NUM2POS(len); FilePathValue(path); path = rb_str_encode_ospath(path); ta.path = StringValueCStr(path); r = (int)(VALUE)rb_thread_call_without_gvl(nogvl_truncate, &ta, RUBY_UBF_IO, NULL); if (r < 0) rb_sys_fail_path(path); return INT2FIX(0); #undef NUM2POS } #else #define rb_file_s_truncate rb_f_notimplement #endif #if defined(HAVE_FTRUNCATE) || defined(HAVE_CHSIZE) struct ftruncate_arg { int fd; #if defined(HAVE_FTRUNCATE) #define NUM2POS(n) NUM2OFFT(n) off_t pos; #else #define NUM2POS(n) NUM2LONG(n) long pos; #endif }; static VALUE nogvl_ftruncate(void *ptr) { struct ftruncate_arg *fa = ptr; #ifdef HAVE_FTRUNCATE return (VALUE)ftruncate(fa->fd, fa->pos); #else /* defined(HAVE_CHSIZE) */ return (VALUE)chsize(fa->fd, fa->pos); #endif } /* * call-seq: * file.truncate(integer) -> 0 * * Truncates file to at most integer bytes. The file * must be opened for writing. Not available on all platforms. * * f = File.new("out", "w") * f.syswrite("1234567890") #=> 10 * f.truncate(5) #=> 0 * f.close() #=> nil * File.size("out") #=> 5 */ static VALUE rb_file_truncate(VALUE obj, VALUE len) { rb_io_t *fptr; struct ftruncate_arg fa; fa.pos = NUM2POS(len); GetOpenFile(obj, fptr); if (!(fptr->mode & FMODE_WRITABLE)) { rb_raise(rb_eIOError, "not opened for writing"); } rb_io_flush_raw(obj, 0); fa.fd = fptr->fd; if ((int)rb_thread_io_blocking_region(nogvl_ftruncate, &fa, fa.fd) < 0) { rb_sys_fail_path(fptr->pathv); } return INT2FIX(0); #undef NUM2POS } #else #define rb_file_truncate rb_f_notimplement #endif # ifndef LOCK_SH # define LOCK_SH 1 # endif # ifndef LOCK_EX # define LOCK_EX 2 # endif # ifndef LOCK_NB # define LOCK_NB 4 # endif # ifndef LOCK_UN # define LOCK_UN 8 # endif #ifdef __CYGWIN__ #include #endif static VALUE rb_thread_flock(void *data) { #ifdef __CYGWIN__ int old_errno = errno; #endif int *op = data, ret = flock(op[0], op[1]); #ifdef __CYGWIN__ if (GetLastError() == ERROR_NOT_LOCKED) { ret = 0; errno = old_errno; } #endif return (VALUE)ret; } /* * call-seq: * file.flock(locking_constant) -> 0 or false * * Locks or unlocks a file according to locking_constant (a * logical or of the values in the table below). * Returns false if File::LOCK_NB is * specified and the operation would otherwise have blocked. Not * available on all platforms. * * Locking constants (in class File): * * LOCK_EX | Exclusive lock. Only one process may hold an * | exclusive lock for a given file at a time. * ----------+------------------------------------------------ * LOCK_NB | Don't block when locking. May be combined * | with other lock options using logical or. * ----------+------------------------------------------------ * LOCK_SH | Shared lock. Multiple processes may each hold a * | shared lock for a given file at the same time. * ----------+------------------------------------------------ * LOCK_UN | Unlock. * * Example: * * # update a counter using write lock * # don't use "w" because it truncates the file before lock. * File.open("counter", File::RDWR|File::CREAT, 0644) {|f| * f.flock(File::LOCK_EX) * value = f.read.to_i + 1 * f.rewind * f.write("#{value}\n") * f.flush * f.truncate(f.pos) * } * * # read the counter using read lock * File.open("counter", "r") {|f| * f.flock(File::LOCK_SH) * p f.read * } * */ static VALUE rb_file_flock(VALUE obj, VALUE operation) { rb_io_t *fptr; int op[2], op1; struct timeval time; op[1] = op1 = NUM2INT(operation); GetOpenFile(obj, fptr); op[0] = fptr->fd; if (fptr->mode & FMODE_WRITABLE) { rb_io_flush_raw(obj, 0); } while ((int)rb_thread_io_blocking_region(rb_thread_flock, op, fptr->fd) < 0) { int e = errno; switch (e) { case EAGAIN: case EACCES: #if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN case EWOULDBLOCK: #endif if (op1 & LOCK_NB) return Qfalse; time.tv_sec = 0; time.tv_usec = 100 * 1000; /* 0.1 sec */ rb_thread_wait_for(time); rb_io_check_closed(fptr); continue; case EINTR: #if defined(ERESTART) case ERESTART: #endif break; default: rb_syserr_fail_path(e, fptr->pathv); } } return INT2FIX(0); } static void test_check(int n, int argc, VALUE *argv) { int i; n+=1; rb_check_arity(argc, n, n); for (i=1; i obj * * Uses the character +cmd+ to perform various tests on +file1+ (first * table below) or on +file1+ and +file2+ (second table). * * File tests on a single file: * * Cmd Returns Meaning * "A" | Time | Last access time for file1 * "b" | boolean | True if file1 is a block device * "c" | boolean | True if file1 is a character device * "C" | Time | Last change time for file1 * "d" | boolean | True if file1 exists and is a directory * "e" | boolean | True if file1 exists * "f" | boolean | True if file1 exists and is a regular file * "g" | boolean | True if file1 has the \CF{setgid} bit * | | set (false under NT) * "G" | boolean | True if file1 exists and has a group * | | ownership equal to the caller's group * "k" | boolean | True if file1 exists and has the sticky bit set * "l" | boolean | True if file1 exists and is a symbolic link * "M" | Time | Last modification time for file1 * "o" | boolean | True if file1 exists and is owned by * | | the caller's effective uid * "O" | boolean | True if file1 exists and is owned by * | | the caller's real uid * "p" | boolean | True if file1 exists and is a fifo * "r" | boolean | True if file1 is readable by the effective * | | uid/gid of the caller * "R" | boolean | True if file is readable by the real * | | uid/gid of the caller * "s" | int/nil | If file1 has nonzero size, return the size, * | | otherwise return nil * "S" | boolean | True if file1 exists and is a socket * "u" | boolean | True if file1 has the setuid bit set * "w" | boolean | True if file1 exists and is writable by * | | the effective uid/gid * "W" | boolean | True if file1 exists and is writable by * | | the real uid/gid * "x" | boolean | True if file1 exists and is executable by * | | the effective uid/gid * "X" | boolean | True if file1 exists and is executable by * | | the real uid/gid * "z" | boolean | True if file1 exists and has a zero length * * Tests that take two files: * * "-" | boolean | True if file1 and file2 are identical * "=" | boolean | True if the modification times of file1 * | | and file2 are equal * "<" | boolean | True if the modification time of file1 * | | is prior to that of file2 * ">" | boolean | True if the modification time of file1 * | | is after that of file2 */ static VALUE rb_f_test(int argc, VALUE *argv) { int cmd; if (argc == 0) rb_check_arity(argc, 2, 3); cmd = NUM2CHR(argv[0]); if (cmd == 0) { unknown: /* unknown command */ if (ISPRINT(cmd)) { rb_raise(rb_eArgError, "unknown command '%s%c'", cmd == '\'' || cmd == '\\' ? "\\" : "", cmd); } else { rb_raise(rb_eArgError, "unknown command \"\\x%02X\"", cmd); } } if (strchr("bcdefgGkloOprRsSuwWxXz", cmd)) { CHECK(1); switch (cmd) { case 'b': return rb_file_blockdev_p(0, argv[1]); case 'c': return rb_file_chardev_p(0, argv[1]); case 'd': return rb_file_directory_p(0, argv[1]); case 'e': return rb_file_exist_p(0, argv[1]); case 'f': return rb_file_file_p(0, argv[1]); case 'g': return rb_file_sgid_p(0, argv[1]); case 'G': return rb_file_grpowned_p(0, argv[1]); case 'k': return rb_file_sticky_p(0, argv[1]); case 'l': return rb_file_symlink_p(0, argv[1]); case 'o': return rb_file_owned_p(0, argv[1]); case 'O': return rb_file_rowned_p(0, argv[1]); case 'p': return rb_file_pipe_p(0, argv[1]); case 'r': return rb_file_readable_p(0, argv[1]); case 'R': return rb_file_readable_real_p(0, argv[1]); case 's': return rb_file_size_p(0, argv[1]); case 'S': return rb_file_socket_p(0, argv[1]); case 'u': return rb_file_suid_p(0, argv[1]); case 'w': return rb_file_writable_p(0, argv[1]); case 'W': return rb_file_writable_real_p(0, argv[1]); case 'x': return rb_file_executable_p(0, argv[1]); case 'X': return rb_file_executable_real_p(0, argv[1]); case 'z': return rb_file_zero_p(0, argv[1]); } } if (strchr("MAC", cmd)) { struct stat st; VALUE fname = argv[1]; CHECK(1); if (rb_stat(fname, &st) == -1) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } switch (cmd) { case 'A': return stat_atime(&st); case 'M': return stat_mtime(&st); case 'C': return stat_ctime(&st); } } if (cmd == '-') { CHECK(2); return rb_file_identical_p(0, argv[1], argv[2]); } if (strchr("=<>", cmd)) { struct stat st1, st2; struct timespec t1, t2; CHECK(2); if (rb_stat(argv[1], &st1) < 0) return Qfalse; if (rb_stat(argv[2], &st2) < 0) return Qfalse; t1 = stat_mtimespec(&st1); t2 = stat_mtimespec(&st2); switch (cmd) { case '=': if (t1.tv_sec == t2.tv_sec && t1.tv_nsec == t2.tv_nsec) return Qtrue; return Qfalse; case '>': if (t1.tv_sec > t2.tv_sec) return Qtrue; if (t1.tv_sec == t2.tv_sec && t1.tv_nsec > t2.tv_nsec) return Qtrue; return Qfalse; case '<': if (t1.tv_sec < t2.tv_sec) return Qtrue; if (t1.tv_sec == t2.tv_sec && t1.tv_nsec < t2.tv_nsec) return Qtrue; return Qfalse; } } goto unknown; } /* * Document-class: File::Stat * * Objects of class File::Stat encapsulate common status * information for File objects. The information is * recorded at the moment the File::Stat object is * created; changes made to the file after that point will not be * reflected. File::Stat objects are returned by * IO#stat, File::stat, * File#lstat, and File::lstat. Many of these * methods return platform-specific values, and not all values are * meaningful on all systems. See also Kernel#test. */ static VALUE rb_stat_s_alloc(VALUE klass) { return stat_new_0(klass, 0); } /* * call-seq: * * File::Stat.new(file_name) -> stat * * Create a File::Stat object for the given file name (raising an * exception if the file doesn't exist). */ static VALUE rb_stat_init(VALUE obj, VALUE fname) { struct stat st, *nst; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (STAT(StringValueCStr(fname), &st) == -1) { rb_sys_fail_path(fname); } if (DATA_PTR(obj)) { xfree(DATA_PTR(obj)); DATA_PTR(obj) = NULL; } nst = ALLOC(struct stat); *nst = st; DATA_PTR(obj) = nst; return Qnil; } /* :nodoc: */ static VALUE rb_stat_init_copy(VALUE copy, VALUE orig) { struct stat *nst; if (!OBJ_INIT_COPY(copy, orig)) return copy; if (DATA_PTR(copy)) { xfree(DATA_PTR(copy)); DATA_PTR(copy) = 0; } if (DATA_PTR(orig)) { nst = ALLOC(struct stat); *nst = *(struct stat*)DATA_PTR(orig); DATA_PTR(copy) = nst; } return copy; } /* * call-seq: * stat.ftype -> string * * Identifies the type of stat. The return string is one of: * ``file'', ``directory'', * ``characterSpecial'', ``blockSpecial'', * ``fifo'', ``link'', * ``socket'', or ``unknown''. * * File.stat("/dev/tty").ftype #=> "characterSpecial" * */ static VALUE rb_stat_ftype(VALUE obj) { return rb_file_ftype(get_stat(obj)); } /* * call-seq: * stat.directory? -> true or false * * Returns true if stat is a directory, * false otherwise. * * File.stat("testfile").directory? #=> false * File.stat(".").directory? #=> true */ static VALUE rb_stat_d(VALUE obj) { if (S_ISDIR(get_stat(obj)->st_mode)) return Qtrue; return Qfalse; } /* * call-seq: * stat.pipe? -> true or false * * Returns true if the operating system supports pipes and * stat is a pipe; false otherwise. */ static VALUE rb_stat_p(VALUE obj) { #ifdef S_IFIFO if (S_ISFIFO(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * stat.symlink? -> true or false * * Returns true if stat is a symbolic link, * false if it isn't or if the operating system doesn't * support this feature. As File::stat automatically * follows symbolic links, symlink? will always be * false for an object returned by * File::stat. * * File.symlink("testfile", "alink") #=> 0 * File.stat("alink").symlink? #=> false * File.lstat("alink").symlink? #=> true * */ static VALUE rb_stat_l(VALUE obj) { #ifdef S_ISLNK if (S_ISLNK(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * stat.socket? -> true or false * * Returns true if stat is a socket, * false if it isn't or if the operating system doesn't * support this feature. * * File.stat("testfile").socket? #=> false * */ static VALUE rb_stat_S(VALUE obj) { #ifdef S_ISSOCK if (S_ISSOCK(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * stat.blockdev? -> true or false * * Returns true if the file is a block device, * false if it isn't or if the operating system doesn't * support this feature. * * File.stat("testfile").blockdev? #=> false * File.stat("/dev/hda1").blockdev? #=> true * */ static VALUE rb_stat_b(VALUE obj) { #ifdef S_ISBLK if (S_ISBLK(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; } /* * call-seq: * stat.chardev? -> true or false * * Returns true if the file is a character device, * false if it isn't or if the operating system doesn't * support this feature. * * File.stat("/dev/tty").chardev? #=> true * */ static VALUE rb_stat_c(VALUE obj) { if (S_ISCHR(get_stat(obj)->st_mode)) return Qtrue; return Qfalse; } /* * call-seq: * stat.owned? -> true or false * * Returns true if the effective user id of the process is * the same as the owner of stat. * * File.stat("testfile").owned? #=> true * File.stat("/etc/passwd").owned? #=> false * */ static VALUE rb_stat_owned(VALUE obj) { if (get_stat(obj)->st_uid == geteuid()) return Qtrue; return Qfalse; } static VALUE rb_stat_rowned(VALUE obj) { if (get_stat(obj)->st_uid == getuid()) return Qtrue; return Qfalse; } /* * call-seq: * stat.grpowned? -> true or false * * Returns true if the effective group id of the process is the same as * the group id of stat. On Windows NT, returns false. * * File.stat("testfile").grpowned? #=> true * File.stat("/etc/passwd").grpowned? #=> false * */ static VALUE rb_stat_grpowned(VALUE obj) { #ifndef _WIN32 if (rb_group_member(get_stat(obj)->st_gid)) return Qtrue; #endif return Qfalse; } /* * call-seq: * stat.readable? -> true or false * * Returns true if stat is readable by the * effective user id of this process. * * File.stat("testfile").readable? #=> true * */ static VALUE rb_stat_r(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (geteuid() == 0) return Qtrue; #endif #ifdef S_IRUSR if (rb_stat_owned(obj)) return st->st_mode & S_IRUSR ? Qtrue : Qfalse; #endif #ifdef S_IRGRP if (rb_stat_grpowned(obj)) return st->st_mode & S_IRGRP ? Qtrue : Qfalse; #endif #ifdef S_IROTH if (!(st->st_mode & S_IROTH)) return Qfalse; #endif return Qtrue; } /* * call-seq: * stat.readable_real? -> true or false * * Returns true if stat is readable by the real * user id of this process. * * File.stat("testfile").readable_real? #=> true * */ static VALUE rb_stat_R(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (getuid() == 0) return Qtrue; #endif #ifdef S_IRUSR if (rb_stat_rowned(obj)) return st->st_mode & S_IRUSR ? Qtrue : Qfalse; #endif #ifdef S_IRGRP if (rb_group_member(get_stat(obj)->st_gid)) return st->st_mode & S_IRGRP ? Qtrue : Qfalse; #endif #ifdef S_IROTH if (!(st->st_mode & S_IROTH)) return Qfalse; #endif return Qtrue; } /* * call-seq: * stat.world_readable? -> integer or nil * * If stat is readable by others, returns an integer * representing the file permission bits of stat. Returns * nil otherwise. The meaning of the bits is platform * dependent; on Unix systems, see stat(2). * * m = File.stat("/etc/passwd").world_readable? #=> 420 * sprintf("%o", m) #=> "644" */ static VALUE rb_stat_wr(VALUE obj) { #ifdef S_IROTH struct stat *st = get_stat(obj); if ((st->st_mode & (S_IROTH)) == S_IROTH) { return UINT2NUM(st->st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } else { return Qnil; } #endif } /* * call-seq: * stat.writable? -> true or false * * Returns true if stat is writable by the * effective user id of this process. * * File.stat("testfile").writable? #=> true * */ static VALUE rb_stat_w(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (geteuid() == 0) return Qtrue; #endif #ifdef S_IWUSR if (rb_stat_owned(obj)) return st->st_mode & S_IWUSR ? Qtrue : Qfalse; #endif #ifdef S_IWGRP if (rb_stat_grpowned(obj)) return st->st_mode & S_IWGRP ? Qtrue : Qfalse; #endif #ifdef S_IWOTH if (!(st->st_mode & S_IWOTH)) return Qfalse; #endif return Qtrue; } /* * call-seq: * stat.writable_real? -> true or false * * Returns true if stat is writable by the real * user id of this process. * * File.stat("testfile").writable_real? #=> true * */ static VALUE rb_stat_W(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (getuid() == 0) return Qtrue; #endif #ifdef S_IWUSR if (rb_stat_rowned(obj)) return st->st_mode & S_IWUSR ? Qtrue : Qfalse; #endif #ifdef S_IWGRP if (rb_group_member(get_stat(obj)->st_gid)) return st->st_mode & S_IWGRP ? Qtrue : Qfalse; #endif #ifdef S_IWOTH if (!(st->st_mode & S_IWOTH)) return Qfalse; #endif return Qtrue; } /* * call-seq: * stat.world_writable? -> integer or nil * * If stat is writable by others, returns an integer * representing the file permission bits of stat. Returns * nil otherwise. The meaning of the bits is platform * dependent; on Unix systems, see stat(2). * * m = File.stat("/tmp").world_writable? #=> 511 * sprintf("%o", m) #=> "777" */ static VALUE rb_stat_ww(VALUE obj) { #ifdef S_IROTH struct stat *st = get_stat(obj); if ((st->st_mode & (S_IWOTH)) == S_IWOTH) { return UINT2NUM(st->st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } else { return Qnil; } #endif } /* * call-seq: * stat.executable? -> true or false * * Returns true if stat is executable or if the * operating system doesn't distinguish executable files from * nonexecutable files. The tests are made using the effective owner of * the process. * * File.stat("testfile").executable? #=> false * */ static VALUE rb_stat_x(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (geteuid() == 0) { return st->st_mode & S_IXUGO ? Qtrue : Qfalse; } #endif #ifdef S_IXUSR if (rb_stat_owned(obj)) return st->st_mode & S_IXUSR ? Qtrue : Qfalse; #endif #ifdef S_IXGRP if (rb_stat_grpowned(obj)) return st->st_mode & S_IXGRP ? Qtrue : Qfalse; #endif #ifdef S_IXOTH if (!(st->st_mode & S_IXOTH)) return Qfalse; #endif return Qtrue; } /* * call-seq: * stat.executable_real? -> true or false * * Same as executable?, but tests using the real owner of * the process. */ static VALUE rb_stat_X(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (getuid() == 0) { return st->st_mode & S_IXUGO ? Qtrue : Qfalse; } #endif #ifdef S_IXUSR if (rb_stat_rowned(obj)) return st->st_mode & S_IXUSR ? Qtrue : Qfalse; #endif #ifdef S_IXGRP if (rb_group_member(get_stat(obj)->st_gid)) return st->st_mode & S_IXGRP ? Qtrue : Qfalse; #endif #ifdef S_IXOTH if (!(st->st_mode & S_IXOTH)) return Qfalse; #endif return Qtrue; } /* * call-seq: * stat.file? -> true or false * * Returns true if stat is a regular file (not * a device file, pipe, socket, etc.). * * File.stat("testfile").file? #=> true * */ static VALUE rb_stat_f(VALUE obj) { if (S_ISREG(get_stat(obj)->st_mode)) return Qtrue; return Qfalse; } /* * call-seq: * stat.zero? -> true or false * * Returns true if stat is a zero-length file; * false otherwise. * * File.stat("testfile").zero? #=> false * */ static VALUE rb_stat_z(VALUE obj) { if (get_stat(obj)->st_size == 0) return Qtrue; return Qfalse; } /* * call-seq: * state.size -> integer * * Returns the size of stat in bytes. * * File.stat("testfile").size #=> 66 * */ static VALUE rb_stat_s(VALUE obj) { off_t size = get_stat(obj)->st_size; if (size == 0) return Qnil; return OFFT2NUM(size); } /* * call-seq: * stat.setuid? -> true or false * * Returns true if stat has the set-user-id * permission bit set, false if it doesn't or if the * operating system doesn't support this feature. * * File.stat("/bin/su").setuid? #=> true */ static VALUE rb_stat_suid(VALUE obj) { #ifdef S_ISUID if (get_stat(obj)->st_mode & S_ISUID) return Qtrue; #endif return Qfalse; } /* * call-seq: * stat.setgid? -> true or false * * Returns true if stat has the set-group-id * permission bit set, false if it doesn't or if the * operating system doesn't support this feature. * * File.stat("/usr/sbin/lpc").setgid? #=> true * */ static VALUE rb_stat_sgid(VALUE obj) { #ifdef S_ISGID if (get_stat(obj)->st_mode & S_ISGID) return Qtrue; #endif return Qfalse; } /* * call-seq: * stat.sticky? -> true or false * * Returns true if stat has its sticky bit set, * false if it doesn't or if the operating system doesn't * support this feature. * * File.stat("testfile").sticky? #=> false * */ static VALUE rb_stat_sticky(VALUE obj) { #ifdef S_ISVTX if (get_stat(obj)->st_mode & S_ISVTX) return Qtrue; #endif return Qfalse; } #if !defined HAVE_MKFIFO && defined HAVE_MKNOD && defined S_IFIFO #define mkfifo(path, mode) mknod(path, (mode)&~S_IFMT|S_IFIFO, 0) #define HAVE_MKFIFO #endif #ifdef HAVE_MKFIFO struct mkfifo_arg { const char *path; mode_t mode; }; static void * nogvl_mkfifo(void *ptr) { struct mkfifo_arg *ma = ptr; return (void *)(VALUE)mkfifo(ma->path, ma->mode); } /* * call-seq: * File.mkfifo(file_name, mode=0666) => 0 * * Creates a FIFO special file with name _file_name_. _mode_ * specifies the FIFO's permissions. It is modified by the process's * umask in the usual way: the permissions of the created file are * (mode & ~umask). */ static VALUE rb_file_s_mkfifo(int argc, VALUE *argv) { VALUE path; struct mkfifo_arg ma; ma.mode = 0666; rb_check_arity(argc, 1, 2); if (argc > 1) { ma.mode = NUM2MODET(argv[1]); } path = argv[0]; FilePathValue(path); path = rb_str_encode_ospath(path); ma.path = RSTRING_PTR(path); if (rb_thread_call_without_gvl(nogvl_mkfifo, &ma, RUBY_UBF_IO, 0)) { rb_sys_fail_path(path); } return INT2FIX(0); } #else #define rb_file_s_mkfifo rb_f_notimplement #endif static VALUE rb_mFConst; void rb_file_const(const char *name, VALUE value) { rb_define_const(rb_mFConst, name, value); } int rb_is_absolute_path(const char *path) { #ifdef DOSISH_DRIVE_LETTER if (has_drive_letter(path) && isdirsep(path[2])) return 1; #endif #ifdef DOSISH_UNC if (isdirsep(path[0]) && isdirsep(path[1])) return 1; #endif #ifndef DOSISH if (path[0] == '/') return 1; #endif return 0; } #ifndef ENABLE_PATH_CHECK # if defined DOSISH || defined __CYGWIN__ # define ENABLE_PATH_CHECK 0 # else # define ENABLE_PATH_CHECK 1 # endif #endif #if ENABLE_PATH_CHECK static int path_check_0(VALUE path, int execpath) { struct stat st; const char *p0 = StringValueCStr(path); const char *e0; rb_encoding *enc; char *p = 0, *s; if (!rb_is_absolute_path(p0)) { char *buf = ruby_getcwd(); VALUE newpath; newpath = rb_str_new2(buf); xfree(buf); rb_str_cat2(newpath, "/"); rb_str_cat2(newpath, p0); path = newpath; p0 = RSTRING_PTR(path); } e0 = p0 + RSTRING_LEN(path); enc = rb_enc_get(path); for (;;) { #ifndef S_IWOTH # define S_IWOTH 002 #endif if (STAT(p0, &st) == 0 && S_ISDIR(st.st_mode) && (st.st_mode & S_IWOTH) #ifdef S_ISVTX && !(p && execpath && (st.st_mode & S_ISVTX)) #endif && !access(p0, W_OK)) { rb_enc_warn(enc, "Insecure world writable dir %s in %sPATH, mode 0%" PRI_MODET_PREFIX"o", p0, (execpath ? "" : "LOAD_"), st.st_mode); if (p) *p = '/'; RB_GC_GUARD(path); return 0; } s = strrdirsep(p0, e0, enc); if (p) *p = '/'; if (!s || s == p0) return 1; p = s; e0 = p; *p = '\0'; } } #endif #if ENABLE_PATH_CHECK #define fpath_check(path) path_check_0((path), FALSE) #else #define fpath_check(path) 1 #endif int rb_path_check(const char *path) { #if ENABLE_PATH_CHECK const char *p0, *p, *pend; const char sep = PATH_SEP_CHAR; if (!path) return 1; pend = path + strlen(path); p0 = path; p = strchr(path, sep); if (!p) p = pend; for (;;) { if (!path_check_0(rb_str_new(p0, p - p0), TRUE)) { return 0; /* not safe */ } p0 = p + 1; if (p0 > pend) break; p = strchr(p0, sep); if (!p) p = pend; } #endif return 1; } int ruby_is_fd_loadable(int fd) { #ifdef _WIN32 return 1; #else struct stat st; if (fstat(fd, &st) < 0) return 0; if (S_ISREG(st.st_mode)) return 1; if (S_ISFIFO(st.st_mode) || S_ISCHR(st.st_mode)) return -1; if (S_ISDIR(st.st_mode)) errno = EISDIR; else errno = ENXIO; return 0; #endif } #ifndef _WIN32 int rb_file_load_ok(const char *path) { int ret = 1; /* open(2) may block if path is FIFO and it's empty. Let's use O_NONBLOCK. FIXME: Why O_NDELAY is checked? */ int mode = (O_RDONLY | #if defined O_NONBLOCK O_NONBLOCK | #elif defined O_NDELAY O_NDELAY | #endif 0); int fd = rb_cloexec_open(path, mode, 0); if (fd == -1) return 0; rb_update_max_fd(fd); ret = ruby_is_fd_loadable(fd); (void)close(fd); return ret; } #endif static int is_explicit_relative(const char *path) { if (*path++ != '.') return 0; if (*path == '.') path++; return isdirsep(*path); } static VALUE copy_path_class(VALUE path, VALUE orig) { str_shrink(path); RBASIC_SET_CLASS(path, rb_obj_class(orig)); OBJ_FREEZE(path); return path; } int rb_find_file_ext(VALUE *filep, const char *const *ext) { return rb_find_file_ext_safe(filep, ext, rb_safe_level()); } int rb_find_file_ext_safe(VALUE *filep, const char *const *ext, int safe_level) { const char *f = StringValueCStr(*filep); VALUE fname = *filep, load_path, tmp; long i, j, fnlen; int expanded = 0; if (!ext[0]) return 0; if (f[0] == '~') { fname = file_expand_path_1(fname); if (safe_level >= 1 && OBJ_TAINTED(fname)) { rb_raise(rb_eSecurityError, "loading from unsafe file %s", f); } f = RSTRING_PTR(fname); *filep = fname; expanded = 1; } if (expanded || rb_is_absolute_path(f) || is_explicit_relative(f)) { if (safe_level >= 1 && !fpath_check(fname)) { rb_raise(rb_eSecurityError, "loading from unsafe path %s", f); } if (!expanded) fname = file_expand_path_1(fname); fnlen = RSTRING_LEN(fname); for (i=0; ext[i]; i++) { rb_str_cat2(fname, ext[i]); if (rb_file_load_ok(RSTRING_PTR(fname))) { *filep = copy_path_class(fname, *filep); return (int)(i+1); } rb_str_set_len(fname, fnlen); } return 0; } RB_GC_GUARD(load_path) = rb_get_expanded_load_path(); if (!load_path) return 0; fname = rb_str_dup(*filep); RBASIC_CLEAR_CLASS(fname); fnlen = RSTRING_LEN(fname); tmp = rb_str_tmp_new(MAXPATHLEN + 2); rb_enc_associate_index(tmp, rb_usascii_encindex()); for (j=0; ext[j]; j++) { rb_str_cat2(fname, ext[j]); for (i = 0; i < RARRAY_LEN(load_path); i++) { VALUE str = RARRAY_AREF(load_path, i); RB_GC_GUARD(str) = rb_get_path_check(str, safe_level); if (RSTRING_LEN(str) == 0) continue; rb_file_expand_path_internal(fname, str, 0, 0, tmp); if (rb_file_load_ok(RSTRING_PTR(tmp))) { *filep = copy_path_class(tmp, *filep); return (int)(j+1); } FL_UNSET(tmp, FL_TAINT); } rb_str_set_len(fname, fnlen); } rb_str_resize(tmp, 0); RB_GC_GUARD(load_path); return 0; } VALUE rb_find_file(VALUE path) { return rb_find_file_safe(path, rb_safe_level()); } VALUE rb_find_file_safe(VALUE path, int safe_level) { VALUE tmp, load_path; const char *f = StringValueCStr(path); int expanded = 0; if (f[0] == '~') { tmp = file_expand_path_1(path); if (safe_level >= 1 && OBJ_TAINTED(tmp)) { rb_raise(rb_eSecurityError, "loading from unsafe file %"PRIsVALUE, tmp); } path = copy_path_class(tmp, path); f = RSTRING_PTR(path); expanded = 1; } if (expanded || rb_is_absolute_path(f) || is_explicit_relative(f)) { if (safe_level >= 1 && !fpath_check(path)) { rb_raise(rb_eSecurityError, "loading from unsafe path %"PRIsVALUE, path); } if (!rb_file_load_ok(f)) return 0; if (!expanded) path = copy_path_class(file_expand_path_1(path), path); return path; } RB_GC_GUARD(load_path) = rb_get_expanded_load_path(); if (load_path) { long i; tmp = rb_str_tmp_new(MAXPATHLEN + 2); rb_enc_associate_index(tmp, rb_usascii_encindex()); for (i = 0; i < RARRAY_LEN(load_path); i++) { VALUE str = RARRAY_AREF(load_path, i); RB_GC_GUARD(str) = rb_get_path_check(str, safe_level); if (RSTRING_LEN(str) > 0) { rb_file_expand_path_internal(path, str, 0, 0, tmp); f = RSTRING_PTR(tmp); if (rb_file_load_ok(f)) goto found; } } rb_str_resize(tmp, 0); return 0; } else { return 0; /* no path, no load */ } found: if (safe_level >= 1 && !fpath_check(tmp)) { rb_raise(rb_eSecurityError, "loading from unsafe file %"PRIsVALUE, tmp); } return copy_path_class(tmp, path); } static void define_filetest_function(const char *name, VALUE (*func)(ANYARGS), int argc) { rb_define_module_function(rb_mFileTest, name, func, argc); rb_define_singleton_method(rb_cFile, name, func, argc); } const char ruby_null_device[] = #if defined DOSISH "NUL" #elif defined AMIGA || defined __amigaos__ "NIL" #elif defined __VMS "NL:" #else "/dev/null" #endif ; /* * A File is an abstraction of any file object accessible * by the program and is closely associated with class IO. * File includes the methods of module * FileTest as class methods, allowing you to write (for * example) File.exist?("foo"). * * In the description of File methods, * permission bits are a platform-specific * set of bits that indicate permissions of a file. On Unix-based * systems, permissions are viewed as a set of three octets, for the * owner, the group, and the rest of the world. For each of these * entities, permissions may be set to read, write, or execute the * file: * * The permission bits 0644 (in octal) would thus be * interpreted as read/write for owner, and read-only for group and * other. Higher-order bits may also be used to indicate the type of * file (plain, directory, pipe, socket, and so on) and various other * special features. If the permissions are for a directory, the * meaning of the execute bit changes; when set the directory can be * searched. * * On non-Posix operating systems, there may be only the ability to * make a file read-only or read-write. In this case, the remaining * permission bits will be synthesized to resemble typical values. For * instance, on Windows NT the default permission bits are * 0644, which means read/write for owner, read-only for * all others. The only change that can be made is to make the file * read-only, which is reported as 0444. * * Various constants for the methods in File can be found in File::Constants. */ void Init_File(void) { VALUE separator; rb_mFileTest = rb_define_module("FileTest"); rb_cFile = rb_define_class("File", rb_cIO); define_filetest_function("directory?", rb_file_directory_p, 1); define_filetest_function("exist?", rb_file_exist_p, 1); define_filetest_function("exists?", rb_file_exists_p, 1); define_filetest_function("readable?", rb_file_readable_p, 1); define_filetest_function("readable_real?", rb_file_readable_real_p, 1); define_filetest_function("world_readable?", rb_file_world_readable_p, 1); define_filetest_function("writable?", rb_file_writable_p, 1); define_filetest_function("writable_real?", rb_file_writable_real_p, 1); define_filetest_function("world_writable?", rb_file_world_writable_p, 1); define_filetest_function("executable?", rb_file_executable_p, 1); define_filetest_function("executable_real?", rb_file_executable_real_p, 1); define_filetest_function("file?", rb_file_file_p, 1); define_filetest_function("zero?", rb_file_zero_p, 1); define_filetest_function("empty?", rb_file_zero_p, 1); define_filetest_function("size?", rb_file_size_p, 1); define_filetest_function("size", rb_file_s_size, 1); define_filetest_function("owned?", rb_file_owned_p, 1); define_filetest_function("grpowned?", rb_file_grpowned_p, 1); define_filetest_function("pipe?", rb_file_pipe_p, 1); define_filetest_function("symlink?", rb_file_symlink_p, 1); define_filetest_function("socket?", rb_file_socket_p, 1); define_filetest_function("blockdev?", rb_file_blockdev_p, 1); define_filetest_function("chardev?", rb_file_chardev_p, 1); define_filetest_function("setuid?", rb_file_suid_p, 1); define_filetest_function("setgid?", rb_file_sgid_p, 1); define_filetest_function("sticky?", rb_file_sticky_p, 1); define_filetest_function("identical?", rb_file_identical_p, 2); rb_define_singleton_method(rb_cFile, "stat", rb_file_s_stat, 1); rb_define_singleton_method(rb_cFile, "lstat", rb_file_s_lstat, 1); rb_define_singleton_method(rb_cFile, "ftype", rb_file_s_ftype, 1); rb_define_singleton_method(rb_cFile, "atime", rb_file_s_atime, 1); rb_define_singleton_method(rb_cFile, "mtime", rb_file_s_mtime, 1); rb_define_singleton_method(rb_cFile, "ctime", rb_file_s_ctime, 1); rb_define_singleton_method(rb_cFile, "birthtime", rb_file_s_birthtime, 1); rb_define_singleton_method(rb_cFile, "utime", rb_file_s_utime, -1); rb_define_singleton_method(rb_cFile, "chmod", rb_file_s_chmod, -1); rb_define_singleton_method(rb_cFile, "chown", rb_file_s_chown, -1); rb_define_singleton_method(rb_cFile, "lchmod", rb_file_s_lchmod, -1); rb_define_singleton_method(rb_cFile, "lchown", rb_file_s_lchown, -1); rb_define_singleton_method(rb_cFile, "lutime", rb_file_s_lutime, -1); rb_define_singleton_method(rb_cFile, "link", rb_file_s_link, 2); rb_define_singleton_method(rb_cFile, "symlink", rb_file_s_symlink, 2); rb_define_singleton_method(rb_cFile, "readlink", rb_file_s_readlink, 1); rb_define_singleton_method(rb_cFile, "unlink", rb_file_s_unlink, -1); rb_define_singleton_method(rb_cFile, "delete", rb_file_s_unlink, -1); rb_define_singleton_method(rb_cFile, "rename", rb_file_s_rename, 2); rb_define_singleton_method(rb_cFile, "umask", rb_file_s_umask, -1); rb_define_singleton_method(rb_cFile, "truncate", rb_file_s_truncate, 2); rb_define_singleton_method(rb_cFile, "mkfifo", rb_file_s_mkfifo, -1); rb_define_singleton_method(rb_cFile, "expand_path", rb_file_s_expand_path, -1); rb_define_singleton_method(rb_cFile, "absolute_path", rb_file_s_absolute_path, -1); rb_define_singleton_method(rb_cFile, "realpath", rb_file_s_realpath, -1); rb_define_singleton_method(rb_cFile, "realdirpath", rb_file_s_realdirpath, -1); rb_define_singleton_method(rb_cFile, "basename", rb_file_s_basename, -1); rb_define_singleton_method(rb_cFile, "dirname", rb_file_s_dirname, 1); rb_define_singleton_method(rb_cFile, "extname", rb_file_s_extname, 1); rb_define_singleton_method(rb_cFile, "path", rb_file_s_path, 1); separator = rb_fstring_lit("/"); /* separates directory parts in path */ rb_define_const(rb_cFile, "Separator", separator); /* separates directory parts in path */ rb_define_const(rb_cFile, "SEPARATOR", separator); rb_define_singleton_method(rb_cFile, "split", rb_file_s_split, 1); rb_define_singleton_method(rb_cFile, "join", rb_file_s_join, -2); #ifdef DOSISH /* platform specific alternative separator */ rb_define_const(rb_cFile, "ALT_SEPARATOR", rb_obj_freeze(rb_usascii_str_new2(file_alt_separator))); #else rb_define_const(rb_cFile, "ALT_SEPARATOR", Qnil); #endif /* path list separator */ rb_define_const(rb_cFile, "PATH_SEPARATOR", rb_fstring_cstr(PATH_SEP)); rb_define_method(rb_cIO, "stat", rb_io_stat, 0); /* this is IO's method */ rb_define_method(rb_cFile, "lstat", rb_file_lstat, 0); rb_define_method(rb_cFile, "atime", rb_file_atime, 0); rb_define_method(rb_cFile, "mtime", rb_file_mtime, 0); rb_define_method(rb_cFile, "ctime", rb_file_ctime, 0); rb_define_method(rb_cFile, "birthtime", rb_file_birthtime, 0); rb_define_method(rb_cFile, "size", rb_file_size, 0); rb_define_method(rb_cFile, "chmod", rb_file_chmod, 1); rb_define_method(rb_cFile, "chown", rb_file_chown, 2); rb_define_method(rb_cFile, "truncate", rb_file_truncate, 1); rb_define_method(rb_cFile, "flock", rb_file_flock, 1); /* * Document-module: File::Constants * * File::Constants provides file-related constants. All possible * file constants are listed in the documentation but they may not all * be present on your platform. * * If the underlying platform doesn't define a constant the corresponding * Ruby constant is not defined. * * Your platform documentations (e.g. man open(2)) may describe more * detailed information. */ rb_mFConst = rb_define_module_under(rb_cFile, "Constants"); rb_include_module(rb_cIO, rb_mFConst); /* open for reading only */ rb_define_const(rb_mFConst, "RDONLY", INT2FIX(O_RDONLY)); /* open for writing only */ rb_define_const(rb_mFConst, "WRONLY", INT2FIX(O_WRONLY)); /* open for reading and writing */ rb_define_const(rb_mFConst, "RDWR", INT2FIX(O_RDWR)); /* append on each write */ rb_define_const(rb_mFConst, "APPEND", INT2FIX(O_APPEND)); /* create file if it does not exist */ rb_define_const(rb_mFConst, "CREAT", INT2FIX(O_CREAT)); /* error if CREAT and the file exists */ rb_define_const(rb_mFConst, "EXCL", INT2FIX(O_EXCL)); #if defined(O_NDELAY) || defined(O_NONBLOCK) # ifndef O_NONBLOCK # define O_NONBLOCK O_NDELAY # endif /* do not block on open or for data to become available */ rb_define_const(rb_mFConst, "NONBLOCK", INT2FIX(O_NONBLOCK)); #endif /* truncate size to 0 */ rb_define_const(rb_mFConst, "TRUNC", INT2FIX(O_TRUNC)); #ifdef O_NOCTTY /* not to make opened IO the controlling terminal device */ rb_define_const(rb_mFConst, "NOCTTY", INT2FIX(O_NOCTTY)); #endif #ifndef O_BINARY # define O_BINARY 0 #endif /* disable line code conversion */ rb_define_const(rb_mFConst, "BINARY", INT2FIX(O_BINARY)); #ifndef O_SHARE_DELETE # define O_SHARE_DELETE 0 #endif /* can delete opened file */ rb_define_const(rb_mFConst, "SHARE_DELETE", INT2FIX(O_SHARE_DELETE)); #ifdef O_SYNC /* any write operation perform synchronously */ rb_define_const(rb_mFConst, "SYNC", INT2FIX(O_SYNC)); #endif #ifdef O_DSYNC /* any write operation perform synchronously except some meta data */ rb_define_const(rb_mFConst, "DSYNC", INT2FIX(O_DSYNC)); #endif #ifdef O_RSYNC /* any read operation perform synchronously. used with SYNC or DSYNC. */ rb_define_const(rb_mFConst, "RSYNC", INT2FIX(O_RSYNC)); #endif #ifdef O_NOFOLLOW /* do not follow symlinks */ rb_define_const(rb_mFConst, "NOFOLLOW", INT2FIX(O_NOFOLLOW)); /* FreeBSD, Linux */ #endif #ifdef O_NOATIME /* do not change atime */ rb_define_const(rb_mFConst, "NOATIME", INT2FIX(O_NOATIME)); /* Linux */ #endif #ifdef O_DIRECT /* Try to minimize cache effects of the I/O to and from this file. */ rb_define_const(rb_mFConst, "DIRECT", INT2FIX(O_DIRECT)); #endif #ifdef O_TMPFILE /* Create an unnamed temporary file */ rb_define_const(rb_mFConst, "TMPFILE", INT2FIX(O_TMPFILE)); #endif /* shared lock. see File#flock */ rb_define_const(rb_mFConst, "LOCK_SH", INT2FIX(LOCK_SH)); /* exclusive lock. see File#flock */ rb_define_const(rb_mFConst, "LOCK_EX", INT2FIX(LOCK_EX)); /* unlock. see File#flock */ rb_define_const(rb_mFConst, "LOCK_UN", INT2FIX(LOCK_UN)); /* non-blocking lock. used with LOCK_SH or LOCK_EX. see File#flock */ rb_define_const(rb_mFConst, "LOCK_NB", INT2FIX(LOCK_NB)); /* Name of the null device */ rb_define_const(rb_mFConst, "NULL", rb_fstring_cstr(ruby_null_device)); rb_define_method(rb_cFile, "path", rb_file_path, 0); rb_define_method(rb_cFile, "to_path", rb_file_path, 0); rb_define_global_function("test", rb_f_test, -1); rb_cStat = rb_define_class_under(rb_cFile, "Stat", rb_cObject); rb_define_alloc_func(rb_cStat, rb_stat_s_alloc); rb_define_method(rb_cStat, "initialize", rb_stat_init, 1); rb_define_method(rb_cStat, "initialize_copy", rb_stat_init_copy, 1); rb_include_module(rb_cStat, rb_mComparable); rb_define_method(rb_cStat, "<=>", rb_stat_cmp, 1); rb_define_method(rb_cStat, "dev", rb_stat_dev, 0); rb_define_method(rb_cStat, "dev_major", rb_stat_dev_major, 0); rb_define_method(rb_cStat, "dev_minor", rb_stat_dev_minor, 0); rb_define_method(rb_cStat, "ino", rb_stat_ino, 0); rb_define_method(rb_cStat, "mode", rb_stat_mode, 0); rb_define_method(rb_cStat, "nlink", rb_stat_nlink, 0); rb_define_method(rb_cStat, "uid", rb_stat_uid, 0); rb_define_method(rb_cStat, "gid", rb_stat_gid, 0); rb_define_method(rb_cStat, "rdev", rb_stat_rdev, 0); rb_define_method(rb_cStat, "rdev_major", rb_stat_rdev_major, 0); rb_define_method(rb_cStat, "rdev_minor", rb_stat_rdev_minor, 0); rb_define_method(rb_cStat, "size", rb_stat_size, 0); rb_define_method(rb_cStat, "blksize", rb_stat_blksize, 0); rb_define_method(rb_cStat, "blocks", rb_stat_blocks, 0); rb_define_method(rb_cStat, "atime", rb_stat_atime, 0); rb_define_method(rb_cStat, "mtime", rb_stat_mtime, 0); rb_define_method(rb_cStat, "ctime", rb_stat_ctime, 0); rb_define_method(rb_cStat, "birthtime", rb_stat_birthtime, 0); rb_define_method(rb_cStat, "inspect", rb_stat_inspect, 0); rb_define_method(rb_cStat, "ftype", rb_stat_ftype, 0); rb_define_method(rb_cStat, "directory?", rb_stat_d, 0); rb_define_method(rb_cStat, "readable?", rb_stat_r, 0); rb_define_method(rb_cStat, "readable_real?", rb_stat_R, 0); rb_define_method(rb_cStat, "world_readable?", rb_stat_wr, 0); rb_define_method(rb_cStat, "writable?", rb_stat_w, 0); rb_define_method(rb_cStat, "writable_real?", rb_stat_W, 0); rb_define_method(rb_cStat, "world_writable?", rb_stat_ww, 0); rb_define_method(rb_cStat, "executable?", rb_stat_x, 0); rb_define_method(rb_cStat, "executable_real?", rb_stat_X, 0); rb_define_method(rb_cStat, "file?", rb_stat_f, 0); rb_define_method(rb_cStat, "zero?", rb_stat_z, 0); rb_define_method(rb_cStat, "size?", rb_stat_s, 0); rb_define_method(rb_cStat, "owned?", rb_stat_owned, 0); rb_define_method(rb_cStat, "grpowned?", rb_stat_grpowned, 0); rb_define_method(rb_cStat, "pipe?", rb_stat_p, 0); rb_define_method(rb_cStat, "symlink?", rb_stat_l, 0); rb_define_method(rb_cStat, "socket?", rb_stat_S, 0); rb_define_method(rb_cStat, "blockdev?", rb_stat_b, 0); rb_define_method(rb_cStat, "chardev?", rb_stat_c, 0); rb_define_method(rb_cStat, "setuid?", rb_stat_suid, 0); rb_define_method(rb_cStat, "setgid?", rb_stat_sgid, 0); rb_define_method(rb_cStat, "sticky?", rb_stat_sticky, 0); }