NeoMutt  2025-12-11-694-ga89709
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 590 of file compress.c.

591{
592 if (!m->compress_info)
593 return MX_STATUS_ERROR;
594
595 struct CompressInfo *ci = m->compress_info;
596
597 if (!ci->cmd_close)
598 {
599 mutt_error(_("Can't sync a compressed file without a close-hook"));
600 return MX_STATUS_ERROR;
601 }
602
603 const struct MxOps *ops = ci->child_ops;
604 if (!ops)
605 return MX_STATUS_ERROR;
606
607 if (!lock_realpath(m, true))
608 {
609 mutt_error(_("Unable to lock mailbox"));
610 return MX_STATUS_ERROR;
611 }
612
613 enum MxStatus check = comp_mbox_check(m);
614 if (check != MX_STATUS_OK)
615 goto sync_cleanup;
616
617 check = ops->mbox_sync(m);
618 if (check != MX_STATUS_OK)
619 goto sync_cleanup;
620
621 if (!execute_command(m, ci->cmd_close, _("Compressing %s")))
622 {
623 check = MX_STATUS_ERROR;
624 goto sync_cleanup;
625 }
626
627 check = MX_STATUS_OK;
628
629sync_cleanup:
630 store_size(m);
632 return check;
633}
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:554
#define _(a)
Definition message.h:28
MxStatus
Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()
Definition mxapi.h:59
@ MX_STATUS_ERROR
An error occurred.
Definition mxapi.h:60
@ MX_STATUS_OK
No changes.
Definition mxapi.h:61
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:120
Definition mxapi.h:87
enum MxStatus(* mbox_sync)(struct Mailbox *m)
Definition mxapi.h:183
+ 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 848 of file mailbox.c.

849{
850 enum MxStatus check = maildir_check(m);
851 if (check == MX_STATUS_ERROR)
852 return check;
853
854 struct HeaderCache *hc = maildir_hcache_open(m);
855
856 struct Progress *progress = NULL;
857 if (m->verbose)
858 {
860 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
861 }
862
863 for (int i = 0; i < m->msg_count; i++)
864 {
865 progress_update(progress, i, -1);
866
867 struct Email *e = m->emails[i];
868 if (!maildir_sync_mailbox_message(m, e, hc))
869 {
870 progress_free(&progress);
871 goto err;
872 }
873 }
874 progress_free(&progress);
876
877 /* XXX race condition? */
878
880
881 /* adjust indices */
882
883 if (m->msg_deleted)
884 {
885 const bool c_maildir_trash = cs_subset_bool(NeoMutt->sub, "maildir_trash");
886 for (int i = 0, j = 0; i < m->msg_count; i++)
887 {
888 struct Email *e = m->emails[i];
889 if (!e)
890 break;
891
892 if (!e->deleted || c_maildir_trash)
893 e->index = j++;
894 }
895 }
896
897 return check;
898
899err:
901 return MX_STATUS_ERROR;
902}
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:213
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:545
void maildir_update_mtime(struct Mailbox *m)
Update our record of the Maildir modification time.
Definition mailbox.c:724
bool maildir_sync_mailbox_message(struct Mailbox *m, struct Email *e, struct HeaderCache *hc)
Save changes to the mailbox.
Definition message.c:315
@ 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:87
struct Email ** emails
Array of Emails.
Definition mailbox.h:95
int msg_deleted
Number of deleted messages.
Definition mailbox.h:92
bool verbose
Display status messages?
Definition mailbox.h:116
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 1067 of file mbox.c.

1068{
1070 if (!adata)
1071 return MX_STATUS_ERROR;
1072
1073 struct Buffer *tempfile = NULL;
1074 char buf[32] = { 0 };
1075 int j;
1076 bool unlink_tempfile = false;
1077 bool need_sort = false; /* flag to resort mailbox if new mail arrives */
1078 int first = -1; /* first message to be written */
1079 LOFF_T offset; /* location in mailbox to write changed messages */
1080 struct stat st = { 0 };
1081 struct MUpdate *new_offset = NULL;
1082 struct MUpdate *old_offset = NULL;
1083 FILE *fp = NULL;
1084 struct Progress *progress = NULL;
1085 enum MxStatus rc = MX_STATUS_ERROR;
1086
1087 /* sort message by their position in the mailbox on disk */
1088 const enum EmailSortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
1089 if (c_sort != EMAIL_SORT_UNSORTED)
1090 {
1092 need_sort = true;
1093 }
1094
1095 /* need to open the file for writing in such a way that it does not truncate
1096 * the file, so use read-write mode. */
1097 adata->fp = freopen(mailbox_path(m), "r+", adata->fp);
1098 if (!adata->fp)
1099 {
1100 mx_fastclose_mailbox(m, false);
1101 mutt_error(_("Fatal error! Could not reopen mailbox!"));
1102 goto fatal;
1103 }
1104
1106
1107 if (mbox_lock_mailbox(m, true, true) == -1)
1108 {
1110 mutt_error(_("Unable to lock mailbox"));
1111 goto bail;
1112 }
1113
1114 /* Check to make sure that the file hasn't changed on disk */
1115 enum MxStatus check = mbox_mbox_check(m);
1116 if ((check == MX_STATUS_NEW_MAIL) || (check == MX_STATUS_REOPENED))
1117 {
1118 /* new mail arrived, or mailbox reopened */
1119 rc = check;
1120 goto bail;
1121 }
1122 else if (check < 0)
1123 {
1124 goto fatal;
1125 }
1126
1127 /* Create a temporary file to write the new version of the mailbox in. */
1128 tempfile = buf_pool_get();
1129 buf_mktemp(tempfile);
1130 int fd = open(buf_string(tempfile), O_WRONLY | O_EXCL | O_CREAT, 0600);
1131 if ((fd == -1) || !(fp = fdopen(fd, "w")))
1132 {
1133 if (fd != -1)
1134 {
1135 close(fd);
1136 unlink_tempfile = true;
1137 }
1138 mutt_error(_("Could not create temporary file"));
1139 goto bail;
1140 }
1141 unlink_tempfile = true;
1142
1143 /* find the first deleted/changed message. we save a lot of time by only
1144 * rewriting the mailbox from the point where it has actually changed. */
1145 int i = 0;
1146 for (; (i < m->msg_count) && !m->emails[i]->deleted &&
1147 !m->emails[i]->changed && !m->emails[i]->attach_del;
1148 i++)
1149 {
1150 }
1151 if (i == m->msg_count)
1152 {
1153 /* this means m->changed or m->msg_deleted was set, but no
1154 * messages were found to be changed or deleted. This should
1155 * never happen, is we presume it is a bug in neomutt. */
1156 mutt_error(_("sync: mbox modified, but no modified messages (report this bug)"));
1157 mutt_debug(LL_DEBUG1, "no modified messages\n");
1158 goto bail;
1159 }
1160
1161 /* save the index of the first changed/deleted message */
1162 first = i;
1163 /* where to start overwriting */
1164 offset = m->emails[i]->offset;
1165
1166 /* the offset stored in the header does not include the MMDF_SEP, so make
1167 * sure we seek to the correct location */
1168 if (m->type == MUTT_MMDF)
1169 offset -= (sizeof(MMDF_SEP) - 1);
1170
1171 /* allocate space for the new offsets */
1172 new_offset = MUTT_MEM_CALLOC(m->msg_count - first, struct MUpdate);
1173 old_offset = MUTT_MEM_CALLOC(m->msg_count - first, struct MUpdate);
1174
1175 if (m->verbose)
1176 {
1178 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
1179 }
1180
1181 for (i = first, j = 0; i < m->msg_count; i++)
1182 {
1183 progress_update(progress, i, i / (m->msg_count / 100 + 1));
1184 /* back up some information which is needed to restore offsets when
1185 * something fails. */
1186
1187 old_offset[i - first].valid = true;
1188 old_offset[i - first].hdr = m->emails[i]->offset;
1189 old_offset[i - first].body = m->emails[i]->body->offset;
1190 old_offset[i - first].lines = m->emails[i]->lines;
1191 old_offset[i - first].length = m->emails[i]->body->length;
1192
1193 if (!m->emails[i]->deleted)
1194 {
1195 j++;
1196
1197 if (m->type == MUTT_MMDF)
1198 {
1199 if (fputs(MMDF_SEP, fp) == EOF)
1200 {
1201 mutt_perror("%s", buf_string(tempfile));
1202 goto bail;
1203 }
1204 }
1205
1206 /* save the new offset for this message. we add 'offset' because the
1207 * temporary file only contains saved message which are located after
1208 * 'offset' in the real mailbox */
1209 new_offset[i - first].hdr = ftello(fp) + offset;
1210
1211 struct Message *msg = mx_msg_open(m, m->emails[i]);
1212 const int rc2 = mutt_copy_message(fp, m->emails[i], msg, MUTT_CM_UPDATE,
1214 mx_msg_close(m, &msg);
1215 if (rc2 != 0)
1216 {
1217 mutt_perror("%s", buf_string(tempfile));
1218 goto bail;
1219 }
1220
1221 /* Since messages could have been deleted, the offsets stored in memory
1222 * will be wrong, so update what we can, which is the offset of this
1223 * message, and the offset of the body. If this is a multipart message,
1224 * we just flush the in memory cache so that the message will be reparsed
1225 * if the user accesses it later. */
1226 new_offset[i - first].body = ftello(fp) - m->emails[i]->body->length + offset;
1227 mutt_body_free(&m->emails[i]->body->parts);
1228
1229 if (m->type == MUTT_MMDF)
1230 {
1231 if (fputs(MMDF_SEP, fp) == EOF)
1232 {
1233 mutt_perror("%s", buf_string(tempfile));
1234 goto bail;
1235 }
1236 }
1237 else
1238 {
1239 if (fputs("\n", fp) == EOF)
1240 {
1241 mutt_perror("%s", buf_string(tempfile));
1242 goto bail;
1243 }
1244 }
1245 }
1246 }
1247
1248 if (mutt_file_fclose(&fp) != 0)
1249 {
1250 mutt_debug(LL_DEBUG1, "mutt_file_fclose (&) returned non-zero\n");
1251 mutt_perror("%s", buf_string(tempfile));
1252 goto bail;
1253 }
1254
1255 /* Save the state of this folder. */
1256 if (stat(mailbox_path(m), &st) == -1)
1257 {
1258 mutt_perror("%s", mailbox_path(m));
1259 goto bail;
1260 }
1261
1262 unlink_tempfile = false;
1263
1264 fp = mutt_file_fopen(buf_string(tempfile), "r");
1265 if (!fp)
1266 {
1268 mx_fastclose_mailbox(m, false);
1269 mutt_debug(LL_DEBUG1, "unable to reopen temp copy of mailbox!\n");
1270 mutt_perror("%s", buf_string(tempfile));
1271 FREE(&new_offset);
1272 FREE(&old_offset);
1273 goto fatal;
1274 }
1275
1276 if (!mutt_file_seek(adata->fp, offset, SEEK_SET) || /* seek the append location */
1277 /* do a sanity check to make sure the mailbox looks ok */
1278 !fgets(buf, sizeof(buf), adata->fp) ||
1279 ((m->type == MUTT_MBOX) && !mutt_str_startswith(buf, "From ")) ||
1280 ((m->type == MUTT_MMDF) && !mutt_str_equal(MMDF_SEP, buf)))
1281 {
1282 mutt_debug(LL_DEBUG1, "message not in expected position\n");
1283 mutt_debug(LL_DEBUG1, " LINE: %s\n", buf);
1284 i = -1;
1285 }
1286 else
1287 {
1288 if (!mutt_file_seek(adata->fp, offset, SEEK_SET)) /* return to proper offset */
1289 {
1290 i = -1;
1291 }
1292 else
1293 {
1294 /* copy the temp mailbox back into place starting at the first
1295 * change/deleted message */
1296 if (m->verbose)
1297 mutt_message(_("Committing changes..."));
1298 i = mutt_file_copy_stream(fp, adata->fp);
1299
1300 if (ferror(adata->fp))
1301 i = -1;
1302 }
1303 if (i >= 0)
1304 {
1305 m->size = ftello(adata->fp); /* update the mailbox->size of the mailbox */
1306 if ((m->size < 0) || (ftruncate(fileno(adata->fp), m->size) != 0))
1307 {
1308 i = -1;
1309 mutt_debug(LL_DEBUG1, "ftruncate() failed\n");
1310 }
1311 }
1312 }
1313
1316
1317 if ((mutt_file_fclose(&adata->fp) != 0) || (i == -1))
1318 {
1319 /* error occurred while writing the mailbox back, so keep the temp copy around */
1320
1321 struct Buffer *savefile = buf_pool_get();
1322
1323 const char *const c_tmp_dir = cs_subset_path(NeoMutt->sub, "tmp_dir");
1324 buf_printf(savefile, "%s/neomutt.%s-%s-%u", NONULL(c_tmp_dir),
1325 NONULL(NeoMutt->username), NONULL(ShortHostname), (unsigned int) getpid());
1326 rename(buf_string(tempfile), buf_string(savefile));
1328 mx_fastclose_mailbox(m, false);
1329 pretty_mailbox(savefile);
1330 mutt_error(_("Write failed! Saved partial mailbox to %s"), buf_string(savefile));
1331 buf_pool_release(&savefile);
1332 FREE(&new_offset);
1333 FREE(&old_offset);
1334 goto fatal;
1335 }
1336
1337 /* Restore the previous access/modification times */
1338 mbox_reset_atime(m, &st);
1339
1340 /* reopen the mailbox in read-only mode */
1341 adata->fp = mbox_open_readwrite(m);
1342 if (!adata->fp)
1343 {
1344 adata->fp = mbox_open_readonly(m);
1345 }
1346 if (!adata->fp)
1347 {
1348 unlink(buf_string(tempfile));
1350 mx_fastclose_mailbox(m, false);
1351 mutt_error(_("Fatal error! Could not reopen mailbox!"));
1352 FREE(&new_offset);
1353 FREE(&old_offset);
1354 goto fatal;
1355 }
1356
1357 /* update the offsets of the rewritten messages */
1358 for (i = first, j = first; i < m->msg_count; i++)
1359 {
1360 if (!m->emails[i]->deleted)
1361 {
1362 m->emails[i]->offset = new_offset[i - first].hdr;
1363 m->emails[i]->body->hdr_offset = new_offset[i - first].hdr;
1364 m->emails[i]->body->offset = new_offset[i - first].body;
1365 m->emails[i]->index = j++;
1366 }
1367 }
1368 FREE(&new_offset);
1369 FREE(&old_offset);
1370 unlink(buf_string(tempfile)); /* remove partial copy of the mailbox */
1371 buf_pool_release(&tempfile);
1373
1374 const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
1375 if (c_check_mbox_size)
1376 {
1377 struct Mailbox *m_tmp = mailbox_find(mailbox_path(m));
1378 if (m_tmp && !m_tmp->has_new)
1379 mailbox_update(m_tmp);
1380 }
1381
1382 progress_free(&progress);
1383 return 0; /* signal success */
1384
1385bail: /* Come here in case of disaster */
1386
1387 mutt_file_fclose(&fp);
1388
1389 if (tempfile && unlink_tempfile)
1390 unlink(buf_string(tempfile));
1391
1392 /* restore offsets, as far as they are valid */
1393 if ((first >= 0) && old_offset)
1394 {
1395 for (i = first; (i < m->msg_count) && old_offset[i - first].valid; i++)
1396 {
1397 m->emails[i]->offset = old_offset[i - first].hdr;
1398 m->emails[i]->body->hdr_offset = old_offset[i - first].hdr;
1399 m->emails[i]->body->offset = old_offset[i - first].body;
1400 m->emails[i]->lines = old_offset[i - first].lines;
1401 m->emails[i]->body->length = old_offset[i - first].length;
1402 }
1403 }
1404
1405 /* this is ok to call even if we haven't locked anything */
1407
1409 FREE(&new_offset);
1410 FREE(&old_offset);
1411
1412 adata->fp = freopen(mailbox_path(m), "r", adata->fp);
1413 if (!adata->fp)
1414 {
1415 mutt_error(_("Could not reopen mailbox"));
1416 mx_fastclose_mailbox(m, false);
1417 goto fatal;
1418 }
1419
1421 if (need_sort)
1422 {
1423 /* if the mailbox was reopened, the thread tree will be invalid so make
1424 * sure to start threading from scratch. */
1426 }
1427
1428fatal:
1429 buf_pool_release(&tempfile);
1430 progress_free(&progress);
1431 return rc;
1432}
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_email.c:917
#define MUTT_CM_UPDATE
Update structs on sync.
Definition copy_email.h:42
#define CH_UPDATE
Update the status and x-status fields?
Definition copy_email.h:56
#define CH_FROM
Retain the "From " message separator?
Definition copy_email.h:60
#define CH_UPDATE_LEN
Update Lines: and Content-Length:
Definition copy_email.h:66
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:180
@ NT_MAILBOX_UPDATE
Update internal tables.
Definition mailbox.h:181
@ 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:448
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:139
#define mutt_file_fopen(PATH, MODE)
Definition file.h:138
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:933
@ 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:806
static FILE * mbox_open_readonly(struct Mailbox *m)
Open an mbox read-only.
Definition mbox.c:821
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:751
#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:665
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:1182
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:1136
@ MX_STATUS_REOPENED
Mailbox was reopened.
Definition mxapi.h:64
@ MX_STATUS_NEW_MAIL
New mail received in Mailbox.
Definition mxapi.h:62
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:78
bool has_new
Mailbox has new mail.
Definition mailbox.h:84
enum MailboxType type
Mailbox type.
Definition mailbox.h:101
off_t size
Size of the Mailbox.
Definition mailbox.h:83
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:57
#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 1067 of file mh.c.

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

2566{
2567 struct NntpMboxData *mdata = m->mdata;
2568
2569 /* check for new articles */
2570 mdata->adata->check_time = 0;
2571 enum MxStatus check = check_mailbox(m);
2572 if (check != MX_STATUS_OK)
2573 return check;
2574
2575#ifdef USE_HCACHE
2576 mdata->last_cached = 0;
2577 struct HeaderCache *hc = nntp_hcache_open(mdata);
2578#endif
2579
2580 for (int i = 0; i < m->msg_count; i++)
2581 {
2582 struct Email *e = m->emails[i];
2583 if (!e)
2584 break;
2585
2586 char buf[16] = { 0 };
2587
2588 snprintf(buf, sizeof(buf), ANUM_FMT, nntp_edata_get(e)->article_num);
2589 if (mdata->bcache && e->deleted)
2590 {
2591 mutt_debug(LL_DEBUG2, "mutt_bcache_del %s\n", buf);
2592 mutt_bcache_del(mdata->bcache, buf);
2593 }
2594
2595#ifdef USE_HCACHE
2596 if (hc && (e->changed || e->deleted))
2597 {
2598 if (e->deleted && !e->read)
2599 mdata->unread--;
2600 mutt_debug(LL_DEBUG2, "hcache_store_email %s\n", buf);
2601 hcache_store_email(hc, buf, strlen(buf), e, 0);
2602 }
2603#endif
2604 }
2605
2606#ifdef USE_HCACHE
2607 if (hc)
2608 {
2609 hcache_close(&hc);
2610 mdata->last_cached = mdata->last_loaded;
2611 }
2612#endif
2613
2614 /* save .newsrc entries */
2616 nntp_newsrc_update(mdata->adata);
2617 nntp_newsrc_close(mdata->adata);
2618 return MX_STATUS_OK;
2619}
int mutt_bcache_del(struct BodyCache *bcache, const char *id)
Delete a file from the Body Cache.
Definition bcache.c:274
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:684
@ 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:707
void nntp_newsrc_gen_entries(struct Mailbox *m)
Generate array of .newsrc entries.
Definition newsrc.c:300
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:119
int nntp_newsrc_update(struct NntpAccountData *adata)
Update .newsrc file.
Definition newsrc.c:442
#define ANUM_FMT
Definition lib.h:64
static enum MxStatus check_mailbox(struct Mailbox *m)
Check current newsgroup for new articles.
Definition nntp.c:1492
bool read
Email is read.
Definition email.h:50
void * mdata
Driver specific data.
Definition mailbox.h:131
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 2277 of file notmuch.c.

2278{
2279 struct NmMboxData *mdata = nm_mdata_get(m);
2280 if (!mdata)
2281 return MX_STATUS_ERROR;
2282
2283 enum MxStatus rc = MX_STATUS_OK;
2284 struct Progress *progress = NULL;
2285 char *url = mutt_str_dup(mailbox_path(m));
2286 bool changed = false;
2287
2288 mutt_debug(LL_DEBUG1, "nm: sync start\n");
2289
2290 if (m->verbose)
2291 {
2292 /* all is in this function so we don't use data->progress here */
2294 progress_set_message(progress, _("Writing %s..."), mailbox_path(m));
2295 }
2296
2297 struct HeaderCache *hc = nm_hcache_open(m);
2298
2299 /* Iterate through all messages, syncing flag changes to the underlying
2300 * maildir/mh files and updating the notmuch database for renames/deletes */
2301 int mh_sync_errors = 0;
2302 for (int i = 0; i < m->msg_count; i++)
2303 {
2304 char old_file[PATH_MAX], new_file[PATH_MAX];
2305 struct Email *e = m->emails[i];
2306 if (!e)
2307 break;
2308
2309 struct NmEmailData *edata = nm_edata_get(e);
2310 if (!edata)
2311 continue;
2312
2313 progress_update(progress, i, -1);
2314
2315 *old_file = '\0';
2316 *new_file = '\0';
2317
2318 if (edata->oldpath)
2319 {
2320 mutt_str_copy(old_file, edata->oldpath, sizeof(old_file));
2321 mutt_debug(LL_DEBUG2, "nm: fixing obsolete path '%s'\n", old_file);
2322 }
2323 else
2324 {
2325 email_get_fullpath(e, old_file, sizeof(old_file));
2326 }
2327
2328 /* Temporarily set mailbox path and type to the message's backing
2329 * maildir folder so maildir_sync_mailbox_message() can operate */
2330 buf_strcpy(&m->pathbuf, edata->folder);
2331 m->type = edata->type;
2332
2333 bool ok = maildir_sync_mailbox_message(m, e, hc);
2334 if (!ok)
2335 {
2336 /* Syncing file failed, query notmuch for an updated filepath
2337 * (another process may have moved the message on disk) */
2338 m->type = MUTT_NOTMUCH;
2339 notmuch_database_t *db = nm_db_get(m, true);
2340 if (db)
2341 {
2342 notmuch_message_t *msg = get_nm_message(db, e);
2343
2345
2346 buf_strcpy(&m->pathbuf, edata->folder);
2347 m->type = edata->type;
2348 ok = maildir_sync_mailbox_message(m, e, hc);
2349 m->type = MUTT_NOTMUCH;
2350 }
2351 nm_db_release(m);
2352 m->type = edata->type;
2353 }
2354
2355 /* Restore the virtual notmuch mailbox path */
2356 buf_strcpy(&m->pathbuf, url);
2357 m->type = MUTT_NOTMUCH;
2358
2359 if (!ok)
2360 {
2361 mh_sync_errors += 1;
2362 continue;
2363 }
2364
2365 /* If the message was deleted or its file was renamed (e.g. flag change),
2366 * update the notmuch database to reflect the new state */
2367 if (!e->deleted)
2368 email_get_fullpath(e, new_file, sizeof(new_file));
2369
2370 if (e->deleted || !mutt_str_equal(old_file, new_file))
2371 {
2372 if (e->deleted && (remove_filename(m, old_file) == 0))
2373 changed = true;
2374 else if (*new_file && *old_file && (rename_filename(m, old_file, new_file, e) == 0))
2375 changed = true;
2376 }
2377
2378 FREE(&edata->oldpath);
2379 }
2380
2381 if (mh_sync_errors > 0)
2382 {
2383 mutt_error(ngettext("Unable to sync %d message due to external mailbox modification",
2384 "Unable to sync %d messages due to external mailbox modification",
2385 mh_sync_errors),
2386 mh_sync_errors);
2387 rc = MX_STATUS_ERROR;
2388 }
2389
2390 buf_strcpy(&m->pathbuf, url);
2391 m->type = MUTT_NOTMUCH;
2392
2393 nm_db_release(m);
2394
2395 if (changed)
2396 {
2397 mdata->mtime.tv_sec = mutt_date_now();
2398 mdata->mtime.tv_nsec = 0;
2399 }
2400
2401 nm_hcache_close(&hc);
2402
2403 progress_free(&progress);
2404 FREE(&url);
2405 mutt_debug(LL_DEBUG1, "nm: .... sync done [rc=%d]\n", rc);
2406 return rc;
2407}
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:50
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition date.c:457
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:586
#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: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: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:79
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 865 of file pop.c.

866{
867 int i, j, rc = 0;
868 char buf[1024] = { 0 };
870#ifdef USE_HCACHE
871 struct HeaderCache *hc = NULL;
872#endif
873
874 adata->check_time = 0;
875
876 int num_deleted = 0;
877 for (i = 0; i < m->msg_count; i++)
878 {
879 if (m->emails[i]->deleted)
880 num_deleted++;
881 }
882
883 while (true)
884 {
885 if (pop_reconnect(m) < 0)
886 return MX_STATUS_ERROR;
887
888#ifdef USE_HCACHE
889 hc = pop_hcache_open(adata, mailbox_path(m));
890#endif
891
892 struct Progress *progress = NULL;
893 if (m->verbose)
894 {
895 progress = progress_new(MUTT_PROGRESS_WRITE, num_deleted);
896 progress_set_message(progress, _("Marking messages deleted..."));
897 }
898
899 for (i = 0, j = 0, rc = 0; (rc == 0) && (i < m->msg_count); i++)
900 {
901 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
902 if (m->emails[i]->deleted && (edata->refno != -1))
903 {
904 j++;
905 progress_update(progress, j, -1);
906 snprintf(buf, sizeof(buf), "DELE %d\r\n", edata->refno);
907 rc = pop_query(adata, buf, sizeof(buf));
908 if (rc == 0)
909 {
910 mutt_bcache_del(adata->bcache, cache_id(edata->uid));
911#ifdef USE_HCACHE
912 hcache_delete_email(hc, edata->uid, strlen(edata->uid));
913#endif
914 }
915 }
916
917#ifdef USE_HCACHE
918 if (m->emails[i]->changed)
919 {
920 hcache_store_email(hc, edata->uid, strlen(edata->uid), m->emails[i], 0);
921 }
922#endif
923 }
924 progress_free(&progress);
925
926#ifdef USE_HCACHE
927 hcache_close(&hc);
928#endif
929
930 if (rc == 0)
931 {
932 mutt_str_copy(buf, "QUIT\r\n", sizeof(buf));
933 rc = pop_query(adata, buf, sizeof(buf));
934 }
935
936 if (rc == 0)
937 {
938 adata->clear_cache = true;
939 pop_clear_cache(adata);
940 adata->status = POP_DISCONNECTED;
941 return MX_STATUS_OK;
942 }
943
944 if (rc == -2)
945 {
946 mutt_error("%s", adata->err_msg);
947 return MX_STATUS_ERROR;
948 }
949 }
950}
int hcache_delete_email(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition hcache.c:753
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:498
static const char * cache_id(const char *id)
Make a message-cache-compatible id.
Definition pop.c:80
static struct HeaderCache * pop_hcache_open(struct PopAccountData *adata, const char *path)
Open the header cache.
Definition pop.c:305
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: