docs: Fix variable list in man vfs_crossrename.
[Samba.git] / source3 / smbd / mangle.c
blob49599c1ee1c4a266e2c9595f82a681603675e186
1 /*
2 Unix SMB/CIFS implementation.
3 Name mangling interface
4 Copyright (C) Andrew Tridgell 2002
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.
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.
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/>.
20 #include "includes.h"
21 #include "smbd/smbd.h"
22 #include "smbd/globals.h"
23 #include "mangle.h"
25 /* this allows us to add more mangling backends */
26 static const struct {
27 const char *name;
28 const struct mangle_fns *(*init_fn)(void);
29 } mangle_backends[] = {
30 { "hash", mangle_hash_init },
31 { "hash2", mangle_hash2_init },
32 { "posix", posix_mangle_init },
33 /*{ "tdb", mangle_tdb_init }, */
34 { NULL, NULL }
38 initialise the mangling subsystem
40 static void mangle_init(void)
42 int i;
43 const char *method;
45 if (mangle_fns)
46 return;
48 method = lp_mangling_method();
50 /* find the first mangling method that manages to initialise and
51 matches the "mangling method" parameter */
52 for (i=0; mangle_backends[i].name && !mangle_fns; i++) {
53 if (!method || !*method || strcmp(method, mangle_backends[i].name) == 0) {
54 mangle_fns = mangle_backends[i].init_fn();
58 if (!mangle_fns) {
59 DEBUG(0,("Failed to initialise mangling system '%s'\n", method));
60 exit_server("mangling init failed");
66 reset the cache. This is called when smb.conf has been reloaded
68 void mangle_reset_cache(void)
70 mangle_init();
71 mangle_fns->reset();
74 void mangle_change_to_posix(void)
76 mangle_fns = NULL;
77 lp_set_mangling_method("posix");
78 mangle_reset_cache();
82 see if a filename has come out of our mangling code
84 bool mangle_is_mangled(const char *s, const struct share_params *p)
86 return mangle_fns->is_mangled(s, p);
90 see if a filename matches the rules of a 8.3 filename
92 bool mangle_is_8_3(const char *fname, bool check_case,
93 const struct share_params *p)
95 return mangle_fns->is_8_3(fname, check_case, False, p);
98 bool mangle_is_8_3_wildcards(const char *fname, bool check_case,
99 const struct share_params *p)
101 return mangle_fns->is_8_3(fname, check_case, True, p);
104 bool mangle_must_mangle(const char *fname,
105 const struct share_params *p)
107 if (!lp_manglednames(p)) {
108 return False;
110 return mangle_fns->must_mangle(fname, p);
114 try to reverse map a 8.3 name to the original filename. This doesn't have to
115 always succeed, as the directory handling code in smbd will scan the directory
116 looking for a matching name if it doesn't. It should succeed most of the time
117 or there will be a huge performance penalty
119 bool mangle_lookup_name_from_8_3(TALLOC_CTX *ctx,
120 const char *in,
121 char **out, /* talloced on the given context. */
122 const struct share_params *p)
124 return mangle_fns->lookup_name_from_8_3(ctx, in, out, p);
128 mangle a long filename to a 8.3 name.
129 Return True if we did mangle the name (ie. out is filled in).
130 False on error.
131 JRA.
134 bool name_to_8_3(const char *in,
135 char out[13],
136 bool cache83,
137 const struct share_params *p)
139 memset(out,'\0',13);
141 /* name mangling can be disabled for speed, in which case
142 we just truncate the string */
143 if (!lp_manglednames(p)) {
144 strlcpy(out, in, 13);
145 return True;
148 return mangle_fns->name_to_8_3(in,
149 out,
150 cache83,
151 lp_defaultcase(p->service),