Implement custom emoticons on XMPP using XEP 0231

[malu]

This ticket is about adding support for sending and receiving custom emoticons on XMPP using XEP 0231 ("Data Element") and the use-cases 3.1 (messaging) and 3.2 (data retreival) define therein, using the libpurple smiley API as implemented by salinas_v and msfbrasil.

I have starting on a patch implementing this on branch im.pidgin.pidgin.custom_smiley.

The XEP also specifies other use-cases (for example for providing an image thumbnail in a file transfer request), but these will not be covered in this ticket...

[salinasv]

suscribe

[malu]

Implements custom emoticons for XMPP

[malu]

Here is a first patch against im.pidgin.pidgin.custom_smiley implementing custom emoticons using XEP 0231. It works quite nice for me. I haven't tried it much with MUCs. There also seems to be an issue when sending messages to offline buddies, where sometimes the message is silently dropped (but not always) when containing an emoticon. This may be because of a size limitation.

[sadrul]

Actually, I think deryni would be the better person to look at this. I am not very familiar with our jabber code.

[malu]

Fixed freeing emoticons when closing a MUC

[malu]

I just realized "jabber_convo_closed" isn't called when closing a MUC. So, here is an updated patch that calls "jabber_data_delete_associated_with_conv" for the PurpleConversation? belonging to a JabberChat? in "jabber_chat_part".

[malu]

Fixed memory leak in data.c

[malu]

Set flag PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY on PurpleConnection? for XMPP

[malu]

The last patch sets the new PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY flag on the PurpleConnection? when logging in on an XMPP connection. This allows custom emoticons to be selected on XMPP.

[phannent]

Hello,

I just patched this to the next.minor branch and compiled on windows. Due to Glib being version 2.0 rather than 2.8, I had to change line 62 to this:

	char hostname[256];
	int ret;

	ret = gethostname(hostname, sizeof(hostname));
	hostname[sizeof(hostname) - 1] = '\0';
	if (ret < 0 || hostname[0] == '\0') {
		purple_debug_warning("irc", "gethostname() failed -- is your hostname set?");
		strcpy(hostname, "localhost");
	}
	
	/* is there some better way to generate a content ID? */
	g_snprintf(cid, sizeof(cid), "%s@%s", checksum, hostname);

plus it failed to receive at the other end (see that screenshot I am going to attach).

If anybody wants to try it on windows its here: http://www.hannent.eu/pidgin/20080513/xmpp/pidgin-2.5.0devel.exe

[phannent]

Screenshot of failed receiving of the custom emoticon, see an empty line

[malu]

Replying to phannent:

Hello, I just patched this to the next.minor branch and compiled on windows. Due to Glib being version 2.0 rather than 2.8, I had to change line 62 to this: {{{ char hostname[256]; int ret; ret = gethostname(hostname, sizeof(hostname)); hostname[sizeof(hostname) - 1] = '\0';

if (ret < 0 hostname[0] == '\0') { purple_debug_warning("irc", "gethostname() failed -- is your hostname set?"); strcpy(hostname, "localhost"); } /* is there some better way to generate a content ID? */ g_snprintf(cid, sizeof(cid), "%s@%s", checksum, hostname); }}} plus it failed to receive at the other end (see that screenshot I am going to attach). If anybody wants to try it on windows its here: http://www.hannent.eu/pidgin/20080513/xmpp/pidgin-2.5.0devel.exe

I will take a look at your patch and integrate it with my patch. Maybe a gethostname function should be in libpurple?

Does the empty line happen when both ends have the patch? The current Pidgin doesn't handle <img> tags in XHTML-IM. The smileys get translated to such tags when sending the message. They are "unpacked" by the receiver (and the text is "smileyfied" using the functions available in libpurple. (if custom smileys have been turned off the tag will just be converted to the corresponding shortcut text (the "alt" attribute).

[phannent]

You were right with both sides needing the patch.

[phannent]

For a test windows build: http://hannent.blogspot.com/2008/05/jabber-custom-emoticons.html

[phannent]

Updated for Win32 compile

[ferk]

wow.. this is really great, thank you so much! is there any built .deb already for test?

[ferk]

Oh.. sorry.. echelon89 already did it.. thank you! here it is echelon89 page: [ http://echelon89.altervista.org/download/patchato/view-category.html?dir=DESC&limit=5&limitstart=0&order=date click]

[sadrul]

mlundblad: I believe it's important that if the client doesn't support custom smileys (e.g. an unpatched pidgin) then it will display the text for the received custom smiley, instead of completely removing it (which appears to be the current state, judging from the screenshot).

[malu]

Replying to sadrul:

mlundblad: I believe it's important that if the client doesn't support custom smileys (e.g. an unpatched pidgin) then it will display the text for the received custom smiley, instead of completely removing it (which appears to be the current state, judging from the screenshot).

Unfortunatly the current (unpatched) GtkIMHtml ignores <img> tags. So I haven't come up with a good way to let old clients to display just the shortcut. The best would have been if there was a defined capability that the client was supposed to present in case it supports images with embedded data. The plain-text body element of the message stanza on the other hand contains just the text of the smileys, so clients not knowing XHTML-IM extension will display the raw text.

[malu]

Replying to sadrul:

mlundblad: I believe it's important that if the client doesn't support custom smileys (e.g. an unpatched pidgin) then it will display the text for the received custom smiley, instead of completely removing it (which appears to be the current state, judging from the screenshot).

Now we have a service discovery for the messageing use case of XEP-0231. So it shall be able to just insert the text for a smiley if the other client doesn't advertize support. I've starting working on a new patch adding that functionallity.

[malu]

Added support for service discovery of "in-band images".

[malu]

The latest patch adds checking for the capability of receiving smileys "in-band images" using the updated XEP-0231. Currently it doesn't attempt to determine support when in an MUC, so smileys will be sent as plain text there.

[ml@…]

(In [144341017ede7e3be12c467ddec33984a0868928]):
Custom smileys for XMPP according to XEP 0231. Refs #5627.

[phannent]

Fix for building on Windows

[phannent]

Hello,

I recompiled the new im.pidgin.xmpp.custom_smiley branch with the attached fix and a windows binary can be found here: http://www.hannent.eu/pidgin/20080602/pidgin-2.5.0devel.exe

[malu]

Use destructor functions for the per-conversation-allocated hash tables (fixes freeing keys)

[malu]

This last patch uses destructor functions on "inner hash tables" used to cache smileys. Fixes a few leaks...

[malu]

Some changes in message.c to simplify fetching unique smileys from incoming messages. data.c now uses purple_conversation_get/set to store data hashtables per conversation

[malu]

I have uploaded a new patch. There is some modification in the function that parses the XHTML of incoming messages to get a list of unique smileys. Also the cacheing of JabberData? objects per conversation in jabber/data.c now uses the functions for PurpleConversation? to store data attributes to store the hash tables for local and remote data items per conversation.

[malu]

Changed one occurance of a hard-coded XML namespace in iq.c to use #define:d string

[malu]

Handle <img>...</img> and lack of "alt" attribute

[malu]

Updated patch:

This one can cope with a message where <img> tags are not self-closing, ie. <img alt=".." src="..."></img>

It also handles the case when the received <img/> doesn't have an "alt" attribute, in this case the remote shortcut of the smiley is set to the value of the content ID (cid), since the smiley API needs a shortcut.

[phannent]

mtn diff with all patches since 1st June

[phannent]

I have also built the windows binary which can be downloaded from: http://hannent.blogspot.com/2008/06/emoticon-xmpp-pidgin.html

[malu]

Added function in libpurple/util.c to return the hostname

[malu]

The last patch add a function in util.c to return the host name, it uses g_get_host_name on glib >= 2.8 and usis Phil's code if not.

[sadrul@…]

(In [ee0b2e3380c2604a456e2388ce05e8ba8913f4f8]):
Add purple_get_host_name to get the hostname of the machine. This is a replacement for g_get_host_name in glib2.8+. Thanks to Phil Hannent and Marcus Lundblad for the initial patch. References #5627.

[scytheman]

cc

[malu]

Updated to latest XEP

[malu]

The latest patch updates the implementation according to the latest specification. Received data objects are cached per CID instead of per conversation. CIDs is generated of the form "sha1+hash@…". Only data objects of size < 1024 bytes are included directly in the <message/> stanza. (data is requested using <iq/>s if not already cached by the receiver).

[malu]

Changed namespace according to change to draft

[malu]

The last patch changes the namespace of the <data/> element (and capabilities), since the XEP is now draft, and has dropped ":tmp"

[phannent]

Test compile of patch: xmpp-custom-emoticons-20080903.diff

[phannent]

Rejected from patch 20080903

[phannent]

I have attached the compile log from the 20080903 patch as it did not compile cleanly on windows.

This was against a clean im.pidgin.xmpp.custom_smiley which badly needs a propogate from i.p.p

[phannent]

Scratch my last comment, I just saw that I had propagated from i.p.p to this branch and that is what is causing the error.

[phannent]

Fix for the window compile

[phannent]

Sadrul shepherded me through the fix for the windows build. Malu could you apply the attached patch to the branch please?

[phannent]

I have build windows versions of this patch here: http://hannent.blogspot.com/2008/09/pidgin-with-xmpp-jabbergtalk-custom.html

[phannent]

The recent patches all applied fine and are working great, windows builds are here: http://hannent.blogspot.com/2008/09/custom-emoticons-working-with-jabbim.html

[phannent]

Can this be merged? I have no problems with running this and want to get on with testing IBB #6183

[malu@…]

(In [d5543e6ef5e67e9c4a1fb372c06245ab36155e4b]):
Add custom smiley support for XMPP. Closes #5627.