NeoMutt  2022-04-29-215-gc12b98
Teaching an old dog new tricks
DOXYGEN
editmsg.c File Reference

Prepare an email to be edited. More...

#include "config.h"
#include <errno.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "copy.h"
#include "muttlib.h"
#include "mx.h"
#include "protos.h"
+ Include dependency graph for editmsg.c:

Go to the source code of this file.

Functions

static int ev_message (enum EvMessage action, struct Mailbox *m, struct Email *e)
 Edit an email or view it in an external editor. More...
 
int mutt_ev_message (struct Mailbox *m, struct EmailList *el, enum EvMessage action)
 Edit or view a message. More...
 

Detailed Description

Prepare an email to be edited.

Authors
  • Thomas Roessler

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file editmsg.c.

Function Documentation

◆ ev_message()

static int ev_message ( enum EvMessage  action,
struct Mailbox m,
struct Email e 
)
static

Edit an email or view it in an external editor.

Parameters
actionAction to perform, e.g. EVM_EDIT
mMailbox
eEmail
Return values
1Message not modified
0Message edited successfully
-1Error

Definition at line 56 of file editmsg.c.

57{
58 char buf[256] = { 0 };
59 int rc;
60 FILE *fp = NULL;
61 struct stat st = { 0 };
62 bool old_append = m->append;
63
64 struct Buffer *fname = mutt_buffer_pool_get();
65 mutt_buffer_mktemp(fname);
66
67 // Temporarily force $mbox_type to be MUTT_MBOX
68 const unsigned char c_mbox_type = cs_subset_enum(NeoMutt->sub, "mbox_type");
69 cs_subset_str_native_set(NeoMutt->sub, "mbox_type", MUTT_MBOX, NULL);
70
71 struct Mailbox *m_fname = mx_path_resolve(mutt_buffer_string(fname));
72 if (!mx_mbox_open(m_fname, MUTT_NEWFOLDER))
73 {
74 mutt_error(_("could not create temporary folder: %s"), strerror(errno));
76 mailbox_free(&m_fname);
77 return -1;
78 }
79
80 cs_subset_str_native_set(NeoMutt->sub, "mbox_type", c_mbox_type, NULL);
81
82 const CopyHeaderFlags chflags = CH_NOLEN |
83 (((m->type == MUTT_MBOX) || (m->type == MUTT_MMDF)) ?
86 rc = mutt_append_message(m_fname, m, e, NULL, MUTT_CM_NO_FLAGS, chflags);
87 int oerrno = errno;
88
89 mx_mbox_close(m_fname);
90 mailbox_free(&m_fname);
91
92 if (rc == -1)
93 {
94 mutt_error(_("could not write temporary mail folder: %s"), strerror(oerrno));
95 goto bail;
96 }
97
98 rc = stat(mutt_buffer_string(fname), &st);
99 if (rc == -1)
100 {
101 mutt_error(_("Can't stat %s: %s"), mutt_buffer_string(fname), strerror(errno));
102 goto bail;
103 }
104
105 /* The file the user is going to edit is not a real mbox, so we need to
106 * truncate the last newline in the temp file, which is logically part of
107 * the message separator, and not the body of the message. If we fail to
108 * remove it, the message will grow by one line each time the user edits
109 * the message. */
110 if ((st.st_size != 0) && (truncate(mutt_buffer_string(fname), st.st_size - 1) == -1))
111 {
112 rc = -1;
113 mutt_error(_("could not truncate temporary mail folder: %s"), strerror(errno));
114 goto bail;
115 }
116
117 if (action == EVM_VIEW)
118 {
119 /* remove write permissions */
121 S_IWUSR | S_IWGRP | S_IWOTH, &st);
122 if (rc == -1)
123 {
124 mutt_debug(LL_DEBUG1, "Could not remove write permissions of %s: %s",
125 mutt_buffer_string(fname), strerror(errno));
126 /* Do not bail out here as we are checking afterwards if we should adopt
127 * changes of the temporary file. */
128 }
129 }
130
131 /* re-stat after the truncate, to avoid false "modified" bugs */
132 rc = stat(mutt_buffer_string(fname), &st);
133 if (rc == -1)
134 {
135 mutt_error(_("Can't stat %s: %s"), mutt_buffer_string(fname), strerror(errno));
136 goto bail;
137 }
138
139 /* Do not reuse the stat st here as it is outdated. */
141 if (mtime == (time_t) -1)
142 {
143 rc = -1;
145 goto bail;
146 }
147
148 const char *const c_editor = cs_subset_string(NeoMutt->sub, "editor");
149 mutt_edit_file(NONULL(c_editor), mutt_buffer_string(fname));
150
151 rc = stat(mutt_buffer_string(fname), &st);
152 if (rc == -1)
153 {
154 mutt_error(_("Can't stat %s: %s"), mutt_buffer_string(fname), strerror(errno));
155 goto bail;
156 }
157
158 if (st.st_size == 0)
159 {
160 mutt_message(_("Message file is empty"));
161 rc = 1;
162 goto bail;
163 }
164
165 if ((action == EVM_EDIT) && (st.st_mtime == mtime))
166 {
167 mutt_message(_("Message not modified"));
168 rc = 1;
169 goto bail;
170 }
171
172 if ((action == EVM_VIEW) && (st.st_mtime != mtime))
173 {
174 mutt_message(_("Message of read-only mailbox modified! Ignoring changes."));
175 rc = 1;
176 goto bail;
177 }
178
179 if (action == EVM_VIEW)
180 {
181 /* stop processing here and skip right to the end */
182 rc = 1;
183 goto bail;
184 }
185
186 fp = fopen(mutt_buffer_string(fname), "r");
187 if (!fp)
188 {
189 rc = -1;
190 mutt_error(_("Can't open message file: %s"), strerror(errno));
191 goto bail;
192 }
193
195 {
196 rc = -1;
197 /* L10N: %s is from strerror(errno) */
198 mutt_error(_("Can't append to folder: %s"), strerror(errno));
199 goto bail;
200 }
202 CopyHeaderFlags cf = (((m->type == MUTT_MBOX) || (m->type == MUTT_MMDF)) ? CH_NO_FLAGS : CH_NOSTATUS);
203
204 if (fgets(buf, sizeof(buf), fp) && is_from(buf, NULL, 0, NULL))
205 {
206 if ((m->type == MUTT_MBOX) || (m->type == MUTT_MMDF))
207 cf = CH_FROM | CH_FORCE_FROM;
208 }
209 else
210 of = MUTT_ADD_FROM;
211
212 /* XXX - we have to play games with the message flags to avoid
213 * problematic behavior with maildir folders. */
214
215 bool o_read = e->read;
216 bool o_old = e->old;
217 e->read = false;
218 e->old = false;
219 struct Message *msg = mx_msg_open_new(m, e, of);
220 e->read = o_read;
221 e->old = o_old;
222
223 if (!msg)
224 {
225 rc = -1;
226 mutt_error(_("Can't append to folder: %s"), strerror(errno));
227 mx_mbox_close(m);
228 goto bail;
229 }
230
231 rc = mutt_copy_hdr(fp, msg->fp, 0, st.st_size, CH_NOLEN | cf, NULL, 0);
232 if (rc == 0)
233 {
234 fputc('\n', msg->fp);
236 }
237
238 rc = mx_msg_commit(m, msg);
239 mx_msg_close(m, &msg);
240
241 mx_mbox_close(m);
242
243bail:
245
246 if (rc >= 0)
247 unlink(mutt_buffer_string(fname));
248
249 if (rc == 0)
250 {
251 mutt_set_flag(m, e, MUTT_DELETE, true);
252 mutt_set_flag(m, e, MUTT_PURGE, true);
253 mutt_set_flag(m, e, MUTT_READ, true);
254
255 const bool c_delete_untag = cs_subset_bool(NeoMutt->sub, "delete_untag");
256 if (c_delete_untag)
257 mutt_set_flag(m, e, MUTT_TAG, false);
258 }
259 else if (rc == -1)
260 mutt_message(_("Error. Preserving temporary file: %s"), mutt_buffer_string(fname));
261
262 m->append = old_append;
263
265 return rc;
266}
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:317
unsigned char cs_subset_enum(const struct ConfigSubset *sub, const char *name)
Get a enumeration config item by name.
Definition: helpers.c:97
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
int mutt_append_message(struct Mailbox *m_dst, struct Mailbox *m_src, struct Email *e, struct Message *msg, CopyMessageFlags cmflags, CopyHeaderFlags chflags)
Append a message.
Definition: copy.c:939
int mutt_copy_hdr(FILE *fp_in, FILE *fp_out, LOFF_T off_start, LOFF_T off_end, CopyHeaderFlags chflags, const char *prefix, int wraplen)
Copy header from one file to another.
Definition: copy.c:104
#define CH_NOSTATUS
Suppress the status and x-status fields.
Definition: copy.h:58
#define CH_FROM
Retain the "From " message separator?
Definition: copy.h:56
uint32_t CopyHeaderFlags
Flags for mutt_copy_header(), e.g. CH_UPDATE.
Definition: copy.h:50
#define CH_FORCE_FROM
Give CH_FROM precedence over CH_WEED?
Definition: copy.h:66
#define MUTT_CM_NO_FLAGS
No flags are set.
Definition: copy.h:35
#define CH_NO_FLAGS
No flags are set.
Definition: copy.h:51
#define CH_NOLEN
Don't write Content-Length: and Lines:
Definition: copy.h:64
void mutt_edit_file(const char *editor, const char *file)
Let the user edit a file.
Definition: curs_lib.c:312
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition: file.c:260
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:152
time_t mutt_file_decrease_mtime(const char *fp, struct stat *st)
Decrease a file's modification time by 1 second.
Definition: file.c:1019
int mutt_file_chmod_rm_stat(const char *path, mode_t mode, struct stat *st)
Remove permissions from a file.
Definition: file.c:1202
bool is_from(const char *s, char *path, size_t pathlen, time_t *tp)
Is a string a 'From' header line?
Definition: from.c:48
#define mutt_error(...)
Definition: logging.h:87
#define mutt_message(...)
Definition: logging.h:86
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
#define mutt_perror(...)
Definition: logging.h:88
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
void mailbox_free(struct Mailbox **ptr)
Free a Mailbox.
Definition: mailbox.c:87
@ MUTT_MMDF
'mmdf' Mailbox type
Definition: mailbox.h:46
@ MUTT_MBOX
'mbox' Mailbox type
Definition: mailbox.h:45
#define _(a)
Definition: message.h:28
@ MUTT_READ
Messages that have been read.
Definition: mutt.h:93
@ MUTT_PURGE
Messages to be purged (bypass trash)
Definition: mutt.h:97
@ MUTT_TAG
Tagged messages.
Definition: mutt.h:100
@ MUTT_DELETE
Messages to be deleted.
Definition: mutt.h:95
#define mutt_buffer_mktemp(buf)
Definition: muttlib.h:74
int mx_msg_close(struct Mailbox *m, struct Message **msg)
Close a message.
Definition: mx.c:1193
bool mx_mbox_open(struct Mailbox *m, OpenMailboxFlags flags)
Open a mailbox and parse it.
Definition: mx.c:304
struct Message * mx_msg_open_new(struct Mailbox *m, const struct Email *e, MsgOpenFlags flags)
Open a new message.
Definition: mx.c:1057
int mx_msg_commit(struct Mailbox *m, struct Message *msg)
Commit a message to a folder - Wrapper for MxOps::msg_commit()
Definition: mx.c:1172
struct Mailbox * mx_path_resolve(const char *path)
Get a Mailbox for a path.
Definition: mx.c:1677
enum MxStatus mx_mbox_close(struct Mailbox *m)
Save changes and close mailbox.
Definition: mx.c:615
uint8_t MsgOpenFlags
Flags for mx_msg_open_new(), e.g. MUTT_ADD_FROM.
Definition: mx.h:41
#define MUTT_ADD_FROM
add a From_ line
Definition: mx.h:43
#define MUTT_MSG_NO_FLAGS
No flags are set.
Definition: mx.h:42
#define MUTT_NEWFOLDER
Create a new folder - same as MUTT_APPEND, but uses mutt_file_fopen() with mode "w" for mbox-style fo...
Definition: mxapi.h:66
#define MUTT_APPEND
Open mailbox for appending messages.
Definition: mxapi.h:63
#define MUTT_QUIET
Do not print any messages.
Definition: mxapi.h:65
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
@ EVM_VIEW
View the message.
Definition: protos.h:52
@ EVM_EDIT
Edit the message.
Definition: protos.h:53
#define mutt_set_flag(m, e, flag, bf)
Definition: protos.h:63
#define NONULL(x)
Definition: string2.h:37
String manipulation buffer.
Definition: buffer.h:34
bool read
Email is read.
Definition: email.h:48
bool old
Email is seen, but unread.
Definition: email.h:47
A mailbox.
Definition: mailbox.h:79
struct timespec mtime
Time Mailbox was last changed.
Definition: mailbox.h:104
bool append
Mailbox is opened in append mode.
Definition: mailbox.h:109
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
A local copy of an email.
Definition: mxapi.h:43
FILE * fp
pointer to the message data
Definition: mxapi.h:44
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
int cs_subset_str_native_set(const struct ConfigSubset *sub, const char *name, intptr_t value, struct Buffer *err)
Natively set the value of a string config item.
Definition: subset.c:305
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_ev_message()

int mutt_ev_message ( struct Mailbox m,
struct EmailList *  el,
enum EvMessage  action 
)

Edit or view a message.

Parameters
mMailbox
elList of Emails
actionAction to perform, e.g. EVM_EDIT
Return values
1Message not modified
0Message edited successfully
-1Error

Definition at line 277 of file editmsg.c.

278{
279 struct EmailNode *en = NULL;
280 STAILQ_FOREACH(en, el, entries)
281 {
282 if (ev_message(action, m, en->email) == -1)
283 return -1;
284 }
285
286 return 0;
287}
static int ev_message(enum EvMessage action, struct Mailbox *m, struct Email *e)
Edit an email or view it in an external editor.
Definition: editmsg.c:56
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
List of Emails.
Definition: email.h:131
struct Email * email
Email in the list.
Definition: email.h:132
+ Here is the call graph for this function:
+ Here is the caller graph for this function: