* Holy war on strlen: use IsEmptyStr where apropriate.
[citadel.git] / citadel / vcard.c
index ce93ada3a51d43de352c1bb0439eb150e380c4d4..a44117747a3b73da5bb637a5fbfa6592f5e9698e 100644 (file)
@@ -1,15 +1,14 @@
 /*
  * $Id$
  *
- * vCard implementation for Citadel/UX
+ * vCard implementation for Citadel
  *
- * Copyright (C) 1999 by Art Cancro
+ * Copyright (C) 1999-2005 by Art Cancro
  * This code is freely redistributable under the terms of the GNU General
  * Public License.  All other rights reserved.
  */
 
 
-#include "sysdep.h"
 #include <stdlib.h>
 #include <unistd.h>
 #include <stdio.h>
 #include <string.h>
 #include <errno.h>
 #include <limits.h>
-#include <syslog.h>
+#include <string.h>
+
 #include "citadel.h"
 #include "server.h"
-#include "control.h"
-#include "sysdep_decls.h"
 #include "support.h"
-#include "config.h"
-#include "tools.h"
 #include "vcard.h"
+#include "tools.h"
+
 
-/* 
- * Constructor (empty vCard)
+
+
+
+/** 
+ * \brief Constructor (empty vCard)
+ * \return an empty vcard
  */
 struct vCard *vcard_new() {
        struct vCard *v;
 
-       v = (struct vCard *) mallok(sizeof(struct vCard));
+       v = (struct vCard *) malloc(sizeof(struct vCard));
        if (v == NULL) return v;
 
        v->magic = CTDL_VCARD_MAGIC;
@@ -57,9 +59,53 @@ struct vCard *vcard_new() {
        return v;
 }
 
+/**
+ * \brief      Remove the "charset=" attribute from a vCard property name
+ *
+ * \param      strbuf          The property name string to be stripped
+ */
+void remove_charset_attribute(char *strbuf)
+{
+       int i, t;
+       char compare[256];
+
+       t = num_tokens(strbuf, ';');
+       for (i=0; i<t; ++i) {
+               extract_token(compare, strbuf, i, ';', sizeof compare);
+               striplt(compare);
+               if (!strncasecmp(compare, "charset=", 8)) {
+                       remove_token(strbuf, i, ';');
+               }
+       }
+       if (!IsEmptyStr(strbuf)) {
+               if (strbuf[strlen(strbuf)-1] == ';') {
+                       strbuf[strlen(strbuf)-1] = 0;
+               }
+       }
+}
+
 
 /*
- * Constructor (supply serialized vCard)
+ * \brief      Add a property to a vCard
+ *
+ * \param      v               vCard structure to which we are adding
+ * \param      propname        name of new property
+ * \param      propvalue       value of new property
+ */
+void vcard_add_prop(struct vCard *v, char *propname, char *propvalue) {
+       ++v->numprops;
+       v->prop = realloc(v->prop,
+               (v->numprops * sizeof(struct vCardProp)) );
+       v->prop[v->numprops-1].name = strdup(propname);
+       v->prop[v->numprops-1].value = strdup(propvalue);
+}
+
+
+
+/**
+ * \brief Constructor (supply serialized vCard)
+ * \param vtext the text to parse into the new vcard
+ * \return the parsed VCard
  */
 struct vCard *vcard_load(char *vtext) {
        struct vCard *v;
@@ -69,14 +115,16 @@ struct vCard *vcard_load(char *vtext) {
        int i;
        int colonpos, nlpos;
 
-       mycopy = strdoop(vtext);
+       if (vtext == NULL) return vcard_new();
+       mycopy = strdup(vtext);
        if (mycopy == NULL) return NULL;
 
-       /* First, fix this big pile o' vCard to make it more parseable.
+       /**
+        * First, fix this big pile o' vCard to make it more parseable.
         * To make it easier to parse, we convert CRLF to LF, and unfold any
         * multi-line fields into single lines.
         */
-       for (i=0; i<strlen(mycopy); ++i) {
+       for (i=0; !IsEmptyStr(&mycopy[i]); ++i) {
                if (!strncmp(&mycopy[i], "\r\n", 2)) {
                        strcpy(&mycopy[i], &mycopy[i+1]);
                }
@@ -89,70 +137,89 @@ struct vCard *vcard_load(char *vtext) {
        if (v == NULL) return v;
 
        ptr = mycopy;
-       while (strlen(ptr)>0) {
+       while (!IsEmptyStr(ptr)) {
                colonpos = (-1);
                nlpos = (-1);
                colonpos = pattern2(ptr, ":");
                nlpos = pattern2(ptr, "\n");
 
-               if (nlpos > colonpos > 0) {
-                       namebuf = mallok(colonpos + 1);
-                       valuebuf = mallok(nlpos - colonpos + 1);
+               if ((nlpos > colonpos) && (colonpos > 0)) {
+                       namebuf = malloc(colonpos + 1);
+                       valuebuf = malloc(nlpos - colonpos + 1);
                        strncpy(namebuf, ptr, colonpos);
                        namebuf[colonpos] = 0;
                        strncpy(valuebuf, &ptr[colonpos+1], nlpos-colonpos-1);
                        valuebuf[nlpos-colonpos-1] = 0;
 
-                       if ( (!strcasecmp(namebuf, "end"))
-                          && (!strcasecmp(valuebuf, "vcard")) )  valid = 0;
-                       if ( (!strcasecmp(namebuf, "begin"))
-                          && (!strcasecmp(valuebuf, "vcard")) )  valid = 1;
+                       if (!strcasecmp(namebuf, "end")) {
+                               valid = 0;
+                       }
+                       if (    (!strcasecmp(namebuf, "begin"))
+                               && (!strcasecmp(valuebuf, "vcard"))
+                       ) {
+                               valid = 1;
+                       }
 
                        if ( (valid) && (strcasecmp(namebuf, "begin")) ) {
+                               remove_charset_attribute(namebuf);
                                ++v->numprops;
-                               v->prop = reallok(v->prop,
-                                       (v->numprops * sizeof(char *) * 2) );
+                               v->prop = realloc(v->prop,
+                                       (v->numprops * sizeof(struct vCardProp))
+                               );
                                v->prop[v->numprops-1].name = namebuf;
                                v->prop[v->numprops-1].value = valuebuf;
                        } 
                        else {
-                               phree(namebuf);
-                               phree(valuebuf);
+                               free(namebuf);
+                               free(valuebuf);
                        }
 
                }
 
-               while ( (*ptr != '\n') && (strlen(ptr)>0) ) {
+               while ( (*ptr != '\n') && (!IsEmptyStr(ptr)) ) {
                        ++ptr;
                }
                if (*ptr == '\n') ++ptr;
        }
 
-       phree(mycopy);
+       free(mycopy);
        return v;
 }
 
 
-/*
- * Fetch the value of a particular key
+/**
+ * \brief Fetch the value of a particular key.
  * If is_partial is set to 1, a partial match is ok (for example,
- * a key of "tel;home" will satisfy a search for "tel")
+ * a key of "tel;home" will satisfy a search for "tel").
  * Set "instance" to a value higher than 0 to return subsequent instances
- * of the same key
+ * of the same key.
+ * Set "get_propname" to nonzero to fetch the property name instead of value.
+ * \param v vCard to get keyvalue from
+ * \param propname key to retrieve
+ * \param is_partial dunno???
+ * \param instance if >0 return a later token of the value
+ * \param get_propname if nonzero get the real property name???
+ * \return the requested value / token / propertyname
  */
 char *vcard_get_prop(struct vCard *v, char *propname,
-                       int is_partial, int instance) {
+                       int is_partial, int instance, int get_propname) {
        int i;
        int found_instance = 0;
 
        if (v->numprops) for (i=0; i<(v->numprops); ++i) {
                if ( (!strcasecmp(v->prop[i].name, propname))
+                  || (propname[0] == 0)
                   || (  (!strncasecmp(v->prop[i].name,
                                        propname, strlen(propname)))
                         && (v->prop[i].name[strlen(propname)] == ';')
                         && (is_partial) ) ) {
                        if (instance == found_instance++) {
-                               return(v->prop[i].value);
+                               if (get_propname) {
+                                       return(v->prop[i].name);
+                               }
+                               else {
+                                       return(v->prop[i].value);
+                               }
                        }
                }
        }
@@ -163,8 +230,10 @@ char *vcard_get_prop(struct vCard *v, char *propname,
 
 
 
-/*
- * Destructor
+/**
+ * \brief Destructor
+ * kill a vCard
+ * \param v the vCard to purge from memory
  */
 void vcard_free(struct vCard *v) {
        int i;
@@ -172,113 +241,162 @@ void vcard_free(struct vCard *v) {
        if (v->magic != CTDL_VCARD_MAGIC) return;       /* Self-check */
        
        if (v->numprops) for (i=0; i<(v->numprops); ++i) {
-               phree(v->prop[i].name);
-               phree(v->prop[i].value);
+               free(v->prop[i].name);
+               free(v->prop[i].value);
        }
 
-       if (v->prop != NULL) phree(v->prop);
+       if (v->prop != NULL) free(v->prop);
        
        memset(v, 0, sizeof(struct vCard));
-       phree(v);
-}
-
-
-/*
- * Experimental output type of thing
- */
-char *vcard_to_html(struct vCard *v) {
-       char *html = NULL;
-       int i;
-       size_t len = 256;
-
-       if (v == NULL) return NULL;
-
-       if (v->numprops) for (i=0; i<(v->numprops); ++i) {
-               len += strlen(v->prop[i].name);
-               len += strlen(v->prop[i].value);
-       }
-
-       html = mallok(len);
-       if (html == NULL) return NULL;
-
-       sprintf(html, "<TABLE bgcolor=#888888>");
-       if (v->numprops) for (i=0; i<(v->numprops); ++i) {
-               sprintf(&html[strlen(html)],
-                       "<TR><TD>%s</TD><TD>%s</TD></TR>\n",
-                       v->prop[i].name,
-                       v->prop[i].value
-               );
-       }
-
-       strcat(html, "</TABLE>");
-
-       return(html);
+       free(v);
 }
 
 
 
 
-/*
- * Set a name/value pair in the card
+/**
+ * \brief Set a name/value pair in the card
+ * \param v vCard to inspect
+ * \param name key to set
+ * \param value the value to assign to key
+ * \param append should we append the value to an existing one?
  */
 void vcard_set_prop(struct vCard *v, char *name, char *value, int append) {
        int i;
 
-       if (v->magic != CTDL_VCARD_MAGIC) return;       /* Self-check */
+       if (v->magic != CTDL_VCARD_MAGIC) return;       /** Self-check */
 
-       /* If this key is already present, replace it */
+       /** If this key is already present, replace it */
        if (!append) if (v->numprops) for (i=0; i<(v->numprops); ++i) {
                if (!strcasecmp(v->prop[i].name, name)) {
-                       phree(v->prop[i].name);
-                       phree(v->prop[i].value);
-                       v->prop[i].name = strdoop(name);
-                       v->prop[i].value = strdoop(value);
+                       free(v->prop[i].name);
+                       free(v->prop[i].value);
+                       v->prop[i].name = strdup(name);
+                       v->prop[i].value = strdup(value);
                        return;
                }
        }
 
-       /* Otherwise, append it */
+       /** Otherwise, append it */
        ++v->numprops;
-       v->prop = reallok(v->prop,
-               (v->numprops * sizeof(char *) * 2) );
-       v->prop[v->numprops-1].name = strdoop(name);
-       v->prop[v->numprops-1].value = strdoop(value);
+       v->prop = realloc(v->prop,
+               (v->numprops * sizeof(struct vCardProp)) );
+       v->prop[v->numprops-1].name = strdup(name);
+       v->prop[v->numprops-1].value = strdup(value);
 }
 
 
 
 
-/*
- * Serialize a struct vcard into a standard text/x-vcard MIME type.
- *
+/**
+ * \brief Serialize a 'struct vcard' into an actual vcard.
+ * \param v vCard to serialize
+ * \return the serialized vCard
  */
 char *vcard_serialize(struct vCard *v)
 {
        char *ser;
-       int i;
+       int i, j;
        size_t len;
+       int is_utf8 = 0;
 
-       if (v->magic != CTDL_VCARD_MAGIC) return NULL;  /* self check */
+       if (v->magic != CTDL_VCARD_MAGIC) return NULL;  /** self check */
 
-       /* Figure out how big a buffer we need to allocate */
-       len = 64;       /* for begin, end, and a little padding for safety */
+       /** Figure out how big a buffer we need to allocate */
+       len = 64;       /** for begin, end, and a little padding for safety */
        if (v->numprops) for (i=0; i<(v->numprops); ++i) {
                len = len +
                        strlen(v->prop[i].name) +
-                       strlen(v->prop[i].value) + 4;
+                       strlen(v->prop[i].value) + 16;
        }
 
-       ser = mallok(len);
+       ser = malloc(len);
        if (ser == NULL) return NULL;
 
-       strcpy(ser, "begin:vcard\r\n");
+       safestrncpy(ser, "begin:vcard\r\n", len);
        if (v->numprops) for (i=0; i<(v->numprops); ++i) {
-               strcat(ser, v->prop[i].name);
-               strcat(ser, ":");
-               strcat(ser, v->prop[i].value);
-               strcat(ser, "\r\n");
+               if ( (strcasecmp(v->prop[i].name, "end")) && (v->prop[i].value != NULL) ) {
+                       is_utf8 = 0;
+                       for (j=0; !IsEmptyStr(&v->prop[i].value[j]); ++j) {
+                               if ( (v->prop[i].value[j] < 32) || (v->prop[i].value[j] > 126) ) {
+                                       is_utf8 = 1;
+                               }
+                       }
+                       strcat(ser, v->prop[i].name);
+                       if (is_utf8) {
+                               strcat(ser, ";charset=UTF-8");
+                       }
+                       strcat(ser, ":");
+                       strcat(ser, v->prop[i].value);
+                       strcat(ser, "\r\n");
+               }
        }
        strcat(ser, "end:vcard\r\n");
 
        return ser;
 }
+
+
+
+/*
+ * \brief      Convert FN (Friendly Name) into N (Name)
+ *
+ * \param      vname           Supplied friendly-name
+ * \param      n               Target buffer to store Name
+ * \param      vname_size      Size of buffer
+ */
+void vcard_fn_to_n(char *vname, char *n, size_t vname_size) {
+       char lastname[256];
+       char firstname[256];
+       char middlename[256];
+       char honorific_prefixes[256];
+       char honorific_suffixes[256];
+       char buf[256];
+
+       safestrncpy(buf, n, sizeof buf);
+
+       /* Try to intelligently convert the screen name to a
+        * fully expanded vCard name based on the number of
+        * words in the name
+        */
+       safestrncpy(lastname, "", sizeof lastname);
+       safestrncpy(firstname, "", sizeof firstname);
+       safestrncpy(middlename, "", sizeof middlename);
+       safestrncpy(honorific_prefixes, "", sizeof honorific_prefixes);
+       safestrncpy(honorific_suffixes, "", sizeof honorific_suffixes);
+
+       /* Honorific suffixes */
+       if (num_tokens(buf, ',') > 1) {
+               extract_token(honorific_suffixes, buf, (num_tokens(buf, ' ') - 1), ',',
+                       sizeof honorific_suffixes);
+               remove_token(buf, (num_tokens(buf, ',') - 1), ',');
+       }
+
+       /* Find a last name */
+       extract_token(lastname, buf, (num_tokens(buf, ' ') - 1), ' ', sizeof lastname);
+       remove_token(buf, (num_tokens(buf, ' ') - 1), ' ');
+
+       /* Find honorific prefixes */
+       if (num_tokens(buf, ' ') > 2) {
+               extract_token(honorific_prefixes, buf, 0, ' ', sizeof honorific_prefixes);
+               remove_token(buf, 0, ' ');
+       }
+
+       /* Find a middle name */
+       if (num_tokens(buf, ' ') > 1) {
+               extract_token(middlename, buf, (num_tokens(buf, ' ') - 1), ' ', sizeof middlename);
+               remove_token(buf, (num_tokens(buf, ' ') - 1), ' ');
+       }
+
+       /* Anything left is probably the first name */
+       safestrncpy(firstname, buf, sizeof firstname);
+       striplt(firstname);
+
+       /* Compose the structured name */
+       snprintf(vname, vname_size, "%s;%s;%s;%s;%s", lastname, firstname, middlename,
+               honorific_prefixes, honorific_suffixes);
+}
+
+
+
+