I developed a VCard plugin for OpenFire XMPP server with the main purpose of creating/updating and retrieving users' avatars via HTTP requests. Unfortunately, the plugin does not work as expected - VCard changes are propogated into the database (ofVcard
table), but neither the user whose userpic was updated nor his buddies see the refreshed image. Here is how I create/update the VCards:
...
XMPPServer server = XMPPServer.getInstance();
VCardManager vcardManager = server.getVCardManager();
public void createOrUpdateVcard(String username, String vcard)
throws Exception {
SAXReader reader = new SAXReader();
reader.setValidation(false);
// convert String into InputStream
InputStream is = new ByteArrayInputStream(vcard.getBytes());
// read it with BufferedReader
BufferedReader br = new BufferedReader(new InputStreamReader(is));
try {
// Reading malformed XML will lead to DocumentException
Document document = reader.read(is);
Element vCardElement = document.getRootElement();
log.info("Username: " + username);
vcardManager.setVCard(username, vCardElement);
} catch (DocumentException e) {
throw new MalformedXmlException(e);
}
}
...
When I change avatars directly from the client (we are using Jitsi), the changes are not only immediately stored in the database, but all the buddies get the refreshed image. I see that VCardManager
, which I use, dispatches events internally:
VCardEventDispatcher.dispatchVCardUpdated(username, newvCard);
but they seem not to have any effect.
I cannot figure out what is the difference between the way the setVcard
method is called from the handleIQ(IQ packet)
in IQvCardHandler
and in my own code. What am I missing?
Ok, I will answer my question myself - maybe someone would find this info helpful.
It turned out to be not as simple as just storing a picture into a database. There is a message exchange, expected to happen between the involved parties. The crucial part of this exchange is that there is a presence update, sent by the client, which informs the server and consequently all his buddies about his new profile image. Please refer to XEP-0153: vCard-Based Avatars for further details. This is the piece of code, that "emulates" the presence update which will be sent to all of the user's buddies:
public void createOrUpdateVcard(String username, String vcard)
throws MalformedXmlException, UserNotFoundException, SetVcardException {
SAXReader reader = new SAXReader();
reader.setValidation(false);
InputStream is = new ByteArrayInputStream(vcard.getBytes());
try {
// Reading malformed XML will lead to DocumentException
Document document = reader.read(is);
Element vCardElement = document.getRootElement();
//Checking that the user exists
User user = userManager.getUser(username);
//This might be redundant
String userUsername = user.getUsername();
log.debug("Setting VCard for " + userUsername);
//Storing vCard into the database
VCardManager.getInstance().setVCard(userUsername, vCardElement);
Presence presence = new Presence();
JID userJID = server.createJID(username, null);
presence.setFrom(userJID);
presence.setStatus("");
presence.setPriority(30);
Element xElement = presence.addChildElement("x", "vcard-temp:x:update");
Element photoElement = xElement.addElement("photo");
SecureRandom random = new SecureRandom();
//We do not care about the actual hash - just push updates every time
String fakeHash = new BigInteger(130, random).toString(32);
photoElement.setText(fakeHash);
Element cElement = presence.addChildElement("c", "http://jabber.org/protocol/caps");
cElement.addAttribute( "ext", "voice-v1 video-v1 camera-v1" )
.addAttribute("hash", "sha-1");
System.out.println("SENDING PRESENCE UPDATE:\n" + presence.toXML());
broadcastUpdate(presence);
} catch (DocumentException e) {
throw new MalformedXmlException(e);
}catch (UserNotFoundException e){
throw new UserNotFoundException();
} catch (Exception e){
//Unfortunately setVCard method above just throws Exception.
//This catch block is for wrapping it up
throw new SetVcardException();
}
}
This is a slightly adjusted method from the PresenceUpdateHandler class:
private void broadcastUpdate(Presence update) {
if (update.getFrom() == null) {
return;
}
if (localServer.isLocal(update.getFrom())) {
// Do nothing if roster service is disabled
if (!RosterManager.isRosterServiceEnabled()) {
return;
}
// Local updates can simply run through the roster of the local user
String name = update.getFrom().getNode();
try {
if (name != null && !"".equals(name)) {
Roster roster = rosterManager.getRoster(name);
roster.broadcastPresence(update);
}
}
catch (UserNotFoundException e) {
log.warn("Presence being sent from unknown user " + name, e);
}
catch (PacketException e) {
log.error(LocaleUtils.getLocalizedString("admin.error"), e);
}
}
else {
// Foreign updates will do a reverse lookup of entries in rosters
// on the server
log.warn("Presence requested from server "
+ localServer.getServerInfo().getXMPPDomain()
+ " by unknown user: " + update.getFrom());
}
}
For debugging OpenFire issues I would strongly recommend running it locally in debug mode - see instructions here: 2. Be aware, that newer eclipse releases do not have Create project from existing source, but you have to click on New -> Java Project, untick the Use default location check box and Browse to the project location.