NeoMutt  2025-12-11-980-ge38c27
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 589 of file compress.c.

590{
591 if (!m->compress_info)
592 return MX_STATUS_ERROR;
593
594 struct CompressInfo *ci = m->compress_info;
595
596 if (!ci->cmd_close)
597 {
598 mutt_error(_("Can't sync a compressed file without a close-hook"));
599 return MX_STATUS_ERROR;
600 }
601
602 const struct MxOps *ops = ci->child_ops;
603 if (!ops)
604 return MX_STATUS_ERROR;
605
606 if (!lock_realpath(m, true))
607 {
608 mutt_error(_("Unable to lock mailbox"));
609 return MX_STATUS_ERROR;
610 }
611
612 enum MxStatus check = comp_mbox_check(m);
613 if (check != MX_STATUS_OK)
614 goto sync_cleanup;
615
616 check = ops->mbox_sync(m);
617 if (check != MX_STATUS_OK)
618 goto sync_cleanup;
619
620 if (!execute_command(m, ci->cmd_close, _("Compressing %s")))
621 {
622 check = MX_STATUS_ERROR;
623 goto sync_cleanup;
624 }
625
626 check = MX_STATUS_OK;
627
628sync_cleanup:
629 store_size(m);
631 return check;
632}
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:108
static void unlock_realpath(struct Mailbox *m)
Unlock the mailbox->realpath.
Definition compress.c:153
static bool execute_command(struct Mailbox *m, const struct Expando *exp, const char *progress)
Run a system command.
Definition compress.c:295
#define mutt_error(...)
Definition logging2.h:94
static enum MxStatus comp_mbox_check(struct Mailbox *m)
Check for new mail - Implements MxOps::mbox_check() -.
Definition compress.c:553
#define _(a)
Definition message.h:28
MxStatus
Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()
Definition mxapi.h:70
@ MX_STATUS_ERROR
An error occurred.
Definition mxapi.h:71
@ MX_STATUS_OK
No changes.
Definition mxapi.h:72
Private data for compress.
Definition lib.h:61
const struct MxOps * child_ops
callbacks of de-compressed file
Definition lib.h:66
struct Expando * cmd_close
close-hook command
Definition lib.h:63
void * compress_info
Compressed mbox module private data.
Definition mailbox.h:123
Definition mxapi.h:98
enum MxStatus(* mbox_sync)(struct Mailbox *m)
Definition mxapi.h:194
+ 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 849 of file mailbox.c.

850{
851 enum MxStatus check = maildir_check(m);
852 if (check == MX_STATUS_ERROR)
853 return check;
854
855 struct HeaderCache *hc = maildir_hcache_open(m);
856
857 struct Progress *progress = NULL;
858 if (m->verbose)
859 {
861 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
862 }
863
864 for (int i = 0; i < m->msg_count; i++)
865 {
866 progress_update(progress, i, -1);
867
868 struct Email *e = m->emails[i];
869 if (!maildir_sync_mailbox_message(m, e, hc))
870 {
871 progress_free(&progress);
872 goto err;
873 }
874 }
875 progress_free(&progress);
877
878 /* XXX race condition? */
879
881
882 /* adjust indices */
883
884 if (m->msg_deleted)
885 {
886 const bool c_maildir_trash = cs_subset_bool(NeoMutt->sub, "maildir_trash");
887 for (int i = 0, j = 0; i < m->msg_count; i++)
888 {
889 struct Email *e = m->emails[i];
890 if (!e)
891 break;
892
893 if (!e->deleted || c_maildir_trash)
894 e->index = j++;
895 }
896 }
897
898 return check;
899
900err:
902 return MX_STATUS_ERROR;
903}
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:216
struct HeaderCache * maildir_hcache_open(struct Mailbox *m)
Open the Header Cache.
Definition hcache.c:104
void maildir_hcache_close(struct HeaderCache **ptr)
Close the Header Cache.
Definition hcache.c:77
static enum MxStatus maildir_check(struct Mailbox *m)
Check for new mail.
Definition mailbox.c:546
void maildir_update_mtime(struct Mailbox *m)
Update our record of the Maildir modification time.
Definition mailbox.c:725
bool maildir_sync_mailbox_message(struct Mailbox *m, struct Email *e, struct HeaderCache *hc)
Save changes to the mailbox.
Definition message.c:316
@ MUTT_PROGRESS_WRITE
Progress tracks elements, according to $write_inc
Definition lib.h:85
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:87
int msg_count
Total number of messages.
Definition mailbox.h:90
struct Email ** emails
Array of Emails.
Definition mailbox.h:98
int msg_deleted
Number of deleted messages.
Definition mailbox.h:95
bool verbose
Display status messages?
Definition mailbox.h:119
Container for Accounts, Notifications.
Definition neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:49
+ 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 1092 of file mbox.c.

1093{
1095 if (!adata)
1096 return MX_STATUS_ERROR;
1097
1098 struct Buffer *tempfile = NULL;
1099 char buf[32] = { 0 };
1100 int j;
1101 bool unlink_tempfile = false;
1102 bool need_sort = false; /* flag to resort mailbox if new mail arrives */
1103 int first = -1; /* first message to be written */
1104 LOFF_T offset; /* location in mailbox to write changed messages */
1105 struct stat st = { 0 };
1106 struct MUpdate *new_offset = NULL;
1107 struct MUpdate *old_offset = NULL;
1108 FILE *fp = NULL;
1109 struct Progress *progress = NULL;
1110 enum MxStatus rc = MX_STATUS_ERROR;
1111
1112 /* sort message by their position in the mailbox on disk */
1113 const enum EmailSortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
1114 if (c_sort != EMAIL_SORT_UNSORTED)
1115 {
1117 need_sort = true;
1118 }
1119
1120 /* need to open the file for writing in such a way that it does not truncate
1121 * the file, so use read-write mode. */
1122 adata->fp = freopen(mailbox_path(m), "r+", adata->fp);
1123 if (!adata->fp)
1124 {
1125 mx_fastclose_mailbox(m, false);
1126 mutt_error(_("Fatal error! Could not reopen mailbox!"));
1127 goto fatal;
1128 }
1129
1131
1132 if (mbox_lock_mailbox(m, true, true) == -1)
1133 {
1135 mutt_error(_("Unable to lock mailbox"));
1136 goto bail;
1137 }
1138
1139 /* Check to make sure that the file hasn't changed on disk */
1140 enum MxStatus check = mbox_mbox_check(m);
1141 if ((check == MX_STATUS_NEW_MAIL) || (check == MX_STATUS_REOPENED))
1142 {
1143 /* new mail arrived, or mailbox reopened */
1144 rc = check;
1145 goto bail;
1146 }
1147 else if (check < 0)
1148 {
1149 goto fatal;
1150 }
1151
1152 /* Create a temporary file to write the new version of the mailbox in. */
1153 tempfile = buf_pool_get();
1154 buf_mktemp(tempfile);
1155 int fd = open(buf_string(tempfile), O_WRONLY | O_EXCL | O_CREAT, 0600);
1156 if ((fd == -1) || !(fp = fdopen(fd, "w")))
1157 {
1158 if (fd != -1)
1159 {
1160 close(fd);
1161 unlink_tempfile = true;
1162 }
1163 mutt_error(_("Could not create temporary file"));
1164 goto bail;
1165 }
1166 unlink_tempfile = true;
1167
1168 /* find the first deleted/changed message. we save a lot of time by only
1169 * rewriting the mailbox from the point where it has actually changed. */
1170 int i = 0;
1171 for (; (i < m->msg_count) && !m->emails[i]->deleted &&
1172 !m->emails[i]->changed && !m->emails[i]->attach_del;
1173 i++)
1174 {
1175 }
1176 if (i == m->msg_count)
1177 {
1178 /* this means m->changed or m->msg_deleted was set, but no
1179 * messages were found to be changed or deleted. This should
1180 * never happen, is we presume it is a bug in neomutt. */
1181 mutt_error(_("sync: mbox modified, but no modified messages (report this bug)"));
1182 mutt_debug(LL_DEBUG1, "no modified messages\n");
1183 goto bail;
1184 }
1185
1186 /* save the index of the first changed/deleted message */
1187 first = i;
1188 /* where to start overwriting */
1189 offset = m->emails[i]->offset;
1190
1191 /* the offset stored in the header does not include the MMDF_SEP, so make
1192 * sure we seek to the correct location */
1193 if (m->type == MUTT_MMDF)
1194 offset -= (sizeof(MMDF_SEP) - 1);
1195
1196 /* allocate space for the new offsets */
1197 new_offset = MUTT_MEM_CALLOC(m->msg_count - first, struct MUpdate);
1198 old_offset = MUTT_MEM_CALLOC(m->msg_count - first, struct MUpdate);
1199
1200 if (m->verbose)
1201 {
1203 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
1204 }
1205
1206 for (i = first, j = 0; i < m->msg_count; i++)
1207 {
1208 progress_update(progress, i, i / (m->msg_count / 100 + 1));
1209 /* back up some information which is needed to restore offsets when
1210 * something fails. */
1211
1212 old_offset[i - first].valid = true;
1213 old_offset[i - first].hdr = m->emails[i]->offset;
1214 old_offset[i - first].body = m->emails[i]->body->offset;
1215 old_offset[i - first].lines = m->emails[i]->lines;
1216 old_offset[i - first].length = m->emails[i]->body->length;
1217
1218 if (!m->emails[i]->deleted)
1219 {
1220 j++;
1221
1222 if (m->type == MUTT_MMDF)
1223 {
1224 if (fputs(MMDF_SEP, fp) == EOF)
1225 {
1226 mutt_perror("%s", buf_string(tempfile));
1227 goto bail;
1228 }
1229 }
1230
1231 /* save the new offset for this message. we add 'offset' because the
1232 * temporary file only contains saved message which are located after
1233 * 'offset' in the real mailbox */
1234 new_offset[i - first].hdr = ftello(fp) + offset;
1235
1236 struct Message *msg = mx_msg_open(m, m->emails[i]);
1237 const int rc2 = mutt_copy_message(fp, m->emails[i], msg, MUTT_CM_UPDATE,
1239 mx_msg_close(m, &msg);
1240 if (rc2 != 0)
1241 {
1242 mutt_perror("%s", buf_string(tempfile));
1243 goto bail;
1244 }
1245
1246 /* Since messages could have been deleted, the offsets stored in memory
1247 * will be wrong, so update what we can, which is the offset of this
1248 * message, and the offset of the body. If this is a multipart message,
1249 * we just flush the in memory cache so that the message will be reparsed
1250 * if the user accesses it later. */
1251 new_offset[i - first].body = ftello(fp) - m->emails[i]->body->length + offset;
1252 mutt_body_free(&m->emails[i]->body->parts);
1253
1254 if (m->type == MUTT_MMDF)
1255 {
1256 if (fputs(MMDF_SEP, fp) == EOF)
1257 {
1258 mutt_perror("%s", buf_string(tempfile));
1259 goto bail;
1260 }
1261 }
1262 else
1263 {
1264 if (fputs(MBOX_SEP, fp) == EOF)
1265 {
1266 mutt_perror("%s", buf_string(tempfile));
1267 goto bail;
1268 }
1269 }
1270 }
1271 }
1272
1273 if (mutt_file_fclose(&fp) != 0)
1274 {
1275 mutt_debug(LL_DEBUG1, "mutt_file_fclose (&) returned non-zero\n");
1276 mutt_perror("%s", buf_string(tempfile));
1277 goto bail;
1278 }
1279
1280 /* Save the state of this folder. */
1281 if (stat(mailbox_path(m), &st) == -1)
1282 {
1283 mutt_perror("%s", mailbox_path(m));
1284 goto bail;
1285 }
1286
1287 unlink_tempfile = false;
1288
1289 fp = mutt_file_fopen(buf_string(tempfile), "r");
1290 if (!fp)
1291 {
1293 mx_fastclose_mailbox(m, false);
1294 mutt_debug(LL_DEBUG1, "unable to reopen temp copy of mailbox!\n");
1295 mutt_perror("%s", buf_string(tempfile));
1296 FREE(&new_offset);
1297 FREE(&old_offset);
1298 goto fatal;
1299 }
1300
1301 if (!mutt_file_seek(adata->fp, offset, SEEK_SET) || /* seek the append location */
1302 /* do a sanity check to make sure the mailbox looks ok */
1303 !fgets(buf, sizeof(buf), adata->fp) ||
1304 ((m->type == MUTT_MBOX) && !mutt_str_startswith(buf, "From ")) ||
1305 ((m->type == MUTT_MMDF) && !mutt_str_equal(MMDF_SEP, buf)))
1306 {
1307 mutt_debug(LL_DEBUG1, "message not in expected position\n");
1308 mutt_debug(LL_DEBUG1, " LINE: %s\n", buf);
1309 i = -1;
1310 }
1311 else
1312 {
1313 if (!mutt_file_seek(adata->fp, offset, SEEK_SET)) /* return to proper offset */
1314 {
1315 i = -1;
1316 }
1317 else
1318 {
1319 /* copy the temp mailbox back into place starting at the first
1320 * change/deleted message */
1321 if (m->verbose)
1322 mutt_message(_("Committing changes..."));
1323 i = mutt_file_copy_stream(fp, adata->fp);
1324
1325 if (ferror(adata->fp))
1326 i = -1;
1327 }
1328 if (i >= 0)
1329 {
1330 m->size = ftello(adata->fp); /* update the mailbox->size of the mailbox */
1331 if ((m->size < 0) || (ftruncate(fileno(adata->fp), m->size) != 0))
1332 {
1333 i = -1;
1334 mutt_debug(LL_DEBUG1, "ftruncate() failed\n");
1335 }
1336 }
1337 }
1338
1341
1342 if ((mutt_file_fclose(&adata->fp) != 0) || (i == -1))
1343 {
1344 /* error occurred while writing the mailbox back, so keep the temp copy around */
1345
1346 struct Buffer *savefile = buf_pool_get();
1347
1348 const char *const c_tmp_dir = cs_subset_path(NeoMutt->sub, "tmp_dir");
1349 buf_printf(savefile, "%s/neomutt.%s-%s-%u", NONULL(c_tmp_dir),
1350 NONULL(NeoMutt->username), NONULL(ShortHostname), (unsigned int) getpid());
1351 rename(buf_string(tempfile), buf_string(savefile));
1353 mx_fastclose_mailbox(m, false);
1354 pretty_mailbox(savefile);
1355 mutt_error(_("Write failed! Saved partial mailbox to %s"), buf_string(savefile));
1356 buf_pool_release(&savefile);
1357 FREE(&new_offset);
1358 FREE(&old_offset);
1359 goto fatal;
1360 }
1361
1362 /* Restore the previous access/modification times */
1363 mbox_reset_atime(m, &st);
1364
1365 /* reopen the mailbox in read-only mode */
1366 adata->fp = mbox_open_readwrite(m);
1367 if (!adata->fp)
1368 {
1369 adata->fp = mbox_open_readonly(m);
1370 }
1371 if (!adata->fp)
1372 {
1373 unlink(buf_string(tempfile));
1375 mx_fastclose_mailbox(m, false);
1376 mutt_error(_("Fatal error! Could not reopen mailbox!"));
1377 FREE(&new_offset);
1378 FREE(&old_offset);
1379 goto fatal;
1380 }
1381
1382 /* update the offsets of the rewritten messages */
1383 for (i = first, j = first; i < m->msg_count; i++)
1384 {
1385 if (!m->emails[i]->deleted)
1386 {
1387 m->emails[i]->offset = new_offset[i - first].hdr;
1388 m->emails[i]->body->hdr_offset = new_offset[i - first].hdr;
1389 m->emails[i]->body->offset = new_offset[i - first].body;
1390 m->emails[i]->index = j++;
1391 }
1392 }
1393 FREE(&new_offset);
1394 FREE(&old_offset);
1395 unlink(buf_string(tempfile)); /* remove partial copy of the mailbox */
1396 buf_pool_release(&tempfile);
1398
1399 const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
1400 if (c_check_mbox_size)
1401 {
1402 struct Mailbox *m_tmp = mailbox_find(mailbox_path(m));
1403 if (m_tmp && !m_tmp->has_new)
1404 mailbox_update(m_tmp);
1405 }
1406
1407 progress_free(&progress);
1408 return 0; /* signal success */
1409
1410bail: /* Come here in case of disaster */
1411
1412 mutt_file_fclose(&fp);
1413
1414 if (tempfile && unlink_tempfile)
1415 unlink(buf_string(tempfile));
1416
1417 /* restore offsets, as far as they are valid */
1418 if ((first >= 0) && old_offset)
1419 {
1420 for (i = first; (i < m->msg_count) && old_offset[i - first].valid; i++)
1421 {
1422 m->emails[i]->offset = old_offset[i - first].hdr;
1423 m->emails[i]->body->hdr_offset = old_offset[i - first].hdr;
1424 m->emails[i]->body->offset = old_offset[i - first].body;
1425 m->emails[i]->lines = old_offset[i - first].lines;
1426 m->emails[i]->body->length = old_offset[i - first].length;
1427 }
1428 }
1429
1430 /* this is ok to call even if we haven't locked anything */
1432
1434 FREE(&new_offset);
1435 FREE(&old_offset);
1436
1437 adata->fp = freopen(mailbox_path(m), "r", adata->fp);
1438 if (!adata->fp)
1439 {
1440 mutt_error(_("Could not reopen mailbox"));
1441 mx_fastclose_mailbox(m, false);
1442 goto fatal;
1443 }
1444
1446 if (need_sort)
1447 {
1448 /* if the mailbox was reopened, the thread tree will be invalid so make
1449 * sure to start threading from scratch. */
1451 }
1452
1453fatal:
1454 buf_pool_release(&tempfile);
1455 progress_free(&progress);
1456 return rc;
1457}
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition buffer.c:168
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_email.c:920
@ MUTT_CM_UPDATE
Update structs on sync.
Definition copy_email.h:46
@ CH_UPDATE
Update the status and x-status fields?
Definition copy_email.h:66
@ CH_UPDATE_LEN
Update Lines: and Content-Length:
Definition copy_email.h:76
@ CH_FROM
Retain the "From " message separator?
Definition copy_email.h:70
void mailbox_update(struct Mailbox *m)
Get the mailbox's current size.
Definition mailbox.c:214
void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
Notify observers of a change to a Mailbox.
Definition mailbox.c:232
struct Mailbox * mailbox_find(const char *path)
Find the mailbox with a given path.
Definition mailbox.c:151
@ NT_MAILBOX_RESORT
Email list needs resorting.
Definition mailbox.h:183
@ NT_MAILBOX_UPDATE
Update internal tables.
Definition mailbox.h:184
@ MUTT_MMDF
'mmdf' Mailbox type
Definition mailbox.h:45
@ MUTT_MBOX
'mbox' Mailbox type
Definition mailbox.h:44
void mutt_body_free(struct Body **ptr)
Free a Body.
Definition body.c:58
void mutt_sort_unsorted(struct Mailbox *m)
Sort emails by their disk order.
Definition sort.c:452
EmailSortType
Methods for sorting Emails.
Definition sort.h:53
@ EMAIL_SORT_UNSORTED
Sort by the order the messages appear in the mailbox.
Definition sort.h:64
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition file.c:224
bool mutt_file_seek(FILE *fp, LOFF_T offset, int whence)
Wrapper for fseeko with error handling.
Definition file.c:648
#define mutt_file_fclose(FP)
Definition file.h:144
#define mutt_file_fopen(PATH, MODE)
Definition file.h:143
char * ShortHostname
Short version of the hostname.
Definition globals.c:36
#define mutt_message(...)
Definition logging2.h:93
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
#define mutt_perror(...)
Definition logging2.h:95
static enum MxStatus mbox_mbox_check(struct Mailbox *m)
Check for new mail - Implements MxOps::mbox_check() -.
Definition mbox.c:958
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:45
#define MMDF_SEP
Definition lib.h:63
static int mbox_lock_mailbox(struct Mailbox *m, bool excl, bool retry)
Lock a mailbox.
Definition mbox.c:136
static struct MboxAccountData * mbox_adata_get(struct Mailbox *m)
Get the private data associated with a Mailbox.
Definition mbox.c:121
static FILE * mbox_open_readwrite(struct Mailbox *m)
Open an mbox read-write.
Definition mbox.c:831
static FILE * mbox_open_readonly(struct Mailbox *m)
Open an mbox read-only.
Definition mbox.c:846
static void mbox_unlock_mailbox(struct Mailbox *m)
Unlock a mailbox.
Definition mbox.c:160
void mbox_reset_atime(struct Mailbox *m, struct stat *st)
Reset the access time on the mailbox file.
Definition mbox.c:776
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
#define MUTT_MEM_CALLOC(n, type)
Definition memory.h:52
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:666
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition string.c:234
void pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition muttlib.c:428
int mx_msg_close(struct Mailbox *m, struct Message **ptr)
Close a message.
Definition mx.c:1185
void mx_fastclose_mailbox(struct Mailbox *m, bool keep_account)
Free up memory associated with the Mailbox.
Definition mx.c:411
struct Message * mx_msg_open(struct Mailbox *m, struct Email *e)
Return a stream pointer for a message.
Definition mx.c:1139
#define MBOX_SEP
Definition mx.h:69
@ MX_STATUS_REOPENED
Mailbox was reopened.
Definition mxapi.h:75
@ MX_STATUS_NEW_MAIL
New mail received in Mailbox.
Definition mxapi.h:73
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
void mutt_sig_block(void)
Block signals during critical operations.
Definition signal.c:227
void mutt_sig_unblock(void)
Restore previously blocked signals.
Definition signal.c:245
#define NONULL(x)
Definition string2.h:44
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:65
long lines
Number of lines.
Definition mbox.c:69
LOFF_T hdr
Header offset.
Definition mbox.c:67
LOFF_T length
Total length.
Definition mbox.c:70
LOFF_T body
Body offset.
Definition mbox.c:68
bool valid
Is this entry valid?
Definition mbox.c:66
A mailbox.
Definition mailbox.h:81
bool has_new
Mailbox has new mail.
Definition mailbox.h:87
enum MailboxType type
Mailbox type.
Definition mailbox.h:104
off_t size
Size of the Mailbox.
Definition mailbox.h:86
Mbox-specific Account data -.
Definition lib.h:50
FILE * fp
Mailbox file.
Definition lib.h:51
A local copy of an email.
Definition message.h:34
FILE * fp
pointer to the message data
Definition message.h:35
char * username
User's login name.
Definition neomutt.h:56
#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 1069 of file mh.c.

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

2576{
2577 struct NntpMboxData *mdata = m->mdata;
2578
2579 /* check for new articles */
2580 mdata->adata->check_time = 0;
2581 enum MxStatus check = check_mailbox(m);
2582 if (check != MX_STATUS_OK)
2583 return check;
2584
2585#ifdef USE_HCACHE
2586 mdata->last_cached = 0;
2587 struct HeaderCache *hc = nntp_hcache_open(mdata);
2588#endif
2589
2590 for (int i = 0; i < m->msg_count; i++)
2591 {
2592 struct Email *e = m->emails[i];
2593 if (!e)
2594 break;
2595
2596 char buf[16] = { 0 };
2597
2598 snprintf(buf, sizeof(buf), ANUM_FMT, nntp_edata_get(e)->article_num);
2599 if (mdata->bcache && e->deleted)
2600 {
2601 mutt_debug(LL_DEBUG2, "mutt_bcache_del %s\n", buf);
2602 mutt_bcache_del(mdata->bcache, buf);
2603 }
2604
2605#ifdef USE_HCACHE
2606 if (hc && (e->changed || e->deleted))
2607 {
2608 if (e->deleted && !e->read)
2609 mdata->unread--;
2610 mutt_debug(LL_DEBUG2, "hcache_store_email %s\n", buf);
2611 hcache_store_email(hc, buf, strlen(buf), e, 0);
2612 }
2613#endif
2614 }
2615
2616#ifdef USE_HCACHE
2617 if (hc)
2618 {
2619 hcache_close(&hc);
2620 mdata->last_cached = mdata->last_loaded;
2621 }
2622#endif
2623
2624 /* save .newsrc entries */
2626 nntp_newsrc_update(mdata->adata);
2627 nntp_newsrc_close(mdata->adata);
2628 return MX_STATUS_OK;
2629}
int mutt_bcache_del(struct BodyCache *bcache, const char *id)
Delete a file from the Body Cache.
Definition bcache.c:290
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:700
@ LL_DEBUG2
Log at debug level 2.
Definition logging2.h:46
struct HeaderCache * nntp_hcache_open(struct NntpMboxData *mdata)
Open newsgroup hcache.
Definition newsrc.c:712
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:121
int nntp_newsrc_update(struct NntpAccountData *adata)
Update .newsrc file.
Definition newsrc.c:446
#define ANUM_FMT
Definition lib.h:64
static enum MxStatus check_mailbox(struct Mailbox *m)
Check current newsgroup for new articles.
Definition nntp.c:1497
bool read
Email is read.
Definition email.h:50
void * mdata
Driver specific data.
Definition mailbox.h:134
NNTP-specific Mailbox data -.
Definition mdata.h:34
anum_t last_cached
Last cached article.
Definition mdata.h:40
struct BodyCache * bcache
Body cache.
Definition mdata.h:50
struct NntpAccountData * adata
Account data.
Definition mdata.h:48
anum_t unread
Unread articles.
Definition mdata.h:41
anum_t last_loaded
Last loaded article.
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 2242 of file notmuch.c.

2243{
2244 struct NmMboxData *mdata = nm_mdata_get(m);
2245 if (!mdata)
2246 return MX_STATUS_ERROR;
2247
2248 enum MxStatus rc = MX_STATUS_OK;
2249 struct Progress *progress = NULL;
2250 char *url = mutt_str_dup(mailbox_path(m));
2251 bool changed = false;
2252
2253 mutt_debug(LL_DEBUG1, "nm: sync start\n");
2254
2255 if (m->verbose)
2256 {
2257 /* all is in this function so we don't use data->progress here */
2259 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
2260 }
2261
2262 struct HeaderCache *hc = nm_hcache_open(m);
2263
2264 /* Iterate through all messages, syncing flag changes to the underlying
2265 * maildir/mh files and updating the notmuch database for renames/deletes */
2266 int mh_sync_errors = 0;
2267 for (int i = 0; i < m->msg_count; i++)
2268 {
2269 char old_file[PATH_MAX] = { 0 };
2270 char new_file[PATH_MAX] = { 0 };
2271 struct Email *e = m->emails[i];
2272 if (!e)
2273 break;
2274
2275 struct NmEmailData *edata = nm_edata_get(e);
2276 if (!edata)
2277 continue;
2278
2279 progress_update(progress, i, -1);
2280
2281 if (edata->oldpath)
2282 {
2283 mutt_str_copy(old_file, edata->oldpath, sizeof(old_file));
2284 mutt_debug(LL_DEBUG2, "nm: fixing obsolete path '%s'\n", old_file);
2285 }
2286 else
2287 {
2288 email_get_fullpath(e, old_file, sizeof(old_file));
2289 }
2290
2291 /* Temporarily set mailbox path and type to the message's backing
2292 * maildir folder so maildir_sync_mailbox_message() can operate */
2293 buf_strcpy(&m->pathbuf, edata->folder);
2294 m->type = edata->type;
2295
2296 bool ok = maildir_sync_mailbox_message(m, e, hc);
2297 if (!ok)
2298 {
2299 /* Syncing file failed, query notmuch for an updated filepath
2300 * (another process may have moved the message on disk) */
2301 m->type = MUTT_NOTMUCH;
2302 notmuch_database_t *db = nm_db_get(m, true);
2303 if (db)
2304 {
2305 notmuch_message_t *msg = get_nm_message(db, e);
2306
2308
2309 buf_strcpy(&m->pathbuf, edata->folder);
2310 m->type = edata->type;
2311 ok = maildir_sync_mailbox_message(m, e, hc);
2312 m->type = MUTT_NOTMUCH;
2313 }
2314 nm_db_release(m);
2315 m->type = edata->type;
2316 }
2317
2318 /* Restore the virtual notmuch mailbox path */
2319 buf_strcpy(&m->pathbuf, url);
2320 m->type = MUTT_NOTMUCH;
2321
2322 if (!ok)
2323 {
2324 mh_sync_errors += 1;
2325 continue;
2326 }
2327
2328 /* If the message was deleted or its file was renamed (e.g. flag change),
2329 * update the notmuch database to reflect the new state */
2330 if (!e->deleted)
2331 email_get_fullpath(e, new_file, sizeof(new_file));
2332
2333 if (e->deleted || !mutt_str_equal(old_file, new_file))
2334 {
2335 if (e->deleted && (remove_filename(m, old_file) == 0))
2336 changed = true;
2337 else if (*new_file && *old_file && (rename_filename(m, old_file, new_file, e) == 0))
2338 changed = true;
2339 }
2340
2341 FREE(&edata->oldpath);
2342 }
2343
2344 if (mh_sync_errors > 0)
2345 {
2346 mutt_error(ngettext("Unable to sync %d message due to external mailbox modification",
2347 "Unable to sync %d messages due to external mailbox modification",
2348 mh_sync_errors),
2349 mh_sync_errors);
2350 rc = MX_STATUS_ERROR;
2351 }
2352
2353 buf_strcpy(&m->pathbuf, url);
2354 m->type = MUTT_NOTMUCH;
2355
2356 nm_db_release(m);
2357
2358 if (changed)
2359 {
2360 mdata->mtime.tv_sec = mutt_date_now();
2361 mdata->mtime.tv_nsec = 0;
2362 }
2363
2364 nm_hcache_close(&hc);
2365
2366 progress_free(&progress);
2367 FREE(&url);
2368 mutt_debug(LL_DEBUG1, "nm: .... sync done [rc=%d]\n", rc);
2369 return rc;
2370}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition buffer.c:401
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition mailbox.h:50
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition date.c:459
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
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:587
#define PATH_MAX
Definition mutt.h:49
notmuch_database_t * nm_db_get(struct Mailbox *m, bool writable)
Get the Notmuch database.
Definition db.c:210
int nm_db_release(struct Mailbox *m)
Close the Notmuch database.
Definition db.c:245
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:230
static void sync_email_path_with_nm(struct Email *e, notmuch_message_t *msg)
Synchronize NeoMutt's Email path with notmuch.
Definition notmuch.c:1122
static notmuch_message_t * get_nm_message(notmuch_database_t *db, struct Email *e)
Find a Notmuch message.
Definition notmuch.c:1081
static int rename_filename(struct Mailbox *m, const char *old_file, const char *new_file, struct Email *e)
Rename the file.
Definition notmuch.c:1367
static struct HeaderCache * nm_hcache_open(struct Mailbox *m)
Open a header cache.
Definition notmuch.c:111
static int remove_filename(struct Mailbox *m, const char *path)
Delete a file.
Definition notmuch.c:1303
static void nm_hcache_close(struct HeaderCache **ptr)
Close the header cache.
Definition notmuch.c:125
void * edata
Driver-specific data.
Definition email.h:74
struct Buffer pathbuf
Path of the Mailbox.
Definition mailbox.h:82
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 878 of file pop.c.

879{
880 int i;
881 int j;
882 int rc = 0;
883 char buf[1024] = { 0 };
885#ifdef USE_HCACHE
886 struct HeaderCache *hc = NULL;
887#endif
888
889 adata->check_time = 0;
890
891 int num_deleted = 0;
892 for (i = 0; i < m->msg_count; i++)
893 {
894 if (m->emails[i]->deleted)
895 num_deleted++;
896 }
897
898 while (true)
899 {
900 if (pop_reconnect(m) < 0)
901 return MX_STATUS_ERROR;
902
903#ifdef USE_HCACHE
904 hc = pop_hcache_open(adata, mailbox_path(m));
905#endif
906
907 struct Progress *progress = NULL;
908 if (m->verbose)
909 {
910 progress = progress_new(MUTT_PROGRESS_WRITE, num_deleted);
911 progress_set_message(progress, _("Marking messages deleted..."));
912 }
913
914 for (i = 0, j = 0, rc = 0; (rc == 0) && (i < m->msg_count); i++)
915 {
916 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
917 if (m->emails[i]->deleted && (edata->refno != -1))
918 {
919 j++;
920 progress_update(progress, j, -1);
921 snprintf(buf, sizeof(buf), "DELE %d\r\n", edata->refno);
922 rc = pop_query(adata, buf, sizeof(buf));
923 if (rc == 0)
924 {
925 mutt_bcache_del(adata->bcache, cache_id(edata->uid));
926#ifdef USE_HCACHE
927 hcache_delete_email(hc, edata->uid, strlen(edata->uid));
928#endif
929 }
930 }
931
932#ifdef USE_HCACHE
933 if (m->emails[i]->changed)
934 {
935 hcache_store_email(hc, edata->uid, strlen(edata->uid), m->emails[i], 0);
936 }
937#endif
938 }
939 progress_free(&progress);
940
941#ifdef USE_HCACHE
942 hcache_close(&hc);
943#endif
944
945 if (rc == 0)
946 {
947 mutt_str_copy(buf, "QUIT\r\n", sizeof(buf));
948 rc = pop_query(adata, buf, sizeof(buf));
949 }
950
951 if (rc == 0)
952 {
953 adata->clear_cache = true;
954 pop_clear_cache(adata);
955 adata->status = POP_DISCONNECTED;
956 return MX_STATUS_OK;
957 }
958
959 if (rc == -2)
960 {
961 mutt_error("%s", adata->err_msg);
962 return MX_STATUS_ERROR;
963 }
964 }
965}
int hcache_delete_email(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition hcache.c:769
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:109
@ POP_DISCONNECTED
Disconnected from server.
Definition private.h:49
static void pop_clear_cache(struct PopAccountData *adata)
Delete all cached messages.
Definition pop.c:510
static const char * cache_id(const char *id)
Make a message-cache-compatible id.
Definition pop.c:85
static struct HeaderCache * pop_hcache_open(struct PopAccountData *adata, const char *path)
Open the header cache.
Definition pop.c:316
POP-specific Account data -.
Definition adata.h:37
bool clear_cache
Clear the cache.
Definition adata.h:49
time_t check_time
Last check time.
Definition adata.h:51
char err_msg[POP_CMD_RESPONSE]
Last error message.
Definition adata.h:57
unsigned int status
Connection status.
Definition adata.h:39
struct BodyCache * bcache
body cache
Definition adata.h:56
POP-specific Email data -.
Definition edata.h:32
+ Here is the call graph for this function: