MucOptions.java

  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.utils.Xmlns;
 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		return hasFeature(Xmlns.MAM);
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				boolean realJidInMuc = false;
398				for (User u : users) {
399					if (user.realJid != null && user.realJid.equals(u.realJid)) {
400						realJidInMuc = true;
401						break;
402					}
403				}
404				boolean self = user.realJid != null && user.realJid.equals(account.getJid().toBareJid());
405				if (membersOnly()
406						&& nonanonymous()
407						&& user.affiliation.ranks(Affiliation.MEMBER)
408						&& user.realJid != null
409						&& !realJidInMuc
410						&& !self) {
411					user.role = Role.NONE;
412					user.avatar = null;
413					user.fullJid = null;
414					users.add(user);
415				}
416			}
417		}
418		return user;
419	}
420
421	public void updateUser(User user) {
422		User old;
423		if (user.fullJid == null && user.realJid != null) {
424			old = findUserByRealJid(user.realJid);
425			if (old != null) {
426				if (old.fullJid != null) {
427					return; //don't add. user already exists
428				} else {
429					synchronized (users) {
430						users.remove(old);
431					}
432				}
433			}
434		} else if (user.realJid != null) {
435			old = findUserByRealJid(user.realJid);
436			synchronized (users) {
437				if (old != null && old.fullJid == null) {
438					users.remove(old);
439				}
440			}
441		}
442		old = findUserByFullJid(user.getFullJid());
443		synchronized (this.users) {
444			if (old != null) {
445				users.remove(old);
446			}
447			if ((!membersOnly() || user.getAffiliation().ranks(Affiliation.MEMBER))
448					&& user.getAffiliation().outranks(Affiliation.OUTCAST)){
449				this.users.add(user);
450			}
451		}
452	}
453
454	public User findUserByFullJid(Jid jid) {
455		if (jid == null) {
456			return null;
457		}
458		synchronized (users) {
459			for (User user : users) {
460				if (jid.equals(user.getFullJid())) {
461					return user;
462				}
463			}
464		}
465		return null;
466	}
467
468	private User findUserByRealJid(Jid jid) {
469		if (jid == null) {
470			return null;
471		}
472		synchronized (users) {
473			for (User user : users) {
474				if (jid.equals(user.realJid)) {
475					return user;
476				}
477			}
478		}
479		return null;
480	}
481
482	public boolean isContactInRoom(Contact contact) {
483		return findUserByRealJid(contact.getJid().toBareJid()) != null;
484	}
485
486	public boolean isUserInRoom(Jid jid) {
487		return findUserByFullJid(jid) != null;
488	}
489
490	public void setError(Error error) {
491		this.isOnline = isOnline && error == Error.NONE;
492		this.error = error;
493	}
494
495	public void setOnline() {
496		this.isOnline = true;
497	}
498
499	public ArrayList<User> getUsers() {
500		return getUsers(true);
501	}
502
503	public ArrayList<User> getUsers(boolean includeOffline) {
504		synchronized (users) {
505			if (includeOffline) {
506				return new ArrayList<>(users);
507			} else {
508				ArrayList<User> onlineUsers = new ArrayList<>();
509				for (User user : users) {
510					if (user.getRole().ranks(Role.PARTICIPANT)) {
511						onlineUsers.add(user);
512					}
513				}
514				return onlineUsers;
515			}
516		}
517	}
518
519	public List<User> getUsers(int max) {
520		ArrayList<User> subset = new ArrayList<>();
521		HashSet<Jid> jids = new HashSet<>();
522		jids.add(account.getJid().toBareJid());
523		synchronized (users) {
524			for(User user : users) {
525				if (user.getRealJid() == null || jids.add(user.getRealJid())) {
526					subset.add(user);
527				}
528				if (subset.size() >= max) {
529					break;
530				}
531			}
532		}
533		return subset;
534	}
535
536	public int getUserCount() {
537		synchronized (users) {
538			return users.size();
539		}
540	}
541
542	public String getProposedNick() {
543		if (conversation.getBookmark() != null
544				&& conversation.getBookmark().getNick() != null
545				&& !conversation.getBookmark().getNick().trim().isEmpty()) {
546			return conversation.getBookmark().getNick().trim();
547		} else if (!conversation.getJid().isBareJid()) {
548			return conversation.getJid().getResourcepart();
549		} else {
550			return account.getUsername();
551		}
552	}
553
554	public String getActualNick() {
555		if (this.self.getName() != null) {
556			return this.self.getName();
557		} else {
558			return this.getProposedNick();
559		}
560	}
561
562	public boolean online() {
563		return this.isOnline;
564	}
565
566	public Error getError() {
567		return this.error;
568	}
569
570	public void setOnRenameListener(OnRenameListener listener) {
571		this.onRenameListener = listener;
572	}
573
574	public void setOffline() {
575		synchronized (users) {
576			this.users.clear();
577		}
578		this.error = Error.NO_RESPONSE;
579		this.isOnline = false;
580	}
581
582	public User getSelf() {
583		return self;
584	}
585
586	public void setSubject(String content) {
587		this.subject = content;
588	}
589
590	public String getSubject() {
591		return this.subject;
592	}
593
594	public String createNameFromParticipants() {
595		if (getUserCount() >= 2) {
596			List<String> names = new ArrayList<>();
597			for (User user : getUsers(5)) {
598				Contact contact = user.getContact();
599				if (contact != null && !contact.getDisplayName().isEmpty()) {
600					names.add(contact.getDisplayName().split("\\s+")[0]);
601				} else if (user.getName() != null){
602					names.add(user.getName());
603				}
604			}
605			StringBuilder builder = new StringBuilder();
606			for (int i = 0; i < names.size(); ++i) {
607				builder.append(names.get(i));
608				if (i != names.size() - 1) {
609					builder.append(", ");
610				}
611			}
612			return builder.toString();
613		} else {
614			return null;
615		}
616	}
617
618	public long[] getPgpKeyIds() {
619		List<Long> ids = new ArrayList<>();
620		for (User user : this.users) {
621			if (user.getPgpKeyId() != 0) {
622				ids.add(user.getPgpKeyId());
623			}
624		}
625		ids.add(account.getPgpId());
626		long[] primitiveLongArray = new long[ids.size()];
627		for (int i = 0; i < ids.size(); ++i) {
628			primitiveLongArray[i] = ids.get(i);
629		}
630		return primitiveLongArray;
631	}
632
633	public boolean pgpKeysInUse() {
634		synchronized (users) {
635			for (User user : users) {
636				if (user.getPgpKeyId() != 0) {
637					return true;
638				}
639			}
640		}
641		return false;
642	}
643
644	public boolean everybodyHasKeys() {
645		synchronized (users) {
646			for (User user : users) {
647				if (user.getPgpKeyId() == 0) {
648					return false;
649				}
650			}
651		}
652		return true;
653	}
654
655	public Jid createJoinJid(String nick) {
656		try {
657			return Jid.fromString(this.conversation.getJid().toBareJid().toString() + "/" + nick);
658		} catch (final InvalidJidException e) {
659			return null;
660		}
661	}
662
663	public Jid getTrueCounterpart(Jid jid) {
664		if (jid.equals(getSelf().getFullJid())) {
665			return account.getJid().toBareJid();
666		}
667		User user = findUserByFullJid(jid);
668		return user == null ? null : user.realJid;
669	}
670
671	public String getPassword() {
672		this.password = conversation.getAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD);
673		if (this.password == null && conversation.getBookmark() != null
674				&& conversation.getBookmark().getPassword() != null) {
675			return conversation.getBookmark().getPassword();
676		} else {
677			return this.password;
678		}
679	}
680
681	public void setPassword(String password) {
682		if (conversation.getBookmark() != null) {
683			conversation.getBookmark().setPassword(password);
684		} else {
685			this.password = password;
686		}
687		conversation.setAttribute(Conversation.ATTRIBUTE_MUC_PASSWORD, password);
688	}
689
690	public Conversation getConversation() {
691		return this.conversation;
692	}
693
694	public List<Jid> getMembers() {
695		ArrayList<Jid> members = new ArrayList<>();
696		synchronized (users) {
697			for (User user : users) {
698				if (user.affiliation.ranks(Affiliation.MEMBER) && user.realJid != null) {
699					members.add(user.realJid);
700				}
701			}
702		}
703		return members;
704	}
705}