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