NeoMutt  2018-07-16 +1360-3df4a2
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 "mutt.h"
#include "score.h"
#include "context.h"
#include "globals.h"
#include "keymap.h"
#include "mailbox.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

void mutt_check_rescore ( struct Mailbox m)

Do the emails need to have their scores recalculated?

Parameters
mMailbox

Definition at line 71 of file score.c.

72 {
73  if (OptNeedRescore && C_Score)
74  {
75  if (((C_Sort & SORT_MASK) == SORT_SCORE) || ((C_SortAux & SORT_MASK) == SORT_SCORE))
76  {
77  OptNeedResort = true;
78  if ((C_Sort & SORT_MASK) == SORT_THREADS)
79  OptSortSubthreads = true;
80  }
81 
82  /* must redraw the index since the user might have %N in it */
85 
86  for (int i = 0; m && i < m->msg_count; i++)
87  {
88  mutt_score_message(m, m->emails[i], true);
89  m->emails[i]->pair = 0;
90  }
91  }
92  OptNeedRescore = false;
93 }
struct Email ** emails
Definition: mailbox.h:100
int msg_count
total number of messages
Definition: mailbox.h:93
WHERE bool OptNeedResort
(pseudo) used to force a re-sort
Definition: options.h:40
void mutt_score_message(struct Mailbox *m, struct Email *e, bool upd_mbox)
Apply scoring to an email.
Definition: score.c:171
Index panel (list of emails)
Definition: keymap.h:74
WHERE bool OptNeedRescore
(pseudo) set when the &#39;score&#39; command is used
Definition: options.h:39
Pager pager (email viewer)
Definition: keymap.h:75
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
WHERE bool C_Score
Config: Use message scoring.
Definition: globals.h:256
WHERE bool OptSortSubthreads
(pseudo) used when $sort_aux changes
Definition: options.h:51
Sort by email threads.
Definition: sort.h:56
#define SORT_MASK
Mask for the sort id.
Definition: sort.h:85
int pair
color-pair to use when displaying in the index
Definition: email.h:82
Sort by the email&#39;s score.
Definition: sort.h:59

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 98 of file score.c.

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

+ Here is the call graph for this function:

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 171 of file score.c.

172 {
173  struct Score *tmp = NULL;
174  struct PatternCache cache = { 0 };
175 
176  e->score = 0; /* in case of re-scoring */
177  for (tmp = ScoreList; tmp; tmp = tmp->next)
178  {
179  if (mutt_pattern_exec(tmp->pat, MUTT_MATCH_FULL_ADDRESS, NULL, e, &cache) > 0)
180  {
181  if (tmp->exact || (tmp->val == 9999) || (tmp->val == -9999))
182  {
183  e->score = tmp->val;
184  break;
185  }
186  e->score += tmp->val;
187  }
188  }
189  if (e->score < 0)
190  e->score = 0;
191 
192  if (e->score <= C_ScoreThresholdDelete)
193  mutt_set_flag_update(m, e, MUTT_DELETE, true, upd_mbox);
194  if (e->score <= C_ScoreThresholdRead)
195  mutt_set_flag_update(m, e, MUTT_READ, true, upd_mbox);
196  if (e->score >= C_ScoreThresholdFlag)
197  mutt_set_flag_update(m, e, MUTT_FLAG, true, upd_mbox);
198 }
short C_ScoreThresholdFlag
Config: Messages with a greater score will be automatically flagged.
Definition: score.c:50
Flagged messages.
Definition: mutt.h:104
Match the full address.
Definition: pattern.h:72
static struct Score * ScoreList
Definition: score.c:65
int val
Definition: score.c:60
int score
Definition: email.h:91
Messages to be deleted.
Definition: mutt.h:100
Messages that have been read.
Definition: mutt.h:98
Scoring rule for email.
Definition: score.c:56
short C_ScoreThresholdDelete
Config: Messages with a lower score will be automatically deleted.
Definition: score.c:49
struct Score * next
Definition: score.c:62
short C_ScoreThresholdRead
Config: Messages with a lower score will be automatically marked read.
Definition: score.c:51
Cache commonly-used patterns.
Definition: pattern.h:83
bool exact
if this rule matches, don&#39;t evaluate any more
Definition: score.c:61
int mutt_pattern_exec(struct Pattern *pat, enum PatternExecFlag flags, struct Mailbox *m, struct Email *e, struct PatternCache *cache)
Match a pattern against an email header.
Definition: pattern.c:1931
struct Pattern * pat
Definition: score.c:59
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:56

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 203 of file score.c.

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

+ Here is the call graph for this function:

Variable Documentation

short C_ScoreThresholdDelete

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

Definition at line 49 of file score.c.

short C_ScoreThresholdFlag

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

Definition at line 50 of file score.c.

short C_ScoreThresholdRead

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

Definition at line 51 of file score.c.

struct Score* ScoreList = NULL
static

Definition at line 65 of file score.c.