WHATSNEW: Add release notes for Samba 4.9.17.
[Samba.git] / source3 / modules / vfs_recycle.c
blobe84f0351c871da88be72d8c1e5a4535daa7b99b0
1 /*
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/>.
25 #include "includes.h"
26 #include "smbd/smbd.h"
27 #include "system/filesys.h"
28 #include "../librpc/gen_ndr/ndr_netlogon.h"
29 #include "auth.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;
35 #undef DBGC_CLASS
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));
49 return tmp_str;
52 static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
54 bool ret;
56 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
58 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
60 return ret;
63 static bool recycle_versions(vfs_handle_struct *handle)
65 bool ret;
67 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
69 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
71 return ret;
74 static bool recycle_touch(vfs_handle_struct *handle)
76 bool ret;
78 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
80 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
82 return ret;
85 static bool recycle_touch_mtime(vfs_handle_struct *handle)
87 bool ret;
89 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
91 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
93 return ret;
96 static const char **recycle_exclude(vfs_handle_struct *handle)
98 const char **tmp_lp;
100 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
102 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
104 return tmp_lp;
107 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
109 const char **tmp_lp;
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:""));
115 return tmp_lp;
118 static const char **recycle_noversions(vfs_handle_struct *handle)
120 const char **tmp_lp;
122 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
124 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
126 return tmp_lp;
129 static off_t recycle_maxsize(vfs_handle_struct *handle)
131 off_t maxsize;
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));
138 return maxsize;
141 static off_t recycle_minsize(vfs_handle_struct *handle)
143 off_t minsize;
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));
150 return minsize;
153 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
155 int dirmode;
156 const char *buff;
158 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
160 if (buff != NULL ) {
161 sscanf(buff, "%o", &dirmode);
162 } else {
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)
172 int dirmode;
173 const char *buff;
175 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
177 if (buff != NULL ) {
178 sscanf(buff, "%o", &dirmode);
179 } else {
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)
189 struct smb_filename smb_fname = {
190 .base_name = discard_const_p(char, dname)
193 if (SMB_VFS_STAT(handle->conn, &smb_fname) == 0) {
194 if (S_ISDIR(smb_fname.st.st_ex_mode)) {
195 return True;
199 return False;
202 static bool recycle_file_exist(vfs_handle_struct *handle,
203 const struct smb_filename *smb_fname)
205 struct smb_filename *smb_fname_tmp = NULL;
206 bool ret = false;
208 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
209 if (smb_fname_tmp == NULL) {
210 return false;
213 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
214 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
215 ret = true;
219 TALLOC_FREE(smb_fname_tmp);
220 return ret;
224 * Return file size
225 * @param conn connection
226 * @param fname file name
227 * @return size in bytes
229 static off_t recycle_get_file_size(vfs_handle_struct *handle,
230 const struct smb_filename *smb_fname)
232 struct smb_filename *smb_fname_tmp = NULL;
233 off_t size;
235 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
236 if (smb_fname_tmp == NULL) {
237 size = (off_t)0;
238 goto out;
241 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
242 DEBUG(0,("recycle: stat for %s returned %s\n",
243 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
244 size = (off_t)0;
245 goto out;
248 size = smb_fname_tmp->st.st_ex_size;
249 out:
250 TALLOC_FREE(smb_fname_tmp);
251 return size;
255 * Create directory tree
256 * @param conn connection
257 * @param dname Directory tree to be created
258 * @return Returns True for success
260 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
262 size_t len;
263 mode_t mode;
264 char *new_dir = NULL;
265 char *tmp_str = NULL;
266 char *token;
267 char *tok_str;
268 bool ret = False;
269 char *saveptr;
271 mode = recycle_directory_mode(handle);
273 tmp_str = SMB_STRDUP(dname);
274 ALLOC_CHECK(tmp_str, done);
275 tok_str = tmp_str;
277 len = strlen(dname)+1;
278 new_dir = (char *)SMB_MALLOC(len + 1);
279 ALLOC_CHECK(new_dir, done);
280 *new_dir = '\0';
281 if (dname[0] == '/') {
282 /* Absolute path. */
283 if (strlcat(new_dir,"/",len+1) >= len+1) {
284 goto done;
288 /* Create directory tree if neccessary */
289 for(token = strtok_r(tok_str, "/", &saveptr); token;
290 token = strtok_r(NULL, "/", &saveptr)) {
291 if (strlcat(new_dir, token, len+1) >= len+1) {
292 goto done;
294 if (recycle_directory_exist(handle, new_dir))
295 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
296 else {
297 struct smb_filename *smb_fname = NULL;
299 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
301 smb_fname = synthetic_smb_fname(talloc_tos(),
302 new_dir,
303 NULL,
304 NULL,
306 if (smb_fname == NULL) {
307 goto done;
310 if (SMB_VFS_NEXT_MKDIR(handle, smb_fname, mode) != 0) {
311 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
312 TALLOC_FREE(smb_fname);
313 ret = False;
314 goto done;
316 TALLOC_FREE(smb_fname);
318 if (strlcat(new_dir, "/", len+1) >= len+1) {
319 goto done;
321 mode = recycle_subdir_mode(handle);
324 ret = True;
325 done:
326 SAFE_FREE(tmp_str);
327 SAFE_FREE(new_dir);
328 return ret;
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') {
342 return False;
346 * Walk the components of path, looking for matches with the
347 * exclude list on each component.
350 for (startp = path; startp; startp = endp) {
351 int i;
353 while (*startp == '/') {
354 startp++;
356 endp = strchr(startp, '/');
357 if (endp) {
358 *endp = '\0';
361 for(i=0; dir_exclude_list[i] ; i++) {
362 if(unix_wild_match(dir_exclude_list[i], startp)) {
363 /* Repair path. */
364 if (endp) {
365 *endp = '/';
367 return True;
371 /* Repair path. */
372 if (endp) {
373 *endp = '/';
377 return False;
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)
388 int i;
390 if (haystack_list == NULL || haystack_list[0] == NULL ||
391 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
392 return False;
395 for(i=0; haystack_list[i] ; i++) {
396 if(unix_wild_match(haystack_list[i], needle)) {
397 return True;
401 return False;
405 * Touch access or modify date
407 static void recycle_do_touch(vfs_handle_struct *handle,
408 const struct smb_filename *smb_fname,
409 bool touch_mtime)
411 struct smb_filename *smb_fname_tmp = NULL;
412 struct smb_file_time ft;
413 int ret, err;
415 ZERO_STRUCT(ft);
417 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
418 if (smb_fname_tmp == NULL) {
419 return;
422 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
423 DEBUG(0,("recycle: stat for %s returned %s\n",
424 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
425 goto out;
427 /* atime */
428 ft.atime = timespec_current();
429 /* mtime */
430 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
432 become_root();
433 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
434 err = errno;
435 unbecome_root();
436 if (ret == -1 ) {
437 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
438 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
440 out:
441 TALLOC_FREE(smb_fname_tmp);
445 * Check if file should be recycled
447 static int recycle_unlink(vfs_handle_struct *handle,
448 const struct smb_filename *smb_fname)
450 connection_struct *conn = handle->conn;
451 char *path_name = NULL;
452 char *temp_name = NULL;
453 char *final_name = NULL;
454 struct smb_filename *smb_fname_final = NULL;
455 const char *base;
456 char *repository = NULL;
457 int i = 1;
458 off_t maxsize, minsize;
459 off_t file_size; /* space_avail; */
460 bool exist;
461 int rc = -1;
463 repository = talloc_sub_advanced(NULL, lp_servicename(talloc_tos(), SNUM(conn)),
464 conn->session_info->unix_info->unix_name,
465 conn->connectpath,
466 conn->session_info->unix_token->gid,
467 conn->session_info->unix_info->sanitized_username,
468 conn->session_info->info->domain_name,
469 recycle_repository(handle));
470 ALLOC_CHECK(repository, done);
471 /* shouldn't we allow absolute path names here? --metze */
472 /* Yes :-). JRA. */
473 trim_char(repository, '\0', '/');
475 if(!repository || *(repository) == '\0') {
476 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
477 smb_fname_str_dbg(smb_fname)));
478 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
479 goto done;
482 /* we don't recycle the recycle bin... */
483 if (strncmp(smb_fname->base_name, repository,
484 strlen(repository)) == 0) {
485 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
486 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
487 goto done;
490 file_size = recycle_get_file_size(handle, smb_fname);
491 /* it is wrong to purge filenames only because they are empty imho
492 * --- simo
494 if(fsize == 0) {
495 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
496 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
497 goto done;
501 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
502 * not greater then maxsize, not the size of the single file, also it is better
503 * to remove older files
505 maxsize = recycle_maxsize(handle);
506 if(maxsize > 0 && file_size > maxsize) {
507 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
508 "purging... \n", smb_fname_str_dbg(smb_fname)));
509 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
510 goto done;
512 minsize = recycle_minsize(handle);
513 if(minsize > 0 && file_size < minsize) {
514 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
515 "purging... \n", smb_fname_str_dbg(smb_fname)));
516 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
517 goto done;
520 /* FIXME: this is wrong: moving files with rename does not change the disk space
521 * allocation
523 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
524 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
525 if(space_avail < file_size) {
526 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
527 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
528 goto done;
532 /* extract filename and path */
533 base = strrchr(smb_fname->base_name, '/');
534 if (base == NULL) {
535 base = smb_fname->base_name;
536 path_name = SMB_STRDUP("/");
537 ALLOC_CHECK(path_name, done);
539 else {
540 path_name = SMB_STRDUP(smb_fname->base_name);
541 ALLOC_CHECK(path_name, done);
542 path_name[base - smb_fname->base_name] = '\0';
543 base++;
546 /* original filename with path */
547 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
548 /* original path */
549 DEBUG(10, ("recycle: fpath = %s\n", path_name));
550 /* filename without path */
551 DEBUG(10, ("recycle: base = %s\n", base));
553 if (matchparam(recycle_exclude(handle), base)) {
554 DEBUG(3, ("recycle: file %s is excluded \n", base));
555 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
556 goto done;
559 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
560 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
561 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
562 goto done;
565 if (recycle_keep_dir_tree(handle) == True) {
566 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
567 ALLOC_CHECK(temp_name, done);
569 } else {
570 temp_name = SMB_STRDUP(repository);
572 ALLOC_CHECK(temp_name, done);
574 exist = recycle_directory_exist(handle, temp_name);
575 if (exist) {
576 DEBUG(10, ("recycle: Directory already exists\n"));
577 } else {
578 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
579 if (recycle_create_dir(handle, temp_name) == False) {
580 DEBUG(3, ("recycle: Could not create directory, "
581 "purging %s...\n",
582 smb_fname_str_dbg(smb_fname)));
583 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
584 goto done;
588 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
589 ALLOC_CHECK(final_name, done);
592 /* Create smb_fname with final base name and orig stream name. */
593 smb_fname_final = synthetic_smb_fname(talloc_tos(),
594 final_name,
595 smb_fname->stream_name,
596 NULL,
597 smb_fname->flags);
598 if (smb_fname_final == NULL) {
599 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
600 goto done;
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 */
620 i = 1;
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,
628 final_name);
629 if (smb_fname_final->base_name == NULL) {
630 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
631 goto done;
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);
638 if (rc != 0) {
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);
644 goto done;
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));
652 done:
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);
658 return rc;
661 static struct vfs_fn_pointers vfs_recycle_fns = {
662 .unlink_fn = recycle_unlink
665 static_decl_vfs;
666 NTSTATUS vfs_recycle_init(TALLOC_CTX *ctx)
668 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
669 &vfs_recycle_fns);
671 if (!NT_STATUS_IS_OK(ret))
672 return ret;
674 vfs_recycle_debug_level = debug_add_class("recycle");
675 if (vfs_recycle_debug_level == -1) {
676 vfs_recycle_debug_level = DBGC_VFS;
677 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
678 } else {
679 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
682 return ret;