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_DEFAULT_BUFSIZE 4096
73/* For backwards compat */
74#define APR_FILE_BUFSIZE APR_FILE_DEFAULT_BUFSIZE
75
76#if APR_HAS_THREADS
77#define file_lock(f)   do { \
78                           if ((f)->thlock) \
79                               apr_thread_mutex_lock((f)->thlock); \
80                       } while (0)
81#define file_unlock(f) do { \
82                           if ((f)->thlock) \
83                               apr_thread_mutex_unlock((f)->thlock); \
84                       } while (0)
85#else
86#define file_lock(f)   do {} while (0)
87#define file_unlock(f) do {} while (0)
88#endif
89
90#if APR_HAS_LARGE_FILES
91#define lseek(f,o,w) lseek64(f,o,w)
92#define ftruncate(f,l) ftruncate64(f,l)
93#endif
94
95typedef struct stat struct_stat;
96
97struct apr_file_t {
98    apr_pool_t *pool;
99    int filedes;
100    char *fname;
101    apr_int32_t flags;
102    int eof_hit;
103    int is_pipe;
104    apr_interval_time_t timeout;
105    int buffered;
106    enum {BLK_UNKNOWN, BLK_OFF, BLK_ON } blocking;
107    int ungetchar;    /* Last char provided by an unget op. (-1 = no char)*/
108
109    /* if there is a timeout set, then this pollset is used */
110    apr_pollset_t *pollset;
111
112    /* Stuff for buffered mode */
113    char *buffer;
114    apr_size_t bufpos;    /* Read/Write position in buffer */
115    apr_size_t bufsize;   /* The buffer size */
116    apr_off_t dataRead;   /* amount of valid data read into buffer */
117    int direction;            /* buffer being used for 0 = read, 1 = write */
118    apr_off_t filePtr;    /* position in file of handle */
119#if APR_HAS_THREADS
120    struct apr_thread_mutex_t *thlock;
121#endif
122};
123
124struct apr_dir_t {
125    apr_pool_t *pool;
126    char *dirname;
127    DIR *dirstruct;
128    struct dirent *entry;
129};
130
131typedef struct apr_stat_entry_t apr_stat_entry_t;
132
133struct apr_stat_entry_t {
134    struct stat info;
135    char *casedName;
136    apr_time_t expire;
137    NXPathCtx_t pathCtx;
138};
139
140#define MAX_SERVER_NAME     64
141#define MAX_VOLUME_NAME     64
142#define MAX_PATH_NAME       256
143#define MAX_FILE_NAME       256
144
145#define DRIVE_ONLY          1
146
147/* If the user passes d: vs. D: (or //mach/share vs. //MACH/SHARE),
148 * we need to fold the case to canonical form.  This function is
149 * supposed to do so.
150 */
151apr_status_t filepath_root_case(char **rootpath, char *root, apr_pool_t *p);
152
153/* This function check to see of the given path includes a drive/volume
154 * specifier.  If the _only_ parameter is set to DRIVE_ONLY then it
155 * check to see of the path only contains a drive/volume specifier and
156 * nothing else.
157 */
158apr_status_t filepath_has_drive(const char *rootpath, int only, apr_pool_t *p);
159
160/* This function compares the drive/volume specifiers for each given path.
161 * It returns zero if they match or non-zero if not.
162 */
163apr_status_t filepath_compare_drive(const char *path1, const char *path2, apr_pool_t *p);
164
165apr_status_t apr_unix_file_cleanup(void *);
166apr_status_t apr_unix_child_file_cleanup(void *);
167
168mode_t apr_unix_perms2mode(apr_fileperms_t perms);
169apr_fileperms_t apr_unix_mode2perms(mode_t mode);
170
171apr_status_t apr_file_flush_locked(apr_file_t *thefile);
172apr_status_t apr_file_info_get_locked(apr_finfo_t *finfo, apr_int32_t wanted,
173                                      apr_file_t *thefile);
174
175#endif  /* ! FILE_IO_H */
176
177