/* * Unix SMB/CIFS implementation. * libsmbconf - Samba configuration library * Copyright (C) Michael Adam 2008 * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . */ #ifndef __LIBSMBCONF_H__ #define __LIBSMBCONF_H__ /** * @brief Status codes returned from smbconf functions */ enum _sbcErrType { SBC_ERR_OK = 0, /**< Successful completion **/ SBC_ERR_NOT_IMPLEMENTED, /**< Function not implemented **/ SBC_ERR_NOT_SUPPORTED, /**< Function not supported **/ SBC_ERR_UNKNOWN_FAILURE, /**< General failure **/ SBC_ERR_NOMEM, /**< Memory allocation error **/ SBC_ERR_INVALID_PARAM, /**< An Invalid parameter was supplied **/ SBC_ERR_BADFILE, /**< A bad file was supplied **/ SBC_ERR_NO_SUCH_SERVICE, /**< There is no such service provided **/ SBC_ERR_IO_FAILURE, /**< There was an IO error **/ SBC_ERR_CAN_NOT_COMPLETE,/**< Can not complete action **/ SBC_ERR_NO_MORE_ITEMS, /**< No more items left **/ SBC_ERR_FILE_EXISTS, /**< File already exists **/ SBC_ERR_ACCESS_DENIED, /**< Access has been denied **/ }; typedef enum _sbcErrType sbcErr; #define SBC_ERROR_IS_OK(x) ((x) == SBC_ERR_OK) #define SBC_ERROR_EQUAL(x,y) ((x) == (y)) struct smbconf_ctx; /* the change sequence number */ struct smbconf_csn { uint64_t csn; }; /** Information about a service */ struct smbconf_service { char *name; /**< The name of the share */ uint32_t num_params; /**< List of length num_shares of parameter counts for each share */ char **param_names; /**< List of lists of parameter names for each share */ char **param_values; /**< List of lists of parameter values for each share */ }; /* * The smbconf API functions */ /** * @brief Translate an error value into a string * * @param error * * @return a pointer to a static string **/ const char *sbcErrorString(sbcErr error); /** * @brief Check if the backend requires messaging to be set up. * * Tell whether the backend requires messaging to be set up * for the backend to work correctly. * * @param[in] ctx The smbconf context to check. * * @return True if needed, false if not. */ bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx); /** * @brief Tell whether the source is writeable. * * @param[in] ctx The smbconf context to check. * * @return True if it is writeable, false if not. */ bool smbconf_is_writeable(struct smbconf_ctx *ctx); /** * @brief Close the configuration. * * @param[in] ctx The smbconf context to close. */ void smbconf_shutdown(struct smbconf_ctx *ctx); /** * @brief Detect changes in the configuration. * * Get the change sequence number of the given service/parameter. Service and * parameter strings may be NULL. * * The given change sequence number (csn) struct is filled with the current * csn. smbconf_changed() can also be used for initial retrieval of the csn. * * @param[in] ctx The smbconf context to check for changes. * * @param[inout] csn The smbconf csn to be filled. * * @param[in] service The service name to check or NULL. * * @param[in] param The param to check or NULL. * * @return True if it has been changed, false if not. */ bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn, const char *service, const char *param); /** * @brief Drop the whole configuration (restarting empty). * * @param[in] ctx The smbconf context to drop the config. * * @return SBC_ERR_OK on success, a corresponding sbcErr if an * error occured. */ sbcErr smbconf_drop(struct smbconf_ctx *ctx); /** * @brief Get the whole configuration as lists of strings with counts. * * @param[in] ctx The smbconf context to get the lists from. * * @param[in] mem_ctx The memory context to use. * * @param[in] num_shares A pointer to store the number of shares. * * @param[out] services A pointer to store the services. * * @return SBC_ERR_OK on success, a corresponding sbcErr if an * error occured. * * @see smbconf_service */ sbcErr smbconf_get_config(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, uint32_t *num_shares, struct smbconf_service ***services); sbcErr smbconf_get_share_names(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, uint32_t *num_shares, char ***share_names); bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename); sbcErr smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename); sbcErr smbconf_get_share(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, const char *servicename, struct smbconf_service **service); sbcErr smbconf_delete_share(struct smbconf_ctx *ctx, const char *servicename); sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx, const char *service, const char *param, const char *valstr); sbcErr smbconf_set_global_parameter(struct smbconf_ctx *ctx, const char *param, const char *val); sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, const char *service, const char *param, char **valstr); sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, const char *param, char **valstr); sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx, const char *service, const char *param); sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx, const char *param); sbcErr smbconf_get_includes(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, const char *service, uint32_t *num_includes, char ***includes); sbcErr smbconf_get_global_includes(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, uint32_t *num_includes, char ***includes); sbcErr smbconf_set_includes(struct smbconf_ctx *ctx, const char *service, uint32_t num_includes, const char **includes); sbcErr smbconf_set_global_includes(struct smbconf_ctx *ctx, uint32_t num_includes, const char **includes); sbcErr smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service); sbcErr smbconf_delete_global_includes(struct smbconf_ctx *ctx); sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx); sbcErr smbconf_transaction_commit(struct smbconf_ctx *ctx); sbcErr smbconf_transaction_cancel(struct smbconf_ctx *ctx); #endif /* _LIBSMBCONF_H_ */