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(),
304 if (smb_fname == NULL) {
308 retval = SMB_VFS_NEXT_MKDIRAT(handle,
309 handle->conn->cwd_fsp,
313 DBG_WARNING("recycle: mkdirat failed "
314 "for %s with error: %s\n",
317 TALLOC_FREE(smb_fname);
321 TALLOC_FREE(smb_fname);
323 if (strlcat(new_dir, "/", len+1) >= len+1) {
326 mode = recycle_subdir_mode(handle);
337 * Check if any of the components of "exclude_list" are contained in path.
338 * Return True if found
341 static bool matchdirparam(const char **dir_exclude_list, char *path)
343 char *startp = NULL, *endp = NULL;
345 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
346 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
351 * Walk the components of path, looking for matches with the
352 * exclude list on each component.
355 for (startp = path; startp; startp = endp) {
358 while (*startp == '/') {
361 endp = strchr(startp, '/');
366 for(i=0; dir_exclude_list[i] ; i++) {
367 if(unix_wild_match(dir_exclude_list[i], startp)) {
386 * Check if needle is contained in haystack, * and ? patterns are resolved
387 * @param haystack list of parameters separated by delimimiter character
388 * @param needle string to be matched exectly to haystack including pattern matching
389 * @return True if found
391 static bool matchparam(const char **haystack_list, const char *needle)
395 if (haystack_list == NULL || haystack_list[0] == NULL ||
396 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
400 for(i=0; haystack_list[i] ; i++) {
401 if(unix_wild_match(haystack_list[i], needle)) {
410 * Touch access or modify date
412 static void recycle_do_touch(vfs_handle_struct *handle,
413 const struct smb_filename *smb_fname,
416 struct smb_filename *smb_fname_tmp = NULL;
417 struct smb_file_time ft;
420 init_smb_file_time(&ft);
422 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
423 if (smb_fname_tmp == NULL) {
427 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
428 DEBUG(0,("recycle: stat for %s returned %s\n",
429 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
433 ft.atime = timespec_current();
435 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
438 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
442 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
443 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
446 TALLOC_FREE(smb_fname_tmp);
450 * Check if file should be recycled
452 static int recycle_unlink_internal(vfs_handle_struct *handle,
453 struct files_struct *dirfsp,
454 const struct smb_filename *smb_fname,
457 const struct loadparm_substitution *lp_sub =
458 loadparm_s3_global_substitution();
459 connection_struct *conn = handle->conn;
460 char *path_name = NULL;
461 char *temp_name = NULL;
462 char *final_name = NULL;
463 struct smb_filename *smb_fname_final = NULL;
465 char *repository = NULL;
467 off_t maxsize, minsize;
468 off_t file_size; /* space_avail; */
472 repository = talloc_sub_full(NULL, lp_servicename(talloc_tos(), lp_sub, SNUM(conn)),
473 conn->session_info->unix_info->unix_name,
475 conn->session_info->unix_token->gid,
476 conn->session_info->unix_info->sanitized_username,
477 conn->session_info->info->domain_name,
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_UNLINKAT(handle,
494 /* we don't recycle the recycle bin... */
495 if (strncmp(smb_fname->base_name, repository,
496 strlen(repository)) == 0) {
497 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
498 rc = SMB_VFS_NEXT_UNLINKAT(handle,
505 file_size = recycle_get_file_size(handle, smb_fname);
506 /* it is wrong to purge filenames only because they are empty imho
510 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
511 rc = SMB_VFS_NEXT_UNLINKAT(handle,
519 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
520 * not greater then maxsize, not the size of the single file, also it is better
521 * to remove older files
523 maxsize = recycle_maxsize(handle);
524 if(maxsize > 0 && file_size > maxsize) {
525 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
526 "purging... \n", smb_fname_str_dbg(smb_fname)));
527 rc = SMB_VFS_NEXT_UNLINKAT(handle,
533 minsize = recycle_minsize(handle);
534 if(minsize > 0 && file_size < minsize) {
535 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
536 "purging... \n", smb_fname_str_dbg(smb_fname)));
537 rc = SMB_VFS_NEXT_UNLINKAT(handle,
544 /* FIXME: this is wrong: moving files with rename does not change the disk space
547 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
548 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
549 if(space_avail < file_size) {
550 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
551 rc = SMB_VFS_NEXT_UNLINKAT(handle,
559 /* extract filename and path */
560 base = strrchr(smb_fname->base_name, '/');
562 base = smb_fname->base_name;
563 path_name = SMB_STRDUP("/");
564 ALLOC_CHECK(path_name, done);
567 path_name = SMB_STRDUP(smb_fname->base_name);
568 ALLOC_CHECK(path_name, done);
569 path_name[base - smb_fname->base_name] = '\0';
573 /* original filename with path */
574 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
576 DEBUG(10, ("recycle: fpath = %s\n", path_name));
577 /* filename without path */
578 DEBUG(10, ("recycle: base = %s\n", base));
580 if (matchparam(recycle_exclude(handle), base)) {
581 DEBUG(3, ("recycle: file %s is excluded \n", base));
582 rc = SMB_VFS_NEXT_UNLINKAT(handle,
589 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
590 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
591 rc = SMB_VFS_NEXT_UNLINKAT(handle,
598 if (recycle_keep_dir_tree(handle) == True) {
599 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
600 ALLOC_CHECK(temp_name, done);
603 temp_name = SMB_STRDUP(repository);
605 ALLOC_CHECK(temp_name, done);
607 exist = recycle_directory_exist(handle, temp_name);
609 DEBUG(10, ("recycle: Directory already exists\n"));
611 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
612 if (recycle_create_dir(handle, temp_name) == False) {
613 DEBUG(3, ("recycle: Could not create directory, "
615 smb_fname_str_dbg(smb_fname)));
616 rc = SMB_VFS_NEXT_UNLINKAT(handle,
624 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
625 ALLOC_CHECK(final_name, done);
628 /* Create smb_fname with final base name and orig stream name. */
629 smb_fname_final = synthetic_smb_fname(talloc_tos(),
631 smb_fname->stream_name,
634 if (smb_fname_final == NULL) {
635 rc = SMB_VFS_NEXT_UNLINKAT(handle,
642 /* new filename with path */
643 DEBUG(10, ("recycle: recycled file name: %s\n",
644 smb_fname_str_dbg(smb_fname_final)));
646 /* check if we should delete file from recycle bin */
647 if (recycle_file_exist(handle, smb_fname_final)) {
648 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
649 DEBUG(3, ("recycle: Removing old file %s from recycle "
650 "bin\n", smb_fname_str_dbg(smb_fname_final)));
651 if (SMB_VFS_NEXT_UNLINKAT(handle,
655 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
660 /* rename file we move to recycle bin */
662 while (recycle_file_exist(handle, smb_fname_final)) {
663 SAFE_FREE(final_name);
664 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
665 ALLOC_CHECK(final_name, done);
667 TALLOC_FREE(smb_fname_final->base_name);
668 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
670 if (smb_fname_final->base_name == NULL) {
671 rc = SMB_VFS_NEXT_UNLINKAT(handle,
679 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
680 smb_fname_str_dbg(smb_fname_final)));
681 rc = SMB_VFS_NEXT_RENAMEAT(handle,
682 handle->conn->cwd_fsp,
684 handle->conn->cwd_fsp,
687 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
688 "(%s)\n", errno, strerror(errno),
689 smb_fname_str_dbg(smb_fname),
690 smb_fname_str_dbg(smb_fname_final)));
691 rc = SMB_VFS_NEXT_UNLINKAT(handle,
698 /* touch access date of moved file */
699 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
700 recycle_do_touch(handle, smb_fname_final,
701 recycle_touch_mtime(handle));
704 SAFE_FREE(path_name);
705 SAFE_FREE(temp_name);
706 SAFE_FREE(final_name);
707 TALLOC_FREE(smb_fname_final);
708 TALLOC_FREE(repository);
712 static int recycle_unlinkat(vfs_handle_struct *handle,
713 struct files_struct *dirfsp,
714 const struct smb_filename *smb_fname,
719 if (flags & AT_REMOVEDIR) {
720 ret = SMB_VFS_NEXT_UNLINKAT(handle,
725 SMB_ASSERT(dirfsp == dirfsp->conn->cwd_fsp);
726 ret = recycle_unlink_internal(handle,
734 static struct vfs_fn_pointers vfs_recycle_fns = {
735 .unlinkat_fn = recycle_unlinkat
739 NTSTATUS vfs_recycle_init(TALLOC_CTX *ctx)
741 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
744 if (!NT_STATUS_IS_OK(ret))
747 vfs_recycle_debug_level = debug_add_class("recycle");
748 if (vfs_recycle_debug_level == -1) {
749 vfs_recycle_debug_level = DBGC_VFS;
750 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
752 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));