Moved contact.c

2 files changed, 522 insertions, 0 deletions

diff --git a/src/xmpp/contact.c b/src/xmpp/contact.c
new file mode 100644
index 00000000..000d7668
--- /dev/null
+++ b/src/xmpp/contact.c
@@ -0,0 +1,446 @@
+/*
+ * contact.c
+ *
+ * Copyright (C) 2012 - 2016 James Booth <boothj5@gmail.com>
+ *
+ * This file is part of Profanity.
+ *
+ * Profanity 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 of the License, or
+ * (at your option) any later version.
+ *
+ * Profanity 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 Profanity.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * In addition, as a special exception, the copyright holders give permission to
+ * link the code of portions of this program with the OpenSSL library under
+ * certain conditions as described in each individual source file, and
+ * distribute linked combinations including the two.
+ *
+ * You must obey the GNU General Public License in all respects for all of the
+ * code used other than OpenSSL. If you modify file(s) with this exception, you
+ * may extend this exception to your version of the file(s), but you are not
+ * obligated to do so. If you do not wish to do so, delete this exception
+ * statement from your version. If you delete this exception statement from all
+ * source files in the program, then also delete it here.
+ *
+ */
+
+#include <assert.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <glib.h>
+
+#include "contact.h"
+#include "common.h"
+#include "resource.h"
+#include "tools/autocomplete.h"
+
+struct p_contact_t {
+    char *barejid;
+    gchar *barejid_collate_key;
+    char *name;
+    gchar *name_collate_key;
+    GSList *groups;
+    char *subscription;
+    char *offline_message;
+    gboolean pending_out;
+    GDateTime *last_activity;
+    GHashTable *available_resources;
+    Autocomplete resource_ac;
+};
+
+PContact
+p_contact_new(const char *const barejid, const char *const name,
+    GSList *groups, const char *const subscription,
+    const char *const offline_message, gboolean pending_out)
+{
+    PContact contact = malloc(sizeof(struct p_contact_t));
+    contact->barejid = strdup(barejid);
+    contact->barejid_collate_key = g_utf8_collate_key(contact->barejid, -1);
+
+    if (name) {
+        contact->name = strdup(name);
+        contact->name_collate_key = g_utf8_collate_key(contact->name, -1);
+    } else {
+        contact->name = NULL;
+        contact->name_collate_key = NULL;
+    }
+
+    contact->groups = groups;
+
+    if (subscription)
+        contact->subscription = strdup(subscription);
+    else
+        contact->subscription = strdup("none");
+
+    if (offline_message)
+        contact->offline_message = strdup(offline_message);
+    else
+        contact->offline_message = NULL;
+
+    contact->pending_out = pending_out;
+    contact->last_activity = NULL;
+
+    contact->available_resources = g_hash_table_new_full(g_str_hash, g_str_equal, free,
+        (GDestroyNotify)resource_destroy);
+
+    contact->resource_ac = autocomplete_new();
+
+    return contact;
+}
+
+void
+p_contact_set_name(const PContact contact, const char *const name)
+{
+    FREE_SET_NULL(contact->name);
+    FREE_SET_NULL(contact->name_collate_key);
+    if (name) {
+        contact->name = strdup(name);
+        contact->name_collate_key = g_utf8_collate_key(contact->name, -1);
+    }
+}
+
+void
+p_contact_set_groups(const PContact contact, GSList *groups)
+{
+    if (contact->groups) {
+        g_slist_free_full(contact->groups, g_free);
+        contact->groups = NULL;
+    }
+
+    contact->groups = groups;
+}
+
+gboolean
+p_contact_in_group(const PContact contact, const char *const group)
+{
+    GSList *groups = contact->groups;
+    while (groups) {
+        if (strcmp(groups->data, group) == 0) {
+            return TRUE;
+        }
+        groups = g_slist_next(groups);
+    }
+
+    return FALSE;
+}
+
+GSList*
+p_contact_groups(const PContact contact)
+{
+    return contact->groups;
+}
+
+gboolean
+p_contact_remove_resource(PContact contact, const char *const resource)
+{
+    gboolean result = g_hash_table_remove(contact->available_resources, resource);
+    autocomplete_remove(contact->resource_ac, resource);
+
+    return result;
+}
+
+void
+p_contact_free(PContact contact)
+{
+    if (contact) {
+        free(contact->barejid);
+        free(contact->barejid_collate_key);
+        free(contact->name);
+        free(contact->name_collate_key);
+        free(contact->subscription);
+        free(contact->offline_message);
+
+        if (contact->groups) {
+            g_slist_free_full(contact->groups, g_free);
+        }
+
+        if (contact->last_activity) {
+            g_date_time_unref(contact->last_activity);
+        }
+
+        g_hash_table_destroy(contact->available_resources);
+        autocomplete_free(contact->resource_ac);
+        free(contact);
+    }
+}
+
+const char*
+p_contact_barejid(const PContact contact)
+{
+    return contact->barejid;
+}
+
+const char*
+p_contact_barejid_collate_key(const PContact contact)
+{
+    return contact->barejid_collate_key;
+}
+
+const char*
+p_contact_name(const PContact contact)
+{
+    return contact->name;
+}
+
+const char*
+p_contact_name_collate_key(const PContact contact)
+{
+    return contact->name_collate_key;
+}
+
+const char*
+p_contact_name_or_jid(const PContact contact)
+{
+    if (contact->name) {
+        return contact->name;
+    } else {
+        return contact->barejid;
+    }
+}
+
+char*
+p_contact_create_display_string(const PContact contact, const char *const resource)
+{
+    GString *result_str = g_string_new("");
+
+    // use nickname if exists
+    const char *display_name = p_contact_name_or_jid(contact);
+    g_string_append(result_str, display_name);
+
+    // add resource if not default provided by profanity
+    if (strcmp(resource, "__prof_default") != 0) {
+        g_string_append(result_str, " (");
+        g_string_append(result_str, resource);
+        g_string_append(result_str, ")");
+    }
+
+    char *result = result_str->str;
+    g_string_free(result_str, FALSE);
+
+    return result;
+}
+
+static Resource*
+_highest_presence(Resource *first, Resource *second)
+{
+    if (first->presence == RESOURCE_CHAT) {
+        return first;
+    } else if (second->presence == RESOURCE_CHAT) {
+        return second;
+    } else if (first->presence == RESOURCE_ONLINE) {
+        return first;
+    } else if (second->presence == RESOURCE_ONLINE) {
+        return second;
+    } else if (first->presence == RESOURCE_AWAY) {
+        return first;
+    } else if (second->presence == RESOURCE_AWAY) {
+        return second;
+    } else if (first->presence == RESOURCE_XA) {
+        return first;
+    } else if (second->presence == RESOURCE_XA) {
+        return second;
+    } else {
+        return first;
+    }
+}
+
+Resource*
+_get_most_available_resource(PContact contact)
+{
+    // find resource with highest priority, if more than one,
+    // use highest availability, in the following order:
+    //      chat
+    //      online
+    //      away
+    //      xa
+    //      dnd
+    GList *resources = g_hash_table_get_values(contact->available_resources);
+    GList *curr = resources;
+    Resource *current = curr->data;
+    Resource *highest = current;
+    curr = g_list_next(curr);
+    while (curr) {
+        current = curr->data;
+
+        // priority is same as current highest, choose presence
+        if (current->priority == highest->priority) {
+            highest = _highest_presence(highest, current);
+
+        // priority higher than current highest, set new presence
+        } else if (current->priority > highest->priority) {
+            highest = current;
+        }
+
+        curr = g_list_next(curr);
+    }
+    g_list_free(resources);
+
+    return highest;
+}
+
+const char*
+p_contact_presence(const PContact contact)
+{
+    assert(contact != NULL);
+
+    // no available resources, offline
+    if (g_hash_table_size(contact->available_resources) == 0) {
+        return "offline";
+    }
+
+    Resource *resource = _get_most_available_resource(contact);
+
+    return string_from_resource_presence(resource->presence);
+}
+
+const char*
+p_contact_status(const PContact contact)
+{
+    assert(contact != NULL);
+
+    // no available resources, use offline message
+    if (g_hash_table_size(contact->available_resources) == 0) {
+        return contact->offline_message;
+    }
+
+    Resource *resource = _get_most_available_resource(contact);
+
+    return resource->status;
+}
+
+const char*
+p_contact_subscription(const PContact contact)
+{
+    return contact->subscription;
+}
+
+gboolean
+p_contact_subscribed(const PContact contact)
+{
+    if (contact->subscription == NULL) {
+        return FALSE;
+    } else if (strcmp(contact->subscription, "to") == 0) {
+        return TRUE;
+    } else if (strcmp(contact->subscription, "both") == 0) {
+        return TRUE;
+    } else {
+        return FALSE;
+    }
+}
+
+Resource*
+p_contact_get_resource(const PContact contact, const char *const resource)
+{
+    return g_hash_table_lookup(contact->available_resources, resource);
+}
+
+gboolean
+p_contact_pending_out(const PContact contact)
+{
+    return contact->pending_out;
+}
+
+GDateTime*
+p_contact_last_activity(const PContact contact)
+{
+    return contact->last_activity;
+}
+
+GList*
+p_contact_get_available_resources(const PContact contact)
+{
+    assert(contact != NULL);
+    GList *resources = g_hash_table_get_values(contact->available_resources);
+    GList *ordered = NULL;
+
+    GList *curr_resource = resources;
+    while (curr_resource) {
+        Resource *resource = curr_resource->data;
+        ordered = g_list_insert_sorted(ordered, resource, (GCompareFunc)resource_compare_availability);
+        curr_resource = g_list_next(curr_resource);
+    }
+
+    g_list_free(resources);
+
+    return ordered;
+}
+
+gboolean
+p_contact_is_available(const PContact contact)
+{
+    // no available resources, unavailable
+    if (g_hash_table_size(contact->available_resources) == 0) {
+        return FALSE;
+    }
+
+    // if most available resource is CHAT or ONLINE, available
+    Resource *most_available = _get_most_available_resource(contact);
+    if ((most_available->presence == RESOURCE_ONLINE) ||
+        (most_available->presence == RESOURCE_CHAT)) {
+        return TRUE;
+    } else {
+        return FALSE;
+    }
+}
+
+gboolean
+p_contact_has_available_resource(const PContact contact)
+{
+    return (g_hash_table_size(contact->available_resources) > 0);
+}
+
+void
+p_contact_set_presence(const PContact contact, Resource *resource)
+{
+    g_hash_table_replace(contact->available_resources, strdup(resource->name), resource);
+    autocomplete_add(contact->resource_ac, resource->name);
+}
+
+void
+p_contact_set_subscription(const PContact contact, const char *const subscription)
+{
+    FREE_SET_NULL(contact->subscription);
+    if (subscription) {
+        contact->subscription = strdup(subscription);
+    }
+}
+
+void
+p_contact_set_pending_out(const PContact contact, gboolean pending_out)
+{
+    contact->pending_out = pending_out;
+}
+
+void
+p_contact_set_last_activity(const PContact contact, GDateTime *last_activity)
+{
+    if (contact->last_activity) {
+        g_date_time_unref(contact->last_activity);
+        contact->last_activity = NULL;
+    }
+
+    if (last_activity) {
+        contact->last_activity = g_date_time_ref(last_activity);
+    }
+}
+
+Autocomplete
+p_contact_resource_ac(const PContact contact)
+{
+    return contact->resource_ac;
+}
+
+void
+p_contact_resource_ac_reset(const PContact contact)
+{
+    autocomplete_reset(contact->resource_ac);
+}
diff --git a/src/xmpp/contact.h b/src/xmpp/contact.h
new file mode 100644
index 00000000..6a13d01e
--- /dev/null
+++ b/src/xmpp/contact.h
@@ -0,0 +1,76 @@
+/*
+ * contact.h
+ *
+ * Copyright (C) 2012 - 2016 James Booth <boothj5@gmail.com>
+ *
+ * This file is part of Profanity.
+ *
+ * Profanity 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 of the License, or
+ * (at your option) any later version.
+ *
+ * Profanity 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 Profanity.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * In addition, as a special exception, the copyright holders give permission to
+ * link the code of portions of this program with the OpenSSL library under
+ * certain conditions as described in each individual source file, and
+ * distribute linked combinations including the two.
+ *
+ * You must obey the GNU General Public License in all respects for all of the
+ * code used other than OpenSSL. If you modify file(s) with this exception, you
+ * may extend this exception to your version of the file(s), but you are not
+ * obligated to do so. If you do not wish to do so, delete this exception
+ * statement from your version. If you delete this exception statement from all
+ * source files in the program, then also delete it here.
+ *
+ */
+
+#ifndef XMPP_CONTACT_H
+#define XMPP_CONTACT_H
+
+#include "resource.h"
+#include "tools/autocomplete.h"
+
+typedef struct p_contact_t *PContact;
+
+PContact p_contact_new(const char *const barejid, const char *const name, GSList *groups,
+    const char *const subscription, const char *const offline_message, gboolean pending_out);
+void p_contact_add_resource(PContact contact, Resource *resource);
+gboolean p_contact_remove_resource(PContact contact, const char *const resource);
+void p_contact_free(PContact contact);
+const char* p_contact_barejid(PContact contact);
+const char* p_contact_barejid_collate_key(PContact contact);
+const char* p_contact_name(PContact contact);
+const char* p_contact_name_collate_key(PContact contact);
+const char* p_contact_name_or_jid(const PContact contact);
+const char* p_contact_presence(PContact contact);
+const char* p_contact_status(PContact contact);
+const char* p_contact_subscription(const PContact contact);
+GList* p_contact_get_available_resources(const PContact contact);
+GDateTime* p_contact_last_activity(const PContact contact);
+gboolean p_contact_pending_out(const PContact contact);
+void p_contact_set_presence(const PContact contact, Resource *resource);
+void p_contact_set_status(const PContact contact, const char *const status);
+void p_contact_set_name(const PContact contact, const char *const name);
+void p_contact_set_subscription(const PContact contact, const char *const subscription);
+void p_contact_set_pending_out(const PContact contact, gboolean pending_out);
+void p_contact_set_last_activity(const PContact contact, GDateTime *last_activity);
+gboolean p_contact_is_available(const PContact contact);
+gboolean p_contact_has_available_resource(const PContact contact);
+Resource* p_contact_get_resource(const PContact contact, const char *const resource);
+void p_contact_set_groups(const PContact contact, GSList *groups);
+GSList* p_contact_groups(const PContact contact);
+gboolean p_contact_in_group(const PContact contact, const char *const group);
+gboolean p_contact_subscribed(const PContact contact);
+char* p_contact_create_display_string(const PContact contact, const char *const resource);
+Autocomplete p_contact_resource_ac(const PContact contact);
+void p_contact_resource_ac_reset(const PContact contact);
+
+#endif