subjectrx.c File Reference

Subject Regex handling. More...

#include "config.h"
#include <stddef.h>
#include "mutt/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "subjectrx.h"
#include "parse/lib.h"
#include "mview.h"

Include dependency graph for subjectrx.c:

Go to the source code of this file.

Functions
void	subjrx_cleanup (void)
	Free the Subject Regex List.
void	subjrx_init (void)
	Create new Subject Regex List.
static enum CommandResult	parse_unreplace_list (const struct Command *cmd, struct Buffer *line, struct ReplaceList *list, struct Buffer *err)
	Remove a string replacement rule.
static enum CommandResult	parse_replace_list (const struct Command *cmd, struct Buffer *line, struct ReplaceList *list, struct Buffer *err)
	Parse a string replacement rule.
bool	subjrx_apply_mods (struct Envelope *env)
	Apply regex modifications to the subject.
void	subjrx_clear_mods (struct MailboxView *mv)
	Clear out all modified email subjects.
enum CommandResult	parse_subjectrx_list (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse the 'subjectrx' command - Implements Command::parse() -.
enum CommandResult	parse_unsubjectrx_list (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse the 'unsubjectrx' command - Implements Command::parse() -.

Variables
static struct ReplaceList	SubjectRegexList = STAILQ_HEAD_INITIALIZER(SubjectRegexList)
	List of subjectrx rules for modifying the Subject:
static struct Notify *	SubjRxNotify = NULL
	Notifications: NotifySubjRx.

Detailed Description

Subject Regex handling.

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

Function Documentation

subjrx_cleanup()

void subjrx_cleanup

(

void

)

Free the Subject Regex List.

Definition at line 45 of file subjectrx.c.

{
  notify_free(&SubjRxNotify);
  mutt_replacelist_free(&SubjectRegexList);
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjrx_init()

void subjrx_init

(

void

)

Create new Subject Regex List.

Definition at line 54 of file subjectrx.c.

{
  if (SubjRxNotify)
    return;
 
  SubjRxNotify = notify_new();
  notify_set_parent(SubjRxNotify, NeoMutt->notify);
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_unreplace_list()

static enum CommandResult parse_unreplace_list ( const struct Command * cmd, struct Buffer * line, struct ReplaceList * list, struct Buffer * err )

static

Remove a string replacement rule.

Parameters

cmd	Command being parsed
line	Buffer containing string to be parsed
list	ReplaceList to be updated
err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Definition at line 71 of file subjectrx.c.

{
  if (!MoreArgs(line))
  {
    buf_printf(err, _("%s: too few arguments"), cmd->name);
    return MUTT_CMD_WARNING;
  }
 
  struct Buffer *token = buf_pool_get();
 
  /* First token is a regex. */
  parse_extract_token(token, line, TOKEN_NO_FLAGS);
 
  /* "*" is a special case. */
  if (mutt_str_equal(buf_string(token), "*"))
  {
    mutt_replacelist_free(list);
    buf_pool_release(&token);
    return MUTT_CMD_SUCCESS;
  }
 
  mutt_replacelist_remove(list, buf_string(token));
  buf_pool_release(&token);
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_replace_list()

static enum CommandResult parse_replace_list ( const struct Command * cmd, struct Buffer * line, struct ReplaceList * list, struct Buffer * err )

static

Parse a string replacement rule.

Parameters

cmd	Command being parsed
line	Buffer containing string to be parsed
list	ReplaceList to be updated
err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Definition at line 107 of file subjectrx.c.

{
  struct Buffer *templ = buf_pool_get();
  struct Buffer *regex = buf_pool_get();
  int rc = MUTT_CMD_WARNING;
 
  if (!MoreArgs(line))
  {
    buf_printf(err, _("%s: too few arguments"), cmd->name);
    goto done;
  }
 
  /* First token is a regex. */
  parse_extract_token(regex, line, TOKEN_NO_FLAGS);
 
  if (!MoreArgs(line))
  {
    buf_printf(err, _("%s: too few arguments"), cmd->name);
    goto done;
  }
 
  /* Second token is a replacement template */
  parse_extract_token(templ, line, TOKEN_NO_FLAGS);
 
  if (mutt_replacelist_add(list, buf_string(regex), buf_string(templ), err) != 0)
  {
    rc = MUTT_CMD_ERROR;
    goto done;
  }
 
  rc = MUTT_CMD_SUCCESS;
 
done:
  buf_pool_release(&regex);
  buf_pool_release(&templ);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjrx_apply_mods()

bool subjrx_apply_mods

(

struct Envelope *

env

)

Apply regex modifications to the subject.

Parameters

env	Envelope of Email

Return values

true	Subject modified

Definition at line 151 of file subjectrx.c.

{
  if (!env || !env->subject || (*env->subject == '\0'))
    return false;
 
  if (env->disp_subj)
    return true;
 
  if (STAILQ_EMPTY(&SubjectRegexList))
    return false;
 
  env->disp_subj = mutt_replacelist_apply(&SubjectRegexList, env->subject);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjrx_clear_mods()

void subjrx_clear_mods

(

struct MailboxView *

mv

)

Clear out all modified email subjects.

Parameters

mv	Mailbox view

Definition at line 170 of file subjectrx.c.

{
  if (!mv || !mv->mailbox)
    return;
 
  struct Mailbox *m = mv->mailbox;
 
  for (int i = 0; i < m->msg_count; i++)
  {
    struct Email *e = m->emails[i];
    if (!e || !e->env)
      continue;
    FREE(&e->env->disp_subj);
  }
}

Here is the caller graph for this function:

Variable Documentation

SubjectRegexList

struct ReplaceList SubjectRegexList = STAILQ_HEAD_INITIALIZER(SubjectRegexList)

static

List of subjectrx rules for modifying the Subject:

Definition at line 39 of file subjectrx.c.

SubjRxNotify

struct Notify* SubjRxNotify = NULL

static

Notifications: NotifySubjRx.

Definition at line 40 of file subjectrx.c.