NeoMutt  2019-11-11
Teaching an old dog new tricks
DOXYGEN
mutt_parse.c File Reference

Miscellaneous email parsing routines. More...

#include "config.h"
#include <regex.h>
#include <stdbool.h>
#include <stdio.h>
#include "mutt/mutt.h"
#include "email/lib.h"
#include "mutt_parse.h"
#include "mx.h"
#include "ncrypt/ncrypt.h"
+ Include dependency graph for mutt_parse.c:

Go to the source code of this file.

Functions

void mutt_parse_mime_message (struct Mailbox *m, struct Email *e)
 Parse a MIME email. More...
 
static bool count_body_parts_check (struct ListHead *checklist, struct Body *b, bool dflt)
 Compares mime types to the ok and except lists. More...
 
static int count_body_parts (struct Body *body)
 Count the MIME Body parts. More...
 
int mutt_count_body_parts (struct Mailbox *m, struct Email *e)
 Count the MIME Body parts. More...
 

Variables

struct ListHead AttachAllow = STAILQ_HEAD_INITIALIZER(AttachAllow)
 List of attachment types to be counted. More...
 
struct ListHead AttachExclude = STAILQ_HEAD_INITIALIZER(AttachExclude)
 List of attachment types to be ignored. More...
 
struct ListHead InlineAllow = STAILQ_HEAD_INITIALIZER(InlineAllow)
 List of inline types to counted. More...
 
struct ListHead InlineExclude = STAILQ_HEAD_INITIALIZER(InlineExclude)
 List of inline types to ignore. More...
 

Detailed Description

Miscellaneous email parsing routines.

Authors
  • Michael R. Elkins

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 mutt_parse.c.

Function Documentation

◆ mutt_parse_mime_message()

void mutt_parse_mime_message ( struct Mailbox m,
struct Email e 
)

Parse a MIME email.

Parameters
mMailbox
eEmail

Definition at line 49 of file mutt_parse.c.

50 {
51  do
52  {
53  if ((e->content->type != TYPE_MESSAGE) && (e->content->type != TYPE_MULTIPART))
54  break; /* nothing to do */
55 
56  if (e->content->parts)
57  break; /* The message was parsed earlier. */
58 
59  struct Message *msg = mx_msg_open(m, e->msgno);
60  if (msg)
61  {
62  mutt_parse_part(msg->fp, e->content);
63 
64  if (WithCrypto)
65  e->security = crypt_query(e->content);
66 
67  mx_msg_close(m, &msg);
68  }
69  } while (false);
70 
71  e->attach_valid = false;
72 }
struct Body * content
List of MIME parts.
Definition: email.h:90
int mx_msg_close(struct Mailbox *m, struct Message **msg)
Close a message.
Definition: mx.c:1101
A local copy of an email.
Definition: mx.h:81
struct Body * parts
parts of a multipart or message/rfc822
Definition: body.h:54
bool attach_valid
true when the attachment count is valid
Definition: email.h:70
SecurityFlags security
bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/ncrypt.h pgplib.h, smime.h
Definition: email.h:39
unsigned int type
content-type primary type
Definition: body.h:65
Type: &#39;message/*&#39;.
Definition: mime.h:35
void mutt_parse_part(FILE *fp, struct Body *b)
Parse a MIME part.
Definition: parse.c:1404
Type: &#39;multipart/*&#39;.
Definition: mime.h:37
FILE * fp
pointer to the message data
Definition: mx.h:83
#define WithCrypto
Definition: ncrypt.h:160
SecurityFlags crypt_query(struct Body *m)
Check out the type of encryption used.
Definition: crypt.c:694
struct Message * mx_msg_open(struct Mailbox *m, int msgno)
return a stream pointer for a message
Definition: mx.c:1053
int msgno
Number displayed to the user.
Definition: email.h:86
+ Here is the caller graph for this function:

◆ count_body_parts_check()

static bool count_body_parts_check ( struct ListHead *  checklist,
struct Body b,
bool  dflt 
)
static

Compares mime types to the ok and except lists.

Parameters
checklistList of AttachMatch
bEmail Body
dfltLog whether the matches are OK, or Excluded
Return values
trueAttachment should be counted

Definition at line 81 of file mutt_parse.c.

82 {
83  struct AttachMatch *a = NULL;
84 
85  /* If list is null, use default behavior. */
86  if (!checklist || STAILQ_EMPTY(checklist))
87  {
88  return false;
89  }
90 
91  struct ListNode *np = NULL;
92  STAILQ_FOREACH(np, checklist, entries)
93  {
94  a = (struct AttachMatch *) np->data;
95  mutt_debug(LL_DEBUG3, "%s %d/%s ?? %s/%s [%d]... ", dflt ? "[OK] " : "[EXCL] ",
96  b->type, b->subtype ? b->subtype : "*", a->major, a->minor, a->major_int);
97  if (((a->major_int == TYPE_ANY) || (a->major_int == b->type)) &&
98  (!b->subtype || !regexec(&a->minor_regex, b->subtype, 0, NULL, 0)))
99  {
100  mutt_debug(LL_DEBUG3, "yes\n");
101  return true;
102  }
103  else
104  {
105  mutt_debug(LL_DEBUG3, "no\n");
106  }
107  }
108 
109  return false;
110 }
enum ContentType major_int
Definition: mutt_parse.h:38
Type: &#39;*&#39; or &#39;.*&#39;.
Definition: mime.h:40
const char * major
Definition: mutt_parse.h:37
char * subtype
content-type subtype
Definition: body.h:37
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:350
unsigned int type
content-type primary type
Definition: body.h:65
char * data
String.
Definition: list.h:35
regex_t minor_regex
Definition: mutt_parse.h:40
#define STAILQ_EMPTY(head)
Definition: queue.h:346
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
An attachment matching a regex for attachment counter.
Definition: mutt_parse.h:35
A List node for strings.
Definition: list.h:33
const char * minor
Definition: mutt_parse.h:39
Log at debug level 3.
Definition: logging.h:58
+ Here is the caller graph for this function:

◆ count_body_parts()

static int count_body_parts ( struct Body body)
static

Count the MIME Body parts.

Parameters
bodyBody of email
Return values
numNumber of MIME Body parts

Definition at line 117 of file mutt_parse.c.

118 {
119  if (!body)
120  return 0;
121 
122  int count = 0;
123 
124  for (struct Body *bp = body; bp; bp = bp->next)
125  {
126  /* Initial disposition is to count and not to recurse this part. */
127  bool shallcount = true; /* default */
128  bool shallrecurse = false;
129 
130  mutt_debug(LL_DEBUG5, "desc=\"%s\"; fn=\"%s\", type=\"%d/%s\"\n",
131  bp->description ? bp->description : ("none"),
132  bp->filename ? bp->filename : bp->d_filename ? bp->d_filename : "(none)",
133  bp->type, bp->subtype ? bp->subtype : "*");
134 
135  if (bp->type == TYPE_MESSAGE)
136  {
137  shallrecurse = true;
138 
139  /* If it's an external body pointer, don't recurse it. */
140  if (mutt_str_strcasecmp(bp->subtype, "external-body") == 0)
141  shallrecurse = false;
142  }
143  else if (bp->type == TYPE_MULTIPART)
144  {
145  /* Always recurse multiparts, except multipart/alternative. */
146  shallrecurse = true;
147  if (mutt_str_strcasecmp(bp->subtype, "alternative") == 0)
148  shallrecurse = false;
149  }
150 
151  if ((bp->disposition == DISP_INLINE) && (bp->type != TYPE_MULTIPART) &&
152  (bp->type != TYPE_MESSAGE) && (bp == body))
153  {
154  shallcount = false; /* ignore fundamental inlines */
155  }
156 
157  /* If this body isn't scheduled for enumeration already, don't bother
158  * profiling it further. */
159  if (shallcount)
160  {
161  /* Turn off shallcount if message type is not in ok list,
162  * or if it is in except list. Check is done separately for
163  * inlines vs. attachments. */
164 
165  if (bp->disposition == DISP_ATTACH)
166  {
167  if (!count_body_parts_check(&AttachAllow, bp, true))
168  shallcount = false; /* attach not allowed */
169  if (count_body_parts_check(&AttachExclude, bp, false))
170  shallcount = false; /* attach excluded */
171  }
172  else
173  {
174  if (!count_body_parts_check(&InlineAllow, bp, true))
175  shallcount = false; /* inline not allowed */
176  if (count_body_parts_check(&InlineExclude, bp, false))
177  shallcount = false; /* excluded */
178  }
179  }
180 
181  if (shallcount)
182  count++;
183  bp->attach_qualifies = shallcount;
184 
185  mutt_debug(LL_DEBUG3, "%p shallcount = %d\n", (void *) bp, shallcount);
186 
187  if (shallrecurse)
188  {
189  mutt_debug(LL_DEBUG3, "%p pre count = %d\n", (void *) bp, count);
190  bp->attach_count = count_body_parts(bp->parts);
191  count += bp->attach_count;
192  mutt_debug(LL_DEBUG3, "%p post count = %d\n", (void *) bp, count);
193  }
194  }
195 
196  mutt_debug(LL_DEBUG3, "return %d\n", (count < 0) ? 0 : count);
197  return (count < 0) ? 0 : count;
198 }
static bool count_body_parts_check(struct ListHead *checklist, struct Body *b, bool dflt)
Compares mime types to the ok and except lists.
Definition: mutt_parse.c:81
struct ListHead InlineAllow
List of inline types to counted.
Definition: mutt_parse.c:41
struct Body * next
next attachment in the list
Definition: body.h:53
static int count_body_parts(struct Body *body)
Count the MIME Body parts.
Definition: mutt_parse.c:117
The body of an email.
Definition: body.h:34
Content is attached.
Definition: mime.h:63
struct ListHead InlineExclude
List of inline types to ignore.
Definition: mutt_parse.c:42
Type: &#39;message/*&#39;.
Definition: mime.h:35
struct ListHead AttachExclude
List of attachment types to be ignored.
Definition: mutt_parse.c:40
Type: &#39;multipart/*&#39;.
Definition: mime.h:37
int mutt_str_strcasecmp(const char *a, const char *b)
Compare two strings ignoring case, safely.
Definition: string.c:628
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
Log at debug level 5.
Definition: logging.h:60
Content is inline.
Definition: mime.h:62
struct ListHead AttachAllow
List of attachment types to be counted.
Definition: mutt_parse.c:39
Log at debug level 3.
Definition: logging.h:58
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_count_body_parts()

int mutt_count_body_parts ( struct Mailbox m,
struct Email e 
)

Count the MIME Body parts.

Parameters
mMailbox
eEmail
Return values
numNumber of MIME Body parts

Definition at line 206 of file mutt_parse.c.

207 {
208  bool keep_parts = false;
209 
210  if (e->attach_valid)
211  return e->attach_total;
212 
213  if (e->content->parts)
214  keep_parts = true;
215  else
217 
220  {
222  }
223  else
224  e->attach_total = 0;
225 
226  e->attach_valid = true;
227 
228  if (!keep_parts)
230 
231  return e->attach_total;
232 }
struct ListHead InlineAllow
List of inline types to counted.
Definition: mutt_parse.c:41
struct Body * content
List of MIME parts.
Definition: email.h:90
void mutt_parse_mime_message(struct Mailbox *m, struct Email *e)
Parse a MIME email.
Definition: mutt_parse.c:49
static int count_body_parts(struct Body *body)
Count the MIME Body parts.
Definition: mutt_parse.c:117
short attach_total
Number of qualifying attachments in message, if attach_valid.
Definition: email.h:96
struct ListHead InlineExclude
List of inline types to ignore.
Definition: mutt_parse.c:42
struct Body * parts
parts of a multipart or message/rfc822
Definition: body.h:54
bool attach_valid
true when the attachment count is valid
Definition: email.h:70
struct ListHead AttachExclude
List of attachment types to be ignored.
Definition: mutt_parse.c:40
#define STAILQ_EMPTY(head)
Definition: queue.h:346
void mutt_body_free(struct Body **ptr)
Free a Body.
Definition: body.c:57
struct ListHead AttachAllow
List of attachment types to be counted.
Definition: mutt_parse.c:39
+ Here is the caller graph for this function:

Variable Documentation

◆ AttachAllow

struct ListHead AttachAllow = STAILQ_HEAD_INITIALIZER(AttachAllow)

List of attachment types to be counted.

Definition at line 39 of file mutt_parse.c.

◆ AttachExclude

struct ListHead AttachExclude = STAILQ_HEAD_INITIALIZER(AttachExclude)

List of attachment types to be ignored.

Definition at line 40 of file mutt_parse.c.

◆ InlineAllow

struct ListHead InlineAllow = STAILQ_HEAD_INITIALIZER(InlineAllow)

List of inline types to counted.

Definition at line 41 of file mutt_parse.c.

◆ InlineExclude

struct ListHead InlineExclude = STAILQ_HEAD_INITIALIZER(InlineExclude)

List of inline types to ignore.

Definition at line 42 of file mutt_parse.c.