NeoMutt  2024-03-23-142-g2b2e76
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
file.h
Go to the documentation of this file.
1
24#ifndef MUTT_MUTT_FILE_H
25#define MUTT_MUTT_FILE_H
26
27#include "config.h"
28#include <dirent.h>
29#include <stdbool.h>
30#include <stdint.h>
31#include <stdio.h>
32#include <sys/types.h>
33
34struct Buffer;
35struct stat;
36extern const char FilenameSafeChars[];
37
38/* Flags for mutt_file_read_line() */
39typedef uint8_t ReadLineFlags;
40#define MUTT_RL_NO_FLAGS 0
41#define MUTT_RL_CONT (1 << 0)
42#define MUTT_RL_EOL (1 << 1)
43
44#ifdef HAVE_STRUCT_TIMESPEC
45struct timespec;
46#else
51{
52 time_t tv_sec;
53 long tv_nsec;
54};
55#endif
56
63{
67};
68
73{
76};
77
82{
83 char *line;
84 size_t size;
86};
87
99typedef bool (*mutt_file_map_t)(char *line, int line_num, void *user_data);
100
101int mutt_file_check_empty(const char *path);
102int mutt_file_chmod_add(const char *path, mode_t mode);
103int mutt_file_chmod_add_stat(const char *path, mode_t mode, struct stat *st);
104int mutt_file_chmod_rm_stat(const char *path, mode_t mode, struct stat *st);
105int mutt_file_copy_bytes(FILE *fp_in, FILE *fp_out, size_t size);
106int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out);
107time_t mutt_file_decrease_mtime(const char *fp, struct stat *st);
108void mutt_file_expand_fmt(struct Buffer *dest, const char *fmt, const char *src);
109void mutt_file_expand_fmt_quote(char *dest, size_t destlen, const char *fmt, const char *src);
110int mutt_file_fclose_full(FILE **fp, const char *file, int line, const char *func);
111FILE * mutt_file_fopen_full(const char *path, const char *mode, const char *file, int line, const char *func);
112int mutt_file_fsync_close(FILE **fp);
113long mutt_file_get_size(const char *path);
114long mutt_file_get_size_fp(FILE* fp);
115void mutt_file_get_stat_timespec(struct timespec *dest, struct stat *st, enum MuttStatType type);
116bool mutt_file_iter_line(struct MuttFileIter *iter, FILE *fp, ReadLineFlags flags);
117int mutt_file_lock(int fd, bool excl, bool timeout);
118bool mutt_file_map_lines(mutt_file_map_t func, void *user_data, FILE *fp, ReadLineFlags flags);
119int mutt_file_mkdir(const char *path, mode_t mode);
120int mutt_file_open(const char *path, uint32_t flags);
121DIR * mutt_file_opendir(const char *path, enum MuttOpenDirMode mode);
122char * mutt_file_read_keyword(const char *file, char *buf, size_t buflen);
123char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags);
124int mutt_file_rename(const char *oldfile, const char *newfile);
125int mutt_file_rmtree(const char *path);
126const char *mutt_file_rotate(const char *path, int num);
127int mutt_file_safe_rename(const char *src, const char *target);
128void mutt_file_sanitize_filename(char *path, bool slash);
129int mutt_file_sanitize_regex(struct Buffer *dest, const char *src);
130size_t mutt_file_save_str(FILE *fp, const char *str);
131bool mutt_file_seek(FILE *fp, LOFF_T offset, int whence);
132void mutt_file_set_mtime(const char *from, const char *to);
133int mutt_file_stat_compare(struct stat *st1, enum MuttStatType st1_type, struct stat *st2, enum MuttStatType st2_type);
134int mutt_file_stat_timespec_compare(struct stat *st, enum MuttStatType type, struct timespec *b);
135int mutt_file_symlink(const char *oldpath, const char *newpath);
136int mutt_file_timespec_compare(struct timespec *a, struct timespec *b);
137void mutt_file_touch_atime(int fd);
138void mutt_file_unlink(const char *s);
139void mutt_file_unlink_empty(const char *path);
140int mutt_file_unlock(int fd);
141void mutt_file_resolve_symlink(struct Buffer *buf);
142
143void buf_quote_filename(struct Buffer *buf, const char *filename, bool add_outer);
144void buf_file_expand_fmt_quote(struct Buffer *dest, const char *fmt, const char *src);
145
146#define mutt_file_fopen(PATH, MODE) mutt_file_fopen_full(PATH, MODE, __FILE__, __LINE__, __func__)
147#define mutt_file_fclose(FP) mutt_file_fclose_full(FP, __FILE__, __LINE__, __func__)
148
149#endif /* MUTT_MUTT_FILE_H */
void mutt_file_get_stat_timespec(struct timespec *dest, struct stat *st, enum MuttStatType type)
Read the stat() time into a time value.
Definition: file.c:1576
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition: file.c:286
void buf_quote_filename(struct Buffer *buf, const char *filename, bool add_outer)
Quote a filename to survive the shell's quoting rules.
Definition: file.c:930
FILE * mutt_file_fopen_full(const char *path, const char *mode, const char *file, int line, const char *func)
Call fopen() safely.
Definition: file.c:663
int mutt_file_open(const char *path, uint32_t flags)
Open a file.
Definition: file.c:575
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags)
Read a line from a file.
Definition: file.c:805
int mutt_file_safe_rename(const char *src, const char *target)
NFS-safe renaming of files.
Definition: file.c:370
void mutt_file_unlink_empty(const char *path)
Delete a file if it's empty.
Definition: file.c:1332
const char FilenameSafeChars[]
Set of characters <=0x7F that are safe to use in filenames.
Definition: file.c:70
MuttOpenDirMode
Mode flag for mutt_file_opendir()
Definition: file.h:73
@ MUTT_OPENDIR_CREATE
Create the directory if it doesn't exist.
Definition: file.h:75
@ MUTT_OPENDIR_NONE
Plain opendir()
Definition: file.h:74
int mutt_file_stat_compare(struct stat *st1, enum MuttStatType st1_type, struct stat *st2, enum MuttStatType st2_type)
Compare two stat infos.
Definition: file.c:1638
int mutt_file_copy_bytes(FILE *fp_in, FILE *fp_out, size_t size)
Copy some content from one file to another.
Definition: file.c:256
char * mutt_file_read_keyword(const char *file, char *buf, size_t buflen)
Read a keyword from a file.
Definition: file.c:1403
void buf_file_expand_fmt_quote(struct Buffer *dest, const char *fmt, const char *src)
Replace s in a string with a filename.
Definition: file.c:1453
void mutt_file_touch_atime(int fd)
Set the access time to current time.
Definition: file.c:1088
int mutt_file_sanitize_regex(struct Buffer *dest, const char *src)
Escape any regex-magic characters in a string.
Definition: file.c:751
int mutt_file_check_empty(const char *path)
Is the mailbox empty.
Definition: file.c:1433
int mutt_file_mkdir(const char *path, mode_t mode)
Recursively create directories.
Definition: file.c:971
int mutt_file_lock(int fd, bool excl, bool timeout)
(Try to) Lock a file using fcntl()
Definition: file.c:1199
long mutt_file_get_size_fp(FILE *fp)
Get the size of a file.
Definition: file.c:1534
void mutt_file_sanitize_filename(char *path, bool slash)
Replace unsafe characters in a filename.
Definition: file.c:709
int mutt_file_timespec_compare(struct timespec *a, struct timespec *b)
Compare to time values.
Definition: file.c:1554
int mutt_file_unlock(int fd)
Unlock a file previously locked by mutt_file_lock()
Definition: file.c:1246
time_t mutt_file_decrease_mtime(const char *fp, struct stat *st)
Decrease a file's modification time by 1 second.
Definition: file.c:1025
bool mutt_file_map_lines(mutt_file_map_t func, void *user_data, FILE *fp, ReadLineFlags flags)
Process lines of text read from a file pointer.
Definition: file.c:907
DIR * mutt_file_opendir(const char *path, enum MuttOpenDirMode mode)
Open a directory.
Definition: file.c:640
bool mutt_file_seek(FILE *fp, LOFF_T offset, int whence)
Wrapper for fseeko with error handling.
Definition: file.c:775
int mutt_file_fclose_full(FILE **fp, const char *file, int line, const char *func)
Close a FILE handle (and NULL the pointer)
Definition: file.c:164
long mutt_file_get_size(const char *path)
Get the size of a file.
Definition: file.c:1516
int mutt_file_rename(const char *oldfile, const char *newfile)
Rename a file.
Definition: file.c:1368
bool mutt_file_iter_line(struct MuttFileIter *iter, FILE *fp, ReadLineFlags flags)
Iterate over the lines from an open file pointer.
Definition: file.c:886
void mutt_file_expand_fmt_quote(char *dest, size_t destlen, const char *fmt, const char *src)
const char * mutt_file_rotate(const char *path, int num)
Rotate a set of numbered files.
Definition: file.c:545
int mutt_file_symlink(const char *oldpath, const char *newpath)
Create a symlink.
Definition: file.c:314
int mutt_file_chmod_add_stat(const char *path, mode_t mode, struct stat *st)
Add permissions to a file.
Definition: file.c:1136
bool(* mutt_file_map_t)(char *line, int line_num, void *user_data)
Definition: file.h:99
void mutt_file_expand_fmt(struct Buffer *dest, const char *fmt, const char *src)
Replace s in a string with a filename.
Definition: file.c:1468
void mutt_file_resolve_symlink(struct Buffer *buf)
Resolve a symlink in place.
Definition: file.c:1656
void mutt_file_set_mtime(const char *from, const char *to)
Set the modification time of one file from another.
Definition: file.c:1065
int mutt_file_stat_timespec_compare(struct stat *st, enum MuttStatType type, struct timespec *b)
Compare stat info with a time value.
Definition: file.c:1616
MuttStatType
Flags for mutt_file_get_stat_timespec.
Definition: file.h:63
@ MUTT_STAT_CTIME
File/dir's ctime - creation time.
Definition: file.h:66
@ MUTT_STAT_ATIME
File/dir's atime - last accessed time.
Definition: file.h:64
@ MUTT_STAT_MTIME
File/dir's mtime - last modified time.
Definition: file.h:65
uint8_t ReadLineFlags
Flags for mutt_file_read_line(), e.g. MUTT_RL_CONT.
Definition: file.h:39
int mutt_file_chmod_add(const char *path, mode_t mode)
Add permissions to a file.
Definition: file.c:1113
void mutt_file_unlink(const char *s)
Delete a file, carefully.
Definition: file.c:220
int mutt_file_fsync_close(FILE **fp)
Flush the data, before closing a file (and NULL the pointer)
Definition: file.c:192
int mutt_file_rmtree(const char *path)
Recursively remove a directory.
Definition: file.c:485
size_t mutt_file_save_str(FILE *fp, const char *str)
Save a string to a file.
Definition: file.c:1676
int mutt_file_chmod_rm_stat(const char *path, mode_t mode, struct stat *st)
Remove permissions from a file.
Definition: file.c:1170
String manipulation buffer.
Definition: buffer.h:36
State record for mutt_file_iter_line()
Definition: file.h:82
char * line
the line data
Definition: file.h:83
int line_num
line number
Definition: file.h:85
size_t size
allocated size of line data
Definition: file.h:84
Time value with nanosecond precision.
Definition: file.h:51
long tv_nsec
Number of nanosecond, on top.
Definition: file.h:53
time_t tv_sec
Number of seconds since the epoch.
Definition: file.h:52