Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package it.auties.whatsapp.controller;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import it.auties.protobuf.annotation.ProtobufProperty;
import it.auties.protobuf.model.ProtobufMessage;
import it.auties.protobuf.model.ProtobufType;
import it.auties.whatsapp.api.ClientType;
import it.auties.whatsapp.api.TextPreviewSetting;
import it.auties.whatsapp.api.WebHistoryLength;
import it.auties.whatsapp.listener.Listener;
import it.auties.whatsapp.model.business.BusinessCategory;
import it.auties.whatsapp.model.call.Call;
import it.auties.whatsapp.model.chat.Chat;
import it.auties.whatsapp.model.chat.ChatBuilder;
import it.auties.whatsapp.model.chat.ChatEphemeralTimer;
import it.auties.whatsapp.model.companion.CompanionDevice;
import it.auties.whatsapp.model.contact.Contact;
import it.auties.whatsapp.model.info.ChatMessageInfo;
import it.auties.whatsapp.model.info.ContextInfo;
import it.auties.whatsapp.model.info.MessageStatusInfo;
import it.auties.whatsapp.model.info.NewsletterMessageInfo;
import it.auties.whatsapp.model.jid.Jid;
import it.auties.whatsapp.model.jid.JidProvider;
import it.auties.whatsapp.model.jid.JidServer;
import it.auties.whatsapp.model.media.MediaConnection;
import it.auties.whatsapp.model.message.model.ChatMessageKey;
import it.auties.whatsapp.model.message.model.ContextualMessage;
import it.auties.whatsapp.model.mobile.CountryLocale;
import it.auties.whatsapp.model.mobile.PhoneNumber;
import it.auties.whatsapp.model.newsletter.Newsletter;
import it.auties.whatsapp.model.newsletter.NewsletterName;
import it.auties.whatsapp.model.node.Node;
import it.auties.whatsapp.model.privacy.PrivacySettingEntry;
import it.auties.whatsapp.model.privacy.PrivacySettingType;
import it.auties.whatsapp.model.signal.auth.UserAgent.ReleaseChannel;
import it.auties.whatsapp.model.signal.auth.Version;
import it.auties.whatsapp.model.sync.HistorySyncMessage;
import it.auties.whatsapp.registration.TokenProvider;
import it.auties.whatsapp.socket.SocketRequest;
import it.auties.whatsapp.util.BytesHelper;
import it.auties.whatsapp.util.FutureReference;
import it.auties.whatsapp.util.ProtobufUriMixin;
import it.auties.whatsapp.util.ProxyAuthenticator;
import java.net.URI;
import java.time.Duration;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentHashMap.KeySetView;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* This controller holds the user-related data regarding a WhatsappWeb session
*/
@SuppressWarnings({"unused", "UnusedReturnValue"})
public final class Store extends Controller implements ProtobufMessage {
/**
* The version used by this session
*/
@ProtobufProperty(index = 5, type = ProtobufType.STRING, mixin = ProtobufUriMixin.class)
URI proxy;
/**
* The version used by this session
*/
@ProtobufProperty(index = 6, type = ProtobufType.OBJECT, overrideType = Version.class)
FutureReference version;
/**
* Whether this account is online for other users
*/
@ProtobufProperty(index = 7, type = ProtobufType.BOOL)
boolean online;
/**
* The locale of the user linked to this account
*/
@ProtobufProperty(index = 8, type = ProtobufType.OBJECT)
CountryLocale locale;
/**
* The name of the user linked to this account. This field will be null while the user hasn't
* logged in yet. Assumed to be non-null otherwise.
*/
@ProtobufProperty(index = 9, type = ProtobufType.STRING)
String name;
/**
* The address of this account, if it's a business account
*/
@ProtobufProperty(index = 10, type = ProtobufType.STRING)
String businessAddress;
/**
* The longitude of this account's location, if it's a business account
*/
@ProtobufProperty(index = 11, type = ProtobufType.DOUBLE)
Double businessLongitude;
/**
* The latitude of this account's location, if it's a business account
*/
@ProtobufProperty(index = 12, type = ProtobufType.DOUBLE)
Double businessLatitude;
/**
* The description of this account, if it's a business account
*/
@ProtobufProperty(index = 13, type = ProtobufType.STRING)
String businessDescription;
/**
* The website of this account, if it's a business account
*/
@ProtobufProperty(index = 14, type = ProtobufType.STRING)
String businessWebsite;
/**
* The email of this account, if it's a business account
*/
@ProtobufProperty(index = 15, type = ProtobufType.STRING)
String businessEmail;
/**
* The category of this account, if it's a business account
*/
@ProtobufProperty(index = 16, type = ProtobufType.OBJECT)
BusinessCategory businessCategory;
/**
* The hash of the companion associated with this session
*/
@ProtobufProperty(index = 17, type = ProtobufType.STRING)
String deviceHash;
/**
* A map of all the devices that the companion has associated using WhatsappWeb
* The key here is the index of the device's key
* The value is the device's companion jid
*/
@ProtobufProperty(index = 18, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.INT32)
LinkedHashMap linkedDevicesKeys;
/**
* The profile picture of the user linked to this account. This field will be null while the user
* hasn't logged in yet. This field can also be null if no image was set.
*/
@ProtobufProperty(index = 19, type = ProtobufType.STRING, mixin = ProtobufUriMixin.class)
URI profilePicture;
/**
* The status of the user linked to this account.
* This field will be null while the user hasn't logged in yet.
* Assumed to be non-null otherwise.
*/
@ProtobufProperty(index = 20, type = ProtobufType.STRING)
String about;
/**
* The user linked to this account. This field will be null while the user hasn't logged in yet.
*/
@ProtobufProperty(index = 21, type = ProtobufType.STRING)
Jid jid;
/**
* The lid user linked to this account. This field will be null while the user hasn't logged in yet.
*/
@ProtobufProperty(index = 22, type = ProtobufType.STRING)
Jid lid;
/**
* The non-null map of properties received by whatsapp
*/
@ProtobufProperty(index = 23, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.STRING)
final ConcurrentHashMap properties;
/**
* The non-null map of chats
*/
@JsonIgnore
final ConcurrentHashMap chats;
/**
* The non-null map of contacts
*/
@ProtobufProperty(index = 24, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT)
final ConcurrentHashMap contacts;
/**
* The non-null list of status messages
*/
@ProtobufProperty(index = 25, type = ProtobufType.OBJECT)
final KeySetView status;
/**
* The non-null map of newsletters
*/
@JsonIgnore
final ConcurrentHashMap newsletters;
/**
* The non-null map of privacy settings
*/
@ProtobufProperty(index = 26, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT)
final ConcurrentHashMap privacySettings;
/**
* The non-null map of calls
*/
@ProtobufProperty(index = 27, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT)
final ConcurrentHashMap calls;
/**
* Whether chats should be unarchived if a new message arrives
*/
@ProtobufProperty(index = 28, type = ProtobufType.BOOL)
boolean unarchiveChats;
/**
* Whether the twenty-hours format is being used by the client
*/
@ProtobufProperty(index = 29, type = ProtobufType.BOOL)
boolean twentyFourHourFormat;
/**
* The non-null list of requests that were sent to Whatsapp. They might or might not be waiting
* for a newsletters
*/
@JsonIgnore
final ConcurrentHashMap requests;
/**
* The non-null list of replies waiting to be fulfilled
*/
@JsonIgnore
final ConcurrentHashMap> replyHandlers;
/**
* The non-null list of listeners
*/
@JsonIgnore
final KeySetView listeners;
/**
* The request tag, used to create messages
*/
@JsonIgnore
final String tag;
/**
* The timestampSeconds in seconds for the initialization of this object
*/
@ProtobufProperty(index = 30, type = ProtobufType.UINT64)
final long initializationTimeStamp;
/**
* The media connection associated with this store
*/
@JsonIgnore
MediaConnection mediaConnection;
/**
* The media connection latch associated with this store
*/
@JsonIgnore
final CountDownLatch mediaConnectionLatch;
/**
* The request tag, used to create messages
*/
@ProtobufProperty(index = 31, type = ProtobufType.OBJECT)
ChatEphemeralTimer newChatsEphemeralTimer;
/**
* The setting to use when generating previews for text messages that contain links
*/
@ProtobufProperty(index = 32, type = ProtobufType.OBJECT)
TextPreviewSetting textPreviewSetting;
/**
* Describes how much chat history Whatsapp should send
*/
@ProtobufProperty(index = 33, type = ProtobufType.OBJECT)
WebHistoryLength historyLength;
/**
* Whether listeners should be automatically scanned and registered or not
*/
@ProtobufProperty(index = 34, type = ProtobufType.BOOL)
boolean autodetectListeners;
/**
* Whether the listeners that were automatically scanned should be cached
*/
@ProtobufProperty(index = 35, type = ProtobufType.BOOL)
boolean cacheDetectedListeners;
/**
* Whether updates about the presence of the session should be sent automatically to Whatsapp
* For example, when the bot is started, the status of the companion is changed to available if this option is enabled
* If this option is enabled, the companion will not receive notifications because the bot will instantly read them
*/
@ProtobufProperty(index = 36, type = ProtobufType.BOOL)
boolean automaticPresenceUpdates;
/**
* The release channel to use when connecting to Whatsapp
* This should allow the use of beta features
*/
@ProtobufProperty(index = 37, type = ProtobufType.OBJECT)
ReleaseChannel releaseChannel;
/**
* Metadata about the device that is being simulated for Whatsapp
*/
@ProtobufProperty(index = 38, type = ProtobufType.OBJECT)
CompanionDevice device;
/**
* Whether the mac of every app state request should be checked
*/
@ProtobufProperty(index = 39, type = ProtobufType.BOOL)
boolean checkPatchMacs;
/**
* All args constructor
*/
@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
public Store(UUID uuid, PhoneNumber phoneNumber, ClientType clientType, Collection alias, URI proxy, FutureReference version, boolean online, CountryLocale locale, String name, String businessAddress, Double businessLongitude, Double businessLatitude, String businessDescription, String businessWebsite, String businessEmail, BusinessCategory businessCategory, String deviceHash, LinkedHashMap linkedDevicesKeys, URI profilePicture, String about, Jid jid, Jid lid, ConcurrentHashMap properties, ConcurrentHashMap contacts, KeySetView status, ConcurrentHashMap privacySettings, ConcurrentHashMap calls, boolean unarchiveChats, boolean twentyFourHourFormat, long initializationTimeStamp, ChatEphemeralTimer newChatsEphemeralTimer, TextPreviewSetting textPreviewSetting, WebHistoryLength historyLength, boolean autodetectListeners, boolean cacheDetectedListeners, boolean automaticPresenceUpdates, ReleaseChannel releaseChannel, CompanionDevice device, boolean checkPatchMacs) {
super(uuid, phoneNumber, null, clientType, alias);
if (proxy != null) {
ProxyAuthenticator.register(proxy);
}
this.proxy = proxy;
this.version = version;
this.online = online;
this.locale = locale;
this.name = name;
this.businessAddress = businessAddress;
this.businessLongitude = businessLongitude;
this.businessLatitude = businessLatitude;
this.businessDescription = businessDescription;
this.businessWebsite = businessWebsite;
this.businessEmail = businessEmail;
this.businessCategory = businessCategory;
this.deviceHash = deviceHash;
this.linkedDevicesKeys = linkedDevicesKeys;
this.profilePicture = profilePicture;
this.about = about;
this.jid = jid;
this.lid = lid;
this.properties = properties;
this.chats = new ConcurrentHashMap<>();
this.contacts = contacts;
this.status = status;
this.newsletters = new ConcurrentHashMap<>();
this.privacySettings = privacySettings;
this.calls = calls;
this.unarchiveChats = unarchiveChats;
this.twentyFourHourFormat = twentyFourHourFormat;
this.requests = new ConcurrentHashMap<>();
this.replyHandlers = new ConcurrentHashMap<>();
this.listeners = ConcurrentHashMap.newKeySet();
this.tag = HexFormat.of().formatHex(BytesHelper.random(1));
this.initializationTimeStamp = initializationTimeStamp;
this.mediaConnectionLatch = new CountDownLatch(1);
this.newChatsEphemeralTimer = newChatsEphemeralTimer;
this.textPreviewSetting = textPreviewSetting;
this.historyLength = historyLength;
this.autodetectListeners = autodetectListeners;
this.cacheDetectedListeners = cacheDetectedListeners;
this.automaticPresenceUpdates = automaticPresenceUpdates;
this.releaseChannel = releaseChannel;
this.device = device;
this.checkPatchMacs = checkPatchMacs;
}
/**
* Queries the first contact whose jid is equal to {@code jid}
*
* @param jid the jid to search
* @return a non-null optional
*/
public Optional findContactByJid(JidProvider jid) {
if (jid == null) {
return Optional.empty();
}
if (jid instanceof Contact contact) {
return Optional.of(contact);
}
return Optional.ofNullable(contacts.get(jid.toJid()));
}
/**
* Queries the first contact whose name is equal to {@code name}
*
* @param name the name to search
* @return a non-null optional
*/
public Optional findContactByName(String name) {
return findContactsStream(name).findAny();
}
private Stream findContactsStream(String name) {
return name == null ? Stream.empty() : contacts().parallelStream()
.filter(contact -> contact.fullName().filter(name::equals).isPresent() || contact.chosenName().filter(name::equals).isPresent() || contact.shortName().filter(name::equals).isPresent());
}
/**
* Returns all the contacts
*
* @return an immutable collection
*/
public Collection contacts() {
return Collections.unmodifiableCollection(contacts.values());
}
/**
* Queries every contact whose name is equal to {@code name}
*
* @param name the name to search
* @return a non-null immutable set
*/
public Set findContactsByName(String name) {
return findContactsStream(name).collect(Collectors.toUnmodifiableSet());
}
/**
* Queries the first message whose id matches the one provided in the specified chat
*
* @param key the key to search
* @return a non-null optional
*/
public Optional findMessageByKey(ChatMessageKey key) {
return Optional.ofNullable(key)
.map(ChatMessageKey::chatJid)
.flatMap(this::findChatByJid)
.flatMap(chat -> findMessageById(chat, key.id()));
}
/**
* Queries the first message whose id matches the one provided in the specified chat or newsletter
*
* @param provider the chat to search in
* @param id the jid to search
* @return a non-null optional
*/
public Optional> findMessageById(JidProvider provider, String id) {
if (provider == null || id == null) {
return Optional.empty();
}
return switch (provider) {
case Chat chat -> findMessageById(chat, id);
case Newsletter newsletter -> findMessageById(newsletter, id);
case Contact contact -> findChatByJid(contact.jid())
.flatMap(chat -> findMessageById(chat, id));
case Jid contactJid -> switch (contactJid.type()) {
case NEWSLETTER -> findNewsletterByJid(contactJid)
.flatMap(newsletter -> findMessageById(newsletter, id));
case STATUS -> status.stream()
.filter(entry -> Objects.equals(entry.chatJid(), provider.toJid()) && Objects.equals(entry.id(), id))
.findFirst();
default -> findChatByJid(contactJid)
.flatMap(chat -> findMessageById(chat, id));
};
};
}
/**
* Queries the first message whose id matches the one provided in the specified newsletter
*
* @param newsletter newsletter chat to search in
* @param id the jid to search
* @return a non-null optional
*/
public Optional findMessageById(Newsletter newsletter, String id) {
return newsletter.messages()
.parallelStream()
.filter(entry -> Objects.equals(id, entry.id()) || Objects.equals(id, String.valueOf(entry.serverId())))
.findFirst();
}
/**
* Queries the first message whose id matches the one provided in the specified chat
*
* @param chat the chat to search in
* @param id the jid to search
* @return a non-null optional
*/
public Optional findMessageById(Chat chat, String id) {
return chat.messages()
.parallelStream()
.map(HistorySyncMessage::messageInfo)
.filter(message -> Objects.equals(message.key().id(), id))
.findAny();
}
/**
* Queries the first chat whose jid is equal to {@code jid}
*
* @param jid the jid to search
* @return a non-null optional
*/
public Optional findChatByJid(JidProvider jid) {
if (jid == null) {
return Optional.empty();
}
if (jid instanceof Chat chat) {
return Optional.of(chat);
}
return Optional.ofNullable(chats.get(jid.toJid()));
}
/**
* Queries the first newsletter whose jid is equal to {@code jid}
*
* @param jid the jid to search
* @return a non-null optional
*/
public Optional findNewsletterByJid(JidProvider jid) {
if (jid == null) {
return Optional.empty();
}
if (jid instanceof Newsletter newsletter) {
return Optional.of(newsletter);
}
return Optional.ofNullable(newsletters.get(jid.toJid()));
}
/**
* Queries the first chat whose name is equal to {@code name}
*
* @param name the name to search
* @return a non-null optional
*/
public Optional findChatByName(String name) {
return findChatsByNameStream(name).findAny();
}
/**
* Queries the first newsletter whose name is equal to {@code name}
*
* @param name the name to search
* @return a non-null optional
*/
public Optional findNewsletterByName(String name) {
return findNewslettersByNameStream(name).findAny();
}
private Stream findChatsByNameStream(String name) {
return name == null ? Stream.empty() : chats.values()
.parallelStream()
.filter(chat -> chat.name().equalsIgnoreCase(name));
}
private Stream findNewslettersByNameStream(String name) {
return name == null ? Stream.empty() : newsletters.values()
.parallelStream()
.filter(newsletter -> name.equalsIgnoreCase(newsletter.metadata().name().map(NewsletterName::text).orElse(null)));
}
/**
* Queries the first chat that matches the provided function
*
* @param function the non-null filter
* @return a non-null optional
*/
public Optional findChatBy(Function function) {
return chats.values().parallelStream()
.filter(function::apply)
.findFirst();
}
/**
* Queries the first newsletter that matches the provided function
*
* @param function the non-null filter
* @return a non-null optional
*/
public Optional findNewsletterBy(Function function) {
return newsletters.values()
.parallelStream()
.filter(function::apply)
.findFirst();
}
/**
* Queries every chat whose name is equal to {@code name}
*
* @param name the name to search
* @return a non-null immutable set
*/
public Set findChatsByName(String name) {
return findChatsByNameStream(name)
.collect(Collectors.toUnmodifiableSet());
}
/**
* Queries every newsletter whose name is equal to {@code name}
*
* @param name the name to search
* @return a non-null immutable set
*/
public Set findNewslettersByName(String name) {
return findNewslettersByNameStream(name)
.collect(Collectors.toUnmodifiableSet());
}
/**
* Queries the first chat that matches the provided function
*
* @param function the non-null filter
* @return a non-null optional
*/
public Set findChatsBy(Function function) {
return chats.values()
.stream()
.filter(function::apply)
.collect(Collectors.toUnmodifiableSet());
}
/**
* Returns all the status
*
* @return an immutable collection
*/
public Collection status() {
return Collections.unmodifiableCollection(status);
}
/**
* Returns all the newsletters
*
* @return an immutable collection
*/
public Collection newsletters() {
return Collections.unmodifiableCollection(newsletters.values());
}
/**
* Queries all the status of a contact
*
* @param jid the sender of the status
* @return a non-null immutable list
*/
public Collection findStatusBySender(JidProvider jid) {
return status.stream()
.filter(entry -> Objects.equals(entry.chatJid(), jid))
.toList();
}
/**
* Queries the first request whose id equals the one stored by the newsletters and, if any is found,
* it completes it
*
* @param response the newsletters to complete the request with
* @param exceptionally whether the newsletters is erroneous
* @return a boolean
*/
public boolean resolvePendingRequest(Node response, boolean exceptionally) {
return findPendingRequest(response.id()).map(request -> deleteAndComplete(request, response, exceptionally))
.isPresent();
}
/**
* Queries the first request whose id is equal to {@code id}
*
* @param id the id to search, can be null
* @return a non-null optional
*/
@SuppressWarnings("ClassEscapesDefinedScope")
public Optional findPendingRequest(String id) {
return id == null ? Optional.empty() : Optional.ofNullable(requests.get(id));
}
private SocketRequest deleteAndComplete(SocketRequest request, Node response, boolean exceptionally) {
if (request.complete(response, exceptionally)) {
requests.remove(request.id());
}
return request;
}
/**
* Clears all the data that this object holds and closes the pending requests
*/
public void resolveAllPendingRequests() {
requests.values().forEach(request -> request.complete(null, false));
}
/**
* Returns an immutable collection of pending requests
*
* @return a non-null collection
*/
@SuppressWarnings("ClassEscapesDefinedScope")
public Collection pendingRequests() {
return Collections.unmodifiableCollection(requests.values());
}
/**
* Queries the first reply waiting and completes it with the input message
*
* @param response the newsletters to complete the reply with
* @return a boolean
*/
public boolean resolvePendingReply(ChatMessageInfo response) {
return response.message()
.contentWithContext()
.flatMap(ContextualMessage::contextInfo)
.flatMap(ContextInfo::quotedMessageId)
.map(id -> {
var future = replyHandlers.remove(id);
if (future == null) {
return false;
}
future.complete(response);
return true;
})
.orElse(false);
}
/**
* Adds a chat in memory
*
* @param chatJid the chat to add
* @return the input chat
*/
public Chat addNewChat(Jid chatJid) {
var chat = new ChatBuilder()
.jid(chatJid)
.build();
addChat(chat);
return chat;
}
/**
* Adds a chat in memory
*
* @param chat the chat to add
* @return the old chat, if present
*/
public Optional addChat(Chat chat) {
if (chat.hasName() && chat.jid().hasServer(JidServer.WHATSAPP)) {
var contact = findContactByJid(chat.jid())
.orElseGet(() -> addContact(new Contact(chat.jid())));
contact.setFullName(chat.name());
}
var oldChat = chats.get(chat.jid());
if (oldChat != null) {
if (oldChat.hasName() && !chat.hasName()) {
chat.setName(oldChat.name()); // Coming from contact actions
}
joinMessages(chat, oldChat);
}
return addChatDirect(chat);
}
private void joinMessages(Chat chat, Chat oldChat) {
var newChatTimestamp = chat.newestMessage()
.map(message -> message.timestampSeconds().orElse(0L))
.orElse(0L);
var oldChatTimestamp = oldChat.newestMessage()
.map(message -> message.timestampSeconds().orElse(0L))
.orElse(0L);
if (newChatTimestamp <= oldChatTimestamp) {
chat.addMessages(oldChat.messages());
return;
}
chat.addOldMessages(chat.messages());
}
/**
* Adds a chat in memory without executing any check
*
* @param chat the chat to add
* @return the old chat, if present
*/
public Optional addChatDirect(Chat chat) {
return Optional.ofNullable(chats.put(chat.jid(), chat));
}
/**
* Adds a contact in memory
*
* @param jid the contact to add
* @return the input contact
*/
public Contact addContact(Jid jid) {
return addContact(new Contact(jid));
}
/**
* Adds a contact in memory
*
* @param contact the contact to add
* @return the input contact
*/
public Contact addContact(Contact contact) {
contacts.put(contact.jid(), contact);
return contact;
}
/**
* Adds a newsletter in memory
*
* @param newsletter the newsletter to add
* @return the old newsletter, if present
*/
public Optional addNewsletter(Newsletter newsletter) {
return Optional.ofNullable(newsletters.put(newsletter.jid(), newsletter));
}
/**
* Removes a chat from memory
*
* @param chatJid the chat to remove
* @return the chat that was deleted wrapped by an optional
*/
public Optional removeChat(JidProvider chatJid) {
return Optional.ofNullable(chats.remove(chatJid.toJid()));
}
/**
* Removes a newsletter from memory
*
* @param newsletterJid the newsletter to remove
* @return the newsletter that was deleted wrapped by an optional
*/
public Optional removeNewsletter(JidProvider newsletterJid) {
return Optional.ofNullable(newsletters.remove(newsletterJid.toJid()));
}
/**
* Removes a contact from memory
*
* @param contactJid the contact to remove
* @return the contact that was deleted wrapped by an optional
*/
public Optional removeContact(JidProvider contactJid) {
return Optional.ofNullable(contacts.remove(contactJid.toJid()));
}
/**
* Returns the chats pinned to the top sorted new to old
*
* @return a non-null list of chats
*/
public List pinnedChats() {
return chats.values()
.parallelStream()
.filter(Chat::isPinned)
.sorted(Comparator.comparingLong(Chat::pinnedTimestampSeconds).reversed())
.toList();
}
/**
* Returns all the starred messages
*
* @return a non-null list of messages
*/
public List starredMessages() {
return chats().parallelStream().map(Chat::starredMessages).flatMap(Collection::stream).toList();
}
/**
* Returns all the chats sorted from newest to oldest
*
* @return an immutable collection
*/
public List chats() {
return chats.values()
.stream()
.sorted(Comparator.comparingLong(Chat::timestampSeconds).reversed())
.toList();
}
/**
* Returns the non-null map of properties received by whatsapp
*
* @return an unmodifiable map
*/
public Map properties() {
return Collections.unmodifiableMap(properties);
}
public void addProperties(Map properties) {
this.properties.putAll(properties);
}
/**
* The media connection associated with this store
*
* @return the media connection
*/
public MediaConnection mediaConnection() {
return mediaConnection(Duration.ofMinutes(1));
}
/**
* The media connection associated with this store
*
* @param timeout the non-null timeout for the connection to be filled
* @return the media connection
*/
public MediaConnection mediaConnection(Duration timeout) {
try {
var result = mediaConnectionLatch.await(timeout.toMillis(), TimeUnit.MILLISECONDS);
if (!result) {
throw new RuntimeException("Cannot get media connection");
}
return mediaConnection;
} catch (InterruptedException exception) {
throw new RuntimeException("Cannot lock on media connection", exception);
}
}
/**
* Writes a media connection
*
* @param mediaConnection a media connection
* @return the same instance
*/
public Store setMediaConnection(MediaConnection mediaConnection) {
this.mediaConnection = mediaConnection;
mediaConnectionLatch.countDown();
return this;
}
/**
* Returns all the blocked contacts
*
* @return an immutable collection
*/
public Collection blockedContacts() {
return contacts().stream().filter(Contact::blocked).toList();
}
/**
* Adds a status to this store
*
* @param info the non-null status to add
* @return the same instance
*/
public Store addStatus(ChatMessageInfo info) {
status.add(info);
return this;
}
/**
* Adds a request to this store
*
* @param request the non-null request to add
* @return the non-null completable newsletters of the request
*/
@SuppressWarnings("ClassEscapesDefinedScope")
public CompletableFuture addRequest(SocketRequest request) {
if (request.id() == null) {
return CompletableFuture.completedFuture(null);
}
requests.put(request.id(), request);
return request.future();
}
/**
* Adds a replay handler to this store
*
* @param messageId the non-null message id to listen for
* @return the non-null completable newsletters of the reply handler
*/
public CompletableFuture addPendingReply(String messageId) {
var result = new CompletableFuture();
replyHandlers.put(messageId, result);
return result;
}
/**
* Returns the profile picture of this user if present
*
* @return an optional uri
*/
public Optional profilePicture() {
return Optional.ofNullable(profilePicture);
}
/**
* Queries all the privacy settings
*
* @return a non-null list
*/
public Collection privacySettings() {
return privacySettings.values();
}
/**
* Queries the privacy setting entry for the type
*
* @param type a non-null type
* @return a non-null entry
*/
public PrivacySettingEntry findPrivacySetting(PrivacySettingType type) {
return privacySettings.get(type.name());
}
/**
* Sets the privacy setting entry for a type
*
* @param type a non-null type
* @param entry the non-null entry
* @return the old privacy setting entry
*/
public PrivacySettingEntry addPrivacySetting(PrivacySettingType type, PrivacySettingEntry entry) {
return privacySettings.put(type.name(), entry);
}
/**
* Returns an unmodifiable map that contains every companion associated using Whatsapp web mapped to its key index
*
* @return an unmodifiable map
*/
public Map linkedDevicesKeys() {
return Collections.unmodifiableMap(linkedDevicesKeys);
}
/**
* Returns an unmodifiable list that contains the devices associated using Whatsapp web to this session's companion
*
* @return an unmodifiable list
*/
public Collection linkedDevices() {
return Collections.unmodifiableCollection(linkedDevicesKeys.keySet());
}
/**
* Registers a new companion
* Only use this method in the mobile api
*
* @param companion a non-null companion
* @param keyId the id of its key
* @return the nullable old key
*/
public Optional addLinkedDevice(Jid companion, int keyId) {
return Optional.ofNullable(linkedDevicesKeys.put(companion, keyId));
}
/**
* Removes a companion
* Only use this method in the mobile api
*
* @param companion a non-null companion
* @return the nullable old key
*/
public Optional removeLinkedCompanion(Jid companion) {
return Optional.ofNullable(linkedDevicesKeys.remove(companion));
}
/**
* Removes all linked companion
*/
public void removeLinkedCompanions() {
linkedDevicesKeys.clear();
}
/**
* Returns an immutable collection of listeners
*
* @return a non-null collection
*/
public Collection listeners() {
return Collections.unmodifiableSet(listeners);
}
/**
* Registers a listener
*
* @param listener the listener to register
* @return the same instance
*/
public Store addListener(Listener listener) {
listeners.add(listener);
return this;
}
/**
* Registers a collection of listeners
*
* @param listeners the listeners to register
* @return the same instance
*/
public Store addListeners(Collection listeners) {
this.listeners.addAll(listeners);
return this;
}
/**
* Removes a listener
*
* @param listener the listener to remove
* @return the same instance
*/
public Store removeListener(Listener listener) {
listeners.remove(listener);
return this;
}
/**
* Removes all listeners
*
* @return the same instance
*/
public Store removeListener() {
listeners.clear();
return this;
}
/**
* Sets the proxy used by this session
*
* @return the same instance
*/
public Store setProxy(URI proxy) {
if (proxy != null && proxy.getUserInfo() != null) {
ProxyAuthenticator.register(proxy);
} else if (proxy == null && this.proxy != null) {
ProxyAuthenticator.unregister(this.proxy);
}
this.proxy = proxy;
return this;
}
/**
* Returns the proxy used by this session
*
* @return a non-null optional
*/
public Optional proxy() {
return Optional.ofNullable(proxy);
}
/**
* The address of this account, if it's a business account
*
* @return an optional
*/
public Optional businessAddress() {
return Optional.ofNullable(businessAddress);
}
/**
* The longitude of this account's location, if it's a business account
*
* @return an optional
*/
public Optional businessLongitude() {
return Optional.ofNullable(businessLongitude);
}
/**
* The latitude of this account's location, if it's a business account
*
* @return an optional
*/
public Optional businessLatitude() {
return Optional.ofNullable(businessLatitude);
}
/**
* The description of this account, if it's a business account
*
* @return an optional
*/
public Optional businessDescription() {
return Optional.ofNullable(businessDescription);
}
/**
* The website of this account, if it's a business account
*
* @return an optional
*/
public Optional businessWebsite() {
return Optional.ofNullable(businessWebsite);
}
/**
* The email of this account, if it's a business account
*
* @return an optional
*/
public Optional businessEmail() {
return Optional.ofNullable(businessEmail);
}
/**
* The category of this account, if it's a business account
*
* @return an optional
*/
public Optional businessCategory() {
return Optional.ofNullable(businessCategory);
}
public void dispose() {
serialize(false);
serializer.linkMetadata(this);
mediaConnectionLatch.countDown();
}
@Override
public void serialize(boolean async) {
serializer.serializeStore(this, async);
}
/**
* Adds a call to the store
*
* @param call a non-null call
* @return the old value associated with {@link Call#id()}
*/
public Optional addCall(Call call) {
return Optional.ofNullable(calls.put(call.id(), call));
}
/**
* Finds a call by id
*
* @param callId the id of the call, can be null
* @return an optional
*/
public Optional findCallById(String callId) {
return callId == null ? Optional.empty() : Optional.ofNullable(calls.get(callId));
}
public String tag() {
return tag;
}
@JsonGetter("version")
public Version version() {
if(version == null) {
this.version = new FutureReference<>(null, () -> TokenProvider.getVersion(device.platform()));
}
return version.value();
}
public boolean online() {
return this.online;
}
public Optional locale() {
return Optional.ofNullable(this.locale);
}
public String name() {
return name;
}
public Optional deviceHash() {
return Optional.ofNullable(this.deviceHash);
}
public Optional about() {
return Optional.ofNullable(this.about);
}
public Optional jid() {
return Optional.ofNullable(this.jid);
}
public Optional lid() {
return Optional.ofNullable(this.lid);
}
public boolean unarchiveChats() {
return this.unarchiveChats;
}
public boolean twentyFourHourFormat() {
return this.twentyFourHourFormat;
}
public long initializationTimeStamp() {
return this.initializationTimeStamp;
}
public ChatEphemeralTimer newChatsEphemeralTimer() {
return this.newChatsEphemeralTimer;
}
public TextPreviewSetting textPreviewSetting() {
return this.textPreviewSetting;
}
public WebHistoryLength historyLength() {
return this.historyLength;
}
public boolean autodetectListeners() {
return this.autodetectListeners;
}
public boolean cacheDetectedListeners() {
return cacheDetectedListeners;
}
public boolean automaticPresenceUpdates() {
return this.automaticPresenceUpdates;
}
public ReleaseChannel releaseChannel() {
return this.releaseChannel;
}
public CompanionDevice device() {
return device;
}
public boolean checkPatchMacs() {
return this.checkPatchMacs;
}
public Map calls() {
return Collections.unmodifiableMap(calls);
}
public Store setOnline(boolean online) {
this.online = online;
return this;
}
public Store setLocale(CountryLocale locale) {
this.locale = locale;
return this;
}
public Store setName(String name) {
this.name = name;
return this;
}
public Store setBusinessAddress(String businessAddress) {
this.businessAddress = businessAddress;
return this;
}
public Store setBusinessLongitude(Double businessLongitude) {
this.businessLongitude = businessLongitude;
return this;
}
public Store setBusinessLatitude(Double businessLatitude) {
this.businessLatitude = businessLatitude;
return this;
}
public Store setBusinessDescription(String businessDescription) {
this.businessDescription = businessDescription;
return this;
}
public Store setBusinessWebsite(String businessWebsite) {
this.businessWebsite = businessWebsite;
return this;
}
public Store setBusinessEmail(String businessEmail) {
this.businessEmail = businessEmail;
return this;
}
public Store setBusinessCategory(BusinessCategory businessCategory) {
this.businessCategory = businessCategory;
return this;
}
public Store setDeviceHash(String deviceHash) {
this.deviceHash = deviceHash;
return this;
}
public Store setLinkedDevicesKeys(LinkedHashMap linkedDevicesKeys) {
this.linkedDevicesKeys = linkedDevicesKeys;
return this;
}
public Store setProfilePicture(URI profilePicture) {
this.profilePicture = profilePicture;
return this;
}
public Store setAbout(String about) {
this.about = about;
return this;
}
public Store setJid(Jid jid) {
this.jid = jid;
return this;
}
public Store setLid(Jid lid) {
this.lid = lid;
return this;
}
public Store setUnarchiveChats(boolean unarchiveChats) {
this.unarchiveChats = unarchiveChats;
return this;
}
public Store setTwentyFourHourFormat(boolean twentyFourHourFormat) {
this.twentyFourHourFormat = twentyFourHourFormat;
return this;
}
public Store setNewChatsEphemeralTimer(ChatEphemeralTimer newChatsEphemeralTimer) {
this.newChatsEphemeralTimer = newChatsEphemeralTimer;
return this;
}
public Store setTextPreviewSetting(TextPreviewSetting textPreviewSetting) {
this.textPreviewSetting = textPreviewSetting;
return this;
}
public Store setHistoryLength(WebHistoryLength historyLength) {
this.historyLength = historyLength;
return this;
}
public Store setAutodetectListeners(boolean autodetectListeners) {
this.autodetectListeners = autodetectListeners;
return this;
}
public void setCacheDetectedListeners(boolean cacheDetectedListeners) {
this.cacheDetectedListeners = cacheDetectedListeners;
}
public Store setAutomaticPresenceUpdates(boolean automaticPresenceUpdates) {
this.automaticPresenceUpdates = automaticPresenceUpdates;
return this;
}
public Store setReleaseChannel(ReleaseChannel releaseChannel) {
this.releaseChannel = releaseChannel;
return this;
}
public Store setDevice(CompanionDevice device) {
Objects.requireNonNull(device, "The device cannot be null");
this.device = device;
this.version = new FutureReference<>(null, () -> TokenProvider.getVersion(device.platform()));
return this;
}
public Store setCheckPatchMacs(boolean checkPatchMacs) {
this.checkPatchMacs = checkPatchMacs;
return this;
}
public Store setVersion(Version version) {
this.version.setValue(version);
return this;
}
}
