More strlcat/strlcpy truncate checks.
[amitay/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 SMB_OFF_T recycle_maxsize(vfs_handle_struct *handle)
130 {
131         SMB_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 SMB_OFF_T recycle_minsize(vfs_handle_struct *handle)
142 {
143         SMB_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_fname(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         NTSTATUS status;
205         bool ret = false;
206
207         status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
208         if (!NT_STATUS_IS_OK(status)) {
209                 return false;
210         }
211
212         if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
213                 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
214                         ret = true;
215                 }
216         }
217
218         TALLOC_FREE(smb_fname_tmp);
219         return ret;
220 }
221
222 /**
223  * Return file size
224  * @param conn connection
225  * @param fname file name
226  * @return size in bytes
227  **/
228 static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle,
229                                        const struct smb_filename *smb_fname)
230 {
231         struct smb_filename *smb_fname_tmp = NULL;
232         NTSTATUS status;
233         SMB_OFF_T size;
234
235         status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
236         if (!NT_STATUS_IS_OK(status)) {
237                 size = (SMB_OFF_T)0;
238                 goto out;
239         }
240
241         if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
242                 DEBUG(0,("recycle: stat for %s returned %s\n",
243                          smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
244                 size = (SMB_OFF_T)0;
245                 goto out;
246         }
247
248         size = smb_fname_tmp->st.st_ex_size;
249  out:
250         TALLOC_FREE(smb_fname_tmp);
251         return size;
252 }
253
254 /**
255  * Create directory tree
256  * @param conn connection
257  * @param dname Directory tree to be created
258  * @return Returns True for success
259  **/
260 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
261 {
262         size_t len;
263         mode_t mode;
264         char *new_dir = NULL;
265         char *tmp_str = NULL;
266         char *token;
267         char *tok_str;
268         bool ret = False;
269         char *saveptr;
270
271         mode = recycle_directory_mode(handle);
272
273         tmp_str = SMB_STRDUP(dname);
274         ALLOC_CHECK(tmp_str, done);
275         tok_str = tmp_str;
276
277         len = strlen(dname)+1;
278         new_dir = (char *)SMB_MALLOC(len + 1);
279         ALLOC_CHECK(new_dir, done);
280         *new_dir = '\0';
281         if (dname[0] == '/') {
282                 /* Absolute path. */
283                 if (strlcat(new_dir,"/",len+1) >= len+1) {
284                         goto done;
285                 }
286         }
287
288         /* Create directory tree if neccessary */
289         for(token = strtok_r(tok_str, "/", &saveptr); token;
290             token = strtok_r(NULL, "/", &saveptr)) {
291                 if (strlcat(new_dir, token, len+1) >= len+1) {
292                         goto done;
293                 }
294                 if (recycle_directory_exist(handle, new_dir))
295                         DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
296                 else {
297                         DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
298                         if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
299                                 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
300                                 ret = False;
301                                 goto done;
302                         }
303                 }
304                 if (strlcat(new_dir, "/", len+1) >= len+1) {
305                         goto done;
306                 }
307                 mode = recycle_subdir_mode(handle);
308         }
309
310         ret = True;
311 done:
312         SAFE_FREE(tmp_str);
313         SAFE_FREE(new_dir);
314         return ret;
315 }
316
317 /**
318  * Check if any of the components of "exclude_list" are contained in path.
319  * Return True if found
320  **/
321
322 static bool matchdirparam(const char **dir_exclude_list, char *path)
323 {
324         char *startp = NULL, *endp = NULL;
325
326         if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
327                 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
328                 return False;
329         }
330
331         /* 
332          * Walk the components of path, looking for matches with the
333          * exclude list on each component. 
334          */
335
336         for (startp = path; startp; startp = endp) {
337                 int i;
338
339                 while (*startp == '/') {
340                         startp++;
341                 }
342                 endp = strchr(startp, '/');
343                 if (endp) {
344                         *endp = '\0';
345                 }
346
347                 for(i=0; dir_exclude_list[i] ; i++) {
348                         if(unix_wild_match(dir_exclude_list[i], startp)) {
349                                 /* Repair path. */
350                                 if (endp) {
351                                         *endp = '/';
352                                 }
353                                 return True;
354                         }
355                 }
356
357                 /* Repair path. */
358                 if (endp) {
359                         *endp = '/';
360                 }
361         }
362
363         return False;
364 }
365
366 /**
367  * Check if needle is contained in haystack, * and ? patterns are resolved
368  * @param haystack list of parameters separated by delimimiter character
369  * @param needle string to be matched exectly to haystack including pattern matching
370  * @return True if found
371  **/
372 static bool matchparam(const char **haystack_list, const char *needle)
373 {
374         int i;
375
376         if (haystack_list == NULL || haystack_list[0] == NULL ||
377                 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
378                 return False;
379         }
380
381         for(i=0; haystack_list[i] ; i++) {
382                 if(unix_wild_match(haystack_list[i], needle)) {
383                         return True;
384                 }
385         }
386
387         return False;
388 }
389
390 /**
391  * Touch access or modify date
392  **/
393 static void recycle_do_touch(vfs_handle_struct *handle,
394                              const struct smb_filename *smb_fname,
395                              bool touch_mtime)
396 {
397         struct smb_filename *smb_fname_tmp = NULL;
398         struct smb_file_time ft;
399         NTSTATUS status;
400         int ret, err;
401
402         ZERO_STRUCT(ft);
403
404         status = copy_smb_filename(talloc_tos(), smb_fname, &smb_fname_tmp);
405         if (!NT_STATUS_IS_OK(status)) {
406                 return;
407         }
408
409         if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
410                 DEBUG(0,("recycle: stat for %s returned %s\n",
411                          smb_fname_str_dbg(smb_fname_tmp), strerror(errno)));
412                 goto out;
413         }
414         /* atime */
415         ft.atime = timespec_current();
416         /* mtime */
417         ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
418
419         become_root();
420         ret = SMB_VFS_NEXT_NTIMES(handle, smb_fname_tmp, &ft);
421         err = errno;
422         unbecome_root();
423         if (ret == -1 ) {
424                 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
425                           smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
426         }
427  out:
428         TALLOC_FREE(smb_fname_tmp);
429 }
430
431 /**
432  * Check if file should be recycled
433  **/
434 static int recycle_unlink(vfs_handle_struct *handle,
435     const struct smb_filename *smb_fname)
436 {
437         connection_struct *conn = handle->conn;
438         char *path_name = NULL;
439         char *temp_name = NULL;
440         char *final_name = NULL;
441         struct smb_filename *smb_fname_final = NULL;
442         const char *base;
443         char *repository = NULL;
444         int i = 1;
445         SMB_OFF_T maxsize, minsize;
446         SMB_OFF_T file_size; /* space_avail;    */
447         bool exist;
448         NTSTATUS status;
449         int rc = -1;
450
451         repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
452                                         conn->session_info->unix_info->unix_name,
453                                         conn->connectpath,
454                                         conn->session_info->unix_token->gid,
455                                         conn->session_info->unix_info->sanitized_username,
456                                         conn->session_info->info->domain_name,
457                                         recycle_repository(handle));
458         ALLOC_CHECK(repository, done);
459         /* shouldn't we allow absolute path names here? --metze */
460         /* Yes :-). JRA. */
461         trim_char(repository, '\0', '/');
462
463         if(!repository || *(repository) == '\0') {
464                 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
465                           smb_fname_str_dbg(smb_fname)));
466                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
467                 goto done;
468         }
469
470         /* we don't recycle the recycle bin... */
471         if (strncmp(smb_fname->base_name, repository,
472                     strlen(repository)) == 0) {
473                 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
474                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
475                 goto done;
476         }
477
478         file_size = recycle_get_file_size(handle, smb_fname);
479         /* it is wrong to purge filenames only because they are empty imho
480          *   --- simo
481          *
482         if(fsize == 0) {
483                 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
484                 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
485                 goto done;
486         }
487          */
488
489         /* FIXME: this is wrong, we should check the whole size of the recycle bin is
490          * not greater then maxsize, not the size of the single file, also it is better
491          * to remove older files
492          */
493         maxsize = recycle_maxsize(handle);
494         if(maxsize > 0 && file_size > maxsize) {
495                 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
496                           "purging... \n", smb_fname_str_dbg(smb_fname)));
497                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
498                 goto done;
499         }
500         minsize = recycle_minsize(handle);
501         if(minsize > 0 && file_size < minsize) {
502                 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
503                           "purging... \n", smb_fname_str_dbg(smb_fname)));
504                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
505                 goto done;
506         }
507
508         /* FIXME: this is wrong: moving files with rename does not change the disk space
509          * allocation
510          *
511         space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
512         DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
513         if(space_avail < file_size) {
514                 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
515                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
516                 goto done;
517         }
518          */
519
520         /* extract filename and path */
521         base = strrchr(smb_fname->base_name, '/');
522         if (base == NULL) {
523                 base = smb_fname->base_name;
524                 path_name = SMB_STRDUP("/");
525                 ALLOC_CHECK(path_name, done);
526         }
527         else {
528                 path_name = SMB_STRDUP(smb_fname->base_name);
529                 ALLOC_CHECK(path_name, done);
530                 path_name[base - smb_fname->base_name] = '\0';
531                 base++;
532         }
533
534         /* original filename with path */
535         DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(smb_fname)));
536         /* original path */
537         DEBUG(10, ("recycle: fpath = %s\n", path_name));
538         /* filename without path */
539         DEBUG(10, ("recycle: base = %s\n", base));
540
541         if (matchparam(recycle_exclude(handle), base)) {
542                 DEBUG(3, ("recycle: file %s is excluded \n", base));
543                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
544                 goto done;
545         }
546
547         if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
548                 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
549                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
550                 goto done;
551         }
552
553         if (recycle_keep_dir_tree(handle) == True) {
554                 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
555                         ALLOC_CHECK(temp_name, done);
556                 }
557         } else {
558                 temp_name = SMB_STRDUP(repository);
559         }
560         ALLOC_CHECK(temp_name, done);
561
562         exist = recycle_directory_exist(handle, temp_name);
563         if (exist) {
564                 DEBUG(10, ("recycle: Directory already exists\n"));
565         } else {
566                 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
567                 if (recycle_create_dir(handle, temp_name) == False) {
568                         DEBUG(3, ("recycle: Could not create directory, "
569                                   "purging %s...\n",
570                                   smb_fname_str_dbg(smb_fname)));
571                         rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
572                         goto done;
573                 }
574         }
575
576         if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
577                 ALLOC_CHECK(final_name, done);
578         }
579
580         /* Create smb_fname with final base name and orig stream name. */
581         status = create_synthetic_smb_fname(talloc_tos(), final_name,
582                                             smb_fname->stream_name, NULL,
583                                             &smb_fname_final);
584         if (!NT_STATUS_IS_OK(status)) {
585                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
586                 goto done;
587         }
588
589         /* new filename with path */
590         DEBUG(10, ("recycle: recycled file name: %s\n",
591                    smb_fname_str_dbg(smb_fname_final)));
592
593         /* check if we should delete file from recycle bin */
594         if (recycle_file_exist(handle, smb_fname_final)) {
595                 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
596                         DEBUG(3, ("recycle: Removing old file %s from recycle "
597                                   "bin\n", smb_fname_str_dbg(smb_fname_final)));
598                         if (SMB_VFS_NEXT_UNLINK(handle,
599                                                 smb_fname_final) != 0) {
600                                 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
601                         }
602                 }
603         }
604
605         /* rename file we move to recycle bin */
606         i = 1;
607         while (recycle_file_exist(handle, smb_fname_final)) {
608                 SAFE_FREE(final_name);
609                 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
610                         ALLOC_CHECK(final_name, done);
611                 }
612                 TALLOC_FREE(smb_fname_final->base_name);
613                 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
614                                                            final_name);
615                 if (smb_fname_final->base_name == NULL) {
616                         rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
617                         goto done;
618                 }
619         }
620
621         DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(smb_fname),
622                 smb_fname_str_dbg(smb_fname_final)));
623         rc = SMB_VFS_NEXT_RENAME(handle, smb_fname, smb_fname_final);
624         if (rc != 0) {
625                 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
626                           "(%s)\n", errno, strerror(errno),
627                           smb_fname_str_dbg(smb_fname),
628                           smb_fname_str_dbg(smb_fname_final)));
629                 rc = SMB_VFS_NEXT_UNLINK(handle, smb_fname);
630                 goto done;
631         }
632
633         /* touch access date of moved file */
634         if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
635                 recycle_do_touch(handle, smb_fname_final,
636                                  recycle_touch_mtime(handle));
637
638 done:
639         SAFE_FREE(path_name);
640         SAFE_FREE(temp_name);
641         SAFE_FREE(final_name);
642         TALLOC_FREE(smb_fname_final);
643         TALLOC_FREE(repository);
644         return rc;
645 }
646
647 static struct vfs_fn_pointers vfs_recycle_fns = {
648         .unlink_fn = recycle_unlink
649 };
650
651 NTSTATUS vfs_recycle_init(void);
652 NTSTATUS vfs_recycle_init(void)
653 {
654         NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
655                                         &vfs_recycle_fns);
656
657         if (!NT_STATUS_IS_OK(ret))
658                 return ret;
659
660         vfs_recycle_debug_level = debug_add_class("recycle");
661         if (vfs_recycle_debug_level == -1) {
662                 vfs_recycle_debug_level = DBGC_VFS;
663                 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
664         } else {
665                 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
666         }
667
668         return ret;
669 }