NeoMutt
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h File Reference

Match patterns to emails. More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "mutt.h"
#include "complete/lib.h"
#include "search_state.h"
+ Include dependency graph for lib.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Pattern
 A simple (non-regex) pattern. More...
 
struct  PatternCache
 Cache commonly-used patterns. More...
 

Macros

#define MUTT_ALIAS_SIMPLESEARCH   "~f %s | ~t %s | ~c %s"
 
#define MUTT_PC_NO_FLAGS   0
 No flags are set.
 
#define MUTT_PC_FULL_MSG   (1 << 0)
 Enable body and header matching.
 
#define MUTT_PC_PATTERN_DYNAMIC   (1 << 1)
 Enable runtime date range evaluation.
 
#define MUTT_PC_SEND_MODE_SEARCH   (1 << 2)
 Allow send-mode body searching.
 
#define MUTT_PAT_EXEC_NO_FLAGS   0
 No flags are set.
 
#define MUTT_MATCH_FULL_ADDRESS   (1 << 0)
 Match the full address.
 

Typedefs

typedef uint8_t PatternCompFlags
 Flags for mutt_pattern_comp(), e.g. MUTT_PC_FULL_MSG.
 
typedef uint8_t PatternExecFlags
 Flags for mutt_pattern_exec(), e.g. MUTT_MATCH_FULL_ADDRESS.
 

Enumerations

enum  PatternType {
  MUTT_PAT_AND = MUTT_MT_MAX , MUTT_PAT_OR , MUTT_PAT_THREAD , MUTT_PAT_PARENT ,
  MUTT_PAT_CHILDREN , MUTT_PAT_TO , MUTT_PAT_CC , MUTT_PAT_BCC ,
  MUTT_PAT_COLLAPSED , MUTT_PAT_SUBJECT , MUTT_PAT_FROM , MUTT_PAT_DATE ,
  MUTT_PAT_DATE_RECEIVED , MUTT_PAT_DUPLICATED , MUTT_PAT_UNREFERENCED , MUTT_PAT_BROKEN ,
  MUTT_PAT_ID , MUTT_PAT_ID_EXTERNAL , MUTT_PAT_BODY , MUTT_PAT_HEADER ,
  MUTT_PAT_HORMEL , MUTT_PAT_WHOLE_MSG , MUTT_PAT_SENDER , MUTT_PAT_MESSAGE ,
  MUTT_PAT_SCORE , MUTT_PAT_SIZE , MUTT_PAT_REFERENCE , MUTT_PAT_RECIPIENT ,
  MUTT_PAT_LIST , MUTT_PAT_SUBSCRIBED_LIST , MUTT_PAT_PERSONAL_RECIP , MUTT_PAT_PERSONAL_FROM ,
  MUTT_PAT_ADDRESS , MUTT_PAT_CRYPT_SIGN , MUTT_PAT_CRYPT_VERIFIED , MUTT_PAT_CRYPT_ENCRYPT ,
  MUTT_PAT_PGP_KEY , MUTT_PAT_XLABEL , MUTT_PAT_SERVERSEARCH , MUTT_PAT_DRIVER_TAGS ,
  MUTT_PAT_MIMEATTACH , MUTT_PAT_MIMETYPE , MUTT_PAT_NEWSGROUPS , MUTT_PAT_MAX
}
 Types of pattern to match. More...
 

Functions

 SLIST_HEAD (PatternList, Pattern)
 
bool mutt_pattern_exec (struct Pattern *pat, PatternExecFlags flags, struct Mailbox *m, struct Email *e, struct PatternCache *cache)
 Match a pattern against an email header.
 
bool mutt_pattern_alias_exec (struct Pattern *pat, PatternExecFlags flags, struct AliasView *av, struct PatternCache *cache)
 Match a pattern against an alias.
 
struct PatternList * mutt_pattern_comp (struct MailboxView *mv, struct Menu *menu, const char *s, PatternCompFlags flags, struct Buffer *err)
 Create a Pattern.
 
void mutt_check_simple (struct Buffer *s, const char *simple)
 Convert a simple search into a real request.
 
void mutt_pattern_free (struct PatternList **pat)
 Free a Pattern.
 
bool dlg_pattern (char *buf, size_t buflen)
 Show menu to select a Pattern -.
 
int mutt_which_case (const char *s)
 
bool mutt_is_list_recipient (bool all_addr, struct Envelope *env)
 Matches known mailing lists.
 
bool mutt_is_subscribed_list_recipient (bool all_addr, struct Envelope *env)
 Matches subscribed mailing lists.
 
int mutt_pattern_func (struct MailboxView *mv, int op, char *prompt)
 Perform some Pattern matching.
 
int mutt_pattern_alias_func (char *prompt, struct AliasMenuData *mdata, struct Menu *menu)
 Perform some Pattern matching for Alias.
 
int mutt_search_command (struct MailboxView *mv, struct Menu *menu, int cur, struct SearchState *state, SearchFlags flags)
 Perform a search.
 
int mutt_search_alias_command (struct Menu *menu, int cur, struct SearchState *state, SearchFlags flags)
 Perform a search.
 

Variables

const struct CompleteOps CompletePatternOps
 Auto-Completion of Patterns.
 

Detailed Description

Match patterns to emails.

Authors
  • Richard Russon
  • Pietro Cerutti

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 lib.h.

Macro Definition Documentation

◆ MUTT_ALIAS_SIMPLESEARCH

#define MUTT_ALIAS_SIMPLESEARCH   "~f %s | ~t %s | ~c %s"

Definition at line 63 of file lib.h.

◆ MUTT_PC_NO_FLAGS

#define MUTT_PC_NO_FLAGS   0

No flags are set.

Definition at line 68 of file lib.h.

◆ MUTT_PC_FULL_MSG

#define MUTT_PC_FULL_MSG   (1 << 0)

Enable body and header matching.

Definition at line 69 of file lib.h.

◆ MUTT_PC_PATTERN_DYNAMIC

#define MUTT_PC_PATTERN_DYNAMIC   (1 << 1)

Enable runtime date range evaluation.

Definition at line 70 of file lib.h.

◆ MUTT_PC_SEND_MODE_SEARCH

#define MUTT_PC_SEND_MODE_SEARCH   (1 << 2)

Allow send-mode body searching.

Definition at line 71 of file lib.h.

◆ MUTT_PAT_EXEC_NO_FLAGS

#define MUTT_PAT_EXEC_NO_FLAGS   0

No flags are set.

Definition at line 105 of file lib.h.

◆ MUTT_MATCH_FULL_ADDRESS

#define MUTT_MATCH_FULL_ADDRESS   (1 << 0)

Match the full address.

Definition at line 106 of file lib.h.

Typedef Documentation

◆ PatternCompFlags

typedef uint8_t PatternCompFlags

Flags for mutt_pattern_comp(), e.g. MUTT_PC_FULL_MSG.

Definition at line 67 of file lib.h.

◆ PatternExecFlags

typedef uint8_t PatternExecFlags

Flags for mutt_pattern_exec(), e.g. MUTT_MATCH_FULL_ADDRESS.

Definition at line 104 of file lib.h.

Enumeration Type Documentation

◆ PatternType

Types of pattern to match.

Note
This enum piggy-backs on top of MessageType
See also
mutt_pattern_comp(), mutt_pattern_exec()
Enumerator
MUTT_PAT_AND 

Both patterns must match.

MUTT_PAT_OR 

Either pattern can match.

MUTT_PAT_THREAD 

Pattern matches email thread.

MUTT_PAT_PARENT 

Pattern matches parent.

MUTT_PAT_CHILDREN 

Pattern matches a child email.

MUTT_PAT_TO 

Pattern matches 'To:' field.

MUTT_PAT_CC 

Pattern matches 'Cc:' field.

MUTT_PAT_BCC 

Pattern matches 'Bcc:' field.

MUTT_PAT_COLLAPSED 

Thread is collapsed.

MUTT_PAT_SUBJECT 

Pattern matches 'Subject:' field.

MUTT_PAT_FROM 

Pattern matches 'From:' field.

MUTT_PAT_DATE 

Pattern matches 'Date:' field.

MUTT_PAT_DATE_RECEIVED 

Pattern matches date received.

MUTT_PAT_DUPLICATED 

Duplicate message.

MUTT_PAT_UNREFERENCED 

Message is unreferenced in the thread.

MUTT_PAT_BROKEN 

Message is part of a broken thread.

MUTT_PAT_ID 

Pattern matches email's Message-Id.

MUTT_PAT_ID_EXTERNAL 

Message-Id is among results from an external query.

MUTT_PAT_BODY 

Pattern matches email's body.

MUTT_PAT_HEADER 

Pattern matches email's header.

MUTT_PAT_HORMEL 

Pattern matches email's spam score.

MUTT_PAT_WHOLE_MSG 

Pattern matches raw email text.

MUTT_PAT_SENDER 

Pattern matches sender.

MUTT_PAT_MESSAGE 

Pattern matches message number.

MUTT_PAT_SCORE 

Pattern matches email's score.

MUTT_PAT_SIZE 

Pattern matches email's size.

MUTT_PAT_REFERENCE 

Pattern matches 'References:' or 'In-Reply-To:' field.

MUTT_PAT_RECIPIENT 

User is a recipient of the email.

MUTT_PAT_LIST 

Email is on mailing list.

MUTT_PAT_SUBSCRIBED_LIST 

Email is on subscribed mailing list.

MUTT_PAT_PERSONAL_RECIP 

Email is addressed to the user.

MUTT_PAT_PERSONAL_FROM 

Email is from the user.

MUTT_PAT_ADDRESS 

Pattern matches any address field.

MUTT_PAT_CRYPT_SIGN 

Message is signed.

MUTT_PAT_CRYPT_VERIFIED 

Message is crypographically verified.

MUTT_PAT_CRYPT_ENCRYPT 

Message is encrypted.

MUTT_PAT_PGP_KEY 

Message has PGP key.

MUTT_PAT_XLABEL 

Pattern matches keyword/label.

MUTT_PAT_SERVERSEARCH 

Server-side pattern matches.

MUTT_PAT_DRIVER_TAGS 

Pattern matches message tags.

MUTT_PAT_MIMEATTACH 

Pattern matches number of attachments.

MUTT_PAT_MIMETYPE 

Pattern matches MIME type.

MUTT_PAT_NEWSGROUPS 

Pattern matches newsgroup.

MUTT_PAT_MAX 

Definition at line 135 of file lib.h.

136{
179#ifdef USE_NNTP
181#endif
183};
@ MUTT_MT_MAX
Definition: mutt.h:86
@ MUTT_PAT_HEADER
Pattern matches email's header.
Definition: lib.h:156
@ MUTT_PAT_WHOLE_MSG
Pattern matches raw email text.
Definition: lib.h:158
@ MUTT_PAT_BROKEN
Message is part of a broken thread.
Definition: lib.h:152
@ MUTT_PAT_ID_EXTERNAL
Message-Id is among results from an external query.
Definition: lib.h:154
@ MUTT_PAT_OR
Either pattern can match.
Definition: lib.h:138
@ MUTT_PAT_CHILDREN
Pattern matches a child email.
Definition: lib.h:141
@ MUTT_PAT_PARENT
Pattern matches parent.
Definition: lib.h:140
@ MUTT_PAT_REFERENCE
Pattern matches 'References:' or 'In-Reply-To:' field.
Definition: lib.h:163
@ MUTT_PAT_FROM
Pattern matches 'From:' field.
Definition: lib.h:147
@ MUTT_PAT_DRIVER_TAGS
Pattern matches message tags.
Definition: lib.h:176
@ MUTT_PAT_COLLAPSED
Thread is collapsed.
Definition: lib.h:145
@ MUTT_PAT_CRYPT_VERIFIED
Message is crypographically verified.
Definition: lib.h:171
@ MUTT_PAT_HORMEL
Pattern matches email's spam score.
Definition: lib.h:157
@ MUTT_PAT_SUBJECT
Pattern matches 'Subject:' field.
Definition: lib.h:146
@ MUTT_PAT_LIST
Email is on mailing list.
Definition: lib.h:165
@ MUTT_PAT_NEWSGROUPS
Pattern matches newsgroup.
Definition: lib.h:180
@ MUTT_PAT_PERSONAL_RECIP
Email is addressed to the user.
Definition: lib.h:167
@ MUTT_PAT_CC
Pattern matches 'Cc:' field.
Definition: lib.h:143
@ MUTT_PAT_SUBSCRIBED_LIST
Email is on subscribed mailing list.
Definition: lib.h:166
@ MUTT_PAT_SERVERSEARCH
Server-side pattern matches.
Definition: lib.h:175
@ MUTT_PAT_RECIPIENT
User is a recipient of the email.
Definition: lib.h:164
@ MUTT_PAT_CRYPT_ENCRYPT
Message is encrypted.
Definition: lib.h:172
@ MUTT_PAT_UNREFERENCED
Message is unreferenced in the thread.
Definition: lib.h:151
@ MUTT_PAT_CRYPT_SIGN
Message is signed.
Definition: lib.h:170
@ MUTT_PAT_MESSAGE
Pattern matches message number.
Definition: lib.h:160
@ MUTT_PAT_AND
Both patterns must match.
Definition: lib.h:137
@ MUTT_PAT_DATE
Pattern matches 'Date:' field.
Definition: lib.h:148
@ MUTT_PAT_XLABEL
Pattern matches keyword/label.
Definition: lib.h:174
@ MUTT_PAT_SCORE
Pattern matches email's score.
Definition: lib.h:161
@ MUTT_PAT_MIMEATTACH
Pattern matches number of attachments.
Definition: lib.h:177
@ MUTT_PAT_DUPLICATED
Duplicate message.
Definition: lib.h:150
@ MUTT_PAT_PERSONAL_FROM
Email is from the user.
Definition: lib.h:168
@ MUTT_PAT_TO
Pattern matches 'To:' field.
Definition: lib.h:142
@ MUTT_PAT_BCC
Pattern matches 'Bcc:' field.
Definition: lib.h:144
@ MUTT_PAT_SENDER
Pattern matches sender.
Definition: lib.h:159
@ MUTT_PAT_DATE_RECEIVED
Pattern matches date received.
Definition: lib.h:149
@ MUTT_PAT_ADDRESS
Pattern matches any address field.
Definition: lib.h:169
@ MUTT_PAT_MAX
Definition: lib.h:182
@ MUTT_PAT_MIMETYPE
Pattern matches MIME type.
Definition: lib.h:178
@ MUTT_PAT_PGP_KEY
Message has PGP key.
Definition: lib.h:173
@ MUTT_PAT_ID
Pattern matches email's Message-Id.
Definition: lib.h:153
@ MUTT_PAT_THREAD
Pattern matches email thread.
Definition: lib.h:139
@ MUTT_PAT_SIZE
Pattern matches email's size.
Definition: lib.h:162
@ MUTT_PAT_BODY
Pattern matches email's body.
Definition: lib.h:155

Function Documentation

◆ SLIST_HEAD()

SLIST_HEAD ( PatternList  ,
Pattern   
)

◆ mutt_pattern_exec()

bool mutt_pattern_exec ( struct Pattern pat,
PatternExecFlags  flags,
struct Mailbox m,
struct Email e,
struct PatternCache cache 
)

Match a pattern against an email header.

Parameters
patPattern to match
flagsFlags, e.g. MUTT_MATCH_FULL_ADDRESS
mMailbox
eEmail
cacheCache for common Patterns
Return values
trueSuccess, pattern matched
falsePattern did not match

flags: MUTT_MATCH_FULL_ADDRESS: match both personal and machine address cache: For repeated matches against the same Header, passing in non-NULL will store some of the cacheable pattern matches in this structure.

Definition at line 1137 of file exec.c.

1139{
1140 const bool needs_msg = pattern_needs_msg(m, pat);
1141 struct Message *msg = needs_msg ? mx_msg_open(m, e) : NULL;
1142 if (needs_msg && !msg)
1143 {
1144 return false;
1145 }
1146 const bool matched = pattern_exec(pat, flags, m, e, msg, cache);
1147 mx_msg_close(m, &msg);
1148 return matched;
1149}
static bool pattern_needs_msg(const struct Mailbox *m, const struct Pattern *pat)
Check whether a pattern needs a full message.
Definition: exec.c:778
static bool pattern_exec(struct Pattern *pat, PatternExecFlags flags, struct Mailbox *m, struct Email *e, struct Message *msg, struct PatternCache *cache)
Match a pattern against an email header.
Definition: exec.c:824
int mx_msg_close(struct Mailbox *m, struct Message **ptr)
Close a message.
Definition: mx.c:1206
struct Message * mx_msg_open(struct Mailbox *m, struct Email *e)
Return a stream pointer for a message.
Definition: mx.c:1160
A local copy of an email.
Definition: message.h:34
struct Message::@0 flags
Flags for the Message.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_pattern_alias_exec()

bool mutt_pattern_alias_exec ( struct Pattern pat,
PatternExecFlags  flags,
struct AliasView av,
struct PatternCache cache 
)

Match a pattern against an alias.

Parameters
patPattern to match
flagsFlags, e.g. MUTT_MATCH_FULL_ADDRESS
avAliasView
cacheCache for common Patterns
Return values
trueSuccess, pattern matched
falsePattern did not match

flags: MUTT_MATCH_FULL_ADDRESS: match both personal and machine address cache: For repeated matches against the same Alias, passing in non-NULL will store some of the cacheable pattern matches in this structure.

Definition at line 1164 of file exec.c.

1166{
1167 switch (pat->op)
1168 {
1169 case MUTT_PAT_FROM: /* alias */
1170 if (!av->alias)
1171 return false;
1172 return pat->pat_not ^ (av->alias->name && patmatch(pat, av->alias->name));
1173 case MUTT_PAT_CC: /* comment */
1174 if (!av->alias)
1175 return false;
1176 return pat->pat_not ^ (av->alias->comment && patmatch(pat, av->alias->comment));
1177 case MUTT_PAT_TO: /* alias address list */
1178 if (!av->alias)
1179 return false;
1180 return pat->pat_not ^ match_addrlist(pat, (flags & MUTT_MATCH_FULL_ADDRESS),
1181 1, &av->alias->addr);
1182 case MUTT_PAT_AND:
1183 return pat->pat_not ^ (perform_alias_and(pat->child, flags, av, cache) > 0);
1184 case MUTT_PAT_OR:
1185 return pat->pat_not ^ (perform_alias_or(pat->child, flags, av, cache) > 0);
1186 }
1187
1188 return false;
1189}
static bool perform_alias_and(struct PatternList *pat, PatternExecFlags flags, struct AliasView *av, struct PatternCache *cache)
Perform a logical AND on a set of Patterns.
Definition: exec.c:325
static int match_addrlist(struct Pattern *pat, bool match_personal, int n,...)
Match a Pattern against an Address list.
Definition: exec.c:399
static bool patmatch(const struct Pattern *pat, const char *buf)
Compare a string to a Pattern.
Definition: exec.c:70
static int perform_alias_or(struct PatternList *pat, PatternExecFlags flags, struct AliasView *av, struct PatternCache *cache)
Perform a logical OR on a set of Patterns.
Definition: exec.c:374
#define MUTT_MATCH_FULL_ADDRESS
Match the full address.
Definition: lib.h:106
struct Alias * alias
Alias.
Definition: gui.h:44
char * comment
Free-form comment string.
Definition: alias.h:37
char * name
Short name.
Definition: alias.h:35
struct AddressList addr
List of Addresses the Alias expands to.
Definition: alias.h:36
struct PatternList * child
Arguments to logical operation.
Definition: lib.h:90
short op
Operation, e.g. MUTT_PAT_SCORE.
Definition: lib.h:78
bool pat_not
Pattern should be inverted (not)
Definition: lib.h:79
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_pattern_comp()

struct PatternList * mutt_pattern_comp ( struct MailboxView mv,
struct Menu menu,
const char *  s,
PatternCompFlags  flags,
struct Buffer err 
)

Create a Pattern.

Parameters
mvMailbox view
menuCurrent Menu
sPattern string
flagsFlags, e.g. MUTT_PC_FULL_MSG
errBuffer for error messages
Return values
ptrNewly allocated Pattern

Definition at line 906 of file compile.c.

909{
910 /* curlist when assigned will always point to a list containing at least one node
911 * with a Pattern value. */
912 struct PatternList *curlist = NULL;
913 bool pat_not = false;
914 bool all_addr = false;
915 bool pat_or = false;
916 bool implicit = true; /* used to detect logical AND operator */
917 bool is_alias = false;
918 const struct PatternFlags *entry = NULL;
919 char *p = NULL;
920 char *buf = NULL;
921 struct Buffer ps;
922 struct Mailbox *m = mv ? mv->mailbox : NULL;
923
924 if (!s || (s[0] == '\0'))
925 {
926 buf_strcpy(err, _("empty pattern"));
927 return NULL;
928 }
929
930 buf_init(&ps);
931 ps.dptr = (char *) s;
932 ps.dsize = mutt_str_len(s);
933
934 while (*ps.dptr)
935 {
936 SKIPWS(ps.dptr);
937 switch (*ps.dptr)
938 {
939 case '^':
940 ps.dptr++;
941 all_addr = !all_addr;
942 break;
943 case '!':
944 ps.dptr++;
945 pat_not = !pat_not;
946 break;
947 case '@':
948 ps.dptr++;
949 is_alias = !is_alias;
950 break;
951 case '|':
952 if (!pat_or)
953 {
954 if (!curlist)
955 {
956 buf_printf(err, _("error in pattern at: %s"), ps.dptr);
957 return NULL;
958 }
959
960 struct Pattern *pat = SLIST_FIRST(curlist);
961 if (SLIST_NEXT(pat, entries))
962 {
963 /* A & B | C == (A & B) | C */
964 struct Pattern *root = attach_new_root(&curlist);
965 root->op = MUTT_PAT_AND;
966 }
967
968 pat_or = true;
969 }
970 ps.dptr++;
971 implicit = false;
972 pat_not = false;
973 all_addr = false;
974 is_alias = false;
975 break;
976 case '%':
977 case '=':
978 case '~':
979 {
980 if (ps.dptr[1] == '\0')
981 {
982 buf_printf(err, _("missing pattern: %s"), ps.dptr);
983 goto cleanup;
984 }
985 short thread_op = 0;
986 if (ps.dptr[1] == '(')
987 thread_op = MUTT_PAT_THREAD;
988 else if ((ps.dptr[1] == '<') && (ps.dptr[2] == '('))
989 thread_op = MUTT_PAT_PARENT;
990 else if ((ps.dptr[1] == '>') && (ps.dptr[2] == '('))
991 thread_op = MUTT_PAT_CHILDREN;
992 if (thread_op != 0)
993 {
994 ps.dptr++; /* skip ~ */
995 if ((thread_op == MUTT_PAT_PARENT) || (thread_op == MUTT_PAT_CHILDREN))
996 ps.dptr++;
997 p = find_matching_paren(ps.dptr + 1);
998 if (p[0] != ')')
999 {
1000 buf_printf(err, _("mismatched parentheses: %s"), ps.dptr);
1001 goto cleanup;
1002 }
1003 struct Pattern *leaf = attach_new_leaf(&curlist);
1004 leaf->op = thread_op;
1005 leaf->pat_not = pat_not;
1006 leaf->all_addr = all_addr;
1007 leaf->is_alias = is_alias;
1008 pat_not = false;
1009 all_addr = false;
1010 is_alias = false;
1011 /* compile the sub-expression */
1012 buf = mutt_strn_dup(ps.dptr + 1, p - (ps.dptr + 1));
1013 leaf->child = mutt_pattern_comp(mv, menu, buf, flags, err);
1014 if (!leaf->child)
1015 {
1016 FREE(&buf);
1017 goto cleanup;
1018 }
1019 FREE(&buf);
1020 ps.dptr = p + 1; /* restore location */
1021 SKIPWS(ps.dptr);
1022 break;
1023 }
1024 if (implicit && pat_or)
1025 {
1026 /* A | B & C == (A | B) & C */
1027 struct Pattern *root = attach_new_root(&curlist);
1028 root->op = MUTT_PAT_OR;
1029 pat_or = false;
1030 }
1031
1032 entry = lookup_tag(ps.dptr[1]);
1033 if (!entry)
1034 {
1035 buf_printf(err, _("%c: invalid pattern modifier"), *ps.dptr);
1036 goto cleanup;
1037 }
1038 if (entry->flags && ((flags & entry->flags) == 0))
1039 {
1040 buf_printf(err, _("%c: not supported in this mode"), *ps.dptr);
1041 goto cleanup;
1042 }
1043
1044 struct Pattern *leaf = attach_new_leaf(&curlist);
1045 leaf->pat_not = pat_not;
1046 leaf->all_addr = all_addr;
1047 leaf->is_alias = is_alias;
1048 leaf->string_match = (ps.dptr[0] == '=');
1049 leaf->group_match = (ps.dptr[0] == '%');
1050 leaf->sendmode = (flags & MUTT_PC_SEND_MODE_SEARCH);
1051 leaf->op = entry->op;
1052 pat_not = false;
1053 all_addr = false;
1054 is_alias = false;
1055
1056 ps.dptr++; /* move past the ~ */
1057 ps.dptr++; /* eat the operator and any optional whitespace */
1058 SKIPWS(ps.dptr);
1059 if (entry->eat_arg)
1060 {
1061 if (ps.dptr[0] == '\0')
1062 {
1063 buf_addstr(err, _("missing parameter"));
1064 goto cleanup;
1065 }
1066 switch (entry->eat_arg)
1067 {
1068 case EAT_REGEX:
1069 if (!eat_regex(leaf, flags, &ps, err))
1070 goto cleanup;
1071 break;
1072 case EAT_DATE:
1073 if (!eat_date(leaf, flags, &ps, err))
1074 goto cleanup;
1075 break;
1076 case EAT_RANGE:
1077 if (!eat_range(leaf, flags, &ps, err))
1078 goto cleanup;
1079 break;
1080 case EAT_MESSAGE_RANGE:
1081 if (!eat_message_range(leaf, flags, &ps, err, mv))
1082 goto cleanup;
1083 break;
1084 case EAT_QUERY:
1085 if (!eat_query(leaf, flags, &ps, err, m))
1086 goto cleanup;
1087 break;
1088 default:
1089 break;
1090 }
1091 }
1092 implicit = true;
1093 break;
1094 }
1095
1096 case '(':
1097 {
1098 p = find_matching_paren(ps.dptr + 1);
1099 if (p[0] != ')')
1100 {
1101 buf_printf(err, _("mismatched parentheses: %s"), ps.dptr);
1102 goto cleanup;
1103 }
1104 /* compile the sub-expression */
1105 buf = mutt_strn_dup(ps.dptr + 1, p - (ps.dptr + 1));
1106 struct PatternList *sub = mutt_pattern_comp(mv, menu, buf, flags, err);
1107 FREE(&buf);
1108 if (!sub)
1109 goto cleanup;
1110 struct Pattern *leaf = SLIST_FIRST(sub);
1111 if (curlist)
1112 {
1113 attach_leaf(curlist, leaf);
1114 FREE(&sub);
1115 }
1116 else
1117 {
1118 curlist = sub;
1119 }
1120 leaf->pat_not ^= pat_not;
1121 leaf->all_addr |= all_addr;
1122 leaf->is_alias |= is_alias;
1123 pat_not = false;
1124 all_addr = false;
1125 is_alias = false;
1126 ps.dptr = p + 1; /* restore location */
1127 SKIPWS(ps.dptr);
1128 break;
1129 }
1130
1131 default:
1132 buf_printf(err, _("error in pattern at: %s"), ps.dptr);
1133 goto cleanup;
1134 }
1135 }
1136
1137 if (!curlist)
1138 {
1139 buf_strcpy(err, _("empty pattern"));
1140 return NULL;
1141 }
1142
1143 if (SLIST_NEXT(SLIST_FIRST(curlist), entries))
1144 {
1145 struct Pattern *root = attach_new_root(&curlist);
1146 root->op = pat_or ? MUTT_PAT_OR : MUTT_PAT_AND;
1147 }
1148
1149 return curlist;
1150
1151cleanup:
1152 mutt_pattern_free(&curlist);
1153 return NULL;
1154}
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:173
struct Buffer * buf_init(struct Buffer *buf)
Initialise a new Buffer.
Definition: buffer.c:55
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:238
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:407
static struct Pattern * attach_new_root(struct PatternList **curlist)
Create a new Pattern as a parent for a List.
Definition: compile.c:869
static struct Pattern * attach_new_leaf(struct PatternList **curlist)
Attach a new Pattern to a List.
Definition: compile.c:885
static struct Pattern * attach_leaf(struct PatternList *list, struct Pattern *leaf)
Attach a Pattern to a Pattern List.
Definition: compile.c:847
static char * find_matching_paren(char *s)
Find the matching parenthesis.
Definition: compile.c:754
struct PatternList * mutt_pattern_comp(struct MailboxView *mv, struct Menu *menu, const char *s, PatternCompFlags flags, struct Buffer *err)
Create a Pattern.
Definition: compile.c:906
void mutt_pattern_free(struct PatternList **pat)
Free a Pattern.
Definition: compile.c:778
static bool eat_query(struct Pattern *pat, PatternCompFlags flags, struct Buffer *s, struct Buffer *err, struct Mailbox *m)
Parse a query for an external search program - Implements eat_arg_t -.
Definition: compile.c:143
bool eat_message_range(struct Pattern *pat, PatternCompFlags flags, struct Buffer *s, struct Buffer *err, struct MailboxView *mv)
Parse a range of message numbers - Implements eat_arg_t -.
Definition: message.c:283
static bool eat_range(struct Pattern *pat, PatternCompFlags flags, struct Buffer *s, struct Buffer *err)
Parse a number range - Implements eat_arg_t -.
Definition: compile.c:624
static bool eat_date(struct Pattern *pat, PatternCompFlags flags, struct Buffer *s, struct Buffer *err)
Parse a date pattern - Implements eat_arg_t -.
Definition: compile.c:715
static bool eat_regex(struct Pattern *pat, PatternCompFlags flags, struct Buffer *s, struct Buffer *err)
Parse a regex - Implements eat_arg_t -.
Definition: compile.c:68
#define FREE(x)
Definition: memory.h:45
#define _(a)
Definition: message.h:28
char * mutt_strn_dup(const char *begin, size_t len)
Duplicate a sub-string.
Definition: string.c:452
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:568
const struct PatternFlags * lookup_tag(char tag)
Lookup a pattern modifier.
Definition: flags.c:200
#define MUTT_PC_SEND_MODE_SEARCH
Allow send-mode body searching.
Definition: lib.h:71
@ EAT_RANGE
Process a number (range)
Definition: private.h:53
@ EAT_MESSAGE_RANGE
Process a message number (range)
Definition: private.h:54
@ EAT_DATE
Process a date (range)
Definition: private.h:52
@ EAT_QUERY
Process a query string.
Definition: private.h:55
@ EAT_REGEX
Process a regex.
Definition: private.h:51
#define SLIST_NEXT(elm, field)
Definition: queue.h:270
#define SLIST_FIRST(head)
Definition: queue.h:229
#define SKIPWS(ch)
Definition: string2.h:45
String manipulation buffer.
Definition: buffer.h:34
struct Mailbox * mailbox
Current Mailbox.
Definition: mview.h:50
A mailbox.
Definition: mailbox.h:79
Mapping between user character and internal constant.
Definition: private.h:62
enum PatternEat eat_arg
Type of function needed to parse flag, e.g. EAT_DATE.
Definition: private.h:67
PatternCompFlags flags
Pattern flags, e.g. MUTT_PC_FULL_MSG.
Definition: private.h:65
int op
Operation to perform, e.g. MUTT_PAT_SCORE.
Definition: private.h:64
A simple (non-regex) pattern.
Definition: lib.h:77
bool group_match
Check a group of Addresses.
Definition: lib.h:82
union Pattern::@1 p
bool all_addr
All Addresses in the list must match.
Definition: lib.h:80
bool string_match
Check a string for a match.
Definition: lib.h:81
bool is_alias
Is there an alias for this Address?
Definition: lib.h:84
bool sendmode
Evaluate searches in send-mode.
Definition: lib.h:86
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_check_simple()

void mutt_check_simple ( struct Buffer buf,
const char *  simple 
)

Convert a simple search into a real request.

Parameters
bufBuffer for the result
simpleSearch string to convert

Definition at line 113 of file pattern.c.

114{
115 bool do_simple = true;
116
117 for (const char *p = buf_string(buf); p && (p[0] != '\0'); p++)
118 {
119 if ((p[0] == '\\') && (p[1] != '\0'))
120 {
121 p++;
122 }
123 else if ((p[0] == '~') || (p[0] == '=') || (p[0] == '%'))
124 {
125 do_simple = false;
126 break;
127 }
128 }
129
130 /* XXX - is mutt_istr_cmp() right here, or should we use locale's
131 * equivalences? */
132
133 if (do_simple) /* yup, so spoof a real request */
134 {
135 /* convert old tokens into the new format */
136 if (mutt_istr_equal("all", buf_string(buf)) || mutt_str_equal("^", buf_string(buf)) ||
137 mutt_str_equal(".", buf_string(buf))) /* ~A is more efficient */
138 {
139 buf_strcpy(buf, "~A");
140 }
141 else if (mutt_istr_equal("del", buf_string(buf)))
142 {
143 buf_strcpy(buf, "~D");
144 }
145 else if (mutt_istr_equal("flag", buf_string(buf)))
146 {
147 buf_strcpy(buf, "~F");
148 }
149 else if (mutt_istr_equal("new", buf_string(buf)))
150 {
151 buf_strcpy(buf, "~N");
152 }
153 else if (mutt_istr_equal("old", buf_string(buf)))
154 {
155 buf_strcpy(buf, "~O");
156 }
157 else if (mutt_istr_equal("repl", buf_string(buf)))
158 {
159 buf_strcpy(buf, "~Q");
160 }
161 else if (mutt_istr_equal("read", buf_string(buf)))
162 {
163 buf_strcpy(buf, "~R");
164 }
165 else if (mutt_istr_equal("tag", buf_string(buf)))
166 {
167 buf_strcpy(buf, "~T");
168 }
169 else if (mutt_istr_equal("unread", buf_string(buf)))
170 {
171 buf_strcpy(buf, "~U");
172 }
173 else
174 {
175 struct Buffer *tmp = buf_pool_get();
176 quote_simple(buf_string(buf), tmp);
177 mutt_file_expand_fmt(buf, simple, buf_string(tmp));
178 buf_pool_release(&tmp);
179 }
180 }
181}
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:93
void mutt_file_expand_fmt(struct Buffer *dest, const char *fmt, const char *src)
Replace s in a string with a filename.
Definition: file.c:1512
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:810
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:798
static void quote_simple(const char *str, struct Buffer *buf)
Apply simple quoting to a string.
Definition: pattern.c:95
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_pattern_free()

void mutt_pattern_free ( struct PatternList **  pat)

Free a Pattern.

Parameters
[out]patPattern to free

Definition at line 778 of file compile.c.

779{
780 if (!pat || !*pat)
781 return;
782
783 struct Pattern *np = SLIST_FIRST(*pat), *next = NULL;
784
785 while (np)
786 {
787 next = SLIST_NEXT(np, entries);
788
789 if (np->is_multi)
790 {
792 }
793 else if (np->string_match || np->dynamic)
794 {
795 FREE(&np->p.str);
796 }
797 else if (np->group_match)
798 {
799 np->p.group = NULL;
800 }
801 else if (np->p.regex)
802 {
803 regfree(np->p.regex);
804 FREE(&np->p.regex);
805 }
806
807#ifdef USE_DEBUG_GRAPHVIZ
808 FREE(&np->raw_pattern);
809#endif
811 FREE(&np);
812
813 np = next;
814 }
815
816 FREE(pat);
817}
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
struct Group * group
Address group if group_match is set.
Definition: lib.h:93
regex_t * regex
Compiled regex, for non-pattern matching.
Definition: lib.h:92
struct ListHead multi_cases
Multiple strings for ~I pattern.
Definition: lib.h:95
char * str
String, if string_match is set.
Definition: lib.h:94
bool dynamic
Evaluate date ranges at run time.
Definition: lib.h:85
bool is_multi
Multiple case (only for ~I pattern now)
Definition: lib.h:87
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_which_case()

int mutt_which_case ( const char *  s)

◆ mutt_is_list_recipient()

bool mutt_is_list_recipient ( bool  all_addr,
struct Envelope env 
)

Matches known mailing lists.

Parameters
all_addrIf true, ALL Addresses must be mailing lists
envEnvelope
Return values
true
  • One Address is a mailing list (all_addr is false)
  • All the Addresses are mailing lists (all_addr is true)

Definition at line 489 of file exec.c.

490{
491 return mutt_is_predicate_recipient(all_addr, env, &mutt_is_mail_list);
492}
static bool mutt_is_predicate_recipient(bool all_addr, struct Envelope *env, addr_predicate_t p)
Test an Envelopes Addresses using a predicate function.
Definition: exec.c:452
bool mutt_is_mail_list(const struct Address *addr)
Is this the email address of a mailing list? - Implements addr_predicate_t -.
Definition: maillist.c:44
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_is_subscribed_list_recipient()

bool mutt_is_subscribed_list_recipient ( bool  all_addr,
struct Envelope env 
)

Matches subscribed mailing lists.

Parameters
all_addrIf true, ALL Addresses must be on the subscribed list
envEnvelope
Return values
true
  • One Address is subscribed (all_addr is false)
  • All the Addresses are subscribed (all_addr is true)

Definition at line 476 of file exec.c.

477{
479}
bool mutt_is_subscribed_list(const struct Address *addr)
Is this the email address of a user-subscribed mailing list? - Implements addr_predicate_t -.
Definition: maillist.c:56
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_pattern_func()

int mutt_pattern_func ( struct MailboxView mv,
int  op,
char *  prompt 
)

Perform some Pattern matching.

Parameters
mvMailbox View
opOperation to perform, e.g. MUTT_LIMIT
promptPrompt to show the user
Return values
0Success
-1Failure

Definition at line 290 of file pattern.c.

291{
292 if (!mv || !mv->mailbox)
293 return -1;
294
295 struct Mailbox *m = mv->mailbox;
296
297 struct Buffer *err = NULL;
298 int rc = -1;
299 struct Progress *progress = NULL;
300 struct Buffer *buf = buf_pool_get();
301
302 buf_strcpy(buf, NONULL(mv->pattern));
303 if (prompt || (op != MUTT_LIMIT))
304 {
305 if ((mw_get_field(prompt, buf, MUTT_COMP_CLEAR, HC_PATTERN, &CompletePatternOps, NULL) != 0) ||
306 buf_is_empty(buf))
307 {
308 buf_pool_release(&buf);
309 return -1;
310 }
311 }
312
313 mutt_message(_("Compiling search pattern..."));
314
315 char *simple = buf_strdup(buf);
316 const char *const c_simple_search = cs_subset_string(NeoMutt->sub, "simple_search");
317 mutt_check_simple(buf, NONULL(c_simple_search));
318 const char *pbuf = buf->data;
319 while (*pbuf == ' ')
320 pbuf++;
321 const bool match_all = mutt_str_equal(pbuf, "~A");
322
323 err = buf_pool_get();
324 struct PatternList *pat = mutt_pattern_comp(mv, mv->menu, buf->data, MUTT_PC_FULL_MSG, err);
325 if (!pat)
326 {
327 mutt_error("%s", buf_string(err));
328 goto bail;
329 }
330
331#ifdef USE_IMAP
332 if ((m->type == MUTT_IMAP) && (!imap_search(m, pat)))
333 goto bail;
334#endif
335
336 progress = progress_new(_("Executing command on matching messages..."), MUTT_PROGRESS_READ,
337 (op == MUTT_LIMIT) ? m->msg_count : m->vcount);
338
339 if (op == MUTT_LIMIT)
340 {
341 m->vcount = 0;
342 mv->vsize = 0;
343 mv->collapsed = false;
344 int padding = mx_msg_padding_size(m);
345
346 for (int i = 0; i < m->msg_count; i++)
347 {
348 struct Email *e = m->emails[i];
349 if (!e)
350 break;
351
352 progress_update(progress, i, -1);
353 /* new limit pattern implicitly uncollapses all threads */
354 e->vnum = -1;
355 e->visible = false;
356 e->limit_visited = true;
357 e->collapsed = false;
358 e->num_hidden = 0;
359
360 if (match_all ||
362 {
363 e->vnum = m->vcount;
364 e->visible = true;
365 m->v2r[m->vcount] = i;
366 m->vcount++;
367 struct Body *b = e->body;
368 mv->vsize += b->length + b->offset - b->hdr_offset + padding;
369 }
370 }
371 }
372 else
373 {
374 for (int i = 0; i < m->vcount; i++)
375 {
376 struct Email *e = mutt_get_virt_email(m, i);
377 if (!e)
378 continue;
379 progress_update(progress, i, -1);
381 {
382 switch (op)
383 {
384 case MUTT_UNDELETE:
385 mutt_set_flag(m, e, MUTT_PURGE, false, true);
386 /* fallthrough */
387 case MUTT_DELETE:
388 mutt_set_flag(m, e, MUTT_DELETE, (op == MUTT_DELETE), true);
389 break;
390 case MUTT_TAG:
391 case MUTT_UNTAG:
392 mutt_set_flag(m, e, MUTT_TAG, (op == MUTT_TAG), true);
393 break;
394 }
395 }
396 }
397 }
398 progress_free(&progress);
399
401
402 if (op == MUTT_LIMIT)
403 {
404 /* drop previous limit pattern */
405 FREE(&mv->pattern);
407
408 if (m->msg_count && !m->vcount)
409 mutt_error(_("No messages matched criteria"));
410
411 /* record new limit pattern, unless match all */
412 if (!match_all)
413 {
414 mv->pattern = simple;
415 simple = NULL; /* don't clobber it */
416 mv->limit_pattern = mutt_pattern_comp(mv, mv->menu, buf->data, MUTT_PC_FULL_MSG, err);
417 }
418 }
419
420 rc = 0;
421
422bail:
423 buf_pool_release(&buf);
424 buf_pool_release(&err);
425 FREE(&simple);
426 mutt_pattern_free(&pat);
427
428 return rc;
429}
bool buf_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:303
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition: buffer.c:542
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:292
bool mutt_pattern_exec(struct Pattern *pat, PatternExecFlags flags, struct Mailbox *m, struct Email *e, struct PatternCache *cache)
Match a pattern against an email header.
Definition: exec.c:1137
void mutt_set_flag(struct Mailbox *m, struct Email *e, enum MessageType flag, bool bf, bool upd_mbox)
Set a flag on an email.
Definition: flags.c:53
int mw_get_field(const char *prompt, struct Buffer *buf, CompletionFlags complete, enum HistoryClass hclass, const struct CompleteOps *comp_api, void *cdata)
Ask the user for a string -.
Definition: window.c:275
#define mutt_error(...)
Definition: logging2.h:92
#define mutt_message(...)
Definition: logging2.h:91
@ HC_PATTERN
Patterns.
Definition: lib.h:53
bool imap_search(struct Mailbox *m, const struct PatternList *pat)
Find messages in mailbox matching a pattern.
Definition: search.c:229
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
@ MUTT_UNDELETE
Messages to be un-deleted.
Definition: mutt.h:75
@ MUTT_LIMIT
Messages in limited view.
Definition: mutt.h:81
@ MUTT_UNTAG
Messages to be un-tagged.
Definition: mutt.h:80
@ MUTT_PURGE
Messages to be purged (bypass trash)
Definition: mutt.h:76
@ MUTT_TAG
Tagged messages.
Definition: mutt.h:79
@ MUTT_DELETE
Messages to be deleted.
Definition: mutt.h:74
#define MUTT_COMP_CLEAR
Clear input if printable character is pressed.
Definition: mutt.h:56
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:73
struct Email * mutt_get_virt_email(struct Mailbox *m, int vnum)
Get a virtual Email.
Definition: mview.c:419
int mx_msg_padding_size(struct Mailbox *m)
Bytes of padding between messages - Wrapper for MxOps::msg_padding_size()
Definition: mx.c:1566
const struct CompleteOps CompletePatternOps
Auto-Completion of Patterns.
Definition: complete.c:82
#define MUTT_PC_FULL_MSG
Enable body and header matching.
Definition: lib.h:69
void mutt_check_simple(struct Buffer *buf, const char *simple)
Convert a simple search into a real request.
Definition: pattern.c:113
@ MUTT_PROGRESS_READ
Progress tracks elements, according to $read_inc
Definition: lib.h:49
void progress_free(struct Progress **ptr)
Free a Progress Bar.
Definition: progress.c:92
bool progress_update(struct Progress *progress, size_t pos, int percent)
Update the state of the progress bar.
Definition: progress.c:73
struct Progress * progress_new(const char *msg, enum ProgressType type, size_t size)
Create a new Progress Bar.
Definition: progress.c:124
#define NONULL(x)
Definition: string2.h:37
The body of an email.
Definition: body.h:36
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:80
char * data
Pointer to data.
Definition: buffer.h:35
The envelope/body of an email.
Definition: email.h:37
bool visible
Is this message part of the view?
Definition: email.h:120
bool limit_visited
Has the limit pattern been applied to this message?
Definition: email.h:121
bool collapsed
Is this message part of a collapsed thread?
Definition: email.h:119
struct Body * body
List of MIME parts.
Definition: email.h:67
size_t num_hidden
Number of hidden messages in this view (only valid when collapsed is set)
Definition: email.h:122
int vnum
Virtual message number.
Definition: email.h:113
bool collapsed
Are all threads collapsed?
Definition: mview.h:48
struct Menu * menu
Needed for pattern compilation.
Definition: mview.h:46
off_t vsize
Size (in bytes) of the messages shown.
Definition: mview.h:40
struct PatternList * limit_pattern
Compiled limit pattern.
Definition: mview.h:42
char * pattern
Limit pattern string.
Definition: mview.h:41
int vcount
The number of virtual messages.
Definition: mailbox.h:99
int * v2r
Mapping from virtual to real msgno.
Definition: mailbox.h:98
int msg_count
Total number of messages.
Definition: mailbox.h:88
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_pattern_alias_func()

int mutt_pattern_alias_func ( char *  prompt,
struct AliasMenuData mdata,
struct Menu menu 
)

Perform some Pattern matching for Alias.

Parameters
promptPrompt to show the user
mdataMenu data holding Aliases
menuCurrent menu
Return values
0Success
-1Failure

Definition at line 191 of file pattern.c.

192{
193 int rc = -1;
194 struct Progress *progress = NULL;
195 struct Buffer *buf = buf_pool_get();
196
197 buf_strcpy(buf, mdata->limit);
198 if (prompt)
199 {
200 if ((mw_get_field(prompt, buf, MUTT_COMP_CLEAR, HC_PATTERN, &CompletePatternOps, NULL) != 0) ||
201 buf_is_empty(buf))
202 {
203 buf_pool_release(&buf);
204 return -1;
205 }
206 }
207
208 mutt_message(_("Compiling search pattern..."));
209
210 bool match_all = false;
211 struct PatternList *pat = NULL;
212 char *simple = buf_strdup(buf);
213 if (simple)
214 {
216 const char *pbuf = buf->data;
217 while (*pbuf == ' ')
218 pbuf++;
219 match_all = mutt_str_equal(pbuf, "~A");
220
221 struct Buffer err = buf_make(0);
222 pat = mutt_pattern_comp(NULL, menu, buf->data, MUTT_PC_FULL_MSG, &err);
223 if (!pat)
224 {
225 mutt_error("%s", buf_string(&err));
226 buf_dealloc(&err);
227 goto bail;
228 }
229 }
230 else
231 {
232 match_all = true;
233 }
234
235 progress = progress_new(_("Executing command on matching messages..."),
237
238 int vcounter = 0;
239 struct AliasView *avp = NULL;
240 ARRAY_FOREACH(avp, &mdata->ava)
241 {
242 progress_update(progress, ARRAY_FOREACH_IDX, -1);
243
244 if (match_all ||
246 {
247 avp->is_visible = true;
248 vcounter++;
249 }
250 else
251 {
252 avp->is_visible = false;
253 }
254 }
255 progress_free(&progress);
256
257 FREE(&mdata->limit);
258 if (!match_all)
259 {
260 mdata->limit = simple;
261 simple = NULL;
262 }
263
264 if (menu)
265 {
266 menu->max = vcounter;
267 menu_set_index(menu, 0);
268 }
269
271
272 rc = 0;
273
274bail:
275 buf_pool_release(&buf);
276 FREE(&simple);
277 mutt_pattern_free(&pat);
278
279 return rc;
280}
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition: array.h:211
#define ARRAY_SIZE(head)
The number of elements stored.
Definition: array.h:86
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:389
struct Buffer buf_make(size_t size)
Make a new buffer on the stack.
Definition: buffer.c:70
bool mutt_pattern_alias_exec(struct Pattern *pat, PatternExecFlags flags, struct AliasView *av, struct PatternCache *cache)
Match a pattern against an alias.
Definition: exec.c:1164
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition: menu.c:170
#define MUTT_ALIAS_SIMPLESEARCH
Definition: lib.h:63
char * limit
Limit being used.
Definition: gui.h:58
struct AliasViewArray ava
All Aliases/Queries.
Definition: gui.h:53
GUI data wrapping an Alias.
Definition: gui.h:36
bool is_visible
Is visible?
Definition: gui.h:43
int max
Number of entries in the menu.
Definition: lib.h:72
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_search_command()

int mutt_search_command ( struct MailboxView mv,
struct Menu menu,
int  cur,
struct SearchState state,
SearchFlags  flags 
)

Perform a search.

Parameters
mvMailbox view to search through
menuCurrent Menu
curIndex number of current email
stateCurrent search state
flagsSearch flags, e.g. SEARCH_PROMPT
Return values
>=0Index of matching email
-1No match, or error

Definition at line 441 of file pattern.c.

443{
444 struct Progress *progress = NULL;
445 int rc = -1;
446 struct Mailbox *m = mv ? mv->mailbox : NULL;
447 if (!m)
448 return -1;
449 bool pattern_changed = false;
450
451 if (buf_is_empty(state->string) || (flags & SEARCH_PROMPT))
452 {
453 if ((mw_get_field((state->reverse) ? _("Reverse search for: ") : _("Search for: "),
455 &CompletePatternOps, NULL) != 0) ||
456 buf_is_empty(state->string))
457 {
458 goto done;
459 }
460
461 /* compare the *expanded* version of the search pattern in case
462 * $simple_search has changed while we were searching */
463 struct Buffer *tmp = buf_pool_get();
464 buf_copy(tmp, state->string);
465 const char *const c_simple_search = cs_subset_string(NeoMutt->sub, "simple_search");
466 mutt_check_simple(tmp, NONULL(c_simple_search));
467 if (!buf_str_equal(tmp, state->string_expn))
468 {
469 mutt_pattern_free(&state->pattern);
470 buf_copy(state->string_expn, tmp);
471 buf_pool_release(&tmp);
472 }
473 }
474
475 if (!state->pattern)
476 {
477 mutt_message(_("Compiling search pattern..."));
478 mutt_pattern_free(&state->pattern);
479 struct Buffer *err = buf_pool_get();
480 state->pattern = mutt_pattern_comp(mv, menu, state->string_expn->data,
481 MUTT_PC_FULL_MSG, err);
482 pattern_changed = true;
483 if (!state->pattern)
484 {
485 mutt_error("%s", buf_string(err));
486 buf_free(&err);
487 buf_reset(state->string);
488 buf_reset(state->string_expn);
489 return -1;
490 }
491 buf_free(&err);
493 }
494
495 if (pattern_changed)
496 {
497 for (int i = 0; i < m->msg_count; i++)
498 m->emails[i]->searched = false;
499#ifdef USE_IMAP
500 if ((m->type == MUTT_IMAP) && (!imap_search(m, state->pattern)))
501 return -1;
502#endif
503 }
504
505 int incr = state->reverse ? -1 : 1;
506 if (flags & SEARCH_OPPOSITE)
507 incr = -incr;
508
509 progress = progress_new(_("Searching..."), MUTT_PROGRESS_READ, m->vcount);
510
511 const bool c_wrap_search = cs_subset_bool(NeoMutt->sub, "wrap_search");
512 for (int i = cur + incr, j = 0; j != m->vcount; j++)
513 {
514 const char *msg = NULL;
515 progress_update(progress, j, -1);
516 if (i > m->vcount - 1)
517 {
518 i = 0;
519 if (c_wrap_search)
520 {
521 msg = _("Search wrapped to top");
522 }
523 else
524 {
525 mutt_message(_("Search hit bottom without finding match"));
526 goto done;
527 }
528 }
529 else if (i < 0)
530 {
531 i = m->vcount - 1;
532 if (c_wrap_search)
533 {
534 msg = _("Search wrapped to bottom");
535 }
536 else
537 {
538 mutt_message(_("Search hit top without finding match"));
539 goto done;
540 }
541 }
542
543 struct Email *e = mutt_get_virt_email(m, i);
544 if (!e)
545 goto done;
546
547 if (e->searched)
548 {
549 /* if we've already evaluated this message, use the cached value */
550 if (e->matched)
551 {
553 if (msg && *msg)
554 mutt_message("%s", msg);
555 rc = i;
556 goto done;
557 }
558 }
559 else
560 {
561 /* remember that we've already searched this message */
562 e->searched = true;
564 MUTT_MATCH_FULL_ADDRESS, m, e, NULL);
565 if (e->matched)
566 {
568 if (msg && *msg)
569 mutt_message("%s", msg);
570 rc = i;
571 goto done;
572 }
573 }
574
575 if (SigInt)
576 {
577 mutt_error(_("Search interrupted"));
578 SigInt = false;
579 goto done;
580 }
581
582 i += incr;
583 }
584
585 mutt_error(_("Not found"));
586done:
587 progress_free(&progress);
588 return rc;
589}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:88
void buf_free(struct Buffer **ptr)
Deallocates a buffer.
Definition: buffer.c:331
bool buf_str_equal(const struct Buffer *a, const struct Buffer *b)
Return if two buffers are equal.
Definition: buffer.c:653
size_t buf_copy(struct Buffer *dst, const struct Buffer *src)
Copy a Buffer's contents to another Buffer.
Definition: buffer.c:572
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
SIG_ATOMIC_VOLATILE_T SigInt
true after SIGINT is received
Definition: globals.c:59
#define SEARCH_OPPOSITE
Search in the opposite direction.
Definition: search_state.h:45
#define SEARCH_PROMPT
Ask for search input.
Definition: search_state.h:44
bool searched
Email has been searched.
Definition: email.h:104
bool matched
Search matches this Email.
Definition: email.h:101
struct Buffer * string
search string
Definition: search_state.h:37
struct Buffer * string_expn
expanded search string
Definition: search_state.h:38
bool reverse
search backwards
Definition: search_state.h:39
struct PatternList * pattern
compiled search pattern
Definition: search_state.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_search_alias_command()

int mutt_search_alias_command ( struct Menu menu,
int  cur,
struct SearchState state,
SearchFlags  flags 
)

Perform a search.

Parameters
menuMenu to search through
curIndex number of current email
stateCurrent search state
flagsSearch flags, e.g. SEARCH_PROMPT
Return values
>=0Index of matching alias
-1No match, or error

Definition at line 600 of file pattern.c.

602{
603 struct Progress *progress = NULL;
604 const struct AliasMenuData *mdata = menu->mdata;
605 const struct AliasViewArray *ava = &mdata->ava;
606 int rc = -1;
607 bool pattern_changed = false;
608
609 if (buf_is_empty(state->string) || flags & SEARCH_PROMPT)
610 {
611 if ((mw_get_field((flags & OP_SEARCH_REVERSE) ? _("Reverse search for: ") : _("Search for: "),
613 &CompletePatternOps, NULL) != 0) ||
614 buf_is_empty(state->string))
615 {
616 goto done;
617 }
618
619 /* compare the *expanded* version of the search pattern in case
620 * $simple_search has changed while we were searching */
621 struct Buffer *tmp = buf_pool_get();
622 buf_copy(tmp, state->string);
624 if (!buf_str_equal(tmp, state->string_expn))
625 {
626 mutt_pattern_free(&state->pattern);
627 buf_copy(state->string_expn, tmp);
628 buf_pool_release(&tmp);
629 }
630 }
631
632 if (!state->pattern)
633 {
634 mutt_message(_("Compiling search pattern..."));
635 struct Buffer *err = buf_pool_get();
636 state->pattern = mutt_pattern_comp(NULL, menu, state->string_expn->data,
637 MUTT_PC_FULL_MSG, err);
638 pattern_changed = true;
639 if (!state->pattern)
640 {
641 mutt_error("%s", buf_string(err));
642 buf_free(&err);
643 buf_reset(state->string);
644 buf_reset(state->string_expn);
645 return -1;
646 }
647 buf_free(&err);
649 }
650
651 if (pattern_changed)
652 {
653 struct AliasView *av = NULL;
654 ARRAY_FOREACH(av, ava)
655 {
656 av->is_searched = false;
657 }
658 }
659
660 int incr = state->reverse ? -1 : 1;
661 if (flags & SEARCH_OPPOSITE)
662 incr = -incr;
663
664 progress = progress_new(_("Searching..."), MUTT_PROGRESS_READ, ARRAY_SIZE(ava));
665
666 const bool c_wrap_search = cs_subset_bool(NeoMutt->sub, "wrap_search");
667 for (int i = cur + incr, j = 0; j != ARRAY_SIZE(ava); j++)
668 {
669 const char *msg = NULL;
670 progress_update(progress, j, -1);
671 if (i > ARRAY_SIZE(ava) - 1)
672 {
673 i = 0;
674 if (c_wrap_search)
675 {
676 msg = _("Search wrapped to top");
677 }
678 else
679 {
680 mutt_message(_("Search hit bottom without finding match"));
681 goto done;
682 }
683 }
684 else if (i < 0)
685 {
686 i = ARRAY_SIZE(ava) - 1;
687 if (c_wrap_search)
688 {
689 msg = _("Search wrapped to bottom");
690 }
691 else
692 {
693 mutt_message(_("Search hit top without finding match"));
694 goto done;
695 }
696 }
697
698 struct AliasView *av = ARRAY_GET(ava, i);
699 if (av->is_searched)
700 {
701 /* if we've already evaluated this message, use the cached value */
702 if (av->is_matched)
703 {
705 if (msg && *msg)
706 mutt_message("%s", msg);
707 rc = i;
708 goto done;
709 }
710 }
711 else
712 {
713 /* remember that we've already searched this message */
714 av->is_searched = true;
716 MUTT_MATCH_FULL_ADDRESS, av, NULL);
717 if (av->is_matched)
718 {
720 if (msg && *msg)
721 mutt_message("%s", msg);
722 rc = i;
723 goto done;
724 }
725 }
726
727 if (SigInt)
728 {
729 mutt_error(_("Search interrupted"));
730 SigInt = false;
731 goto done;
732 }
733
734 i += incr;
735 }
736
737 mutt_error(_("Not found"));
738done:
739 progress_free(&progress);
740 return rc;
741}
#define ARRAY_GET(head, idx)
Return the element at index.
Definition: array.h:108
AliasView array wrapper with Pattern information -.
Definition: gui.h:52
struct Menu * menu
Menu.
Definition: gui.h:56
bool is_matched
Search matches this Alias.
Definition: gui.h:40
bool is_searched
Alias has been searched.
Definition: gui.h:39
void * mdata
Private data.
Definition: lib.h:137
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ CompletePatternOps

const struct CompleteOps CompletePatternOps
extern

Auto-Completion of Patterns.

Definition at line 82 of file complete.c.