Initial revamp of the libsmbclient interface.

The libsmbclient interface has suffered from difficulty of improvement and
feature enrichment without causing ABI breakage.  Although there were a number
of issues, the primary ones were:

(a) the user of the library would manually manipulate the context structure
    members, meaning that nothing in the context structure could change other
    than adding stuff at the end;

(b) there were three methods of setting options: setting bits in a flags field
    within the context structure, setting explicit options variables within an
    options structure in the context structure, and by calling the
    smbc_option_set() function;

(c) the authentication callback did not traditionally provide enough
    information to the callee which required adding an option for a callback
    with a different signature, and now there are requests for even more
    information at the callback, requiring yet a third signature and option to
    set it (if we implement that feature).

This commit provides a reorganization of the code which fixes (a) and (b).
The context structure is now entirely opaque, and there are setter and getter
functions for manipulating it.  This makes maintaining ABI consistency much,
much easier.

Additionally, the options setting/getting has been unified into a single
mechanism using smbc_option_set() and smbc_option_get().

Yet to be completed is a refactoring of the authentication callback (c).

The test programs in examples/libsmbclient have been modified (if necessary;
some applications require no changes at all) for the new API and a few have
been minimally tested.

Derrell
(This used to be commit d4b4bae8ded824d06ad5ab0e219f71187ee5c771)

1 files changed, 518 insertions, 20 deletions

diff --git a/source3/include/libsmb_internal.h b/source3/include/libsmb_internal.h
index 6c7dc80da8..353575dce8 100644
--- a/source3/include/libsmb_internal.h
+++ b/source3/include/libsmb_internal.h
@@ -1,12 +1,71 @@
+/* 
+   Unix SMB/Netbios implementation.
+   SMB client library implementation
+   Copyright (C) Andrew Tridgell 1998
+   Copyright (C) Richard Sharpe 2000, 2002
+   Copyright (C) John Terpstra 2000
+   Copyright (C) Tom Jansen (Ninja ISD) 2002 
+   Copyright (C) Derrell Lipman 2003-2008
+   Copyright (C) Jeremy Allison 2007, 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 <http://www.gnu.org/licenses/>.
+*/
+
+#include "includes.h"
+
+
 #ifndef _LIBSMB_INTERNAL_H_
 #define _LIBSMB_INTERNAL_H_
 
+#include "../include/libsmbclient.h"
+
 #define SMBC_MAX_NAME  1023
 #define SMBC_FILE_MODE (S_IFREG | 0444)
 #define SMBC_DIR_MODE  (S_IFDIR | 0555)
 
+/*
+ * DOS Attribute values (used internally)
+ */
+typedef struct DOS_ATTR_DESC {
+	int mode;
+	SMB_OFF_T size;
+	time_t create_time;
+	time_t access_time;
+	time_t write_time;
+	time_t change_time;
+	SMB_INO_T inode;
+} DOS_ATTR_DESC;
+
+
+/*
+ * Internal flags for extended attributes
+ */
+
+/* internal mode values */
+#define SMBC_XATTR_MODE_ADD          1
+#define SMBC_XATTR_MODE_REMOVE       2
+#define SMBC_XATTR_MODE_REMOVE_ALL   3
+#define SMBC_XATTR_MODE_SET          4
+#define SMBC_XATTR_MODE_CHOWN        5
+#define SMBC_XATTR_MODE_CHGRP        6
+
+#define CREATE_ACCESS_READ      READ_CONTROL_ACCESS
 
-#include "include/libsmbclient.h"
+/*We should test for this in configure ... */
+#ifndef ENOTSUP
+#define ENOTSUP EOPNOTSUPP
+#endif
 
 
 struct _SMBCSRV {
@@ -46,12 +105,28 @@ struct _SMBCFILE {
 };
 
 
-struct smbc_internal_data {
+/*
+ * Context structure
+ */
+struct _SMBCCTX {
 
-	/*
-         * Is this handle initialized ? 
-	 */
-	bool    _initialized;
+	/* True when this handle is initialized */
+	bool            initialized;
+
+        /* Netbios name used for making connections */
+        char *          netbios_name;
+
+        /* Workgroup used for making connections */
+        char *          workgroup;
+
+        /* Username used for making connections */
+        char *          user;
+
+        /* Debug level */
+        int             debug;
+
+        /* Connection timeout value */
+        int             timeout;
 
         /* dirent pointer location
          *
@@ -64,22 +139,22 @@ struct smbc_internal_data {
          * According to <linux/limits.h>, NAME_MAX is 255.  Is it longer
          * anyplace else?
          */
-	char    _dirent[1024];
+	char            dirent[1024];
 
 	/*
          * server connection list
 	 */
-	SMBCSRV * _servers;
+	SMBCSRV *       servers;
 	
 	/*
          * open file/dir list
 	 */
-	SMBCFILE * _files;
+	SMBCFILE *      files;
 
         /*
          * Log to standard error instead of the more typical standard output
          */
-        bool _debug_stderr;
+        bool            debug_stderr;
 
         /*
          * Support "Create Time" in get/set with the *xattr() functions, if
@@ -88,33 +163,456 @@ struct smbc_internal_data {
          * CREATE_TIME.  Default is FALSE, i.e.  to use the old-style shorter
          * names and to not support CREATE time, for backward compatibility.
          */
-        bool _full_time_names;
+        bool            full_time_names;
 
         /*
          * The share mode of a file being opened.  To match POSIX semantics
          * (and maintain backward compatibility), DENY_NONE is the default.
          */
-         smbc_share_mode _share_mode;
-
-        /*
-         * Authentication function which includes the context.  This will be
-         * used if set; otherwise context->callbacks.auth_fn() will be used.
-         */
-        smbc_get_auth_data_with_context_fn _auth_fn_with_context;
+        smbc_share_mode share_mode;
 
         /*
          * An opaque (to this library) user data handle which can be set
          * and retrieved with smbc_option_set() and smbc_option_get().
          */
-        void * _user_data;
+        void *          user_data;
 
         /*
          * Should we attempt UNIX smb encryption ? 
          * Set to 0 if we should never attempt, set to 1 if
          * encryption requested, set to 2 if encryption required.
          */
-        int _smb_encryption_level;
+        int             smb_encryption_level;
+
+        /*
+         * From how many local master browsers should the list of
+         * workgroups be retrieved?  It can take up to 12 minutes or
+         * longer after a server becomes a local master browser, for
+         * it to have the entire browse list (the list of
+         * workgroups/domains) from an entire network.  Since a client
+         * never knows which local master browser will be found first,
+         * the one which is found first and used to retrieve a browse
+         * list may have an incomplete or empty browse list.  By
+         * requesting the browse list from multiple local master
+         * browsers, a more complete list can be generated.  For small
+         * networks (few workgroups), it is recommended that this
+         * value be set to 0, causing the browse lists from all found
+         * local master browsers to be retrieved and merged.  For
+         * networks with many workgroups, a suitable value for this
+         * variable is probably somewhere around 3. (Default: 3).
+         */
+        int             browse_max_lmb_count;
+
+        /*
+         * There is a difference in the desired return strings from
+         * smbc_readdir() depending upon whether the filenames are to
+         * be displayed to the user, or whether they are to be
+         * appended to the path name passed to smbc_opendir() to call
+         * a further smbc_ function (e.g. open the file with
+         * smbc_open()).  In the former case, the filename should be
+         * in "human readable" form.  In the latter case, the smbc_
+         * functions expect a URL which must be url-encoded.  Those
+         * functions decode the URL.  If, for example, smbc_readdir()
+         * returned a file name of "abc%20def.txt", passing a path
+         * with this file name attached to smbc_open() would cause
+         * smbc_open to attempt to open the file "abc def.txt" since
+         * the %20 is decoded into a space.
+         *
+         * Set this option to True if the names returned by
+         * smbc_readdir() should be url-encoded such that they can be
+         * passed back to another smbc_ call.  Set it to False if the
+         * names returned by smbc_readdir() are to be presented to the
+         * user.
+         *
+         * For backwards compatibility, this option defaults to False.
+         */
+        bool            urlencode_readdir_entries;
+
+        /*
+         * Some Windows versions appear to have a limit to the number
+         * of concurrent SESSIONs and/or TREE CONNECTions.  In
+         * one-shot programs (i.e. the program runs and then quickly
+         * ends, thereby shutting down all connections), it is
+         * probably reasonable to establish a new connection for each
+         * share.  In long-running applications, the limitation can be
+         * avoided by using only a single connection to each server,
+         * and issuing a new TREE CONNECT when the share is accessed.
+         */
+        bool            one_share_per_server;
+
+        /* Kerberos-related flags */
+        bool            use_kerberos;
+        bool            fallback_after_kerberos;
+
+        /* Don't try to do automatic anonymous login */
+        bool            no_auto_anonymous_login;
+
+        /* Server-related functions */
+        struct
+        {
+                smbc_get_auth_data_fn           get_auth_data_fn;
+                smbc_check_server_fn            check_server_fn;
+                smbc_remove_unused_server_fn    remove_unused_server_fn;
+        }               server;
+
+        /* Cache-related functions */
+        struct
+        {
+                struct smbc_server_cache *      server_cache_data;
+                smbc_add_cached_srv_fn          add_cached_server_fn;
+                smbc_get_cached_srv_fn          get_cached_server_fn;
+                smbc_remove_cached_srv_fn       remove_cached_server_fn;
+                smbc_purge_cached_srv_fn        purge_cached_server_fn;
+        }               cache;
+
+        /* POSIX emulation functions */
+        struct
+        {
+                smbc_open_fn                    open_fn;
+                smbc_creat_fn                   creat_fn;
+                smbc_read_fn                    read_fn;
+                smbc_write_fn                   write_fn;
+                smbc_unlink_fn                  unlink_fn;
+                smbc_rename_fn                  rename_fn;
+                smbc_lseek_fn                   lseek_fn;
+                smbc_ftruncate_fn               ftruncate_fn;
+                smbc_stat_fn                    stat_fn;
+                smbc_fstat_fn                   fstat_fn;
+                smbc_close_fn                   close_fn;
+                smbc_opendir_fn                 opendir_fn;
+                smbc_closedir_fn                closedir_fn;
+                smbc_readdir_fn                 readdir_fn;
+                smbc_getdents_fn                getdents_fn;
+                smbc_mkdir_fn                   mkdir_fn;
+                smbc_rmdir_fn                   rmdir_fn;
+                smbc_telldir_fn                 telldir_fn;
+                smbc_lseekdir_fn                lseekdir_fn;
+                smbc_fstatdir_fn                fstatdir_fn;
+                smbc_chmod_fn                   chmod_fn;
+                smbc_utimes_fn                  utimes_fn;
+                smbc_setxattr_fn                setxattr_fn;
+                smbc_getxattr_fn                getxattr_fn;
+                smbc_removexattr_fn             removexattr_fn;
+                smbc_listxattr_fn               listxattr_fn;
+        }               posix_emu;
+
+        /* Printing-related functions */
+        struct
+        {
+                smbc_print_file_fn              print_file_fn;
+                smbc_open_print_job_fn          open_print_job_fn;
+                smbc_list_print_jobs_fn         list_print_jobs_fn;
+                smbc_unlink_print_job_fn        unlink_print_job_fn;
+        }               printing;
+
+#if 0 /* not yet */
+        /* SMB high-level functions */
+        struct
+        {
+        }               smb;
+
+#endif
 };	
 
+/* Functions in libsmb_cache.c */
+int
+SMBC_add_cached_server(SMBCCTX * context,
+                       SMBCSRV * newsrv,
+                       const char * server,
+                       const char * share, 
+                       const char * workgroup,
+                       const char * username);
+
+SMBCSRV *
+SMBC_get_cached_server(SMBCCTX * context,
+                       const char * server, 
+                       const char * share,
+                       const char * workgroup,
+                       const char * user);
+
+int
+SMBC_remove_cached_server(SMBCCTX * context,
+                          SMBCSRV * server);
+
+int
+SMBC_purge_cached_servers(SMBCCTX * context);
+
+
+/* Functions in libsmb_dir.c */
+int
+SMBC_check_options(char *server,
+                   char *share,
+                   char *path,
+                   char *options);
+
+SMBCFILE *
+SMBC_opendir_ctx(SMBCCTX *context,
+                 const char *fname);
+
+int
+SMBC_closedir_ctx(SMBCCTX *context,
+                  SMBCFILE *dir);
+
+struct smbc_dirent *
+SMBC_readdir_ctx(SMBCCTX *context,
+                 SMBCFILE *dir);
+
+int
+SMBC_getdents_ctx(SMBCCTX *context,
+                  SMBCFILE *dir,
+                  struct smbc_dirent *dirp,
+                  int count);
+
+int
+SMBC_mkdir_ctx(SMBCCTX *context,
+               const char *fname,
+               mode_t mode);
+
+int
+SMBC_rmdir_ctx(SMBCCTX *context,
+               const char *fname);
+
+off_t
+SMBC_telldir_ctx(SMBCCTX *context,
+                 SMBCFILE *dir);
+
+int
+SMBC_lseekdir_ctx(SMBCCTX *context,
+                  SMBCFILE *dir,
+                  off_t offset);
+
+int
+SMBC_fstatdir_ctx(SMBCCTX *context,
+                  SMBCFILE *dir,
+                  struct stat *st);
+
+int
+SMBC_chmod_ctx(SMBCCTX *context,
+               const char *fname,
+               mode_t newmode);
+
+int
+SMBC_utimes_ctx(SMBCCTX *context,
+                const char *fname,
+                struct timeval *tbuf);
+
+int
+SMBC_unlink_ctx(SMBCCTX *context,
+                const char *fname);
+
+int
+SMBC_rename_ctx(SMBCCTX *ocontext,
+                const char *oname, 
+                SMBCCTX *ncontext,
+                const char *nname);
+
+
+/* Functions in libsmb_file.c */
+SMBCFILE *
+SMBC_open_ctx(SMBCCTX *context,
+              const char *fname,
+              int flags,
+              mode_t mode);
+
+SMBCFILE *
+SMBC_creat_ctx(SMBCCTX *context,
+               const char *path,
+               mode_t mode);
+
+ssize_t
+SMBC_read_ctx(SMBCCTX *context,
+              SMBCFILE *file,
+              void *buf,
+              size_t count);
+
+ssize_t
+SMBC_write_ctx(SMBCCTX *context,
+               SMBCFILE *file,
+               void *buf,
+               size_t count);
+
+int
+SMBC_close_ctx(SMBCCTX *context,
+               SMBCFILE *file);
+
+bool
+SMBC_getatr(SMBCCTX * context,
+            SMBCSRV *srv,
+            char *path,
+            uint16 *mode,
+            SMB_OFF_T *size,
+            struct timespec *create_time_ts,
+            struct timespec *access_time_ts,
+            struct timespec *write_time_ts,
+            struct timespec *change_time_ts,
+            SMB_INO_T *ino);
+
+bool
+SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path, 
+            time_t create_time,
+            time_t access_time,
+            time_t write_time,
+            time_t change_time,
+            uint16 mode);
+
+off_t
+SMBC_lseek_ctx(SMBCCTX *context,
+               SMBCFILE *file,
+               off_t offset,
+               int whence);
+
+int
+SMBC_ftruncate_ctx(SMBCCTX *context,
+                   SMBCFILE *file,
+                   off_t length);
+
+
+/* Functions in libsmb_misc.c */
+int
+SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
+
+int
+SMBC_errno(SMBCCTX *context,
+           struct cli_state *c);
+
+
+/* Functions in libsmb_path.c */
+int
+SMBC_urldecode(char *dest,
+               char *src,
+               size_t max_dest_len);
+
+int
+SMBC_urlencode(char *dest,
+               char *src,
+               int max_dest_len);
+
+int
+SMBC_parse_path(TALLOC_CTX *ctx,
+		SMBCCTX *context,
+                const char *fname,
+                char **pp_workgroup,
+                char **pp_server,
+                char **pp_share,
+                char **pp_path,
+		char **pp_user,
+                char **pp_password,
+                char **pp_options);
+
+
+/* Functions in libsmb_printjob.c */
+SMBCFILE *
+SMBC_open_print_job_ctx(SMBCCTX *context,
+                        const char *fname);
+
+int
+SMBC_print_file_ctx(SMBCCTX *c_file,
+                    const char *fname,
+                    SMBCCTX *c_print,
+                    const char *printq);
+
+int
+SMBC_list_print_jobs_ctx(SMBCCTX *context,
+                         const char *fname,
+                         smbc_list_print_job_fn fn);
+
+int
+SMBC_unlink_print_job_ctx(SMBCCTX *context,
+                          const char *fname,
+                          int id);
+
+
+/* Functions in libsmb_server.c */
+int
+SMBC_check_server(SMBCCTX * context,
+                  SMBCSRV * server);
+
+int
+SMBC_remove_unused_server(SMBCCTX * context,
+                          SMBCSRV * srv);
+
+void
+SMBC_call_auth_fn(TALLOC_CTX *ctx,
+                  SMBCCTX *context,
+                  const char *server,
+                  const char *share,
+                  char **pp_workgroup,
+                  char **pp_username,
+                  char **pp_password);
+
+void
+SMBC_get_auth_data(const char *server, const char *share,
+                   char *workgroup_buf, int workgroup_buf_len,
+                   char *username_buf, int username_buf_len,
+                   char *password_buf, int password_buf_len);
+
+SMBCSRV *
+SMBC_find_server(TALLOC_CTX *ctx,
+                 SMBCCTX *context,
+                 const char *server,
+                 const char *share,
+                 char **pp_workgroup,
+                 char **pp_username,
+                 char **pp_password);
+
+SMBCSRV *
+SMBC_server(TALLOC_CTX *ctx,
+            SMBCCTX *context,
+            bool connect_if_not_found,
+            const char *server,
+            const char *share,
+            char **pp_workgroup,
+            char **pp_username,
+            char **pp_password);
+
+SMBCSRV *
+SMBC_attr_server(TALLOC_CTX *ctx,
+                 SMBCCTX *context,
+                 const char *server,
+                 const char *share,
+                 char **pp_workgroup,
+                 char **pp_username,
+                 char **pp_password);
+
+
+/* Functions in libsmb_stat.c */
+int
+SMBC_stat_ctx(SMBCCTX *context,
+              const char *fname,
+              struct stat *st);
+
+int
+SMBC_fstat_ctx(SMBCCTX *context,
+               SMBCFILE *file,
+               struct stat *st);
+
+
+/* Functions in libsmb_xattr.c */
+int
+SMBC_setxattr_ctx(SMBCCTX *context,
+                  const char *fname,
+                  const char *name,
+                  const void *value,
+                  size_t size,
+                  int flags);
+
+int
+SMBC_getxattr_ctx(SMBCCTX *context,
+                  const char *fname,
+                  const char *name,
+                  const void *value,
+                  size_t size);
+
+int
+SMBC_removexattr_ctx(SMBCCTX *context,
+                     const char *fname,
+                     const char *name);
+
+int
+SMBC_listxattr_ctx(SMBCCTX *context,
+                   const char *fname,
+                   char *list,
+                   size_t size);
+
 
 #endif