source: vendor/3.5.0/source3/modules/vfs_recycle.c

Last change on this file was 414, checked in by Herwig Bauernfeind, 15 years ago

Samba 3.5.0: Initial import
File size: 17.6 KB
Line 
1/*
2 * Recycle bin VFS module for Samba.
3 *
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
10 *
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.
15 *
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.
20 *
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/>.
23 */
24
25#include "includes.h"
26
27#define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
28
29static int vfs_recycle_debug_level = DBGC_VFS;
30
31#undef DBGC_CLASS
32#define DBGC_CLASS vfs_recycle_debug_level
33
34static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user);
35static void recycle_disconnect(vfs_handle_struct *handle);
36static int recycle_unlink(vfs_handle_struct *handle,
37 const struct smb_filename *smb_fname);
38
39static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user)
40{
41 int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
42
43 if (ret < 0) {
44 return ret;
45 }
46
47 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
48 service,user));
49
50 return 0;
51}
52
53static void recycle_disconnect(vfs_handle_struct *handle)
54{
55 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
56 lp_servicename(SNUM(handle->conn))));
57
58 SMB_VFS_NEXT_DISCONNECT(handle);
59}
60
61static const char *recycle_repository(vfs_handle_struct *handle)
62{
63 const char *tmp_str = NULL;
64
65
66 tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
67
68 DEBUG(10, ("recycle: repository = %s\n", tmp_str));
69
70 return tmp_str;
71}
72
73static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
74{
75 bool ret;
76
77 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
78
79 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
80
81 return ret;
82}
83
84static bool recycle_versions(vfs_handle_struct *handle)
85{
86 bool ret;
87
88 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
89
90 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
91
92 return ret;
93}
94
95static bool recycle_touch(vfs_handle_struct *handle)
96{
97 bool ret;
98
99 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
100
101 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
102
103 return ret;
104}
105
106static bool recycle_touch_mtime(vfs_handle_struct *handle)
107{
108 bool ret;
109
110 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
111
112 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
113
114 return ret;
115}
116
117static const char **recycle_exclude(vfs_handle_struct *handle)
118{
119 const char **tmp_lp;
120
121 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
122
123 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
124
125 return tmp_lp;
126}
127
128static const char **recycle_exclude_dir(vfs_handle_struct *handle)
129{
130 const char **tmp_lp;
131
132 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
133
134 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
135
136 return tmp_lp;
137}
138
139static const char **recycle_noversions(vfs_handle_struct *handle)
140{
141 const char **tmp_lp;
142
143 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
144
145 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
146
147 return tmp_lp;
148}
149
150static SMB_OFF_T recycle_maxsize(vfs_handle_struct *handle)
151{
152 SMB_OFF_T maxsize;
153
154 maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
155 "recycle", "maxsize", NULL));
156
157 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize));
158
159 return maxsize;
160}
161
162static SMB_OFF_T recycle_minsize(vfs_handle_struct *handle)
163{
164 SMB_OFF_T minsize;
165
166 minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
167 "recycle", "minsize", NULL));
168
169 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
170
171 return minsize;
172}
173
174static mode_t recycle_directory_mode(vfs_handle_struct *handle)
175{
176 int dirmode;
177 const char *buff;
178
179 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
180
181 if (buff != NULL ) {
182 sscanf(buff, "%o", &dirmode);
183 } else {
184 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
185 }
186
187 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
188 return (mode_t)dirmode;
189}
190
191static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
192{
193 int dirmode;
194 const char *buff;
195
196 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
197
198 if (buff != NULL ) {
199 sscanf(buff, "%o", &dirmode);
200 } else {
201 dirmode=recycle_directory_mode(handle);
202 }
203
204 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
205 return (mode_t)dirmode;
206}
207
208static bool recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
209{
210 SMB_STRUCT_STAT st;
211
212 if (vfs_stat_smb_fname(handle->conn, dname, &st) == 0) {
213 if (S_ISDIR(st.st_ex_mode)) {
214 return True;
215 }
216 }
217
218 return False;
219}
220
221static bool recycle_file_exist(vfs_handle_struct *handle,
222 const struct smb_filename *smb_fname)
223{
224 struct smb_filename *smb_fname_tmp = NULL;
225 NTSTATUS status;
226 bool ret = false;
227
228 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
229 if (!NT_STATUS_IS_OK(status)) {
230 return false;
231 }
232
233 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
234 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
235 ret = true;
236 }
237 }
238
239 TALLOC_FREE(smb_fname_tmp);
240 return ret;
241}
242
243/**
244 * Return file size
245 * @param conn connection
246 * @param fname file name
247 * @return size in bytes
248 **/
249static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle,
250 const struct smb_filename *smb_fname)
251{
252 struct smb_filename *smb_fname_tmp = NULL;
253 NTSTATUS status;
254 SMB_OFF_T size;
255
256 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
257 if (!NT_STATUS_IS_OK(status)) {
258 size = (SMB_OFF_T)0;
259 goto out;
260 }
261
262 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
263 DEBUG(0,("recycle: stat for %s returned %s\n",
264 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
265 size = (SMB_OFF_T)0;
266 goto out;
267 }
268
269 size = smb_fname_tmp->st.st_ex_size;
270 out:
271 TALLOC_FREE(smb_fname_tmp);
272 return size;
273}
274
275/**
276 * Create directory tree
277 * @param conn connection
278 * @param dname Directory tree to be created
279 * @return Returns True for success
280 **/
281static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
282{
283 size_t len;
284 mode_t mode;
285 char *new_dir = NULL;
286 char *tmp_str = NULL;
287 char *token;
288 char *tok_str;
289 bool ret = False;
290 char *saveptr;
291
292 mode = recycle_directory_mode(handle);
293
294 tmp_str = SMB_STRDUP(dname);
295 ALLOC_CHECK(tmp_str, done);
296 tok_str = tmp_str;
297
298 len = strlen(dname)+1;
299 new_dir = (char *)SMB_MALLOC(len + 1);
300 ALLOC_CHECK(new_dir, done);
301 *new_dir = '\0';
302 if (dname[0] == '/') {
303 /* Absolute path. */
304 safe_strcat(new_dir,"/",len);
305 }
306
307 /* Create directory tree if neccessary */
308 for(token = strtok_r(tok_str, "/", &saveptr); token;
309 token = strtok_r(NULL, "/", &saveptr)) {
310 safe_strcat(new_dir, token, len);
311 if (recycle_directory_exist(handle, new_dir))
312 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
313 else {
314 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
315 if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
316 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
317 ret = False;
318 goto done;
319 }
320 }
321 safe_strcat(new_dir, "/", len);
322 mode = recycle_subdir_mode(handle);
323 }
324
325 ret = True;
326done:
327 SAFE_FREE(tmp_str);
328 SAFE_FREE(new_dir);
329 return ret;
330}
331
332/**
333 * Check if any of the components of "exclude_list" are contained in path.
334 * Return True if found
335 **/
336
337static bool matchdirparam(const char **dir_exclude_list, char *path)
338{
339 char *startp = NULL, *endp = NULL;
340
341 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
342 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
343 return False;
344 }
345
346 /*
347 * Walk the components of path, looking for matches with the
348 * exclude list on each component.
349 */
350
351 for (startp = path; startp; startp = endp) {
352 int i;
353
354 while (*startp == '/') {
355 startp++;
356 }
357 endp = strchr(startp, '/');
358 if (endp) {
359 *endp = '\0';
360 }
361
362 for(i=0; dir_exclude_list[i] ; i++) {
363 if(unix_wild_match(dir_exclude_list[i], startp)) {
364 /* Repair path. */
365 if (endp) {
366 *endp = '/';
367 }
368 return True;
369 }
370 }
371
372 /* Repair path. */
373 if (endp) {
374 *endp = '/';
375 }
376 }
377
378 return False;
379}
380
381/**
382 * Check if needle is contained in haystack, * and ? patterns are resolved
383 * @param haystack list of parameters separated by delimimiter character
384 * @param needle string to be matched exectly to haystack including pattern matching
385 * @return True if found
386 **/
387static bool matchparam(const char **haystack_list, const char *needle)
388{
389 int i;
390
391 if (haystack_list == NULL || haystack_list[0] == NULL ||
392 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
393 return False;
394 }
395
396 for(i=0; haystack_list[i] ; i++) {
397 if(unix_wild_match(haystack_list[i], needle)) {
398 return True;
399 }
400 }
401
402 return False;
403}
404
405/**
406 * Touch access or modify date
407 **/
408static void recycle_do_touch(vfs_handle_struct *handle,
409 const struct smb_filename *smb_fname,
410 bool touch_mtime)
411{
412 struct smb_filename *smb_fname_tmp = NULL;
413 struct smb_file_time ft;
414 NTSTATUS status;
415 int ret, err;
416
417 ZERO_STRUCT(ft);
418
419 status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
420 if (!NT_STATUS_IS_OK(status)) {
421 return;
422 }
423
424 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
425 DEBUG(0,("recycle: stat for %s returned %s\n",
426 smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
427 goto out;
428 }
429 /* atime */
430 ft.atime = timespec_current();
431 /* mtime */
432 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
433
434 become_root();
435 ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
436 err = errno;
437 unbecome_root();
438 if (ret == -1 ) {
439 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
440 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
441 }
442 out:
443 TALLOC_FREE(smb_fname_tmp);
444}
445
446/**
447 * Check if file should be recycled
448 **/
449static int recycle_unlink(vfs_handle_struct *handle,
450 const struct smb_filename *smb_fname)
451{
452 connection_struct *conn = handle->conn;
453 char *path_name = NULL;
454 char *temp_name = NULL;
455 char *final_name = NULL;
456 struct smb_filename *smb_fname_final = NULL;
457 const char *base;
458 char *repository = NULL;
459 int i = 1;
460 SMB_OFF_T maxsize, minsize;
461 SMB_OFF_T file_size; /* space_avail; */
462 bool exist;
463 NTSTATUS status;
464 int rc = -1;
465
466 repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
467 conn->server_info->unix_name,
468 conn->connectpath,
469 conn->server_info->utok.gid,
470 conn->server_info->sanitized_username,
471 pdb_get_domain(conn->server_info->sam_account),
472 recycle_repository(handle));
473 ALLOC_CHECK(repository, done);
474 /* shouldn't we allow absolute path names here? --metze */
475 /* Yes :-). JRA. */
476 trim_char(repository, '\0', '/');
477
478 if(!repository || *(repository) == '\0') {
479 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
480 smb_fname_str_dbg(smb_fname)));
481 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
482 goto done;
483 }
484
485 /* we don't recycle the recycle bin... */
486 if (strncmp(smb_fname->base_name, repository,
487 strlen(repository)) == 0) {
488 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
489 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
490 goto done;
491 }
492
493 file_size = recycle_get_file_size(handle, smb_fname);
494 /* it is wrong to purge filenames only because they are empty imho
495 * --- simo
496 *
497 if(fsize == 0) {
498 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
499 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
500 goto done;
501 }
502 */
503
504 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
505 * not greater then maxsize, not the size of the single file, also it is better
506 * to remove older files
507 */
508 maxsize = recycle_maxsize(handle);
509 if(maxsize > 0 && file_size > maxsize) {
510 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
511 "purging... \n", smb_fname_str_dbg(smb_fname)));
512 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
513 goto done;
514 }
515 minsize = recycle_minsize(handle);
516 if(minsize > 0 && file_size < minsize) {
517 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
518 "purging... \n", smb_fname_str_dbg(smb_fname)));
519 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
520 goto done;
521 }
522
523 /* FIXME: this is wrong: moving files with rename does not change the disk space
524 * allocation
525 *
526 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
527 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
528 if(space_avail < file_size) {
529 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
530 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
531 goto done;
532 }
533 */
534
535 /* extract filename and path */
536 base = strrchr(smb_fname->base_name, '/');
537 if (base == NULL) {
538 base = smb_fname->base_name;
539 path_name = SMB_STRDUP("/");
540 ALLOC_CHECK(path_name, done);
541 }
542 else {
543 path_name = SMB_STRDUP(smb_fname->base_name);
544 ALLOC_CHECK(path_name, done);
545 path_name[base - smb_fname->base_name] = '\0';
546 base++;
547 }
548
549 /* original filename with path */
550 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
551 /* original path */
552 DEBUG(10, ("recycle: fpath = %s\n", path_name));
553 /* filename without path */
554 DEBUG(10, ("recycle: base = %s\n", base));
555
556 if (matchparam(recycle_exclude(handle), base)) {
557 DEBUG(3, ("recycle: file %s is excluded \n", base));
558 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
559 goto done;
560 }
561
562 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
563 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
564 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
565 goto done;
566 }
567
568 if (recycle_keep_dir_tree(handle) == True) {
569 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
570 ALLOC_CHECK(temp_name, done);
571 }
572 } else {
573 temp_name = SMB_STRDUP(repository);
574 }
575 ALLOC_CHECK(temp_name, done);
576
577 exist = recycle_directory_exist(handle, temp_name);
578 if (exist) {
579 DEBUG(10, ("recycle: Directory already exists\n"));
580 } else {
581 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
582 if (recycle_create_dir(handle, temp_name) == False) {
583 DEBUG(3, ("recycle: Could not create directory, "
584 "purging %s...\n",
585 smb_fname_str_dbg(smb_fname)));
586 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
587 goto done;
588 }
589 }
590
591 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
592 ALLOC_CHECK(final_name, done);
593 }
594
595 /* Create smb_fname with final base name and orig stream name. */
596 status = create_synthetic_smb_fname(talloc_tos(), final_name,
597 smb_fname->stream_name, NULL,
598 &smb_fname_final);
599 if (!NT_STATUS_IS_OK(status)) {
600 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
601 goto done;
602 }
603
604 /* new filename with path */
605 DEBUG(10, ("recycle: recycled file name: %s\n",
606 smb_fname_str_dbg(smb_fname_final)));
607
608 /* check if we should delete file from recycle bin */
609 if (recycle_file_exist(handle, smb_fname_final)) {
610 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
611 DEBUG(3, ("recycle: Removing old file %s from recycle "
612 "bin\n", smb_fname_str_dbg(smb_fname_final)));
613 if (SMB_VFS_NEXT_UNLINK(handle,
614 smb_fname_final) != 0) {
615 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
616 }
617 }
618 }
619
620 /* rename file we move to recycle bin */
621 i = 1;
622 while (recycle_file_exist(handle, smb_fname_final)) {
623 SAFE_FREE(final_name);
624 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
625 ALLOC_CHECK(final_name, done);
626 }
627 TALLOC_FREE(smb_fname_final->base_name);
628 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
629 final_name);
630 if (smb_fname_final->base_name == NULL) {
631 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
632 goto done;
633 }
634 }
635
636 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
637 smb_fname_str_dbg(smb_fname_final)));
638 rc = SMB_VFS_NEXT_RENAME(handle, smb_fname, smb_fname_final);
639 if (rc != 0) {
640 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
641 "(%s)\n", errno, strerror(errno),
642 smb_fname_str_dbg(smb_fname),
643 smb_fname_str_dbg(smb_fname_final)));
644 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
645 goto done;
646 }
647
648 /* touch access date of moved file */
649 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
650 recycle_do_touch(handle, smb_fname_final,
651 recycle_touch_mtime(handle));
652
653done:
654 SAFE_FREE(path_name);
655 SAFE_FREE(temp_name);
656 SAFE_FREE(final_name);
657 TALLOC_FREE(smb_fname_final);
658 TALLOC_FREE(repository);
659 return rc;
660}
661
662static struct vfs_fn_pointers vfs_recycle_fns = {
663 .connect_fn = recycle_connect,
664 .disconnect = recycle_disconnect,
665 .unlink = recycle_unlink
666};
667
668NTSTATUS vfs_recycle_init(void);
669NTSTATUS vfs_recycle_init(void)
670{
671 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
672 &vfs_recycle_fns);
673
674 if (!NT_STATUS_IS_OK(ret))
675 return ret;
676
677 vfs_recycle_debug_level = debug_add_class("recycle");
678 if (vfs_recycle_debug_level == -1) {
679 vfs_recycle_debug_level = DBGC_VFS;
680 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
681 } else {
682 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
683 }
684
685 return ret;
686}
Note: See TracBrowser for help on using the repository browser.