From 1a63374e73dc7b8a97c17529974c9f0352edfd8d Mon Sep 17 00:00:00 2001 From: Daniel Spiljar Date: Wed, 18 Sep 2024 23:48:21 +0200 Subject: [PATCH 1/5] Move file locking code to a separate function. Failure to lock a file is now fatal. --- src/mbox.c | 64 ++++++++++++++++++++++++++++-------------------------- src/mbox.h | 3 ++- 2 files changed, 35 insertions(+), 32 deletions(-) diff --git a/src/mbox.c b/src/mbox.c index 9151c05..21571f4 100644 --- a/src/mbox.c +++ b/src/mbox.c @@ -1,6 +1,6 @@ /* mboxgrep - scan mailbox for messages matching a regular expression - Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2023 Daniel Spiljar + Copyright (C) 2000 - 2004, 2006, 2023 - 2024 Daniel Spiljar Mboxgrep is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -90,36 +90,7 @@ mbox_open (const char *path, const char *mode) } if (config.lock > LOCK_NONE) - { -#ifdef HAVE_FLOCK - int op; - - if (mode[0] == 'r') - op = LOCK_SH; - else - op = LOCK_EX; - if (-1 == flock (fd, op)) -#else - memset (&lck, 0, sizeof (struct flock)); - lck.l_whence = SEEK_SET; - if (mode[0] == 'r') - lck.l_type = F_RDLCK; - else - lck.l_type = F_WRLCK; - - if (-1 == fcntl (fd, F_SETLK, &lck)) -#endif /* HAVE_FLOCK */ - { - if (config.merr) - { - fprintf (stderr, "%s: %s: ", APPNAME, path); - perror (NULL); - } - errno = 0; - close (fd); - return NULL; - } - } + mbox_lock (fd, path, mode); if (mode[0] == 'r') { @@ -431,3 +402,34 @@ tmpfile_create (void) } return fd; } + +void +mbox_lock (int fd, const char *path, const char *mode) +{ +#ifdef HAVE_FLOCK + int op; + + if (mode[0] == 'r') + op = LOCK_SH; + else + op = LOCK_EX; + if (-1 == flock (fd, op)) +#else + memset (&lck, 0, sizeof (struct flock)); + lck.l_whence = SEEK_SET; + if (mode[0] == 'r') + lck.l_type = F_RDLCK; + else + lck.l_type = F_WRLCK; + + if (-1 == fcntl (fd, F_SETLK, &lck)) +#endif /* HAVE_FLOCK */ + { + if (config.merr) + { + fprintf (stderr, "%s: %s: ", APPNAME, path); + perror (NULL); + exit (2); + } + } +} diff --git a/src/mbox.h b/src/mbox.h index 098b40a..e739180 100644 --- a/src/mbox.h +++ b/src/mbox.h @@ -1,6 +1,6 @@ /* mboxgrep - scan mailbox for messages matching a regular expression - Copyright (C) 2000 - 2004, 2023 Daniel Spiljar + Copyright (C) 2000 - 2004, 2023 - 2024 Daniel Spiljar Mboxgrep is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -40,5 +40,6 @@ int tmpfile_create (void); void mbox_close (mbox_t * mbp); message_t *mbox_read_message (mbox_t * mp); void mbox_write_message (message_t * m, mbox_t * mbox); +void mbox_lock (int fd, const char *path, const char *mode); #endif /* MBOX_H */ From b30f2f236271257ef8e0fb65d3eb4a4cc792d910 Mon Sep 17 00:00:00 2001 From: Daniel Spiljar Date: Thu, 19 Sep 2024 00:24:21 +0200 Subject: [PATCH 2/5] Suppress "Not an mbox folder" error messages on empty files. --- src/mbox.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/mbox.c b/src/mbox.c index 21571f4..32b2bfc 100644 --- a/src/mbox.c +++ b/src/mbox.c @@ -132,6 +132,8 @@ mbox_open (const char *path, const char *mode) } } + memset (buffer, 0, BUFSIZ); + if (mode[0] == 'r') { if (config.format == FORMAT_MBOX) @@ -158,13 +160,13 @@ mbox_open (const char *path, const char *mode) if (0 != strncmp ("From ", buffer, 5)) { - if (config.merr) + if ((config.merr) && (buffer[0] != '\0')) { if (0 == strcmp ("-", path)) - fprintf (stderr, "%s: (standard input): Not a mbox folder\n", + fprintf (stderr, "%s: (standard input): Not an mbox folder\n", APPNAME); else - fprintf (stderr, "%s: %s: Not a mbox folder\n", APPNAME, + fprintf (stderr, "%s: %s: Not an mbox folder\n", APPNAME, path); } if (config.format == FORMAT_MBOX) From bd64536e891932cdddbd2071471985354c8f4995 Mon Sep 17 00:00:00 2001 From: Daniel Spiljar Date: Thu, 19 Sep 2024 22:40:20 +0200 Subject: [PATCH 3/5] Function prototype Use an enum type instead of a string to define the file opening mode. --- src/main.c | 4 ++-- src/mbox.c | 24 +++++++++--------------- src/mbox.h | 12 ++++++++---- src/scan.c | 6 +++--- 4 files changed, 22 insertions(+), 24 deletions(-) diff --git a/src/main.c b/src/main.c index 81bdba3..26c4a0b 100644 --- a/src/main.c +++ b/src/main.c @@ -1,6 +1,6 @@ /* mboxgrep - scan mailbox for messages matching a regular expression - Copyright (C) 2000 - 2004, 2006, 2023 Daniel Spiljar + Copyright (C) 2000 - 2004, 2006, 2023 - 2024 Daniel Spiljar Mboxgrep is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -117,7 +117,7 @@ main (int argc, char **argv) if (config.action == ACTION_DELETE) { tmpmbox_create (argv[optind]); - runtime.tmp_mbox = (mbox_t *) mbox_open (config.tmpfilename, "w"); + runtime.tmp_mbox = (mbox_t *) mbox_open (config.tmpfilename, w); } config.boxname = xstrdup (argv[optind]); diff --git a/src/mbox.c b/src/mbox.c index 32b2bfc..ba119ed 100644 --- a/src/mbox.c +++ b/src/mbox.c @@ -50,7 +50,7 @@ #endif /* HAVE_LIBDMALLOC */ mbox_t * -mbox_open (const char *path, const char *mode) +mbox_open (const char *path, const mbox_mode_t mbox_mode) { mbox_t *mp; static int fd; @@ -66,17 +66,11 @@ mbox_open (const char *path, const char *mode) mp->fp = stdin; else { - if (mode[0] == 'r') - fd = m_open (path, O_RDONLY, 0); - else if (mode[0] == 'w') + if (mbox_mode == w) fd = m_open (path, (O_WRONLY | O_CREAT | O_APPEND), (S_IWUSR | S_IRUSR)); else - { - fprintf (stderr, "%s: mbox.c: Unknown mode %c. You shouldn't " - "get this error...", APPNAME, mode[0]); - exit (2); - } + fd = m_open (path, O_RDONLY, 0); if (fd == -1) { @@ -90,9 +84,9 @@ mbox_open (const char *path, const char *mode) } if (config.lock > LOCK_NONE) - mbox_lock (fd, path, mode); + mbox_lock (fd, path, mbox_mode); - if (mode[0] == 'r') + if (mbox_mode == r) { if (config.format == FORMAT_MBOX) mp->fp = (FILE *) m_fdopen (fd, "r"); @@ -105,7 +99,7 @@ mbox_open (const char *path, const char *mode) mp->fp = (BZFILE *) BZ2_bzdopen (fd, "rb"); #endif /* HAVE_LIBBZ2 */ } - else if (mode[0] == 'w') + else if (mbox_mode == w) { if (config.format == FORMAT_MBOX) mp->fp = (FILE *) m_fdopen (fd, "w"); @@ -134,7 +128,7 @@ mbox_open (const char *path, const char *mode) memset (buffer, 0, BUFSIZ); - if (mode[0] == 'r') + if (mbox_mode == r) { if (config.format == FORMAT_MBOX) fgets (buffer, BUFSIZ, mp->fp); @@ -406,12 +400,12 @@ tmpfile_create (void) } void -mbox_lock (int fd, const char *path, const char *mode) +mbox_lock (int fd, const char *path, const mbox_mode_t mbox_mode) { #ifdef HAVE_FLOCK int op; - if (mode[0] == 'r') + if (mbox_mode == r) op = LOCK_SH; else op = LOCK_EX; diff --git a/src/mbox.h b/src/mbox.h index e739180..4776383 100644 --- a/src/mbox.h +++ b/src/mbox.h @@ -19,9 +19,7 @@ #ifndef MBOX_H # define MBOX_H 1 - # include - # include "message.h" typedef struct @@ -31,8 +29,14 @@ typedef struct char *postmark_cache; } mbox_t; +typedef enum +{ + r, + w, +} mbox_mode_t; -mbox_t *mbox_open (const char *path, const char *mode); + +mbox_t *mbox_open (const char *path, const mbox_mode_t mbox_mode); void tmpmbox_create (const char *path); void tmpfile_name (const char *path); void tmpfile_mod_own (const int fd, const char *path); @@ -40,6 +44,6 @@ int tmpfile_create (void); void mbox_close (mbox_t * mbp); message_t *mbox_read_message (mbox_t * mp); void mbox_write_message (message_t * m, mbox_t * mbox); -void mbox_lock (int fd, const char *path, const char *mode); +void mbox_lock (int fd, const char *path, const mbox_mode_t mbox_mode); #endif /* MBOX_H */ diff --git a/src/scan.c b/src/scan.c index 85f19f9..69ff4fd 100644 --- a/src/scan.c +++ b/src/scan.c @@ -1,6 +1,6 @@ /* mboxgrep - scan mailbox for messages matching a regular expression - Copyright (C) 2000 - 2004, 2006, 2023 Daniel Spiljar + Copyright (C) 2000 - 2004, 2006, 2023 - 2024 Daniel Spiljar Mboxgrep is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -107,7 +107,7 @@ scan_mailbox (char path[]) if ((config.format == FORMAT_MBOX) || (config.format == FORMAT_ZMBOX) || (config.format == FORMAT_BZ2MBOX)) { - mbox = (mbox_t *) mbox_open (path, "r"); + mbox = (mbox_t *) mbox_open (path, r); if (mbox == NULL) return; } @@ -179,7 +179,7 @@ scan_mailbox (char path[]) else if ((config.format == FORMAT_MBOX) || (config.format == FORMAT_ZMBOX) || (config.format == FORMAT_BZ2MBOX)) { - out = mbox_open (config.outboxname, "w"); + out = mbox_open (config.outboxname, w); /* fprintf (out->fp, "%s\n%s", msg->headers, msg->body); */ mbox_write_message (msg, out); mbox_close (out); From 631998a849961103452debc3edb8eecc13f31fce Mon Sep 17 00:00:00 2001 From: Daniel Spiljar Date: Fri, 20 Sep 2024 13:11:06 +0200 Subject: [PATCH 4/5] Code refactoring Partial refactor of mbox_open(). Opening of file descripts has been moved to mbox_fdopen(). --- src/mbox.c | 81 +++++++++++++++++++++++++----------------------------- src/mbox.h | 1 + 2 files changed, 39 insertions(+), 43 deletions(-) diff --git a/src/mbox.c b/src/mbox.c index ba119ed..7501f3f 100644 --- a/src/mbox.c +++ b/src/mbox.c @@ -74,11 +74,6 @@ mbox_open (const char *path, const mbox_mode_t mbox_mode) if (fd == -1) { - if (config.merr) - { - fprintf (stderr, "%s: %s: ", APPNAME, path); - perror (NULL); - } errno = 0; return NULL; } @@ -86,44 +81,7 @@ mbox_open (const char *path, const mbox_mode_t mbox_mode) if (config.lock > LOCK_NONE) mbox_lock (fd, path, mbox_mode); - if (mbox_mode == r) - { - if (config.format == FORMAT_MBOX) - mp->fp = (FILE *) m_fdopen (fd, "r"); -#ifdef HAVE_LIBZ - else if (config.format == FORMAT_ZMBOX) - mp->fp = (gzFile *) m_gzdopen (fd, "rb"); -#endif /* HAVE_LIBZ */ -#ifdef HAVE_LIBBZ2 - else if (config.format == FORMAT_BZ2MBOX) - mp->fp = (BZFILE *) BZ2_bzdopen (fd, "rb"); -#endif /* HAVE_LIBBZ2 */ - } - else if (mbox_mode == w) - { - if (config.format == FORMAT_MBOX) - mp->fp = (FILE *) m_fdopen (fd, "w"); -#ifdef HAVE_LIBZ - else if (config.format == FORMAT_ZMBOX) - mp->fp = (gzFile *) m_gzdopen (fd, "wb"); -#endif /* HAVE_LIBZ */ -#ifdef HAVE_LIBBZ2 - else if (config.format == FORMAT_BZ2MBOX) - mp->fp = (BZFILE *) BZ2_bzdopen (fd, "wb"); -#endif /* HAVE_LIBBZ2 */ - } - - if (mp->fp == NULL) - { - if (config.merr) - { - fprintf (stderr, "%s: %s: ", APPNAME, path); - perror (NULL); - } - errno = 0; - close (fd); - return NULL; - } + mp->fp = mbox_fdopen (fd, path, mbox_mode); } memset (buffer, 0, BUFSIZ); @@ -429,3 +387,40 @@ mbox_lock (int fd, const char *path, const mbox_mode_t mbox_mode) } } } + +void * +mbox_fdopen (int fd, const char *path, const mbox_mode_t mbox_mode) +{ + void *f; + char *file_mode; + + if (mbox_mode == w) + file_mode = xstrdup("wb"); + else + file_mode = xstrdup("rb"); + + if (config.format == FORMAT_MBOX) + f = (FILE *) m_fdopen (fd, file_mode); +#ifdef HAVE_LIBZ + else if (config.format == FORMAT_ZMBOX) + f = (gzFile *) m_gzdopen (fd, file_mode); +#endif /* HAVE_LIBZ */ +#ifdef HAVE_LIBBZ2 + else if (config.format == FORMAT_BZ2MBOX) + f = (BZFILE *) BZ2_bzdopen (fd, file_mode); +#endif /* HAVE_LIBBZ2 */ + + if (f == NULL) + { + if (config.merr) + { + fprintf (stderr, "%s: %s: ", APPNAME, path); + perror (NULL); + } + errno = 0; + close (fd); + return NULL; + } + + return f; +} diff --git a/src/mbox.h b/src/mbox.h index 4776383..05b04ba 100644 --- a/src/mbox.h +++ b/src/mbox.h @@ -45,5 +45,6 @@ void mbox_close (mbox_t * mbp); message_t *mbox_read_message (mbox_t * mp); void mbox_write_message (message_t * m, mbox_t * mbox); void mbox_lock (int fd, const char *path, const mbox_mode_t mbox_mode); +void *mbox_fdopen (int fd, const char *path, const mbox_mode_t mbox_mode); #endif /* MBOX_H */ From a790494133a303150efb39a2888fe9dd2dc282cd Mon Sep 17 00:00:00 2001 From: Daniel Spiljar Date: Fri, 20 Sep 2024 22:18:30 +0200 Subject: [PATCH 5/5] Code refactoring Refactor of mbox_open(). Checking for a "postmark" line, i.e. whether the file is an mbox mailbox, has been moved to mbox_check_postmark(). --- src/mbox.c | 110 +++++++++++++++++++++++++++++------------------------ src/mbox.h | 1 + 2 files changed, 62 insertions(+), 49 deletions(-) diff --git a/src/mbox.c b/src/mbox.c index 7501f3f..aef612b 100644 --- a/src/mbox.c +++ b/src/mbox.c @@ -57,10 +57,9 @@ mbox_open (const char *path, const mbox_mode_t mbox_mode) #ifndef HAVE_FLOCK struct flock lck; #endif /* HAVE_FLOCK */ - char buffer[BUFSIZ]; mp = (mbox_t *) xmalloc (sizeof (mbox_t)); - mp->postmark_cache = (char *) xmalloc (BUFSIZ * sizeof (char)); + mp->postmark_cache = NULL; if (0 == strcmp ("-", path)) mp->fp = stdin; @@ -84,57 +83,14 @@ mbox_open (const char *path, const mbox_mode_t mbox_mode) mp->fp = mbox_fdopen (fd, path, mbox_mode); } - memset (buffer, 0, BUFSIZ); - if (mbox_mode == r) { - if (config.format == FORMAT_MBOX) - fgets (buffer, BUFSIZ, mp->fp); -#ifdef HAVE_LIBZ - else if (config.format == FORMAT_ZMBOX) - gzgets (mp->fp, buffer, BUFSIZ); -#endif /* HAVE_LIBZ */ -#ifdef HAVE_LIBBZ2 - else if (config.format == FORMAT_BZ2MBOX) - { - char c[1] = "\0"; - int n = 0; + mp->postmark_cache = mbox_check_postmark (mp, path); - while (c[0] != '\n' && n < BUFSIZ) - { - BZ2_bzread (mp->fp, c, 1); - buffer[n] = c[0]; - n++; - } - buffer[n] = '\0'; - } -#endif /* HAVE_LIBBZ2 */ - - if (0 != strncmp ("From ", buffer, 5)) - { - if ((config.merr) && (buffer[0] != '\0')) - { - if (0 == strcmp ("-", path)) - fprintf (stderr, "%s: (standard input): Not an mbox folder\n", - APPNAME); - else - fprintf (stderr, "%s: %s: Not an mbox folder\n", APPNAME, - path); - } - if (config.format == FORMAT_MBOX) - fclose (mp->fp); -#ifdef HAVE_LIBZ - else if (config.format == FORMAT_ZMBOX) - gzclose (mp->fp); -#endif /* HAVE_LIBZ */ -#ifdef HAVE_LIBBZ2 - else if (config.format == FORMAT_BZ2MBOX) - BZ2_bzclose (mp->fp); -#endif /* HAVE_LIBBZ2 */ - return NULL; - } - strcpy (mp->postmark_cache, buffer); + if (! mp->postmark_cache) + return NULL; } + return mp; } @@ -424,3 +380,59 @@ mbox_fdopen (int fd, const char *path, const mbox_mode_t mbox_mode) return f; } + +char * +mbox_check_postmark(mbox_t *mp, const char *path) +{ + char *buffer; + + buffer = (char *) xmalloc (BUFSIZ * sizeof (char)); + memset (buffer, 0, BUFSIZ); + + if (config.format == FORMAT_MBOX) + fgets (buffer, BUFSIZ, mp->fp); +#ifdef HAVE_LIBZ + else if (config.format == FORMAT_ZMBOX) + gzgets (mp->fp, buffer, BUFSIZ); +#endif /* HAVE_LIBZ */ +#ifdef HAVE_LIBBZ2 + else if (config.format == FORMAT_BZ2MBOX) + { + char c[1] = "\0"; + int n = 0; + + while (c[0] != '\n' && n < BUFSIZ) + { + BZ2_bzread (mp->fp, c, 1); + buffer[n] = c[0]; + n++; + } + buffer[n] = '\0'; + } +#endif /* HAVE_LIBBZ2 */ + + if (0 != strncmp ("From ", buffer, 5)) + { + if ((config.merr) && (buffer[0] != '\0')) + { + if (0 == strcmp ("-", path)) + fprintf (stderr, "%s: (standard input): Not an mbox folder\n", + APPNAME); + else + fprintf (stderr, "%s: %s: Not an mbox folder\n", APPNAME, + path); + } + if (config.format == FORMAT_MBOX) + fclose (mp->fp); +#ifdef HAVE_LIBZ + else if (config.format == FORMAT_ZMBOX) + gzclose (mp->fp); +#endif /* HAVE_LIBZ */ +#ifdef HAVE_LIBBZ2 + else if (config.format == FORMAT_BZ2MBOX) + BZ2_bzclose (mp->fp); +#endif /* HAVE_LIBBZ2 */ + return NULL; + } + return buffer; +} diff --git a/src/mbox.h b/src/mbox.h index 05b04ba..91accc3 100644 --- a/src/mbox.h +++ b/src/mbox.h @@ -46,5 +46,6 @@ message_t *mbox_read_message (mbox_t * mp); void mbox_write_message (message_t * m, mbox_t * mbox); void mbox_lock (int fd, const char *path, const mbox_mode_t mbox_mode); void *mbox_fdopen (int fd, const char *path, const mbox_mode_t mbox_mode); +char *mbox_check_postmark(mbox_t *mp, const char *path); #endif /* MBOX_H */