/** Tests whether there is a offline message received and whether is the one we have send */
public void testReceiveOfflineMessages() {
String messageText = fixture.offlineMsgCollector.getMessageText();
Message receiveMessage = fixture.offlineMsgCollector.getReceivedMessage();
assertNotNull("No Offline messages have been received", receiveMessage);
assertEquals("message body", messageText, receiveMessage.getContent());
}
/**
* Shows a warning message to the user when message delivery has failed.
*
* @param evt the event containing details on the message delivery failure
*/
public void messageDeliveryFailed(MessageDeliveryFailedEvent evt) {
logger.error(evt.getReason());
String errorMsg = null;
Message sourceMessage = (Message) evt.getSource();
Contact sourceContact = evt.getDestinationContact();
MetaContact metaContact =
GuiActivator.getContactListService().findMetaContactByContact(sourceContact);
if (evt.getErrorCode() == MessageDeliveryFailedEvent.OFFLINE_MESSAGES_NOT_SUPPORTED) {
errorMsg =
GuiActivator.getResources()
.getI18NString(
"service.gui.MSG_DELIVERY_NOT_SUPPORTED",
new String[] {sourceContact.getDisplayName()});
} else if (evt.getErrorCode() == MessageDeliveryFailedEvent.NETWORK_FAILURE) {
errorMsg = GuiActivator.getResources().getI18NString("service.gui.MSG_NOT_DELIVERED");
} else if (evt.getErrorCode() == MessageDeliveryFailedEvent.PROVIDER_NOT_REGISTERED) {
errorMsg =
GuiActivator.getResources().getI18NString("service.gui.MSG_SEND_CONNECTION_PROBLEM");
} else if (evt.getErrorCode() == MessageDeliveryFailedEvent.INTERNAL_ERROR) {
errorMsg =
GuiActivator.getResources().getI18NString("service.gui.MSG_DELIVERY_INTERNAL_ERROR");
} else {
errorMsg = GuiActivator.getResources().getI18NString("service.gui.MSG_DELIVERY_ERROR");
}
String reason = evt.getReason();
if (reason != null)
errorMsg +=
" "
+ GuiActivator.getResources()
.getI18NString("service.gui.ERROR_WAS", new String[] {reason});
ChatPanel chatPanel = chatWindowManager.getContactChat(metaContact, sourceContact);
chatPanel.addMessage(
sourceContact.getAddress(),
metaContact.getDisplayName(),
new Date(),
Chat.OUTGOING_MESSAGE,
sourceMessage.getContent(),
sourceMessage.getContentType(),
sourceMessage.getMessageUID(),
evt.getCorrectedMessageUID());
chatPanel.addErrorMessage(metaContact.getDisplayName(), errorMsg);
chatWindowManager.openChat(chatPanel, false);
}
/**
* Send an instant message from the tester agent and assert reception by the tested implementation
*/
public void thenTestSendMessage() {
String body =
"This is an IM coming from the tested implementation" + " on " + new Date().toString();
// create the message
net.java.sip.communicator.service.protocol.Message msg = opSetBasicIM.createMessage(body);
// register a listener in the op set
ImEventCollector imEvtCollector = new ImEventCollector();
opSetBasicIM.addMessageListener(imEvtCollector);
// register a listener in the tester agent
JoustSimMessageEventCollector jsEvtCollector = new JoustSimMessageEventCollector();
fixture.testerAgent.addConversationListener(fixture.ourUserID, jsEvtCollector);
Contact testerAgentContact = opSetPresence.findContactByID(fixture.testerAgent.getIcqUIN());
opSetBasicIM.sendInstantMessage(testerAgentContact, msg);
imEvtCollector.waitForEvent(10000);
jsEvtCollector.waitForEvent(10000);
fixture.testerAgent.removeConversationListener(fixture.ourUserID, jsEvtCollector);
opSetBasicIM.removeMessageListener(imEvtCollector);
// verify that the message delivered event was dispatched
assertTrue(
"No events delivered when sending a message", imEvtCollector.collectedEvents.size() > 0);
assertTrue(
"Received evt was not an instance of " + MessageDeliveredEvent.class.getName(),
imEvtCollector.collectedEvents.get(0) instanceof MessageDeliveredEvent);
MessageDeliveredEvent evt = (MessageDeliveredEvent) imEvtCollector.collectedEvents.get(0);
assertEquals(
"message destination ",
evt.getDestinationContact().getAddress(),
fixture.testerAgent.getIcqUIN());
assertSame("source message", msg, evt.getSourceMessage());
// verify that the message has successfully arived at the destination
assertTrue(
"No messages received by the tester agent", jsEvtCollector.collectedMessageInfo.size() > 0);
String receivedBody =
((MessageInfo) jsEvtCollector.collectedMessageInfo.get(0)).getMessage().getMessageBody();
assertEquals("received message body", msg.getContent(), receivedBody);
}
/** Creates an Message through the advance createMessage() method and inspects its parameters. */
public void testCreateMessage2() {
String body =
"This is an IM coming from the tested implementation" + " on " + new Date().toString();
String contentType = "text/html";
String encoding = "UTF-16";
String subject = "test message";
net.java.sip.communicator.service.protocol.Message msg =
opSetBasicIM.createMessage(body.getBytes(), contentType, encoding, subject);
assertEquals("message body", body, msg.getContent());
assertTrue("message body bytes", Arrays.equals(body.getBytes(), msg.getRawData()));
assertEquals("message length", body.length(), msg.getSize());
assertEquals("message content type", contentType, msg.getContentType());
assertEquals("message encoding", encoding, msg.getEncoding());
assertNotNull("message uid", msg.getMessageUID());
// a further test on message uid.
net.java.sip.communicator.service.protocol.Message msg2 = opSetBasicIM.createMessage(body);
assertFalse("message uid", msg.getMessageUID().equals(msg2.getMessageUID()));
}
/**
* When a sent message is delivered shows it in the chat conversation panel.
*
* @param evt the event containing details on the message delivery
*/
public void messageDelivered(MessageDeliveredEvent evt) {
Contact contact = evt.getDestinationContact();
MetaContact metaContact =
GuiActivator.getContactListService().findMetaContactByContact(contact);
if (logger.isTraceEnabled())
logger.trace("MESSAGE DELIVERED to contact: " + contact.getAddress());
ChatPanel chatPanel = chatWindowManager.getContactChat(metaContact, false);
if (chatPanel != null) {
Message msg = evt.getSourceMessage();
ProtocolProviderService protocolProvider = contact.getProtocolProvider();
if (logger.isTraceEnabled())
logger.trace(
"MESSAGE DELIVERED: process message to chat for contact: "
+ contact.getAddress()
+ " MESSAGE: "
+ msg.getContent());
chatPanel.addMessage(
this.mainFrame.getAccountAddress(protocolProvider),
this.mainFrame.getAccountDisplayName(protocolProvider),
evt.getTimestamp(),
Chat.OUTGOING_MESSAGE,
msg.getContent(),
msg.getContentType(),
msg.getMessageUID(),
evt.getCorrectedMessageUID());
if (evt.isSmsMessage() && !ConfigurationUtils.isSmsNotifyTextDisabled()) {
chatPanel.addMessage(
contact.getDisplayName(),
new Date(),
Chat.ACTION_MESSAGE,
GuiActivator.getResources().getI18NString("service.gui.SMS_SUCCESSFULLY_SENT"),
"text");
}
}
}
/**
* Sends the <tt>message</tt> to the destination indicated by the <tt>to</tt> contact.
*
* @param to the <tt>Contact</tt> to send <tt>message</tt> to
* @param message the <tt>Message</tt> to send.
* @throws IllegalStateException if the underlying ICQ stack is not registered and initialized.
* @throws IllegalArgumentException if <tt>to</tt> is not an instance belonging to the underlying
* implementation.
*/
public void sendInstantMessage(Contact to, Message message)
throws IllegalStateException, IllegalArgumentException {
if (!(to instanceof ContactDictImpl)) {
throw new IllegalArgumentException("The specified contact is not a Dict contact." + to);
}
// Remove all html tags from the message
message = createMessage(Html2Text.extractText(message.getContent()));
// Display the queried word
fireMessageDelivered(message, to);
this.submitDictQuery((ContactDictImpl) to, message);
}
/** Creates an Message through the simple createMessage() method and inspects its parameters. */
public void testCreateMessage1() {
String body =
"This is an IM coming from the tested implementation" + " on " + new Date().toString();
net.java.sip.communicator.service.protocol.Message msg = opSetBasicIM1.createMessage(body);
assertEquals("message body", body, msg.getContent());
assertTrue("message body bytes", Arrays.equals(body.getBytes(), msg.getRawData()));
assertEquals("message length", body.length(), msg.getSize());
assertEquals(
"message content type",
OperationSetBasicInstantMessaging.DEFAULT_MIME_TYPE,
msg.getContentType());
assertEquals(
"message encoding",
OperationSetBasicInstantMessaging.DEFAULT_MIME_ENCODING,
msg.getEncoding());
assertNotNull("message uid", msg.getMessageUID());
// a further test on message uid.
net.java.sip.communicator.service.protocol.Message msg2 = opSetBasicIM1.createMessage(body);
assertFalse("message uid", msg.getMessageUID().equals(msg2.getMessageUID()));
}
/**
* Create, execute and display a query to a dictionary (ContactDictImpl)
*
* @param dictContact the contact containing the database name
* @param message the message containing the word
*/
private void submitDictQuery(ContactDictImpl dictContact, Message message) {
Message msg = this.createMessage("");
String database = dictContact.getContactID();
DictConnection conn = this.parentProvider.getConnection();
boolean doMatch = false;
String word;
// Formatting the query message, if the word as one or more spaces we
// put it between quotes to prevent errors
word = message.getContent().replace("\"", "").trim();
if (word.indexOf(' ') > 0) {
word = "\"" + word + "\"";
}
// Try to get the definition of the work
try {
List<Definition> definitions = conn.define(database, word);
msg = this.createMessage(retrieveDefine(definitions, word));
} catch (DictException dx) {
if (dx.getErrorCode()
== DictReturnCode.NO_MATCH) { // No word found, we are going to try the match command
doMatch = true;
} else { // Otherwise we display the error returned by the server
msg = this.createMessage(manageException(dx, database));
}
}
if (doMatch) {
// Trying the match command
try {
List<MatchWord> matchWords = conn.match(database, word, this.accountID.getStrategy());
msg = this.createMessage(retrieveMatch(matchWords, word));
} catch (DictException dx) {
msg = this.createMessage(manageException(dx, database));
}
}
// Send message
fireMessageReceived(msg, dictContact);
}
/**
* Helper function used to send a message to a contact, with the given extensions attached.
*
* @param to The contact to send the message to.
* @param toResource The resource to send the message to or null if no resource has been specified
* @param message The message to send.
* @param extensions The XMPP extensions that should be attached to the message before sending.
* @return The MessageDeliveryEvent that resulted after attempting to send this message, so the
* calling function can modify it if needed.
*/
private MessageDeliveredEvent sendMessage(
Contact to, ContactResource toResource, Message message, PacketExtension[] extensions) {
if (!(to instanceof ContactJabberImpl))
throw new IllegalArgumentException("The specified contact is not a Jabber contact." + to);
assertConnected();
org.jivesoftware.smack.packet.Message msg = new org.jivesoftware.smack.packet.Message();
String toJID = null;
if (toResource != null) {
if (toResource.equals(ContactResource.BASE_RESOURCE)) {
toJID = to.getAddress();
} else toJID = ((ContactResourceJabberImpl) toResource).getFullJid();
}
if (toJID == null) {
toJID = to.getAddress();
}
msg.setPacketID(message.getMessageUID());
msg.setTo(toJID);
for (PacketExtension ext : extensions) {
msg.addExtension(ext);
}
if (logger.isTraceEnabled())
logger.trace("Will send a message to:" + toJID + " chat.jid=" + toJID);
MessageDeliveredEvent msgDeliveryPendingEvt =
new MessageDeliveredEvent(message, to, toResource);
MessageDeliveredEvent[] transformedEvents =
messageDeliveryPendingTransform(msgDeliveryPendingEvt);
if (transformedEvents == null || transformedEvents.length == 0) return null;
for (MessageDeliveredEvent event : transformedEvents) {
String content = event.getSourceMessage().getContent();
if (message.getContentType().equals(HTML_MIME_TYPE)) {
msg.setBody(Html2Text.extractText(content));
// Check if the other user supports XHTML messages
// make sure we use our discovery manager as it caches calls
if (jabberProvider.isFeatureListSupported(toJID, HTML_NAMESPACE)) {
// Add the XHTML text to the message
XHTMLManager.addBody(msg, OPEN_BODY_TAG + content + CLOSE_BODY_TAG);
}
} else {
// this is plain text so keep it as it is.
msg.setBody(content);
}
// msg.addExtension(new Version());
if (event.isMessageEncrypted() && isCarbonEnabled) {
msg.addExtension(new CarbonPacketExtension.PrivateExtension());
}
MessageEventManager.addNotificationsRequests(msg, true, false, false, true);
String threadID = getThreadIDForAddress(toJID);
if (threadID == null) threadID = nextThreadID();
msg.setThread(threadID);
msg.setType(org.jivesoftware.smack.packet.Message.Type.chat);
msg.setFrom(jabberProvider.getConnection().getUser());
jabberProvider.getConnection().sendPacket(msg);
putJidForAddress(toJID, threadID);
}
return new MessageDeliveredEvent(message, to, toResource);
}
/**
* Parses the content type of a message and return the subtype
*
* @param msg the Message to scan
* @return the subtype of the message
*/
private String getSubType(Message msg) {
String subtype = msg.getContentType();
return subtype.substring(subtype.indexOf('/') + 1);
}
/**
* Parses the content type of a message and return the type
*
* @param msg the Message to scan
* @return the type of the message
*/
private String getType(Message msg) {
String type = msg.getContentType();
return type.substring(0, type.indexOf('/'));
}
/**
* Construct a <tt>Request</tt> represent a new message.
*
* @param to the <tt>Contact</tt> to send <tt>message</tt> to
* @param message the <tt>Message</tt> to send.
* @return a Message Request destined to the contact
* @throws OperationFailedException if an error occurred during the creation of the request
*/
Request createMessageRequest(Contact to, Message message) throws OperationFailedException {
Address toAddress = null;
try {
toAddress = sipProvider.parseAddressString(to.getAddress());
} catch (ParseException exc) {
// Shouldn't happen
logger.error("An unexpected error occurred while" + "constructing the address", exc);
throw new OperationFailedException(
"An unexpected error occurred while" + "constructing the address",
OperationFailedException.INTERNAL_ERROR,
exc);
}
// Call ID
CallIdHeader callIdHeader = this.sipProvider.getDefaultJainSipProvider().getNewCallId();
// CSeq
CSeqHeader cSeqHeader = null;
try {
// protect seqN
synchronized (this) {
cSeqHeader = this.sipProvider.getHeaderFactory().createCSeqHeader(seqN++, Request.MESSAGE);
}
} catch (InvalidArgumentException ex) {
// Shouldn't happen
logger.error("An unexpected error occurred while" + "constructing the CSeqHeadder", ex);
throw new OperationFailedException(
"An unexpected error occurred while" + "constructing the CSeqHeadder",
OperationFailedException.INTERNAL_ERROR,
ex);
} catch (ParseException exc) {
// shouldn't happen
logger.error("An unexpected error occurred while" + "constructing the CSeqHeadder", exc);
throw new OperationFailedException(
"An unexpected error occurred while" + "constructing the CSeqHeadder",
OperationFailedException.INTERNAL_ERROR,
exc);
}
// FromHeader and ToHeader
String localTag = SipMessageFactory.generateLocalTag();
FromHeader fromHeader = null;
ToHeader toHeader = null;
try {
// FromHeader
fromHeader =
this.sipProvider
.getHeaderFactory()
.createFromHeader(sipProvider.getOurSipAddress(toAddress), localTag);
// ToHeader
toHeader = this.sipProvider.getHeaderFactory().createToHeader(toAddress, null);
} catch (ParseException ex) {
// these two should never happen.
logger.error(
"An unexpected error occurred while" + "constructing the FromHeader or ToHeader", ex);
throw new OperationFailedException(
"An unexpected error occurred while" + "constructing the FromHeader or ToHeader",
OperationFailedException.INTERNAL_ERROR,
ex);
}
// ViaHeaders
ArrayList<ViaHeader> viaHeaders = this.sipProvider.getLocalViaHeaders(toAddress);
// MaxForwards
MaxForwardsHeader maxForwards = this.sipProvider.getMaxForwardsHeader();
// Content params
ContentTypeHeader contTypeHeader;
ContentLengthHeader contLengthHeader;
try {
contTypeHeader =
this.sipProvider
.getHeaderFactory()
.createContentTypeHeader(getType(message), getSubType(message));
if (!DEFAULT_MIME_ENCODING.equalsIgnoreCase(message.getEncoding()))
contTypeHeader.setParameter("charset", message.getEncoding());
contLengthHeader =
this.sipProvider.getHeaderFactory().createContentLengthHeader(message.getSize());
} catch (ParseException ex) {
// these two should never happen.
logger.error("An unexpected error occurred while" + "constructing the content headers", ex);
throw new OperationFailedException(
"An unexpected error occurred while" + "constructing the content headers",
OperationFailedException.INTERNAL_ERROR,
ex);
} catch (InvalidArgumentException exc) {
// these two should never happen.
logger.error(
"An unexpected error occurred while" + "constructing the content length header", exc);
throw new OperationFailedException(
"An unexpected error occurred while" + "constructing the content length header",
OperationFailedException.INTERNAL_ERROR,
exc);
}
Request req;
try {
req =
this.sipProvider
.getMessageFactory()
.createRequest(
toHeader.getAddress().getURI(),
Request.MESSAGE,
callIdHeader,
cSeqHeader,
fromHeader,
toHeader,
viaHeaders,
maxForwards,
contTypeHeader,
message.getRawData());
} catch (ParseException ex) {
// shouldn't happen
logger.error("Failed to create message Request!", ex);
throw new OperationFailedException(
"Failed to create message Request!", OperationFailedException.INTERNAL_ERROR, ex);
}
req.addHeader(contLengthHeader);
return req;
}
/**
* Send an instant message from the tester agent and assert reception by the tested implementation
*/
public void thenTestSendMessage() {
logger.debug(
"Printing Server Stored list to see if message fails are contacts in each other lists");
ContactGroup rootGroup1 =
((OperationSetPersistentPresence) opSetPresence1).getServerStoredContactListRoot();
logger.debug("=========== Server Stored Contact List 1 =================");
logger.debug(
"rootGroup="
+ rootGroup1.getGroupName()
+ " rootGroup.childContacts="
+ rootGroup1.countContacts()
+ "rootGroup.childGroups="
+ rootGroup1.countSubgroups()
+ "Printing rootGroupContents=\n"
+ rootGroup1.toString());
ContactGroup rootGroup2 =
((OperationSetPersistentPresence) opSetPresence2).getServerStoredContactListRoot();
logger.debug("=========== Server Stored Contact List 2 =================");
logger.debug(
"rootGroup="
+ rootGroup2.getGroupName()
+ " rootGroup.childContacts="
+ rootGroup2.countContacts()
+ "rootGroup.childGroups="
+ rootGroup2.countSubgroups()
+ "Printing rootGroupContents=\n"
+ rootGroup2.toString());
String body =
"This is an IM coming from the tested implementation" + " on " + new Date().toString();
// create the message
net.java.sip.communicator.service.protocol.Message msg = opSetBasicIM1.createMessage(body);
// register a listener in the op set
ImEventCollector imEvtCollector1 = new ImEventCollector();
opSetBasicIM1.addMessageListener(imEvtCollector1);
// register a listener in the tester agent
ImEventCollector imEvtCollector2 = new ImEventCollector();
opSetBasicIM2.addMessageListener(imEvtCollector2);
Contact testerAgentContact = opSetPresence1.findContactByID(fixture.userID2);
opSetBasicIM1.sendInstantMessage(testerAgentContact, msg);
imEvtCollector1.waitForEvent(10000);
imEvtCollector2.waitForEvent(10000);
opSetBasicIM1.removeMessageListener(imEvtCollector1);
opSetBasicIM2.removeMessageListener(imEvtCollector2);
// verify that the message delivered event was dispatched
assertTrue(
"No events delivered when sending a message", imEvtCollector1.collectedEvents.size() > 0);
assertTrue(
"Received evt was not an instance of " + MessageDeliveredEvent.class.getName(),
imEvtCollector1.collectedEvents.get(0) instanceof MessageDeliveredEvent);
MessageDeliveredEvent evt = (MessageDeliveredEvent) imEvtCollector1.collectedEvents.get(0);
assertEquals("message destination ", evt.getDestinationContact().getAddress(), fixture.userID2);
assertSame("source message", msg, evt.getSourceMessage());
// verify that the message has successfully arived at the destination
assertTrue(
"No messages received by the tester agent", imEvtCollector2.collectedEvents.size() > 0);
assertFalse(
"Message was unable to deliver !",
imEvtCollector2.collectedEvents.get(0) instanceof MessageDeliveryFailedEvent);
String receivedBody =
((MessageReceivedEvent) imEvtCollector2.collectedEvents.get(0))
.getSourceMessage()
.getContent();
assertEquals("received message body", msg.getContent(), receivedBody);
}
/**
* When a message is received determines whether to open a new chat window or chat window tab, or
* to indicate that a message is received from a contact which already has an open chat. When the
* chat is found checks if in mode "Auto popup enabled" and if this is the case shows the message
* in the appropriate chat panel.
*
* @param protocolContact the source contact of the event
* @param contactResource the resource from which the contact is writing
* @param metaContact the metacontact containing <tt>protocolContact</tt>
* @param message the message to deliver
* @param eventType the event type
* @param timestamp the timestamp of the event
* @param correctedMessageUID the identifier of the corrected message
* @param isPrivateMessaging if <tt>true</tt> the message is received from private messaging
* contact.
* @param privateContactRoom the chat room associated with the private messaging contact.
*/
private void messageReceived(
final Contact protocolContact,
final ContactResource contactResource,
final MetaContact metaContact,
final Message message,
final int eventType,
final Date timestamp,
final String correctedMessageUID,
final boolean isPrivateMessaging,
final ChatRoom privateContactRoom) {
if (!SwingUtilities.isEventDispatchThread()) {
SwingUtilities.invokeLater(
new Runnable() {
public void run() {
messageReceived(
protocolContact,
contactResource,
metaContact,
message,
eventType,
timestamp,
correctedMessageUID,
isPrivateMessaging,
privateContactRoom);
}
});
return;
}
// Obtain the corresponding chat panel.
final ChatPanel chatPanel =
chatWindowManager.getContactChat(
metaContact, protocolContact, contactResource, message.getMessageUID());
// Show an envelope on the sender contact in the contact list and
// in the systray.
if (!chatPanel.isChatFocused()) contactList.setActiveContact(metaContact, true);
// Distinguish the message type, depending on the type of event that
// we have received.
String messageType = null;
if (eventType == MessageReceivedEvent.CONVERSATION_MESSAGE_RECEIVED) {
messageType = Chat.INCOMING_MESSAGE;
} else if (eventType == MessageReceivedEvent.SYSTEM_MESSAGE_RECEIVED) {
messageType = Chat.SYSTEM_MESSAGE;
} else if (eventType == MessageReceivedEvent.SMS_MESSAGE_RECEIVED) {
messageType = Chat.SMS_MESSAGE;
}
String contactAddress =
(contactResource != null)
? protocolContact.getAddress() + " (" + contactResource.getResourceName() + ")"
: protocolContact.getAddress();
chatPanel.addMessage(
contactAddress,
protocolContact.getDisplayName(),
timestamp,
messageType,
message.getContent(),
message.getContentType(),
message.getMessageUID(),
correctedMessageUID);
String resourceName = (contactResource != null) ? contactResource.getResourceName() : null;
if (isPrivateMessaging) {
chatWindowManager.openPrivateChatForChatRoomMember(privateContactRoom, protocolContact);
} else {
chatWindowManager.openChat(chatPanel, false);
}
ChatTransport chatTransport =
chatPanel.getChatSession().findChatTransportForDescriptor(protocolContact, resourceName);
chatPanel.setSelectedChatTransport(chatTransport, true);
}