NeoMutt  2021-10-29-220-g2b1eec
Teaching an old dog new tricks
DOXYGEN
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 More...
 
#define MUTT_UNGROUP   1
 'ungroup' config command More...
 

Functions

 STAILQ_HEAD (GroupList, GroupNode)
 
void mutt_grouplist_add (struct GroupList *gl, struct Group *group)
 Add a Group to a GroupList. More...
 
void mutt_grouplist_add_addrlist (struct GroupList *gl, struct AddressList *a)
 Add Address list to a GroupList. More...
 
int mutt_grouplist_add_regex (struct GroupList *gl, const char *s, uint16_t flags, struct Buffer *err)
 Add matching Addresses to a GroupList. More...
 
void mutt_grouplist_clear (struct GroupList *gl)
 Clear a GroupList. More...
 
void mutt_grouplist_destroy (struct GroupList *gl)
 Free a GroupList. More...
 
void mutt_grouplist_free (void)
 Free GroupList singleton resource. More...
 
void mutt_grouplist_init (void)
 Initialize the GroupList singleton. More...
 
int mutt_grouplist_remove_addrlist (struct GroupList *gl, struct AddressList *a)
 Remove an AddressList from a GroupList. More...
 
int mutt_grouplist_remove_regex (struct GroupList *gl, const char *s)
 Remove matching addresses from a GroupList. More...
 
bool mutt_group_match (struct Group *g, const char *s)
 Does a string match an entry in a Group? More...
 
struct Groupmutt_pattern_group (const char *pat)
 Match a pattern to a Group. More...
 

Detailed Description

Handling for email address groups.

Authors
  • Thomas Roessler
  • Rocco Rutte
  • Pietro Cerutti

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 33 of file group.h.

◆ MUTT_UNGROUP

#define MUTT_UNGROUP   1

'ungroup' config command

Definition at line 34 of file group.h.

Function Documentation

◆ STAILQ_HEAD()

STAILQ_HEAD ( GroupList  ,
GroupNode   
)

◆ mutt_grouplist_add()

void mutt_grouplist_add ( struct GroupList *  gl,
struct Group group 
)

Add a Group to a GroupList.

Parameters
glGroupList to add to
groupGroup to add

Definition at line 181 of file group.c.

182 {
183  if (!gl || !group)
184  return;
185 
186  struct GroupNode *np = NULL;
187  STAILQ_FOREACH(np, gl, entries)
188  {
189  if (np->group == group)
190  return;
191  }
192  np = mutt_mem_calloc(1, sizeof(struct GroupNode));
193  np->group = group;
194  STAILQ_INSERT_TAIL(gl, np, entries);
195 }
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define STAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:389
An element in a GroupList.
Definition: group.h:50
struct Group * group
Address Group.
Definition: group.h:51
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_grouplist_add_addrlist()

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

Add Address list to a GroupList.

Parameters
glGroupList to add to
alAddress list to add

Definition at line 270 of file group.c.

271 {
272  if (!gl || !al)
273  return;
274 
275  struct GroupNode *np = NULL;
276  STAILQ_FOREACH(np, gl, entries)
277  {
278  group_add_addrlist(np->group, al);
279  }
280 }
static void group_add_addrlist(struct Group *g, const struct AddressList *al)
Add an Address List to a Group.
Definition: group.c:222
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_grouplist_add_regex()

int mutt_grouplist_add_regex ( struct GroupList *  gl,
const char *  s,
uint16_t  flags,
struct Buffer err 
)

Add matching Addresses to a GroupList.

Parameters
glGroupList to add to
sAddress to match
flagsFlags, e.g. REG_ICASE
errBuffer for error message
Return values
0Success
-1Error

Definition at line 320 of file group.c.

322 {
323  if (!gl || !s)
324  return -1;
325 
326  int rc = 0;
327 
328  struct GroupNode *np = NULL;
329  STAILQ_FOREACH(np, gl, entries)
330  {
331  rc = group_add_regex(np->group, s, flags, err);
332  if (rc)
333  return rc;
334  }
335  return rc;
336 }
static int group_add_regex(struct Group *g, const char *s, uint16_t flags, struct Buffer *err)
Add a Regex to a Group.
Definition: group.c:248
+ Here is the call graph for this function:

◆ mutt_grouplist_clear()

void mutt_grouplist_clear ( struct GroupList *  gl)

Clear a GroupList.

Parameters
glGroupList to clear

Definition at line 147 of file group.c.

148 {
149  if (!gl)
150  return;
151 
152  struct GroupNode *np = STAILQ_FIRST(gl);
153  struct GroupNode *next = NULL;
154  while (np)
155  {
156  group_remove(np->group);
157  next = STAILQ_NEXT(np, entries);
158  FREE(&np);
159  np = next;
160  }
161  STAILQ_INIT(gl);
162 }
static void group_remove(struct Group *g)
Remove a Group from the Hash Table.
Definition: group.c:132
#define FREE(x)
Definition: memory.h:40
#define STAILQ_INIT(head)
Definition: queue.h:372
#define STAILQ_FIRST(head)
Definition: queue.h:350
#define STAILQ_NEXT(elm, field)
Definition: queue.h:400
+ Here is the call graph for this function:

◆ mutt_grouplist_destroy()

void mutt_grouplist_destroy ( struct GroupList *  gl)

Free a GroupList.

Parameters
glGroupList to free

Definition at line 201 of file group.c.

202 {
203  if (!gl)
204  return;
205 
206  struct GroupNode *np = STAILQ_FIRST(gl);
207  struct GroupNode *next = NULL;
208  while (np)
209  {
210  next = STAILQ_NEXT(np, entries);
211  FREE(&np);
212  np = next;
213  }
214  STAILQ_INIT(gl);
215 }
+ Here is the caller graph for this function:

◆ mutt_grouplist_free()

void mutt_grouplist_free ( void  )

Free GroupList singleton resource.

This is called once from init.c when deinitializing the global resources.

Definition at line 102 of file group.c.

103 {
105 }
static struct HashTable * Groups
Definition: group.c:38
void mutt_hash_free(struct HashTable **ptr)
Free a hash table.
Definition: hash.c:457
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_grouplist_init()

void mutt_grouplist_init ( void  )

Initialize the GroupList singleton.

This is called once from init.c when initializing the global structures.

Definition at line 90 of file group.c.

91 {
93 
95 }
void group_hash_free(int type, void *obj, intptr_t data)
Free our hash table data - Implements hash_hdata_free_t -.
Definition: group.c:79
struct HashTable * mutt_hash_new(size_t num_elems, HashFlags flags)
Create a new Hash Table (with string keys)
Definition: hash.c:259
void mutt_hash_set_destructor(struct HashTable *table, hash_hdata_free_t fn, intptr_t fn_data)
Set the destructor for a Hash Table.
Definition: hash.c:301
#define MUTT_HASH_NO_FLAGS
No flags are set.
Definition: hash.h:109
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_grouplist_remove_addrlist()

int mutt_grouplist_remove_addrlist ( struct GroupList *  gl,
struct AddressList *  al 
)

Remove an AddressList from a GroupList.

Parameters
glGroupList to remove from
alAddressList to remove
Return values
0Success
-1Error

Definition at line 289 of file group.c.

290 {
291  if (!gl || !al)
292  return -1;
293 
294  struct GroupNode *gnp = NULL;
295  STAILQ_FOREACH(gnp, gl, entries)
296  {
297  struct Address *a = NULL;
298  TAILQ_FOREACH(a, al, entries)
299  {
300  mutt_addrlist_remove(&gnp->group->al, a->mailbox);
301  }
302  if (empty_group(gnp->group))
303  {
304  group_remove(gnp->group);
305  }
306  }
307 
308  return 0;
309 }
int mutt_addrlist_remove(struct AddressList *al, const char *mailbox)
Remove an Address from a list.
Definition: address.c:413
static bool empty_group(struct Group *g)
Is a Group empty?
Definition: group.c:169
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:725
An email address.
Definition: address.h:36
char * mailbox
Mailbox and host address.
Definition: address.h:38
struct AddressList al
List of Addresses.
Definition: group.h:41
+ Here is the call graph for this function:

◆ mutt_grouplist_remove_regex()

int mutt_grouplist_remove_regex ( struct GroupList *  gl,
const char *  s 
)

Remove matching addresses from a GroupList.

Parameters
glGroupList to remove from
sAddress to match
Return values
0Success
-1Error

Definition at line 345 of file group.c.

346 {
347  if (!gl || !s)
348  return -1;
349 
350  int rc = 0;
351  struct GroupNode *np = NULL;
352  STAILQ_FOREACH(np, gl, entries)
353  {
354  rc = group_remove_regex(np->group, s);
355  if (empty_group(np->group))
356  group_remove(np->group);
357  if (rc)
358  return rc;
359  }
360  return rc;
361 }
static int group_remove_regex(struct Group *g, const char *s)
Remove a Regex from a Group.
Definition: group.c:260
+ Here is the call graph for this function:

◆ mutt_group_match()

bool mutt_group_match ( struct Group g,
const char *  s 
)

Does a string match an entry in a Group?

Parameters
gGroup to match against
sString to match
Return values
trueThere's a match

Definition at line 369 of file group.c.

370 {
371  if (!g || !s)
372  return false;
373 
374  if (mutt_regexlist_match(&g->rs, s))
375  return true;
376  struct Address *a = NULL;
377  TAILQ_FOREACH(a, &g->al, entries)
378  {
379  if (a->mailbox && mutt_istr_equal(s, a->mailbox))
380  return true;
381  }
382 
383  return false;
384 }
bool mutt_regexlist_match(struct RegexList *rl, const char *str)
Does a string match any Regex in the list?
Definition: regex.c:194
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:727
struct RegexList rs
Group Regex patterns.
Definition: group.h:42
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_pattern_group()

struct Group* mutt_pattern_group ( const char *  pat)

Match a pattern to a Group.

Parameters
patPattern to match
Return values
ptrMatching Group, or new Group (if no match)

Definition at line 112 of file group.c.

113 {
114  if (!pat)
115  return NULL;
116 
117  struct Group *g = mutt_hash_find(Groups, pat);
118  if (!g)
119  {
120  mutt_debug(LL_DEBUG2, "Creating group %s\n", pat);
121  g = group_new(pat);
122  mutt_hash_insert(Groups, g->name, g);
123  }
124 
125  return g;
126 }
struct Group * group_new(const char *pat)
Create a new Address Group.
Definition: group.c:65
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
struct HashElem * mutt_hash_insert(struct HashTable *table, const char *strkey, void *data)
Add a new element to the Hash Table (with string keys)
Definition: hash.c:335
void * mutt_hash_find(const struct HashTable *table, const char *strkey)
Find the HashElem data in a Hash Table element using a key.
Definition: hash.c:362
@ LL_DEBUG2
Log at debug level 2.
Definition: logging.h:41
A set of email addresses.
Definition: group.h:40
char * name
Name of Group.
Definition: group.h:43
+ Here is the call graph for this function:
+ Here is the caller graph for this function: