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 2 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, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
30 static int vfs_recycle_debug_level = DBGC_VFS;
33 #define DBGC_CLASS vfs_recycle_debug_level
35 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user);
36 static void recycle_disconnect(vfs_handle_struct *handle);
37 static int recycle_unlink(vfs_handle_struct *handle, const char *name);
39 static vfs_op_tuple recycle_ops[] = {
42 {SMB_VFS_OP(recycle_connect), SMB_VFS_OP_CONNECT, SMB_VFS_LAYER_TRANSPARENT},
43 {SMB_VFS_OP(recycle_disconnect), SMB_VFS_OP_DISCONNECT, SMB_VFS_LAYER_TRANSPARENT},
46 {SMB_VFS_OP(recycle_unlink), SMB_VFS_OP_UNLINK, SMB_VFS_LAYER_TRANSPARENT},
48 {SMB_VFS_OP(NULL), SMB_VFS_OP_NOOP, SMB_VFS_LAYER_NOOP}
51 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user)
53 DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
56 return SMB_VFS_NEXT_CONNECT(handle, service, user);
59 static void recycle_disconnect(vfs_handle_struct *handle)
61 DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
62 lp_servicename(SNUM(handle->conn))));
64 SMB_VFS_NEXT_DISCONNECT(handle);
67 static const char *recycle_repository(vfs_handle_struct *handle)
69 const char *tmp_str = NULL;
72 tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
74 DEBUG(10, ("recycle: repository = %s\n", tmp_str));
79 static BOOL recycle_keep_dir_tree(vfs_handle_struct *handle)
83 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
85 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
90 static BOOL recycle_versions(vfs_handle_struct *handle)
94 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
96 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
101 static BOOL recycle_touch(vfs_handle_struct *handle)
105 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
107 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
112 static BOOL recycle_touch_mtime(vfs_handle_struct *handle)
116 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
118 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
123 static const char **recycle_exclude(vfs_handle_struct *handle)
127 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
129 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
134 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
138 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
140 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
145 static const char **recycle_noversions(vfs_handle_struct *handle)
149 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
151 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
156 static SMB_OFF_T recycle_maxsize(vfs_handle_struct *handle)
160 maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
161 "recycle", "maxsize", NULL));
163 DEBUG(10, ("recycle: maxsize = %lu\n", maxsize));
168 static SMB_OFF_T recycle_minsize(vfs_handle_struct *handle)
172 minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
173 "recycle", "minsize", NULL));
175 DEBUG(10, ("recycle: minsize = %lu\n", minsize));
180 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
185 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
188 sscanf(buff, "%o", &dirmode);
190 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
193 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
194 return (mode_t)dirmode;
197 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
202 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
205 sscanf(buff, "%o", &dirmode);
207 dirmode=recycle_directory_mode(handle);
210 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
211 return (mode_t)dirmode;
214 static BOOL recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
218 if (SMB_VFS_NEXT_STAT(handle, dname, &st) == 0) {
219 if (S_ISDIR(st.st_mode)) {
227 static BOOL recycle_file_exist(vfs_handle_struct *handle, const char *fname)
231 if (SMB_VFS_NEXT_STAT(handle, fname, &st) == 0) {
232 if (S_ISREG(st.st_mode)) {
242 * @param conn connection
243 * @param fname file name
244 * @return size in bytes
246 static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle, const char *fname)
250 if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
251 DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
259 * Create directory tree
260 * @param conn connection
261 * @param dname Directory tree to be created
262 * @return Returns True for success
264 static BOOL recycle_create_dir(vfs_handle_struct *handle, const char *dname)
268 char *new_dir = NULL;
269 char *tmp_str = NULL;
274 mode = recycle_directory_mode(handle);
276 tmp_str = SMB_STRDUP(dname);
277 ALLOC_CHECK(tmp_str, done);
280 len = strlen(dname)+1;
281 new_dir = (char *)SMB_MALLOC(len + 1);
282 ALLOC_CHECK(new_dir, done);
284 if (dname[0] == '/') {
286 safe_strcat(new_dir,"/",len);
289 /* Create directory tree if neccessary */
290 for(token = strtok(tok_str, "/"); token; token = strtok(NULL, "/")) {
291 safe_strcat(new_dir, token, len);
292 if (recycle_directory_exist(handle, new_dir))
293 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
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)));
302 safe_strcat(new_dir, "/", len);
303 mode = recycle_subdir_mode(handle);
314 * Check if needle is contained exactly in haystack
315 * @param haystack list of parameters separated by delimimiter character
316 * @param needle string to be matched exactly to haystack
317 * @return True if found
319 static BOOL checkparam(const char **haystack_list, const char *needle)
323 if (haystack_list == NULL || haystack_list[0] == NULL ||
324 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
328 for(i=0; haystack_list[i] ; i++) {
329 if(strequal(haystack_list[i], needle)) {
338 * Check if needle is contained in haystack, * and ? patterns are resolved
339 * @param haystack list of parameters separated by delimimiter character
340 * @param needle string to be matched exectly to haystack including pattern matching
341 * @return True if found
343 static BOOL matchparam(const char **haystack_list, const char *needle)
347 if (haystack_list == NULL || haystack_list[0] == NULL ||
348 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
352 for(i=0; haystack_list[i] ; i++) {
353 if(unix_wild_match(haystack_list[i], needle)) {
362 * Touch access or modify date
364 static void recycle_do_touch(vfs_handle_struct *handle, const char *fname, BOOL touch_mtime)
367 struct timespec ts[2];
369 if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
370 DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
373 ts[0] = timespec_current(); /* atime */
374 ts[1] = touch_mtime ? ts[0] : get_mtimespec(&st); /* mtime */
376 if (SMB_VFS_NEXT_NTIMES(handle, fname, ts) == -1 ) {
377 DEBUG(0, ("recycle: touching %s failed, reason = %s\n", fname, strerror(errno)));
381 extern userdom_struct current_user_info;
384 * Check if file should be recycled
386 static int recycle_unlink(vfs_handle_struct *handle, const char *file_name)
388 connection_struct *conn = handle->conn;
389 char *path_name = NULL;
390 char *temp_name = NULL;
391 char *final_name = NULL;
393 char *repository = NULL;
395 SMB_OFF_T maxsize, minsize;
396 SMB_OFF_T file_size; /* space_avail; */
400 repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
402 conn->connectpath, conn->gid,
403 get_current_username(),
404 current_user_info.domain,
405 recycle_repository(handle));
406 ALLOC_CHECK(repository, done);
407 /* shouldn't we allow absolute path names here? --metze */
409 trim_char(repository, '\0', '/');
411 if(!repository || *(repository) == '\0') {
412 DEBUG(3, ("recycle: repository path not set, purging %s...\n", file_name));
413 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
417 /* we don't recycle the recycle bin... */
418 if (strncmp(file_name, repository, strlen(repository)) == 0) {
419 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
420 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
424 file_size = recycle_get_file_size(handle, file_name);
425 /* it is wrong to purge filenames only because they are empty imho
429 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
430 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
435 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
436 * not greater then maxsize, not the size of the single file, also it is better
437 * to remove older files
439 maxsize = recycle_maxsize(handle);
440 if(maxsize > 0 && file_size > maxsize) {
441 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, purging... \n", file_name));
442 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
445 minsize = recycle_minsize(handle);
446 if(minsize > 0 && file_size < minsize) {
447 DEBUG(3, ("recycle: File %s lowers minimum recycle size, purging... \n", file_name));
448 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
452 /* FIXME: this is wrong: moving files with rename does not change the disk space
455 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
456 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
457 if(space_avail < file_size) {
458 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
459 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
464 /* extract filename and path */
465 base = strrchr(file_name, '/');
468 path_name = SMB_STRDUP("/");
469 ALLOC_CHECK(path_name, done);
472 path_name = SMB_STRDUP(file_name);
473 ALLOC_CHECK(path_name, done);
474 path_name[base - file_name] = '\0';
478 DEBUG(10, ("recycle: fname = %s\n", file_name)); /* original filename with path */
479 DEBUG(10, ("recycle: fpath = %s\n", path_name)); /* original path */
480 DEBUG(10, ("recycle: base = %s\n", base)); /* filename without path */
482 if (matchparam(recycle_exclude(handle), base)) {
483 DEBUG(3, ("recycle: file %s is excluded \n", base));
484 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
488 /* FIXME: this check will fail if we have more than one level of directories,
489 * we shoud check for every level 1, 1/2, 1/2/3, 1/2/3/4 ....
492 if (checkparam(recycle_exclude_dir(handle), path_name)) {
493 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
494 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
498 if (recycle_keep_dir_tree(handle) == True) {
499 asprintf(&temp_name, "%s/%s", repository, path_name);
501 temp_name = SMB_STRDUP(repository);
503 ALLOC_CHECK(temp_name, done);
505 exist = recycle_directory_exist(handle, temp_name);
507 DEBUG(10, ("recycle: Directory already exists\n"));
509 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
510 if (recycle_create_dir(handle, temp_name) == False) {
511 DEBUG(3, ("recycle: Could not create directory, purging %s...\n", file_name));
512 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
517 asprintf(&final_name, "%s/%s", temp_name, base);
518 ALLOC_CHECK(final_name, done);
519 DEBUG(10, ("recycle: recycled file name: %s\n", final_name)); /* new filename with path */
521 /* check if we should delete file from recycle bin */
522 if (recycle_file_exist(handle, final_name)) {
523 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
524 DEBUG(3, ("recycle: Removing old file %s from recycle bin\n", final_name));
525 if (SMB_VFS_NEXT_UNLINK(handle, final_name) != 0) {
526 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
531 /* rename file we move to recycle bin */
533 while (recycle_file_exist(handle, final_name)) {
534 SAFE_FREE(final_name);
535 asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base);
538 DEBUG(10, ("recycle: Moving %s to %s\n", file_name, final_name));
539 rc = SMB_VFS_NEXT_RENAME(handle, file_name, final_name);
541 DEBUG(3, ("recycle: Move error %d (%s), purging file %s (%s)\n", errno, strerror(errno), file_name, final_name));
542 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
546 /* touch access date of moved file */
547 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
548 recycle_do_touch(handle, final_name, recycle_touch_mtime(handle));
551 SAFE_FREE(path_name);
552 SAFE_FREE(temp_name);
553 SAFE_FREE(final_name);
554 TALLOC_FREE(repository);
558 NTSTATUS vfs_recycle_init(void);
559 NTSTATUS vfs_recycle_init(void)
561 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle", recycle_ops);
563 if (!NT_STATUS_IS_OK(ret))
566 vfs_recycle_debug_level = debug_add_class("recycle");
567 if (vfs_recycle_debug_level == -1) {
568 vfs_recycle_debug_level = DBGC_VFS;
569 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
571 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));