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 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
44 return SMB_VFS_NEXT_CONNECT(handle
, service
, user
);
47 static void recycle_disconnect(vfs_handle_struct
*handle
)
49 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
50 lp_servicename(SNUM(handle
->conn
))));
52 SMB_VFS_NEXT_DISCONNECT(handle
);
55 static const char *recycle_repository(vfs_handle_struct
*handle
)
57 const char *tmp_str
= NULL
;
60 tmp_str
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "repository",".recycle");
62 DEBUG(10, ("recycle: repository = %s\n", tmp_str
));
67 static bool recycle_keep_dir_tree(vfs_handle_struct
*handle
)
71 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "keeptree", False
);
73 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret
?"True":"False"));
78 static bool recycle_versions(vfs_handle_struct
*handle
)
82 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "versions", False
);
84 DEBUG(10, ("recycle: versions = %s\n", ret
?"True":"False"));
89 static bool recycle_touch(vfs_handle_struct
*handle
)
93 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch", False
);
95 DEBUG(10, ("recycle: touch = %s\n", ret
?"True":"False"));
100 static bool recycle_touch_mtime(vfs_handle_struct
*handle
)
104 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch_mtime", False
);
106 DEBUG(10, ("recycle: touch_mtime = %s\n", ret
?"True":"False"));
111 static const char **recycle_exclude(vfs_handle_struct
*handle
)
115 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude", NULL
);
117 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp
?*tmp_lp
:""));
122 static const char **recycle_exclude_dir(vfs_handle_struct
*handle
)
126 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude_dir", NULL
);
128 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp
?*tmp_lp
:""));
133 static const char **recycle_noversions(vfs_handle_struct
*handle
)
137 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "noversions", NULL
);
139 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp
?*tmp_lp
:""));
144 static SMB_OFF_T
recycle_maxsize(vfs_handle_struct
*handle
)
148 maxsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
149 "recycle", "maxsize", NULL
));
151 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize
));
156 static SMB_OFF_T
recycle_minsize(vfs_handle_struct
*handle
)
160 minsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
161 "recycle", "minsize", NULL
));
163 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize
));
168 static mode_t
recycle_directory_mode(vfs_handle_struct
*handle
)
173 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "directory_mode", NULL
);
176 sscanf(buff
, "%o", &dirmode
);
178 dirmode
=S_IRUSR
| S_IWUSR
| S_IXUSR
;
181 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode
));
182 return (mode_t
)dirmode
;
185 static mode_t
recycle_subdir_mode(vfs_handle_struct
*handle
)
190 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "subdir_mode", NULL
);
193 sscanf(buff
, "%o", &dirmode
);
195 dirmode
=recycle_directory_mode(handle
);
198 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode
));
199 return (mode_t
)dirmode
;
202 static bool recycle_directory_exist(vfs_handle_struct
*handle
, const char *dname
)
206 if (vfs_stat_smb_fname(handle
->conn
, dname
, &st
) == 0) {
207 if (S_ISDIR(st
.st_ex_mode
)) {
215 static bool recycle_file_exist(vfs_handle_struct
*handle
,
216 const struct smb_filename
*smb_fname
)
218 struct smb_filename
*smb_fname_tmp
= NULL
;
222 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
223 if (!NT_STATUS_IS_OK(status
)) {
227 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) == 0) {
228 if (S_ISREG(smb_fname_tmp
->st
.st_ex_mode
)) {
233 TALLOC_FREE(smb_fname_tmp
);
239 * @param conn connection
240 * @param fname file name
241 * @return size in bytes
243 static SMB_OFF_T
recycle_get_file_size(vfs_handle_struct
*handle
,
244 const struct smb_filename
*smb_fname
)
246 struct smb_filename
*smb_fname_tmp
= NULL
;
250 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
251 if (!NT_STATUS_IS_OK(status
)) {
256 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
257 DEBUG(0,("recycle: stat for %s returned %s\n",
258 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
263 size
= smb_fname_tmp
->st
.st_ex_size
;
265 TALLOC_FREE(smb_fname_tmp
);
270 * Create directory tree
271 * @param conn connection
272 * @param dname Directory tree to be created
273 * @return Returns True for success
275 static bool recycle_create_dir(vfs_handle_struct
*handle
, const char *dname
)
279 char *new_dir
= NULL
;
280 char *tmp_str
= NULL
;
286 mode
= recycle_directory_mode(handle
);
288 tmp_str
= SMB_STRDUP(dname
);
289 ALLOC_CHECK(tmp_str
, done
);
292 len
= strlen(dname
)+1;
293 new_dir
= (char *)SMB_MALLOC(len
+ 1);
294 ALLOC_CHECK(new_dir
, done
);
296 if (dname
[0] == '/') {
298 safe_strcat(new_dir
,"/",len
);
301 /* Create directory tree if neccessary */
302 for(token
= strtok_r(tok_str
, "/", &saveptr
); token
;
303 token
= strtok_r(NULL
, "/", &saveptr
)) {
304 safe_strcat(new_dir
, token
, len
);
305 if (recycle_directory_exist(handle
, new_dir
))
306 DEBUG(10, ("recycle: dir %s already exists\n", new_dir
));
308 DEBUG(5, ("recycle: creating new dir %s\n", new_dir
));
309 if (SMB_VFS_NEXT_MKDIR(handle
, new_dir
, mode
) != 0) {
310 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir
, strerror(errno
)));
315 safe_strcat(new_dir
, "/", len
);
316 mode
= recycle_subdir_mode(handle
);
327 * Check if any of the components of "exclude_list" are contained in path.
328 * Return True if found
331 static bool matchdirparam(const char **dir_exclude_list
, char *path
)
333 char *startp
= NULL
, *endp
= NULL
;
335 if (dir_exclude_list
== NULL
|| dir_exclude_list
[0] == NULL
||
336 *dir_exclude_list
[0] == '\0' || path
== NULL
|| *path
== '\0') {
341 * Walk the components of path, looking for matches with the
342 * exclude list on each component.
345 for (startp
= path
; startp
; startp
= endp
) {
348 while (*startp
== '/') {
351 endp
= strchr(startp
, '/');
356 for(i
=0; dir_exclude_list
[i
] ; i
++) {
357 if(unix_wild_match(dir_exclude_list
[i
], startp
)) {
376 * Check if needle is contained in haystack, * and ? patterns are resolved
377 * @param haystack list of parameters separated by delimimiter character
378 * @param needle string to be matched exectly to haystack including pattern matching
379 * @return True if found
381 static bool matchparam(const char **haystack_list
, const char *needle
)
385 if (haystack_list
== NULL
|| haystack_list
[0] == NULL
||
386 *haystack_list
[0] == '\0' || needle
== NULL
|| *needle
== '\0') {
390 for(i
=0; haystack_list
[i
] ; i
++) {
391 if(unix_wild_match(haystack_list
[i
], needle
)) {
400 * Touch access or modify date
402 static void recycle_do_touch(vfs_handle_struct
*handle
,
403 const struct smb_filename
*smb_fname
,
406 struct smb_filename
*smb_fname_tmp
= NULL
;
407 struct smb_file_time ft
;
413 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
414 if (!NT_STATUS_IS_OK(status
)) {
418 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
419 DEBUG(0,("recycle: stat for %s returned %s\n",
420 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
424 ft
.atime
= timespec_current();
426 ft
.mtime
= touch_mtime
? ft
.atime
: smb_fname_tmp
->st
.st_ex_mtime
;
429 ret
= SMB_VFS_NEXT_NTIMES(handle
, smb_fname_tmp
, &ft
);
433 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
434 smb_fname_str_dbg(smb_fname_tmp
), strerror(err
)));
437 TALLOC_FREE(smb_fname_tmp
);
441 * Check if file should be recycled
443 static int recycle_unlink(vfs_handle_struct
*handle
,
444 const struct smb_filename
*smb_fname
)
446 connection_struct
*conn
= handle
->conn
;
447 char *path_name
= NULL
;
448 char *temp_name
= NULL
;
449 char *final_name
= NULL
;
450 struct smb_filename
*smb_fname_final
= NULL
;
452 char *repository
= NULL
;
454 SMB_OFF_T maxsize
, minsize
;
455 SMB_OFF_T file_size
; /* space_avail; */
460 repository
= talloc_sub_advanced(NULL
, lp_servicename(SNUM(conn
)),
461 conn
->server_info
->unix_name
,
463 conn
->server_info
->utok
.gid
,
464 conn
->server_info
->sanitized_username
,
465 pdb_get_domain(conn
->server_info
->sam_account
),
466 recycle_repository(handle
));
467 ALLOC_CHECK(repository
, done
);
468 /* shouldn't we allow absolute path names here? --metze */
470 trim_char(repository
, '\0', '/');
472 if(!repository
|| *(repository
) == '\0') {
473 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
474 smb_fname_str_dbg(smb_fname
)));
475 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
479 /* we don't recycle the recycle bin... */
480 if (strncmp(smb_fname
->base_name
, repository
,
481 strlen(repository
)) == 0) {
482 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
483 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
487 file_size
= recycle_get_file_size(handle
, smb_fname
);
488 /* it is wrong to purge filenames only because they are empty imho
492 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
493 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
498 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
499 * not greater then maxsize, not the size of the single file, also it is better
500 * to remove older files
502 maxsize
= recycle_maxsize(handle
);
503 if(maxsize
> 0 && file_size
> maxsize
) {
504 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
505 "purging... \n", smb_fname_str_dbg(smb_fname
)));
506 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
509 minsize
= recycle_minsize(handle
);
510 if(minsize
> 0 && file_size
< minsize
) {
511 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
512 "purging... \n", smb_fname_str_dbg(smb_fname
)));
513 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
517 /* FIXME: this is wrong: moving files with rename does not change the disk space
520 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
521 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
522 if(space_avail < file_size) {
523 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
524 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
529 /* extract filename and path */
530 base
= strrchr(smb_fname
->base_name
, '/');
532 base
= smb_fname
->base_name
;
533 path_name
= SMB_STRDUP("/");
534 ALLOC_CHECK(path_name
, done
);
537 path_name
= SMB_STRDUP(smb_fname
->base_name
);
538 ALLOC_CHECK(path_name
, done
);
539 path_name
[base
- smb_fname
->base_name
] = '\0';
543 /* original filename with path */
544 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname
)));
546 DEBUG(10, ("recycle: fpath = %s\n", path_name
));
547 /* filename without path */
548 DEBUG(10, ("recycle: base = %s\n", base
));
550 if (matchparam(recycle_exclude(handle
), base
)) {
551 DEBUG(3, ("recycle: file %s is excluded \n", base
));
552 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
556 if (matchdirparam(recycle_exclude_dir(handle
), path_name
)) {
557 DEBUG(3, ("recycle: directory %s is excluded \n", path_name
));
558 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
562 if (recycle_keep_dir_tree(handle
) == True
) {
563 if (asprintf(&temp_name
, "%s/%s", repository
, path_name
) == -1) {
564 ALLOC_CHECK(temp_name
, done
);
567 temp_name
= SMB_STRDUP(repository
);
569 ALLOC_CHECK(temp_name
, done
);
571 exist
= recycle_directory_exist(handle
, temp_name
);
573 DEBUG(10, ("recycle: Directory already exists\n"));
575 DEBUG(10, ("recycle: Creating directory %s\n", temp_name
));
576 if (recycle_create_dir(handle
, temp_name
) == False
) {
577 DEBUG(3, ("recycle: Could not create directory, "
579 smb_fname_str_dbg(smb_fname
)));
580 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
585 if (asprintf(&final_name
, "%s/%s", temp_name
, base
) == -1) {
586 ALLOC_CHECK(final_name
, done
);
589 /* Create smb_fname with final base name and orig stream name. */
590 status
= create_synthetic_smb_fname(talloc_tos(), final_name
,
591 smb_fname
->stream_name
, NULL
,
593 if (!NT_STATUS_IS_OK(status
)) {
594 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
598 /* new filename with path */
599 DEBUG(10, ("recycle: recycled file name: %s\n",
600 smb_fname_str_dbg(smb_fname_final
)));
602 /* check if we should delete file from recycle bin */
603 if (recycle_file_exist(handle
, smb_fname_final
)) {
604 if (recycle_versions(handle
) == False
|| matchparam(recycle_noversions(handle
), base
) == True
) {
605 DEBUG(3, ("recycle: Removing old file %s from recycle "
606 "bin\n", smb_fname_str_dbg(smb_fname_final
)));
607 if (SMB_VFS_NEXT_UNLINK(handle
,
608 smb_fname_final
) != 0) {
609 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno
)));
614 /* rename file we move to recycle bin */
616 while (recycle_file_exist(handle
, smb_fname_final
)) {
617 SAFE_FREE(final_name
);
618 if (asprintf(&final_name
, "%s/Copy #%d of %s", temp_name
, i
++, base
) == -1) {
619 ALLOC_CHECK(final_name
, done
);
621 TALLOC_FREE(smb_fname_final
->base_name
);
622 smb_fname_final
->base_name
= talloc_strdup(smb_fname_final
,
624 if (smb_fname_final
->base_name
== NULL
) {
625 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
630 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname
),
631 smb_fname_str_dbg(smb_fname_final
)));
632 rc
= SMB_VFS_NEXT_RENAME(handle
, smb_fname
, smb_fname_final
);
634 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
635 "(%s)\n", errno
, strerror(errno
),
636 smb_fname_str_dbg(smb_fname
),
637 smb_fname_str_dbg(smb_fname_final
)));
638 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
642 /* touch access date of moved file */
643 if (recycle_touch(handle
) == True
|| recycle_touch_mtime(handle
))
644 recycle_do_touch(handle
, smb_fname_final
,
645 recycle_touch_mtime(handle
));
648 SAFE_FREE(path_name
);
649 SAFE_FREE(temp_name
);
650 SAFE_FREE(final_name
);
651 TALLOC_FREE(smb_fname_final
);
652 TALLOC_FREE(repository
);
656 static struct vfs_fn_pointers vfs_recycle_fns
= {
657 .connect_fn
= recycle_connect
,
658 .disconnect
= recycle_disconnect
,
659 .unlink
= recycle_unlink
662 NTSTATUS
vfs_recycle_init(void);
663 NTSTATUS
vfs_recycle_init(void)
665 NTSTATUS ret
= smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "recycle",
668 if (!NT_STATUS_IS_OK(ret
))
671 vfs_recycle_debug_level
= debug_add_class("recycle");
672 if (vfs_recycle_debug_level
== -1) {
673 vfs_recycle_debug_level
= DBGC_VFS
;
674 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
676 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level
));