alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

* MuMsgContact refactoring (split off)

Browse Source
This commit is contained in:
djcb
2010-08-19 22:15:19 +03:00
parent 5fb3e7fd36
commit 93590436c1
7 changed files with 281 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Makefile.am
View File

@ -60,6 +60,8 @@ libmu_la_SOURCES= \
mu-log.h \
mu-maildir.c \
mu-maildir.h \
mu-msg-contact.c \
mu-msg-contact.h \
mu-msg-fields.c \
mu-msg-fields.h \
mu-msg-flags.c \

78
src/mu-msg-contact.c Normal file
View File

@ -0,0 +1,78 @@
/*
** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
**
** 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 3, 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, write to the Free Software Foundation,
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif /*HAVE_CONFIG_H*/
#include <glib.h>
#include "mu-msg-contact.h"
MuMsgContact*
mu_msg_contact_new (const char *name, const char* address,
MuMsgContactType ctype)
{
MuMsgContact *ct;
g_return_val_if_fail (ctype == MU_MSG_CONTACT_TYPE_TO ||
ctype == MU_MSG_CONTACT_TYPE_FROM ||
ctype == MU_MSG_CONTACT_TYPE_CC ||
ctype == MU_MSG_CONTACT_TYPE_BCC,
NULL);
ct = g_slice_new (MuMsgContact);
ct->name = name ? g_strdup(name) : NULL;
ct->address = address ? g_strdup(address) : NULL;
ct->type = ctype;
return ct;
}
void
mu_msg_contact_destroy (MuMsgContact *ct)
{
if (ct) {
g_free (ct->name);
g_free (ct->address);
}
g_slice_free (MuMsgContact, ct);
}
void
mu_msg_contact_list_foreach (GSList *lst,
MuMsgContactForeachFunc func,
gpointer user_data)
{
while (lst && func((MuMsgContact*)lst->data, user_data))
lst = g_slist_next(lst);
}
void
mu_msg_contact_list_free (GSList *lst)
{
g_slist_foreach (lst, (GFunc)mu_msg_contact_destroy, NULL);
g_slist_free (lst);
}

122
src/mu-msg-contact.h Normal file
View File

@ -0,0 +1,122 @@
/*
** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
**
** 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 3, 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, write to the Free Software Foundation,
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**
*/
#ifndef __MU_MSG_CONTACT_H__
#define __MU_MSG_CONTACT_H__
#include <glib.h>
enum _MuMsgContactType { /* Reply-To:? */
MU_MSG_CONTACT_TYPE_TO,
MU_MSG_CONTACT_TYPE_FROM,
MU_MSG_CONTACT_TYPE_CC,
MU_MSG_CONTACT_TYPE_BCC
};
typedef enum _MuMsgContactType MuMsgContactType;
struct _MuMsgContact {
char *name; /* Foo Bar */
char *address; /* foo@bar.cuux */
MuMsgContactType type; /*MU_MSG_CONTACT_TYPE_{TO,CC,BCC,FROM}*/
};
typedef struct _MuMsgContact MuMsgContact;
/**
* create a new MuMsgContact instance
*
* @param name name of the contact (or NULL)
* @param addr address of the contact (or NULL)
* @param ctype a valid contact type
*
* @return a new MuMsgContact instance; use mu_msg_contact_destroy
* when finished.
*/
MuMsgContact *mu_msg_contact_new (const char *name, const char *addr,
MuMsgContactType ctype);
/**
* destroy a MuMsgContact
*
* @param ct a MuMsgContact, or NULL
*/
void mu_msg_contact_destroy (MuMsgContact *ct);
/**
* macro to get the name of a contact
*
* @param ct a MuMsgContact
*
* @return the name
*/
#define mu_msg_contact_name(ct) ((ct)->name)
/**
* macro to get the address of a contact
*
* @param ct a MuMsgContact
*
* @return the address
*/
#define mu_msg_contact_address(ct) ((ct)->address)
/**
* macro to get the contact type
*
* @param ct a MuMsgContact
*
* @return the contact type
*/
#define mu_msg_contact_type(ct) ((ct)->type)
/**
* callback function
*
* @param contact
* @param user_data a user provided data pointer
*
* @return TRUE if we should continue the foreach, FALSE otherwise
*/
typedef gboolean (*MuMsgContactForeachFunc) (MuMsgContact* contact,
gpointer user_data);
/**
* call a function for each MuMsgContact in the list
*
* @param lst a list of MuMsgContact objects
* @param func a callback function
* @param user_data user pointer, passed to the callback
*/
void mu_msg_contact_list_foreach (GSList *lst,
MuMsgContactForeachFunc func,
gpointer user_data);
/**
* free a list of MuMsgContact objects
*
* @param lst list of MuMsgContact object
*/
void mu_msg_contact_list_free (GSList *lst);
#endif /*__MU_MSG_CONTACT_H__*/

64
src/mu-msg-gmime.c
View File

@ -843,13 +843,13 @@ fill_contact (MuMsgContact *contact, InternetAddress *addr,
if (!addr)
return FALSE;
contact->name = internet_address_get_name (addr);
contact->name = (char*)internet_address_get_name (addr);
contact->type = ctype;
/* we only support internet addresses;
* if we don't check, g_mime hits an assert
*/
contact->address = internet_address_mailbox_get_addr
contact->address = (char*)internet_address_mailbox_get_addr
(INTERNET_ADDRESS_MAILBOX(addr));
return TRUE;
@ -858,9 +858,9 @@ fill_contact (MuMsgContact *contact, InternetAddress *addr,
static int
address_list_foreach (InternetAddressList *addrlist,
MuMsgContactType ctype,
MuMsgGMimeContactsForeachFunc func,
gpointer user_data)
MuMsgContactType ctype,
MuMsgContactForeachFunc func,
gpointer user_data)
{
int i,rv;
@ -887,10 +887,10 @@ address_list_foreach (InternetAddressList *addrlist,
static int
mu_msg_gmime_get_contacts_from (MuMsgGMime *msg, MuMsgGMimeContactsForeachFunc func,
get_contacts_from (MuMsgGMime *msg, MuMsgContactForeachFunc func,
gpointer user_data)
{
InternetAddressList *list;
InternetAddressList *lst;
int rv;
/* we go through this whole excercise of trying to get a *list*
@ -898,20 +898,22 @@ mu_msg_gmime_get_contacts_from (MuMsgGMime *msg, MuMsgGMimeContactsForeachFunc f
* internet_address_parse_string has the nice side-effect of
* splitting in names and addresses for us */
list = internet_address_list_parse_string (
lst = internet_address_list_parse_string (
g_mime_message_get_sender (msg->_mime_msg));
rv = address_list_foreach (list, MU_MSG_CONTACT_TYPE_FROM, func, user_data);
if (list)
g_object_unref (G_OBJECT(list));
if (lst) {
rv = address_list_foreach (lst, MU_MSG_CONTACT_TYPE_FROM,
func, user_data);
g_object_unref (G_OBJECT(lst));
}
return rv;
}
void
mu_msg_gmime_contacts_foreach (MuMsgGMime *msg, MuMsgGMimeContactsForeachFunc func,
mu_msg_gmime_contacts_foreach (MuMsgGMime *msg, MuMsgContactForeachFunc func,
gpointer user_data)
{
int i, rv;
@ -926,8 +928,8 @@ mu_msg_gmime_contacts_foreach (MuMsgGMime *msg, MuMsgGMimeContactsForeachFunc fu
g_return_if_fail (func && msg);
/* first, get the from address */
rv = mu_msg_gmime_get_contacts_from (msg, func, user_data);
/* first, get the from address(es) */
rv = get_contacts_from (msg, func, user_data);
if (rv != 0)
return; /* callback told us to stop */
@ -942,6 +944,36 @@ mu_msg_gmime_contacts_foreach (MuMsgGMime *msg, MuMsgGMimeContactsForeachFunc fu
}
static gboolean
each_contact (MuMsgContact *contact, GSList **lst)
{
MuMsgContact *ct;
ct = mu_msg_contact_new (mu_msg_contact_name(contact),
mu_msg_contact_address (contact),
mu_msg_contact_type (contact));
*lst = g_slist_append (*lst, ct);
return TRUE;
}
GSList *
mu_msg_gmime_contacts_list (MuMsgGMime *msg)
{
GSList *contacts;
g_return_val_if_fail (msg, NULL);
contacts = NULL;
mu_msg_gmime_contacts_foreach (msg,
(MuMsgContactForeachFunc)each_contact,
&contacts);
return contacts;
}
static gboolean _initialized = FALSE;
void

17
src/mu-msg-gmime.h
View File

@ -21,6 +21,7 @@
#define __MU_MSG_GMIME_H__
#include "mu-msg.h"
#include "mu-msg-contact.h"
G_BEGIN_DECLS
@ -316,16 +317,18 @@ time_t mu_msg_gmime_get_timestamp (MuMsgGMime *msg);
/**
* callback function
* get a list of contacts (MuMsgContact) for this message; you can use
* GSList functions or mu_msg_contact_list_foreach to read the items.
*
* @param contact
* @param user_data a user provided data pointer
* @param msg a valid MuMsgGMime* instance
*
* @return TRUE if we should continue the foreach, FALSE otherwise
* @return a list of contacts for this message; use mu_msg_contact_list_free
* to free it when done
*/
typedef gboolean (*MuMsgGMimeContactsForeachFunc) (MuMsgContact* contact,
gpointer user_data);
GSList * mu_msg_gmime_contacts_list (MuMsgGMime *msg);
/**
* call a function for each of the contacts in a message
@ -337,7 +340,7 @@ typedef gboolean (*MuMsgGMimeContactsForeachFunc) (MuMsgContact* contact,
*
*/
void mu_msg_gmime_contacts_foreach (MuMsgGMime *msg,
MuMsgGMimeContactsForeachFunc func,
MuMsgContactForeachFunc func,
gpointer user_data);
G_END_DECLS

16
src/mu-msg.h
View File

@ -43,20 +43,4 @@ enum _MuMsgPriority {
};
typedef enum _MuMsgPriority MuMsgPriority;
enum _MuMsgContactType { /* Reply-To:? */
MU_MSG_CONTACT_TYPE_TO,
MU_MSG_CONTACT_TYPE_FROM,
MU_MSG_CONTACT_TYPE_CC,
MU_MSG_CONTACT_TYPE_BCC
};
typedef enum _MuMsgContactType MuMsgContactType;
struct _MuMsgContact {
const char *name; /* Foo Bar */
const char *address; /* foo@bar.cuux */
MuMsgContactType type; /*MU_MSG_CONTACT_TYPE_{TO,CC,BCC,FROM}*/
};
typedef struct _MuMsgContact MuMsgContact;
#endif /*__MU_MSG_H__*/

32
src/tests/test-mu-msg-gmime.c
View File

@ -91,17 +91,16 @@ test_mu_msg_gmime_01 (void)
==, 1217530645);
{
GSList *lst, *cur;
lst = NULL;
mu_msg_gmime_contacts_foreach (msg,
(MuMsgGMimeContactsForeachFunc)each_contact,
&lst);
lst = mu_msg_gmime_contacts_list (msg);
g_assert_cmpuint (g_slist_length(lst),==, 1);
cur = lst;
g_assert_cmpstr ((const char*)cur->data, ==,
"<none> <anon@example.com>");
g_slist_foreach (lst, (GFunc)g_free, NULL);
g_slist_free (lst);
g_assert_cmpstr (mu_msg_contact_name ((MuMsgContact*)cur->data),
==, NULL);
g_assert_cmpstr (mu_msg_contact_address ((MuMsgContact*)cur->data),
==, "anon@example.com");
mu_msg_contact_list_free (lst);
}
mu_msg_gmime_destroy (msg);
@ -138,21 +137,22 @@ test_mu_msg_gmime_02 (void)
==, MU_MSG_PRIORITY_LOW);
g_assert_cmpuint (mu_msg_gmime_get_date(msg),
==, 1218051515);
{
GSList *lst, *cur;
lst = NULL;
mu_msg_gmime_contacts_foreach (msg,
(MuMsgGMimeContactsForeachFunc)each_contact,
&lst);
lst = mu_msg_gmime_contacts_list (msg);
g_assert_cmpuint (g_slist_length(lst),==, 1);
cur = lst;
g_assert_cmpstr ((const char*)cur->data, ==,
"<none> <anon@example.com>");
g_slist_foreach (lst, (GFunc)g_free, NULL);
g_slist_free (lst);
g_assert_cmpstr (mu_msg_contact_name ((MuMsgContact*)cur->data),
==, NULL);
g_assert_cmpstr (mu_msg_contact_address ((MuMsgContact*)cur->data),
==, "anon@example.com");
mu_msg_contact_list_free (lst);
}
mu_msg_gmime_destroy (msg);
g_free (mfile);