00001 /* Licensed to the Apache Software Foundation (ASF) under one or more 00002 * contributor license agreements. See the NOTICE file distributed with 00003 * this work for additional information regarding copyright ownership. 00004 * The ASF licenses this file to You under the Apache License, Version 2.0 00005 * (the "License"); you may not use this file except in compliance with 00006 * the License. You may obtain a copy of the License at 00007 * 00008 * http://www.apache.org/licenses/LICENSE-2.0 00009 * 00010 * Unless required by applicable law or agreed to in writing, software 00011 * distributed under the License is distributed on an "AS IS" BASIS, 00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 * See the License for the specific language governing permissions and 00014 * limitations under the License. 00015 */ 00016 00017 #ifndef APR_FILE_IO_H 00018 #define APR_FILE_IO_H 00019 00020 /** 00021 * @file apr_file_io.h 00022 * @brief APR File I/O Handling 00023 */ 00024 00025 #include "apr.h" 00026 #include "apr_pools.h" 00027 #include "apr_time.h" 00028 #include "apr_errno.h" 00029 #include "apr_file_info.h" 00030 #include "apr_inherit.h" 00031 00032 #define APR_WANT_STDIO /**< for SEEK_* */ 00033 #define APR_WANT_IOVEC /**< for apr_file_writev */ 00034 #include "apr_want.h" 00035 00036 #ifdef __cplusplus 00037 extern "C" { 00038 #endif /* __cplusplus */ 00039 00040 /** 00041 * @defgroup apr_file_io File I/O Handling Functions 00042 * @ingroup APR 00043 * @{ 00044 */ 00045 00046 /** 00047 * @defgroup apr_file_open_flags File Open Flags/Routines 00048 * @{ 00049 */ 00050 00051 /* Note to implementors: Values in the range 0x00100000--0x80000000 00052 are reserved for platform-specific values. */ 00053 00054 #define APR_FOPEN_READ 0x00001 /**< Open the file for reading */ 00055 #define APR_FOPEN_WRITE 0x00002 /**< Open the file for writing */ 00056 #define APR_FOPEN_CREATE 0x00004 /**< Create the file if not there */ 00057 #define APR_FOPEN_APPEND 0x00008 /**< Append to the end of the file */ 00058 #define APR_FOPEN_TRUNCATE 0x00010 /**< Open the file and truncate 00059 to 0 length */ 00060 #define APR_FOPEN_BINARY 0x00020 /**< Open the file in binary mode */ 00061 #define APR_FOPEN_EXCL 0x00040 /**< Open should fail if APR_CREATE 00062 and file exists. */ 00063 #define APR_FOPEN_BUFFERED 0x00080 /**< Open the file for buffered I/O */ 00064 #define APR_FOPEN_DELONCLOSE 0x00100 /**< Delete the file after close */ 00065 #define APR_FOPEN_XTHREAD 0x00200 /**< Platform dependent tag to open 00066 the file for use across multiple 00067 threads */ 00068 #define APR_FOPEN_SHARELOCK 0x00400 /**< Platform dependent support for 00069 higher level locked read/write 00070 access to support writes across 00071 process/machines */ 00072 #define APR_FOPEN_NOCLEANUP 0x00800 /**< Do not register a cleanup 00073 when the file is opened */ 00074 #define APR_FOPEN_SENDFILE_ENABLED 0x01000 /**< Advisory flag that this 00075 file should support 00076 apr_socket_sendfile operation */ 00077 #define APR_FOPEN_LARGEFILE 0x04000 /**< Platform dependent flag to enable 00078 * large file support, see WARNING below 00079 */ 00080 #define APR_FOPEN_SPARSE 0x08000 /**< Platform dependent flag to enable 00081 * sparse file support, see WARNING below 00082 */ 00083 00084 /* backcompat */ 00085 #define APR_READ APR_FOPEN_READ /**< @deprecated @see APR_FOPEN_READ */ 00086 #define APR_WRITE APR_FOPEN_WRITE /**< @deprecated @see APR_FOPEN_WRITE */ 00087 #define APR_CREATE APR_FOPEN_CREATE /**< @deprecated @see APR_FOPEN_CREATE */ 00088 #define APR_APPEND APR_FOPEN_APPEND /**< @deprecated @see APR_FOPEN_APPEND */ 00089 #define APR_TRUNCATE APR_FOPEN_TRUNCATE /**< @deprecated @see APR_FOPEN_TRUNCATE */ 00090 #define APR_BINARY APR_FOPEN_BINARY /**< @deprecated @see APR_FOPEN_BINARY */ 00091 #define APR_EXCL APR_FOPEN_EXCL /**< @deprecated @see APR_FOPEN_EXCL */ 00092 #define APR_BUFFERED APR_FOPEN_BUFFERED /**< @deprecated @see APR_FOPEN_BUFFERED */ 00093 #define APR_DELONCLOSE APR_FOPEN_DELONCLOSE /**< @deprecated @see APR_FOPEN_DELONCLOSE */ 00094 #define APR_XTHREAD APR_FOPEN_XTHREAD /**< @deprecated @see APR_FOPEN_XTHREAD */ 00095 #define APR_SHARELOCK APR_FOPEN_SHARELOCK /**< @deprecated @see APR_FOPEN_SHARELOCK */ 00096 #define APR_FILE_NOCLEANUP APR_FOPEN_NOCLEANUP /**< @deprecated @see APR_FOPEN_NOCLEANUP */ 00097 #define APR_SENDFILE_ENABLED APR_FOPEN_SENDFILE_ENABLED /**< @deprecated @see APR_FOPEN_SENDFILE_ENABLED */ 00098 #define APR_LARGEFILE APR_FOPEN_LARGEFILE /**< @deprecated @see APR_FOPEN_LARGEFILE */ 00099 00100 /** @warning APR_FOPEN_LARGEFILE flag only has effect on some 00101 * platforms where sizeof(apr_off_t) == 4. Where implemented, it 00102 * allows opening and writing to a file which exceeds the size which 00103 * can be represented by apr_off_t (2 gigabytes). When a file's size 00104 * does exceed 2Gb, apr_file_info_get() will fail with an error on the 00105 * descriptor, likewise apr_stat()/apr_lstat() will fail on the 00106 * filename. apr_dir_read() will fail with APR_INCOMPLETE on a 00107 * directory entry for a large file depending on the particular 00108 * APR_FINFO_* flags. Generally, it is not recommended to use this 00109 * flag. 00110 * 00111 * @warning APR_FOPEN_SPARSE may, depending on platform, convert a 00112 * normal file to a sparse file. Some applications may be unable 00113 * to decipher a sparse file, so it's critical that the sparse file 00114 * flag should only be used for files accessed only by APR or other 00115 * applications known to be able to decipher them. APR does not 00116 * guarentee that it will compress the file into sparse segments 00117 * if it was previously created and written without the sparse flag. 00118 * On platforms which do not understand, or on file systems which 00119 * cannot handle sparse files, the flag is ignored by apr_file_open(). 00120 */ 00121 00122 /** @} */ 00123 00124 /** 00125 * @defgroup apr_file_seek_flags File Seek Flags 00126 * @{ 00127 */ 00128 00129 /* flags for apr_file_seek */ 00130 /** Set the file position */ 00131 #define APR_SET SEEK_SET 00132 /** Current */ 00133 #define APR_CUR SEEK_CUR 00134 /** Go to end of file */ 00135 #define APR_END SEEK_END 00136 /** @} */ 00137 00138 /** 00139 * @defgroup apr_file_attrs_set_flags File Attribute Flags 00140 * @{ 00141 */ 00142 00143 /* flags for apr_file_attrs_set */ 00144 #define APR_FILE_ATTR_READONLY 0x01 /**< File is read-only */ 00145 #define APR_FILE_ATTR_EXECUTABLE 0x02 /**< File is executable */ 00146 #define APR_FILE_ATTR_HIDDEN 0x04 /**< File is hidden */ 00147 /** @} */ 00148 00149 /** 00150 * @defgroup apr_file_writev{_full} max iovec size 00151 * @{ 00152 */ 00153 #if defined(DOXYGEN) 00154 #define APR_MAX_IOVEC_SIZE 1024 /**< System dependent maximum 00155 size of an iovec array */ 00156 #elif defined(IOV_MAX) 00157 #define APR_MAX_IOVEC_SIZE IOV_MAX 00158 #elif defined(MAX_IOVEC) 00159 #define APR_MAX_IOVEC_SIZE MAX_IOVEC 00160 #else 00161 #define APR_MAX_IOVEC_SIZE 1024 00162 #endif 00163 /** @} */ 00164 00165 /** File attributes */ 00166 typedef apr_uint32_t apr_fileattrs_t; 00167 00168 /** Type to pass as whence argument to apr_file_seek. */ 00169 typedef int apr_seek_where_t; 00170 00171 /** 00172 * Structure for referencing files. 00173 */ 00174 typedef struct apr_file_t apr_file_t; 00175 00176 /* File lock types/flags */ 00177 /** 00178 * @defgroup apr_file_lock_types File Lock Types 00179 * @{ 00180 */ 00181 00182 #define APR_FLOCK_SHARED 1 /**< Shared lock. More than one process 00183 or thread can hold a shared lock 00184 at any given time. Essentially, 00185 this is a "read lock", preventing 00186 writers from establishing an 00187 exclusive lock. */ 00188 #define APR_FLOCK_EXCLUSIVE 2 /**< Exclusive lock. Only one process 00189 may hold an exclusive lock at any 00190 given time. This is analogous to 00191 a "write lock". */ 00192 00193 #define APR_FLOCK_TYPEMASK 0x000F /**< mask to extract lock type */ 00194 #define APR_FLOCK_NONBLOCK 0x0010 /**< do not block while acquiring the 00195 file lock */ 00196 /** @} */ 00197 00198 /** 00199 * Open the specified file. 00200 * @param newf The opened file descriptor. 00201 * @param fname The full path to the file (using / on all systems) 00202 * @param flag Or'ed value of: 00203 * <PRE> 00204 * APR_READ open for reading 00205 * APR_WRITE open for writing 00206 * APR_CREATE create the file if not there 00207 * APR_APPEND file ptr is set to end prior to all writes 00208 * APR_TRUNCATE set length to zero if file exists 00209 * APR_BINARY not a text file (This flag is ignored on 00210 * UNIX because it has no meaning) 00211 * APR_BUFFERED buffer the data. Default is non-buffered 00212 * APR_EXCL return error if APR_CREATE and file exists 00213 * APR_DELONCLOSE delete the file after closing. 00214 * APR_XTHREAD Platform dependent tag to open the file 00215 * for use across multiple threads 00216 * APR_SHARELOCK Platform dependent support for higher 00217 * level locked read/write access to support 00218 * writes across process/machines 00219 * APR_FILE_NOCLEANUP Do not register a cleanup with the pool 00220 * passed in on the <EM>pool</EM> argument (see below). 00221 * The apr_os_file_t handle in apr_file_t will not 00222 * be closed when the pool is destroyed. 00223 * APR_SENDFILE_ENABLED Open with appropriate platform semantics 00224 * for sendfile operations. Advisory only, 00225 * apr_socket_sendfile does not check this flag. 00226 * </PRE> 00227 * @param perm Access permissions for file. 00228 * @param pool The pool to use. 00229 * @remark If perm is APR_OS_DEFAULT and the file is being created, 00230 * appropriate default permissions will be used. 00231 * @remark By default, the returned file descriptor will not be 00232 * inherited by child processes created by apr_proc_create(). This 00233 * can be changed using apr_file_inherit_set(). 00234 */ 00235 APR_DECLARE(apr_status_t) apr_file_open(apr_file_t **newf, const char *fname, 00236 apr_int32_t flag, apr_fileperms_t perm, 00237 apr_pool_t *pool); 00238 00239 /** 00240 * Close the specified file. 00241 * @param file The file descriptor to close. 00242 */ 00243 APR_DECLARE(apr_status_t) apr_file_close(apr_file_t *file); 00244 00245 /** 00246 * Delete the specified file. 00247 * @param path The full path to the file (using / on all systems) 00248 * @param pool The pool to use. 00249 * @remark If the file is open, it won't be removed until all 00250 * instances are closed. 00251 */ 00252 APR_DECLARE(apr_status_t) apr_file_remove(const char *path, apr_pool_t *pool); 00253 00254 /** 00255 * Rename the specified file. 00256 * @param from_path The full path to the original file (using / on all systems) 00257 * @param to_path The full path to the new file (using / on all systems) 00258 * @param pool The pool to use. 00259 * @warning If a file exists at the new location, then it will be 00260 * overwritten. Moving files or directories across devices may not be 00261 * possible. 00262 */ 00263 APR_DECLARE(apr_status_t) apr_file_rename(const char *from_path, 00264 const char *to_path, 00265 apr_pool_t *pool); 00266 00267 /** 00268 * Copy the specified file to another file. 00269 * @param from_path The full path to the original file (using / on all systems) 00270 * @param to_path The full path to the new file (using / on all systems) 00271 * @param perms Access permissions for the new file if it is created. 00272 * In place of the usual or'd combination of file permissions, the 00273 * value APR_FILE_SOURCE_PERMS may be given, in which case the source 00274 * file's permissions are copied. 00275 * @param pool The pool to use. 00276 * @remark The new file does not need to exist, it will be created if required. 00277 * @warning If the new file already exists, its contents will be overwritten. 00278 */ 00279 APR_DECLARE(apr_status_t) apr_file_copy(const char *from_path, 00280 const char *to_path, 00281 apr_fileperms_t perms, 00282 apr_pool_t *pool); 00283 00284 /** 00285 * Append the specified file to another file. 00286 * @param from_path The full path to the source file (use / on all systems) 00287 * @param to_path The full path to the destination file (use / on all systems) 00288 * @param perms Access permissions for the destination file if it is created. 00289 * In place of the usual or'd combination of file permissions, the 00290 * value APR_FILE_SOURCE_PERMS may be given, in which case the source 00291 * file's permissions are copied. 00292 * @param pool The pool to use. 00293 * @remark The new file does not need to exist, it will be created if required. 00294 */ 00295 APR_DECLARE(apr_status_t) apr_file_append(const char *from_path, 00296 const char *to_path, 00297 apr_fileperms_t perms, 00298 apr_pool_t *pool); 00299 00300 /** 00301 * Are we at the end of the file 00302 * @param fptr The apr file we are testing. 00303 * @remark Returns APR_EOF if we are at the end of file, APR_SUCCESS otherwise. 00304 */ 00305 APR_DECLARE(apr_status_t) apr_file_eof(apr_file_t *fptr); 00306 00307 /** 00308 * Open standard error as an apr file pointer. 00309 * @param thefile The apr file to use as stderr. 00310 * @param pool The pool to allocate the file out of. 00311 * 00312 * @remark The only reason that the apr_file_open_std* functions exist 00313 * is that you may not always have a stderr/out/in on Windows. This 00314 * is generally a problem with newer versions of Windows and services. 00315 * 00316 * @remark The other problem is that the C library functions generally work 00317 * differently on Windows and Unix. So, by using apr_file_open_std* 00318 * functions, you can get a handle to an APR struct that works with 00319 * the APR functions which are supposed to work identically on all 00320 * platforms. 00321 */ 00322 APR_DECLARE(apr_status_t) apr_file_open_stderr(apr_file_t **thefile, 00323 apr_pool_t *pool); 00324 00325 /** 00326 * open standard output as an apr file pointer. 00327 * @param thefile The apr file to use as stdout. 00328 * @param pool The pool to allocate the file out of. 00329 * 00330 * @remark See remarks for apr_file_open_stderr. 00331 */ 00332 APR_DECLARE(apr_status_t) apr_file_open_stdout(apr_file_t **thefile, 00333 apr_pool_t *pool); 00334 00335 /** 00336 * open standard input as an apr file pointer. 00337 * @param thefile The apr file to use as stdin. 00338 * @param pool The pool to allocate the file out of. 00339 * 00340 * @remark See remarks for apr_file_open_stderr. 00341 */ 00342 APR_DECLARE(apr_status_t) apr_file_open_stdin(apr_file_t **thefile, 00343 apr_pool_t *pool); 00344 00345 /** 00346 * open standard error as an apr file pointer, with flags. 00347 * @param thefile The apr file to use as stderr. 00348 * @param flags The flags to open the file with. Only the APR_EXCL, 00349 * APR_BUFFERED, APR_XTHREAD, APR_SHARELOCK, 00350 * APR_SENDFILE_ENABLED and APR_LARGEFILE flags should 00351 * be used. The APR_WRITE flag will be set unconditionally. 00352 * @param pool The pool to allocate the file out of. 00353 * 00354 * @remark See remarks for apr_file_open_stderr. 00355 */ 00356 APR_DECLARE(apr_status_t) apr_file_open_flags_stderr(apr_file_t **thefile, 00357 apr_int32_t flags, 00358 apr_pool_t *pool); 00359 00360 /** 00361 * open standard output as an apr file pointer, with flags. 00362 * @param thefile The apr file to use as stdout. 00363 * @param flags The flags to open the file with. Only the APR_EXCL, 00364 * APR_BUFFERED, APR_XTHREAD, APR_SHARELOCK, 00365 * APR_SENDFILE_ENABLED and APR_LARGEFILE flags should 00366 * be used. The APR_WRITE flag will be set unconditionally. 00367 * @param pool The pool to allocate the file out of. 00368 * 00369 * @remark See remarks for apr_file_open_stderr. 00370 */ 00371 APR_DECLARE(apr_status_t) apr_file_open_flags_stdout(apr_file_t **thefile, 00372 apr_int32_t flags, 00373 apr_pool_t *pool); 00374 00375 /** 00376 * open standard input as an apr file pointer, with flags. 00377 * @param thefile The apr file to use as stdin. 00378 * @param flags The flags to open the file with. Only the APR_EXCL, 00379 * APR_BUFFERED, APR_XTHREAD, APR_SHARELOCK, 00380 * APR_SENDFILE_ENABLED and APR_LARGEFILE flags should 00381 * be used. The APR_READ flag will be set unconditionally. 00382 * @param pool The pool to allocate the file out of. 00383 * 00384 * @remark See remarks for apr_file_open_stderr. 00385 */ 00386 APR_DECLARE(apr_status_t) apr_file_open_flags_stdin(apr_file_t **thefile, 00387 apr_int32_t flags, 00388 apr_pool_t *pool); 00389 00390 /** 00391 * Read data from the specified file. 00392 * @param thefile The file descriptor to read from. 00393 * @param buf The buffer to store the data to. 00394 * @param nbytes On entry, the number of bytes to read; on exit, the number 00395 * of bytes read. 00396 * 00397 * @remark apr_file_read will read up to the specified number of 00398 * bytes, but never more. If there isn't enough data to fill that 00399 * number of bytes, all of the available data is read. The third 00400 * argument is modified to reflect the number of bytes read. If a 00401 * char was put back into the stream via ungetc, it will be the first 00402 * character returned. 00403 * 00404 * @remark It is not possible for both bytes to be read and an APR_EOF 00405 * or other error to be returned. APR_EINTR is never returned. 00406 */ 00407 APR_DECLARE(apr_status_t) apr_file_read(apr_file_t *thefile, void *buf, 00408 apr_size_t *nbytes); 00409 00410 /** 00411 * Write data to the specified file. 00412 * @param thefile The file descriptor to write to. 00413 * @param buf The buffer which contains the data. 00414 * @param nbytes On entry, the number of bytes to write; on exit, the number 00415 * of bytes written. 00416 * 00417 * @remark apr_file_write will write up to the specified number of 00418 * bytes, but never more. If the OS cannot write that many bytes, it 00419 * will write as many as it can. The third argument is modified to 00420 * reflect the * number of bytes written. 00421 * 00422 * @remark It is possible for both bytes to be written and an error to 00423 * be returned. APR_EINTR is never returned. 00424 */ 00425 APR_DECLARE(apr_status_t) apr_file_write(apr_file_t *thefile, const void *buf, 00426 apr_size_t *nbytes); 00427 00428 /** 00429 * Write data from iovec array to the specified file. 00430 * @param thefile The file descriptor to write to. 00431 * @param vec The array from which to get the data to write to the file. 00432 * @param nvec The number of elements in the struct iovec array. This must 00433 * be smaller than APR_MAX_IOVEC_SIZE. If it isn't, the function 00434 * will fail with APR_EINVAL. 00435 * @param nbytes The number of bytes written. 00436 * 00437 * @remark It is possible for both bytes to be written and an error to 00438 * be returned. APR_EINTR is never returned. 00439 * 00440 * @remark apr_file_writev is available even if the underlying 00441 * operating system doesn't provide writev(). 00442 */ 00443 APR_DECLARE(apr_status_t) apr_file_writev(apr_file_t *thefile, 00444 const struct iovec *vec, 00445 apr_size_t nvec, apr_size_t *nbytes); 00446 00447 /** 00448 * Read data from the specified file, ensuring that the buffer is filled 00449 * before returning. 00450 * @param thefile The file descriptor to read from. 00451 * @param buf The buffer to store the data to. 00452 * @param nbytes The number of bytes to read. 00453 * @param bytes_read If non-NULL, this will contain the number of bytes read. 00454 * 00455 * @remark apr_file_read will read up to the specified number of 00456 * bytes, but never more. If there isn't enough data to fill that 00457 * number of bytes, then the process/thread will block until it is 00458 * available or EOF is reached. If a char was put back into the 00459 * stream via ungetc, it will be the first character returned. 00460 * 00461 * @remark It is possible for both bytes to be read and an error to be 00462 * returned. And if *bytes_read is less than nbytes, an accompanying 00463 * error is _always_ returned. 00464 * 00465 * @remark APR_EINTR is never returned. 00466 */ 00467 APR_DECLARE(apr_status_t) apr_file_read_full(apr_file_t *thefile, void *buf, 00468 apr_size_t nbytes, 00469 apr_size_t *bytes_read); 00470 00471 /** 00472 * Write data to the specified file, ensuring that all of the data is 00473 * written before returning. 00474 * @param thefile The file descriptor to write to. 00475 * @param buf The buffer which contains the data. 00476 * @param nbytes The number of bytes to write. 00477 * @param bytes_written If non-NULL, set to the number of bytes written. 00478 * 00479 * @remark apr_file_write will write up to the specified number of 00480 * bytes, but never more. If the OS cannot write that many bytes, the 00481 * process/thread will block until they can be written. Exceptional 00482 * error such as "out of space" or "pipe closed" will terminate with 00483 * an error. 00484 * 00485 * @remark It is possible for both bytes to be written and an error to 00486 * be returned. And if *bytes_written is less than nbytes, an 00487 * accompanying error is _always_ returned. 00488 * 00489 * @remark APR_EINTR is never returned. 00490 */ 00491 APR_DECLARE(apr_status_t) apr_file_write_full(apr_file_t *thefile, 00492 const void *buf, 00493 apr_size_t nbytes, 00494 apr_size_t *bytes_written); 00495 00496 00497 /** 00498 * Write data from iovec array to the specified file, ensuring that all of the 00499 * data is written before returning. 00500 * @param thefile The file descriptor to write to. 00501 * @param vec The array from which to get the data to write to the file. 00502 * @param nvec The number of elements in the struct iovec array. This must 00503 * be smaller than APR_MAX_IOVEC_SIZE. If it isn't, the function 00504 * will fail with APR_EINVAL. 00505 * @param nbytes The number of bytes written. 00506 * 00507 * @remark apr_file_writev_full is available even if the underlying 00508 * operating system doesn't provide writev(). 00509 */ 00510 APR_DECLARE(apr_status_t) apr_file_writev_full(apr_file_t *thefile, 00511 const struct iovec *vec, 00512 apr_size_t nvec, 00513 apr_size_t *nbytes); 00514 /** 00515 * Write a character into the specified file. 00516 * @param ch The character to write. 00517 * @param thefile The file descriptor to write to 00518 */ 00519 APR_DECLARE(apr_status_t) apr_file_putc(char ch, apr_file_t *thefile); 00520 00521 /** 00522 * Read a character from the specified file. 00523 * @param ch The character to read into 00524 * @param thefile The file descriptor to read from 00525 */ 00526 APR_DECLARE(apr_status_t) apr_file_getc(char *ch, apr_file_t *thefile); 00527 00528 /** 00529 * Put a character back onto a specified stream. 00530 * @param ch The character to write. 00531 * @param thefile The file descriptor to write to 00532 */ 00533 APR_DECLARE(apr_status_t) apr_file_ungetc(char ch, apr_file_t *thefile); 00534 00535 /** 00536 * Read a string from the specified file. 00537 * @param str The buffer to store the string in. 00538 * @param len The length of the string 00539 * @param thefile The file descriptor to read from 00540 * @remark The buffer will be NUL-terminated if any characters are stored. 00541 */ 00542 APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, 00543 apr_file_t *thefile); 00544 00545 /** 00546 * Write the string into the specified file. 00547 * @param str The string to write. 00548 * @param thefile The file descriptor to write to 00549 */ 00550 APR_DECLARE(apr_status_t) apr_file_puts(const char *str, apr_file_t *thefile); 00551 00552 /** 00553 * Flush the file's buffer. 00554 * @param thefile The file descriptor to flush 00555 */ 00556 APR_DECLARE(apr_status_t) apr_file_flush(apr_file_t *thefile); 00557 00558 /** 00559 * Duplicate the specified file descriptor. 00560 * @param new_file The structure to duplicate into. 00561 * @param old_file The file to duplicate. 00562 * @param p The pool to use for the new file. 00563 * @remark *new_file must point to a valid apr_file_t, or point to NULL. 00564 */ 00565 APR_DECLARE(apr_status_t) apr_file_dup(apr_file_t **new_file, 00566 apr_file_t *old_file, 00567 apr_pool_t *p); 00568 00569 /** 00570 * Duplicate the specified file descriptor and close the original 00571 * @param new_file The old file that is to be closed and reused 00572 * @param old_file The file to duplicate 00573 * @param p The pool to use for the new file 00574 * 00575 * @remark new_file MUST point at a valid apr_file_t. It cannot be NULL. 00576 */ 00577 APR_DECLARE(apr_status_t) apr_file_dup2(apr_file_t *new_file, 00578 apr_file_t *old_file, 00579 apr_pool_t *p); 00580 00581 /** 00582 * Move the specified file descriptor to a new pool 00583 * @param new_file Pointer in which to return the new apr_file_t 00584 * @param old_file The file to move 00585 * @param p The pool to which the descriptor is to be moved 00586 * @remark Unlike apr_file_dup2(), this function doesn't do an 00587 * OS dup() operation on the underlying descriptor; it just 00588 * moves the descriptor's apr_file_t wrapper to a new pool. 00589 * @remark The new pool need not be an ancestor of old_file's pool. 00590 * @remark After calling this function, old_file may not be used 00591 */ 00592 APR_DECLARE(apr_status_t) apr_file_setaside(apr_file_t **new_file, 00593 apr_file_t *old_file, 00594 apr_pool_t *p); 00595 00596 /** 00597 * Give the specified apr file handle a new buffer 00598 * @param thefile The file handle that is to be modified 00599 * @param buffer The buffer 00600 * @param bufsize The size of the buffer 00601 * @remark It is possible to add a buffer to previously unbuffered 00602 * file handles, the APR_BUFFERED flag will be added to 00603 * the file handle's flags. Likewise, with buffer=NULL and 00604 * bufsize=0 arguments it is possible to make a previously 00605 * buffered file handle unbuffered. 00606 */ 00607 APR_DECLARE(apr_status_t) apr_file_buffer_set(apr_file_t *thefile, 00608 char * buffer, 00609 apr_size_t bufsize); 00610 00611 /** 00612 * Get the size of any buffer for the specified apr file handle 00613 * @param thefile The file handle 00614 */ 00615 APR_DECLARE(apr_size_t) apr_file_buffer_size_get(apr_file_t *thefile); 00616 00617 /** 00618 * Move the read/write file offset to a specified byte within a file. 00619 * @param thefile The file descriptor 00620 * @param where How to move the pointer, one of: 00621 * <PRE> 00622 * APR_SET -- set the offset to offset 00623 * APR_CUR -- add the offset to the current position 00624 * APR_END -- add the offset to the current file size 00625 * </PRE> 00626 * @param offset The offset to move the pointer to. 00627 * @remark The third argument is modified to be the offset the pointer 00628 was actually moved to. 00629 */ 00630 APR_DECLARE(apr_status_t) apr_file_seek(apr_file_t *thefile, 00631 apr_seek_where_t where, 00632 apr_off_t *offset); 00633 00634 /** 00635 * Create an anonymous pipe. 00636 * @param in The newly created pipe's file for reading. 00637 * @param out The newly created pipe's file for writing. 00638 * @param pool The pool to operate on. 00639 * @remark By default, the returned file descriptors will be inherited 00640 * by child processes created using apr_proc_create(). This can be 00641 * changed using apr_file_inherit_unset(). 00642 * @bug Some platforms cannot toggle between blocking and nonblocking, 00643 * and when passing a pipe as a standard handle to an application which 00644 * does not expect it, a non-blocking stream will fluxor the client app. 00645 * @deprecated @see apr_file_pipe_create_ex 00646 */ 00647 APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, 00648 apr_file_t **out, 00649 apr_pool_t *pool); 00650 00651 /** 00652 * Create an anonymous pipe which portably supports async timeout options. 00653 * @param in The newly created pipe's file for reading. 00654 * @param out The newly created pipe's file for writing. 00655 * @param blocking one of these values defined in apr_thread_proc.h; 00656 * <pre> 00657 * APR_FULL_BLOCK 00658 * APR_READ_BLOCK 00659 * APR_WRITE_BLOCK 00660 * APR_FULL_NONBLOCK 00661 * </pre> 00662 * @remark By default, the returned file descriptors will be inherited 00663 * by child processes created using apr_proc_create(). This can be 00664 * changed using apr_file_inherit_unset(). 00665 * @remark Some platforms cannot toggle between blocking and nonblocking, 00666 * and when passing a pipe as a standard handle to an application which 00667 * does not expect it, a non-blocking stream will fluxor the client app. 00668 * Use this function rather than apr_file_pipe_create to create pipes 00669 * where one or both ends require non-blocking semantics. 00670 */ 00671 APR_DECLARE(apr_status_t) apr_file_pipe_create_ex(apr_file_t **in, 00672 apr_file_t **out, 00673 apr_int32_t blocking, 00674 apr_pool_t *p); 00675 00676 /** 00677 * Create a named pipe. 00678 * @param filename The filename of the named pipe 00679 * @param perm The permissions for the newly created pipe. 00680 * @param pool The pool to operate on. 00681 */ 00682 APR_DECLARE(apr_status_t) apr_file_namedpipe_create(const char *filename, 00683 apr_fileperms_t perm, 00684 apr_pool_t *pool); 00685 00686 /** 00687 * Get the timeout value for a pipe or manipulate the blocking state. 00688 * @param thepipe The pipe we are getting a timeout for. 00689 * @param timeout The current timeout value in microseconds. 00690 */ 00691 APR_DECLARE(apr_status_t) apr_file_pipe_timeout_get(apr_file_t *thepipe, 00692 apr_interval_time_t *timeout); 00693 00694 /** 00695 * Set the timeout value for a pipe or manipulate the blocking state. 00696 * @param thepipe The pipe we are setting a timeout on. 00697 * @param timeout The timeout value in microseconds. Values < 0 mean wait 00698 * forever, 0 means do not wait at all. 00699 */ 00700 APR_DECLARE(apr_status_t) apr_file_pipe_timeout_set(apr_file_t *thepipe, 00701 apr_interval_time_t timeout); 00702 00703 /** file (un)locking functions. */ 00704 00705 /** 00706 * Establish a lock on the specified, open file. The lock may be advisory 00707 * or mandatory, at the discretion of the platform. The lock applies to 00708 * the file as a whole, rather than a specific range. Locks are established 00709 * on a per-thread/process basis; a second lock by the same thread will not 00710 * block. 00711 * @param thefile The file to lock. 00712 * @param type The type of lock to establish on the file. 00713 */ 00714 APR_DECLARE(apr_status_t) apr_file_lock(apr_file_t *thefile, int type); 00715 00716 /** 00717 * Remove any outstanding locks on the file. 00718 * @param thefile The file to unlock. 00719 */ 00720 APR_DECLARE(apr_status_t) apr_file_unlock(apr_file_t *thefile); 00721 00722 /**accessor and general file_io functions. */ 00723 00724 /** 00725 * return the file name of the current file. 00726 * @param new_path The path of the file. 00727 * @param thefile The currently open file. 00728 */ 00729 APR_DECLARE(apr_status_t) apr_file_name_get(const char **new_path, 00730 apr_file_t *thefile); 00731 00732 /** 00733 * Return the data associated with the current file. 00734 * @param data The user data associated with the file. 00735 * @param key The key to use for retreiving data associated with this file. 00736 * @param file The currently open file. 00737 */ 00738 APR_DECLARE(apr_status_t) apr_file_data_get(void **data, const char *key, 00739 apr_file_t *file); 00740 00741 /** 00742 * Set the data associated with the current file. 00743 * @param file The currently open file. 00744 * @param data The user data to associate with the file. 00745 * @param key The key to use for assocaiteing data with the file. 00746 * @param cleanup The cleanup routine to use when the file is destroyed. 00747 */ 00748 APR_DECLARE(apr_status_t) apr_file_data_set(apr_file_t *file, void *data, 00749 const char *key, 00750 apr_status_t (*cleanup)(void *)); 00751 00752 /** 00753 * Write a string to a file using a printf format. 00754 * @param fptr The file to write to. 00755 * @param format The format string 00756 * @param ... The values to substitute in the format string 00757 * @return The number of bytes written 00758 */ 00759 APR_DECLARE_NONSTD(int) apr_file_printf(apr_file_t *fptr, 00760 const char *format, ...) 00761 __attribute__((format(printf,2,3))); 00762 00763 /** 00764 * set the specified file's permission bits. 00765 * @param fname The file (name) to apply the permissions to. 00766 * @param perms The permission bits to apply to the file. 00767 * 00768 * @warning Some platforms may not be able to apply all of the 00769 * available permission bits; APR_INCOMPLETE will be returned if some 00770 * permissions are specified which could not be set. 00771 * 00772 * @warning Platforms which do not implement this feature will return 00773 * APR_ENOTIMPL. 00774 */ 00775 APR_DECLARE(apr_status_t) apr_file_perms_set(const char *fname, 00776 apr_fileperms_t perms); 00777 00778 /** 00779 * Set attributes of the specified file. 00780 * @param fname The full path to the file (using / on all systems) 00781 * @param attributes Or'd combination of 00782 * <PRE> 00783 * APR_FILE_ATTR_READONLY - make the file readonly 00784 * APR_FILE_ATTR_EXECUTABLE - make the file executable 00785 * APR_FILE_ATTR_HIDDEN - make the file hidden 00786 * </PRE> 00787 * @param attr_mask Mask of valid bits in attributes. 00788 * @param pool the pool to use. 00789 * @remark This function should be used in preference to explict manipulation 00790 * of the file permissions, because the operations to provide these 00791 * attributes are platform specific and may involve more than simply 00792 * setting permission bits. 00793 * @warning Platforms which do not implement this feature will return 00794 * APR_ENOTIMPL. 00795 */ 00796 APR_DECLARE(apr_status_t) apr_file_attrs_set(const char *fname, 00797 apr_fileattrs_t attributes, 00798 apr_fileattrs_t attr_mask, 00799 apr_pool_t *pool); 00800 00801 /** 00802 * Set the mtime of the specified file. 00803 * @param fname The full path to the file (using / on all systems) 00804 * @param mtime The mtime to apply to the file. 00805 * @param pool The pool to use. 00806 * @warning Platforms which do not implement this feature will return 00807 * APR_ENOTIMPL. 00808 */ 00809 APR_DECLARE(apr_status_t) apr_file_mtime_set(const char *fname, 00810 apr_time_t mtime, 00811 apr_pool_t *pool); 00812 00813 /** 00814 * Create a new directory on the file system. 00815 * @param path the path for the directory to be created. (use / on all systems) 00816 * @param perm Permissions for the new direcoty. 00817 * @param pool the pool to use. 00818 */ 00819 APR_DECLARE(apr_status_t) apr_dir_make(const char *path, apr_fileperms_t perm, 00820 apr_pool_t *pool); 00821 00822 /** Creates a new directory on the file system, but behaves like 00823 * 'mkdir -p'. Creates intermediate directories as required. No error 00824 * will be reported if PATH already exists. 00825 * @param path the path for the directory to be created. (use / on all systems) 00826 * @param perm Permissions for the new direcoty. 00827 * @param pool the pool to use. 00828 */ 00829 APR_DECLARE(apr_status_t) apr_dir_make_recursive(const char *path, 00830 apr_fileperms_t perm, 00831 apr_pool_t *pool); 00832 00833 /** 00834 * Remove directory from the file system. 00835 * @param path the path for the directory to be removed. (use / on all systems) 00836 * @param pool the pool to use. 00837 * @remark Removing a directory which is in-use (e.g., the current working 00838 * directory, or during apr_dir_read, or with an open file) is not portable. 00839 */ 00840 APR_DECLARE(apr_status_t) apr_dir_remove(const char *path, apr_pool_t *pool); 00841 00842 /** 00843 * get the specified file's stats. 00844 * @param finfo Where to store the information about the file. 00845 * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values 00846 * @param thefile The file to get information about. 00847 */ 00848 APR_DECLARE(apr_status_t) apr_file_info_get(apr_finfo_t *finfo, 00849 apr_int32_t wanted, 00850 apr_file_t *thefile); 00851 00852 00853 /** 00854 * Truncate the file's length to the specified offset 00855 * @param fp The file to truncate 00856 * @param offset The offset to truncate to. 00857 * @remark The read/write file offset is repositioned to offset. 00858 */ 00859 APR_DECLARE(apr_status_t) apr_file_trunc(apr_file_t *fp, apr_off_t offset); 00860 00861 /** 00862 * Retrieve the flags that were passed into apr_file_open() 00863 * when the file was opened. 00864 * @return apr_int32_t the flags 00865 */ 00866 APR_DECLARE(apr_int32_t) apr_file_flags_get(apr_file_t *f); 00867 00868 /** 00869 * Get the pool used by the file. 00870 */ 00871 APR_POOL_DECLARE_ACCESSOR(file); 00872 00873 /** 00874 * Set a file to be inherited by child processes. 00875 * 00876 */ 00877 APR_DECLARE_INHERIT_SET(file); 00878 00879 /** 00880 * Unset a file from being inherited by child processes. 00881 */ 00882 APR_DECLARE_INHERIT_UNSET(file); 00883 00884 /** 00885 * Open a temporary file 00886 * @param fp The apr file to use as a temporary file. 00887 * @param templ The template to use when creating a temp file. 00888 * @param flags The flags to open the file with. If this is zero, 00889 * the file is opened with 00890 * APR_CREATE | APR_READ | APR_WRITE | APR_EXCL | APR_DELONCLOSE 00891 * @param p The pool to allocate the file out of. 00892 * @remark 00893 * This function generates a unique temporary file name from template. 00894 * The last six characters of template must be XXXXXX and these are replaced 00895 * with a string that makes the filename unique. Since it will be modified, 00896 * template must not be a string constant, but should be declared as a character 00897 * array. 00898 * 00899 */ 00900 APR_DECLARE(apr_status_t) apr_file_mktemp(apr_file_t **fp, char *templ, 00901 apr_int32_t flags, apr_pool_t *p); 00902 00903 00904 /** 00905 * Find an existing directory suitable as a temporary storage location. 00906 * @param temp_dir The temp directory. 00907 * @param p The pool to use for any necessary allocations. 00908 * @remark 00909 * This function uses an algorithm to search for a directory that an 00910 * an application can use for temporary storage. Once such a 00911 * directory is found, that location is cached by the library. Thus, 00912 * callers only pay the cost of this algorithm once if that one time 00913 * is successful. 00914 * 00915 */ 00916 APR_DECLARE(apr_status_t) apr_temp_dir_get(const char **temp_dir, 00917 apr_pool_t *p); 00918 00919 /** @} */ 00920 00921 #ifdef __cplusplus 00922 } 00923 #endif 00924 00925 #endif /* ! APR_FILE_IO_H */