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 vfs_op_tuple recycle_ops
[] = {
42 {SMB_VFS_OP(recycle_connect
), SMB_VFS_OP_CONNECT
, SMB_VFS_LAYER_TRANSPARENT
},
43 {SMB_VFS_OP(recycle_disconnect
), SMB_VFS_OP_DISCONNECT
, SMB_VFS_LAYER_TRANSPARENT
},
46 {SMB_VFS_OP(recycle_unlink
), SMB_VFS_OP_UNLINK
, SMB_VFS_LAYER_TRANSPARENT
},
48 {SMB_VFS_OP(NULL
), SMB_VFS_OP_NOOP
, SMB_VFS_LAYER_NOOP
}
51 static int recycle_connect(vfs_handle_struct
*handle
, const char *service
, const char *user
)
53 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
56 return SMB_VFS_NEXT_CONNECT(handle
, service
, user
);
59 static void recycle_disconnect(vfs_handle_struct
*handle
)
61 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
62 lp_servicename(SNUM(handle
->conn
))));
64 SMB_VFS_NEXT_DISCONNECT(handle
);
67 static const char *recycle_repository(vfs_handle_struct
*handle
)
69 const char *tmp_str
= NULL
;
72 tmp_str
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "repository",".recycle");
74 DEBUG(10, ("recycle: repository = %s\n", tmp_str
));
79 static bool recycle_keep_dir_tree(vfs_handle_struct
*handle
)
83 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "keeptree", False
);
85 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret
?"True":"False"));
90 static bool recycle_versions(vfs_handle_struct
*handle
)
94 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "versions", False
);
96 DEBUG(10, ("recycle: versions = %s\n", ret
?"True":"False"));
101 static bool recycle_touch(vfs_handle_struct
*handle
)
105 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch", False
);
107 DEBUG(10, ("recycle: touch = %s\n", ret
?"True":"False"));
112 static bool recycle_touch_mtime(vfs_handle_struct
*handle
)
116 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch_mtime", False
);
118 DEBUG(10, ("recycle: touch_mtime = %s\n", ret
?"True":"False"));
123 static const char **recycle_exclude(vfs_handle_struct
*handle
)
127 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude", NULL
);
129 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp
?*tmp_lp
:""));
134 static const char **recycle_exclude_dir(vfs_handle_struct
*handle
)
138 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude_dir", NULL
);
140 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp
?*tmp_lp
:""));
145 static const char **recycle_noversions(vfs_handle_struct
*handle
)
149 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "noversions", NULL
);
151 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp
?*tmp_lp
:""));
156 static SMB_OFF_T
recycle_maxsize(vfs_handle_struct
*handle
)
160 maxsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
161 "recycle", "maxsize", NULL
));
163 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize
));
168 static SMB_OFF_T
recycle_minsize(vfs_handle_struct
*handle
)
172 minsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
173 "recycle", "minsize", NULL
));
175 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize
));
180 static mode_t
recycle_directory_mode(vfs_handle_struct
*handle
)
185 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "directory_mode", NULL
);
188 sscanf(buff
, "%o", &dirmode
);
190 dirmode
=S_IRUSR
| S_IWUSR
| S_IXUSR
;
193 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode
));
194 return (mode_t
)dirmode
;
197 static mode_t
recycle_subdir_mode(vfs_handle_struct
*handle
)
202 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "subdir_mode", NULL
);
205 sscanf(buff
, "%o", &dirmode
);
207 dirmode
=recycle_directory_mode(handle
);
210 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode
));
211 return (mode_t
)dirmode
;
214 static bool recycle_directory_exist(vfs_handle_struct
*handle
, const char *dname
)
218 if (vfs_stat_smb_fname(handle
->conn
, dname
, &st
) == 0) {
219 if (S_ISDIR(st
.st_ex_mode
)) {
227 static bool recycle_file_exist(vfs_handle_struct
*handle
,
228 const struct smb_filename
*smb_fname
)
230 struct smb_filename
*smb_fname_tmp
= NULL
;
234 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
235 if (!NT_STATUS_IS_OK(status
)) {
239 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) == 0) {
240 if (S_ISREG(smb_fname_tmp
->st
.st_ex_mode
)) {
245 TALLOC_FREE(smb_fname_tmp
);
251 * @param conn connection
252 * @param fname file name
253 * @return size in bytes
255 static SMB_OFF_T
recycle_get_file_size(vfs_handle_struct
*handle
,
256 const struct smb_filename
*smb_fname
)
258 struct smb_filename
*smb_fname_tmp
= NULL
;
262 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
263 if (!NT_STATUS_IS_OK(status
)) {
268 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
269 DEBUG(0,("recycle: stat for %s returned %s\n",
270 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
275 size
= smb_fname_tmp
->st
.st_ex_size
;
277 TALLOC_FREE(smb_fname_tmp
);
282 * Create directory tree
283 * @param conn connection
284 * @param dname Directory tree to be created
285 * @return Returns True for success
287 static bool recycle_create_dir(vfs_handle_struct
*handle
, const char *dname
)
291 char *new_dir
= NULL
;
292 char *tmp_str
= NULL
;
298 mode
= recycle_directory_mode(handle
);
300 tmp_str
= SMB_STRDUP(dname
);
301 ALLOC_CHECK(tmp_str
, done
);
304 len
= strlen(dname
)+1;
305 new_dir
= (char *)SMB_MALLOC(len
+ 1);
306 ALLOC_CHECK(new_dir
, done
);
308 if (dname
[0] == '/') {
310 safe_strcat(new_dir
,"/",len
);
313 /* Create directory tree if neccessary */
314 for(token
= strtok_r(tok_str
, "/", &saveptr
); token
;
315 token
= strtok_r(NULL
, "/", &saveptr
)) {
316 safe_strcat(new_dir
, token
, len
);
317 if (recycle_directory_exist(handle
, new_dir
))
318 DEBUG(10, ("recycle: dir %s already exists\n", new_dir
));
320 DEBUG(5, ("recycle: creating new dir %s\n", new_dir
));
321 if (SMB_VFS_NEXT_MKDIR(handle
, new_dir
, mode
) != 0) {
322 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir
, strerror(errno
)));
327 safe_strcat(new_dir
, "/", len
);
328 mode
= recycle_subdir_mode(handle
);
339 * Check if any of the components of "exclude_list" are contained in path.
340 * Return True if found
343 static bool matchdirparam(const char **dir_exclude_list
, char *path
)
345 char *startp
= NULL
, *endp
= NULL
;
347 if (dir_exclude_list
== NULL
|| dir_exclude_list
[0] == NULL
||
348 *dir_exclude_list
[0] == '\0' || path
== NULL
|| *path
== '\0') {
353 * Walk the components of path, looking for matches with the
354 * exclude list on each component.
357 for (startp
= path
; startp
; startp
= endp
) {
360 while (*startp
== '/') {
363 endp
= strchr(startp
, '/');
368 for(i
=0; dir_exclude_list
[i
] ; i
++) {
369 if(unix_wild_match(dir_exclude_list
[i
], startp
)) {
388 * Check if needle is contained in haystack, * and ? patterns are resolved
389 * @param haystack list of parameters separated by delimimiter character
390 * @param needle string to be matched exectly to haystack including pattern matching
391 * @return True if found
393 static bool matchparam(const char **haystack_list
, const char *needle
)
397 if (haystack_list
== NULL
|| haystack_list
[0] == NULL
||
398 *haystack_list
[0] == '\0' || needle
== NULL
|| *needle
== '\0') {
402 for(i
=0; haystack_list
[i
] ; i
++) {
403 if(unix_wild_match(haystack_list
[i
], needle
)) {
412 * Touch access or modify date
414 static void recycle_do_touch(vfs_handle_struct
*handle
,
415 const struct smb_filename
*smb_fname
,
418 struct smb_filename
*smb_fname_tmp
= NULL
;
419 struct smb_file_time ft
;
425 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
426 if (!NT_STATUS_IS_OK(status
)) {
430 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
431 DEBUG(0,("recycle: stat for %s returned %s\n",
432 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
436 ft
.atime
= timespec_current();
438 ft
.mtime
= touch_mtime
? ft
.atime
: smb_fname_tmp
->st
.st_ex_mtime
;
441 ret
= SMB_VFS_NEXT_NTIMES(handle
, smb_fname_tmp
, &ft
);
445 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
446 smb_fname_str_dbg(smb_fname_tmp
), strerror(err
)));
449 TALLOC_FREE(smb_fname_tmp
);
453 * Check if file should be recycled
455 static int recycle_unlink(vfs_handle_struct
*handle
,
456 const struct smb_filename
*smb_fname
)
458 connection_struct
*conn
= handle
->conn
;
459 char *path_name
= NULL
;
460 char *temp_name
= NULL
;
461 char *final_name
= NULL
;
462 struct smb_filename
*smb_fname_final
= NULL
;
464 char *repository
= NULL
;
466 SMB_OFF_T maxsize
, minsize
;
467 SMB_OFF_T file_size
; /* space_avail; */
472 repository
= talloc_sub_advanced(NULL
, lp_servicename(SNUM(conn
)),
473 conn
->server_info
->unix_name
,
475 conn
->server_info
->utok
.gid
,
476 conn
->server_info
->sanitized_username
,
477 pdb_get_domain(conn
->server_info
->sam_account
),
478 recycle_repository(handle
));
479 ALLOC_CHECK(repository
, done
);
480 /* shouldn't we allow absolute path names here? --metze */
482 trim_char(repository
, '\0', '/');
484 if(!repository
|| *(repository
) == '\0') {
485 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
486 smb_fname_str_dbg(smb_fname
)));
487 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
491 /* we don't recycle the recycle bin... */
492 if (strncmp(smb_fname
->base_name
, repository
,
493 strlen(repository
)) == 0) {
494 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
495 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
499 file_size
= recycle_get_file_size(handle
, smb_fname
);
500 /* it is wrong to purge filenames only because they are empty imho
504 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
505 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
510 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
511 * not greater then maxsize, not the size of the single file, also it is better
512 * to remove older files
514 maxsize
= recycle_maxsize(handle
);
515 if(maxsize
> 0 && file_size
> maxsize
) {
516 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
517 "purging... \n", smb_fname_str_dbg(smb_fname
)));
518 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
521 minsize
= recycle_minsize(handle
);
522 if(minsize
> 0 && file_size
< minsize
) {
523 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
524 "purging... \n", smb_fname_str_dbg(smb_fname
)));
525 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
529 /* FIXME: this is wrong: moving files with rename does not change the disk space
532 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
533 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
534 if(space_avail < file_size) {
535 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
536 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
541 /* extract filename and path */
542 base
= strrchr(smb_fname
->base_name
, '/');
544 base
= smb_fname
->base_name
;
545 path_name
= SMB_STRDUP("/");
546 ALLOC_CHECK(path_name
, done
);
549 path_name
= SMB_STRDUP(smb_fname
->base_name
);
550 ALLOC_CHECK(path_name
, done
);
551 path_name
[base
- smb_fname
->base_name
] = '\0';
555 /* original filename with path */
556 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname
)));
558 DEBUG(10, ("recycle: fpath = %s\n", path_name
));
559 /* filename without path */
560 DEBUG(10, ("recycle: base = %s\n", base
));
562 if (matchparam(recycle_exclude(handle
), base
)) {
563 DEBUG(3, ("recycle: file %s is excluded \n", base
));
564 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
568 if (matchdirparam(recycle_exclude_dir(handle
), path_name
)) {
569 DEBUG(3, ("recycle: directory %s is excluded \n", path_name
));
570 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
574 if (recycle_keep_dir_tree(handle
) == True
) {
575 if (asprintf(&temp_name
, "%s/%s", repository
, path_name
) == -1) {
576 ALLOC_CHECK(temp_name
, done
);
579 temp_name
= SMB_STRDUP(repository
);
581 ALLOC_CHECK(temp_name
, done
);
583 exist
= recycle_directory_exist(handle
, temp_name
);
585 DEBUG(10, ("recycle: Directory already exists\n"));
587 DEBUG(10, ("recycle: Creating directory %s\n", temp_name
));
588 if (recycle_create_dir(handle
, temp_name
) == False
) {
589 DEBUG(3, ("recycle: Could not create directory, "
591 smb_fname_str_dbg(smb_fname
)));
592 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
597 if (asprintf(&final_name
, "%s/%s", temp_name
, base
) == -1) {
598 ALLOC_CHECK(final_name
, done
);
601 /* Create smb_fname with final base name and orig stream name. */
602 status
= create_synthetic_smb_fname(talloc_tos(), final_name
,
603 smb_fname
->stream_name
, NULL
,
605 if (!NT_STATUS_IS_OK(status
)) {
606 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
610 /* new filename with path */
611 DEBUG(10, ("recycle: recycled file name: %s\n",
612 smb_fname_str_dbg(smb_fname_final
)));
614 /* check if we should delete file from recycle bin */
615 if (recycle_file_exist(handle
, smb_fname_final
)) {
616 if (recycle_versions(handle
) == False
|| matchparam(recycle_noversions(handle
), base
) == True
) {
617 DEBUG(3, ("recycle: Removing old file %s from recycle "
618 "bin\n", smb_fname_str_dbg(smb_fname_final
)));
619 if (SMB_VFS_NEXT_UNLINK(handle
,
620 smb_fname_final
) != 0) {
621 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno
)));
626 /* rename file we move to recycle bin */
628 while (recycle_file_exist(handle
, smb_fname_final
)) {
629 SAFE_FREE(final_name
);
630 if (asprintf(&final_name
, "%s/Copy #%d of %s", temp_name
, i
++, base
) == -1) {
631 ALLOC_CHECK(final_name
, done
);
633 TALLOC_FREE(smb_fname_final
->base_name
);
634 smb_fname_final
->base_name
= talloc_strdup(smb_fname_final
,
636 if (smb_fname_final
->base_name
== NULL
) {
637 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
642 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname
),
643 smb_fname_str_dbg(smb_fname_final
)));
644 rc
= SMB_VFS_NEXT_RENAME(handle
, smb_fname
, smb_fname_final
);
646 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
647 "(%s)\n", errno
, strerror(errno
),
648 smb_fname_str_dbg(smb_fname
),
649 smb_fname_str_dbg(smb_fname_final
)));
650 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
654 /* touch access date of moved file */
655 if (recycle_touch(handle
) == True
|| recycle_touch_mtime(handle
))
656 recycle_do_touch(handle
, smb_fname_final
,
657 recycle_touch_mtime(handle
));
660 SAFE_FREE(path_name
);
661 SAFE_FREE(temp_name
);
662 SAFE_FREE(final_name
);
663 TALLOC_FREE(smb_fname_final
);
664 TALLOC_FREE(repository
);
668 NTSTATUS
vfs_recycle_init(void);
669 NTSTATUS
vfs_recycle_init(void)
671 NTSTATUS ret
= smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "recycle", recycle_ops
);
673 if (!NT_STATUS_IS_OK(ret
))
676 vfs_recycle_debug_level
= debug_add_class("recycle");
677 if (vfs_recycle_debug_level
== -1) {
678 vfs_recycle_debug_level
= DBGC_VFS
;
679 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
681 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level
));