score.h File Reference

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

#include <stdbool.h>
#include <stdint.h>
#include "mutt_commands.h"

Include dependency graph for score.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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, intptr_t data, struct Buffer *err)
	Parse the 'score' command - Implements Command::parse() More...
enum CommandResult	mutt_parse_unscore (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unscore' command - Implements Command::parse() More...
void	mutt_score_message (struct Mailbox *m, struct Email *e, bool upd_ctx)
	Apply scoring to an email. 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...

Detailed Description

Routines for adding user scores to emails.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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

Function Documentation

mutt_check_rescore()

void mutt_check_rescore

(

struct Mailbox *

m

)

Do the emails need to have their scores recalculated?

Parameters

m

Mailbox

Definition at line 71 of file score.c.

{
  if (OptNeedRescore && C_Score)
  {
    if (((C_Sort & SORT_MASK) == SORT_SCORE) || ((C_SortAux & SORT_MASK) == SORT_SCORE))
    {
      OptNeedResort = true;
      if ((C_Sort & SORT_MASK) == SORT_THREADS)
        OptSortSubthreads = true;
    }

    /* must redraw the index since the user might have %N in it */
    mutt_menu_set_redraw_full(MENU_MAIN);
    mutt_menu_set_redraw_full(MENU_PAGER);

    for (int i = 0; m && i < m->msg_count; i++)
    {
      struct Email *e = m->emails[i];
      if (!e)
        break;

      mutt_score_message(m, e, true);
      e->pair = 0;
    }
  }
  OptNeedRescore = false;
}

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,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'score' command - Implements Command::parse()

Definition at line 102 of file score.c.

{
  struct Score *ptr = NULL, *last = NULL;
  char *pattern = NULL, *pc = NULL;

  mutt_extract_token(buf, s, MUTT_TOKEN_NO_FLAGS);
  if (!MoreArgs(s))
  {
    mutt_buffer_printf(err, _("%s: too few arguments"), "score");
    return MUTT_CMD_WARNING;
  }
  pattern = mutt_buffer_strdup(buf);
  mutt_extract_token(buf, s, MUTT_TOKEN_NO_FLAGS);
  if (MoreArgs(s))
  {
    FREE(&pattern);
    mutt_buffer_printf(err, _("%s: too many arguments"), "score");
    return MUTT_CMD_WARNING;
  }

  /* look for an existing entry and update the value, else add it to the end
   * of the list */
  for (ptr = ScoreList, last = NULL; ptr; last = ptr, ptr = ptr->next)
    if (mutt_str_equal(pattern, ptr->str))
      break;
  if (!ptr)
  {
    struct PatternList *pat = mutt_pattern_comp(pattern, MUTT_PC_NO_FLAGS, err);
    if (!pat)
    {
      FREE(&pattern);
      return MUTT_CMD_ERROR;
    }
    ptr = mutt_mem_calloc(1, sizeof(struct Score));
    if (last)
      last->next = ptr;
    else
      ScoreList = ptr;
    ptr->pat = pat;
    ptr->str = pattern;
  }
  else
  {
    /* 'buf' arg was cleared and 'pattern' holds the only reference;
     * as here 'ptr' != NULL -> update the value only in which case
     * ptr->str already has the string, so pattern should be freed.  */
    FREE(&pattern);
  }
  pc = buf->data;
  if (*pc == '=')
  {
    ptr->exact = true;
    pc++;
  }
  if (mutt_str_atoi(pc, &ptr->val) < 0)
  {
    FREE(&pattern);
    mutt_buffer_strcpy(err, _("Error: score: invalid number"));
    return MUTT_CMD_ERROR;
  }
  OptNeedRescore = true;
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

mutt_parse_unscore()

enum CommandResult mutt_parse_unscore	(	struct Buffer *	buf,
		struct Buffer *	s,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'unscore' command - Implements Command::parse()

Definition at line 205 of file score.c.

{
  struct Score *tmp = NULL, *last = NULL;

  while (MoreArgs(s))
  {
    mutt_extract_token(buf, s, MUTT_TOKEN_NO_FLAGS);
    if (mutt_str_equal("*", buf->data))
    {
      for (tmp = ScoreList; tmp;)
      {
        last = tmp;
        tmp = tmp->next;
        mutt_pattern_free(&last->pat);
        FREE(&last);
      }
      ScoreList = NULL;
    }
    else
    {
      for (tmp = ScoreList; tmp; last = tmp, tmp = tmp->next)
      {
        if (mutt_str_equal(buf->data, tmp->str))
        {
          if (last)
            last->next = tmp->next;
          else
            ScoreList = tmp->next;
          mutt_pattern_free(&tmp->pat);
          FREE(&tmp);
          /* there should only be one score per pattern, so we can stop here */
          break;
        }
      }
    }
  }
  OptNeedRescore = true;
  return MUTT_CMD_SUCCESS;
}

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

m	Mailbox
e	Email
upd_mbox	If true, update the Mailbox too

Definition at line 173 of file score.c.

{
  struct Score *tmp = NULL;
  struct PatternCache cache = { 0 };

  e->score = 0; /* in case of re-scoring */
  for (tmp = ScoreList; tmp; tmp = tmp->next)
  {
    if (mutt_pattern_exec(SLIST_FIRST(tmp->pat), MUTT_MATCH_FULL_ADDRESS, NULL, e, &cache) > 0)
    {
      if (tmp->exact || (tmp->val == 9999) || (tmp->val == -9999))
      {
        e->score = tmp->val;
        break;
      }
      e->score += tmp->val;
    }
  }
  if (e->score < 0)
    e->score = 0;

  if (e->score <= C_ScoreThresholdDelete)
    mutt_set_flag_update(m, e, MUTT_DELETE, true, upd_mbox);
  if (e->score <= C_ScoreThresholdRead)
    mutt_set_flag_update(m, e, MUTT_READ, true, upd_mbox);
  if (e->score >= C_ScoreThresholdFlag)
    mutt_set_flag_update(m, e, MUTT_FLAG, true, upd_mbox);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C_ScoreThresholdDelete

short C_ScoreThresholdDelete

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

Definition at line 49 of file score.c.

C_ScoreThresholdFlag

short C_ScoreThresholdFlag

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

Definition at line 50 of file score.c.

C_ScoreThresholdRead

short C_ScoreThresholdRead

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

Definition at line 51 of file score.c.