- libbalsa/rfc6350.c, libbalsa/rfc6350.h: new files; simple RFC 6350 to LibBalsaAddress parser
diff --git a/libbalsa/rfc6350.c b/libbalsa/rfc6350.c new file mode 100644 index 0000000..0c902c0 --- /dev/null +++ b/libbalsa/rfc6350.c @@ -0,0 +1,353 @@ +/* Balsa E-Mail Client + * + * Copyright (C) 1997-2016 Stuart Parmenter and others, see the file AUTHORS for a list. + * + * This module provides a simple RFC 6350 (aka VCard 4.0, see https://tools.ietf.org/html/rfc6350) parser which extracts a single + * VCard from a GDataInputStream and returns it as LibBalsaAddress. + * + * Written by Copyright (C) 2016 Albrecht Dreß <[email protected]>. + * + * 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, 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/>. + */ + +#if defined(HAVE_CONFIG_H) && HAVE_CONFIG_H +# include "config.h" +#endif /* HAVE_CONFIG_H */ + +#if defined(HAVE_OSMO) + +#include <glib/gi18n.h> +#include "rfc6350.h" + + +/* define GError stuff for the RFC 6350/VCard parser */ +#define RFC6350_ERROR_QUARK (g_quark_from_static_string("rfc6350-parser")) +#define RFC6350_ERROR_NO_COLON 1 +#define RFC6350_ERROR_EMPTY 2 +#define RFC6350_ERROR_BEGIN 3 +#define RFC6350_ERROR_END 4 + + +static gboolean rfc6350_eval_line(gchar *line, + LibBalsaAddress *address, + GError **error); +static gchar **rfc6350_strsplit(const gchar *item, + guint count); +static gchar *rfc6350_get_name(gchar *name); +static void rfc6350_unescape(gchar *item); +static gchar *rfc6350_fn_from_n(gchar **n_items); + + +LibBalsaAddress * +rfc6350_parse_from_stream(GDataInputStream *stream, + gboolean *eos, + GError **error) +{ + gchar *line; + LibBalsaAddress *result = NULL; + + line = g_data_input_stream_read_line_utf8(stream, NULL, NULL, error); + if (line == NULL) { + if (*error == NULL) { + *eos = TRUE; + } + } else if (g_ascii_strcasecmp(line, "BEGIN:VCARD") != 0) { + g_set_error(error, RFC6350_ERROR_QUARK, RFC6350_ERROR_BEGIN, _("malformed card, BEGIN:VCARD expected")); + g_free(line); + } else { + gboolean parse_done = FALSE; + + result = libbalsa_address_new(); + while (result && (line != NULL) && !parse_done) { + if (g_ascii_strcasecmp(line, "END:VCARD") == 0) { + parse_done = TRUE; + g_free(line); + } else { + gchar *nextline; + + /* perform unfolding (RFC 6350, sect. 3.2. "Line Delimiting and Folding") */ + nextline = g_data_input_stream_read_line_utf8(stream, NULL, NULL, error); + while ((nextline) != NULL && ((nextline[0] == ' ') || (nextline[0] == '\t'))) { + gchar *unfold; + + unfold = g_strconcat(line, &nextline[1], NULL); + g_free(line); + g_free(nextline); + line = unfold; + nextline = g_data_input_stream_read_line_utf8(stream, NULL, NULL, error); + } + + /* evaluate unfolded line, drop address on error */ + if (!rfc6350_eval_line(line, result, error)) { + g_object_unref(result); + result = NULL; + } + + /* process next line */ + g_free(line); + line = nextline; + } + } + + if (!parse_done) { + g_set_error(error, RFC6350_ERROR_QUARK, RFC6350_ERROR_END, _("malformed card, END:VCARD missing")); + g_object_unref(result); + result = NULL; + } + } + + /* ignore items without an Email address, fill empty full name if necessary */ + if (result != NULL) { + if (result->address_list == NULL) { + g_object_unref(result); + result = NULL; + } else if (result->full_name == NULL) { + result->full_name = g_strdup(_("No-Name")); + } + } + + return result; +} + + +/** \brief Extract a VCard name item + * + * \param name input name field, modified in place + * \return the name field, with group and parameters stripped + * + * Remove the \em group and \em param parts of the VCard \em name field (see RFC 6350, sect. 3.3. "ABNF Format Definition"). + * + * \note Do \em not free the returned value. + */ +static gchar * +rfc6350_get_name(gchar *name) +{ + gchar *result; + gchar *semicolon; + + /* skip group */ + result = strchr(name, '.'); + if (result == NULL) { + result = name; + } else { + result = &result[1]; + } + + /* drop any name parameters */ + semicolon = strchr(result, ';'); + if (semicolon != NULL) { + semicolon[0] = '\0'; + } + + return result; +} + + +/** \brief RFC 6350 unescape a string + * + * \param item VCard item, modified in place + * + * Unescape a string according to RFC 6350, sect. 3.4. "Property Value Escaping". Note that all other escaped characters than those + * defined in RFC 6350 are simply ignored, although they \em should be regarded as errors. + * + * \note Do \em not free the returned value. + */ +static void +rfc6350_unescape(gchar *item) +{ + gchar *p; + gchar *bslash; + + g_assert(item != NULL); + + p = item; + do { + bslash = strchr(p, '\\'); + if (bslash != NULL) { + if (strchr(",;\\nN", bslash[1]) != NULL) { + if (g_ascii_tolower(bslash[1]) == 'n') { + bslash[1] = '\n'; + } + memmove(bslash, &bslash[1], strlen(bslash)); + } + p = &bslash[1]; + } else { + p = NULL; + } + } while (p != NULL); +} + + +/** \brief Split a ';' delimited list into items + * + * \param item value string consisting of ';' delimited items + * \param count maximum number of fields to split into + * \return a newly allocated NULL-terminated array of unescaped fields + * + * Split the passed value string into fields, and unescape the resulting values. If the \em item contains more than \em count + * fields, the extra delimiters are ignored. + * + * \note Free the returned value by calling g_strfreev() on it. + */ +static gchar ** +rfc6350_strsplit(const gchar *item, + guint count) +{ + gchar **result; + const gchar *start; + guint index; + + result = g_new0(gchar *, count + 1U); + start = item; + index = 0U; + + while ((start != NULL) && (index < count)) { + if (start[0] == ';') { + result[index] = g_strdup(""); + start = &start[1]; + } else { + const gchar *delim; + + delim = strchr(start, ';'); + while ((delim != NULL) && (delim[-1] == '\\')) { + delim = strchr(&delim[1], ';'); + } + if (delim != NULL) { + result[index] = g_strndup(start, delim - start); + start = &delim[1]; + } else { + result[index] = g_strdup(start); + start = NULL; + } + rfc6350_unescape(result[index]); + } + index++; + } + + return result; +} + + +/** \brief Evaluate a VCard line + * + * \param line VCard line + * \param address target address object + * \param error filled with error information on error + * \return TRUE on success, or FALSE is the VCard line is malformed + * + * Evaluate the VCard line, extract a N, FN, NICKNAME, ORG or EMAIL item and assign it to the appropriate fields in the target + * address item. + */ +static gboolean +rfc6350_eval_line(gchar *line, + LibBalsaAddress *address, + GError **error) +{ + gchar *value; + gboolean result; + + /* split into name and value */ + value = strchr(line, ':'); + if (value == NULL) { + g_set_error(error, RFC6350_ERROR_QUARK, RFC6350_ERROR_NO_COLON, _("malformed line '%s', missing ':'"), line); + result = FALSE; + } else { + gchar *namepart; + gchar *name; + + /* get the name and make sure that neither name nor value are empty */ + namepart = g_strndup(line, value - line); + name = rfc6350_get_name(namepart); + value = &value[1]; + if ((name[0] == '\0') || (value[0] == '\0')) { + g_set_error(error, RFC6350_ERROR_QUARK, RFC6350_ERROR_EMPTY, _("malformed line '%s', empty name or value"), line); + result = FALSE; + } else { + g_debug("%s: line='%s' name='%s', value='%s'", __func__, line, name, value); + if (g_ascii_strcasecmp(name, "FN") == 0) { + rfc6350_unescape(value); + g_free(address->full_name); + address->full_name = g_strdup(value); + } else if (g_ascii_strcasecmp(name, "N") == 0) { + gchar **n_items; + + n_items = rfc6350_strsplit(value, 5U); + g_free(address->first_name); + g_free(address->last_name); + if (n_items[1] != NULL) { + address->first_name = g_strdup(n_items[1]); + } else { + address->first_name = NULL; + } + if (n_items[0] != NULL) { + address->last_name = g_strdup(n_items[0]); + } else { + address->last_name = NULL; + } + if (address->full_name == NULL) { + address->full_name = rfc6350_fn_from_n(n_items); + } + g_strfreev(n_items); + } else if (g_ascii_strcasecmp(name, "NICKNAME") == 0) { + rfc6350_unescape(value); + g_free(address->nick_name); + address->nick_name = g_strdup(value); + } else if (g_ascii_strcasecmp(name, "ORG") == 0) { + gchar **n_items; + + n_items = rfc6350_strsplit(value, 2U); + g_free(address->organization); + address->organization = g_strdup(n_items[0]); + g_strfreev(n_items); + } else if (g_ascii_strcasecmp(name, "EMAIL") == 0) { + rfc6350_unescape(value); + address->address_list = g_list_prepend(address->address_list, g_strdup(value)); + } else { + /* ignore any other items */ + } + } + g_free(namepart); + result = TRUE; + } + + return result; +} + + +/** \brief Create a full name from VCard "N" items + * + * \param n_items extracted VCard N items + * \return the full name + * + * Construct a full name by concatenating -in this order- the VCard "N" elements Honorific Prefixes, Given Names, Additional Names, + * Family Names and Honorific Suffixes, separated by a single space each. + */ +static gchar * +rfc6350_fn_from_n(gchar **n_items) +{ + GString *fn; + static const guint add_idx[5] = { 3U, 1U, 2U, 0U, 4U }; + guint n; + + fn = g_string_new(NULL); + + for (n = 0; n < 5U; n++) { + if ((n_items[add_idx[n]] != NULL) && (n_items[add_idx[n]][0] != '\0')) { + if (fn->len > 0U) { + fn = g_string_append_c(fn, ' '); + } + fn = g_string_append(fn, n_items[add_idx[n]]); + } + } + + return g_string_free(fn, FALSE); +} + +#endif /* HAVE_OSMO */ diff --git a/libbalsa/rfc6350.h b/libbalsa/rfc6350.h new file mode 100644 index 0000000..4904ef1 --- /dev/null +++ b/libbalsa/rfc6350.h @@ -0,0 +1,45 @@ +/* Balsa E-Mail Client + * + * Copyright (C) 1997-2016 Stuart Parmenter and others, see the file AUTHORS for a list. + * + * This module provides a simple RFC 6350 (aka VCard 4.0, see https://tools.ietf.org/html/rfc6350) parser which extracts a single + * VCard from a GDataInputStream and returns it as LibBalsaAddress. + * + * Written by Copyright (C) 2016 Albrecht Dreß <[email protected]>. + * + * 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, 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/>. + */ + +#ifndef LIBBALSA_RFC6350_H_ +#define LIBBALSA_RFC6350_H_ + + +#include "address.h" + + +/** \brief Extract a single VCard 4.0 + * + * \param stream VCard input stream + * \param eos filled with TRUE is the end of the input stream has been reached + * \param error filled with error information on error + * \return a new address object on success + * + * Read a VCard from the input stream and extract all relevant fields into a LibBalsaAddress. A LibBalsaAddress is returned only if + * it contains any email address. The caller shall distinguish this case from an error by checking if the error argument is filled. + * The input stream is positioned immediately after the card read. + * + * \note The caller shall unref the returned address object. + */ +LibBalsaAddress *rfc6350_parse_from_stream(GDataInputStream *stream, + gboolean *eos, + GError **error); + + +#endif /* LIBBALSA_RFC6350_H_ */
pgpryKJXCPzfo.pgp
Description: PGP signature
_______________________________________________ balsa-list mailing list [email protected] https://mail.gnome.org/mailman/listinfo/balsa-list
