s3 libsmbclient: Fix fstatvfs to be more portable
[jra/samba/.git] / source3 / include / libsmb_internal.h
1 /* 
2    Unix SMB/Netbios implementation.
3    SMB client library implementation
4    Copyright (C) Andrew Tridgell 1998
5    Copyright (C) Richard Sharpe 2000, 2002
6    Copyright (C) John Terpstra 2000
7    Copyright (C) Tom Jansen (Ninja ISD) 2002 
8    Copyright (C) Derrell Lipman 2003-2008
9    Copyright (C) Jeremy Allison 2007, 2008
10    
11    This program is free software; you can redistribute it and/or modify
12    it under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 3 of the License, or
14    (at your option) any later version.
15    
16    This program is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19    GNU General Public License for more details.
20    
21    You should have received a copy of the GNU General Public License
22    along with this program.  If not, see <http://www.gnu.org/licenses/>.
23 */
24
25 #include "includes.h"
26
27
28 #ifndef _LIBSMB_INTERNAL_H_
29 #define _LIBSMB_INTERNAL_H_
30
31 #include "../include/libsmbclient.h"
32
33 #define SMBC_MAX_NAME  1023
34 #define SMBC_FILE_MODE (S_IFREG | 0444)
35 #define SMBC_DIR_MODE  (S_IFDIR | 0555)
36
37 /*
38  * DOS Attribute values (used internally)
39  */
40 typedef struct DOS_ATTR_DESC {
41         int mode;
42         SMB_OFF_T size;
43         time_t create_time;
44         time_t access_time;
45         time_t write_time;
46         time_t change_time;
47         SMB_INO_T inode;
48 } DOS_ATTR_DESC;
49
50
51 /*
52  * Internal flags for extended attributes
53  */
54
55 /* internal mode values */
56 #define SMBC_XATTR_MODE_ADD          1
57 #define SMBC_XATTR_MODE_REMOVE       2
58 #define SMBC_XATTR_MODE_REMOVE_ALL   3
59 #define SMBC_XATTR_MODE_SET          4
60 #define SMBC_XATTR_MODE_CHOWN        5
61 #define SMBC_XATTR_MODE_CHGRP        6
62
63 #define CREATE_ACCESS_READ      READ_CONTROL_ACCESS
64
65 /*We should test for this in configure ... */
66 #ifndef ENOTSUP
67 #define ENOTSUP EOPNOTSUPP
68 #endif
69
70
71 struct _SMBCSRV {
72         struct cli_state *cli;
73         dev_t dev;
74         bool no_pathinfo;
75         bool no_pathinfo2;
76         bool no_nt_session;
77         POLICY_HND pol;
78
79         SMBCSRV *next, *prev;
80         
81 };
82
83 /* 
84  * Keep directory entries in a list 
85  */
86 struct smbc_dir_list {
87         struct smbc_dir_list *next;
88         struct smbc_dirent *dirent;
89 };
90
91
92 /*
93  * Structure for open file management
94  */ 
95 struct _SMBCFILE {
96         int cli_fd; 
97         char *fname;
98         SMB_OFF_T offset;
99         struct _SMBCSRV *srv;
100         bool file;
101         struct smbc_dir_list *dir_list, *dir_end, *dir_next;
102         int dir_type, dir_error;
103
104         SMBCFILE *next, *prev;
105 };
106
107
108 /*
109  * Context structure
110  */
111 struct SMBC_internal_data {
112
113         /* True when this handle is initialized */
114         bool                                    initialized;
115
116         /* dirent pointer location */
117         struct smbc_dirent                      dirent;
118         /*
119          * Leave room for any urlencoded filename and the comment field.
120          *
121          * We use (NAME_MAX * 3) plus whatever the max length of a comment is,
122          * plus a couple of null terminators (one after the filename,
123          * one after the comment).
124          *
125          * According to <linux/limits.h>, NAME_MAX is 255.  Is it longer
126          * anyplace else?
127          */
128         char                                    _dirent_name[1024];
129
130         /*
131          * server connection list
132          */
133         SMBCSRV *                               servers;
134         
135         /*
136          * open file/dir list
137          */
138         SMBCFILE *                              files;
139
140         /*
141          * Log to standard error instead of the more typical standard output
142          */
143         bool                                    debug_stderr;
144
145         /*
146          * Support "Create Time" in get/set with the *xattr() functions, if
147          * true.  This replaces the dos attribute strings C_TIME, A_TIME and
148          * M_TIME with CHANGE_TIME, ACCESS_TIME and WRITE_TIME, and adds
149          * CREATE_TIME.  Default is FALSE, i.e.  to use the old-style shorter
150          * names and to not support CREATE time, for backward compatibility.
151          */
152         bool                                    full_time_names;
153
154         /*
155          * The share mode of a file being opened.  To match POSIX semantics
156          * (and maintain backward compatibility), DENY_NONE is the default.
157          */
158         smbc_share_mode                         share_mode;
159
160         /*
161          * Authentication function which includes the context.  This will be
162          * used if set; otherwise context->callbacks.auth_fn() will be used.
163          */
164         smbc_get_auth_data_with_context_fn      auth_fn_with_context;
165
166         /*
167          * An opaque (to this library) user data handle which can be set
168          * and retrieved with smbc_option_set() and smbc_option_get().
169          */
170         void *                                  user_data;
171
172         /*
173          * Should we attempt UNIX smb encryption ? 
174          * Set to 0 if we should never attempt, set to 1 if
175          * encryption requested, set to 2 if encryption required.
176          */
177         smbc_smb_encrypt_level                  smb_encryption_level;
178
179         /*
180          * Should we request case sensitivity of file names?
181          */
182         bool                                    case_sensitive;
183
184         struct smbc_server_cache * server_cache;
185
186         /* POSIX emulation functions */
187         struct
188         {
189 #if 0 /* Left in libsmbclient.h for backward compatibility */
190                 smbc_open_fn                    open_fn;
191                 smbc_creat_fn                   creat_fn;
192                 smbc_read_fn                    read_fn;
193                 smbc_write_fn                   write_fn;
194                 smbc_unlink_fn                  unlink_fn;
195                 smbc_rename_fn                  rename_fn;
196                 smbc_lseek_fn                   lseek_fn;
197                 smbc_stat_fn                    stat_fn;
198                 smbc_fstat_fn                   fstat_fn;
199 #endif
200                 smbc_statvfs_fn                 statvfs_fn;
201                 smbc_fstatvfs_fn                fstatvfs_fn;
202                 smbc_ftruncate_fn               ftruncate_fn;
203 #if 0 /* Left in libsmbclient.h for backward compatibility */
204                 smbc_close_fn                   close_fn;
205                 smbc_opendir_fn                 opendir_fn;
206                 smbc_closedir_fn                closedir_fn;
207                 smbc_readdir_fn                 readdir_fn;
208                 smbc_getdents_fn                getdents_fn;
209                 smbc_mkdir_fn                   mkdir_fn;
210                 smbc_rmdir_fn                   rmdir_fn;
211                 smbc_telldir_fn                 telldir_fn;
212                 smbc_lseekdir_fn                lseekdir_fn;
213                 smbc_fstatdir_fn                fstatdir_fn;
214                 smbc_chmod_fn                   chmod_fn;
215                 smbc_utimes_fn                  utimes_fn;
216                 smbc_setxattr_fn                setxattr_fn;
217                 smbc_getxattr_fn                getxattr_fn;
218                 smbc_removexattr_fn             removexattr_fn;
219                 smbc_listxattr_fn               listxattr_fn;
220 #endif
221         }               posix_emu;
222
223 #if 0 /* Left in libsmbclient.h for backward compatibility */
224         /* Printing-related functions */
225         struct
226         {
227                 smbc_print_file_fn              print_file_fn;
228                 smbc_open_print_job_fn          open_print_job_fn;
229                 smbc_list_print_jobs_fn         list_print_jobs_fn;
230                 smbc_unlink_print_job_fn        unlink_print_job_fn;
231         }               printing;
232 #endif
233
234 #if 0 /* None available yet */
235         /* SMB high-level functions */
236         struct
237         {
238         }               smb;
239
240 #endif
241 };      
242
243 /* Functions in libsmb_cache.c */
244 int
245 SMBC_add_cached_server(SMBCCTX * context,
246                        SMBCSRV * newsrv,
247                        const char * server,
248                        const char * share, 
249                        const char * workgroup,
250                        const char * username);
251
252 SMBCSRV *
253 SMBC_get_cached_server(SMBCCTX * context,
254                        const char * server, 
255                        const char * share,
256                        const char * workgroup,
257                        const char * user);
258
259 int
260 SMBC_remove_cached_server(SMBCCTX * context,
261                           SMBCSRV * server);
262
263 int
264 SMBC_purge_cached_servers(SMBCCTX * context);
265
266
267 /* Functions in libsmb_dir.c */
268 int
269 SMBC_check_options(char *server,
270                    char *share,
271                    char *path,
272                    char *options);
273
274 SMBCFILE *
275 SMBC_opendir_ctx(SMBCCTX *context,
276                  const char *fname);
277
278 int
279 SMBC_closedir_ctx(SMBCCTX *context,
280                   SMBCFILE *dir);
281
282 struct smbc_dirent *
283 SMBC_readdir_ctx(SMBCCTX *context,
284                  SMBCFILE *dir);
285
286 int
287 SMBC_getdents_ctx(SMBCCTX *context,
288                   SMBCFILE *dir,
289                   struct smbc_dirent *dirp,
290                   int count);
291
292 int
293 SMBC_mkdir_ctx(SMBCCTX *context,
294                const char *fname,
295                mode_t mode);
296
297 int
298 SMBC_rmdir_ctx(SMBCCTX *context,
299                const char *fname);
300
301 off_t
302 SMBC_telldir_ctx(SMBCCTX *context,
303                  SMBCFILE *dir);
304
305 int
306 SMBC_lseekdir_ctx(SMBCCTX *context,
307                   SMBCFILE *dir,
308                   off_t offset);
309
310 int
311 SMBC_fstatdir_ctx(SMBCCTX *context,
312                   SMBCFILE *dir,
313                   struct stat *st);
314
315 int
316 SMBC_chmod_ctx(SMBCCTX *context,
317                const char *fname,
318                mode_t newmode);
319
320 int
321 SMBC_utimes_ctx(SMBCCTX *context,
322                 const char *fname,
323                 struct timeval *tbuf);
324
325 int
326 SMBC_unlink_ctx(SMBCCTX *context,
327                 const char *fname);
328
329 int
330 SMBC_rename_ctx(SMBCCTX *ocontext,
331                 const char *oname, 
332                 SMBCCTX *ncontext,
333                 const char *nname);
334
335
336 /* Functions in libsmb_file.c */
337 SMBCFILE *
338 SMBC_open_ctx(SMBCCTX *context,
339               const char *fname,
340               int flags,
341               mode_t mode);
342
343 SMBCFILE *
344 SMBC_creat_ctx(SMBCCTX *context,
345                const char *path,
346                mode_t mode);
347
348 ssize_t
349 SMBC_read_ctx(SMBCCTX *context,
350               SMBCFILE *file,
351               void *buf,
352               size_t count);
353
354 ssize_t
355 SMBC_write_ctx(SMBCCTX *context,
356                SMBCFILE *file,
357                const void *buf,
358                size_t count);
359
360 int
361 SMBC_close_ctx(SMBCCTX *context,
362                SMBCFILE *file);
363
364 bool
365 SMBC_getatr(SMBCCTX * context,
366             SMBCSRV *srv,
367             char *path,
368             uint16 *mode,
369             SMB_OFF_T *size,
370             struct timespec *create_time_ts,
371             struct timespec *access_time_ts,
372             struct timespec *write_time_ts,
373             struct timespec *change_time_ts,
374             SMB_INO_T *ino);
375
376 bool
377 SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path, 
378             time_t create_time,
379             time_t access_time,
380             time_t write_time,
381             time_t change_time,
382             uint16 mode);
383
384 off_t
385 SMBC_lseek_ctx(SMBCCTX *context,
386                SMBCFILE *file,
387                off_t offset,
388                int whence);
389
390 int
391 SMBC_ftruncate_ctx(SMBCCTX *context,
392                    SMBCFILE *file,
393                    off_t length);
394
395
396 /* Functions in libsmb_misc.c */
397 int
398 SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
399
400 int
401 SMBC_errno(SMBCCTX *context,
402            struct cli_state *c);
403
404
405 /* Functions in libsmb_path.c */
406 int
407 SMBC_parse_path(TALLOC_CTX *ctx,
408                 SMBCCTX *context,
409                 const char *fname,
410                 char **pp_workgroup,
411                 char **pp_server,
412                 char **pp_share,
413                 char **pp_path,
414                 char **pp_user,
415                 char **pp_password,
416                 char **pp_options);
417
418
419 /* Functions in libsmb_printjob.c */
420 SMBCFILE *
421 SMBC_open_print_job_ctx(SMBCCTX *context,
422                         const char *fname);
423
424 int
425 SMBC_print_file_ctx(SMBCCTX *c_file,
426                     const char *fname,
427                     SMBCCTX *c_print,
428                     const char *printq);
429
430 int
431 SMBC_list_print_jobs_ctx(SMBCCTX *context,
432                          const char *fname,
433                          smbc_list_print_job_fn fn);
434
435 int
436 SMBC_unlink_print_job_ctx(SMBCCTX *context,
437                           const char *fname,
438                           int id);
439
440
441 /* Functions in libsmb_server.c */
442 int
443 SMBC_check_server(SMBCCTX * context,
444                   SMBCSRV * server);
445
446 int
447 SMBC_remove_unused_server(SMBCCTX * context,
448                           SMBCSRV * srv);
449
450 void
451 SMBC_call_auth_fn(TALLOC_CTX *ctx,
452                   SMBCCTX *context,
453                   const char *server,
454                   const char *share,
455                   char **pp_workgroup,
456                   char **pp_username,
457                   char **pp_password);
458
459 void
460 SMBC_get_auth_data(const char *server, const char *share,
461                    char *workgroup_buf, int workgroup_buf_len,
462                    char *username_buf, int username_buf_len,
463                    char *password_buf, int password_buf_len);
464
465 SMBCSRV *
466 SMBC_find_server(TALLOC_CTX *ctx,
467                  SMBCCTX *context,
468                  const char *server,
469                  const char *share,
470                  char **pp_workgroup,
471                  char **pp_username,
472                  char **pp_password);
473
474 SMBCSRV *
475 SMBC_server(TALLOC_CTX *ctx,
476             SMBCCTX *context,
477             bool connect_if_not_found,
478             const char *server,
479             const char *share,
480             char **pp_workgroup,
481             char **pp_username,
482             char **pp_password);
483
484 SMBCSRV *
485 SMBC_attr_server(TALLOC_CTX *ctx,
486                  SMBCCTX *context,
487                  const char *server,
488                  const char *share,
489                  char **pp_workgroup,
490                  char **pp_username,
491                  char **pp_password);
492
493
494 /* Functions in libsmb_stat.c */
495 int
496 SMBC_stat_ctx(SMBCCTX *context,
497               const char *fname,
498               struct stat *st);
499
500 int
501 SMBC_fstat_ctx(SMBCCTX *context,
502                SMBCFILE *file,
503                struct stat *st);
504
505
506 int
507 SMBC_statvfs_ctx(SMBCCTX *context,
508                  char *path,
509                  struct smbc_statvfs *st);
510
511
512 int
513 SMBC_fstatvfs_ctx(SMBCCTX *context,
514                   SMBCFILE *file,
515                   struct smbc_statvfs *st);
516
517
518 /* Functions in libsmb_xattr.c */
519 int
520 SMBC_setxattr_ctx(SMBCCTX *context,
521                   const char *fname,
522                   const char *name,
523                   const void *value,
524                   size_t size,
525                   int flags);
526
527 int
528 SMBC_getxattr_ctx(SMBCCTX *context,
529                   const char *fname,
530                   const char *name,
531                   const void *value,
532                   size_t size);
533
534 int
535 SMBC_removexattr_ctx(SMBCCTX *context,
536                      const char *fname,
537                      const char *name);
538
539 int
540 SMBC_listxattr_ctx(SMBCCTX *context,
541                    const char *fname,
542                    char *list,
543                    size_t size);
544
545
546 #endif