group.h File Reference

Handling for email address groups. More...

#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "address.h"

Include dependency graph for group.h:

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

Go to the source code of this file.

Data Structures
struct	Group
	A set of email addresses. More...
struct	GroupNode
	An element in a GroupList. More...

Macros
#define	MUTT_GROUP   0
	'group' config command
#define	MUTT_UNGROUP   1
	'ungroup' config command

Functions
	STAILQ_HEAD (GroupList, GroupNode)
bool	group_match (struct Group *g, const char *str)
	Does a string match an entry in a Group?
void	grouplist_add_group (struct GroupList *gl, struct Group *g)
	Add a Group to a GroupList.
void	grouplist_add_addrlist (struct GroupList *gl, struct AddressList *al)
	Add Address list to a GroupList.
int	grouplist_add_regex (struct GroupList *gl, const char *str, uint16_t flags, struct Buffer *err)
	Add matching Addresses to a GroupList.
void	grouplist_destroy (struct GroupList *gl)
	Free a GroupList.
struct HashTable *	groups_new (void)
	Create a HashTable for the Address Groups.
void	groups_free (struct HashTable **pptr)
	Free Address Groups HashTable.
struct Group *	groups_get_group (struct HashTable *groups, const char *name)
	Get a Group by its name.
int	groups_remove_addrlist (struct HashTable *groups, struct GroupList *gl, struct AddressList *al)
	Remove an AddressList from a GroupList.
void	groups_remove_grouplist (struct HashTable *groups, struct GroupList *gl)
	Clear a GroupList.
int	groups_remove_regex (struct HashTable *groups, struct GroupList *gl, const char *str)
	Remove matching addresses from a GroupList.

Detailed Description

Handling for email address groups.

Authors

• Richard Russon
• 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 group.h.

Macro Definition Documentation

MUTT_GROUP

#define MUTT_GROUP   0

'group' config command

Definition at line 32 of file group.h.

MUTT_UNGROUP

#define MUTT_UNGROUP   1

'ungroup' config command

Definition at line 33 of file group.h.

Function Documentation

STAILQ_HEAD()

STAILQ_HEAD	(	GroupList	,
		GroupNode	)

group_match()

bool group_match	(	struct Group *	g,
		const char *	str )

Does a string match an entry in a Group?

Parameters

g	Group to match against
str	String to match

Return values

true	There's a match

Definition at line 161 of file group.c.

{
  if (!g || !str)
    return false;
 
  if (mutt_regexlist_match(&g->rs, str))
    return true;
  struct Address *a = NULL;
  TAILQ_FOREACH(a, &g->al, entries)
  {
    if (a->mailbox && mutt_istr_equal(str, buf_string(a->mailbox)))
      return true;
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

grouplist_add_group()

void grouplist_add_group	(	struct GroupList *	gl,
		struct Group *	g )

Add a Group to a GroupList.

Parameters

gl	GroupList to add to
g	Group to add

Definition at line 183 of file group.c.

{
  if (!gl || !g)
    return;
 
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    if (np->group == g)
      return;
  }
  np = MUTT_MEM_CALLOC(1, struct GroupNode);
  np->group = g;
  STAILQ_INSERT_TAIL(gl, np, entries);
}

Here is the caller graph for this function:

grouplist_add_addrlist()

void grouplist_add_addrlist	(	struct GroupList *	gl,
		struct AddressList *	al )

Add Address list to a GroupList.

Parameters

gl	GroupList to add to
al	Address list to add

Definition at line 224 of file group.c.

{
  if (!gl || !al)
    return;
 
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    group_add_addrlist(np->group, al);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

grouplist_add_regex()

int grouplist_add_regex	(	struct GroupList *	gl,
		const char *	str,
		uint16_t	flags,
		struct Buffer *	err )

Add matching Addresses to a GroupList.

Parameters

gl	GroupList to add to
str	Address regex string to match
flags	Flags, e.g. REG_ICASE
err	Buffer for error message

Return values

0	Success
-1	Error

Definition at line 245 of file group.c.

{
  if (!gl || !str)
    return -1;
 
  int rc = 0;
 
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    rc = group_add_regex(np->group, str, flags, err);
    if (rc)
      return rc;
  }
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

grouplist_destroy()

void grouplist_destroy

(

struct GroupList *

gl

)

Free a GroupList.

Parameters

gl	GroupList to free

Definition at line 203 of file group.c.

{
  if (!gl)
    return;
 
  struct GroupNode *np = STAILQ_FIRST(gl);
  struct GroupNode *next = NULL;
  while (np)
  {
    next = STAILQ_NEXT(np, entries);
    FREE(&np);
    np = next;
  }
  STAILQ_INIT(gl);
}

Here is the caller graph for this function:

groups_new()

struct HashTable * groups_new

(

void

)

Create a HashTable for the Address Groups.

Return values

ptr	New Groups HashTable

Definition at line 267 of file group.c.

{
  struct HashTable *groups = mutt_hash_new(1031, MUTT_HASH_NO_FLAGS);
 
  mutt_hash_set_destructor(groups, group_hash_free, 0);
 
  return groups;
}

Here is the call graph for this function:

Here is the caller graph for this function:

groups_free()

void groups_free

(

struct HashTable **

pptr

)

Free Address Groups HashTable.

Parameters

pptr	Groups HashTable to free

Definition at line 280 of file group.c.

{
  mutt_hash_free(pptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

groups_get_group()

struct Group * groups_get_group	(	struct HashTable *	groups,
		const char *	name )

Get a Group by its name.

Parameters

groups	Groups HashTable
name	Name to find

Return values

ptr	Matching Group, or new Group (if no match)

Definition at line 291 of file group.c.

{
  if (!groups || !name)
    return NULL;
 
  struct Group *g = mutt_hash_find(groups, name);
  if (!g)
  {
    mutt_debug(LL_DEBUG2, "Creating group %s\n", name);
    g = group_new(name);
    mutt_hash_insert(groups, g->name, g);
  }
 
  return g;
}

Here is the call graph for this function:

Here is the caller graph for this function:

groups_remove_addrlist()

int groups_remove_addrlist	(	struct HashTable *	groups,
		struct GroupList *	gl,
		struct AddressList *	al )

Remove an AddressList from a GroupList.

Parameters

groups	Groups HashTable
gl	GroupList to remove from
al	AddressList to remove

Return values

0	Success
-1	Error

Definition at line 337 of file group.c.

{
  if (!groups || !gl || !al)
    return -1;
 
  struct GroupNode *gnp = NULL;
  STAILQ_FOREACH(gnp, gl, entries)
  {
    struct Address *a = NULL;
    TAILQ_FOREACH(a, al, entries)
    {
      mutt_addrlist_remove(&gnp->group->al, buf_string(a->mailbox));
    }
    if (group_is_empty(gnp->group))
    {
      group_remove(groups, gnp->group);
    }
  }
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

groups_remove_grouplist()

void groups_remove_grouplist	(	struct HashTable *	groups,
		struct GroupList *	gl )

Clear a GroupList.

Parameters

groups	Groups HashTable
gl	GroupList to clear

Definition at line 312 of file group.c.

{
  if (!groups || !gl)
    return;
 
  struct GroupNode *np = STAILQ_FIRST(gl);
  struct GroupNode *next = NULL;
  while (np)
  {
    group_remove(groups, np->group);
    next = STAILQ_NEXT(np, entries);
    FREE(&np);
    np = next;
  }
  STAILQ_INIT(gl);
}

Here is the call graph for this function:

Here is the caller graph for this function:

groups_remove_regex()

int groups_remove_regex	(	struct HashTable *	groups,
		struct GroupList *	gl,
		const char *	str )

Remove matching addresses from a GroupList.

Parameters

groups	Groups HashTable
gl	GroupList to remove from
str	Regex string to match

Return values

0	Success
-1	Error

Definition at line 368 of file group.c.

{
  if (!groups || !gl || !str)
    return -1;
 
  int rc = 0;
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    rc = group_remove_regex(np->group, str);
    if (group_is_empty(np->group))
      group_remove(groups, np->group);
    if (rc != 0)
      return rc;
  }
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: