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/>.
27 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
29 static int vfs_recycle_debug_level = DBGC_VFS;
32 #define DBGC_CLASS vfs_recycle_debug_level
34 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user);
35 static void recycle_disconnect(vfs_handle_struct *handle);
36 static int recycle_unlink(vfs_handle_struct *handle,
37 const struct smb_filename *smb_fname);
39 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user)
41 int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
47 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
53 static void recycle_disconnect(vfs_handle_struct *handle)
55 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
56 lp_servicename(SNUM(handle->conn))));
58 SMB_VFS_NEXT_DISCONNECT(handle);
61 static const char *recycle_repository(vfs_handle_struct *handle)
63 const char *tmp_str = NULL;
65 tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
67 DEBUG(10, ("recycle: repository = %s\n", tmp_str));
72 static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
76 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
78 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
83 static bool recycle_versions(vfs_handle_struct *handle)
87 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
89 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
94 static bool recycle_touch(vfs_handle_struct *handle)
98 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
100 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
105 static bool recycle_touch_mtime(vfs_handle_struct *handle)
109 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
111 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
116 static const char **recycle_exclude(vfs_handle_struct *handle)
120 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
122 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
127 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
131 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
133 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
138 static const char **recycle_noversions(vfs_handle_struct *handle)
142 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
144 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
149 static SMB_OFF_T recycle_maxsize(vfs_handle_struct *handle)
153 maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
154 "recycle", "maxsize", NULL));
156 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize));
161 static SMB_OFF_T recycle_minsize(vfs_handle_struct *handle)
165 minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
166 "recycle", "minsize", NULL));
168 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
173 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
178 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
181 sscanf(buff, "%o", &dirmode);
183 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
186 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
187 return (mode_t)dirmode;
190 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
195 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
198 sscanf(buff, "%o", &dirmode);
200 dirmode=recycle_directory_mode(handle);
203 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
204 return (mode_t)dirmode;
207 static bool recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
211 if (vfs_stat_smb_fname(handle->conn, dname, &st) == 0) {
212 if (S_ISDIR(st.st_ex_mode)) {
220 static bool recycle_file_exist(vfs_handle_struct *handle,
221 const struct smb_filename *smb_fname)
223 struct smb_filename *smb_fname_tmp = NULL;
227 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
228 if (!NT_STATUS_IS_OK(status)) {
232 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
233 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
238 TALLOC_FREE(smb_fname_tmp);
244 * @param conn connection
245 * @param fname file name
246 * @return size in bytes
248 static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle,
249 const struct smb_filename *smb_fname)
251 struct smb_filename *smb_fname_tmp = NULL;
255 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
256 if (!NT_STATUS_IS_OK(status)) {
261 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
262 DEBUG(0,("recycle: stat for %s returned %s\n",
263 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
268 size = smb_fname_tmp->st.st_ex_size;
270 TALLOC_FREE(smb_fname_tmp);
275 * Create directory tree
276 * @param conn connection
277 * @param dname Directory tree to be created
278 * @return Returns True for success
280 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
284 char *new_dir = NULL;
285 char *tmp_str = NULL;
291 mode = recycle_directory_mode(handle);
293 tmp_str = SMB_STRDUP(dname);
294 ALLOC_CHECK(tmp_str, done);
297 len = strlen(dname)+1;
298 new_dir = (char *)SMB_MALLOC(len + 1);
299 ALLOC_CHECK(new_dir, done);
301 if (dname[0] == '/') {
303 safe_strcat(new_dir,"/",len);
306 /* Create directory tree if neccessary */
307 for(token = strtok_r(tok_str, "/", &saveptr); token;
308 token = strtok_r(NULL, "/", &saveptr)) {
309 safe_strcat(new_dir, token, len);
310 if (recycle_directory_exist(handle, new_dir))
311 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
313 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
314 if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
315 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
320 safe_strcat(new_dir, "/", len);
321 mode = recycle_subdir_mode(handle);
332 * Check if any of the components of "exclude_list" are contained in path.
333 * Return True if found
336 static bool matchdirparam(const char **dir_exclude_list, char *path)
338 char *startp = NULL, *endp = NULL;
340 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
341 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
346 * Walk the components of path, looking for matches with the
347 * exclude list on each component.
350 for (startp = path; startp; startp = endp) {
353 while (*startp == '/') {
356 endp = strchr(startp, '/');
361 for(i=0; dir_exclude_list[i] ; i++) {
362 if(unix_wild_match(dir_exclude_list[i], startp)) {
381 * Check if needle is contained in haystack, * and ? patterns are resolved
382 * @param haystack list of parameters separated by delimimiter character
383 * @param needle string to be matched exectly to haystack including pattern matching
384 * @return True if found
386 static bool matchparam(const char **haystack_list, const char *needle)
390 if (haystack_list == NULL || haystack_list[0] == NULL ||
391 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
395 for(i=0; haystack_list[i] ; i++) {
396 if(unix_wild_match(haystack_list[i], needle)) {
405 * Touch access or modify date
407 static void recycle_do_touch(vfs_handle_struct *handle,
408 const struct smb_filename *smb_fname,
411 struct smb_filename *smb_fname_tmp = NULL;
412 struct smb_file_time ft;
418 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
419 if (!NT_STATUS_IS_OK(status)) {
423 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
424 DEBUG(0,("recycle: stat for %s returned %s\n",
425 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
429 ft.atime = timespec_current();
431 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
434 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
438 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
439 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
442 TALLOC_FREE(smb_fname_tmp);
446 * Check if file should be recycled
448 static int recycle_unlink(vfs_handle_struct *handle,
449 const struct smb_filename *smb_fname)
451 connection_struct *conn = handle->conn;
452 char *path_name = NULL;
453 char *temp_name = NULL;
454 char *final_name = NULL;
455 struct smb_filename *smb_fname_final = NULL;
457 char *repository = NULL;
459 SMB_OFF_T maxsize, minsize;
460 SMB_OFF_T file_size; /* space_avail; */
465 repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
466 conn->server_info->unix_name,
468 conn->server_info->utok.gid,
469 conn->server_info->sanitized_username,
470 conn->server_info->info3->base.domain.string,
471 recycle_repository(handle));
472 ALLOC_CHECK(repository, done);
473 /* shouldn't we allow absolute path names here? --metze */
475 trim_char(repository, '\0', '/');
477 if(!repository || *(repository) == '\0') {
478 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
479 smb_fname_str_dbg(smb_fname)));
480 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
484 /* we don't recycle the recycle bin... */
485 if (strncmp(smb_fname->base_name, repository,
486 strlen(repository)) == 0) {
487 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
488 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
492 file_size = recycle_get_file_size(handle, smb_fname);
493 /* it is wrong to purge filenames only because they are empty imho
497 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
498 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
503 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
504 * not greater then maxsize, not the size of the single file, also it is better
505 * to remove older files
507 maxsize = recycle_maxsize(handle);
508 if(maxsize > 0 && file_size > maxsize) {
509 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
510 "purging... \n", smb_fname_str_dbg(smb_fname)));
511 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
514 minsize = recycle_minsize(handle);
515 if(minsize > 0 && file_size < minsize) {
516 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
517 "purging... \n", smb_fname_str_dbg(smb_fname)));
518 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
522 /* FIXME: this is wrong: moving files with rename does not change the disk space
525 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
526 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
527 if(space_avail < file_size) {
528 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
529 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
534 /* extract filename and path */
535 base = strrchr(smb_fname->base_name, '/');
537 base = smb_fname->base_name;
538 path_name = SMB_STRDUP("/");
539 ALLOC_CHECK(path_name, done);
542 path_name = SMB_STRDUP(smb_fname->base_name);
543 ALLOC_CHECK(path_name, done);
544 path_name[base - smb_fname->base_name] = '\0';
548 /* original filename with path */
549 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
551 DEBUG(10, ("recycle: fpath = %s\n", path_name));
552 /* filename without path */
553 DEBUG(10, ("recycle: base = %s\n", base));
555 if (matchparam(recycle_exclude(handle), base)) {
556 DEBUG(3, ("recycle: file %s is excluded \n", base));
557 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
561 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
562 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
563 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
567 if (recycle_keep_dir_tree(handle) == True) {
568 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
569 ALLOC_CHECK(temp_name, done);
572 temp_name = SMB_STRDUP(repository);
574 ALLOC_CHECK(temp_name, done);
576 exist = recycle_directory_exist(handle, temp_name);
578 DEBUG(10, ("recycle: Directory already exists\n"));
580 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
581 if (recycle_create_dir(handle, temp_name) == False) {
582 DEBUG(3, ("recycle: Could not create directory, "
584 smb_fname_str_dbg(smb_fname)));
585 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
590 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
591 ALLOC_CHECK(final_name, done);
594 /* Create smb_fname with final base name and orig stream name. */
595 status = create_synthetic_smb_fname(talloc_tos(), final_name,
596 smb_fname->stream_name, NULL,
598 if (!NT_STATUS_IS_OK(status)) {
599 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
603 /* new filename with path */
604 DEBUG(10, ("recycle: recycled file name: %s\n",
605 smb_fname_str_dbg(smb_fname_final)));
607 /* check if we should delete file from recycle bin */
608 if (recycle_file_exist(handle, smb_fname_final)) {
609 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
610 DEBUG(3, ("recycle: Removing old file %s from recycle "
611 "bin\n", smb_fname_str_dbg(smb_fname_final)));
612 if (SMB_VFS_NEXT_UNLINK(handle,
613 smb_fname_final) != 0) {
614 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
619 /* rename file we move to recycle bin */
621 while (recycle_file_exist(handle, smb_fname_final)) {
622 SAFE_FREE(final_name);
623 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
624 ALLOC_CHECK(final_name, done);
626 TALLOC_FREE(smb_fname_final->base_name);
627 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
629 if (smb_fname_final->base_name == NULL) {
630 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
635 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
636 smb_fname_str_dbg(smb_fname_final)));
637 rc = SMB_VFS_NEXT_RENAME(handle, smb_fname, smb_fname_final);
639 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
640 "(%s)\n", errno, strerror(errno),
641 smb_fname_str_dbg(smb_fname),
642 smb_fname_str_dbg(smb_fname_final)));
643 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
647 /* touch access date of moved file */
648 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
649 recycle_do_touch(handle, smb_fname_final,
650 recycle_touch_mtime(handle));
653 SAFE_FREE(path_name);
654 SAFE_FREE(temp_name);
655 SAFE_FREE(final_name);
656 TALLOC_FREE(smb_fname_final);
657 TALLOC_FREE(repository);
661 static struct vfs_fn_pointers vfs_recycle_fns = {
662 .connect_fn = recycle_connect,
663 .disconnect = recycle_disconnect,
664 .unlink = recycle_unlink
667 NTSTATUS vfs_recycle_init(void);
668 NTSTATUS vfs_recycle_init(void)
670 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
673 if (!NT_STATUS_IS_OK(ret))
676 vfs_recycle_debug_level = debug_add_class("recycle");
677 if (vfs_recycle_debug_level == -1) {
678 vfs_recycle_debug_level = DBGC_VFS;
679 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
681 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));