r23784: use the GPLv3 boilerplate as recommended by the FSF and the license text
[abartlet/samba.git/.git] / source3 / smbd / mangle.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Name mangling interface
4    Copyright (C) Andrew Tridgell 2002
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "includes.h"
21
22 static struct mangle_fns *mangle_fns;
23
24 /* this allows us to add more mangling backends */
25 static const struct {
26         const char *name;
27         struct mangle_fns *(*init_fn)(void);
28 } mangle_backends[] = {
29         { "hash", mangle_hash_init },
30         { "hash2", mangle_hash2_init },
31         { "posix", posix_mangle_init },
32         /*{ "tdb", mangle_tdb_init }, */
33         { NULL, NULL }
34 };
35
36 /*
37   initialise the mangling subsystem
38 */
39 static void mangle_init(void)
40 {
41         int i;
42         const char *method;
43
44         if (mangle_fns)
45                 return;
46
47         method = lp_mangling_method();
48
49         /* find the first mangling method that manages to initialise and
50            matches the "mangling method" parameter */
51         for (i=0; mangle_backends[i].name && !mangle_fns; i++) {
52                 if (!method || !*method || strcmp(method, mangle_backends[i].name) == 0) {
53                         mangle_fns = mangle_backends[i].init_fn();
54                 }
55         }
56
57         if (!mangle_fns) {
58                 DEBUG(0,("Failed to initialise mangling system '%s'\n", method));
59                 exit_server("mangling init failed");
60         }
61 }
62
63
64 /*
65   reset the cache. This is called when smb.conf has been reloaded
66 */
67 void mangle_reset_cache(void)
68 {
69         mangle_init();
70         mangle_fns->reset();
71 }
72
73 void mangle_change_to_posix(void)
74 {
75         mangle_fns = NULL;
76         lp_set_mangling_method("posix");
77         mangle_reset_cache();
78 }
79
80 /*
81   see if a filename has come out of our mangling code
82 */
83 BOOL mangle_is_mangled(const char *s, const struct share_params *p)
84 {
85         return mangle_fns->is_mangled(s, p);
86 }
87
88 /*
89   see if a filename matches the rules of a 8.3 filename
90 */
91 BOOL mangle_is_8_3(const char *fname, BOOL check_case,
92                    const struct share_params *p)
93 {
94         return mangle_fns->is_8_3(fname, check_case, False, p);
95 }
96
97 BOOL mangle_is_8_3_wildcards(const char *fname, BOOL check_case,
98                              const struct share_params *p)
99 {
100         return mangle_fns->is_8_3(fname, check_case, True, p);
101 }
102
103 /*
104   try to reverse map a 8.3 name to the original filename. This doesn't have to 
105   always succeed, as the directory handling code in smbd will scan the directory
106   looking for a matching name if it doesn't. It should succeed most of the time
107   or there will be a huge performance penalty
108 */
109 BOOL mangle_check_cache(char *s, size_t maxlen,
110                         const struct share_params *p)
111 {
112         return mangle_fns->check_cache(s, maxlen, p);
113 }
114
115 /* 
116    map a long filename to a 8.3 name. 
117  */
118
119 void mangle_map(pstring OutName, BOOL need83, BOOL cache83,
120                 const struct share_params *p)
121 {
122         /* name mangling can be disabled for speed, in which case
123            we just truncate the string */
124         if (!lp_manglednames(p)) {
125                 if (need83) {
126                         string_truncate(OutName, 12);
127                 }
128                 return;
129         }
130
131         /* invoke the inane "mangled map" code */
132         mangle_map_filename(OutName, p);
133         mangle_fns->name_map(OutName, need83, cache83, lp_defaultcase(p->service), p);
134 }