MucOptions.java

  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		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	public boolean mNickChangingInProgress = false;
336
337	public MucOptions(Conversation conversation) {
338		this.account = conversation.getAccount();
339		this.conversation = conversation;
340		this.self = new User(this,createJoinJid(getProposedNick()));
341	}
342
343	public void updateFeatures(ArrayList<String> features) {
344		this.features.clear();
345		this.features.addAll(features);
346	}
347
348	public void updateFormData(Data form) {
349		this.form = form;
350	}
351
352	public boolean hasFeature(String feature) {
353		return this.features.contains(feature);
354	}
355
356	public boolean canInvite() {
357		Field field = this.form.getFieldByName("muc#roomconfig_allowinvites");
358		return !membersOnly() || self.getRole().ranks(Role.MODERATOR) || (field != null && "1".equals(field.getValue()));
359	}
360
361	public boolean canChangeSubject() {
362		Field field = this.form.getFieldByName("muc#roomconfig_changesubject");
363		return self.getRole().ranks(Role.MODERATOR) || (field != null && "1".equals(field.getValue()));
364	}
365
366	public boolean participating() {
367		return !online()
368				|| self.getRole().ranks(Role.PARTICIPANT)
369				|| hasFeature("muc_unmoderated");
370	}
371
372	public boolean membersOnly() {
373		return hasFeature("muc_membersonly");
374	}
375
376	public boolean mamSupport() {
377		// Update with "urn:xmpp:mam:1" once we support it
378		return hasFeature("urn:xmpp:mam:0");
379	}
380
381	public boolean nonanonymous() {
382		return hasFeature("muc_nonanonymous");
383	}
384
385	public boolean persistent() {
386		return hasFeature("muc_persistent");
387	}
388
389	public boolean moderated() {
390		return hasFeature("muc_moderated");
391	}
392
393	public User deleteUser(Jid jid) {
394		User user = findUserByFullJid(jid);
395		if (user != null) {
396			synchronized (users) {
397				users.remove(user);
398				if (membersOnly() &&
399						nonanonymous() &&
400						user.affiliation.ranks(Affiliation.MEMBER) &&
401						user.realJid != null) {
402					user.role = Role.NONE;
403					user.avatar = null;
404					user.fullJid = null;
405					users.add(user);
406				}
407			}
408		}
409		return user;
410	}
411
412	public void addUser(User user) {
413		User old;
414		if (user.fullJid == null && user.realJid != null) {
415			old = findUserByRealJid(user.realJid);
416			if (old != null) {
417				if (old.fullJid != null) {
418					return; //don't add. user already exists
419				} else {
420					synchronized (users) {
421						users.remove(old);
422					}
423				}
424			}
425		} else if (user.realJid != null) {
426			old = findUserByRealJid(user.realJid);
427			synchronized (users) {
428				if (old != null && old.fullJid == null) {
429					users.remove(old);
430				}
431			}
432		}
433		old = findUserByFullJid(user.getFullJid());
434		synchronized (this.users) {
435			if (old != null) {
436				users.remove(old);
437			}
438			if ((!membersOnly() || user.getAffiliation().ranks(Affiliation.MEMBER))
439					&& user.getAffiliation().outranks(Affiliation.OUTCAST)){
440				this.users.add(user);
441			}
442		}
443	}
444
445	public User findUserByFullJid(Jid jid) {
446		if (jid == null) {
447			return null;
448		}
449		synchronized (users) {
450			for (User user : users) {
451				if (jid.equals(user.getFullJid())) {
452					return user;
453				}
454			}
455		}
456		return null;
457	}
458
459	private User findUserByRealJid(Jid jid) {
460		if (jid == null) {
461			return null;
462		}
463		synchronized (users) {
464			for (User user : users) {
465				if (jid.equals(user.realJid)) {
466					return user;
467				}
468			}
469		}
470		return null;
471	}
472
473	public boolean isContactInRoom(Contact contact) {
474		return findUserByRealJid(contact.getJid().toBareJid()) != null;
475	}
476
477	public boolean isUserInRoom(Jid jid) {
478		return findUserByFullJid(jid) != null;
479	}
480
481	public void setError(Error error) {
482		this.isOnline = isOnline && error == Error.NONE;
483		this.error = error;
484	}
485
486	public void setOnline() {
487		this.isOnline = true;
488	}
489
490	public ArrayList<User> getUsers() {
491		return getUsers(true);
492	}
493
494	public ArrayList<User> getUsers(boolean includeOffline) {
495		synchronized (users) {
496			if (includeOffline) {
497				return new ArrayList<>(users);
498			} else {
499				ArrayList<User> onlineUsers = new ArrayList<>();
500				for (User user : users) {
501					if (user.getRole().ranks(Role.PARTICIPANT)) {
502						onlineUsers.add(user);
503					}
504				}
505				return onlineUsers;
506			}
507		}
508	}
509
510	public List<User> getUsers(int max) {
511		ArrayList<User> users = getUsers();
512		return users.subList(0, Math.min(max, users.size()));
513	}
514
515	public int getUserCount() {
516		synchronized (users) {
517			return users.size();
518		}
519	}
520
521	public String getProposedNick() {
522		if (conversation.getBookmark() != null
523				&& conversation.getBookmark().getNick() != null
524				&& !conversation.getBookmark().getNick().trim().isEmpty()) {
525			return conversation.getBookmark().getNick().trim();
526		} else if (!conversation.getJid().isBareJid()) {
527			return conversation.getJid().getResourcepart();
528		} else {
529			return account.getUsername();
530		}
531	}
532
533	public String getActualNick() {
534		if (this.self.getName() != null) {
535			return this.self.getName();
536		} else {
537			return this.getProposedNick();
538		}
539	}
540
541	public boolean online() {
542		return this.isOnline;
543	}
544
545	public Error getError() {
546		return this.error;
547	}
548
549	public void setOnRenameListener(OnRenameListener listener) {
550		this.onRenameListener = listener;
551	}
552
553	public void setOffline() {
554		synchronized (users) {
555			this.users.clear();
556		}
557		this.error = Error.NO_RESPONSE;
558		this.isOnline = false;
559	}
560
561	public User getSelf() {
562		return self;
563	}
564
565	public void setSubject(String content) {
566		this.subject = content;
567	}
568
569	public String getSubject() {
570		return this.subject;
571	}
572
573	public String createNameFromParticipants() {
574		if (getUserCount() >= 2) {
575			List<String> names = new ArrayList<>();
576			for (User user : getUsers(5)) {
577				Contact contact = user.getContact();
578				if (contact != null && !contact.getDisplayName().isEmpty()) {
579					names.add(contact.getDisplayName().split("\\s+")[0]);
580				} else if (user.getName() != null){
581					names.add(user.getName());
582				}
583			}
584			StringBuilder builder = new StringBuilder();
585			for (int i = 0; i < names.size(); ++i) {
586				builder.append(names.get(i));
587				if (i != names.size() - 1) {
588					builder.append(", ");
589				}
590			}
591			return builder.toString();
592		} else {
593			return null;
594		}
595	}
596
597	public long[] getPgpKeyIds() {
598		List<Long> ids = new ArrayList<>();
599		for (User user : this.users) {
600			if (user.getPgpKeyId() != 0) {
601				ids.add(user.getPgpKeyId());
602			}
603		}
604		ids.add(account.getPgpId());
605		long[] primitiveLongArray = new long[ids.size()];
606		for (int i = 0; i < ids.size(); ++i) {
607			primitiveLongArray[i] = ids.get(i);
608		}
609		return primitiveLongArray;
610	}
611
612	public boolean pgpKeysInUse() {
613		synchronized (users) {
614			for (User user : users) {
615				if (user.getPgpKeyId() != 0) {
616					return true;
617				}
618			}
619		}
620		return false;
621	}
622
623	public boolean everybodyHasKeys() {
624		synchronized (users) {
625			for (User user : users) {
626				if (user.getPgpKeyId() == 0) {
627					return false;
628				}
629			}
630		}
631		return true;
632	}
633
634	public Jid createJoinJid(String nick) {
635		try {
636			return Jid.fromString(this.conversation.getJid().toBareJid().toString() + "/" + nick);
637		} catch (final InvalidJidException e) {
638			return null;
639		}
640	}
641
642	public Jid getTrueCounterpart(Jid jid) {
643		if (jid.equals(getSelf().getFullJid())) {
644			return account.getJid().toBareJid();
645		}
646		User user = findUserByFullJid(jid);
647		return user == null ? null : user.realJid;
648	}
649
650	public String getPassword() {
651		this.password = conversation.getAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD);
652		if (this.password == null && conversation.getBookmark() != null
653				&& conversation.getBookmark().getPassword() != null) {
654			return conversation.getBookmark().getPassword();
655		} else {
656			return this.password;
657		}
658	}
659
660	public void setPassword(String password) {
661		if (conversation.getBookmark() != null) {
662			conversation.getBookmark().setPassword(password);
663		} else {
664			this.password = password;
665		}
666		conversation.setAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD, password);
667	}
668
669	public Conversation getConversation() {
670		return this.conversation;
671	}
672
673	public List<Jid> getMembers() {
674		ArrayList<Jid> members = new ArrayList<>();
675		synchronized (users) {
676			for (User user : users) {
677				if (user.affiliation.ranks(Affiliation.MEMBER) && user.realJid != null) {
678					members.add(user.realJid);
679				}
680			}
681		}
682		return members;
683	}
684}