1package eu.siacs.conversations.entities;
2
3import android.annotation.SuppressLint;
4
5import java.util.ArrayList;
6import java.util.HashSet;
7import java.util.List;
8import java.util.Set;
9
10import eu.siacs.conversations.R;
11import eu.siacs.conversations.xml.Namespace;
12import eu.siacs.conversations.xmpp.forms.Data;
13import eu.siacs.conversations.xmpp.forms.Field;
14import eu.siacs.conversations.xmpp.jid.InvalidJidException;
15import eu.siacs.conversations.xmpp.jid.Jid;
16import eu.siacs.conversations.xmpp.pep.Avatar;
17
18@SuppressLint("DefaultLocale")
19public class MucOptions {
20
21 private boolean mAutoPushConfiguration = true;
22
23 public Account getAccount() {
24 return this.conversation.getAccount();
25 }
26
27 public void setSelf(User user) {
28 this.self = user;
29 }
30
31 public void changeAffiliation(Jid jid, Affiliation affiliation) {
32 User user = findUserByRealJid(jid);
33 synchronized (users) {
34 if (user != null && user.getRole() == Role.NONE) {
35 users.remove(user);
36 if (affiliation.ranks(Affiliation.MEMBER)) {
37 user.affiliation = affiliation;
38 users.add(user);
39 }
40 }
41 }
42 }
43
44 public void flagNoAutoPushConfiguration() {
45 mAutoPushConfiguration = false;
46 }
47
48 public boolean autoPushConfiguration() {
49 return mAutoPushConfiguration;
50 }
51
52 public enum Affiliation {
53 OWNER("owner", 4, R.string.owner),
54 ADMIN("admin", 3, R.string.admin),
55 MEMBER("member", 2, R.string.member),
56 OUTCAST("outcast", 0, R.string.outcast),
57 NONE("none", 1, R.string.no_affiliation);
58
59 Affiliation(String string, int rank, int resId) {
60 this.string = string;
61 this.resId = resId;
62 this.rank = rank;
63 }
64
65 private String string;
66 private int resId;
67 private int rank;
68
69 public int getResId() {
70 return resId;
71 }
72
73 @Override
74 public String toString() {
75 return this.string;
76 }
77
78 public boolean outranks(Affiliation affiliation) {
79 return rank > affiliation.rank;
80 }
81
82 public boolean ranks(Affiliation affiliation) {
83 return rank >= affiliation.rank;
84 }
85 }
86
87 public enum Role {
88 MODERATOR("moderator", R.string.moderator,3),
89 VISITOR("visitor", R.string.visitor,1),
90 PARTICIPANT("participant", R.string.participant,2),
91 NONE("none", R.string.no_role,0);
92
93 Role(String string, int resId, int rank) {
94 this.string = string;
95 this.resId = resId;
96 this.rank = rank;
97 }
98
99 private String string;
100 private int resId;
101 private int rank;
102
103 public int getResId() {
104 return resId;
105 }
106
107 @Override
108 public String toString() {
109 return this.string;
110 }
111
112 public boolean ranks(Role role) {
113 return rank >= role.rank;
114 }
115 }
116
117 public enum Error {
118 NO_RESPONSE,
119 SERVER_NOT_FOUND,
120 NONE,
121 NICK_IN_USE,
122 PASSWORD_REQUIRED,
123 BANNED,
124 MEMBERS_ONLY,
125 KICKED,
126 SHUTDOWN,
127 UNKNOWN
128 }
129
130 public static final String STATUS_CODE_SELF_PRESENCE = "110";
131 public static final String STATUS_CODE_ROOM_CREATED = "201";
132 public static final String STATUS_CODE_BANNED = "301";
133 public static final String STATUS_CODE_CHANGED_NICK = "303";
134 public static final String STATUS_CODE_KICKED = "307";
135 public static final String STATUS_CODE_AFFILIATION_CHANGE = "321";
136 public static final String STATUS_CODE_LOST_MEMBERSHIP = "322";
137 public static final String STATUS_CODE_SHUTDOWN = "332";
138
139 private interface OnEventListener {
140 void onSuccess();
141
142 void onFailure();
143 }
144
145 public interface OnRenameListener extends OnEventListener {
146
147 }
148
149 public static class User implements Comparable<User> {
150 private Role role = Role.NONE;
151 private Affiliation affiliation = Affiliation.NONE;
152 private Jid realJid;
153 private Jid fullJid;
154 private long pgpKeyId = 0;
155 private Avatar avatar;
156 private MucOptions options;
157
158 public User(MucOptions options, Jid from) {
159 this.options = options;
160 this.fullJid = from;
161 }
162
163 public String getName() {
164 return fullJid == null ? null : fullJid.getResourcepart();
165 }
166
167 public void setRealJid(Jid jid) {
168 this.realJid = jid != null ? jid.toBareJid() : null;
169 }
170
171 public Role getRole() {
172 return this.role;
173 }
174
175 public void setRole(String role) {
176 if (role == null) {
177 this.role = Role.NONE;
178 return;
179 }
180 role = role.toLowerCase();
181 switch (role) {
182 case "moderator":
183 this.role = Role.MODERATOR;
184 break;
185 case "participant":
186 this.role = Role.PARTICIPANT;
187 break;
188 case "visitor":
189 this.role = Role.VISITOR;
190 break;
191 default:
192 this.role = Role.NONE;
193 break;
194 }
195 }
196
197 public Affiliation getAffiliation() {
198 return this.affiliation;
199 }
200
201 public void setAffiliation(String affiliation) {
202 if (affiliation == null) {
203 this.affiliation = Affiliation.NONE;
204 return;
205 }
206 affiliation = affiliation.toLowerCase();
207 switch (affiliation) {
208 case "admin":
209 this.affiliation = Affiliation.ADMIN;
210 break;
211 case "owner":
212 this.affiliation = Affiliation.OWNER;
213 break;
214 case "member":
215 this.affiliation = Affiliation.MEMBER;
216 break;
217 case "outcast":
218 this.affiliation = Affiliation.OUTCAST;
219 break;
220 default:
221 this.affiliation = Affiliation.NONE;
222 }
223 }
224
225 public void setPgpKeyId(long id) {
226 this.pgpKeyId = id;
227 }
228
229 public long getPgpKeyId() {
230 return this.pgpKeyId;
231 }
232
233 public Contact getContact() {
234 if (fullJid != null) {
235 return getAccount().getRoster().getContactFromRoster(realJid);
236 } else if (realJid != null){
237 return getAccount().getRoster().getContact(realJid);
238 } else {
239 return null;
240 }
241 }
242
243 public boolean setAvatar(Avatar avatar) {
244 if (this.avatar != null && this.avatar.equals(avatar)) {
245 return false;
246 } else {
247 this.avatar = avatar;
248 return true;
249 }
250 }
251
252 public String getAvatar() {
253 return avatar == null ? null : avatar.getFilename();
254 }
255
256 public Account getAccount() {
257 return options.getAccount();
258 }
259
260 public Jid getFullJid() {
261 return fullJid;
262 }
263
264 @Override
265 public boolean equals(Object o) {
266 if (this == o) return true;
267 if (o == null || getClass() != o.getClass()) return false;
268
269 User user = (User) o;
270
271 if (role != user.role) return false;
272 if (affiliation != user.affiliation) return false;
273 if (realJid != null ? !realJid.equals(user.realJid) : user.realJid != null)
274 return false;
275 return fullJid != null ? fullJid.equals(user.fullJid) : user.fullJid == null;
276
277 }
278
279 @Override
280 public int hashCode() {
281 int result = role != null ? role.hashCode() : 0;
282 result = 31 * result + (affiliation != null ? affiliation.hashCode() : 0);
283 result = 31 * result + (realJid != null ? realJid.hashCode() : 0);
284 result = 31 * result + (fullJid != null ? fullJid.hashCode() : 0);
285 return result;
286 }
287
288 @Override
289 public String toString() {
290 return "[fulljid:"+String.valueOf(fullJid)+",realjid:"+String.valueOf(realJid)+",affiliation"+affiliation.toString()+"]";
291 }
292
293 public boolean realJidMatchesAccount() {
294 return realJid != null && realJid.equals(options.account.getJid().toBareJid());
295 }
296
297 @Override
298 public int compareTo(User another) {
299 if (another.getAffiliation().outranks(getAffiliation())) {
300 return 1;
301 } else if (getAffiliation().outranks(another.getAffiliation())) {
302 return -1;
303 } else {
304 return getComparableName().compareToIgnoreCase(another.getComparableName());
305 }
306 }
307
308
309 private String getComparableName() {
310 Contact contact = getContact();
311 if (contact != null) {
312 return contact.getDisplayName();
313 } else {
314 String name = getName();
315 return name == null ? "" : name;
316 }
317 }
318
319 public Jid getRealJid() {
320 return realJid;
321 }
322 }
323
324 private Account account;
325 private final Set<User> users = new HashSet<>();
326 private final List<String> features = new ArrayList<>();
327 private Data form = new Data();
328 private Conversation conversation;
329 private boolean isOnline = false;
330 private Error error = Error.NONE;
331 public OnRenameListener onRenameListener = null;
332 private User self;
333 private String subject = null;
334 private String password = null;
335
336 public MucOptions(Conversation conversation) {
337 this.account = conversation.getAccount();
338 this.conversation = conversation;
339 this.self = new User(this,createJoinJid(getProposedNick()));
340 }
341
342 public void updateFeatures(ArrayList<String> features) {
343 this.features.clear();
344 this.features.addAll(features);
345 }
346
347 public void updateFormData(Data form) {
348 this.form = form;
349 }
350
351 public boolean hasFeature(String feature) {
352 return this.features.contains(feature);
353 }
354
355 public boolean canInvite() {
356 Field field = this.form.getFieldByName("muc#roomconfig_allowinvites");
357 return !membersOnly() || self.getRole().ranks(Role.MODERATOR) || (field != null && "1".equals(field.getValue()));
358 }
359
360 public boolean canChangeSubject() {
361 Field field = this.form.getFieldByName("muc#roomconfig_changesubject");
362 return self.getRole().ranks(Role.MODERATOR) || (field != null && "1".equals(field.getValue()));
363 }
364
365 public boolean participating() {
366 return !online()
367 || self.getRole().ranks(Role.PARTICIPANT)
368 || hasFeature("muc_unmoderated");
369 }
370
371 public boolean membersOnly() {
372 return hasFeature("muc_membersonly");
373 }
374
375 public boolean mamSupport() {
376 return hasFeature(Namespace.MAM) || hasFeature(Namespace.MAM_LEGACY);
377 }
378
379 public boolean mamLegacy() {
380 return hasFeature(Namespace.MAM_LEGACY) && !hasFeature(Namespace.MAM);
381 }
382
383 public boolean nonanonymous() {
384 return hasFeature("muc_nonanonymous");
385 }
386
387 public boolean persistent() {
388 return hasFeature("muc_persistent");
389 }
390
391 public boolean moderated() {
392 return hasFeature("muc_moderated");
393 }
394
395 public User deleteUser(Jid jid) {
396 User user = findUserByFullJid(jid);
397 if (user != null) {
398 synchronized (users) {
399 users.remove(user);
400 boolean realJidInMuc = false;
401 for (User u : users) {
402 if (user.realJid != null && user.realJid.equals(u.realJid)) {
403 realJidInMuc = true;
404 break;
405 }
406 }
407 boolean self = user.realJid != null && user.realJid.equals(account.getJid().toBareJid());
408 if (membersOnly()
409 && nonanonymous()
410 && user.affiliation.ranks(Affiliation.MEMBER)
411 && user.realJid != null
412 && !realJidInMuc
413 && !self) {
414 user.role = Role.NONE;
415 user.avatar = null;
416 user.fullJid = null;
417 users.add(user);
418 }
419 }
420 }
421 return user;
422 }
423
424 public void updateUser(User user) {
425 User old;
426 if (user.fullJid == null && user.realJid != null) {
427 old = findUserByRealJid(user.realJid);
428 if (old != null) {
429 if (old.fullJid != null) {
430 return; //don't add. user already exists
431 } else {
432 synchronized (users) {
433 users.remove(old);
434 }
435 }
436 }
437 } else if (user.realJid != null) {
438 old = findUserByRealJid(user.realJid);
439 synchronized (users) {
440 if (old != null && old.fullJid == null) {
441 users.remove(old);
442 }
443 }
444 }
445 old = findUserByFullJid(user.getFullJid());
446 synchronized (this.users) {
447 if (old != null) {
448 users.remove(old);
449 }
450 boolean fullJidIsSelf = isOnline && user.getFullJid() != null && user.getFullJid().equals(self.getFullJid());
451 if ((!membersOnly() || user.getAffiliation().ranks(Affiliation.MEMBER))
452 && user.getAffiliation().outranks(Affiliation.OUTCAST)
453 && !fullJidIsSelf){
454 this.users.add(user);
455 }
456 }
457 }
458
459 public User findUserByFullJid(Jid jid) {
460 if (jid == null) {
461 return null;
462 }
463 synchronized (users) {
464 for (User user : users) {
465 if (jid.equals(user.getFullJid())) {
466 return user;
467 }
468 }
469 }
470 return null;
471 }
472
473 private User findUserByRealJid(Jid jid) {
474 if (jid == null) {
475 return null;
476 }
477 synchronized (users) {
478 for (User user : users) {
479 if (jid.equals(user.realJid)) {
480 return user;
481 }
482 }
483 }
484 return null;
485 }
486
487 public boolean isContactInRoom(Contact contact) {
488 return findUserByRealJid(contact.getJid().toBareJid()) != null;
489 }
490
491 public boolean isUserInRoom(Jid jid) {
492 return findUserByFullJid(jid) != null;
493 }
494
495 public void setError(Error error) {
496 this.isOnline = isOnline && error == Error.NONE;
497 this.error = error;
498 }
499
500 public void setOnline() {
501 this.isOnline = true;
502 }
503
504 public ArrayList<User> getUsers() {
505 return getUsers(true);
506 }
507
508 public ArrayList<User> getUsers(boolean includeOffline) {
509 synchronized (users) {
510 if (includeOffline) {
511 return new ArrayList<>(users);
512 } else {
513 ArrayList<User> onlineUsers = new ArrayList<>();
514 for (User user : users) {
515 if (user.getRole().ranks(Role.PARTICIPANT)) {
516 onlineUsers.add(user);
517 }
518 }
519 return onlineUsers;
520 }
521 }
522 }
523
524 public List<User> getUsers(int max) {
525 ArrayList<User> subset = new ArrayList<>();
526 HashSet<Jid> jids = new HashSet<>();
527 jids.add(account.getJid().toBareJid());
528 synchronized (users) {
529 for(User user : users) {
530 if (user.getRealJid() == null || jids.add(user.getRealJid())) {
531 subset.add(user);
532 }
533 if (subset.size() >= max) {
534 break;
535 }
536 }
537 }
538 return subset;
539 }
540
541 public int getUserCount() {
542 synchronized (users) {
543 return users.size();
544 }
545 }
546
547 public String getProposedNick() {
548 if (conversation.getBookmark() != null
549 && conversation.getBookmark().getNick() != null
550 && !conversation.getBookmark().getNick().trim().isEmpty()) {
551 return conversation.getBookmark().getNick().trim();
552 } else if (!conversation.getJid().isBareJid()) {
553 return conversation.getJid().getResourcepart();
554 } else {
555 return account.getUsername();
556 }
557 }
558
559 public String getActualNick() {
560 if (this.self.getName() != null) {
561 return this.self.getName();
562 } else {
563 return this.getProposedNick();
564 }
565 }
566
567 public boolean online() {
568 return this.isOnline;
569 }
570
571 public Error getError() {
572 return this.error;
573 }
574
575 public void setOnRenameListener(OnRenameListener listener) {
576 this.onRenameListener = listener;
577 }
578
579 public void setOffline() {
580 synchronized (users) {
581 this.users.clear();
582 }
583 this.error = Error.NO_RESPONSE;
584 this.isOnline = false;
585 }
586
587 public User getSelf() {
588 return self;
589 }
590
591 public void setSubject(String content) {
592 this.subject = content;
593 }
594
595 public String getSubject() {
596 return this.subject;
597 }
598
599 public String createNameFromParticipants() {
600 if (getUserCount() >= 2) {
601 List<String> names = new ArrayList<>();
602 for (User user : getUsers(5)) {
603 Contact contact = user.getContact();
604 if (contact != null && !contact.getDisplayName().isEmpty()) {
605 names.add(contact.getDisplayName().split("\\s+")[0]);
606 } else if (user.getName() != null){
607 names.add(user.getName());
608 }
609 }
610 StringBuilder builder = new StringBuilder();
611 for (int i = 0; i < names.size(); ++i) {
612 builder.append(names.get(i));
613 if (i != names.size() - 1) {
614 builder.append(", ");
615 }
616 }
617 return builder.toString();
618 } else {
619 return null;
620 }
621 }
622
623 public long[] getPgpKeyIds() {
624 List<Long> ids = new ArrayList<>();
625 for (User user : this.users) {
626 if (user.getPgpKeyId() != 0) {
627 ids.add(user.getPgpKeyId());
628 }
629 }
630 ids.add(account.getPgpId());
631 long[] primitiveLongArray = new long[ids.size()];
632 for (int i = 0; i < ids.size(); ++i) {
633 primitiveLongArray[i] = ids.get(i);
634 }
635 return primitiveLongArray;
636 }
637
638 public boolean pgpKeysInUse() {
639 synchronized (users) {
640 for (User user : users) {
641 if (user.getPgpKeyId() != 0) {
642 return true;
643 }
644 }
645 }
646 return false;
647 }
648
649 public boolean everybodyHasKeys() {
650 synchronized (users) {
651 for (User user : users) {
652 if (user.getPgpKeyId() == 0) {
653 return false;
654 }
655 }
656 }
657 return true;
658 }
659
660 public Jid createJoinJid(String nick) {
661 try {
662 return Jid.fromString(this.conversation.getJid().toBareJid().toString() + "/" + nick);
663 } catch (final InvalidJidException e) {
664 return null;
665 }
666 }
667
668 public Jid getTrueCounterpart(Jid jid) {
669 if (jid.equals(getSelf().getFullJid())) {
670 return account.getJid().toBareJid();
671 }
672 User user = findUserByFullJid(jid);
673 return user == null ? null : user.realJid;
674 }
675
676 public String getPassword() {
677 this.password = conversation.getAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD);
678 if (this.password == null && conversation.getBookmark() != null
679 && conversation.getBookmark().getPassword() != null) {
680 return conversation.getBookmark().getPassword();
681 } else {
682 return this.password;
683 }
684 }
685
686 public void setPassword(String password) {
687 if (conversation.getBookmark() != null) {
688 conversation.getBookmark().setPassword(password);
689 } else {
690 this.password = password;
691 }
692 conversation.setAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD, password);
693 }
694
695 public Conversation getConversation() {
696 return this.conversation;
697 }
698
699 public List<Jid> getMembers() {
700 ArrayList<Jid> members = new ArrayList<>();
701 synchronized (users) {
702 for (User user : users) {
703 if (user.affiliation.ranks(Affiliation.MEMBER) && user.realJid != null) {
704 members.add(user.realJid);
705 }
706 }
707 }
708 return members;
709 }
710}