NeoMutt  2024-10-02-34-g9dd811
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
mbox_sync()

Save changes to the Mailbox. More...

+ Collaboration diagram for mbox_sync():

Functions

static enum MxStatus comp_mbox_sync (struct Mailbox *m)
 Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
 
enum MxStatus maildir_mbox_sync (struct Mailbox *m)
 Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
 
static enum MxStatus mbox_mbox_sync (struct Mailbox *m)
 Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
 
static enum MxStatus mh_mbox_sync (struct Mailbox *m)
 Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
 
static enum MxStatus nntp_mbox_sync (struct Mailbox *m)
 Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
 
static enum MxStatus nm_mbox_sync (struct Mailbox *m)
 Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
 
static enum MxStatus pop_mbox_sync (struct Mailbox *m)
 Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
 

Detailed Description

Save changes to the Mailbox.

Parameters
mMailbox to sync
Return values
enumMxStatus
Precondition
m is not NULL

Function Documentation

◆ comp_mbox_sync()

static enum MxStatus comp_mbox_sync ( struct Mailbox m)
static

Save changes to the Mailbox - Implements MxOps::mbox_sync() -.

Changes in NeoMutt only affect the tmp file. Calling comp_mbox_sync() will commit them to the compressed file.

Definition at line 619 of file compress.c.

620{
621 if (!m->compress_info)
622 return MX_STATUS_ERROR;
623
624 struct CompressInfo *ci = m->compress_info;
625
626 if (!ci->cmd_close)
627 {
628 mutt_error(_("Can't sync a compressed file without a close-hook"));
629 return MX_STATUS_ERROR;
630 }
631
632 const struct MxOps *ops = ci->child_ops;
633 if (!ops)
634 return MX_STATUS_ERROR;
635
636 if (!lock_realpath(m, true))
637 {
638 mutt_error(_("Unable to lock mailbox"));
639 return MX_STATUS_ERROR;
640 }
641
642 enum MxStatus check = comp_mbox_check(m);
643 if (check != MX_STATUS_OK)
644 goto sync_cleanup;
645
646 check = ops->mbox_sync(m);
647 if (check != MX_STATUS_OK)
648 goto sync_cleanup;
649
650 if (!execute_command(m, ci->cmd_close, _("Compressing %s")))
651 {
652 check = MX_STATUS_ERROR;
653 goto sync_cleanup;
654 }
655
656 check = MX_STATUS_OK;
657
658sync_cleanup:
659 store_size(m);
661 return check;
662}
static void store_size(const struct Mailbox *m)
Save the size of the compressed file.
Definition: compress.c:202
static bool lock_realpath(struct Mailbox *m, bool excl)
Try to lock the Mailbox.realpath.
Definition: compress.c:107
static void unlock_realpath(struct Mailbox *m)
Unlock the mailbox->realpath.
Definition: compress.c:148
static bool execute_command(struct Mailbox *m, const struct Expando *exp, const char *progress)
Run a system command.
Definition: compress.c:323
#define mutt_error(...)
Definition: logging2.h:92
static enum MxStatus comp_mbox_check(struct Mailbox *m)
Check for new mail - Implements MxOps::mbox_check() -.
Definition: compress.c:583
#define _(a)
Definition: message.h:28
MxStatus
Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()
Definition: mxapi.h:63
@ MX_STATUS_ERROR
An error occurred.
Definition: mxapi.h:64
@ MX_STATUS_OK
No changes.
Definition: mxapi.h:65
Private data for compress.
Definition: lib.h:59
const struct MxOps * child_ops
callbacks of de-compressed file
Definition: lib.h:64
struct Expando * cmd_close
close-hook command
Definition: lib.h:61
void * compress_info
Compressed mbox module private data.
Definition: mailbox.h:121
Definition: mxapi.h:91
enum MxStatus(* mbox_sync)(struct Mailbox *m)
Definition: mxapi.h:187
+ Here is the call graph for this function:

◆ maildir_mbox_sync()

enum MxStatus maildir_mbox_sync ( struct Mailbox m)

Save changes to the Mailbox - Implements MxOps::mbox_sync() -.

Return values
enumMxStatus
Note
The flag retvals come from a call to a backend sync function

Definition at line 838 of file mailbox.c.

839{
840 enum MxStatus check = maildir_check(m);
841 if (check == MX_STATUS_ERROR)
842 return check;
843
844 struct HeaderCache *hc = maildir_hcache_open(m);
845
846 struct Progress *progress = NULL;
847 if (m->verbose)
848 {
850 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
851 }
852
853 for (int i = 0; i < m->msg_count; i++)
854 {
855 progress_update(progress, i, -1);
856
857 struct Email *e = m->emails[i];
858 if (!maildir_sync_mailbox_message(m, e, hc))
859 {
860 progress_free(&progress);
861 goto err;
862 }
863 }
864 progress_free(&progress);
866
867 /* XXX race condition? */
868
870
871 /* adjust indices */
872
873 if (m->msg_deleted)
874 {
875 const bool c_maildir_trash = cs_subset_bool(NeoMutt->sub, "maildir_trash");
876 for (int i = 0, j = 0; i < m->msg_count; i++)
877 {
878 struct Email *e = m->emails[i];
879 if (!e)
880 break;
881
882 if (!e->deleted || c_maildir_trash)
883 e->index = j++;
884 }
885 }
886
887 return check;
888
889err:
891 return MX_STATUS_ERROR;
892}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:223
struct HeaderCache * maildir_hcache_open(struct Mailbox *m)
Open the Header Cache.
Definition: hcache.c:96
void maildir_hcache_close(struct HeaderCache **ptr)
Close the Header Cache.
Definition: hcache.c:69
static enum MxStatus maildir_check(struct Mailbox *m)
Check for new mail.
Definition: mailbox.c:539
void maildir_update_mtime(struct Mailbox *m)
Update our record of the Maildir modification time.
Definition: mailbox.c:716
bool maildir_sync_mailbox_message(struct Mailbox *m, struct Email *e, struct HeaderCache *hc)
Save changes to the mailbox.
Definition: message.c:312
@ MUTT_PROGRESS_WRITE
Progress tracks elements, according to $write_inc
Definition: lib.h:83
struct Progress * progress_new(enum ProgressType type, size_t size)
Create a new Progress Bar.
Definition: progress.c:139
void progress_free(struct Progress **ptr)
Free a Progress Bar.
Definition: progress.c:110
void progress_set_message(struct Progress *progress, const char *fmt,...) __attribute__((__format__(__printf__
bool progress_update(struct Progress *progress, size_t pos, int percent)
Update the state of the progress bar.
Definition: progress.c:80
The envelope/body of an email.
Definition: email.h:39
bool deleted
Email is deleted.
Definition: email.h:78
int index
The absolute (unsorted) message number.
Definition: email.h:110
Header Cache.
Definition: lib.h:86
int msg_count
Total number of messages.
Definition: mailbox.h:88
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
int msg_deleted
Number of deleted messages.
Definition: mailbox.h:93
bool verbose
Display status messages?
Definition: mailbox.h:117
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
+ Here is the call graph for this function:

◆ mbox_mbox_sync()

static enum MxStatus mbox_mbox_sync ( struct Mailbox m)
static

Save changes to the Mailbox - Implements MxOps::mbox_sync() -.

Definition at line 1064 of file mbox.c.

1065{
1067 if (!adata)
1068 return MX_STATUS_ERROR;
1069
1070 struct Buffer *tempfile = NULL;
1071 char buf[32] = { 0 };
1072 int j;
1073 bool unlink_tempfile = false;
1074 bool need_sort = false; /* flag to resort mailbox if new mail arrives */
1075 int first = -1; /* first message to be written */
1076 LOFF_T offset; /* location in mailbox to write changed messages */
1077 struct stat st = { 0 };
1078 struct MUpdate *new_offset = NULL;
1079 struct MUpdate *old_offset = NULL;
1080 FILE *fp = NULL;
1081 struct Progress *progress = NULL;
1082 enum MxStatus rc = MX_STATUS_ERROR;
1083
1084 /* sort message by their position in the mailbox on disk */
1085 const enum SortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
1086 if (c_sort != SORT_ORDER)
1087 {
1088 mutt_sort_order(m);
1089 need_sort = true;
1090 }
1091
1092 /* need to open the file for writing in such a way that it does not truncate
1093 * the file, so use read-write mode. */
1094 adata->fp = freopen(mailbox_path(m), "r+", adata->fp);
1095 if (!adata->fp)
1096 {
1097 mx_fastclose_mailbox(m, false);
1098 mutt_error(_("Fatal error! Could not reopen mailbox!"));
1099 goto fatal;
1100 }
1101
1103
1104 if (mbox_lock_mailbox(m, true, true) == -1)
1105 {
1107 mutt_error(_("Unable to lock mailbox"));
1108 goto bail;
1109 }
1110
1111 /* Check to make sure that the file hasn't changed on disk */
1112 enum MxStatus check = mbox_mbox_check(m);
1113 if ((check == MX_STATUS_NEW_MAIL) || (check == MX_STATUS_REOPENED))
1114 {
1115 /* new mail arrived, or mailbox reopened */
1116 rc = check;
1117 goto bail;
1118 }
1119 else if (check < 0)
1120 {
1121 goto fatal;
1122 }
1123
1124 /* Create a temporary file to write the new version of the mailbox in. */
1125 tempfile = buf_pool_get();
1126 buf_mktemp(tempfile);
1127 int fd = open(buf_string(tempfile), O_WRONLY | O_EXCL | O_CREAT, 0600);
1128 if ((fd == -1) || !(fp = fdopen(fd, "w")))
1129 {
1130 if (fd != -1)
1131 {
1132 close(fd);
1133 unlink_tempfile = true;
1134 }
1135 mutt_error(_("Could not create temporary file"));
1136 goto bail;
1137 }
1138 unlink_tempfile = true;
1139
1140 /* find the first deleted/changed message. we save a lot of time by only
1141 * rewriting the mailbox from the point where it has actually changed. */
1142 int i = 0;
1143 for (; (i < m->msg_count) && !m->emails[i]->deleted &&
1144 !m->emails[i]->changed && !m->emails[i]->attach_del;
1145 i++)
1146 {
1147 }
1148 if (i == m->msg_count)
1149 {
1150 /* this means m->changed or m->msg_deleted was set, but no
1151 * messages were found to be changed or deleted. This should
1152 * never happen, is we presume it is a bug in neomutt. */
1153 mutt_error(_("sync: mbox modified, but no modified messages (report this bug)"));
1154 mutt_debug(LL_DEBUG1, "no modified messages\n");
1155 goto bail;
1156 }
1157
1158 /* save the index of the first changed/deleted message */
1159 first = i;
1160 /* where to start overwriting */
1161 offset = m->emails[i]->offset;
1162
1163 /* the offset stored in the header does not include the MMDF_SEP, so make
1164 * sure we seek to the correct location */
1165 if (m->type == MUTT_MMDF)
1166 offset -= (sizeof(MMDF_SEP) - 1);
1167
1168 /* allocate space for the new offsets */
1169 new_offset = mutt_mem_calloc(m->msg_count - first, sizeof(struct MUpdate));
1170 old_offset = mutt_mem_calloc(m->msg_count - first, sizeof(struct MUpdate));
1171
1172 if (m->verbose)
1173 {
1175 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
1176 }
1177
1178 for (i = first, j = 0; i < m->msg_count; i++)
1179 {
1180 progress_update(progress, i, i / (m->msg_count / 100 + 1));
1181 /* back up some information which is needed to restore offsets when
1182 * something fails. */
1183
1184 old_offset[i - first].valid = true;
1185 old_offset[i - first].hdr = m->emails[i]->offset;
1186 old_offset[i - first].body = m->emails[i]->body->offset;
1187 old_offset[i - first].lines = m->emails[i]->lines;
1188 old_offset[i - first].length = m->emails[i]->body->length;
1189
1190 if (!m->emails[i]->deleted)
1191 {
1192 j++;
1193
1194 if (m->type == MUTT_MMDF)
1195 {
1196 if (fputs(MMDF_SEP, fp) == EOF)
1197 {
1198 mutt_perror("%s", buf_string(tempfile));
1199 goto bail;
1200 }
1201 }
1202
1203 /* save the new offset for this message. we add 'offset' because the
1204 * temporary file only contains saved message which are located after
1205 * 'offset' in the real mailbox */
1206 new_offset[i - first].hdr = ftello(fp) + offset;
1207
1208 struct Message *msg = mx_msg_open(m, m->emails[i]);
1209 const int rc2 = mutt_copy_message(fp, m->emails[i], msg, MUTT_CM_UPDATE,
1211 mx_msg_close(m, &msg);
1212 if (rc2 != 0)
1213 {
1214 mutt_perror("%s", buf_string(tempfile));
1215 goto bail;
1216 }
1217
1218 /* Since messages could have been deleted, the offsets stored in memory
1219 * will be wrong, so update what we can, which is the offset of this
1220 * message, and the offset of the body. If this is a multipart message,
1221 * we just flush the in memory cache so that the message will be reparsed
1222 * if the user accesses it later. */
1223 new_offset[i - first].body = ftello(fp) - m->emails[i]->body->length + offset;
1224 mutt_body_free(&m->emails[i]->body->parts);
1225
1226 if (m->type == MUTT_MMDF)
1227 {
1228 if (fputs(MMDF_SEP, fp) == EOF)
1229 {
1230 mutt_perror("%s", buf_string(tempfile));
1231 goto bail;
1232 }
1233 }
1234 else
1235 {
1236 if (fputs("\n", fp) == EOF)
1237 {
1238 mutt_perror("%s", buf_string(tempfile));
1239 goto bail;
1240 }
1241 }
1242 }
1243 }
1244
1245 if (mutt_file_fclose(&fp) != 0)
1246 {
1247 mutt_debug(LL_DEBUG1, "mutt_file_fclose (&) returned non-zero\n");
1248 mutt_perror("%s", buf_string(tempfile));
1249 goto bail;
1250 }
1251
1252 /* Save the state of this folder. */
1253 if (stat(mailbox_path(m), &st) == -1)
1254 {
1255 mutt_perror("%s", mailbox_path(m));
1256 goto bail;
1257 }
1258
1259 unlink_tempfile = false;
1260
1261 fp = mutt_file_fopen(buf_string(tempfile), "r");
1262 if (!fp)
1263 {
1265 mx_fastclose_mailbox(m, false);
1266 mutt_debug(LL_DEBUG1, "unable to reopen temp copy of mailbox!\n");
1267 mutt_perror("%s", buf_string(tempfile));
1268 FREE(&new_offset);
1269 FREE(&old_offset);
1270 goto fatal;
1271 }
1272
1273 if (!mutt_file_seek(adata->fp, offset, SEEK_SET) || /* seek the append location */
1274 /* do a sanity check to make sure the mailbox looks ok */
1275 !fgets(buf, sizeof(buf), adata->fp) ||
1276 ((m->type == MUTT_MBOX) && !mutt_str_startswith(buf, "From ")) ||
1277 ((m->type == MUTT_MMDF) && !mutt_str_equal(MMDF_SEP, buf)))
1278 {
1279 mutt_debug(LL_DEBUG1, "message not in expected position\n");
1280 mutt_debug(LL_DEBUG1, " LINE: %s\n", buf);
1281 i = -1;
1282 }
1283 else
1284 {
1285 if (!mutt_file_seek(adata->fp, offset, SEEK_SET)) /* return to proper offset */
1286 {
1287 i = -1;
1288 }
1289 else
1290 {
1291 /* copy the temp mailbox back into place starting at the first
1292 * change/deleted message */
1293 if (m->verbose)
1294 mutt_message(_("Committing changes..."));
1295 i = mutt_file_copy_stream(fp, adata->fp);
1296
1297 if (ferror(adata->fp))
1298 i = -1;
1299 }
1300 if (i >= 0)
1301 {
1302 m->size = ftello(adata->fp); /* update the mailbox->size of the mailbox */
1303 if ((m->size < 0) || (ftruncate(fileno(adata->fp), m->size) != 0))
1304 {
1305 i = -1;
1306 mutt_debug(LL_DEBUG1, "ftruncate() failed\n");
1307 }
1308 }
1309 }
1310
1313
1314 if ((mutt_file_fclose(&adata->fp) != 0) || (i == -1))
1315 {
1316 /* error occurred while writing the mailbox back, so keep the temp copy around */
1317
1318 struct Buffer *savefile = buf_pool_get();
1319
1320 const char *const c_tmp_dir = cs_subset_path(NeoMutt->sub, "tmp_dir");
1321 buf_printf(savefile, "%s/neomutt.%s-%s-%u", NONULL(c_tmp_dir),
1322 NONULL(Username), NONULL(ShortHostname), (unsigned int) getpid());
1323 rename(buf_string(tempfile), buf_string(savefile));
1325 mx_fastclose_mailbox(m, false);
1326 buf_pretty_mailbox(savefile);
1327 mutt_error(_("Write failed! Saved partial mailbox to %s"), buf_string(savefile));
1328 buf_pool_release(&savefile);
1329 FREE(&new_offset);
1330 FREE(&old_offset);
1331 goto fatal;
1332 }
1333
1334 /* Restore the previous access/modification times */
1335 mbox_reset_atime(m, &st);
1336
1337 /* reopen the mailbox in read-only mode */
1338 adata->fp = mbox_open_readwrite(m);
1339 if (!adata->fp)
1340 {
1341 adata->fp = mbox_open_readonly(m);
1342 }
1343 if (!adata->fp)
1344 {
1345 unlink(buf_string(tempfile));
1347 mx_fastclose_mailbox(m, false);
1348 mutt_error(_("Fatal error! Could not reopen mailbox!"));
1349 FREE(&new_offset);
1350 FREE(&old_offset);
1351 goto fatal;
1352 }
1353
1354 /* update the offsets of the rewritten messages */
1355 for (i = first, j = first; i < m->msg_count; i++)
1356 {
1357 if (!m->emails[i]->deleted)
1358 {
1359 m->emails[i]->offset = new_offset[i - first].hdr;
1360 m->emails[i]->body->hdr_offset = new_offset[i - first].hdr;
1361 m->emails[i]->body->offset = new_offset[i - first].body;
1362 m->emails[i]->index = j++;
1363 }
1364 }
1365 FREE(&new_offset);
1366 FREE(&old_offset);
1367 unlink(buf_string(tempfile)); /* remove partial copy of the mailbox */
1368 buf_pool_release(&tempfile);
1370
1371 const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
1372 if (c_check_mbox_size)
1373 {
1374 struct Mailbox *m_tmp = mailbox_find(mailbox_path(m));
1375 if (m_tmp && !m_tmp->has_new)
1376 mailbox_update(m_tmp);
1377 }
1378
1379 progress_free(&progress);
1380 return 0; /* signal success */
1381
1382bail: /* Come here in case of disaster */
1383
1384 mutt_file_fclose(&fp);
1385
1386 if (tempfile && unlink_tempfile)
1387 unlink(buf_string(tempfile));
1388
1389 /* restore offsets, as far as they are valid */
1390 if ((first >= 0) && old_offset)
1391 {
1392 for (i = first; (i < m->msg_count) && old_offset[i - first].valid; i++)
1393 {
1394 m->emails[i]->offset = old_offset[i - first].hdr;
1395 m->emails[i]->body->hdr_offset = old_offset[i - first].hdr;
1396 m->emails[i]->body->offset = old_offset[i - first].body;
1397 m->emails[i]->lines = old_offset[i - first].lines;
1398 m->emails[i]->body->length = old_offset[i - first].length;
1399 }
1400 }
1401
1402 /* this is ok to call even if we haven't locked anything */
1404
1406 FREE(&new_offset);
1407 FREE(&old_offset);
1408
1409 adata->fp = freopen(mailbox_path(m), "r", adata->fp);
1410 if (!adata->fp)
1411 {
1412 mutt_error(_("Could not reopen mailbox"));
1413 mx_fastclose_mailbox(m, false);
1414 goto fatal;
1415 }
1416
1418 if (need_sort)
1419 {
1420 /* if the mailbox was reopened, the thread tree will be invalid so make
1421 * sure to start threading from scratch. */
1423 }
1424
1425fatal:
1426 buf_pool_release(&tempfile);
1427 progress_free(&progress);
1428 return rc;
1429}
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:161
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:168
short cs_subset_sort(const struct ConfigSubset *sub, const char *name)
Get a sort config item by name.
Definition: helpers.c:266
int mutt_copy_message(FILE *fp_out, struct Email *e, struct Message *msg, CopyMessageFlags cmflags, CopyHeaderFlags chflags, int wraplen)
Copy a message from a Mailbox.
Definition: copy.c:907
#define MUTT_CM_UPDATE
Update structs on sync.
Definition: copy.h:42
#define CH_UPDATE
Update the status and x-status fields?
Definition: copy.h:54
#define CH_FROM
Retain the "From " message separator?
Definition: copy.h:58
#define CH_UPDATE_LEN
Update Lines: and Content-Length:
Definition: copy.h:64
void mailbox_update(struct Mailbox *m)
Get the mailbox's current size.
Definition: mailbox.c:215
void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
Notify observers of a change to a Mailbox.
Definition: mailbox.c:233
struct Mailbox * mailbox_find(const char *path)
Find the mailbox with a given path.
Definition: mailbox.c:150
@ NT_MAILBOX_RESORT
Email list needs resorting.
Definition: mailbox.h:190
@ NT_MAILBOX_UPDATE
Update internal tables.
Definition: mailbox.h:191
@ MUTT_MMDF
'mmdf' Mailbox type
Definition: mailbox.h:46
@ MUTT_MBOX
'mbox' Mailbox type
Definition: mailbox.h:45
void mutt_body_free(struct Body **ptr)
Free a Body.
Definition: body.c:58
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition: file.c:287
bool mutt_file_seek(FILE *fp, LOFF_T offset, int whence)
Wrapper for fseeko with error handling.
Definition: file.c:778
#define mutt_file_fclose(FP)
Definition: file.h:138
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:137
char * ShortHostname
Short version of the hostname.
Definition: globals.c:38
char * Username
User's login name.
Definition: globals.c:40
#define mutt_message(...)
Definition: logging2.h:91
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
#define mutt_perror(...)
Definition: logging2.h:93
static enum MxStatus mbox_mbox_check(struct Mailbox *m)
Check for new mail - Implements MxOps::mbox_check() -.
Definition: mbox.c:930
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
#define MMDF_SEP
Definition: lib.h:62
static int mbox_lock_mailbox(struct Mailbox *m, bool excl, bool retry)
Lock a mailbox.
Definition: mbox.c:140
static struct MboxAccountData * mbox_adata_get(struct Mailbox *m)
Get the private data associated with a Mailbox.
Definition: mbox.c:125
static FILE * mbox_open_readwrite(struct Mailbox *m)
Open an mbox read-write.
Definition: mbox.c:803
static FILE * mbox_open_readonly(struct Mailbox *m)
Open an mbox read-only.
Definition: mbox.c:818
static void mbox_unlock_mailbox(struct Mailbox *m)
Unlock a mailbox.
Definition: mbox.c:164
void mbox_reset_atime(struct Mailbox *m, struct stat *st)
Reset the access time on the mailbox file.
Definition: mbox.c:748
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
#define FREE(x)
Definition: memory.h:45
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:230
void buf_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:519
int mx_msg_close(struct Mailbox *m, struct Message **ptr)
Close a message.
Definition: mx.c:1180
void mx_fastclose_mailbox(struct Mailbox *m, bool keep_account)
Free up memory associated with the Mailbox.
Definition: mx.c:414
struct Message * mx_msg_open(struct Mailbox *m, struct Email *e)
Return a stream pointer for a message.
Definition: mx.c:1134
@ MX_STATUS_REOPENED
Mailbox was reopened.
Definition: mxapi.h:68
@ MX_STATUS_NEW_MAIL
New mail received in Mailbox.
Definition: mxapi.h:66
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
void mutt_sig_block(void)
Block signals during critical operations.
Definition: signal.c:212
void mutt_sig_unblock(void)
Restore previously blocked signals.
Definition: signal.c:230
SortType
Methods for sorting.
Definition: sort2.h:34
@ SORT_ORDER
Sort by the order the messages appear in the mailbox.
Definition: sort2.h:40
void mutt_sort_order(struct Mailbox *m)
Sort emails by their disk order.
Definition: sort.c:444
#define NONULL(x)
Definition: string2.h:37
void * adata
Private data (for Mailbox backends)
Definition: account.h:42
struct Body * parts
parts of a multipart or message/rfc822
Definition: body.h:73
LOFF_T offset
offset where the actual data begins
Definition: body.h:52
LOFF_T length
length (in bytes) of attachment
Definition: body.h:53
long hdr_offset
Offset in stream where the headers begin.
Definition: body.h:81
String manipulation buffer.
Definition: buffer.h:36
int lines
How many lines in the body of this message?
Definition: email.h:62
struct Body * body
List of MIME parts.
Definition: email.h:69
bool changed
Email has been edited.
Definition: email.h:77
LOFF_T offset
Where in the stream does this message begin?
Definition: email.h:71
bool attach_del
Has an attachment marked for deletion.
Definition: email.h:99
Store of new offsets, used by mutt_sync_mailbox()
Definition: mbox.c:69
long lines
Definition: mbox.c:73
LOFF_T hdr
Definition: mbox.c:71
LOFF_T length
Definition: mbox.c:74
LOFF_T body
Definition: mbox.c:72
bool valid
Definition: mbox.c:70
A mailbox.
Definition: mailbox.h:79
bool has_new
Mailbox has new mail.
Definition: mailbox.h:85
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
off_t size
Size of the Mailbox.
Definition: mailbox.h:84
Mbox-specific Account data -.
Definition: lib.h:49
FILE * fp
Mailbox file.
Definition: lib.h:50
A local copy of an email.
Definition: message.h:34
FILE * fp
pointer to the message data
Definition: message.h:35
#define buf_mktemp(buf)
Definition: tmp.h:33
+ Here is the call graph for this function:

◆ mh_mbox_sync()

static enum MxStatus mh_mbox_sync ( struct Mailbox m)
static

Save changes to the Mailbox - Implements MxOps::mbox_sync() -.

Return values
MX_STATUS_REOPENEDmailbox has been externally modified
MX_STATUS_NEW_MAILnew mail has arrived
0Success
-1Error
Note
The flag retvals come from a call to a backend sync function

Definition at line 1065 of file mh.c.

1066{
1067 enum MxStatus check = mh_check(m);
1068 if (check == MX_STATUS_ERROR)
1069 return check;
1070
1071 struct HeaderCache *hc = NULL;
1072#ifdef USE_HCACHE
1073 const char *const c_header_cache = cs_subset_path(NeoMutt->sub, "header_cache");
1074 hc = hcache_open(c_header_cache, mailbox_path(m), NULL, true);
1075#endif
1076
1077 struct Progress *progress = NULL;
1078 if (m->verbose)
1079 {
1081 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
1082 }
1083
1084 for (int i = 0; i < m->msg_count; i++)
1085 {
1086 progress_update(progress, i, -1);
1087
1088 struct Email *e = m->emails[i];
1089 if (mh_sync_mailbox_message(m, e, hc) == -1)
1090 {
1091 progress_free(&progress);
1092 goto err;
1093 }
1094 }
1095 progress_free(&progress);
1096
1097#ifdef USE_HCACHE
1098 hcache_close(&hc);
1099#endif
1100
1101 mh_seq_update(m);
1102
1103 /* XXX race condition? */
1104
1105 mh_update_mtime(m);
1106
1107 /* adjust indices */
1108
1109 if (m->msg_deleted)
1110 {
1111 for (int i = 0, j = 0; i < m->msg_count; i++)
1112 {
1113 struct Email *e = m->emails[i];
1114 if (!e)
1115 break;
1116
1117 if (!e->deleted)
1118 e->index = j++;
1119 }
1120 }
1121
1122 return check;
1123
1124err:
1125#ifdef USE_HCACHE
1126 hcache_close(&hc);
1127#endif
1128 return MX_STATUS_ERROR;
1129}
struct HeaderCache * hcache_open(const char *path, const char *folder, hcache_namer_t namer, bool create)
Multiplexor for StoreOps::open.
Definition: hcache.c:471
void hcache_close(struct HeaderCache **ptr)
Multiplexor for StoreOps::close.
Definition: hcache.c:542
static void mh_update_mtime(struct Mailbox *m)
Update our record of the mailbox modification time.
Definition: mh.c:419
static enum MxStatus mh_check(struct Mailbox *m)
Check for new mail.
Definition: mh.c:909
int mh_sync_mailbox_message(struct Mailbox *m, struct Email *e, struct HeaderCache *hc)
Save changes to the mailbox.
Definition: mh.c:728
void mh_seq_update(struct Mailbox *m)
Update sequence numbers.
Definition: sequence.c:234
+ Here is the call graph for this function:

◆ nntp_mbox_sync()

static enum MxStatus nntp_mbox_sync ( struct Mailbox m)
static

Save changes to the Mailbox - Implements MxOps::mbox_sync() -.

Note
May also return values from check_mailbox()

Definition at line 2564 of file nntp.c.

2565{
2566 struct NntpMboxData *mdata = m->mdata;
2567
2568 /* check for new articles */
2569 mdata->adata->check_time = 0;
2570 enum MxStatus check = check_mailbox(m);
2571 if (check != MX_STATUS_OK)
2572 return check;
2573
2574#ifdef USE_HCACHE
2575 mdata->last_cached = 0;
2576 struct HeaderCache *hc = nntp_hcache_open(mdata);
2577#endif
2578
2579 for (int i = 0; i < m->msg_count; i++)
2580 {
2581 struct Email *e = m->emails[i];
2582 if (!e)
2583 break;
2584
2585 char buf[16] = { 0 };
2586
2587 snprintf(buf, sizeof(buf), ANUM_FMT, nntp_edata_get(e)->article_num);
2588 if (mdata->bcache && e->deleted)
2589 {
2590 mutt_debug(LL_DEBUG2, "mutt_bcache_del %s\n", buf);
2591 mutt_bcache_del(mdata->bcache, buf);
2592 }
2593
2594#ifdef USE_HCACHE
2595 if (hc && (e->changed || e->deleted))
2596 {
2597 if (e->deleted && !e->read)
2598 mdata->unread--;
2599 mutt_debug(LL_DEBUG2, "hcache_store_email %s\n", buf);
2600 hcache_store_email(hc, buf, strlen(buf), e, 0);
2601 }
2602#endif
2603 }
2604
2605#ifdef USE_HCACHE
2606 if (hc)
2607 {
2608 hcache_close(&hc);
2609 mdata->last_cached = mdata->last_loaded;
2610 }
2611#endif
2612
2613 /* save .newsrc entries */
2615 nntp_newsrc_update(mdata->adata);
2616 nntp_newsrc_close(mdata->adata);
2617 return MX_STATUS_OK;
2618}
int mutt_bcache_del(struct BodyCache *bcache, const char *id)
Delete a file from the Body Cache.
Definition: bcache.c:271
int hcache_store_email(struct HeaderCache *hc, const char *key, size_t keylen, struct Email *e, uint32_t uidvalidity)
Multiplexor for StoreOps::store.
Definition: hcache.c:670
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:44
struct HeaderCache * nntp_hcache_open(struct NntpMboxData *mdata)
Open newsgroup hcache.
Definition: newsrc.c:709
void nntp_newsrc_gen_entries(struct Mailbox *m)
Generate array of .newsrc entries.
Definition: newsrc.c:303
struct NntpEmailData * nntp_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:60
void nntp_newsrc_close(struct NntpAccountData *adata)
Unlock and close .newsrc file.
Definition: newsrc.c:122
int nntp_newsrc_update(struct NntpAccountData *adata)
Update .newsrc file.
Definition: newsrc.c:445
#define ANUM_FMT
Definition: lib.h:61
static enum MxStatus check_mailbox(struct Mailbox *m)
Check current newsgroup for new articles.
Definition: nntp.c:1491
bool read
Email is read.
Definition: email.h:50
void * mdata
Driver specific data.
Definition: mailbox.h:132
NNTP-specific Mailbox data -.
Definition: mdata.h:34
anum_t last_cached
Definition: mdata.h:40
struct BodyCache * bcache
Definition: mdata.h:50
struct NntpAccountData * adata
Definition: mdata.h:48
anum_t unread
Definition: mdata.h:41
anum_t last_loaded
Definition: mdata.h:39
+ Here is the call graph for this function:

◆ nm_mbox_sync()

static enum MxStatus nm_mbox_sync ( struct Mailbox m)
static

Save changes to the Mailbox - Implements MxOps::mbox_sync() -.

Definition at line 2231 of file notmuch.c.

2232{
2233 struct NmMboxData *mdata = nm_mdata_get(m);
2234 if (!mdata)
2235 return MX_STATUS_ERROR;
2236
2237 enum MxStatus rc = MX_STATUS_OK;
2238 struct Progress *progress = NULL;
2239 char *url = mutt_str_dup(mailbox_path(m));
2240 bool changed = false;
2241
2242 mutt_debug(LL_DEBUG1, "nm: sync start\n");
2243
2244 if (m->verbose)
2245 {
2246 /* all is in this function so we don't use data->progress here */
2248 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
2249 }
2250
2251 struct HeaderCache *hc = nm_hcache_open(m);
2252
2253 int mh_sync_errors = 0;
2254 for (int i = 0; i < m->msg_count; i++)
2255 {
2256 char old_file[PATH_MAX], new_file[PATH_MAX];
2257 struct Email *e = m->emails[i];
2258 if (!e)
2259 break;
2260
2261 struct NmEmailData *edata = nm_edata_get(e);
2262
2263 progress_update(progress, i, -1);
2264
2265 *old_file = '\0';
2266 *new_file = '\0';
2267
2268 if (edata->oldpath)
2269 {
2270 mutt_str_copy(old_file, edata->oldpath, sizeof(old_file));
2271 old_file[sizeof(old_file) - 1] = '\0';
2272 mutt_debug(LL_DEBUG2, "nm: fixing obsolete path '%s'\n", old_file);
2273 }
2274 else
2275 {
2276 email_get_fullpath(e, old_file, sizeof(old_file));
2277 }
2278
2279 buf_strcpy(&m->pathbuf, edata->folder);
2280 m->type = edata->type;
2281
2282 bool ok = maildir_sync_mailbox_message(m, e, hc);
2283 if (!ok)
2284 {
2285 // Syncing file failed, query notmuch for new filepath.
2286 m->type = MUTT_NOTMUCH;
2287 notmuch_database_t *db = nm_db_get(m, true);
2288 if (db)
2289 {
2290 notmuch_message_t *msg = get_nm_message(db, e);
2291
2293
2294 buf_strcpy(&m->pathbuf, edata->folder);
2295 m->type = edata->type;
2296 ok = maildir_sync_mailbox_message(m, e, hc);
2297 m->type = MUTT_NOTMUCH;
2298 }
2299 nm_db_release(m);
2300 m->type = edata->type;
2301 }
2302
2303 buf_strcpy(&m->pathbuf, url);
2304 m->type = MUTT_NOTMUCH;
2305
2306 if (!ok)
2307 {
2308 mh_sync_errors += 1;
2309 continue;
2310 }
2311
2312 if (!e->deleted)
2313 email_get_fullpath(e, new_file, sizeof(new_file));
2314
2315 if (e->deleted || !mutt_str_equal(old_file, new_file))
2316 {
2317 if (e->deleted && (remove_filename(m, old_file) == 0))
2318 changed = true;
2319 else if (*new_file && *old_file && (rename_filename(m, old_file, new_file, e) == 0))
2320 changed = true;
2321 }
2322
2323 FREE(&edata->oldpath);
2324 }
2325
2326 if (mh_sync_errors > 0)
2327 {
2328 mutt_error(ngettext("Unable to sync %d message due to external mailbox modification",
2329 "Unable to sync %d messages due to external mailbox modification",
2330 mh_sync_errors),
2331 mh_sync_errors);
2332 }
2333
2334 buf_strcpy(&m->pathbuf, url);
2335 m->type = MUTT_NOTMUCH;
2336
2337 nm_db_release(m);
2338
2339 if (changed)
2340 {
2341 mdata->mtime.tv_sec = mutt_date_now();
2342 mdata->mtime.tv_nsec = 0;
2343 }
2344
2345 nm_hcache_close(&hc);
2346
2347 progress_free(&progress);
2348 FREE(&url);
2349 mutt_debug(LL_DEBUG1, "nm: .... sync done [rc=%d]\n", rc);
2350 return rc;
2351}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition: mailbox.h:51
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:456
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:581
#define PATH_MAX
Definition: mutt.h:42
notmuch_database_t * nm_db_get(struct Mailbox *m, bool writable)
Get the Notmuch database.
Definition: db.c:209
int nm_db_release(struct Mailbox *m)
Close the Notmuch database.
Definition: db.c:233
struct NmEmailData * nm_edata_get(struct Email *e)
Get the Notmuch Email data.
Definition: edata.c:72
struct NmMboxData * nm_mdata_get(struct Mailbox *m)
Get the Notmuch Mailbox data.
Definition: mdata.c:96
static char * email_get_fullpath(struct Email *e, char *buf, size_t buflen)
Get the full path of an email.
Definition: notmuch.c:237
static void sync_email_path_with_nm(struct Email *e, notmuch_message_t *msg)
Synchronize Neomutt's Email path with notmuch.
Definition: notmuch.c:1088
static notmuch_message_t * get_nm_message(notmuch_database_t *db, struct Email *e)
Find a Notmuch message.
Definition: notmuch.c:1047
static int rename_filename(struct Mailbox *m, const char *old_file, const char *new_file, struct Email *e)
Rename the file.
Definition: notmuch.c:1331
static struct HeaderCache * nm_hcache_open(struct Mailbox *m)
Open a header cache.
Definition: notmuch.c:118
static int remove_filename(struct Mailbox *m, const char *path)
Delete a file.
Definition: notmuch.c:1267
static void nm_hcache_close(struct HeaderCache **ptr)
Close the header cache.
Definition: notmuch.c:132
void * edata
Driver-specific data.
Definition: email.h:74
struct Buffer pathbuf
Path of the Mailbox.
Definition: mailbox.h:80
Notmuch-specific Email data -.
Definition: edata.h:34
Notmuch-specific Mailbox data -.
Definition: mdata.h:35
struct timespec mtime
Time Mailbox was last changed.
Definition: mdata.h:44
+ Here is the call graph for this function:

◆ pop_mbox_sync()

static enum MxStatus pop_mbox_sync ( struct Mailbox m)
static

Save changes to the Mailbox - Implements MxOps::mbox_sync() -.

Update POP mailbox, delete messages from server

Definition at line 860 of file pop.c.

861{
862 int i, j, rc = 0;
863 char buf[1024] = { 0 };
865#ifdef USE_HCACHE
866 struct HeaderCache *hc = NULL;
867#endif
868
869 adata->check_time = 0;
870
871 int num_deleted = 0;
872 for (i = 0; i < m->msg_count; i++)
873 {
874 if (m->emails[i]->deleted)
875 num_deleted++;
876 }
877
878 while (true)
879 {
880 if (pop_reconnect(m) < 0)
881 return MX_STATUS_ERROR;
882
883#ifdef USE_HCACHE
884 hc = pop_hcache_open(adata, mailbox_path(m));
885#endif
886
887 struct Progress *progress = NULL;
888 if (m->verbose)
889 {
890 progress = progress_new(MUTT_PROGRESS_WRITE, num_deleted);
891 progress_set_message(progress, _("Marking messages deleted..."));
892 }
893
894 for (i = 0, j = 0, rc = 0; (rc == 0) && (i < m->msg_count); i++)
895 {
896 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
897 if (m->emails[i]->deleted && (edata->refno != -1))
898 {
899 j++;
900 progress_update(progress, j, -1);
901 snprintf(buf, sizeof(buf), "DELE %d\r\n", edata->refno);
902 rc = pop_query(adata, buf, sizeof(buf));
903 if (rc == 0)
904 {
905 mutt_bcache_del(adata->bcache, cache_id(edata->uid));
906#ifdef USE_HCACHE
907 hcache_delete_email(hc, edata->uid, strlen(edata->uid));
908#endif
909 }
910 }
911
912#ifdef USE_HCACHE
913 if (m->emails[i]->changed)
914 {
915 hcache_store_email(hc, edata->uid, strlen(edata->uid), m->emails[i], 0);
916 }
917#endif
918 }
919 progress_free(&progress);
920
921#ifdef USE_HCACHE
922 hcache_close(&hc);
923#endif
924
925 if (rc == 0)
926 {
927 mutt_str_copy(buf, "QUIT\r\n", sizeof(buf));
928 rc = pop_query(adata, buf, sizeof(buf));
929 }
930
931 if (rc == 0)
932 {
933 adata->clear_cache = true;
934 pop_clear_cache(adata);
935 adata->status = POP_DISCONNECTED;
936 return MX_STATUS_OK;
937 }
938
939 if (rc == -2)
940 {
941 mutt_error("%s", adata->err_msg);
942 return MX_STATUS_ERROR;
943 }
944 }
945}
int hcache_delete_email(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition: hcache.c:739
struct PopAccountData * pop_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:73
struct PopEmailData * pop_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:68
int pop_reconnect(struct Mailbox *m)
Reconnect and verify indexes if connection was lost.
Definition: lib.c:609
#define pop_query(adata, buf, buflen)
Definition: private.h:111
@ POP_DISCONNECTED
Disconnected from server.
Definition: private.h:51
static void pop_clear_cache(struct PopAccountData *adata)
Delete all cached messages.
Definition: pop.c:493
static const char * cache_id(const char *id)
Make a message-cache-compatible id.
Definition: pop.c:82
static struct HeaderCache * pop_hcache_open(struct PopAccountData *adata, const char *path)
Open the header cache.
Definition: pop.c:300
POP-specific Account data -.
Definition: adata.h:37
bool clear_cache
Definition: adata.h:49
time_t check_time
Definition: adata.h:51
char err_msg[POP_CMD_RESPONSE]
Definition: adata.h:56
unsigned int status
Definition: adata.h:39
struct BodyCache * bcache
body cache
Definition: adata.h:55
POP-specific Email data -.
Definition: edata.h:32
+ Here is the call graph for this function: