1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
|
/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.impl.protocol.icq;
import java.util.*;
import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.service.protocol.Message;
import net.java.sip.communicator.service.protocol.event.*;
import net.java.sip.communicator.util.*;
import net.kano.joscar.*;
import net.kano.joscar.flapcmd.*;
import net.kano.joscar.snac.*;
import net.kano.joscar.snaccmd.error.*;
import net.kano.joscar.snaccmd.icq.*;
import net.kano.joustsim.*;
import net.kano.joustsim.oscar.oscar.service.icbm.*;
import net.java.sip.communicator.service.protocol.icqconstants.*;
/**
* A straightforward implementation of the basic instant messaging operation
* set.
*
* @author Emil Ivov
* @author Damian Minkov
*/
public class OperationSetBasicInstantMessagingIcqImpl
extends AbstractOperationSetBasicInstantMessaging
{
private static final Logger logger =
Logger.getLogger(OperationSetBasicInstantMessagingIcqImpl.class);
/**
* The icq provider that created us.
*/
private ProtocolProviderServiceIcqImpl icqProvider = null;
/**
* The registration listener that would get notified when the unerlying
* icq provider gets registered.
*/
private RegistrationStateListener providerRegListener
= new RegistrationStateListener();
/**
* The listener that would receive instant messaging events from oscar.jar
*/
private JoustSimIcbmListener joustSimIcbmListener
= new JoustSimIcbmListener();
/**
* The listener that would receive conversation events from oscar.jar
*/
private JoustSimConversationListener joustSimConversationListener
= new JoustSimConversationListener();
/**
* A reference to the persistent presence operation set that we use
* to match incoming messages to <tt>Contact</tt>s and vice versa.
*/
private OperationSetPersistentPresenceIcqImpl opSetPersPresence = null;
/**
* The maximum message length allowed by the icq protocol as reported by
* Pavel Tankov.
*/
private static final int MAX_MSG_LEN = 2047;
/**
* I do not why but we sometimes receive messages with a date in the future.sdf
* I've decided to ignore such messages. I draw the line on
* currentTimeMillis() + ONE_DAY milliseconds. Anything with a date farther
* in the future is considered bogus and its date is replaced with current
* time millis.
*/
private static final long ONE_DAY = 86400001;
/**
* KeepAlive interval for sending packets
*/
private final static long KEEPALIVE_INTERVAL = 180000l; // 3 minutes
/**
* The interval after which a packet is considered to be lost
*/
private final static long KEEPALIVE_WAIT = 20000l; //20 secs
private final String defaultHtmlStartTag = "<HTML><BODY>";
private final String defaultHtmlEndTag = "</BODY></HTML>";
/**
* The task sending packets
*/
private KeepAliveSendTask keepAliveSendTask = null;
/**
* The timer executing tasks on specified intervals
*/
private Timer keepAliveTimer = null;
/**
* The queue holding the received packets
*/
private final LinkedList<String> receivedKeepAlivePackets
= new LinkedList<String>();
/**
* The ping message prefix that we use in our keep alive thread.
*/
private static String SYS_MSG_PREFIX_TEST
= "SIP COMMUNICATOR SYSTEM MESSAGE!";
/**
* Creates an instance of this operation set.
* @param icqProvider a ref to the <tt>ProtocolProviderServiceIcqImpl</tt>
* that created us and that we'll use for retrieving the underlying aim
* connection.
*/
OperationSetBasicInstantMessagingIcqImpl(
ProtocolProviderServiceIcqImpl icqProvider)
{
this.icqProvider = icqProvider;
icqProvider.addRegistrationStateChangeListener(providerRegListener);
}
public Message createMessage(String content, String contentType,
String encoding, String subject)
{
return new MessageIcqImpl(content, contentType, encoding, subject);
}
/**
* 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 java.lang.IllegalStateException if the underlying ICQ stack is
* not registered and initialized.
* @throws java.lang.IllegalArgumentException if <tt>to</tt> is not an
* instance of ContactIcqImpl.
*/
public void sendInstantMessage(Contact to, Message message)
throws IllegalStateException, IllegalArgumentException
{
assertConnected();
if( !(to instanceof ContactIcqImpl) )
throw new IllegalArgumentException(
"The specified contact is not a Icq contact."
+ to);
ImConversation imConversation =
icqProvider.getAimConnection().getIcbmService().
getImConversation(
new Screenname(to.getAddress()));
String messageContent;
if (message.getContentType().equals(HTML_MIME_TYPE)
&& !message.getContent().startsWith(defaultHtmlStartTag))
{
messageContent = defaultHtmlStartTag
+ message.getContent()
+ defaultHtmlEndTag;
}
else
messageContent = message.getContent();
MessageDeliveredEvent msgDeliveryPendingEvt
= new MessageDeliveredEvent(message, to);
msgDeliveryPendingEvt = this.messageDeliveryPendingTransform(msgDeliveryPendingEvt);
if (msgDeliveryPendingEvt == null)
return;
String transformedContent = msgDeliveryPendingEvt.getSourceMessage().getContent();
if (to.getPresenceStatus().isOnline())
{
//do not add the conversation listener in here. we'll add it
//inside the icbm listener
imConversation.sendMessage(new SimpleMessage(transformedContent));
}
else
imConversation.sendMessage(new SimpleMessage(transformedContent), true);
MessageDeliveredEvent msgDeliveredEvt
= new MessageDeliveredEvent(message, to);
// msgDeliveredEvt = this.messageDeliveredTransform(msgDeliveredEvt);
if (msgDeliveredEvt != null)
fireMessageEvent(msgDeliveredEvt);
}
/**
* Retreives all offline Messages If any.
* Then delete them from the server.
*
* @param listener the <tt>MessageListener</tt> receiving the messages.
*/
private static int offlineMessageRequestID = 0;
private void retreiveOfflineMessages()
{
int requestID = offlineMessageRequestID++;
OfflineMsgIcqRequest offlineMsgsReq =
new OfflineMsgIcqRequest(
Long.parseLong(
icqProvider.getAimSession().getScreenname().getNormal()),
requestID
);
OfflineMessagesRetriever responseRetriever =
new OfflineMessagesRetriever(requestID);
SnacRequest snReq = new SnacRequest(offlineMsgsReq, responseRetriever);
icqProvider.getAimConnection().getInfoService().
getOscarConnection().sendSnacRequest(snReq);
}
private class OfflineMessagesRetriever
extends SnacRequestAdapter
{
private int requestID;
public OfflineMessagesRetriever(int requestID)
{
this.requestID = requestID;
}
public void handleResponse(SnacResponseEvent evt)
{
SnacCommand snac = evt.getSnacCommand();
logger.debug("Received a response to our offline message request: " +
snac);
if (snac instanceof OfflineMsgIcqCmd)
{
OfflineMsgIcqCmd offlineMsgCmd = (OfflineMsgIcqCmd) snac;
String contactUIN = String.valueOf(offlineMsgCmd.getFromUIN());
Contact sourceContact =
opSetPersPresence.findContactByID(contactUIN);
if (sourceContact == null)
{
logger.debug(
"received a message from a unknown contact: "
+ contactUIN);
//create the volatile contact
sourceContact = opSetPersPresence
.createVolatileContact(contactUIN);
}
//some messages arrive far away in the future for some
//reason that I currently don't know. Until we find it
//(which may well be never) we are putting in an agly hack
//ignoring messages with a date beyond tomorrow.
long current = System.currentTimeMillis();
long msgDate = offlineMsgCmd.getDate().getTime();
if( (current + ONE_DAY) > msgDate )
msgDate = current;
MessageReceivedEvent msgReceivedEvt
= new MessageReceivedEvent(
createMessage(offlineMsgCmd.getContents()),
sourceContact,
msgDate);
// msgReceivedEvt = messageReceivedTransform(msgReceivedEvt);
if (msgReceivedEvt != null)
{
logger.debug("fire msg received for : " +
offlineMsgCmd.getContents());
fireMessageEvent(msgReceivedEvt);
}
}
else if (snac instanceof OfflineMsgDoneCmd)
{
logger.debug("send ack to delete offline messages");
OfflineMsgIcqAckCmd offlineMsgDeleteReq = new
OfflineMsgIcqAckCmd(
Long.parseLong(
icqProvider.getAimSession().getScreenname().
getNormal()),
requestID
);
icqProvider.getAimConnection().getInfoService().
getOscarConnection().sendSnac(offlineMsgDeleteReq);
}
else if (snac instanceof SnacError)
{
logger.debug("error receiving offline messages");
}
}
}
/**
* Utility method throwing an exception if the icq stack is not properly
* initialized.
* @throws java.lang.IllegalStateException if the underlying ICQ stack is
* not registered and initialized.
*/
private void assertConnected() throws IllegalStateException
{
if (icqProvider == null)
throw new IllegalStateException(
"The icq provider must be non-null and signed on the ICQ "
+"service before being able to communicate.");
if (!icqProvider.isRegistered())
throw new IllegalStateException(
"The icq provider must be signed on the ICQ service before "
+"being able to communicate.");
}
/**
* Determines wheter the protocol provider (or the protocol itself) support
* sending and receiving offline messages. Most often this method would
* return true for protocols that support offline messages and false for
* those that don't. It is however possible for a protocol to support these
* messages and yet have a particular account that does not (i.e. feature
* not enabled on the protocol server). In cases like this it is possible
* for this method to return true even when offline messaging is not
* supported, and then have the sendMessage method throw an
* OperationFailedException with code - OFFLINE_MESSAGES_NOT_SUPPORTED.
*
* @return <tt>true</tt> if the protocol supports offline messages and
* <tt>false</tt> otherwise.
*/
public boolean isOfflineMessagingSupported()
{
if(icqProvider.USING_ICQ)
return true;
else
return false;
}
/**
* Determines wheter the protocol supports the supplied content type
*
* @param contentType the type we want to check
* @return <tt>true</tt> if the protocol supports it and
* <tt>false</tt> otherwise.
*/
public boolean isContentTypeSupported(String contentType)
{
if(contentType.equals(DEFAULT_MIME_TYPE) ||
(contentType.equals(HTML_MIME_TYPE)))
return true;
else
return false;
}
/**
* Our listener that will tell us when we're registered to icq and joust
* sim is ready to accept us as a listener.
*/
private class RegistrationStateListener
implements RegistrationStateChangeListener
{
/**
* The method is called by a ProtocolProvider implementation whenver
* a change in the registration state of the corresponding provider had
* occurred.
* @param evt ProviderStatusChangeEvent the event describing the status
* change.
*/
public void registrationStateChanged(RegistrationStateChangeEvent evt)
{
logger.debug("The ICQ provider changed state from: "
+ evt.getOldState()
+ " to: " + evt.getNewState());
if(evt.getNewState() == RegistrationState.FINALIZING_REGISTRATION)
{
logger.debug("adding a Bos Service Listener");
icqProvider.getAimConnection().getIcbmService()
.addIcbmListener(joustSimIcbmListener);
opSetPersPresence =
(OperationSetPersistentPresenceIcqImpl) icqProvider
.getOperationSet(OperationSetPersistentPresence.class);
}
else if (evt.getNewState() == RegistrationState.REGISTERED)
{
if(icqProvider.USING_ICQ)
retreiveOfflineMessages();
String customMessageEncoding = null;
if((customMessageEncoding =
System.getProperty("icq.custom.message.charset")) != null)
OscarTools.setDefaultCharset(customMessageEncoding);
// run keepalive thread
if(keepAliveSendTask == null)
{
//Temporarily disable keep alives as they seem to be causing trouble
// keepAliveSendTask = new KeepAliveSendTask();
// keepAliveTimer = new Timer();
// keepAliveTimer.scheduleAtFixedRate(
// keepAliveSendTask, KEEPALIVE_INTERVAL, KEEPALIVE_INTERVAL);
}
}
else
if (evt.getNewState() == RegistrationState.UNREGISTERED)
{
// stop keepalive thread
if (keepAliveSendTask != null)
{
keepAliveSendTask.cancel();
keepAliveTimer.cancel();
keepAliveSendTask = null;
keepAliveTimer = null;
}
}
}
}
/**
* The listener that would retrieve instant messaging events from oscar.jar.
*/
private class JoustSimIcbmListener implements IcbmListener
{
/**
* Register our icbm listener so that we get notified when new
* conversations are cretaed and register ourselvers as listeners in
* them.
*
* @param service the <tt>IcbmService</tt> that is clling us
* @param conv the <tt>Conversation</tt> that has just been created.
*/
public void newConversation(IcbmService service, Conversation conv)
{
conv.addConversationListener(joustSimConversationListener);
}
/**
* Currently Unused.
* @param service Currently Unused.
* @param buddy Currently Unused.
* @param info Currently Unused.
*/
public void buddyInfoUpdated(IcbmService service, Screenname buddy,
IcbmBuddyInfo info)
{
logger.debug("buddy info pudated for " + buddy
+ " new info is: " + info);
}
public void sendAutomaticallyFailed(
IcbmService service,
net.kano.joustsim.oscar.oscar.service.icbm.Message message,
Set triedConversations)
{
logger.debug("sendAutomaticallyFailed message : " + message);
}
}
/**
* Joust SIM supports the notion of instant messaging conversations and
* all message events are delivered through this listener. Right now we
* won't burden ourselves with conversations and would simply deliver
* events as we get them. If we need conversation support we'll implement it
* some other day.
*/
private class JoustSimConversationListener implements ImConversationListener
{
/**
* Create a corresponding message object and fire a
* <tt>MessageReceivedEvent</tt>.
*
* @param conversation the conversation where the message is received in.
* @param minfo informtion about the received message
*/
public void gotMessage(Conversation conversation, MessageInfo minfo)
{
String msgBody = minfo.getMessage().getMessageBody();
if(logger.isDebugEnabled())
logger.debug("Received from "
+ conversation.getBuddy()
+ " the message "
+ msgBody);
if(msgBody.startsWith(SYS_MSG_PREFIX_TEST)
&& conversation.getBuddy().getFormatted().
equals(icqProvider.getAccountID().getUserID()))
{
receivedKeepAlivePackets.addLast(msgBody);
return;
}
String msgContent;
String msgContentType;
if (msgBody.startsWith(defaultHtmlStartTag))
{
msgContent = msgBody.substring(
msgBody.indexOf(defaultHtmlStartTag)
+ defaultHtmlStartTag.length(),
msgBody.indexOf(defaultHtmlEndTag));
msgContentType = HTML_MIME_TYPE;
}
else
{
msgContent = msgBody;
msgContentType = DEFAULT_MIME_TYPE;
}
Message newMessage =
createMessage(msgContent, msgContentType,
DEFAULT_MIME_ENCODING, null);
Contact sourceContact =
opSetPersPresence.findContactByID( conversation.getBuddy()
.getFormatted());
if(sourceContact == null)
{
logger.debug("received a message from a unknown contact: "
+ conversation.getBuddy());
//create the volatile contact
sourceContact = opSetPersPresence
.createVolatileContact(
conversation.getBuddy().getFormatted());
}
//some messages arrive far away in the future for some
//reason that I currently don't know. Until we find it
//(which may well be never) we are putting in an agly hack
//ignoring messages with a date beyond tomorrow.
long current = System.currentTimeMillis();
long msgDate = minfo.getTimestamp().getTime();
if ( (current + ONE_DAY) > msgDate)
msgDate = current;
MessageReceivedEvent msgReceivedEvt =
new MessageReceivedEvent(newMessage, sourceContact, msgDate);
// msgReceivedEvt = messageReceivedTransform(msgReceivedEvt);
if (msgReceivedEvt != null)
{
logger.debug("fire msg received for : " +
newMessage);
fireMessageEvent(msgReceivedEvt);
}
}
public void sentOtherEvent(Conversation conversation,
ConversationEventInfo event)
{}
public void canSendMessageChanged(Conversation conv, boolean canSend)
{}
public void conversationClosed(Conversation conv)
{}
public void conversationOpened(Conversation conv)
{}
public void gotOtherEvent(Conversation conversation,
ConversationEventInfo event)
{}
public void sentMessage(Conversation conv, MessageInfo minfo)
{
/**@todo implement sentMessage() */
/**
* there's no id in this event and besides we have no message failed
* method so refiring an event here would be difficult.
*
* we'll deal with that some other day.
*/
}
public void missedMessages(ImConversation conv, MissedImInfo info)
{
/**@todo implement missedMessages() */
}
public void gotTypingState(Conversation conversation,
TypingInfo typingInfo)
{
//typing events are handled in OperationSetTypingNotifications
}
}
/**
* Task sending packets on intervals.
* The task is runned on specified intervals by the keepAliveTimer
*/
private class KeepAliveSendTask
extends TimerTask
{
public void run()
{
try
{
// if we are not registerd do nothing
if(!icqProvider.isRegistered())
return;
StringBuffer sysMsg = new StringBuffer(SYS_MSG_PREFIX_TEST);
sysMsg.append("pp:").append(icqProvider.hashCode()).
append("&op:").append(
OperationSetBasicInstantMessagingIcqImpl.this.hashCode());
ImConversation imConversation =
icqProvider.getAimConnection().getIcbmService().
getImConversation(
new Screenname(icqProvider.getAccountID().getUserID()));
// schedule the check task
keepAliveTimer.schedule(
new KeepAliveCheckTask(), KEEPALIVE_WAIT);
logger.trace("send keepalive");
imConversation.sendMessage(new SimpleMessage(sysMsg.toString()));
}
catch (Exception ex)
{
logger.error("Failed to start keep alive task.", ex);
}
}
}
/**
* Check if the first received packet in the queue
* is ok and if its not or the queue has no received packets
* the this means there is some network problem, so fire event
*/
private class KeepAliveCheckTask
extends TimerTask
{
public void run()
{
try
{
// check till we find a correct message
// or if NoSuchElementException is thrown
// there is no message
while(!checkFirstPacket());
}
catch (Exception ex)
{
logger.error(
"Exception occurred while retrieving keep alive packet."
, ex);
fireUnregistered();
}
}
/**
* Checks whether first packet in queue is ok
* @return boolean
* @throws Exception
*/
boolean checkFirstPacket()
throws Exception
{
String receivedStr = receivedKeepAlivePackets.removeLast();
logger.trace("Last keep alive message is: " + receivedStr);
receivedStr = receivedStr.replaceAll(SYS_MSG_PREFIX_TEST, "");
String[] ss = receivedStr.split("&");
String provHashStr = ss[0].split(":")[1];
String opsetHashStr = ss[1].split(":")[1];
if(icqProvider.hashCode() != Integer.parseInt(provHashStr)
|| OperationSetBasicInstantMessagingIcqImpl.this.hashCode()
!= Integer.parseInt(opsetHashStr) )
{
return false;
}
else
{
return true;
}
}
/**
* Fire Unregistered event
*/
private void fireUnregistered()
{
icqProvider.fireRegistrationStateChanged(
icqProvider.getRegistrationState()
, RegistrationState.CONNECTION_FAILED
, RegistrationStateChangeEvent.REASON_INTERNAL_ERROR
, "Did not receive last keep alive packet.");
if(icqProvider.USING_ICQ)
opSetPersPresence.fireProviderPresenceStatusChangeEvent(
opSetPersPresence.getPresenceStatus().getStatus()
, IcqStatusEnum.OFFLINE.getStatus());
else
opSetPersPresence.fireProviderPresenceStatusChangeEvent(
opSetPersPresence.getPresenceStatus().getStatus()
, AimStatusEnum.OFFLINE.getStatus());
}
}
}
|
