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"
30 #include "source3/lib/substitute.h"
32 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
34 static int vfs_recycle_debug_level = DBGC_VFS;
37 #define DBGC_CLASS vfs_recycle_debug_level
39 static const char *recycle_repository(vfs_handle_struct *handle)
41 const char *tmp_str = NULL;
43 tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
45 DEBUG(10, ("recycle: repository = %s\n", tmp_str));
50 static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
54 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
56 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
61 static bool recycle_versions(vfs_handle_struct *handle)
65 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
67 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
72 static bool recycle_touch(vfs_handle_struct *handle)
76 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
78 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
83 static bool recycle_touch_mtime(vfs_handle_struct *handle)
87 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
89 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
94 static const char **recycle_exclude(vfs_handle_struct *handle)
98 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
100 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
105 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
109 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
111 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
116 static const char **recycle_noversions(vfs_handle_struct *handle)
120 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
122 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
127 static off_t recycle_maxsize(vfs_handle_struct *handle)
131 maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
132 "recycle", "maxsize", NULL));
134 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize));
139 static off_t recycle_minsize(vfs_handle_struct *handle)
143 minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
144 "recycle", "minsize", NULL));
146 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
151 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
156 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
159 sscanf(buff, "%o", &dirmode);
161 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
164 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
165 return (mode_t)dirmode;
168 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
173 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
176 sscanf(buff, "%o", &dirmode);
178 dirmode=recycle_directory_mode(handle);
181 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
182 return (mode_t)dirmode;
185 static bool recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
187 struct smb_filename smb_fname = {
188 .base_name = discard_const_p(char, dname)
191 if (SMB_VFS_STAT(handle->conn, &smb_fname) == 0) {
192 if (S_ISDIR(smb_fname.st.st_ex_mode)) {
200 static bool recycle_file_exist(vfs_handle_struct *handle,
201 const struct smb_filename *smb_fname)
203 struct smb_filename *smb_fname_tmp = NULL;
206 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
207 if (smb_fname_tmp == NULL) {
211 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
212 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
217 TALLOC_FREE(smb_fname_tmp);
223 * @param conn connection
224 * @param fname file name
225 * @return size in bytes
227 static off_t recycle_get_file_size(vfs_handle_struct *handle,
228 const struct smb_filename *smb_fname)
230 struct smb_filename *smb_fname_tmp = NULL;
233 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
234 if (smb_fname_tmp == NULL) {
239 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
240 DBG_DEBUG("stat for %s returned %s\n",
241 smb_fname_str_dbg(smb_fname_tmp), strerror(errno));
246 size = smb_fname_tmp->st.st_ex_size;
248 TALLOC_FREE(smb_fname_tmp);
253 * Create directory tree
254 * @param conn connection
255 * @param dname Directory tree to be created
256 * @return Returns True for success
258 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
262 char *new_dir = NULL;
263 char *tmp_str = NULL;
269 mode = recycle_directory_mode(handle);
271 tmp_str = SMB_STRDUP(dname);
272 ALLOC_CHECK(tmp_str, done);
275 len = strlen(dname)+1;
276 new_dir = (char *)SMB_MALLOC(len + 1);
277 ALLOC_CHECK(new_dir, done);
279 if (dname[0] == '/') {
281 if (strlcat(new_dir,"/",len+1) >= len+1) {
286 /* Create directory tree if necessary */
287 for(token = strtok_r(tok_str, "/", &saveptr); token;
288 token = strtok_r(NULL, "/", &saveptr)) {
289 if (strlcat(new_dir, token, len+1) >= len+1) {
292 if (recycle_directory_exist(handle, new_dir))
293 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
295 struct smb_filename *smb_fname = NULL;
298 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
300 smb_fname = synthetic_smb_fname(talloc_tos(),
306 if (smb_fname == NULL) {
310 retval = SMB_VFS_NEXT_MKDIRAT(handle,
311 handle->conn->cwd_fsp,
315 DBG_WARNING("recycle: mkdirat failed "
316 "for %s with error: %s\n",
319 TALLOC_FREE(smb_fname);
323 TALLOC_FREE(smb_fname);
325 if (strlcat(new_dir, "/", len+1) >= len+1) {
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;
423 init_smb_file_time(&ft);
425 status = synthetic_pathref(talloc_tos(),
426 handle->conn->cwd_fsp,
427 smb_fname->base_name,
428 smb_fname->stream_name,
433 if (!NT_STATUS_IS_OK(status)) {
434 DBG_DEBUG("synthetic_pathref for '%s' failed: %s\n",
435 smb_fname_str_dbg(smb_fname), nt_errstr(status));
440 ft.atime = timespec_current();
442 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
445 ret = SMB_VFS_NEXT_FNTIMES(handle, smb_fname_tmp->fsp, &ft);
449 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
450 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
453 TALLOC_FREE(smb_fname_tmp);
457 * Check if file should be recycled
459 static int recycle_unlink_internal(vfs_handle_struct *handle,
460 struct files_struct *dirfsp,
461 const struct smb_filename *smb_fname,
464 const struct loadparm_substitution *lp_sub =
465 loadparm_s3_global_substitution();
466 connection_struct *conn = handle->conn;
467 struct smb_filename *full_fname = NULL;
468 char *path_name = NULL;
469 char *temp_name = NULL;
470 char *final_name = NULL;
471 struct smb_filename *smb_fname_final = NULL;
473 char *repository = NULL;
475 off_t maxsize, minsize;
476 off_t file_size; /* space_avail; */
480 repository = talloc_sub_full(NULL, lp_servicename(talloc_tos(), lp_sub, SNUM(conn)),
481 conn->session_info->unix_info->unix_name,
483 conn->session_info->unix_token->gid,
484 conn->session_info->unix_info->sanitized_username,
485 conn->session_info->info->domain_name,
486 recycle_repository(handle));
487 ALLOC_CHECK(repository, done);
488 /* shouldn't we allow absolute path names here? --metze */
490 trim_char(repository, '\0', '/');
492 if(!repository || *(repository) == '\0') {
493 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
494 smb_fname_str_dbg(smb_fname)));
495 rc = SMB_VFS_NEXT_UNLINKAT(handle,
502 full_fname = full_path_from_dirfsp_atname(talloc_tos(),
505 if (full_fname == NULL) {
509 /* we don't recycle the recycle bin... */
510 if (strncmp(full_fname->base_name, repository,
511 strlen(repository)) == 0) {
512 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
513 rc = SMB_VFS_NEXT_UNLINKAT(handle,
520 file_size = recycle_get_file_size(handle, full_fname);
521 /* it is wrong to purge filenames only because they are empty imho
525 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
526 rc = SMB_VFS_NEXT_UNLINKAT(handle,
534 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
535 * not greater then maxsize, not the size of the single file, also it is better
536 * to remove older files
538 maxsize = recycle_maxsize(handle);
539 if(maxsize > 0 && file_size > maxsize) {
540 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
541 "purging... \n", smb_fname_str_dbg(full_fname)));
542 rc = SMB_VFS_NEXT_UNLINKAT(handle,
548 minsize = recycle_minsize(handle);
549 if(minsize > 0 && file_size < minsize) {
550 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
551 "purging... \n", smb_fname_str_dbg(full_fname)));
552 rc = SMB_VFS_NEXT_UNLINKAT(handle,
559 /* FIXME: this is wrong: moving files with rename does not change the disk space
562 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
563 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
564 if(space_avail < file_size) {
565 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
566 rc = SMB_VFS_NEXT_UNLINKAT(handle,
574 /* extract filename and path */
575 if (!parent_dirname(talloc_tos(), full_fname->base_name, &path_name, &base)) {
581 /* original filename with path */
582 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(full_fname)));
584 DEBUG(10, ("recycle: fpath = %s\n", path_name));
585 /* filename without path */
586 DEBUG(10, ("recycle: base = %s\n", base));
588 if (matchparam(recycle_exclude(handle), base)) {
589 DEBUG(3, ("recycle: file %s is excluded \n", base));
590 rc = SMB_VFS_NEXT_UNLINKAT(handle,
597 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
598 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
599 rc = SMB_VFS_NEXT_UNLINKAT(handle,
606 if (recycle_keep_dir_tree(handle) == True) {
607 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
608 ALLOC_CHECK(temp_name, done);
611 temp_name = SMB_STRDUP(repository);
613 ALLOC_CHECK(temp_name, done);
615 exist = recycle_directory_exist(handle, temp_name);
617 DEBUG(10, ("recycle: Directory already exists\n"));
619 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
620 if (recycle_create_dir(handle, temp_name) == False) {
621 DEBUG(3, ("recycle: Could not create directory, "
623 smb_fname_str_dbg(full_fname)));
624 rc = SMB_VFS_NEXT_UNLINKAT(handle,
632 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
633 ALLOC_CHECK(final_name, done);
636 /* Create smb_fname with final base name and orig stream name. */
637 smb_fname_final = synthetic_smb_fname(talloc_tos(),
639 full_fname->stream_name,
643 if (smb_fname_final == NULL) {
644 rc = SMB_VFS_NEXT_UNLINKAT(handle,
651 /* new filename with path */
652 DEBUG(10, ("recycle: recycled file name: %s\n",
653 smb_fname_str_dbg(smb_fname_final)));
655 /* check if we should delete file from recycle bin */
656 if (recycle_file_exist(handle, smb_fname_final)) {
657 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
658 DEBUG(3, ("recycle: Removing old file %s from recycle "
659 "bin\n", smb_fname_str_dbg(smb_fname_final)));
660 if (SMB_VFS_NEXT_UNLINKAT(handle,
661 dirfsp->conn->cwd_fsp,
664 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
669 /* rename file we move to recycle bin */
671 while (recycle_file_exist(handle, smb_fname_final)) {
672 SAFE_FREE(final_name);
673 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
674 ALLOC_CHECK(final_name, done);
676 TALLOC_FREE(smb_fname_final->base_name);
677 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
679 if (smb_fname_final->base_name == NULL) {
680 rc = SMB_VFS_NEXT_UNLINKAT(handle,
688 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(full_fname),
689 smb_fname_str_dbg(smb_fname_final)));
690 rc = SMB_VFS_NEXT_RENAMEAT(handle,
693 handle->conn->cwd_fsp,
696 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
697 "(%s)\n", errno, strerror(errno),
698 smb_fname_str_dbg(full_fname),
699 smb_fname_str_dbg(smb_fname_final)));
700 rc = SMB_VFS_NEXT_UNLINKAT(handle,
707 /* touch access date of moved file */
708 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
709 recycle_do_touch(handle, smb_fname_final,
710 recycle_touch_mtime(handle));
713 TALLOC_FREE(path_name);
714 SAFE_FREE(temp_name);
715 SAFE_FREE(final_name);
716 TALLOC_FREE(full_fname);
717 TALLOC_FREE(smb_fname_final);
718 TALLOC_FREE(repository);
722 static int recycle_unlinkat(vfs_handle_struct *handle,
723 struct files_struct *dirfsp,
724 const struct smb_filename *smb_fname,
729 if (flags & AT_REMOVEDIR) {
730 ret = SMB_VFS_NEXT_UNLINKAT(handle,
735 ret = recycle_unlink_internal(handle,
743 static struct vfs_fn_pointers vfs_recycle_fns = {
744 .unlinkat_fn = recycle_unlinkat
748 NTSTATUS vfs_recycle_init(TALLOC_CTX *ctx)
750 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
753 if (!NT_STATUS_IS_OK(ret))
756 vfs_recycle_debug_level = debug_add_class("recycle");
757 if (vfs_recycle_debug_level == -1) {
758 vfs_recycle_debug_level = DBGC_VFS;
759 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
761 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));