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