2 * Recycle bin VFS module for Samba.
4 * Copyright (C) 2001, Brandon Stone, Amherst College, <bbstone@amherst.edu>.
5 * Copyright (C) 2002, Jeremy Allison - modified to make a VFS module.
6 * Copyright (C) 2002, Alexander Bokovoy - cascaded VFS adoption,
7 * Copyright (C) 2002, Juergen Hasch - added some options.
8 * Copyright (C) 2002, Simo Sorce
9 * Copyright (C) 2002, Stefan (metze) Metzmacher
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <http://www.gnu.org/licenses/>.
27 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
29 static int vfs_recycle_debug_level
= DBGC_VFS
;
32 #define DBGC_CLASS vfs_recycle_debug_level
34 static int recycle_connect(vfs_handle_struct
*handle
, const char *service
, const char *user
);
35 static void recycle_disconnect(vfs_handle_struct
*handle
);
36 static int recycle_unlink(vfs_handle_struct
*handle
, const char *name
);
38 static vfs_op_tuple recycle_ops
[] = {
41 {SMB_VFS_OP(recycle_connect
), SMB_VFS_OP_CONNECT
, SMB_VFS_LAYER_TRANSPARENT
},
42 {SMB_VFS_OP(recycle_disconnect
), SMB_VFS_OP_DISCONNECT
, SMB_VFS_LAYER_TRANSPARENT
},
45 {SMB_VFS_OP(recycle_unlink
), SMB_VFS_OP_UNLINK
, SMB_VFS_LAYER_TRANSPARENT
},
47 {SMB_VFS_OP(NULL
), SMB_VFS_OP_NOOP
, SMB_VFS_LAYER_NOOP
}
50 static int recycle_connect(vfs_handle_struct
*handle
, const char *service
, const char *user
)
52 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
55 return SMB_VFS_NEXT_CONNECT(handle
, service
, user
);
58 static void recycle_disconnect(vfs_handle_struct
*handle
)
60 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
61 lp_servicename(SNUM(handle
->conn
))));
63 SMB_VFS_NEXT_DISCONNECT(handle
);
66 static const char *recycle_repository(vfs_handle_struct
*handle
)
68 const char *tmp_str
= NULL
;
71 tmp_str
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "repository",".recycle");
73 DEBUG(10, ("recycle: repository = %s\n", tmp_str
));
78 static bool recycle_keep_dir_tree(vfs_handle_struct
*handle
)
82 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "keeptree", False
);
84 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret
?"True":"False"));
89 static bool recycle_versions(vfs_handle_struct
*handle
)
93 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "versions", False
);
95 DEBUG(10, ("recycle: versions = %s\n", ret
?"True":"False"));
100 static bool recycle_touch(vfs_handle_struct
*handle
)
104 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch", False
);
106 DEBUG(10, ("recycle: touch = %s\n", ret
?"True":"False"));
111 static bool recycle_touch_mtime(vfs_handle_struct
*handle
)
115 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch_mtime", False
);
117 DEBUG(10, ("recycle: touch_mtime = %s\n", ret
?"True":"False"));
122 static const char **recycle_exclude(vfs_handle_struct
*handle
)
126 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude", NULL
);
128 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp
?*tmp_lp
:""));
133 static const char **recycle_exclude_dir(vfs_handle_struct
*handle
)
137 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude_dir", NULL
);
139 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp
?*tmp_lp
:""));
144 static const char **recycle_noversions(vfs_handle_struct
*handle
)
148 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "noversions", NULL
);
150 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp
?*tmp_lp
:""));
155 static SMB_OFF_T
recycle_maxsize(vfs_handle_struct
*handle
)
159 maxsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
160 "recycle", "maxsize", NULL
));
162 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize
));
167 static SMB_OFF_T
recycle_minsize(vfs_handle_struct
*handle
)
171 minsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
172 "recycle", "minsize", NULL
));
174 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize
));
179 static mode_t
recycle_directory_mode(vfs_handle_struct
*handle
)
184 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "directory_mode", NULL
);
187 sscanf(buff
, "%o", &dirmode
);
189 dirmode
=S_IRUSR
| S_IWUSR
| S_IXUSR
;
192 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode
));
193 return (mode_t
)dirmode
;
196 static mode_t
recycle_subdir_mode(vfs_handle_struct
*handle
)
201 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "subdir_mode", NULL
);
204 sscanf(buff
, "%o", &dirmode
);
206 dirmode
=recycle_directory_mode(handle
);
209 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode
));
210 return (mode_t
)dirmode
;
213 static bool recycle_directory_exist(vfs_handle_struct
*handle
, const char *dname
)
217 if (SMB_VFS_NEXT_STAT(handle
, dname
, &st
) == 0) {
218 if (S_ISDIR(st
.st_mode
)) {
226 static bool recycle_file_exist(vfs_handle_struct
*handle
, const char *fname
)
230 if (SMB_VFS_NEXT_STAT(handle
, fname
, &st
) == 0) {
231 if (S_ISREG(st
.st_mode
)) {
241 * @param conn connection
242 * @param fname file name
243 * @return size in bytes
245 static SMB_OFF_T
recycle_get_file_size(vfs_handle_struct
*handle
, const char *fname
)
249 if (SMB_VFS_NEXT_STAT(handle
, fname
, &st
) != 0) {
250 DEBUG(0,("recycle: stat for %s returned %s\n", fname
, strerror(errno
)));
258 * Create directory tree
259 * @param conn connection
260 * @param dname Directory tree to be created
261 * @return Returns True for success
263 static bool recycle_create_dir(vfs_handle_struct
*handle
, const char *dname
)
267 char *new_dir
= NULL
;
268 char *tmp_str
= NULL
;
274 mode
= recycle_directory_mode(handle
);
276 tmp_str
= SMB_STRDUP(dname
);
277 ALLOC_CHECK(tmp_str
, done
);
280 len
= strlen(dname
)+1;
281 new_dir
= (char *)SMB_MALLOC(len
+ 1);
282 ALLOC_CHECK(new_dir
, done
);
284 if (dname
[0] == '/') {
286 safe_strcat(new_dir
,"/",len
);
289 /* Create directory tree if neccessary */
290 for(token
= strtok_r(tok_str
, "/", &saveptr
); token
;
291 token
= strtok_r(NULL
, "/", &saveptr
)) {
292 safe_strcat(new_dir
, token
, len
);
293 if (recycle_directory_exist(handle
, new_dir
))
294 DEBUG(10, ("recycle: dir %s already exists\n", new_dir
));
296 DEBUG(5, ("recycle: creating new dir %s\n", new_dir
));
297 if (SMB_VFS_NEXT_MKDIR(handle
, new_dir
, mode
) != 0) {
298 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir
, strerror(errno
)));
303 safe_strcat(new_dir
, "/", len
);
304 mode
= recycle_subdir_mode(handle
);
315 * Check if any of the components of "exclude_list" are contained in path.
316 * Return True if found
319 static bool matchdirparam(const char **dir_exclude_list
, char *path
)
321 char *startp
= NULL
, *endp
= NULL
;
323 if (dir_exclude_list
== NULL
|| dir_exclude_list
[0] == NULL
||
324 *dir_exclude_list
[0] == '\0' || path
== NULL
|| *path
== '\0') {
329 * Walk the components of path, looking for matches with the
330 * exclude list on each component.
333 for (startp
= path
; startp
; startp
= endp
) {
336 while (*startp
== '/') {
339 endp
= strchr(startp
, '/');
344 for(i
=0; dir_exclude_list
[i
] ; i
++) {
345 if(unix_wild_match(dir_exclude_list
[i
], startp
)) {
364 * Check if needle is contained in haystack, * and ? patterns are resolved
365 * @param haystack list of parameters separated by delimimiter character
366 * @param needle string to be matched exectly to haystack including pattern matching
367 * @return True if found
369 static bool matchparam(const char **haystack_list
, const char *needle
)
373 if (haystack_list
== NULL
|| haystack_list
[0] == NULL
||
374 *haystack_list
[0] == '\0' || needle
== NULL
|| *needle
== '\0') {
378 for(i
=0; haystack_list
[i
] ; i
++) {
379 if(unix_wild_match(haystack_list
[i
], needle
)) {
388 * Touch access or modify date
390 static void recycle_do_touch(vfs_handle_struct
*handle
, const char *fname
,
394 struct timespec ts
[2];
397 if (SMB_VFS_NEXT_STAT(handle
, fname
, &st
) != 0) {
398 DEBUG(0,("recycle: stat for %s returned %s\n",
399 fname
, strerror(errno
)));
402 ts
[0] = timespec_current(); /* atime */
403 ts
[1] = touch_mtime
? ts
[0] : get_mtimespec(&st
); /* mtime */
406 ret
= SMB_VFS_NEXT_NTIMES(handle
, fname
, ts
);
410 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
411 fname
, strerror(err
)));
415 extern userdom_struct current_user_info
;
418 * Check if file should be recycled
420 static int recycle_unlink(vfs_handle_struct
*handle
, const char *file_name
)
422 connection_struct
*conn
= handle
->conn
;
423 char *path_name
= NULL
;
424 char *temp_name
= NULL
;
425 char *final_name
= NULL
;
427 char *repository
= NULL
;
429 SMB_OFF_T maxsize
, minsize
;
430 SMB_OFF_T file_size
; /* space_avail; */
434 repository
= talloc_sub_advanced(NULL
, lp_servicename(SNUM(conn
)),
435 conn
->server_info
->unix_name
,
437 conn
->server_info
->gid
,
438 conn
->server_info
->sanitized_username
,
439 current_user_info
.domain
,
440 recycle_repository(handle
));
441 ALLOC_CHECK(repository
, done
);
442 /* shouldn't we allow absolute path names here? --metze */
444 trim_char(repository
, '\0', '/');
446 if(!repository
|| *(repository
) == '\0') {
447 DEBUG(3, ("recycle: repository path not set, purging %s...\n", file_name
));
448 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
452 /* we don't recycle the recycle bin... */
453 if (strncmp(file_name
, repository
, strlen(repository
)) == 0) {
454 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
455 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
459 file_size
= recycle_get_file_size(handle
, file_name
);
460 /* it is wrong to purge filenames only because they are empty imho
464 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
465 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
470 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
471 * not greater then maxsize, not the size of the single file, also it is better
472 * to remove older files
474 maxsize
= recycle_maxsize(handle
);
475 if(maxsize
> 0 && file_size
> maxsize
) {
476 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, purging... \n", file_name
));
477 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
480 minsize
= recycle_minsize(handle
);
481 if(minsize
> 0 && file_size
< minsize
) {
482 DEBUG(3, ("recycle: File %s lowers minimum recycle size, purging... \n", file_name
));
483 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
487 /* FIXME: this is wrong: moving files with rename does not change the disk space
490 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
491 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
492 if(space_avail < file_size) {
493 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
494 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
499 /* extract filename and path */
500 base
= strrchr(file_name
, '/');
503 path_name
= SMB_STRDUP("/");
504 ALLOC_CHECK(path_name
, done
);
507 path_name
= SMB_STRDUP(file_name
);
508 ALLOC_CHECK(path_name
, done
);
509 path_name
[base
- file_name
] = '\0';
513 DEBUG(10, ("recycle: fname = %s\n", file_name
)); /* original filename with path */
514 DEBUG(10, ("recycle: fpath = %s\n", path_name
)); /* original path */
515 DEBUG(10, ("recycle: base = %s\n", base
)); /* filename without path */
517 if (matchparam(recycle_exclude(handle
), base
)) {
518 DEBUG(3, ("recycle: file %s is excluded \n", base
));
519 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
523 if (matchdirparam(recycle_exclude_dir(handle
), path_name
)) {
524 DEBUG(3, ("recycle: directory %s is excluded \n", path_name
));
525 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
529 if (recycle_keep_dir_tree(handle
) == True
) {
530 asprintf(&temp_name
, "%s/%s", repository
, path_name
);
532 temp_name
= SMB_STRDUP(repository
);
534 ALLOC_CHECK(temp_name
, done
);
536 exist
= recycle_directory_exist(handle
, temp_name
);
538 DEBUG(10, ("recycle: Directory already exists\n"));
540 DEBUG(10, ("recycle: Creating directory %s\n", temp_name
));
541 if (recycle_create_dir(handle
, temp_name
) == False
) {
542 DEBUG(3, ("recycle: Could not create directory, purging %s...\n", file_name
));
543 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
548 asprintf(&final_name
, "%s/%s", temp_name
, base
);
549 ALLOC_CHECK(final_name
, done
);
550 DEBUG(10, ("recycle: recycled file name: %s\n", final_name
)); /* new filename with path */
552 /* check if we should delete file from recycle bin */
553 if (recycle_file_exist(handle
, final_name
)) {
554 if (recycle_versions(handle
) == False
|| matchparam(recycle_noversions(handle
), base
) == True
) {
555 DEBUG(3, ("recycle: Removing old file %s from recycle bin\n", final_name
));
556 if (SMB_VFS_NEXT_UNLINK(handle
, final_name
) != 0) {
557 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno
)));
562 /* rename file we move to recycle bin */
564 while (recycle_file_exist(handle
, final_name
)) {
565 SAFE_FREE(final_name
);
566 asprintf(&final_name
, "%s/Copy #%d of %s", temp_name
, i
++, base
);
569 DEBUG(10, ("recycle: Moving %s to %s\n", file_name
, final_name
));
570 rc
= SMB_VFS_NEXT_RENAME(handle
, file_name
, final_name
);
572 DEBUG(3, ("recycle: Move error %d (%s), purging file %s (%s)\n", errno
, strerror(errno
), file_name
, final_name
));
573 rc
= SMB_VFS_NEXT_UNLINK(handle
, file_name
);
577 /* touch access date of moved file */
578 if (recycle_touch(handle
) == True
|| recycle_touch_mtime(handle
))
579 recycle_do_touch(handle
, final_name
, recycle_touch_mtime(handle
));
582 SAFE_FREE(path_name
);
583 SAFE_FREE(temp_name
);
584 SAFE_FREE(final_name
);
585 TALLOC_FREE(repository
);
589 NTSTATUS
vfs_recycle_init(void);
590 NTSTATUS
vfs_recycle_init(void)
592 NTSTATUS ret
= smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "recycle", recycle_ops
);
594 if (!NT_STATUS_IS_OK(ret
))
597 vfs_recycle_debug_level
= debug_add_class("recycle");
598 if (vfs_recycle_debug_level
== -1) {
599 vfs_recycle_debug_level
= DBGC_VFS
;
600 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
602 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level
));