1package eu.siacs.conversations.entities;
2
3import android.annotation.SuppressLint;
4
5import java.util.ArrayList;
6import java.util.Collections;
7import java.util.HashSet;
8import java.util.List;
9import java.util.Set;
10
11import eu.siacs.conversations.R;
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 NONE,
120 NICK_IN_USE,
121 PASSWORD_REQUIRED,
122 BANNED,
123 MEMBERS_ONLY,
124 KICKED,
125 SHUTDOWN,
126 UNKNOWN
127 }
128
129 public static final String STATUS_CODE_ROOM_CONFIG_CHANGED = "104";
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 Contact ourContact = getContact();
305 Contact anotherContact = another.getContact();
306 if (ourContact != null && anotherContact != null) {
307 return ourContact.compareTo(anotherContact);
308 } else if (ourContact == null && anotherContact != null) {
309 return getName().compareToIgnoreCase(anotherContact.getDisplayName());
310 } else if (ourContact != null) {
311 return ourContact.getDisplayName().compareToIgnoreCase(another.getName());
312 } else {
313 return getName().compareToIgnoreCase(another.getName());
314 }
315 }
316 }
317
318 public Jid getRealJid() {
319 return realJid;
320 }
321 }
322
323 private Account account;
324 private final Set<User> users = new HashSet<>();
325 private final List<String> features = new ArrayList<>();
326 private Data form = new Data();
327 private Conversation conversation;
328 private boolean isOnline = false;
329 private Error error = Error.NONE;
330 public OnRenameListener onRenameListener = null;
331 private User self;
332 private String subject = null;
333 private String password = null;
334 public boolean mNickChangingInProgress = false;
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 // Update with "urn:xmpp:mam:1" once we support it
377 return hasFeature("urn:xmpp:mam:0");
378 }
379
380 public boolean nonanonymous() {
381 return hasFeature("muc_nonanonymous");
382 }
383
384 public boolean persistent() {
385 return hasFeature("muc_persistent");
386 }
387
388 public boolean moderated() {
389 return hasFeature("muc_moderated");
390 }
391
392 public User deleteUser(Jid jid) {
393 User user = findUserByFullJid(jid);
394 if (user != null) {
395 synchronized (users) {
396 users.remove(user);
397 if (membersOnly() &&
398 nonanonymous() &&
399 user.affiliation.ranks(Affiliation.MEMBER) &&
400 user.realJid != null) {
401 user.role = Role.NONE;
402 user.avatar = null;
403 user.fullJid = null;
404 users.add(user);
405 }
406 }
407 }
408 return user;
409 }
410
411 public void addUser(User user) {
412 User old;
413 if (user.fullJid == null && user.realJid != null) {
414 old = findUserByRealJid(user.realJid);
415 if (old != null) {
416 if (old.fullJid != null) {
417 return; //don't add. user already exists
418 } else {
419 synchronized (users) {
420 users.remove(old);
421 }
422 }
423 }
424 } else if (user.realJid != null) {
425 old = findUserByRealJid(user.realJid);
426 synchronized (users) {
427 if (old != null && old.fullJid == null) {
428 users.remove(old);
429 }
430 }
431 }
432 old = findUserByFullJid(user.getFullJid());
433 synchronized (this.users) {
434 if (old != null) {
435 users.remove(old);
436 }
437 this.users.add(user);
438 }
439 }
440
441 public User findUserByFullJid(Jid jid) {
442 if (jid == null) {
443 return null;
444 }
445 synchronized (users) {
446 for (User user : users) {
447 if (jid.equals(user.getFullJid())) {
448 return user;
449 }
450 }
451 }
452 return null;
453 }
454
455 private User findUserByRealJid(Jid jid) {
456 if (jid == null) {
457 return null;
458 }
459 synchronized (users) {
460 for (User user : users) {
461 if (jid.equals(user.realJid)) {
462 return user;
463 }
464 }
465 }
466 return null;
467 }
468
469 public boolean isContactInRoom(Contact contact) {
470 return findUserByRealJid(contact.getJid().toBareJid()) != null;
471 }
472
473 public boolean isUserInRoom(Jid jid) {
474 return findUserByFullJid(jid) != null;
475 }
476
477 public void setError(Error error) {
478 this.isOnline = isOnline && error == Error.NONE;
479 this.error = error;
480 }
481
482 public void setOnline() {
483 this.isOnline = true;
484 }
485
486 public ArrayList<User> getUsers() {
487 return getUsers(true);
488 }
489
490 public ArrayList<User> getUsers(boolean includeOffline) {
491 synchronized (users) {
492 if (includeOffline) {
493 return new ArrayList<>(users);
494 } else {
495 ArrayList<User> onlineUsers = new ArrayList<>();
496 for (User user : users) {
497 if (user.getRole().ranks(Role.PARTICIPANT)) {
498 onlineUsers.add(user);
499 }
500 }
501 return onlineUsers;
502 }
503 }
504 }
505
506 public List<User> getUsers(int max) {
507 ArrayList<User> users = getUsers();
508 return users.subList(0, Math.min(max, users.size()));
509 }
510
511 public int getUserCount() {
512 synchronized (users) {
513 return users.size();
514 }
515 }
516
517 public String getProposedNick() {
518 if (conversation.getBookmark() != null
519 && conversation.getBookmark().getNick() != null
520 && !conversation.getBookmark().getNick().trim().isEmpty()) {
521 return conversation.getBookmark().getNick().trim();
522 } else if (!conversation.getJid().isBareJid()) {
523 return conversation.getJid().getResourcepart();
524 } else {
525 return account.getUsername();
526 }
527 }
528
529 public String getActualNick() {
530 if (this.self.getName() != null) {
531 return this.self.getName();
532 } else {
533 return this.getProposedNick();
534 }
535 }
536
537 public boolean online() {
538 return this.isOnline;
539 }
540
541 public Error getError() {
542 return this.error;
543 }
544
545 public void setOnRenameListener(OnRenameListener listener) {
546 this.onRenameListener = listener;
547 }
548
549 public void setOffline() {
550 synchronized (users) {
551 this.users.clear();
552 }
553 this.error = Error.NO_RESPONSE;
554 this.isOnline = false;
555 }
556
557 public User getSelf() {
558 return self;
559 }
560
561 public void setSubject(String content) {
562 this.subject = content;
563 }
564
565 public String getSubject() {
566 return this.subject;
567 }
568
569 public String createNameFromParticipants() {
570 if (getUserCount() >= 2) {
571 List<String> names = new ArrayList<>();
572 for (User user : getUsers(5)) {
573 Contact contact = user.getContact();
574 if (contact != null && !contact.getDisplayName().isEmpty()) {
575 names.add(contact.getDisplayName().split("\\s+")[0]);
576 } else if (user.getName() != null){
577 names.add(user.getName());
578 }
579 }
580 StringBuilder builder = new StringBuilder();
581 for (int i = 0; i < names.size(); ++i) {
582 builder.append(names.get(i));
583 if (i != names.size() - 1) {
584 builder.append(", ");
585 }
586 }
587 return builder.toString();
588 } else {
589 return null;
590 }
591 }
592
593 public long[] getPgpKeyIds() {
594 List<Long> ids = new ArrayList<>();
595 for (User user : this.users) {
596 if (user.getPgpKeyId() != 0) {
597 ids.add(user.getPgpKeyId());
598 }
599 }
600 ids.add(account.getPgpId());
601 long[] primitiveLongArray = new long[ids.size()];
602 for (int i = 0; i < ids.size(); ++i) {
603 primitiveLongArray[i] = ids.get(i);
604 }
605 return primitiveLongArray;
606 }
607
608 public boolean pgpKeysInUse() {
609 synchronized (users) {
610 for (User user : users) {
611 if (user.getPgpKeyId() != 0) {
612 return true;
613 }
614 }
615 }
616 return false;
617 }
618
619 public boolean everybodyHasKeys() {
620 synchronized (users) {
621 for (User user : users) {
622 if (user.getPgpKeyId() == 0) {
623 return false;
624 }
625 }
626 }
627 return true;
628 }
629
630 public Jid createJoinJid(String nick) {
631 try {
632 return Jid.fromString(this.conversation.getJid().toBareJid().toString() + "/" + nick);
633 } catch (final InvalidJidException e) {
634 return null;
635 }
636 }
637
638 public Jid getTrueCounterpart(Jid jid) {
639 if (jid.equals(getSelf().getFullJid())) {
640 return account.getJid().toBareJid();
641 }
642 User user = findUserByFullJid(jid);
643 return user == null ? null : user.realJid;
644 }
645
646 public String getPassword() {
647 this.password = conversation.getAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD);
648 if (this.password == null && conversation.getBookmark() != null
649 && conversation.getBookmark().getPassword() != null) {
650 return conversation.getBookmark().getPassword();
651 } else {
652 return this.password;
653 }
654 }
655
656 public void setPassword(String password) {
657 if (conversation.getBookmark() != null) {
658 conversation.getBookmark().setPassword(password);
659 } else {
660 this.password = password;
661 }
662 conversation.setAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD, password);
663 }
664
665 public Conversation getConversation() {
666 return this.conversation;
667 }
668
669 public List<Jid> getMembers() {
670 ArrayList<Jid> members = new ArrayList<>();
671 synchronized (users) {
672 for (User user : users) {
673 if (user.affiliation.ranks(Affiliation.MEMBER) && user.realJid != null) {
674 members.add(user.realJid);
675 }
676 }
677 }
678 return members;
679 }
680}