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