1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements.  See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License.  You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef FILE_IO_H
18 #define FILE_IO_H
19 
20 #include "apr.h"
21 #include "apr_private.h"
22 #include "apr_general.h"
23 #include "apr_tables.h"
24 #include "apr_file_io.h"
25 #include "apr_file_info.h"
26 #include "apr_errno.h"
27 #include "apr_lib.h"
28 #include "apr_poll.h"
29 
30 /* System headers the file I/O library needs */
31 #if APR_HAVE_FCNTL_H
32 #include <fcntl.h>
33 #endif
34 #if APR_HAVE_SYS_TYPES_H
35 #include <sys/types.h>
36 #endif
37 #if APR_HAVE_ERRNO_H
38 #include <errno.h>
39 #endif
40 #if APR_HAVE_STRING_H
41 #include <string.h>
42 #endif
43 #if APR_HAVE_STRINGS_H
44 #include <strings.h>
45 #endif
46 #if APR_HAVE_DIRENT_H
47 #include <dirent.h>
48 #endif
49 #ifdef HAVE_SYS_STAT_H
50 #include <sys/stat.h>
51 #endif
52 #if APR_HAVE_UNISTD_H
53 #include <unistd.h>
54 #endif
55 #if APR_HAVE_STDIO_H
56 #include <stdio.h>
57 #endif
58 #if APR_HAVE_STDLIB_H
59 #include <stdlib.h>
60 #endif
61 #if APR_HAVE_SYS_UIO_H
62 #include <sys/uio.h>
63 #endif
64 #if APR_HAVE_SYS_TIME_H
65 #include <sys/time.h>
66 #endif
67 
68 #include <fsio.h>
69 
70 /* End System headers */
71 
72 #define APR_FILE_BUFSIZE 4096
73 
74 #if APR_HAS_LARGE_FILES
75 #define lseek(f,o,w) lseek64(f,o,w)
76 #define ftruncate(f,l) ftruncate64(f,l)
77 #endif
78 
79 typedef struct stat struct_stat;
80 
81 struct apr_file_t {
82     apr_pool_t *pool;
83     int filedes;
84     char *fname;
85     apr_int32_t flags;
86     int eof_hit;
87     int is_pipe;
88     apr_interval_time_t timeout;
89     int buffered;
90     enum {BLK_UNKNOWN, BLK_OFF, BLK_ON } blocking;
91     int ungetchar;    /* Last char provided by an unget op. (-1 = no char)*/
92 
93     /* if there is a timeout set, then this pollset is used */
94     apr_pollset_t *pollset;
95 
96     /* Stuff for buffered mode */
97     char *buffer;
98     int bufpos;               /* Read/Write position in buffer */
99     apr_off_t dataRead;   /* amount of valid data read into buffer */
100     int direction;            /* buffer being used for 0 = read, 1 = write */
101     apr_off_t filePtr;    /* position in file of handle */
102 #if APR_HAS_THREADS
103     struct apr_thread_mutex_t *thlock;
104 #endif
105 };
106 
107 struct apr_dir_t {
108     apr_pool_t *pool;
109     char *dirname;
110     DIR *dirstruct;
111     struct dirent *entry;
112 };
113 
114 typedef struct apr_stat_entry_t apr_stat_entry_t;
115 
116 struct apr_stat_entry_t {
117     struct stat info;
118     char *casedName;
119     apr_time_t expire;
120     NXPathCtx_t pathCtx;
121 };
122 
123 #define MAX_SERVER_NAME     64
124 #define MAX_VOLUME_NAME     64
125 #define MAX_PATH_NAME       256
126 #define MAX_FILE_NAME       256
127 
128 #define DRIVE_ONLY          1
129 
130 /* If the user passes d: vs. D: (or //mach/share vs. //MACH/SHARE),
131  * we need to fold the case to canonical form.  This function is
132  * supposed to do so.
133  */
134 apr_status_t filepath_root_case(char **rootpath, char *root, apr_pool_t *p);
135 
136 /* This function check to see of the given path includes a drive/volume
137  * specifier.  If the _only_ parameter is set to DRIVE_ONLY then it
138  * check to see of the path only contains a drive/volume specifier and
139  * nothing else.
140  */
141 apr_status_t filepath_has_drive(const char *rootpath, int only, apr_pool_t *p);
142 
143 /* This function compares the drive/volume specifiers for each given path.
144  * It returns zero if they match or non-zero if not.
145  */
146 apr_status_t filepath_compare_drive(const char *path1, const char *path2, apr_pool_t *p);
147 
148 apr_status_t apr_unix_file_cleanup(void *);
149 
150 #endif  /* ! FILE_IO_H */
151 
152