/*
* $Id$
+ */
+/**
+ * \defgroup VCardMain vCard data type implementation for the Citadel system.
*
- * vCard implementation for Citadel/UX
- *
- * 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 <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <signal.h>
-
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
-#else
-# if HAVE_SYS_TIME_H
-# include <sys/time.h>
-# else
-# include <time.h>
-# endif
-#endif
-
-#include <ctype.h>
-#include <string.h>
-#include <errno.h>
-#include <limits.h>
-#include <syslog.h>
-
+/*@{*/
#include "webcit.h"
+#include "webserver.h"
#include "vcard.h"
-/*
- * Constructor (empty vCard)
+/**
+ * \brief Constructor (empty vCard)
+ * \return an empty vcard
*/
struct vCard *vcard_new() {
struct vCard *v;
}
-/*
- * Constructor (supply serialized vCard)
+/**
+ * \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;
int i;
int colonpos, nlpos;
+ 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.
*/
colonpos = pattern2(ptr, ":");
nlpos = pattern2(ptr, "\n");
- if (nlpos > colonpos > 0) {
+ if ((nlpos > colonpos) && (colonpos > 0)) {
namebuf = malloc(colonpos + 1);
valuebuf = malloc(nlpos - colonpos + 1);
strncpy(namebuf, ptr, colonpos);
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")) ) {
++v->numprops;
v->prop = realloc(v->prop,
- (v->numprops * sizeof(char *) * 2) );
+ (v->numprops * sizeof(struct vCardProp))
+ );
v->prop[v->numprops-1].name = namebuf;
v->prop[v->numprops-1].value = valuebuf;
}
}
-/*
- * 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;
&& (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);
+ }
}
}
}
-/*
- * Destructor
+/**
+ * \brief Destructor
+ * kill a vCard
+ * \param v the vCard to purge from memory
*/
void vcard_free(struct vCard *v) {
int i;
-/*
- * 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)) {
free(v->prop[i].name);
}
}
- /* Otherwise, append it */
+ /** Otherwise, append it */
++v->numprops;
v->prop = realloc(v->prop,
- (v->numprops * sizeof(char *) * 2) );
+ (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 a standard text/x-vcard MIME type.
+ * \param v vCard to serialize
+ * \return the serialized vCard
*/
char *vcard_serialize(struct vCard *v)
{
int i;
size_t len;
- 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) +
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, ":");
return ser;
}
+
+
+
+/*@}*/