changeset 32162:2e8c905a5e74

Attempt to move the message style object from the plugin into the new PurpleConvTheme GObject. This is probably not yet abstracted correctly as I don't quite understand how the ThemeLoader bit fits into it all.

--- a/pidgin/gtkconv-theme.c	Sat Sep 17 06:14:59 2011 +0000
+++ b/pidgin/gtkconv-theme.c	Sat Sep 17 06:27:35 2011 +0000
@@ -22,8 +22,15 @@
 
 #include "gtkconv-theme.h"
 
+#include "debug.h"
+#include "prefs.h"
+#include "xmlnode.h"
+
 #include <gtk/gtk.h>
 
+#include <stdlib.h>
+#include <string.h>
+
 #define PIDGIN_CONV_THEME_GET_PRIVATE(Gobject) \
 	(G_TYPE_INSTANCE_GET_PRIVATE((Gobject), PIDGIN_TYPE_CONV_THEME, PidginConvThemePrivate))
 
@@ -32,8 +39,41 @@
  *****************************************************************************/
 
 typedef struct {
-	/* Boilerplate... */
-	gpointer unused;
+	/* current config options */
+	char     *variant; /* allowed to be NULL if there are no variants */
+
+	/* Info.plist keys that change with Variant */
+
+	/* Static Info.plist keys */
+	int      message_view_version;
+	char     *cf_bundle_name;
+	char     *cf_bundle_identifier;
+	char     *cf_bundle_get_info_string;
+	char     *default_font_family;
+	int      default_font_size;
+	gboolean shows_user_icons;
+	gboolean disable_combine_consecutive;
+	gboolean default_background_is_transparent;
+	gboolean disable_custom_background;
+	char     *default_background_color;
+	gboolean allow_text_colors;
+	char     *image_mask;
+	char     *default_variant;
+
+	/* paths */
+	char    *style_dir;
+	char    *template_path;
+
+	/* caches */
+	char    *template_html;
+	char    *header_html;
+	char    *footer_html;
+	char    *incoming_content_html;
+	char    *outgoing_content_html;
+	char    *incoming_next_content_html;
+	char    *outgoing_next_content_html;
+	char    *status_html;
+	char    *basestyle_css;
 } PidginConvThemePrivate;
 
 /******************************************************************************
@@ -53,8 +93,6 @@
 	PidginConvThemePrivate *priv;
 
 	priv = PIDGIN_CONV_THEME_GET_PRIVATE(instance);
-
-	priv->unused = NULL; /* Boilerplate... */
 }
 
 static void
@@ -64,6 +102,24 @@
 
 	priv = PIDGIN_CONV_THEME_GET_PRIVATE(obj);
 
+	g_free(priv->cf_bundle_name);
+	g_free(priv->cf_bundle_identifier);
+	g_free(priv->cf_bundle_get_info_string);
+	g_free(priv->default_font_family);
+	g_free(priv->default_background_color);
+	g_free(priv->image_mask);
+	g_free(priv->default_variant);
+
+	g_free(priv->style_dir);
+	g_free(priv->template_path);
+
+	g_free(priv->template_html);
+	g_free(priv->incoming_content_html);
+	g_free(priv->outgoing_content_html);
+	g_free(priv->outgoing_next_content_html);
+	g_free(priv->status_html);
+	g_free(priv->basestyle_css);
+
 	parent_class->finalize(obj);
 }
 
@@ -104,3 +160,408 @@
  * Public API functions
  *****************************************************************************/
 
+static PidginConvTheme *
+pidgin_conversation_theme_new(const char *styledir)
+{
+	PidginConvTheme *ret = g_object_new(PIDGIN_TYPE_CONV_THEME, NULL);
+	PidginConvThemePrivate *priv;
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(ret);
+	priv->style_dir = g_strdup(styledir);
+
+	return ret;
+}
+
+void
+pidgin_conversation_theme_save_state(const PidginConvTheme *theme)
+{
+	PidginConvThemePrivate *priv;
+	char *prefname;
+	char *variant;
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	prefname = g_strdup_printf("/plugins/gtk/adiumthemes/%s", priv->cf_bundle_identifier);
+	variant = g_strdup_printf("%s/variant", prefname);
+
+	purple_debug_info("webkit", "saving state with variant %s\n", priv->variant);
+	purple_prefs_add_none(prefname);
+	purple_prefs_add_string(variant, "");
+	purple_prefs_set_string(variant, priv->variant);
+
+	g_free(prefname);
+	g_free(variant);
+}
+
+static void
+pidgin_conversation_theme_load_state(PidginConvTheme *theme)
+{
+	PidginConvThemePrivate *priv;
+	char *prefname;
+	char *variant;
+	const char* value;
+	gboolean changed;
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	prefname = g_strdup_printf("/plugins/gtk/adiumthemes/%s", priv->cf_bundle_identifier);
+	variant = g_strdup_printf("%s/variant", prefname);
+
+	value = purple_prefs_get_string(variant);
+	changed = !priv->variant || !g_str_equal(priv->variant, value);
+
+	g_free(priv->variant);
+	priv->variant = g_strdup(value);
+
+	if (changed)
+		pidgin_conversation_theme_read_info_plist(theme, priv->variant);
+
+	g_free(prefname);
+	g_free(variant);
+}
+
+
+static gboolean
+parse_info_plist_key_value(xmlnode *key, gpointer destination, const char *expected)
+{
+	xmlnode *val = key->next;
+
+	for (; val && val->type != XMLNODE_TYPE_TAG; val = val->next)
+		;
+	if (!val)
+		return FALSE;
+
+	if (expected == NULL || g_str_equal(expected, "string")) {
+		char **dest = (char **)destination;
+		if (!g_str_equal(val->name, "string"))
+			return FALSE;
+		if (*dest)
+			g_free(*dest);
+		*dest = xmlnode_get_data_unescaped(val);
+	} else if (g_str_equal(expected, "integer")) {
+		int *dest = (int *)destination;
+		char *value = xmlnode_get_data_unescaped(val);
+
+		if (!g_str_equal(val->name, "integer"))
+			return FALSE;
+		*dest = atoi(value);
+		g_free(value);
+	} else if (g_str_equal(expected, "boolean")) {
+		gboolean *dest = (gboolean *)destination;
+		if (g_str_equal(val->name, "true"))
+			*dest = TRUE;
+		else if (g_str_equal(val->name, "false"))
+			*dest = FALSE;
+		else
+			return FALSE;
+	} else return FALSE;
+
+	return TRUE;
+}
+
+static gboolean
+str_for_key(const char *key, const char *found, const char *variant)
+{
+	if (g_str_equal(key, found))
+		return TRUE;
+	if (!variant)
+		return FALSE;
+	return (g_str_has_prefix(found, key)
+		&& g_str_has_suffix(found, variant)
+		&& strlen(found) == strlen(key) + strlen(variant) + 1);
+}
+
+/**
+ * Info.plist should be re-read every time the variant changes, this is because
+ * the keys that take precedence depend on the value of the current variant.
+ */
+void
+pidgin_conversation_theme_read_info_plist(PidginConvTheme *theme, const char *variant)
+{
+	PidginConvThemePrivate *priv;
+	char *contents;
+	xmlnode *plist, *iter;
+	xmlnode *dict;
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	/* note that if a variant is used the option:VARIANTNAME takes precedence */
+	contents = g_build_filename(priv->style_dir, "Contents", NULL);
+	plist = xmlnode_from_file(contents, "Info.plist", "Info.plist", "webkit");
+	dict = xmlnode_get_child(plist, "dict");
+
+	g_assert (dict);
+	for (iter = xmlnode_get_child(dict, "key"); iter; iter = xmlnode_get_next_twin(iter)) {
+		char* key = xmlnode_get_data_unescaped(iter);
+		gboolean pr = TRUE;
+
+		if (g_str_equal("MessageViewVersion", key))
+			pr = parse_info_plist_key_value(iter, &priv->message_view_version, "integer");
+		else if (g_str_equal("CFBundleName", key))
+			pr = parse_info_plist_key_value(iter, &priv->cf_bundle_name, "string");
+		else if (g_str_equal("CFBundleIdentifier", key))
+			pr = parse_info_plist_key_value(iter, &priv->cf_bundle_identifier, "string");
+		else if (g_str_equal("CFBundleGetInfoString", key))
+			pr = parse_info_plist_key_value(iter, &priv->cf_bundle_get_info_string, "string");
+		else if (str_for_key("DefaultFontFamily", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->default_font_family, "string");
+		else if (str_for_key("DefaultFontSize", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->default_font_size, "integer");
+		else if (str_for_key("ShowsUserIcons", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->shows_user_icons, "boolean");
+		else if (str_for_key("DisableCombineConsecutive", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->disable_combine_consecutive, "boolean");
+		else if (str_for_key("DefaultBackgroundIsTransparent", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->default_background_is_transparent, "boolean");
+		else if (str_for_key("DisableCustomBackground", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->disable_custom_background, "boolean");
+		else if (str_for_key("DefaultBackgroundColor", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->default_background_color, "string");
+		else if (str_for_key("AllowTextColors", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->allow_text_colors, "integer");
+		else if (str_for_key("ImageMask", key, variant))
+			pr = parse_info_plist_key_value(iter, &priv->image_mask, "string");
+
+		if (!pr)
+			purple_debug_warning("webkit", "Failed to parse key %s\n", key);
+		g_free(key);
+	}
+
+	xmlnode_free(plist);
+}
+
+PidginConvTheme *
+pidgin_conversation_theme_load(const char *styledir)
+{
+	/*
+	 * the loading process described:
+	 *
+	 * First we load all the style .html files, etc.
+	 * The we load any config options that have been stored for
+	 * this variant.
+	 * Then we load the Info.plist, for the currently decided variant.
+	 * At this point, if we find that variants exist, yet
+	 * we don't have a variant selected, we choose DefaultVariant
+	 * and if that does not exist, we choose the first one in the
+	 * directory.
+	 */
+	char *file;
+	PidginConvTheme *theme = NULL;
+	PidginConvThemePrivate *priv;
+
+	theme = pidgin_conversation_theme_new(styledir);
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	/* load all other files */
+
+	/* The template path can either come from the theme, or can
+	 * be stock Template.html that comes with the plugin */
+	priv->template_path = g_build_filename(styledir, "Contents", "Resources", "Template.html", NULL);
+
+	if (!g_file_test(priv->template_path, G_FILE_TEST_EXISTS)) {
+		g_free(priv->template_path);
+		priv->template_path = g_build_filename(DATADIR, "pidgin", "webkit", "Template.html", NULL);
+	}
+
+	if (!g_file_get_contents(priv->template_path, &priv->template_html, NULL, NULL)) {
+		purple_debug_error("webkit", "Could not locate a Template.html (%s)\n", priv->template_path);
+		g_object_unref(G_OBJECT(theme));
+		return NULL;
+	}
+
+	file = g_build_filename(styledir, "Contents", "Resources", "Status.html", NULL);
+	if (!g_file_get_contents(file, &priv->status_html, NULL, NULL)) {
+		purple_debug_info("webkit", "%s could not find Resources/Status.html", styledir);
+		g_object_unref(G_OBJECT(theme));
+		g_free(file);
+		return NULL;
+	}
+	g_free(file);
+
+	file = g_build_filename(styledir, "Contents", "Resources", "main.css", NULL);
+	if (!g_file_get_contents(file, &priv->basestyle_css, NULL, NULL))
+		priv->basestyle_css = g_strdup("");
+	g_free(file);
+
+	file = g_build_filename(styledir, "Contents", "Resources", "Header.html", NULL);
+	if (!g_file_get_contents(file, &priv->header_html, NULL, NULL))
+		priv->header_html = g_strdup("");
+	g_free(file);
+
+	file = g_build_filename(styledir, "Contents", "Resources", "Footer.html", NULL);
+	if (!g_file_get_contents(file, &priv->footer_html, NULL, NULL))
+		priv->footer_html = g_strdup("");
+	g_free(file);
+
+	file = g_build_filename(styledir, "Contents", "Resources", "Incoming", "Content.html", NULL);
+	if (!g_file_get_contents(file, &priv->incoming_content_html, NULL, NULL)) {
+		purple_debug_info("webkit", "%s did not have a Incoming/Content.html\n", styledir);
+		g_object_unref(G_OBJECT(theme));
+		g_free(file);
+		return NULL;
+	}
+	g_free(file);
+
+
+	/* according to the spec, the following are optional files */
+	file = g_build_filename(styledir, "Contents", "Resources", "Incoming", "NextContent.html", NULL);
+	if (!g_file_get_contents(file, &priv->incoming_next_content_html, NULL, NULL)) {
+		priv->incoming_next_content_html = g_strdup(priv->incoming_content_html);
+	}
+	g_free(file);
+
+	file = g_build_filename(styledir, "Contents", "Resources", "Outgoing", "Content.html", NULL);
+	if (!g_file_get_contents(file, &priv->outgoing_content_html, NULL, NULL)) {
+		priv->outgoing_content_html = g_strdup(priv->incoming_content_html);
+	}
+	g_free(file);
+
+	file = g_build_filename(styledir, "Contents", "Resources", "Outgoing", "NextContent.html", NULL);
+	if (!g_file_get_contents(file, &priv->outgoing_next_content_html, NULL, NULL)) {
+		priv->outgoing_next_content_html = g_strdup(priv->outgoing_content_html);
+	}
+
+	pidgin_conversation_theme_read_info_plist(theme, NULL);
+	pidgin_conversation_theme_load_state(theme);
+
+	/* non variant dependent Info.plist checks */
+	if (priv->message_view_version < 3) {
+		purple_debug_info("webkit", "%s is a legacy style (version %d) and will not be loaded\n", priv->cf_bundle_name, priv->message_view_version);
+		g_object_unref(G_OBJECT(theme));
+		return NULL;
+	}
+
+	if (!priv->variant)
+	{
+		GList *variants = pidgin_conversation_theme_get_variants(theme);
+
+		if (variants)
+			pidgin_conversation_theme_set_variant(theme, variants->data);
+
+		for (; variants; variants = g_list_delete_link(variants, variants))
+			g_free(variants->data);
+	}
+
+	return theme;
+}
+
+PidginConvTheme *
+pidgin_conversation_theme_copy(const PidginConvTheme *theme)
+{
+	PidginConvTheme *ret;
+	PidginConvThemePrivate *old, *new;
+
+	old = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+	ret = pidgin_conversation_theme_new(old->style_dir);
+	new = PIDGIN_CONV_THEME_GET_PRIVATE(ret);
+
+	new->variant = g_strdup(old->variant);
+	new->message_view_version = old->message_view_version;
+	new->cf_bundle_name = g_strdup(old->cf_bundle_name);
+	new->cf_bundle_identifier = g_strdup(old->cf_bundle_identifier);
+	new->cf_bundle_get_info_string = g_strdup(old->cf_bundle_get_info_string);
+	new->default_font_family = g_strdup(old->default_font_family);
+	new->default_font_size = old->default_font_size;
+	new->shows_user_icons = old->shows_user_icons;
+	new->disable_combine_consecutive = old->disable_combine_consecutive;
+	new->default_background_is_transparent = old->default_background_is_transparent;
+	new->disable_custom_background = old->disable_custom_background;
+	new->default_background_color = g_strdup(old->default_background_color);
+	new->allow_text_colors = old->allow_text_colors;
+	new->image_mask = g_strdup(old->image_mask);
+	new->default_variant = g_strdup(old->default_variant);
+
+	new->template_path = g_strdup(old->template_path);
+	new->template_html = g_strdup(old->template_html);
+	new->header_html = g_strdup(old->header_html);
+	new->footer_html = g_strdup(old->footer_html);
+	new->incoming_content_html = g_strdup(old->incoming_content_html);
+	new->outgoing_content_html = g_strdup(old->outgoing_content_html);
+	new->incoming_next_content_html = g_strdup(old->incoming_next_content_html);
+	new->outgoing_next_content_html = g_strdup(old->outgoing_next_content_html);
+	new->status_html = g_strdup(old->status_html);
+	new->basestyle_css = g_strdup(old->basestyle_css);
+
+	return ret;
+}
+
+void
+pidgin_conversation_theme_set_variant(PidginConvTheme *theme, const char *variant)
+{
+	PidginConvThemePrivate *priv;
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	/* I'm not going to test whether this variant is valid! */
+	g_free(priv->variant);
+	priv->variant = g_strdup(variant);
+
+	pidgin_conversation_theme_read_info_plist(theme, variant);
+
+	/* todo, the style has "changed". Ideally, I would like to use signals at this point. */
+}
+
+char *
+pidgin_conversation_theme_get_variant(PidginConvTheme *theme)
+{
+	PidginConvThemePrivate *priv;
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	return g_strdup(priv->variant);
+}
+
+/**
+ * Get a list of variants supported by the style.
+ */
+GList *
+pidgin_conversation_theme_get_variants(PidginConvTheme *theme)
+{
+	PidginConvThemePrivate *priv;
+	GList *ret = NULL;
+	GDir *variants;
+	const char *css_file;
+	char *css;
+	char *variant_dir;
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	g_assert(priv->style_dir);
+	variant_dir = g_build_filename(priv->style_dir, "Contents", "Resources", "Variants", NULL);
+
+	variants = g_dir_open(variant_dir, 0, NULL);
+	if (!variants)
+		return NULL;
+
+	while ((css_file = g_dir_read_name(variants)) != NULL) {
+		if (!g_str_has_suffix(css_file, ".css"))
+			continue;
+
+		css = g_strndup(css_file, strlen(css_file) - 4);
+		ret = g_list_append(ret, css);
+	}
+
+	g_dir_close(variants);
+	g_free(variant_dir);
+
+	ret = g_list_sort(ret, (GCompareFunc)g_strcmp0);
+	return ret;
+}
+
+char *
+pidgin_conversation_theme_get_css(PidginConvTheme *theme)
+{
+	PidginConvThemePrivate *priv;
+
+	priv = PIDGIN_CONV_THEME_GET_PRIVATE(theme);
+
+	if (!priv->variant) {
+		return g_build_filename(priv->style_dir, "Contents", "Resources", "main.css", NULL);
+	} else {
+		char *file = g_strdup_printf("%s.css", priv->variant);
+		char *ret = g_build_filename(priv->style_dir, "Contents", "Resources", "Variants",  file, NULL);
+		g_free(file);
+		return ret;
+	}
+}
+

--- a/pidgin/gtkconv-theme.h	Sat Sep 17 06:14:59 2011 +0000
+++ b/pidgin/gtkconv-theme.h	Sat Sep 17 06:27:35 2011 +0000
@@ -68,6 +68,16 @@
  */
 GType pidgin_conversation_theme_get_type(void);
 
+PidginConvTheme *pidgin_conversation_theme_load(const char *styledir);
+PidginConvTheme *pidgin_conversation_theme_copy(const PidginConvTheme *theme);
+void pidgin_conversation_theme_save_state(const PidginConvTheme *theme);
+void pidgin_conversation_theme_read_info_plist(PidginConvTheme *theme, const char *variant);
+char *pidgin_conversation_theme_get_variant(PidginConvTheme *theme);
+GList *pidgin_conversation_theme_get_variants(PidginConvTheme *theme);
+void pidgin_conversation_theme_set_variant(PidginConvTheme *theme, const char *variant);
+
+char *pidgin_conversation_theme_get_css(PidginConvTheme *theme);
+
 G_END_DECLS
 #endif /* PIDGIN_CONV_THEME_H */