source3/lib/smbconf/smbconf.c

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *  libsmbconf - Samba configuration library
   4  *  Copyright (C) Michael Adam 2007-2008
   5  *  Copyright (C) Guenther Deschner 2007
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 3 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include "includes.h"
  22 #include "smbconf_private.h"
  23
  24 /**********************************************************************
  25  *
  26  * internal helper functions
  27  *
  28  **********************************************************************/
  29
  30 static WERROR smbconf_global_check(struct smbconf_ctx *ctx)
  31 {
  32         if (!smbconf_share_exists(ctx, GLOBAL_NAME)) {
  33                 return smbconf_create_share(ctx, GLOBAL_NAME);
  34         }
  35         return WERR_OK;
  36 }
  37
  38
  39 /**********************************************************************
  40  *
  41  * The actual libsmbconf API functions that are exported.
  42  *
  43  **********************************************************************/
  44
  45 /**
  46  * Tell whether the backend requires messaging to be set up
  47  * for the backend to work correctly.
  48  */
  49 bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx)
  50 {
  51         return ctx->ops->requires_messaging(ctx);
  52 }
  53
  54 /**
  55  * Tell whether the source is writeable.
  56  */
  57 bool smbconf_is_writeable(struct smbconf_ctx *ctx)
  58 {
  59         return ctx->ops->is_writeable(ctx);
  60 }
  61
  62 /**
  63  * Close the configuration.
  64  */
  65 void smbconf_shutdown(struct smbconf_ctx *ctx)
  66 {
  67         TALLOC_FREE(ctx);
  68 }
  69
  70 /**
  71  * Detect changes in the configuration.
  72  * The given csn struct is filled with the current csn.
  73  * smbconf_changed() can also be used for initial retrieval
  74  * of the csn.
  75  */
  76 bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
  77                      const char *service, const char *param)
  78 {
  79         struct smbconf_csn old_csn;
  80
  81         if (csn == NULL) {
  82                 return false;
  83         }
  84
  85         old_csn = *csn;
  86
  87         ctx->ops->get_csn(ctx, csn, service, param);
  88         return (csn->csn != old_csn.csn);
  89 }
  90
  91 /**
  92  * Drop the whole configuration (restarting empty).
  93  */
  94 WERROR smbconf_drop(struct smbconf_ctx *ctx)
  95 {
  96         return ctx->ops->drop(ctx);
  97 }
  98
  99 /**
 100  * Get the whole configuration as lists of strings with counts:
 101  *
 102  *  num_shares   : number of shares
 103  *  share_names  : list of length num_shares of share names
 104  *  num_params   : list of length num_shares of parameter counts for each share
 105  *  param_names  : list of lists of parameter names for each share
 106  *  param_values : list of lists of parameter values for each share
 107  */
 108 WERROR smbconf_get_config(struct smbconf_ctx *ctx,
 109                           TALLOC_CTX *mem_ctx,
 110                           uint32_t *num_shares,
 111                           struct smbconf_service ***services)
 112 {
 113         WERROR werr = WERR_OK;
 114         TALLOC_CTX *tmp_ctx = NULL;
 115         uint32_t tmp_num_shares;
 116         char **tmp_share_names;
 117         struct smbconf_service **tmp_services;
 118         uint32_t count;
 119
 120         if ((num_shares == NULL) || (services == NULL)) {
 121                 werr = WERR_INVALID_PARAM;
 122                 goto done;
 123         }
 124
 125         tmp_ctx = talloc_stackframe();
 126
 127         werr = smbconf_get_share_names(ctx, tmp_ctx, &tmp_num_shares,
 128                                        &tmp_share_names);
 129         if (!W_ERROR_IS_OK(werr)) {
 130                 goto done;
 131         }
 132
 133         tmp_services = TALLOC_ARRAY(tmp_ctx, struct smbconf_service *,
 134                                     tmp_num_shares);
 135
 136         if (tmp_services == NULL) {
 137                 werr = WERR_NOMEM;
 138                 goto done;
 139         }
 140
 141         for (count = 0; count < tmp_num_shares; count++) {
 142                 werr = smbconf_get_share(ctx, tmp_services,
 143                                          tmp_share_names[count],
 144                                          &tmp_services[count]);
 145                 if (!W_ERROR_IS_OK(werr)) {
 146                         goto done;
 147                 }
 148         }
 149
 150         werr = WERR_OK;
 151
 152         *num_shares = tmp_num_shares;
 153         if (tmp_num_shares > 0) {
 154                 *services = talloc_move(mem_ctx, &tmp_services);
 155         } else {
 156                 *services = NULL;
 157         }
 158
 159 done:
 160         TALLOC_FREE(tmp_ctx);
 161         return werr;
 162 }
 163
 164 /**
 165  * get the list of share names defined in the configuration.
 166  */
 167 WERROR smbconf_get_share_names(struct smbconf_ctx *ctx,
 168                                TALLOC_CTX *mem_ctx,
 169                                uint32_t *num_shares,
 170                                char ***share_names)
 171 {
 172         return ctx->ops->get_share_names(ctx, mem_ctx, num_shares,
 173                                          share_names);
 174 }
 175
 176 /**
 177  * check if a share/service of a given name exists
 178  */
 179 bool smbconf_share_exists(struct smbconf_ctx *ctx,
 180                           const char *servicename)
 181 {
 182         return ctx->ops->share_exists(ctx, servicename);
 183 }
 184
 185 /**
 186  * Add a service if it does not already exist.
 187  */
 188 WERROR smbconf_create_share(struct smbconf_ctx *ctx,
 189                             const char *servicename)
 190 {
 191         if ((servicename != NULL) && smbconf_share_exists(ctx, servicename)) {
 192                 return WERR_FILE_EXISTS;
 193         }
 194
 195         return ctx->ops->create_share(ctx, servicename);
 196 }
 197
 198 /**
 199  * get a definition of a share (service) from configuration.
 200  */
 201 WERROR smbconf_get_share(struct smbconf_ctx *ctx,
 202                          TALLOC_CTX *mem_ctx,
 203                          const char *servicename,
 204                          struct smbconf_service **service)
 205 {
 206         if (!smbconf_share_exists(ctx, servicename)) {
 207                 return WERR_NO_SUCH_SERVICE;
 208         }
 209
 210         return ctx->ops->get_share(ctx, mem_ctx, servicename, service);
 211 }
 212
 213 /**
 214  * delete a service from configuration
 215  */
 216 WERROR smbconf_delete_share(struct smbconf_ctx *ctx, const char *servicename)
 217 {
 218         if (!smbconf_share_exists(ctx, servicename)) {
 219                 return WERR_NO_SUCH_SERVICE;
 220         }
 221
 222         return ctx->ops->delete_share(ctx, servicename);
 223 }
 224
 225 /**
 226  * set a configuration parameter to the value provided.
 227  */
 228 WERROR smbconf_set_parameter(struct smbconf_ctx *ctx,
 229                              const char *service,
 230                              const char *param,
 231                              const char *valstr)
 232 {
 233         if (!smbconf_share_exists(ctx, service)) {
 234                 return WERR_NO_SUCH_SERVICE;
 235         }
 236
 237         return ctx->ops->set_parameter(ctx, service, param, valstr);
 238 }
 239
 240 /**
 241  * Set a global parameter
 242  * (i.e. a parameter in the [global] service).
 243  *
 244  * This also creates [global] when it does not exist.
 245  */
 246 WERROR smbconf_set_global_parameter(struct smbconf_ctx *ctx,
 247                                     const char *param, const char *val)
 248 {
 249         WERROR werr;
 250
 251         werr = smbconf_global_check(ctx);
 252         if (W_ERROR_IS_OK(werr)) {
 253                 werr = smbconf_set_parameter(ctx, GLOBAL_NAME, param, val);
 254         }
 255
 256         return werr;
 257 }
 258
 259 /**
 260  * get the value of a configuration parameter as a string
 261  */
 262 WERROR smbconf_get_parameter(struct smbconf_ctx *ctx,
 263                              TALLOC_CTX *mem_ctx,
 264                              const char *service,
 265                              const char *param,
 266                              char **valstr)
 267 {
 268         if (valstr == NULL) {
 269                 return WERR_INVALID_PARAM;
 270         }
 271
 272         if (!smbconf_share_exists(ctx, service)) {
 273                 return WERR_NO_SUCH_SERVICE;
 274         }
 275
 276         return ctx->ops->get_parameter(ctx, mem_ctx, service, param, valstr);
 277 }
 278
 279 /**
 280  * Get the value of a global parameter.
 281  *
 282  * Create [global] if it does not exist.
 283  */
 284 WERROR smbconf_get_global_parameter(struct smbconf_ctx *ctx,
 285                                     TALLOC_CTX *mem_ctx,
 286                                     const char *param,
 287                                     char **valstr)
 288 {
 289         WERROR werr;
 290
 291         werr = smbconf_global_check(ctx);
 292         if (W_ERROR_IS_OK(werr)) {
 293                 werr = smbconf_get_parameter(ctx, mem_ctx, GLOBAL_NAME, param,
 294                                              valstr);
 295         }
 296
 297         return werr;
 298 }
 299
 300 /**
 301  * delete a parameter from configuration
 302  */
 303 WERROR smbconf_delete_parameter(struct smbconf_ctx *ctx,
 304                                 const char *service, const char *param)
 305 {
 306         if (!smbconf_share_exists(ctx, service)) {
 307                 return WERR_NO_SUCH_SERVICE;
 308         }
 309
 310         return ctx->ops->delete_parameter(ctx, service, param);
 311 }
 312
 313 /**
 314  * Delete a global parameter.
 315  *
 316  * Create [global] if it does not exist.
 317  */
 318 WERROR smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
 319                                        const char *param)
 320 {
 321         WERROR werr;
 322
 323         werr = smbconf_global_check(ctx);
 324         if (W_ERROR_IS_OK(werr)) {
 325                 werr = smbconf_delete_parameter(ctx, GLOBAL_NAME, param);
 326         }
 327
 328         return werr;
 329 }
 330
 331 WERROR smbconf_get_includes(struct smbconf_ctx *ctx,
 332                             TALLOC_CTX *mem_ctx,
 333                             const char *service,
 334                             uint32_t *num_includes, char ***includes)
 335 {
 336         if (!smbconf_share_exists(ctx, service)) {
 337                 return WERR_NO_SUCH_SERVICE;
 338         }
 339
 340         return ctx->ops->get_includes(ctx, mem_ctx, service, num_includes,
 341                                       includes);
 342 }
 343
 344 WERROR smbconf_get_global_includes(struct smbconf_ctx *ctx,
 345                                    TALLOC_CTX *mem_ctx,
 346                                    uint32_t *num_includes, char ***includes)
 347 {
 348         WERROR werr;
 349
 350         werr = smbconf_global_check(ctx);
 351         if (W_ERROR_IS_OK(werr)) {
 352                 werr = smbconf_get_includes(ctx, mem_ctx, GLOBAL_NAME,
 353                                             num_includes, includes);
 354         }
 355
 356         return werr;
 357 }
 358
 359 WERROR smbconf_set_includes(struct smbconf_ctx *ctx,
 360                             const char *service,
 361                             uint32_t num_includes, const char **includes)
 362 {
 363         if (!smbconf_share_exists(ctx, service)) {
 364                 return WERR_NO_SUCH_SERVICE;
 365         }
 366
 367         return ctx->ops->set_includes(ctx, service, num_includes, includes);
 368 }
 369
 370 WERROR smbconf_set_global_includes(struct smbconf_ctx *ctx,
 371                                    uint32_t num_includes,
 372                                    const char **includes)
 373 {
 374         WERROR werr;
 375
 376         werr = smbconf_global_check(ctx);
 377         if (W_ERROR_IS_OK(werr)) {
 378                 werr = smbconf_set_includes(ctx, GLOBAL_NAME,
 379                                             num_includes, includes);
 380         }
 381
 382         return werr;
 383 }
 384
 385
 386 WERROR smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service)
 387 {
 388         if (!smbconf_share_exists(ctx, service)) {
 389                 return WERR_NO_SUCH_SERVICE;
 390         }
 391
 392         return ctx->ops->delete_includes(ctx, service);
 393 }
 394
 395 WERROR smbconf_delete_global_includes(struct smbconf_ctx *ctx)
 396 {
 397         WERROR werr;
 398
 399         werr = smbconf_global_check(ctx);
 400         if (W_ERROR_IS_OK(werr)) {
 401                 werr = smbconf_delete_includes(ctx, GLOBAL_NAME);
 402         }
 403
 404         return werr;
 405 }