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

Routines for adding user scores to emails. More...

#include "config.h"
#include <stdbool.h>
#include <stdlib.h>
#include "mutt/mutt.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "mutt.h"
#include "score.h"
#include "globals.h"
#include "keymap.h"
#include "mutt_commands.h"
#include "mutt_menu.h"
#include "options.h"
#include "pattern.h"
#include "protos.h"
#include "sort.h"
+ Include dependency graph for score.c:

Go to the source code of this file.

Data Structures

struct  Score
 Scoring rule for email. More...
 

Functions

void mutt_check_rescore (struct Mailbox *m)
 Do the emails need to have their scores recalculated? More...
 
enum CommandResult mutt_parse_score (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 Parse the 'score' command - Implements command_t. More...
 
void mutt_score_message (struct Mailbox *m, struct Email *e, bool upd_mbox)
 Apply scoring to an email. More...
 
enum CommandResult mutt_parse_unscore (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 Parse the 'unscore' command - Implements command_t. More...
 

Variables

short C_ScoreThresholdDelete
 Config: Messages with a lower score will be automatically deleted. More...
 
short C_ScoreThresholdFlag
 Config: Messages with a greater score will be automatically flagged. More...
 
short C_ScoreThresholdRead
 Config: Messages with a lower score will be automatically marked read. More...
 
static struct ScoreScoreList = NULL
 

Detailed Description

Routines for adding user scores to emails.

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

Function Documentation

◆ mutt_check_rescore()

void mutt_check_rescore ( struct Mailbox m)

Do the emails need to have their scores recalculated?

Parameters
mMailbox

Definition at line 70 of file score.c.

71 {
72  if (OptNeedRescore && C_Score)
73  {
74  if (((C_Sort & SORT_MASK) == SORT_SCORE) || ((C_SortAux & SORT_MASK) == SORT_SCORE))
75  {
76  OptNeedResort = true;
77  if ((C_Sort & SORT_MASK) == SORT_THREADS)
78  OptSortSubthreads = true;
79  }
80 
81  /* must redraw the index since the user might have %N in it */
84 
85  for (int i = 0; m && i < m->msg_count; i++)
86  {
87  mutt_score_message(m, m->emails[i], true);
88  m->emails[i]->pair = 0;
89  }
90  }
91  OptNeedRescore = false;
92 }
struct Email ** emails
Array of Emails.
Definition: mailbox.h:110
int msg_count
Total number of messages.
Definition: mailbox.h:102
WHERE bool OptNeedResort
(pseudo) used to force a re-sort
Definition: options.h:41
void mutt_score_message(struct Mailbox *m, struct Email *e, bool upd_mbox)
Apply scoring to an email.
Definition: score.c:169
Sort by the email&#39;s score.
Definition: sort2.h:59
Index panel (list of emails)
Definition: keymap.h:77
WHERE bool OptNeedRescore
(pseudo) set when the &#39;score&#39; command is used
Definition: options.h:40
Pager pager (email viewer)
Definition: keymap.h:78
WHERE short C_Sort
Config: Sort method for the index.
Definition: sort.h:58
WHERE short C_SortAux
Config: Secondary sort method for the index.
Definition: sort.h:59
Sort by email threads.
Definition: sort2.h:56
WHERE bool C_Score
Config: Use message scoring.
Definition: globals.h:255
WHERE bool OptSortSubthreads
(pseudo) used when $sort_aux changes
Definition: options.h:52
int pair
Color-pair to use when displaying in the index.
Definition: email.h:79
#define SORT_MASK
Mask for the sort id.
Definition: sort2.h:85
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_parse_score()

enum CommandResult mutt_parse_score ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Parse the 'score' command - Implements command_t.

Definition at line 97 of file score.c.

99 {
100  struct Score *ptr = NULL, *last = NULL;
101  char *pattern = NULL, *pc = NULL;
102 
104  if (!MoreArgs(s))
105  {
106  mutt_buffer_printf(err, _("%s: too few arguments"), "score");
107  return MUTT_CMD_WARNING;
108  }
109  pattern = buf->data;
110  mutt_buffer_init(buf);
112  if (MoreArgs(s))
113  {
114  FREE(&pattern);
115  mutt_buffer_printf(err, _("%s: too many arguments"), "score");
116  return MUTT_CMD_WARNING;
117  }
118 
119  /* look for an existing entry and update the value, else add it to the end
120  * of the list */
121  for (ptr = ScoreList, last = NULL; ptr; last = ptr, ptr = ptr->next)
122  if (mutt_str_strcmp(pattern, ptr->str) == 0)
123  break;
124  if (!ptr)
125  {
126  struct PatternList *pat = mutt_pattern_comp(pattern, MUTT_PC_NO_FLAGS, err);
127  if (!pat)
128  {
129  FREE(&pattern);
130  return MUTT_CMD_ERROR;
131  }
132  ptr = mutt_mem_calloc(1, sizeof(struct Score));
133  if (last)
134  last->next = ptr;
135  else
136  ScoreList = ptr;
137  ptr->pat = pat;
138  ptr->str = pattern;
139  }
140  else
141  {
142  /* 'buf' arg was cleared and 'pattern' holds the only reference;
143  * as here 'ptr' != NULL -> update the value only in which case
144  * ptr->str already has the string, so pattern should be freed. */
145  FREE(&pattern);
146  }
147  pc = buf->data;
148  if (*pc == '=')
149  {
150  ptr->exact = true;
151  pc++;
152  }
153  if (mutt_str_atoi(pc, &ptr->val) < 0)
154  {
155  FREE(&pattern);
156  mutt_buffer_strcpy(err, _("Error: score: invalid number"));
157  return MUTT_CMD_ERROR;
158  }
159  OptNeedRescore = true;
160  return MUTT_CMD_SUCCESS;
161 }
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
int mutt_str_atoi(const char *str, int *dst)
Convert ASCII string to an integer.
Definition: string.c:262
Error: Can&#39;t help the user.
Definition: mutt_commands.h:35
struct PatternList * pat
Definition: score.c:58
#define _(a)
Definition: message.h:28
static struct Score * ScoreList
Definition: score.c:64
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
WHERE bool OptNeedRescore
(pseudo) set when the &#39;score&#39; command is used
Definition: options.h:40
#define MoreArgs(buf)
Definition: buffer.h:43
struct PatternList * mutt_pattern_comp(const char *s, PatternCompFlags flags, struct Buffer *err)
Create a Pattern.
Definition: pattern.c:1392
int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: init.c:2655
char * data
Pointer to data.
Definition: buffer.h:35
Scoring rule for email.
Definition: score.c:55
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
Success: Command worked.
Definition: mutt_commands.h:37
#define MUTT_PC_NO_FLAGS
No flags are set.
Definition: pattern.h:42
Warning: Help given to the user.
Definition: mutt_commands.h:36
#define FREE(x)
Definition: memory.h:40
struct Score * next
Definition: score.c:61
struct Buffer * mutt_buffer_init(struct Buffer *buf)
Initialise a new Buffer.
Definition: buffer.c:46
int mutt_str_strcmp(const char *a, const char *b)
Compare two strings, safely.
Definition: string.c:615
#define MUTT_TOKEN_NO_FLAGS
No flags are set.
Definition: mutt.h:76
+ Here is the call graph for this function:

◆ mutt_score_message()

void mutt_score_message ( struct Mailbox m,
struct Email e,
bool  upd_mbox 
)

Apply scoring to an email.

Parameters
mMailbox
eEmail
upd_mboxIf true, update the Mailbox too

Definition at line 169 of file score.c.

170 {
171  struct Score *tmp = NULL;
172  struct PatternCache cache = { 0 };
173 
174  e->score = 0; /* in case of re-scoring */
175  for (tmp = ScoreList; tmp; tmp = tmp->next)
176  {
177  if (mutt_pattern_exec(SLIST_FIRST(tmp->pat), MUTT_MATCH_FULL_ADDRESS, NULL, e, &cache) > 0)
178  {
179  if (tmp->exact || (tmp->val == 9999) || (tmp->val == -9999))
180  {
181  e->score = tmp->val;
182  break;
183  }
184  e->score += tmp->val;
185  }
186  }
187  if (e->score < 0)
188  e->score = 0;
189 
190  if (e->score <= C_ScoreThresholdDelete)
191  mutt_set_flag_update(m, e, MUTT_DELETE, true, upd_mbox);
192  if (e->score <= C_ScoreThresholdRead)
193  mutt_set_flag_update(m, e, MUTT_READ, true, upd_mbox);
194  if (e->score >= C_ScoreThresholdFlag)
195  mutt_set_flag_update(m, e, MUTT_FLAG, true, upd_mbox);
196 }
struct PatternList * pat
Definition: score.c:58
short C_ScoreThresholdFlag
Config: Messages with a greater score will be automatically flagged.
Definition: score.c:49
Flagged messages.
Definition: mutt.h:106
static struct Score * ScoreList
Definition: score.c:64
int val
Definition: score.c:59
int score
Message score.
Definition: email.h:88
int 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: pattern.c:2001
#define SLIST_FIRST(head)
Definition: queue.h:229
Messages to be deleted.
Definition: mutt.h:102
Messages that have been read.
Definition: mutt.h:100
Scoring rule for email.
Definition: score.c:55
#define MUTT_MATCH_FULL_ADDRESS
Match the full address.
Definition: pattern.h:75
short C_ScoreThresholdDelete
Config: Messages with a lower score will be automatically deleted.
Definition: score.c:48
struct Score * next
Definition: score.c:61
short C_ScoreThresholdRead
Config: Messages with a lower score will be automatically marked read.
Definition: score.c:50
Cache commonly-used patterns.
Definition: pattern.h:85
bool exact
if this rule matches, don&#39;t evaluate any more
Definition: score.c:60
void mutt_set_flag_update(struct Mailbox *m, struct Email *e, int flag, bool bf, bool upd_mbox)
Set a flag on an email.
Definition: flags.c:55
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_parse_unscore()

enum CommandResult mutt_parse_unscore ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Parse the 'unscore' command - Implements command_t.

Definition at line 201 of file score.c.

203 {
204  struct Score *tmp = NULL, *last = NULL;
205 
206  while (MoreArgs(s))
207  {
209  if (mutt_str_strcmp("*", buf->data) == 0)
210  {
211  for (tmp = ScoreList; tmp;)
212  {
213  last = tmp;
214  tmp = tmp->next;
215  mutt_pattern_free(&last->pat);
216  FREE(&last);
217  }
218  ScoreList = NULL;
219  }
220  else
221  {
222  for (tmp = ScoreList; tmp; last = tmp, tmp = tmp->next)
223  {
224  if (mutt_str_strcmp(buf->data, tmp->str) == 0)
225  {
226  if (last)
227  last->next = tmp->next;
228  else
229  ScoreList = tmp->next;
230  mutt_pattern_free(&tmp->pat);
231  FREE(&tmp);
232  /* there should only be one score per pattern, so we can stop here */
233  break;
234  }
235  }
236  }
237  }
238  OptNeedRescore = true;
239  return MUTT_CMD_SUCCESS;
240 }
static struct Score * ScoreList
Definition: score.c:64
WHERE bool OptNeedRescore
(pseudo) set when the &#39;score&#39; command is used
Definition: options.h:40
#define MoreArgs(buf)
Definition: buffer.h:43
int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: init.c:2655
char * data
Pointer to data.
Definition: buffer.h:35
void mutt_pattern_free(struct PatternList **pat)
Free a Pattern.
Definition: pattern.c:1340
Scoring rule for email.
Definition: score.c:55
Success: Command worked.
Definition: mutt_commands.h:37
#define FREE(x)
Definition: memory.h:40
struct Score * next
Definition: score.c:61
int mutt_str_strcmp(const char *a, const char *b)
Compare two strings, safely.
Definition: string.c:615
#define MUTT_TOKEN_NO_FLAGS
No flags are set.
Definition: mutt.h:76
+ Here is the call graph for this function:

Variable Documentation

◆ C_ScoreThresholdDelete

short C_ScoreThresholdDelete

Config: Messages with a lower score will be automatically deleted.

Definition at line 48 of file score.c.

◆ C_ScoreThresholdFlag

short C_ScoreThresholdFlag

Config: Messages with a greater score will be automatically flagged.

Definition at line 49 of file score.c.

◆ C_ScoreThresholdRead

short C_ScoreThresholdRead

Config: Messages with a lower score will be automatically marked read.

Definition at line 50 of file score.c.

◆ ScoreList

struct Score* ScoreList = NULL
static

Definition at line 64 of file score.c.