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_connect(vfs_handle_struct
*handle
, const char *service
, const char *user
);
39 static void recycle_disconnect(vfs_handle_struct
*handle
);
40 static int recycle_unlink(vfs_handle_struct
*handle
,
41 const struct smb_filename
*smb_fname
);
43 static int recycle_connect(vfs_handle_struct
*handle
, const char *service
, const char *user
)
45 int ret
= SMB_VFS_NEXT_CONNECT(handle
, service
, user
);
51 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
57 static void recycle_disconnect(vfs_handle_struct
*handle
)
59 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
60 lp_servicename(SNUM(handle
->conn
))));
62 SMB_VFS_NEXT_DISCONNECT(handle
);
65 static const char *recycle_repository(vfs_handle_struct
*handle
)
67 const char *tmp_str
= NULL
;
69 tmp_str
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "repository",".recycle");
71 DEBUG(10, ("recycle: repository = %s\n", tmp_str
));
76 static bool recycle_keep_dir_tree(vfs_handle_struct
*handle
)
80 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "keeptree", False
);
82 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret
?"True":"False"));
87 static bool recycle_versions(vfs_handle_struct
*handle
)
91 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "versions", False
);
93 DEBUG(10, ("recycle: versions = %s\n", ret
?"True":"False"));
98 static bool recycle_touch(vfs_handle_struct
*handle
)
102 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch", False
);
104 DEBUG(10, ("recycle: touch = %s\n", ret
?"True":"False"));
109 static bool recycle_touch_mtime(vfs_handle_struct
*handle
)
113 ret
= lp_parm_bool(SNUM(handle
->conn
), "recycle", "touch_mtime", False
);
115 DEBUG(10, ("recycle: touch_mtime = %s\n", ret
?"True":"False"));
120 static const char **recycle_exclude(vfs_handle_struct
*handle
)
124 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude", NULL
);
126 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp
?*tmp_lp
:""));
131 static const char **recycle_exclude_dir(vfs_handle_struct
*handle
)
135 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "exclude_dir", NULL
);
137 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp
?*tmp_lp
:""));
142 static const char **recycle_noversions(vfs_handle_struct
*handle
)
146 tmp_lp
= lp_parm_string_list(SNUM(handle
->conn
), "recycle", "noversions", NULL
);
148 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp
?*tmp_lp
:""));
153 static SMB_OFF_T
recycle_maxsize(vfs_handle_struct
*handle
)
157 maxsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
158 "recycle", "maxsize", NULL
));
160 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize
));
165 static SMB_OFF_T
recycle_minsize(vfs_handle_struct
*handle
)
169 minsize
= conv_str_size(lp_parm_const_string(SNUM(handle
->conn
),
170 "recycle", "minsize", NULL
));
172 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize
));
177 static mode_t
recycle_directory_mode(vfs_handle_struct
*handle
)
182 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "directory_mode", NULL
);
185 sscanf(buff
, "%o", &dirmode
);
187 dirmode
=S_IRUSR
| S_IWUSR
| S_IXUSR
;
190 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode
));
191 return (mode_t
)dirmode
;
194 static mode_t
recycle_subdir_mode(vfs_handle_struct
*handle
)
199 buff
= lp_parm_const_string(SNUM(handle
->conn
), "recycle", "subdir_mode", NULL
);
202 sscanf(buff
, "%o", &dirmode
);
204 dirmode
=recycle_directory_mode(handle
);
207 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode
));
208 return (mode_t
)dirmode
;
211 static bool recycle_directory_exist(vfs_handle_struct
*handle
, const char *dname
)
215 if (vfs_stat_smb_fname(handle
->conn
, dname
, &st
) == 0) {
216 if (S_ISDIR(st
.st_ex_mode
)) {
224 static bool recycle_file_exist(vfs_handle_struct
*handle
,
225 const struct smb_filename
*smb_fname
)
227 struct smb_filename
*smb_fname_tmp
= NULL
;
231 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
232 if (!NT_STATUS_IS_OK(status
)) {
236 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) == 0) {
237 if (S_ISREG(smb_fname_tmp
->st
.st_ex_mode
)) {
242 TALLOC_FREE(smb_fname_tmp
);
248 * @param conn connection
249 * @param fname file name
250 * @return size in bytes
252 static SMB_OFF_T
recycle_get_file_size(vfs_handle_struct
*handle
,
253 const struct smb_filename
*smb_fname
)
255 struct smb_filename
*smb_fname_tmp
= NULL
;
259 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
260 if (!NT_STATUS_IS_OK(status
)) {
265 if (SMB_VFS_STAT(handle
->conn
, smb_fname_tmp
) != 0) {
266 DEBUG(0,("recycle: stat for %s returned %s\n",
267 smb_fname_str_dbg(smb_fname_tmp
), strerror(errno
)));
272 size
= smb_fname_tmp
->st
.st_ex_size
;
274 TALLOC_FREE(smb_fname_tmp
);
279 * Create directory tree
280 * @param conn connection
281 * @param dname Directory tree to be created
282 * @return Returns True for success
284 static bool recycle_create_dir(vfs_handle_struct
*handle
, const char *dname
)
288 char *new_dir
= NULL
;
289 char *tmp_str
= NULL
;
295 mode
= recycle_directory_mode(handle
);
297 tmp_str
= SMB_STRDUP(dname
);
298 ALLOC_CHECK(tmp_str
, done
);
301 len
= strlen(dname
)+1;
302 new_dir
= (char *)SMB_MALLOC(len
+ 1);
303 ALLOC_CHECK(new_dir
, done
);
305 if (dname
[0] == '/') {
307 safe_strcat(new_dir
,"/",len
);
310 /* Create directory tree if neccessary */
311 for(token
= strtok_r(tok_str
, "/", &saveptr
); token
;
312 token
= strtok_r(NULL
, "/", &saveptr
)) {
313 safe_strcat(new_dir
, token
, len
);
314 if (recycle_directory_exist(handle
, new_dir
))
315 DEBUG(10, ("recycle: dir %s already exists\n", new_dir
));
317 DEBUG(5, ("recycle: creating new dir %s\n", new_dir
));
318 if (SMB_VFS_NEXT_MKDIR(handle
, new_dir
, mode
) != 0) {
319 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir
, strerror(errno
)));
324 safe_strcat(new_dir
, "/", len
);
325 mode
= recycle_subdir_mode(handle
);
336 * Check if any of the components of "exclude_list" are contained in path.
337 * Return True if found
340 static bool matchdirparam(const char **dir_exclude_list
, char *path
)
342 char *startp
= NULL
, *endp
= NULL
;
344 if (dir_exclude_list
== NULL
|| dir_exclude_list
[0] == NULL
||
345 *dir_exclude_list
[0] == '\0' || path
== NULL
|| *path
== '\0') {
350 * Walk the components of path, looking for matches with the
351 * exclude list on each component.
354 for (startp
= path
; startp
; startp
= endp
) {
357 while (*startp
== '/') {
360 endp
= strchr(startp
, '/');
365 for(i
=0; dir_exclude_list
[i
] ; i
++) {
366 if(unix_wild_match(dir_exclude_list
[i
], startp
)) {
385 * Check if needle is contained in haystack, * and ? patterns are resolved
386 * @param haystack list of parameters separated by delimimiter character
387 * @param needle string to be matched exectly to haystack including pattern matching
388 * @return True if found
390 static bool matchparam(const char **haystack_list
, const char *needle
)
394 if (haystack_list
== NULL
|| haystack_list
[0] == NULL
||
395 *haystack_list
[0] == '\0' || needle
== NULL
|| *needle
== '\0') {
399 for(i
=0; haystack_list
[i
] ; i
++) {
400 if(unix_wild_match(haystack_list
[i
], needle
)) {
409 * Touch access or modify date
411 static void recycle_do_touch(vfs_handle_struct
*handle
,
412 const struct smb_filename
*smb_fname
,
415 struct smb_filename
*smb_fname_tmp
= NULL
;
416 struct smb_file_time ft
;
422 status
= copy_smb_filename(talloc_tos(), smb_fname
, &smb_fname_tmp
);
423 if (!NT_STATUS_IS_OK(status
)) {
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(vfs_handle_struct
*handle
,
453 const struct smb_filename
*smb_fname
)
455 connection_struct
*conn
= handle
->conn
;
456 char *path_name
= NULL
;
457 char *temp_name
= NULL
;
458 char *final_name
= NULL
;
459 struct smb_filename
*smb_fname_final
= NULL
;
461 char *repository
= NULL
;
463 SMB_OFF_T maxsize
, minsize
;
464 SMB_OFF_T file_size
; /* space_avail; */
469 repository
= talloc_sub_advanced(NULL
, lp_servicename(SNUM(conn
)),
470 conn
->session_info
->unix_name
,
472 conn
->session_info
->utok
.gid
,
473 conn
->session_info
->sanitized_username
,
474 conn
->session_info
->info3
->base
.domain
.string
,
475 recycle_repository(handle
));
476 ALLOC_CHECK(repository
, done
);
477 /* shouldn't we allow absolute path names here? --metze */
479 trim_char(repository
, '\0', '/');
481 if(!repository
|| *(repository
) == '\0') {
482 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
483 smb_fname_str_dbg(smb_fname
)));
484 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
488 /* we don't recycle the recycle bin... */
489 if (strncmp(smb_fname
->base_name
, repository
,
490 strlen(repository
)) == 0) {
491 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
492 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
496 file_size
= recycle_get_file_size(handle
, smb_fname
);
497 /* it is wrong to purge filenames only because they are empty imho
501 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
502 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
507 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
508 * not greater then maxsize, not the size of the single file, also it is better
509 * to remove older files
511 maxsize
= recycle_maxsize(handle
);
512 if(maxsize
> 0 && file_size
> maxsize
) {
513 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
514 "purging... \n", smb_fname_str_dbg(smb_fname
)));
515 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
518 minsize
= recycle_minsize(handle
);
519 if(minsize
> 0 && file_size
< minsize
) {
520 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
521 "purging... \n", smb_fname_str_dbg(smb_fname
)));
522 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
526 /* FIXME: this is wrong: moving files with rename does not change the disk space
529 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
530 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
531 if(space_avail < file_size) {
532 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
533 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
538 /* extract filename and path */
539 base
= strrchr(smb_fname
->base_name
, '/');
541 base
= smb_fname
->base_name
;
542 path_name
= SMB_STRDUP("/");
543 ALLOC_CHECK(path_name
, done
);
546 path_name
= SMB_STRDUP(smb_fname
->base_name
);
547 ALLOC_CHECK(path_name
, done
);
548 path_name
[base
- smb_fname
->base_name
] = '\0';
552 /* original filename with path */
553 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname
)));
555 DEBUG(10, ("recycle: fpath = %s\n", path_name
));
556 /* filename without path */
557 DEBUG(10, ("recycle: base = %s\n", base
));
559 if (matchparam(recycle_exclude(handle
), base
)) {
560 DEBUG(3, ("recycle: file %s is excluded \n", base
));
561 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
565 if (matchdirparam(recycle_exclude_dir(handle
), path_name
)) {
566 DEBUG(3, ("recycle: directory %s is excluded \n", path_name
));
567 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
571 if (recycle_keep_dir_tree(handle
) == True
) {
572 if (asprintf(&temp_name
, "%s/%s", repository
, path_name
) == -1) {
573 ALLOC_CHECK(temp_name
, done
);
576 temp_name
= SMB_STRDUP(repository
);
578 ALLOC_CHECK(temp_name
, done
);
580 exist
= recycle_directory_exist(handle
, temp_name
);
582 DEBUG(10, ("recycle: Directory already exists\n"));
584 DEBUG(10, ("recycle: Creating directory %s\n", temp_name
));
585 if (recycle_create_dir(handle
, temp_name
) == False
) {
586 DEBUG(3, ("recycle: Could not create directory, "
588 smb_fname_str_dbg(smb_fname
)));
589 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
594 if (asprintf(&final_name
, "%s/%s", temp_name
, base
) == -1) {
595 ALLOC_CHECK(final_name
, done
);
598 /* Create smb_fname with final base name and orig stream name. */
599 status
= create_synthetic_smb_fname(talloc_tos(), final_name
,
600 smb_fname
->stream_name
, NULL
,
602 if (!NT_STATUS_IS_OK(status
)) {
603 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
607 /* new filename with path */
608 DEBUG(10, ("recycle: recycled file name: %s\n",
609 smb_fname_str_dbg(smb_fname_final
)));
611 /* check if we should delete file from recycle bin */
612 if (recycle_file_exist(handle
, smb_fname_final
)) {
613 if (recycle_versions(handle
) == False
|| matchparam(recycle_noversions(handle
), base
) == True
) {
614 DEBUG(3, ("recycle: Removing old file %s from recycle "
615 "bin\n", smb_fname_str_dbg(smb_fname_final
)));
616 if (SMB_VFS_NEXT_UNLINK(handle
,
617 smb_fname_final
) != 0) {
618 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno
)));
623 /* rename file we move to recycle bin */
625 while (recycle_file_exist(handle
, smb_fname_final
)) {
626 SAFE_FREE(final_name
);
627 if (asprintf(&final_name
, "%s/Copy #%d of %s", temp_name
, i
++, base
) == -1) {
628 ALLOC_CHECK(final_name
, done
);
630 TALLOC_FREE(smb_fname_final
->base_name
);
631 smb_fname_final
->base_name
= talloc_strdup(smb_fname_final
,
633 if (smb_fname_final
->base_name
== NULL
) {
634 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
639 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname
),
640 smb_fname_str_dbg(smb_fname_final
)));
641 rc
= SMB_VFS_NEXT_RENAME(handle
, smb_fname
, smb_fname_final
);
643 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
644 "(%s)\n", errno
, strerror(errno
),
645 smb_fname_str_dbg(smb_fname
),
646 smb_fname_str_dbg(smb_fname_final
)));
647 rc
= SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
651 /* touch access date of moved file */
652 if (recycle_touch(handle
) == True
|| recycle_touch_mtime(handle
))
653 recycle_do_touch(handle
, smb_fname_final
,
654 recycle_touch_mtime(handle
));
657 SAFE_FREE(path_name
);
658 SAFE_FREE(temp_name
);
659 SAFE_FREE(final_name
);
660 TALLOC_FREE(smb_fname_final
);
661 TALLOC_FREE(repository
);
665 static struct vfs_fn_pointers vfs_recycle_fns
= {
666 .connect_fn
= recycle_connect
,
667 .disconnect
= recycle_disconnect
,
668 .unlink
= recycle_unlink
671 NTSTATUS
vfs_recycle_init(void);
672 NTSTATUS
vfs_recycle_init(void)
674 NTSTATUS ret
= smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "recycle",
677 if (!NT_STATUS_IS_OK(ret
))
680 vfs_recycle_debug_level
= debug_add_class("recycle");
681 if (vfs_recycle_debug_level
== -1) {
682 vfs_recycle_debug_level
= DBGC_VFS
;
683 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
685 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level
));