The Samba-Bugzilla – Attachment 2256 Details for
Bug 4053
off_t size in libsmbclient.h depends on LFS defines
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Requests
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
restricted LFS support
patch-libsmbclient-require-lfs (text/plain), 174.58 KB, created by
Samuel Thibault
on 2007-01-14 19:02:09 UTC
(
hide
)
Description:
restricted LFS support
Filename:
MIME Type:
Creator:
Samuel Thibault
Created:
2007-01-14 19:02:09 UTC
Size:
174.58 KB
patch
obsolete
>diff -urN samba-3.0.23d/source/configure.in samba-3.0.23d-require-lfs/source/configure.in >--- samba-3.0.23d/source/configure.in 2006-11-14 15:42:15.000000000 +0100 >+++ samba-3.0.23d-require-lfs/source/configure.in 2007-01-15 01:40:38.000000000 +0100 >@@ -4,6 +4,7 @@ > AC_PREREQ(2.53) > AC_INIT(include/includes.h) > AC_CONFIG_HEADER(include/config.h) >+AC_CONFIG_HEADER(include/libsmbclient.h) > > AC_DISABLE_STATIC > AC_ENABLE_SHARED >@@ -678,6 +679,7 @@ > LDFLAGS="$LDFLAGS -lthread" > AC_DEFINE(_LARGEFILE64_SOURCE, 1, [Whether to enable large file support]) > AC_DEFINE(_FILE_OFFSET_BITS, 64, [File offset bits]) >+ AC_DEFINE(SMBC_FILE_OFFSET_BITS, 64, [Libsmbclient file offset bits]) > ;; > esac > else >@@ -685,6 +687,7 @@ > LDFLAGS="$LDFLAGS -lthread" > AC_DEFINE(_LARGEFILE64_SOURCE, 1, [Whether to enable large file support]) > AC_DEFINE(_FILE_OFFSET_BITS, 64, [File offset bits]) >+ AC_DEFINE(SMBC_FILE_OFFSET_BITS, 64, [Libsmbclient file offset bits]) > fi > ;; > esac >@@ -795,6 +798,7 @@ > CPPFLAGS="-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64 -D_GNU_SOURCE $CPPFLAGS" > AC_DEFINE(_LARGEFILE64_SOURCE, 1, [Whether to enable large file support]) > AC_DEFINE(_FILE_OFFSET_BITS, 64, [File offset bits]) >+ AC_DEFINE(SMBC_FILE_OFFSET_BITS, 64, [Libsmbclient file offset bits]) > AC_DEFINE(_GNU_SOURCE, 1, [Whether to use GNU libc extensions]) > fi > AC_MSG_RESULT([$LINUX_LFS_SUPPORT]) >diff -urN samba-3.0.23d/source/include/libsmbclient.h samba-3.0.23d-require-lfs/source/include/libsmbclient.h >--- samba-3.0.23d/source/include/libsmbclient.h 2006-04-20 04:29:39.000000000 +0200 >+++ samba-3.0.23d-require-lfs/source/include/libsmbclient.h 1970-01-01 01:00:00.000000000 +0100 >@@ -1,2179 +0,0 @@ >-/*===================================================================== >- Unix SMB/Netbios implementation. >- SMB client library API definitions >- Copyright (C) Andrew Tridgell 1998 >- Copyright (C) Richard Sharpe 2000 >- Copyright (C) John Terpsra 2000 >- Copyright (C) Tom Jansen (Ninja ISD) 2002 >- Copyright (C) Derrell Lipman 2003 >- >- >- 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 2 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, write to the Free Software >- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. >- =====================================================================*/ >- >-#ifndef SMBCLIENT_H_INCLUDED >-#define SMBCLIENT_H_INCLUDED >- >-#ifdef __cplusplus >-extern "C" { >-#endif >- >-/*-------------------------------------------------------------------*/ >-/* The following are special comments to instruct DOXYGEN (automated >- * documentation tool: >-*/ >-/** \defgroup libsmbclient >-*/ >-/** \defgroup structure Data Structures Type and Constants >-* \ingroup libsmbclient >-* Data structures, types, and constants >-*/ >-/** \defgroup callback Callback function types >-* \ingroup libsmbclient >-* Callback functions >-*/ >-/** \defgroup file File Functions >-* \ingroup libsmbclient >-* Functions used to access individual file contents >-*/ >-/** \defgroup directory Directory Functions >-* \ingroup libsmbclient >-* Functions used to access directory entries >-*/ >-/** \defgroup attribute Attributes Functions >-* \ingroup libsmbclient >-* Functions used to view or change file and directory attributes >-*/ >-/** \defgroup print Print Functions >-* \ingroup libsmbclient >-* Functions used to access printing functionality >-*/ >-/** \defgroup misc Miscellaneous Functions >-* \ingroup libsmbclient >-* Functions that don't fit in to other categories >-*/ >-/*-------------------------------------------------------------------*/ >- >-/* Make sure we have the following includes for now ... */ >-#include <sys/types.h> >-#include <sys/stat.h> >-#include <fcntl.h> >-#include <utime.h> >- >-#define SMBC_BASE_FD 10000 /* smallest file descriptor returned */ >- >-#define SMBC_WORKGROUP 1 >-#define SMBC_SERVER 2 >-#define SMBC_FILE_SHARE 3 >-#define SMBC_PRINTER_SHARE 4 >-#define SMBC_COMMS_SHARE 5 >-#define SMBC_IPC_SHARE 6 >-#define SMBC_DIR 7 >-#define SMBC_FILE 8 >-#define SMBC_LINK 9 >- >-/**@ingroup structure >- * Structure that represents a directory entry. >- * >- */ >-struct smbc_dirent >-{ >- /** Type of entity. >- SMBC_WORKGROUP=1, >- SMBC_SERVER=2, >- SMBC_FILE_SHARE=3, >- SMBC_PRINTER_SHARE=4, >- SMBC_COMMS_SHARE=5, >- SMBC_IPC_SHARE=6, >- SMBC_DIR=7, >- SMBC_FILE=8, >- SMBC_LINK=9,*/ >- unsigned int smbc_type; >- >- /** Length of this smbc_dirent in bytes >- */ >- unsigned int dirlen; >- /** The length of the comment string in bytes (does not include >- * null terminator) >- */ >- unsigned int commentlen; >- /** Points to the null terminated comment string >- */ >- char *comment; >- /** The length of the name string in bytes (does not include >- * null terminator) >- */ >- unsigned int namelen; >- /** Points to the null terminated name string >- */ >- char name[1]; >-}; >- >-/* >- * Flags for smbc_setxattr() >- * Specify a bitwise OR of these, or 0 to add or replace as necessary >- */ >-#define SMBC_XATTR_FLAG_CREATE 0x1 /* fail if attr already exists */ >-#define SMBC_XATTR_FLAG_REPLACE 0x2 /* fail if attr does not exist */ >- >- >-/* >- * Mappings of the DOS mode bits, as returned by smbc_getxattr() when the >- * attribute name "system.dos_attr.mode" (or "system.dos_attr.*" or >- * "system.*") is specified. >- */ >-#define SMBC_DOS_MODE_READONLY 0x01 >-#define SMBC_DOS_MODE_HIDDEN 0x02 >-#define SMBC_DOS_MODE_SYSTEM 0x04 >-#define SMBC_DOS_MODE_VOLUME_ID 0x08 >-#define SMBC_DOS_MODE_DIRECTORY 0x10 >-#define SMBC_DOS_MODE_ARCHIVE 0x20 >- >- >-#ifndef ENOATTR >-# define ENOATTR ENOENT /* No such attribute */ >-#endif >- >- >- >- >-/**@ingroup structure >- * Structure that represents a print job. >- * >- */ >-#ifndef _CLIENT_H >-struct print_job_info >-{ >- /** numeric ID of the print job >- */ >- unsigned short id; >- >- /** represents print job priority (lower numbers mean higher priority) >- */ >- unsigned short priority; >- >- /** Size of the print job >- */ >- size_t size; >- >- /** Name of the user that owns the print job >- */ >- char user[128]; >- >- /** Name of the print job. This will have no name if an anonymous print >- * file was opened. Ie smb://server/printer >- */ >- char name[128]; >- >- /** Time the print job was spooled >- */ >- time_t t; >-}; >-#endif /* _CLIENT_H */ >- >- >-/**@ingroup structure >- * Server handle >- */ >-typedef struct _SMBCSRV SMBCSRV; >- >-/**@ingroup structure >- * File or directory handle >- */ >-typedef struct _SMBCFILE SMBCFILE; >- >-/**@ingroup structure >- * File or directory handle >- */ >-typedef struct _SMBCCTX SMBCCTX; >- >- >- >- >- >-/**@ingroup callback >- * Authentication callback function type (traditional method) >- * >- * Type for the the authentication function called by the library to >- * obtain authentication credentals >- * >- * @param srv Server being authenticated to >- * >- * @param shr Share being authenticated to >- * >- * @param wg Pointer to buffer containing a "hint" for the >- * workgroup to be authenticated. Should be filled in >- * with the correct workgroup if the hint is wrong. >- * >- * @param wglen The size of the workgroup buffer in bytes >- * >- * @param un Pointer to buffer containing a "hint" for the >- * user name to be use for authentication. Should be >- * filled in with the correct workgroup if the hint is >- * wrong. >- * >- * @param unlen The size of the username buffer in bytes >- * >- * @param pw Pointer to buffer containing to which password >- * copied >- * >- * @param pwlen The size of the password buffer in bytes >- * >- */ >-typedef void (*smbc_get_auth_data_fn)(const char *srv, >- const char *shr, >- char *wg, int wglen, >- char *un, int unlen, >- char *pw, int pwlen); >-/**@ingroup callback >- * Authentication callback function type (method that includes context) >- * >- * Type for the the authentication function called by the library to >- * obtain authentication credentals >- * >- * @param c Pointer to the smb context >- * >- * @param srv Server being authenticated to >- * >- * @param shr Share being authenticated to >- * >- * @param wg Pointer to buffer containing a "hint" for the >- * workgroup to be authenticated. Should be filled in >- * with the correct workgroup if the hint is wrong. >- * >- * @param wglen The size of the workgroup buffer in bytes >- * >- * @param un Pointer to buffer containing a "hint" for the >- * user name to be use for authentication. Should be >- * filled in with the correct workgroup if the hint is >- * wrong. >- * >- * @param unlen The size of the username buffer in bytes >- * >- * @param pw Pointer to buffer containing to which password >- * copied >- * >- * @param pwlen The size of the password buffer in bytes >- * >- */ >-typedef void (*smbc_get_auth_data_with_context_fn)(SMBCCTX *c, >- const char *srv, >- const char *shr, >- char *wg, int wglen, >- char *un, int unlen, >- char *pw, int pwlen); >- >- >-/**@ingroup callback >- * Print job info callback function type. >- * >- * @param i pointer to print job information structure >- * >- */ >-typedef void (*smbc_list_print_job_fn)(struct print_job_info *i); >- >- >-/**@ingroup callback >- * Check if a server is still good >- * >- * @param c pointer to smb context >- * >- * @param srv pointer to server to check >- * >- * @return 0 when connection is good. 1 on error. >- * >- */ >-typedef int (*smbc_check_server_fn)(SMBCCTX * c, SMBCSRV *srv); >- >-/**@ingroup callback >- * Remove a server if unused >- * >- * @param c pointer to smb context >- * >- * @param srv pointer to server to remove >- * >- * @return 0 on success. 1 on failure. >- * >- */ >-typedef int (*smbc_remove_unused_server_fn)(SMBCCTX * c, SMBCSRV *srv); >- >- >-/**@ingroup callback >- * Add a server to the cache system >- * >- * @param c pointer to smb context >- * >- * @param srv pointer to server to add >- * >- * @param server server name >- * >- * @param share share name >- * >- * @param workgroup workgroup used to connect >- * >- * @param username username used to connect >- * >- * @return 0 on success. 1 on failure. >- * >- */ >-typedef int (*smbc_add_cached_srv_fn) (SMBCCTX * c, SMBCSRV *srv, >- const char * server, const char * share, >- const char * workgroup, const char * username); >- >-/**@ingroup callback >- * Look up a server in the cache system >- * >- * @param c pointer to smb context >- * >- * @param server server name to match >- * >- * @param share share name to match >- * >- * @param workgroup workgroup to match >- * >- * @param username username to match >- * >- * @return pointer to SMBCSRV on success. NULL on failure. >- * >- */ >-typedef SMBCSRV * (*smbc_get_cached_srv_fn) (SMBCCTX * c, const char * server, >- const char * share, const char * workgroup, >- const char * username); >- >-/**@ingroup callback >- * Check if a server is still good >- * >- * @param c pointer to smb context >- * >- * @param srv pointer to server to remove >- * >- * @return 0 when found and removed. 1 on failure. >- * >- */ >-typedef int (*smbc_remove_cached_srv_fn)(SMBCCTX * c, SMBCSRV *srv); >- >- >-/**@ingroup callback >- * Try to remove all servers from the cache system and disconnect >- * >- * @param c pointer to smb context >- * >- * @return 0 when found and removed. 1 on failure. >- * >- */ >-typedef int (*smbc_purge_cached_fn) (SMBCCTX * c); >- >- >-/**@ingroup structure >- * Structure that contains a client context information >- * This structure is know as SMBCCTX >- */ >-struct _SMBCCTX { >- /** debug level >- */ >- int debug; >- >- /** netbios name used for making connections >- */ >- char * netbios_name; >- >- /** workgroup name used for making connections >- */ >- char * workgroup; >- >- /** username used for making connections >- */ >- char * user; >- >- /** timeout used for waiting on connections / response data (in milliseconds) >- */ >- int timeout; >- >- /** callable functions for files: >- * For usage and return values see the smbc_* functions >- */ >- SMBCFILE * (*open) (SMBCCTX *c, const char *fname, int flags, mode_t mode); >- SMBCFILE * (*creat) (SMBCCTX *c, const char *path, mode_t mode); >- ssize_t (*read) (SMBCCTX *c, SMBCFILE *file, void *buf, size_t count); >- ssize_t (*write) (SMBCCTX *c, SMBCFILE *file, void *buf, size_t count); >- int (*unlink) (SMBCCTX *c, const char *fname); >- int (*rename) (SMBCCTX *ocontext, const char *oname, >- SMBCCTX *ncontext, const char *nname); >- off_t (*lseek) (SMBCCTX *c, SMBCFILE * file, off_t offset, int whence); >- int (*stat) (SMBCCTX *c, const char *fname, struct stat *st); >- int (*fstat) (SMBCCTX *c, SMBCFILE *file, struct stat *st); >- int (*close_fn) (SMBCCTX *c, SMBCFILE *file); >- >- /** callable functions for dirs >- */ >- SMBCFILE * (*opendir) (SMBCCTX *c, const char *fname); >- int (*closedir)(SMBCCTX *c, SMBCFILE *dir); >- struct smbc_dirent * (*readdir)(SMBCCTX *c, SMBCFILE *dir); >- int (*getdents)(SMBCCTX *c, SMBCFILE *dir, >- struct smbc_dirent *dirp, int count); >- int (*mkdir) (SMBCCTX *c, const char *fname, mode_t mode); >- int (*rmdir) (SMBCCTX *c, const char *fname); >- off_t (*telldir) (SMBCCTX *c, SMBCFILE *dir); >- int (*lseekdir)(SMBCCTX *c, SMBCFILE *dir, off_t offset); >- int (*fstatdir)(SMBCCTX *c, SMBCFILE *dir, struct stat *st); >- int (*chmod)(SMBCCTX *c, const char *fname, mode_t mode); >- int (*utimes)(SMBCCTX *c, >- const char *fname, struct timeval *tbuf); >- int (*setxattr)(SMBCCTX *context, >- const char *fname, >- const char *name, >- const void *value, >- size_t size, >- int flags); >- int (*getxattr)(SMBCCTX *context, >- const char *fname, >- const char *name, >- const void *value, >- size_t size); >- int (*removexattr)(SMBCCTX *context, >- const char *fname, >- const char *name); >- int (*listxattr)(SMBCCTX *context, >- const char *fname, >- char *list, >- size_t size); >- >- /** callable functions for printing >- */ >- int (*print_file)(SMBCCTX *c_file, const char *fname, >- SMBCCTX *c_print, const char *printq); >- SMBCFILE * (*open_print_job)(SMBCCTX *c, const char *fname); >- int (*list_print_jobs)(SMBCCTX *c, const char *fname, smbc_list_print_job_fn fn); >- int (*unlink_print_job)(SMBCCTX *c, const char *fname, int id); >- >- >- /* >- ** Callbacks >- * These callbacks _always_ have to be initialized because they will >- * not be checked at dereference for increased speed. >- */ >- struct _smbc_callbacks { >- /** authentication function callback: called upon auth requests >- */ >- smbc_get_auth_data_fn auth_fn; >- >- /** check if a server is still good >- */ >- smbc_check_server_fn check_server_fn; >- >- /** remove a server if unused >- */ >- smbc_remove_unused_server_fn remove_unused_server_fn; >- >- /** Cache subsystem >- * For an example cache system see samba/source/libsmb/libsmb_cache.c >- * Cache subsystem functions follow. >- */ >- >- /** server cache addition >- */ >- smbc_add_cached_srv_fn add_cached_srv_fn; >- >- /** server cache lookup >- */ >- smbc_get_cached_srv_fn get_cached_srv_fn; >- >- /** server cache removal >- */ >- smbc_remove_cached_srv_fn remove_cached_srv_fn; >- >- /** server cache purging, try to remove all cached servers (disconnect) >- */ >- smbc_purge_cached_fn purge_cached_fn; >- } callbacks; >- >- >- /** Space to store private data of the server cache. >- */ >- struct smbc_server_cache * server_cache; >- >- int flags; >- >- /** user options selections that apply to this session >- */ >- struct _smbc_options { >- >- /* >- * 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. >- */ >- int 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. >- */ >- int one_share_per_server; >- } options; >- >- /** INTERNAL DATA >- * do _NOT_ touch this from your program ! >- */ >- struct smbc_internal_data * internal; >-}; >- >-/* Flags for SMBCCTX->flags */ >-#define SMB_CTX_FLAG_USE_KERBEROS (1 << 0) >-#define SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS (1 << 1) >-#define SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON (1 << 2) /* don't try to do automatic anon login */ >- >-/**@ingroup misc >- * Create a new SBMCCTX (a context). >- * >- * Must be called before the context is passed to smbc_context_init() >- * >- * @return The given SMBCCTX pointer on success, NULL on error with errno set: >- * - ENOMEM Out of memory >- * >- * @see smbc_free_context(), smbc_init_context() >- * >- * @note Do not forget to smbc_init_context() the returned SMBCCTX pointer ! >- */ >-SMBCCTX * smbc_new_context(void); >- >-/**@ingroup misc >- * Delete a SBMCCTX (a context) acquired from smbc_new_context(). >- * >- * The context will be deleted if possible. >- * >- * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >- * >- * @param shutdown_ctx If 1, all connections and files will be closed even if they are busy. >- * >- * >- * @return Returns 0 on succes. Returns 1 on failure with errno set: >- * - EBUSY Server connections are still used, Files are open or cache >- * could not be purged >- * - EBADF context == NULL >- * >- * @see smbc_new_context() >- * >- * @note It is advised to clean up all the contexts with shutdown_ctx set to 1 >- * just before exit()'ing. When shutdown_ctx is 0, this function can be >- * use in periodical cleanup functions for example. >- */ >-int smbc_free_context(SMBCCTX * context, int shutdown_ctx); >- >- >-/**@ingroup misc >- * Each time the context structure is changed, we have binary backward >- * compatibility issues. Instead of modifying the public portions of the >- * context structure to add new options, instead, we put them in the internal >- * portion of the context structure and provide a set function for these new >- * options. >- * >- * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >- * >- * @param option_name >- * The name of the option for which the value is to be set >- * >- * @param option_value >- * The new value of the option being set >- * >- */ >-void >-smbc_option_set(SMBCCTX *context, >- char *option_name, >- void *option_value); >-/* >- * Retrieve the current value of an option >- * >- * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >- * >- * @param option_name >- * The name of the option for which the value is to be >- * retrieved >- * >- * @return The value of the specified option. >- */ >-void * >-smbc_option_get(SMBCCTX *context, >- char *option_name); >- >-/**@ingroup misc >- * Initialize a SBMCCTX (a context). >- * >- * Must be called before using any SMBCCTX API function >- * >- * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >- * >- * @return A pointer to the given SMBCCTX on success, >- * NULL on error with errno set: >- * - EBADF NULL context given >- * - ENOMEM Out of memory >- * - ENOENT The smb.conf file would not load >- * >- * @see smbc_new_context() >- * >- * @note my_context = smbc_init_context(smbc_new_context()) >- * is perfectly safe, but it might leak memory on >- * smbc_context_init() failure. Avoid this. >- * You'll have to call smbc_free_context() yourself >- * on failure. >- */ >- >-SMBCCTX * smbc_init_context(SMBCCTX * context); >- >-/**@ingroup misc >- * Initialize the samba client library. >- * >- * Must be called before using any of the smbclient API function >- * >- * @param fn The function that will be called to obtaion >- * authentication credentials. >- * >- * @param debug Allows caller to set the debug level. Can be >- * changed in smb.conf file. Allows caller to set >- * debugging if no smb.conf. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - ENOMEM Out of memory >- * - ENOENT The smb.conf file would not load >- * >- */ >- >-int smbc_init(smbc_get_auth_data_fn fn, int debug); >- >-/**@ingroup misc >- * Set or retrieve the compatibility library's context pointer >- * >- * @param context New context to use, or NULL. If a new context is provided, >- * it must have allocated with smbc_new_context() and >- * initialized with smbc_init_context(), followed, optionally, >- * by some manual changes to some of the non-internal fields. >- * >- * @return The old context. >- * >- * @see smbc_new_context(), smbc_init_context(), smbc_init() >- * >- * @note This function may be called prior to smbc_init() to force >- * use of the next context without any internal calls to >- * smbc_new_context() or smbc_init_context(). It may also >- * be called after smbc_init() has already called those two >- * functions, to replace the existing context with a new one. >- * Care should be taken, in this latter case, to ensure that >- * the server cache and any data allocated by the >- * authentication functions have been freed, if necessary. >- */ >- >-SMBCCTX * smbc_set_context(SMBCCTX * new_context); >- >-/**@ingroup file >- * Open a file on an SMB server. >- * >- * @param furl The smb url of the file to be opened. >- * >- * @param flags Is one of O_RDONLY, O_WRONLY or O_RDWR which >- * request opening the file read-only,write-only >- * or read/write. flags may also be bitwise-or'd with >- * one or more of the following: >- * O_CREAT - If the file does not exist it will be >- * created. >- * O_EXCL - When used with O_CREAT, if the file >- * already exists it is an error and the open will >- * fail. >- * O_TRUNC - If the file already exists it will be >- * truncated. >- * O_APPEND The file is opened in append mode >- * >- * @param mode mode specifies the permissions to use if a new >- * file is created. It is modified by the >- * process's umask in the usual way: the permissions >- * of the created file are (mode & ~umask) >- * >- * Not currently use, but there for future use. >- * We will map this to SYSTEM, HIDDEN, etc bits >- * that reverses the mapping that smbc_fstat does. >- * >- * @return Valid file handle, < 0 on error with errno set: >- * - ENOMEM Out of memory >- * - EINVAL if an invalid parameter passed, like no >- * file, or smbc_init not called. >- * - EEXIST pathname already exists and O_CREAT and >- * O_EXCL were used. >- * - EISDIR pathname refers to a directory and >- * the access requested involved writing. >- * - EACCES The requested access to the file is not >- * allowed >- * - ENODEV The requested share does not exist >- * - ENOTDIR A file on the path is not a directory >- * - ENOENT A directory component in pathname does >- * not exist. >- * >- * @see smbc_creat() >- * >- * @note This call uses an underlying routine that may create >- * a new connection to the server specified in the URL. >- * If the credentials supplied in the URL, or via the >- * auth_fn in the smbc_init call, fail, this call will >- * try again with an empty username and password. This >- * often gets mapped to the guest account on some machines. >- */ >- >-int smbc_open(const char *furl, int flags, mode_t mode); >- >-/**@ingroup file >- * Create a file on an SMB server. >- * >- * Same as calling smbc_open() with flags = O_CREAT|O_WRONLY|O_TRUNC >- * >- * @param furl The smb url of the file to be created >- * >- * @param mode mode specifies the permissions to use if a new >- * file is created. It is modified by the >- * process's umask in the usual way: the permissions >- * of the created file are (mode & ~umask) >- * >- * NOTE, the above is not true. We are dealing with >- * an SMB server, which has no concept of a umask! >- * >- * @return Valid file handle, < 0 on error with errno set: >- * - ENOMEM Out of memory >- * - EINVAL if an invalid parameter passed, like no >- * file, or smbc_init not called. >- * - EEXIST pathname already exists and O_CREAT and >- * O_EXCL were used. >- * - EISDIR pathname refers to a directory and >- * the access requested involved writing. >- * - EACCES The requested access to the file is not >- * allowed >- * - ENOENT A directory component in pathname does >- * not exist. >- * - ENODEV The requested share does not exist. >- * @see smbc_open() >- * >- */ >- >-int smbc_creat(const char *furl, mode_t mode); >- >-/**@ingroup file >- * Read from a file using an opened file handle. >- * >- * @param fd Open file handle from smbc_open() or smbc_creat() >- * >- * @param buf Pointer to buffer to recieve read data >- * >- * @param bufsize Size of buf in bytes >- * >- * @return Number of bytes read, < 0 on error with errno set: >- * - EISDIR fd refers to a directory >- * - EBADF fd is not a valid file descriptor or >- * is not open for reading. >- * - EINVAL fd is attached to an object which is >- * unsuitable for reading, or no buffer passed or >- * smbc_init not called. >- * >- * @see smbc_open(), smbc_write() >- * >- */ >-ssize_t smbc_read(int fd, void *buf, size_t bufsize); >- >- >-/**@ingroup file >- * Write to a file using an opened file handle. >- * >- * @param fd Open file handle from smbc_open() or smbc_creat() >- * >- * @param buf Pointer to buffer to recieve read data >- * >- * @param bufsize Size of buf in bytes >- * >- * @return Number of bytes written, < 0 on error with errno set: >- * - EISDIR fd refers to a directory. >- * - EBADF fd is not a valid file descriptor or >- * is not open for reading. >- * - EINVAL fd is attached to an object which is >- * unsuitable for reading, or no buffer passed or >- * smbc_init not called. >- * >- * @see smbc_open(), smbc_read() >- * >- */ >-ssize_t smbc_write(int fd, void *buf, size_t bufsize); >- >- >-/**@ingroup file >- * Seek to a specific location in a file. >- * >- * @param fd Open file handle from smbc_open() or smbc_creat() >- * >- * @param offset Offset in bytes from whence >- * >- * @param whence A location in the file: >- * - SEEK_SET The offset is set to offset bytes from >- * the beginning of the file >- * - SEEK_CUR The offset is set to current location >- * plus offset bytes. >- * - SEEK_END The offset is set to the size of the >- * file plus offset bytes. >- * >- * @return Upon successful completion, lseek returns the >- * resulting offset location as measured in bytes >- * from the beginning of the file. Otherwise, a value >- * of (off_t)-1 is returned and errno is set to >- * indicate the error: >- * - EBADF Fildes is not an open file descriptor. >- * - EINVAL Whence is not a proper value or smbc_init >- * not called. >- * >- * @todo Are all the whence values really supported? >- * >- * @todo Are errno values complete and correct? >- */ >-off_t smbc_lseek(int fd, off_t offset, int whence); >- >- >-/**@ingroup file >- * Close an open file handle. >- * >- * @param fd The file handle to close >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EBADF fd isn't a valid open file descriptor >- * - EINVAL smbc_init() failed or has not been called >- * >- * @see smbc_open(), smbc_creat() >- */ >-int smbc_close(int fd); >- >- >-/**@ingroup directory >- * Unlink (delete) a file or directory. >- * >- * @param furl The smb url of the file to delete >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EACCES or EPERM Write access to the directory >- * containing pathname is not allowed or one >- * of the directories in pathname did not allow >- * search (execute) permission >- * - ENOENT A directory component in pathname does >- * not exist >- * - EINVAL NULL was passed in the file param or >- * smbc_init not called. >- * - EACCES You do not have access to the file >- * - ENOMEM Insufficient kernel memory was available >- * >- * @see smbc_rmdir()s >- * >- * @todo Are errno values complete and correct? >- */ >-int smbc_unlink(const char *furl); >- >- >-/**@ingroup directory >- * Rename or move a file or directory. >- * >- * @param ourl The original smb url (source url) of file or >- * directory to be moved >- * >- * @param nurl The new smb url (destination url) of the file >- * or directory after the move. Currently nurl must >- * be on the same share as ourl. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EISDIR nurl is an existing directory, but ourl is >- * not a directory. >- * - EEXIST nurl is a non-empty directory, >- * i.e., contains entries other than "." and ".." >- * - EINVAL The new url contained a path prefix >- * of the old, or, more generally, an attempt was >- * made to make a directory a subdirectory of itself >- * or smbc_init not called. >- * - ENOTDIR A component used as a directory in ourl >- * or nurl path is not, in fact, a directory. Or, >- * ourl is a directory, and newpath exists but is not >- * a directory. >- * - EACCES or EPERM Write access to the directory >- * containing ourl or nurl is not allowed for the >- * process's effective uid, or one of the >- * directories in ourl or nurl did not allow search >- * (execute) permission, or ourl was a directory >- * and did not allow write permission. >- * - ENOENT A directory component in ourl or nurl >- * does not exist. >- * - EXDEV Rename across shares not supported. >- * - ENOMEM Insufficient kernel memory was available. >- * - EEXIST The target file, nurl, already exists. >- * >- * >- * @todo Are we going to support copying when urls are not on the same >- * share? I say no... NOTE. I agree for the moment. >- * >- */ >-int smbc_rename(const char *ourl, const char *nurl); >- >- >-/**@ingroup directory >- * Open a directory used to obtain directory entries. >- * >- * @param durl The smb url of the directory to open >- * >- * @return Valid directory handle. < 0 on error with errno set: >- * - EACCES Permission denied. >- * - EINVAL A NULL file/URL was passed, or the URL would >- * not parse, or was of incorrect form or smbc_init not >- * called. >- * - ENOENT durl does not exist, or name is an >- * - ENOMEM Insufficient memory to complete the >- * operation. >- * - ENOTDIR name is not a directory. >- * - EPERM the workgroup could not be found. >- * - ENODEV the workgroup or server could not be found. >- * >- * @see smbc_getdents(), smbc_readdir(), smbc_closedir() >- * >- */ >-int smbc_opendir(const char *durl); >- >- >-/**@ingroup directory >- * Close a directory handle opened by smbc_opendir(). >- * >- * @param dh Directory handle to close >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EBADF dh is an invalid directory handle >- * >- * @see smbc_opendir() >- */ >-int smbc_closedir(int dh); >- >- >-/**@ingroup directory >- * Get multiple directory entries. >- * >- * smbc_getdents() reads as many dirent structures from the an open >- * directory handle into a specified memory area as will fit. >- * >- * @param dh Valid directory as returned by smbc_opendir() >- * >- * @param dirp pointer to buffer that will receive the directory >- * entries. >- * >- * @param count The size of the dirp buffer in bytes >- * >- * @returns If any dirents returned, return will indicate the >- * total size. If there were no more dirents available, >- * 0 is returned. < 0 indicates an error. >- * - EBADF Invalid directory handle >- * - EINVAL Result buffer is too small or smbc_init >- * not called. >- * - ENOENT No such directory. >- * @see , smbc_dirent, smbc_readdir(), smbc_open() >- * >- * @todo Are errno values complete and correct? >- * >- * @todo Add example code so people know how to parse buffers. >- */ >-int smbc_getdents(unsigned int dh, struct smbc_dirent *dirp, int count); >- >- >-/**@ingroup directory >- * Get a single directory entry. >- * >- * @param dh Valid directory as returned by smbc_opendir() >- * >- * @return A pointer to a smbc_dirent structure, or NULL if an >- * error occurs or end-of-directory is reached: >- * - EBADF Invalid directory handle >- * - EINVAL smbc_init() failed or has not been called >- * >- * @see smbc_dirent, smbc_getdents(), smbc_open() >- */ >-struct smbc_dirent* smbc_readdir(unsigned int dh); >- >- >-/**@ingroup directory >- * Get the current directory offset. >- * >- * smbc_telldir() may be used in conjunction with smbc_readdir() and >- * smbc_lseekdir(). >- * >- * @param dh Valid directory as returned by smbc_opendir() >- * >- * @return The current location in the directory stream or -1 >- * if an error occur. The current location is not >- * an offset. Becuase of the implementation, it is a >- * handle that allows the library to find the entry >- * later. >- * - EBADF dh is not a valid directory handle >- * - EINVAL smbc_init() failed or has not been called >- * - ENOTDIR if dh is not a directory >- * >- * @see smbc_readdir() >- * >- */ >-off_t smbc_telldir(int dh); >- >- >-/**@ingroup directory >- * lseek on directories. >- * >- * smbc_lseekdir() may be used in conjunction with smbc_readdir() and >- * smbc_telldir(). (rewind by smbc_lseekdir(fd, NULL)) >- * >- * @param fd Valid directory as returned by smbc_opendir() >- * >- * @param offset The offset (as returned by smbc_telldir). Can be >- * NULL, in which case we will rewind >- * >- * @return 0 on success, -1 on failure >- * - EBADF dh is not a valid directory handle >- * - ENOTDIR if dh is not a directory >- * - EINVAL offset did not refer to a valid dirent or >- * smbc_init not called. >- * >- * @see smbc_telldir() >- * >- * >- * @todo In what does the reture and errno values mean? >- */ >-int smbc_lseekdir(int fd, off_t offset); >- >-/**@ingroup directory >- * Create a directory. >- * >- * @param durl The url of the directory to create >- * >- * @param mode Specifies the permissions to use. It is modified >- * by the process's umask in the usual way: the >- * permissions of the created file are (mode & ~umask). >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EEXIST directory url already exists >- * - EACCES The parent directory does not allow write >- * permission to the process, or one of the directories >- * - ENOENT A directory component in pathname does not >- * exist. >- * - EINVAL NULL durl passed or smbc_init not called. >- * - ENOMEM Insufficient memory was available. >- * >- * @see smbc_rmdir() >- * >- */ >-int smbc_mkdir(const char *durl, mode_t mode); >- >- >-/**@ingroup directory >- * Remove a directory. >- * >- * @param durl The smb url of the directory to remove >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EACCES or EPERM Write access to the directory >- * containing pathname was not allowed. >- * - EINVAL durl is NULL or smbc_init not called. >- * - ENOENT A directory component in pathname does not >- * exist. >- * - ENOTEMPTY directory contains entries. >- * - ENOMEM Insufficient kernel memory was available. >- * >- * @see smbc_mkdir(), smbc_unlink() >- * >- * @todo Are errno values complete and correct? >- */ >-int smbc_rmdir(const char *durl); >- >- >-/**@ingroup attribute >- * Get information about a file or directory. >- * >- * @param url The smb url to get information for >- * >- * @param st pointer to a buffer that will be filled with >- * standard Unix struct stat information. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - ENOENT A component of the path file_name does not >- * exist. >- * - EINVAL a NULL url was passed or smbc_init not called. >- * - EACCES Permission denied. >- * - ENOMEM Out of memory >- * - ENOTDIR The target dir, url, is not a directory. >- * >- * @see Unix stat() >- * >- */ >-int smbc_stat(const char *url, struct stat *st); >- >- >-/**@ingroup attribute >- * Get file information via an file descriptor. >- * >- * @param fd Open file handle from smbc_open() or smbc_creat() >- * >- * @param st pointer to a buffer that will be filled with >- * standard Unix struct stat information. >- * >- * @return EBADF filedes is bad. >- * - EACCES Permission denied. >- * - EBADF fd is not a valid file descriptor >- * - EINVAL Problems occurred in the underlying routines >- * or smbc_init not called. >- * - ENOMEM Out of memory >- * >- * @see smbc_stat(), Unix stat() >- * >- */ >-int smbc_fstat(int fd, struct stat *st); >- >- >-/**@ingroup attribue >- * Change the ownership of a file or directory. >- * >- * @param url The smb url of the file or directory to change >- * ownership of. >- * >- * @param owner I have no idea? >- * >- * @param group I have not idea? >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EPERM The effective UID does not match the owner >- * of the file, and is not zero; or the owner or group >- * were specified incorrectly. >- * - ENOENT The file does not exist. >- * - ENOMEM Insufficient was available. >- * - ENOENT file or directory does not exist >- * >- * @todo Are we actually going to be able to implement this function >- * >- * @todo How do we abstract owner and group uid and gid? >- * >- */ >-int smbc_chown(const char *url, uid_t owner, gid_t group); >- >- >-/**@ingroup attribute >- * Change the permissions of a file. >- * >- * @param url The smb url of the file or directory to change >- * permissions of >- * >- * @param mode The permissions to set: >- * - Put good explaination of permissions here! >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EPERM The effective UID does not match the owner >- * of the file, and is not zero >- * - ENOENT The file does not exist. >- * - ENOMEM Insufficient was available. >- * - ENOENT file or directory does not exist >- * >- * @todo Actually implement this fuction? >- * >- * @todo Are errno values complete and correct? >- */ >-int smbc_chmod(const char *url, mode_t mode); >- >-/**@ingroup attribute >- * Change the last modification time on a file >- * >- * @param url The smb url of the file or directory to change >- * the modification time of >- * >- * @param tbuf A timeval structure which contains the desired >- * modification time. NOTE: Only the tv_sec field is >- * used. The tv_usec (microseconds) portion is ignored. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - EPERM Permission was denied. >- * >- */ >-int smbc_utimes(const char *url, struct timeval *tbuf); >- >-#ifdef HAVE_UTIME_H >-/**@ingroup attribute >- * Change the last modification time on a file >- * >- * @param url The smb url of the file or directory to change >- * the modification time of >- * >- * @param utbuf A utimebuf structure which contains the desired >- * modification time. NOTE: Although the structure contains >- * an access time as well, the access time value is ignored. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - ENOMEM No memory was available for internal needs >- * - EPERM Permission was denied. >- * >- */ >-int smbc_utime(const char *fname, struct utimbuf *utbuf); >-#endif >- >-/**@ingroup attribute >- * Set extended attributes for a file. This is used for modifying a file's >- * security descriptor (i.e. owner, group, and access control list) >- * >- * @param url The smb url of the file or directory to set extended >- * attributes for. >- * >- * @param name The name of an attribute to be changed. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter should contain a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @param value The value to be assigned to the specified attribute name. >- * This buffer should contain only the attribute value if the >- * name was of the "system.nt_sec_desc.<attribute_name>" >- * form. If the name was of the "system.nt_sec_desc.*" form >- * then a complete security descriptor, with name:value pairs >- * separated by tabs, commas, or newlines (not spaces!), >- * should be provided in this value buffer. A complete >- * security descriptor will contain one or more entries >- * selected from the following: >- * >- * REVISION:<revision number> >- * OWNER:<sid or name> >- * GROUP:<sid or name> >- * ACL:<sid or name>:<type>/<flags>/<mask> >- * >- * The revision of the ACL specifies the internal Windows NT >- * ACL revision for the security descriptor. If not specified >- * it defaults to 1. Using values other than 1 may cause >- * strange behaviour. >- * >- * The owner and group specify the owner and group sids for >- * the object. If the attribute name (either '*+' with a >- * complete security descriptor, or individual 'owner+' or >- * 'group+' attribute names) ended with a plus sign, the >- * specified name is resolved to a SID value, using the >- * server on which the file or directory resides. Otherwise, >- * the value should be provided in SID-printable format as >- * S-1-x-y-z, and is used directly. The <sid or name> >- * associated with the ACL: attribute should be provided >- * similarly. >- * >- * @param size The number of the bytes of data in the value buffer >- * >- * @param flags A bit-wise OR of zero or more of the following: >- * SMBC_XATTR_FLAG_CREATE - >- * fail if the named attribute already exists >- * SMBC_XATTR_FLAG_REPLACE - >- * fail if the attribute does not already exist >- * >- * If neither flag is specified, the specified attributes >- * will be added or replace existing attributes of the same >- * name, as necessary. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * or one of the parameters is not of a correct >- * form >- * - ENOMEM No memory was available for internal needs >- * - EEXIST If the attribute already exists and the flag >- * SMBC_XATTR_FLAG_CREAT was specified >- * - ENOATTR If the attribute does not exist and the flag >- * SMBC_XATTR_FLAG_REPLACE was specified >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- * @note Attribute names are compared in a case-insensitive >- * fashion. All of the following are equivalent, although >- * the all-lower-case name is the preferred format: >- * system.nt_sec_desc.owner >- * SYSTEM.NT_SEC_DESC.OWNER >- * sYsTeM.nt_sEc_desc.owNER >- * >- */ >-int smbc_setxattr(const char *url, >- const char *name, >- const void *value, >- size_t size, >- int flags); >- >- >-/**@ingroup attribute >- * Set extended attributes for a file. This is used for modifying a file's >- * security descriptor (i.e. owner, group, and access control list). The >- * POSIX function which this maps to would act on a symbolic link rather than >- * acting on what the symbolic link points to, but with no symbolic links in >- * SMB file systems, this function is functionally identical to >- * smbc_setxattr(). >- * >- * @param url The smb url of the file or directory to set extended >- * attributes for. >- * >- * @param name The name of an attribute to be changed. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter should contain a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @param value The value to be assigned to the specified attribute name. >- * This buffer should contain only the attribute value if the >- * name was of the "system.nt_sec_desc.<attribute_name>" >- * form. If the name was of the "system.nt_sec_desc.*" form >- * then a complete security descriptor, with name:value pairs >- * separated by tabs, commas, or newlines (not spaces!), >- * should be provided in this value buffer. A complete >- * security descriptor will contain one or more entries >- * selected from the following: >- * >- * REVISION:<revision number> >- * OWNER:<sid or name> >- * GROUP:<sid or name> >- * ACL:<sid or name>:<type>/<flags>/<mask> >- * >- * The revision of the ACL specifies the internal Windows NT >- * ACL revision for the security descriptor. If not specified >- * it defaults to 1. Using values other than 1 may cause >- * strange behaviour. >- * >- * The owner and group specify the owner and group sids for >- * the object. If the attribute name (either '*+' with a >- * complete security descriptor, or individual 'owner+' or >- * 'group+' attribute names) ended with a plus sign, the >- * specified name is resolved to a SID value, using the >- * server on which the file or directory resides. Otherwise, >- * the value should be provided in SID-printable format as >- * S-1-x-y-z, and is used directly. The <sid or name> >- * associated with the ACL: attribute should be provided >- * similarly. >- * >- * @param size The number of the bytes of data in the value buffer >- * >- * @param flags A bit-wise OR of zero or more of the following: >- * SMBC_XATTR_FLAG_CREATE - >- * fail if the named attribute already exists >- * SMBC_XATTR_FLAG_REPLACE - >- * fail if the attribute does not already exist >- * >- * If neither flag is specified, the specified attributes >- * will be added or replace existing attributes of the same >- * name, as necessary. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * or one of the parameters is not of a correct >- * form >- * - ENOMEM No memory was available for internal needs >- * - EEXIST If the attribute already exists and the flag >- * SMBC_XATTR_FLAG_CREAT was specified >- * - ENOATTR If the attribute does not exist and the flag >- * SMBC_XATTR_FLAG_REPLACE was specified >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- * @note Attribute names are compared in a case-insensitive >- * fashion. All of the following are equivalent, although >- * the all-lower-case name is the preferred format: >- * system.nt_sec_desc.owner >- * SYSTEM.NT_SEC_DESC.OWNER >- * sYsTeM.nt_sEc_desc.owNER >- * >- */ >-int smbc_lsetxattr(const char *url, >- const char *name, >- const void *value, >- size_t size, >- int flags); >- >- >-/**@ingroup attribute >- * Set extended attributes for a file. This is used for modifying a file's >- * security descriptor (i.e. owner, group, and access control list) >- * >- * @param fd A file descriptor associated with an open file (as >- * previously returned by smbc_open(), to get extended >- * attributes for. >- * >- * @param name The name of an attribute to be changed. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter should contain a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @param value The value to be assigned to the specified attribute name. >- * This buffer should contain only the attribute value if the >- * name was of the "system.nt_sec_desc.<attribute_name>" >- * form. If the name was of the "system.nt_sec_desc.*" form >- * then a complete security descriptor, with name:value pairs >- * separated by tabs, commas, or newlines (not spaces!), >- * should be provided in this value buffer. A complete >- * security descriptor will contain one or more entries >- * selected from the following: >- * >- * REVISION:<revision number> >- * OWNER:<sid or name> >- * GROUP:<sid or name> >- * ACL:<sid or name>:<type>/<flags>/<mask> >- * >- * The revision of the ACL specifies the internal Windows NT >- * ACL revision for the security descriptor. If not specified >- * it defaults to 1. Using values other than 1 may cause >- * strange behaviour. >- * >- * The owner and group specify the owner and group sids for >- * the object. If the attribute name (either '*+' with a >- * complete security descriptor, or individual 'owner+' or >- * 'group+' attribute names) ended with a plus sign, the >- * specified name is resolved to a SID value, using the >- * server on which the file or directory resides. Otherwise, >- * the value should be provided in SID-printable format as >- * S-1-x-y-z, and is used directly. The <sid or name> >- * associated with the ACL: attribute should be provided >- * similarly. >- * >- * @param size The number of the bytes of data in the value buffer >- * >- * @param flags A bit-wise OR of zero or more of the following: >- * SMBC_XATTR_FLAG_CREATE - >- * fail if the named attribute already exists >- * SMBC_XATTR_FLAG_REPLACE - >- * fail if the attribute does not already exist >- * >- * If neither flag is specified, the specified attributes >- * will be added or replace existing attributes of the same >- * name, as necessary. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * or one of the parameters is not of a correct >- * form >- * - ENOMEM No memory was available for internal needs >- * - EEXIST If the attribute already exists and the flag >- * SMBC_XATTR_FLAG_CREAT was specified >- * - ENOATTR If the attribute does not exist and the flag >- * SMBC_XATTR_FLAG_REPLACE was specified >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- * @note Attribute names are compared in a case-insensitive >- * fashion. All of the following are equivalent, although >- * the all-lower-case name is the preferred format: >- * system.nt_sec_desc.owner >- * SYSTEM.NT_SEC_DESC.OWNER >- * sYsTeM.nt_sEc_desc.owNER >- * >- */ >-int smbc_fsetxattr(int fd, >- const char *name, >- const void *value, >- size_t size, >- int flags); >- >- >-/**@ingroup attribute >- * Get extended attributes for a file. >- * >- * @param url The smb url of the file or directory to get extended >- * attributes for. >- * >- * @param name The name of an attribute to be retrieved. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter will return a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @param value A pointer to a buffer in which the value of the specified >- * attribute will be placed (unless size is zero). >- * >- * @param size The size of the buffer pointed to by value. This parameter >- * may also be zero, in which case the size of the buffer >- * required to hold the attribute value will be returned, >- * but nothing will be placed into the value buffer. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * or one of the parameters is not of a correct >- * form >- * - ENOMEM No memory was available for internal needs >- * - EEXIST If the attribute already exists and the flag >- * SMBC_XATTR_FLAG_CREAT was specified >- * - ENOATTR If the attribute does not exist and the flag >- * SMBC_XATTR_FLAG_REPLACE was specified >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- */ >-int smbc_getxattr(const char *url, >- const char *name, >- const void *value, >- size_t size); >- >- >-/**@ingroup attribute >- * Get extended attributes for a file. The POSIX function which this maps to >- * would act on a symbolic link rather than acting on what the symbolic link >- * points to, but with no symbolic links in SMB file systems, this function >- * is functionally identical to smbc_getxattr(). >- * >- * @param url The smb url of the file or directory to get extended >- * attributes for. >- * >- * @param name The name of an attribute to be retrieved. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter will return a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @param value A pointer to a buffer in which the value of the specified >- * attribute will be placed (unless size is zero). >- * >- * @param size The size of the buffer pointed to by value. This parameter >- * may also be zero, in which case the size of the buffer >- * required to hold the attribute value will be returned, >- * but nothing will be placed into the value buffer. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * or one of the parameters is not of a correct >- * form >- * - ENOMEM No memory was available for internal needs >- * - EEXIST If the attribute already exists and the flag >- * SMBC_XATTR_FLAG_CREAT was specified >- * - ENOATTR If the attribute does not exist and the flag >- * SMBC_XATTR_FLAG_REPLACE was specified >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- */ >-int smbc_lgetxattr(const char *url, >- const char *name, >- const void *value, >- size_t size); >- >- >-/**@ingroup attribute >- * Get extended attributes for a file. >- * >- * @param fd A file descriptor associated with an open file (as >- * previously returned by smbc_open(), to get extended >- * attributes for. >- * >- * @param name The name of an attribute to be retrieved. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter will return a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @param value A pointer to a buffer in which the value of the specified >- * attribute will be placed (unless size is zero). >- * >- * @param size The size of the buffer pointed to by value. This parameter >- * may also be zero, in which case the size of the buffer >- * required to hold the attribute value will be returned, >- * but nothing will be placed into the value buffer. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * or one of the parameters is not of a correct >- * form >- * - ENOMEM No memory was available for internal needs >- * - EEXIST If the attribute already exists and the flag >- * SMBC_XATTR_FLAG_CREAT was specified >- * - ENOATTR If the attribute does not exist and the flag >- * SMBC_XATTR_FLAG_REPLACE was specified >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- */ >-int smbc_fgetxattr(int fd, >- const char *name, >- const void *value, >- size_t size); >- >- >-/**@ingroup attribute >- * Remove extended attributes for a file. This is used for modifying a file's >- * security descriptor (i.e. owner, group, and access control list) >- * >- * @param url The smb url of the file or directory to remove the extended >- * attributes for. >- * >- * @param name The name of an attribute to be removed. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter will return a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - ENOMEM No memory was available for internal needs >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- */ >-int smbc_removexattr(const char *url, >- const char *name); >- >- >-/**@ingroup attribute >- * Remove extended attributes for a file. This is used for modifying a file's >- * security descriptor (i.e. owner, group, and access control list) The POSIX >- * function which this maps to would act on a symbolic link rather than acting >- * on what the symbolic link points to, but with no symbolic links in SMB file >- * systems, this function is functionally identical to smbc_removexattr(). >- * >- * @param url The smb url of the file or directory to remove the extended >- * attributes for. >- * >- * @param name The name of an attribute to be removed. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter will return a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - ENOMEM No memory was available for internal needs >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- */ >-int smbc_lremovexattr(const char *url, >- const char *name); >- >- >-/**@ingroup attribute >- * Remove extended attributes for a file. This is used for modifying a file's >- * security descriptor (i.e. owner, group, and access control list) >- * >- * @param fd A file descriptor associated with an open file (as >- * previously returned by smbc_open(), to get extended >- * attributes for. >- * >- * @param name The name of an attribute to be removed. Names are of >- * one of the following forms: >- * >- * system.nt_sec_desc.<attribute name> >- * system.nt_sec_desc.* >- * system.nt_sec_desc.*+ >- * >- * where <attribute name> is one of: >- * >- * revision >- * owner >- * owner+ >- * group >- * group+ >- * acl:<name or sid> >- * acl+:<name or sid> >- * >- * In the forms "system.nt_sec_desc.*" and >- * "system.nt_sec_desc.*+", the asterisk and plus signs are >- * literal, i.e. the string is provided exactly as shown, and >- * the value parameter will return a complete security >- * descriptor with name:value pairs separated by tabs, >- * commas, or newlines (not spaces!). >- * >- * The plus sign ('+') indicates that SIDs should be mapped >- * to names. Without the plus sign, SIDs are not mapped; >- * rather they are simply converted to a string format. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - ENOMEM No memory was available for internal needs >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- */ >-int smbc_fremovexattr(int fd, >- const char *name); >- >- >-/**@ingroup attribute >- * List the supported extended attribute names associated with a file >- * >- * @param url The smb url of the file or directory to list the extended >- * attributes for. >- * >- * @param list A pointer to a buffer in which the list of attributes for >- * the specified file or directory will be placed (unless >- * size is zero). >- * >- * @param size The size of the buffer pointed to by list. This parameter >- * may also be zero, in which case the size of the buffer >- * required to hold all of the attribute names will be >- * returned, but nothing will be placed into the list buffer. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - ENOMEM No memory was available for internal needs >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- * @note This function always returns all attribute names supported >- * by NT file systems, regardless of wether the referenced >- * file system supports extended attributes (e.g. a Windows >- * 2000 machine supports extended attributes if NTFS is used, >- * but not if FAT is used, and Windows 98 doesn't support >- * extended attributes at all. Whether this is a feature or >- * a bug is yet to be decided. >- */ >-int smbc_listxattr(const char *url, >- char *list, >- size_t size); >- >-/**@ingroup attribute >- * List the supported extended attribute names associated with a file The >- * POSIX function which this maps to would act on a symbolic link rather than >- * acting on what the symbolic link points to, but with no symbolic links in >- * SMB file systems, this function is functionally identical to >- * smbc_listxattr(). >- * >- * @param url The smb url of the file or directory to list the extended >- * attributes for. >- * >- * @param list A pointer to a buffer in which the list of attributes for >- * the specified file or directory will be placed (unless >- * size is zero). >- * >- * @param size The size of the buffer pointed to by list. This parameter >- * may also be zero, in which case the size of the buffer >- * required to hold all of the attribute names will be >- * returned, but nothing will be placed into the list buffer. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - ENOMEM No memory was available for internal needs >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- * @note This function always returns all attribute names supported >- * by NT file systems, regardless of wether the referenced >- * file system supports extended attributes (e.g. a Windows >- * 2000 machine supports extended attributes if NTFS is used, >- * but not if FAT is used, and Windows 98 doesn't support >- * extended attributes at all. Whether this is a feature or >- * a bug is yet to be decided. >- */ >-int smbc_llistxattr(const char *url, >- char *list, >- size_t size); >- >-/**@ingroup attribute >- * List the supported extended attribute names associated with a file >- * >- * @param fd A file descriptor associated with an open file (as >- * previously returned by smbc_open(), to get extended >- * attributes for. >- * >- * @param list A pointer to a buffer in which the list of attributes for >- * the specified file or directory will be placed (unless >- * size is zero). >- * >- * @param size The size of the buffer pointed to by list. This parameter >- * may also be zero, in which case the size of the buffer >- * required to hold all of the attribute names will be >- * returned, but nothing will be placed into the list buffer. >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL The client library is not properly initialized >- * - ENOMEM No memory was available for internal needs >- * - EPERM Permission was denied. >- * - ENOTSUP The referenced file system does not support >- * extended attributes >- * >- * @note This function always returns all attribute names supported >- * by NT file systems, regardless of wether the referenced >- * file system supports extended attributes (e.g. a Windows >- * 2000 machine supports extended attributes if NTFS is used, >- * but not if FAT is used, and Windows 98 doesn't support >- * extended attributes at all. Whether this is a feature or >- * a bug is yet to be decided. >- */ >-int smbc_flistxattr(int fd, >- char *list, >- size_t size); >- >-/**@ingroup print >- * Print a file given the name in fname. It would be a URL ... >- * >- * @param fname The URL of a file on a remote SMB server that the >- * caller wants printed >- * >- * @param printq The URL of the print share to print the file to. >- * >- * @return 0 on success, < 0 on error with errno set: >- * >- * - EINVAL fname or printq was NULL or smbc_init not >- * not called. >- * and errors returned by smbc_open >- * >- */ >-int smbc_print_file(const char *fname, const char *printq); >- >-/**@ingroup print >- * Open a print file that can be written to by other calls. This simply >- * does an smbc_open call after checking if there is a file name on the >- * URI. If not, a temporary name is added ... >- * >- * @param fname The URL of the print share to print to? >- * >- * @returns A file handle for the print file if successful. >- * Returns -1 if an error ocurred and errno has the values >- * - EINVAL fname was NULL or smbc_init not called. >- * - all errors returned by smbc_open >- * >- */ >-int smbc_open_print_job(const char *fname); >- >-/**@ingroup print >- * List the print jobs on a print share, for the moment, pass a callback >- * >- * @param purl The url of the print share to list the jobs of >- * >- * @param fn Callback function the receives printjob info >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL fname was NULL or smbc_init not called >- * - EACCES ??? >- */ >-int smbc_list_print_jobs(const char *purl, smbc_list_print_job_fn fn); >- >-/**@ingroup print >- * Delete a print job >- * >- * @param purl Url of the print share >- * >- * @param id The id of the job to delete >- * >- * @return 0 on success, < 0 on error with errno set: >- * - EINVAL fname was NULL or smbc_init not called >- * >- * @todo what errno values are possible here? >- */ >-int smbc_unlink_print_job(const char *purl, int id); >- >-/**@ingroup callback >- * Remove a server from the cached server list it's unused. >- * >- * @param context pointer to smb context >- * >- * @param srv pointer to server to remove >- * >- * @return On success, 0 is returned. 1 is returned if the server could not >- * be removed. Also useable outside libsmbclient. >- */ >-int smbc_remove_unused_server(SMBCCTX * context, SMBCSRV * srv); >- >-#ifdef __cplusplus >-} >-#endif >- >-/**@ingroup directory >- * Convert strings of %xx to their single character equivalent. >- * >- * @param dest A pointer to a buffer in which the resulting decoded >- * string should be placed. This may be a pointer to the >- * same buffer as src_segment. >- * >- * @param src A pointer to the buffer containing the URL to be decoded. >- * Any %xx sequences herein are converted to their single >- * character equivalent. Each 'x' must be a valid hexadecimal >- * digit, or that % sequence is left undecoded. >- * >- * @param max_dest_len >- * The size of the buffer pointed to by dest_segment. >- * >- * @return The number of % sequences which could not be converted >- * due to lack of two following hexadecimal digits. >- */ >-#ifdef __cplusplus >-extern "C" { >-#endif >-int >-smbc_urldecode(char *dest, char * src, size_t max_dest_len); >-#ifdef __cplusplus >-} >-#endif >- >- >-/* >- * Convert any characters not specifically allowed in a URL into their %xx >- * equivalent. >- * >- * @param dest A pointer to a buffer in which the resulting encoded >- * string should be placed. Unlike smbc_urldecode(), this >- * must be a buffer unique from src. >- * >- * @param src A pointer to the buffer containing the string to be encoded. >- * Any character not specifically allowed in a URL is converted >- * into its hexadecimal value and encoded as %xx. >- * >- * @param max_dest_len >- * The size of the buffer pointed to by dest_segment. >- * >- * @returns The remaining buffer length. >- */ >-#ifdef __cplusplus >-extern "C" { >-#endif >-int >-smbc_urlencode(char * dest, char * src, int max_dest_len); >-#ifdef __cplusplus >-} >-#endif >- >- >-/**@ingroup directory >- * Return the version of the linked Samba code, and thus the version of the >- * libsmbclient code. >- * >- * @return The version string. >- */ >-#ifdef __cplusplus >-extern "C" { >-#endif >-const char * >-smbc_version(void); >-#ifdef __cplusplus >-} >-#endif >- >- >-#endif /* SMBCLIENT_H_INCLUDED */ >diff -urN samba-3.0.23d/source/include/libsmbclient.h.in samba-3.0.23d-require-lfs/source/include/libsmbclient.h.in >--- samba-3.0.23d/source/include/libsmbclient.h.in 1970-01-01 01:00:00.000000000 +0100 >+++ samba-3.0.23d-require-lfs/source/include/libsmbclient.h.in 2007-01-15 01:50:30.000000000 +0100 >@@ -0,0 +1,2192 @@ >+/*===================================================================== >+ Unix SMB/Netbios implementation. >+ SMB client library API definitions >+ Copyright (C) Andrew Tridgell 1998 >+ Copyright (C) Richard Sharpe 2000 >+ Copyright (C) John Terpsra 2000 >+ Copyright (C) Tom Jansen (Ninja ISD) 2002 >+ Copyright (C) Derrell Lipman 2003 >+ >+ >+ 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 2 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, write to the Free Software >+ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. >+ =====================================================================*/ >+ >+#ifndef SMBCLIENT_H_INCLUDED >+#define SMBCLIENT_H_INCLUDED >+ >+#ifdef __cplusplus >+extern "C" { >+#endif >+ >+/*-------------------------------------------------------------------*/ >+/* The following are special comments to instruct DOXYGEN (automated >+ * documentation tool: >+*/ >+/** \defgroup libsmbclient >+*/ >+/** \defgroup structure Data Structures Type and Constants >+* \ingroup libsmbclient >+* Data structures, types, and constants >+*/ >+/** \defgroup callback Callback function types >+* \ingroup libsmbclient >+* Callback functions >+*/ >+/** \defgroup file File Functions >+* \ingroup libsmbclient >+* Functions used to access individual file contents >+*/ >+/** \defgroup directory Directory Functions >+* \ingroup libsmbclient >+* Functions used to access directory entries >+*/ >+/** \defgroup attribute Attributes Functions >+* \ingroup libsmbclient >+* Functions used to view or change file and directory attributes >+*/ >+/** \defgroup print Print Functions >+* \ingroup libsmbclient >+* Functions used to access printing functionality >+*/ >+/** \defgroup misc Miscellaneous Functions >+* \ingroup libsmbclient >+* Functions that don't fit in to other categories >+*/ >+/*-------------------------------------------------------------------*/ >+ >+/* Make sure we have the following includes for now ... */ >+#include <sys/types.h> >+#include <sys/stat.h> >+#include <fcntl.h> >+#include <utime.h> >+ >+#define SMBC_BASE_FD 10000 /* smallest file descriptor returned */ >+ >+#define SMBC_WORKGROUP 1 >+#define SMBC_SERVER 2 >+#define SMBC_FILE_SHARE 3 >+#define SMBC_PRINTER_SHARE 4 >+#define SMBC_COMMS_SHARE 5 >+#define SMBC_IPC_SHARE 6 >+#define SMBC_DIR 7 >+#define SMBC_FILE 8 >+#define SMBC_LINK 9 >+ >+/* Value of _FILE_OFFSET_BITS when libsmbclient got compiled */ >+#undef SMBC_FILE_OFFSET_BITS >+ >+#if (defined(_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS > 32) /* LFS requested */ \ >+ && (!defined(SMBC_FILE_OFFSET_BITS) || SMBC_FILE_OFFSET_BITS != _FILE_OFFSET_BITS) /* Wasn't compiled with LFS support */ >+#error "LFS requested but libsmbclient wasn't compiled with LFS support" >+#endif >+ >+#if (!defined(_FILE_OFFSET_BITS) || _FILE_OFFSET_BITS == 32) /* LFS not requested */ \ >+ && (defined(SMBC_FILE_OFFSET_BITS) && SMBC_FILE_OFFSET_BITS > 32) /* Was compiled with LFS support */ >+#error "LFS not requested but libsmbclient was compiled with LFS support" >+#endif >+ >+/**@ingroup structure >+ * Structure that represents a directory entry. >+ * >+ */ >+struct smbc_dirent >+{ >+ /** Type of entity. >+ SMBC_WORKGROUP=1, >+ SMBC_SERVER=2, >+ SMBC_FILE_SHARE=3, >+ SMBC_PRINTER_SHARE=4, >+ SMBC_COMMS_SHARE=5, >+ SMBC_IPC_SHARE=6, >+ SMBC_DIR=7, >+ SMBC_FILE=8, >+ SMBC_LINK=9,*/ >+ unsigned int smbc_type; >+ >+ /** Length of this smbc_dirent in bytes >+ */ >+ unsigned int dirlen; >+ /** The length of the comment string in bytes (does not include >+ * null terminator) >+ */ >+ unsigned int commentlen; >+ /** Points to the null terminated comment string >+ */ >+ char *comment; >+ /** The length of the name string in bytes (does not include >+ * null terminator) >+ */ >+ unsigned int namelen; >+ /** Points to the null terminated name string >+ */ >+ char name[1]; >+}; >+ >+/* >+ * Flags for smbc_setxattr() >+ * Specify a bitwise OR of these, or 0 to add or replace as necessary >+ */ >+#define SMBC_XATTR_FLAG_CREATE 0x1 /* fail if attr already exists */ >+#define SMBC_XATTR_FLAG_REPLACE 0x2 /* fail if attr does not exist */ >+ >+ >+/* >+ * Mappings of the DOS mode bits, as returned by smbc_getxattr() when the >+ * attribute name "system.dos_attr.mode" (or "system.dos_attr.*" or >+ * "system.*") is specified. >+ */ >+#define SMBC_DOS_MODE_READONLY 0x01 >+#define SMBC_DOS_MODE_HIDDEN 0x02 >+#define SMBC_DOS_MODE_SYSTEM 0x04 >+#define SMBC_DOS_MODE_VOLUME_ID 0x08 >+#define SMBC_DOS_MODE_DIRECTORY 0x10 >+#define SMBC_DOS_MODE_ARCHIVE 0x20 >+ >+ >+#ifndef ENOATTR >+# define ENOATTR ENOENT /* No such attribute */ >+#endif >+ >+ >+ >+ >+/**@ingroup structure >+ * Structure that represents a print job. >+ * >+ */ >+#ifndef _CLIENT_H >+struct print_job_info >+{ >+ /** numeric ID of the print job >+ */ >+ unsigned short id; >+ >+ /** represents print job priority (lower numbers mean higher priority) >+ */ >+ unsigned short priority; >+ >+ /** Size of the print job >+ */ >+ size_t size; >+ >+ /** Name of the user that owns the print job >+ */ >+ char user[128]; >+ >+ /** Name of the print job. This will have no name if an anonymous print >+ * file was opened. Ie smb://server/printer >+ */ >+ char name[128]; >+ >+ /** Time the print job was spooled >+ */ >+ time_t t; >+}; >+#endif /* _CLIENT_H */ >+ >+ >+/**@ingroup structure >+ * Server handle >+ */ >+typedef struct _SMBCSRV SMBCSRV; >+ >+/**@ingroup structure >+ * File or directory handle >+ */ >+typedef struct _SMBCFILE SMBCFILE; >+ >+/**@ingroup structure >+ * File or directory handle >+ */ >+typedef struct _SMBCCTX SMBCCTX; >+ >+ >+ >+ >+ >+/**@ingroup callback >+ * Authentication callback function type (traditional method) >+ * >+ * Type for the the authentication function called by the library to >+ * obtain authentication credentals >+ * >+ * @param srv Server being authenticated to >+ * >+ * @param shr Share being authenticated to >+ * >+ * @param wg Pointer to buffer containing a "hint" for the >+ * workgroup to be authenticated. Should be filled in >+ * with the correct workgroup if the hint is wrong. >+ * >+ * @param wglen The size of the workgroup buffer in bytes >+ * >+ * @param un Pointer to buffer containing a "hint" for the >+ * user name to be use for authentication. Should be >+ * filled in with the correct workgroup if the hint is >+ * wrong. >+ * >+ * @param unlen The size of the username buffer in bytes >+ * >+ * @param pw Pointer to buffer containing to which password >+ * copied >+ * >+ * @param pwlen The size of the password buffer in bytes >+ * >+ */ >+typedef void (*smbc_get_auth_data_fn)(const char *srv, >+ const char *shr, >+ char *wg, int wglen, >+ char *un, int unlen, >+ char *pw, int pwlen); >+/**@ingroup callback >+ * Authentication callback function type (method that includes context) >+ * >+ * Type for the the authentication function called by the library to >+ * obtain authentication credentals >+ * >+ * @param c Pointer to the smb context >+ * >+ * @param srv Server being authenticated to >+ * >+ * @param shr Share being authenticated to >+ * >+ * @param wg Pointer to buffer containing a "hint" for the >+ * workgroup to be authenticated. Should be filled in >+ * with the correct workgroup if the hint is wrong. >+ * >+ * @param wglen The size of the workgroup buffer in bytes >+ * >+ * @param un Pointer to buffer containing a "hint" for the >+ * user name to be use for authentication. Should be >+ * filled in with the correct workgroup if the hint is >+ * wrong. >+ * >+ * @param unlen The size of the username buffer in bytes >+ * >+ * @param pw Pointer to buffer containing to which password >+ * copied >+ * >+ * @param pwlen The size of the password buffer in bytes >+ * >+ */ >+typedef void (*smbc_get_auth_data_with_context_fn)(SMBCCTX *c, >+ const char *srv, >+ const char *shr, >+ char *wg, int wglen, >+ char *un, int unlen, >+ char *pw, int pwlen); >+ >+ >+/**@ingroup callback >+ * Print job info callback function type. >+ * >+ * @param i pointer to print job information structure >+ * >+ */ >+typedef void (*smbc_list_print_job_fn)(struct print_job_info *i); >+ >+ >+/**@ingroup callback >+ * Check if a server is still good >+ * >+ * @param c pointer to smb context >+ * >+ * @param srv pointer to server to check >+ * >+ * @return 0 when connection is good. 1 on error. >+ * >+ */ >+typedef int (*smbc_check_server_fn)(SMBCCTX * c, SMBCSRV *srv); >+ >+/**@ingroup callback >+ * Remove a server if unused >+ * >+ * @param c pointer to smb context >+ * >+ * @param srv pointer to server to remove >+ * >+ * @return 0 on success. 1 on failure. >+ * >+ */ >+typedef int (*smbc_remove_unused_server_fn)(SMBCCTX * c, SMBCSRV *srv); >+ >+ >+/**@ingroup callback >+ * Add a server to the cache system >+ * >+ * @param c pointer to smb context >+ * >+ * @param srv pointer to server to add >+ * >+ * @param server server name >+ * >+ * @param share share name >+ * >+ * @param workgroup workgroup used to connect >+ * >+ * @param username username used to connect >+ * >+ * @return 0 on success. 1 on failure. >+ * >+ */ >+typedef int (*smbc_add_cached_srv_fn) (SMBCCTX * c, SMBCSRV *srv, >+ const char * server, const char * share, >+ const char * workgroup, const char * username); >+ >+/**@ingroup callback >+ * Look up a server in the cache system >+ * >+ * @param c pointer to smb context >+ * >+ * @param server server name to match >+ * >+ * @param share share name to match >+ * >+ * @param workgroup workgroup to match >+ * >+ * @param username username to match >+ * >+ * @return pointer to SMBCSRV on success. NULL on failure. >+ * >+ */ >+typedef SMBCSRV * (*smbc_get_cached_srv_fn) (SMBCCTX * c, const char * server, >+ const char * share, const char * workgroup, >+ const char * username); >+ >+/**@ingroup callback >+ * Check if a server is still good >+ * >+ * @param c pointer to smb context >+ * >+ * @param srv pointer to server to remove >+ * >+ * @return 0 when found and removed. 1 on failure. >+ * >+ */ >+typedef int (*smbc_remove_cached_srv_fn)(SMBCCTX * c, SMBCSRV *srv); >+ >+ >+/**@ingroup callback >+ * Try to remove all servers from the cache system and disconnect >+ * >+ * @param c pointer to smb context >+ * >+ * @return 0 when found and removed. 1 on failure. >+ * >+ */ >+typedef int (*smbc_purge_cached_fn) (SMBCCTX * c); >+ >+ >+/**@ingroup structure >+ * Structure that contains a client context information >+ * This structure is know as SMBCCTX >+ */ >+struct _SMBCCTX { >+ /** debug level >+ */ >+ int debug; >+ >+ /** netbios name used for making connections >+ */ >+ char * netbios_name; >+ >+ /** workgroup name used for making connections >+ */ >+ char * workgroup; >+ >+ /** username used for making connections >+ */ >+ char * user; >+ >+ /** timeout used for waiting on connections / response data (in milliseconds) >+ */ >+ int timeout; >+ >+ /** callable functions for files: >+ * For usage and return values see the smbc_* functions >+ */ >+ SMBCFILE * (*open) (SMBCCTX *c, const char *fname, int flags, mode_t mode); >+ SMBCFILE * (*creat) (SMBCCTX *c, const char *path, mode_t mode); >+ ssize_t (*read) (SMBCCTX *c, SMBCFILE *file, void *buf, size_t count); >+ ssize_t (*write) (SMBCCTX *c, SMBCFILE *file, void *buf, size_t count); >+ int (*unlink) (SMBCCTX *c, const char *fname); >+ int (*rename) (SMBCCTX *ocontext, const char *oname, >+ SMBCCTX *ncontext, const char *nname); >+ off_t (*lseek) (SMBCCTX *c, SMBCFILE * file, off_t offset, int whence); >+ int (*stat) (SMBCCTX *c, const char *fname, struct stat *st); >+ int (*fstat) (SMBCCTX *c, SMBCFILE *file, struct stat *st); >+ int (*close_fn) (SMBCCTX *c, SMBCFILE *file); >+ >+ /** callable functions for dirs >+ */ >+ SMBCFILE * (*opendir) (SMBCCTX *c, const char *fname); >+ int (*closedir)(SMBCCTX *c, SMBCFILE *dir); >+ struct smbc_dirent * (*readdir)(SMBCCTX *c, SMBCFILE *dir); >+ int (*getdents)(SMBCCTX *c, SMBCFILE *dir, >+ struct smbc_dirent *dirp, int count); >+ int (*mkdir) (SMBCCTX *c, const char *fname, mode_t mode); >+ int (*rmdir) (SMBCCTX *c, const char *fname); >+ off_t (*telldir) (SMBCCTX *c, SMBCFILE *dir); >+ int (*lseekdir)(SMBCCTX *c, SMBCFILE *dir, off_t offset); >+ int (*fstatdir)(SMBCCTX *c, SMBCFILE *dir, struct stat *st); >+ int (*chmod)(SMBCCTX *c, const char *fname, mode_t mode); >+ int (*utimes)(SMBCCTX *c, >+ const char *fname, struct timeval *tbuf); >+ int (*setxattr)(SMBCCTX *context, >+ const char *fname, >+ const char *name, >+ const void *value, >+ size_t size, >+ int flags); >+ int (*getxattr)(SMBCCTX *context, >+ const char *fname, >+ const char *name, >+ const void *value, >+ size_t size); >+ int (*removexattr)(SMBCCTX *context, >+ const char *fname, >+ const char *name); >+ int (*listxattr)(SMBCCTX *context, >+ const char *fname, >+ char *list, >+ size_t size); >+ >+ /** callable functions for printing >+ */ >+ int (*print_file)(SMBCCTX *c_file, const char *fname, >+ SMBCCTX *c_print, const char *printq); >+ SMBCFILE * (*open_print_job)(SMBCCTX *c, const char *fname); >+ int (*list_print_jobs)(SMBCCTX *c, const char *fname, smbc_list_print_job_fn fn); >+ int (*unlink_print_job)(SMBCCTX *c, const char *fname, int id); >+ >+ >+ /* >+ ** Callbacks >+ * These callbacks _always_ have to be initialized because they will >+ * not be checked at dereference for increased speed. >+ */ >+ struct _smbc_callbacks { >+ /** authentication function callback: called upon auth requests >+ */ >+ smbc_get_auth_data_fn auth_fn; >+ >+ /** check if a server is still good >+ */ >+ smbc_check_server_fn check_server_fn; >+ >+ /** remove a server if unused >+ */ >+ smbc_remove_unused_server_fn remove_unused_server_fn; >+ >+ /** Cache subsystem >+ * For an example cache system see samba/source/libsmb/libsmb_cache.c >+ * Cache subsystem functions follow. >+ */ >+ >+ /** server cache addition >+ */ >+ smbc_add_cached_srv_fn add_cached_srv_fn; >+ >+ /** server cache lookup >+ */ >+ smbc_get_cached_srv_fn get_cached_srv_fn; >+ >+ /** server cache removal >+ */ >+ smbc_remove_cached_srv_fn remove_cached_srv_fn; >+ >+ /** server cache purging, try to remove all cached servers (disconnect) >+ */ >+ smbc_purge_cached_fn purge_cached_fn; >+ } callbacks; >+ >+ >+ /** Space to store private data of the server cache. >+ */ >+ struct smbc_server_cache * server_cache; >+ >+ int flags; >+ >+ /** user options selections that apply to this session >+ */ >+ struct _smbc_options { >+ >+ /* >+ * 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. >+ */ >+ int 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. >+ */ >+ int one_share_per_server; >+ } options; >+ >+ /** INTERNAL DATA >+ * do _NOT_ touch this from your program ! >+ */ >+ struct smbc_internal_data * internal; >+}; >+ >+/* Flags for SMBCCTX->flags */ >+#define SMB_CTX_FLAG_USE_KERBEROS (1 << 0) >+#define SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS (1 << 1) >+#define SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON (1 << 2) /* don't try to do automatic anon login */ >+ >+/**@ingroup misc >+ * Create a new SBMCCTX (a context). >+ * >+ * Must be called before the context is passed to smbc_context_init() >+ * >+ * @return The given SMBCCTX pointer on success, NULL on error with errno set: >+ * - ENOMEM Out of memory >+ * >+ * @see smbc_free_context(), smbc_init_context() >+ * >+ * @note Do not forget to smbc_init_context() the returned SMBCCTX pointer ! >+ */ >+SMBCCTX * smbc_new_context(void); >+ >+/**@ingroup misc >+ * Delete a SBMCCTX (a context) acquired from smbc_new_context(). >+ * >+ * The context will be deleted if possible. >+ * >+ * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >+ * >+ * @param shutdown_ctx If 1, all connections and files will be closed even if they are busy. >+ * >+ * >+ * @return Returns 0 on succes. Returns 1 on failure with errno set: >+ * - EBUSY Server connections are still used, Files are open or cache >+ * could not be purged >+ * - EBADF context == NULL >+ * >+ * @see smbc_new_context() >+ * >+ * @note It is advised to clean up all the contexts with shutdown_ctx set to 1 >+ * just before exit()'ing. When shutdown_ctx is 0, this function can be >+ * use in periodical cleanup functions for example. >+ */ >+int smbc_free_context(SMBCCTX * context, int shutdown_ctx); >+ >+ >+/**@ingroup misc >+ * Each time the context structure is changed, we have binary backward >+ * compatibility issues. Instead of modifying the public portions of the >+ * context structure to add new options, instead, we put them in the internal >+ * portion of the context structure and provide a set function for these new >+ * options. >+ * >+ * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >+ * >+ * @param option_name >+ * The name of the option for which the value is to be set >+ * >+ * @param option_value >+ * The new value of the option being set >+ * >+ */ >+void >+smbc_option_set(SMBCCTX *context, >+ char *option_name, >+ void *option_value); >+/* >+ * Retrieve the current value of an option >+ * >+ * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >+ * >+ * @param option_name >+ * The name of the option for which the value is to be >+ * retrieved >+ * >+ * @return The value of the specified option. >+ */ >+void * >+smbc_option_get(SMBCCTX *context, >+ char *option_name); >+ >+/**@ingroup misc >+ * Initialize a SBMCCTX (a context). >+ * >+ * Must be called before using any SMBCCTX API function >+ * >+ * @param context A pointer to a SMBCCTX obtained from smbc_new_context() >+ * >+ * @return A pointer to the given SMBCCTX on success, >+ * NULL on error with errno set: >+ * - EBADF NULL context given >+ * - ENOMEM Out of memory >+ * - ENOENT The smb.conf file would not load >+ * >+ * @see smbc_new_context() >+ * >+ * @note my_context = smbc_init_context(smbc_new_context()) >+ * is perfectly safe, but it might leak memory on >+ * smbc_context_init() failure. Avoid this. >+ * You'll have to call smbc_free_context() yourself >+ * on failure. >+ */ >+ >+SMBCCTX * smbc_init_context(SMBCCTX * context); >+ >+/**@ingroup misc >+ * Initialize the samba client library. >+ * >+ * Must be called before using any of the smbclient API function >+ * >+ * @param fn The function that will be called to obtaion >+ * authentication credentials. >+ * >+ * @param debug Allows caller to set the debug level. Can be >+ * changed in smb.conf file. Allows caller to set >+ * debugging if no smb.conf. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - ENOMEM Out of memory >+ * - ENOENT The smb.conf file would not load >+ * >+ */ >+ >+int smbc_init(smbc_get_auth_data_fn fn, int debug); >+ >+/**@ingroup misc >+ * Set or retrieve the compatibility library's context pointer >+ * >+ * @param context New context to use, or NULL. If a new context is provided, >+ * it must have allocated with smbc_new_context() and >+ * initialized with smbc_init_context(), followed, optionally, >+ * by some manual changes to some of the non-internal fields. >+ * >+ * @return The old context. >+ * >+ * @see smbc_new_context(), smbc_init_context(), smbc_init() >+ * >+ * @note This function may be called prior to smbc_init() to force >+ * use of the next context without any internal calls to >+ * smbc_new_context() or smbc_init_context(). It may also >+ * be called after smbc_init() has already called those two >+ * functions, to replace the existing context with a new one. >+ * Care should be taken, in this latter case, to ensure that >+ * the server cache and any data allocated by the >+ * authentication functions have been freed, if necessary. >+ */ >+ >+SMBCCTX * smbc_set_context(SMBCCTX * new_context); >+ >+/**@ingroup file >+ * Open a file on an SMB server. >+ * >+ * @param furl The smb url of the file to be opened. >+ * >+ * @param flags Is one of O_RDONLY, O_WRONLY or O_RDWR which >+ * request opening the file read-only,write-only >+ * or read/write. flags may also be bitwise-or'd with >+ * one or more of the following: >+ * O_CREAT - If the file does not exist it will be >+ * created. >+ * O_EXCL - When used with O_CREAT, if the file >+ * already exists it is an error and the open will >+ * fail. >+ * O_TRUNC - If the file already exists it will be >+ * truncated. >+ * O_APPEND The file is opened in append mode >+ * >+ * @param mode mode specifies the permissions to use if a new >+ * file is created. It is modified by the >+ * process's umask in the usual way: the permissions >+ * of the created file are (mode & ~umask) >+ * >+ * Not currently use, but there for future use. >+ * We will map this to SYSTEM, HIDDEN, etc bits >+ * that reverses the mapping that smbc_fstat does. >+ * >+ * @return Valid file handle, < 0 on error with errno set: >+ * - ENOMEM Out of memory >+ * - EINVAL if an invalid parameter passed, like no >+ * file, or smbc_init not called. >+ * - EEXIST pathname already exists and O_CREAT and >+ * O_EXCL were used. >+ * - EISDIR pathname refers to a directory and >+ * the access requested involved writing. >+ * - EACCES The requested access to the file is not >+ * allowed >+ * - ENODEV The requested share does not exist >+ * - ENOTDIR A file on the path is not a directory >+ * - ENOENT A directory component in pathname does >+ * not exist. >+ * >+ * @see smbc_creat() >+ * >+ * @note This call uses an underlying routine that may create >+ * a new connection to the server specified in the URL. >+ * If the credentials supplied in the URL, or via the >+ * auth_fn in the smbc_init call, fail, this call will >+ * try again with an empty username and password. This >+ * often gets mapped to the guest account on some machines. >+ */ >+ >+int smbc_open(const char *furl, int flags, mode_t mode); >+ >+/**@ingroup file >+ * Create a file on an SMB server. >+ * >+ * Same as calling smbc_open() with flags = O_CREAT|O_WRONLY|O_TRUNC >+ * >+ * @param furl The smb url of the file to be created >+ * >+ * @param mode mode specifies the permissions to use if a new >+ * file is created. It is modified by the >+ * process's umask in the usual way: the permissions >+ * of the created file are (mode & ~umask) >+ * >+ * NOTE, the above is not true. We are dealing with >+ * an SMB server, which has no concept of a umask! >+ * >+ * @return Valid file handle, < 0 on error with errno set: >+ * - ENOMEM Out of memory >+ * - EINVAL if an invalid parameter passed, like no >+ * file, or smbc_init not called. >+ * - EEXIST pathname already exists and O_CREAT and >+ * O_EXCL were used. >+ * - EISDIR pathname refers to a directory and >+ * the access requested involved writing. >+ * - EACCES The requested access to the file is not >+ * allowed >+ * - ENOENT A directory component in pathname does >+ * not exist. >+ * - ENODEV The requested share does not exist. >+ * @see smbc_open() >+ * >+ */ >+ >+int smbc_creat(const char *furl, mode_t mode); >+ >+/**@ingroup file >+ * Read from a file using an opened file handle. >+ * >+ * @param fd Open file handle from smbc_open() or smbc_creat() >+ * >+ * @param buf Pointer to buffer to recieve read data >+ * >+ * @param bufsize Size of buf in bytes >+ * >+ * @return Number of bytes read, < 0 on error with errno set: >+ * - EISDIR fd refers to a directory >+ * - EBADF fd is not a valid file descriptor or >+ * is not open for reading. >+ * - EINVAL fd is attached to an object which is >+ * unsuitable for reading, or no buffer passed or >+ * smbc_init not called. >+ * >+ * @see smbc_open(), smbc_write() >+ * >+ */ >+ssize_t smbc_read(int fd, void *buf, size_t bufsize); >+ >+ >+/**@ingroup file >+ * Write to a file using an opened file handle. >+ * >+ * @param fd Open file handle from smbc_open() or smbc_creat() >+ * >+ * @param buf Pointer to buffer to recieve read data >+ * >+ * @param bufsize Size of buf in bytes >+ * >+ * @return Number of bytes written, < 0 on error with errno set: >+ * - EISDIR fd refers to a directory. >+ * - EBADF fd is not a valid file descriptor or >+ * is not open for reading. >+ * - EINVAL fd is attached to an object which is >+ * unsuitable for reading, or no buffer passed or >+ * smbc_init not called. >+ * >+ * @see smbc_open(), smbc_read() >+ * >+ */ >+ssize_t smbc_write(int fd, void *buf, size_t bufsize); >+ >+ >+/**@ingroup file >+ * Seek to a specific location in a file. >+ * >+ * @param fd Open file handle from smbc_open() or smbc_creat() >+ * >+ * @param offset Offset in bytes from whence >+ * >+ * @param whence A location in the file: >+ * - SEEK_SET The offset is set to offset bytes from >+ * the beginning of the file >+ * - SEEK_CUR The offset is set to current location >+ * plus offset bytes. >+ * - SEEK_END The offset is set to the size of the >+ * file plus offset bytes. >+ * >+ * @return Upon successful completion, lseek returns the >+ * resulting offset location as measured in bytes >+ * from the beginning of the file. Otherwise, a value >+ * of (off_t)-1 is returned and errno is set to >+ * indicate the error: >+ * - EBADF Fildes is not an open file descriptor. >+ * - EINVAL Whence is not a proper value or smbc_init >+ * not called. >+ * >+ * @todo Are all the whence values really supported? >+ * >+ * @todo Are errno values complete and correct? >+ */ >+off_t smbc_lseek(int fd, off_t offset, int whence); >+ >+ >+/**@ingroup file >+ * Close an open file handle. >+ * >+ * @param fd The file handle to close >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EBADF fd isn't a valid open file descriptor >+ * - EINVAL smbc_init() failed or has not been called >+ * >+ * @see smbc_open(), smbc_creat() >+ */ >+int smbc_close(int fd); >+ >+ >+/**@ingroup directory >+ * Unlink (delete) a file or directory. >+ * >+ * @param furl The smb url of the file to delete >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EACCES or EPERM Write access to the directory >+ * containing pathname is not allowed or one >+ * of the directories in pathname did not allow >+ * search (execute) permission >+ * - ENOENT A directory component in pathname does >+ * not exist >+ * - EINVAL NULL was passed in the file param or >+ * smbc_init not called. >+ * - EACCES You do not have access to the file >+ * - ENOMEM Insufficient kernel memory was available >+ * >+ * @see smbc_rmdir()s >+ * >+ * @todo Are errno values complete and correct? >+ */ >+int smbc_unlink(const char *furl); >+ >+ >+/**@ingroup directory >+ * Rename or move a file or directory. >+ * >+ * @param ourl The original smb url (source url) of file or >+ * directory to be moved >+ * >+ * @param nurl The new smb url (destination url) of the file >+ * or directory after the move. Currently nurl must >+ * be on the same share as ourl. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EISDIR nurl is an existing directory, but ourl is >+ * not a directory. >+ * - EEXIST nurl is a non-empty directory, >+ * i.e., contains entries other than "." and ".." >+ * - EINVAL The new url contained a path prefix >+ * of the old, or, more generally, an attempt was >+ * made to make a directory a subdirectory of itself >+ * or smbc_init not called. >+ * - ENOTDIR A component used as a directory in ourl >+ * or nurl path is not, in fact, a directory. Or, >+ * ourl is a directory, and newpath exists but is not >+ * a directory. >+ * - EACCES or EPERM Write access to the directory >+ * containing ourl or nurl is not allowed for the >+ * process's effective uid, or one of the >+ * directories in ourl or nurl did not allow search >+ * (execute) permission, or ourl was a directory >+ * and did not allow write permission. >+ * - ENOENT A directory component in ourl or nurl >+ * does not exist. >+ * - EXDEV Rename across shares not supported. >+ * - ENOMEM Insufficient kernel memory was available. >+ * - EEXIST The target file, nurl, already exists. >+ * >+ * >+ * @todo Are we going to support copying when urls are not on the same >+ * share? I say no... NOTE. I agree for the moment. >+ * >+ */ >+int smbc_rename(const char *ourl, const char *nurl); >+ >+ >+/**@ingroup directory >+ * Open a directory used to obtain directory entries. >+ * >+ * @param durl The smb url of the directory to open >+ * >+ * @return Valid directory handle. < 0 on error with errno set: >+ * - EACCES Permission denied. >+ * - EINVAL A NULL file/URL was passed, or the URL would >+ * not parse, or was of incorrect form or smbc_init not >+ * called. >+ * - ENOENT durl does not exist, or name is an >+ * - ENOMEM Insufficient memory to complete the >+ * operation. >+ * - ENOTDIR name is not a directory. >+ * - EPERM the workgroup could not be found. >+ * - ENODEV the workgroup or server could not be found. >+ * >+ * @see smbc_getdents(), smbc_readdir(), smbc_closedir() >+ * >+ */ >+int smbc_opendir(const char *durl); >+ >+ >+/**@ingroup directory >+ * Close a directory handle opened by smbc_opendir(). >+ * >+ * @param dh Directory handle to close >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EBADF dh is an invalid directory handle >+ * >+ * @see smbc_opendir() >+ */ >+int smbc_closedir(int dh); >+ >+ >+/**@ingroup directory >+ * Get multiple directory entries. >+ * >+ * smbc_getdents() reads as many dirent structures from the an open >+ * directory handle into a specified memory area as will fit. >+ * >+ * @param dh Valid directory as returned by smbc_opendir() >+ * >+ * @param dirp pointer to buffer that will receive the directory >+ * entries. >+ * >+ * @param count The size of the dirp buffer in bytes >+ * >+ * @returns If any dirents returned, return will indicate the >+ * total size. If there were no more dirents available, >+ * 0 is returned. < 0 indicates an error. >+ * - EBADF Invalid directory handle >+ * - EINVAL Result buffer is too small or smbc_init >+ * not called. >+ * - ENOENT No such directory. >+ * @see , smbc_dirent, smbc_readdir(), smbc_open() >+ * >+ * @todo Are errno values complete and correct? >+ * >+ * @todo Add example code so people know how to parse buffers. >+ */ >+int smbc_getdents(unsigned int dh, struct smbc_dirent *dirp, int count); >+ >+ >+/**@ingroup directory >+ * Get a single directory entry. >+ * >+ * @param dh Valid directory as returned by smbc_opendir() >+ * >+ * @return A pointer to a smbc_dirent structure, or NULL if an >+ * error occurs or end-of-directory is reached: >+ * - EBADF Invalid directory handle >+ * - EINVAL smbc_init() failed or has not been called >+ * >+ * @see smbc_dirent, smbc_getdents(), smbc_open() >+ */ >+struct smbc_dirent* smbc_readdir(unsigned int dh); >+ >+ >+/**@ingroup directory >+ * Get the current directory offset. >+ * >+ * smbc_telldir() may be used in conjunction with smbc_readdir() and >+ * smbc_lseekdir(). >+ * >+ * @param dh Valid directory as returned by smbc_opendir() >+ * >+ * @return The current location in the directory stream or -1 >+ * if an error occur. The current location is not >+ * an offset. Becuase of the implementation, it is a >+ * handle that allows the library to find the entry >+ * later. >+ * - EBADF dh is not a valid directory handle >+ * - EINVAL smbc_init() failed or has not been called >+ * - ENOTDIR if dh is not a directory >+ * >+ * @see smbc_readdir() >+ * >+ */ >+off_t smbc_telldir(int dh); >+ >+ >+/**@ingroup directory >+ * lseek on directories. >+ * >+ * smbc_lseekdir() may be used in conjunction with smbc_readdir() and >+ * smbc_telldir(). (rewind by smbc_lseekdir(fd, NULL)) >+ * >+ * @param fd Valid directory as returned by smbc_opendir() >+ * >+ * @param offset The offset (as returned by smbc_telldir). Can be >+ * NULL, in which case we will rewind >+ * >+ * @return 0 on success, -1 on failure >+ * - EBADF dh is not a valid directory handle >+ * - ENOTDIR if dh is not a directory >+ * - EINVAL offset did not refer to a valid dirent or >+ * smbc_init not called. >+ * >+ * @see smbc_telldir() >+ * >+ * >+ * @todo In what does the reture and errno values mean? >+ */ >+int smbc_lseekdir(int fd, off_t offset); >+ >+/**@ingroup directory >+ * Create a directory. >+ * >+ * @param durl The url of the directory to create >+ * >+ * @param mode Specifies the permissions to use. It is modified >+ * by the process's umask in the usual way: the >+ * permissions of the created file are (mode & ~umask). >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EEXIST directory url already exists >+ * - EACCES The parent directory does not allow write >+ * permission to the process, or one of the directories >+ * - ENOENT A directory component in pathname does not >+ * exist. >+ * - EINVAL NULL durl passed or smbc_init not called. >+ * - ENOMEM Insufficient memory was available. >+ * >+ * @see smbc_rmdir() >+ * >+ */ >+int smbc_mkdir(const char *durl, mode_t mode); >+ >+ >+/**@ingroup directory >+ * Remove a directory. >+ * >+ * @param durl The smb url of the directory to remove >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EACCES or EPERM Write access to the directory >+ * containing pathname was not allowed. >+ * - EINVAL durl is NULL or smbc_init not called. >+ * - ENOENT A directory component in pathname does not >+ * exist. >+ * - ENOTEMPTY directory contains entries. >+ * - ENOMEM Insufficient kernel memory was available. >+ * >+ * @see smbc_mkdir(), smbc_unlink() >+ * >+ * @todo Are errno values complete and correct? >+ */ >+int smbc_rmdir(const char *durl); >+ >+ >+/**@ingroup attribute >+ * Get information about a file or directory. >+ * >+ * @param url The smb url to get information for >+ * >+ * @param st pointer to a buffer that will be filled with >+ * standard Unix struct stat information. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - ENOENT A component of the path file_name does not >+ * exist. >+ * - EINVAL a NULL url was passed or smbc_init not called. >+ * - EACCES Permission denied. >+ * - ENOMEM Out of memory >+ * - ENOTDIR The target dir, url, is not a directory. >+ * >+ * @see Unix stat() >+ * >+ */ >+int smbc_stat(const char *url, struct stat *st); >+ >+ >+/**@ingroup attribute >+ * Get file information via an file descriptor. >+ * >+ * @param fd Open file handle from smbc_open() or smbc_creat() >+ * >+ * @param st pointer to a buffer that will be filled with >+ * standard Unix struct stat information. >+ * >+ * @return EBADF filedes is bad. >+ * - EACCES Permission denied. >+ * - EBADF fd is not a valid file descriptor >+ * - EINVAL Problems occurred in the underlying routines >+ * or smbc_init not called. >+ * - ENOMEM Out of memory >+ * >+ * @see smbc_stat(), Unix stat() >+ * >+ */ >+int smbc_fstat(int fd, struct stat *st); >+ >+ >+/**@ingroup attribue >+ * Change the ownership of a file or directory. >+ * >+ * @param url The smb url of the file or directory to change >+ * ownership of. >+ * >+ * @param owner I have no idea? >+ * >+ * @param group I have not idea? >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EPERM The effective UID does not match the owner >+ * of the file, and is not zero; or the owner or group >+ * were specified incorrectly. >+ * - ENOENT The file does not exist. >+ * - ENOMEM Insufficient was available. >+ * - ENOENT file or directory does not exist >+ * >+ * @todo Are we actually going to be able to implement this function >+ * >+ * @todo How do we abstract owner and group uid and gid? >+ * >+ */ >+int smbc_chown(const char *url, uid_t owner, gid_t group); >+ >+ >+/**@ingroup attribute >+ * Change the permissions of a file. >+ * >+ * @param url The smb url of the file or directory to change >+ * permissions of >+ * >+ * @param mode The permissions to set: >+ * - Put good explaination of permissions here! >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EPERM The effective UID does not match the owner >+ * of the file, and is not zero >+ * - ENOENT The file does not exist. >+ * - ENOMEM Insufficient was available. >+ * - ENOENT file or directory does not exist >+ * >+ * @todo Actually implement this fuction? >+ * >+ * @todo Are errno values complete and correct? >+ */ >+int smbc_chmod(const char *url, mode_t mode); >+ >+/**@ingroup attribute >+ * Change the last modification time on a file >+ * >+ * @param url The smb url of the file or directory to change >+ * the modification time of >+ * >+ * @param tbuf A timeval structure which contains the desired >+ * modification time. NOTE: Only the tv_sec field is >+ * used. The tv_usec (microseconds) portion is ignored. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - EPERM Permission was denied. >+ * >+ */ >+int smbc_utimes(const char *url, struct timeval *tbuf); >+ >+#ifdef HAVE_UTIME_H >+/**@ingroup attribute >+ * Change the last modification time on a file >+ * >+ * @param url The smb url of the file or directory to change >+ * the modification time of >+ * >+ * @param utbuf A utimebuf structure which contains the desired >+ * modification time. NOTE: Although the structure contains >+ * an access time as well, the access time value is ignored. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - ENOMEM No memory was available for internal needs >+ * - EPERM Permission was denied. >+ * >+ */ >+int smbc_utime(const char *fname, struct utimbuf *utbuf); >+#endif >+ >+/**@ingroup attribute >+ * Set extended attributes for a file. This is used for modifying a file's >+ * security descriptor (i.e. owner, group, and access control list) >+ * >+ * @param url The smb url of the file or directory to set extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be changed. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter should contain a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @param value The value to be assigned to the specified attribute name. >+ * This buffer should contain only the attribute value if the >+ * name was of the "system.nt_sec_desc.<attribute_name>" >+ * form. If the name was of the "system.nt_sec_desc.*" form >+ * then a complete security descriptor, with name:value pairs >+ * separated by tabs, commas, or newlines (not spaces!), >+ * should be provided in this value buffer. A complete >+ * security descriptor will contain one or more entries >+ * selected from the following: >+ * >+ * REVISION:<revision number> >+ * OWNER:<sid or name> >+ * GROUP:<sid or name> >+ * ACL:<sid or name>:<type>/<flags>/<mask> >+ * >+ * The revision of the ACL specifies the internal Windows NT >+ * ACL revision for the security descriptor. If not specified >+ * it defaults to 1. Using values other than 1 may cause >+ * strange behaviour. >+ * >+ * The owner and group specify the owner and group sids for >+ * the object. If the attribute name (either '*+' with a >+ * complete security descriptor, or individual 'owner+' or >+ * 'group+' attribute names) ended with a plus sign, the >+ * specified name is resolved to a SID value, using the >+ * server on which the file or directory resides. Otherwise, >+ * the value should be provided in SID-printable format as >+ * S-1-x-y-z, and is used directly. The <sid or name> >+ * associated with the ACL: attribute should be provided >+ * similarly. >+ * >+ * @param size The number of the bytes of data in the value buffer >+ * >+ * @param flags A bit-wise OR of zero or more of the following: >+ * SMBC_XATTR_FLAG_CREATE - >+ * fail if the named attribute already exists >+ * SMBC_XATTR_FLAG_REPLACE - >+ * fail if the attribute does not already exist >+ * >+ * If neither flag is specified, the specified attributes >+ * will be added or replace existing attributes of the same >+ * name, as necessary. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * or one of the parameters is not of a correct >+ * form >+ * - ENOMEM No memory was available for internal needs >+ * - EEXIST If the attribute already exists and the flag >+ * SMBC_XATTR_FLAG_CREAT was specified >+ * - ENOATTR If the attribute does not exist and the flag >+ * SMBC_XATTR_FLAG_REPLACE was specified >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ * @note Attribute names are compared in a case-insensitive >+ * fashion. All of the following are equivalent, although >+ * the all-lower-case name is the preferred format: >+ * system.nt_sec_desc.owner >+ * SYSTEM.NT_SEC_DESC.OWNER >+ * sYsTeM.nt_sEc_desc.owNER >+ * >+ */ >+int smbc_setxattr(const char *url, >+ const char *name, >+ const void *value, >+ size_t size, >+ int flags); >+ >+ >+/**@ingroup attribute >+ * Set extended attributes for a file. This is used for modifying a file's >+ * security descriptor (i.e. owner, group, and access control list). The >+ * POSIX function which this maps to would act on a symbolic link rather than >+ * acting on what the symbolic link points to, but with no symbolic links in >+ * SMB file systems, this function is functionally identical to >+ * smbc_setxattr(). >+ * >+ * @param url The smb url of the file or directory to set extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be changed. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter should contain a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @param value The value to be assigned to the specified attribute name. >+ * This buffer should contain only the attribute value if the >+ * name was of the "system.nt_sec_desc.<attribute_name>" >+ * form. If the name was of the "system.nt_sec_desc.*" form >+ * then a complete security descriptor, with name:value pairs >+ * separated by tabs, commas, or newlines (not spaces!), >+ * should be provided in this value buffer. A complete >+ * security descriptor will contain one or more entries >+ * selected from the following: >+ * >+ * REVISION:<revision number> >+ * OWNER:<sid or name> >+ * GROUP:<sid or name> >+ * ACL:<sid or name>:<type>/<flags>/<mask> >+ * >+ * The revision of the ACL specifies the internal Windows NT >+ * ACL revision for the security descriptor. If not specified >+ * it defaults to 1. Using values other than 1 may cause >+ * strange behaviour. >+ * >+ * The owner and group specify the owner and group sids for >+ * the object. If the attribute name (either '*+' with a >+ * complete security descriptor, or individual 'owner+' or >+ * 'group+' attribute names) ended with a plus sign, the >+ * specified name is resolved to a SID value, using the >+ * server on which the file or directory resides. Otherwise, >+ * the value should be provided in SID-printable format as >+ * S-1-x-y-z, and is used directly. The <sid or name> >+ * associated with the ACL: attribute should be provided >+ * similarly. >+ * >+ * @param size The number of the bytes of data in the value buffer >+ * >+ * @param flags A bit-wise OR of zero or more of the following: >+ * SMBC_XATTR_FLAG_CREATE - >+ * fail if the named attribute already exists >+ * SMBC_XATTR_FLAG_REPLACE - >+ * fail if the attribute does not already exist >+ * >+ * If neither flag is specified, the specified attributes >+ * will be added or replace existing attributes of the same >+ * name, as necessary. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * or one of the parameters is not of a correct >+ * form >+ * - ENOMEM No memory was available for internal needs >+ * - EEXIST If the attribute already exists and the flag >+ * SMBC_XATTR_FLAG_CREAT was specified >+ * - ENOATTR If the attribute does not exist and the flag >+ * SMBC_XATTR_FLAG_REPLACE was specified >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ * @note Attribute names are compared in a case-insensitive >+ * fashion. All of the following are equivalent, although >+ * the all-lower-case name is the preferred format: >+ * system.nt_sec_desc.owner >+ * SYSTEM.NT_SEC_DESC.OWNER >+ * sYsTeM.nt_sEc_desc.owNER >+ * >+ */ >+int smbc_lsetxattr(const char *url, >+ const char *name, >+ const void *value, >+ size_t size, >+ int flags); >+ >+ >+/**@ingroup attribute >+ * Set extended attributes for a file. This is used for modifying a file's >+ * security descriptor (i.e. owner, group, and access control list) >+ * >+ * @param fd A file descriptor associated with an open file (as >+ * previously returned by smbc_open(), to get extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be changed. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter should contain a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @param value The value to be assigned to the specified attribute name. >+ * This buffer should contain only the attribute value if the >+ * name was of the "system.nt_sec_desc.<attribute_name>" >+ * form. If the name was of the "system.nt_sec_desc.*" form >+ * then a complete security descriptor, with name:value pairs >+ * separated by tabs, commas, or newlines (not spaces!), >+ * should be provided in this value buffer. A complete >+ * security descriptor will contain one or more entries >+ * selected from the following: >+ * >+ * REVISION:<revision number> >+ * OWNER:<sid or name> >+ * GROUP:<sid or name> >+ * ACL:<sid or name>:<type>/<flags>/<mask> >+ * >+ * The revision of the ACL specifies the internal Windows NT >+ * ACL revision for the security descriptor. If not specified >+ * it defaults to 1. Using values other than 1 may cause >+ * strange behaviour. >+ * >+ * The owner and group specify the owner and group sids for >+ * the object. If the attribute name (either '*+' with a >+ * complete security descriptor, or individual 'owner+' or >+ * 'group+' attribute names) ended with a plus sign, the >+ * specified name is resolved to a SID value, using the >+ * server on which the file or directory resides. Otherwise, >+ * the value should be provided in SID-printable format as >+ * S-1-x-y-z, and is used directly. The <sid or name> >+ * associated with the ACL: attribute should be provided >+ * similarly. >+ * >+ * @param size The number of the bytes of data in the value buffer >+ * >+ * @param flags A bit-wise OR of zero or more of the following: >+ * SMBC_XATTR_FLAG_CREATE - >+ * fail if the named attribute already exists >+ * SMBC_XATTR_FLAG_REPLACE - >+ * fail if the attribute does not already exist >+ * >+ * If neither flag is specified, the specified attributes >+ * will be added or replace existing attributes of the same >+ * name, as necessary. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * or one of the parameters is not of a correct >+ * form >+ * - ENOMEM No memory was available for internal needs >+ * - EEXIST If the attribute already exists and the flag >+ * SMBC_XATTR_FLAG_CREAT was specified >+ * - ENOATTR If the attribute does not exist and the flag >+ * SMBC_XATTR_FLAG_REPLACE was specified >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ * @note Attribute names are compared in a case-insensitive >+ * fashion. All of the following are equivalent, although >+ * the all-lower-case name is the preferred format: >+ * system.nt_sec_desc.owner >+ * SYSTEM.NT_SEC_DESC.OWNER >+ * sYsTeM.nt_sEc_desc.owNER >+ * >+ */ >+int smbc_fsetxattr(int fd, >+ const char *name, >+ const void *value, >+ size_t size, >+ int flags); >+ >+ >+/**@ingroup attribute >+ * Get extended attributes for a file. >+ * >+ * @param url The smb url of the file or directory to get extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be retrieved. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter will return a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @param value A pointer to a buffer in which the value of the specified >+ * attribute will be placed (unless size is zero). >+ * >+ * @param size The size of the buffer pointed to by value. This parameter >+ * may also be zero, in which case the size of the buffer >+ * required to hold the attribute value will be returned, >+ * but nothing will be placed into the value buffer. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * or one of the parameters is not of a correct >+ * form >+ * - ENOMEM No memory was available for internal needs >+ * - EEXIST If the attribute already exists and the flag >+ * SMBC_XATTR_FLAG_CREAT was specified >+ * - ENOATTR If the attribute does not exist and the flag >+ * SMBC_XATTR_FLAG_REPLACE was specified >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ */ >+int smbc_getxattr(const char *url, >+ const char *name, >+ const void *value, >+ size_t size); >+ >+ >+/**@ingroup attribute >+ * Get extended attributes for a file. The POSIX function which this maps to >+ * would act on a symbolic link rather than acting on what the symbolic link >+ * points to, but with no symbolic links in SMB file systems, this function >+ * is functionally identical to smbc_getxattr(). >+ * >+ * @param url The smb url of the file or directory to get extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be retrieved. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter will return a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @param value A pointer to a buffer in which the value of the specified >+ * attribute will be placed (unless size is zero). >+ * >+ * @param size The size of the buffer pointed to by value. This parameter >+ * may also be zero, in which case the size of the buffer >+ * required to hold the attribute value will be returned, >+ * but nothing will be placed into the value buffer. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * or one of the parameters is not of a correct >+ * form >+ * - ENOMEM No memory was available for internal needs >+ * - EEXIST If the attribute already exists and the flag >+ * SMBC_XATTR_FLAG_CREAT was specified >+ * - ENOATTR If the attribute does not exist and the flag >+ * SMBC_XATTR_FLAG_REPLACE was specified >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ */ >+int smbc_lgetxattr(const char *url, >+ const char *name, >+ const void *value, >+ size_t size); >+ >+ >+/**@ingroup attribute >+ * Get extended attributes for a file. >+ * >+ * @param fd A file descriptor associated with an open file (as >+ * previously returned by smbc_open(), to get extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be retrieved. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter will return a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @param value A pointer to a buffer in which the value of the specified >+ * attribute will be placed (unless size is zero). >+ * >+ * @param size The size of the buffer pointed to by value. This parameter >+ * may also be zero, in which case the size of the buffer >+ * required to hold the attribute value will be returned, >+ * but nothing will be placed into the value buffer. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * or one of the parameters is not of a correct >+ * form >+ * - ENOMEM No memory was available for internal needs >+ * - EEXIST If the attribute already exists and the flag >+ * SMBC_XATTR_FLAG_CREAT was specified >+ * - ENOATTR If the attribute does not exist and the flag >+ * SMBC_XATTR_FLAG_REPLACE was specified >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ */ >+int smbc_fgetxattr(int fd, >+ const char *name, >+ const void *value, >+ size_t size); >+ >+ >+/**@ingroup attribute >+ * Remove extended attributes for a file. This is used for modifying a file's >+ * security descriptor (i.e. owner, group, and access control list) >+ * >+ * @param url The smb url of the file or directory to remove the extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be removed. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter will return a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - ENOMEM No memory was available for internal needs >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ */ >+int smbc_removexattr(const char *url, >+ const char *name); >+ >+ >+/**@ingroup attribute >+ * Remove extended attributes for a file. This is used for modifying a file's >+ * security descriptor (i.e. owner, group, and access control list) The POSIX >+ * function which this maps to would act on a symbolic link rather than acting >+ * on what the symbolic link points to, but with no symbolic links in SMB file >+ * systems, this function is functionally identical to smbc_removexattr(). >+ * >+ * @param url The smb url of the file or directory to remove the extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be removed. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter will return a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - ENOMEM No memory was available for internal needs >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ */ >+int smbc_lremovexattr(const char *url, >+ const char *name); >+ >+ >+/**@ingroup attribute >+ * Remove extended attributes for a file. This is used for modifying a file's >+ * security descriptor (i.e. owner, group, and access control list) >+ * >+ * @param fd A file descriptor associated with an open file (as >+ * previously returned by smbc_open(), to get extended >+ * attributes for. >+ * >+ * @param name The name of an attribute to be removed. Names are of >+ * one of the following forms: >+ * >+ * system.nt_sec_desc.<attribute name> >+ * system.nt_sec_desc.* >+ * system.nt_sec_desc.*+ >+ * >+ * where <attribute name> is one of: >+ * >+ * revision >+ * owner >+ * owner+ >+ * group >+ * group+ >+ * acl:<name or sid> >+ * acl+:<name or sid> >+ * >+ * In the forms "system.nt_sec_desc.*" and >+ * "system.nt_sec_desc.*+", the asterisk and plus signs are >+ * literal, i.e. the string is provided exactly as shown, and >+ * the value parameter will return a complete security >+ * descriptor with name:value pairs separated by tabs, >+ * commas, or newlines (not spaces!). >+ * >+ * The plus sign ('+') indicates that SIDs should be mapped >+ * to names. Without the plus sign, SIDs are not mapped; >+ * rather they are simply converted to a string format. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - ENOMEM No memory was available for internal needs >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ */ >+int smbc_fremovexattr(int fd, >+ const char *name); >+ >+ >+/**@ingroup attribute >+ * List the supported extended attribute names associated with a file >+ * >+ * @param url The smb url of the file or directory to list the extended >+ * attributes for. >+ * >+ * @param list A pointer to a buffer in which the list of attributes for >+ * the specified file or directory will be placed (unless >+ * size is zero). >+ * >+ * @param size The size of the buffer pointed to by list. This parameter >+ * may also be zero, in which case the size of the buffer >+ * required to hold all of the attribute names will be >+ * returned, but nothing will be placed into the list buffer. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - ENOMEM No memory was available for internal needs >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ * @note This function always returns all attribute names supported >+ * by NT file systems, regardless of wether the referenced >+ * file system supports extended attributes (e.g. a Windows >+ * 2000 machine supports extended attributes if NTFS is used, >+ * but not if FAT is used, and Windows 98 doesn't support >+ * extended attributes at all. Whether this is a feature or >+ * a bug is yet to be decided. >+ */ >+int smbc_listxattr(const char *url, >+ char *list, >+ size_t size); >+ >+/**@ingroup attribute >+ * List the supported extended attribute names associated with a file The >+ * POSIX function which this maps to would act on a symbolic link rather than >+ * acting on what the symbolic link points to, but with no symbolic links in >+ * SMB file systems, this function is functionally identical to >+ * smbc_listxattr(). >+ * >+ * @param url The smb url of the file or directory to list the extended >+ * attributes for. >+ * >+ * @param list A pointer to a buffer in which the list of attributes for >+ * the specified file or directory will be placed (unless >+ * size is zero). >+ * >+ * @param size The size of the buffer pointed to by list. This parameter >+ * may also be zero, in which case the size of the buffer >+ * required to hold all of the attribute names will be >+ * returned, but nothing will be placed into the list buffer. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - ENOMEM No memory was available for internal needs >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ * @note This function always returns all attribute names supported >+ * by NT file systems, regardless of wether the referenced >+ * file system supports extended attributes (e.g. a Windows >+ * 2000 machine supports extended attributes if NTFS is used, >+ * but not if FAT is used, and Windows 98 doesn't support >+ * extended attributes at all. Whether this is a feature or >+ * a bug is yet to be decided. >+ */ >+int smbc_llistxattr(const char *url, >+ char *list, >+ size_t size); >+ >+/**@ingroup attribute >+ * List the supported extended attribute names associated with a file >+ * >+ * @param fd A file descriptor associated with an open file (as >+ * previously returned by smbc_open(), to get extended >+ * attributes for. >+ * >+ * @param list A pointer to a buffer in which the list of attributes for >+ * the specified file or directory will be placed (unless >+ * size is zero). >+ * >+ * @param size The size of the buffer pointed to by list. This parameter >+ * may also be zero, in which case the size of the buffer >+ * required to hold all of the attribute names will be >+ * returned, but nothing will be placed into the list buffer. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL The client library is not properly initialized >+ * - ENOMEM No memory was available for internal needs >+ * - EPERM Permission was denied. >+ * - ENOTSUP The referenced file system does not support >+ * extended attributes >+ * >+ * @note This function always returns all attribute names supported >+ * by NT file systems, regardless of wether the referenced >+ * file system supports extended attributes (e.g. a Windows >+ * 2000 machine supports extended attributes if NTFS is used, >+ * but not if FAT is used, and Windows 98 doesn't support >+ * extended attributes at all. Whether this is a feature or >+ * a bug is yet to be decided. >+ */ >+int smbc_flistxattr(int fd, >+ char *list, >+ size_t size); >+ >+/**@ingroup print >+ * Print a file given the name in fname. It would be a URL ... >+ * >+ * @param fname The URL of a file on a remote SMB server that the >+ * caller wants printed >+ * >+ * @param printq The URL of the print share to print the file to. >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * >+ * - EINVAL fname or printq was NULL or smbc_init not >+ * not called. >+ * and errors returned by smbc_open >+ * >+ */ >+int smbc_print_file(const char *fname, const char *printq); >+ >+/**@ingroup print >+ * Open a print file that can be written to by other calls. This simply >+ * does an smbc_open call after checking if there is a file name on the >+ * URI. If not, a temporary name is added ... >+ * >+ * @param fname The URL of the print share to print to? >+ * >+ * @returns A file handle for the print file if successful. >+ * Returns -1 if an error ocurred and errno has the values >+ * - EINVAL fname was NULL or smbc_init not called. >+ * - all errors returned by smbc_open >+ * >+ */ >+int smbc_open_print_job(const char *fname); >+ >+/**@ingroup print >+ * List the print jobs on a print share, for the moment, pass a callback >+ * >+ * @param purl The url of the print share to list the jobs of >+ * >+ * @param fn Callback function the receives printjob info >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL fname was NULL or smbc_init not called >+ * - EACCES ??? >+ */ >+int smbc_list_print_jobs(const char *purl, smbc_list_print_job_fn fn); >+ >+/**@ingroup print >+ * Delete a print job >+ * >+ * @param purl Url of the print share >+ * >+ * @param id The id of the job to delete >+ * >+ * @return 0 on success, < 0 on error with errno set: >+ * - EINVAL fname was NULL or smbc_init not called >+ * >+ * @todo what errno values are possible here? >+ */ >+int smbc_unlink_print_job(const char *purl, int id); >+ >+/**@ingroup callback >+ * Remove a server from the cached server list it's unused. >+ * >+ * @param context pointer to smb context >+ * >+ * @param srv pointer to server to remove >+ * >+ * @return On success, 0 is returned. 1 is returned if the server could not >+ * be removed. Also useable outside libsmbclient. >+ */ >+int smbc_remove_unused_server(SMBCCTX * context, SMBCSRV * srv); >+ >+#ifdef __cplusplus >+} >+#endif >+ >+/**@ingroup directory >+ * Convert strings of %xx to their single character equivalent. >+ * >+ * @param dest A pointer to a buffer in which the resulting decoded >+ * string should be placed. This may be a pointer to the >+ * same buffer as src_segment. >+ * >+ * @param src A pointer to the buffer containing the URL to be decoded. >+ * Any %xx sequences herein are converted to their single >+ * character equivalent. Each 'x' must be a valid hexadecimal >+ * digit, or that % sequence is left undecoded. >+ * >+ * @param max_dest_len >+ * The size of the buffer pointed to by dest_segment. >+ * >+ * @return The number of % sequences which could not be converted >+ * due to lack of two following hexadecimal digits. >+ */ >+#ifdef __cplusplus >+extern "C" { >+#endif >+int >+smbc_urldecode(char *dest, char * src, size_t max_dest_len); >+#ifdef __cplusplus >+} >+#endif >+ >+ >+/* >+ * Convert any characters not specifically allowed in a URL into their %xx >+ * equivalent. >+ * >+ * @param dest A pointer to a buffer in which the resulting encoded >+ * string should be placed. Unlike smbc_urldecode(), this >+ * must be a buffer unique from src. >+ * >+ * @param src A pointer to the buffer containing the string to be encoded. >+ * Any character not specifically allowed in a URL is converted >+ * into its hexadecimal value and encoded as %xx. >+ * >+ * @param max_dest_len >+ * The size of the buffer pointed to by dest_segment. >+ * >+ * @returns The remaining buffer length. >+ */ >+#ifdef __cplusplus >+extern "C" { >+#endif >+int >+smbc_urlencode(char * dest, char * src, int max_dest_len); >+#ifdef __cplusplus >+} >+#endif >+ >+ >+/**@ingroup directory >+ * Return the version of the linked Samba code, and thus the version of the >+ * libsmbclient code. >+ * >+ * @return The version string. >+ */ >+#ifdef __cplusplus >+extern "C" { >+#endif >+const char * >+smbc_version(void); >+#ifdef __cplusplus >+} >+#endif >+ >+ >+#endif /* SMBCLIENT_H_INCLUDED */
<b>You cannot view the attachment while viewing its details because your browser does not support IFRAMEs. <a href="attachment.cgi?id=2256">View the attachment on a separate page</a>.</b>
View Attachment As Raw
Actions:
View
Attachments on
bug 4053
:
2255
| 2256 |
2698
|
2699