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/>.
26 #include "smbd/smbd.h"
27 #include "system/filesys.h"
28 #include "../librpc/gen_ndr/ndr_netlogon.h"
31 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
33 static int vfs_recycle_debug_level
= DBGC_VFS
;
36 #define DBGC_CLASS vfs_recycle_debug_level
38 static int recycle_unlink(vfs_handle_struct
*handle
,
39 const struct smb_filename
*smb_fname
);
41 static const char *recycle_repository(vfs_handle_struct
*handle
)
43 const char *tmp_str
= NULL
;
45 tmp_str
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "repository",".recycle");
47 DEBUG(10, ("recycle: repository = %s\n", tmp_str
));
52 static bool recycle_keep_dir_tree(vfs_handle_struct
*handle
)
56 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "keeptree", False
);
58 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret
?"True":"False"));
63 static bool recycle_versions(vfs_handle_struct
*handle
)
67 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "versions", False
);
69 DEBUG(10, ("recycle: versions = %s\n", ret
?"True":"False"));
74 static bool recycle_touch(vfs_handle_struct
*handle
)
78 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch", False
);
80 DEBUG(10, ("recycle: touch = %s\n", ret
?"True":"False"));
85 static bool recycle_touch_mtime(vfs_handle_struct
*handle
)
89 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch_mtime", False
);
91 DEBUG(10, ("recycle: touch_mtime = %s\n", ret
?"True":"False"));
96 static const char **recycle_exclude(vfs_handle_struct
*handle
)
100 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude", NULL
);
102 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp
?*tmp_lp
:""));
107 static const char **recycle_exclude_dir(vfs_handle_struct
*handle
)
111 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude_dir", NULL
);
113 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp
?*tmp_lp
:""));
118 static const char **recycle_noversions(vfs_handle_struct
*handle
)
122 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "noversions", NULL
);
124 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp
?*tmp_lp
:""));
129 static off_t
recycle_maxsize(vfs_handle_struct
*handle
)
133 maxsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
134 "recycle", "maxsize", NULL
));
136 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize
));
141 static off_t
recycle_minsize(vfs_handle_struct
*handle
)
145 minsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
146 "recycle", "minsize", NULL
));
148 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize
));
153 static mode_t
recycle_directory_mode(vfs_handle_struct
*handle
)
158 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "directory_mode", NULL
);
161 sscanf(buff
, "%o", &dirmode
);
163 dirmode
=S_IRUSR
| S_IWUSR
| S_IXUSR
;
166 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode
));
167 return (mode_t
)dirmode
;
170 static mode_t
recycle_subdir_mode(vfs_handle_struct
*handle
)
175 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "subdir_mode", NULL
);
178 sscanf(buff
, "%o", &dirmode
);
180 dirmode
=recycle_directory_mode(handle
);
183 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode
));
184 return (mode_t
)dirmode
;
187 static bool recycle_directory_exist(vfs_handle_struct
*handle
, const char *dname
)
189 struct smb_filename smb_fname
= {
190 .base_name
= discard_const_p(char, dname
)
193 if (SMB_VFS_STAT(handle
->conn
, &smb_fname
) == 0) {
194 if (S_ISDIR(smb_fname
.st
.st_ex_mode
)) {
202 static bool recycle_file_exist(vfs_handle_struct
*handle
,
203 const struct smb_filename
*smb_fname
)
205 struct smb_filename
*smb_fname_tmp
= NULL
;
208 smb_fname_tmp
= cp_smb_filename(talloc_tos(), smb_fname
);
209 if (smb_fname_tmp
== NULL
) {
213 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) == 0) {
214 if (S_ISREG(smb_fname_tmp
->st
.st_ex_mode
)) {
219 TALLOC_FREE(smb_fname_tmp
);
225 * @param conn connection
226 * @param fname file name
227 * @return size in bytes
229 static off_t
recycle_get_file_size(vfs_handle_struct
*handle
,
230 const struct smb_filename
*smb_fname
)
232 struct smb_filename
*smb_fname_tmp
= NULL
;
235 smb_fname_tmp
= cp_smb_filename(talloc_tos(), smb_fname
);
236 if (smb_fname_tmp
== NULL
) {
241 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
242 DEBUG(0,("recycle: stat for %s returned %s\n",
243 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
248 size
= smb_fname_tmp
->st
.st_ex_size
;
250 TALLOC_FREE(smb_fname_tmp
);
255 * Create directory tree
256 * @param conn connection
257 * @param dname Directory tree to be created
258 * @return Returns True for success
260 static bool recycle_create_dir(vfs_handle_struct
*handle
, const char *dname
)
264 char *new_dir
= NULL
;
265 char *tmp_str
= NULL
;
271 mode
= recycle_directory_mode(handle
);
273 tmp_str
= SMB_STRDUP(dname
);
274 ALLOC_CHECK(tmp_str
, done
);
277 len
= strlen(dname
)+1;
278 new_dir
= (char *)SMB_MALLOC(len
+ 1);
279 ALLOC_CHECK(new_dir
, done
);
281 if (dname
[0] == '/') {
283 if (strlcat(new_dir
,"/",len
+1) >= len
+1) {
288 /* Create directory tree if neccessary */
289 for(token
= strtok_r(tok_str
, "/", &saveptr
); token
;
290 token
= strtok_r(NULL
, "/", &saveptr
)) {
291 if (strlcat(new_dir
, token
, len
+1) >= len
+1) {
294 if (recycle_directory_exist(handle
, new_dir
))
295 DEBUG(10, ("recycle: dir %s already exists\n", new_dir
));
297 struct smb_filename
*smb_fname
= NULL
;
300 DEBUG(5, ("recycle: creating new dir %s\n", new_dir
));
302 smb_fname
= synthetic_smb_fname(talloc_tos(),
307 if (smb_fname
== NULL
) {
311 retval
= SMB_VFS_NEXT_MKDIRAT(handle
,
312 handle
->conn
->cwd_fsp
,
316 DBG_WARNING("recycle: mkdirat failed "
317 "for %s with error: %s\n",
320 TALLOC_FREE(smb_fname
);
324 TALLOC_FREE(smb_fname
);
326 if (strlcat(new_dir
, "/", len
+1) >= len
+1) {
329 mode
= recycle_subdir_mode(handle
);
340 * Check if any of the components of "exclude_list" are contained in path.
341 * Return True if found
344 static bool matchdirparam(const char **dir_exclude_list
, char *path
)
346 char *startp
= NULL
, *endp
= NULL
;
348 if (dir_exclude_list
== NULL
|| dir_exclude_list
[0] == NULL
||
349 *dir_exclude_list
[0] == '\0' || path
== NULL
|| *path
== '\0') {
354 * Walk the components of path, looking for matches with the
355 * exclude list on each component.
358 for (startp
= path
; startp
; startp
= endp
) {
361 while (*startp
== '/') {
364 endp
= strchr(startp
, '/');
369 for(i
=0; dir_exclude_list
[i
] ; i
++) {
370 if(unix_wild_match(dir_exclude_list
[i
], startp
)) {
389 * Check if needle is contained in haystack, * and ? patterns are resolved
390 * @param haystack list of parameters separated by delimimiter character
391 * @param needle string to be matched exectly to haystack including pattern matching
392 * @return True if found
394 static bool matchparam(const char **haystack_list
, const char *needle
)
398 if (haystack_list
== NULL
|| haystack_list
[0] == NULL
||
399 *haystack_list
[0] == '\0' || needle
== NULL
|| *needle
== '\0') {
403 for(i
=0; haystack_list
[i
] ; i
++) {
404 if(unix_wild_match(haystack_list
[i
], needle
)) {
413 * Touch access or modify date
415 static void recycle_do_touch(vfs_handle_struct
*handle
,
416 const struct smb_filename
*smb_fname
,
419 struct smb_filename
*smb_fname_tmp
= NULL
;
420 struct smb_file_time ft
;
425 smb_fname_tmp
= cp_smb_filename(talloc_tos(), smb_fname
);
426 if (smb_fname_tmp
== NULL
) {
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 off_t maxsize
, minsize
;
467 off_t file_size
; /* space_avail; */
471 repository
= talloc_sub_advanced(NULL
, lp_servicename(talloc_tos(), SNUM(conn
)),
472 conn
->session_info
->unix_info
->unix_name
,
474 conn
->session_info
->unix_token
->gid
,
475 conn
->session_info
->unix_info
->sanitized_username
,
476 conn
->session_info
->info
->domain_name
,
477 recycle_repository(handle
));
478 ALLOC_CHECK(repository
, done
);
479 /* shouldn't we allow absolute path names here? --metze */
481 trim_char(repository
, '\0', '/');
483 if(!repository
|| *(repository
) == '\0') {
484 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
485 smb_fname_str_dbg(smb_fname
)));
486 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
490 /* we don't recycle the recycle bin... */
491 if (strncmp(smb_fname
->base_name
, repository
,
492 strlen(repository
)) == 0) {
493 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
494 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
498 file_size
= recycle_get_file_size(handle
, smb_fname
);
499 /* it is wrong to purge filenames only because they are empty imho
503 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
504 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
509 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
510 * not greater then maxsize, not the size of the single file, also it is better
511 * to remove older files
513 maxsize
= recycle_maxsize(handle
);
514 if(maxsize
> 0 && file_size
> maxsize
) {
515 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
516 "purging... \n", smb_fname_str_dbg(smb_fname
)));
517 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
520 minsize
= recycle_minsize(handle
);
521 if(minsize
> 0 && file_size
< minsize
) {
522 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
523 "purging... \n", smb_fname_str_dbg(smb_fname
)));
524 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
528 /* FIXME: this is wrong: moving files with rename does not change the disk space
531 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
532 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
533 if(space_avail < file_size) {
534 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
535 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
540 /* extract filename and path */
541 base
= strrchr(smb_fname
->base_name
, '/');
543 base
= smb_fname
->base_name
;
544 path_name
= SMB_STRDUP("/");
545 ALLOC_CHECK(path_name
, done
);
548 path_name
= SMB_STRDUP(smb_fname
->base_name
);
549 ALLOC_CHECK(path_name
, done
);
550 path_name
[base
- smb_fname
->base_name
] = '\0';
554 /* original filename with path */
555 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname
)));
557 DEBUG(10, ("recycle: fpath = %s\n", path_name
));
558 /* filename without path */
559 DEBUG(10, ("recycle: base = %s\n", base
));
561 if (matchparam(recycle_exclude(handle
), base
)) {
562 DEBUG(3, ("recycle: file %s is excluded \n", base
));
563 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
567 if (matchdirparam(recycle_exclude_dir(handle
), path_name
)) {
568 DEBUG(3, ("recycle: directory %s is excluded \n", path_name
));
569 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
573 if (recycle_keep_dir_tree(handle
) == True
) {
574 if (asprintf(&temp_name
, "%s/%s", repository
, path_name
) == -1) {
575 ALLOC_CHECK(temp_name
, done
);
578 temp_name
= SMB_STRDUP(repository
);
580 ALLOC_CHECK(temp_name
, done
);
582 exist
= recycle_directory_exist(handle
, temp_name
);
584 DEBUG(10, ("recycle: Directory already exists\n"));
586 DEBUG(10, ("recycle: Creating directory %s\n", temp_name
));
587 if (recycle_create_dir(handle
, temp_name
) == False
) {
588 DEBUG(3, ("recycle: Could not create directory, "
590 smb_fname_str_dbg(smb_fname
)));
591 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
596 if (asprintf(&final_name
, "%s/%s", temp_name
, base
) == -1) {
597 ALLOC_CHECK(final_name
, done
);
600 /* Create smb_fname with final base name and orig stream name. */
601 smb_fname_final
= synthetic_smb_fname(talloc_tos(),
603 smb_fname
->stream_name
,
606 if (smb_fname_final
== NULL
) {
607 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
611 /* new filename with path */
612 DEBUG(10, ("recycle: recycled file name: %s\n",
613 smb_fname_str_dbg(smb_fname_final
)));
615 /* check if we should delete file from recycle bin */
616 if (recycle_file_exist(handle
, smb_fname_final
)) {
617 if (recycle_versions(handle
) == False
|| matchparam(recycle_noversions(handle
), base
) == True
) {
618 DEBUG(3, ("recycle: Removing old file %s from recycle "
619 "bin\n", smb_fname_str_dbg(smb_fname_final
)));
620 if (SMB_VFS_NEXT_UNLINK(handle
,
621 smb_fname_final
) != 0) {
622 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno
)));
627 /* rename file we move to recycle bin */
629 while (recycle_file_exist(handle
, smb_fname_final
)) {
630 SAFE_FREE(final_name
);
631 if (asprintf(&final_name
, "%s/Copy #%d of %s", temp_name
, i
++, base
) == -1) {
632 ALLOC_CHECK(final_name
, done
);
634 TALLOC_FREE(smb_fname_final
->base_name
);
635 smb_fname_final
->base_name
= talloc_strdup(smb_fname_final
,
637 if (smb_fname_final
->base_name
== NULL
) {
638 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
643 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname
),
644 smb_fname_str_dbg(smb_fname_final
)));
645 rc
= SMB_VFS_NEXT_RENAMEAT(handle
,
646 handle
->conn
->cwd_fsp
,
648 handle
->conn
->cwd_fsp
,
651 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
652 "(%s)\n", errno
, strerror(errno
),
653 smb_fname_str_dbg(smb_fname
),
654 smb_fname_str_dbg(smb_fname_final
)));
655 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
659 /* touch access date of moved file */
660 if (recycle_touch(handle
) == True
|| recycle_touch_mtime(handle
))
661 recycle_do_touch(handle
, smb_fname_final
,
662 recycle_touch_mtime(handle
));
665 SAFE_FREE(path_name
);
666 SAFE_FREE(temp_name
);
667 SAFE_FREE(final_name
);
668 TALLOC_FREE(smb_fname_final
);
669 TALLOC_FREE(repository
);
673 static struct vfs_fn_pointers vfs_recycle_fns
= {
674 .unlink_fn
= recycle_unlink
678 NTSTATUS
vfs_recycle_init(TALLOC_CTX
*ctx
)
680 NTSTATUS ret
= smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "recycle",
683 if (!NT_STATUS_IS_OK(ret
))
686 vfs_recycle_debug_level
= debug_add_class("recycle");
687 if (vfs_recycle_debug_level
== -1) {
688 vfs_recycle_debug_level
= DBGC_VFS
;
689 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
691 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level
));