[s3]libsmbconf: add utility function smbconf_is_writeable_bystring()
[ira/wip.git] / source3 / lib / smbconf / smbconf.h
1 /*
2  *  Unix SMB/CIFS implementation.
3  *  libsmbconf - Samba configuration library
4  *  Copyright (C) Michael Adam 2008
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 #ifndef __LIBSMBCONF_H__
21 #define __LIBSMBCONF_H__
22
23 struct smbconf_ctx;
24
25 /* the change sequence number */
26 struct smbconf_csn {
27         uint64_t csn;
28 };
29
30 struct smbconf_service {
31         char *name;
32         uint32_t num_params;
33         char **param_names;
34         char **param_values;
35 };
36
37
38 /**
39  * intialization dispatcher function.
40  * takes source string in the form of "backend:path"
41  */
42 WERROR smbconf_init(TALLOC_CTX *mem_ctx, struct smbconf_ctx **conf_ctx,
43                     const char *source);
44
45 /**
46  * initialization functions for the available modules
47  */
48
49 WERROR smbconf_init_reg(TALLOC_CTX *mem_ctx, struct smbconf_ctx **conf_ctx,
50                         const char *path);
51
52 WERROR smbconf_init_txt(TALLOC_CTX *mem_ctx,
53                         struct smbconf_ctx **conf_ctx,
54                         const char *path);
55
56 /*
57  * the smbconf API functions
58  */
59 bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx);
60 bool smbconf_is_writeable(struct smbconf_ctx *ctx);
61 bool smbconf_is_writeable_bystring(const char *configsource);
62 void smbconf_shutdown(struct smbconf_ctx *ctx);
63 bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
64                      const char *service, const char *param);
65 WERROR smbconf_drop(struct smbconf_ctx *ctx);
66 WERROR smbconf_get_config(struct smbconf_ctx *ctx,
67                           TALLOC_CTX *mem_ctx,
68                           uint32_t *num_shares,
69                           struct smbconf_service ***services);
70 WERROR smbconf_get_share_names(struct smbconf_ctx *ctx,
71                                TALLOC_CTX *mem_ctx,
72                                uint32_t *num_shares,
73                                char ***share_names);
74 bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename);
75 WERROR smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename);
76 WERROR smbconf_get_share(struct smbconf_ctx *ctx,
77                          TALLOC_CTX *mem_ctx,
78                          const char *servicename,
79                          struct smbconf_service **service);
80 WERROR smbconf_delete_share(struct smbconf_ctx *ctx,
81                             const char *servicename);
82 WERROR smbconf_set_parameter(struct smbconf_ctx *ctx,
83                              const char *service,
84                              const char *param,
85                              const char *valstr);
86 WERROR smbconf_set_global_parameter(struct smbconf_ctx *ctx,
87                                     const char *param, const char *val);
88 WERROR smbconf_get_parameter(struct smbconf_ctx *ctx,
89                              TALLOC_CTX *mem_ctx,
90                              const char *service,
91                              const char *param,
92                              char **valstr);
93 WERROR smbconf_get_global_parameter(struct smbconf_ctx *ctx,
94                                     TALLOC_CTX *mem_ctx,
95                                     const char *param,
96                                     char **valstr);
97 WERROR smbconf_delete_parameter(struct smbconf_ctx *ctx,
98                                 const char *service, const char *param);
99 WERROR smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
100                                        const char *param);
101 WERROR smbconf_get_includes(struct smbconf_ctx *ctx,
102                             TALLOC_CTX *mem_ctx,
103                             const char *service,
104                             uint32_t *num_includes, char ***includes);
105 WERROR smbconf_get_global_includes(struct smbconf_ctx *ctx,
106                                    TALLOC_CTX *mem_ctx,
107                                    uint32_t *num_includes, char ***includes);
108 WERROR smbconf_set_includes(struct smbconf_ctx *ctx,
109                             const char *service,
110                             uint32_t num_includes, const char **includes);
111 WERROR smbconf_set_global_includes(struct smbconf_ctx *ctx,
112                                    uint32_t num_includes,
113                                    const char **includes);
114 WERROR smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service);
115 WERROR smbconf_delete_global_includes(struct smbconf_ctx *ctx);
116
117 #endif /*  _LIBSMBCONF_H_  */