score.c File Reference

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

#include "config.h"
#include <stdbool.h>
#include <stdlib.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "score.h"
#include "index/lib.h"
#include "parse/lib.h"
#include "pattern/lib.h"
#include "email.h"
#include "globals.h"
#include "module_data.h"
#include "sort.h"

Include dependency graph for score.c:

Go to the source code of this file.

Functions
void	score_list_free (struct Score **sp)
	Free a list of scoring rules.
enum CommandResult	parse_score (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'score' command - Implements Command::parse() -.
enum CommandResult	parse_unscore (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'unscore' command - Implements Command::parse() -.
void	mutt_check_rescore (struct Mailbox *m)
	Do the emails need to have their scores recalculated?
void	mutt_score_message (struct Mailbox *m, struct Email *e, bool upd_mbox)
	Apply scoring to an email.

Detailed Description

Routines for adding user scores to emails.

Authors

• Michael R. Elkins
• Richard Russon
• Victor Fernandes
• Pietro Cerutti

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

Function Documentation

score_list_free()

void score_list_free

(

struct Score **

sp

)

Free a list of scoring rules.

Parameters

[out]

sp

Head of the Score list

Definition at line 53 of file score.c.

{
  if (!sp)
    return;
 
  struct Score *sc = *sp;
  while (sc)
  {
    struct Score *next = sc->next;
    mutt_pattern_free(&sc->pat);
    FREE(&sc->str);
    FREE(&sc);
    sc = next;
  }
  *sp = NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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

{
  const bool c_score = cs_subset_bool(NeoMutt->sub, "score");
  if (OptNeedRescore && c_score)
  {
    const enum EmailSortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
    const enum EmailSortType c_sort_aux = cs_subset_sort(NeoMutt->sub, "sort_aux");
    if (((c_sort & SORT_MASK) == EMAIL_SORT_SCORE) ||
        ((c_sort_aux & SORT_MASK) == EMAIL_SORT_SCORE))
    {
      OptNeedResort = true;
      if (mutt_using_threads())
        OptSortSubthreads = true;
    }
 
    mutt_debug(LL_NOTIFY, "NT_SCORE: %p\n", (void *) m);
    notify_send(m->notify, NT_SCORE, 0, NULL);
  }
  OptNeedRescore = false;
}

Here is the call graph for this function:

Here is the caller 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 243 of file score.c.

{
  struct EmailModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  struct Score *tmp = NULL;
  struct PatternCache cache = { 0 };
 
  e->score = 0; /* in case of re-scoring */
  for (tmp = mod_data->score_list; 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;
 
  const short c_score_threshold_delete = cs_subset_number(NeoMutt->sub, "score_threshold_delete");
  const short c_score_threshold_flag = cs_subset_number(NeoMutt->sub, "score_threshold_flag");
  const short c_score_threshold_read = cs_subset_number(NeoMutt->sub, "score_threshold_read");
 
  if (e->score <= c_score_threshold_delete)
    mutt_set_flag(m, e, MUTT_DELETE, true, upd_mbox);
  if (e->score <= c_score_threshold_read)
    mutt_set_flag(m, e, MUTT_READ, true, upd_mbox);
  if (e->score >= c_score_threshold_flag)
    mutt_set_flag(m, e, MUTT_FLAG, true, upd_mbox);
}

Here is the call graph for this function:

Here is the caller graph for this function: