diff libpurple/notify.c @ 15373:5fe8042783c1

Rename gtk/ and libgaim/ to pidgin/ and libpurple/

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/notify.c	Sat Jan 20 02:32:10 2007 +0000
@@ -0,0 +1,809 @@
+/**
+ * @file notify.c Notification API
+ * @ingroup core
+ *
+ * gaim
+ *
+ * Gaim is the legal property of its developers, whose names are too numerous
+ * to list here.  Please refer to the COPYRIGHT file distributed with this
+ * source distribution.
+ *
+ * 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 of the License, 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, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+#include "notify.h"
+
+static GaimNotifyUiOps *notify_ui_ops = NULL;
+static GList *handles = NULL;
+
+typedef struct
+{
+	GaimNotifyType type;
+	void *handle;
+	void *ui_handle;
+	GaimNotifyCloseCallback cb;
+	gpointer cb_user_data;
+} GaimNotifyInfo;
+
+/**
+ * Definition of a user info entry
+ */
+struct _GaimNotifyUserInfoEntry
+{
+	char *label;
+	char *value;
+	GaimNotifyUserInfoEntryType type;
+};
+
+struct _GaimNotifyUserInfo
+{
+	GList *user_info_entries;
+};
+
+void *
+gaim_notify_message(void *handle, GaimNotifyMsgType type,
+					const char *title, const char *primary,
+					const char *secondary, GaimNotifyCloseCallback cb, gpointer user_data)
+{
+	GaimNotifyUiOps *ops;
+
+	g_return_val_if_fail(primary != NULL, NULL);
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_message != NULL) {
+		GaimNotifyInfo *info;
+
+		info            = g_new0(GaimNotifyInfo, 1);
+		info->type      = GAIM_NOTIFY_MESSAGE;
+		info->handle    = handle;
+		info->ui_handle = ops->notify_message(type, title, primary,
+											  secondary);
+		info->cb = cb;
+		info->cb_user_data = user_data;
+
+		if (info->ui_handle != NULL) {
+			handles = g_list_append(handles, info);
+
+			return info->ui_handle;
+
+		} else {
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+
+			return NULL;
+		}
+
+	} else {
+		if (cb != NULL)
+			cb(user_data);
+	}
+
+	return NULL;
+}
+
+void *
+gaim_notify_email(void *handle, const char *subject, const char *from,
+				  const char *to, const char *url, GaimNotifyCloseCallback cb,
+				  gpointer user_data)
+{
+	GaimNotifyUiOps *ops;
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_email != NULL) {
+		GaimNotifyInfo *info;
+
+		info            = g_new0(GaimNotifyInfo, 1);
+		info->type      = GAIM_NOTIFY_EMAIL;
+		info->handle    = handle;
+		info->ui_handle = ops->notify_email(handle, subject, from, to, url);
+		info->cb = cb;
+		info->cb_user_data = user_data;
+
+		if (info->ui_handle != NULL) {
+			handles = g_list_append(handles, info);
+
+			return info->ui_handle;
+
+		} else {
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+
+			return NULL;
+		}
+	} else {
+		if (cb != NULL)
+			cb(user_data);
+	}
+
+	return NULL;
+}
+
+void *
+gaim_notify_emails(void *handle, size_t count, gboolean detailed,
+				   const char **subjects, const char **froms,
+				   const char **tos, const char **urls,
+				   GaimNotifyCloseCallback cb, gpointer user_data)
+{
+	GaimNotifyUiOps *ops;
+
+	g_return_val_if_fail(count != 0, NULL);
+
+	if (count == 1) {
+		return gaim_notify_email(handle,
+								 (subjects == NULL ? NULL : *subjects),
+								 (froms    == NULL ? NULL : *froms),
+								 (tos      == NULL ? NULL : *tos),
+								 (urls     == NULL ? NULL : *urls),
+								 cb, user_data);
+	}
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_emails != NULL) {
+		GaimNotifyInfo *info;
+
+		info            = g_new0(GaimNotifyInfo, 1);
+		info->type      = GAIM_NOTIFY_EMAILS;
+		info->handle    = handle;
+		info->ui_handle = ops->notify_emails(handle, count, detailed, subjects,
+											 froms, tos, urls);
+		info->cb = cb;
+		info->cb_user_data = user_data;
+
+		if (info->ui_handle != NULL) {
+			handles = g_list_append(handles, info);
+
+			return info->ui_handle;
+
+		} else {
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+
+			return NULL;
+		}
+
+	} else {
+		if (cb != NULL)
+			cb(user_data);
+	}
+
+	return NULL;
+}
+
+void *
+gaim_notify_formatted(void *handle, const char *title, const char *primary,
+					  const char *secondary, const char *text,
+					  GaimNotifyCloseCallback cb, gpointer user_data)
+{
+	GaimNotifyUiOps *ops;
+
+	g_return_val_if_fail(primary != NULL, NULL);
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_formatted != NULL) {
+		GaimNotifyInfo *info;
+
+		info            = g_new0(GaimNotifyInfo, 1);
+		info->type      = GAIM_NOTIFY_FORMATTED;
+		info->handle    = handle;
+		info->ui_handle = ops->notify_formatted(title, primary, secondary, text);
+		info->cb = cb;
+		info->cb_user_data = user_data;
+
+		if (info->ui_handle != NULL) {
+			handles = g_list_append(handles, info);
+
+			return info->ui_handle;
+
+		} else {
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+
+			return NULL;
+		}
+
+	} else {
+		if (cb != NULL)
+			cb(user_data);
+	}
+
+	return NULL;
+}
+
+void *
+gaim_notify_searchresults(GaimConnection *gc, const char *title,
+						  const char *primary, const char *secondary,
+						  GaimNotifySearchResults *results, GaimNotifyCloseCallback cb,
+						  gpointer user_data)
+{
+	GaimNotifyUiOps *ops;
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_searchresults != NULL) {
+		GaimNotifyInfo *info;
+
+		info            = g_new0(GaimNotifyInfo, 1);
+		info->type      = GAIM_NOTIFY_SEARCHRESULTS;
+		info->handle    = gc;
+		info->ui_handle = ops->notify_searchresults(gc, title, primary,
+													secondary, results, user_data);
+		info->cb = cb;
+		info->cb_user_data = user_data;
+
+		if (info->ui_handle != NULL) {
+			handles = g_list_append(handles, info);
+
+			return info->ui_handle;
+
+		} else {
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+
+			return NULL;
+		}
+
+	} else {
+		if (cb != NULL)
+			cb(user_data);
+	}
+
+	return NULL;
+}
+
+void
+gaim_notify_searchresults_free(GaimNotifySearchResults *results)
+{
+	GList *l;
+
+	g_return_if_fail(results != NULL);
+
+	for (l = results->buttons; l; l = g_list_delete_link(l, l)) {
+		GaimNotifySearchButton *button = l->data;
+		g_free(button->label);
+		g_free(button);
+	}
+
+	for (l = results->rows; l; l = g_list_delete_link(l, l)) {
+		GList *row = l->data;
+		g_list_foreach(row, (GFunc)g_free, NULL);
+		g_list_free(row);
+	}
+
+	for (l = results->columns; l; l = g_list_delete_link(l, l)) {
+		GaimNotifySearchColumn *column = l->data;
+		g_free(column->title);
+		g_free(column);
+	}
+
+	g_free(results);
+}
+
+void
+gaim_notify_searchresults_new_rows(GaimConnection *gc,
+		GaimNotifySearchResults *results,
+		void *data)
+{
+	GaimNotifyUiOps *ops;
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_searchresults != NULL) {
+		ops->notify_searchresults_new_rows(gc, results, data);
+	}
+}
+
+void
+gaim_notify_searchresults_button_add(GaimNotifySearchResults *results,
+									 GaimNotifySearchButtonType type,
+									 GaimNotifySearchResultsCallback cb)
+{
+	GaimNotifySearchButton *button;
+
+	g_return_if_fail(results != NULL);
+	g_return_if_fail(cb != NULL);
+
+	button = g_new0(GaimNotifySearchButton, 1);
+	button->callback = cb;
+	button->type = type;
+
+	results->buttons = g_list_append(results->buttons, button);
+}
+
+
+void
+gaim_notify_searchresults_button_add_labeled(GaimNotifySearchResults *results,
+                                             const char *label,
+                                             GaimNotifySearchResultsCallback cb) {
+	GaimNotifySearchButton *button;
+
+	g_return_if_fail(results != NULL);
+	g_return_if_fail(cb != NULL);
+	g_return_if_fail(label != NULL);
+	g_return_if_fail(*label != '\0');
+
+	button = g_new0(GaimNotifySearchButton, 1);
+	button->callback = cb;
+	button->type = GAIM_NOTIFY_BUTTON_LABELED;
+	button->label = g_strdup(label);
+
+	results->buttons = g_list_append(results->buttons, button);
+}
+
+
+GaimNotifySearchResults *
+gaim_notify_searchresults_new()
+{
+	GaimNotifySearchResults *rs = g_new0(GaimNotifySearchResults, 1);
+
+	return rs;
+}
+
+void
+gaim_notify_searchresults_column_add(GaimNotifySearchResults *results,
+									 GaimNotifySearchColumn *column)
+{
+	g_return_if_fail(results != NULL);
+	g_return_if_fail(column  != NULL);
+
+	results->columns = g_list_append(results->columns, column);
+}
+
+void gaim_notify_searchresults_row_add(GaimNotifySearchResults *results,
+									   GList *row)
+{
+	g_return_if_fail(results != NULL);
+	g_return_if_fail(row     != NULL);
+
+	results->rows = g_list_append(results->rows, row);
+}
+
+GaimNotifySearchColumn *
+gaim_notify_searchresults_column_new(const char *title)
+{
+	GaimNotifySearchColumn *sc;
+
+	g_return_val_if_fail(title != NULL, NULL);
+
+	sc = g_new0(GaimNotifySearchColumn, 1);
+	sc->title = g_strdup(title);
+
+	return sc;
+}
+
+guint
+gaim_notify_searchresults_get_columns_count(GaimNotifySearchResults *results)
+{
+	g_return_val_if_fail(results != NULL, 0);
+
+	return g_list_length(results->columns);
+}
+
+guint
+gaim_notify_searchresults_get_rows_count(GaimNotifySearchResults *results)
+{
+	g_return_val_if_fail(results != NULL, 0);
+
+	return g_list_length(results->rows);
+}
+
+char *
+gaim_notify_searchresults_column_get_title(GaimNotifySearchResults *results,
+										   unsigned int column_id)
+{
+	g_return_val_if_fail(results != NULL, NULL);
+
+	return ((GaimNotifySearchColumn *)g_list_nth_data(results->columns, column_id))->title;
+}
+
+GList *
+gaim_notify_searchresults_row_get(GaimNotifySearchResults *results,
+								  unsigned int row_id)
+{
+	g_return_val_if_fail(results != NULL, NULL);
+
+	return g_list_nth_data(results->rows, row_id);
+}
+
+void *
+gaim_notify_userinfo(GaimConnection *gc, const char *who,
+						   GaimNotifyUserInfo *user_info, GaimNotifyCloseCallback cb, gpointer user_data)
+{
+	GaimNotifyUiOps *ops;
+
+	g_return_val_if_fail(who != NULL, NULL);
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_userinfo != NULL) {
+		GaimNotifyInfo *info;
+
+		info            = g_new0(GaimNotifyInfo, 1);
+		info->type      = GAIM_NOTIFY_USERINFO;
+		info->handle    = gc;
+
+		gaim_signal_emit(gaim_notify_get_handle(), "displaying-userinfo",
+						 gaim_connection_get_account(gc), who, user_info);
+
+		info->ui_handle = ops->notify_userinfo(gc, who, user_info);
+		info->cb = cb;
+		info->cb_user_data = user_data;
+
+		if (info->ui_handle != NULL) {
+			handles = g_list_append(handles, info);
+
+			return info->ui_handle;
+
+		} else {
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+
+			return NULL;
+		}
+
+	} else {
+		if (cb != NULL)
+			cb(user_data);
+	}
+
+	return NULL;
+}
+
+GaimNotifyUserInfoEntry *
+gaim_notify_user_info_entry_new(const char *label, const char *value)
+{
+	GaimNotifyUserInfoEntry *user_info_entry;
+	
+	user_info_entry = g_new0(GaimNotifyUserInfoEntry, 1);
+	user_info_entry->label = g_strdup(label);
+	user_info_entry->value = g_strdup(value);
+	user_info_entry->type = GAIM_NOTIFY_USER_INFO_ENTRY_PAIR;
+
+	return user_info_entry;
+}
+
+static void
+gaim_notify_user_info_entry_destroy(GaimNotifyUserInfoEntry *user_info_entry)
+{
+	g_return_if_fail(user_info_entry != NULL);
+	
+	g_free(user_info_entry->label);
+	g_free(user_info_entry->value);	
+	g_free(user_info_entry);
+}
+
+GaimNotifyUserInfo *
+gaim_notify_user_info_new()
+{
+	GaimNotifyUserInfo *user_info;
+	
+	user_info = g_new0(GaimNotifyUserInfo, 1);
+	user_info->user_info_entries = NULL;
+	
+	return user_info;
+}
+
+void
+gaim_notify_user_info_destroy(GaimNotifyUserInfo *user_info)
+{
+	GList *l;
+
+	for (l = user_info->user_info_entries; l != NULL; l = l->next) {
+		GaimNotifyUserInfoEntry *user_info_entry = l->data;
+		
+		gaim_notify_user_info_entry_destroy(user_info_entry);
+	}
+	
+	g_list_free(user_info->user_info_entries);
+}
+
+GList *
+gaim_notify_user_info_get_entries(GaimNotifyUserInfo *user_info)
+{
+	g_return_val_if_fail(user_info != NULL, NULL);
+
+	return user_info->user_info_entries;
+}
+
+char *
+gaim_notify_user_info_get_text_with_newline(GaimNotifyUserInfo *user_info, const char *newline)
+{
+	GList *l;
+	GString *text;
+	
+	text = g_string_new("");
+
+	for (l = user_info->user_info_entries; l != NULL; l = l->next) {
+		GaimNotifyUserInfoEntry *user_info_entry = l->data;
+		/* Add a newline before a section header */
+		if (user_info_entry->type == GAIM_NOTIFY_USER_INFO_ENTRY_SECTION_HEADER)
+			g_string_append(text, newline);
+
+		/* Handle the label/value pair itself */
+		/* XXX Todo: Use a larger size for a section header? */
+		if (user_info_entry->label)
+			g_string_append_printf(text, "<b>%s</b>", user_info_entry->label);
+		if (user_info_entry->label && user_info_entry->value)
+			g_string_append(text, ": ");
+		if (user_info_entry->value)
+			g_string_append(text, user_info_entry->value);			
+
+		/* Display a section break as a horizontal line */
+		if (user_info_entry->type == GAIM_NOTIFY_USER_INFO_ENTRY_SECTION_BREAK)
+			g_string_append(text, "<HR>");
+
+		/* Don't insert a new line before or after a section break; <HR> does that for us */
+		if ((user_info_entry->type != GAIM_NOTIFY_USER_INFO_ENTRY_SECTION_BREAK) &&
+			(l->next && ((((GaimNotifyUserInfoEntry *)(l->next->data))->type != GAIM_NOTIFY_USER_INFO_ENTRY_SECTION_BREAK))))
+			g_string_append(text, newline);
+		
+		/* Add an extra newline after a section header */
+		if (user_info_entry->type == GAIM_NOTIFY_USER_INFO_ENTRY_SECTION_HEADER)
+			g_string_append(text, newline);
+	}
+
+	return g_string_free(text, FALSE);
+}
+
+
+gchar *
+gaim_notify_user_info_entry_get_label(GaimNotifyUserInfoEntry *user_info_entry)
+{
+	g_return_val_if_fail(user_info_entry != NULL, NULL);
+
+	return user_info_entry->label;
+}
+
+void
+gaim_notify_user_info_entry_set_label(GaimNotifyUserInfoEntry *user_info_entry, const char *label)
+{
+	g_return_if_fail(user_info_entry != NULL);
+
+	g_free(user_info_entry->label);
+	user_info_entry->label = g_strdup(label);
+}
+
+gchar *
+gaim_notify_user_info_entry_get_value(GaimNotifyUserInfoEntry *user_info_entry)
+{
+	g_return_val_if_fail(user_info_entry != NULL, NULL);
+	
+	return user_info_entry->value;
+}
+
+void
+gaim_notify_user_info_entry_set_value(GaimNotifyUserInfoEntry *user_info_entry, const char *value)
+{
+	g_return_if_fail(user_info_entry != NULL);
+
+	g_free(user_info_entry->value);
+	user_info_entry->value = g_strdup(value);
+}
+
+GaimNotifyUserInfoEntryType
+gaim_notify_user_info_entry_get_type(GaimNotifyUserInfoEntry *user_info_entry)
+{
+	g_return_val_if_fail(user_info_entry != NULL, GAIM_NOTIFY_USER_INFO_ENTRY_PAIR);
+
+	return user_info_entry->type;
+}
+
+void
+gaim_notify_user_info_entry_set_type(GaimNotifyUserInfoEntry *user_info_entry, GaimNotifyUserInfoEntryType type)
+{
+	g_return_if_fail(user_info_entry != NULL);
+
+	user_info_entry->type = type;
+}
+
+void
+gaim_notify_user_info_add_pair(GaimNotifyUserInfo *user_info, const char *label, const char *value)
+{
+	GaimNotifyUserInfoEntry *entry;
+	
+	entry = gaim_notify_user_info_entry_new(label, value);
+	user_info->user_info_entries = g_list_append(user_info->user_info_entries, entry);
+}
+
+void
+gaim_notify_user_info_prepend_pair(GaimNotifyUserInfo *user_info, const char *label, const char *value)
+{
+	GaimNotifyUserInfoEntry *entry;
+
+	entry = gaim_notify_user_info_entry_new(label, value);
+	user_info->user_info_entries = g_list_prepend(user_info->user_info_entries, entry);
+}
+
+void
+gaim_notify_user_info_remove_entry(GaimNotifyUserInfo *user_info, GaimNotifyUserInfoEntry *entry)
+{
+	g_return_if_fail(user_info != NULL);
+	g_return_if_fail(entry != NULL);
+
+	user_info->user_info_entries = g_list_remove(user_info->user_info_entries, entry);
+}
+
+void
+gaim_notify_user_info_add_section_header(GaimNotifyUserInfo *user_info, const char *label)
+{
+	GaimNotifyUserInfoEntry *entry;
+	
+	entry = gaim_notify_user_info_entry_new(label, NULL);
+	entry->type = GAIM_NOTIFY_USER_INFO_ENTRY_SECTION_HEADER;
+
+	user_info->user_info_entries = g_list_append(user_info->user_info_entries, entry);
+}
+
+void
+gaim_notify_user_info_add_section_break(GaimNotifyUserInfo *user_info)
+{
+	GaimNotifyUserInfoEntry *entry;
+	
+	entry = gaim_notify_user_info_entry_new(NULL, NULL);
+	entry->type = GAIM_NOTIFY_USER_INFO_ENTRY_SECTION_BREAK;
+
+	user_info->user_info_entries = g_list_append(user_info->user_info_entries, entry);
+}
+
+void
+gaim_notify_user_info_remove_last_item(GaimNotifyUserInfo *user_info)
+{
+	user_info->user_info_entries = g_list_remove(user_info->user_info_entries,
+												 g_list_last(user_info->user_info_entries)->data);
+}
+
+void *
+gaim_notify_uri(void *handle, const char *uri)
+{
+	GaimNotifyUiOps *ops;
+
+	g_return_val_if_fail(uri != NULL, NULL);
+
+	ops = gaim_notify_get_ui_ops();
+
+	if (ops != NULL && ops->notify_uri != NULL) {
+		GaimNotifyInfo *info;
+
+		info            = g_new0(GaimNotifyInfo, 1);
+		info->type      = GAIM_NOTIFY_URI;
+		info->handle    = handle;
+		info->ui_handle = ops->notify_uri(uri);
+
+		if (info->ui_handle != NULL) {
+			handles = g_list_append(handles, info);
+
+			return info->ui_handle;
+
+		} else {
+			g_free(info);
+
+			return NULL;
+		}
+	}
+
+	return NULL;
+}
+
+void
+gaim_notify_close(GaimNotifyType type, void *ui_handle)
+{
+	GList *l;
+	GaimNotifyUiOps *ops;
+
+	g_return_if_fail(ui_handle != NULL);
+
+	ops = gaim_notify_get_ui_ops();
+
+	for (l = handles; l != NULL; l = l->next) {
+		GaimNotifyInfo *info = l->data;
+
+		if (info->ui_handle == ui_handle) {
+			handles = g_list_remove(handles, info);
+
+			if (ops != NULL && ops->close_notify != NULL)
+				ops->close_notify(info->type, ui_handle);
+
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+
+			break;
+		}
+	}
+}
+
+void
+gaim_notify_close_with_handle(void *handle)
+{
+	GList *l, *l_next;
+	GaimNotifyUiOps *ops;
+
+	g_return_if_fail(handle != NULL);
+
+	ops = gaim_notify_get_ui_ops();
+
+	for (l = handles; l != NULL; l = l_next) {
+		GaimNotifyInfo *info = l->data;
+
+		l_next = l->next;
+
+		if (info->handle == handle) {
+			handles = g_list_remove(handles, info);
+
+			if (ops != NULL && ops->close_notify != NULL)
+				ops->close_notify(info->type, info->ui_handle);
+
+			if (info->cb != NULL)
+				info->cb(info->cb_user_data);
+
+			g_free(info);
+		}
+	}
+}
+
+void
+gaim_notify_set_ui_ops(GaimNotifyUiOps *ops)
+{
+	notify_ui_ops = ops;
+}
+
+GaimNotifyUiOps *
+gaim_notify_get_ui_ops(void)
+{
+	return notify_ui_ops;
+}
+
+void *
+gaim_notify_get_handle(void)
+{
+	static int handle;
+
+	return &handle;
+}
+
+void
+gaim_notify_init(void)
+{
+	gpointer handle = gaim_notify_get_handle();
+
+	gaim_signal_register(handle, "displaying-userinfo",
+						 gaim_marshal_VOID__POINTER_POINTER_POINTER, NULL, 3,
+						 gaim_value_new(GAIM_TYPE_SUBTYPE,
+										GAIM_SUBTYPE_ACCOUNT),
+						 gaim_value_new(GAIM_TYPE_STRING),
+						 gaim_value_new(GAIM_TYPE_SUBTYPE,
+										GAIM_SUBTYPE_USERINFO));
+}
+
+void
+gaim_notify_uninit(void)
+{
+	gaim_signals_unregister_by_instance(gaim_notify_get_handle());
+}