modules/vfs_recycle.c

ソースコードを見る。

関数
static int	recycle_connect (vfs_handle_struct *handle, const char *service, const char *user)
static void	recycle_disconnect (vfs_handle_struct *handle)
static int	recycle_unlink (vfs_handle_struct *handle, const char *file_name)
	Check if file should be recycled
static const char *	recycle_repository (vfs_handle_struct *handle)
static BOOL	recycle_keep_dir_tree (vfs_handle_struct *handle)
static BOOL	recycle_versions (vfs_handle_struct *handle)
static BOOL	recycle_touch (vfs_handle_struct *handle)
static BOOL	recycle_touch_mtime (vfs_handle_struct *handle)
static const char **	recycle_exclude (vfs_handle_struct *handle)
static const char **	recycle_exclude_dir (vfs_handle_struct *handle)
static const char **	recycle_noversions (vfs_handle_struct *handle)
static SMB_OFF_T	recycle_maxsize (vfs_handle_struct *handle)
static SMB_OFF_T	recycle_minsize (vfs_handle_struct *handle)
static mode_t	recycle_directory_mode (vfs_handle_struct *handle)
static mode_t	recycle_subdir_mode (vfs_handle_struct *handle)
static BOOL	recycle_directory_exist (vfs_handle_struct *handle, const char *dname)
static BOOL	recycle_file_exist (vfs_handle_struct *handle, const char *fname)
static SMB_OFF_T	recycle_get_file_size (vfs_handle_struct *handle, const char *fname)
	Return file size
static BOOL	recycle_create_dir (vfs_handle_struct *handle, const char *dname)
	Create directory tree
static BOOL	matchdirparam (const char **dir_exclude_list, char *path)
	Check if any of the components of "exclude_list" are contained in path.
static BOOL	matchparam (const char **haystack_list, const char *needle)
	Check if needle is contained in haystack, * and ? patterns are resolved
static void	recycle_do_touch (vfs_handle_struct *handle, const char *fname, BOOL touch_mtime)
	Touch access or modify date
NTSTATUS	vfs_recycle_init (void)
変数
static int	vfs_recycle_debug_level = DBGC_VFS
static vfs_op_tuple	recycle_ops []
userdom_struct	current_user_info

---

関数

static int recycle_connect	(	vfs_handle_struct *	handle,
		const char *	service,
		const char *	user
	)			[static]

vfs_recycle.c の 51 行で定義されています。

参照先 handle.

{
        DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
                service,user));

        return SMB_VFS_NEXT_CONNECT(handle, service, user);
}

static void recycle_disconnect

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 59 行で定義されています。

参照先 handle.

{
        DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
                lp_servicename(SNUM(handle->conn))));

        SMB_VFS_NEXT_DISCONNECT(handle);
}

static int recycle_unlink	(	vfs_handle_struct *	handle,
		const char *	name
	)			[static]

Check if file should be recycled

vfs_recycle.c の 411 行で定義されています。

参照先 asprintf()・connection_struct::connectpath・current_user_info・userdom_struct::domain・errno・get_current_username()・connection_struct::gid・handle・matchdirparam()・matchparam()・recycle_create_dir()・recycle_directory_exist()・recycle_do_touch()・recycle_exclude()・recycle_exclude_dir()・recycle_file_exist()・recycle_get_file_size()・recycle_keep_dir_tree()・recycle_maxsize()・recycle_minsize()・recycle_noversions()・recycle_repository()・recycle_touch()・recycle_touch_mtime()・recycle_versions()・strerror()・talloc_sub_advanced()・trim_char()・connection_struct::user.

{
        connection_struct *conn = handle->conn;
        char *path_name = NULL;
        char *temp_name = NULL;
        char *final_name = NULL;
        const char *base;
        char *repository = NULL;
        int i = 1;
        SMB_OFF_T maxsize, minsize;
        SMB_OFF_T file_size; /* space_avail;    */
        BOOL exist;
        int rc = -1;

        repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
                                        conn->user,
                                        conn->connectpath, conn->gid,
                                        get_current_username(),
                                        current_user_info.domain,
                                        recycle_repository(handle));
        ALLOC_CHECK(repository, done);
        /* shouldn't we allow absolute path names here? --metze */
        /* Yes :-). JRA. */
        trim_char(repository, '\0', '/');
        
        if(!repository || *(repository) == '\0') {
                DEBUG(3, ("recycle: repository path not set, purging %s...\n", file_name));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }

        /* we don't recycle the recycle bin... */
        if (strncmp(file_name, repository, strlen(repository)) == 0) {
                DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }

        file_size = recycle_get_file_size(handle, file_name);
        /* it is wrong to purge filenames only because they are empty imho
         *   --- simo
         *
        if(fsize == 0) {
                DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
                rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
                goto done;
        }
         */

        /* FIXME: this is wrong, we should check the whole size of the recycle bin is
         * not greater then maxsize, not the size of the single file, also it is better
         * to remove older files
         */
        maxsize = recycle_maxsize(handle);
        if(maxsize > 0 && file_size > maxsize) {
                DEBUG(3, ("recycle: File %s exceeds maximum recycle size, purging... \n", file_name));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }
        minsize = recycle_minsize(handle);
        if(minsize > 0 && file_size < minsize) {
                DEBUG(3, ("recycle: File %s lowers minimum recycle size, purging... \n", file_name));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }

        /* FIXME: this is wrong: moving files with rename does not change the disk space
         * allocation
         *
        space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
        DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
        if(space_avail < file_size) {
                DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }
         */

        /* extract filename and path */
        base = strrchr(file_name, '/');
        if (base == NULL) {
                base = file_name;
                path_name = SMB_STRDUP("/");
                ALLOC_CHECK(path_name, done);
        }
        else {
                path_name = SMB_STRDUP(file_name);
                ALLOC_CHECK(path_name, done);
                path_name[base - file_name] = '\0';
                base++;
        }

        DEBUG(10, ("recycle: fname = %s\n", file_name));        /* original filename with path */
        DEBUG(10, ("recycle: fpath = %s\n", path_name));        /* original path */
        DEBUG(10, ("recycle: base = %s\n", base));              /* filename without path */

        if (matchparam(recycle_exclude(handle), base)) {
                DEBUG(3, ("recycle: file %s is excluded \n", base));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }

        if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
                DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }

        if (recycle_keep_dir_tree(handle) == True) {
                asprintf(&temp_name, "%s/%s", repository, path_name);
        } else {
                temp_name = SMB_STRDUP(repository);
        }
        ALLOC_CHECK(temp_name, done);

        exist = recycle_directory_exist(handle, temp_name);
        if (exist) {
                DEBUG(10, ("recycle: Directory already exists\n"));
        } else {
                DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
                if (recycle_create_dir(handle, temp_name) == False) {
                        DEBUG(3, ("recycle: Could not create directory, purging %s...\n", file_name));
                        rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                        goto done;
                }
        }

        asprintf(&final_name, "%s/%s", temp_name, base);
        ALLOC_CHECK(final_name, done);
        DEBUG(10, ("recycle: recycled file name: %s\n", final_name));           /* new filename with path */

        /* check if we should delete file from recycle bin */
        if (recycle_file_exist(handle, final_name)) {
                if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
                        DEBUG(3, ("recycle: Removing old file %s from recycle bin\n", final_name));
                        if (SMB_VFS_NEXT_UNLINK(handle, final_name) != 0) {
                                DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
                        }
                }
        }

        /* rename file we move to recycle bin */
        i = 1;
        while (recycle_file_exist(handle, final_name)) {
                SAFE_FREE(final_name);
                asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base);
        }

        DEBUG(10, ("recycle: Moving %s to %s\n", file_name, final_name));
        rc = SMB_VFS_NEXT_RENAME(handle, file_name, final_name);
        if (rc != 0) {
                DEBUG(3, ("recycle: Move error %d (%s), purging file %s (%s)\n", errno, strerror(errno), file_name, final_name));
                rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
                goto done;
        }

        /* touch access date of moved file */
        if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
                recycle_do_touch(handle, final_name, recycle_touch_mtime(handle));

done:
        SAFE_FREE(path_name);
        SAFE_FREE(temp_name);
        SAFE_FREE(final_name);
        TALLOC_FREE(repository);
        return rc;
}

static const char* recycle_repository

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 67 行で定義されています。

参照先 handle・lp_parm_const_string().

参照元 recycle_unlink().

{
        const char *tmp_str = NULL;
        

        tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");

        DEBUG(10, ("recycle: repository = %s\n", tmp_str));
        
        return tmp_str;
}

static BOOL recycle_keep_dir_tree

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 79 行で定義されています。

参照先 handle・lp_parm_bool().

参照元 recycle_unlink().

{
        BOOL ret;
        
        ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);

        DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
        
        return ret;
}

static BOOL recycle_versions

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 90 行で定義されています。

参照先 handle・lp_parm_bool().

参照元 recycle_unlink().

{
        BOOL ret;

        ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);

        DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
        
        return ret;
}

static BOOL recycle_touch

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 101 行で定義されています。

参照先 handle・lp_parm_bool().

参照元 recycle_unlink().

{
        BOOL ret;

        ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);

        DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
        
        return ret;
}

static BOOL recycle_touch_mtime

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 112 行で定義されています。

参照先 handle・lp_parm_bool().

参照元 recycle_unlink().

{
        BOOL ret;

        ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);

        DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
        
        return ret;
}

static const char** recycle_exclude

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 123 行で定義されています。

参照先 handle・lp_parm_string_list().

参照元 recycle_unlink().

{
        const char **tmp_lp;
        
        tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);

        DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
        
        return tmp_lp;
}

static const char** recycle_exclude_dir

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 134 行で定義されています。

参照先 handle・lp_parm_string_list().

参照元 recycle_unlink().

{
        const char **tmp_lp;
        
        tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);

        DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
        
        return tmp_lp;
}

static const char** recycle_noversions

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 145 行で定義されています。

参照先 handle・lp_parm_string_list().

参照元 recycle_unlink().

{
        const char **tmp_lp;
        
        tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);

        DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
        
        return tmp_lp;
}

static SMB_OFF_T recycle_maxsize

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 156 行で定義されています。

参照先 conv_str_size()・handle・lp_parm_const_string().

参照元 recycle_unlink().

{
        SMB_OFF_T maxsize;
        
        maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
                                            "recycle", "maxsize", NULL));

        DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize));
        
        return maxsize;
}

static SMB_OFF_T recycle_minsize

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 168 行で定義されています。

参照先 conv_str_size()・handle・lp_parm_const_string().

参照元 recycle_unlink().

{
        SMB_OFF_T minsize;
        
        minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
                                            "recycle", "minsize", NULL));

        DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
        
        return minsize;
}

static mode_t recycle_directory_mode

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 180 行で定義されています。

参照先 handle・lp_parm_const_string().

参照元 recycle_create_dir()・recycle_subdir_mode().

{
        int dirmode;
        const char *buff;

        buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);

        if (buff != NULL ) {
                sscanf(buff, "%o", &dirmode);
        } else {
                dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
        }

        DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
        return (mode_t)dirmode;
}

static mode_t recycle_subdir_mode

(

vfs_handle_struct *

handle

)

[static]

vfs_recycle.c の 197 行で定義されています。

参照先 handle・lp_parm_const_string()・recycle_directory_mode().

参照元 recycle_create_dir().

{
        int dirmode;
        const char *buff;

        buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);

        if (buff != NULL ) {
                sscanf(buff, "%o", &dirmode);
        } else {
                dirmode=recycle_directory_mode(handle);
        }

        DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
        return (mode_t)dirmode;
}

static BOOL recycle_directory_exist	(	vfs_handle_struct *	handle,
		const char *	dname
	)			[static]

vfs_recycle.c の 214 行で定義されています。

参照先 handle.

参照元 recycle_create_dir()・recycle_unlink().

{
        SMB_STRUCT_STAT st;

        if (SMB_VFS_NEXT_STAT(handle, dname, &st) == 0) {
                if (S_ISDIR(st.st_mode)) {
                        return True;
                }
        }

        return False;
}

static BOOL recycle_file_exist	(	vfs_handle_struct *	handle,
		const char *	fname
	)			[static]

vfs_recycle.c の 227 行で定義されています。

参照先 handle.

参照元 recycle_unlink().

{
        SMB_STRUCT_STAT st;

        if (SMB_VFS_NEXT_STAT(handle, fname, &st) == 0) {
                if (S_ISREG(st.st_mode)) {
                        return True;
                }
        }

        return False;
}

static SMB_OFF_T recycle_get_file_size	(	vfs_handle_struct *	handle,
		const char *	fname
	)			[static]

Return file size

引数:

	conn	connection
	fname	file name

戻り値:

size in bytes

vfs_recycle.c の 246 行で定義されています。

参照先 errno・handle・strerror().

参照元 recycle_unlink().

{
        SMB_STRUCT_STAT st;

        if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
                DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
                return (SMB_OFF_T)0;
        }

        return(st.st_size);
}

static BOOL recycle_create_dir	(	vfs_handle_struct *	handle,
		const char *	dname
	)			[static]

Create directory tree

引数:

	conn	connection
	dname	Directory tree to be created

戻り値:

Returns True for success

vfs_recycle.c の 264 行で定義されています。

参照先 errno・handle・len・mode・recycle_directory_exist()・recycle_directory_mode()・recycle_subdir_mode()・strerror().

参照元 recycle_unlink().

{
        size_t len;
        mode_t mode;
        char *new_dir = NULL;
        char *tmp_str = NULL;
        char *token;
        char *tok_str;
        BOOL ret = False;

        mode = recycle_directory_mode(handle);

        tmp_str = SMB_STRDUP(dname);
        ALLOC_CHECK(tmp_str, done);
        tok_str = tmp_str;

        len = strlen(dname)+1;
        new_dir = (char *)SMB_MALLOC(len + 1);
        ALLOC_CHECK(new_dir, done);
        *new_dir = '\0';
        if (dname[0] == '/') {
                /* Absolute path. */
                safe_strcat(new_dir,"/",len);
        }

        /* Create directory tree if neccessary */
        for(token = strtok(tok_str, "/"); token; token = strtok(NULL, "/")) {
                safe_strcat(new_dir, token, len);
                if (recycle_directory_exist(handle, new_dir))
                        DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
                else {
                        DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
                        if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
                                DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
                                ret = False;
                                goto done;
                        }
                }
                safe_strcat(new_dir, "/", len);
                mode = recycle_subdir_mode(handle);
        }

        ret = True;
done:
        SAFE_FREE(tmp_str);
        SAFE_FREE(new_dir);
        return ret;
}

static BOOL matchdirparam	(	const char **	dir_exclude_list,
		char *	path
	)			[static]

Check if any of the components of "exclude_list" are contained in path.

Return True if found

vfs_recycle.c の 318 行で定義されています。

参照先 unix_wild_match().

参照元 recycle_unlink().

{
        char *startp = NULL, *endp = NULL;

        if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
                *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
                return False;
        }

        /* 
         * Walk the components of path, looking for matches with the
         * exclude list on each component. 
         */

        for (startp = path; startp; startp = endp) {
                int i;

                while (*startp == '/') {
                        startp++;
                }
                endp = strchr(startp, '/');
                if (endp) {
                        *endp = '\0';
                }

                for(i=0; dir_exclude_list[i] ; i++) {
                        if(unix_wild_match(dir_exclude_list[i], startp)) {
                                /* Repair path. */
                                if (endp) {
                                        *endp = '/';
                                }
                                return True;
                        }
                }

                /* Repair path. */
                if (endp) {
                        *endp = '/';
                }
        }

        return False;
}

static BOOL matchparam	(	const char **	haystack_list,
		const char *	needle
	)			[static]

Check if needle is contained in haystack, * and ? patterns are resolved

引数:

	haystack	list of parameters separated by delimimiter character
	needle	string to be matched exectly to haystack including pattern matching

戻り値:

True if found

vfs_recycle.c の 368 行で定義されています。

参照先 unix_wild_match().

参照元 recycle_unlink().

{
        int i;

        if (haystack_list == NULL || haystack_list[0] == NULL ||
                *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
                return False;
        }

        for(i=0; haystack_list[i] ; i++) {
                if(unix_wild_match(haystack_list[i], needle)) {
                        return True;
                }
        }

        return False;
}

static void recycle_do_touch	(	vfs_handle_struct *	handle,
		const char *	fname,
		BOOL	touch_mtime
	)			[static]

Touch access or modify date

vfs_recycle.c の 389 行で定義されています。

参照先 errno・get_mtimespec()・handle・strerror()・timespec_current().

参照元 recycle_unlink().

{
        SMB_STRUCT_STAT st;
        struct timespec ts[2];
        
        if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
                DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
                return;
        }
        ts[0] = timespec_current(); /* atime */
        ts[1] = touch_mtime ? ts[0] : get_mtimespec(&st); /* mtime */

        if (SMB_VFS_NEXT_NTIMES(handle, fname, ts) == -1 ) {
                DEBUG(0, ("recycle: touching %s failed, reason = %s\n", fname, strerror(errno)));
        }
}

NTSTATUS vfs_recycle_init

(

void

)

vfs_recycle.c の 580 行で定義されています。

参照先 debug_add_class()・recycle_ops・smb_register_vfs()・vfs_recycle_debug_level.

{
        NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle", recycle_ops);

        if (!NT_STATUS_IS_OK(ret))
                return ret;
        
        vfs_recycle_debug_level = debug_add_class("recycle");
        if (vfs_recycle_debug_level == -1) {
                vfs_recycle_debug_level = DBGC_VFS;
                DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
        } else {
                DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
        }
        
        return ret;
}

---

変数

int vfs_recycle_debug_level = DBGC_VFS [static]

vfs_recycle.c の 30 行で定義されています。

参照元 vfs_recycle_init().

vfs_op_tuple recycle_ops[] [static]

初期値:

 {

        
        {SMB_VFS_OP(recycle_connect),   SMB_VFS_OP_CONNECT,     SMB_VFS_LAYER_TRANSPARENT},
        {SMB_VFS_OP(recycle_disconnect),        SMB_VFS_OP_DISCONNECT,  SMB_VFS_LAYER_TRANSPARENT},

        
        {SMB_VFS_OP(recycle_unlink),    SMB_VFS_OP_UNLINK,      SMB_VFS_LAYER_TRANSPARENT},

        {SMB_VFS_OP(NULL),              SMB_VFS_OP_NOOP,        SMB_VFS_LAYER_NOOP}
}

vfs_recycle.c の 39 行で定義されています。

参照元 vfs_recycle_init().

userdom_struct current_user_info

substitute.c の 29 行で定義されています。

---