hdrline.c File Reference

String processing routines to generate the mail index. More...

#include "config.h"
#include <locale.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "gui/lib.h"
#include "hdrline.h"
#include "attach/lib.h"
#include "color/lib.h"
#include "ncrypt/lib.h"
#include "format_flags.h"
#include "hook.h"
#include "maillist.h"
#include "mutt_thread.h"
#include "muttlib.h"
#include "mx.h"
#include "sort.h"
#include "subjectrx.h"
#include "notmuch/lib.h"

Include dependency graph for hdrline.c:

Go to the source code of this file.

Data Structures
struct	HdrFormatInfo
	Data passed to index_format_str() More...

Enumerations
enum	FlagChars {   FLAG_CHAR_TAGGED , FLAG_CHAR_IMPORTANT , FLAG_CHAR_DELETED , FLAG_CHAR_DELETED_ATTACH ,   FLAG_CHAR_REPLIED , FLAG_CHAR_OLD , FLAG_CHAR_NEW , FLAG_CHAR_OLD_THREAD ,   FLAG_CHAR_NEW_THREAD , FLAG_CHAR_SEMPTY , FLAG_CHAR_ZEMPTY }
	Index into the $flag_chars variable ($flag_chars) More...
enum	CryptChars {   FLAG_CHAR_CRYPT_GOOD_SIGN , FLAG_CHAR_CRYPT_ENCRYPTED , FLAG_CHAR_CRYPT_SIGNED , FLAG_CHAR_CRYPT_CONTAINS_KEY ,   FLAG_CHAR_CRYPT_NO_CRYPTO }
	Index into the $crypt_chars variable ($crypt_chars) More...
enum	FieldType {   DISP_TO , DISP_CC , DISP_BCC , DISP_FROM ,   DISP_PLAIN , DISP_MAX }
	Header types. More...

Functions
static size_t	add_index_color (char *buf, size_t buflen, MuttFormatFlags flags, enum ColorId color)
	Insert a color marker into a string. More...
static const char *	get_nth_wchar (const struct MbTable *table, int index)
	Extract one char from a multi-byte table. More...
static const char *	make_from_prefix (enum FieldType disp)
	Create a prefix for an author field. More...
static void	make_from (struct Envelope *env, char *buf, size_t buflen, bool do_lists, MuttFormatFlags flags)
	Generate a From: field (with optional prefix) More...
static void	make_from_addr (struct Envelope *env, char *buf, size_t buflen, bool do_lists)
	Create a 'from' address for a reply email. More...
static bool	user_in_addr (struct AddressList *al)
	Do any of the addresses refer to the user? More...
static int	user_is_recipient (struct Email *e)
	Is the user a recipient of the message. More...
static bool	thread_is_new (struct Email *e)
	Does the email thread contain any new emails? More...
static bool	thread_is_old (struct Email *e)
	Does the email thread contain any unread emails? More...
static const char *	index_format_str (char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, intptr_t data, MuttFormatFlags flags)
	Format a string for the index list - Implements format_t -. More...
void	mutt_make_string (char *buf, size_t buflen, int cols, const char *s, struct Mailbox *m, int inpgr, struct Email *e, MuttFormatFlags flags, const char *progress)
	Create formatted strings using mailbox expandos. More...

Detailed Description

String processing routines to generate the mail index.

Authors

• Michael R. Elkins
• Richard Russon
• Ian Zimmerman
• 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 hdrline.c.

Enumeration Type Documentation

FlagChars

enum FlagChars

Index into the $flag_chars variable ($flag_chars)

Enumerator
FLAG_CHAR_TAGGED	Character denoting a tagged email.
FLAG_CHAR_IMPORTANT	Character denoting a important (flagged) email.
FLAG_CHAR_DELETED	Character denoting a deleted email.
FLAG_CHAR_DELETED_ATTACH	Character denoting a deleted attachment.
FLAG_CHAR_REPLIED	Character denoting an email that has been replied to.
FLAG_CHAR_OLD	Character denoting an email that has been read.
FLAG_CHAR_NEW	Character denoting an unread email.
FLAG_CHAR_OLD_THREAD	Character denoting a thread of emails that has been read.
FLAG_CHAR_NEW_THREAD	Character denoting a thread containing at least one new email.
FLAG_CHAR_SEMPTY	Character denoting a read email, $index_format S expando.
FLAG_CHAR_ZEMPTY	Character denoting a read email, $index_format Z expando.

Definition at line 77 of file hdrline.c.

{
  FLAG_CHAR_TAGGED,         
  FLAG_CHAR_IMPORTANT,      
  FLAG_CHAR_DELETED,        
  FLAG_CHAR_DELETED_ATTACH, 
  FLAG_CHAR_REPLIED, 
  FLAG_CHAR_OLD,     
  FLAG_CHAR_NEW,     
  FLAG_CHAR_OLD_THREAD, 
  FLAG_CHAR_NEW_THREAD, 
  FLAG_CHAR_SEMPTY, 
  FLAG_CHAR_ZEMPTY, 
};

CryptChars

enum CryptChars

Index into the $crypt_chars variable ($crypt_chars)

Enumerator
FLAG_CHAR_CRYPT_GOOD_SIGN	Character denoting a message signed with a verified key.
FLAG_CHAR_CRYPT_ENCRYPTED	Character denoting a message is PGP-encrypted.
FLAG_CHAR_CRYPT_SIGNED	Character denoting a message is signed.
FLAG_CHAR_CRYPT_CONTAINS_KEY	Character denoting a message contains a PGP key.
FLAG_CHAR_CRYPT_NO_CRYPTO	Character denoting a message has no cryptography information.

Definition at line 95 of file hdrline.c.

{
  FLAG_CHAR_CRYPT_GOOD_SIGN, 
  FLAG_CHAR_CRYPT_ENCRYPTED, 
  FLAG_CHAR_CRYPT_SIGNED,    
  FLAG_CHAR_CRYPT_CONTAINS_KEY, 
  FLAG_CHAR_CRYPT_NO_CRYPTO, 
};

FieldType

enum FieldType

Header types.

Strings for printing headers

Enumerator
DISP_TO	To: string.
DISP_CC	Cc: string.
DISP_BCC	Bcc: string.
DISP_FROM	From: string.
DISP_PLAIN	Empty string.
DISP_MAX

Definition at line 109 of file hdrline.c.

{
  DISP_TO,    
  DISP_CC,    
  DISP_BCC,   
  DISP_FROM,  
  DISP_PLAIN, 
  DISP_MAX,
};

Function Documentation

add_index_color()

static size_t add_index_color ( char *  buf, size_t  buflen, MuttFormatFlags  flags, enum ColorId  color  )

static

Insert a color marker into a string.

Parameters

buf	Buffer to store marker
buflen	Buffer length
flags	Flags, see MuttFormatFlags
color	Color, e.g. MT_COLOR_MESSAGE

Return values

num	Characters written

The colors are stored as "magic" strings embedded in the text.

Definition at line 129 of file hdrline.c.

{
  /* only add color markers if we are operating on main index entries. */
  if (!(flags & MUTT_FORMAT_INDEX))
    return 0;
 
  /* this item is going to be passed to an external filter */
  if (flags & MUTT_FORMAT_NOFILTER)
    return 0;
 
  if (color == MT_COLOR_INDEX)
  { /* buf might be uninitialized other cases */
    const size_t len = mutt_str_len(buf);
    buf += len;
    buflen -= len;
  }
 
  if (buflen <= 2)
    return 0;
 
  buf[0] = MUTT_SPECIAL_INDEX;
  buf[1] = color;
  buf[2] = '\0';
 
  return 2;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_nth_wchar()

static const char * get_nth_wchar ( const struct MbTable *  table, int  index  )

static

Extract one char from a multi-byte table.

Parameters

table	Multi-byte table
index	Select this character

Return values

ptr	String pointer to the character

Extract one multi-byte character from a string table. If the index is invalid, then a space character will be returned. If the character selected is '
' (Ctrl-M), then "" will be returned.

Definition at line 166 of file hdrline.c.

{
  if (!table || !table->chars || (index < 0) || (index >= table->len))
    return " ";
 
  if (table->chars[index][0] == '\r')
    return "";
 
  return table->chars[index];
}

Here is the caller graph for this function:

make_from_prefix()

static const char * make_from_prefix ( enum FieldType  disp )

static

Create a prefix for an author field.

Parameters

disp	Type of field

Return values

ptr	Prefix string (do not free it)

If $from_chars is set, pick an appropriate character from it. If not, use the default prefix: "To", "Cc", etc

Definition at line 185 of file hdrline.c.

{
  /* need 2 bytes at the end, one for the space, another for NUL */
  static char padded[8];
  static const char *long_prefixes[DISP_MAX] = {
    [DISP_TO] = "To ", [DISP_CC] = "Cc ", [DISP_BCC] = "Bcc ",
    [DISP_FROM] = "",  [DISP_PLAIN] = "",
  };
 
  const struct MbTable *c_from_chars = cs_subset_mbtable(NeoMutt->sub, "from_chars");
 
  if (!c_from_chars || !c_from_chars->chars || (c_from_chars->len == 0))
    return long_prefixes[disp];
 
  const char *pchar = get_nth_wchar(c_from_chars, disp);
  if (mutt_str_len(pchar) == 0)
    return "";
 
  snprintf(padded, sizeof(padded), "%s ", pchar);
  return padded;
}

Here is the call graph for this function:

Here is the caller graph for this function:

make_from()

static void make_from ( struct Envelope *  env, char *  buf, size_t  buflen, bool  do_lists, MuttFormatFlags  flags  )

static

Generate a From: field (with optional prefix)

Parameters

env	Envelope of the email
buf	Buffer to store the result
buflen	Size of the buffer
do_lists	Should we check for mailing lists?
flags	Format flags, see MuttFormatFlags

Generate the F or L field in $index_format. This is the author, or recipient of the email.

The field can optionally be prefixed by a character from $from_chars. If $from_chars is not set, the prefix will be, "To", "Cc", etc

Definition at line 221 of file hdrline.c.

{
  if (!env || !buf)
    return;
 
  bool me;
  enum FieldType disp;
  struct AddressList *name = NULL;
 
  me = mutt_addr_is_user(TAILQ_FIRST(&env->from));
 
  if (do_lists || me)
  {
    if (check_for_mailing_list(&env->to, make_from_prefix(DISP_TO), buf, buflen))
      return;
    if (check_for_mailing_list(&env->cc, make_from_prefix(DISP_CC), buf, buflen))
      return;
  }
 
  if (me && !TAILQ_EMPTY(&env->to))
  {
    disp = (flags & MUTT_FORMAT_PLAIN) ? DISP_PLAIN : DISP_TO;
    name = &env->to;
  }
  else if (me && !TAILQ_EMPTY(&env->cc))
  {
    disp = DISP_CC;
    name = &env->cc;
  }
  else if (me && !TAILQ_EMPTY(&env->bcc))
  {
    disp = DISP_BCC;
    name = &env->bcc;
  }
  else if (!TAILQ_EMPTY(&env->from))
  {
    disp = DISP_FROM;
    name = &env->from;
  }
  else
  {
    *buf = '\0';
    return;
  }
 
  snprintf(buf, buflen, "%s%s", make_from_prefix(disp), mutt_get_name(TAILQ_FIRST(name)));
}

Here is the call graph for this function:

Here is the caller graph for this function:

make_from_addr()

static void make_from_addr ( struct Envelope *  env, char *  buf, size_t  buflen, bool  do_lists  )

static

Create a 'from' address for a reply email.

Parameters

env	Envelope of current email
buf	Buffer for the result
buflen	Length of buffer
do_lists	If true, check for mailing lists

Definition at line 277 of file hdrline.c.

{
  if (!env || !buf)
    return;
 
  bool me = mutt_addr_is_user(TAILQ_FIRST(&env->from));
 
  if (do_lists || me)
  {
    if (check_for_mailing_list_addr(&env->to, buf, buflen))
      return;
    if (check_for_mailing_list_addr(&env->cc, buf, buflen))
      return;
  }
 
  if (me && !TAILQ_EMPTY(&env->to))
    snprintf(buf, buflen, "%s", TAILQ_FIRST(&env->to)->mailbox);
  else if (me && !TAILQ_EMPTY(&env->cc))
    snprintf(buf, buflen, "%s", TAILQ_FIRST(&env->cc)->mailbox);
  else if (!TAILQ_EMPTY(&env->from))
    mutt_str_copy(buf, TAILQ_FIRST(&env->from)->mailbox, buflen);
  else
    *buf = '\0';
}

Here is the call graph for this function:

Here is the caller graph for this function:

user_in_addr()

static bool user_in_addr ( struct AddressList *  al )

static

Do any of the addresses refer to the user?

Parameters

al	AddressList

Return values

true	Any of the addresses match one of the user's addresses

Definition at line 307 of file hdrline.c.

{
  struct Address *a = NULL;
  TAILQ_FOREACH(a, al, entries)
  if (mutt_addr_is_user(a))
    return true;
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

user_is_recipient()

static int user_is_recipient ( struct Email *  e )

static

Is the user a recipient of the message.

Parameters

e	Email to test

Return values

0	User is not in list
1	User is unique recipient
2	User is in the TO list
3	User is in the CC list
4	User is originator
5	Sent to a subscribed mailinglist
6	User is in the Reply-To list

Definition at line 327 of file hdrline.c.

{
  if (!e || !e->env)
    return 0;
 
  struct Envelope *env = e->env;
 
  if (!e->recip_valid)
  {
    e->recip_valid = true;
 
    if (mutt_addr_is_user(TAILQ_FIRST(&env->from)))
    {
      e->recipient = 4;
    }
    else if (user_in_addr(&env->to))
    {
      if (TAILQ_NEXT(TAILQ_FIRST(&env->to), entries) || !TAILQ_EMPTY(&env->cc))
        e->recipient = 2; /* non-unique recipient */
      else
        e->recipient = 1; /* unique recipient */
    }
    else if (user_in_addr(&env->cc))
    {
      e->recipient = 3;
    }
    else if (check_for_mailing_list(&env->to, NULL, NULL, 0))
    {
      e->recipient = 5;
    }
    else if (check_for_mailing_list(&env->cc, NULL, NULL, 0))
    {
      e->recipient = 5;
    }
    else if (user_in_addr(&env->reply_to))
    {
      e->recipient = 6;
    }
    else
    {
      e->recipient = 0;
    }
  }
 
  return e->recipient;
}

Here is the call graph for this function:

Here is the caller graph for this function:

thread_is_new()

static bool thread_is_new ( struct Email *  e )

static

Does the email thread contain any new emails?

Parameters

e

Email

Return values

true	Thread contains new mail

Definition at line 379 of file hdrline.c.

{
  return e->collapsed && (e->num_hidden > 1) && (mutt_thread_contains_unread(e) == 1);
}

Here is the caller graph for this function:

thread_is_old()

static bool thread_is_old ( struct Email *  e )

static

Does the email thread contain any unread emails?

Parameters

e

Email

Return values

true	Thread contains unread mail

Definition at line 389 of file hdrline.c.

{
  return e->collapsed && (e->num_hidden > 1) && (mutt_thread_contains_unread(e) == 2);
}

Here is the caller graph for this function:

mutt_make_string()

void mutt_make_string	(	char *	buf,
		size_t	buflen,
		int	cols,
		const char *	s,
		struct Mailbox *	m,
		int	inpgr,
		struct Email *	e,
		MuttFormatFlags	flags,
		const char *	progress
	)

Create formatted strings using mailbox expandos.

Parameters

buf	Buffer for the result
buflen	Buffer length
cols	Number of screen columns (OPTIONAL)
s	printf-line format string
m	Mailbox
inpgr	Message shown in the pager
e	Email
flags	Flags, see MuttFormatFlags
progress	Pager progress string

See also

index_format_str()

Definition at line 1489 of file hdrline.c.

{
  struct HdrFormatInfo hfi = { 0 };
 
  hfi.email = e;
  hfi.mailbox = m;
  hfi.msg_in_pager = inpgr;
  hfi.pager_progress = progress;
 
  mutt_expando_format(buf, buflen, 0, cols, s, index_format_str, (intptr_t) &hfi, flags);
}

Here is the call graph for this function:

Here is the caller graph for this function: