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)
191 if (vfs_stat_smb_basename(handle->conn, dname, &st) == 0) {
192 if (S_ISDIR(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 DEBUG(0,("recycle: 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 neccessary */
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;
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 if (SMB_VFS_NEXT_MKDIR(handle, smb_fname, mode) != 0) {
309 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
310 TALLOC_FREE(smb_fname);
314 TALLOC_FREE(smb_fname);
316 if (strlcat(new_dir, "/", len+1) >= len+1) {
319 mode = recycle_subdir_mode(handle);
330 * Check if any of the components of "exclude_list" are contained in path.
331 * Return True if found
334 static bool matchdirparam(const char **dir_exclude_list, char *path)
336 char *startp = NULL, *endp = NULL;
338 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
339 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
344 * Walk the components of path, looking for matches with the
345 * exclude list on each component.
348 for (startp = path; startp; startp = endp) {
351 while (*startp == '/') {
354 endp = strchr(startp, '/');
359 for(i=0; dir_exclude_list[i] ; i++) {
360 if(unix_wild_match(dir_exclude_list[i], startp)) {
379 * Check if needle is contained in haystack, * and ? patterns are resolved
380 * @param haystack list of parameters separated by delimimiter character
381 * @param needle string to be matched exectly to haystack including pattern matching
382 * @return True if found
384 static bool matchparam(const char **haystack_list, const char *needle)
388 if (haystack_list == NULL || haystack_list[0] == NULL ||
389 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
393 for(i=0; haystack_list[i] ; i++) {
394 if(unix_wild_match(haystack_list[i], needle)) {
403 * Touch access or modify date
405 static void recycle_do_touch(vfs_handle_struct *handle,
406 const struct smb_filename *smb_fname,
409 struct smb_filename *smb_fname_tmp = NULL;
410 struct smb_file_time ft;
415 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
416 if (smb_fname_tmp == NULL) {
420 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
421 DEBUG(0,("recycle: stat for %s returned %s\n",
422 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
426 ft.atime = timespec_current();
428 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
431 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
435 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
436 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
439 TALLOC_FREE(smb_fname_tmp);
443 * Check if file should be recycled
445 static int recycle_unlink(vfs_handle_struct *handle,
446 const struct smb_filename *smb_fname)
448 connection_struct *conn = handle->conn;
449 char *path_name = NULL;
450 char *temp_name = NULL;
451 char *final_name = NULL;
452 struct smb_filename *smb_fname_final = NULL;
454 char *repository = NULL;
456 off_t maxsize, minsize;
457 off_t file_size; /* space_avail; */
461 repository = talloc_sub_advanced(NULL, lp_servicename(talloc_tos(), SNUM(conn)),
462 conn->session_info->unix_info->unix_name,
464 conn->session_info->unix_token->gid,
465 conn->session_info->unix_info->sanitized_username,
466 conn->session_info->info->domain_name,
467 recycle_repository(handle));
468 ALLOC_CHECK(repository, done);
469 /* shouldn't we allow absolute path names here? --metze */
471 trim_char(repository, '\0', '/');
473 if(!repository || *(repository) == '\0') {
474 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
475 smb_fname_str_dbg(smb_fname)));
476 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
480 /* we don't recycle the recycle bin... */
481 if (strncmp(smb_fname->base_name, repository,
482 strlen(repository)) == 0) {
483 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
484 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
488 file_size = recycle_get_file_size(handle, smb_fname);
489 /* it is wrong to purge filenames only because they are empty imho
493 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
494 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
499 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
500 * not greater then maxsize, not the size of the single file, also it is better
501 * to remove older files
503 maxsize = recycle_maxsize(handle);
504 if(maxsize > 0 && file_size > maxsize) {
505 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
506 "purging... \n", smb_fname_str_dbg(smb_fname)));
507 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
510 minsize = recycle_minsize(handle);
511 if(minsize > 0 && file_size < minsize) {
512 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
513 "purging... \n", smb_fname_str_dbg(smb_fname)));
514 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
518 /* FIXME: this is wrong: moving files with rename does not change the disk space
521 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
522 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
523 if(space_avail < file_size) {
524 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
525 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
530 /* extract filename and path */
531 base = strrchr(smb_fname->base_name, '/');
533 base = smb_fname->base_name;
534 path_name = SMB_STRDUP("/");
535 ALLOC_CHECK(path_name, done);
538 path_name = SMB_STRDUP(smb_fname->base_name);
539 ALLOC_CHECK(path_name, done);
540 path_name[base - smb_fname->base_name] = '\0';
544 /* original filename with path */
545 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
547 DEBUG(10, ("recycle: fpath = %s\n", path_name));
548 /* filename without path */
549 DEBUG(10, ("recycle: base = %s\n", base));
551 if (matchparam(recycle_exclude(handle), base)) {
552 DEBUG(3, ("recycle: file %s is excluded \n", base));
553 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
557 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
558 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
559 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
563 if (recycle_keep_dir_tree(handle) == True) {
564 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
565 ALLOC_CHECK(temp_name, done);
568 temp_name = SMB_STRDUP(repository);
570 ALLOC_CHECK(temp_name, done);
572 exist = recycle_directory_exist(handle, temp_name);
574 DEBUG(10, ("recycle: Directory already exists\n"));
576 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
577 if (recycle_create_dir(handle, temp_name) == False) {
578 DEBUG(3, ("recycle: Could not create directory, "
580 smb_fname_str_dbg(smb_fname)));
581 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
586 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
587 ALLOC_CHECK(final_name, done);
590 /* Create smb_fname with final base name and orig stream name. */
591 smb_fname_final = synthetic_smb_fname(talloc_tos(),
593 smb_fname->stream_name,
596 if (smb_fname_final == NULL) {
597 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
601 /* new filename with path */
602 DEBUG(10, ("recycle: recycled file name: %s\n",
603 smb_fname_str_dbg(smb_fname_final)));
605 /* check if we should delete file from recycle bin */
606 if (recycle_file_exist(handle, smb_fname_final)) {
607 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
608 DEBUG(3, ("recycle: Removing old file %s from recycle "
609 "bin\n", smb_fname_str_dbg(smb_fname_final)));
610 if (SMB_VFS_NEXT_UNLINK(handle,
611 smb_fname_final) != 0) {
612 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
617 /* rename file we move to recycle bin */
619 while (recycle_file_exist(handle, smb_fname_final)) {
620 SAFE_FREE(final_name);
621 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
622 ALLOC_CHECK(final_name, done);
624 TALLOC_FREE(smb_fname_final->base_name);
625 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
627 if (smb_fname_final->base_name == NULL) {
628 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
633 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
634 smb_fname_str_dbg(smb_fname_final)));
635 rc = SMB_VFS_NEXT_RENAME(handle, smb_fname, smb_fname_final);
637 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
638 "(%s)\n", errno, strerror(errno),
639 smb_fname_str_dbg(smb_fname),
640 smb_fname_str_dbg(smb_fname_final)));
641 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
645 /* touch access date of moved file */
646 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
647 recycle_do_touch(handle, smb_fname_final,
648 recycle_touch_mtime(handle));
651 SAFE_FREE(path_name);
652 SAFE_FREE(temp_name);
653 SAFE_FREE(final_name);
654 TALLOC_FREE(smb_fname_final);
655 TALLOC_FREE(repository);
659 static struct vfs_fn_pointers vfs_recycle_fns = {
660 .unlink_fn = recycle_unlink
663 NTSTATUS vfs_recycle_init(void);
664 NTSTATUS vfs_recycle_init(void)
666 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
669 if (!NT_STATUS_IS_OK(ret))
672 vfs_recycle_debug_level = debug_add_class("recycle");
673 if (vfs_recycle_debug_level == -1) {
674 vfs_recycle_debug_level = DBGC_VFS;
675 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
677 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));