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 const char *recycle_repository(vfs_handle_struct *handle)
40 const char *tmp_str = NULL;
42 tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
44 DEBUG(10, ("recycle: repository = %s\n", tmp_str));
49 static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
53 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
55 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
60 static bool recycle_versions(vfs_handle_struct *handle)
64 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
66 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
71 static bool recycle_touch(vfs_handle_struct *handle)
75 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
77 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
82 static bool recycle_touch_mtime(vfs_handle_struct *handle)
86 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
88 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
93 static const char **recycle_exclude(vfs_handle_struct *handle)
97 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
99 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
104 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
108 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
110 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
115 static const char **recycle_noversions(vfs_handle_struct *handle)
119 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
121 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
126 static off_t recycle_maxsize(vfs_handle_struct *handle)
130 maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
131 "recycle", "maxsize", NULL));
133 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize));
138 static off_t recycle_minsize(vfs_handle_struct *handle)
142 minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
143 "recycle", "minsize", NULL));
145 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
150 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
155 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
158 sscanf(buff, "%o", &dirmode);
160 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
163 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
164 return (mode_t)dirmode;
167 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
172 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
175 sscanf(buff, "%o", &dirmode);
177 dirmode=recycle_directory_mode(handle);
180 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
181 return (mode_t)dirmode;
184 static bool recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
186 struct smb_filename smb_fname = {
187 .base_name = discard_const_p(char, dname)
190 if (SMB_VFS_STAT(handle->conn, &smb_fname) == 0) {
191 if (S_ISDIR(smb_fname.st.st_ex_mode)) {
199 static bool recycle_file_exist(vfs_handle_struct *handle,
200 const struct smb_filename *smb_fname)
202 struct smb_filename *smb_fname_tmp = NULL;
205 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
206 if (smb_fname_tmp == NULL) {
210 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
211 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
216 TALLOC_FREE(smb_fname_tmp);
222 * @param conn connection
223 * @param fname file name
224 * @return size in bytes
226 static off_t recycle_get_file_size(vfs_handle_struct *handle,
227 const struct smb_filename *smb_fname)
229 struct smb_filename *smb_fname_tmp = NULL;
232 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
233 if (smb_fname_tmp == NULL) {
238 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
239 DBG_DEBUG("stat for %s returned %s\n",
240 smb_fname_str_dbg(smb_fname_tmp), strerror(errno));
245 size = smb_fname_tmp->st.st_ex_size;
247 TALLOC_FREE(smb_fname_tmp);
252 * Create directory tree
253 * @param conn connection
254 * @param dname Directory tree to be created
255 * @return Returns True for success
257 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
261 char *new_dir = NULL;
262 char *tmp_str = NULL;
268 mode = recycle_directory_mode(handle);
270 tmp_str = SMB_STRDUP(dname);
271 ALLOC_CHECK(tmp_str, done);
274 len = strlen(dname)+1;
275 new_dir = (char *)SMB_MALLOC(len + 1);
276 ALLOC_CHECK(new_dir, done);
278 if (dname[0] == '/') {
280 if (strlcat(new_dir,"/",len+1) >= len+1) {
285 /* Create directory tree if necessary */
286 for(token = strtok_r(tok_str, "/", &saveptr); token;
287 token = strtok_r(NULL, "/", &saveptr)) {
288 if (strlcat(new_dir, token, len+1) >= len+1) {
291 if (recycle_directory_exist(handle, new_dir))
292 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
294 struct smb_filename *smb_fname = NULL;
297 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
299 smb_fname = synthetic_smb_fname(talloc_tos(),
305 if (smb_fname == NULL) {
309 retval = SMB_VFS_NEXT_MKDIRAT(handle,
310 handle->conn->cwd_fsp,
314 DBG_WARNING("recycle: mkdirat failed "
315 "for %s with error: %s\n",
318 TALLOC_FREE(smb_fname);
322 TALLOC_FREE(smb_fname);
324 if (strlcat(new_dir, "/", len+1) >= len+1) {
327 mode = recycle_subdir_mode(handle);
338 * Check if any of the components of "exclude_list" are contained in path.
339 * Return True if found
342 static bool matchdirparam(const char **dir_exclude_list, char *path)
344 char *startp = NULL, *endp = NULL;
346 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
347 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
352 * Walk the components of path, looking for matches with the
353 * exclude list on each component.
356 for (startp = path; startp; startp = endp) {
359 while (*startp == '/') {
362 endp = strchr(startp, '/');
367 for(i=0; dir_exclude_list[i] ; i++) {
368 if(unix_wild_match(dir_exclude_list[i], startp)) {
387 * Check if needle is contained in haystack, * and ? patterns are resolved
388 * @param haystack list of parameters separated by delimimiter character
389 * @param needle string to be matched exectly to haystack including pattern matching
390 * @return True if found
392 static bool matchparam(const char **haystack_list, const char *needle)
396 if (haystack_list == NULL || haystack_list[0] == NULL ||
397 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
401 for(i=0; haystack_list[i] ; i++) {
402 if(unix_wild_match(haystack_list[i], needle)) {
411 * Touch access or modify date
413 static void recycle_do_touch(vfs_handle_struct *handle,
414 const struct smb_filename *smb_fname,
417 struct smb_filename *smb_fname_tmp = NULL;
418 struct smb_file_time ft;
422 init_smb_file_time(&ft);
424 status = synthetic_pathref(talloc_tos(),
425 handle->conn->cwd_fsp,
426 smb_fname->base_name,
427 smb_fname->stream_name,
432 if (!NT_STATUS_IS_OK(status)) {
433 DBG_DEBUG("synthetic_pathref for '%s' failed: %s\n",
434 smb_fname_str_dbg(smb_fname), nt_errstr(status));
439 ft.atime = timespec_current();
441 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
444 ret = SMB_VFS_NEXT_FNTIMES(handle, smb_fname_tmp->fsp, &ft);
448 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
449 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
452 TALLOC_FREE(smb_fname_tmp);
456 * Check if file should be recycled
458 static int recycle_unlink_internal(vfs_handle_struct *handle,
459 struct files_struct *dirfsp,
460 const struct smb_filename *smb_fname,
463 const struct loadparm_substitution *lp_sub =
464 loadparm_s3_global_substitution();
465 connection_struct *conn = handle->conn;
466 struct smb_filename *full_fname = NULL;
467 char *path_name = NULL;
468 char *temp_name = NULL;
469 char *final_name = NULL;
470 struct smb_filename *smb_fname_final = NULL;
472 char *repository = NULL;
474 off_t maxsize, minsize;
475 off_t file_size; /* space_avail; */
479 repository = talloc_sub_full(NULL, lp_servicename(talloc_tos(), lp_sub, SNUM(conn)),
480 conn->session_info->unix_info->unix_name,
482 conn->session_info->unix_token->gid,
483 conn->session_info->unix_info->sanitized_username,
484 conn->session_info->info->domain_name,
485 recycle_repository(handle));
486 ALLOC_CHECK(repository, done);
487 /* shouldn't we allow absolute path names here? --metze */
489 trim_char(repository, '\0', '/');
491 if(!repository || *(repository) == '\0') {
492 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
493 smb_fname_str_dbg(smb_fname)));
494 rc = SMB_VFS_NEXT_UNLINKAT(handle,
501 full_fname = full_path_from_dirfsp_atname(talloc_tos(),
504 if (full_fname == NULL) {
508 /* we don't recycle the recycle bin... */
509 if (strncmp(full_fname->base_name, repository,
510 strlen(repository)) == 0) {
511 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
512 rc = SMB_VFS_NEXT_UNLINKAT(handle,
519 file_size = recycle_get_file_size(handle, full_fname);
520 /* it is wrong to purge filenames only because they are empty imho
524 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
525 rc = SMB_VFS_NEXT_UNLINKAT(handle,
533 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
534 * not greater then maxsize, not the size of the single file, also it is better
535 * to remove older files
537 maxsize = recycle_maxsize(handle);
538 if(maxsize > 0 && file_size > maxsize) {
539 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
540 "purging... \n", smb_fname_str_dbg(full_fname)));
541 rc = SMB_VFS_NEXT_UNLINKAT(handle,
547 minsize = recycle_minsize(handle);
548 if(minsize > 0 && file_size < minsize) {
549 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
550 "purging... \n", smb_fname_str_dbg(full_fname)));
551 rc = SMB_VFS_NEXT_UNLINKAT(handle,
558 /* FIXME: this is wrong: moving files with rename does not change the disk space
561 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
562 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
563 if(space_avail < file_size) {
564 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
565 rc = SMB_VFS_NEXT_UNLINKAT(handle,
573 /* extract filename and path */
574 base = strrchr(full_fname->base_name, '/');
576 base = full_fname->base_name;
577 path_name = SMB_STRDUP("/");
578 ALLOC_CHECK(path_name, done);
581 path_name = SMB_STRDUP(full_fname->base_name);
582 ALLOC_CHECK(path_name, done);
583 path_name[base - smb_fname->base_name] = '\0';
587 /* original filename with path */
588 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(full_fname)));
590 DEBUG(10, ("recycle: fpath = %s\n", path_name));
591 /* filename without path */
592 DEBUG(10, ("recycle: base = %s\n", base));
594 if (matchparam(recycle_exclude(handle), base)) {
595 DEBUG(3, ("recycle: file %s is excluded \n", base));
596 rc = SMB_VFS_NEXT_UNLINKAT(handle,
603 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
604 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
605 rc = SMB_VFS_NEXT_UNLINKAT(handle,
612 if (recycle_keep_dir_tree(handle) == True) {
613 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
614 ALLOC_CHECK(temp_name, done);
617 temp_name = SMB_STRDUP(repository);
619 ALLOC_CHECK(temp_name, done);
621 exist = recycle_directory_exist(handle, temp_name);
623 DEBUG(10, ("recycle: Directory already exists\n"));
625 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
626 if (recycle_create_dir(handle, temp_name) == False) {
627 DEBUG(3, ("recycle: Could not create directory, "
629 smb_fname_str_dbg(full_fname)));
630 rc = SMB_VFS_NEXT_UNLINKAT(handle,
638 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
639 ALLOC_CHECK(final_name, done);
642 /* Create smb_fname with final base name and orig stream name. */
643 smb_fname_final = synthetic_smb_fname(talloc_tos(),
645 full_fname->stream_name,
649 if (smb_fname_final == NULL) {
650 rc = SMB_VFS_NEXT_UNLINKAT(handle,
657 /* new filename with path */
658 DEBUG(10, ("recycle: recycled file name: %s\n",
659 smb_fname_str_dbg(smb_fname_final)));
661 /* check if we should delete file from recycle bin */
662 if (recycle_file_exist(handle, smb_fname_final)) {
663 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
664 DEBUG(3, ("recycle: Removing old file %s from recycle "
665 "bin\n", smb_fname_str_dbg(smb_fname_final)));
666 if (SMB_VFS_NEXT_UNLINKAT(handle,
667 dirfsp->conn->cwd_fsp,
670 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
675 /* rename file we move to recycle bin */
677 while (recycle_file_exist(handle, smb_fname_final)) {
678 SAFE_FREE(final_name);
679 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
680 ALLOC_CHECK(final_name, done);
682 TALLOC_FREE(smb_fname_final->base_name);
683 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
685 if (smb_fname_final->base_name == NULL) {
686 rc = SMB_VFS_NEXT_UNLINKAT(handle,
694 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(full_fname),
695 smb_fname_str_dbg(smb_fname_final)));
696 rc = SMB_VFS_NEXT_RENAMEAT(handle,
699 handle->conn->cwd_fsp,
702 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
703 "(%s)\n", errno, strerror(errno),
704 smb_fname_str_dbg(full_fname),
705 smb_fname_str_dbg(smb_fname_final)));
706 rc = SMB_VFS_NEXT_UNLINKAT(handle,
713 /* touch access date of moved file */
714 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
715 recycle_do_touch(handle, smb_fname_final,
716 recycle_touch_mtime(handle));
719 SAFE_FREE(path_name);
720 SAFE_FREE(temp_name);
721 SAFE_FREE(final_name);
722 TALLOC_FREE(full_fname);
723 TALLOC_FREE(smb_fname_final);
724 TALLOC_FREE(repository);
728 static int recycle_unlinkat(vfs_handle_struct *handle,
729 struct files_struct *dirfsp,
730 const struct smb_filename *smb_fname,
735 if (flags & AT_REMOVEDIR) {
736 ret = SMB_VFS_NEXT_UNLINKAT(handle,
741 ret = recycle_unlink_internal(handle,
749 static struct vfs_fn_pointers vfs_recycle_fns = {
750 .unlinkat_fn = recycle_unlinkat
754 NTSTATUS vfs_recycle_init(TALLOC_CTX *ctx)
756 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
759 if (!NT_STATUS_IS_OK(ret))
762 vfs_recycle_debug_level = debug_add_class("recycle");
763 if (vfs_recycle_debug_level == -1) {
764 vfs_recycle_debug_level = DBGC_VFS;
765 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
767 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));