Wed, 27 Nov 2024 23:00:07 +0100
add TODO to use a future ucx feature
54 | 1 | /* |
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
3 | * | |
4 | * Copyright 2013 Olaf Wintermann. All rights reserved. | |
5 | * | |
6 | * Redistribution and use in source and binary forms, with or without | |
7 | * modification, are permitted provided that the following conditions are met: | |
8 | * | |
9 | * 1. Redistributions of source code must retain the above copyright | |
10 | * notice, this list of conditions and the following disclaimer. | |
11 | * | |
12 | * 2. Redistributions in binary form must reproduce the above copyright | |
13 | * notice, this list of conditions and the following disclaimer in the | |
14 | * documentation and/or other materials provided with the distribution. | |
15 | * | |
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
26 | * POSSIBILITY OF SUCH DAMAGE. | |
27 | */ | |
28 | ||
29 | #ifndef VFS_H | |
30 | #define VFS_H | |
31 | ||
59
ab25c0a231d0
some fixes and new public APIs
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
58
diff
changeset
|
32 | #include "../public/vfs.h" |
63
66442f81f823
supports file system ACLs on Solaris
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
59
diff
changeset
|
33 | #include "acl.h" |
54 | 34 | |
415
d938228c382e
switch from ucx 2 to 3
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
366
diff
changeset
|
35 | #include <cx/string.h> |
366
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
36 | |
54 | 37 | #ifdef __cplusplus |
38 | extern "C" { | |
39 | #endif | |
105
63d9051fe35c
using readdir_r instead of readdir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
66
diff
changeset
|
40 | |
366
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
41 | typedef struct VfsType { |
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
42 | vfs_init_func init; |
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
43 | vfs_create_func create; |
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
44 | } VfsType; |
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
45 | |
105
63d9051fe35c
using readdir_r instead of readdir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
66
diff
changeset
|
46 | typedef struct SysVFSDir { |
63d9051fe35c
using readdir_r instead of readdir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
66
diff
changeset
|
47 | DIR *dir; |
63d9051fe35c
using readdir_r instead of readdir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
66
diff
changeset
|
48 | struct dirent *cur; |
63d9051fe35c
using readdir_r instead of readdir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
66
diff
changeset
|
49 | } SysVFSDir; |
187
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
50 | |
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
51 | enum VFSAioOp { |
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
52 | VFS_AIO_READ = 0, |
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
53 | VFS_AIO_WRITE |
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
54 | }; |
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
55 | typedef enum VFSAioOp VFSAioOp; |
63
66442f81f823
supports file system ACLs on Solaris
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
59
diff
changeset
|
56 | |
289
285d483db2fb
add first pg vfs tests
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
247
diff
changeset
|
57 | int vfs_init(void); |
415
d938228c382e
switch from ucx 2 to 3
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
366
diff
changeset
|
58 | VfsType* vfs_get_type(cxstring vfs_class); |
366
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
59 | |
47bc686fafe4
add new dav config element
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
289
diff
changeset
|
60 | void* vfs_init_backend(ServerConfiguration *cfg, pool_handle_t *pool, VfsType *vfs_class, WSConfigNode *config, int *error); |
54 | 61 | |
241
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
62 | typedef int(*vfs_op_f)(VFSContext *, const char *); |
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
63 | typedef int(*sys_op_f)(VFSContext *, const char *, SysACL *); |
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
64 | int vfs_path_op(VFSContext *ctx, const char *path, vfs_op_f op, uint32_t access); |
56
c6cf20b09043
added vfs_mkdir and vfs_unlink
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
55
diff
changeset
|
65 | |
241
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
66 | SYS_FILE sys_vfs_open(VFSContext *ctx, const char *path, int oflags); |
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
67 | int sys_vfs_stat(VFSContext *ctx, const char *path, struct stat *buf); |
165
6942a8c3e737
refactors vfs code
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
105
diff
changeset
|
68 | int sys_vfs_fstat(VFSContext *ctx, SYS_FILE fd, struct stat *buf); |
241
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
69 | VFS_DIR sys_vfs_opendir(VFSContext *ctx, const char *path); |
211
2160585200ac
add propfind/proppatch parser and first iteration of the new webdav api
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
189
diff
changeset
|
70 | VFS_DIR sys_vfs_fdopendir(VFSContext *ctx, SYS_FILE fd); |
241
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
71 | int sys_vfs_mkdir(VFSContext *ctx, const char *path); |
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
72 | int sys_vfs_unlink(VFSContext *ctx, const char *path); |
247
1df803e06076
implement webdav delete for collections
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
241
diff
changeset
|
73 | int sys_vfs_rmdir(VFSContext *ctx, const char *path); |
165
6942a8c3e737
refactors vfs code
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
105
diff
changeset
|
74 | |
241
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
75 | int sys_path_op(VFSContext *ctx, const char *path, sys_op_f op); |
63
66442f81f823
supports file system ACLs on Solaris
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
59
diff
changeset
|
76 | int sys_acl_check(VFSContext *ctx, uint32_t access_mask, SysACL *externacl); |
54 | 77 | void sys_set_error_status(VFSContext *ctx); |
165
6942a8c3e737
refactors vfs code
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
105
diff
changeset
|
78 | |
54 | 79 | ssize_t sys_file_read(SYS_FILE fd, void *buf, size_t nbyte); |
80 | ssize_t sys_file_write(SYS_FILE fd, const void *buf, size_t nbyte); | |
189
a2438f6d1e73
adds vfs pread/pwrite functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
187
diff
changeset
|
81 | ssize_t sys_file_pread(SYS_FILE fd, void *buf, size_t nbyte, off_t offset); |
a2438f6d1e73
adds vfs pread/pwrite functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
187
diff
changeset
|
82 | ssize_t sys_file_pwrite(SYS_FILE fd, const void *buf, size_t nbyte, off_t offset); |
66
74babc0082b7
added authentication cache
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
63
diff
changeset
|
83 | off_t sys_file_seek(SYS_FILE fd, off_t offset, int whence); |
54 | 84 | void sys_file_close(SYS_FILE fd); |
172
5580517faafc
adds public aio and poll api and asynchronous send_range function
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
165
diff
changeset
|
85 | int sys_file_aioread(aiocb_s *aiocb); |
5580517faafc
adds public aio and poll api and asynchronous send_range function
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
165
diff
changeset
|
86 | int sys_file_aiowrite(aiocb_s *aiocb); |
165
6942a8c3e737
refactors vfs code
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
105
diff
changeset
|
87 | |
55
b7908bf38f9f
vfs can read directories
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
54
diff
changeset
|
88 | int sys_dir_read(VFS_DIR dir, VFS_ENTRY *entry, int getstat); |
b7908bf38f9f
vfs can read directories
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
54
diff
changeset
|
89 | void sys_dir_close(VFS_DIR dir); |
165
6942a8c3e737
refactors vfs code
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
105
diff
changeset
|
90 | |
241
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
91 | int sys_mkdir(VFSContext *ctx, const char *path, SysACL *sysacl); |
4adad7faf452
add proppatch op
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
211
diff
changeset
|
92 | int sys_unlink(VFSContext *ctx, const char *path, SysACL *sysacl); |
247
1df803e06076
implement webdav delete for collections
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
241
diff
changeset
|
93 | int sys_rmdir(VFSContext *ctx, const char *path, SysACL *sysacl); |
54 | 94 | |
450
d7b276de183b
fix cgi pipes not closed in some error case + minor improvements
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
415
diff
changeset
|
95 | NSAPI_PUBLIC int vfs_is_sys(VFS *vfs); |
d7b276de183b
fix cgi pipes not closed in some error case + minor improvements
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
415
diff
changeset
|
96 | |
187
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
97 | void vfs_queue_aio(aiocb_s *aiocb, VFSAioOp op); |
4384bfbb7e26
adds platform independent aio functions
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
172
diff
changeset
|
98 | |
54 | 99 | #ifdef __cplusplus |
100 | } | |
101 | #endif | |
102 | ||
103 | #endif /* VFS_H */ | |
104 |