vfs: Convert recycle_file_exists to cp_smb_filename
[Samba/gebeck_regimport.git] / source3 / modules / vfs_recycle.c
blobddc76945df0e90b02da2603fa0dae483d17f81a7
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 SMB_STRUCT_STAT st;
191 if (vfs_stat_smb_fname(handle->conn, dname, &st) == 0) {
192 if (S_ISDIR(st.st_ex_mode)) {
193 return True;
197 return False;
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;
204 bool ret = false;
206 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
207 if (smb_fname_tmp == NULL) {
208 return false;
211 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
212 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
213 ret = true;
217 TALLOC_FREE(smb_fname_tmp);
218 return ret;
222 * Return file size
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;
231 NTSTATUS status;
232 off_t size;
234 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
235 if (!NT_STATUS_IS_OK(status)) {
236 size = (off_t)0;
237 goto out;
240 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
241 DEBUG(0,("recycle: stat for %s returned %s\n",
242 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
243 size = (off_t)0;
244 goto out;
247 size = smb_fname_tmp->st.st_ex_size;
248 out:
249 TALLOC_FREE(smb_fname_tmp);
250 return size;
254 * Create directory tree
255 * @param conn connection
256 * @param dname Directory tree to be created
257 * @return Returns True for success
259 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
261 size_t len;
262 mode_t mode;
263 char *new_dir = NULL;
264 char *tmp_str = NULL;
265 char *token;
266 char *tok_str;
267 bool ret = False;
268 char *saveptr;
270 mode = recycle_directory_mode(handle);
272 tmp_str = SMB_STRDUP(dname);
273 ALLOC_CHECK(tmp_str, done);
274 tok_str = tmp_str;
276 len = strlen(dname)+1;
277 new_dir = (char *)SMB_MALLOC(len + 1);
278 ALLOC_CHECK(new_dir, done);
279 *new_dir = '\0';
280 if (dname[0] == '/') {
281 /* Absolute path. */
282 if (strlcat(new_dir,"/",len+1) >= len+1) {
283 goto done;
287 /* Create directory tree if neccessary */
288 for(token = strtok_r(tok_str, "/", &saveptr); token;
289 token = strtok_r(NULL, "/", &saveptr)) {
290 if (strlcat(new_dir, token, len+1) >= len+1) {
291 goto done;
293 if (recycle_directory_exist(handle, new_dir))
294 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
295 else {
296 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
297 if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
298 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
299 ret = False;
300 goto done;
303 if (strlcat(new_dir, "/", len+1) >= len+1) {
304 goto done;
306 mode = recycle_subdir_mode(handle);
309 ret = True;
310 done:
311 SAFE_FREE(tmp_str);
312 SAFE_FREE(new_dir);
313 return ret;
317 * Check if any of the components of "exclude_list" are contained in path.
318 * Return True if found
321 static bool matchdirparam(const char **dir_exclude_list, char *path)
323 char *startp = NULL, *endp = NULL;
325 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
326 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
327 return False;
331 * Walk the components of path, looking for matches with the
332 * exclude list on each component.
335 for (startp = path; startp; startp = endp) {
336 int i;
338 while (*startp == '/') {
339 startp++;
341 endp = strchr(startp, '/');
342 if (endp) {
343 *endp = '\0';
346 for(i=0; dir_exclude_list[i] ; i++) {
347 if(unix_wild_match(dir_exclude_list[i], startp)) {
348 /* Repair path. */
349 if (endp) {
350 *endp = '/';
352 return True;
356 /* Repair path. */
357 if (endp) {
358 *endp = '/';
362 return False;
366 * Check if needle is contained in haystack, * and ? patterns are resolved
367 * @param haystack list of parameters separated by delimimiter character
368 * @param needle string to be matched exectly to haystack including pattern matching
369 * @return True if found
371 static bool matchparam(const char **haystack_list, const char *needle)
373 int i;
375 if (haystack_list == NULL || haystack_list[0] == NULL ||
376 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
377 return False;
380 for(i=0; haystack_list[i] ; i++) {
381 if(unix_wild_match(haystack_list[i], needle)) {
382 return True;
386 return False;
390 * Touch access or modify date
392 static void recycle_do_touch(vfs_handle_struct *handle,
393 const struct smb_filename *smb_fname,
394 bool touch_mtime)
396 struct smb_filename *smb_fname_tmp = NULL;
397 struct smb_file_time ft;
398 NTSTATUS status;
399 int ret, err;
401 ZERO_STRUCT(ft);
403 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
404 if (!NT_STATUS_IS_OK(status)) {
405 return;
408 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
409 DEBUG(0,("recycle: stat for %s returned %s\n",
410 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
411 goto out;
413 /* atime */
414 ft.atime = timespec_current();
415 /* mtime */
416 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
418 become_root();
419 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
420 err = errno;
421 unbecome_root();
422 if (ret == -1 ) {
423 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
424 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
426 out:
427 TALLOC_FREE(smb_fname_tmp);
431 * Check if file should be recycled
433 static int recycle_unlink(vfs_handle_struct *handle,
434 const struct smb_filename *smb_fname)
436 connection_struct *conn = handle->conn;
437 char *path_name = NULL;
438 char *temp_name = NULL;
439 char *final_name = NULL;
440 struct smb_filename *smb_fname_final = NULL;
441 const char *base;
442 char *repository = NULL;
443 int i = 1;
444 off_t maxsize, minsize;
445 off_t file_size; /* space_avail; */
446 bool exist;
447 NTSTATUS status;
448 int rc = -1;
450 repository = talloc_sub_advanced(NULL, lp_servicename(talloc_tos(), SNUM(conn)),
451 conn->session_info->unix_info->unix_name,
452 conn->connectpath,
453 conn->session_info->unix_token->gid,
454 conn->session_info->unix_info->sanitized_username,
455 conn->session_info->info->domain_name,
456 recycle_repository(handle));
457 ALLOC_CHECK(repository, done);
458 /* shouldn't we allow absolute path names here? --metze */
459 /* Yes :-). JRA. */
460 trim_char(repository, '\0', '/');
462 if(!repository || *(repository) == '\0') {
463 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
464 smb_fname_str_dbg(smb_fname)));
465 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
466 goto done;
469 /* we don't recycle the recycle bin... */
470 if (strncmp(smb_fname->base_name, repository,
471 strlen(repository)) == 0) {
472 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
473 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
474 goto done;
477 file_size = recycle_get_file_size(handle, smb_fname);
478 /* it is wrong to purge filenames only because they are empty imho
479 * --- simo
481 if(fsize == 0) {
482 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
483 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
484 goto done;
488 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
489 * not greater then maxsize, not the size of the single file, also it is better
490 * to remove older files
492 maxsize = recycle_maxsize(handle);
493 if(maxsize > 0 && file_size > maxsize) {
494 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
495 "purging... \n", smb_fname_str_dbg(smb_fname)));
496 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
497 goto done;
499 minsize = recycle_minsize(handle);
500 if(minsize > 0 && file_size < minsize) {
501 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
502 "purging... \n", smb_fname_str_dbg(smb_fname)));
503 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
504 goto done;
507 /* FIXME: this is wrong: moving files with rename does not change the disk space
508 * allocation
510 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
511 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
512 if(space_avail < file_size) {
513 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
514 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
515 goto done;
519 /* extract filename and path */
520 base = strrchr(smb_fname->base_name, '/');
521 if (base == NULL) {
522 base = smb_fname->base_name;
523 path_name = SMB_STRDUP("/");
524 ALLOC_CHECK(path_name, done);
526 else {
527 path_name = SMB_STRDUP(smb_fname->base_name);
528 ALLOC_CHECK(path_name, done);
529 path_name[base - smb_fname->base_name] = '\0';
530 base++;
533 /* original filename with path */
534 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
535 /* original path */
536 DEBUG(10, ("recycle: fpath = %s\n", path_name));
537 /* filename without path */
538 DEBUG(10, ("recycle: base = %s\n", base));
540 if (matchparam(recycle_exclude(handle), base)) {
541 DEBUG(3, ("recycle: file %s is excluded \n", base));
542 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
543 goto done;
546 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
547 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
548 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
549 goto done;
552 if (recycle_keep_dir_tree(handle) == True) {
553 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
554 ALLOC_CHECK(temp_name, done);
556 } else {
557 temp_name = SMB_STRDUP(repository);
559 ALLOC_CHECK(temp_name, done);
561 exist = recycle_directory_exist(handle, temp_name);
562 if (exist) {
563 DEBUG(10, ("recycle: Directory already exists\n"));
564 } else {
565 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
566 if (recycle_create_dir(handle, temp_name) == False) {
567 DEBUG(3, ("recycle: Could not create directory, "
568 "purging %s...\n",
569 smb_fname_str_dbg(smb_fname)));
570 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
571 goto done;
575 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
576 ALLOC_CHECK(final_name, done);
579 /* Create smb_fname with final base name and orig stream name. */
580 status = create_synthetic_smb_fname(talloc_tos(), final_name,
581 smb_fname->stream_name, NULL,
582 &smb_fname_final);
583 if (!NT_STATUS_IS_OK(status)) {
584 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
585 goto done;
588 /* new filename with path */
589 DEBUG(10, ("recycle: recycled file name: %s\n",
590 smb_fname_str_dbg(smb_fname_final)));
592 /* check if we should delete file from recycle bin */
593 if (recycle_file_exist(handle, smb_fname_final)) {
594 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
595 DEBUG(3, ("recycle: Removing old file %s from recycle "
596 "bin\n", smb_fname_str_dbg(smb_fname_final)));
597 if (SMB_VFS_NEXT_UNLINK(handle,
598 smb_fname_final) != 0) {
599 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
604 /* rename file we move to recycle bin */
605 i = 1;
606 while (recycle_file_exist(handle, smb_fname_final)) {
607 SAFE_FREE(final_name);
608 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
609 ALLOC_CHECK(final_name, done);
611 TALLOC_FREE(smb_fname_final->base_name);
612 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
613 final_name);
614 if (smb_fname_final->base_name == NULL) {
615 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
616 goto done;
620 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
621 smb_fname_str_dbg(smb_fname_final)));
622 rc = SMB_VFS_NEXT_RENAME(handle, smb_fname, smb_fname_final);
623 if (rc != 0) {
624 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
625 "(%s)\n", errno, strerror(errno),
626 smb_fname_str_dbg(smb_fname),
627 smb_fname_str_dbg(smb_fname_final)));
628 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
629 goto done;
632 /* touch access date of moved file */
633 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
634 recycle_do_touch(handle, smb_fname_final,
635 recycle_touch_mtime(handle));
637 done:
638 SAFE_FREE(path_name);
639 SAFE_FREE(temp_name);
640 SAFE_FREE(final_name);
641 TALLOC_FREE(smb_fname_final);
642 TALLOC_FREE(repository);
643 return rc;
646 static struct vfs_fn_pointers vfs_recycle_fns = {
647 .unlink_fn = recycle_unlink
650 NTSTATUS vfs_recycle_init(void);
651 NTSTATUS vfs_recycle_init(void)
653 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
654 &vfs_recycle_fns);
656 if (!NT_STATUS_IS_OK(ret))
657 return ret;
659 vfs_recycle_debug_level = debug_add_class("recycle");
660 if (vfs_recycle_debug_level == -1) {
661 vfs_recycle_debug_level = DBGC_VFS;
662 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
663 } else {
664 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
667 return ret;