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 "system/filesys.h"
27 #include "../librpc/gen_ndr/ndr_netlogon.h"
29 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
31 static int vfs_recycle_debug_level = DBGC_VFS;
34 #define DBGC_CLASS vfs_recycle_debug_level
36 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user);
37 static void recycle_disconnect(vfs_handle_struct *handle);
38 static int recycle_unlink(vfs_handle_struct *handle,
39 const struct smb_filename *smb_fname);
41 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user)
43 int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
49 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
55 static void recycle_disconnect(vfs_handle_struct *handle)
57 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
58 lp_servicename(SNUM(handle->conn))));
60 SMB_VFS_NEXT_DISCONNECT(handle);
63 static const char *recycle_repository(vfs_handle_struct *handle)
65 const char *tmp_str = NULL;
67 tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
69 DEBUG(10, ("recycle: repository = %s\n", tmp_str));
74 static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
78 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
80 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
85 static bool recycle_versions(vfs_handle_struct *handle)
89 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
91 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
96 static bool recycle_touch(vfs_handle_struct *handle)
100 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
102 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
107 static bool recycle_touch_mtime(vfs_handle_struct *handle)
111 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
113 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
118 static const char **recycle_exclude(vfs_handle_struct *handle)
122 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
124 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
129 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
133 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
135 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
140 static const char **recycle_noversions(vfs_handle_struct *handle)
144 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
146 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
151 static SMB_OFF_T recycle_maxsize(vfs_handle_struct *handle)
155 maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
156 "recycle", "maxsize", NULL));
158 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize));
163 static SMB_OFF_T recycle_minsize(vfs_handle_struct *handle)
167 minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
168 "recycle", "minsize", NULL));
170 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
175 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
180 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
183 sscanf(buff, "%o", &dirmode);
185 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
188 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
189 return (mode_t)dirmode;
192 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
197 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
200 sscanf(buff, "%o", &dirmode);
202 dirmode=recycle_directory_mode(handle);
205 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
206 return (mode_t)dirmode;
209 static bool recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
213 if (vfs_stat_smb_fname(handle->conn, dname, &st) == 0) {
214 if (S_ISDIR(st.st_ex_mode)) {
222 static bool recycle_file_exist(vfs_handle_struct *handle,
223 const struct smb_filename *smb_fname)
225 struct smb_filename *smb_fname_tmp = NULL;
229 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
230 if (!NT_STATUS_IS_OK(status)) {
234 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
235 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
240 TALLOC_FREE(smb_fname_tmp);
246 * @param conn connection
247 * @param fname file name
248 * @return size in bytes
250 static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle,
251 const struct smb_filename *smb_fname)
253 struct smb_filename *smb_fname_tmp = NULL;
257 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
258 if (!NT_STATUS_IS_OK(status)) {
263 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
264 DEBUG(0,("recycle: stat for %s returned %s\n",
265 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
270 size = smb_fname_tmp->st.st_ex_size;
272 TALLOC_FREE(smb_fname_tmp);
277 * Create directory tree
278 * @param conn connection
279 * @param dname Directory tree to be created
280 * @return Returns True for success
282 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
286 char *new_dir = NULL;
287 char *tmp_str = NULL;
293 mode = recycle_directory_mode(handle);
295 tmp_str = SMB_STRDUP(dname);
296 ALLOC_CHECK(tmp_str, done);
299 len = strlen(dname)+1;
300 new_dir = (char *)SMB_MALLOC(len + 1);
301 ALLOC_CHECK(new_dir, done);
303 if (dname[0] == '/') {
305 safe_strcat(new_dir,"/",len);
308 /* Create directory tree if neccessary */
309 for(token = strtok_r(tok_str, "/", &saveptr); token;
310 token = strtok_r(NULL, "/", &saveptr)) {
311 safe_strcat(new_dir, token, len);
312 if (recycle_directory_exist(handle, new_dir))
313 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
315 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
316 if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
317 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
322 safe_strcat(new_dir, "/", len);
323 mode = recycle_subdir_mode(handle);
334 * Check if any of the components of "exclude_list" are contained in path.
335 * Return True if found
338 static bool matchdirparam(const char **dir_exclude_list, char *path)
340 char *startp = NULL, *endp = NULL;
342 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
343 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
348 * Walk the components of path, looking for matches with the
349 * exclude list on each component.
352 for (startp = path; startp; startp = endp) {
355 while (*startp == '/') {
358 endp = strchr(startp, '/');
363 for(i=0; dir_exclude_list[i] ; i++) {
364 if(unix_wild_match(dir_exclude_list[i], startp)) {
383 * Check if needle is contained in haystack, * and ? patterns are resolved
384 * @param haystack list of parameters separated by delimimiter character
385 * @param needle string to be matched exectly to haystack including pattern matching
386 * @return True if found
388 static bool matchparam(const char **haystack_list, const char *needle)
392 if (haystack_list == NULL || haystack_list[0] == NULL ||
393 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
397 for(i=0; haystack_list[i] ; i++) {
398 if(unix_wild_match(haystack_list[i], needle)) {
407 * Touch access or modify date
409 static void recycle_do_touch(vfs_handle_struct *handle,
410 const struct smb_filename *smb_fname,
413 struct smb_filename *smb_fname_tmp = NULL;
414 struct smb_file_time ft;
420 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
421 if (!NT_STATUS_IS_OK(status)) {
425 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
426 DEBUG(0,("recycle: stat for %s returned %s\n",
427 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
431 ft.atime = timespec_current();
433 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
436 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
440 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
441 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
444 TALLOC_FREE(smb_fname_tmp);
448 * Check if file should be recycled
450 static int recycle_unlink(vfs_handle_struct *handle,
451 const struct smb_filename *smb_fname)
453 connection_struct *conn = handle->conn;
454 char *path_name = NULL;
455 char *temp_name = NULL;
456 char *final_name = NULL;
457 struct smb_filename *smb_fname_final = NULL;
459 char *repository = NULL;
461 SMB_OFF_T maxsize, minsize;
462 SMB_OFF_T file_size; /* space_avail; */
467 repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
468 conn->session_info->unix_name,
470 conn->session_info->utok.gid,
471 conn->session_info->sanitized_username,
472 conn->session_info->info3->base.domain.string,
473 recycle_repository(handle));
474 ALLOC_CHECK(repository, done);
475 /* shouldn't we allow absolute path names here? --metze */
477 trim_char(repository, '\0', '/');
479 if(!repository || *(repository) == '\0') {
480 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
481 smb_fname_str_dbg(smb_fname)));
482 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
486 /* we don't recycle the recycle bin... */
487 if (strncmp(smb_fname->base_name, repository,
488 strlen(repository)) == 0) {
489 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
490 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
494 file_size = recycle_get_file_size(handle, smb_fname);
495 /* it is wrong to purge filenames only because they are empty imho
499 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
500 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
505 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
506 * not greater then maxsize, not the size of the single file, also it is better
507 * to remove older files
509 maxsize = recycle_maxsize(handle);
510 if(maxsize > 0 && file_size > maxsize) {
511 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
512 "purging... \n", smb_fname_str_dbg(smb_fname)));
513 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
516 minsize = recycle_minsize(handle);
517 if(minsize > 0 && file_size < minsize) {
518 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
519 "purging... \n", smb_fname_str_dbg(smb_fname)));
520 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
524 /* FIXME: this is wrong: moving files with rename does not change the disk space
527 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
528 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
529 if(space_avail < file_size) {
530 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
531 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
536 /* extract filename and path */
537 base = strrchr(smb_fname->base_name, '/');
539 base = smb_fname->base_name;
540 path_name = SMB_STRDUP("/");
541 ALLOC_CHECK(path_name, done);
544 path_name = SMB_STRDUP(smb_fname->base_name);
545 ALLOC_CHECK(path_name, done);
546 path_name[base - smb_fname->base_name] = '\0';
550 /* original filename with path */
551 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
553 DEBUG(10, ("recycle: fpath = %s\n", path_name));
554 /* filename without path */
555 DEBUG(10, ("recycle: base = %s\n", base));
557 if (matchparam(recycle_exclude(handle), base)) {
558 DEBUG(3, ("recycle: file %s is excluded \n", base));
559 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
563 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
564 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
565 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
569 if (recycle_keep_dir_tree(handle) == True) {
570 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
571 ALLOC_CHECK(temp_name, done);
574 temp_name = SMB_STRDUP(repository);
576 ALLOC_CHECK(temp_name, done);
578 exist = recycle_directory_exist(handle, temp_name);
580 DEBUG(10, ("recycle: Directory already exists\n"));
582 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
583 if (recycle_create_dir(handle, temp_name) == False) {
584 DEBUG(3, ("recycle: Could not create directory, "
586 smb_fname_str_dbg(smb_fname)));
587 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
592 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
593 ALLOC_CHECK(final_name, done);
596 /* Create smb_fname with final base name and orig stream name. */
597 status = create_synthetic_smb_fname(talloc_tos(), final_name,
598 smb_fname->stream_name, NULL,
600 if (!NT_STATUS_IS_OK(status)) {
601 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
605 /* new filename with path */
606 DEBUG(10, ("recycle: recycled file name: %s\n",
607 smb_fname_str_dbg(smb_fname_final)));
609 /* check if we should delete file from recycle bin */
610 if (recycle_file_exist(handle, smb_fname_final)) {
611 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
612 DEBUG(3, ("recycle: Removing old file %s from recycle "
613 "bin\n", smb_fname_str_dbg(smb_fname_final)));
614 if (SMB_VFS_NEXT_UNLINK(handle,
615 smb_fname_final) != 0) {
616 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
621 /* rename file we move to recycle bin */
623 while (recycle_file_exist(handle, smb_fname_final)) {
624 SAFE_FREE(final_name);
625 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
626 ALLOC_CHECK(final_name, done);
628 TALLOC_FREE(smb_fname_final->base_name);
629 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
631 if (smb_fname_final->base_name == NULL) {
632 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
637 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
638 smb_fname_str_dbg(smb_fname_final)));
639 rc = SMB_VFS_NEXT_RENAME(handle, smb_fname, smb_fname_final);
641 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
642 "(%s)\n", errno, strerror(errno),
643 smb_fname_str_dbg(smb_fname),
644 smb_fname_str_dbg(smb_fname_final)));
645 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
649 /* touch access date of moved file */
650 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
651 recycle_do_touch(handle, smb_fname_final,
652 recycle_touch_mtime(handle));
655 SAFE_FREE(path_name);
656 SAFE_FREE(temp_name);
657 SAFE_FREE(final_name);
658 TALLOC_FREE(smb_fname_final);
659 TALLOC_FREE(repository);
663 static struct vfs_fn_pointers vfs_recycle_fns = {
664 .connect_fn = recycle_connect,
665 .disconnect = recycle_disconnect,
666 .unlink = recycle_unlink
669 NTSTATUS vfs_recycle_init(void);
670 NTSTATUS vfs_recycle_init(void)
672 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
675 if (!NT_STATUS_IS_OK(ret))
678 vfs_recycle_debug_level = debug_add_class("recycle");
679 if (vfs_recycle_debug_level == -1) {
680 vfs_recycle_debug_level = DBGC_VFS;
681 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
683 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));