updated the 3.0 branch from the head branch - ready for alpha18
[samba.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 2 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, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21 #include "includes.h"
22
23 static struct mangle_fns *mangle_fns;
24
25 /* this allows us to add more mangling backends */
26 static struct {
27         char *name;
28         struct mangle_fns *(*init_fn)(void);
29 } mangle_backends[] = {
30         { "hash", mangle_hash_init },
31         { "hash2", mangle_hash2_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         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
71         mangle_fns->reset();
72 }
73
74 /*
75   see if a filename has come out of our mangling code
76 */
77 BOOL mangle_is_mangled(const char *s)
78 {
79         return mangle_fns->is_mangled(s);
80 }
81
82 /*
83   see if a filename matches the rules of a 8.3 filename
84 */
85 BOOL mangle_is_8_3(const char *fname, BOOL check_case)
86 {
87         return mangle_fns->is_8_3(fname, check_case, False);
88 }
89
90 BOOL mangle_is_8_3_wildcards(const char *fname, BOOL check_case)
91 {
92         return mangle_fns->is_8_3(fname, check_case, True);
93 }
94
95 /*
96   try to reverse map a 8.3 name to the original filename. This doesn't have to 
97   always succeed, as the directory handling code in smbd will scan the directory
98   looking for a matching name if it doesn't. It should succeed most of the time
99   or there will be a huge performance penalty
100 */
101 BOOL mangle_check_cache(char *s)
102 {
103         return mangle_fns->check_cache(s);
104 }
105
106 /* 
107    map a long filename to a 8.3 name. 
108  */
109
110 void mangle_map(char *OutName, BOOL need83, BOOL cache83, int snum)
111 {
112         /* name mangling can be disabled for speed, in which case
113            we just truncate the string */
114         if (!lp_manglednames(snum)) {
115                 if (need83) {
116                         string_truncate(OutName, 12);
117                 }
118                 return;
119         }
120
121         /* invoke the inane "mangled map" code */
122         mangle_map_filename(OutName, snum);
123         mangle_fns->name_map(OutName, need83, cache83);
124 }