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
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
|
/*
* Jitsi, 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.irc;
import java.util.*;
import java.util.Map.Entry;
import net.java.sip.communicator.impl.protocol.irc.ModeParser.ModeEntry;
import net.java.sip.communicator.impl.protocol.irc.exception.*;
import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.service.protocol.event.*;
import net.java.sip.communicator.util.*;
import com.ircclouds.irc.api.*;
import com.ircclouds.irc.api.domain.*;
import com.ircclouds.irc.api.domain.messages.*;
import com.ircclouds.irc.api.domain.messages.interfaces.*;
import com.ircclouds.irc.api.state.*;
/**
* Channel manager.
*
* TODO Implement channel services (ChanServ - channel related services) that
* can be used for accessing remove channel facilities.
*
* TODO Do we need to cancel any join channel operations still in progress?
*
* @author Danny van Heumen
*/
public class ChannelManager
{
/**
* Logger.
*/
private static final Logger LOGGER = Logger.getLogger(ChannelManager.class);
/**
* IRCApi instance.
*
* Instance must be thread-safe!
*/
private final IRCApi irc;
/**
* Connection state.
*/
private final IIRCState connectionState;
/**
* Provider.
*/
private final ProtocolProviderServiceIrcImpl provider;
/**
* Client configuration.
*/
private final ClientConfig config;
/**
* Container for joined channels.
*
* There are two different cases:
*
* <pre>
* - null value: joining is initiated but still in progress.
* - non-null value: joining is finished, chat room instance is available.
* </pre>
*/
private final Map<String, ChatRoomIrcImpl> joined = Collections
.synchronizedMap(new HashMap<String, ChatRoomIrcImpl>());
/**
* Maximum channel name length according to server ISUPPORT instructions.
*
* <p>This value is not guaranteed, so it may be <tt>null</tt>.</p>
*/
private final Integer isupportChannelLen;
/**
* Maximum topic length according to server ISUPPORT instructions.
*
* <p>This value is not guaranteed, so it may be <tt>null</tt>.</p>
*/
private final Integer isupportTopicLen;
/**
* Maximum kick message length according to server ISUPPORT instructions.
*
* <p>This value is not guaranteed, so it may be <tt>null</tt>.</p>
*/
private final Integer isupportKickLen;
/**
* Maximum number of joined channels according to server ISUPPORT
* instructions. Limits are stored per channel type (#, &, etc.)
*
* <p>This value is not guaranteed, so it may be <tt>null</tt>.</p>
*/
private final Map<Character, Integer> isupportChanLimit
= new HashMap<Character, Integer>();
/**
* Constructor.
*
* @param irc thread-safe IRCApi instance
* @param connectionState the connection state
* @param provider the provider instance
* @param config client configuration
*/
public ChannelManager(final IRCApi irc, final IIRCState connectionState,
final ProtocolProviderServiceIrcImpl provider,
final ClientConfig config)
{
if (irc == null)
{
throw new IllegalArgumentException("irc instance cannot be null");
}
this.irc = irc;
if (connectionState == null)
{
throw new IllegalArgumentException(
"connectionState cannot be null");
}
this.connectionState = connectionState;
if (provider == null)
{
throw new IllegalArgumentException("provider cannot be null");
}
this.provider = provider;
if (config == null)
{
throw new IllegalArgumentException("client config cannot be null");
}
this.config = config;
this.irc.addListener(new ManagerListener());
// parse ISUPPORT parameters
this.isupportChannelLen = parseISupportInteger(this.connectionState,
ISupport.CHANNELLEN);
this.isupportTopicLen = parseISupportInteger(this.connectionState,
ISupport.TOPICLEN);
this.isupportKickLen = parseISupportInteger(this.connectionState,
ISupport.KICKLEN);
parseISupportChanLimit(this.isupportChanLimit, this.connectionState);
}
/**
* Parse the ISUPPORT parameter for Integer value.
*
* @param state the connection state
* @return returns instance with parameter value or <tt>null</tt> if
* not specified.
*/
private static Integer parseISupportInteger(final IIRCState state,
final ISupport param)
{
final String value = state.getServerOptions().getKey(param.name());
if (value == null)
{
return null;
}
if (LOGGER.isDebugEnabled())
{
LOGGER.debug("Setting ISUPPORT parameter " + param.name() + " to "
+ value);
}
return new Integer(value);
}
/**
* Parse the raw ISUPPORT CHANLIMIT value, extract its values into the
* destination map.
*
* @param destination the destination map
* @param state the IRC connection state
*/
private static void parseISupportChanLimit(
final Map<Character, Integer> destination, final IIRCState state)
{
final String rawChanLimitValue =
state.getServerOptions().getKey(ISupport.CHANLIMIT.name());
ISupport.parseChanLimit(destination, rawChanLimitValue);
if (LOGGER.isDebugEnabled())
{
LOGGER.debug("Parsed ISUPPORT CHANLIMIT parameter: "
+ rawChanLimitValue);
for (Entry<Character, Integer> e : destination.entrySet())
{
LOGGER.debug(e.getKey() + ":" + e.getValue());
}
}
}
/**
* Get a set of channel type indicators.
*
* @return returns set of channel type indicators.
*/
public Set<Character> getChannelTypes()
{
return this.connectionState.getServerOptions().getChanTypes();
}
/**
* Check whether the user has joined a particular chat room.
*
* @param chatroom Chat room to check for.
* @return Returns true in case the user is already joined, or false if the
* user has not joined.
*/
public boolean isJoined(final ChatRoomIrcImpl chatroom)
{
return this.joined.get(chatroom.getIdentifier()) != null;
}
/**
* Join a particular chat room.
*
* @param chatroom Chat room to join.
* @throws OperationFailedException failed to join the chat room
*/
public void join(final ChatRoomIrcImpl chatroom)
throws OperationFailedException
{
join(chatroom, "");
}
/**
* Join a particular chat room.
*
* Issue a join channel IRC operation and wait for the join operation to
* complete (either successfully or failing).
*
* @param chatroom The chatroom to join.
* @param password Optionally, a password that may be required for some
* channels.
* @throws OperationFailedException failed to join the chat room
*/
public void join(final ChatRoomIrcImpl chatroom, final String password)
throws OperationFailedException
{
if (!this.connectionState.isConnected())
{
throw new IllegalStateException(
"Please connect to an IRC server first");
}
if (chatroom == null)
{
throw new IllegalArgumentException("chatroom cannot be null");
}
if (password == null)
{
throw new IllegalArgumentException("password cannot be null");
}
final String chatRoomId = chatroom.getIdentifier();
if (this.joined.containsKey(chatRoomId))
{
// If we already joined this particular chatroom, no further action
// is required.
return;
}
if (this.isupportChannelLen != null
&& chatRoomId.length() > this.isupportChannelLen)
{
throw new IllegalArgumentException("the channel name must not be "
+ "longer than " + this.isupportChannelLen.intValue()
+ " characters according to server parameters.");
}
// Verify max channel limit based on server parameters (ISupport)
final Integer limit = this.isupportChanLimit.get(chatRoomId.charAt(0));
if (limit != null && this.joined.size() >= limit)
{
throw new IllegalStateException("already joined to the maximum "
+ "allowed number of channels ("
+ this.isupportChanLimit.toString() + ") according to "
+ "server parameters.");
}
LOGGER.trace("Start joining channel " + chatRoomId);
final Result<Object, Exception> joinSignal =
new Result<Object, Exception>();
synchronized (joinSignal)
{
LOGGER.trace("Issue join channel command to IRC library and wait "
+ "for join operation to complete (un)successfully.");
this.joined.put(chatRoomId, null);
// TODO Refactor this ridiculous nesting of functions and
// classes.
this.irc.joinChannel(chatRoomId, password,
new Callback<IRCChannel>()
{
@Override
public void onSuccess(final IRCChannel channel)
{
if (LOGGER.isTraceEnabled())
{
LOGGER.trace("Started callback for successful "
+ "join of channel '"
+ chatroom.getIdentifier() + "'.");
}
boolean isRequestedChatRoom =
channel.getName().equalsIgnoreCase(chatRoomId);
synchronized (joinSignal)
{
if (!isRequestedChatRoom)
{
// We joined another chat room than the one
// we requested initially.
if (LOGGER.isTraceEnabled())
{
LOGGER.trace("Callback for successful "
+ "join finished prematurely "
+ "since we got forwarded from '"
+ chatRoomId + "' to '"
+ channel.getName()
+ "'. Joining of forwarded channel "
+ "gets handled by Server Listener "
+ "since that channel was not "
+ "announced.");
}
// Remove original chat room id from
// joined-list since we aren't actually
// attempting to join this room anymore.
ChannelManager.this.joined.remove(chatRoomId);
ChannelManager.this.provider
.getMUC()
.fireLocalUserPresenceEvent(
chatroom,
LocalUserChatRoomPresenceChangeEvent
.LOCAL_USER_JOIN_FAILED,
"We got forwarded to channel '"
+ channel.getName() + "'.");
// Notify waiting threads of finished
// execution.
joinSignal.setDone();
joinSignal.notifyAll();
// The channel that we were forwarded to
// will be handled by the Server Listener,
// since the channel join was unannounced,
// and we are done here.
return;
}
try
{
ChannelManager.this.joined.put(chatRoomId,
chatroom);
ChannelManager.this.irc
.addListener(new ChatRoomListener(chatroom,
ChannelManager.this.config
.isChannelPresenceTaskEnabled()));
prepareChatRoom(chatroom, channel);
}
finally
{
// In any case, issue the local user
// presence, since the irc library notified
// us of a successful join. We should wait
// as long as possible though. First we need
// to fill the list of chat room members and
// other chat room properties.
ChannelManager.this.provider
.getMUC()
.fireLocalUserPresenceEvent(
chatroom,
LocalUserChatRoomPresenceChangeEvent
.LOCAL_USER_JOINED,
null);
if (LOGGER.isTraceEnabled())
{
LOGGER.trace("Finished successful join "
+ "callback for channel '" + chatRoomId
+ "'. Waking up original thread.");
}
// Notify waiting threads of finished
// execution.
joinSignal.setDone();
joinSignal.notifyAll();
}
}
}
@Override
public void onFailure(final Exception e)
{
LOGGER.trace("Started callback for failed attempt to "
+ "join channel '" + chatRoomId + "'.");
synchronized (joinSignal)
{
try
{
ChannelManager.this.joined.remove(chatRoomId);
ChannelManager.this.provider
.getMUC()
.fireLocalUserPresenceEvent(
chatroom,
LocalUserChatRoomPresenceChangeEvent
.LOCAL_USER_JOIN_FAILED,
e.getMessage());
}
finally
{
if (LOGGER.isTraceEnabled())
{
LOGGER.trace("Finished callback for "
+ "failed attempt to join "
+ "channel '" + chatRoomId
+ "'. Waking up original thread.");
}
// Notify waiting threads of finished
// execution
joinSignal.setDone(e);
joinSignal.notifyAll();
}
}
}
});
try
{
while (!joinSignal.isDone())
{
LOGGER.trace("Waiting for channel join message ...");
// Wait until async channel join operation has finished.
joinSignal.wait();
}
LOGGER
.trace("Finished waiting for join operation for channel '"
+ chatroom.getIdentifier() + "' to complete.");
// TODO How to handle 480 (+j): Channel throttle exceeded?
}
catch (InterruptedException e)
{
LOGGER.error("Wait for join operation was interrupted.", e);
throw new OperationFailedException(e.getMessage(),
OperationFailedException.INTERNAL_ERROR, e);
}
}
}
/**
* Prepare a chat room for initial opening.
*
* @param channel The IRC channel which is the source of data.
* @param chatRoom The chatroom to prepare.
*/
private void prepareChatRoom(final ChatRoomIrcImpl chatRoom,
final IRCChannel channel)
{
final IRCTopic topic = channel.getTopic();
chatRoom.updateSubject(topic.getValue());
for (final IRCUser user : channel.getUsers())
{
final ChatRoomMemberIrcImpl member =
new ChatRoomMemberIrcImpl(this.provider, chatRoom,
user.getNick(), user.getIdent(), user.getHostname(),
ChatRoomMemberRole.SILENT_MEMBER, IrcStatusEnum.ONLINE);
ChatRoomMemberRole role;
for (final IRCUserStatus status : channel.getStatusesForUser(user))
{
try
{
role = convertMemberMode(status.getChanModeType());
member.addRole(role);
}
catch (UnknownModeException e)
{
LOGGER.info(
"Unknown mode encountered. This mode will be ignored.",
e);
}
}
chatRoom.addChatRoomMember(member.getContactAddress(), member);
if (this.connectionState.getNickname().equals(user.getNick()))
{
chatRoom.setLocalUser(member);
if (member.getRole() != ChatRoomMemberRole.SILENT_MEMBER)
{
ChatRoomLocalUserRoleChangeEvent event =
new ChatRoomLocalUserRoleChangeEvent(chatRoom,
ChatRoomMemberRole.SILENT_MEMBER, member.getRole(),
true);
chatRoom.fireLocalUserRoleChangedEvent(event);
}
}
}
}
/**
* Set the subject of the specified chat room.
*
* @param chatroom The chat room for which to set the subject.
* @param subject The subject.
*/
public void setSubject(final ChatRoomIrcImpl chatroom, final String subject)
{
if (!this.connectionState.isConnected())
{
throw new IllegalStateException(
"Please connect to an IRC server first.");
}
if (chatroom == null)
{
throw new IllegalArgumentException("Cannot have a null chatroom");
}
if (this.isupportTopicLen != null
&& subject.length() > this.isupportTopicLen)
{
throw new IllegalArgumentException("the topic length must not be "
+ "longer than " + this.isupportTopicLen
+ " characters according to server parameters.");
}
LOGGER.trace("Setting chat room topic to '" + subject + "'");
this.irc.changeTopic(chatroom.getIdentifier(), subject == null ? ""
: subject);
}
/**
* Part from a joined chat room.
*
* @param chatroom The chat room to part from.
*/
public void leave(final ChatRoomIrcImpl chatroom)
{
LOGGER.trace("Leaving chat room '" + chatroom.getIdentifier() + "'.");
leave(chatroom.getIdentifier());
}
/**
* Part from a joined chat room.
*
* @param chatRoomName The chat room to part from.
*/
private void leave(final String chatRoomName)
{
if (!this.connectionState.isConnected())
{
throw new IllegalStateException("Not connected to an IRC server.");
}
try
{
this.irc.leaveChannel(chatRoomName);
}
catch (ApiException e)
{
LOGGER.warn("exception occurred while leaving channel", e);
}
}
/**
* Grant user permissions to specified user.
*
* @param chatRoom chat room to grant permissions for
* @param userAddress user to grant permissions to
* @param mode mode to grant
*/
public void grant(final ChatRoomIrcImpl chatRoom, final String userAddress,
final Mode mode)
{
if (!this.connectionState.isConnected())
{
throw new IllegalStateException("Not connected to an IRC server.");
}
if (mode.getRole() == null)
{
throw new IllegalArgumentException(
"This mode does not modify user permissions.");
}
this.irc.changeMode(chatRoom.getIdentifier() + " +" + mode.getSymbol()
+ " " + userAddress);
}
/**
* Revoke user permissions of chat room for user.
*
* @param chatRoom chat room
* @param userAddress user
* @param mode mode
*/
public void revoke(final ChatRoomIrcImpl chatRoom,
final String userAddress, final Mode mode)
{
if (!this.connectionState.isConnected())
{
throw new IllegalStateException("Not connected to an IRC server.");
}
if (mode.getRole() == null)
{
throw new IllegalArgumentException(
"This mode does not modify user permissions.");
}
this.irc.changeMode(chatRoom.getIdentifier() + " -" + mode.getSymbol()
+ " " + userAddress);
}
/**
* Ban chat room member.
*
* @param chatroom chat room to ban from
* @param member member to ban
* @param reason reason for banning
* @throws OperationFailedException throws operation failed in case of
* trouble.
*/
public void banParticipant(final ChatRoomIrcImpl chatroom,
final ChatRoomMemberIrcImpl member, final String reason)
throws OperationFailedException
{
if (!this.connectionState.isConnected())
{
return;
}
kickParticipant(chatroom, member, reason);
this.irc.changeMode(String.format("%s +b %s!%s@%s",
chatroom.getIdentifier(), "*",
member.getIdent(), member.getHostname()));
}
/**
* Kick channel member.
*
* @param chatroom channel to kick from
* @param member member to kick
* @param reason kick message to deliver
*/
public void kickParticipant(final ChatRoomIrcImpl chatroom,
final ChatRoomMember member, final String reason)
{
if (!this.connectionState.isConnected())
{
return;
}
if (this.isupportKickLen != null
&& reason.length() > this.isupportKickLen)
{
throw new IllegalArgumentException("the kick reason must not be "
+ "longer than " + this.isupportKickLen.intValue()
+ " characters according to server parameters.");
}
this.irc.kick(chatroom.getIdentifier(), member.getContactAddress(),
reason);
}
/**
* Issue invite command to IRC server.
*
* @param memberId member to invite
* @param chatroom channel to invite to
*/
public void invite(final String memberId, final ChatRoomIrcImpl chatroom)
{
if (!this.connectionState.isConnected())
{
throw new IllegalStateException("Not connected to an IRC server.");
}
this.irc.rawMessage("INVITE " + memberId + " "
+ chatroom.getIdentifier());
}
/**
* Convert a member mode character to a ChatRoomMemberRole instance.
*
* @param modeSymbol The member mode character.
* @return Return the instance of ChatRoomMemberRole corresponding to the
* member mode character.
* @throws UnknownModeException returns UnknownModeException in case unknown
* mode is encountered
*/
private static ChatRoomMemberRole convertMemberMode(final char modeSymbol)
throws UnknownModeException
{
return Mode.bySymbol(modeSymbol).getRole();
}
/**
* The channel manager listener. This listener is used for any events that
* are not directly related to an open, managed chat room. This includes
* events signaling that a channel has been joined on initiative of the IRC
* server, such that it isn't managed yet.
*
* @author Danny van Heumen
*/
private final class ManagerListener extends AbstractIrcMessageListener
{
/**
* IRC reply code for end of list.
*/
private static final int RPL_LISTEND =
IRCServerNumerics.CHANNEL_NICKS_END_OF_LIST;
/**
* Constructor.
*/
public ManagerListener()
{
super(ChannelManager.this.irc, ChannelManager.this.connectionState);
}
/**
* Server numeric message.
*
* @param msg server numeric message
*/
@Override
public void onServerNumericMessage(final ServerNumericMessage msg)
{
switch (msg.getNumericCode())
{
case RPL_LISTEND:
// CHANNEL_NICKS_END_OF_LIST indicates the end of a nick list as
// you will receive when joining a channel. This is used as the
// indicator that we have joined a channel. Now we have to
// determine whether or not we already know about this
// particular join attempt. If not, we continue to inform Jitsi
// and to create a listener for this new chat room.
final String text = msg.getText();
final String channelName = text.substring(0, text.indexOf(' '));
final ChatRoomIrcImpl chatRoom;
final IRCChannel channel;
synchronized (ChannelManager.this.joined)
{
// Synchronize the section that checks then adds a chat
// room. This way we can be sure that there are no 2
// simultaneous creation events.
if (ChannelManager.this.joined.containsKey(channelName))
{
LOGGER.trace("Chat room '" + channelName
+ "' join event was announced or already "
+ "finished. Stop handling this event.");
break;
}
// We aren't currently attempting to join, so this join is
// unannounced.
LOGGER.trace("Starting unannounced join of chat room '"
+ channelName);
// Assuming that at the time that NICKS_END_OF_LIST is
// propagated, the channel join event has been completely
// handled by IRCApi.
channel =
this.connectionState.getChannelByName(channelName);
chatRoom =
new ChatRoomIrcImpl(channelName,
ChannelManager.this.provider);
ChannelManager.this.joined.put(channelName, chatRoom);
}
this.irc.addListener(new ChatRoomListener(chatRoom,
ChannelManager.this.config.isChannelPresenceTaskEnabled()));
try
{
ChannelManager.this.provider.getMUC().openChatRoomWindow(
chatRoom);
}
catch (NullPointerException e)
{
LOGGER.error("failed to open chat room window", e);
}
ChannelManager.this.prepareChatRoom(chatRoom, channel);
ChannelManager.this.provider.getMUC()
.fireLocalUserPresenceEvent(chatRoom,
LocalUserChatRoomPresenceChangeEvent.LOCAL_USER_JOINED,
null);
LOGGER.trace("Unannounced join of chat room '" + channelName
+ "' completed.");
break;
default:
break;
}
}
}
/**
* A chat room listener.
*
* A chat room listener is registered for each chat room that we join. The
* chat room listener updates chat room data and fires events based on IRC
* messages that report state changes for the specified channel.
*
* @author Danny van Heumen
*/
private final class ChatRoomListener
extends AbstractIrcMessageListener
{
/**
* IRC error code for case when user cannot send a message to the
* channel, for example when this channel is moderated and user does not
* have VOICE (+v).
*/
private static final int IRC_ERR_CANNOTSENDTOCHAN = 404;
/**
* IRC error code for case where user is not joined to that channel.
*/
private static final int IRC_ERR_NOTONCHANNEL = 442;
/**
* IRC reply code for WHO reply entry for an individual user.
*/
private static final int IRC_RPL_WHOREPLY = 352;
/**
* IRC reply code for end of WHO reply list.
*/
private static final int IRC_RPL_ENDOFWHO = 315;
/**
* Presence task initial delay.
*/
private static final long TASK_INITIAL_DELAY = 1000L;
/**
* Presence task period.
*/
private static final long TASK_PERIOD = 60000L;
/**
* Chat room for which this listener is working.
*/
private final ChatRoomIrcImpl chatroom;
/**
* Presence task timer.
*/
private final Timer presenceTaskTimer = new Timer();
/**
* Constructor. Instantiate listener for the provided chat room.
*
* @param chatroom the chat room
*/
private ChatRoomListener(final ChatRoomIrcImpl chatroom,
final boolean activatePresenceWatcher)
{
super(ChannelManager.this.irc, ChannelManager.this.connectionState);
if (chatroom == null)
{
throw new IllegalArgumentException("chatroom cannot be null");
}
this.chatroom = chatroom;
if (activatePresenceWatcher)
{
createPeriodicPresenceWatcher();
}
}
/**
* Create periodic task for updating channel presence statuses.
*/
private void createPeriodicPresenceWatcher() {
final TimerTask task = new TimerTask()
{
@Override
public void run()
{
irc.rawMessage("WHO " + chatroom.getIdentifier());
}
};
this.presenceTaskTimer.schedule(task, TASK_INITIAL_DELAY,
TASK_PERIOD);
LOGGER.debug("Scheduled periodic task for querying member presence "
+ "for channel " + this.chatroom.getIdentifier());
}
/**
* Event in case of topic change.
*
* @param msg topic change message
*/
@Override
public void onTopicChange(final TopicMessage msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
this.chatroom.updateSubject(msg.getTopic().getValue());
}
/**
* Event in case of channel mode changes.
*
* @param msg channel mode message
*/
@Override
public void onChannelMode(final ChannelModeMessage msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
processModeMessage(msg);
}
/**
* Event in case of channel join message.
*
* @param msg channel join message
*/
@Override
public void onChannelJoin(final ChanJoinMessage msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
final String user = msg.getSource().getNick();
final String ident = msg.getSource().getIdent();
final String host = msg.getSource().getHostname();
final ChatRoomMemberIrcImpl member =
new ChatRoomMemberIrcImpl(ChannelManager.this.provider,
this.chatroom, user, ident, host,
ChatRoomMemberRole.SILENT_MEMBER, IrcStatusEnum.ONLINE);
this.chatroom.fireMemberPresenceEvent(member, null,
ChatRoomMemberPresenceChangeEvent.MEMBER_JOINED, null);
}
/**
* Event in case of channel part.
*
* @param msg channel part message
*/
@Override
public void onChannelPart(final ChanPartMessage msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
final IRCUser user = msg.getSource();
if (localUser(user))
{
leaveChatRoom();
return;
}
final String userNick = msg.getSource().getNick();
final ChatRoomMember member =
this.chatroom.getChatRoomMember(userNick);
if (member != null)
{
// When the account has been disabled, the chat room may return
// null. If that is NOT the case, continue handling.
try
{
this.chatroom.fireMemberPresenceEvent(member, null,
ChatRoomMemberPresenceChangeEvent.MEMBER_LEFT,
msg.getPartMsg());
}
catch (NullPointerException e)
{
LOGGER.warn(
"This should not have happened. Please report this "
+ "as it is a bug.", e);
}
}
}
/**
* Some of the generic message are relevant to us, so keep an eye on
* general numeric messages.
*
* @param msg IRC server numeric message
*/
public void onServerNumericMessage(final ServerNumericMessage msg)
{
final Integer code = msg.getNumericCode();
if (code == null)
{
return;
}
final String raw = msg.getText();
switch (code)
{
case IRC_ERR_NOTONCHANNEL:
final String channel = raw.substring(0, raw.indexOf(" "));
if (isThisChatRoom(channel))
{
LOGGER
.warn("Just discovered that we are no longer joined to "
+ "channel "
+ channel
+ ". Leaving quietly. (This is most likely due to a"
+ " bug in the implementation.)");
// If for some reason we missed the message that we aren't
// joined (anymore) to this particular chat room, correct
// our problem ASAP.
leaveChatRoom();
}
break;
case IRC_ERR_CANNOTSENDTOCHAN:
final String cannotSendChannel =
raw.substring(0, raw.indexOf(" "));
if (isThisChatRoom(cannotSendChannel))
{
final MessageIrcImpl message =
new MessageIrcImpl("", "text/plain", "UTF-8", null);
this.chatroom.fireMessageDeliveryFailedEvent(
ChatRoomMessageDeliveryFailedEvent.FORBIDDEN,
"This channel is moderated.", new Date(), message);
}
break;
case IRC_RPL_WHOREPLY:
final String[] messageComponents = msg.getText().split(" ");
if (messageComponents.length < 6
|| !isThisChatRoom(messageComponents[0]))
{
// We need at least 6 components in order to process this
// message correctly, so stop processing if this is not the
// case. Or if this reply was not targeted at this channel.
return;
}
final String nick = messageComponents[4];
final ChatRoomMemberIrcImpl member =
(ChatRoomMemberIrcImpl) this.chatroom
.getChatRoomMember(nick);
if (member != null)
{
final IrcStatusEnum status =
determineStatus(messageComponents[5]);
final IrcStatusEnum previous =
member.setPresenceStatus(status);
final ChatRoomMemberPropertyChangeEvent presenceEvent =
new ChatRoomMemberPropertyChangeEvent(member,
this.chatroom,
ChatRoomMemberPropertyChangeEvent.MEMBER_PRESENCE,
previous, status);
this.chatroom.fireMemberPropertyChangeEvent(presenceEvent);
}
break;
default:
break;
}
}
/**
* Determine the presence status by the code in the IRC WHO reply.
*
* @param presenceReply presence code
* @return returns corresponding IrcStatusEnum instance
*/
private IrcStatusEnum determineStatus(final String presenceReply)
{
if (presenceReply != null && presenceReply.startsWith("G"))
{
return IrcStatusEnum.AWAY;
}
return IrcStatusEnum.ONLINE;
}
/**
* Event in case of channel kick.
*
* @param msg channel kick message
*/
@Override
public void onChannelKick(final ChannelKick msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
if (!this.connectionState.isConnected())
{
LOGGER.error("Not currently connected to IRC Server. "
+ "Aborting message handling.");
return;
}
final String kickedUser = msg.getKickedNickname();
final ChatRoomMember kickedMember =
this.chatroom.getChatRoomMember(kickedUser);
final String user = msg.getSource().getNick();
if (kickedMember != null)
{
ChatRoomMember kicker = this.chatroom.getChatRoomMember(user);
this.chatroom.fireMemberPresenceEvent(kickedMember, kicker,
ChatRoomMemberPresenceChangeEvent.MEMBER_KICKED,
msg.getText());
}
if (localUser(kickedUser))
{
LOGGER.debug(
"Local user is kicked. Removing chat room listener.");
this.irc.deleteListener(this);
ChannelManager.this.joined
.remove(this.chatroom.getIdentifier());
ChannelManager.this.provider.getMUC()
.fireLocalUserPresenceEvent(this.chatroom,
LocalUserChatRoomPresenceChangeEvent.LOCAL_USER_KICKED,
msg.getText());
}
}
/**
* Event in case of user quit.
*
* @param msg user quit message
*/
@Override
public void onUserQuit(final QuitMessage msg)
{
final String user = msg.getSource().getNick();
if (localUser(user))
{
this.presenceTaskTimer.cancel();
}
else
{
final ChatRoomMember member =
this.chatroom.getChatRoomMember(user);
if (member != null)
{
this.chatroom.fireMemberPresenceEvent(member, null,
ChatRoomMemberPresenceChangeEvent.MEMBER_QUIT,
msg.getQuitMsg());
}
}
super.onUserQuit(msg);
}
/**
* Event in case of error. Cancel running timer then do the regular
* onError stuff.
*/
@Override
public void onError(ErrorMessage msg)
{
this.presenceTaskTimer.cancel();
super.onError(msg);
}
/**
* Event in case of nick change.
*
* @param msg nick change message
*/
@Override
public void onNickChange(final NickMessage msg)
{
if (msg == null)
{
return;
}
final String oldNick = msg.getSource().getNick();
final String newNick = msg.getNewNick();
final ChatRoomMemberIrcImpl member =
(ChatRoomMemberIrcImpl) this.chatroom
.getChatRoomMember(oldNick);
if (member != null)
{
member.setName(newNick);
this.chatroom.updateChatRoomMemberName(oldNick);
ChatRoomMemberPropertyChangeEvent evt =
new ChatRoomMemberPropertyChangeEvent(member,
this.chatroom,
ChatRoomMemberPropertyChangeEvent.MEMBER_NICKNAME,
oldNick, newNick);
this.chatroom.fireMemberPropertyChangeEvent(evt);
}
}
/**
* Event in case of channel message arrival.
*
* @param msg channel message
*/
@Override
public void onChannelMessage(final ChannelPrivMsg msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
final MessageIrcImpl message =
MessageIrcImpl.newMessageFromIRC(msg.getText());
// FIXME why create a new instance?
final ChatRoomMemberIrcImpl member =
new ChatRoomMemberIrcImpl(ChannelManager.this.provider,
this.chatroom, msg.getSource().getNick(), msg.getSource()
.getIdent(), msg.getSource().getHostname(),
ChatRoomMemberRole.MEMBER, IrcStatusEnum.ONLINE);
this.chatroom.fireMessageReceivedEvent(message, member, new Date(),
ChatRoomMessageReceivedEvent.CONVERSATION_MESSAGE_RECEIVED);
}
/**
* Event in case of channel action message arrival.
*
* @param msg channel action message
*/
@Override
public void onChannelAction(final ChannelActionMsg msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
String userNick = msg.getSource().getNick();
// FIXME why create a new instance?
ChatRoomMemberIrcImpl member =
new ChatRoomMemberIrcImpl(ChannelManager.this.provider,
this.chatroom, userNick, msg.getSource().getIdent(), msg
.getSource().getHostname(), ChatRoomMemberRole.MEMBER,
IrcStatusEnum.ONLINE);
MessageIrcImpl message =
MessageIrcImpl.newActionFromIRC(msg.getText());
this.chatroom.fireMessageReceivedEvent(message, member, new Date(),
ChatRoomMessageReceivedEvent.CONVERSATION_MESSAGE_RECEIVED);
}
/**
* Event in case of channel notice message arrival.
*
* @param msg channel notice message
*/
@Override
public void onChannelNotice(final ChannelNotice msg)
{
if (!isThisChatRoom(msg.getChannelName()))
{
return;
}
final String userNick = msg.getSource().getNick();
// FIXME why create a new instance?
final ChatRoomMemberIrcImpl member =
new ChatRoomMemberIrcImpl(ChannelManager.this.provider,
this.chatroom, userNick, msg.getSource().getIdent(), msg
.getSource().getHostname(), ChatRoomMemberRole.MEMBER,
IrcStatusEnum.ONLINE);
final MessageIrcImpl message =
MessageIrcImpl.newNoticeFromIRC(member, msg.getText());
this.chatroom.fireMessageReceivedEvent(message, member, new Date(),
ChatRoomMessageReceivedEvent.CONVERSATION_MESSAGE_RECEIVED);
}
/**
* Leave this chat room.
*/
private void leaveChatRoom()
{
this.presenceTaskTimer.cancel();
this.irc.deleteListener(this);
ChannelManager.this.joined.remove(this.chatroom.getIdentifier());
LOGGER.debug("Leaving chat room " + this.chatroom.getIdentifier()
+ ". Chat room listener removed.");
ChannelManager.this.provider.getMUC().fireLocalUserPresenceEvent(
this.chatroom,
LocalUserChatRoomPresenceChangeEvent.LOCAL_USER_LEFT, null);
}
/**
* Process mode changes.
*
* @param msg raw mode message
*/
private void processModeMessage(final ChannelModeMessage msg)
{
final ChatRoomMemberIrcImpl source = extractChatRoomMember(msg);
final ModeParser parser = new ModeParser(msg.getModeStr());
for (ModeEntry mode : parser.getModes())
{
switch (mode.getMode())
{
case OWNER:
case OPERATOR:
case HALFOP:
case VOICE:
processRoleChange(source, mode);
break;
case LIMIT:
processLimitChange(source, mode);
break;
case BAN:
processBanChange(source, mode);
break;
case UNKNOWN:
if (LOGGER.isInfoEnabled())
{
LOGGER.info("Unknown mode: "
+ (mode.isAdded() ? "+" : "-")
+ mode.getParams()[0] + ". Original mode string: '"
+ msg.getModeStr() + "'");
}
break;
default:
if (LOGGER.isInfoEnabled())
{
LOGGER.info("Unsupported mode '"
+ (mode.isAdded() ? "+" : "-") + mode.getMode()
+ "' (from modestring '" + msg.getModeStr() + "')");
}
break;
}
}
}
/**
* Process changes for ban patterns.
*
* @param sourceMember the originating member
* @param mode the ban mode change
*/
private void processBanChange(final ChatRoomMemberIrcImpl sourceMember,
final ModeEntry mode)
{
final MessageIrcImpl banMessage =
new MessageIrcImpl(
"channel ban mask was "
+ (mode.isAdded() ? "added" : "removed")
+ ": "
+ mode.getParams()[0]
+ " by "
+ (sourceMember.getContactAddress().length() == 0
? "server"
: sourceMember.getContactAddress()),
MessageIrcImpl.DEFAULT_MIME_TYPE,
MessageIrcImpl.DEFAULT_MIME_ENCODING, null);
this.chatroom.fireMessageReceivedEvent(banMessage, sourceMember,
new Date(),
ChatRoomMessageReceivedEvent.SYSTEM_MESSAGE_RECEIVED);
}
/**
* Process mode changes resulting in role manipulation.
*
* @param sourceMember the originating member
* @param mode the mode change
*/
private void processRoleChange(
final ChatRoomMemberIrcImpl sourceMember, final ModeEntry mode)
{
final String targetNick = mode.getParams()[0];
final ChatRoomMemberIrcImpl targetMember =
(ChatRoomMemberIrcImpl) this.chatroom
.getChatRoomMember(targetNick);
final ChatRoomMemberRole originalRole = targetMember.getRole();
if (mode.isAdded())
{
targetMember.addRole(mode.getMode().getRole());
}
else
{
targetMember.removeRole(mode.getMode().getRole());
}
final ChatRoomMemberRole newRole = targetMember.getRole();
if (newRole != originalRole)
{
// Mode change actually caused a role change.
final ChatRoomLocalUserRoleChangeEvent event =
new ChatRoomLocalUserRoleChangeEvent(this.chatroom,
originalRole, newRole, false);
if (localUser(targetMember.getContactAddress()))
{
this.chatroom.fireLocalUserRoleChangedEvent(event);
}
else
{
this.chatroom.fireMemberRoleEvent(targetMember,
newRole);
}
}
else
{
// Mode change did not cause an immediate role change.
// Display a system message for the mode change.
final String text =
sourceMember.getName()
+ (mode.isAdded() ? " gives "
+ mode.getMode().name().toLowerCase()
+ " to " : " removes "
+ mode.getMode().name().toLowerCase()
+ " from ") + targetMember.getName();
final MessageIrcImpl message =
new MessageIrcImpl(text,
MessageIrcImpl.DEFAULT_MIME_TYPE,
MessageIrcImpl.DEFAULT_MIME_ENCODING, null);
this.chatroom
.fireMessageReceivedEvent(
message,
sourceMember,
new Date(),
ChatRoomMessageReceivedEvent.SYSTEM_MESSAGE_RECEIVED);
}
}
/**
* Process mode change that represents a channel limit modification.
*
* @param sourceMember the originating member
* @param mode the limit mode change
*/
private void processLimitChange(
final ChatRoomMemberIrcImpl sourceMember, final ModeEntry mode)
{
final MessageIrcImpl limitMessage;
if (mode.isAdded())
{
try
{
limitMessage =
new MessageIrcImpl(
"channel limit set to "
+ Integer.parseInt(mode.getParams()[0])
+ " by "
+ (sourceMember.getContactAddress()
.length() == 0
? "server"
: sourceMember.getContactAddress()),
"text/plain", "UTF-8", null);
}
catch (NumberFormatException e)
{
LOGGER.warn("server sent incorrect limit: "
+ "limit is not a number", e);
return;
}
}
else
{
// TODO "server" is now easily fakeable if someone
// calls himself server. There should be some other way
// to represent the server if a message comes from
// something other than a normal chat room member.
limitMessage =
new MessageIrcImpl(
"channel limit removed by "
+ (sourceMember.getContactAddress().length() == 0
? "server"
: sourceMember.getContactAddress()),
"text/plain", "UTF-8", null);
}
this.chatroom.fireMessageReceivedEvent(limitMessage, sourceMember,
new Date(),
ChatRoomMessageReceivedEvent.SYSTEM_MESSAGE_RECEIVED);
}
/**
* Extract chat room member identifier from message.
*
* @param msg raw mode message
* @return returns member instance
*/
private ChatRoomMemberIrcImpl extractChatRoomMember(
final ChannelModeMessage msg)
{
ChatRoomMemberIrcImpl member;
ISource source = msg.getSource();
if (source instanceof IRCServer)
{
// TODO Created chat room member with creepy empty contact ID.
// Interacting with this contact might screw up other sections
// of code which is not good. Is there a better way to represent
// an IRC server as a chat room member?
member =
new ChatRoomMemberIrcImpl(ChannelManager.this.provider,
this.chatroom, "", "", "",
ChatRoomMemberRole.ADMINISTRATOR, IrcStatusEnum.ONLINE);
}
else if (source instanceof IRCUser)
{
String nick = ((IRCUser) source).getNick();
member =
(ChatRoomMemberIrcImpl) this.chatroom
.getChatRoomMember(nick);
}
else
{
throw new IllegalArgumentException("Unknown source type: "
+ source.getClass().getName());
}
return member;
}
/**
* Test whether this listener corresponds to the chat room.
*
* @param chatRoomName chat room name
* @return returns true if this listener applies, false otherwise
*/
private boolean isThisChatRoom(final String chatRoomName)
{
return this.chatroom.getIdentifier().equalsIgnoreCase(chatRoomName);
}
/**
* Test whether the source user is this user.
*
* @param user the source user
* @return returns true if this use, or false otherwise
*/
private boolean localUser(final IRCUser user)
{
return localUser(user.getNick());
}
}
}
|