path: root/addressbook/backend/pas/pas-backend-card-sexp.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * pas-backend-card-sexp.c
 * Copyright 1999, 2000, 2001, Ximian, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#include "pas-backend-card-sexp.h"

#include <string.h>
#include <e-util/e-sexp.h>
#include <gal/widgets/e-unicode.h>

static GObjectClass *parent_class;

typedef struct _SearchContext SearchContext;

struct _PASBackendCardSExpPrivate {
    ESExp *search_sexp;
    SearchContext *search_context;
};

struct _SearchContext {
    EContact *contact;
};

static gboolean
compare_email (EContact *contact, const char *str,
           char *(*compare)(const char*, const char*))
{
    int i;

    for (i = E_CONTACT_EMAIL_1; i <= E_CONTACT_EMAIL_3; i ++) {
        const char *email = e_contact_get_const (contact, i);

        if (email && compare(email, str))
            return TRUE;
    }

    return FALSE;
}

static gboolean
compare_phone (EContact *contact, const char *str,
           char *(*compare)(const char*, const char*))
{
    int i;
    gboolean rv = FALSE;

    for (i = E_CONTACT_FIRST_PHONE_ID; i <= E_CONTACT_LAST_PHONE_ID; i ++) {
        char *phone = e_contact_get (contact, i);

        rv = phone && compare(phone, str);
        g_free (phone);

        if (rv)
            break;
    }

    return rv;
}

static gboolean
compare_name (EContact *contact, const char *str,
          char *(*compare)(const char*, const char*))
{
    const char *name;

    name = e_contact_get_const (contact, E_CONTACT_FULL_NAME);
    if (name && compare (name, str))
        return TRUE;

    name = e_contact_get_const (contact, E_CONTACT_FAMILY_NAME);
    if (name && compare (name, str))
        return TRUE;

    return FALSE;
}

static gboolean
compare_address (EContact *contact, const char *str,
         char *(*compare)(const char*, const char*))
{
    g_warning("address searching not implemented\n");
    return FALSE;
}

static gboolean
compare_category (EContact *contact, const char *str,
          char *(*compare)(const char*, const char*))
{
    GList *categories;
    GList *iterator;
    gboolean ret_val = FALSE;

    categories = e_contact_get (contact, E_CONTACT_CATEGORY_LIST);

    for (iterator = categories; iterator; iterator = iterator->next) {
        const char *category = iterator->data;

        if (compare(category, str)) {
            ret_val = TRUE;
            break;
        }
    }

    g_list_foreach (categories, (GFunc)g_free, NULL);
    g_list_free (categories);

    return ret_val;
}

static struct prop_info {
    EContactField field_id;
    const char *query_prop;
#define PROP_TYPE_NORMAL   0x01
#define PROP_TYPE_LIST     0x02
    int prop_type;
    gboolean (*list_compare)(EContact *contact, const char *str,
                 char *(*compare)(const char*, const char*));

} prop_info_table[] = {
#define NORMAL_PROP(f,q) {f, q, PROP_TYPE_NORMAL, NULL}
#define LIST_PROP(q,c) {0, q, PROP_TYPE_LIST, c}

    /* query prop,   type,              list compare function */
    NORMAL_PROP ( E_CONTACT_FILE_AS, "file_as" ),
    LIST_PROP ( "full_name", compare_name), /* not really a list, but we need to compare both full and surname */
    NORMAL_PROP ( E_CONTACT_HOMEPAGE_URL, "url"),
    NORMAL_PROP ( E_CONTACT_MAILER, "mailer"),
    NORMAL_PROP ( E_CONTACT_ORG, "org"),
    NORMAL_PROP ( E_CONTACT_ORG_UNIT, "org_unit"),
    NORMAL_PROP ( E_CONTACT_OFFICE, "office"),
    NORMAL_PROP ( E_CONTACT_TITLE, "title"),
    NORMAL_PROP ( E_CONTACT_ROLE, "role"),
    NORMAL_PROP ( E_CONTACT_MANAGER, "manager"),
    NORMAL_PROP ( E_CONTACT_ASSISTANT, "assistant"),
    NORMAL_PROP ( E_CONTACT_NICKNAME, "nickname"),
    NORMAL_PROP ( E_CONTACT_SPOUSE, "spouse" ),
    NORMAL_PROP ( E_CONTACT_NOTE, "note"),
    NORMAL_PROP ( E_CONTACT_UID, "id"),
    LIST_PROP ( "email", compare_email ),
    LIST_PROP ( "phone", compare_phone ),
    LIST_PROP ( "address", compare_address ),
    LIST_PROP ( "category", compare_category ),
};
static int num_prop_infos = sizeof(prop_info_table) / sizeof(prop_info_table[0]);

static ESExpResult *
entry_compare(SearchContext *ctx, struct _ESExp *f,
          int argc, struct _ESExpResult **argv,
          char *(*compare)(const char*, const char*))
{
    ESExpResult *r;
    int truth = FALSE;

    if (argc == 2
        && argv[0]->type == ESEXP_RES_STRING
        && argv[1]->type == ESEXP_RES_STRING) {
        char *propname;
        struct prop_info *info = NULL;
        int i;
        gboolean any_field;

        propname = argv[0]->value.string;

        any_field = !strcmp(propname, "x-evolution-any-field");
        for (i = 0; i < num_prop_infos; i ++) {
            if (any_field
                || !strcmp (prop_info_table[i].query_prop, propname)) {
                info = &prop_info_table[i];
                
                if (info->prop_type == PROP_TYPE_NORMAL) {
                    const char *prop = NULL;
                    /* straight string property matches */
                    
                    prop = e_contact_get_const (ctx->contact, info->field_id);

                    if (prop && compare(prop, argv[1]->value.string)) {
                        truth = TRUE;
                    }
                    if ((!prop) && compare("", argv[1]->value.string)) {
                        truth = TRUE;
                    }
                }
                else if (info->prop_type == PROP_TYPE_LIST) {
                    /* the special searches that match any of the list elements */
                    truth = info->list_compare (ctx->contact, argv[1]->value.string, compare);
                }

                /* if we're looking at all fields and find a match,
                   or if we're just looking at this one field,
                   break. */
                if ((any_field && truth)
                    || !any_field)
                    break;
            }
        }
        
    }
    r = e_sexp_result_new(f, ESEXP_RES_BOOL);
    r->value.bool = truth;

    return r;
}

static ESExpResult *
func_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, void *data)
{
    SearchContext *ctx = data;

    return entry_compare (ctx, f, argc, argv, (char *(*)(const char*, const char*)) e_utf8_strstrcase);
}

static char *
is_helper (const char *s1, const char *s2)
{
    if (!strcasecmp(s1, s2))
        return (char*)s1;
    else
        return NULL;
}

static ESExpResult *
func_is(struct _ESExp *f, int argc, struct _ESExpResult **argv, void *data)
{
    SearchContext *ctx = data;

    return entry_compare (ctx, f, argc, argv, is_helper);
}

static char *
endswith_helper (const char *s1, const char *s2)
{
    char *p;
    if ((p = (char*)e_utf8_strstrcase(s1, s2))
        && (strlen(p) == strlen(s2)))
        return p;
    else
        return NULL;
}

static ESExpResult *
func_endswith(struct _ESExp *f, int argc, struct _ESExpResult **argv, void *data)
{
    SearchContext *ctx = data;

    return entry_compare (ctx, f, argc, argv, endswith_helper);
}

static char *
beginswith_helper (const char *s1, const char *s2)
{
    char *p;
    if ((p = (char*)e_utf8_strstrcase(s1, s2))
        && (p == s1))
        return p;
    else
        return NULL;
}

static ESExpResult *
func_beginswith(struct _ESExp *f, int argc, struct _ESExpResult **argv, void *data)
{
    SearchContext *ctx = data;

    return entry_compare (ctx, f, argc, argv, beginswith_helper);
}

static ESExpResult *
func_exists(struct _ESExp *f, int argc, struct _ESExpResult **argv, void *data)
{
    SearchContext *ctx = data;
    ESExpResult *r;
    int truth = FALSE;

    if (argc == 1
        && argv[0]->type == ESEXP_RES_STRING) {
        char *propname;
        struct prop_info *info = NULL;
        int i;

        propname = argv[0]->value.string;

        for (i = 0; i < num_prop_infos; i ++) {
            if (!strcmp (prop_info_table[i].query_prop, propname)) {
                info = &prop_info_table[i];
                
                if (info->prop_type == PROP_TYPE_NORMAL) {
                    const char *prop = NULL;
                    /* searches where the query's property
                       maps directly to an ecard property */
                    
                    prop = e_contact_get_const (ctx->contact, info->field_id);

                    if (prop && *prop)
                        truth = TRUE;
                }
                else if (info->prop_type == PROP_TYPE_LIST) {
                /* the special searches that match any of the list elements */
                    truth = info->list_compare (ctx->contact, "", (char *(*)(const char*, const char*)) e_utf8_strstrcase);
                }

                break;
            }
        }
        
    }
    r = e_sexp_result_new(f, ESEXP_RES_BOOL);
    r->value.bool = truth;

    return r;
}

/* 'builtin' functions */
static struct {
    char *name;
    ESExpFunc *func;
    int type;       /* set to 1 if a function can perform shortcut evaluation, or
                   doesn't execute everything, 0 otherwise */
} symbols[] = {
    { "contains", func_contains, 0 },
    { "is", func_is, 0 },
    { "beginswith", func_beginswith, 0 },
    { "endswith", func_endswith, 0 },
    { "exists", func_exists, 0 },
};

gboolean
pas_backend_card_sexp_match_contact (PASBackendCardSExp *sexp, EContact *contact)
{
    ESExpResult *r;
    gboolean retval;

    if (!contact) {
        g_warning ("null EContact passed to pas_backend_card_sexp_match_contact");
        return FALSE;
    }

    sexp->priv->search_context->contact = g_object_ref (contact);

    r = e_sexp_eval(sexp->priv->search_sexp);

    retval = (r && r->type == ESEXP_RES_BOOL && r->value.bool);

    g_object_unref(sexp->priv->search_context->contact);

    e_sexp_result_free(sexp->priv->search_sexp, r);

    return retval;
}

gboolean
pas_backend_card_sexp_match_vcard (PASBackendCardSExp *sexp, const char *vcard)
{
    EContact *contact;
    gboolean retval;

    contact = e_contact_new_from_vcard (vcard);

    retval = pas_backend_card_sexp_match_contact (sexp, contact);

    g_object_unref(contact);

    return retval;
}



/**
 * pas_backend_card_sexp_new:
 */
PASBackendCardSExp *
pas_backend_card_sexp_new (const char *text)
{
    PASBackendCardSExp *sexp = g_object_new (PAS_TYPE_BACKEND_CARD_SEXP, NULL);
    int esexp_error;
    int i;

    sexp->priv->search_sexp = e_sexp_new();

    for(i=0;i<sizeof(symbols)/sizeof(symbols[0]);i++) {
        if (symbols[i].type == 1) {
            e_sexp_add_ifunction(sexp->priv->search_sexp, 0, symbols[i].name,
                         (ESExpIFunc *)symbols[i].func, sexp->priv->search_context);
        }
        else {
            e_sexp_add_function(sexp->priv->search_sexp, 0, symbols[i].name,
                        symbols[i].func, sexp->priv->search_context);
        }
    }

    e_sexp_input_text(sexp->priv->search_sexp, text, strlen(text));
    esexp_error = e_sexp_parse(sexp->priv->search_sexp);

    if (esexp_error == -1) {
        g_object_unref (sexp);
        sexp = NULL;
    }

    return sexp;
}

static void
pas_backend_card_sexp_dispose (GObject *object)
{
    PASBackendCardSExp *sexp = PAS_BACKEND_CARD_SEXP (object);

    if (sexp->priv) {
        e_sexp_unref(sexp->priv->search_sexp);

        g_free (sexp->priv->search_context);
        g_free (sexp->priv);
        sexp->priv = NULL;
    }

    if (G_OBJECT_CLASS (parent_class)->dispose)
        G_OBJECT_CLASS (parent_class)->dispose (object);
}

static void
pas_backend_card_sexp_class_init (PASBackendCardSExpClass *klass)
{
    GObjectClass  *object_class = G_OBJECT_CLASS (klass);

    parent_class = g_type_class_peek_parent (klass);

    /* Set the virtual methods. */

    object_class->dispose = pas_backend_card_sexp_dispose;
}

static void
pas_backend_card_sexp_init (PASBackendCardSExp *sexp)
{
    PASBackendCardSExpPrivate *priv;

    priv             = g_new0 (PASBackendCardSExpPrivate, 1);

    sexp->priv = priv;
    priv->search_context = g_new (SearchContext, 1);
}

/**
 * pas_backend_card_sexp_get_type:
 */
GType
pas_backend_card_sexp_get_type (void)
{
    static GType type = 0;

    if (! type) {
        GTypeInfo info = {
            sizeof (PASBackendCardSExpClass),
            NULL, /* base_class_init */
            NULL, /* base_class_finalize */
            (GClassInitFunc)  pas_backend_card_sexp_class_init,
            NULL, /* class_finalize */
            NULL, /* class_data */
            sizeof (PASBackendCardSExp),
            0,    /* n_preallocs */
            (GInstanceInitFunc) pas_backend_card_sexp_init
        };

        type = g_type_register_static (G_TYPE_OBJECT, "PASBackendCardSExp", &info, 0);
    }

    return type;
}