vfs: Convert recycle_get_file_size to cp_smb_filename
[Samba.git] / source3 / modules / vfs_recycle.c
blob84a1cd89f9d751838b22274d2a11b66168ea5570
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 off_t size;
233 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
234 if (smb_fname_tmp == NULL) {
235 size = (off_t)0;
236 goto out;
239 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
240 DEBUG(0,("recycle: stat for %s returned %s\n",
241 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
242 size = (off_t)0;
243 goto out;
246 size = smb_fname_tmp->st.st_ex_size;
247 out:
248 TALLOC_FREE(smb_fname_tmp);
249 return size;
253 * Create directory tree
254 * @param conn connection
255 * @param dname Directory tree to be created
256 * @return Returns True for success
258 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
260 size_t len;
261 mode_t mode;
262 char *new_dir = NULL;
263 char *tmp_str = NULL;
264 char *token;
265 char *tok_str;
266 bool ret = False;
267 char *saveptr;
269 mode = recycle_directory_mode(handle);
271 tmp_str = SMB_STRDUP(dname);
272 ALLOC_CHECK(tmp_str, done);
273 tok_str = tmp_str;
275 len = strlen(dname)+1;
276 new_dir = (char *)SMB_MALLOC(len + 1);
277 ALLOC_CHECK(new_dir, done);
278 *new_dir = '\0';
279 if (dname[0] == '/') {
280 /* Absolute path. */
281 if (strlcat(new_dir,"/",len+1) >= len+1) {
282 goto done;
286 /* Create directory tree if neccessary */
287 for(token = strtok_r(tok_str, "/", &saveptr); token;
288 token = strtok_r(NULL, "/", &saveptr)) {
289 if (strlcat(new_dir, token, len+1) >= len+1) {
290 goto done;
292 if (recycle_directory_exist(handle, new_dir))
293 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
294 else {
295 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
296 if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
297 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
298 ret = False;
299 goto done;
302 if (strlcat(new_dir, "/", len+1) >= len+1) {
303 goto done;
305 mode = recycle_subdir_mode(handle);
308 ret = True;
309 done:
310 SAFE_FREE(tmp_str);
311 SAFE_FREE(new_dir);
312 return ret;
316 * Check if any of the components of "exclude_list" are contained in path.
317 * Return True if found
320 static bool matchdirparam(const char **dir_exclude_list, char *path)
322 char *startp = NULL, *endp = NULL;
324 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
325 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
326 return False;
330 * Walk the components of path, looking for matches with the
331 * exclude list on each component.
334 for (startp = path; startp; startp = endp) {
335 int i;
337 while (*startp == '/') {
338 startp++;
340 endp = strchr(startp, '/');
341 if (endp) {
342 *endp = '\0';
345 for(i=0; dir_exclude_list[i] ; i++) {
346 if(unix_wild_match(dir_exclude_list[i], startp)) {
347 /* Repair path. */
348 if (endp) {
349 *endp = '/';
351 return True;
355 /* Repair path. */
356 if (endp) {
357 *endp = '/';
361 return False;
365 * Check if needle is contained in haystack, * and ? patterns are resolved
366 * @param haystack list of parameters separated by delimimiter character
367 * @param needle string to be matched exectly to haystack including pattern matching
368 * @return True if found
370 static bool matchparam(const char **haystack_list, const char *needle)
372 int i;
374 if (haystack_list == NULL || haystack_list[0] == NULL ||
375 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
376 return False;
379 for(i=0; haystack_list[i] ; i++) {
380 if(unix_wild_match(haystack_list[i], needle)) {
381 return True;
385 return False;
389 * Touch access or modify date
391 static void recycle_do_touch(vfs_handle_struct *handle,
392 const struct smb_filename *smb_fname,
393 bool touch_mtime)
395 struct smb_filename *smb_fname_tmp = NULL;
396 struct smb_file_time ft;
397 NTSTATUS status;
398 int ret, err;
400 ZERO_STRUCT(ft);
402 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
403 if (!NT_STATUS_IS_OK(status)) {
404 return;
407 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
408 DEBUG(0,("recycle: stat for %s returned %s\n",
409 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
410 goto out;
412 /* atime */
413 ft.atime = timespec_current();
414 /* mtime */
415 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
417 become_root();
418 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
419 err = errno;
420 unbecome_root();
421 if (ret == -1 ) {
422 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
423 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
425 out:
426 TALLOC_FREE(smb_fname_tmp);
430 * Check if file should be recycled
432 static int recycle_unlink(vfs_handle_struct *handle,
433 const struct smb_filename *smb_fname)
435 connection_struct *conn = handle->conn;
436 char *path_name = NULL;
437 char *temp_name = NULL;
438 char *final_name = NULL;
439 struct smb_filename *smb_fname_final = NULL;
440 const char *base;
441 char *repository = NULL;
442 int i = 1;
443 off_t maxsize, minsize;
444 off_t file_size; /* space_avail; */
445 bool exist;
446 NTSTATUS status;
447 int rc = -1;
449 repository = talloc_sub_advanced(NULL, lp_servicename(talloc_tos(), SNUM(conn)),
450 conn->session_info->unix_info->unix_name,
451 conn->connectpath,
452 conn->session_info->unix_token->gid,
453 conn->session_info->unix_info->sanitized_username,
454 conn->session_info->info->domain_name,
455 recycle_repository(handle));
456 ALLOC_CHECK(repository, done);
457 /* shouldn't we allow absolute path names here? --metze */
458 /* Yes :-). JRA. */
459 trim_char(repository, '\0', '/');
461 if(!repository || *(repository) == '\0') {
462 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
463 smb_fname_str_dbg(smb_fname)));
464 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
465 goto done;
468 /* we don't recycle the recycle bin... */
469 if (strncmp(smb_fname->base_name, repository,
470 strlen(repository)) == 0) {
471 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
472 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
473 goto done;
476 file_size = recycle_get_file_size(handle, smb_fname);
477 /* it is wrong to purge filenames only because they are empty imho
478 * --- simo
480 if(fsize == 0) {
481 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
482 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
483 goto done;
487 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
488 * not greater then maxsize, not the size of the single file, also it is better
489 * to remove older files
491 maxsize = recycle_maxsize(handle);
492 if(maxsize > 0 && file_size > maxsize) {
493 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
494 "purging... \n", smb_fname_str_dbg(smb_fname)));
495 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
496 goto done;
498 minsize = recycle_minsize(handle);
499 if(minsize > 0 && file_size < minsize) {
500 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
501 "purging... \n", smb_fname_str_dbg(smb_fname)));
502 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
503 goto done;
506 /* FIXME: this is wrong: moving files with rename does not change the disk space
507 * allocation
509 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
510 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
511 if(space_avail < file_size) {
512 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
513 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
514 goto done;
518 /* extract filename and path */
519 base = strrchr(smb_fname->base_name, '/');
520 if (base == NULL) {
521 base = smb_fname->base_name;
522 path_name = SMB_STRDUP("/");
523 ALLOC_CHECK(path_name, done);
525 else {
526 path_name = SMB_STRDUP(smb_fname->base_name);
527 ALLOC_CHECK(path_name, done);
528 path_name[base - smb_fname->base_name] = '\0';
529 base++;
532 /* original filename with path */
533 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
534 /* original path */
535 DEBUG(10, ("recycle: fpath = %s\n", path_name));
536 /* filename without path */
537 DEBUG(10, ("recycle: base = %s\n", base));
539 if (matchparam(recycle_exclude(handle), base)) {
540 DEBUG(3, ("recycle: file %s is excluded \n", base));
541 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
542 goto done;
545 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
546 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
547 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
548 goto done;
551 if (recycle_keep_dir_tree(handle) == True) {
552 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
553 ALLOC_CHECK(temp_name, done);
555 } else {
556 temp_name = SMB_STRDUP(repository);
558 ALLOC_CHECK(temp_name, done);
560 exist = recycle_directory_exist(handle, temp_name);
561 if (exist) {
562 DEBUG(10, ("recycle: Directory already exists\n"));
563 } else {
564 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
565 if (recycle_create_dir(handle, temp_name) == False) {
566 DEBUG(3, ("recycle: Could not create directory, "
567 "purging %s...\n",
568 smb_fname_str_dbg(smb_fname)));
569 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
570 goto done;
574 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
575 ALLOC_CHECK(final_name, done);
578 /* Create smb_fname with final base name and orig stream name. */
579 status = create_synthetic_smb_fname(talloc_tos(), final_name,
580 smb_fname->stream_name, NULL,
581 &smb_fname_final);
582 if (!NT_STATUS_IS_OK(status)) {
583 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
584 goto done;
587 /* new filename with path */
588 DEBUG(10, ("recycle: recycled file name: %s\n",
589 smb_fname_str_dbg(smb_fname_final)));
591 /* check if we should delete file from recycle bin */
592 if (recycle_file_exist(handle, smb_fname_final)) {
593 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
594 DEBUG(3, ("recycle: Removing old file %s from recycle "
595 "bin\n", smb_fname_str_dbg(smb_fname_final)));
596 if (SMB_VFS_NEXT_UNLINK(handle,
597 smb_fname_final) != 0) {
598 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
603 /* rename file we move to recycle bin */
604 i = 1;
605 while (recycle_file_exist(handle, smb_fname_final)) {
606 SAFE_FREE(final_name);
607 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
608 ALLOC_CHECK(final_name, done);
610 TALLOC_FREE(smb_fname_final->base_name);
611 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
612 final_name);
613 if (smb_fname_final->base_name == NULL) {
614 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
615 goto done;
619 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
620 smb_fname_str_dbg(smb_fname_final)));
621 rc = SMB_VFS_NEXT_RENAME(handle, smb_fname, smb_fname_final);
622 if (rc != 0) {
623 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
624 "(%s)\n", errno, strerror(errno),
625 smb_fname_str_dbg(smb_fname),
626 smb_fname_str_dbg(smb_fname_final)));
627 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
628 goto done;
631 /* touch access date of moved file */
632 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
633 recycle_do_touch(handle, smb_fname_final,
634 recycle_touch_mtime(handle));
636 done:
637 SAFE_FREE(path_name);
638 SAFE_FREE(temp_name);
639 SAFE_FREE(final_name);
640 TALLOC_FREE(smb_fname_final);
641 TALLOC_FREE(repository);
642 return rc;
645 static struct vfs_fn_pointers vfs_recycle_fns = {
646 .unlink_fn = recycle_unlink
649 NTSTATUS vfs_recycle_init(void);
650 NTSTATUS vfs_recycle_init(void)
652 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
653 &vfs_recycle_fns);
655 if (!NT_STATUS_IS_OK(ret))
656 return ret;
658 vfs_recycle_debug_level = debug_add_class("recycle");
659 if (vfs_recycle_debug_level == -1) {
660 vfs_recycle_debug_level = DBGC_VFS;
661 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
662 } else {
663 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
666 return ret;