summaryrefslogtreecommitdiff
path: root/file_io/unix/fileacc.c
blob: 1acd7130a60598cf4cd7ffc4df9fc6c93bc94b61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/* ====================================================================
 * Copyright (c) 1999 The Apache Group.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the Apache Group
 *    for use in the Apache HTTP server project (http://www.apache.org/)."
 *
 * 4. The names "Apache Server" and "Apache Group" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the Apache Group
 *    for use in the Apache HTTP server project (http://www.apache.org/)."
 *
 * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE APACHE GROUP OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Group.
 * For more information on the Apache Group and the Apache HTTP server
 * project, please see <http://www.apache.org/>.
 *
 */

#include "fileio.h"

/* A file to put ALL of the accessor functions for struct file_t types. */

/* ***APRDOC********************************************************
 * ap_status_t ap_get_filename(char **, ap_file_t *)
 *    return the file name of the current file.
 * arg 1) The currently open file.
 * arg 2) The path of the file.  
 */                     
ap_status_t ap_get_filename(char **new, struct file_t *thefile)
{
    if (thefile != NULL) {
        *new = ap_pstrdup(thefile->cntxt, thefile->fname);
        return APR_SUCCESS;
    }
    else {
        *new = NULL;
        return APR_ENOFILE;
    }
}

mode_t get_fileperms(ap_fileperms_t mode)
{
    mode_t rv = 0;

    if (mode & APR_UREAD)
        rv |= S_IRUSR;
    if (mode & APR_UWRITE)
        rv |= S_IWUSR;
    if (mode & APR_UEXECUTE)
        rv |= S_IXUSR;

    if (mode & APR_GREAD)
        rv |= S_IRGRP;
    if (mode & APR_GWRITE)
        rv |= S_IWGRP;
    if (mode & APR_GEXECUTE)
        rv |= S_IXGRP;

    if (mode & APR_WREAD)
        rv |= S_IROTH;
    if (mode & APR_WWRITE)
        rv |= S_IWOTH;
    if (mode & APR_WEXECUTE)
        rv |= S_IXOTH;

    return rv;
}

/* ***APRDOC********************************************************
 * ap_status_t ap_get_filesize(ap_ssize_t *, ap_file_t *)
 *    Return the size of the current file.
 * arg 1) The currently open file.
 * arg 2) The size of the file.  
 */                     
ap_status_t ap_get_filesize(ap_ssize_t *size, struct file_t *file)
{
    if (file != NULL) {
        if (file->stated == 0) {
            ap_getfileinfo(file);
        }
        *size = file->size;
        return APR_SUCCESS;
    }
    else {
        *size = -1;
        return APR_ENOFILE;
    }
}

/* ***APRDOC********************************************************
 * ap_status_t ap_get_fileperms(ap_fileperms_t *, ap_file_t *)
 *    Return the permissions of the current file.
 * arg 1) The currently open file.
 * arg 2) The permissions of the file.  
 */                     
ap_status_t ap_get_fileperms(ap_fileperms_t *perm, struct file_t *file)
{
    if (file != NULL) {
        if (file->stated == 0) {
            ap_getfileinfo(file);
        }
        *perm = file->protection;
        return APR_SUCCESS;
    }
    else {
        *perm = -1;
        return APR_ENOFILE;
    }
}

/* ***APRDOC********************************************************
 * ap_status_t ap_get_fileatime(time_t *, ap_file_t *)
 *    Return the last access time of the current file.
 * arg 1) The currently open file.
 * arg 2) The last access time of the file.  
 */                     
ap_status_t ap_get_fileatime(time_t *atime, struct file_t *file)
{    
    if (file != NULL) {
        if (file->stated == 0) {
            ap_getfileinfo(file);
        }
        *atime = file->atime;
        return APR_SUCCESS;
    }
    else {
        *atime = -1;
        return APR_ENOFILE;
    }
}

/* ***APRDOC********************************************************
 * ap_status_t ap_get_filectime(time_t *, ap_file_t *)
 *    Return the time of the last change to the current file.
 * arg 1) The currently open file.
 * arg 2) The last change time of the file.  
 */                     
ap_status_t ap_get_filectime(time_t *ptime, struct file_t *file)
{    
    if (file != NULL) {
        if (file->stated == 0) {
            ap_getfileinfo(file);
        }
        *ptime = file->ctime;
        return APR_SUCCESS;
    }
    else {
        *ptime = -1;
        return APR_ENOFILE;
    }
}

/* ***APRDOC********************************************************
 * ap_status_t ap_get_filemtime(time_t *, ap_file_t *)
 *    Return the last modified time of the current file.
 * arg 1) The currently open file.
 * arg 2) The last modified time of the file.  
 */                     
ap_status_t ap_get_filemtime(time_t *mtime, struct file_t *file)
{    
    if (file != NULL) {
        if (file->stated == 0) {
            ap_getfileinfo(file);
        }
        *mtime = file->mtime;
        return APR_SUCCESS;
    }
    else {
        *mtime = -1;
        return APR_ENOFILE;
    }
}

/* ***APRDOC********************************************************
 * ap_status_t ap_get_filetype(ap_filetype_e, ap_file_t *)
 *    Return the type of the current file.
 * arg 1) The currently open file.
 * arg 2) The file type
 */                     
ap_status_t ap_get_filetype(ap_filetype_e *type, struct file_t *file)
{    
    if (file != NULL) {
        if (file->stated == 0) {
            ap_getfileinfo(file);
        }
        if (S_ISREG(file->protection))
            *type = APR_REG;
        if (S_ISDIR(file->protection))
            *type = APR_DIR;
        if (S_ISCHR(file->protection))
            *type = APR_CHR;
        if (S_ISBLK(file->protection))
            *type = APR_BLK;
        if (S_ISFIFO(file->protection))
            *type = APR_PIPE;
        if (S_ISLNK(file->protection))
            *type = APR_LNK;
#ifndef BEOS
        if (S_ISSOCK(file->protection))
            *type = APR_SOCK;
#endif
        return APR_SUCCESS;
    }
    else {
        *type = APR_REG;
        return APR_ENOFILE;
    }
}

/* ***APRDOC********************************************************
 * ap_status_t ap_get_filedata(void **, char *key, ap_file_t *)
 *    Return the data associated with the current file.
 * arg 1) The currently open file.
 * arg 2) The key to use for retreiving data associated with this file.
 * arg 3) The user data associated with the file.  
 */                     
ap_status_t ap_get_filedata(void **data, char *key, struct file_t *file)
{    
    if (file != NULL) {
        return ap_get_userdata(data, key, file->cntxt);
    }
    else {
        data = NULL;
        return APR_ENOFILE;
    }
}

/* ***APRDOC********************************************************
 * ap_status_t ap_set_filedata(ap_file_t *, void *, char *key,
                               ap_status (*cleanup) (void *))
 *    Set the data associated with the current file.
 * arg 1) The currently open file.
 * arg 2) The user data to associate with the file.  
 * arg 3) The key to use for assocaiteing data with the file.
 * arg 4) The cleanup routine to use when the file is destroyed.
 */                     
ap_status_t ap_set_filedata(struct file_t *file, void *data, char *key,
                            ap_status_t (*cleanup) (void *))
{    
    if (file != NULL) {
        return ap_set_userdata(data, key, cleanup, file->cntxt);
    }
    else {
        data = NULL;
        return APR_ENOFILE;
    }
}