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
,
37 const struct smb_filename
*smb_fname
);
39 static int recycle_connect(vfs_handle_struct
*handle
, const char *service
, const char *user
)
41 int ret
= SMB_VFS_NEXT_CONNECT(handle
, service
, user
);
47 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
53 static void recycle_disconnect(vfs_handle_struct
*handle
)
55 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
56 lp_servicename(SNUM(handle
->conn
))));
58 SMB_VFS_NEXT_DISCONNECT(handle
);
61 static const char *recycle_repository(vfs_handle_struct
*handle
)
63 const char *tmp_str
= NULL
;
66 tmp_str
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "repository",".recycle");
68 DEBUG(10, ("recycle: repository = %s\n", tmp_str
));
73 static bool recycle_keep_dir_tree(vfs_handle_struct
*handle
)
77 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "keeptree", False
);
79 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret
?"True":"False"));
84 static bool recycle_versions(vfs_handle_struct
*handle
)
88 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "versions", False
);
90 DEBUG(10, ("recycle: versions = %s\n", ret
?"True":"False"));
95 static bool recycle_touch(vfs_handle_struct
*handle
)
99 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch", False
);
101 DEBUG(10, ("recycle: touch = %s\n", ret
?"True":"False"));
106 static bool recycle_touch_mtime(vfs_handle_struct
*handle
)
110 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch_mtime", False
);
112 DEBUG(10, ("recycle: touch_mtime = %s\n", ret
?"True":"False"));
117 static const char **recycle_exclude(vfs_handle_struct
*handle
)
121 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude", NULL
);
123 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp
?*tmp_lp
:""));
128 static const char **recycle_exclude_dir(vfs_handle_struct
*handle
)
132 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude_dir", NULL
);
134 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp
?*tmp_lp
:""));
139 static const char **recycle_noversions(vfs_handle_struct
*handle
)
143 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "noversions", NULL
);
145 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp
?*tmp_lp
:""));
150 static SMB_OFF_T
recycle_maxsize(vfs_handle_struct
*handle
)
154 maxsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
155 "recycle", "maxsize", NULL
));
157 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize
));
162 static SMB_OFF_T
recycle_minsize(vfs_handle_struct
*handle
)
166 minsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
167 "recycle", "minsize", NULL
));
169 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize
));
174 static mode_t
recycle_directory_mode(vfs_handle_struct
*handle
)
179 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "directory_mode", NULL
);
182 sscanf(buff
, "%o", &dirmode
);
184 dirmode
=S_IRUSR
| S_IWUSR
| S_IXUSR
;
187 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode
));
188 return (mode_t
)dirmode
;
191 static mode_t
recycle_subdir_mode(vfs_handle_struct
*handle
)
196 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "subdir_mode", NULL
);
199 sscanf(buff
, "%o", &dirmode
);
201 dirmode
=recycle_directory_mode(handle
);
204 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode
));
205 return (mode_t
)dirmode
;
208 static bool recycle_directory_exist(vfs_handle_struct
*handle
, const char *dname
)
212 if (vfs_stat_smb_fname(handle
->conn
, dname
, &st
) == 0) {
213 if (S_ISDIR(st
.st_ex_mode
)) {
221 static bool recycle_file_exist(vfs_handle_struct
*handle
,
222 const struct smb_filename
*smb_fname
)
224 struct smb_filename
*smb_fname_tmp
= NULL
;
228 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
229 if (!NT_STATUS_IS_OK(status
)) {
233 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) == 0) {
234 if (S_ISREG(smb_fname_tmp
->st
.st_ex_mode
)) {
239 TALLOC_FREE(smb_fname_tmp
);
245 * @param conn connection
246 * @param fname file name
247 * @return size in bytes
249 static SMB_OFF_T
recycle_get_file_size(vfs_handle_struct
*handle
,
250 const struct smb_filename
*smb_fname
)
252 struct smb_filename
*smb_fname_tmp
= NULL
;
256 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
257 if (!NT_STATUS_IS_OK(status
)) {
262 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
263 DEBUG(0,("recycle: stat for %s returned %s\n",
264 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
269 size
= smb_fname_tmp
->st
.st_ex_size
;
271 TALLOC_FREE(smb_fname_tmp
);
276 * Create directory tree
277 * @param conn connection
278 * @param dname Directory tree to be created
279 * @return Returns True for success
281 static bool recycle_create_dir(vfs_handle_struct
*handle
, const char *dname
)
285 char *new_dir
= NULL
;
286 char *tmp_str
= NULL
;
292 mode
= recycle_directory_mode(handle
);
294 tmp_str
= SMB_STRDUP(dname
);
295 ALLOC_CHECK(tmp_str
, done
);
298 len
= strlen(dname
)+1;
299 new_dir
= (char *)SMB_MALLOC(len
+ 1);
300 ALLOC_CHECK(new_dir
, done
);
302 if (dname
[0] == '/') {
304 safe_strcat(new_dir
,"/",len
);
307 /* Create directory tree if neccessary */
308 for(token
= strtok_r(tok_str
, "/", &saveptr
); token
;
309 token
= strtok_r(NULL
, "/", &saveptr
)) {
310 safe_strcat(new_dir
, token
, len
);
311 if (recycle_directory_exist(handle
, new_dir
))
312 DEBUG(10, ("recycle: dir %s already exists\n", new_dir
));
314 DEBUG(5, ("recycle: creating new dir %s\n", new_dir
));
315 if (SMB_VFS_NEXT_MKDIR(handle
, new_dir
, mode
) != 0) {
316 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir
, strerror(errno
)));
321 safe_strcat(new_dir
, "/", len
);
322 mode
= recycle_subdir_mode(handle
);
333 * Check if any of the components of "exclude_list" are contained in path.
334 * Return True if found
337 static bool matchdirparam(const char **dir_exclude_list
, char *path
)
339 char *startp
= NULL
, *endp
= NULL
;
341 if (dir_exclude_list
== NULL
|| dir_exclude_list
[0] == NULL
||
342 *dir_exclude_list
[0] == '\0' || path
== NULL
|| *path
== '\0') {
347 * Walk the components of path, looking for matches with the
348 * exclude list on each component.
351 for (startp
= path
; startp
; startp
= endp
) {
354 while (*startp
== '/') {
357 endp
= strchr(startp
, '/');
362 for(i
=0; dir_exclude_list
[i
] ; i
++) {
363 if(unix_wild_match(dir_exclude_list
[i
], startp
)) {
382 * Check if needle is contained in haystack, * and ? patterns are resolved
383 * @param haystack list of parameters separated by delimimiter character
384 * @param needle string to be matched exectly to haystack including pattern matching
385 * @return True if found
387 static bool matchparam(const char **haystack_list
, const char *needle
)
391 if (haystack_list
== NULL
|| haystack_list
[0] == NULL
||
392 *haystack_list
[0] == '\0' || needle
== NULL
|| *needle
== '\0') {
396 for(i
=0; haystack_list
[i
] ; i
++) {
397 if(unix_wild_match(haystack_list
[i
], needle
)) {
406 * Touch access or modify date
408 static void recycle_do_touch(vfs_handle_struct
*handle
,
409 const struct smb_filename
*smb_fname
,
412 struct smb_filename
*smb_fname_tmp
= NULL
;
413 struct smb_file_time ft
;
419 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
420 if (!NT_STATUS_IS_OK(status
)) {
424 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
425 DEBUG(0,("recycle: stat for %s returned %s\n",
426 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
430 ft
.atime
= timespec_current();
432 ft
.mtime
= touch_mtime
? ft
.atime
: smb_fname_tmp
->st
.st_ex_mtime
;
435 ret
= SMB_VFS_NEXT_NTIMES(handle
, smb_fname_tmp
, &ft
);
439 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
440 smb_fname_str_dbg(smb_fname_tmp
), strerror(err
)));
443 TALLOC_FREE(smb_fname_tmp
);
447 * Check if file should be recycled
449 static int recycle_unlink(vfs_handle_struct
*handle
,
450 const struct smb_filename
*smb_fname
)
452 connection_struct
*conn
= handle
->conn
;
453 char *path_name
= NULL
;
454 char *temp_name
= NULL
;
455 char *final_name
= NULL
;
456 struct smb_filename
*smb_fname_final
= NULL
;
458 char *repository
= NULL
;
460 SMB_OFF_T maxsize
, minsize
;
461 SMB_OFF_T file_size
; /* space_avail; */
466 repository
= talloc_sub_advanced(NULL
, lp_servicename(SNUM(conn
)),
467 conn
->server_info
->unix_name
,
469 conn
->server_info
->utok
.gid
,
470 conn
->server_info
->sanitized_username
,
471 pdb_get_domain(conn
->server_info
->sam_account
),
472 recycle_repository(handle
));
473 ALLOC_CHECK(repository
, done
);
474 /* shouldn't we allow absolute path names here? --metze */
476 trim_char(repository
, '\0', '/');
478 if(!repository
|| *(repository
) == '\0') {
479 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
480 smb_fname_str_dbg(smb_fname
)));
481 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
485 /* we don't recycle the recycle bin... */
486 if (strncmp(smb_fname
->base_name
, repository
,
487 strlen(repository
)) == 0) {
488 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
489 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
493 file_size
= recycle_get_file_size(handle
, smb_fname
);
494 /* it is wrong to purge filenames only because they are empty imho
498 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
499 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
504 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
505 * not greater then maxsize, not the size of the single file, also it is better
506 * to remove older files
508 maxsize
= recycle_maxsize(handle
);
509 if(maxsize
> 0 && file_size
> maxsize
) {
510 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
511 "purging... \n", smb_fname_str_dbg(smb_fname
)));
512 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
515 minsize
= recycle_minsize(handle
);
516 if(minsize
> 0 && file_size
< minsize
) {
517 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
518 "purging... \n", smb_fname_str_dbg(smb_fname
)));
519 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
523 /* FIXME: this is wrong: moving files with rename does not change the disk space
526 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
527 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
528 if(space_avail < file_size) {
529 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
530 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
535 /* extract filename and path */
536 base
= strrchr(smb_fname
->base_name
, '/');
538 base
= smb_fname
->base_name
;
539 path_name
= SMB_STRDUP("/");
540 ALLOC_CHECK(path_name
, done
);
543 path_name
= SMB_STRDUP(smb_fname
->base_name
);
544 ALLOC_CHECK(path_name
, done
);
545 path_name
[base
- smb_fname
->base_name
] = '\0';
549 /* original filename with path */
550 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname
)));
552 DEBUG(10, ("recycle: fpath = %s\n", path_name
));
553 /* filename without path */
554 DEBUG(10, ("recycle: base = %s\n", base
));
556 if (matchparam(recycle_exclude(handle
), base
)) {
557 DEBUG(3, ("recycle: file %s is excluded \n", base
));
558 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
562 if (matchdirparam(recycle_exclude_dir(handle
), path_name
)) {
563 DEBUG(3, ("recycle: directory %s is excluded \n", path_name
));
564 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
568 if (recycle_keep_dir_tree(handle
) == True
) {
569 if (asprintf(&temp_name
, "%s/%s", repository
, path_name
) == -1) {
570 ALLOC_CHECK(temp_name
, done
);
573 temp_name
= SMB_STRDUP(repository
);
575 ALLOC_CHECK(temp_name
, done
);
577 exist
= recycle_directory_exist(handle
, temp_name
);
579 DEBUG(10, ("recycle: Directory already exists\n"));
581 DEBUG(10, ("recycle: Creating directory %s\n", temp_name
));
582 if (recycle_create_dir(handle
, temp_name
) == False
) {
583 DEBUG(3, ("recycle: Could not create directory, "
585 smb_fname_str_dbg(smb_fname
)));
586 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
591 if (asprintf(&final_name
, "%s/%s", temp_name
, base
) == -1) {
592 ALLOC_CHECK(final_name
, done
);
595 /* Create smb_fname with final base name and orig stream name. */
596 status
= create_synthetic_smb_fname(talloc_tos(), final_name
,
597 smb_fname
->stream_name
, NULL
,
599 if (!NT_STATUS_IS_OK(status
)) {
600 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
604 /* new filename with path */
605 DEBUG(10, ("recycle: recycled file name: %s\n",
606 smb_fname_str_dbg(smb_fname_final
)));
608 /* check if we should delete file from recycle bin */
609 if (recycle_file_exist(handle
, smb_fname_final
)) {
610 if (recycle_versions(handle
) == False
|| matchparam(recycle_noversions(handle
), base
) == True
) {
611 DEBUG(3, ("recycle: Removing old file %s from recycle "
612 "bin\n", smb_fname_str_dbg(smb_fname_final
)));
613 if (SMB_VFS_NEXT_UNLINK(handle
,
614 smb_fname_final
) != 0) {
615 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno
)));
620 /* rename file we move to recycle bin */
622 while (recycle_file_exist(handle
, smb_fname_final
)) {
623 SAFE_FREE(final_name
);
624 if (asprintf(&final_name
, "%s/Copy #%d of %s", temp_name
, i
++, base
) == -1) {
625 ALLOC_CHECK(final_name
, done
);
627 TALLOC_FREE(smb_fname_final
->base_name
);
628 smb_fname_final
->base_name
= talloc_strdup(smb_fname_final
,
630 if (smb_fname_final
->base_name
== NULL
) {
631 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
636 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname
),
637 smb_fname_str_dbg(smb_fname_final
)));
638 rc
= SMB_VFS_NEXT_RENAME(handle
, smb_fname
, smb_fname_final
);
640 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
641 "(%s)\n", errno
, strerror(errno
),
642 smb_fname_str_dbg(smb_fname
),
643 smb_fname_str_dbg(smb_fname_final
)));
644 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
648 /* touch access date of moved file */
649 if (recycle_touch(handle
) == True
|| recycle_touch_mtime(handle
))
650 recycle_do_touch(handle
, smb_fname_final
,
651 recycle_touch_mtime(handle
));
654 SAFE_FREE(path_name
);
655 SAFE_FREE(temp_name
);
656 SAFE_FREE(final_name
);
657 TALLOC_FREE(smb_fname_final
);
658 TALLOC_FREE(repository
);
662 static struct vfs_fn_pointers vfs_recycle_fns
= {
663 .connect_fn
= recycle_connect
,
664 .disconnect
= recycle_disconnect
,
665 .unlink
= recycle_unlink
668 NTSTATUS
vfs_recycle_init(void);
669 NTSTATUS
vfs_recycle_init(void)
671 NTSTATUS ret
= smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "recycle",
674 if (!NT_STATUS_IS_OK(ret
))
677 vfs_recycle_debug_level
= debug_add_class("recycle");
678 if (vfs_recycle_debug_level
== -1) {
679 vfs_recycle_debug_level
= DBGC_VFS
;
680 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
682 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level
));